doc/doxygen/latex/TestMasterMicroMod_2getopt_8c.tex
changeset 207 b6572d0336c3
equal deleted inserted replaced
206:6787754b251b 207:b6572d0336c3
       
     1 \section{examples/Test\-Master\-Micro\-Mod/getopt.c File Reference}
       
     2 \label{TestMasterMicroMod_2getopt_8c}\index{examples/TestMasterMicroMod/getopt.c@{examples/TestMasterMicroMod/getopt.c}}
       
     3 {\tt \#include $<$stdio.h$>$}\par
       
     4 {\tt \#include \char`\"{}getopt.h\char`\"{}}\par
       
     5 {\tt \#include $<$strings.h$>$}\par
       
     6 \subsection*{Defines}
       
     7 \begin{CompactItemize}
       
     8 \item 
       
     9 \#define {\bf GETOPT\_\-INTERFACE\_\-VERSION}~2
       
    10 \item 
       
    11 \#define {\bf \_\-}(msgid)~(msgid)
       
    12 \item 
       
    13 \#define {\bf SWAP\_\-FLAGS}(ch1, ch2)
       
    14 \item 
       
    15 \#define {\bf NONOPTION\_\-P}~(argv[{\bf optind}][0] != '-' $|$$|$ argv[{\bf optind}][1] == '$\backslash$0')
       
    16 \end{CompactItemize}
       
    17 \subsection*{Enumerations}
       
    18 \begin{CompactItemize}
       
    19 \item 
       
    20 enum \{ {\bf REQUIRE\_\-ORDER}, 
       
    21 {\bf PERMUTE}, 
       
    22 {\bf RETURN\_\-IN\_\-ORDER}
       
    23  \}
       
    24 \end{CompactItemize}
       
    25 \subsection*{Functions}
       
    26 \begin{CompactItemize}
       
    27 \item 
       
    28 char $\ast$ {\bf getenv} ()
       
    29 \item 
       
    30 static char $\ast$ {\bf my\_\-index} (char $\ast$str, int chr) const
       
    31 \item 
       
    32 static void {\bf exchange} (char $\ast$$\ast$argv)
       
    33 \item 
       
    34 static const char $\ast$ {\bf \_\-getopt\_\-initialize} (int argc, char $\ast$const $\ast$argv, const char $\ast$optstring)
       
    35 \item 
       
    36 int {\bf \_\-getopt\_\-internal} (int argc, char $\ast$const $\ast$argv, const char $\ast$optstring, const struct {\bf option} $\ast$longopts, int $\ast$longind, int long\_\-only)
       
    37 \item 
       
    38 int {\bf getopt} (int argc, char $\ast$const $\ast$argv, const char $\ast$optstring)
       
    39 \end{CompactItemize}
       
    40 \subsection*{Variables}
       
    41 \begin{CompactItemize}
       
    42 \item 
       
    43 char $\ast$ {\bf optarg}
       
    44 \item 
       
    45 int {\bf optind} = 1
       
    46 \item 
       
    47 int {\bf \_\-\_\-getopt\_\-initialized}
       
    48 \item 
       
    49 static char $\ast$ {\bf nextchar}
       
    50 \item 
       
    51 int {\bf opterr} = 1
       
    52 \item 
       
    53 int {\bf optopt} = '?'
       
    54 \item 
       
    55 static enum  \{ ... \}  {\bf ordering}
       
    56 \item 
       
    57 static char $\ast$ {\bf posixly\_\-correct}
       
    58 \item 
       
    59 static int {\bf first\_\-nonopt}
       
    60 \item 
       
    61 static int {\bf last\_\-nonopt}
       
    62 \end{CompactItemize}
       
    63 
       
    64 
       
    65 \subsection{Define Documentation}
       
    66 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!_@{\_\-}}
       
    67 \index{_@{\_\-}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
    68 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define \_\-(msgid)~(msgid)}\label{TestMasterMicroMod_2getopt_8c_86a239addea586602343007a370bf8ad}
       
    69 
       
    70 
       
    71 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!GETOPT_INTERFACE_VERSION@{GETOPT\_\-INTERFACE\_\-VERSION}}
       
    72 \index{GETOPT_INTERFACE_VERSION@{GETOPT\_\-INTERFACE\_\-VERSION}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
    73 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define GETOPT\_\-INTERFACE\_\-VERSION~2}\label{TestMasterMicroMod_2getopt_8c_5325c715897861c318d3ae312ac452cc}
       
    74 
       
    75 
       
    76 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!NONOPTION_P@{NONOPTION\_\-P}}
       
    77 \index{NONOPTION_P@{NONOPTION\_\-P}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
    78 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define NONOPTION\_\-P~(argv[{\bf optind}][0] != '-' $|$$|$ argv[{\bf optind}][1] == '$\backslash$0')}\label{TestMasterMicroMod_2getopt_8c_71ceb8911d64b39b402041ba5ea8453c}
       
    79 
       
    80 
       
    81 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!SWAP_FLAGS@{SWAP\_\-FLAGS}}
       
    82 \index{SWAP_FLAGS@{SWAP\_\-FLAGS}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
    83 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define SWAP\_\-FLAGS(ch1, ch2)}\label{TestMasterMicroMod_2getopt_8c_6e06e56c5fa96faaf47f3b231e015e35}
       
    84 
       
    85 
       
    86 
       
    87 
       
    88 \subsection{Enumeration Type Documentation}
       
    89 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}\label{TestMasterMicroMod_2getopt_8c_06fc87d81c62e9abb8790b6e5713c55b}
       
    90 
       
    91 
       
    92 \begin{Desc}
       
    93 \item[Enumerator: ]\par
       
    94 \begin{description}
       
    95 \index{REQUIRE_ORDER@{REQUIRE\_\-ORDER}!TestMasterMicroMod/getopt.c@{TestMasterMicroMod/getopt.c}}\index{TestMasterMicroMod/getopt.c@{TestMasterMicroMod/getopt.c}!REQUIRE_ORDER@{REQUIRE\_\-ORDER}}\item[{\em 
       
    96 REQUIRE\_\-ORDER\label{TestMasterMicroMod_2getopt_8c_06fc87d81c62e9abb8790b6e5713c55b0e73a0691c110b1442d8364d1d12eccc}
       
    97 }]\index{PERMUTE@{PERMUTE}!TestMasterMicroMod/getopt.c@{TestMasterMicroMod/getopt.c}}\index{TestMasterMicroMod/getopt.c@{TestMasterMicroMod/getopt.c}!PERMUTE@{PERMUTE}}\item[{\em 
       
    98 PERMUTE\label{TestMasterMicroMod_2getopt_8c_06fc87d81c62e9abb8790b6e5713c55bcfdde4b47c27f4efbd832e1ac7f8a8fc}
       
    99 }]\index{RETURN_IN_ORDER@{RETURN\_\-IN\_\-ORDER}!TestMasterMicroMod/getopt.c@{TestMasterMicroMod/getopt.c}}\index{TestMasterMicroMod/getopt.c@{TestMasterMicroMod/getopt.c}!RETURN_IN_ORDER@{RETURN\_\-IN\_\-ORDER}}\item[{\em 
       
   100 RETURN\_\-IN\_\-ORDER\label{TestMasterMicroMod_2getopt_8c_06fc87d81c62e9abb8790b6e5713c55b3c56550bfafe809d9214b863b69c31c5}
       
   101 }]\end{description}
       
   102 \end{Desc}
       
   103 
       
   104 
       
   105 
       
   106 \subsection{Function Documentation}
       
   107 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!_getopt_initialize@{\_\-getopt\_\-initialize}}
       
   108 \index{_getopt_initialize@{\_\-getopt\_\-initialize}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   109 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}static const char$\ast$ \_\-getopt\_\-initialize (int {\em argc}, char $\ast$const $\ast$ {\em argv}, const char $\ast$ {\em optstring})\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_17475cbc1ffae0c12af2e0a3319d197f}
       
   110 
       
   111 
       
   112 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!_getopt_internal@{\_\-getopt\_\-internal}}
       
   113 \index{_getopt_internal@{\_\-getopt\_\-internal}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   114 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int \_\-getopt\_\-internal (int {\em argc}, char $\ast$const $\ast$ {\em argv}, const char $\ast$ {\em optstring}, const struct {\bf option} $\ast$ {\em longopts}, int $\ast$ {\em longind}, int {\em long\_\-only})}\label{TestMasterMicroMod_2getopt_8c_0df92a0ae8fe1fd43268c738f548674f}
       
   115 
       
   116 
       
   117 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!exchange@{exchange}}
       
   118 \index{exchange@{exchange}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   119 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}static void exchange (char $\ast$$\ast$ {\em argv})\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_4621659dd6377e52ac50a0869625bb6e}
       
   120 
       
   121 
       
   122 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!getenv@{getenv}}
       
   123 \index{getenv@{getenv}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   124 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ getenv ()}\label{TestMasterMicroMod_2getopt_8c_ee28fd8a0e40b6d958f7d20348e45368}
       
   125 
       
   126 
       
   127 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!getopt@{getopt}}
       
   128 \index{getopt@{getopt}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   129 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int getopt (int {\em argc}, char $\ast$const $\ast$ {\em argv}, const char $\ast$ {\em optstring})}\label{TestMasterMicroMod_2getopt_8c_1b2ada39ab92162c6ec9c67c8093fa2e}
       
   130 
       
   131 
       
   132 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!my_index@{my\_\-index}}
       
   133 \index{my_index@{my\_\-index}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   134 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}static char$\ast$ my\_\-index (char $\ast$ {\em str}, int {\em chr}) const\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_e0ac978b7775f69496c0f127ffdada9d}
       
   135 
       
   136 
       
   137 
       
   138 
       
   139 \subsection{Variable Documentation}
       
   140 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!__getopt_initialized@{\_\-\_\-getopt\_\-initialized}}
       
   141 \index{__getopt_initialized@{\_\-\_\-getopt\_\-initialized}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   142 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf \_\-\_\-getopt\_\-initialized}}\label{TestMasterMicroMod_2getopt_8c_28286be757527aeb1db951b5da9aeec1}
       
   143 
       
   144 
       
   145 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!first_nonopt@{first\_\-nonopt}}
       
   146 \index{first_nonopt@{first\_\-nonopt}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   147 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf first\_\-nonopt}\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_7b0f4f3bfbee147113f282427ce933ed}
       
   148 
       
   149 
       
   150 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!last_nonopt@{last\_\-nonopt}}
       
   151 \index{last_nonopt@{last\_\-nonopt}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   152 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf last\_\-nonopt}\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_580f2c2acf35dad51ca18b427212bf15}
       
   153 
       
   154 
       
   155 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!nextchar@{nextchar}}
       
   156 \index{nextchar@{nextchar}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   157 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf nextchar}\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_47a40a4c365dae45f94751ad32aab530}
       
   158 
       
   159 
       
   160 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!optarg@{optarg}}
       
   161 \index{optarg@{optarg}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   162 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf optarg}}\label{TestMasterMicroMod_2getopt_8c_db50a0eab9fed92fc3bfc7dfa4f2c410}
       
   163 
       
   164 
       
   165 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!opterr@{opterr}}
       
   166 \index{opterr@{opterr}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   167 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf opterr} = 1}\label{TestMasterMicroMod_2getopt_8c_e30f05ee1e2e5652f174a35c7875d25e}
       
   168 
       
   169 
       
   170 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!optind@{optind}}
       
   171 \index{optind@{optind}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   172 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf optind} = 1}\label{TestMasterMicroMod_2getopt_8c_d5e1c16213bbee2d5e8cc363309f418c}
       
   173 
       
   174 
       
   175 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!optopt@{optopt}}
       
   176 \index{optopt@{optopt}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   177 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf optopt} = '?'}\label{TestMasterMicroMod_2getopt_8c_475b8db98445da73e5f62a1ef6324b95}
       
   178 
       
   179 
       
   180 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!ordering@{ordering}}
       
   181 \index{ordering@{ordering}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   182 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum \{ ... \}   {\bf ordering}\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_67a84cf4dacaa8337be68345f8b9a8cc}
       
   183 
       
   184 
       
   185 \index{TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}!posixly_correct@{posixly\_\-correct}}
       
   186 \index{posixly_correct@{posixly\_\-correct}!TestMasterMicroMod/getopt.c@{Test\-Master\-Micro\-Mod/getopt.c}}
       
   187 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf posixly\_\-correct}\hspace{0.3cm}{\tt  [static]}}\label{TestMasterMicroMod_2getopt_8c_d0ccb64bbd4defe7a57dbad2045ddd14}
       
   188 
       
   189