1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
|
<?xml version='1.0'?>
<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM "../scons.mod">
%scons;
<!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
%builders-mod;
<!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
%functions-mod;
<!ENTITY % tools-mod SYSTEM "../generated/tools.mod">
%tools-mod;
<!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
%variables-mod;
]>
<chapter id="chap-builders-built-in"
xmlns="http://www.scons.org/dbxsd/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
<title>Built-In Builders</title>
<!--
__COPYRIGHT__
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-->
<para>
&SCons; provides the ability to build a lot of different
types of files right "out of the box."
So far, we've been using &SCons;' ability to build
programs, objects and libraries to
illustrate much of the underlying functionality of &SCons;
This section will describe all of the different
types of files that you can build with &SCons;,
and the built-in &Builder; objects used to build them.
By default, all of the &Builder; objects in this section
can be built either with or without an explicit
construction environment.
</para>
<section>
<title>Programs: the &Program; Builder</title>
<para>
As we've seen, the &b-link-Program; Builder
is used to build an executable program.
The &source; argument is one or more
source-code files or object files,
and the ⌖ argument is the
name of the executable program name to be created.
For example:
</para>
<programlisting>
Program('prog', 'file1.o')
</programlisting>
<para>
Will create the &prog;
executable on a POSIX system,
the &prog_exe; executable on a Windows system.
</para>
<para>
The target file's prefix and suffix may be omitted,
and the values from the
&cv-link-PROGPREFIX;
and
&cv-link-PROGSUFFIX;
construction variables
will be appended appropriately.
For example:
</para>
<programlisting>
env = Environment(PROGPREFIX='my', PROGSUFFIX='.xxx')
env.Program('prog', ['file1.o', 'file2.o'])
</programlisting>
<para>
Will create a program named
<filename>myprog.xxx</filename>
regardless of the system on which it is run.
</para>
<para>
If you omit the ⌖,
the base of the first input
file name specified
becomes the base of the target
program created.
For example:
</para>
<programlisting>
Program(['hello.c', 'goodbye.c'])
</programlisting>
<para>
Will create the &hello;
executable on a POSIX system,
the &hello_exe; executable on a Windows system.
</para>
<para>
Two construction variables control what libraries
will be linked with the resulting program.
The &cv-link-LIBS; variable is a list of the names of
libraries that will be linked into any programs,
and the &cv-link-LIBPATH; variables is a list of
directories that will be searched for
the specified libraries.
&SCons; will construct the right command-line
options for the running system.
For example:
</para>
<scons_example name="buildersbuiltin_libs">
<file name="SConstruct" printme="1">
env = Environment(LIBS = ['foo1', 'foo2'],
LIBPATH = ['/usr/dir1', 'dir2'])
env.Program(['hello.c', 'goodbye.c'])
</file>
<file name="hello.c">
int hello() { printf("Hello, world!\n"); }
</file>
<file name="goodbye.c">
int goodbye() { printf("Goodbye, world!\n"); }
</file>
</scons_example>
<para>
Will execute as follows on a POSIX system:
</para>
<scons_output example="buildersbuiltin_libs" os="posix" suffix="1">
<scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
And execute as follows on a Windows system:
</para>
<scons_output example="buildersbuiltin_libs" os="win32" suffix="2">
<scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
The &cv-LIBS; construction variable
is turned into command line options
by appending the &cv-link-LIBLINKPREFIX; and &cv-link-LIBLINKSUFFIX;
construction variables to the beginning and end,
respectively, of each specified library.
</para>
<para>
The &cv-LIBPATH; construction variable
is turned into command line options
by appending the &cv-link-LIBDIRPREFIX; and &cv-link-LIBDIRSUFFIX;
construction variables to the beginning and end,
respectively, of each specified library.
</para>
<para>
Other relevant construction variables
include those used by the &b-link-Object;
builders to affect how the
source files specified as input to the <literal>Program</literal>
builders are turned into object files;
see the next section.
</para>
<para>
The command line used to control how a program is linked
is specified by the &cv-link-LINKCOM; construction variable.
By default, it uses the
&cv-link-LINK; construction variable
and the &cv-link-LINKFLAGS; construction variable.
</para>
</section>
<section>
<title>Object-File Builders</title>
<para>
&SCons; provides separate Builder objects
to create static and shared object files.
The distinction becomes especially important when
archiving object files into different types of libraries.
</para>
<section>
<title>The &StaticObject; Builder</title>
<para>
The &b-link-StaticObject; Builder
is used to build an object file
suitable for static linking into a program,
or for inclusion in a static library.
The &source; argument is a single source-code file,
and the ⌖ argument is the
name of the static object file to be created.
For example:
</para>
<programlisting>
StaticObject('file', 'file.c')
</programlisting>
<para>
Will create the &file_o;
object file on a POSIX system,
the &file_obj; executable on a Windows system.
</para>
<para>
The target file's prefix and suffix may be omitted,
and the values from the
&cv-link-OBJPREFIX;
and
&cv-link-OBJSUFFIX;
construction variables
will be appended appropriately.
For example:
</para>
<programlisting>
env = Environment(OBJPREFIX='my', OBJSUFFIX='.xxx')
env.StaticObject('file', 'file.c')
</programlisting>
<para>
Will create an object file named
<filename>myfile.xxx</filename>
regardless of the system on which it is run.
</para>
<para>
If you omit the ⌖,
the base of the first input
file name specified
beomces the base of the name
of the static object file to be created.
For example:
</para>
<programlisting>
StaticObject('file.c')
</programlisting>
<para>
Will create the &file_o;
executable on a POSIX system,
the &file_obj; executable on a Windows system.
</para>
</section>
<section>
<title>The &SharedObject; Builder</title>
<para>
The &b-link-SharedObject; Builder
is used to build an object file
suitable for shared linking into a program,
or for inclusion in a shared library.
The &source; argument is a single source-code file,
and the ⌖ argument is the
name of the shared object file to be created.
For example:
</para>
<programlisting>
SharedObject('file', 'file.c')
</programlisting>
<para>
Will create the &file_o;
object file on a POSIX system,
the &file_obj; executable on a Windows system.
</para>
<para>
The target file's prefix and suffix may be omitted,
and the values from the
&cv-link-SHOBJPREFIX;
and
&cv-link-SHOBJSUFFIX;
construction variables
will be appended appropriately.
For example:
</para>
<programlisting>
env = Environment(SHOBJPREFIX='my', SHOBJSUFFIX='.xxx')
env.SharedObject('file', 'file.c')
</programlisting>
<para>
Will create an object file named
<filename>myfile.xxx</filename>
regardless of the system on which it is run.
</para>
<para>
If you omit the ⌖,
the base of the first input
file name specified
becomes the base of the name
of the shared object file to be created.
For example:
</para>
<programlisting>
SharedObject('file.c')
</programlisting>
<para>
Will create the &file_o;
executable on a POSIX system,
the &file_obj; executable on a Windows system.
</para>
</section>
<section>
<title>The &Object; Builder</title>
<para>
The &b-link-Object; Builder is a synonym for &b-link-StaticObject;
and is completely equivalent.
</para>
</section>
</section>
<section>
<title>Library Builders</title>
<para>
&SCons; provides separate Builder objects
to create static and shared libraries.
</para>
<section>
<title>The &StaticLibrary; Builder</title>
<para>
The &b-link-StaticLibrary; Builder
is used to create a library
suitable for static linking into a program.
The &source; argument is one or more
source-code files or object files,
and the ⌖ argument is the
name of the static library to be created.
For example:
</para>
<programlisting>
StaticLibrary('foo', ['file1.c', 'file2.c'])
</programlisting>
<para>
The target file's prefix and suffix may be omitted,
and the values from the
&cv-link-LIBPREFIX;
and
&cv-link-LIBSUFFIX;
construction variables
will be appended appropriately.
For example:
</para>
<programlisting>
env = Environment(LIBPREFIX='my', LIBSUFFIX='.xxx')
env.StaticLibrary('lib', ['file1.o', 'file2.o'])
</programlisting>
<para>
Will create an object file named
<filename>mylib.xxx</filename>
regardless of the system on which it is run.
</para>
<programlisting>
StaticLibrary('foo', ['file1.c', 'file2.c'])
</programlisting>
<para>
If you omit the ⌖,
the base of the first input
file name specified
becomes the base of the name of the static object file to be created.
For example:
</para>
<programlisting>
StaticLibrary(['file.c', 'another.c'])
</programlisting>
<para>
Will create the &libfile_a;
library on a POSIX system,
the &file_lib; library on a Windows system.
</para>
</section>
<section>
<title>The &SharedLibrary; Builder</title>
<para>
The &b-link-SharedLibrary; Builder
is used to create a shared library
suitable for linking with a program.
The &source; argument is one or more
source-code files or object files,
and the ⌖ argument is the
name of the shared library to be created.
For example:
</para>
<programlisting>
SharedLibrary('foo', ['file1.c', 'file2.c'])
</programlisting>
<para>
The target file's prefix and suffix may be omitted,
and the values from the
&cv-link-SHLIBPREFIX;
and
&cv-link-SHLIBSUFFIX;
construction variables
will be appended appropriately.
For example:
</para>
<programlisting>
env = Environment(SHLIBPREFIX='my', SHLIBSUFFIX='.xxx')
env.SharedLibrary('shared', ['file1.o', 'file2.o'])
</programlisting>
<para>
Will create an object file named
<filename>myshared.xxx</filename>
regardless of the system on which it is run.
</para>
<programlisting>
SharedLibrary('foo', ['file1.c', 'file2.c'])
</programlisting>
<para>
If you omit the ⌖,
the base of the first input
file name specified
becomes the base of the name of the shared library to be created.
For example:
</para>
<programlisting>
SharedLibrary(['file.c', 'another.c'])
</programlisting>
<para>
Will create the &libfile_so;
library on a POSIX system,
the &file_dll; library on a Windows system.
</para>
</section>
<section>
<title>The &Library; Builder</title>
<para>
The &b-link-Library; Builder is a synonym for &b-link-StaticLibrary;
and is completely equivalent.
</para>
</section>
</section>
<section>
<title>Pre-Compiled Headers: the &PCH; Builder</title>
<para>
XXX PCH()
</para>
</section>
<section>
<title>Microsoft Visual C++ Resource Files: the &RES; Builder</title>
<para>
XXX RES()
</para>
</section>
<section>
<title>Source Files</title>
<para>
By default
&SCons; supports two Builder objects
that know how to build source files
from other input files.
These are typically invoked "internally"
to turn files that need preprocessing into other source files.
</para>
<section>
<title>The &CFile; Builder</title>
<para>
XXX CFile()
</para>
<programlisting>
XXX CFile() programlisting
</programlisting>
<screen>
XXX CFile() screen
</screen>
</section>
<section>
<title>The &CXXFile; Builder</title>
<para>
XXX CXXFILE()
</para>
<programlisting>
XXX CXXFILE() programlisting
</programlisting>
<screen>
XXX CXXFILE() screen
</screen>
</section>
</section>
<section>
<title>Documents</title>
<para>
&SCons; provides a number of Builder objects
for creating different types of documents.
</para>
<section>
<title>The &DVI; Builder</title>
<para>
XXX DVI() para
</para>
<programlisting>
XXX DVI() programlisting
</programlisting>
<screen>
XXX DVI() screen
</screen>
</section>
<section>
<title>The &PDF; Builder</title>
<para>
XXX PDF() para
</para>
</section>
<section>
<title>The &PostScript; Builder</title>
<para>
XXX PostScript() para
</para>
<programlisting>
XXX PostScript() programlisting
</programlisting>
<screen>
XXX PostScript() screen
</screen>
</section>
</section>
<section>
<title>Archives</title>
<para>
&SCons; provides Builder objects
for creating two different types of archive files.
</para>
<section>
<title>The &Tar; Builder</title>
<para>
The &b-link-Tar; Builder object uses the &tar;
utility to create archives of files
and/or directory trees:
</para>
<scons_example name="buildersbuiltin_ex1">
<file name="SConstruct" printme="1">
env = Environment()
env.Tar('out1.tar', ['file1', 'file2'])
env.Tar('out2', 'directory')
</file>
<file name="file1">
file1
</file>
<file name="file2">
file2
</file>
<file name="directory/file3">
directory/file3
</file>
</scons_example>
<scons_output example="buildersbuiltin_ex1" os="posix" suffix="1">
<scons_output_command>scons -Q .</scons_output_command>
</scons_output>
<para>
One common requirement when creating a &tar; archive
is to create a compressed archive using the
<option>-z</option> option.
This is easily handled by specifying
the value of the &cv-link-TARFLAGS; variable
when you create the construction environment.
Note, however, that the <option>-c</option> used to
to instruct &tar; to create the archive
is part of the default value of &cv-TARFLAGS;,
so you need to set it both options:
</para>
<scons_example name="buildersbuiltin_ex2">
<file name="SConstruct" printme="1">
env = Environment(TARFLAGS = '-c -z')
env.Tar('out.tar.gz', 'directory')
</file>
<file name="directory/file">
directory/file
</file>
</scons_example>
<scons_output example="buildersbuiltin_ex2" os="posix" suffix="1">
<scons_output_command>scons -Q .</scons_output_command>
</scons_output>
<para>
you may also wish to set the value of the
&cv-link-TARSUFFIX; construction variable
to your desired suffix for compress &tar; archives,
so that &SCons; can append it to the target file name
without your having to specify it explicitly:
</para>
<scons_example name="buildersbuiltin_ex3">
<file name="SConstruct" printme="1">
env = Environment(TARFLAGS = '-c -z',
TARSUFFIX = '.tgz')
env.Tar('out', 'directory')
</file>
<file name="directory/file">
directory/file
</file>
</scons_example>
<scons_output example="buildersbuiltin_ex3" os="posix" suffix="1">
<scons_output_command>scons -Q .</scons_output_command>
</scons_output>
</section>
<section>
<title>The &Zip; Builder</title>
<para>
The &b-link-Zip; Builder object creates archives of files
and/or directory trees in the ZIP file format.
Python versions 1.6 or later
contain an internal &zipfile; module
that &SCons; will use.
In this case, given the following
&SConstruct; file:
</para>
<scons_example name="buildersbuiltin_ex4">
<file name="SConstruct" printme="1">
env = Environment()
env.Zip('out', ['file1', 'file2'])
</file>
<file name="file1">
file1
</file>
<file name="file2">
file2
</file>
</scons_example>
<para>
Your output will reflect the fact
that an internal Python function
is being used to create the output ZIP archive:
</para>
<scons_output example="buildersbuiltin_ex4" os="posix" suffix="1">
<scons_output_command>scons -Q .</scons_output_command>
</scons_output>
</section>
</section>
<section>
<title>Java</title>
<para>
&SCons; provides Builder objects
for creating various types of Java output files.
</para>
<section>
<title>Building Class Files: the &Java; Builder</title>
<para>
The &b-link-Java; builder takes one or more input
<filename>.java</filename> files
and turns them into one or more
<filename>.class</filename> files
Unlike most builders, however,
the &Java; builder takes
target and source <emphasis>directories</emphasis>,
not files, as input.
</para>
<programlisting>
env = Environment()
env.Java(target = 'classes', source = 'src')
</programlisting>
<para>
The &Java; builder will then
search the specified source directory
tree for all <filename>.java</filename> files,
and pass any out-of-date
</para>
<screen>
XXX Java() screen
</screen>
</section>
<section>
<title>The &Jar; Builder</title>
<para>
XXX The &Jar; builder object
</para>
<programlisting>
env = Environment()
env.Java(target = 'classes', source = 'src')
env.Jar(target = '', source = 'classes')
</programlisting>
<screen>
XXX Jar() screen
</screen>
</section>
<section>
<title>Building C header and stub files: the &JavaH; Builder</title>
<para>
XXX JavaH() para
</para>
<programlisting>
XXX JavaH() programlisting
</programlisting>
<screen>
XXX JavaH() screen
</screen>
</section>
<section>
<title>Building RMI stub and skeleton class files: the &RMIC; Builder</title>
<para>
XXX RMIC() para
</para>
<programlisting>
XXX RMIC() programlisting
</programlisting>
<screen>
XXX RMIC() screen
</screen>
</section>
</section>
</chapter>
|