Changes between Version 19 and Version 20 of Documentation/T3Q/Quality-Checks/Code-Style

Timestamp:

10/14/25 16:39:17 (5 months ago)

Author:

phdmakk

Comment:

--

Documentation/T3Q/Quality-Checks/Code-Style

@@ -425 +425 @@
 ==== There Must Be No Uninitialized Fields in Templates ====
  * '''Symbolic Name in XML Configuration''': checkNoUninitializedFieldsInTemplates
- * '''Dependant Tags in XML Configuration''': -
+ * '''Dependant Tags in XML Configuration''': checkNoUninitializedFieldsInTemplatesRecursion
 
 This check makes sure there are no uninitialized fields in templates. This currently covers declared templates (on the module level only) for structured types declared in TTCN-3 (support for structured types declared in ASN.1 is currently being investigated).
@@ -492 +492 @@
         }
 }}}
+
+By default only the first level of modified templates is checked in case a template modifies another template, and the field specifications in the base template are considered. With the option '''checkNoUnititializedFieldsInTemplatesRecursion''' multiple levels of modified templates are considered.
+
+{{{
+module checkNoUnititializedFieldsInTemplatesRecursion {
+    type record R {
+        integer f1, 
+        integer f2,
+        integer f3
+    }
+
+    template R A := {f1 := 1} //base template, not fully-specified -> warning
+
+    template R B1 modifies A := {f2 := 2, f3:= 3} //fully-specified, inherits f1 -> no warning
+
+    template R B2 modifies A := {f2 := 2} //not fully-specified, inherits f1, misses f3 -> warning
+
+    template R C1 modifies B1 := {f1 := 3} //fully-specified, inherits f2, f3 -> no warning
+
+    template R C2 modifies B2 := {f3 := 3} //fully-specified, inherits f1 from A, f2 from B2 
+    //-> no warning if checkNoUnititializedFieldsInTemplatesRecursion is true
+    //-> warning if checkNoUnititializedFieldsInTemplatesRecursion is false (only f2 from B2 considered)
+} 
+}}}
+