PageRenderTime 235ms CodeModel.GetById 26ms RepoModel.GetById 1ms app.codeStats 0ms

/lib/syntax_tools/doc/erl_syntax.html

https://github.com/babo/jungerl
HTML | 2608 lines | 2317 code | 291 blank | 0 comment | 0 complexity | c88080a99e6714ed35d735276bae267c MD5 | raw file
Possible License(s): LGPL-2.1, BSD-3-Clause, AGPL-1.0

Large files files are truncated, but you can click here to view the full file

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module erl_syntax</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  8. <h1>Module erl_syntax</h1>
    9. 

  9. Abstract Erlang syntax trees.<ul><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul><h2><a name="description">Description</a></h2>Abstract Erlang syntax trees.
    10. 

  10.  
    11. 

  11.   <p> This module defines an abstract data type for representing Erlang
    12. 

  12.   source code as syntax trees, in a way that is backwards compatible
    13. 

  13.   with the data structures created by the Erlang standard library
    14. 

  14.   parser module <code>erl_parse</code> (often referred to as "parse
    15. 

  15.   trees", which is a bit of a misnomer). This means that all
    16. 

  16.   <code>erl_parse</code> trees are valid abstract syntax trees, but the
    17. 

  17.   reverse is not true: abstract syntax trees can in general not be used
    18. 

  18.   as input to functions expecting an <code>erl_parse</code> tree.
    19. 

  19.   However, as long as an abstract syntax tree represents a correct
    20. 

  20.   Erlang program, the function <a href="#revert-1"><code>revert/1</code></a> should be able to
    21. 

  21.   transform it to the corresponding <code>erl_parse</code>
    22. 

  22.   representation.</p>
    23. 

  23.  
    24. 

  24.   <p>A recommended starting point for the first-time user is the
    25. 

  25.   documentation of the <a href="#type-syntaxTree"><code>syntaxTree()</code></a> data type, and
    26. 

  26.   the function <a href="#type-1"><code>type/1</code></a>.</p>
    27. 

  27.  
    28. 

  28.   <h3><b>NOTES:</b></h3>
    29. 

  29.  
    30. 

  30.   <p>This module deals with the composition and decomposition of
    31. 

  31.   <em>syntactic</em> entities (as opposed to semantic ones); its
    32. 

  32.   purpose is to hide all direct references to the data structures used
    33. 

  33.   to represent these entities. With few exceptions, the functions in
    34. 

  34.   this module perform no semantic interpretation of their inputs, and
    35. 

  35.   in general, the user is assumed to pass type-correct arguments - if
    36. 

  36.   this is not done, the effects are not defined.</p>
    37. 

  37.  
    38. 

  38.   <p>With the exception of the <code>erl_parse</code> data structures,
    39. 

  39.   the internal representations of abstract syntax trees are subject to
    40. 

  40.   change without notice, and should not be documented outside this
    41. 

  41.   module. Furthermore, we do not give any guarantees on how an abstract
    42. 

  42.   syntax tree may or may not be represented, <em>with the following
    43. 

  43.   exceptions</em>: no syntax tree is represented by a single atom, such
    44. 

  44.   as <code>none</code>, by a list constructor <code>[X | Y]</code>, or
    45. 

  45.   by the empty list <code>[]</code>. This can be relied on when writing
    46. 

  46.   functions that operate on syntax trees.</p>
    47. 

  47.  
    48. 

  48. <h2><a name="types">Data Types</a></h2>
    49. 

  49. 

  50. <h3><a name="type-erl_parse">erl_parse()</a></h3>
    51. 

  51. <p><tt>erl_parse() = <a href="/usr/local/home/richardc/hipe/otp/lib/stdlib/doc/erl_parse.html#type-parse_tree">erl_parse:parse_tree()</a></tt></p>
    52. 

  52. <p>The "parse tree"
    53. 

  53.   representation built by the Erlang standard library parser
    54. 

  54.   <code>erl_parse</code>. This is a subset of the
    55. 

  55.   <a href="#type-syntaxTree"><code>syntaxTree</code></a> type.
    56. 

  56.  </p>
    57. 

  57. 

  58. <h3><a name="type-syntaxTree">syntaxTree()</a></h3>
    59. 

  59. <p><b>abstract datatype</b>: <tt>syntaxTree()</tt></p>
    60. 

  60. <p>An abstract syntax tree. The
    61. 

  61.   <code>erl_parse</code> "parse tree" representation is a subset of the
    62. 

  62.   <code>syntaxTree()</code> representation.
    63. 

  63.  
    64. 

  64.   <p>Every abstract syntax tree node has a <em>type</em>, given by the
    65. 

  65.   function <a href="#type-1"><code>type/1</code></a>. Each node also
    66. 

  66.   has associated <em>attributes</em>; see <a href="#get_attrs-1"><code>get_attrs/1</code></a> for details. The
    67. 

  67.   functions <a href="#make_tree-2"><code>make_tree/2</code></a> and <a href="#subtrees-1"><code>subtrees/1</code></a> are generic
    68. 

  68.   constructor/decomposition functions for abstract syntax trees. The
    69. 

  69.   functions <a href="#abstract-1"><code>abstract/1</code></a> and <a href="#concrete-1"><code>concrete/1</code></a> convert between
    70. 

  70.   constant Erlang terms and their syntactic representations. The set of
    71. 

  71.   syntax tree nodes is extensible through the <a href="#tree-2"><code>tree/2</code></a> function.</p>
    72. 

  72.  
    73. 

  73.   <p>A syntax tree can be transformed to the <code>erl_parse</code>
    74. 

  74.   representation with the <a href="#revert-1"><code>revert/1</code></a>
    75. 

  75.   function.</p>
    76. 

  76.  </p>
    77. 

  77. 

  78. <h3><a name="type-syntaxTreeAttributes">syntaxTreeAttributes()</a></h3>
    79. 

  79. <p><b>abstract datatype</b>: <tt>syntaxTreeAttributes()</tt></p>
    80. 

  80. <p>This is an abstract representation of
    81. 

  81.   syntax tree node attributes; see the function <a href="#get_attrs-1"><code>get_attrs/1</code></a>.
    82. 

  82.  </p>
    83. 

  83. 

  84. <h2><a name="index">Function Index</a></h2>
    85. 

  85. <table width="100%" border="1"><tr><td valign="top"><a href="#abstract-1">abstract/1</a></td><td>Returns the syntax tree corresponding to an Erlang term.</td></tr>
    86. 

  86. <tr><td valign="top"><a href="#add_ann-2">add_ann/2</a></td><td>Appends the term <code>Annotation</code> to the list of user
    87. 

  87.   annotations of <code>Node</code>.</td></tr>
    88. 

  88. <tr><td valign="top"><a href="#add_postcomments-2">add_postcomments/2</a></td><td>Appends <code>Comments</code> to the post-comments of
    89. 

  89.   <code>Node</code>.</td></tr>
    90. 

  90. <tr><td valign="top"><a href="#add_precomments-2">add_precomments/2</a></td><td>Appends <code>Comments</code> to the pre-comments of
    91. 

  91.   <code>Node</code>.</td></tr>
    92. 

  92. <tr><td valign="top"><a href="#application-2">application/2</a></td><td>Creates an abstract function application expression.</td></tr>
    93. 

  93. <tr><td valign="top"><a href="#application-3">application/3</a></td><td>Creates an abstract function application expression.</td></tr>
    94. 

  94. <tr><td valign="top"><a href="#application_arguments-1">application_arguments/1</a></td><td>Returns the list of argument subtrees of an
    95. 

  95.   <code>application</code> node.</td></tr>
    96. 

  96. <tr><td valign="top"><a href="#application_operator-1">application_operator/1</a></td><td>Returns the operator subtree of an <code>application</code>
    97. 

  97.   node.</td></tr>
    98. 

  98. <tr><td valign="top"><a href="#arity_qualifier-2">arity_qualifier/2</a></td><td>Creates an abstract arity qualifier.</td></tr>
    99. 

  99. <tr><td valign="top"><a href="#arity_qualifier_argument-1">arity_qualifier_argument/1</a></td><td>Returns the argument (the arity) subtree of an
    100. 

  100.   <code>arity_qualifier</code> node.</td></tr>
    101. 

  101. <tr><td valign="top"><a href="#arity_qualifier_body-1">arity_qualifier_body/1</a></td><td>Returns the body subtree of an <code>arity_qualifier</code>
    102. 

  102.   node.</td></tr>
    103. 

  103. <tr><td valign="top"><a href="#atom-1">atom/1</a></td><td>Creates an abstract atom literal.</td></tr>
    104. 

  104. <tr><td valign="top"><a href="#atom_literal-1">atom_literal/1</a></td><td>Returns the literal string represented by an <code>atom</code>
    105. 

  105.   node.</td></tr>
    106. 

  106. <tr><td valign="top"><a href="#atom_name-1">atom_name/1</a></td><td>Returns the printname of an <code>atom</code> node.</td></tr>
    107. 

  107. <tr><td valign="top"><a href="#atom_value-1">atom_value/1</a></td><td>Returns the value represented by an <code>atom</code> node.</td></tr>
    108. 

  108. <tr><td valign="top"><a href="#attribute-1">attribute/1</a></td><td><p>Equivalent to <a href="#attribute-2"><tt>attribute(Name, none)</tt></a>.</p>
    109. 

  109. </td></tr>
    110. 

  110. <tr><td valign="top"><a href="#attribute-2">attribute/2</a></td><td>Creates an abstract program attribute.</td></tr>
    111. 

  111. <tr><td valign="top"><a href="#attribute_arguments-1">attribute_arguments/1</a></td><td>Returns the list of argument subtrees of an
    112. 

  112.   <code>attribute</code> node, if any.</td></tr>
    113. 

  113. <tr><td valign="top"><a href="#attribute_name-1">attribute_name/1</a></td><td>Returns the name subtree of an <code>attribute</code> node.</td></tr>
    114. 

  114. <tr><td valign="top"><a href="#binary-1">binary/1</a></td><td>Creates an abstract binary-object template.</td></tr>
    115. 

  115. <tr><td valign="top"><a href="#binary_field-1">binary_field/1</a></td><td><p>Equivalent to <a href="#binary_field-2"><tt>binary_field(Body, [])</tt></a>.</p>
    116. 

  116. </td></tr>
    117. 

  117. <tr><td valign="top"><a href="#binary_field-2">binary_field/2</a></td><td>Creates an abstract binary template field.</td></tr>
    118. 

  118. <tr><td valign="top"><a href="#binary_field-3">binary_field/3</a></td><td>Creates an abstract binary template field.</td></tr>
    119. 

  119. <tr><td valign="top"><a href="#binary_field_body-1">binary_field_body/1</a></td><td>Returns the body subtree of a <code>binary_field</code>.</td></tr>
    120. 

  120. <tr><td valign="top"><a href="#binary_field_size-1">binary_field_size/1</a></td><td>Returns the size specifier subtree of a
    121. 

  121.   <code>binary_field</code> node, if any.</td></tr>
    122. 

  122. <tr><td valign="top"><a href="#binary_field_types-1">binary_field_types/1</a></td><td>Returns the list of type-specifier subtrees of a
    123. 

  123.   <code>binary_field</code> node.</td></tr>
    124. 

  124. <tr><td valign="top"><a href="#binary_fields-1">binary_fields/1</a></td><td>Returns the list of field subtrees of a <code>binary</code>
    125. 

  125.   node.</td></tr>
    126. 

  126. <tr><td valign="top"><a href="#block_expr-1">block_expr/1</a></td><td>Creates an abstract block expression.</td></tr>
    127. 

  127. <tr><td valign="top"><a href="#block_expr_body-1">block_expr_body/1</a></td><td>Returns the list of body subtrees of a <code>block_expr</code>
    128. 

  128.   node.</td></tr>
    129. 

  129. <tr><td valign="top"><a href="#case_expr-2">case_expr/2</a></td><td>Creates an abstract case-expression.</td></tr>
    130. 

  130. <tr><td valign="top"><a href="#case_expr_argument-1">case_expr_argument/1</a></td><td>Returns the argument subtree of a <code>case_expr</code> node.</td></tr>
    131. 

  131. <tr><td valign="top"><a href="#case_expr_clauses-1">case_expr_clauses/1</a></td><td>Returns the list of clause subtrees of a <code>case_expr</code>
    132. 

  132.   node.</td></tr>
    133. 

  133. <tr><td valign="top"><a href="#catch_expr-1">catch_expr/1</a></td><td>Creates an abstract catch-expression.</td></tr>
    134. 

  134. <tr><td valign="top"><a href="#catch_expr_body-1">catch_expr_body/1</a></td><td>Returns the body subtree of a <code>catch_expr</code> node.</td></tr>
    135. 

  135. <tr><td valign="top"><a href="#char-1">char/1</a></td><td>Creates an abstract character literal.</td></tr>
    136. 

  136. <tr><td valign="top"><a href="#char_literal-1">char_literal/1</a></td><td>Returns the literal string represented by a <code>char</code>
    137. 

  137.   node.</td></tr>
    138. 

  138. <tr><td valign="top"><a href="#char_value-1">char_value/1</a></td><td>Returns the value represented by a <code>char</code> node.</td></tr>
    139. 

  139. <tr><td valign="top"><a href="#class_qualifier-2">class_qualifier/2</a></td><td>Creates an abstract class qualifier.</td></tr>
    140. 

  140. <tr><td valign="top"><a href="#class_qualifier_argument-1">class_qualifier_argument/1</a></td><td>Returns the argument (the class) subtree of a
    141. 

  141.   <code>class_qualifier</code> node.</td></tr>
    142. 

  142. <tr><td valign="top"><a href="#class_qualifier_body-1">class_qualifier_body/1</a></td><td>Returns the body subtree of a <code>class_qualifier</code> node.</td></tr>
    143. 

  143. <tr><td valign="top"><a href="#clause-2">clause/2</a></td><td><p>Equivalent to <a href="#clause-3"><tt>clause([], Guard, Body)</tt></a>.</p>
    144. 

  144. </td></tr>
    145. 

  145. <tr><td valign="top"><a href="#clause-3">clause/3</a></td><td>Creates an abstract clause.</td></tr>
    146. 

  146. <tr><td valign="top"><a href="#clause_body-1">clause_body/1</a></td><td>Return the list of body subtrees of a <code>clause</code>
    147. 

  147.   node.</td></tr>
    148. 

  148. <tr><td valign="top"><a href="#clause_guard-1">clause_guard/1</a></td><td>Returns the guard subtree of a <code>clause</code> node, if
    149. 

  149.   any.</td></tr>
    150. 

  150. <tr><td valign="top"><a href="#clause_patterns-1">clause_patterns/1</a></td><td>Returns the list of pattern subtrees of a <code>clause</code>
    151. 

  151.   node.</td></tr>
    152. 

  152. <tr><td valign="top"><a href="#comment-1">comment/1</a></td><td><p>Equivalent to <a href="#comment-2"><tt>comment(none, Strings)</tt></a>.</p>
    153. 

  153. </td></tr>
    154. 

  154. <tr><td valign="top"><a href="#comment-2">comment/2</a></td><td>Creates an abstract comment with the given padding and text.</td></tr>
    155. 

  155. <tr><td valign="top"><a href="#comment_padding-1">comment_padding/1</a></td><td>Returns the amount of padding before the comment, or
    156. 

  156.   <code>none</code>.</td></tr>
    157. 

  157. <tr><td valign="top"><a href="#comment_text-1">comment_text/1</a></td><td>Returns the lines of text of the abstract comment.</td></tr>
    158. 

  158. <tr><td valign="top"><a href="#compact_list-1">compact_list/1</a></td><td>Yields the most compact form for an abstract list skeleton.</td></tr>
    159. 

  159. <tr><td valign="top"><a href="#concrete-1">concrete/1</a></td><td>Returns the Erlang term represented by a syntax tree.</td></tr>
    160. 

  160. <tr><td valign="top"><a href="#cond_expr-1">cond_expr/1</a></td><td>Creates an abstract cond-expression.</td></tr>
    161. 

  161. <tr><td valign="top"><a href="#cond_expr_clauses-1">cond_expr_clauses/1</a></td><td>Returns the list of clause subtrees of a <code>cond_expr</code>
    162. 

  162.   node.</td></tr>
    163. 

  163. <tr><td valign="top"><a href="#conjunction-1">conjunction/1</a></td><td>Creates an abstract conjunction.</td></tr>
    164. 

  164. <tr><td valign="top"><a href="#conjunction_body-1">conjunction_body/1</a></td><td>Returns the list of body subtrees of a
    165. 

  165.   <code>conjunction</code> node.</td></tr>
    166. 

  166. <tr><td valign="top"><a href="#cons-2">cons/2</a></td><td>"Optimising" list skeleton cons operation.</td></tr>
    167. 

  167. <tr><td valign="top"><a href="#copy_ann-2">copy_ann/2</a></td><td>Copies the list of user annotations from <code>Source</code> to
    168. 

  168.   <code>Target</code>.</td></tr>
    169. 

  169. <tr><td valign="top"><a href="#copy_attrs-2">copy_attrs/2</a></td><td>Copies the attributes from <code>Source</code> to
    170. 

  170.   <code>Target</code>.</td></tr>
    171. 

  171. <tr><td valign="top"><a href="#copy_comments-2">copy_comments/2</a></td><td>Copies the pre- and postcomments from <code>Source</code> to
    172. 

  172.   <code>Target</code>.</td></tr>
    173. 

  173. <tr><td valign="top"><a href="#copy_pos-2">copy_pos/2</a></td><td>Copies the position information from <code>Source</code> to
    174. 

  174.   <code>Target</code>.</td></tr>
    175. 

  175. <tr><td valign="top"><a href="#data-1">data/1</a></td><td><em>For special purposes only</em>.</td></tr>
    176. 

  176. <tr><td valign="top"><a href="#disjunction-1">disjunction/1</a></td><td>Creates an abstract disjunction.</td></tr>
    177. 

  177. <tr><td valign="top"><a href="#disjunction_body-1">disjunction_body/1</a></td><td>Returns the list of body subtrees of a
    178. 

  178.   <code>disjunction</code> node.</td></tr>
    179. 

  179. <tr><td valign="top"><a href="#eof_marker-0">eof_marker/0</a></td><td>Creates an abstract end-of-file marker.</td></tr>
    180. 

  180. <tr><td valign="top"><a href="#error_marker-1">error_marker/1</a></td><td>Creates an abstract error marker.</td></tr>
    181. 

  181. <tr><td valign="top"><a href="#error_marker_info-1">error_marker_info/1</a></td><td>Returns the ErrorInfo structure of an <code>error_marker</code>
    182. 

  182.   node.</td></tr>
    183. 

  183. <tr><td valign="top"><a href="#flatten_form_list-1">flatten_form_list/1</a></td><td>Flattens sublists of a <code>form_list</code> node.</td></tr>
    184. 

  184. <tr><td valign="top"><a href="#float-1">float/1</a></td><td>Creates an abstract floating-point literal.</td></tr>
    185. 

  185. <tr><td valign="top"><a href="#float_literal-1">float_literal/1</a></td><td>Returns the numeral string represented by a <code>float</code>
    186. 

  186.   node.</td></tr>
    187. 

  187. <tr><td valign="top"><a href="#float_value-1">float_value/1</a></td><td>Returns the value represented by a <code>float</code> node.</td></tr>
    188. 

  188. <tr><td valign="top"><a href="#form_list-1">form_list/1</a></td><td>Creates an abstract sequence of "source code forms".</td></tr>
    189. 

  189. <tr><td valign="top"><a href="#form_list_elements-1">form_list_elements/1</a></td><td>Returns the list of subnodes of a <code>form_list</code> node.</td></tr>
    190. 

  190. <tr><td valign="top"><a href="#fun_expr-1">fun_expr/1</a></td><td>Creates an abstract fun-expression.</td></tr>
    191. 

  191. <tr><td valign="top"><a href="#fun_expr_arity-1">fun_expr_arity/1</a></td><td>Returns the arity of a <code>fun_expr</code> node.</td></tr>
    192. 

  192. <tr><td valign="top"><a href="#fun_expr_clauses-1">fun_expr_clauses/1</a></td><td>Returns the list of clause subtrees of a <code>fun_expr</code>
    193. 

  193.   node.</td></tr>
    194. 

  194. <tr><td valign="top"><a href="#function-2">function/2</a></td><td>Creates an abstract function definition.</td></tr>
    195. 

  195. <tr><td valign="top"><a href="#function_arity-1">function_arity/1</a></td><td>Returns the arity of a <code>function</code> node.</td></tr>
    196. 

  196. <tr><td valign="top"><a href="#function_clauses-1">function_clauses/1</a></td><td>Returns the list of clause subtrees of a <code>function</code>
    197. 

  197.   node.</td></tr>
    198. 

  198. <tr><td valign="top"><a href="#function_name-1">function_name/1</a></td><td>Returns the name subtree of a <code>function</code> node.</td></tr>
    199. 

  199. <tr><td valign="top"><a href="#generator-2">generator/2</a></td><td>Creates an abstract generator.</td></tr>
    200. 

  200. <tr><td valign="top"><a href="#generator_body-1">generator_body/1</a></td><td>Returns the body subtree of a <code>generator</code> node.</td></tr>
    201. 

  201. <tr><td valign="top"><a href="#generator_pattern-1">generator_pattern/1</a></td><td>Returns the pattern subtree of a <code>generator</code> node.</td></tr>
    202. 

  202. <tr><td valign="top"><a href="#get_ann-1">get_ann/1</a></td><td>Returns the list of user annotations associated with a syntax
    203. 

  203.   tree node.</td></tr>
    204. 

  204. <tr><td valign="top"><a href="#get_attrs-1">get_attrs/1</a></td><td>Returns a representation of the attributes associated with a
    205. 

  205.   syntax tree node.</td></tr>
    206. 

  206. <tr><td valign="top"><a href="#get_pos-1">get_pos/1</a></td><td>Returns the position information associated with
    207. 

  207.   <code>Node</code>.</td></tr>
    208. 

  208. <tr><td valign="top"><a href="#get_postcomments-1">get_postcomments/1</a></td><td>Returns the associated post-comments of a node.</td></tr>
    209. 

  209. <tr><td valign="top"><a href="#get_precomments-1">get_precomments/1</a></td><td>Returns the associated pre-comments of a node.</td></tr>
    210. 

  210. <tr><td valign="top"><a href="#has_comments-1">has_comments/1</a></td><td>Yields <code>false</code> if the node has no associated
    211. 

  211.   comments, and <code>true</code> otherwise.</td></tr>
    212. 

  212. <tr><td valign="top"><a href="#if_expr-1">if_expr/1</a></td><td>Creates an abstract if-expression.</td></tr>
    213. 

  213. <tr><td valign="top"><a href="#if_expr_clauses-1">if_expr_clauses/1</a></td><td>Returns the list of clause subtrees of an <code>if_expr</code>
    214. 

  214.   node.</td></tr>
    215. 

  215. <tr><td valign="top"><a href="#implicit_fun-1">implicit_fun/1</a></td><td>Creates an abstract "implicit fun" expression.</td></tr>
    216. 

  216. <tr><td valign="top"><a href="#implicit_fun-2">implicit_fun/2</a></td><td>Creates an abstract "implicit fun" expression.</td></tr>
    217. 

  217. <tr><td valign="top"><a href="#implicit_fun_name-1">implicit_fun_name/1</a></td><td>Returns the name subtree of an <code>implicit_fun</code> node.</td></tr>
    218. 

  218. <tr><td valign="top"><a href="#infix_expr-3">infix_expr/3</a></td><td>Creates an abstract infix operator expression.</td></tr>
    219. 

  219. <tr><td valign="top"><a href="#infix_expr_left-1">infix_expr_left/1</a></td><td>Returns the left argument subtree of an
    220. 

  220.   <code>infix_expr</code> node.</td></tr>
    221. 

  221. <tr><td valign="top"><a href="#infix_expr_operator-1">infix_expr_operator/1</a></td><td>Returns the operator subtree of an <code>infix_expr</code>
    222. 

  222.   node.</td></tr>
    223. 

  223. <tr><td valign="top"><a href="#infix_expr_right-1">infix_expr_right/1</a></td><td>Returns the right argument subtree of an
    224. 

  224.   <code>infix_expr</code> node.</td></tr>
    225. 

  225. <tr><td valign="top"><a href="#integer-1">integer/1</a></td><td>Creates an abstract integer literal.</td></tr>
    226. 

  226. <tr><td valign="top"><a href="#integer_literal-1">integer_literal/1</a></td><td>Returns the numeral string represented by an
    227. 

  227.   <code>integer</code> node.</td></tr>
    228. 

  228. <tr><td valign="top"><a href="#integer_value-1">integer_value/1</a></td><td>Returns the value represented by an <code>integer</code> node.</td></tr>
    229. 

  229. <tr><td valign="top"><a href="#is_atom-2">is_atom/2</a></td><td>Returns <code>true</code> if <code>Node</code> has type
    230. 

  230.   <code>atom</code> and represents <code>Value</code>, otherwise
    231. 

  231.   <code>false</code>.</td></tr>
    232. 

  232. <tr><td valign="top"><a href="#is_char-2">is_char/2</a></td><td>Returns <code>true</code> if <code>Node</code> has type
    233. 

  233.   <code>char</code> and represents <code>Value</code>, otherwise
    234. 

  234.   <code>false</code>.</td></tr>
    235. 

  235. <tr><td valign="top"><a href="#is_form-1">is_form/1</a></td><td>Returns <code>true</code> if <code>Node</code> is a syntax tree
    236. 

  236.   representing a so-called "source code form", otherwise
    237. 

  237.   <code>false</code>.</td></tr>
    238. 

  238. <tr><td valign="top"><a href="#is_integer-2">is_integer/2</a></td><td>Returns <code>true</code> if <code>Node</code> has type
    239. 

  239.   <code>integer</code> and represents <code>Value</code>, otherwise
    240. 

  240.   <code>false</code>.</td></tr>
    241. 

  241. <tr><td valign="top"><a href="#is_leaf-1">is_leaf/1</a></td><td>Returns <code>true</code> if <code>Node</code> is a leaf node,
    242. 

  242.   otherwise <code>false</code>.</td></tr>
    243. 

  243. <tr><td valign="top"><a href="#is_list_skeleton-1">is_list_skeleton/1</a></td><td>Returns <code>true</code> if <code>Node</code> has type
    244. 

  244.   <code>list</code> or <code>nil</code>, otherwise <code>false</code>.</td></tr>
    245. 

  245. <tr><td valign="top"><a href="#is_literal-1">is_literal/1</a></td><td>Returns <code>true</code> if <code>Node</code> represents a
    246. 

  246.   literal term, otherwise <code>false</code>.</td></tr>
    247. 

  247. <tr><td valign="top"><a href="#is_proper_list-1">is_proper_list/1</a></td><td>Returns <code>true</code> if <code>Node</code> represents a
    248. 

  248.   proper list, and <code>false</code> otherwise.</td></tr>
    249. 

  249. <tr><td valign="top"><a href="#is_string-2">is_string/2</a></td><td>Returns <code>true</code> if <code>Node</code> has type
    250. 

  250.   <code>string</code> and represents <code>Value</code>, otherwise
    251. 

  251.   <code>false</code>.</td></tr>
    252. 

  252. <tr><td valign="top"><a href="#is_tree-1">is_tree/1</a></td><td><em>For special purposes only</em>.</td></tr>
    253. 

  253. <tr><td valign="top"><a href="#join_comments-2">join_comments/2</a></td><td>Appends the comments of <code>Source</code> to the current
    254. 

  254.   comments of <code>Target</code>.</td></tr>
    255. 

  255. <tr><td valign="top"><a href="#list-1">list/1</a></td><td><p>Equivalent to <a href="#list-2"><tt>list(List, none)</tt></a>.</p>
    256. 

  256. </td></tr>
    257. 

  257. <tr><td valign="top"><a href="#list-2">list/2</a></td><td>Constructs an abstract list skeleton.</td></tr>
    258. 

  258. <tr><td valign="top"><a href="#list_comp-2">list_comp/2</a></td><td>Creates an abstract list comprehension.</td></tr>
    259. 

  259. <tr><td valign="top"><a href="#list_comp_body-1">list_comp_body/1</a></td><td>Returns the list of body subtrees of a <code>list_comp</code>
    260. 

  260.   node.</td></tr>
    261. 

  261. <tr><td valign="top"><a href="#list_comp_template-1">list_comp_template/1</a></td><td>Returns the template subtree of a <code>list_comp</code> node.</td></tr>
    262. 

  262. <tr><td valign="top"><a href="#list_elements-1">list_elements/1</a></td><td>Returns the list of element subtrees of a list skeleton.</td></tr>
    263. 

  263. <tr><td valign="top"><a href="#list_head-1">list_head/1</a></td><td>Returns the head element subtree of a <code>list</code> node.</td></tr>
    264. 

  264. <tr><td valign="top"><a href="#list_length-1">list_length/1</a></td><td>Returns the number of element subtrees of a list skeleton.</td></tr>
    265. 

  265. <tr><td valign="top"><a href="#list_prefix-1">list_prefix/1</a></td><td>Returns the prefix element subtrees of a <code>list</code> node.</td></tr>
    266. 

  266. <tr><td valign="top"><a href="#list_suffix-1">list_suffix/1</a></td><td>Returns the suffix subtree of a <code>list</code> node, if one
    267. 

  267.   exists.</td></tr>
    268. 

  268. <tr><td valign="top"><a href="#list_tail-1">list_tail/1</a></td><td>Returns the tail of a <code>list</code> node.</td></tr>
    269. 

  269. <tr><td valign="top"><a href="#macro-1">macro/1</a></td><td><p>Equivalent to <a href="#macro-2"><tt>macro(Name, none)</tt></a>.</p>
    270. 

  270. </td></tr>
    271. 

  271. <tr><td valign="top"><a href="#macro-2">macro/2</a></td><td>Creates an abstract macro application.</td></tr>
    272. 

  272. <tr><td valign="top"><a href="#macro_arguments-1">macro_arguments/1</a></td><td>Returns the list of argument subtrees of a <code>macro</code>
    273. 

  273.   node, if any.</td></tr>
    274. 

  274. <tr><td valign="top"><a href="#macro_name-1">macro_name/1</a></td><td>Returns the name subtree of a <code>macro</code> node.</td></tr>
    275. 

  275. <tr><td valign="top"><a href="#make_tree-2">make_tree/2</a></td><td>Creates a syntax tree with the given type and subtrees.</td></tr>
    276. 

  276. <tr><td valign="top"><a href="#match_expr-2">match_expr/2</a></td><td>Creates an abstract match-expression.</td></tr>
    277. 

  277. <tr><td valign="top"><a href="#match_expr_body-1">match_expr_body/1</a></td><td>Returns the body subtree of a <code>match_expr</code> node.</td></tr>
    278. 

  278. <tr><td valign="top"><a href="#match_expr_pattern-1">match_expr_pattern/1</a></td><td>Returns the pattern subtree of a <code>match_expr</code> node.</td></tr>
    279. 

  279. <tr><td valign="top"><a href="#meta-1">meta/1</a></td><td>Creates a meta-representation of a syntax tree.</td></tr>
    280. 

  280. <tr><td valign="top"><a href="#module_qualifier-2">module_qualifier/2</a></td><td>Creates an abstract module qualifier.</td></tr>
    281. 

  281. <tr><td valign="top"><a href="#module_qualifier_argument-1">module_qualifier_argument/1</a></td><td>Returns the argument (the module) subtree of a
    282. 

  282.   <code>module_qualifier</code> node.</td></tr>
    283. 

  283. <tr><td valign="top"><a href="#module_qualifier_body-1">module_qualifier_body/1</a></td><td>Returns the body subtree of a <code>module_qualifier</code>
    284. 

  284.   node.</td></tr>
    285. 

  285. <tr><td valign="top"><a href="#nil-0">nil/0</a></td><td>Creates an abstract empty list.</td></tr>
    286. 

  286. <tr><td valign="top"><a href="#normalize_list-1">normalize_list/1</a></td><td>Expands an abstract list skeleton to its most explicit form.</td></tr>
    287. 

  287. <tr><td valign="top"><a href="#operator-1">operator/1</a></td><td>Creates an abstract operator.</td></tr>
    288. 

  288. <tr><td valign="top"><a href="#operator_literal-1">operator_literal/1</a></td><td>Returns the literal string represented by an
    289. 

  289.   <code>operator</code> node.</td></tr>
    290. 

  290. <tr><td valign="top"><a href="#operator_name-1">operator_name/1</a></td><td>Returns the name of an <code>operator</code> node.</td></tr>
    291. 

  291. <tr><td valign="top"><a href="#parentheses-1">parentheses/1</a></td><td>Creates an abstract parenthesised expression.</td></tr>
    292. 

  292. <tr><td valign="top"><a href="#parentheses_body-1">parentheses_body/1</a></td><td>Returns the body subtree of a <code>parentheses</code> node.</td></tr>
    293. 

  293. <tr><td valign="top"><a href="#prefix_expr-2">prefix_expr/2</a></td><td>Creates an abstract prefix operator expression.</td></tr>
    294. 

  294. <tr><td valign="top"><a href="#prefix_expr_argument-1">prefix_expr_argument/1</a></td><td>Returns the argument subtree of a <code>prefix_expr</code>
    295. 

  295.   node.</td></tr>
    296. 

  296. <tr><td valign="top"><a href="#prefix_expr_operator-1">prefix_expr_operator/1</a></td><td>Returns the operator subtree of a <code>prefix_expr</code>
    297. 

  297.   node.</td></tr>
    298. 

  298. <tr><td valign="top"><a href="#qualified_name-1">qualified_name/1</a></td><td>Creates an abstract qualified name.</td></tr>
    299. 

  299. <tr><td valign="top"><a href="#qualified_name_segments-1">qualified_name_segments/1</a></td><td>Returns the list of name segments of a
    300. 

  300.   <code>qualified_name</code> node.</td></tr>
    301. 

  301. <tr><td valign="top"><a href="#query_expr-1">query_expr/1</a></td><td>Creates an abstract Mnemosyne query expression.</td></tr>
    302. 

  302. <tr><td valign="top"><a href="#query_expr_body-1">query_expr_body/1</a></td><td>Returns the body subtree of a <code>query_expr</code> node.</td></tr>
    303. 

  303. <tr><td valign="top"><a href="#receive_expr-1">receive_expr/1</a></td><td><p>Equivalent to <a href="#receive_expr-3"><tt>receive_expr(Clauses, none, [])</tt></a>.</p>
    304. 

  304. </td></tr>
    305. 

  305. <tr><td valign="top"><a href="#receive_expr-3">receive_expr/3</a></td><td>Creates an abstract receive-expression.</td></tr>
    306. 

  306. <tr><td valign="top"><a href="#receive_expr_action-1">receive_expr_action/1</a></td><td>Returns the list of action body subtrees of a
    307. 

  307.   <code>receive_expr</code> node.</td></tr>
    308. 

  308. <tr><td valign="top"><a href="#receive_expr_clauses-1">receive_expr_clauses/1</a></td><td>Returns the list of clause subtrees of a
    309. 

  309.   <code>receive_expr</code> node.</td></tr>
    310. 

  310. <tr><td valign="top"><a href="#receive_expr_timeout-1">receive_expr_timeout/1</a></td><td>Returns the timeout subtree of a <code>receive_expr</code> node,
    311. 

  311.   if any.</td></tr>
    312. 

  312. <tr><td valign="top"><a href="#record_access-2">record_access/2</a></td><td><p>Equivalent to <a href="#record_access-3"><tt>record_access(Argument, none, Field)</tt></a>.</p>
    313. 

  313. </td></tr>
    314. 

  314. <tr><td valign="top"><a href="#record_access-3">record_access/3</a></td><td>Creates an abstract record field access expression.</td></tr>
    315. 

  315. <tr><td valign="top"><a href="#record_access_argument-1">record_access_argument/1</a></td><td>Returns the argument subtree of a <code>record_access</code>
    316. 

  316.   node.</td></tr>
    317. 

  317. <tr><td valign="top"><a href="#record_access_field-1">record_access_field/1</a></td><td>Returns the field subtree of a <code>record_access</code>
    318. 

  318.   node.</td></tr>
    319. 

  319. <tr><td valign="top"><a href="#record_access_type-1">record_access_type/1</a></td><td>Returns the type subtree of a <code>record_access</code> node,
    320. 

  320.   if any.</td></tr>
    321. 

  321. <tr><td valign="top"><a href="#record_expr-2">record_expr/2</a></td><td><p>Equivalent to <a href="#record_expr-3"><tt>record_expr(none, Type, Fields)</tt></a>.</p>
    322. 

  322. </td></tr>
    323. 

  323. <tr><td valign="top"><a href="#record_expr-3">record_expr/3</a></td><td>Creates an abstract record expression.</td></tr>
    324. 

  324. <tr><td valign="top"><a href="#record_expr_argument-1">record_expr_argument/1</a></td><td>Returns the argument subtree of a <code>record_expr</code> node,
    325. 

  325.   if any.</td></tr>
    326. 

  326. <tr><td valign="top"><a href="#record_expr_fields-1">record_expr_fields/1</a></td><td>Returns the list of field subtrees of a
    327. 

  327.   <code>record_expr</code> node.</td></tr>
    328. 

  328. <tr><td valign="top"><a href="#record_expr_type-1">record_expr_type/1</a></td><td>Returns the type subtree of a <code>record_expr</code> node.</td></tr>
    329. 

  329. <tr><td valign="top"><a href="#record_field-1">record_field/1</a></td><td><p>Equivalent to <a href="#record_field-2"><tt>record_field(Name, none)</tt></a>.</p>
    330. 

  330. </td></tr>
    331. 

  331. <tr><td valign="top"><a href="#record_field-2">record_field/2</a></td><td>Creates an abstract record field specification.</td></tr>
    332. 

  332. <tr><td valign="top"><a href="#record_field_name-1">record_field_name/1</a></td><td>Returns the name subtree of a <code>record_field</code> node.</td></tr>
    333. 

  333. <tr><td valign="top"><a href="#record_field_value-1">record_field_value/1</a></td><td>Returns the value subtree of a <code>record_field</code> node,
    334. 

  334.   if any.</td></tr>
    335. 

  335. <tr><td valign="top"><a href="#record_index_expr-2">record_index_expr/2</a></td><td>Creates an abstract record field index expression.</td></tr>
    336. 

  336. <tr><td valign="top"><a href="#record_index_expr_field-1">record_index_expr_field/1</a></td><td>Returns the field subtree of a <code>record_index_expr</code>
    337. 

  337.   node.</td></tr>
    338. 

  338. <tr><td valign="top"><a href="#record_index_expr_type-1">record_index_expr_type/1</a></td><td>Returns the type subtree of a <code>record_index_expr</code>
    339. 

  339.   node.</td></tr>
    340. 

  340. <tr><td valign="top"><a href="#remove_comments-1">remove_comments/1</a></td><td>Clears the associated comments of <code>Node</code>.</td></tr>
    341. 

  341. <tr><td valign="top"><a href="#revert-1">revert/1</a></td><td>Returns an <code>erl_parse</code>-compatible representation of a
    342. 

  342.   syntax tree, if possible.</td></tr>
    343. 

  343. <tr><td valign="top"><a href="#revert_forms-1">revert_forms/1</a></td><td>Reverts a sequence of Erlang source code forms.</td></tr>
    344. 

  344. <tr><td valign="top"><a href="#rule-2">rule/2</a></td><td>Creates an abstract Mnemosyne rule.</td></tr>
    345. 

  345. <tr><td valign="top"><a href="#rule_arity-1">rule_arity/1</a></td><td>Returns the arity of a <code>rule</code> node.</td></tr>
    346. 

  346. <tr><td valign="top"><a href="#rule_clauses-1">rule_clauses/1</a></td><td>Returns the list of clause subtrees of a <code>rule</code> node.</td></tr>
    347. 

  347. <tr><td valign="top"><a href="#rule_name-1">rule_name/1</a></td><td>Returns the name subtree of a <code>rule</code> node.</td></tr>
    348. 

  348. <tr><td valign="top"><a href="#set_ann-2">set_ann/2</a></td><td>Sets the list of user annotations of <code>Node</code> to
    349. 

  349.   <code>Annotations</code>.</td></tr>
    350. 

  350. <tr><td valign="top"><a href="#set_attrs-2">set_attrs/2</a></td><td>Sets the attributes of <code>Node</code> to
    351. 

  351.   <code>Attributes</code>.</td></tr>
    352. 

  352. <tr><td valign="top"><a href="#set_pos-2">set_pos/2</a></td><td>Sets the position information of <code>Node</code> to
    353. 

  353.   <code>Pos</code>.</td></tr>
    354. 

  354. <tr><td valign="top"><a href="#set_postcomments-2">set_postcomments/2</a></td><td>Sets the post-comments of <code>Node</code> to
    355. 

  355.   <code>Comments</code>.</td></tr>
    356. 

  356. <tr><td valign="top"><a href="#set_precomments-2">set_precomments/2</a></td><td>Sets the pre-comments of <code>Node</code> to
    357. 

  357.   <code>Comments</code>.</td></tr>
    358. 

  358. <tr><td valign="top"><a href="#size_qualifier-2">size_qualifier/2</a></td><td>Creates an abstract size qualifier.</td></tr>
    359. 

  359. <tr><td valign="top"><a href="#size_qualifier_argument-1">size_qualifier_argument/1</a></td><td>Returns the argument subtree (the size) of a
    360. 

  360.   <code>size_qualifier</code> node.</td></tr>
    361. 

  361. <tr><td valign="top"><a href="#size_qualifier_body-1">size_qualifier_body/1</a></td><td>Returns the body subtree of a <code>size_qualifier</code>
    362. 

  362.   node.</td></tr>
    363. 

  363. <tr><td valign="top"><a href="#string-1">string/1</a></td><td>Creates an abstract string literal.</td></tr>
    364. 

  364. <tr><td valign="top"><a href="#string_literal-1">string_literal/1</a></td><td>Returns the literal string represented by a <code>string</code>
    365. 

  365.   node.</td></tr>
    366. 

  366. <tr><td valign="top"><a href="#string_value-1">string_value/1</a></td><td>Returns the value represented by a <code>string</code> node.</td></tr>
    367. 

  367. <tr><td valign="top"><a href="#subtrees-1">subtrees/1</a></td><td>Returns the grouped list of all subtrees of a syntax tree.</td></tr>
    368. 

  368. <tr><td valign="top"><a href="#text-1">text/1</a></td><td>Creates an abstract piece of source code text.</td></tr>
    369. 

  369. <tr><td valign="top"><a href="#text_string-1">text_string/1</a></td><td>Returns the character sequence represented by a
    370. 

  370.   <code>text</code> node.</td></tr>
    371. 

  371. <tr><td valign="top"><a href="#tree-1">tree/1</a></td><td><p>Equivalent to <a href="#tree-2"><tt>tree(Type, [])</tt></a>.</p>
    372. 

  372. </td></tr>
    373. 

  373. <tr><td valign="top"><a href="#tree-2">tree/2</a></td><td><em>For special purposes only</em>.</td></tr>
    374. 

  374. <tr><td valign="top"><a href="#try_after_expr-2">try_after_expr/2</a></td><td><p>Equivalent to <a href="#try_expr-4"><tt>try_expr(Body, [], [], After)</tt></a>.</p>
    375. 

  375. </td></tr>
    376. 

  376. <tr><td valign="top"><a href="#try_expr-2">try_expr/2</a></td><td><p>Equivalent to <a href="#try_expr-3"><tt>try_expr(Body, [], Handlers)</tt></a>.</p>
    377. 

  377. </td></tr>
    378. 

  378. <tr><td valign="top"><a href="#try_expr-3">try_expr/3</a></td><td><p>Equivalent to <a href="#try_expr-4"><tt>try_expr(Body, Clauses, Handlers, [])</tt></a>.</p>
    379. 

  379. </td></tr>
    380. 

  380. <tr><td valign="top"><a href="#try_expr-4">try_expr/4</a></td><td>Creates an abstract try-expression.</td></tr>
    381. 

  381. <tr><td valign="top"><a href="#try_expr_after-1">try_expr_after/1</a></td><td>Returns the list of "after" subtrees of a <code>try_expr</code>
    382. 

  382.   node.</td></tr>
    383. 

  383. <tr><td valign="top"><a href="#try_expr_body-1">try_expr_body/1</a></td><td>Returns the list of body subtrees of a <code>try_expr</code>
    384. 

  384.   node.</td></tr>
    385. 

  385. <tr><td valign="top"><a href="#try_expr_clauses-1">try_expr_clauses/1</a></td><td>Returns the list of case-clause subtrees of a
    386. 

  386.   <code>try_expr</code> node.</td></tr>
    387. 

  387. <tr><td valign="top"><a href="#try_expr_handlers-1">try_expr_handlers/1</a></td><td>Returns the list of handler-clause subtrees of a
    388. 

  388.   <code>try_expr</code> node.</td></tr>
    389. 

  389. <tr><td valign="top"><a href="#tuple-1">tuple/1</a></td><td>Creates an abstract tuple.</td></tr>
    390. 

  390. <tr><td valign="top"><a href="#tuple_elements-1">tuple_elements/1</a></td><td>Returns the list of element subtrees of a <code>tuple</code>
    391. 

  391.   node.</td></tr>
    392. 

  392. <tr><td valign="top"><a href="#tuple_size-1">tuple_size/1</a></td><td>Returns the number of elements of a <code>tuple</code> node.</td></tr>
    393. 

  393. <tr><td valign="top"><a href="#type-1">type/1</a></td><td>Returns the type tag of <code>Node</code>.</td></tr>
    394. 

  394. <tr><td valign="top"><a href="#underscore-0">underscore/0</a></td><td>Creates an abstract universal pattern ("<code>_</code>").</td></tr>
    395. 

  395. <tr><td valign="top"><a href="#update_tree-2">update_tree/2</a></td><td>Creates a syntax tree with the same type and attributes as the
    396. 

  396.   given tree.</td></tr>
    397. 

  397. <tr><td valign="top"><a href="#variable-1">variable/1</a></td><td>Creates an abstract variable with the given name.</td></tr>
    398. 

  398. <tr><td valign="top"><a href="#variable_literal-1">variable_literal/1</a></td><td>Returns the name of a <code>variable</code> node as a string.</td></tr>
    399. 

  399. <tr><td valign="top"><a href="#variable_name-1">variable_name/1</a></td><td>Returns the name of a <code>variable</code> node as an atom.</td></tr>
    400. 

  400. <tr><td valign="top"><a href="#warning_marker-1">warning_marker/1</a></td><td>Creates an abstract warning marker.</td></tr>
    401. 

  401. <tr><td valign="top"><a href="#warning_marker_info-1">warning_marker_info/1</a></td><td>Returns the ErrorInfo structure of a <code>warning_marker</code>
    402. 

  402.   node.</td></tr>
    403. 

  403. </table>
    404. 

  404. 

  405. <h2><a name="functions">Function Details</a></h2>
    406. 

  406. 

  407. <h3><a name="abstract-1">abstract/1</a></h3>
    408. 

  408. <p><tt>abstract(Term::term()) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    409. 

  409. <p>Returns the syntax tree corresponding to an Erlang term.
    410. 

  410.   <code>Term</code> must be a literal term, i.e., one that can be
    411. 

  411.   represented as a source code literal. Thus, it may not contain a
    412. 

  412.   process identifier, port, reference, binary or function value as a
    413. 

  413.   subterm. The function recognises printable strings, in order to get a
    414. 

  414.   compact and readable representation. Evaluation fails with reason
    415. 

  415.   <code>badarg</code> if <code>Term</code> is not a literal term.
    416. 

  416.  </p>
    417. 

  417. <p><b>See also:</b> <a href="#concrete-1">concrete/1</a>, <a href="#is_literal-1">is_literal/1</a>.</p>
    418. 

  418. 

  419. <h3><a name="add_ann-2">add_ann/2</a></h3>
    420. 

  420. <p><tt>add_ann(Annotation::term(), Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    421. 

  421. <p>Appends the term <code>Annotation</code> to the list of user
    422. 

  422.   annotations of <code>Node</code>.
    423. 

  423.  
    424. 

  424.   <p>Note: this is equivalent to <code>set_ann(Node, [Annotation |
    425. 

  425.   get_ann(Node)])</code>, but potentially more efficient.</p>
    426. 

  426.  </p>
    427. 

  427. <p><b>See also:</b> <a href="#get_ann-1">get_ann/1</a>, <a href="#set_ann-2">set_ann/2</a>.</p>
    428. 

  428. 

  429. <h3><a name="add_postcomments-2">add_postcomments/2</a></h3>
    430. 

  430. <p><tt>add_postcomments(Comments::[<a href="#type-syntaxTree">syntaxTree()</a>], Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    431. 

  431. <p>Appends <code>Comments</code> to the post-comments of
    432. 

  432.   <code>Node</code>.
    433. 

  433.  
    434. 

  434.   <p>Note: This is equivalent to <code>set_postcomments(Node,
    435. 

  435.   get_postcomments(Node) ++ Comments)</code>, but potentially more
    436. 

  436.   efficient.</p>
    437. 

  437.  </p>
    438. 

  438. <p><b>See also:</b> <a href="#add_precomments-2">add_precomments/2</a>, <a href="#comment-2">comment/2</a>, <a href="#get_postcomments-1">get_postcomments/1</a>, <a href="#join_comments-2">join_comments/2</a>, <a href="#set_postcomments-2">set_postcomments/2</a>.</p>
    439. 

  439. 

  440. <h3><a name="add_precomments-2">add_precomments/2</a></h3>
    441. 

  441. <p><tt>add_precomments(Comments::[<a href="#type-syntaxTree">syntaxTree()</a>], Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    442. 

  442. <p>Appends <code>Comments</code> to the pre-comments of
    443. 

  443.   <code>Node</code>.
    444. 

  444.  
    445. 

  445.   <p>Note: This is equivalent to <code>set_precomments(Node,
    446. 

  446.   get_precomments(Node) ++ Comments)</code>, but potentially more
    447. 

  447.   efficient.</p>
    448. 

  448.  </p>
    449. 

  449. <p><b>See also:</b> <a href="#add_postcomments-2">add_postcomments/2</a>, <a href="#comment-2">comment/2</a>, <a href="#get_precomments-1">get_precomments/1</a>, <a href="#join_comments-2">join_comments/2</a>, <a href="#set_precomments-2">set_precomments/2</a>.</p>
    450. 

  450. 

  451. <h3><a name="application-2">application/2</a></h3>
    452. 

  452. <p><tt>application(Operator::<a href="#type-syntaxTree">syntaxTree()</a>, Arguments::[<a href="#type-syntaxTree">syntaxTree()</a>]) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    453. 

  453. <p>Creates an abstract function application expression. If
    454. 

  454.   <code>Arguments</code> is <code>[A1, ..., An]</code>, the result
    455. 

  455.   represents "<code><em>Operator</em>(<em>A1</em>, ...,
    456. 

  456.   <em>An</em>)</code>".
    457. 

  457.  </p>
    458. 

  458. <p><b>See also:</b> <a href="#application-3">application/3</a>, <a href="#application_arguments-1">application_arguments/1</a>, <a href="#application_operator-1">application_operator/1</a>.</p>
    459. 

  459. 

  460. <h3><a name="application-3">application/3</a></h3>
    461. 

  461. <p><tt>application(Module, Function::<a href="#type-syntaxTree">syntaxTree()</a>, Arguments::[<a href="#type-syntaxTree">syntaxTree()</a>]) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt>
    462. 

  462. <ul><li><tt>Module = none | <a href="#type-syntaxTree">syntaxTree()</a></tt></li></ul></p>
    463. 

  463. <p>Creates an abstract function application expression. (Utility
    464. 

  464.   function.) If <code>Module</code> is <code>none</code>, this is
    465. 

  465.   call is equivalent to <code>application(Function,
    466. 

  466.   Arguments)</code>, otherwise it is equivalent to
    467. 

  467.   <code>application(module_qualifier(Module, Function),
    468. 

  468.   Arguments)</code>.
    469. 

  469.  </p>
    470. 

  470. <p><b>See also:</b> <a href="#application-2">application/2</a>, <a href="#module_qualifier-2">module_qualifier/2</a>.</p>
    471. 

  471. 

  472. <h3><a name="application_arguments-1">application_arguments/1</a></h3>
    473. 

  473. <p><tt>application_arguments(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; [<a href="#type-syntaxTree">syntaxTree()</a>]</tt></p>
    474. 

  474. <p>Returns the list of argument subtrees of an
    475. 

  475.   <code>application</code> node.
    476. 

  476.  </p>
    477. 

  477. <p><b>See also:</b> <a href="#application-2">application/2</a>.</p>
    478. 

  478. 

  479. <h3><a name="application_operator-1">application_operator/1</a></h3>
    480. 

  480. <p><tt>application_operator(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    481. 

  481. <p>Returns the operator subtree of an <code>application</code>
    482. 

  482.   node.
    483. 

  483.  
    484. 

  484.   <p>Note: if <code>Node</code> represents
    485. 

  485.   "<code><em>M</em>:<em>F</em>(...)</code>", then the result is the
    486. 

  486.   subtree representing "<code><em>M</em>:<em>F</em></code>".</p>
    487. 

  487.  </p>
    488. 

  488. <p><b>See also:</b> <a href="#application-2">application/2</a>, <a href="#module_qualifier-2">module_qualifier/2</a>.</p>
    489. 

  489. 

  490. <h3><a name="arity_qualifier-2">arity_qualifier/2</a></h3>
    491. 

  491. <p><tt>arity_qualifier(Body::<a href="#type-syntaxTree">syntaxTree()</a>, Arity::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    492. 

  492. <p>Creates an abstract arity qualifier. The result represents
    493. 

  493.   "<code><em>Body</em>/<em>Arity</em></code>".
    494. 

  494.  </p>
    495. 

  495. <p><b>See also:</b> <a href="#arity_qualifier_argument-1">arity_qualifier_argument/1</a>, <a href="#arity_qualifier_body-1">arity_qualifier_body/1</a>.</p>
    496. 

  496. 

  497. <h3><a name="arity_qualifier_argument-1">arity_qualifier_argument/1</a></h3>
    498. 

  498. <p><tt>arity_qualifier_argument(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    499. 

  499. <p>Returns the argument (the arity) subtree of an
    500. 

  500.   <code>arity_qualifier</code> node.
    501. 

  501.  </p>
    502. 

  502. <p><b>See also:</b> <a href="#arity_qualifier-1">arity_qualifier/1</a>.</p>
    503. 

  503. 

  504. <h3><a name="arity_qualifier_body-1">arity_qualifier_body/1</a></h3>
    505. 

  505. <p><tt>arity_qualifier_body(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    506. 

  506. <p>Returns the body subtree of an <code>arity_qualifier</code>
    507. 

  507.   node.
    508. 

  508.  </p>
    509. 

  509. <p><b>See also:</b> <a href="#arity_qualifier-1">arity_qualifier/1</a>.</p>
    510. 

  510. 

  511. <h3><a name="atom-1">atom/1</a></h3>
    512. 

  512. <p><tt>atom(Name) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt>
    513. 

  513. <ul><li><tt>Name = atom() | string()</tt></li></ul></p>
    514. 

  514. <p>Creates an abstract atom literal. The print name of the atom is
    515. 

  515.   the character sequence represented by <code>Name</code>.
    516. 

  516.  </p>
    517. 

  517. <p><b>See also:</b> <a href="#atom_literal-1">atom_literal/1</a>, <a href="#atom_name-1">atom_name/1</a>, <a href="#atom_value-1">atom_value/1</a>, <a href="#is_atom-2">is_atom/2</a>.</p>
    518. 

  518. 

  519. <h3><a name="atom_literal-1">atom_literal/1</a></h3>
    520. 

  520. <p><tt>atom_literal(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; string()</tt></p>
    521. 

  521. <p>Returns the literal string represented by an <code>atom</code>
    522. 

  522.   node. This includes surrounding single-quote characters if necessary.
    523. 

  523.  
    524. 

  524.   <p>Note that e.g. the result of <code>atom("x\ny")</code> represents
    525. 

  525.   any and all of <code>'x\ny'</code>, <code>'x\12y'</code>,
    526. 

  526.   <code>'x\012y'</code> and <code>'x\^Jy\'</code>; cf.
    527. 

  527.   <code>string/1</code>.</p>
    528. 

  528.  </p>
    529. 

  529. <p><b>See also:</b> <a href="#atom-1">atom/1</a>, <a href="#string-1">string/1</a>.</p>
    530. 

  530. 

  531. <h3><a name="atom_name-1">atom_name/1</a></h3>
    532. 

  532. <p><tt>atom_name(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; string()</tt></p>
    533. 

  533. <p>Returns the printname of an <code>atom</code> node.
    534. 

  534.  </p>
    535. 

  535. <p><b>See also:</b> <a href="#atom-1">atom/1</a>.</p>
    536. 

  536. 

  537. <h3><a name="atom_value-1">atom_value/1</a></h3>
    538. 

  538. <p><tt>atom_value(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; atom()</tt></p>
    539. 

  539. <p>Returns the value represented by an <code>atom</code> node.
    540. 

  540.  </p>
    541. 

  541. <p><b>See also:</b> <a href="#atom-1">atom/1</a>.</p>
    542. 

  542. 

  543. <h3><a name="attribute-1">attribute/1</a></h3>
    544. 

  544. <p><tt>attribute(Name) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    545. 

  545. <p>Equivalent to <a href="#attribute-2"><tt>attribute(Name, none)</tt></a>.</p>
    546. 

  546. 

  547. 

  548. <h3><a name="attribute-2">attribute/2</a></h3>
    549. 

  549. <p><tt>attribute(Name::<a href="#type-syntaxTree">syntaxTree()</a>, Args::Arguments) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt>
    550. 

  550. <ul><li><tt>Arguments = none | [<a href="#type-syntaxTree">syntaxTree()</a>]</tt></li></ul></p>
    551. 

  551. <p>Creates an abstract program attribute. If
    552. 

  552.   <code>Arguments</code> is <code>[A1, ..., An]</code>, the result
    553. 

  553.   represents "<code>-<em>Name</em>(<em>A1</em>, ...,
    554. 

  554.   <em>An</em>).</code>". Otherwise, if <code>Arguments</code> is
    555. 

  555.   <code>none</code>, the result represents
    556. 

  556.   "<code>-<em>Name</em>.</code>". The latter form makes it possible
    557. 

  557.   to represent preprocessor directives such as
    558. 

  558.   "<code>-endif.</code>". Attributes are source code forms.
    559. 

  559.  
    560. 

  560.   <p>Note: The preprocessor macro definition directive
    561. 

  561.   "<code>-define(<em>Name</em>, <em>Body</em>).</code>" has relatively
    562. 

  562.   few requirements on the syntactical form of <code>Body</code> (viewed
    563. 

  563.   as a sequence of tokens). The <code>text</code> node type can be used
    564. 

  564.   for a <code>Body</code> that is not a normal Erlang construct.</p>
    565. 

  565.  </p>
    566. 

  566. <p><b>See also:</b> <a href="#attribute-1">attribute/1</a>, <a href="#attribute_arguments-1">attribute_arguments/1</a>, <a href="#attribute_name-1">attribute_name/1</a>, <a href="#is_form-1">is_form/1</a>, <a href="#text-1">text/1</a>.</p>
    567. 

  567. 

  568. <h3><a name="attribute_arguments-1">attribute_arguments/1</a></h3>
    569. 

  569. <p><tt>attribute_arguments(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; none | [<a href="#type-syntaxTree">syntaxTree()</a>]</tt></p>
    570. 

  570. <p>Returns the list of argument subtrees of an
    571. 

  571.   <code>attribute</code> node, if any. If <code>Node</code>
    572. 

  572.   represents "<code>-<em>Name</em>.</code>", the result is
    573. 

  573.   <code>none</code>. Otherwise, if <code>Node</code> represents
    574. 

  574.   "<code>-<em>Name</em>(<em>E1</em>, ..., <em>En</em>).</code>",
    575. 

  575.   <code>[E1, ..., E1]</code> is returned.
    576. 

  576.  </p>
    577. 

  577. <p><b>See also:</b> <a href="#attribute-1">attribute/1</a>.</p>
    578. 

  578. 

  579. <h3><a name="attribute_name-1">attribute_name/1</a></h3>
    580. 

  580. <p><tt>attribute_name(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    581. 

  581. <p>Returns the name subtree of an <code>attribute</code> node.
    582. 

  582.  </p>
    583. 

  583. <p><b>See also:</b> <a href="#attribute-1">attribute/1</a>.</p>
    584. 

  584. 

  585. <h3><a name="binary-1">binary/1</a></h3>
    586. 

  586. <p><tt>binary(Fields::[<a href="#type-syntaxTree">syntaxTree()</a>]) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    587. 

  587. <p>Creates an abstract binary-object template. If
    588. 

  588.   <code>Fields</code> is <code>[F1, ..., Fn]</code>, the result
    589. 

  589.   represents "<code>&lt;&lt;<em>F1</em>, ...,
    590. 

  590.   <em>Fn</em>&gt;&gt;</code>".
    591. 

  591.  </p>
    592. 

  592. <p><b>See also:</b> <a href="#binary_field-2">binary_field/2</a>, <a href="#binary_fields-1">binary_fields/1</a>.</p>
    593. 

  593. 

  594. <h3><a name="binary_field-1">binary_field/1</a></h3>
    595. 

  595. <p><tt>binary_field(Body) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    596. 

  596. <p>Equivalent to <a href="#binary_field-2"><tt>binary_field(Body, [])</tt></a>.</p>
    597. 

  597. 

  598. 

  599. <h3><a name="binary_field-2">binary_field/2</a></h3>
    600. 

  600. <p><tt>binary_field(Body::<a href="#type-syntaxTree">syntaxTree()</a>, Types::[<a href="#type-syntaxTree">syntaxTree()</a>]) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    601. 

  601. <p>Creates an abstract binary template field. If
    602. 

  602.   <code>Types</code> is the empty list, the result simply represents
    603. 

  603.   "<code><em>Body</em></code>", otherwise, if <code>Types</code> is
    604. 

  604.   <code>[T1, ..., Tn]</code>, the result represents
    605. 

  605.   "<code><em>Body</em>/<em>T1</em>-...-<em>Tn</em></code>".
    606. 

  606.  </p>
    607. 

  607. <p><b>See also:</b> <a href="#binary-1">binary/1</a>, <a href="#binary_field-1">binary_field/1</a>, <a href="#binary_field-3">binary_field/3</a>, <a href="#binary_field_body-1">binary_field_body/1</a>, <a href="#binary_field_size-1">binary_field_size/1</a>, <a href="#binary_field_types-1">binary_field_types/1</a>.</p>
    608. 

  608. 

  609. <h3><a name="binary_field-3">binary_field/3</a></h3>
    610. 

  610. <p><tt>binary_field(Body::<a href="#type-syntaxTree">syntaxTree()</a>, Size, Types::[<a href="#type-syntaxTree">syntaxTree()</a>]) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt>
    611. 

  611. <ul><li><tt>Size = none | <a href="#type-syntaxTree">syntaxTree()</a></tt></li></ul></p>
    612. 

  612. <p>Creates an abstract binary template field. (Utility function.)
    613. 

  613.   If <code>Size</code> is <code>none</code>, this is equivalent to
    614. 

  614.   "<code>binary_field(Body, Types)</code>", otherwise it is
    615. 

  615.   equivalent to "<code>binary_field(size_qualifier(Body, Size),
    616. 

  616.   Types)</code>".
    617. 

  617.  </p>
    618. 

  618. <p><b>See also:</b> <a href="#binary-1">binary/1</a>, <a href="#binary_field-2">binary_field/2</a>, <a href="#size_qualifier-2">size_qualifier/2</a>.</p>
    619. 

  619. 

  620. <h3><a name="binary_field_body-1">binary_field_body/1</a></h3>
    621. 

  621. <p><tt>binary_field_body(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    622. 

  622. <p>Returns the body subtree of a <code>binary_field</code>.
    623. 

  623.  </p>
    624. 

  624. <p><b>See also:</b> <a href="#binary_field-2">binary_field/2</a>.</p>
    625. 

  625. 

  626. <h3><a name="binary_field_size-1">binary_field_size/1</a></h3>
    627. 

  627. <p><tt>binary_field_size(Node::<a href="#type-syntaxTree">syntaxTree()</a>) -&gt; none | <a href="#type-syntaxTree">syntaxTree()</a></tt></p>
    628. 

  628. <p>Returns the size specifier subtree of a
    629. 

  629.   <code>binary_field</code> node, if any. (Utility function.) If
    630. 

  630.   <code>Node</code> represents
    631. 

  631.   "<code><em>Body</em>:<em>Size</em></code>" or
    632. 

  632.   "<code><em>Body</em>:<em>Size</em>/<em>T1</em>, ...,
    633. 

  633.   <em>Tn</em></code>", the result is <code>Size</code>, otherwise
    634. 

  634.   <code>none</code> is returned.
    635. 

  635.  </p>
    636. 

  636. <p><b>See also:</b> <a href="#binary_field-2">binary_field/2</a>, <a href="#binary_fie…
    637.

Large files files are truncated, but you can click here to view the full file