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 # Absolute data directory
389 if mode == 'release':
391 env['LYX_DATA_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
393 env['LYX_DATA_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
395 # in the debug mode, use $TOP_SRCDIR/lib to make sure lyx can be started from anyway
396 # by using this directory as data directory
397 env['LYX_DATA_DIR'] = os.path.join(env.subst('$TOP_SRCDIR'), 'lib')
398 # we need absolute path for package.C
399 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
402 #---------------------------------------------------------
403 # Setting building environment (Tools, compiler flags etc)
404 #---------------------------------------------------------
406 # Since Tool('mingw') will reset CCFLAGS etc, this should be
407 # done before getEnvVariable
408 if platform_name == 'win32':
414 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
415 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
417 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
420 # we differentiate between hard-coded options and default options
421 # hard-coded options are required and will always be there
422 # default options can be replaced by enviromental variables or command line options
423 CCFLAGS_required = []
424 LINKFLAGS_required = []
427 # if we use ms vc, the commands are fine (cl.exe and link.exe)
429 # C4819: The file contains a character that cannot be represented
430 # in the current code page (number)
431 # C4996: foo was decleared deprecated
432 CCFLAGS_required.append('/EHsc')
434 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
436 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
438 # for debug/release mode
439 if env.has_key('optimization') and env['optimization'] is not None:
440 # if user supplies optimization flags, use it anyway
441 CCFLAGS_required.extend(env['optimization'].split())
442 # and do not use default
443 set_default_optimization_flags = False
445 set_default_optimization_flags = True
449 CCFLAGS_required.append('/Zi')
450 LINKFLAGS_required.extend(['/debug', '/map'])
452 CCFLAGS_required.append('-g')
453 CCFLAGS_default.append('-O')
454 elif mode == 'release' and set_default_optimization_flags:
456 CCFLAGS_default.append('/O2')
458 CCFLAGS_default.append('-O2')
460 # msvc uses separate tools for profiling
461 if env.has_key('profiling') and env['profiling']:
463 print 'Visual C++ does not use profiling options'
465 CCFLAGS_required.append('-pg')
466 LINKFLAGS_required.append('-pg')
468 if env.has_key('warnings') and env['warnings']:
470 CCFLAGS_default.append('/W2')
472 # Note: autotools detect gxx version and pass -W for 3.x
473 # and -Wextra for other versions of gcc
474 CCFLAGS_default.append('-Wall')
476 # Now, set the variables as follows:
477 # 1. if command line option exists: replace default
478 # 2. then if s envronment variable exists: replace default
479 # 3. set variable to required + default
480 def setEnvVariable(env, name, required = None, default = None, split = True):
481 ''' env: environment to set variable
483 required: hardcoded options
484 default: default options that can be replaced by command line or
485 environment variables
486 split: whether or not split obtained variable like '-02 -g'
488 # 1. ARGUMENTS is already set to env[name], override default.
489 if ARGUMENTS.has_key(name):
490 # env[name] may be rewritten when building tools are reloaded
491 # if that is the case, commandline option will override it.
492 env[name] = ARGUMENTS[name]
494 # then use environment default
495 elif os.environ.has_key(name):
496 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
497 default = os.environ[name]
499 default = default.split()
500 # the real value should be env[name] + default + required
503 if env.has_key(name):
504 value = str(env[name]).split()
505 if required is not None:
507 if default is not None:
511 if env.has_key(name):
512 value = str(env[name])
513 if required is not None:
514 value += " " + required
515 if default is not None:
516 value += " " + default
518 # print name, env[name]
520 setEnvVariable(env, 'DESTDIR', split=False)
521 setEnvVariable(env, 'CC')
522 setEnvVariable(env, 'LINK')
523 setEnvVariable(env, 'CPP')
524 setEnvVariable(env, 'CXX')
525 setEnvVariable(env, 'CXXCPP')
526 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
527 setEnvVariable(env, 'CXXFLAGS')
528 setEnvVariable(env, 'CPPFLAGS')
529 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
531 # if DESTDIR is not set...
532 if env.has_key('dest_dir'):
533 print "This option is obsolete. Please use DESTDIR instead."
534 env['DESTDIR'] = env['dest_dir']
537 # extra_inc_path and extra_lib_path
540 if env.has_key('extra_inc_path') and env['extra_inc_path']:
541 extra_inc_paths.append(env['extra_inc_path'])
542 if env.has_key('extra_lib_path') and env['extra_lib_path']:
543 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
544 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
545 extra_inc_paths.append(env['extra_inc_path1'])
546 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
547 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
548 if env.has_key('extra_bin_path') and env['extra_bin_path']:
549 # only the first one is needed (a scons bug?)
550 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
551 env.PrependENVPath('PATH', env['extra_bin_path'])
552 # extra_inc_paths will be used later by intlenv etc
553 env.AppendUnique(CPPPATH = extra_inc_paths)
556 #----------------------------------------------------------
558 #----------------------------------------------------------
560 conf = Configure(env,
562 'CheckPkgConfig' : utils.checkPkgConfig,
563 'CheckPackage' : utils.checkPackage,
564 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
565 'CheckSelectArgType' : utils.checkSelectArgType,
566 'CheckBoostLibraries' : utils.checkBoostLibraries,
567 'CheckCommand' : utils.checkCommand,
568 'CheckNSIS' : utils.checkNSIS,
569 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
570 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
571 'CheckIconvConst' : utils.checkIconvConst,
572 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
573 'CheckDeclaration' : utils.checkDeclaration,
577 # When using msvc, windows.h is required
578 if use_vc and not conf.CheckCHeader('windows.h'):
579 print 'Windows.h is not found. Please install Windows Platform SDK.'
580 print 'Please check config.log for more information.'
583 # pkg-config? (if not, we use hard-coded options)
584 if conf.CheckPkgConfig('0.15.0'):
585 env['HAS_PKG_CONFIG'] = True
587 print 'pkg-config >= 0.1.50 is not found'
588 env['HAS_PKG_CONFIG'] = False
590 # zlib? This is required.
591 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
592 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
593 print 'Did not find zdll.lib or zlib.h, exiting!'
594 print 'Please check config.log for more information.'
596 if conf.CheckLib('iconv'):
597 env['ICONV_LIB'] = 'iconv'
598 elif conf.CheckLib('libiconv'):
599 env['ICONV_LIB'] = 'libiconv'
600 elif conf.CheckFunc('iconv_open'):
601 env['ICONV_LIB'] = None
603 print 'Did not find iconv or libiconv, exiting!'
604 print 'Please check config.log for more information.'
609 if conf.CheckLib('socket'):
610 socket_libs.append('socket')
611 # nsl is the network services library and provides a
612 # transport-level interface to networking services.
613 if conf.CheckLib('nsl'):
614 socket_libs.append('nsl')
616 # check available boost libs (since lyx1.4 does not use iostream)
618 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
619 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
620 boost_libs.append(lib)
622 # check boost libraries
623 boost_opt = ARGUMENTS.get('boost', 'auto')
624 # check for system boost
625 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
626 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
627 # default to $BUILDDIR/libs (use None since this path will be added anyway)
629 # here I assume that all libraries are in the same directory
630 if boost_opt == 'included':
631 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
632 included_boost = True
633 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
634 elif boost_opt == 'auto':
635 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
636 # if not found, use local boost
638 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
639 included_boost = True
640 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
642 included_boost = False
643 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
644 elif boost_opt == 'system':
645 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
647 print "Can not find system boost libraries with version %s " % boost_version
648 print "Please supply a path through extra_lib_path and try again."
649 print "Or use boost=included to use included boost libraries."
652 included_boost = False
653 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
656 if boost_libpath is not None:
657 env.AppendUnique(LIBPATH = [boost_libpath])
660 env['ENABLE_NLS'] = env['nls']
662 if not env['ENABLE_NLS']:
664 included_gettext = False
666 # check gettext libraries
667 gettext_opt = ARGUMENTS.get('gettext', 'auto')
668 # check for system gettext
670 if gettext_opt in ['auto', 'system']:
671 if conf.CheckFunc('gettext'):
672 included_gettext = False
675 elif conf.CheckLib('intl'):
676 included_gettext = False
680 if gettext_opt == 'system':
681 print "Can not find system gettext library"
682 print "Please supply a path through extra_lib_path and try again."
683 print "Or use gettext=included to use included gettext libraries."
685 # now, auto and succ = false, or gettext=included
687 # we do not need to set LIBPATH now.
688 included_gettext = True
689 intl_libs = ['included_intl']
693 # check for msgfmt command
694 env['MSGFMT'] = conf.CheckCommand('msgfmt')
695 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
696 env['XGETTEXT'] = conf.CheckCommand('xgettext')
697 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
699 # if under windows, check the nsis compiler
700 if platform_name == 'win32':
701 env['NSIS'] = conf.CheckNSIS()
703 # cygwin packaging requires the binaries to be stripped
704 if platform_name == 'cygwin':
705 env['STRIP'] = conf.CheckCommand('strip')
708 # Customized builders
710 # install customized builders
711 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
712 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
713 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
716 #----------------------------------------------------------
717 # Generating config.h
718 #----------------------------------------------------------
719 aspell_lib = 'aspell'
720 # assume that we use aspell, aspelld compiled for msvc
721 if platform_name == 'win32' and mode == 'debug' and use_vc:
722 aspell_lib = 'aspelld'
724 # check the existence of config.h
725 config_h = os.path.join(env.Dir('$BUILDDIR/src').path, 'config.h')
726 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
728 print "Creating %s..." % boost_config_h
730 utils.createConfigFile(conf,
731 config_file = boost_config_h,
732 config_pre = r'''/* boost/config.h. Generated by SCons. */
737 * This file is part of LyX, the document processor.
738 * Licence details can be found in the file COPYING.
740 * This is the compilation configuration file for LyX.
741 * It was generated by scon.
742 * You might want to change some of the defaults if something goes wrong
743 * during the compilation.
746 #ifndef _BOOST_CONFIG_H
747 #define _BOOST_CONFIG_H
750 ('ostream', 'HAVE_OSTREAM', 'cxx'),
751 ('locale', 'HAVE_LOCALE', 'cxx'),
752 ('sstream', 'HAVE_SSTREAM', 'cxx'),
753 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
756 (env.has_key('assertions') and env['assertions'],
758 'Define if you want assertions to be enabled in the code'
762 ('wchar_t', 'HAVE_WCHAR_T', None),
766 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
767 # define USE_BOOST_FORMAT 1
769 # define USE_BOOST_FORMAT 0
772 #if !defined(ENABLE_ASSERTIONS)
773 # define BOOST_DISABLE_ASSERTS 1
775 #define BOOST_ENABLE_ASSERT_HANDLER 1
777 #define BOOST_DISABLE_THREADS 1
778 #define BOOST_NO_WSTRING 1
781 # define BOOST_POSIX 1
782 # define BOOST_POSIX_API 1
783 # define BOOST_POSIX_PATH 1
786 #define BOOST_ALL_NO_LIB 1
788 #if defined(HAVE_NEWAPIS_H)
789 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
793 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
794 * support compiled in:
795 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
796 * And we are not interested at all what libc
797 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
798 * has the needed wchar_t support and uses UCS4. Whether it
799 * implements this with the help of libc, or whether it has own code
800 * does not matter for us, because we don't use libc directly (Georg)
802 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
810 print "\nGenerating %s..." % config_h
812 # AIKSAURUS_H_LOCATION
813 if (conf.CheckCXXHeader("Aiksaurus.h")):
814 aik_location = '<Aiksaurus.h>'
815 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
816 aik_location = '<Aiksaurus/Aiksaurus.h>'
820 # determine headers to use
821 spell_opt = ARGUMENTS.get('spell', 'auto')
822 env['USE_ASPELL'] = False
823 env['USE_PSPELL'] = False
824 env['USE_ISPELL'] = False
825 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
826 spell_engine = 'USE_ASPELL'
827 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
828 spell_engine = 'USE_PSPELL'
829 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
830 spell_engine = 'USE_ISPELL'
834 if spell_engine is not None:
835 env[spell_engine] = True
837 if spell_opt == 'auto':
838 print "Warning: Can not locate any spell checker"
839 elif spell_opt != 'no':
840 print "Warning: Can not locate specified spell checker:", spell_opt
841 print 'Please check config.log for more information.'
844 # check arg types of select function
845 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
847 # check the size of wchar_t
848 sizeof_wchar_t = conf.CheckSizeOfWChar()
850 if sizeof_wchar_t == 0:
851 print 'Error: Can not determine the size of wchar_t.'
852 print 'Please check config.log for more information.'
856 # fill in the version info
857 env['VERSION_INFO'] = '''Configuration
859 Special build flags: %s
861 C Compiler flags: %s %s
863 C++ Compiler LyX flags: %s
864 C++ Compiler flags: %s %s
866 Linker user flags: %s
868 Builing directory: %s
871 include search path: %s
877 ''' % (platform_name,
878 env.subst('$CCFLAGS'), env.subst('$CC'),
879 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
880 env.subst('$CXX'), env.subst('$CXXFLAGS'),
881 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
882 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
883 env.subst('$LOCALLIBPATH'),
884 env.subst('$LIBPATH'), str(boost_libraries),
885 env.subst('$CPPPATH'),
886 frontend, packaging_method,
887 prefix, env['LYX_DATA_DIR'])
891 result = utils.createConfigFile(conf,
892 config_file = config_h,
893 config_pre = r'''/* config.h. Generated by SCons. */
898 * This file is part of LyX, the document processor.
899 * Licence details can be found in the file COPYING.
901 * This is the compilation configuration file for LyX.
902 * It was generated by scon.
903 * You might want to change some of the defaults if something goes wrong
904 * during the compilation.
911 ('io.h', 'HAVE_IO_H', 'c'),
912 ('limits.h', 'HAVE_LIMITS_H', 'c'),
913 ('locale.h', 'HAVE_LOCALE_H', 'c'),
914 ('process.h', 'HAVE_PROCESS_H', 'c'),
915 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
916 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
917 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
918 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
919 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
920 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
921 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
922 ('utime.h', 'HAVE_UTIME_H', 'c'),
923 ('direct.h', 'HAVE_DIRECT_H', 'c'),
924 ('istream', 'HAVE_ISTREAM', 'cxx'),
925 ('ios', 'HAVE_IOS', 'cxx'),
928 ('open', 'HAVE_OPEN', None),
929 ('chmod', 'HAVE_CHMOD', None),
930 ('close', 'HAVE_CLOSE', None),
931 ('popen', 'HAVE_POPEN', None),
932 ('pclose', 'HAVE_PCLOSE', None),
933 ('_open', 'HAVE__OPEN', None),
934 ('_close', 'HAVE__CLOSE', None),
935 ('_popen', 'HAVE__POPEN', None),
936 ('_pclose', 'HAVE__PCLOSE', None),
937 ('getpid', 'HAVE_GETPID', None),
938 ('_getpid', 'HAVE__GETPID', None),
939 ('mkdir', 'HAVE_MKDIR', None),
940 ('_mkdir', 'HAVE__MKDIR', None),
941 ('mktemp', 'HAVE_MKTEMP', None),
942 ('mkstemp', 'HAVE_MKSTEMP', None),
943 ('strerror', 'HAVE_STRERROR', None),
944 ('getcwd', 'HAVE_GETCWD', None),
945 ('setenv', 'HAVE_SETENV', None),
946 ('putenv', 'HAVE_PUTENV', None),
947 ('fcntl', 'HAVE_FCNTL', None),
948 ('mkfifo', 'HAVE_MKFIFO', None),
951 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
954 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
955 '#include <streambuf>\n#include <istream>'),
956 ('wchar_t', 'HAVE_WCHAR_T', None),
957 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
960 ('gdi32', 'HAVE_LIBGDI32'),
961 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
964 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
966 'Define is sys/types.h does not have pid_t',
970 (conf.CheckCXXGlobalCstd(),
972 'Define if your C++ compiler puts C library functions in the global namespace'
974 (conf.CheckMkdirOneArg(),
975 'MKDIR_TAKES_ONE_ARG',
976 'Define if mkdir takes only one argument.'
978 (conf.CheckIconvConst(),
980 'Define as const if the declaration of iconv() needs const.',
981 '#define ICONV_CONST const',
982 '#define ICONV_CONST',
984 (conf.CheckLC_MESSAGES(),
986 'Define if your <locale.h> file defines LC_MESSAGES.'
988 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
991 "Define to 1 if translation of program messages to the user's native anguage is requested.",
993 (env['nls'] and not included_gettext,
995 'Define to 1 if using system gettext library'
997 (env.has_key('concept_checks') and env['concept_checks'],
998 '_GLIBCXX_CONCEPT_CHECKS',
999 'libstdc++ concept checking'
1001 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1003 'libstdc++ debug mode'
1005 (env.has_key('stdlib_debug') and env['stdlib_debug'],
1006 '_GLIBCXX_DEBUG_PEDANTIC',
1007 'libstdc++ pedantic debug mode'
1009 (os.name != 'nt', 'BOOST_POSIX',
1010 'Indicates to boost < 1.34 which API to use (posix or windows).'
1012 (os.name != 'nt', 'BOOST_POSIX_API',
1013 'Indicates to boost 1.34 which API to use (posix or windows).'
1015 (os.name != 'nt', 'BOOST_POSIX_PATH',
1016 'Indicates to boost 1.34 which path style to use (posix or windows).'
1018 (spell_engine is not None, spell_engine,
1019 'Spell engine to use'
1021 # we need to know the byte order for unicode conversions
1022 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1023 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1027 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1029 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1030 'Define to the address where bug reports for this package should be sent.'),
1031 ('#define PACKAGE_NAME "%s"' % package_name,
1032 'Define to the full name of this package.'),
1033 ('#define PACKAGE_STRING "%s"' % package_string,
1034 'Define to the full name and version of this package.'),
1035 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1036 'Define to the one symbol short name of this package.'),
1037 ('#define PACKAGE_VERSION "%s"' % package_version,
1038 'Define to the version of this package.'),
1039 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1040 'Full version info'),
1041 ('#define LYX_DATE "%s"' % lyx_date,
1043 ('#define PROGRAM_SUFFIX "%s"' % program_suffix,
1044 'Program version suffix'),
1045 ('#define LYX_ABS_INSTALLED_DATADIR "%s"' % env.subst('$LYX_DATA_DIR').replace('\\', '/'),
1046 'Hard coded system support directory'),
1047 ('#define LYX_ABS_INSTALLED_LOCALEDIR "%s"' % env.subst('$LOCALEDIR').replace('\\', '/'),
1048 'Hard coded locale directory'),
1049 ('#define LYX_ABS_TOP_SRCDIR "%s"' % env.subst('$TOP_SRCDIR').replace('\\', '/'),
1050 'Top source directory'),
1051 ('#define BOOST_ALL_NO_LIB 1',
1052 'disable automatic linking of boost libraries.'),
1053 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1054 'Packaging method'),
1055 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1056 'Aiksaurus include file'),
1057 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1058 "Define to the type of arg 1 for `select'."),
1059 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1060 "Define to the type of arg 2, 3, 4 for `select'."),
1061 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1062 "Define to the type of arg 5 for `select'."),
1063 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1064 'Define to be the size of type wchar_t'),
1066 config_post = '''/************************************************************
1067 ** You should not need to change anything beyond this point */
1069 #ifndef HAVE_STRERROR
1070 #if defined(__cplusplus)
1073 char * strerror(int n);
1076 #include <../boost/config.h>
1082 # these keys are needed in env
1083 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1084 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1085 # USE_ASPELL etc does not go through result
1086 if result.has_key(key):
1087 env[key] = result[key]
1090 # if nls=yes and gettext=included, create intl/config.h
1091 # intl/libintl.h etc
1093 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1094 if env['nls'] and included_gettext:
1096 print "Creating %s..." % intl_config_h
1098 # create intl/config.h
1099 result = utils.createConfigFile(conf,
1100 config_file = intl_config_h,
1101 config_pre = r'''/* intl/config.h. Generated by SCons. */
1106 * This file is part of LyX, the document processor.
1107 * Licence details can be found in the file COPYING.
1109 * This is the compilation configuration file for LyX.
1110 * It was generated by scon.
1111 * You might want to change some of the defaults if something goes wrong
1112 * during the compilation.
1115 #ifndef _INTL_CONFIG_H
1116 #define _INTL_CONFIG_H
1119 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1120 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1121 ('string.h', 'HAVE_STRING_H', 'c'),
1122 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1123 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1124 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1125 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1126 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1127 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1128 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1131 ('getcwd', 'HAVE_GETCWD', None),
1132 ('stpcpy', 'HAVE_STPCPY', None),
1133 ('strcasecmp', 'HAVE_STRCASECMP', None),
1134 ('strdup', 'HAVE_STRDUP', None),
1135 ('strtoul', 'HAVE_STRTOUL', None),
1136 ('alloca', 'HAVE_ALLOCA', None),
1137 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1138 ('mempcpy', 'HAVE_MEMPCPY', None),
1139 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1140 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1141 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1142 ('setlocale', 'HAVE_SETLOCALE', None),
1143 ('tsearch', 'HAVE_TSEARCH', None),
1144 ('getegid', 'HAVE_GETEGID', None),
1145 ('getgid', 'HAVE_GETGID', None),
1146 ('getuid', 'HAVE_GETUID', None),
1147 ('wcslen', 'HAVE_WCSLEN', None),
1148 ('asprintf', 'HAVE_ASPRINTF', None),
1149 ('wprintf', 'HAVE_WPRINTF', None),
1150 ('snprintf', 'HAVE_SNPRINTF', None),
1151 ('printf', 'HAVE_POSIX_PRINTF', None),
1152 ('fcntl', 'HAVE_FCNTL', None),
1155 ('intmax_t', 'HAVE_INTMAX_T', None),
1156 ('long double', 'HAVE_LONG_DOUBLE', None),
1157 ('long long', 'HAVE_LONG_LONG', None),
1158 ('wchar_t', 'HAVE_WCHAR_T', None),
1159 ('wint_t', 'HAVE_WINT_T', None),
1160 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1161 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1167 (conf.CheckLC_MESSAGES(),
1169 'Define if your <locale.h> file defines LC_MESSAGES.'
1171 (conf.CheckIconvConst(),
1173 'Define as const if the declaration of iconv() needs const.',
1174 '#define ICONV_CONST const',
1175 '#define ICONV_CONST',
1177 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1178 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1180 "Define to 1 if you have the `intmax_t' type."
1182 (env.has_key('nls') and env['nls'],
1184 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1188 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1189 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1190 'Define to be the size of type wchar_t'),
1192 config_post = '#endif'
1195 # these keys are needed in env
1196 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1197 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1198 # USE_ASPELL etc does not go through result
1199 if result.has_key(key):
1200 env[key] = result[key]
1203 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1204 if env['nls'] and included_gettext:
1205 # libgnuintl.h.in => libintl.h
1206 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1207 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1208 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1209 [Copy('$TARGET', '$SOURCE')])
1212 # Finish auto-configuration
1215 #----------------------------------------------------------
1216 # Now set up our build process accordingly
1217 #----------------------------------------------------------
1219 if env['ICONV_LIB'] is None:
1222 system_libs = [env['ICONV_LIB']]
1223 if platform_name in ['win32', 'cygwin']:
1224 # the final link step needs stdc++ to succeed under mingw
1225 # FIXME: shouldn't g++ automatically link to stdc++?
1227 system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1229 system_libs += ['shlwapi', 'stdc++', 'z']
1230 elif platform_name == 'cygwin' and env['X11']:
1231 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1232 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1233 'resolv', 'pthread', 'z']
1235 system_libs += ['z']
1238 ('HAVE_LIBGDI32', 'gdi32'),
1239 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1240 ('USE_ASPELL', aspell_lib),
1241 ('USE_ISPELL', 'ispell'),
1242 ('USE_PSPELL', 'pspell'),
1247 system_libs.append(lib[1])
1250 # Build parameters CPPPATH etc
1253 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1256 # boost: for boost header files
1257 # BUILDDIR/src: for config.h
1258 # TOP_SRCDIR/src: for support/* etc
1260 env['CPPPATH'] += ['$BUILDDIR/src', '$TOP_SRCDIR/src']
1262 # Separating boost directories from CPPPATH stops scons from building
1263 # the dependency tree for boost header files, and effectively reduce
1264 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1265 # boost headers, the following is not 100% safe.
1266 # env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1267 env.PrependUnique(CCFLAGS = ['$INCPREFIX$BOOST_INC_PATH'])
1269 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1270 if env['nls'] and included_gettext:
1271 env['CPPPATH'].append('$BUILDDIR/intl')
1275 # A Link script for cygwin see
1276 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1277 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1280 if platform_name == 'cygwin':
1281 ld_script_path = '/tmp'
1282 ld_script = utils.installCygwinLDScript(ld_script_path)
1283 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1284 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1287 #---------------------------------------------------------
1288 # Frontend related variables (QTDIR etc)
1289 #---------------------------------------------------------
1292 # create a separate environment so that other files do not have
1293 # to be built with all the include directories etc
1295 if frontend == 'qt4':
1296 frontend_env = env.Copy()
1298 # handle qt related user specified paths
1299 # set environment so that moc etc can be found even if its path is not set properly
1300 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1301 frontend_env['QTDIR'] = frontend_env['qt_dir']
1302 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1303 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1304 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1305 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1306 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1308 # if separate qt_lib_path is given
1309 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1310 qt_lib_path = frontend_env.subst('$qt_lib_path')
1311 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1312 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1316 # if separate qt_inc_path is given
1317 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1318 qt_inc_path = frontend_env['qt_inc_path']
1322 # local qt4 toolset from
1323 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1325 # NOTE: I have to patch qt4.py since it does not automatically
1326 # process .C file!!! (add to cxx_suffixes )
1328 frontend_env.Tool('qt4', [scons_dir])
1329 frontend_env['QT_AUTOSCAN'] = 0
1330 frontend_env['QT4_AUTOSCAN'] = 0
1331 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1333 if qt_lib_path is None:
1334 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1335 if qt_inc_path is None:
1336 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1339 conf = Configure(frontend_env,
1341 'CheckPackage' : utils.checkPackage,
1342 'CheckCommand' : utils.checkCommand,
1347 # first: try pkg_config
1348 if frontend_env['HAS_PKG_CONFIG']:
1349 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1350 # FIXME: use pkg_config information?
1351 #frontend_env['QT4_PKG_CONFIG'] = succ
1352 # second: try to link to it
1354 # Under linux, I can test the following perfectly
1355 # Under windows, lib names need to passed as libXXX4.a ...
1356 if platform_name == 'win32':
1357 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1359 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1360 # still can not find it
1362 print 'Did not find qt libraries, exiting!'
1363 print 'Please check config.log for more information.'
1366 # Now, determine the correct suffix:
1367 qt_libs = ['QtCore', 'QtGui']
1368 if platform_name == 'win32':
1369 if mode == 'debug' and use_vc and \
1370 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1371 qt_lib_suffix = 'd4'
1372 use_qt_debug_libs = True
1375 use_qt_debug_libs = False
1377 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1378 qt_lib_suffix = '_debug'
1379 use_qt_debug_libs = True
1382 use_qt_debug_libs = False
1383 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1384 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1385 qtcore_lib = ['QtCore' + qt_lib_suffix]
1387 # check uic and moc commands for qt frontends
1388 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1389 print 'uic or moc command is not found for frontend', frontend
1392 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1393 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1394 # For some unknown changes in msvc or qt, this is no longer needed.
1396 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1397 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1398 env.File('$BUILDDIR/lyx.exe.manifest').path]
1400 frontend_env = conf.Finish()
1405 print env['VERSION_INFO']
1408 # Mingw command line may be too short for our link usage,
1409 # Here we use a trick from scons wiki
1410 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1412 # I also would like to add logging (commands only) capacity to the
1414 logfile = env.get('logfile', default_log_file)
1415 if logfile != '' or platform_name == 'win32':
1417 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1418 info = '''# This is a log of commands used by scons to build lyx
1422 ''' % (time.asctime(), ' '.join(sys.argv),
1423 env['VERSION_INFO'].replace('\n','\n# ')) )
1428 # -h will print out help info
1429 Help(opts.GenerateHelpText(env))
1432 #----------------------------------------------------------
1434 #----------------------------------------------------------
1435 # this has been the source of problems on some platforms...
1436 # I find that I need to supply it with full path name
1437 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1438 # this usage needs further investigation.
1439 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1440 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1441 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1442 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1443 frontend_env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1445 print "Building all targets recursively"
1447 def libExists(libname):
1448 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1449 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1452 if (included_boost and not libExists('included_boost_regex')) or 'boost' in BUILD_TARGETS:
1456 for lib in boost_libs:
1457 boostlib = env.StaticLibrary(
1458 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1459 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)],
1460 # do not use global CPPPATH because src/config.h will mess up with boost/config.h
1461 CPPPATH = ['$BUILDDIR/boost'] + extra_inc_paths,
1462 CCFLAGS = ['$CCFLAGS', '$INCPREFIX$TOP_SRCDIR/boost', '-DBOOST_USER_CONFIG="<config.h>"']
1464 Alias('boost', boostlib)
1467 if (included_gettext and not libExists('included_intl')) or 'intl' in BUILD_TARGETS:
1472 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1473 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1474 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1476 '-DENABLE_RELOCATABLE=1',
1478 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1480 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1481 '-Drelocate=libintl_relocate',
1482 '-DDEPENDS_ON_LIBICONV=1',
1486 INTL_CCFLAGS.extend(['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1488 intl = env.StaticLibrary(
1489 target = '$LOCALLIBPATH/included_intl',
1491 CCFLAGS = INTL_CCFLAGS,
1492 # do not use global CPPPATH because src/config.h will mess up with intl/config.h
1493 CPPPATH = ['$BUILDDIR/intl'] + extra_inc_paths,
1494 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1501 support = frontend_env.StaticLibrary(
1502 target = '$LOCALLIBPATH/support',
1503 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files] + \
1504 ['$BUILDDIR/src/support/minizip/%s' % x for x in src_support_minizip_files],
1508 '-DQT_CLEAN_NAMESPACE',
1513 CPPPATH = ['$CPPPATH', '$TOP_SRCDIR/src/support/minizip']
1515 Alias('support', support)
1521 mathed = env.StaticLibrary(
1522 target = '$LOCALLIBPATH/mathed',
1523 source = ['$BUILDDIR/src/mathed/%s' % x for x in src_mathed_files]
1525 Alias('mathed', mathed)
1531 insets = env.StaticLibrary(
1532 target = '$LOCALLIBPATH/insets',
1533 source = ['$BUILDDIR/src/insets/%s' % x for x in src_insets_files]
1535 Alias('insets', insets)
1541 frontends = env.StaticLibrary(
1542 target = '$LOCALLIBPATH/frontends',
1543 source = ['$BUILDDIR/src/frontends/%s' % x for x in src_frontends_files]
1545 Alias('frontends', frontends)
1551 graphics = env.StaticLibrary(
1552 target = '$LOCALLIBPATH/graphics',
1553 source = ['$BUILDDIR/src/graphics/%s' % x for x in src_graphics_files]
1555 Alias('graphics', graphics)
1561 frontend_env['QT4_MOCHPREFIX'] = ''
1562 frontend_env['QT4_MOCHSUFFIX'] = '_moc.cpp'
1564 # tells scons how to get these moced files, although not all moced files are needed
1565 # (or are actually generated).
1566 qt4_moced_files = [frontend_env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1567 for x in src_frontends_qt4_header_files ]
1568 resources = [frontend_env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1569 for x in src_frontends_qt4_ui_files]
1572 # moc qt4_moc_files, the moced files are included in the original files
1574 qt4 = frontend_env.StaticLibrary(
1575 target = '$LOCALLIBPATH/qt4',
1576 source = ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1580 '$BUILDDIR/src/images',
1581 '$BUILDDIR/src/frontends',
1582 '$BUILDDIR/src/frontends/qt4',
1583 '$BUILDDIR/src/frontends/qt4/ui',
1588 '-DQT_CLEAN_NAMESPACE',
1600 if env['HAVE_FCNTL']:
1601 client = frontend_env.Program(
1602 target = '$BUILDDIR/src/client/lyxclient',
1603 LIBS = ['support'] + intl_libs + system_libs +
1604 socket_libs + boost_libraries + qtcore_lib,
1605 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1606 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1608 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1609 client, [Copy('$TARGET', '$SOURCE')]))
1612 Alias('client', client)
1618 for file in src_tex2lyx_copied_files:
1619 frontend_env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1620 [Copy('$TARGET', '$SOURCE')])
1622 tex2lyx = frontend_env.Program(
1623 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1624 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1625 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1626 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1627 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$CPPPATH'],
1628 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1629 CCFLAGS = ['$CCFLAGS', '-DTEX2LYX'],
1631 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1632 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1633 Alias('tex2lyx', tex2lyx)
1639 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1640 src_post_files.append('ASpell.cpp')
1641 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1642 src_post_files.append('PSpell.cpp')
1643 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1644 src_post_files.append('ISpell.cpp')
1646 # msvc requires at least one source file with main()
1647 # so I exclude main.cpp from lyxbase
1648 lyxbase_pre = env.StaticLibrary(
1649 target = '$LOCALLIBPATH/lyxbase_pre',
1650 source = ['$BUILDDIR/src/%s' % x for x in src_pre_files]
1652 lyxbase_post = env.StaticLibrary(
1653 target = '$LOCALLIBPATH/lyxbase_post',
1654 source = ["$BUILDDIR/src/%s" % x for x in src_post_files]
1656 Alias('lyxbase', lyxbase_pre)
1657 Alias('lyxbase', lyxbase_post)
1661 # Build lyx with given frontend
1663 lyx = frontend_env.Program(
1664 target = '$BUILDDIR/lyx',
1665 source = ['$BUILDDIR/src/main.cpp'] + \
1666 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1686 if use_vc and 'msvs_projects' in BUILD_TARGETS:
1687 def build_project(target, full_target = None, src = [], inc = [], res = []):
1688 ''' build mavs project files
1689 target: alias (correspond to directory name)
1690 full_target: full path/filename of the target
1695 For non-debug-able targets like static libraries, target (alias) is
1696 enough to build the target. For executable targets, msvs need to know
1697 the full path to start debug them.
1700 proj = env.MSVSProject(
1701 target = target + env['MSVSPROJECTSUFFIX'],
1702 # this allows easy access to header files (along with source)
1703 srcs = [env.subst(x) for x in src + inc],
1704 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1705 localincs = [env.subst(x) for x in inc],
1706 resources = [env.subst(x) for x in res],
1707 buildtarget = full_target,
1710 Alias('msvs_projects', proj)
1712 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1713 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1714 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1716 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1717 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1718 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1720 build_project('lyx',
1721 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1722 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1723 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1724 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1725 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1726 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1727 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1728 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1729 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1730 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1731 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1732 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1733 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1734 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1735 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1736 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1739 if 'update_po' in BUILD_TARGETS:
1743 print 'Updating po/*.po files...'
1745 # whether or not update po files
1746 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1747 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1749 # rebuild POTFILES.in
1750 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1751 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1752 src_extra_src_files] + \
1753 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1754 src_support_extra_header_files + src_support_extra_src_files] + \
1755 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1756 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1757 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1758 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1759 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files + src_frontends_qt4_moc_files] + \
1760 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1761 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1763 Alias('update_po', POTFILES_in)
1764 # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n
1765 # and combine them to lyx.po
1766 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1767 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1768 env.Command('$BUILDDIR/po/all.po',
1769 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1770 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1771 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1772 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1773 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files + lib_layouts_module_files],
1774 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1775 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1776 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1777 env.Command('$BUILDDIR/po/ui_l10n.pot',
1778 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1779 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1780 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1781 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
1783 ['$MSGUNIQ -o $TARGET $SOURCE',
1784 '''$XGETTEXT --default-domain=${TARGET.base} \
1785 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
1786 --language=C++ --join-existing \
1787 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
1788 --files-from=$TOP_SRCDIR/po/POTFILES.in \
1789 --copyright-holder="LyX Developers" \
1790 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
1792 env.Depends(lyx_po, POTFILES_in)
1793 # copy lyx.po to lyx.pot
1794 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
1795 Copy('$TARGET', '$SOURCE'))
1798 # files to translate
1799 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
1800 # possibly *only* handle these languages
1802 if env.has_key('languages'):
1803 languages = env.make_list(env['languages'])
1804 # merge. if I use lan.po as $TARGET, it will be removed
1805 # before it is merged. In this builder,
1806 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
1807 # and is copied to po/lang.po
1808 env['BUILDERS']['msgmerge'] = Builder(action=[
1809 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
1810 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
1812 # for each po file, generate pot
1813 for po_file in transfiles:
1815 fname = os.path.split(po_file)[1]
1817 country = fname.split('.')[0]
1819 if not languages or country in languages:
1820 # merge po files, the generated lan.po_new file is copied to lan.po file.
1821 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
1822 env.Depends(po, POTFILES_in)
1823 Alias('update_po', po)
1826 # if 'install' is not in the target, do not process this
1827 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
1829 # this part is a bit messy right now. Since scons will provide
1830 # --DESTDIR option soon, at least the dest_dir handling can be
1839 # files to translate
1840 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1841 # possibly *only* handle these languages
1843 if env.has_key('languages'):
1844 languages = env.make_list(env['lanauges'])
1845 # use defulat msgfmt
1847 if not env['MSGFMT']:
1848 print 'msgfmt does not exist. Can not process po files'
1851 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
1853 for f in transfiles:
1855 fname = os.path.split(f)[1]
1857 country = fname.split('.')[0]
1859 if not languages or country in languages:
1860 gmo_files.extend(env.Transfiles(f))
1861 # how to join dest_dir and prefix
1862 def joinPaths(path1, path2):
1863 ''' join path1 and path2, do not use os.path.join because
1864 under window, c:\destdir\d:\program is invalid '''
1866 return os.path.normpath(path2)
1867 # separate drive letter
1868 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
1869 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
1870 return os.path.join(os.path.normpath(path1), path[1:])
1872 # install to dest_dir/prefix
1873 dest_dir = env.get('DESTDIR', '')
1874 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
1875 # create the directory if needed
1876 if not os.path.isdir(dest_prefix_dir):
1878 os.makedirs(dest_prefix_dir)
1881 if not os.path.isdir(dest_prefix_dir):
1882 print 'Can not create directory', dest_prefix_dir
1885 if env.has_key('exec_prefix'):
1886 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
1888 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
1890 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
1892 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
1893 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
1894 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
1895 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
1899 # install executables (lyxclient may be None)
1902 version_suffix = program_suffix
1906 # install lyx, if in release mode, try to strip the binary
1907 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
1908 # create a builder to strip and install
1909 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
1911 # install executables
1912 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
1915 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
1916 target = os.path.join(bin_dest_dir, target_name)
1917 if env['BUILDERS'].has_key('StripInstallAs'):
1918 env.StripInstallAs(target, obj)
1920 env.InstallAs(target, obj)
1921 Alias('install', target)
1925 for (dir,files) in [
1927 ('bind', lib_bind_files),
1928 ('bind/de', lib_bind_de_files),
1929 ('bind/fi', lib_bind_fi_files),
1930 ('bind/pt', lib_bind_pt_files),
1931 ('bind/sv', lib_bind_sv_files),
1932 ('doc', lib_doc_files),
1933 ('doc/biblio', lib_doc_biblio_files),
1934 ('doc/clipart', lib_doc_clipart_files),
1935 ('doc/cs', lib_doc_cs_files),
1936 ('doc/da', lib_doc_da_files),
1937 ('doc/de', lib_doc_de_files),
1938 ('doc/de/clipart', lib_doc_de_clipart_files),
1939 ('doc/es', lib_doc_es_files),
1940 ('doc/es/biblio', lib_doc_es_biblio_files),
1941 ('doc/es/clipart', lib_doc_es_clipart_files),
1942 ('doc/eu', lib_doc_eu_files),
1943 ('doc/fr', lib_doc_fr_files),
1944 ('doc/he', lib_doc_he_files),
1945 ('doc/hu', lib_doc_hu_files),
1946 ('doc/it', lib_doc_it_files),
1947 ('doc/nl', lib_doc_nl_files),
1948 ('doc/nb', lib_doc_nb_files),
1949 ('doc/pl', lib_doc_pl_files),
1950 ('doc/pt', lib_doc_pt_files),
1951 ('doc/ro', lib_doc_ro_files),
1952 ('doc/ru', lib_doc_ru_files),
1953 ('doc/sk', lib_doc_sk_files),
1954 ('doc/sl', lib_doc_sl_files),
1955 ('doc/sv', lib_doc_sv_files),
1956 ('examples', lib_examples_files),
1957 ('examples/ca', lib_examples_ca_files),
1958 ('examples/cs', lib_examples_cs_files),
1959 ('examples/da', lib_examples_da_files),
1960 ('examples/de', lib_examples_de_files),
1961 ('examples/es', lib_examples_es_files),
1962 ('examples/eu', lib_examples_eu_files),
1963 ('examples/fa', lib_examples_fa_files),
1964 ('examples/fr', lib_examples_fr_files),
1965 ('examples/he', lib_examples_he_files),
1966 ('examples/hu', lib_examples_hu_files),
1967 ('examples/it', lib_examples_it_files),
1968 ('examples/nl', lib_examples_nl_files),
1969 ('examples/pl', lib_examples_pl_files),
1970 ('examples/pt', lib_examples_pt_files),
1971 ('examples/ru', lib_examples_ru_files),
1972 ('examples/sl', lib_examples_sl_files),
1973 ('examples/ro', lib_examples_ro_files),
1974 ('fonts', lib_fonts_files),
1975 ('images', lib_images_files),
1976 ('images/math', lib_images_math_files),
1977 ('kbd', lib_kbd_files),
1978 ('layouts', lib_layouts_files + lib_layouts_inc_files),
1979 ('lyx2lyx', lib_lyx2lyx_files),
1980 ('scripts', lib_scripts_files),
1981 ('templates', lib_templates_files),
1982 ('tex', lib_tex_files),
1983 ('ui', lib_ui_files)]:
1984 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
1985 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
1986 Alias('install', dirs)
1988 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
1989 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
1990 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
1991 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
1992 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
1993 sys.path.append(share_dest_dir + '/lyx2lyx')
1995 # generate TOC files for each doc
1996 languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
1998 for lang in languages.keys():
1999 if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2000 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2003 # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2004 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2006 # this is for English
2007 toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2010 env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2011 Alias('install', tocs)
2013 if platform_name == 'cygwin':
2014 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2015 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2016 '%s-%s.README' % (package, package_cygwin_version))
2017 env.InstallAs(Cygwin_README,
2018 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2019 Alias('install', Cygwin_README)
2020 # also a directory /usr/share/doc/lyx for README etc
2021 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2022 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2023 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2024 Alias('install', Cygwin_Doc)
2025 # cygwin fonts also need to be installed
2026 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2027 env.Install(Cygwin_fonts,
2028 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2029 for file in win32_bakoma_fonts])
2030 Alias('install', Cygwin_fonts)
2031 # we also need a post installation script
2032 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2033 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2034 env.Install(postinstall_path, tmp_script)
2035 Alias('install', postinstall_path)
2037 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2038 env.subst('$TOP_SRCDIR/lyx.man'))
2039 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2040 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2041 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2042 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2043 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2044 x in ['lyx', 'tex2lyx', 'lyxclient']])
2046 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2047 for gmo in gmo_files:
2048 lan = os.path.split(str(gmo))[1].split('.')[0]
2049 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2050 env.InstallAs(dest_file, gmo)
2051 Alias('install', dest_file)
2054 if 'installer' in BUILD_TARGETS:
2056 # build windows installer using NSIS
2059 # There is a nsis builder on scons wiki but it does not work with
2060 # our lyx.nsi because it does not dig through all the include directives
2061 # and find the dependencies automatically. Also, it can not parse
2062 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2063 # something rely on date.
2064 # Because of this, I am doing a simple nsis builder here.
2065 if platform_name != 'win32':
2066 print 'installer target is only available for windows platform'
2068 if mode != 'release':
2069 print 'installer has to be built in release mode (use option mode=release)'
2071 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2072 % x for x in development_Win32_packaging_installer] + \
2073 ['$TOP_SRCDIR/development/Win32/packaging/installer/components/%s' \
2074 % x for x in development_Win32_packaging_installer_components] + \
2075 ['$TOP_SRCDIR/development/Win32/packaging/installer/dialogs/%s' \
2076 % x for x in development_Win32_packaging_installer_dialogs] + \
2077 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2078 % x for x in development_Win32_packaging_installer_graphics] + \
2079 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2080 % x for x in development_Win32_packaging_installer_include] + \
2081 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2082 % x for x in development_Win32_packaging_installer_lang]
2083 if env.has_key('NSIS') and env['NSIS'] is not None:
2084 # create a builder to strip and install
2085 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2087 print 'No nsis compiler is found. Existing...'
2089 if not env.has_key('win_installer') or env['win_installer'] is None:
2091 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2093 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2094 # provide default setting
2095 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2096 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2097 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2098 print 'Development dependency package is not found.'
2101 env['deps_dir'] = env.Dir('$deps_dir').abspath
2103 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2104 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2105 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2106 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2108 env['bundle_dir'] = None
2109 # if absolute path is given, use it, otherwise, write to current directory
2110 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2111 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2112 env.Append(NSISDEFINES={
2113 'ExeFile':env['win_installer'],
2114 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2115 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2116 'FilesDeps':env['deps_dir'],
2117 'FilesBundle':env['bundle_dir'],
2119 installer = env.installer(env['win_installer'],
2120 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2121 # since I can not use a scanner, explicit dependent is required
2122 env.Depends(installer, 'install')
2123 env.Depends(installer, installer_files)
2124 env.Alias('installer', installer)
2125 # also generate bundle?
2126 if env.has_key('bundle') and env['bundle']:
2127 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2128 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2129 print 'Use bundle_dir option to specify'
2131 # generator of the builder will add bundle stuff depending on output name
2132 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2133 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2134 env.Depends(bundle_installer, 'install')
2135 env.Depends(bundle_installer, installer_files)
2136 env.Alias('installer', bundle_installer)
2139 Alias('all', ['lyx', 'client', 'tex2lyx'])