RIC-1060: Reduce warnings for samples + doc update for 2.0.1 (#84)

mattias-mohlin · GitHub Enterprise · commit d7959be949bb · 2024-11-07T13:31:44.000+01:00
diff --git a/art-samples/DependencyInjection/top.tcjs b/art-samples/DependencyInjection/top.tcjs
@@ -4,4 +4,5 @@ tc.targetFolder = 'DependencyInjection_target';
 tc.commonPreface = `
 #include <iostream>
 `;
-tc.capsuleFactory = '&CapsuleFactory::factory';
+tc.capsuleFactory = '&CapsuleFactory::factory';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/DiningPhilosophers/DiningPhils_v1/Top.tcjs b/art-samples/DiningPhilosophers/DiningPhils_v1/Top.tcjs
@@ -2,3 +2,4 @@
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'Top';
 tc.targetFolder = 'DiningPhils_v1_target';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/DiningPhilosophers/DiningPhils_v2/Top.tcjs b/art-samples/DiningPhilosophers/DiningPhils_v2/Top.tcjs
@@ -1,4 +1,5 @@
 //Transformation Configuration File
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'Top';
-tc.targetFolder = 'DiningPhils_v2_target';
+tc.targetFolder = 'DiningPhils_v2_target';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/DistributedPingPong/top.tcjs b/art-samples/DistributedPingPong/top.tcjs
@@ -2,3 +2,4 @@ let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'TOP';
 tc.targetFolder = 'DistributedPingPong_target'; 
 tc.prerequisites = ['../TcpServer/tcpServerLib.tcjs'];
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/HelloWorld/HelloWorld.tcjs b/art-samples/HelloWorld/HelloWorld.tcjs
@@ -1,3 +1,4 @@
 //Transformation Configuration File
 let tc = TCF.define(TCF.ART_TO_CPP);
-tc.topCapsule = 'HelloWorld';
+tc.topCapsule = 'HelloWorld';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/MoreOrLess/app.tcjs b/art-samples/MoreOrLess/app.tcjs
@@ -2,3 +2,4 @@
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.targetFolder = 'MoreOrLess_target'; 
 tc.topCapsule = "Top";
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/PiComputer/defaultTC.tcjs b/art-samples/PiComputer/defaultTC.tcjs
@@ -1,4 +1,5 @@
 //Transformation Configuration File
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'PiComputer'; 
-tc.targetFolder = 'Pi_target'; 
+tc.targetFolder = 'Pi_target';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/PingPong/PingPong.tcjs b/art-samples/PingPong/PingPong.tcjs
@@ -1,2 +1,3 @@
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'Top';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/PingPongTimeDeltaTracker/PingPong.tcjs b/art-samples/PingPongTimeDeltaTracker/PingPong.tcjs
@@ -1,2 +1,3 @@
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'Top';
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/QtTrafficLight/app.tcjs b/art-samples/QtTrafficLight/app.tcjs
@@ -1,4 +1,5 @@
 //Transformation Configuration File
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.topCapsule = 'TLSystem'; 
-tc.targetFolder = 'QtTrafficLight_target'; 
+tc.targetFolder = 'QtTrafficLight_target'; 
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/TcpRangeCounter/app.tcjs b/art-samples/TcpRangeCounter/app.tcjs
@@ -2,6 +2,7 @@
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.targetFolder = 'TcpRangeCounter_target'; 
 tc.prerequisites = ['../TcpServer/tcpServerLib.tcjs'];
+tc.cppCodeStandard = "C++ 17";
 
 // Uncomment to debug
 /*
diff --git a/art-samples/TcpServer/tcpServerLib.tcjs b/art-samples/TcpServer/tcpServerLib.tcjs
@@ -12,6 +12,6 @@ tc.targetConfiguration = TCF.getTopTC().eval.targetConfiguration;
 
 tc.targetProject = 'LibTCPServer_target';
 tc.targetRTSLocation = TCF.getTopTC().eval.targetServicesLibrary;
-//tc.targetRTSLocation = 'C:/git/rsarte-target-rts/rsa_rt/C++/TargetRTS';
+tc.cppCodeStandard = TCF.getTopTC().eval.cppCodeStandard;
 
 tc.unitName = 'UnitName_TCPLib';
diff --git a/art-samples/TokenRing/app.tcjs b/art-samples/TokenRing/app.tcjs
@@ -20,4 +20,6 @@ tc.threads = [
             'ServerThread'
         ]
     }
-];
+];
+
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/TrafficLight/app.tcjs b/art-samples/TrafficLight/app.tcjs
@@ -2,3 +2,4 @@
 let tc = TCF.define(TCF.ART_TO_CPP);
 tc.targetFolder = "TrafficLight_target";
 tc.topCapsule = "TrafficLight";
+tc.cppCodeStandard = "C++ 17";
diff --git a/art-samples/TrafficLightWeb/app.tcjs b/art-samples/TrafficLightWeb/app.tcjs
@@ -3,6 +3,7 @@ let tc = TCF.define(TCF.ART_TO_CPP);
 tc.targetFolder = 'TrafficLightWeb_target'; 
 tc.prerequisites = ['../TcpServer/tcpServerLib.tcjs'];
 
+tc.cppCodeStandard = "C++ 17";
 // Uncomment to debug
 /*
 tc.compileArguments = '$(DEBUG_TAG)';
diff --git a/art-samples/gRPC_MazeRunner/Maze.art b/art-samples/gRPC_MazeRunner/Maze.art
@@ -27,7 +27,7 @@ capsule Maze {
             `;
             adjustStepCount: on server.adjustStepCount
             `
-                const int adjustment = *(static_cast<const int*>(rtdata));
+                const int adjustment = *rtdata;
                 stepCount += adjustment;
             `;
 
diff --git a/docs-sources/art-lang/index.md b/docs-sources/art-lang/index.md
@@ -672,7 +672,7 @@ If the instantiated capsule has a constructor you need to use a capsule factory
 
 3) **Plugin part**
 
-A plugin part is similar to an optional part in that it is populated by capsule instances programmatically. However, the capsule instances are not created in the plugin part but instead imported into the plugin part from another part. Typically such a capsule instance is first created into an optional part, and then at some later point in time imported into a plugin part. Later it can be deported (i.e. removed) from the plugin part and perhaps imported into another plugin part. This makes it possible to create very dynamic composite structures where the same capsule instance can play different roles in different parts over time. Moving a capsule instance by deporting it from one plugin part and then importing it in another plugin part is usually more efficient than destroying the capsule instance in one optional part and then creating another capsule instance in another optional part. 
+A plugin part is similar to an optional part in that it is populated by capsule instances programmatically. However, the capsule instances are not created in the plugin part but instead imported into the plugin part from another part. Typically such a capsule instance is first created into an optional part, and then at some later point in time imported into a plugin part. Later it can be deported (i.e. removed) from the plugin part and perhaps imported into another plugin part. This makes it possible to create very dynamic composite structures where the same capsule instance can play different roles in different parts over time. Moving a capsule instance by deporting it from one plugin part and then importing it in another plugin part is usually more efficient than destroying the capsule instance in one optional part and then creating another capsule instance in another optional part (and data stored in the moved capsule instance is of course retained). Note that the parts which you move a capsule instance between can belong to different composite structures.
 
 Plugin parts can be useful in applications when a capsule needs to use a shared resource for some time, and then return it so it can be used by other capsules. The shared resource is the capsule that is imported into a plugin part of the capsule that needs to use it, and when it's no longer needed it gets deported from the plugin part so that another capsule can use it.
 
diff --git a/docs-sources/images/disable-check.png b/docs-sources/images/disable-check.png
diff --git a/docs-sources/validation.md b/docs-sources/validation.md
@@ -51,6 +51,13 @@ Some problems have one or several typical solutions that are possible to apply a
 
 Note that most problems cannot be automatically resolved like this, but in some cases it's possible. 
 
+You can choose to "fix" most kinds of reported problems by disabling the validation rule that reported it. A "Disable" code action for doing this is listed after other code actions, and is available for many kinds of problems. The validation rule will be disabled only for the specific element on which the problem was reported. See [Configuring Validation](#configuring-validation) for how you can disable certain validation rules globally.
+
+![](images/disable-check.png)
+
+!!! note 
+    In some (unusual) cases a validation rule may report a problem on multiple elements, for example [ART_0002](#art_0002_duplicatenamesinscope) can detect that names of two or more global elements are conflicting. If you perform the Quick Fix for disabling that validation rule, a `rule_config` property will be set on one of the elements, but since the problem relates to multiple elements this will not make the problem go away. You can only turn off such validation rules by disabling them globally.
+
 ## Configuring Validation
 Validation can be configured to change which rules that should run, and what severity they should report found problems with. By default every [validation rule](#validation-rules) is enabled and uses a predefined severity level. Validation rules can be configured either globally by means of a setting, or locally by means of a property [rule_config](../art-lang#rule_config). In both cases the rule configuration consists of a comma-separated list of 5 letter strings where the first letter specifies if the rule is disabled or it's severity (X,I,W,E) and remaining letters specify the rule id. For example, the rule configuration `X0003,I0004,W0009,E0005` means the following:
 

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`let tc = TCF.define(TCF.ART_TO_CPP);`
`2`	`2`	`tc.topCapsule = 'Top';`
	`3`	`+tc.cppCodeStandard = "C++ 17";`