feat(debug): added preprocessor debug cli option

Author: gnikit

fortls/__init__.py

@@ -3,7 +3,13 @@
 import sys
 from multiprocessing import freeze_support
 
-from .debug import DebugError, debug_lsp, debug_parser, is_debug_mode
+from .debug import (
+    DebugError,
+    debug_lsp,
+    debug_parser,
+    debug_preprocessor,
+    is_debug_mode,
+)
 from .interface import cli
 from .jsonrpc import JSONRPC2Connection, ReadWriter
 from .langserver import LangServer
@@ -20,6 +26,9 @@ def main():
         if args.debug_parser:
             debug_parser(args)
 
+        elif args.debug_preproc:
+            debug_preprocessor(args)
+
         elif is_debug_mode(args):
             debug_lsp(args, vars(args))
 

fortls/debug.py

@@ -1,14 +1,16 @@
 from __future__ import annotations
 
+import logging
 import os
 import pprint
+import sys
 
 import json5
 
 from .helper_functions import only_dirs, resolve_globs
 from .jsonrpc import JSONRPC2Connection, ReadWriter, path_from_uri
 from .langserver import LangServer
-from .parsers.internal.parser import FortranFile
+from .parsers.internal.parser import FortranFile, preprocess_file
 
 
 class DebugError(Exception):
@@ -439,6 +441,56 @@ def debug_parser(args):
     separator()
 
 
+def debug_preprocessor(args):
+    """Debug the preprocessor of the Language Server
+    Triggered by `--debug_preprocessor` option.
+
+    Parameters
+    ----------
+    args : Namespace
+        The arguments parsed from the `ArgumentParser`
+    """
+
+    def sep_lvl2(heading: str):
+        print("\n" + "=" * 75 + f"\n{heading}\n" + "=" * 75)
+
+    print("\nTesting preprocessor")
+    separator()
+
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout, format="%(message)s")
+
+    file = args.debug_filepath
+    ensure_file_accessible(file)
+    with open(file, encoding="utf-8") as f:
+        lines = f.readlines()
+
+    root = args.debug_rootpath if args.debug_rootpath else os.path.dirname(file)
+    _, pp_defs, include_dirs = read_config(root, args.config)
+
+    sep_lvl2("Preprocessor Pass:")
+    output, skips, defines, defs = preprocess_file(
+        lines, file, pp_defs, include_dirs, debug=True
+    )
+
+    sep_lvl2("Preprocessor Skipped Lines:")
+    for line in skips:
+        print(f"  {line}")
+
+    sep_lvl2("Preprocessor Macros:")
+    for key, value in defs.items():
+        print(f"  {key} = {value}")
+
+    sep_lvl2("Preprocessor Defines (#define):")
+    for line in defines:
+        print(f"  {line}")
+
+    sep_lvl2("Preprocessor Final Output:")
+    for line in output:
+        print(rf"  {line.rstrip()}")
+
+    separator()
+
+
 def ensure_file_accessible(filepath: str):
     """Ensure the file exists and is accessible, raising an error if not."""
     if not os.path.isfile(filepath):

fortls/interface.py

@@ -333,6 +333,11 @@ def hide_opt(help: str) -> str:
         action="store_true",
         help=hide_opt("Test source code parser on specified file"),
     )
+    group.add_argument(
+        "--debug_preproc",
+        action="store_true",
+        help=hide_opt("Test source code preprocessor parser on specified file"),
+    )
     group.add_argument(
         "--debug_hover",
         action="store_true",