File: foamExprParserInfo.C

package info (click to toggle)
openfoam 1912.200626-3
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 238,956 kB
  • sloc: cpp: 1,159,641; sh: 15,902; ansic: 5,195; lex: 660; xml: 387; python: 282; awk: 212; makefile: 103; sed: 88; csh: 3
file content (199 lines) | stat: -rw-r--r-- 5,444 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2019 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.

Application
    foamExprParserInfo

Group
    grpTools

Description
    Display token names or rules for specified expression parsers.

    In the Lemon grammar, terminals (uppercase) are listed first.
    Non-terminals (lowercase) are listed second.

    The current OpenFOAM grammar short naming conventions:
    - svalue : scalar value
    - sfield : scalar field
    - lfield : logic field
    - vfield : vector field
    - tfield : tensor field
    - hfield : sphericalTensor field
    - yfield : symmTensor field
    .
    Prefixes: 's' (surface) or 'p' (point).
    For example, psfield for a point scalar field

Usage
    \b foamExprParserInfo [OPTION]

    Options:
      - \par -rules
        Print parser rules

      - \par -tokens
        Print token names (default)

      - \par -all
        Display information for all parsers

      - \par -field
        Field expression parser information

      - \par -patch
        Patch expression parser information

      - \par -volume
        Volume expression parser information

\*---------------------------------------------------------------------------*/

#include "argList.H"
#include "IOstreams.H"
#include "List.H"
#include "fieldExprParser.H"
#include "patchExprParser.H"
#include "volumeExprParser.H"

using namespace Foam;

template<class Parser>
void printInformation
(
    Ostream& os,
    const word& name,
    const bool printNames,
    const bool printRules
)
{
    if (printNames)
    {
        os << nl << "# Tokens for " << name << nl;
        Parser::printTokenNames(os);
    }

    if (printRules)
    {
        os << nl << "# Rules for " << name << nl;
        Parser::printRules(os);
    }
}


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Main program:

int main(int argc, char *argv[])
{
    argList::noBanner();
    argList::noParallel();
    argList::setAdvanced("case");  // Hide -case : has no meaning here

    argList::addNote
    (
        "Display token names or rules for specified expression parsers.\n"
        "In the Lemon grammar, terminals (uppercase) are listed first.\n"
        "Non-terminals (lowercase) are listed second.\n \n"
        "The current OpenFOAM grammar short naming conventions:\n"
        "  * svalue : scalar value\n"
        "  * sfield : scalar field\n"
        "  * lfield : logic field\n"
        "  * vfield : vector field\n"
        "  * tfield : tensor field\n"
        "  * hfield : sphericalTensor field\n"
        "  * yfield : symmTensor field\n"
        " \n"
        "Prefixes: 's' (surface) or 'p' (point).\n"
        "Eg, psfield for a point scalar field\n"
    );

    argList::addBoolOption("rules", "Print parser rules");
    argList::addBoolOption("tokens", "Print token names (default)");

    argList::addBoolOption("all", "Display information for all parsers");
    argList::addBoolOption("field", "Field expression parser information");
    argList::addBoolOption("patch", "Patch expression parser information");
    argList::addBoolOption("volume", "Volume expression parser information");

    argList args(argc, argv);

    const bool all = args.found("all");
    const bool printRules = args.found("rules");
    const bool printNames = args.found("tokens") || !printRules;

    label count = 0;

    if (all || args.found("field"))
    {
        ++count;
        printInformation<expressions::fieldExpr::parser>
        (
            Info,
            "field",
            printNames,
            printRules
        );
    }

    if (all || args.found("patch"))
    {
        ++count;
        printInformation<expressions::patchExpr::parser>
        (
            Info,
            "patch",
            printNames,
            printRules
        );
    }

    if (all || args.found("volume"))
    {
        ++count;
        printInformation<expressions::volumeExpr::parser>
        (
            Info,
            "volume",
            printNames,
            printRules
        );
    }

    if (!count)
    {
        InfoErr
            << "Error: no parser selected." << nl
            << "See '" << args.executable() << " -help' for usage" << nl
            << nl;

        return 1;
    }

    return 0;
}


// ************************************************************************* //