2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > 1/mn< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< link href = "inweb.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body >
<!-- Weave of '1/cnf' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../webs.html" > ★ < / a > < / li > < li > < a href = "index.html" > indoc 4< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Setting Up< / a > < / li > < li > < b > Configuration< / b > < / li > < / ul > < p class = "purpose" > Instructions of indoc to different output types.< / p >
< ul class = "toc" > < li > < a href = "#SP1" > § 1. Known instruction files< / a > < / li > < li > < a href = "#SP2" > § 2. Command line switches< / a > < / li > < / ul > < hr class = "tocbar" >
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. Known instruction files. < / b > Most configuration is done not from the command line, but by instructions
files, and we store a list of those here:
< / p >
< pre class = "display" >
< span class = "reserved" > linked_list< / span > < span class = "plain" > *< / span > < span class = "identifier" > instructions_files< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ; < / span > < span class = "comment" > of < code class = "display" > < span class = "extract" > filename< / span > < / code > < / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Configuration::add_instructions_file< / span > < span class = "plain" > (< / span > < span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > instructions_files< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > instructions_files< / span > < span class = "plain" > = < / span > < span class = "identifier" > NEW_LINKED_LIST< / span > < span class = "plain" > (< / span > < span class = "reserved" > filename< / span > < span class = "plain" > );< / span >
< span class = "identifier" > ADD_TO_LINKED_LIST< / span > < span class = "plain" > (< / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "reserved" > filename< / span > < span class = "plain" > , < / span > < span class = "identifier" > instructions_files< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Configuration::read_instructions< / span > < span class = "plain" > (< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > target< / span > < span class = "plain" > , < / span > < span class = "reserved" > settings_block< / span > < span class = "plain" > *< / span > < span class = "identifier" > settings< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > Instructions::read_instructions< / span > < span class = "plain" > (< / span > < span class = "identifier" > target< / span > < span class = "plain" > , < / span > < span class = "identifier" > instructions_files< / span > < span class = "plain" > , < / span > < span class = "identifier" > settings< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Configuration::add_instructions_file is used in < a href = "#SP2" > § 2< / a > , < a href = "#SP3" > § 3< / a > .< / p >
< p class = "endnote" > The function Configuration::read_instructions is used in < a href = "#SP2" > § 2< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. Command line switches. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > typedef< / span > < span class = "plain" > < / span > < span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > cl_state< / span > < span class = "plain" > {< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > target_chosen< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > settings_block< / span > < span class = "plain" > *< / span > < span class = "identifier" > settings< / span > < span class = "plain" > ;< / span >
< span class = "plain" > } < / span > < span class = "reserved" > cl_state< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Configuration::read_command_line< / span > < span class = "plain" > (< / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > argc< / span > < span class = "plain" > , < / span > < span class = "reserved" > char< / span > < span class = "plain" > **< / span > < span class = "identifier" > argv< / span > < span class = "plain" > , < / span > < span class = "reserved" > settings_block< / span > < span class = "plain" > *< / span > < span class = "identifier" > settings< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > cl_state< / span > < span class = "plain" > < / span > < span class = "identifier" > state< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > state< / span > < span class = "element" > .target_chosen< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::new< / span > < span class = "plain" > ();< / span >
< span class = "identifier" > state< / span > < span class = "element" > .settings< / span > < span class = "plain" > = < / span > < span class = "identifier" > settings< / span > < span class = "plain" > ;< / span >
< < span class = "cwebmacro" > Read the command line< / span > < span class = "cwebmacronumber" > 2.2< / span > > < span class = "plain" > ;< / span >
< span class = "identifier" > path_to_indoc< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Pathnames::installation_path< / span > < span class = "plain" > (< / span > < span class = "string" > "INDOC_PATH"< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "indoc"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > verbose_mode< / span > < span class = "plain" > ) < / span > < span class = "identifier" > PRINT< / span > < span class = "plain" > (< / span > < span class = "string" > "Installation path is %p\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > , < / span > < span class = "identifier" > path_to_indoc< / span > < span class = "plain" > );< / span >
< span class = "identifier" > path_to_indoc_materials< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Pathnames::subfolder< / span > < span class = "plain" > (< / span > < span class = "identifier" > path_to_indoc< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "Materials"< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Configuration::add_instructions_file< / span > < span class = "plain" > (< / span >
< span class = "functiontext" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > path_to_indoc_materials< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "basic-instructions.txt"< / span > < span class = "plain" > ));< / span >
< span class = "functiontext" > Configuration::add_instructions_file< / span > < span class = "plain" > (< / span >
< span class = "functiontext" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > book_folder< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "indoc-instructions.txt"< / span > < span class = "plain" > ));< / span >
< span class = "functiontext" > Configuration::read_instructions< / span > < span class = "plain" > (< / span > < span class = "identifier" > state< / span > < span class = "element" > .target_chosen< / span > < span class = "plain" > , < / span > < span class = "identifier" > settings< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Configuration::read_command_line is used in 1/mn (< a href = "1-mn.html#SP1_1" > § 1.1< / a > ).< / p >
< p class = "endnote" > The structure cl_state is accessed in 1/ins and here.< / p >
< p class = "inwebparagraph" > < a id = "SP2_1" > < / a > < b > § 2.1. < / b > < / p >
< pre class = "definitions" >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > VERBOSE_CLSW< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > TEST_INDEX_CLSW< / span >
2020-01-26 01:42:42 +02:00
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > XREFS_CLSW< / span >
2019-03-17 14:40:57 +02:00
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > FROM_CLSW< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > TO_CLSW< / span >
2019-06-26 11:05:27 +03:00
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > INSERTION_CLSW< / span >
2019-03-17 14:40:57 +02:00
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > INSTRUCTIONS_CLSW< / span >
< / pre >
< p class = "inwebparagraph" > < a id = "SP2_2" > < / a > < b > § 2.2. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Read the command line< / span > < span class = "cwebmacronumber" > 2.2< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "functiontext" > CommandLine::declare_heading< / span > < span class = "plain" > (< / span >
< span class = "identifier" > L< / span > < span class = "string" > "indoc: a tool for rendering Inform documentation\< / span > < span class = "plain" > n< / span > < span class = "string" > \< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span >
< span class = "identifier" > L< / span > < span class = "string" > "Usage: indoc [OPTIONS] TARGET\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span >
< span class = "identifier" > L< / span > < span class = "string" > "where TARGET must be one of those set up in the instructions.\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > CommandLine::declare_boolean_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > VERBOSE_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "verbose"< / span > < span class = "plain" > , 1,< / span >
2020-02-27 03:43:11 +02:00
< span class = "identifier" > L< / span > < span class = "string" > "explain what indoc is doing"< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "functiontext" > CommandLine::declare_boolean_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > TEST_INDEX_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "test-index"< / span > < span class = "plain" > , 1,< / span >
2020-02-27 03:43:11 +02:00
< span class = "identifier" > L< / span > < span class = "string" > "test indexing"< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > );< / span >
2020-01-26 01:42:42 +02:00
< span class = "functiontext" > CommandLine::declare_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > XREFS_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "xrefs"< / span > < span class = "plain" > , 2,< / span >
< span class = "identifier" > L< / span > < span class = "string" > "write a file of documentation cross-references to filename X"< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "functiontext" > CommandLine::declare_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > FROM_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "from"< / span > < span class = "plain" > , 2,< / span >
< span class = "identifier" > L< / span > < span class = "string" > "use documentation in directory X (instead of 'Documentation' in cwd)"< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > CommandLine::declare_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > TO_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "to"< / span > < span class = "plain" > , 2,< / span >
< span class = "identifier" > L< / span > < span class = "string" > "redirect output to folder X (which must already exist)"< / span > < span class = "plain" > );< / span >
2019-06-26 11:05:27 +03:00
< span class = "functiontext" > CommandLine::declare_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > INSERTION_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "insertion"< / span > < span class = "plain" > , 2,< / span >
< span class = "identifier" > L< / span > < span class = "string" > "insert HTML in file X at the top of each page head"< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "functiontext" > CommandLine::declare_switch< / span > < span class = "plain" > (< / span > < span class = "constant" > INSTRUCTIONS_CLSW< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "instructions"< / span > < span class = "plain" > , 2,< / span >
< span class = "identifier" > L< / span > < span class = "string" > "read further instructions from file X"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > CommandLine::read< / span > < span class = "plain" > (< / span > < span class = "identifier" > argc< / span > < span class = "plain" > , < / span > < span class = "identifier" > argv< / span > < span class = "plain" > , & < / span > < span class = "identifier" > state< / span > < span class = "plain" > , & < / span > < span class = "functiontext" > Configuration::switch< / span > < span class = "plain" > , & < / span > < span class = "functiontext" > Configuration::bareword< / span > < span class = "plain" > )< / span >
< span class = "plain" > == < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ) < / span > < span class = "identifier" > exit< / span > < span class = "plain" > (0);< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP2" > § 2< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP3" > < / a > < b > § 3. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Configuration::switch< / span > < span class = "plain" > (< / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > id< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > val< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > arg< / span > < span class = "plain" > , < / span > < span class = "reserved" > void< / span > < span class = "plain" > *< / span > < span class = "identifier" > v_cl_state< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > settings_block< / span > < span class = "plain" > *< / span > < span class = "identifier" > settings< / span > < span class = "plain" > = ((< / span > < span class = "reserved" > cl_state< / span > < span class = "plain" > *) < / span > < span class = "identifier" > v_cl_state< / span > < span class = "plain" > )-< / span > < span class = "element" > > settings< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > switch< / span > < span class = "plain" > (< / span > < span class = "identifier" > id< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > VERBOSE_CLSW< / span > < span class = "plain" > : < / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > verbose_mode< / span > < span class = "plain" > = < / span > < span class = "identifier" > val< / span > < span class = "plain" > ; < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > TEST_INDEX_CLSW< / span > < span class = "plain" > : < / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > test_index_mode< / span > < span class = "plain" > = < / span > < span class = "identifier" > val< / span > < span class = "plain" > ; < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
2020-01-26 01:42:42 +02:00
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > XREFS_CLSW< / span > < span class = "plain" > : < / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > xrefs_filename< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Filenames::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > ); < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > FROM_CLSW< / span > < span class = "plain" > : < / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > book_folder< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Pathnames::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > ); < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > TO_CLSW< / span > < span class = "plain" > : < / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > destination< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Pathnames::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > );< / span >
< span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > destination_modifiable< / span > < span class = "plain" > = < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ; < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
2019-06-26 11:05:27 +03:00
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > INSERTION_CLSW< / span > < span class = "plain" > : < / span > < span class = "identifier" > settings< / span > < span class = "plain" > -< / span > < span class = "element" > > insertion_filename< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Filenames::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > ); < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< span class = "reserved" > case< / span > < span class = "plain" > < / span > < span class = "constant" > INSTRUCTIONS_CLSW< / span > < span class = "plain" > : < / span > < span class = "functiontext" > Configuration::add_instructions_file< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Filenames::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > )); < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > default< / span > < span class = "plain" > : < / span > < span class = "identifier" > internal_error< / span > < span class = "plain" > (< / span > < span class = "string" > "unimplemented switch"< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Configuration::bareword< / span > < span class = "plain" > (< / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > id< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > opt< / span > < span class = "plain" > , < / span > < span class = "reserved" > void< / span > < span class = "plain" > *< / span > < span class = "identifier" > v_cl_state< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > cl_state< / span > < span class = "plain" > *< / span > < span class = "identifier" > state< / span > < span class = "plain" > = (< / span > < span class = "reserved" > cl_state< / span > < span class = "plain" > *) < / span > < span class = "identifier" > v_cl_state< / span > < span class = "plain" > ;< / span >
< span class = "functiontext" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > state< / span > < span class = "plain" > -< / span > < span class = "element" > > target_chosen< / span > < span class = "plain" > , < / span > < span class = "identifier" > opt< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Configuration::switch is used in < a href = "#SP2_2" > § 2.2< / a > .< / p >
< p class = "endnote" > The function Configuration::bareword is used in < a href = "#SP2_2" > § 2.2< / a > .< / p >
< hr class = "tocbar" >
< ul class = "toc" > < li > < a href = "1-mn.html" > Back to 'Main'< / a > < / li > < li > < a href = "1-ins.html" > Continue with 'Instructions'< / a > < / li > < / ul > < hr class = "tocbar" >
2019-04-22 17:42:10 +03:00
<!-- End of weave -->
2019-03-17 14:40:57 +02:00
< / body >
< / html >