Subversion Repositories DevTools

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
227 dpurdie 1
#! perl
2
########################################################################
315 dpurdie 3
# Copyright (C) 1998-2010 ERG Limited, All rights reserved
227 dpurdie 4
#
5
# Module name   : jats.sh
6
# Module type   : Makefile system
7
# Compiler(s)   : n/a
8
# Environment(s): jats
9
#
10
# Description:
11
#       This is a wrapper script to simplify access to the jats
12
#       build system
13
#
14
# Usage:        jats build | make | install | help | ...
15
#
229 dpurdie 16
# Package: PACKAGE_TAG
17
# Version: VERSION_TAG
227 dpurdie 18
#......................................................................#
19
 
261 dpurdie 20
require 5.008_002;
227 dpurdie 21
use strict;
22
use warnings;
23
 
24
use Cwd;
25
use File::Copy;
26
use Getopt::Long qw(:config require_order);     # Stop on non-option
27
use FindBin;                                    # Determine the current directory
28
use lib "$FindBin::Bin/LIB";                    # Allow JATS libraries
29
use Config;
30
use Sys::Hostname;                              # For hostname
31
 
315 dpurdie 32
use Pod::Usage;                                 # For help support
227 dpurdie 33
use JatsError;                                  # Common error reporting
34
use DescPkg;                                    # Package Descriptor processing
35
use JatsSystem;                                 # System call interface
245 dpurdie 36
use JatsBuildFiles;                             # Parse Build Files
227 dpurdie 37
 
229 dpurdie 38
my $GBE_VERSION = "VERSION_TAG";                # Will be re-written when released
245 dpurdie 39
my $GBE_NOT_RELEASED = "RELEASE_TAG";           # Will be re-written when released
227 dpurdie 40
my $opr_done;
41
my $opt_here = 0;
42
my $BUILD_FILE      = "build.pl";
43
my @BUILD_FILE_ALT  = qw(auto.pl build_test.pl);
44
my $BUILD_FILE_SET;
45
my $RESULT = 0;
46
my $PSPLIT = ':';                               # Win/Unix path splitter
47
my $TIMER = time;
48
my $opt_time = 0;
49
my $opt_help = 0;
50
my $opt_locate = 0;
51
my $opt_locate_file;
245 dpurdie 52
my $opt_locate_package;
227 dpurdie 53
my $opt_dir;
54
my $opt_java;
277 dpurdie 55
my $opt_export_vars = 1;
227 dpurdie 56
my $result;
57
 
58
#
59
#   Grab a copy of ALL the environment variable that will be used
60
#   This will simplify the script a great deal
61
#
62
 
279 dpurdie 63
our $GBE_JATS_VERSION   = $ENV{'GBE_JATS_VERSION'}   || '';
227 dpurdie 64
our $GBE_JATS_SANE      = $ENV{'GBE_JATS_SANE'}      || 0;
279 dpurdie 65
our $GBE_CORE           = $ENV{'GBE_CORE'}           || '';
66
our $GBE_BIN            = $ENV{'GBE_BIN'}            || '';
67
our $GBE_CONFIG         = $ENV{'GBE_CONFIG'}         || '';
68
our $GBE_DPLY           = $ENV{'GBE_DPLY'}           || '';
69
our $GBE_DPKG           = $ENV{'GBE_DPKG'}           || '';
70
our $GBE_DPKG_STORE     = $ENV{'GBE_DPKG_STORE'}     || '';
71
our $GBE_DPKG_LOCAL     = $ENV{'GBE_DPKG_LOCAL'}     || '';
72
our $GBE_DPKG_CACHE     = $ENV{'GBE_DPKG_CACHE'}     || '';
73
our $GBE_DPKG_SBOX      = $ENV{'GBE_DPKG_SBOX'}      || '';
74
our $GBE_SANDBOX        = $ENV{'GBE_SANDBOX'}        || '';
75
our $GBE_PERL           = $ENV{'GBE_PERL'}           || '';
76
our $GBE_TOOLS          = $ENV{'GBE_TOOLS'}          || '';
77
our $GBE_MACHTYPE       = $ENV{'GBE_MACHTYPE'}       || '';
273 dpurdie 78
our $GBE_HOSTMACH       = $ENV{'GBE_HOSTMACH'}       || $GBE_MACHTYPE;
279 dpurdie 79
our $GBE_PLATFORM       = $ENV{'GBE_PLATFORM'}       || '';
80
our $GBE_BUILDFILTER    = $ENV{'GBE_BUILDFILTER'}    || '';
227 dpurdie 81
our $GBE_DEBUG          = $ENV{'GBE_DEBUG'}          || 0;
82
our $GBE_VERBOSE        = $ENV{'GBE_VERBOSE'}        || 0;
279 dpurdie 83
our $GBE_DRV            = $ENV{'GBE_DRV'}            || '';
84
our $GBE_HOSTNAME       = $ENV{'GBE_HOSTNAME'}       || hostname || '';
85
our $USER               = $ENV{'USER'}               || '';
86
our $PERL5LIB           = $ENV{'PERL5LIB'}           || '';
87
our $JAVA_HOME          = $ENV{'JAVA_HOME'}          || '';
88
our $GBE_ABT            = $ENV{'GBE_ABT'}            || '';
227 dpurdie 89
our $GBE_UNIX           = 1;
90
our $CWD;
91
 
92
#-------------------------------------------------------------------------------
93
#   Clean up some environment variables
245 dpurdie 94
#       GBE_BUILDFILTER - may be space or comma separated list
95
#       GBE_PLATFORM - may be space or comma separated list
96
#       GBE_ABT - may be space or comma separated list
279 dpurdie 97
#       GBE_HOSTNAME - No whitespace
227 dpurdie 98
#
99
$GBE_BUILDFILTER = join (' ', split( /[,\s]+/, $GBE_BUILDFILTER));
100
$GBE_PLATFORM    = join (' ', split( /[,\s]+/, $GBE_PLATFORM));
101
$GBE_ABT         = join (' ', split( /[,\s]+/, $GBE_ABT));
279 dpurdie 102
$GBE_HOSTNAME    =~ s~\s+~~g;
227 dpurdie 103
 
104
#-------------------------------------------------------------------------------
105
#   Parse the user options
106
#   GetOptions has been configured so that it will stop parsing on the first
107
#   non-options. This allows the command syntax to the script to have options
108
#   that are directed to this script before the command keyword, and command
109
#   options to the subcommand to be after the keyword.
110
#
111
$result = GetOptions (
261 dpurdie 112
            "help|h:+"          => \$opt_help,
113
            "manual:3"          => \$opt_help,
114
            "verbose|v:+"       => \$GBE_VERBOSE,
115
            "debug:+"           => \$GBE_DEBUG,
227 dpurdie 116
            "cd|changedir=s"    => \$opt_dir,
117
            "locate"            => \$opt_locate,
118
            "locatefile=s"      => \$opt_locate_file,
245 dpurdie 119
            "locatepkg=s"       => \$opt_locate_package,
227 dpurdie 120
            "here"              => \$opt_here,
121
            "time"              => \$opt_time,
122
            "b|buildfile=s"     => \&opts_buildfile,
245 dpurdie 123
            "java=s"            => \$opt_java,
227 dpurdie 124
            "version=s",        => \&opts_version,
125
            "platform:s",       => sub{ opts_extend( \$GBE_PLATFORM, @_ )},
126
            "buildfilter:s"     => sub{ opts_extend( \$GBE_BUILDFILTER, @_ )},
127
            "abt:s"             => sub{ opts_extend( \$GBE_ABT, @_ )},
277 dpurdie 128
            "exportvars!"       => \$opt_export_vars,
227 dpurdie 129
            );
130
 
131
#
132
#   Configure the error reporting process now that we have the user options
133
#
134
ErrorConfig( 'name'    => 'JATS',
135
             'debug'   => $GBE_DEBUG,
136
             'verbose' => $GBE_VERBOSE );
137
#
138
#   Post process some of the options
139
#
140
Error ("Options not parsed. Use -help for help") unless $result;
263 dpurdie 141
Verbose3 ('ARGS', @ARGV);
227 dpurdie 142
 
143
#
144
#   Option Helper Routine
145
#   Save alternate buildfile. Flag that it has been set
146
#
147
sub opts_buildfile
148
{
283 dpurdie 149
    my ($junk, $bf) = @_;
150
    $BUILD_FILE = $bf;
227 dpurdie 151
    $BUILD_FILE_SET = 1;
152
    Verbose ("Use alternate buildfile: $BUILD_FILE");
283 dpurdie 153
    return;
227 dpurdie 154
}
155
 
156
#
157
#   Options Helper Routine
158
#   Collect a space/comma delimited list and replace/append to string
159
#   Allows the string to be reset
160
#   Use of a +" will append to existing value
161
#
162
#       arg1 - Ref to string to store data
163
#       arg2 - Option name
164
#       arg3 - Option value
165
#
166
sub opts_extend
167
{
168
    my( $ref, $name, $value) = @_;
169
    if ( $value )
170
    {
171
        $value =~ s/,/ /g;
172
        $value = ${$ref} . ' ' . $value
173
            if ( $value =~ s/\+/ /g );
174
        $value =~ s/^\s+//;
175
        $value =~ s/\s+/ /;
176
    }
177
    ${$ref} = $value;
283 dpurdie 178
    return;
227 dpurdie 179
}
180
 
181
#
182
#   Options Helper routine
183
#   Collect --version=version, then stop processing of the command line
184
#   This will simulate a '--'
185
#
186
sub opts_version
187
{
283 dpurdie 188
    my ($junk, $vn) = @_;
189
    $GBE_JATS_VERSION = $vn;
190
    die("!FINISH\n");
227 dpurdie 191
}
192
 
193
################################################################################
194
#
195
#   Ensure that essential environment variables are present and that they
196
#   do not contain spaces.
197
#
198
ReportError('Set env-var GBE_PERL (typically "/usr/bin/perl")')   unless ( $GBE_PERL );
229 dpurdie 199
ReportError('Set env-var GBE_DPKG (typically "/devl/dpkg_archive")') unless ( $GBE_DPKG );
200
ReportError('Set env-var GBE_CORE (typically "/devl/dpkg_archive/PACKAGE_TAG/VERSION_TAG")')  unless ( $GBE_CORE );
279 dpurdie 201
ReportError('Hostname cannot be determined') unless ( $GBE_HOSTNAME );
227 dpurdie 202
 
229 dpurdie 203
################################################################################
204
#
205
#   Warn if using a version of perl that is newer than expected
206
#   The 'require' does a lower limit test
207
#
283 dpurdie 208
if ( ! $GBE_JATS_SANE )
209
{
210
    Warning ("Perl Version may not be compatible",
211
             "Jats has been tested with: 5.8.8",
212
             "This version is: $]",
213
            ) if ( $] > 5.010000 );
227 dpurdie 214
 
283 dpurdie 215
    Warning ("The PDK, as used by some deployed packages does not work with this version of perl.",
216
             "ERG only has a licence for PDK V5 and this only works with Perl 5.6 and 5.8",
217
             "This version is: $]",
218
            ) if ( $] > 5.009000 );
219
}
229 dpurdie 220
 
221
#
222
#   Warn if this is not an active state release
223
#
224
#   Would be nice, but I can't figure out how to do it - yet
225
#   The following does not work on all platforms
226
#
227
#unless ( $ActivePerl::VERSION )
228
#{
229
#    Warning ("Perl does not appear to be an ActiveState Release", "Jats may not function as expected");
230
#}
231
#else
232
#{
233
#    Verbose ("ActiveState Version: $ActivePerl::VERSION");
234
#}
235
 
227 dpurdie 236
################################################################################
229 dpurdie 237
#
245 dpurdie 238
#   Warn if this version of JATS is not correctly versioned
229 dpurdie 239
#   Users should be using correctly versioned copies of JATS. These come
240
#   from dpkg_archive.
241
#
231 dpurdie 242
Warning ("*** Unofficial version of JATS ***")
243 dpurdie 243
    if ( ! $GBE_JATS_SANE && $GBE_NOT_RELEASED );
229 dpurdie 244
 
245
################################################################################
227 dpurdie 246
#   If running with cygwin then warn if the CYGWIN environment variable
247
#   contains "tty". tty mode causes some strange behaviour such as:
248
#       1) Non flushing of perl scripts under some conditions (eg:create_dpkg)
249
#
250
if ( $ENV{'CYGWIN'} && $ENV{'CYGWIN'} =~ m/tty/ )
251
{
252
    Warning ("The CYGWIN variable contains \"tty\".",
253
             "This can cause strange behaviour with interactive scripts");
254
}
255
 
256
#
257
#   Remove CDPATH - this breaks things when cygwin is running
258
#   even if we are not running under cygwin perl
259
#
260
delete $ENV{'CDPATH'};
261
 
262
 
263
################################################################################
264
#   Sanitize GBE_CORE and others for internal Perl use
265
#   It may contain \ to be added to PATH but within perl is needs /
266
#
267
$PERL5LIB =~ tr~\\/~/~s;
268
 
