Skip to content

Commit 2b1a5e8

Browse files
arobenkoarobenko
committed
Release v6.0
2 parents 985bbf6 + 75957e6 commit 2b1a5e8

23 files changed

+525
-136
lines changed

‎CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ if (NOT ASCIIDOCTOR_PDF_EXE)
1111
message(FATAL_ERROR "asciidoctor-pdf is not found")
1212
endif ()
1313

14-
set (VERSION "v5.0")
14+
set (VERSION "v6.0")
1515
set (MAIN_FILE "${PROJECT_SOURCE_DIR}/commsdsl_spec.adoc")
1616

1717
add_custom_target("pdf" ALL

‎appendix/alias.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Introduced in DSL version **3**.
88
|===
99
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
1010

11-
|**name**|<<intro-names, name>> string|3|yes||Name of the alias.
1211
|**description**|string|3|no||Human readable description of the alias.
1312
|**field**|relative <<intro-references, reference>> string|3|yes||Reference to the aliased field, must start with `$` character.
13+
|**name**|<<intro-names, name>> string|3|yes||Name of the alias.
1414
|===

‎appendix/bundle.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Extra child XML elements allowed:
1818
|===
1919
|XML Element|DSL Version ^.^|Description
2020

21-
|**&lt;members&gt;**|1|Wraps member fields.
2221
|**&lt;alias&gt;**|3|Alias names for other member fields. See <<aliases-aliases, Aliases>> for more info.
22+
|**&lt;members&gt;**|1|Wraps member fields.
2323
|**&lt;replace&gt;**|5|Wraps replacing member fields after copying using **reuse** property.
2424
|===

‎appendix/custom.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ for detailed description.
88
[cols="^.^27,^.^11,^.^8,^.^10,^.^10,34", options="header"]
99
|===
1010
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
11+
|**checksumFrom**|<<intro-names, name>> string|5|no (unless **semanticLayerType** is "checksum" and **checksumUntil** is empty)||Name of the frame layer, from which the checksum calculation starts. Applicable only when `semanticLayerType="checksum"`.
12+
|**checksumUntil**|<<intro-names, name>> string|5|no (unless **semanticLayerType** is "checksum" and **checksumFrom** is empty)||Name of the frame layer, until (and including) which the checksum calculation is executed. Applicable only when `semanticLayerType="checksum"`.
1113
|**[.line-through]#idReplacement#**|<<intro-boolean, bool>>|1|no|false|Mark the layer as one replacing <<frames-id, &lt;id&gt; >>. +
1214
**Deprecated**, use `semanticLayerType="id"` instead.
1315
|**semanticLayerType**|"payload", "id", "size", "sync", "checksum", "value", "custom"|5|no|custom|Specify what other layer **&lt;custom&gt;** one is replacing.
14-
|**checksumFrom**|<<intro-names, name>> string|5|no (unless **semanticLayerType** is "checksum" and **checksumUntil** is empty)||Name of the frame layer, from which the checksum calculation starts. Applicable only when `semanticLayerType="checksum"`.
15-
|**checksumUntil**|<<intro-names, name>> string|5|no (unless **semanticLayerType** is "checksum" and **checksumFrom** is empty)||Name of the frame layer, until (and including) which the checksum calculation is executed. Applicable only when `semanticLayerType="checksum"`.
1616
|===

‎appendix/enum.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,28 @@ for detailed description.
99
|===
1010
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
1111

12-
|**type**|"int8", "uint8", "int16", "uint16", "int32", "uint32", "int64", "uint64", "intvar", "uintvar"|1|yes||Underlying primitive type.
12+
|**availableLengthLimit**|<<intro-boolean, bool>>|4|no|false|Allow having less bytes in the buffer than required by the **type** when performing (de)serialization.
13+
|**bitLength**|<<intro-numeric, unsigned>>|1|no|length of **type** in bits|Serialization length in bits, applicable only to a member of <<fields-bitfield, &lt;bitfield&gt; >>.
1314
|**defaultValue**|<<intro-numeric, numeric>> or <<intro-names, name>>|1|no|0|Default value. Must fit the underlying **type**.
1415
|**endian**|"big" or "little"|1|no|endian of <<schema-schema, schema>>|Endian of the field.
15-
|**length**|<<intro-numeric, unsigned>>|1|no|length of **type**|Forced serialization length.
16-
|**bitLength**|<<intro-numeric, unsigned>>|1|no|length of **type** in bits|Serialization length in bits, applicable only to a member of <<fields-bitfield, &lt;bitfield&gt; >>.
1716
|**hexAssign**|<<intro-boolean, bool>>|1|no|false|Force generated code to assign enum values using hexadecimal numbers.
17+
|**length**|<<intro-numeric, unsigned>>|1|no|length of **type**|Forced serialization length.
1818
|**nonUniqueAllowed**|<<intro-boolean, bool>>|1|no|false|Allow non unique **&lt;validValue&gt;**-es.
19+
|**type**|"int8", "uint8", "int16", "uint16", "int32", "uint32", "int64", "uint64", "intvar", "uintvar"|1|yes||Underlying primitive type.
1920
|**validCheckVersion**|<<intro-boolean, bool>>|1|no|false|Take into account protocol version when generating code for field's value validity check.
20-
|**availableLengthLimit**|<<intro-boolean, bool>>|4|no|false|Allow having less bytes in the buffer than required by the **type** when performing (de)serialization.
2121
|===
2222

2323
==== Properties of &lt;validValue&gt; Child Element of &lt;enum&gt; Field ====
2424
[cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
2525
|===
2626
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
2727

28-
|**name**|<<intro-names, name>> string|1|yes||Name of the value.
29-
|**val**|<<intro-numeric, numeric>>|1|yes||Numeric value.
28+
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which value was deprecated. +
29+
Must be greater than value of **sinceVersion**.
3030
|**description**|string|1|no||Human readable description of the value.
3131
|**displayName**|string|1|no||Human readable name of the value to display in various analysis tools.
32+
|**name**|<<intro-names, name>> string|1|yes||Name of the value.
3233
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which value was introduced.
33-
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which value was deprecated. +
34-
Must be greater than value of **sinceVersion**.
34+
|**val**|<<intro-numeric, numeric>>|1|yes||Numeric value.
3535
|===
3636

‎appendix/fields.adoc

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ Refer to <<fields-common, Common Properties of Fields>> chapter for detailed des
88
|===
99
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
1010

11-
|**name**|<<intro-names, name>> string|1|yes||Name of the field.
11+
|**copyCodeFrom**|<<intro-references, reference>> string|5|no||Specify field, overriding or other extra code of which needs to be copied.
12+
|**customizable**|<<intro-boolean, bool>>|1|no|false|Mark the field to allow compile time customization regardless of code generator's level of customization.
13+
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which field was deprecated. +
14+
Must be greater than value of **sinceVersion**. +
15+
Applipable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
1216
|**description**|string|1|no||Human readable description of the field.
13-
|**reuse**|<<intro-references, reference>> string|1|no||Field, definition of which to copy.
17+
|**displayHidden**|<<intro-boolean, bool>>|1|no|false|Don't display field at all in visual analysis tool(s).
1418
|**displayName**|string|1|no||Name of the field to display. If empty, the code generator must use value of property **name** instead. In order to force empty name to display, use "_" (underscore).
1519
|**displayReadOnly**|<<intro-boolean, bool>>|1|no|false|Disable modification of the field in visual analysis tool(s).
16-
|**displayHidden**|<<intro-boolean, bool>>|1|no|false|Don't display field at all in visual analysis tool(s).
17-
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which field was introduced. +
18-
Applicable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
19-
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which field was deprecated. +
20-
Must be greater than value of **sinceVersion**. +
21-
Applipable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
22-
|**removed**|<<intro-boolean, bool>>|1|no|false|Indicates whether deprecated field has been removed from being serialized. +
23-
Applicable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
2420
|**failOnInvalid**|<<intro-boolean, bool>>|1|no|false|Fail *read* operation if read value is invalid.
25-
|**pseudo**|<<intro-boolean, bool>>|1|no|false|In case of **true**, don't serialize/deserialize this field.
26-
|**customizable**|<<intro-boolean, bool>>|1|no|false|Mark the field to allow compile time customization regardless of code generator's level of customization.
27-
|**semanticType**|"none", "messageId", "version", "length"|1|no|none|Specify semantic type of the field. It allows code generator to generate special code for special cases. Value "length" was introduced in **v2** of this specification.
2821
|**forceGen**|<<intro-boolean, bool>>|3|no|false|Force generation of field's code regardless of it's being referenced or not.
29-
|**valueOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **value** operation.
30-
|**readOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **read** operation.
31-
|**writeOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **write** operation.
32-
|**refreshOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **refresh** operation.
3322
|**lengthOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **length** retrieval.
34-
|**validOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **valid** retrieval.
23+
|**name**|<<intro-names, name>> string|1|yes||Name of the field.
3524
|**nameOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **name** retrieval.
36-
|**copyCodeFrom**|<<intro-references, reference>> string|5|no||Specify field, overriding or other extra code of which needs to be copied.
25+
|**pseudo**|<<intro-boolean, bool>>|1|no|false|In case of **true**, don't serialize/deserialize this field.
26+
|**readOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **read** operation.
27+
|**refreshOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **refresh** operation.
28+
|**removed**|<<intro-boolean, bool>>|1|no|false|Indicates whether deprecated field has been removed from being serialized. +
29+
Applicable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
30+
|**reuse**|<<intro-references, reference>> string|1|no||Field, definition of which to copy.
3731
|**reuseCode**|<<intro-boolean, bool>>|5|no|false|In case of **reuse** apply **copyCodeFrom** with the same <<intro-references, reference>> string.
32+
|**semanticType**|"none", "messageId", "version", "length"|1|no|none|Specify semantic type of the field. It allows code generator to generate special code for special cases. Value "length" was introduced in **v2** of this specification.
33+
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which field was introduced. +
34+
Applicable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
35+
|**validOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **valid** retrieval.
36+
|**valueOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **value** operation.
37+
|**writeOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **write** operation.
3838
|===

‎appendix/float.adoc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,31 @@ for detailed description.
99
|===
1010
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
1111

12-
|**type**|"float", "double"|1|yes||Underlying primitive type
1312
|**defaultValue**|floating point value, **nan**, **inf**, **-inf**|1|no|0.0|Default value. Must fit the underlying **type**.
13+
|**displayDecimals**|<<intro-numeric, numeric>>|1|no|0|Indicates to GUI analysis how many digits need to be displayed after the fraction point.
14+
|**displaySpecials**|<<intro-boolean, bool>>|2|no|true|Control displaying **&lt;special&gt;** values in analysis tools.
1415
|**endian**|"big" or "little"|1|no|endian of <<schema-schema, schema>>|Endian of the field.
16+
|**nonUniqueSpecialsAllowed**|<<intro-boolean, bool>>|2|no|false|Allow non unique **&lt;special&gt;**-s.
17+
|**type**|"float", "double"|1|yes||Underlying primitive type
1518
|**units**|<<appendix-units, units>>|1|no||Units of the value.
19+
|**validCheckVersion**|<<intro-boolean, bool>>|1|no|false|Take into account protocol version when generating code for field's value validity check.
20+
|**validFullRange**|<<intro-boolean, bool>>|1|no|false|Mark all the range of existing FP values to be valid, excluding **nan**, **inf**, and **-inf**.
21+
|**validMax**|floating point value|1|no||Valid maximal value. All the numbers below it are considered to be valid.
22+
|**validMin**|floating point value|1|no||Valid minimal value. All the numbers above it are considered to be valid.
1623
|**validRange**|"[ fp_value, fp_value ]"|1|no||Range of valid values.
1724
|**validValue**|floating point value, **nan**, **inf**, **-inf**|1|no||Valid value.
18-
|**validMin**|floating point value|1|no||Valid minimal value. All the numbers above it are considered to be valid.
19-
|**validMax**|floating point value|1|no||Valid maximal value. All the numbers below it are considered to be valid.
20-
|**validFullRange**|<<intro-boolean, bool>>|1|no|false|Mark all the range of existing FP values to be valid, excluding **nan**, **inf**, and **-inf**.
21-
|**validCheckVersion**|<<intro-boolean, bool>>|1|no|false|Take into account protocol version when generating code for field's value validity check.
22-
|**displayDecimals**|<<intro-numeric, numeric>>|1|no|0|Indicates to GUI analysis how many digits need to be displayed after the fraction point.
23-
|**nonUniqueSpecialsAllowed**|<<intro-boolean, bool>>|2|no|false|Allow non unique **&lt;special&gt;**-s.
24-
|**displaySpecials**|<<intro-boolean, bool>>|2|no|true|Control displaying **&lt;special&gt;** values in analysis tools.
2525
|===
2626

27-
2827
==== Properties of &lt;special&gt; Child Element of &lt;float&gt; Field ====
2928
[cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
3029
|===
3130
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
3231

33-
|**name**|<<intro-names, name>> string|1|yes||Name of the value.
34-
|**val**|floating point value, **nan**, **inf**, **-inf**|1|yes||Numeric value.
35-
|**description**|string|1|no||Human readable description of the value.
36-
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which value was introduced.
37-
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which value was deprecated. +
32+
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which value was deprecated. +
3833
Must be greater than value of **sinceVersion**.
34+
|**description**|string|1|no||Human readable description of the value.
3935
|**displayName**|string|2|no||Name to display in various analysis tools.
36+
|**name**|<<intro-names, name>> string|1|yes||Name of the value.
37+
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which value was introduced.
38+
|**val**|floating point value, **nan**, **inf**, **-inf**|1|yes||Numeric value.
4039
|===

‎appendix/frame.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ for detailed description.
88
|===
99
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
1010

11-
|**name**|<<intro-names, name>> string|1|yes||Name of the frame.
1211
|**description**|string|1|no||Human readable description of the frame.
12+
|**name**|<<intro-names, name>> string|1|yes||Name of the frame.
1313
|===
1414

1515
Extra child XML elements allowed:

0 commit comments

Comments
 (0)