1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 # This is a scons based building system for lyx, please refer
12 # to INSTALL.scons for detailed instructions.
15 import os, sys, copy, cPickle, glob, time
17 # scons_utils.py defines a few utility function
18 import scons_utils as utils
19 # import all file lists
20 from scons_manifest import *
22 #----------------------------------------------------------
23 # Required runtime environment
24 #----------------------------------------------------------
26 # scons asks for 1.5.2, lyx requires 2.3
27 EnsurePythonVersion(2, 3)
28 # Please use at least 0.96.92 (not 0.96.1)
29 EnsureSConsVersion(0, 96)
30 # also check for minor version number for scons 0.96
31 from SCons import __version__
32 version = map(int, __version__.split('.'))
33 if version[0] == 0 and version[1] == 96 and version[2] < 92:
34 print "Scons >= 0.96.92 is required."
37 # determine where I am ...
39 from SCons.Node.FS import default_fs
40 # default_fs.SConstruct_dir is where SConstruct file is located.
41 scons_dir = default_fs.SConstruct_dir.path
42 # get the ../.. of scons_dir
43 top_src_dir = os.path.split(os.path.split(default_fs.SConstruct_dir.abspath)[0])[0]
44 sys.path.append(os.path.join(top_src_dir, 'lib', 'doc'))
47 #----------------------------------------------------------
49 #----------------------------------------------------------
51 # some global settings
53 # get version number from configure.ac so that JMarc does
54 # not have to change SConstruct during lyx release
55 package_version = utils.getVerFromConfigure(top_src_dir)
56 package_cygwin_version = '%s-1' % package_version
57 boost_version = ['1_34']
59 if 'svn' in package_version:
61 default_build_mode = 'debug'
64 default_build_mode = 'release'
67 package_bugreport = 'lyx-devel@lists.lyx.org'
69 package_tarname = 'lyx'
70 package_string = '%s %s' % (package_name, package_version)
72 # various cache/log files
73 default_log_file = 'scons_lyx.log'
74 opt_cache_file = 'opt.cache'
77 #----------------------------------------------------------
78 # platform dependent settings
79 #----------------------------------------------------------
82 platform_name = 'win32'
83 default_prefix = 'c:/program files/lyx'
84 default_with_x = False
85 default_packaging_method = 'windows'
86 elif os.name == 'posix' and sys.platform != 'cygwin':
87 platform_name = sys.platform
88 default_prefix = '/usr/local'
90 default_packaging_method = 'posix'
91 elif os.name == 'posix' and sys.platform == 'cygwin':
92 platform_name = 'cygwin'
93 default_prefix = '/usr'
95 default_packaging_method = 'posix'
96 elif os.name == 'darwin':
97 platform_name = 'macosx'
98 # FIXME: macOSX default prefix?
100 default_with_x = False
101 default_packaging_method = 'macosx'
102 else: # unsupported system, assume posix behavior
103 platform_name = 'others'
105 default_with_x = True
106 default_packaging_method = 'posix'
108 #---------------------------------------------------------
110 #----------------------------------------------------------
112 # You can set perminant default values in config.py
113 if os.path.isfile('config.py'):
114 print "Getting options from config.py..."
115 print open('config.py').read()
117 opts = Options(['config.py'])
120 EnumOption('frontend', 'Main GUI', 'qt4',
121 allowed_values = ('qt4',) ),
122 # debug or release build
123 EnumOption('mode', 'Building method', default_build_mode,
124 allowed_values = ('debug', 'release') ),
127 'Use included, system boost library, or try sytem boost first.',
128 'auto', allowed_values = (
129 'auto', # detect boost, if not found, use included
130 'included', # always use included boost
131 'system', # always use system boost, fail if can not find
134 EnumOption('gettext',
135 'Use included, system gettext library, or try sytem gettext first',
136 'auto', allowed_values = (
137 'auto', # detect gettext, if not found, use included
138 'included', # always use included gettext
139 'system', # always use system gettext, fail if can not find
142 EnumOption('spell', 'Choose spell checker to use.', 'auto',
143 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
145 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
146 allowed_values = ('windows', 'posix', 'macosx')),
148 BoolOption('fast_start', 'This option is obsolete.', False),
149 # No precompiled header support (too troublesome to make it work for msvc)
150 # BoolOption('pch', 'Whether or not use pch', False),
151 # enable assertion, (config.h has ENABLE_ASSERTIOS
152 BoolOption('assertions', 'Use assertions', True),
153 # enable warning, (config.h has WITH_WARNINGS)
154 # default to False since MSVC does not have #warning
155 BoolOption('warnings', 'Use warnings', False),
156 # config.h define _GLIBCXX_CONCEPT_CHECKS
157 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
158 BoolOption('concept_checks', 'Enable concept checks', True),
160 BoolOption('nls', 'Whether or not use native language support', True),
162 BoolOption('profiling', 'Whether or not enable profiling', False),
163 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
164 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
166 BoolOption('X11', 'Use x11 windows system', default_with_x),
167 # use MS VC++ to build lyx
168 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
170 PathOption('qt_dir', 'Path to qt directory', None),
172 PathOption('qt_inc_path', 'Path to qt include directory', None),
174 PathOption('qt_lib_path', 'Path to qt library directory', None),
175 # extra include and libpath
176 PathOption('extra_inc_path', 'Extra include path', None),
178 PathOption('extra_lib_path', 'Extra library path', None),
180 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
182 PathOption('extra_inc_path1', 'Extra include path', None),
184 PathOption('extra_lib_path1', 'Extra library path', None),
185 # rebuild only specifed, comma separated targets
186 ('rebuild', '''rebuild only specifed, comma separated targets.
187 yes or all (default): rebuild everything
188 no or none: rebuild nothing (usually used for installation)
189 comp1,comp2,...: rebuild specified targets''', None),
190 # can be set to a non-existing directory
191 ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
192 # replace the default name and location of the windows installer
193 ('win_installer', 'name or full path to the windows installer', None),
194 # the deps package used to create minimal installer (qt and other libraries)
195 ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
196 # whether or not build bundle installer
197 BoolOption('bundle', 'Whether or not build bundle installer', False),
198 # the bundle directory, containing bundled applications
199 PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
200 # build directory, will use $mode if not set
201 ('build_dir', 'Build directory', None),
203 ('version_suffix', 'install lyx as lyx-suffix', None),
204 # how to load options
205 ('load_option', '''load option from previous scons run. option can be
206 yes (default): load all options
207 no: do not load any option
208 opt1,opt2: load specified options
209 -opt1,opt2: load all options other than specified ones''', 'yes'),
211 ('optimization', 'optimization CCFLAGS option.', None),
213 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
215 ('logfile', 'save commands (not outputs) to logfile', default_log_file),
216 # provided for backward compatibility
217 ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
218 # environment variable can be set as options.
219 ('DESTDIR', 'install to DESTDIR', None),
220 ('CC', 'replace default $CC', None),
221 ('LINK', 'replace default $LINK', None),
222 ('CPP', 'replace default $CPP', None),
223 ('CXX', 'replace default $CXX', None),
224 ('CXXCPP', 'replace default $CXXCPP', None),
225 ('CCFLAGS', 'replace default $CCFLAGS', None),
226 ('CPPFLAGS', 'replace default $CPPFLAGS', None),
227 ('LINKFLAGS', 'replace default $LINKFLAGS', None),
231 all_options = [x.key for x in opts.options]
233 # copied from SCons/Options/BoolOption.py
234 # We need to use them before a boolean ARGUMENTS option is available
236 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
237 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
239 if ARGUMENTS.has_key('fast_start'):
240 print 'fast_start option is obsolete'
242 # if load_option=yes (default), load saved comand line options
244 # This option can take value yes/no/opt1,opt2/-opt1,opt2
245 # and tries to be clever in choosing options to load
246 if (not ARGUMENTS.has_key('load_option') or \
247 ARGUMENTS['load_option'] not in false_strings) \
248 and os.path.isfile(opt_cache_file):
249 cache_file = open(opt_cache_file)
250 opt_cache = cPickle.load(cache_file)
252 # import cached options, but we should ignore qt_dir when frontend changes
253 if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
254 and ARGUMENTS['frontend'] != opt_cache['frontend'] \
255 and opt_cache.has_key('qt_dir'):
256 opt_cache.pop('qt_dir')
257 # and we do not cache some options (dest_dir is obsolete)
258 for arg in ['load_option', 'dest_dir', 'bundle']:
259 if opt_cache.has_key(arg):
261 # remove obsolete cached keys (well, SConstruct is evolving. :-)
262 for arg in opt_cache.keys():
263 if arg not in all_options:
264 print 'Option %s is obsolete, do not load it' % arg
266 # now, if load_option=opt1,opt2 or -opt1,opt2
267 if ARGUMENTS.has_key('load_option') and \
268 ARGUMENTS['load_option'] not in true_strings + false_strings:
269 # if -opt1,opt2 is specified, do not load these options
270 if ARGUMENTS['load_option'][0] == '-':
271 for arg in ARGUMENTS['load_option'][1:].split(','):
272 if opt_cache.has_key(arg):
274 # if opt1,opt2 is specified, only load specified options
276 args = ARGUMENTS['load_option'].split(',')
277 for arg in opt_cache.keys():
280 # now restore options as if entered from command line
281 for key in opt_cache.keys():
282 if not ARGUMENTS.has_key(key):
283 ARGUMENTS[key] = opt_cache[key]
284 print "Restoring cached option %s=%s" % (key, ARGUMENTS[key])
287 # check if there is unused (or misspelled) argument
288 for arg in ARGUMENTS.keys():
289 if arg not in all_options:
291 print "Unknown option '%s'... exiting." % arg
293 print "Available options are (check 'scons -help' for details):"
294 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
298 cache_file = open(opt_cache_file, 'w')
299 cPickle.dump(ARGUMENTS, cache_file)
302 #---------------------------------------------------------
303 # Setting up environment
304 #---------------------------------------------------------
306 # I do not really like ENV=os.environ, but you may add it
307 # here if you experience some environment related problem
308 env = Environment(options = opts)
310 # set individual variables since I do not really like ENV = os.environ
311 env['ENV']['PATH'] = os.environ.get('PATH')
312 env['ENV']['HOME'] = os.environ.get('HOME')
313 # these are defined for MSVC
314 env['ENV']['LIB'] = os.environ.get('LIB')
315 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
317 # for simplicity, use var instead of env[var]
318 frontend = env['frontend']
319 prefix = env['prefix']
322 if platform_name == 'win32':
323 if env.has_key('use_vc'):
324 use_vc = env['use_vc']
325 if WhereIs('cl.exe') is None:
326 print "cl.exe is not found. Are you using the MSVC environment?"
328 elif WhereIs('cl.exe') is not None:
335 # lyx will be built to $build/build_dir so it is possible
336 # to build multiple build_dirs using the same source
337 # $mode can be debug or release
338 if env.has_key('build_dir') and env['build_dir'] is not None:
339 # create the directory if needed
340 if not os.path.isdir(env['build_dir']):
342 os.makedirs(env['build_dir'])
345 if not os.path.isdir(env['build_dir']):
346 print 'Can not create directory', env['build_dir']
348 env['BUILDDIR'] = env['build_dir']
350 # Determine the name of the build $mode
351 env['BUILDDIR'] = '#' + mode
353 # all built libraries will go to build_dir/libs
354 # (This is different from the make file approach)
355 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
356 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
359 # Here is a summary of variables defined in env
361 # 2. undefined options with a non-None default value
362 # 3. compiler commands and flags like CCFLAGS.
363 # MSGFMT used to process po files
364 # 4. Variables that will be used to replace variables in some_file.in
365 # src/support/Package.cpp.in:
366 # TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
367 # lib/lyx2lyx/lyx2lyx_version.py.in
370 # PACKAGE_VERSION, LYX_DATE, VERSION_INFO
372 # full path name is used to build msvs project files
373 # and to replace TOP_SRCDIR in package.C
374 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
375 # needed by src/version.cpp.in => src/version.cpp
376 env['PACKAGE_VERSION'] = package_version
377 env['LYX_DATE'] = time.asctime()
379 # determine share_dir etc
380 packaging_method = env.get('packaging')
381 if packaging_method == 'windows':
382 share_dir = 'Resources'
383 man_dir = 'Resources/man/man1'
384 locale_dir = 'Resources/locale'
386 share_dir = 'share/lyx'
387 locale_dir = 'share/locale'
388 if platform_name == 'cygwin':
389 man_dir = 'share/man/man1'
393 # program suffix: can be yes, or a string
394 if env.has_key('version_suffix'):
395 if env['version_suffix'] in true_strings:
396 program_suffix = package_version
397 elif env['version_suffix'] in false_strings:
400 program_suffix = env['version_suffix']
403 # used by Package.cpp.in
404 env['PROGRAM_SUFFIX'] = program_suffix
406 # whether or not add suffix to file and directory names
407 add_suffix = packaging_method != 'windows'
408 # LYX_DIR are different (used in Package.cpp.in)
410 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
412 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
413 # we need absolute path for package.C
414 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
417 #---------------------------------------------------------
418 # Setting building environment (Tools, compiler flags etc)
419 #---------------------------------------------------------
421 # Since Tool('mingw') will reset CCFLAGS etc, this should be
422 # done before getEnvVariable
423 if platform_name == 'win32':
429 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
430 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
432 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
435 # we differentiate between hard-coded options and default options
436 # hard-coded options are required and will always be there
437 # default options can be replaced by enviromental variables or command line options
438 CCFLAGS_required = []
439 LINKFLAGS_required = []
442 # under windows, scons is confused by .C/.c and uses gcc instead of
443 # g++. I am forcing the use of g++ here. This is expected to change
444 # after lyx renames all .C files to .cpp
446 # save the old c compiler and CCFLAGS (used by libintl)
447 C_COMPILER = env.subst('$CC')
448 C_CCFLAGS = env.subst('$CCFLAGS').split()
449 # if we use ms vc, the commands are fine (cl.exe and link.exe)
451 # /TP treat all source code as C++
452 # C4819: The file contains a character that cannot be represented
453 # in the current code page (number)
454 # C4996: foo was decleared deprecated
455 CCFLAGS_required.extend(['/TP', '/EHsc'])
457 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
458 # the flags are also needed in C mode (for intl lib)
459 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
461 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
462 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
464 if env.has_key('CXX') and env['CXX']:
465 env['CC'] = env.subst('$CXX')
466 env['LINK'] = env.subst('$CXX')
471 # for debug/release mode
472 if env.has_key('optimization') and env['optimization'] is not None:
473 # if user supplies optimization flags, use it anyway
474 CCFLAGS_required.extend(env['optimization'].split())
475 # and do not use default
476 set_default_optimization_flags = False
478 set_default_optimization_flags = True
482 CCFLAGS_required.append('/Zi')
483 LINKFLAGS_required.extend(['/debug', '/map'])
485 CCFLAGS_required.append('-g')
486 CCFLAGS_default.append('-O')
487 elif mode == 'release' and set_default_optimization_flags:
489 CCFLAGS_default.append('/O2')
491 CCFLAGS_default.append('-O2')
493 # msvc uses separate tools for profiling
494 if env.has_key('profiling') and env['profiling']:
496 print 'Visual C++ does not use profiling options'
498 CCFLAGS_required.append('-pg')
499 LINKFLAGS_required.append('-pg')
501 if env.has_key('warnings') and env['warnings']:
503 CCFLAGS_default.append('/W2')
505 # Note: autotools detect gxx version and pass -W for 3.x
506 # and -Wextra for other versions of gcc
507 CCFLAGS_default.append('-Wall')
509 # Now, set the variables as follows:
510 # 1. if command line option exists: replace default
511 # 2. then if s envronment variable exists: replace default
512 # 3. set variable to required + default
513 def setEnvVariable(env, name, required = None, default = None, split = True):
514 ''' env: environment to set variable
516 required: hardcoded options
517 default: default options that can be replaced by command line or
518 environment variables
519 split: whether or not split obtained variable like '-02 -g'
521 # 1. ARGUMENTS is already set to env[name], override default.
522 if ARGUMENTS.has_key(name):
523 # env[name] may be rewritten when building tools are reloaded
524 # if that is the case, commandline option will override it.
525 env[name] = ARGUMENTS[name]
527 # then use environment default
528 elif os.environ.has_key(name):
529 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
530 default = os.environ[name]
532 default = default.split()
533 # the real value should be env[name] + default + required
536 if env.has_key(name):
537 value = str(env[name]).split()
538 if required is not None:
540 if default is not None:
544 if env.has_key(name):
545 value = str(env[name])
546 if required is not None:
547 value += " " + required
548 if default is not None:
549 value += " " + default
551 # print name, env[name]
553 setEnvVariable(env, 'DESTDIR', split=False)
554 setEnvVariable(env, 'CC')
555 setEnvVariable(env, 'LINK')
556 setEnvVariable(env, 'CPP')
557 setEnvVariable(env, 'CXX')
558 setEnvVariable(env, 'CXXCPP')
559 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
560 setEnvVariable(env, 'CXXFLAGS')
561 setEnvVariable(env, 'CPPFLAGS')
562 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
564 # if DESTDIR is not set...
565 if env.has_key('dest_dir'):
566 print "This option is obsolete. Please use DESTDIR instead."
567 env['DESTDIR'] = env['dest_dir']
570 # extra_inc_path and extra_lib_path
573 if env.has_key('extra_inc_path') and env['extra_inc_path']:
574 extra_inc_paths.append(env['extra_inc_path'])
575 if env.has_key('extra_lib_path') and env['extra_lib_path']:
576 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
577 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
578 extra_inc_paths.append(env['extra_inc_path1'])
579 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
580 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
581 if env.has_key('extra_bin_path') and env['extra_bin_path']:
582 # only the first one is needed (a scons bug?)
583 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
584 env.PrependENVPath('PATH', env['extra_bin_path'])
585 # extra_inc_paths will be used later by intlenv etc
586 env.AppendUnique(CPPPATH = extra_inc_paths)
589 #----------------------------------------------------------
591 #----------------------------------------------------------
593 conf = Configure(env,
595 'CheckPkgConfig' : utils.checkPkgConfig,
596 'CheckPackage' : utils.checkPackage,
597 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
598 'CheckSelectArgType' : utils.checkSelectArgType,
599 'CheckBoostLibraries' : utils.checkBoostLibraries,
600 'CheckCommand' : utils.checkCommand,
601 'CheckNSIS' : utils.checkNSIS,
602 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
603 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
604 'CheckIconvConst' : utils.checkIconvConst,
605 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
606 'CheckDeclaration' : utils.checkDeclaration,
610 # pkg-config? (if not, we use hard-coded options)
611 if conf.CheckPkgConfig('0.15.0'):
612 env['HAS_PKG_CONFIG'] = True
614 print 'pkg-config >= 0.1.50 is not found'
615 env['HAS_PKG_CONFIG'] = False
617 # zlib? This is required.
618 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
619 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
620 print 'Did not find zdll.lib or zlib.h, exiting!'
622 if conf.CheckLib('iconv'):
623 env['ICONV_LIB'] = 'iconv'
624 elif conf.CheckLib('libiconv'):
625 env['ICONV_LIB'] = 'libiconv'
626 elif conf.CheckFunc('iconv_open'):
627 env['ICONV_LIB'] = None
629 print 'Did not find iconv or libiconv, exiting!'
634 if conf.CheckLib('socket'):
635 socket_libs.append('socket')
636 # nsl is the network services library and provides a
637 # transport-level interface to networking services.
638 if conf.CheckLib('nsl'):
639 socket_libs.append('nsl')
641 # check available boost libs (since lyx1.4 does not use iostream)
643 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
644 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
645 boost_libs.append(lib)
647 # check boost libraries
648 boost_opt = ARGUMENTS.get('boost', 'auto')
649 # check for system boost
650 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
651 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
652 # default to $BUILDDIR/libs (use None since this path will be added anyway)
654 # here I assume that all libraries are in the same directory
655 if boost_opt == 'included':
656 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
657 included_boost = True
658 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
659 elif boost_opt == 'auto':
660 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
661 # if not found, use local boost
663 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
664 included_boost = True
665 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
667 included_boost = False
668 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
669 elif boost_opt == 'system':
670 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
672 print "Can not find system boost libraries with version %s " % boost_version
673 print "Please supply a path through extra_lib_path and try again."
674 print "Or use boost=included to use included boost libraries."
677 included_boost = False
678 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
681 if boost_libpath is not None:
682 env.AppendUnique(LIBPATH = [boost_libpath])
685 env['ENABLE_NLS'] = env['nls']
687 if not env['ENABLE_NLS']:
689 included_gettext = False
691 # check gettext libraries
692 gettext_opt = ARGUMENTS.get('gettext', 'auto')
693 # check for system gettext
695 if gettext_opt in ['auto', 'system']:
696 if conf.CheckFunc('gettext'):
697 included_gettext = False
700 elif conf.CheckLib('intl'):
701 included_gettext = False
705 if gettext_opt == 'system':
706 print "Can not find system gettext library"
707 print "Please supply a path through extra_lib_path and try again."
708 print "Or use gettext=included to use included gettext libraries."
710 # now, auto and succ = false, or gettext=included
712 # we do not need to set LIBPATH now.
713 included_gettext = True
714 intl_libs = ['included_intl']
718 # check for msgfmt command
719 env['MSGFMT'] = conf.CheckCommand('msgfmt')
720 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
721 env['XGETTEXT'] = conf.CheckCommand('xgettext')
722 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
724 # if under windows, check the nsis compiler
725 if platform_name == 'win32':
726 env['NSIS'] = conf.CheckNSIS()
728 # cygwin packaging requires the binaries to be stripped
729 if platform_name == 'cygwin':
730 env['STRIP'] = conf.CheckCommand('strip')
733 # Customized builders
735 # install customized builders
736 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
737 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
738 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
741 #----------------------------------------------------------
742 # Generating config.h
743 #----------------------------------------------------------
744 aspell_lib = 'aspell'
745 # assume that we use aspell, aspelld compiled for msvc
746 if platform_name == 'win32' and mode == 'debug' and use_vc:
747 aspell_lib = 'aspelld'
749 # check the existence of config.h
750 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
751 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
753 print "Creating %s..." % boost_config_h
755 utils.createConfigFile(conf,
756 config_file = boost_config_h,
757 config_pre = '''/* boost/config.h. Generated by SCons. */
762 * This file is part of LyX, the document processor.
763 * Licence details can be found in the file COPYING.
765 * This is the compilation configuration file for LyX.
766 * It was generated by scon.
767 * You might want to change some of the defaults if something goes wrong
768 * during the compilation.
771 #ifndef _BOOST_CONFIG_H
772 #define _BOOST_CONFIG_H
775 ('ostream', 'HAVE_OSTREAM', 'cxx'),
776 ('locale', 'HAVE_LOCALE', 'cxx'),
777 ('sstream', 'HAVE_SSTREAM', 'cxx'),
778 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
781 (env.has_key('assertions') and env['assertions'],
783 'Define if you want assertions to be enabled in the code'
787 ('wchar_t', 'HAVE_WCHAR_T', None),
791 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
792 # define USE_BOOST_FORMAT 1
794 # define USE_BOOST_FORMAT 0
797 #if !defined(ENABLE_ASSERTIONS)
798 # define BOOST_DISABLE_ASSERTS 1
800 #define BOOST_ENABLE_ASSERT_HANDLER 1
802 #define BOOST_DISABLE_THREADS 1
803 #define BOOST_NO_WSTRING 1
806 # define BOOST_POSIX 1
807 # define BOOST_POSIX_API 1
808 # define BOOST_POSIX_PATH 1
811 #define BOOST_ALL_NO_LIB 1
813 #if defined(HAVE_NEWAPIS_H)
814 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
817 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4
818 # define LIBC_WCTYPE_USES_UCS4
825 print "\nGenerating %s..." % config_h
827 # AIKSAURUS_H_LOCATION
828 if (conf.CheckCXXHeader("Aiksaurus.h")):
829 aik_location = '<Aiksaurus.h>'
830 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
831 aik_location = '<Aiksaurus/Aiksaurus.h>'
835 # determine headers to use
836 spell_opt = ARGUMENTS.get('spell', 'auto')
837 env['USE_ASPELL'] = False
838 env['USE_PSPELL'] = False
839 env['USE_ISPELL'] = False
840 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
841 spell_engine = 'USE_ASPELL'
842 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
843 spell_engine = 'USE_PSPELL'
844 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
845 spell_engine = 'USE_ISPELL'
849 if spell_engine is not None:
850 env[spell_engine] = True
852 if spell_opt == 'auto':
853 print "Warning: Can not locate any spell checker"
854 elif spell_opt != 'no':
855 print "Warning: Can not locate specified spell checker:", spell_opt
858 # check arg types of select function
859 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
861 # check the size of wchar_t
862 sizeof_wchar_t = conf.CheckSizeOfWChar()
864 if sizeof_wchar_t == 0:
865 print 'Error: Can not determine the size of wchar_t.'
870 result = utils.createConfigFile(conf,
871 config_file = config_h,
872 config_pre = '''/* config.h. Generated by SCons. */
877 * This file is part of LyX, the document processor.
878 * Licence details can be found in the file COPYING.
880 * This is the compilation configuration file for LyX.
881 * It was generated by scon.
882 * You might want to change some of the defaults if something goes wrong
883 * during the compilation.
890 ('io.h', 'HAVE_IO_H', 'c'),
891 ('limits.h', 'HAVE_LIMITS_H', 'c'),
892 ('locale.h', 'HAVE_LOCALE_H', 'c'),
893 ('process.h', 'HAVE_PROCESS_H', 'c'),
894 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
895 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
896 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
897 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
898 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
899 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
900 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
901 ('utime.h', 'HAVE_UTIME_H', 'c'),
902 ('direct.h', 'HAVE_DIRECT_H', 'c'),
903 ('istream', 'HAVE_ISTREAM', 'cxx'),
904 ('ios', 'HAVE_IOS', 'cxx'),
907 ('open', 'HAVE_OPEN', None),
908 ('chmod', 'HAVE_CHMOD', None),
909 ('close', 'HAVE_CLOSE', None),
910 ('popen', 'HAVE_POPEN', None),
911 ('pclose', 'HAVE_PCLOSE', None),
912 ('_open', 'HAVE__OPEN', None),
913 ('_close', 'HAVE__CLOSE', None),
914 ('_popen', 'HAVE__POPEN', None),
915 ('_pclose', 'HAVE__PCLOSE', None),
916 ('getpid', 'HAVE_GETPID', None),
917 ('_getpid', 'HAVE__GETPID', None),
918 ('mkdir', 'HAVE_MKDIR', None),
919 ('_mkdir', 'HAVE__MKDIR', None),
920 ('mktemp', 'HAVE_MKTEMP', None),
921 ('mkstemp', 'HAVE_MKSTEMP', None),
922 ('strerror', 'HAVE_STRERROR', None),
923 ('count', 'HAVE_STD_COUNT', '''
928 return std::count(a, a+5, 'l');
931 ('getcwd', 'HAVE_GETCWD', None),
932 ('setenv', 'HAVE_SETENV', None),
933 ('putenv', 'HAVE_PUTENV', None),
934 ('fcntl', 'HAVE_FCNTL', None),
935 ('mkfifo', 'HAVE_MKFIFO', None),
938 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
941 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
942 '#include <streambuf>\n#include <istream>'),
943 ('wchar_t', 'HAVE_WCHAR_T', None),
944 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
947 ('gdi32', 'HAVE_LIBGDI32'),
948 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
951 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
953 'Define is sys/types.h does not have pid_t',
957 (conf.CheckCXXGlobalCstd(),
959 'Define if your C++ compiler puts C library functions in the global namespace'
961 (conf.CheckMkdirOneArg(),
962 'MKDIR_TAKES_ONE_ARG',
963 'Define if mkdir takes only one argument.'
965 (conf.CheckIconvConst(),
967 'Define as const if the declaration of iconv() needs const.',
968 '#define ICONV_CONST const',
969 '#define ICONV_CONST',
971 (conf.CheckLC_MESSAGES(),
973 'Define if your <locale.h> file defines LC_MESSAGES.'
975 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
978 "Define to 1 if translation of program messages to the user's native anguage is requested.",
980 (env['nls'] and not included_gettext,
982 'Define to 1 if using system gettext library'
984 (env.has_key('warnings') and env['warnings'],
986 'Define this if you want to see the warning directives put here and there by the developpers to get attention'
988 (env.has_key('concept_checks') and env['concept_checks'],
989 '_GLIBCXX_CONCEPT_CHECKS',
990 'libstdc++ concept checking'
992 (env.has_key('stdlib_debug') and env['stdlib_debug'],
994 'libstdc++ debug mode'
996 (env.has_key('stdlib_debug') and env['stdlib_debug'],
997 '_GLIBCXX_DEBUG_PEDANTIC',
998 'libstdc++ pedantic debug mode'
1000 (os.name != 'nt', 'BOOST_POSIX',
1001 'Indicates to boost < 1.34 which API to use (posix or windows).'
1003 (os.name != 'nt', 'BOOST_POSIX_API',
1004 'Indicates to boost 1.34 which API to use (posix or windows).'
1006 (os.name != 'nt', 'BOOST_POSIX_PATH',
1007 'Indicates to boost 1.34 which path style to use (posix or windows).'
1009 (spell_engine is not None, spell_engine,
1010 'Spell engine to use'
1012 # we need to know the byte order for unicode conversions
1013 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1014 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1018 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1020 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1021 'Define to the address where bug reports for this package should be sent.'),
1022 ('#define PACKAGE_NAME "%s"' % package_name,
1023 'Define to the full name of this package.'),
1024 ('#define PACKAGE_STRING "%s"' % package_string,
1025 'Define to the full name and version of this package.'),
1026 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1027 'Define to the one symbol short name of this package.'),
1028 ('#define PACKAGE_VERSION "%s"' % package_version,
1029 'Define to the version of this package.'),
1030 ('#define BOOST_ALL_NO_LIB 1',
1031 'disable automatic linking of boost libraries.'),
1032 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1033 'Packaging method'),
1034 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1035 'Aiksaurus include file'),
1036 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1037 "Define to the type of arg 1 for `select'."),
1038 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1039 "Define to the type of arg 2, 3, 4 for `select'."),
1040 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1041 "Define to the type of arg 5 for `select'."),
1042 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1043 'Define to be the size of type wchar_t'),
1045 config_post = '''/************************************************************
1046 ** You should not need to change anything beyond this point */
1048 #ifndef HAVE_STRERROR
1049 #if defined(__cplusplus)
1052 char * strerror(int n);
1056 #ifndef HAVE_DECL_MKSTEMP
1057 #if defined(__cplusplus)
1064 #include <../boost/config.h>
1070 # these keys are needed in env
1071 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1072 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1073 # USE_ASPELL etc does not go through result
1074 if result.has_key(key):
1075 env[key] = result[key]
1078 # if nls=yes and gettext=included, create intl/config.h
1079 # intl/libintl.h etc
1081 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1082 if env['nls'] and included_gettext:
1084 print "Creating %s..." % intl_config_h
1086 # create intl/config.h
1087 result = utils.createConfigFile(conf,
1088 config_file = intl_config_h,
1089 config_pre = '''/* intl/config.h. Generated by SCons. */
1094 * This file is part of LyX, the document processor.
1095 * Licence details can be found in the file COPYING.
1097 * This is the compilation configuration file for LyX.
1098 * It was generated by scon.
1099 * You might want to change some of the defaults if something goes wrong
1100 * during the compilation.
1107 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1108 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1109 ('string.h', 'HAVE_STRING_H', 'c'),
1110 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1111 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1112 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1113 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1114 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1115 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1116 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1119 ('getcwd', 'HAVE_GETCWD', None),
1120 ('stpcpy', 'HAVE_STPCPY', None),
1121 ('strcasecmp', 'HAVE_STRCASECMP', None),
1122 ('strdup', 'HAVE_STRDUP', None),
1123 ('strtoul', 'HAVE_STRTOUL', None),
1124 ('alloca', 'HAVE_ALLOCA', None),
1125 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1126 ('mempcpy', 'HAVE_MEMPCPY', None),
1127 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1128 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1129 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1130 ('setlocale', 'HAVE_SETLOCALE', None),
1131 ('tsearch', 'HAVE_TSEARCH', None),
1132 ('getegid', 'HAVE_GETEGID', None),
1133 ('getgid', 'HAVE_GETGID', None),
1134 ('getuid', 'HAVE_GETUID', None),
1135 ('wcslen', 'HAVE_WCSLEN', None),
1136 ('asprintf', 'HAVE_ASPRINTF', None),
1137 ('wprintf', 'HAVE_WPRINTF', None),
1138 ('snprintf', 'HAVE_SNPRINTF', None),
1139 ('printf', 'HAVE_POSIX_PRINTF', None),
1140 ('fcntl', 'HAVE_FCNTL', None),
1143 ('intmax_t', 'HAVE_INTMAX_T', None),
1144 ('long double', 'HAVE_LONG_DOUBLE', None),
1145 ('long long', 'HAVE_LONG_LONG', None),
1146 ('wchar_t', 'HAVE_WCHAR_T', None),
1147 ('wint_t', 'HAVE_WINT_T', None),
1148 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1149 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1155 (conf.CheckLC_MESSAGES(),
1157 'Define if your <locale.h> file defines LC_MESSAGES.'
1159 (conf.CheckIconvConst(),
1161 'Define as const if the declaration of iconv() needs const.',
1162 '#define ICONV_CONST const',
1163 '#define ICONV_CONST',
1165 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1166 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1168 "Define to 1 if you have the `intmax_t' type."
1170 (env.has_key('nls') and env['nls'],
1172 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1176 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1177 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1178 'Define to be the size of type wchar_t'),
1180 config_post = '#endif'
1183 # these keys are needed in env
1184 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1185 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1186 # USE_ASPELL etc does not go through result
1187 if result.has_key(key):
1188 env[key] = result[key]
1191 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1192 if env['nls'] and included_gettext:
1193 # libgnuintl.h.in => libintl.h
1194 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1195 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1196 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1197 [Copy('$TARGET', '$SOURCE')])
1200 # Finish auto-configuration
1203 #----------------------------------------------------------
1204 # Now set up our build process accordingly
1205 #----------------------------------------------------------
1207 if env['ICONV_LIB'] is None:
1210 system_libs = [env['ICONV_LIB']]
1211 if platform_name in ['win32', 'cygwin']:
1212 # the final link step needs stdc++ to succeed under mingw
1213 # FIXME: shouldn't g++ automatically link to stdc++?
1215 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1217 system_libs += ['shlwapi', 'stdc++', 'z']
1218 elif platform_name == 'cygwin' and env['X11']:
1219 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1220 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1221 'resolv', 'pthread', 'z']
1223 system_libs += ['z']
1226 ('HAVE_LIBGDI32', 'gdi32'),
1227 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1228 ('USE_ASPELL', aspell_lib),
1229 ('USE_ISPELL', 'ispell'),
1230 ('USE_PSPELL', 'pspell'),
1235 system_libs.append(lib[1])
1238 # Build parameters CPPPATH etc
1241 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1244 # boost: for boost header files
1245 # BUILDDIR/common: for config.h
1246 # TOP_SRCDIR/src: for support/* etc
1248 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1250 # Separating boost directories from CPPPATH stops scons from building
1251 # the dependency tree for boost header files, and effectively reduce
1252 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1253 # boost headers, this is only done for system boost headers.
1255 env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1258 env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1260 env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1262 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1263 if env['nls'] and included_gettext:
1264 env['CPPPATH'].append('$BUILDDIR/intl')
1268 # A Link script for cygwin see
1269 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1270 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1273 if platform_name == 'cygwin':
1274 ld_script_path = '/tmp'
1275 ld_script = utils.installCygwinLDScript(ld_script_path)
1276 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1277 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1280 #---------------------------------------------------------
1281 # Frontend related variables (QTDIR etc)
1282 #---------------------------------------------------------
1285 # create a separate environment so that other files do not have
1286 # to be built with all the include directories etc
1288 if frontend == 'qt4':
1289 frontend_env = env.Copy()
1291 # handle qt related user specified paths
1292 # set environment so that moc etc can be found even if its path is not set properly
1293 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1294 frontend_env['QTDIR'] = frontend_env['qt_dir']
1295 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1296 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1297 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1298 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1299 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1301 # if separate qt_lib_path is given
1302 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1303 qt_lib_path = frontend_env.subst('$qt_lib_path')
1304 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1305 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1309 # if separate qt_inc_path is given
1310 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1311 qt_inc_path = frontend_env['qt_inc_path']
1315 # local qt4 toolset from
1316 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1318 # NOTE: I have to patch qt4.py since it does not automatically
1319 # process .C file!!! (add to cxx_suffixes )
1321 frontend_env.Tool('qt4', [scons_dir])
1322 frontend_env['QT_AUTOSCAN'] = 0
1323 frontend_env['QT4_AUTOSCAN'] = 0
1324 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1326 if qt_lib_path is None:
1327 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1328 if qt_inc_path is None:
1329 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1332 conf = Configure(frontend_env,
1334 'CheckPackage' : utils.checkPackage,
1335 'CheckCommand' : utils.checkCommand,
1340 # first: try pkg_config
1341 if frontend_env['HAS_PKG_CONFIG']:
1342 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1343 # FIXME: use pkg_config information?
1344 #frontend_env['QT4_PKG_CONFIG'] = succ
1345 # second: try to link to it
1347 # Under linux, I can test the following perfectly
1348 # Under windows, lib names need to passed as libXXX4.a ...
1349 if platform_name == 'win32':
1350 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1352 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1353 # still can not find it
1355 print 'Did not find qt libraries, exiting!'
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 that QT_LIB_PATH/QT_LIB.manifest file
1387 if qt_lib_path is not None:
1388 manifest = os.path.join(qt_lib_path, 'QtGuid4.dll.manifest')
1390 manifest = 'QtGuid4.dll.manifest'
1392 if qt_lib_path is not None:
1393 manifest = os.path.join(qt_lib_path, 'QtGui4.dll.manifest')
1395 manifest = 'QtGui4.dll.manifest'
1396 if os.path.isfile(manifest):
1397 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % manifest]
1399 frontend_env = conf.Finish()
1404 # fill in the version info
1405 env['VERSION_INFO'] = '''Configuration
1407 Special build flags: %s
1409 C Compiler flags: %s %s
1411 C++ Compiler LyX flags: %s
1412 C++ Compiler flags: %s %s
1414 Linker user flags: %s
1416 Builing directory: %s
1417 Local library directory: %s
1420 Frontend libraries: %s
1421 System libraries: %s
1422 include search path: %s
1428 ''' % (platform_name,
1429 env.subst('$CCFLAGS'), env.subst('$CC'),
1430 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1431 env.subst('$CXX'), env.subst('$CXXFLAGS'),
1432 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1433 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1434 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1435 str(env['LIBPATH']), str(boost_libraries),
1436 str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1437 frontend, packaging_method,
1438 prefix, env['LYX_DIR'])
1440 if frontend in ['qt4']:
1441 env['VERSION_INFO'] += ''' include dir: %s
1444 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1446 print env['VERSION_INFO']
1449 # Mingw command line may be too short for our link usage,
1450 # Here we use a trick from scons wiki
1451 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1453 # I also would like to add logging (commands only) capacity to the
1455 logfile = env.get('logfile', default_log_file)
1456 if logfile != '' or platform_name == 'win32':
1458 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1459 info = '''# This is a log of commands used by scons to build lyx
1463 ''' % (time.asctime(), ' '.join(sys.argv),
1464 env['VERSION_INFO'].replace('\n','\n# ')) )
1469 # -h will print out help info
1470 Help(opts.GenerateHelpText(env))
1474 #----------------------------------------------------------
1476 #----------------------------------------------------------
1477 # this has been the source of problems on some platforms...
1478 # I find that I need to supply it with full path name
1479 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1480 # this usage needs further investigation.
1481 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1483 print "Building all targets recursively"
1485 if env.has_key('rebuild'):
1486 rebuild_targets = env['rebuild'].split(',')
1487 if 'none' in rebuild_targets or 'no' in rebuild_targets:
1488 rebuild_targets = []
1489 elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1490 # None: let scons decide which components to build
1491 # Forcing all components to be rebuilt is in theory not necessary
1492 rebuild_targets = None
1494 rebuild_targets = None
1496 def libExists(libname):
1497 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1498 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1500 def appExists(apppath, appname):
1501 ''' Check whether or not application already exists'''
1502 return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1504 targets = BUILD_TARGETS
1505 build_install = 'install' in targets or 'installer' in targets
1506 build_installer = 'installer' in targets
1507 # msvc need to pass full target name, so I have to look for path/lyx etc
1508 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1509 or build_install or 'all' in targets
1510 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1511 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1512 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1513 build_mathed = build_lyx or 'mathed' in targets
1514 build_insets = build_lyx or 'insets' in targets
1515 build_frontends = build_lyx or 'frontends' in targets
1516 build_graphics = build_lyx or 'graphics' in targets
1517 build_controllers = build_lyx or 'controllers' in targets
1518 build_client = True in ['client' in x for x in targets] \
1519 or build_install or 'all' in targets or build_installer
1520 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1521 or build_install or 'all' in targets or build_installer
1522 build_lyxbase = build_lyx or 'lyxbase' in targets
1523 update_po = 'update_po' in targets
1524 update_manifest = 'update_manifest' in targets
1525 build_po = 'po' in targets or build_install or 'all' in targets
1526 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1527 build_msvs_projects = use_vc and 'msvs_projects' in targets
1530 # now, if rebuild_targets is specified, do not rebuild some targets
1531 if rebuild_targets is not None:
1533 def ifBuildLib(name, libname, old_value):
1534 # explicitly asked to rebuild
1535 if name in rebuild_targets:
1537 # else if not rebuild, and if the library already exists
1538 elif libExists(libname):
1540 # do not change the original value
1543 build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1544 build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1545 build_support = ifBuildLib('support', 'support', build_support)
1546 build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1547 build_insets = ifBuildLib('insets', 'insets', build_insets)
1548 build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1549 build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1550 build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1551 build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1552 build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1554 def ifBuildApp(name, appname, old_value):
1555 # explicitly asked to rebuild
1556 if name in rebuild_targets:
1558 # else if not rebuild, and if the library already exists
1559 elif appExists(name, appname):
1561 # do not change the original value
1564 build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1565 build_client = ifBuildApp('client', 'lyxclient', build_client)
1567 # sync frontend and frontend (?)
1577 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1579 boostenv = env.Copy()
1581 # boost use its own config.h
1582 boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1583 boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1585 for lib in boost_libs:
1586 print 'Processing files in boost/libs/%s/src...' % lib
1587 boostlib = boostenv.StaticLibrary(
1588 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1589 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1591 Alias('boost', boostlib)
1598 intlenv = env.Copy()
1600 print "Processing files in intl..."
1602 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1604 # we need the original C compiler for these files
1605 intlenv['CC'] = C_COMPILER
1606 intlenv['CCFLAGS'] = C_CCFLAGS
1608 intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1609 # intl does not use global config.h
1610 intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1612 intlenv.Append(CCFLAGS = [
1613 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1614 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1615 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1617 '-DENABLE_RELOCATABLE=1',
1619 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1621 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1622 '-Drelocate=libintl_relocate',
1623 '-DDEPENDS_ON_LIBICONV=1',
1628 intl = intlenv.StaticLibrary(
1629 target = '$LOCALLIBPATH/included_intl',
1631 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1637 # Now, src code under src/
1639 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1646 print "Processing files in src/support..."
1648 frontend_env.Depends('$BUILDDIR/common/support/Package.cpp', '$BUILDDIR/common/config.h')
1649 Package_cpp = env.substFile('$BUILDDIR/common/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1651 support = frontend_env.StaticLibrary(
1652 target = '$LOCALLIBPATH/support',
1653 source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files] + Package_cpp,
1655 Alias('support', support)
1662 print "Processing files in src/mathed..."
1664 mathed = env.StaticLibrary(
1665 target = '$LOCALLIBPATH/mathed',
1666 source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1668 Alias('mathed', mathed)
1675 print "Processing files in src/insets..."
1677 insets = env.StaticLibrary(
1678 target = '$LOCALLIBPATH/insets',
1679 source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1681 Alias('insets', insets)
1688 print "Processing files in src/frontends..."
1690 frontends = env.StaticLibrary(
1691 target = '$LOCALLIBPATH/frontends',
1692 source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1694 Alias('frontends', frontends)
1701 print "Processing files in src/graphics..."
1703 graphics = env.StaticLibrary(
1704 target = '$LOCALLIBPATH/graphics',
1705 source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1707 Alias('graphics', graphics)
1710 if build_controllers:
1712 # src/frontends/controllers
1714 print "Processing files in src/frontends/controllers..."
1716 controllers = env.StaticLibrary(
1717 target = '$LOCALLIBPATH/controllers',
1718 source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1720 Alias('controllers', controllers)
1727 env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1729 print "Processing files in src/frontends/qt4..."
1731 qt4_moc_files = ["$BUILDDIR/common/frontends/qt4/%s" % x for x in src_frontends_qt4_moc_files]
1736 resources = [frontend_env.Uic4(x.split('.')[0]) for x in \
1737 ["$BUILDDIR/common/frontends/qt4/ui/%s" % x for x in src_frontends_qt4_ui_files]]
1740 # moc qt4_moc_files, the moced files are included in the original files
1742 qt4_moced_files = [frontend_env.Moc4(x.replace('.cpp', '_moc.cpp'), x.replace('.cpp', '.h')) for x in qt4_moc_files]
1744 qt4 = frontend_env.StaticLibrary(
1745 target = '$LOCALLIBPATH/qt4',
1746 source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1750 '$BUILDDIR/common/images',
1751 '$BUILDDIR/common/frontends',
1752 '$BUILDDIR/common/frontends/qt4',
1753 '$BUILDDIR/common/frontends/controllers'
1758 '-DQT_CLEAN_NAMESPACE',
1771 frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1773 print "Processing files in src/client..."
1775 if env['HAVE_FCNTL']:
1776 client = frontend_env.Program(
1777 target = '$BUILDDIR/common/client/lyxclient',
1778 LIBS = ['support'] + intl_libs + system_libs +
1779 socket_libs + boost_libraries + qtcore_lib,
1780 source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1781 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1783 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1784 client, [Copy('$TARGET', '$SOURCE')]))
1787 Alias('client', client)
1789 if env['HAVE_FCNTL']:
1790 # define client even if lyxclient is not built with rebuild=no
1791 client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1800 print "Processing files in src/tex2lyx..."
1803 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1804 frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1805 [Copy('$TARGET', '$SOURCE')])
1807 tex2lyx = frontend_env.Program(
1808 target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1809 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1810 source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1811 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1812 CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1813 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1815 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1816 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1817 Alias('tex2lyx', tex2lyx)
1819 # define tex2lyx even if tex2lyx is not built with rebuild=no
1820 tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1827 print "Processing files in src..."
1829 env.Depends('$BUILDDIR/common/version.cpp', '$BUILDDIR/common/config.h')
1830 version_cpp = env.substFile('$BUILDDIR/common/version.cpp', '$TOP_SRCDIR/src/version.cpp.in')
1832 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1833 src_post_files.append('ASpell.cpp')
1834 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1835 src_post_files.append('PSpell.cpp')
1836 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1837 src_post_files.append('ISpell.cpp')
1839 # msvc requires at least one source file with main()
1840 # so I exclude main.cpp from lyxbase
1841 lyxbase_pre = env.StaticLibrary(
1842 target = '$LOCALLIBPATH/lyxbase_pre',
1843 source = ['$BUILDDIR/common/%s' % x for x in src_pre_files] + version_cpp
1845 lyxbase_post = env.StaticLibrary(
1846 target = '$LOCALLIBPATH/lyxbase_post',
1847 source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1849 Alias('lyxbase', lyxbase_pre)
1850 Alias('lyxbase', lyxbase_post)
1855 # Build lyx with given frontend
1857 lyx = frontend_env.Program(
1858 target = '$BUILDDIR/lyx',
1859 source = ['$BUILDDIR/common/main.cpp'] + \
1860 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1880 # define lyx even if lyx is not built with rebuild=no
1881 lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1884 if build_msvs_projects:
1885 def build_project(target, full_target = None,
1886 src = [], inc = [], res = [], rebuildTargetOnly = True):
1887 ''' build mavs project files
1888 target: alias (correspond to directory name)
1889 full_target: full path/filename of the target
1893 rebuildTargetOnly: whether or not only rebuild this target
1895 For non-debug-able targets like static libraries, target (alias) is
1896 enough to build the target. For executable targets, msvs need to know
1897 the full path to start debug them.
1899 if rebuildTargetOnly:
1900 cmds = 'rebuild='+target
1903 if full_target is None:
1904 build_target = target
1906 build_target = full_target
1908 proj = env.MSVSProject(
1909 target = target + env['MSVSPROJECTSUFFIX'],
1910 # this allows easy access to header files (along with source)
1911 srcs = [env.subst(x) for x in src + inc],
1912 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1913 localincs = [env.subst(x) for x in inc],
1914 resources = [env.subst(x) for x in res],
1915 buildtarget = build_target,
1919 Alias('msvs_projects', proj)
1921 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1922 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1923 rebuildTargetOnly = False,
1924 full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1926 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1927 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1928 rebuildTargetOnly = False,
1929 full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1931 build_project('lyx',
1932 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1933 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1934 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1935 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1936 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1937 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1938 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1939 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1940 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1941 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1942 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1943 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1944 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1945 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1946 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1947 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1948 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1949 rebuildTargetOnly = False,
1950 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1955 # update scons_manifest.py
1957 # When you run 'scons update_manifest', it tells you which files are missing
1958 # and which files are not in the source tree. It also generates a
1959 # scons_manifest.py.new file with all the missing files added to
1960 # XXX_extra_files. It will *not* change other sections of existing
1963 print 'Validating development/scons/scons_manifest.py...'
1965 manifest = open(env.File('$TOP_SRCDIR/development/scons/scons_manifest.py.new').abspath, 'w')
1966 print >> manifest, 'from SCons.Util import Split\n'
1968 ignore_dirs = ['boost/boost', 'm4', 'development',
1969 utils.relativePath(env.Dir('$BUILDDIR').abspath, env.Dir('$TOP_SRCDIR').abspath)]
1970 ignore_types = ['.svn', '.deps', '.cache', '.tmp', '.bak', '.gmo', '.pot',
1971 '.pyc', '.pyo', '.o', '_moc.cpp', 'Makefile.in', 'config.h.in',
1972 'LaTeXConfig.lyx', 'version.cpp', 'Package.cpp']
1973 ext_types = ['_header_files', '_files', '_pre_files', '_post_files', '_moc_files', '_inc_files',
1974 '_copied_files', '_copied_header_files', '_extra_header_files', '_extra_src_files', '_extra_files']
1975 for root,path,files in os.walk(env.Dir('$TOP_SRCDIR').abspath):
1976 if os.path.split(root)[-1][0] == '.' \
1977 or True in [x in root for x in ignore_types] \
1978 or True in [utils.isSubDir(root, x) for x in ignore_dirs]:
1980 dirname = utils.relativePath(root, env.subst('$TOP_SRCDIR')).replace(os.sep, '_')
1983 # files in the current manifest.py
1985 for ext in ext_types:
1986 if 'copied' not in ext and dirname + ext in locals():
1987 cur_files.extend(eval(dirname + ext))
1989 # compare files with cur_files
1990 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]]
1992 if cur_files != files:
1995 if f not in cur_files:
2001 if len(missing) > 0:
2002 print 'Missing: %s in %s' % (', '.join(missing), root)
2003 if dirname + '_extra_files' in locals():
2004 exec('%s_extra_files.extend(missing)' % dirname)
2006 exec('%s_extra_files = missing' % dirname)
2008 print 'Extra: %s in %s' % (', '.join(extra), root)
2009 # write to a new manifest file
2010 for ext in ext_types:
2011 if dirname + ext in locals():
2012 exec('%s%s.sort()' % (dirname, ext))
2013 print >> manifest, "%s%s = Split('''\n " % (dirname, ext),
2014 print >> manifest, eval(r"'\n '.join(%s%s)" % (dirname, ext))
2015 print >> manifest, "''')\n\n"
2017 Alias('update_manifest', None)
2024 print 'Updating po/*.po files...'
2026 # whether or not update po files
2027 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
2028 print 'xgettext or msgmerge does not exist. Cannot merge po files'
2030 # rebuild POTFILES.in
2031 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
2032 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
2033 src_extra_src_files] + \
2034 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
2035 src_support_extra_header_files + src_support_extra_src_files] + \
2036 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
2037 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
2038 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
2039 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
2040 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
2041 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
2042 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
2043 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
2045 Alias('update_po', POTFILES_in)
2046 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
2047 # and combine them to lyx.po
2048 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
2049 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
2050 env.Command('$BUILDDIR/po/all.po',
2051 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
2052 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
2053 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
2054 env.Command('$BUILDDIR/po/layouts_l10n.pot',
2055 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
2056 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2057 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
2058 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2059 env.Command('$BUILDDIR/po/ui_l10n.pot',
2060 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2061 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2062 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
2063 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
2065 ['$MSGUNIQ -o $TARGET $SOURCE',
2066 '''$XGETTEXT --default-domain=${TARGET.base} \
2067 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2068 --language=C++ --join-existing \
2069 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
2070 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2071 --copyright-holder="LyX Developers" \
2072 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2074 env.Depends(lyx_po, POTFILES_in)
2075 # copy lyx.po to lyx.pot
2076 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2077 Copy('$TARGET', '$SOURCE'))
2080 # files to translate
2081 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2082 # possibly *only* handle these languages
2084 if env.has_key('languages'):
2085 languages = env.make_list(env['languages'])
2086 # merge. if I use lan.po as $TARGET, it will be removed
2087 # before it is merged. In this builder,
2088 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2089 # and is copied to po/lang.po
2090 env['BUILDERS']['msgmerge'] = Builder(action=[
2091 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2092 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2094 # for each po file, generate pot
2095 for po_file in transfiles:
2097 fname = os.path.split(po_file)[1]
2099 country = fname.split('.')[0]
2101 if not languages or country in languages:
2102 # merge po files, the generated lan.po_new file is copied to lan.po file.
2103 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2104 env.Depends(po, POTFILES_in)
2105 Alias('update_po', po)
2112 print 'Processing files in po...'
2117 # files to translate
2118 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2119 # possibly *only* handle these languages
2121 if env.has_key('languages'):
2122 languages = env.make_list(env['lanauges'])
2123 # use defulat msgfmt
2125 if not env['MSGFMT']:
2126 print 'msgfmt does not exist. Can not process po files'
2129 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2131 for f in transfiles:
2133 fname = os.path.split(f)[1]
2135 country = fname.split('.')[0]
2137 if not languages or country in languages:
2138 gmo_files.extend(env.Transfiles(f))
2143 # this part is a bit messy right now. Since scons will provide
2144 # --DESTDIR option soon, at least the dest_dir handling can be
2147 # how to join dest_dir and prefix
2148 def joinPaths(path1, path2):
2149 ''' join path1 and path2, do not use os.path.join because
2150 under window, c:\destdir\d:\program is invalid '''
2152 return os.path.normpath(path2)
2153 # separate drive letter
2154 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2155 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2156 return os.path.join(os.path.normpath(path1), path[1:])
2158 # install to dest_dir/prefix
2159 dest_dir = env.get('DESTDIR', '')
2160 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2161 # create the directory if needed
2162 if not os.path.isdir(dest_prefix_dir):
2164 os.makedirs(dest_prefix_dir)
2167 if not os.path.isdir(dest_prefix_dir):
2168 print 'Can not create directory', dest_prefix_dir
2171 if env.has_key('exec_prefix'):
2172 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2174 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2176 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2178 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2179 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2180 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2181 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2185 # install executables (lyxclient may be None)
2188 version_suffix = program_suffix
2192 # install lyx, if in release mode, try to strip the binary
2193 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2194 # create a builder to strip and install
2195 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2197 # install executables
2198 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2201 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2202 target = os.path.join(bin_dest_dir, target_name)
2203 if env['BUILDERS'].has_key('StripInstallAs'):
2204 env.StripInstallAs(target, obj)
2206 env.InstallAs(target, obj)
2207 Alias('install', target)
2211 for (dir,files) in [
2213 ('bind', lib_bind_files),
2214 ('bind/de', lib_bind_de_files),
2215 ('bind/fi', lib_bind_fi_files),
2216 ('bind/pt', lib_bind_pt_files),
2217 ('bind/sv', lib_bind_sv_files),
2218 ('doc', lib_doc_files),
2219 ('doc/clipart', lib_doc_clipart_files),
2220 ('doc/cs', lib_doc_cs_files),
2221 ('doc/da', lib_doc_da_files),
2222 ('doc/de', lib_doc_de_files),
2223 ('doc/de/clipart', lib_doc_de_clipart_files),
2224 ('doc/es', lib_doc_es_files),
2225 ('doc/es/clipart', lib_doc_es_clipart_files),
2226 ('doc/eu', lib_doc_eu_files),
2227 ('doc/fr', lib_doc_fr_files),
2228 ('doc/he', lib_doc_he_files),
2229 ('doc/hu', lib_doc_hu_files),
2230 ('doc/it', lib_doc_it_files),
2231 ('doc/nl', lib_doc_nl_files),
2232 ('doc/nb', lib_doc_nb_files),
2233 ('doc/pl', lib_doc_pl_files),
2234 ('doc/pt', lib_doc_pt_files),
2235 ('doc/ro', lib_doc_ro_files),
2236 ('doc/ru', lib_doc_ru_files),
2237 ('doc/sk', lib_doc_sk_files),
2238 ('doc/sl', lib_doc_sl_files),
2239 ('doc/sv', lib_doc_sv_files),
2240 ('examples', lib_examples_files),
2241 ('examples/ca', lib_examples_ca_files),
2242 ('examples/cs', lib_examples_cs_files),
2243 ('examples/da', lib_examples_da_files),
2244 ('examples/de', lib_examples_de_files),
2245 ('examples/es', lib_examples_es_files),
2246 ('examples/eu', lib_examples_eu_files),
2247 ('examples/fa', lib_examples_fa_files),
2248 ('examples/fr', lib_examples_fr_files),
2249 ('examples/he', lib_examples_he_files),
2250 ('examples/hu', lib_examples_hu_files),
2251 ('examples/it', lib_examples_it_files),
2252 ('examples/nl', lib_examples_nl_files),
2253 ('examples/pl', lib_examples_pl_files),
2254 ('examples/pt', lib_examples_pt_files),
2255 ('examples/ru', lib_examples_ru_files),
2256 ('examples/sl', lib_examples_sl_files),
2257 ('examples/ro', lib_examples_ro_files),
2258 ('fonts', lib_fonts_files),
2259 ('images', lib_images_files),
2260 ('images/math', lib_images_math_files),
2261 ('kbd', lib_kbd_files),
2262 ('layouts', lib_layouts_files + lib_layouts_inc_files),
2263 ('lyx2lyx', lib_lyx2lyx_files),
2264 ('scripts', lib_scripts_files),
2265 ('templates', lib_templates_files),
2266 ('tex', lib_tex_files),
2267 ('ui', lib_ui_files)]:
2268 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2269 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2270 Alias('install', dirs)
2272 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2273 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2274 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2275 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2276 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2277 sys.path.append(share_dest_dir + '/lyx2lyx')
2279 # generate TOC files for each doc
2280 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2282 for lang in languages.keys():
2283 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2284 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2287 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2288 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2290 # this is for English
2291 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2294 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2295 Alias('install', tocs)
2297 if platform_name == 'cygwin':
2298 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2299 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2300 '%s-%s.README' % (package, package_cygwin_version))
2301 env.InstallAs(Cygwin_README,
2302 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2303 Alias('install', Cygwin_README)
2304 # also a directory /usr/share/doc/lyx for README etc
2305 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2306 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2307 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2308 Alias('install', Cygwin_Doc)
2309 # cygwin fonts also need to be installed
2310 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2311 env.Install(Cygwin_fonts,
2312 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2313 for file in win32_bakoma_fonts])
2314 Alias('install', Cygwin_fonts)
2315 # we also need a post installation script
2316 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2317 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2318 env.Install(postinstall_path, tmp_script)
2319 Alias('install', postinstall_path)
2323 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2324 env.subst('$TOP_SRCDIR/lyx.man'))
2325 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2326 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2327 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2328 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2329 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2330 x in ['lyx', 'tex2lyx', 'lyxclient']])
2332 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2333 for gmo in gmo_files:
2334 lan = os.path.split(str(gmo))[1].split('.')[0]
2335 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2336 env.InstallAs(dest_file, gmo)
2337 Alias('install', dest_file)
2342 # build windows installer using NSIS
2345 # There is a nsis builder on scons wiki but it does not work with
2346 # our lyx.nsi because it does not dig through all the include directives
2347 # and find the dependencies automatically. Also, it can not parse
2348 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2349 # something rely on date.
2350 # Because of this, I am doing a simple nsis builder here.
2351 if platform_name != 'win32':
2352 print 'installer target is only available for windows platform'
2354 if mode != 'release':
2355 print 'installer has to be built in release mode (use option mode=release)'
2357 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2358 % x for x in development_Win32_packaging_installer] + \
2359 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2360 % x for x in development_Win32_packaging_installer_components] + \
2361 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2362 % x for x in development_Win32_packaging_installer_dialogs] + \
2363 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2364 % x for x in development_Win32_packaging_installer_graphics] + \
2365 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2366 % x for x in development_Win32_packaging_installer_include] + \
2367 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2368 % x for x in development_Win32_packaging_installer_lang]
2369 if env.has_key('NSIS') and env['NSIS'] is not None:
2370 # create a builder to strip and install
2371 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2373 print 'No nsis compiler is found. Existing...'
2375 if not env.has_key('win_installer') or env['win_installer'] is None:
2377 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2379 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2380 # provide default setting
2381 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2382 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2383 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2384 print 'Development dependency package is not found.'
2387 env['deps_dir'] = env.Dir('$deps_dir').abspath
2389 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2390 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2391 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2392 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2394 env['bundle_dir'] = None
2395 # if absolute path is given, use it, otherwise, write to current directory
2396 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2397 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2398 env.Append(NSISDEFINES={
2399 'ExeFile':env['win_installer'],
2400 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2401 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2402 'FilesDeps':env['deps_dir'],
2403 'FilesBundle':env['bundle_dir'],
2405 installer = env.installer(env['win_installer'],
2406 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2407 # since I can not use a scanner, explicit dependent is required
2408 env.Depends(installer, 'install')
2409 env.Depends(installer, installer_files)
2410 env.Alias('installer', installer)
2411 # also generate bundle?
2412 if env.has_key('bundle') and env['bundle']:
2413 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2414 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2415 print 'Use bundle_dir option to specify'
2417 # generator of the builder will add bundle stuff depending on output name
2418 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2419 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2420 env.Depends(bundle_installer, 'install')
2421 env.Depends(bundle_installer, installer_files)
2422 env.Alias('installer', bundle_installer)
2425 Alias('all', ['lyx', 'client', 'tex2lyx'])