/*
* Copyright (C) 2003-2015 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_FS_ALLOCATED_PATH_HXX
#define MPD_FS_ALLOCATED_PATH_HXX
#include "check.h"
#include "Compiler.h"
#include "Traits.hxx"
#include "Path.hxx"
#include <cstddef>
#include <utility>
#include <string>
class Error;
/**
* A path name in the native file system character set.
*
* This class manages the memory chunk where this path string is
* stored.
*/
class AllocatedPath {
typedef PathTraitsFS::string string;
typedef PathTraitsFS::value_type value_type;
typedef PathTraitsFS::pointer pointer;
typedef PathTraitsFS::const_pointer const_pointer;
string value;
AllocatedPath(std::nullptr_t):value() {}
AllocatedPath(const_pointer _value):value(_value) {}
AllocatedPath(string &&_value):value(std::move(_value)) {}
static AllocatedPath Build(const_pointer a, size_t a_size,
const_pointer b, size_t b_size) {
return AllocatedPath(PathTraitsFS::Build(a, a_size, b, b_size));
}
public:
/**
* Copy an #AllocatedPath object.
*/
AllocatedPath(const AllocatedPath &) = default;
/**
* Move an #AllocatedPath object.
*/
AllocatedPath(AllocatedPath &&other):value(std::move(other.value)) {}
explicit AllocatedPath(Path other):value(other.c_str()) {}
~AllocatedPath();
/**
* Return a "nulled" instance. Its IsNull() method will
* return true. Such an object must not be used.
*
* @see IsNull()
*/
gcc_const
static AllocatedPath Null() {
return AllocatedPath(nullptr);
}
gcc_pure
operator Path() const {
return Path::FromFS(c_str());
}
/**
* Join two path components with the path separator.
*/
gcc_pure gcc_nonnull_all
static AllocatedPath Build(const_pointer a, const_pointer b) {
return Build(a, PathTraitsFS::GetLength(a),
b, PathTraitsFS::GetLength(b));
}
gcc_pure gcc_nonnull_all
static AllocatedPath Build(Path a, const_pointer b) {
return Build(a.c_str(), b);
}
gcc_pure gcc_nonnull_all
static AllocatedPath Build(Path a, Path b) {
return Build(a, b.c_str());
}
gcc_pure gcc_nonnull_all
static AllocatedPath Build(const_pointer a, const AllocatedPath &b) {
return Build(a, PathTraitsFS::GetLength(a),
b.value.c_str(), b.value.size());
}
gcc_pure gcc_nonnull_all
static AllocatedPath Build(const AllocatedPath &a, const_pointer b) {
return Build(a.value.c_str(), a.value.size(),
b, PathTraitsFS::GetLength(b));
}
gcc_pure
static AllocatedPath Build(const AllocatedPath &a,
const AllocatedPath &b) {
return Build(a.value.c_str(), a.value.size(),
b.value.c_str(), b.value.size());
}
/**
* Convert a C string that is already in the filesystem
* character set to a #Path instance.
*/
gcc_pure
static AllocatedPath FromFS(const_pointer fs) {
return AllocatedPath(fs);
}
/**
* Convert a C++ string that is already in the filesystem
* character set to a #Path instance.
*/
gcc_pure
static AllocatedPath FromFS(string &&fs) {
return AllocatedPath(std::move(fs));
}
/**
* Convert a UTF-8 C string to an #AllocatedPath instance.
* Returns return a "nulled" instance on error.
*/
gcc_pure gcc_nonnull_all
static AllocatedPath FromUTF8(const char *path_utf8);
gcc_pure gcc_nonnull_all
static AllocatedPath FromUTF8(const char *path_utf8, Error &error);
/**
* Copy an #AllocatedPath object.
*/
AllocatedPath &operator=(const AllocatedPath &) = default;
/**
* Move an #AllocatedPath object.
*/
AllocatedPath &operator=(AllocatedPath &&other) {
value = std::move(other.value);
return *this;
}
gcc_pure
bool operator==(const AllocatedPath &other) const {
return value == other.value;
}
gcc_pure
bool operator!=(const AllocatedPath &other) const {
return value != other.value;
}
/**
* Allows the caller to "steal" the internal value by
* providing a rvalue reference to the std::string attribute.
*/
string &&Steal() {
return std::move(value);
}
/**
* Check if this is a "nulled" instance. A "nulled" instance
* must not be used.
*/
bool IsNull() const {
return value.empty();
}
/**
* Clear this object's value, make it "nulled".
*
* @see IsNull()
*/
void SetNull() {
value.clear();
}
/**
* @return the length of this string in number of "value_type"
* elements (which may not be the number of characters).
*/
gcc_pure
size_t length() const {
return value.length();
}
/**
* Returns the value as a const C string. The returned
* pointer is invalidated whenever the value of life of this
* instance ends.
*/
gcc_pure
const_pointer c_str() const {
return value.c_str();
}
/**
* Returns a pointer to the raw value, not necessarily
* null-terminated.
*/
gcc_pure
const_pointer data() const {
return value.data();
}
/**
* Convert the path to UTF-8.
* Returns empty string on error or if this instance is "nulled"
* (#IsNull returns true).
*/
gcc_pure
std::string ToUTF8() const;
/**
* Gets directory name of this path.
* Returns a "nulled" instance on error.
*/
gcc_pure
AllocatedPath GetDirectoryName() const;
/**
* Determine the relative part of the given path to this
* object, not including the directory separator. Returns an
* empty string if the given path equals this object or
* nullptr on mismatch.
*/
gcc_pure
const_pointer Relative(Path other_fs) const {
return PathTraitsFS::Relative(c_str(), other_fs.c_str());
}
/**
* Chop trailing directory separators.
*/
void ChopSeparators();
gcc_pure
bool IsAbsolute() const {
return PathTraitsFS::IsAbsolute(c_str());
}
};
#endif
