Adds incl_suffixes in the settings

Author: gnikit

CHANGELOG.md

@@ -9,6 +9,7 @@
 - Adds Go To Definition for `include` statements
 - Adds intrinsic support for `OpenACC` version 3.1
 - Adds sphinx autogenerated documentation
+- Adds `incl_suffixes` as a configuration option
 
 ### Changes
 

README.md

@@ -157,6 +157,7 @@ All command line options are also available through the **options** file as well
 - `max_line_length` Maximum line length (default: none)
 - `max_comment_line_length` Maximum comment line length (default:
   none)
+- `incl_suffixes` Add more Fortran extensions to be parsed by the server
 
 ## Additional settings
 

fortls/langserver.py

@@ -1,4 +1,3 @@
-# TODO: make FORTRAN_EXT_REGEX be able to update from user input extensions
 # TODO: enable jsonc C-style comments
 from __future__ import annotations
 
@@ -9,6 +8,7 @@
 import traceback
 from multiprocessing import Pool
 from pathlib import Path
+from typing import Pattern
 
 # Local modules
 from fortls.constants import (
@@ -52,11 +52,11 @@
     LOGICAL_REGEX,
     NUMBER_REGEX,
     SQ_STRING_REGEX,
+    src_file_exts,
 )
 
 log = logging.getLogger(__name__)
 # Global regexes
-FORTRAN_EXT_REGEX = re.compile(r"\.F(77|90|95|03|08|OR|PP)?$", re.I)
 # TODO: I think this can be replaced by fortls.regex_patterns type & class
 TYPE_DEF_REGEX = re.compile(r"[ ]*(TYPE|CLASS)[ ]*\([a-z0-9_ ]*$", re.I)
 # TODO: I think this can be replaced by fortls.regex_patterns
@@ -94,13 +94,15 @@ def __init__(self, conn, debug_log=False, settings={}):
         self.link_version = 0
         self.source_dirs = set()
         self.excl_paths = set()
-        self.excl_suffixes = []
+        self.incl_suffixes: list[str] = []
+        self.excl_suffixes: list[str] = []
         self.post_messages = []
         self.pp_suffixes = None
         self.pp_defs = {}
         self.include_dirs = []
         self.streaming = True
         self.debug_log = debug_log
+        self.FORTRAN_SRC_EXT_REGEX: Pattern[str] = src_file_exts()
         # Intrinsic (re-loaded during initialize)
         (
             self.statements,
@@ -1491,6 +1493,9 @@ def __load_config_file_dirs(self, config_dict) -> None:
         self.source_dirs = {i for i in self.source_dirs if i not in self.excl_paths}
 
     def __load_config_file_general(self, config_dict) -> None:
+        self.incl_suffixes = config_dict.get("incl_suffixes", [])
+        # Update the source file REGEX
+        self.FORTRAN_SRC_EXT_REGEX = src_file_exts(self.incl_suffixes)
         self.excl_suffixes = config_dict.get("excl_suffixes", [])
         self.lowercase_intrinsics = config_dict.get(
             "lowercase_intrinsics", self.lowercase_intrinsics
@@ -1535,7 +1540,7 @@ def __add_source_dirs(self) -> None:
         self.source_dirs = set()
         for root, dirs, files in os.walk(self.root_path):
             # Match not found
-            if not list(filter(FORTRAN_EXT_REGEX.search, files)):
+            if not list(filter(self.FORTRAN_SRC_EXT_REGEX.search, files)):
                 continue
             if root not in self.source_dirs and root not in self.excl_paths:
                 self.source_dirs.add(str(Path(root).resolve()))
@@ -1563,7 +1568,7 @@ def __get_source_files(self) -> list[str]:
                 if not os.path.isfile(p):
                     continue
                 # File extension must match supported extensions
-                if not FORTRAN_EXT_REGEX.search(f):
+                if not self.FORTRAN_SRC_EXT_REGEX.search(f):
                     continue
                 # File cannot be in excluded paths/files
                 if p in self.excl_paths:

fortls/regex_patterns.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import re
+from typing import Pattern
 
 USE_REGEX = re.compile(
     r"[ ]*USE([, ]+(?:INTRINSIC|NON_INTRINSIC))?[ :]+(\w*)([, ]+ONLY[ :]+)?",
@@ -125,3 +128,32 @@
 CLASS_VAR_REGEX = re.compile(r"(TYPE|CLASS)[ ]*\(", re.I)
 DEF_KIND_REGEX = re.compile(r"([a-z]*)[ ]*\((?:KIND|LEN)?[ =]*([a-z_]\w*)", re.I)
 OBJBREAK_REGEX = re.compile(r"[\/\-(.,+*<>=$: ]", re.I)
+
+
+def src_file_exts(input_exts: list[str] = []) -> Pattern[str]:
+    """Create a REGEX for which file extensions the Language Server should parse
+    Default extensions are
+    F F03 F05 F08 F18 F77 F90 F95 FOR FPP f f03 f05 f08 f18 f77 f90 f95 for fpp
+
+    Parameters
+    ----------
+    input_exts : list[str], optional
+        Additional Fortran, by default []
+
+    Returns
+    -------
+    Pattern[str]
+        A compiled regular expression, by default
+        '.(F|F03|F05|F08|F18|F77|F90|F95|FOR|FPP|f|f03|f05|f08|f18|f77|f90|f95|for|fpp)?'
+    """
+    EXTS = ["", "77", "90", "95", "03", "05", "08", "18", "OR", "PP"]
+    FORTRAN_FILE_EXTS = []
+    for e in EXTS:
+        FORTRAN_FILE_EXTS.extend([f"F{e}".upper(), f"f{e}".lower()])
+    # Add the custom extensions for the server to parse
+    for e in input_exts:
+        if e.startswith("."):
+            FORTRAN_FILE_EXTS.append(e.replace(".", ""))
+    # Cast into a set to ensure uniqueness of extensions & sort for consistency
+    # Create a regular expression from this
+    return re.compile(fr"\.({'|'.join(sorted(set(FORTRAN_FILE_EXTS)))})?$")

test/test_source/pp/.pp_conf.json

@@ -1,15 +1,9 @@
 {
-    "lowercase_intrinsics": true,
-    "use_signature_help": true,
-    "variable_hover": true,
-    "hover_signature": true,
-    "enable_code_actions": true,
-    "include_dirs": [
-        "include"
-    ],
-    "pp_suffixes": [
-        ".h",
-        ".F90"
-    ]
-    
-}
+  "lowercase_intrinsics": true,
+  "use_signature_help": true,
+  "variable_hover": true,
+  "hover_signature": true,
+  "enable_code_actions": true,
+  "incl_suffixes": [".h"],
+  "include_dirs": ["include"]
+}