mirror of
https://github.com/ganelson/inform.git
synced 2024-07-08 10:04:21 +03:00
205 lines
19 KiB
HTML
205 lines
19 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>1/bsc</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/mn' 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>Main</b></li></ul><p class="purpose">The top level of the program.</p>
|
|
|
|
<ul class="toc"><li><a href="#SP1">§1. Nutshell</a></li><li><a href="#SP1_1">§1.1. Starting up</a></li><li><a href="#SP1_2">§1.2. First and second passes</a></li><li><a href="#SP1_6">§1.6. Shutting down</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. Nutshell. </b>We turn the source matter, "rawtext", into a batch of output files using the
|
|
chosen format, a process we'll call "rendering". We do this in two passes.
|
|
</p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">path_to_indoc</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span> <span class="comment">where we are installed</span>
|
|
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">path_to_indoc_materials</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span> <span class="comment">the materials pathname</span>
|
|
|
|
<span class="reserved">settings_block</span><span class="plain"> *</span><span class="identifier">indoc_settings</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">no_volumes</span><span class="plain"> = 0;</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">no_examples</span><span class="plain"> = 0;</span>
|
|
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">main</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="functiontext">Basics::start</span><span class="plain">();</span>
|
|
<<span class="cwebmacro">Start up indoc</span> <span class="cwebmacronumber">1.1</span>><span class="plain">;</span>
|
|
<<span class="cwebmacro">Make a first-pass scan of the rawtext</span> <span class="cwebmacronumber">1.2</span>><span class="plain">;</span>
|
|
<<span class="cwebmacro">Render the rawtext as documentation</span> <span class="cwebmacronumber">1.3</span>><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>html_for_Inform_application</span><span class="plain">)</span>
|
|
<<span class="cwebmacro">Work out cross-references for the in-application documentation only</span> <span class="cwebmacronumber">1.4</span>><span class="plain">;</span>
|
|
<<span class="cwebmacro">Produce the indexes</span> <span class="cwebmacronumber">1.5</span>><span class="plain">;</span>
|
|
<span class="functiontext">HTMLUtilities::copy_images</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>wrapper</span><span class="plain"> == </span><span class="constant">WRAPPER_epub</span><span class="plain">) {</span>
|
|
<span class="functiontext">HTMLUtilities::note_images</span><span class="plain">();</span>
|
|
<span class="functiontext">Scanner::mark_up_ebook</span><span class="plain">();</span>
|
|
<span class="functiontext">Epub::end_construction</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>ebook</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<<span class="cwebmacro">Shut down indoc</span> <span class="cwebmacronumber">1.6</span>><span class="plain">;</span>
|
|
<span class="functiontext">Basics::end</span><span class="plain">();</span>
|
|
<span class="reserved">return</span><span class="plain"> 0;</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function main is used in 2/haj (<a href="2-haj.html#SP24">§24</a>), 3/cai (<a href="3-cai.html#SP9_1">§9.1</a>).</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_1"></a><b>§1.1. Starting up. </b></p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Start up indoc</span> <span class="cwebmacronumber">1.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc [[Version Number]] (Inform Tools Suite)\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
|
|
<span class="functiontext">Nav::start</span><span class="plain">();</span>
|
|
<span class="functiontext">Symbols::start_up_symbols</span><span class="plain">();</span>
|
|
<span class="identifier">indoc_settings</span><span class="plain"> = </span><span class="functiontext">Instructions::clean_slate</span><span class="plain">();</span>
|
|
<span class="functiontext">Configuration::read_command_line</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">indoc_settings</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>wrapper</span><span class="plain"> == </span><span class="constant">WRAPPER_epub</span><span class="plain">) {</span>
|
|
<span class="functiontext">HTMLUtilities::image_URL</span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">,</span>
|
|
<span class="functiontext">Filenames::get_leafname</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>book_cover_image</span><span class="plain">));</span>
|
|
<span class="functiontext">Instructions::apply_ebook_metadata</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>ebook</span><span class="plain">);</span>
|
|
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">I</span><span class="plain"> = </span><span class="functiontext">Pathnames::from_text</span><span class="plain">(</span><span class="identifier">I</span><span class="string">"images"</span><span class="plain">);</span>
|
|
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">cover_in_situ</span><span class="plain"> = </span><span class="functiontext">Filenames::in_folder</span><span class="plain">(</span><span class="identifier">I</span><span class="plain">,</span>
|
|
<span class="functiontext">Filenames::get_leafname</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>book_cover_image</span><span class="plain">));</span>
|
|
<span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>destination</span><span class="plain"> = </span><span class="functiontext">Epub::begin_construction</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>ebook</span><span class="plain">,</span>
|
|
<span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>destination</span><span class="plain">, </span><span class="identifier">cover_in_situ</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">volume</span><span class="plain">) == 0) { </span><span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc: nothing to do\</span><span class="plain">n</span><span class="string">"</span><span class="plain">); </span><span class="identifier">exit</span><span class="plain">(0); }</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">problem_count</span><span class="plain"> > 0) </span><span class="identifier">exit</span><span class="plain">(1);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_2"></a><b>§1.2. First and second passes. </b>First we look ahead, so to speak, by scanning the examples we are going
|
|
to need to insert; then similarly to find the section titles. At this
|
|
point, nothing is being output.
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Make a first-pass scan of the rawtext</span> <span class="cwebmacronumber">1.2</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">volume</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">;</span>
|
|
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">volume</span><span class="plain">) </span><span class="functiontext">Scanner::scan_rawtext_for_section_titles</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>book_contains_examples</span><span class="plain">) </span><span class="functiontext">Examples::scan_examples</span><span class="plain">();</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_3"></a><b>§1.3. </b>We then work through each volume's rawtext file in turn, writing the output
|
|
section by section.
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Render the rawtext as documentation</span> <span class="cwebmacronumber">1.3</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) </span><span class="functiontext">CSS::write_CSS_files</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>css_source_file</span><span class="plain">);</span>
|
|
<span class="reserved">volume</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">;</span>
|
|
<span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">TO</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">volume</span><span class="plain">) </span><span class="identifier">TO</span><span class="plain"> = </span><span class="functiontext">Rawtext::process_large_rawtext_file</span><span class="plain">(</span><span class="identifier">TO</span><span class="plain">, </span><span class="identifier">V</span><span class="plain">);</span>
|
|
<span class="functiontext">Nav::render_navigation_contents_files</span><span class="plain">();</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_4"></a><b>§1.4. </b>The following functions here are for use only when compiling documentation
|
|
to go inside the Inform user interface application.
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Work out cross-references for the in-application documentation only</span> <span class="cwebmacronumber">1.4</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="functiontext">Scanner::write_manifest_file</span><span class="plain">(</span><span class="identifier">FIRST_OBJECT</span><span class="plain">(</span><span class="reserved">volume</span><span class="plain">));</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>definitions_filename</span><span class="plain">) </span><span class="functiontext">Updater::write_definitions_file</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>standard_rules_filename</span><span class="plain">)</span>
|
|
<span class="functiontext">Updater::rewrite_standard_rules_file</span><span class="plain">(</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>standard_rules_filename</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_5"></a><b>§1.5. </b>These are automatically generated.
|
|
</p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Produce the indexes</span> <span class="cwebmacronumber">1.5</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">indoc_settings</span><span class="plain">-</span><span class="element">>format</span><span class="plain"> == </span><span class="constant">HTML_FORMAT</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">no_examples</span><span class="plain"> > 0) {</span>
|
|
<span class="functiontext">ExamplesIndex::write_alphabetical_examples_index</span><span class="plain">();</span>
|
|
<span class="functiontext">ExamplesIndex::write_numerical_examples_index</span><span class="plain">();</span>
|
|
<span class="functiontext">ExamplesIndex::write_thematic_examples_index</span><span class="plain">();</span>
|
|
<span class="plain">}</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">index_lemma</span><span class="plain">) > 0) </span><span class="functiontext">Indexes::write_general_index</span><span class="plain">();</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_6"></a><b>§1.6. Shutting down. </b></p>
|
|
|
|
|
|
<p class="macrodefinition"><code class="display">
|
|
<<span class="cwebmacrodefn">Shut down indoc</span> <span class="cwebmacronumber">1.6</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">problem_count</span><span class="plain"> > 0) {</span>
|
|
<span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc: ended with error%s\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, (</span><span class="identifier">problem_count</span><span class="plain"> == 1)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">);</span>
|
|
<span class="identifier">exit</span><span class="plain">(1);</span>
|
|
<span class="plain">}</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">s</span><span class="plain"> = 0;</span>
|
|
<span class="reserved">volume</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">; </span><span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">volume</span><span class="plain">) </span><span class="identifier">s</span><span class="plain"> += </span><span class="identifier">V</span><span class="plain">-</span><span class="element">>vol_section_count</span><span class="plain">;</span>
|
|
<span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"indoc: done (%d volume%s, %d section%s, %d example%s)\</span><span class="plain">n</span><span class="string">"</span><span class="plain">,</span>
|
|
<span class="identifier">no_volumes</span><span class="plain">, (</span><span class="identifier">problem_count</span><span class="plain"> == 1)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">,</span>
|
|
<span class="identifier">s</span><span class="plain">, (</span><span class="identifier">s</span><span class="plain"> == 1)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">,</span>
|
|
<span class="identifier">no_examples</span><span class="plain">, (</span><span class="identifier">no_examples</span><span class="plain"> == 1)?</span><span class="string">""</span><span class="plain">:</span><span class="string">"s"</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="1-bsc.html">Back to 'Basics'</a></li><li><a href="1-cnf.html">Continue with 'Configuration'</a></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
</body>
|
|
</html>
|
|
|