File: sh.version

package info (click to toggle)
shtool 2.0.8-9
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 808 kB
  • ctags: 12
  • sloc: perl: 399; makefile: 110; sh: 42
file content (424 lines) | stat: -rw-r--r-- 13,845 bytes parent folder | download | duplicates (3)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
##
##  version -- Maintain a version information file
##  Copyright (c) 1994-2008 Ralf S. Engelschall <rse@engelschall.com>
##
##  This file is part of shtool and free software; you can redistribute
##  it and/or modify it under the terms of the GNU General Public
##  License as published by the Free Software Foundation; either version
##  2 of the License, or (at your option) any later version.
##
##  This file is distributed in the hope that it will be useful,
##  but WITHOUT ANY WARRANTY; without even the implied warranty of
##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
##  General Public License for more details.
##
##  You should have received a copy of the GNU General Public License
##  along with this program; if not, write to the Free Software
##  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
##  USA, or contact Ralf S. Engelschall <rse@engelschall.com>.
##

str_tool="version"
str_usage="[-l|--language <lang>] [-n|--name <name>] [-p|--prefix <prefix>] [-s|--set <version>] [-e|--edit] [-i|--increase <knob>] [-d|--display <type>] <file>"
arg_spec="1="
opt_spec="l:n:p:s:i:e.d:"
opt_alias="l:language,n:name,p:prefix,s:set,e:edit,i:increase,d:display"
opt_l="txt"
opt_n="unknown"
opt_p=""
opt_s=""
opt_e="no"
opt_i=""
opt_d="short"

. ./sh.common

file="$1"

#   determine prefix and name
name="$opt_n"
prefix="$opt_p"

#   determine current version
triple="$opt_s"
if [ ".$triple" != . ]; then
    #   use given triple
    if [ ".`echo $triple | grep '[0-9]*.[0-9]*[sabp.][0-9]*'`" = . ]; then
        echo "$msgprefix:Error: invalid argument to option \`-s': \`$opt_s'" 1>&2
        shtool_exit 1
    fi
    eval `echo $triple |\
          sed -e 's%\([0-9]*\)\.\([0-9]*\)\([sabp.]\)\([0-9]*\).*%\
          ver="\1";rev="\2";typ="\3";lev="\4"%'`
    tim=calc
elif [ -r $file ]; then
    #   determine triple from given file
    eval `grep 'Version [0-9]*.[0-9]*[sabp.][0-9]* ([0-9]*-[a-zA-Z]*-[0-9]*)' $file |\
          sed -e 's%.*Version \([0-9]*\)\.\([0-9]*\)\([sabp.]\)\([0-9]*\) (\([0-9]*-[a-zA-Z]*-[0-9]*\)).*%\
          ver="\1";rev="\2";typ="\3";lev="\4";tim="\5"%' -e 'q'`
else
    #   intialise to first version
    ver=0
    rev=1
    typ=.
    lev=0
    tim=calc
fi

#   determine new version in batch
if [ ".$opt_i" != . ]; then
    case $opt_i in
        v ) ver=`expr $ver + 1`
            rev=0
            lev=0
            ;;
        r ) rev=`expr $rev + 1`
            lev=0
            ;;
        l ) lev=`expr $lev + 1`
            ;;
        * ) echo "$msgprefix:Error: invalid argument to option \`-i': \`$opt_i'" 1>&2
            shtool_exit 1
            ;;
    esac
    tim=calc
fi

#   determine new version interactively
if [ ".$opt_e" = .yes ]; then
    echo "old version: ${ver}.${rev}${typ}${lev}"
    while [ 1 ]; do
        echo dummy | awk '{ printf("new version: "); }'
        read triple
        case $triple in
            [0-9]*.[0-9]*[sabp.][0-9]* )
                ;;
            * ) echo "$msgprefix:Error: invalid version string entered: \`$triple'" 1>&2
                continue
                ;;
        esac
        break
    done
    eval `echo $triple |\
          sed -e 's%^\([0-9]*\)\.\([0-9]*\)\([sabp.]\)\([0-9]*\)$%\
          ver="\1";rev="\2";typ="\3";lev="\4"%'`
    tim=calc
