<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>GNU Radio 3.6.4.1 C++ API: getopt.h Source File</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> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.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 style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU Radio 3.6.4.1 C++ API </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> </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"> $(document).ready(function(){initNavTree('getopt_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">getopt.h</div> </div> </div><!--header--> <div class="contents"> <a href="getopt_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Declarations for getopt.</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 1989, 1990, 1991, 1992, 1993 Free Software Foundation, Inc.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> This program is free software; you can redistribute it and/or modify it</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> under the terms of the GNU General Public License as published by the</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Free Software Foundation; either version 3, or (at your option) any</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> later version.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> This program is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> GNU General Public License for more details.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> along with this program; if not, write to the Free Software</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef _GETOPT_H</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="preprocessor">#define _GETOPT_H 1</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* For communication from `getopt' to the caller.</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> When `getopt' finds an option that takes an argument,</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> the argument value is returned here.</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> Also, when `ordering' is RETURN_IN_ORDER,</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> each non-option ARGV-element is returned here. */</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">extern</span> <span class="keywordtype">char</span> *<a class="code" href="getopt_8h.html#adb50a0eab9fed92fc3bfc7dfa4f2c410">optarg</a>;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/* Index in ARGV of the next element to be scanned.</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> This is used for communication to and from the caller</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> and for communication between successive calls to `getopt'.</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> On entry to `getopt', zero means this is the first call; initialize.</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> When `getopt' returns EOF, this is the index of the first of the</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> non-option elements that the caller should itself scan.</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> Otherwise, `optind' communicates from one call to the next</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> how much of ARGV has been scanned so far. */</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#ad5e1c16213bbee2d5e8cc363309f418c">optind</a>;</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/* Callers store zero here to inhibit the error message `getopt' prints</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> for unrecognized options. */</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#ae30f05ee1e2e5652f174a35c7875d25e">opterr</a>;</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/* Set to an option character which was unrecognized. */</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a475b8db98445da73e5f62a1ef6324b95">optopt</a>;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/* Describe the long-named options requested by the application.</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> of `struct option' terminated by an element containing a name which is</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> zero.</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> The field `has_arg' is:</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> no_argument (or 0) if the option does not take an argument,</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> required_argument (or 1) if the option requires an argument,</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> optional_argument (or 2) if the option takes an optional argument.</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> If the field `flag' is not NULL, it points to a variable that is set</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> to the value given in the field `val' when the option is found, but</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> left unchanged if the option is not found.</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> To have a long-named option do something other than set an `int' to</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> a compiled-in constant, such as set a value from `optarg', set the</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> option's `flag' field to zero and its `val' field to a nonzero</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> value (the equivalent single-letter option character, if there is</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> one). For long options that have a zero `flag' field, `getopt'</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> returns the contents of the `val' field. */</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00077"></a><span class="lineno"><a class="code" href="structoption.html"> 77</a></span> <span class="keyword">struct </span><a class="code" href="structoption.html">option</a></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#if __STDC__</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structoption.html#a92c850a23c7828c1dba453bf8d15e1f0">name</a>;</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#else</span></div> <div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="structoption.html#a92c850a23c7828c1dba453bf8d15e1f0"> 82</a></span> <span class="preprocessor"></span> <span class="keywordtype">char</span> *<a class="code" href="structoption.html#a92c850a23c7828c1dba453bf8d15e1f0">name</a>;</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"></span> <span class="comment">/* has_arg can't be an enum because some compilers complain about</span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> type mismatches in all the code that assumes it is an int. */</span></div> <div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="structoption.html#a90d7ee9a51eea5c002682dbd0af149e4"> 86</a></span>  <span class="keywordtype">int</span> <a class="code" href="structoption.html#a90d7ee9a51eea5c002682dbd0af149e4">has_arg</a>;</div> <div class="line"><a name="l00087"></a><span class="lineno"><a class="code" href="structoption.html#ab366eea5fe7be25c1928328ba715e353"> 87</a></span>  <span class="keywordtype">int</span> *<a class="code" href="structoption.html#ab366eea5fe7be25c1928328ba715e353">flag</a>;</div> <div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="structoption.html#a13bd155ec3b405d29c41ab8d0793be11"> 88</a></span>  <span class="keywordtype">int</span> <a class="code" href="structoption.html#a13bd155ec3b405d29c41ab8d0793be11">val</a>;</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> };</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/* Names for the values of the `has_arg' field of `struct option'. */</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="getopt_8h.html#a3bc1d5f667b5b4ca4b4abb685dc874ce"> 93</a></span> <span class="preprocessor">#define no_argument 0</span></div> <div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="getopt_8h.html#a6ece8d8dfa8378778f7290fdaba5b8bc"> 94</a></span> <span class="preprocessor"></span><span class="preprocessor">#define required_argument 1</span></div> <div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="getopt_8h.html#acca06c0a947656bd8b395bf1084ffb72"> 95</a></span> <span class="preprocessor"></span><span class="preprocessor">#define optional_argument 2</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#if __STDC__</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"></span><span class="preprocessor">#if defined(__GNU_LIBRARY__)</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"></span><span class="comment">/* Many other libraries have conflicting prototypes for getopt, with</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> differences in the consts, in stdlib.h. To avoid compilation</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> errors, only prototype getopt for the GNU C library. */</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a6c5b232cca42dab05f40b47f69715f8b">getopt</a> (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *argv, <span class="keyword">const</span> <span class="keywordtype">char</span> *shortopts);</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#else </span><span class="comment">/* not __GNU_LIBRARY__ */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a6c5b232cca42dab05f40b47f69715f8b">getopt</a> ();</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif </span><span class="comment">/* not __GNU_LIBRARY__ */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a8616b8a74ae6c01a7ad95ad2876226ec">getopt_long</a> (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *argv, <span class="keyword">const</span> <span class="keywordtype">char</span> *shortopts,</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoption.html">option</a> *longopts, <span class="keywordtype">int</span> *longind);</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#ac07930413317507d5c51c19b3ac6ed20">getopt_long_only</a> (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *argv,</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *shortopts,</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoption.html">option</a> *longopts, <span class="keywordtype">int</span> *longind);</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/* Internal only. Users should not call this directly. */</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a60428225710059ca135c6b2a8941855f">_getopt_internal</a> (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *argv,</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *shortopts,</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoption.html">option</a> *longopts, <span class="keywordtype">int</span> *longind,</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">int</span> long_only);</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#else </span><span class="comment">/* not __STDC__ */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a6c5b232cca42dab05f40b47f69715f8b">getopt</a> ();</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a8616b8a74ae6c01a7ad95ad2876226ec">getopt_long</a> ();</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#ac07930413317507d5c51c19b3ac6ed20">getopt_long_only</a> ();</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="getopt_8h.html#a60428225710059ca135c6b2a8941855f">_getopt_internal</a> ();</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif </span><span class="comment">/* not __STDC__ */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#endif </span><span class="comment">/* _GETOPT_H */</span><span class="preprocessor"></span></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_e7dddbb82d49880dabf93f95255e237c.html">missing</a></li><li class="navelem"><a class="el" href="getopt_8h.html">getopt.h</a></li> <li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>