Gazebo Common

API Reference

3.17.0
gz/common/SystemPaths.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef GZ_COMMON_SYSTEMPATHS_HH_
18 #define GZ_COMMON_SYSTEMPATHS_HH_
19 
20 #include <stdio.h>
21 
22 #ifdef _WIN32
23  #include <direct.h>
24  #define GetCurrentDir _getcwd
25 #else
26  #include <unistd.h>
27  #define GetCurrentDir getcwd
28 #endif
29 
30 #include <functional>
31 #include <list>
32 #include <memory>
33 #include <string>
34 #include <vector>
35 
36 #include <gz/common/Export.hh>
38 #include <gz/common/URI.hh>
39 
40 namespace ignition
41 {
42  namespace common
43  {
44  // Forward declare private data class
45  class SystemPathsPrivate;
46 
51  class IGNITION_COMMON_VISIBLE SystemPaths
52  {
54  public: SystemPaths();
55 
57  public: virtual ~SystemPaths();
58 
64  public: std::string LogPath() const;
65 
68  public: const std::list<std::string> &PluginPaths();
69 
74  public: std::string FindFileURI(const std::string &_uri) const;
75 
80  public: std::string FindFileURI(const ignition::common::URI &_uri) const;
81 
84  public: void SetPluginPathEnv(const std::string &_env);
85 
92  public: std::string FindFile(const std::string &_filename,
93  const bool _searchLocalPath = true) const;
94 
103  public: std::string FindSharedLibrary(const std::string &_libName);
104 
107  public: void AddPluginPaths(const std::string &_path);
108 
110  public: void ClearPluginPaths();
111 
119  public: void SetFilePathEnv(const std::string &_env);
120 
127  public: std::string FilePathEnv() const;
128 
131  public: const std::list<std::string> &FilePaths();
132 
138  public: void AddFilePaths(const std::string &_path);
139 
141  public: void ClearFilePaths();
142 
145  public: void AddSearchPathSuffix(const std::string &_suffix);
146 
153  public: void IGN_DEPRECATED(3) SetFindFileCallback(
154  std::function<std::string(const std::string &)> _cb);
155 
165  public: void AddFindFileCallback(
166  std::function<std::string(const std::string &)> _cb);
167 
177  public: void AddFindFileURICallback(
179 
186  public: void IGN_DEPRECATED(3) SetFindFileURICallback(
187  std::function<std::string(const std::string &)> _cb);
188 
200  public: static std::string LocateLocalFile(const std::string &_filename,
201  const std::vector<std::string> &_paths);
202 
207  public: static std::string NormalizeDirectoryPath(
208  const std::string &_path);
209 
213  public: static std::list<std::string> PathsFromEnv(
214  const std::string &_env);
215 
218  public: static char Delimiter();
219 
222  private: std::unique_ptr<SystemPathsPrivate> dataPtr;
224  };
225  }
226 }
227 #endif
void SetFindFileURICallback(std::function< std::string(const std::string &)> _cb)
Set the callback to use when ignition can't find a file uri. The callback should return a complete pa...
Forward declarations for the common classes.
STL class.
void AddFilePaths(const std::string &_path)
Add colon (semicolon on windows) delimited paths to find files. These paths will be used with the Fin...
#define IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
Microsoft Visual Studio does not automatically export the interface information for member variables ...
Definition: gz/common/SuppressWarning.hh:65
STL class.
STL class.
std::string FindFileURI(const std::string &_uri) const
Find a file or path using a URI.
static std::string NormalizeDirectoryPath(const std::string &_path)
Format the directory path to use "/" as a separator with "/" at the end.
static std::list< std::string > PathsFromEnv(const std::string &_env)
Return all paths given by an environment variable.
void SetFindFileCallback(std::function< std::string(const std::string &)> _cb)
Set the callback to use when ignition can't find a file. The callback should return a complete path t...
std::string LogPath() const
Get the log path. If IGN_LOG_PATH environment variable is set, then this path is used....
void AddFindFileCallback(std::function< std::string(const std::string &)> _cb)
Add a callback to use when FindFile() can't find a file. The callback should return a full local path...
static char Delimiter()
Get the delimiter that the current operating system uses to separate different paths from each other.
void AddPluginPaths(const std::string &_path)
Add colon (semicolon on windows) delimited paths to plugins.
A complete URI.
Definition: gz/common/URI.hh:263
std::string FindFile(const std::string &_filename, const bool _searchLocalPath=true) const
Find a file in the set search paths (not recursive)
Functions to handle getting system paths, keeps track of:
Definition: gz/common/SystemPaths.hh:51
const std::list< std::string > & PluginPaths()
Get the plugin paths.
virtual ~SystemPaths()
Destructor.
std::string FindSharedLibrary(const std::string &_libName)
Find a shared library by name in the plugin paths.
void SetFilePathEnv(const std::string &_env)
Set the file path environment variable to use, and clears any previously set file paths....
SystemPaths()
Constructor for SystemPaths.
std::string FilePathEnv() const
Get the file path environment variable in use. The environment variable contains a set of colon (semi...
void ClearPluginPaths()
clear out SystemPaths::pluginPaths
void AddFindFileURICallback(std::function< std::string(const ignition::common::URI &)> _cb)
Add a callback to use when FindFileURI() can't find a file. The callback should return a full local p...
void AddSearchPathSuffix(const std::string &_suffix)
add _suffix to the list of path search suffixes
static std::string LocateLocalFile(const std::string &_filename, const std::vector< std::string > &_paths)
look for a file in a set of search paths (not recursive) \description This method checks if a file ex...
void SetPluginPathEnv(const std::string &_env)
Set the plugin path environment variable to use.
const std::list< std::string > & FilePaths()
Get the file paths.
#define IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
Definition: gz/common/SuppressWarning.hh:68
void ClearFilePaths()
clear out SystemPaths::filePaths