1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
* Copyright 2003-2018 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_PATH_HXX
#define MPD_FS_PATH_HXX
#include "util/Compiler.h"
#include "Traits.hxx"
#include <string>
#include <assert.h>
class AllocatedPath;
/**
* A path name in the native file system character set.
*
* This class manages a pointer to an existing path string. While an
* instance lives, the string must not be invalidated.
*/
class Path : public PathTraitsFS::Pointer {
using Traits = PathTraitsFS;
typedef Traits::Pointer Base;
constexpr Path(const_pointer_type _value):Base(_value) {}
public:
/**
* Construct a "nulled" instance. Its IsNull() method will
* return true. Such an object must not be used.
*
* @see IsNull()
*/
constexpr Path(std::nullptr_t):Base(nullptr) {}
/**
* Copy a #Path object.
*/
constexpr Path(const Path &) = default;
/**
* Create a new instance pointing to the specified path
* string.
*/
static constexpr Path FromFS(const_pointer_type fs) {
return Path(fs);
}
/**
* Copy a #Path object.
*/
Path &operator=(const Path &) = default;
/**
* Check if this is a "nulled" instance. A "nulled" instance
* must not be used.
*/
bool IsNull() const {
return Base::IsNull();
}
/**
* Clear this object's value, make it "nulled".
*
* @see IsNull()
*/
void SetNull() {
*this = nullptr;
}
/**
* @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 noexcept {
assert(!IsNull());
return Traits::GetLength(c_str());
}
/**
* 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_type c_str() const noexcept {
return Base::c_str();
}
/**
* Returns a pointer to the raw value, not necessarily
* null-terminated.
*/
gcc_pure
const_pointer_type data() const noexcept {
return c_str();
}
/**
* Does the path contain a newline character? (Which is
* usually rejected by MPD because its protocol cannot
* transfer newline characters).
*/
gcc_pure
bool HasNewline() const noexcept {
return Traits::Find(c_str(), '\n') != nullptr;
}
/**
* 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 noexcept;
/**
* Like ToUTF8(), but throws on error.
*/
std::string ToUTF8Throw() const;
/**
* Determine the "base" file name.
* The return value points inside this object.
*/
gcc_pure
Path GetBase() const noexcept {
return FromFS(Traits::GetBase(c_str()));
}
/**
* Gets directory name of this path.
* Returns a "nulled" instance on error.
*/
gcc_pure
AllocatedPath GetDirectoryName() const noexcept;
/**
* 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_type Relative(Path other_fs) const noexcept {
return Traits::Relative(c_str(), other_fs.c_str());
}
gcc_pure
bool IsAbsolute() const noexcept {
return Traits::IsAbsolute(c_str());
}
gcc_pure
const_pointer_type GetSuffix() const noexcept;
};
/**
* Concatenate two path components using the directory separator.
*
* Wrapper for AllocatedPath::Build().
*/
AllocatedPath
operator/(Path a, Path b) noexcept;
#endif