2019-02-04 22:26:45 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > 1/cnf< / 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 >
2019-02-09 12:33:40 +00:00
<!-- Weave of '1/ptt' generated by 7 -->
2019-02-04 22:26:45 +00:00
< ul class = "crumbs" > < li > < a href = "../webs.html" > ★ < / a > < / li > < li > < a href = "index.html" > inweb 7< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Top Level< / a > < / li > < li > < b > Patterns< / b > < / li > < / ul > < p class = "purpose" > Managing weave patterns, which are bundled configuration settings for weaving.< / p >
< ul class = "toc" > < li > < a href = "#SP1" > § 1. Reading in< / a > < / li > < li > < a href = "#SP5" > § 5. Obtaining files< / a > < / li > < / ul > < hr class = "tocbar" >
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. Reading in. < / b > Patterns are stored as directories in the file system, and are identified by
names such as < code class = "display" > < span class = "extract" > HTML< / span > < / code > . On request, we need to find the directory corresponding
to such a name, and to read it in. This structure holds the result:
< / p >
< pre class = "display" >
< span class = "reserved" > typedef< / span > < span class = "plain" > < / span > < span class = "reserved" > struct weave_pattern< / 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" > pattern_name< / span > < span class = "plain" > ; < / span > < span class = "comment" > such as < code class = "display" > < span class = "extract" > HTML< / span > < / code > < / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > pattern_location< / span > < span class = "plain" > ; < / span > < span class = "comment" > the directory< / span >
< span class = "reserved" > struct weave_pattern< / span > < span class = "plain" > *< / span > < span class = "identifier" > based_on< / span > < span class = "plain" > ; < / span > < span class = "comment" > inherit from which other pattern?< / span >
< span class = "reserved" > struct weave_format< / span > < span class = "plain" > *< / span > < span class = "identifier" > pattern_format< / span > < span class = "plain" > ; < / span > < span class = "comment" > such as < code class = "display" > < span class = "extract" > DVI< / span > < / code > : the desired final format< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > linked_list< / span > < span class = "plain" > *< / span > < span class = "identifier" > payloads< / span > < span class = "plain" > ; < / span > < span class = "comment" > of < code class = "display" > < span class = "extract" > text_stream< / span > < / code > : leafnames of associated files< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > tex_command< / span > < span class = "plain" > ; < / span > < span class = "comment" > shell command to use for < code class = "display" > < span class = "extract" > tex< / span > < / code > < / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > pdftex_command< / span > < span class = "plain" > ; < / span > < span class = "comment" > shell command to use for < code class = "display" > < span class = "extract" > pdftex< / span > < / code > < / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > open_command< / span > < span class = "plain" > ; < / span > < span class = "comment" > shell command to use for < code class = "display" > < span class = "extract" > open< / span > < / code > < / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > embed_CSS< / span > < span class = "plain" > ; < / span > < span class = "comment" > embed CSS directly into any HTML files made?< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > show_abbrevs< / span > < span class = "plain" > ; < / span > < span class = "comment" > show section range abbreviations in the weave?< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > number_sections< / span > < span class = "plain" > ; < / span > < span class = "comment" > insert section numbers into the weave?< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > default_range< / span > < span class = "plain" > ; < / span > < span class = "comment" > for example, < code class = "display" > < span class = "extract" > sections< / span > < / code > < / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > web< / span > < span class = "plain" > *< / span > < span class = "identifier" > patterned_for< / span > < span class = "plain" > ; < / span > < span class = "comment" > the web which caused this to be read in< / span >
< span class = "constant" > MEMORY_MANAGEMENT< / span >
< span class = "plain" > }< / span > < span class = "reserved" > weave_pattern< / span > < span class = "plain" > ;< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The structure weave_pattern is accessed in 1/pc, 3/ts, 3/ti, 3/tw, 5/wf, 5/tf, 5/rtt and here.< / p >
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. < / b > When a given web needs a pattern with a given name, this is where it comes.
< / p >
< pre class = "display" >
< span class = "reserved" > weave_pattern< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Patterns::find< / span > < span class = "plain" > (< / span > < span class = "reserved" > web< / span > < span class = "plain" > *< / span > < span class = "identifier" > W< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > name< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > pattern_file< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > weave_pattern< / span > < span class = "plain" > *< / span > < span class = "identifier" > wp< / span > < span class = "plain" > = < / span > < span class = "identifier" > CREATE< / span > < span class = "reserved" > (weave_pattern< / span > < span class = "plain" > );< / span >
< < span class = "cwebmacro" > Initialise the pattern structure< / span > < span class = "cwebmacronumber" > 2.1< / span > > < span class = "plain" > ;< / span >
< < span class = "cwebmacro" > Locate the pattern directory< / span > < span class = "cwebmacronumber" > 2.2< / span > > < span class = "plain" > ;< / span >
< < span class = "cwebmacro" > Read in the pattern.txt file< / span > < span class = "cwebmacronumber" > 2.3< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > wp< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Patterns::find is used in < a href = "#SP3_1" > § 3.1< / a > , 1/pc (< a href = "1-pc.html#SP7_2_3" > § 7.2.3< / a > ).< / p >
< p class = "inwebparagraph" > < a id = "SP2_1" > < / a > < b > § 2.1. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Initialise the pattern structure< / span > < span class = "cwebmacronumber" > 2.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_name< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > name< / span > < span class = "plain" > );< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_location< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > payloads< / span > < span class = "plain" > = < / span > < span class = "identifier" > NEW_LINKED_LIST< / span > < span class = "plain" > (< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > );< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > based_on< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > embed_CSS< / span > < span class = "plain" > = < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > patterned_for< / span > < span class = "plain" > = < / span > < span class = "identifier" > W< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > show_abbrevs< / span > < span class = "plain" > = < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > number_sections< / span > < span class = "plain" > = < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > default_range< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > I< / span > < span class = "string" > "0"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > tex_command< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > I< / span > < span class = "string" > "tex"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pdftex_command< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > I< / span > < span class = "string" > "pdftex"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > open_command< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > I< / span > < span class = "string" > "open"< / span > < span class = "plain" > );< / 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 = "SP2_2" > < / a > < b > § 2.2. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Locate the pattern directory< / span > < span class = "cwebmacronumber" > 2.2< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_location< / span > < span class = "plain" > =< / span >
< span class = "functiontext" > Pathnames::subfolder< / span > < span class = "plain" > (< / span >
< span class = "functiontext" > Pathnames::subfolder< / span > < span class = "plain" > (< / span > < span class = "identifier" > W< / span > < span class = "plain" > -< / span > < span class = "element" > > path_to_web< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "Patterns"< / span > < span class = "plain" > ),< / span >
< span class = "identifier" > name< / span > < span class = "plain" > );< / span >
< span class = "identifier" > pattern_file< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_location< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "pattern.txt"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern_file< / span > < span class = "plain" > ) == < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_location< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Pathnames::subfolder< / span > < span class = "plain" > (< / span > < span class = "identifier" > path_to_inweb_patterns< / span > < span class = "plain" > , < / span > < span class = "identifier" > name< / span > < span class = "plain" > );< / span >
< span class = "identifier" > pattern_file< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_location< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "pattern.txt"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern_file< / span > < span class = "plain" > ) == < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > )< / span >
< span class = "functiontext" > Errors::fatal_with_text< / span > < span class = "plain" > (< / span > < span class = "string" > "no such weave pattern as '%S'"< / span > < span class = "plain" > , < / span > < span class = "identifier" > name< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / 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 = "SP2_3" > < / a > < b > § 2.3. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Read in the pattern.txt file< / span > < span class = "cwebmacronumber" > 2.3< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern_file< / span > < span class = "plain" > )< / span >
< span class = "functiontext" > TextFiles::read< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern_file< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > , < / span > < span class = "string" > "can't open pattern.txt file"< / span > < span class = "plain" > ,< / span >
< span class = "constant" > TRUE< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Patterns::scan_pattern_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "identifier" > wp< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_format< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > )< / span >
< span class = "functiontext" > Errors::fatal_with_text< / span > < span class = "plain" > (< / span > < span class = "string" > "pattern did not specify a format"< / span > < span class = "plain" > , < / span > < span class = "identifier" > name< / span > < span class = "plain" > );< / 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 > The Foundation module provides a standard way to scan text files line by
line, and this is used to send each line in the < code class = "display" > < span class = "extract" > pattern.txt< / span > < / code > file to the
following routine:
< / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Patterns::scan_pattern_line< / span > < span class = "plain" > (< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_file_position< / span > < span class = "plain" > *< / span > < span class = "identifier" > tfp< / span > < span class = "plain" > , < / span > < span class = "reserved" > void< / span > < span class = "plain" > *< / span > < span class = "identifier" > X< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > weave_pattern< / span > < span class = "plain" > *< / span > < span class = "identifier" > wp< / span > < span class = "plain" > = < / span > < span class = "reserved" > (weave_pattern< / span > < span class = "plain" > *) < / span > < span class = "identifier" > X< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > match_results< / span > < span class = "plain" > < / span > < span class = "identifier" > mr< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Regexp::create_mr< / span > < span class = "plain" > ();< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *from (%c+)"< / span > < span class = "plain" > )) < / span > < < span class = "cwebmacro" > This is a from command< / span > < span class = "cwebmacronumber" > 3.1< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *(%c+?) = (%c+)"< / span > < span class = "plain" > )) < / span > < < span class = "cwebmacro" > This is an X = Y command< / span > < span class = "cwebmacronumber" > 3.2< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *embed css *"< / span > < span class = "plain" > )) < / span > < < span class = "cwebmacro" > This is an embed CSS command< / span > < span class = "cwebmacronumber" > 3.3< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *use (%c+)"< / span > < span class = "plain" > )) < / span > < < span class = "cwebmacro" > This is a use command< / span > < span class = "cwebmacronumber" > 3.4< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *%C%c*"< / span > < span class = "plain" > ))< / span >
< span class = "functiontext" > Errors::in_text_file< / span > < span class = "plain" > (< / span > < span class = "string" > "unrecognised pattern command"< / span > < span class = "plain" > , < / span > < span class = "identifier" > tfp< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Patterns::scan_pattern_line is used in < a href = "#SP2_3" > § 2.3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP3_1" > < / a > < b > § 3.1. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > This is a from command< / span > < span class = "cwebmacronumber" > 3.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > based_on< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Patterns::find< / span > < span class = "plain" > (< / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > patterned_for< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0]);< / span >
< span class = "functiontext" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP3" > § 3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP3_2" > < / a > < b > § 3.2. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > This is an X = Y command< / span > < span class = "cwebmacronumber" > 3.2< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "format"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_format< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Formats::find_by_name< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "abbrevs"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > show_abbrevs< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Patterns::yes_or_no< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1], < / span > < span class = "identifier" > tfp< / span > < span class = "plain" > );< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "numbered"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > number_sections< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Patterns::yes_or_no< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1], < / span > < span class = "identifier" > tfp< / span > < span class = "plain" > );< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "default-range"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > default_range< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "tex-command"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > tex_command< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "pdftex-command"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > pdftex_command< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "open-command"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > open_command< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "functiontext" > Bibliographic::data_exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > patterned_for< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0])) ||< / span >
< span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > I< / span > < span class = "string" > "Booklet Title"< / span > < span class = "plain" > ))) {< / span >
< span class = "functiontext" > Bibliographic::set_datum< / span > < span class = "plain" > (< / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > patterned_for< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0], < / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
< span class = "identifier" > PRINT< / span > < span class = "plain" > (< / span > < span class = "string" > "Setting: %S\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0]);< / span >
< span class = "functiontext" > Errors::in_text_file< / span > < span class = "plain" > (< / span > < span class = "string" > "no such pattern setting"< / span > < span class = "plain" > , < / span > < span class = "identifier" > tfp< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "functiontext" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP3" > § 3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP3_3" > < / a > < b > § 3.3. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > This is an embed CSS command< / span > < span class = "cwebmacronumber" > 3.3< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > embed_CSS< / span > < span class = "plain" > = < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "functiontext" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP3" > § 3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP3_4" > < / a > < b > § 3.4. < / b > "Payloads" are associated files such as images which may be needed for an
HTML weave to look right. We identify them here only by leafname: their
actual location will depend on where the pattern directory is.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > This is a use command< / span > < span class = "cwebmacronumber" > 3.4< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > leafname< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > mr< / span > < span class = "element" > .exp< / span > < span class = "plain" > [0]);< / span >
< span class = "identifier" > ADD_TO_LINKED_LIST< / span > < span class = "plain" > (< / span > < span class = "identifier" > leafname< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > , < / span > < span class = "identifier" > wp< / span > < span class = "plain" > -< / span > < span class = "element" > > payloads< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP3" > § 3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP4" > < / a > < b > § 4. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "functiontext" > Patterns::yes_or_no< / 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" > text_file_position< / span > < span class = "plain" > *< / span > < span class = "identifier" > tfp< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "yes"< / span > < span class = "plain" > )) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Str::eq< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "no"< / span > < span class = "plain" > )) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "functiontext" > Errors::in_text_file< / span > < span class = "plain" > (< / span > < span class = "string" > "setting must be 'yes' or 'no'"< / span > < span class = "plain" > , < / span > < span class = "identifier" > tfp< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Patterns::yes_or_no is used in < a href = "#SP3_2" > § 3.2< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP5" > < / a > < b > § 5. Obtaining files. < / b > Patterns provide not merely some configuration settings (above): they also
provide template or style files of various kinds. When Inweb wants to find
a pattern file with a given leafname, it looks for it in the pattern
directory. If that fails, it then looks in the directory of the pattern
inherited from.
< / p >
< p class = "inwebparagraph" > Note that if you're rash enough to set up a cycle of patterns inheriting
from each other then this routine will lock up into an infinite loop.
< / p >
< pre class = "display" >
< span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Patterns::obtain_filename< / span > < span class = "reserved" > (weave_pattern< / span > < span class = "plain" > *< / span > < span class = "identifier" > pattern< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > leafname< / 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 = "functiontext" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern< / span > < span class = "plain" > -< / span > < span class = "element" > > pattern_location< / span > < span class = "plain" > , < / span > < span class = "identifier" > leafname< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > F< / span > < span class = "plain" > )) < / span > < span class = "reserved" > return< / 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" > pattern< / span > < span class = "plain" > -< / span > < span class = "element" > > based_on< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "functiontext" > Patterns::obtain_filename< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern< / span > < span class = "plain" > -< / span > < span class = "element" > > based_on< / span > < span class = "plain" > , < / span > < span class = "identifier" > leafname< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
2019-03-12 23:32:12 +00:00
< p class = "endnote" > The function Patterns::obtain_filename is used in < a href = "#SP6" > § 6< / a > , 3/ts (< a href = "3-ts.html#SP3" > § 3< / a > ), 3/ti (< a href = "3-ti.html#SP1" > § 1< / a > , < a href = "3-ti.html#SP2" > § 2< / a > , < a href = "3-ti.html#SP2_1_2" > § 2.1.2< / a > , < a href = "3-ti.html#SP4_1" > § 4.1< / a > ), 5/tf (< a href = "5-tf.html#SP3_1" > § 3.1< / a > ), 5/hf (< a href = "5-hf.html#SP6" > § 6< / a > , < a href = "5-hf.html#SP9" > § 9< / a > , < a href = "5-hf.html#SP27" > § 27< / a > ).< / p >
2019-02-04 22:26:45 +00:00
< p class = "inwebparagraph" > < a id = "SP6" > < / a > < b > § 6. < / b > When we eventually want to deal with the < code class = "display" > < span class = "extract" > use P< / span > < / code > commands, which call
for payloads to be copied into weave, we make good use of the above:
< / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Patterns::copy_payloads_into_weave< / span > < span class = "plain" > (< / span > < span class = "reserved" > web< / span > < span class = "plain" > *< / span > < span class = "identifier" > W< / span > < span class = "plain" > ,< / span > < span class = "reserved" > weave_pattern< / span > < span class = "plain" > *< / span > < span class = "identifier" > pattern< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > leafname< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > LOOP_OVER_LINKED_LIST< / span > < span class = "plain" > (< / span > < span class = "identifier" > leafname< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > , < / span > < span class = "identifier" > pattern< / span > < span class = "plain" > -< / span > < span class = "element" > > payloads< / 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 = "functiontext" > Patterns::obtain_filename< / span > < span class = "plain" > (< / span > < span class = "identifier" > pattern< / span > < span class = "plain" > , < / span > < span class = "identifier" > leafname< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Patterns::copy_file_into_weave< / span > < span class = "plain" > (< / span > < span class = "identifier" > W< / 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" > W< / span > < span class = "plain" > -< / span > < span class = "element" > > as_ebook< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > rel< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "identifier" > leafname< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Epub::note_image< / span > < span class = "plain" > (< / span > < span class = "identifier" > W< / span > < span class = "plain" > -< / span > < span class = "element" > > as_ebook< / span > < span class = "plain" > , < / span > < span class = "identifier" > rel< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Patterns::copy_payloads_into_weave is used in 3/ts (< a href = "3-ts.html#SP3" > § 3< / a > ).< / p >
< p class = "inwebparagraph" > < a id = "SP7" > < / a > < b > § 7. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Patterns::copy_file_into_weave< / span > < span class = "plain" > (< / span > < span class = "reserved" > web< / span > < span class = "plain" > *< / span > < span class = "identifier" > W< / 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" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > H< / span > < span class = "plain" > = < / span > < span class = "identifier" > W< / span > < span class = "plain" > -< / span > < span class = "element" > > redirect_weaves_to< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > H< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > H< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Reader::woven_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > W< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Shell::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "identifier" > H< / span > < span class = "plain" > , < / span > < span class = "string" > ""< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Patterns::copy_file_into_weave is used in < a href = "#SP6" > § 6< / a > , 5/hf (< a href = "5-hf.html#SP6" > § 6< / a > , < a href = "5-hf.html#SP9" > § 9< / a > , < a href = "5-hf.html#SP15" > § 15< / a > ).< / p >
2019-03-12 23:32:12 +00:00
< hr class = "tocbar" >
< ul class = "toc" > < li > < a href = "1-cnf.html" > Back to 'Configuration'< / a > < / li > < li > < i > (This section ends Chapter 1: Top Level.)< / i > < / li > < / ul > < hr class = "tocbar" >
2019-03-18 11:16:10 +00:00
<!-- End of weave -->
2019-02-04 22:26:45 +00:00
< / body >
< / html >