scripts/unify-sources.sh
author Alpar Juttner <alpar@cs.elte.hu>
Fri, 07 Nov 2008 13:04:54 +0000
changeset 372 7b6466ed488a
parent 331 2f5c0c42a5cd
child 396 c5f010a5647a
permissions -rwxr-xr-x
Avoid bit operator precedence warning with gcc-4.3

Some of these warnings are actually revealed real bugs
alpar@38
     1
#!/bin/bash
alpar@38
     2
alpar@38
     3
YEAR=`date +2003-%Y`
alpar@38
     4
HGROOT=`hg root`
alpar@38
     5
deba@324
     6
# file enumaration modes
deba@324
     7
deba@324
     8
function all_files() {
deba@324
     9
    hg status -a -m -c |
deba@324
    10
    cut -d ' ' -f 2 | grep -E '(\.(cc|h|dox)$|Makefile\.am$)' |
deba@324
    11
    while read file; do echo $HGROOT/$file; done
deba@324
    12
}
deba@324
    13
deba@324
    14
function modified_files() {
deba@324
    15
    hg status -a -m |
deba@324
    16
    cut -d ' ' -f 2 | grep -E  '(\.(cc|h|dox)$|Makefile\.am$)' |
deba@324
    17
    while read file; do echo $HGROOT/$file; done
deba@324
    18
}
deba@324
    19
deba@324
    20
function changed_files() {
deba@324
    21
    {
deba@324
    22
        if [ -n "$HG_PARENT1" ]
deba@324
    23
        then
deba@324
    24
            hg status --rev $HG_PARENT1:$HG_NODE -a -m
deba@324
    25
        fi
deba@324
    26
        if [ -n "$HG_PARENT2" ]
deba@324
    27
        then
deba@324
    28
            hg status --rev $HG_PARENT2:$HG_NODE -a -m
deba@324
    29
        fi
deba@324
    30
    } | cut -d ' ' -f 2 | grep -E '(\.(cc|h|dox)$|Makefile\.am$)' | 
deba@324
    31
    sort | uniq |
deba@324
    32
    while read file; do echo $HGROOT/$file; done
deba@324
    33
}
deba@324
    34
deba@324
    35
function given_files() {
deba@324
    36
    for file in $GIVEN_FILES
deba@324
    37
    do
deba@324
    38
	echo $file
deba@324
    39
    done
deba@324
    40
}
deba@324
    41
deba@324
    42
# actions
deba@324
    43
deba@324
    44
function update_action() {
deba@324
    45
    if ! diff -q $1 $2 >/dev/null
deba@324
    46
    then
deba@324
    47
	echo -n " [$3 updated]"
deba@324
    48
	rm $2
deba@324
    49
	mv $1 $2
deba@324
    50
	CHANGED=YES
deba@324
    51
    fi
deba@324
    52
}
deba@324
    53
deba@324
    54
function update_warning() {
deba@324
    55
    echo -n " [$2 warning]"
deba@324
    56
    WARNED=YES
deba@324
    57
}
deba@324
    58
deba@324
    59
function update_init() {
deba@324
    60
    echo Update source files...
deba@324
    61
    TOTAL_FILES=0
deba@324
    62
    CHANGED_FILES=0
deba@324
    63
    WARNED_FILES=0
deba@324
    64
}
deba@324
    65
deba@324
    66
function update_done() {
deba@324
    67
    echo $CHANGED_FILES out of $TOTAL_FILES files has been changed.
alpar@325
    68
    echo $WARNED_FILES out of $TOTAL_FILES files triggered warnings.
deba@324
    69
}
deba@324
    70
deba@324
    71
function update_begin() {
deba@324
    72
    ((TOTAL_FILES++))
deba@324
    73
    CHANGED=NO
deba@324
    74
    WARNED=NO
deba@324
    75
}
deba@324
    76
deba@324
    77
function update_end() {
deba@324
    78
    if [ $CHANGED == YES ]
deba@324
    79
    then
deba@324
    80
	((++CHANGED_FILES))
deba@324
    81
    fi
deba@324
    82
    if [ $WARNED == YES ]
deba@324
    83
    then
deba@324
    84
	((++WARNED_FILES))
deba@324
    85
    fi
deba@324
    86
}
deba@324
    87
deba@324
    88
