Subversion Repositories DevTools

Rev

Rev 283 | Rev 315 | 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
 
255 dpurdie 22
require 5.006_001;
227 dpurdie 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;
267 dpurdie 40
use ConfigurationFile;
289 dpurdie 41
use FileUtils;
227 dpurdie 42
 
283 dpurdie 43
#
44
#   Package Interface
45
#
46
use base qw(Exporter);
47
our @EXPORT = qw( BuildVersionC
227 dpurdie 48
              BuildVersionCdefs
49
              BuildVersionCSharp
50
              BuildVersionWinRC
229 dpurdie 51
              BuildVersionProperties
289 dpurdie 52
              BuildVersionDelphi
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
 
247 dpurdie 70
    #
71
    #   Store the files location for use at runtime
72
    #   It will be a file that is 'known' to JATS
73
    #
74
    $fname = ::BuildAddKnownFile ( $Srcdir, $fname );
75
    return if ( $Clobber );      # clobber mode ?
289 dpurdie 76
    Message ("Creating C# Version File: $fname" );
227 dpurdie 77
 
78
    #
79
    #   Determine the build version
80
    #
81
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
82
    my $vstring = "$major.$minor.$patch.$build";
83
 
84
 
247 dpurdie 85
    my $fh = ConfigurationFile::New( $fname, '--Type=CSharp' );
227 dpurdie 86
    $fh->HeaderSimple( "buildlib (Version $BuildVersion)",
87
                       "CSharp Assembly Version Definition" );
88
 
89
    $fh->Write( "\n" );
90
    $fh->Write( "using System.Reflection;\n" );
91
    $fh->Write( "using System.Runtime.CompilerServices;\n" );
92
    $fh->Write( "\n" );
93
    $fh->Write( "[assembly: AssemblyCompany(\"ERG Group\")]\n" );
94
    $fh->Write( "[assembly: AssemblyProduct(\"$BUILDNAME_PACKAGE\")]\n" );
95
    $fh->Write( "[assembly: AssemblyCopyright(\"ERG Group $CurrentYear\")]\n" );
96
    $fh->Write( "[assembly: AssemblyTrademark(\"\")]\n" );
97
    $fh->Write( "\n");
98
    $fh->Comment( "\n");
99
    $fh->Comment( "Version information for an assembly consists of the following four values:\n");
100
    $fh->Comment( "\n");
101
    $fh->Comment( "     Major Version   -ERG:Major\n");
102
    $fh->Comment( "     Minor Version  - ERG:Minor\n");
103
    $fh->Comment( "     Build Number   - ERG:Patch\n");
104
    $fh->Comment( "     Revision       - ERG:Build Number\n");
105
    $fh->Comment( "\n");
106
    $fh->Write( "\n");
107
    $fh->Write( "[assembly: AssemblyVersion(\"$vstring\")]\n" );
108
    $fh->Write( "\n");
109
 
110
    $fh->Close();
111
}
112
 
