From a07a1d465994427d322c523f26dcabefeb14cf01 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Magnus=20L=C3=A5ng?= <margnus1@telia.com>
Date: Sat, 27 Feb 2016 18:49:33 +0100
Subject: erl_parse: Add parsing for new map type syntax

erl_types typesets mandatory keys with :=, and uses "..." as a shorthand
for "any() => any()". Add these to erl_parse so that all representable
types can be written in type-specs.
---
 system/doc/reference_manual/typespec.xml | 32 +++++++++++++++++++++++---------
 1 file changed, 23 insertions(+), 9 deletions(-)

(limited to 'system')

diff --git a/system/doc/reference_manual/typespec.xml b/system/doc/reference_manual/typespec.xml
index c5d24a96b5..36ae252b2f 100644
--- a/system/doc/reference_manual/typespec.xml
+++ b/system/doc/reference_manual/typespec.xml
@@ -132,15 +132,18 @@
         | nonempty_list(Type)                  %% Proper non-empty list
 
   Map :: map()                                 %% stands for a map of any size
-       | #{}                                   %% stands for a map of any size
+       | #{}                                   %% stands for the empty map
        | #{PairList}
 
   Tuple :: tuple()                             %% stands for a tuple of any size
          | {}
          | {TList}
 
-  PairList :: Type => Type
-            | Type => Type, PairList
+  PairList :: Pair
+            | Pair, PairList
+
+  Pair :: Type := Type                         %% notes a pair that must be present
+        | Type => Type
 
   TList :: Type
          | Type, TList
@@ -169,6 +172,23 @@
     elements of unknown type, is <c>[_]</c> (or <c>[any()]</c>), not <c>[]</c>. 
     The notation <c>[]</c> specifies the singleton type for the empty list.
   </p>
+  <p>
+    The general form of maps is <c>#{PairList}</c>. The key types in
+    <c>PairList</c> are allowed to overlap, and if they do, the leftmost pair
+    takes precedence. A map value does not belong to this type if contains a key
+    that is not in <c>PairList</c>.
+  </p>
+  <p>
+    Because it is common to end a map type with <c>any() =&gt; any()</c> to denote
+    that keys that do not belong to any other pair in <c>PairList</c> are
+    allowed, and may map to any value, the shorhand notation <c>...</c> is
+    allowed as the last pair of a map type.
+  </p>
+  <p>
+    Notice that the syntactic representation of <c>map()</c> is <c>#{...}</c>
+    (or <c>#{_ =&gt; _}</c>, or <c>#{any() =&gt; any()}</c>), not <c>#{}</c>.
+    The notation <c>#{}</c> specifies the singleton type for the empty map.
+  </p>
   <p>
     For convenience, the following types are also built-in. 
     They can be thought as predefined aliases for the type unions also shown in 
@@ -302,12 +322,6 @@
     This is described in <seealso marker="#typeinrecords">
     Type Information in Record Declarations</seealso>.
   </p>
-  <note>
-    <p>Map types, both <c>map()</c> and <c>#{...}</c>,
-      are considered experimental during OTP 17.</p>
-    <p>No type information of maps pairs, only the containing map types,
-      are used by Dialyzer in OTP 17.</p>
-  </note>
   </section>
 
   <section>
-- 
cgit v1.2.3