CommonIface.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 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 GAZEBO_COMMON_COMMONIFACE_HH_
18 #define GAZEBO_COMMON_COMMONIFACE_HH_
19 
20 #include <string>
21 #include <vector>
22 #include <boost/uuid/sha1.hpp>
23 #include <boost/filesystem.hpp>
24 #include <iomanip>
25 #include <sstream>
26 
27 #include "gazebo/util/system.hh"
28 
29 namespace gazebo
30 {
31  namespace common
32  {
35 
37  GZ_COMMON_VISIBLE
38  void load();
39 
42  GZ_COMMON_VISIBLE
43  void add_search_path_suffix(const std::string &_suffix);
44 
48  GZ_COMMON_VISIBLE
49  std::string find_file(const std::string &_file);
50 
56  GZ_COMMON_VISIBLE
57  std::string find_file(const std::string &_file,
58  bool _searchLocalPath);
59 
63  GZ_COMMON_VISIBLE
64  std::string find_file_path(const std::string &_file);
65 
70  template<typename T>
71  std::string get_sha1(const T &_buffer);
72 
76  GZ_COMMON_VISIBLE
77  const char *getEnv(const char *_name);
78 
81  GZ_COMMON_VISIBLE
82  std::string cwd();
83 
87  GZ_COMMON_VISIBLE
88  bool exists(const std::string &_path);
89 
93  GZ_COMMON_VISIBLE
94  bool isDirectory(const std::string &_path);
95 
99  GZ_COMMON_VISIBLE
100  bool isFile(const std::string &_path);
101 
105  GZ_COMMON_VISIBLE
106  std::string absPath(const std::string &_path);
107 
112  GZ_COMMON_VISIBLE
113  bool copyFile(const std::string &_existingFilename,
114  const std::string &_newFilename);
115 
120  GZ_COMMON_VISIBLE
121  bool copyDir(const boost::filesystem::path &_source,
122  const boost::filesystem::path &_destination);
123 
128  GZ_COMMON_VISIBLE
129  bool moveFile(const std::string &_existingFilename,
130  const std::string &_newFilename);
131 
140  GZ_COMMON_VISIBLE
141  void replaceAll(std::string &_result,
142  const std::string &_orig,
143  const std::string &_key,
144  const std::string &_replacement);
145 
154  GZ_COMMON_VISIBLE
155  std::string replaceAll(const std::string &_orig,
156  const std::string &_key,
157  const std::string &_replacement);
158 
163  GZ_COMMON_VISIBLE
164  std::vector<std::string> split(const std::string &_str,
165  const std::string &_delim);
166 
174  GZ_COMMON_VISIBLE
175  std::string unique_file_path(const std::string &_pathAndName,
176  const std::string &_extension);
178  }
179 
181  // Implementation of get_sha1
182  template<typename T>
183  std::string common::get_sha1(const T &_buffer)
184  {
185  boost::uuids::detail::sha1 sha1;
186  unsigned int hash[5];
187  std::stringstream stream;
188 
189  if (_buffer.size() == 0)
190  {
191  sha1.process_bytes(nullptr, 0);
192  }
193  else
194  {
195  sha1.process_bytes(&(_buffer[0]), _buffer.size() * sizeof(_buffer[0]));
196  }
197 
198  sha1.get_digest(hash);
199 
200  for (std::size_t i = 0; i < sizeof(hash) / sizeof(hash[0]); ++i)
201  {
202  stream << std::setfill('0')
203  << std::setw(sizeof(hash[0]) * 2)
204  << std::hex
205  << hash[i];
206  }
207 
208  return stream.str();
209  }
210 }
211 #endif
std::string get_sha1(const T &_buffer)
Compute the SHA1 hash of an array of bytes.
Definition: CommonIface.hh:183
const char * getEnv(const char *_name)
Cross platform retrieval of an environment variable.
std::vector< std::string > split(const std::string &_str, const std::string &_delim)
Splits a string into tokens.
Forward declarations for the common classes.
Definition: Animation.hh:26
std::string find_file_path(const std::string &_file)
search for a file in common::SystemPaths
bool copyDir(const boost::filesystem::path &_source, const boost::filesystem::path &_destination)
Copy a directory, overwrite the destination directory if exists.
void load()
Load the common library.
bool isFile(const std::string &_path)
Check if the given path is a file.
bool copyFile(const std::string &_existingFilename, const std::string &_newFilename)
Copy a file.
std::string cwd()
Get the current working directory.
std::string absPath(const std::string &_path)
Get the absolute path of a provided path.
std::string unique_file_path(const std::string &_pathAndName, const std::string &_extension)
Generates a path for a file which doesn&#39;t collide with existing files, by appending numbers to it (i...
std::string find_file(const std::string &_file)
search for file in common::SystemPaths
bool isDirectory(const std::string &_path)
Check if the given path is a directory.
bool moveFile(const std::string &_existingFilename, const std::string &_newFilename)
Move a file.
void add_search_path_suffix(const std::string &_suffix)
add path sufix to common::SystemPaths
void replaceAll(std::string &_result, const std::string &_orig, const std::string &_key, const std::string &_replacement)
Replace all occurances of _key with _replacement.
bool exists(const std::string &_path)
Returns true if _path is a file or directory.