Subversion Repositories DevTools

Rev

Rev 229 | Rev 247 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
227 dpurdie 1
#! perl
2
########################################################################
3
# Copyright ( C ) 2004 ERG Limited, All rights reserved
4
#
5
# Module name   : jats.sh
6
# Module type   : Makefile system
7
# Compiler(s)   : n/a
8
# Environment(s): jats
9
#
10
# Description   : Provide varions functions used by the BuildVersion
11
#                 directive.
12
#
13
#                 Use only within buildlib.pl as this package assumes
14
#                 a great deal about its environment.
15
#
16
# Usage:
17
#
18
# Version   Who      Date        Description
19
#
20
#......................................................................#
21
 
22
require 5.6.1;
23
use strict;
24
use warnings;
25
 
26
our $Clobber;
27
our $CurrentYear;
28
our $CurrentTime;
29
our $Srcdir;
30
our $BuildVersion;
31
our $BUILDNAME;
32
our $BUILDNAME_PACKAGE;
33
our $BUILDNAME_VERSION;
34
our $BUILDNAME_PROJECT;
35
 
36
package BuildVersion;
37
use JatsError;
38
use JatsSystem;
39
use JatsVersionUtils;
40
 
41
our (@ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS, $VERSION);
42
use Exporter;
43
 
44
$VERSION = 1.00;
45
@ISA = qw(Exporter);
46
 
47
# Symbols to autoexport (:DEFAULT tag)
48
@EXPORT = qw( BuildVersionC
49
              BuildVersionCdefs
50
              BuildVersionCSharp
51
              BuildVersionWinRC
229 dpurdie 52
              BuildVersionProperties
227 dpurdie 53
            );
54
 
55
#-------------------------------------------------------------------------------
56
# Function        : BuildVersionCSharp
57
#
58
# Description     : Generate a C# versionn information file to allow
59
#                   insertion of data into an assembly
60
#
61
# Inputs          : $FileName           - Output filename (Optional)
62
#
63
# Returns         :
64
#
65
sub BuildVersionCSharp
66
{
67
    my ( $fname ) = @_;
68
    $fname = 'AssemblyVersionInfo.cs' unless $fname;
69
 
70
    if ( $Clobber )                             # clobber mode ?
71
    {
72
        System( "$::GBE_BIN/rm -f $Srcdir/$fname" );
73
        return;
74
    }
75
 
76
    #
77
    #   Determine the build version
78
    #
79
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
80
    my $vstring = "$major.$minor.$patch.$build";
81
 
82
 
83
    my $fh = ConfigurationFile::New( "$Srcdir/$fname", '--Type=CSharp' );
84
    $fh->HeaderSimple( "buildlib (Version $BuildVersion)",
85
                       "CSharp Assembly Version Definition" );
86
 
87
    $fh->Write( "\n" );
88
    $fh->Write( "using System.Reflection;\n" );
89
    $fh->Write( "using System.Runtime.CompilerServices;\n" );
90
    $fh->Write( "\n" );
91
    $fh->Write( "[assembly: AssemblyCompany(\"ERG Group\")]\n" );
92
    $fh->Write( "[assembly: AssemblyProduct(\"$BUILDNAME_PACKAGE\")]\n" );
93
    $fh->Write( "[assembly: AssemblyCopyright(\"ERG Group $CurrentYear\")]\n" );
94
    $fh->Write( "[assembly: AssemblyTrademark(\"\")]\n" );
95
    $fh->Write( "\n");
96
    $fh->Comment( "\n");
97
    $fh->Comment( "Version information for an assembly consists of the following four values:\n");
98
    $fh->Comment( "\n");
99
    $fh->Comment( "     Major Version   -ERG:Major\n");
100
    $fh->Comment( "     Minor Version  - ERG:Minor\n");
101
    $fh->Comment( "     Build Number   - ERG:Patch\n");
102
    $fh->Comment( "     Revision       - ERG:Build Number\n");
103
    $fh->Comment( "\n");
104
    $fh->Write( "\n");
105
    $fh->Write( "[assembly: AssemblyVersion(\"$vstring\")]\n" );
106
    $fh->Write( "\n");
107
 
108
    $fh->Close();
109
}
110
 