269
TestDirectoryConfig( 'GBE_CORE' );
270
TestDirectoryConfig( 'GBE_BIN' );
271
TestDirectoryConfig( 'GBE_PERL' );
272
TestDirectoryConfig( 'GBE_DPLY' );
273
TestDirectoryConfig( 'GBE_DPKG' );
274
TestDirectoryConfig( 'GBE_DPKG_CACHE' );
275
TestDirectoryConfig( 'GBE_DPKG_LOCAL' );
276
TestDirectoryConfig( 'GBE_DPKG_STORE' );
277
TestDirectoryConfig( 'GBE_DPKG_SBOX' );
278
TestDirectoryConfig( 'GBE_SANDBOX' );
279
 
280
################################################################################
281
#   Setup the Machine Type
282
#
283
#   GBE_MACHTYPE is used to determine the BIN directory from which JATS will
284
#   pull local binary executables from. The directory must exist.
285
#
286
#   We need GBE_MACHTYPE to be correctly defined by the user
287
#   This is machine specific and should be done in jats.sh/jats.bat
288
#
289
unless ( $GBE_MACHTYPE )
290
{
291
    $GBE_MACHTYPE = 'win32' if ( $^O eq "cygwin" );
292
    $GBE_MACHTYPE = 'win32' if ( $^O eq "MSWin32" );
293
    $GBE_MACHTYPE = 'win32' if ( $^O eq "win95" );
294
    Verbose ("Setting GBE_MACHTYPE: $GBE_MACHTYPE") ;
295
}
296
 
297
ReportError ('Set env-var GBE_MACHTYPE (typically "win32")') unless ( $GBE_MACHTYPE );
298
ErrorDoExit();
299
 
300
if ( $GBE_MACHTYPE eq 'win32' )
301
{
302
    $PSPLIT = ';';
303
    $GBE_UNIX = 0;
304
}
305
 
306
################################################################################
307
#   Windows: If the user is running JATS from within the development view
308
#   then they may not provide a drive letter in the full name of GBE_CORE
309
#   For correct operation GBE_CORE needs to be able to run programs and
310
#   scripts from any other drive
311
#
312
#   If GBE_CORE does not have a driver letter - then add one
313
#   Note: Use the CWD before any CD operations
314
#
315
if ( $GBE_MACHTYPE eq 'win32'  && $GBE_CORE !~ m/^\w\:/ )
316
{
317
        my $cwd = getcwd();
318
        $GBE_CORE = substr( $cwd, 0, 2 ) . '/' . $GBE_CORE;
319
        $GBE_CORE =~ s~//~/~g;
320
        Verbose2 ("Setting GBE_CORE drive: $GBE_CORE");
321
}
322
 
323
################################################################################
324
#   Attempt to run JATS from a local cache
325
#   This mechanism allows JATS to be a link to a desired version on a network
326
#   drive, but to have the version transferred locally if required
327
#
229 dpurdie 328
#   The transfer/check is only done on the first invocation of jats. If jats uses
245 dpurdie 329
#   jats to perform functions, then it will not be performed.
229 dpurdie 330
#
245 dpurdie 331
#   If we want to run an alternate version of JATS, then don't attempt to
229 dpurdie 332
#   cache the initial version of JATS.
333
#
227 dpurdie 334
if ( $ENV{GBE_CACHE_JATS} && ! $GBE_JATS_SANE && ! $GBE_JATS_VERSION)
335
{
336
    my $state = "Not Cached: Not running from dpkg_archive";
337
    #
338
    #   Must have the DPKG_ARCHIVE cache
229 dpurdie 339
    #   Must be running from DPKG_ARCHIVE - prevent messing with local copies
227 dpurdie 340
    #
341
    if ( $GBE_DPKG_CACHE )
342
    {
229 dpurdie 343
        #
344
        #   JATS must be running from an archive, otherwise we assume that its
345
        #   a local copy. Detected by:
346
        #       GBE_NOT_RELEASED being set
347
        #       Lack of descpkg file
348
        #
349
        if ( ! $GBE_NOT_RELEASED  && -f "$GBE_CORE/descpkg" )
227 dpurdie 350
        {
229 dpurdie 351
            my ($archive, $package) = LocateJatsVersion( $GBE_VERSION );
352
            if ( $archive )
353
            {
354
                Verbose ("Update cached version of JATS: $GBE_VERSION");
355
                #
356
                #   Attempt to cache the package
357
                #   Need enough JATS environment to run the cache_dpkg utility
358
                #
283 dpurdie 359
                {
360
                    local %ENV = %ENV;
227 dpurdie 361
 
283 dpurdie 362
                    $ENV{GBE_TOOLS} = "$GBE_CORE/TOOLS";
363
                    $ENV{PERL5LIB} = "$GBE_CORE/TOOLS/LIB" ;
364
                    $ENV{GBE_BIN}  = "$GBE_CORE/BIN.$GBE_MACHTYPE";
365
                    $ENV{GBE_VERBOSE}  = $GBE_VERBOSE;
227 dpurdie 366
 
283 dpurdie 367
                    etool ( 'cache_dpkg.pl', $package );
368
                }
227 dpurdie 369
 
229 dpurdie 370
                my $tgt = "$GBE_DPKG_CACHE/$package";
371
                if ( -d $tgt )
372
                {
373
                    Verbose ("Using cached version of JATS: $GBE_VERSION");
374
                    $GBE_CORE = $tgt;
375
                    $state = "Cached";
376
                }
377
                else
378
                {
379
                    $state = "Not Cached: Copy Failure";
380
                }
227 dpurdie 381
            }
382
            else
383
            {
229 dpurdie 384
                $state = "Not Cached: Not found in archives";
227 dpurdie 385
            }
386
        }
387
    }
388
    else
389
    {
390
        $state = "Not Cached: No GBE_DPKG_CACHE";
391
    }
392
 
393
    #
394
    #   Flag JATS having been cached on the machine
395
    #
396
    $ENV{GBE_CACHE_JATS} = $state;
397
}
398
 
399
 
400
################################################################################
401
#   Establish a relationship between GBE_BIN, GBE_TOOLS and GBE_CONFIG
402
#   unless the user has already provided one.
403
#
404
#   Only NEED GBE_CORE - the others will be derived
405
#
406
unless ( $GBE_BIN )
407
{
408
    $GBE_BIN = "$GBE_CORE/BIN.$GBE_MACHTYPE";
409
    Verbose2 ("Setting GBE_BIN: $GBE_BIN");
410
}
411
ReportError ('GBE_MACHTYPE is not valid.',
412
             'There must be a corresponding BIN directory in GBE_CORE',
413
             "GBE_BIN     : $GBE_BIN",
414
             "GBE_MACHTYPE: $GBE_MACHTYPE"
415
             ) unless ( -d $GBE_BIN );
416
 
417
ReportError ('Machine specific binary directory does not appear to setup',
418
             'After JATS is installed the PostInstall script must be run',
419
             "GBE_BIN     : $GBE_BIN"
420
             ) unless ( -x $GBE_BIN . '/sh' || -x $GBE_BIN . '/sh.exe'  );
421
 
422
unless ( $GBE_TOOLS )
423
{
424
    $GBE_TOOLS = "$GBE_CORE/TOOLS";
425
    Verbose2 ("Setting GBE_TOOLS: $GBE_TOOLS");
426
}
427
 
428
unless ( $GBE_CONFIG )
429
{
430
    $GBE_CONFIG = "$GBE_CORE/CFG";
431
    Verbose2 ("Setting GBE_CONFIG: $GBE_CONFIG");
432
}
433
 
434
#
435
#   Extend the PERL5 with our own Module Repository
436
#
437
$PERL5LIB = join( $PSPLIT, split( $PSPLIT, $PERL5LIB), "$GBE_CORE/TOOLS/LIB" );
438
 
439
 
440
################################################################################
441
#   Sanity Test
442
#   The ABT environment requires several parameters to specify the location
443
#   of the Release/Deployment Managers
444
#
445
#   GBE_DM_LOCATION will be set GBE_RM_LOCATION, if not set
446
#
447
#   Only perform the test:
448
#       - On the first invocation of JATS, not nested invocations
449
#       - Based on the EnvVar, not the user option. This will allow a user
450
#         to invoke ABT without the need for these values to be present
451
#
452
if ( ! $GBE_JATS_SANE && $ENV{GBE_RM_LOCATION} && ! $ENV{GBE_DM_LOCATION} )
453
{
454
    $ENV{GBE_DM_LOCATION} = $ENV{GBE_RM_LOCATION};
455
}
456
 
457
if ( ! $GBE_JATS_SANE && $ENV{GBE_ABT} )
458
{
459
    foreach my $var ( qw(GBE_DM_LOCATION GBE_DM_USERNAME GBE_DM_PASSWORD GBE_RM_URL))
460
    {
461
        Warning("Deployment Manager EnvVar may need to be defined: $var") unless ( $ENV{$var} );
462
    }
463
 
464
    foreach my $var ( qw(GBE_RM_LOCATION GBE_RM_USERNAME GBE_RM_PASSWORD GBE_DM_URL))
465
    {
466
        ReportError("Release Manager EnvVar needs to be defined: $var") unless ( $ENV{$var} );
467
    }
468
}
469
 
470
################################################################################
471
#
472
#   Change to the required root directory
473
#       The user may specify a start directory( -c )
474
#
475
change_dir ( $opt_dir );
245 dpurdie 476
 
477
 
478
################################################################################
479
#   Locate the root of the build - if required
480
#   This is used by the autobuild tools to:
481
#       1) Locate the build.pl file for JATS based builds
482
#          The name of the target package can be provided to resolve
483
#          cases of multiple build files.
484
#
485
#       2) Locate the <ProjectName>depends.xml file for ANT based builds
486
#          The name of the buildfile will be specified
487
#          There must be only one file of this name in the tree
488
#
489
#   Note: If only one build file is found, then it will be used
490
#         It will not be sanity tested. This is intentional
491
#         for backward compatability.
492
#
493
if ( $opt_locate || $opt_locate_file || $opt_locate_package )
227 dpurdie 494
{
245 dpurdie 495
    #
496
    #   Allow the user to specify the name of the build file
497
    #   This will be used in ANT builds as the name changes
498
    #   but it can be predetermined
499
    #
227 dpurdie 500
    $opt_locate_file = $BUILD_FILE unless ( $opt_locate_file );
501
 
245 dpurdie 502
    #
503
    #   Create a Build File Scanner object
504
    #   This will be used to locate a suitable build file
505
    #
227 dpurdie 506
    Verbose ("Autolocate the build file: $opt_locate_file");
507
 
245 dpurdie 508
    my $bscanner = BuildFileScanner ( '.', $opt_locate_file );
509
    my $count = $bscanner->locate();
510
 
511
    Error ("Autolocate. Build file not found: $opt_locate_file" )
512
        if ( $count <= 0 );
513
 
227 dpurdie 514
    #
245 dpurdie 515
    #   If multiple build files have been found
516
    #   If $opt_locate_package is set then we can attempt to resolve the package
227 dpurdie 517
    #
245 dpurdie 518
    #   Scan the buildfiles and determine the names of the packages that will
519
    #   be built. This can be used to generate nice error messages
520
    if ( $count > 1 )
521
    {
522
        $bscanner->scan();
523
        $count = $bscanner->match( $opt_locate_package );
524
#DebugDumpData ("Bscan", \$bscanner );
227 dpurdie 525
 
245 dpurdie 526
        my $errmess;
527
        unless ( $opt_locate_package ) {
528
            $errmess = "Use -locatepkg=pkg to resolve required package";
529
 
530
        } elsif ( $count <= 0 ) {
531
            $errmess = "None found that build package: $opt_locate_package";
532
 
533
        } elsif ( $count > 1 ) {
534
            $errmess = "Multiple build files build the required package: $opt_locate_package";
535
        }
536
 
537
        #
538
        #   Pretty error display
539
        #   Display build directory and the package name (mangled)
540
        #
541
        if ( $errmess )
542
        {
543
            Error ("Autolocate. Multiple build files found.",
544
                   $errmess,
545
                   "Build files found in:", $bscanner->formatData() );
546
        }
547
    }
548
 
227 dpurdie 549
    #
245 dpurdie 550
    #   Extract the required build file directory
227 dpurdie 551
    #
245 dpurdie 552
    my $dir = $bscanner->getMatchDir() || '';
553
    Verbose ("Autolocate. Found $count build files: $dir");
227 dpurdie 554
 
555
    #
556
    #   Select the one true build directory
557
    #
245 dpurdie 558
    change_dir ( $dir );
227 dpurdie 559
 
560
    #
561
    #   Kill location scan as we have already located the build file
562
    #
563
    $opt_here = 1;
564
}
565
 
