mirror of
https://github.com/irungentoo/toxcore.git
synced 2024-03-22 13:30:51 +08:00
1859d0f44a
Most system headers contain functions (e.g. `memcpy` in `string.h`) which aren't needed in our own header files. For the most part, our own headers should only include types needed to declare our own types and functions. We now enforce this so we think twice about which headers we really need in the .h files.
58 lines
1.5 KiB
Python
Executable File
58 lines
1.5 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
import subprocess
|
|
import sys
|
|
from typing import Tuple
|
|
|
|
ALLOWLIST: Tuple[str, ...] = (
|
|
# system headers
|
|
"pthread.h",
|
|
"stdarg.h",
|
|
"stdbool.h",
|
|
"stddef.h",
|
|
"stdint.h",
|
|
# toxav stuff, maybe not worth abstracting away
|
|
"opus.h",
|
|
"vpx/vp8cx.h",
|
|
"vpx/vp8dx.h",
|
|
"vpx/vpx_decoder.h",
|
|
"vpx/vpx_encoder.h",
|
|
"vpx/vpx_image.h",
|
|
)
|
|
|
|
out = (subprocess.run(
|
|
[
|
|
"grep", "-R", "^#include <.*>", "other", "toxav", "toxcore",
|
|
"toxencryptsave"
|
|
],
|
|
check=True,
|
|
capture_output=True,
|
|
).stdout.decode("utf-8").rstrip())
|
|
|
|
errors = 0
|
|
for line in out.split("\n"):
|
|
# other/fun can do what it wants.
|
|
if "/fun/" in line:
|
|
continue
|
|
filename, include = line.split(":", 1)
|
|
# We only check headers.
|
|
if not filename.endswith(".h"):
|
|
continue
|
|
# ccompat.h can include some things we don't really want elsewhere.
|
|
allowlist = ALLOWLIST
|
|
if filename == "toxcore/ccompat.h":
|
|
allowlist += ("alloca.h", "malloc.h", "stdlib.h")
|
|
header = include[include.index("<") + 1:include.index(">")]
|
|
if header not in allowlist:
|
|
source = filename[:-2] + ".c"
|
|
print(
|
|
f"{filename}: includes system header <{header}>, which is not allowed in .h files"
|
|
)
|
|
print(
|
|
" " * len(filename) +
|
|
f" consider including it in {source} and exporting an abstraction, instead"
|
|
)
|
|
errors += 1
|
|
|
|
if errors:
|
|
sys.exit(1)
|