word.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2025 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::word
 
Description
    A class for handling words, derived from string.
 
    A word is a string of characters without whitespace, quotes, slashes,
    semicolons or brace brackets. Words are delimited by whitespace.
 
SourceFiles
    wordStatics.C
    word.C
    wordIO.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef word_H
#define word_H
 
#include "string.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of friend functions and operators
class word;
inline word operator&(const word&, const word&);
Istream& operator>>(Istream&, word&);
Ostream& operator<<(Ostream&, const word&);
 
 
/*---------------------------------------------------------------------------*\
                            Class word Declaration
\*---------------------------------------------------------------------------*/
 
class word
:
    public string
{
    // Private Member Functions
 
        //- Strip invalid characters from this word
        inline void stripInvalid();
 
 
public:
 
    // Static Data Members
 
        static const char* const typeName;
        static int debug;
 
        //- An empty word
        static const word null;
 
 
    // Constructors
 
        //- Construct null
        inline word();
 
        //- Copy constructor
        inline word(const word&);
 
        //- Copy constructor of character array
        inline word(const char*, const bool doStripInvalid=true);
 
        //- Copy constructor with a maximum number of characters
        inline word
        (
            const char*,
            const size_type,
            const bool doStripInvalid
        );
 
        //- Copy constructor of string
        inline word(const string&, const bool doStripInvalid=true);
 
        //- Copy constructor of std::string
        inline word(const std::string&, const bool doStripInvalid=true);
 
        //- Construct from Istream
        word(Istream&);
 
 
    // Member Functions
 
        //- Is this character valid for a word
        inline static bool valid(char);
 
        //- Return the word with the first letter capitalised
        inline word capitalise() const;
 
 
    // Member Operators
 
        // Assignment
 
            inline void operator=(const word&);
            inline void operator=(const string&);
            inline void operator=(const std::string&);
            inline void operator=(const char*);
 
 
    // Friend Operators
 
        friend word operator&(const word&, const word&);
 
 
    // IOstream Operators
 
        friend Istream& operator>>(Istream&, word&);
        friend Ostream& operator<<(Ostream&, const word&);
};
 
 
void writeEntry(Ostream& os, const word& value);
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "wordI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //