Mark overridden virtual functions as such

[libs/core.git] / source / fs / dir.h

diff --git a/source/fs/dir.h b/source/fs/dir.h
index 5544a3179b912e9d7f14a4687095aaeabd7a547d..bef89c6d72e1e160072be098450c8641bb0ec00a 100644 (file)
--- a/source/fs/dir.h
+++ b/source/fs/dir.h
@@ -1,13 +1,21 @@
 #ifndef MSP_FS_DIR_H_
 #define MSP_FS_DIR_H_
 
-#include <list>
+#include <stdexcept>
 #include <string>
+#include <vector>
 #include "path.h"
 
 namespace Msp {
 namespace FS {
 
+class not_a_directory: public std::runtime_error
+{
+public:
+       not_a_directory(const Path &);
+       ~not_a_directory() throw() override = default;
+};
+
 /// Creates a directory
 void mkdir(const Path &path, int mode);
 
@@ -21,31 +29,38 @@ void rmdir(const Path &path);
 void rmpath(const Path &path);
 
 /// Lists the contents of a directory
-std::list<std::string> list_files(const Path &path);
+std::vector<std::string> list_files(const Path &path);
 
 /// Lists the contents of a directory, filtered with a regex
-std::list<std::string> list_filtered(const Path &path, const std::string &filter);
+std::vector<std::string> list_filtered(const Path &path, const std::string &filter);
 
 /// Returns the current working directory
 Path getcwd();
 
+/// Changes the current working directory
+void chdir(const Path &);
+
 /// Returns the user's home directory
 Path get_home_dir();
 
-/// Returns a directory suitable for storing user-specific data
-Path get_user_data_dir(const std::string &appname);
+/// Returns a directory suitable for storing user-specific data.
+Path get_user_data_dir();
 
-/// Returns a directory containing system-wide configuration
-Path get_sys_conf_dir(const std::string &argv0);
+/// Returns a directory containing system-wide configuration.
+Path get_sys_conf_dir();
 
-/// Returns a directory containing immutable system-wide data
-Path get_sys_data_dir(const std::string &argv0, const std::string &appname);
+/// Returns a directory containing immutable system-wide data.
+Path get_sys_data_dir();
 
-/// Returns a directory containing system-wide architecture-specific files
-Path get_sys_lib_dir(const std::string &argv0, const std::string &appname);
+/// Returns a directory containing system-wide architecture-specific files.
+Path get_sys_lib_dir();
 
-/// Changes the current working directory
-void chdir(const Path &);
+/** Looks for a file in a list of paths.  Returns the absolute path to the
+first existing location, or an empty Path if the file is not found at all. */
+Path path_lookup(const std::string &, const std::vector<Path> &);
+
+/** Looks for a file using the PATH environment variable. */
+Path path_lookup(const std::string &);
 
 } // namespace FS
 } // namespace Msp