113
#-------------------------------------------------------------------------------
114
# Function        : BuildVersionWinRC
115
#
116
# Description     : Create a Windows RC file to describe the build version
117
#                   This file may be used directly
118
#
119
# Inputs          : $FileName           - Output filename (Optional)
267 dpurdie 120
#                   @opts               - Options
121
#                           --Definitions
122
#                           --Icon=path
123
#                           --Comment=text
124
#                           --Description=text
125
#                           --Product=text
126
#                           --Version=text          (Internal Use)
127
#                           --PkgName=text          (Internal Use)
128
#                           --ToolUse               (Internal Use)
129
# Returns         : Nothing
227 dpurdie 130
#
131
sub BuildVersionWinRC
132
{
267 dpurdie 133
    my ( $fname, @opts ) = @_;
134
    my $icon;
135
    my $defs;
136
    my $product = '';
137
    my $version = $BUILDNAME_VERSION || '';
138
    my $pkg_name = $BUILDNAME_PACKAGE || '';
139
    my $comment = "Build Date: $CurrentTime";
140
    my $description = '';
141
    my $used_by_tool = '';
142
 
143
    #
144
    #   Process options
145
    #
146
    foreach ( @opts )
147
    {
148
        if ( m~^--Icon=(.+)~ ) {
149
            $icon = $1;
150
        } elsif ( m~^--Definitions~ ) {
151
            $defs = 1;
152
        } elsif ( m~^--Comment=(.+)~ ) {
153
            $comment = $1;
154
        } elsif ( m~^--Description=(.+)~ ) {
155
            $description = $1;
156
        } elsif ( m~^--Product=(.+)~ ) {
157
            $product = $1;
158
        } elsif ( m~^--Version=(.+)~ ) {
159
            $version = $1;
160
        } elsif ( m~^--PkgName=(.+)~ ) {
161
            $pkg_name = $1;
162
        } elsif ( m~^--ToolUse~ ) {
163
            $used_by_tool = 1;
164
        } else {
165
            Error ("WinRC Style Version. Unknown option: $_");
166
        }
167
    }
168
 
169
    #
170
    #   Setup defaults
171
    #
227 dpurdie 172
    $fname = 'version.rc' unless $fname;
267 dpurdie 173
    Error ("WinRC: No Build Version provided") unless ( $version );
174
    Error ("WinRC: No Build Package Name provided") unless ( $pkg_name );
227 dpurdie 175
 
176
    #
247 dpurdie 177
    #   Store the files location for use at runtime
178
    #   It will be a file that is 'known' to JATS
179
    #
267 dpurdie 180
    unless ( $used_by_tool  )
181
    {
182
        $fname = ::BuildAddKnownFile ( $Srcdir, $fname );
183
        return if ( $Clobber );      # clobber mode ?
184
    }
185
 
247 dpurdie 186
    Message ("Creating Windows Resource File: $fname" );
267 dpurdie 187
 
247 dpurdie 188
    #
227 dpurdie 189
    #   Determine the build version
190
    #
267 dpurdie 191
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($version);
227 dpurdie 192
    my $product_version = "$major, $minor, $patch, $build";
193
 
194
 
195
    #
196
    #   Create the file
197
    #
247 dpurdie 198
    my $fh = ConfigurationFile::New( $fname, '--Type=C++' );
227 dpurdie 199
    $fh->HeaderSimple( "buildlib (Version $BuildVersion)",
200
                       "Windows Resource Version Definition" );
201
 
202
    sub prc
203
    {
204
        return "@_\n";
205
    }
206
 
207
    sub pdefs
208
    {
209
        my ($arg, $val) = @_;
267 dpurdie 210
        Error ("Undefined value for $arg") unless ( defined $val );
227 dpurdie 211
        return "#define $arg \"$val\\0\"\n";
212
    }
213
 
214
    sub pdef
215
    {
216
        my ($arg, $val) = @_;
267 dpurdie 217
        Error ("Undefined value for $arg") unless ( defined $val );
227 dpurdie 218
        return "#define $arg $val\n";
219
    }
220
 
221
    $fh->Write(prc     (""));
222
#    $fh->Write(prc     ("#include \"afxres.h\""));
223
#    $fh->Write(prc     (""));
269 dpurdie 224
 
227 dpurdie 225
    $fh->Write(prc     (""));
226
    $fh->Write(pdefs   ("RC_STR_EMPTY"         , "" ));
227
    $fh->Write(pdefs   ("RC_STR_COMPANY"       , "ERG Group" ));
267 dpurdie 228
    $fh->Write(pdefs   ("RC_STR_PRODUCTNAME"   , $product ));
229
    $fh->Write(pdefs   ("RC_STR_COMMENT"       , $comment ));
230
    $fh->Write(pdefs   ("RC_STR_DESCRIPTION"   , $description ));
231
    $fh->Write(pdefs   ("RC_STR_NAME"          , $pkg_name ));
227 dpurdie 232
    $fh->Write(pdefs   ("RC_STR_VERSION"       , $product_version ));
233
    $fh->Write(pdef    ("RC_NUM_VERSION"       , $product_version ));
234
    $fh->Write(pdefs   ("RC_STR_COPYRIGHT"     , "Copyright ERG Group $CurrentYear" ));
235
    $fh->Write(prc     ('#ifdef _DEBUG'));
236
    $fh->Write(pdefs   ("RC_STR_SPECIAL"       , "Debug Version" ));
237
    $fh->Write(prc     ('#else'));
238
    $fh->Write(pdefs   ("RC_STR_SPECIAL"       , "Production Version" ));
239
    $fh->Write(prc     ('#endif'));
240
    $fh->Write(prc     (""));
241
 
263 dpurdie 242
    unless ( $defs )
243
    {
269 dpurdie 244
        $fh->Write(prc     ('#define VS_VERSION_INFO     1'));
263 dpurdie 245
        $fh->Write(prc     (''));
246
        $fh->Write(prc     ('VS_VERSION_INFO VERSIONINFO'));
247
        $fh->Write(prc     (' FILEVERSION      RC_NUM_VERSION'));
248
        $fh->Write(prc     (' PRODUCTVERSION   RC_NUM_VERSION'));
249
        $fh->Write(prc     (' FILEFLAGSMASK 0x3fL'));
250
        $fh->Write(prc     ('#ifdef _DEBUG'));
251
        $fh->Write(prc     (' FILEFLAGS 0x1L'));
252
        $fh->Write(prc     ('#else'));
253
        $fh->Write(prc     (' FILEFLAGS 0x0L'));
254
        $fh->Write(prc     ('#endif'));
255
        $fh->Write(prc     (' FILEOS 0x40004L'));
256
        $fh->Write(prc     (' FILETYPE 0x1L'));
257
        $fh->Write(prc     (' FILESUBTYPE 0x0L'));
258
        $fh->Write(prc     ('BEGIN'));
259
        $fh->Write(prc     ('    BLOCK "StringFileInfo"'));
260
        $fh->Write(prc     ('    BEGIN'));
261
        $fh->Write(prc     ('        BLOCK "0c0904b0"'));
262
        $fh->Write(prc     ('        BEGIN'));
263
        $fh->Write(prc     ('            VALUE "Comments",         RC_STR_COMMENT'));
264
        $fh->Write(prc     ('            VALUE "CompanyName",      RC_STR_COMPANY'));
265
        $fh->Write(prc     ('            VALUE "FileDescription",  RC_STR_DESCRIPTION'));
266
        $fh->Write(prc     ('            VALUE "FileVersion",      RC_STR_VERSION'));
267
        $fh->Write(prc     ('            VALUE "InternalName",     RC_STR_NAME'));
268
        $fh->Write(prc     ('            VALUE "LegalCopyright",   RC_STR_COPYRIGHT'));
269
        $fh->Write(prc     ('            VALUE "LegalTrademarks",  RC_STR_EMPTY'));
270
        $fh->Write(prc     ('            VALUE "OriginalFilename", RC_STR_NAME'));
271
        $fh->Write(prc     ('            VALUE "PrivateBuild",     RC_STR_EMPTY'));
272
        $fh->Write(prc     ('            VALUE "ProductName",      RC_STR_PRODUCTNAME'));
273
        $fh->Write(prc     ('            VALUE "ProductVersion",   RC_STR_VERSION'));
274
        $fh->Write(prc     ('            VALUE "SpecialBuild",     RC_STR_SPECIAL'));
275
        $fh->Write(prc     ('        END'));
276
        $fh->Write(prc     ('    END'));
277
        $fh->Write(prc     ('        BLOCK "VarFileInfo"'));
278
        $fh->Write(prc     ('        BEGIN'));
279
        $fh->Write(prc     ('            VALUE "Translation", 0xc09, 1200'));
280
        $fh->Write(prc     ('        END'));
281
        $fh->Write(prc     ('END'));
282
        $fh->Write(prc     (''));
227 dpurdie 283
 
263 dpurdie 284
        if ( $icon )
285
        {
286
        $fh->Write(prc     (''));
287
        $fh->Write(prc     ('/////////////////////////////////////////////////////////////////////////////'));
288
        $fh->Write(prc     ('//'));
289
        $fh->Write(prc     ('// Icon'));
290
        $fh->Write(prc     ('//'));
291
        $fh->Write(prc     ('// Icon with lowest ID value placed first to ensure application icon'));
292
        $fh->Write(prc     ('// remains consistent on all systems.'));
293
        $fh->Write(prc     ("101       ICON    DISCARDABLE     \"$icon\""));
294
        $fh->Write(prc     (''));
295
        }
235 dpurdie 296
    }
297
 
298
 
227 dpurdie 299
    $fh->Close();
300
}
301
 
302
#-------------------------------------------------------------------------------
303
# Function        : BuildVersionC
304
#
305
# Description     : Create a "C" style version.c and version.h file
306
#
289 dpurdie 307
# Inputs          : $FileName       - Output filename (Optional)
308
#                                     If provided it will be 'known' to all
309
#                                     of jats. Done for backward compatability
310
#                   $Prefix         - Text to prefix generated variables with
227 dpurdie 311
#                                     Used to avoid namespace conflicts
312
#                   $Type           - Type of version to create
313
#                                     Only allowed value is 'array'
314
#
315
# Returns         :
316
#
317
 
318
sub BuildVersionC
319
{
289 dpurdie 320
    my( $FileName, $Prefix, $Type ) = @_;
227 dpurdie 321
    my $ver;
322
 
289 dpurdie 323
    #
324
    #   Default name of the file
325
    #   Don't allow the user to play with the extension
326
    #   If the user provided a filename It will be a file that is 'known' to JATS
327
    #   
328
    my $bname = defined($FileName) ? StripExt($FileName) : 'version';
227 dpurdie 329
 
289 dpurdie 330
    my $fname_c = ::BuildAddKnownFile ( $Srcdir, $bname . '.c', !defined($FileName) );
331
    my $fname_h = ::BuildAddKnownFile ( $Srcdir, $bname . '.h', !defined($FileName) );
332
 
333
    return if ( $Clobber );      # clobber mode ?
334
    Message ("Creating C Version File: $fname_c" );
335
 
227 dpurdie 336
    #
337
    #   Default prefix is none
338
    #   Set to a defined, bet empty, string
339
    #
340
    $Prefix = "" if ( ! defined( $Prefix ) );
341
    $Type   = "" if ( ! defined( $Type ) );
342
 
343
    #   src/version.c
344
    #..
289 dpurdie 345
    open( VERSIONC, '>', $fname_c ) ||
346
        Error( "cannot create $fname_c" );
227 dpurdie 347
 
348
    print VERSIONC
349
        "/* Please do not edit this file.\n" .
350
        " * It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
351
        " */\n" .
352
        "#include \"version.h\"\n";
353
 
354
    print VERSIONC
355
        "\n" .
356
        "static char what[] = \"@(#) $BUILDNAME $::CurrentDate ERG\";\n" .
357
        "\n";
358
 
359
 
360
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
361
    if ( $Type eq "array" )
362
    {                                           # new style
363
        print VERSIONC
364
           "static const char *pkgarray[] = \n" .
365
           "{\n";
366
 
367
        foreach $ver ( @PACKAGEVERS   ) {
368
            print VERSIONC "    \"$ver\",\n";
369
        }
370
 
371
        print VERSIONC
372
           "    0\n",
373
           "};\n\n";
374
 
375
        print VERSIONC
376
           "\nconst char *\n$Prefix"."VersionString(void)\n" .
377
           "{\n".
378
           "    return \"$BUILDNAME\";\n" .
379
           "}\n" .
380
           "\nconst char **\n$Prefix"."PkgStrings(void)\n" .
381
           "{\n".
382
           "    return pkgarray;\n" .
383
           "}\n" .
384
           "\nconst char *\n$Prefix"."GetModuleInfo(void)\n" .
385
           "{\n" .
386
           "    return \"$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\";\n" .
387
           "}\n";
388
    }
389
    else
390
    {                                           # old style
391
        print VERSIONC
392
           "\nconst char *\n$Prefix"."VersionString(void)\n" .
393
           "{\n".
394
           "    return \"$BUILDNAME @PACKAGEVERS\";\n" .
395
           "}\n" .
396
           "\nconst char *\n$Prefix"."GetModuleInfo(void)\n" .
397
           "{\n" .
398
           "    return \"$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\";\n" .
399
           "}\n";
400
    }
401
    close VERSIONC;
402
 
403
#   src/version.h
404
#..
289 dpurdie 405
    open( VERSIONH, '>', $fname_h ) ||
406
        Error( "cannot create $fname_h" );
227 dpurdie 407
 
408
    print VERSIONH
409
        "#ifndef VERSION_H_INCLUDED\n" .
410
        "#define VERSION_H_INCLUDED\n" .
411
        "/* Please do not edit this file.\n" .
412
        " * It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
413
        " */\n\n" .
414
        "#define BUILDNAME     \"$BUILDNAME\"\n" .
415
        "#define BUILDDATE     \"$::CurrentTime\"\n" .
416
        "\n";
417
 
418
    print VERSIONH
419
        "#ifdef __cplusplus\n" .
420
        "    extern \"C\" {           /* force C calling convention when using C++ */\n" .
421
        "#endif\n" .
422
        "\n";
423
 
424
    if ( $Type eq "array" )
425
    {                                           # extended interface
426
        print VERSIONH
427
        "extern const char **  $Prefix"."PkgStrings(void);\n";
428
    }
429
    print VERSIONH
430
        "extern const char *   $Prefix"."VersionString(void);\n".
431
        "extern const char *   $Prefix"."GetModuleInfo(void);\n";
432
 
433
    print VERSIONH
434
        "\n" .
435
        "#ifdef __cplusplus\n" .
436
        "    } /* extern \"C\" */\n" .
437
        "#endif\n" .
438
        "\n";
439
 
440
    print VERSIONH
441
        "\n#endif /*VERSION_H_INCLUDED*/\n";
442
    close VERSIONH;
443
}
444
 
445
#-------------------------------------------------------------------------------
446
# Function        : BuildVersionCdefs
447
#
448
# Description     : Generate a "C" style version definitions file
449
#                   This file simply contains definitions
450
#
289 dpurdie 451
# Inputs          : $FileName       - Output filename (Optional)
452
#                                     If provided it will be 'known' to all
453
#                                     of jats. Done for backward compatability
454
#                   $Mode           - File suffix
227 dpurdie 455
#                   $ModePrefix     - Tag for all generated definitions
456
#
457
# Returns         :
458
#
459
 
460
sub BuildVersionCdefs
461
{
289 dpurdie 462
    my ( $FileName, $Mode, $ModePrefix ) = @_;
227 dpurdie 463
 
289 dpurdie 464
    my $fname = defined($FileName) ? $FileName : "version_$Mode.h";
465
    $fname = ::BuildAddKnownFile ( $Srcdir, $fname , ! defined($FileName) );
466
    return if ( $Clobber );      # clobber mode ?
467
    Message ("Creating C Version Defs File: $fname" );
227 dpurdie 468
 
469
    #
470
    #   Generate version_defs.h
471
    #   This file contains ONLY definitions. It may be used by assembler
472
    #   programs (that support a preprocessor) to access version information
473
    #
474
    #   Allow for a user supplied filename fragment that will be used within
475
    #   all the definitions with in the file.
476
    #
477
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
478
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
479
 
480
    #
481
    #   Base names on a user supplied value or a default
482
    #
483
    my $vtag = uc( "VERSION$ModePrefix" );
484
    my $guard_name = uc($fname);
289 dpurdie 485
       $guard_name =~ tr~\.\/\\~_~s;
227 dpurdie 486
 
289 dpurdie 487
    open( VERSIOND, '>', $fname ) ||
488
        Error( "cannot create $fname" );
227 dpurdie 489
 
490
    print VERSIOND
491
        "#ifndef $guard_name\n" .
492
        "#define $guard_name\n" .
493
        "/* Please do not edit this file.\n" .
494
        " * It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
495
        " */\n\n" .
496
        "\n".
497
        "#define ${vtag}_BUILDNAME      \"$BUILDNAME\"\n".
498
        "#define ${vtag}_BUILDDATE      \"$::CurrentTime\"\n".
499
        "\n".
500
        "#define ${vtag}_PACKAGE        \"$BUILDNAME_PACKAGE\"\n".
501
        "#define ${vtag}_VERSION        \"$BUILDNAME_VERSION\"\n".
502
        "#define ${vtag}_MAJOR_STR      \"$major\"\n".
503
        "#define ${vtag}_MINOR_STR      \"$minor\"\n".
504
        "#define ${vtag}_PATCH_STR      \"$patch\"\n".
505
        "#define ${vtag}_BUILD_STR      \"$build\"\n".
506
        "#define ${vtag}_PATCHBUILD_STR \"$raw_patch\"\n".
507
        "#define ${vtag}_PROJECT        \"$BUILDNAME_PROJECT\"\n".
508
        "#define ${vtag}_MAJOR          " . strip_zeros($major) . "\n".
509
        "#define ${vtag}_MINOR          " . strip_zeros($minor) . "\n".
510
        "#define ${vtag}_PATCH          " . strip_zeros($patch) . "\n".
511
        "#define ${vtag}_BUILD          " . strip_zeros($build) . "\n".
512
        "#define ${vtag}_PATCHBUILD     " . strip_zeros($raw_patch) . "\n".
513
        "#define ${vtag}_ALL            \"$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\"\n".
514
        "#define ${vtag}_BUILDTIME      " . strip_zeros(time()) . "\n".
515
        "\n".
516
        "#endif /* $guard_name */\n";
517
 
518
    close VERSIOND;
519
}
520
 
