FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
fife_boost_filesystem.h
Go to the documentation of this file.
1 /***************************************************************************
2 * Copyright (C) 2005-2017 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 
45  bool HasParentPath(const bfs::path& path);
46 
51  bfs::path GetParentPath(const bfs::path& path);
52 
58  std::string GetFilenameFromPath(const bfs::path& path);
59 
64  std::string GetFilenameFromDirectoryIterator(const bfs::directory_iterator& iter);
65 
70  std::string GetPathIteratorAsString(const bfs::path::iterator& pathIter);
71 
76  bfs::path GetAbsolutePath(const std::string& path);
77 
82  bfs::path GetAbsolutePath(const bfs::path& path);
83 
88  bool HasExtension(const std::string& path);
89 
94  bool HasExtension(const bfs::path& path);
95 
101  std::string GetExtension(const std::string& path);
102 
108  std::string GetExtension(const bfs::path& path);
109 
115  std::string GetStem(const std::string& path);
116 
122  std::string GetStem(const bfs::path& path);
123 }
124 
125 #endif
std::string GetFilenameFromPath(const bfs::path &path)
Helper function to retrieve the filename from a boost filesystem path filename is just the name of th...
std::string GetFilenameFromDirectoryIterator(const bfs::directory_iterator &iter)
Helper function to retrieve a filename string from a directory iterator.
bool HasParentPath(const bfs::path &path)
Helper function to determine if a path object has a parent path.
bfs::path GetParentPath(const bfs::path &path)
Helper function to retrieve a parent path object from a path object.
std::string GetPathIteratorAsString(const bfs::path::iterator &pathIter)
Helper function to retrieve the path iterator in a string representation.
bfs::path GetAbsolutePath(const std::string &path)
Helper function to retrieve an absolute path from a given relative path.
bool HasExtension(const std::string &path)
Helper function to check if a filename has an extension.
std::string GetStem(const std::string &path)
Helper function to retrieve the filename minus any extension.
std::string GetExtension(const std::string &path)
Helper function to retrieve the extension.