source/fs/dir.h

   1 #ifndef MSP_FS_DIR_H_
   2 #define MSP_FS_DIR_H_
   3
   4 #include <list>
   5 #include <stdexcept>
   6 #include <string>
   7 #include "path.h"
   8
   9 namespace Msp {
  10 namespace FS {
  11
  12 class not_a_directory: public std::runtime_error
  13 {
  14 public:
  15         not_a_directory(const Path &);
  16         virtual ~not_a_directory() throw() { }
  17 };
  18
  19 /// Creates a directory
  20 void mkdir(const Path &path, int mode);
  21
  22 /// Creates a directory and any required parent directories
  23 void mkpath(const Path &path, int mode);
  24
  25 /// Removes a directory, which must be empty
  26 void rmdir(const Path &path);
  27
  28 /// Removes a directory and anything it contains
  29 void rmpath(const Path &path);
  30
  31 /// Lists the contents of a directory
  32 std::list<std::string> list_files(const Path &path);
  33
  34 /// Lists the contents of a directory, filtered with a regex
  35 std::list<std::string> list_filtered(const Path &path, const std::string &filter);
  36
  37 /// Returns the current working directory
  38 Path getcwd();
  39
  40 /// Returns the user's home directory
  41 Path get_home_dir();
  42
  43 /// Returns a directory suitable for storing user-specific data
  44 Path get_user_data_dir(const std::string &appname);
  45
  46 Path get_user_data_dir();
  47
  48 /// Returns a directory containing system-wide configuration
  49 Path get_sys_conf_dir(const std::string &argv0);
  50
  51 Path get_sys_conf_dir();
  52
  53 /// Returns a directory containing immutable system-wide data
  54 Path get_sys_data_dir(const std::string &argv0, const std::string &appname);
  55
  56 Path get_sys_data_dir();
  57
  58 /// Returns a directory containing system-wide architecture-specific files
  59 Path get_sys_lib_dir(const std::string &argv0, const std::string &appname);
  60
  61 Path get_sys_lib_dir();
  62
  63 /// Changes the current working directory
  64 void chdir(const Path &);
  65
  66 } // namespace FS
  67 } // namespace Msp
  68
  69 #endif