File: header_guards.sh

package info (click to toggle)
godot 3.6%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 270,588 kB
  • sloc: cpp: 971,579; ansic: 617,953; xml: 80,302; asm: 17,498; cs: 14,559; python: 11,744; java: 9,681; javascript: 4,654; pascal: 1,176; sh: 896; objc: 529; makefile: 176
file content (61 lines) | stat: -rwxr-xr-x 2,460 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
#!/bin/bash

if [ ! -f "version.py" ]; then
  echo "Warning: This script is intended to be run from the root of the Godot repository."
  echo "Some of the paths checks may not work as intended from a different folder."
fi

for file in $(find -name "thirdparty" -prune -o -name "*.h" -print); do
  # Skip *.gen.h and *-so_wrap.h, they're generated.
  if [[ "$file" == *".gen.h" || "$file" == *"-so_wrap.h" ]]; then continue; fi
  # Has important define before normal header guards.
  if [[ "$file" == *"thread.h" || "$file" == *"platform_config.h" ]]; then continue; fi

  bname=$(basename $file .h)

  # Add custom prefix or suffix for generic filenames with a well-defined namespace.

  prefix=
  if [[ "$file" == "./modules/gdnative/"*"/register_types.h" ]]; then
    module=$(echo $file | sed "s@.*modules/gdnative/\([^/]*\).*@\1@")
    prefix="${module^^}_"
  elif [[ "$file" == "./modules/"*"/register_types.h" ]]; then
    module=$(echo $file | sed "s@.*modules/\([^/]*\).*@\1@")
    prefix="${module^^}_"
  fi
  if [[ "$file" == "./platform/"*"/api/api.h" || "$file" == "./platform/"*"/export/"* ]]; then
    platform=$(echo $file | sed "s@.*platform/\([^/]*\).*@\1@")
    prefix="${platform^^}_"
  fi
  if [[ "$file" == "./modules/mono/utils/"* && "$bname" != *"mono"* ]]; then prefix="MONO_"; fi
  if [[ "$file" == "./modules/gdnative/include/gdnative/"* ]]; then prefix="GDNATIVE_"; fi

  suffix=
  if [[ "$file" == *"ustring.h" ]]; then suffix="_GODOT"; fi

  # ^^ is bash builtin for UPPERCASE.
  guard="${prefix}${bname^^}${suffix}_H"

  # Replaces guards to use computed name.
  # We also add some \n to make sure there's a proper separation.
  sed -i $file -e "0,/ifndef/s/#ifndef.*/\n#ifndef $guard/"
  sed -i $file -e "0,/define/s/#define.*/#define $guard\n/"
  sed -i $file -e "$ s/#endif.*/\n#endif \/\/ $guard/"
  # Removes redundant \n added before, if they weren't needed.
  sed -i $file -e "/^$/N;/^\n$/D"
done

diff=$(git diff --color)

# If no diff has been generated all is OK, clean up, and exit.
if [ -z "$diff" ] ; then
    printf "Files in this commit comply with the header guards formatting rules.\n"
    exit 0
fi

# A diff has been created, notify the user, clean up, and exit.
printf "\n*** The following differences were found between the code "
printf "and the header guards formatting rules:\n\n"
echo "$diff"
printf "\n*** Aborting, please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\n"
exit 1