Preprocessor directives causing syntax error

[JonElsey]

When trying to parse ukca_mode_tracer_maps_mod, I get the following error.

Traceback (most recent call last):
  File "/home/jelsey/NG-ARCH/transformer/psyclone_ve/bin/psyclone", line 42, in <module>
    main(sys.argv[1:])
  File "/home/jelsey/NG-ARCH/cemac_ngarch_tools/psyclone/src/psyclone/generator.py", line 592, in main
    code_transformation_mode(input_file=args.filename,
  File "/home/jelsey/NG-ARCH/cemac_ngarch_tools/psyclone/src/psyclone/generator.py", line 772, in code_transformation_mode
    .psyir_from_file(input_file)
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jelsey/NG-ARCH/cemac_ngarch_tools/psyclone/src/psyclone/psyir/frontend/fortran.py", line 255, in psyir_from_file
    parse_tree = self._parser(reader)
                 ^^^^^^^^^^^^^^^^^^^^
  File "/home/jelsey/NG-ARCH/transformer/psyclone_ve/lib/python3.12/site-packages/fparser/two/Fortran2003.py", line 275, in __new__
    raise FortranSyntaxError(string, "")
fparser.two.utils.FortranSyntaxError: at line 175
>>>END DO\n

The code that it is tripping up on looks like:

! Construct the number and component mass index arrays
! by looping over all entries in the all_tracers array
DO i=1,n_tracers
! (Slow) Workaround for NAG Fortran vn7.0 internal compiler error.
! Fixed in vn7.1
#if defined(NAG_FORTRAN) && (NAG_FORTRAN == 7000000)
tracer_belongs = .FALSE.
DO j=1,nmodes
IF ( mode_names(j) == all_tracers_names(i)(1:7) ) THEN
tracer_belongs = .TRUE.
END IF
END DO   
IF ( tracer_belongs ) THEN
#else
IF ( ANY(mode_names(:) == all_tracers_names(i)(1:7)) ) THEN
#endif

<code> 

END DO    ! this is the line it detects the syntax error on

The code compiles fine, but PSyclone passthrough doesn't work.
I've set up a branch that refactors this bit of code (which now works fine), but I just wanted to flag it as something that PSyclone didn't know how to handle.

[arporter]

Thanks @JonElsey. There are two things here. The first is that it is fparser refusing to parse the code (because it's not Fortran) and the second is that PSyclone only works with Fortran source (https://psyclone.readthedocs.io/en/latest/user_guide/psyclone_command.html#c-pre-processor-include-files). If it contains pre-processor macros then the code must be pre-processed before giving it to PSyclone. @sergisiso is working on a psyclonefc command in #3023 - this will provide a simpler way to solve this problem, c.f. mpif90 wrapping the Fortran compiler.

Could you paste the full error output here - it may be that we should be producing a better message in this case.

[JonElsey]

Thanks for the response @arporter - that helps a lot!

Running

psyclone --version

> PSyclone version: 3.1.1-dev

psyclone -o $GLOMAP_OMP/ukca_mode_tracer_maps_mod.F90 -s omp_cpu_trans.py --log-level DEBUG $GLOMAP/ukca_mode_tracer_maps_mod.F90 > psyclone_dbg.log

This is the contents of psyclone_dbg.log (my transformation script raises/prints the error hence why it appears twice).

DEBUG:psyclone.generator:Logging system initialised.
DEBUG:fparser.two.parser:Parent_Identifier class is missing subclass_names list
DEBUG:fparser.two.parser:Cray_Pointer_Decl class is missing subclass_names list
DEBUG:fparser.two.parser:Extended_Intrinsic_Op class is missing subclass_names list
DEBUG:fparser.two.parser:Include_Stmt class is missing subclass_names list
Traceback (most recent call last):
  File "/home/jelsey/NG-ARCH/transformer/psyclone_ve/lib/python3.12/site-packages/fparser/two/Fortran2003.py", line 271, in __new__
    return Base.__new__(cls, string, _deepcopy=_deepcopy)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jelsey/NG-ARCH/transformer/psyclone_ve/lib/python3.12/site-packages/fparser/two/utils.py", line 511, in __new__
    raise NoMatchError(errmsg)
fparser.two.utils.NoMatchError: at line 175
>>>END DO


During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/jelsey/NG-ARCH/transformer/psyclone_ve/bin/psyclone", line 42, in <module>
    main(sys.argv[1:])
  File "/home/jelsey/NG-ARCH/cemac_ngarch_tools/psyclone/src/psyclone/generator.py", line 592, in main
    code_transformation_mode(input_file=args.filename,
  File "/home/jelsey/NG-ARCH/cemac_ngarch_tools/psyclone/src/psyclone/generator.py", line 772, in code_transformation_mode
    .psyir_from_file(input_file)
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jelsey/NG-ARCH/cemac_ngarch_tools/psyclone/src/psyclone/psyir/frontend/fortran.py", line 255, in psyir_from_file
    parse_tree = self._parser(reader)
                 ^^^^^^^^^^^^^^^^^^^^
  File "/home/jelsey/NG-ARCH/transformer/psyclone_ve/lib/python3.12/site-packages/fparser/two/Fortran2003.py", line 275, in __new__
    raise FortranSyntaxError(string, "")
fparser.two.utils.FortranSyntaxError: at line 175
>>>END DO

[arporter]

Ooh, that's not very nice. I'll take a look.