development/scons/SConstruct

   1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
   2 #
   3 # file SConstruct
   4 #
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7 #
   8 # \author Bo Peng
   9 # Full author contact details are available in file CREDITS.
  10 #
  11 # This is a scons based building system for lyx, please refer
  12 # to INSTALL.scons for detailed instructions.
  13 #
  14
  15 import os, sys, copy, cPickle, glob, time
  16
  17 # determine where I am ...
  18 #
  19 from SCons.Node.FS import default_fs
  20 # default_fs.SConstruct_dir is where SConstruct file is located.
  21 scons_dir = default_fs.SConstruct_dir.path
  22 scons_absdir = default_fs.SConstruct_dir.abspath
  23
  24 # if SConstruct is copied to the top source directory
  25 if os.path.exists(os.path.join(scons_dir, 'development', 'scons', 'scons_manifest.py')):
  26     scons_dir = os.path.join(scons_dir, 'development', 'scons')
  27     scons_absdir = os.path.join(scons_absdir, 'development', 'scons')
  28 # get the ../.. of scons_dir
  29 top_src_dir = os.path.split(os.path.split(scons_absdir)[0])[0]
  30
  31 sys.path.extend([scons_absdir, os.path.join(top_src_dir, 'lib', 'doc')])
  32 import depend
  33
  34 # scons_utils.py defines a few utility function
  35 import scons_utils as utils
  36 # import all file lists
  37 from scons_manifest import *
  38
  39 #----------------------------------------------------------
  40 # Required runtime environment
  41 #----------------------------------------------------------
  42
  43 # scons asks for 1.5.2, lyx requires 2.3
  44 EnsurePythonVersion(2, 3)
  45 # Please use at least 0.96.92 (not 0.96.1)
  46 EnsureSConsVersion(0, 96)
  47 # also check for minor version number for scons 0.96
  48 from SCons import __version__
  49 version = map(int, __version__.split('.'))
  50 if version[0] == 0 and version[1] == 96 and version[2] < 92:
  51     print "Scons >= 0.96.92 is required."
  52     Exit(1)
  53
  54
  55 #----------------------------------------------------------
  56 # Global definitions
  57 #----------------------------------------------------------
  58
  59 # some global settings
  60 #
  61 # get version number from configure.ac so that JMarc does
  62 # not have to change SConstruct during lyx release
  63 package_version = utils.getVerFromConfigure(top_src_dir)
  64 package_cygwin_version = '%s-1' % package_version
  65 boost_version = ['1_34']
  66
  67 if 'svn' in package_version:
  68     devel_version = True
  69     default_build_mode = 'debug'
  70 else:
  71     devel_version = False
  72     default_build_mode = 'release'
  73
  74 package = 'lyx'
  75 package_bugreport = 'lyx-devel@lists.lyx.org'
  76 package_name = 'LyX'
  77 package_tarname = 'lyx'
  78 package_string = '%s %s' % (package_name, package_version)
  79
  80 # various cache/log files
  81 default_log_file = 'scons_lyx.log'
  82 opt_cache_file = 'opt.cache'
  83
  84
  85 #----------------------------------------------------------
  86 # platform dependent settings
  87 #----------------------------------------------------------
  88
  89 if os.name == 'nt':
  90     platform_name = 'win32'
  91     default_prefix = 'c:/program files/lyx'
  92     default_with_x = False
  93     default_packaging_method = 'windows'
  94 elif os.name == 'posix' and sys.platform != 'cygwin':
  95     platform_name = sys.platform
  96     default_prefix = '/usr/local'
  97     default_with_x = True
  98     default_packaging_method = 'posix'
  99 elif os.name == 'posix' and sys.platform == 'cygwin':
 100     platform_name = 'cygwin'
 101     default_prefix = '/usr'
 102     default_with_x = True
 103     default_packaging_method = 'posix'
 104 elif os.name == 'darwin':
 105     platform_name = 'macosx'
 106     # FIXME: macOSX default prefix?
 107     default_prefix = '.'
 108     default_with_x = False
 109     default_packaging_method = 'macosx'
 110 else:  # unsupported system, assume posix behavior
 111     platform_name = 'others'
 112     default_prefix = '.'
 113     default_with_x = True
 114     default_packaging_method = 'posix'
 115
 116 #---------------------------------------------------------
 117 # Handling options
 118 #----------------------------------------------------------
 119 #
 120 # You can set perminant default values in config.py
 121 if os.path.isfile('config.py'):
 122     print "Getting options from config.py..."
 123     print open('config.py').read()
 124
 125 opts = Options(['config.py'])
 126 opts.AddOptions(
 127     # frontend
 128     EnumOption('frontend', 'Main GUI', 'qt4',
 129         allowed_values = ('qt4',) ),
 130     # debug or release build
 131     EnumOption('mode', 'Building method', default_build_mode,
 132         allowed_values = ('debug', 'release') ),
 133     # boost libraries
 134     EnumOption('boost',
 135         'Use included, system boost library, or try sytem boost first.',
 136         'auto', allowed_values = (
 137             'auto',       # detect boost, if not found, use included
 138             'included',   # always use included boost
 139             'system',     # always use system boost, fail if can not find
 140             ) ),
 141     #
 142     EnumOption('gettext',
 143         'Use included, system gettext library, or try sytem gettext first',
 144         'auto', allowed_values = (
 145             'auto',       # detect gettext, if not found, use included
 146             'included',   # always use included gettext
 147             'system',     # always use system gettext, fail if can not find
 148             ) ),
 149     #
 150     EnumOption('spell', 'Choose spell checker to use.', 'auto',
 151         allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
 152     # packaging method
 153     EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
 154         allowed_values = ('windows', 'posix', 'macosx')),
 155     #
 156     BoolOption('fast_start', 'This option is obsolete.', False),
 157     # No precompiled header support (too troublesome to make it work for msvc)
 158     # BoolOption('pch', 'Whether or not use pch', False),
 159     # enable assertion, (config.h has ENABLE_ASSERTIOS
 160     BoolOption('assertions', 'Use assertions', True),
 161     # config.h define _GLIBCXX_CONCEPT_CHECKS
 162     # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
 163     BoolOption('concept_checks', 'Enable concept checks', True),
 164     #
 165     BoolOption('nls', 'Whether or not use native language support', True),
 166     #
 167     BoolOption('profiling', 'Whether or not enable profiling', False),
 168     # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
 169     BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
 170     # using x11?
 171     BoolOption('X11', 'Use x11 windows system', default_with_x),
 172     # use MS VC++ to build lyx
 173     BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
 174     #
 175     PathOption('qt_dir', 'Path to qt directory', None),
 176     #
 177     PathOption('qt_inc_path', 'Path to qt include directory', None),
 178     #
 179     PathOption('qt_lib_path', 'Path to qt library directory', None),
 180     # extra include and libpath
 181     PathOption('extra_inc_path', 'Extra include path', None),
 182     #
 183     PathOption('extra_lib_path', 'Extra library path', None),
 184     #
 185     PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
 186     #
 187     PathOption('extra_inc_path1', 'Extra include path', None),
 188     #
 189     PathOption('extra_lib_path1', 'Extra library path', None),
 190     # rebuild only specifed, comma separated targets
 191     ('rebuild', '''rebuild only specifed, comma separated targets.
 192         yes or all (default): rebuild everything
 193         no or none: rebuild nothing (usually used for installation)
 194         comp1,comp2,...: rebuild specified targets''', None),
 195     # can be set to a non-existing directory
 196     ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
 197     # replace the default name and location of the windows installer
 198     ('win_installer', 'name or full path to the windows installer', None),
 199     # the deps package used to create minimal installer (qt and other libraries)
 200     ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
 201     # whether or not build bundle installer
 202     BoolOption('bundle', 'Whether or not build bundle installer', False),
 203     # the bundle directory, containing bundled applications
 204     PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
 205     # build directory, will use $mode if not set
 206     ('build_dir', 'Build directory', None),
 207     # version suffix
 208     ('version_suffix', 'install lyx as lyx-suffix', None),
 209     # how to load options
 210     ('load_option', '''load option from previous scons run. option can be
 211         yes (default): load all options
 212         no: do not load any option
 213         opt1,opt2: load specified options
 214         -opt1,opt2: load all options other than specified ones''', 'yes'),
 215     #
 216     ('optimization', 'optimization CCFLAGS option.', None),
 217     #
 218     PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
 219     # log file
 220     ('logfile', 'save commands (not outputs) to logfile', default_log_file),
 221     # provided for backward compatibility
 222     ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
 223     # environment variable can be set as options.
 224     ('DESTDIR', 'install to DESTDIR', None),
 225     ('CC', 'replace default $CC', None),
 226     ('LINK', 'replace default $LINK', None),
 227     ('CPP', 'replace default $CPP', None),
 228     ('CXX', 'replace default $CXX', None),
 229     ('CXXCPP', 'replace default $CXXCPP', None),
 230     ('CCFLAGS', 'replace default $CCFLAGS', None),
 231     ('CPPFLAGS', 'replace default $CPPFLAGS', None),
 232     ('LINKFLAGS', 'replace default $LINKFLAGS', None),
 233 )
 234
 235 # allowed options
 236 all_options = [x.key for x in opts.options]
 237
 238 # copied from SCons/Options/BoolOption.py
 239 # We need to use them before a boolean ARGUMENTS option is available
 240 # in env as bool.
 241 true_strings  = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
 242 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
 243
 244 if ARGUMENTS.has_key('fast_start'):
 245     print 'fast_start option is obsolete'
 246
 247 # if load_option=yes (default), load saved comand line options
 248 #
 249 # This option can take value yes/no/opt1,opt2/-opt1,opt2
 250 # and tries to be clever in choosing options to load
 251 if (not ARGUMENTS.has_key('load_option') or \
 252     ARGUMENTS['load_option'] not in false_strings) \
 253     and os.path.isfile(opt_cache_file):
 254     cache_file = open(opt_cache_file)
 255     opt_cache = cPickle.load(cache_file)
 256     cache_file.close()
 257     # import cached options, but we should ignore qt_dir when frontend changes
 258     if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
 259         and ARGUMENTS['frontend'] != opt_cache['frontend'] \
 260         and opt_cache.has_key('qt_dir'):
 261         opt_cache.pop('qt_dir')
 262     # and we do not cache some options (dest_dir is obsolete)
 263     for arg in ['load_option', 'dest_dir', 'bundle']:
 264         if opt_cache.has_key(arg):
 265             opt_cache.pop(arg)
 266     # remove obsolete cached keys (well, SConstruct is evolving. :-)
 267     for arg in opt_cache.keys():
 268         if arg not in all_options:
 269             print 'Option %s is obsolete, do not load it' % arg
 270             opt_cache.pop(arg)
 271     # now, if load_option=opt1,opt2 or -opt1,opt2
 272     if ARGUMENTS.has_key('load_option') and \
 273         ARGUMENTS['load_option'] not in true_strings + false_strings:
 274         # if -opt1,opt2 is specified, do not load these options
 275         if ARGUMENTS['load_option'][0] == '-':
 276             for arg in ARGUMENTS['load_option'][1:].split(','):
 277                 if opt_cache.has_key(arg):
 278                     opt_cache.pop(arg)
 279         # if opt1,opt2 is specified, only load specified options
 280         else:
 281             args = ARGUMENTS['load_option'].split(',')
 282             for arg in opt_cache.keys():
 283                 if arg not in args:
 284                     opt_cache.pop(arg)
 285     # now restore options as if entered from command line
 286     for key in opt_cache.keys():
 287         if not ARGUMENTS.has_key(key):
 288             ARGUMENTS[key] = opt_cache[key]
 289             print "Restoring cached option  %s=%s" % (key, ARGUMENTS[key])
 290     print
 291
 292 # check if there is unused (or misspelled) argument
 293 for arg in ARGUMENTS.keys():
 294     if arg not in all_options:
 295         import textwrap
 296         print "Unknown option '%s'... exiting." % arg
 297         print
 298         print "Available options are (check 'scons -help' for details):"
 299         print '    ' + '\n    '.join(textwrap.wrap(',  '.join(all_options)))
 300         Exit(1)
 301
 302 # save options used
 303 cache_file = open(opt_cache_file, 'w')
 304 cPickle.dump(ARGUMENTS, cache_file)
 305 cache_file.close()
 306
 307 #---------------------------------------------------------
 308 # Setting up environment
 309 #---------------------------------------------------------
 310
 311 # I do not really like ENV=os.environ, but you may add it
 312 # here if you experience some environment related problem
 313 env = Environment(options = opts)
 314
 315 # set individual variables since I do not really like ENV = os.environ
 316 env['ENV']['PATH'] = os.environ.get('PATH')
 317 env['ENV']['HOME'] = os.environ.get('HOME')
 318 # these are defined for MSVC
 319 env['ENV']['LIB'] = os.environ.get('LIB')
 320 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
 321
 322 # for simplicity, use var instead of env[var]
 323 frontend = env['frontend']
 324 prefix = env['prefix']
 325 mode = env['mode']
 326
 327 if platform_name == 'win32':
 328     if env.has_key('use_vc'):
 329         use_vc = env['use_vc']
 330         if WhereIs('cl.exe') is None:
 331             print "cl.exe is not found. Are you using the MSVC environment?"
 332             Exit(2)
 333     elif WhereIs('cl.exe') is not None:
 334         use_vc = True
 335     else:
 336         use_vc = False
 337 else:
 338     use_vc = False
 339
 340 # lyx will be built to $build/build_dir so it is possible
 341 # to build multiple build_dirs using the same source
 342 # $mode can be debug or release
 343 if env.has_key('build_dir') and env['build_dir'] is not None:
 344     # create the directory if needed
 345     if not os.path.isdir(env['build_dir']):
 346         try:
 347             os.makedirs(env['build_dir'])
 348         except:
 349             pass
 350         if not os.path.isdir(env['build_dir']):
 351             print 'Can not create directory', env['build_dir']
 352             Exit(3)
 353     env['BUILDDIR'] = env['build_dir']
 354 else:
 355     # Determine the name of the build $mode
 356     env['BUILDDIR'] = '#' + mode
 357
 358 # all built libraries will go to build_dir/libs
 359 # (This is different from the make file approach)
 360 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
 361 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
 362
 363
 364 # Here is a summary of variables defined in env
 365 # 1. defined options
 366 # 2. undefined options with a non-None default value
 367 # 3. compiler commands and flags like CCFLAGS.
 368 #     MSGFMT used to process po files
 369 # 4. Variables that will be used to replace variables in some_file.in
 370 #     src/support/Package.cpp.in:
 371 #       TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
 372 #     lib/lyx2lyx/lyx2lyx_version.py.in
 373 #       PACKAGE_VERSION
 374 #     src/version.cpp.in
 375 #       PACKAGE_VERSION, LYX_DATE, VERSION_INFO
 376
 377 # full path name is used to build msvs project files
 378 # and to replace TOP_SRCDIR in package.C
 379 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
 380 # needed by src/version.cpp.in => src/version.cpp
 381 env['PACKAGE_VERSION'] = package_version
 382 env['LYX_DATE'] = time.asctime()
 383
 384 # determine share_dir etc
 385 packaging_method = env.get('packaging')
 386 if packaging_method == 'windows':
 387     share_dir = 'Resources'
 388     man_dir = 'Resources/man/man1'
 389     locale_dir = 'Resources/locale'
 390 else:
 391     share_dir = 'share/lyx'
 392     locale_dir = 'share/locale'
 393     if platform_name == 'cygwin':
 394         man_dir = 'share/man/man1'
 395     else:
 396         man_dir = 'man/man1'
 397
 398 # program suffix: can be yes, or a string
 399 if env.has_key('version_suffix'):
 400     if env['version_suffix'] in true_strings:
 401         program_suffix = package_version
 402     elif env['version_suffix'] in false_strings:
 403         program_suffix = ''
 404     else:
 405         program_suffix = env['version_suffix']
 406 else:
 407     program_suffix = ''
 408 # used by Package.cpp.in
 409 env['PROGRAM_SUFFIX'] = program_suffix
 410
 411 # whether or not add suffix to file and directory names
 412 add_suffix = packaging_method != 'windows'
 413 # LYX_DIR are different (used in Package.cpp.in)
 414 if add_suffix:
 415     env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
 416 else:
 417     env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
 418 # we need absolute path for package.C
 419 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
 420
 421
 422 #---------------------------------------------------------
 423 # Setting building environment (Tools, compiler flags etc)
 424 #---------------------------------------------------------
 425
 426 # Since Tool('mingw') will reset CCFLAGS etc, this should be
 427 # done before getEnvVariable
 428 if platform_name == 'win32':
 429     if use_vc:
 430         env.Tool('msvc')
 431         env.Tool('mslink')
 432     else:
 433         env.Tool('mingw')
 434         env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
 435         # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
 436         # in version 0.96.93
 437         env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
 438
 439
 440 # we differentiate between hard-coded options and default options
 441 # hard-coded options are required and will always be there
 442 # default options can be replaced by enviromental variables or command line options
 443 CCFLAGS_required = []
 444 LINKFLAGS_required = []
 445 CCFLAGS_default = []
 446
 447 # under windows, scons is confused by .C/.c and uses gcc instead of
 448 # g++. I am forcing the use of g++ here. This is expected to change
 449 # after lyx renames all .C files to .cpp
 450 #
 451 # save the old c compiler and CCFLAGS (used by libintl)
 452 C_COMPILER = env.subst('$CC')
 453 C_CCFLAGS = env.subst('$CCFLAGS').split()
 454 # if we use ms vc, the commands are fine (cl.exe and link.exe)
 455 if use_vc:
 456     # /TP treat all source code as C++
 457     # C4819: The file contains a character that cannot be represented
 458     #   in the current code page (number)
 459     # C4996: foo was decleared deprecated
 460     CCFLAGS_required.extend(['/TP', '/EHsc'])
 461     if mode == 'debug':
 462         CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
 463         # the flags are also needed in C mode (for intl lib)
 464         C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
 465     else:
 466         CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
 467         C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
 468 else:
 469     if env.has_key('CXX') and env['CXX']:
 470         env['CC'] = env.subst('$CXX')
 471         env['LINK'] = env.subst('$CXX')
 472     else:
 473         env['CC'] = 'g++'
 474         env['LINK'] = 'g++'
 475
 476 # for debug/release mode
 477 if env.has_key('optimization') and env['optimization'] is not None:
 478     # if user supplies optimization flags, use it anyway
 479     CCFLAGS_required.extend(env['optimization'].split())
 480     # and do not use default
 481     set_default_optimization_flags = False
 482 else:
 483     set_default_optimization_flags = True
 484
 485 if mode == 'debug':
 486     if use_vc:
 487         CCFLAGS_required.append('/Zi')
 488         LINKFLAGS_required.extend(['/debug', '/map'])
 489     else:
 490         CCFLAGS_required.append('-g')
 491         CCFLAGS_default.append('-O')
 492 elif mode == 'release' and set_default_optimization_flags:
 493     if use_vc:
 494         CCFLAGS_default.append('/O2')
 495     else:
 496         CCFLAGS_default.append('-O2')
 497
 498 # msvc uses separate tools for profiling
 499 if env.has_key('profiling') and env['profiling']:
 500     if use_vc:
 501         print 'Visual C++ does not use profiling options'
 502     else:
 503         CCFLAGS_required.append('-pg')
 504         LINKFLAGS_required.append('-pg')
 505
 506 if env.has_key('warnings') and env['warnings']:
 507     if use_vc:
 508         CCFLAGS_default.append('/W2')
 509     else:
 510         # Note: autotools detect gxx version and pass -W for 3.x
 511         # and -Wextra for other versions of gcc
 512         CCFLAGS_default.append('-Wall')
 513
 514 # Now, set the variables as follows:
 515 # 1. if command line option exists: replace default
 516 # 2. then if s envronment variable exists: replace default
 517 # 3. set variable to required + default
 518 def setEnvVariable(env, name, required = None, default = None, split = True):
 519     ''' env: environment to set variable
 520             name: variable
 521             required: hardcoded options
 522             default: default options that can be replaced by command line or
 523                 environment variables
 524             split: whether or not split obtained variable like '-02 -g'
 525     '''
 526     # 1. ARGUMENTS is already set to env[name], override default.
 527     if ARGUMENTS.has_key(name):
 528         # env[name] may be rewritten when building tools are reloaded
 529         # if that is the case, commandline option will override it.
 530         env[name] = ARGUMENTS[name]
 531         default = None
 532     # then use environment default
 533     elif os.environ.has_key(name):
 534         print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
 535         default = os.environ[name]
 536         if split:
 537             default = default.split()
 538     # the real value should be env[name] + default + required
 539     if split:
 540         value = []
 541         if env.has_key(name):
 542             value = str(env[name]).split()
 543         if required is not None:
 544             value += required
 545         if default is not None:
 546             value += default
 547     else:
 548         value = ""
 549         if env.has_key(name):
 550             value = str(env[name])
 551         if required is not None:
 552             value += " " + required
 553         if default is not None:
 554             value += " " + default
 555     env[name] = value
 556     # print name, env[name]
 557
 558 setEnvVariable(env, 'DESTDIR', split=False)
 559 setEnvVariable(env, 'CC')
 560 setEnvVariable(env, 'LINK')
 561 setEnvVariable(env, 'CPP')
 562 setEnvVariable(env, 'CXX')
 563 setEnvVariable(env, 'CXXCPP')
 564 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
 565 setEnvVariable(env, 'CXXFLAGS')
 566 setEnvVariable(env, 'CPPFLAGS')
 567 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
 568
 569 # if DESTDIR is not set...
 570 if env.has_key('dest_dir'):
 571     print "This option is obsolete. Please use DESTDIR instead."
 572     env['DESTDIR'] = env['dest_dir']
 573
 574 #
 575 # extra_inc_path and extra_lib_path
 576 #
 577 extra_inc_paths = []
 578 if env.has_key('extra_inc_path') and env['extra_inc_path']:
 579     extra_inc_paths.append(env['extra_inc_path'])
 580 if env.has_key('extra_lib_path') and env['extra_lib_path']:
 581     env.AppendUnique(LIBPATH = [env['extra_lib_path']])
 582 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
 583     extra_inc_paths.append(env['extra_inc_path1'])
 584 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
 585     env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
 586 if env.has_key('extra_bin_path') and env['extra_bin_path']:
 587     # only the first one is needed (a scons bug?)
 588     os.environ['PATH'] += os.pathsep + env['extra_bin_path']
 589     env.PrependENVPath('PATH', env['extra_bin_path'])
 590 # extra_inc_paths will be used later by intlenv etc
 591 env.AppendUnique(CPPPATH = extra_inc_paths)
 592
 593
 594 #----------------------------------------------------------
 595 # Autoconf business
 596 #----------------------------------------------------------
 597
 598 conf = Configure(env,
 599     custom_tests = {
 600         'CheckPkgConfig' : utils.checkPkgConfig,
 601         'CheckPackage' : utils.checkPackage,
 602         'CheckMkdirOneArg' : utils.checkMkdirOneArg,
 603         'CheckSelectArgType' : utils.checkSelectArgType,
 604         'CheckBoostLibraries' : utils.checkBoostLibraries,
 605         'CheckCommand' : utils.checkCommand,
 606         'CheckNSIS' : utils.checkNSIS,
 607         'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
 608         'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
 609         'CheckIconvConst' : utils.checkIconvConst,
 610         'CheckSizeOfWChar' : utils.checkSizeOfWChar,
 611         'CheckDeclaration' : utils.checkDeclaration,
 612     }
 613 )
 614
 615 # When using msvc, windows.h is required
 616 if use_vc and not conf.CheckCHeader('windows.h'):
 617     print 'Windows.h is not found. Please install Windows Platform SDK.'
 618     print 'Please check config.log for more information.'
 619     Exit(1)
 620
 621 # pkg-config? (if not, we use hard-coded options)
 622 if conf.CheckPkgConfig('0.15.0'):
 623     env['HAS_PKG_CONFIG'] = True
 624 else:
 625     print 'pkg-config >= 0.1.50 is not found'
 626     env['HAS_PKG_CONFIG'] = False
 627
 628 # zlib? This is required.
 629 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
 630     or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
 631     print 'Did not find zdll.lib or zlib.h, exiting!'
 632     print 'Please check config.log for more information.'
 633     Exit(1)
 634 if conf.CheckLib('iconv'):
 635     env['ICONV_LIB'] = 'iconv'
 636 elif conf.CheckLib('libiconv'):
 637     env['ICONV_LIB'] = 'libiconv'
 638 elif conf.CheckFunc('iconv_open'):
 639     env['ICONV_LIB'] = None
 640 else:
 641     print 'Did not find iconv or libiconv, exiting!'
 642     print 'Please check config.log for more information.'
 643     Exit(1)
 644
 645 # check socket libs
 646 socket_libs = []
 647 if conf.CheckLib('socket'):
 648     socket_libs.append('socket')
 649 # nsl is the network services library and provides a
 650 # transport-level interface to networking services.
 651 if conf.CheckLib('nsl'):
 652     socket_libs.append('nsl')
 653
 654 # check available boost libs (since lyx1.4 does not use iostream)
 655 boost_libs = []
 656 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
 657     if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
 658         boost_libs.append(lib)
 659
 660 # check boost libraries
 661 boost_opt = ARGUMENTS.get('boost', 'auto')
 662 # check for system boost
 663 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
 664 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
 665 # default to $BUILDDIR/libs (use None since this path will be added anyway)
 666 boost_libpath = None
 667 # here I assume that all libraries are in the same directory
 668 if boost_opt == 'included':
 669     boost_libraries = ['included_boost_%s' % x for x in boost_libs]
 670     included_boost = True
 671     env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
 672 elif boost_opt == 'auto':
 673     res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
 674     # if not found, use local boost
 675     if res[0] is None:
 676         boost_libraries = ['included_boost_%s' % x for x in boost_libs]
 677         included_boost = True
 678         env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
 679     else:
 680         included_boost = False
 681         (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
 682 elif boost_opt == 'system':
 683     res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
 684     if res[0] is None:
 685         print "Can not find system boost libraries with version %s " % boost_version
 686         print "Please supply a path through extra_lib_path and try again."
 687         print "Or use boost=included to use included boost libraries."
 688         Exit(2)
 689     else:
 690         included_boost = False
 691         (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
 692
 693
 694 if boost_libpath is not None:
 695     env.AppendUnique(LIBPATH = [boost_libpath])
 696
 697
 698 env['ENABLE_NLS'] = env['nls']
 699
 700 if not env['ENABLE_NLS']:
 701     intl_libs = []
 702     included_gettext = False
 703 else:
 704     # check gettext libraries
 705     gettext_opt = ARGUMENTS.get('gettext', 'auto')
 706     # check for system gettext
 707     succ = False
 708     if gettext_opt in ['auto', 'system']:
 709         if conf.CheckFunc('gettext'):
 710             included_gettext = False
 711             intl_libs = []
 712             succ = True
 713         elif conf.CheckLib('intl'):
 714             included_gettext = False
 715             intl_libs = ['intl']
 716             succ = True
 717         else: # no found
 718             if gettext_opt == 'system':
 719                 print "Can not find system gettext library"
 720                 print "Please supply a path through extra_lib_path and try again."
 721                 print "Or use gettext=included to use included gettext libraries."
 722                 Exit(2)
 723     # now, auto and succ = false, or gettext=included
 724     if not succ:
 725         # we do not need to set LIBPATH now.
 726         included_gettext = True
 727         intl_libs = ['included_intl']
 728
 729
 730 #
 731 # check for msgfmt command
 732 env['MSGFMT'] = conf.CheckCommand('msgfmt')
 733 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
 734 env['XGETTEXT'] = conf.CheckCommand('xgettext')
 735 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
 736
 737 # if under windows, check the nsis compiler
 738 if platform_name == 'win32':
 739     env['NSIS'] = conf.CheckNSIS()
 740
 741 # cygwin packaging requires the binaries to be stripped
 742 if platform_name == 'cygwin':
 743     env['STRIP'] = conf.CheckCommand('strip')
 744
 745 #
 746 # Customized builders
 747 #
 748 # install customized builders
 749 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
 750 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
 751 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
 752
 753
 754 #----------------------------------------------------------
 755 # Generating config.h
 756 #----------------------------------------------------------
 757 aspell_lib = 'aspell'
 758 # assume that we use aspell, aspelld compiled for msvc
 759 if platform_name == 'win32' and mode == 'debug' and use_vc:
 760     aspell_lib = 'aspelld'
 761
 762 # check the existence of config.h
 763 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
 764 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
 765 #
 766 print "Creating %s..." % boost_config_h
 767 #
 768 utils.createConfigFile(conf,
 769     config_file = boost_config_h,
 770     config_pre = '''/* boost/config.h.  Generated by SCons.  */
 771
 772 /* -*- C++ -*- */
 773 /*
 774 * \file config.h
 775 * This file is part of LyX, the document processor.
 776 * Licence details can be found in the file COPYING.
 777 *
 778 * This is the compilation configuration file for LyX.
 779 * It was generated by scon.
 780 * You might want to change some of the defaults if something goes wrong
 781 * during the compilation.
 782 */
 783
 784 #ifndef _BOOST_CONFIG_H
 785 #define _BOOST_CONFIG_H
 786 ''',
 787     headers = [
 788         ('ostream', 'HAVE_OSTREAM', 'cxx'),
 789         ('locale', 'HAVE_LOCALE', 'cxx'),
 790         ('sstream', 'HAVE_SSTREAM', 'cxx'),
 791         #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
 792     ],
 793     custom_tests = [
 794         (env.has_key('assertions') and env['assertions'],
 795             'ENABLE_ASSERTIONS',
 796             'Define if you want assertions to be enabled in the code'
 797         ),
 798     ],
 799     types = [
 800         ('wchar_t', 'HAVE_WCHAR_T', None),
 801     ],
 802     config_post = '''
 803
 804 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
 805 #  define USE_BOOST_FORMAT 1
 806 #else
 807 #  define USE_BOOST_FORMAT 0
 808 #endif
 809
 810 #if !defined(ENABLE_ASSERTIONS)
 811 #  define BOOST_DISABLE_ASSERTS 1
 812 #endif
 813 #define BOOST_ENABLE_ASSERT_HANDLER 1
 814
 815 #define BOOST_DISABLE_THREADS 1
 816 #define BOOST_NO_WSTRING 1
 817
 818 #ifdef __CYGWIN__
 819 #  define BOOST_POSIX 1
 820 #  define BOOST_POSIX_API 1
 821 #  define BOOST_POSIX_PATH 1
 822 #endif
 823
 824 #define BOOST_ALL_NO_LIB 1
 825
 826 #if defined(HAVE_NEWAPIS_H)
 827 #  define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
 828 #endif
 829
 830 /*
 831  * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
 832  * support compiled in:
 833  * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
 834  * And we are not interested at all what libc
 835  * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
 836  * has the needed wchar_t support and uses UCS4. Whether it
 837  * implements this with the help of libc, or whether it has own code
 838  * does not matter for us, because we don't use libc directly (Georg)
 839 */
 840 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
 841 #  define USE_WCHAR_T
 842 #endif
 843
 844 #endif
 845 '''
 846 )
 847 #
 848 print "\nGenerating %s..." % config_h
 849
 850 # AIKSAURUS_H_LOCATION
 851 if (conf.CheckCXXHeader("Aiksaurus.h")):
 852     aik_location = '<Aiksaurus.h>'
 853 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
 854     aik_location = '<Aiksaurus/Aiksaurus.h>'
 855 else:
 856     aik_location = ''
 857
 858 # determine headers to use
 859 spell_opt = ARGUMENTS.get('spell', 'auto')
 860 env['USE_ASPELL'] = False
 861 env['USE_PSPELL'] = False
 862 env['USE_ISPELL'] = False
 863 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
 864     spell_engine = 'USE_ASPELL'
 865 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
 866     spell_engine = 'USE_PSPELL'
 867 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
 868     spell_engine = 'USE_ISPELL'
 869 else:
 870     spell_engine = None
 871
 872 if spell_engine is not None:
 873     env[spell_engine] = True
 874 else:
 875     if spell_opt == 'auto':
 876         print "Warning: Can not locate any spell checker"
 877     elif spell_opt != 'no':
 878         print "Warning: Can not locate specified spell checker:", spell_opt
 879         print 'Please check config.log for more information.'
 880         Exit(1)
 881
 882 # check arg types of select function
 883 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
 884
 885 # check the size of wchar_t
 886 sizeof_wchar_t = conf.CheckSizeOfWChar()
 887 # something wrong
 888 if sizeof_wchar_t == 0:
 889     print 'Error: Can not determine the size of wchar_t.'
 890     print 'Please check config.log for more information.'
 891     Exit(1)
 892
 893 #
 894 # create config.h
 895 result = utils.createConfigFile(conf,
 896     config_file = config_h,
 897     config_pre = '''/* config.h.  Generated by SCons.  */
 898
 899 /* -*- C++ -*- */
 900 /*
 901 * \file config.h
 902 * This file is part of LyX, the document processor.
 903 * Licence details can be found in the file COPYING.
 904 *
 905 * This is the compilation configuration file for LyX.
 906 * It was generated by scon.
 907 * You might want to change some of the defaults if something goes wrong
 908 * during the compilation.
 909 */
 910
 911 #ifndef _CONFIG_H
 912 #define _CONFIG_H
 913 ''',
 914     headers = [
 915         ('io.h', 'HAVE_IO_H', 'c'),
 916         ('limits.h', 'HAVE_LIMITS_H', 'c'),
 917         ('locale.h', 'HAVE_LOCALE_H', 'c'),
 918         ('process.h', 'HAVE_PROCESS_H', 'c'),
 919         ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
 920         ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
 921         ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
 922         ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
 923         ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
 924         ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
 925         ('unistd.h', 'HAVE_UNISTD_H', 'c'),
 926         ('utime.h', 'HAVE_UTIME_H', 'c'),
 927         ('direct.h', 'HAVE_DIRECT_H', 'c'),
 928         ('istream', 'HAVE_ISTREAM', 'cxx'),
 929         ('ios', 'HAVE_IOS', 'cxx'),
 930     ],
 931     functions = [
 932         ('open', 'HAVE_OPEN', None),
 933         ('chmod', 'HAVE_CHMOD', None),
 934         ('close', 'HAVE_CLOSE', None),
 935         ('popen', 'HAVE_POPEN', None),
 936         ('pclose', 'HAVE_PCLOSE', None),
 937         ('_open', 'HAVE__OPEN', None),
 938         ('_close', 'HAVE__CLOSE', None),
 939         ('_popen', 'HAVE__POPEN', None),
 940         ('_pclose', 'HAVE__PCLOSE', None),
 941         ('getpid', 'HAVE_GETPID', None),
 942         ('_getpid', 'HAVE__GETPID', None),
 943         ('mkdir', 'HAVE_MKDIR', None),
 944         ('_mkdir', 'HAVE__MKDIR', None),
 945         ('mktemp', 'HAVE_MKTEMP', None),
 946         ('mkstemp', 'HAVE_MKSTEMP', None),
 947         ('strerror', 'HAVE_STRERROR', None),
 948         ('count', 'HAVE_STD_COUNT', '''
 949 #include <algorithm>
 950 int count()
 951 {
 952 char a[] = "hello";
 953 return std::count(a, a+5, 'l');
 954 }
 955 '''),
 956         ('getcwd', 'HAVE_GETCWD', None),
 957         ('setenv', 'HAVE_SETENV', None),
 958         ('putenv', 'HAVE_PUTENV', None),
 959         ('fcntl', 'HAVE_FCNTL', None),
 960         ('mkfifo', 'HAVE_MKFIFO', None),
 961     ],
 962     declarations = [
 963         ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
 964     ],
 965     types = [
 966         ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
 967             '#include <streambuf>\n#include <istream>'),
 968         ('wchar_t', 'HAVE_WCHAR_T', None),
 969         ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
 970     ],
 971     libs = [
 972         ('gdi32', 'HAVE_LIBGDI32'),
 973         (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
 974     ],
 975     custom_tests = [
 976         (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
 977             'HAVE_PID_T',
 978             'Define is sys/types.h does not have pid_t',
 979             '',
 980             '#define pid_t int',
 981         ),
 982         (conf.CheckCXXGlobalCstd(),
 983             'CXX_GLOBAL_CSTD',
 984             'Define if your C++ compiler puts C library functions in the global namespace'
 985         ),
 986         (conf.CheckMkdirOneArg(),
 987             'MKDIR_TAKES_ONE_ARG',
 988             'Define if mkdir takes only one argument.'
 989         ),
 990         (conf.CheckIconvConst(),
 991             'ICONV_CONST',
 992             'Define as const if the declaration of iconv() needs const.',
 993             '#define ICONV_CONST const',
 994             '#define ICONV_CONST',
 995         ),
 996         (conf.CheckLC_MESSAGES(),
 997             'HAVE_LC_MESSAGES',
 998             'Define if your <locale.h> file defines LC_MESSAGES.'
 999         ),
1000         (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
1001         (env['nls'],
1002             'ENABLE_NLS',
1003             "Define to 1 if translation of program messages to the user's native anguage is requested.",
1004         ),
1005         (env['nls'] and not included_gettext,
1006             'HAVE_GETTEXT',
1007             'Define to 1 if using system gettext library'
1008         ),
1009         (env.has_key('concept_checks') and env['concept_checks'],
1010             '_GLIBCXX_CONCEPT_CHECKS',
1011             'libstdc++ concept checking'
1012         ),
1013         (env.has_key('stdlib_debug') and env['stdlib_debug'],
1014             '_GLIBCXX_DEBUG',
1015             'libstdc++ debug mode'
1016         ),
1017         (env.has_key('stdlib_debug') and env['stdlib_debug'],
1018             '_GLIBCXX_DEBUG_PEDANTIC',
1019             'libstdc++ pedantic debug mode'
1020         ),
1021         (os.name != 'nt', 'BOOST_POSIX',
1022             'Indicates to boost < 1.34 which API to use (posix or windows).'
1023         ),
1024         (os.name != 'nt', 'BOOST_POSIX_API',
1025             'Indicates to boost 1.34 which API to use (posix or windows).'
1026         ),
1027         (os.name != 'nt', 'BOOST_POSIX_PATH',
1028             'Indicates to boost 1.34 which path style to use (posix or windows).'
1029         ),
1030         (spell_engine is not None, spell_engine,
1031             'Spell engine to use'
1032         ),
1033         # we need to know the byte order for unicode conversions
1034         (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1035             'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1036         ),
1037     ],
1038     extra_items = [
1039         ('#define PACKAGE "%s%s"' % (package, program_suffix),
1040             'Name of package'),
1041         ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1042             'Define to the address where bug reports for this package should be sent.'),
1043         ('#define PACKAGE_NAME "%s"' % package_name,
1044             'Define to the full name of this package.'),
1045         ('#define PACKAGE_STRING "%s"' % package_string,
1046             'Define to the full name and version of this package.'),
1047         ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1048             'Define to the one symbol short name of this package.'),
1049         ('#define PACKAGE_VERSION "%s"' % package_version,
1050             'Define to the version of this package.'),
1051         ('#define BOOST_ALL_NO_LIB 1',
1052             'disable automatic linking of boost libraries.'),
1053         ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1054             'Packaging method'),
1055         ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1056             'Aiksaurus include file'),
1057         ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1058             "Define to the type of arg 1 for `select'."),
1059         ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1060             "Define to the type of arg 2, 3, 4 for `select'."),
1061         ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1062             "Define to the type of arg 5 for `select'."),
1063         ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1064             'Define to be the size of type wchar_t'),
1065     ],
1066     config_post = '''/************************************************************
1067 ** You should not need to change anything beyond this point */
1068
1069 #ifndef HAVE_STRERROR
1070 #if defined(__cplusplus)
1071 extern "C"
1072 #endif
1073 char * strerror(int n);
1074 #endif
1075
1076 #include <../boost/config.h>
1077
1078 #endif
1079 '''
1080 )
1081
1082 # these keys are needed in env
1083 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1084     'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1085     # USE_ASPELL etc does not go through result
1086     if result.has_key(key):
1087         env[key] = result[key]
1088
1089 #
1090 # if nls=yes and gettext=included, create intl/config.h
1091 # intl/libintl.h etc
1092 #
1093 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1094 if env['nls'] and included_gettext:
1095     #
1096     print "Creating %s..." % intl_config_h
1097     #
1098     # create intl/config.h
1099     result = utils.createConfigFile(conf,
1100         config_file = intl_config_h,
1101         config_pre = '''/* intl/config.h.  Generated by SCons.  */
1102
1103 /* -*- C++ -*- */
1104 /*
1105 * \file config.h
1106 * This file is part of LyX, the document processor.
1107 * Licence details can be found in the file COPYING.
1108 *
1109 * This is the compilation configuration file for LyX.
1110 * It was generated by scon.
1111 * You might want to change some of the defaults if something goes wrong
1112 * during the compilation.
1113 */
1114
1115 #ifndef _CONFIG_H
1116 #define _CONFIG_H
1117 ''',
1118         headers = [
1119             ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1120             ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1121             ('string.h', 'HAVE_STRING_H', 'c'),
1122             ('strings.h', 'HAVE_STRINGS_H', 'c'),
1123             ('argz.h', 'HAVE_ARGZ_H', 'c'),
1124             ('limits.h', 'HAVE_LIMITS_H', 'c'),
1125             ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1126             ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1127             ('stdint.h', 'HAVE_STDINT_H', 'c'),
1128             ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1129         ],
1130         functions = [
1131             ('getcwd', 'HAVE_GETCWD', None),
1132             ('stpcpy', 'HAVE_STPCPY', None),
1133             ('strcasecmp', 'HAVE_STRCASECMP', None),
1134             ('strdup', 'HAVE_STRDUP', None),
1135             ('strtoul', 'HAVE_STRTOUL', None),
1136             ('alloca', 'HAVE_ALLOCA', None),
1137             ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1138             ('mempcpy', 'HAVE_MEMPCPY', None),
1139             ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1140             ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1141             ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1142             ('setlocale', 'HAVE_SETLOCALE', None),
1143             ('tsearch', 'HAVE_TSEARCH', None),
1144             ('getegid', 'HAVE_GETEGID', None),
1145             ('getgid', 'HAVE_GETGID', None),
1146             ('getuid', 'HAVE_GETUID', None),
1147             ('wcslen', 'HAVE_WCSLEN', None),
1148             ('asprintf', 'HAVE_ASPRINTF', None),
1149             ('wprintf', 'HAVE_WPRINTF', None),
1150             ('snprintf', 'HAVE_SNPRINTF', None),
1151             ('printf', 'HAVE_POSIX_PRINTF', None),
1152             ('fcntl', 'HAVE_FCNTL', None),
1153         ],
1154         types = [
1155             ('intmax_t', 'HAVE_INTMAX_T', None),
1156             ('long double', 'HAVE_LONG_DOUBLE', None),
1157             ('long long', 'HAVE_LONG_LONG', None),
1158             ('wchar_t', 'HAVE_WCHAR_T', None),
1159             ('wint_t', 'HAVE_WINT_T', None),
1160             ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1161             ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1162         ],
1163         libs = [
1164             ('c', 'HAVE_LIBC'),
1165         ],
1166         custom_tests = [
1167             (conf.CheckLC_MESSAGES(),
1168                 'HAVE_LC_MESSAGES',
1169                 'Define if your <locale.h> file defines LC_MESSAGES.'
1170             ),
1171             (conf.CheckIconvConst(),
1172                 'ICONV_CONST',
1173                 'Define as const if the declaration of iconv() needs const.',
1174                 '#define ICONV_CONST const',
1175                 '#define ICONV_CONST',
1176             ),
1177             (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1178             conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1179                 'HAVE_INTMAX_T',
1180                 "Define to 1 if you have the `intmax_t' type."
1181             ),
1182             (env.has_key('nls') and env['nls'],
1183                 'ENABLE_NLS',
1184                 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1185             ),
1186         ],
1187         extra_items = [
1188             ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1189             ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1190                 'Define to be the size of type wchar_t'),
1191         ],
1192         config_post = '#endif'
1193     )
1194
1195     # these keys are needed in env
1196     for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1197         'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1198         # USE_ASPELL etc does not go through result
1199         if result.has_key(key):
1200             env[key] = result[key]
1201
1202
1203 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1204 if env['nls'] and included_gettext:
1205     # libgnuintl.h.in => libintl.h
1206     env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1207     env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1208     env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1209         [Copy('$TARGET', '$SOURCE')])
1210
1211 #
1212 # Finish auto-configuration
1213 env = conf.Finish()
1214
1215 #----------------------------------------------------------
1216 # Now set up our build process accordingly
1217 #----------------------------------------------------------
1218
1219 if env['ICONV_LIB'] is None:
1220     system_libs = []
1221 else:
1222     system_libs = [env['ICONV_LIB']]
1223 if platform_name in ['win32', 'cygwin']:
1224     # the final link step needs stdc++ to succeed under mingw
1225     # FIXME: shouldn't g++ automatically link to stdc++?
1226     if use_vc:
1227         system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1228     else:
1229         system_libs += ['shlwapi', 'stdc++', 'z']
1230 elif platform_name == 'cygwin' and env['X11']:
1231     system_libs += ['GL',  'Xmu', 'Xi', 'Xrender', 'Xrandr',
1232         'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1233         'resolv', 'pthread', 'z']
1234 else:
1235     system_libs += ['z']
1236
1237 libs = [
1238     ('HAVE_LIBGDI32', 'gdi32'),
1239     ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1240     ('USE_ASPELL', aspell_lib),
1241     ('USE_ISPELL', 'ispell'),
1242     ('USE_PSPELL', 'pspell'),
1243 ]
1244
1245 for lib in libs:
1246     if env[lib[0]]:
1247         system_libs.append(lib[1])
1248
1249 #
1250 # Build parameters CPPPATH etc
1251 #
1252 if env['X11']:
1253     env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1254
1255 #
1256 # boost: for boost header files
1257 # BUILDDIR/common: for config.h
1258 # TOP_SRCDIR/src: for support/* etc
1259 #
1260 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1261 #
1262 # Separating boost directories from CPPPATH stops scons from building
1263 # the dependency tree for boost header files, and effectively reduce
1264 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1265 # boost headers, this is only done for system boost headers.
1266 if included_boost:
1267     env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1268 else:
1269     if use_vc:
1270         env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1271     else:
1272         env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1273
1274 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1275 if env['nls'] and included_gettext:
1276     env['CPPPATH'].append('$BUILDDIR/intl')
1277 #
1278
1279 #
1280 # A Link script for cygwin see
1281 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1282 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1283 # for details
1284 #
1285 if platform_name == 'cygwin':
1286     ld_script_path = '/tmp'
1287     ld_script = utils.installCygwinLDScript(ld_script_path)
1288     env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1289         '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1290
1291
1292 #---------------------------------------------------------
1293 # Frontend related variables (QTDIR etc)
1294 #---------------------------------------------------------
1295
1296 #
1297 # create a separate environment so that other files do not have
1298 # to be built with all the include directories etc
1299 #
1300 if frontend == 'qt4':
1301     frontend_env = env.Copy()
1302
1303     # handle qt related user specified paths
1304     # set environment so that moc etc can be found even if its path is not set properly
1305     if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1306         frontend_env['QTDIR'] = frontend_env['qt_dir']
1307         if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1308             os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1309             frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1310         if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1311             frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1312
1313     # if separate qt_lib_path is given
1314     if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1315         qt_lib_path = frontend_env.subst('$qt_lib_path')
1316         frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1317         frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1318     else:
1319         qt_lib_path = None
1320
1321     # if separate qt_inc_path is given
1322     if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1323         qt_inc_path = frontend_env['qt_inc_path']
1324     else:
1325         qt_inc_path = None
1326
1327     # local qt4 toolset from
1328     # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1329     #
1330     # NOTE: I have to patch qt4.py since it does not automatically
1331     # process .C file!!! (add to cxx_suffixes )
1332     #
1333     frontend_env.Tool('qt4', [scons_dir])
1334     frontend_env['QT_AUTOSCAN'] = 0
1335     frontend_env['QT4_AUTOSCAN'] = 0
1336     frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1337
1338     if qt_lib_path is None:
1339         qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1340     if qt_inc_path is None:
1341         qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1342
1343
1344     conf = Configure(frontend_env,
1345         custom_tests = {
1346             'CheckPackage' : utils.checkPackage,
1347             'CheckCommand' : utils.checkCommand,
1348         }
1349     )
1350
1351     succ = False
1352     # first: try pkg_config
1353     if frontend_env['HAS_PKG_CONFIG']:
1354         succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1355         # FIXME: use pkg_config information?
1356         #frontend_env['QT4_PKG_CONFIG'] = succ
1357     # second: try to link to it
1358     if not succ:
1359         # Under linux, I can test the following perfectly
1360         # Under windows, lib names need to passed as libXXX4.a ...
1361         if platform_name == 'win32':
1362             succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1363         else:
1364             succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1365     # still can not find it
1366     if not succ:
1367         print 'Did not find qt libraries, exiting!'
1368         print 'Please check config.log for more information.'
1369         Exit(1)
1370     #
1371     # Now, determine the correct suffix:
1372     qt_libs = ['QtCore', 'QtGui']
1373     if platform_name == 'win32':
1374         if mode == 'debug' and use_vc and \
1375             conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1376             qt_lib_suffix = 'd4'
1377             use_qt_debug_libs = True
1378         else:
1379             qt_lib_suffix = '4'
1380             use_qt_debug_libs = False
1381     else:
1382         if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1383             qt_lib_suffix = '_debug'
1384             use_qt_debug_libs = True
1385         else:
1386             qt_lib_suffix = ''
1387             use_qt_debug_libs = False
1388     frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1389     frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1390     qtcore_lib = ['QtCore' + qt_lib_suffix]
1391
1392     # check uic and moc commands for qt frontends
1393     if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1394         print 'uic or moc command is not found for frontend', frontend
1395         Exit(1)
1396
1397     # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1398     # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1399     # For some unknown changes in msvc or qt, this is no longer needed.
1400     if use_vc:
1401         frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1402             'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1403             env.File('$BUILDDIR/lyx.exe.manifest').path]
1404
1405     frontend_env = conf.Finish()
1406
1407 #
1408 # Report results
1409 #
1410 # fill in the version info
1411 env['VERSION_INFO'] = '''Configuration
1412   Host type:                      %s
1413   Special build flags:            %s
1414   C   Compiler:                   %s
1415   C   Compiler flags:             %s %s
1416   C++ Compiler:                   %s
1417   C++ Compiler LyX flags:         %s
1418   C++ Compiler flags:             %s %s
1419   Linker flags:                   %s
1420   Linker user flags:              %s
1421 Build info:
1422   Builing directory:              %s
1423   Local library directory:        %s
1424   Libraries paths:                %s
1425   Boost libraries:                %s
1426   Frontend libraries:             %s
1427   System libraries:               %s
1428   include search path:            %s
1429 Frontend:
1430   Frontend:                       %s
1431   Packaging:                      %s
1432   LyX dir:                        %s
1433   LyX files dir:                  %s
1434 ''' % (platform_name,
1435     env.subst('$CCFLAGS'), env.subst('$CC'),
1436     env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1437     env.subst('$CXX'), env.subst('$CXXFLAGS'),
1438     env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1439     env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1440     env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1441     str(env['LIBPATH']), str(boost_libraries),
1442     str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1443     frontend, packaging_method,
1444     prefix, env['LYX_DIR'])
1445
1446 if frontend in ['qt4']:
1447     env['VERSION_INFO'] += '''  include dir:                    %s
1448   library dir:                    %s
1449   X11:                            %s
1450 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1451
1452 print env['VERSION_INFO']
1453
1454 #
1455 # Mingw command line may be too short for our link usage,
1456 # Here we use a trick from scons wiki
1457 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1458 #
1459 # I also would like to add logging (commands only) capacity to the
1460 # spawn system.
1461 logfile = env.get('logfile', default_log_file)
1462 if logfile != '' or platform_name == 'win32':
1463     import time
1464     utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1465         info = '''# This is a log of commands used by scons to build lyx
1466 # Time: %s
1467 # Command: %s
1468 # Info: %s
1469 ''' % (time.asctime(), ' '.join(sys.argv),
1470     env['VERSION_INFO'].replace('\n','\n# ')) )
1471
1472
1473 # Cleanup stuff
1474 #
1475 # -h will print out help info
1476 Help(opts.GenerateHelpText(env))
1477
1478
1479
1480 #----------------------------------------------------------
1481 # Start building
1482 #----------------------------------------------------------
1483 # this has been the source of problems on some platforms...
1484 # I find that I need to supply it with full path name
1485 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1486 # this usage needs further investigation.
1487 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1488
1489 print "Building all targets recursively"
1490
1491 if env.has_key('rebuild'):
1492     rebuild_targets = env['rebuild'].split(',')
1493     if 'none' in rebuild_targets or 'no' in rebuild_targets:
1494         rebuild_targets = []
1495     elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1496         # None: let scons decide which components to build
1497         # Forcing all components to be rebuilt is in theory not necessary
1498         rebuild_targets = None
1499 else:
1500     rebuild_targets = None
1501
1502 def libExists(libname):
1503     ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1504     return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1505
1506 def appExists(apppath, appname):
1507     ''' Check whether or not application already exists'''
1508     return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1509
1510 targets = BUILD_TARGETS
1511 build_install = 'install' in targets or 'installer' in targets
1512 build_installer = 'installer' in targets
1513 # msvc need to pass full target name, so I have to look for path/lyx etc
1514 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1515     or build_install or 'all' in targets
1516 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1517 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1518 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1519 build_mathed = build_lyx or 'mathed' in targets
1520 build_insets = build_lyx or 'insets' in targets
1521 build_frontends = build_lyx or 'frontends' in targets
1522 build_graphics = build_lyx or 'graphics' in targets
1523 build_controllers = build_lyx or 'controllers' in targets
1524 build_client = True in ['client' in x for x in targets] \
1525     or build_install or 'all' in targets or build_installer
1526 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1527     or build_install or 'all' in targets or build_installer
1528 build_lyxbase = build_lyx or 'lyxbase' in targets
1529 update_po = 'update_po' in targets
1530 update_manifest = 'update_manifest' in targets
1531 build_po = 'po' in targets or build_install or 'all' in targets
1532 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1533 build_msvs_projects = use_vc and 'msvs_projects' in targets
1534
1535
1536 # now, if rebuild_targets is specified, do not rebuild some targets
1537 if rebuild_targets is not None:
1538     #
1539     def ifBuildLib(name, libname, old_value):
1540         # explicitly asked to rebuild
1541         if name in rebuild_targets:
1542             return True
1543         # else if not rebuild, and if the library already exists
1544         elif libExists(libname):
1545             return False
1546         # do not change the original value
1547         else:
1548             return old_value
1549     build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1550     build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1551     build_support = ifBuildLib('support', 'support', build_support)
1552     build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1553     build_insets = ifBuildLib('insets', 'insets', build_insets)
1554     build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1555     build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1556     build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1557     build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1558     build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1559     #
1560     def ifBuildApp(name, appname, old_value):
1561         # explicitly asked to rebuild
1562         if name in rebuild_targets:
1563             return True
1564         # else if not rebuild, and if the library already exists
1565         elif appExists(name, appname):
1566             return False
1567         # do not change the original value
1568         else:
1569             return old_value
1570     build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1571     build_client = ifBuildApp('client', 'lyxclient', build_client)
1572
1573 # sync frontend and frontend (?)
1574 if build_qt4:
1575     frontend = 'qt4'
1576
1577
1578 if build_boost:
1579     #
1580     # boost libraries
1581     #
1582     # special builddir
1583     env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1584
1585     boostenv = env.Copy()
1586     #
1587     # boost use its own config.h
1588     boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1589     boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1590
1591     for lib in boost_libs:
1592         print 'Processing files in boost/libs/%s/src...' % lib
1593         boostlib = boostenv.StaticLibrary(
1594             target = '$LOCALLIBPATH/included_boost_%s' % lib,
1595             source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1596         )
1597         Alias('boost', boostlib)
1598
1599
1600 if build_intl:
1601     #
1602     # intl
1603     #
1604     intlenv = env.Copy()
1605
1606     print "Processing files in intl..."
1607
1608     env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1609
1610     # we need the original C compiler for these files
1611     intlenv['CC'] = C_COMPILER
1612     intlenv['CCFLAGS'] = C_CCFLAGS
1613     if use_vc:
1614         intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1615     # intl does not use global config.h
1616     intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1617
1618     intlenv.Append(CCFLAGS = [
1619         r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1620         r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1621         r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1622         '-DIN_LIBINTL',
1623         '-DENABLE_RELOCATABLE=1',
1624         '-DIN_LIBRARY',
1625         r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1626         '-DNO_XMALLOC',
1627         '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1628         '-Drelocate=libintl_relocate',
1629         '-DDEPENDS_ON_LIBICONV=1',
1630         '-DHAVE_CONFIG_H'
1631         ]
1632     )
1633
1634     intl = intlenv.StaticLibrary(
1635         target = '$LOCALLIBPATH/included_intl',
1636         LIBS = ['c'],
1637         source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1638     )
1639     Alias('intl', intl)
1640
1641
1642 #
1643 # Now, src code under src/
1644 #
1645 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1646
1647
1648 if build_support:
1649     #
1650     # src/support
1651     #
1652     print "Processing files in src/support..."
1653
1654     frontend_env.Depends('$BUILDDIR/common/support/Package.cpp', '$BUILDDIR/common/config.h')
1655     Package_cpp = env.substFile('$BUILDDIR/common/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1656
1657     support = frontend_env.StaticLibrary(
1658         target = '$LOCALLIBPATH/support',
1659         source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files] + Package_cpp,
1660         CCFLAGS =  [
1661             '$CCFLAGS',
1662             '-DHAVE_CONFIG_H',
1663             '-DQT_CLEAN_NAMESPACE',
1664             '-DQT_GENUINE_STR',
1665             '-DQT_NO_STL',
1666             '-DQT_NO_KEYWORDS',
1667         ]
1668
1669     )
1670     Alias('support', support)
1671
1672
1673 if build_mathed:
1674     #
1675     # src/mathed
1676     #
1677     print "Processing files in src/mathed..."
1678     #
1679     mathed = env.StaticLibrary(
1680         target = '$LOCALLIBPATH/mathed',
1681         source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1682     )
1683     Alias('mathed', mathed)
1684
1685
1686 if build_insets:
1687     #
1688     # src/insets
1689     #
1690     print "Processing files in src/insets..."
1691     #
1692     insets = env.StaticLibrary(
1693         target = '$LOCALLIBPATH/insets',
1694         source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1695     )
1696     Alias('insets', insets)
1697
1698
1699 if build_frontends:
1700     #
1701     # src/frontends
1702     #
1703     print "Processing files in src/frontends..."
1704
1705     frontends = env.StaticLibrary(
1706         target = '$LOCALLIBPATH/frontends',
1707         source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1708     )
1709     Alias('frontends', frontends)
1710
1711
1712 if build_graphics:
1713     #
1714     # src/graphics
1715     #
1716     print "Processing files in src/graphics..."
1717
1718     graphics = env.StaticLibrary(
1719         target = '$LOCALLIBPATH/graphics',
1720         source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1721     )
1722     Alias('graphics', graphics)
1723
1724
1725 if build_controllers:
1726     #
1727     # src/frontends/controllers
1728     #
1729     print "Processing files in src/frontends/controllers..."
1730
1731     controllers = env.StaticLibrary(
1732         target = '$LOCALLIBPATH/controllers',
1733         source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1734     )
1735     Alias('controllers', controllers)
1736
1737
1738 #
1739 # src/frontend/qt4
1740 #
1741 if build_qt4:
1742     env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1743
1744     print "Processing files in src/frontends/qt4..."
1745
1746     #
1747     # moc qt4_moc_files, the moced files are included in the original files
1748     #
1749     qt4 = frontend_env.StaticLibrary(
1750         target = '$LOCALLIBPATH/qt4',
1751         source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1752         CPPPATH = [
1753             '$CPPPATH',
1754             '$BUILDDIR/common',
1755             '$BUILDDIR/common/images',
1756             '$BUILDDIR/common/frontends',
1757             '$BUILDDIR/common/frontends/qt4',
1758             '$BUILDDIR/common/frontends/qt4/ui',
1759             '$BUILDDIR/common/frontends/controllers'
1760         ],
1761         CCFLAGS =  [
1762             '$CCFLAGS',
1763             '-DHAVE_CONFIG_H',
1764             '-DQT_CLEAN_NAMESPACE',
1765             '-DQT_GENUINE_STR',
1766             '-DQT_NO_STL',
1767             '-DQT_NO_KEYWORDS',
1768         ]
1769     )
1770     Alias('qt4', qt4)
1771
1772
1773 if build_client:
1774     #
1775     # src/client
1776     #
1777     frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1778
1779     print "Processing files in src/client..."
1780
1781     if env['HAVE_FCNTL']:
1782         client = frontend_env.Program(
1783             target = '$BUILDDIR/common/client/lyxclient',
1784             LIBS = ['support'] + intl_libs + system_libs +
1785                 socket_libs + boost_libraries + qtcore_lib,
1786             source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1787                 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1788         )
1789         Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1790             client, [Copy('$TARGET', '$SOURCE')]))
1791     else:
1792         client = None
1793     Alias('client', client)
1794 else:
1795     if env['HAVE_FCNTL']:
1796         # define client even if lyxclient is not built with rebuild=no
1797         client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1798     else:
1799         client = None
1800
1801
1802 if build_tex2lyx:
1803     #
1804     # tex2lyx
1805     #
1806     print "Processing files in src/tex2lyx..."
1807
1808     #
1809     for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1810         frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1811             [Copy('$TARGET', '$SOURCE')])
1812
1813     tex2lyx = frontend_env.Program(
1814         target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1815         LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1816         source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1817             utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1818         CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1819         LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1820     )
1821     Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1822         tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1823     Alias('tex2lyx', tex2lyx)
1824 else:
1825     # define tex2lyx even if tex2lyx is not built with rebuild=no
1826     tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1827
1828
1829 if build_lyxbase:
1830     #
1831     # src/
1832     #
1833     print "Processing files in src..."
1834
1835     env.Depends('$BUILDDIR/common/version.cpp', '$BUILDDIR/common/config.h')
1836     version_cpp = env.substFile('$BUILDDIR/common/version.cpp', '$TOP_SRCDIR/src/version.cpp.in')
1837
1838     if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1839         src_post_files.append('ASpell.cpp')
1840     elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1841         src_post_files.append('PSpell.cpp')
1842     elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1843         src_post_files.append('ISpell.cpp')
1844
1845     # msvc requires at least one source file with main()
1846     # so I exclude main.cpp from lyxbase
1847     lyxbase_pre = env.StaticLibrary(
1848         target = '$LOCALLIBPATH/lyxbase_pre',
1849         source = ['$BUILDDIR/common/%s' % x for x in src_pre_files] + version_cpp
1850     )
1851     lyxbase_post = env.StaticLibrary(
1852         target = '$LOCALLIBPATH/lyxbase_post',
1853         source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1854     )
1855     Alias('lyxbase', lyxbase_pre)
1856     Alias('lyxbase', lyxbase_post)
1857
1858
1859 if build_lyx:
1860     #
1861     # Build lyx with given frontend
1862     #
1863     lyx = frontend_env.Program(
1864         target = '$BUILDDIR/lyx',
1865         source = ['$BUILDDIR/common/main.cpp'] + \
1866             utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1867         LIBS = [
1868             'lyxbase_pre',
1869             'mathed',
1870             'insets',
1871             'frontends',
1872             frontend,
1873             'controllers',
1874             'graphics',
1875             'support',
1876             'lyxbase_post',
1877             ] +
1878             boost_libraries +
1879             frontend_libs +
1880             intl_libs +
1881             socket_libs +
1882             system_libs
1883     )
1884     Alias('lyx', lyx)
1885 else:
1886     # define lyx even if lyx is not built with rebuild=no
1887     lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1888
1889
1890 if build_msvs_projects:
1891     def build_project(target, full_target = None,
1892         src = [], inc = [], res = [], rebuildTargetOnly = True):
1893         ''' build mavs project files
1894             target:      alias (correspond to directory name)
1895             full_target: full path/filename of the target
1896             src:         source files
1897             inc:         include files
1898             res:         resource files
1899             rebuildTargetOnly:     whether or not only rebuild this target
1900
1901         For non-debug-able targets like static libraries, target (alias) is
1902         enough to build the target. For executable targets, msvs need to know
1903         the full path to start debug them.
1904         '''
1905         if rebuildTargetOnly:
1906             cmds = 'rebuild='+target
1907         else:
1908             cmds = ''
1909         if full_target is None:
1910             build_target = target
1911         else:
1912             build_target = full_target
1913         # project
1914         proj = env.MSVSProject(
1915             target = target + env['MSVSPROJECTSUFFIX'],
1916             # this allows easy access to header files (along with source)
1917             srcs = [env.subst(x) for x in src + inc],
1918             incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1919             localincs = [env.subst(x) for x in inc],
1920             resources = [env.subst(x) for x in res],
1921             buildtarget = build_target,
1922             cmdargs = cmds,
1923             variant = 'Debug'
1924         )
1925         Alias('msvs_projects', proj)
1926     #
1927     build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1928         inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1929         rebuildTargetOnly = False,
1930         full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1931     #
1932     build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1933         inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1934         rebuildTargetOnly = False,
1935         full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1936     #
1937     build_project('lyx',
1938         src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1939             ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1940             ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1941             ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1942             ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1943             ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1944             ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1945             ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1946         inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1947             ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1948             ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1949             ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1950             ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1951             ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1952             ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1953             ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1954         res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1955         rebuildTargetOnly = False,
1956         full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1957
1958
1959 if update_manifest:
1960     #
1961     # update scons_manifest.py
1962     #
1963     # When you run 'scons update_manifest', it tells you which files are missing
1964     # and which files are not in the source tree. It also generates a
1965     # scons_manifest.py.new file with all the missing files added to
1966     # XXX_extra_files. It will *not* change other sections of existing
1967     # manifest.py
1968     #
1969     print 'Validating development/scons/scons_manifest.py...'
1970     #
1971     manifest = open(env.File('$TOP_SRCDIR/development/scons/scons_manifest.py.new').abspath, 'w')
1972     print >> manifest, 'from SCons.Util import Split\n'
1973     #
1974     ignore_dirs = ['boost/boost', 'm4', 'development',
1975         utils.relativePath(env.Dir('$BUILDDIR').abspath, env.Dir('$TOP_SRCDIR').abspath)]
1976     ignore_types = ['.svn', '.deps', '.cache', '.tmp', '.bak', '.gmo', '.pot',
1977         '.pyc', '.pyo', '.o', '_moc.cpp', 'Makefile.in', 'config.h.in',
1978         'LaTeXConfig.lyx', 'version.cpp', 'Package.cpp']
1979     ext_types = ['_header_files', '_files', '_pre_files', '_post_files', '_moc_files', '_inc_files',
1980         '_copied_files', '_copied_header_files', '_extra_header_files', '_extra_src_files', '_extra_files']
1981     for root,path,files in os.walk(env.Dir('$TOP_SRCDIR').abspath):
1982         if os.path.split(root)[-1][0] == '.' \
1983             or True in [x in root for x in ignore_types] \
1984             or True in [utils.isSubDir(root, x) for x in ignore_dirs]:
1985             continue
1986         dirname = utils.relativePath(root, env.subst('$TOP_SRCDIR')).replace(os.sep, '_')
1987         if dirname == '':
1988             dirname = 'TOP'
1989         # files in the current manifest.py
1990         cur_files = []
1991         for ext in ext_types:
1992             if 'copied' not in ext and dirname + ext in locals():
1993                 cur_files.extend(eval(dirname + ext))
1994         cur_files.sort()
1995         # compare files with cur_files
1996         files = [x for x in files if x[0] != '.' and True not in [len(x) >= len(y) and x[-len(y):] == y for y in ignore_types]]
1997         files.sort()
1998         if cur_files != files:
1999             missing = []
2000             for f in files:
2001                 if f not in cur_files:
2002                     missing.append(f)
2003             extra = []
2004             for f in cur_files:
2005                 if f not in files:
2006                     extra.append(f)
2007             if len(missing) > 0:
2008                 print 'Missing: %s in %s' % (', '.join(missing), root)
2009                 if dirname + '_extra_files' in locals():
2010                     exec('%s_extra_files.extend(missing)' % dirname)
2011                 else:
2012                     exec('%s_extra_files = missing' % dirname)
2013             if len(extra) > 0:
2014                 print 'Extra: %s in %s' % (', '.join(extra), root)
2015         # write to a new manifest file
2016         for ext in ext_types:
2017             if dirname + ext in locals():
2018                 exec('%s%s.sort()' % (dirname, ext))
2019                 print >> manifest, "%s%s = Split('''\n   " % (dirname, ext),
2020                 print >> manifest, eval(r"'\n    '.join(%s%s)" % (dirname, ext))
2021                 print >> manifest, "''')\n\n"
2022     manifest.close()
2023     Alias('update_manifest', None)
2024
2025
2026 if update_po:
2027     #
2028     # update po files
2029     #
2030     print 'Updating po/*.po files...'
2031
2032     # whether or not update po files
2033     if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
2034         print 'xgettext or msgmerge does not exist. Cannot merge po files'
2035         Exit(1)
2036     # rebuild POTFILES.in
2037     POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
2038         ['$TOP_SRCDIR/src/%s' % x for x in  src_header_files + src_pre_files + src_post_files + \
2039             src_extra_src_files] + \
2040         ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
2041             src_support_extra_header_files + src_support_extra_src_files] + \
2042         ['$TOP_SRCDIR/src/mathed/%s' % x for x in  src_mathed_header_files + src_mathed_files] + \
2043         ['$TOP_SRCDIR/src/insets/%s' % x for x in  src_insets_header_files + src_insets_files] + \
2044         ['$TOP_SRCDIR/src/frontends/%s' % x for x in  src_frontends_header_files + src_frontends_files] + \
2045         ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
2046         ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
2047         ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
2048         ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ]  + \
2049         ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
2050     )
2051     Alias('update_po', POTFILES_in)
2052     # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
2053     # and combine them to lyx.po
2054     env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
2055     lyx_po = env.Command('$BUILDDIR/po/lyx.po',
2056         env.Command('$BUILDDIR/po/all.po',
2057             [env.Command('$BUILDDIR/po/qt4_l10n.pot',
2058                 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
2059                 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
2060              env.Command('$BUILDDIR/po/layouts_l10n.pot',
2061                 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
2062                 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2063              env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
2064                 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2065              env.Command('$BUILDDIR/po/ui_l10n.pot',
2066                 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2067                 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2068              env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
2069                 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
2070              ], utils.env_cat),
2071             ['$MSGUNIQ -o $TARGET $SOURCE',
2072              '''$XGETTEXT --default-domain=${TARGET.base} \
2073                 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2074                 --language=C++ --join-existing \
2075                 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
2076                 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2077                 --copyright-holder="LyX Developers" \
2078                 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2079         )
2080     env.Depends(lyx_po, POTFILES_in)
2081     # copy lyx.po to lyx.pot
2082     lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2083         Copy('$TARGET', '$SOURCE'))
2084     #
2085     import glob
2086     # files to translate
2087     transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2088     # possibly *only* handle these languages
2089     languages = None
2090     if env.has_key('languages'):
2091         languages = env.make_list(env['languages'])
2092     # merge. if I use lan.po as $TARGET, it will be removed
2093     # before it is merged. In this builder,
2094     # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2095     # and is copied to po/lang.po
2096     env['BUILDERS']['msgmerge'] = Builder(action=[
2097         '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2098         Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2099         )
2100     # for each po file, generate pot
2101     for po_file in transfiles:
2102         # get filename
2103         fname = os.path.split(po_file)[1]
2104         # country code
2105         country = fname.split('.')[0]
2106         #
2107         if not languages or country in languages:
2108             # merge po files, the generated lan.po_new file is copied to lan.po file.
2109             po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2110             env.Depends(po, POTFILES_in)
2111             Alias('update_po', po)
2112
2113
2114 if build_po:
2115     #
2116     # po/
2117     #
2118     print 'Processing files in po...'
2119
2120     import glob
2121     # handle po files
2122     #
2123     # files to translate
2124     transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2125     # possibly *only* handle these languages
2126     languages = None
2127     if env.has_key('languages'):
2128         languages = env.make_list(env['lanauges'])
2129     # use defulat msgfmt
2130     gmo_files = []
2131     if not env['MSGFMT']:
2132         print 'msgfmt does not exist. Can not process po files'
2133     else:
2134         # create a builder
2135         env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2136         #
2137         for f in transfiles:
2138             # get filename
2139             fname = os.path.split(f)[1]
2140             # country code
2141             country = fname.split('.')[0]
2142             #
2143             if not languages or country in languages:
2144                 gmo_files.extend(env.Transfiles(f))
2145
2146
2147 if build_install:
2148     #
2149     # this part is a bit messy right now. Since scons will provide
2150     # --DESTDIR option soon, at least the dest_dir handling can be
2151     # removed later.
2152     #
2153     # how to join dest_dir and prefix
2154     def joinPaths(path1, path2):
2155         ''' join path1 and path2, do not use os.path.join because
2156             under window, c:\destdir\d:\program is invalid '''
2157         if path1 == '':
2158             return os.path.normpath(path2)
2159         # separate drive letter
2160         (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2161         # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2162         return os.path.join(os.path.normpath(path1), path[1:])
2163     #
2164     # install to dest_dir/prefix
2165     dest_dir = env.get('DESTDIR', '')
2166     dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2167     # create the directory if needed
2168     if not os.path.isdir(dest_prefix_dir):
2169         try:
2170             os.makedirs(dest_prefix_dir)
2171         except:
2172             pass
2173         if not os.path.isdir(dest_prefix_dir):
2174             print 'Can not create directory', dest_prefix_dir
2175             Exit(3)
2176     #
2177     if env.has_key('exec_prefix'):
2178         bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2179     else:
2180         bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2181     if add_suffix:
2182         share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2183     else:
2184         share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2185     man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2186     locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2187     env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2188     #
2189     import glob
2190     #
2191     # install executables (lyxclient may be None)
2192     #
2193     if add_suffix:
2194         version_suffix = program_suffix
2195     else:
2196         version_suffix = ''
2197     #
2198     # install lyx, if in release mode, try to strip the binary
2199     if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2200         # create a builder to strip and install
2201         env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2202
2203     # install executables
2204     for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2205         if obj is None:
2206             continue
2207         target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2208         target = os.path.join(bin_dest_dir, target_name)
2209         if env['BUILDERS'].has_key('StripInstallAs'):
2210             env.StripInstallAs(target, obj)
2211         else:
2212             env.InstallAs(target, obj)
2213         Alias('install', target)
2214
2215     # share/lyx
2216     dirs = []
2217     for (dir,files) in [
2218             ('.', lib_files),
2219             ('bind', lib_bind_files),
2220             ('bind/de', lib_bind_de_files),
2221             ('bind/fi', lib_bind_fi_files),
2222             ('bind/pt', lib_bind_pt_files),
2223             ('bind/sv', lib_bind_sv_files),
2224             ('doc', lib_doc_files),
2225             ('doc/biblio', lib_doc_biblio_files),
2226             ('doc/clipart', lib_doc_clipart_files),
2227             ('doc/cs', lib_doc_cs_files),
2228             ('doc/da', lib_doc_da_files),
2229             ('doc/de', lib_doc_de_files),
2230             ('doc/de/clipart', lib_doc_de_clipart_files),
2231             ('doc/es', lib_doc_es_files),
2232             ('doc/es/clipart', lib_doc_es_clipart_files),
2233             ('doc/eu', lib_doc_eu_files),
2234             ('doc/fr', lib_doc_fr_files),
2235             ('doc/he', lib_doc_he_files),
2236             ('doc/hu', lib_doc_hu_files),
2237             ('doc/it', lib_doc_it_files),
2238             ('doc/nl', lib_doc_nl_files),
2239             ('doc/nb', lib_doc_nb_files),
2240             ('doc/pl', lib_doc_pl_files),
2241             ('doc/pt', lib_doc_pt_files),
2242             ('doc/ro', lib_doc_ro_files),
2243             ('doc/ru', lib_doc_ru_files),
2244             ('doc/sk', lib_doc_sk_files),
2245             ('doc/sl', lib_doc_sl_files),
2246             ('doc/sv', lib_doc_sv_files),
2247             ('examples', lib_examples_files),
2248             ('examples/ca', lib_examples_ca_files),
2249             ('examples/cs', lib_examples_cs_files),
2250             ('examples/da', lib_examples_da_files),
2251             ('examples/de', lib_examples_de_files),
2252             ('examples/es', lib_examples_es_files),
2253             ('examples/eu', lib_examples_eu_files),
2254             ('examples/fa', lib_examples_fa_files),
2255             ('examples/fr', lib_examples_fr_files),
2256             ('examples/he', lib_examples_he_files),
2257             ('examples/hu', lib_examples_hu_files),
2258             ('examples/it', lib_examples_it_files),
2259             ('examples/nl', lib_examples_nl_files),
2260             ('examples/pl', lib_examples_pl_files),
2261             ('examples/pt', lib_examples_pt_files),
2262             ('examples/ru', lib_examples_ru_files),
2263             ('examples/sl', lib_examples_sl_files),
2264             ('examples/ro', lib_examples_ro_files),
2265             ('fonts', lib_fonts_files),
2266             ('images', lib_images_files),
2267             ('images/math', lib_images_math_files),
2268             ('kbd', lib_kbd_files),
2269             ('layouts', lib_layouts_files + lib_layouts_inc_files),
2270             ('lyx2lyx', lib_lyx2lyx_files),
2271             ('scripts', lib_scripts_files),
2272             ('templates', lib_templates_files),
2273             ('tex', lib_tex_files),
2274             ('ui', lib_ui_files)]:
2275         dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2276             [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2277     Alias('install', dirs)
2278
2279     # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2280     env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2281     env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2282         '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2283     Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2284     sys.path.append(share_dest_dir + '/lyx2lyx')
2285
2286     # generate TOC files for each doc
2287     languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2288     tocs = []
2289     for lang in languages.keys():
2290         if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2291             toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2292                 languages[lang])
2293             tocs.append(toc)
2294             # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2295             env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2296         else:
2297             # this is for English
2298             toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2299                 languages[lang])
2300             tocs.append(toc)
2301             env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2302     Alias('install', tocs)
2303
2304     if platform_name == 'cygwin':
2305         # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2306         Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2307             '%s-%s.README' % (package, package_cygwin_version))
2308         env.InstallAs(Cygwin_README,
2309             os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2310         Alias('install', Cygwin_README)
2311         # also a directory /usr/share/doc/lyx for README etc
2312         Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2313         env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2314             ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2315         Alias('install', Cygwin_Doc)
2316         # cygwin fonts also need to be installed
2317         Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2318         env.Install(Cygwin_fonts,
2319             [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2320                   for file in win32_bakoma_fonts])
2321         Alias('install', Cygwin_fonts)
2322         # we also need a post installation script
2323         tmp_script = utils.installCygwinPostinstallScript('/tmp')
2324         postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2325         env.Install(postinstall_path, tmp_script)
2326         Alias('install', postinstall_path)
2327
2328
2329     # man
2330     env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2331         env.subst('$TOP_SRCDIR/lyx.man'))
2332     env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2333         env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2334     env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2335         env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2336     Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2337         x in ['lyx', 'tex2lyx', 'lyxclient']])
2338     # locale files?
2339     # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2340     for gmo in gmo_files:
2341         lan = os.path.split(str(gmo))[1].split('.')[0]
2342         dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2343         env.InstallAs(dest_file, gmo)
2344         Alias('install', dest_file)
2345
2346
2347 if build_installer:
2348     #
2349     # build windows installer using NSIS
2350     #
2351     # NOTE:
2352     # There is a nsis builder on scons wiki but it does not work with
2353     # our lyx.nsi because it does not dig through all the include directives
2354     # and find the dependencies automatically. Also, it can not parse
2355     # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2356     # something rely on date.
2357     # Because of this, I am doing a simple nsis builder here.
2358     if platform_name != 'win32':
2359         print 'installer target is only available for windows platform'
2360         Exit(1)
2361     if mode != 'release':
2362         print 'installer has to be built in release mode (use option mode=release)'
2363         Exit(1)
2364     installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2365             % x for x in development_Win32_packaging_installer] + \
2366         ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2367             % x for x in development_Win32_packaging_installer_components] + \
2368         ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2369             % x for x in development_Win32_packaging_installer_dialogs] + \
2370         ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2371             % x for x in development_Win32_packaging_installer_graphics] + \
2372         ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2373             % x for x in development_Win32_packaging_installer_include] + \
2374         ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2375             % x for x in development_Win32_packaging_installer_lang]
2376     if env.has_key('NSIS') and env['NSIS'] is not None:
2377         # create a builder to strip and install
2378         env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2379     else:
2380         print 'No nsis compiler is found. Existing...'
2381         Exit(2)
2382     if not env.has_key('win_installer') or env['win_installer'] is None:
2383         if devel_version:
2384             env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2385         else:
2386             env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2387     # provide default setting
2388     if not env.has_key('deps_dir') or env['deps_dir'] is None:
2389         env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2390     if not os.path.isdir(env.Dir('$deps_dir').abspath):
2391         print 'Development dependency package is not found.'
2392         Exit(1)
2393     else:
2394         env['deps_dir'] = env.Dir('$deps_dir').abspath
2395     # build bundle?
2396     if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2397         env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2398     elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2399         env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2400     else:
2401         env['bundle_dir'] = None
2402     # if absolute path is given, use it, otherwise, write to current directory
2403     if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2404         env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2405     env.Append(NSISDEFINES={
2406         'ExeFile':env['win_installer'],
2407         'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2408         'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2409         'FilesDeps':env['deps_dir'],
2410         'FilesBundle':env['bundle_dir'],
2411         })
2412     installer = env.installer(env['win_installer'],
2413         '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2414     # since I can not use a scanner, explicit dependent is required
2415     env.Depends(installer, 'install')
2416     env.Depends(installer, installer_files)
2417     env.Alias('installer', installer)
2418     # also generate bundle?
2419     if env.has_key('bundle') and env['bundle']:
2420         if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2421             print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2422             print 'Use bundle_dir option to specify'
2423             Exit(1)
2424         # generator of the builder will add bundle stuff depending on output name
2425         bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2426             '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2427         env.Depends(bundle_installer, 'install')
2428         env.Depends(bundle_installer, installer_files)
2429         env.Alias('installer', bundle_installer)
2430
2431 Default('lyx')
2432 Alias('all', ['lyx', 'client', 'tex2lyx'])