Ostream.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-2026 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::Ostream
 
Description
    An Ostream is an abstract base class for all output systems
    (streams, files, token lists, etc).
 
SourceFiles
    Ostream.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Ostream_H
#define Ostream_H
 
#include "IOstream.H"
#include "verbatimString.H"
#include "keyType.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class token;
 
/*---------------------------------------------------------------------------*\
                           Class Ostream Declaration
\*---------------------------------------------------------------------------*/
 
class Ostream
:
    public IOstream
{
 
protected:
 
    // Protected data
 
        //- Number of spaces per indent level
        static const unsigned short indentSize_ = 4;
 
        //- Current indent level
        unsigned short indentLevel_;
 
 
public:
 
    // Constructors
 
        //- Set stream status
        Ostream
        (
            const streamFormat format = ASCII,
            const versionNumber version = currentVersion,
            const compressionType compression = UNCOMPRESSED,
            const bool global = false
        )
        :
            IOstream(format, version, compression, global),
            indentLevel_(0)
        {}
 
 
    //- Destructor
    virtual ~Ostream()
    {}
 
 
    // Member Functions
 
        // Write functions
 
            //- Write token
            virtual Ostream& write(const token&);
 
            //- Write the compound token tag if the name is a compound token
            virtual Ostream& writeCompoundTag(const word& typeName);
 
            //- Write character
            virtual Ostream& write(const char) = 0;
 
            //- Write character string
            virtual Ostream& write(const char*) = 0;
 
            //- Write word
            virtual Ostream& write(const word&) = 0;
 
            //- Write string
            virtual Ostream& write(const string&) = 0;
 
            //- Write keyType
            virtual Ostream& write(const keyType&) = 0;
 
            //- Write verbatimString
            virtual Ostream& write(const verbatimString&) = 0;
 
            //- Write std::string surrounded by quotes.
            //  Optional write without quotes.
            virtual Ostream& writeQuoted
            (
                const std::string&,
                const bool quoted=true
            ) = 0;
 
            //- Write int32_t
            virtual Ostream& write(const int32_t) = 0;
 
            //- Write int64_t
            virtual Ostream& write(const int64_t) = 0;
 
            //- Write uint32_t
            virtual Ostream& write(const uint32_t) = 0;
 
            //- Write uint64_t
            virtual Ostream& write(const uint64_t) = 0;
 
            //- Write floatScalar
            virtual Ostream& write(const floatScalar) = 0;
 
            //- Write doubleScalar
            virtual Ostream& write(const doubleScalar) = 0;
 
            //- Write longDoubleScalar
            virtual Ostream& write(const longDoubleScalar) = 0;
 
            //- Write binary block
            virtual Ostream& write(const char*, std::streamsize) = 0;
 
            //- Add indentation characters
            virtual void indent() = 0;
 
            //- Return indent level
            unsigned short indentLevel() const
            {
                return indentLevel_;
            }
 
            //- Access to indent level
            unsigned short& indentLevel()
            {
                return indentLevel_;
            }
 
            //- Return the number of characters in an indent
            unsigned short indentSize() const
            {
                return indentLevel_*indentSize_;
            }
 
            //- Incrememt the indent level
            void incrIndent()
            {
                indentLevel_++;
            }
 
            //- Decrememt the indent level
            void decrIndent();
 
            //- Write the keyword followed by an appropriate indentation.
            //  Here for backward compatibility, replaced by
            //  writeKeyword(Foam::Ostream& os, const keyType& kw);
            Ostream& writeKeyword(const keyType&);
 
 
        // Stream state functions
 
            //- Flush stream
            virtual void flush() = 0;
 
            //- Add newline and flush stream
            virtual void endl() = 0;
 
            //- Get width of output field
            virtual int width() const = 0;
 
            //- Set width of output field (and return old width)
            virtual int width(const int w) = 0;
 
            //- Get precision of output field
            virtual int precision() const = 0;
 
            //- Set precision of output field (and return old precision)
            virtual int precision(const int p) = 0;
 
 
    // Member Operators
 
        //- Return a non-const reference to const Ostream
        //  Needed for write functions where the stream argument is temporary:
        //  e.g. thing thisThing(OFstream("thingFileName")());
        Ostream& operator()() const
        {
            return const_cast<Ostream&>(*this);
        }
};
 
 
// --------------------------------------------------------------------
// ------ Manipulators (not taking arguments)
// --------------------------------------------------------------------
 
typedef Ostream& (*OstreamManip)(Ostream&);
 
//- operator<< handling for manipulators without arguments
inline Ostream& operator<<(Ostream& os, OstreamManip f)
{
    return f(os);
}
 
//- operator<< handling for manipulators without arguments
inline Ostream& operator<<(Ostream& os, IOstreamManip f)
{
    f(os);
    return os;
}
 
 
//- Indent stream
inline Ostream& indent(Ostream& os)
{
    os.indent();
    return os;
}
 
//- Indent stream or add newline if indent level == 0
inline Ostream& indentOrNl(Ostream& os)
{
    if (os.indentLevel() == 0)
    {
        os.endl();
    }
    else
    {
        os.indent();
    }
 
    return os;
}
 
//- Increment the indent level
inline Ostream& incrIndent(Ostream& os)
{
    os.incrIndent();
    return os;
}
 
//- Decrement the indent level
inline Ostream& decrIndent(Ostream& os)
{
    os.decrIndent();
    return os;
}
 
 
//- Flush stream
inline Ostream& flush(Ostream& os)
{
    os.flush();
    return os;
}
 
 
//- Add newline and flush stream
inline Ostream& endl(Ostream& os)
{
    os.endl();
    return os;
}
 
 
// Useful aliases for tab and newline characters
static const char tab = '\t';
static const char nl = '\n';
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //