1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 18:14:21 +03:00
inform7/docs/inter-module/4-tcc.html
2019-09-07 20:43:31 +01:00

72 lines
10 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>4/tnc</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 '4/tcc' 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#4">Chapter 4: Void Constructs</a></li><li><b>The Comment Construct</b></li></ul><p class="purpose">Defining the comment construct.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b></p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">COMMENT_IST</span>
</pre>
<pre class="display">
<span class="definitionkeyword">define</span> <span class="constant">EXTENT_COMMENT_IFR</span><span class="plain"> 2</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Comment::define</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">inter_construct</span><span class="plain"> *</span><span class="identifier">IC</span><span class="plain"> = </span><span class="functiontext">Inter::Defn::create_construct</span><span class="plain">(</span>
<span class="constant">COMMENT_IST</span><span class="plain">,</span>
<span class="identifier">L</span><span class="string">" *"</span><span class="plain">,</span>
<span class="identifier">I</span><span class="string">"comment"</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"comments"</span><span class="plain">);</span>
<span class="identifier">METHOD_ADD</span><span class="plain">(</span><span class="identifier">IC</span><span class="plain">, </span><span class="constant">CONSTRUCT_READ_MTID</span><span class="plain">, </span><span class="functiontext">Inter::Comment::read</span><span class="plain">);</span>
<span class="identifier">METHOD_ADD</span><span class="plain">(</span><span class="identifier">IC</span><span class="plain">, </span><span class="constant">CONSTRUCT_TRANSPOSE_MTID</span><span class="plain">, </span><span class="functiontext">Inter::Comment::transpose</span><span class="plain">);</span>
<span class="identifier">IC</span><span class="plain">-</span><span class="element">&gt;min_level</span><span class="plain"> = 0;</span>
<span class="identifier">IC</span><span class="plain">-</span><span class="element">&gt;max_level</span><span class="plain"> = 100000000;</span>
<span class="identifier">IC</span><span class="plain">-</span><span class="element">&gt;usage_permissions</span><span class="plain"> = </span><span class="constant">OUTSIDE_OF_PACKAGES</span><span class="plain"> + </span><span class="constant">INSIDE_PLAIN_PACKAGE</span><span class="plain"> + </span><span class="constant">INSIDE_CODE_PACKAGE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Comment::read</span><span class="plain">(</span><span class="reserved">inter_construct</span><span class="plain"> *</span><span class="identifier">IC</span><span class="plain">, </span><span class="reserved">inter_bookmark</span><span class="plain"> *</span><span class="identifier">IBM</span><span class="plain">, </span><span class="reserved">inter_line_parse</span><span class="plain"> *</span><span class="identifier">ilp</span><span class="plain">, </span><span class="reserved">inter_error_location</span><span class="plain"> *</span><span class="identifier">eloc</span><span class="plain">, </span><span class="reserved">inter_error_message</span><span class="plain"> **</span><span class="identifier">E</span><span class="plain">) {</span>
<span class="plain">*</span><span class="identifier">E</span><span class="plain"> = </span><span class="functiontext">Inter::Defn::vet_level</span><span class="plain">(</span><span class="identifier">IBM</span><span class="plain">, </span><span class="constant">COMMENT_IST</span><span class="plain">, </span><span class="identifier">ilp</span><span class="plain">-</span><span class="element">&gt;indent_level</span><span class="plain">, </span><span class="identifier">eloc</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (*</span><span class="identifier">E</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Inter::Annotations::exist</span><span class="plain">(&amp;(</span><span class="identifier">ilp</span><span class="plain">-</span><span class="element">&gt;set</span><span class="plain">))) { *</span><span class="identifier">E</span><span class="plain"> = </span><span class="functiontext">Inter::Errors::plain</span><span class="plain">(</span><span class="identifier">I</span><span class="string">"__annotations are not allowed"</span><span class="plain">, </span><span class="identifier">eloc</span><span class="plain">); </span><span class="reserved">return</span><span class="plain">; }</span>
<span class="plain">*</span><span class="identifier">E</span><span class="plain"> = </span><span class="functiontext">Inter::Comment::new</span><span class="plain">(</span><span class="identifier">IBM</span><span class="plain">, (</span><span class="constant">inter_t</span><span class="plain">) </span><span class="identifier">ilp</span><span class="plain">-</span><span class="element">&gt;indent_level</span><span class="plain">, </span><span class="identifier">eloc</span><span class="plain">, </span><span class="identifier">ilp</span><span class="plain">-</span><span class="element">&gt;terminal_comment</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="functiontext">Inter::Comment::new</span><span class="plain">(</span><span class="reserved">inter_bookmark</span><span class="plain"> *</span><span class="identifier">IBM</span><span class="plain">, </span><span class="constant">inter_t</span><span class="plain"> </span><span class="identifier">level</span><span class="plain">, </span><span class="reserved">inter_error_location</span><span class="plain"> *</span><span class="identifier">eloc</span><span class="plain">, </span><span class="constant">inter_t</span><span class="plain"> </span><span class="identifier">comment_ID</span><span class="plain">) {</span>
<span class="reserved">inter_tree_node</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="functiontext">Inter::Node::fill_0</span><span class="plain">(</span><span class="identifier">IBM</span><span class="plain">, </span><span class="constant">COMMENT_IST</span><span class="plain">, </span><span class="identifier">eloc</span><span class="plain">, </span><span class="identifier">level</span><span class="plain">);</span>
<span class="functiontext">Inter::Node::attach_comment</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">comment_ID</span><span class="plain">);</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain"> = </span><span class="functiontext">Inter::Defn::verify_construct</span><span class="plain">(</span><span class="functiontext">Inter::Bookmarks::package</span><span class="plain">(</span><span class="identifier">IBM</span><span class="plain">), </span><span class="identifier">P</span><span class="plain">); </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">E</span><span class="plain">;</span>
<span class="functiontext">Inter::Bookmarks::insert</span><span class="plain">(</span><span class="identifier">IBM</span><span class="plain">, </span><span class="identifier">P</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>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Comment::transpose</span><span class="plain">(</span><span class="reserved">inter_construct</span><span class="plain"> *</span><span class="identifier">IC</span><span class="plain">, </span><span class="reserved">inter_tree_node</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain">, </span><span class="constant">inter_t</span><span class="plain"> *</span><span class="identifier">grid</span><span class="plain">, </span><span class="constant">inter_t</span><span class="plain"> </span><span class="identifier">grid_extent</span><span class="plain">, </span><span class="reserved">inter_error_message</span><span class="plain"> **</span><span class="identifier">E</span><span class="plain">) {</span>
<span class="functiontext">Inter::Node::attach_comment</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">grid</span><span class="plain">[</span><span class="functiontext">Inter::Node::get_comment</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">)]);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Inter::Comment::define is used in 3/dfn (<a href="3-dfn.html#SP3">&#167;3</a>).</p>
<p class="endnote">The function Inter::Comment::read appears nowhere else.</p>
<p class="endnote">The function Inter::Comment::new is used in 2/trn (<a href="2-trn.html#SP1_2">&#167;1.2</a>).</p>
<p class="endnote">The function Inter::Comment::transpose appears nowhere else.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="4-tnc.html">Back to 'The Nop Construct'</a></li><li><a href="4-tmc.html">Continue with 'The Metadata Construct'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>