Debian Codegraph @

engine/core/vfs/fife_boost_filesystem.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21 #ifndef FIFE_VFS_H_
22 #define FIFE_VFS_H_
23
24 // Standard C++ library includes
25
26 // 3rd party library includes
27 #include <boost/filesystem.hpp>
28 // #include <boost/filesystem/operations.hpp>
29 // #include <boost/filesystem/path.hpp>
30
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35
36 namespace bfs = boost::filesystem;
37
38 namespace FIFE {
39
40 /** Helper function to determine if a path object has a parent path
41 * @param path boost filesystem path object
42 * @return true - does have parent path
43 * false - does not have parent path
44 */
45 bool HasParentPath(const bfs::path& path);
46
47 /** Helper function to retrieve a parent path object from a path object
48 * @param path boost filesystem path object
49 * @return a path object with parent of passed in parameter
50 */
51 bfs::path GetParentPath(const bfs::path& path);
52
53 /** Helper function to retrieve the filename from a boost filesystem path
54 * filename is just the name of the file and any extension without a path
55 * @param path boost filesystem path object
56 * @return filename string
57 */
58 std::string GetFilenameFromPath(const bfs::path& path);
59
60 /** Helper function to retrieve a filename string from a directory iterator
61 * @param iter boost filesystem directory_iterator object
62 * @return a filename string
63 */
64 std::string GetFilenameFromDirectoryIterator(const bfs::directory_iterator& iter);
65
66 /** Helper function to retrieve the path iterator in a string representation
67 * @param pathIter the iterator to get the string from
68 * @return a string representing the value in the path iterator
69 */
70 std::string GetPathIteratorAsString(const bfs::path::iterator& pathIter);
71
72 /** Helper function to retrieve an absolute path from a given relative path
73 * @param path std::string object
74 * @return a boost filesystem path object
75 */
76 bfs::path GetAbsolutePath(const std::string& path);
77
78 /** Helper function to retrieve an absolute path from a given relative path
79 * @param path boost filesystem path object
80 * @return a boost filesystem path object
81 */
82 bfs::path GetAbsolutePath(const bfs::path& path);
83
84 /** Helper function to check if a filename has an extension
85 * @param path boost filesystem path object
86 * @return true if filename has extension, false if not
87 */
88 bool HasExtension(const std::string& path);
89
90 /** Helper function to check if a filename has an extension
91 * @param path boost filesystem path object
92 * @return true if filename has extension, false if not
93 */
94 bool HasExtension(const bfs::path& path);
95
96 /** Helper function to retrieve the extension
97 * @note the extension includes the "."
98 * @param path the input path string
99 * @return the extension on the input path
100 */
101 std::string GetExtension(const std::string& path);
102
103 /** Helper function to retrieve the extension
104 * @note the extension includes the "."
105 * @param path the input path object
106 * @return the extension on the input path
107 */
108 std::string GetExtension(const bfs::path& path);
109
110 /** Helper function to retrieve the filename minus any extension
111 * @note the "." is NOT included
112 * @param path the input path string
113 * @return the filename minus any extension
114 */
115 std::string GetStem(const std::string& path);
116
117 /** Helper function to retrieve the filename minus any extension
118 * @note the "." is NOT included
119 * @param path the input path object
120 * @return the filename minus any extension
121 */
122 std::string GetStem(const bfs::path& path);
123 }
124
125 #endif