Debian Codegraph @

docs/fpm-ford/proc/parse.html

raw
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
7 <meta name="description" content="command line parsing">
8 <meta name="author" content="John S. Urban" >
9 <link rel="icon" href="../favicon.png">
10
11 <title>parse &ndash; M_CLI2</title>
12
13 <link href="../css/bootstrap.min.css" rel="stylesheet">
14 <link href="../css/pygments.css" rel="stylesheet">
15 <link href="../css/font-awesome.min.css" rel="stylesheet">
16 <link href="../css/local.css" rel="stylesheet">
17 <link href="../tipuesearch/tipuesearch.css" rel="stylesheet">
18
19 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
20 <!--[if lt IE 9]>
21 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
22 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
23 <![endif]-->
24
25 <script src="../js/jquery-2.1.3.min.js"></script>
26 <script src="../js/svg-pan-zoom.min.js"></script>
27
28 </head>
29
30 <body>
31
32 <!-- Fixed navbar -->
33 <nav class="navbar navbar-inverse navbar-fixed-top">
34 <div class="container">
35 <div class="navbar-header">
36 <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
37 <span class="sr-only">Toggle navigation</span>
38 <span class="icon-bar"></span>
39 <span class="icon-bar"></span>
40 <span class="icon-bar"></span>
41 </button>
42 <a class="navbar-brand" href="../index.html">M_CLI2 </a>
43 </div>
44 <div id="navbar" class="navbar-collapse collapse">
45 <ul class="nav navbar-nav">
46 <li class="dropdown hidden-xs visible-sm visible-md hidden-lg">
47 <a href="#" class="dropdown-toggle"
48 data-toggle="dropdown" role="button"
49 aria-haspopup="true"
50 aria-expanded="false">Contents <span class="caret"></span></a>
51 <ul class="dropdown-menu">
52 <li><a href="../lists/files.html">Source Files</a></li>
53 <li><a href="../lists/modules.html">Modules</a></li>
54 <li><a href="../lists/procedures.html">Procedures</a></li>
55 <li><a href="../lists/types.html">Derived Types</a></li>
56 <li><a href="../lists/programs.html">Programs</a></li>
57
58 </ul>
59
60 </li>
61 <li class="visible-xs hidden-sm visible-lg"><a href="../lists/files.html">Source Files</a></li>
62 <li class="visible-xs hidden-sm visible-lg"><a href="../lists/modules.html">Modules</a></li>
63 <li class="visible-xs hidden-sm visible-lg"><a href="../lists/procedures.html">Procedures</a></li>
64 <li class="visible-xs hidden-sm visible-lg"><a href="../lists/types.html">Derived Types</a></li>
65 <li class="visible-xs hidden-sm visible-lg"><a href="../lists/programs.html">Programs</a></li>
66 </ul>
67 <form action="../search.html" class="navbar-form navbar-right" role="search">
68 <div class="form-group">
69 <input type="text" class="form-control" placeholder="Search" name="q" id="tipue_search_input" autocomplete="off" required>
70 </div>
71 <!--
72 <button type="submit" class="btn btn-default">Submit</button>
73 -->
74 </form>
75 </div><!--/.nav-collapse -->
76 </div>
77 </nav>
78
79 <div class="container">
80 <div class="row">
81 <h1>parse
82 <small>Subroutine</small>
83
84 </h1>
85 <div class="row" id="info-bar">
86 <div class="col-lg-12">
87 <div class="well well-sm">
88 <ul class="list-inline" style="margin-bottom:0px;display:inline">
89
90 <li id="statements"><i class="fa fa-list-ol"></i>
91 <a data-toggle="tooltip"
92 data-placement="bottom" data-html="true"
93 title=" 4.2% of total for procedures.">16 statements</a>
94 </li>
95
96 <li id="source-file">
97 <i class="fa fa-code"></i>
98 <a href="../src/demo2.f90"> Source File</a>
99 </li>
100 </ul>
101 <ol class="breadcrumb in-well text-right">
102 <li><a href='../sourcefile/demo2.f90.html'>demo2.f90</a></li>
103 <li><a href='../program/demo2.html'>demo2</a></li>
104 <li class="active">parse</li>
105 </ol>
106 </div>
107 </div>
108 </div>
109 <script>
110 $(function () {
111 $('[data-toggle="tooltip"]').tooltip()
112 })
113 </script>
114
115 </div>
116
117 <div class="row">
118 <div class="col-md-3 hidden-xs hidden-sm visible-md visible-lg">
119 <div id="sidebar">
120 <h3>Contents</h3>
121
122 <div class="panel panel-primary">
123 <div class="panel-heading text-left">
124 <h3 class="panel-title">
125 <a data-toggle="collapse" href="#vars-0">Variables</a>
126 </h3>
127 </div>
128 <div id="vars-0" class="panel-collapse collapse">
129 <div class="list-group">
130 <a class="list-group-item" href="../proc/parse.html#variable-cmd">cmd</a>
131 <a class="list-group-item" href="../proc/parse.html#variable-help_text">help_text</a>
132 <a class="list-group-item" href="../proc/parse.html#variable-version_text">version_text</a>
133 </div>
134 </div>
135 </div>
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154 <div class="panel panel-primary">
155 <div class="panel-heading text-left"><h3 class="panel-title">Source Code</h3></div>
156 <div class="list-group">
157 <a class="list-group-item" href="../proc/parse.html#src">parse</a>
158 </div>
159 </div>
160
161
162 </div>
163
164 </div>
165
166 <div class="col-md-9" id='text'>
167 <h2> subroutine parse()
168 </h2>
169 <div class="panel panel-default">
170 <div class="panel-heading">
171 <h3 class="panel-title">Uses</h3>
172 </div>
173 <ul class="list-group">
174 <li class="list-group-item">
175 <ul class="list-inline">
176 <li><a href='../module/m_cli2.html'>M_CLI2</a></li>
177 </ul>
178 </li>
179 </ul>
180 </div>
181
182
183 <p>PUT EVERYTHING TO DO WITH COMMAND PARSING HERE FOR CLARITY</p>
184
185 <h3>Arguments</h3>
186 <em>None</em>
187 <br>
188 <br>
189
190 <section class="visible-xs visible-sm hidden-md">
191 <h3>Contents</h3>
192
193 <div class="panel panel-primary">
194 <div class="panel-heading text-left">
195 <h3 class="panel-title">
196 <a data-toggle="collapse" href="#vars-1">Variables</a>
197 </h3>
198 </div>
199 <div id="vars-1" class="panel-collapse collapse">
200 <div class="list-group">
201 <a class="list-group-item" href="../proc/parse.html#variable-cmd">cmd</a>
202 <a class="list-group-item" href="../proc/parse.html#variable-help_text">help_text</a>
203 <a class="list-group-item" href="../proc/parse.html#variable-version_text">version_text</a>
204 </div>
205 </div>
206 </div>
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225 <div class="panel panel-primary">
226 <div class="panel-heading text-left"><h3 class="panel-title">Source Code</h3></div>
227 <div class="list-group">
228 <a class="list-group-item" href="../proc/parse.html#src">parse</a>
229 </div>
230 </div>
231
232
233 </section>
234 <br class="visible-xs visible-sm hidden-md">
235
236
237 <section>
238 <h2>Variables</h2>
239 <table class="table table-striped varlist">
240 <thead>
241 <tr>
242 <th>Type</th>
243 <th>Visibility</th> <th>Attributes</th>
244 <th></th>
245 <th>Name</th>
246 <th></th><th>Initial</th> <th></th>
247 </thead>
248 <tbody>
249 <tr>
250 <td>
251 <span class="anchor" id="variable-cmd"></span>
252 character(len=*),
253 </td>
254 <td>public,</td>
255 <td>
256 parameter
257 </td>
258 <td>::</td>
259 <td><strong>cmd</strong></td>
260 <td> =</td>
261 <td>' -x 1 -y 2 -z 3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--point -1,-2,-3&nbsp;&nbsp;&nbsp;&nbsp;--title "my title"&nbsp;&nbsp;-l F -L F&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'</td>
262 <td>
263
264 </td>
265 </tr>
266 <tr>
267 <td>
268 <span class="anchor" id="variable-help_text"></span>
269 character(len=:),
270 </td>
271 <td>public,</td>
272 <td>
273 allocatable
274 </td>
275 <td>::</td>
276 <td><strong>help_text</strong>(:)</td>
277 <td></td>
278 <td></td>
279 <td>
280 <p>DEFINE COMMAND PROTOTYPE
281 o All parameters must be listed with a default value
282 o string values must be double-quoted
283 o numeric lists must be comma-delimited. No spaces are allowed
284 o long keynames must be all lowercase</p>
285 </td>
286 </tr>
287 <tr>
288 <td>
289 <span class="anchor" id="variable-version_text"></span>
290 character(len=:),
291 </td>
292 <td>public,</td>
293 <td>
294 allocatable
295 </td>
296 <td>::</td>
297 <td><strong>version_text</strong>(:)</td>
298 <td></td>
299 <td></td>
300 <td>
301 <p>DEFINE COMMAND PROTOTYPE
302 o All parameters must be listed with a default value
303 o string values must be double-quoted
304 o numeric lists must be comma-delimited. No spaces are allowed
305 o long keynames must be all lowercase</p>
306 </td>
307 </tr>
308 </tbody>
309 </table>
310
311 </section>
312 <br>
313
314
315
316
317
318
319
320
321 <section>
322 <h2><span class="anchor" id="src"></span>Source Code</h2>
323 <div class="highlight"><pre><span></span><span class="k">subroutine </span><span class="n">parse</span><span class="p">()</span><span class="w"></span>
324 <span class="c">!! PUT EVERYTHING TO DO WITH COMMAND PARSING HERE FOR CLARITY</span>
325 <span class="k">use </span><span class="n">M_CLI2</span><span class="p">,</span><span class="w"> </span><span class="k">only</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">set_args</span><span class="p">,</span><span class="w"> </span><span class="n">get_args</span><span class="w"></span>
326 <span class="k">use </span><span class="n">M_CLI2</span><span class="p">,</span><span class="w"> </span><span class="k">only</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">get_args_fixed_size</span><span class="p">,</span><span class="n">get_args_fixed_length</span><span class="w"></span>
327 <span class="kt">character</span><span class="p">(</span><span class="nb">len</span><span class="o">=</span><span class="p">:),</span><span class="k">allocatable</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">help_text</span><span class="p">(:),</span><span class="w"> </span><span class="n">version_text</span><span class="p">(:)</span><span class="w"></span>
328
329 <span class="c">!! DEFINE COMMAND PROTOTYPE</span>
330 <span class="c">!! o All parameters must be listed with a default value</span>
331 <span class="c">!! o string values must be double-quoted</span>
332 <span class="c">!! o numeric lists must be comma-delimited. No spaces are allowed</span>
333 <span class="c">!! o long keynames must be all lowercase</span>
334
335 <span class="kt">character</span><span class="p">(</span><span class="nb">len</span><span class="o">=*</span><span class="p">),</span><span class="k">parameter</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">cmd</span><span class="o">=</span><span class="s1">&#39;&amp;</span>
336 <span class="s1"> &amp; -x 1 -y 2 -z 3 &amp;</span>
337 <span class="s1"> &amp; --point -1,-2,-3 &amp;</span>
338 <span class="s1"> &amp; --title &quot;my title&quot; &amp;</span>
339 <span class="s1"> &amp; -l F -L F &amp;</span>
340 <span class="s1"> &amp; &#39;</span><span class="w"></span>
341
342 <span class="w"> </span><span class="n">help_text</span><span class="o">=</span><span class="p">[</span><span class="kt">character</span><span class="p">(</span><span class="nb">len</span><span class="o">=</span><span class="mi">80</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
343 <span class="w"> </span><span class="s1">&#39;NAME &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
344 <span class="w"> </span><span class="s1">&#39; myprocedure(1) - make all things possible &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
345 <span class="w"> </span><span class="s1">&#39;SYNOPSIS &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
346 <span class="w"> </span><span class="s1">&#39; function myprocedure(stuff) &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
347 <span class="w"> </span><span class="s1">&#39; class(*) :: stuff &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
348 <span class="w"> </span><span class="s1">&#39;DESCRIPTION &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
349 <span class="w"> </span><span class="s1">&#39; myprocedure(1) makes all things possible given STUFF &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
350 <span class="w"> </span><span class="s1">&#39;OPTIONS &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
351 <span class="w"> </span><span class="s1">&#39; STUFF things to do things to &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
352 <span class="w"> </span><span class="s1">&#39;RETURNS &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
353 <span class="w"> </span><span class="s1">&#39; MYPROCEDURE the answers you want &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
354 <span class="w"> </span><span class="s1">&#39;EXAMPLE &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
355 <span class="w"> </span><span class="s1">&#39;&#39;</span><span class="w"> </span><span class="p">]</span><span class="w"></span>
356
357 <span class="w"> </span><span class="n">version_text</span><span class="o">=</span><span class="p">[</span><span class="kt">character</span><span class="p">(</span><span class="nb">len</span><span class="o">=</span><span class="mi">80</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
358 <span class="w"> </span><span class="s1">&#39;@(#)PROGRAM: demo2 &gt;&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
359 <span class="w"> </span><span class="s1">&#39;@(#)DESCRIPTION: My demo program &gt;&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
360 <span class="w"> </span><span class="s1">&#39;@(#)VERSION: 1.0 20200115 &gt;&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
361 <span class="w"> </span><span class="s1">&#39;@(#)AUTHOR: me, myself, and I&gt;&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
362 <span class="w"> </span><span class="s1">&#39;@(#)LICENSE: Public Domain &gt;&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
363 <span class="w"> </span><span class="s1">&#39;&#39;</span><span class="w"> </span><span class="p">]</span><span class="w"></span>
364
365 <span class="w"> </span><span class="k">call </span><span class="n">set_args</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span><span class="w"> </span><span class="n">help_text</span><span class="p">,</span><span class="w"> </span><span class="n">version_text</span><span class="p">)</span><span class="w"></span>
366 <span class="w"> </span><span class="k">call </span><span class="n">get_args</span><span class="p">(</span><span class="s1">&#39;x&#39;</span><span class="p">,</span><span class="n">x</span><span class="p">)</span><span class="w"></span>
367 <span class="w"> </span><span class="k">call </span><span class="n">get_args</span><span class="p">(</span><span class="s1">&#39;y&#39;</span><span class="p">,</span><span class="n">y</span><span class="p">)</span><span class="w"></span>
368 <span class="w"> </span><span class="k">call </span><span class="n">get_args</span><span class="p">(</span><span class="s1">&#39;z&#39;</span><span class="p">,</span><span class="n">z</span><span class="p">)</span><span class="w"></span>
369 <span class="w"> </span><span class="k">call </span><span class="n">get_args_fixed_size</span><span class="p">(</span><span class="s1">&#39;point&#39;</span><span class="p">,</span><span class="n">point</span><span class="p">)</span><span class="w"></span>
370 <span class="w"> </span><span class="k">call </span><span class="n">get_args_fixed_length</span><span class="p">(</span><span class="s1">&#39;title&#39;</span><span class="p">,</span><span class="n">title</span><span class="p">)</span><span class="w"></span>
371 <span class="w"> </span><span class="k">call </span><span class="n">get_args</span><span class="p">(</span><span class="s1">&#39;l&#39;</span><span class="p">,</span><span class="n">l</span><span class="p">)</span><span class="w"></span>
372 <span class="w"> </span><span class="k">call </span><span class="n">get_args</span><span class="p">(</span><span class="s1">&#39;L&#39;</span><span class="p">,</span><span class="n">l_</span><span class="p">)</span><span class="w"></span>
373
374 <span class="k">end subroutine </span><span class="n">parse</span><span class="w"></span>
375 </pre></div>
376
377 </section>
378 <br>
379
380 </div>
381 </div>
382
383 <hr>
384 </div> <!-- /container -->
385 <footer>
386 <div class="container">
387 <div class="row">
388 <div class="col-xs-6 col-md-6"><p>M_CLI2 was developed by John S. Urban<br>&copy; 2023
389 </p>
390 </div>
391 <div class="col-xs-6 col-md-6">
392 <p class="text-right">
393 Documentation generated by
394 <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
395 on 2023-02-10 18:53 </p>
396 </div>
397 </div>
398 <br>
399 </div> <!-- /container -->
400 </footer>
401
402 <!-- Bootstrap core JavaScript
403 ================================================== -->
404 <!-- Placed at the end of the document so the pages load faster -->
405 <!--
406 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
407 -->
408 <script src="../js/bootstrap.min.js"></script>
409 <!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
410 <script src="../js/ie10-viewport-bug-workaround.js"></script>
411
412 <!-- MathJax JavaScript
413 ================================================== -->
414 <!-- Placed at the end of the document so the pages load faster -->
415 <script type="text/x-mathjax-config">
416 MathJax.Hub.Config({
417 TeX: { extensions: ['AMSmath.js','AMSsymbols.js','noErrors.js','noUndefined.js'], equationNumbers: { autoNumber: 'AMS' } },
418 jax: ['input/TeX','input/MathML','output/HTML-CSS'],
419 extensions: ['tex2jax.js','mml2jax.js','MathMenu.js','MathZoom.js']
420 });
421 </script>
422 <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
423
424 <script src="../tipuesearch/tipuesearch_content.js"></script>
425 <script src="../tipuesearch/tipuesearch_set.js"></script>
426 <script src="../tipuesearch/tipuesearch.js"></script>
427
428 </body>
429 </html>