1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 # This is a scons based building system for lyx, please refer
12 # to INSTALL.scons for detailed instructions.
15 import os, sys, copy, cPickle, glob, time
17 # determine where I am ...
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
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]
31 sys.path.extend([scons_absdir, os.path.join(top_src_dir, 'lib', 'doc')])
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 *
39 #----------------------------------------------------------
40 # Required runtime environment
41 #----------------------------------------------------------
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."
55 #----------------------------------------------------------
57 #----------------------------------------------------------
59 # some global settings
61 # get version number from configure.ac so that JMarc does
62 # not have to change SConstruct during lyx release
63 package_version = utils.getVerFromConfigure(top_src_dir)
64 package_cygwin_version = '%s-1' % package_version
65 boost_version = ['1_34']
67 if 'svn' in package_version:
69 default_build_mode = 'debug'
72 default_build_mode = 'release'
75 package_bugreport = 'lyx-devel@lists.lyx.org'
77 package_tarname = 'lyx'
78 package_string = '%s %s' % (package_name, package_version)
80 # various cache/log files
81 default_log_file = 'scons_lyx.log'
82 opt_cache_file = 'opt.cache'
85 #----------------------------------------------------------
86 # platform dependent settings
87 #----------------------------------------------------------
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'
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?
108 default_with_x = False
109 default_packaging_method = 'macosx'
110 else: # unsupported system, assume posix behavior
111 platform_name = 'others'
113 default_with_x = True
114 default_packaging_method = 'posix'
116 #---------------------------------------------------------
118 #----------------------------------------------------------
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()
125 opts = Options(['config.py'])
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') ),
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
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
150 EnumOption('spell', 'Choose spell checker to use.', 'auto',
151 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
153 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
154 allowed_values = ('windows', 'posix', 'macosx')),
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),
165 BoolOption('nls', 'Whether or not use native language support', True),
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),
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),
175 PathOption('qt_dir', 'Path to qt directory', None),
177 PathOption('qt_inc_path', 'Path to qt include directory', None),
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),
183 PathOption('extra_lib_path', 'Extra library path', None),
185 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
187 PathOption('extra_inc_path1', 'Extra include path', None),
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),
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'),
216 ('optimization', 'optimization CCFLAGS option.', None),
218 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
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),
236 all_options = [x.key for x in opts.options]
238 # copied from SCons/Options/BoolOption.py
239 # We need to use them before a boolean ARGUMENTS option is available
241 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
242 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
244 if ARGUMENTS.has_key('fast_start'):
245 print 'fast_start option is obsolete'
247 # if load_option=yes (default), load saved comand line options
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)
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):
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
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):
279 # if opt1,opt2 is specified, only load specified options
281 args = ARGUMENTS['load_option'].split(',')
282 for arg in opt_cache.keys():
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])
292 # check if there is unused (or misspelled) argument
293 for arg in ARGUMENTS.keys():
294 if arg not in all_options:
296 print "Unknown option '%s'... exiting." % arg
298 print "Available options are (check 'scons -help' for details):"
299 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
303 cache_file = open(opt_cache_file, 'w')
304 cPickle.dump(ARGUMENTS, cache_file)
307 #---------------------------------------------------------
308 # Setting up environment
309 #---------------------------------------------------------
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)
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')
322 # for simplicity, use var instead of env[var]
323 frontend = env['frontend']
324 prefix = env['prefix']
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?"
333 elif WhereIs('cl.exe') is not None:
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']):
347 os.makedirs(env['build_dir'])
350 if not os.path.isdir(env['build_dir']):
351 print 'Can not create directory', env['build_dir']
353 env['BUILDDIR'] = env['build_dir']
355 # Determine the name of the build $mode
356 env['BUILDDIR'] = '#' + mode
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'])
364 # Here is a summary of variables defined in env
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
375 # PACKAGE_VERSION, LYX_DATE, VERSION_INFO
377 # full path name is used to build msvs project files
378 # and to replace TOP_SRCDIR in package.C
379 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
380 # needed by src/version.cpp.in => src/version.cpp
381 env['PACKAGE_VERSION'] = package_version
382 env['LYX_DATE'] = time.asctime()
384 # determine share_dir etc
385 packaging_method = env.get('packaging')
386 if packaging_method == 'windows':
387 share_dir = 'Resources'
388 man_dir = 'Resources/man/man1'
389 locale_dir = 'Resources/locale'
391 share_dir = 'share/lyx'
392 locale_dir = 'share/locale'
393 if platform_name == 'cygwin':
394 man_dir = 'share/man/man1'
398 # program suffix: can be yes, or a string
399 if env.has_key('version_suffix'):
400 if env['version_suffix'] in true_strings:
401 program_suffix = package_version
402 elif env['version_suffix'] in false_strings:
405 program_suffix = env['version_suffix']
408 # used by Package.cpp.in
409 env['PROGRAM_SUFFIX'] = program_suffix
411 # whether or not add suffix to file and directory names
412 add_suffix = packaging_method != 'windows'
413 # LYX_DIR are different (used in Package.cpp.in)
415 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
417 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
418 # we need absolute path for package.C
419 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
422 #---------------------------------------------------------
423 # Setting building environment (Tools, compiler flags etc)
424 #---------------------------------------------------------
426 # Since Tool('mingw') will reset CCFLAGS etc, this should be
427 # done before getEnvVariable
428 if platform_name == 'win32':
434 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
435 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
437 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
440 # we differentiate between hard-coded options and default options
441 # hard-coded options are required and will always be there
442 # default options can be replaced by enviromental variables or command line options
443 CCFLAGS_required = []
444 LINKFLAGS_required = []
447 # under windows, scons is confused by .C/.c and uses gcc instead of
448 # g++. I am forcing the use of g++ here. This is expected to change
449 # after lyx renames all .C files to .cpp
451 # save the old c compiler and CCFLAGS (used by libintl)
452 C_COMPILER = env.subst('$CC')
453 C_CCFLAGS = env.subst('$CCFLAGS').split()
454 # if we use ms vc, the commands are fine (cl.exe and link.exe)
456 # /TP treat all source code as C++
457 # C4819: The file contains a character that cannot be represented
458 # in the current code page (number)
459 # C4996: foo was decleared deprecated
460 CCFLAGS_required.extend(['/TP', '/EHsc'])
462 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
463 # the flags are also needed in C mode (for intl lib)
464 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
466 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
467 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
469 if env.has_key('CXX') and env['CXX']:
470 env['CC'] = env.subst('$CXX')
471 env['LINK'] = env.subst('$CXX')
476 # for debug/release mode
477 if env.has_key('optimization') and env['optimization'] is not None:
478 # if user supplies optimization flags, use it anyway
479 CCFLAGS_required.extend(env['optimization'].split())
480 # and do not use default
481 set_default_optimization_flags = False
483 set_default_optimization_flags = True
487 CCFLAGS_required.append('/Zi')
488 LINKFLAGS_required.extend(['/debug', '/map'])
490 CCFLAGS_required.append('-g')
491 CCFLAGS_default.append('-O')
492 elif mode == 'release' and set_default_optimization_flags:
494 CCFLAGS_default.append('/O2')
496 CCFLAGS_default.append('-O2')
498 # msvc uses separate tools for profiling
499 if env.has_key('profiling') and env['profiling']:
501 print 'Visual C++ does not use profiling options'
503 CCFLAGS_required.append('-pg')
504 LINKFLAGS_required.append('-pg')
506 if env.has_key('warnings') and env['warnings']:
508 CCFLAGS_default.append('/W2')
510 # Note: autotools detect gxx version and pass -W for 3.x
511 # and -Wextra for other versions of gcc
512 CCFLAGS_default.append('-Wall')
514 # Now, set the variables as follows:
515 # 1. if command line option exists: replace default
516 # 2. then if s envronment variable exists: replace default
517 # 3. set variable to required + default
518 def setEnvVariable(env, name, required = None, default = None, split = True):
519 ''' env: environment to set variable
521 required: hardcoded options
522 default: default options that can be replaced by command line or
523 environment variables
524 split: whether or not split obtained variable like '-02 -g'
526 # 1. ARGUMENTS is already set to env[name], override default.
527 if ARGUMENTS.has_key(name):
528 # env[name] may be rewritten when building tools are reloaded
529 # if that is the case, commandline option will override it.
530 env[name] = ARGUMENTS[name]
532 # then use environment default
533 elif os.environ.has_key(name):
534 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
535 default = os.environ[name]
537 default = default.split()
538 # the real value should be env[name] + default + required
541 if env.has_key(name):
542 value = str(env[name]).split()
543 if required is not None:
545 if default is not None:
549 if env.has_key(name):
550 value = str(env[name])
551 if required is not None:
552 value += " " + required
553 if default is not None:
554 value += " " + default
556 # print name, env[name]
558 setEnvVariable(env, 'DESTDIR', split=False)
559 setEnvVariable(env, 'CC')
560 setEnvVariable(env, 'LINK')
561 setEnvVariable(env, 'CPP')
562 setEnvVariable(env, 'CXX')
563 setEnvVariable(env, 'CXXCPP')
564 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
565 setEnvVariable(env, 'CXXFLAGS')
566 setEnvVariable(env, 'CPPFLAGS')
567 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
569 # if DESTDIR is not set...
570 if env.has_key('dest_dir'):
571 print "This option is obsolete. Please use DESTDIR instead."
572 env['DESTDIR'] = env['dest_dir']
575 # extra_inc_path and extra_lib_path
578 if env.has_key('extra_inc_path') and env['extra_inc_path']:
579 extra_inc_paths.append(env['extra_inc_path'])
580 if env.has_key('extra_lib_path') and env['extra_lib_path']:
581 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
582 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
583 extra_inc_paths.append(env['extra_inc_path1'])
584 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
585 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
586 if env.has_key('extra_bin_path') and env['extra_bin_path']:
587 # only the first one is needed (a scons bug?)
588 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
589 env.PrependENVPath('PATH', env['extra_bin_path'])
590 # extra_inc_paths will be used later by intlenv etc
591 env.AppendUnique(CPPPATH = extra_inc_paths)
594 #----------------------------------------------------------
596 #----------------------------------------------------------
598 conf = Configure(env,
600 'CheckPkgConfig' : utils.checkPkgConfig,
601 'CheckPackage' : utils.checkPackage,
602 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
603 'CheckSelectArgType' : utils.checkSelectArgType,
604 'CheckBoostLibraries' : utils.checkBoostLibraries,
605 'CheckCommand' : utils.checkCommand,
606 'CheckNSIS' : utils.checkNSIS,
607 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
608 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
609 'CheckIconvConst' : utils.checkIconvConst,
610 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
611 'CheckDeclaration' : utils.checkDeclaration,
615 # When using msvc, windows.h is required
616 if use_vc and not conf.CheckCHeader('windows.h'):
617 print 'Windows.h is not found. Please install Windows Platform SDK.'
618 print 'Please check config.log for more information.'
621 # pkg-config? (if not, we use hard-coded options)
622 if conf.CheckPkgConfig('0.15.0'):
623 env['HAS_PKG_CONFIG'] = True
625 print 'pkg-config >= 0.1.50 is not found'
626 env['HAS_PKG_CONFIG'] = False
628 # zlib? This is required.
629 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
630 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
631 print 'Did not find zdll.lib or zlib.h, exiting!'
632 print 'Please check config.log for more information.'
634 if conf.CheckLib('iconv'):
635 env['ICONV_LIB'] = 'iconv'
636 elif conf.CheckLib('libiconv'):
637 env['ICONV_LIB'] = 'libiconv'
638 elif conf.CheckFunc('iconv_open'):
639 env['ICONV_LIB'] = None
641 print 'Did not find iconv or libiconv, exiting!'
642 print 'Please check config.log for more information.'
647 if conf.CheckLib('socket'):
648 socket_libs.append('socket')
649 # nsl is the network services library and provides a
650 # transport-level interface to networking services.
651 if conf.CheckLib('nsl'):
652 socket_libs.append('nsl')
654 # check available boost libs (since lyx1.4 does not use iostream)
656 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
657 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
658 boost_libs.append(lib)
660 # check boost libraries
661 boost_opt = ARGUMENTS.get('boost', 'auto')
662 # check for system boost
663 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
664 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
665 # default to $BUILDDIR/libs (use None since this path will be added anyway)
667 # here I assume that all libraries are in the same directory
668 if boost_opt == 'included':
669 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
670 included_boost = True
671 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
672 elif boost_opt == 'auto':
673 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
674 # if not found, use local boost
676 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
677 included_boost = True
678 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
680 included_boost = False
681 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
682 elif boost_opt == 'system':
683 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
685 print "Can not find system boost libraries with version %s " % boost_version
686 print "Please supply a path through extra_lib_path and try again."
687 print "Or use boost=included to use included boost libraries."
690 included_boost = False
691 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
694 if boost_libpath is not None:
695 env.AppendUnique(LIBPATH = [boost_libpath])
698 env['ENABLE_NLS'] = env['nls']
700 if not env['ENABLE_NLS']:
702 included_gettext = False
704 # check gettext libraries
705 gettext_opt = ARGUMENTS.get('gettext', 'auto')
706 # check for system gettext
708 if gettext_opt in ['auto', 'system']:
709 if conf.CheckFunc('gettext'):
710 included_gettext = False
713 elif conf.CheckLib('intl'):
714 included_gettext = False
718 if gettext_opt == 'system':
719 print "Can not find system gettext library"
720 print "Please supply a path through extra_lib_path and try again."
721 print "Or use gettext=included to use included gettext libraries."
723 # now, auto and succ = false, or gettext=included
725 # we do not need to set LIBPATH now.
726 included_gettext = True
727 intl_libs = ['included_intl']
731 # check for msgfmt command
732 env['MSGFMT'] = conf.CheckCommand('msgfmt')
733 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
734 env['XGETTEXT'] = conf.CheckCommand('xgettext')
735 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
737 # if under windows, check the nsis compiler
738 if platform_name == 'win32':
739 env['NSIS'] = conf.CheckNSIS()
741 # cygwin packaging requires the binaries to be stripped
742 if platform_name == 'cygwin':
743 env['STRIP'] = conf.CheckCommand('strip')
746 # Customized builders
748 # install customized builders
749 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
750 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
751 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
754 #----------------------------------------------------------
755 # Generating config.h
756 #----------------------------------------------------------
757 aspell_lib = 'aspell'
758 # assume that we use aspell, aspelld compiled for msvc
759 if platform_name == 'win32' and mode == 'debug' and use_vc:
760 aspell_lib = 'aspelld'
762 # check the existence of config.h
763 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
764 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
766 print "Creating %s..." % boost_config_h
768 utils.createConfigFile(conf,
769 config_file = boost_config_h,
770 config_pre = '''/* boost/config.h. Generated by SCons. */
775 * This file is part of LyX, the document processor.
776 * Licence details can be found in the file COPYING.
778 * This is the compilation configuration file for LyX.
779 * It was generated by scon.
780 * You might want to change some of the defaults if something goes wrong
781 * during the compilation.
784 #ifndef _BOOST_CONFIG_H
785 #define _BOOST_CONFIG_H
788 ('ostream', 'HAVE_OSTREAM', 'cxx'),
789 ('locale', 'HAVE_LOCALE', 'cxx'),
790 ('sstream', 'HAVE_SSTREAM', 'cxx'),
791 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
794 (env.has_key('assertions') and env['assertions'],
796 'Define if you want assertions to be enabled in the code'
800 ('wchar_t', 'HAVE_WCHAR_T', None),
804 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
805 # define USE_BOOST_FORMAT 1
807 # define USE_BOOST_FORMAT 0
810 #if !defined(ENABLE_ASSERTIONS)
811 # define BOOST_DISABLE_ASSERTS 1
813 #define BOOST_ENABLE_ASSERT_HANDLER 1
815 #define BOOST_DISABLE_THREADS 1
816 #define BOOST_NO_WSTRING 1
819 # define BOOST_POSIX 1
820 # define BOOST_POSIX_API 1
821 # define BOOST_POSIX_PATH 1
824 #define BOOST_ALL_NO_LIB 1
826 #if defined(HAVE_NEWAPIS_H)
827 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
831 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
832 * support compiled in:
833 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
834 * And we are not interested at all what libc
835 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
836 * has the needed wchar_t support and uses UCS4. Whether it
837 * implements this with the help of libc, or whether it has own code
838 * does not matter for us, because we don't use libc directly (Georg)
840 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
848 print "\nGenerating %s..." % config_h
850 # AIKSAURUS_H_LOCATION
851 if (conf.CheckCXXHeader("Aiksaurus.h")):
852 aik_location = '<Aiksaurus.h>'
853 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
854 aik_location = '<Aiksaurus/Aiksaurus.h>'
858 # determine headers to use
859 spell_opt = ARGUMENTS.get('spell', 'auto')
860 env['USE_ASPELL'] = False
861 env['USE_PSPELL'] = False
862 env['USE_ISPELL'] = False
863 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
864 spell_engine = 'USE_ASPELL'
865 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
866 spell_engine = 'USE_PSPELL'
867 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
868 spell_engine = 'USE_ISPELL'
872 if spell_engine is not None:
873 env[spell_engine] = True
875 if spell_opt == 'auto':
876 print "Warning: Can not locate any spell checker"
877 elif spell_opt != 'no':
878 print "Warning: Can not locate specified spell checker:", spell_opt
879 print 'Please check config.log for more information.'
882 # check arg types of select function
883 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
885 # check the size of wchar_t
886 sizeof_wchar_t = conf.CheckSizeOfWChar()
888 if sizeof_wchar_t == 0:
889 print 'Error: Can not determine the size of wchar_t.'
890 print 'Please check config.log for more information.'
895 result = utils.createConfigFile(conf,
896 config_file = config_h,
897 config_pre = '''/* config.h. Generated by SCons. */
902 * This file is part of LyX, the document processor.
903 * Licence details can be found in the file COPYING.
905 * This is the compilation configuration file for LyX.
906 * It was generated by scon.
907 * You might want to change some of the defaults if something goes wrong
908 * during the compilation.
915 ('io.h', 'HAVE_IO_H', 'c'),
916 ('limits.h', 'HAVE_LIMITS_H', 'c'),
917 ('locale.h', 'HAVE_LOCALE_H', 'c'),
918 ('process.h', 'HAVE_PROCESS_H', 'c'),
919 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
920 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
921 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
922 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
923 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
924 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
925 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
926 ('utime.h', 'HAVE_UTIME_H', 'c'),
927 ('direct.h', 'HAVE_DIRECT_H', 'c'),
928 ('istream', 'HAVE_ISTREAM', 'cxx'),
929 ('ios', 'HAVE_IOS', 'cxx'),
932 ('open', 'HAVE_OPEN', None),
933 ('chmod', 'HAVE_CHMOD', None),
934 ('close', 'HAVE_CLOSE', None),
935 ('popen', 'HAVE_POPEN', None),
936 ('pclose', 'HAVE_PCLOSE', None),
937 ('_open', 'HAVE__OPEN', None),
938 ('_close', 'HAVE__CLOSE', None),
939 ('_popen', 'HAVE__POPEN', None),
940 ('_pclose', 'HAVE__PCLOSE', None),
941 ('getpid', 'HAVE_GETPID', None),
942 ('_getpid', 'HAVE__GETPID', None),
943 ('mkdir', 'HAVE_MKDIR', None),
944 ('_mkdir', 'HAVE__MKDIR', None),
945 ('mktemp', 'HAVE_MKTEMP', None),
946 ('mkstemp', 'HAVE_MKSTEMP', None),
947 ('strerror', 'HAVE_STRERROR', None),
948 ('getcwd', 'HAVE_GETCWD', None),
949 ('setenv', 'HAVE_SETENV', None),
950 ('putenv', 'HAVE_PUTENV', None),
951 ('fcntl', 'HAVE_FCNTL', None),
952 ('mkfifo', 'HAVE_MKFIFO', None),
955 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
958 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
959 '#include <streambuf>\n#include <istream>'),
960 ('wchar_t', 'HAVE_WCHAR_T', None),
961 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
964 ('gdi32', 'HAVE_LIBGDI32'),
965 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
968 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
970 'Define is sys/types.h does not have pid_t',
974 (conf.CheckCXXGlobalCstd(),
976 'Define if your C++ compiler puts C library functions in the global namespace'
978 (conf.CheckMkdirOneArg(),
979 'MKDIR_TAKES_ONE_ARG',
980 'Define if mkdir takes only one argument.'
982 (conf.CheckIconvConst(),
984 'Define as const if the declaration of iconv() needs const.',
985 '#define ICONV_CONST const',
986 '#define ICONV_CONST',
988 (conf.CheckLC_MESSAGES(),
990 'Define if your <locale.h> file defines LC_MESSAGES.'
992 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
995 "Define to 1 if translation of program messages to the user's native anguage is requested.",
997 (env['nls'] and not included_gettext,
999 'Define to 1 if using system gettext library'
1001 (env.has_key('concept_checks') and env['concept_checks'],
1002 '_GLIBCXX_CONCEPT_CHECKS',
1003 'libstdc++ concept checking'
1005 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1007 'libstdc++ debug mode'
1009 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1010 '_GLIBCXX_DEBUG_PEDANTIC',
1011 'libstdc++ pedantic debug mode'
1013 (os.name != 'nt', 'BOOST_POSIX',
1014 'Indicates to boost < 1.34 which API to use (posix or windows).'
1016 (os.name != 'nt', 'BOOST_POSIX_API',
1017 'Indicates to boost 1.34 which API to use (posix or windows).'
1019 (os.name != 'nt', 'BOOST_POSIX_PATH',
1020 'Indicates to boost 1.34 which path style to use (posix or windows).'
1022 (spell_engine is not None, spell_engine,
1023 'Spell engine to use'
1025 # we need to know the byte order for unicode conversions
1026 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1027 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1031 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1033 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1034 'Define to the address where bug reports for this package should be sent.'),
1035 ('#define PACKAGE_NAME "%s"' % package_name,
1036 'Define to the full name of this package.'),
1037 ('#define PACKAGE_STRING "%s"' % package_string,
1038 'Define to the full name and version of this package.'),
1039 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1040 'Define to the one symbol short name of this package.'),
1041 ('#define PACKAGE_VERSION "%s"' % package_version,
1042 'Define to the version of this package.'),
1043 ('#define BOOST_ALL_NO_LIB 1',
1044 'disable automatic linking of boost libraries.'),
1045 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1046 'Packaging method'),
1047 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1048 'Aiksaurus include file'),
1049 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1050 "Define to the type of arg 1 for `select'."),
1051 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1052 "Define to the type of arg 2, 3, 4 for `select'."),
1053 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1054 "Define to the type of arg 5 for `select'."),
1055 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1056 'Define to be the size of type wchar_t'),
1058 config_post = '''/************************************************************
1059 ** You should not need to change anything beyond this point */
1061 #ifndef HAVE_STRERROR
1062 #if defined(__cplusplus)
1065 char * strerror(int n);
1068 #include <../boost/config.h>
1074 # these keys are needed in env
1075 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1076 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1077 # USE_ASPELL etc does not go through result
1078 if result.has_key(key):
1079 env[key] = result[key]
1082 # if nls=yes and gettext=included, create intl/config.h
1083 # intl/libintl.h etc
1085 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1086 if env['nls'] and included_gettext:
1088 print "Creating %s..." % intl_config_h
1090 # create intl/config.h
1091 result = utils.createConfigFile(conf,
1092 config_file = intl_config_h,
1093 config_pre = '''/* intl/config.h. Generated by SCons. */
1098 * This file is part of LyX, the document processor.
1099 * Licence details can be found in the file COPYING.
1101 * This is the compilation configuration file for LyX.
1102 * It was generated by scon.
1103 * You might want to change some of the defaults if something goes wrong
1104 * during the compilation.
1111 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1112 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1113 ('string.h', 'HAVE_STRING_H', 'c'),
1114 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1115 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1116 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1117 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1118 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1119 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1120 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1123 ('getcwd', 'HAVE_GETCWD', None),
1124 ('stpcpy', 'HAVE_STPCPY', None),
1125 ('strcasecmp', 'HAVE_STRCASECMP', None),
1126 ('strdup', 'HAVE_STRDUP', None),
1127 ('strtoul', 'HAVE_STRTOUL', None),
1128 ('alloca', 'HAVE_ALLOCA', None),
1129 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1130 ('mempcpy', 'HAVE_MEMPCPY', None),
1131 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1132 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1133 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1134 ('setlocale', 'HAVE_SETLOCALE', None),
1135 ('tsearch', 'HAVE_TSEARCH', None),
1136 ('getegid', 'HAVE_GETEGID', None),
1137 ('getgid', 'HAVE_GETGID', None),
1138 ('getuid', 'HAVE_GETUID', None),
1139 ('wcslen', 'HAVE_WCSLEN', None),
1140 ('asprintf', 'HAVE_ASPRINTF', None),
1141 ('wprintf', 'HAVE_WPRINTF', None),
1142 ('snprintf', 'HAVE_SNPRINTF', None),
1143 ('printf', 'HAVE_POSIX_PRINTF', None),
1144 ('fcntl', 'HAVE_FCNTL', None),
1147 ('intmax_t', 'HAVE_INTMAX_T', None),
1148 ('long double', 'HAVE_LONG_DOUBLE', None),
1149 ('long long', 'HAVE_LONG_LONG', None),
1150 ('wchar_t', 'HAVE_WCHAR_T', None),
1151 ('wint_t', 'HAVE_WINT_T', None),
1152 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1153 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1159 (conf.CheckLC_MESSAGES(),
1161 'Define if your <locale.h> file defines LC_MESSAGES.'
1163 (conf.CheckIconvConst(),
1165 'Define as const if the declaration of iconv() needs const.',
1166 '#define ICONV_CONST const',
1167 '#define ICONV_CONST',
1169 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1170 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1172 "Define to 1 if you have the `intmax_t' type."
1174 (env.has_key('nls') and env['nls'],
1176 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1180 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1181 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1182 'Define to be the size of type wchar_t'),
1184 config_post = '#endif'
1187 # these keys are needed in env
1188 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1189 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1190 # USE_ASPELL etc does not go through result
1191 if result.has_key(key):
1192 env[key] = result[key]
1195 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1196 if env['nls'] and included_gettext:
1197 # libgnuintl.h.in => libintl.h
1198 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1199 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1200 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1201 [Copy('$TARGET', '$SOURCE')])
1204 # Finish auto-configuration
1207 #----------------------------------------------------------
1208 # Now set up our build process accordingly
1209 #----------------------------------------------------------
1211 if env['ICONV_LIB'] is None:
1214 system_libs = [env['ICONV_LIB']]
1215 if platform_name in ['win32', 'cygwin']:
1216 # the final link step needs stdc++ to succeed under mingw
1217 # FIXME: shouldn't g++ automatically link to stdc++?
1219 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1221 system_libs += ['shlwapi', 'stdc++', 'z']
1222 elif platform_name == 'cygwin' and env['X11']:
1223 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1224 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1225 'resolv', 'pthread', 'z']
1227 system_libs += ['z']
1230 ('HAVE_LIBGDI32', 'gdi32'),
1231 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1232 ('USE_ASPELL', aspell_lib),
1233 ('USE_ISPELL', 'ispell'),
1234 ('USE_PSPELL', 'pspell'),
1239 system_libs.append(lib[1])
1242 # Build parameters CPPPATH etc
1245 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1248 # boost: for boost header files
1249 # BUILDDIR/common: for config.h
1250 # TOP_SRCDIR/src: for support/* etc
1252 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1254 # Separating boost directories from CPPPATH stops scons from building
1255 # the dependency tree for boost header files, and effectively reduce
1256 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1257 # boost headers, this is only done for system boost headers.
1259 env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1262 env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1264 env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1266 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1267 if env['nls'] and included_gettext:
1268 env['CPPPATH'].append('$BUILDDIR/intl')
1272 # A Link script for cygwin see
1273 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1274 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1277 if platform_name == 'cygwin':
1278 ld_script_path = '/tmp'
1279 ld_script = utils.installCygwinLDScript(ld_script_path)
1280 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1281 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1284 #---------------------------------------------------------
1285 # Frontend related variables (QTDIR etc)
1286 #---------------------------------------------------------
1289 # create a separate environment so that other files do not have
1290 # to be built with all the include directories etc
1292 if frontend == 'qt4':
1293 frontend_env = env.Copy()
1295 # handle qt related user specified paths
1296 # set environment so that moc etc can be found even if its path is not set properly
1297 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1298 frontend_env['QTDIR'] = frontend_env['qt_dir']
1299 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1300 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1301 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1302 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1303 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1305 # if separate qt_lib_path is given
1306 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1307 qt_lib_path = frontend_env.subst('$qt_lib_path')
1308 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1309 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1313 # if separate qt_inc_path is given
1314 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1315 qt_inc_path = frontend_env['qt_inc_path']
1319 # local qt4 toolset from
1320 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1322 # NOTE: I have to patch qt4.py since it does not automatically
1323 # process .C file!!! (add to cxx_suffixes )
1325 frontend_env.Tool('qt4', [scons_dir])
1326 frontend_env['QT_AUTOSCAN'] = 0
1327 frontend_env['QT4_AUTOSCAN'] = 0
1328 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1330 if qt_lib_path is None:
1331 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1332 if qt_inc_path is None:
1333 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1336 conf = Configure(frontend_env,
1338 'CheckPackage' : utils.checkPackage,
1339 'CheckCommand' : utils.checkCommand,
1344 # first: try pkg_config
1345 if frontend_env['HAS_PKG_CONFIG']:
1346 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1347 # FIXME: use pkg_config information?
1348 #frontend_env['QT4_PKG_CONFIG'] = succ
1349 # second: try to link to it
1351 # Under linux, I can test the following perfectly
1352 # Under windows, lib names need to passed as libXXX4.a ...
1353 if platform_name == 'win32':
1354 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1356 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1357 # still can not find it
1359 print 'Did not find qt libraries, exiting!'
1360 print 'Please check config.log for more information.'
1363 # Now, determine the correct suffix:
1364 qt_libs = ['QtCore', 'QtGui']
1365 if platform_name == 'win32':
1366 if mode == 'debug' and use_vc and \
1367 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1368 qt_lib_suffix = 'd4'
1369 use_qt_debug_libs = True
1372 use_qt_debug_libs = False
1374 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1375 qt_lib_suffix = '_debug'
1376 use_qt_debug_libs = True
1379 use_qt_debug_libs = False
1380 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1381 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1382 qtcore_lib = ['QtCore' + qt_lib_suffix]
1384 # check uic and moc commands for qt frontends
1385 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1386 print 'uic or moc command is not found for frontend', frontend
1389 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1390 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1391 # For some unknown changes in msvc or qt, this is no longer needed.
1393 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1394 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1395 env.File('$BUILDDIR/lyx.exe.manifest').path]
1397 frontend_env = conf.Finish()
1402 # fill in the version info
1403 env['VERSION_INFO'] = '''Configuration
1405 Special build flags: %s
1407 C Compiler flags: %s %s
1409 C++ Compiler LyX flags: %s
1410 C++ Compiler flags: %s %s
1412 Linker user flags: %s
1414 Builing directory: %s
1415 Local library directory: %s
1418 Frontend libraries: %s
1419 System libraries: %s
1420 include search path: %s
1426 ''' % (platform_name,
1427 env.subst('$CCFLAGS'), env.subst('$CC'),
1428 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1429 env.subst('$CXX'), env.subst('$CXXFLAGS'),
1430 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1431 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1432 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1433 str(env['LIBPATH']), str(boost_libraries),
1434 str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1435 frontend, packaging_method,
1436 prefix, env['LYX_DIR'])
1438 if frontend in ['qt4']:
1439 env['VERSION_INFO'] += ''' include dir: %s
1442 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1444 print env['VERSION_INFO']
1447 # Mingw command line may be too short for our link usage,
1448 # Here we use a trick from scons wiki
1449 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1451 # I also would like to add logging (commands only) capacity to the
1453 logfile = env.get('logfile', default_log_file)
1454 if logfile != '' or platform_name == 'win32':
1456 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1457 info = '''# This is a log of commands used by scons to build lyx
1461 ''' % (time.asctime(), ' '.join(sys.argv),
1462 env['VERSION_INFO'].replace('\n','\n# ')) )
1467 # -h will print out help info
1468 Help(opts.GenerateHelpText(env))
1472 #----------------------------------------------------------
1474 #----------------------------------------------------------
1475 # this has been the source of problems on some platforms...
1476 # I find that I need to supply it with full path name
1477 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1478 # this usage needs further investigation.
1479 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1481 print "Building all targets recursively"
1483 if env.has_key('rebuild'):
1484 rebuild_targets = env['rebuild'].split(',')
1485 if 'none' in rebuild_targets or 'no' in rebuild_targets:
1486 rebuild_targets = []
1487 elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1488 # None: let scons decide which components to build
1489 # Forcing all components to be rebuilt is in theory not necessary
1490 rebuild_targets = None
1492 rebuild_targets = None
1494 def libExists(libname):
1495 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1496 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1498 def appExists(apppath, appname):
1499 ''' Check whether or not application already exists'''
1500 return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1502 targets = BUILD_TARGETS
1503 build_install = 'install' in targets or 'installer' in targets
1504 build_installer = 'installer' in targets
1505 # msvc need to pass full target name, so I have to look for path/lyx etc
1506 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1507 or build_install or 'all' in targets
1508 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1509 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1510 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1511 build_mathed = build_lyx or 'mathed' in targets
1512 build_insets = build_lyx or 'insets' in targets
1513 build_frontends = build_lyx or 'frontends' in targets
1514 build_graphics = build_lyx or 'graphics' in targets
1515 build_controllers = build_lyx or 'controllers' in targets
1516 build_client = True in ['client' in x for x in targets] \
1517 or build_install or 'all' in targets or build_installer
1518 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1519 or build_install or 'all' in targets or build_installer
1520 build_lyxbase = build_lyx or 'lyxbase' in targets
1521 update_po = 'update_po' in targets
1522 update_manifest = 'update_manifest' in targets
1523 build_po = 'po' in targets or build_install or 'all' in targets
1524 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1525 build_msvs_projects = use_vc and 'msvs_projects' in targets
1528 # now, if rebuild_targets is specified, do not rebuild some targets
1529 if rebuild_targets is not None:
1531 def ifBuildLib(name, libname, old_value):
1532 # explicitly asked to rebuild
1533 if name in rebuild_targets:
1535 # else if not rebuild, and if the library already exists
1536 elif libExists(libname):
1538 # do not change the original value
1541 build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1542 build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1543 build_support = ifBuildLib('support', 'support', build_support)
1544 build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1545 build_insets = ifBuildLib('insets', 'insets', build_insets)
1546 build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1547 build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1548 build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1549 build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1550 build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1552 def ifBuildApp(name, appname, old_value):
1553 # explicitly asked to rebuild
1554 if name in rebuild_targets:
1556 # else if not rebuild, and if the library already exists
1557 elif appExists(name, appname):
1559 # do not change the original value
1562 build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1563 build_client = ifBuildApp('client', 'lyxclient', build_client)
1565 # sync frontend and frontend (?)
1575 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1577 boostenv = env.Copy()
1579 # boost use its own config.h
1580 boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1581 boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1583 for lib in boost_libs:
1584 print 'Processing files in boost/libs/%s/src...' % lib
1585 boostlib = boostenv.StaticLibrary(
1586 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1587 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1589 Alias('boost', boostlib)
1596 intlenv = env.Copy()
1598 print "Processing files in intl..."
1600 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1602 # we need the original C compiler for these files
1603 intlenv['CC'] = C_COMPILER
1604 intlenv['CCFLAGS'] = C_CCFLAGS
1606 intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1607 # intl does not use global config.h
1608 intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1610 intlenv.Append(CCFLAGS = [
1611 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1612 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1613 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1615 '-DENABLE_RELOCATABLE=1',
1617 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1619 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1620 '-Drelocate=libintl_relocate',
1621 '-DDEPENDS_ON_LIBICONV=1',
1626 intl = intlenv.StaticLibrary(
1627 target = '$LOCALLIBPATH/included_intl',
1629 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1635 # Now, src code under src/
1637 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1644 print "Processing files in src/support..."
1646 frontend_env.Depends('$BUILDDIR/common/support/Package.cpp', '$BUILDDIR/common/config.h')
1647 Package_cpp = env.substFile('$BUILDDIR/common/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1649 support = frontend_env.StaticLibrary(
1650 target = '$LOCALLIBPATH/support',
1651 source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files] + Package_cpp,
1655 '-DQT_CLEAN_NAMESPACE',
1662 Alias('support', support)
1669 print "Processing files in src/mathed..."
1671 mathed = env.StaticLibrary(
1672 target = '$LOCALLIBPATH/mathed',
1673 source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1675 Alias('mathed', mathed)
1682 print "Processing files in src/insets..."
1684 insets = env.StaticLibrary(
1685 target = '$LOCALLIBPATH/insets',
1686 source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1688 Alias('insets', insets)
1695 print "Processing files in src/frontends..."
1697 frontends = env.StaticLibrary(
1698 target = '$LOCALLIBPATH/frontends',
1699 source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1701 Alias('frontends', frontends)
1708 print "Processing files in src/graphics..."
1710 graphics = env.StaticLibrary(
1711 target = '$LOCALLIBPATH/graphics',
1712 source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1714 Alias('graphics', graphics)
1717 if build_controllers:
1719 # src/frontends/controllers
1721 print "Processing files in src/frontends/controllers..."
1723 controllers = env.StaticLibrary(
1724 target = '$LOCALLIBPATH/controllers',
1725 source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1727 Alias('controllers', controllers)
1734 env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1736 print "Processing files in src/frontends/qt4..."
1739 # moc qt4_moc_files, the moced files are included in the original files
1741 qt4 = frontend_env.StaticLibrary(
1742 target = '$LOCALLIBPATH/qt4',
1743 source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1747 '$BUILDDIR/common/images',
1748 '$BUILDDIR/common/frontends',
1749 '$BUILDDIR/common/frontends/qt4',
1750 '$BUILDDIR/common/frontends/qt4/ui',
1751 '$BUILDDIR/common/frontends/controllers'
1756 '-DQT_CLEAN_NAMESPACE',
1769 frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1771 print "Processing files in src/client..."
1773 if env['HAVE_FCNTL']:
1774 client = frontend_env.Program(
1775 target = '$BUILDDIR/common/client/lyxclient',
1776 LIBS = ['support'] + intl_libs + system_libs +
1777 socket_libs + boost_libraries + qtcore_lib,
1778 source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1779 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1781 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1782 client, [Copy('$TARGET', '$SOURCE')]))
1785 Alias('client', client)
1787 if env['HAVE_FCNTL']:
1788 # define client even if lyxclient is not built with rebuild=no
1789 client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1798 print "Processing files in src/tex2lyx..."
1801 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1802 frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1803 [Copy('$TARGET', '$SOURCE')])
1805 tex2lyx = frontend_env.Program(
1806 target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1807 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1808 source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1809 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1810 CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1811 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1813 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1814 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1815 Alias('tex2lyx', tex2lyx)
1817 # define tex2lyx even if tex2lyx is not built with rebuild=no
1818 tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1825 print "Processing files in src..."
1827 env.Depends('$BUILDDIR/common/version.cpp', '$BUILDDIR/common/config.h')
1828 version_cpp = env.substFile('$BUILDDIR/common/version.cpp', '$TOP_SRCDIR/src/version.cpp.in')
1830 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1831 src_post_files.append('ASpell.cpp')
1832 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1833 src_post_files.append('PSpell.cpp')
1834 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1835 src_post_files.append('ISpell.cpp')
1837 # msvc requires at least one source file with main()
1838 # so I exclude main.cpp from lyxbase
1839 lyxbase_pre = env.StaticLibrary(
1840 target = '$LOCALLIBPATH/lyxbase_pre',
1841 source = ['$BUILDDIR/common/%s' % x for x in src_pre_files] + version_cpp
1843 lyxbase_post = env.StaticLibrary(
1844 target = '$LOCALLIBPATH/lyxbase_post',
1845 source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1847 Alias('lyxbase', lyxbase_pre)
1848 Alias('lyxbase', lyxbase_post)
1853 # Build lyx with given frontend
1855 lyx = frontend_env.Program(
1856 target = '$BUILDDIR/lyx',
1857 source = ['$BUILDDIR/common/main.cpp'] + \
1858 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1878 # define lyx even if lyx is not built with rebuild=no
1879 lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1882 if build_msvs_projects:
1883 def build_project(target, full_target = None,
1884 src = [], inc = [], res = [], rebuildTargetOnly = True):
1885 ''' build mavs project files
1886 target: alias (correspond to directory name)
1887 full_target: full path/filename of the target
1891 rebuildTargetOnly: whether or not only rebuild this target
1893 For non-debug-able targets like static libraries, target (alias) is
1894 enough to build the target. For executable targets, msvs need to know
1895 the full path to start debug them.
1897 if rebuildTargetOnly:
1898 cmds = 'rebuild='+target
1901 if full_target is None:
1902 build_target = target
1904 build_target = full_target
1906 proj = env.MSVSProject(
1907 target = target + env['MSVSPROJECTSUFFIX'],
1908 # this allows easy access to header files (along with source)
1909 srcs = [env.subst(x) for x in src + inc],
1910 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1911 localincs = [env.subst(x) for x in inc],
1912 resources = [env.subst(x) for x in res],
1913 buildtarget = build_target,
1917 Alias('msvs_projects', proj)
1919 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1920 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1921 rebuildTargetOnly = False,
1922 full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1924 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1925 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1926 rebuildTargetOnly = False,
1927 full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1929 build_project('lyx',
1930 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1931 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1932 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1933 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1934 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1935 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1936 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1937 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1938 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1939 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1940 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1941 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1942 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1943 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1944 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1945 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1946 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1947 rebuildTargetOnly = False,
1948 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1953 # update scons_manifest.py
1955 # When you run 'scons update_manifest', it tells you which files are missing
1956 # and which files are not in the source tree. It also generates a
1957 # scons_manifest.py.new file with all the missing files added to
1958 # XXX_extra_files. It will *not* change other sections of existing
1961 print 'Validating development/scons/scons_manifest.py...'
1963 manifest = open(env.File('$TOP_SRCDIR/development/scons/scons_manifest.py.new').abspath, 'w')
1964 print >> manifest, 'from SCons.Util import Split\n'
1966 ignore_dirs = ['boost/boost', 'm4', 'development',
1967 utils.relativePath(env.Dir('$BUILDDIR').abspath, env.Dir('$TOP_SRCDIR').abspath)]
1968 ignore_types = ['.svn', '.deps', '.cache', '.tmp', '.bak', '.gmo', '.pot',
1969 '.pyc', '.pyo', '.o', '_moc.cpp', 'Makefile.in', 'config.h.in',
1970 'LaTeXConfig.lyx', 'version.cpp', 'Package.cpp']
1971 ext_types = ['_header_files', '_files', '_pre_files', '_post_files', '_moc_files', '_inc_files',
1972 '_copied_files', '_copied_header_files', '_extra_header_files', '_extra_src_files', '_extra_files']
1973 for root,path,files in os.walk(env.Dir('$TOP_SRCDIR').abspath):
1974 if os.path.split(root)[-1][0] == '.' \
1975 or True in [x in root for x in ignore_types] \
1976 or True in [utils.isSubDir(root, x) for x in ignore_dirs]:
1978 dirname = utils.relativePath(root, env.subst('$TOP_SRCDIR')).replace(os.sep, '_')
1981 # files in the current manifest.py
1983 for ext in ext_types:
1984 if 'copied' not in ext and dirname + ext in locals():
1985 cur_files.extend(eval(dirname + ext))
1987 # compare files with cur_files
1988 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]]
1990 if cur_files != files:
1993 if f not in cur_files:
1999 if len(missing) > 0:
2000 print 'Missing: %s in %s' % (', '.join(missing), root)
2001 if dirname + '_extra_files' in locals():
2002 exec('%s_extra_files.extend(missing)' % dirname)
2004 exec('%s_extra_files = missing' % dirname)
2006 print 'Extra: %s in %s' % (', '.join(extra), root)
2007 # write to a new manifest file
2008 for ext in ext_types:
2009 if dirname + ext in locals():
2010 exec('%s%s.sort()' % (dirname, ext))
2011 print >> manifest, "%s%s = Split('''\n " % (dirname, ext),
2012 print >> manifest, eval(r"'\n '.join(%s%s)" % (dirname, ext))
2013 print >> manifest, "''')\n\n"
2015 Alias('update_manifest', None)
2022 print 'Updating po/*.po files...'
2024 # whether or not update po files
2025 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
2026 print 'xgettext or msgmerge does not exist. Cannot merge po files'
2028 # rebuild POTFILES.in
2029 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
2030 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
2031 src_extra_src_files] + \
2032 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
2033 src_support_extra_header_files + src_support_extra_src_files] + \
2034 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
2035 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
2036 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
2037 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
2038 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
2039 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
2040 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
2041 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
2043 Alias('update_po', POTFILES_in)
2044 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
2045 # and combine them to lyx.po
2046 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
2047 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
2048 env.Command('$BUILDDIR/po/all.po',
2049 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
2050 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
2051 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
2052 env.Command('$BUILDDIR/po/layouts_l10n.pot',
2053 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
2054 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2055 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
2056 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2057 env.Command('$BUILDDIR/po/ui_l10n.pot',
2058 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2059 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2060 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
2061 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
2063 ['$MSGUNIQ -o $TARGET $SOURCE',
2064 '''$XGETTEXT --default-domain=${TARGET.base} \
2065 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2066 --language=C++ --join-existing \
2067 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
2068 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2069 --copyright-holder="LyX Developers" \
2070 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2072 env.Depends(lyx_po, POTFILES_in)
2073 # copy lyx.po to lyx.pot
2074 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2075 Copy('$TARGET', '$SOURCE'))
2078 # files to translate
2079 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2080 # possibly *only* handle these languages
2082 if env.has_key('languages'):
2083 languages = env.make_list(env['languages'])
2084 # merge. if I use lan.po as $TARGET, it will be removed
2085 # before it is merged. In this builder,
2086 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2087 # and is copied to po/lang.po
2088 env['BUILDERS']['msgmerge'] = Builder(action=[
2089 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2090 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2092 # for each po file, generate pot
2093 for po_file in transfiles:
2095 fname = os.path.split(po_file)[1]
2097 country = fname.split('.')[0]
2099 if not languages or country in languages:
2100 # merge po files, the generated lan.po_new file is copied to lan.po file.
2101 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2102 env.Depends(po, POTFILES_in)
2103 Alias('update_po', po)
2110 print 'Processing files in po...'
2115 # files to translate
2116 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2117 # possibly *only* handle these languages
2119 if env.has_key('languages'):
2120 languages = env.make_list(env['lanauges'])
2121 # use defulat msgfmt
2123 if not env['MSGFMT']:
2124 print 'msgfmt does not exist. Can not process po files'
2127 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2129 for f in transfiles:
2131 fname = os.path.split(f)[1]
2133 country = fname.split('.')[0]
2135 if not languages or country in languages:
2136 gmo_files.extend(env.Transfiles(f))
2141 # this part is a bit messy right now. Since scons will provide
2142 # --DESTDIR option soon, at least the dest_dir handling can be
2145 # how to join dest_dir and prefix
2146 def joinPaths(path1, path2):
2147 ''' join path1 and path2, do not use os.path.join because
2148 under window, c:\destdir\d:\program is invalid '''
2150 return os.path.normpath(path2)
2151 # separate drive letter
2152 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2153 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2154 return os.path.join(os.path.normpath(path1), path[1:])
2156 # install to dest_dir/prefix
2157 dest_dir = env.get('DESTDIR', '')
2158 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2159 # create the directory if needed
2160 if not os.path.isdir(dest_prefix_dir):
2162 os.makedirs(dest_prefix_dir)
2165 if not os.path.isdir(dest_prefix_dir):
2166 print 'Can not create directory', dest_prefix_dir
2169 if env.has_key('exec_prefix'):
2170 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2172 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2174 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2176 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2177 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2178 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2179 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2183 # install executables (lyxclient may be None)
2186 version_suffix = program_suffix
2190 # install lyx, if in release mode, try to strip the binary
2191 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2192 # create a builder to strip and install
2193 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2195 # install executables
2196 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2199 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2200 target = os.path.join(bin_dest_dir, target_name)
2201 if env['BUILDERS'].has_key('StripInstallAs'):
2202 env.StripInstallAs(target, obj)
2204 env.InstallAs(target, obj)
2205 Alias('install', target)
2209 for (dir,files) in [
2211 ('bind', lib_bind_files),
2212 ('bind/de', lib_bind_de_files),
2213 ('bind/fi', lib_bind_fi_files),
2214 ('bind/pt', lib_bind_pt_files),
2215 ('bind/sv', lib_bind_sv_files),
2216 ('doc', lib_doc_files),
2217 ('doc/biblio', lib_doc_biblio_files),
2218 ('doc/clipart', lib_doc_clipart_files),
2219 ('doc/cs', lib_doc_cs_files),
2220 ('doc/da', lib_doc_da_files),
2221 ('doc/de', lib_doc_de_files),
2222 ('doc/de/clipart', lib_doc_de_clipart_files),
2223 ('doc/es', lib_doc_es_files),
2224 ('doc/es/clipart', lib_doc_es_clipart_files),
2225 ('doc/eu', lib_doc_eu_files),
2226 ('doc/fr', lib_doc_fr_files),
2227 ('doc/he', lib_doc_he_files),
2228 ('doc/hu', lib_doc_hu_files),
2229 ('doc/it', lib_doc_it_files),
2230 ('doc/nl', lib_doc_nl_files),
2231 ('doc/nb', lib_doc_nb_files),
2232 ('doc/pl', lib_doc_pl_files),
2233 ('doc/pt', lib_doc_pt_files),
2234 ('doc/ro', lib_doc_ro_files),
2235 ('doc/ru', lib_doc_ru_files),
2236 ('doc/sk', lib_doc_sk_files),
2237 ('doc/sl', lib_doc_sl_files),
2238 ('doc/sv', lib_doc_sv_files),
2239 ('examples', lib_examples_files),
2240 ('examples/ca', lib_examples_ca_files),
2241 ('examples/cs', lib_examples_cs_files),
2242 ('examples/da', lib_examples_da_files),
2243 ('examples/de', lib_examples_de_files),
2244 ('examples/es', lib_examples_es_files),
2245 ('examples/eu', lib_examples_eu_files),
2246 ('examples/fa', lib_examples_fa_files),
2247 ('examples/fr', lib_examples_fr_files),
2248 ('examples/he', lib_examples_he_files),
2249 ('examples/hu', lib_examples_hu_files),
2250 ('examples/it', lib_examples_it_files),
2251 ('examples/nl', lib_examples_nl_files),
2252 ('examples/pl', lib_examples_pl_files),
2253 ('examples/pt', lib_examples_pt_files),
2254 ('examples/ru', lib_examples_ru_files),
2255 ('examples/sl', lib_examples_sl_files),
2256 ('examples/ro', lib_examples_ro_files),
2257 ('fonts', lib_fonts_files),
2258 ('images', lib_images_files),
2259 ('images/math', lib_images_math_files),
2260 ('kbd', lib_kbd_files),
2261 ('layouts', lib_layouts_files + lib_layouts_inc_files),
2262 ('lyx2lyx', lib_lyx2lyx_files),
2263 ('scripts', lib_scripts_files),
2264 ('templates', lib_templates_files),
2265 ('tex', lib_tex_files),
2266 ('ui', lib_ui_files)]:
2267 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2268 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2269 Alias('install', dirs)
2271 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2272 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2273 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2274 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2275 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2276 sys.path.append(share_dest_dir + '/lyx2lyx')
2278 # generate TOC files for each doc
2279 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2281 for lang in languages.keys():
2282 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2283 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2286 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2287 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2289 # this is for English
2290 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2293 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2294 Alias('install', tocs)
2296 if platform_name == 'cygwin':
2297 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2298 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2299 '%s-%s.README' % (package, package_cygwin_version))
2300 env.InstallAs(Cygwin_README,
2301 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2302 Alias('install', Cygwin_README)
2303 # also a directory /usr/share/doc/lyx for README etc
2304 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2305 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2306 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2307 Alias('install', Cygwin_Doc)
2308 # cygwin fonts also need to be installed
2309 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2310 env.Install(Cygwin_fonts,
2311 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2312 for file in win32_bakoma_fonts])
2313 Alias('install', Cygwin_fonts)
2314 # we also need a post installation script
2315 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2316 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2317 env.Install(postinstall_path, tmp_script)
2318 Alias('install', postinstall_path)
2322 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2323 env.subst('$TOP_SRCDIR/lyx.man'))
2324 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2325 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2326 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2327 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2328 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2329 x in ['lyx', 'tex2lyx', 'lyxclient']])
2331 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2332 for gmo in gmo_files:
2333 lan = os.path.split(str(gmo))[1].split('.')[0]
2334 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2335 env.InstallAs(dest_file, gmo)
2336 Alias('install', dest_file)
2341 # build windows installer using NSIS
2344 # There is a nsis builder on scons wiki but it does not work with
2345 # our lyx.nsi because it does not dig through all the include directives
2346 # and find the dependencies automatically. Also, it can not parse
2347 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2348 # something rely on date.
2349 # Because of this, I am doing a simple nsis builder here.
2350 if platform_name != 'win32':
2351 print 'installer target is only available for windows platform'
2353 if mode != 'release':
2354 print 'installer has to be built in release mode (use option mode=release)'
2356 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2357 % x for x in development_Win32_packaging_installer] + \
2358 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2359 % x for x in development_Win32_packaging_installer_components] + \
2360 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2361 % x for x in development_Win32_packaging_installer_dialogs] + \
2362 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2363 % x for x in development_Win32_packaging_installer_graphics] + \
2364 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2365 % x for x in development_Win32_packaging_installer_include] + \
2366 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2367 % x for x in development_Win32_packaging_installer_lang]
2368 if env.has_key('NSIS') and env['NSIS'] is not None:
2369 # create a builder to strip and install
2370 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2372 print 'No nsis compiler is found. Existing...'
2374 if not env.has_key('win_installer') or env['win_installer'] is None:
2376 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2378 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2379 # provide default setting
2380 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2381 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2382 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2383 print 'Development dependency package is not found.'
2386 env['deps_dir'] = env.Dir('$deps_dir').abspath
2388 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2389 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2390 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2391 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2393 env['bundle_dir'] = None
2394 # if absolute path is given, use it, otherwise, write to current directory
2395 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2396 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2397 env.Append(NSISDEFINES={
2398 'ExeFile':env['win_installer'],
2399 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2400 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2401 'FilesDeps':env['deps_dir'],
2402 'FilesBundle':env['bundle_dir'],
2404 installer = env.installer(env['win_installer'],
2405 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2406 # since I can not use a scanner, explicit dependent is required
2407 env.Depends(installer, 'install')
2408 env.Depends(installer, installer_files)
2409 env.Alias('installer', installer)
2410 # also generate bundle?
2411 if env.has_key('bundle') and env['bundle']:
2412 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2413 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2414 print 'Use bundle_dir option to specify'
2416 # generator of the builder will add bundle stuff depending on output name
2417 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2418 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2419 env.Depends(bundle_installer, 'install')
2420 env.Depends(bundle_installer, installer_files)
2421 env.Alias('installer', bundle_installer)
2424 Alias('all', ['lyx', 'client', 'tex2lyx'])