566
################################################################################
567
#   Version redirection
568
#   JATS allows the version of JATS to be used to be specified
569
#   This mechanism operates on the assumption that the required version is
570
#   present in dpkg_archive. If a specific version is required then the bulk
571
#   of this script is bypassed and the arguments passed directly to the required
572
#   target
573
#
574
if ( $GBE_JATS_VERSION && $GBE_JATS_VERSION eq $GBE_VERSION )
575
{
576
    Message("Using current JATS version: $GBE_JATS_VERSION" );
577
    $GBE_JATS_VERSION = undef;
578
}
579
 
580
if ( $GBE_JATS_VERSION )
581
{
582
    #
583
    #   Report any errors detected
584
    #
585
    ErrorDoExit();
586
    Message("Using JATS version: $GBE_JATS_VERSION");
587
 
588
    #
245 dpurdie 589
    #   If we have a cache available, then attempt to transfer the required
590
    #   version into the cache. If we don't have a cache, then don't even try.
229 dpurdie 591
    #
245 dpurdie 592
    if ( $GBE_DPKG_CACHE )
593
    {
594
        #
595
        #   Attempt to locate the desired version in one of the well known
596
        #   package archives. This will give us its package name.
597
        #
598
        my ($archive, $package) = LocateJatsVersion ($GBE_JATS_VERSION);
599
        Error("Cannot find JATS version: $GBE_JATS_VERSION") unless $archive;
229 dpurdie 600
 
245 dpurdie 601
        #
602
        #   Do NOT propagate GBE_JATS_VERSION in the environment
603
        #   This will only cause problem in recursion
604
        #
605
        delete $ENV{GBE_JATS_VERSION};
227 dpurdie 606
 
245 dpurdie 607
        #
608
        #   Attempt to cache the package
609
        #   Need enough JATS environment to run the utility
610
        #
283 dpurdie 611
        {
612
            local %ENV = %ENV;
227 dpurdie 613
 
283 dpurdie 614
            $ENV{PERL5LIB} = $PERL5LIB;
615
            $ENV{GBE_BIN}  = $GBE_BIN;
616
            $ENV{GBE_VERBOSE}  = $GBE_VERBOSE;
617
            $ENV{GBE_TOOLS}  = $GBE_TOOLS;
227 dpurdie 618
 
283 dpurdie 619
            etool ( 'cache_dpkg.pl', $package );
620
        }
245 dpurdie 621
    }
227 dpurdie 622
 
623
    #
229 dpurdie 624
    #   Locate the version of JATS to be run (again)
227 dpurdie 625
    #   It should be in the cache, but it may not be
626
    #
245 dpurdie 627
    my ($archive, $package) = LocateJatsVersion ($GBE_JATS_VERSION);
229 dpurdie 628
    Error("Cannot find JATS version: $GBE_JATS_VERSION") unless $archive;
629
 
630
    $GBE_CORE = "$archive/$package";
227 dpurdie 631
    Verbose2 ("Using alternate version: $GBE_CORE");
632
 
633
    #
634
    #   Run the specified version of JATS
635
    #   Force the required version of GBE_CORE and invoke the wrapper script
636
    #
637
    $ENV{GBE_CORE} = $GBE_CORE;
638
 
639
    Verbose("Use ARGV: @ARGV");
640
    $RESULT = System ($GBE_PERL, "$GBE_CORE/TOOLS/jats.pl", @ARGV );
641
    do_exit();
642
}
643
 
644
################################################################################
645
#   Determine the current directory
646
#   Note: Don't use `pwd`. This sucks for so many reasons including
647
#         the fact that it may not be available until this wrapper
648
#         script has done it job.
649
#
650
$CWD = getcwd();
651
Verbose ("Current Working Directory: $CWD");
652
Warning ("Current working directory contains spaces") if ( $CWD =~ m/\s/ );
653
 
654
 
655
################################################################################
656
#   Setup drive
657
#   This is only required under windows
658
#   Purpose is unclear, but under windows it is required, so lets create one
659
#   if its not present
660
#
661
unless ( $GBE_UNIX )
662
{
663
    unless ( $GBE_DRV )
664
    {
665
        ($GBE_DRV = $CWD ) =~ s~[^:]*$~~;
666
        $GBE_DRV = "c:" if ( $GBE_DRV !~ m/:/ );
667
        Verbose2( "Setting GBE_DRV: $GBE_DRV" );
668
    }
669
}
670
 
671
################################################################################
672
#   Sanity test the main archive variable
673
#   This MUST address one archive
674
#
675
 
676
Error ("GBE_DPKG must not be a path list: $GBE_DPKG")
677
    if ( $GBE_DPKG =~ /$PSPLIT/ );
678
Error ("GBE_DPKG is not a directory : $GBE_DPKG")
679
    unless( -d $GBE_DPKG );
680
 
681
################################################################################
682
#   Sanity test the cache
683
#
684
Error ("GBE_DPKG_CACHE is not a directory : $GBE_DPKG_CACHE")
685
    if ( $GBE_DPKG_CACHE && ! -d $GBE_DPKG_CACHE );
686
 
687
################################################################################
688
#   Sanity test the global store
689
#
690
Error ("GBE_DPKG_STORE is not a directory : $GBE_DPKG_STORE")
691
    if ( $GBE_DPKG_STORE && ! -d $GBE_DPKG_STORE );
692
 
693
Error ("GBE_DPLY is not a directory : $GBE_DPLY")
694
    if ( $GBE_DPLY && ! -d $GBE_DPLY );
695
 
696
########################################################################
697
#
698
#       Locate a local_dpkg_archive directory, by searching from the CWD
699
#       to the root of the file system
700
#
701
unless ( $GBE_DPKG_LOCAL )
702
{
283 dpurdie 703
    ($GBE_DPKG_LOCAL) = scan_for_dir ('local_dpkg_archive');
227 dpurdie 704
}
705
else
706
{
707
    Error ("GBE_DPKG_LOCAL is not a directory : $GBE_DPKG_LOCAL")
708
        unless( -d $GBE_DPKG_LOCAL );
709
}
710
 
711
########################################################################
712
#
713
#       Locate a sandbox_dpkg_archive directory by searching from the CWD
714
#       to the root of the file system
715
#
241 dpurdie 716
#       sandbox_dpkg_archive is a dpkg_archive for packages that are being
717
#       co-developed. Package Versions within the sandbox are ignored
227 dpurdie 718
#
241 dpurdie 719
 
720
#
721
#   Ensure that the user does not set $GBE_SANDBOX or $GBE_DPKG_SBOX
722
#   $GBE_JATS_SANE will be set for multiple invocations, thus it is cleared
723
#   for the first one (unless the user messes with it).
724
#
725
unless ( $GBE_JATS_SANE )
227 dpurdie 726
{
241 dpurdie 727
    Error ("GBE_SANDBOX must not be set by the user") if ( $GBE_SANDBOX );
728
    Error ("GBE_DPKG_SBOX must not be set by the user") if ( $GBE_DPKG_SBOX );
729
 
730
    #
731
    #   The ABT does not use the sandbox
732
    #   It will never be found and will be ignored
733
    #
734
    unless ( $GBE_ABT )
735
    {
277 dpurdie 736
        ($GBE_DPKG_SBOX,$GBE_SANDBOX)  = scan_for_dir ('sandbox_dpkg_archive');
227 dpurdie 737
    }
738
}
739
 
740
########################################################################
741
#
742
#   Ensure that the user has been set
743
#   Under windows USER may not be set, but USERNAME may be
299 dpurdie 744
#   As a last resort, use getlogin data
227 dpurdie 745
#
746
$USER = $ENV{ 'USERNAME' } || '' unless ( $USER );
747
$USER = $ENV{ 'LOGNAME' }  || '' unless ( $USER );
299 dpurdie 748
$USER = getlogin()         || '' unless ( $USER );
301 dpurdie 749
ReportError ('Cannot determine USER name, via USER, USERNAME, LOGNAME or getlogin')
750
    unless ( $USER );
299 dpurdie 751
#Debug ("User: ", $USER, $ENV{ 'USERNAME'}, $ENV{ 'LOGNAME' }, getlogin() );
752
 
227 dpurdie 753
################################################################################
754
#   Sanitize the PATH variable
755
#   Some of the Win32 binary tools used by JATS cannot handle lower case Path
756
#   Force an upper case PATH
757
#
758
my $PATH = '';
759
$PATH .= delete( $ENV{ 'Path' } ) if (exists $ENV{ 'Path' });
760
$PATH .= delete( $ENV{ 'path' } ) if (exists $ENV{ 'path' });
761
$PATH .= delete( $ENV{ 'PATH' } ) if (exists $ENV{ 'PATH' });
277 dpurdie 762
$ENV{'PATH'} = $PATH;
227 dpurdie 763
 
764
#
765
#   Windows now defines ComSpec. This is only a problem when programs are
766
#   started up without the use of cmd.exe - like the JATS internal sh.exe
767
#   Correct by deleting the environment variable and forcing it to be uppercase
768
#
769
my $COMSPEC = '';
770
$COMSPEC = delete( $ENV{'COMSPEC'} ) if ( exists $ENV{'COMSPEC'} );
771
 
772
################################################################################
773
#   There is some really ugly interaction between Cygwin, ActiveState Perl 5.8.2
774
#   and xmake. Even if none of the cygwin bits are used within JATS the fact that
775
#   Cygwin is in the path causes problems.
776
#
777
#   Problems seen:
778
#       1) "jats build"     xmake fails with a segment fault. Possibly when
779
#                           displaying an error message
780
#       2) Warnings and messages generated from within Perl don't always appear
781
#          In particular. The output from a Message() within a PLATFORM/xxx file
782
#          does not get displayed.
783
#
784
#   Solution:
785
#       Remove cygwin from the PATH
786
#
787
$PATH =~ s~c:\\cygwin[^;]*;~~ig;
788
 
789
################################################################################
297 dpurdie 790
#   Setup the default JAVA_HOME
791
#   User should specify 1.4, 1.5,1.6 ....
792
#
793
$JAVA_HOME = get_java_home ($opt_java)
794
    if ( $opt_java );
795
PathPrepend ("$JAVA_HOME/bin")
796
    if ( -d $JAVA_HOME );
797
 
798
 
799
################################################################################
227 dpurdie 800
#   Ensure that the PATH contains the PERL executable
801
#   Need to true path to the PERL executable so that the user has access to some
802
#   of the perl utility programs such as pod2html
803
#
299 dpurdie 804
PathPrepend ($Config{'binexp'});
227 dpurdie 805
 
806
################################################################################
807
#   There is more ugliness if GBE_BIN is not in the users path
808
#   I suspect that it something within xmake (under win32) and that it needs
809
#   to be able to find sh within the path - even though its fully pathed
810
#
811
#   Add GBE_BIN to the start of the path to assist in searching
812
#   Also ensure that we pickup our version of utilities instead of random
813
#   versions.
814
#
297 dpurdie 815
PathPrepend ($GBE_BIN);
227 dpurdie 816
 
817
################################################################################
818
#   Clean PATH
819
#       Remove duplicates
820
#       Remove empty elements
821
#       Clean path endings
245 dpurdie 822
#       Place non-existent paths at the end. They will be seen, but not scanned
227 dpurdie 823
#
824
{
825
    my @new_path;
826
    my @non_exist;
827
    my %seen;
828
    foreach ( split $PSPLIT, $PATH )
829
    {
830
        s~[/\\]+$~~;                                # Remove trailing / or \
831
        my $name = ( $GBE_UNIX ) ? $_ : lc ($_);    # Windows is case insensitive
832
        next unless ( $_ );                         # Remove empty elements
833
        next if ( /^\.+$/ );                        # Remove . and ..
834
        next if ( exists $seen{$name} );            # Remove duplicates
835
        if ( -d $_ ) {
836
            push @new_path, $_;                     # Exists
837
        } else {
245 dpurdie 838
            push @non_exist, $_;                    # Place non existent paths at the end
227 dpurdie 839
        }
840
        $seen{$name} = 1;
841
    }
842
    $PATH = join( $PSPLIT, @new_path, @non_exist );
843
}
844
 
845
################################################################################
846
#   Windows: Ensure that cmd.exe is in the users PATH
847
#            If cmd.exe cannot be found then the 'system' command will not work
848
#
849
unless ( $GBE_UNIX )
850
{
851
    my $cmd_found;
852
    foreach ( split $PSPLIT, $PATH )
853
    {
854
        my $file = $_ . "/cmd.exe";
855
        Verbose2 ("Look for: $file");
856
        if ( -x $file  )
857
        {
858
            $cmd_found = 1;
859
            Verbose ("Found: $file");
860
            last;
861
        }
862
    }
863
 
864
    Warning( "Users PATH does not contain \"cmd.exe\"",
865
             "System commands may not work" ) unless $cmd_found;
866
}
867
 
