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 # scons asks for 1.5.2, lyx requires 2.3
40 EnsurePythonVersion(2, 3)
41 # Please use at least 0.96.92 (not 0.96.1)
42 EnsureSConsVersion(0, 96)
43 # also check for minor version number for scons 0.96
44 from SCons import __version__
45 # allow the use of snapshot version of scons
46 __version__ = __version__.split('d')[0]
47 version = map(int, __version__.split('.'))
48 if version[0] == 0 and version[1] == 96 and version[2] < 92:
49 print "Scons >= 0.96.92 is required."
53 #----------------------------------------------------------
55 #----------------------------------------------------------
57 # some global settings
59 # get version number from configure.ac so that JMarc does
60 # not have to change SConstruct during lyx release
61 package_version, lyx_date = utils.getVerFromConfigure(top_src_dir)
62 package_cygwin_version = '%s-1' % package_version
63 boost_version = ['1_34']
65 if 'svn' in package_version:
67 default_build_mode = 'debug'
70 default_build_mode = 'release'
73 package_bugreport = 'lyx-devel@lists.lyx.org'
75 package_tarname = 'lyx'
76 package_string = '%s %s' % (package_name, package_version)
78 # various cache/log files
79 default_log_file = 'scons_lyx.log'
80 opt_cache_file = 'opt.cache'
83 #----------------------------------------------------------
84 # platform dependent settings
85 #----------------------------------------------------------
88 platform_name = 'win32'
89 default_prefix = 'c:/program files/lyx'
90 default_with_x = False
91 default_packaging_method = 'windows'
92 elif os.name == 'posix' and sys.platform != 'cygwin':
93 platform_name = sys.platform
94 default_prefix = '/usr/local'
96 default_packaging_method = 'posix'
97 elif os.name == 'posix' and sys.platform == 'cygwin':
98 platform_name = 'cygwin'
99 default_prefix = '/usr'
100 default_with_x = True
101 default_packaging_method = 'posix'
102 elif os.name == 'darwin':
103 platform_name = 'macosx'
104 # FIXME: macOSX default prefix?
106 default_with_x = False
107 default_packaging_method = 'macosx'
108 else: # unsupported system, assume posix behavior
109 platform_name = 'others'
111 default_with_x = True
112 default_packaging_method = 'posix'
114 #---------------------------------------------------------
116 #----------------------------------------------------------
118 # You can set perminant default values in config.py
119 if os.path.isfile('config.py'):
120 print "Getting options from config.py..."
121 print open('config.py').read()
123 opts = Options(['config.py'])
126 EnumOption('frontend', 'Main GUI', 'qt4',
127 allowed_values = ('qt4',) ),
128 # debug or release build
129 EnumOption('mode', 'Building method', default_build_mode,
130 allowed_values = ('debug', 'release') ),
133 'Use included, system boost library, or try sytem boost first.',
134 'auto', allowed_values = (
135 'auto', # detect boost, if not found, use included
136 'included', # always use included boost
137 'system', # always use system boost, fail if can not find
140 EnumOption('gettext',
141 'Use included, system gettext library, or try sytem gettext first',
142 'auto', allowed_values = (
143 'auto', # detect gettext, if not found, use included
144 'included', # always use included gettext
145 'system', # always use system gettext, fail if can not find
148 EnumOption('spell', 'Choose spell checker to use.', 'auto',
149 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
151 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
152 allowed_values = ('windows', 'posix', 'macosx')),
154 BoolOption('fast_start', 'This option is obsolete.', False),
155 # No precompiled header support (too troublesome to make it work for msvc)
156 # BoolOption('pch', 'Whether or not use pch', False),
157 # enable assertion, (config.h has ENABLE_ASSERTIOS
158 BoolOption('assertions', 'Use assertions', True),
159 # config.h define _GLIBCXX_CONCEPT_CHECKS
160 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
161 BoolOption('concept_checks', 'Enable concept checks', True),
163 BoolOption('nls', 'Whether or not use native language support', True),
165 BoolOption('profiling', 'Whether or not enable profiling', False),
166 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
167 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
169 BoolOption('X11', 'Use x11 windows system', default_with_x),
170 # use MS VC++ to build lyx
171 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
173 PathOption('qt_dir', 'Path to qt directory', None),
175 PathOption('qt_inc_path', 'Path to qt include directory', None),
177 PathOption('qt_lib_path', 'Path to qt library directory', None),
178 # extra include and libpath
179 PathOption('extra_inc_path', 'Extra include path', None),
181 PathOption('extra_lib_path', 'Extra library path', None),
183 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
185 PathOption('extra_inc_path1', 'Extra include path', None),
187 PathOption('extra_lib_path1', 'Extra library path', None),
189 ('rebuild', 'Obsolete option', 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 if env.has_key('build_dir') and env['build_dir'] is not None:
336 env['BUILDDIR'] = env['build_dir']
338 # Determine the name of the build $mode
339 env['BUILDDIR'] = '#' + mode
341 # all built libraries will go to build_dir/libs
342 # (This is different from the make file approach)
343 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
344 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
347 # Here is a summary of variables defined in env
349 # 2. undefined options with a non-None default value
350 # 3. compiler commands and flags like CCFLAGS.
351 # MSGFMT used to process po files
352 # 4. Variables that will be used to replace variables in some_file.in
353 # lib/lyx2lyx/lyx2lyx_version.py.in
356 # full path name is used to build msvs project files
357 # and to replace TOP_SRCDIR in package.C
358 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
360 # determine share_dir etc
361 packaging_method = env.get('packaging')
362 if packaging_method == 'windows':
363 share_dir = 'Resources'
364 man_dir = 'Resources/man/man1'
365 locale_dir = 'Resources/locale'
367 share_dir = 'share/lyx'
368 locale_dir = 'share/locale'
369 if platform_name == 'cygwin':
370 man_dir = 'share/man/man1'
374 # program suffix: can be yes, or a string
375 if env.has_key('version_suffix'):
376 if env['version_suffix'] in true_strings:
377 program_suffix = package_version
378 elif env['version_suffix'] in false_strings:
381 program_suffix = env['version_suffix']
386 # whether or not add suffix to file and directory names
387 add_suffix = packaging_method != 'windows'
388 # LYX_DIR are different (used in Package.cpp.in)
390 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
392 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
393 # we need absolute path for package.C
394 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
397 #---------------------------------------------------------
398 # Setting building environment (Tools, compiler flags etc)
399 #---------------------------------------------------------
401 # Since Tool('mingw') will reset CCFLAGS etc, this should be
402 # done before getEnvVariable
403 if platform_name == 'win32':
409 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
410 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
412 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
415 # we differentiate between hard-coded options and default options
416 # hard-coded options are required and will always be there
417 # default options can be replaced by enviromental variables or command line options
418 CCFLAGS_required = []
419 LINKFLAGS_required = []
422 # if we use ms vc, the commands are fine (cl.exe and link.exe)
424 # C4819: The file contains a character that cannot be represented
425 # in the current code page (number)
426 # C4996: foo was decleared deprecated
427 CCFLAGS_required.append('/EHsc')
429 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
431 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
433 # for debug/release mode
434 if env.has_key('optimization') and env['optimization'] is not None:
435 # if user supplies optimization flags, use it anyway
436 CCFLAGS_required.extend(env['optimization'].split())
437 # and do not use default
438 set_default_optimization_flags = False
440 set_default_optimization_flags = True
444 CCFLAGS_required.append('/Zi')
445 LINKFLAGS_required.extend(['/debug', '/map'])
447 CCFLAGS_required.append('-g')
448 CCFLAGS_default.append('-O')
449 elif mode == 'release' and set_default_optimization_flags:
451 CCFLAGS_default.append('/O2')
453 CCFLAGS_default.append('-O2')
455 # msvc uses separate tools for profiling
456 if env.has_key('profiling') and env['profiling']:
458 print 'Visual C++ does not use profiling options'
460 CCFLAGS_required.append('-pg')
461 LINKFLAGS_required.append('-pg')
463 if env.has_key('warnings') and env['warnings']:
465 CCFLAGS_default.append('/W2')
467 # Note: autotools detect gxx version and pass -W for 3.x
468 # and -Wextra for other versions of gcc
469 CCFLAGS_default.append('-Wall')
471 # Now, set the variables as follows:
472 # 1. if command line option exists: replace default
473 # 2. then if s envronment variable exists: replace default
474 # 3. set variable to required + default
475 def setEnvVariable(env, name, required = None, default = None, split = True):
476 ''' env: environment to set variable
478 required: hardcoded options
479 default: default options that can be replaced by command line or
480 environment variables
481 split: whether or not split obtained variable like '-02 -g'
483 # 1. ARGUMENTS is already set to env[name], override default.
484 if ARGUMENTS.has_key(name):
485 # env[name] may be rewritten when building tools are reloaded
486 # if that is the case, commandline option will override it.
487 env[name] = ARGUMENTS[name]
489 # then use environment default
490 elif os.environ.has_key(name):
491 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
492 default = os.environ[name]
494 default = default.split()
495 # the real value should be env[name] + default + required
498 if env.has_key(name):
499 value = str(env[name]).split()
500 if required is not None:
502 if default is not None:
506 if env.has_key(name):
507 value = str(env[name])
508 if required is not None:
509 value += " " + required
510 if default is not None:
511 value += " " + default
513 # print name, env[name]
515 setEnvVariable(env, 'DESTDIR', split=False)
516 setEnvVariable(env, 'CC')
517 setEnvVariable(env, 'LINK')
518 setEnvVariable(env, 'CPP')
519 setEnvVariable(env, 'CXX')
520 setEnvVariable(env, 'CXXCPP')
521 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
522 setEnvVariable(env, 'CXXFLAGS')
523 setEnvVariable(env, 'CPPFLAGS')
524 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
526 # if DESTDIR is not set...
527 if env.has_key('dest_dir'):
528 print "This option is obsolete. Please use DESTDIR instead."
529 env['DESTDIR'] = env['dest_dir']
532 # extra_inc_path and extra_lib_path
535 if env.has_key('extra_inc_path') and env['extra_inc_path']:
536 extra_inc_paths.append(env['extra_inc_path'])
537 if env.has_key('extra_lib_path') and env['extra_lib_path']:
538 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
539 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
540 extra_inc_paths.append(env['extra_inc_path1'])
541 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
542 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
543 if env.has_key('extra_bin_path') and env['extra_bin_path']:
544 # only the first one is needed (a scons bug?)
545 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
546 env.PrependENVPath('PATH', env['extra_bin_path'])
547 # extra_inc_paths will be used later by intlenv etc
548 env.AppendUnique(CPPPATH = extra_inc_paths)
551 #----------------------------------------------------------
553 #----------------------------------------------------------
555 conf = Configure(env,
557 'CheckPkgConfig' : utils.checkPkgConfig,
558 'CheckPackage' : utils.checkPackage,
559 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
560 'CheckSelectArgType' : utils.checkSelectArgType,
561 'CheckBoostLibraries' : utils.checkBoostLibraries,
562 'CheckCommand' : utils.checkCommand,
563 'CheckNSIS' : utils.checkNSIS,
564 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
565 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
566 'CheckIconvConst' : utils.checkIconvConst,
567 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
568 'CheckDeclaration' : utils.checkDeclaration,
572 # When using msvc, windows.h is required
573 if use_vc and not conf.CheckCHeader('windows.h'):
574 print 'Windows.h is not found. Please install Windows Platform SDK.'
575 print 'Please check config.log for more information.'
578 # pkg-config? (if not, we use hard-coded options)
579 if conf.CheckPkgConfig('0.15.0'):
580 env['HAS_PKG_CONFIG'] = True
582 print 'pkg-config >= 0.1.50 is not found'
583 env['HAS_PKG_CONFIG'] = False
585 # zlib? This is required.
586 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
587 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
588 print 'Did not find zdll.lib or zlib.h, exiting!'
589 print 'Please check config.log for more information.'
591 if conf.CheckLib('iconv'):
592 env['ICONV_LIB'] = 'iconv'
593 elif conf.CheckLib('libiconv'):
594 env['ICONV_LIB'] = 'libiconv'
595 elif conf.CheckFunc('iconv_open'):
596 env['ICONV_LIB'] = None
598 print 'Did not find iconv or libiconv, exiting!'
599 print 'Please check config.log for more information.'
604 if conf.CheckLib('socket'):
605 socket_libs.append('socket')
606 # nsl is the network services library and provides a
607 # transport-level interface to networking services.
608 if conf.CheckLib('nsl'):
609 socket_libs.append('nsl')
611 # check available boost libs (since lyx1.4 does not use iostream)
613 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
614 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
615 boost_libs.append(lib)
617 # check boost libraries
618 boost_opt = ARGUMENTS.get('boost', 'auto')
619 # check for system boost
620 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
621 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
622 # default to $BUILDDIR/libs (use None since this path will be added anyway)
624 # here I assume that all libraries are in the same directory
625 if boost_opt == 'included':
626 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
627 included_boost = True
628 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
629 elif boost_opt == 'auto':
630 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
631 # if not found, use local boost
633 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
634 included_boost = True
635 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
637 included_boost = False
638 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
639 elif boost_opt == 'system':
640 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
642 print "Can not find system boost libraries with version %s " % boost_version
643 print "Please supply a path through extra_lib_path and try again."
644 print "Or use boost=included to use included boost libraries."
647 included_boost = False
648 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
651 if boost_libpath is not None:
652 env.AppendUnique(LIBPATH = [boost_libpath])
655 env['ENABLE_NLS'] = env['nls']
657 if not env['ENABLE_NLS']:
659 included_gettext = False
661 # check gettext libraries
662 gettext_opt = ARGUMENTS.get('gettext', 'auto')
663 # check for system gettext
665 if gettext_opt in ['auto', 'system']:
666 if conf.CheckFunc('gettext'):
667 included_gettext = False
670 elif conf.CheckLib('intl'):
671 included_gettext = False
675 if gettext_opt == 'system':
676 print "Can not find system gettext library"
677 print "Please supply a path through extra_lib_path and try again."
678 print "Or use gettext=included to use included gettext libraries."
680 # now, auto and succ = false, or gettext=included
682 # we do not need to set LIBPATH now.
683 included_gettext = True
684 intl_libs = ['included_intl']
688 # check for msgfmt command
689 env['MSGFMT'] = conf.CheckCommand('msgfmt')
690 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
691 env['XGETTEXT'] = conf.CheckCommand('xgettext')
692 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
694 # if under windows, check the nsis compiler
695 if platform_name == 'win32':
696 env['NSIS'] = conf.CheckNSIS()
698 # cygwin packaging requires the binaries to be stripped
699 if platform_name == 'cygwin':
700 env['STRIP'] = conf.CheckCommand('strip')
703 # Customized builders
705 # install customized builders
706 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
707 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
708 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
711 #----------------------------------------------------------
712 # Generating config.h
713 #----------------------------------------------------------
714 aspell_lib = 'aspell'
715 # assume that we use aspell, aspelld compiled for msvc
716 if platform_name == 'win32' and mode == 'debug' and use_vc:
717 aspell_lib = 'aspelld'
719 # check the existence of config.h
720 config_h = os.path.join(env.Dir('$BUILDDIR/src').path, 'config.h')
721 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
723 print "Creating %s..." % boost_config_h
725 utils.createConfigFile(conf,
726 config_file = boost_config_h,
727 config_pre = r'''/* boost/config.h. Generated by SCons. */
732 * This file is part of LyX, the document processor.
733 * Licence details can be found in the file COPYING.
735 * This is the compilation configuration file for LyX.
736 * It was generated by scon.
737 * You might want to change some of the defaults if something goes wrong
738 * during the compilation.
741 #ifndef _BOOST_CONFIG_H
742 #define _BOOST_CONFIG_H
745 ('ostream', 'HAVE_OSTREAM', 'cxx'),
746 ('locale', 'HAVE_LOCALE', 'cxx'),
747 ('sstream', 'HAVE_SSTREAM', 'cxx'),
748 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
751 (env.has_key('assertions') and env['assertions'],
753 'Define if you want assertions to be enabled in the code'
757 ('wchar_t', 'HAVE_WCHAR_T', None),
761 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
762 # define USE_BOOST_FORMAT 1
764 # define USE_BOOST_FORMAT 0
767 #if !defined(ENABLE_ASSERTIONS)
768 # define BOOST_DISABLE_ASSERTS 1
770 #define BOOST_ENABLE_ASSERT_HANDLER 1
772 #define BOOST_DISABLE_THREADS 1
773 #define BOOST_NO_WSTRING 1
776 # define BOOST_POSIX 1
777 # define BOOST_POSIX_API 1
778 # define BOOST_POSIX_PATH 1
781 #define BOOST_ALL_NO_LIB 1
783 #if defined(HAVE_NEWAPIS_H)
784 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
788 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
789 * support compiled in:
790 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
791 * And we are not interested at all what libc
792 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
793 * has the needed wchar_t support and uses UCS4. Whether it
794 * implements this with the help of libc, or whether it has own code
795 * does not matter for us, because we don't use libc directly (Georg)
797 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
805 print "\nGenerating %s..." % config_h
807 # AIKSAURUS_H_LOCATION
808 if (conf.CheckCXXHeader("Aiksaurus.h")):
809 aik_location = '<Aiksaurus.h>'
810 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
811 aik_location = '<Aiksaurus/Aiksaurus.h>'
815 # determine headers to use
816 spell_opt = ARGUMENTS.get('spell', 'auto')
817 env['USE_ASPELL'] = False
818 env['USE_PSPELL'] = False
819 env['USE_ISPELL'] = False
820 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
821 spell_engine = 'USE_ASPELL'
822 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
823 spell_engine = 'USE_PSPELL'
824 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
825 spell_engine = 'USE_ISPELL'
829 if spell_engine is not None:
830 env[spell_engine] = True
832 if spell_opt == 'auto':
833 print "Warning: Can not locate any spell checker"
834 elif spell_opt != 'no':
835 print "Warning: Can not locate specified spell checker:", spell_opt
836 print 'Please check config.log for more information.'
839 # check arg types of select function
840 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
842 # check the size of wchar_t
843 sizeof_wchar_t = conf.CheckSizeOfWChar()
845 if sizeof_wchar_t == 0:
846 print 'Error: Can not determine the size of wchar_t.'
847 print 'Please check config.log for more information.'
851 # fill in the version info
852 env['VERSION_INFO'] = '''Configuration
854 Special build flags: %s
856 C Compiler flags: %s %s
858 C++ Compiler LyX flags: %s
859 C++ Compiler flags: %s %s
861 Linker user flags: %s
863 Builing directory: %s
866 include search path: %s
872 ''' % (platform_name,
873 env.subst('$CCFLAGS'), env.subst('$CC'),
874 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
875 env.subst('$CXX'), env.subst('$CXXFLAGS'),
876 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
877 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
878 env.subst('$LOCALLIBPATH'),
879 env.subst('$LIBPATH'), str(boost_libraries),
880 env.subst('$CPPPATH'),
881 frontend, packaging_method,
882 prefix, env['LYX_DIR'])
886 result = utils.createConfigFile(conf,
887 config_file = config_h,
888 config_pre = r'''/* config.h. Generated by SCons. */
893 * This file is part of LyX, the document processor.
894 * Licence details can be found in the file COPYING.
896 * This is the compilation configuration file for LyX.
897 * It was generated by scon.
898 * You might want to change some of the defaults if something goes wrong
899 * during the compilation.
906 ('io.h', 'HAVE_IO_H', 'c'),
907 ('limits.h', 'HAVE_LIMITS_H', 'c'),
908 ('locale.h', 'HAVE_LOCALE_H', 'c'),
909 ('process.h', 'HAVE_PROCESS_H', 'c'),
910 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
911 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
912 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
913 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
914 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
915 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
916 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
917 ('utime.h', 'HAVE_UTIME_H', 'c'),
918 ('direct.h', 'HAVE_DIRECT_H', 'c'),
919 ('istream', 'HAVE_ISTREAM', 'cxx'),
920 ('ios', 'HAVE_IOS', 'cxx'),
923 ('open', 'HAVE_OPEN', None),
924 ('chmod', 'HAVE_CHMOD', None),
925 ('close', 'HAVE_CLOSE', None),
926 ('popen', 'HAVE_POPEN', None),
927 ('pclose', 'HAVE_PCLOSE', None),
928 ('_open', 'HAVE__OPEN', None),
929 ('_close', 'HAVE__CLOSE', None),
930 ('_popen', 'HAVE__POPEN', None),
931 ('_pclose', 'HAVE__PCLOSE', None),
932 ('getpid', 'HAVE_GETPID', None),
933 ('_getpid', 'HAVE__GETPID', None),
934 ('mkdir', 'HAVE_MKDIR', None),
935 ('_mkdir', 'HAVE__MKDIR', None),
936 ('mktemp', 'HAVE_MKTEMP', None),
937 ('mkstemp', 'HAVE_MKSTEMP', None),
938 ('strerror', 'HAVE_STRERROR', None),
939 ('getcwd', 'HAVE_GETCWD', None),
940 ('setenv', 'HAVE_SETENV', None),
941 ('putenv', 'HAVE_PUTENV', None),
942 ('fcntl', 'HAVE_FCNTL', None),
943 ('mkfifo', 'HAVE_MKFIFO', None),
946 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
949 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
950 '#include <streambuf>\n#include <istream>'),
951 ('wchar_t', 'HAVE_WCHAR_T', None),
952 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
955 ('gdi32', 'HAVE_LIBGDI32'),
956 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
959 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
961 'Define is sys/types.h does not have pid_t',
965 (conf.CheckCXXGlobalCstd(),
967 'Define if your C++ compiler puts C library functions in the global namespace'
969 (conf.CheckMkdirOneArg(),
970 'MKDIR_TAKES_ONE_ARG',
971 'Define if mkdir takes only one argument.'
973 (conf.CheckIconvConst(),
975 'Define as const if the declaration of iconv() needs const.',
976 '#define ICONV_CONST const',
977 '#define ICONV_CONST',
979 (conf.CheckLC_MESSAGES(),
981 'Define if your <locale.h> file defines LC_MESSAGES.'
983 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
986 "Define to 1 if translation of program messages to the user's native anguage is requested.",
988 (env['nls'] and not included_gettext,
990 'Define to 1 if using system gettext library'
992 (env.has_key('concept_checks') and env['concept_checks'],
993 '_GLIBCXX_CONCEPT_CHECKS',
994 'libstdc++ concept checking'
996 (env.has_key('stdlib_debug') and env['stdlib_debug'],
998 'libstdc++ debug mode'
1000 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1001 '_GLIBCXX_DEBUG_PEDANTIC',
1002 'libstdc++ pedantic debug mode'
1004 (os.name != 'nt', 'BOOST_POSIX',
1005 'Indicates to boost < 1.34 which API to use (posix or windows).'
1007 (os.name != 'nt', 'BOOST_POSIX_API',
1008 'Indicates to boost 1.34 which API to use (posix or windows).'
1010 (os.name != 'nt', 'BOOST_POSIX_PATH',
1011 'Indicates to boost 1.34 which path style to use (posix or windows).'
1013 (spell_engine is not None, spell_engine,
1014 'Spell engine to use'
1016 # we need to know the byte order for unicode conversions
1017 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1018 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1022 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1024 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1025 'Define to the address where bug reports for this package should be sent.'),
1026 ('#define PACKAGE_NAME "%s"' % package_name,
1027 'Define to the full name of this package.'),
1028 ('#define PACKAGE_STRING "%s"' % package_string,
1029 'Define to the full name and version of this package.'),
1030 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1031 'Define to the one symbol short name of this package.'),
1032 ('#define PACKAGE_VERSION "%s"' % package_version,
1033 'Define to the version of this package.'),
1034 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1035 'Full version info'),
1036 ('#define LYX_DATE "%s"' % lyx_date,
1038 ('#define PROGRAM_SUFFIX "%s"' % program_suffix,
1039 'Program version suffix'),
1040 ('#define LYX_ABS_INSTALLED_DATADIR "%s"' % env.subst('$LYX_DIR'),
1041 'Hard coded system support directory'),
1042 ('#define LYX_ABS_INSTALLED_LOCALEDIR "%s"' % env.subst('$LOCALEDIR'),
1043 'Hard coded locale directory'),
1044 ('#define LYX_ABS_TOP_SRCDIR "%s"' % env.subst('$TOP_SRCDIR'),
1045 'Top source directory'),
1046 ('#define BOOST_ALL_NO_LIB 1',
1047 'disable automatic linking of boost libraries.'),
1048 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1049 'Packaging method'),
1050 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1051 'Aiksaurus include file'),
1052 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1053 "Define to the type of arg 1 for `select'."),
1054 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1055 "Define to the type of arg 2, 3, 4 for `select'."),
1056 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1057 "Define to the type of arg 5 for `select'."),
1058 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1059 'Define to be the size of type wchar_t'),
1061 config_post = '''/************************************************************
1062 ** You should not need to change anything beyond this point */
1064 #ifndef HAVE_STRERROR
1065 #if defined(__cplusplus)
1068 char * strerror(int n);
1071 #include <../boost/config.h>
1077 # these keys are needed in env
1078 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1079 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1080 # USE_ASPELL etc does not go through result
1081 if result.has_key(key):
1082 env[key] = result[key]
1085 # if nls=yes and gettext=included, create intl/config.h
1086 # intl/libintl.h etc
1088 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1089 if env['nls'] and included_gettext:
1091 print "Creating %s..." % intl_config_h
1093 # create intl/config.h
1094 result = utils.createConfigFile(conf,
1095 config_file = intl_config_h,
1096 config_pre = r'''/* intl/config.h. Generated by SCons. */
1101 * This file is part of LyX, the document processor.
1102 * Licence details can be found in the file COPYING.
1104 * This is the compilation configuration file for LyX.
1105 * It was generated by scon.
1106 * You might want to change some of the defaults if something goes wrong
1107 * during the compilation.
1110 #ifndef _INTL_CONFIG_H
1111 #define _INTL_CONFIG_H
1114 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1115 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1116 ('string.h', 'HAVE_STRING_H', 'c'),
1117 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1118 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1119 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1120 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1121 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1122 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1123 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1126 ('getcwd', 'HAVE_GETCWD', None),
1127 ('stpcpy', 'HAVE_STPCPY', None),
1128 ('strcasecmp', 'HAVE_STRCASECMP', None),
1129 ('strdup', 'HAVE_STRDUP', None),
1130 ('strtoul', 'HAVE_STRTOUL', None),
1131 ('alloca', 'HAVE_ALLOCA', None),
1132 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1133 ('mempcpy', 'HAVE_MEMPCPY', None),
1134 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1135 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1136 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1137 ('setlocale', 'HAVE_SETLOCALE', None),
1138 ('tsearch', 'HAVE_TSEARCH', None),
1139 ('getegid', 'HAVE_GETEGID', None),
1140 ('getgid', 'HAVE_GETGID', None),
1141 ('getuid', 'HAVE_GETUID', None),
1142 ('wcslen', 'HAVE_WCSLEN', None),
1143 ('asprintf', 'HAVE_ASPRINTF', None),
1144 ('wprintf', 'HAVE_WPRINTF', None),
1145 ('snprintf', 'HAVE_SNPRINTF', None),
1146 ('printf', 'HAVE_POSIX_PRINTF', None),
1147 ('fcntl', 'HAVE_FCNTL', None),
1150 ('intmax_t', 'HAVE_INTMAX_T', None),
1151 ('long double', 'HAVE_LONG_DOUBLE', None),
1152 ('long long', 'HAVE_LONG_LONG', None),
1153 ('wchar_t', 'HAVE_WCHAR_T', None),
1154 ('wint_t', 'HAVE_WINT_T', None),
1155 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1156 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1162 (conf.CheckLC_MESSAGES(),
1164 'Define if your <locale.h> file defines LC_MESSAGES.'
1166 (conf.CheckIconvConst(),
1168 'Define as const if the declaration of iconv() needs const.',
1169 '#define ICONV_CONST const',
1170 '#define ICONV_CONST',
1172 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1173 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1175 "Define to 1 if you have the `intmax_t' type."
1177 (env.has_key('nls') and env['nls'],
1179 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1183 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1184 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1185 'Define to be the size of type wchar_t'),
1187 config_post = '#endif'
1190 # these keys are needed in env
1191 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1192 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1193 # USE_ASPELL etc does not go through result
1194 if result.has_key(key):
1195 env[key] = result[key]
1198 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1199 if env['nls'] and included_gettext:
1200 # libgnuintl.h.in => libintl.h
1201 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1202 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1203 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1204 [Copy('$TARGET', '$SOURCE')])
1207 # Finish auto-configuration
1210 #----------------------------------------------------------
1211 # Now set up our build process accordingly
1212 #----------------------------------------------------------
1214 if env['ICONV_LIB'] is None:
1217 system_libs = [env['ICONV_LIB']]
1218 if platform_name in ['win32', 'cygwin']:
1219 # the final link step needs stdc++ to succeed under mingw
1220 # FIXME: shouldn't g++ automatically link to stdc++?
1222 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1224 system_libs += ['shlwapi', 'stdc++', 'z']
1225 elif platform_name == 'cygwin' and env['X11']:
1226 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1227 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1228 'resolv', 'pthread', 'z']
1230 system_libs += ['z']
1233 ('HAVE_LIBGDI32', 'gdi32'),
1234 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1235 ('USE_ASPELL', aspell_lib),
1236 ('USE_ISPELL', 'ispell'),
1237 ('USE_PSPELL', 'pspell'),
1242 system_libs.append(lib[1])
1245 # Build parameters CPPPATH etc
1248 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1251 # boost: for boost header files
1252 # BUILDDIR/src: for config.h
1253 # TOP_SRCDIR/src: for support/* etc
1255 env['CPPPATH'] += ['$BUILDDIR/src', '$TOP_SRCDIR/src']
1257 # Separating boost directories from CPPPATH stops scons from building
1258 # the dependency tree for boost header files, and effectively reduce
1259 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1260 # boost headers, the following is not 100% safe.
1261 # env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1262 env.PrependUnique(CCFLAGS = ['$INCPREFIX$BOOST_INC_PATH'])
1264 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1265 if env['nls'] and included_gettext:
1266 env['CPPPATH'].append('$BUILDDIR/intl')
1270 # A Link script for cygwin see
1271 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1272 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1275 if platform_name == 'cygwin':
1276 ld_script_path = '/tmp'
1277 ld_script = utils.installCygwinLDScript(ld_script_path)
1278 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1279 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1282 #---------------------------------------------------------
1283 # Frontend related variables (QTDIR etc)
1284 #---------------------------------------------------------
1287 # create a separate environment so that other files do not have
1288 # to be built with all the include directories etc
1290 if frontend == 'qt4':
1291 frontend_env = env.Copy()
1293 # handle qt related user specified paths
1294 # set environment so that moc etc can be found even if its path is not set properly
1295 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1296 frontend_env['QTDIR'] = frontend_env['qt_dir']
1297 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1298 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1299 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1300 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1301 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1303 # if separate qt_lib_path is given
1304 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1305 qt_lib_path = frontend_env.subst('$qt_lib_path')
1306 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1307 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1311 # if separate qt_inc_path is given
1312 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1313 qt_inc_path = frontend_env['qt_inc_path']
1317 # local qt4 toolset from
1318 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1320 # NOTE: I have to patch qt4.py since it does not automatically
1321 # process .C file!!! (add to cxx_suffixes )
1323 frontend_env.Tool('qt4', [scons_dir])
1324 frontend_env['QT_AUTOSCAN'] = 0
1325 frontend_env['QT4_AUTOSCAN'] = 0
1326 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1328 if qt_lib_path is None:
1329 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1330 if qt_inc_path is None:
1331 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1334 conf = Configure(frontend_env,
1336 'CheckPackage' : utils.checkPackage,
1337 'CheckCommand' : utils.checkCommand,
1342 # first: try pkg_config
1343 if frontend_env['HAS_PKG_CONFIG']:
1344 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1345 # FIXME: use pkg_config information?
1346 #frontend_env['QT4_PKG_CONFIG'] = succ
1347 # second: try to link to it
1349 # Under linux, I can test the following perfectly
1350 # Under windows, lib names need to passed as libXXX4.a ...
1351 if platform_name == 'win32':
1352 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1354 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1355 # still can not find it
1357 print 'Did not find qt libraries, exiting!'
1358 print 'Please check config.log for more information.'
1361 # Now, determine the correct suffix:
1362 qt_libs = ['QtCore', 'QtGui']
1363 if platform_name == 'win32':
1364 if mode == 'debug' and use_vc and \
1365 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1366 qt_lib_suffix = 'd4'
1367 use_qt_debug_libs = True
1370 use_qt_debug_libs = False
1372 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1373 qt_lib_suffix = '_debug'
1374 use_qt_debug_libs = True
1377 use_qt_debug_libs = False
1378 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1379 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1380 qtcore_lib = ['QtCore' + qt_lib_suffix]
1382 # check uic and moc commands for qt frontends
1383 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1384 print 'uic or moc command is not found for frontend', frontend
1387 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1388 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1389 # For some unknown changes in msvc or qt, this is no longer needed.
1391 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1392 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1393 env.File('$BUILDDIR/lyx.exe.manifest').path]
1395 frontend_env = conf.Finish()
1400 print env['VERSION_INFO']
1403 # Mingw command line may be too short for our link usage,
1404 # Here we use a trick from scons wiki
1405 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1407 # I also would like to add logging (commands only) capacity to the
1409 logfile = env.get('logfile', default_log_file)
1410 if logfile != '' or platform_name == 'win32':
1412 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1413 info = '''# This is a log of commands used by scons to build lyx
1417 ''' % (time.asctime(), ' '.join(sys.argv),
1418 env['VERSION_INFO'].replace('\n','\n# ')) )
1423 # -h will print out help info
1424 Help(opts.GenerateHelpText(env))
1427 #----------------------------------------------------------
1429 #----------------------------------------------------------
1430 # this has been the source of problems on some platforms...
1431 # I find that I need to supply it with full path name
1432 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1433 # this usage needs further investigation.
1434 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1435 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1436 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1437 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1438 frontend_env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1440 print "Building all targets recursively"
1442 def libExists(libname):
1443 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1444 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1447 if (included_boost and not libExists('included_boost_regex')) or 'boost' in BUILD_TARGETS:
1451 for lib in boost_libs:
1452 boostlib = env.StaticLibrary(
1453 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1454 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)],
1455 # do not use global CPPPATH because src/config.h will mess up with boost/config.h
1456 CPPPATH = ['$BUILDDIR/boost'] + extra_inc_paths,
1457 CCFLAGS = ['$CCFLAGS', '$INCPREFIX$TOP_SRCDIR/boost', '-DBOOST_USER_CONFIG="<config.h>"']
1459 Alias('boost', boostlib)
1462 if (included_gettext and not libExists('included_intl')) or 'intl' in BUILD_TARGETS:
1467 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1468 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1469 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1471 '-DENABLE_RELOCATABLE=1',
1473 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1475 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1476 '-Drelocate=libintl_relocate',
1477 '-DDEPENDS_ON_LIBICONV=1',
1481 INTL_CCFLAGS.extend(['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1483 intl = env.StaticLibrary(
1484 target = '$LOCALLIBPATH/included_intl',
1486 CCFLAGS = INTL_CCFLAGS,
1487 # do not use global CPPPATH because src/config.h will mess up with intl/config.h
1488 CPPPATH = ['$BUILDDIR/intl'] + extra_inc_paths,
1489 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1496 support = frontend_env.StaticLibrary(
1497 target = '$LOCALLIBPATH/support',
1498 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files] + \
1499 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_files],
1503 '-DQT_CLEAN_NAMESPACE',
1508 CPPPATH = ['$CPPPATH', '$TOP_SRCDIR/src/support/minizip']
1510 Alias('support', support)
1516 mathed = env.StaticLibrary(
1517 target = '$LOCALLIBPATH/mathed',
1518 source = ['$BUILDDIR/src/mathed/%s' % x for x in src_mathed_files]
1520 Alias('mathed', mathed)
1526 insets = env.StaticLibrary(
1527 target = '$LOCALLIBPATH/insets',
1528 source = ['$BUILDDIR/src/insets/%s' % x for x in src_insets_files]
1530 Alias('insets', insets)
1536 frontends = env.StaticLibrary(
1537 target = '$LOCALLIBPATH/frontends',
1538 source = ['$BUILDDIR/src/frontends/%s' % x for x in src_frontends_files]
1540 Alias('frontends', frontends)
1546 graphics = env.StaticLibrary(
1547 target = '$LOCALLIBPATH/graphics',
1548 source = ['$BUILDDIR/src/graphics/%s' % x for x in src_graphics_files]
1550 Alias('graphics', graphics)
1554 # src/frontends/controllers
1556 controllers = env.StaticLibrary(
1557 target = '$LOCALLIBPATH/controllers',
1558 source = ['$BUILDDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1560 Alias('controllers', controllers)
1566 frontend_env['QT4_MOCHPREFIX'] = ''
1567 frontend_env['QT4_MOCHSUFFIX'] = '_moc.cpp'
1569 # tells scons how to get these moced files, although not all moced files are needed
1570 # (or are actually generated).
1571 qt4_moced_files = [frontend_env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1572 for x in src_frontends_qt4_header_files ]
1573 resources = [frontend_env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1574 for x in src_frontends_qt4_ui_files]
1577 # moc qt4_moc_files, the moced files are included in the original files
1579 qt4 = frontend_env.StaticLibrary(
1580 target = '$LOCALLIBPATH/qt4',
1581 source = ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1585 '$BUILDDIR/src/images',
1586 '$BUILDDIR/src/frontends',
1587 '$BUILDDIR/src/frontends/qt4',
1588 '$BUILDDIR/src/frontends/qt4/ui',
1589 '$BUILDDIR/src/frontends/controllers'
1594 '-DQT_CLEAN_NAMESPACE',
1606 if env['HAVE_FCNTL']:
1607 client = frontend_env.Program(
1608 target = '$BUILDDIR/src/client/lyxclient',
1609 LIBS = ['support'] + intl_libs + system_libs +
1610 socket_libs + boost_libraries + qtcore_lib,
1611 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1612 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1614 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1615 client, [Copy('$TARGET', '$SOURCE')]))
1618 Alias('client', client)
1624 for file in src_tex2lyx_copied_files:
1625 frontend_env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1626 [Copy('$TARGET', '$SOURCE')])
1628 tex2lyx = frontend_env.Program(
1629 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1630 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1631 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1632 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1633 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$CPPPATH'],
1634 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1635 CCFLAGS = ['$CCFLAGS', '-DTEX2LYX'],
1637 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1638 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1639 Alias('tex2lyx', tex2lyx)
1645 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1646 src_post_files.append('ASpell.cpp')
1647 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1648 src_post_files.append('PSpell.cpp')
1649 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1650 src_post_files.append('ISpell.cpp')
1652 # msvc requires at least one source file with main()
1653 # so I exclude main.cpp from lyxbase
1654 lyxbase_pre = env.StaticLibrary(
1655 target = '$LOCALLIBPATH/lyxbase_pre',
1656 source = ['$BUILDDIR/src/%s' % x for x in src_pre_files]
1658 lyxbase_post = env.StaticLibrary(
1659 target = '$LOCALLIBPATH/lyxbase_post',
1660 source = ["$BUILDDIR/src/%s" % x for x in src_post_files]
1662 Alias('lyxbase', lyxbase_pre)
1663 Alias('lyxbase', lyxbase_post)
1667 # Build lyx with given frontend
1669 lyx = frontend_env.Program(
1670 target = '$BUILDDIR/lyx',
1671 source = ['$BUILDDIR/src/main.cpp'] + \
1672 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1693 if use_vc and 'msvs_projects' in BUILD_TARGETS:
1694 def build_project(target, full_target = None,
1695 src = [], inc = [], res = []):
1696 ''' build mavs project files
1697 target: alias (correspond to directory name)
1698 full_target: full path/filename of the target
1703 For non-debug-able targets like static libraries, target (alias) is
1704 enough to build the target. For executable targets, msvs need to know
1705 the full path to start debug them.
1708 if full_target is None:
1709 build_target = target
1711 build_target = full_target
1713 proj = env.MSVSProject(
1714 target = target + env['MSVSPROJECTSUFFIX'],
1715 # this allows easy access to header files (along with source)
1716 srcs = [env.subst(x) for x in src + inc],
1717 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1718 localincs = [env.subst(x) for x in inc],
1719 resources = [env.subst(x) for x in res],
1720 buildtarget = build_target,
1724 Alias('msvs_projects', proj)
1726 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1727 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1728 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1730 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1731 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1732 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1734 build_project('lyx',
1735 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1736 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1737 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1738 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1739 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1740 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1741 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1742 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1743 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1744 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1745 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1746 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1747 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1748 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1749 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1750 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1751 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1752 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1755 if 'update_po' in BUILD_TARGETS:
1759 print 'Updating po/*.po files...'
1761 # whether or not update po files
1762 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1763 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1765 # rebuild POTFILES.in
1766 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1767 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1768 src_extra_src_files] + \
1769 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1770 src_support_extra_header_files + src_support_extra_src_files] + \
1771 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1772 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1773 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1774 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1775 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
1776 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
1777 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1778 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1780 Alias('update_po', POTFILES_in)
1781 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
1782 # and combine them to lyx.po
1783 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1784 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1785 env.Command('$BUILDDIR/po/all.po',
1786 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1787 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1788 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1789 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1790 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files + lib_layouts_module_files],
1791 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1792 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1793 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1794 env.Command('$BUILDDIR/po/ui_l10n.pot',
1795 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1796 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1797 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1798 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
1800 ['$MSGUNIQ -o $TARGET $SOURCE',
1801 '''$XGETTEXT --default-domain=${TARGET.base} \
1802 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
1803 --language=C++ --join-existing \
1804 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
1805 --files-from=$TOP_SRCDIR/po/POTFILES.in \
1806 --copyright-holder="LyX Developers" \
1807 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
1809 env.Depends(lyx_po, POTFILES_in)
1810 # copy lyx.po to lyx.pot
1811 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
1812 Copy('$TARGET', '$SOURCE'))
1815 # files to translate
1816 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
1817 # possibly *only* handle these languages
1819 if env.has_key('languages'):
1820 languages = env.make_list(env['languages'])
1821 # merge. if I use lan.po as $TARGET, it will be removed
1822 # before it is merged. In this builder,
1823 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
1824 # and is copied to po/lang.po
1825 env['BUILDERS']['msgmerge'] = Builder(action=[
1826 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
1827 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
1829 # for each po file, generate pot
1830 for po_file in transfiles:
1832 fname = os.path.split(po_file)[1]
1834 country = fname.split('.')[0]
1836 if not languages or country in languages:
1837 # merge po files, the generated lan.po_new file is copied to lan.po file.
1838 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
1839 env.Depends(po, POTFILES_in)
1840 Alias('update_po', po)
1843 # if 'install' is not in the target, do not process this
1844 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
1846 # this part is a bit messy right now. Since scons will provide
1847 # --DESTDIR option soon, at least the dest_dir handling can be
1856 # files to translate
1857 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1858 # possibly *only* handle these languages
1860 if env.has_key('languages'):
1861 languages = env.make_list(env['lanauges'])
1862 # use defulat msgfmt
1864 if not env['MSGFMT']:
1865 print 'msgfmt does not exist. Can not process po files'
1868 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
1870 for f in transfiles:
1872 fname = os.path.split(f)[1]
1874 country = fname.split('.')[0]
1876 if not languages or country in languages:
1877 gmo_files.extend(env.Transfiles(f))
1878 # how to join dest_dir and prefix
1879 def joinPaths(path1, path2):
1880 ''' join path1 and path2, do not use os.path.join because
1881 under window, c:\destdir\d:\program is invalid '''
1883 return os.path.normpath(path2)
1884 # separate drive letter
1885 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
1886 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
1887 return os.path.join(os.path.normpath(path1), path[1:])
1889 # install to dest_dir/prefix
1890 dest_dir = env.get('DESTDIR', '')
1891 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
1892 # create the directory if needed
1893 if not os.path.isdir(dest_prefix_dir):
1895 os.makedirs(dest_prefix_dir)
1898 if not os.path.isdir(dest_prefix_dir):
1899 print 'Can not create directory', dest_prefix_dir
1902 if env.has_key('exec_prefix'):
1903 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
1905 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
1907 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
1909 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
1910 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
1911 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
1912 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
1916 # install executables (lyxclient may be None)
1919 version_suffix = program_suffix
1923 # install lyx, if in release mode, try to strip the binary
1924 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
1925 # create a builder to strip and install
1926 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
1928 # install executables
1929 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
1932 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
1933 target = os.path.join(bin_dest_dir, target_name)
1934 if env['BUILDERS'].has_key('StripInstallAs'):
1935 env.StripInstallAs(target, obj)
1937 env.InstallAs(target, obj)
1938 Alias('install', target)
1942 for (dir,files) in [
1944 ('bind', lib_bind_files),
1945 ('bind/de', lib_bind_de_files),
1946 ('bind/fi', lib_bind_fi_files),
1947 ('bind/pt', lib_bind_pt_files),
1948 ('bind/sv', lib_bind_sv_files),
1949 ('doc', lib_doc_files),
1950 ('doc/biblio', lib_doc_biblio_files),
1951 ('doc/clipart', lib_doc_clipart_files),
1952 ('doc/cs', lib_doc_cs_files),
1953 ('doc/da', lib_doc_da_files),
1954 ('doc/de', lib_doc_de_files),
1955 ('doc/de/clipart', lib_doc_de_clipart_files),
1956 ('doc/es', lib_doc_es_files),
1957 ('doc/es/clipart', lib_doc_es_clipart_files),
1958 ('doc/eu', lib_doc_eu_files),
1959 ('doc/fr', lib_doc_fr_files),
1960 ('doc/he', lib_doc_he_files),
1961 ('doc/hu', lib_doc_hu_files),
1962 ('doc/it', lib_doc_it_files),
1963 ('doc/nl', lib_doc_nl_files),
1964 ('doc/nb', lib_doc_nb_files),
1965 ('doc/pl', lib_doc_pl_files),
1966 ('doc/pt', lib_doc_pt_files),
1967 ('doc/ro', lib_doc_ro_files),
1968 ('doc/ru', lib_doc_ru_files),
1969 ('doc/sk', lib_doc_sk_files),
1970 ('doc/sl', lib_doc_sl_files),
1971 ('doc/sv', lib_doc_sv_files),
1972 ('examples', lib_examples_files),
1973 ('examples/ca', lib_examples_ca_files),
1974 ('examples/cs', lib_examples_cs_files),
1975 ('examples/da', lib_examples_da_files),
1976 ('examples/de', lib_examples_de_files),
1977 ('examples/es', lib_examples_es_files),
1978 ('examples/eu', lib_examples_eu_files),
1979 ('examples/fa', lib_examples_fa_files),
1980 ('examples/fr', lib_examples_fr_files),
1981 ('examples/he', lib_examples_he_files),
1982 ('examples/hu', lib_examples_hu_files),
1983 ('examples/it', lib_examples_it_files),
1984 ('examples/nl', lib_examples_nl_files),
1985 ('examples/pl', lib_examples_pl_files),
1986 ('examples/pt', lib_examples_pt_files),
1987 ('examples/ru', lib_examples_ru_files),
1988 ('examples/sl', lib_examples_sl_files),
1989 ('examples/ro', lib_examples_ro_files),
1990 ('fonts', lib_fonts_files),
1991 ('images', lib_images_files),
1992 ('images/math', lib_images_math_files),
1993 ('kbd', lib_kbd_files),
1994 ('layouts', lib_layouts_files + lib_layouts_inc_files),
1995 ('lyx2lyx', lib_lyx2lyx_files),
1996 ('scripts', lib_scripts_files),
1997 ('templates', lib_templates_files),
1998 ('tex', lib_tex_files),
1999 ('ui', lib_ui_files)]:
2000 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2001 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2002 Alias('install', dirs)
2004 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2005 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
2006 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2007 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2008 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2009 sys.path.append(share_dest_dir + '/lyx2lyx')
2011 # generate TOC files for each doc
2012 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2014 for lang in languages.keys():
2015 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2016 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2019 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2020 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2022 # this is for English
2023 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2026 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2027 Alias('install', tocs)
2029 if platform_name == 'cygwin':
2030 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2031 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2032 '%s-%s.README' % (package, package_cygwin_version))
2033 env.InstallAs(Cygwin_README,
2034 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2035 Alias('install', Cygwin_README)
2036 # also a directory /usr/share/doc/lyx for README etc
2037 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2038 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2039 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2040 Alias('install', Cygwin_Doc)
2041 # cygwin fonts also need to be installed
2042 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2043 env.Install(Cygwin_fonts,
2044 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2045 for file in win32_bakoma_fonts])
2046 Alias('install', Cygwin_fonts)
2047 # we also need a post installation script
2048 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2049 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2050 env.Install(postinstall_path, tmp_script)
2051 Alias('install', postinstall_path)
2053 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2054 env.subst('$TOP_SRCDIR/lyx.man'))
2055 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2056 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2057 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2058 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2059 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2060 x in ['lyx', 'tex2lyx', 'lyxclient']])
2062 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2063 for gmo in gmo_files:
2064 lan = os.path.split(str(gmo))[1].split('.')[0]
2065 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2066 env.InstallAs(dest_file, gmo)
2067 Alias('install', dest_file)
2070 if 'installer' in BUILD_TARGETS:
2072 # build windows installer using NSIS
2075 # There is a nsis builder on scons wiki but it does not work with
2076 # our lyx.nsi because it does not dig through all the include directives
2077 # and find the dependencies automatically. Also, it can not parse
2078 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2079 # something rely on date.
2080 # Because of this, I am doing a simple nsis builder here.
2081 if platform_name != 'win32':
2082 print 'installer target is only available for windows platform'
2084 if mode != 'release':
2085 print 'installer has to be built in release mode (use option mode=release)'
2087 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2088 % x for x in development_Win32_packaging_installer] + \
2089 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2090 % x for x in development_Win32_packaging_installer_components] + \
2091 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2092 % x for x in development_Win32_packaging_installer_dialogs] + \
2093 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2094 % x for x in development_Win32_packaging_installer_graphics] + \
2095 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2096 % x for x in development_Win32_packaging_installer_include] + \
2097 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2098 % x for x in development_Win32_packaging_installer_lang]
2099 if env.has_key('NSIS') and env['NSIS'] is not None:
2100 # create a builder to strip and install
2101 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2103 print 'No nsis compiler is found. Existing...'
2105 if not env.has_key('win_installer') or env['win_installer'] is None:
2107 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2109 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2110 # provide default setting
2111 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2112 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2113 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2114 print 'Development dependency package is not found.'
2117 env['deps_dir'] = env.Dir('$deps_dir').abspath
2119 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2120 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2121 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2122 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2124 env['bundle_dir'] = None
2125 # if absolute path is given, use it, otherwise, write to current directory
2126 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2127 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2128 env.Append(NSISDEFINES={
2129 'ExeFile':env['win_installer'],
2130 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2131 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2132 'FilesDeps':env['deps_dir'],
2133 'FilesBundle':env['bundle_dir'],
2135 installer = env.installer(env['win_installer'],
2136 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2137 # since I can not use a scanner, explicit dependent is required
2138 env.Depends(installer, 'install')
2139 env.Depends(installer, installer_files)
2140 env.Alias('installer', installer)
2141 # also generate bundle?
2142 if env.has_key('bundle') and env['bundle']:
2143 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2144 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2145 print 'Use bundle_dir option to specify'
2147 # generator of the builder will add bundle stuff depending on output name
2148 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2149 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2150 env.Depends(bundle_installer, 'install')
2151 env.Depends(bundle_installer, installer_files)
2152 env.Alias('installer', bundle_installer)
2155 Alias('all', ['lyx', 'client', 'tex2lyx'])