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 = Variables(['config.py'])
116 EnumVariable('frontend', 'Main GUI', 'qt4',
117 allowed_values = ('qt4',) ),
118 # debug or release build
119 EnumVariable('mode', 'Building method', default_build_mode,
120 allowed_values = ('debug', 'release') ),
122 EnumVariable('boost',
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 EnumVariable('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 EnumVariable('spell', 'Choose spell checker to use.', 'auto',
139 allowed_values = ('aspell', 'enchant', 'hunspell', 'auto', 'no') ),
141 EnumVariable('packaging', 'Packaging method to use.', default_packaging_method,
142 allowed_values = ('windows', 'posix', 'macosx')),
144 BoolVariable('fast_start', 'This option is obsolete.', False),
145 # No precompiled header support (too troublesome to make it work for msvc)
146 # BoolVariable('pch', 'Whether or not use pch', False),
147 # enable assertion, (config.h has ENABLE_ASSERTIOS
148 BoolVariable('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 BoolVariable('concept_checks', 'Enable concept checks', True),
153 BoolVariable('nls', 'Whether or not use native language support', True),
155 BoolVariable('profiling', 'Whether or not enable profiling', False),
156 # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
157 BoolVariable('stdlib_debug', 'Whether or not turn on stdlib debug', False),
159 BoolVariable('X11', 'Use x11 windows system', default_with_x),
160 # use MS VC++ to build lyx
161 BoolVariable('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
163 PathVariable('qt_dir', 'Path to qt directory', None),
165 PathVariable('qt_inc_path', 'Path to qt include directory', None),
167 PathVariable('qt_lib_path', 'Path to qt library directory', None),
168 # extra include and libpath
169 PathVariable('extra_inc_path', 'Extra include path', None),
171 PathVariable('extra_lib_path', 'Extra library path', None),
173 PathVariable('extra_bin_path', 'A convenient way to add a path to $PATH', None),
175 PathVariable('extra_inc_path1', 'Extra include path', None),
177 PathVariable('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 BoolVariable('bundle', 'Whether or not build bundle installer', False),
188 # the bundle directory, containing bundled applications
189 PathVariable('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 PathVariable('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/Variables/BoolVariable.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'),
745 (env.has_key('assertions') and env['assertions'] and mode == 'debug',
747 'Define if you want assertions to be enabled in the code'
751 ('wchar_t', 'HAVE_WCHAR_T', None),
755 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
756 # define USE_BOOST_FORMAT 1
758 # define USE_BOOST_FORMAT 0
761 #if !defined(ENABLE_ASSERTIONS)
762 # define BOOST_DISABLE_ASSERTS 1
764 #define BOOST_ENABLE_ASSERT_HANDLER 1
766 #define BOOST_DISABLE_THREADS 1
767 #define BOOST_NO_WSTRING 1
770 # define BOOST_POSIX 1
771 # define BOOST_POSIX_API 1
772 # define BOOST_POSIX_PATH 1
775 #define BOOST_ALL_NO_LIB 1
778 * the FreeBSD libc uses UCS4, but libstdc++ has no proper wchar_t
779 * support compiled in:
780 * http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#3_9
781 * And we are not interested at all what libc
782 * does: What we need is a 32bit wide wchar_t, and a libstdc++ that
783 * has the needed wchar_t support and uses UCS4. Whether it
784 * implements this with the help of libc, or whether it has own code
785 * does not matter for us, because we don't use libc directly (Georg)
787 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4 && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
795 print "\nGenerating %s..." % config_h
797 # AIKSAURUS_H_LOCATION
798 if (conf.CheckCXXHeader("Aiksaurus.h")):
799 aik_location = '<Aiksaurus.h>'
800 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
801 aik_location = '<Aiksaurus/Aiksaurus.h>'
805 # determine headers to use
806 spell_opt = ARGUMENTS.get('spell', 'auto')
807 env['USE_ASPELL'] = False
808 env['USE_ENCHANT'] = False
809 env['USE_HUNSPELL'] = False
810 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
811 spell_engine = 'USE_ASPELL'
812 elif spell_opt in ['auto', 'enchant'] and conf.CheckLib('enchant'):
813 spell_engine = 'USE_ENCHANT'
814 elif spell_opt in ['auto', 'hunspell'] and conf.CheckLib('hunspell'):
815 spell_engine = 'USE_HUNSPELL'
819 if spell_engine is not None:
820 env[spell_engine] = True
822 if spell_opt == 'auto':
823 print "Warning: Can not locate any spell checker"
824 elif spell_opt != 'no':
825 print "Warning: Can not locate specified spell checker:", spell_opt
826 print 'Please check config.log for more information.'
829 # check arg types of select function
830 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
832 # check the size of wchar_t
833 sizeof_wchar_t = conf.CheckSizeOfWChar()
835 if sizeof_wchar_t == 0:
836 print 'Error: Can not determine the size of wchar_t.'
837 print 'Please check config.log for more information.'
841 # fill in the version info
842 env['VERSION_INFO'] = '''Configuration
844 Special build flags: %s
846 C Compiler flags: %s %s
848 C++ Compiler LyX flags: %s
849 C++ Compiler flags: %s %s
851 Linker user flags: %s
853 Builing directory: %s
856 include search path: %s
862 ''' % (platform_name,
863 env.subst('$CCFLAGS'), env.subst('$CC'),
864 env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
865 env.subst('$CXX'), env.subst('$CXXFLAGS'),
866 env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
867 env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
868 env.subst('$LOCALLIBPATH'),
869 env.subst('$LIBPATH'), str(boost_libraries),
870 env.subst('$CPPPATH'),
871 frontend, packaging_method,
872 prefix, env['LYX_DATA_DIR'])
876 result = utils.createConfigFile(conf,
877 config_file = config_h,
878 config_pre = r'''/* config.h. Generated by SCons. */
883 * This file is part of LyX, the document processor.
884 * Licence details can be found in the file COPYING.
886 * This is the compilation configuration file for LyX.
887 * It was generated by scon.
888 * You might want to change some of the defaults if something goes wrong
889 * during the compilation.
896 ('io.h', 'HAVE_IO_H', 'c'),
897 ('limits.h', 'HAVE_LIMITS_H', 'c'),
898 ('locale.h', 'HAVE_LOCALE_H', 'c'),
899 ('process.h', 'HAVE_PROCESS_H', 'c'),
900 ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
901 ('string.h', 'HAVE_STRING_H', 'c'),
902 ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
903 ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
904 ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
905 ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
906 ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
907 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
908 ('utime.h', 'HAVE_UTIME_H', 'c'),
909 ('direct.h', 'HAVE_DIRECT_H', 'c'),
910 ('istream', 'HAVE_ISTREAM', 'cxx'),
911 ('ios', 'HAVE_IOS', 'cxx'),
914 ('open', 'HAVE_OPEN', None),
915 ('chmod', 'HAVE_CHMOD', None),
916 ('close', 'HAVE_CLOSE', None),
917 ('popen', 'HAVE_POPEN', None),
918 ('pclose', 'HAVE_PCLOSE', None),
919 ('_open', 'HAVE__OPEN', None),
920 ('_close', 'HAVE__CLOSE', None),
921 ('_popen', 'HAVE__POPEN', None),
922 ('_pclose', 'HAVE__PCLOSE', None),
923 ('getpid', 'HAVE_GETPID', None),
924 ('_getpid', 'HAVE__GETPID', None),
925 ('mkdir', 'HAVE_MKDIR', None),
926 ('_mkdir', 'HAVE__MKDIR', None),
927 ('mktemp', 'HAVE_MKTEMP', None),
928 ('mkstemp', 'HAVE_MKSTEMP', None),
929 ('strerror', 'HAVE_STRERROR', None),
930 ('getcwd', 'HAVE_GETCWD', None),
931 ('setenv', 'HAVE_SETENV', None),
932 ('putenv', 'HAVE_PUTENV', None),
933 ('fcntl', 'HAVE_FCNTL', None),
934 ('mkfifo', 'HAVE_MKFIFO', None),
937 ('mkstemp', 'HAVE_DECL_MKSTEMP', ['unistd.h', 'stdlib.h']),
940 ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
941 '#include <streambuf>\n#include <istream>'),
942 ('wchar_t', 'HAVE_WCHAR_T', None),
943 ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
946 ('gdi32', 'HAVE_LIBGDI32'),
947 (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
950 (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
952 'Define is sys/types.h does not have pid_t',
956 (conf.CheckCXXGlobalCstd(),
958 'Define if your C++ compiler puts C library functions in the global namespace'
960 (conf.CheckMkdirOneArg(),
961 'MKDIR_TAKES_ONE_ARG',
962 'Define if mkdir takes only one argument.'
964 (conf.CheckIconvConst(),
966 'Define as const if the declaration of iconv() needs const.',
967 '#define ICONV_CONST const',
968 '#define ICONV_CONST',
970 (conf.CheckLC_MESSAGES(),
972 'Define if your <locale.h> file defines LC_MESSAGES.'
974 (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
977 "Define to 1 if translation of program messages to the user's native anguage is requested.",
979 (env['nls'] and not included_gettext,
981 'Define to 1 if using system gettext library'
983 (env.has_key('concept_checks') and env['concept_checks'],
984 '_GLIBCXX_CONCEPT_CHECKS',
985 'libstdc++ concept checking'
987 (env.has_key('stdlib_debug') and env['stdlib_debug'],
989 'libstdc++ debug mode'
991 (env.has_key('stdlib_debug') and env['stdlib_debug'],
992 '_GLIBCXX_DEBUG_PEDANTIC',
993 'libstdc++ pedantic debug mode'
995 (os.name != 'nt', 'BOOST_POSIX',
996 'Indicates to boost < 1.34 which API to use (posix or windows).'
998 (os.name != 'nt', 'BOOST_POSIX_API',
999 'Indicates to boost 1.34 which API to use (posix or windows).'
1001 (os.name != 'nt', 'BOOST_POSIX_PATH',
1002 'Indicates to boost 1.34 which path style to use (posix or windows).'
1004 (spell_engine is not None, spell_engine,
1005 'Spell engine to use'
1007 # we need to know the byte order for unicode conversions
1008 (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1009 'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1013 ('#define PACKAGE "%s%s"' % (package, program_suffix),
1015 ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1016 'Define to the address where bug reports for this package should be sent.'),
1017 ('#define PACKAGE_NAME "%s"' % package_name,
1018 'Define to the full name of this package.'),
1019 ('#define PACKAGE_STRING "%s"' % package_string,
1020 'Define to the full name and version of this package.'),
1021 ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1022 'Define to the one symbol short name of this package.'),
1023 ('#define PACKAGE_VERSION "%s"' % package_version,
1024 'Define to the version of this package.'),
1025 ('#define VERSION_INFO "%s"' % env['VERSION_INFO'].replace('\n', '\\n'),
1026 'Full version info'),
1027 ('#define LYX_DIR_VER "LYX_DIR_%sx"' % majmin_ver,
1028 'Versioned env var for system dir'),
1029 ('#define LYX_USERDIR_VER "LYX_USERDIR_%sx"' % majmin_ver,
1030 'Versioned env var for user dir'),
1031 ('#define LYX_DATE "%s"' % lyx_date,
1033 ('#define PROGRAM_SUFFIX "%s"' % program_suffix,
1034 'Program version suffix'),
1035 ('#define LYX_ABS_INSTALLED_DATADIR "%s"' % env.subst('$LYX_DATA_DIR').replace('\\', '/'),
1036 'Hard coded system support directory'),
1037 ('#define LYX_ABS_INSTALLED_LOCALEDIR "%s"' % env.subst('$LOCALEDIR').replace('\\', '/'),
1038 'Hard coded locale directory'),
1039 ('#define LYX_ABS_TOP_SRCDIR "%s"' % env.subst('$TOP_SRCDIR').replace('\\', '/'),
1040 'Top source directory'),
1041 ('#define BOOST_ALL_NO_LIB 1',
1042 'disable automatic linking of boost libraries.'),
1043 ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1044 'Packaging method'),
1045 ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1046 'Aiksaurus include file'),
1047 ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1048 "Define to the type of arg 1 for `select'."),
1049 ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1050 "Define to the type of arg 2, 3, 4 for `select'."),
1051 ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1052 "Define to the type of arg 5 for `select'."),
1053 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1054 'Define to be the size of type wchar_t'),
1056 config_post = '''/************************************************************
1057 ** You should not need to change anything beyond this point */
1059 #ifndef HAVE_STRERROR
1060 #if defined(__cplusplus)
1063 char * strerror(int n);
1066 #include <../boost/config.h>
1072 # these keys are needed in env
1073 for key in ['USE_ASPELL', 'USE_ENCHANT', 'USE_HUNSPELL', 'HAVE_FCNTL',\
1074 'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1075 # USE_ASPELL etc does not go through result
1076 if result.has_key(key):
1077 env[key] = result[key]
1080 # if nls=yes and gettext=included, create intl/config.h
1081 # intl/libintl.h etc
1083 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1084 if env['nls'] and included_gettext:
1086 print "Creating %s..." % intl_config_h
1088 # create intl/config.h
1089 result = utils.createConfigFile(conf,
1090 config_file = intl_config_h,
1091 config_pre = r'''/* intl/config.h. Generated by SCons. */
1096 * This file is part of LyX, the document processor.
1097 * Licence details can be found in the file COPYING.
1099 * This is the compilation configuration file for LyX.
1100 * It was generated by scon.
1101 * You might want to change some of the defaults if something goes wrong
1102 * during the compilation.
1105 #ifndef _INTL_CONFIG_H
1106 #define _INTL_CONFIG_H
1109 ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1110 ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1111 ('string.h', 'HAVE_STRING_H', 'c'),
1112 ('strings.h', 'HAVE_STRINGS_H', 'c'),
1113 ('argz.h', 'HAVE_ARGZ_H', 'c'),
1114 ('limits.h', 'HAVE_LIMITS_H', 'c'),
1115 ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1116 ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1117 ('stdint.h', 'HAVE_STDINT_H', 'c'),
1118 ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1121 ('getcwd', 'HAVE_GETCWD', None),
1122 ('stpcpy', 'HAVE_STPCPY', None),
1123 ('strcasecmp', 'HAVE_STRCASECMP', None),
1124 ('strdup', 'HAVE_STRDUP', None),
1125 ('strtoul', 'HAVE_STRTOUL', None),
1126 ('alloca', 'HAVE_ALLOCA', None),
1127 ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1128 ('mempcpy', 'HAVE_MEMPCPY', None),
1129 ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1130 ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1131 ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1132 ('setlocale', 'HAVE_SETLOCALE', None),
1133 ('tsearch', 'HAVE_TSEARCH', None),
1134 ('getegid', 'HAVE_GETEGID', None),
1135 ('getgid', 'HAVE_GETGID', None),
1136 ('getuid', 'HAVE_GETUID', None),
1137 ('wcslen', 'HAVE_WCSLEN', None),
1138 ('asprintf', 'HAVE_ASPRINTF', None),
1139 ('wprintf', 'HAVE_WPRINTF', None),
1140 ('snprintf', 'HAVE_SNPRINTF', None),
1141 ('printf', 'HAVE_POSIX_PRINTF', None),
1142 ('fcntl', 'HAVE_FCNTL', None),
1145 ('intmax_t', 'HAVE_INTMAX_T', None),
1146 ('long double', 'HAVE_LONG_DOUBLE', None),
1147 ('long long', 'HAVE_LONG_LONG', None),
1148 ('wchar_t', 'HAVE_WCHAR_T', None),
1149 ('wint_t', 'HAVE_WINT_T', None),
1150 ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1151 ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1157 (conf.CheckLC_MESSAGES(),
1159 'Define if your <locale.h> file defines LC_MESSAGES.'
1161 (conf.CheckIconvConst(),
1163 'Define as const if the declaration of iconv() needs const.',
1164 '#define ICONV_CONST const',
1165 '#define ICONV_CONST',
1167 (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1168 conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1170 "Define to 1 if you have the `intmax_t' type."
1172 (env.has_key('nls') and env['nls'],
1174 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1178 ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1179 ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1180 'Define to be the size of type wchar_t'),
1182 config_post = '#endif'
1185 # these keys are needed in env
1186 for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1187 'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1188 # USE_ASPELL etc does not go through result
1189 if result.has_key(key):
1190 env[key] = result[key]
1193 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1194 if env['nls'] and included_gettext:
1195 # libgnuintl.h.in => libintl.h
1196 env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1197 env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1198 env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1199 [Copy('$TARGET', '$SOURCE')])
1202 # Finish auto-configuration
1205 #----------------------------------------------------------
1206 # Now set up our build process accordingly
1207 #----------------------------------------------------------
1209 if env['ICONV_LIB'] is None:
1212 system_libs = [env['ICONV_LIB']]
1213 if platform_name in ['win32', 'cygwin']:
1214 # the final link step needs stdc++ to succeed under mingw
1215 # FIXME: shouldn't g++ automatically link to stdc++?
1217 system_libs += ['ole32', 'shlwapi', 'psapi', 'shell32', 'advapi32', 'zdll']
1219 system_libs += ['shlwapi', 'psapi', 'stdc++', 'z']
1220 elif platform_name == 'cygwin' and env['X11']:
1221 system_libs += ['GL', 'Xmu', 'Xi', 'Xrender', 'Xrandr',
1222 'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE',
1223 'resolv', 'pthread', 'z']
1225 system_libs += ['z']
1228 ('HAVE_LIBGDI32', 'gdi32'),
1229 ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1230 ('USE_ASPELL', aspell_lib),
1231 ('USE_ENCHANT', 'enchant'),
1232 ('USE_HUNSPELL', 'hunspell')
1237 system_libs.append(lib[1])
1240 # Build parameters CPPPATH etc
1243 env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1246 # boost: for boost header files
1247 # BUILDDIR/src: for config.h
1248 # TOP_SRCDIR/src: for support/* etc
1250 env['CPPPATH'] += ['$BUILDDIR/src', '$TOP_SRCDIR/src']
1252 # Separating boost directories from CPPPATH stops scons from building
1253 # the dependency tree for boost header files, and effectively reduce
1254 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1255 # boost headers, the following is not 100% safe.
1256 # env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1257 env.PrependUnique(CCFLAGS = ['$INCPREFIX$BOOST_INC_PATH'])
1259 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1260 if env['nls'] and included_gettext:
1261 env['CPPPATH'].append('$BUILDDIR/intl')
1265 # A Link script for cygwin see
1266 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1267 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1270 if platform_name == 'cygwin':
1271 ld_script_path = '/tmp'
1272 ld_script = utils.installCygwinLDScript(ld_script_path)
1273 env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1274 '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1277 #---------------------------------------------------------
1278 # Frontend related variables (QTDIR etc)
1279 #---------------------------------------------------------
1282 # create a separate environment so that other files do not have
1283 # to be built with all the include directories etc
1285 if frontend == 'qt4':
1286 env['BUILDERS']['qtResource'] = Builder(action = utils.env_qtResource)
1288 # handle qt related user specified paths
1289 # set environment so that moc etc can be found even if its path is not set properly
1290 if env.has_key('qt_dir') and env['qt_dir']:
1291 env['QTDIR'] = env['qt_dir']
1292 if os.path.isdir(os.path.join(env['qt_dir'], 'bin')):
1293 os.environ['PATH'] += os.pathsep + os.path.join(env['qt_dir'], 'bin')
1294 env.PrependENVPath('PATH', os.path.join(env['qt_dir'], 'bin'))
1295 if os.path.isdir(os.path.join(env['qt_dir'], 'lib')):
1296 env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(env['qt_dir'], 'lib'))
1298 # if separate qt_lib_path is given
1299 if env.has_key('qt_lib_path') and env['qt_lib_path']:
1300 qt_lib_path = env.subst('$qt_lib_path')
1301 env.AppendUnique(LIBPATH = [qt_lib_path])
1302 env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1306 # if separate qt_inc_path is given
1307 if env.has_key('qt_inc_path') and env['qt_inc_path']:
1308 qt_inc_path = env['qt_inc_path']
1312 # local qt4 toolset from
1313 # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1315 # NOTE: I have to patch qt4.py since it does not automatically
1316 # process .C file!!! (add to cxx_suffixes )
1318 env.Tool('qt4', [scons_dir])
1319 env['QT_AUTOSCAN'] = 0
1320 env['QT4_AUTOSCAN'] = 0
1321 env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1322 if platform_name == 'win32':
1323 env['QT4_MOCFROMHFLAGS'] = '-D_WIN32'
1325 if qt_lib_path is None:
1326 qt_lib_path = os.path.join(env.subst('$QTDIR'), 'lib')
1327 if qt_inc_path is None:
1328 qt_inc_path = os.path.join(env.subst('$QTDIR'), 'include')
1331 conf = Configure(env,
1333 'CheckPackage' : utils.checkPackage,
1334 'CheckCommand' : utils.checkCommand,
1339 # first: try pkg_config
1340 if env['HAS_PKG_CONFIG']:
1341 succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1342 # FIXME: use pkg_config information?
1343 #env['QT4_PKG_CONFIG'] = succ
1344 # second: try to link to it
1346 # Under linux, I can test the following perfectly
1347 # Under windows, lib names need to passed as libXXX4.a ...
1348 if platform_name == 'win32':
1349 succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1351 succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1352 # still can not find it
1354 print 'Did not find qt libraries, exiting!'
1355 print 'Please check config.log for more information.'
1358 # Now, determine the correct suffix:
1359 qt_libs = ['QtCore', 'QtGui']
1360 if platform_name == 'win32':
1361 if mode == 'debug' and use_vc and \
1362 conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1363 qt_lib_suffix = 'd4'
1364 use_qt_debug_libs = True
1367 use_qt_debug_libs = False
1369 if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1370 qt_lib_suffix = '_debug'
1371 use_qt_debug_libs = True
1374 use_qt_debug_libs = False
1375 env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1376 frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1377 qtcore_lib = ['QtCore' + qt_lib_suffix]
1379 # check uic and moc commands for qt frontends
1380 if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1381 print 'uic or moc command is not found for frontend', frontend
1384 # now, if msvc2005 is used, we will need to embed lyx.exe.manifest to lyx.exe
1385 # NOTE: previously, lyx.exe had to be linked to some qt manifest to work.
1386 # For some unknown changes in msvc or qt, this is no longer needed.
1388 env['LINKCOM'] = [env['LINKCOM'], \
1389 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % \
1390 env.File('$BUILDDIR/lyx.exe.manifest').path]
1397 print env['VERSION_INFO']
1400 # Mingw command line may be too short for our link usage,
1401 # Here we use a trick from scons wiki
1402 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1404 # I also would like to add logging (commands only) capacity to the
1406 logfile = env.get('logfile', default_log_file)
1407 if logfile != '' or platform_name == 'win32':
1409 utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1410 info = '''# This is a log of commands used by scons to build lyx
1414 ''' % (time.asctime(), ' '.join(sys.argv),
1415 env['VERSION_INFO'].replace('\n','\n# ')) )
1420 # -h will print out help info
1421 Help(opts.GenerateHelpText(env))
1424 #----------------------------------------------------------
1426 #----------------------------------------------------------
1427 # this has been the source of problems on some platforms...
1428 # I find that I need to supply it with full path name
1429 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1430 # this usage needs further investigation.
1431 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1432 env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1433 env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1434 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1435 env.BuildDir('$BUILDDIR/src', '$TOP_SRCDIR/src', duplicate = 0)
1437 print "Building all targets recursively"
1439 def libExists(libname):
1440 ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1441 return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1444 if (included_boost and not libExists('included_boost_regex')) or 'boost' in BUILD_TARGETS:
1448 for lib in boost_libs:
1449 boostlib = env.StaticLibrary(
1450 target = '$LOCALLIBPATH/included_boost_%s' % lib,
1451 source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)],
1452 # do not use global CPPPATH because src/config.h will mess up with boost/config.h
1453 CPPPATH = ['$BUILDDIR/boost'] + extra_inc_paths,
1454 CCFLAGS = ['$CCFLAGS', '$INCPREFIX$TOP_SRCDIR/boost', '-DBOOST_USER_CONFIG="<config.h>"']
1456 Alias('boost', boostlib)
1459 if (included_gettext and not libExists('included_intl')) or 'intl' in BUILD_TARGETS:
1464 r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1465 r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1466 r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1468 '-DENABLE_RELOCATABLE=1',
1470 r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1472 '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1473 '-Drelocate=libintl_relocate',
1474 '-DDEPENDS_ON_LIBICONV=1',
1478 INTL_CCFLAGS.extend(['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1480 intl = env.StaticLibrary(
1481 target = '$LOCALLIBPATH/included_intl',
1483 CCFLAGS = INTL_CCFLAGS,
1484 # do not use global CPPPATH because src/config.h will mess up with intl/config.h
1485 CPPPATH = ['$BUILDDIR/intl'] + extra_inc_paths,
1486 source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1493 env['QT4_MOCHPREFIX'] = 'moc_'
1494 env['QT4_MOCHSUFFIX'] = '.cpp'
1496 support_moced_files = [env.Moc4('$BUILDDIR/src/support/%s' % x)
1497 for x in src_support_header_files ]
1498 support = env.StaticLibrary(
1499 target = '$LOCALLIBPATH/support',
1500 source = ['$BUILDDIR/src/support/%s' % x for x in src_support_files],
1507 CPPPATH = ['$CPPPATH', '$BUILDDIR/src/support']
1509 Alias('support', support)
1512 if env['HAVE_FCNTL']:
1513 client = env.Program(
1514 target = '$BUILDDIR/src/client/lyxclient',
1515 LIBS = ['support'] + intl_libs + system_libs +
1516 socket_libs + boost_libraries + qtcore_lib,
1517 source = ['$BUILDDIR/src/client/%s' % x for x in src_client_files] + \
1518 utils.createResFromIcon(env, 'lyx.ico', '$LOCALLIBPATH/client.rc')
1520 Alias('client', env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1521 client, [Copy('$TARGET', '$SOURCE')]))
1524 Alias('client', client)
1530 for file in src_tex2lyx_copied_files + src_tex2lyx_copied_header_files:
1531 env.Command('$BUILDDIR/src/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1532 [Copy('$TARGET', '$SOURCE')])
1534 tex2lyx = env.Program(
1535 target = '$BUILDDIR/src/tex2lyx/tex2lyx',
1536 LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1537 source = ['$BUILDDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files + src_tex2lyx_copied_files] + \
1538 utils.createResFromIcon(env, 'lyx.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1539 CPPPATH = ['$BUILDDIR/src/tex2lyx', '$BUILDDIR/src', '$CPPPATH'],
1540 LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1541 CCFLAGS = ['$CCFLAGS', '-DTEX2LYX'],
1543 Alias('tex2lyx', env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1544 tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1545 Alias('tex2lyx', tex2lyx)
1549 # Build lyx with given frontend
1551 if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1552 src_post_files.append('AspellChecker.cpp')
1553 elif env.has_key('USE_ENCHANT') and env['USE_ENCHANT']:
1554 src_post_files.append('EnchantChecker.cpp')
1555 elif env.has_key('USE_HUNSPELL') and env['USE_HUNSPELL']:
1556 src_post_files.append('HunspellChecker.cpp')
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 = [env.Moc4('$BUILDDIR/src/frontends/qt4/%s' % x)
1561 for x in src_frontends_qt4_header_files ]
1562 src_moced_files = [env.Moc4('$BUILDDIR/src/%s' % x)
1563 for x in src_header_files ]
1564 ui_files = [env.Uic4('$BUILDDIR/src/frontends/qt4/ui/%s' % x.split('.')[0])
1565 for x in src_frontends_qt4_ui_files]
1566 resource = env.Qrc(env.qtResource(
1567 '$BUILDDIR/src/frontends/qt4/Resource.qrc',
1568 ['$TOP_SRCDIR/lib/images/%s' % x for x in lib_images_files] +
1569 ['$TOP_SRCDIR/lib/images/math/%s' % x for x in lib_images_math_files] +
1570 ['$TOP_SRCDIR/lib/images/commands/%s' % x for x in lib_images_commands_files]))
1573 target = '$BUILDDIR/lyx',
1574 source = ['$BUILDDIR/src/main.cpp'] +
1575 ['$BUILDDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files] +
1577 ['$BUILDDIR/src/graphics/%s' % x for x in src_graphics_files] +
1578 ['$BUILDDIR/src/mathed/%s' % x for x in src_mathed_files] +
1579 ['$BUILDDIR/src/insets/%s' % x for x in src_insets_files] +
1580 ['$BUILDDIR/src/frontends/%s' % x for x in src_frontends_files] +
1581 ['$BUILDDIR/src/%s' % x for x in src_pre_files] +
1582 ["$BUILDDIR/src/%s" % x for x in src_post_files] +
1583 utils.createResFromIcon(env, 'lyx.ico', '$LOCALLIBPATH/lyx.rc'),
1587 '$BUILDDIR/src/images',
1588 '$BUILDDIR/src/frontends',
1589 '$BUILDDIR/src/frontends/qt4',
1590 '$BUILDDIR/src/frontends/qt4/ui',
1610 if use_vc and 'msvs_projects' in BUILD_TARGETS:
1611 def build_project(target, full_target = None, src = [], inc = [], res = []):
1612 ''' build mavs project files
1613 target: alias (correspond to directory name)
1614 full_target: full path/filename of the target
1619 For non-debug-able targets like static libraries, target (alias) is
1620 enough to build the target. For executable targets, msvs need to know
1621 the full path to start debug them.
1624 proj = env.MSVSProject(
1625 target = target + env['MSVSPROJECTSUFFIX'],
1626 # this allows easy access to header files (along with source)
1627 srcs = [env.subst(x) for x in src + inc],
1628 incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1629 localincs = [env.subst(x) for x in inc],
1630 resources = [env.subst(x) for x in res],
1631 buildtarget = full_target,
1634 Alias('msvs_projects', proj)
1636 build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1637 inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1638 full_target = File(env.subst('$BUILDDIR/src/client/lyxclient$PROGSUFFIX')).abspath)
1640 build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1641 inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1642 full_target = File(env.subst('$BUILDDIR/src/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1644 build_project('lyx',
1645 src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files + ['version.cpp']] + \
1646 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files + ['Package.cpp'] ] + \
1647 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1648 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1649 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1650 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1651 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1652 inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1653 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1654 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1655 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1656 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1657 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1658 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1659 res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1660 full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1663 if 'update_po' in BUILD_TARGETS:
1667 print 'Updating po/*.po files...'
1669 # whether or not update po files
1670 if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1671 print 'xgettext or msgmerge does not exist. Cannot merge po files'
1673 # rebuild POTFILES.in
1674 POTFILES_in = env.potfiles('$TOP_SRCDIR/po/POTFILES.in',
1675 ['$TOP_SRCDIR/src/%s' % x for x in src_header_files + src_pre_files + src_post_files + \
1676 src_extra_src_files] + \
1677 ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files + src_support_files + \
1678 src_support_extra_header_files + src_support_extra_src_files] + \
1679 ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files + src_mathed_files] + \
1680 ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files + src_insets_files] + \
1681 ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files + src_frontends_files] + \
1682 ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files + src_graphics_files] + \
1683 ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files + src_frontends_qt4_files] + \
1684 ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files + src_client_files ] + \
1685 ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files + src_tex2lyx_files ]
1687 Alias('update_po', POTFILES_in)
1688 # build language_l10n.pot, encodings_10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot, external_l10n, formats_l10n
1689 # and combine them to lyx.po
1690 env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1691 lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1692 env.Command('$BUILDDIR/po/all.po',
1693 [env.Command('$BUILDDIR/po/qt4_l10n.pot',
1694 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1695 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1696 env.Command('$BUILDDIR/po/layouts_l10n.pot',
1697 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files + lib_layouts_inc_files + lib_layouts_module_files],
1698 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
1699 env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages',
1700 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
1701 env.Command('$BUILDDIR/po/encodings_l10n.pot', '$TOP_SRCDIR/lib/encodings',
1702 '$LYX_POT -b $TOP_SRCDIR -t encodings -o $TARGET $SOURCES'),
1703 env.Command('$BUILDDIR/po/ui_l10n.pot',
1704 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
1705 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
1706 env.Command('$BUILDDIR/po/external_l10n.pot', '$TOP_SRCDIR/lib/external_templates',
1707 '$LYX_POT -b $TOP_SRCDIR -t external -o $TARGET $SOURCES'),
1708 env.Command('$BUILDDIR/po/formats_l10n.pot', '$TOP_SRCDIR/lib/configure.py',
1709 '$LYX_POT -b $TOP_SRCDIR -t formats -o $TARGET $SOURCES'),
1711 ['$MSGUNIQ -o $TARGET $SOURCE',
1712 '''$XGETTEXT --default-domain=${TARGET.base} \
1713 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
1714 --language=C++ --join-existing \
1715 --keyword=_ --keyword=N_ --keyword=B_ --keyword=qt_ \
1716 --files-from=$TOP_SRCDIR/po/POTFILES.in \
1717 --copyright-holder="LyX Developers" \
1718 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
1720 env.Depends(lyx_po, POTFILES_in)
1721 # copy lyx.po to lyx.pot
1722 lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
1723 Copy('$TARGET', '$SOURCE'))
1726 # files to translate
1727 transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
1728 # possibly *only* handle these languages
1730 if env.has_key('languages'):
1731 languages = env.make_list(env['languages'])
1732 # merge. if I use lan.po as $TARGET, it will be removed
1733 # before it is merged. In this builder,
1734 # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
1735 # and is copied to po/lang.po
1736 env['BUILDERS']['msgmerge'] = Builder(action=[
1737 '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
1738 Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
1740 # for each po file, generate pot
1741 for po_file in transfiles:
1743 fname = os.path.split(po_file)[1]
1745 country = fname.split('.')[0]
1747 if not languages or country in languages:
1748 # merge po files, the generated lan.po_new file is copied to lan.po file.
1749 po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
1750 env.Depends(po, POTFILES_in)
1751 Alias('update_po', po)
1754 # if 'install' is not in the target, do not process this
1755 if 'install' in BUILD_TARGETS or 'installer' in BUILD_TARGETS:
1757 # this part is a bit messy right now. Since scons will provide
1758 # --DESTDIR option soon, at least the dest_dir handling can be
1767 # files to translate
1768 transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
1769 # possibly *only* handle these languages
1771 if env.has_key('languages'):
1772 languages = env.make_list(env['lanauges'])
1773 # use defulat msgfmt
1775 if not env['MSGFMT']:
1776 print 'msgfmt does not exist. Can not process po files'
1779 env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
1781 for f in transfiles:
1783 fname = os.path.split(f)[1]
1785 country = fname.split('.')[0]
1787 if not languages or country in languages:
1788 gmo_files.extend(env.Transfiles(f))
1789 # how to join dest_dir and prefix
1790 def joinPaths(path1, path2):
1791 ''' join path1 and path2, do not use os.path.join because
1792 under window, c:\destdir\d:\program is invalid '''
1794 return os.path.normpath(path2)
1795 # separate drive letter
1796 (drive, path) = os.path.splitdrive(os.path.normpath(path2))
1797 # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
1798 return os.path.join(os.path.normpath(path1), path[1:])
1800 # install to dest_dir/prefix
1801 dest_dir = env.get('DESTDIR', '')
1802 dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
1803 # create the directory if needed
1804 if not os.path.isdir(dest_prefix_dir):
1806 os.makedirs(dest_prefix_dir)
1809 if not os.path.isdir(dest_prefix_dir):
1810 print 'Can not create directory', dest_prefix_dir
1813 if env.has_key('exec_prefix'):
1814 bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
1816 bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
1818 share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
1820 share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
1821 man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
1822 locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
1823 env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
1827 # install executables (lyxclient may be None)
1830 version_suffix = program_suffix
1834 # install lyx, if in release mode, try to strip the binary
1835 if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
1836 # create a builder to strip and install
1837 env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
1839 # install executables
1840 for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
1843 target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
1844 target = os.path.join(bin_dest_dir, target_name)
1845 if env['BUILDERS'].has_key('StripInstallAs'):
1846 env.StripInstallAs(target, obj)
1848 env.InstallAs(target, obj)
1849 Alias('install', target)
1853 for (dir,files) in [
1855 ('bind', lib_bind_files),
1856 ('bind/de', lib_bind_de_files),
1857 ('bind/fi', lib_bind_fi_files),
1858 ('bind/pt', lib_bind_pt_files),
1859 ('bind/sv', lib_bind_sv_files),
1860 ('commands', lib_commands_files),
1861 ('doc', lib_doc_files),
1862 ('doc/biblio', lib_doc_biblio_files),
1863 ('doc/clipart', lib_doc_clipart_files),
1864 ('doc/ca', lib_doc_ca_files),
1865 ('doc/cs', lib_doc_cs_files),
1866 ('doc/da', lib_doc_da_files),
1867 ('doc/de', lib_doc_de_files),
1868 ('doc/de/clipart', lib_doc_de_clipart_files),
1869 ('doc/es', lib_doc_es_files),
1870 ('doc/es/clipart', lib_doc_es_clipart_files),
1871 ('doc/eu', lib_doc_eu_files),
1872 ('doc/fr', lib_doc_fr_files),
1873 ('doc/fr/clipart', lib_doc_fr_clipart_files),
1874 ('doc/gl', lib_doc_gl_files),
1875 ('doc/he', lib_doc_he_files),
1876 ('doc/hu', lib_doc_hu_files),
1877 ('doc/id', lib_doc_id_files),
1878 ('doc/id/clipart', lib_doc_id_clipart_files),
1879 ('doc/it', lib_doc_it_files),
1880 ('doc/it/clipart', lib_doc_it_clipart_files),
1881 ('doc/ja', lib_doc_ja_files),
1882 ('doc/ja/clipart', lib_doc_ja_clipart_files),
1883 ('doc/nl', lib_doc_nl_files),
1884 ('doc/nb', lib_doc_nb_files),
1885 ('doc/pl', lib_doc_pl_files),
1886 ('doc/pt', lib_doc_pt_files),
1887 ('doc/ro', lib_doc_ro_files),
1888 ('doc/ru', lib_doc_ru_files),
1889 ('doc/sk', lib_doc_sk_files),
1890 ('doc/sl', lib_doc_sl_files),
1891 ('doc/sv', lib_doc_sv_files),
1892 ('doc/uk', lib_doc_uk_files),
1893 ('doc/uk/clipart', lib_doc_uk_clipart_files),
1894 ('doc/zh_CN', lib_doc_zhCN_files),
1895 ('examples', lib_examples_files),
1896 ('examples/ca', lib_examples_ca_files),
1897 ('examples/cs', lib_examples_cs_files),
1898 ('examples/da', lib_examples_da_files),
1899 ('examples/de', lib_examples_de_files),
1900 ('examples/es', lib_examples_es_files),
1901 ('examples/eu', lib_examples_eu_files),
1902 ('examples/fa', lib_examples_fa_files),
1903 ('examples/fr', lib_examples_fr_files),
1904 ('examples/gl', lib_examples_gl_files),
1905 ('examples/he', lib_examples_he_files),
1906 ('examples/hu', lib_examples_hu_files),
1907 ('examples/id', lib_examples_id_files),
1908 ('examples/it', lib_examples_it_files),
1909 ('examples/ja', lib_examples_ja_files),
1910 ('examples/nl', lib_examples_nl_files),
1911 ('examples/pl', lib_examples_pl_files),
1912 ('examples/pt', lib_examples_pt_files),
1913 ('examples/ro', lib_examples_ro_files),
1914 ('examples/ru', lib_examples_ru_files),
1915 ('examples/sk', lib_examples_sk_files),
1916 ('examples/sl', lib_examples_sl_files),
1917 ('examples/uk', lib_examples_uk_files),
1918 ('fonts', lib_fonts_files),
1919 ('images', lib_images_files),
1920 ('images/math', lib_images_math_files),
1921 ('images/commands', lib_images_commands_files),
1922 ('kbd', lib_kbd_files),
1923 ('layouts', lib_layouts_files + lib_layouts_inc_files + lib_layouts_module_files),
1924 ('lyx2lyx', lib_lyx2lyx_files),
1925 ('scripts', lib_scripts_files),
1926 ('templates', lib_templates_files),
1927 ('tex', lib_tex_files),
1928 ('ui', lib_ui_files)]:
1929 dirs.append(env.Install(os.path.join(share_dest_dir, dir),
1930 [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
1931 Alias('install', dirs)
1933 # subst and install lyx2lyx_version.py which is not in scons_manifest.py
1934 env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/src/config.h')
1935 env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
1936 '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
1937 Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
1938 sys.path.append(share_dest_dir + '/lyx2lyx')
1940 if platform_name == 'cygwin':
1941 # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
1942 Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin',
1943 '%s-%s.README' % (package, package_cygwin_version))
1944 env.InstallAs(Cygwin_README,
1945 os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
1946 Alias('install', Cygwin_README)
1947 # also a directory /usr/share/doc/lyx for README etc
1948 Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
1949 env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
1950 ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
1951 Alias('install', Cygwin_Doc)
1952 # cygwin fonts also need to be installed
1953 Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
1954 env.Install(Cygwin_fonts,
1955 [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
1956 for file in win32_bakoma_fonts])
1957 Alias('install', Cygwin_fonts)
1958 # we also need a post installation script
1959 tmp_script = utils.installCygwinPostinstallScript('/tmp')
1960 postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
1961 env.Install(postinstall_path, tmp_script)
1962 Alias('install', postinstall_path)
1964 env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
1965 env.subst('$TOP_SRCDIR/lyx.1in'))
1966 env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
1967 env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.1in'))
1968 env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
1969 env.subst('$TOP_SRCDIR/src/client/lyxclient.1in'))
1970 Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
1971 x in ['lyx', 'tex2lyx', 'lyxclient']])
1973 # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
1974 for gmo in gmo_files:
1975 lan = os.path.split(str(gmo))[1].split('.')[0]
1976 dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
1977 env.InstallAs(dest_file, gmo)
1978 Alias('install', dest_file)
1981 if 'installer' in BUILD_TARGETS:
1983 # build windows installer using NSIS
1986 # There is a nsis builder on scons wiki but it does not work with
1987 # our lyx.nsi because it does not dig through all the include directives
1988 # and find the dependencies automatically. Also, it can not parse
1989 # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
1990 # something rely on date.
1991 # Because of this, I am doing a simple nsis builder here.
1992 if platform_name != 'win32':
1993 print 'installer target is only available for windows platform'
1995 if mode != 'release':
1996 print 'installer has to be built in release mode (use option mode=release)'
1998 installer_files = ['$TOP_SRCDIR/development/Win32/packaging/installer/%s' \
1999 % x for x in development_Win32_packaging_installer] + \
2000 ['$TOP_SRCDIR/development/Win32/packaging/installer/graphics/%s' \
2001 % x for x in development_Win32_packaging_installer_graphics] + \
2002 ['$TOP_SRCDIR/development/Win32/packaging/installer/gui/%s' \
2003 % x for x in development_Win32_packaging_installer_gui] + \
2004 ['$TOP_SRCDIR/development/Win32/packaging/installer/include/%s' \
2005 % x for x in development_Win32_packaging_installer_include] + \
2006 ['$TOP_SRCDIR/development/Win32/packaging/installer/lang/%s' \
2007 % x for x in development_Win32_packaging_installer_lang] + \
2008 ['$TOP_SRCDIR/development/Win32/packaging/installer/setup/%s' \
2009 % x for x in development_Win32_packaging_installer_setup]
2010 if env.has_key('NSIS') and env['NSIS'] is not None:
2011 # create a builder to strip and install
2012 env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2014 print 'No nsis compiler is found. Existing...'
2016 if not env.has_key('win_installer') or env['win_installer'] is None:
2018 env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2020 env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2021 # provide default setting
2022 if not env.has_key('deps_dir') or env['deps_dir'] is None:
2023 env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2024 if not os.path.isdir(env.Dir('$deps_dir').abspath):
2025 print 'Development dependency package is not found.'
2028 env['deps_dir'] = env.Dir('$deps_dir').abspath
2030 if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2031 env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2032 elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2033 env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2035 env['bundle_dir'] = None
2036 # if absolute path is given, use it, otherwise, write to current directory
2037 if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2038 env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2039 env.Append(NSISDEFINES={
2040 'ExeFile':env['win_installer'],
2041 'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2042 'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2043 'FilesDeps':env['deps_dir'],
2044 'FilesBundle':env['bundle_dir'],
2046 installer = env.installer(env['win_installer'],
2047 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2048 # since I can not use a scanner, explicit dependent is required
2049 env.Depends(installer, 'install')
2050 env.Depends(installer, installer_files)
2051 env.Alias('installer', installer)
2052 # also generate bundle?
2053 if env.has_key('bundle') and env['bundle']:
2054 if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2055 print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2056 print 'Use bundle_dir option to specify'
2058 # generator of the builder will add bundle stuff depending on output name
2059 bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2060 '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2061 env.Depends(bundle_installer, 'install')
2062 env.Depends(bundle_installer, installer_files)
2063 env.Alias('installer', bundle_installer)
2066 Alias('all', ['lyx', 'client', 'tex2lyx'])