godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Style: Integrate #pragma once in builders/checks

Browse Source
This commit is contained in:
Thaddeus Crews
2025-02-01 10:11:55 -06:00
parent 7459a0361d
commit 96fdaa616b
17 changed files with 44 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
misc/scripts/char_range_fetch.py
View File

@@ -106,8 +106,7 @@ def generate_char_range_inc() -> None:
source += f"""
// This file was generated using the `misc/scripts/char_range_fetch.py` script.
#ifndef CHAR_RANGE_INC
#define CHAR_RANGE_INC
#pragma once
#include "core/typedefs.h"
@@ -125,8 +124,6 @@ struct CharRange {{
source += make_array("lowercase_letter", lowercase_letter)
source += make_array("unicode_letter", unicode_letter)
source += "#endif // CHAR_RANGE_INC\n"
char_range_path: str = os.path.join(os.path.dirname(__file__), "../../core/string/char_range.inc")
with open(char_range_path, "w", newline="\n") as f:
f.write(source)

134
misc/scripts/header_guards.py
View File

@@ -2,7 +2,6 @@
# -*- coding: utf-8 -*-
import sys
from pathlib import Path
if len(sys.argv) < 2:
print("Invalid usage of header_guards.py, it should be called with a path to one or multiple files.")
@@ -13,7 +12,7 @@ invalid = []
for file in sys.argv[1:]:
header_start = -1
HEADER_CHECK_OFFSET = -1
header_end = -1
with open(file.strip(), "rt", encoding="utf-8", newline="\n") as f:
lines = f.readlines()
@@ -28,17 +27,21 @@ for file in sys.argv[1:]:
if sline.startswith("/**********"): # Godot header starts this way.
header_start = idx
else:
HEADER_CHECK_OFFSET = 0 # There is no Godot header.
header_end = 0 # There is no Godot header.
break
else:
if not sline.startswith("*") and not sline.startswith("/*"): # Not in the Godot header anymore.
HEADER_CHECK_OFFSET = idx + 1 # The include should be two lines below the Godot header.
if not sline.startswith(("*", "/*")): # Not in the Godot header anymore.
header_end = idx + 1 # The guard should be two lines below the Godot header.
break
if HEADER_CHECK_OFFSET < 0:
if (HEADER_CHECK_OFFSET := header_end) < 0 or HEADER_CHECK_OFFSET >= len(lines):
invalid.append(file)
continue
if lines[HEADER_CHECK_OFFSET].startswith("#pragma once"):
continue
# Might be using legacy header guards.
HEADER_BEGIN_OFFSET = HEADER_CHECK_OFFSET + 1
HEADER_END_OFFSET = len(lines) - 1
@@ -46,124 +49,35 @@ for file in sys.argv[1:]:
invalid.append(file)
continue
split = file.split("/") # Already in posix-format.
prefix = ""
if split[0] == "modules" and split[-1] == "register_types.h":
prefix = f"{split[1]}_" # Name of module.
elif split[0] == "platform" and (file.endswith("api/api.h") or "/export/" in file):
prefix = f"{split[1]}_" # Name of platform.
elif file.startswith("modules/mono/utils") and "mono" not in split[-1]:
prefix = "MONO_"
elif file == "servers/rendering/storage/utilities.h":
prefix = "RENDERER_"
suffix = ""
if "dummy" in file and "dummy" not in split[-1]:
suffix = "_DUMMY"
elif "gles3" in file and "gles3" not in split[-1]:
suffix = "_GLES3"
elif "renderer_rd" in file and "rd" not in split[-1]:
suffix = "_RD"
elif split[-1] == "ustring.h":
suffix = "_GODOT"
name = (f"{prefix}{Path(file).stem}{suffix}{Path(file).suffix}".upper()
.replace(".", "_").replace("-", "_").replace(" ", "_")) # fmt: skip
HEADER_CHECK = f"#ifndef {name}\n"
HEADER_BEGIN = f"#define {name}\n"
HEADER_END = f"#endif // {name}\n"
if (
lines[HEADER_CHECK_OFFSET] == HEADER_CHECK
and lines[HEADER_BEGIN_OFFSET] == HEADER_BEGIN
and lines[HEADER_END_OFFSET] == HEADER_END
):
continue
# Guards might exist but with the wrong names.
if (
lines[HEADER_CHECK_OFFSET].startswith("#ifndef")
and lines[HEADER_BEGIN_OFFSET].startswith("#define")
and lines[HEADER_END_OFFSET].startswith("#endif")
):
lines[HEADER_CHECK_OFFSET] = HEADER_CHECK
lines[HEADER_BEGIN_OFFSET] = HEADER_BEGIN
lines[HEADER_END_OFFSET] = HEADER_END
lines[HEADER_CHECK_OFFSET] = "#pragma once"
lines[HEADER_BEGIN_OFFSET] = "\n"
lines.pop()
with open(file, "wt", encoding="utf-8", newline="\n") as f:
f.writelines(lines)
changed.append(file)
continue
header_check = -1
header_begin = -1
header_end = -1
pragma_once = -1
objc = False
for idx, line in enumerate(lines):
if line.startswith("// #import"): # Some dummy obj-c files only have commented out import lines.
objc = True
break
if not line.startswith("#"):
continue
elif line.startswith("#ifndef") and header_check == -1:
header_check = idx
elif line.startswith("#define") and header_begin == -1:
header_begin = idx
elif line.startswith("#endif") and header_end == -1:
header_end = idx
elif line.startswith("#pragma once"):
pragma_once = idx
break
elif line.startswith("#import"):
objc = True
# Verify `#pragma once` doesn't exist at invalid location.
misplaced = False
for line in lines:
if line.startswith("#pragma once"):
misplaced = True
break
if objc:
if misplaced:
invalid.append(file)
continue
if pragma_once != -1:
lines.pop(pragma_once)
lines.insert(HEADER_CHECK_OFFSET, HEADER_CHECK)
lines.insert(HEADER_BEGIN_OFFSET, HEADER_BEGIN)
lines.append("\n")
lines.append(HEADER_END)
with open(file, "wt", encoding="utf-8", newline="\n") as f:
f.writelines(lines)
changed.append(file)
continue
if header_check == -1 and header_begin == -1 and header_end == -1:
# Guards simply didn't exist
lines.insert(HEADER_CHECK_OFFSET, HEADER_CHECK)
lines.insert(HEADER_BEGIN_OFFSET, HEADER_BEGIN)
lines.append("\n")
lines.append(HEADER_END)
with open(file, "wt", encoding="utf-8", newline="\n") as f:
f.writelines(lines)
changed.append(file)
continue
if header_check != -1 and header_begin != -1 and header_end != -1:
# All prepends "found", see if we can salvage this.
if header_check == header_begin - 1 and header_begin < header_end:
lines.pop(header_check)
lines.pop(header_begin - 1)
lines.pop(header_end - 2)
if lines[header_end - 3] == "\n":
lines.pop(header_end - 3)
lines.insert(HEADER_CHECK_OFFSET, HEADER_CHECK)
lines.insert(HEADER_BEGIN_OFFSET, HEADER_BEGIN)
lines.append("\n")
lines.append(HEADER_END)
with open(file, "wt", encoding="utf-8", newline="\n") as f:
f.writelines(lines)
changed.append(file)
continue
invalid.append(file)
# Assume that we're simply missing a guard entirely.
lines.insert(HEADER_CHECK_OFFSET, "#pragma once\n\n")
with open(file, "wt", encoding="utf-8", newline="\n") as f:
f.writelines(lines)
changed.append(file)
if changed:
for file in changed:

5
misc/scripts/ucaps_fetch.py
View File

@@ -55,8 +55,7 @@ def generate_ucaps_fetch() -> None:
source: str = generate_copyright_header("ucaps.h")
source += f"""
#ifndef UCAPS_H
#define UCAPS_H
#pragma once
// This file was generated using the `misc/scripts/ucaps_fetch.py` script.
@@ -105,8 +104,6 @@ static int _find_lower(int ch) {
\treturn ch;
}
#endif // UCAPS_H
"""
ucaps_path: str = os.path.join(os.path.dirname(__file__), "../../core/string/ucaps.h")