annotation for const and enum (#251)

mohapatr3 · web-flow · commit 192c3095c19e · 2024-12-11T10:39:08.000+01:00
Add type annotations for C++ enumerations and constants literals.

Signed-off-by: mohapatr3 &lt;prasanta.mohapatra@here.com&gt;
diff --git a/flatdata-cpp/include/flatdata/DebugDataAccessStatistics.h b/flatdata-cpp/include/flatdata/DebugDataAccessStatistics.h
@@ -20,6 +20,7 @@
 #include <shared_mutex>
 #include <utility>
 #include <vector>
+#include <algorithm>
 
 namespace flatdata
 {
diff --git a/flatdata-generator/flatdata/generator/templates/cpp/constant.jinja2 b/flatdata-generator/flatdata/generator/templates/cpp/constant.jinja2
@@ -4,6 +4,6 @@ enum : {{ node.type|cpp_base_type}}
 {% if node.doc %}
     {{- node.doc|cpp_doc }}
 {% endif %}
-    {{ node.name }} = {{ node.value }}
+    {{ node.name }} = {{ node.value }}{{ node.type.annotation }}
 };
 {%- endmacro %}
diff --git a/flatdata-generator/flatdata/generator/templates/cpp/enumeration.jinja2 b/flatdata-generator/flatdata/generator/templates/cpp/enumeration.jinja2
@@ -9,7 +9,7 @@ enum class {{ enum.name }} : {{ enum.type|cpp_base_type }}
     {% if value.doc %}
     {{ value.doc|cpp_doc }}
     {% endif %}
-    {{ value.name }} = {{ value.value }}{{ "," if not loop.last }}
+    {{ value.name }} = {{ value.value }}{{ enum.type.annotation }}{{ "," if not loop.last }}
     {% endfor %}
 };
 
diff --git a/flatdata-generator/flatdata/generator/tree/helpers/basictype.py b/flatdata-generator/flatdata/generator/tree/helpers/basictype.py
@@ -16,6 +16,18 @@ class BasicType:
         "i64": 64
     }
 
+    _TYPE_ANNOTATION = {
+        "bool": "",
+        "u8": "",
+        "i8": "",
+        "u16": "",
+        "i16": "",
+        "u32": "UL",
+        "i32": "L",
+        "u64": "ULL",
+        "i64": "LL"
+    }
+
     @staticmethod
     def is_basic_type(name):
         return name in grammar.BASIC_TYPES
@@ -41,6 +53,10 @@ def width(self):
     def is_signed(self):
         return self._name[0] == 'i'
 
+    @property
+    def annotation(self):
+        return self._TYPE_ANNOTATION[self._name]
+
     def bits_required(self, value):
         if self.is_signed:
             if value >= 0:
diff --git a/flatdata-generator/flatdata/generator/tree/helpers/enumtype.py b/flatdata-generator/flatdata/generator/tree/helpers/enumtype.py
@@ -15,6 +15,10 @@ def name(self):
     def width(self):
         return self._type.width
 
+    @property
+    def annotation(self):
+        return self._type.annotation
+
     @property
     def is_signed(self):
         return self._type.is_signed
diff --git a/flatdata-generator/tests/generators/cpp_expectations/constants/comments.h.1 b/flatdata-generator/tests/generators/cpp_expectations/constants/comments.h.1
@@ -1,5 +1,5 @@
 enum : uint32_t
 {
 // This is a comment about foo
-    FOO = 0
+    FOO = 0UL
 };
diff --git a/flatdata-generator/tests/generators/cpp_expectations/constants/comments.h.2 b/flatdata-generator/tests/generators/cpp_expectations/constants/comments.h.2
@@ -3,5 +3,5 @@ enum : uint64_t
 /*
  * This is a comment about bar
  */
-    BAR = 0
+    BAR = 0ULL
 };
