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')])
33 # scons_utils.py defines a few utility function
34 import scons_utils as utils
35 # import all file lists
36 from scons_manifest import *
38 # scons asks for 1.5.2, lyx requires 2.3
39 EnsurePythonVersion(2, 3)
40 # Please use at least version 0.97
41 EnsureSConsVersion(0, 97)
43 #----------------------------------------------------------
45 #----------------------------------------------------------
47 # some global settings
49 # get version number from configure.ac so that JMarc does
50 # not have to change SConstruct during lyx release
51 package_version, majmin_ver, lyx_date = utils.getVerFromConfigure(top_src_dir)
52 package_cygwin_version = '%s-1' % package_version
53 boost_version = ['1_34']
55 if 'svn' in package_version:
57 default_build_mode = 'debug'
60 default_build_mode = 'release'
63 package_bugreport = 'lyx-devel@lists.lyx.org'
65 package_tarname = 'lyx'
66 package_string = '%s %s' % (package_name, package_version)
68 # various cache/log files
69 default_log_file = 'scons_lyx.log'
70 opt_cache_file = 'opt.cache'
73 #----------------------------------------------------------
74 # platform dependent settings
75 #----------------------------------------------------------
78 platform_name = 'win32'
79 default_prefix = 'c:/program files/lyx'
80 default_with_x = False
81 default_packaging_method = 'windows'
82 elif os.name == 'posix' and sys.platform != 'cygwin':
83 platform_name = sys.platform
84 default_prefix = '/usr/local'
86 default_packaging_method = 'posix'
87 elif os.name == 'posix' and sys.platform == 'cygwin':
88 platform_name = 'cygwin'
89 default_prefix = '/usr'
91 default_packaging_method = 'posix'
92 elif os.name == 'darwin':
93 platform_name = 'macosx'
94 # FIXME: macOSX default prefix?
96 default_with_x = False
97 default_packaging_method = 'macosx'
98 else: # unsupported system, assume posix behavior
99 platform_name = 'others'
101 default_with_x = True
102 default_packaging_method = 'posix'
104 #---------------------------------------------------------
106 #----------------------------------------------------------
108 # You can set perminant default values in config.py
109 if os.path.isfile('config.py'):
110 print "Getting options from config.py..."
111 print open('config.py').read()
113 opts = Options(['config.py'])
116 EnumOption('frontend', 'Main GUI', 'qt4',
117 allowed_values = ('qt4',) ),
118 # debug or release build
119 EnumOption('mode', 'Building method', default_build_mode,
120 allowed_values = ('debug', 'release') ),
123 'Use included, system boost library, or try sytem boost first.',
124 'auto', allowed_values = (
125 'auto', # detect boost, if not found, use included
126 'included', # always use included boost
127 'system', # always use system boost, fail if can not find
130 EnumOption('gettext',
131 'Use included, system gettext library, or try sytem gettext first',
132 'auto', allowed_values = (
133 'auto', # detect gettext, if not found, use included
134 'included', # always use included gettext
135 'system', # always use system gettext, fail if can not find
138 EnumOption('spell', 'Choose spell checker to use.', 'auto',
139 allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
141 EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
142 allowed_values = ('windows', 'posix', 'macosx')),
144 BoolOption('fast_start', 'This option is obsolete.', False),
145 # No precompiled header support (too troublesome to make it work for msvc)
146 # BoolOption('pch', 'Whether or not use pch', False),
147 # enable assertion, (config.h has ENABLE_ASSERTIOS
148 BoolOption('assertions', 'Use assertions', True),
149 # config.h define _GLIBCXX_CONCEPT_CHECKS
150 # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
151 BoolOption('concept_checks', 'Enable concept checks', True),
153 BoolOption('nls', 'Whether or not use native language support', True),
155 BoolOption('profiling', 'Whether or not enable profiling', False),
156 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
157 BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
159 BoolOption('X11', 'Use x11 windows system', default_with_x),
160 # use MS VC++ to build lyx
161 BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
163 PathOption('qt_dir', 'Path to qt directory', None),
165 PathOption('qt_inc_path', 'Path to qt include directory', None),
167 PathOption('qt_lib_path', 'Path to qt library directory', None),
168 # extra include and libpath
169 PathOption('extra_inc_path', 'Extra include path', None),
171 PathOption('extra_lib_path', 'Extra library path', None),
173 PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
175 PathOption('extra_inc_path1', 'Extra include path', None),
177 PathOption('extra_lib_path1', 'Extra library path', None),
179 ('rebuild', 'Obsolete option', None),
180 # can be set to a non-existing directory
181 ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
182 # replace the default name and location of the windows installer
183 ('win_installer', 'name or full path to the windows installer', None),
184 # the deps package used to create minimal installer (qt and other libraries)
185 ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
186 # whether or not build bundle installer
187 BoolOption('bundle', 'Whether or not build bundle installer', False),
188 # the bundle directory, containing bundled applications
189 PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
190 # build directory, will use $mode if not set
191 ('build_dir', 'Build directory', None),
193 ('version_suffix', 'install lyx as lyx-suffix', None),
194 # how to load options
195 ('load_option', '''load option from previous scons run. option can be
196 yes (default): load all options
197 no: do not load any option
198 opt1,opt2: load specified options
199 -opt1,opt2: load all options other than specified ones''', 'yes'),
201 ('optimization', 'optimization CCFLAGS option.', None),
203 PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
205 ('logfile', 'save commands (not outputs) to logfile', default_log_file),
206 # provided for backward compatibility
207 ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
208 # environment variable can be set as options.
209 ('DESTDIR', 'install to DESTDIR', None),
210 ('CC', 'replace default $CC', None),
211 ('LINK', 'replace default $LINK', None),
212 ('CPP', 'replace default $CPP', None),
213 ('CXX', 'replace default $CXX', None),
214 ('CXXCPP', 'replace default $CXXCPP', None),
215 ('CCFLAGS', 'replace default $CCFLAGS', None),
216 ('CPPFLAGS', 'replace default $CPPFLAGS', None),
217 ('LINKFLAGS', 'replace default $LINKFLAGS', None),
221 all_options = [x.key for x in opts.options]
223 # copied from SCons/Options/BoolOption.py
224 # We need to use them before a boolean ARGUMENTS option is available
226 true_strings = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
227 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
229 if ARGUMENTS.has_key('fast_start'):
230 print 'fast_start option is obsolete'
232 # if load_option=yes (default), load saved comand line options
234 # This option can take value yes/no/opt1,opt2/-opt1,opt2
235 # and tries to be clever in choosing options to load
236 if (not ARGUMENTS.has_key('load_option') or \
237 ARGUMENTS['load_option'] not in false_strings) \
238 and os.path.isfile(opt_cache_file):
239 cache_file = open(opt_cache_file)
240 opt_cache = cPickle.load(cache_file)
242 # import cached options, but we should ignore qt_dir when frontend changes
243 if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
244 and ARGUMENTS['frontend'] != opt_cache['frontend'] \
245 and opt_cache.has_key('qt_dir'):
246 opt_cache.pop('qt_dir')
247 # and we do not cache some options (dest_dir is obsolete)
248 for arg in ['load_option', 'dest_dir', 'bundle']:
249 if opt_cache.has_key(arg):
251 # remove obsolete cached keys (well, SConstruct is evolving. :-)
252 for arg in opt_cache.keys():
253 if arg not in all_options:
254 print 'Option %s is obsolete, do not load it' % arg
256 # now, if load_option=opt1,opt2 or -opt1,opt2
257 if ARGUMENTS.has_key('load_option') and \
258 ARGUMENTS['load_option'] not in true_strings + false_strings:
259 # if -opt1,opt2 is specified, do not load these options
260 if ARGUMENTS['load_option'][0] == '-':
261 for arg in ARGUMENTS['load_option'][1:].split(','):
262 if opt_cache.has_key(arg):
264 # if opt1,opt2 is specified, only load specified options
266 args = ARGUMENTS['load_option'].split(',')
267 for arg in opt_cache.keys():
270 # now restore options as if entered from command line
271 for key in opt_cache.keys():
272 if not ARGUMENTS.has_key(key):
273 ARGUMENTS[key] = opt_cache[key]
274 print "Restoring cached option %s=%s" % (key, ARGUMENTS[key])
277 # check if there is unused (or misspelled) argument
278 for arg in ARGUMENTS.keys():
279 if arg not in all_options:
281 print "Unknown option '%s'... exiting." % arg
283 print "Available options are (check 'scons -help' for details):"
284 print ' ' + '\n '.join(textwrap.wrap(', '.join(all_options)))
288 cache_file = open(opt_cache_file, 'w')
289 cPickle.dump(ARGUMENTS, cache_file)
292 #---------------------------------------------------------
293 # Setting up environment
294 #---------------------------------------------------------
296 # I do not really like ENV=os.environ, but you may add it
297 # here if you experience some environment related problem
298 env = Environment(options = opts)
300 # set individual variables since I do not really like ENV = os.environ
301 env['ENV']['PATH'] = os.environ.get('PATH')
302 env['ENV']['HOME'] = os.environ.get('HOME')
303 # these are defined for MSVC
304 env['ENV']['LIB'] = os.environ.get('LIB')
305 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
307 # for simplicity, use var instead of env[var]
308 frontend = env['frontend']
309 prefix = env['prefix']
312 if platform_name == 'win32':
313 if env.has_key('use_vc'):
314 use_vc = env['use_vc']
315 if WhereIs('cl.exe') is None:
316 print "cl.exe is not found. Are you using the MSVC environment?"
318 elif WhereIs('cl.exe') is not None:
325 if env.has_key('build_dir') and env['build_dir'] is not None:
326 env['BUILDDIR'] = env['build_dir']
328 # Determine the name of the build $mode
329 env['BUILDDIR'] = '#' + mode
331 # all built libraries will go to build_dir/libs
332 # (This is different from the make file approach)
333 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
334 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
337 # Here is a summary of variables defined in env
339 # 2. undefined options with a non-None default value
340 # 3. compiler commands and flags like CCFLAGS.
341 # MSGFMT used to process po files
342 # 4. Variables that will be used to replace variables in some_file.in
343 # lib/lyx2lyx/lyx2lyx_version.py.in
346 # full path name is used to build msvs project files
347 # and to replace TOP_SRCDIR in package.C
348 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
350 # determine share_dir etc
351 packaging_method = env.get('packaging')
352 if packaging_method == 'windows':
353 share_dir = 'Resources'
354 man_dir = 'Resources/man/man1'
355 locale_dir = 'Resources/locale'
357 share_dir = 'share/lyx'
358 locale_dir = 'share/locale'
359 if platform_name == 'cygwin':
360 man_dir = 'share/man/man1'
364 # program suffix: can be yes, or a string
365 if env.has_key('version_suffix'):
366 if env['version_suffix'] in true_strings:
367 program_suffix = package_version
368 elif env['version_suffix'] in false_strings:
371 program_suffix = env['version_suffix']
376 # whether or not add suffix to file and directory names
377 add_suffix = packaging_method != 'windows'
378 # Absolute data directory
379 if mode == 'release':
381 env['LYX_DATA_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
383 env['LYX_DATA_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
385 # in the debug mode, use $TOP_SRCDIR/lib to make sure lyx can be started from anyway
386 # by using this directory as data directory
387 env['LYX_DATA_DIR'] = os.path.join(env.subst('$TOP_SRCDIR'), 'lib')
388 # we need absolute path for package.C
389 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
392 #---------------------------------------------------------
393 # Setting building environment (Tools, compiler flags etc)
394 #---------------------------------------------------------
396 # Since Tool('mingw') will reset CCFLAGS etc, this should be
397 # done before getEnvVariable
398 if platform_name == 'win32':
404 env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
405 # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
407 env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
410 # we differentiate between hard-coded options and default options
411 # hard-coded options are required and will always be there
412 # default options can be replaced by enviromental variables or command line options
413 CCFLAGS_required = []
414 LINKFLAGS_required = []
417 # if we use ms vc, the commands are fine (cl.exe and link.exe)
419 # C4819: The file contains a character that cannot be represented
420 # in the current code page (number)
421 # C4996: foo was decleared deprecated
422 CCFLAGS_required.append('/EHsc')
424 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
426 CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
428 # for debug/release mode
429 if env.has_key('optimization') and env['optimization'] is not None:
430 # if user supplies optimization flags, use it anyway
431 CCFLAGS_required.extend(env['optimization'].split())
432 # and do not use default
433 set_default_optimization_flags = False
435 set_default_optimization_flags = True
439 CCFLAGS_required.append('/Zi')
440 LINKFLAGS_required.extend(['/debug', '/map'])
442 CCFLAGS_required.append('-g')
443 CCFLAGS_default.append('-O')
444 elif mode == 'release' and set_default_optimization_flags:
446 CCFLAGS_default.append('/O2')
448 CCFLAGS_default.append('-O2')
450 # msvc uses separate tools for profiling
451 if env.has_key('profiling') and env['profiling']:
453 print 'Visual C++ does not use profiling options'
455 CCFLAGS_required.append('-pg')
456 LINKFLAGS_required.append('-pg')
458 if env.has_key('warnings') and env['warnings']:
460 CCFLAGS_default.append('/W2')
462 # Note: autotools detect gxx version and pass -W for 3.x
463 # and -Wextra for other versions of gcc
464 CCFLAGS_default.append('-Wall')
466 # Now, set the variables as follows:
467 # 1. if command line option exists: replace default
468 # 2. then if s envronment variable exists: replace default
469 # 3. set variable to required + default
470 def setEnvVariable(env, name, required = None, default = None, split = True):
471 ''' env: environment to set variable
473 required: hardcoded options
474 default: default options that can be replaced by command line or
475 environment variables
476 split: whether or not split obtained variable like '-02 -g'
478 # 1. ARGUMENTS is already set to env[name], override default.
479 if ARGUMENTS.has_key(name):
480 # env[name] may be rewritten when building tools are reloaded
481 # if that is the case, commandline option will override it.
482 env[name] = ARGUMENTS[name]
484 # then use environment default
485 elif os.environ.has_key(name):
486 print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
487 default = os.environ[name]
489 default = default.split()
490 # the real value should be env[name] + default + required
493 if env.has_key(name):
494 value = str(env[name]).split()
495 if required is not None:
497 if default is not None:
501 if env.has_key(name):
502 value = str(env[name])
503 if required is not None:
504 value += " " + required
505 if default is not None:
506 value += " " + default
508 # print name, env[name]
510 setEnvVariable(env, 'DESTDIR', split=False)
511 setEnvVariable(env, 'CC')
512 setEnvVariable(env, 'LINK')
513 setEnvVariable(env, 'CPP')
514 setEnvVariable(env, 'CXX')
515 setEnvVariable(env, 'CXXCPP')
516 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
517 setEnvVariable(env, 'CXXFLAGS')
518 setEnvVariable(env, 'CPPFLAGS')
519 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
521 # if DESTDIR is not set...
522 if env.has_key('dest_dir'):
523 print "This option is obsolete. Please use DESTDIR instead."
524 env['DESTDIR'] = env['dest_dir']
527 # extra_inc_path and extra_lib_path
530 if env.has_key('extra_inc_path') and env['extra_inc_path']:
531 extra_inc_paths.append(env['extra_inc_path'])
532 if env.has_key('extra_lib_path') and env['extra_lib_path']:
533 env.AppendUnique(LIBPATH = [env['extra_lib_path']])
534 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
535 extra_inc_paths.append(env['extra_inc_path1'])
536 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
537 env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
538 if env.has_key('extra_bin_path') and env['extra_bin_path']:
539 # only the first one is needed (a scons bug?)
540 os.environ['PATH'] += os.pathsep + env['extra_bin_path']
541 env.PrependENVPath('PATH', env['extra_bin_path'])
542 # extra_inc_paths will be used later by intlenv etc
543 env.AppendUnique(CPPPATH = extra_inc_paths)
546 #----------------------------------------------------------
548 #----------------------------------------------------------
550 conf = Configure(env,
552 'CheckPkgConfig' : utils.checkPkgConfig,
553 'CheckPackage' : utils.checkPackage,
554 'CheckMkdirOneArg' : utils.checkMkdirOneArg,
555 'CheckSelectArgType' : utils.checkSelectArgType,
556 'CheckBoostLibraries' : utils.checkBoostLibraries,
557 'CheckCommand' : utils.checkCommand,
558 'CheckNSIS' : utils.checkNSIS,
559 'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
560 'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
561 'CheckIconvConst' : utils.checkIconvConst,
562 'CheckSizeOfWChar' : utils.checkSizeOfWChar,
563 'CheckDeclaration' : utils.checkDeclaration,
567 # When using msvc, windows.h is required
568 if use_vc and not conf.CheckCHeader('windows.h'):
569 print 'Windows.h is not found. Please install Windows Platform SDK.'
570 print 'Please check config.log for more information.'
573 # pkg-config? (if not, we use hard-coded options)
574 if conf.CheckPkgConfig('0.15.0'):
575 env['HAS_PKG_CONFIG'] = True
577 print 'pkg-config >= 0.1.50 is not found'
578 env['HAS_PKG_CONFIG'] = False
580 # zlib? This is required.
581 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
582 or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
583 print 'Did not find zdll.lib or zlib.h, exiting!'
584 print 'Please check config.log for more information.'
586 if conf.CheckLib('iconv'):
587 env['ICONV_LIB'] = 'iconv'
588 elif conf.CheckLib('libiconv'):
589 env['ICONV_LIB'] = 'libiconv'
590 elif conf.CheckFunc('iconv_open'):
591 env['ICONV_LIB'] = None
593 print 'Did not find iconv or libiconv, exiting!'
594 print 'Please check config.log for more information.'
599 if conf.CheckLib('socket'):
600 socket_libs.append('socket')
601 # nsl is the network services library and provides a
602 # transport-level interface to networking services.
603 if conf.CheckLib('nsl'):
604 socket_libs.append('nsl')
606 # check available boost libs (since lyx1.4 does not use iostream)
608 for lib in ['signals', 'regex']:
609 if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
610 boost_libs.append(lib)
612 # check boost libraries
613 boost_opt = ARGUMENTS.get('boost', 'auto')
614 # check for system boost
615 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
616 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
617 # default to $BUILDDIR/libs (use None since this path will be added anyway)
619 # here I assume that all libraries are in the same directory
620 if boost_opt == 'included':
621 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
622 included_boost = True
623 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
624 elif boost_opt == 'auto':
625 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
626 # if not found, use local boost
628 boost_libraries = ['included_boost_%s' % x for x in boost_libs]
629 included_boost = True
630 env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
632 included_boost = False
633 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
634 elif boost_opt == 'system':
635 res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
637 print "Can not find system boost libraries with version %s " % boost_version
638 print "Please supply a path through extra_lib_path and try again."
639 print "Or use boost=included to use included boost libraries."
642 included_boost = False
643 (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
646 if boost_libpath is not None:
647 env.AppendUnique(LIBPATH = [boost_libpath])
650 env['ENABLE_NLS'] = env['nls']
652 if not env['ENABLE_NLS']:
654 included_gettext = False
656 # check gettext libraries
657 gettext_opt = ARGUMENTS.get('gettext', 'auto')
658 # check for system gettext
660 if gettext_opt in ['auto', 'system']:
661 if conf.CheckFunc('gettext'):
662 included_gettext = False
665 elif conf.CheckLib('intl'):
666 included_gettext = False
670 if gettext_opt == 'system':
671 print "Can not find system gettext library"
672 print "Please supply a path through extra_lib_path and try again."
673 print "Or use gettext=included to use included gettext libraries."
675 # now, auto and succ = false, or gettext=included
677 # we do not need to set LIBPATH now.
678 included_gettext = True
679 intl_libs = ['included_intl']
683 # check for msgfmt command
684 env['MSGFMT'] = conf.CheckCommand('msgfmt')
685 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
686 env['XGETTEXT'] = conf.CheckCommand('xgettext')
687 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
689 # if under windows, check the nsis compiler
690 if platform_name == 'win32':
691 env['NSIS'] = conf.CheckNSIS()
693 # cygwin packaging requires the binaries to be stripped
694 if platform_name == 'cygwin':
695 env['STRIP'] = conf.CheckCommand('strip')
698 # Customized builders
700 # install customized builders
701 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
702 #env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
703 env['BUILDERS']['potfiles'] = Builder(action = utils.env_potfiles)
706 #----------------------------------------------------------
707 # Generating config.h
708 #----------------------------------------------------------
709 aspell_lib = 'aspell'
710 # assume that we use aspell, aspelld compiled for msvc
711 if platform_name == 'win32' and mode == 'debug' and use_vc:
712 aspell_lib = 'aspelld'
714 # check the existence of config.h
715 config_h = os.path.join(env.Dir('$BUILDDIR/src').path, 'config.h')
716 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
718 print "Creating %s..." % boost_config_h
720 utils.createConfigFile(conf,
721 config_file = boost_config_h,
722 config_pre = r'''/* boost/config.h. Generated by SCons. */
727 * This file is part of LyX, the document processor.
728 * Licence details can be found in the file COPYING.
730 * This is the compilation configuration file for LyX.
731 * It was generated by scon.
732 * You might want to change some of the defaults if something goes wrong
733 * during the compilation.
736 #ifndef _BOOST_CONFIG_H
737 #define _BOOST_CONFIG_H
740 ('ostream', 'HAVE_OSTREAM', 'cxx'),
741 ('locale', 'HAVE_LOCALE', 'cxx'),
742 ('sstream', 'HAVE_SSTREAM', 'cxx'),
743 #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
746 (env.has_key('assertions') and env['assertions'] and devel_version,
748 'Define if you want assertions to be enabled in the code'
752 ('wchar_t', 'HAVE_WCHAR_T', None),
756 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
757 # define USE_BOOST_FORMAT 1
759 # define USE_BOOST_FORMAT 0
762 #if !defined(ENABLE_ASSERTIONS)
763 # define BOOST_DISABLE_ASSERTS 1
765 #define BOOST_ENABLE_ASSERT_HANDLER 1
767 #define BOOST_DISABLE_THREADS 1
768 #define BOOST_NO_WSTRING 1
771 # define BOOST_POSIX 1
772 # define BOOST_POSIX_API 1
773 # define BOOST_POSIX_PATH 1
776 #define BOOST_ALL_NO_LIB 1
778 #if defined(HAVE_NEWAPIS_H)
779 # define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
783 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
784 * support compiled in:
785 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
786 * And we are not interested at all what libc
787 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
788 * has the needed wchar_t support and uses UCS4. Whether it
789 * implements this with the help of libc, or whether it has own code
790 * does not matter for us, because we don't use libc directly (Georg)
792 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
800 print "\nGenerating %s..." % config_h
802 # AIKSAURUS_H_LOCATION
803 if (conf.CheckCXXHeader("Aiksaurus.h")):
804 aik_location = '<Aiksaurus.h>'
805 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
806 aik_location = '<Aiksaurus/Aiksaurus.h>'
810 # determine headers to use
811 spell_opt = ARGUMENTS.get('spell', 'auto')
812 env['USE_ASPELL'] = False
813 env['USE_PSPELL'] = False
814 env['USE_ISPELL'] = False
815 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
816 spell_engine = 'USE_ASPELL'
817 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
818 spell_engine = 'USE_PSPELL'
819 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
820 spell_engine = 'USE_ISPELL'
824 if spell_engine is not None:
825 env[spell_engine] = True
827 if spell_opt == 'auto':
828 print "Warning: Can not locate any spell checker"
829 elif spell_opt != 'no':
830 print "Warning: Can not locate specified spell checker:", spell_opt
831 print 'Please check config.log for more information.'
834 # check arg types of select function
835 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
837 # check the size of wchar_t
838 sizeof_wchar_t = conf.CheckSizeOfWChar()
840 if sizeof_wchar_t == 0:
841 print 'Error: Can not determine the size of wchar_t.'
842 print 'Please check config.log for more information.'
846 # fill in the version info
847 env['VERSION_INFO'] = '''Configuration
849 Special build flags: %s
851 C Compiler flags: %s %s
853 C++ Compiler LyX flags: %s
854 C++ Compiler flags: %s %s
856 Linker user flags: %s
858 Builing directory: %s
861 include search path: %s
867 ''' % (platform_name,
868 env.subst('$CCFLAGS'), env.subst('$CC'),
869 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
870 env.subst('$CXX'), env.subst('$CXXFLAGS'),
871 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
872 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
873 env.subst('$LOCALLIBPATH'),
874 env.subst('$LIBPATH'), str(boost_libraries),
875 env.subst('$CPPPATH'),
876 frontend, packaging_method,
877 prefix, env['LYX_DATA_DIR'])
881 result = utils.createConfigFile(conf,
882 config_file = config_h,
883 config_pre = r'''/* config.h. Generated by SCons. */
888 * This file is part of LyX, the document processor.
889 * Licence details can be found in the file COPYING.
891 * This is the compilation configuration file for LyX.
892 * It was generated by scon.
893 * You might want to change some of the defaults if something goes wrong
894 * during the compilation.
901 ('io.h', 'HAVE_IO_H', 'c'),
902 ('limits.h', 'HAVE_LIMITS_H', 'c'),
903 ('locale.h', 'HAVE_LOCALE_H', 'c'),
904 ('process.h', 'HAVE_PROCESS_H', 'c'),
905 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
906 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
907 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
908 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
909 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
910 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
911 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
912 ('utime.h', 'HAVE_UTIME_H', 'c'),
913 ('direct.h', 'HAVE_DIRECT_H', 'c'),
914 ('istream', 'HAVE_ISTREAM', 'cxx'),
915 ('ios', 'HAVE_IOS', 'cxx'),
918 ('open', 'HAVE_OPEN', None),
919 ('chmod', 'HAVE_CHMOD', None),
920 ('close', 'HAVE_CLOSE', None),
921 ('popen', 'HAVE_POPEN', None),
922 ('pclose', 'HAVE_PCLOSE', None),
923 ('_open', 'HAVE__OPEN', None),
924 ('_close', 'HAVE__CLOSE', None),
925 ('_popen', 'HAVE__POPEN', None),
926 ('_pclose', 'HAVE__PCLOSE', None),
927 ('getpid', 'HAVE_GETPID', None),
928 ('_getpid', 'HAVE__GETPID', None),
929 ('mkdir', 'HAVE_MKDIR', None),
930 ('_mkdir', 'HAVE__MKDIR', None),
931 ('mktemp', 'HAVE_MKTEMP', None),
932 ('mkstemp', 'HAVE_MKSTEMP', None),
933 ('strerror', 'HAVE_STRERROR', None),
934 ('getcwd', 'HAVE_GETCWD', None),
935 ('setenv', 'HAVE_SETENV', None),
936 ('putenv', 'HAVE_PUTENV', None),
937 ('fcntl', 'HAVE_FCNTL', None),
938 ('mkfifo', 'HAVE_MKFIFO', None),
941 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
944 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
945 '#include <streambuf>\n#include <istream>'),
946 ('wchar_t', 'HAVE_WCHAR_T', None),
947 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
950 ('gdi32', 'HAVE_LIBGDI32'),
951 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
954 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
956 'Define is sys/types.h does not have pid_t',
960 (conf.CheckCXXGlobalCstd(),
962 'Define if your C++ compiler puts C library functions in the global namespace'
964 (conf.CheckMkdirOneArg(),
965 'MKDIR_TAKES_ONE_ARG',
966 'Define if mkdir takes only one argument.'
968 (conf.CheckIconvConst(),
970 'Define as const if the declaration of iconv() needs const.',
971 '#define ICONV_CONST const',
972 '#define ICONV_CONST',
974 (conf.CheckLC_MESSAGES(),
976 'Define if your <locale.h> file defines LC_MESSAGES.'
978 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
981 "Define to 1 if translation of program messages to the user's native anguage is requested.",
983 (env['nls'] and not included_gettext,
985 'Define to 1 if using system gettext library'
987 (env.has_key('concept_checks') and env['concept_checks'],
988 '_GLIBCXX_CONCEPT_CHECKS',
989 'libstdc++ concept checking'
991 (env.has_key('stdlib_debug') and env['stdlib_debug'],
993 'libstdc++ debug mode'
995 (env.has_key('stdlib_debug') and env['stdlib_debug'],
996 '_GLIBCXX_DEBUG_PEDANTIC',
997 'libstdc++ pedantic debug mode'
999 (os.name != 'nt', 'BOOST_POSIX',
1000 'Indicates to boost < 1.34 which API to use (posix or windows).'
1002 (os.name != 'nt', 'BOOST_POSIX_API',
1003 'Indicates to boost 1.34 which API to use (posix or windows).'
1005 (os.name != 'nt', 'BOOST_POSIX_PATH',
1006 'Indicates to boost 1.34 which path style to use (posix or windows).'
1008 (spell_engine is not None, spell_engine,
1009 'Spell engine to use'
1011 # we need to know the byte order for unicode conversions
1012 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1013 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1017 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1019 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1020 'Define to the address where bug reports for this package should be sent.'),
1021 ('#define PACKAGE_NAME "%s"' % package_name,
1022 'Define to the full name of this package.'),
1023 ('#define PACKAGE_STRING "%s"' % package_string,
1024 'Define to the full name and version of this package.'),
1025 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1026 'Define to the one symbol short name of this package.'),
1027 ('#define PACKAGE_VERSION "%s"' % package_version,
1028 'Define to the version of this package.'),
1029 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1030 'Full version info'),
1031 ('#define LYX_DIR_VER "LYX_DIR_%sx"' % majmin_ver,
1032 'Versioned env var for system dir'),
1033 ('#define LYX_USERDIR_VER "LYX_USERDIR_%sx"' % majmin_ver,
1034 'Versioned env var for user dir'),
1035 ('#define LYX_DATE "%s"' % lyx_date,
1037 ('#define PROGRAM_SUFFIX "%s"' % program_suffix,
1038 'Program version suffix'),
1039 ('#define LYX_ABS_INSTALLED_DATADIR "%s"' % env.subst('$LYX_DATA_DIR').replace('\\', '/'),
1040 'Hard coded system support directory'),
1041 ('#define LYX_ABS_INSTALLED_LOCALEDIR "%s"' % env.subst('$LOCALEDIR').replace('\\', '/'),
1042 'Hard coded locale directory'),
1043 ('#define LYX_ABS_TOP_SRCDIR "%s"' % env.subst('$TOP_SRCDIR').replace('\\', '/'),
1044 'Top source directory'),
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.Clone()
1291 frontend_env['BUILDERS']['qtResource'] = Builder(action = utils.env_qtResource)
1293 # handle qt related user specified paths
1294 # set environment so that moc etc can be found even if its path is not set properly
1295 if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1296 frontend_env['QTDIR'] = frontend_env['qt_dir']
1297 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1298 os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1299 frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1300 if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1301 frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1303 # if separate qt_lib_path is given
1304 if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1305 qt_lib_path = frontend_env.subst('$qt_lib_path')
1306 frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1307 frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1311 # if separate qt_inc_path is given
1312 if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1313 qt_inc_path = frontend_env['qt_inc_path']
1317 # local qt4 toolset from
1318 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1320 # NOTE: I have to patch qt4.py since it does not automatically
1321 # process .C file!!! (add to cxx_suffixes )
1323 frontend_env.Tool('qt4', [scons_dir])
1324 frontend_env['QT_AUTOSCAN'] = 0
1325 frontend_env['QT4_AUTOSCAN'] = 0
1326 frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1328 if qt_lib_path is None:
1329 qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1330 if qt_inc_path is None:
1331 qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1334 conf = Configure(frontend_env,
1336 'CheckPackage' : utils.checkPackage,
1337 'CheckCommand' : utils.checkCommand,
1342 # first: try pkg_config
1343 if frontend_env['HAS_PKG_CONFIG']:
1344 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1345 # FIXME: use pkg_config information?
1346 #frontend_env['QT4_PKG_CONFIG'] = succ
1347 # second: try to link to it
1349 # Under linux, I can test the following perfectly
1350 # Under windows, lib names need to passed as libXXX4.a ...
1351 if platform_name == 'win32':
1352 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1354 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1355 # still can not find it
1357 print 'Did not find qt libraries, exiting!'
1358 print 'Please check config.log for more information.'
1361 # Now, determine the correct suffix:
1362 qt_libs = ['QtCore', 'QtGui']
1363 if platform_name == 'win32':
1364 if mode == 'debug' and use_vc and \
1365 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1366 qt_lib_suffix = 'd4'
1367 use_qt_debug_libs = True
1370 use_qt_debug_libs = False
1372 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1373 qt_lib_suffix = '_debug'
1374 use_qt_debug_libs = True
1377 use_qt_debug_libs = False
1378 frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1379 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1380 qtcore_lib = ['QtCore' + qt_lib_suffix]
1382 # check uic and moc commands for qt frontends
1383 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1384 print 'uic or moc command is not found for frontend', frontend
1387 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1388 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1389 # For some unknown changes in msvc or qt, this is no longer needed.
1391 frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], \
1392 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1393 env.File('$BUILDDIR/lyx.exe.manifest').path]
1395 frontend_env = conf.Finish()
1400 print env['VERSION_INFO']
1403 # Mingw command line may be too short for our link usage,
1404 # Here we use a trick from scons wiki
1405 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1407 # I also would like to add logging (commands only) capacity to the
1409 logfile = env.get('logfile', default_log_file)
1410 if logfile != '' or platform_name == 'win32':
1412 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1413 info = '''# This is a log of commands used by scons to build lyx
1417 ''' % (time.asctime(), ' '.join(sys.argv),
1418 env['VERSION_INFO'].replace('\n','\n# ')) )
1423 # -h will print out help info
1424 Help(opts.GenerateHelpText(env))
1427 #----------------------------------------------------------
1429 #----------------------------------------------------------
1430 # this has been the source of problems on some platforms...
1431 # I find that I need to supply it with full path name
1432 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1433 # this usage needs further investigation.
1434 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1435 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1436 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1437 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1438 frontend_env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1440 print "Building all targets recursively"
1442 def libExists(libname):
1443 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1444 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1447 if (included_boost and not libExists('included_boost_regex')) or 'boost' in BUILD_TARGETS:
1451 for lib in boost_libs:
1452 boostlib = env.StaticLibrary(
1453 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1454 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)],
1455 # do not use global CPPPATH because src/config.h will mess up with boost/config.h
1456 CPPPATH = ['$BUILDDIR/boost'] + extra_inc_paths,
1457 CCFLAGS = ['$CCFLAGS', '$INCPREFIX$TOP_SRCDIR/boost', '-DBOOST_USER_CONFIG="<config.h>"']
1459 Alias('boost', boostlib)
1462 if (included_gettext and not libExists('included_intl')) or 'intl' in BUILD_TARGETS:
1467 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1468 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1469 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1471 '-DENABLE_RELOCATABLE=1',
1473 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1475 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1476 '-Drelocate=libintl_relocate',
1477 '-DDEPENDS_ON_LIBICONV=1',
1481 INTL_CCFLAGS.extend(['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1483 intl = env.StaticLibrary(
1484 target = '$LOCALLIBPATH/included_intl',
1486 CCFLAGS = INTL_CCFLAGS,
1487 # do not use global CPPPATH because src/config.h will mess up with intl/config.h
1488 CPPPATH = ['$BUILDDIR/intl'] + extra_inc_paths,
1489 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1496 frontend_env['QT4_MOCHPREFIX'] = ''
1497 frontend_env['QT4_MOCHSUFFIX'] = '_moc.cpp'
1499 support_moced_files = [frontend_env.Moc4('$BUILDDIR/src/support/%s' % x)
1500 for x in src_support_header_files ]
1501 support = frontend_env.StaticLibrary(
1502 target = '$LOCALLIBPATH/support',
1503 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files],
1510 CPPPATH = ['$CPPPATH', '$BUILDDIR/src/support']
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)
1558 # tells scons how to get these moced files, although not all moced files are needed
1559 # (or are actually generated).
1560 qt4_moced_files = [frontend_env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1561 for x in src_frontends_qt4_header_files ]
1562 ui_files = [frontend_env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1563 for x in src_frontends_qt4_ui_files]
1564 resource = frontend_env.Qrc(frontend_env.qtResource(
1565 '$BUILDDIR/src/frontends/qt4/Resource.qrc',
1566 ['$TOP_SRCDIR/lib/images/%s' % x for x in lib_images_files] +
1567 ['$TOP_SRCDIR/lib/images/math/%s' % x for x in lib_images_math_files] +
1568 ['$TOP_SRCDIR/lib/images/commands/%s' % x for x in lib_images_commands_files]))
1570 # moc qt4_moc_files, the moced files are included in the original files
1572 qt4 = frontend_env.StaticLibrary(
1573 target = '$LOCALLIBPATH/qt4',
1574 source = ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files] + resource,
1578 '$BUILDDIR/src/images',
1579 '$BUILDDIR/src/frontends',
1580 '$BUILDDIR/src/frontends/qt4',
1581 '$BUILDDIR/src/frontends/qt4/ui',
1596 if env['HAVE_FCNTL']:
1597 client = frontend_env.Program(
1598 target = '$BUILDDIR/src/client/lyxclient',
1599 LIBS = ['support'] + intl_libs + system_libs +
1600 socket_libs + boost_libraries + qtcore_lib,
1601 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1602 utils.createResFromIcon(frontend_env, 'lyx.ico', '$LOCALLIBPATH/client.rc')
1604 Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1605 client, [Copy('$TARGET', '$SOURCE')]))
1608 Alias('client', client)
1614 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1615 frontend_env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1616 [Copy('$TARGET', '$SOURCE')])
1618 tex2lyx = frontend_env.Program(
1619 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1620 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1621 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1622 utils.createResFromIcon(frontend_env, 'lyx.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1623 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$BUILDDIR/src', '$CPPPATH'],
1624 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1625 CCFLAGS = ['$CCFLAGS', '-DTEX2LYX'],
1627 Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1628 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1629 Alias('tex2lyx', tex2lyx)
1635 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1636 src_post_files.append('ASpell.cpp')
1637 elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1638 src_post_files.append('PSpell.cpp')
1639 elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1640 src_post_files.append('ISpell.cpp')
1642 # msvc requires at least one source file with main()
1643 # so I exclude main.cpp from lyxbase
1644 lyxbase_pre = env.StaticLibrary(
1645 target = '$LOCALLIBPATH/lyxbase_pre',
1646 source = ['$BUILDDIR/src/%s' % x for x in src_pre_files]
1648 lyxbase_post = env.StaticLibrary(
1649 target = '$LOCALLIBPATH/lyxbase_post',
1650 source = ["$BUILDDIR/src/%s" % x for x in src_post_files]
1652 Alias('lyxbase', lyxbase_pre)
1653 Alias('lyxbase', lyxbase_post)
1657 # Build lyx with given frontend
1659 lyx = frontend_env.Program(
1660 target = '$BUILDDIR/lyx',
1661 source = ['$BUILDDIR/src/main.cpp'] + \
1662 utils.createResFromIcon(frontend_env, 'lyx.ico', '$LOCALLIBPATH/lyx.rc'),
1672 boost_libraries + ['lyxbase_post'] +
1681 if use_vc and 'msvs_projects' in BUILD_TARGETS:
1682 def build_project(target, full_target = None, src = [], inc = [], res = []):
1683 ''' build mavs project files
1684 target: alias (correspond to directory name)
1685 full_target: full path/filename of the target
1690 For non-debug-able targets like static libraries, target (alias) is
1691 enough to build the target. For executable targets, msvs need to know
1692 the full path to start debug them.
1695 proj = env.MSVSProject(
1696 target = target + env['MSVSPROJECTSUFFIX'],
1697 # this allows easy access to header files (along with source)
1698 srcs = [env.subst(x) for x in src + inc],
1699 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1700 localincs = [env.subst(x) for x in inc],
1701 resources = [env.subst(x) for x in res],
1702 buildtarget = full_target,
1705 Alias('msvs_projects', proj)
1707 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1708 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1709 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1711 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1712 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1713 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1715 build_project('lyx',
1716 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1717 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1718 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1719 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1720 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1721 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1722 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1723 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1724 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1725 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1726 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1727 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1728 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1729 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1730 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1731 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1734 if 'update_po' in BUILD_TARGETS:
1738 print 'Updating po/*.po files...'
1740 # whether or not update po files
1741 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1742 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1744 # rebuild POTFILES.in
1745 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1746 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1747 src_extra_src_files] + \
1748 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1749 src_support_extra_header_files + src_support_extra_src_files] + \
1750 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1751 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1752 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1753 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1754 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files] + \
1755 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1756 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1758 Alias('update_po', POTFILES_in)
1759 # build language_l10n.pot, encodings_10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n, formats_l10n
1760 # and combine them to lyx.po
1761 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1762 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1763 env.Command('$BUILDDIR/po/all.po',
1764 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1765 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1766 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1767 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1768 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files + lib_layouts_module_files],
1769 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1770 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1771 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1772 env.Command('$BUILDDIR/po/encodings_l10n.pot', '$TOP_SRCDIR/lib/encodings',
1773 '$LYX_POT -b $TOP_SRCDIR -t encodings -o $TARGET $SOURCES'),
1774 env.Command('$BUILDDIR/po/ui_l10n.pot',
1775 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1776 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1777 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1778 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
1779 env.Command('$BUILDDIR/po/formats_l10n.pot', '$TOP_SRCDIR/lib/configure.py',
1780 '$LYX_POT -b $TOP_SRCDIR -t formats -o $TARGET $SOURCES'),
1782 ['$MSGUNIQ -o $TARGET $SOURCE',
1783 '''$XGETTEXT --default-domain=${TARGET.base} \
1784 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
1785 --language=C++ --join-existing \
1786 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
1787 --files-from=$TOP_SRCDIR/po/POTFILES.in \
1788 --copyright-holder="LyX Developers" \
1789 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
1791 env.Depends(lyx_po, POTFILES_in)
1792 # copy lyx.po to lyx.pot
1793 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
1794 Copy('$TARGET', '$SOURCE'))
1797 # files to translate
1798 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
1799 # possibly *only* handle these languages
1801 if env.has_key('languages'):
1802 languages = env.make_list(env['languages'])
1803 # merge. if I use lan.po as $TARGET, it will be removed
1804 # before it is merged. In this builder,
1805 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
1806 # and is copied to po/lang.po
1807 env['BUILDERS']['msgmerge'] = Builder(action=[
1808 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
1809 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
1811 # for each po file, generate pot
1812 for po_file in transfiles:
1814 fname = os.path.split(po_file)[1]
1816 country = fname.split('.')[0]
1818 if not languages or country in languages:
1819 # merge po files, the generated lan.po_new file is copied to lan.po file.
1820 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
1821 env.Depends(po, POTFILES_in)
1822 Alias('update_po', po)
1825 # if 'install' is not in the target, do not process this
1826 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
1828 # this part is a bit messy right now. Since scons will provide
1829 # --DESTDIR option soon, at least the dest_dir handling can be
1838 # files to translate
1839 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1840 # possibly *only* handle these languages
1842 if env.has_key('languages'):
1843 languages = env.make_list(env['lanauges'])
1844 # use defulat msgfmt
1846 if not env['MSGFMT']:
1847 print 'msgfmt does not exist. Can not process po files'
1850 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
1852 for f in transfiles:
1854 fname = os.path.split(f)[1]
1856 country = fname.split('.')[0]
1858 if not languages or country in languages:
1859 gmo_files.extend(env.Transfiles(f))
1860 # how to join dest_dir and prefix
1861 def joinPaths(path1, path2):
1862 ''' join path1 and path2, do not use os.path.join because
1863 under window, c:\destdir\d:\program is invalid '''
1865 return os.path.normpath(path2)
1866 # separate drive letter
1867 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
1868 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
1869 return os.path.join(os.path.normpath(path1), path[1:])
1871 # install to dest_dir/prefix
1872 dest_dir = env.get('DESTDIR', '')
1873 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
1874 # create the directory if needed
1875 if not os.path.isdir(dest_prefix_dir):
1877 os.makedirs(dest_prefix_dir)
1880 if not os.path.isdir(dest_prefix_dir):
1881 print 'Can not create directory', dest_prefix_dir
1884 if env.has_key('exec_prefix'):
1885 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
1887 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
1889 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
1891 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
1892 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
1893 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
1894 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
1898 # install executables (lyxclient may be None)
1901 version_suffix = program_suffix
1905 # install lyx, if in release mode, try to strip the binary
1906 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
1907 # create a builder to strip and install
1908 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
1910 # install executables
1911 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
1914 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
1915 target = os.path.join(bin_dest_dir, target_name)
1916 if env['BUILDERS'].has_key('StripInstallAs'):
1917 env.StripInstallAs(target, obj)
1919 env.InstallAs(target, obj)
1920 Alias('install', target)
1924 for (dir,files) in [
1926 ('bind', lib_bind_files),
1927 ('bind/de', lib_bind_de_files),
1928 ('bind/fi', lib_bind_fi_files),
1929 ('bind/pt', lib_bind_pt_files),
1930 ('bind/sv', lib_bind_sv_files),
1931 ('commands', lib_commands_files),
1932 ('doc', lib_doc_files),
1933 ('doc/biblio', lib_doc_biblio_files),
1934 ('doc/clipart', lib_doc_clipart_files),
1935 ('doc/ca', lib_doc_ca_files),
1936 ('doc/cs', lib_doc_cs_files),
1937 ('doc/da', lib_doc_da_files),
1938 ('doc/de', lib_doc_de_files),
1939 ('doc/de/clipart', lib_doc_de_clipart_files),
1940 ('doc/es', lib_doc_es_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/fr/clipart', lib_doc_fr_clipart_files),
1945 ('doc/gl', lib_doc_gl_files),
1946 ('doc/he', lib_doc_he_files),
1947 ('doc/hu', lib_doc_hu_files),
1948 ('doc/it', lib_doc_it_files),
1949 ('doc/it/clipart', lib_doc_it_clipart_files),
1950 ('doc/ja', lib_doc_ja_files),
1951 ('doc/ja/clipart', lib_doc_ja_clipart_files),
1952 ('doc/nl', lib_doc_nl_files),
1953 ('doc/nb', lib_doc_nb_files),
1954 ('doc/pl', lib_doc_pl_files),
1955 ('doc/pt', lib_doc_pt_files),
1956 ('doc/ro', lib_doc_ro_files),
1957 ('doc/ru', lib_doc_ru_files),
1958 ('doc/sk', lib_doc_sk_files),
1959 ('doc/sl', lib_doc_sl_files),
1960 ('doc/sv', lib_doc_sv_files),
1961 ('doc/uk', lib_doc_uk_files),
1962 ('doc/uk/clipart', lib_doc_uk_clipart_files),
1963 ('examples', lib_examples_files),
1964 ('examples/ca', lib_examples_ca_files),
1965 ('examples/cs', lib_examples_cs_files),
1966 ('examples/da', lib_examples_da_files),
1967 ('examples/de', lib_examples_de_files),
1968 ('examples/es', lib_examples_es_files),
1969 ('examples/eu', lib_examples_eu_files),
1970 ('examples/fa', lib_examples_fa_files),
1971 ('examples/fr', lib_examples_fr_files),
1972 ('examples/gl', lib_examples_gl_files),
1973 ('examples/he', lib_examples_he_files),
1974 ('examples/hu', lib_examples_hu_files),
1975 ('examples/it', lib_examples_it_files),
1976 ('examples/ja', lib_examples_ja_files),
1977 ('examples/nl', lib_examples_nl_files),
1978 ('examples/pl', lib_examples_pl_files),
1979 ('examples/pt', lib_examples_pt_files),
1980 ('examples/ru', lib_examples_ru_files),
1981 ('examples/sl', lib_examples_sl_files),
1982 ('examples/ro', lib_examples_ro_files),
1983 ('fonts', lib_fonts_files),
1984 ('images', lib_images_files),
1985 ('images/math', lib_images_math_files),
1986 ('images/commands', lib_images_commands_files),
1987 ('kbd', lib_kbd_files),
1988 ('layouts', lib_layouts_files + lib_layouts_inc_files + lib_layouts_module_files),
1989 ('lyx2lyx', lib_lyx2lyx_files),
1990 ('scripts', lib_scripts_files),
1991 ('templates', lib_templates_files),
1992 ('tex', lib_tex_files),
1993 ('ui', lib_ui_files)]:
1994 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
1995 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
1996 Alias('install', dirs)
1998 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
1999 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
2000 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2001 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2002 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2003 sys.path.append(share_dest_dir + '/lyx2lyx')
2005 if platform_name == 'cygwin':
2006 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2007 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
2008 '%s-%s.README' % (package, package_cygwin_version))
2009 env.InstallAs(Cygwin_README,
2010 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2011 Alias('install', Cygwin_README)
2012 # also a directory /usr/share/doc/lyx for README etc
2013 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2014 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2015 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2016 Alias('install', Cygwin_Doc)
2017 # cygwin fonts also need to be installed
2018 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2019 env.Install(Cygwin_fonts,
2020 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2021 for file in win32_bakoma_fonts])
2022 Alias('install', Cygwin_fonts)
2023 # we also need a post installation script
2024 tmp_script = utils.installCygwinPostinstallScript('/tmp')
2025 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2026 env.Install(postinstall_path, tmp_script)
2027 Alias('install', postinstall_path)
2029 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2030 env.subst('$TOP_SRCDIR/lyx.1in'))
2031 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2032 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2033 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2034 env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2035 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2036 x in ['lyx', 'tex2lyx', 'lyxclient']])
2038 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2039 for gmo in gmo_files:
2040 lan = os.path.split(str(gmo))[1].split('.')[0]
2041 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2042 env.InstallAs(dest_file, gmo)
2043 Alias('install', dest_file)
2046 if 'installer' in BUILD_TARGETS:
2048 # build windows installer using NSIS
2051 # There is a nsis builder on scons wiki but it does not work with
2052 # our lyx.nsi because it does not dig through all the include directives
2053 # and find the dependencies automatically. Also, it can not parse
2054 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2055 # something rely on date.
2056 # Because of this, I am doing a simple nsis builder here.
2057 if platform_name != 'win32':
2058 print 'installer target is only available for windows platform'
2060 if mode != 'release':
2061 print 'installer has to be built in release mode (use option mode=release)'
2063 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
2064 % x for x in development_Win32_packaging_installer] + \
2065 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2066 % x for x in development_Win32_packaging_installer_graphics] + \
2067 ['$TOP_SRCDIR/development/Win32/packaging/installer/gui/%s' \
2068 % x for x in development_Win32_packaging_installer_gui] + \
2069 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2070 % x for x in development_Win32_packaging_installer_include] + \
2071 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2072 % x for x in development_Win32_packaging_installer_lang] + \
2073 ['$TOP_SRCDIR/development/Win32/packaging/installer/setup/%s' \
2074 % x for x in development_Win32_packaging_installer_setup]
2075 if env.has_key('NSIS') and env['NSIS'] is not None:
2076 # create a builder to strip and install
2077 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2079 print 'No nsis compiler is found. Existing...'
2081 if not env.has_key('win_installer') or env['win_installer'] is None:
2083 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2085 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2086 # provide default setting
2087 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2088 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2089 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2090 print 'Development dependency package is not found.'
2093 env['deps_dir'] = env.Dir('$deps_dir').abspath
2095 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2096 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2097 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2098 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2100 env['bundle_dir'] = None
2101 # if absolute path is given, use it, otherwise, write to current directory
2102 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2103 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2104 env.Append(NSISDEFINES={
2105 'ExeFile':env['win_installer'],
2106 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2107 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2108 'FilesDeps':env['deps_dir'],
2109 'FilesBundle':env['bundle_dir'],
2111 installer = env.installer(env['win_installer'],
2112 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2113 # since I can not use a scanner, explicit dependent is required
2114 env.Depends(installer, 'install')
2115 env.Depends(installer, installer_files)
2116 env.Alias('installer', installer)
2117 # also generate bundle?
2118 if env.has_key('bundle') and env['bundle']:
2119 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2120 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2121 print 'Use bundle_dir option to specify'
2123 # generator of the builder will add bundle stuff depending on output name
2124 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2125 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2126 env.Depends(bundle_installer, 'install')
2127 env.Depends(bundle_installer, installer_files)
2128 env.Alias('installer', bundle_installer)
2131 Alias('all', ['lyx', 'client', 'tex2lyx'])