868
################################################################################
869
#   Sanitize the Microsoft Visual Studio environment variables LIB and INCLUDE.
870
#   If these have a trailing \ then the generated makefiles
871
#   will fail. This is impossible to detect and fix within make so do it here
872
#
873
#   Note: JATS no longer allows these environment variables through to the
874
#         makefiles.
875
#
876
unless ( $GBE_UNIX )
877
{
878
    for my $var qw ( LIB INCLUDE )
879
    {
880
        my $evar = $ENV{$var};
881
        if ( $evar )
882
        {
883
            $evar =~ s~\\;~;~g;         # Remove trailing \ from components \; -> ;
884
            $evar =~ s~\\$~~;           # Remove trailing \
885
            $evar =~ s~;$~~;            # Remove trailing ;
886
            $evar =~ s~;;~;~g;          # Remove empty items ;;
887
            $ENV{$var} = $evar;
888
        }
889
    }
890
}
891
 
892
################################################################################
297 dpurdie 893
#   Update the environment variables used by JATS, unless requested otherwise.
227 dpurdie 894
#
277 dpurdie 895
#   If JATS is being used to startup build daemons, then we don't want to
896
#   export many of the calculated values into the environment. In particular
897
#   GBE_CORE, GBE_BIN, GBE_CONFIG and GBE_TOOLS must not be exported as it will
898
#   prevent the daemon from picking up the 'current' version of JATS
899
#
900
#
287 dpurdie 901
 
277 dpurdie 902
if ( $opt_export_vars )
903
{
904
    $ENV{'PATH'}              = $PATH;
905
    $ENV{'GBE_VERSION'}       = $GBE_VERSION;
906
    $ENV{'GBE_CORE'}          = $GBE_CORE;
907
    $ENV{'GBE_BIN'}           = $GBE_BIN;
908
    $ENV{'GBE_CONFIG'}        = $GBE_CONFIG;
909
    $ENV{'GBE_DPLY'}          = $GBE_DPLY;
910
    $ENV{'GBE_DPKG'}          = $GBE_DPKG;
911
    $ENV{'JATS_HOME'}         = $GBE_DPKG;
912
    $ENV{'GBE_DPKG_CACHE'}    = $GBE_DPKG_CACHE;
913
    $ENV{'GBE_DPKG_STORE'}    = $GBE_DPKG_STORE;
914
    $ENV{'GBE_DPKG_LOCAL'}    = $GBE_DPKG_LOCAL;
915
    $ENV{'GBE_SANDBOX'}       = $GBE_SANDBOX;
916
    $ENV{'GBE_DPKG_SBOX'}     = $GBE_DPKG_SBOX;
917
    $ENV{'GBE_PERL'}          = $GBE_PERL;
918
    $ENV{'GBE_TOOLS'}         = $GBE_TOOLS;
919
    $ENV{'GBE_MACHTYPE'}      = $GBE_MACHTYPE;
920
    $ENV{'GBE_HOSTMACH'}      = $GBE_HOSTMACH;
921
    $ENV{'GBE_PLATFORM'}      = $GBE_PLATFORM;
922
    $ENV{'GBE_DRV'}           = $GBE_DRV;
923
    $ENV{'PERL5LIB'}          = $PERL5LIB;
924
    $ENV{'JAVA_HOME'}         = $JAVA_HOME if ($JAVA_HOME);
925
    $ENV{'GBE_JATS_SANE'}     = 1;
926
}
287 dpurdie 927
else
928
{
929
    #
930
    #   Delete, from the environment, values that are related to selecting
931
    #   the version of JATS being used
932
    #
933
    foreach ( qw( GBE_VERSION GBE_CORE GBE_BIN GBE_CONFIG GBE_TOOLS GBE_DRV PERL5LIB GBE_DPKG_SBOX GBE_SANDBOX GBE_PLATFORM GBE_JATS_SANE ) )
934
    {
935
        delete $ENV{$_};
936
    }
937
}
277 dpurdie 938
 
939
#
940
#   The following don't affect the operation of the build daemons selecting
941
#   the current version of JATS. Some need to be passed through anyway
942
#
227 dpurdie 943
$ENV{'GBE_BUILDFILTER'}   = $GBE_BUILDFILTER;
277 dpurdie 944
$ENV{'GBE_ABT'}           = $GBE_ABT if ($GBE_ABT);
227 dpurdie 945
$ENV{'GBE_DEBUG'}         = $GBE_DEBUG;
946
$ENV{'GBE_VERBOSE'}       = $GBE_VERBOSE;
947
$ENV{'GBE_UNIX'}          = $GBE_UNIX;
948
$ENV{'USER'}              = $USER;
277 dpurdie 949
$ENV{'COMSPEC'}           = $COMSPEC;
279 dpurdie 950
$ENV{'GBE_HOSTNAME'}      = $GBE_HOSTNAME;
227 dpurdie 951
 
952
#-------------------------------------------------------------------------------
297 dpurdie 953
# Function        : PathPrepend
954
#
955
# Description     : Prepend stuff to the PATH
956
#
957
# Inputs          : Items to prepend
958
#
959
# Returns         : Nothing
960
#                   Modifies $PATH
961
#
962
sub PathPrepend
963
{
299 dpurdie 964
    foreach my $el ( @_ )
297 dpurdie 965
    {
299 dpurdie 966
        # Must NOT change the original argument, just a copy of it.
967
        # Don't use $_ as this messes up too
968
        my $item = $el;
297 dpurdie 969
        $item =~ s~/~\\~g unless ( $GBE_UNIX );
970
        $PATH = $item . $PSPLIT . $PATH;
971
    }
972
}
973
 
974
#-------------------------------------------------------------------------------
229 dpurdie 975
# Function        : LocateJatsVersion
976
#
245 dpurdie 977
# Description     : Scan archives looking for a specified version of JATS
229 dpurdie 978
#                   Complicated by the name change from core_devl to jats
245 dpurdie 979
#                   that occurred circa version 2.71.7.
229 dpurdie 980
#                   The required version may be in either of the packages
981
#
982
# Inputs          : $version            - Version to locate
983
#
984
# Returns         : undef               - if not found
985
#                   Array of:
986
#                       Repository
987
#                       package/version
988
#
989
sub LocateJatsVersion
990
{
991
    my ($version) = @_;
992
    my $package;
993
    my $path;
994
 
995
    foreach my $archive qw ( GBE_DPKG_LOCAL GBE_DPKG_CACHE GBE_DPKG GBE_DPKG_STORE )
996
    {
997
        no strict 'refs';
998
        $path = ${$archive};
999
        use strict 'refs';
1000
        next unless ( $path );
1001
 
1002
        foreach my $package qw( jats core_devl )
1003
        {
1004
            Verbose2( "ExamineDir: $path/$package/$version" );
1005
            if ( -d "$path/$package/$version" )
1006
            {
283 dpurdie 1007
                return $path, "$package/$version";
229 dpurdie 1008
            }
1009
        }
1010
    }
283 dpurdie 1011
    return;
229 dpurdie 1012
}
1013
 
1014
 