fi

#   determine hexadecimal and libtool value of version
case $typ in
    a     ) typnum=0;  levnum=$lev ;;
    b     ) typnum=1;  levnum=$lev ;;
    p | . ) typnum=2;  levnum=$lev ;;
    s     ) typnum=15; levnum=255  ;; # snapshots are special
esac
hex=`echo "$ver:$rev:$typnum:$levnum" |\
     awk -F: '{ printf("0x%x%02x%1x%02x", $1, $2, $3, $4); }' |\
     tr 'abcdef' 'ABCDEF'`
ltv=`echo "$ver:$rev:$typnum:$levnum" |\
     awk -F: '{ printf("%d:%d", $1*10 + $2, $3*10 + $4); }'`

#   determine date
if [ ".$tim" = .calc ]; then
    day=`date '+%d'`
    month=`date '+%m'`
    year=`date '+%Y' 2>/dev/null`
    if [ ".$time_year" = . ]; then
        year=`date '+%y'`
        case $year in
            [5-9][0-9]) year="19$year" ;;
            [0-4][0-9]) year="20$year" ;;
        esac
    fi
    case $month in
        1|01) month='Jan' ;;
        2|02) month='Feb' ;;
        3|03) month='Mar' ;;
        4|04) month='Apr' ;;
        5|05) month='May' ;;
        6|06) month='Jun' ;;
        7|07) month='Jul' ;;
        8|08) month='Aug' ;;
        9|09) month='Sep' ;;
          10) month='Oct' ;;
          11) month='Nov' ;;
          12) month='Dec' ;;
    esac
    tim="${day}-${month}-${year}"
fi

#   perform result actions
mode=show
if [ ".$opt_i" != . ]; then
    mode=edit
elif [ ".$opt_e" = .yes ]; then
    mode=edit
elif [ ".$opt_s" != . ]; then
    mode=edit
fi
if [ ".$mode" = .show ]; then
    #   just display the current version
    case $opt_d in
        short )
            echo "${ver}.${rev}${typ}${lev}"
            ;;
        long )
            echo "${ver}.${rev}${typ}${lev} ($tim)"
            ;;
        libtool )
            echo "${ltv}"
            ;;
        hex )
            echo "${hex}"
            ;;
        * ) echo "$msgprefix:Error: invalid argument to option \`-d': \`$opt_d'" 1>&2
            shtool_exit 1
            ;;
    esac
