based on commit from Mon, 9 Aug 2010 08:59:19 +0000 by vladimir_prus <vladimir_prus...
[boost:zeuners-boost-cmake.git] / boostcpp.jam
1 # Boost.Build support specific for the Boost C++ Libraries.
2 # Copyright Vladimir Prus 2002-2010.
3 # Copyright Dave Abrahams 2005-2006.
4 # Copyright Rene Rivera 2005-2007.
5 # Copyright Douglas Gregor 2005.
6 #
7 # Distributed under the Boost Software License, Version 1.0.
8 #    (See accompanying file LICENSE_1_0.txt or copy at
9 #          http://www.boost.org/LICENSE_1_0.txt)
10
11 import option ;
12 import regex ;
13 import common ;
14
15 import modules ;
16 import os ;
17 import path ;
18 import build-system ;
19 import configure ;
20 import set ;
21 import package ;
22 import project ;
23 import targets ;
24 import generate ;
25 import package ;
26
27 ##############################################################################
28
29 # 0. General setup. Parse options, check them.
30 #
31 ##############################################################################  
32
33 BOOST_ROOT = [ modules.binding $(__name__) ] ;
34
35 rule set-version ( version )
36 {
37     BOOST_VERSION = $(version) ;
38     
39     local version-tag = [ MATCH "^([^.]+)[.]([^.]+)[.]([^.]+)" : $(BOOST_VERSION) ]
40       ;
41     if $(version-tag[3]) = 0
42     {
43         version-tag = $(version-tag[1-2]) ;
44     }
45     
46     BOOST_VERSION_TAG = $(version-tag:J="_") ;
47 }
48
49 # Option to choose how many variants to build. The default is "minimal".
50 build-type = [ option.get "build-type" ] ;
51 build-type ?= minimal ;
52 if ! ( $(build-type) in minimal complete )
53 {
54     ECHO "The value of the --build-type option should be either 'complete' or 'minimal'" ;
55     EXIT ;
56 }
57
58 # What kind of layout are we doing?
59 layout = [ option.get layout : "" ] ;
60 # On Windows, we used versioned layout by default in order to
61 # be compatible with autolink. On other systems, we use system
62 # layout which is what every other program uses. Note that windows
63 # check is static, and won't 
64 if ! $(layout)
65 {
66     if [ os.name ] = NT
67     {
68         layout = versioned ;
69     }
70     else
71     {
72         layout = system ;
73     }
74 }
75 layout-$(layout) = true ;
76
77 if $(layout) = system && $(build-type) = complete
78 {
79     ECHO "error: Cannot use --layout=system with --build-type complete." ;
80     ECHO "error: Please used either --layout=versioned or --layout=tagged " ;
81     ECHO "error: if you wish to build multiple variants." ;
82     if ! [ os.name ] = NT
83     {        
84         ECHO "error: Note that --layout=system is default on Unix starting with Boost 1.40." ;
85     }    
86     EXIT ;
87 }
88
89 # Possible stage only location.
90 stage-locate = [ option.get "stagedir" ] ;
91 stage-locate ?= stage ;
92 BOOST_STAGE_LOCATE = $(stage-locate) ;
93
94 # Custom build ID.
95 build-id = [ option.get "buildid" ] ;
96 if $(build-id)
97 {
98     BUILD_ID = [ regex.replace $(build-id) "[*\\/:.\"\' ]" "_" ] ;
99 }
100
101 # Python build id (only for Python libraries)
102 python-id = [ option.get "python-buildid" ] ;
103 if $(python-id)
104 {
105     PYTHON_ID = [ regex.replace $(python-id) "[*\\/:.\"\']" "_" ] ;
106 }
107
108 ##############################################################################
109 #
110 # 1. The 'tag' function that adds decoration suitable to the properties if
111 # versioned or tagged layout is requested. This function is called from 
112 # Jamroot
113 #
114 ##############################################################################  
115
116 rule tag ( name : type ? : property-set )
117 {
118     if $(type) in STATIC_LIB SHARED_LIB IMPORT_LIB
119     {
120         local result ;
121         if $(layout) = versioned
122         {
123             result = [ common.format-name
124                 <base> <toolset> <threading> <runtime> -$(BOOST_VERSION_TAG)
125                 -$(BUILD_ID)
126                 : $(name) : $(type) : $(property-set) ] ;
127         }        
128         else if $(layout) = tagged
129         {
130             result = [ common.format-name
131                 <base> <threading> <runtime>
132                 -$(BUILD_ID)
133                 : $(name) : $(type) : $(property-set) ] ;            
134         }
135         else if $(layout) = system
136         {
137             result = [ common.format-name
138                 <base> 
139                 -$(BUILD_ID)
140                 : $(name) : $(type) : $(property-set) ] ;
141         }
142         else
143         {
144             ECHO "error: invalid layout '$(layout:E=)'" ;
145             EXIT ;               
146         }
147                 
148         # Optionally add version suffix. On NT, library with version suffix
149         # will not be recognized by linkers. On CYGWIN, we get strage
150         # duplicate symbol errors when library is generated with version
151         # suffix. On OSX, version suffix is not needed -- the linker expects
152         # the libFoo.1.2.3.dylib format. AIX linkers do not accept version
153         # suffixes either. Pgi compilers can not accept library with version
154         # suffix.
155         if $(type) = SHARED_LIB &&
156           ( ! ( [ $(property-set).get <target-os> ] in windows cygwin darwin aix ) &&
157             ! ( [ $(property-set).get <toolset> ] in pgi ) )
158         {
159             result = $(result).$(BOOST_VERSION)  ;
160         }
161
162         return $(result) ;
163     }    
164 }
165
166 ##############################################################################
167 #
168 # 2. Declare targets that build and install all libraries. Specifically:
169 #
170 #    - 'stage-proper' that puts all libraries in stage/lib
171 #    - 'install-proper' that install libraries and headers to system location
172 #    - 'stage-unversioned' that creates links to libraries without boost veriosn
173 #       in name
174 #    - 'install-unversioned' which creates unversioned linked to installed
175 #       libraries.
176 #
177 ##############################################################################  
178
179 # Worker function suitable to the 'generate' metatarget. Creates a link
180 # to 'source', striping any version number from the name.
181 rule make-unversioned-links ( project name ? : property-set : sources * )
182 {
183     local result ;
184     local filtered ;
185     local pattern ;
186     local nt = [ modules.peek : NT ] ;
187
188     # Collect the libraries that have the version number in 'filtered'.
189     for local s in $(sources)
190     {
191         local m ;
192         if $(nt)
193         {
194             m = [ MATCH "(.*[.]lib)" : [ $(s).name ] ] ;
195         }
196         else
197         {
198             m = [ MATCH "(.*[.]so[.0-9]+)" "(.*[.]dylib)" "(.*[.]a)" :
199               [ $(s).name ] ] ;
200         }
201         if $(m)
202         {
203             filtered += $(s) ;
204         }
205     }
206
207     # Create links without version.
208     for local s in $(filtered)
209     {
210         local name = [ $(s).name ] ;
211         local ea = [ $(s).action ] ;
212         local ep = [ $(ea).properties ] ;
213         local a  = [ new non-scanning-action $(s) : symlink.ln : $(ep) ] ;
214
215         local noversion-file ;
216         if $(nt)
217         {
218             noversion-file = [ MATCH "(.*)-[0-9_]+(.*[.]lib)" : $(name) ] ;
219         }
220         else
221         {
222             noversion-file =
223               [ MATCH "(.*)-[0-9_]+(.*[.]so)[.0-9]*" : $(name) ]
224                 [ MATCH "(.*)-[0-9_]+(.*[.]dylib)" : $(name) ]
225                   [ MATCH "(.*)-[0-9_]+(.*[.]a)" : $(name) ]
226                     [ MATCH "(.*)-[0-9_]+(.*[.]dll[.]a)" : $(name) ] ;
227         }
228
229         local new-name =
230           $(noversion-file[1])$(noversion-file[2]) ;
231         result += [ new file-target $(new-name) exact : [ $(s).type ] : $(project)
232           : $(a) ] ;
233
234     }
235     return $(result) ;
236 }
237
238 rule declare_install_and_stage_proper_targets ( libraries * : headers * )
239 {
240     install-requirements = <install-source-root>$(BOOST_ROOT)/boost ;
241
242     if $(layout-versioned)
243     {
244         install-requirements += <install-header-subdir>boost-$(BOOST_VERSION_TAG)/boost ;
245     }
246     else
247     {
248         install-requirements += <install-header-subdir>boost ;
249     }
250     
251     if [ os.name ] = NT
252     {
253         install-requirements += <install-default-prefix>C:/Boost ;
254     }
255     else
256     {
257         install-requirements += <install-default-prefix>/usr/local ;
258     }
259     
260     p = [ project.current ] ;
261     
262     # Complete install.
263     package.install install-proper
264       : $(install-requirements) <install-no-version-symlinks>on
265       :
266       : libs/$(libraries)/build
267       : $(headers)
268       ;
269     
270     $(p).mark-target-as-explicit install-proper ;
271
272     # Install just library.
273     install stage-proper
274       : libs/$(libraries)/build
275       : <location>$(stage-locate)/lib
276         <install-dependencies>on <install-type>LIB
277         <install-no-version-symlinks>on
278       ;
279     $(p).mark-target-as-explicit stage-proper ;
280
281     if $(layout-versioned) && ( [ modules.peek : NT ] || [ modules.peek : UNIX ] )
282     {
283         generate stage-unversioned : stage-proper :
284           <generating-rule>boostcpp.make-unversioned-links ;
285         $(p).mark-target-as-explicit stage-unversioned ;
286
287         generate install-unversioned : install-proper :
288           <generating-rule>boostcpp.make-unversioned-links ;
289         $(p).mark-target-as-explicit  explicit install-unversioned ;
290     }
291     else
292     {
293         # Create do-nothing aliases.
294         alias stage-unversioned ;
295         $(p).mark-target-as-explicit stage-unversioned ;
296         alias install-unversioned ;
297         $(p).mark-target-as-explicit install-unversioned ;
298     }
299 }
300
301 ##############################################################################  
302 #
303 #  3. Declare top-level targets 'stage' and 'install'. These examine
304 #  the --build-type option and, in case it's 'complete', build the
305 #  'install-proper' and 'stage-proper' targets with a number of
306 #  property sets.
307 #
308 ##############################################################################  
309
310 class top-level-target : alias-target-class
311 {
312     import modules ;
313     import errors ; 
314     
315     rule __init__ ( name : project : sources * : requirements *
316         : default-build * : usage-requirements * )
317     {
318         alias-target-class.__init__ $(name) : $(project) : $(sources) :
319             $(requirements) : $(default-build) : $(usage-requirements) ;
320         
321         self.build-type = [ modules.peek boostcpp : build-type ] ;
322         # On Linux, we build release variant by default, since few users will
323         # ever want to debug C++ Boost libraries, and there's no ABI
324         # incompatibility between debug and release variants. We build
325         # shared and static libraries since that's what most packages
326         # seem to provide (.so in libfoo and .a in libfoo-dev).
327         self.minimal-properties = [ property-set.create 
328             <variant>release <threading>multi <link>shared <link>static <runtime-link>shared ] ;
329         # On Windows, new IDE projects use:
330         #
331         #   runtime-link=dynamic, threading=multi, variant=(debug|release)
332         #
333         # and in addition, C++ Boost's autolink defaults to static linking.
334         self.minimal-properties-win = [ property-set.create 
335             <variant>debug <variant>release <threading>multi <link>static <runtime-link>shared ] ;
336
337         self.complete-properties = [ property-set.create
338             <variant>debug <variant>release
339             <threading>single <threading>multi
340             <link>shared <link>static
341             <runtime-link>shared <runtime-link>static ] ;
342     }
343     
344     rule generate ( property-set )
345     {
346         local x = [ modules.peek : top-level-targets ] ;
347         x += $(self.name) ;
348         modules.poke : top-level-targets : $(x) ;
349         if $(self.build-type) = minimal
350         {
351             local expanded ;
352             
353             local os = [ $(property-set).get <target-os> ] ;
354             # Because we completely override parent's 'generate'
355             # we need to check for default value of feature ourself.
356             if ! $(os)
357             {
358                 os = [ feature.defaults <target-os> ] ;
359                 os = $(os:G=) ;
360             }
361             
362             if $(os) = windows
363             {                
364                 expanded = [ targets.apply-default-build $(property-set)
365                   : $(self.minimal-properties-win) ] ;
366             }
367             else
368             {
369                 expanded = [ targets.apply-default-build $(property-set)
370                   : $(self.minimal-properties) ] ;
371             }            
372             return [ build-multiple $(expanded) ] ;
373         }
374         else if $(self.build-type) = complete
375         {                                    
376             local expanded = [ targets.apply-default-build $(property-set)
377               : $(self.complete-properties) ] ;
378             
379             # Filter inappopriate combinations
380             local filtered ;
381             for local p in $(expanded)
382             {
383                 # See comment in handle-static-runtime regarding this logic.
384                 if [ $(p).get <link> ] = shared && [ $(p).get <runtime-link> ] = static
385                    && [ $(p).get <toolset> ] != cw
386                 {
387                     # Skip this
388                 }
389                 else
390                 {
391                     filtered += $(p) ;
392                 }
393             }            
394             return [ build-multiple $(filtered) ] ;            
395         }
396         else
397         {
398             errors.error "Unknown build type" ; 
399         }               
400     }
401     
402     rule build-multiple ( property-sets * )
403     {
404         local usage-requirements = [ property-set.empty ] ;
405         local result ;
406         for local p in $(property-sets)
407         {
408             local r = [ alias-target-class.generate $(p) ] ;
409             if $(r)
410             {
411                 usage-requirements = [ $(usage-requirements).add $(r[1]) ] ;
412                 result += $(r[2-]) ;
413             }
414         }
415         return $(usage-requirements) [ sequence.unique $(result) ] ;
416     }    
417 }
418
419 rule declare_top_level_targets ( libraries * : headers * )
420 {
421     declare_install_and_stage_proper_targets $(libraries) : $(headers) ;
422     
423     targets.create-metatarget top-level-target : [ project.current ]
424         : install
425         : install-proper install-unversioned 
426         ;
427     targets.create-metatarget top-level-target : [ project.current ]
428         : stage
429         : stage-proper stage-unversioned 
430         ;
431
432     p = [ project.current ] ;
433     $(p).mark-target-as-explicit install stage ;
434     
435     # This target is built by default, and will forward to 'stage'
436     # after producing some explanations.
437     targets.create-metatarget top-level-target : [ project.current ]
438         : forward
439         : explain stage
440         ;
441 }
442
443
444 stage-abs = [ path.native [ path.root $(stage-locate)/lib [ path.pwd ] ] ] ;
445
446 ##############################################################################
447 #
448 # 4. Add hook to report configuration before the build, and confirmation
449 # with setup instructions after the build
450 #
451 ##############################################################################  
452
453 message explain :
454 "\nBuilding the Boost C++ Libraries.\n\n" ;
455 p = [ project.current ] ;
456 $(p).mark-target-as-explicit explain ;
457
458 rule pre-build ( )
459 {
460     local tl = [ modules.peek : top-level-targets ] ;
461     if stage in $(tl) || install in $(tl)
462     {
463         # FIXME: remove if when Boost regression tests use trunk
464         # bjam.
465         if PAD in [ RULENAMES ]
466         {            
467             configure.print-component-configuration ;
468         }        
469     }
470 }
471 IMPORT $(__name__) : pre-build : : $(__name__).pre-build ;
472 build-system.set-pre-build-hook $(__name__).pre-build ;
473
474 # FIXME: revive stage_abs
475 rule post-build ( ok ? ) 
476 {
477     if forward in [ modules.peek : top-level-targets ] 
478     {        
479         if $(ok)
480         {
481         ECHO 
482 "\n\nThe Boost C++ Libraries were successfully built!
483           
484 The following directory should be added to compiler include paths:
485           
486     $(BOOST_ROOT)
487       
488 The following directory should be added to linker library paths:
489       
490     $(stage-abs)
491 " ;
492         }    
493     }    
494 }
495 IMPORT $(__name__) : post-build : : $(__name__).post-build ;
496 build-system.set-post-build-hook $(__name__).post-build ;
497
498
499 ##############################################################################
500
501 # 5. Top-level setup 
502 #
503 ##############################################################################  
504
505
506 # Decides which libraries are to be installed by looking at --with-<library>
507 # --without-<library> arguments. Returns the list of directories under "libs"
508 # which must be built and installed.
509 #
510 rule libraries-to-install ( existing-libraries * )
511 {
512    local argv = [ modules.peek : ARGV ] ;
513    local with-parameter = [ MATCH --with-(.*) : $(argv) ] ;
514    local without-parameter = [ MATCH --without-(.*) : $(argv) ] ;
515    
516    if ! $(with-parameter) && ! $(without-parameter)
517    {
518        # Nothing is specified on command line. See if maybe
519        # project-config.jam has some choices. 
520        local project-config-libs = [ modules.peek project-config : libraries ] ;
521        with-parameter = [ MATCH --with-(.*) : $(project-config-libs) ] ;
522        without-parameter = [ MATCH --without-(.*) : $(project-config-libs) ] ;
523    }
524
525    # Do some checks.
526    if $(with-parameter) && $(without-parameter)
527    {
528        ECHO "error: both --with-<library> and --without-<library> specified" ;
529        EXIT ;
530    }
531
532    local wrong = [ set.difference $(with-parameter) : $(existing-libraries) ] ;
533    if $(wrong)
534    {
535        ECHO "error: wrong library name '$(wrong[1])' in the --with-<library> option." ;
536        EXIT ;
537    }
538    local wrong = [ set.difference $(without-parameter) : $(existing-libraries) ] ;
539    if $(wrong)
540    {
541        ECHO "error: wrong library name '$(wrong[1])' in the --without-<library> option." ;
542        EXIT ;
543    }
544
545    if $(with-parameter)
546    {
547        return [ set.intersection $(existing-libraries) : $(with-parameter) ] ;
548    }
549    else
550    {
551        return [ set.difference $(existing-libraries) : $(without-parameter) ] ;
552    }
553 }
554
555 rule declare_targets ( all-libraries * : headers * )
556 {
557     configure.register-components $(all-libraries) ;
558     
559     # Select the libraries to install.
560     libraries = [ libraries-to-install $(all-libraries) ] ;
561     configure.components-building $(libraries) ;
562
563     if [ option.get "show-libraries" : : true ]
564     {
565         ECHO "The following libraries require building:" ;
566         for local l in $(libraries)
567         {
568             ECHO "    - $(l)" ;
569         }
570         EXIT ;
571     }
572
573     declare_top_level_targets $(libraries) : $(headers) ;
574 }