/*
- Copyright (C) 2007 Tim Mayberry
+ Copyright (C) 2007 Tim Mayberry
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
-#ifndef PBD_SEARCH_PATH_INCLUDED
-#define PBD_SEARCH_PATH_INCLUDED
-
-#ifdef SearchPath
-#undef SearchPath
-#endif
+#ifndef __libpbd_search_path_h__
+#define __libpbd_search_path_h__
#include <string>
#include <vector>
+#include "pbd/libpbd_visibility.h"
+
namespace PBD {
/**
- * @class SearchPath
+ * @class Searchpath
*
- * The SearchPath class is a helper class for getting a
- * vector of paths contained in a search path string where a
- * "search path string" contains absolute directory paths
+ * The Searchpath class is a helper class for getting a
+ * vector of paths contained in a search path string where a
+ * "search path string" contains absolute directory paths
* separated by a colon(:) or a semi-colon(;) on windows.
*
- * The SearchPath class does not test whether the paths exist
+ * The Searchpath class does not test whether the paths exist
* or are directories. It is basically just a container.
*/
-class SearchPath : public std::vector<std::string>
+class LIBPBD_TEMPLATE_API Searchpath : public std::vector<std::string>
{
public:
/**
- * Create an empty SearchPath.
+ * Create an empty Searchpath.
*/
- SearchPath ();
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath ();
/**
- * Initialize SearchPath from a string where the string contains
- * one or more absolute paths to directories which are delimited
- * by a path separation character. The path delimeter is a
+ * Initialize Searchpath from a string where the string contains
+ * one or more absolute paths to directories which are delimited
+ * by a path separation character. The path delimeter is a
* colon(:) on unix and a semi-colon(;) on windows.
*
* Each path contained in the search path may or may not resolve to
* an existing directory in the filesystem.
- *
+ *
* @param search_path A path string.
*/
- SearchPath (const std::string& search_path);
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath (const std::string& search_path);
/**
- * Initialize SearchPath from a vector of paths that may or may
+ * Initialize Searchpath from a vector of paths that may or may
* not exist.
*
* @param paths A vector of paths.
*/
- SearchPath (const std::vector<std::string>& paths);
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath (const std::vector<std::string>& paths);
+
+ LIBPBD_TEMPLATE_MEMBER_API ~Searchpath () {};
/**
* @return a search path string.
* The string that is returned contains the platform specific
* path separator.
*/
- const std::string to_string () const;
+ LIBPBD_TEMPLATE_MEMBER_API const std::string to_string () const;
/**
* Add all the directories in path to this.
*/
- SearchPath& operator+= (const SearchPath& spath);
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator+= (const Searchpath& spath);
/**
* Add another directory path to the search path.
*/
- SearchPath& operator+= (const std::string& directory_path);
-
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator+= (const std::string& directory_path);
+
/**
- * Concatenate another SearchPath onto this.
+ * Concatenate another Searchpath onto this.
*/
- SearchPath& operator+ (const SearchPath& other);
-
+ LIBPBD_TEMPLATE_MEMBER_API const Searchpath operator+ (const Searchpath& other);
+
/**
* Add another path to the search path.
*/
- SearchPath& operator+ (const std::string& directory_path);
+ LIBPBD_TEMPLATE_MEMBER_API const Searchpath operator+ (const std::string& directory_path);
+
+ /**
+ * Remove all the directories in path from this.
+ */
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator-= (const Searchpath& spath);
+
+ /**
+ * Remove a directory path from the search path.
+ */
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator-= (const std::string& directory_path);
/**
* Add a sub-directory to each path in the search path.
- * @param subdir The directory name, it should not contain
+ * @param subdir The directory name, it should not contain
* any path separating tokens.
*/
- SearchPath& add_subdirectory_to_paths (const std::string& subdir);
+ LIBPBD_TEMPLATE_MEMBER_API Searchpath& add_subdirectory_to_paths (const std::string& subdir);
-protected:
+ /**
+ * Add directory_path to this Searchpath.
+ */
+ LIBPBD_TEMPLATE_MEMBER_API void add_directory (const std::string& directory_path);
- void add_directory (const std::string& directory_path);
- void add_directories (const std::vector<std::string>& paths);
+ /**
+ * Add directories in paths to this Searchpath.
+ */
+ LIBPBD_TEMPLATE_MEMBER_API void add_directories (const std::vector<std::string>& paths);
+
+ /**
+ * Remove directory_path from this Searchpath.
+ */
+ LIBPBD_TEMPLATE_MEMBER_API void remove_directory (const std::string& directory_path);
+
+ /**
+ * Remove all the directories in paths from this Searchpath.
+ */
+ LIBPBD_TEMPLATE_MEMBER_API void remove_directories (const std::vector<std::string>& paths);
+
+ /**
+ * @return true if Searchpath already contains path
+ */
+ LIBPBD_TEMPLATE_MEMBER_API bool contains (const std::string& path) const;
};
+LIBPBD_API void export_search_path (const std::string& base_dir, const char* varname, const char* dir);
+
+
} // namespace PBD
-#endif
+#endif /* __libpbd_search_path_h__ */