diff --git a/flatdata-generator/tests/generators/cpp_expectations/constants/values.h b/flatdata-generator/tests/generators/cpp_expectations/constants/values.h
@@ -141,139 +141,139 @@ enum : uint16_t
 namespace n { 
 enum : int32_t
 {
-    FOO_I32_NEG = -2147483648
+    FOO_I32_NEG = -2147483648L
 };
 } // namespace n
 
 namespace n { 
 enum : int32_t
 {
-    FOO_I32_POS = 2147483647
+    FOO_I32_POS = 2147483647L
 };
 } // namespace n
 
 namespace n { 
 enum : int32_t
 {
-    FOO_I32_ZERO = 0
+    FOO_I32_ZERO = 0L
 };
 } // namespace n
 
 namespace n { 
 enum : int32_t
 {
-    FOO_I32_NEG_HEX = -2147483648
+    FOO_I32_NEG_HEX = -2147483648L
 };
 } // namespace n
 
 namespace n { 
 enum : int32_t
 {
-    FOO_I32_POS_HEX = 2147483647
+    FOO_I32_POS_HEX = 2147483647L
 };
 } // namespace n
 
 namespace n { 
 enum : int32_t
 {
-    FOO_I32_ZERO_HEX = 0
+    FOO_I32_ZERO_HEX = 0L
 };
 } // namespace n
 
 namespace n { 
 enum : uint32_t
 {
-    FOO_U32_POS = 4294967295
+    FOO_U32_POS = 4294967295UL
 };
 } // namespace n
 
 namespace n { 
 enum : uint32_t
 {
-    FOO_U32_ZERO = 0
+    FOO_U32_ZERO = 0UL
 };
 } // namespace n
 
 namespace n { 
 enum : uint32_t
 {
-    FOO_U32_POS_HEX = 4294967295
+    FOO_U32_POS_HEX = 4294967295UL
 };
 } // namespace n
 
 namespace n { 
 enum : uint32_t
 {
-    FOO_U32_ZERO_HEX = 0
+    FOO_U32_ZERO_HEX = 0UL
 };
 } // namespace n
 
 namespace n { 
 enum : int64_t
 {
-    FOO_I64_NEG = -9223372036854775808
+    FOO_I64_NEG = -9223372036854775808LL
 };
 } // namespace n
 
 namespace n { 
 enum : int64_t
 {
-    FOO_I64_POS = 9223372036854775807
+    FOO_I64_POS = 9223372036854775807LL
 };
 } // namespace n
 
 namespace n { 
 enum : int64_t
 {
-    FOO_I64_ZERO = 0
+    FOO_I64_ZERO = 0LL
 };
 } // namespace n
 
 namespace n { 
 enum : int64_t
 {
-    FOO_I64_NEG_HEX = -9223372036854775808
+    FOO_I64_NEG_HEX = -9223372036854775808LL
 };
 } // namespace n
 
 namespace n { 
 enum : int64_t
 {
-    FOO_I64_POS_HEX = 9223372036854775807
+    FOO_I64_POS_HEX = 9223372036854775807LL
 };
 } // namespace n
 
 namespace n { 
 enum : int64_t
 {
-    FOO_I64_ZERO_HEX = 0
+    FOO_I64_ZERO_HEX = 0LL
 };
 } // namespace n
 
 namespace n { 
 enum : uint64_t
 {
-    FOO_U64_POS = 18446744073709551615
+    FOO_U64_POS = 18446744073709551615ULL
 };
 } // namespace n
 
 namespace n { 
 enum : uint64_t
 {
-    FOO_U64_ZERO = 0
+    FOO_U64_ZERO = 0ULL
 };
 } // namespace n
 
 namespace n { 
 enum : uint64_t
 {
-    FOO_U64_POS_HEX = 18446744073709551615
+    FOO_U64_POS_HEX = 18446744073709551615ULL
 };
 } // namespace n
 
 namespace n { 
 enum : uint64_t
 {
-    FOO_U64_ZERO_HEX = 0
+    FOO_U64_ZERO_HEX = 0ULL
 };
 } // namespace n
diff --git a/flatdata-generator/tests/generators/cpp_expectations/enums/comments.h.1 b/flatdata-generator/tests/generators/cpp_expectations/enums/comments.h.1
@@ -2,7 +2,7 @@
 enum class Foo : uint64_t
 {
     // This is a comment about Foo.a
-    A = 0,
+    A = 0ULL,
     // This is a comment about Foo.b
-    B = 1
+    B = 1ULL
 };
diff --git a/flatdata-generator/tests/generators/cpp_expectations/enums/comments.h.2 b/flatdata-generator/tests/generators/cpp_expectations/enums/comments.h.2
@@ -6,9 +6,9 @@ enum class Bar : uint64_t
     /*
          * This is a comment about Bar.a
          */
-    A = 0,
+    A = 0ULL,
     /*
      * This is a comment about Bar.b
      */
-    B = 1
+    B = 1ULL
 };
diff --git a/flatdata-generator/tests/generators/cpp_expectations/enums/structs.h b/flatdata-generator/tests/generators/cpp_expectations/enums/structs.h
@@ -282,8 +282,8 @@ namespace n {
 
 enum class EnumI32 : int32_t
 {
-    VALUE = 0,
-    UNKNOWN_VALUE_MINUS_1 = -1
+    VALUE = 0L,
+    UNKNOWN_VALUE_MINUS_1 = -1L
 };
 
 inline
@@ -350,8 +350,8 @@ namespace n {
 
 enum class EnumU32 : uint32_t
 {
-    VALUE = 0,
-    UNKNOWN_VALUE_1 = 1
+    VALUE = 0UL,
+    UNKNOWN_VALUE_1 = 1UL
 };
 
 inline
@@ -418,8 +418,8 @@ namespace n {
 
 enum class EnumI64 : int64_t
 {
-    VALUE = 0,
-    UNKNOWN_VALUE_MINUS_1 = -1
+    VALUE = 0LL,
+    UNKNOWN_VALUE_MINUS_1 = -1LL
 };
 
 inline
@@ -486,8 +486,8 @@ namespace n {
 
 enum class EnumU64 : uint64_t
 {
-    VALUE = 0,
-    UNKNOWN_VALUE_1 = 1
+    VALUE = 0ULL,
+    UNKNOWN_VALUE_1 = 1ULL
 };
 
 inline

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`#include <shared_mutex>`
`21`	`21`	`#include <utility>`
`22`	`22`	`#include <vector>`
	`23`	`+#include <algorithm>`
`23`	`24`
`24`	`25`	`namespace flatdata`
`25`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`enum : uint32_t`
`2`	`2`	`{`
`3`	`3`	`// This is a comment about foo`
`4`		`- FOO = 0`
	`4`	`+ FOO = 0UL`
`5`	`5`	`};`