feat(cli): adding --extract-func-names to list all symbols

Author: SuperFola

arkdoc/__main__.py

@@ -4,6 +4,8 @@
 import sys
 import argparse
 
+from arkdoc.generator.utils import extractor
+from arkdoc.parser import Source
 from . import logger
 from .logger_utils import LogLevel
 from .reader import parse_all_in
@@ -14,28 +16,61 @@
 EXIT_FAILURE = 1
 
 
-def compute(args) -> bool:
+def check_folders(source_folder) -> bool:
     global logger
 
-    for folder in args.source_folder:
+    for folder in source_folder:
         if not os.path.exists(folder):
             logger.error(f"Folder `{folder}` does not exists")
             return False
+    return True
 
-    if args.dry_run:
-        logger.level = LogLevel.DEBUG
+
+def parse_all(source_folder, dry_run) -> list:
+    global logger
 
     parsers = []
-    for folder in args.source_folder:
+    for folder in source_folder:
         parsers += parse_all_in(folder)
     for p in parsers:
         logger.info(f"Parsing {p.filename}...")
         p.parse()
 
-        if args.dry_run:
+        if dry_run:
             _ = list(p.extract_documentation())
 
+    return parsers
+
+def compute(args) -> bool:
+    global logger
+
+    if not check_folders(args.source_folder):
+        return False
+    if args.dry_run:
+        logger.level = LogLevel.DEBUG
+
+    parsers = parse_all(args.source_folder, args.dry_run)
+
     if not args.dry_run:
+        if args.extract_func_names:
+            functions = []
+            for p in parsers:
+                prefix = os.path.splitext(os.path.basename(p.filename))[0].lower()
+                for doc in p.extract_documentation():
+                    if doc.source == Source.ArkScript:
+                        kw, name, *args = doc.signature()
+                        if kw == "$":
+                            # macro!
+                            functions.append(name)
+                        else:
+                            functions.append(prefix + ":" + name)
+                    elif doc.source == Source.Cpp:
+                        data, _ = extractor({"name": ""}, doc)
+                        functions.append(data["name"])
+            print("\n".join(functions))
+            # early exit if the flag is present
+            return True
+
         if args.html:
             gen = HTMLGenerator(parsers, args.html, args.ark_version, args.root_dir)
             gen()
@@ -57,6 +92,11 @@ def main() -> int:
         action="store_true",
         help="Run and log everything but don't generate any file",
     )
+    cli.add_argument(
+        "--extract-func-names",
+        action="store_true",
+        help="Extract only the function names, print them on separate lines and exit",
+    )
     cli.add_argument("--html", type=str, help="Output folder for the HTML docs")
     cli.add_argument(
         "--root-dir", type=str, default="", help="The root dir for the links"

arkdoc/generator/utils.py

@@ -38,11 +38,12 @@ def extractor(data: Dict, doc: Documentation) -> Tuple[Dict, str]:
         margin = code[0].index("(")
         code = [line[margin:] for line in code]
 
-    for i, param in enumerate(data["param"]):
-        param_name, desc = param.split(" ", 1)
-        data["param"][i] = spec.Param(param_name, desc)
-
-    data["author"] = [el.strip() for el in data["author"].split(",") if data["author"]]
+    if "param" in data:
+        for i, param in enumerate(data["param"]):
+            param_name, desc = param.split(" ", 1)
+            data["param"][i] = spec.Param(param_name, desc)
+    if "author" in data:
+        data["author"] = [el.strip() for el in data["author"].split(",") if data["author"]]
 
     return data, "\n".join(code)