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 # src/support/Package.cpp.in:
354 # TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
355 # lib/lyx2lyx/lyx2lyx_version.py.in
358 # full path name is used to build msvs project files
359 # and to replace TOP_SRCDIR in package.C
360 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
362 # determine share_dir etc
363 packaging_method = env.get('packaging')
364 if packaging_method == 'windows':
365 share_dir = 'Resources'
366 man_dir = 'Resources/man/man1'
367 locale_dir = 'Resources/locale'
369 share_dir = 'share/lyx'
370 locale_dir = 'share/locale'
371 if platform_name == 'cygwin':
372 man_dir = 'share/man/man1'
376 # program suffix: can be yes, or a string
377 if env.has_key('version_suffix'):
378 if env['version_suffix'] in true_strings:
379 program_suffix = package_version
380 elif env['version_suffix'] in false_strings:
383 program_suffix = env['version_suffix']
386 # used by Package.cpp.in
387 env['PROGRAM_SUFFIX'] = program_suffix
389 # whether or not add suffix to file and directory names
390 add_suffix = packaging_method != 'windows'
391 # LYX_DIR are different (used in Package.cpp.in)
393 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
395 env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
396 # we need absolute path for package.C
397 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
400 #---------------------------------------------------------
401 # Setting building environment (Tools, compiler flags etc)
402 #---------------------------------------------------------
404 # Since Tool('mingw') will reset CCFLAGS etc, this should be
405 # done before getEnvVariable
406 if platform_name == 'win32':
412 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
413 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
415 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
418 # we differentiate between hard-coded options and default options
419 # hard-coded options are required and will always be there
420 # default options can be replaced by enviromental variables or command line options
421 CCFLAGS_required = []
422 LINKFLAGS_required = []
425 # if we use ms vc, the commands are fine (cl.exe and link.exe)
427 # C4819: The file contains a character that cannot be represented
428 # in the current code page (number)
429 # C4996: foo was decleared deprecated
430 CCFLAGS_required.append('/EHsc')
432 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
433 # the flags are also needed in C mode (for intl lib)
434 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
436 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
437 C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
439 # for debug/release mode
440 if env.has_key('optimization') and env['optimization'] is not None:
441 # if user supplies optimization flags, use it anyway
442 CCFLAGS_required.extend(env['optimization'].split())
443 # and do not use default
444 set_default_optimization_flags = False
446 set_default_optimization_flags = True
450 CCFLAGS_required.append('/Zi')
451 LINKFLAGS_required.extend(['/debug', '/map'])
453 CCFLAGS_required.append('-g')
454 CCFLAGS_default.append('-O')
455 elif mode == 'release' and set_default_optimization_flags:
457 CCFLAGS_default.append('/O2')
459 CCFLAGS_default.append('-O2')
461 # msvc uses separate tools for profiling
462 if env.has_key('profiling') and env['profiling']:
464 print 'Visual C++ does not use profiling options'
466 CCFLAGS_required.append('-pg')
467 LINKFLAGS_required.append('-pg')
469 if env.has_key('warnings') and env['warnings']:
471 CCFLAGS_default.append('/W2')
473 # Note: autotools detect gxx version and pass -W for 3.x
474 # and -Wextra for other versions of gcc
475 CCFLAGS_default.append('-Wall')
477 # Now, set the variables as follows:
478 # 1. if command line option exists: replace default
479 # 2. then if s envronment variable exists: replace default
480 # 3. set variable to required + default
481 def setEnvVariable(env, name, required = None, default = None, split = True):
482 ''' env: environment to set variable
484 required: hardcoded options
485 default: default options that can be replaced by command line or
486 environment variables
487 split: whether or not split obtained variable like '-02 -g'
489 # 1. ARGUMENTS is already set to env[name], override default.
490 if ARGUMENTS.has_key(name):
491 # env[name] may be rewritten when building tools are reloaded
492 # if that is the case, commandline option will override it.
493 env[name] = ARGUMENTS[name]
495 # then use environment default
496 elif os.environ.has_key(name):
497 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
498 default = os.environ[name]
500 default = default.split()
501 # the real value should be env[name] + default + required
504 if env.has_key(name):
505 value = str(env[name]).split()
506 if required is not None:
508 if default is not None:
512 if env.has_key(name):
513 value = str(env[name])
514 if required is not None:
515 value += " " + required
516 if default is not None:
517 value += " " + default
519 # print name, env[name]
521 setEnvVariable(env, 'DESTDIR', split=False)
522 setEnvVariable(env, 'CC')
523 setEnvVariable(env, 'LINK')
524 setEnvVariable(env, 'CPP')
525 setEnvVariable(env, 'CXX')
526 setEnvVariable(env, 'CXXCPP')
527 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
528 setEnvVariable(env, 'CXXFLAGS')
529 setEnvVariable(env, 'CPPFLAGS')
530 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
532 # if DESTDIR is not set...
533 if env.has_key('dest_dir'):
534 print "This option is obsolete. Please use DESTDIR instead."
535 env['DESTDIR'] = env['dest_dir']
538 # extra_inc_path and extra_lib_path
541 if env.has_key('extra_inc_path') and env['extra_inc_path']:
542 extra_inc_paths.append(env['extra_inc_path'])
543 if env.has_key('extra_lib_path') and env['extra_lib_path']:
544 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
545 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
546 extra_inc_paths.append(env['extra_inc_path1'])
547 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
548 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
549 if env.has_key('extra_bin_path') and env['extra_bin_path']:
550 # only the first one is needed (a scons bug?)
551 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
552 env.PrependENVPath('PATH', env['extra_bin_path'])
553 # extra_inc_paths will be used later by intlenv etc
554 env.AppendUnique(CPPPATH = extra_inc_paths)
557 #----------------------------------------------------------
559 #----------------------------------------------------------
561 conf = Configure(env,
563 'CheckPkgConfig' : utils.checkPkgConfig,
564 'CheckPackage' : utils.checkPackage,
565 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
566 'CheckSelectArgType' : utils.checkSelectArgType,
567 'CheckBoostLibraries' : utils.checkBoostLibraries,
568 'CheckCommand' : utils.checkCommand,
569 'CheckNSIS' : utils.checkNSIS,
570 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
571 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
572 'CheckIconvConst' : utils.checkIconvConst,
573 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
574 'CheckDeclaration' : utils.checkDeclaration,
578 # When using msvc, windows.h is required
579 if use_vc and not conf.CheckCHeader('windows.h'):
580 print 'Windows.h is not found. Please install Windows Platform SDK.'
581 print 'Please check config.log for more information.'
584 # pkg-config? (if not, we use hard-coded options)
585 if conf.CheckPkgConfig('0.15.0'):
586 env['HAS_PKG_CONFIG'] = True
588 print 'pkg-config >= 0.1.50 is not found'
589 env['HAS_PKG_CONFIG'] = False
591 # zlib? This is required.
592 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
593 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
594 print 'Did not find zdll.lib or zlib.h, exiting!'
595 print 'Please check config.log for more information.'
597 if conf.CheckLib('iconv'):
598 env['ICONV_LIB'] = 'iconv'
599 elif conf.CheckLib('libiconv'):
600 env['ICONV_LIB'] = 'libiconv'
601 elif conf.CheckFunc('iconv_open'):
602 env['ICONV_LIB'] = None
604 print 'Did not find iconv or libiconv, exiting!'
605 print 'Please check config.log for more information.'
610 if conf.CheckLib('socket'):
611 socket_libs.append('socket')
612 # nsl is the network services library and provides a
613 # transport-level interface to networking services.
614 if conf.CheckLib('nsl'):
615 socket_libs.append('nsl')
617 # check available boost libs (since lyx1.4 does not use iostream)
619 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
620 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
621 boost_libs.append(lib)
623 # check boost libraries
624 boost_opt = ARGUMENTS.get('boost', 'auto')
625 # check for system boost
626 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
627 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
628 # default to $BUILDDIR/libs (use None since this path will be added anyway)
630 # here I assume that all libraries are in the same directory
631 if boost_opt == 'included':
632 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
633 included_boost = True
634 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
635 elif boost_opt == 'auto':
636 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
637 # if not found, use local boost
639 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
640 included_boost = True
641 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
643 included_boost = False
644 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
645 elif boost_opt == 'system':
646 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
648 print "Can not find system boost libraries with version %s " % boost_version
649 print "Please supply a path through extra_lib_path and try again."
650 print "Or use boost=included to use included boost libraries."
653 included_boost = False
654 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
657 if boost_libpath is not None:
658 env.AppendUnique(LIBPATH = [boost_libpath])
661 env['ENABLE_NLS'] = env['nls']
663 if not env['ENABLE_NLS']:
665 included_gettext = False
667 # check gettext libraries
668 gettext_opt = ARGUMENTS.get('gettext', 'auto')
669 # check for system gettext
671 if gettext_opt in ['auto', 'system']:
672 if conf.CheckFunc('gettext'):
673 included_gettext = False
676 elif conf.CheckLib('intl'):
677 included_gettext = False
681 if gettext_opt == 'system':
682 print "Can not find system gettext library"
683 print "Please supply a path through extra_lib_path and try again."
684 print "Or use gettext=included to use included gettext libraries."
686 # now, auto and succ = false, or gettext=included
688 # we do not need to set LIBPATH now.
689 included_gettext = True
690 intl_libs = ['included_intl']
694 # check for msgfmt command
695 env['MSGFMT'] = conf.CheckCommand('msgfmt')
696 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
697 env['XGETTEXT'] = conf.CheckCommand('xgettext')
698 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
700 # if under windows, check the nsis compiler
701 if platform_name == 'win32':
702 env['NSIS'] = conf.CheckNSIS()
704 # cygwin packaging requires the binaries to be stripped
705 if platform_name == 'cygwin':
706 env['STRIP'] = conf.CheckCommand('strip')
709 # Customized builders
711 # install customized builders
712 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
713 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
714 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
717 #----------------------------------------------------------
718 # Generating config.h
719 #----------------------------------------------------------
720 aspell_lib = 'aspell'
721 # assume that we use aspell, aspelld compiled for msvc
722 if platform_name == 'win32' and mode == 'debug' and use_vc:
723 aspell_lib = 'aspelld'
725 # check the existence of config.h
726 config_h = os.path.join(env.Dir('$BUILDDIR/src').path, 'config.h')
727 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
729 print "Creating %s..." % boost_config_h
731 utils.createConfigFile(conf,
732 config_file = boost_config_h,
733 config_pre = r'''/* boost/config.h. Generated by SCons. */
738 * This file is part of LyX, the document processor.
739 * Licence details can be found in the file COPYING.
741 * This is the compilation configuration file for LyX.
742 * It was generated by scon.
743 * You might want to change some of the defaults if something goes wrong
744 * during the compilation.
747 #ifndef _BOOST_CONFIG_H
748 #define _BOOST_CONFIG_H
751 ('ostream', 'HAVE_OSTREAM', 'cxx'),
752 ('locale', 'HAVE_LOCALE', 'cxx'),
753 ('sstream', 'HAVE_SSTREAM', 'cxx'),
754 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
757 (env.has_key('assertions') and env['assertions'],
759 'Define if you want assertions to be enabled in the code'
763 ('wchar_t', 'HAVE_WCHAR_T', None),
767 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
768 # define USE_BOOST_FORMAT 1
770 # define USE_BOOST_FORMAT 0
773 #if !defined(ENABLE_ASSERTIONS)
774 # define BOOST_DISABLE_ASSERTS 1
776 #define BOOST_ENABLE_ASSERT_HANDLER 1
778 #define BOOST_DISABLE_THREADS 1
779 #define BOOST_NO_WSTRING 1
782 # define BOOST_POSIX 1
783 # define BOOST_POSIX_API 1
784 # define BOOST_POSIX_PATH 1
787 #define BOOST_ALL_NO_LIB 1
789 #if defined(HAVE_NEWAPIS_H)
790 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
794 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
795 * support compiled in:
796 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
797 * And we are not interested at all what libc
798 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
799 * has the needed wchar_t support and uses UCS4. Whether it
800 * implements this with the help of libc, or whether it has own code
801 * does not matter for us, because we don't use libc directly (Georg)
803 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
811 print "\nGenerating %s..." % config_h
813 # AIKSAURUS_H_LOCATION
814 if (conf.CheckCXXHeader("Aiksaurus.h")):
815 aik_location = '<Aiksaurus.h>'
816 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
817 aik_location = '<Aiksaurus/Aiksaurus.h>'
821 # determine headers to use
822 spell_opt = ARGUMENTS.get('spell', 'auto')
823 env['USE_ASPELL'] = False
824 env['USE_PSPELL'] = False
825 env['USE_ISPELL'] = False
826 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
827 spell_engine = 'USE_ASPELL'
828 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
829 spell_engine = 'USE_PSPELL'
830 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
831 spell_engine = 'USE_ISPELL'
835 if spell_engine is not None:
836 env[spell_engine] = True
838 if spell_opt == 'auto':
839 print "Warning: Can not locate any spell checker"
840 elif spell_opt != 'no':
841 print "Warning: Can not locate specified spell checker:", spell_opt
842 print 'Please check config.log for more information.'
845 # check arg types of select function
846 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
848 # check the size of wchar_t
849 sizeof_wchar_t = conf.CheckSizeOfWChar()
851 if sizeof_wchar_t == 0:
852 print 'Error: Can not determine the size of wchar_t.'
853 print 'Please check config.log for more information.'
857 # fill in the version info
858 env['VERSION_INFO'] = '''Configuration
860 Special build flags: %s
862 C Compiler flags: %s %s
864 C++ Compiler LyX flags: %s
865 C++ Compiler flags: %s %s
867 Linker user flags: %s
869 Builing directory: %s
870 Local library directory: %s
873 include search path: %s
879 ''' % (platform_name,
880 env.subst('$CCFLAGS'), env.subst('$CC'),
881 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
882 env.subst('$CXX'), env.subst('$CXXFLAGS'),
883 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
884 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
885 env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
886 str(env['LIBPATH']), str(boost_libraries),
888 frontend, packaging_method,
889 prefix, env['LYX_DIR'])
893 result = utils.createConfigFile(conf,
894 config_file = config_h,
895 config_pre = r'''/* config.h. Generated by SCons. */
900 * This file is part of LyX, the document processor.
901 * Licence details can be found in the file COPYING.
903 * This is the compilation configuration file for LyX.
904 * It was generated by scon.
905 * You might want to change some of the defaults if something goes wrong
906 * during the compilation.
913 ('io.h', 'HAVE_IO_H', 'c'),
914 ('limits.h', 'HAVE_LIMITS_H', 'c'),
915 ('locale.h', 'HAVE_LOCALE_H', 'c'),
916 ('process.h', 'HAVE_PROCESS_H', 'c'),
917 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
918 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
919 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
920 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
921 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
922 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
923 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
924 ('utime.h', 'HAVE_UTIME_H', 'c'),
925 ('direct.h', 'HAVE_DIRECT_H', 'c'),
926 ('istream', 'HAVE_ISTREAM', 'cxx'),
927 ('ios', 'HAVE_IOS', 'cxx'),
930 ('open', 'HAVE_OPEN', None),
931 ('chmod', 'HAVE_CHMOD', None),
932 ('close', 'HAVE_CLOSE', None),
933 ('popen', 'HAVE_POPEN', None),
934 ('pclose', 'HAVE_PCLOSE', None),
935 ('_open', 'HAVE__OPEN', None),
936 ('_close', 'HAVE__CLOSE', None),
937 ('_popen', 'HAVE__POPEN', None),
938 ('_pclose', 'HAVE__PCLOSE', None),
939 ('getpid', 'HAVE_GETPID', None),
940 ('_getpid', 'HAVE__GETPID', None),
941 ('mkdir', 'HAVE_MKDIR', None),
942 ('_mkdir', 'HAVE__MKDIR', None),
943 ('mktemp', 'HAVE_MKTEMP', None),
944 ('mkstemp', 'HAVE_MKSTEMP', None),
945 ('strerror', 'HAVE_STRERROR', None),
946 ('getcwd', 'HAVE_GETCWD', None),
947 ('setenv', 'HAVE_SETENV', None),
948 ('putenv', 'HAVE_PUTENV', None),
949 ('fcntl', 'HAVE_FCNTL', None),
950 ('mkfifo', 'HAVE_MKFIFO', None),
953 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
956 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
957 '#include <streambuf>\n#include <istream>'),
958 ('wchar_t', 'HAVE_WCHAR_T', None),
959 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
962 ('gdi32', 'HAVE_LIBGDI32'),
963 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
966 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
968 'Define is sys/types.h does not have pid_t',
972 (conf.CheckCXXGlobalCstd(),
974 'Define if your C++ compiler puts C library functions in the global namespace'
976 (conf.CheckMkdirOneArg(),
977 'MKDIR_TAKES_ONE_ARG',
978 'Define if mkdir takes only one argument.'
980 (conf.CheckIconvConst(),
982 'Define as const if the declaration of iconv() needs const.',
983 '#define ICONV_CONST const',
984 '#define ICONV_CONST',
986 (conf.CheckLC_MESSAGES(),
988 'Define if your <locale.h> file defines LC_MESSAGES.'
990 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
993 "Define to 1 if translation of program messages to the user's native anguage is requested.",
995 (env['nls'] and not included_gettext,
997 'Define to 1 if using system gettext library'
999 (env.has_key('concept_checks') and env['concept_checks'],
1000 '_GLIBCXX_CONCEPT_CHECKS',
1001 'libstdc++ concept checking'
1003 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1005 'libstdc++ debug mode'
1007 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1008 '_GLIBCXX_DEBUG_PEDANTIC',
1009 'libstdc++ pedantic debug mode'
1011 (os.name != 'nt', 'BOOST_POSIX',
1012 'Indicates to boost < 1.34 which API to use (posix or windows).'
1014 (os.name != 'nt', 'BOOST_POSIX_API',
1015 'Indicates to boost 1.34 which API to use (posix or windows).'
1017 (os.name != 'nt', 'BOOST_POSIX_PATH',
1018 'Indicates to boost 1.34 which path style to use (posix or windows).'
1020 (spell_engine is not None, spell_engine,
1021 'Spell engine to use'
1023 # we need to know the byte order for unicode conversions
1024 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1025 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1029 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1031 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1032 'Define to the address where bug reports for this package should be sent.'),
1033 ('#define PACKAGE_NAME "%s"' % package_name,
1034 'Define to the full name of this package.'),
1035 ('#define PACKAGE_STRING "%s"' % package_string,
1036 'Define to the full name and version of this package.'),
1037 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1038 'Define to the one symbol short name of this package.'),
1039 ('#define PACKAGE_VERSION "%s"' % package_version,
1040 'Define to the version of this package.'),
1041 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1042 'Full version info'),
1043 ('#define LYX_DATE "%s"' % lyx_date,
1045 ('#define BOOST_ALL_NO_LIB 1',
1046 'disable automatic linking of boost libraries.'),
1047 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1048 'Packaging method'),
1049 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1050 'Aiksaurus include file'),
1051 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1052 "Define to the type of arg 1 for `select'."),
1053 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1054 "Define to the type of arg 2, 3, 4 for `select'."),
1055 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1056 "Define to the type of arg 5 for `select'."),
1057 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1058 'Define to be the size of type wchar_t'),
1060 config_post = '''/************************************************************
1061 ** You should not need to change anything beyond this point */
1063 #ifndef HAVE_STRERROR
1064 #if defined(__cplusplus)
1067 char * strerror(int n);
1070 #include <../boost/config.h>
1076 # these keys are needed in env
1077 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1078 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1079 # USE_ASPELL etc does not go through result
1080 if result.has_key(key):
1081 env[key] = result[key]
1084 # if nls=yes and gettext=included, create intl/config.h
1085 # intl/libintl.h etc
1087 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1088 if env['nls'] and included_gettext:
1090 print "Creating %s..." % intl_config_h
1092 # create intl/config.h
1093 result = utils.createConfigFile(conf,
1094 config_file = intl_config_h,
1095 config_pre = r'''/* intl/config.h. Generated by SCons. */
1100 * This file is part of LyX, the document processor.
1101 * Licence details can be found in the file COPYING.
1103 * This is the compilation configuration file for LyX.
1104 * It was generated by scon.
1105 * You might want to change some of the defaults if something goes wrong
1106 * during the compilation.
1109 #ifndef _INTL_CONFIG_H
1110 #define _INTL_CONFIG_H
1113 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1114 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1115 ('string.h', 'HAVE_STRING_H', 'c'),
1116 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1117 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1118 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1119 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1120 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1121 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1122 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1125 ('getcwd', 'HAVE_GETCWD', None),
1126 ('stpcpy', 'HAVE_STPCPY', None),
1127 ('strcasecmp', 'HAVE_STRCASECMP', None),
1128 ('strdup', 'HAVE_STRDUP', None),
1129 ('strtoul', 'HAVE_STRTOUL', None),
1130 ('alloca', 'HAVE_ALLOCA', None),
1131 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1132 ('mempcpy', 'HAVE_MEMPCPY', None),
1133 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1134 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1135 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1136 ('setlocale', 'HAVE_SETLOCALE', None),
1137 ('tsearch', 'HAVE_TSEARCH', None),
1138 ('getegid', 'HAVE_GETEGID', None),
1139 ('getgid', 'HAVE_GETGID', None),
1140 ('getuid', 'HAVE_GETUID', None),
1141 ('wcslen', 'HAVE_WCSLEN', None),
1142 ('asprintf', 'HAVE_ASPRINTF', None),
1143 ('wprintf', 'HAVE_WPRINTF', None),
1144 ('snprintf', 'HAVE_SNPRINTF', None),
1145 ('printf', 'HAVE_POSIX_PRINTF', None),
1146 ('fcntl', 'HAVE_FCNTL', None),
1149 ('intmax_t', 'HAVE_INTMAX_T', None),
1150 ('long double', 'HAVE_LONG_DOUBLE', None),
1151 ('long long', 'HAVE_LONG_LONG', None),
1152 ('wchar_t', 'HAVE_WCHAR_T', None),
1153 ('wint_t', 'HAVE_WINT_T', None),
1154 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1155 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1161 (conf.CheckLC_MESSAGES(),
1163 'Define if your <locale.h> file defines LC_MESSAGES.'
1165 (conf.CheckIconvConst(),
1167 'Define as const if the declaration of iconv() needs const.',
1168 '#define ICONV_CONST const',
1169 '#define ICONV_CONST',
1171 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1172 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1174 "Define to 1 if you have the `intmax_t' type."
1176 (env.has_key('nls') and env['nls'],
1178 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1182 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1183 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1184 'Define to be the size of type wchar_t'),
1186 config_post = '#endif'
1189 # these keys are needed in env
1190 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1191 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1192 # USE_ASPELL etc does not go through result
1193 if result.has_key(key):
1194 env[key] = result[key]
1197 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1198 if env['nls'] and included_gettext:
1199 # libgnuintl.h.in => libintl.h
1200 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1201 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1202 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1203 [Copy('$TARGET', '$SOURCE')])
1206 # Finish auto-configuration
1209 #----------------------------------------------------------
1210 # Now set up our build process accordingly
1211 #----------------------------------------------------------
1213 if env['ICONV_LIB'] is None:
1216 system_libs = [env['ICONV_LIB']]
1217 if platform_name in ['win32', 'cygwin']:
1218 # the final link step needs stdc++ to succeed under mingw
1219 # FIXME: shouldn't g++ automatically link to stdc++?
1221 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1223 system_libs += ['shlwapi', 'stdc++', 'z']
1224 elif platform_name == 'cygwin' and env['X11']:
1225 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1226 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1227 'resolv', 'pthread', 'z']
1229 system_libs += ['z']
1232 ('HAVE_LIBGDI32', 'gdi32'),
1233 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1234 ('USE_ASPELL', aspell_lib),
1235 ('USE_ISPELL', 'ispell'),
1236 ('USE_PSPELL', 'pspell'),
1241 system_libs.append(lib[1])
1244 # Build parameters CPPPATH etc
1247 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1250 # boost: for boost header files
1251 # BUILDDIR/src: for config.h
1252 # TOP_SRCDIR/src: for support/* etc
1254 env['CPPPATH'] += ['$BUILDDIR/src', '$TOP_SRCDIR/src']
1256 # Separating boost directories from CPPPATH stops scons from building
1257 # the dependency tree for boost header files, and effectively reduce
1258 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1259 # boost headers, the following is not 100% safe.
1260 # env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1261 env.PrependUnique(CCFLAGS = ['$INCPREFIX$BOOST_INC_PATH'])
1263 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1264 if env['nls'] and included_gettext:
1265 env['CPPPATH'].append('$BUILDDIR/intl')
1269 # A Link script for cygwin see
1270 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1271 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1274 if platform_name == 'cygwin':
1275 ld_script_path = '/tmp'
1276 ld_script = utils.installCygwinLDScript(ld_script_path)
1277 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1278 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1281 #---------------------------------------------------------
1282 # Frontend related variables (QTDIR etc)
1283 #---------------------------------------------------------
1286 # create a separate environment so that other files do not have
1287 # to be built with all the include directories etc
1289 if frontend == 'qt4':
1290 frontend_env = env.Copy()
1292 # handle qt related user specified paths
1293 # set environment so that moc etc can be found even if its path is not set properly
1294 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1295 frontend_env['QTDIR'] = frontend_env['qt_dir']
1296 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1297 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1298 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1299 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1300 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1302 # if separate qt_lib_path is given
1303 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1304 qt_lib_path = frontend_env.subst('$qt_lib_path')
1305 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1306 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1310 # if separate qt_inc_path is given
1311 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1312 qt_inc_path = frontend_env['qt_inc_path']
1316 # local qt4 toolset from
1317 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1319 # NOTE: I have to patch qt4.py since it does not automatically
1320 # process .C file!!! (add to cxx_suffixes )
1322 frontend_env.Tool('qt4', [scons_dir])
1323 frontend_env['QT_AUTOSCAN'] = 0
1324 frontend_env['QT4_AUTOSCAN'] = 0
1325 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1327 if qt_lib_path is None:
1328 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1329 if qt_inc_path is None:
1330 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1333 conf = Configure(frontend_env,
1335 'CheckPackage' : utils.checkPackage,
1336 'CheckCommand' : utils.checkCommand,
1341 # first: try pkg_config
1342 if frontend_env['HAS_PKG_CONFIG']:
1343 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1344 # FIXME: use pkg_config information?
1345 #frontend_env['QT4_PKG_CONFIG'] = succ
1346 # second: try to link to it
1348 # Under linux, I can test the following perfectly
1349 # Under windows, lib names need to passed as libXXX4.a ...
1350 if platform_name == 'win32':
1351 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1353 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1354 # still can not find it
1356 print 'Did not find qt libraries, exiting!'
1357 print 'Please check config.log for more information.'
1360 # Now, determine the correct suffix:
1361 qt_libs = ['QtCore', 'QtGui']
1362 if platform_name == 'win32':
1363 if mode == 'debug' and use_vc and \
1364 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1365 qt_lib_suffix = 'd4'
1366 use_qt_debug_libs = True
1369 use_qt_debug_libs = False
1371 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1372 qt_lib_suffix = '_debug'
1373 use_qt_debug_libs = True
1376 use_qt_debug_libs = False
1377 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1378 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1379 qtcore_lib = ['QtCore' + qt_lib_suffix]
1381 # check uic and moc commands for qt frontends
1382 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1383 print 'uic or moc command is not found for frontend', frontend
1386 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1387 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1388 # For some unknown changes in msvc or qt, this is no longer needed.
1390 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1391 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1392 env.File('$BUILDDIR/lyx.exe.manifest').path]
1394 frontend_env = conf.Finish()
1399 print env['VERSION_INFO']
1402 # Mingw command line may be too short for our link usage,
1403 # Here we use a trick from scons wiki
1404 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1406 # I also would like to add logging (commands only) capacity to the
1408 logfile = env.get('logfile', default_log_file)
1409 if logfile != '' or platform_name == 'win32':
1411 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1412 info = '''# This is a log of commands used by scons to build lyx
1416 ''' % (time.asctime(), ' '.join(sys.argv),
1417 env['VERSION_INFO'].replace('\n','\n# ')) )
1422 # -h will print out help info
1423 Help(opts.GenerateHelpText(env))
1426 #----------------------------------------------------------
1428 #----------------------------------------------------------
1429 # this has been the source of problems on some platforms...
1430 # I find that I need to supply it with full path name
1431 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1432 # this usage needs further investigation.
1433 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1434 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1435 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1436 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1437 frontend_env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1439 print "Building all targets recursively"
1441 def libExists(libname):
1442 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1443 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1446 if (included_boost and not libExists('included_boost_regex')) or 'boost' in BUILD_TARGETS:
1450 for lib in boost_libs:
1451 boostlib = env.StaticLibrary(
1452 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1453 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)],
1454 # do not use global CPPPATH because src/config.h will mess up with boost/config.h
1455 CPPPATH = ['$BUILDDIR/boost'] + extra_inc_paths,
1456 CCFLAGS = ['$CCFLAGS', '$INCPREFIX$TOP_SRCDIR/boost', '-DBOOST_USER_CONFIG="<config.h>"']
1458 Alias('boost', boostlib)
1461 if (included_gettext and not libExists('included_intl')) or 'intl' in BUILD_TARGETS:
1466 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1467 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1468 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1470 '-DENABLE_RELOCATABLE=1',
1472 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1474 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1475 '-Drelocate=libintl_relocate',
1476 '-DDEPENDS_ON_LIBICONV=1',
1480 INTL_CCFLAGS.extend(['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1482 intl = env.StaticLibrary(
1483 target = '$LOCALLIBPATH/included_intl',
1485 CCFLAGS = INTL_CCFLAGS,
1486 # do not use global CPPPATH because src/config.h will mess up with intl/config.h
1487 CPPPATH = ['$BUILDDIR/intl'] + extra_inc_paths,
1488 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1495 frontend_env.Depends('$BUILDDIR/src/support/Package.cpp', '$BUILDDIR/src/config.h')
1496 Package_cpp = env.substFile('$BUILDDIR/src/support/Package.cpp', '$TOP_SRCDIR/src/support/Package.cpp.in')
1498 support = frontend_env.StaticLibrary(
1499 target = '$LOCALLIBPATH/support',
1500 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files] + Package_cpp + \
1501 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_files],
1505 '-DQT_CLEAN_NAMESPACE',
1510 CPPPATH = ['$CPPPATH', '$TOP_SRCDIR/src/support/minizip']
1512 Alias('support', support)
1518 mathed = env.StaticLibrary(
1519 target = '$LOCALLIBPATH/mathed',
1520 source = ['$BUILDDIR/src/mathed/%s' % x for x in src_mathed_files]
1522 Alias('mathed', mathed)
1528 insets = env.StaticLibrary(
1529 target = '$LOCALLIBPATH/insets',
1530 source = ['$BUILDDIR/src/insets/%s' % x for x in src_insets_files]
1532 Alias('insets', insets)
1538 frontends = env.StaticLibrary(
1539 target = '$LOCALLIBPATH/frontends',
1540 source = ['$BUILDDIR/src/frontends/%s' % x for x in src_frontends_files]
1542 Alias('frontends', frontends)
1548 graphics = env.StaticLibrary(
1549 target = '$LOCALLIBPATH/graphics',
1550 source = ['$BUILDDIR/src/graphics/%s' % x for x in src_graphics_files]
1552 Alias('graphics', graphics)
1556 # src/frontends/controllers
1558 controllers = env.StaticLibrary(
1559 target = '$LOCALLIBPATH/controllers',
1560 source = ['$BUILDDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1562 Alias('controllers', controllers)
1568 frontend_env['QT4_MOCHPREFIX'] = ''
1569 frontend_env['QT4_MOCHSUFFIX'] = '_moc.cpp'
1571 # tells scons how to get these moced files, although not all moced files are needed
1572 # (or are actually generated).
1573 qt4_moced_files = [frontend_env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1574 for x in src_frontends_qt4_header_files ]
1575 resources = [frontend_env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1576 for x in src_frontends_qt4_ui_files]
1579 # moc qt4_moc_files, the moced files are included in the original files
1581 qt4 = frontend_env.StaticLibrary(
1582 target = '$LOCALLIBPATH/qt4',
1583 source = ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1587 '$BUILDDIR/src/images',
1588 '$BUILDDIR/src/frontends',
1589 '$BUILDDIR/src/frontends/qt4',
1590 '$BUILDDIR/src/frontends/qt4/ui',
1591 '$BUILDDIR/src/frontends/controllers'
1596 '-DQT_CLEAN_NAMESPACE',
1608 if env['HAVE_FCNTL']:
1609 client = frontend_env.Program(
1610 target = '$BUILDDIR/src/client/lyxclient',
1611 LIBS = ['support'] + intl_libs + system_libs +
1612 socket_libs + boost_libraries + qtcore_lib,
1613 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1614 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1616 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1617 client, [Copy('$TARGET', '$SOURCE')]))
1620 Alias('client', client)
1626 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1627 frontend_env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1628 [Copy('$TARGET', '$SOURCE')])
1630 tex2lyx = frontend_env.Program(
1631 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1632 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1633 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1634 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1635 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$CPPPATH'],
1636 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1638 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1639 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1640 Alias('tex2lyx', tex2lyx)
1646 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1647 src_post_files.append('ASpell.cpp')
1648 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1649 src_post_files.append('PSpell.cpp')
1650 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1651 src_post_files.append('ISpell.cpp')
1653 # msvc requires at least one source file with main()
1654 # so I exclude main.cpp from lyxbase
1655 lyxbase_pre = env.StaticLibrary(
1656 target = '$LOCALLIBPATH/lyxbase_pre',
1657 source = ['$BUILDDIR/src/%s' % x for x in src_pre_files]
1659 lyxbase_post = env.StaticLibrary(
1660 target = '$LOCALLIBPATH/lyxbase_post',
1661 source = ["$BUILDDIR/src/%s" % x for x in src_post_files]
1663 Alias('lyxbase', lyxbase_pre)
1664 Alias('lyxbase', lyxbase_post)
1668 # Build lyx with given frontend
1670 lyx = frontend_env.Program(
1671 target = '$BUILDDIR/lyx',
1672 source = ['$BUILDDIR/src/main.cpp'] + \
1673 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1694 if use_vc and 'msvs_projects' in BUILD_TARGETS:
1695 def build_project(target, full_target = None,
1696 src = [], inc = [], res = []):
1697 ''' build mavs project files
1698 target: alias (correspond to directory name)
1699 full_target: full path/filename of the target
1704 For non-debug-able targets like static libraries, target (alias) is
1705 enough to build the target. For executable targets, msvs need to know
1706 the full path to start debug them.
1709 if full_target is None:
1710 build_target = target
1712 build_target = full_target
1714 proj = env.MSVSProject(
1715 target = target + env['MSVSPROJECTSUFFIX'],
1716 # this allows easy access to header files (along with source)
1717 srcs = [env.subst(x) for x in src + inc],
1718 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1719 localincs = [env.subst(x) for x in inc],
1720 resources = [env.subst(x) for x in res],
1721 buildtarget = build_target,
1725 Alias('msvs_projects', proj)
1727 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1728 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1729 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1731 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1732 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1733 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1735 build_project('lyx',
1736 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1737 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1738 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1739 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1740 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1741 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1742 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1743 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1744 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1745 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1746 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1747 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1748 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1749 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1750 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1751 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1752 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1753 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1756 if 'update_po' in BUILD_TARGETS:
1760 print 'Updating po/*.po files...'
1762 # whether or not update po files
1763 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1764 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1766 # rebuild POTFILES.in
1767 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1768 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1769 src_extra_src_files] + \
1770 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1771 src_support_extra_header_files + src_support_extra_src_files] + \
1772 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1773 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1774 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1775 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1776 ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files + src_frontends_controllers_files] + \
1777 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
1778 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1779 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1781 Alias('update_po', POTFILES_in)
1782 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
1783 # and combine them to lyx.po
1784 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1785 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1786 env.Command('$BUILDDIR/po/all.po',
1787 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1788 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1789 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1790 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1791 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files],
1792 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1793 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1794 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1795 env.Command('$BUILDDIR/po/ui_l10n.pot',
1796 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1797 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1798 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1799 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
1801 ['$MSGUNIQ -o $TARGET $SOURCE',
1802 '''$XGETTEXT --default-domain=${TARGET.base} \
1803 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
1804 --language=C++ --join-existing \
1805 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
1806 --files-from=$TOP_SRCDIR/po/POTFILES.in \
1807 --copyright-holder="LyX Developers" \
1808 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
1810 env.Depends(lyx_po, POTFILES_in)
1811 # copy lyx.po to lyx.pot
1812 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
1813 Copy('$TARGET', '$SOURCE'))
1816 # files to translate
1817 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
1818 # possibly *only* handle these languages
1820 if env.has_key('languages'):
1821 languages = env.make_list(env['languages'])
1822 # merge. if I use lan.po as $TARGET, it will be removed
1823 # before it is merged. In this builder,
1824 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
1825 # and is copied to po/lang.po
1826 env['BUILDERS']['msgmerge'] = Builder(action=[
1827 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
1828 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
1830 # for each po file, generate pot
1831 for po_file in transfiles:
1833 fname = os.path.split(po_file)[1]
1835 country = fname.split('.')[0]
1837 if not languages or country in languages:
1838 # merge po files, the generated lan.po_new file is copied to lan.po file.
1839 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
1840 env.Depends(po, POTFILES_in)
1841 Alias('update_po', po)
1844 # if 'install' is not in the target, do not process this
1845 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
1847 # this part is a bit messy right now. Since scons will provide
1848 # --DESTDIR option soon, at least the dest_dir handling can be
1857 # files to translate
1858 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1859 # possibly *only* handle these languages
1861 if env.has_key('languages'):
1862 languages = env.make_list(env['lanauges'])
1863 # use defulat msgfmt
1865 if not env['MSGFMT']:
1866 print 'msgfmt does not exist. Can not process po files'
1869 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
1871 for f in transfiles:
1873 fname = os.path.split(f)[1]
1875 country = fname.split('.')[0]
1877 if not languages or country in languages:
1878 gmo_files.extend(env.Transfiles(f))
1879 # how to join dest_dir and prefix
1880 def joinPaths(path1, path2):
1881 ''' join path1 and path2, do not use os.path.join because
1882 under window, c:\destdir\d:\program is invalid '''
1884 return os.path.normpath(path2)
1885 # separate drive letter
1886 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
1887 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
1888 return os.path.join(os.path.normpath(path1), path[1:])
1890 # install to dest_dir/prefix
1891 dest_dir = env.get('DESTDIR', '')
1892 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
1893 # create the directory if needed
1894 if not os.path.isdir(dest_prefix_dir):
1896 os.makedirs(dest_prefix_dir)
1899 if not os.path.isdir(dest_prefix_dir):
1900 print 'Can not create directory', dest_prefix_dir
1903 if env.has_key('exec_prefix'):
1904 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
1906 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
1908 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
1910 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
1911 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
1912 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
1913 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
1917 # install executables (lyxclient may be None)
1920 version_suffix = program_suffix
1924 # install lyx, if in release mode, try to strip the binary
1925 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
1926 # create a builder to strip and install
1927 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
1929 # install executables
1930 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
1933 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
1934 target = os.path.join(bin_dest_dir, target_name)
1935 if env['BUILDERS'].has_key('StripInstallAs'):
1936 env.StripInstallAs(target, obj)
1938 env.InstallAs(target, obj)
1939 Alias('install', target)
1943 for (dir,files) in [
1945 ('bind', lib_bind_files),
1946 ('bind/de', lib_bind_de_files),
1947 ('bind/fi', lib_bind_fi_files),
1948 ('bind/pt', lib_bind_pt_files),
1949 ('bind/sv', lib_bind_sv_files),
1950 ('doc', lib_doc_files),
1951 ('doc/biblio', lib_doc_biblio_files),
1952 ('doc/clipart', lib_doc_clipart_files),
1953 ('doc/cs', lib_doc_cs_files),
1954 ('doc/da', lib_doc_da_files),
1955 ('doc/de', lib_doc_de_files),
1956 ('doc/de/clipart', lib_doc_de_clipart_files),
1957 ('doc/es', lib_doc_es_files),
1958 ('doc/es/clipart', lib_doc_es_clipart_files),
1959 ('doc/eu', lib_doc_eu_files),
1960 ('doc/fr', lib_doc_fr_files),
1961 ('doc/he', lib_doc_he_files),
1962 ('doc/hu', lib_doc_hu_files),
1963 ('doc/it', lib_doc_it_files),
1964 ('doc/nl', lib_doc_nl_files),
1965 ('doc/nb', lib_doc_nb_files),
1966 ('doc/pl', lib_doc_pl_files),
1967 ('doc/pt', lib_doc_pt_files),
1968 ('doc/ro', lib_doc_ro_files),
1969 ('doc/ru', lib_doc_ru_files),
1970 ('doc/sk', lib_doc_sk_files),
1971 ('doc/sl', lib_doc_sl_files),
1972 ('doc/sv', lib_doc_sv_files),
1973 ('examples', lib_examples_files),
1974 ('examples/ca', lib_examples_ca_files),
1975 ('examples/cs', lib_examples_cs_files),
1976 ('examples/da', lib_examples_da_files),
1977 ('examples/de', lib_examples_de_files),
1978 ('examples/es', lib_examples_es_files),
1979 ('examples/eu', lib_examples_eu_files),
1980 ('examples/fa', lib_examples_fa_files),
1981 ('examples/fr', lib_examples_fr_files),
1982 ('examples/he', lib_examples_he_files),
1983 ('examples/hu', lib_examples_hu_files),
1984 ('examples/it', lib_examples_it_files),
1985 ('examples/nl', lib_examples_nl_files),
1986 ('examples/pl', lib_examples_pl_files),
1987 ('examples/pt', lib_examples_pt_files),
1988 ('examples/ru', lib_examples_ru_files),
1989 ('examples/sl', lib_examples_sl_files),
1990 ('examples/ro', lib_examples_ro_files),
1991 ('fonts', lib_fonts_files),
1992 ('images', lib_images_files),
1993 ('images/math', lib_images_math_files),
1994 ('kbd', lib_kbd_files),
1995 ('layouts', lib_layouts_files + lib_layouts_inc_files),
1996 ('lyx2lyx', lib_lyx2lyx_files),
1997 ('scripts', lib_scripts_files),
1998 ('templates', lib_templates_files),
1999 ('tex', lib_tex_files),
2000 ('ui', lib_ui_files)]:
2001 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2002 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2003 Alias('install', dirs)
2005 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2006 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
2007 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2008 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2009 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2010 sys.path.append(share_dest_dir + '/lyx2lyx')
2012 # generate TOC files for each doc
2013 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2015 for lang in languages.keys():
2016 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2017 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2020 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2021 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2023 # this is for English
2024 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2027 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2028 Alias('install', tocs)
2030 if platform_name == 'cygwin':
2031 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2032 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2033 '%s-%s.README' % (package, package_cygwin_version))
2034 env.InstallAs(Cygwin_README,
2035 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2036 Alias('install', Cygwin_README)
2037 # also a directory /usr/share/doc/lyx for README etc
2038 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2039 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2040 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2041 Alias('install', Cygwin_Doc)
2042 # cygwin fonts also need to be installed
2043 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2044 env.Install(Cygwin_fonts,
2045 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2046 for file in win32_bakoma_fonts])
2047 Alias('install', Cygwin_fonts)
2048 # we also need a post installation script
2049 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2050 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2051 env.Install(postinstall_path, tmp_script)
2052 Alias('install', postinstall_path)
2054 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2055 env.subst('$TOP_SRCDIR/lyx.man'))
2056 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2057 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2058 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2059 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2060 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2061 x in ['lyx', 'tex2lyx', 'lyxclient']])
2063 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2064 for gmo in gmo_files:
2065 lan = os.path.split(str(gmo))[1].split('.')[0]
2066 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2067 env.InstallAs(dest_file, gmo)
2068 Alias('install', dest_file)
2071 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
2073 # build windows installer using NSIS
2076 # There is a nsis builder on scons wiki but it does not work with
2077 # our lyx.nsi because it does not dig through all the include directives
2078 # and find the dependencies automatically. Also, it can not parse
2079 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2080 # something rely on date.
2081 # Because of this, I am doing a simple nsis builder here.
2082 if platform_name != 'win32':
2083 print 'installer target is only available for windows platform'
2085 if mode != 'release':
2086 print 'installer has to be built in release mode (use option mode=release)'
2088 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2089 % x for x in development_Win32_packaging_installer] + \
2090 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2091 % x for x in development_Win32_packaging_installer_components] + \
2092 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2093 % x for x in development_Win32_packaging_installer_dialogs] + \
2094 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2095 % x for x in development_Win32_packaging_installer_graphics] + \
2096 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2097 % x for x in development_Win32_packaging_installer_include] + \
2098 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2099 % x for x in development_Win32_packaging_installer_lang]
2100 if env.has_key('NSIS') and env['NSIS'] is not None:
2101 # create a builder to strip and install
2102 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2104 print 'No nsis compiler is found. Existing...'
2106 if not env.has_key('win_installer') or env['win_installer'] is None:
2108 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2110 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2111 # provide default setting
2112 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2113 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2114 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2115 print 'Development dependency package is not found.'
2118 env['deps_dir'] = env.Dir('$deps_dir').abspath
2120 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2121 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2122 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2123 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2125 env['bundle_dir'] = None
2126 # if absolute path is given, use it, otherwise, write to current directory
2127 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2128 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2129 env.Append(NSISDEFINES={
2130 'ExeFile':env['win_installer'],
2131 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2132 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2133 'FilesDeps':env['deps_dir'],
2134 'FilesBundle':env['bundle_dir'],
2136 installer = env.installer(env['win_installer'],
2137 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2138 # since I can not use a scanner, explicit dependent is required
2139 env.Depends(installer, 'install')
2140 env.Depends(installer, installer_files)
2141 env.Alias('installer', installer)
2142 # also generate bundle?
2143 if env.has_key('bundle') and env['bundle']:
2144 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2145 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2146 print 'Use bundle_dir option to specify'
2148 # generator of the builder will add bundle stuff depending on output name
2149 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2150 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2151 env.Depends(bundle_installer, 'install')
2152 env.Depends(bundle_installer, installer_files)
2153 env.Alias('installer', bundle_installer)
2156 Alias('all', ['lyx', 'client', 'tex2lyx'])