Configure.pl

   1 #! perl
   2
   3 # Copyright (C) 2001-2007, The Perl Foundation.
   4 # $Id$
   5
   6 =head1 NAME
   7
   8 Configure.pl - Parrot's Configuration Script
   9
  10 =head1 SYNOPSIS
  11
  12     % perl Configure.pl [options]
  13
  14 =head1 DESCRIPTION
  15
  16 This is Parrot's configuration program. It should be run to create
  17 the necessary system-specific files before building Parrot.
  18
  19 =head2 Command-line Options
  20
  21 General Options
  22
  23 =over
  24
  25 =item C<--help>
  26
  27 Prints out a description of the options and exits.
  28
  29 =item C<--version>
  30
  31 Prints out the version number of Configure.pl and exits.
  32
  33 =item C<--verbose>
  34
  35 Tells Configure.pl to output extra information about the configuration data it
  36 is setting.
  37
  38 =item C<--verbose=2>
  39
  40 Tells Configure.pl to output information about i<every> setting added or
  41 changed.
  42
  43 =item C<--verbose-step={N|regex}>
  44
  45 Run C<--verbose=2> for step number C<N> or matching description.
  46
  47 =item C<--nomanicheck>
  48
  49 Tells Configure.pl not to run the MANIFEST check.
  50
  51 =item C<--prefix>
  52
  53 Sets the location where parrot will be installed.
  54
  55 =item C<--step=>
  56
  57 Execute a single configure step.
  58
  59 =item C<--languages="list of languages">
  60
  61 Specify a list of languages to process (space separated.)
  62 Used in combination with C<--step=gen::languages> to regenerate makefiles.
  63
  64 =item C<--ask>
  65
  66 This turns on the user prompts.
  67
  68 =item C<--test>
  69
  70 Run certain tests along with F<Configure.pl>:
  71
  72 =over 4
  73
  74 =item C<--test=configure>
  75
  76 Run tests found in F<t/configure/> I<before> beginning configuration.  These
  77 tests demonstrate that Parrot's configuration tools will work properly once
  78 configuration has begun.
  79
  80 =item C<--test=build>
  81
  82 Run tests found in F<t/postconfigure/>, F<t/tools/pmc2cutils/>,
  83 F<t/tools/ops2cutils/> and F<t/tools/ops2pmutils/> I<after> configuration has
  84 completed.  These tests demonstrate (a) that certain of Parrot's configuration
  85 tools are working properly post-configuration; and (b) that certain of
  86 Parrot's build tools will work properly once you call F<make>.
  87
  88 =item C<--test>
  89
  90 Run the tests described in C<--test=configure>, conduct configuration, then
  91 run the tests described in C<--test=build>.
  92
  93 =back
  94
  95 =back
  96
  97 Compile Options
  98
  99 =over
 100
 101 =item C<--debugging=0>
 102
 103 Debugging is turned on by default. Use this to disable it.
 104
 105 =item C<--parrot_is_shared>
 106
 107 Link parrot dynamically.
 108
 109 =item C<--m=32>
 110
 111 Create a 32-bit executable on 64-architectures like x86_64. This
 112 option appends -m32 to compiler and linker programs and does
 113 s/lib64/lib/g on link flags.
 114
 115 This option is experimental. See F<config/init/defaults.pm> for more.
 116
 117 =item C<--profile>
 118
 119 Turn on profiled compile (gcc only for now)
 120
 121 =item C<--cage>
 122
 123 [CAGE] compile includes many additional warnings
 124
 125 =item C<--optimize>
 126
 127 Add perl5's $Config{optimize} to the compiler flags.
 128
 129 =item C<--optimize=flags>
 130
 131 Add C<flags> to the compiler flags.
 132
 133 =item C<--inline>
 134
 135 Tell Configure that the compiler supports C<inline>.
 136
 137 =item C<--cc=(compiler)>
 138
 139 Specify which compiler to use.
 140
 141 =item C<--ccflags=(flags)>
 142
 143 Use the given compiler flags.
 144
 145 =item C<--ccwarn=(flags)>
 146
 147 Use the given compiler warning flags.
 148
 149 =item C<--cxx=(compiler)>
 150
 151 Specify which C++ compiler to use (for ICU).
 152
 153 =item C<--libs=(libs)>
 154
 155 Use the given libraries.
 156
 157 =item C<--link=(linker)>
 158
 159 Specify which linker to use.
 160
 161 =item C<--linkflags=(flags)>
 162
 163 Use the given linker flags
 164
 165 =item C<--ld=(linker)>
 166
 167 Specify which loader to use for shared libraries.
 168
 169 =item C<--ldflags=(flags)>
 170
 171 Use the given loader flags for shared libraries
 172
 173 =item C<--lex=(lexer)>
 174
 175 Specify which lexer to use.
 176
 177 =item C<--yacc=(parser)>
 178
 179 Specify which parser to use.
 180
 181 =item C<--define=val1[,val2]>
 182
 183 Generate "#define PARROT_DEF_VAL1 1" ... entries in has_header.h. Currently
 184 needed to use inet_aton for systems that lack inet_pton:
 185
 186   --define=inet_aton
 187
 188 =back
 189
 190 Parrot Options
 191
 192 =over
 193
 194 =item C<--intval=(type)>
 195
 196 Use the given type for C<INTVAL>.
 197
 198 =item C<--floatval=(type)>
 199
 200 Use the given type for C<FLOATVAL>.
 201
 202 =item C<--opcode=(type)>
 203
 204 Use the given type for opcodes.
 205
 206 =item C<--ops=(files)>
 207
 208 Use the given ops files.
 209
 210 =item C<--pmc=(files)>
 211
 212 Use the given PMC files.
 213
 214 =item C<--cgoto=0>
 215
 216 Don't build cgoto core. This is recommended when you are short of memory.
 217
 218 =item C<--jitcapable>
 219
 220 Use JIT system.
 221
 222 =item C<--execcapable>
 223
 224 Use JIT to emit a native executable.
 225
 226 =item C<--gc=(type)>
 227
 228 Determine the type of garbage collection. The value for C<type> should be one
 229 of: C<gc>, C<libc>, C<malloc> or C<malloc-trace>. The default is C<gc>.
 230
 231 =back
 232
 233 International Components For Unicode (ICU) Options
 234
 235 =over
 236
 237 =item C<--icu-config=/path/to/icu-config>
 238
 239 Use the specified icu-config script to determine the necessary ICU options.
 240
 241 Use --icu-config=none to disable the autodetect feature. Parrot will then be
 242 build without ICU.
 243
 244 B<Note:> If you specify another ICU option than --icu-config, the autodetection
 245 functionality will be disabled.
 246
 247 =item C<--icushared=(linkeroption)>
 248
 249 Linker command to link against ICU library.
 250
 251 E.g.
 252
 253    --icushared='-L /opt/openoffice/program -licudata -licuuc'
 254
 255 (The libs in openoffice are actually version 2.2 and do not work)
 256
 257 =item C<--icuheaders=(header_dir)>
 258
 259 Location of ICU header files without the /unicode suffix.
 260
 261 E.g.
 262
 263 --icuheaders='/home/lt/icu/'
 264
 265 =back
 266
 267 Other Options
 268
 269 =over
 270
 271 =item C<--maintainer>
 272
 273 Use this option if you want imcc's parser and lexer files to be generated.
 274 Needs a working parser and lexer.
 275
 276 =item C<--miniparrot>
 277
 278 Build parrot assuming only pure ANSI C is available.
 279
 280 =back
 281
 282 =head1 SEE ALSO
 283
 284 F<config/init/data.pl>, F<lib/Parrot/Configure/RunSteps.pm>,
 285 F<lib/Parrot/Configure/Step.pm>, F<docs/configuration.pod>
 286
 287 =cut
 288
 289 use 5.008_000;
 290 use strict;
 291 use warnings;
 292 use Data::Dumper;
 293 $Data::Dumper::Indent = 1;
 294 use lib 'lib';
 295
 296 use Parrot::BuildUtil;
 297 use Parrot::Configure;
 298 use Parrot::Configure::Options qw( process_options );
 299 use Parrot::Configure::Options::Test;
 300 use Parrot::Configure::Messages qw(
 301     print_introduction
 302     print_conclusion
 303 );
 304 use Parrot::Configure::Step::List qw( get_steps_list );
 305
 306 my $parrot_version = Parrot::BuildUtil::parrot_version();
 307
 308 $| = 1; # $OUTPUT_AUTOFLUSH = 1;
 309
 310 # Install Option text was taken from:
 311 #
 312 # autoconf (GNU Autoconf) 2.59
 313 # Written by David J. MacKenzie and Akim Demaille.
 314 #
 315 # Copyright (C) 2003 Free Software Foundation, Inc.
 316 # This is free software; see the source for copying conditions.  There is NO
 317 # warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 318
 319 # from Parrot::Configure::Options
 320 my $args = process_options( {
 321     argv            => [ @ARGV ],
 322     script          => $0,
 323     parrot_version  => $parrot_version,
 324     svnid           => '$Id$',
 325 } );
 326 exit unless defined $args;
 327 my %args = %{$args};
 328
 329 my $opttest = Parrot::Configure::Options::Test->new($args);
 330 # configuration tests will only be run if you requested them
 331 # as command-line option
 332 $opttest->run_configure_tests();
 333
 334 # from Parrot::Configure::Messages
 335 print_introduction($parrot_version) unless exists $args{step};
 336
 337 my $conf = Parrot::Configure->new;
 338
 339 # from Parrot::Configure::Step::List
 340 $conf->add_steps(get_steps_list());
 341
 342 # from Parrot::Configure::Data
 343 $conf->options->set(%args);
 344
 345 if ( exists $args{step} ) {
 346     # from Parrot::Configure::Data
 347     $conf->data()->slurp();
 348     $conf->data()->slurp_temp()
 349         if $args{step} =~ /gen::makefiles/;
 350     # from Parrot::Configure
 351     $conf->runstep( $args{step} );
 352     print "\n";
 353 }
 354 else {
 355     # Run the actual steps
 356     # from Parrot::Configure
 357     $conf->runsteps or exit(1);
 358 }
 359
 360 # build tests will only be run if you requested them
 361 # as command-line option
 362 $opttest->run_build_tests();
 363
 364 # from Parrot::Configure::Messages
 365 print_conclusion($conf->data->get('make')) unless exists $args{step};
 366
 367 exit(0);
 368
 369 ################### DOCUMENTATION ###################
 370
 371
 372 # Local Variables:
 373 #   mode: cperl
 374 #   cperl-indent-level: 4
 375 #   fill-column: 100
 376 # End:
 377 # vim: expandtab shiftwidth=4:
 378