521
#-------------------------------------------------------------------------------
229 dpurdie 522
# Function        : BuildVersionProperties
523
#
524
# Description     : Generate a "Java" style version definitions file
525
#                   This is a simple properties file
526
#
527
# Inputs          : $FileName       - Output filename (Optional)
528
#                   $Prefix         - Tag for all generated definitions
529
#
530
# Returns         :
531
#
532
sub BuildVersionProperties
533
{
534
    my ( $fname, $Prefix ) = @_;
535
 
536
    #
537
    #   Default name of the file
538
    #
539
    $fname = 'version.properties' unless $fname;
540
 
541
    #
247 dpurdie 542
    #   Store the files location for use at runtime
543
    #   It will be a file that is 'known' to JATS
544
    #
545
    $fname = ::BuildAddKnownFile ( $Srcdir, $fname );
546
    return if ( $Clobber );      # clobber mode ?
289 dpurdie 547
    Message ("Creating Properties Version File: $fname" );
247 dpurdie 548
 
549
    #
229 dpurdie 550
    #   Generate version properties file
551
    #
552
    #   This file contains ONLY definitions. It may be included by the ANT
553
    #   builds. Its not intended to be imported by the java code
554
 
555
 
556
    #
557
    #   Allow for a user supplied property prefix
558
    #   Not really needed as
559
    #
560
    my $vtag = '';
561
    $vtag = $Prefix . '.' if $Prefix;
562
 
563
 
564
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
565
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
566
 
567
    #
568
    #   Create properties in the same form as for "C" definitions
569
    #   Note:
570
    #       The 'ALL' is in a format used by other software. Do not change
571
    #
247 dpurdie 572
    open( VERSIOND, ">$fname" ) ||
573
        Error( "cannot create $fname" );
229 dpurdie 574
 
575
    print VERSIOND
576
        "# Please do not edit this file.\n" .
577
        "# It was auto-generated by Buildlib ($BuildVersion) on $::CurrentTime\n" .
578
        "#\n" .
579
        "${vtag}BUILDNAME      = $BUILDNAME\n".
580
        "${vtag}BUILDDATE      = $::CurrentTime\n".
581
        "\n".
582
        "${vtag}PACKAGE        = $BUILDNAME_PACKAGE\n".
583
        "${vtag}VERSION        = $BUILDNAME_VERSION\n".
584
        "${vtag}MAJOR_STR      = $major\n".
585
        "${vtag}MINOR_STR      = $minor\n".
586
        "${vtag}PATCH_STR      = $patch\n".
587
        "${vtag}BUILD_STR      = $build\n".
588
        "${vtag}PATCHBUILD_STR = $raw_patch\n".
589
        "${vtag}PROJECT        = $BUILDNAME_PROJECT\n".
590
        "${vtag}MAJOR          = " . strip_zeros($major) . "\n".
591
        "${vtag}MINOR          = " . strip_zeros($minor) . "\n".
592
        "${vtag}PATCH          = " . strip_zeros($patch) . "\n".
593
        "${vtag}BUILD          = " . strip_zeros($build) . "\n".
594
        "${vtag}PATCHBUILD     = " . strip_zeros($raw_patch) . "\n".
595
        "${vtag}ALL            = $BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS\n".
596
        "${vtag}BUILDTIME      = " . strip_zeros(time()) . "\n".
597
        "\n";
598
    #
599
    #   Create a set of definitions for each dependent package
600
    #
601
    print VERSIOND "# Dependent Packages and Versions\n".
602
                   "#\n";
603
 
604
    foreach my $tag ( PackageEntry::GetPackageList() )
605
    {
606
        my ($name, $version, $type) = PackageEntry::GetPackageData($tag);
607
#        push @attributes, "build=\"true\"" if $type =~ /Build/i;
608
        print VERSIOND "${vtag}PACKAGE.$name=$version\n";
609
    }
610
    close VERSIOND;
611
}
612
 
