FilePath.h

Go to the documentation of this file.

/*
    Copyright (C) 2018, University of Hull

    This file is part of STIR.
    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_FILEPATH_H__
#define __stir_FILEPATH_H__

#include "stir/common.h"
#include <string>
#include <vector>

START_NAMESPACE_STIR

class FilePath
{
public:
  FilePath();

  FilePath(const std::string& __str, bool _run_checks = true);

  ~FilePath() {}

  bool is_directory() const;
  bool is_regular_file() const;
  bool is_writable() const;
  // This funtion has been copied from the Functions for filename manipulations
  static bool is_absolute(const std::string& _filename_with_directory);
  static bool exists(const std::string& s);
  static std::string get_current_working_directory();
  FilePath append(const FilePath& p);
  FilePath append(const std::string& p);
  static void append_separator(std::string& s);
  // This funtion has been copied from the Functions for filename manipulations
  void prepend_directory_name(const std::string& p);
  // This funtion has been copied from the Functions for filename manipulations
  void add_extension(const std::string& e);
  // This funtion has been copied from the Functions for filename manipulations
  void replace_extension(const std::string& e);
  std::string get_path() const;
  std::string get_path_only() const;
  std::string get_filename() const;
  std::string get_filename_no_extension() const;
  // This function will return the the bit that is after the last dot.
  std::string get_extension() const;
  std::string get_as_string() const;

  inline std::string get_string() const;

  inline bool operator==(const FilePath& other);

  inline bool operator==(const std::string& other);

  inline void operator=(const FilePath& other);

  inline void operator=(const std::string& other);

private:
  void checks() const;
  const std::vector<std::string> split(const std::string& s, const char* c = "");

  std::string merge(const std::string& first, const std::string& sec);

  inline void initSeparator();

  // This funtion has been copied from the Functions for filename manipulations
  std::string::size_type find_pos_of_filename() const;
  // This funtion has been copied from the Functions for filename manipulations
  std::string::size_type find_pos_of_extension() const;

protected:
  std::string my_string;
  std::string separator;
  bool run_checks;
};

END_NAMESPACE_STIR

#include "stir/FilePath.inl"

#endif