Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Util.h
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * Util.h
17  * File related helper functions.
18  * Copyright (C) 2013 Simon Newton
19  */
20 
21 #ifndef INCLUDE_OLA_FILE_UTIL_H_
22 #define INCLUDE_OLA_FILE_UTIL_H_
23 
24 #include <string>
25 #include <vector>
26 
27 namespace ola {
28 namespace file {
29 
30 extern const char PATH_SEPARATOR;
31 
37 std::string ConvertPathSeparators(const std::string &path);
38 
45 std::string JoinPaths(const std::string &first, const std::string &second);
46 
55 bool FindMatchingFiles(const std::string &directory,
56  const std::string &prefix,
57  std::vector<std::string> *files);
58 
67 bool FindMatchingFiles(const std::string &directory,
68  const std::vector<std::string> &prefixes,
69  std::vector<std::string> *files);
70 
79 bool ListDirectory(const std::string& directory,
80  std::vector<std::string> *files);
81 
89 std::string FilenameFromPathOrDefault(const std::string &path,
90  const std::string &default_value);
91 
99 std::string FilenameFromPathOrPath(const std::string &path);
100 
106 std::string FilenameFromPath(const std::string &path);
107 } // namespace file
108 } // namespace ola
109 #endif // INCLUDE_OLA_FILE_UTIL_H_
string ConvertPathSeparators(const string &path)
Convert all separators in a path to the OS's version.
Definition: Util.cpp:53
bool FindMatchingFiles(const string &directory, const string &prefix, vector< string > *files)
Find all files in a directory that match the given prefix.
Definition: Util.cpp:84
string JoinPaths(const string &first, const string &second)
Join two parts of a path.
Definition: Util.cpp:63
bool ListDirectory(const string &directory, vector< string > *files)
Get a list of all files in a directory.
Definition: Util.cpp:168
string FilenameFromPathOrDefault(const string &path, const string &default_value)
Convert a path to a filename.
Definition: Util.cpp:173
string FilenameFromPathOrPath(const string &path)
Convert a path to a filename (this variant is good for switching based on executable names) ...
Definition: Util.cpp:184
string FilenameFromPath(const string &path)
Convert a path to a filename.
Definition: Util.cpp:188
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44