char.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Primitive
27  char
28 
29 Description
30  A character and a pointer to a character string.
31 
32 SourceFiles
33  charIO.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef char_H
38 #define char_H
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class Istream;
46 class Ostream;
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 //- Read single character
51 char readChar(Istream& is);
52 
53 //- Read single character
54 Istream& operator>>(Istream& is, char& c);
55 
56 //- Write single character
57 Ostream& operator<<(Ostream& os, const char c);
58 
59 //- Write a nul-terminated C-string
60 Ostream& operator<<(Ostream& os, const char* str);
61 
62 //- Test for \em horizontal whitespace
63 inline bool isspace(char c)
64 {
65  return
66  (
67  c == ' '
68  || c == '\n'
69  || c == '\r'
70  || c == '\t'
71  );
72 }
73 
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 } // End namespace Foam
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #endif
82 
83 // ************************************************************************* //
Foam::readChar
char readChar(Istream &is)
Read single character.
Definition: charIO.C:33
Foam::operator>>
Istream & operator>>(Istream &, directionInfo &)
Definition: directionInfo.C:230
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition: boundaryPatch.C:83
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::constant::universal::c
const dimensionedScalar c
Speed of light in a vacuum.
Foam::isspace
bool isspace(char c)
Test for horizontal whitespace.
Definition: char.H:63