111
#-------------------------------------------------------------------------------
112
# Function        : BuildVersionWinRC
113
#
114
# Description     : Create a Windows RC file to describe the build version
115
#                   This file may be used directly
116
#
117
# Inputs          : $FileName           - Output filename (Optional)
235 dpurdie 118
#                   $icon               - Name of icon (optional )
227 dpurdie 119
#
120
# Returns         :
121
#
122
sub BuildVersionWinRC
123
{
235 dpurdie 124
    my ( $fname, $icon ) = @_;
227 dpurdie 125
    $fname = 'version.rc' unless $fname;
126
 
127
    if ( $Clobber )                             # clobber mode ?
128
    {
129
        System( "$::GBE_BIN/rm -f $Srcdir/$fname" );
130
        return;
131
    }
132
 
235 dpurdie 133
    Message ("Creating Windows Resource File: $fname" );    
227 dpurdie 134
    #
135
    #   Determine the build version
136
    #
137
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
138
    my $product_version = "$major, $minor, $patch, $build";
139
 
140
 
141
    #
142
    #   Create the file
143
    #
144
    my $fh = ConfigurationFile::New( "$Srcdir/$fname", '--Type=C++' );
145
    $fh->HeaderSimple( "buildlib (Version $BuildVersion)",
146
                       "Windows Resource Version Definition" );
147
 
148
    sub prc
149
    {
150
        return "@_\n";
151
    }
152
 
153
    sub pdefs
154
    {
155
        my ($arg, $val) = @_;
156
        return "#define $arg \"$val\\0\"\n";
157
    }
158
 
159
    sub pdef
160
    {
161
        my ($arg, $val) = @_;
162
        return "#define $arg $val\n";
163
    }
164
 
165
    $fh->Write(prc     (""));
166
#    $fh->Write(prc     ("#include \"afxres.h\""));
167
#    $fh->Write(prc     (""));
168
    $fh->Write(prc     (""));
169
    $fh->Write(pdefs   ("RC_STR_EMPTY"         , "" ));
170
    $fh->Write(pdefs   ("RC_STR_COMPANY"       , "ERG Group" ));
171
    $fh->Write(pdefs   ("RC_STR_PRODUCTNAME"   , "ERG Group test" ));
172
    $fh->Write(pdefs   ("RC_STR_COMMENT"       , "Build Date: $CurrentTime" ));
173
    $fh->Write(pdefs   ("RC_STR_DESCRIPTION"   , "From: $BUILDNAME_PACKAGE" ));
174
    $fh->Write(pdefs   ("RC_STR_NAME"          , $BUILDNAME_PACKAGE ));
175
    $fh->Write(pdefs   ("RC_STR_VERSION"       , $product_version ));
176
    $fh->Write(pdef    ("RC_NUM_VERSION"       , $product_version ));
177
    $fh->Write(pdefs   ("RC_STR_COPYRIGHT"     , "Copyright ERG Group $CurrentYear" ));
178
    $fh->Write(prc     ('#ifdef _DEBUG'));
179
    $fh->Write(pdefs   ("RC_STR_SPECIAL"       , "Debug Version" ));
180
    $fh->Write(prc     ('#else'));
181
    $fh->Write(pdefs   ("RC_STR_SPECIAL"       , "Production Version" ));
182
    $fh->Write(prc     ('#endif'));
183
    $fh->Write(prc     (""));
184
 
185
    $fh->Write(prc     (''));
186
    $fh->Write(prc     ('VS_VERSION_INFO VERSIONINFO'));
187
    $fh->Write(prc     (' FILEVERSION      RC_NUM_VERSION'));
188
    $fh->Write(prc     (' PRODUCTVERSION   RC_NUM_VERSION'));
189
    $fh->Write(prc     (' FILEFLAGSMASK 0x3fL'));
190
    $fh->Write(prc     ('#ifdef _DEBUG'));
191
    $fh->Write(prc     (' FILEFLAGS 0x1L'));
192
    $fh->Write(prc     ('#else'));
193
    $fh->Write(prc     (' FILEFLAGS 0x0L'));
194
    $fh->Write(prc     ('#endif'));
195
    $fh->Write(prc     (' FILEOS 0x40004L'));
196
    $fh->Write(prc     (' FILETYPE 0x1L'));
197
    $fh->Write(prc     (' FILESUBTYPE 0x0L'));
198
    $fh->Write(prc     ('BEGIN'));
199
    $fh->Write(prc     ('    BLOCK "StringFileInfo"'));
200
    $fh->Write(prc     ('    BEGIN'));
201
    $fh->Write(prc     ('        BLOCK "0c0904b0"'));
202
    $fh->Write(prc     ('        BEGIN'));
203
    $fh->Write(prc     ('            VALUE "Comments",         RC_STR_COMMENT'));
204
    $fh->Write(prc     ('            VALUE "CompanyName",      RC_STR_COMPANY'));
205
    $fh->Write(prc     ('            VALUE "FileDescription",  RC_STR_DESCRIPTION'));
206
    $fh->Write(prc     ('            VALUE "FileVersion",      RC_STR_VERSION'));
207
    $fh->Write(prc     ('            VALUE "InternalName",     RC_STR_NAME'));
208
    $fh->Write(prc     ('            VALUE "LegalCopyright",   RC_STR_COPYRIGHT'));
209
    $fh->Write(prc     ('            VALUE "LegalTrademarks",  RC_STR_EMPTY'));
210
    $fh->Write(prc     ('            VALUE "OriginalFilename", RC_STR_NAME'));
211
    $fh->Write(prc     ('            VALUE "PrivateBuild",     RC_STR_EMPTY'));
212
    $fh->Write(prc     ('            VALUE "ProductName",      RC_STR_PRODUCTNAME'));
213
    $fh->Write(prc     ('            VALUE "ProductVersion",   RC_STR_VERSION'));
214
    $fh->Write(prc     ('            VALUE "SpecialBuild",     RC_STR_SPECIAL'));
215
    $fh->Write(prc     ('        END'));
216
    $fh->Write(prc     ('    END'));
217
    $fh->Write(prc     ('        BLOCK "VarFileInfo"'));
218
    $fh->Write(prc     ('        BEGIN'));
219
    $fh->Write(prc     ('            VALUE "Translation", 0xc09, 1200'));
220
    $fh->Write(prc     ('        END'));
221
    $fh->Write(prc     ('END'));
222
    $fh->Write(prc     (''));
223
 
235 dpurdie 224
    if ( $icon )
225
    {
226
    $fh->Write(prc     (''));
227
    $fh->Write(prc     ('/////////////////////////////////////////////////////////////////////////////'));
228
    $fh->Write(prc     ('//'));
229
    $fh->Write(prc     ('// Icon'));
230
    $fh->Write(prc     ('//'));
231
    $fh->Write(prc     ('// Icon with lowest ID value placed first to ensure application icon'));
232
    $fh->Write(prc     ('// remains consistent on all systems.'));
233
    $fh->Write(prc     ("101       ICON    DISCARDABLE     \"$icon\""));
234
    $fh->Write(prc     (''));
235
    }
236
 
237
 
227 dpurdie 238
    $fh->Close();
239
}
240
 
