Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /proc/self/root/proc/thread-self/root/usr/share/doc/source-highlight/ |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"
"http://www.w3.org/TR/REC-html40/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite">
<title>../src/cmdline.h</title>
<link rel="stylesheet" href="./mono.css" type="text/css">
</head>
<body>
<pre><tt><span class="comment">/** </span><span class="type">@file</span><span class="comment"> cmdline.h</span>
<span class="comment"> * </span><span class="type">@brief</span><span class="comment"> The header file for the command line option parser</span>
<span class="comment"> * generated by GNU Gengetopt version 2.22.6</span>
<span class="comment"> * </span><span class="url">http://www.gnu.org/software/gengetopt.</span>
<span class="comment"> * DO NOT modify this file, since it can be overwritten</span>
<span class="comment"> * </span><span class="type">@author</span><span class="comment"> GNU Gengetopt by Lorenzo Bettini */</span>
<span class="preproc">#ifndef</span><span class="normal"> CMDLINE_H</span>
<span class="preproc">#define</span><span class="normal"> CMDLINE_H</span>
<span class="comment">/* If we use autoconf. */</span>
<span class="preproc">#ifdef</span><span class="normal"> HAVE_CONFIG_H</span>
<span class="preproc">#include</span><span class="normal"> </span><span class="string">"config.h"</span>
<span class="preproc">#endif</span>
<span class="preproc">#include</span><span class="normal"> </span><span class="string"><stdio.h></span><span class="normal"> </span><span class="comment">/* for FILE */</span>
<span class="preproc">#ifdef</span><span class="normal"> __cplusplus</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="string">"C"</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="preproc">#endif</span><span class="normal"> </span><span class="comment">/* __cplusplus */</span>
<span class="preproc">#ifndef</span><span class="normal"> CMDLINE_PARSER_PACKAGE</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> the program name (used for printing errors) */</span>
<span class="preproc">#define</span><span class="normal"> CMDLINE_PARSER_PACKAGE PACKAGE</span>
<span class="preproc">#endif</span>
<span class="preproc">#ifndef</span><span class="normal"> CMDLINE_PARSER_PACKAGE_NAME</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> the complete program name (used for help and version) */</span>
<span class="preproc">#ifdef</span><span class="normal"> PACKAGE_NAME</span>
<span class="preproc">#define</span><span class="normal"> </span><span class="usertype">CMDLINE_PARSER_PACKAGE_NAME</span><span class="normal"> PACKAGE_NAME</span>
<span class="preproc">#else</span>
<span class="preproc">#define</span><span class="normal"> CMDLINE_PARSER_PACKAGE_NAME PACKAGE</span>
<span class="preproc">#endif</span>
<span class="preproc">#endif</span>
<span class="preproc">#ifndef</span><span class="normal"> CMDLINE_PARSER_VERSION</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> the program version */</span>
<span class="preproc">#define</span><span class="normal"> CMDLINE_PARSER_VERSION VERSION</span>
<span class="preproc">#endif</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> Where the command line options are stored */</span>
<span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span>
<span class="cbracket">{</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">help_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Print help and exit help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">detailed_help_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Print help, including all details and hidden options, and exit help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">version_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Print version and exit help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> input_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> input file. default std input. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> input_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> input file. default std input original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">input_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> input file. default std input help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> output_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output file. default std output (when the third invocation form is used). If STDOUT is specified, the output is directed to standard output. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> output_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output file. default std output (when the third invocation form is used). If STDOUT is specified, the output is directed to standard output original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">output_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output file. default std output (when the third invocation form is used). If STDOUT is specified, the output is directed to standard output help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> src_lang_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> source language (use --lang-list to get the complete list). If not specified, the source language will be guessed from the file extension.. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> src_lang_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> source language (use --lang-list to get the complete list). If not specified, the source language will be guessed from the file extension. original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">src_lang_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> source language (use --lang-list to get the complete list). If not specified, the source language will be guessed from the file extension. help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">lang_list_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> list all the supported language and associated language definition file help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">outlang_list_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> list all the supported output language and associated language definition file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> out_format_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output format (use --outlang-list to get the complete list) (default='html'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> out_format_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output format (use --outlang-list to get the complete list) original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">out_format_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output format (use --outlang-list to get the complete list) help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">doc_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> create an output file that can be used as a stand alone document (e.g., not to be included in another one) help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">no_doc_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> cancel the --doc option even if it is implied (e.g., when css is given) help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> css_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> the external style sheet filename. Implies --doc. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> css_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> the external style sheet filename. Implies --doc original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">css_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> the external style sheet filename. Implies --doc help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> title_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> give a title to the output document. Implies --doc. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> title_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> give a title to the output document. Implies --doc original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">title_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> give a title to the output document. Implies --doc help description. */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> tab_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify tab length. (default='8'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> tab_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify tab length. original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">tab_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify tab length. help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> header_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> file to insert as header. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> header_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> file to insert as header original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">header_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> file to insert as header help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> footer_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> file to insert as footer. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> footer_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> file to insert as footer original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">footer_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> file to insert as footer help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> style_file_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing format options (default='default.style'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> style_file_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing format options original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">style_file_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing format options help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> style_css_file_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing format options (in css syntax). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> style_css_file_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing format options (in css syntax) original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">style_css_file_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing format options (in css syntax) help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> style_defaults_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing defaults for format options (default='style.defaults'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> style_defaults_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing defaults for format options original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">style_defaults_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file containing defaults for format options help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> outlang_def_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output language definition file. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> outlang_def_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output language definition file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">outlang_def_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output language definition file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> outlang_map_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output language map file (default='outlang.map'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> outlang_map_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output language map file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">outlang_map_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output language map file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> data_dir_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> directory where language definition files and language maps are searched for. If not specified these files are searched for in the current directory and in the data dir installation directory. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> data_dir_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> directory where language definition files and language maps are searched for. If not specified these files are searched for in the current directory and in the data dir installation directory original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">data_dir_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> directory where language definition files and language maps are searched for. If not specified these files are searched for in the current directory and in the data dir installation directory help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> output_dir_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output directory. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> output_dir_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output directory original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">output_dir_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> output directory help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> lang_def_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> language definition file. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> lang_def_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> language definition file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">lang_def_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> language definition file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> lang_map_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> language map file (default='lang.map'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> lang_map_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> language map file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">lang_map_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> language map file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> show_lang_elements_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> prints the language elements that are defined in the language definition file. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> show_lang_elements_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> prints the language elements that are defined in the language definition file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">show_lang_elements_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> prints the language elements that are defined in the language definition file help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">infer_lang_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> force to infer source script language (overriding given language specification) help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> line_number_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number all output lines, using the specified padding character (default='0'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> line_number_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number all output lines, using the specified padding character original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">line_number_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number all output lines, using the specified padding character help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> line_number_ref_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number all output lines and generate an anchor, made of the specified prefix + the line number (default='line'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> line_number_ref_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number all output lines and generate an anchor, made of the specified prefix + the line number original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">line_number_ref_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number all output lines and generate an anchor, made of the specified prefix + the line number help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal"> line_range_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines in the specified range(s). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal"> line_range_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines in the specified range(s) original value given at command line. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> line_range_min</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines in the specified range(s)'s minimum occurreces */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> line_range_max</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines in the specified range(s)'s maximum occurreces */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">line_range_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines in the specified range(s) help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> range_separator_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> the optional separator to be printed among ranges (e.g., \"...\"). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> range_separator_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> the optional separator to be printed among ranges (e.g., \"...\") original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">range_separator_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> the optional separator to be printed among ranges (e.g., \"...\") help description. */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> range_context_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number of (context) lines generated even if not in range. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> range_context_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number of (context) lines generated even if not in range original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">range_context_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> number of (context) lines generated even if not in range help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal"> regex_range_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines within the specified regular expressions. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal"> regex_range_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines within the specified regular expressions original value given at command line. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> regex_range_min</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines within the specified regular expressions's minimum occurreces */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> regex_range_max</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines within the specified regular expressions's maximum occurreces */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">regex_range_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate only the lines within the specified regular expressions help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> gen_references_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate references (default='inline'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> gen_references_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate references original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gen_references_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> generate references help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> ctags_file_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file generated by ctags that will be used to generate references (default='tags'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> ctags_file_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file generated by ctags that will be used to generate references original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">ctags_file_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> specify the file generated by ctags that will be used to generate references help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> ctags_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> how to run the ctags command. If this option is not specified, ctags will be executed with the default value. If it is specified with an empty string, ctags will not be executed at all (default='ctags --excmd=n --tag-relative=yes'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> ctags_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> how to run the ctags command. If this option is not specified, ctags will be executed with the default value. If it is specified with an empty string, ctags will not be executed at all original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">ctags_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> how to run the ctags command. If this option is not specified, ctags will be executed with the default value. If it is specified with an empty string, ctags will not be executed at all help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">verbose_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> verbose mode on help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">quiet_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> print no progress information help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">binary_output_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> write output files in binary mode help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">statistics_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> print some statistics (i.e., elapsed time) help description. */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> gen_version_flag</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> put source-highlight version in the generated file (default=on). */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gen_version_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> put source-highlight version in the generated file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> check_lang_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> only check the correctness of a language definition file. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> check_lang_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> only check the correctness of a language definition file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">check_lang_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> only check the correctness of a language definition file help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> check_outlang_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> only check the correctness of an output language definition file. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> check_outlang_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> only check the correctness of an output language definition file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">check_outlang_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> only check the correctness of an output language definition file help description. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">failsafe_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> if no language definition is found for the input, it is simply copied to the output help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> debug_langdef_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> debug a language definition. In dump mode just dumps all the steps; in interactive, at each step, waits for some input (press ENTER to step) (default='dump'). */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> debug_langdef_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> debug a language definition. In dump mode just dumps all the steps; in interactive, at each step, waits for some input (press ENTER to step) original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">debug_langdef_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> debug a language definition. In dump mode just dumps all the steps; in interactive, at each step, waits for some input (press ENTER to step) help description. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> show_regex_arg</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> show the regular expression automaton corresponding to a language definition file. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal"> show_regex_orig</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> show the regular expression automaton corresponding to a language definition file original value given at command line. */</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">show_regex_help</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> show the regular expression automaton corresponding to a language definition file help description. */</span>
<span class="normal"> </span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> help_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether help was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> detailed_help_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether detailed-help was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> version_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether version was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> input_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether input was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> output_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether output was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> src_lang_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether src-lang was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> lang_list_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether lang-list was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> outlang_list_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether outlang-list was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> out_format_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether out-format was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> doc_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether doc was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> no_doc_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether no-doc was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> css_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether css was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> title_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether title was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> tab_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether tab was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> header_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether header was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> footer_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether footer was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> style_file_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether style-file was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> style_css_file_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether style-css-file was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> style_defaults_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether style-defaults was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> outlang_def_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether outlang-def was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> outlang_map_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether outlang-map was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> data_dir_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether data-dir was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> output_dir_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether output-dir was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> lang_def_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether lang-def was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> lang_map_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether lang-map was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> show_lang_elements_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether show-lang-elements was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> infer_lang_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether infer-lang was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> line_number_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether line-number was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> line_number_ref_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether line-number-ref was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> line_range_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether line-range was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> range_separator_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether range-separator was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> range_context_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether range-context was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> regex_range_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether regex-range was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> gen_references_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether gen-references was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> ctags_file_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether ctags-file was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> ctags_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether ctags was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> verbose_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether verbose was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> quiet_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether quiet was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> binary_output_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether binary-output was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> statistics_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether statistics was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> gen_version_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether gen-version was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> check_lang_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether check-lang was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> check_outlang_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether check-outlang was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> failsafe_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether failsafe was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> debug_langdef_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether debug-langdef was given. */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> </span><span class="type">int</span><span class="normal"> show_regex_given </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Whether show-regex was given. */</span>
<span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">inputs </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> unamed options (options without names) */</span>
<span class="normal"> </span><span class="type">unsigned</span><span class="normal"> inputs_num </span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> unamed options number */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> linerange_mode_counter</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Counter for mode linerange */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> regexrange_mode_counter</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Counter for mode regexrange */</span>
<span class="cbracket">}</span><span class="normal"> </span><span class="symbol">;</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> The additional parameters to pass to parser functions */</span>
<span class="keyword">struct</span><span class="normal"> </span><span class="classname">cmdline_parser_params</span>
<span class="cbracket">{</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> override</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> whether to override possibly already present options (default 0) */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> initialize</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> whether to initialize the option structure gengetopt_args_info (default 1) */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> check_required</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> whether to check that all required options were provided (default 1) */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> check_ambiguity</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> whether to check for options already specified in the option structure gengetopt_args_info (default 0) */</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> print_errors</span><span class="symbol">;</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> whether getopt_long should print an error message for a bad option (default 1) */</span>
<span class="cbracket">}</span><span class="normal"> </span><span class="symbol">;</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> the purpose string of the program */</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gengetopt_args_info_purpose</span><span class="symbol">;</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> the usage string of the program */</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gengetopt_args_info_usage</span><span class="symbol">;</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> the description string of the program */</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gengetopt_args_info_description</span><span class="symbol">;</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> all the lines making the help output */</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gengetopt_args_info_help</span><span class="symbol">[];</span>
<span class="comment">/** </span><span class="type">@brief</span><span class="comment"> all the lines making the detailed help output (including hidden options and details) */</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gengetopt_args_info_detailed_help</span><span class="symbol">[];</span>
<span class="comment">/**</span>
<span class="comment"> * The command line parser</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> argc the number of command line options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> argv the command line options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the structure where option information will be stored</span>
<span class="comment"> * </span><span class="type">@return</span><span class="comment"> 0 if everything went fine, NON 0 if an error took place</span>
<span class="comment"> */</span>
<span class="type">int</span><span class="normal"> </span><span class="function">cmdline_parser</span><span class="normal"> </span><span class="symbol">(</span><span class="type">int</span><span class="normal"> argc</span><span class="symbol">,</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">argv</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * The command line parser (version with additional parameters - deprecated)</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> argc the number of command line options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> argv the command line options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the structure where option information will be stored</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> override whether to override possibly already present options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> initialize whether to initialize the option structure my_args_info</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> check_required whether to check that all required options were provided</span>
<span class="comment"> * </span><span class="type">@return</span><span class="comment"> 0 if everything went fine, NON 0 if an error took place</span>
<span class="comment"> * </span><span class="type">@deprecated</span><span class="comment"> use cmdline_parser_ext() instead</span>
<span class="comment"> */</span>
<span class="type">int</span><span class="normal"> </span><span class="function">cmdline_parser2</span><span class="normal"> </span><span class="symbol">(</span><span class="type">int</span><span class="normal"> argc</span><span class="symbol">,</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">argv</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">,</span>
<span class="normal"> </span><span class="type">int</span><span class="normal"> override</span><span class="symbol">,</span><span class="normal"> </span><span class="type">int</span><span class="normal"> initialize</span><span class="symbol">,</span><span class="normal"> </span><span class="type">int</span><span class="normal"> check_required</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * The command line parser (version with additional parameters)</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> argc the number of command line options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> argv the command line options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the structure where option information will be stored</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> params additional parameters for the parser</span>
<span class="comment"> * </span><span class="type">@return</span><span class="comment"> 0 if everything went fine, NON 0 if an error took place</span>
<span class="comment"> */</span>
<span class="type">int</span><span class="normal"> </span><span class="function">cmdline_parser_ext</span><span class="normal"> </span><span class="symbol">(</span><span class="type">int</span><span class="normal"> argc</span><span class="symbol">,</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">argv</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">cmdline_parser_params</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">params</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Save the contents of the option struct into an already open FILE stream.</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> outfile the stream where to dump options</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the option struct to dump</span>
<span class="comment"> * </span><span class="type">@return</span><span class="comment"> 0 if everything went fine, NON 0 if an error took place</span>
<span class="comment"> */</span>
<span class="type">int</span><span class="normal"> </span><span class="function">cmdline_parser_dump</span><span class="symbol">(</span><span class="usertype">FILE</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">outfile</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Save the contents of the option struct into a (text) file.</span>
<span class="comment"> * This file can be read by the config file parser (if generated by gengetopt)</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> filename the file where to save</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the option struct to save</span>
<span class="comment"> * </span><span class="type">@return</span><span class="comment"> 0 if everything went fine, NON 0 if an error took place</span>
<span class="comment"> */</span>
<span class="type">int</span><span class="normal"> </span><span class="function">cmdline_parser_file_save</span><span class="symbol">(</span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">filename</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Print the help</span>
<span class="comment"> */</span>
<span class="type">void</span><span class="normal"> </span><span class="function">cmdline_parser_print_help</span><span class="symbol">(</span><span class="type">void</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Print the detailed help (including hidden options and details)</span>
<span class="comment"> */</span>
<span class="type">void</span><span class="normal"> </span><span class="function">cmdline_parser_print_detailed_help</span><span class="symbol">(</span><span class="type">void</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Print the version</span>
<span class="comment"> */</span>
<span class="type">void</span><span class="normal"> </span><span class="function">cmdline_parser_print_version</span><span class="symbol">(</span><span class="type">void</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Initializes all the fields a cmdline_parser_params structure </span>
<span class="comment"> * to their default values</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> params the structure to initialize</span>
<span class="comment"> */</span>
<span class="type">void</span><span class="normal"> </span><span class="function">cmdline_parser_params_init</span><span class="symbol">(</span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">cmdline_parser_params</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">params</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Allocates dynamically a cmdline_parser_params structure and initializes</span>
<span class="comment"> * all its fields to their default values</span>
<span class="comment"> * </span><span class="type">@return</span><span class="comment"> the created and initialized cmdline_parser_params structure</span>
<span class="comment"> */</span>
<span class="keyword">struct</span><span class="normal"> </span><span class="classname">cmdline_parser_params</span><span class="normal"> </span><span class="symbol">*</span><span class="function">cmdline_parser_params_create</span><span class="symbol">(</span><span class="type">void</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Initializes the passed gengetopt_args_info structure's fields</span>
<span class="comment"> * (also set default values for options that have a default)</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the structure to initialize</span>
<span class="comment"> */</span>
<span class="type">void</span><span class="normal"> </span><span class="function">cmdline_parser_init</span><span class="normal"> </span><span class="symbol">(</span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Deallocates the string fields of the gengetopt_args_info structure</span>
<span class="comment"> * (but does not deallocate the structure itself)</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the structure to deallocate</span>
<span class="comment"> */</span>
<span class="type">void</span><span class="normal"> </span><span class="function">cmdline_parser_free</span><span class="normal"> </span><span class="symbol">(</span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">);</span>
<span class="comment">/**</span>
<span class="comment"> * Checks that all the required options were specified</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> args_info the structure to check</span>
<span class="comment"> * </span><span class="type">@param</span><span class="comment"> prog_name the name of the program that will be used to print</span>
<span class="comment"> * possible errors</span>
<span class="comment"> * </span><span class="type">@return</span>
<span class="comment"> */</span>
<span class="type">int</span><span class="normal"> </span><span class="function">cmdline_parser_required</span><span class="normal"> </span><span class="symbol">(</span><span class="keyword">struct</span><span class="normal"> </span><span class="classname">gengetopt_args_info</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">args_info</span><span class="symbol">,</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">prog_name</span><span class="symbol">);</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">cmdline_parser_gen_references_values</span><span class="symbol">[];</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Possible values for gen-references. */</span>
<span class="keyword">extern</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">cmdline_parser_debug_langdef_values</span><span class="symbol">[];</span><span class="normal"> </span><span class="comment">/**< </span><span class="type">@brief</span><span class="comment"> Possible values for debug-langdef. */</span>
<span class="preproc">#ifdef</span><span class="normal"> __cplusplus</span>
<span class="cbracket">}</span>
<span class="preproc">#endif</span><span class="normal"> </span><span class="comment">/* __cplusplus */</span>
<span class="preproc">#endif</span><span class="normal"> </span><span class="comment">/* CMDLINE_H */</span>
</tt></pre>
</body>
</html>