function check_action() {
kpeter@341
    89
    if [ "$3" == 'tabs' ]
kpeter@341
    90
    then
kpeter@341
    91
        PATTERN=$(echo -e '\t')
kpeter@341
    92
    elif [ "$3" == 'trailing spaces' ]
kpeter@341
    93
    then
kpeter@341
    94
        PATTERN='\ +$'
kpeter@341
    95
    else
kpeter@341
    96
        PATTERN='*'
kpeter@341
    97
    fi
kpeter@341
    98
deba@324
    99
    if ! diff -q $1 $2 >/dev/null
deba@324
   100
    then
kpeter@341
   101
        if [ "$PATTERN" == '*' ]
kpeter@341
   102
        then
kpeter@341
   103
            diff $1 $2 | grep '^[0-9]' | sed "s|^\(.*\)c.*$|$2:\1: check failed: $3|g" |
kpeter@341
   104
              sed "s/:\([0-9]*\),\([0-9]*\):\(.*\)$/:\1:\3 (until line \2)/g"
kpeter@341
   105
        else
kpeter@341
   106
            grep -n -E "$PATTERN" $2 | sed "s|^\([0-9]*\):.*$|$2:\1: check failed: $3|g"
kpeter@341
   107
        fi
kpeter@341
   108
        FAILED=YES
deba@324
   109
    fi
deba@324
   110
}
deba@324
   111
deba@324
   112
function check_warning() {
kpeter@329
   113
    if [ "$2" == 'long lines' ]
kpeter@329
   114
    then
kpeter@341
   115
        grep -n -E '.{81,}' $1 | sed "s|^\([0-9]*\):.*$|$1:\1: warning: $2|g"
kpeter@329
   116
    else
kpeter@341
   117
        echo "$1: warning: $2"
kpeter@329
   118
    fi
deba@324
   119
    WARNED=YES
deba@324
   120
}
deba@324
   121
deba@324
   122
function check_init() {
deba@324
   123
    echo Check source files...
deba@324
   124
    FAILED_FILES=0
deba@324
   125
    WARNED_FILES=0
deba@324
   126
    TOTAL_FILES=0
deba@324
   127
}
deba@324
   128
deba@324
   129
function check_done() {
deba@324
   130
    echo $FAILED_FILES out of $TOTAL_FILES files has been failed.
alpar@325
   131
    echo $WARNED_FILES out of $TOTAL_FILES files triggered warnings.
deba@324
   132
deba@324
   133
    if [ $FAILED_FILES -gt 0 ]
deba@324
   134
    then
deba@324
   135
	return 1
deba@324
   136
    elif [ $WARNED_FILES -gt 0 ]
deba@324
   137
    then
deba@324
   138
	if [ "$WARNING" == 'INTERACTIVE' ]
deba@324
   139
	then
alpar@325
   140
	    echo -n "Are the files with warnings acceptable? (yes/no) "
deba@324
   141
	    while read answer
deba@324
   142
	    do
deba@324
   143
		if [ "$answer" == 'yes' ]
deba@324
   144
		then
deba@324
   145
		    return 0
deba@324
   146
		elif [ "$answer" == 'no' ]
deba@324
   147
		then
deba@324
   148
		    return 1
deba@324
   149
		fi
alpar@325
   150
		echo -n "Are the files with warnings acceptable? (yes/no) "
deba@324
   151
	    done
deba@324
   152
	elif [ "$WARNING" == 'WERROR' ]
deba@324
   153
	then
deba@324
   154
	    return 1
deba@324
   155
	fi
deba@324
   156
    fi
deba@324
   157
}
deba@324
   158
deba@324
   159
function check_begin() {
deba@324
   160
    ((TOTAL_FILES++))
deba@324
   161
    FAILED=NO
deba@324
   162
    WARNED=NO
deba@324
   163
}
deba@324
   164
deba@324
   165
function check_end() {
deba@324
   166
    if [ $FAILED == YES ]
deba@324
   167
    then
deba@324
   168
	((++FAILED_FILES))
deba@324
   169
    fi
deba@324
   170
    if [ $WARNED == YES ]
deba@324
   171
    then
deba@324
   172
	((++WARNED_FILES))
deba@324
   173
    fi
deba@324
   174
}
deba@324
   175
deba@324
   176
deba@324
   177
deba@324
   178
# checks
deba@324
   179
deba@324
   180
