| 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>get_subcommand – 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>get_subcommand |
| 82 |
<small>Function</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="12.3% of total for procedures.">47 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">get_subcommand</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/get_subcommand.html#src">get_subcommand</a> |
| 144 |
</div> |
| 145 |
</div> |
| 146 |
|
| 147 |
|
| 148 |
</div> |
| 149 |
|
| 150 |
</div> |
| 151 |
|
| 152 |
<div class="col-md-9" id='text'> |
| 153 |
<h2>public function get_subcommand() result(sub) |
| 154 |
</h2> |
| 155 |
|
| 156 |
|
| 157 |
<h2 id="name">NAME</h2> |
| 158 |
<div class="codehilite"><pre><span></span><code><span class="nv">get_subcommand</span><span class="ss">(</span><span class="mi">3</span><span class="nv">f</span><span class="ss">)</span> <span class="o">-</span> [<span class="nv">ARGUMENTS</span>:<span class="nv">M_CLI2</span>] <span class="nv">special</span><span class="o">-</span><span class="nv">case</span> <span class="nv">routine</span> <span class="k">for</span> |
| 159 |
<span class="nv">handling</span> <span class="nv">subcommands</span> <span class="nv">on</span> <span class="nv">a</span> <span class="nv">command</span> <span class="nv">line</span> |
| 160 |
<span class="ss">(</span><span class="nv">LICENSE</span>:<span class="nv">PD</span><span class="ss">)</span> |
| 161 |
</code></pre></div> |
| 162 |
|
| 163 |
<h2 id="synopsis">SYNOPSIS</h2> |
| 164 |
<div class="codehilite"><pre><span></span><code><span class="k">function</span><span class="w"> </span><span class="nf">get_subcommand</span><span class="p">()</span><span class="w"></span> |
| 165 |
|
| 166 |
<span class="w"> </span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=:),</span><span class="n">allocatable</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="n">get_subcommand</span><span class="w"></span> |
| 167 |
</code></pre></div> |
| 168 |
|
| 169 |
<h2 id="description">DESCRIPTION</h2> |
| 170 |
<div class="codehilite"><pre><span></span><code>In the special case when creating a program with subcommands it |
| 171 |
is assumed the first word on the command line is the subcommand. A |
| 172 |
routine is required to handle response file processing, therefore |
| 173 |
this routine (optionally processing response files) returns that |
| 174 |
first word as the subcommand name. |
| 175 |
|
| 176 |
It should not be used by programs not building a more elaborate |
| 177 |
command with subcommands. |
| 178 |
</code></pre></div> |
| 179 |
|
| 180 |
<h2 id="returns">RETURNS</h2> |
| 181 |
<div class="codehilite"><pre><span></span><code>NAME name of subcommand |
| 182 |
</code></pre></div> |
| 183 |
|
| 184 |
<h2 id="example">EXAMPLE</h2> |
| 185 |
<p>Sample program:</p> |
| 186 |
<div class="codehilite"><pre><span></span><code><span class="n">program</span><span class="w"> </span><span class="s">demo_get_subcommand</span><span class="w"></span> |
| 187 |
<span class="sx">!x! SUBCOMMANDS</span><span class="w"></span> |
| 188 |
<span class="sx">!x! For a command with subcommands like git(1)</span><span class="w"></span> |
| 189 |
<span class="sx">!x! you can make separate namelists for each subcommand.</span><span class="w"></span> |
| 190 |
<span class="sx">!x! You can call this program which has two subcommands (run, test),</span><span class="w"></span> |
| 191 |
<span class="sx">!x! like this:</span><span class="w"></span> |
| 192 |
<span class="sx">!x! demo_get_subcommand --help</span><span class="w"></span> |
| 193 |
<span class="sx">!x! demo_get_subcommand run -x -y -z --title -l -L</span><span class="w"></span> |
| 194 |
<span class="sx">!x! demo_get_subcommand test --title -l -L --testname</span><span class="w"></span> |
| 195 |
<span class="sx">!x! demo_get_subcommand run --help</span><span class="w"></span> |
| 196 |
<span class="w"> </span><span class="n">implicit</span><span class="w"> </span><span class="n">none</span><span class="w"></span> |
| 197 |
<span class="sx">!x! DEFINE VALUES TO USE AS ARGUMENTS WITH INITIAL VALUES</span><span class="w"></span> |
| 198 |
<span class="w"> </span><span class="nb">real</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="n">x</span><span class="p">=</span><span class="o">-</span><span class="mf">999.0</span><span class="p">,</span><span class="n">y</span><span class="p">=</span><span class="o">-</span><span class="mf">999.0</span><span class="p">,</span><span class="n">z</span><span class="p">=</span><span class="o">-</span><span class="mf">999.0</span><span class="w"></span> |
| 199 |
<span class="w"> </span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</span><span class="p">)</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="nb">title</span><span class="p">=</span><span class="s">"not set"</span><span class="w"></span> |
| 200 |
<span class="w"> </span><span class="nb">logical</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="n">l</span><span class="p">=.</span><span class="n">false</span><span class="p">.</span><span class="w"></span> |
| 201 |
<span class="w"> </span><span class="nb">logical</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="n">l_</span><span class="p">=.</span><span class="n">false</span><span class="p">.</span><span class="w"></span> |
| 202 |
<span class="w"> </span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</span><span class="p">)</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="n">testname</span><span class="p">=</span><span class="s">"not set"</span><span class="w"></span> |
| 203 |
<span class="w"> </span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">20</span><span class="p">)</span><span class="w"> </span><span class="p">::</span><span class="w"> </span><span class="n">name</span><span class="w"></span> |
| 204 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">parse</span><span class="p">(</span><span class="n">name</span><span class="p">)</span><span class="w"> </span>!<span class="n">x</span>!<span class="w"> </span><span class="n">DEFINE</span><span class="w"> </span><span class="n">AND</span><span class="w"> </span><span class="n">PARSE</span><span class="w"> </span><span class="n">COMMAND</span><span class="w"> </span><span class="n">LINE</span><span class="w"></span> |
| 205 |
<span class="w"> </span>!<span class="n">x</span>!<span class="w"> </span><span class="n">ALL</span><span class="w"> </span><span class="n">DONE</span><span class="w"> </span><span class="n">CRACKING</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> |
| 206 |
<span class="w"> </span>!<span class="n">x</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">VALUES</span><span class="w"> </span><span class="n">IN</span><span class="w"> </span><span class="n">YOUR</span><span class="w"> </span><span class="n">PROGRAM</span><span class="p">.</span><span class="w"></span> |
| 207 |
<span class="w"> </span><span class="nb">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="o">*</span><span class="p">)</span><span class="o">'</span><span class="n">command</span><span class="w"> </span><span class="n">was</span><span class="w"> </span><span class="s">',name</span> |
| 208 |
<span class="s"> write(*,*)'</span><span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">,</span><span class="n">z</span><span class="w"> </span><span class="k">...</span><span class="c">. ',x,y,z</span><span class="w"></span> |
| 209 |
<span class="w"> </span><span class="nb">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="o">*</span><span class="p">)</span><span class="o">'</span><span class="nb">title</span><span class="w"> </span><span class="k">...</span><span class="c">. ',title</span><span class="w"></span> |
| 210 |
<span class="w"> </span><span class="nb">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="o">*</span><span class="p">)</span><span class="o">'</span><span class="n">l</span><span class="p">,</span><span class="n">l_</span><span class="w"> </span><span class="k">...</span><span class="c">.. ',l,l_</span><span class="w"></span> |
| 211 |
<span class="w"> </span><span class="nb">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="o">*</span><span class="p">)</span><span class="o">'</span><span class="n">testname</span><span class="w"> </span><span class="p">.</span><span class="w"> </span><span class="s">',testname</span> |
| 212 |
<span class="s">contains</span> |
| 213 |
<span class="s">subroutine parse(name)</span> |
| 214 |
<span class="s">!x! PUT EVERYTHING TO DO WITH COMMAND PARSING HERE FOR CLARITY</span> |
| 215 |
<span class="s">use M_CLI2, only : set_args, get_args, get_args_fixed_length</span> |
| 216 |
<span class="s">use M_CLI2, only : get_subcommand, set_mode</span> |
| 217 |
<span class="s">character(len=*) :: name ! the subcommand name</span> |
| 218 |
<span class="s">character(len=:),allocatable :: help_text(:), version_text(:)</span> |
| 219 |
<span class="s"> call set_mode('</span><span class="n">response_file</span><span class="o">'</span><span class="p">)</span><span class="w"></span> |
| 220 |
<span class="sx">! define version text</span><span class="w"></span> |
| 221 |
<span class="w"> </span><span class="n">version_text</span><span class="p">=[</span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</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> |
| 222 |
<span class="w"> </span><span class="s">'@(#)PROGRAM: demo_get_subcommand >'</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 223 |
<span class="w"> </span><span class="s">'@(#)DESCRIPTION: My demo program >'</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 224 |
<span class="w"> </span><span class="s">'@(#)VERSION: 1.0 20200715 >'</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 225 |
<span class="w"> </span><span class="s">'@(#)AUTHOR: me, myself, and I>'</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 226 |
<span class="w"> </span><span class="s">'@(#)LICENSE: Public Domain >'</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 227 |
<span class="w"> </span><span class="s">''</span><span class="w"> </span><span class="p">]</span><span class="w"></span> |
| 228 |
<span class="w"> </span>!<span class="w"> </span><span class="n">general</span><span class="w"> </span><span class="nb">help</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="s">"demo_get_subcommand --help"</span><span class="w"></span> |
| 229 |
<span class="w"> </span><span class="n">help_text</span><span class="p">=[</span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</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> |
| 230 |
<span class="w"> </span><span class="s">' allowed subcommands are '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 231 |
<span class="w"> </span><span class="s">' * run -l -L --title -x -y -z '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 232 |
<span class="w"> </span><span class="s">' * test -l -L --title '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 233 |
<span class="w"> </span><span class="s">''</span><span class="w"> </span><span class="p">]</span><span class="w"></span> |
| 234 |
<span class="w"> </span>!<span class="w"> </span><span class="nb">find</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">subcommand</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="n">looking</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">first</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="n">on</span><span class="w"> </span><span class="n">command</span><span class="w"></span> |
| 235 |
<span class="w"> </span>!<span class="w"> </span><span class="n">not</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">dash</span><span class="w"></span> |
| 236 |
<span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">get_subcommand</span><span class="p">()</span><span class="w"></span> |
| 237 |
<span class="w"> </span><span class="n">select</span><span class="w"> </span><span class="k">case</span><span class="p">(</span><span class="n">name</span><span class="p">)</span><span class="w"></span> |
| 238 |
<span class="w"> </span><span class="k">case</span><span class="p">(</span><span class="s">'run'</span><span class="p">)</span><span class="w"></span> |
| 239 |
<span class="w"> </span><span class="n">help_text</span><span class="p">=[</span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</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> |
| 240 |
<span class="w"> </span><span class="s">' '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 241 |
<span class="w"> </span><span class="s">' Help for subcommand "run" '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 242 |
<span class="w"> </span><span class="s">' '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 243 |
<span class="w"> </span><span class="s">''</span><span class="w"> </span><span class="p">]</span><span class="w"></span> |
| 244 |
<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="w"> </span><span class="o">&</span><span class="w"></span> |
| 245 |
<span class="w"> </span><span class="o">&</span><span class="w"> </span><span class="s">'-x 1 -y 2 -z 3 --title "my title" -l F -L F'</span><span class="p">,</span><span class="o">&</span><span class="w"></span> |
| 246 |
<span class="w"> </span><span class="o">&</span><span class="w"> </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> |
| 247 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'x'</span><span class="p">,</span><span class="n">x</span><span class="p">)</span><span class="w"></span> |
| 248 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'y'</span><span class="p">,</span><span class="n">y</span><span class="p">)</span><span class="w"></span> |
| 249 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'z'</span><span class="p">,</span><span class="n">z</span><span class="p">)</span><span class="w"></span> |
| 250 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args_fixed_length</span><span class="p">(</span><span class="s">'title'</span><span class="p">,</span><span class="nb">title</span><span class="p">)</span><span class="w"></span> |
| 251 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'l'</span><span class="p">,</span><span class="n">l</span><span class="p">)</span><span class="w"></span> |
| 252 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'L'</span><span class="p">,</span><span class="n">l_</span><span class="p">)</span><span class="w"></span> |
| 253 |
<span class="w"> </span><span class="k">case</span><span class="p">(</span><span class="s">'test'</span><span class="p">)</span><span class="w"></span> |
| 254 |
<span class="w"> </span><span class="n">help_text</span><span class="p">=[</span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</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> |
| 255 |
<span class="w"> </span><span class="s">' '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 256 |
<span class="w"> </span><span class="s">' Help for subcommand "test" '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 257 |
<span class="w"> </span><span class="s">' '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 258 |
<span class="w"> </span><span class="s">''</span><span class="w"> </span><span class="p">]</span><span class="w"></span> |
| 259 |
<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="o">&</span><span class="w"></span> |
| 260 |
<span class="w"> </span><span class="o">&</span><span class="w"> </span><span class="s">'--title "my title" -l F -L F --testname "Test"'</span><span class="p">,</span><span class="o">&</span><span class="w"></span> |
| 261 |
<span class="w"> </span><span class="o">&</span><span class="w"> </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> |
| 262 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args_fixed_length</span><span class="p">(</span><span class="s">'title'</span><span class="p">,</span><span class="nb">title</span><span class="p">)</span><span class="w"></span> |
| 263 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'l'</span><span class="p">,</span><span class="n">l</span><span class="p">)</span><span class="w"></span> |
| 264 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args</span><span class="p">(</span><span class="s">'L'</span><span class="p">,</span><span class="n">l_</span><span class="p">)</span><span class="w"></span> |
| 265 |
<span class="w"> </span><span class="n">call</span><span class="w"> </span><span class="n">get_args_fixed_length</span><span class="p">(</span><span class="s">'testname'</span><span class="p">,</span><span class="n">testname</span><span class="p">)</span><span class="w"></span> |
| 266 |
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">default</span><span class="w"></span> |
| 267 |
<span class="w"> </span>!<span class="w"> </span><span class="n">process</span><span class="w"> </span><span class="nb">help</span><span class="w"> </span><span class="n">and</span><span class="w"> </span><span class="nb">version</span><span class="w"></span> |
| 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="s">' '</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> |
| 269 |
<span class="w"> </span><span class="nb">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="s">'(*(a))'</span><span class="p">)</span><span class="o">'</span><span class="n">unknown</span><span class="w"> </span><span class="n">or</span><span class="w"> </span><span class="nb">missing</span><span class="w"> </span><span class="n">subcommand</span><span class="w"> </span><span class="p">[</span><span class="s">',trim(name),'</span><span class="p">]</span><span class="o">'</span><span class="w"></span> |
| 270 |
<span class="w"> </span><span class="nb">write</span><span class="p">(</span><span class="o">*</span><span class="p">,</span><span class="s">'(a)'</span><span class="p">)[</span><span class="n">character</span><span class="p">(</span><span class="n">len</span><span class="p">=</span><span class="mi">80</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> |
| 271 |
<span class="w"> </span><span class="s">' allowed subcommands are '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 272 |
<span class="w"> </span><span class="s">' * run -l -L -title -x -y -z '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 273 |
<span class="w"> </span><span class="s">' * test -l -L -title '</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="w"></span> |
| 274 |
<span class="w"> </span><span class="s">''</span><span class="w"> </span><span class="p">]</span><span class="w"></span> |
| 275 |
<span class="w"> </span><span class="nb">stop</span><span class="w"></span> |
| 276 |
<span class="w"> </span><span class="k">end</span><span class="w"> </span><span class="n">select</span><span class="w"></span> |
| 277 |
<span class="k">end</span><span class="w"> </span><span class="n">subroutine</span><span class="w"> </span><span class="n">parse</span><span class="w"></span> |
| 278 |
<span class="k">end</span><span class="w"> </span><span class="n">program</span><span class="w"> </span><span class="n">demo_get_subcommand</span><span class="w"></span> |
| 279 |
</code></pre></div> |
| 280 |
|
| 281 |
<h2 id="author">AUTHOR</h2> |
| 282 |
<div class="codehilite"><pre><span></span><code> John S. Urban, 2019 |
| 283 |
</code></pre></div> |
| 284 |
|
| 285 |
<h2 id="license">LICENSE</h2> |
| 286 |
<div class="codehilite"><pre><span></span><code> Public Domain |
| 287 |
</code></pre></div> |
| 288 |
|
| 289 |
<h3>Arguments</h3> |
| 290 |
<em>None</em> |
| 291 |
<br> |
| 292 |
<h3>Return Value |
| 293 |
<small> |
| 294 |
<span class="anchor" id="variable-sub"></span> |
| 295 |
character(len=:), allocatable |
| 296 |
</small> |
| 297 |
</h3> |
| 298 |
|
| 299 |
<br> |
| 300 |
|
| 301 |
<section class="visible-xs visible-sm hidden-md"> |
| 302 |
<h3>Contents</h3> |
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 |
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
<div class="panel panel-primary"> |
| 323 |
<div class="panel-heading text-left"><h3 class="panel-title">Source Code</h3></div> |
| 324 |
<div class="list-group"> |
| 325 |
<a class="list-group-item" href="../proc/get_subcommand.html#src">get_subcommand</a> |
| 326 |
</div> |
| 327 |
</div> |
| 328 |
|
| 329 |
|
| 330 |
</section> |
| 331 |
<br class="visible-xs visible-sm hidden-md"> |
| 332 |
|
| 333 |
|
| 334 |
|
| 335 |
|
| 336 |
|
| 337 |
|
| 338 |
|
| 339 |
|
| 340 |
|
| 341 |
|
| 342 |
<section> |
| 343 |
<h2><span class="anchor" id="src"></span>Source Code</h2> |
| 344 |
<div class="highlight"><pre><span></span><span class="k">function </span><span class="n">get_subcommand</span><span class="p">()</span><span class="w"> </span><span class="k">result</span><span class="p">(</span><span class="n">sub</span><span class="p">)</span><span class="w"></span> |
| 345 |
|
| 346 |
<span class="c">! ident_2="@(#) M_CLI2 get_subcommand(3f) parse prototype string to get subcommand allowing for response files"</span> |
| 347 |
|
| 348 |
<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">sub</span><span class="w"></span> |
| 349 |
<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">cmdarg</span><span class="w"></span> |
| 350 |
<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="k">array</span><span class="p">(:)</span><span class="w"></span> |
| 351 |
<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">prototype</span><span class="w"></span> |
| 352 |
<span class="kt">integer</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">ilongest</span><span class="w"></span> |
| 353 |
<span class="kt">integer</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">i</span><span class="w"></span> |
| 354 |
<span class="kt">integer</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">j</span><span class="w"></span> |
| 355 |
<span class="w"> </span><span class="n">G_subcommand</span><span class="o">=</span><span class="s1">''</span><span class="w"></span> |
| 356 |
<span class="w"> </span><span class="n">G_options_only</span><span class="o">=</span><span class="p">.</span><span class="n">true</span><span class="p">.</span><span class="w"></span> |
| 357 |
<span class="w"> </span><span class="n">sub</span><span class="o">=</span><span class="s1">''</span><span class="w"></span> |
| 358 |
|
| 359 |
<span class="w"> </span><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> |
| 360 |
<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> |
| 361 |
<span class="w"> </span><span class="k">endif</span> |
| 362 |
|
| 363 |
<span class="k"> </span><span class="n">ilongest</span><span class="o">=</span><span class="n">longest_command_argument</span><span class="p">()</span><span class="w"></span> |
| 364 |
<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="nb">max</span><span class="p">(</span><span class="mi">63</span><span class="p">,</span><span class="n">ilongest</span><span class="p">))</span><span class="kd">::</span><span class="w"> </span><span class="n">cmdarg</span><span class="p">)</span><span class="w"></span> |
| 365 |
<span class="w"> </span><span class="n">cmdarg</span><span class="p">(:)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">''</span><span class="w"></span> |
| 366 |
<span class="w"> </span><span class="c">! look for @NAME if CLI_RESPONSE_FILE=.TRUE. AND LOAD THEM</span> |
| 367 |
<span class="w"> </span><span class="k">do </span><span class="n">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">command_argument_count</span><span class="p">()</span><span class="w"></span> |
| 368 |
<span class="w"> </span><span class="k">call </span><span class="nb">get_command_argument</span><span class="p">(</span><span class="n">i</span><span class="p">,</span><span class="w"> </span><span class="n">cmdarg</span><span class="p">)</span><span class="w"></span> |
| 369 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">scan</span><span class="p">(</span><span class="nb">adjustl</span><span class="p">(</span><span class="n">cmdarg</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="s1">'@'</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">1</span><span class="p">)</span><span class="k">then</span> |
| 370 |
<span class="k"> call </span><span class="n">get_prototype</span><span class="p">(</span><span class="n">cmdarg</span><span class="p">,</span><span class="n">prototype</span><span class="p">)</span><span class="w"></span> |
| 371 |
<span class="w"> </span><span class="k">call </span><span class="n">split</span><span class="p">(</span><span class="n">prototype</span><span class="p">,</span><span class="k">array</span><span class="p">)</span><span class="w"></span> |
| 372 |
<span class="w"> </span><span class="c">! assume that if using subcommands first word not starting with dash is the subcommand</span> |
| 373 |
<span class="w"> </span><span class="k">do </span><span class="n">j</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span><span class="n">size</span><span class="p">(</span><span class="k">array</span><span class="p">)</span><span class="w"></span> |
| 374 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">adjustl</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="n">j</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><span class="o">/=</span><span class="w"> </span><span class="s1">'-'</span><span class="p">)</span><span class="k">then</span> |
| 375 |
<span class="k"> </span><span class="n">G_subcommand</span><span class="o">=</span><span class="nb">trim</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="n">j</span><span class="p">))</span><span class="w"></span> |
| 376 |
<span class="w"> </span><span class="n">sub</span><span class="o">=</span><span class="n">G_subcommand</span><span class="w"></span> |
| 377 |
<span class="w"> </span><span class="k">exit</span> |
| 378 |
<span class="k"> endif</span> |
| 379 |
<span class="k"> enddo</span> |
| 380 |
<span class="k"> endif</span> |
| 381 |
<span class="k"> enddo</span> |
| 382 |
|
| 383 |
<span class="k"> if</span><span class="p">(</span><span class="n">G_subcommand</span><span class="w"> </span><span class="o">/=</span><span class="w"> </span><span class="s1">''</span><span class="p">)</span><span class="k">then</span> |
| 384 |
<span class="k"> </span><span class="n">sub</span><span class="o">=</span><span class="n">G_subcommand</span><span class="w"></span> |
| 385 |
<span class="w"> </span><span class="n">elseif</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">then</span> |
| 386 |
<span class="k"> </span><span class="n">sub</span><span class="o">=</span><span class="n">unnamed</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"></span> |
| 387 |
<span class="w"> </span><span class="k">else</span> |
| 388 |
<span class="k"> </span><span class="n">cmdarg</span><span class="p">(:)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">''</span><span class="w"></span> |
| 389 |
<span class="w"> </span><span class="k">do </span><span class="n">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">command_argument_count</span><span class="p">()</span><span class="w"></span> |
| 390 |
<span class="w"> </span><span class="k">call </span><span class="nb">get_command_argument</span><span class="p">(</span><span class="n">i</span><span class="p">,</span><span class="w"> </span><span class="n">cmdarg</span><span class="p">)</span><span class="w"></span> |
| 391 |
<span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="nb">adjustl</span><span class="p">(</span><span class="n">cmdarg</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><span class="o">/=</span><span class="w"> </span><span class="s1">'-'</span><span class="p">)</span><span class="k">then</span> |
| 392 |
<span class="k"> </span><span class="n">sub</span><span class="o">=</span><span class="nb">trim</span><span class="p">(</span><span class="n">cmdarg</span><span class="p">)</span><span class="w"></span> |
| 393 |
<span class="w"> </span><span class="k">exit</span> |
| 394 |
<span class="k"> endif</span> |
| 395 |
<span class="k"> enddo</span> |
| 396 |
<span class="k"> endif</span> |
| 397 |
<span class="k"> </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> |
| 398 |
<span class="k">end function </span><span class="n">get_subcommand</span><span class="w"></span> |
| 399 |
</pre></div> |
| 400 |
|
| 401 |
</section> |
| 402 |
<br> |
| 403 |
|
| 404 |
</div> |
| 405 |
</div> |
| 406 |
|
| 407 |
<hr> |
| 408 |
</div> <!-- /container --> |
| 409 |
<footer> |
| 410 |
<div class="container"> |
| 411 |
<div class="row"> |
| 412 |
<div class="col-xs-6 col-md-6"><p>M_CLI2 was developed by John S. Urban<br>© 2023 |
| 413 |
</p> |
| 414 |
</div> |
| 415 |
<div class="col-xs-6 col-md-6"> |
| 416 |
<p class="text-right"> |
| 417 |
Documentation generated by |
| 418 |
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a> |
| 419 |
on 2023-02-10 18:53 </p> |
| 420 |
</div> |
| 421 |
</div> |
| 422 |
<br> |
| 423 |
</div> <!-- /container --> |
| 424 |
</footer> |
| 425 |
|
| 426 |
<!-- Bootstrap core JavaScript |
| 427 |
================================================== --> |
| 428 |
<!-- Placed at the end of the document so the pages load faster --> |
| 429 |
<!-- |
| 430 |
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script> |
| 431 |
--> |
| 432 |
<script src="../js/bootstrap.min.js"></script> |
| 433 |
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> |
| 434 |
<script src="../js/ie10-viewport-bug-workaround.js"></script> |
| 435 |
|
| 436 |
<!-- MathJax JavaScript |
| 437 |
================================================== --> |
| 438 |
<!-- Placed at the end of the document so the pages load faster --> |
| 439 |
<script type="text/x-mathjax-config"> |
| 440 |
MathJax.Hub.Config({ |
| 441 |
TeX: { extensions: ['AMSmath.js','AMSsymbols.js','noErrors.js','noUndefined.js'], equationNumbers: { autoNumber: 'AMS' } }, |
| 442 |
jax: ['input/TeX','input/MathML','output/HTML-CSS'], |
| 443 |
extensions: ['tex2jax.js','mml2jax.js','MathMenu.js','MathZoom.js'] |
| 444 |
}); |
| 445 |
</script> |
| 446 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| 447 |
|
| 448 |
<script src="../tipuesearch/tipuesearch_content.js"></script> |
| 449 |
<script src="../tipuesearch/tipuesearch_set.js"></script> |
| 450 |
<script src="../tipuesearch/tipuesearch.js"></script> |
| 451 |
|
| 452 |
</body> |
| 453 |
</html> |