ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-18 06:54:26 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/inter-module/3-ca.html
Graham Nelson 1ddf852361 Further work on independent assimilation
2019-09-01 11:50:12 +01:00

146 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>2/trn</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
<link href="inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body>
<!--Weave of '3/ca' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">inter</a></li><li><a href="index.html#3">Chapter 3: Language Definition</a></li><li><b>Canonical Annotations</b></li></ul><p class="purpose">Defining the one true set of Inter annotation codes.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b></p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">INVALID_IANN</span><span class="definitionkeyword"> from </span><span class="constant">0</span>
</pre>
<pre class="display">
<span class="definitionkeyword">enum</span> <span class="constant">PROPERTY_NAME_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">HEX_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">SIGNED_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">CALL_PARAMETER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">IMPLIED_CALL_PARAMETER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">ACTION_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">APPEND_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">ARROW_COUNT_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">ASSIMILATED_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">ATTRIBUTE_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">BIP_CODE_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">BUFFERARRAY_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">BYTEARRAY_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">DECLARATION_ORDER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">DELENDA_EST_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">EITHER_OR_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">ENCLOSING_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">FAKE_ACTION_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">OBJECT_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">HOLDING_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">INLINE_ARRAY_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">LATE_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">METAVERB_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">NOUN_FILTER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">OBJECT_KIND_COUNTER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">RTO_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">SCOPE_FILTER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">SOURCE_ORDER_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">STRINGARRAY_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">TABLEARRAY_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">VERBARRAY_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">WEAK_ID_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">EXPLICIT_ATTRIBUTE_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">EXPLICIT_VARIABLE_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">TEXT_LITERAL_IANN</span>
<span class="definitionkeyword">enum</span> <span class="constant">VENEER_IANN</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>And also the canonical set of bits to use in the flags word for an Inter
symbol.
</p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">LABEL_ISYMT</span><span class="plain"> 0</span><span class="identifier">x00000000</span>
<span class="definitionkeyword">define</span> <span class="constant">MISC_ISYMT</span><span class="plain"> 0</span><span class="identifier">x00000001</span>
<span class="definitionkeyword">define</span> <span class="constant">PACKAGE_ISYMT</span><span class="plain"> 0</span><span class="identifier">x00000002</span>
<span class="definitionkeyword">define</span> <span class="constant">PTYPE_ISYMT</span><span class="plain"> 0</span><span class="identifier">x00000003</span>
<span class="definitionkeyword">define</span> <span class="constant">SYMBOL_TYPE_MASK_ISYMT</span><span class="plain"> 0</span><span class="identifier">x00000003</span>
<span class="definitionkeyword">define</span> <span class="constant">PRIVATE_ISYMS</span><span class="plain"> 0</span><span class="identifier">x00000000</span>
<span class="definitionkeyword">define</span> <span class="constant">PUBLIC_ISYMS</span><span class="plain"> 0</span><span class="identifier">x00000004</span>
<span class="definitionkeyword">define</span> <span class="constant">EXTERNAL_ISYMS</span><span class="plain"> 0</span><span class="identifier">x00000008</span>
<span class="definitionkeyword">define</span> <span class="constant">PLUG_ISYMS</span><span class="plain"> 0</span><span class="identifier">x0000000C</span>
<span class="definitionkeyword">define</span> <span class="constant">SOCKET_ISYMS</span><span class="plain"> 0</span><span class="identifier">x00000010</span>
<span class="definitionkeyword">define</span> <span class="constant">SYMBOL_SCOPE_MASK_ISYMT</span><span class="plain"> 0</span><span class="identifier">x0000001C</span>
<span class="definitionkeyword">define</span> <span class="constant">TRAVERSE_MARK_BIT</span><span class="plain"> 0</span><span class="identifier">x00000020</span>
<span class="definitionkeyword">define</span> <span class="constant">ATTRIBUTE_MARK_BIT</span><span class="plain"> 0</span><span class="identifier">x00000040</span>
<span class="definitionkeyword">define</span> <span class="constant">VPH_MARK_BIT</span><span class="plain"> 0</span><span class="identifier">x00000080</span>
<span class="definitionkeyword">define</span> <span class="constant">USED_MARK_BIT</span><span class="plain"> 0</span><span class="identifier">x00000100</span>
<span class="definitionkeyword">define</span> <span class="constant">MAKE_NAME_UNIQUE</span><span class="plain"> 0</span><span class="identifier">x00000200</span>
<span class="definitionkeyword">define</span> <span class="constant">ERROR_ISSUED_MARK_BIT</span><span class="plain"> 0</span><span class="identifier">x00000400</span>
<span class="definitionkeyword">define</span> <span class="constant">NONTRANSIENT_SYMBOL_BITS</span><span class="plain"> (</span><span class="constant">MAKE_NAME_UNIQUE</span><span class="plain"> + </span><span class="constant">SYMBOL_TYPE_MASK_ISYMT</span><span class="plain"> + </span><span class="constant">SYMBOL_SCOPE_MASK_ISYMT</span><span class="plain">)</span>
</pre>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b></p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Canon::declare</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="identifier">invalid_IAF</span><span class="plain"> = </span><span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">INVALID_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__invalid"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">name_IAF</span><span class="plain"> = </span><span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">PROPERTY_NAME_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__property_name"</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">HEX_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__hex"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">SIGNED_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__signed"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">CALL_PARAMETER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__call_parameter"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">IMPLIED_CALL_PARAMETER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__implied_call_parameter"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">ACTION_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__action"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">APPEND_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__append"</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">ARROW_COUNT_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__arrow_count"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">ASSIMILATED_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__assimilated"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">ATTRIBUTE_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__attribute"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">BIP_CODE_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__bip"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">BUFFERARRAY_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__buffer_array"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">BYTEARRAY_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__byte_array"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">DECLARATION_ORDER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__declaration_order"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">DELENDA_EST_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__delenda_est"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">EITHER_OR_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__either_or"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">ENCLOSING_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__enclosing"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">FAKE_ACTION_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__fake_action"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">OBJECT_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__object"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">HOLDING_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__holding"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">INLINE_ARRAY_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__inline_array"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">LATE_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__late"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">METAVERB_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__meta_verb"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">NOUN_FILTER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__noun_filter"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">OBJECT_KIND_COUNTER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__object_kind_counter"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">RTO_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__rto"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">SCOPE_FILTER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__scope_filter"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">SOURCE_ORDER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__source_order"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">STRINGARRAY_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__string_array"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">TABLEARRAY_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__table_array"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">VERBARRAY_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__verb"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">WEAK_ID_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__weak_ID"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">EXPLICIT_ATTRIBUTE_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__explicit_attribute"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">EXPLICIT_VARIABLE_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__explicit_variable"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">TEXT_LITERAL_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__text_literal"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="functiontext">Inter::Annotations::form</span><span class="plain">(</span><span class="constant">VENEER_IANN</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"__veneer"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Inter::Canon::declare is used in 3/dfn (<a href="3-dfn.html#SP3">&#167;3</a>).</p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Chapter 3: Language Definition.)</i></li><li><a href="3-dfn.html">Continue with 'Definition'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>
Reference in a new issue View git blame Copy permalink