else
    #   update the version file

    #   pre-generate various strings
    triple="${ver}.${rev}${typ}${lev}"
    vHex="$hex"
    vShort="${triple}"
    vLong="${triple} (${tim})"
    vTeX="This is ${name}, Version ${triple} (${tim})"
    vGNU="${name} ${triple} (${tim})"
    vWeb="${name}/${triple}"
    vSCCS="@(#)${name} ${triple} (${tim})"
    vRCS="\$Id: ${name} ${triple} (${tim}) \$"

    #   determine string out of filename
    #   (do NOT try to optimize this in any way because of portability)
    filestr=`util_upper "$file" | tr './%+' '____' | sed -e 's/-/_/g'`

    #   generate uppercase prefix
    prefixupper=`util_upper "$prefix"`

    #   create the version file according the the selected language
    echo "new version: ${vLong}"

    cp /dev/null $file
    case $opt_l in
        txt )
            echo >>$file ""
            echo >>$file "  ${file} -- Version Information for ${name} (syntax: Text)"
            echo >>$file "  [automatically generated and maintained by GNU shtool]"
            echo >>$file ""
            echo >>$file "  $vTeX"
            echo >>$file ""
            ;;
        c )
            echo >>$file "/*"
            echo >>$file "**  ${file} -- Version Information for ${name} (syntax: C/C++)"
            echo >>$file "**  [automatically generated and maintained by GNU shtool]"
            echo >>$file "*/"
            echo >>$file ""
            echo >>$file "#ifdef _${filestr}_AS_HEADER_"
            echo >>$file ""
            echo >>$file "#ifndef _${filestr}_"
            echo >>$file "#define _${filestr}_"
            echo >>$file ""
            echo >>$file "#define ${prefixupper}VERSION ${vHex}"
            echo >>$file ""
            echo >>$file "typedef struct {"
            echo >>$file "    const int   v_hex;"
            echo >>$file "    const char *v_short;"
            echo >>$file "    const char *v_long;"
            echo >>$file "    const char *v_tex;"
            echo >>$file "    const char *v_gnu;"
            echo >>$file "    const char *v_web;"
            echo >>$file "    const char *v_sccs;"
            echo >>$file "    const char *v_rcs;"
            echo >>$file "} ${prefix}version_t;"
            echo >>$file ""
            echo >>$file "extern ${prefix}version_t ${prefix}version;"
            echo >>$file ""
            echo >>$file "#endif /* _${filestr}_ */"
            echo >>$file ""
            echo >>$file "#else /* _${filestr}_AS_HEADER_ */"
            echo >>$file ""
            echo >>$file "#define _${filestr}_AS_HEADER_"
            echo >>$file "#include \"${file}\""
            echo >>$file "#undef  _${filestr}_AS_HEADER_"
            echo >>$file ""
            echo >>$file "${prefix}version_t ${prefix}version = {"
            echo >>$file "    ${vHex},"
            echo >>$file "    \"${vShort}\","
            echo >>$file "    \"${vLong}\","
            echo >>$file "    \"${vTeX}\","
            echo >>$file "    \"${vGNU}\","
            echo >>$file "    \"${vWeb}\","
            echo >>$file "    \"${vSCCS}\","
            echo >>$file "    \"${vRCS}\""
            echo >>$file "};"
            echo >>$file ""
            echo >>$file "#endif /* _${filestr}_AS_HEADER_ */"
            echo >>$file ""
            ;;
        m4 )
            echo >>$file "##"
            echo >>$file "##  ${file} -- Version Information for ${name} (syntax: M4)"
            echo >>$file "##  [automatically generated and maintained by GNU shtool]"
            echo >>$file "##"
            echo >>$file ""
            echo >>$file "m4_define([v_hex],   [${vHex}])"
            echo >>$file "m4_define([v_short], [${vShort}])"
            echo >>$file "m4_define([v_long],  [${vLong}])"
            echo >>$file "m4_define([v_tex],   [${vTeX}])"
            echo >>$file "m4_define([v_gnu],   [${vGNU}])"
            echo >>$file "m4_define([v_web],   [${vWeb}])"
            echo >>$file "m4_define([v_sccs],  [${vSCCS}])"
            echo >>$file "m4_define([v_rcs],   [${vRCS}])"
            echo >>$file ""
            ;;
        perl )
            echo >>$file "##"
            echo >>$file "##  ${file} -- Version Information for ${name} (syntax: Perl)"
            echo >>$file "##  [automatically generated and maintained by GNU shtool]"
            echo >>$file "##"
            echo >>$file ""
            echo >>$file "our \$${prefix}version = {"
            echo >>$file "    'v_hex'   => ${vHex},"
            echo >>$file "    'v_short' => \"${vShort}\","
            echo >>$file "    'v_long'  => \"${vLong}\","
            echo >>$file "    'v_tex'   => \"${vTeX}\","
            echo >>$file "    'v_gnu'   => \"${vGNU}\","
            echo >>$file "    'v_web'   => \"${vWeb}\","
            echo >>$file "    'v_sccs'  => \"${vSCCS}\","
            echo >>$file "    'v_rcs'   => \"\\${vRCS}/\""
            echo >>$file "};"
            echo >>$file ""
            echo >>$file "1;"
            echo >>$file ""
            ;;
        python )
            echo >>$file "##"
            echo >>$file "##  ${file} -- Version Information for ${name} (syntax: Python)"
            echo >>$file "##  [automatically generated and maintained by GNU shtool]"
            echo >>$file "##"
            echo >>$file ""
            echo >>$file "class ${prefix}version:"
            echo >>$file "    v_hex       = ${vHex}"
            echo >>$file "    v_short     = \"${vShort}\""
            echo >>$file "    v_long      = \"${vLong}\""
            echo >>$file "    v_tex       = \"${vTeX}\""
            echo >>$file "    v_gnu       = \"${vGNU}\""
            echo >>$file "    v_web       = \"${vWeb}\""
            echo >>$file "    v_sccs      = \"${vSCCS}\""
            echo >>$file "    v_rcs       = \"${vRCS}\""
            echo >>$file ""
            ;;
        * ) echo "$msgprefix:Error: invalid argument to option \`-l': \`$opt_l'" 1>&2
            shtool_exit 1
            ;;
    esac
