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.C.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.C.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.C.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.C.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')
722 # if under windows, check the nsis compiler
723 if platform_name == 'win32':
724 env['NSIS'] = conf.CheckNSIS()
726 # cygwin packaging requires the binaries to be stripped
727 if platform_name == 'cygwin':
728 env['STRIP'] = conf.CheckCommand('strip')
731 # Customized builders
733 # install customized builders
734 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
735 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
738 #----------------------------------------------------------
739 # Generating config.h
740 #----------------------------------------------------------
741 aspell_lib = 'aspell'
742 # assume that we use aspell, aspelld compiled for msvc
743 if platform_name == 'win32' and mode == 'debug' and use_vc:
744 aspell_lib = 'aspelld'
746 # check the existence of config.h
747 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
748 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
750 print "Creating %s..." % boost_config_h
752 utils.createConfigFile(conf,
753 config_file = boost_config_h,
754 config_pre = '''/* boost/config.h. Generated by SCons. */
759 * This file is part of LyX, the document processor.
760 * Licence details can be found in the file COPYING.
762 * This is the compilation configuration file for LyX.
763 * It was generated by scon.
764 * You might want to change some of the defaults if something goes wrong
765 * during the compilation.
768 #ifndef _BOOST_CONFIG_H
769 #define _BOOST_CONFIG_H
772 ('ostream', 'HAVE_OSTREAM', 'cxx'),
773 ('locale', 'HAVE_LOCALE', 'cxx'),
774 ('sstream', 'HAVE_SSTREAM', 'cxx'),
775 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
778 (env.has_key('assertions') and env['assertions'],
780 'Define if you want assertions to be enabled in the code'
784 ('wchar_t', 'HAVE_WCHAR_T', None),
788 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
789 # define USE_BOOST_FORMAT 1
791 # define USE_BOOST_FORMAT 0
794 #if !defined(ENABLE_ASSERTIONS)
795 # define BOOST_DISABLE_ASSERTS 1
797 #define BOOST_ENABLE_ASSERT_HANDLER 1
799 #define BOOST_DISABLE_THREADS 1
800 #define BOOST_NO_WSTRING 1
803 # define BOOST_POSIX 1
804 # define BOOST_POSIX_API 1
805 # define BOOST_POSIX_PATH 1
808 #define BOOST_ALL_NO_LIB 1
810 #if defined(HAVE_NEWAPIS_H)
811 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
814 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4
815 # define LIBC_WCTYPE_USES_UCS4
822 print "\nGenerating %s..." % config_h
824 # AIKSAURUS_H_LOCATION
825 if (conf.CheckCXXHeader("Aiksaurus.h")):
826 aik_location = '<Aiksaurus.h>'
827 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
828 aik_location = '<Aiksaurus/Aiksaurus.h>'
832 # determine headers to use
833 spell_opt = ARGUMENTS.get('spell', 'auto')
834 env['USE_ASPELL'] = False
835 env['USE_PSPELL'] = False
836 env['USE_ISPELL'] = False
837 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
838 spell_engine = 'USE_ASPELL'
839 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
840 spell_engine = 'USE_PSPELL'
841 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
842 spell_engine = 'USE_ISPELL'
846 if spell_engine is not None:
847 env[spell_engine] = True
849 if spell_opt == 'auto':
850 print "Warning: Can not locate any spell checker"
851 elif spell_opt != 'no':
852 print "Warning: Can not locate specified spell checker:", spell_opt
855 # check arg types of select function
856 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
858 # check the size of wchar_t
859 sizeof_wchar_t = conf.CheckSizeOfWChar()
861 if sizeof_wchar_t == 0:
862 print 'Error: Can not determine the size of wchar_t.'
867 result = utils.createConfigFile(conf,
868 config_file = config_h,
869 config_pre = '''/* config.h. Generated by SCons. */
874 * This file is part of LyX, the document processor.
875 * Licence details can be found in the file COPYING.
877 * This is the compilation configuration file for LyX.
878 * It was generated by scon.
879 * You might want to change some of the defaults if something goes wrong
880 * during the compilation.
887 ('io.h', 'HAVE_IO_H', 'c'),
888 ('limits.h', 'HAVE_LIMITS_H', 'c'),
889 ('locale.h', 'HAVE_LOCALE_H', 'c'),
890 ('process.h', 'HAVE_PROCESS_H', 'c'),
891 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
892 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
893 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
894 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
895 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
896 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
897 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
898 ('utime.h', 'HAVE_UTIME_H', 'c'),
899 ('direct.h', 'HAVE_DIRECT_H', 'c'),
900 ('istream', 'HAVE_ISTREAM', 'cxx'),
901 ('ios', 'HAVE_IOS', 'cxx'),
904 ('open', 'HAVE_OPEN', None),
905 ('chmod', 'HAVE_CHMOD', None),
906 ('close', 'HAVE_CLOSE', None),
907 ('popen', 'HAVE_POPEN', None),
908 ('pclose', 'HAVE_PCLOSE', None),
909 ('_open', 'HAVE__OPEN', None),
910 ('_close', 'HAVE__CLOSE', None),
911 ('_popen', 'HAVE__POPEN', None),
912 ('_pclose', 'HAVE__PCLOSE', None),
913 ('getpid', 'HAVE_GETPID', None),
914 ('_getpid', 'HAVE__GETPID', None),
915 ('mkdir', 'HAVE_MKDIR', None),
916 ('_mkdir', 'HAVE__MKDIR', None),
917 ('mktemp', 'HAVE_MKTEMP', None),
918 ('mkstemp', 'HAVE_MKSTEMP', None),
919 ('strerror', 'HAVE_STRERROR', None),
920 ('count', 'HAVE_STD_COUNT', '''
925 return std::count(a, a+5, 'l');
928 ('getcwd', 'HAVE_GETCWD', None),
929 ('setenv', 'HAVE_SETENV', None),
930 ('putenv', 'HAVE_PUTENV', None),
931 ('fcntl', 'HAVE_FCNTL', None),
934 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
935 '#include <streambuf>\n#include <istream>'),
936 ('wchar_t', 'HAVE_WCHAR_T', None),
937 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
940 ('gdi32', 'HAVE_LIBGDI32'),
941 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
944 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
946 'Define is sys/types.h does not have pid_t',
950 (conf.CheckCXXGlobalCstd(),
952 'Define if your C++ compiler puts C library functions in the global namespace'
954 (conf.CheckMkdirOneArg(),
955 'MKDIR_TAKES_ONE_ARG',
956 'Define if mkdir takes only one argument.'
958 (conf.CheckIconvConst(),
960 'Define as const if the declaration of iconv() needs const.',
961 '#define ICONV_CONST const',
962 '#define ICONV_CONST',
964 (conf.CheckLC_MESSAGES(),
966 'Define if your <locale.h> file defines LC_MESSAGES.'
968 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
971 "Define to 1 if translation of program messages to the user's native anguage is requested.",
973 (env['nls'] and not included_gettext,
975 'Define to 1 if using system gettext library'
977 (env.has_key('warnings') and env['warnings'],
979 'Define this if you want to see the warning directives put here and there by the developpers to get attention'
981 (env.has_key('concept_checks') and env['concept_checks'],
982 '_GLIBCXX_CONCEPT_CHECKS',
983 'libstdc++ concept checking'
985 (env.has_key('stdlib_debug') and env['stdlib_debug'],
987 'libstdc++ debug mode'
989 (env.has_key('stdlib_debug') and env['stdlib_debug'],
990 '_GLIBCXX_DEBUG_PEDANTIC',
991 'libstdc++ pedantic debug mode'
993 (os.name != 'nt', 'BOOST_POSIX',
994 'Indicates to boost < 1.34 which API to use (posix or windows).'
996 (os.name != 'nt', 'BOOST_POSIX_API',
997 'Indicates to boost 1.34 which API to use (posix or windows).'
999 (os.name != 'nt', 'BOOST_POSIX_PATH',
1000 'Indicates to boost 1.34 which path style to use (posix or windows).'
1002 (spell_engine is not None, spell_engine,
1003 'Spell engine to use'
1005 # we need to know the byte order for unicode conversions
1006 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1007 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1011 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1013 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1014 'Define to the address where bug reports for this package should be sent.'),
1015 ('#define PACKAGE_NAME "%s"' % package_name,
1016 'Define to the full name of this package.'),
1017 ('#define PACKAGE_STRING "%s"' % package_string,
1018 'Define to the full name and version of this package.'),
1019 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1020 'Define to the one symbol short name of this package.'),
1021 ('#define PACKAGE_VERSION "%s"' % package_version,
1022 'Define to the version of this package.'),
1023 ('#define BOOST_ALL_NO_LIB 1',
1024 'disable automatic linking of boost libraries.'),
1025 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1026 'Packaging method'),
1027 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1028 'Aiksaurus include file'),
1029 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1030 "Define to the type of arg 1 for `select'."),
1031 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1032 "Define to the type of arg 2, 3, 4 for `select'."),
1033 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1034 "Define to the type of arg 5 for `select'."),
1035 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1036 'Define to be the size of type wchar_t'),
1038 config_post = '''/************************************************************
1039 ** You should not need to change anything beyond this point */
1041 #ifndef HAVE_STRERROR
1042 #if defined(__cplusplus)
1045 char * strerror(int n);
1049 #ifndef HAVE_DECL_MKSTEMP
1050 #if defined(__cplusplus)
1057 #include <../boost/config.h>
1063 # these keys are needed in env
1064 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1065 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1066 # USE_ASPELL etc does not go through result
1067 if result.has_key(key):
1068 env[key] = result[key]
1071 # if nls=yes and gettext=included, create intl/config.h
1072 # intl/libintl.h etc
1074 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1075 if env['nls'] and included_gettext:
1077 print "Creating %s..." % intl_config_h
1079 # create intl/config.h
1080 result = utils.createConfigFile(conf,
1081 config_file = intl_config_h,
1082 config_pre = '''/* intl/config.h. Generated by SCons. */
1087 * This file is part of LyX, the document processor.
1088 * Licence details can be found in the file COPYING.
1090 * This is the compilation configuration file for LyX.
1091 * It was generated by scon.
1092 * You might want to change some of the defaults if something goes wrong
1093 * during the compilation.
1100 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1101 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1102 ('string.h', 'HAVE_STRING_H', 'c'),
1103 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1104 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1105 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1106 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1107 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1108 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1109 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1112 ('getcwd', 'HAVE_GETCWD', None),
1113 ('stpcpy', 'HAVE_STPCPY', None),
1114 ('strcasecmp', 'HAVE_STRCASECMP', None),
1115 ('strdup', 'HAVE_STRDUP', None),
1116 ('strtoul', 'HAVE_STRTOUL', None),
1117 ('alloca', 'HAVE_ALLOCA', None),
1118 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1119 ('mempcpy', 'HAVE_MEMPCPY', None),
1120 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1121 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1122 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1123 ('setlocale', 'HAVE_SETLOCALE', None),
1124 ('tsearch', 'HAVE_TSEARCH', None),
1125 ('getegid', 'HAVE_GETEGID', None),
1126 ('getgid', 'HAVE_GETGID', None),
1127 ('getuid', 'HAVE_GETUID', None),
1128 ('wcslen', 'HAVE_WCSLEN', None),
1129 ('asprintf', 'HAVE_ASPRINTF', None),
1130 ('wprintf', 'HAVE_WPRINTF', None),
1131 ('snprintf', 'HAVE_SNPRINTF', None),
1132 ('printf', 'HAVE_POSIX_PRINTF', None),
1133 ('fcntl', 'HAVE_FCNTL', None),
1136 ('intmax_t', 'HAVE_INTMAX_T', None),
1137 ('long double', 'HAVE_LONG_DOUBLE', None),
1138 ('long long', 'HAVE_LONG_LONG', None),
1139 ('wchar_t', 'HAVE_WCHAR_T', None),
1140 ('wint_t', 'HAVE_WINT_T', None),
1141 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1142 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1148 (conf.CheckLC_MESSAGES(),
1150 'Define if your <locale.h> file defines LC_MESSAGES.'
1152 (conf.CheckIconvConst(),
1154 'Define as const if the declaration of iconv() needs const.',
1155 '#define ICONV_CONST const',
1156 '#define ICONV_CONST',
1158 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1159 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1161 "Define to 1 if you have the `intmax_t' type."
1163 (env.has_key('nls') and env['nls'],
1165 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1169 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1170 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1171 'Define to be the size of type wchar_t'),
1173 config_post = '#endif'
1176 # these keys are needed in env
1177 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1178 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1179 # USE_ASPELL etc does not go through result
1180 if result.has_key(key):
1181 env[key] = result[key]
1184 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1185 if env['nls'] and included_gettext:
1186 # libgnuintl.h.in => libintl.h
1187 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1188 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1189 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1190 [Copy('$TARGET', '$SOURCE')])
1193 # Finish auto-configuration
1196 #----------------------------------------------------------
1197 # Now set up our build process accordingly
1198 #----------------------------------------------------------
1200 if env['ICONV_LIB'] is None:
1203 system_libs = [env['ICONV_LIB']]
1204 if platform_name in ['win32', 'cygwin']:
1205 # the final link step needs stdc++ to succeed under mingw
1206 # FIXME: shouldn't g++ automatically link to stdc++?
1208 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1210 system_libs += ['shlwapi', 'stdc++', 'z']
1211 elif platform_name == 'cygwin' and env['X11']:
1212 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1213 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1214 'resolv', 'pthread', 'z']
1216 system_libs += ['z']
1219 ('HAVE_LIBGDI32', 'gdi32'),
1220 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1221 ('USE_ASPELL', aspell_lib),
1222 ('USE_ISPELL', 'ispell'),
1223 ('USE_PSPELL', 'pspell'),
1228 system_libs.append(lib[1])
1231 # Build parameters CPPPATH etc
1234 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1237 # boost: for boost header files
1238 # BUILDDIR/common: for config.h
1239 # TOP_SRCDIR/src: for support/* etc
1241 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1243 # Separating boost directories from CPPPATH stops scons from building
1244 # the dependency tree for boost header files, and effectively reduce
1245 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1246 # boost headers, this is only done for system boost headers.
1248 env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1251 env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1253 env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1255 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1256 if env['nls'] and included_gettext:
1257 env['CPPPATH'].append('$BUILDDIR/intl')
1261 # A Link script for cygwin see
1262 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1263 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1266 if platform_name == 'cygwin':
1267 ld_script_path = '/tmp'
1268 ld_script = utils.installCygwinLDScript(ld_script_path)
1269 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1270 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1273 #---------------------------------------------------------
1274 # Frontend related variables (QTDIR etc)
1275 #---------------------------------------------------------
1278 # create a separate environment so that other files do not have
1279 # to be built with all the include directories etc
1281 if frontend == 'qt4':
1282 frontend_env = env.Copy()
1284 # handle qt related user specified paths
1285 # set environment so that moc etc can be found even if its path is not set properly
1286 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1287 frontend_env['QTDIR'] = frontend_env['qt_dir']
1288 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1289 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1290 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1291 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1292 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1294 # if separate qt_lib_path is given
1295 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1296 qt_lib_path = frontend_env.subst('$qt_lib_path')
1297 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1298 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1302 # if separate qt_inc_path is given
1303 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1304 qt_inc_path = frontend_env['qt_inc_path']
1308 # local qt4 toolset from
1309 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1311 # NOTE: I have to patch qt4.py since it does not automatically
1312 # process .C file!!! (add to cxx_suffixes )
1314 frontend_env.Tool('qt4', [scons_dir])
1315 frontend_env['QT_AUTOSCAN'] = 0
1316 frontend_env['QT4_AUTOSCAN'] = 0
1317 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1319 if qt_lib_path is None:
1320 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1321 if qt_inc_path is None:
1322 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1325 conf = Configure(frontend_env,
1327 'CheckPackage' : utils.checkPackage,
1328 'CheckCommand' : utils.checkCommand,
1333 # first: try pkg_config
1334 if frontend_env['HAS_PKG_CONFIG']:
1335 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1336 # FIXME: use pkg_config information?
1337 #frontend_env['QT4_PKG_CONFIG'] = succ
1338 # second: try to link to it
1340 # Under linux, I can test the following perfectly
1341 # Under windows, lib names need to passed as libXXX4.a ...
1342 if platform_name == 'win32':
1343 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1345 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1346 # still can not find it
1348 print 'Did not find qt libraries, exiting!'
1351 # Now, determine the correct suffix:
1352 qt_libs = ['QtCore', 'QtGui']
1353 if platform_name == 'win32':
1354 if mode == 'debug' and use_vc and \
1355 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1356 qt_lib_suffix = 'd4'
1357 use_qt_debug_libs = True
1360 use_qt_debug_libs = False
1362 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1363 qt_lib_suffix = '_debug'
1364 use_qt_debug_libs = True
1367 use_qt_debug_libs = False
1368 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1369 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1370 qtcore_lib = ['QtCore' + qt_lib_suffix]
1372 # check uic and moc commands for qt frontends
1373 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1374 print 'uic or moc command is not found for frontend', frontend
1377 # now, if msvc2005 is used, we will need that QT_LIB_PATH/QT_LIB.manifest file
1380 if qt_lib_path is not None:
1381 manifest = os.path.join(qt_lib_path, 'QtGuid4.dll.manifest')
1383 manifest = 'QtGuid4.dll.manifest'
1385 if qt_lib_path is not None:
1386 manifest = os.path.join(qt_lib_path, 'QtGui4.dll.manifest')
1388 manifest = 'QtGui4.dll.manifest'
1389 if os.path.isfile(manifest):
1390 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % manifest]
1392 frontend_env = conf.Finish()
1397 # fill in the version info
1398 env['VERSION_INFO'] = '''Configuration
1400 Special build flags: %s
1402 C Compiler flags: %s %s
1404 C++ Compiler LyX flags: %s
1405 C++ Compiler flags: %s %s
1407 Linker user flags: %s
1409 Builing directory: %s
1410 Local library directory: %s
1413 Frontend libraries: %s
1414 System libraries: %s
1415 include search path: %s
1421 ''' % (platform_name,
1422 env.subst('$CCFLAGS'), env.subst('$CC'),
1423 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1424 env.subst('$CXX'), env.subst('$CXXFLAGS'),
1425 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1426 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1427 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1428 str(env['LIBPATH']), str(boost_libraries),
1429 str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1430 frontend, packaging_method,
1431 prefix, env['LYX_DIR'])
1433 if frontend in ['qt4']:
1434 env['VERSION_INFO'] += ''' include dir: %s
1437 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1439 print env['VERSION_INFO']
1442 # Mingw command line may be too short for our link usage,
1443 # Here we use a trick from scons wiki
1444 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1446 # I also would like to add logging (commands only) capacity to the
1448 logfile = env.get('logfile', default_log_file)
1449 if logfile != '' or platform_name == 'win32':
1451 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1452 info = '''# This is a log of commands used by scons to build lyx
1456 ''' % (time.asctime(), ' '.join(sys.argv),
1457 env['VERSION_INFO'].replace('\n','\n# ')) )
1462 # -h will print out help info
1463 Help(opts.GenerateHelpText(env))
1467 #----------------------------------------------------------
1469 #----------------------------------------------------------
1470 # this has been the source of problems on some platforms...
1471 # I find that I need to supply it with full path name
1472 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1473 # this usage needs further investigation.
1474 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1476 print "Building all targets recursively"
1478 if env.has_key('rebuild'):
1479 rebuild_targets = env['rebuild'].split(',')
1480 if 'none' in rebuild_targets or 'no' in rebuild_targets:
1481 rebuild_targets = []
1482 elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1483 # None: let scons decide which components to build
1484 # Forcing all components to be rebuilt is in theory not necessary
1485 rebuild_targets = None
1487 rebuild_targets = None
1489 def libExists(libname):
1490 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1491 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1493 def appExists(apppath, appname):
1494 ''' Check whether or not application already exists'''
1495 return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1497 targets = BUILD_TARGETS
1498 build_install = 'install' in targets or 'installer' in targets
1499 build_installer = 'installer' in targets
1500 # msvc need to pass full target name, so I have to look for path/lyx etc
1501 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1502 or build_install or 'all' in targets
1503 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1504 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1505 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1506 build_mathed = build_lyx or 'mathed' in targets
1507 build_insets = build_lyx or 'insets' in targets
1508 build_frontends = build_lyx or 'frontends' in targets
1509 build_graphics = build_lyx or 'graphics' in targets
1510 build_controllers = build_lyx or 'controllers' in targets
1511 build_client = True in ['client' in x for x in targets] \
1512 or build_install or 'all' in targets or build_installer
1513 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1514 or build_install or 'all' in targets or build_installer
1515 build_lyxbase = build_lyx or 'lyxbase' in targets
1516 update_po = 'update_po' in targets
1517 build_po = 'po' in targets or build_install or 'all' in targets
1518 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1519 build_msvs_projects = use_vc and 'msvs_projects' in targets
1522 # now, if rebuild_targets is specified, do not rebuild some targets
1523 if rebuild_targets is not None:
1525 def ifBuildLib(name, libname, old_value):
1526 # explicitly asked to rebuild
1527 if name in rebuild_targets:
1529 # else if not rebuild, and if the library already exists
1530 elif libExists(libname):
1532 # do not change the original value
1535 build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1536 build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1537 build_support = ifBuildLib('support', 'support', build_support)
1538 build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1539 build_insets = ifBuildLib('insets', 'insets', build_insets)
1540 build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1541 build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1542 build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1543 build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1544 build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1546 def ifBuildApp(name, appname, old_value):
1547 # explicitly asked to rebuild
1548 if name in rebuild_targets:
1550 # else if not rebuild, and if the library already exists
1551 elif appExists(name, appname):
1553 # do not change the original value
1556 build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1557 build_client = ifBuildApp('client', 'lyxclient', build_client)
1559 # sync frontend and frontend (?)
1569 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1571 boostenv = env.Copy()
1573 # boost use its own config.h
1574 boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1575 boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1577 for lib in boost_libs:
1578 print 'Processing files in boost/libs/%s/src...' % lib
1579 boostlib = boostenv.StaticLibrary(
1580 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1581 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1583 Alias('boost', boostlib)
1590 intlenv = env.Copy()
1592 print "Processing files in intl..."
1594 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1596 # we need the original C compiler for these files
1597 intlenv['CC'] = C_COMPILER
1598 intlenv['CCFLAGS'] = C_CCFLAGS
1600 intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1601 # intl does not use global config.h
1602 intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1604 intlenv.Append(CCFLAGS = [
1605 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1606 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1607 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1609 '-DENABLE_RELOCATABLE=1',
1611 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1613 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1614 '-Drelocate=libintl_relocate',
1615 '-DDEPENDS_ON_LIBICONV=1',
1620 intl = intlenv.StaticLibrary(
1621 target = '$LOCALLIBPATH/included_intl',
1623 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1629 # Now, src code under src/
1631 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1638 print "Processing files in src/support..."
1640 frontend_env.Depends('$BUILDDIR/common/support/package.C', '$BUILDDIR/common/config.h')
1641 env.substFile('$BUILDDIR/common/support/package.C', '$TOP_SRCDIR/src/support/package.C.in')
1643 support = frontend_env.StaticLibrary(
1644 target = '$LOCALLIBPATH/support',
1645 source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files],
1647 Alias('support', support)
1654 print "Processing files in src/mathed..."
1656 mathed = env.StaticLibrary(
1657 target = '$LOCALLIBPATH/mathed',
1658 source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1660 Alias('mathed', mathed)
1667 print "Processing files in src/insets..."
1669 insets = env.StaticLibrary(
1670 target = '$LOCALLIBPATH/insets',
1671 source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1673 Alias('insets', insets)
1680 print "Processing files in src/frontends..."
1682 frontends = env.StaticLibrary(
1683 target = '$LOCALLIBPATH/frontends',
1684 source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1686 Alias('frontends', frontends)
1693 print "Processing files in src/graphics..."
1695 graphics = env.StaticLibrary(
1696 target = '$LOCALLIBPATH/graphics',
1697 source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1699 Alias('graphics', graphics)
1702 if build_controllers:
1704 # src/frontends/controllers
1706 print "Processing files in src/frontends/controllers..."
1708 controllers = env.StaticLibrary(
1709 target = '$LOCALLIBPATH/controllers',
1710 source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1712 Alias('controllers', controllers)
1719 env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1721 print "Processing files in src/frontends/qt4..."
1723 qt4_moc_files = ["$BUILDDIR/common/frontends/qt4/%s" % x for x in src_frontends_qt4_moc_files]
1728 resources = [frontend_env.Uic4(x.split('.')[0]) for x in \
1729 ["$BUILDDIR/common/frontends/qt4/ui/%s" % x for x in src_frontends_qt4_ui_files]]
1732 # moc qt4_moc_files, the moced files are included in the original files
1734 qt4_moced_files = [frontend_env.Moc4(x.replace('.C', '_moc.cpp'), x.replace('.C', '.h')) for x in qt4_moc_files]
1736 qt4 = frontend_env.StaticLibrary(
1737 target = '$LOCALLIBPATH/qt4',
1738 source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1742 '$BUILDDIR/common/images',
1743 '$BUILDDIR/common/frontends',
1744 '$BUILDDIR/common/frontends/qt4',
1745 '$BUILDDIR/common/frontends/controllers'
1750 '-DQT_CLEAN_NAMESPACE',
1763 frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1765 print "Processing files in src/client..."
1767 if env['HAVE_FCNTL']:
1768 client = frontend_env.Program(
1769 target = '$BUILDDIR/common/client/lyxclient',
1770 LIBS = ['support'] + intl_libs + system_libs +
1771 socket_libs + boost_libraries + qtcore_lib,
1772 source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1773 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1775 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1776 client, [Copy('$TARGET', '$SOURCE')]))
1779 Alias('client', client)
1781 if env['HAVE_FCNTL']:
1782 # define client even if lyxclient is not built with rebuild=no
1783 client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1792 print "Processing files in src/tex2lyx..."
1795 for file in ['FloatList.C', 'Floating.C', 'counters.C', 'lyxlayout.h', 'lyxlayout.C',
1796 'lyxtextclass.h', 'lyxtextclass.C', 'lyxlex.C', 'lyxlex_pimpl.C']:
1797 frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1798 [Copy('$TARGET', '$SOURCE')])
1800 tex2lyx = frontend_env.Program(
1801 target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1802 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1803 source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files] + \
1804 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1805 CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1806 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1808 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1809 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1810 Alias('tex2lyx', tex2lyx)
1812 # define tex2lyx even if tex2lyx is not built with rebuild=no
1813 tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1820 print "Processing files in src..."
1822 env.Depends('$BUILDDIR/common/version.C', '$BUILDDIR/common/config.h')
1823 env.substFile('$BUILDDIR/common/version.C', '$TOP_SRCDIR/src/version.C.in')
1825 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1826 src_post_files.append('aspell.C')
1827 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1828 src_post_files.append('pspell.C')
1829 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1830 src_post_files.append('ispell.C')
1832 # msvc requires at least one source file with main()
1833 # so I exclude main.C from lyxbase
1834 lyxbase_pre = env.StaticLibrary(
1835 target = '$LOCALLIBPATH/lyxbase_pre',
1836 source = ['$BUILDDIR/common/%s' % x for x in src_pre_files]
1838 lyxbase_post = env.StaticLibrary(
1839 target = '$LOCALLIBPATH/lyxbase_post',
1840 source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1842 Alias('lyxbase', lyxbase_pre)
1843 Alias('lyxbase', lyxbase_post)
1848 # Build lyx with given frontend
1850 lyx = frontend_env.Program(
1851 target = '$BUILDDIR/lyx',
1852 source = ['$BUILDDIR/common/main.C'] + \
1853 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1873 # define lyx even if lyx is not built with rebuild=no
1874 lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1877 if build_msvs_projects:
1878 def build_project(target, full_target = None,
1879 src = [], inc = [], res = [], rebuildTargetOnly = True):
1880 ''' build mavs project files
1881 target: alias (correspond to directory name)
1882 full_target: full path/filename of the target
1886 rebuildTargetOnly: whether or not only rebuild this target
1888 For non-debug-able targets like static libraries, target (alias) is
1889 enough to build the target. For executable targets, msvs need to know
1890 the full path to start debug them.
1892 if rebuildTargetOnly:
1893 cmds = 'rebuild='+target
1896 if full_target is None:
1897 build_target = target
1899 build_target = full_target
1901 proj = env.MSVSProject(
1902 target = target + env['MSVSPROJECTSUFFIX'],
1903 # this allows easy access to header files (along with source)
1904 srcs = [env.subst(x) for x in src + inc],
1905 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1906 localincs = [env.subst(x) for x in inc],
1907 resources = [env.subst(x) for x in res],
1908 buildtarget = build_target,
1912 Alias('msvs_projects', proj)
1915 for lib in boost_libs:
1916 boost_src += ['$TOP_SRCDIR/boost/libs/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1917 build_project('boost', src = boost_src)
1919 build_project('intl', src = ['$TOP_SRCDIR/intl/%s' % x for x in intl_files],
1920 inc = ['$TOP_SRCDIR/intl/%s' % x for x in intl_header_files])
1922 build_project('support', src = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files],
1923 inc = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files])
1925 build_project('mathed', src = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files],
1926 inc = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files])
1928 build_project('insets', src = ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files],
1929 inc = ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files])
1931 build_project('frontends', src = ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files],
1932 inc = ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files])
1934 build_project('graphics', src = ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files],
1935 inc = ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files])
1937 build_project('controllers', src = ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files],
1938 inc = ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files])
1940 build_project('qt4', src = ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1941 inc = ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1942 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files])
1944 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1945 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1946 rebuildTargetOnly = False,
1947 full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1949 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1950 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1951 rebuildTargetOnly = False,
1952 full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1954 build_project('lyxbase', src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files],
1955 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files])
1956 build_project('lyx',
1957 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files] + \
1958 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files] + \
1959 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1960 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1961 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1962 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1963 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1964 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1965 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1966 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1967 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1968 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1969 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1970 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1971 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1972 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1973 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1974 rebuildTargetOnly = False,
1975 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1982 print 'Updating po/*.po files...'
1985 # files to translate
1986 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1987 # possibly *only* handle these languages
1989 if env.has_key('languages'):
1990 languages = env.make_list(env['lanauges'])
1991 # whether or not update po files
1992 if not env['XGETTEXT'] or not env['MSGMERGE']:
1993 print 'xgettext or msgmerge does not exist. Can not merge po files'
1995 # create a builder that generate
1996 env['XGETTEXT_OPTIONS'] = '--language=C++ --join-existing --keyword=_ --keyword=N_ --keyword=qt_'
1997 env['MSGMERGE_OPTIONS'] = '--update'
1998 env['COPYRIGHT_HOLDER'] = 'LyX Developers'
1999 env['MSGID_BUGS_ADDRESS'] = 'lyx-devel@lists.lyx.org'
2000 env['BUILDERS']['xgettext'] = Builder(action='''$XGETTEXT --default-domain=lyx \
2002 --directory=$TOP_SRCDIR \
2003 --add-comments=TRANSLATORS: $XGETTEXT_OPTIONS \
2004 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2005 --copyright-holder='$COPYRIGHT_HOLDER' \
2006 --msgid-bugs-address='$MSGID_BUGS_ADDRESS' ''')
2007 env['BUILDERS']['msgmerge'] = Builder(action='$MSGMERGE $MSGMERGE_OPTIONS $SOURCE $TARGET')
2009 env.xgettext('$BUILDDIR/common/lyx.pot', '$TOP_SRCDIR/po/POTFILES.in')
2010 # for each po file, generate pot
2011 for f in transfiles:
2013 fname = os.path.split(f)[1]
2015 country = fname.split('.')[0]
2017 if not languages or country in languages:
2019 env.msgmerge(f, '$BUILDDIR/common/lyx.pot')
2020 # build language_l10n.pot
2021 env['BUILDERS']['language_l10n'] = Builder(action=utils.env_language_l10n)
2022 tar1 = env.language_l10n('$BUILDDIR/common/language_l10n.pot', '$TOP_SRCDIR/lib/languages')
2023 env['BUILDERS']['qt4_l10n'] = Builder(action=utils.env_qt4_l10n)
2024 tar2 = env.qt4_l10n('$BUILDDIR/common/qt4_l10n.pot',
2025 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files])
2026 env['BUILDERS']['layouts_l10n'] = Builder(action=utils.env_layouts_l10n)
2027 tar3 = env.layouts_l10n('$BUILDDIR/common/layouts_l10n.pot',
2028 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files])
2029 env['BUILDERS']['ui_l10n'] = Builder(action=utils.env_ui_l10n)
2030 tar4 = env.ui_l10n('$BUILDDIR/common/ui_l10n.pot',
2031 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files])
2032 Alias('update_po', [tar1, tar2, tar3, tar4])
2039 print 'Processing files in po...'
2044 # files to translate
2045 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2046 # possibly *only* handle these languages
2048 if env.has_key('languages'):
2049 languages = env.make_list(env['lanauges'])
2050 # use defulat msgfmt
2052 if not env['MSGFMT']:
2053 print 'msgfmt does not exist. Can not process po files'
2056 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2058 for f in transfiles:
2060 fname = os.path.split(f)[1]
2062 country = fname.split('.')[0]
2064 if not languages or country in languages:
2065 gmo_files.extend(env.Transfiles(f))
2070 # this part is a bit messy right now. Since scons will provide
2071 # --DESTDIR option soon, at least the dest_dir handling can be
2074 # how to join dest_dir and prefix
2075 def joinPaths(path1, path2):
2076 ''' join path1 and path2, do not use os.path.join because
2077 under window, c:\destdir\d:\program is invalid '''
2079 return os.path.normpath(path2)
2080 # separate drive letter
2081 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2082 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2083 return os.path.join(os.path.normpath(path1), path[1:])
2085 # install to dest_dir/prefix
2086 dest_dir = env.get('DESTDIR', '')
2087 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2088 # create the directory if needed
2089 if not os.path.isdir(dest_prefix_dir):
2091 os.makedirs(dest_prefix_dir)
2094 if not os.path.isdir(dest_prefix_dir):
2095 print 'Can not create directory', dest_prefix_dir
2098 if env.has_key('exec_prefix'):
2099 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2101 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2103 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2105 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2106 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2107 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2108 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2112 # install executables (lyxclient may be None)
2115 version_suffix = program_suffix
2119 # install lyx, if in release mode, try to strip the binary
2120 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2121 # create a builder to strip and install
2122 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2124 # install executables
2125 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2128 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2129 target = os.path.join(bin_dest_dir, target_name)
2130 if env['BUILDERS'].has_key('StripInstallAs'):
2131 env.StripInstallAs(target, obj)
2133 env.InstallAs(target, obj)
2134 Alias('install', target)
2138 for (dir,files) in [
2140 ('images', lib_images_files),
2141 ('images/math', lib_images_math_files),
2142 ('kbd', lib_kbd_files),
2143 ('layouts', lib_layouts_files),
2144 ('scripts', lib_scripts_files),
2145 ('templates', lib_templates_files),
2146 ('tex', lib_tex_files),
2147 ('ui', lib_ui_files),
2148 ('bind', lib_bind_files),
2149 ('bind/de', lib_bind_de_files),
2150 ('bind/fi', lib_bind_fi_files),
2151 ('bind/pt', lib_bind_pt_files),
2152 ('bind/sv', lib_bind_sv_files),
2153 ('doc', lib_doc_files),
2154 ('doc/clipart', lib_doc_clipart_files),
2155 ('doc/cs', lib_doc_cs_files),
2156 ('doc/da', lib_doc_da_files),
2157 ('doc/de', lib_doc_de_files),
2158 ('doc/es', lib_doc_es_files),
2159 ('doc/es/clipart', lib_doc_es_clipart_files),
2160 ('doc/eu', lib_doc_eu_files),
2161 ('doc/fr', lib_doc_fr_files),
2162 ('doc/he', lib_doc_he_files),
2163 ('doc/hu', lib_doc_hu_files),
2164 ('doc/it', lib_doc_it_files),
2165 ('doc/nl', lib_doc_nl_files),
2166 ('doc/nb', lib_doc_nb_files),
2167 ('doc/pl', lib_doc_pl_files),
2168 ('doc/pt', lib_doc_pt_files),
2169 ('doc/ro', lib_doc_ro_files),
2170 ('doc/ru', lib_doc_ru_files),
2171 ('doc/sk', lib_doc_sk_files),
2172 ('doc/sl', lib_doc_sl_files),
2173 ('doc/sv', lib_doc_sv_files),
2174 ('examples', lib_examples_files),
2175 ('examples/ca', lib_examples_ca_files),
2176 ('examples/cs', lib_examples_cs_files),
2177 ('examples/da', lib_examples_da_files),
2178 ('examples/de', lib_examples_de_files),
2179 ('examples/es', lib_examples_es_files),
2180 ('examples/eu', lib_examples_eu_files),
2181 ('examples/fr', lib_examples_fr_files),
2182 ('examples/he', lib_examples_he_files),
2183 ('examples/hu', lib_examples_hu_files),
2184 ('examples/it', lib_examples_it_files),
2185 ('examples/nl', lib_examples_nl_files),
2186 ('examples/pl', lib_examples_pl_files),
2187 ('examples/pt', lib_examples_pt_files),
2188 ('examples/ru', lib_examples_ru_files),
2189 ('examples/sl', lib_examples_sl_files),
2190 ('examples/ro', lib_examples_ro_files),
2191 ('lyx2lyx', lib_lyx2lyx_files)]:
2192 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2193 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2194 Alias('install', dirs)
2196 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2197 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2198 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2199 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2200 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2201 sys.path.append(share_dest_dir + '/lyx2lyx')
2203 # generate TOC files for each doc
2204 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2206 for lang in languages.keys():
2207 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2208 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2211 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2212 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2214 # this is for English
2215 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2218 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2219 Alias('install', tocs)
2221 if platform_name == 'cygwin':
2222 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2223 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2224 '%s-%s.README' % (package, package_cygwin_version))
2225 env.InstallAs(Cygwin_README,
2226 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2227 Alias('install', Cygwin_README)
2228 # also a directory /usr/share/doc/lyx for README etc
2229 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2230 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2231 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2232 Alias('install', Cygwin_Doc)
2233 # cygwin fonts also need to be installed
2234 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2235 env.Install(Cygwin_fonts,
2236 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2237 for file in win32_bakoma_fonts])
2238 Alias('install', Cygwin_fonts)
2239 # we also need a post installation script
2240 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2241 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2242 env.Install(postinstall_path, tmp_script)
2243 Alias('install', postinstall_path)
2247 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2248 env.subst('$TOP_SRCDIR/lyx.man'))
2249 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2250 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2251 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2252 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2253 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2254 x in ['lyx', 'tex2lyx', 'lyxclient']])
2256 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2257 for gmo in gmo_files:
2258 lan = os.path.split(str(gmo))[1].split('.')[0]
2259 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2260 env.InstallAs(dest_file, gmo)
2261 Alias('install', dest_file)
2266 # build windows installer using NSIS
2269 # There is a nsis builder on scons wiki but it does not work with
2270 # our lyx.nsi because it does not dig through all the include directives
2271 # and find the dependencies automatically. Also, it can not parse
2272 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2273 # something rely on date.
2274 # Because of this, I am doing a simple nsis builder here.
2275 if platform_name != 'win32':
2276 print 'installer target is only available for windows platform'
2278 if env.has_key('NSIS') and env['NSIS'] is not None:
2279 # create a builder to strip and install
2280 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2282 print 'No nsis compiler is found. Existing...'
2284 if not env.has_key('win_installer') or env['win_installer'] is None:
2286 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2288 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2289 # provide default setting
2290 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2291 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2292 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2293 print 'Development dependency package is not found.'
2296 env['deps_dir'] = env.Dir('$deps_dir').abspath
2298 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2299 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2300 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2301 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2303 env['bundle_dir'] = None
2304 # if absolute path is given, use it, otherwise, write to current directory
2305 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2306 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2307 env.Append(NSISDEFINES={
2308 'ExeFile':env['win_installer'],
2309 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2310 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2311 'FilesDeps':env['deps_dir'],
2312 'FilesBundle':env['bundle_dir'],
2314 installer = env.installer(env['win_installer'],
2315 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2316 # since I can not use a scanner, explicit dependent is required
2317 env.Depends(installer, 'install')
2318 env.Alias('installer', installer)
2319 # also generate bundle?
2320 if env.has_key('bundle') and env['bundle']:
2321 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2322 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2323 print 'Use bundle_dir option to specify'
2325 # generator of the builder will add bundle stuff depending on output name
2326 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2327 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2328 env.Depends(bundle_installer, 'install')
2329 env.Alias('installer', bundle_installer)
2332 Alias('all', ['lyx', 'client', 'tex2lyx'])