1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 # This is a scons based building system for lyx, please refer
12 # to INSTALL.scons for detailed instructions.
15 import os, sys, copy, cPickle, glob, time
17 # determine where I am ...
19 from SCons.Node.FS import default_fs
20 # default_fs.SConstruct_dir is where SConstruct file is located.
21 scons_dir = default_fs.SConstruct_dir.path
22 scons_absdir = default_fs.SConstruct_dir.abspath
24 # if SConstruct is copied to the top source directory
25 if os.path.exists(os.path.join(scons_dir, 'development', 'scons', 'scons_manifest.py')):
26 scons_dir = os.path.join(scons_dir, 'development', 'scons')
27 scons_absdir = os.path.join(scons_absdir, 'development', 'scons')
28 # get the ../.. of scons_dir
29 top_src_dir = os.path.split(os.path.split(scons_absdir)[0])[0]
31 sys.path.extend([scons_absdir, os.path.join(top_src_dir, 'lib', 'doc')])
34 # scons_utils.py defines a few utility function
35 import scons_utils as utils
36 # import all file lists
37 from scons_manifest import *
39 #----------------------------------------------------------
40 # Required runtime environment
41 #----------------------------------------------------------
43 # scons asks for 1.5.2, lyx requires 2.3
44 EnsurePythonVersion(2, 3)
45 # Please use at least 0.96.92 (not 0.96.1)
46 EnsureSConsVersion(0, 96)
47 # also check for minor version number for scons 0.96
48 from SCons import __version__
49 # allow the use of snapshot version of scons
50 __version__ = __version__.split('d')[0]
51 version = map(int, __version__.split('.'))
52 if version[0] == 0 and version[1] == 96 and version[2] < 92:
53 print "Scons >= 0.96.92 is required."
57 #----------------------------------------------------------
59 #----------------------------------------------------------
61 # some global settings
63 # get version number from configure.ac so that JMarc does
64 # not have to change SConstruct during lyx release
65 package_version, lyx_date = utils.getVerFromConfigure(top_src_dir)
66 package_cygwin_version = '%s-1' % package_version
67 boost_version = ['1_34']
69 if 'svn' in package_version:
71 default_build_mode = 'debug'
74 default_build_mode = 'release'
77 package_bugreport = 'lyx-devel@lists.lyx.org'
79 package_tarname = 'lyx'
80 package_string = '%s %s' % (package_name, package_version)
82 # various cache/log files
83 default_log_file = 'scons_lyx.log'
84 opt_cache_file = 'opt.cache'
87 #----------------------------------------------------------
88 # platform dependent settings
89 #----------------------------------------------------------
92 platform_name = 'win32'
93 default_prefix = 'c:/program files/lyx'
94 default_with_x = False
95 default_packaging_method = 'windows'
96 elif os.name == 'posix' and sys.platform != 'cygwin':
97 platform_name = sys.platform
98 default_prefix = '/usr/local'
100 default_packaging_method = 'posix'
101 elif os.name == 'posix' and sys.platform == 'cygwin':
102 platform_name = 'cygwin'
103 default_prefix = '/usr'
104 default_with_x = True
105 default_packaging_method = 'posix'
106 elif os.name == 'darwin':
107 platform_name = 'macosx'
108 # FIXME: macOSX default prefix?
110 default_with_x = False
111 default_packaging_method = 'macosx'
112 else: # unsupported system, assume posix behavior
113 platform_name = 'others'
115 default_with_x = True
116 default_packaging_method = 'posix'
118 #---------------------------------------------------------
120 #----------------------------------------------------------
122 # You can set perminant default values in config.py
123 if os.path.isfile('config.py'):
124 print "Getting options from config.py..."
125 print open('config.py').read()
127 opts = Options(['config.py'])
130 EnumOption('frontend', 'Main GUI', 'qt4',
131 allowed_values = ('qt4',) ),
132 # debug or release build
133 EnumOption('mode', 'Building method', default_build_mode,
134 allowed_values = ('debug', 'release') ),
137 'Use included, system boost library, or try sytem boost first.',
138 'auto', allowed_values = (
139 'auto', # detect boost, if not found, use included
140 'included', # always use included boost
141 'system', # always use system boost, fail if can not find
144 EnumOption('gettext',
145 'Use included, system gettext library, or try sytem gettext first',
146 'auto', allowed_values = (
147 'auto', # detect gettext, if not found, use included
148 'included', # always use included gettext
149 'system', # always use system gettext, fail if can not find
152 EnumOption('spell', 'Choose spell checker to use.', 'auto',
153 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
155 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
156 allowed_values = ('windows', 'posix', 'macosx')),
158 BoolOption('fast_start', 'This option is obsolete.', False),
159 # No precompiled header support (too troublesome to make it work for msvc)
160 # BoolOption('pch', 'Whether or not use pch', False),
161 # enable assertion, (config.h has ENABLE_ASSERTIOS
162 BoolOption('assertions', 'Use assertions', True),
163 # config.h define _GLIBCXX_CONCEPT_CHECKS
164 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
165 BoolOption('concept_checks', 'Enable concept checks', True),
167 BoolOption('nls', 'Whether or not use native language support', True),
169 BoolOption('profiling', 'Whether or not enable profiling', False),
170 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
171 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
173 BoolOption('X11', 'Use x11 windows system', default_with_x),
174 # use MS VC++ to build lyx
175 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
177 PathOption('qt_dir', 'Path to qt directory', None),
179 PathOption('qt_inc_path', 'Path to qt include directory', None),
181 PathOption('qt_lib_path', 'Path to qt library directory', None),
182 # extra include and libpath
183 PathOption('extra_inc_path', 'Extra include path', None),
185 PathOption('extra_lib_path', 'Extra library path', None),
187 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
189 PathOption('extra_inc_path1', 'Extra include path', None),
191 PathOption('extra_lib_path1', 'Extra library path', None),
193 ('rebuild', 'Obsolete option', None),
194 # can be set to a non-existing directory
195 ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
196 # replace the default name and location of the windows installer
197 ('win_installer', 'name or full path to the windows installer', None),
198 # the deps package used to create minimal installer (qt and other libraries)
199 ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
200 # whether or not build bundle installer
201 BoolOption('bundle', 'Whether or not build bundle installer', False),
202 # the bundle directory, containing bundled applications
203 PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
204 # build directory, will use $mode if not set
205 ('build_dir', 'Build directory', None),
207 ('version_suffix', 'install lyx as lyx-suffix', None),
208 # how to load options
209 ('load_option', '''load option from previous scons run. option can be
210 yes (default): load all options
211 no: do not load any option
212 opt1,opt2: load specified options
213 -opt1,opt2: load all options other than specified ones''', 'yes'),
215 ('optimization', 'optimization CCFLAGS option.', None),
217 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
219 ('logfile', 'save commands (not outputs) to logfile', default_log_file),
220 # provided for backward compatibility
221 ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
222 # environment variable can be set as options.
223 ('DESTDIR', 'install to DESTDIR', None),
224 ('CC', 'replace default $CC', None),
225 ('LINK', 'replace default $LINK', None),
226 ('CPP', 'replace default $CPP', None),
227 ('CXX', 'replace default $CXX', None),
228 ('CXXCPP', 'replace default $CXXCPP', None),
229 ('CCFLAGS', 'replace default $CCFLAGS', None),
230 ('CPPFLAGS', 'replace default $CPPFLAGS', None),
231 ('LINKFLAGS', 'replace default $LINKFLAGS', None),
235 all_options = [x.key for x in opts.options]
237 # copied from SCons/Options/BoolOption.py
238 # We need to use them before a boolean ARGUMENTS option is available
240 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
241 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
243 if ARGUMENTS.has_key('fast_start'):
244 print 'fast_start option is obsolete'
246 # if load_option=yes (default), load saved comand line options
248 # This option can take value yes/no/opt1,opt2/-opt1,opt2
249 # and tries to be clever in choosing options to load
250 if (not ARGUMENTS.has_key('load_option') or \
251 ARGUMENTS['load_option'] not in false_strings) \
252 and os.path.isfile(opt_cache_file):
253 cache_file = open(opt_cache_file)
254 opt_cache = cPickle.load(cache_file)
256 # import cached options, but we should ignore qt_dir when frontend changes
257 if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
258 and ARGUMENTS['frontend'] != opt_cache['frontend'] \
259 and opt_cache.has_key('qt_dir'):
260 opt_cache.pop('qt_dir')
261 # and we do not cache some options (dest_dir is obsolete)
262 for arg in ['load_option', 'dest_dir', 'bundle']:
263 if opt_cache.has_key(arg):
265 # remove obsolete cached keys (well, SConstruct is evolving. :-)
266 for arg in opt_cache.keys():
267 if arg not in all_options:
268 print 'Option %s is obsolete, do not load it' % arg
270 # now, if load_option=opt1,opt2 or -opt1,opt2
271 if ARGUMENTS.has_key('load_option') and \
272 ARGUMENTS['load_option'] not in true_strings + false_strings:
273 # if -opt1,opt2 is specified, do not load these options
274 if ARGUMENTS['load_option'][0] == '-':
275 for arg in ARGUMENTS['load_option'][1:].split(','):
276 if opt_cache.has_key(arg):
278 # if opt1,opt2 is specified, only load specified options
280 args = ARGUMENTS['load_option'].split(',')
281 for arg in opt_cache.keys():
284 # now restore options as if entered from command line
285 for key in opt_cache.keys():
286 if not ARGUMENTS.has_key(key):
287 ARGUMENTS[key] = opt_cache[key]
288 print "Restoring cached option %s=%s" % (key, ARGUMENTS[key])
291 # check if there is unused (or misspelled) argument
292 for arg in ARGUMENTS.keys():
293 if arg not in all_options:
295 print "Unknown option '%s'... exiting." % arg
297 print "Available options are (check 'scons -help' for details):"
298 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
302 cache_file = open(opt_cache_file, 'w')
303 cPickle.dump(ARGUMENTS, cache_file)
306 #---------------------------------------------------------
307 # Setting up environment
308 #---------------------------------------------------------
310 # I do not really like ENV=os.environ, but you may add it
311 # here if you experience some environment related problem
312 env = Environment(options = opts)
314 # set individual variables since I do not really like ENV = os.environ
315 env['ENV']['PATH'] = os.environ.get('PATH')
316 env['ENV']['HOME'] = os.environ.get('HOME')
317 # these are defined for MSVC
318 env['ENV']['LIB'] = os.environ.get('LIB')
319 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
321 # for simplicity, use var instead of env[var]
322 frontend = env['frontend']
323 prefix = env['prefix']
326 if platform_name == 'win32':
327 if env.has_key('use_vc'):
328 use_vc = env['use_vc']
329 if WhereIs('cl.exe') is None:
330 print "cl.exe is not found. Are you using the MSVC environment?"
332 elif WhereIs('cl.exe') is not None:
339 # lyx will be built to $build/build_dir so it is possible
340 # to build multiple build_dirs using the same source
341 # $mode can be debug or release
342 if env.has_key('build_dir') and env['build_dir'] is not None:
343 # create the directory if needed
344 if not os.path.isdir(env['build_dir']):
346 os.makedirs(env['build_dir'])
349 if not os.path.isdir(env['build_dir']):
350 print 'Can not create directory', env['build_dir']
352 env['BUILDDIR'] = env['build_dir']
354 # Determine the name of the build $mode
355 env['BUILDDIR'] = '#' + mode
357 # all built libraries will go to build_dir/libs
358 # (This is different from the make file approach)
359 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
360 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
363 # Here is a summary of variables defined in env
365 # 2. undefined options with a non-None default value
366 # 3. compiler commands and flags like CCFLAGS.
367 # MSGFMT used to process po files
368 # 4. Variables that will be used to replace variables in some_file.in
369 # src/support/Package.cpp.in:
370 # TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
371 # lib/lyx2lyx/lyx2lyx_version.py.in
374 # full path name is used to build msvs project files
375 # and to replace TOP_SRCDIR in package.C
376 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
378 # determine share_dir etc
379 packaging_method = env.get('packaging')
380 if packaging_method == 'windows':
381 share_dir = 'Resources'
382 man_dir = 'Resources/man/man1'
383 locale_dir = 'Resources/locale'
385 share_dir = 'share/lyx'
386 locale_dir = 'share/locale'
387 if platform_name == 'cygwin':
388 man_dir = 'share/man/man1'
392 # program suffix: can be yes, or a string
393 if env.has_key('version_suffix'):
394 if env['version_suffix'] in true_strings:
395 program_suffix = package_version
396 elif env['version_suffix'] in false_strings:
399 program_suffix = env['version_suffix']
402 # used by Package.cpp.in
403 env['PROGRAM_SUFFIX'] = program_suffix
405 # whether or not add suffix to file and directory names
406 add_suffix = packaging_method != 'windows'
407 # LYX_DIR are different (used in Package.cpp.in)
409 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
411 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
412 # we need absolute path for package.C
413 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
416 #---------------------------------------------------------
417 # Setting building environment (Tools, compiler flags etc)
418 #---------------------------------------------------------
420 # Since Tool('mingw') will reset CCFLAGS etc, this should be
421 # done before getEnvVariable
422 if platform_name == 'win32':
428 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
429 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
431 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
434 # we differentiate between hard-coded options and default options
435 # hard-coded options are required and will always be there
436 # default options can be replaced by enviromental variables or command line options
437 CCFLAGS_required = []
438 LINKFLAGS_required = []
441 # under windows, scons is confused by .C/.c and uses gcc instead of
442 # g++. I am forcing the use of g++ here. This is expected to change
443 # after lyx renames all .C files to .cpp
445 # save the old c compiler and CCFLAGS (used by libintl)
446 C_COMPILER = env.subst('$CC')
447 C_CCFLAGS = env.subst('$CCFLAGS').split()
448 # if we use ms vc, the commands are fine (cl.exe and link.exe)
450 # C4819: The file contains a character that cannot be represented
451 # in the current code page (number)
452 # C4996: foo was decleared deprecated
453 CCFLAGS_required.append('/EHsc')
455 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
456 # the flags are also needed in C mode (for intl lib)
457 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
459 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
460 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
462 # for debug/release mode
463 if env.has_key('optimization') and env['optimization'] is not None:
464 # if user supplies optimization flags, use it anyway
465 CCFLAGS_required.extend(env['optimization'].split())
466 # and do not use default
467 set_default_optimization_flags = False
469 set_default_optimization_flags = True
473 CCFLAGS_required.append('/Zi')
474 LINKFLAGS_required.extend(['/debug', '/map'])
476 CCFLAGS_required.append('-g')
477 CCFLAGS_default.append('-O')
478 elif mode == 'release' and set_default_optimization_flags:
480 CCFLAGS_default.append('/O2')
482 CCFLAGS_default.append('-O2')
484 # msvc uses separate tools for profiling
485 if env.has_key('profiling') and env['profiling']:
487 print 'Visual C++ does not use profiling options'
489 CCFLAGS_required.append('-pg')
490 LINKFLAGS_required.append('-pg')
492 if env.has_key('warnings') and env['warnings']:
494 CCFLAGS_default.append('/W2')
496 # Note: autotools detect gxx version and pass -W for 3.x
497 # and -Wextra for other versions of gcc
498 CCFLAGS_default.append('-Wall')
500 # Now, set the variables as follows:
501 # 1. if command line option exists: replace default
502 # 2. then if s envronment variable exists: replace default
503 # 3. set variable to required + default
504 def setEnvVariable(env, name, required = None, default = None, split = True):
505 ''' env: environment to set variable
507 required: hardcoded options
508 default: default options that can be replaced by command line or
509 environment variables
510 split: whether or not split obtained variable like '-02 -g'
512 # 1. ARGUMENTS is already set to env[name], override default.
513 if ARGUMENTS.has_key(name):
514 # env[name] may be rewritten when building tools are reloaded
515 # if that is the case, commandline option will override it.
516 env[name] = ARGUMENTS[name]
518 # then use environment default
519 elif os.environ.has_key(name):
520 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
521 default = os.environ[name]
523 default = default.split()
524 # the real value should be env[name] + default + required
527 if env.has_key(name):
528 value = str(env[name]).split()
529 if required is not None:
531 if default is not None:
535 if env.has_key(name):
536 value = str(env[name])
537 if required is not None:
538 value += " " + required
539 if default is not None:
540 value += " " + default
542 # print name, env[name]
544 setEnvVariable(env, 'DESTDIR', split=False)
545 setEnvVariable(env, 'CC')
546 setEnvVariable(env, 'LINK')
547 setEnvVariable(env, 'CPP')
548 setEnvVariable(env, 'CXX')
549 setEnvVariable(env, 'CXXCPP')
550 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
551 setEnvVariable(env, 'CXXFLAGS')
552 setEnvVariable(env, 'CPPFLAGS')
553 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
555 # if DESTDIR is not set...
556 if env.has_key('dest_dir'):
557 print "This option is obsolete. Please use DESTDIR instead."
558 env['DESTDIR'] = env['dest_dir']
561 # extra_inc_path and extra_lib_path
564 if env.has_key('extra_inc_path') and env['extra_inc_path']:
565 extra_inc_paths.append(env['extra_inc_path'])
566 if env.has_key('extra_lib_path') and env['extra_lib_path']:
567 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
568 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
569 extra_inc_paths.append(env['extra_inc_path1'])
570 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
571 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
572 if env.has_key('extra_bin_path') and env['extra_bin_path']:
573 # only the first one is needed (a scons bug?)
574 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
575 env.PrependENVPath('PATH', env['extra_bin_path'])
576 # extra_inc_paths will be used later by intlenv etc
577 env.AppendUnique(CPPPATH = extra_inc_paths)
580 #----------------------------------------------------------
582 #----------------------------------------------------------
584 conf = Configure(env,
586 'CheckPkgConfig' : utils.checkPkgConfig,
587 'CheckPackage' : utils.checkPackage,
588 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
589 'CheckSelectArgType' : utils.checkSelectArgType,
590 'CheckBoostLibraries' : utils.checkBoostLibraries,
591 'CheckCommand' : utils.checkCommand,
592 'CheckNSIS' : utils.checkNSIS,
593 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
594 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
595 'CheckIconvConst' : utils.checkIconvConst,
596 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
597 'CheckDeclaration' : utils.checkDeclaration,
601 # When using msvc, windows.h is required
602 if use_vc and not conf.CheckCHeader('windows.h'):
603 print 'Windows.h is not found. Please install Windows Platform SDK.'
604 print 'Please check config.log for more information.'
607 # pkg-config? (if not, we use hard-coded options)
608 if conf.CheckPkgConfig('0.15.0'):
609 env['HAS_PKG_CONFIG'] = True
611 print 'pkg-config >= 0.1.50 is not found'
612 env['HAS_PKG_CONFIG'] = False
614 # zlib? This is required.
615 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
616 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
617 print 'Did not find zdll.lib or zlib.h, exiting!'
618 print 'Please check config.log for more information.'
620 if conf.CheckLib('iconv'):
621 env['ICONV_LIB'] = 'iconv'
622 elif conf.CheckLib('libiconv'):
623 env['ICONV_LIB'] = 'libiconv'
624 elif conf.CheckFunc('iconv_open'):
625 env['ICONV_LIB'] = None
627 print 'Did not find iconv or libiconv, exiting!'
628 print 'Please check config.log for more information.'
633 if conf.CheckLib('socket'):
634 socket_libs.append('socket')
635 # nsl is the network services library and provides a
636 # transport-level interface to networking services.
637 if conf.CheckLib('nsl'):
638 socket_libs.append('nsl')
640 # check available boost libs (since lyx1.4 does not use iostream)
642 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
643 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
644 boost_libs.append(lib)
646 # check boost libraries
647 boost_opt = ARGUMENTS.get('boost', 'auto')
648 # check for system boost
649 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
650 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
651 # default to $BUILDDIR/libs (use None since this path will be added anyway)
653 # here I assume that all libraries are in the same directory
654 if boost_opt == 'included':
655 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
656 included_boost = True
657 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
658 elif boost_opt == 'auto':
659 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
660 # if not found, use local boost
662 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
663 included_boost = True
664 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
666 included_boost = False
667 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
668 elif boost_opt == 'system':
669 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
671 print "Can not find system boost libraries with version %s " % boost_version
672 print "Please supply a path through extra_lib_path and try again."
673 print "Or use boost=included to use included boost libraries."
676 included_boost = False
677 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
680 if boost_libpath is not None:
681 env.AppendUnique(LIBPATH = [boost_libpath])
684 env['ENABLE_NLS'] = env['nls']
686 if not env['ENABLE_NLS']:
688 included_gettext = False
690 # check gettext libraries
691 gettext_opt = ARGUMENTS.get('gettext', 'auto')
692 # check for system gettext
694 if gettext_opt in ['auto', 'system']:
695 if conf.CheckFunc('gettext'):
696 included_gettext = False
699 elif conf.CheckLib('intl'):
700 included_gettext = False
704 if gettext_opt == 'system':
705 print "Can not find system gettext library"
706 print "Please supply a path through extra_lib_path and try again."
707 print "Or use gettext=included to use included gettext libraries."
709 # now, auto and succ = false, or gettext=included
711 # we do not need to set LIBPATH now.
712 included_gettext = True
713 intl_libs = ['included_intl']
717 # check for msgfmt command
718 env['MSGFMT'] = conf.CheckCommand('msgfmt')
719 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
720 env['XGETTEXT'] = conf.CheckCommand('xgettext')
721 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
723 # if under windows, check the nsis compiler
724 if platform_name == 'win32':
725 env['NSIS'] = conf.CheckNSIS()
727 # cygwin packaging requires the binaries to be stripped
728 if platform_name == 'cygwin':
729 env['STRIP'] = conf.CheckCommand('strip')
732 # Customized builders
734 # install customized builders
735 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
736 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
737 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
740 #----------------------------------------------------------
741 # Generating config.h
742 #----------------------------------------------------------
743 aspell_lib = 'aspell'
744 # assume that we use aspell, aspelld compiled for msvc
745 if platform_name == 'win32' and mode == 'debug' and use_vc:
746 aspell_lib = 'aspelld'
748 # check the existence of config.h
749 config_h = os.path.join(env.Dir('$BUILDDIR/src').path, 'config.h')
750 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
752 print "Creating %s..." % boost_config_h
754 utils.createConfigFile(conf,
755 config_file = boost_config_h,
756 config_pre = '''/* boost/config.h. Generated by SCons. */
761 * This file is part of LyX, the document processor.
762 * Licence details can be found in the file COPYING.
764 * This is the compilation configuration file for LyX.
765 * It was generated by scon.
766 * You might want to change some of the defaults if something goes wrong
767 * during the compilation.
770 #ifndef _BOOST_CONFIG_H
771 #define _BOOST_CONFIG_H
774 ('ostream', 'HAVE_OSTREAM', 'cxx'),
775 ('locale', 'HAVE_LOCALE', 'cxx'),
776 ('sstream', 'HAVE_SSTREAM', 'cxx'),
777 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
780 (env.has_key('assertions') and env['assertions'],
782 'Define if you want assertions to be enabled in the code'
786 ('wchar_t', 'HAVE_WCHAR_T', None),
790 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
791 # define USE_BOOST_FORMAT 1
793 # define USE_BOOST_FORMAT 0
796 #if !defined(ENABLE_ASSERTIONS)
797 # define BOOST_DISABLE_ASSERTS 1
799 #define BOOST_ENABLE_ASSERT_HANDLER 1
801 #define BOOST_DISABLE_THREADS 1
802 #define BOOST_NO_WSTRING 1
805 # define BOOST_POSIX 1
806 # define BOOST_POSIX_API 1
807 # define BOOST_POSIX_PATH 1
810 #define BOOST_ALL_NO_LIB 1
812 #if defined(HAVE_NEWAPIS_H)
813 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
817 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
818 * support compiled in:
819 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
820 * And we are not interested at all what libc
821 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
822 * has the needed wchar_t support and uses UCS4. Whether it
823 * implements this with the help of libc, or whether it has own code
824 * does not matter for us, because we don't use libc directly (Georg)
826 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
834 print "\nGenerating %s..." % config_h
836 # AIKSAURUS_H_LOCATION
837 if (conf.CheckCXXHeader("Aiksaurus.h")):
838 aik_location = '<Aiksaurus.h>'
839 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
840 aik_location = '<Aiksaurus/Aiksaurus.h>'
844 # determine headers to use
845 spell_opt = ARGUMENTS.get('spell', 'auto')
846 env['USE_ASPELL'] = False
847 env['USE_PSPELL'] = False
848 env['USE_ISPELL'] = False
849 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
850 spell_engine = 'USE_ASPELL'
851 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
852 spell_engine = 'USE_PSPELL'
853 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
854 spell_engine = 'USE_ISPELL'
858 if spell_engine is not None:
859 env[spell_engine] = True
861 if spell_opt == 'auto':
862 print "Warning: Can not locate any spell checker"
863 elif spell_opt != 'no':
864 print "Warning: Can not locate specified spell checker:", spell_opt
865 print 'Please check config.log for more information.'
868 # check arg types of select function
869 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
871 # check the size of wchar_t
872 sizeof_wchar_t = conf.CheckSizeOfWChar()
874 if sizeof_wchar_t == 0:
875 print 'Error: Can not determine the size of wchar_t.'
876 print 'Please check config.log for more information.'
880 # fill in the version info
881 env['VERSION_INFO'] = '''Configuration
883 Special build flags: %s
885 C Compiler flags: %s %s
887 C++ Compiler LyX flags: %s
888 C++ Compiler flags: %s %s
890 Linker user flags: %s
892 Builing directory: %s
893 Local library directory: %s
896 include search path: %s
902 ''' % (platform_name,
903 env.subst('$CCFLAGS'), env.subst('$CC'),
904 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
905 env.subst('$CXX'), env.subst('$CXXFLAGS'),
906 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
907 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
908 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
909 str(env['LIBPATH']), str(boost_libraries),
911 frontend, packaging_method,
912 prefix, env['LYX_DIR'])
916 result = utils.createConfigFile(conf,
917 config_file = config_h,
918 config_pre = '''/* config.h. Generated by SCons. */
923 * This file is part of LyX, the document processor.
924 * Licence details can be found in the file COPYING.
926 * This is the compilation configuration file for LyX.
927 * It was generated by scon.
928 * You might want to change some of the defaults if something goes wrong
929 * during the compilation.
936 ('io.h', 'HAVE_IO_H', 'c'),
937 ('limits.h', 'HAVE_LIMITS_H', 'c'),
938 ('locale.h', 'HAVE_LOCALE_H', 'c'),
939 ('process.h', 'HAVE_PROCESS_H', 'c'),
940 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
941 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
942 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
943 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
944 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
945 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
946 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
947 ('utime.h', 'HAVE_UTIME_H', 'c'),
948 ('direct.h', 'HAVE_DIRECT_H', 'c'),
949 ('istream', 'HAVE_ISTREAM', 'cxx'),
950 ('ios', 'HAVE_IOS', 'cxx'),
953 ('open', 'HAVE_OPEN', None),
954 ('chmod', 'HAVE_CHMOD', None),
955 ('close', 'HAVE_CLOSE', None),
956 ('popen', 'HAVE_POPEN', None),
957 ('pclose', 'HAVE_PCLOSE', None),
958 ('_open', 'HAVE__OPEN', None),
959 ('_close', 'HAVE__CLOSE', None),
960 ('_popen', 'HAVE__POPEN', None),
961 ('_pclose', 'HAVE__PCLOSE', None),
962 ('getpid', 'HAVE_GETPID', None),
963 ('_getpid', 'HAVE__GETPID', None),
964 ('mkdir', 'HAVE_MKDIR', None),
965 ('_mkdir', 'HAVE__MKDIR', None),
966 ('mktemp', 'HAVE_MKTEMP', None),
967 ('mkstemp', 'HAVE_MKSTEMP', None),
968 ('strerror', 'HAVE_STRERROR', None),
969 ('getcwd', 'HAVE_GETCWD', None),
970 ('setenv', 'HAVE_SETENV', None),
971 ('putenv', 'HAVE_PUTENV', None),
972 ('fcntl', 'HAVE_FCNTL', None),
973 ('mkfifo', 'HAVE_MKFIFO', None),
976 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
979 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
980 '#include <streambuf>\n#include <istream>'),
981 ('wchar_t', 'HAVE_WCHAR_T', None),
982 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
985 ('gdi32', 'HAVE_LIBGDI32'),
986 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
989 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
991 'Define is sys/types.h does not have pid_t',
995 (conf.CheckCXXGlobalCstd(),
997 'Define if your C++ compiler puts C library functions in the global namespace'
999 (conf.CheckMkdirOneArg(),
1000 'MKDIR_TAKES_ONE_ARG',
1001 'Define if mkdir takes only one argument.'
1003 (conf.CheckIconvConst(),
1005 'Define as const if the declaration of iconv() needs const.',
1006 '#define ICONV_CONST const',
1007 '#define ICONV_CONST',
1009 (conf.CheckLC_MESSAGES(),
1011 'Define if your <locale.h> file defines LC_MESSAGES.'
1013 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
1016 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1018 (env['nls'] and not included_gettext,
1020 'Define to 1 if using system gettext library'
1022 (env.has_key('concept_checks') and env['concept_checks'],
1023 '_GLIBCXX_CONCEPT_CHECKS',
1024 'libstdc++ concept checking'
1026 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1028 'libstdc++ debug mode'
1030 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1031 '_GLIBCXX_DEBUG_PEDANTIC',
1032 'libstdc++ pedantic debug mode'
1034 (os.name != 'nt', 'BOOST_POSIX',
1035 'Indicates to boost < 1.34 which API to use (posix or windows).'
1037 (os.name != 'nt', 'BOOST_POSIX_API',
1038 'Indicates to boost 1.34 which API to use (posix or windows).'
1040 (os.name != 'nt', 'BOOST_POSIX_PATH',
1041 'Indicates to boost 1.34 which path style to use (posix or windows).'
1043 (spell_engine is not None, spell_engine,
1044 'Spell engine to use'
1046 # we need to know the byte order for unicode conversions
1047 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1048 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1052 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1054 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1055 'Define to the address where bug reports for this package should be sent.'),
1056 ('#define PACKAGE_NAME "%s"' % package_name,
1057 'Define to the full name of this package.'),
1058 ('#define PACKAGE_STRING "%s"' % package_string,
1059 'Define to the full name and version of this package.'),
1060 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1061 'Define to the one symbol short name of this package.'),
1062 ('#define PACKAGE_VERSION "%s"' % package_version,
1063 'Define to the version of this package.'),
1064 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1065 'Full version info'),
1066 ('#define LYX_DATE "%s"' % lyx_date,
1068 ('#define BOOST_ALL_NO_LIB 1',
1069 'disable automatic linking of boost libraries.'),
1070 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1071 'Packaging method'),
1072 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1073 'Aiksaurus include file'),
1074 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1075 "Define to the type of arg 1 for `select'."),
1076 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1077 "Define to the type of arg 2, 3, 4 for `select'."),
1078 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1079 "Define to the type of arg 5 for `select'."),
1080 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1081 'Define to be the size of type wchar_t'),
1083 config_post = '''/************************************************************
1084 ** You should not need to change anything beyond this point */
1086 #ifndef HAVE_STRERROR
1087 #if defined(__cplusplus)
1090 char * strerror(int n);
1093 #include <../boost/config.h>
1099 # these keys are needed in env
1100 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1101 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1102 # USE_ASPELL etc does not go through result
1103 if result.has_key(key):
1104 env[key] = result[key]
1107 # if nls=yes and gettext=included, create intl/config.h
1108 # intl/libintl.h etc
1110 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1111 if env['nls'] and included_gettext:
1113 print "Creating %s..." % intl_config_h
1115 # create intl/config.h
1116 result = utils.createConfigFile(conf,
1117 config_file = intl_config_h,
1118 config_pre = '''/* intl/config.h. Generated by SCons. */
1123 * This file is part of LyX, the document processor.
1124 * Licence details can be found in the file COPYING.
1126 * This is the compilation configuration file for LyX.
1127 * It was generated by scon.
1128 * You might want to change some of the defaults if something goes wrong
1129 * during the compilation.
1136 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1137 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1138 ('string.h', 'HAVE_STRING_H', 'c'),
1139 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1140 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1141 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1142 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1143 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1144 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1145 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1148 ('getcwd', 'HAVE_GETCWD', None),
1149 ('stpcpy', 'HAVE_STPCPY', None),
1150 ('strcasecmp', 'HAVE_STRCASECMP', None),
1151 ('strdup', 'HAVE_STRDUP', None),
1152 ('strtoul', 'HAVE_STRTOUL', None),
1153 ('alloca', 'HAVE_ALLOCA', None),
1154 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1155 ('mempcpy', 'HAVE_MEMPCPY', None),
1156 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1157 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1158 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1159 ('setlocale', 'HAVE_SETLOCALE', None),
1160 ('tsearch', 'HAVE_TSEARCH', None),
1161 ('getegid', 'HAVE_GETEGID', None),
1162 ('getgid', 'HAVE_GETGID', None),
1163 ('getuid', 'HAVE_GETUID', None),
1164 ('wcslen', 'HAVE_WCSLEN', None),
1165 ('asprintf', 'HAVE_ASPRINTF', None),
1166 ('wprintf', 'HAVE_WPRINTF', None),
1167 ('snprintf', 'HAVE_SNPRINTF', None),
1168 ('printf', 'HAVE_POSIX_PRINTF', None),
1169 ('fcntl', 'HAVE_FCNTL', None),
1172 ('intmax_t', 'HAVE_INTMAX_T', None),
1173 ('long double', 'HAVE_LONG_DOUBLE', None),
1174 ('long long', 'HAVE_LONG_LONG', None),
1175 ('wchar_t', 'HAVE_WCHAR_T', None),
1176 ('wint_t', 'HAVE_WINT_T', None),
1177 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1178 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1184 (conf.CheckLC_MESSAGES(),
1186 'Define if your <locale.h> file defines LC_MESSAGES.'
1188 (conf.CheckIconvConst(),
1190 'Define as const if the declaration of iconv() needs const.',
1191 '#define ICONV_CONST const',
1192 '#define ICONV_CONST',
1194 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1195 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1197 "Define to 1 if you have the `intmax_t' type."
1199 (env.has_key('nls') and env['nls'],
1201 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1205 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1206 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1207 'Define to be the size of type wchar_t'),
1209 config_post = '#endif'
1212 # these keys are needed in env
1213 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1214 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1215 # USE_ASPELL etc does not go through result
1216 if result.has_key(key):
1217 env[key] = result[key]
1220 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1221 if env['nls'] and included_gettext:
1222 # libgnuintl.h.in => libintl.h
1223 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1224 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1225 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1226 [Copy('$TARGET', '$SOURCE')])
1229 # Finish auto-configuration
1232 #----------------------------------------------------------
1233 # Now set up our build process accordingly
1234 #----------------------------------------------------------
1236 if env['ICONV_LIB'] is None:
1239 system_libs = [env['ICONV_LIB']]
1240 if platform_name in ['win32', 'cygwin']:
1241 # the final link step needs stdc++ to succeed under mingw
1242 # FIXME: shouldn't g++ automatically link to stdc++?
1244 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1246 system_libs += ['shlwapi', 'stdc++', 'z']
1247 elif platform_name == 'cygwin' and env['X11']:
1248 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1249 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1250 'resolv', 'pthread', 'z']
1252 system_libs += ['z']
1255 ('HAVE_LIBGDI32', 'gdi32'),
1256 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1257 ('USE_ASPELL', aspell_lib),
1258 ('USE_ISPELL', 'ispell'),
1259 ('USE_PSPELL', 'pspell'),
1264 system_libs.append(lib[1])
1267 # Build parameters CPPPATH etc
1270 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1273 # boost: for boost header files
1274 # BUILDDIR/src: for config.h
1275 # TOP_SRCDIR/src: for support/* etc
1277 env['CPPPATH'] += ['$BUILDDIR/src', '$TOP_SRCDIR/src']
1279 # Separating boost directories from CPPPATH stops scons from building
1280 # the dependency tree for boost header files, and effectively reduce
1281 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1282 # boost headers, the following is not 100% safe.
1283 # env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1284 env.PrependUnique(CCFLAGS = ['$INCPREFIX$BOOST_INC_PATH'])
1286 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1287 if env['nls'] and included_gettext:
1288 env['CPPPATH'].append('$BUILDDIR/intl')
1292 # A Link script for cygwin see
1293 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1294 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1297 if platform_name == 'cygwin':
1298 ld_script_path = '/tmp'
1299 ld_script = utils.installCygwinLDScript(ld_script_path)
1300 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1301 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1304 #---------------------------------------------------------
1305 # Frontend related variables (QTDIR etc)
1306 #---------------------------------------------------------
1309 # create a separate environment so that other files do not have
1310 # to be built with all the include directories etc
1312 if frontend == 'qt4':
1313 frontend_env = env.Copy()
1315 # handle qt related user specified paths
1316 # set environment so that moc etc can be found even if its path is not set properly
1317 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1318 frontend_env['QTDIR'] = frontend_env['qt_dir']
1319 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1320 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1321 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1322 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1323 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1325 # if separate qt_lib_path is given
1326 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1327 qt_lib_path = frontend_env.subst('$qt_lib_path')
1328 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1329 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1333 # if separate qt_inc_path is given
1334 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1335 qt_inc_path = frontend_env['qt_inc_path']
1339 # local qt4 toolset from
1340 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1342 # NOTE: I have to patch qt4.py since it does not automatically
1343 # process .C file!!! (add to cxx_suffixes )
1345 frontend_env.Tool('qt4', [scons_dir])
1346 frontend_env['QT_AUTOSCAN'] = 0
1347 frontend_env['QT4_AUTOSCAN'] = 0
1348 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1350 if qt_lib_path is None:
1351 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1352 if qt_inc_path is None:
1353 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1356 conf = Configure(frontend_env,
1358 'CheckPackage' : utils.checkPackage,
1359 'CheckCommand' : utils.checkCommand,
1364 # first: try pkg_config
1365 if frontend_env['HAS_PKG_CONFIG']:
1366 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1367 # FIXME: use pkg_config information?
1368 #frontend_env['QT4_PKG_CONFIG'] = succ
1369 # second: try to link to it
1371 # Under linux, I can test the following perfectly
1372 # Under windows, lib names need to passed as libXXX4.a ...
1373 if platform_name == 'win32':
1374 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1376 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1377 # still can not find it
1379 print 'Did not find qt libraries, exiting!'
1380 print 'Please check config.log for more information.'
1383 # Now, determine the correct suffix:
1384 qt_libs = ['QtCore', 'QtGui']
1385 if platform_name == 'win32':
1386 if mode == 'debug' and use_vc and \
1387 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1388 qt_lib_suffix = 'd4'
1389 use_qt_debug_libs = True
1392 use_qt_debug_libs = False
1394 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1395 qt_lib_suffix = '_debug'
1396 use_qt_debug_libs = True
1399 use_qt_debug_libs = False
1400 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1401 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1402 qtcore_lib = ['QtCore' + qt_lib_suffix]
1404 # check uic and moc commands for qt frontends
1405 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1406 print 'uic or moc command is not found for frontend', frontend
1409 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1410 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1411 # For some unknown changes in msvc or qt, this is no longer needed.
1413 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1414 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1415 env.File('$BUILDDIR/lyx.exe.manifest').path]
1417 frontend_env = conf.Finish()
1424 print env['VERSION_INFO']
1427 # Mingw command line may be too short for our link usage,
1428 # Here we use a trick from scons wiki
1429 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1431 # I also would like to add logging (commands only) capacity to the
1433 logfile = env.get('logfile', default_log_file)
1434 if logfile != '' or platform_name == 'win32':
1436 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1437 info = '''# This is a log of commands used by scons to build lyx
1441 ''' % (time.asctime(), ' '.join(sys.argv),
1442 env['VERSION_INFO'].replace('\n','\n# ')) )
1447 # -h will print out help info
1448 Help(opts.GenerateHelpText(env))
1452 #----------------------------------------------------------
1454 #----------------------------------------------------------
1455 # this has been the source of problems on some platforms...
1456 # I find that I need to supply it with full path name
1457 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1458 # this usage needs further investigation.
1459 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1460 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1461 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1462 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1463 frontend_env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1465 print "Building all targets recursively"
1467 def libExists(libname):
1468 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1469 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1472 if (included_boost and not libExists('included_boost_regex')) or 'boost' in BUILD_TARGETS:
1476 for lib in boost_libs:
1477 boostlib = env.StaticLibrary(
1478 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1479 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)],
1480 # do not use global CPPPATH because src/config.h will mess up with boost/config.h
1481 CPPPATH = ['$BUILDDIR/boost'] + extra_inc_paths,
1482 CCFLAGS = ['$CCFLAGS', '$INCPREFIX$TOP_SRCDIR/boost', '-DBOOST_USER_CONFIG="<config.h>"']
1484 Alias('boost', boostlib)
1487 if (included_gettext and not libExists('included_intl')) or 'intl' in BUILD_TARGETS:
1492 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1493 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1494 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1496 '-DENABLE_RELOCATABLE=1',
1498 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1500 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1501 '-Drelocate=libintl_relocate',
1502 '-DDEPENDS_ON_LIBICONV=1',
1506 INTL_CCFLAGS.extend(['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1508 intl = env.StaticLibrary(
1509 target = '$LOCALLIBPATH/included_intl',
1511 CCFLAGS = INTL_CCFLAGS,
1512 # do not use global CPPPATH because src/config.h will mess up with intl/config.h
1513 CPPPATH = ['$BUILDDIR/intl'] + extra_inc_paths,
1514 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1520 # Now, src code under src/
1525 frontend_env.Depends('$BUILDDIR/src/support/Package.cpp', '$BUILDDIR/src/config.h')
1526 Package_cpp = env.substFile('$BUILDDIR/src/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1528 support = frontend_env.StaticLibrary(
1529 target = '$LOCALLIBPATH/support',
1530 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files] + Package_cpp + \
1531 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_files] + \
1532 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_windows_files if platform_name == 'win32'],
1536 '-DQT_CLEAN_NAMESPACE',
1541 CPPPATH = ['$CPPPATH', '$TOP_SRCDIR/src/support/minizip']
1543 Alias('support', support)
1549 mathed = env.StaticLibrary(
1550 target = '$LOCALLIBPATH/mathed',
1551 source = ['$BUILDDIR/src/mathed/%s' % x for x in src_mathed_files]
1553 Alias('mathed', mathed)
1559 insets = env.StaticLibrary(
1560 target = '$LOCALLIBPATH/insets',
1561 source = ['$BUILDDIR/src/insets/%s' % x for x in src_insets_files]
1563 Alias('insets', insets)
1569 frontends = env.StaticLibrary(
1570 target = '$LOCALLIBPATH/frontends',
1571 source = ['$BUILDDIR/src/frontends/%s' % x for x in src_frontends_files]
1573 Alias('frontends', frontends)
1579 graphics = env.StaticLibrary(
1580 target = '$LOCALLIBPATH/graphics',
1581 source = ['$BUILDDIR/src/graphics/%s' % x for x in src_graphics_files]
1583 Alias('graphics', graphics)
1587 # src/frontends/controllers
1589 controllers = env.StaticLibrary(
1590 target = '$LOCALLIBPATH/controllers',
1591 source = ['$BUILDDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1593 Alias('controllers', controllers)
1599 frontend_env['QT4_MOCHPREFIX'] = ''
1600 frontend_env['QT4_MOCHSUFFIX'] = '_moc.cpp'
1602 # tells scons how to get these moced files, although not all moced files are needed
1603 # (or are actually generated).
1604 qt4_moced_files = [frontend_env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1605 for x in src_frontends_qt4_header_files ]
1606 resources = [frontend_env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1607 for x in src_frontends_qt4_ui_files]
1610 # moc qt4_moc_files, the moced files are included in the original files
1612 qt4 = frontend_env.StaticLibrary(
1613 target = '$LOCALLIBPATH/qt4',
1614 source = ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1618 '$BUILDDIR/src/images',
1619 '$BUILDDIR/src/frontends',
1620 '$BUILDDIR/src/frontends/qt4',
1621 '$BUILDDIR/src/frontends/qt4/ui',
1622 '$BUILDDIR/src/frontends/controllers'
1627 '-DQT_CLEAN_NAMESPACE',
1639 if env['HAVE_FCNTL']:
1640 client = frontend_env.Program(
1641 target = '$BUILDDIR/src/client/lyxclient',
1642 LIBS = ['support'] + intl_libs + system_libs +
1643 socket_libs + boost_libraries + qtcore_lib,
1644 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1645 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1647 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1648 client, [Copy('$TARGET', '$SOURCE')]))
1651 Alias('client', client)
1657 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1658 frontend_env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1659 [Copy('$TARGET', '$SOURCE')])
1661 tex2lyx = frontend_env.Program(
1662 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1663 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1664 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1665 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1666 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$CPPPATH'],
1667 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1669 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1670 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1671 Alias('tex2lyx', tex2lyx)
1677 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1678 src_post_files.append('ASpell.cpp')
1679 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1680 src_post_files.append('PSpell.cpp')
1681 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1682 src_post_files.append('ISpell.cpp')
1684 # msvc requires at least one source file with main()
1685 # so I exclude main.cpp from lyxbase
1686 lyxbase_pre = env.StaticLibrary(
1687 target = '$LOCALLIBPATH/lyxbase_pre',
1688 source = ['$BUILDDIR/src/%s' % x for x in src_pre_files]
1690 lyxbase_post = env.StaticLibrary(
1691 target = '$LOCALLIBPATH/lyxbase_post',
1692 source = ["$BUILDDIR/src/%s" % x for x in src_post_files]
1694 Alias('lyxbase', lyxbase_pre)
1695 Alias('lyxbase', lyxbase_post)
1699 # Build lyx with given frontend
1701 lyx = frontend_env.Program(
1702 target = '$BUILDDIR/lyx',
1703 source = ['$BUILDDIR/src/main.cpp'] + \
1704 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1725 if use_vc and 'msvs_projects' in BUILD_TARGETS:
1726 def build_project(target, full_target = None,
1727 src = [], inc = [], res = []):
1728 ''' build mavs project files
1729 target: alias (correspond to directory name)
1730 full_target: full path/filename of the target
1735 For non-debug-able targets like static libraries, target (alias) is
1736 enough to build the target. For executable targets, msvs need to know
1737 the full path to start debug them.
1740 if full_target is None:
1741 build_target = target
1743 build_target = full_target
1745 proj = env.MSVSProject(
1746 target = target + env['MSVSPROJECTSUFFIX'],
1747 # this allows easy access to header files (along with source)
1748 srcs = [env.subst(x) for x in src + inc],
1749 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1750 localincs = [env.subst(x) for x in inc],
1751 resources = [env.subst(x) for x in res],
1752 buildtarget = build_target,
1756 Alias('msvs_projects', proj)
1758 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1759 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1760 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1762 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1763 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1764 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1766 build_project('lyx',
1767 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1768 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1769 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1770 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1771 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1772 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1773 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1774 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1775 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1776 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1777 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1778 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1779 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1780 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1781 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1782 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1783 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1784 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1787 if 'update_po' in BUILD_TARGETS:
1791 print 'Updating po/*.po files...'
1793 # whether or not update po files
1794 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1795 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1797 # rebuild POTFILES.in
1798 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1799 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1800 src_extra_src_files] + \
1801 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1802 src_support_extra_header_files + src_support_extra_src_files] + \
1803 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1804 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1805 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1806 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1807 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
1808 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
1809 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1810 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1812 Alias('update_po', POTFILES_in)
1813 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
1814 # and combine them to lyx.po
1815 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1816 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1817 env.Command('$BUILDDIR/po/all.po',
1818 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1819 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1820 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1821 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1822 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
1823 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1824 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1825 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1826 env.Command('$BUILDDIR/po/ui_l10n.pot',
1827 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1828 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1829 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1830 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
1832 ['$MSGUNIQ -o $TARGET $SOURCE',
1833 '''$XGETTEXT --default-domain=${TARGET.base} \
1834 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
1835 --language=C++ --join-existing \
1836 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
1837 --files-from=$TOP_SRCDIR/po/POTFILES.in \
1838 --copyright-holder="LyX Developers" \
1839 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
1841 env.Depends(lyx_po, POTFILES_in)
1842 # copy lyx.po to lyx.pot
1843 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
1844 Copy('$TARGET', '$SOURCE'))
1847 # files to translate
1848 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
1849 # possibly *only* handle these languages
1851 if env.has_key('languages'):
1852 languages = env.make_list(env['languages'])
1853 # merge. if I use lan.po as $TARGET, it will be removed
1854 # before it is merged. In this builder,
1855 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
1856 # and is copied to po/lang.po
1857 env['BUILDERS']['msgmerge'] = Builder(action=[
1858 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
1859 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
1861 # for each po file, generate pot
1862 for po_file in transfiles:
1864 fname = os.path.split(po_file)[1]
1866 country = fname.split('.')[0]
1868 if not languages or country in languages:
1869 # merge po files, the generated lan.po_new file is copied to lan.po file.
1870 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
1871 env.Depends(po, POTFILES_in)
1872 Alias('update_po', po)
1875 # if 'install' is not in the target, do not process this
1876 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
1878 # this part is a bit messy right now. Since scons will provide
1879 # --DESTDIR option soon, at least the dest_dir handling can be
1888 # files to translate
1889 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1890 # possibly *only* handle these languages
1892 if env.has_key('languages'):
1893 languages = env.make_list(env['lanauges'])
1894 # use defulat msgfmt
1896 if not env['MSGFMT']:
1897 print 'msgfmt does not exist. Can not process po files'
1900 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
1902 for f in transfiles:
1904 fname = os.path.split(f)[1]
1906 country = fname.split('.')[0]
1908 if not languages or country in languages:
1909 gmo_files.extend(env.Transfiles(f))
1910 # how to join dest_dir and prefix
1911 def joinPaths(path1, path2):
1912 ''' join path1 and path2, do not use os.path.join because
1913 under window, c:\destdir\d:\program is invalid '''
1915 return os.path.normpath(path2)
1916 # separate drive letter
1917 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
1918 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
1919 return os.path.join(os.path.normpath(path1), path[1:])
1921 # install to dest_dir/prefix
1922 dest_dir = env.get('DESTDIR', '')
1923 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
1924 # create the directory if needed
1925 if not os.path.isdir(dest_prefix_dir):
1927 os.makedirs(dest_prefix_dir)
1930 if not os.path.isdir(dest_prefix_dir):
1931 print 'Can not create directory', dest_prefix_dir
1934 if env.has_key('exec_prefix'):
1935 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
1937 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
1939 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
1941 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
1942 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
1943 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
1944 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
1948 # install executables (lyxclient may be None)
1951 version_suffix = program_suffix
1955 # install lyx, if in release mode, try to strip the binary
1956 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
1957 # create a builder to strip and install
1958 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
1960 # install executables
1961 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
1964 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
1965 target = os.path.join(bin_dest_dir, target_name)
1966 if env['BUILDERS'].has_key('StripInstallAs'):
1967 env.StripInstallAs(target, obj)
1969 env.InstallAs(target, obj)
1970 Alias('install', target)
1974 for (dir,files) in [
1976 ('bind', lib_bind_files),
1977 ('bind/de', lib_bind_de_files),
1978 ('bind/fi', lib_bind_fi_files),
1979 ('bind/pt', lib_bind_pt_files),
1980 ('bind/sv', lib_bind_sv_files),
1981 ('doc', lib_doc_files),
1982 ('doc/biblio', lib_doc_biblio_files),
1983 ('doc/clipart', lib_doc_clipart_files),
1984 ('doc/cs', lib_doc_cs_files),
1985 ('doc/da', lib_doc_da_files),
1986 ('doc/de', lib_doc_de_files),
1987 ('doc/de/clipart', lib_doc_de_clipart_files),
1988 ('doc/es', lib_doc_es_files),
1989 ('doc/es/clipart', lib_doc_es_clipart_files),
1990 ('doc/eu', lib_doc_eu_files),
1991 ('doc/fr', lib_doc_fr_files),
1992 ('doc/he', lib_doc_he_files),
1993 ('doc/hu', lib_doc_hu_files),
1994 ('doc/it', lib_doc_it_files),
1995 ('doc/nl', lib_doc_nl_files),
1996 ('doc/nb', lib_doc_nb_files),
1997 ('doc/pl', lib_doc_pl_files),
1998 ('doc/pt', lib_doc_pt_files),
1999 ('doc/ro', lib_doc_ro_files),
2000 ('doc/ru', lib_doc_ru_files),
2001 ('doc/sk', lib_doc_sk_files),
2002 ('doc/sl', lib_doc_sl_files),
2003 ('doc/sv', lib_doc_sv_files),
2004 ('examples', lib_examples_files),
2005 ('examples/ca', lib_examples_ca_files),
2006 ('examples/cs', lib_examples_cs_files),
2007 ('examples/da', lib_examples_da_files),
2008 ('examples/de', lib_examples_de_files),
2009 ('examples/es', lib_examples_es_files),
2010 ('examples/eu', lib_examples_eu_files),
2011 ('examples/fa', lib_examples_fa_files),
2012 ('examples/fr', lib_examples_fr_files),
2013 ('examples/he', lib_examples_he_files),
2014 ('examples/hu', lib_examples_hu_files),
2015 ('examples/it', lib_examples_it_files),
2016 ('examples/nl', lib_examples_nl_files),
2017 ('examples/pl', lib_examples_pl_files),
2018 ('examples/pt', lib_examples_pt_files),
2019 ('examples/ru', lib_examples_ru_files),
2020 ('examples/sl', lib_examples_sl_files),
2021 ('examples/ro', lib_examples_ro_files),
2022 ('fonts', lib_fonts_files),
2023 ('images', lib_images_files),
2024 ('images/math', lib_images_math_files),
2025 ('kbd', lib_kbd_files),
2026 ('layouts', lib_layouts_files + lib_layouts_inc_files),
2027 ('lyx2lyx', lib_lyx2lyx_files),
2028 ('scripts', lib_scripts_files),
2029 ('templates', lib_templates_files),
2030 ('tex', lib_tex_files),
2031 ('ui', lib_ui_files)]:
2032 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2033 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2034 Alias('install', dirs)
2036 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2037 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
2038 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2039 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2040 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2041 sys.path.append(share_dest_dir + '/lyx2lyx')
2043 # generate TOC files for each doc
2044 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2046 for lang in languages.keys():
2047 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2048 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2051 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2052 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2054 # this is for English
2055 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2058 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2059 Alias('install', tocs)
2061 if platform_name == 'cygwin':
2062 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2063 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2064 '%s-%s.README' % (package, package_cygwin_version))
2065 env.InstallAs(Cygwin_README,
2066 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2067 Alias('install', Cygwin_README)
2068 # also a directory /usr/share/doc/lyx for README etc
2069 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2070 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2071 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2072 Alias('install', Cygwin_Doc)
2073 # cygwin fonts also need to be installed
2074 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2075 env.Install(Cygwin_fonts,
2076 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2077 for file in win32_bakoma_fonts])
2078 Alias('install', Cygwin_fonts)
2079 # we also need a post installation script
2080 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2081 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2082 env.Install(postinstall_path, tmp_script)
2083 Alias('install', postinstall_path)
2087 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2088 env.subst('$TOP_SRCDIR/lyx.man'))
2089 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2090 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2091 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2092 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2093 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2094 x in ['lyx', 'tex2lyx', 'lyxclient']])
2096 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2097 for gmo in gmo_files:
2098 lan = os.path.split(str(gmo))[1].split('.')[0]
2099 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2100 env.InstallAs(dest_file, gmo)
2101 Alias('install', dest_file)
2104 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
2106 # build windows installer using NSIS
2109 # There is a nsis builder on scons wiki but it does not work with
2110 # our lyx.nsi because it does not dig through all the include directives
2111 # and find the dependencies automatically. Also, it can not parse
2112 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2113 # something rely on date.
2114 # Because of this, I am doing a simple nsis builder here.
2115 if platform_name != 'win32':
2116 print 'installer target is only available for windows platform'
2118 if mode != 'release':
2119 print 'installer has to be built in release mode (use option mode=release)'
2121 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2122 % x for x in development_Win32_packaging_installer] + \
2123 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2124 % x for x in development_Win32_packaging_installer_components] + \
2125 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2126 % x for x in development_Win32_packaging_installer_dialogs] + \
2127 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2128 % x for x in development_Win32_packaging_installer_graphics] + \
2129 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2130 % x for x in development_Win32_packaging_installer_include] + \
2131 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2132 % x for x in development_Win32_packaging_installer_lang]
2133 if env.has_key('NSIS') and env['NSIS'] is not None:
2134 # create a builder to strip and install
2135 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2137 print 'No nsis compiler is found. Existing...'
2139 if not env.has_key('win_installer') or env['win_installer'] is None:
2141 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2143 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2144 # provide default setting
2145 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2146 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2147 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2148 print 'Development dependency package is not found.'
2151 env['deps_dir'] = env.Dir('$deps_dir').abspath
2153 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2154 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2155 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2156 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2158 env['bundle_dir'] = None
2159 # if absolute path is given, use it, otherwise, write to current directory
2160 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2161 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2162 env.Append(NSISDEFINES={
2163 'ExeFile':env['win_installer'],
2164 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2165 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2166 'FilesDeps':env['deps_dir'],
2167 'FilesBundle':env['bundle_dir'],
2169 installer = env.installer(env['win_installer'],
2170 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2171 # since I can not use a scanner, explicit dependent is required
2172 env.Depends(installer, 'install')
2173 env.Depends(installer, installer_files)
2174 env.Alias('installer', installer)
2175 # also generate bundle?
2176 if env.has_key('bundle') and env['bundle']:
2177 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2178 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2179 print 'Use bundle_dir option to specify'
2181 # generator of the builder will add bundle stuff depending on output name
2182 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2183 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2184 env.Depends(bundle_installer, 'install')
2185 env.Depends(bundle_installer, installer_files)
2186 env.Alias('installer', bundle_installer)
2189 Alias('all', ['lyx', 'client', 'tex2lyx'])