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