fi

shtool_exit 0

##
##  manual page
##

=pod

=head1 NAME

B<shtool-version> - B<GNU shtool> maintain version information file

=head1 SYNOPSIS

B<shtool version>
[B<-l>|B<--language> I<lang>]
[B<-n>|B<--name> I<name>]
[B<-p>|B<--prefix> I<prefix>]
[B<-s>|B<--set> I<version>]
[B<-e>|B<--edit>]
[B<-i>|B<--increase> I<knob>]
[B<-d>|B<--display> I<type>]
I<file>

=head1 DESCRIPTION

This command displays and maintains version information in I<file>.

The version is always described with a triple
E<lt>I<version>,I<revision>,I<level>E<gt> and is represented
by a string which always matches the regular expression
"C<[0-9]+\.[0-9]+[sabp.][0-9]+>".

The hexadecimal format for a version C<v.rtl> is C<VVRRTLL> where C<VV>
and C<RR> directly correspond to C<v> and C<r>, C<T> encodes the level
type as C<9>, C<2>, C<1>, C<0> (representing C<s>, C<p>/C<.>, C<b>, C<a>
in this order) and C<LL> is either directly corresponding to C<l> or set
to C<99> if level type is C<s>.

=head1 OPTIONS

The following command line options are available.

=over 4

=item B<-v>, B<--verbose>

Print verbose information during processing.

=item B<-l>, B<--language> I<lang>

Choose format of version file I<file>. I<lang>="C<txt>", ANSI C
(I<lang>="c"), M4 (I<lang>="m4"), Perl (I<lang>="perl") or Python
(I<lang>="python"). Default is C<txt>.

=item B<-n>, B<--name> I<name>

Name the program the version is maintained for. Default is C<unknown>.

=item B<-p>, B<--prefix> I<prefix>
=item B<-s>, B<--set> I<version>

Set the version to I<version>.

=item B<-e>, B<--edit>

Interactively enter a new version.

=item B<-i>, B<--increase> I<knob>

When option ``B<-i>'' is used, the current version in I<file> is updated
by increasing one element of the version where I<knob> can be one of
the following: ``C<v>'' for increasing the version by 1 (and resetting
revision and level to 0), ``C<r>'' for increasing the revision by 1 (and
resetting level to 0) or ``C<l>'' for increasing the level by 1.

=item B<-d>, B<--display> I<type>

Control the display type: "C<short>" for a short version display,
"C<long>" for a longer version display, "C<hex>" for a hexadecimal
display of the version and "C<libtool>" for a format suitable for use
with GNU libtool.

=back

=head1 EXAMPLE

 #   shell script
 shtool version -l c -n FooBar -p foobar -s 1.2b3 version.c

 #   configure.in
 V=`shtool version -l c -d long version.c`
 echo "Configuring FooBar, Version $V"

=head1 HISTORY

The B<GNU shtool> B<version> command was originally written by Ralf S.
Engelschall E<lt>rse@engelschall.comE<gt> in 1994 for B<OSSP eperl>. It
was later rewritten from scratch for inclusion into B<GNU shtool>.

=head1 SEE ALSO

shtool(1).

=cut