220 lines
5.7 KiB
C++
220 lines
5.7 KiB
C++
/* Copyright (c) 2010 Wildfire Games
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* Path string class, similar to boost::filesystem::basic_path.
|
|
*/
|
|
|
|
// notes:
|
|
// - this module is independent of lib/file so that it can be used from
|
|
// other code without pulling in the entire file manager.
|
|
// - there is no restriction on buffer lengths except the underlying OS.
|
|
// input buffers must not exceed PATH_MAX chars, while outputs
|
|
// must hold at least that much.
|
|
// - unless otherwise mentioned, all functions are intended to work with
|
|
// native and VFS paths.
|
|
// when reading, both '/' and SYS_DIR_SEP are accepted; '/' is written.
|
|
|
|
#ifndef INCLUDED_PATH
|
|
#define INCLUDED_PATH
|
|
|
|
#if CONFIG_ENABLE_BOOST
|
|
# include "boost/functional/hash.hpp"
|
|
#endif
|
|
|
|
#include <cstring>
|
|
|
|
namespace ERR
|
|
{
|
|
const LibError PATH_CHARACTER_ILLEGAL = -100300;
|
|
const LibError PATH_CHARACTER_UNSAFE = -100301;
|
|
const LibError PATH_NOT_FOUND = -100302;
|
|
}
|
|
|
|
/**
|
|
* is s2 a subpath of s1, or vice versa? (equal counts as subpath)
|
|
*
|
|
* @param s1, s2 comparand strings
|
|
* @return bool
|
|
**/
|
|
LIB_API bool path_is_subpath(const wchar_t* s1, const wchar_t* s2);
|
|
|
|
/**
|
|
* Get the path component of a path.
|
|
* Skips over all characters up to the last dir separator, if any.
|
|
*
|
|
* @param path Input path.
|
|
* @return pointer to path component within \<path\>.
|
|
**/
|
|
LIB_API const wchar_t* path_name_only(const wchar_t* path);
|
|
|
|
|
|
// NB: there is a need for 'generic' paths (e.g. for Trace entry / archive pathnames).
|
|
// converting via c_str would be inefficient, and the Os/VfsPath typedefs are hopefully
|
|
// sufficient to avoid errors.
|
|
class Path
|
|
{
|
|
public:
|
|
typedef std::wstring String;
|
|
|
|
Path() {}
|
|
Path(const char* p) : path(p, p+strlen(p)) {}
|
|
Path(const wchar_t* p) : path(p, p+wcslen(p)) {}
|
|
Path(const std::string& s) : path(s.begin(), s.end()) {}
|
|
Path(const std::wstring& s) : path(s) {}
|
|
|
|
bool empty() const
|
|
{
|
|
return path.empty();
|
|
}
|
|
|
|
const String& string() const
|
|
{
|
|
return path;
|
|
}
|
|
|
|
bool operator<(const Path& rhs) const
|
|
{
|
|
return wcscasecmp(path.c_str(), rhs.path.c_str()) < 0;
|
|
}
|
|
|
|
bool operator==(const Path& rhs) const
|
|
{
|
|
return wcscasecmp(path.c_str(), rhs.path.c_str()) == 0;
|
|
}
|
|
|
|
bool operator!=(const Path& rhs) const
|
|
{
|
|
return !operator==(rhs);
|
|
}
|
|
|
|
bool IsDirectory() const
|
|
{
|
|
if(empty()) // (ensure length()-1 is safe)
|
|
return true; // (the VFS root directory is represented as an empty string)
|
|
|
|
// note: ideally, path strings would only contain '/' or even SYS_DIR_SEP.
|
|
// however, windows-specific code (e.g. the sound driver detection)
|
|
// uses these routines with '\\' strings. converting them all to
|
|
// '/' and then back before passing to OS functions would be annoying.
|
|
// also, the self-tests verify correct operation of such strings.
|
|
// it would be error-prone to only test the platform's separators.
|
|
// we therefore allow all separators here.
|
|
return path[path.length()-1] == '/' || path[path.length()-1] == '\\';
|
|
}
|
|
|
|
Path Parent() const
|
|
{
|
|
size_t idxSlash = path.find_last_of('/');
|
|
if(idxSlash == String::npos)
|
|
{
|
|
idxSlash = path.find_last_of('\\');
|
|
if(idxSlash == String::npos)
|
|
return L"";
|
|
}
|
|
return path.substr(0, idxSlash);
|
|
}
|
|
|
|
Path Filename() const
|
|
{
|
|
size_t idxSlash = path.find_last_of('/');
|
|
if(idxSlash == String::npos)
|
|
{
|
|
idxSlash = path.find_last_of('\\');
|
|
if(idxSlash == String::npos)
|
|
return path;
|
|
}
|
|
return path.substr(idxSlash+1);
|
|
}
|
|
|
|
Path Basename() const
|
|
{
|
|
const Path filename = Filename();
|
|
const size_t idxDot = filename.string().find_last_of('.');
|
|
if(idxDot == String::npos)
|
|
return filename;
|
|
return filename.string().substr(0, idxDot);
|
|
}
|
|
|
|
// (Path return type allows callers to use our operator==)
|
|
Path Extension() const
|
|
{
|
|
const Path filename = Filename();
|
|
const size_t idxDot = filename.string().find_last_of('.');
|
|
if(idxDot == String::npos)
|
|
return Path();
|
|
return filename.string().substr(idxDot);
|
|
}
|
|
|
|
Path ChangeExtension(Path extension) const
|
|
{
|
|
return Parent() / Path(Basename().string() + extension.string());
|
|
}
|
|
|
|
Path operator/(Path rhs) const
|
|
{
|
|
Path ret = *this;
|
|
if(!ret.IsDirectory())
|
|
ret.path += '/';
|
|
ret.path += rhs.path;
|
|
return ret;
|
|
}
|
|
|
|
static LibError Validate(String::value_type c);
|
|
|
|
private:
|
|
String path;
|
|
};
|
|
|
|
static inline std::wostream& operator<<(std::wostream& s, const Path& path)
|
|
{
|
|
s << path.string();
|
|
return s;
|
|
}
|
|
|
|
static inline std::wistream& operator>>(std::wistream& s, Path& path)
|
|
{
|
|
Path::String string;
|
|
s >> string;
|
|
path = Path(string);
|
|
return s;
|
|
}
|
|
|
|
#if CONFIG_ENABLE_BOOST
|
|
|
|
namespace boost {
|
|
|
|
template<>
|
|
struct hash<Path> : std::unary_function<Path, std::size_t>
|
|
{
|
|
std::size_t operator()(const Path& path) const
|
|
{
|
|
return hash_value(path.string());
|
|
}
|
|
};
|
|
|
|
}
|
|
|
|
#endif // #if CONFIG_ENABLE_BOOST
|
|
|
|
#endif // #ifndef INCLUDED_PATH
|