/usr/include/freefoam/OpenFOAM/fileName.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ 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 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 <OpenFOAM/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&);
/*---------------------------------------------------------------------------*\
Class fileName Declaration
\*---------------------------------------------------------------------------*/
class fileName
:
public string
{
// Private member functions
//- Strip invalid characters
inline void stripInvalid();
public:
//- Enumerations to handle file types and modes.
enum Type
{
UNDEFINED,
FILE,
DIRECTORY,
LINK
};
// Static data members
static const char* const typeName;
static int debug;
static const fileName null;
// Constructors
//- Construct null
inline fileName();
//- Construct as copy
inline fileName(const fileName&);
//- Construct as copy of word
inline fileName(const word&);
//- Construct as copy of string
inline fileName(const string&);
//- Construct as copy of std::string
inline fileName(const std::string&);
//- Construct as copy 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
// eg, remove repeated slashes, etc.
bool clean();
//- Cleanup file name
// eg, remove repeated slashes, etc.
fileName clean() const;
// Interogation
//- Return the file type: FILE, DIRECTORY or UNDEFINED
Type type() const;
// Decomposition
//- Return file name (part beyond last /)
word name() const;
//- Return directory path name (part before last /)
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
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
const fileName& operator=(const fileName&);
const fileName& operator=(const word&);
const fileName& operator=(const string&);
const fileName& operator=(const std::string&);
const fileName& operator=(const char*);
// IOstream operators
friend Istream& operator>>(Istream&, fileName&);
friend Ostream& operator<<(Ostream&, const fileName&);
};
//- Assemble words and fileNames as pathnames by adding a '/' separator
fileName operator/(const string&, const string&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include <OpenFOAM/fileNameI.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|