Debian Codegraph @

docs/fpm-ford/proc/parse~2.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=" 1.8% of total for procedures.">7 statements</a>
94 </li>
95
96 <li id="source-file">
97 <i class="fa fa-code"></i>
98 <a href="../src/demo17.f90"> Source File</a>
99 </li>
100 </ul>
101 <ol class="breadcrumb in-well text-right">
102 <li><a href='../sourcefile/demo17.f90.html'>demo17.f90</a></li>
103 <li><a href='../program/demo17.html'>demo17</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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140 <div class="panel panel-primary">
141 <div class="panel-heading text-left"><h3 class="panel-title">Source Code</h3></div>
142 <div class="list-group">
143 <a class="list-group-item" href="../proc/parse~2.html#src">parse</a>
144 </div>
145 </div>
146
147
148 </div>
149
150 </div>
151
152 <div class="col-md-9" id='text'>
153 <h2> subroutine parse()
154 </h2>
155 <div class="panel panel-default">
156 <div class="panel-heading">
157 <h3 class="panel-title">Uses</h3>
158 </div>
159 <ul class="list-group">
160 <li class="list-group-item">
161 <ul class="list-inline">
162 <li><a href='../module/m_cli2.html'>M_CLI2</a></li>
163 </ul>
164 </li>
165 </ul>
166 </div>
167
168
169 <p>Put everything to do with command parsing here </p>
170 <p>DEFINE COMMAND OPTIONS AND DEFAULT VALUES</p>
171 <h2 id="version-text-with-optional-prefix-for-what1-command">VERSION TEXT (with optional @(#) prefix for what(1) command)</h2>
172
173 <h3>Arguments</h3>
174 <em>None</em>
175 <br>
176 <br>
177
178 <section class="visible-xs visible-sm hidden-md">
179 <h3>Contents</h3>
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199 <div class="panel panel-primary">
200 <div class="panel-heading text-left"><h3 class="panel-title">Source Code</h3></div>
201 <div class="list-group">
202 <a class="list-group-item" href="../proc/parse~2.html#src">parse</a>
203 </div>
204 </div>
205
206
207 </section>
208 <br class="visible-xs visible-sm hidden-md">
209
210
211
212
213
214
215
216
217
218
219 <section>
220 <h2><span class="anchor" id="src"></span>Source Code</h2>
221 <div class="highlight"><pre><span></span><span class="k">subroutine </span><span class="n">parse</span><span class="p">()</span><span class="w"></span>
222 <span class="c">!! Put everything to do with command parsing here </span>
223 <span class="c">!!</span>
224 <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">set_mode</span><span class="w"></span>
225 <span class="k">call </span><span class="n">set_mode</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">20</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="s1">&#39;strict&#39;</span><span class="p">,</span><span class="s1">&#39;ignorecase&#39;</span><span class="p">])</span><span class="w"></span>
226 <span class="c">! a single call to set_args can define the options and their defaults, set help</span>
227 <span class="c">! text and version information, and crack command line.</span>
228 <span class="k">call </span><span class="n">set_args</span><span class="p">(&amp;</span><span class="w"></span>
229 <span class="c">!! DEFINE COMMAND OPTIONS AND DEFAULT VALUES</span>
230 <span class="s1">&#39; &amp;</span>
231 <span class="s1"> -i 1 -j 2 -k 3 &amp;</span>
232 <span class="s1"> -l F -m F -n F &amp;</span>
233 <span class="s1"> -x 1 -y 2 -z 3 &amp;</span>
234 <span class="s1"> --title &quot;my title&quot; &amp;</span>
235 <span class="s1">!! ## HELP TEXT ##</span>
236 <span class="s1">&#39;</span><span class="p">,</span><span class="w"> </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>
237 <span class="c">!12345678901234567890123456789012345678901234567890123456789012345678901234567890</span>
238 <span class="s1">&#39;NAME &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
239 <span class="s1">&#39; myprogram(1) - make all things possible &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
240 <span class="s1">&#39;SYNOPSIS &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
241 <span class="s1">&#39; myprogram [-i NNN] [-j NNN] [-k NNN] [-l] [-m] [-n] ] &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
242 <span class="s1">&#39; [-x NNN.mm] [-y NNN.mm] [-z NNN.mm] [FILENAMES] &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
243 <span class="s1">&#39;DESCRIPTION &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
244 <span class="s1">&#39; myprogram(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>
245 <span class="s1">&#39;OPTIONS &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
246 <span class="s1">&#39; -i,-j,-k some integer values &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
247 <span class="s1">&#39; -l,-m,-n some logical values &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
248 <span class="s1">&#39; -x,-y,-z some real values &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
249 <span class="s1">&#39; --title a string argument &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
250 <span class="s1">&#39; FILENAMES any additional strings &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
251 <span class="s1">&#39;EXAMPLE &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
252 <span class="s1">&#39; Typical usage: &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
253 <span class="s1">&#39; &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
254 <span class="s1">&#39; demo17 *.* &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
255 <span class="s1">&#39; &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
256 <span class="s1">&#39; &#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
257 <span class="c">!! ## VERSION TEXT (with optional @(#) prefix for what(1) command) ##</span>
258 <span class="s1">&#39;&#39;</span><span class="w"> </span><span class="p">],</span><span class="w"> </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>
259 <span class="s1">&#39;@(#)PROGRAM: demo17 &gt;&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">&amp;</span><span class="w"></span>
260 <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>
261 <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>
262 <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>
263 <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>
264 <span class="s1">&#39;&#39;</span><span class="w"> </span><span class="p">])</span><span class="w"></span>
265
266 <span class="k">end subroutine </span><span class="n">parse</span><span class="w"></span>
267 </pre></div>
268
269 </section>
270 <br>
271
272 </div>
273 </div>
274
275 <hr>
276 </div> <!-- /container -->
277 <footer>
278 <div class="container">
279 <div class="row">
280 <div class="col-xs-6 col-md-6"><p>M_CLI2 was developed by John S. Urban<br>&copy; 2023
281 </p>
282 </div>
283 <div class="col-xs-6 col-md-6">
284 <p class="text-right">
285 Documentation generated by
286 <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
287 on 2023-02-10 18:53 </p>
288 </div>
289 </div>
290 <br>
291 </div> <!-- /container -->
292 </footer>
293
294 <!-- Bootstrap core JavaScript
295 ================================================== -->
296 <!-- Placed at the end of the document so the pages load faster -->
297 <!--
298 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
299 -->
300 <script src="../js/bootstrap.min.js"></script>
301 <!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
302 <script src="../js/ie10-viewport-bug-workaround.js"></script>
303
304 <!-- MathJax JavaScript
305 ================================================== -->
306 <!-- Placed at the end of the document so the pages load faster -->
307 <script type="text/x-mathjax-config">
308 MathJax.Hub.Config({
309 TeX: { extensions: ['AMSmath.js','AMSsymbols.js','noErrors.js','noUndefined.js'], equationNumbers: { autoNumber: 'AMS' } },
310 jax: ['input/TeX','input/MathML','output/HTML-CSS'],
311 extensions: ['tex2jax.js','mml2jax.js','MathMenu.js','MathZoom.js']
312 });
313 </script>
314 <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
315
316 <script src="../tipuesearch/tipuesearch_content.js"></script>
317 <script src="../tipuesearch/tipuesearch_set.js"></script>
318 <script src="../tipuesearch/tipuesearch.js"></script>
319
320 </body>
321 </html>