1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 # This is a scons based building system for lyx, please refer
12 # to INSTALL.scons for detailed instructions.
15 import os, sys, copy, cPickle, glob, time
17 # determine where I am ...
19 from SCons.Node.FS import default_fs
20 # default_fs.SConstruct_dir is where SConstruct file is located.
21 scons_dir = default_fs.SConstruct_dir.path
22 scons_absdir = default_fs.SConstruct_dir.abspath
24 # if SConstruct is copied to the top source directory
25 if os.path.exists(os.path.join(scons_dir, 'development', 'scons', 'scons_manifest.py')):
26 scons_dir = os.path.join(scons_dir, 'development', 'scons')
27 scons_absdir = os.path.join(scons_absdir, 'development', 'scons')
28 # get the ../.. of scons_dir
29 top_src_dir = os.path.split(os.path.split(scons_absdir)[0])[0]
31 sys.path.extend([scons_absdir, os.path.join(top_src_dir, 'lib', 'doc')])
34 # scons_utils.py defines a few utility function
35 import scons_utils as utils
36 # import all file lists
37 from scons_manifest import *
39 #----------------------------------------------------------
40 # Required runtime environment
41 #----------------------------------------------------------
43 # scons asks for 1.5.2, lyx requires 2.3
44 EnsurePythonVersion(2, 3)
45 # Please use at least 0.96.92 (not 0.96.1)
46 EnsureSConsVersion(0, 96)
47 # also check for minor version number for scons 0.96
48 from SCons import __version__
49 # allow the use of snapshot version of scons
50 __version__ = __version__.split('d')[0]
51 version = map(int, __version__.split('.'))
52 if version[0] == 0 and version[1] == 96 and version[2] < 92:
53 print "Scons >= 0.96.92 is required."
57 #----------------------------------------------------------
59 #----------------------------------------------------------
61 # some global settings
63 # get version number from configure.ac so that JMarc does
64 # not have to change SConstruct during lyx release
65 package_version, lyx_date = utils.getVerFromConfigure(top_src_dir)
66 package_cygwin_version = '%s-1' % package_version
67 boost_version = ['1_34']
69 if 'svn' in package_version:
71 default_build_mode = 'debug'
74 default_build_mode = 'release'
77 package_bugreport = 'lyx-devel@lists.lyx.org'
79 package_tarname = 'lyx'
80 package_string = '%s %s' % (package_name, package_version)
82 # various cache/log files
83 default_log_file = 'scons_lyx.log'
84 opt_cache_file = 'opt.cache'
87 #----------------------------------------------------------
88 # platform dependent settings
89 #----------------------------------------------------------
92 platform_name = 'win32'
93 default_prefix = 'c:/program files/lyx'
94 default_with_x = False
95 default_packaging_method = 'windows'
96 elif os.name == 'posix' and sys.platform != 'cygwin':
97 platform_name = sys.platform
98 default_prefix = '/usr/local'
100 default_packaging_method = 'posix'
101 elif os.name == 'posix' and sys.platform == 'cygwin':
102 platform_name = 'cygwin'
103 default_prefix = '/usr'
104 default_with_x = True
105 default_packaging_method = 'posix'
106 elif os.name == 'darwin':
107 platform_name = 'macosx'
108 # FIXME: macOSX default prefix?
110 default_with_x = False
111 default_packaging_method = 'macosx'
112 else: # unsupported system, assume posix behavior
113 platform_name = 'others'
115 default_with_x = True
116 default_packaging_method = 'posix'
118 #---------------------------------------------------------
120 #----------------------------------------------------------
122 # You can set perminant default values in config.py
123 if os.path.isfile('config.py'):
124 print "Getting options from config.py..."
125 print open('config.py').read()
127 opts = Options(['config.py'])
130 EnumOption('frontend', 'Main GUI', 'qt4',
131 allowed_values = ('qt4',) ),
132 # debug or release build
133 EnumOption('mode', 'Building method', default_build_mode,
134 allowed_values = ('debug', 'release') ),
137 'Use included, system boost library, or try sytem boost first.',
138 'auto', allowed_values = (
139 'auto', # detect boost, if not found, use included
140 'included', # always use included boost
141 'system', # always use system boost, fail if can not find
144 EnumOption('gettext',
145 'Use included, system gettext library, or try sytem gettext first',
146 'auto', allowed_values = (
147 'auto', # detect gettext, if not found, use included
148 'included', # always use included gettext
149 'system', # always use system gettext, fail if can not find
152 EnumOption('spell', 'Choose spell checker to use.', 'auto',
153 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
155 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
156 allowed_values = ('windows', 'posix', 'macosx')),
158 BoolOption('fast_start', 'This option is obsolete.', False),
159 # No precompiled header support (too troublesome to make it work for msvc)
160 # BoolOption('pch', 'Whether or not use pch', False),
161 # enable assertion, (config.h has ENABLE_ASSERTIOS
162 BoolOption('assertions', 'Use assertions', True),
163 # config.h define _GLIBCXX_CONCEPT_CHECKS
164 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
165 BoolOption('concept_checks', 'Enable concept checks', True),
167 BoolOption('nls', 'Whether or not use native language support', True),
169 BoolOption('profiling', 'Whether or not enable profiling', False),
170 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
171 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
173 BoolOption('X11', 'Use x11 windows system', default_with_x),
174 # use MS VC++ to build lyx
175 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
177 PathOption('qt_dir', 'Path to qt directory', None),
179 PathOption('qt_inc_path', 'Path to qt include directory', None),
181 PathOption('qt_lib_path', 'Path to qt library directory', None),
182 # extra include and libpath
183 PathOption('extra_inc_path', 'Extra include path', None),
185 PathOption('extra_lib_path', 'Extra library path', None),
187 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
189 PathOption('extra_inc_path1', 'Extra include path', None),
191 PathOption('extra_lib_path1', 'Extra library path', None),
193 ('rebuild', 'Obsolete option', None),
194 # can be set to a non-existing directory
195 ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
196 # replace the default name and location of the windows installer
197 ('win_installer', 'name or full path to the windows installer', None),
198 # the deps package used to create minimal installer (qt and other libraries)
199 ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
200 # whether or not build bundle installer
201 BoolOption('bundle', 'Whether or not build bundle installer', False),
202 # the bundle directory, containing bundled applications
203 PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
204 # build directory, will use $mode if not set
205 ('build_dir', 'Build directory', None),
207 ('version_suffix', 'install lyx as lyx-suffix', None),
208 # how to load options
209 ('load_option', '''load option from previous scons run. option can be
210 yes (default): load all options
211 no: do not load any option
212 opt1,opt2: load specified options
213 -opt1,opt2: load all options other than specified ones''', 'yes'),
215 ('optimization', 'optimization CCFLAGS option.', None),
217 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
219 ('logfile', 'save commands (not outputs) to logfile', default_log_file),
220 # provided for backward compatibility
221 ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
222 # environment variable can be set as options.
223 ('DESTDIR', 'install to DESTDIR', None),
224 ('CC', 'replace default $CC', None),
225 ('LINK', 'replace default $LINK', None),
226 ('CPP', 'replace default $CPP', None),
227 ('CXX', 'replace default $CXX', None),
228 ('CXXCPP', 'replace default $CXXCPP', None),
229 ('CCFLAGS', 'replace default $CCFLAGS', None),
230 ('CPPFLAGS', 'replace default $CPPFLAGS', None),
231 ('LINKFLAGS', 'replace default $LINKFLAGS', None),
235 all_options = [x.key for x in opts.options]
237 # copied from SCons/Options/BoolOption.py
238 # We need to use them before a boolean ARGUMENTS option is available
240 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
241 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
243 if ARGUMENTS.has_key('fast_start'):
244 print 'fast_start option is obsolete'
246 # if load_option=yes (default), load saved comand line options
248 # This option can take value yes/no/opt1,opt2/-opt1,opt2
249 # and tries to be clever in choosing options to load
250 if (not ARGUMENTS.has_key('load_option') or \
251 ARGUMENTS['load_option'] not in false_strings) \
252 and os.path.isfile(opt_cache_file):
253 cache_file = open(opt_cache_file)
254 opt_cache = cPickle.load(cache_file)
256 # import cached options, but we should ignore qt_dir when frontend changes
257 if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
258 and ARGUMENTS['frontend'] != opt_cache['frontend'] \
259 and opt_cache.has_key('qt_dir'):
260 opt_cache.pop('qt_dir')
261 # and we do not cache some options (dest_dir is obsolete)
262 for arg in ['load_option', 'dest_dir', 'bundle']:
263 if opt_cache.has_key(arg):
265 # remove obsolete cached keys (well, SConstruct is evolving. :-)
266 for arg in opt_cache.keys():
267 if arg not in all_options:
268 print 'Option %s is obsolete, do not load it' % arg
270 # now, if load_option=opt1,opt2 or -opt1,opt2
271 if ARGUMENTS.has_key('load_option') and \
272 ARGUMENTS['load_option'] not in true_strings + false_strings:
273 # if -opt1,opt2 is specified, do not load these options
274 if ARGUMENTS['load_option'][0] == '-':
275 for arg in ARGUMENTS['load_option'][1:].split(','):
276 if opt_cache.has_key(arg):
278 # if opt1,opt2 is specified, only load specified options
280 args = ARGUMENTS['load_option'].split(',')
281 for arg in opt_cache.keys():
284 # now restore options as if entered from command line
285 for key in opt_cache.keys():
286 if not ARGUMENTS.has_key(key):
287 ARGUMENTS[key] = opt_cache[key]
288 print "Restoring cached option %s=%s" % (key, ARGUMENTS[key])
291 # check if there is unused (or misspelled) argument
292 for arg in ARGUMENTS.keys():
293 if arg not in all_options:
295 print "Unknown option '%s'... exiting." % arg
297 print "Available options are (check 'scons -help' for details):"
298 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
302 cache_file = open(opt_cache_file, 'w')
303 cPickle.dump(ARGUMENTS, cache_file)
306 #---------------------------------------------------------
307 # Setting up environment
308 #---------------------------------------------------------
310 # I do not really like ENV=os.environ, but you may add it
311 # here if you experience some environment related problem
312 env = Environment(options = opts)
314 # set individual variables since I do not really like ENV = os.environ
315 env['ENV']['PATH'] = os.environ.get('PATH')
316 env['ENV']['HOME'] = os.environ.get('HOME')
317 # these are defined for MSVC
318 env['ENV']['LIB'] = os.environ.get('LIB')
319 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
321 # for simplicity, use var instead of env[var]
322 frontend = env['frontend']
323 prefix = env['prefix']
326 if platform_name == 'win32':
327 if env.has_key('use_vc'):
328 use_vc = env['use_vc']
329 if WhereIs('cl.exe') is None:
330 print "cl.exe is not found. Are you using the MSVC environment?"
332 elif WhereIs('cl.exe') is not None:
339 # lyx will be built to $build/build_dir so it is possible
340 # to build multiple build_dirs using the same source
341 # $mode can be debug or release
342 if env.has_key('build_dir') and env['build_dir'] is not None:
343 # create the directory if needed
344 if not os.path.isdir(env['build_dir']):
346 os.makedirs(env['build_dir'])
349 if not os.path.isdir(env['build_dir']):
350 print 'Can not create directory', env['build_dir']
352 env['BUILDDIR'] = env['build_dir']
354 # Determine the name of the build $mode
355 env['BUILDDIR'] = '#' + mode
357 # all built libraries will go to build_dir/libs
358 # (This is different from the make file approach)
359 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
360 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
363 # Here is a summary of variables defined in env
365 # 2. undefined options with a non-None default value
366 # 3. compiler commands and flags like CCFLAGS.
367 # MSGFMT used to process po files
368 # 4. Variables that will be used to replace variables in some_file.in
369 # src/support/Package.cpp.in:
370 # TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
371 # lib/lyx2lyx/lyx2lyx_version.py.in
374 # full path name is used to build msvs project files
375 # and to replace TOP_SRCDIR in package.C
376 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
378 # determine share_dir etc
379 packaging_method = env.get('packaging')
380 if packaging_method == 'windows':
381 share_dir = 'Resources'
382 man_dir = 'Resources/man/man1'
383 locale_dir = 'Resources/locale'
385 share_dir = 'share/lyx'
386 locale_dir = 'share/locale'
387 if platform_name == 'cygwin':
388 man_dir = 'share/man/man1'
392 # program suffix: can be yes, or a string
393 if env.has_key('version_suffix'):
394 if env['version_suffix'] in true_strings:
395 program_suffix = package_version
396 elif env['version_suffix'] in false_strings:
399 program_suffix = env['version_suffix']
402 # used by Package.cpp.in
403 env['PROGRAM_SUFFIX'] = program_suffix
405 # whether or not add suffix to file and directory names
406 add_suffix = packaging_method != 'windows'
407 # LYX_DIR are different (used in Package.cpp.in)
409 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
411 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
412 # we need absolute path for package.C
413 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
416 #---------------------------------------------------------
417 # Setting building environment (Tools, compiler flags etc)
418 #---------------------------------------------------------
420 # Since Tool('mingw') will reset CCFLAGS etc, this should be
421 # done before getEnvVariable
422 if platform_name == 'win32':
428 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
429 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
431 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
434 # we differentiate between hard-coded options and default options
435 # hard-coded options are required and will always be there
436 # default options can be replaced by enviromental variables or command line options
437 CCFLAGS_required = []
438 LINKFLAGS_required = []
441 # under windows, scons is confused by .C/.c and uses gcc instead of
442 # g++. I am forcing the use of g++ here. This is expected to change
443 # after lyx renames all .C files to .cpp
445 # save the old c compiler and CCFLAGS (used by libintl)
446 C_COMPILER = env.subst('$CC')
447 C_CCFLAGS = env.subst('$CCFLAGS').split()
448 # if we use ms vc, the commands are fine (cl.exe and link.exe)
450 # C4819: The file contains a character that cannot be represented
451 # in the current code page (number)
452 # C4996: foo was decleared deprecated
453 CCFLAGS_required.append('/EHsc')
455 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
456 # the flags are also needed in C mode (for intl lib)
457 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
459 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
460 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
462 if env.has_key('CXX') and env['CXX']:
463 env['CC'] = env.subst('$CXX')
464 env['LINK'] = env.subst('$CXX')
469 # for debug/release mode
470 if env.has_key('optimization') and env['optimization'] is not None:
471 # if user supplies optimization flags, use it anyway
472 CCFLAGS_required.extend(env['optimization'].split())
473 # and do not use default
474 set_default_optimization_flags = False
476 set_default_optimization_flags = True
480 CCFLAGS_required.append('/Zi')
481 LINKFLAGS_required.extend(['/debug', '/map'])
483 CCFLAGS_required.append('-g')
484 CCFLAGS_default.append('-O')
485 elif mode == 'release' and set_default_optimization_flags:
487 CCFLAGS_default.append('/O2')
489 CCFLAGS_default.append('-O2')
491 # msvc uses separate tools for profiling
492 if env.has_key('profiling') and env['profiling']:
494 print 'Visual C++ does not use profiling options'
496 CCFLAGS_required.append('-pg')
497 LINKFLAGS_required.append('-pg')
499 if env.has_key('warnings') and env['warnings']:
501 CCFLAGS_default.append('/W2')
503 # Note: autotools detect gxx version and pass -W for 3.x
504 # and -Wextra for other versions of gcc
505 CCFLAGS_default.append('-Wall')
507 # Now, set the variables as follows:
508 # 1. if command line option exists: replace default
509 # 2. then if s envronment variable exists: replace default
510 # 3. set variable to required + default
511 def setEnvVariable(env, name, required = None, default = None, split = True):
512 ''' env: environment to set variable
514 required: hardcoded options
515 default: default options that can be replaced by command line or
516 environment variables
517 split: whether or not split obtained variable like '-02 -g'
519 # 1. ARGUMENTS is already set to env[name], override default.
520 if ARGUMENTS.has_key(name):
521 # env[name] may be rewritten when building tools are reloaded
522 # if that is the case, commandline option will override it.
523 env[name] = ARGUMENTS[name]
525 # then use environment default
526 elif os.environ.has_key(name):
527 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
528 default = os.environ[name]
530 default = default.split()
531 # the real value should be env[name] + default + required
534 if env.has_key(name):
535 value = str(env[name]).split()
536 if required is not None:
538 if default is not None:
542 if env.has_key(name):
543 value = str(env[name])
544 if required is not None:
545 value += " " + required
546 if default is not None:
547 value += " " + default
549 # print name, env[name]
551 setEnvVariable(env, 'DESTDIR', split=False)
552 setEnvVariable(env, 'CC')
553 setEnvVariable(env, 'LINK')
554 setEnvVariable(env, 'CPP')
555 setEnvVariable(env, 'CXX')
556 setEnvVariable(env, 'CXXCPP')
557 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
558 setEnvVariable(env, 'CXXFLAGS')
559 setEnvVariable(env, 'CPPFLAGS')
560 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
562 # if DESTDIR is not set...
563 if env.has_key('dest_dir'):
564 print "This option is obsolete. Please use DESTDIR instead."
565 env['DESTDIR'] = env['dest_dir']
568 # extra_inc_path and extra_lib_path
571 if env.has_key('extra_inc_path') and env['extra_inc_path']:
572 extra_inc_paths.append(env['extra_inc_path'])
573 if env.has_key('extra_lib_path') and env['extra_lib_path']:
574 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
575 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
576 extra_inc_paths.append(env['extra_inc_path1'])
577 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
578 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
579 if env.has_key('extra_bin_path') and env['extra_bin_path']:
580 # only the first one is needed (a scons bug?)
581 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
582 env.PrependENVPath('PATH', env['extra_bin_path'])
583 # extra_inc_paths will be used later by intlenv etc
584 env.AppendUnique(CPPPATH = extra_inc_paths)
587 #----------------------------------------------------------
589 #----------------------------------------------------------
591 conf = Configure(env,
593 'CheckPkgConfig' : utils.checkPkgConfig,
594 'CheckPackage' : utils.checkPackage,
595 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
596 'CheckSelectArgType' : utils.checkSelectArgType,
597 'CheckBoostLibraries' : utils.checkBoostLibraries,
598 'CheckCommand' : utils.checkCommand,
599 'CheckNSIS' : utils.checkNSIS,
600 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
601 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
602 'CheckIconvConst' : utils.checkIconvConst,
603 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
604 'CheckDeclaration' : utils.checkDeclaration,
608 # When using msvc, windows.h is required
609 if use_vc and not conf.CheckCHeader('windows.h'):
610 print 'Windows.h is not found. Please install Windows Platform SDK.'
611 print 'Please check config.log for more information.'
614 # pkg-config? (if not, we use hard-coded options)
615 if conf.CheckPkgConfig('0.15.0'):
616 env['HAS_PKG_CONFIG'] = True
618 print 'pkg-config >= 0.1.50 is not found'
619 env['HAS_PKG_CONFIG'] = False
621 # zlib? This is required.
622 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
623 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
624 print 'Did not find zdll.lib or zlib.h, exiting!'
625 print 'Please check config.log for more information.'
627 if conf.CheckLib('iconv'):
628 env['ICONV_LIB'] = 'iconv'
629 elif conf.CheckLib('libiconv'):
630 env['ICONV_LIB'] = 'libiconv'
631 elif conf.CheckFunc('iconv_open'):
632 env['ICONV_LIB'] = None
634 print 'Did not find iconv or libiconv, exiting!'
635 print 'Please check config.log for more information.'
640 if conf.CheckLib('socket'):
641 socket_libs.append('socket')
642 # nsl is the network services library and provides a
643 # transport-level interface to networking services.
644 if conf.CheckLib('nsl'):
645 socket_libs.append('nsl')
647 # check available boost libs (since lyx1.4 does not use iostream)
649 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
650 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
651 boost_libs.append(lib)
653 # check boost libraries
654 boost_opt = ARGUMENTS.get('boost', 'auto')
655 # check for system boost
656 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
657 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
658 # default to $BUILDDIR/libs (use None since this path will be added anyway)
660 # here I assume that all libraries are in the same directory
661 if boost_opt == 'included':
662 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
663 included_boost = True
664 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
665 elif boost_opt == 'auto':
666 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
667 # if not found, use local boost
669 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
670 included_boost = True
671 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
673 included_boost = False
674 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
675 elif boost_opt == 'system':
676 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
678 print "Can not find system boost libraries with version %s " % boost_version
679 print "Please supply a path through extra_lib_path and try again."
680 print "Or use boost=included to use included boost libraries."
683 included_boost = False
684 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
687 if boost_libpath is not None:
688 env.AppendUnique(LIBPATH = [boost_libpath])
691 env['ENABLE_NLS'] = env['nls']
693 if not env['ENABLE_NLS']:
695 included_gettext = False
697 # check gettext libraries
698 gettext_opt = ARGUMENTS.get('gettext', 'auto')
699 # check for system gettext
701 if gettext_opt in ['auto', 'system']:
702 if conf.CheckFunc('gettext'):
703 included_gettext = False
706 elif conf.CheckLib('intl'):
707 included_gettext = False
711 if gettext_opt == 'system':
712 print "Can not find system gettext library"
713 print "Please supply a path through extra_lib_path and try again."
714 print "Or use gettext=included to use included gettext libraries."
716 # now, auto and succ = false, or gettext=included
718 # we do not need to set LIBPATH now.
719 included_gettext = True
720 intl_libs = ['included_intl']
724 # check for msgfmt command
725 env['MSGFMT'] = conf.CheckCommand('msgfmt')
726 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
727 env['XGETTEXT'] = conf.CheckCommand('xgettext')
728 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
730 # if under windows, check the nsis compiler
731 if platform_name == 'win32':
732 env['NSIS'] = conf.CheckNSIS()
734 # cygwin packaging requires the binaries to be stripped
735 if platform_name == 'cygwin':
736 env['STRIP'] = conf.CheckCommand('strip')
739 # Customized builders
741 # install customized builders
742 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
743 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
744 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
747 #----------------------------------------------------------
748 # Generating config.h
749 #----------------------------------------------------------
750 aspell_lib = 'aspell'
751 # assume that we use aspell, aspelld compiled for msvc
752 if platform_name == 'win32' and mode == 'debug' and use_vc:
753 aspell_lib = 'aspelld'
755 # check the existence of config.h
756 config_h = os.path.join(env.Dir('$BUILDDIR/src').path, 'config.h')
757 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
759 print "Creating %s..." % boost_config_h
761 utils.createConfigFile(conf,
762 config_file = boost_config_h,
763 config_pre = '''/* boost/config.h. Generated by SCons. */
768 * This file is part of LyX, the document processor.
769 * Licence details can be found in the file COPYING.
771 * This is the compilation configuration file for LyX.
772 * It was generated by scon.
773 * You might want to change some of the defaults if something goes wrong
774 * during the compilation.
777 #ifndef _BOOST_CONFIG_H
778 #define _BOOST_CONFIG_H
781 ('ostream', 'HAVE_OSTREAM', 'cxx'),
782 ('locale', 'HAVE_LOCALE', 'cxx'),
783 ('sstream', 'HAVE_SSTREAM', 'cxx'),
784 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
787 (env.has_key('assertions') and env['assertions'],
789 'Define if you want assertions to be enabled in the code'
793 ('wchar_t', 'HAVE_WCHAR_T', None),
797 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
798 # define USE_BOOST_FORMAT 1
800 # define USE_BOOST_FORMAT 0
803 #if !defined(ENABLE_ASSERTIONS)
804 # define BOOST_DISABLE_ASSERTS 1
806 #define BOOST_ENABLE_ASSERT_HANDLER 1
808 #define BOOST_DISABLE_THREADS 1
809 #define BOOST_NO_WSTRING 1
812 # define BOOST_POSIX 1
813 # define BOOST_POSIX_API 1
814 # define BOOST_POSIX_PATH 1
817 #define BOOST_ALL_NO_LIB 1
819 #if defined(HAVE_NEWAPIS_H)
820 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
824 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
825 * support compiled in:
826 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
827 * And we are not interested at all what libc
828 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
829 * has the needed wchar_t support and uses UCS4. Whether it
830 * implements this with the help of libc, or whether it has own code
831 * does not matter for us, because we don't use libc directly (Georg)
833 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
841 print "\nGenerating %s..." % config_h
843 # AIKSAURUS_H_LOCATION
844 if (conf.CheckCXXHeader("Aiksaurus.h")):
845 aik_location = '<Aiksaurus.h>'
846 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
847 aik_location = '<Aiksaurus/Aiksaurus.h>'
851 # determine headers to use
852 spell_opt = ARGUMENTS.get('spell', 'auto')
853 env['USE_ASPELL'] = False
854 env['USE_PSPELL'] = False
855 env['USE_ISPELL'] = False
856 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
857 spell_engine = 'USE_ASPELL'
858 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
859 spell_engine = 'USE_PSPELL'
860 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
861 spell_engine = 'USE_ISPELL'
865 if spell_engine is not None:
866 env[spell_engine] = True
868 if spell_opt == 'auto':
869 print "Warning: Can not locate any spell checker"
870 elif spell_opt != 'no':
871 print "Warning: Can not locate specified spell checker:", spell_opt
872 print 'Please check config.log for more information.'
875 # check arg types of select function
876 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
878 # check the size of wchar_t
879 sizeof_wchar_t = conf.CheckSizeOfWChar()
881 if sizeof_wchar_t == 0:
882 print 'Error: Can not determine the size of wchar_t.'
883 print 'Please check config.log for more information.'
887 # fill in the version info
888 env['VERSION_INFO'] = '''Configuration
890 Special build flags: %s
892 C Compiler flags: %s %s
894 C++ Compiler LyX flags: %s
895 C++ Compiler flags: %s %s
897 Linker user flags: %s
899 Builing directory: %s
900 Local library directory: %s
903 include search path: %s
909 ''' % (platform_name,
910 env.subst('$CCFLAGS'), env.subst('$CC'),
911 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
912 env.subst('$CXX'), env.subst('$CXXFLAGS'),
913 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
914 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
915 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
916 str(env['LIBPATH']), str(boost_libraries),
918 frontend, packaging_method,
919 prefix, env['LYX_DIR'])
923 result = utils.createConfigFile(conf,
924 config_file = config_h,
925 config_pre = '''/* config.h. Generated by SCons. */
930 * This file is part of LyX, the document processor.
931 * Licence details can be found in the file COPYING.
933 * This is the compilation configuration file for LyX.
934 * It was generated by scon.
935 * You might want to change some of the defaults if something goes wrong
936 * during the compilation.
943 ('io.h', 'HAVE_IO_H', 'c'),
944 ('limits.h', 'HAVE_LIMITS_H', 'c'),
945 ('locale.h', 'HAVE_LOCALE_H', 'c'),
946 ('process.h', 'HAVE_PROCESS_H', 'c'),
947 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
948 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
949 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
950 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
951 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
952 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
953 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
954 ('utime.h', 'HAVE_UTIME_H', 'c'),
955 ('direct.h', 'HAVE_DIRECT_H', 'c'),
956 ('istream', 'HAVE_ISTREAM', 'cxx'),
957 ('ios', 'HAVE_IOS', 'cxx'),
960 ('open', 'HAVE_OPEN', None),
961 ('chmod', 'HAVE_CHMOD', None),
962 ('close', 'HAVE_CLOSE', None),
963 ('popen', 'HAVE_POPEN', None),
964 ('pclose', 'HAVE_PCLOSE', None),
965 ('_open', 'HAVE__OPEN', None),
966 ('_close', 'HAVE__CLOSE', None),
967 ('_popen', 'HAVE__POPEN', None),
968 ('_pclose', 'HAVE__PCLOSE', None),
969 ('getpid', 'HAVE_GETPID', None),
970 ('_getpid', 'HAVE__GETPID', None),
971 ('mkdir', 'HAVE_MKDIR', None),
972 ('_mkdir', 'HAVE__MKDIR', None),
973 ('mktemp', 'HAVE_MKTEMP', None),
974 ('mkstemp', 'HAVE_MKSTEMP', None),
975 ('strerror', 'HAVE_STRERROR', None),
976 ('getcwd', 'HAVE_GETCWD', None),
977 ('setenv', 'HAVE_SETENV', None),
978 ('putenv', 'HAVE_PUTENV', None),
979 ('fcntl', 'HAVE_FCNTL', None),
980 ('mkfifo', 'HAVE_MKFIFO', None),
983 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
986 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
987 '#include <streambuf>\n#include <istream>'),
988 ('wchar_t', 'HAVE_WCHAR_T', None),
989 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
992 ('gdi32', 'HAVE_LIBGDI32'),
993 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
996 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
998 'Define is sys/types.h does not have pid_t',
1000 '#define pid_t int',
1002 (conf.CheckCXXGlobalCstd(),
1004 'Define if your C++ compiler puts C library functions in the global namespace'
1006 (conf.CheckMkdirOneArg(),
1007 'MKDIR_TAKES_ONE_ARG',
1008 'Define if mkdir takes only one argument.'
1010 (conf.CheckIconvConst(),
1012 'Define as const if the declaration of iconv() needs const.',
1013 '#define ICONV_CONST const',
1014 '#define ICONV_CONST',
1016 (conf.CheckLC_MESSAGES(),
1018 'Define if your <locale.h> file defines LC_MESSAGES.'
1020 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
1023 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1025 (env['nls'] and not included_gettext,
1027 'Define to 1 if using system gettext library'
1029 (env.has_key('concept_checks') and env['concept_checks'],
1030 '_GLIBCXX_CONCEPT_CHECKS',
1031 'libstdc++ concept checking'
1033 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1035 'libstdc++ debug mode'
1037 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1038 '_GLIBCXX_DEBUG_PEDANTIC',
1039 'libstdc++ pedantic debug mode'
1041 (os.name != 'nt', 'BOOST_POSIX',
1042 'Indicates to boost < 1.34 which API to use (posix or windows).'
1044 (os.name != 'nt', 'BOOST_POSIX_API',
1045 'Indicates to boost 1.34 which API to use (posix or windows).'
1047 (os.name != 'nt', 'BOOST_POSIX_PATH',
1048 'Indicates to boost 1.34 which path style to use (posix or windows).'
1050 (spell_engine is not None, spell_engine,
1051 'Spell engine to use'
1053 # we need to know the byte order for unicode conversions
1054 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1055 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1059 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1061 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1062 'Define to the address where bug reports for this package should be sent.'),
1063 ('#define PACKAGE_NAME "%s"' % package_name,
1064 'Define to the full name of this package.'),
1065 ('#define PACKAGE_STRING "%s"' % package_string,
1066 'Define to the full name and version of this package.'),
1067 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1068 'Define to the one symbol short name of this package.'),
1069 ('#define PACKAGE_VERSION "%s"' % package_version,
1070 'Define to the version of this package.'),
1071 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1072 'Full version info'),
1073 ('#define LYX_DATE "%s"' % lyx_date,
1075 ('#define BOOST_ALL_NO_LIB 1',
1076 'disable automatic linking of boost libraries.'),
1077 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1078 'Packaging method'),
1079 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1080 'Aiksaurus include file'),
1081 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1082 "Define to the type of arg 1 for `select'."),
1083 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1084 "Define to the type of arg 2, 3, 4 for `select'."),
1085 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1086 "Define to the type of arg 5 for `select'."),
1087 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1088 'Define to be the size of type wchar_t'),
1090 config_post = '''/************************************************************
1091 ** You should not need to change anything beyond this point */
1093 #ifndef HAVE_STRERROR
1094 #if defined(__cplusplus)
1097 char * strerror(int n);
1100 #include <../boost/config.h>
1106 # these keys are needed in env
1107 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1108 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1109 # USE_ASPELL etc does not go through result
1110 if result.has_key(key):
1111 env[key] = result[key]
1114 # if nls=yes and gettext=included, create intl/config.h
1115 # intl/libintl.h etc
1117 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1118 if env['nls'] and included_gettext:
1120 print "Creating %s..." % intl_config_h
1122 # create intl/config.h
1123 result = utils.createConfigFile(conf,
1124 config_file = intl_config_h,
1125 config_pre = '''/* intl/config.h. Generated by SCons. */
1130 * This file is part of LyX, the document processor.
1131 * Licence details can be found in the file COPYING.
1133 * This is the compilation configuration file for LyX.
1134 * It was generated by scon.
1135 * You might want to change some of the defaults if something goes wrong
1136 * during the compilation.
1143 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1144 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1145 ('string.h', 'HAVE_STRING_H', 'c'),
1146 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1147 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1148 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1149 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1150 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1151 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1152 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1155 ('getcwd', 'HAVE_GETCWD', None),
1156 ('stpcpy', 'HAVE_STPCPY', None),
1157 ('strcasecmp', 'HAVE_STRCASECMP', None),
1158 ('strdup', 'HAVE_STRDUP', None),
1159 ('strtoul', 'HAVE_STRTOUL', None),
1160 ('alloca', 'HAVE_ALLOCA', None),
1161 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1162 ('mempcpy', 'HAVE_MEMPCPY', None),
1163 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1164 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1165 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1166 ('setlocale', 'HAVE_SETLOCALE', None),
1167 ('tsearch', 'HAVE_TSEARCH', None),
1168 ('getegid', 'HAVE_GETEGID', None),
1169 ('getgid', 'HAVE_GETGID', None),
1170 ('getuid', 'HAVE_GETUID', None),
1171 ('wcslen', 'HAVE_WCSLEN', None),
1172 ('asprintf', 'HAVE_ASPRINTF', None),
1173 ('wprintf', 'HAVE_WPRINTF', None),
1174 ('snprintf', 'HAVE_SNPRINTF', None),
1175 ('printf', 'HAVE_POSIX_PRINTF', None),
1176 ('fcntl', 'HAVE_FCNTL', None),
1179 ('intmax_t', 'HAVE_INTMAX_T', None),
1180 ('long double', 'HAVE_LONG_DOUBLE', None),
1181 ('long long', 'HAVE_LONG_LONG', None),
1182 ('wchar_t', 'HAVE_WCHAR_T', None),
1183 ('wint_t', 'HAVE_WINT_T', None),
1184 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1185 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1191 (conf.CheckLC_MESSAGES(),
1193 'Define if your <locale.h> file defines LC_MESSAGES.'
1195 (conf.CheckIconvConst(),
1197 'Define as const if the declaration of iconv() needs const.',
1198 '#define ICONV_CONST const',
1199 '#define ICONV_CONST',
1201 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1202 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1204 "Define to 1 if you have the `intmax_t' type."
1206 (env.has_key('nls') and env['nls'],
1208 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1212 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1213 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1214 'Define to be the size of type wchar_t'),
1216 config_post = '#endif'
1219 # these keys are needed in env
1220 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1221 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1222 # USE_ASPELL etc does not go through result
1223 if result.has_key(key):
1224 env[key] = result[key]
1227 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1228 if env['nls'] and included_gettext:
1229 # libgnuintl.h.in => libintl.h
1230 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1231 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1232 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1233 [Copy('$TARGET', '$SOURCE')])
1236 # Finish auto-configuration
1239 #----------------------------------------------------------
1240 # Now set up our build process accordingly
1241 #----------------------------------------------------------
1243 if env['ICONV_LIB'] is None:
1246 system_libs = [env['ICONV_LIB']]
1247 if platform_name in ['win32', 'cygwin']:
1248 # the final link step needs stdc++ to succeed under mingw
1249 # FIXME: shouldn't g++ automatically link to stdc++?
1251 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1253 system_libs += ['shlwapi', 'stdc++', 'z']
1254 elif platform_name == 'cygwin' and env['X11']:
1255 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1256 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1257 'resolv', 'pthread', 'z']
1259 system_libs += ['z']
1262 ('HAVE_LIBGDI32', 'gdi32'),
1263 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1264 ('USE_ASPELL', aspell_lib),
1265 ('USE_ISPELL', 'ispell'),
1266 ('USE_PSPELL', 'pspell'),
1271 system_libs.append(lib[1])
1274 # Build parameters CPPPATH etc
1277 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1280 # boost: for boost header files
1281 # BUILDDIR/src: for config.h
1282 # TOP_SRCDIR/src: for support/* etc
1284 env['CPPPATH'] += ['$BUILDDIR/src', '$TOP_SRCDIR/src']
1286 # Separating boost directories from CPPPATH stops scons from building
1287 # the dependency tree for boost header files, and effectively reduce
1288 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1289 # boost headers, the following is not 100% safe.
1290 # env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1291 env.PrependUnique(CCFLAGS = ['$INCPREFIX$BOOST_INC_PATH'])
1293 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1294 if env['nls'] and included_gettext:
1295 env['CPPPATH'].append('$BUILDDIR/intl')
1299 # A Link script for cygwin see
1300 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1301 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1304 if platform_name == 'cygwin':
1305 ld_script_path = '/tmp'
1306 ld_script = utils.installCygwinLDScript(ld_script_path)
1307 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1308 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1311 #---------------------------------------------------------
1312 # Frontend related variables (QTDIR etc)
1313 #---------------------------------------------------------
1316 # create a separate environment so that other files do not have
1317 # to be built with all the include directories etc
1319 if frontend == 'qt4':
1320 frontend_env = env.Copy()
1322 # handle qt related user specified paths
1323 # set environment so that moc etc can be found even if its path is not set properly
1324 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1325 frontend_env['QTDIR'] = frontend_env['qt_dir']
1326 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1327 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1328 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1329 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1330 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1332 # if separate qt_lib_path is given
1333 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1334 qt_lib_path = frontend_env.subst('$qt_lib_path')
1335 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1336 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1340 # if separate qt_inc_path is given
1341 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1342 qt_inc_path = frontend_env['qt_inc_path']
1346 # local qt4 toolset from
1347 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1349 # NOTE: I have to patch qt4.py since it does not automatically
1350 # process .C file!!! (add to cxx_suffixes )
1352 frontend_env.Tool('qt4', [scons_dir])
1353 frontend_env['QT_AUTOSCAN'] = 0
1354 frontend_env['QT4_AUTOSCAN'] = 0
1355 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1357 if qt_lib_path is None:
1358 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1359 if qt_inc_path is None:
1360 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1363 conf = Configure(frontend_env,
1365 'CheckPackage' : utils.checkPackage,
1366 'CheckCommand' : utils.checkCommand,
1371 # first: try pkg_config
1372 if frontend_env['HAS_PKG_CONFIG']:
1373 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1374 # FIXME: use pkg_config information?
1375 #frontend_env['QT4_PKG_CONFIG'] = succ
1376 # second: try to link to it
1378 # Under linux, I can test the following perfectly
1379 # Under windows, lib names need to passed as libXXX4.a ...
1380 if platform_name == 'win32':
1381 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1383 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1384 # still can not find it
1386 print 'Did not find qt libraries, exiting!'
1387 print 'Please check config.log for more information.'
1390 # Now, determine the correct suffix:
1391 qt_libs = ['QtCore', 'QtGui']
1392 if platform_name == 'win32':
1393 if mode == 'debug' and use_vc and \
1394 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1395 qt_lib_suffix = 'd4'
1396 use_qt_debug_libs = True
1399 use_qt_debug_libs = False
1401 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1402 qt_lib_suffix = '_debug'
1403 use_qt_debug_libs = True
1406 use_qt_debug_libs = False
1407 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1408 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1409 qtcore_lib = ['QtCore' + qt_lib_suffix]
1411 # check uic and moc commands for qt frontends
1412 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1413 print 'uic or moc command is not found for frontend', frontend
1416 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1417 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1418 # For some unknown changes in msvc or qt, this is no longer needed.
1420 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1421 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1422 env.File('$BUILDDIR/lyx.exe.manifest').path]
1424 frontend_env = conf.Finish()
1431 print env['VERSION_INFO']
1434 # Mingw command line may be too short for our link usage,
1435 # Here we use a trick from scons wiki
1436 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1438 # I also would like to add logging (commands only) capacity to the
1440 logfile = env.get('logfile', default_log_file)
1441 if logfile != '' or platform_name == 'win32':
1443 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1444 info = '''# This is a log of commands used by scons to build lyx
1448 ''' % (time.asctime(), ' '.join(sys.argv),
1449 env['VERSION_INFO'].replace('\n','\n# ')) )
1454 # -h will print out help info
1455 Help(opts.GenerateHelpText(env))
1459 #----------------------------------------------------------
1461 #----------------------------------------------------------
1462 # this has been the source of problems on some platforms...
1463 # I find that I need to supply it with full path name
1464 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1465 # this usage needs further investigation.
1466 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1467 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1468 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1469 frontend_env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1471 print "Building all targets recursively"
1473 def libExists(libname):
1474 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1475 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1477 def appExists(apppath, appname):
1478 ''' Check whether or not application already exists'''
1479 return os.path.isfile(File(env.subst('$BUILDDIR/src/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1481 targets = BUILD_TARGETS
1482 build_install = 'install' in targets or 'installer' in targets
1483 build_installer = 'installer' in targets
1484 # msvc need to pass full target name, so I have to look for path/lyx etc
1485 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1486 or build_install or 'all' in targets
1487 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1488 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1489 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1490 build_mathed = build_lyx or 'mathed' in targets
1491 build_insets = build_lyx or 'insets' in targets
1492 build_frontends = build_lyx or 'frontends' in targets
1493 build_graphics = build_lyx or 'graphics' in targets
1494 build_controllers = build_lyx or 'controllers' in targets
1495 build_client = True in ['client' in x for x in targets] \
1496 or build_install or 'all' in targets or build_installer
1497 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1498 or build_install or 'all' in targets or build_installer
1499 build_lyxbase = build_lyx or 'lyxbase' in targets
1500 update_po = 'update_po' in targets
1501 update_manifest = 'update_manifest' in targets
1502 build_po = 'po' in targets or build_install or 'all' in targets
1503 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1504 build_msvs_projects = use_vc and 'msvs_projects' in targets
1507 # sync frontend and frontend (?)
1518 boostenv = env.Copy()
1520 # boost use its own config.h
1521 boostenv['CPPPATH'] = ['$BUILDDIR/boost'] + extra_inc_paths
1522 boostenv['CCFLAGS'] = ['$INCPREFIX$TOP_SRCDIR/boost']
1523 boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1525 for lib in boost_libs:
1526 print 'Processing files in boost/libs/%s/src...' % lib
1527 boostlib = boostenv.StaticLibrary(
1528 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1529 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1531 Alias('boost', boostlib)
1538 intlenv = env.Copy()
1540 print "Processing files in intl..."
1543 # we need the original C compiler for these files
1544 intlenv['CC'] = C_COMPILER
1545 intlenv['CCFLAGS'] = C_CCFLAGS
1547 intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1548 # intl does not use global config.h
1549 intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1551 intlenv.Append(CCFLAGS = [
1552 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1553 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1554 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1556 '-DENABLE_RELOCATABLE=1',
1558 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1560 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1561 '-Drelocate=libintl_relocate',
1562 '-DDEPENDS_ON_LIBICONV=1',
1567 intl = intlenv.StaticLibrary(
1568 target = '$LOCALLIBPATH/included_intl',
1570 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1576 # Now, src code under src/
1584 print "Processing files in src/support..."
1586 frontend_env.Depends('$BUILDDIR/src/support/Package.cpp', '$BUILDDIR/src/config.h')
1587 Package_cpp = env.substFile('$BUILDDIR/src/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1589 support = frontend_env.StaticLibrary(
1590 target = '$LOCALLIBPATH/support',
1591 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files] + Package_cpp + \
1592 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_files] + \
1593 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_windows_files if platform_name == 'win32'],
1597 '-DQT_CLEAN_NAMESPACE',
1602 CPPPATH = ['$CPPPATH', '$TOP_SRCDIR/src/support/minizip']
1604 Alias('support', support)
1611 print "Processing files in src/mathed..."
1613 mathed = env.StaticLibrary(
1614 target = '$LOCALLIBPATH/mathed',
1615 source = ['$BUILDDIR/src/mathed/%s' % x for x in src_mathed_files]
1617 Alias('mathed', mathed)
1624 print "Processing files in src/insets..."
1626 insets = env.StaticLibrary(
1627 target = '$LOCALLIBPATH/insets',
1628 source = ['$BUILDDIR/src/insets/%s' % x for x in src_insets_files]
1630 Alias('insets', insets)
1637 print "Processing files in src/frontends..."
1639 frontends = env.StaticLibrary(
1640 target = '$LOCALLIBPATH/frontends',
1641 source = ['$BUILDDIR/src/frontends/%s' % x for x in src_frontends_files]
1643 Alias('frontends', frontends)
1650 print "Processing files in src/graphics..."
1652 graphics = env.StaticLibrary(
1653 target = '$LOCALLIBPATH/graphics',
1654 source = ['$BUILDDIR/src/graphics/%s' % x for x in src_graphics_files]
1656 Alias('graphics', graphics)
1659 if build_controllers:
1661 # src/frontends/controllers
1663 print "Processing files in src/frontends/controllers..."
1665 controllers = env.StaticLibrary(
1666 target = '$LOCALLIBPATH/controllers',
1667 source = ['$BUILDDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1669 Alias('controllers', controllers)
1676 print "Processing files in src/frontends/qt4..."
1677 frontend_env['QT4_MOCHPREFIX'] = ''
1678 frontend_env['QT4_MOCHSUFFIX'] = '_moc.cpp'
1680 # tells scons how to get these moced files, although not all moced files are needed
1681 # (or are actually generated).
1682 qt4_moced_files = [frontend_env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1683 for x in src_frontends_qt4_header_files ]
1684 resources = [frontend_env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1685 for x in src_frontends_qt4_ui_files]
1688 # moc qt4_moc_files, the moced files are included in the original files
1690 qt4 = frontend_env.StaticLibrary(
1691 target = '$LOCALLIBPATH/qt4',
1692 source = ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1696 '$BUILDDIR/src/images',
1697 '$BUILDDIR/src/frontends',
1698 '$BUILDDIR/src/frontends/qt4',
1699 '$BUILDDIR/src/frontends/qt4/ui',
1700 '$BUILDDIR/src/frontends/controllers'
1705 '-DQT_CLEAN_NAMESPACE',
1719 print "Processing files in src/client..."
1721 if env['HAVE_FCNTL']:
1722 client = frontend_env.Program(
1723 target = '$BUILDDIR/src/client/lyxclient',
1724 LIBS = ['support'] + intl_libs + system_libs +
1725 socket_libs + boost_libraries + qtcore_lib,
1726 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1727 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1729 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1730 client, [Copy('$TARGET', '$SOURCE')]))
1733 Alias('client', client)
1735 if env['HAVE_FCNTL']:
1736 # define client even if lyxclient is not built with rebuild=no
1737 client = [env.subst('$BUILDDIR/src/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1746 print "Processing files in src/tex2lyx..."
1749 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1750 frontend_env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1751 [Copy('$TARGET', '$SOURCE')])
1753 tex2lyx = frontend_env.Program(
1754 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1755 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1756 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1757 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1758 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$CPPPATH'],
1759 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1761 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1762 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1763 Alias('tex2lyx', tex2lyx)
1765 # define tex2lyx even if tex2lyx is not built with rebuild=no
1766 tex2lyx = [frontend_env.subst('$BUILDDIR/src/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1773 print "Processing files in src..."
1775 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1776 src_post_files.append('ASpell.cpp')
1777 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1778 src_post_files.append('PSpell.cpp')
1779 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1780 src_post_files.append('ISpell.cpp')
1782 # msvc requires at least one source file with main()
1783 # so I exclude main.cpp from lyxbase
1784 lyxbase_pre = env.StaticLibrary(
1785 target = '$LOCALLIBPATH/lyxbase_pre',
1786 source = ['$BUILDDIR/src/%s' % x for x in src_pre_files]
1788 lyxbase_post = env.StaticLibrary(
1789 target = '$LOCALLIBPATH/lyxbase_post',
1790 source = ["$BUILDDIR/src/%s" % x for x in src_post_files]
1792 Alias('lyxbase', lyxbase_pre)
1793 Alias('lyxbase', lyxbase_post)
1798 # Build lyx with given frontend
1800 lyx = frontend_env.Program(
1801 target = '$BUILDDIR/lyx',
1802 source = ['$BUILDDIR/src/main.cpp'] + \
1803 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1823 # define lyx even if lyx is not built with rebuild=no
1824 lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1827 if build_msvs_projects:
1828 def build_project(target, full_target = None,
1829 src = [], inc = [], res = []):
1830 ''' build mavs project files
1831 target: alias (correspond to directory name)
1832 full_target: full path/filename of the target
1837 For non-debug-able targets like static libraries, target (alias) is
1838 enough to build the target. For executable targets, msvs need to know
1839 the full path to start debug them.
1842 if full_target is None:
1843 build_target = target
1845 build_target = full_target
1847 proj = env.MSVSProject(
1848 target = target + env['MSVSPROJECTSUFFIX'],
1849 # this allows easy access to header files (along with source)
1850 srcs = [env.subst(x) for x in src + inc],
1851 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1852 localincs = [env.subst(x) for x in inc],
1853 resources = [env.subst(x) for x in res],
1854 buildtarget = build_target,
1858 Alias('msvs_projects', proj)
1860 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1861 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1862 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1864 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1865 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1866 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1868 build_project('lyx',
1869 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1870 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1871 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1872 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1873 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1874 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1875 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1876 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1877 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1878 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1879 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1880 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1881 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1882 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1883 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1884 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1885 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1886 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1891 # update scons_manifest.py
1893 # When you run 'scons update_manifest', it tells you which files are missing
1894 # and which files are not in the source tree. It also generates a
1895 # scons_manifest.py.new file with all the missing files added to
1896 # XXX_extra_files. It will *not* change other sections of existing
1899 print 'Validating development/scons/scons_manifest.py...'
1901 manifest = open(env.File('$TOP_SRCDIR/development/scons/scons_manifest.py.new').abspath, 'w')
1902 print >> manifest, 'from SCons.Util import Split\n'
1904 ignore_dirs = ['boost/boost', 'm4', 'development',
1905 utils.relativePath(env.Dir('$BUILDDIR').abspath, env.Dir('$TOP_SRCDIR').abspath)]
1906 ignore_types = ['.svn', '.deps', '.cache', '.tmp', '.bak', '.gmo', '.pot',
1907 '.pyc', '.pyo', '.o', '_moc.cpp', 'Makefile.in', 'config.h.in',
1908 'LaTeXConfig.lyx', 'version.cpp', 'Package.cpp']
1909 ext_types = ['_header_files', '_files', '_pre_files', '_post_files', '_moc_files', '_inc_files',
1910 '_copied_files', '_copied_header_files', '_extra_header_files', '_extra_src_files', '_extra_files']
1911 for root,path,files in os.walk(env.Dir('$TOP_SRCDIR').abspath):
1912 if os.path.split(root)[-1][0] == '.' \
1913 or True in [x in root for x in ignore_types] \
1914 or True in [utils.isSubDir(root, x) for x in ignore_dirs]:
1916 dirname = utils.relativePath(root, env.subst('$TOP_SRCDIR')).replace(os.sep, '_')
1919 # files in the current manifest.py
1921 for ext in ext_types:
1922 if 'copied' not in ext and dirname + ext in locals():
1923 cur_files.extend(eval(dirname + ext))
1925 # compare files with cur_files
1926 files = [x for x in files if x[0] != '.' and True not in [len(x) >= len(y) and x[-len(y):] == y for y in ignore_types]]
1928 if cur_files != files:
1931 if f not in cur_files:
1937 if len(missing) > 0:
1938 print 'Missing: %s in %s' % (', '.join(missing), root)
1939 if dirname + '_extra_files' in locals():
1940 exec('%s_extra_files.extend(missing)' % dirname)
1942 exec('%s_extra_files = missing' % dirname)
1944 print 'Extra: %s in %s' % (', '.join(extra), root)
1945 # write to a new manifest file
1946 for ext in ext_types:
1947 if dirname + ext in locals():
1948 exec('%s%s.sort()' % (dirname, ext))
1949 print >> manifest, "%s%s = Split('''\n " % (dirname, ext),
1950 print >> manifest, eval(r"'\n '.join(%s%s)" % (dirname, ext))
1951 print >> manifest, "''')\n\n"
1953 Alias('update_manifest', None)
1960 print 'Updating po/*.po files...'
1962 # whether or not update po files
1963 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1964 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1966 # rebuild POTFILES.in
1967 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1968 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1969 src_extra_src_files] + \
1970 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1971 src_support_extra_header_files + src_support_extra_src_files] + \
1972 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1973 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1974 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1975 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1976 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
1977 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
1978 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1979 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1981 Alias('update_po', POTFILES_in)
1982 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
1983 # and combine them to lyx.po
1984 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1985 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1986 env.Command('$BUILDDIR/po/all.po',
1987 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1988 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1989 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1990 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1991 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
1992 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1993 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1994 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1995 env.Command('$BUILDDIR/po/ui_l10n.pot',
1996 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1997 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1998 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1999 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
2001 ['$MSGUNIQ -o $TARGET $SOURCE',
2002 '''$XGETTEXT --default-domain=${TARGET.base} \
2003 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2004 --language=C++ --join-existing \
2005 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
2006 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2007 --copyright-holder="LyX Developers" \
2008 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2010 env.Depends(lyx_po, POTFILES_in)
2011 # copy lyx.po to lyx.pot
2012 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2013 Copy('$TARGET', '$SOURCE'))
2016 # files to translate
2017 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2018 # possibly *only* handle these languages
2020 if env.has_key('languages'):
2021 languages = env.make_list(env['languages'])
2022 # merge. if I use lan.po as $TARGET, it will be removed
2023 # before it is merged. In this builder,
2024 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2025 # and is copied to po/lang.po
2026 env['BUILDERS']['msgmerge'] = Builder(action=[
2027 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2028 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2030 # for each po file, generate pot
2031 for po_file in transfiles:
2033 fname = os.path.split(po_file)[1]
2035 country = fname.split('.')[0]
2037 if not languages or country in languages:
2038 # merge po files, the generated lan.po_new file is copied to lan.po file.
2039 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2040 env.Depends(po, POTFILES_in)
2041 Alias('update_po', po)
2048 print 'Processing files in po...'
2053 # files to translate
2054 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2055 # possibly *only* handle these languages
2057 if env.has_key('languages'):
2058 languages = env.make_list(env['lanauges'])
2059 # use defulat msgfmt
2061 if not env['MSGFMT']:
2062 print 'msgfmt does not exist. Can not process po files'
2065 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2067 for f in transfiles:
2069 fname = os.path.split(f)[1]
2071 country = fname.split('.')[0]
2073 if not languages or country in languages:
2074 gmo_files.extend(env.Transfiles(f))
2079 # this part is a bit messy right now. Since scons will provide
2080 # --DESTDIR option soon, at least the dest_dir handling can be
2083 # how to join dest_dir and prefix
2084 def joinPaths(path1, path2):
2085 ''' join path1 and path2, do not use os.path.join because
2086 under window, c:\destdir\d:\program is invalid '''
2088 return os.path.normpath(path2)
2089 # separate drive letter
2090 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2091 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2092 return os.path.join(os.path.normpath(path1), path[1:])
2094 # install to dest_dir/prefix
2095 dest_dir = env.get('DESTDIR', '')
2096 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2097 # create the directory if needed
2098 if not os.path.isdir(dest_prefix_dir):
2100 os.makedirs(dest_prefix_dir)
2103 if not os.path.isdir(dest_prefix_dir):
2104 print 'Can not create directory', dest_prefix_dir
2107 if env.has_key('exec_prefix'):
2108 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2110 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2112 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2114 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2115 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2116 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2117 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2121 # install executables (lyxclient may be None)
2124 version_suffix = program_suffix
2128 # install lyx, if in release mode, try to strip the binary
2129 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2130 # create a builder to strip and install
2131 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2133 # install executables
2134 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2137 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2138 target = os.path.join(bin_dest_dir, target_name)
2139 if env['BUILDERS'].has_key('StripInstallAs'):
2140 env.StripInstallAs(target, obj)
2142 env.InstallAs(target, obj)
2143 Alias('install', target)
2147 for (dir,files) in [
2149 ('bind', lib_bind_files),
2150 ('bind/de', lib_bind_de_files),
2151 ('bind/fi', lib_bind_fi_files),
2152 ('bind/pt', lib_bind_pt_files),
2153 ('bind/sv', lib_bind_sv_files),
2154 ('doc', lib_doc_files),
2155 ('doc/biblio', lib_doc_biblio_files),
2156 ('doc/clipart', lib_doc_clipart_files),
2157 ('doc/cs', lib_doc_cs_files),
2158 ('doc/da', lib_doc_da_files),
2159 ('doc/de', lib_doc_de_files),
2160 ('doc/de/clipart', lib_doc_de_clipart_files),
2161 ('doc/es', lib_doc_es_files),
2162 ('doc/es/clipart', lib_doc_es_clipart_files),
2163 ('doc/eu', lib_doc_eu_files),
2164 ('doc/fr', lib_doc_fr_files),
2165 ('doc/he', lib_doc_he_files),
2166 ('doc/hu', lib_doc_hu_files),
2167 ('doc/it', lib_doc_it_files),
2168 ('doc/nl', lib_doc_nl_files),
2169 ('doc/nb', lib_doc_nb_files),
2170 ('doc/pl', lib_doc_pl_files),
2171 ('doc/pt', lib_doc_pt_files),
2172 ('doc/ro', lib_doc_ro_files),
2173 ('doc/ru', lib_doc_ru_files),
2174 ('doc/sk', lib_doc_sk_files),
2175 ('doc/sl', lib_doc_sl_files),
2176 ('doc/sv', lib_doc_sv_files),
2177 ('examples', lib_examples_files),
2178 ('examples/ca', lib_examples_ca_files),
2179 ('examples/cs', lib_examples_cs_files),
2180 ('examples/da', lib_examples_da_files),
2181 ('examples/de', lib_examples_de_files),
2182 ('examples/es', lib_examples_es_files),
2183 ('examples/eu', lib_examples_eu_files),
2184 ('examples/fa', lib_examples_fa_files),
2185 ('examples/fr', lib_examples_fr_files),
2186 ('examples/he', lib_examples_he_files),
2187 ('examples/hu', lib_examples_hu_files),
2188 ('examples/it', lib_examples_it_files),
2189 ('examples/nl', lib_examples_nl_files),
2190 ('examples/pl', lib_examples_pl_files),
2191 ('examples/pt', lib_examples_pt_files),
2192 ('examples/ru', lib_examples_ru_files),
2193 ('examples/sl', lib_examples_sl_files),
2194 ('examples/ro', lib_examples_ro_files),
2195 ('fonts', lib_fonts_files),
2196 ('images', lib_images_files),
2197 ('images/math', lib_images_math_files),
2198 ('kbd', lib_kbd_files),
2199 ('layouts', lib_layouts_files + lib_layouts_inc_files),
2200 ('lyx2lyx', lib_lyx2lyx_files),
2201 ('scripts', lib_scripts_files),
2202 ('templates', lib_templates_files),
2203 ('tex', lib_tex_files),
2204 ('ui', lib_ui_files)]:
2205 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2206 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2207 Alias('install', dirs)
2209 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2210 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
2211 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2212 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2213 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2214 sys.path.append(share_dest_dir + '/lyx2lyx')
2216 # generate TOC files for each doc
2217 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2219 for lang in languages.keys():
2220 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2221 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2224 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2225 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2227 # this is for English
2228 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2231 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2232 Alias('install', tocs)
2234 if platform_name == 'cygwin':
2235 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2236 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2237 '%s-%s.README' % (package, package_cygwin_version))
2238 env.InstallAs(Cygwin_README,
2239 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2240 Alias('install', Cygwin_README)
2241 # also a directory /usr/share/doc/lyx for README etc
2242 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2243 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2244 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2245 Alias('install', Cygwin_Doc)
2246 # cygwin fonts also need to be installed
2247 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2248 env.Install(Cygwin_fonts,
2249 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2250 for file in win32_bakoma_fonts])
2251 Alias('install', Cygwin_fonts)
2252 # we also need a post installation script
2253 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2254 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2255 env.Install(postinstall_path, tmp_script)
2256 Alias('install', postinstall_path)
2260 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2261 env.subst('$TOP_SRCDIR/lyx.man'))
2262 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2263 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2264 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2265 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2266 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2267 x in ['lyx', 'tex2lyx', 'lyxclient']])
2269 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2270 for gmo in gmo_files:
2271 lan = os.path.split(str(gmo))[1].split('.')[0]
2272 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2273 env.InstallAs(dest_file, gmo)
2274 Alias('install', dest_file)
2279 # build windows installer using NSIS
2282 # There is a nsis builder on scons wiki but it does not work with
2283 # our lyx.nsi because it does not dig through all the include directives
2284 # and find the dependencies automatically. Also, it can not parse
2285 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2286 # something rely on date.
2287 # Because of this, I am doing a simple nsis builder here.
2288 if platform_name != 'win32':
2289 print 'installer target is only available for windows platform'
2291 if mode != 'release':
2292 print 'installer has to be built in release mode (use option mode=release)'
2294 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2295 % x for x in development_Win32_packaging_installer] + \
2296 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2297 % x for x in development_Win32_packaging_installer_components] + \
2298 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2299 % x for x in development_Win32_packaging_installer_dialogs] + \
2300 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2301 % x for x in development_Win32_packaging_installer_graphics] + \
2302 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2303 % x for x in development_Win32_packaging_installer_include] + \
2304 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2305 % x for x in development_Win32_packaging_installer_lang]
2306 if env.has_key('NSIS') and env['NSIS'] is not None:
2307 # create a builder to strip and install
2308 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2310 print 'No nsis compiler is found. Existing...'
2312 if not env.has_key('win_installer') or env['win_installer'] is None:
2314 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2316 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2317 # provide default setting
2318 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2319 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2320 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2321 print 'Development dependency package is not found.'
2324 env['deps_dir'] = env.Dir('$deps_dir').abspath
2326 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2327 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2328 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2329 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2331 env['bundle_dir'] = None
2332 # if absolute path is given, use it, otherwise, write to current directory
2333 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2334 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2335 env.Append(NSISDEFINES={
2336 'ExeFile':env['win_installer'],
2337 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2338 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2339 'FilesDeps':env['deps_dir'],
2340 'FilesBundle':env['bundle_dir'],
2342 installer = env.installer(env['win_installer'],
2343 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2344 # since I can not use a scanner, explicit dependent is required
2345 env.Depends(installer, 'install')
2346 env.Depends(installer, installer_files)
2347 env.Alias('installer', installer)
2348 # also generate bundle?
2349 if env.has_key('bundle') and env['bundle']:
2350 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2351 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2352 print 'Use bundle_dir option to specify'
2354 # generator of the builder will add bundle stuff depending on output name
2355 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2356 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2357 env.Depends(bundle_installer, 'install')
2358 env.Depends(bundle_installer, installer_files)
2359 env.Alias('installer', bundle_installer)
2362 Alias('all', ['lyx', 'client', 'tex2lyx'])