| 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>set_args – 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>set_args |
| 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="15.2% of total for procedures.">58 statements</a> |
| 94 |
</li> |
| 95 |
|
| 96 |
<li id="source-file"> |
| 97 |
<i class="fa fa-code"></i> |
| 98 |
<a href="../src/M_CLI2.F90"> Source File</a> |
| 99 |
</li> |
| 100 |
</ul> |
| 101 |
<ol class="breadcrumb in-well text-right"> |
| 102 |
<li><a href='../sourcefile/m_cli2.f90.html'>M_CLI2.F90</a></li> |
| 103 |
<li><a href='../module/m_cli2.html'>M_CLI2</a></li> |
| 104 |
<li class="active">set_args</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/set_args.html#src">set_args</a> |
| 144 |
</div> |
| 145 |
</div> |
| 146 |
|
| 147 |
|
| 148 |
</div> |
| 149 |
|
| 150 |
</div> |
| 151 |
|
| 152 |
<div class="col-md-9" id='text'> |
| 153 |
<h2>public subroutine set_args(prototype, help_text, version_text, string, prefix, ierr, errmsg) |
| 154 |
</h2> |
| 155 |
|
| 156 |
|
| 157 |
<h2 id="name">NAME</h2> |
| 158 |
<div class="codehilite"><pre><span></span><code>set_args(3f) - [ARGUMENTS:M_CLI2] command line argument parsing |
| 159 |
(LICENSE:PD) |
| 160 |
</code></pre></div> |
| 161 |
|
| 162 |
<h2 id="synopsis">SYNOPSIS</h2> |
| 163 |
<div class="codehilite"><pre><span></span><code> subroutine set_args(prototype,help_text,version_text,ierr,errmsg) |
| 164 |
|
| 165 |
character(len=*),intent(in),optional :: prototype |
| 166 |
character(len=*),intent(in),optional :: help_text(:) |
| 167 |
character(len=*),intent(in),optional :: version_text(:) |
| 168 |
integer,intent(out),optional :: ierr |
| 169 |
character(len=:),intent(out),allocatable,optional :: errmsg |
| 170 |
</code></pre></div> |
| 171 |
|
| 172 |
<h2 id="description">DESCRIPTION</h2> |
| 173 |
<div class="codehilite"><pre><span></span><code><span class="nv">SET_ARGS</span><span class="ss">(</span><span class="mi">3</span><span class="nv">f</span><span class="ss">)</span> <span class="nv">requires</span> <span class="nv">a</span> <span class="mi">1</span><span class="o">-</span><span class="nv">like</span> <span class="nv">command</span> <span class="nv">prototype</span> <span class="nv">which</span> <span class="nv">defines</span> |
| 174 |
<span class="nv">the</span> <span class="nv">command</span><span class="o">-</span><span class="nv">line</span> <span class="nv">options</span> <span class="nv">and</span> <span class="nv">their</span> <span class="nv">default</span> <span class="nv">values</span>. <span class="nv">When</span> <span class="nv">the</span> <span class="nv">program</span> |
| 175 |
<span class="nv">is</span> <span class="nv">executed</span> <span class="nv">this</span> <span class="nv">and</span> <span class="nv">the</span> <span class="nv">command</span><span class="o">-</span><span class="nv">line</span> <span class="nv">options</span> <span class="nv">are</span> <span class="nv">applied</span> <span class="nv">and</span> <span class="nv">the</span> |
| 176 |
<span class="nv">resulting</span> <span class="nv">values</span> <span class="nv">are</span> <span class="nv">placed</span> <span class="nv">in</span> <span class="nv">an</span> <span class="nv">internal</span> <span class="nv">table</span> <span class="k">for</span> <span class="nv">retrieval</span> <span class="nv">via</span> |
| 177 |
<span class="nv">GET_ARGS</span><span class="ss">(</span><span class="mi">3</span><span class="nv">f</span><span class="ss">)</span>. |
| 178 |
|
| 179 |
<span class="nv">The</span> <span class="nv">built</span><span class="o">-</span><span class="nv">in</span> <span class="o">--</span><span class="nv">help</span> <span class="nv">and</span> <span class="o">--</span><span class="nv">version</span> <span class="nv">options</span> <span class="nv">require</span> <span class="nv">optional</span> <span class="nv">help_text</span> |
| 180 |
<span class="nv">and</span> <span class="nv">version_text</span> <span class="nv">values</span> <span class="nv">to</span> <span class="nv">be</span> <span class="nv">provided</span> <span class="nv">to</span> <span class="nv">be</span> <span class="nv">particularly</span> <span class="nv">useful</span>. |
| 181 |
</code></pre></div> |
| 182 |
|
| 183 |
<h2 id="options">OPTIONS</h2> |
| 184 |
<div class="codehilite"><pre><span></span><code><span class="nv">PROTOTYPE</span> <span class="nv">composed</span> <span class="nv">of</span> <span class="nv">all</span> <span class="nv">command</span> <span class="nv">arguments</span> <span class="nv">concatenated</span> |
| 185 |
<span class="nv">into</span> <span class="nv">a</span> <span class="nv">Unix</span><span class="o">-</span><span class="nv">like</span> <span class="nv">command</span> <span class="nv">prototype</span> <span class="nv">string</span>. <span class="k">For</span> |
| 186 |
<span class="nv">example</span>: |
| 187 |
|
| 188 |
<span class="k">call</span> <span class="nl">set_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">-L F --ints 1,2,3 --title "my title" -R 10.3</span><span class="s1">'</span><span class="ss">)</span> |
| 189 |
|
| 190 |
<span class="nv">The</span> <span class="nv">following</span> <span class="nv">options</span> <span class="nv">are</span> <span class="nv">predefined</span> <span class="k">for</span> <span class="nv">all</span> <span class="nv">commands</span>: |
| 191 |
<span class="s1">'</span><span class="s">--verbose F --usage F --help F --version F</span><span class="s1">'</span>. |
| 192 |
|
| 193 |
<span class="nv">see</span> <span class="s2">"</span><span class="s">DEFINING THE PROTOTYPE</span><span class="s2">"</span> <span class="nv">in</span> <span class="nv">the</span> <span class="k">next</span> <span class="nv">section</span> <span class="k">for</span> |
| 194 |
<span class="nv">further</span> <span class="nv">details</span>. |
| 195 |
|
| 196 |
<span class="nv">HELP_TEXT</span> <span class="k">if</span> <span class="nv">present</span>, <span class="nv">will</span> <span class="nv">be</span> <span class="nv">displayed</span> <span class="nv">when</span> <span class="nv">the</span> <span class="nv">program</span> <span class="nv">is</span> <span class="nv">called</span> <span class="nv">with</span> |
| 197 |
<span class="nv">a</span> <span class="o">--</span><span class="nv">help</span> <span class="nv">switch</span>, <span class="nv">and</span> <span class="k">then</span> <span class="nv">the</span> <span class="nv">program</span> <span class="nv">will</span> <span class="nv">terminate</span>. <span class="k">If</span> |
| 198 |
<span class="nv">help</span> <span class="nv">text</span> <span class="nv">is</span> <span class="nv">not</span> <span class="nv">supplied</span> <span class="nv">the</span> <span class="nv">command</span> <span class="nv">line</span> <span class="nv">initialization</span> |
| 199 |
<span class="nv">string</span> <span class="nv">will</span> <span class="nv">be</span> <span class="nv">echoed</span>. |
| 200 |
|
| 201 |
<span class="nv">VERSION_TEXT</span> <span class="k">if</span> <span class="nv">present</span>, <span class="nv">any</span> <span class="nv">version</span> <span class="nv">text</span> <span class="nv">defined</span> <span class="nv">will</span> <span class="nv">be</span> <span class="nv">displayed</span> |
| 202 |
<span class="nv">when</span> <span class="nv">the</span> <span class="nv">program</span> <span class="nv">is</span> <span class="nv">called</span> <span class="nv">with</span> <span class="nv">a</span> <span class="o">--</span><span class="nv">version</span> <span class="nv">switch</span>, |
| 203 |
<span class="nv">and</span> <span class="k">then</span> <span class="nv">the</span> <span class="nv">program</span> <span class="nv">will</span> <span class="nv">terminate</span>. |
| 204 |
<span class="nv">IERR</span> <span class="k">if</span> <span class="nv">present</span> <span class="nv">a</span> <span class="nv">non</span><span class="o">-</span><span class="nv">zero</span> <span class="nv">option</span> <span class="nv">is</span> <span class="nv">returned</span> <span class="nv">when</span> <span class="nv">an</span> |
| 205 |
<span class="nv">error</span> <span class="nv">occurs</span> <span class="nv">instead</span> <span class="nv">of</span> <span class="nv">the</span> <span class="nv">program</span> <span class="nv">terminating</span>. |
| 206 |
<span class="nv">ERRMSG</span> <span class="nv">a</span> <span class="nv">description</span> <span class="nv">of</span> <span class="nv">the</span> <span class="nv">error</span> <span class="k">if</span> <span class="nv">ierr</span> <span class="nv">is</span> <span class="nv">present</span>. |
| 207 |
</code></pre></div> |
| 208 |
|
| 209 |
<h2 id="defining-the-prototype">DEFINING THE PROTOTYPE</h2> |
| 210 |
<div class="codehilite"><pre><span></span><code><span class="n">o</span><span class="w"> </span><span class="n">Keywords</span><span class="w"> </span><span class="n">start</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">single</span><span class="w"> </span><span class="n">dash</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">short</span><span class="w"> </span><span class="n">single</span><span class="o">-</span><span class="n">character</span><span class="w"></span> |
| 211 |
<span class="w"> </span><span class="n">keywords</span><span class="p">,</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">two</span><span class="w"> </span><span class="n">dashes</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">longer</span><span class="w"> </span><span class="n">keywords</span><span class="o">.</span><span class="w"></span> |
| 212 |
|
| 213 |
<span class="n">o</span><span class="w"> </span><span class="n">all</span><span class="w"> </span><span class="n">keywords</span><span class="w"> </span><span class="n">on</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">prototype</span><span class="w"> </span><span class="n">MUST</span><span class="w"> </span><span class="n">get</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">value</span><span class="o">.</span><span class="w"></span> |
| 214 |
|
| 215 |
<span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">logicals</span><span class="w"> </span><span class="n">must</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">set</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">an</span><span class="w"> </span><span class="n">unquoted</span><span class="w"> </span><span class="n">F</span><span class="o">.</span><span class="w"></span> |
| 216 |
|
| 217 |
<span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">strings</span><span class="w"> </span><span class="n">must</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">delimited</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">double</span><span class="o">-</span><span class="n">quotes</span><span class="o">.</span><span class="w"></span> |
| 218 |
<span class="w"> </span><span class="n">Since</span><span class="w"> </span><span class="n">internal</span><span class="w"> </span><span class="n">double</span><span class="o">-</span><span class="n">quotes</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">represented</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">two</span><span class="w"></span> |
| 219 |
<span class="w"> </span><span class="n">double</span><span class="o">-</span><span class="n">quotes</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">must</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">at</span><span class="w"> </span><span class="n">least</span><span class="w"> </span><span class="n">one</span><span class="w"> </span><span class="n">space</span><span class="o">.</span><span class="w"></span> |
| 220 |
|
| 221 |
<span class="n">o</span><span class="w"> </span><span class="n">numeric</span><span class="w"> </span><span class="n">keywords</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">allowed</span><span class="p">;</span><span class="w"> </span><span class="n">but</span><span class="w"> </span><span class="n">this</span><span class="w"> </span><span class="n">allows</span><span class="w"></span> |
| 222 |
<span class="w"> </span><span class="n">negative</span><span class="w"> </span><span class="n">numbers</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">values</span><span class="o">.</span><span class="w"></span> |
| 223 |
|
| 224 |
<span class="n">o</span><span class="w"> </span><span class="n">lists</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">values</span><span class="w"> </span><span class="n">should</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">comma</span><span class="o">-</span><span class="n">delimited</span><span class="w"> </span><span class="n">unless</span><span class="w"> </span><span class="n">a</span><span class="w"></span> |
| 225 |
<span class="w"> </span><span class="n">user</span><span class="o">-</span><span class="n">specified</span><span class="w"> </span><span class="n">delimiter</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">used</span><span class="o">.</span><span class="w"> </span><span class="n">The</span><span class="w"> </span><span class="n">prototype</span><span class="w"></span> |
| 226 |
<span class="w"> </span><span class="n">must</span><span class="w"> </span><span class="n">use</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">same</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">delimiters</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">to</span><span class="w"></span> |
| 227 |
<span class="w"> </span><span class="n">get</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">value</span><span class="o">.</span><span class="w"></span> |
| 228 |
|
| 229 |
<span class="n">o</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">define</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">zero</span><span class="o">-</span><span class="n">length</span><span class="w"> </span><span class="n">allocatable</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">make</span><span class="w"> </span><span class="n">the</span><span class="w"></span> |
| 230 |
<span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">delimiter</span><span class="w"> </span><span class="p">(</span><span class="n">usually</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">comma</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">an</span><span class="w"> </span><span class="n">empty</span><span class="w"> </span><span class="n">set</span><span class="w"></span> |
| 231 |
<span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">braces</span><span class="w"> </span><span class="p">(</span><span class="s2">"[]"</span><span class="p">)</span><span class="o">.</span><span class="w"></span> |
| 232 |
|
| 233 |
<span class="n">LONG</span><span class="w"> </span><span class="n">AND</span><span class="w"> </span><span class="n">SHORT</span><span class="w"> </span><span class="n">NAMES</span><span class="w"></span> |
| 234 |
|
| 235 |
<span class="n">Long</span><span class="w"> </span><span class="n">keywords</span><span class="w"> </span><span class="n">start</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">two</span><span class="w"> </span><span class="n">dashes</span><span class="w"> </span><span class="n">followed</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="n">more</span><span class="w"> </span><span class="n">than</span><span class="w"> </span><span class="n">one</span><span class="w"> </span><span class="n">letter</span><span class="o">.</span><span class="w"></span> |
| 236 |
<span class="n">Short</span><span class="w"> </span><span class="n">keywords</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">dash</span><span class="w"> </span><span class="n">followed</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">single</span><span class="w"> </span><span class="n">letter</span><span class="o">.</span><span class="w"></span> |
| 237 |
|
| 238 |
<span class="n">o</span><span class="w"> </span><span class="n">It</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">recommended</span><span class="w"> </span><span class="n">long</span><span class="w"> </span><span class="n">names</span><span class="w"> </span><span class="p">(</span><span class="o">--</span><span class="n">keyword</span><span class="p">)</span><span class="w"> </span><span class="n">should</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">all</span><span class="w"> </span><span class="n">lowercase</span><span class="w"></span> |
| 239 |
<span class="w"> </span><span class="n">but</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">case</span><span class="o">-</span><span class="n">sensitive</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="n">default</span><span class="p">,</span><span class="w"> </span><span class="n">unless</span><span class="w"> </span><span class="s2">"set_mode('ignorecase')"</span><span class="w"></span> |
| 240 |
<span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">effect</span><span class="o">.</span><span class="w"></span> |
| 241 |
|
| 242 |
<span class="n">o</span><span class="w"> </span><span class="n">Long</span><span class="w"> </span><span class="n">names</span><span class="w"> </span><span class="n">should</span><span class="w"> </span><span class="n">always</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">more</span><span class="w"> </span><span class="n">than</span><span class="w"> </span><span class="n">one</span><span class="w"> </span><span class="n">character</span><span class="o">.</span><span class="w"></span> |
| 243 |
|
| 244 |
<span class="n">o</span><span class="w"> </span><span class="n">The</span><span class="w"> </span><span class="n">recommended</span><span class="w"> </span><span class="n">way</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">have</span><span class="w"> </span><span class="n">short</span><span class="w"> </span><span class="n">names</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">suffix</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">long</span><span class="w"></span> |
| 245 |
<span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="p">:</span><span class="n">LETTER</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">definition</span><span class="o">.</span><span class="w"></span> |
| 246 |
|
| 247 |
<span class="w"> </span><span class="n">If</span><span class="w"> </span><span class="n">this</span><span class="w"> </span><span class="n">syntax</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">then</span><span class="w"> </span><span class="n">logical</span><span class="w"> </span><span class="n">shorts</span><span class="w"> </span><span class="n">may</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">combined</span><span class="w"> </span><span class="n">on</span><span class="w"> </span><span class="n">the</span><span class="w"></span> |
| 248 |
<span class="w"> </span><span class="n">command</span><span class="w"> </span><span class="n">line</span><span class="w"> </span><span class="n">when</span><span class="w"> </span><span class="s2">"set_mode('strict')"</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">effect</span><span class="o">.</span><span class="w"></span> |
| 249 |
|
| 250 |
<span class="n">SPECIAL</span><span class="w"> </span><span class="n">BEHAVIORS</span><span class="w"></span> |
| 251 |
|
| 252 |
<span class="n">o</span><span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="n">special</span><span class="w"> </span><span class="n">behavior</span><span class="w"> </span><span class="n">occurs</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">keyword</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="n">ends</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="p">::</span><span class="o">.</span><span class="w"></span> |
| 253 |
<span class="w"> </span><span class="n">When</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">called</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">next</span><span class="w"> </span><span class="n">parameter</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">taken</span><span class="w"> </span><span class="k">as</span><span class="w"></span> |
| 254 |
<span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="n">even</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="n">starts</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="o">-.</span><span class="w"> </span><span class="n">This</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">generally</span><span class="w"></span> |
| 255 |
<span class="w"> </span><span class="n">recommended</span><span class="w"> </span><span class="n">but</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">useful</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">rare</span><span class="w"> </span><span class="n">cases</span><span class="w"> </span><span class="n">where</span><span class="w"> </span><span class="n">non</span><span class="o">-</span><span class="n">numeric</span><span class="w"></span> |
| 256 |
<span class="w"> </span><span class="n">values</span><span class="w"> </span><span class="n">starting</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">dash</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">desired</span><span class="o">.</span><span class="w"></span> |
| 257 |
|
| 258 |
<span class="n">o</span><span class="w"> </span><span class="n">If</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">prototype</span><span class="w"> </span><span class="n">ends</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="s2">"--"</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">special</span><span class="w"> </span><span class="n">mode</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">turned</span><span class="w"></span> |
| 259 |
<span class="w"> </span><span class="n">on</span><span class="w"> </span><span class="n">where</span><span class="w"> </span><span class="n">anything</span><span class="w"> </span><span class="n">after</span><span class="w"> </span><span class="s2">"--"</span><span class="w"> </span><span class="n">on</span><span class="w"> </span><span class="n">input</span><span class="w"> </span><span class="n">goes</span><span class="w"> </span><span class="n">into</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">variable</span><span class="w"></span> |
| 260 |
<span class="w"> </span><span class="n">REMAINING</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">values</span><span class="w"> </span><span class="n">double</span><span class="o">-</span><span class="n">quoted</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">also</span><span class="w"> </span><span class="n">into</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">ARGS</span><span class="w"></span> |
| 261 |
<span class="w"> </span><span class="n">instead</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">becoming</span><span class="w"> </span><span class="n">elements</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">UNNAMED</span><span class="w"> </span><span class="n">array</span><span class="o">.</span><span class="w"> </span><span class="n">This</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="ow">not</span><span class="w"></span> |
| 262 |
<span class="w"> </span><span class="n">needed</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">normal</span><span class="w"> </span><span class="n">processing</span><span class="p">,</span><span class="w"> </span><span class="n">but</span><span class="w"> </span><span class="n">was</span><span class="w"> </span><span class="n">needed</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="n">that</span><span class="w"></span> |
| 263 |
<span class="w"> </span><span class="n">needed</span><span class="w"> </span><span class="n">this</span><span class="w"> </span><span class="n">behavior</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">its</span><span class="w"> </span><span class="n">subcommands</span><span class="o">.</span><span class="w"></span> |
| 264 |
|
| 265 |
<span class="w"> </span><span class="n">That</span><span class="w"> </span><span class="k">is</span><span class="p">,</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">normal</span><span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">all</span><span class="w"> </span><span class="n">unnamed</span><span class="w"> </span><span class="n">values</span><span class="w"> </span><span class="n">go</span><span class="w"> </span><span class="n">into</span><span class="w"> </span><span class="n">UNNAMED</span><span class="w"></span> |
| 266 |
<span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">ARGS</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">REMAINING</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">ignored</span><span class="o">.</span><span class="w"> </span><span class="n">So</span><span class="w"> </span><span class="k">for</span><span class="w"></span> |
| 267 |
|
| 268 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">set_args</span><span class="p">(</span><span class="s1">'-x 10 -y 20 '</span><span class="p">)</span><span class="w"></span> |
| 269 |
|
| 270 |
<span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="n">invocation</span><span class="w"> </span><span class="n">such</span><span class="w"> </span><span class="k">as</span><span class="w"></span> |
| 271 |
|
| 272 |
<span class="w"> </span><span class="n">xx</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="n">c</span><span class="w"> </span><span class="o">--</span><span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="n">B</span><span class="w"> </span><span class="n">C</span><span class="w"> </span><span class="s2">" dd "</span><span class="w"></span> |
| 273 |
|
| 274 |
<span class="w"> </span><span class="n">results</span><span class="w"> </span><span class="ow">in</span><span class="w"></span> |
| 275 |
|
| 276 |
<span class="w"> </span><span class="n">UNNAMED</span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s1">'a'</span><span class="p">,</span><span class="s1">'b'</span><span class="p">,</span><span class="s1">'c'</span><span class="p">,</span><span class="s1">'A'</span><span class="p">,</span><span class="s1">'B'</span><span class="p">,</span><span class="s1">'C'</span><span class="p">,</span><span class="s1">' dd'</span><span class="p">]</span><span class="w"></span> |
| 277 |
<span class="w"> </span><span class="n">REMAINING</span><span class="o">=</span><span class="w"> </span><span class="s1">''</span><span class="w"></span> |
| 278 |
<span class="w"> </span><span class="n">ARGS</span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="o">!</span><span class="w"> </span><span class="n">ie</span><span class="p">,</span><span class="w"> </span><span class="n">an</span><span class="w"> </span><span class="n">empty</span><span class="w"> </span><span class="n">character</span><span class="w"> </span><span class="n">array</span><span class="w"></span> |
| 279 |
|
| 280 |
<span class="w"> </span><span class="n">Whereas</span><span class="w"></span> |
| 281 |
|
| 282 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">set_args</span><span class="p">(</span><span class="s1">'-x 10 -y 20 --'</span><span class="p">)</span><span class="w"></span> |
| 283 |
|
| 284 |
<span class="w"> </span><span class="n">generates</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">following</span><span class="w"> </span><span class="n">output</span><span class="w"> </span><span class="n">from</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">same</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="n">execution</span><span class="p">:</span><span class="w"></span> |
| 285 |
|
| 286 |
<span class="w"> </span><span class="n">UNNAMED</span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s1">'a'</span><span class="p">,</span><span class="s1">'b'</span><span class="p">,</span><span class="s1">'c'</span><span class="p">]</span><span class="w"></span> |
| 287 |
<span class="w"> </span><span class="n">REMAINING</span><span class="o">=</span><span class="w"> </span><span class="s1">'"A" "B" "C" " dd "'</span><span class="w"></span> |
| 288 |
<span class="w"> </span><span class="n">ARGS</span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s1">'A'</span><span class="p">,</span><span class="s1">'B'</span><span class="p">,</span><span class="s1">'C,'</span><span class="w"> </span><span class="n">dd</span><span class="s1">']</span> |
| 289 |
</code></pre></div> |
| 290 |
|
| 291 |
<h2 id="usage-notes">USAGE NOTES</h2> |
| 292 |
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="n">When</span><span class="w"> </span><span class="n">invoking</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="n">line</span><span class="w"> </span><span class="n">note</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="p">(</span><span class="n">subject</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">change</span><span class="p">)</span><span class="w"></span> |
| 293 |
<span class="w"> </span><span class="n">following</span><span class="w"> </span><span class="n">restrictions</span><span class="w"> </span><span class="p">(</span><span class="n">which</span><span class="w"> </span><span class="n">often</span><span class="w"> </span><span class="n">differ</span><span class="w"> </span><span class="n">between</span><span class="w"> </span><span class="n">various</span><span class="w"></span> |
| 294 |
<span class="w"> </span><span class="n">command</span><span class="o">-</span><span class="n">line</span><span class="w"> </span><span class="n">parsers</span><span class="p">):</span><span class="w"></span> |
| 295 |
|
| 296 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">values</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">duplicate</span><span class="w"> </span><span class="n">keywords</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">appended</span><span class="w"> </span><span class="n">together</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">space</span><span class="w"></span> |
| 297 |
<span class="w"> </span><span class="n">separator</span><span class="w"> </span><span class="n">when</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">command</span><span class="w"> </span><span class="n">line</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">executed</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="n">default</span><span class="o">.</span><span class="w"></span> |
| 298 |
|
| 299 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">shuffling</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">supported</span><span class="o">.</span><span class="w"> </span><span class="n">Values</span><span class="w"> </span><span class="n">immediately</span><span class="w"> </span><span class="n">follow</span><span class="w"> </span><span class="n">their</span><span class="w"></span> |
| 300 |
<span class="w"> </span><span class="n">keywords</span><span class="o">.</span><span class="w"></span> |
| 301 |
|
| 302 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">Only</span><span class="w"> </span><span class="n">short</span><span class="w"> </span><span class="n">Boolean</span><span class="w"> </span><span class="n">keywords</span><span class="w"> </span><span class="n">can</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">bundled</span><span class="w"> </span><span class="n">together</span><span class="o">.</span><span class="w"></span> |
| 303 |
<span class="w"> </span><span class="n">If</span><span class="w"> </span><span class="n">allowing</span><span class="w"> </span><span class="n">bundling</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">desired</span><span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="s2">"set_mode('strict')"</span><span class="o">.</span><span class="w"></span> |
| 304 |
<span class="w"> </span><span class="n">This</span><span class="w"> </span><span class="n">will</span><span class="w"> </span><span class="n">require</span><span class="w"> </span><span class="n">prefixing</span><span class="w"> </span><span class="n">long</span><span class="w"> </span><span class="n">names</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="s2">"--"</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">short</span><span class="w"></span> |
| 305 |
<span class="w"> </span><span class="n">names</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="s2">"-"</span><span class="o">.</span><span class="w"> </span><span class="n">Otherwise</span><span class="w"> </span><span class="n">M_CLI2</span><span class="w"> </span><span class="n">relaxes</span><span class="w"> </span><span class="n">that</span><span class="w"> </span><span class="n">requirement</span><span class="w"></span> |
| 306 |
<span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">mostly</span><span class="w"> </span><span class="n">does</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">care</span><span class="w"> </span><span class="n">what</span><span class="w"> </span><span class="n">prefix</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">keyword</span><span class="o">.</span><span class="w"></span> |
| 307 |
<span class="w"> </span><span class="n">But</span><span class="w"> </span><span class="n">this</span><span class="w"> </span><span class="n">would</span><span class="w"> </span><span class="n">make</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="n">unclear</span><span class="w"> </span><span class="n">what</span><span class="w"> </span><span class="n">was</span><span class="w"> </span><span class="n">meant</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="s2">"-ox"</span><span class="w"> </span><span class="k">if</span><span class="w"></span> |
| 308 |
<span class="w"> </span><span class="n">allowed</span><span class="w"> </span><span class="n">options</span><span class="w"> </span><span class="n">were</span><span class="w"> </span><span class="s2">"-o F -x F --ox F "</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">example</span><span class="p">,</span><span class="w"> </span><span class="n">so</span><span class="w"></span> |
| 309 |
<span class="w"> </span><span class="s2">"strict"</span><span class="w"> </span><span class="n">mode</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">required</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">remove</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">ambiguity</span><span class="o">.</span><span class="w"></span> |
| 310 |
|
| 311 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">parameter</span><span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">just</span><span class="w"> </span><span class="s2">"-"</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">supplied</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="k">is</span><span class="w"></span> |
| 312 |
<span class="w"> </span><span class="n">converted</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="s2">"stdin"</span><span class="o">.</span><span class="w"></span> |
| 313 |
|
| 314 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">values</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">needed</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">keyword</span><span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="n">go</span><span class="w"> </span><span class="n">into</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">character</span><span class="w"></span> |
| 315 |
<span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="s2">"UNNAMED"</span><span class="o">.</span><span class="w"></span> |
| 316 |
|
| 317 |
<span class="w"> </span><span class="n">In</span><span class="w"> </span><span class="n">addition</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">keyword</span><span class="w"> </span><span class="s2">"--"</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">encountered</span><span class="w"> </span><span class="n">on</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">command</span><span class="w"></span> |
| 318 |
<span class="w"> </span><span class="n">line</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">rest</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">command</span><span class="w"> </span><span class="n">line</span><span class="w"> </span><span class="n">goes</span><span class="w"> </span><span class="n">into</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">character</span><span class="w"> </span><span class="n">array</span><span class="w"></span> |
| 319 |
<span class="w"> </span><span class="s2">"UNNAMED"</span><span class="o">.</span><span class="w"></span> |
| 320 |
</code></pre></div> |
| 321 |
|
| 322 |
<h2 id="example">EXAMPLE</h2> |
| 323 |
<p>Sample program:</p> |
| 324 |
<div class="codehilite"><pre><span></span><code> <span class="nv">program</span> <span class="nv">demo_set_args</span> |
| 325 |
<span class="nv">use</span> <span class="nv">M_CLI2</span>, <span class="nv">only</span> : <span class="nv">filenames</span><span class="o">=></span><span class="nv">unnamed</span>, <span class="nv">set_args</span>, <span class="nv">get_args</span> |
| 326 |
<span class="nv">use</span> <span class="nv">M_CLI2</span>, <span class="nv">only</span> : <span class="nv">get_args_fixed_size</span> |
| 327 |
<span class="nv">implicit</span> <span class="nv">none</span> |
| 328 |
<span class="nv">integer</span> :: <span class="nv">i</span> |
| 329 |
<span class="o">!</span> <span class="nv">DEFINE</span> <span class="nv">ARGS</span> |
| 330 |
<span class="nv">real</span> :: <span class="nv">x</span>, <span class="nv">y</span>, <span class="nv">z</span> |
| 331 |
<span class="nv">real</span> :: <span class="nv">p</span><span class="ss">(</span><span class="mi">3</span><span class="ss">)</span> |
| 332 |
<span class="nv">character</span><span class="ss">(</span><span class="nv">len</span><span class="o">=</span>:<span class="ss">)</span>,<span class="nv">allocatable</span> :: <span class="nv">title</span> |
| 333 |
<span class="nv">logical</span> :: <span class="nv">l</span>, <span class="nv">lbig</span> |
| 334 |
<span class="nv">integer</span>,<span class="nv">allocatable</span> :: <span class="nv">ints</span><span class="ss">(</span>:<span class="ss">)</span> |
| 335 |
<span class="o">!</span> |
| 336 |
<span class="o">!</span> <span class="nv">DEFINE</span> <span class="nv">COMMAND</span> <span class="ss">(</span><span class="nv">TO</span> <span class="nv">SET</span> <span class="nv">INITIAL</span> <span class="nv">VALUES</span> <span class="nv">AND</span> <span class="nv">ALLOWED</span> <span class="nv">KEYWORDS</span><span class="ss">)</span> |
| 337 |
<span class="o">!</span> <span class="nv">AND</span> <span class="nv">READ</span> <span class="nv">COMMAND</span> <span class="nv">LINE</span> |
| 338 |
<span class="k">call</span> <span class="nl">set_args</span><span class="ss">(</span><span class="s1">'</span><span class="s"> &</span> |
| 339 |
<span class="o">!</span> <span class="nv">reals</span> |
| 340 |
<span class="o">&</span> <span class="o">-</span><span class="nv">x</span> <span class="mi">1</span> <span class="o">-</span><span class="nv">y</span> <span class="mi">2</span>.<span class="mi">3</span> <span class="o">-</span><span class="nv">z</span> <span class="mi">3</span>.<span class="mi">4</span><span class="nv">e2</span> <span class="o">&</span> |
| 341 |
<span class="o">!</span> <span class="nv">integer</span> <span class="nv">array</span> |
| 342 |
<span class="o">&</span> <span class="o">-</span><span class="nv">p</span> <span class="o">-</span><span class="mi">1</span>,<span class="o">-</span><span class="mi">2</span>,<span class="o">-</span><span class="mi">3</span> <span class="o">&</span> |
| 343 |
<span class="o">!</span> <span class="nv">always</span> <span class="nv">double</span><span class="o">-</span><span class="nv">quote</span> <span class="nv">strings</span> |
| 344 |
<span class="o">&</span> <span class="o">--</span><span class="nv">title</span> <span class="s2">"</span><span class="s">my title</span><span class="s2">"</span> <span class="o">&</span> |
| 345 |
<span class="o">!</span> <span class="nv">string</span> <span class="nv">should</span> <span class="nv">be</span> <span class="nv">a</span> <span class="nv">single</span> <span class="nv">character</span> <span class="nv">at</span> <span class="nv">a</span> <span class="nv">minimum</span> |
| 346 |
<span class="o">&</span> <span class="o">--</span><span class="nv">label</span> <span class="s2">"</span><span class="s"> </span><span class="s2">"</span>, <span class="o">&</span> |
| 347 |
<span class="o">!</span> <span class="nv">set</span> <span class="nv">all</span> <span class="nv">logical</span> <span class="nv">values</span> <span class="nv">to</span> <span class="nv">F</span> |
| 348 |
<span class="o">&</span> <span class="o">-</span><span class="nv">l</span> <span class="nv">F</span> <span class="o">-</span><span class="nv">L</span> <span class="nv">F</span> <span class="o">&</span> |
| 349 |
<span class="o">!</span> <span class="nv">set</span> <span class="nv">allocatable</span> <span class="nv">size</span> <span class="nv">to</span> <span class="nv">zero</span> <span class="k">if</span> <span class="nv">you</span> <span class="nv">like</span> <span class="nv">by</span> <span class="nv">using</span> <span class="nv">a</span> <span class="nv">delimiter</span> |
| 350 |
<span class="o">&</span> <span class="o">--</span><span class="nv">ints</span> , <span class="o">&</span> |
| 351 |
<span class="o">&</span> <span class="s1">'</span><span class="s">)</span> |
| 352 |
<span class="o">!</span> <span class="nv">ASSIGN</span> <span class="nv">VALUES</span> <span class="nv">TO</span> <span class="nv">ELEMENTS</span> |
| 353 |
<span class="o">!</span> <span class="nv">SCALARS</span> |
| 354 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">x</span><span class="s1">'</span>,<span class="nv">x</span><span class="ss">)</span> |
| 355 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">y</span><span class="s1">'</span>,<span class="nv">y</span><span class="ss">)</span> |
| 356 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">z</span><span class="s1">'</span>,<span class="nv">z</span><span class="ss">)</span> |
| 357 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">l</span><span class="s1">'</span>,<span class="nv">l</span><span class="ss">)</span> |
| 358 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">L</span><span class="s1">'</span>,<span class="nv">lbig</span><span class="ss">)</span> |
| 359 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">ints</span><span class="s1">'</span>,<span class="nv">ints</span><span class="ss">)</span> <span class="o">!</span> <span class="nv">ALLOCATABLE</span> <span class="nv">ARRAY</span> |
| 360 |
<span class="k">call</span> <span class="nl">get_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">title</span><span class="s1">'</span>,<span class="nv">title</span><span class="ss">)</span> <span class="o">!</span> <span class="nv">ALLOCATABLE</span> <span class="nv">STRING</span> |
| 361 |
<span class="k">call</span> <span class="nl">get_args_fixed_size</span><span class="ss">(</span><span class="s1">'</span><span class="s">p</span><span class="s1">'</span>,<span class="nv">p</span><span class="ss">)</span> <span class="o">!</span> <span class="nv">NON</span><span class="o">-</span><span class="nv">ALLOCATABLE</span> <span class="nv">ARRAY</span> |
| 362 |
<span class="o">!</span> <span class="nv">USE</span> <span class="nv">VALUES</span> |
| 363 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">x=</span><span class="s1">'</span>,<span class="nv">x</span> |
| 364 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">y=</span><span class="s1">'</span>,<span class="nv">y</span> |
| 365 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">z=</span><span class="s1">'</span>,<span class="nv">z</span> |
| 366 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">p=</span><span class="s1">'</span>,<span class="nv">p</span> |
| 367 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">title=</span><span class="s1">'</span>,<span class="nv">title</span> |
| 368 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">ints=</span><span class="s1">'</span>,<span class="nv">ints</span> |
| 369 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">l=</span><span class="s1">'</span>,<span class="nv">l</span> |
| 370 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="o">*</span><span class="ss">)</span><span class="s1">'</span><span class="s">L=</span><span class="s1">'</span>,<span class="nv">lbig</span> |
| 371 |
<span class="o">!</span> <span class="nv">UNNAMED</span> <span class="nv">VALUES</span> |
| 372 |
<span class="k">if</span><span class="ss">(</span><span class="nv">size</span><span class="ss">(</span><span class="nv">filenames</span><span class="ss">)</span> <span class="o">></span> <span class="mi">0</span><span class="ss">)</span><span class="k">then</span> |
| 373 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="s1">'</span><span class="s">(i6.6,3a)</span><span class="s1">'</span><span class="ss">)(</span><span class="nv">i</span>,<span class="s1">'</span><span class="s">[</span><span class="s1">'</span>,<span class="nv">filenames</span><span class="ss">(</span><span class="nv">i</span><span class="ss">)</span>,<span class="s1">'</span><span class="s">]</span><span class="s1">'</span>,<span class="nv">i</span><span class="o">=</span><span class="mi">1</span>,<span class="nv">size</span><span class="ss">(</span><span class="nv">filenames</span><span class="ss">))</span> |
| 374 |
<span class="k">endif</span> |
| 375 |
<span class="k">end</span> <span class="nv">program</span> <span class="nv">demo_set_args</span> |
| 376 |
</code></pre></div> |
| 377 |
|
| 378 |
<h2 id="response-files">RESPONSE FILES</h2> |
| 379 |
<p>If you have no interest in using external files as abbreviations |
| 380 |
you can ignore this section. Otherwise, before calling set_args(3f) |
| 381 |
add:</p> |
| 382 |
<div class="codehilite"><pre><span></span><code> use M_CLI2, only : set_mode |
| 383 |
call set_mode('response_file') |
| 384 |
</code></pre></div> |
| 385 |
|
| 386 |
<p>M_CLI2 Response files are small files containing CLI (Command Line |
| 387 |
Interface) arguments that end with “.rsp” that can be used when command |
| 388 |
lines are so long that they would exceed line length limits or so complex |
| 389 |
that it is useful to have a platform-independent method of creating |
| 390 |
an abbreviation.</p> |
| 391 |
<p>Shell aliases and scripts are often used for similar purposes (and |
| 392 |
allow for much more complex conditional execution, of course), but |
| 393 |
they generally cannot be used to overcome line length limits and are |
| 394 |
typically platform-specific.</p> |
| 395 |
<p>Examples of commands that support similar response files are the Clang |
| 396 |
and Intel compilers, although there is no standard format for the files.</p> |
| 397 |
<p>They are read if you add options of the syntax “@NAME” as the FIRST |
| 398 |
parameters on your program command line calls. They are not recursive – |
| 399 |
that is, an option in a response file cannot be given the value “@NAME2” |
| 400 |
to call another response file.</p> |
| 401 |
<p>More than one response name may appear on a command line.</p> |
| 402 |
<p>They are case-sensitive names.</p> |
| 403 |
<p>Note “@” s a special character in Powershell, and requires being escaped |
| 404 |
with a grave character.</p> |
| 405 |
<p>LOCATING RESPONSE FILES</p> |
| 406 |
<p>A search for the response file always starts with the current directory. |
| 407 |
The search then proceeds to look in any additional directories specified |
| 408 |
with the colon-delimited environment variable CLI_RESPONSE_PATH.</p> |
| 409 |
<p>The first resource file found that results in lines being processed |
| 410 |
will be used and processing stops after that first match is found. If |
| 411 |
no match is found an error occurs and the program is stopped.</p> |
| 412 |
<p>RESPONSE FILE SECTIONS</p> |
| 413 |
<p>A simple response file just has options for calling the program in it |
| 414 |
prefixed with the word “options”. |
| 415 |
But they can also contain section headers to denote selections that are |
| 416 |
only executed when a specific OS is being used, print messages, and |
| 417 |
execute system commands.</p> |
| 418 |
<p>SEARCHING FOR OSTYPE IN REGULAR FILES</p> |
| 419 |
<p>So assuming the name @NAME was specified on the command line a file |
| 420 |
named NAME.rsp will be searched for in all the search directories |
| 421 |
and then in that file a string that starts with the string @OSTYPE |
| 422 |
(if the environment variables $OS and $OSTYPE are not blank. $OSTYPE |
| 423 |
takes precedence over $OS).</p> |
| 424 |
<p>SEARCHING FOR UNLABELED DIRECTIVES IN REGULAR FILES</p> |
| 425 |
<p>Then, the same files will be searched for lines above any line starting |
| 426 |
with “@”. That is, if there is no special section for the current OS |
| 427 |
it just looks at the top of the file for unlabeled options.</p> |
| 428 |
<p>SEARCHING FOR OSTYPE AND NAME IN THE COMPOUND FILE</p> |
| 429 |
<p>In addition or instead of files with the same name as the @NAME option |
| 430 |
on the command line, you can have one file named after the executable |
| 431 |
name that contains multiple abbreviation names.</p> |
| 432 |
<p>So if your program executable is named EXEC you create a single file |
| 433 |
called EXEC.rsp and can append all the simple files described above |
| 434 |
separating them with lines of the form @OSTYPE@NAME or just @NAME.</p> |
| 435 |
<p>So if no specific file for the abbreviation is found a file called |
| 436 |
“EXEC.rsp” is searched for where “EXEC” is the name of the executable. |
| 437 |
This file is always a “compound” response file that uses the following format:</p> |
| 438 |
<p>Any compound EXEC.rsp file found in the current or searched directories |
| 439 |
will be searched for the string @OSTYPE@NAME first.</p> |
| 440 |
<p>Then if nothing is found, the less specific line @NAME is searched for.</p> |
| 441 |
<p>THE SEARCH IS OVER</p> |
| 442 |
<p>Sounds complicated but actually works quite intuitively. Make a file in |
| 443 |
the current directory and put options in it and it will be used. If that |
| 444 |
file ends up needing different cases for different platforms add a line |
| 445 |
like “@Linux” to the file and some more lines and that will only be |
| 446 |
executed if the environment variable OSTYPE or OS is “Linux”. If no match |
| 447 |
is found for named sections the lines at the top before any “@” lines |
| 448 |
will be used as a default if no match is found.</p> |
| 449 |
<p>If you end up using a lot of files like this you can combine them all |
| 450 |
together and put them into a file called “program_name”.rsp and just |
| 451 |
put lines like @NAME or @OSTYPE@NAME at that top of each selection.</p> |
| 452 |
<p>Now, back to the details on just what you can put in the files.</p> |
| 453 |
<h2 id="specification-for-response-files">SPECIFICATION FOR RESPONSE FILES</h2> |
| 454 |
<p>SIMPLE RESPONSE FILES</p> |
| 455 |
<p>The first word of a line is special and has the following meanings:</p> |
| 456 |
<div class="codehilite"><pre><span></span><code><span class="n">options</span><span class="o">|-</span><span class="w"> </span><span class="n">Command</span><span class="w"> </span><span class="n">options</span><span class="w"> </span><span class="n">following</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">rules</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">SET_ARGS</span><span class="p">(</span><span class="mi">3</span><span class="n">f</span><span class="p">)</span><span class="w"></span> |
| 457 |
<span class="w"> </span><span class="n">prototype</span><span class="o">.</span><span class="w"> </span><span class="n">So</span><span class="w"></span> |
| 458 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">It</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">preferred</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">specify</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">all</span><span class="w"> </span><span class="n">options</span><span class="o">.</span><span class="w"></span> |
| 459 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">double</span><span class="o">-</span><span class="n">quote</span><span class="w"> </span><span class="n">strings</span><span class="o">.</span><span class="w"></span> |
| 460 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">give</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">blank</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">value</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="s2">" "</span><span class="o">.</span><span class="w"></span> |
| 461 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">use</span><span class="w"> </span><span class="n">F</span><span class="o">|</span><span class="n">T</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">lists</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">logicals</span><span class="p">,</span><span class="w"></span> |
| 462 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="n">lists</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">numbers</span><span class="w"> </span><span class="n">should</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">comma</span><span class="o">-</span><span class="n">delimited</span><span class="o">.</span><span class="w"></span> |
| 463 |
<span class="w"> </span><span class="n">o</span><span class="w"> </span><span class="o">--</span><span class="n">usage</span><span class="p">,</span><span class="w"> </span><span class="o">--</span><span class="n">help</span><span class="p">,</span><span class="w"> </span><span class="o">--</span><span class="n">version</span><span class="p">,</span><span class="w"> </span><span class="o">--</span><span class="n">verbose</span><span class="p">,</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">unknown</span><span class="w"></span> |
| 464 |
<span class="w"> </span><span class="n">options</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">ignored</span><span class="o">.</span><span class="w"></span> |
| 465 |
|
| 466 |
<span class="n">comment</span><span class="o">|</span><span class="c1"># Line is a comment line</span><span class="w"></span> |
| 467 |
<span class="n">system</span><span class="o">|!</span><span class="w"> </span><span class="n">System</span><span class="w"> </span><span class="n">command</span><span class="o">.</span><span class="w"></span> |
| 468 |
<span class="w"> </span><span class="n">System</span><span class="w"> </span><span class="n">commands</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">executed</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">simple</span><span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">to</span><span class="w"></span> |
| 469 |
<span class="w"> </span><span class="n">system</span><span class="w"> </span><span class="p">(</span><span class="n">so</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">cd</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">setting</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">shell</span><span class="w"> </span><span class="n">variable</span><span class="w"></span> |
| 470 |
<span class="w"> </span><span class="n">would</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">effect</span><span class="w"> </span><span class="n">subsequent</span><span class="w"> </span><span class="n">lines</span><span class="p">,</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">example</span><span class="p">)</span><span class="w"></span> |
| 471 |
<span class="w"> </span><span class="n">BEFORE</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">command</span><span class="w"> </span><span class="n">being</span><span class="w"> </span><span class="n">processed</span><span class="o">.</span><span class="w"></span> |
| 472 |
<span class="nb">print</span><span class="o">|></span><span class="w"> </span><span class="n">Message</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">screen</span><span class="w"></span> |
| 473 |
<span class="n">stop</span><span class="w"> </span><span class="n">display</span><span class="w"> </span><span class="n">message</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">stop</span><span class="w"> </span><span class="n">program</span><span class="o">.</span><span class="w"></span> |
| 474 |
</code></pre></div> |
| 475 |
|
| 476 |
<p>NOTE: system commands are executed when encountered, but options are |
| 477 |
gathered from multiple option lines and passed together at the end of |
| 478 |
processing of the block; so all commands will be executed BEFORE the |
| 479 |
command for which options are being supplied no matter where they occur.</p> |
| 480 |
<p>So if a program that does nothing but echos its parameters</p> |
| 481 |
<div class="codehilite"><pre><span></span><code><span class="nv">program</span> <span class="nv">testit</span> |
| 482 |
<span class="nv">use</span> <span class="nv">M_CLI2</span>, <span class="nv">only</span> : <span class="nv">set_args</span>, <span class="nv">rget</span>, <span class="nv">sget</span>, <span class="nv">lget</span>, <span class="nv">set_mode</span> |
| 483 |
<span class="nv">implicit</span> <span class="nv">none</span> |
| 484 |
<span class="nv">real</span> :: <span class="nv">x</span>,<span class="nv">y</span> <span class="c1">; namelist/args/ x,y</span> |
| 485 |
<span class="nv">character</span><span class="ss">(</span><span class="nv">len</span><span class="o">=</span>:<span class="ss">)</span>,<span class="nv">allocatable</span> :: <span class="nv">title</span> <span class="c1">; namelist/args/ title</span> |
| 486 |
<span class="nv">logical</span> :: <span class="nv">big</span> <span class="c1">; namelist/args/ big</span> |
| 487 |
<span class="k">call</span> <span class="nl">set_mode</span><span class="ss">(</span><span class="s1">'</span><span class="s">response_file</span><span class="s1">'</span><span class="ss">)</span> |
| 488 |
<span class="k">call</span> <span class="nl">set_args</span><span class="ss">(</span><span class="s1">'</span><span class="s">-x 10.0 -y 20.0 --title "my title" --big F</span><span class="s1">'</span><span class="ss">)</span> |
| 489 |
<span class="nv">x</span><span class="o">=</span><span class="nv">rget</span><span class="ss">(</span><span class="s1">'</span><span class="s">x</span><span class="s1">'</span><span class="ss">)</span> |
| 490 |
<span class="nv">y</span><span class="o">=</span><span class="nv">rget</span><span class="ss">(</span><span class="s1">'</span><span class="s">y</span><span class="s1">'</span><span class="ss">)</span> |
| 491 |
<span class="nv">title</span><span class="o">=</span><span class="nv">sget</span><span class="ss">(</span><span class="s1">'</span><span class="s">title</span><span class="s1">'</span><span class="ss">)</span> |
| 492 |
<span class="nv">big</span><span class="o">=</span><span class="nv">lget</span><span class="ss">(</span><span class="s1">'</span><span class="s">big</span><span class="s1">'</span><span class="ss">)</span> |
| 493 |
<span class="nv">write</span><span class="ss">(</span><span class="o">*</span>,<span class="nv">nml</span><span class="o">=</span><span class="nv">args</span><span class="ss">)</span> |
| 494 |
<span class="k">end</span> <span class="nv">program</span> <span class="nv">testit</span> |
| 495 |
</code></pre></div> |
| 496 |
|
| 497 |
<p>And a file in the current directory called “a.rsp” contains</p> |
| 498 |
<div class="codehilite"><pre><span></span><code> # <span class="nv">defaults</span> <span class="k">for</span> <span class="nv">project</span> <span class="nv">A</span> |
| 499 |
<span class="nv">options</span> <span class="o">-</span><span class="nv">x</span> <span class="mi">1000</span> <span class="o">-</span><span class="nv">y</span> <span class="mi">9999</span> |
| 500 |
<span class="nv">options</span> <span class="o">--</span><span class="nv">title</span> <span class="s2">"</span><span class="s"> </span><span class="s2">"</span> |
| 501 |
<span class="nv">options</span> <span class="o">--</span><span class="nv">big</span> <span class="nv">T</span> |
| 502 |
</code></pre></div> |
| 503 |
|
| 504 |
<p>The program could be called with</p> |
| 505 |
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="err">$</span><span class="n">myprog</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">normal</span><span class="w"> </span><span class="k">call</span><span class="w"></span> |
| 506 |
<span class="w"> </span><span class="n">X</span><span class="o">=</span><span class="mf">10.0</span><span class="w"> </span><span class="n">Y</span><span class="o">=</span><span class="mf">20.0</span><span class="w"> </span><span class="n">TITLE</span><span class="o">=</span><span class="ss">"my title"</span><span class="w"></span> |
| 507 |
|
| 508 |
<span class="w"> </span><span class="err">$</span><span class="n">myprog</span><span class="w"> </span><span class="nv">@a</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">change</span><span class="w"> </span><span class="n">defaults</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">specified</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="ss">"a.rsp"</span><span class="w"></span> |
| 509 |
<span class="w"> </span><span class="n">X</span><span class="o">=</span><span class="mf">1000.0</span><span class="w"> </span><span class="n">Y</span><span class="o">=</span><span class="mf">9999.0</span><span class="w"> </span><span class="n">TITLE</span><span class="o">=</span><span class="ss">" "</span><span class="w"></span> |
| 510 |
|
| 511 |
<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">change</span><span class="w"> </span><span class="n">defaults</span><span class="w"> </span><span class="n">but</span><span class="w"> </span><span class="k">use</span><span class="w"> </span><span class="ow">any</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">normal</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">override</span><span class="w"> </span><span class="n">defaults</span><span class="w"></span> |
| 512 |
<span class="w"> </span><span class="err">$</span><span class="n">myprog</span><span class="w"> </span><span class="nv">@a</span><span class="w"> </span><span class="o">-</span><span class="n">y</span><span class="w"> </span><span class="mi">1234</span><span class="w"></span> |
| 513 |
<span class="w"> </span><span class="n">X</span><span class="o">=</span><span class="mf">1000.0</span><span class="w"> </span><span class="n">Y</span><span class="o">=</span><span class="mf">1234.0</span><span class="w"> </span><span class="n">TITLE</span><span class="o">=</span><span class="ss">" "</span><span class="w"></span> |
| 514 |
</code></pre></div> |
| 515 |
|
| 516 |
<p>COMPOUND RESPONSE FILES</p> |
| 517 |
<p>A compound response file has the same basename as the executable with a |
| 518 |
“.rsp” suffix added. So if your program is named “myprg” the filename |
| 519 |
must be “myprg.rsp”.</p> |
| 520 |
<div class="codehilite"><pre><span></span><code><span class="n">Note</span><span class="w"> </span><span class="n">that</span><span class="w"> </span><span class="n">here</span><span class="w"> </span><span class="n n-Quoted">`basename`</span><span class="w"> </span><span class="n">means</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="k">last</span><span class="w"> </span><span class="n">leaf</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">the</span><span class="w"></span> |
| 521 |
<span class="k">name</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">returned</span><span class="w"> </span><span class="k">by</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">Fortran</span><span class="w"> </span><span class="n">intrinsic</span><span class="w"></span> |
| 522 |
<span class="n">GET_COMMAND_ARGUMENT</span><span class="p">(</span><span class="mi">0</span><span class="p">,...)</span><span class="w"> </span><span class="n">trimmed</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">anything</span><span class="w"> </span><span class="k">after</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">period</span><span class="w"> </span><span class="p">(</span><span class="s2">"."</span><span class="p">),</span><span class="w"></span> |
| 523 |
<span class="n">so</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">good</span><span class="w"> </span><span class="n">idea</span><span class="w"> </span><span class="k">not</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="k">use</span><span class="w"> </span><span class="n">hidden</span><span class="w"> </span><span class="n">files</span><span class="p">.</span><span class="w"></span> |
| 524 |
</code></pre></div> |
| 525 |
|
| 526 |
<p>Unlike simple response files compound response files can contain multiple |
| 527 |
setting names.</p> |
| 528 |
<p>Specifically in a compound file |
| 529 |
if the environment variable $OSTYPE (first) or $OS is set the first search |
| 530 |
will be for a line of the form (no leading spaces should be used):</p> |
| 531 |
<div class="codehilite"><pre><span></span><code><span class="nv">@OSTYPE@alias_name</span><span class="w"></span> |
| 532 |
</code></pre></div> |
| 533 |
|
| 534 |
<p>If no match or if the environment variables $OSTYPE and $OS were not |
| 535 |
set or a match is not found then a line of the form</p> |
| 536 |
<div class="codehilite"><pre><span></span><code><span class="nv">@alias_name</span><span class="w"></span> |
| 537 |
</code></pre></div> |
| 538 |
|
| 539 |
<p>is searched for in simple or compound files. If found subsequent lines |
| 540 |
will be ignored that start with “@” until a line not starting with |
| 541 |
“@” is encountered. Lines will then be processed until another line |
| 542 |
starting with “@” is found or end-of-file is encountered.</p> |
| 543 |
<p>COMPOUND RESPONSE FILE EXAMPLE |
| 544 |
An example compound file</p> |
| 545 |
<div class="codehilite"><pre><span></span><code>#################<span class="w"></span> |
| 546 |
<span class="p">@</span><span class="k">if</span><span class="w"></span> |
| 547 |
<span class="o">></span><span class="w"> </span><span class="n">RUNNING</span><span class="w"> </span><span class="n">TESTS</span><span class="w"> </span><span class="n">USING</span><span class="w"> </span><span class="n">RELEASE</span><span class="w"> </span><span class="n">VERSION</span><span class="w"> </span><span class="n">AND</span><span class="w"> </span><span class="n">ifort</span><span class="w"></span> |
| 548 |
<span class="n">options</span><span class="w"> </span><span class="s">test</span><span class="w"> </span><span class="o">--</span><span class="nb">release</span><span class="w"> </span><span class="o">--</span><span class="n">compiler</span><span class="w"> </span><span class="n">ifort</span><span class="w"></span> |
| 549 |
#################<span class="w"></span> |
| 550 |
<span class="p">@</span><span class="n">gf</span><span class="w"></span> |
| 551 |
<span class="o">></span><span class="w"> </span><span class="n">RUNNING</span><span class="w"> </span><span class="n">TESTS</span><span class="w"> </span><span class="n">USING</span><span class="w"> </span><span class="n">RELEASE</span><span class="w"> </span><span class="n">VERSION</span><span class="w"> </span><span class="n">AND</span><span class="w"> </span><span class="n">gfortran</span><span class="w"></span> |
| 552 |
<span class="n">options</span><span class="w"> </span><span class="s">test</span><span class="w"> </span><span class="o">--</span><span class="nb">release</span><span class="w"> </span><span class="o">--</span><span class="n">compiler</span><span class="w"> </span><span class="n">gfortran</span><span class="w"></span> |
| 553 |
#################<span class="w"></span> |
| 554 |
<span class="p">@</span><span class="n">nv</span><span class="w"></span> |
| 555 |
<span class="o">></span><span class="w"> </span><span class="n">RUNNING</span><span class="w"> </span><span class="n">TESTS</span><span class="w"> </span><span class="n">USING</span><span class="w"> </span><span class="n">RELEASE</span><span class="w"> </span><span class="n">VERSION</span><span class="w"> </span><span class="n">AND</span><span class="w"> </span><span class="n">nvfortran</span><span class="w"></span> |
| 556 |
<span class="n">options</span><span class="w"> </span><span class="s">test</span><span class="w"> </span><span class="o">--</span><span class="nb">release</span><span class="w"> </span><span class="o">--</span><span class="n">compiler</span><span class="w"> </span><span class="n">nvfortran</span><span class="w"></span> |
| 557 |
#################<span class="w"></span> |
| 558 |
<span class="p">@</span><span class="n">nag</span><span class="w"></span> |
| 559 |
<span class="o">></span><span class="w"> </span><span class="n">RUNNING</span><span class="w"> </span><span class="n">TESTS</span><span class="w"> </span><span class="n">USING</span><span class="w"> </span><span class="n">RELEASE</span><span class="w"> </span><span class="n">VERSION</span><span class="w"> </span><span class="n">AND</span><span class="w"> </span><span class="n">nagfor</span><span class="w"></span> |
| 560 |
<span class="n">options</span><span class="w"> </span><span class="s">test</span><span class="w"> </span><span class="o">--</span><span class="nb">release</span><span class="w"> </span><span class="o">--</span><span class="n">compiler</span><span class="w"> </span><span class="n">nagfor</span><span class="w"></span> |
| 561 |
#<span class="w"></span> |
| 562 |
#################<span class="w"></span> |
| 563 |
#<span class="w"> </span><span class="n">OS</span><span class="o">-</span><span class="n">specific</span><span class="w"> </span><span class="n">example</span><span class="p">:</span><span class="w"></span> |
| 564 |
<span class="p">@</span><span class="n">Linux</span><span class="p">@</span><span class="n">install</span><span class="w"></span> |
| 565 |
#<span class="w"></span> |
| 566 |
#<span class="w"> </span><span class="n">install</span><span class="w"> </span><span class="n">executables</span><span class="w"> </span><span class="n">in</span><span class="w"> </span><span class="n">directory</span><span class="w"> </span><span class="p">(</span><span class="n">assuming</span><span class="w"> </span><span class="n">install</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="n">exists</span><span class="p">)</span><span class="w"></span> |
| 567 |
#<span class="w"></span> |
| 568 |
<span class="nb">system</span><span class="w"> </span><span class="nb">mkdir</span><span class="w"> </span><span class="o">-</span><span class="n">p</span><span class="w"> </span><span class="o">~/</span><span class="p">.</span><span class="n">local</span><span class="o">/</span><span class="n">bin</span><span class="w"></span> |
| 569 |
<span class="n">options</span><span class="w"> </span><span class="s">run</span><span class="w"> </span><span class="o">--</span><span class="nb">release</span><span class="w"> </span><span class="n">T</span><span class="w"> </span><span class="o">--</span><span class="n">runner</span><span class="w"> </span><span class="s">"install -vbp -m 0711 -t ~/.local/bin"</span><span class="w"></span> |
| 570 |
<span class="p">@</span><span class="n">install</span><span class="w"></span> |
| 571 |
<span class="n">STOP</span><span class="w"> </span><span class="s">INSTALL</span><span class="w"> </span><span class="s">NOT</span><span class="w"> </span><span class="s">SUPPORTED</span><span class="w"> </span><span class="s">ON</span><span class="w"> </span><span class="s">THIS</span><span class="w"> </span><span class="s">PLATFORM</span><span class="w"> </span><span class="s">OR</span><span class="w"> </span><span class="s">$OSTYPE</span><span class="w"> </span><span class="s">NOT</span><span class="w"> </span><span class="s">SET</span><span class="w"></span> |
| 572 |
#<span class="w"></span> |
| 573 |
#################<span class="w"></span> |
| 574 |
<span class="p">@</span><span class="n">fpm</span><span class="p">@</span><span class="n">testall</span><span class="w"></span> |
| 575 |
#<span class="w"></span> |
| 576 |
<span class="sx">!fpm test --compiler nvfortran</span><span class="w"></span> |
| 577 |
<span class="sx">!fpm test --compiler ifort</span><span class="w"></span> |
| 578 |
<span class="sx">!fpm test --compiler gfortran</span><span class="w"></span> |
| 579 |
<span class="sx">!fpm test --compiler nagfor</span><span class="w"></span> |
| 580 |
<span class="n">STOP</span><span class="w"> </span><span class="s">tests</span><span class="w"> </span><span class="s">complete.</span><span class="w"> </span><span class="s">Any</span><span class="w"> </span><span class="s">additional</span><span class="w"> </span><span class="s">parameters</span><span class="w"> </span><span class="s">were</span><span class="w"> </span><span class="s">ignored</span><span class="w"></span> |
| 581 |
#################<span class="w"></span> |
| 582 |
</code></pre></div> |
| 583 |
|
| 584 |
<p>Would be used like</p> |
| 585 |
<div class="codehilite"><pre><span></span><code><span class="n">fpm</span><span class="w"> </span><span class="nv">@install</span><span class="w"></span> |
| 586 |
<span class="n">fpm</span><span class="w"> </span><span class="nv">@nag</span><span class="w"> </span><span class="o">--</span><span class="w"></span> |
| 587 |
<span class="n">fpm</span><span class="w"> </span><span class="nv">@testall</span><span class="w"></span> |
| 588 |
</code></pre></div> |
| 589 |
|
| 590 |
<p>NOTES</p> |
| 591 |
<div class="codehilite"><pre><span></span><code><span class="n">The</span><span class="w"> </span><span class="n">intel</span><span class="w"> </span><span class="k">Fortran</span><span class="w"> </span><span class="n">compiler</span><span class="w"> </span><span class="n">now</span><span class="w"> </span><span class="n">calls</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">response</span><span class="w"> </span><span class="n">files</span><span class="w"> </span><span class="ss">"indirect</span> |
| 592 |
<span class="ss">files"</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">does</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="k">add</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">implied</span><span class="w"> </span><span class="n">suffix</span><span class="w"> </span><span class="ss">".rsp"</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">files</span><span class="w"></span> |
| 593 |
<span class="n">anymore</span><span class="p">.</span><span class="w"> </span><span class="n">It</span><span class="w"> </span><span class="n">also</span><span class="w"> </span><span class="n">allows</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="nv">@NAME</span><span class="w"> </span><span class="n">syntax</span><span class="w"> </span><span class="n">anywhere</span><span class="w"> </span><span class="k">on</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">command</span><span class="w"> </span><span class="n">line</span><span class="p">,</span><span class="w"></span> |
| 594 |
<span class="ow">not</span><span class="w"> </span><span class="n">just</span><span class="w"> </span><span class="k">at</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">beginning</span><span class="p">.</span><span class="w"> </span><span class="c1">-- 20201212</span> |
| 595 |
</code></pre></div> |
| 596 |
|
| 597 |
<h2 id="author">AUTHOR</h2> |
| 598 |
<div class="codehilite"><pre><span></span><code> John S. Urban, 2019 |
| 599 |
</code></pre></div> |
| 600 |
|
| 601 |
<h2 id="license">LICENSE</h2> |
| 602 |
<div class="codehilite"><pre><span></span><code> Public Domain |
| 603 |
</code></pre></div> |
| 604 |
|
| 605 |
<h3>Arguments</h3> |
| 606 |
<table class="table table-striped varlist"> |
| 607 |
<thead> |
| 608 |
<tr> |
| 609 |
<th>Type</th> |
| 610 |
<th>Intent</th><th>Optional</th> <th>Attributes</th> |
| 611 |
<th></th> |
| 612 |
<th>Name</th> |
| 613 |
<th></th> |
| 614 |
</thead> |
| 615 |
<tbody> |
| 616 |
<tr> |
| 617 |
<td> |
| 618 |
<span class="anchor" id="variable-prototype"></span> |
| 619 |
character(len=*), |
| 620 |
</td> |
| 621 |
<td>intent(in)</td> |
| 622 |
<td></td> <td> |
| 623 |
|
| 624 |
</td> |
| 625 |
<td>::</td> |
| 626 |
<td><strong>prototype</strong></td> |
| 627 |
<td> |
| 628 |
|
| 629 |
</td> |
| 630 |
</tr> |
| 631 |
<tr> |
| 632 |
<td> |
| 633 |
<span class="anchor" id="variable-help_text~2"></span> |
| 634 |
character(len=*), |
| 635 |
</td> |
| 636 |
<td>intent(in),</td> |
| 637 |
<td>optional</td> <td> |
| 638 |
|
| 639 |
</td> |
| 640 |
<td>::</td> |
| 641 |
<td><strong>help_text</strong>(:)</td> |
| 642 |
<td> |
| 643 |
|
| 644 |
</td> |
| 645 |
</tr> |
| 646 |
<tr> |
| 647 |
<td> |
| 648 |
<span class="anchor" id="variable-version_text~2"></span> |
| 649 |
character(len=*), |
| 650 |
</td> |
| 651 |
<td>intent(in),</td> |
| 652 |
<td>optional</td> <td> |
| 653 |
|
| 654 |
</td> |
| 655 |
<td>::</td> |
| 656 |
<td><strong>version_text</strong>(:)</td> |
| 657 |
<td> |
| 658 |
|
| 659 |
</td> |
| 660 |
</tr> |
| 661 |
<tr> |
| 662 |
<td> |
| 663 |
<span class="anchor" id="variable-string"></span> |
| 664 |
character(len=*), |
| 665 |
</td> |
| 666 |
<td>intent(in),</td> |
| 667 |
<td>optional</td> <td> |
| 668 |
|
| 669 |
</td> |
| 670 |
<td>::</td> |
| 671 |
<td><strong>string</strong></td> |
| 672 |
<td> |
| 673 |
|
| 674 |
</td> |
| 675 |
</tr> |
| 676 |
<tr> |
| 677 |
<td> |
| 678 |
<span class="anchor" id="variable-prefix"></span> |
| 679 |
character(len=*), |
| 680 |
</td> |
| 681 |
<td>intent(in),</td> |
| 682 |
<td>optional</td> <td> |
| 683 |
|
| 684 |
</td> |
| 685 |
<td>::</td> |
| 686 |
<td><strong>prefix</strong></td> |
| 687 |
<td> |
| 688 |
|
| 689 |
</td> |
| 690 |
</tr> |
| 691 |
<tr> |
| 692 |
<td> |
| 693 |
<span class="anchor" id="variable-ierr"></span> |
| 694 |
integer, |
| 695 |
</td> |
| 696 |
<td>intent(out),</td> |
| 697 |
<td>optional</td> <td> |
| 698 |
|
| 699 |
</td> |
| 700 |
<td>::</td> |
| 701 |
<td><strong>ierr</strong></td> |
| 702 |
<td> |
| 703 |
|
| 704 |
</td> |
| 705 |
</tr> |
| 706 |
<tr> |
| 707 |
<td> |
| 708 |
<span class="anchor" id="variable-errmsg"></span> |
| 709 |
character(len=:), |
| 710 |
</td> |
| 711 |
<td>intent(out),</td> |
| 712 |
<td>optional,</td> <td> |
| 713 |
allocatable |
| 714 |
</td> |
| 715 |
<td>::</td> |
| 716 |
<td><strong>errmsg</strong></td> |
| 717 |
<td> |
| 718 |
|
| 719 |
</td> |
| 720 |
</tr> |
| 721 |
</tbody> |
| 722 |
</table> |
| 723 |
|
| 724 |
<br> |
| 725 |
|
| 726 |
<section class="visible-xs visible-sm hidden-md"> |
| 727 |
<h3>Contents</h3> |
| 728 |
|
| 729 |
|
| 730 |
|
| 731 |
|
| 732 |
|
| 733 |
|
| 734 |
|
| 735 |
|
| 736 |
|
| 737 |
|
| 738 |
|
| 739 |
|
| 740 |
|
| 741 |
|
| 742 |
|
| 743 |
|
| 744 |
|
| 745 |
|
| 746 |
|
| 747 |
<div class="panel panel-primary"> |
| 748 |
<div class="panel-heading text-left"><h3 class="panel-title">Source Code</h3></div> |
| 749 |
<div class="list-group"> |
| 750 |
<a class="list-group-item" href="../proc/set_args.html#src">set_args</a> |
| 751 |
</div> |
| 752 |
</div> |
| 753 |
|
| 754 |
|
| 755 |
</section> |
| 756 |
<br class="visible-xs visible-sm hidden-md"> |
| 757 |
|
| 758 |
|
| 759 |
|
| 760 |
|
| 761 |
|
| 762 |
|
| 763 |
|
| 764 |
|
| 765 |
|
| 766 |
|
| 767 |
<section> |
| 768 |
<h2><span class="anchor" id="src"></span>Source Code</h2> |
| 769 |
<div class="highlight"><pre><span></span><span class="k">subroutine </span><span class="n">set_args</span><span class="p">(</span><span class="n">prototype</span><span class="p">,</span><span class="n">help_text</span><span class="p">,</span><span class="n">version_text</span><span class="p">,</span><span class="n">string</span><span class="p">,</span><span class="n">prefix</span><span class="p">,</span><span class="n">ierr</span><span class="p">,</span><span class="n">errmsg</span><span class="p">)</span><span class="w"></span> |
| 770 |
|
| 771 |
<span class="c">! ident_1="@(#) M_CLI2 set_args(3f) parse prototype string"</span> |
| 772 |
|
| 773 |
<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">intent</span><span class="p">(</span><span class="n">in</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">prototype</span><span class="w"></span> |
| 774 |
<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">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</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> |
| 775 |
<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">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">version_text</span><span class="p">(:)</span><span class="w"></span> |
| 776 |
<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">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">string</span><span class="w"></span> |
| 777 |
<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">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">prefix</span><span class="w"></span> |
| 778 |
<span class="kt">integer</span><span class="p">,</span><span class="k">intent</span><span class="p">(</span><span class="n">out</span><span class="p">),</span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">ierr</span><span class="w"></span> |
| 779 |
<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">intent</span><span class="p">(</span><span class="n">out</span><span class="p">),</span><span class="k">allocatable</span><span class="p">,</span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">errmsg</span><span class="w"></span> |
| 780 |
<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">hold</span><span class="w"> </span><span class="c">! stores command line argument</span> |
| 781 |
<span class="kt">integer</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">ibig</span><span class="w"></span> |
| 782 |
<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">debug_mode</span><span class="w"></span> |
| 783 |
|
| 784 |
<span class="w"> </span><span class="n">debug_mode</span><span class="o">=</span><span class="w"> </span><span class="n">upper</span><span class="p">(</span><span class="n">get_env</span><span class="p">(</span><span class="s1">'CLI_DEBUG_MODE'</span><span class="p">,</span><span class="s1">'FALSE'</span><span class="p">))</span><span class="o">//</span><span class="s1">' '</span><span class="w"></span> |
| 785 |
<span class="w"> </span><span class="k">select case</span><span class="p">(</span><span class="n">debug_mode</span><span class="p">(</span><span class="mi">1</span><span class="p">:</span><span class="mi">1</span><span class="p">))</span><span class="w"></span> |
| 786 |
<span class="w"> </span><span class="k">case</span><span class="p">(</span><span class="s1">'Y'</span><span class="p">,</span><span class="s1">'T'</span><span class="p">)</span><span class="w"></span> |
| 787 |
<span class="w"> </span><span class="n">G_DEBUG</span><span class="o">=</span><span class="p">.</span><span class="n">true</span><span class="p">.</span><span class="w"></span> |
| 788 |
<span class="w"> </span><span class="k">end select</span> |
| 789 |
|
| 790 |
<span class="k"> </span><span class="n">G_response</span><span class="o">=</span><span class="n">CLI_RESPONSE_FILE</span><span class="w"></span> |
| 791 |
<span class="w"> </span><span class="n">G_options_only</span><span class="o">=</span><span class="p">.</span><span class="n">false</span><span class="p">.</span><span class="w"></span> |
| 792 |
<span class="w"> </span><span class="n">G_passed_in</span><span class="o">=</span><span class="s1">''</span><span class="w"></span> |
| 793 |
<span class="w"> </span><span class="n">G_STOP</span><span class="o">=</span><span class="mi">0</span><span class="w"></span> |
| 794 |
<span class="w"> </span><span class="n">G_STOP_MESSAGE</span><span class="o">=</span><span class="s1">''</span><span class="w"></span> |
| 795 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">present</span><span class="p">(</span><span class="n">prefix</span><span class="p">))</span><span class="k">then</span> |
| 796 |
<span class="k"> </span><span class="n">G_PREFIX</span><span class="o">=</span><span class="n">prefix</span><span class="w"></span> |
| 797 |
<span class="w"> </span><span class="k">else</span> |
| 798 |
<span class="k"> </span><span class="n">G_PREFIX</span><span class="o">=</span><span class="s1">''</span><span class="w"></span> |
| 799 |
<span class="w"> </span><span class="k">endif</span> |
| 800 |
<span class="k"> if</span><span class="p">(</span><span class="nb">present</span><span class="p">(</span><span class="n">ierr</span><span class="p">))</span><span class="k">then</span> |
| 801 |
<span class="k"> </span><span class="n">G_QUIET</span><span class="o">=</span><span class="p">.</span><span class="n">true</span><span class="p">.</span><span class="w"></span> |
| 802 |
<span class="w"> </span><span class="k">else</span> |
| 803 |
<span class="k"> </span><span class="n">G_QUIET</span><span class="o">=</span><span class="p">.</span><span class="n">false</span><span class="p">.</span><span class="w"></span> |
| 804 |
<span class="w"> </span><span class="k">endif</span> |
| 805 |
<span class="k"> </span><span class="n">ibig</span><span class="o">=</span><span class="n">longest_command_argument</span><span class="p">()</span><span class="w"> </span><span class="c">! bug in gfortran. len=0 should be fine</span> |
| 806 |
<span class="w"> </span><span class="k">IF</span><span class="p">(</span><span class="nb">ALLOCATED</span><span class="p">(</span><span class="n">UNNAMED</span><span class="p">))</span><span class="w"> </span><span class="k">DEALLOCATE</span><span class="p">(</span><span class="n">UNNAMED</span><span class="p">)</span><span class="w"></span> |
| 807 |
<span class="w"> </span><span class="k">ALLOCATE</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="n">IBIG</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">UNNAMED</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span><span class="w"></span> |
| 808 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">allocated</span><span class="p">(</span><span class="n">args</span><span class="p">))</span><span class="w"> </span><span class="k">deallocate</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="w"></span> |
| 809 |
<span class="w"> </span><span class="k">allocate</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="n">ibig</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">args</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span><span class="w"></span> |
| 810 |
|
| 811 |
<span class="w"> </span><span class="k">call </span><span class="n">wipe_dictionary</span><span class="p">()</span><span class="w"></span> |
| 812 |
<span class="w"> </span><span class="n">hold</span><span class="o">=</span><span class="s1">'--version F --usage F --help F --version F '</span><span class="o">//</span><span class="nb">adjustl</span><span class="p">(</span><span class="n">prototype</span><span class="p">)</span><span class="w"></span> |
| 813 |
<span class="w"> </span><span class="k">call </span><span class="n">prototype_and_cmd_args_to_nlist</span><span class="p">(</span><span class="n">hold</span><span class="p">,</span><span class="n">string</span><span class="p">)</span><span class="w"></span> |
| 814 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">allocated</span><span class="p">(</span><span class="n">G_RESPONSE_IGNORED</span><span class="p">))</span><span class="k">then</span> |
| 815 |
<span class="k"> if</span><span class="p">(</span><span class="n">G_DEBUG</span><span class="p">)</span><span class="k">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="n">gen</span><span class="p">)</span><span class="s1">'<DEBUG>SET_ARGS:G_RESPONSE_IGNORED:'</span><span class="p">,</span><span class="n">G_RESPONSE_IGNORED</span><span class="w"></span> |
| 816 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="n">size</span><span class="p">(</span><span class="n">unnamed</span><span class="p">)</span><span class="w"> </span><span class="o">/=</span><span class="w"> </span><span class="mi">0</span><span class="p">)</span><span class="k">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="o">*</span><span class="p">)</span><span class="s1">'LOGIC ERROR'</span><span class="w"></span> |
| 817 |
<span class="w"> </span><span class="k">call </span><span class="n">split</span><span class="p">(</span><span class="n">G_RESPONSE_IGNORED</span><span class="p">,</span><span class="n">unnamed</span><span class="p">)</span><span class="w"></span> |
| 818 |
<span class="w"> </span><span class="k">endif</span> |
| 819 |
|
| 820 |
<span class="k"> if</span><span class="p">(.</span><span class="nb">not</span><span class="p">.</span><span class="nb">allocated</span><span class="p">(</span><span class="n">unnamed</span><span class="p">))</span><span class="k">then</span> |
| 821 |
<span class="k"> allocate</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">0</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">unnamed</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span><span class="w"></span> |
| 822 |
<span class="w"> </span><span class="k">endif</span> |
| 823 |
<span class="k"> if</span><span class="p">(.</span><span class="nb">not</span><span class="p">.</span><span class="nb">allocated</span><span class="p">(</span><span class="n">args</span><span class="p">))</span><span class="k">then</span> |
| 824 |
<span class="k"> allocate</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">0</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">args</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span><span class="w"></span> |
| 825 |
<span class="w"> </span><span class="k">endif</span> |
| 826 |
<span class="k"> call </span><span class="n">check_commandline</span><span class="p">(</span><span class="n">help_text</span><span class="p">,</span><span class="n">version_text</span><span class="p">)</span><span class="w"> </span><span class="c">! process --help, --version, --usage</span> |
| 827 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">present</span><span class="p">(</span><span class="n">ierr</span><span class="p">))</span><span class="k">then</span> |
| 828 |
<span class="k"> </span><span class="n">ierr</span><span class="o">=</span><span class="n">G_STOP</span><span class="w"></span> |
| 829 |
<span class="w"> </span><span class="k">endif</span> |
| 830 |
<span class="k"> if</span><span class="p">(</span><span class="nb">present</span><span class="p">(</span><span class="n">errmsg</span><span class="p">))</span><span class="k">then</span> |
| 831 |
<span class="k"> </span><span class="n">errmsg</span><span class="o">=</span><span class="n">G_STOP_MESSAGE</span><span class="w"></span> |
| 832 |
<span class="w"> </span><span class="k">endif</span> |
| 833 |
<span class="k">end subroutine </span><span class="n">set_args</span><span class="w"></span> |
| 834 |
</pre></div> |
| 835 |
|
| 836 |
</section> |
| 837 |
<br> |
| 838 |
|
| 839 |
</div> |
| 840 |
</div> |
| 841 |
|
| 842 |
<hr> |
| 843 |
</div> <!-- /container --> |
| 844 |
<footer> |
| 845 |
<div class="container"> |
| 846 |
<div class="row"> |
| 847 |
<div class="col-xs-6 col-md-6"><p>M_CLI2 was developed by John S. Urban<br>© 2023 |
| 848 |
</p> |
| 849 |
</div> |
| 850 |
<div class="col-xs-6 col-md-6"> |
| 851 |
<p class="text-right"> |
| 852 |
Documentation generated by |
| 853 |
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a> |
| 854 |
on 2023-02-10 18:53 </p> |
| 855 |
</div> |
| 856 |
</div> |
| 857 |
<br> |
| 858 |
</div> <!-- /container --> |
| 859 |
</footer> |
| 860 |
|
| 861 |
<!-- Bootstrap core JavaScript |
| 862 |
================================================== --> |
| 863 |
<!-- Placed at the end of the document so the pages load faster --> |
| 864 |
<!-- |
| 865 |
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script> |
| 866 |
--> |
| 867 |
<script src="../js/bootstrap.min.js"></script> |
| 868 |
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> |
| 869 |
<script src="../js/ie10-viewport-bug-workaround.js"></script> |
| 870 |
|
| 871 |
<!-- MathJax JavaScript |
| 872 |
================================================== --> |
| 873 |
<!-- Placed at the end of the document so the pages load faster --> |
| 874 |
<script type="text/x-mathjax-config"> |
| 875 |
MathJax.Hub.Config({ |
| 876 |
TeX: { extensions: ['AMSmath.js','AMSsymbols.js','noErrors.js','noUndefined.js'], equationNumbers: { autoNumber: 'AMS' } }, |
| 877 |
jax: ['input/TeX','input/MathML','output/HTML-CSS'], |
| 878 |
extensions: ['tex2jax.js','mml2jax.js','MathMenu.js','MathZoom.js'] |
| 879 |
}); |
| 880 |
</script> |
| 881 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| 882 |
|
| 883 |
<script src="../tipuesearch/tipuesearch_content.js"></script> |
| 884 |
<script src="../tipuesearch/tipuesearch_set.js"></script> |
| 885 |
<script src="../tipuesearch/tipuesearch.js"></script> |
| 886 |
|
| 887 |
</body> |
| 888 |
</html> |