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 # When using msvc, windows.h is required
 611 if use_vc and not conf.CheckCHeader('windows.h'):
 612     print 'Windows.h is not found. Please install Windows Platform SDK.'
 613     Exit(1)
 614
 615 # pkg-config? (if not, we use hard-coded options)
 616 if conf.CheckPkgConfig('0.15.0'):
 617     env['HAS_PKG_CONFIG'] = True
 618 else:
 619     print 'pkg-config >= 0.1.50 is not found'
 620     env['HAS_PKG_CONFIG'] = False
 621
 622 # zlib? This is required.
 623 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
 624     or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
 625     print 'Did not find zdll.lib or zlib.h, exiting!'
 626     Exit(1)
 627 if conf.CheckLib('iconv'):
 628     env['ICONV_LIB'] = 'iconv'
 629 elif conf.CheckLib('libiconv'):
 630     env['ICONV_LIB'] = 'libiconv'
 631 elif conf.CheckFunc('iconv_open'):
 632     env['ICONV_LIB'] = None
 633 else:
 634     print 'Did not find iconv or libiconv, exiting!'
 635     Exit(1)
 636
 637 # check socket libs
 638 socket_libs = []
 639 if conf.CheckLib('socket'):
 640     socket_libs.append('socket')
 641 # nsl is the network services library and provides a
 642 # transport-level interface to networking services.
 643 if conf.CheckLib('nsl'):
 644     socket_libs.append('nsl')
 645
 646 # check available boost libs (since lyx1.4 does not use iostream)
 647 boost_libs = []
 648 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
 649     if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
 650         boost_libs.append(lib)
 651
 652 # check boost libraries
 653 boost_opt = ARGUMENTS.get('boost', 'auto')
 654 # check for system boost
 655 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
 656 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
 657 # default to $BUILDDIR/libs (use None since this path will be added anyway)
 658 boost_libpath = None
 659 # here I assume that all libraries are in the same directory
 660 if boost_opt == 'included':
 661     boost_libraries = ['included_boost_%s' % x for x in boost_libs]
 662     included_boost = True
 663     env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
 664 elif boost_opt == 'auto':
 665     res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
 666     # if not found, use local boost
 667     if res[0] is None:
 668         boost_libraries = ['included_boost_%s' % x for x in boost_libs]
 669         included_boost = True
 670         env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
 671     else:
 672         included_boost = False
 673         (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
 674 elif boost_opt == 'system':
 675     res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
 676     if res[0] is None:
 677         print "Can not find system boost libraries with version %s " % boost_version
 678         print "Please supply a path through extra_lib_path and try again."
 679         print "Or use boost=included to use included boost libraries."
 680         Exit(2)
 681     else:
 682         included_boost = False
 683         (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
 684
 685
 686 if boost_libpath is not None:
 687     env.AppendUnique(LIBPATH = [boost_libpath])
 688
 689
 690 env['ENABLE_NLS'] = env['nls']
 691
 692 if not env['ENABLE_NLS']:
 693     intl_libs = []
 694     included_gettext = False
 695 else:
 696     # check gettext libraries
 697     gettext_opt = ARGUMENTS.get('gettext', 'auto')
 698     # check for system gettext
 699     succ = False
 700     if gettext_opt in ['auto', 'system']:
 701         if conf.CheckFunc('gettext'):
 702             included_gettext = False
 703             intl_libs = []
 704             succ = True
 705         elif conf.CheckLib('intl'):
 706             included_gettext = False
 707             intl_libs = ['intl']
 708             succ = True
 709         else: # no found
 710             if gettext_opt == 'system':
 711                 print "Can not find system gettext library"
 712                 print "Please supply a path through extra_lib_path and try again."
 713                 print "Or use gettext=included to use included gettext libraries."
 714                 Exit(2)
 715     # now, auto and succ = false, or gettext=included
 716     if not succ:
 717         # we do not need to set LIBPATH now.
 718         included_gettext = True
 719         intl_libs = ['included_intl']
 720
 721
 722 #
 723 # check for msgfmt command
 724 env['MSGFMT'] = conf.CheckCommand('msgfmt')
 725 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
 726 env['XGETTEXT'] = conf.CheckCommand('xgettext')
 727 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
 728
 729 # if under windows, check the nsis compiler
 730 if platform_name == 'win32':
 731     env['NSIS'] = conf.CheckNSIS()
 732
 733 # cygwin packaging requires the binaries to be stripped
 734 if platform_name == 'cygwin':
 735     env['STRIP'] = conf.CheckCommand('strip')
 736
 737 #
 738 # Customized builders
 739 #
 740 # install customized builders
 741 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
 742 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
 743 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
 744
 745
 746 #----------------------------------------------------------
 747 # Generating config.h
 748 #----------------------------------------------------------
 749 aspell_lib = 'aspell'
 750 # assume that we use aspell, aspelld compiled for msvc
 751 if platform_name == 'win32' and mode == 'debug' and use_vc:
 752     aspell_lib = 'aspelld'
 753
 754 # check the existence of config.h
 755 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
 756 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
 757 #
 758 print "Creating %s..." % boost_config_h
 759 #
 760 utils.createConfigFile(conf,
 761     config_file = boost_config_h,
 762     config_pre = '''/* boost/config.h.  Generated by SCons.  */
 763
 764 /* -*- C++ -*- */
 765 /*
 766 * \file config.h
 767 * This file is part of LyX, the document processor.
 768 * Licence details can be found in the file COPYING.
 769 *
 770 * This is the compilation configuration file for LyX.
 771 * It was generated by scon.
 772 * You might want to change some of the defaults if something goes wrong
 773 * during the compilation.
 774 */
 775
 776 #ifndef _BOOST_CONFIG_H
 777 #define _BOOST_CONFIG_H
 778 ''',
 779     headers = [
 780         ('ostream', 'HAVE_OSTREAM', 'cxx'),
 781         ('locale', 'HAVE_LOCALE', 'cxx'),
 782         ('sstream', 'HAVE_SSTREAM', 'cxx'),
 783         #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
 784     ],
 785     custom_tests = [
 786         (env.has_key('assertions') and env['assertions'],
 787             'ENABLE_ASSERTIONS',
 788             'Define if you want assertions to be enabled in the code'
 789         ),
 790     ],
 791     types = [
 792         ('wchar_t', 'HAVE_WCHAR_T', None),
 793     ],
 794     config_post = '''
 795
 796 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
 797 #  define USE_BOOST_FORMAT 1
 798 #else
 799 #  define USE_BOOST_FORMAT 0
 800 #endif
 801
 802 #if !defined(ENABLE_ASSERTIONS)
 803 #  define BOOST_DISABLE_ASSERTS 1
 804 #endif
 805 #define BOOST_ENABLE_ASSERT_HANDLER 1
 806
 807 #define BOOST_DISABLE_THREADS 1
 808 #define BOOST_NO_WSTRING 1
 809
 810 #ifdef __CYGWIN__
 811 #  define BOOST_POSIX 1
 812 #  define BOOST_POSIX_API 1
 813 #  define BOOST_POSIX_PATH 1
 814 #endif
 815
 816 #define BOOST_ALL_NO_LIB 1
 817
 818 #if defined(HAVE_NEWAPIS_H)
 819 #  define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
 820 #endif
 821
 822 /*
 823  * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
 824  * support compiled in:
 825  * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
 826  * And we are not interested at all what libc
 827  * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
 828  * has the needed wchar_t support and uses UCS4. Whether it
 829  * implements this with the help of libc, or whether it has own code
 830  * does not matter for us, because we don't use libc directly (Georg)
 831 */
 832 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && ! defined(__FREEBSD__)
 833 #  define USE_WCHAR_T
 834 #endif
 835
 836 #endif
 837 '''
 838 )
 839 #
 840 print "\nGenerating %s..." % config_h
 841
 842 # AIKSAURUS_H_LOCATION
 843 if (conf.CheckCXXHeader("Aiksaurus.h")):
 844     aik_location = '<Aiksaurus.h>'
 845 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
 846     aik_location = '<Aiksaurus/Aiksaurus.h>'
 847 else:
 848     aik_location = ''
 849
 850 # determine headers to use
 851 spell_opt = ARGUMENTS.get('spell', 'auto')
 852 env['USE_ASPELL'] = False
 853 env['USE_PSPELL'] = False
 854 env['USE_ISPELL'] = False
 855 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
 856     spell_engine = 'USE_ASPELL'
 857 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
 858     spell_engine = 'USE_PSPELL'
 859 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
 860     spell_engine = 'USE_ISPELL'
 861 else:
 862     spell_engine = None
 863
 864 if spell_engine is not None:
 865     env[spell_engine] = True
 866 else:
 867     if spell_opt == 'auto':
 868         print "Warning: Can not locate any spell checker"
 869     elif spell_opt != 'no':
 870         print "Warning: Can not locate specified spell checker:", spell_opt
 871         Exit(1)
 872
 873 # check arg types of select function
 874 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
 875
 876 # check the size of wchar_t
 877 sizeof_wchar_t = conf.CheckSizeOfWChar()
 878 # something wrong
 879 if sizeof_wchar_t == 0:
 880     print 'Error: Can not determine the size of wchar_t.'
 881     Exit(1)
 882
 883 #
 884 # create config.h
 885 result = utils.createConfigFile(conf,
 886     config_file = config_h,
 887     config_pre = '''/* config.h.  Generated by SCons.  */
 888
 889 /* -*- C++ -*- */
 890 /*
 891 * \file config.h
 892 * This file is part of LyX, the document processor.
 893 * Licence details can be found in the file COPYING.
 894 *
 895 * This is the compilation configuration file for LyX.
 896 * It was generated by scon.
 897 * You might want to change some of the defaults if something goes wrong
 898 * during the compilation.
 899 */
 900
 901 #ifndef _CONFIG_H
 902 #define _CONFIG_H
 903 ''',
 904     headers = [
 905         ('io.h', 'HAVE_IO_H', 'c'),
 906         ('limits.h', 'HAVE_LIMITS_H', 'c'),
 907         ('locale.h', 'HAVE_LOCALE_H', 'c'),
 908         ('process.h', 'HAVE_PROCESS_H', 'c'),
 909         ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
 910         ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
 911         ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
 912         ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
 913         ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
 914         ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
 915         ('unistd.h', 'HAVE_UNISTD_H', 'c'),
 916         ('utime.h', 'HAVE_UTIME_H', 'c'),
 917         ('direct.h', 'HAVE_DIRECT_H', 'c'),
 918         ('istream', 'HAVE_ISTREAM', 'cxx'),
 919         ('ios', 'HAVE_IOS', 'cxx'),
 920     ],
 921     functions = [
 922         ('open', 'HAVE_OPEN', None),
 923         ('chmod', 'HAVE_CHMOD', None),
 924         ('close', 'HAVE_CLOSE', None),
 925         ('popen', 'HAVE_POPEN', None),
 926         ('pclose', 'HAVE_PCLOSE', None),
 927         ('_open', 'HAVE__OPEN', None),
 928         ('_close', 'HAVE__CLOSE', None),
 929         ('_popen', 'HAVE__POPEN', None),
 930         ('_pclose', 'HAVE__PCLOSE', None),
 931         ('getpid', 'HAVE_GETPID', None),
 932         ('_getpid', 'HAVE__GETPID', None),
 933         ('mkdir', 'HAVE_MKDIR', None),
 934         ('_mkdir', 'HAVE__MKDIR', None),
 935         ('mktemp', 'HAVE_MKTEMP', None),
 936         ('mkstemp', 'HAVE_MKSTEMP', None),
 937         ('strerror', 'HAVE_STRERROR', None),
 938         ('count', 'HAVE_STD_COUNT', '''
 939 #include <algorithm>
 940 int count()
 941 {
 942 char a[] = "hello";
 943 return std::count(a, a+5, 'l');
 944 }
 945 '''),
 946         ('getcwd', 'HAVE_GETCWD', None),
 947         ('setenv', 'HAVE_SETENV', None),
 948         ('putenv', 'HAVE_PUTENV', None),
 949         ('fcntl', 'HAVE_FCNTL', None),
 950         ('mkfifo', 'HAVE_MKFIFO', None),
 951     ],
 952     declarations = [
 953         ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
 954     ],
 955     types = [
 956         ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
 957             '#include <streambuf>\n#include <istream>'),
 958         ('wchar_t', 'HAVE_WCHAR_T', None),
 959         ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
 960     ],
 961     libs = [
 962         ('gdi32', 'HAVE_LIBGDI32'),
 963         (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
 964     ],
 965     custom_tests = [
 966         (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
 967             'HAVE_PID_T',
 968             'Define is sys/types.h does not have pid_t',
 969             '',
 970             '#define pid_t int',
 971         ),
 972         (conf.CheckCXXGlobalCstd(),
 973             'CXX_GLOBAL_CSTD',
 974             'Define if your C++ compiler puts C library functions in the global namespace'
 975         ),
 976         (conf.CheckMkdirOneArg(),
 977             'MKDIR_TAKES_ONE_ARG',
 978             'Define if mkdir takes only one argument.'
 979         ),
 980         (conf.CheckIconvConst(),
 981             'ICONV_CONST',
 982             'Define as const if the declaration of iconv() needs const.',
 983             '#define ICONV_CONST const',
 984             '#define ICONV_CONST',
 985         ),
 986         (conf.CheckLC_MESSAGES(),
 987             'HAVE_LC_MESSAGES',
 988             'Define if your <locale.h> file defines LC_MESSAGES.'
 989         ),
 990         (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
 991         (env['nls'],
 992             'ENABLE_NLS',
 993             "Define to 1 if translation of program messages to the user's native anguage is requested.",
 994         ),
 995         (env['nls'] and not included_gettext,
 996             'HAVE_GETTEXT',
 997             'Define to 1 if using system gettext library'
 998         ),
 999         (env.has_key('warnings') and env['warnings'],
1000             'WITH_WARNINGS',
1001             'Define this if you want to see the warning directives put here and there by the developpers to get attention'
1002         ),
1003         (env.has_key('concept_checks') and env['concept_checks'],
1004             '_GLIBCXX_CONCEPT_CHECKS',
1005             'libstdc++ concept checking'
1006         ),
1007         (env.has_key('stdlib_debug') and env['stdlib_debug'],
1008             '_GLIBCXX_DEBUG',
1009             'libstdc++ debug mode'
1010         ),
1011         (env.has_key('stdlib_debug') and env['stdlib_debug'],
1012             '_GLIBCXX_DEBUG_PEDANTIC',
1013             'libstdc++ pedantic debug mode'
1014         ),
1015         (os.name != 'nt', 'BOOST_POSIX',
1016             'Indicates to boost < 1.34 which API to use (posix or windows).'
1017         ),
1018         (os.name != 'nt', 'BOOST_POSIX_API',
1019             'Indicates to boost 1.34 which API to use (posix or windows).'
1020         ),
1021         (os.name != 'nt', 'BOOST_POSIX_PATH',
1022             'Indicates to boost 1.34 which path style to use (posix or windows).'
1023         ),
1024         (spell_engine is not None, spell_engine,
1025             'Spell engine to use'
1026         ),
1027         # we need to know the byte order for unicode conversions
1028         (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1029             'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1030         ),
1031     ],
1032     extra_items = [
1033         ('#define PACKAGE "%s%s"' % (package, program_suffix),
1034             'Name of package'),
1035         ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1036             'Define to the address where bug reports for this package should be sent.'),
1037         ('#define PACKAGE_NAME "%s"' % package_name,
1038             'Define to the full name of this package.'),
1039         ('#define PACKAGE_STRING "%s"' % package_string,
1040             'Define to the full name and version of this package.'),
1041         ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1042             'Define to the one symbol short name of this package.'),
1043         ('#define PACKAGE_VERSION "%s"' % package_version,
1044             'Define to the version of this package.'),
1045         ('#define BOOST_ALL_NO_LIB 1',
1046             'disable automatic linking of boost libraries.'),
1047         ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1048             'Packaging method'),
1049         ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1050             'Aiksaurus include file'),
1051         ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1052             "Define to the type of arg 1 for `select'."),
1053         ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1054             "Define to the type of arg 2, 3, 4 for `select'."),
1055         ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1056             "Define to the type of arg 5 for `select'."),
1057         ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1058             'Define to be the size of type wchar_t'),
1059     ],
1060     config_post = '''/************************************************************
1061 ** You should not need to change anything beyond this point */
1062
1063 #ifndef HAVE_STRERROR
1064 #if defined(__cplusplus)
1065 extern "C"
1066 #endif
1067 char * strerror(int n);
1068 #endif
1069
1070 #ifdef HAVE_MKSTEMP
1071 #ifndef HAVE_DECL_MKSTEMP
1072 #if defined(__cplusplus)
1073 extern "C"
1074 #endif
1075 int mkstemp(char*);
1076 #endif
1077 #endif
1078
1079 #include <../boost/config.h>
1080
1081 #endif
1082 '''
1083 )
1084
1085 # these keys are needed in env
1086 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1087     'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1088     # USE_ASPELL etc does not go through result
1089     if result.has_key(key):
1090         env[key] = result[key]
1091
1092 #
1093 # if nls=yes and gettext=included, create intl/config.h
1094 # intl/libintl.h etc
1095 #
1096 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1097 if env['nls'] and included_gettext:
1098     #
1099     print "Creating %s..." % intl_config_h
1100     #
1101     # create intl/config.h
1102     result = utils.createConfigFile(conf,
1103         config_file = intl_config_h,
1104         config_pre = '''/* intl/config.h.  Generated by SCons.  */
1105
1106 /* -*- C++ -*- */
1107 /*
1108 * \file config.h
1109 * This file is part of LyX, the document processor.
1110 * Licence details can be found in the file COPYING.
1111 *
1112 * This is the compilation configuration file for LyX.
1113 * It was generated by scon.
1114 * You might want to change some of the defaults if something goes wrong
1115 * during the compilation.
1116 */
1117
1118 #ifndef _CONFIG_H
1119 #define _CONFIG_H
1120 ''',
1121         headers = [
1122             ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1123             ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1124             ('string.h', 'HAVE_STRING_H', 'c'),
1125             ('strings.h', 'HAVE_STRINGS_H', 'c'),
1126             ('argz.h', 'HAVE_ARGZ_H', 'c'),
1127             ('limits.h', 'HAVE_LIMITS_H', 'c'),
1128             ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1129             ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1130             ('stdint.h', 'HAVE_STDINT_H', 'c'),
1131             ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1132         ],
1133         functions = [
1134             ('getcwd', 'HAVE_GETCWD', None),
1135             ('stpcpy', 'HAVE_STPCPY', None),
1136             ('strcasecmp', 'HAVE_STRCASECMP', None),
1137             ('strdup', 'HAVE_STRDUP', None),
1138             ('strtoul', 'HAVE_STRTOUL', None),
1139             ('alloca', 'HAVE_ALLOCA', None),
1140             ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1141             ('mempcpy', 'HAVE_MEMPCPY', None),
1142             ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1143             ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1144             ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1145             ('setlocale', 'HAVE_SETLOCALE', None),
1146             ('tsearch', 'HAVE_TSEARCH', None),
1147             ('getegid', 'HAVE_GETEGID', None),
1148             ('getgid', 'HAVE_GETGID', None),
1149             ('getuid', 'HAVE_GETUID', None),
1150             ('wcslen', 'HAVE_WCSLEN', None),
1151             ('asprintf', 'HAVE_ASPRINTF', None),
1152             ('wprintf', 'HAVE_WPRINTF', None),
1153             ('snprintf', 'HAVE_SNPRINTF', None),
1154             ('printf', 'HAVE_POSIX_PRINTF', None),
1155             ('fcntl', 'HAVE_FCNTL', None),
1156         ],
1157         types = [
1158             ('intmax_t', 'HAVE_INTMAX_T', None),
1159             ('long double', 'HAVE_LONG_DOUBLE', None),
1160             ('long long', 'HAVE_LONG_LONG', None),
1161             ('wchar_t', 'HAVE_WCHAR_T', None),
1162             ('wint_t', 'HAVE_WINT_T', None),
1163             ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1164             ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1165         ],
1166         libs = [
1167             ('c', 'HAVE_LIBC'),
1168         ],
1169         custom_tests = [
1170             (conf.CheckLC_MESSAGES(),
1171                 'HAVE_LC_MESSAGES',
1172                 'Define if your <locale.h> file defines LC_MESSAGES.'
1173             ),
1174             (conf.CheckIconvConst(),
1175                 'ICONV_CONST',
1176                 'Define as const if the declaration of iconv() needs const.',
1177                 '#define ICONV_CONST const',
1178                 '#define ICONV_CONST',
1179             ),
1180             (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1181             conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1182                 'HAVE_INTMAX_T',
1183                 "Define to 1 if you have the `intmax_t' type."
1184             ),
1185             (env.has_key('nls') and env['nls'],
1186                 'ENABLE_NLS',
1187                 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1188             ),
1189         ],
1190         extra_items = [
1191             ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1192             ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1193                 'Define to be the size of type wchar_t'),
1194         ],
1195         config_post = '#endif'
1196     )
1197
1198     # these keys are needed in env
1199     for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1200         'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1201         # USE_ASPELL etc does not go through result
1202         if result.has_key(key):
1203             env[key] = result[key]
1204
1205
1206 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1207 if env['nls'] and included_gettext:
1208     # libgnuintl.h.in => libintl.h
1209     env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1210     env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1211     env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1212         [Copy('$TARGET', '$SOURCE')])
1213
1214 #
1215 # Finish auto-configuration
1216 env = conf.Finish()
1217
1218 #----------------------------------------------------------
1219 # Now set up our build process accordingly
1220 #----------------------------------------------------------
1221
1222 if env['ICONV_LIB'] is None:
1223     system_libs = []
1224 else:
1225     system_libs = [env['ICONV_LIB']]
1226 if platform_name in ['win32', 'cygwin']:
1227     # the final link step needs stdc++ to succeed under mingw
1228     # FIXME: shouldn't g++ automatically link to stdc++?
1229     if use_vc:
1230         system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1231     else:
1232         system_libs += ['shlwapi', 'stdc++', 'z']
1233 elif platform_name == 'cygwin' and env['X11']:
1234     system_libs += ['GL',  'Xmu', 'Xi', 'Xrender', 'Xrandr',
1235         'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1236         'resolv', 'pthread', 'z']
1237 else:
1238     system_libs += ['z']
1239
1240 libs = [
1241     ('HAVE_LIBGDI32', 'gdi32'),
1242     ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1243     ('USE_ASPELL', aspell_lib),
1244     ('USE_ISPELL', 'ispell'),
1245     ('USE_PSPELL', 'pspell'),
1246 ]
1247
1248 for lib in libs:
1249     if env[lib[0]]:
1250         system_libs.append(lib[1])
1251
1252 #
1253 # Build parameters CPPPATH etc
1254 #
1255 if env['X11']:
1256     env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1257
1258 #
1259 # boost: for boost header files
1260 # BUILDDIR/common: for config.h
1261 # TOP_SRCDIR/src: for support/* etc
1262 #
1263 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1264 #
1265 # Separating boost directories from CPPPATH stops scons from building
1266 # the dependency tree for boost header files, and effectively reduce
1267 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1268 # boost headers, this is only done for system boost headers.
1269 if included_boost:
1270     env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1271 else:
1272     if use_vc:
1273         env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1274     else:
1275         env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1276
1277 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1278 if env['nls'] and included_gettext:
1279     env['CPPPATH'].append('$BUILDDIR/intl')
1280 #
1281
1282 #
1283 # A Link script for cygwin see
1284 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1285 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1286 # for details
1287 #
1288 if platform_name == 'cygwin':
1289     ld_script_path = '/tmp'
1290     ld_script = utils.installCygwinLDScript(ld_script_path)
1291     env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1292         '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1293
1294
1295 #---------------------------------------------------------
1296 # Frontend related variables (QTDIR etc)
1297 #---------------------------------------------------------
1298
1299 #
1300 # create a separate environment so that other files do not have
1301 # to be built with all the include directories etc
1302 #
1303 if frontend == 'qt4':
1304     frontend_env = env.Copy()
1305
1306     # handle qt related user specified paths
1307     # set environment so that moc etc can be found even if its path is not set properly
1308     if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1309         frontend_env['QTDIR'] = frontend_env['qt_dir']
1310         if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1311             os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1312             frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1313         if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1314             frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1315
1316     # if separate qt_lib_path is given
1317     if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1318         qt_lib_path = frontend_env.subst('$qt_lib_path')
1319         frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1320         frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1321     else:
1322         qt_lib_path = None
1323
1324     # if separate qt_inc_path is given
1325     if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1326         qt_inc_path = frontend_env['qt_inc_path']
1327     else:
1328         qt_inc_path = None
1329
1330     # local qt4 toolset from
1331     # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1332     #
1333     # NOTE: I have to patch qt4.py since it does not automatically
1334     # process .C file!!! (add to cxx_suffixes )
1335     #
1336     frontend_env.Tool('qt4', [scons_dir])
1337     frontend_env['QT_AUTOSCAN'] = 0
1338     frontend_env['QT4_AUTOSCAN'] = 0
1339     frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1340
1341     if qt_lib_path is None:
1342         qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1343     if qt_inc_path is None:
1344         qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1345
1346
1347     conf = Configure(frontend_env,
1348         custom_tests = {
1349             'CheckPackage' : utils.checkPackage,
1350             'CheckCommand' : utils.checkCommand,
1351         }
1352     )
1353
1354     succ = False
1355     # first: try pkg_config
1356     if frontend_env['HAS_PKG_CONFIG']:
1357         succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1358         # FIXME: use pkg_config information?
1359         #frontend_env['QT4_PKG_CONFIG'] = succ
1360     # second: try to link to it
1361     if not succ:
1362         # Under linux, I can test the following perfectly
1363         # Under windows, lib names need to passed as libXXX4.a ...
1364         if platform_name == 'win32':
1365             succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1366         else:
1367             succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1368     # still can not find it
1369     if not succ:
1370         print 'Did not find qt libraries, exiting!'
1371         Exit(1)
1372     #
1373     # Now, determine the correct suffix:
1374     qt_libs = ['QtCore', 'QtGui']
1375     if platform_name == 'win32':
1376         if mode == 'debug' and use_vc and \
1377             conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1378             qt_lib_suffix = 'd4'
1379             use_qt_debug_libs = True
1380         else:
1381             qt_lib_suffix = '4'
1382             use_qt_debug_libs = False
1383     else:
1384         if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1385             qt_lib_suffix = '_debug'
1386             use_qt_debug_libs = True
1387         else:
1388             qt_lib_suffix = ''
1389             use_qt_debug_libs = False
1390     frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1391     frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1392     qtcore_lib = ['QtCore' + qt_lib_suffix]
1393
1394     # check uic and moc commands for qt frontends
1395     if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1396         print 'uic or moc command is not found for frontend', frontend
1397         Exit(1)
1398
1399     # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1400     # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1401     # For some unknown changes in msvc or qt, this is no longer needed.
1402     if use_vc:
1403         frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1404             'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1405             env.File('$BUILDDIR/lyx.exe.manifest').path]
1406
1407     frontend_env = conf.Finish()
1408
1409 #
1410 # Report results
1411 #
1412 # fill in the version info
1413 env['VERSION_INFO'] = '''Configuration
1414   Host type:                      %s
1415   Special build flags:            %s
1416   C   Compiler:                   %s
1417   C   Compiler flags:             %s %s
1418   C++ Compiler:                   %s
1419   C++ Compiler LyX flags:         %s
1420   C++ Compiler flags:             %s %s
1421   Linker flags:                   %s
1422   Linker user flags:              %s
1423 Build info:
1424   Builing directory:              %s
1425   Local library directory:        %s
1426   Libraries paths:                %s
1427   Boost libraries:                %s
1428   Frontend libraries:             %s
1429   System libraries:               %s
1430   include search path:            %s
1431 Frontend:
1432   Frontend:                       %s
1433   Packaging:                      %s
1434   LyX dir:                        %s
1435   LyX files dir:                  %s
1436 ''' % (platform_name,
1437     env.subst('$CCFLAGS'), env.subst('$CC'),
1438     env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1439     env.subst('$CXX'), env.subst('$CXXFLAGS'),
1440     env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1441     env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1442     env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1443     str(env['LIBPATH']), str(boost_libraries),
1444     str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1445     frontend, packaging_method,
1446     prefix, env['LYX_DIR'])
1447
1448 if frontend in ['qt4']:
1449     env['VERSION_INFO'] += '''  include dir:                    %s
1450   library dir:                    %s
1451   X11:                            %s
1452 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1453
1454 print env['VERSION_INFO']
1455
1456 #
1457 # Mingw command line may be too short for our link usage,
1458 # Here we use a trick from scons wiki
1459 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1460 #
1461 # I also would like to add logging (commands only) capacity to the
1462 # spawn system.
1463 logfile = env.get('logfile', default_log_file)
1464 if logfile != '' or platform_name == 'win32':
1465     import time
1466     utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1467         info = '''# This is a log of commands used by scons to build lyx
1468 # Time: %s
1469 # Command: %s
1470 # Info: %s
1471 ''' % (time.asctime(), ' '.join(sys.argv),
1472     env['VERSION_INFO'].replace('\n','\n# ')) )
1473
1474
1475 # Cleanup stuff
1476 #
1477 # -h will print out help info
1478 Help(opts.GenerateHelpText(env))
1479
1480
1481
1482 #----------------------------------------------------------
1483 # Start building
1484 #----------------------------------------------------------
1485 # this has been the source of problems on some platforms...
1486 # I find that I need to supply it with full path name
1487 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1488 # this usage needs further investigation.
1489 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1490
1491 print "Building all targets recursively"
1492
1493 if env.has_key('rebuild'):
1494     rebuild_targets = env['rebuild'].split(',')
1495     if 'none' in rebuild_targets or 'no' in rebuild_targets:
1496         rebuild_targets = []
1497     elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1498         # None: let scons decide which components to build
1499         # Forcing all components to be rebuilt is in theory not necessary
1500         rebuild_targets = None
1501 else:
1502     rebuild_targets = None
1503
1504 def libExists(libname):
1505     ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1506     return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1507
1508 def appExists(apppath, appname):
1509     ''' Check whether or not application already exists'''
1510     return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1511
1512 targets = BUILD_TARGETS
1513 build_install = 'install' in targets or 'installer' in targets
1514 build_installer = 'installer' in targets
1515 # msvc need to pass full target name, so I have to look for path/lyx etc
1516 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1517     or build_install or 'all' in targets
1518 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1519 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1520 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1521 build_mathed = build_lyx or 'mathed' in targets
1522 build_insets = build_lyx or 'insets' in targets
1523 build_frontends = build_lyx or 'frontends' in targets
1524 build_graphics = build_lyx or 'graphics' in targets
1525 build_controllers = build_lyx or 'controllers' in targets
1526 build_client = True in ['client' in x for x in targets] \
1527     or build_install or 'all' in targets or build_installer
1528 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1529     or build_install or 'all' in targets or build_installer
1530 build_lyxbase = build_lyx or 'lyxbase' in targets
1531 update_po = 'update_po' in targets
1532 update_manifest = 'update_manifest' in targets
1533 build_po = 'po' in targets or build_install or 'all' in targets
1534 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1535 build_msvs_projects = use_vc and 'msvs_projects' in targets
1536
1537
1538 # now, if rebuild_targets is specified, do not rebuild some targets
1539 if rebuild_targets is not None:
1540     #
1541     def ifBuildLib(name, libname, old_value):
1542         # explicitly asked to rebuild
1543         if name in rebuild_targets:
1544             return True
1545         # else if not rebuild, and if the library already exists
1546         elif libExists(libname):
1547             return False
1548         # do not change the original value
1549         else:
1550             return old_value
1551     build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1552     build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1553     build_support = ifBuildLib('support', 'support', build_support)
1554     build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1555     build_insets = ifBuildLib('insets', 'insets', build_insets)
1556     build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1557     build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1558     build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1559     build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1560     build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1561     #
1562     def ifBuildApp(name, appname, old_value):
1563         # explicitly asked to rebuild
1564         if name in rebuild_targets:
1565             return True
1566         # else if not rebuild, and if the library already exists
1567         elif appExists(name, appname):
1568             return False
1569         # do not change the original value
1570         else:
1571             return old_value
1572     build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1573     build_client = ifBuildApp('client', 'lyxclient', build_client)
1574
1575 # sync frontend and frontend (?)
1576 if build_qt4:
1577     frontend = 'qt4'
1578
1579
1580 if build_boost:
1581     #
1582     # boost libraries
1583     #
1584     # special builddir
1585     env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1586
1587     boostenv = env.Copy()
1588     #
1589     # boost use its own config.h
1590     boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1591     boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1592
1593     for lib in boost_libs:
1594         print 'Processing files in boost/libs/%s/src...' % lib
1595         boostlib = boostenv.StaticLibrary(
1596             target = '$LOCALLIBPATH/included_boost_%s' % lib,
1597             source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1598         )
1599         Alias('boost', boostlib)
1600
1601
1602 if build_intl:
1603     #
1604     # intl
1605     #
1606     intlenv = env.Copy()
1607
1608     print "Processing files in intl..."
1609
1610     env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1611
1612     # we need the original C compiler for these files
1613     intlenv['CC'] = C_COMPILER
1614     intlenv['CCFLAGS'] = C_CCFLAGS
1615     if use_vc:
1616         intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1617     # intl does not use global config.h
1618     intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1619
1620     intlenv.Append(CCFLAGS = [
1621         r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1622         r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1623         r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1624         '-DIN_LIBINTL',
1625         '-DENABLE_RELOCATABLE=1',
1626         '-DIN_LIBRARY',
1627         r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1628         '-DNO_XMALLOC',
1629         '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1630         '-Drelocate=libintl_relocate',
1631         '-DDEPENDS_ON_LIBICONV=1',
1632         '-DHAVE_CONFIG_H'
1633         ]
1634     )
1635
1636     intl = intlenv.StaticLibrary(
1637         target = '$LOCALLIBPATH/included_intl',
1638         LIBS = ['c'],
1639         source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1640     )
1641     Alias('intl', intl)
1642
1643
1644 #
1645 # Now, src code under src/
1646 #
1647 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1648
1649
1650 if build_support:
1651     #
1652     # src/support
1653     #
1654     print "Processing files in src/support..."
1655
1656     frontend_env.Depends('$BUILDDIR/common/support/Package.cpp', '$BUILDDIR/common/config.h')
1657     Package_cpp = env.substFile('$BUILDDIR/common/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1658
1659     support = frontend_env.StaticLibrary(
1660         target = '$LOCALLIBPATH/support',
1661         source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files] + Package_cpp,
1662     )
1663     Alias('support', support)
1664
1665
1666 if build_mathed:
1667     #
1668     # src/mathed
1669     #
1670     print "Processing files in src/mathed..."
1671     #
1672     mathed = env.StaticLibrary(
1673         target = '$LOCALLIBPATH/mathed',
1674         source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1675     )
1676     Alias('mathed', mathed)
1677
1678
1679 if build_insets:
1680     #
1681     # src/insets
1682     #
1683     print "Processing files in src/insets..."
1684     #
1685     insets = env.StaticLibrary(
1686         target = '$LOCALLIBPATH/insets',
1687         source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1688     )
1689     Alias('insets', insets)
1690
1691
1692 if build_frontends:
1693     #
1694     # src/frontends
1695     #
1696     print "Processing files in src/frontends..."
1697
1698     frontends = env.StaticLibrary(
1699         target = '$LOCALLIBPATH/frontends',
1700         source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1701     )
1702     Alias('frontends', frontends)
1703
1704
1705 if build_graphics:
1706     #
1707     # src/graphics
1708     #
1709     print "Processing files in src/graphics..."
1710
1711     graphics = env.StaticLibrary(
1712         target = '$LOCALLIBPATH/graphics',
1713         source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1714     )
1715     Alias('graphics', graphics)
1716
1717
1718 if build_controllers:
1719     #
1720     # src/frontends/controllers
1721     #
1722     print "Processing files in src/frontends/controllers..."
1723
1724     controllers = env.StaticLibrary(
1725         target = '$LOCALLIBPATH/controllers',
1726         source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1727     )
1728     Alias('controllers', controllers)
1729
1730
1731 #
1732 # src/frontend/qt4
1733 #
1734 if build_qt4:
1735     env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1736
1737     print "Processing files in src/frontends/qt4..."
1738
1739     qt4_moc_files = ["$BUILDDIR/common/frontends/qt4/%s" % x for x in src_frontends_qt4_moc_files]
1740
1741     #
1742     # Compile resources
1743     #
1744     resources = [frontend_env.Uic4(x.split('.')[0]) for x in \
1745         ["$BUILDDIR/common/frontends/qt4/ui/%s" % x for x in src_frontends_qt4_ui_files]]
1746
1747     #
1748     # moc qt4_moc_files, the moced files are included in the original files
1749     #
1750     qt4_moced_files = [frontend_env.Moc4(x.replace('.cpp', '_moc.cpp'), x.replace('.cpp', '.h')) for x in qt4_moc_files]
1751
1752     qt4 = frontend_env.StaticLibrary(
1753         target = '$LOCALLIBPATH/qt4',
1754         source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1755         CPPPATH = [
1756             '$CPPPATH',
1757             '$BUILDDIR/common',
1758             '$BUILDDIR/common/images',
1759             '$BUILDDIR/common/frontends',
1760             '$BUILDDIR/common/frontends/qt4',
1761             '$BUILDDIR/common/frontends/controllers'
1762         ],
1763         CCFLAGS =  [
1764             '$CCFLAGS',
1765             '-DHAVE_CONFIG_H',
1766             '-DQT_CLEAN_NAMESPACE',
1767             '-DQT_GENUINE_STR',
1768             '-DQT_NO_STL',
1769             '-DQT_NO_KEYWORDS',
1770         ]
1771     )
1772     Alias('qt4', qt4)
1773
1774
1775 if build_client:
1776     #
1777     # src/client
1778     #
1779     frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1780
1781     print "Processing files in src/client..."
1782
1783     if env['HAVE_FCNTL']:
1784         client = frontend_env.Program(
1785             target = '$BUILDDIR/common/client/lyxclient',
1786             LIBS = ['support'] + intl_libs + system_libs +
1787                 socket_libs + boost_libraries + qtcore_lib,
1788             source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1789                 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1790         )
1791         Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1792             client, [Copy('$TARGET', '$SOURCE')]))
1793     else:
1794         client = None
1795     Alias('client', client)
1796 else:
1797     if env['HAVE_FCNTL']:
1798         # define client even if lyxclient is not built with rebuild=no
1799         client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1800     else:
1801         client = None
1802
1803
1804 if build_tex2lyx:
1805     #
1806     # tex2lyx
1807     #
1808     print "Processing files in src/tex2lyx..."
1809
1810     #
1811     for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1812         frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1813             [Copy('$TARGET', '$SOURCE')])
1814
1815     tex2lyx = frontend_env.Program(
1816         target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1817         LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1818         source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1819             utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1820         CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1821         LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1822     )
1823     Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1824         tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1825     Alias('tex2lyx', tex2lyx)
1826 else:
1827     # define tex2lyx even if tex2lyx is not built with rebuild=no
1828     tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1829
1830
1831 if build_lyxbase:
1832     #
1833     # src/
1834     #
1835     print "Processing files in src..."
1836
1837     env.Depends('$BUILDDIR/common/version.cpp', '$BUILDDIR/common/config.h')
1838     version_cpp = env.substFile('$BUILDDIR/common/version.cpp', '$TOP_SRCDIR/src/version.cpp.in')
1839
1840     if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1841         src_post_files.append('ASpell.cpp')
1842     elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1843         src_post_files.append('PSpell.cpp')
1844     elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1845         src_post_files.append('ISpell.cpp')
1846
1847     # msvc requires at least one source file with main()
1848     # so I exclude main.cpp from lyxbase
1849     lyxbase_pre = env.StaticLibrary(
1850         target = '$LOCALLIBPATH/lyxbase_pre',
1851         source = ['$BUILDDIR/common/%s' % x for x in src_pre_files] + version_cpp
1852     )
1853     lyxbase_post = env.StaticLibrary(
1854         target = '$LOCALLIBPATH/lyxbase_post',
1855         source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1856     )
1857     Alias('lyxbase', lyxbase_pre)
1858     Alias('lyxbase', lyxbase_post)
1859
1860
1861 if build_lyx:
1862     #
1863     # Build lyx with given frontend
1864     #
1865     lyx = frontend_env.Program(
1866         target = '$BUILDDIR/lyx',
1867         source = ['$BUILDDIR/common/main.cpp'] + \
1868             utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1869         LIBS = [
1870             'lyxbase_pre',
1871             'mathed',
1872             'insets',
1873             'frontends',
1874             frontend,
1875             'controllers',
1876             'graphics',
1877             'support',
1878             'lyxbase_post',
1879             ] +
1880             boost_libraries +
1881             frontend_libs +
1882             intl_libs +
1883             socket_libs +
1884             system_libs
1885     )
1886     Alias('lyx', lyx)
1887 else:
1888     # define lyx even if lyx is not built with rebuild=no
1889     lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1890
1891
1892 if build_msvs_projects:
1893     def build_project(target, full_target = None,
1894         src = [], inc = [], res = [], rebuildTargetOnly = True):
1895         ''' build mavs project files
1896             target:      alias (correspond to directory name)
1897             full_target: full path/filename of the target
1898             src:         source files
1899             inc:         include files
1900             res:         resource files
1901             rebuildTargetOnly:     whether or not only rebuild this target
1902
1903         For non-debug-able targets like static libraries, target (alias) is
1904         enough to build the target. For executable targets, msvs need to know
1905         the full path to start debug them.
1906         '''
1907         if rebuildTargetOnly:
1908             cmds = 'rebuild='+target
1909         else:
1910             cmds = ''
1911         if full_target is None:
1912             build_target = target
1913         else:
1914             build_target = full_target
1915         # project
1916         proj = env.MSVSProject(
1917             target = target + env['MSVSPROJECTSUFFIX'],
1918             # this allows easy access to header files (along with source)
1919             srcs = [env.subst(x) for x in src + inc],
1920             incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1921             localincs = [env.subst(x) for x in inc],
1922             resources = [env.subst(x) for x in res],
1923             buildtarget = build_target,
1924             cmdargs = cmds,
1925             variant = 'Debug'
1926         )
1927         Alias('msvs_projects', proj)
1928     #
1929     build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1930         inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1931         rebuildTargetOnly = False,
1932         full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1933     #
1934     build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1935         inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1936         rebuildTargetOnly = False,
1937         full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1938     #
1939     build_project('lyx',
1940         src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1941             ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1942             ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1943             ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1944             ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1945             ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1946             ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1947             ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1948         inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1949             ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1950             ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1951             ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1952             ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1953             ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1954             ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1955             ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1956         res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1957         rebuildTargetOnly = False,
1958         full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1959
1960
1961 if update_manifest:
1962     #
1963     # update scons_manifest.py
1964     #
1965     # When you run 'scons update_manifest', it tells you which files are missing
1966     # and which files are not in the source tree. It also generates a
1967     # scons_manifest.py.new file with all the missing files added to
1968     # XXX_extra_files. It will *not* change other sections of existing
1969     # manifest.py
1970     #
1971     print 'Validating development/scons/scons_manifest.py...'
1972     #
1973     manifest = open(env.File('$TOP_SRCDIR/development/scons/scons_manifest.py.new').abspath, 'w')
1974     print >> manifest, 'from SCons.Util import Split\n'
1975     #
1976     ignore_dirs = ['boost/boost', 'm4', 'development',
1977         utils.relativePath(env.Dir('$BUILDDIR').abspath, env.Dir('$TOP_SRCDIR').abspath)]
1978     ignore_types = ['.svn', '.deps', '.cache', '.tmp', '.bak', '.gmo', '.pot',
1979         '.pyc', '.pyo', '.o', '_moc.cpp', 'Makefile.in', 'config.h.in',
1980         'LaTeXConfig.lyx', 'version.cpp', 'Package.cpp']
1981     ext_types = ['_header_files', '_files', '_pre_files', '_post_files', '_moc_files', '_inc_files',
1982         '_copied_files', '_copied_header_files', '_extra_header_files', '_extra_src_files', '_extra_files']
1983     for root,path,files in os.walk(env.Dir('$TOP_SRCDIR').abspath):
1984         if os.path.split(root)[-1][0] == '.' \
1985             or True in [x in root for x in ignore_types] \
1986             or True in [utils.isSubDir(root, x) for x in ignore_dirs]:
1987             continue
1988         dirname = utils.relativePath(root, env.subst('$TOP_SRCDIR')).replace(os.sep, '_')
1989         if dirname == '':
1990             dirname = 'TOP'
1991         # files in the current manifest.py
1992         cur_files = []
1993         for ext in ext_types:
1994             if 'copied' not in ext and dirname + ext in locals():
1995                 cur_files.extend(eval(dirname + ext))
1996         cur_files.sort()
1997         # compare files with cur_files
1998         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]]
1999         files.sort()
2000         if cur_files != files:
2001             missing = []
2002             for f in files:
2003                 if f not in cur_files:
2004                     missing.append(f)
2005             extra = []
2006             for f in cur_files:
2007                 if f not in files:
2008                     extra.append(f)
2009             if len(missing) > 0:
2010                 print 'Missing: %s in %s' % (', '.join(missing), root)
2011                 if dirname + '_extra_files' in locals():
2012                     exec('%s_extra_files.extend(missing)' % dirname)
2013                 else:
2014                     exec('%s_extra_files = missing' % dirname)
2015             if len(extra) > 0:
2016                 print 'Extra: %s in %s' % (', '.join(extra), root)
2017         # write to a new manifest file
2018         for ext in ext_types:
2019             if dirname + ext in locals():
2020                 exec('%s%s.sort()' % (dirname, ext))
2021                 print >> manifest, "%s%s = Split('''\n   " % (dirname, ext),
2022                 print >> manifest, eval(r"'\n    '.join(%s%s)" % (dirname, ext))
2023                 print >> manifest, "''')\n\n"
2024     manifest.close()
2025     Alias('update_manifest', None)
2026
2027
2028 if update_po:
2029     #
2030     # update po files
2031     #
2032     print 'Updating po/*.po files...'
2033
2034     # whether or not update po files
2035     if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
2036         print 'xgettext or msgmerge does not exist. Cannot merge po files'
2037         Exit(1)
2038     # rebuild POTFILES.in
2039     POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
2040         ['$TOP_SRCDIR/src/%s' % x for x in  src_header_files + src_pre_files + src_post_files + \
2041             src_extra_src_files] + \
2042         ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
2043             src_support_extra_header_files + src_support_extra_src_files] + \
2044         ['$TOP_SRCDIR/src/mathed/%s' % x for x in  src_mathed_header_files + src_mathed_files] + \
2045         ['$TOP_SRCDIR/src/insets/%s' % x for x in  src_insets_header_files + src_insets_files] + \
2046         ['$TOP_SRCDIR/src/frontends/%s' % x for x in  src_frontends_header_files + src_frontends_files] + \
2047         ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
2048         ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
2049         ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
2050         ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ]  + \
2051         ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
2052     )
2053     Alias('update_po', POTFILES_in)
2054     # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
2055     # and combine them to lyx.po
2056     env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
2057     lyx_po = env.Command('$BUILDDIR/po/lyx.po',
2058         env.Command('$BUILDDIR/po/all.po',
2059             [env.Command('$BUILDDIR/po/qt4_l10n.pot',
2060                 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
2061                 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
2062              env.Command('$BUILDDIR/po/layouts_l10n.pot',
2063                 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
2064                 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2065              env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
2066                 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2067              env.Command('$BUILDDIR/po/ui_l10n.pot',
2068                 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2069                 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2070              env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
2071                 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
2072              ], utils.env_cat),
2073             ['$MSGUNIQ -o $TARGET $SOURCE',
2074              '''$XGETTEXT --default-domain=${TARGET.base} \
2075                 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2076                 --language=C++ --join-existing \
2077                 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
2078                 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2079                 --copyright-holder="LyX Developers" \
2080                 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2081         )
2082     env.Depends(lyx_po, POTFILES_in)
2083     # copy lyx.po to lyx.pot
2084     lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2085         Copy('$TARGET', '$SOURCE'))
2086     #
2087     import glob
2088     # files to translate
2089     transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2090     # possibly *only* handle these languages
2091     languages = None
2092     if env.has_key('languages'):
2093         languages = env.make_list(env['languages'])
2094     # merge. if I use lan.po as $TARGET, it will be removed
2095     # before it is merged. In this builder,
2096     # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2097     # and is copied to po/lang.po
2098     env['BUILDERS']['msgmerge'] = Builder(action=[
2099         '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2100         Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2101         )
2102     # for each po file, generate pot
2103     for po_file in transfiles:
2104         # get filename
2105         fname = os.path.split(po_file)[1]
2106         # country code
2107         country = fname.split('.')[0]
2108         #
2109         if not languages or country in languages:
2110             # merge po files, the generated lan.po_new file is copied to lan.po file.
2111             po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2112             env.Depends(po, POTFILES_in)
2113             Alias('update_po', po)
2114
2115
2116 if build_po:
2117     #
2118     # po/
2119     #
2120     print 'Processing files in po...'
2121
2122     import glob
2123     # handle po files
2124     #
2125     # files to translate
2126     transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2127     # possibly *only* handle these languages
2128     languages = None
2129     if env.has_key('languages'):
2130         languages = env.make_list(env['lanauges'])
2131     # use defulat msgfmt
2132     gmo_files = []
2133     if not env['MSGFMT']:
2134         print 'msgfmt does not exist. Can not process po files'
2135     else:
2136         # create a builder
2137         env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2138         #
2139         for f in transfiles:
2140             # get filename
2141             fname = os.path.split(f)[1]
2142             # country code
2143             country = fname.split('.')[0]
2144             #
2145             if not languages or country in languages:
2146                 gmo_files.extend(env.Transfiles(f))
2147
2148
2149 if build_install:
2150     #
2151     # this part is a bit messy right now. Since scons will provide
2152     # --DESTDIR option soon, at least the dest_dir handling can be
2153     # removed later.
2154     #
2155     # how to join dest_dir and prefix
2156     def joinPaths(path1, path2):
2157         ''' join path1 and path2, do not use os.path.join because
2158             under window, c:\destdir\d:\program is invalid '''
2159         if path1 == '':
2160             return os.path.normpath(path2)
2161         # separate drive letter
2162         (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2163         # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2164         return os.path.join(os.path.normpath(path1), path[1:])
2165     #
2166     # install to dest_dir/prefix
2167     dest_dir = env.get('DESTDIR', '')
2168     dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2169     # create the directory if needed
2170     if not os.path.isdir(dest_prefix_dir):
2171         try:
2172             os.makedirs(dest_prefix_dir)
2173         except:
2174             pass
2175         if not os.path.isdir(dest_prefix_dir):
2176             print 'Can not create directory', dest_prefix_dir
2177             Exit(3)
2178     #
2179     if env.has_key('exec_prefix'):
2180         bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2181     else:
2182         bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2183     if add_suffix:
2184         share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2185     else:
2186         share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2187     man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2188     locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2189     env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2190     #
2191     import glob
2192     #
2193     # install executables (lyxclient may be None)
2194     #
2195     if add_suffix:
2196         version_suffix = program_suffix
2197     else:
2198         version_suffix = ''
2199     #
2200     # install lyx, if in release mode, try to strip the binary
2201     if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2202         # create a builder to strip and install
2203         env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2204
2205     # install executables
2206     for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2207         if obj is None:
2208             continue
2209         target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2210         target = os.path.join(bin_dest_dir, target_name)
2211         if env['BUILDERS'].has_key('StripInstallAs'):
2212             env.StripInstallAs(target, obj)
2213         else:
2214             env.InstallAs(target, obj)
2215         Alias('install', target)
2216
2217     # share/lyx
2218     dirs = []
2219     for (dir,files) in [
2220             ('.', lib_files),
2221             ('bind', lib_bind_files),
2222             ('bind/de', lib_bind_de_files),
2223             ('bind/fi', lib_bind_fi_files),
2224             ('bind/pt', lib_bind_pt_files),
2225             ('bind/sv', lib_bind_sv_files),
2226             ('doc', lib_doc_files),
2227             ('doc/clipart', lib_doc_clipart_files),
2228             ('doc/cs', lib_doc_cs_files),
2229             ('doc/da', lib_doc_da_files),
2230             ('doc/de', lib_doc_de_files),
2231             ('doc/de/clipart', lib_doc_de_clipart_files),
2232             ('doc/es', lib_doc_es_files),
2233             ('doc/es/clipart', lib_doc_es_clipart_files),
2234             ('doc/eu', lib_doc_eu_files),
2235             ('doc/fr', lib_doc_fr_files),
2236             ('doc/he', lib_doc_he_files),
2237             ('doc/hu', lib_doc_hu_files),
2238             ('doc/it', lib_doc_it_files),
2239             ('doc/nl', lib_doc_nl_files),
2240             ('doc/nb', lib_doc_nb_files),
2241             ('doc/pl', lib_doc_pl_files),
2242             ('doc/pt', lib_doc_pt_files),
2243             ('doc/ro', lib_doc_ro_files),
2244             ('doc/ru', lib_doc_ru_files),
2245             ('doc/sk', lib_doc_sk_files),
2246             ('doc/sl', lib_doc_sl_files),
2247             ('doc/sv', lib_doc_sv_files),
2248             ('examples', lib_examples_files),
2249             ('examples/ca', lib_examples_ca_files),
2250             ('examples/cs', lib_examples_cs_files),
2251             ('examples/da', lib_examples_da_files),
2252             ('examples/de', lib_examples_de_files),
2253             ('examples/es', lib_examples_es_files),
2254             ('examples/eu', lib_examples_eu_files),
2255             ('examples/fa', lib_examples_fa_files),
2256             ('examples/fr', lib_examples_fr_files),
2257             ('examples/he', lib_examples_he_files),
2258             ('examples/hu', lib_examples_hu_files),
2259             ('examples/it', lib_examples_it_files),
2260             ('examples/nl', lib_examples_nl_files),
2261             ('examples/pl', lib_examples_pl_files),
2262             ('examples/pt', lib_examples_pt_files),
2263             ('examples/ru', lib_examples_ru_files),
2264             ('examples/sl', lib_examples_sl_files),
2265             ('examples/ro', lib_examples_ro_files),
2266             ('fonts', lib_fonts_files),
2267             ('images', lib_images_files),
2268             ('images/math', lib_images_math_files),
2269             ('kbd', lib_kbd_files),
2270             ('layouts', lib_layouts_files + lib_layouts_inc_files),
2271             ('lyx2lyx', lib_lyx2lyx_files),
2272             ('scripts', lib_scripts_files),
2273             ('templates', lib_templates_files),
2274             ('tex', lib_tex_files),
2275             ('ui', lib_ui_files)]:
2276         dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2277             [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2278     Alias('install', dirs)
2279
2280     # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2281     env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2282     env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2283         '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2284     Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2285     sys.path.append(share_dest_dir + '/lyx2lyx')
2286
2287     # generate TOC files for each doc
2288     languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2289     tocs = []
2290     for lang in languages.keys():
2291         if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2292             toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2293                 languages[lang])
2294             tocs.append(toc)
2295             # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2296             env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2297         else:
2298             # this is for English
2299             toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2300                 languages[lang])
2301             tocs.append(toc)
2302             env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2303     Alias('install', tocs)
2304
2305     if platform_name == 'cygwin':
2306         # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2307         Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2308             '%s-%s.README' % (package, package_cygwin_version))
2309         env.InstallAs(Cygwin_README,
2310             os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2311         Alias('install', Cygwin_README)
2312         # also a directory /usr/share/doc/lyx for README etc
2313         Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2314         env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2315             ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2316         Alias('install', Cygwin_Doc)
2317         # cygwin fonts also need to be installed
2318         Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2319         env.Install(Cygwin_fonts,
2320             [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2321                   for file in win32_bakoma_fonts])
2322         Alias('install', Cygwin_fonts)
2323         # we also need a post installation script
2324         tmp_script = utils.installCygwinPostinstallScript('/tmp')
2325         postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2326         env.Install(postinstall_path, tmp_script)
2327         Alias('install', postinstall_path)
2328
2329
2330     # man
2331     env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2332         env.subst('$TOP_SRCDIR/lyx.man'))
2333     env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2334         env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2335     env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2336         env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2337     Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2338         x in ['lyx', 'tex2lyx', 'lyxclient']])
2339     # locale files?
2340     # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2341     for gmo in gmo_files:
2342         lan = os.path.split(str(gmo))[1].split('.')[0]
2343         dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2344         env.InstallAs(dest_file, gmo)
2345         Alias('install', dest_file)
2346
2347
2348 if build_installer:
2349     #
2350     # build windows installer using NSIS
2351     #
2352     # NOTE:
2353     # There is a nsis builder on scons wiki but it does not work with
2354     # our lyx.nsi because it does not dig through all the include directives
2355     # and find the dependencies automatically. Also, it can not parse
2356     # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2357     # something rely on date.
2358     # Because of this, I am doing a simple nsis builder here.
2359     if platform_name != 'win32':
2360         print 'installer target is only available for windows platform'
2361         Exit(1)
2362     if mode != 'release':
2363         print 'installer has to be built in release mode (use option mode=release)'
2364         Exit(1)
2365     installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2366             % x for x in development_Win32_packaging_installer] + \
2367         ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2368             % x for x in development_Win32_packaging_installer_components] + \
2369         ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2370             % x for x in development_Win32_packaging_installer_dialogs] + \
2371         ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2372             % x for x in development_Win32_packaging_installer_graphics] + \
2373         ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2374             % x for x in development_Win32_packaging_installer_include] + \
2375         ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2376             % x for x in development_Win32_packaging_installer_lang]
2377     if env.has_key('NSIS') and env['NSIS'] is not None:
2378         # create a builder to strip and install
2379         env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2380     else:
2381         print 'No nsis compiler is found. Existing...'
2382         Exit(2)
2383     if not env.has_key('win_installer') or env['win_installer'] is None:
2384         if devel_version:
2385             env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2386         else:
2387             env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2388     # provide default setting
2389     if not env.has_key('deps_dir') or env['deps_dir'] is None:
2390         env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2391     if not os.path.isdir(env.Dir('$deps_dir').abspath):
2392         print 'Development dependency package is not found.'
2393         Exit(1)
2394     else:
2395         env['deps_dir'] = env.Dir('$deps_dir').abspath
2396     # build bundle?
2397     if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2398         env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2399     elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2400         env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2401     else:
2402         env['bundle_dir'] = None
2403     # if absolute path is given, use it, otherwise, write to current directory
2404     if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2405         env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2406     env.Append(NSISDEFINES={
2407         'ExeFile':env['win_installer'],
2408         'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2409         'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2410         'FilesDeps':env['deps_dir'],
2411         'FilesBundle':env['bundle_dir'],
2412         })
2413     installer = env.installer(env['win_installer'],
2414         '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2415     # since I can not use a scanner, explicit dependent is required
2416     env.Depends(installer, 'install')
2417     env.Depends(installer, installer_files)
2418     env.Alias('installer', installer)
2419     # also generate bundle?
2420     if env.has_key('bundle') and env['bundle']:
2421         if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2422             print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2423             print 'Use bundle_dir option to specify'
2424             Exit(1)
2425         # generator of the builder will add bundle stuff depending on output name
2426         bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2427             '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2428         env.Depends(bundle_installer, 'install')
2429         env.Depends(bundle_installer, installer_files)
2430         env.Alias('installer', bundle_installer)
2431
2432 Default('lyx')
2433 Alias('all', ['lyx', 'client', 'tex2lyx'])