blob: e51d5de4ad5014404212b734de1f686973f662e2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/*
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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef PBD_SEARCH_PATH_INCLUDED
#define PBD_SEARCH_PATH_INCLUDED
#include <string>
#include <vector>
#include <pbd/filesystem.h>
namespace PBD {
using std::string;
using std::vector;
/**
* @class 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
* or are directories. It is basically just a container.
*/
class SearchPath {
public:
typedef std::vector<sys::path>::iterator iterator;
typedef std::vector<sys::path>::const_iterator const_iterator;
public:
/**
* Create an empty SearchPath.
*/
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
* 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 string& search_path);
/**
* Initialize SearchPath from a sys::path.
*
* @param directory_path A directory path.
*/
SearchPath (const sys::path& directory_path);
/**
* Initialize SearchPath from a vector of paths that may or may
* not exist.
*
* @param path A path.
*/
SearchPath (const vector<sys::path>& paths);
/**
* The copy constructor does what you would expect and copies the
* vector of paths contained by the SearchPath.
*/
SearchPath (const SearchPath& search_path);
/**
* Indicate whether there are any directory paths in m_dirs.
*
* If SearchPath is initialized with an empty string as the
* result of for instance the contents of an unset environment
* variable.
*
* @return true if there are any paths in m_paths.
*/
operator void* () const { return (void*)!m_dirs.empty(); }
/**
* @return a read/write iterator that points to the first
* path in the SearchPath. Iteration is done in ordinary
* element order.
*/
iterator begin () { return m_dirs.begin(); }
/**
* @return A read-only (constant) iterator that points to the
* first path in the SearchPath.
*/
const_iterator begin () const { return m_dirs.begin(); }
/**
* @return A read/write iterator that points one past the last
* path in the SearchPath.
*/
iterator end () { return m_dirs.end(); }
/**
* @return A read-only (constant) iterator that points one past
* the last path in the SearchPath.
*/
const_iterator end () const { return m_dirs.end(); }
/**
* @return a search path string.
*
* The string that is returned contains the platform specific
* path separator.
*/
const string get_string () const;
/**
* Assignment of another SearchPath to this.
*/
SearchPath& operator= (const SearchPath& spath);
/**
* Add all the directories in path to this.
*/
SearchPath& operator+= (const SearchPath& spath);
/**
* Add another directory path to the search path.
*/
SearchPath& operator+= (const sys::path& directory_path);
/**
* Concatenate another SearchPath onto this.
*/
SearchPath& operator+ (const SearchPath& other);
/**
* Add another path to the search path.
*/
SearchPath& operator+ (const sys::path& directory_path);
/**
* Add a sub-directory to each path in the search path.
* @param subdir The directory name, it should not contain
* any path separating tokens.
*/
SearchPath& add_subdirectory_to_paths (const string& subdir);
/**
* Add a sub-directory to each path in the search path.
* @see add_subdirectory_to_paths
*/
SearchPath& operator/= (const string& subdir);
protected:
void add_directory (const sys::path& directory_path);
void add_directories (const vector<sys::path>& paths);
vector<sys::path> m_dirs;
};
} // namespace PBD
#endif
|
