5 Permission is hereby granted, free of charge, to any person obtaining
6 a copy of this software and associated documentation files (the
7 "Software"), to deal in the Software without restriction, including
8 without limitation the rights to use, copy, modify, merge, publish,
9 distribute, sublicense, and/or sell copies of the Software, and to
10 permit persons to whom the Software is furnished to do so, subject to
11 the following conditions:
13 The above copyright notice and this permission notice shall be included
14 in all copies or substantial portions of the Software.
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
17 KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 =head1 More on construction environments
30 As previously mentioned, a B<construction environment> is an object that
31 has a set of keyword/value pairs and a set of methods, and which is used
32 to tell Cons how target files should be built. This section describes
33 how Cons uses and expands construction environment values to control its
36 =head2 Construction variable expansion
38 Construction variables from a construction environment are expanded
39 by preceding the keyword with a C<%> (percent sign):
41 Construction variables:
42 XYZZY => 'abracadabra',
44 The string: "The magic word is: %XYZZY!"
45 expands to: "The magic word is: abracadabra!"
47 A construction variable name may be surrounded by C<{> and C<}> (curly
48 braces), which are stripped as part of the expansion. This can
49 sometimes be necessary to separate a variable expansion from trailing
50 alphanumeric characters:
52 Construction variables:
56 The string: "%OPT %{OPT}ION %OPTION %{OPTION}"
57 expands to: "value1 value1ION value2 value2"
59 Construction variable expansion is recursive, that is, a string
60 containing C<%->expansions after substitution will be re-expanded until
61 no further substitutions can be made:
63 Construction variables:
64 STRING => 'The result is: %FOO',
68 The string: "The string says: %STRING"
69 expands to: "The string says: The result is: final value"
71 If a construction variable is not defined in an environment, then the
72 null string is substituted:
74 Construction variables:
78 The string: "%FOO <%NO_VARIABLE> %BAR"
79 expands to: "value1 <> value2"
81 A doubled C<%%> will be replaced by a single C<%>:
83 The string: "Here is a percent sign: %%"
84 expands to: "Here is a percent sign: %"
86 =head2 Default construction variables
88 When you specify no arguments when creating a new construction
93 Cons creates a reference to a new, default construction
94 environment. This contains a number of construction variables and some
95 methods. At the present writing, the default construction variables on a
100 CCCOM => '%CC %CFLAGS %_IFLAGS -c %< -o %>',
102 CXXFLAGS => '%CFLAGS',
103 CXXCOM => '%CXX %CXXFLAGS %_IFLAGS -c %< -o %>',
104 INCDIRPREFIX => '-I',
107 LINKCOM => '%LINK %LDFLAGS -o %> %< %_LDIRS %LIBS',
108 LINKMODULECOM => '%LD -r -o %> %<',
109 LIBDIRPREFIX => '-L',
113 ARCOM => ['%AR %ARFLAGS %> %<', '%RANLIB %>'],
117 ASCOM => '%AS %ASFLAGS %< -o %>',
124 SIGNATURE => [ '*' => 'build' ],
125 ENV => { 'PATH' => '/bin:/usr/bin' },
128 And on a Windows system (Windows NT), the default construction variables
129 are (unless the default rule style is set using the B<DefaultRules>
134 CCCOM => '%CC %CFLAGS %_IFLAGS /c %< /Fo%>',
135 CXXCOM => '%CXX %CXXFLAGS %_IFLAGS /c %< /Fo%>',
136 INCDIRPREFIX => '/I',
139 LINKCOM => '%LINK %LDFLAGS /out:%> %< %_LDIRS %LIBS',
140 LINKMODULECOM => '%LD /r /o %> %<',
141 LIBDIRPREFIX => '/LIBPATH:',
144 ARFLAGS => '/nologo ',
145 ARCOM => "%AR %ARFLAGS /out:%> %<",
148 LDFLAGS => '/nologo ',
152 SUFLIBS => '.dll:.lib',
154 SIGNATURE => [ '*' => 'build' ],
156 These variables are used by the various methods associated with the
157 environment. In particular, any method that ultimately invokes an external
158 command will substitute these variables into the final command, as
159 appropriate. For example, the C<Objects> method takes a number of source
160 files and arranges to derive, if necessary, the corresponding object
163 Objects $env 'foo.c', 'bar.c';
165 This will arrange to produce, if necessary, F<foo.o> and F<bar.o>. The
166 command invoked is simply C<%CCCOM>, which expands, through substitution,
167 to the appropriate external command required to build each object. The
168 substitution rules will be discussed in detail in the next section.
170 The construction variables are also used for other purposes. For example,
171 C<CPPPATH> is used to specify a colon-separated path of include
172 directories. These are intended to be passed to the C preprocessor and are
173 also used by the C-file scanning machinery to determine the dependencies
174 involved in a C Compilation.
176 Variables beginning with underscore are created by various methods,
177 and should normally be considered ``internal'' variables. For example,
178 when a method is called which calls for the creation of an object from
179 a C source, the variable C<_IFLAGS> is created: this corresponds to the
180 C<-I> switches required by the C compiler to represent the directories
181 specified by C<CPPPATH>.
183 Note that, for any particular environment, the value of a variable is set
184 once, and then never reset (to change a variable, you must create a new
185 environment. Methods are provided for copying existing environments for this
186 purpose). Some internal variables, such as C<_IFLAGS> are created on demand,
187 but once set, they remain fixed for the life of the environment.
189 The C<CFLAGS>, C<LDFLAGS>, and C<ARFLAGS> variables all supply a place
190 for passing options to the compiler, loader, and archiver, respectively.
192 The C<INCDIRPREFIX> and C<INCDIRSUFFIX> variables specify option
193 strings to be appended to the beginning and end, respectively, of each
194 include directory so that the compiler knows where to find F<.h> files.
195 Similarly, the C<LIBDIRPREFIX> and C<LIBDIRSUFFIX> variables specify the
196 option string to be appended to the beginning of and end, respectively,
197 of each directory that the linker should search for libraries.
199 Another variable, C<ENV>, is used to determine the system environment during
200 the execution of an external command. By default, the only environment
201 variable that is set is C<PATH>, which is the execution path for a UNIX
202 command. For the utmost reproducibility, you should really arrange to set
203 your own execution path, in your top-level F<Construct> file (or perhaps by
204 importing an appropriate construction package with the Perl C<use>
205 command). The default variables are intended to get you off the ground.
207 =head2 Expanding variables in construction commands
209 Within a construction command, construction variables will be expanded
210 according to the rules described above. In addition to normal variable
211 expansion from the construction environment, construction commands also
212 expand the following pseudo-variables to insert the specific input and
213 output files in the command line that will be executed:
219 The target file name. In a multi-target command, this expands to the
220 first target mentioned.)
226 =item %1, %2, ..., %9
228 These refer to the first through ninth input file, respectively.
232 The full set of input file names. If any of these have been used
233 anywhere else in the current command line (via C<%1>, C<%2>, etc.), then
234 those will be deleted from the list provided by C<%E<lt>>. Consider the
235 following command found in a F<Conscript> file in the F<test> directory:
237 Command $env 'tgt', qw(foo bar baz), qq(
243 If F<tgt> needed to be updated, then this would result in the execution of
244 the following commands, assuming that no remapping has been established for
245 the F<test> directory:
247 echo test/bar test/baz -i test/foo > test/tgt
248 echo test/foo test/baz -i test/bar >> test/tgt
249 echo test/foo test/bar -i test/baz >> test/tgt
253 Any of the above pseudo-variables may be followed immediately by one of
254 the following suffixes to select a portion of the expanded path name:
256 :a the absolute path to the file name
257 :b the directory plus the file name stripped of any suffix
260 :s the file name suffix
261 :F the file name stripped of any suffix
262 :S the absolute path path to a Linked source file
264 Continuing with the above example, C<%E<lt>:f> would expand to C<foo bar baz>,
265 and C<%E<gt>:d> would expand to C<test>.
267 There are additional C<%> elements which affect the command line(s):
273 It is possible to programmatically rewrite part of the command by
274 enclosing part of it between C<%[> and C<%]>. This will call the
275 construction variable named as the first word enclosed in the brackets
276 as a Perl code reference; the results of this call will be used to
277 replace the contents of the brackets in the command line. For example,
278 given an existing input file named F<tgt.in>:
280 @keywords = qw(foo bar baz);
281 $env = new cons(X_COMMA => sub { join(",", @_) });
282 Command $env 'tgt', 'tgt.in', qq(
283 echo '# Keywords: %[X_COMMA @keywords %]' > %>
289 echo '# Keywords: foo,bar,baz' > tgt
294 Cons includes the text of the command line in the MD5 signature for a
295 build, so that targets get rebuilt if you change the command line (to
296 add or remove an option, for example). Command-line text in between
297 C<%(> and C<%)>, however, will be ignored for MD5 signature calculation.
299 Internally, Cons uses C<%(> and C<%)> around include and library
300 directory options (C<-I> and C<-L> on UNIX systems, C</I> and
301 C</LIBPATH> on Windows NT) to avoid rebuilds just because the directory
302 list changes. Rebuilds occur only if the changed directory list causes
303 any included I<files> to change, and a changed include file is detected
304 by the MD5 signature calculation on the actual file contents.
308 XXX DESCRIBE THE Literal() FUNCTION, TOO XXX
310 =head2 Expanding construction variables in file names
312 Cons expands construction variables in the source and target file names
313 passed to the various construction methods according to the expansion
314 rules described above:
317 DESTDIR => 'programs',
320 Program $env '%DESTDIR/hello', '%SRCDIR/hello.c';
322 This allows for flexible configuration, through the construction
323 environment, of directory names, suffixes, etc.
329 An <literal>environment</literal>
330 is a collection of values that
331 can affect how a program executes.
332 &SCons; distinguishes between three
333 different types of environments
334 that can affect the behavior of &SCons; itself
335 (subject to the configuration in the &SConscript; files),
336 as well as the compilers and other tools it executes:
343 <term>External Environment</term>
348 The <literal>external environment</literal>
349 is the set of variables in the user's environment
350 at the time the user runs &SCons;.
351 These variables are available within the &SConscript; files
352 through the Python <literal>os.environ</literal> dictionary.
353 See <xref linkend="sect-external-environments"></xref>, below.
360 <term>&ConsEnv;</term>
366 is a distinct object creating within
367 a &SConscript; file and
368 and which contains values that
369 affect how &SCons; decides
370 what action to use to build a target,
371 and even to define which targets
372 should be built from which sources.
373 One of the most powerful features of &SCons;
374 is the ability to create multiple &consenvs;,
375 including the ability to clone a new, customized
376 &consenv; from an existing &consenv;.
377 See <xref linkend="sect-construction-environments"></xref>, below.
384 <term>Execution Environment</term>
389 An <literal>execution environment</literal>
390 is the values that &SCons; sets
391 when executing an external
392 command (such as a compiler or linker)
393 to build one or more targets.
394 Note that this is not the same as
395 the <literal>external environment</literal>
397 See <xref linkend="sect-execution-environments"></xref>, below.
407 Unlike &Make;, &SCons; does not automatically
408 copy or import values between different environments
409 (with the exception of explicit clones of &consenvs;,
410 which inherit values from their parent).
411 This is a deliberate design choice
412 to make sure that builds are,
413 by default, repeatable regardless of
414 the values in the user's external environment.
415 This avoids a whole class of problems with builds
416 where a developer's local build works
417 because a custom variable setting
418 causes a different compiler or build option to be used,
419 but the checked-in change breaks the official build
420 because it uses different environment variable settings.
426 Note that the &SConscript; writer can
427 easily arrange for variables to be
428 copied or imported between environments,
429 and this is often very useful
430 (or even downright necessary)
431 to make it easy for developers
432 to customize the build in appropriate ways.
433 The point is <emphasis>not</emphasis>
434 that copying variables between different environments
435 is evil and must always be avoided.
436 Instead, it should be up to the
437 implementer of the build system
438 to make conscious choices
439 about how and when to import
440 a variable from one environment to another,
441 making informed decisions about
442 striking the right balance
443 between making the build
444 repeatable on the one hand
445 and convenient to use on the other.
449 <section id="sect-external-environments">
450 <title>Using Values From the External Environment</title>
454 The <literal>external environment</literal>
455 variable settings that
456 the user has in force
457 when executing &SCons;
458 are available through the normal Python
459 <envar>os.environ</envar>
461 This means that you must add an
462 <literal>import os</literal> statement
463 to any &SConscript; file
464 in which you want to use
465 values from the user's external environment.
475 More usefully, you can use the
476 <envar>os.environ</envar>
477 dictionary in your &SConscript;
478 files to initialize &consenvs;
479 with values from the user's external environment.
480 See the next section,
481 <xref linkend="sect-construction-environments"></xref>,
482 for information on how to do this.
488 <section id="sect-construction-environments">
489 <title>Construction Environments</title>
493 It is rare that all of the software in a large,
494 complicated system needs to be built the same way.
495 For example, different source files may need different options
496 enabled on the command line,
497 or different executable programs need to be linked
498 with different libraries.
499 &SCons; accommodates these different build
500 requirements by allowing you to create and
501 configure multiple &consenvs;
502 that control how the software is built.
503 A &consenv; is an object
504 that has a number of associated
505 &consvars;, each with a name and a value.
506 (A construction environment also has an attached
507 set of &Builder; methods,
508 about which we'll learn more later.)
513 <title>Creating a &ConsEnv;: the &Environment; Function</title>
517 A &consenv; is created by the &Environment; method:
527 By default, &SCons; initializes every
528 new construction environment
529 with a set of &consvars;
530 based on the tools that it finds on your system,
531 plus the default set of builder methods
532 necessary for using those tools.
533 The construction variables
534 are initialized with values describing
536 the Fortran compiler,
539 as well as the command lines to invoke them.
545 When you initialize a construction environment
546 you can set the values of the
547 environment's &consvars;
548 to control how a program is built.
556 env = Environment(CC = 'gcc',
564 The construction environment in this example
565 is still initialized with the same default
566 construction variable values,
567 except that the user has explicitly specified use of the
568 GNU C compiler &gcc;,
569 and further specifies that the <literal>-O2</literal>
570 (optimization level two)
571 flag should be used when compiling the object file.
572 In other words, the explicit initializations of
573 &cv-link-CC; and &cv-link-CCFLAGS;
574 override the default values in the newly-created
575 construction environment.
576 So a run from this example would look like:
581 % <userinput>scons -Q</userinput>
582 gcc -o foo.o -c -O2 foo.c
589 <title>Fetching Values From a &ConsEnv;</title>
593 You can fetch individual construction variables
594 using the normal syntax
595 for accessing individual named items in a Python dictionary:
601 print "CC is:", env['CC']
606 This example &SConstruct; file doesn't build anything,
607 but because it's actually a Python script,
608 it will print the value of &cv-link-CC; for us:
613 % <userinput>scons -Q</userinput>
615 scons: `.' is up to date.
620 A construction environment, however,
621 is actually an object with associated methods, etc.
622 If you want to have direct access to only the
623 dictionary of construction variables,
624 you can fetch this using the &Dictionary; method:
629 env = Environment(FOO = 'foo', BAR = 'bar')
630 dict = env.Dictionary()
631 for key in ['OBJSUFFIX', 'LIBSUFFIX', 'PROGSUFFIX']:
632 print "key = %s, value = %s" % (key, dict[key])
637 This &SConstruct; file
638 will print the specified dictionary items for us on POSIX
644 % <userinput>scons -Q</userinput>
645 key = OBJSUFFIX, value = .o
646 key = LIBSUFFIX, value = .a
647 key = PROGSUFFIX, value =
648 scons: `.' is up to date.
658 C:\><userinput>scons -Q</userinput>
659 key = OBJSUFFIX, value = .obj
660 key = LIBSUFFIX, value = .lib
661 key = PROGSUFFIX, value = .exe
662 scons: `.' is up to date.
667 If you want to loop and print the values of
668 all of the construction variables in a construction environment,
669 the Python code to do that in sorted order might look something like:
675 for item in sorted(env.Dictionary().items()):
676 print "construction variable = '%s', value = '%s'" % item
682 <title>Expanding Values From a &ConsEnv;: the &subst; Method</title>
686 Another way to get information from
687 a construction environment.
688 is to use the &subst; method
689 on a string containing <literal>$</literal> expansions
690 of construction variable names.
692 the example from the previous
694 <literal>env['CC']</literal>
695 to fetch the value of &cv-link-CC;
696 could also be written as:
702 print "CC is:", env.subst('$CC')
707 One advantage of using
708 &subst; to expand strings is
709 that construction variables
710 in the result get re-expanded until
711 there are no expansions left in the string.
712 So a simple fetch of a value like
718 env = Environment(CCFLAGS = '-DFOO')
719 print "CCCOM is:", env['CCCOM']
724 Will print the unexpanded value of &cv-CCCOM;,
725 showing us the construction
726 variables that still need to be expanded:
731 % <userinput>scons -Q</userinput>
732 CCCOM is: $CC $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS -c -o $TARGET $SOURCES
733 scons: `.' is up to date.
738 Calling the &subst; method on <varname>$CCOM</varname>,
744 env = Environment(CCFLAGS = '-DFOO')
745 print "CCCOM is:", env.subst('$CCCOM')
750 Will recursively expand all of
751 the construction variables prefixed
752 with <literal>$</literal> (dollar signs),
753 showing us the final output:
758 % <userinput>scons -Q</userinput>
759 CCCOM is: gcc -DFOO -c -o
760 scons: `.' is up to date.
765 Note that because we're not expanding this
766 in the context of building something
767 there are no target or source files
768 for &cv-link-TARGET; and &cv-link-SOURCES; to expand.
775 <title>Controlling the Default &ConsEnv;: the &DefaultEnvironment; Function</title>
779 All of the &Builder; functions that we've introduced so far,
780 like &Program; and &Library;,
781 actually use a default &consenv;
782 that contains settings
783 for the various compilers
785 &SCons; configures by default,
786 or otherwise knows about
787 and has discovered on your system.
788 The goal of the default construction environment
789 is to make many configurations to "just work"
790 to build software using
791 readily available tools
792 with a minimum of configuration changes.
798 You can, however, control the settings
799 in the default contstruction environment
800 by using the &DefaultEnvironment; function
801 to initialize various settings:
807 DefaultEnvironment(CC = '/usr/local/bin/gcc')
813 When configured as above,
814 all calls to the &Program;
816 will build object files with the
817 <filename>/usr/local/bin/gcc</filename>
824 Note that the &DefaultEnvironment; function
825 returns the initialized
826 default construction environment object,
827 which can then be manipulated like any
828 other construction environment.
830 would be equivalent to the
833 variable to <filename>/usr/local/bin/gcc</filename>
834 but as a separate step after
835 the default construction environment has been initialized:
841 env = DefaultEnvironment()
842 env['CC'] = '/usr/local/bin/gcc'
848 One very common use of the &DefaultEnvironment; function
849 is to speed up &SCons; initialization.
850 As part of trying to make most default
851 configurations "just work,"
852 &SCons; will actually
853 search the local system for installed
854 compilers and other utilities.
855 This search can take time,
856 especially on systems with
857 slow or networked file systems.
858 If you know which compiler(s) and/or
859 other utilities you want to configure,
860 you can control the search
861 that &SCons; performs
862 by specifying some specific
863 tool modules with which to
864 initialize the default construction environment:
870 env = DefaultEnvironment(tools = ['gcc', 'gnulink'],
871 CC = '/usr/local/bin/gcc')
877 So the above example would tell &SCons;
878 to explicitly configure the default environment
879 to use its normal GNU Compiler and GNU Linker settings
880 (without having to search for them,
881 or any other utilities for that matter),
882 and specifically to use the compiler found at
883 <filename>/usr/local/bin/gcc</filename>.
890 <title>Multiple &ConsEnvs;</title>
894 The real advantage of construction environments
895 is that you can create as many different construction
896 environments as you need,
897 each tailored to a different way to build
898 some piece of software or other file.
899 If, for example, we need to build
900 one program with the <literal>-O2</literal> flag
901 and another with the <literal>-g</literal> (debug) flag,
902 we would do this like so:
907 opt = Environment(CCFLAGS = '-O2')
908 dbg = Environment(CCFLAGS = '-g')
910 opt.Program('foo', 'foo.c')
912 dbg.Program('bar', 'bar.c')
916 % <userinput>scons -Q</userinput>
917 cc -o bar.o -c -g bar.c
919 cc -o foo.o -c -O2 foo.c
925 We can even use multiple construction environments to build
926 multiple versions of a single program.
927 If you do this by simply trying to use the
928 &b-link-Program; builder with both environments, though,
934 opt = Environment(CCFLAGS = '-O2')
935 dbg = Environment(CCFLAGS = '-g')
937 opt.Program('foo', 'foo.c')
939 dbg.Program('foo', 'foo.c')
944 Then &SCons; generates the following error:
949 % <userinput>scons -Q</userinput>
951 scons: *** Two environments with different actions were specified for the same target: foo.o
952 File "/home/my/project/SConstruct", line 6, in <module>
957 This is because the two &b-Program; calls have
958 each implicitly told &SCons; to generate an object file named
959 <filename>foo.o</filename>,
960 one with a &cv-link-CCFLAGS; value of
961 <literal>-O2</literal>
962 and one with a &cv-link-CCFLAGS; value of
963 <literal>-g</literal>.
964 &SCons; can't just decide that one of them
965 should take precedence over the other,
966 so it generates the error.
967 To avoid this problem,
968 we must explicitly specify
969 that each environment compile
970 <filename>foo.c</filename>
971 to a separately-named object file
972 using the &b-link-Object; builder, like so:
977 opt = Environment(CCFLAGS = '-O2')
978 dbg = Environment(CCFLAGS = '-g')
980 o = opt.Object('foo-opt', 'foo.c')
983 d = dbg.Object('foo-dbg', 'foo.c')
989 Notice that each call to the &b-Object; builder
991 an internal &SCons; object that
992 represents the object file that will be built.
993 We then use that object
994 as input to the &b-Program; builder.
995 This avoids having to specify explicitly
996 the object file name in multiple places,
997 and makes for a compact, readable
999 Our &SCons; output then looks like:
1004 % <userinput>scons -Q</userinput>
1005 cc -o foo-dbg.o -c -g foo.c
1006 cc -o foo-dbg foo-dbg.o
1007 cc -o foo-opt.o -c -O2 foo.c
1008 cc -o foo-opt foo-opt.o
1014 <title>Making Copies of &ConsEnvs;: the &Clone; Method</title>
1018 Sometimes you want more than one construction environment
1019 to share the same values for one or more variables.
1020 Rather than always having to repeat all of the common
1021 variables when you create each construction environment,
1022 you can use the &Clone; method
1023 to create a copy of a construction environment.
1029 Like the &Environment; call that creates a construction environment,
1030 the &Clone; method takes &consvar; assignments,
1031 which will override the values in the copied construction environment.
1032 For example, suppose we want to use &gcc;
1033 to create three versions of a program,
1034 one optimized, one debug, and one with neither.
1035 We could do this by creating a "base" construction environment
1036 that sets &cv-link-CC; to &gcc;,
1037 and then creating two copies,
1038 one which sets &cv-link-CCFLAGS; for optimization
1039 and the other which sets &cv-CCFLAGS; for debugging:
1044 env = Environment(CC = 'gcc')
1045 opt = env.Clone(CCFLAGS = '-O2')
1046 dbg = env.Clone(CCFLAGS = '-g')
1048 env.Program('foo', 'foo.c')
1050 o = opt.Object('foo-opt', 'foo.c')
1053 d = dbg.Object('foo-dbg', 'foo.c')
1059 Then our output would look like:
1064 % <userinput>scons -Q</userinput>
1065 gcc -o foo.o -c foo.c
1067 gcc -o foo-dbg.o -c -g foo.c
1068 gcc -o foo-dbg foo-dbg.o
1069 gcc -o foo-opt.o -c -O2 foo.c
1070 gcc -o foo-opt foo-opt.o
1076 <title>Replacing Values: the &Replace; Method</title>
1080 You can replace existing construction variable values
1081 using the &Replace; method:
1086 env = Environment(CCFLAGS = '-DDEFINE1')
1087 env.Replace(CCFLAGS = '-DDEFINE2')
1088 env.Program('foo.c')
1094 (<literal>-DDEFINE2</literal> in the above example)
1095 completely replaces the value in the
1096 construction environment:
1101 % <userinput>scons -Q</userinput>
1102 cc -o foo.o -c -DDEFINE2 foo.c
1108 You can safely call &Replace;
1109 for construction variables that
1110 don't exist in the construction environment:
1116 env.Replace(NEW_VARIABLE = 'xyzzy')
1117 print "NEW_VARIABLE =", env['NEW_VARIABLE']
1123 the construction variable simply
1124 gets added to the construction environment:
1129 % <userinput>scons -Q</userinput>
1130 NEW_VARIABLE = xyzzy
1131 scons: `.' is up to date.
1136 Because the variables
1137 aren't expanded until the construction environment
1138 is actually used to build the targets,
1139 and because &SCons; function and method calls
1140 are order-independent,
1141 the last replacement "wins"
1142 and is used to build all targets,
1143 regardless of the order in which
1144 the calls to Replace() are
1145 interspersed with calls to
1151 env = Environment(CCFLAGS = '-DDEFINE1')
1152 print "CCFLAGS =", env['CCFLAGS']
1153 env.Program('foo.c')
1155 env.Replace(CCFLAGS = '-DDEFINE2')
1156 print "CCFLAGS =", env['CCFLAGS']
1157 env.Program('bar.c')
1162 The timing of when the replacement
1163 actually occurs relative
1164 to when the targets get built
1166 if we run &scons; without the <literal>-Q</literal>
1172 % <userinput>scons</userinput>
1173 scons: Reading SConscript files ...
1176 scons: done reading SConscript files.
1177 scons: Building targets ...
1178 cc -o bar.o -c -DDEFINE2 bar.c
1180 cc -o foo.o -c -DDEFINE2 foo.c
1182 scons: done building targets.
1187 Because the replacement occurs while
1188 the &SConscript; files are being read,
1189 the &cv-link-CCFLAGS;
1190 variable has already been set to
1191 <literal>-DDEFINE2</literal>
1192 by the time the &foo_o; target is built,
1193 even though the call to the &Replace;
1194 method does not occur until later in
1195 the &SConscript; file.
1202 <title>Setting Values Only If They're Not Already Defined: the &SetDefault; Method</title>
1206 Sometimes it's useful to be able to specify
1207 that a construction variable should be
1208 set to a value only if the construction environment
1209 does not already have that variable defined
1210 You can do this with the &SetDefault; method,
1211 which behaves similarly to the <function>set_default</function>
1212 method of Python dictionary objects:
1217 env.SetDefault(SPECIAL_FLAG = '-extra-option')
1222 This is especially useful
1223 when writing your own <literal>Tool</literal> modules
1224 to apply variables to construction environments.
1226 See <xref linkend="chap-tool-modules"></xref>
1227 for more information about writing
1236 <title>Appending to the End of Values: the &Append; Method</title>
1240 You can append a value to
1241 an existing construction variable
1242 using the &Append; method:
1247 env = Environment(CCFLAGS = ['-DMY_VALUE'])
1248 env.Append(CCFLAGS = ['-DLAST'])
1249 env.Program('foo.c')
1254 &SCons; then supplies both the <literal>-DMY_VALUE</literal> and
1255 <literal>-DLAST</literal> flags when compiling the object file:
1260 % <userinput>scons -Q</userinput>
1261 cc -o foo.o -c -DMY_VALUE -DLAST foo.c
1267 If the construction variable doesn't already exist,
1268 the &Append; method will create it:
1274 env.Append(NEW_VARIABLE = 'added')
1275 print "NEW_VARIABLE =", env['NEW_VARIABLE']
1285 % <userinput>scons -Q</userinput>
1286 NEW_VARIABLE = added
1287 scons: `.' is up to date.
1292 Note that the &Append; function tries to be "smart"
1293 about how the new value is appended to the old value.
1294 If both are strings, the previous and new strings
1295 are simply concatenated.
1296 Similarly, if both are lists,
1297 the lists are concatenated.
1298 If, however, one is a string and the other is a list,
1299 the string is added as a new element to the list.
1306 <title>Appending Unique Values: the &AppendUnique; Method</title>
1310 Some times it's useful to add a new value
1311 only if the existing construction variable
1312 doesn't already contain the value.
1313 This can be done using the &AppendUnique; method:
1318 env.AppendUnique(CCFLAGS=['-g'])
1323 In the above example,
1324 the <literal>-g</literal> would be added
1325 only if the &cv-CCFLAGS; variable
1326 does not already contain a <literal>-g</literal> value.
1333 <title>Appending to the Beginning of Values: the &Prepend; Method</title>
1337 You can append a value to the beginning of
1338 an existing construction variable
1339 using the &Prepend; method:
1344 env = Environment(CCFLAGS = ['-DMY_VALUE'])
1345 env.Prepend(CCFLAGS = ['-DFIRST'])
1346 env.Program('foo.c')
1351 &SCons; then supplies both the <literal>-DFIRST</literal> and
1352 <literal>-DMY_VALUE</literal> flags when compiling the object file:
1357 % <userinput>scons -Q</userinput>
1358 cc -o foo.o -c -DFIRST -DMY_VALUE foo.c
1364 If the construction variable doesn't already exist,
1365 the &Prepend; method will create it:
1371 env.Prepend(NEW_VARIABLE = 'added')
1372 print "NEW_VARIABLE =", env['NEW_VARIABLE']
1382 % <userinput>scons -Q</userinput>
1383 NEW_VARIABLE = added
1384 scons: `.' is up to date.
1389 Like the &Append; function,
1390 the &Prepend; function tries to be "smart"
1391 about how the new value is appended to the old value.
1392 If both are strings, the previous and new strings
1393 are simply concatenated.
1394 Similarly, if both are lists,
1395 the lists are concatenated.
1396 If, however, one is a string and the other is a list,
1397 the string is added as a new element to the list.
1404 <title>Prepending Unique Values: the &PrependUnique; Method</title>
1408 Some times it's useful to add a new value
1409 to the beginning of a construction variable
1410 only if the existing value
1411 doesn't already contain the to-be-added value.
1412 This can be done using the &PrependUnique; method:
1417 env.PrependUnique(CCFLAGS=['-g'])
1422 In the above example,
1423 the <literal>-g</literal> would be added
1424 only if the &cv-CCFLAGS; variable
1425 does not already contain a <literal>-g</literal> value.
1433 <section id="sect-execution-environments">
1434 <title>Controlling the Execution Environment for Issued Commands</title>
1438 When &SCons; builds a target file,
1439 it does not execute the commands with
1440 the same external environment
1441 that you used to execute &SCons;.
1442 Instead, it uses the dictionary
1443 stored in the &cv-link-ENV; construction variable
1444 as the external environment
1445 for executing commands.
1451 The most important ramification of this behavior
1452 is that the &PATH; environment variable,
1453 which controls where the operating system
1454 will look for commands and utilities,
1455 is not the same as in the external environment
1456 from which you called &SCons;.
1457 This means that &SCons; will not, by default,
1458 necessarily find all of the tools
1459 that you can execute from the command line.
1465 The default value of the &PATH; environment variable
1467 is <literal>/usr/local/bin:/bin:/usr/bin</literal>.
1468 The default value of the &PATH; environment variable
1469 on a Windows system comes from the Windows registry
1470 value for the command interpreter.
1471 If you want to execute any commands--compilers, linkers, etc.--that
1472 are not in these default locations,
1473 you need to set the &PATH; value
1474 in the &cv-ENV; dictionary
1475 in your construction environment.
1481 The simplest way to do this is to initialize explicitly
1482 the value when you create the construction environment;
1483 this is one way to do that:
1488 path = ['/usr/local/bin', '/bin', '/usr/bin']
1489 env = Environment(ENV = {'PATH' : path})
1494 Assign a dictionary to the &cv-ENV;
1495 construction variable in this way
1496 completely resets the external environment
1497 so that the only variable that will be
1498 set when external commands are executed
1499 will be the &PATH; value.
1500 If you want to use the rest of
1501 the values in &cv-ENV; and only
1502 set the value of &PATH;,
1503 the most straightforward way is probably:
1508 env['ENV']['PATH'] = ['/usr/local/bin', '/bin', '/usr/bin']
1513 Note that &SCons; does allow you to define
1514 the directories in the &PATH; in a string,
1515 separated by the pathname-separator character
1516 for your system (':' on POSIX systems, ';' on Windows):
1521 env['ENV']['PATH'] = '/usr/local/bin:/bin:/usr/bin'
1526 But doing so makes your &SConscript; file less portable,
1527 (although in this case that may not be a huge concern
1528 since the directories you list are likley system-specific, anyway).
1534 <scons_example name="ex1">
1535 <file name="SConstruct" printme="1">
1537 env.Command('foo', [], '__ROOT__/usr/bin/printenv.py')
1539 <file name="__ROOT__/usr/bin/printenv.py" chmod="0755">
1540 #!/usr/bin/env python
1543 if len(sys.argv) > 1:
1546 keys = sorted(os.environ.keys())
1548 print " " + key + "=" + os.environ[key]
1556 <scons_output example="ex1">
1557 <scons_output_command>scons -Q</scons_output_command>
1563 <title>Propagating &PATH; From the External Environment</title>
1567 You may want to propagate the external &PATH;
1568 to the execution environment for commands.
1569 You do this by initializing the &PATH;
1570 variable with the &PATH; value from
1571 the <literal>os.environ</literal>
1573 which is Python's way of letting you
1574 get at the external environment:
1580 env = Environment(ENV = {'PATH' : os.environ['PATH']})
1585 Alternatively, you may find it easier
1586 to just propagate the entire external
1587 environment to the execution environment
1589 This is simpler to code than explicity
1590 selecting the &PATH; value:
1596 env = Environment(ENV = os.environ)
1601 Either of these will guarantee that
1602 &SCons; will be able to execute
1603 any command that you can execute from the command line.
1604 The drawback is that the build can behave
1605 differently if it's run by people with
1606 different &PATH; values in their environment--for example,
1607 if both the <literal>/bin</literal> and
1608 <literal>/usr/local/bin</literal> directories
1609 have different &cc; commands,
1610 then which one will be used to compile programs
1611 will depend on which directory is listed
1612 first in the user's &PATH; variable.
1619 <title>Adding to <varname>PATH</varname> Values in the Execution Environment</title>
1623 One of the most common requirements
1624 for manipulating a variable in the execution environment
1625 is to add one or more custom directories to a search
1626 like the <envar>$PATH</envar> variable on Linux or POSIX systems,
1627 or the <envar>%PATH%</envar> variable on Windows,
1628 so that a locally-installed compiler or other utility
1629 can be found when &SCons; tries to execute it to update a target.
1630 &SCons; provides &PrependENVPath; and &AppendENVPath; functions
1631 to make adding things to execution variables convenient.
1632 You call these functions by specifying the variable
1633 to which you want the value added,
1634 and then value itself.
1635 So to add some <filename>/usr/local</filename> directories
1636 to the <envar>$PATH</envar> and <envar>$LIB</envar> variables,
1642 env = Environment(ENV = os.environ)
1643 env.PrependENVPath('PATH', '/usr/local/bin')
1644 env.AppendENVPath('LIB', '/usr/local/lib')
1649 Note that the added values are strings,
1650 and if you want to add multiple directories to
1651 a variable like <envar>$PATH</envar>,
1652 you must include the path separate character
1653 (<literal>:</literal> on Linux or POSIX,
1654 <literal>;</literal> on Windows)