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

Timestamp:

11/13/25 21:59:35 (2 months ago)

Author:

phdmakk

Comment:

--

Documentation/T3Q/Quality-Checks/Code-Style

@@ -423 +423 @@
 }}}
 
-==== There Must Be No Uninitialized Fields in Templates ====
- * '''Symbolic Name in XML Configuration''': checkNoUninitializedFieldsInTemplates
- * '''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).
+
+==== **There Must Be No Uninitialized Fields in Templates**====
+
+* **Symbolic Name in XML Configuration**: checkNoUninitializedFieldsInTemplates
+* **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 and ASN.1 (see ASN.1 Support for details).
 
 {{{
@@ -493 +495 @@
 }}}
 
-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.
+By default only the first level of modified templates is checked in case a template modifies another template or is assigned to another template, and the field specifications in the base template are considered. With the option **checkNoUnititializedFieldsInTemplatesRecursion** multiple levels of modified or assigned templates are considered.
 
 {{{
@@ -514 +516 @@
     //-> no warning if checkNoUnititializedFieldsInTemplatesRecursion is true
     //-> warning if checkNoUnititializedFieldsInTemplatesRecursion is false (only f2 from B2 considered)
+
+  template tr t_tr_mod_base_full_assigned (charstring p_c) := t_tr_mod_base_full("a", {}) //no warning
+
+  template tr t_tr_mod_base_full (charstring p_c) modifies t_tr_base_full := {
+      common := (p_c) //no warning
+  } 
+  
+  template tr t_tr_base_full (integer p_ind) := { 
+      common := "yes", //no warning
+      indication := p_ind,
+      version := 1
+  }
+  
+  template tr t_tr_ref_ref_mod_c(charstring p_c) modifies t_tr_ref_ref := {
+      common := (p_c) //no warning
+  }  
+
+  template tr t_tr_ref_mod_c(charstring p_c) modifies t_tr_ref := {
+      common := (p_c) //no warning
+  }  
+
+  template tr t_tr_ref_ref_mod(charstring p_c) modifies t_tr_ref_ref := {
+      version := (p_c) //warning
+  }  
+
+  template tr t_tr_ref_mod(charstring p_c) modifies t_tr_ref := {
+      version := (p_c) //warning
+  }  
+ 
+  template tr t_tr_ref_ref (integer p_i) := t_tr_ref(p_i) //warning 
+
+  template tr t_tr_ref(integer p_i) := t_tr_base(p_i) //warning
+  template tr t_tr_ref_no_par(integer p_i) := t_tr_base //warning
+   
+  template tr t_tr_base(integer p_ind) := { 
+//      common := "yes", //common not specified
+
+
+      indication := p_ind,
+      version := 1
+  }
+    
+  type record tr {
+      charstring common,
+      integer indication,
+      integer version
+  }
+
+    template rx_sub rx_sub_par(template rx_sub p_rx) := p_rx //skipped
+    
+    template rx_sub t_rx := {
+        version := 1, 
+        extensions := "x1",
+        size := 3 
+    }
+    
+    type rx rx_sub
+    type record rx {
+        integer version,
+        charstring extensions,
+        integer size
+    }
 } 
 }}}
 
+==== **There Must Be No Zero or Multiple Fields in Union Templates**====
+
+* **Symbolic Name in XML Configuration**: checkNoZeroOrMultipleFieldsInUnionTemplates
+* **Dependant Tags in XML Configuration**: checkNoUninitializedFieldsInTemplatesRecursion
+
+This check makes sure there are no zero or multiple initialized fields in union templates. This currently covers declared templates (on the module level only) for union types declared in TTCN-3 and in ASN.1 (see ASN.1 Support for details).
+
+{{{
+module unions {
+  template tu tu_func_mod modifies tu_func := {
+      //skipped
+  }
+  
+  template tu tu_func_ref := tu_func()
+     //skipped
+  
+  template tu tu_func_ref_np := tu_func
+
+  template tu tu_func := f_tu()
+  //no warning (no way to determine) -> skipped
+
+  template tu tu_func := tu_base()  
+ 
+  template tu tu_base_mod_empty modifies tu_base := {
+      //no warning   
+  }
+
+  template tu tu_base_mod_c modifies tu_base := {
+      common := "b" //no warning, same 
+  } 
+
+  template tu tu_base_mod modifies tu_base := { 
+      version := 0 //warning more than one / different
+  } 
+
+  template tu tu_base := {
+      common := "a"
+  }
+  
+  function f_tu() return tu {
+      return tu_base
+  }
+  
+  type union tu {
+      charstring common,
+      integer indication,
+      integer version
+  }
+}
+}}}
+
+By default only the first level of modified templates is checked in case a template modifies another template or is assigned to another template, and the field specifications in the base template are considered. With the option **checkNoUnititializedFieldsInTemplatesRecursion** multiple levels of modified or assigned templates are considered. While the TTCN-3 semantics state that in the case of modified templates the newly assigned field replaces the field specified in the base template, the warning from this check can still be beneficial in highlighting cases where that may be unintentional.