241
#-------------------------------------------------------------------------------
242
# Function        : BuildVersionC
243
#
244
# Description     : Create a "C" style version.c and version.h file
245
#
246
# Inputs          : $Prefix         - Text to prefix generated variables with
247
#                                     Used to avoid namespace conflicts
248
#                   $Type           - Type of version to create
249
#                                     Only allowed value is 'array'
250
#
251
# Returns         :
252
#
253
 
254
sub BuildVersionC
255
{
256
    my( $Prefix, $Type ) = @_;
257
    my $ver;
258
 
259
    if ( $Clobber )                             # clobber mode ?
260
    {
261
        #
262
        #   Clobber common version.c and version.h
263
        #
264
        System( "$::GBE_BIN/rm -f $Srcdir/version.c $Srcdir/version.h" );
265
        return;
266
    }
267
 
268
    #
269
    #   Default prefix is none
270
    #   Set to a defined, bet empty, string
271
    #
272
    $Prefix = "" if ( ! defined( $Prefix ) );
273
    $Type   = "" if ( ! defined( $Type ) );
274
 
275
    #   src/version.c
276
    #..
277
    open( VERSIONC, ">$Srcdir/version.c" ) ||
278
        Error( "cannot create $Srcdir/version.c" );
279
 
280
    print VERSIONC
281
        "/* Please do not edit this file.\n" .
282
        " * It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
283
        " */\n" .
284
        "#include \"version.h\"\n";
285
 
286
    print VERSIONC
287
        "\n" .
288
        "static char what[] = \"@(#) $BUILDNAME $::CurrentDate ERG\";\n" .
289
        "\n";
290
 
291
 
292
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
293
    if ( $Type eq "array" )
294
    {                                           # new style
295
        print VERSIONC
296
           "static const char *pkgarray[] = \n" .
297
           "{\n";
298
 
299
        foreach $ver ( @PACKAGEVERS   ) {
300
            print VERSIONC "    \"$ver\",\n";
301
        }
302
 
303
        print VERSIONC
304
           "    0\n",
305
           "};\n\n";
306
 
307
        print VERSIONC
308
           "\nconst char *\n$Prefix"."VersionString(void)\n" .
309
           "{\n".
310
           "    return \"$BUILDNAME\";\n" .
311
           "}\n" .
312
           "\nconst char **\n$Prefix"."PkgStrings(void)\n" .
313
           "{\n".
314
           "    return pkgarray;\n" .
315
           "}\n" .
316
           "\nconst char *\n$Prefix"."GetModuleInfo(void)\n" .
317
           "{\n" .
318
           "    return \"$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\";\n" .
319
           "}\n";
320
    }
321
    else
322
    {                                           # old style
323
        print VERSIONC
324
           "\nconst char *\n$Prefix"."VersionString(void)\n" .
325
           "{\n".
326
           "    return \"$BUILDNAME @PACKAGEVERS\";\n" .
327
           "}\n" .
328
           "\nconst char *\n$Prefix"."GetModuleInfo(void)\n" .
329
           "{\n" .
330
           "    return \"$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\";\n" .
331
           "}\n";
332
    }
333
    close VERSIONC;
334
 
335
#   src/version.h
336
#..
337
    open( VERSIONH, ">$Srcdir/version.h" ) ||
338
        Error( "cannot create $Srcdir/version.h" );
339
 
340
    print VERSIONH
341
        "#ifndef VERSION_H_INCLUDED\n" .
342
        "#define VERSION_H_INCLUDED\n" .
343
        "/* Please do not edit this file.\n" .
344
        " * It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
345
        " */\n\n" .
346
        "#define BUILDNAME     \"$BUILDNAME\"\n" .
347
        "#define BUILDDATE     \"$::CurrentTime\"\n" .
348
        "\n";
349
 
350
    print VERSIONH
351
        "#ifdef __cplusplus\n" .
352
        "    extern \"C\" {           /* force C calling convention when using C++ */\n" .
353
        "#endif\n" .
354
        "\n";
355
 
356
    if ( $Type eq "array" )
357
    {                                           # extended interface
358
        print VERSIONH
359
        "extern const char **  $Prefix"."PkgStrings(void);\n";
360
    }
361
    print VERSIONH
362
        "extern const char *   $Prefix"."VersionString(void);\n".
363
        "extern const char *   $Prefix"."GetModuleInfo(void);\n";
364
 
365
    print VERSIONH
366
        "\n" .
367
        "#ifdef __cplusplus\n" .
368
        "    } /* extern \"C\" */\n" .
369
        "#endif\n" .
370
        "\n";
371
 
372
    print VERSIONH
373
        "\n#endif /*VERSION_H_INCLUDED*/\n";
374
    close VERSIONH;
375
}
376
 
