Support selected Intel-specific preprocessor macro expansions

fortls/langserver.py

@@ -751,11 +751,17 @@ def get_definition(
             return None
         # Search in Preprocessor defined variables
         if def_name in def_file.pp_defs:
+            def_value = def_file.pp_defs.get(def_name)
+            def_arg_str = ""
+            if isinstance(def_value, tuple):
+                def_arg_str, def_value = def_value
+                def_arg_str = f"({def_arg_str})"
+
             var = Variable(
                 def_file.ast,
                 def_line + 1,
                 def_name,
-                f"#define {def_name} {def_file.pp_defs.get(def_name)}",
+                f"#define {def_name}{def_arg_str} {def_value}",
                 [],
             )
             return var

fortls/parsers/internal/parser.py

@@ -9,9 +9,9 @@
 
 # Python < 3.8 does not have typing.Literals
 try:
-    from typing import Literal
+    from typing import Literal, Tuple
 except ImportError:
-    from typing_extensions import Literal
+    from typing_extensions import Literal, Tuple
 
 from re import Match, Pattern
 
@@ -2098,10 +2098,11 @@ def replace_vars(line: str):
         if def_cont_name is not None:
             output_file.append("")
             if line.rstrip()[-1] != "\\":
-                defs_tmp[def_cont_name] += line.strip()
+                append_multiline_macro(defs_tmp, def_cont_name, line.strip())
                 def_cont_name = None
             else:
-                defs_tmp[def_cont_name] += line[0:-1].strip()
+                append_multiline_macro(defs_tmp, def_cont_name, line[0:-1].strip())
+
             continue
         # Handle conditional statements
         match = FRegex.PP_REGEX.match(line)
@@ -2206,15 +2207,24 @@ def replace_vars(line: str):
             #     def_name += match.group(3)
             if (match.group(1) == "define") and (def_name not in defs_tmp):
                 eq_ind = line[match.end(0) :].find(" ")
+                if eq_ind < 0:
+                    eq_ind = line[match.end(0) :].find("\t")
+
                 if eq_ind >= 0:
                     # Handle multiline macros
                     if line.rstrip()[-1] == "\\":
-                        defs_tmp[def_name] = line[match.end(0) + eq_ind : -1].strip()
+                        def_value = line[match.end(0) + eq_ind : -1].strip()
                         def_cont_name = def_name
                     else:
-                        defs_tmp[def_name] = line[match.end(0) + eq_ind :].strip()
+                        def_value = line[match.end(0) + eq_ind :].strip()
                 else:
-                    defs_tmp[def_name] = "True"
+                    def_value = "True"
+
+                # are there arguments to parse?
+                if match.group(3):
+                    def_value = (match.group(4), def_value)
+
+                defs_tmp[def_name] = def_value
             elif (match.group(1) == "undef") and (def_name in defs_tmp):
                 defs_tmp.pop(def_name, None)
             log.debug(f"{line.strip()} !!! Define statement({i + 1})")
@@ -2265,8 +2275,16 @@ def replace_vars(line: str):
                 continue
             def_regex = def_regexes.get(def_tmp)
             if def_regex is None:
-                def_regex = re.compile(rf"\b{def_tmp}\b")
+                if isinstance(value, tuple):
+                    def_regex = expand_def_func_macro(def_tmp, value)
+                else:
+                    def_regex = re.compile(rf"\b{def_tmp}\b")
+
                 def_regexes[def_tmp] = def_regex
+
+            if isinstance(def_regex, tuple):
+                def_regex, value = def_regex
+
             line_new, nsubs = def_regex.subn(value, line)
             if nsubs > 0:
                 log.debug(
@@ -2275,3 +2293,29 @@ def replace_vars(line: str):
                 line = line_new
         output_file.append(line)
     return output_file, pp_skips, pp_defines, defs_tmp
+
+
+def expand_def_func_macro(def_name: str, def_value: tuple[str, str]):
+    def_args, sub = def_value
+    def_args = def_args.split(",")
+    regex = re.compile(rf"\b{def_name}\s*\({','.join(['(.*)']*len(def_args))}\)")
+
+    for i, arg in enumerate(def_args):
+        arg = arg.strip()
+        sub = re.sub(rf"\b({arg})\b", rf"\\{i + 1}", sub)
+
+    return regex, sub
+
+
+def append_multiline_macro(pp_defs: dict, def_name: str, line: str):
+    def_value = pp_defs[def_name]
+    def_args = None
+    if isinstance(def_value, tuple):
+        def_args, def_value = def_value
+
+    def_value += line
+
+    if def_args is not None:
+        def_value = (def_args, def_value)
+
+    pp_defs[def_name] = def_value

fortls/regex_patterns.py

@@ -124,11 +124,14 @@ class FortranRegularExpressions:
     FREE_FORMAT_TEST: Pattern = compile(r"[ ]{1,4}[a-z]", I)
     # Preprocessor matching rules
     DEFINED: Pattern = compile(r"defined[ ]*\(?[ ]*([a-z_]\w*)[ ]*\)?", I)
-    PP_REGEX: Pattern = compile(r"#(if |ifdef|ifndef|else|elif|endif)")
-    PP_DEF: Pattern = compile(r"#(define|undef)[ ]*([\w]+)(\((\w+(,[ ]*)?)+\))?", I)
+    PP_REGEX: Pattern = compile(r"\s*#\s*(if |ifdef|ifndef|else|elif|endif)")
+    PP_DEF: Pattern = compile(
+        r"\s*#\s*(define|undef)\s*(\w+)(\(\s*(\w+\s*,?[\s\w,]*)*\s*\))?",
+        I,
+    )
     PP_DEF_TEST: Pattern = compile(r"(![ ]*)?defined[ ]*\([ ]*(\w*)[ ]*\)$", I)
-    PP_INCLUDE: Pattern = compile(r"#include[ ]*([\"\w\.]*)", I)
-    PP_ANY: Pattern = compile(r"(^#:?\w+)")
+    PP_INCLUDE: Pattern = compile(r"\s*#\s*include\s*([\"\w\.]*)", I)
+    PP_ANY: Pattern = compile(r"(^\s*#\s*\w*:?\w+)")
     # Context matching rules
     CALL: Pattern = compile(r"[ ]*CALL[ ]+[\w%]*$", I)
     INT_STMNT: Pattern = compile(r"^[ ]*[a-z]*$", I)

test/test_interface.py

@@ -179,7 +179,8 @@ def test_version_update_pypi():
     s = LangServer(conn=JSONRPC2Connection(ReadWriter(stdin, stdout)), settings=args)
     s.root_path = (Path(__file__).parent / "test_source").resolve()
     did_update = s._update_version_pypi(test=True)
-    assert did_update
+    isconda = os.path.exists(os.path.join(sys.prefix, "conda-meta"))
+    assert not did_update if isconda else did_update
 
     s.disable_autoupdate = True
     did_update = s._update_version_pypi()

test/test_preproc.py

@@ -42,6 +42,10 @@ def check_return(result_array, checks):
     string += hover_req(file_path, 30, 23)
     file_path = root_dir / "preproc_if_elif_skip.F90"
     string += hover_req(file_path, 30, 23)
+    file_path = root_dir / "preproc_spacing_arg_defs.F90"
+    string += hover_req(file_path, 11, 20)
+    string += hover_req(file_path, 18, 17)
+    string += hover_req(file_path, 20, 13)
     config = str(root_dir / ".pp_conf.json")
     errcode, results = run_request(string, ["--config", config])
     assert errcode == 0
@@ -52,12 +56,12 @@ def check_return(result_array, checks):
         "```fortran90\n#define PETSC_ERR_INT_OVERFLOW 84\n```",
         "```fortran90\n#define varVar 55\n```",
         (
-            "```fortran90\n#define ewrite if (priority <= 3) write((priority),"
-            " format)\n```"
+            "```fortran90\n#define ewrite(priority, format)"
+            " if (priority <= 3) write((priority), format)\n```"
         ),
         (
-            "```fortran90\n#define ewrite2 if (priority <= 3) write((priority),"
-            " format)\n```"
+            "```fortran90\n#define ewrite2(priority, format)"
+            " if (priority <= 3) write((priority), format)\n```"
         ),
         "```fortran90\n#define SUCCESS .true.\n```",
         "```fortran90\nREAL, CONTIGUOUS, POINTER, DIMENSION(:) :: var1\n```",
@@ -68,6 +72,22 @@ def check_return(result_array, checks):
         "```fortran90\nINTEGER, PARAMETER :: res = 0+1+0+0\n```",
         "```fortran90\nINTEGER, PARAMETER :: res = 0+0+0+1\n```",
         "```fortran90\nINTEGER, PARAMETER :: res = 1+0+0+0\n```",
+        "```fortran90\n#define MAYBEWRAP(PROCEDURE) PROCEDURE\n```",
+        "```fortran90\nSUBROUTINE test_type_set_test()\n```",
+        "```fortran90\n#define MACROARGS(x , y ) x + y\n```",
     )
     assert len(ref_results) == len(results) - 1
     check_return(results[1:], ref_results)
+
+
+def test_FortranFile_pp():
+    from fortls import FortranFile
+
+    root_dir = test_dir / "pp"
+    # file_path = root_dir / "preproc.F90"
+    file_path = root_dir / "preproc_spacing_arg_defs.F90"
+    ff = FortranFile(file_path)
+    ff.load_from_disk()
+    include_dirs = {root_dir / "include"}
+    file_ast = ff.parse(include_dirs=include_dirs, debug=True)
+    assert file_ast

test/test_server.py

@@ -175,6 +175,7 @@ def test_workspace_symbols():
     def check_return(result_array):
         # Expected objects
         objs = (
+            ["argtest", 13, 16],
             ["test", 6, 7],
             ["test_abstract", 2, 0],
             ["test_associate_block", 2, 0],
@@ -196,7 +197,11 @@ def check_return(result_array):
             ["test_str1", 13, 5],
             ["test_str2", 13, 5],
             ["test_sub", 6, 8],
+            ["test_type", 5, 5],
+            ["test_type_set_test", 6, 23],
             ["test_vis_mod", 2, 0],
+            ["the_test", 13, 15],
+            ["wrap_test_type_set_test", 6, 31],
         )
         assert len(result_array) == len(objs)
         for i, obj in enumerate(objs):

test/test_source/pp/include/indent.h

@@ -0,0 +1,22 @@
+!! sample code adapted from json-fortran/json_macros.inc
+
+          # define SPACING_TEST
+  #    define FILE_ENCODING ,encoding='UTF-8'
+
+#   ifdef __GFORTRAN__
+! gfortran uses cpp in old-school compatibility mode so
+! the # stringify and ## concatenate operators don't work
+! but we can use C/C++ style comment to ensure PROCEDURE is
+! correctly tokenized and prepended with 'wrap_' when the
+! macro is expanded
+#     define MAYBEWRAP(PROCEDURE) PROCEDURE , wrap_/**/PROCEDURE
+#   else
+! Intel's fpp does support the more contemporary ## concatenation
+! operator, but doesn't treat the C/C++ comments the same way.
+! If you use the gfortran approach and pass the -noB switch to
+! fpp, the macro will expand, but with a space between wrap_ and
+! whatever PROCEDURE expands to
+#   define MAYBEWRAP(PROCEDURE) PROCEDURE
+# endif
+
+#     define MACROARGS( x , y ) x + y

test/test_source/pp/preproc_spacing_arg_defs.F90

@@ -0,0 +1,40 @@
+program preprocessor_spacing_arg_defs
+  implicit none
+
+  #include "indent.h"
+
+  type :: test_type
+    private
+      integer, public :: test_int
+
+    contains
+      generic, public :: set_test => MAYBEWRAP(test_type_set_test)
+      procedure :: MAYBEWRAP(test_type_set_test)
+
+  end type test_type
+
+  type(test_type) :: the_test
+  integer :: argtest
+
+  call the_test%set_test()
+
+  argtest = MACROARGS(the_test%test_int, 4)
+
+contains
+  subroutine test_type_set_test(me)
+    implicit none
+
+    class(test_type), intent(inout) :: me
+
+    me%test_int = 3
+  end subroutine test_type_set_test
+
+  subroutine wrap_test_type_set_test(me)
+    implicit none
+
+    class(test_type), intent(inout) :: me
+
+    me%test_int = 5
+  end subroutine wrap_test_type_set_test
+
+end program preprocessor_spacing_arg_defs