scripts/kabi: tui: add interactive interface.

Signed-off-by: Quentin Casasnovas <quentin.casasnovas@vates.tech>

Author: casasnovas

scripts/kabi/src/kabi/cli.py

@@ -173,6 +173,52 @@ def main() -> None:
         help="kabi_lockedlist file",
     )
 
+    tui_p = subp.add_parser(
+        "tui",
+        help="Opens an interactive user interface to help fixing kABI changes",
+    )
+    tui_p.set_defaults(func=commands.tui)
+    tui_p.add_argument(
+        "--locked-file",
+        "-l",
+        required=True,
+        metavar="KABI.LOCKED_FILE",
+        help="Path to the kabi.locked_file (e.g. xcpng-8.3-kabi.locked_list)",
+    )
+    tui_p.add_argument(
+        "--repository",
+        "-r",
+        default="./",
+        help="Path to the git repository hosting the source code",
+    )
+    tui_p.add_argument(
+        "--rev-list",
+        required=True,
+        help="Options passed to git rev-list to get the list of commits to audit (e.g. v4.19.19..v4.19.325)",
+    )
+    tui_p.add_argument(
+        "--old-vmlinux",
+        metavar="VMLINUX.O",
+        required=False,
+        help="Unstripped vmlinux.o file before changes",
+    )
+    tui_p.add_argument(
+        "--new-vmlinux",
+        metavar="VMLINUX.O",
+        required=False,
+        help="Unstripped vmlinux.o file after changes",
+    )
+    tui_p.add_argument(
+        "symtypes_lhs",
+        metavar="Modules.kabi|Symtypes.build",
+        help="Symtypes file for baseline (e.g. kABI Modules.kabi-v4.19.19)",
+    )
+    tui_p.add_argument(
+        "symtypes_rhs",
+        metavar="Modules.kabi|Symtypes.build",
+        help=("Symtypes file for comparison (e.g. Symtypes.build-v4.19.325)"),
+    )
+
     args = p.parse_args()
     if not getattr(args, "func", None):
         p.print_help()

scripts/kabi/src/kabi/commands.py

@@ -9,6 +9,7 @@
 from .fileio import read_lockedlist, read_symbols, read_symvers
 from .symtypes import SymTypes
 from .utils import collect_helper, compare_helper, print_diffs
+from .ui.app import KabiTuiApp
 
 
 def check(args: argparse.Namespace) -> NoReturn:
@@ -182,3 +183,7 @@ def smoke(args: argparse.Namespace) -> NoReturn:
         print("Unless you've modified Module.kabi or Symtypes.kabi, you should")
         print("report these to the UEK maintainers.")
     sys.exit(ret)
+
+
+def tui(args: argparse.Namespace):
+    KabiTuiApp(args).run()

scripts/kabi/src/kabi/fileio.py

@@ -1,3 +1,5 @@
+from collections import defaultdict
+
 def read_symvers(filename: str) -> dict[str, tuple[str, str, str]]:
     vers: dict[str, tuple[str, str, str]] = {}
     with open(filename) as f:
@@ -15,6 +17,19 @@ def read_lockedlist(filename: str) -> set[str]:
         return {line.strip() for line in f if not line.startswith("[")}
 
 
+def read_lockedlist_grouped(filename: str) -> dict[str, str]:
+    module_symbols: defaultdict[str, list] = defaultdict(list)
+    with open(filename) as f:
+        cur_module = "unknown"
+        for line in f:
+            line = line.strip()
+            if line.startswith("["):
+                cur_module = line[1:-1]
+            else:
+                module_symbols[line].append(cur_module)
+    return module_symbols
+
+
 def read_symbols(filename: str) -> set[str]:
     with open(filename) as f:
         first_line = f.readline()

scripts/kabi/src/kabi/symtypes.py

@@ -8,7 +8,7 @@
 
 class SymTypes:
     PREFIXES: dict[str, str] = {
-        "t": "",
+        "t": "typedef ",
         "E": "",
         "e": "enum ",
         "s": "struct ",
@@ -65,7 +65,7 @@ def gen_short_decl(self, token: str) -> str:
         result: list[str] = []
         for tok in self.symtok[token]:
             result.append(self.name(tok))
-        return pretty(" ".join(result))
+        return pretty(" ".join(result), enum_mode=token.startswith("e#"))
 
     def crc(self, token: str, fn: str | None = None) -> int:
         if not fn: