From 74cee7dc1cc5b0332cd851da4953ebbb98224b5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Tue, 8 Jan 2013 10:56:27 +0100 Subject: By default, encode BIT STRING to bitstrings Add the option 'legacy_bit_string' to decode to the old list format. --- lib/asn1/doc/src/asn1_ug.xml | 77 +++++++++++++++++++++++--------------------- lib/asn1/doc/src/asn1ct.xml | 31 ++++++++++-------- 2 files changed, 58 insertions(+), 50 deletions(-) (limited to 'lib/asn1/doc') diff --git a/lib/asn1/doc/src/asn1_ug.xml b/lib/asn1/doc/src/asn1_ug.xml index ecca287670..a0ab98cf7a 100644 --- a/lib/asn1/doc/src/asn1_ug.xml +++ b/lib/asn1/doc/src/asn1_ug.xml @@ -324,13 +324,6 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn are several places to search in. The compiler will always search the current directory first.

- +compact_bit_string - -

Gives the user the option to use a compact format of the BIT - STRING type to save memory space, typing space and - increase encode/decode performance, for details see - BIT STRING type section.

- +der

DER encoding rule. Only when using -ber option.

@@ -649,7 +642,7 @@ Day1 = saturday,
- BIT STRING + BIT STRING

The BIT STRING type can be used to model information which is made up of arbitrary length series of bits. It is intended to be used for a selection of flags, not for binary files.

@@ -660,56 +653,66 @@ Day1 = saturday, Bits1 ::= BIT STRING Bits2 ::= BIT STRING {foo(0),bar(1),gnu(2),gnome(3),punk(14)} -

There are four different notations available for representation of +

There are five different notations available for representation of BIT STRING values in Erlang and as input to the encode functions.

- A list of binary digits (0 or 1). - A hexadecimal number (or an integer). This format should be - avoided, since it is easy to misinterpret a BIT STRING - value in this format. This format may be withdrawn in a future - release. + A bitstring. By default, a BIT STRING with no + symbolic names will be decoded to an Erlang bitstring. A list of atoms corresponding to atoms in the NamedBitList - in the BIT STRING definition. + in the BIT STRING definition. A BIT STRING with symbolic + names will always be decoded to this format. + A list of binary digits (0 or 1). This format is always + accepted as input to the encode functions. A BIT STRING will + be decoded to this format if legacy_bit_string option + has been given. This format may be withdrawn in a future + release. + As {Unused,Binary} where Unused denotes how - many trailing zero-bits 0 to 7 that are unused in the least - significant byte in Binary. This notation is only - available when the ASN.1 files have been compiled with the - +compact_bit_string flag in the option list. In - this case it is possible to use all kinds of notation when - encoding. But the result when decoding is always in the - compact form. The benefit from this notation is a more - compact notation when one has large BIT STRINGs. The - encode/decode performance is also much better in the case of - large BIT STRINGs. + many trailing zero-bits 0 to 7 that are unused in the least + significant byte in Binary. This format is always + accepted as input to the encode functions. A BIT STRING will + be decoded to this format if compact_bit_string has + been given. This format may be withdrawn in a future + release. + + A hexadecimal number (or an integer). This format should be + avoided, since it is easy to misinterpret a BIT STRING + value in this format. This format may be withdrawn in a future + release. + -

Note that it is advised not to use the integer format of a - BIT STRING, see the second point above.

+

It is recommended to either use the bitstring format (for + BIT STRINGs with no symbolic names) or a list of symbolic + names (for BIT STRINGs with symbolic names). The other formats + should be avoided since they may be withdrawn in a future + release. + 

-Bits1Val1 = [0,1,0,1,1],
+Bits1Val1 = <<0:1,1:1,0:1,1:1,1:1>>,
 Bits1Val2 = 16#1A,
-Bits1Val3 = {3,<<0:1,1:1,0:1,1:1,1:1,0:3>>}
+Bits1Val3 = {3,<<0:1,1:1,0:1,1:1,1:1,0:3>>},
+Bits1Val4 = [0,1,0,1,1]
-

Note that Bits1Val1, Bits1Val2 and Bits1Val3 - denote the same value.

+

Note that Bits1Val1, Bits1Val2, Bits1Val3, + and Bits1Val1 denote the same value.

 Bits2Val1 = [gnu,punk],
-Bits2Val2 = 2#1110,
+Bits2Val2 = <<2#1110:4>>,
 Bits2Val3 = [bar,gnu,gnome],
-Bits2Val4 = [0,1,1,1]
-

The above Bits2Val2, Bits2Val3 and Bits2Val4 - also all denote the same value.

+

Bits2Val2 and Bits2Val3 above denote the same value.

Bits2Val1 is assigned symbolic values. The assignment means that the bits corresponding to gnu and punk i.e. bits 2 and 14 are set to 1 and the rest set to 0. The symbolic values appear as a list of values. If a named value appears, which is not specified in the type definition, a run-time error will occur.

The compact notation equivalent to the empty BIT STRING is - >}]]>, which in the other notations is [] or + >}]]>, which in the other notations is + >]]>, [], or 0.

-

BIT STRINGS may also be sub-typed with for example a SIZE +

BIT STRINGS may also be sub-typed with, for example, a SIZE specification:

 Bits3 ::= BIT STRING (SIZE(0..31))
diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml index 7ad4d14610..b269276a92 100644 --- a/lib/asn1/doc/src/asn1ct.xml +++ b/lib/asn1/doc/src/asn1ct.xml @@ -64,6 +64,7 @@ Asn1module = atom() | string() Options = [Option| OldOption] Option = ber | per | uper | der | compact_bit_string | + legacy_bit_string | noobj | {n2n, EnumTypeName} |{outdir, Dir} | {i, IncludeDir} | asn1config | undec_rest | {macro_name_prefix, Prefix} | {record_name_prefix, Prefix} | verbose | warnings_as_errors @@ -154,22 +155,26 @@ File3.asn compact_bit_string

- Makes it possible to use a compact notation for values - of the BIT STRING type in Erlang. The notation: + The BIT STRING type will be decoded to the "compact notation". + This option is not recommended for new code.

- 
-BitString = {Unused, Binary},
-Unused = integer(),
-Binary = binary()            
-
+

For details see + + BIT STRING type section in the Users Guide + . +

+ + legacy_bit_string +

- Unused must be a number in the range 0 to 7. It - tells how many bits in the least significant byte in - Binary that is unused. - For details see + The BIT STRING type will be decoded to the legacy + format, i.e. a list of zeroes and ones. + This option is not recommended for new code. +

+

For details see - BIT STRING type section in users guide - . + BIT STRING type section in the Users Guide + .

{n2n, EnumTypeName} -- cgit v1.2.3