2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-14 19:56:54 +03:00
< title > Identifiers< / title >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-03-17 14:40:57 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-03-19 02:11:25 +02:00
< link href = "../inweb.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-14 19:56:54 +03:00
2019-03-17 14:40:57 +02:00
< / head >
< body >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2020-04-14 19:56:54 +03:00
< h1 > < a href = "../index.html" >
< img src = "../docs-src/Figures/Inform.png" height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../compiler.html" > compiler tools< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../other.html" > other tools< / a > < / li >
< li > < a href = "../extensions.html" > extensions and kits< / a > < / li >
< li > < a href = "../units.html" > unit test tools< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Compiler Webs< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inbuild/index.html" > inbuild< / a > < / li >
< li > < a href = "../inform7/index.html" > inform7< / a > < / li >
< li > < a href = "../inter/index.html" > inter< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inbuild Modules< / h2 > < ul >
< li > < a href = "../supervisor-module/index.html" > supervisor< / a > < / li >
< / ul > < h2 > Inform7 Modules< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../core-module/index.html" > core< / a > < / li >
< li > < a href = "../inflections-module/index.html" > inflections< / a > < / li >
< li > < a href = "../linguistics-module/index.html" > linguistics< / a > < / li >
< li > < a href = "../kinds-module/index.html" > kinds< / a > < / li >
< li > < a href = "../if-module/index.html" > if< / a > < / li >
< li > < a href = "../multimedia-module/index.html" > multimedia< / a > < / li >
2020-04-14 19:56:54 +03:00
< li > < a href = "../problems-module/index.html" > problems< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../index-module/index.html" > index< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inter Modules< / h2 > < ul >
< li > < a href = "../bytecode-module/index.html" > bytecode< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../building-module/index.html" > building< / a > < / li >
< li > < a href = "../codegen-module/index.html" > codegen< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Shared Modules< / h2 > < ul >
< li > < a href = "../arch-module/index.html" > arch< / a > < / li >
< li > < a href = "../syntax-module/index.html" > syntax< / a > < / li >
< li > < a href = "index.html" > < span class = "selectedlink" > words< / span > < / a > < / li >
< li > < a href = "../html-module/index.html" > html< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2020-04-14 19:56:54 +03:00
<!-- Weave of 'Identifiers' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../compiler.html" > Shared Modules< / a > < / li > < li > < a href = "index.html" > words< / a > < / li > < li > < a href = "index.html#3" > Chapter 3: Words in Sequence< / a > < / li > < li > < b > Identifiers< / b > < / li > < / ul > < p class = "purpose" > To represent snippets of natural language in identifier form, which a typical C-like compiler would accept.< / p >
2019-03-17 14:40:57 +02:00
2020-04-16 01:49:59 +03:00
< ul class = "toc" > < li > < a href = "3-idn.html#SP1" > § 1. Validity of identifiers< / a > < / li > < li > < a href = "3-idn.html#SP3" > § 3. Automatically composed identifiers< / a > < / li > < / ul > < hr class = "tocbar" >
2019-03-17 14:40:57 +02:00
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. Validity of identifiers. < / b > In code compiled by I7, a valid identifier is a sequence of 1 to 31 characters,
which must be alphanumeric or else underscores, except that the leading
character must not be a 0:
< / p >
< pre class = "display" >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "functiontext" > Identifiers::valid< button class = "popup" onclick = "togglePopup('usagePopup127')" > ...< span class = "popuptext" id = "usagePopup127" > Usage of < b > Identifiers::valid< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > wchar_t< / span > < span class = "plain" > *< / span > < span class = "identifier" > p< / span > < span class = "plain" > ) {< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > Wide::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > p< / span > < span class = "plain" > ) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) || (< / span > < span class = "identifier" > Wide::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > p< / span > < span class = "plain" > ) > < / span > < span class = "constant" > 31< / span > < span class = "plain" > )) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< span class = "reserved" > for< / span > < span class = "plain" > (< / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > i< / span > < span class = "plain" > =0; < / span > < span class = "identifier" > p< / span > < span class = "plain" > [< / span > < span class = "identifier" > i< / span > < span class = "plain" > ]; < / span > < span class = "identifier" > i< / span > < span class = "plain" > ++)< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > Characters::isdigit< / span > < span class = "plain" > (< / span > < span class = "identifier" > p< / span > < span class = "plain" > [< / span > < span class = "identifier" > i< / span > < span class = "plain" > ]) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > Characters::isalpha< / span > < span class = "plain" > (< / span > < span class = "identifier" > p< / span > < span class = "plain" > [< / span > < span class = "identifier" > i< / span > < span class = "plain" > ]) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > p< / span > < span class = "plain" > [< / span > < span class = "identifier" > i< / span > < span class = "plain" > ] != < / span > < span class = "character" > '_'< / span > < span class = "plain" > ))< / span >
2019-03-17 14:40:57 +02:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Characters::isdigit< / span > < span class = "plain" > (< / span > < span class = "identifier" > p< / span > < span class = "plain" > [0])) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
2019-04-17 20:19:03 +03:00
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. < / b > The following flattens characters into shape:
< / p >
< pre class = "display" >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Identifiers::purify< button class = "popup" onclick = "togglePopup('usagePopup128')" > ...< span class = "popuptext" id = "usagePopup128" > Usage of < b > Identifiers::purify< / b > :< br > < a href = "3-idn.html#SP3" > § 3< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > ) {< / span >
2019-04-17 20:19:03 +03:00
< span class = "identifier" > LOOP_THROUGH_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > pos< / span > < span class = "plain" > , < / span > < span class = "identifier" > identifier< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > x< / span > < span class = "plain" > = < / span > < span class = "identifier" > Str::get< / span > < span class = "plain" > (< / span > < span class = "identifier" > pos< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (!(((< / span > < span class = "identifier" > x< / span > < span class = "plain" > > = < / span > < span class = "character" > '0'< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > x< / span > < span class = "plain" > < = < / span > < span class = "character" > '9'< / span > < span class = "plain" > )) ||< / span >
< span class = "plain" > ((< / span > < span class = "identifier" > x< / span > < span class = "plain" > > = < / span > < span class = "character" > 'a'< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > x< / span > < span class = "plain" > < = < / span > < span class = "character" > 'z'< / span > < span class = "plain" > )) || ((< / span > < span class = "identifier" > x< / span > < span class = "plain" > > = < / span > < span class = "character" > 'A'< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > x< / span > < span class = "plain" > < = < / span > < span class = "character" > 'Z'< / span > < span class = "plain" > )) || (< / span > < span class = "identifier" > x< / span > < span class = "plain" > == < / span > < span class = "character" > '_'< / span > < span class = "plain" > )))< / span >
< span class = "identifier" > Str::put< / span > < span class = "plain" > (< / span > < span class = "identifier" > pos< / span > < span class = "plain" > , < / span > < span class = "character" > '_'< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP3" > < / a > < b > § 3. Automatically composed identifiers. < / b > The following routines are no longer used by Inform, but retained in case
useful for other projects.
< / p >
< p class = "inwebparagraph" > The idea here is that we want an identifier based on a natural language
wording, but which passed the above validity tests, and which does not lead
tp namespace collisions. Such identifiers are composed in a pattern which
2019-03-17 14:40:57 +02:00
uses an identifying letter (e.g., A for Action), a unique ID number
(preventing name-clashes) and then a truncated alphanumeric-safe form of
the words used in the textual description, if any. For example, an object
called "apple crumble" might have identifier < code class = "display" > < span class = "extract" > O100_apple_crumble< / span > < / code > . Any
other object also called "apple crumble" would have a different identifier
since the number parts would be different.
< / p >
< p class = "inwebparagraph" > Beginning with the identifying letter ensures that we do not open with
a 0 digit.
< / p >
< p class = "inwebparagraph" > We truncate to 28 characters in length so that other routines can
concatenate our identifier with up to 3 further characters, if they choose.
< / p >
< pre class = "display" >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Identifiers::compose< button class = "popup" onclick = "togglePopup('usagePopup129')" > ...< span class = "popuptext" id = "usagePopup129" > Usage of < b > Identifiers::compose< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > nature_character< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > id_number< / span > < span class = "plain" > , < / span > < span class = "reserved" > wording< / span > < span class = "plain" > < / span > < span class = "identifier" > W< / span > < span class = "plain" > ) {< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > Str::clear< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "string" > "%c%d"< / span > < span class = "plain" > , < / span > < span class = "identifier" > nature_character< / span > < span class = "plain" > , < / span > < span class = "identifier" > id_number< / span > < span class = "plain" > );< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "3-wrd.html#SP12" > Wordings::nonempty< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > W< / span > < span class = "plain" > )) {< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > LOOP_THROUGH_WORDING< / span > < span class = "plain" > (< / span > < span class = "identifier" > j< / span > < span class = "plain" > , < / span > < span class = "identifier" > W< / span > < span class = "plain" > ) {< / span >
2020-04-14 19:56:54 +03:00
< span class = "comment" > identifier is at this point 32 chars or fewer in length: add at most 30 more< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Wide::len< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "3-lxr.html#SP18" > Lexer::word_text< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > j< / span > < span class = "plain" > )) > < / span > < span class = "constant" > 30< / span > < span class = "plain" > )< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "string" > " etc"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "string" > " %N"< / span > < span class = "plain" > , < / span > < span class = "identifier" > j< / span > < span class = "plain" > );< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > ) > < / span > < span class = "constant" > 32< / span > < span class = "plain" > ) < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > Str::truncate< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "constant" > 28< / span > < span class = "plain" > ); < / span > < span class = "comment" > it was at worst 62 chars in size, but is now truncated to 28< / span >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "3-idn.html#SP2" > Identifiers::purify< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "plain" > }< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Identifiers::compose_numberless< button class = "popup" onclick = "togglePopup('usagePopup130')" > ...< span class = "popuptext" id = "usagePopup130" > Usage of < b > Identifiers::compose_numberless< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > prefix< / span > < span class = "plain" > , < / span > < span class = "reserved" > wording< / span > < span class = "plain" > < / span > < span class = "identifier" > W< / span > < span class = "plain" > ) {< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "identifier" > prefix< / span > < span class = "plain" > );< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "3-wrd.html#SP12" > Wordings::nonempty< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > W< / span > < span class = "plain" > )) {< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > LOOP_THROUGH_WORDING< / span > < span class = "plain" > (< / span > < span class = "identifier" > j< / span > < span class = "plain" > , < / span > < span class = "identifier" > W< / span > < span class = "plain" > ) {< / span >
2020-04-14 19:56:54 +03:00
< span class = "comment" > identifier is at this point 32 chars or fewer in length: add at most 30 more< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Wide::len< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "3-lxr.html#SP18" > Lexer::word_text< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > j< / span > < span class = "plain" > )) > < / span > < span class = "constant" > 30< / span > < span class = "plain" > )< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "string" > " etc"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "string" > " %N"< / span > < span class = "plain" > , < / span > < span class = "identifier" > j< / span > < span class = "plain" > );< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > ) > < / span > < span class = "constant" > 32< / span > < span class = "plain" > ) < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > Str::truncate< / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > , < / span > < span class = "constant" > 28< / span > < span class = "plain" > ); < / span > < span class = "comment" > it was at worst 62 chars in size, but is now truncated to 28< / span >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "3-idn.html#SP2" > Identifiers::purify< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > identifier< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< hr class = "tocbar" >
< ul class = "toc" > < li > < a href = "3-fds.html" > Back to 'Feeds'< / a > < / li > < li > < i > (This section ends Chapter 3: Words in Sequence.)< / i > < / li > < / ul > < hr class = "tocbar" >
2019-04-22 17:42:10 +03:00
<!-- End of weave -->
2020-04-14 19:56:54 +03:00
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >
