compose.c: fix untrusted source issue

[platform/upstream/libxkbcommon.git] / scripts / makeheader

diff --git a/scripts/makeheader b/scripts/makeheader
index f2738bd..7091aa4 100755 (executable)
--- a/scripts/makeheader
+++ b/scripts/makeheader
@@ -1,7 +1,8 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 from __future__ import print_function
 import re
 import os
+from pathlib import Path
 
 # Expected format:
 #     #define XF86XK_FooBar 0x1234         /* some optional comment */
@@ -18,6 +19,9 @@ keysym_entry_pattern = re.compile(
     re.VERBOSE,
 )
 
+# Match keysym guarded by #ifndef
+keysym_ifndef_pattern = re.compile(r"^#ifndef\s+(?P<prefix>\w*)XK_(?P<name>\w+)\s*$")
+
 # Match remaining XK_ references in the comments, e.g we will replace:
 #       XF86XK_CamelCaseKernelName     _EVDEVK(kernel value)
 #       #define XKB_KEY_SunCompose             0x0000FF20      /* Same as XK_Multi_key */
@@ -27,6 +31,10 @@ keysym_entry_pattern = re.compile(
 xorgproto_keysym_prefix_pattern = re.compile(r"\b(?P<prefix>\w*)XK_(?!KOREAN\b)")
 
 
+def make_keysym_name(m: re.Match[str]) -> str:
+    return m.group("prefix") + m.group("name")
+
+
 def make_keysym_entry(m: re.Match[str]) -> str:
     """
     Perform the substitutions
@@ -49,14 +57,14 @@ def make_keysym_entry(m: re.Match[str]) -> str:
     return f"""{define} XKB_KEY_{prefix}{name}{spacing}{value_str}"""
 
 
-prefix = os.environ.get("X11_HEADERS_PREFIX", "/usr")
-HEADERS = [
-    prefix + "/include/X11/keysymdef.h",
-    prefix + "/include/X11/XF86keysym.h",
-    prefix + "/include/X11/Sunkeysym.h",
-    prefix + "/include/X11/DECkeysym.h",
-    prefix + "/include/X11/HPkeysym.h",
-]
+prefix = Path(os.environ.get("X11_HEADERS_PREFIX", "/usr"))
+HEADERS = (
+    prefix / "include/X11/keysymdef.h",
+    prefix / "include/X11/XF86keysym.h",
+    prefix / "include/X11/Sunkeysym.h",
+    prefix / "include/X11/DECkeysym.h",
+    prefix / "include/X11/HPkeysym.h",
+)
 
 print(
     """#ifndef _XKBCOMMON_KEYSYMS_H
@@ -72,21 +80,51 @@ print(
 #define XKB_KEY_NoSymbol                    0x000000  /* Special KeySym */
 """
 )
+
+keysyms: set[str] = set()
 for path in HEADERS:
-    with open(path) as header:
+    pending_guarded_keysym: str | None = None
+    with path.open("rt", encoding="utf-8") as header:
         for line in header:
-            if "#ifdef" in line or "#ifndef" in line or "#endif" in line:
+            # Duplicate keysym name guard
+            if m := keysym_ifndef_pattern.match(line):
+                if pending_guarded_keysym:
+                    raise ValueError(f"Nested #ifndef {pending_guarded_keysym}")
+                pending_guarded_keysym = make_keysym_name(m)
                 continue
 
-            # Remove #define _OSF_Keysyms and such.
-            if "#define _" in line:
+            # Ignore C macro #ifdef/#ifndef
+            elif line.startswith("#ifdef") or line.startswith("#ifndef"):
+                if pending_guarded_keysym:
+                    raise ValueError(f"Nested C macro {pending_guarded_keysym}")
                 continue
 
-            # Handle a duplicate definition in HPkeysyms.h which kicks in if
-            # it's not already defined.
-            if "XK_Ydiaeresis" in line and "0x100000ee" in line:
+            # Ignore C macro #endif and check end of keysym name guard
+            elif line.startswith("#endif"):
+                if pending_guarded_keysym:
+                    pending_guarded_keysym = None
                 continue
 
+            # Remove #define _OSF_Keysyms and such.
+            elif line.startswith("#define _"):
+                continue
+
+            # Keysym entry: proceed various tests
+            if line.startswith("#") and (m := keysym_entry_pattern.match(line)):
+                name = make_keysym_name(m)
+                # Check expected guarded keysym, if relevant
+                if pending_guarded_keysym and name != pending_guarded_keysym:
+                    raise ValueError(f"{path}: Malformed keysym name guard: {line}")
+                # Check if name already defined
+                elif name in keysyms:
+                    if pending_guarded_keysym:
+                        # Ignore guarded keysym
+                        continue
+                    else:
+                        raise ValueError(f"{path}: Unguarded redefinition: {line}")
+                else:
+                    keysyms.add(name)
+
             # Perform _EVDEV and XK_ substitutions
             line = keysym_entry_pattern.sub(make_keysym_entry, line)
             line = xorgproto_keysym_prefix_pattern.sub(r"XKB_KEY_\1", line)