development/scons/SConstruct

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