civ/hot-step-cpp-ROCm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial release

Browse Source
This commit is contained in:
civ
2026-08-16 18:24:52 +07:00
commit 876886a39a
13244 changed files with 2353959 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
engine/vendor/vst3sdk/doc/basemodule/namespaceSteinberg_1_1CommandLine.html
Vendored
+292
View File
@@ -0,0 +1,292 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Base Module: Steinberg::CommandLine Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="smtg_extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Base Module<span id="projectnumber">&#160;VST 3.8</span>
</div>
<div id="projectbrief">SDK for developing VST plug-in</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespaceSteinberg_1_1CommandLine.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Steinberg::CommandLine Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Very simple command-line parser.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1CommandLine_1_1Description.html">Description</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The description of one single command-line option. <a href="classSteinberg_1_1CommandLine_1_1Description.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html">Descriptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of command-line option descriptions. <a href="classSteinberg_1_1CommandLine_1_1Descriptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html">VariablesMap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command-line parsing result. <a href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a8e4c7d85763c5d6cafd67588804308f4" id="r_a8e4c7d85763c5d6cafd67588804308f4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e4c7d85763c5d6cafd67588804308f4">FilesVector</a> = std::vector&lt;std::string&gt;</td></tr>
<tr class="memdesc:a8e4c7d85763c5d6cafd67588804308f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">type of the list of elements on the command line that are not handled by options parsing <br /></td></tr>
<tr class="separator:a8e4c7d85763c5d6cafd67588804308f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa59540066a0354da873325a175666974" id="r_aa59540066a0354da873325a175666974"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa59540066a0354da873325a175666974">parse</a> (int ac, char *av[], const <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html">Descriptions</a> &amp;desc, <a class="el" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html">VariablesMap</a> &amp;result, <a class="el" href="#a8e4c7d85763c5d6cafd67588804308f4">FilesVector</a> *files=nullptr)</td></tr>
<tr class="memdesc:aa59540066a0354da873325a175666974"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the command - line. <br /></td></tr>
<tr class="separator:aa59540066a0354da873325a175666974"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a38965238a994bf87587aac0b83a5be" id="r_a6a38965238a994bf87587aac0b83a5be"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6a38965238a994bf87587aac0b83a5be">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html">Descriptions</a> &amp;desc)</td></tr>
<tr class="memdesc:a6a38965238a994bf87587aac0b83a5be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html" title="List of command-line option descriptions.">Descriptions</a> stream able. <br /></td></tr>
<tr class="separator:a6a38965238a994bf87587aac0b83a5be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Very simple command-line parser. </p>
<p>Parses the command-line into a <a class="el" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html" title="Command-line parsing result.">CommandLine::VariablesMap</a>.<br />
The command-line parser uses <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html" title="List of command-line option descriptions.">CommandLine::Descriptions</a> to define the available options.</p>
<p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="fcommandline_8h.html">base/source/fcommandline.h</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[])</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">using namespace </span>std;</div>
<div class="line"> </div>
<div class="line"> <a class="code hl_class" href="classSteinberg_1_1CommandLine_1_1Descriptions.html">CommandLine::Descriptions</a> desc;</div>
<div class="line"> <a class="code hl_class" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html">CommandLine::VariablesMap</a> valueMap;</div>
<div class="line"> </div>
<div class="line"> desc.<a class="code hl_function" href="classSteinberg_1_1CommandLine_1_1Descriptions.html#ab27a3d9559b5d6fddcbeb9d1474fd349">addOptions</a> (<span class="stringliteral">&quot;myTool&quot;</span>)</div>
<div class="line"> (<span class="stringliteral">&quot;help&quot;</span>, <span class="stringliteral">&quot;produce help message&quot;</span>)</div>
<div class="line"> (<span class="stringliteral">&quot;opt1&quot;</span>, <span class="keywordtype">string</span>(), <span class="stringliteral">&quot;option 1&quot;</span>)</div>
<div class="line"> (<span class="stringliteral">&quot;opt2&quot;</span>, string(), <span class="stringliteral">&quot;option 2&quot;</span>)</div>
<div class="line"> ;</div>
<div class="line"> <a class="code hl_function" href="#aa59540066a0354da873325a175666974">CommandLine::parse</a> (argc, argv, desc, valueMap);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (valueMap.<a class="code hl_function" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#a81dd125e253592aaef5fea33dfc50c42">hasError</a> () || valueMap.<a class="code hl_function" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#aae1a1de067fae18405ef48dfbe0b3c00">count</a> (<span class="stringliteral">&quot;help&quot;</span>))</div>
<div class="line"> {</div>
<div class="line"> cout &lt;&lt; desc &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;</div>
<div class="line"> <span class="keywordflow">return</span> 1;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> (valueMap.<a class="code hl_function" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#aae1a1de067fae18405ef48dfbe0b3c00">count</a> (<span class="stringliteral">&quot;opt1&quot;</span>))</div>
<div class="line"> {</div>
<div class="line"> cout &lt;&lt; <span class="stringliteral">&quot;Value of option 1 &quot;</span> &lt;&lt; valueMap[<span class="stringliteral">&quot;opt1&quot;</span>] &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> (valueMap.<a class="code hl_function" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#aae1a1de067fae18405ef48dfbe0b3c00">count</a> (<span class="stringliteral">&quot;opt2&quot;</span>))</div>
<div class="line"> {</div>
<div class="line"> cout &lt;&lt; <span class="stringliteral">&quot;Value of option 2 &quot;</span> &lt;&lt; valueMap[<span class="stringliteral">&quot;opt2&quot;</span>] &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aclassSteinberg_1_1CommandLine_1_1Descriptions_html"><div class="ttname"><a href="classSteinberg_1_1CommandLine_1_1Descriptions.html">Steinberg::CommandLine::Descriptions</a></div><div class="ttdoc">List of command-line option descriptions.</div><div class="ttdef"><b>Definition</b> fcommandline.h:137</div></div>
<div class="ttc" id="aclassSteinberg_1_1CommandLine_1_1Descriptions_html_ab27a3d9559b5d6fddcbeb9d1474fd349"><div class="ttname"><a href="classSteinberg_1_1CommandLine_1_1Descriptions.html#ab27a3d9559b5d6fddcbeb9d1474fd349">Steinberg::CommandLine::Descriptions::addOptions</a></div><div class="ttdeci">Descriptions &amp; addOptions(const std::string &amp;caption=&quot;&quot;, std::initializer_list&lt; Description &gt; &amp;&amp;options={})</div><div class="ttdoc">Sets the command-line tool caption and starts adding Descriptions.</div><div class="ttdef"><b>Definition</b> fcommandline.h:265</div></div>
<div class="ttc" id="aclassSteinberg_1_1CommandLine_1_1VariablesMap_html"><div class="ttname"><a href="classSteinberg_1_1CommandLine_1_1VariablesMap.html">Steinberg::CommandLine::VariablesMap</a></div><div class="ttdoc">Command-line parsing result.</div><div class="ttdef"><b>Definition</b> fcommandline.h:89</div></div>
<div class="ttc" id="aclassSteinberg_1_1CommandLine_1_1VariablesMap_html_a81dd125e253592aaef5fea33dfc50c42"><div class="ttname"><a href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#a81dd125e253592aaef5fea33dfc50c42">Steinberg::CommandLine::VariablesMap::hasError</a></div><div class="ttdeci">bool hasError() const</div><div class="ttdoc">Returns true when an error has occurred.</div><div class="ttdef"><b>Definition</b> fcommandline.h:96</div></div>
<div class="ttc" id="aclassSteinberg_1_1CommandLine_1_1VariablesMap_html_aae1a1de067fae18405ef48dfbe0b3c00"><div class="ttname"><a href="classSteinberg_1_1CommandLine_1_1VariablesMap.html#aae1a1de067fae18405ef48dfbe0b3c00">Steinberg::CommandLine::VariablesMap::count</a></div><div class="ttdeci">VariablesMapContainer::size_type count(const VariablesMapContainer::key_type k) const</div><div class="ttdoc">Returns != 0 if command-line contains option k.</div><div class="ttdef"><b>Definition</b> fcommandline.h:184</div></div>
<div class="ttc" id="afcommandline_8h_html"><div class="ttname"><a href="fcommandline_8h.html">fcommandline.h</a></div></div>
<div class="ttc" id="anamespaceSteinberg_1_1CommandLine_html_aa59540066a0354da873325a175666974"><div class="ttname"><a href="#aa59540066a0354da873325a175666974">Steinberg::CommandLine::parse</a></div><div class="ttdeci">bool parse(int ac, char *av[], const Descriptions &amp;desc, VariablesMap &amp;result, FilesVector *files=nullptr)</div><div class="ttdoc">Parse the command - line.</div><div class="ttdef"><b>Definition</b> fcommandline.h:359</div></div>
</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>This is a "header only" implementation.<br />
If you need the declarations in more than one cpp file, you have to define <code>SMTG_NO_IMPLEMENTATION</code> in all but one file. </dd></dl>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a8e4c7d85763c5d6cafd67588804308f4" name="a8e4c7d85763c5d6cafd67588804308f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4c7d85763c5d6cafd67588804308f4">&#9670;&#160;</a></span>FilesVector</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a8e4c7d85763c5d6cafd67588804308f4">FilesVector</a> = std::vector&lt;std::string&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>type of the list of elements on the command line that are not handled by options parsing </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa59540066a0354da873325a175666974" name="aa59540066a0354da873325a175666974"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa59540066a0354da873325a175666974">&#9670;&#160;</a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool parse </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>ac</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>av</em></span>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html">Descriptions</a> &amp;</td> <td class="paramname"><span class="paramname"><em>desc</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classSteinberg_1_1CommandLine_1_1VariablesMap.html">VariablesMap</a> &amp;</td> <td class="paramname"><span class="paramname"><em>result</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a8e4c7d85763c5d6cafd67588804308f4">FilesVector</a> *</td> <td class="paramname"><span class="paramname"><em>files</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse the command - line. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ac</td><td>count of command-line parameters </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">av</td><td>command-line as array of strings </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td><a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html" title="List of command-line option descriptions.">Descriptions</a> including all allowed options </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the parsing result </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">files</td><td>optional list of elements on the command line that are not handled by options parsing </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6a38965238a994bf87587aac0b83a5be" name="a6a38965238a994bf87587aac0b83a5be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a38965238a994bf87587aac0b83a5be">&#9670;&#160;</a></span>operator&lt;&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;</td> <td class="paramname"><span class="paramname"><em>os</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html">Descriptions</a> &amp;</td> <td class="paramname"><span class="paramname"><em>desc</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Make <a class="el" href="classSteinberg_1_1CommandLine_1_1Descriptions.html" title="List of command-line option descriptions.">Descriptions</a> stream able. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<html>
<head>
<title>Empty</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="Author" content="Steinberg">
</head>
<body>
<br/>
<hr width="100%" size="2" align="left" />
<div align=right>
Copyright &copy;<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
</div>
<script>
document.querySelector("#year").textContent = new Date().getFullYear();
</script>
</body>
</html>