src/OpenFOAM/primitives/strings/fileName/fileName.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::fileName
  27
  28 Description
  29     A class for handling file names.
  30
  31     A fileName can be
  32       - constructed from a char*, a string or a word
  33       - concatenated by adding a '/' separator
  34       - decomposed into the path, name or component list
  35       - interrogated for type and access mode
  36
  37     The string::expand() method expands environment variables, etc,
  38
  39 SourceFiles
  40     fileName.C
  41     fileNameIO.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef fileName_H
  46 #define fileName_H
  47
  48 #include "word.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 template<class T> class List;
  56 typedef List<word> wordList;
  57
  58 // Forward declaration of friend functions and operators
  59
  60 class fileName;
  61
  62 Istream& operator>>(Istream&, fileName&);
  63 Ostream& operator<<(Ostream&, const fileName&);
  64
  65
  66 /*---------------------------------------------------------------------------*\
  67                           Class fileName Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class fileName
  71 :
  72     public string
  73 {
  74     // Private member functions
  75
  76         //- Strip invalid characters
  77         inline void stripInvalid();
  78
  79
  80 public:
  81
  82     //- Enumerations to handle file types and modes.
  83     enum Type
  84     {
  85         UNDEFINED,
  86         FILE,
  87         DIRECTORY,
  88         LINK
  89     };
  90
  91
  92     // Static data members
  93
  94         static const char* const typeName;
  95         static int debug;
  96         static const fileName null;
  97
  98
  99     // Constructors
 100
 101         //- Construct null
 102         inline fileName();
 103
 104         //- Construct as copy
 105         inline fileName(const fileName&);
 106
 107         //- Construct as copy of word
 108         inline fileName(const word&);
 109
 110         //- Construct as copy of string
 111         inline fileName(const string&);
 112
 113         //- Construct as copy of std::string
 114         inline fileName(const std::string&);
 115
 116         //- Construct as copy of character array
 117         inline fileName(const char*);
 118
 119         //- Construct by concatenating elements of wordList separated by '/'
 120         explicit fileName(const wordList&);
 121
 122         //- Construct from Istream
 123         fileName(Istream&);
 124
 125
 126     // Member functions
 127
 128         //- Is this character valid for a fileName?
 129         inline static bool valid(char);
 130
 131         //- Cleanup file name
 132         //  eg, remove repeated slashes, etc.
 133         bool clean();
 134
 135         //- Cleanup file name
 136         //  eg, remove repeated slashes, etc.
 137         fileName clean() const;
 138
 139         // Interogation
 140
 141             //- Return the file type: FILE, DIRECTORY or UNDEFINED
 142             Type type() const;
 143
 144         // Decomposition
 145
 146             //- Return file name (part beyond last /)
 147             word name() const;
 148
 149             //- Return directory path name (part before last /)
 150             fileName path() const;
 151
 152             //- Return file name without extension (part before last .)
 153             fileName lessExt() const;
 154
 155             //- Return file name extension (part after last .)
 156             word ext() const;
 157
 158             //- Return path components as wordList
 159             wordList components(const char delimiter='/') const;
 160
 161             //- Return a single component of the path
 162             word component(const size_type, const char delimiter='/') const;
 163
 164     // Member operators
 165
 166         // Assignment
 167
 168             const fileName& operator=(const fileName&);
 169             const fileName& operator=(const word&);
 170             const fileName& operator=(const string&);
 171             const fileName& operator=(const std::string&);
 172             const fileName& operator=(const char*);
 173
 174
 175     // IOstream operators
 176
 177         friend Istream& operator>>(Istream&, fileName&);
 178         friend Ostream& operator<<(Ostream&, const fileName&);
 179 };
 180
 181
 182 //- Assemble words and fileNames as pathnames by adding a '/' separator
 183 fileName operator/(const string&, const string&);
 184
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 } // End namespace Foam
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 #include "fileNameI.H"
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #endif
 197
 198 // ************************************************************************* //