1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
14#ifndef OSGDB_FILENAMEUTILS
15#define OSGDB_FILENAMEUTILS 1
17#include <osgDB/Export>
24/** Gets the parent path from full name (Ex: /a/b/c.Ext => /a/b). */
25extern OSGDB_EXPORT std::string getFilePath(const std::string& filename);
26/** Gets the extension without dot (Ex: /a/b/c.Ext => Ext). */
27extern OSGDB_EXPORT std::string getFileExtension(const std::string& filename);
28/** Gets the extension including dot (Ex: /a/b/c.Ext => .Ext). */
29extern OSGDB_EXPORT std::string getFileExtensionIncludingDot(const std::string& filename);
30/** Gets the lowercase extension without dot (Ex: /a/b/c.Ext => ext). */
31extern OSGDB_EXPORT std::string getLowerCaseFileExtension(const std::string& filename);
32/** Gets file name with extension (Ex: /a/b/c.Ext => c.Ext). */
33extern OSGDB_EXPORT std::string getSimpleFileName(const std::string& fileName);
34/** Gets file path without last extension (Ex: /a/b/c.Ext => /a/b/c ; file.ext1.ext2 => file.ext1). */
35extern OSGDB_EXPORT std::string getNameLessExtension(const std::string& fileName);
36/** Gets file path without \b all extensions (Ex: /a/b/c.Ext => /a/b/c ; file.ext1.ext2 => file). */
37extern OSGDB_EXPORT std::string getNameLessAllExtensions(const std::string& fileName);
38/** Gets file name without last extension (Ex: /a/b/c.Ext => c ; file.ext1.ext2 => file.ext1). */
39extern OSGDB_EXPORT std::string getStrippedName(const std::string& fileName);
40/** If 'to' is in a subdirectory of 'from' then this function returns the subpath, otherwise it just returns the file name.
41 * The function does \b not automagically resolve paths as the system does, so be careful to give canonical paths.
42 * However, the function interprets slashes ('/') and backslashes ('\') as they were equal.
44extern OSGDB_EXPORT std::string getPathRelative(const std::string& from, const std::string& to);
45/** Gets root part of a path ("/" or "C:"), or an empty string if none found. */
46extern OSGDB_EXPORT std::string getPathRoot(const std::string& path);
47/** Tests if path is absolute, as !getPathRoot(path).empty(). */
48extern OSGDB_EXPORT bool isAbsolutePath(const std::string& path);
51/** Converts forward slashes (/) to back slashes (\). */
52extern OSGDB_EXPORT std::string convertFileNameToWindowsStyle(const std::string& fileName);
53/** Converts back slashes (\) to forward slashes (/). */
54extern OSGDB_EXPORT std::string convertFileNameToUnixStyle(const std::string& fileName);
55extern OSGDB_EXPORT std::string convertToLowerCase(const std::string& fileName);
57const char UNIX_PATH_SEPARATOR = '/';
58const char WINDOWS_PATH_SEPARATOR = '\\';
60/** Get the path separator for the current platform. */
61extern OSGDB_EXPORT char getNativePathSeparator();
62/** Check if the path contains only the current platform's path separators. */
63extern OSGDB_EXPORT bool isFileNameNativeStyle(const std::string& fileName);
64/** Convert the path to contain only the current platform's path separators. */
65extern OSGDB_EXPORT std::string convertFileNameToNativeStyle(const std::string& fileName);
67extern OSGDB_EXPORT bool equalCaseInsensitive(const std::string& lhs,const std::string& rhs);
68extern OSGDB_EXPORT bool equalCaseInsensitive(const std::string& lhs,const char* rhs);
70extern OSGDB_EXPORT bool containsServerAddress(const std::string& filename);
71extern OSGDB_EXPORT std::string getServerProtocol(const std::string& filename);
72extern OSGDB_EXPORT std::string getServerAddress(const std::string& filename);
73extern OSGDB_EXPORT std::string getServerFileName(const std::string& filename);
75/** Concatenates two paths */
76extern OSGDB_EXPORT std::string concatPaths(const std::string& left, const std::string& right);
78/** Removes .. and . dirs in a path */
79extern OSGDB_EXPORT std::string getRealPath(const std::string& path);
81/** Splits a path into elements between separators (including Windows' root, if any). */
82extern OSGDB_EXPORT void getPathElements(const std::string& path, std::vector<std::string> & out_elements);
84/** Functor for helping sort filename in alphabetical and numerical order when using in conjunction with std::sort.*/
85struct FileNameComparator
87 inline bool operator() (const std::string& lhs, const std::string& rhs) const
89 std::string::size_type size_lhs = lhs.size();
90 std::string::size_type size_rhs = rhs.size();
91 std::string::size_type pos_lhs = 0;
92 std::string::size_type pos_rhs = 0;
93 while(pos_lhs<size_lhs && pos_rhs<size_rhs)
95 char c_lhs = lhs[pos_rhs];
96 char c_rhs = rhs[pos_rhs];
97 bool numeric_lhs = lhs[pos_lhs]>='0' && lhs[pos_lhs]<='9';
98 bool numeric_rhs = rhs[pos_rhs]>='0' && rhs[pos_rhs]<='9';
99 if (numeric_lhs && numeric_rhs)
101 std::string::size_type start_lhs = pos_lhs;
103 while(pos_lhs<size_lhs && (lhs[pos_lhs]>='0' && lhs[pos_lhs]<='9')) ++pos_lhs;
105 std::string::size_type start_rhs = pos_rhs;
107 while(pos_rhs<size_rhs && (rhs[pos_rhs]>='0' && rhs[pos_rhs]<='9')) ++pos_rhs;
109 if (pos_lhs<pos_rhs) return true;
110 else if (pos_rhs<pos_lhs) return false;
112 while(start_lhs<pos_lhs && start_rhs<pos_rhs)
114 if (lhs[start_lhs]<rhs[start_rhs]) return true;
115 if (lhs[start_lhs]>rhs[start_rhs]) return false;
122 if (c_lhs<c_rhs) return true;
123 else if (c_rhs<c_lhs) return false;
130 return pos_lhs<pos_rhs;
135extern OSGDB_EXPORT void stringcopy(char* dest, const char* src, size_t length);
137#define stringcopyfixedsize(DEST, SRC) stringcopy(DEST, SRC, sizeof(DEST));