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