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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*
* Copyright (C) 2016 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef IGNITION_COMMON_SYSTEMPATHS_HH_
#define IGNITION_COMMON_SYSTEMPATHS_HH_
#include <stdio.h>
#ifdef _WIN32
#include <direct.h>
#define GetCurrentDir _getcwd
#else
#include <unistd.h>
#define GetCurrentDir getcwd
#endif
#include <functional>
#include <list>
#include <memory>
#include <string>
#include <vector>
#include <ignition/common/Export.hh>
#include <ignition/common/SuppressWarning.hh>
#include <ignition/common/URI.hh>
namespace ignition
{
namespace common
{
// Forward declare private data class
class SystemPathsPrivate;
/// \class SystemPaths SystemPaths.hh ignition/common/SystemPaths.hh
/// \brief Functions to handle getting system paths, keeps track of:
/// \li SystemPaths#pluginPaths - plugin library paths
/// for common::WorldPlugin
class IGNITION_COMMON_VISIBLE SystemPaths
{
/// \brief Constructor for SystemPaths
public: SystemPaths();
/// \brief Destructor
public: virtual ~SystemPaths();
/// \brief Get the log path. If IGN_LOG_PATH environment variable is set,
/// then this path is used. If not, the path is $HOME/.ignition, and in
/// case even HOME is not set, /tmp/ignition is used. If the directory
/// does not exist, it is created in the constructor of SystemPaths.
/// \return the path
public: std::string LogPath() const;
/// \brief Get the plugin paths
/// \return a list of paths (with forward slashes as directory separators)
public: const std::list<std::string> &PluginPaths();
/// \brief Find a file or path using a URI
/// \param[in] _uri the uniform resource identifier
/// \return Returns full path name to file with platform-specific
/// directory separators, or an empty string if URI couldn't be found.
/// \sa FindFileURI(const ignition::common::URI &_uri)
public: std::string FindFileURI(const std::string &_uri) const;
/// \brief Find a file or path using a URI.
/// If URI is not an absolute path, the URI's path will be matched against
/// all added paths and environment variables (including URI authority as
/// needed).
/// \param[in] _uri the uniform resource identifier
/// \return Returns full path name to file with platform-specific
/// directory separators, or an empty string if URI couldn't be found.
public: std::string FindFileURI(const ignition::common::URI &_uri) const;
/// \brief Set the plugin path environment variable to use
/// \param [in] _env name of the environment variable
public: void SetPluginPathEnv(const std::string &_env);
/// \brief Find a file in the set search paths (not recursive)
/// \param[in] _filename Name of the file to find.
/// \param[in] _searchLocalPath True to search in the current working
/// directory.
/// \param[in] _verbose False to omit console messages.
/// \return Returns full path name to file with platform-specific
/// directory separators, or empty string on error.
public: std::string FindFile(const std::string &_filename,
const bool _searchLocalPath = true,
const bool _verbose = true) const;
/// \brief Find a shared library by name in the plugin paths
///
/// This will try different combinations of library names on different
/// platforms. For example searching for "MyLibName" may try finding
/// "MyLibName", "libMyLibName.so", "MyLibName.dll", etc...
/// \param[in] _libName Name of shared libary to look for
/// \return Path to file with platform-specific directory separators,
/// or empty string on error.
public: std::string FindSharedLibrary(const std::string &_libName);
/// \brief Add colon (semicolon on windows) delimited paths to plugins
/// \param[in] _path the directory to add
public: void AddPluginPaths(const std::string &_path);
/// \brief clear out SystemPaths#pluginPaths
public: void ClearPluginPaths();
/// \brief Set the file path environment variable to use, and clears
/// any previously set file paths. The default
/// environment variable is IGN_FILE_PATH. The
/// environment variable should be a set of colon (semicolon on windows)
/// delimited paths. These paths will be used with the FindFile function.
/// \param [in] _env name of the environment variable
/// \sa FilePathEnv
public: void SetFilePathEnv(const std::string &_env);
/// \brief Get the file path environment variable in use.
/// The environment variable contains a set of colon (semicolon on
/// windows) delimited paths. These paths are used with the FindFile
/// functions.
/// \return Name of the environment variable
/// \sa SetFilePathEnv
public: std::string FilePathEnv() const;
/// \brief Get the file paths
/// \return a list of paths (with forward slashes as directory separators)
public: const std::list<std::string> &FilePaths();
/// \brief Add colon (semicolon on windows) delimited paths to find
/// files. These paths will be used with the FindFile function.
/// \param[in] _path A colon (semicolon on windows) delimited
/// string of paths. The path can have either forward slashes or platform-
/// specific directory separators, both are okay.
public: void AddFilePaths(const std::string &_path);
/// \brief clear out SystemPaths#filePaths
public: void ClearFilePaths();
/// \brief add _suffix to the list of path search suffixes
/// \param[in] _suffix The suffix to add
public: void AddSearchPathSuffix(const std::string &_suffix);
/// \brief Set the callback to use when ignition can't find a file.
/// The callback should return a complete path to the requested file, or
/// and empty string if the file was not found in the callback. The path
/// should use platform-specific directory separators.
/// \param[in] _cb The callback function.
/// \deprecated Use AddFindFileCallback instead
public: void IGN_DEPRECATED(3) SetFindFileCallback(
std::function<std::string(const std::string &)> _cb);
/// \brief Add a callback to use when FindFile() can't find a file.
/// The callback should return a full local path to the requested file, or
/// and empty string if the file was not found in the callback. The path
/// should use platform-specific directory separators.
/// Callbacks will be called in the order they were added until a path is
/// found (if a callback is set using SetFindFileCallback(), that one is
/// called first).
/// \param[in] _cb The callback function, which takes a file path or URI
/// and returns the full local path.
public: void AddFindFileCallback(
std::function<std::string(const std::string &)> _cb);
/// \brief Add a callback to use when FindFileURI() can't find a file.
/// The callback should return a full local path to the requested file, or
/// and empty string if the file was not found in the callback. The path
/// should use platform-specific directory separators.
/// Callbacks will be called in the order they were added until a path is
/// found (if a callback is set using SetFindFileURICallback(), that one
/// is called first).
/// \param[in] _cb The callback function, which takes a file path or URI
/// and returns the full local path.
public: void AddFindFileURICallback(
std::function<std::string(const ignition::common::URI &)> _cb);
/// \brief Set the callback to use when ignition can't find a file uri.
/// The callback should return a complete path to the requested file, or
/// and empty string if the file was not found in the callback. The path
/// should use platform-specific directory separators.
/// \param[in] _cb The callback function.
/// \deprecated Use AddFindFileURICallback instead
public: void IGN_DEPRECATED(3) SetFindFileURICallback(
std::function<std::string(const std::string &)> _cb);
/// \brief look for a file in a set of search paths (not recursive)
/// \description This method checks if a file exists in given directories.
/// It does so by joining each path with the filename and
/// checking if the file exists. If the file exists in
/// multiple paths the first one is found.
/// \param[in] _filename Name of the file to find
/// \param[in] _paths paths to look for the file
/// \return Returns a path that will work from the current directory
/// or an empty string if the file was not found. The returned
/// path will be normalized, i.e. backslashes will be substituted
/// with forward slashes.
public: static std::string LocateLocalFile(const std::string &_filename,
const std::vector<std::string> &_paths);
/// \brief Format the directory path to use "/" as a separator with "/"
/// at the end.
/// \param[in] _path Path to normalize
/// \return Normalized path
public: static std::string NormalizeDirectoryPath(
const std::string &_path);
/// \brief Return all paths given by an environment variable.
/// \param[in] _env Environment variable.
/// \return A list of paths listed by the environment variable.
public: static std::list<std::string> PathsFromEnv(
const std::string &_env);
/// \brief Get the delimiter that the current operating system
/// uses to separate different paths from each other.
public: static char Delimiter();
IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
/// \brief Private data pointer
private: std::unique_ptr<SystemPathsPrivate> dataPtr;
IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
};
}
}
#endif
|
