test/symbols-leak-test.py

   1 #!/usr/bin/env python3
   2 """Check that all exported symbols are specified in the symbol version scripts.
   3
   4 If this fails, please update the appropriate .map file (adding new version
   5 nodes as needed).
   6 """
   7 import glob
   8 import os
   9 import pathlib
  10 import re
  11 import sys
  12
  13
  14 top_srcdir = pathlib.Path(os.environ['top_srcdir'])
  15
  16
  17 def symbols_from_map(path):
  18     return re.findall(r'^\s+(xkb_.*);', path.read_text('utf-8'), re.MULTILINE)
  19
  20
  21 def symbols_from_src(path):
  22     return re.findall(r'XKB_EXPORT.*\n(xkb_.*)\(', path.read_text('utf-8'))
  23
  24
  25 def diff(map_path, src_paths):
  26     map_symbols = set(symbols_from_map(map_path))
  27     src_symbols = set.union(set(), *(symbols_from_src(path) for path in src_paths))
  28     return sorted(map_symbols - src_symbols), sorted(src_symbols - map_symbols)
  29
  30
  31 exit = 0
  32
  33 # xkbcommon symbols
  34 left, right = diff(
  35     top_srcdir/'xkbcommon.map',
  36     [
  37         *(top_srcdir/'src').glob('*.c'),
  38         *(top_srcdir/'src'/'xkbcomp').glob('*.c'),
  39         *(top_srcdir/'src'/'compose').glob('*.c'),
  40     ],
  41 )
  42 if left:
  43     print('xkbcommon map has extra symbols:', ' '.join(left))
  44     exit = 1
  45 if right:
  46     print('xkbcommon src has extra symbols:', ' '.join(right))
  47     exit = 1
  48
  49 # xkbcommon-x11 symbols
  50 left, right = diff(
  51     top_srcdir/'xkbcommon-x11.map',
  52     [
  53         *(top_srcdir/'src'/'x11').glob('*.c'),
  54     ],
  55 )
  56 if left:
  57     print('xkbcommon-x11 map has extra symbols:', ' '.join(left))
  58     exit = 1
  59 if right:
  60     print('xkbcommon-x11 src has extra symbols:', ' '.join(right))
  61     exit = 1
  62
  63 sys.exit(exit)