From 8a7f914affce3102e4889c2973ea2d2e99ad633d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Mon, 16 Jan 2017 16:47:58 +0100
Subject: Teach the ASN.1 compiler the 'maps' option

When the 'maps' option is given, the SEQUENCE and SET types are
represented as maps instead of as records. Optional and default values
must be not be given as asn1_NOVALUE or asn1_DEFAULT in a map passed
to the M:encode/2 function; they must be omitted from the
map. Similarly, when decoding missing values will be omitted from the
map.

No .hrl files will be generated when the 'maps' options is used.
That means values in an ASN.1 module must be retrieved by calling the
appropriate function in generated module.

Since we one day hope to get rid of the options 'compact_bit_string',
'legacy_bit_string', and 'legacy_erlang_types', we will not allow them
to be combined with the 'maps' option.
---
 lib/asn1/doc/src/asn1ct.xml | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'lib/asn1/doc/src/asn1ct.xml')

diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml
index ebe1ce44dc..859d6a50bb 100644
--- a/lib/asn1/doc/src/asn1ct.xml
+++ b/lib/asn1/doc/src/asn1ct.xml
@@ -170,11 +170,24 @@ File3.asn</pre>
               as for <c>ber</c>.
 	    </p>
           </item>
+          <tag><c>maps</c></tag>
+          <item>
+	    <p>This option changes the representation of the types
+	    <c>SEQUENCE</c> and <c>SET</c> to use maps (instead of
+	    records).  This option also suppresses the generation of
+	    <c>.hrl</c> files.</p>
+	    <p>For details, see Section
+	      <seealso marker="asn1_getting_started#MAP_SEQ_SET">
+		Map representation for SEQUENCE and SET</seealso>
+		in the User's Guide.
+	    </p>
+	  </item>
           <tag><c>compact_bit_string</c></tag>
           <item>
             <p>
 	      The <c>BIT STRING</c> type is decoded to "compact notation".
 	      <em>This option is not recommended for new code.</em>
+	      This option cannot be combined with the option <c>maps</c>.
 	    </p>
 	    <p>For details, see Section
 	      <seealso marker="asn1_getting_started#BIT STRING">
@@ -188,6 +201,7 @@ File3.asn</pre>
 	      The <c>BIT STRING</c> type is decoded to the legacy
 	      format, that is, a list of zeroes and ones.
 	      <em>This option is not recommended for new code.</em>
+	      This option cannot be combined with the option <c>maps</c>.
 	    </p>
 	    <p>For details, see Section
 	      <seealso marker="asn1_getting_started#BIT STRING">BIT STRING</seealso>
@@ -202,7 +216,8 @@ File3.asn</pre>
             marker="asn1_getting_started#BIT STRING">BIT STRING</seealso> and Section
             <seealso marker="asn1_getting_started#OCTET STRING">OCTET
             STRING</seealso> in the User's Guide.</p>
-	    <p><em>This option is not recommended for new code.</em></p>
+	    <p><em>This option is not recommended for new code.</em>
+	    This option cannot be combined with the option <c>maps</c>.</p>
 	  </item>
           <tag><c>{n2n, EnumTypeName}</c></tag>
           <item>
-- 
cgit v1.2.3