2020-05-30 16:33:19 +03:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > Lexicon< / title >
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< meta name = "viewport" content = "width=device-width initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< 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" >
< 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" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body class = "commentary-font" >
< nav role = "navigation" >
2022-04-28 19:37:28 +03:00
< h1 > < a href = "../index.html" >
2020-05-30 16:33:19 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
< / a > < / h1 >
2022-04-28 19:37:28 +03:00
< ul > < li > < a href = "../index.html" > home< / a > < / li >
2022-04-04 20:31:44 +03:00
< / ul > < h2 > Compiler< / h2 > < ul >
< li > < a href = "../structure.html" > structure< / a > < / li >
< li > < a href = "../inbuildn.html" > inbuild< / a > < / li >
< li > < a href = "../inform7n.html" > inform7< / a > < / li >
< li > < a href = "../intern.html" > inter< / a > < / li >
< li > < a href = "../services.html" > services< / a > < / li >
2022-04-18 17:46:46 +03:00
< li > < a href = "../secrets.html" > secrets< / a > < / li >
2022-04-04 20:31:44 +03:00
< / ul > < h2 > Other Tools< / h2 > < ul >
< li > < a href = "../inblorbn.html" > inblorb< / a > < / li >
< li > < a href = "../indocn.html" > indoc< / a > < / li >
< li > < a href = "../inform6.html" > inform6< / a > < / li >
< li > < a href = "../inpolicyn.html" > inpolicy< / a > < / li >
< li > < a href = "../inrtpsn.html" > inrtps< / a > < / li >
2022-04-12 14:32:28 +03:00
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
2022-04-04 20:31:44 +03:00
< / ul > < h2 > Repository< / h2 > < ul >
< li > < a href = "https://github.com/ganelson/inform" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
< / ul > < h2 > Related Projects< / h2 > < ul >
2022-04-28 19:20:06 +03:00
< li > < a href = "../../../inweb/index.html" > inweb< / a > < / li >
< li > < a href = "../../../intest/index.html" > intest< / a > < / li >
2020-05-30 16:33:19 +03:00
< / ul >
< / nav >
< main role = "main" >
<!-- Weave of 'Lexicon' generated by Inweb -->
< div class = "breadcrumbs" >
2022-04-28 19:37:28 +03:00
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../services.html" > Services< / a > < / li > < li > < a href = "index.html" > lexicon< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Setting Up< / a > < / li > < li > < b > Lexicon< / b > < / li > < / ul > < / div >
2020-05-30 16:33:19 +03:00
< p class = "purpose" > This section provides a simple API for storing and retrieving lexicon entries.< / p >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > The user creates new lexicon entries with:
2020-05-30 16:33:19 +03:00
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > excerpt_meaning< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Lexicon::register< / span > < span class = "plain-syntax" > (< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > unsigned< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > meaning_code< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > general_pointer< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > data< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > Wordings::empty< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > )) < / span > < span class = "identifier-syntax" > internal_error< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "tried to register empty excerpt meaning"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < a href = "2-em.html#SP12" class = "function-link" > < span class = "function-syntax" > ExcerptMeanings::register< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > meaning_code< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > data< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > < a href = "2-em.html#SP1" class = "internal" > excerpt_meaning< / a > objects are intended to be fairly opaque, but the user
2020-06-01 00:53:26 +03:00
can call this to extract their attached data:
2020-05-30 16:33:19 +03:00
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2020-07-03 01:09:26 +03:00
< span class = "identifier-syntax" > general_pointer< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Lexicon::get_data< / 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" > Lexicon::get_data< / span > < / span > :< br / > Parse Excerpts - < a href = "2-pe.html#SP7" > § 7< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > excerpt_meaning< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > em< / span > < span class = "plain-syntax" > ) {< / span >
2020-05-30 16:33:19 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > em< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > data< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. < / b > Entries can be retrieved either the regular way, or in "maximal mode",
2020-05-30 16:33:19 +03:00
which tries to parse a maximal-length initial portion of < span class = "extract" > < span class = "extract-syntax" > W< / span > < / span > rather than
necessarily the whole thing. For example, that mode might peel off the
adjective "fixed in place" from wording < span class = "extract" > < span class = "extract-syntax" > W< / span > < / span > which was "fixed in place door".
This is very much the exception: we almost always want to match the whole of < span class = "extract" > < span class = "extract-syntax" > W< / span > < / span > .
< / p >
< p class = "commentary" > It might seem symmetrical that the return value should be an < a href = "2-em.html#SP1" class = "internal" > excerpt_meaning< / a > .
But that wouldn't enable us to return multiple results in the (frequent) case
of ambiguity. Instead, we need to return a list of possibilities, and we do
that by returning fragment of syntax tree material, using the infrastructure
from < a href = "../syntax-module/index.html" class = "internal" > syntax< / a > . This will be a list of nodes joined by < span class = "extract" > < span class = "extract-syntax" > -> next_alternative< / span > < / span > limks.
< / p >
< p class = "commentary" > This list of nodes is disposable — even if it is a copy of something from the
syntax tree, it is never the only copy. It can freely be ignored or changed.
A return value of < span class = "extract" > < span class = "extract-syntax" > NULL< / span > < / span > means there were no results at all.
< / p >
< ul class = "items" > < li > ● If a meaning was registered in such a way that its < span class = "extract" > < span class = "extract-syntax" > data< / span > < / span > actually was a
node from the syntax tree, then the result is a copy of that node.
< / li > < li > ● If not then the result is a node with the meaning code as its node type,
and the excerpt meaning can be recovered from it using < span class = "extract" > < span class = "extract-syntax" > Node::get_meaning< / span > < / span > .
< / li > < / ul >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Lexicon::retrieve< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > unsigned< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > mc_bitmap< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < a href = "2-pe.html#SP5" class = "function-link" > < span class = "function-syntax" > FromLexicon::parse< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > mc_bitmap< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > lexicon_in_maximal_mode< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Lexicon::retrieve_longest_initial_segment< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > unsigned< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > mc_bitmap< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > lexicon_in_maximal_mode< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > lexicon_in_maximal_mode< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > = < / span > < a href = "2-pe.html#SP5" class = "function-link" > < span class = "function-syntax" > FromLexicon::parse< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > mc_bitmap< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > lexicon_in_maximal_mode< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > s< / 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" > p< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP4" class = "paragraph-anchor" > < / a > < b > § 4. < / b > As a bonus, since the lexicon uses quite a convenient hash-coding system
2020-05-30 16:33:19 +03:00
for excerpts, the following is available for anyone wanting to take advantage:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Lexicon::wording_hash< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < a href = "2-em.html#SP8" class = "function-link" > < span class = "function-syntax" > ExcerptMeanings::hash_code< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "1-lm.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresscurrentchapter" > 1< / li > < li class = "progresssection" > < a href = "1-lm.html" > lm< / a > < / li > < li class = "progresscurrent" > lxc< / li > < li class = "progresschapter" > < a href = "2-em.html" > 2< / a > < / li > < li class = "progressnext" > < a href = "2-em.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >