development/scons/SConstruct

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