1015
#-------------------------------------------------------------------------------
227 dpurdie 1016
# Function        : TestDirectoryConfig
1017
#
1018
# Description     : Sanity test a user configurable directory or file
1019
#                   Must not contain spaces
1020
#                   Must not be a network drive ie: //computer
1021
#
1022
# Inputs          :
1023
#
1024
# Returns         :
1025
#
1026
sub TestDirectoryConfig
1027
{
1028
    my ($dir) = @_;
1029
 
1030
    no strict 'refs';
1031
    my $val = ${$dir};
1032
 
1033
    if ( $val )
1034
    {
1035
        #
1036
        #   Cleanup the path
1037
        #
1038
        $val =~ tr~\\/~/~s;
1039
        $val =~ s~/+$~~;
255 dpurdie 1040
        $val = '' if ( $val eq '-' || $val eq 'none' );
227 dpurdie 1041
        ${$dir} = $val;
1042
 
1043
        ReportError("$dir path cannot contain spaces: $val") if ( $val =~ m/\s/ );
1044
        ReportError("$dir path cannot be a computer name: $val") if ( $val =~ m~^//~  );
1045
    }
1046
    use strict 'refs';
283 dpurdie 1047
    return;
227 dpurdie 1048
}
1049
 
1050
#-------------------------------------------------------------------------------
1051
# Function        : change_dir
1052
#
1053
# Description     : change directory to the specified directory
1054
#
1055
# Inputs          : $1      - Target directory
1056
#
1057
# Returns         :
1058
#
1059
sub change_dir
1060
{
1061
    my ($dir) = @_;
1062
 
1063
    if ( $dir && $dir !~ m/^\.$/ )
1064
    {
1065
        Verbose ("Changing to JATS build directory: $dir");
1066
        chdir $dir || Error ("Bad change directory: $dir");
1067
    }
1068
 
1069
    #
1070
    #   Reset the CWD
1071
    #   Note: Don't use `pwd`. This sucks for so many reasons including
1072
    #         the fact that it may not be available until this wrapper
1073
    #         script has done it job.
1074
    #
1075
    $CWD = getcwd();
1076
    $CWD =~tr~\\/~/~s;
1077
    Warning ("Current working directory contains spaces") if ( $CWD =~ m/\s/ );
283 dpurdie 1078
    return;
227 dpurdie 1079
}
1080
 
1081
#-------------------------------------------------------------------------------
277 dpurdie 1082
# Function        : scan_for_dir
1083
#
1084
# Description     : Scan from the current directory up to the root
1085
#                   of the current file system looking for a named
1086
#                   directory
1087
#
1088
# Inputs          : $target                 - Directory to locate
1089
#
1090
# Returns         : full_path               - Path of dir
1091
#                   full_dir                - Containng dir
1092
#
1093
 
1094
sub scan_for_dir
1095
{
1096
    my ($target) = @_;
1097
    Verbose2 ("Scan for $target");
1098
 
1099
    my $test_dir = $CWD;
1100
    {
1101
        do
1102
        {
1103
            #
1104
            #   Stop at /home to prevent unix automounter spitting
1105
            #   lots of error messages
1106
            #
1107
            last if ( $test_dir =~ m~/home$~ );
1108
            Verbose2 ("Testing: $test_dir");
1109
 
1110
            my $test_path = $test_dir . '/' . $target;
1111
            if ( -d $test_path )
1112
            {
1113
                Verbose ("Found $target: $test_path");
1114
                return $test_path, $test_dir;
1115
            }
1116
            #
1117
            #   Remove one directory
1118
            #   Terminate the loop when no more can be removed
1119
            #
1120
        } while ( $test_dir =~ s~[/][^/]*$~~ );
1121
    }
1122
    return '','';
1123
}
1124
 
1125
#-------------------------------------------------------------------------------
227 dpurdie 1126
# Function        : get_java_home
1127
#
1128
# Description     : Convert user java option into a full path,or die
1129
#
1130
# Inputs          : User option
1131
#
1132
# Returns         : Full path
1133
#
1134
sub get_java_home
1135
{
1136
    my ($java) = @_;
1137
    my $jv = "JAVA_HOME_$java";
1138
    $jv =~ s~\.~_~g;
1139
 
1140
    unless ( exists($ENV{$jv}) )
1141
    {
1142
        Error ("Unknown JAVA version: $java",
1143
               "Looking for EnvVar: $jv",
1144
               "Example Usage: -java=1.5");
1145
    }
1146
    my $rv = $ENV{$jv};
1147
    unless ( -d $rv )
1148
    {
1149
        Error ("Java home path not found: $jv",
1150
               "Looking for: $rv" );
1151
    }
1152
    return $rv;
1153
}
1154
 
1155
#-------------------------------------------------------------------------------
1156
# Function        : get_version
1157
#
1158
# Description     : Return the version of JATS being run
1159
#                   JATS should be run from a "package"
1160
#                   The package should have a descpkg file
1161
#                   Use this file
1162
#
1163
# Inputs          :
1164
#
1165
# Returns         : A string
1166
#
1167
sub get_version
1168
{
229 dpurdie 1169
    #
1170
    #   The version number is embedded into this script by the release process
1171
    #   The text [V]ERSION_TAG will be replaced by the real version number
245 dpurdie 1172
    #   If this has not occurred then we know that the release is not official
229 dpurdie 1173
    #   Need to be a little bit careful about the tag name
1174
    #
1175
    return ("Unreleased Version. Version tag has not been set")
1176
        if ( $GBE_NOT_RELEASED );
1177
 
227 dpurdie 1178
    return "$GBE_VERSION [ Internal. Not an installed package ]"
1179
        if ( ! -f "$GBE_CORE/descpkg" );
1180
 
1181
    my $rec;
1182
    return $rec->{'VERSION_FULL'}
1183
        if ($rec = ReadDescpkg ( "$GBE_CORE/descpkg" ) );
1184
 
1185
    return "ERROR";
1186
}
1187
 
1188
#-------------------------------------------------------------------------------
1189
# Function        : print_version
1190
#
1191
# Description     :
1192
#
1193
# Inputs          :
1194
#
1195
# Returns         :
1196
#
1197
sub print_version
1198
{
1199
    #
1200
    #   Allow user to specify verboseness as an argument
1201
    #
1202
    foreach  ( @_ )
1203
    {
1204
        $GBE_VERBOSE++ if ( m/^-v/ );
1205
    }
1206
 
1207
    Message get_version();
1208
    Message "Internal: $GBE_VERSION" if ($GBE_VERBOSE);
1209
    $opr_done = 1;
283 dpurdie 1210
    return;
227 dpurdie 1211
}
1212
 
1213
 
1214
#-------------------------------------------------------------------------------
1215
#
1216
#   Give the user a clue
1217
#
1218
sub help
1219
{
1220
    my ($level) = @_;
1221
    $level = $opt_help unless ( $level );
1222
 
1223
    pod2usage(-verbose => 0, -message => "Version: ". get_version())  if ($level == 1 );
261 dpurdie 1224
    pod2usage(-verbose => $level - 1 );
227 dpurdie 1225
}
1226
 
1227
#-------------------------------------------------------------------------------
309 dpurdie 1228
# Function        : find_jats_dir
227 dpurdie 1229
#
309 dpurdie 1230
# Description     : Find a JATS build directory
1231
#                   Can be supressed with JATS '-here' command line option
227 dpurdie 1232
#
309 dpurdie 1233
# Inputs          : files               - Files to look for
1234
#                   options
1235
#                       --Ant           - Allow Ant files too
295 dpurdie 1236
#
309 dpurdie 1237
# Returns         : Will not return if not found
1238
#                   Will 'cd' to the build directory
1239
#
227 dpurdie 1240
sub find_jats_dir
1241
{
309 dpurdie 1242
    my $allow_ant;
1243
    my @FILES;
1244
    my $DIR;
1245
    my $check_file;
1246
 
227 dpurdie 1247
    #
1248
    #   Autodetect suppressed ?
1249
    #
1250
    return if ( $opt_here );
1251
 
309 dpurdie 1252
    #
1253
    #   Collect options
1254
    #   Collect the rest of the arguments
1255
    #
1256
    foreach ( @_ )
1257
    {
1258
        if ( m/^--Ant/ ) {
1259
            $allow_ant = 1;
1260
        }
1261
        else {
1262
            push @FILES, $_;
1263
        }
1264
    }
1265
 
227 dpurdie 1266
    push @FILES, @BUILD_FILE_ALT;
309 dpurdie 1267
    push @FILES, 'build.xml' if ( $allow_ant );
1268
 
1269
    #
1270
    #   Parent directories to search
1271
    #   Child dirs to search
1272
    #
227 dpurdie 1273
    my @SEARCH = qw( . .. ../.. ../../.. );
309 dpurdie 1274
    my @CHILD  = ('', '/jats', '/build', '/build/jats' );
227 dpurdie 1275
 
1276
    #
1277
    #   Locate the JATS build files
1278
    #   Allow the user to be in a number of parent directories
1279
    #
309 dpurdie 1280
    scan:
227 dpurdie 1281
    for my $ROOTDIR (@SEARCH)
1282
    {
309 dpurdie 1283
        for my $SUBDIR (@CHILD)
227 dpurdie 1284
        {
309 dpurdie 1285
            $DIR = $ROOTDIR . $SUBDIR;
227 dpurdie 1286
            next unless -d $DIR;
1287
 
283 dpurdie 1288
            for my $FILE ( @FILES)
227 dpurdie 1289
            {
309 dpurdie 1290
                $check_file = $DIR . '/' . $FILE;
227 dpurdie 1291
                Verbose2 ("Check for: $check_file");
309 dpurdie 1292
                last scan if ( -f $check_file );
1293
            }
1294
 
1295
            next unless ( $allow_ant );
1296
            foreach ( glob($DIR . '/*depends.xml' ) )
1297
            {
1298
                Verbose2 ("Check for: $_");
1299
                if ( m/(.+)depends.xml/ )
227 dpurdie 1300
                {
309 dpurdie 1301
                    $check_file = "$1.xml";
1302
                    last scan if ( -f $check_file );
227 dpurdie 1303
                }
1304
            }
1305
        }
309 dpurdie 1306
        $DIR = '';
227 dpurdie 1307
    }
309 dpurdie 1308
 
1309
    #
1310
    #   Change to the build directory if one has been found
1311
    #
1312
    if ( $DIR )
1313
    {
1314
        Verbose2 ("Found check file: $check_file");
1315
        change_dir ( $DIR );
1316
    }
1317
    else
1318
    {
1319
        Error ( 'JATS build directory not found.',
1320
                "Cannot locate: @FILES",
1321
                $allow_ant ? 'or Ant <Package>.xml <Package>depends.xml pair' : undef,
1322
                'Use -here option to supress this test'
1323
                );
1324
    }
227 dpurdie 1325
}
1326
 
1327
#-------------------------------------------------------------------------------
1328
#
295 dpurdie 1329
#   Determine the real build file to use
1330
#   Will select from a list of known build files.
227 dpurdie 1331
#
295 dpurdie 1332
sub getBuildFile
227 dpurdie 1333
{
1334
    my $build_file = $BUILD_FILE;
1335
    #
1336
    #   Use an alternative buildfile - if it exists
1337
    #   Do not use this file if the user has specified a buildfile
1338
    #
1339
    unless ( $BUILD_FILE_SET )
1340
    {
1341
        Verbose ("Search for alternate build file");
1342
        foreach my $test_file ( @BUILD_FILE_ALT )
1343
        {
1344
            Verbose2 ("Search for alternate build file: $test_file");
1345
            if ( -f $test_file )
1346
            {
1347
                $build_file = $test_file;
1348
                Message ("=== USING ALTERNATE BUILDFILE: $build_file ===");
1349
                last;
1350
            }
1351
        }
1352
    }
295 dpurdie 1353
   return $build_file;
1354
}
227 dpurdie 1355
 
295 dpurdie 1356
#-------------------------------------------------------------------------------
1357
#
1358
#   Kick off the build process
1359
#
1360
sub build
1361
{
1362
    my $build_file = $BUILD_FILE;
1363
    (my $name = $CWD) =~ s~^.*/~~ ;
1364
    $opr_done = 1;
1365
 
1366
    find_jats_dir($build_file);
1367
    Message ("=== Building $name ===");
1368
    $build_file = getBuildFile();
1369
 
227 dpurdie 1370
    #
1371
    #   Jats/make does not handle file systems with spaces in the path names
1372
    #
1373
    Error('$CWD path cannot contain spaces') if ( $CWD =~ m/\s/ );
1374
 
1375
    $RESULT = System ($GBE_PERL, $build_file, $CWD, "$GBE_TOOLS/buildlib.pl", "--project", @_ );
1376
 
283 dpurdie 1377
    Message ("=== Build $name NOT complete ===") if     ( $RESULT  );
1378
    Message ("=== Build $name complete ===")     unless ( $RESULT );
227 dpurdie 1379
    return $RESULT
1380
}
1381
 
1382
#-------------------------------------------------------------------------------
1383
# Function        : bmake_it
1384
#
1385
# Description     : Combo build and make operations
1386
#
1387
# Inputs          : ...     - COMMANDS or Make arguments.
1388
#                             Key commands are BUILD and INSTALL
1389
#
1390
# Returns         : RESULT code
1391
#
1392
sub bmake_it
1393
{
1394
    my @make_args = @_;
1395
    my $all = 1;
1396
    my $msg;
1397
    $opr_done = 1;
1398
 
1399
    if ( $make_args[0] && $make_args[0] eq 'NOTALL' )
1400
    {
1401
        $all = 0;
1402
        shift @make_args;
1403
    }
1404
    elsif ( $make_args[0] && $make_args[0] eq 'BUILD' )
1405
    {
1406
        Verbose ("Makeit build") ;
1407
        $msg = "Component not built";
1408
        build();
1409
        shift @make_args;
1410
    }
1411
 
1412
    unless ( $RESULT )
1413
    {
1414
        push @make_args, '-default=all' if ( $all );
1415
        Verbose ("Makeit make @make_args") ;
1416
 
309 dpurdie 1417
        find_jats_dir( 'makefile.pl', 'Makefile.gbe', $BUILD_FILE );
227 dpurdie 1418
        Error ("No Makefile.gbe file found") unless ( -f 'Makefile.gbe' );
1419
 
1420
        etool ( 'jmake.pl', @make_args );
1421
        $msg = "Component not made";
1422
        @make_args = ();
1423
    }
1424
 
1425
 
1426
    Verbose ("Makeit Result: $RESULT") ;
1427
    Error ( $msg ) if ( $RESULT );
1428
    return  if ( $RESULT );
1429
}
1430
 
1431
#-------------------------------------------------------------------------------
1432
# Function        : dev_expand
1433
#
1434
# Description     : Expand the users arguments to the "debug/prod" command
1435
#                   "debug/prod" builds and packages debug stuff
1436
#
1437
#                   Ignore make options.
1438
#
1439
# Inputs          : target
1440
#                   Argument list
1441
#
1442
# Returns         : expanded argument list
1443
#
1444
sub dev_expand
1445
{
1446
    my @resultd;
1447
    my @resultp;
1448
    my @args;
1449
    my @opts;
1450
 
1451
    #
1452
    #   Remove options from the argument list
1453
    #
1454
    foreach ( @_ )
1455
    {
1456
        if ( m~=~ || m~^-~ ) {
1457
            push @opts, $_;
1458
        } else {
1459
            push @args, $_;
1460
        }
1461
    }
1462
 
1463
    my $target = shift @args;
1464
    my @cmd = $target;
1465
    if ( $#args < 0 )
1466
    {
1467
        push @cmd, "package_$target";
1468
    }
1469
    else
1470
    {
1471
        foreach ( @args )
1472
        {
1473
            push @resultd, $_ . "_$target";
1474
            push @resultp, $_ . "_package_$target";
1475
            @cmd = ();
1476
        }
1477
    }
1478
 
1479
    return (@cmd, @resultd, @resultp, @opts);
1480
}
1481
 
1482
#-------------------------------------------------------------------------------
1483
# Function        : install_pkg
1484
#
1485
# Description     : Install the built package into local_dpkg_archive
1486
#                   This will make it available for use, without populating the
1487
#                   global archive
1488
#
1489
#                   This is done through an external utility to maintain
1490
#                   consistent interface
1491
#
1492
sub install_pkg
1493
{
1494
 
309 dpurdie 1495
    find_jats_dir($BUILD_FILE, '--Ant');
227 dpurdie 1496
    etool ( 'create_dpkg.pl', '-archive=local', '-quiet', '-override',  @_ );
1497
}
1498
 
1499
#-------------------------------------------------------------------------------
1500
# Function        : create_dpkg
1501
#
1502
# Description     : Install a package into the main dpkg_archive
1503
#                   This is done through an external utility to maintain
1504
#                   consistent interface
1505
#
1506
#                   This function is simply an easy way to access the utility
1507
 
1508
sub create_dpkg
1509
{
309 dpurdie 1510
    find_jats_dir($BUILD_FILE, '--Ant');
227 dpurdie 1511
    etool ( 'create_dpkg.pl',  @_ );
1512
}
1513
 
1514
#-------------------------------------------------------------------------------
1515
# Function        : etool
1516
#
1517
# Description     : Invoke an external tool program written in PERL
1518
#
1519
# Arguments       : $1  Name of the program to run
1520
#                       With optional .pl suffix
1521
#                   $2+ Program arguments
1522
#
1523
sub etool
1524
{
1525
    my $command = shift;
1526
    my $cmd;
1527
    my @etool_path = ( "$ENV{'GBE_TOOLS'}",
1528
                       "$ENV{'GBE_TOOLS'}/DEPLOY",
1529
                       "$ENV{'GBE_TOOLS'}/LOCAL" );
1530
    if ( $command )
1531
    {
1532
        #
1533
        #   Locate a potential tool
1534
        #   These will have the user name or a .pl extension
1535
        #
1536
        ETOOL_SEARCH:
1537
        foreach my $ext ( '', '.pl' )
1538
        {
1539
            foreach my $dir ( @etool_path )
1540
            {
297 dpurdie 1541
                $cmd = "$dir/jats_$command$ext";
1542
                last ETOOL_SEARCH if ( -f $cmd );
1543
 
227 dpurdie 1544
                $cmd = "$dir/$command$ext";
1545
                last ETOOL_SEARCH if ( -f $cmd );
1546
            }
1547
            $cmd='';
1548
        }
1549
 
1550
        Error ("Tool not found: $command", "Search path:", @etool_path) unless $cmd;
1551
        $RESULT = System ( $GBE_PERL, $cmd, @_ );
1552
    }
1553
    else
1554
    {
1555
        #
1556
        #   Display on the .pl commands
1557
        #
1558
        display_commands("Available Tools", \@etool_path, ['*.pl'] );
1559
    }
1560
 
1561
    $opr_done = 1;
1562
}
1563
 
1564
#-------------------------------------------------------------------------------
1565
# Function        : ebin
1566
#
1567
# Description     : Invoke an external JATS provided binary
1568
#                   within the JATS toolset
1569
#
1570
# Arguments       : $1  Name of the program to run
1571
#                   $2+ Program arguments
1572
#
1573
sub ebin
1574
{
1575
    my $command = shift;
1576
    my $cmd;
1577
    my @ebin_path = ( "$GBE_BIN" );
1578
 
1579
    if ( $command )
1580
    {
1581
        #
1582
        #   Locate a potential executable
1583
        #   This
1584
        #
1585
        ETOOL_SEARCH:
1586
        foreach my $ext ( '', '.exe', '.sh' )
1587
        {
1588
            foreach my $dir ( @ebin_path )
1589
            {
1590
                $cmd = "$dir/$command$ext";
1591
                last ETOOL_SEARCH if ( -f $cmd );
1592
            }
1593
            $cmd='';
1594
        }
1595
 
1596
        Error ("Program not found: $command", "Search path:", @ebin_path) unless $cmd;
1597
        $RESULT = System ( $cmd, @_ );
1598
    }
1599
    else
1600
    {
1601
        #
1602
        #   Display a list of programs
1603
        #
1604
        display_commands("Available Programs", \@ebin_path, ['*'] );
1605
    }
1606
 
1607
    $opr_done = 1;
1608
}
1609
 
1610
#-------------------------------------------------------------------------------
1611
# Function        : eprog
1612
#
1613
# Description     : Invoke an external program
1614
#                   Will detect local .pl files and execute them
1615
#                   Will detect local .jar files and execute them
229 dpurdie 1616
#                   Will detect local .bat files and execute them
227 dpurdie 1617
#
1618
# Arguments       : $1  Name of the program to run
1619
#                   $2+ Program arguments
1620
#
1621
sub eprog
1622
{
229 dpurdie 1623
    Verbose ("eprog: @_");
315 dpurdie 1624
    my $name = fix_command_name (shift @_);
227 dpurdie 1625
    Error ("eprog. No program specified") unless ( $name );
1626
 
229 dpurdie 1627
    $name .= ".pl"     if ( -f "${name}.pl" );
1628
    $name .= ".jar"    if ( -f "${name}.jar" );
1629
    $name .= ".bat"    if ( -f "${name}.bat" );
227 dpurdie 1630
 
229 dpurdie 1631
    #
245 dpurdie 1632
    #   On Windows programs in the CWD will be found
1633
    #   Mimic this behaviour on Unix
229 dpurdie 1634
    #
1635
    $name = "./$name" if ( $name !~ m~/~ && -f "./$name");
1636
 
227 dpurdie 1637
    if ( $name =~ m~\.pl$~ ) {
1638
        $RESULT = System ( $GBE_PERL, $name, @_ );
1639
 
1640
    } elsif ( $name =~  m~\.jar$~ ) {
1641
        $RESULT = System ( "$JAVA_HOME/bin/java", '-jar', $name, @_);
1642
 
1643
    } else {
229 dpurdie 1644
        #
1645
        #   Ensure .bat files are pathed with \, and not / characters
1646
        #   The windows command interpreter does not like /
1647
        #
1648
        $name =~ s~/~\\~g if ( $name =~ m~\.bat$~ );
1649
 
227 dpurdie 1650
        $RESULT = System ( $name, @_ );
1651
    }
1652
 
1653
    $opr_done = 1;
1654
}
1655
 
1656
#-------------------------------------------------------------------------------
1657
# Function        : display_commands
1658
#
1659
# Description     : Display a list of commands from a specified list of dirs
1660
#                   Internal helper function
1661
#
1662
# Inputs          : $title      - Display header
1663
#                   $ref_path   - Ref to an array that contains the search path
1664
#                   $ref_ext    - Ref to an array of valid patterns
1665
#
1666
# Returns         : Nothing
1667
#
1668
sub display_commands
1669
{
1670
    my ( $title, $ref_path, $ref_ext ) = @_;
1671
 
1672
    #
1673
    #   Display a list of commands
1674
    #
1675
    my %list;
1676
    foreach ( @$ref_path )
1677
    {
1678
        foreach my $ext ( @$ref_ext )
1679
        {
1680
            foreach my $file (  glob( "$_/$ext") )
1681
            {
1682
                $file =~ s~.*/~~ unless $GBE_VERBOSE;
1683
                $list{$file} = 1;
1684
            }
1685
        }
1686
    }
1687
 
1688
    my $count = 0;
1689
    my $limit = $GBE_VERBOSE ? 1 : 3;
1690
    print "$title:\n";
1691
    foreach ( sort keys %list )
1692
    {
1693
        printf "%-26s", $_;
1694
        print "\n" if ( !( ++$count % $limit) );
1695
    }
1696
}
1697
 
1698
#-------------------------------------------------------------------------------
315 dpurdie 1699
# Function        : fix_command_name
1700
#
1701
# Description     : Fix a command name parameter
1702
#                   Simplify use of cygwin for some users by allowing
1703
#                   that path of external tools to be a cygwin path
1704
#
1705
# Inputs          : cmd             - command
1706
#
1707
# Returns         : cleaned up version of cmd
1708
#
1709
sub fix_command_name
1710
{
1711
    my ($cmd) = @_;
1712
 
1713
    unless ( $GBE_UNIX )
1714
    {
1715
        #
1716
        #   Cygwin kludge
1717
        #       Replace /cygdrive/DriveLetter/ - with DriveLetter:/
1718
        #       Replace /DriveLetter/          - With DriveLetter:/
1719
        #
1720
        $cmd =~ s~^/cygdrive/([A-Z])/(.*)~$1:/$2~i;
1721
        $cmd =~ s~^/([A-Z])/(.*)~$1:/$2~i;
1722
    }
1723
    return $cmd;
1724
}
1725
 
1726
 
1727
#-------------------------------------------------------------------------------
227 dpurdie 1728
# Function        : run_ant
1729
#
1730
# Description     : Invoke ant
1731
#                   If the current directory looks like an ERG build system, then
1732
#                   create and maintain an auto.xml file. Otherwise simply invoke ant
1733
#
1734
# Inputs          : $1+ program arguments
1735
#
1736
sub run_ant
1737
{
1738
    my $JAVA_HOME = $ENV{JAVA_HOME} || Error ("JAVA_HOME is not defined in the environment");
1739
    my $ANT_HOME  = $ENV{ANT_HOME}  || Error ("ANT_HOME is not defined in the environment" );
1740
 
1741
    #
1742
    #   Detect an ERG formatted build
1743
    #   This will have two files <projectname>.xml and <projectname>depends.xml
1744
    #   Create the 'auto.xml' file only if its not present
1745
    #
1746
    my @ant_arg;
1747
    my @flist;
1748
    my $basename = '';
235 dpurdie 1749
    my $scanner = '*depends.xml';
227 dpurdie 1750
 
1751
    #
1752
    #   Use specified build file to resolve multiple names
1753
    #   Strip any trailing depends.xml to make it user friendly
1754
    #
1755
    if ( $BUILD_FILE_SET )
1756
    {
1757
        $basename = $BUILD_FILE;
1758
        $basename =~ s~\.xml$~~;
1759
        $basename =~ s~depends$~~;
235 dpurdie 1760
        $scanner = "${basename}depends.xml";
227 dpurdie 1761
        Verbose ("Using buildfile: $basename");
1762
    }
1763
 
235 dpurdie 1764
    my @buildlist = glob($scanner);
227 dpurdie 1765
    foreach ( @buildlist )
1766
    {
1767
        if ( m/(.+)depends.xml/ )
1768
        {
1769
            my $pname = $1;
1770
            push @flist, $pname if ( -f "$pname.xml" );
1771
        }
1772
    }
1773
 
1774
    if ( $#flist >= 0 )
1775
    {
1776
        Error ("Multiple depends.xml files found:", @flist,
297 dpurdie 1777
               "Use 'jats -buildfile=name ant ...' to resolve") if ( $#flist > 0 );
227 dpurdie 1778
 
1779
        my $depend = "$flist[0]depends.xml";
1780
        @ant_arg = ('-f', "$flist[0].xml");
1781
 
1782
        Message ("Ant using projectfiles: $flist[0].xml");
1783
 
1784
        #
1785
        #   Check for depends.xml newer than auto.xml.
1786
        #
1787
        my $auto_timestamp   = (stat('auto.xml'))[9] || 0;
1788
        my $depend_timestamp = (stat($depend))[9];
1789
        if ( $depend_timestamp > $auto_timestamp )
1790
        {
1791
            Message ("Creating: auto.xml");
1792
            copy( $depend, 'auto.xml' );
1793
            chmod 0777, 'auto.xml';
1794
        }
1795
    }
1796
    elsif ( $BUILD_FILE_SET  )
1797
    {
1798
        Error ("Specified build file pair not found:", $basename, $basename . "depends.xml");
1799
    }
1800
 
1801
    #
1802
    #   The ant provided startup scripts don't return an exit code under
1803
    #   windows. Invoke ant directly
1804
    #
1805
    launch_ant ( $JAVA_HOME, $ANT_HOME, @ant_arg, @_ );
1806
    $opr_done = 1;
1807
}
1808
 
1809
#-------------------------------------------------------------------------------
1810
# Function        : run_abt
1811
#
1812
# Description     : Invoke auto build tool (older form)
1813
#                   Options for the ABT
1814
#                       --Java=x.x
1815
#                   Invoke ANT for the ABT using a specified version of Java
1816
#                   Do not play with the user environment.
297 dpurdie 1817
#                   Don't stick java path into environment
227 dpurdie 1818
#
1819
# Inputs          : $1+ program arguments
1820
#
1821
sub run_abt
1822
{
279 dpurdie 1823
    my $ABT_JAVA = 'JAVA_HOME_1_6';         # Default version for the ABT
227 dpurdie 1824
    my $JAVA_HOME = $ENV{$ABT_JAVA};
1825
    my $ANT_HOME  = $ENV{ANT_HOME};
1826
    my @abt_arg;
239 dpurdie 1827
    my $buildfile = 'build.xml';
227 dpurdie 1828
 
1829
    ErrorConfig( 'name'    => 'JATS ABT' );
1830
 
1831
    #
239 dpurdie 1832
    #   Use the user specified buildfile
1833
    #
1834
    $buildfile = $BUILD_FILE
1835
        if ( $BUILD_FILE_SET );
1836
 
1837
    #
227 dpurdie 1838
    #   Extract known options
1839
    #
1840
    foreach  ( @_ )
1841
    {
1842
        if ( m/-java=(.*)/ ) {
1843
            $JAVA_HOME = get_java_home($1);
239 dpurdie 1844
 
1845
        } elsif ( m/^-buildfile=(.+)/ ) {
1846
            $buildfile = $1;
1847
 
227 dpurdie 1848
        } else {
1849
            push @abt_arg, $_;
1850
        }
1851
    }
1852
 
1853
    Error ("$ABT_JAVA is not defined in the environment") unless $JAVA_HOME;
1854
    Error ("ANT_HOME is not defined in the environment" ) unless $ANT_HOME;
239 dpurdie 1855
    Error ("Ant buildfile not found: $buildfile" ) unless (-f $buildfile);
227 dpurdie 1856
 
1857
    #
239 dpurdie 1858
    #   Insert correct build file arguments
1859
    #
279 dpurdie 1860
    push @abt_arg, '-buildfile', $buildfile;
1861
 
1862
    #
1863
    #   Add current directory as java library directory, but only if
1864
    #   it contains JAR files.
1865
    #
1866
    push @abt_arg, '-lib', $CWD
1867
        if ( glob ('*.jar') );
239 dpurdie 1868
 
1869
    #
227 dpurdie 1870
    #   Use the ant-launcher to invoke ant directly
1871
    #
1872
    launch_ant ( $JAVA_HOME, $ANT_HOME, @abt_arg );
1873
    $opr_done = 1;
1874
}
1875
 
1876
#-------------------------------------------------------------------------------
1877
# Function        : launch_ant
1878
#
1879
# Description     : Start ANT - with sanity checking
1880
#
1881
# Inputs          : JAVA_HOME
1882
#                   ANT_HOME
1883
#                   @user_args
1884
#
1885
# Returns         : Result Code
1886
#
1887
sub launch_ant
1888
{
1889
    my ($JAVA_HOME, $ANT_HOME, @user_args ) = @_;
1890
 
1891
    Error ("Directory not found: $JAVA_HOME") unless ( -d "$JAVA_HOME" );
1892
    Error ("Program not found: $JAVA_HOME/bin/java") unless ( -e "$JAVA_HOME/bin/java" || -e "$JAVA_HOME/bin/java.exe" );
1893
    Error ("Jar not found: $ANT_HOME/lib/ant-launcher.jar") unless ( -e "$ANT_HOME/lib/ant-launcher.jar" );
1894
    Error ("Directory not found: $ANT_HOME") unless ( -d "$ANT_HOME" );
1895
    Error ("Directory not found: $ANT_HOME/lib") unless ( -d "$ANT_HOME/lib" );
1896
 
1897
    #
1898
    #   Use the ant-launcher to invoke ant directly
1899
    #
1900
    $RESULT = System ( "$JAVA_HOME/bin/java",
1901
                       "-classpath","$ANT_HOME/lib/ant-launcher.jar",
1902
                       "-Dant.home=$ANT_HOME",
1903
                       "org.apache.tools.ant.launch.Launcher",
1904
                       "-lib","$ANT_HOME/lib",
1905
                       @user_args
1906
                       );
1907
 
1908
   return $RESULT;
1909
}
1910
 
1911
 
1912
#-------------------------------------------------------------------------------
1913
#
1914
#   Cleanup the sandbox
1915
#   Perform a "make clobber" then a "build clobber"
1916
#
1917
sub clobber
1918
{
1919
    Message ("=== Removing ======");
1920
    find_jats_dir( $BUILD_FILE );
295 dpurdie 1921
    my $build_file = getBuildFile();
1922
 
227 dpurdie 1923
 
1924
    #
1925
    #   Run a "make clobber" to clean out "everything"
1926
    #
1927
    etool ( 'jmake.pl', 'clobber' )
1928
        if ( -f "Makefile.gbe" );
1929
 
295 dpurdie 1930
    if ( -f $build_file )
227 dpurdie 1931
    {
295 dpurdie 1932
        System ( $GBE_PERL, $build_file, $CWD, "$GBE_TOOLS/buildlib.pl", 'clobber' );
227 dpurdie 1933
    }
1934
    else
1935
    {
1936
        Error ("Cannot clobber. No buildfile found");
1937
    }
1938
 
1939
    Message ("=== Remove complete ===");
1940
    $opr_done = 1;
1941
}
1942
 
1943
#-------------------------------------------------------------------------------
1944
# Function        : do_exit
1945
#
1946
# Description     : Common exit point so that time information can be displayed
1947
#
1948
# Inputs          : Optional exit code
1949
#
1950
# Returns         :
1951
#
1952
sub do_exit
1953
{
1954
    my ($ecode) = @_;
1955
 
1956
    $RESULT = $ecode if ( $ecode );
1957
 
1958
    #..
1959
    #   Determine the runtime
1960
    #
1961
    if ( $opt_time )
1962
    {
1963
        my ($TIMEU, $TIMES) = times;
1964
        $TIMER = time - $TIMER;
1965
        my ($m, $s );
1966
 
1967
        $m = int($TIMER / 60);
1968
        $s = $TIMER - ($m * 60);
1969
 
1970
        Message ( "Times: Real: $m:$s, User: $TIMEU, System: $TIMES");
1971
    }
1972
    #.
1973
    #   Make sure that any important exit code is passed to the user
1974
    #
1975
    Verbose ("ExitCode: $RESULT");
1976
    exit $RESULT;
1977
}
1978
 
1979
########################################################################
1980
#
1981
#   Main body of the script
1982
#
1983
#   Process help and manual options
1984
#       Done after all the setup to ensure that the PATH is correct
1985
#       Done before bombout to give user a chance
1986
#
1987
help() if $opt_help;
1988
ErrorDoExit();  # Exit if any error in setup
1989
ErrorConfig( 'on_exit'    => \&do_exit );
1990
 
1991
#
231 dpurdie 1992
#   Reset operational flags.
1993
#   May have been used by setup
1994
#
1995
$opr_done = 0;
1996
$RESULT = 0;
1997
 
1998
#
227 dpurdie 1999
#   Process user commands
2000
#
263 dpurdie 2001
my $cmd = shift @ARGV || help(1);
227 dpurdie 2002
 
2003
print_version(@ARGV)                    if ( $cmd =~ m/^ver/ );
2004
 
2005
clobber                                 if ( $cmd =~ m/^clobber$/ );
2006
build    (@ARGV)                        if ( $cmd =~ m/^build$/ );
2007
 
2008
bmake_it ('NOTALL', @ARGV)              if ( $cmd =~ m/^[x]*make$/ );
2009
bmake_it (@ARGV)                        if ( $cmd =~ m/^go$/ );
2010
bmake_it (dev_expand('debug', @ARGV) )  if ( $cmd =~ m/^debug$/ );
2011
bmake_it (dev_expand('prod', @ARGV) )   if ( $cmd =~ m/^prod$/ );
2012
bmake_it ("clean", @ARGV)               if ( $cmd =~ m/^clean$/ );
2013
bmake_it ("rebuild", @ARGV)             if ( $cmd =~ m/^rebuild$/ );
2014
bmake_it ('BUILD', @ARGV)               if ( $cmd =~ m/^all$/ );
2015
bmake_it ($cmd, @ARGV )                 if ( $cmd =~ m/^run_unit_tests/ );
2016
 
2017
install_pkg(@ARGV)                      if ( $cmd =~ m/^install$/ );
2018
create_dpkg(@ARGV)                      if ( $cmd =~ m/^create_dpkg$/ );
2019
 
2020
ebin  (@ARGV)                           if ( $cmd =~ m/^ebin/ );
2021
etool (@ARGV)                           if ( $cmd =~ m/^etool/ );
2022
eprog (@ARGV)                           if ( $cmd =~ m/^eprog$/ );
2023
run_ant (@ARGV)                         if ( $cmd =~ m/^ant$/ );
2024
run_abt (@ARGV)                         if ( $cmd =~ m/^abt$/ );
2025
 
299 dpurdie 2026
etool ('cache_dpkg', @ARGV)                         if ( $cmd =~ m/^dpkg/ );
2027
etool ('gen_msprojects', @ARGV)                     if ( $cmd =~ m/^gen_msproject/ );
2028
etool ('jats_ccrelease.pl', @ARGV)                  if ( $cmd =~ m/^cbuild/ );
2029
etool ('jats_ccrelease.pl', @ARGV)                  if ( $cmd =~ m/^release/ );
2030
etool ('jats_ccrelease.pl', '-extractfiles' ,@ARGV) if ( $cmd =~ m/^extractf/ );
2031
etool ('jats_ccrelease.pl', '-extract' ,@ARGV)      if (!$opr_done && $cmd =~ m/^extract/ );
2032
etool ('jats_label', @ARGV)                         if ( $cmd =~ m/^label$/ );
2033
etool ('jats_sandbox', @ARGV)                       if ( $cmd =~ m/^sandbox$/ );
313 dpurdie 2034
etool ('jats_help', @ARGV)                          if ( $cmd =~ m/^help$/ );
315 dpurdie 2035
etool ('jats_vars.pl', @ARGV)                       if ( $cmd =~ m/^var/ );
227 dpurdie 2036
 
2037
etool ($cmd, @ARGV)                     unless ($opr_done); # Pass to etool if not known
2038
 
2039
do_exit();
2040
#.
2041
 
2042
#-------------------------------------------------------------------------------
2043
#   Documentation
2044
#
2045
 
2046
=pod
2047
 
2048
=head1 NAME
2049
 
2050
jats - JATS utility interface tool
2051
 
2052
=head1 SYNOPSIS
2053
 
277 dpurdie 2054
 Usage: jats [opts] command [cmd-options]
227 dpurdie 2055
 
2056
 Where opts:
261 dpurdie 2057
    -h, -h -h, -man=[n] - Help messages with increasing verbosity
227 dpurdie 2058
    -cd dir             - Change to specified directory
2059
    -b file             - Use alternate build file
261 dpurdie 2060
    -verbose[=n]        - Verbose operation
2061
    -debug[=n]          - Enable debug mode of JATS scripts
227 dpurdie 2062
    -here               - Disable JATS auto locate of build.pl
2063
    -locate             - Locate build.pl file and change to directory
245 dpurdie 2064
    -locatepkg=pkg      - Locate build.pl. Resolve multiple files via pkg
227 dpurdie 2065
    -locatefile=file    - Locate specified file and change to directory
2066
    -platform=[name]    - Set GBE_PLATFORM to name   (=+ to append)
2067
    -buildfilter=[xxx]  - Set GBE_BUILDFILTER to xxx (=+ to append)
2068
    -abt=[xxx]          - Set GBE_ABT to xxx (=+ to append)
2069
    -java=version       - Alters java version used (1.4, 1.5)
2070
    -time               - Time build and compile times
2071
    -version=xxx        - Use specified version of JATS
277 dpurdie 2072
    -[no]exportvars     - Export sanitised JATS EnvVars (default)
227 dpurdie 2073
 
2074
 Where command is one of:
2075
    build               - Rebuild the sandbox and makefiles
2076
    make                - Make one or more components
2077
    ant                 - Invoke an ant build
2078
    abt [-java=xxx]     - Invoke the auto build tool
2079
    install             - Install package into local_dpkg_archive
2080
    help                - Display help message
2081
    vars                - Display JATS related environment variables
2082
 
2083
    create_dpkg         - Install a package into main dpkg_archive
2084
    label               - Labelling functions
2085
    release             - Build a release from a clearcase label
2086
    extract             - Extract a release from a clearcase label
2087
    dpkg_cache          - Maintain a dpkg cache
2088
    gen_msproject       - Generate MSVC project files
299 dpurdie 2089
    sandbox             - Run Sanbox utility
2090
 
227 dpurdie 2091
    etool name          - Run internal tool
2092
    eprog name          - Run external tool
2093
    ebin name           - Run JATS binary tool
2094
 
2095
 Shortcut commands. Composites of basic commands
2096
    all [opt]           - Same as a "build" and "make all"
2097
    go  [opt]           - Same as a "make all"
2098
    debug [tgt]         - Same as "make debug package_debug"
2099
    prod  [tgt]         - Same as "make prod package_prod"
2100
    clean               - Same as "make clean"
2101
    clobber             - Same as "build clobber"
2102
    *                   - Unknown commands are treated as arguments to etool
2103
 
2104
 Where [cmd-options] are command specific.
2105
 Try "jats command -help" for details
2106
 
2107
=head1 OPTIONS
2108
 
2109
=over 8
2110
 
2111
=item B<-help>
2112
 
2113
Print a brief help message and exits.
2114
 
2115
=item B<-help -help>
2116
 
2117
Print a detailed help message with an explanation for each option.
2118
 
261 dpurdie 2119
=item B<-man[=n]>
227 dpurdie 2120
 
2121
Prints the manual page and exits.
2122
 
261 dpurdie 2123
If a numeric manual level is provide then it will be used to control the
2124
verbosity of help provided. This should be inthe range of 1 to 3.
2125
 
227 dpurdie 2126
=item B<-b file> B<-buildfile file>
2127
 
2128
This option modifies the operation of the "build" command. The command will
2129
use the specified file instead of the normal build.pl file.
2130
 
2131
=item B<-cd dir> B<-changedir dir>
2132
 
2133
This option will change to specified directory before the command is invoked.
2134
 
261 dpurdie 2135
=item B<--verbose[=n]>
227 dpurdie 2136
 
2137
This option will increase the level of verbosity of the JATS command and command
261 dpurdie 2138
invoked by the JATS shell.
227 dpurdie 2139
 
261 dpurdie 2140
If an argument is provided, then it will be used to set the level, otherwise the
2141
existing level will be incremented. This option may be specified multiple times.
227 dpurdie 2142
 
261 dpurdie 2143
=item B<-debug[=n]>
2144
 
227 dpurdie 2145
This option will increase the level of debug output of the JATS command and command
261 dpurdie 2146
invoked by the JATS shell.
227 dpurdie 2147
 
261 dpurdie 2148
If an argument is provided, then it will be used to set the level, otherwise the
2149
existing level will be incremented. This option may be specified multiple times.
2150
 
227 dpurdie 2151
=item B<-here>
2152
 
2153
This option will disable the "autolocate" mechanism of the JATS shell script.
2154
 
2155
By default JATS will "hunt" for a suitable "build.pl" or "makefile.pl" before
2156
executing a build or a make command. JATS will look in the following directories
2157
for a  suitable file. Under some conditions this mechanism is not useful.
2158
 
2159
By default JATS will hunt in the following directories: "." "jats" "build/
2160
jats" ".." "../.." and "../../..".
2161
 
2162
=item B<-locate>
2163
 
2164
This option will cause the JATS wrapper script to locate the build.pl file and
2165
then change to that directory. This allows users to locate the build root of
2166
a project and then issue other JATS commands.
2167
 
2168
If the B<-c> option is also specified then searching will start in the specified
2169
directory.
2170
 
2171
If an alternate build file is specified with the B<-b> option then that filename
2172
will be used in the location process.
2173
 
2174
This option implies a B<-here>. No further scanning will be done.
2175
 
2176
Exactly one build file must be located. If more than buildfile is located then
2177
the locations of the build files is displayed and JATS will terminate.
2178
 
245 dpurdie 2179
 
2180
=item B<-locatepkg=packagename>
2181
 
2182
This option is similar to the B<-locate> option, but it allows the required
2183
build files to be located by ensuring that the required buildfile builds the
2184
specified package.
2185
 
2186
There are two forms in which the B<packagename> can be specified. It can be
2187
specified as a full package name and vesrion, or as a package name and the
2188
project suffix. ie: jats-api.1.0.0000.cr or jats-api.cr
2189
 
227 dpurdie 2190
=item B<-locatefile=file>
2191
 
2192
This option is similar to the B<-locate> option, but it allows the name of the
2193
file to be located to be specified.
2194
 
2195
=item B<-platform=[name]>
2196
 
2197
This option will set the JATS specific environment variable GBE_PLATFORM to
2198
the specified name. The existing value of GBE_PLATFORM may be extended by
2199
using "=+".
2200
 
2201
In practice the GBE_PLATFORM variable is of little use. The same effect can be
2202
achieved directly with make targets or with GBE_BUILDFILTER.
2203
 
2204
=item B<-buildfilter=[xxx]>
2205
 
2206
This option will set the JATS specific environment variable GBE_BUILDFILTER to
2207
the specified name. The existing value of GBE_BUILDFILTER may be extended by
2208
using "=+".
2209
 
2210
This option may be used to limit the initial build, and subsequent "make" to a
2211
limited set of platforms.
2212
 
2213
=item B<-abt=[xxx]>
2214
 
2215
This option will set the JATS specific environment variable GBE_ABT to
2216
the specified name The existing value of GBE_ABT may be extended by
2217
using "=+"..
2218
 
2219
This option is used to pass arguments directly to some tools within the
2220
(ABT) Auto Build Tool framework, or to indicate that the build is being
2221
performed within the ABT framework.
2222
 
2223
=item B<-java=version>
2224
 
2225
This option will override the default java version used by the ant builds and
2226
passed to the underlying programs. The path to the Java SDK is determined from
2227
the environment using the version string replacing the '.' with '_'
2228
 
2229
eg: -java=1.5, will examine the environment for JAVA_HOME_1_5 and will set
2230
JAVA_HOME to that value. It will not setup the users PATH or classpath.
2231
 
2232
=item B<-time>
2233
 
2234
When this option is enabled the JATS script will report the runtime of the
2235
underlying, invoked, command.
2236
 
2237
=item B<-version=xxx>
2238
 
2239
When this option is invoked JATS will attempt to use the specified version to
2240
perform all processing. JATS will search the GBE_DPKG_LOCAL, GBE_DPKG_CACHE,
2241
GBE_DPKG, GBE_DPKG_STORE in order to locate the specified version of the package.
2242
 
2243
The entire command line will be passed to the JATS wrapper script within that
2244
version. This bypasses the jats.bat or jats.sh startup scripts.
2245
 
277 dpurdie 2246
JATS will attempt to transfer the target version to the local cache in an
2247
attempt to improve performance.
227 dpurdie 2248
 
277 dpurdie 2249
=item B<-[no]exportvars>
227 dpurdie 2250
 
277 dpurdie 2251
The default operation is to export sanitised and calculated values to the
2252
programs running under JATS. The use of NoExportVars will prevent JATS from
2253
exporting modified EnvVars into the environment. This may be required by
2254
processes, such as the build daemons that need to pick up the current version of
2255
JATS on the fly and not have it fixed when the daemon is started.
227 dpurdie 2256
 
2257
=back
2258
 
2259
=head1 ARGUMENTS
2260
 
2261
=head2 Basic Commands
2262
 
2263
The following commands are invoked directly by the JATS script to wrap the build
2264
tools in a controlled manner.
2265
 
2266
=over 8
2267
 
2268
=item B<build>
2269
 
2270
Build or rebuild the sandbox and makefiles.
2271
 
2272
This command must be used before the component can be "made" and when the
2273
contents of the "buildpl" file change. It is a common mistake to use the "build"
2274
command to much.
2275
 
2276
The script will hunt for a suitable build.pl file before running the build and
2277
make subcommands.
2278
 
2279
The build process has a large number of options. Use "JATS build help" to
2280
display the complete list.
2281
 
2282
=item B<make>
2283
 
2284
Make one or more components
2285
 
2286
This command will invoke a suitable "make" program on the makefile found in
2287
the current directory. This makefile should have been generated by JATS.
2288
 
2289
The make process has a large number of options. Use "JATS make help" to
2290
display the complete list.
2291
 
2292
=item B<ant>
2293
 
2294
This command will use ANT to build a component. JATS will determine the
2295
build.xml file to use with the following algorithm.
2296
 
2297
    If the files called <Project>depends.xml and <Project>.xml exist then JATS
2298
    will create an 'auto.xml' from the depends file, if one does not already
2299
    exist or is older than the depends.xml file and then use the <Project>.xml
2300
    file as the ant build file.
2301
 
2302
    Otherwise ant is invoked and it will expect a build.xml file.
2303
 
2304
If multiple <Project>depends.xml and <Project>.xml file pairs are found the
2305
command will fail. This can be resolved through the use of the -buildfile=name
2306
option.
2307
 
2308
Ant is invoked with the version of Java specified with the -Java=x.x option.
2309
 
2310
=item B<abt>
2311
 
2312
This command is used to invoke the Auto Build Tool. It will invoke ANT on the
2313
build.xml file in the current directory in such  manner as to not affect the
239 dpurdie 2314
environment of the programs running under ANT.
227 dpurdie 2315
 
245 dpurdie 2316
The remained of the command line is passed to the ABT, with the exception of
239 dpurdie 2317
the options:
2318
 
2319
=over 8
2320
 
2321
=item * -java=x.x. This is used to control the version of Java used by the
227 dpurdie 2322
ABT. The default is 1.5.
2323
 
239 dpurdie 2324
=item * -buildfile=name. This is used to provide a different build file to ant.
2325
The default build file is 'build.xml'.
2326
 
2327
=back
2328
 
227 dpurdie 2329
=item B<install>
2330
 
2331
This command will install a generated "package" into the local_dpkg_archive
2332
directory. This allows a group of packages to be tested before being published
2333
into the global dpkg_archive.
2334
 
2335
NOTE. This command is no longer needed. The "build" process will place a
2336
shortcut in the local_dpkg_archive to a components "pkg" directory. Other
2337
components will utilize this shortcut directly and pickup the package without
2338
the user needing to "install" the package - a step that can be forgotten.
2339
 
2340
=item B<help>
2341
 
2342
Display the basic help message.
2343
 
2344
=item B<vars [-v]>
2345
 
2346
This command will display all the JATS related environment variables in a
2347
readable form.
2348
 
2349
Additional information will be displayed if an argument of "-v" is provided.
2350
 
2351
=back
2352
 
2353
=head2 Extended Commands
2354
 
2355
The following commands support the build environment. They are supplemental to
2356
the build environment. They are implemented as extensions to the basic JATS
2357
command scripts.
2358
 
2359
=over 8
2360
 
2361
=item B<create_dpkg>
2362
 
2363
This command will install a generated package into main dpkg_archive. This
2364
command should not be used directly by a user as it does not ensure that package
2365
has been created in a repeatable manner - use "jats release".
2366
 
2367
=item B<label>
2368
 
2369
This command provides a number of useful labelling mechanisms to assist in the
2370
labeling of source code.
2371
 
2372
=item B<release>, B<cbuild>
2373
 
2374
This command allows a package to be built and released, given a Clearcase label.
2375
This is the desired release mechanism.
2376
 
2377
The command has two main uses:
2378
 
2379
=over 8
2380
 
2381
=item 1
2382
 
2383
Build a package for release. The process will ensure that the build is
2384
controlled and repeatable.
2385
 
2386
=item 2
2387
 
2388
Rebuild a package for test or debugging purposes.
2389
 
2390
=back
2391
 
2392
=item B<extract>
2393
 
2394
This is the same as "release -extract"
2395
 
2396
 
2397
=item B<dpkg_cache>
2398
 
2399
This utility provides a number of commands to maintain the local cache of
245 dpurdie 2400
dpkg_archive.
227 dpurdie 2401
 
2402
=item B<gen_msproject>
2403
 
2404
This utility will generate a set of Microsoft Studio (Version 6) project and
2405
workspace files to encapsulate the JATS build. The resultant project allows VS
2406
to be used as an editor, source browser, debugger and build tool. JATS is
2407
still used to perform the build.
2408
 
2409
=item B<etool name>
2410
 
2411
This command allows any JATS extension program to be run. The programs will by
2412
found in the JATS TOOLS directory.
2413
 
2414
=item B<eprog name>
2415
 
2416
This command allows any JATS extension program to be run.
2417
If the program end in .pl, then it will be run within a perl interpreter.
2418
If the program end in .jar, then it will be run under a java interpreter.
2419
 
2420
=item B<ebin name>
2421
 
2422
This command allows any JATS support program to be run. The programs will by
2423
found in the JATS BIN directory for the current platform. This command allows
2424
a user script to access many of the machine independent utilities in a simple
2425
manner.
2426
 
2427
Example: "JATS ebin ls" - will provide a "real" ls on all platforms.
2428
 
2429
Example: "JATS ebin sh" - will start up the shell used by make.
2430
 
2431
=back
2432
 
2433
=head2 Command Shortcuts
2434
 
2435
The following commands are user shortcuts to the basic commands. The are basic
2436
commands run in sequence.
2437
 
2438
=over 8
2439
 
2440
=item B<all [make_opts]>
2441
 
2442
This command is the same as running the command "build" and "make all".
2443
It will build a component with a single command.
2444
 
2445
If "make_opts" is not present then "make all" is used.
2446
 
2447
If "make_opts" is present then they are passed to the "make" command. In this
2448
manner is it possible to build a WIN32 component of package with a single
2449
command.
2450
 
2451
=item B<go [make_opts]>
2452
 
2453
This command is similar to the "all" shortcut, but it does not "build" the
2454
sandbox. It may be used where the sandbox has already been prepared.
2455
 
2456
=item B<debug [target]>
2457
 
2458
This command is the same as running "make debug package_debug". It will make and
2459
package all the debug components of a sandbox.
2460
 
2461
If any additional arguments are provided to the B<dev> command then they will be
2462
treated as make targets and the commands will be expanded to make and package
2463
the specified debug versions of the names platforms. Make options cannot be
2464
passed in this manner.
2465
 
2466
Example: "JATS dev GAK" will create and package the debug parts for the
2467
GAK_MOS68K and GAK_MOSCF.
2468
 
2469
=item B<prod [target]>
2470
 
2471
This command is the same as running "make prod package_prod". It will make and
2472
package all the debug components of a sandbox.
2473
 
2474
If any additional arguments are provided to the B<prod> command then they will be
2475
treated as make targets and the commands will be expanded to make and package
2476
the specified debug versions of the names platforms. Make options cannot be
2477
passed in this manner.
2478
 
2479
Example: "JATS prod GAK" will create and package the production parts for the
2480
GAK_MOS68K and GAK_MOSCF.
2481
 
2482
=item B<clean>
2483
 
2484
This is the same as "make clean".
2485
 
2486
=item B<clobber>
2487
 
2488
This is the same as "build clobber"
2489
 
2490
=item B<else>
2491
 
2492
Commands that are not known to the JATS wrapper script are passed to etool.
2493
 
2494
ie: "JATS xxxx" is is the same as "JATS etool xxxx".
2495
 
2496
=back
2497
 
2498
=head1 DESCRIPTION
2499
 
2500
JATS is a wrapper script. It provides:
2501
 
2502
=over 8
2503
 
2504
=item *
2505
 
315 dpurdie 2506
A controlled and sanitised environment to all the build tools.
227 dpurdie 2507
 
2508
=item *
2509
 
2510
The same command interface on all supported machines: Windows, Solaris and
2511
Linux.
2512
 
2513
=item *
2514
 
2515
Provides a framework for extending the build environment toolset.
2516
 
2517
=back
2518
 
315 dpurdie 2519
=head1 RELATED DOCUMENTATION
227 dpurdie 2520
 
315 dpurdie 2521
=over 0
227 dpurdie 2522
 
315 dpurdie 2523
=item   * InstallationNotes
227 dpurdie 2524
 
315 dpurdie 2525
=item   * OverView
227 dpurdie 2526
 
315 dpurdie 2527
=item   * EnvVars
255 dpurdie 2528
 
315 dpurdie 2529
=item   * PkgArchives
227 dpurdie 2530
 
2531
=back
2532
 
315 dpurdie 2533
Use C<jats help> to see the available internal documentation.
227 dpurdie 2534
 
315 dpurdie 2535
=head1 EXAMPLES
227 dpurdie 2536
 
315 dpurdie 2537
=over 8
227 dpurdie 2538
 
315 dpurdie 2539
=item   JATS help
227 dpurdie 2540
 
315 dpurdie 2541
This will display the available internal documentation.
227 dpurdie 2542
 
2543
=item   JATS build
2544
 
315 dpurdie 2545
This will prime the current package being built ready for "make". The command
2546
will locate the build.pl file and process it. This will locate all the external
2547
packages and generate the required makefiles.
227 dpurdie 2548
 
2549
=item   JATS make
2550
 
2551
This will run the GNU make program over the makefiles generated by the "build"
2552
command. This may be executed in a subdirectory in order to limit the targets
2553
that are "made".
2554
 
2555
B<NOTE:> Do not run "make" without using the JATS wrapper. It will not perform
2556
as expected as the environment will not have been set up correctly.
2557
 
2558
=back
2559
 
2560
=cut
2561