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 
18 #ifndef _COMMONIFACE_HH_
19 #define _COMMONIFACE_HH_
20 
21 #include <string>
22 #include <vector>
23 #include <boost/uuid/sha1.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 moveFile(const std::string &_existingFilename,
122  const std::string &_newFilename);
123 
132  GZ_COMMON_VISIBLE
133  void replaceAll(std::string &_result,
134  const std::string &_orig,
135  const std::string &_key,
136  const std::string &_replacement);
137 
146  GZ_COMMON_VISIBLE
147  std::string replaceAll(const std::string &_orig,
148  const std::string &_key,
149  const std::string &_replacement);
151  }
152 
154  // Implementation of get_sha1
155  template<typename T>
156  std::string common::get_sha1(const T &_buffer)
157  {
158  boost::uuids::detail::sha1 sha1;
159  unsigned int hash[5];
160  std::stringstream stream;
161 
162  if (_buffer.size() == 0)
163  {
164  sha1.process_bytes(NULL, 0);
165  }
166  else
167  {
168  sha1.process_bytes(&(_buffer[0]), _buffer.size() * sizeof(_buffer[0]));
169  }
170 
171  sha1.get_digest(hash);
172 
173  for (std::size_t i = 0; i < sizeof(hash) / sizeof(hash[0]); ++i)
174  {
175  stream << std::setfill('0')
176  << std::setw(sizeof(hash[0]) * 2)
177  << std::hex
178  << hash[i];
179  }
180 
181  return stream.str();
182  }
183 }
184 #endif
std::string get_sha1(const T &_buffer)
Compute the SHA1 hash of an array of bytes.
Definition: CommonIface.hh:156
const char * getEnv(const char *_name)
Cross platform retrieval of an environment variable.
Forward declarations for the common classes.
Definition: Animation.hh:33
std::string find_file_path(const std::string &_file)
search for a file in common::SystemPaths
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 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.
#define NULL
Definition: CommonTypes.hh:31
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.