377
#-------------------------------------------------------------------------------
378
# Function        : BuildVersionCdefs
379
#
380
# Description     : Generate a "C" style version definitions file
381
#                   This file simply contains definitions
382
#
383
# Inputs          : $Mode           - File suffix
384
#                   $ModePrefix     - Tag for all generated definitions
385
#
386
# Returns         :
387
#
388
 
389
sub BuildVersionCdefs
390
{
391
    my ( $Mode, $ModePrefix ) = @_;
392
    my $fname = "version_$Mode.h";
393
 
394
    if ( $Clobber )                             # clobber mode ?
395
    {
396
        System( "$::GBE_BIN/rm -f $Srcdir/$fname" );
397
        return;
398
    }
399
 
400
    #
401
    #   Generate version_defs.h
402
    #   This file contains ONLY definitions. It may be used by assembler
403
    #   programs (that support a preprocessor) to access version information
404
    #
405
    #   Allow for a user supplied filename fragment that will be used within
406
    #   all the definitions with in the file.
407
    #
408
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
409
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
410
 
411
    #
412
    #   Base names on a user supplied value or a default
413
    #
414
    my $vtag = uc( "VERSION$ModePrefix" );
415
    my $guard_name = uc($fname);
416
       $guard_name =~ s~\.~_~g;
417
 
418
    open( VERSIOND, ">$Srcdir/$fname" ) ||
419
        Error( "cannot create $Srcdir/$fname" );
420
 
421
    print VERSIOND
422
        "#ifndef $guard_name\n" .
423
        "#define $guard_name\n" .
424
        "/* Please do not edit this file.\n" .
425
        " * It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
426
        " */\n\n" .
427
        "\n".
428
        "#define ${vtag}_BUILDNAME      \"$BUILDNAME\"\n".
429
        "#define ${vtag}_BUILDDATE      \"$::CurrentTime\"\n".
430
        "\n".
431
        "#define ${vtag}_PACKAGE        \"$BUILDNAME_PACKAGE\"\n".
432
        "#define ${vtag}_VERSION        \"$BUILDNAME_VERSION\"\n".
433
        "#define ${vtag}_MAJOR_STR      \"$major\"\n".
434
        "#define ${vtag}_MINOR_STR      \"$minor\"\n".
435
        "#define ${vtag}_PATCH_STR      \"$patch\"\n".
436
        "#define ${vtag}_BUILD_STR      \"$build\"\n".
437
        "#define ${vtag}_PATCHBUILD_STR \"$raw_patch\"\n".
438
        "#define ${vtag}_PROJECT        \"$BUILDNAME_PROJECT\"\n".
439
        "#define ${vtag}_MAJOR          " . strip_zeros($major) . "\n".
440
        "#define ${vtag}_MINOR          " . strip_zeros($minor) . "\n".
441
        "#define ${vtag}_PATCH          " . strip_zeros($patch) . "\n".
442
        "#define ${vtag}_BUILD          " . strip_zeros($build) . "\n".
443
        "#define ${vtag}_PATCHBUILD     " . strip_zeros($raw_patch) . "\n".
444
        "#define ${vtag}_ALL            \"$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\"\n".
445
        "#define ${vtag}_BUILDTIME      " . strip_zeros(time()) . "\n".
446
        "\n".
447
        "#endif /* $guard_name */\n";
448
 
449
    close VERSIOND;
450
}
451
 
