1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 # This is a scons based building system for lyx, please refer
12 # to INSTALL.scons for detailed instructions.
15 import os, sys, copy, cPickle, glob, time
17 # determine where I am ...
19 from SCons.Node.FS import default_fs
20 # default_fs.SConstruct_dir is where SConstruct file is located.
21 scons_dir = default_fs.SConstruct_dir.path
22 scons_absdir = default_fs.SConstruct_dir.abspath
24 # if SConstruct is copied to the top source directory
25 if os.path.exists(os.path.join(scons_dir, 'development', 'scons', 'scons_manifest.py')):
26 scons_dir = os.path.join(scons_dir, 'development', 'scons')
27 scons_absdir = os.path.join(scons_absdir, 'development', 'scons')
28 # get the ../.. of scons_dir
29 top_src_dir = os.path.split(os.path.split(scons_absdir)[0])[0]
31 sys.path.extend([scons_absdir, os.path.join(top_src_dir, 'lib', 'doc')])
34 # scons_utils.py defines a few utility function
35 import scons_utils as utils
36 # import all file lists
37 from scons_manifest import *
39 #----------------------------------------------------------
40 # Required runtime environment
41 #----------------------------------------------------------
43 # scons asks for 1.5.2, lyx requires 2.3
44 EnsurePythonVersion(2, 3)
45 # Please use at least 0.96.92 (not 0.96.1)
46 EnsureSConsVersion(0, 96)
47 # also check for minor version number for scons 0.96
48 from SCons import __version__
49 version = map(int, __version__.split('.'))
50 if version[0] == 0 and version[1] == 96 and version[2] < 92:
51 print "Scons >= 0.96.92 is required."
55 #----------------------------------------------------------
57 #----------------------------------------------------------
59 # some global settings
61 # get version number from configure.ac so that JMarc does
62 # not have to change SConstruct during lyx release
63 package_version = utils.getVerFromConfigure(top_src_dir)
64 package_cygwin_version = '%s-1' % package_version
65 boost_version = ['1_34']
67 if 'svn' in package_version:
69 default_build_mode = 'debug'
72 default_build_mode = 'release'
75 package_bugreport = 'lyx-devel@lists.lyx.org'
77 package_tarname = 'lyx'
78 package_string = '%s %s' % (package_name, package_version)
80 # various cache/log files
81 default_log_file = 'scons_lyx.log'
82 opt_cache_file = 'opt.cache'
85 #----------------------------------------------------------
86 # platform dependent settings
87 #----------------------------------------------------------
90 platform_name = 'win32'
91 default_prefix = 'c:/program files/lyx'
92 default_with_x = False
93 default_packaging_method = 'windows'
94 elif os.name == 'posix' and sys.platform != 'cygwin':
95 platform_name = sys.platform
96 default_prefix = '/usr/local'
98 default_packaging_method = 'posix'
99 elif os.name == 'posix' and sys.platform == 'cygwin':
100 platform_name = 'cygwin'
101 default_prefix = '/usr'
102 default_with_x = True
103 default_packaging_method = 'posix'
104 elif os.name == 'darwin':
105 platform_name = 'macosx'
106 # FIXME: macOSX default prefix?
108 default_with_x = False
109 default_packaging_method = 'macosx'
110 else: # unsupported system, assume posix behavior
111 platform_name = 'others'
113 default_with_x = True
114 default_packaging_method = 'posix'
116 #---------------------------------------------------------
118 #----------------------------------------------------------
120 # You can set perminant default values in config.py
121 if os.path.isfile('config.py'):
122 print "Getting options from config.py..."
123 print open('config.py').read()
125 opts = Options(['config.py'])
128 EnumOption('frontend', 'Main GUI', 'qt4',
129 allowed_values = ('qt4',) ),
130 # debug or release build
131 EnumOption('mode', 'Building method', default_build_mode,
132 allowed_values = ('debug', 'release') ),
135 'Use included, system boost library, or try sytem boost first.',
136 'auto', allowed_values = (
137 'auto', # detect boost, if not found, use included
138 'included', # always use included boost
139 'system', # always use system boost, fail if can not find
142 EnumOption('gettext',
143 'Use included, system gettext library, or try sytem gettext first',
144 'auto', allowed_values = (
145 'auto', # detect gettext, if not found, use included
146 'included', # always use included gettext
147 'system', # always use system gettext, fail if can not find
150 EnumOption('spell', 'Choose spell checker to use.', 'auto',
151 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
153 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
154 allowed_values = ('windows', 'posix', 'macosx')),
156 BoolOption('fast_start', 'This option is obsolete.', False),
157 # No precompiled header support (too troublesome to make it work for msvc)
158 # BoolOption('pch', 'Whether or not use pch', False),
159 # enable assertion, (config.h has ENABLE_ASSERTIOS
160 BoolOption('assertions', 'Use assertions', True),
161 # config.h define _GLIBCXX_CONCEPT_CHECKS
162 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
163 BoolOption('concept_checks', 'Enable concept checks', True),
165 BoolOption('nls', 'Whether or not use native language support', True),
167 BoolOption('profiling', 'Whether or not enable profiling', False),
168 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
169 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
171 BoolOption('X11', 'Use x11 windows system', default_with_x),
172 # use MS VC++ to build lyx
173 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
175 PathOption('qt_dir', 'Path to qt directory', None),
177 PathOption('qt_inc_path', 'Path to qt include directory', None),
179 PathOption('qt_lib_path', 'Path to qt library directory', None),
180 # extra include and libpath
181 PathOption('extra_inc_path', 'Extra include path', None),
183 PathOption('extra_lib_path', 'Extra library path', None),
185 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
187 PathOption('extra_inc_path1', 'Extra include path', None),
189 PathOption('extra_lib_path1', 'Extra library path', None),
190 # rebuild only specifed, comma separated targets
191 ('rebuild', '''rebuild only specifed, comma separated targets.
192 yes or all (default): rebuild everything
193 no or none: rebuild nothing (usually used for installation)
194 comp1,comp2,...: rebuild specified targets''', None),
195 # can be set to a non-existing directory
196 ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
197 # replace the default name and location of the windows installer
198 ('win_installer', 'name or full path to the windows installer', None),
199 # the deps package used to create minimal installer (qt and other libraries)
200 ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
201 # whether or not build bundle installer
202 BoolOption('bundle', 'Whether or not build bundle installer', False),
203 # the bundle directory, containing bundled applications
204 PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
205 # build directory, will use $mode if not set
206 ('build_dir', 'Build directory', None),
208 ('version_suffix', 'install lyx as lyx-suffix', None),
209 # how to load options
210 ('load_option', '''load option from previous scons run. option can be
211 yes (default): load all options
212 no: do not load any option
213 opt1,opt2: load specified options
214 -opt1,opt2: load all options other than specified ones''', 'yes'),
216 ('optimization', 'optimization CCFLAGS option.', None),
218 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
220 ('logfile', 'save commands (not outputs) to logfile', default_log_file),
221 # provided for backward compatibility
222 ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
223 # environment variable can be set as options.
224 ('DESTDIR', 'install to DESTDIR', None),
225 ('CC', 'replace default $CC', None),
226 ('LINK', 'replace default $LINK', None),
227 ('CPP', 'replace default $CPP', None),
228 ('CXX', 'replace default $CXX', None),
229 ('CXXCPP', 'replace default $CXXCPP', None),
230 ('CCFLAGS', 'replace default $CCFLAGS', None),
231 ('CPPFLAGS', 'replace default $CPPFLAGS', None),
232 ('LINKFLAGS', 'replace default $LINKFLAGS', None),
236 all_options = [x.key for x in opts.options]
238 # copied from SCons/Options/BoolOption.py
239 # We need to use them before a boolean ARGUMENTS option is available
241 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
242 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
244 if ARGUMENTS.has_key('fast_start'):
245 print 'fast_start option is obsolete'
247 # if load_option=yes (default), load saved comand line options
249 # This option can take value yes/no/opt1,opt2/-opt1,opt2
250 # and tries to be clever in choosing options to load
251 if (not ARGUMENTS.has_key('load_option') or \
252 ARGUMENTS['load_option'] not in false_strings) \
253 and os.path.isfile(opt_cache_file):
254 cache_file = open(opt_cache_file)
255 opt_cache = cPickle.load(cache_file)
257 # import cached options, but we should ignore qt_dir when frontend changes
258 if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
259 and ARGUMENTS['frontend'] != opt_cache['frontend'] \
260 and opt_cache.has_key('qt_dir'):
261 opt_cache.pop('qt_dir')
262 # and we do not cache some options (dest_dir is obsolete)
263 for arg in ['load_option', 'dest_dir', 'bundle']:
264 if opt_cache.has_key(arg):
266 # remove obsolete cached keys (well, SConstruct is evolving. :-)
267 for arg in opt_cache.keys():
268 if arg not in all_options:
269 print 'Option %s is obsolete, do not load it' % arg
271 # now, if load_option=opt1,opt2 or -opt1,opt2
272 if ARGUMENTS.has_key('load_option') and \
273 ARGUMENTS['load_option'] not in true_strings + false_strings:
274 # if -opt1,opt2 is specified, do not load these options
275 if ARGUMENTS['load_option'][0] == '-':
276 for arg in ARGUMENTS['load_option'][1:].split(','):
277 if opt_cache.has_key(arg):
279 # if opt1,opt2 is specified, only load specified options
281 args = ARGUMENTS['load_option'].split(',')
282 for arg in opt_cache.keys():
285 # now restore options as if entered from command line
286 for key in opt_cache.keys():
287 if not ARGUMENTS.has_key(key):
288 ARGUMENTS[key] = opt_cache[key]
289 print "Restoring cached option %s=%s" % (key, ARGUMENTS[key])
292 # check if there is unused (or misspelled) argument
293 for arg in ARGUMENTS.keys():
294 if arg not in all_options:
296 print "Unknown option '%s'... exiting." % arg
298 print "Available options are (check 'scons -help' for details):"
299 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
303 cache_file = open(opt_cache_file, 'w')
304 cPickle.dump(ARGUMENTS, cache_file)
307 #---------------------------------------------------------
308 # Setting up environment
309 #---------------------------------------------------------
311 # I do not really like ENV=os.environ, but you may add it
312 # here if you experience some environment related problem
313 env = Environment(options = opts)
315 # set individual variables since I do not really like ENV = os.environ
316 env['ENV']['PATH'] = os.environ.get('PATH')
317 env['ENV']['HOME'] = os.environ.get('HOME')
318 # these are defined for MSVC
319 env['ENV']['LIB'] = os.environ.get('LIB')
320 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
322 # for simplicity, use var instead of env[var]
323 frontend = env['frontend']
324 prefix = env['prefix']
327 if platform_name == 'win32':
328 if env.has_key('use_vc'):
329 use_vc = env['use_vc']
330 if WhereIs('cl.exe') is None:
331 print "cl.exe is not found. Are you using the MSVC environment?"
333 elif WhereIs('cl.exe') is not None:
340 # lyx will be built to $build/build_dir so it is possible
341 # to build multiple build_dirs using the same source
342 # $mode can be debug or release
343 if env.has_key('build_dir') and env['build_dir'] is not None:
344 # create the directory if needed
345 if not os.path.isdir(env['build_dir']):
347 os.makedirs(env['build_dir'])
350 if not os.path.isdir(env['build_dir']):
351 print 'Can not create directory', env['build_dir']
353 env['BUILDDIR'] = env['build_dir']
355 # Determine the name of the build $mode
356 env['BUILDDIR'] = '#' + mode
358 # all built libraries will go to build_dir/libs
359 # (This is different from the make file approach)
360 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
361 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
364 # Here is a summary of variables defined in env
366 # 2. undefined options with a non-None default value
367 # 3. compiler commands and flags like CCFLAGS.
368 # MSGFMT used to process po files
369 # 4. Variables that will be used to replace variables in some_file.in
370 # src/support/Package.cpp.in:
371 # TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
372 # lib/lyx2lyx/lyx2lyx_version.py.in
375 # full path name is used to build msvs project files
376 # and to replace TOP_SRCDIR in package.C
377 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
379 # determine share_dir etc
380 packaging_method = env.get('packaging')
381 if packaging_method == 'windows':
382 share_dir = 'Resources'
383 man_dir = 'Resources/man/man1'
384 locale_dir = 'Resources/locale'
386 share_dir = 'share/lyx'
387 locale_dir = 'share/locale'
388 if platform_name == 'cygwin':
389 man_dir = 'share/man/man1'
393 # program suffix: can be yes, or a string
394 if env.has_key('version_suffix'):
395 if env['version_suffix'] in true_strings:
396 program_suffix = package_version
397 elif env['version_suffix'] in false_strings:
400 program_suffix = env['version_suffix']
403 # used by Package.cpp.in
404 env['PROGRAM_SUFFIX'] = program_suffix
406 # whether or not add suffix to file and directory names
407 add_suffix = packaging_method != 'windows'
408 # LYX_DIR are different (used in Package.cpp.in)
410 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
412 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
413 # we need absolute path for package.C
414 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
417 #---------------------------------------------------------
418 # Setting building environment (Tools, compiler flags etc)
419 #---------------------------------------------------------
421 # Since Tool('mingw') will reset CCFLAGS etc, this should be
422 # done before getEnvVariable
423 if platform_name == 'win32':
429 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
430 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
432 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
435 # we differentiate between hard-coded options and default options
436 # hard-coded options are required and will always be there
437 # default options can be replaced by enviromental variables or command line options
438 CCFLAGS_required = []
439 LINKFLAGS_required = []
442 # under windows, scons is confused by .C/.c and uses gcc instead of
443 # g++. I am forcing the use of g++ here. This is expected to change
444 # after lyx renames all .C files to .cpp
446 # save the old c compiler and CCFLAGS (used by libintl)
447 C_COMPILER = env.subst('$CC')
448 C_CCFLAGS = env.subst('$CCFLAGS').split()
449 # if we use ms vc, the commands are fine (cl.exe and link.exe)
451 # /TP treat all source code as C++
452 # C4819: The file contains a character that cannot be represented
453 # in the current code page (number)
454 # C4996: foo was decleared deprecated
455 CCFLAGS_required.extend(['/TP', '/EHsc'])
457 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
458 # the flags are also needed in C mode (for intl lib)
459 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
461 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
462 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
464 if env.has_key('CXX') and env['CXX']:
465 env['CC'] = env.subst('$CXX')
466 env['LINK'] = env.subst('$CXX')
471 # for debug/release mode
472 if env.has_key('optimization') and env['optimization'] is not None:
473 # if user supplies optimization flags, use it anyway
474 CCFLAGS_required.extend(env['optimization'].split())
475 # and do not use default
476 set_default_optimization_flags = False
478 set_default_optimization_flags = True
482 CCFLAGS_required.append('/Zi')
483 LINKFLAGS_required.extend(['/debug', '/map'])
485 CCFLAGS_required.append('-g')
486 CCFLAGS_default.append('-O')
487 elif mode == 'release' and set_default_optimization_flags:
489 CCFLAGS_default.append('/O2')
491 CCFLAGS_default.append('-O2')
493 # msvc uses separate tools for profiling
494 if env.has_key('profiling') and env['profiling']:
496 print 'Visual C++ does not use profiling options'
498 CCFLAGS_required.append('-pg')
499 LINKFLAGS_required.append('-pg')
501 if env.has_key('warnings') and env['warnings']:
503 CCFLAGS_default.append('/W2')
505 # Note: autotools detect gxx version and pass -W for 3.x
506 # and -Wextra for other versions of gcc
507 CCFLAGS_default.append('-Wall')
509 # Now, set the variables as follows:
510 # 1. if command line option exists: replace default
511 # 2. then if s envronment variable exists: replace default
512 # 3. set variable to required + default
513 def setEnvVariable(env, name, required = None, default = None, split = True):
514 ''' env: environment to set variable
516 required: hardcoded options
517 default: default options that can be replaced by command line or
518 environment variables
519 split: whether or not split obtained variable like '-02 -g'
521 # 1. ARGUMENTS is already set to env[name], override default.
522 if ARGUMENTS.has_key(name):
523 # env[name] may be rewritten when building tools are reloaded
524 # if that is the case, commandline option will override it.
525 env[name] = ARGUMENTS[name]
527 # then use environment default
528 elif os.environ.has_key(name):
529 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
530 default = os.environ[name]
532 default = default.split()
533 # the real value should be env[name] + default + required
536 if env.has_key(name):
537 value = str(env[name]).split()
538 if required is not None:
540 if default is not None:
544 if env.has_key(name):
545 value = str(env[name])
546 if required is not None:
547 value += " " + required
548 if default is not None:
549 value += " " + default
551 # print name, env[name]
553 setEnvVariable(env, 'DESTDIR', split=False)
554 setEnvVariable(env, 'CC')
555 setEnvVariable(env, 'LINK')
556 setEnvVariable(env, 'CPP')
557 setEnvVariable(env, 'CXX')
558 setEnvVariable(env, 'CXXCPP')
559 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
560 setEnvVariable(env, 'CXXFLAGS')
561 setEnvVariable(env, 'CPPFLAGS')
562 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
564 # if DESTDIR is not set...
565 if env.has_key('dest_dir'):
566 print "This option is obsolete. Please use DESTDIR instead."
567 env['DESTDIR'] = env['dest_dir']
570 # extra_inc_path and extra_lib_path
573 if env.has_key('extra_inc_path') and env['extra_inc_path']:
574 extra_inc_paths.append(env['extra_inc_path'])
575 if env.has_key('extra_lib_path') and env['extra_lib_path']:
576 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
577 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
578 extra_inc_paths.append(env['extra_inc_path1'])
579 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
580 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
581 if env.has_key('extra_bin_path') and env['extra_bin_path']:
582 # only the first one is needed (a scons bug?)
583 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
584 env.PrependENVPath('PATH', env['extra_bin_path'])
585 # extra_inc_paths will be used later by intlenv etc
586 env.AppendUnique(CPPPATH = extra_inc_paths)
589 #----------------------------------------------------------
591 #----------------------------------------------------------
593 conf = Configure(env,
595 'CheckPkgConfig' : utils.checkPkgConfig,
596 'CheckPackage' : utils.checkPackage,
597 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
598 'CheckSelectArgType' : utils.checkSelectArgType,
599 'CheckBoostLibraries' : utils.checkBoostLibraries,
600 'CheckCommand' : utils.checkCommand,
601 'CheckNSIS' : utils.checkNSIS,
602 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
603 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
604 'CheckIconvConst' : utils.checkIconvConst,
605 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
606 'CheckDeclaration' : utils.checkDeclaration,
610 # When using msvc, windows.h is required
611 if use_vc and not conf.CheckCHeader('windows.h'):
612 print 'Windows.h is not found. Please install Windows Platform SDK.'
613 print 'Please check config.log for more information.'
616 # pkg-config? (if not, we use hard-coded options)
617 if conf.CheckPkgConfig('0.15.0'):
618 env['HAS_PKG_CONFIG'] = True
620 print 'pkg-config >= 0.1.50 is not found'
621 env['HAS_PKG_CONFIG'] = False
623 # zlib? This is required.
624 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
625 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
626 print 'Did not find zdll.lib or zlib.h, exiting!'
627 print 'Please check config.log for more information.'
629 if conf.CheckLib('iconv'):
630 env['ICONV_LIB'] = 'iconv'
631 elif conf.CheckLib('libiconv'):
632 env['ICONV_LIB'] = 'libiconv'
633 elif conf.CheckFunc('iconv_open'):
634 env['ICONV_LIB'] = None
636 print 'Did not find iconv or libiconv, exiting!'
637 print 'Please check config.log for more information.'
642 if conf.CheckLib('socket'):
643 socket_libs.append('socket')
644 # nsl is the network services library and provides a
645 # transport-level interface to networking services.
646 if conf.CheckLib('nsl'):
647 socket_libs.append('nsl')
649 # check available boost libs (since lyx1.4 does not use iostream)
651 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
652 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
653 boost_libs.append(lib)
655 # check boost libraries
656 boost_opt = ARGUMENTS.get('boost', 'auto')
657 # check for system boost
658 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
659 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
660 # default to $BUILDDIR/libs (use None since this path will be added anyway)
662 # here I assume that all libraries are in the same directory
663 if boost_opt == 'included':
664 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
665 included_boost = True
666 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
667 elif boost_opt == 'auto':
668 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
669 # if not found, use local boost
671 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
672 included_boost = True
673 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
675 included_boost = False
676 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
677 elif boost_opt == 'system':
678 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
680 print "Can not find system boost libraries with version %s " % boost_version
681 print "Please supply a path through extra_lib_path and try again."
682 print "Or use boost=included to use included boost libraries."
685 included_boost = False
686 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
689 if boost_libpath is not None:
690 env.AppendUnique(LIBPATH = [boost_libpath])
693 env['ENABLE_NLS'] = env['nls']
695 if not env['ENABLE_NLS']:
697 included_gettext = False
699 # check gettext libraries
700 gettext_opt = ARGUMENTS.get('gettext', 'auto')
701 # check for system gettext
703 if gettext_opt in ['auto', 'system']:
704 if conf.CheckFunc('gettext'):
705 included_gettext = False
708 elif conf.CheckLib('intl'):
709 included_gettext = False
713 if gettext_opt == 'system':
714 print "Can not find system gettext library"
715 print "Please supply a path through extra_lib_path and try again."
716 print "Or use gettext=included to use included gettext libraries."
718 # now, auto and succ = false, or gettext=included
720 # we do not need to set LIBPATH now.
721 included_gettext = True
722 intl_libs = ['included_intl']
726 # check for msgfmt command
727 env['MSGFMT'] = conf.CheckCommand('msgfmt')
728 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
729 env['XGETTEXT'] = conf.CheckCommand('xgettext')
730 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
732 # if under windows, check the nsis compiler
733 if platform_name == 'win32':
734 env['NSIS'] = conf.CheckNSIS()
736 # cygwin packaging requires the binaries to be stripped
737 if platform_name == 'cygwin':
738 env['STRIP'] = conf.CheckCommand('strip')
741 # Customized builders
743 # install customized builders
744 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
745 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
746 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
749 #----------------------------------------------------------
750 # Generating config.h
751 #----------------------------------------------------------
752 aspell_lib = 'aspell'
753 # assume that we use aspell, aspelld compiled for msvc
754 if platform_name == 'win32' and mode == 'debug' and use_vc:
755 aspell_lib = 'aspelld'
757 # check the existence of config.h
758 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
759 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
761 print "Creating %s..." % boost_config_h
763 utils.createConfigFile(conf,
764 config_file = boost_config_h,
765 config_pre = '''/* boost/config.h. Generated by SCons. */
770 * This file is part of LyX, the document processor.
771 * Licence details can be found in the file COPYING.
773 * This is the compilation configuration file for LyX.
774 * It was generated by scon.
775 * You might want to change some of the defaults if something goes wrong
776 * during the compilation.
779 #ifndef _BOOST_CONFIG_H
780 #define _BOOST_CONFIG_H
783 ('ostream', 'HAVE_OSTREAM', 'cxx'),
784 ('locale', 'HAVE_LOCALE', 'cxx'),
785 ('sstream', 'HAVE_SSTREAM', 'cxx'),
786 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
789 (env.has_key('assertions') and env['assertions'],
791 'Define if you want assertions to be enabled in the code'
795 ('wchar_t', 'HAVE_WCHAR_T', None),
799 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
800 # define USE_BOOST_FORMAT 1
802 # define USE_BOOST_FORMAT 0
805 #if !defined(ENABLE_ASSERTIONS)
806 # define BOOST_DISABLE_ASSERTS 1
808 #define BOOST_ENABLE_ASSERT_HANDLER 1
810 #define BOOST_DISABLE_THREADS 1
811 #define BOOST_NO_WSTRING 1
814 # define BOOST_POSIX 1
815 # define BOOST_POSIX_API 1
816 # define BOOST_POSIX_PATH 1
819 #define BOOST_ALL_NO_LIB 1
821 #if defined(HAVE_NEWAPIS_H)
822 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
826 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
827 * support compiled in:
828 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
829 * And we are not interested at all what libc
830 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
831 * has the needed wchar_t support and uses UCS4. Whether it
832 * implements this with the help of libc, or whether it has own code
833 * does not matter for us, because we don't use libc directly (Georg)
835 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
843 print "\nGenerating %s..." % config_h
845 # AIKSAURUS_H_LOCATION
846 if (conf.CheckCXXHeader("Aiksaurus.h")):
847 aik_location = '<Aiksaurus.h>'
848 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
849 aik_location = '<Aiksaurus/Aiksaurus.h>'
853 # determine headers to use
854 spell_opt = ARGUMENTS.get('spell', 'auto')
855 env['USE_ASPELL'] = False
856 env['USE_PSPELL'] = False
857 env['USE_ISPELL'] = False
858 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
859 spell_engine = 'USE_ASPELL'
860 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
861 spell_engine = 'USE_PSPELL'
862 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
863 spell_engine = 'USE_ISPELL'
867 if spell_engine is not None:
868 env[spell_engine] = True
870 if spell_opt == 'auto':
871 print "Warning: Can not locate any spell checker"
872 elif spell_opt != 'no':
873 print "Warning: Can not locate specified spell checker:", spell_opt
874 print 'Please check config.log for more information.'
877 # check arg types of select function
878 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
880 # check the size of wchar_t
881 sizeof_wchar_t = conf.CheckSizeOfWChar()
883 if sizeof_wchar_t == 0:
884 print 'Error: Can not determine the size of wchar_t.'
885 print 'Please check config.log for more information.'
890 result = utils.createConfigFile(conf,
891 config_file = config_h,
892 config_pre = '''/* config.h. Generated by SCons. */
897 * This file is part of LyX, the document processor.
898 * Licence details can be found in the file COPYING.
900 * This is the compilation configuration file for LyX.
901 * It was generated by scon.
902 * You might want to change some of the defaults if something goes wrong
903 * during the compilation.
910 ('io.h', 'HAVE_IO_H', 'c'),
911 ('limits.h', 'HAVE_LIMITS_H', 'c'),
912 ('locale.h', 'HAVE_LOCALE_H', 'c'),
913 ('process.h', 'HAVE_PROCESS_H', 'c'),
914 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
915 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
916 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
917 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
918 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
919 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
920 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
921 ('utime.h', 'HAVE_UTIME_H', 'c'),
922 ('direct.h', 'HAVE_DIRECT_H', 'c'),
923 ('istream', 'HAVE_ISTREAM', 'cxx'),
924 ('ios', 'HAVE_IOS', 'cxx'),
927 ('open', 'HAVE_OPEN', None),
928 ('chmod', 'HAVE_CHMOD', None),
929 ('close', 'HAVE_CLOSE', None),
930 ('popen', 'HAVE_POPEN', None),
931 ('pclose', 'HAVE_PCLOSE', None),
932 ('_open', 'HAVE__OPEN', None),
933 ('_close', 'HAVE__CLOSE', None),
934 ('_popen', 'HAVE__POPEN', None),
935 ('_pclose', 'HAVE__PCLOSE', None),
936 ('getpid', 'HAVE_GETPID', None),
937 ('_getpid', 'HAVE__GETPID', None),
938 ('mkdir', 'HAVE_MKDIR', None),
939 ('_mkdir', 'HAVE__MKDIR', None),
940 ('mktemp', 'HAVE_MKTEMP', None),
941 ('mkstemp', 'HAVE_MKSTEMP', None),
942 ('strerror', 'HAVE_STRERROR', None),
943 ('getcwd', 'HAVE_GETCWD', None),
944 ('setenv', 'HAVE_SETENV', None),
945 ('putenv', 'HAVE_PUTENV', None),
946 ('fcntl', 'HAVE_FCNTL', None),
947 ('mkfifo', 'HAVE_MKFIFO', None),
950 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
953 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
954 '#include <streambuf>\n#include <istream>'),
955 ('wchar_t', 'HAVE_WCHAR_T', None),
956 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
959 ('gdi32', 'HAVE_LIBGDI32'),
960 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
963 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
965 'Define is sys/types.h does not have pid_t',
969 (conf.CheckCXXGlobalCstd(),
971 'Define if your C++ compiler puts C library functions in the global namespace'
973 (conf.CheckMkdirOneArg(),
974 'MKDIR_TAKES_ONE_ARG',
975 'Define if mkdir takes only one argument.'
977 (conf.CheckIconvConst(),
979 'Define as const if the declaration of iconv() needs const.',
980 '#define ICONV_CONST const',
981 '#define ICONV_CONST',
983 (conf.CheckLC_MESSAGES(),
985 'Define if your <locale.h> file defines LC_MESSAGES.'
987 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
990 "Define to 1 if translation of program messages to the user's native anguage is requested.",
992 (env['nls'] and not included_gettext,
994 'Define to 1 if using system gettext library'
996 (env.has_key('concept_checks') and env['concept_checks'],
997 '_GLIBCXX_CONCEPT_CHECKS',
998 'libstdc++ concept checking'
1000 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1002 'libstdc++ debug mode'
1004 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1005 '_GLIBCXX_DEBUG_PEDANTIC',
1006 'libstdc++ pedantic debug mode'
1008 (os.name != 'nt', 'BOOST_POSIX',
1009 'Indicates to boost < 1.34 which API to use (posix or windows).'
1011 (os.name != 'nt', 'BOOST_POSIX_API',
1012 'Indicates to boost 1.34 which API to use (posix or windows).'
1014 (os.name != 'nt', 'BOOST_POSIX_PATH',
1015 'Indicates to boost 1.34 which path style to use (posix or windows).'
1017 (spell_engine is not None, spell_engine,
1018 'Spell engine to use'
1020 # we need to know the byte order for unicode conversions
1021 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1022 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1026 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1028 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1029 'Define to the address where bug reports for this package should be sent.'),
1030 ('#define PACKAGE_NAME "%s"' % package_name,
1031 'Define to the full name of this package.'),
1032 ('#define PACKAGE_STRING "%s"' % package_string,
1033 'Define to the full name and version of this package.'),
1034 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1035 'Define to the one symbol short name of this package.'),
1036 ('#define PACKAGE_VERSION "%s"' % package_version,
1037 'Define to the version of this package.'),
1038 ('#define BOOST_ALL_NO_LIB 1',
1039 'disable automatic linking of boost libraries.'),
1040 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1041 'Packaging method'),
1042 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1043 'Aiksaurus include file'),
1044 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1045 "Define to the type of arg 1 for `select'."),
1046 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1047 "Define to the type of arg 2, 3, 4 for `select'."),
1048 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1049 "Define to the type of arg 5 for `select'."),
1050 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1051 'Define to be the size of type wchar_t'),
1053 config_post = '''/************************************************************
1054 ** You should not need to change anything beyond this point */
1056 #ifndef HAVE_STRERROR
1057 #if defined(__cplusplus)
1060 char * strerror(int n);
1063 #include <../boost/config.h>
1069 # these keys are needed in env
1070 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1071 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1072 # USE_ASPELL etc does not go through result
1073 if result.has_key(key):
1074 env[key] = result[key]
1077 # if nls=yes and gettext=included, create intl/config.h
1078 # intl/libintl.h etc
1080 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1081 if env['nls'] and included_gettext:
1083 print "Creating %s..." % intl_config_h
1085 # create intl/config.h
1086 result = utils.createConfigFile(conf,
1087 config_file = intl_config_h,
1088 config_pre = '''/* intl/config.h. Generated by SCons. */
1093 * This file is part of LyX, the document processor.
1094 * Licence details can be found in the file COPYING.
1096 * This is the compilation configuration file for LyX.
1097 * It was generated by scon.
1098 * You might want to change some of the defaults if something goes wrong
1099 * during the compilation.
1106 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1107 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1108 ('string.h', 'HAVE_STRING_H', 'c'),
1109 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1110 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1111 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1112 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1113 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1114 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1115 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1118 ('getcwd', 'HAVE_GETCWD', None),
1119 ('stpcpy', 'HAVE_STPCPY', None),
1120 ('strcasecmp', 'HAVE_STRCASECMP', None),
1121 ('strdup', 'HAVE_STRDUP', None),
1122 ('strtoul', 'HAVE_STRTOUL', None),
1123 ('alloca', 'HAVE_ALLOCA', None),
1124 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1125 ('mempcpy', 'HAVE_MEMPCPY', None),
1126 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1127 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1128 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1129 ('setlocale', 'HAVE_SETLOCALE', None),
1130 ('tsearch', 'HAVE_TSEARCH', None),
1131 ('getegid', 'HAVE_GETEGID', None),
1132 ('getgid', 'HAVE_GETGID', None),
1133 ('getuid', 'HAVE_GETUID', None),
1134 ('wcslen', 'HAVE_WCSLEN', None),
1135 ('asprintf', 'HAVE_ASPRINTF', None),
1136 ('wprintf', 'HAVE_WPRINTF', None),
1137 ('snprintf', 'HAVE_SNPRINTF', None),
1138 ('printf', 'HAVE_POSIX_PRINTF', None),
1139 ('fcntl', 'HAVE_FCNTL', None),
1142 ('intmax_t', 'HAVE_INTMAX_T', None),
1143 ('long double', 'HAVE_LONG_DOUBLE', None),
1144 ('long long', 'HAVE_LONG_LONG', None),
1145 ('wchar_t', 'HAVE_WCHAR_T', None),
1146 ('wint_t', 'HAVE_WINT_T', None),
1147 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1148 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1154 (conf.CheckLC_MESSAGES(),
1156 'Define if your <locale.h> file defines LC_MESSAGES.'
1158 (conf.CheckIconvConst(),
1160 'Define as const if the declaration of iconv() needs const.',
1161 '#define ICONV_CONST const',
1162 '#define ICONV_CONST',
1164 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1165 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1167 "Define to 1 if you have the `intmax_t' type."
1169 (env.has_key('nls') and env['nls'],
1171 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1175 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1176 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1177 'Define to be the size of type wchar_t'),
1179 config_post = '#endif'
1182 # these keys are needed in env
1183 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1184 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1185 # USE_ASPELL etc does not go through result
1186 if result.has_key(key):
1187 env[key] = result[key]
1190 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1191 if env['nls'] and included_gettext:
1192 # libgnuintl.h.in => libintl.h
1193 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1194 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1195 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1196 [Copy('$TARGET', '$SOURCE')])
1199 # Finish auto-configuration
1202 #----------------------------------------------------------
1203 # Now set up our build process accordingly
1204 #----------------------------------------------------------
1206 if env['ICONV_LIB'] is None:
1209 system_libs = [env['ICONV_LIB']]
1210 if platform_name in ['win32', 'cygwin']:
1211 # the final link step needs stdc++ to succeed under mingw
1212 # FIXME: shouldn't g++ automatically link to stdc++?
1214 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1216 system_libs += ['shlwapi', 'stdc++', 'z']
1217 elif platform_name == 'cygwin' and env['X11']:
1218 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1219 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1220 'resolv', 'pthread', 'z']
1222 system_libs += ['z']
1225 ('HAVE_LIBGDI32', 'gdi32'),
1226 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1227 ('USE_ASPELL', aspell_lib),
1228 ('USE_ISPELL', 'ispell'),
1229 ('USE_PSPELL', 'pspell'),
1234 system_libs.append(lib[1])
1237 # Build parameters CPPPATH etc
1240 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1243 # boost: for boost header files
1244 # BUILDDIR/common: for config.h
1245 # TOP_SRCDIR/src: for support/* etc
1247 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1249 # Separating boost directories from CPPPATH stops scons from building
1250 # the dependency tree for boost header files, and effectively reduce
1251 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1252 # boost headers, this is only done for system boost headers.
1254 env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1257 env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1259 env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1261 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1262 if env['nls'] and included_gettext:
1263 env['CPPPATH'].append('$BUILDDIR/intl')
1267 # A Link script for cygwin see
1268 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1269 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1272 if platform_name == 'cygwin':
1273 ld_script_path = '/tmp'
1274 ld_script = utils.installCygwinLDScript(ld_script_path)
1275 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1276 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1279 #---------------------------------------------------------
1280 # Frontend related variables (QTDIR etc)
1281 #---------------------------------------------------------
1284 # create a separate environment so that other files do not have
1285 # to be built with all the include directories etc
1287 if frontend == 'qt4':
1288 frontend_env = env.Copy()
1290 # handle qt related user specified paths
1291 # set environment so that moc etc can be found even if its path is not set properly
1292 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1293 frontend_env['QTDIR'] = frontend_env['qt_dir']
1294 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1295 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1296 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1297 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1298 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1300 # if separate qt_lib_path is given
1301 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1302 qt_lib_path = frontend_env.subst('$qt_lib_path')
1303 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1304 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1308 # if separate qt_inc_path is given
1309 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1310 qt_inc_path = frontend_env['qt_inc_path']
1314 # local qt4 toolset from
1315 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1317 # NOTE: I have to patch qt4.py since it does not automatically
1318 # process .C file!!! (add to cxx_suffixes )
1320 frontend_env.Tool('qt4', [scons_dir])
1321 frontend_env['QT_AUTOSCAN'] = 0
1322 frontend_env['QT4_AUTOSCAN'] = 0
1323 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1325 if qt_lib_path is None:
1326 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1327 if qt_inc_path is None:
1328 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1331 conf = Configure(frontend_env,
1333 'CheckPackage' : utils.checkPackage,
1334 'CheckCommand' : utils.checkCommand,
1339 # first: try pkg_config
1340 if frontend_env['HAS_PKG_CONFIG']:
1341 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1342 # FIXME: use pkg_config information?
1343 #frontend_env['QT4_PKG_CONFIG'] = succ
1344 # second: try to link to it
1346 # Under linux, I can test the following perfectly
1347 # Under windows, lib names need to passed as libXXX4.a ...
1348 if platform_name == 'win32':
1349 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1351 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1352 # still can not find it
1354 print 'Did not find qt libraries, exiting!'
1355 print 'Please check config.log for more information.'
1358 # Now, determine the correct suffix:
1359 qt_libs = ['QtCore', 'QtGui']
1360 if platform_name == 'win32':
1361 if mode == 'debug' and use_vc and \
1362 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1363 qt_lib_suffix = 'd4'
1364 use_qt_debug_libs = True
1367 use_qt_debug_libs = False
1369 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1370 qt_lib_suffix = '_debug'
1371 use_qt_debug_libs = True
1374 use_qt_debug_libs = False
1375 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1376 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1377 qtcore_lib = ['QtCore' + qt_lib_suffix]
1379 # check uic and moc commands for qt frontends
1380 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1381 print 'uic or moc command is not found for frontend', frontend
1384 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1385 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1386 # For some unknown changes in msvc or qt, this is no longer needed.
1388 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1389 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1390 env.File('$BUILDDIR/lyx.exe.manifest').path]
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 update_manifest = 'update_manifest' in targets
1518 build_po = 'po' in targets or build_install or 'all' in targets
1519 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1520 build_msvs_projects = use_vc and 'msvs_projects' in targets
1523 # now, if rebuild_targets is specified, do not rebuild some targets
1524 if rebuild_targets is not None:
1526 def ifBuildLib(name, libname, old_value):
1527 # explicitly asked to rebuild
1528 if name in rebuild_targets:
1530 # else if not rebuild, and if the library already exists
1531 elif libExists(libname):
1533 # do not change the original value
1536 build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1537 build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1538 build_support = ifBuildLib('support', 'support', build_support)
1539 build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1540 build_insets = ifBuildLib('insets', 'insets', build_insets)
1541 build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1542 build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1543 build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1544 build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1545 build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1547 def ifBuildApp(name, appname, old_value):
1548 # explicitly asked to rebuild
1549 if name in rebuild_targets:
1551 # else if not rebuild, and if the library already exists
1552 elif appExists(name, appname):
1554 # do not change the original value
1557 build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1558 build_client = ifBuildApp('client', 'lyxclient', build_client)
1560 # sync frontend and frontend (?)
1570 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1572 boostenv = env.Copy()
1574 # boost use its own config.h
1575 boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1576 boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1578 for lib in boost_libs:
1579 print 'Processing files in boost/libs/%s/src...' % lib
1580 boostlib = boostenv.StaticLibrary(
1581 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1582 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1584 Alias('boost', boostlib)
1591 intlenv = env.Copy()
1593 print "Processing files in intl..."
1595 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1597 # we need the original C compiler for these files
1598 intlenv['CC'] = C_COMPILER
1599 intlenv['CCFLAGS'] = C_CCFLAGS
1601 intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1602 # intl does not use global config.h
1603 intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1605 intlenv.Append(CCFLAGS = [
1606 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1607 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1608 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1610 '-DENABLE_RELOCATABLE=1',
1612 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1614 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1615 '-Drelocate=libintl_relocate',
1616 '-DDEPENDS_ON_LIBICONV=1',
1621 intl = intlenv.StaticLibrary(
1622 target = '$LOCALLIBPATH/included_intl',
1624 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1630 # Now, src code under src/
1632 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1639 print "Processing files in src/support..."
1641 frontend_env.Depends('$BUILDDIR/common/support/Package.cpp', '$BUILDDIR/common/config.h')
1642 Package_cpp = env.substFile('$BUILDDIR/common/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1644 support = frontend_env.StaticLibrary(
1645 target = '$LOCALLIBPATH/support',
1646 source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files] + Package_cpp,
1650 '-DQT_CLEAN_NAMESPACE',
1657 Alias('support', support)
1664 print "Processing files in src/mathed..."
1666 mathed = env.StaticLibrary(
1667 target = '$LOCALLIBPATH/mathed',
1668 source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1670 Alias('mathed', mathed)
1677 print "Processing files in src/insets..."
1679 insets = env.StaticLibrary(
1680 target = '$LOCALLIBPATH/insets',
1681 source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1683 Alias('insets', insets)
1690 print "Processing files in src/frontends..."
1692 frontends = env.StaticLibrary(
1693 target = '$LOCALLIBPATH/frontends',
1694 source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1696 Alias('frontends', frontends)
1703 print "Processing files in src/graphics..."
1705 graphics = env.StaticLibrary(
1706 target = '$LOCALLIBPATH/graphics',
1707 source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1709 Alias('graphics', graphics)
1712 if build_controllers:
1714 # src/frontends/controllers
1716 print "Processing files in src/frontends/controllers..."
1718 controllers = env.StaticLibrary(
1719 target = '$LOCALLIBPATH/controllers',
1720 source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1722 Alias('controllers', controllers)
1729 env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1731 print "Processing files in src/frontends/qt4..."
1734 # moc qt4_moc_files, the moced files are included in the original 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/qt4/ui',
1746 '$BUILDDIR/common/frontends/controllers'
1751 '-DQT_CLEAN_NAMESPACE',
1764 frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1766 print "Processing files in src/client..."
1768 if env['HAVE_FCNTL']:
1769 client = frontend_env.Program(
1770 target = '$BUILDDIR/common/client/lyxclient',
1771 LIBS = ['support'] + intl_libs + system_libs +
1772 socket_libs + boost_libraries + qtcore_lib,
1773 source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1774 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1776 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1777 client, [Copy('$TARGET', '$SOURCE')]))
1780 Alias('client', client)
1782 if env['HAVE_FCNTL']:
1783 # define client even if lyxclient is not built with rebuild=no
1784 client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1793 print "Processing files in src/tex2lyx..."
1796 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
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 + src_tex2lyx_copied_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 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1823 src_post_files.append('ASpell.cpp')
1824 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1825 src_post_files.append('PSpell.cpp')
1826 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1827 src_post_files.append('ISpell.cpp')
1829 # msvc requires at least one source file with main()
1830 # so I exclude main.cpp from lyxbase
1831 lyxbase_pre = env.StaticLibrary(
1832 target = '$LOCALLIBPATH/lyxbase_pre',
1833 source = ['$BUILDDIR/common/%s' % x for x in src_pre_files]
1835 lyxbase_post = env.StaticLibrary(
1836 target = '$LOCALLIBPATH/lyxbase_post',
1837 source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1839 Alias('lyxbase', lyxbase_pre)
1840 Alias('lyxbase', lyxbase_post)
1845 # Build lyx with given frontend
1847 lyx = frontend_env.Program(
1848 target = '$BUILDDIR/lyx',
1849 source = ['$BUILDDIR/common/main.cpp'] + \
1850 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1870 # define lyx even if lyx is not built with rebuild=no
1871 lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1874 if build_msvs_projects:
1875 def build_project(target, full_target = None,
1876 src = [], inc = [], res = [], rebuildTargetOnly = True):
1877 ''' build mavs project files
1878 target: alias (correspond to directory name)
1879 full_target: full path/filename of the target
1883 rebuildTargetOnly: whether or not only rebuild this target
1885 For non-debug-able targets like static libraries, target (alias) is
1886 enough to build the target. For executable targets, msvs need to know
1887 the full path to start debug them.
1889 if rebuildTargetOnly:
1890 cmds = 'rebuild='+target
1893 if full_target is None:
1894 build_target = target
1896 build_target = full_target
1898 proj = env.MSVSProject(
1899 target = target + env['MSVSPROJECTSUFFIX'],
1900 # this allows easy access to header files (along with source)
1901 srcs = [env.subst(x) for x in src + inc],
1902 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1903 localincs = [env.subst(x) for x in inc],
1904 resources = [env.subst(x) for x in res],
1905 buildtarget = build_target,
1909 Alias('msvs_projects', proj)
1911 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1912 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1913 rebuildTargetOnly = False,
1914 full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1916 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1917 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1918 rebuildTargetOnly = False,
1919 full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1921 build_project('lyx',
1922 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1923 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1924 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1925 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1926 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1927 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1928 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1929 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1930 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1931 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1932 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1933 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1934 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1935 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1936 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1937 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1938 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1939 rebuildTargetOnly = False,
1940 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1945 # update scons_manifest.py
1947 # When you run 'scons update_manifest', it tells you which files are missing
1948 # and which files are not in the source tree. It also generates a
1949 # scons_manifest.py.new file with all the missing files added to
1950 # XXX_extra_files. It will *not* change other sections of existing
1953 print 'Validating development/scons/scons_manifest.py...'
1955 manifest = open(env.File('$TOP_SRCDIR/development/scons/scons_manifest.py.new').abspath, 'w')
1956 print >> manifest, 'from SCons.Util import Split\n'
1958 ignore_dirs = ['boost/boost', 'm4', 'development',
1959 utils.relativePath(env.Dir('$BUILDDIR').abspath, env.Dir('$TOP_SRCDIR').abspath)]
1960 ignore_types = ['.svn', '.deps', '.cache', '.tmp', '.bak', '.gmo', '.pot',
1961 '.pyc', '.pyo', '.o', '_moc.cpp', 'Makefile.in', 'config.h.in',
1962 'LaTeXConfig.lyx', 'version.cpp', 'Package.cpp']
1963 ext_types = ['_header_files', '_files', '_pre_files', '_post_files', '_moc_files', '_inc_files',
1964 '_copied_files', '_copied_header_files', '_extra_header_files', '_extra_src_files', '_extra_files']
1965 for root,path,files in os.walk(env.Dir('$TOP_SRCDIR').abspath):
1966 if os.path.split(root)[-1][0] == '.' \
1967 or True in [x in root for x in ignore_types] \
1968 or True in [utils.isSubDir(root, x) for x in ignore_dirs]:
1970 dirname = utils.relativePath(root, env.subst('$TOP_SRCDIR')).replace(os.sep, '_')
1973 # files in the current manifest.py
1975 for ext in ext_types:
1976 if 'copied' not in ext and dirname + ext in locals():
1977 cur_files.extend(eval(dirname + ext))
1979 # compare files with cur_files
1980 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]]
1982 if cur_files != files:
1985 if f not in cur_files:
1991 if len(missing) > 0:
1992 print 'Missing: %s in %s' % (', '.join(missing), root)
1993 if dirname + '_extra_files' in locals():
1994 exec('%s_extra_files.extend(missing)' % dirname)
1996 exec('%s_extra_files = missing' % dirname)
1998 print 'Extra: %s in %s' % (', '.join(extra), root)
1999 # write to a new manifest file
2000 for ext in ext_types:
2001 if dirname + ext in locals():
2002 exec('%s%s.sort()' % (dirname, ext))
2003 print >> manifest, "%s%s = Split('''\n " % (dirname, ext),
2004 print >> manifest, eval(r"'\n '.join(%s%s)" % (dirname, ext))
2005 print >> manifest, "''')\n\n"
2007 Alias('update_manifest', None)
2014 print 'Updating po/*.po files...'
2016 # whether or not update po files
2017 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
2018 print 'xgettext or msgmerge does not exist. Cannot merge po files'
2020 # rebuild POTFILES.in
2021 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
2022 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
2023 src_extra_src_files] + \
2024 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
2025 src_support_extra_header_files + src_support_extra_src_files] + \
2026 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
2027 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
2028 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
2029 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
2030 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
2031 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
2032 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
2033 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
2035 Alias('update_po', POTFILES_in)
2036 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
2037 # and combine them to lyx.po
2038 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
2039 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
2040 env.Command('$BUILDDIR/po/all.po',
2041 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
2042 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
2043 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
2044 env.Command('$BUILDDIR/po/layouts_l10n.pot',
2045 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
2046 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2047 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
2048 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2049 env.Command('$BUILDDIR/po/ui_l10n.pot',
2050 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2051 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2052 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
2053 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
2055 ['$MSGUNIQ -o $TARGET $SOURCE',
2056 '''$XGETTEXT --default-domain=${TARGET.base} \
2057 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2058 --language=C++ --join-existing \
2059 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
2060 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2061 --copyright-holder="LyX Developers" \
2062 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2064 env.Depends(lyx_po, POTFILES_in)
2065 # copy lyx.po to lyx.pot
2066 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2067 Copy('$TARGET', '$SOURCE'))
2070 # files to translate
2071 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2072 # possibly *only* handle these languages
2074 if env.has_key('languages'):
2075 languages = env.make_list(env['languages'])
2076 # merge. if I use lan.po as $TARGET, it will be removed
2077 # before it is merged. In this builder,
2078 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2079 # and is copied to po/lang.po
2080 env['BUILDERS']['msgmerge'] = Builder(action=[
2081 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2082 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2084 # for each po file, generate pot
2085 for po_file in transfiles:
2087 fname = os.path.split(po_file)[1]
2089 country = fname.split('.')[0]
2091 if not languages or country in languages:
2092 # merge po files, the generated lan.po_new file is copied to lan.po file.
2093 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2094 env.Depends(po, POTFILES_in)
2095 Alias('update_po', po)
2102 print 'Processing files in po...'
2107 # files to translate
2108 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2109 # possibly *only* handle these languages
2111 if env.has_key('languages'):
2112 languages = env.make_list(env['lanauges'])
2113 # use defulat msgfmt
2115 if not env['MSGFMT']:
2116 print 'msgfmt does not exist. Can not process po files'
2119 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2121 for f in transfiles:
2123 fname = os.path.split(f)[1]
2125 country = fname.split('.')[0]
2127 if not languages or country in languages:
2128 gmo_files.extend(env.Transfiles(f))
2133 # this part is a bit messy right now. Since scons will provide
2134 # --DESTDIR option soon, at least the dest_dir handling can be
2137 # how to join dest_dir and prefix
2138 def joinPaths(path1, path2):
2139 ''' join path1 and path2, do not use os.path.join because
2140 under window, c:\destdir\d:\program is invalid '''
2142 return os.path.normpath(path2)
2143 # separate drive letter
2144 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2145 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2146 return os.path.join(os.path.normpath(path1), path[1:])
2148 # install to dest_dir/prefix
2149 dest_dir = env.get('DESTDIR', '')
2150 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2151 # create the directory if needed
2152 if not os.path.isdir(dest_prefix_dir):
2154 os.makedirs(dest_prefix_dir)
2157 if not os.path.isdir(dest_prefix_dir):
2158 print 'Can not create directory', dest_prefix_dir
2161 if env.has_key('exec_prefix'):
2162 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2164 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2166 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2168 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2169 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2170 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2171 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2175 # install executables (lyxclient may be None)
2178 version_suffix = program_suffix
2182 # install lyx, if in release mode, try to strip the binary
2183 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2184 # create a builder to strip and install
2185 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2187 # install executables
2188 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2191 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2192 target = os.path.join(bin_dest_dir, target_name)
2193 if env['BUILDERS'].has_key('StripInstallAs'):
2194 env.StripInstallAs(target, obj)
2196 env.InstallAs(target, obj)
2197 Alias('install', target)
2201 for (dir,files) in [
2203 ('bind', lib_bind_files),
2204 ('bind/de', lib_bind_de_files),
2205 ('bind/fi', lib_bind_fi_files),
2206 ('bind/pt', lib_bind_pt_files),
2207 ('bind/sv', lib_bind_sv_files),
2208 ('doc', lib_doc_files),
2209 ('doc/biblio', lib_doc_biblio_files),
2210 ('doc/clipart', lib_doc_clipart_files),
2211 ('doc/cs', lib_doc_cs_files),
2212 ('doc/da', lib_doc_da_files),
2213 ('doc/de', lib_doc_de_files),
2214 ('doc/de/clipart', lib_doc_de_clipart_files),
2215 ('doc/es', lib_doc_es_files),
2216 ('doc/es/clipart', lib_doc_es_clipart_files),
2217 ('doc/eu', lib_doc_eu_files),
2218 ('doc/fr', lib_doc_fr_files),
2219 ('doc/he', lib_doc_he_files),
2220 ('doc/hu', lib_doc_hu_files),
2221 ('doc/it', lib_doc_it_files),
2222 ('doc/nl', lib_doc_nl_files),
2223 ('doc/nb', lib_doc_nb_files),
2224 ('doc/pl', lib_doc_pl_files),
2225 ('doc/pt', lib_doc_pt_files),
2226 ('doc/ro', lib_doc_ro_files),
2227 ('doc/ru', lib_doc_ru_files),
2228 ('doc/sk', lib_doc_sk_files),
2229 ('doc/sl', lib_doc_sl_files),
2230 ('doc/sv', lib_doc_sv_files),
2231 ('examples', lib_examples_files),
2232 ('examples/ca', lib_examples_ca_files),
2233 ('examples/cs', lib_examples_cs_files),
2234 ('examples/da', lib_examples_da_files),
2235 ('examples/de', lib_examples_de_files),
2236 ('examples/es', lib_examples_es_files),
2237 ('examples/eu', lib_examples_eu_files),
2238 ('examples/fa', lib_examples_fa_files),
2239 ('examples/fr', lib_examples_fr_files),
2240 ('examples/he', lib_examples_he_files),
2241 ('examples/hu', lib_examples_hu_files),
2242 ('examples/it', lib_examples_it_files),
2243 ('examples/nl', lib_examples_nl_files),
2244 ('examples/pl', lib_examples_pl_files),
2245 ('examples/pt', lib_examples_pt_files),
2246 ('examples/ru', lib_examples_ru_files),
2247 ('examples/sl', lib_examples_sl_files),
2248 ('examples/ro', lib_examples_ro_files),
2249 ('fonts', lib_fonts_files),
2250 ('images', lib_images_files),
2251 ('images/math', lib_images_math_files),
2252 ('kbd', lib_kbd_files),
2253 ('layouts', lib_layouts_files + lib_layouts_inc_files),
2254 ('lyx2lyx', lib_lyx2lyx_files),
2255 ('scripts', lib_scripts_files),
2256 ('templates', lib_templates_files),
2257 ('tex', lib_tex_files),
2258 ('ui', lib_ui_files)]:
2259 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2260 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2261 Alias('install', dirs)
2263 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2264 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2265 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2266 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2267 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2268 sys.path.append(share_dest_dir + '/lyx2lyx')
2270 # generate TOC files for each doc
2271 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2273 for lang in languages.keys():
2274 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2275 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2278 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2279 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2281 # this is for English
2282 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2285 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2286 Alias('install', tocs)
2288 if platform_name == 'cygwin':
2289 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2290 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2291 '%s-%s.README' % (package, package_cygwin_version))
2292 env.InstallAs(Cygwin_README,
2293 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2294 Alias('install', Cygwin_README)
2295 # also a directory /usr/share/doc/lyx for README etc
2296 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2297 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2298 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2299 Alias('install', Cygwin_Doc)
2300 # cygwin fonts also need to be installed
2301 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2302 env.Install(Cygwin_fonts,
2303 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2304 for file in win32_bakoma_fonts])
2305 Alias('install', Cygwin_fonts)
2306 # we also need a post installation script
2307 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2308 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2309 env.Install(postinstall_path, tmp_script)
2310 Alias('install', postinstall_path)
2314 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2315 env.subst('$TOP_SRCDIR/lyx.man'))
2316 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2317 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2318 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2319 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2320 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2321 x in ['lyx', 'tex2lyx', 'lyxclient']])
2323 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2324 for gmo in gmo_files:
2325 lan = os.path.split(str(gmo))[1].split('.')[0]
2326 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2327 env.InstallAs(dest_file, gmo)
2328 Alias('install', dest_file)
2333 # build windows installer using NSIS
2336 # There is a nsis builder on scons wiki but it does not work with
2337 # our lyx.nsi because it does not dig through all the include directives
2338 # and find the dependencies automatically. Also, it can not parse
2339 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2340 # something rely on date.
2341 # Because of this, I am doing a simple nsis builder here.
2342 if platform_name != 'win32':
2343 print 'installer target is only available for windows platform'
2345 if mode != 'release':
2346 print 'installer has to be built in release mode (use option mode=release)'
2348 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2349 % x for x in development_Win32_packaging_installer] + \
2350 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2351 % x for x in development_Win32_packaging_installer_components] + \
2352 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2353 % x for x in development_Win32_packaging_installer_dialogs] + \
2354 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2355 % x for x in development_Win32_packaging_installer_graphics] + \
2356 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2357 % x for x in development_Win32_packaging_installer_include] + \
2358 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2359 % x for x in development_Win32_packaging_installer_lang]
2360 if env.has_key('NSIS') and env['NSIS'] is not None:
2361 # create a builder to strip and install
2362 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2364 print 'No nsis compiler is found. Existing...'
2366 if not env.has_key('win_installer') or env['win_installer'] is None:
2368 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2370 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2371 # provide default setting
2372 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2373 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2374 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2375 print 'Development dependency package is not found.'
2378 env['deps_dir'] = env.Dir('$deps_dir').abspath
2380 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2381 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2382 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2383 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2385 env['bundle_dir'] = None
2386 # if absolute path is given, use it, otherwise, write to current directory
2387 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2388 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2389 env.Append(NSISDEFINES={
2390 'ExeFile':env['win_installer'],
2391 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2392 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2393 'FilesDeps':env['deps_dir'],
2394 'FilesBundle':env['bundle_dir'],
2396 installer = env.installer(env['win_installer'],
2397 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2398 # since I can not use a scanner, explicit dependent is required
2399 env.Depends(installer, 'install')
2400 env.Depends(installer, installer_files)
2401 env.Alias('installer', installer)
2402 # also generate bundle?
2403 if env.has_key('bundle') and env['bundle']:
2404 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2405 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2406 print 'Use bundle_dir option to specify'
2408 # generator of the builder will add bundle stuff depending on output name
2409 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2410 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2411 env.Depends(bundle_installer, 'install')
2412 env.Depends(bundle_installer, installer_files)
2413 env.Alias('installer', bundle_installer)
2416 Alias('all', ['lyx', 'client', 'tex2lyx'])