function header_check() {
deba@324
   181
    if echo $1 | grep -q -E 'Makefile\.am$'
deba@324
   182
    then
deba@324
   183
	return
deba@324
   184
    fi
deba@324
   185
alpar@38
   186
    TMP_FILE=`mktemp`
alpar@38
   187
alpar@208
   188
    (echo "/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@38
   189
 *
alpar@208
   190
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@38
   191
 *
alpar@38
   192
 * Copyright (C) "$YEAR"
alpar@38
   193
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@38
   194
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@38
   195
 *
alpar@38
   196
 * Permission to use, modify and distribute this software is granted
alpar@38
   197
 * provided that this copyright notice appears in all copies. For
alpar@38
   198
 * precise terms see the accompanying LICENSE file.
alpar@38
   199
 *
alpar@38
   200
 * This software is provided \"AS IS\" with no warranty of any kind,
alpar@38
   201
 * express or implied, and with no claim as to its suitability for any
alpar@38
   202
 * purpose.
alpar@38
   203
 *
alpar@38
   204
 */
alpar@38
   205
"
deba@324
   206
    awk 'BEGIN { pm=0; }
alpar@38
   207
     pm==3 { print }
alpar@38
   208
     /\/\* / && pm==0 { pm=1;}
alpar@38
   209
     /[^:blank:]/ && (pm==0 || pm==2) { pm=3; print;}
alpar@38
   210
     /\*\// && pm==1 { pm=2;}
alpar@38
   211
    ' $1
deba@324
   212
    ) >$TMP_FILE
alpar@208
   213
deba@324
   214
    "$ACTION"_action "$TMP_FILE" "$1" header
alpar@38
   215
}
alpar@38
   216
deba@324
   217
function tabs_check() {
deba@324
   218
    if echo $1 | grep -q -v -E 'Makefile\.am$'
deba@324
   219
    then
deba@324
   220
        OLD_PATTERN=$(echo -e '\t')
deba@324
   221
        NEW_PATTERN='        '
deba@324
   222
    else
deba@324
   223
        OLD_PATTERN='        '
deba@324
   224
        NEW_PATTERN=$(echo -e '\t')
deba@324
   225
    fi
alpar@208
   226
    TMP_FILE=`mktemp`
deba@324
   227
    cat $1 | sed -e "s/$OLD_PATTERN/$NEW_PATTERN/g" >$TMP_FILE
alpar@38
   228
deba@324
   229
    "$ACTION"_action "$TMP_FILE" "$1" 'tabs'
alpar@208
   230
}
alpar@208
   231
deba@324
   232
function spaces_check() {
alpar@208
   233
    TMP_FILE=`mktemp`
deba@324
   234
    cat $1 | sed -e 's/ \+$//g' >$TMP_FILE
alpar@208
   235
kpeter@328
   236
    "$ACTION"_action "$TMP_FILE" "$1" 'trailing spaces'
alpar@208
   237
}
alpar@208
   238
deba@324
   239
function long_lines_check() {
deba@324
   240
    if cat $1 | grep -q -E '.{81,}'
alpar@208
   241
    then
deba@324
   242
	"$ACTION"_warning $1 'long lines'
alpar@208
   243
    fi
alpar@208
   244
}
alpar@208
   245
deba@324
   246
# process the file
deba@324
   247
deba@324
   248
function process_file() {
kpeter@341
   249
    if [ "$ACTION" == 'update' ]
kpeter@341
   250
    then
kpeter@341
   251
        echo -n "    $ACTION $1..."
kpeter@341
   252
    else
kpeter@341
   253
        echo "	  $ACTION $1..."
kpeter@341
   254
    fi
deba@324
   255
deba@324
   256
    CHECKING="header tabs spaces long_lines"
deba@324
   257
deba@324
   258
    "$ACTION"_begin $1
deba@324
   259
    for check in $CHECKING
alpar@38
   260
    do
deba@324
   261
	"$check"_check $1
alpar@38
   262
    done
deba@324
   263
    "$ACTION"_end $1
kpeter@341
   264
    if [ "$ACTION" == 'update' ]
kpeter@341
   265
    then
kpeter@341
   266
        echo
kpeter@341
   267
    fi
deba@324
   268
}
deba@324
   269
deba@324
   270
function process_all {
deba@324
   271
    "$ACTION"_init
deba@324
   272
    while read file
alpar@38
   273
    do
deba@324
   274
	process_file $file
deba@324
   275
    done < <($FILES)
deba@324
   276
    "$ACTION"_done
deba@324
   277
}
deba@324
   278
deba@324
   279
while [ $# -gt 0 ]
deba@324
   280
do
deba@324
   281
    
deba@324
   282
    if [ "$1" == '--help' ] || [ "$1" == '-h' ]
deba@324
   283
    then
deba@324
   284
	echo -n \
deba@324
   285
"Usage:
deba@324
   286
  $0 [OPTIONS] [files]
deba@324
   287
Options:
deba@324
   288
  --dry-run|-n
alpar@325
   289
     Check the files, but do not modify them.
deba@324
   290
  --interactive|-i
alpar@325
   291
     If --dry-run is specified and the checker emits warnings,
alpar@325
   292
     then the user is asked if the warnings should be considered
alpar@325
   293
     errors.
deba@324
   294
  --werror|-w
alpar@325
   295
     Make all warnings into errors.
deba@324
   296
  --all|-a
kpeter@328
   297
     Check all source files in the repository.
deba@324
   298
  --modified|-m
alpar@325
   299
     Check only the modified (and new) source files. This option is
alpar@325
   300
     useful to check the modification before making a commit.
deba@324
   301
  --changed|-c
deba@324
   302
     Check only the changed source files compared to the parent(s) of
alpar@325
   303
     the current hg node.  This option is useful as hg hook script.
alpar@325
   304
     To automatically check all your changes before making a commit,
alpar@325
   305
     add the following section to the appropriate .hg/hgrc file.
deba@324
   306
deba@324
   307
       [hooks]
deba@324
   308
       pretxncommit.checksources = scripts/unify-sources.sh -c -n -i
deba@324
   309
deba@324
   310
  --help|-h
deba@324
   311
     Print this help message.
deba@324
   312
  files
kpeter@328
   313
     The files to check/unify. If no file names are given, the modified
kpeter@328
   314
     source files will be checked/unified (just like using the
kpeter@328
   315
     --modified|-m option).
deba@324
   316
"
deba@324
   317
        exit 0
deba@324
   318
    elif [ "$1" == '--dry-run' ] || [ "$1" == '-n' ]
deba@324
   319
    then
kpeter@328
   320
	[ -n "$ACTION" ] && echo "Conflicting action options" >&2 && exit 1
deba@324
   321
	ACTION=check
deba@324
   322
    elif [ "$1" == "--all" ] || [ "$1" == '-a' ]
deba@324
   323
    then
kpeter@328
   324
	[ -n "$FILES" ] && echo "Conflicting target options" >&2 && exit 1
deba@324
   325
	FILES=all_files
deba@324
   326
    elif [ "$1" == "--changed" ] || [ "$1" == '-c' ]
deba@324
   327
    then
kpeter@328
   328
	[ -n "$FILES" ] && echo "Conflicting target options" >&2 && exit 1
deba@324
   329
	FILES=changed_files
deba@324
   330
    elif [ "$1" == "--modified" ] || [ "$1" == '-m' ]
deba@324
   331
    then
kpeter@328
   332
	[ -n "$FILES" ] && echo "Conflicting target options" >&2 && exit 1
deba@324
   333
	FILES=modified_files
deba@324
   334
    elif [ "$1" == "--interactive" ] || [ "$1" == "-i" ]
deba@324
   335
    then
kpeter@328
   336
	[ -n "$WARNING" ] && echo "Conflicting warning options" >&2 && exit 1
deba@324
   337
	WARNING='INTERACTIVE'
deba@324
   338
    elif [ "$1" == "--werror" ] || [ "$1" == "-w" ]
deba@324
   339
    then
kpeter@328
   340
	[ -n "$WARNING" ] && echo "Conflicting warning options" >&2 && exit 1
deba@324
   341
	WARNING='WERROR'
kpeter@328
   342
    elif [ $(echo x$1 | cut -c 2) == '-' ]
deba@324
   343
    then
deba@324
   344
	echo "Invalid option $1" >&2 && exit 1
deba@324
   345
    else
deba@324
   346
	[ -n "$FILES" ] && echo "Invalid option $1" >&2 && exit 1
deba@324
   347
	GIVEN_FILES=$@
deba@324
   348
	FILES=given_files
deba@324
   349
	break
deba@324
   350
    fi
deba@324
   351
    
deba@324
   352
    shift
deba@324
   353
done
deba@324
   354
deba@324
   355
if [ -z $FILES ]
deba@324
   356
then
deba@324
   357
    FILES=modified_files
alpar@38
   358
fi
deba@324
   359
deba@324
   360
if [ -z $ACTION ]
deba@324
   361
then
deba@324
   362
    ACTION=update
alpar@208
   363
fi
deba@324
   364
deba@324
   365
process_all