452
#-------------------------------------------------------------------------------
229 dpurdie 453
# Function        : BuildVersionProperties
454
#
455
# Description     : Generate a "Java" style version definitions file
456
#                   This is a simple properties file
457
#
458
# Inputs          : $FileName       - Output filename (Optional)
459
#                   $Prefix         - Tag for all generated definitions
460
#
461
# Returns         :
462
#
463
sub BuildVersionProperties
464
{
465
    my ( $fname, $Prefix ) = @_;
466
 
467
    #
468
    #   Default name of the file
469
    #
470
    $fname = 'version.properties' unless $fname;
471
    if ( $Clobber )                             # clobber mode ?
472
    {
473
        System( "$::GBE_BIN/rm -f $Srcdir/$fname" );
474
        return;
475
    }
476
 
477
    #
478
    #   Generate version properties file
479
    #
480
    #   This file contains ONLY definitions. It may be included by the ANT
481
    #   builds. Its not intended to be imported by the java code
482
 
483
 
484
    #
485
    #   Allow for a user supplied property prefix
486
    #   Not really needed as
487
    #
488
    my $vtag = '';
489
    $vtag = $Prefix . '.' if $Prefix;
490
 
491
 
492
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
493
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
494
 
495
    #
496
    #   Create properties in the same form as for "C" definitions
497
    #   Note:
498
    #       The 'ALL' is in a format used by other software. Do not change
499
    #
500
    open( VERSIOND, ">$Srcdir/$fname" ) ||
501
        Error( "cannot create $Srcdir/$fname" );
502
 
503
    print VERSIOND
504
        "# Please do not edit this file.\n" .
505
        "# It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
506
        "#\n" .
507
        "${vtag}BUILDNAME      = $BUILDNAME\n".
508
        "${vtag}BUILDDATE      = $::CurrentTime\n".
509
        "\n".
510
        "${vtag}PACKAGE        = $BUILDNAME_PACKAGE\n".
511
        "${vtag}VERSION        = $BUILDNAME_VERSION\n".
512
        "${vtag}MAJOR_STR      = $major\n".
513
        "${vtag}MINOR_STR      = $minor\n".
514
        "${vtag}PATCH_STR      = $patch\n".
515
        "${vtag}BUILD_STR      = $build\n".
516
        "${vtag}PATCHBUILD_STR = $raw_patch\n".
517
        "${vtag}PROJECT        = $BUILDNAME_PROJECT\n".
518
        "${vtag}MAJOR          = " . strip_zeros($major) . "\n".
519
        "${vtag}MINOR          = " . strip_zeros($minor) . "\n".
520
        "${vtag}PATCH          = " . strip_zeros($patch) . "\n".
521
        "${vtag}BUILD          = " . strip_zeros($build) . "\n".
522
        "${vtag}PATCHBUILD     = " . strip_zeros($raw_patch) . "\n".
523
        "${vtag}ALL            = $BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\n".
524
        "${vtag}BUILDTIME      = " . strip_zeros(time()) . "\n".
525
        "\n";
526
    #
527
    #   Create a set of definitions for each dependent package
528
    #
529
    print VERSIOND "# Dependent Packages and Versions\n".
530
                   "#\n";
531
 
532
    foreach my $tag ( PackageEntry::GetPackageList() )
533
    {
534
        my ($name, $version, $type) = PackageEntry::GetPackageData($tag);
535
#        push @attributes, "build=\"true\"" if $type =~ /Build/i;
536
        print VERSIOND "${vtag}PACKAGE.$name=$version\n";
537
    }
538
    close VERSIOND;
539
}
540
 
541
#-------------------------------------------------------------------------------
227 dpurdie 542
# Function        : stip_zeros
543
#
544
# Description     : Remove leading 0's from a string
545
#
546
# Inputs          : A string
547
#
548
# Returns         : A string without leading zeros
549
#
550
sub strip_zeros
551
{
552
    my ($text) = @_;
553
 
554
    $text =~ s~^0*~~;
555
    $text = '0' unless ( $text );
556
    return $text;
557
}
558
 
559
1;