Fixes the hover of preprocessor functions

This is still not complete and ideally we should parser everything
as a fortran object.

Author: gnikit

CHANGELOG.md

@@ -15,6 +15,12 @@
 - Update constant parameters for `omp_lib` and `omp_lib_kinds` Interface v5.0
 - Format json files with `prettier`
 
+### Fixes
+
+- Fixes the hover of preprocessor functions. It now displays the function name
+  witout the argument list and the function body. The argument list cannot be
+  multiline but the function body can.
+
 ## 1.16.0
 
 ### Adds

fortls/parse_fortran.py

@@ -1203,6 +1203,14 @@ def replace_vars(line: str):
             output_file.append(line)
             pp_defines.append(i + 1)
             def_name = match.group(2)
+            # If this is an argument list of a function add them to the name
+            # get_definition will only return the function name upon hover
+            # hence if the argument list is appended in the def_name then
+            # querying the dictionary will not yield a result.
+            # Need to properly parse the preprocessor files instead of this.
+            # This also does not allow for multiline argument list definitions.
+            # if match.group(3):
+            #     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:

fortls/regex_patterns.py

@@ -105,7 +105,7 @@
 # Preprocessor mathching rules
 DEFINED_REGEX = re.compile(r"defined[ ]*\([ ]*([a-z_][a-z0-9_]*)[ ]*\)", re.I)
 PP_REGEX = re.compile(r"#(if |ifdef|ifndef|else|elif|endif)")
-PP_DEF_REGEX = re.compile(r"#(define|undef)[ ]*([a-z0-9_]+)", re.I)
+PP_DEF_REGEX = re.compile(r"#(define|undef)[ ]*([\w]+)(\((\w+(,[ ]*)?)+\))?", re.I)
 PP_DEF_TEST_REGEX = re.compile(r"(![ ]*)?defined[ ]*\([ ]*([a-z0-9_]*)[ ]*\)$", re.I)
 PP_INCLUDE_REGEX = re.compile(r"#include[ ]*([\"a-z0-9_\.]*)", re.I)
 # Context matching rules

test/test_preproc.py

@@ -29,12 +29,21 @@ def check_return(result_array, checks):
     root_dir = os.path.join(test_dir, "pp")
     string = write_rpc_request(1, "initialize", {"rootPath": root_dir})
     file_path = os.path.join(test_dir, "pp", "preproc.F90")
-    string += hover_req(file_path, 5, 8)
-    string += hover_req(file_path, 7, 30)
+    string += hover_req(file_path, 5, 8)  # user defined type
+    string += hover_req(file_path, 7, 30)  # variable
+    string += hover_req(file_path, 7, 40)  # multi-lin variable
+    string += hover_req(file_path, 8, 7)  # function with if conditional
+    string += hover_req(file_path, 9, 7)  # multiline function with if conditional
     errcode, results = run_request(string, f" --config={root_dir}/.pp_conf.json")
     assert errcode == 0
 
     # Reference solution
-    ref_results = ("#define PCType character*(80)", "#define PETSC_ERR_INT_OVERFLOW 84")
+    ref_results = (
+        "#define PCType character*(80)",
+        "#define PETSC_ERR_INT_OVERFLOW 84",
+        "#define varVar 55",
+        "#define ewrite if (priority <= 3) write((priority), format)",
+        "#define ewrite2 if (priority <= 3) write((priority), format)",
+    )
     assert len(ref_results) == len(results) - 1
     check_return(results[1:], ref_results)

test/test_source/pp/include/petscpc.h

@@ -5,5 +5,9 @@
 
 #define PC type(tPC)
 #define PCType character*(80)
-
+#define ewrite(priority, format) if (priority <= 3) write((priority), format) 
+#define ewrite2(priority, format) \
+    if (priority <= 3) write((priority), format) 
+#define varVar \
+        55
 #endif

test/test_source/pp/preproc.F90

@@ -5,6 +5,9 @@ program preprocessor
     integer, parameter :: var = 1000
     PCType :: tmp
     print*, 999, 3.14, "some", var, PETSC_ERR_MEM
-    print*, PETSC_ERR_INT_OVERFLOW
+    print*, PETSC_ERR_INT_OVERFLOW, varVar
+    ewrite(1,*) 'Assemble EP P1 matrix and rhs sytem'
+    ewrite2(1,*) 'Assemble EP P1 matrix and rhs sytem'
+
 #endif
 end program preprocessor