-
Notifications
You must be signed in to change notification settings - Fork 0
/
_common_grammar_8hpp.html
293 lines (293 loc) · 18.2 KB
/
_common_grammar_8hpp.html
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>src/Control/CommonGrammar.hpp file | Quinoa docs</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="quinoa.m-dark-noindent+doxygen.compiled.css" />
<link rel="icon" href="quinoa_sum.png" type="image/png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">Quinoa <span class="m-thin">docs</span></a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-dox-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path d="m6 0c-3.3144 0-6 2.6856-6 6 0 3.3144 2.6856 6 6 6 1.4858 0 2.8463-0.54083 3.8945-1.4355-0.0164 0.33797 0.14734 0.75854 0.5 1.1504l3.2227 3.7891c0.55185 0.6139 1.4517 0.66544 2.002 0.11524 0.55022-0.55022 0.49866-1.4501-0.11524-2.002l-3.7891-3.2246c-0.39184-0.35266-0.81242-0.51469-1.1504-0.5 0.89472-1.0482 1.4355-2.4088 1.4355-3.8945 0-3.3128-2.6856-5.998-6-5.998zm0 1.5625a4.4375 4.4375 0 0 1 4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375-4.4375 4.4375 4.4375 0 0 1 4.4375-4.4375z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li>
<a href="https://quinoacomputing.github.io/index.html#mainpage_tools">Tools</a>
<ol>
<li><a href="inciter_main.html">Inciter (Compressible flow solver)</a></li>
<li><a href="meshconv_main.html">MeshConv (Mesh format converter)</a></li>
<li><a href="unittest_main.html">UnitTest</a></li>
</ol>
</li>
<li>
<a href="easybuild.html">Build</a>
<ol>
<li><a href="build.html">Advanced build options</a></li>
<li><a href="git_submodules_subtrees.html">Modules</a></li>
<li><a href="licenses.html">Libraries</a></li>
<li><a href="build_system.html">Internals</a></li>
</ol>
</li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li>
<a href="resources.html">Resources</a>
<ol>
<li><a href="https://github.com/quinoacomputing/quinoa">GitHub</a></li>
<li><a href="papers.html">Publications</a></li>
<li><a href="https://github.com/quinoacomputing/quinoa/blob/master/LICENSE">License</a></li>
<li><a href="roadmap.html">Roadmap</a></li>
<li><a href="contributing.html">Contributing</a></li>
<li><a href="coverage.html">Coverage</a></li>
<li><a href="https://github.com/quinoacomputing/quinoa/releases">Tarballs</a></li>
<li><a href="https://bestpractices.coreinfrastructure.org/projects/2120">Practices</a></li>
</ol>
</li>
<li class="m-show-m"><a href="#search" class="m-dox-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path d="m6 0c-3.3144 0-6 2.6856-6 6 0 3.3144 2.6856 6 6 6 1.4858 0 2.8463-0.54083 3.8945-1.4355-0.0164 0.33797 0.14734 0.75854 0.5 1.1504l3.2227 3.7891c0.55185 0.6139 1.4517 0.66544 2.002 0.11524 0.55022-0.55022 0.49866-1.4501-0.11524-2.002l-3.7891-3.2246c-0.39184-0.35266-0.81242-0.51469-1.1504-0.5 0.89472-1.0482 1.4355-2.4088 1.4355-3.8945 0-3.3128-2.6856-5.998-6-5.998zm0 1.5625a4.4375 4.4375 0 0 1 4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375-4.4375 4.4375 4.4375 0 0 1 4.4375-4.4375z"/>
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a>/</span><span class="m-breadcrumb"><a href="dir_3ff0826a6d651abbf0f532354e1ac7dc.html">Control</a>/</span>CommonGrammar.hpp <span class="m-thin">file</span>
</h1>
<p>Generic, low-level grammar, re-used by specific grammars.</p>
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#namespaces">Namespaces</a></li>
<li><a href="#nested-classes">Classes</a></li>
</ul>
</li>
</ul>
</div>
<aside class="m-note m-default"><h4>Copyright</h4><p>2012-2015 J. Bakosi, 2016-2018 Los Alamos National Security, LLC., 2019-2021 Triad National Security, LLC. All rights reserved. See the LICENSE file for details.</p></aside><p>Generic, low-level grammar. We use the Parsing Expression Grammar Template Library (PEGTL) to create the grammar and the associated parser.</p>
<section id="namespaces">
<h2><a href="#namespaces">Namespaces</a></h2>
<dl class="m-dox">
<dt>namespace <a href="namespacetk.html" class="m-dox">tk</a></dt>
<dd>Toolkit declarations and definitions for general purpose utilities.</dd>
<dt>namespace <a href="namespacetk_1_1grm.html" class="m-dox">tk::grm</a></dt>
<dd>Toolkit general purpose grammar definition.</dd>
</dl>
</section>
<section id="nested-classes">
<h2><a href="#nested-classes">Classes</a></h2>
<dl class="m-dox">
<dt>
<div class="m-dox-template">template<typename Rule></div>
struct <a href="structtk_1_1grm_1_1action.html" class="m-dox">tk::grm::action</a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<typename... As></div>
struct <a href="structtk_1_1grm_1_1call.html" class="m-dox">tk::grm::call</a>
</dt>
<dd>Helper for calling action::apply for multiple actions.</dd>
<dt>
<div class="m-dox-template">template<class rule, class... actions></div>
struct <a href="structtk_1_1grm_1_1act.html" class="m-dox">tk::grm::act</a>
</dt>
<dd>Rule used to trigger action(s) for a rule.</dd>
<dt>
<div class="m-dox-template">template<class rule, class... actions></div>
struct <a href="structtk_1_1grm_1_1action_3_01act_3_01rule_00_01actions_8_8_8_01_4_01_4.html" class="m-dox">tk::grm::action<act<rule, actions...>></a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<<a href="namespacetk_1_1grm.html#aaea8b8be7c61e0bfb422394a315b2b64" class="m-dox">MsgType</a>, <a href="namespacetk_1_1grm.html#a86dbe384e8ce31796b7eb5f6ac87e1a3" class="m-dox">MsgKey</a>></div>
struct <a href="structtk_1_1grm_1_1msg.html" class="m-dox">tk::grm::msg</a>
</dt>
<dd>Rule used to trigger action.</dd>
<dt>
<div class="m-dox-template">template<<a href="namespacetk_1_1grm.html#aaea8b8be7c61e0bfb422394a315b2b64" class="m-dox">MsgType</a> type, <a href="namespacetk_1_1grm.html#a86dbe384e8ce31796b7eb5f6ac87e1a3" class="m-dox">MsgKey</a> key></div>
struct <a href="structtk_1_1grm_1_1action_3_01msg_3_01type_00_01key_01_4_01_4.html" class="m-dox">tk::grm::action<msg<type, key>></a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1_store.html" class="m-dox">tk::grm::Store</a>
</dt>
<dd>Rule used to trigger action.</dd>
<dt>
<div class="m-dox-template">template<typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1action_3_01_store_3_01tag_00_01tags_8_8_8_01_4_01_4.html" class="m-dox">tk::grm::action<Store<tag, tags...>></a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<typename... tags></div>
struct <a href="structtk_1_1grm_1_1_invert__switch.html" class="m-dox">tk::grm::Invert_switch</a>
</dt>
<dd>Rule used to trigger action.</dd>
<dt>
<div class="m-dox-template">template<typename... tags></div>
struct <a href="structtk_1_1grm_1_1action_3_01_invert__switch_3_01tags_8_8_8_01_4_01_4.html" class="m-dox">tk::grm::action<Invert_switch<tags...>></a>
</dt>
<dd></dd>
<dt>
struct <a href="structtk_1_1grm_1_1helpkw.html" class="m-dox">tk::grm::helpkw</a>
</dt>
<dd>Rule used to trigger action.</dd>
<dt>
<div class="m-dox-template">template<></div>
struct <a href="structtk_1_1grm_1_1action_3_01helpkw_01_4.html" class="m-dox">tk::grm::action<helpkw></a>
</dt>
<dd>Find keyword among all keywords and if found, store the keyword and its info on which help was requested behind <a href="structtag_1_1helpkw.html" class="m-dox">tag::<wbr />helpkw</a> in Stack.</dd>
<dt>
<div class="m-dox-template">template<class keyword, typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1check__lower__bound.html" class="m-dox">tk::grm::check_lower_bound</a>
</dt>
<dd>Rule used to trigger action.</dd>
<dt>
<div class="m-dox-template">template<class keyword, typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1action_3_01check__lower__bound_3_01keyword_00_01tag_00_01tags_8_8_8_01_4_01_4.html" class="m-dox">tk::grm::action<check_lower_bound<keyword, tag, tags...>></a>
</dt>
<dd>Check if value is larger than lower bound.</dd>
<dt>
<div class="m-dox-template">template<class keyword, typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1check__upper__bound.html" class="m-dox">tk::grm::check_upper_bound</a>
</dt>
<dd>Rule used to trigger action.</dd>
<dt>
<div class="m-dox-template">template<class keyword, typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1action_3_01check__upper__bound_3_01keyword_00_01tag_00_01tags_8_8_8_01_4_01_4.html" class="m-dox">tk::grm::action<check_upper_bound<keyword, tag, tags...>></a>
</dt>
<dd>Check if value is lower than upper bound.</dd>
<dt>
<div class="m-dox-template">template<class token, class erased></div>
struct <a href="structtk_1_1grm_1_1trim.html" class="m-dox">tk::grm::trim</a>
</dt>
<dd>Read 'token' until 'erased' trimming, i.e., not consuming, 'erased'.</dd>
<dt>
<div class="m-dox-template">template<<a href="namespacetk_1_1grm.html#aaea8b8be7c61e0bfb422394a315b2b64" class="m-dox">MsgType</a> type, <a href="namespacetk_1_1grm.html#a86dbe384e8ce31796b7eb5f6ac87e1a3" class="m-dox">MsgKey</a> key></div>
struct <a href="structtk_1_1grm_1_1unknown.html" class="m-dox">tk::grm::unknown</a>
</dt>
<dd>Match unknown keyword and handle error.</dd>
<dt>
<div class="m-dox-template">template<class keyword></div>
struct <a href="structtk_1_1grm_1_1alias.html" class="m-dox">tk::grm::alias</a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<class keyword></div>
struct <a href="structtk_1_1grm_1_1verbose.html" class="m-dox">tk::grm::verbose</a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<class token></div>
struct <a href="structtk_1_1grm_1_1readkw.html" class="m-dox">tk::grm::readkw</a>
</dt>
<dd>Read keyword 'token' padded by blank at left and space at right.</dd>
<dt>
<div class="m-dox-template">template<class keyword, typename = void></div>
struct <a href="structtk_1_1grm_1_1readcmd.html" class="m-dox">tk::grm::readcmd</a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<class keyword></div>
struct <a href="structtk_1_1grm_1_1readcmd_3_01keyword_00_01typename_01if___3_01false_00_01typename_01keyword_1_00e55a5c953a2708b6f3bafb2f26d0c9.html" class="m-dox">tk::grm::readcmd<keyword, typename if_<false, typename keyword::info::alias>::type></a>
</dt>
<dd></dd>
<dt>
<div class="m-dox-template">template<class keyword, class... actions></div>
struct <a href="structtk_1_1grm_1_1scan.html" class="m-dox">tk::grm::scan</a>
</dt>
<dd>Scan input padded by blank at left and space at right and if it matches 'keyword', apply 'actions'.</dd>
<dt>
struct <a href="structtk_1_1grm_1_1number.html" class="m-dox">tk::grm::number</a>
</dt>
<dd>Parse a number: an optional sign followed by digits.</dd>
<dt>
<div class="m-dox-template">template<template<class> class use, class keyword, class insert, class kw_type, class tag, class... tags></div>
struct <a href="structtk_1_1grm_1_1process__cmd.html" class="m-dox">tk::grm::process_cmd</a>
</dt>
<dd>Process command line 'keyword' and call its 'insert' action if matches 'kw_type'.</dd>
<dt>
<div class="m-dox-template">template<template<class> class use, class keyword, typename tag, typename... tags></div>
struct <a href="structtk_1_1grm_1_1process__cmd__switch.html" class="m-dox">tk::grm::process_cmd_switch</a>
</dt>
<dd></dd>
<dt>
struct <a href="structtk_1_1grm_1_1charmarg.html" class="m-dox">tk::grm::charmarg</a>
</dt>
<dd>Process but ignore Charm++'s charmrun arguments starting with '+'.</dd>
<dt>
<div class="m-dox-template">template<typename keywords></div>
struct <a href="structtk_1_1grm_1_1read__string.html" class="m-dox">tk::grm::read_string</a>
</dt>
<dd>Generic string parser entry point: parse 'keywords' until end of string.</dd>
<dt>
<div class="m-dox-template">template<typename keyword, typename pool></div>
struct <a href="structtk_1_1grm_1_1use.html" class="m-dox">tk::grm::use</a>
</dt>
<dd>Ensure that a grammar only uses keywords from a pool of pre-defined keywords.</dd>
</dl>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-dox-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-dox-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-dox-search-content">
<input type="search" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" />
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript. Enable it or <a href="https://google.com/search?q=site:quinoacomputing.github.io+">use an external search engine</a>.</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
Search for symbols, directories, files, pages or modules. You can omit any
prefix from the symbol or file path; adding a <code>:</code> or <code>/</code>
suffix lists all members of given symbol or directory. Navigate through the
list using <span class="m-label m-dim">↓</span> and
<span class="m-label m-dim">↑</span>, press
<span class="m-label m-dim">Enter</span> to go.
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="https://google.com/search?q=site:quinoacomputing.github.io+{query}">search with external engine</a>?</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search.js"></script>
<script src="searchdata.js" async="async"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<p>Quinoa docs, part of the <a href="https://github.com/quinoacomputing/">Quinoa project</a>. Copyright © J. Bakosi 2012–2015, Los Alamos National Security, LLC, 2016–2018, <a href="https://www.triadns.org/">Triad National Security, LLC,</a> 2019-2023. Generated on Thursday, May 30, 2024 using <a href="http://doxygen.org/">Doxygen</a> and <a href="http://mcss.mosra.cz/">m.css</a>. Contact us via <a href="https://github.com/quinoacomputing/quinoa/issues">GitHub</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>