libs/pbd/pbd/search_path.h

   1 /*
   2     Copyright (C) 2007 Tim Mayberry
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef PBD_SEARCH_PATH_INCLUDED
  21 #define PBD_SEARCH_PATH_INCLUDED
  22
  23 #include <string>
  24 #include <vector>
  25
  26 #include "pbd/filesystem.h"
  27
  28 namespace PBD {
  29
  30 /**
  31  * @class The SearchPath class is a helper class for getting a
  32  * vector of paths contained in a search path string where a
  33  * "search path string" contains absolute directory paths
  34  * separated by a colon(:) or a semi-colon(;) on windows.
  35  *
  36  * The SearchPath class does not test whether the paths exist
  37  * or are directories. It is basically just a container.
  38  */
  39 class SearchPath : public std::vector<sys::path>
  40 {
  41 public:
  42         /**
  43          * Create an empty SearchPath.
  44          */
  45         SearchPath ();
  46
  47         /**
  48          * Initialize SearchPath from a string where the string contains
  49          * one or more absolute paths to directories which are delimited
  50          * by a path separation character. The path delimeter is a
  51          * colon(:) on unix and a semi-colon(;) on windows.
  52          *
  53          * Each path contained in the search path may or may not resolve to
  54          * an existing directory in the filesystem.
  55          *
  56          * @param search_path A path string.
  57          */
  58         SearchPath (const std::string& search_path);
  59
  60         /**
  61          * Initialize SearchPath from a sys::path.
  62          *
  63          * @param directory_path A directory path.
  64          */
  65         SearchPath (const PBD::sys::path& directory_path);
  66
  67         /**
  68          * Initialize SearchPath from a vector of paths that may or may
  69          * not exist.
  70          *
  71          * @param path A path.
  72          */
  73         SearchPath (const std::vector<PBD::sys::path>& paths);
  74
  75         /**
  76          * @return a search path string.
  77          *
  78          * The string that is returned contains the platform specific
  79          * path separator.
  80          */
  81         const std::string to_string () const;
  82
  83         /**
  84          * Add all the directories in path to this.
  85          */
  86         SearchPath& operator+= (const SearchPath& spath);
  87
  88         /**
  89          * Add another directory path to the search path.
  90          */
  91         SearchPath& operator+= (const PBD::sys::path& directory_path);
  92
  93         /**
  94          * Concatenate another SearchPath onto this.
  95          */
  96         SearchPath& operator+ (const SearchPath& other);
  97
  98         /**
  99          * Add another path to the search path.
 100          */
 101         SearchPath& operator+ (const PBD::sys::path& directory_path);
 102
 103         /**
 104          * Add a sub-directory to each path in the search path.
 105          * @param subdir The directory name, it should not contain
 106          * any path separating tokens.
 107          */
 108         SearchPath& add_subdirectory_to_paths (const std::string& subdir);
 109
 110 protected:
 111         void add_directory (const sys::path& directory_path);
 112         void add_directories (const std::vector<PBD::sys::path>& paths);
 113 };
 114
 115 } // namespace PBD
 116
 117 #endif