Changes between Version 7 and Version 8 of Documentation/T3Q/Quality-Checks/Code-Style

Timestamp:

12/17/18 15:12:08 (6 years ago)

Author:

phdmakk

Comment:

--

Documentation/T3Q/Quality-Checks/Code-Style

@@ -96 +96 @@
 ==== There Must Be No Over-specific Runs On Clauses ====
  * '''Symbolic Name in XML Configuration''': checkNoOverSpecificRunsOnClauses
- * '''Dependant Tags in XML Configuration''': recursionInCheckNoOverSpecificRunsOnClauses
+ * '''Dependant Tags in XML Configuration''': recursionInCheckNoOverSpecificRunsOnClauses, extendsInCheckNoOverSpecificRunsOnClauses (since v2.0.0b26)
 
 This check will make sure no over-specific '''runs on''' clauses are used. An over-specific runs on clause is when none of the component element definitions (variables, timers, constants, and ports) of the component used in the runs on clause are referenced within the body of the function or alststep with the runs on clause. If at least one of the component element definitions is referenced within the body of the function or altstep, then no problem is reported. If the '''recursionInCheckNoOverSpecificRunsOnClauses''' setting is enabled (which it is by default), also the functions and altsteps referenced within the body of the current construct will be inspected. This is due to the fact that often wrapper functions are used that do not make direct use of the component element definitions themselves.
@@ -105 +105 @@
 
 [[Include(source:trunk/t3q-examples/checkNoOverSpecificRunsOn/checkNoOverSpecificRunsOn.ttcn3, text/x-rst)]]
+
+As of v2.0.0b26 an additional setting '''extendsInCheckNoOverSpecificRunsOnClauses''' is provided to enable the consideration of definitions recursively inherited from extended components as well (disabled by default). If this setting is enabled, a function or an altstep specified to run on a given component will only raise a warning if none of the definitions within the component itself ''as well as'' all the components that this component extends (and the components extended by those components recursively) are used within the function or altstep. For example:
+
+{{{
+    //base component
+    type component componentWithDefinition {
+        timer definedTimer;
+    }
+
+
+    //alias     / extension
+    type component directAlias extends componentWithDefinition {
+        
+    }
+
+    //multi alias /extension
+    type component multiAlias extends directAlias {
+        
+    }
+
+    //always good - base component
+    function someFunctionOnBaseComponent ()
+    runs on componentWithDefinition {
+        definedTimer.start ( 10.0 );
+    }
+
+
+    //good - via direct alias (with extendsInCheckNoOverSpecificRunsOnClauses)
+    //bad - no definition from directAlias used (without extendsInCheckNoOverSpecificRunsOnClauses)
+    function someFunctionOnMultiAlias ()
+    runs on directAlias {
+        definedTimer.start ( 10.0 );
+    }
+
+
+    //good - via multi alias (with extendsInCheckNoOverSpecificRunsOnClauses)
+    //bad - no definition from multiAlias used (without extendsInCheckNoOverSpecificRunsOnClauses)
+    function someFunctionOnMultiAlias ()
+    runs on multiAlias {
+        definedTimer.start ( 10.0 );
+    }
+}}}
 
 ==== There Must Be No Unused Imports ====