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 # scons_utils.py defines a few utility function
18 import scons_utils as utils
19 # import all file lists
20 from scons_manifest import *
22 #----------------------------------------------------------
23 # Required runtime environment
24 #----------------------------------------------------------
26 # scons asks for 1.5.2, lyx requires 2.3
27 EnsurePythonVersion(2, 3)
28 # Please use at least 0.96.92 (not 0.96.1)
29 EnsureSConsVersion(0, 96)
30 # also check for minor version number for scons 0.96
31 from SCons import __version__
32 version = map(int, __version__.split('.'))
33 if version[0] == 0 and version[1] == 96 and version[2] < 92:
34 print "Scons >= 0.96.92 is required."
37 # determine where I am ...
39 from SCons.Node.FS import default_fs
40 # default_fs.SConstruct_dir is where SConstruct file is located.
41 scons_dir = default_fs.SConstruct_dir.path
42 # get the ../.. of scons_dir
43 top_src_dir = os.path.split(os.path.split(default_fs.SConstruct_dir.abspath)[0])[0]
44 sys.path.append(os.path.join(top_src_dir, 'lib', 'doc'))
47 #----------------------------------------------------------
49 #----------------------------------------------------------
51 # some global settings
53 # get version number from configure.ac so that JMarc does
54 # not have to change SConstruct during lyx release
55 package_version = utils.getVerFromConfigure(top_src_dir)
56 package_cygwin_version = '%s-1' % package_version
57 boost_version = ['1_34']
59 if 'svn' in package_version:
61 default_build_mode = 'debug'
64 default_build_mode = 'release'
67 package_bugreport = 'lyx-devel@lists.lyx.org'
69 package_tarname = 'lyx'
70 package_string = '%s %s' % (package_name, package_version)
72 # various cache/log files
73 default_log_file = 'scons_lyx.log'
74 opt_cache_file = 'opt.cache'
77 #----------------------------------------------------------
78 # platform dependent settings
79 #----------------------------------------------------------
82 platform_name = 'win32'
83 default_prefix = 'c:/program files/lyx'
84 default_with_x = False
85 default_packaging_method = 'windows'
86 elif os.name == 'posix' and sys.platform != 'cygwin':
87 platform_name = sys.platform
88 default_prefix = '/usr/local'
90 default_packaging_method = 'posix'
91 elif os.name == 'posix' and sys.platform == 'cygwin':
92 platform_name = 'cygwin'
93 default_prefix = '/usr'
95 default_packaging_method = 'posix'
96 elif os.name == 'darwin':
97 platform_name = 'macosx'
98 # FIXME: macOSX default prefix?
100 default_with_x = False
101 default_packaging_method = 'macosx'
102 else: # unsupported system, assume posix behavior
103 platform_name = 'others'
105 default_with_x = True
106 default_packaging_method = 'posix'
108 #---------------------------------------------------------
110 #----------------------------------------------------------
112 # You can set perminant default values in config.py
113 if os.path.isfile('config.py'):
114 print "Getting options from config.py..."
115 print open('config.py').read()
117 opts = Options(['config.py'])
120 EnumOption('frontend', 'Main GUI', 'qt4',
121 allowed_values = ('qt4',) ),
122 # debug or release build
123 EnumOption('mode', 'Building method', default_build_mode,
124 allowed_values = ('debug', 'release') ),
127 'Use included, system boost library, or try sytem boost first.',
128 'auto', allowed_values = (
129 'auto', # detect boost, if not found, use included
130 'included', # always use included boost
131 'system', # always use system boost, fail if can not find
134 EnumOption('gettext',
135 'Use included, system gettext library, or try sytem gettext first',
136 'auto', allowed_values = (
137 'auto', # detect gettext, if not found, use included
138 'included', # always use included gettext
139 'system', # always use system gettext, fail if can not find
142 EnumOption('spell', 'Choose spell checker to use.', 'auto',
143 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
145 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
146 allowed_values = ('windows', 'posix', 'macosx')),
148 BoolOption('fast_start', 'This option is obsolete.', False),
149 # No precompiled header support (too troublesome to make it work for msvc)
150 # BoolOption('pch', 'Whether or not use pch', False),
151 # enable assertion, (config.h has ENABLE_ASSERTIOS
152 BoolOption('assertions', 'Use assertions', True),
153 # enable warning, (config.h has WITH_WARNINGS)
154 # default to False since MSVC does not have #warning
155 BoolOption('warnings', 'Use warnings', False),
156 # config.h define _GLIBCXX_CONCEPT_CHECKS
157 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
158 BoolOption('concept_checks', 'Enable concept checks', True),
160 BoolOption('nls', 'Whether or not use native language support', True),
162 BoolOption('profiling', 'Whether or not enable profiling', False),
163 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
164 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
166 BoolOption('X11', 'Use x11 windows system', default_with_x),
167 # use MS VC++ to build lyx
168 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
170 PathOption('qt_dir', 'Path to qt directory', None),
172 PathOption('qt_inc_path', 'Path to qt include directory', None),
174 PathOption('qt_lib_path', 'Path to qt library directory', None),
175 # extra include and libpath
176 PathOption('extra_inc_path', 'Extra include path', None),
178 PathOption('extra_lib_path', 'Extra library path', None),
180 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
182 PathOption('extra_inc_path1', 'Extra include path', None),
184 PathOption('extra_lib_path1', 'Extra library path', None),
185 # rebuild only specifed, comma separated targets
186 ('rebuild', '''rebuild only specifed, comma separated targets.
187 yes or all (default): rebuild everything
188 no or none: rebuild nothing (usually used for installation)
189 comp1,comp2,...: rebuild specified targets''', None),
190 # can be set to a non-existing directory
191 ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
192 # replace the default name and location of the windows installer
193 ('win_installer', 'name or full path to the windows installer', None),
194 # the deps package used to create minimal installer (qt and other libraries)
195 ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
196 # whether or not build bundle installer
197 BoolOption('bundle', 'Whether or not build bundle installer', False),
198 # the bundle directory, containing bundled applications
199 PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
200 # build directory, will use $mode if not set
201 ('build_dir', 'Build directory', None),
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'),
211 ('optimization', 'optimization CCFLAGS option.', None),
213 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
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),
231 all_options = [x.key for x in opts.options]
233 # copied from SCons/Options/BoolOption.py
234 # We need to use them before a boolean ARGUMENTS option is available
236 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
237 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
239 if ARGUMENTS.has_key('fast_start'):
240 print 'fast_start option is obsolete'
242 # if load_option=yes (default), load saved comand line options
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)
252 # import cached options, but we should ignore qt_dir when frontend changes
253 if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
254 and ARGUMENTS['frontend'] != opt_cache['frontend'] \
255 and opt_cache.has_key('qt_dir'):
256 opt_cache.pop('qt_dir')
257 # and we do not cache some options (dest_dir is obsolete)
258 for arg in ['load_option', 'dest_dir', 'bundle']:
259 if opt_cache.has_key(arg):
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
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):
274 # if opt1,opt2 is specified, only load specified options
276 args = ARGUMENTS['load_option'].split(',')
277 for arg in opt_cache.keys():
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])
287 # check if there is unused (or misspelled) argument
288 for arg in ARGUMENTS.keys():
289 if arg not in all_options:
291 print "Unknown option '%s'... exiting." % arg
293 print "Available options are (check 'scons -help' for details):"
294 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
298 cache_file = open(opt_cache_file, 'w')
299 cPickle.dump(ARGUMENTS, cache_file)
302 #---------------------------------------------------------
303 # Setting up environment
304 #---------------------------------------------------------
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)
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')
317 # for simplicity, use var instead of env[var]
318 frontend = env['frontend']
319 prefix = env['prefix']
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?"
328 elif WhereIs('cl.exe') is not None:
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']):
342 os.makedirs(env['build_dir'])
345 if not os.path.isdir(env['build_dir']):
346 print 'Can not create directory', env['build_dir']
348 env['BUILDDIR'] = env['build_dir']
350 # Determine the name of the build $mode
351 env['BUILDDIR'] = '#' + mode
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'])
359 # Here is a summary of variables defined in env
361 # 2. undefined options with a non-None default value
362 # 3. compiler commands and flags like CCFLAGS.
363 # MSGFMT used to process po files
364 # 4. Variables that will be used to replace variables in some_file.in
365 # src/support/Package.cpp.in:
366 # TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
367 # lib/lyx2lyx/lyx2lyx_version.py.in
370 # PACKAGE_VERSION, LYX_DATE, VERSION_INFO
372 # full path name is used to build msvs project files
373 # and to replace TOP_SRCDIR in package.C
374 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
375 # needed by src/version.cpp.in => src/version.C
376 env['PACKAGE_VERSION'] = package_version
377 env['LYX_DATE'] = time.asctime()
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'
386 share_dir = 'share/lyx'
387 locale_dir = 'share/locale'
388 if platform_name == 'cygwin':
389 man_dir = 'share/man/man1'
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:
400 program_suffix = env['version_suffix']
403 # used by Package.cpp.in
404 env['PROGRAM_SUFFIX'] = program_suffix
406 # whether or not add suffix to file and directory names
407 add_suffix = packaging_method != 'windows'
408 # LYX_DIR are different (used in Package.cpp.in)
410 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
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
417 #---------------------------------------------------------
418 # Setting building environment (Tools, compiler flags etc)
419 #---------------------------------------------------------
421 # Since Tool('mingw') will reset CCFLAGS etc, this should be
422 # done before getEnvVariable
423 if platform_name == 'win32':
429 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
430 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
432 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
435 # we differentiate between hard-coded options and default options
436 # hard-coded options are required and will always be there
437 # default options can be replaced by enviromental variables or command line options
438 CCFLAGS_required = []
439 LINKFLAGS_required = []
442 # under windows, scons is confused by .C/.c and uses gcc instead of
443 # g++. I am forcing the use of g++ here. This is expected to change
444 # after lyx renames all .C files to .cpp
446 # save the old c compiler and CCFLAGS (used by libintl)
447 C_COMPILER = env.subst('$CC')
448 C_CCFLAGS = env.subst('$CCFLAGS').split()
449 # if we use ms vc, the commands are fine (cl.exe and link.exe)
451 # /TP treat all source code as C++
452 # C4819: The file contains a character that cannot be represented
453 # in the current code page (number)
454 # C4996: foo was decleared deprecated
455 CCFLAGS_required.extend(['/TP', '/EHsc'])
457 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
458 # the flags are also needed in C mode (for intl lib)
459 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
461 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
462 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
464 if env.has_key('CXX') and env['CXX']:
465 env['CC'] = env.subst('$CXX')
466 env['LINK'] = env.subst('$CXX')
471 # for debug/release mode
472 if env.has_key('optimization') and env['optimization'] is not None:
473 # if user supplies optimization flags, use it anyway
474 CCFLAGS_required.extend(env['optimization'].split())
475 # and do not use default
476 set_default_optimization_flags = False
478 set_default_optimization_flags = True
482 CCFLAGS_required.append('/Zi')
483 LINKFLAGS_required.extend(['/debug', '/map'])
485 CCFLAGS_required.append('-g')
486 CCFLAGS_default.append('-O')
487 elif mode == 'release' and set_default_optimization_flags:
489 CCFLAGS_default.append('/O2')
491 CCFLAGS_default.append('-O2')
493 # msvc uses separate tools for profiling
494 if env.has_key('profiling') and env['profiling']:
496 print 'Visual C++ does not use profiling options'
498 CCFLAGS_required.append('-pg')
499 LINKFLAGS_required.append('-pg')
501 if env.has_key('warnings') and env['warnings']:
503 CCFLAGS_default.append('/W2')
505 # Note: autotools detect gxx version and pass -W for 3.x
506 # and -Wextra for other versions of gcc
507 CCFLAGS_default.append('-Wall')
509 # Now, set the variables as follows:
510 # 1. if command line option exists: replace default
511 # 2. then if s envronment variable exists: replace default
512 # 3. set variable to required + default
513 def setEnvVariable(env, name, required = None, default = None, split = True):
514 ''' env: environment to set variable
516 required: hardcoded options
517 default: default options that can be replaced by command line or
518 environment variables
519 split: whether or not split obtained variable like '-02 -g'
521 # 1. ARGUMENTS is already set to env[name], override default.
522 if ARGUMENTS.has_key(name):
523 # env[name] may be rewritten when building tools are reloaded
524 # if that is the case, commandline option will override it.
525 env[name] = ARGUMENTS[name]
527 # then use environment default
528 elif os.environ.has_key(name):
529 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
530 default = os.environ[name]
532 default = default.split()
533 # the real value should be env[name] + default + required
536 if env.has_key(name):
537 value = str(env[name]).split()
538 if required is not None:
540 if default is not None:
544 if env.has_key(name):
545 value = str(env[name])
546 if required is not None:
547 value += " " + required
548 if default is not None:
549 value += " " + default
551 # print name, env[name]
553 setEnvVariable(env, 'DESTDIR', split=False)
554 setEnvVariable(env, 'CC')
555 setEnvVariable(env, 'LINK')
556 setEnvVariable(env, 'CPP')
557 setEnvVariable(env, 'CXX')
558 setEnvVariable(env, 'CXXCPP')
559 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
560 setEnvVariable(env, 'CXXFLAGS')
561 setEnvVariable(env, 'CPPFLAGS')
562 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
564 # if DESTDIR is not set...
565 if env.has_key('dest_dir'):
566 print "This option is obsolete. Please use DESTDIR instead."
567 env['DESTDIR'] = env['dest_dir']
570 # extra_inc_path and extra_lib_path
573 if env.has_key('extra_inc_path') and env['extra_inc_path']:
574 extra_inc_paths.append(env['extra_inc_path'])
575 if env.has_key('extra_lib_path') and env['extra_lib_path']:
576 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
577 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
578 extra_inc_paths.append(env['extra_inc_path1'])
579 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
580 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
581 if env.has_key('extra_bin_path') and env['extra_bin_path']:
582 # only the first one is needed (a scons bug?)
583 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
584 env.PrependENVPath('PATH', env['extra_bin_path'])
585 # extra_inc_paths will be used later by intlenv etc
586 env.AppendUnique(CPPPATH = extra_inc_paths)
589 #----------------------------------------------------------
591 #----------------------------------------------------------
593 conf = Configure(env,
595 'CheckPkgConfig' : utils.checkPkgConfig,
596 'CheckPackage' : utils.checkPackage,
597 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
598 'CheckSelectArgType' : utils.checkSelectArgType,
599 'CheckBoostLibraries' : utils.checkBoostLibraries,
600 'CheckCommand' : utils.checkCommand,
601 'CheckNSIS' : utils.checkNSIS,
602 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
603 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
604 'CheckIconvConst' : utils.checkIconvConst,
605 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
609 # pkg-config? (if not, we use hard-coded options)
610 if conf.CheckPkgConfig('0.15.0'):
611 env['HAS_PKG_CONFIG'] = True
613 print 'pkg-config >= 0.1.50 is not found'
614 env['HAS_PKG_CONFIG'] = False
616 # zlib? This is required.
617 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
618 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
619 print 'Did not find zdll.lib or zlib.h, exiting!'
621 if conf.CheckLib('iconv'):
622 env['ICONV_LIB'] = 'iconv'
623 elif conf.CheckLib('libiconv'):
624 env['ICONV_LIB'] = 'libiconv'
625 elif conf.CheckFunc('iconv_open'):
626 env['ICONV_LIB'] = None
628 print 'Did not find iconv or libiconv, exiting!'
633 if conf.CheckLib('socket'):
634 socket_libs.append('socket')
635 # nsl is the network services library and provides a
636 # transport-level interface to networking services.
637 if conf.CheckLib('nsl'):
638 socket_libs.append('nsl')
640 # check available boost libs (since lyx1.4 does not use iostream)
642 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
643 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
644 boost_libs.append(lib)
646 # check boost libraries
647 boost_opt = ARGUMENTS.get('boost', 'auto')
648 # check for system boost
649 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
650 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
651 # default to $BUILDDIR/libs (use None since this path will be added anyway)
653 # here I assume that all libraries are in the same directory
654 if boost_opt == 'included':
655 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
656 included_boost = True
657 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
658 elif boost_opt == 'auto':
659 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
660 # if not found, use local boost
662 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
663 included_boost = True
664 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
666 included_boost = False
667 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
668 elif boost_opt == 'system':
669 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
671 print "Can not find system boost libraries with version %s " % boost_version
672 print "Please supply a path through extra_lib_path and try again."
673 print "Or use boost=included to use included boost libraries."
676 included_boost = False
677 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
680 if boost_libpath is not None:
681 env.AppendUnique(LIBPATH = [boost_libpath])
684 env['ENABLE_NLS'] = env['nls']
686 if not env['ENABLE_NLS']:
688 included_gettext = False
690 # check gettext libraries
691 gettext_opt = ARGUMENTS.get('gettext', 'auto')
692 # check for system gettext
694 if gettext_opt in ['auto', 'system']:
695 if conf.CheckFunc('gettext'):
696 included_gettext = False
699 elif conf.CheckLib('intl'):
700 included_gettext = False
704 if gettext_opt == 'system':
705 print "Can not find system gettext library"
706 print "Please supply a path through extra_lib_path and try again."
707 print "Or use gettext=included to use included gettext libraries."
709 # now, auto and succ = false, or gettext=included
711 # we do not need to set LIBPATH now.
712 included_gettext = True
713 intl_libs = ['included_intl']
717 # check for msgfmt command
718 env['MSGFMT'] = conf.CheckCommand('msgfmt')
719 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
720 env['XGETTEXT'] = conf.CheckCommand('xgettext')
721 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
723 # if under windows, check the nsis compiler
724 if platform_name == 'win32':
725 env['NSIS'] = conf.CheckNSIS()
727 # cygwin packaging requires the binaries to be stripped
728 if platform_name == 'cygwin':
729 env['STRIP'] = conf.CheckCommand('strip')
732 # Customized builders
734 # install customized builders
735 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
736 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
737 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
740 #----------------------------------------------------------
741 # Generating config.h
742 #----------------------------------------------------------
743 aspell_lib = 'aspell'
744 # assume that we use aspell, aspelld compiled for msvc
745 if platform_name == 'win32' and mode == 'debug' and use_vc:
746 aspell_lib = 'aspelld'
748 # check the existence of config.h
749 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
750 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
752 print "Creating %s..." % boost_config_h
754 utils.createConfigFile(conf,
755 config_file = boost_config_h,
756 config_pre = '''/* boost/config.h. Generated by SCons. */
761 * This file is part of LyX, the document processor.
762 * Licence details can be found in the file COPYING.
764 * This is the compilation configuration file for LyX.
765 * It was generated by scon.
766 * You might want to change some of the defaults if something goes wrong
767 * during the compilation.
770 #ifndef _BOOST_CONFIG_H
771 #define _BOOST_CONFIG_H
774 ('ostream', 'HAVE_OSTREAM', 'cxx'),
775 ('locale', 'HAVE_LOCALE', 'cxx'),
776 ('sstream', 'HAVE_SSTREAM', 'cxx'),
777 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
780 (env.has_key('assertions') and env['assertions'],
782 'Define if you want assertions to be enabled in the code'
786 ('wchar_t', 'HAVE_WCHAR_T', None),
790 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
791 # define USE_BOOST_FORMAT 1
793 # define USE_BOOST_FORMAT 0
796 #if !defined(ENABLE_ASSERTIONS)
797 # define BOOST_DISABLE_ASSERTS 1
799 #define BOOST_ENABLE_ASSERT_HANDLER 1
801 #define BOOST_DISABLE_THREADS 1
802 #define BOOST_NO_WSTRING 1
805 # define BOOST_POSIX 1
806 # define BOOST_POSIX_API 1
807 # define BOOST_POSIX_PATH 1
810 #define BOOST_ALL_NO_LIB 1
812 #if defined(HAVE_NEWAPIS_H)
813 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
816 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4
817 # define LIBC_WCTYPE_USES_UCS4
824 print "\nGenerating %s..." % config_h
826 # AIKSAURUS_H_LOCATION
827 if (conf.CheckCXXHeader("Aiksaurus.h")):
828 aik_location = '<Aiksaurus.h>'
829 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
830 aik_location = '<Aiksaurus/Aiksaurus.h>'
834 # determine headers to use
835 spell_opt = ARGUMENTS.get('spell', 'auto')
836 env['USE_ASPELL'] = False
837 env['USE_PSPELL'] = False
838 env['USE_ISPELL'] = False
839 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
840 spell_engine = 'USE_ASPELL'
841 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
842 spell_engine = 'USE_PSPELL'
843 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
844 spell_engine = 'USE_ISPELL'
848 if spell_engine is not None:
849 env[spell_engine] = True
851 if spell_opt == 'auto':
852 print "Warning: Can not locate any spell checker"
853 elif spell_opt != 'no':
854 print "Warning: Can not locate specified spell checker:", spell_opt
857 # check arg types of select function
858 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
860 # check the size of wchar_t
861 sizeof_wchar_t = conf.CheckSizeOfWChar()
863 if sizeof_wchar_t == 0:
864 print 'Error: Can not determine the size of wchar_t.'
869 result = utils.createConfigFile(conf,
870 config_file = config_h,
871 config_pre = '''/* config.h. Generated by SCons. */
876 * This file is part of LyX, the document processor.
877 * Licence details can be found in the file COPYING.
879 * This is the compilation configuration file for LyX.
880 * It was generated by scon.
881 * You might want to change some of the defaults if something goes wrong
882 * during the compilation.
889 ('io.h', 'HAVE_IO_H', 'c'),
890 ('limits.h', 'HAVE_LIMITS_H', 'c'),
891 ('locale.h', 'HAVE_LOCALE_H', 'c'),
892 ('process.h', 'HAVE_PROCESS_H', 'c'),
893 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
894 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
895 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
896 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
897 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
898 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
899 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
900 ('utime.h', 'HAVE_UTIME_H', 'c'),
901 ('direct.h', 'HAVE_DIRECT_H', 'c'),
902 ('istream', 'HAVE_ISTREAM', 'cxx'),
903 ('ios', 'HAVE_IOS', 'cxx'),
906 ('open', 'HAVE_OPEN', None),
907 ('chmod', 'HAVE_CHMOD', None),
908 ('close', 'HAVE_CLOSE', None),
909 ('popen', 'HAVE_POPEN', None),
910 ('pclose', 'HAVE_PCLOSE', None),
911 ('_open', 'HAVE__OPEN', None),
912 ('_close', 'HAVE__CLOSE', None),
913 ('_popen', 'HAVE__POPEN', None),
914 ('_pclose', 'HAVE__PCLOSE', None),
915 ('getpid', 'HAVE_GETPID', None),
916 ('_getpid', 'HAVE__GETPID', None),
917 ('mkdir', 'HAVE_MKDIR', None),
918 ('_mkdir', 'HAVE__MKDIR', None),
919 ('mktemp', 'HAVE_MKTEMP', None),
920 ('mkstemp', 'HAVE_MKSTEMP', None),
921 ('strerror', 'HAVE_STRERROR', None),
922 ('count', 'HAVE_STD_COUNT', '''
927 return std::count(a, a+5, 'l');
930 ('getcwd', 'HAVE_GETCWD', None),
931 ('setenv', 'HAVE_SETENV', None),
932 ('putenv', 'HAVE_PUTENV', None),
933 ('fcntl', 'HAVE_FCNTL', None),
936 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
937 '#include <streambuf>\n#include <istream>'),
938 ('wchar_t', 'HAVE_WCHAR_T', None),
939 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
942 ('gdi32', 'HAVE_LIBGDI32'),
943 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
946 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
948 'Define is sys/types.h does not have pid_t',
952 (conf.CheckCXXGlobalCstd(),
954 'Define if your C++ compiler puts C library functions in the global namespace'
956 (conf.CheckMkdirOneArg(),
957 'MKDIR_TAKES_ONE_ARG',
958 'Define if mkdir takes only one argument.'
960 (conf.CheckIconvConst(),
962 'Define as const if the declaration of iconv() needs const.',
963 '#define ICONV_CONST const',
964 '#define ICONV_CONST',
966 (conf.CheckLC_MESSAGES(),
968 'Define if your <locale.h> file defines LC_MESSAGES.'
970 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
973 "Define to 1 if translation of program messages to the user's native anguage is requested.",
975 (env['nls'] and not included_gettext,
977 'Define to 1 if using system gettext library'
979 (env.has_key('warnings') and env['warnings'],
981 'Define this if you want to see the warning directives put here and there by the developpers to get attention'
983 (env.has_key('concept_checks') and env['concept_checks'],
984 '_GLIBCXX_CONCEPT_CHECKS',
985 'libstdc++ concept checking'
987 (env.has_key('stdlib_debug') and env['stdlib_debug'],
989 'libstdc++ debug mode'
991 (env.has_key('stdlib_debug') and env['stdlib_debug'],
992 '_GLIBCXX_DEBUG_PEDANTIC',
993 'libstdc++ pedantic debug mode'
995 (os.name != 'nt', 'BOOST_POSIX',
996 'Indicates to boost < 1.34 which API to use (posix or windows).'
998 (os.name != 'nt', 'BOOST_POSIX_API',
999 'Indicates to boost 1.34 which API to use (posix or windows).'
1001 (os.name != 'nt', 'BOOST_POSIX_PATH',
1002 'Indicates to boost 1.34 which path style to use (posix or windows).'
1004 (spell_engine is not None, spell_engine,
1005 'Spell engine to use'
1007 # we need to know the byte order for unicode conversions
1008 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1009 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1013 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1015 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1016 'Define to the address where bug reports for this package should be sent.'),
1017 ('#define PACKAGE_NAME "%s"' % package_name,
1018 'Define to the full name of this package.'),
1019 ('#define PACKAGE_STRING "%s"' % package_string,
1020 'Define to the full name and version of this package.'),
1021 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1022 'Define to the one symbol short name of this package.'),
1023 ('#define PACKAGE_VERSION "%s"' % package_version,
1024 'Define to the version of this package.'),
1025 ('#define BOOST_ALL_NO_LIB 1',
1026 'disable automatic linking of boost libraries.'),
1027 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1028 'Packaging method'),
1029 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1030 'Aiksaurus include file'),
1031 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1032 "Define to the type of arg 1 for `select'."),
1033 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1034 "Define to the type of arg 2, 3, 4 for `select'."),
1035 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1036 "Define to the type of arg 5 for `select'."),
1037 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1038 'Define to be the size of type wchar_t'),
1040 config_post = '''/************************************************************
1041 ** You should not need to change anything beyond this point */
1043 #ifndef HAVE_STRERROR
1044 #if defined(__cplusplus)
1047 char * strerror(int n);
1051 #ifndef HAVE_DECL_MKSTEMP
1052 #if defined(__cplusplus)
1059 #include <../boost/config.h>
1065 # these keys are needed in env
1066 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1067 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1068 # USE_ASPELL etc does not go through result
1069 if result.has_key(key):
1070 env[key] = result[key]
1073 # if nls=yes and gettext=included, create intl/config.h
1074 # intl/libintl.h etc
1076 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1077 if env['nls'] and included_gettext:
1079 print "Creating %s..." % intl_config_h
1081 # create intl/config.h
1082 result = utils.createConfigFile(conf,
1083 config_file = intl_config_h,
1084 config_pre = '''/* intl/config.h. Generated by SCons. */
1089 * This file is part of LyX, the document processor.
1090 * Licence details can be found in the file COPYING.
1092 * This is the compilation configuration file for LyX.
1093 * It was generated by scon.
1094 * You might want to change some of the defaults if something goes wrong
1095 * during the compilation.
1102 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1103 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1104 ('string.h', 'HAVE_STRING_H', 'c'),
1105 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1106 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1107 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1108 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1109 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1110 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1111 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1114 ('getcwd', 'HAVE_GETCWD', None),
1115 ('stpcpy', 'HAVE_STPCPY', None),
1116 ('strcasecmp', 'HAVE_STRCASECMP', None),
1117 ('strdup', 'HAVE_STRDUP', None),
1118 ('strtoul', 'HAVE_STRTOUL', None),
1119 ('alloca', 'HAVE_ALLOCA', None),
1120 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1121 ('mempcpy', 'HAVE_MEMPCPY', None),
1122 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1123 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1124 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1125 ('setlocale', 'HAVE_SETLOCALE', None),
1126 ('tsearch', 'HAVE_TSEARCH', None),
1127 ('getegid', 'HAVE_GETEGID', None),
1128 ('getgid', 'HAVE_GETGID', None),
1129 ('getuid', 'HAVE_GETUID', None),
1130 ('wcslen', 'HAVE_WCSLEN', None),
1131 ('asprintf', 'HAVE_ASPRINTF', None),
1132 ('wprintf', 'HAVE_WPRINTF', None),
1133 ('snprintf', 'HAVE_SNPRINTF', None),
1134 ('printf', 'HAVE_POSIX_PRINTF', None),
1135 ('fcntl', 'HAVE_FCNTL', None),
1138 ('intmax_t', 'HAVE_INTMAX_T', None),
1139 ('long double', 'HAVE_LONG_DOUBLE', None),
1140 ('long long', 'HAVE_LONG_LONG', None),
1141 ('wchar_t', 'HAVE_WCHAR_T', None),
1142 ('wint_t', 'HAVE_WINT_T', None),
1143 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1144 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1150 (conf.CheckLC_MESSAGES(),
1152 'Define if your <locale.h> file defines LC_MESSAGES.'
1154 (conf.CheckIconvConst(),
1156 'Define as const if the declaration of iconv() needs const.',
1157 '#define ICONV_CONST const',
1158 '#define ICONV_CONST',
1160 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1161 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1163 "Define to 1 if you have the `intmax_t' type."
1165 (env.has_key('nls') and env['nls'],
1167 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1171 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1172 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1173 'Define to be the size of type wchar_t'),
1175 config_post = '#endif'
1178 # these keys are needed in env
1179 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1180 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1181 # USE_ASPELL etc does not go through result
1182 if result.has_key(key):
1183 env[key] = result[key]
1186 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1187 if env['nls'] and included_gettext:
1188 # libgnuintl.h.in => libintl.h
1189 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1190 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1191 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1192 [Copy('$TARGET', '$SOURCE')])
1195 # Finish auto-configuration
1198 #----------------------------------------------------------
1199 # Now set up our build process accordingly
1200 #----------------------------------------------------------
1202 if env['ICONV_LIB'] is None:
1205 system_libs = [env['ICONV_LIB']]
1206 if platform_name in ['win32', 'cygwin']:
1207 # the final link step needs stdc++ to succeed under mingw
1208 # FIXME: shouldn't g++ automatically link to stdc++?
1210 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1212 system_libs += ['shlwapi', 'stdc++', 'z']
1213 elif platform_name == 'cygwin' and env['X11']:
1214 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1215 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1216 'resolv', 'pthread', 'z']
1218 system_libs += ['z']
1221 ('HAVE_LIBGDI32', 'gdi32'),
1222 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1223 ('USE_ASPELL', aspell_lib),
1224 ('USE_ISPELL', 'ispell'),
1225 ('USE_PSPELL', 'pspell'),
1230 system_libs.append(lib[1])
1233 # Build parameters CPPPATH etc
1236 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1239 # boost: for boost header files
1240 # BUILDDIR/common: for config.h
1241 # TOP_SRCDIR/src: for support/* etc
1243 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1245 # Separating boost directories from CPPPATH stops scons from building
1246 # the dependency tree for boost header files, and effectively reduce
1247 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1248 # boost headers, this is only done for system boost headers.
1250 env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1253 env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1255 env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1257 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1258 if env['nls'] and included_gettext:
1259 env['CPPPATH'].append('$BUILDDIR/intl')
1263 # A Link script for cygwin see
1264 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1265 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1268 if platform_name == 'cygwin':
1269 ld_script_path = '/tmp'
1270 ld_script = utils.installCygwinLDScript(ld_script_path)
1271 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1272 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1275 #---------------------------------------------------------
1276 # Frontend related variables (QTDIR etc)
1277 #---------------------------------------------------------
1280 # create a separate environment so that other files do not have
1281 # to be built with all the include directories etc
1283 if frontend == 'qt4':
1284 frontend_env = env.Copy()
1286 # handle qt related user specified paths
1287 # set environment so that moc etc can be found even if its path is not set properly
1288 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1289 frontend_env['QTDIR'] = frontend_env['qt_dir']
1290 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1291 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1292 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1293 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1294 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1296 # if separate qt_lib_path is given
1297 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1298 qt_lib_path = frontend_env.subst('$qt_lib_path')
1299 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1300 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1304 # if separate qt_inc_path is given
1305 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1306 qt_inc_path = frontend_env['qt_inc_path']
1310 # local qt4 toolset from
1311 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1313 # NOTE: I have to patch qt4.py since it does not automatically
1314 # process .C file!!! (add to cxx_suffixes )
1316 frontend_env.Tool('qt4', [scons_dir])
1317 frontend_env['QT_AUTOSCAN'] = 0
1318 frontend_env['QT4_AUTOSCAN'] = 0
1319 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1321 if qt_lib_path is None:
1322 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1323 if qt_inc_path is None:
1324 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1327 conf = Configure(frontend_env,
1329 'CheckPackage' : utils.checkPackage,
1330 'CheckCommand' : utils.checkCommand,
1335 # first: try pkg_config
1336 if frontend_env['HAS_PKG_CONFIG']:
1337 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1338 # FIXME: use pkg_config information?
1339 #frontend_env['QT4_PKG_CONFIG'] = succ
1340 # second: try to link to it
1342 # Under linux, I can test the following perfectly
1343 # Under windows, lib names need to passed as libXXX4.a ...
1344 if platform_name == 'win32':
1345 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1347 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1348 # still can not find it
1350 print 'Did not find qt libraries, exiting!'
1353 # Now, determine the correct suffix:
1354 qt_libs = ['QtCore', 'QtGui']
1355 if platform_name == 'win32':
1356 if mode == 'debug' and use_vc and \
1357 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1358 qt_lib_suffix = 'd4'
1359 use_qt_debug_libs = True
1362 use_qt_debug_libs = False
1364 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1365 qt_lib_suffix = '_debug'
1366 use_qt_debug_libs = True
1369 use_qt_debug_libs = False
1370 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1371 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1372 qtcore_lib = ['QtCore' + qt_lib_suffix]
1374 # check uic and moc commands for qt frontends
1375 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1376 print 'uic or moc command is not found for frontend', frontend
1379 # now, if msvc2005 is used, we will need that QT_LIB_PATH/QT_LIB.manifest file
1382 if qt_lib_path is not None:
1383 manifest = os.path.join(qt_lib_path, 'QtGuid4.dll.manifest')
1385 manifest = 'QtGuid4.dll.manifest'
1387 if qt_lib_path is not None:
1388 manifest = os.path.join(qt_lib_path, 'QtGui4.dll.manifest')
1390 manifest = 'QtGui4.dll.manifest'
1391 if os.path.isfile(manifest):
1392 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % manifest]
1394 frontend_env = conf.Finish()
1399 # fill in the version info
1400 env['VERSION_INFO'] = '''Configuration
1402 Special build flags: %s
1404 C Compiler flags: %s %s
1406 C++ Compiler LyX flags: %s
1407 C++ Compiler flags: %s %s
1409 Linker user flags: %s
1411 Builing directory: %s
1412 Local library directory: %s
1415 Frontend libraries: %s
1416 System libraries: %s
1417 include search path: %s
1423 ''' % (platform_name,
1424 env.subst('$CCFLAGS'), env.subst('$CC'),
1425 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1426 env.subst('$CXX'), env.subst('$CXXFLAGS'),
1427 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1428 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1429 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1430 str(env['LIBPATH']), str(boost_libraries),
1431 str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1432 frontend, packaging_method,
1433 prefix, env['LYX_DIR'])
1435 if frontend in ['qt4']:
1436 env['VERSION_INFO'] += ''' include dir: %s
1439 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1441 print env['VERSION_INFO']
1444 # Mingw command line may be too short for our link usage,
1445 # Here we use a trick from scons wiki
1446 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1448 # I also would like to add logging (commands only) capacity to the
1450 logfile = env.get('logfile', default_log_file)
1451 if logfile != '' or platform_name == 'win32':
1453 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1454 info = '''# This is a log of commands used by scons to build lyx
1458 ''' % (time.asctime(), ' '.join(sys.argv),
1459 env['VERSION_INFO'].replace('\n','\n# ')) )
1464 # -h will print out help info
1465 Help(opts.GenerateHelpText(env))
1469 #----------------------------------------------------------
1471 #----------------------------------------------------------
1472 # this has been the source of problems on some platforms...
1473 # I find that I need to supply it with full path name
1474 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1475 # this usage needs further investigation.
1476 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1478 print "Building all targets recursively"
1480 if env.has_key('rebuild'):
1481 rebuild_targets = env['rebuild'].split(',')
1482 if 'none' in rebuild_targets or 'no' in rebuild_targets:
1483 rebuild_targets = []
1484 elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1485 # None: let scons decide which components to build
1486 # Forcing all components to be rebuilt is in theory not necessary
1487 rebuild_targets = None
1489 rebuild_targets = None
1491 def libExists(libname):
1492 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1493 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1495 def appExists(apppath, appname):
1496 ''' Check whether or not application already exists'''
1497 return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1499 targets = BUILD_TARGETS
1500 build_install = 'install' in targets or 'installer' in targets
1501 build_installer = 'installer' in targets
1502 # msvc need to pass full target name, so I have to look for path/lyx etc
1503 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1504 or build_install or 'all' in targets
1505 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1506 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1507 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1508 build_mathed = build_lyx or 'mathed' in targets
1509 build_insets = build_lyx or 'insets' in targets
1510 build_frontends = build_lyx or 'frontends' in targets
1511 build_graphics = build_lyx or 'graphics' in targets
1512 build_controllers = build_lyx or 'controllers' in targets
1513 build_client = True in ['client' in x for x in targets] \
1514 or build_install or 'all' in targets or build_installer
1515 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1516 or build_install or 'all' in targets or build_installer
1517 build_lyxbase = build_lyx or 'lyxbase' in targets
1518 update_po = 'update_po' in targets
1519 build_po = 'po' in targets or build_install or 'all' in targets
1520 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1521 build_msvs_projects = use_vc and 'msvs_projects' in targets
1524 # now, if rebuild_targets is specified, do not rebuild some targets
1525 if rebuild_targets is not None:
1527 def ifBuildLib(name, libname, old_value):
1528 # explicitly asked to rebuild
1529 if name in rebuild_targets:
1531 # else if not rebuild, and if the library already exists
1532 elif libExists(libname):
1534 # do not change the original value
1537 build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1538 build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1539 build_support = ifBuildLib('support', 'support', build_support)
1540 build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1541 build_insets = ifBuildLib('insets', 'insets', build_insets)
1542 build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1543 build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1544 build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1545 build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1546 build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1548 def ifBuildApp(name, appname, old_value):
1549 # explicitly asked to rebuild
1550 if name in rebuild_targets:
1552 # else if not rebuild, and if the library already exists
1553 elif appExists(name, appname):
1555 # do not change the original value
1558 build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1559 build_client = ifBuildApp('client', 'lyxclient', build_client)
1561 # sync frontend and frontend (?)
1571 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1573 boostenv = env.Copy()
1575 # boost use its own config.h
1576 boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1577 boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1579 for lib in boost_libs:
1580 print 'Processing files in boost/libs/%s/src...' % lib
1581 boostlib = boostenv.StaticLibrary(
1582 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1583 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1585 Alias('boost', boostlib)
1592 intlenv = env.Copy()
1594 print "Processing files in intl..."
1596 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1598 # we need the original C compiler for these files
1599 intlenv['CC'] = C_COMPILER
1600 intlenv['CCFLAGS'] = C_CCFLAGS
1602 intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1603 # intl does not use global config.h
1604 intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1606 intlenv.Append(CCFLAGS = [
1607 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1608 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1609 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1611 '-DENABLE_RELOCATABLE=1',
1613 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1615 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1616 '-Drelocate=libintl_relocate',
1617 '-DDEPENDS_ON_LIBICONV=1',
1622 intl = intlenv.StaticLibrary(
1623 target = '$LOCALLIBPATH/included_intl',
1625 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1631 # Now, src code under src/
1633 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1640 print "Processing files in src/support..."
1642 frontend_env.Depends('$BUILDDIR/common/support/Package.cpp', '$BUILDDIR/common/config.h')
1643 env.substFile('$BUILDDIR/common/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1645 support = frontend_env.StaticLibrary(
1646 target = '$LOCALLIBPATH/support',
1647 source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files],
1649 Alias('support', support)
1656 print "Processing files in src/mathed..."
1658 mathed = env.StaticLibrary(
1659 target = '$LOCALLIBPATH/mathed',
1660 source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1662 Alias('mathed', mathed)
1669 print "Processing files in src/insets..."
1671 insets = env.StaticLibrary(
1672 target = '$LOCALLIBPATH/insets',
1673 source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1675 Alias('insets', insets)
1682 print "Processing files in src/frontends..."
1684 frontends = env.StaticLibrary(
1685 target = '$LOCALLIBPATH/frontends',
1686 source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1688 Alias('frontends', frontends)
1695 print "Processing files in src/graphics..."
1697 graphics = env.StaticLibrary(
1698 target = '$LOCALLIBPATH/graphics',
1699 source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1701 Alias('graphics', graphics)
1704 if build_controllers:
1706 # src/frontends/controllers
1708 print "Processing files in src/frontends/controllers..."
1710 controllers = env.StaticLibrary(
1711 target = '$LOCALLIBPATH/controllers',
1712 source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1714 Alias('controllers', controllers)
1721 env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1723 print "Processing files in src/frontends/qt4..."
1725 qt4_moc_files = ["$BUILDDIR/common/frontends/qt4/%s" % x for x in src_frontends_qt4_moc_files]
1730 resources = [frontend_env.Uic4(x.split('.')[0]) for x in \
1731 ["$BUILDDIR/common/frontends/qt4/ui/%s" % x for x in src_frontends_qt4_ui_files]]
1734 # moc qt4_moc_files, the moced files are included in the original files
1736 qt4_moced_files = [frontend_env.Moc4(x.replace('.cpp', '_moc.cpp'), x.replace('.cpp', '.h')) for x in qt4_moc_files]
1738 qt4 = frontend_env.StaticLibrary(
1739 target = '$LOCALLIBPATH/qt4',
1740 source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1744 '$BUILDDIR/common/images',
1745 '$BUILDDIR/common/frontends',
1746 '$BUILDDIR/common/frontends/qt4',
1747 '$BUILDDIR/common/frontends/controllers'
1752 '-DQT_CLEAN_NAMESPACE',
1765 frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1767 print "Processing files in src/client..."
1769 if env['HAVE_FCNTL']:
1770 client = frontend_env.Program(
1771 target = '$BUILDDIR/common/client/lyxclient',
1772 LIBS = ['support'] + intl_libs + system_libs +
1773 socket_libs + boost_libraries + qtcore_lib,
1774 source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1775 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1777 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1778 client, [Copy('$TARGET', '$SOURCE')]))
1781 Alias('client', client)
1783 if env['HAVE_FCNTL']:
1784 # define client even if lyxclient is not built with rebuild=no
1785 client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1794 print "Processing files in src/tex2lyx..."
1797 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1798 frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1799 [Copy('$TARGET', '$SOURCE')])
1801 tex2lyx = frontend_env.Program(
1802 target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1803 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1804 source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1805 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1806 CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1807 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1809 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1810 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1811 Alias('tex2lyx', tex2lyx)
1813 # define tex2lyx even if tex2lyx is not built with rebuild=no
1814 tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1821 print "Processing files in src..."
1823 env.Depends('$BUILDDIR/common/version.cpp', '$BUILDDIR/common/config.h')
1824 env.substFile('$BUILDDIR/common/version.cpp', '$TOP_SRCDIR/src/version.cpp.in')
1826 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1827 src_post_files.append('ASpell.cpp')
1828 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1829 src_post_files.append('PSpell.cpp')
1830 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1831 src_post_files.append('ISpell.cpp')
1833 # msvc requires at least one source file with main()
1834 # so I exclude main.cpp from lyxbase
1835 lyxbase_pre = env.StaticLibrary(
1836 target = '$LOCALLIBPATH/lyxbase_pre',
1837 source = ['$BUILDDIR/common/%s' % x for x in src_pre_files]
1839 lyxbase_post = env.StaticLibrary(
1840 target = '$LOCALLIBPATH/lyxbase_post',
1841 source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1843 Alias('lyxbase', lyxbase_pre)
1844 Alias('lyxbase', lyxbase_post)
1849 # Build lyx with given frontend
1851 lyx = frontend_env.Program(
1852 target = '$BUILDDIR/lyx',
1853 source = ['$BUILDDIR/common/main.cpp'] + \
1854 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1874 # define lyx even if lyx is not built with rebuild=no
1875 lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1878 if build_msvs_projects:
1879 def build_project(target, full_target = None,
1880 src = [], inc = [], res = [], rebuildTargetOnly = True):
1881 ''' build mavs project files
1882 target: alias (correspond to directory name)
1883 full_target: full path/filename of the target
1887 rebuildTargetOnly: whether or not only rebuild this target
1889 For non-debug-able targets like static libraries, target (alias) is
1890 enough to build the target. For executable targets, msvs need to know
1891 the full path to start debug them.
1893 if rebuildTargetOnly:
1894 cmds = 'rebuild='+target
1897 if full_target is None:
1898 build_target = target
1900 build_target = full_target
1902 proj = env.MSVSProject(
1903 target = target + env['MSVSPROJECTSUFFIX'],
1904 # this allows easy access to header files (along with source)
1905 srcs = [env.subst(x) for x in src + inc],
1906 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1907 localincs = [env.subst(x) for x in inc],
1908 resources = [env.subst(x) for x in res],
1909 buildtarget = build_target,
1913 Alias('msvs_projects', proj)
1916 for lib in boost_libs:
1917 boost_src += ['$TOP_SRCDIR/boost/libs/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1918 build_project('boost', src = boost_src)
1920 build_project('intl', src = ['$TOP_SRCDIR/intl/%s' % x for x in intl_files],
1921 inc = ['$TOP_SRCDIR/intl/%s' % x for x in intl_header_files])
1923 build_project('support', src = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files],
1924 inc = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files])
1926 build_project('mathed', src = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files],
1927 inc = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files])
1929 build_project('insets', src = ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files],
1930 inc = ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files])
1932 build_project('frontends', src = ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files],
1933 inc = ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files])
1935 build_project('graphics', src = ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files],
1936 inc = ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files])
1938 build_project('controllers', src = ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files],
1939 inc = ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files])
1941 build_project('qt4', src = ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1942 inc = ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1943 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files])
1945 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1946 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1947 rebuildTargetOnly = False,
1948 full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1950 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1951 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1952 rebuildTargetOnly = False,
1953 full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1955 build_project('lyxbase', src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files],
1956 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files])
1957 build_project('lyx',
1958 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files] + \
1959 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files] + \
1960 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1961 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1962 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1963 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1964 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1965 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1966 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1967 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1968 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1969 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1970 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1971 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1972 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1973 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1974 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1975 rebuildTargetOnly = False,
1976 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1983 print 'Updating po/*.po files...'
1985 # whether or not update po files
1986 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1987 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1989 # rebuild POTFILES.in
1990 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1991 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files if x != 'version.cpp'] + \
1992 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files if x != 'Package.cpp'] + \
1993 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1994 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1995 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1996 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1997 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
1998 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
1999 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
2000 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ] + \
2001 ['$TOP_SRCDIR/src/version.cpp.in', '$TOP_SRCDIR/src/support/Package.cpp.in',\
2002 '$TOP_SRCDIR/src/ASpell.cpp', '$TOP_SRCDIR/src/ISpell.cpp', '$TOP_SRCDIR/src/PSpell.cpp']
2004 Alias('update_po', POTFILES_in)
2005 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot
2006 # and combine them to lyx.po
2007 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
2008 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
2009 env.Command('$BUILDDIR/po/all.po',
2010 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
2011 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
2012 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
2013 env.Command('$BUILDDIR/po/layouts_l10n.pot',
2014 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files],
2015 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2016 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
2017 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2018 env.Command('$BUILDDIR/po/ui_l10n.pot',
2019 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2020 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2022 ['$MSGUNIQ -o $TARGET $SOURCE',
2023 '''$XGETTEXT --default-domain=${TARGET.base} \
2024 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2025 --language=C++ --join-existing --keyword=_ --keyword=N_ --keyword=qt_ \
2026 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2027 --copyright-holder="LyX Developers" \
2028 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2030 env.Depends(lyx_po, POTFILES_in)
2031 # copy lyx.po to lyx.pot
2032 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2033 Copy('$TARGET', '$SOURCE'))
2036 # files to translate
2037 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2038 # possibly *only* handle these languages
2040 if env.has_key('languages'):
2041 languages = env.make_list(env['languages'])
2042 # merge. if I use lan.po as $TARGET, it will be removed
2043 # before it is merged. In this builder,
2044 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2045 # and is copied to po/lang.po
2046 env['BUILDERS']['msgmerge'] = Builder(action=[
2047 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2048 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2050 # for each po file, generate pot
2051 for po_file in transfiles:
2053 fname = os.path.split(po_file)[1]
2055 country = fname.split('.')[0]
2057 if not languages or country in languages:
2058 # merge po files, the generated lan.po_new file is copied to lan.po file.
2059 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2060 env.Depends(po, POTFILES_in)
2061 Alias('update_po', po)
2068 print 'Processing files in po...'
2073 # files to translate
2074 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2075 # possibly *only* handle these languages
2077 if env.has_key('languages'):
2078 languages = env.make_list(env['lanauges'])
2079 # use defulat msgfmt
2081 if not env['MSGFMT']:
2082 print 'msgfmt does not exist. Can not process po files'
2085 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2087 for f in transfiles:
2089 fname = os.path.split(f)[1]
2091 country = fname.split('.')[0]
2093 if not languages or country in languages:
2094 gmo_files.extend(env.Transfiles(f))
2099 # this part is a bit messy right now. Since scons will provide
2100 # --DESTDIR option soon, at least the dest_dir handling can be
2103 # how to join dest_dir and prefix
2104 def joinPaths(path1, path2):
2105 ''' join path1 and path2, do not use os.path.join because
2106 under window, c:\destdir\d:\program is invalid '''
2108 return os.path.normpath(path2)
2109 # separate drive letter
2110 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2111 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2112 return os.path.join(os.path.normpath(path1), path[1:])
2114 # install to dest_dir/prefix
2115 dest_dir = env.get('DESTDIR', '')
2116 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2117 # create the directory if needed
2118 if not os.path.isdir(dest_prefix_dir):
2120 os.makedirs(dest_prefix_dir)
2123 if not os.path.isdir(dest_prefix_dir):
2124 print 'Can not create directory', dest_prefix_dir
2127 if env.has_key('exec_prefix'):
2128 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2130 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2132 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2134 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2135 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2136 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2137 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2141 # install executables (lyxclient may be None)
2144 version_suffix = program_suffix
2148 # install lyx, if in release mode, try to strip the binary
2149 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2150 # create a builder to strip and install
2151 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2153 # install executables
2154 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2157 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2158 target = os.path.join(bin_dest_dir, target_name)
2159 if env['BUILDERS'].has_key('StripInstallAs'):
2160 env.StripInstallAs(target, obj)
2162 env.InstallAs(target, obj)
2163 Alias('install', target)
2167 for (dir,files) in [
2169 ('bind', lib_bind_files),
2170 ('bind/de', lib_bind_de_files),
2171 ('bind/fi', lib_bind_fi_files),
2172 ('bind/pt', lib_bind_pt_files),
2173 ('bind/sv', lib_bind_sv_files),
2174 ('doc', lib_doc_files),
2175 ('doc/clipart', lib_doc_clipart_files),
2176 ('doc/cs', lib_doc_cs_files),
2177 ('doc/da', lib_doc_da_files),
2178 ('doc/de', lib_doc_de_files),
2179 ('doc/es', lib_doc_es_files),
2180 ('doc/es/clipart', lib_doc_es_clipart_files),
2181 ('doc/eu', lib_doc_eu_files),
2182 ('doc/fr', lib_doc_fr_files),
2183 ('doc/he', lib_doc_he_files),
2184 ('doc/hu', lib_doc_hu_files),
2185 ('doc/it', lib_doc_it_files),
2186 ('doc/nl', lib_doc_nl_files),
2187 ('doc/nb', lib_doc_nb_files),
2188 ('doc/pl', lib_doc_pl_files),
2189 ('doc/pt', lib_doc_pt_files),
2190 ('doc/ro', lib_doc_ro_files),
2191 ('doc/ru', lib_doc_ru_files),
2192 ('doc/sk', lib_doc_sk_files),
2193 ('doc/sl', lib_doc_sl_files),
2194 ('doc/sv', lib_doc_sv_files),
2195 ('examples', lib_examples_files),
2196 ('examples/ca', lib_examples_ca_files),
2197 ('examples/cs', lib_examples_cs_files),
2198 ('examples/da', lib_examples_da_files),
2199 ('examples/de', lib_examples_de_files),
2200 ('examples/es', lib_examples_es_files),
2201 ('examples/eu', lib_examples_eu_files),
2202 ('examples/fr', lib_examples_fr_files),
2203 ('examples/he', lib_examples_he_files),
2204 ('examples/hu', lib_examples_hu_files),
2205 ('examples/it', lib_examples_it_files),
2206 ('examples/nl', lib_examples_nl_files),
2207 ('examples/pl', lib_examples_pl_files),
2208 ('examples/pt', lib_examples_pt_files),
2209 ('examples/ru', lib_examples_ru_files),
2210 ('examples/sl', lib_examples_sl_files),
2211 ('examples/ro', lib_examples_ro_files),
2212 ('fonts', lib_fonts_files),
2213 ('images', lib_images_files),
2214 ('images/math', lib_images_math_files),
2215 ('kbd', lib_kbd_files),
2216 ('layouts', lib_layouts_files),
2217 ('lyx2lyx', lib_lyx2lyx_files),
2218 ('scripts', lib_scripts_files),
2219 ('templates', lib_templates_files),
2220 ('tex', lib_tex_files),
2221 ('ui', lib_ui_files)]:
2222 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2223 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2224 Alias('install', dirs)
2226 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2227 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2228 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2229 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2230 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2231 sys.path.append(share_dest_dir + '/lyx2lyx')
2233 # generate TOC files for each doc
2234 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2236 for lang in languages.keys():
2237 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2238 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2241 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2242 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2244 # this is for English
2245 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2248 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2249 Alias('install', tocs)
2251 if platform_name == 'cygwin':
2252 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2253 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2254 '%s-%s.README' % (package, package_cygwin_version))
2255 env.InstallAs(Cygwin_README,
2256 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2257 Alias('install', Cygwin_README)
2258 # also a directory /usr/share/doc/lyx for README etc
2259 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2260 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2261 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2262 Alias('install', Cygwin_Doc)
2263 # cygwin fonts also need to be installed
2264 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2265 env.Install(Cygwin_fonts,
2266 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2267 for file in win32_bakoma_fonts])
2268 Alias('install', Cygwin_fonts)
2269 # we also need a post installation script
2270 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2271 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2272 env.Install(postinstall_path, tmp_script)
2273 Alias('install', postinstall_path)
2277 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2278 env.subst('$TOP_SRCDIR/lyx.man'))
2279 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2280 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2281 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2282 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2283 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2284 x in ['lyx', 'tex2lyx', 'lyxclient']])
2286 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2287 for gmo in gmo_files:
2288 lan = os.path.split(str(gmo))[1].split('.')[0]
2289 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2290 env.InstallAs(dest_file, gmo)
2291 Alias('install', dest_file)
2296 # build windows installer using NSIS
2299 # There is a nsis builder on scons wiki but it does not work with
2300 # our lyx.nsi because it does not dig through all the include directives
2301 # and find the dependencies automatically. Also, it can not parse
2302 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2303 # something rely on date.
2304 # Because of this, I am doing a simple nsis builder here.
2305 if platform_name != 'win32':
2306 print 'installer target is only available for windows platform'
2308 if mode != 'release':
2309 print 'installer has to be built in release mode (use option mode=release)'
2311 if env.has_key('NSIS') and env['NSIS'] is not None:
2312 # create a builder to strip and install
2313 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2315 print 'No nsis compiler is found. Existing...'
2317 if not env.has_key('win_installer') or env['win_installer'] is None:
2319 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2321 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2322 # provide default setting
2323 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2324 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2325 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2326 print 'Development dependency package is not found.'
2329 env['deps_dir'] = env.Dir('$deps_dir').abspath
2331 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2332 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2333 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2334 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2336 env['bundle_dir'] = None
2337 # if absolute path is given, use it, otherwise, write to current directory
2338 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2339 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2340 env.Append(NSISDEFINES={
2341 'ExeFile':env['win_installer'],
2342 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2343 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2344 'FilesDeps':env['deps_dir'],
2345 'FilesBundle':env['bundle_dir'],
2347 installer = env.installer(env['win_installer'],
2348 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2349 # since I can not use a scanner, explicit dependent is required
2350 env.Depends(installer, 'install')
2351 env.Alias('installer', installer)
2352 # also generate bundle?
2353 if env.has_key('bundle') and env['bundle']:
2354 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2355 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2356 print 'Use bundle_dir option to specify'
2358 # generator of the builder will add bundle stuff depending on output name
2359 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2360 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2361 env.Depends(bundle_installer, 'install')
2362 env.Alias('installer', bundle_installer)
2365 Alias('all', ['lyx', 'client', 'tex2lyx'])