Update syntax checking, add it to CI pipeline.

Comments to switch syntax checking on and off.
Address false positives among OpDiLib's files.
Fix syntax checking of a single file.

Merge branch 'revisit/syntax' into develop

Author: jblueh

.gitlab-ci.yml

@@ -56,3 +56,11 @@ output:
     - export OUTPUT_INSTRUMENT=yes
     - export STDERR_OUTPUT_IS_ERROR=no
     - make all
+
+syntax:
+  image: ubuntu:24.04
+  script:
+    - apt update
+    - DEBIAN_FRONTEND=noninteractive apt install -y tzdata
+    - apt install -y python3
+    - python3 syntax/check.py -r syntax/opdi.syntax.json tests macroexample.cpp omptexample.cpp

syntax/check.py

@@ -123,6 +123,7 @@ def check_file(code_file, syntax_file, verbose):
     stack = []
 
     state = State.CODE
+    enabled = True
 
     # parse line by line
     while True:
@@ -132,6 +133,20 @@ def check_file(code_file, syntax_file, verbose):
             break
         line = line.strip()
 
+        # identify comments that enable/disable syntax checking
+        if line.startswith("//"):
+          if line[2:].strip() == "opdi-syntax-on":
+            print_status("enable syntax checking", line_no, line, verbose)
+            enabled = True
+            continue
+          if line[2:].strip() == "opdi-syntax-off":
+            print_status("disable syntax checking", line_no, line, verbose)
+            enabled = False
+            continue
+
+        if not enabled:
+          continue
+
         # eliminate /* */ comments within this line
         begin = line.find("/*")
         while begin != -1 and line.find("*/", begin) != -1:
@@ -237,7 +252,7 @@ def main():
 
     for path in args.path:
         if os.path.isfile(path):
-            result = check_and_report_result(args.file, args.syntax, args.stop_on_error, args.quiet, args.verbose)
+            result = check_and_report_result(path, args.syntax, args.stop_on_error, args.quiet, args.verbose)
             all_fine = all_fine and result
         elif os.path.isdir(path):
             if args.recursive:

tests/tests/TestExternalFunctionGlobal.hpp

@@ -98,10 +98,10 @@ struct TestExternalFunctionGlobal : public TestBase<4, 1, 3, TestExternalFunctio
             eh->addOutput(intermediate[i]);
           }
         }
-        #if _OPENMP >= 202011
-          OPDI_END_MASKED
-        #else
+        #if _OPENMP < 202011
           OPDI_END_MASTER
+        #else
+          OPDI_END_MASKED
         #endif
 
         OPDI_BARRIER()
@@ -129,10 +129,10 @@ struct TestExternalFunctionGlobal : public TestBase<4, 1, 3, TestExternalFunctio
         {
           delete eh;
         }
-        #if _OPENMP >= 202011
-          OPDI_END_MASKED
-        #else
+        #if _OPENMP < 202011
           OPDI_END_MASTER
+        #else
+          OPDI_END_MASKED
         #endif
       }
       OPDI_END_PARALLEL

tests/tests/TestExternalFunctionLogicCalls.hpp

@@ -131,10 +131,10 @@ struct TestExternalFunctionLogicCalls : public TestBase<4, 1, 3, TestExternalFun
             eh->addOutput(intermediate[i]);
           }
         }
-        #if _OPENMP >= 202011
-          OPDI_END_MASKED
-        #else
+        #if _OPENMP < 202011
           OPDI_END_MASTER
+        #else
+          OPDI_END_MASKED
         #endif
 
         OPDI_BARRIER()
@@ -162,10 +162,10 @@ struct TestExternalFunctionLogicCalls : public TestBase<4, 1, 3, TestExternalFun
         {
           delete eh;
         }
-        #if _OPENMP >= 202011
-          OPDI_END_MASKED
-        #else
+        #if _OPENMP < 202011
           OPDI_END_MASTER
+        #else
+          OPDI_END_MASKED
         #endif
       }
       OPDI_END_PARALLEL

tests/tests/TestMasked.hpp

@@ -61,10 +61,10 @@ struct TestMasked : public TestBase<4, 1, 3, TestMasked<_Case>> {
             out[0] += jobResults[i];
           }
         }
-        #if _OPENMP >= 202011
-          OPDI_END_MASKED
-        #else
+        #if _OPENMP < 202011
           OPDI_END_MASTER
+        #else
+          OPDI_END_MASKED
         #endif
       }
       OPDI_END_PARALLEL

tests/tests/TestParallelCopyin.hpp

@@ -69,7 +69,9 @@ struct TestParallelCopyin : public TestBase<4, 1, 3, TestParallelCopyin<_Case>>
       #if !defined(__GNUC__) || defined(__clang__)
         OPDI_PARALLEL(copyin(helper))
       #else
+        // opdi-syntax-off
         OPDI_PARALLEL(firstprivate(helper))
+        // opdi-syntax-on
       #endif
       {
         int nThreads = omp_get_num_threads();

tests/tests/TestSingleCopyprivateNowait.hpp

@@ -56,7 +56,9 @@ struct TestSingleCopyprivateNowait : public TestBase<4, 1, 3, TestSingleCopypriv
         #if _OPENMP >= 202411
           OPDI_SINGLE_COPYPRIVATE_NOWAIT(copyprivate(helper))
         #else
+          // opdi-syntax-off
           OPDI_SINGLE_COPYPRIVATE(copyprivate(helper))
+          // opdi-syntax-on
         #endif
         {
           for (int i = 0; i < N / 2; ++i) {