613
#-------------------------------------------------------------------------------
289 dpurdie 614
# Function        : BuildVersionDelphi
615
#
616
# Description     : Create a pascal file in Delphi format
617
#
618
# Inputs          : $FileName       - Output filename (Optional)
619
#                   $Prefix         - Tag for all generated definitions
620
#
621
#
622
# Returns         : 
623
#
624
sub BuildVersionDelphi
625
{
626
    my ( $fname, $Prefix ) = @_;
627
 
628
    #
629
    #   Default name of the file
630
    #
631
    $fname = 'version_defs.pas' unless $fname;
632
    $fname .= '.pas'
633
        unless ( $fname =~ m~\.~ );
634
    my $unit_name = StripDirExt($fname);
635
    Error ("BuildVersion: Delphi Style. Filename \'$unit_name\. not allowed")
636
        if ( $unit_name =~ m~^version$~i );
637
 
638
    #
639
    #   Store the files location for use at runtime
640
    #   It will be a file that is 'known' to JATS
641
    #
642
    $fname = ::BuildAddKnownFile ( $Srcdir, $fname );
643
    return if ( $Clobber );      # clobber mode ?
644
    Message ("Creating Delpi Version File: $fname" );
645
 
646
    #
647
    #   Generate version source file
648
    #   This file contains ONLY constant definitions.
649
 
650
    #
651
    #   Allow for a user supplied property prefix
652
    #   Not really needed as
653
    #
654
    my $vtag = '';
655
    $vtag = $Prefix . '_' if $Prefix;
656
 
657
 
658
    my ($major, $minor, $patch, $build, $raw_patch) = SplitVersion($BUILDNAME_VERSION);
659
    my @PACKAGEVERS = PackageEntry::GetPackageVersionList();
660
 
661
    #
662
    #   Create properties in the same form as for "C" definitions
663
    #   Note:
664
    #       The 'ALL' is in a format used by other software. Do not change
665
    #
666
    sub pstring
667
    {
668
        my ($arg, $val) = @_;
669
        Error ("Undefined value for $arg") unless ( defined $val );
670
        return sprintf ( "%-24s = \'%s\';" , $arg, $val);
671
    }
672
    sub pnum
673
    {
674
        my ($arg, $val) = @_;
675
        Error ("Undefined value for $arg") unless ( defined $val );
676
        return sprintf ( "%-24s = %s;" , $arg, strip_zeros($val) );
677
    }
678
 
679
    my $fh = ConfigurationFile::New( $fname, '--Type=Delphi' );
680
    $fh->HeaderSimple( "buildlib (Version $BuildVersion)",
681
                       "Delphi Unit Version Definition" );
682
 
683
    $fh->WriteLn(
684
        "unit $unit_name;",
685
        "interface",
686
        "const",
687
        pstring ("${vtag}BUILDNAME",$BUILDNAME),
688
        pstring ("${vtag}BUILDDATE",$::CurrentTime),
689
        '',
690
        pstring ("${vtag}PACKAGE",$BUILDNAME_PACKAGE),
691
        pstring ("${vtag}VERSION",$BUILDNAME_VERSION),
692
        pstring ("${vtag}MAJOR_STR",$major),
693
        pstring ("${vtag}MINOR_STR",$minor),
694
        pstring ("${vtag}PATCH_STR",$patch),
695
        pstring ("${vtag}BUILD_STR",$build),
696
        pstring ("${vtag}PATCHBUILD_STR",$raw_patch),
697
        pstring ("${vtag}PROJECT",$BUILDNAME_PROJECT),
698
        pnum ("${vtag}MAJOR",$major),
699
        pnum ("${vtag}MINOR",$minor),
700
        pnum ("${vtag}PATCH",$patch),
701
        pnum ("${vtag}BUILD",$build),
702
        pnum ("${vtag}PATCHBUILD",$raw_patch),
703
        pstring ("${vtag}ALL","$BUILDNAME_PACKAGE ($BUILDNAME_VERSION.$BUILDNAME_PROJECT) @PACKAGEVERS"),
704
        pnum ("${vtag}BUILDTIME",time()),
705
        ''
706
        );
707
 
708
    #
709
    #   Create a set of definitions for each dependent package
710
    #
711
    $fh->Comment("Dependent Packages and Versions\n");
712
    $fh->Comment("\n");
713
 
714
    foreach my $tag ( PackageEntry::GetPackageList() )
715
    {
716
        my ($name, $version, $type) = PackageEntry::GetPackageData($tag);
717
        $fh->WriteLn(pstring ("${vtag}PACKAGE_$name", $version));
718
    }
719
    $fh->WriteLn( '',
720
        "implementation",
721
        "end.");
722
 
723
 
724
    $fh->WriteLn();
725
    $fh->Close();
726
}
727
 
728
 
729
#-------------------------------------------------------------------------------
227 dpurdie 730
# Function        : stip_zeros
731
#
732
# Description     : Remove leading 0's from a string
733
#
734
# Inputs          : A string
735
#
736
# Returns         : A string without leading zeros
737
#
738
sub strip_zeros
739
{
740
    my ($text) = @_;
741
 
742
    $text =~ s~^0*~~;
743
    $text = '0' unless ( $text );
744
    return $text;
745
}
746
 
747
1;