buildtools/wafsamba/wafsamba.py

   1 # a waf tool to add autoconf-like macros to the configure section
   2 # and for SAMBA_ macros for building libraries, binaries etc
   3
   4 import Build, os, Options, Task, Utils, cc, TaskGen, fnmatch, re, shutil, Logs, Constants
   5 from Configure import conf
   6 from Logs import debug
   7 from samba_utils import SUBST_VARS_RECURSIVE
   8 TaskGen.task_gen.apply_verif = Utils.nada
   9
  10 # bring in the other samba modules
  11 from samba_optimisation import *
  12 from samba_utils import *
  13 from samba_version import *
  14 from samba_autoconf import *
  15 from samba_patterns import *
  16 from samba_pidl import *
  17 from samba_autoproto import *
  18 from samba_python import *
  19 from samba_deps import *
  20 from samba_bundled import *
  21 import samba_install
  22 import samba_conftests
  23 import samba_abi
  24 import tru64cc
  25 import irixcc
  26 import generic_cc
  27 import samba_dist
  28 import samba_wildcard
  29
  30 # some systems have broken threading in python
  31 if os.environ.get('WAF_NOTHREADS') == '1':
  32     import nothreads
  33
  34 LIB_PATH="shared"
  35
  36 os.putenv('PYTHONUNBUFFERED', '1')
  37
  38
  39 if Constants.HEXVERSION < 0x105019:
  40     Logs.error('''
  41 Please use the version of waf that comes with Samba, not
  42 a system installed version. See http://wiki.samba.org/index.php/Waf
  43 for details.
  44
  45 Alternatively, please use ./autogen-waf.sh, and then
  46 run ./configure and make as usual. That will call the right version of waf.
  47 ''')
  48     sys.exit(1)
  49
  50
  51 @conf
  52 def SAMBA_BUILD_ENV(conf):
  53     '''create the samba build environment'''
  54     conf.env.BUILD_DIRECTORY = conf.blddir
  55     mkdir_p(os.path.join(conf.blddir, LIB_PATH))
  56     mkdir_p(os.path.join(conf.blddir, "modules"))
  57     mkdir_p(os.path.join(conf.blddir, 'python/samba/dcerpc'))
  58     # this allows all of the bin/shared and bin/python targets
  59     # to be expressed in terms of build directory paths
  60     mkdir_p(os.path.join(conf.blddir, 'default'))
  61     for p in ['python','shared', 'modules']:
  62         link_target = os.path.join(conf.blddir, 'default/' + p)
  63         if not os.path.lexists(link_target):
  64             os.symlink('../' + p, link_target)
  65
  66     # get perl to put the blib files in the build directory
  67     blib_bld = os.path.join(conf.blddir, 'default/pidl/blib')
  68     blib_src = os.path.join(conf.srcdir, 'pidl/blib')
  69     mkdir_p(blib_bld + '/man1')
  70     mkdir_p(blib_bld + '/man3')
  71     if os.path.islink(blib_src):
  72         os.unlink(blib_src)
  73     elif os.path.exists(blib_src):
  74         shutil.rmtree(blib_src)
  75
  76
  77 def ADD_INIT_FUNCTION(bld, subsystem, target, init_function):
  78     '''add an init_function to the list for a subsystem'''
  79     if init_function is None:
  80         return
  81     bld.ASSERT(subsystem is not None, "You must specify a subsystem for init_function '%s'" % init_function)
  82     cache = LOCAL_CACHE(bld, 'INIT_FUNCTIONS')
  83     if not subsystem in cache:
  84         cache[subsystem] = []
  85     cache[subsystem].append( { 'TARGET':target, 'INIT_FUNCTION':init_function } )
  86 Build.BuildContext.ADD_INIT_FUNCTION = ADD_INIT_FUNCTION
  87
  88
  89
  90 #################################################################
  91 def SAMBA_LIBRARY(bld, libname, source,
  92                   deps='',
  93                   public_deps='',
  94                   includes='',
  95                   public_headers=None,
  96                   header_path=None,
  97                   pc_files=None,
  98                   vnum=None,
  99                   cflags='',
 100                   external_library=False,
 101                   realname=None,
 102                   autoproto=None,
 103                   group='main',
 104                   depends_on='',
 105                   local_include=True,
 106                   vars=None,
 107                   install_path=None,
 108                   install=True,
 109                   pyembed=False,
 110                   target_type='LIBRARY',
 111                   bundled_extension=True,
 112                   link_name=None,
 113                   abi_file=None,
 114                   abi_match=None,
 115                   hide_symbols=False,
 116                   is_bundled=False,
 117                   manpages=None,
 118                   enabled=True):
 119     '''define a Samba library'''
 120
 121     if not enabled:
 122         SET_TARGET_TYPE(bld, libname, 'DISABLED')
 123         return
 124
 125     source = bld.EXPAND_VARIABLES(source, vars=vars)
 126
 127     # remember empty libraries, so we can strip the dependencies
 128     if ((source == '') or (source == [])) and deps == '' and public_deps == '':
 129         SET_TARGET_TYPE(bld, libname, 'EMPTY')
 130         return
 131
 132     if BUILTIN_LIBRARY(bld, libname):
 133         obj_target = libname
 134     else:
 135         obj_target = libname + '.objlist'
 136
 137     # first create a target for building the object files for this library
 138     # by separating in this way, we avoid recompiling the C files
 139     # separately for the install library and the build library
 140     bld.SAMBA_SUBSYSTEM(obj_target,
 141                         source         = source,
 142                         deps           = deps,
 143                         public_deps    = public_deps,
 144                         includes       = includes,
 145                         public_headers = public_headers,
 146                         header_path    = header_path,
 147                         cflags         = cflags,
 148                         group          = group,
 149                         autoproto      = autoproto,
 150                         depends_on     = depends_on,
 151                         pyembed        = pyembed,
 152                         hide_symbols   = hide_symbols,
 153                         local_include  = local_include)
 154
 155     if BUILTIN_LIBRARY(bld, libname):
 156         return
 157
 158     if not SET_TARGET_TYPE(bld, libname, target_type):
 159         return
 160
 161     # the library itself will depend on that object target
 162     deps += ' ' + public_deps
 163     deps = TO_LIST(deps)
 164     deps.append(obj_target)
 165
 166     if target_type == 'PYTHON' or realname or not is_bundled:
 167         # Sanitize the library name
 168         bundled_name = libname.lower().replace('_', '-')
 169         while bundled_name.startswith("lib"):
 170             bundled_name = bundled_name[3:]
 171     else:
 172         bundled_name = BUNDLED_NAME(bld, libname, bundled_extension)
 173
 174     features = 'cc cshlib symlink_lib install_lib'
 175     if target_type == 'PYTHON':
 176         features += ' pyext'
 177     if pyembed:
 178         features += ' pyembed'
 179     if abi_file:
 180         features += ' abi_check'
 181
 182     if abi_file:
 183         abi_file = os.path.join(bld.curdir, abi_file)
 184
 185     bld.SET_BUILD_GROUP(group)
 186     t = bld(
 187         features        = features,
 188         source          = [],
 189         target          = bundled_name,
 190         samba_cflags    = CURRENT_CFLAGS(bld, libname, cflags),
 191         depends_on      = depends_on,
 192         samba_deps      = deps,
 193         samba_includes  = includes,
 194         local_include   = local_include,
 195         vnum            = vnum,
 196         install_path    = None,
 197         samba_inst_path = install_path,
 198         name            = libname,
 199         samba_realname  = realname,
 200         samba_install   = install,
 201         abi_file        = abi_file,
 202         abi_match       = abi_match,
 203         is_bundled      = is_bundled
 204         )
 205
 206     if realname and not link_name:
 207         link_name = 'shared/%s' % realname
 208
 209     if link_name:
 210         t.link_name = link_name
 211
 212     if pc_files is not None:
 213         bld.PKG_CONFIG_FILES(pc_files, vnum=vnum)
 214
 215     if manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']:
 216         bld.MANPAGES(manpages)
 217
 218
 219 Build.BuildContext.SAMBA_LIBRARY = SAMBA_LIBRARY
 220
 221
 222 #################################################################
 223 def SAMBA_BINARY(bld, binname, source,
 224                  deps='',
 225                  includes='',
 226                  public_headers=None,
 227                  header_path=None,
 228                  modules=None,
 229                  ldflags=None,
 230                  cflags='',
 231                  autoproto=None,
 232                  use_hostcc=False,
 233                  use_global_deps=True,
 234                  compiler=None,
 235                  group='binaries',
 236                  manpages=None,
 237                  local_include=True,
 238                  subsystem_name=None,
 239                  pyembed=False,
 240                  vars=None,
 241                  install=True,
 242                  install_path=None,
 243                  enabled=True):
 244     '''define a Samba binary'''
 245
 246     if not enabled:
 247         SET_TARGET_TYPE(bld, binname, 'DISABLED')
 248         return
 249
 250     if not SET_TARGET_TYPE(bld, binname, 'BINARY'):
 251         return
 252
 253     features = 'cc cprogram symlink_bin install_bin'
 254     if pyembed:
 255         features += ' pyembed'
 256
 257     obj_target = binname + '.objlist'
 258
 259     source = bld.EXPAND_VARIABLES(source, vars=vars)
 260     source = unique_list(TO_LIST(source))
 261
 262     # first create a target for building the object files for this binary
 263     # by separating in this way, we avoid recompiling the C files
 264     # separately for the install binary and the build binary
 265     bld.SAMBA_SUBSYSTEM(obj_target,
 266                         source         = source,
 267                         deps           = deps,
 268                         includes       = includes,
 269                         cflags         = cflags,
 270                         group          = group,
 271                         autoproto      = autoproto,
 272                         subsystem_name = subsystem_name,
 273                         pyembed        = pyembed,
 274                         local_include  = local_include,
 275                         use_hostcc     = use_hostcc,
 276                         use_global_deps= use_global_deps)
 277
 278     bld.SET_BUILD_GROUP(group)
 279
 280     # the binary itself will depend on that object target
 281     deps = TO_LIST(deps)
 282     deps.append(obj_target)
 283
 284     t = bld(
 285         features       = features,
 286         source         = [],
 287         target         = binname,
 288         samba_cflags   = CURRENT_CFLAGS(bld, binname, cflags),
 289         samba_deps     = deps,
 290         samba_includes = includes,
 291         local_include  = local_include,
 292         samba_modules  = modules,
 293         top            = True,
 294         samba_subsystem= subsystem_name,
 295         install_path   = None,
 296         samba_inst_path= install_path,
 297         samba_install  = install
 298         )
 299
 300     # setup the subsystem_name as an alias for the real
 301     # binary name, so it can be found when expanding
 302     # subsystem dependencies
 303     if subsystem_name is not None:
 304         bld.TARGET_ALIAS(subsystem_name, binname)
 305
 306     if manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']:
 307         bld.MANPAGES(manpages)
 308
 309 Build.BuildContext.SAMBA_BINARY = SAMBA_BINARY
 310
 311
 312 #################################################################
 313 def SAMBA_MODULE(bld, modname, source,
 314                  deps='',
 315                  includes='',
 316                  subsystem=None,
 317                  init_function=None,
 318                  autoproto=None,
 319                  autoproto_extra_source='',
 320                  aliases=None,
 321                  cflags='',
 322                  internal_module=True,
 323                  local_include=True,
 324                  vars=None,
 325                  enabled=True,
 326                  pyembed=True,
 327                  ):
 328     '''define a Samba module.'''
 329
 330     source = bld.EXPAND_VARIABLES(source, vars=vars)
 331
 332     if internal_module or BUILTIN_LIBRARY(bld, modname):
 333         # treat internal modules as subsystems for now
 334         if subsystem is not None:
 335             deps += ' ' + subsystem
 336
 337         bld.SAMBA_SUBSYSTEM(modname, source,
 338                     deps=deps,
 339                     includes=includes,
 340                     autoproto=autoproto,
 341                     autoproto_extra_source=autoproto_extra_source,
 342                     cflags=cflags,
 343                     local_include=local_include,
 344                     enabled=enabled)
 345
 346         bld.ADD_INIT_FUNCTION(subsystem, modname, init_function)
 347         return
 348
 349     if not enabled:
 350         SET_TARGET_TYPE(bld, modname, 'DISABLED')
 351         return
 352
 353     modnames = [modname] + TO_LIST(aliases)
 354     for modname in modnames:
 355         obj_target = modname + '.objlist'
 356
 357         realname = modname
 358         if subsystem is not None:
 359             deps += ' ' + subsystem
 360             while realname.startswith("lib"+subsystem+"_"):
 361                 realname = realname[len("lib"+subsystem+"_"):]
 362             while realname.startswith(subsystem+"_"):
 363                 realname = realname[len(subsystem+"_"):]
 364
 365         realname = bld.env.shlib_PATTERN % realname
 366         while realname.startswith("lib"):
 367             realname = realname[len("lib"):]
 368
 369         build_link_name = "modules/%s/%s" % (subsystem, realname)
 370
 371         if init_function:
 372             cflags += " -D%s=samba_init_module" % init_function
 373
 374         bld.SAMBA_LIBRARY(modname,
 375                           source,
 376                           deps=deps,
 377                           cflags=cflags,
 378                           realname = realname,
 379                           autoproto = autoproto,
 380                           local_include=local_include,
 381                           vars=vars,
 382                           link_name=build_link_name,
 383                           install_path="${MODULESDIR}/%s" % subsystem,
 384                           pyembed=pyembed,
 385                           )
 386
 387 Build.BuildContext.SAMBA_MODULE = SAMBA_MODULE
 388
 389
 390 #################################################################
 391 def SAMBA_SUBSYSTEM(bld, modname, source,
 392                     deps='',
 393                     public_deps='',
 394                     includes='',
 395                     public_headers=None,
 396                     header_path=None,
 397                     cflags='',
 398                     cflags_end=None,
 399                     group='main',
 400                     init_function_sentinal=None,
 401                     autoproto=None,
 402                     autoproto_extra_source='',
 403                     depends_on='',
 404                     local_include=True,
 405                     local_include_first=True,
 406                     subsystem_name=None,
 407                     enabled=True,
 408                     use_hostcc=False,
 409                     use_global_deps=True,
 410                     vars=None,
 411                     hide_symbols=False,
 412                     pyembed=False,
 413                     pyext=False):
 414     '''define a Samba subsystem'''
 415
 416     if not enabled:
 417         SET_TARGET_TYPE(bld, modname, 'DISABLED')
 418         return
 419
 420     # remember empty subsystems, so we can strip the dependencies
 421     if ((source == '') or (source == [])) and deps == '' and public_deps == '':
 422         SET_TARGET_TYPE(bld, modname, 'EMPTY')
 423         return
 424
 425     if not SET_TARGET_TYPE(bld, modname, 'SUBSYSTEM'):
 426         return
 427
 428     source = bld.EXPAND_VARIABLES(source, vars=vars)
 429     source = unique_list(TO_LIST(source))
 430
 431     deps += ' ' + public_deps
 432
 433     bld.SET_BUILD_GROUP(group)
 434
 435     features = 'cc'
 436     if pyembed:
 437         features += ' pyembed'
 438     if pyext:
 439         features += ' pyext'
 440
 441     t = bld(
 442         features       = features,
 443         source         = source,
 444         target         = modname,
 445         samba_cflags   = CURRENT_CFLAGS(bld, modname, cflags, hide_symbols=hide_symbols),
 446         depends_on     = depends_on,
 447         samba_deps     = TO_LIST(deps),
 448         samba_includes = includes,
 449         local_include  = local_include,
 450         local_include_first  = local_include_first,
 451         samba_subsystem= subsystem_name,
 452         samba_use_hostcc = use_hostcc,
 453         samba_use_global_deps = use_global_deps
 454         )
 455
 456     if cflags_end is not None:
 457         t.samba_cflags.extend(TO_LIST(cflags_end))
 458
 459     if autoproto is not None:
 460         bld.SAMBA_AUTOPROTO(autoproto, source + TO_LIST(autoproto_extra_source))
 461     if public_headers is not None:
 462         bld.PUBLIC_HEADERS(public_headers, header_path=header_path)
 463     return t
 464
 465
 466 Build.BuildContext.SAMBA_SUBSYSTEM = SAMBA_SUBSYSTEM
 467
 468
 469 def SAMBA_GENERATOR(bld, name, rule, source='', target='',
 470                     group='generators', enabled=True,
 471                     public_headers=None,
 472                     header_path=None,
 473                     vars=None,
 474                     always=False):
 475     '''A generic source generator target'''
 476
 477     if not SET_TARGET_TYPE(bld, name, 'GENERATOR'):
 478         return
 479
 480     if not enabled:
 481         return
 482
 483     bld.SET_BUILD_GROUP(group)
 484     t = bld(
 485         rule=rule,
 486         source=bld.EXPAND_VARIABLES(source, vars=vars),
 487         target=target,
 488         shell=isinstance(rule, str),
 489         on_results=True,
 490         before='cc',
 491         ext_out='.c',
 492         name=name)
 493
 494     if always:
 495         t.always = True
 496
 497     if public_headers is not None:
 498         bld.PUBLIC_HEADERS(public_headers, header_path=header_path)
 499     return t
 500 Build.BuildContext.SAMBA_GENERATOR = SAMBA_GENERATOR
 501
 502
 503
 504 @runonce
 505 def SETUP_BUILD_GROUPS(bld):
 506     '''setup build groups used to ensure that the different build
 507     phases happen consecutively'''
 508     bld.p_ln = bld.srcnode # we do want to see all targets!
 509     bld.env['USING_BUILD_GROUPS'] = True
 510     bld.add_group('setup')
 511     bld.add_group('build_compiler_source')
 512     bld.add_group('base_libraries')
 513     bld.add_group('generators')
 514     bld.add_group('compiler_prototypes')
 515     bld.add_group('compiler_libraries')
 516     bld.add_group('build_compilers')
 517     bld.add_group('build_source')
 518     bld.add_group('prototypes')
 519     bld.add_group('main')
 520     bld.add_group('binaries')
 521     bld.add_group('final')
 522 Build.BuildContext.SETUP_BUILD_GROUPS = SETUP_BUILD_GROUPS
 523
 524
 525 def SET_BUILD_GROUP(bld, group):
 526     '''set the current build group'''
 527     if not 'USING_BUILD_GROUPS' in bld.env:
 528         return
 529     bld.set_group(group)
 530 Build.BuildContext.SET_BUILD_GROUP = SET_BUILD_GROUP
 531
 532
 533
 534 @conf
 535 def ENABLE_TIMESTAMP_DEPENDENCIES(conf):
 536     """use timestamps instead of file contents for deps
 537     this currently doesn't work"""
 538     def h_file(filename):
 539         import stat
 540         st = os.stat(filename)
 541         if stat.S_ISDIR(st[stat.ST_MODE]): raise IOError('not a file')
 542         m = Utils.md5()
 543         m.update(str(st.st_mtime))
 544         m.update(str(st.st_size))
 545         m.update(filename)
 546         return m.digest()
 547     Utils.h_file = h_file
 548
 549
 550
 551 t = Task.simple_task_type('copy_script', 'rm -f ${LINK_TARGET} && ln -s ${SRC[0].abspath(env)} ${LINK_TARGET}',
 552                           shell=True, color='PINK', ext_in='.bin')
 553 t.quiet = True
 554
 555 @feature('copy_script')
 556 @before('apply_link')
 557 def copy_script(self):
 558     tsk = self.create_task('copy_script', self.allnodes[0])
 559     tsk.env.TARGET = self.target
 560
 561 def SAMBA_SCRIPT(bld, name, pattern, installdir, installname=None):
 562     '''used to copy scripts from the source tree into the build directory
 563        for use by selftest'''
 564
 565     source = bld.path.ant_glob(pattern)
 566
 567     bld.SET_BUILD_GROUP('build_source')
 568     for s in TO_LIST(source):
 569         iname = s
 570         if installname != None:
 571             iname = installname
 572         target = os.path.join(installdir, iname)
 573         tgtdir = os.path.dirname(os.path.join(bld.srcnode.abspath(bld.env), '..', target))
 574         mkdir_p(tgtdir)
 575         t = bld(features='copy_script',
 576                 source       = s,
 577                 target       = target,
 578                 always       = True,
 579                 install_path = None)
 580         t.env.LINK_TARGET = target
 581
 582 Build.BuildContext.SAMBA_SCRIPT = SAMBA_SCRIPT
 583
 584
 585 def install_file(bld, destdir, file, chmod=MODE_644, flat=False,
 586                  python_fixup=False, destname=None, base_name=None):
 587     '''install a file'''
 588     destdir = bld.EXPAND_VARIABLES(destdir)
 589     if not destname:
 590         destname = file
 591         if flat:
 592             destname = os.path.basename(destname)
 593     dest = os.path.join(destdir, destname)
 594     if python_fixup:
 595         # fixup the python path it will use to find Samba modules
 596         inst_file = file + '.inst'
 597         if bld.env["PYTHONDIR"] not in sys.path:
 598             regex = "s|\(sys.path.insert.*\)bin/python\(.*\)$|\\1${PYTHONDIR}\\2|g"
 599         else:
 600             # Eliminate updating sys.path if the target python dir is already
 601             # in python path.
 602             regex = "s|sys.path.insert.*bin/python.*$||g"
 603         bld.SAMBA_GENERATOR('python_%s' % destname,
 604                             rule="sed '%s' < ${SRC} > ${TGT}" % regex,
 605                             source=file,
 606                             target=inst_file)
 607         file = inst_file
 608     if base_name:
 609         file = os.path.join(base_name, file)
 610     bld.install_as(dest, file, chmod=chmod)
 611
 612
 613 def INSTALL_FILES(bld, destdir, files, chmod=MODE_644, flat=False,
 614                   python_fixup=False, destname=None, base_name=None):
 615     '''install a set of files'''
 616     for f in TO_LIST(files):
 617         install_file(bld, destdir, f, chmod=chmod, flat=flat,
 618                      python_fixup=python_fixup, destname=destname,
 619                      base_name=base_name)
 620 Build.BuildContext.INSTALL_FILES = INSTALL_FILES
 621
 622
 623 def INSTALL_WILDCARD(bld, destdir, pattern, chmod=MODE_644, flat=False,
 624                      python_fixup=False, exclude=None, trim_path=None):
 625     '''install a set of files matching a wildcard pattern'''
 626     files=TO_LIST(bld.path.ant_glob(pattern))
 627     if trim_path:
 628         files2 = []
 629         for f in files:
 630             files2.append(os_path_relpath(f, trim_path))
 631         files = files2
 632
 633     if exclude:
 634         for f in files[:]:
 635             if fnmatch.fnmatch(f, exclude):
 636                 files.remove(f)
 637     INSTALL_FILES(bld, destdir, files, chmod=chmod, flat=flat,
 638                   python_fixup=python_fixup, base_name=trim_path)
 639 Build.BuildContext.INSTALL_WILDCARD = INSTALL_WILDCARD
 640
 641
 642 def INSTALL_DIRS(bld, destdir, dirs):
 643     '''install a set of directories'''
 644     destdir = bld.EXPAND_VARIABLES(destdir)
 645     dirs = bld.EXPAND_VARIABLES(dirs)
 646     for d in TO_LIST(dirs):
 647         bld.install_dir(os.path.join(destdir, d))
 648 Build.BuildContext.INSTALL_DIRS = INSTALL_DIRS
 649
 650
 651 re_header = re.compile('#include[ \t]*"([^"]+)"', re.I | re.M)
 652 class header_task(Task.Task):
 653     """
 654     The public headers (the one installed on the system) have both
 655     different paths and contents, so the rename is not enough.
 656
 657     Intermediate .inst.h files are created because path manipulation
 658     may be slow. The substitution is thus performed only once.
 659     """
 660
 661     name = 'header'
 662     color = 'PINK'
 663     vars = ['INCLUDEDIR', 'HEADER_DEPS']
 664
 665     def run(self):
 666         txt = self.inputs[0].read(self.env)
 667
 668         # hard-coded string, but only present in samba4 (I promise, you won't feel a thing)
 669         txt = txt.replace('#if _SAMBA_BUILD_ == 4', '#if 1\n')
 670
 671         # use a regexp to substitute the #include lines in the files
 672         map = self.generator.bld.hnodemap
 673         dirnodes = self.generator.bld.hnodedirs
 674         def repl(m):
 675             if m.group(1):
 676                 s = m.group(1)
 677
 678                 # pokemon headers: gotta catch'em all!
 679                 fin = s
 680                 if s.startswith('bin/default'):
 681                     node = self.generator.bld.srcnode.find_resource(s.replace('bin/default/', ''))
 682                     if not node:
 683                         Logs.warn('could not find the public header for %r' % s)
 684                     elif node.id in map:
 685                         fin = map[node.id]
 686                     else:
 687                         Logs.warn('could not find the public header replacement for build header %r' % s)
 688                 else:
 689                     # this part is more difficult since the path may be relative to anything
 690                     for dirnode in dirnodes:
 691                         node = dirnode.find_resource(s)
 692                         if node:
 693                              if node.id in map:
 694                                  fin = map[node.id]
 695                                  break
 696                              else:
 697                                  Logs.warn('could not find the public header replacement for source header %r %r' % (s, node))
 698                     else:
 699                         Logs.warn('-> could not find the public header for %r' % s)
 700
 701                 return "#include <%s>" % fin
 702             return ''
 703
 704         txt = re_header.sub(repl, txt)
 705
 706         # and write the output file
 707         f = None
 708         try:
 709             f = open(self.outputs[0].abspath(self.env), 'w')
 710             f.write(txt)
 711         finally:
 712             if f:
 713                 f.close()
 714
 715 @TaskGen.feature('pubh')
 716 def make_public_headers(self):
 717     """
 718     collect the public headers to process and to install, then
 719     create the substitutions (name and contents)
 720     """
 721
 722     if not self.bld.is_install:
 723         # install time only (lazy)
 724         return
 725
 726     # keep two variables
 727     #    hnodedirs: list of folders for searching the headers
 728     #    hnodemap: node ids and replacement string (node objects are unique)
 729     try:
 730         self.bld.hnodedirs.append(self.path)
 731     except AttributeError:
 732         self.bld.hnodemap = {}
 733         self.bld.hnodedirs = [self.bld.srcnode, self.path]
 734
 735         for k in 'source4 source4/include lib/talloc lib/tevent/ source4/lib/ldb/include/'.split():
 736             node = self.bld.srcnode.find_dir(k)
 737             if node:
 738                 self.bld.hnodedirs.append(node)
 739
 740     header_path = getattr(self, 'header_path', None) or ''
 741
 742     for x in self.to_list(self.headers):
 743
 744         # too complicated, but what was the original idea?
 745         if isinstance(header_path, list):
 746             add_dir = ''
 747             for (p1, dir) in header_path:
 748                 lst = self.to_list(p1)
 749                 for p2 in lst:
 750                     if fnmatch.fnmatch(x, p2):
 751                         add_dir = dir
 752                         break
 753                 else:
 754                     continue
 755                 break
 756             inst_path = add_dir
 757         else:
 758             inst_path = header_path
 759
 760         dest = ''
 761         name = x
 762         if x.find(':') != -1:
 763             s = x.split(':')
 764             name = s[0]
 765             dest = s[1]
 766
 767         inn = self.path.find_resource(name)
 768
 769         if not inn:
 770             raise ValueError("could not find the public header %r in %r" % (name, self.path))
 771         out = inn.change_ext('.inst.h')
 772         self.create_task('header', inn, out)
 773
 774         if not dest:
 775             dest = inn.name
 776
 777         if inst_path:
 778             inst_path = inst_path + '/'
 779         inst_path = inst_path + dest
 780
 781         self.bld.install_as('${INCLUDEDIR}/%s' % inst_path, out, self.env)
 782
 783         self.bld.hnodemap[inn.id] = inst_path
 784
 785     # create a hash (not md5) to make sure the headers are re-created if something changes
 786     val = 0
 787     lst = list(self.bld.hnodemap.keys())
 788     lst.sort()
 789     for k in lst:
 790         val = hash((val, k, self.bld.hnodemap[k]))
 791     self.bld.env.HEADER_DEPS = val
 792
 793 def PUBLIC_HEADERS(bld, public_headers, header_path=None):
 794     '''install some headers
 795
 796     header_path may either be a string that is added to the INCLUDEDIR,
 797     or it can be a dictionary of wildcard patterns which map to destination
 798     directories relative to INCLUDEDIR
 799     '''
 800     bld.SET_BUILD_GROUP('final')
 801     ret = bld(features=['pubh'], headers=public_headers, header_path=header_path)
 802     return ret
 803 Build.BuildContext.PUBLIC_HEADERS = PUBLIC_HEADERS
 804
 805
 806 def subst_at_vars(task):
 807     '''substiture @VAR@ style variables in a file'''
 808     src = task.inputs[0].srcpath(task.env)
 809     tgt = task.outputs[0].bldpath(task.env)
 810
 811     f = open(src, 'r')
 812     s = f.read()
 813     f.close()
 814     # split on the vars
 815     a = re.split('(@\w+@)', s)
 816     out = []
 817     done_var = {}
 818     back_sub = [ ('PREFIX', '${prefix}'), ('EXEC_PREFIX', '${exec_prefix}')]
 819     for v in a:
 820         if re.match('@\w+@', v):
 821             vname = v[1:-1]
 822             if not vname in task.env and vname.upper() in task.env:
 823                 vname = vname.upper()
 824             if not vname in task.env:
 825                 Logs.error("Unknown substitution %s in %s" % (v, task.name))
 826                 sys.exit(1)
 827             v = SUBST_VARS_RECURSIVE(task.env[vname], task.env)
 828             # now we back substitute the allowed pc vars
 829             for (b, m) in back_sub:
 830                 s = task.env[b]
 831                 if s == v[0:len(s)]:
 832                     if not b in done_var:
 833                         # we don't want to substitute the first usage
 834                         done_var[b] = True
 835                     else:
 836                         v = m + v[len(s):]
 837                     break
 838         out.append(v)
 839     contents = ''.join(out)
 840     f = open(tgt, 'w')
 841     s = f.write(contents)
 842     f.close()
 843     return 0
 844
 845
 846
 847 def PKG_CONFIG_FILES(bld, pc_files, vnum=None):
 848     '''install some pkg_config pc files'''
 849     dest = '${PKGCONFIGDIR}'
 850     dest = bld.EXPAND_VARIABLES(dest)
 851     for f in TO_LIST(pc_files):
 852         base=os.path.basename(f)
 853         t = bld.SAMBA_GENERATOR('PKGCONFIG_%s' % base,
 854                                 rule=subst_at_vars,
 855                                 source=f+'.in',
 856                                 target=f)
 857         if vnum:
 858             t.env.PACKAGE_VERSION = vnum
 859         INSTALL_FILES(bld, dest, f, flat=True, destname=base)
 860 Build.BuildContext.PKG_CONFIG_FILES = PKG_CONFIG_FILES
 861
 862
 863 def MANPAGES(bld, manpages):
 864     '''build and install manual pages'''
 865     bld.env.MAN_XSL = 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl'
 866     for m in manpages.split():
 867         source = m + '.xml'
 868         bld.SAMBA_GENERATOR(m,
 869                             source=source,
 870                             target=m,
 871                             group='final',
 872                             rule='${XSLTPROC} -o ${TGT} --nonet ${MAN_XSL} ${SRC}'
 873                             )
 874         bld.INSTALL_FILES('${MANDIR}/man%s' % m[-1], m, flat=True)
 875 Build.BuildContext.MANPAGES = MANPAGES
 876
 877
 878 #############################################################
 879 # give a nicer display when building different types of files
 880 def progress_display(self, msg, fname):
 881     col1 = Logs.colors(self.color)
 882     col2 = Logs.colors.NORMAL
 883     total = self.position[1]
 884     n = len(str(total))
 885     fs = '[%%%dd/%%%dd] %s %%s%%s%%s\n' % (n, n, msg)
 886     return fs % (self.position[0], self.position[1], col1, fname, col2)
 887
 888 def link_display(self):
 889     if Options.options.progress_bar != 0:
 890         return Task.Task.old_display(self)
 891     fname = self.outputs[0].bldpath(self.env)
 892     return progress_display(self, 'Linking', fname)
 893 Task.TaskBase.classes['cc_link'].display = link_display
 894
 895 def samba_display(self):
 896     if Options.options.progress_bar != 0:
 897         return Task.Task.old_display(self)
 898
 899     targets    = LOCAL_CACHE(self, 'TARGET_TYPE')
 900     if self.name in targets:
 901         target_type = targets[self.name]
 902         type_map = { 'GENERATOR' : 'Generating',
 903                      'PROTOTYPE' : 'Generating'
 904                      }
 905         if target_type in type_map:
 906             return progress_display(self, type_map[target_type], self.name)
 907
 908     fname = self.inputs[0].bldpath(self.env)
 909     if fname[0:3] == '../':
 910         fname = fname[3:]
 911     ext_loc = fname.rfind('.')
 912     if ext_loc == -1:
 913         return Task.Task.old_display(self)
 914     ext = fname[ext_loc:]
 915
 916     ext_map = { '.idl' : 'Compiling IDL',
 917                 '.et'  : 'Compiling ERRTABLE',
 918                 '.asn1': 'Compiling ASN1',
 919                 '.c'   : 'Compiling' }
 920     if ext in ext_map:
 921         return progress_display(self, ext_map[ext], fname)
 922     return Task.Task.old_display(self)
 923
 924 Task.TaskBase.classes['Task'].old_display = Task.TaskBase.classes['Task'].display
 925 Task.TaskBase.classes['Task'].display = samba_display