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 >
2020-04-08 22:41:00 +00:00
< title > Paragraph Macros< / title >
2020-04-23 22:23:44 +00:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 00:03:04 +00:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-02-04 22:26:45 +00:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-04-20 22:26:08 +00:00
2020-05-02 22:50:23 +00:00
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-30 22:36:38 +00:00
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-25 10:33:39 +00:00
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-20 22:26:08 +00:00
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-21 16:55:17 +00:00
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-23 22:23:44 +00:00
2019-02-04 22:26:45 +00:00
< / head >
2020-04-25 10:33:39 +00:00
< body class = "commentary-font" >
2020-03-19 00:03:04 +00:00
< nav role = "navigation" >
2020-04-13 16:06:45 +00:00
< h1 > < a href = "../index.html" >
2020-04-20 22:26:08 +00:00
< img src = "../docs-assets/Octagram.png" width = 72 height = 72" >
2020-04-13 16:06:45 +00:00
< / a > < / h1 >
< ul > < li > < a href = "index.html" > < span class = "selectedlink" > inweb< / span > < / a > < / li >
< / ul > < h2 > Foundation Module< / h2 > < ul >
< li > < a href = "../foundation-module/index.html" > foundation< / a > < / li >
2020-03-19 00:03:04 +00:00
< li > < a href = "../foundation-test/index.html" > foundation-test< / a > < / li >
2020-04-13 16:06:45 +00:00
< / ul > < h2 > Example Webs< / h2 > < ul >
2020-04-12 16:24:23 +00:00
< li > < a href = "../goldbach/index.html" > goldbach< / a > < / li >
< li > < a href = "../twinprimes/twinprimes.html" > twinprimes< / a > < / li >
2020-04-15 22:45:08 +00:00
< li > < a href = "../eastertide/index.html" > eastertide< / a > < / li >
2020-04-14 17:36:42 +00:00
< / ul > < h2 > Repository< / h2 > < ul >
2020-04-20 22:34:44 +00:00
< li > < a href = "https://github.com/ganelson/inweb" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
2020-04-14 17:36:42 +00:00
< / ul > < h2 > Related Projects< / h2 > < ul >
< li > < a href = "../../../inform/docs/index.html" > inform< / a > < / li >
< li > < a href = "../../../intest/docs/index.html" > intest< / a > < / li >
2020-03-19 00:03:04 +00:00
2020-04-13 16:06:45 +00:00
< / ul >
2020-03-19 00:03:04 +00:00
< / nav >
< main role = "main" >
2020-04-23 22:23:44 +00:00
<!-- Weave of 'Paragraph Macros' generated by Inweb -->
2020-04-30 22:36:38 +00:00
< div class = "breadcrumbs" >
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "index.html" > inweb< / a > < / li > < li > < a href = "index.html#2" > Chapter 2: Parsing a Web< / a > < / li > < li > < b > Paragraph Macros< / b > < / li > < / ul > < / div >
< p class = "purpose" > To manage the set of named paragraph macros in a section.< / p >
2019-02-04 22:26:45 +00:00
2020-04-15 22:45:08 +00:00
< ul class = "toc" > < li > < a href = "2-pm.html#SP3" > § 3. Paragraph macro search< / a > < / li > < / ul > < hr class = "tocbar" >
2019-02-04 22:26:45 +00:00
2020-04-24 23:06:02 +00:00
< p class = "commentary firstcommentary" > < a id = "SP1" > < / a > < b > § 1. < / b > We store these like so:
2019-02-04 22:26:45 +00:00
< / p >
2020-04-25 10:33:39 +00:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-04-21 16:55:17 +00:00
< span class = "reserved-syntax" > typedef< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > {< / span >
2020-04-24 23:06:02 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > macro_name< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > usually long, like "Create a paragraph macro here"< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > paragraph< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > defining_paragraph< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > as printed in small type after the name in any usage< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > source_line< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > defn_start< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > it ends at the end of its defining paragraph< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > linked_list< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > macro_usages< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > of < / span > < span class = "extract" > < span class = "extract-syntax" > macro_usage< / span > < / span > < span class = "comment-syntax" > : only computed for weaves< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "constant-syntax" > MEMORY_MANAGEMENT< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > ;< / span >
2020-04-24 10:26:18 +00:00
< / pre >
< ul class = "endnotetexts" > < li > The structure para_macro is accessed in 2/pn, 3/tw, 3/tt, 5/ptf, 5/tf, 5/hf, 5/df and here.< / li > < / ul >
2020-04-24 23:06:02 +00:00
< p class = "commentary firstcommentary" > < a id = "SP2" > < / a > < b > § 2. < / b > Each section has its own linked list of paragraph macros, since the scope for
2019-02-04 22:26:45 +00:00
the usage of these is always a single section.
< / p >
2020-04-25 10:33:39 +00:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-04-27 22:43:23 +00:00
< span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Macros::create< / span > < button class = "popup" onclick = "togglePopup('usagePopup1')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup1" > Usage of < span class = "code-font" > < span class = "function-syntax" > Macros::create< / span > < / span > :< br / > The Parser - < a href = "2-tp.html#SP1_1_7_4" > § 1.1.7.4< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > section< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > S< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > paragraph< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > source_line< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > CREATE< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > macro_name< / span > < span class = "plain-syntax" > = < / span > < a href = "../foundation-module/4-sm.html#SP3" class = "function-link" > < span class = "function-syntax" > Str::duplicate< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > defining_paragraph< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > defines_macro< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > defn_start< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > next_line< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > macro_usages< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NEW_LINKED_LIST< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > macro_usage< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ADD_TO_LINKED_LIST< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > S< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > macros< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2020-04-24 10:26:18 +00:00
< / pre >
2020-04-24 23:06:02 +00:00
< p class = "commentary firstcommentary" > < a id = "SP3" > < / a > < b > § 3. Paragraph macro search. < / b > The scope for looking up paragraph macro names is a single section, not the
2019-02-04 22:26:45 +00:00
entire web. So you can't expand a macro from another section, but then again,
you can use the same macro name twice in different sections; and lookup is
much faster.
< / p >
2020-04-25 10:33:39 +00:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-04-27 22:43:23 +00:00
< span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Macros::find_by_name< / span > < button class = "popup" onclick = "togglePopup('usagePopup2')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup2" > Usage of < span class = "code-font" > < span class = "function-syntax" > Macros::find_by_name< / span > < / span > :< br / > Paragraph Numbering - < a href = "2-pn.html#SP1_1" > § 1.1< / a > < br / > The Weaver - < a href = "3-tw.html#SP2_7_2_3_2_6" > § 2.7.2.3.2.6< / a > < br / > The Tangler - < a href = "3-tt.html#SP3_1" > § 3.1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > section< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > scope< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > LOOP_OVER_LINKED_LIST< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > para_macro< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > scope< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > macros< / span > < span class = "plain-syntax" > )< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "../foundation-module/4-sm.html#SP19" class = "function-link" > < span class = "function-syntax" > Str::eq< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > macro_name< / span > < span class = "plain-syntax" > ))< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pmac< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2020-04-24 10:26:18 +00:00
< / pre >
2020-04-30 22:36:38 +00:00
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "2-tp.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "M-iti.html" > M< / a > < / li > < li class = "progresschapter" > < a href = "P-htpw.html" > P< / a > < / li > < li class = "progresschapter" > < a href = "1-bsc.html" > 1< / a > < / li > < li class = "progresscurrentchapter" > 2< / li > < li class = "progresssection" > < a href = "2-tr.html" > tr< / a > < / li > < li class = "progresssection" > < a href = "2-lc.html" > lc< / a > < / li > < li class = "progresssection" > < a href = "2-tp.html" > tp< / a > < / li > < li class = "progresscurrent" > pm< / li > < li class = "progresssection" > < a href = "2-tgs.html" > tgs< / a > < / li > < li class = "progresssection" > < a href = "2-ec.html" > ec< / a > < / li > < li class = "progresssection" > < a href = "2-pn.html" > pn< / a > < / li > < li class = "progresschapter" > < a href = "3-ta.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-pl.html" > 4< / a > < / li > < li class = "progresschapter" > < a href = "5-wt.html" > 5< / a > < / li > < li class = "progresschapter" > < a href = "6-mkf.html" > 6< / a > < / li > < li class = "progressnext" > < a href = "2-tgs.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
2020-04-23 22:23:44 +00:00
2020-03-19 00:03:04 +00:00
< / main >
2019-02-04 22:26:45 +00:00
< / body >
< / html >