From 3c2be863bde4965a1ac61092b1348b96397940cb Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Mon, 9 Mar 2015 16:25:00 +0100
Subject: stdlib: Add module erl_anno

Introduce erl_anno, an abstraction of the second element of tokens and
tuples in the abstract format. The convention that negative line
numbers can be used for silencing compiler warnings will no longer
work in OTP 19; instead the annotation 'generated' is to be used.
---
 lib/stdlib/doc/src/erl_parse.xml | 98 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 95 insertions(+), 3 deletions(-)

(limited to 'lib/stdlib/doc/src/erl_parse.xml')

diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml
index cf0bff48cd..b97d06e919 100644
--- a/lib/stdlib/doc/src/erl_parse.xml
+++ b/lib/stdlib/doc/src/erl_parse.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1996</year><year>2014</year>
+      <year>1996</year><year>2015</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -192,6 +192,97 @@
           considered a string.</p>
       </desc>
     </func>
+    <func>
+      <name name="map_anno" arity="2"/>
+      <fsummary>
+        Map a function over the annotations of an abstract form
+      </fsummary>
+      <desc>
+        <p>Modifies the abstract form <anno>Abstr</anno> by applying
+          <anno>Fun</anno> on every collection of annotations of the
+          abstract form. The abstract form is traversed in a
+          depth-first, left-to-right, fashion.
+        </p>
+      </desc>
+    </func>
+    <func>
+      <name name="fold_anno" arity="3"/>
+      <fsummary>
+        Fold a function over the annotations of an abstract form
+      </fsummary>
+      <desc>
+        <p>Updates an accumulator by applying <anno>Fun</anno> on
+          every collection of annotations of the abstract form
+          <anno>Abstr</anno>. The first call to <anno>Fun</anno> has
+          <anno>AccIn</anno> as argument, and the returned accumulator
+          <anno>AccOut</anno> is passed to the next call, and so on.
+          The final value of the accumulator is returned. The abstract
+          form is traversed in a depth-first, left-to-right, fashion.
+        </p>
+      </desc>
+    </func>
+    <func>
+      <name name="mapfold_anno" arity="3"/>
+      <fsummary>
+        Map and fold a function over the annotations of an abstract form
+      </fsummary>
+      <desc>
+        <p>Modifies the abstract form <anno>Abstr</anno> by applying
+          <anno>Fun</anno> on every collection of annotations of the
+          abstract form, while at the same time updating an
+          accumulator. The first call to <anno>Fun</anno> has
+          <anno>AccIn</anno> as second argument, and the returned
+          accumulator <anno>AccOut</anno> is passed to the next call,
+          and so on. The modified abstract form as well as the the
+          final value of the accumulator is returned. The abstract
+          form is traversed in a depth-first, left-to-right, fashion.
+        </p>
+      </desc>
+    </func>
+    <func>
+      <name name="new_anno" arity="1"/>
+      <fsummary>
+        Create new annotations
+      </fsummary>
+      <desc>
+        <p>Creates an abstract form from a term which has the same
+          structure as an abstract form, but <seealso
+          marker="erl_anno#type-location">locations</seealso> where the
+          abstract form has annotations. For each location, <seealso
+          marker="erl_anno#new/1"><c>erl_anno:new/1</c></seealso> is
+          called, and the annotations replace the location.
+        </p>
+      </desc>
+    </func>
+    <func>
+      <name name="anno_from_term" arity="1"/>
+      <fsummary>
+        Return annotations as terms
+      </fsummary>
+      <desc>
+        <p>Assumes that <anno>Term</anno> is a term with the same
+          structure as an abstract form, but with terms, T say, on
+          those places where an abstract form has annotations. Returns
+          an abstract form where every term T has been replaced by the
+          value returned by calling <c>erl_anno:from_term(T)</c>. The
+          term <anno>Term</anno> is traversed in a depth-first,
+          left-to-right, fashion.
+        </p>
+      </desc>
+    </func>
+    <func>
+      <name name="anno_to_term" arity="1"/>
+      <fsummary>
+        Return the representation of annotations
+      </fsummary>
+      <desc>
+        <p>Returns a term where every collection of annotations Anno of
+          <anno>Abstr</anno> has been replaced by the term returned by
+          calling <c>erl_anno:to_term(Anno)</c>. The abstract form is
+          traversed in a depth-first, left-to-right, fashion.
+        </p>
+      </desc>
+    </func>
   </funcs>
 
   <section>
@@ -211,8 +302,9 @@
   <section>
     <title>See Also</title>
     <p><seealso marker="io">io(3)</seealso>,
-      <seealso marker="erl_scan">erl_scan(3)</seealso>,
-      ERTS User's Guide</p>
+       <seealso marker="erl_anno">erl_anno(3)</seealso>,
+       <seealso marker="erl_scan">erl_scan(3)</seealso>,
+       <seealso marker="erts:absform">ERTS User's Guide</seealso></p>
   </section>
 </erlref>
 
-- 
cgit v1.2.3