Files
openfoam/src/OpenFOAM/db/IOstreams/Sstreams/prefixOSstream.H
Mark Olesen 1d866d7fe8 reworked IOstreams
- Istream and Ostream now retain backslashes when reading/writing strings.
  The previous implementation simply discarded them, except when used to
  escape a double-quote or a newline. It is now vitally important to retain
  them, eg for quoting regular expression meta-characters.

  The backslash continues to be used as an escape character for double-quote
  and newline, but otherwise get passed through "as-is" without any other
  special meaning (ie, they are *NOT* C-style strings). This helps avoid
  'backslash hell'!
  For example,
     string:   "match real dots \.+, question mark \? or any char .*"
     C-style:  "match real dots \\.+, question mark \\? or any char .*"

- combined subfiles in db/IOstreams, some had more copyright info than code
- OPstreamI.H contained only private methods, moved into OPstream.C

Are these really correct?
   IOstreams/Istream.H:#   include "HashTable.C"
   token/token.H:#define NoHashTableC
2009-01-03 12:52:27 +01:00

149 lines
3.9 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2009 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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::prefixOSstream
Description
Version of OSstream which prints a prefix on each line.
This is useful for running in parallel as it allows the processor number
to be automatically prepended to each message line.
SourceFiles
prefixOSstream.C
\*---------------------------------------------------------------------------*/
#ifndef prefixOSstream_H
#define prefixOSstream_H
#include "OSstream.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class prefixOSstream Declaration
\*---------------------------------------------------------------------------*/
class prefixOSstream
:
public OSstream
{
// Private data
bool printPrefix_;
string prefix_;
// Private member functions
inline void checkWritePrefix();
public:
// Constructors
//- Set stream status
prefixOSstream
(
ostream& os,
const string& name,
streamFormat format=ASCII,
versionNumber version=currentVersion,
compressionType compression=UNCOMPRESSED
);
// Member functions
// Enquiry
//- Return the prefix of the stream
const string& prefix() const
{
return prefix_;
}
//- Return non-const access to the prefix of the stream
string& prefix()
{
return prefix_;
}
// Write functions
//- Write next token to stream
virtual Ostream& write(const token&);
//- Write character
virtual Ostream& write(const char);
//- Write character string
virtual Ostream& write(const char*);
//- Write word
virtual Ostream& write(const word&);
//- Write string
virtual Ostream& write(const string&);
//- Write label
virtual Ostream& write(const label);
//- Write floatScalar
virtual Ostream& write(const floatScalar);
//- Write doubleScalar
virtual Ostream& write(const doubleScalar);
//- Write binary block
virtual Ostream& write(const char*, std::streamsize);
//- Add indentation characters
virtual void indent();
// Print
//- Print description of IOstream to Ostream
virtual void print(Ostream&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //