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