3 # openssl-format-source
4 # - format source tree according to OpenSSL coding style using indent
7 # openssl-format-source [-v] [-n] [file|directory] ...
9 # note: the indent options assume GNU indent v2.2.10 which was released
10 # Feb-2009 so if you have an older indent the options may not
11 # match what is expected
13 # any marked block comment blocks have to be moved to align manually after
14 # the reformatting has been completed as marking a block causes indent to
15 # not move it at all ...
18 PATH=/usr/local/bin:/bin:/usr/bin:$PATH
25 echo "usage: $0 [-v] [-n] [-c] [sourcefile|sourcedir] ..." >&2
36 # for this exercise, we want to force the openssl style, so we roll
37 # our own indent profile, which is at a well known location
38 INDENT_PROFILE="$HERE/indent.pro"
40 if [ ! -f "$INDENT_PROFILE" ]; then
41 echo "$0: unable to locate the openssl indent.pro file" >&2
45 # Extra arguments; for adding the comment-formatting
49 if [ "$STOPARGS" != "true" ]; then
51 --) STOPARGS="true"; continue;;
52 -n) DONT="true"; continue;;
54 echo "INDENT_PROFILE=$INDENT_PROFILE";
57 INDENT_ARGS="-fc1 -fca -cdb -sc";
61 -d) DEBUG='eval tee "$j.pre" |'
67 LIST=`find "$i" -name '*.[ch]' -print`
69 if [ ! -f "$i" ]; then
70 echo "$0: source file not found: $i" >&2
78 # ignore symlinks - we only ever process the base file - so if we
79 # expand a directory tree we need to ignore any located symlinks
86 if [ "$DONT" = "false" ]; then
87 tmp=$(mktemp /tmp/indent.XXXXXX)
88 trap 'rm -f "$tmp"' HUP INT TERM EXIT
91 # the list of files that indent is unable to handle correctly
92 # that we simply leave alone for manual formatting now
93 obj_dat.h|aes_core.c|aes_x86core.c|ecp_nistz256.c)
97 if [ "$COMMENTS" = "true" ]; then
98 # we have to mark single line comments as /*- ...*/ to stop indent
99 # messing with them, run expand then indent as usual but with the
100 # the process-comments options and then undo that marking, and then
101 # finally re-run indent without process-comments so the marked-to-
102 # be-ignored comments we did automatically end up getting moved
103 # into the right possition within the code as indent leaves marked
104 # comments entirely untouched - we appear to have no way to avoid
105 # the double processing and get the desired output
109 -e 's/(\n#[ \t]*ifdef[ \t]+__cplusplus\n[^\n]*\n#[ \t]*endif\n)/\n\/**INDENT-OFF**\/$1\/**INDENT-ON**\/\n/g;' \
110 -e 's/(\n\/\*\!)/\n\/**/g;' \
111 -e 's/(STACK_OF|LHASH_OF)\(([^ \t,\)]+)\)( |\n)/$1_$2_$3/g;' \
114 -e 's/^([ \t]*)\/\*([ \t]+.*)\*\/[ \t]*$/if (length("$1$2")<75) {$c="-"}else{$c=""}; "$1\/*$c$2*\/"/e;' \
115 -e 's/^\/\* ((Copyright|=|----).*)$/\/*-$1/;' \
116 -e 's/^((DECLARE|IMPLEMENT)_(EXTERN_ASN1|ASN1|ADB|STACK_OF|PKCS12_STACK_OF).*)$/\/**INDENT-OFF**\/\n$1\n\/**INDENT-ON**\//;' \
117 -e 's/^([ \t]*(make_dh|make_dh_bn|make_rfc5114_td)\(.*\)[ \t,]*)$/\/**INDENT-OFF**\/\n$1\n\/**INDENT-ON**\//;' \
118 -e 's/^(ASN1_ADB_TEMPLATE\(.*)$/\/**INDENT-OFF**\/\n$1\n\/**INDENT-ON**\//;' \
119 -e 's/^((ASN1|ADB)_.*_(end|END)\(.*[\){=,;]+[ \t]*)$/$1\n\/**INDENT-ON**\//;' \
120 -e '/ASN1_(ITEM_ref|ITEM_ptr|ITEM_rptr|PCTX)/ || s/^((ASN1|ADB)_[^\*]*[){=,]+[ \t]*)$/\/**INDENT-OFF**\/\n$1/;' \
121 -e 's/^(} (ASN1|ADB)_[^\*]*[\){=,;]+)$/$1\n\/**INDENT-ON**\//;' \
123 $DEBUG indent $INDENT_ARGS | \
125 -e 's/^([ \t]*)\/\*-(.*)\*\/[ \t]*$/$1\/*$2*\//;' \
126 -e 's/^\/\*-((Copyright|=|----).*)$/\/* $1/;' \
129 -e 's/\/\*\*INDENT-(ON|OFF)\*\*\/\n//g;' \
131 -e 's/(STACK_OF|LHASH_OF)_([^ \t,]+)_( |\/)/$1($2)$3/g;' \
132 -e 's/(STACK_OF|LHASH_OF)_([^ \t,]+)_$/$1($2)/g;' \
133 | perl "$HERE"/su-filter.pl \
136 expand "$j" | indent $INDENT_ARGS > "$tmp"
138 if cmp -s "$tmp" "$j"; then
139 if [ "$VERBOSE" = "true" ]; then
144 if [ "$VERBOSE" = "true" ]; then
157 if [ "$VERBOSE" = "true" ]; then
159 if [ "$CHANGED" = "true" ]; then
160 echo "SOURCE WAS MODIFIED"
162 echo "SOURCE WAS NOT MODIFIED"