File size: 8,342 Bytes
5a600cf | 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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM 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 3 of the License, or
(at your option) any later version.
OpenFOAM 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 OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fileName
Description
A class for handling file names.
A fileName is a string of characters without whitespace or quotes.
A fileName can be
- constructed from a char*, a string or a word
- concatenated by adding a '/' separator
- decomposed into the path, name or component list
- interrogated for type and access mode
The string::expand() method expands environment variables, etc,
SourceFiles
fileName.C
fileNameIO.C
\*---------------------------------------------------------------------------*/
#ifndef fileName_H
#define fileName_H
#include "word.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
template<class T> class List;
typedef List<word> wordList;
// Forward declaration of friend functions and operators
class fileName;
Istream& operator>>(Istream&, fileName&);
Ostream& operator<<(Ostream&, const fileName&);
//- Enumeration of file types
enum class fileType
{
undefined,
file,
directory,
link
};
/*---------------------------------------------------------------------------*\
Class fileName Declaration
\*---------------------------------------------------------------------------*/
class fileName
:
public string
{
// Private Member Functions
//- Strip invalid characters
inline void stripInvalid();
public:
// Static Data Members
static const char* const typeName;
static int debug;
//- An empty fileName
static const fileName null;
// Constructors
//- Construct null
inline fileName();
//- Copy constructor
inline fileName(const fileName&);
//- Move constructor
inline fileName(fileName&&);
//- Copy constructor of word
inline fileName(const word&);
//- Copy constructor of string
inline fileName(const string&);
//- Copy constructor of std::string
inline fileName(const std::string&);
//- Copy constructor of character array
inline fileName(const char*);
//- Construct by concatenating elements of wordList separated by '/'
explicit fileName(const wordList&);
//- Construct from Istream
fileName(Istream&);
// Member Functions
//- Is this character valid for a fileName?
inline static bool valid(char);
//- Cleanup file name
//
// * Removes repeated slashes
// /abc////def --> /abc/def
//
// * Removes '/./'
// /abc/def/./ghi/. --> /abc/def/./ghi
// abc/def/./ --> abc/def
//
// * Removes '/../'
// /abc/def/../ghi/jkl/nmo/.. --> /abc/ghi/jkl
// abc/../def/ghi/../jkl --> abc/../def/jkl
//
// * Removes trailing '/'
//
bool clean();
//- Cleanup file name
// eg, remove repeated slashes, etc.
fileName clean() const;
// Interrogation
//- Return the file type: file, directory, undefined or
// link (only if followLink=false)
fileType type
(
const bool checkVariants = true,
const bool followLink = true
) const;
//- Return true if file name is a name without a path
// i.e. does not contain a '/'
bool isName() const;
//- Return true if file name has a path
// i.e. contains a '/'
bool hasPath() const;
//- Return true if file name is absolute
bool isAbsolute() const;
//- Convert from relative to absolute
fileName& toAbsolute();
// Decomposition
//- Return file name (part beyond last /)
//
// Behaviour compared to /usr/bin/basename:
// Input name() basename
// ----- ------ --------
// "foo" "foo" "foo"
// "/foo" "foo" "foo"
// "foo/bar" "bar" "bar"
// "/foo/bar" "bar" "bar"
// "/foo/bar/" "" "bar"
//
word name() const;
//- Return file name (part beyond last /), substitute for FOAM_CASE
string caseName() const;
//- Return file name part relative to FOAM_CASE
string relativePath() const;
//- Return file name, optionally without extension
word name(const bool noExt) const;
//- Return directory path name (part before last /)
//
// Behaviour compared to /usr/bin/dirname:
// input path() dirname
// ----- ------ -------
// "foo" "." "."
// "/foo" "/" "foo"
// "foo/bar" "foo" "foo"
// "/foo/bar" "/foo" "/foo"
// "/foo/bar/" "/foo/bar/" "/foo"
//
fileName path() const;
//- Return file name without extension (part before last .)
fileName lessExt() const;
//- Return file name extension (part after last .)
word ext() const;
//- Return path components as wordList
//
// Behaviour:
// Input components()
// ----- ------
// "foo" 1("foo")
// "/foo" 1("foo")
// "foo/bar" 2("foo", "bar")
// "/foo/bar" 2("foo", "bar")
// "/foo/bar/" 2("foo", "bar")
wordList components(const char delimiter='/') const;
//- Return a single component of the path
word component(const size_type, const char delimiter='/') const;
// Member Operators
// Assignment
void operator=(const fileName&);
void operator=(fileName&&);
void operator=(const word&);
void operator=(const string&);
void operator=(const std::string&);
void operator=(const char*);
//- Add a string to the fileName with a '/' separator
void operator/=(const string&);
// IOstream Operators
friend Istream& operator>>(Istream&, fileName&);
friend Ostream& operator<<(Ostream&, const fileName&);
};
//- Return a fileName created by concatenating two strings with '/' separator
fileName operator/(const string&, const string&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "fileNameI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|