]> git.lyx.org Git - lyx.git/blob - development/scons/SConstruct
Rename version.C.in to version.cpp.in, and Package.C.in to package.cpp.in
[lyx.git] / development / scons / SConstruct
1 # vi:filetype=python:expandtab:tabstop=4:shiftwidth=4
2 #
3 # file SConstruct
4 #
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
7 #
8 # \author Bo Peng
9 # Full author contact details are available in file CREDITS.
10 #
11 # This is a scons based building system for lyx, please refer
12 # to INSTALL.scons for detailed instructions.
13 #
14
15 import os, sys, copy, cPickle, glob, time
16
17 # scons_utils.py defines a few utility function
18 import scons_utils as utils
19 # import all file lists
20 from scons_manifest import *
21
22 #----------------------------------------------------------
23 # Required runtime environment
24 #----------------------------------------------------------
25
26 # scons asks for 1.5.2, lyx requires 2.3
27 EnsurePythonVersion(2, 3)
28 # Please use at least 0.96.92 (not 0.96.1)
29 EnsureSConsVersion(0, 96)
30 # also check for minor version number for scons 0.96
31 from SCons import __version__
32 version = map(int, __version__.split('.'))
33 if version[0] == 0 and version[1] == 96 and version[2] < 92:
34     print "Scons >= 0.96.92 is required."
35     Exit(1)
36
37 # determine where I am ...
38 #
39 from SCons.Node.FS import default_fs
40 # default_fs.SConstruct_dir is where SConstruct file is located.
41 scons_dir = default_fs.SConstruct_dir.path
42 # get the ../.. of scons_dir
43 top_src_dir = os.path.split(os.path.split(default_fs.SConstruct_dir.abspath)[0])[0]
44 sys.path.append(os.path.join(top_src_dir, 'lib', 'doc'))
45 import depend
46
47 #----------------------------------------------------------
48 # Global definitions
49 #----------------------------------------------------------
50
51 # some global settings
52 #
53 # get version number from configure.ac so that JMarc does
54 # not have to change SConstruct during lyx release
55 package_version = utils.getVerFromConfigure(top_src_dir)
56 package_cygwin_version = '%s-1' % package_version
57 boost_version = ['1_34']
58
59 if 'svn' in package_version:
60     devel_version = True
61     default_build_mode = 'debug'
62 else:
63     devel_version = False
64     default_build_mode = 'release'
65
66 package = 'lyx'
67 package_bugreport = 'lyx-devel@lists.lyx.org'
68 package_name = 'LyX'
69 package_tarname = 'lyx'
70 package_string = '%s %s' % (package_name, package_version)
71
72 # various cache/log files
73 default_log_file = 'scons_lyx.log'
74 opt_cache_file = 'opt.cache'
75
76
77 #----------------------------------------------------------
78 # platform dependent settings
79 #----------------------------------------------------------
80
81 if os.name == 'nt':
82     platform_name = 'win32'
83     default_prefix = 'c:/program files/lyx'
84     default_with_x = False
85     default_packaging_method = 'windows'
86 elif os.name == 'posix' and sys.platform != 'cygwin':
87     platform_name = sys.platform
88     default_prefix = '/usr/local'
89     default_with_x = True
90     default_packaging_method = 'posix'
91 elif os.name == 'posix' and sys.platform == 'cygwin':
92     platform_name = 'cygwin'
93     default_prefix = '/usr'
94     default_with_x = True
95     default_packaging_method = 'posix'
96 elif os.name == 'darwin':
97     platform_name = 'macosx'
98     # FIXME: macOSX default prefix?
99     default_prefix = '.'
100     default_with_x = False
101     default_packaging_method = 'macosx'
102 else:  # unsupported system, assume posix behavior
103     platform_name = 'others'
104     default_prefix = '.'
105     default_with_x = True
106     default_packaging_method = 'posix'
107
108 #---------------------------------------------------------
109 # Handling options
110 #----------------------------------------------------------
111 #
112 # You can set perminant default values in config.py
113 if os.path.isfile('config.py'):
114     print "Getting options from config.py..."
115     print open('config.py').read()
116
117 opts = Options(['config.py'])
118 opts.AddOptions(
119     # frontend
120     EnumOption('frontend', 'Main GUI', 'qt4',
121         allowed_values = ('qt4',) ),
122     # debug or release build
123     EnumOption('mode', 'Building method', default_build_mode,
124         allowed_values = ('debug', 'release') ),
125     # boost libraries
126     EnumOption('boost',
127         'Use included, system boost library, or try sytem boost first.',
128         'auto', allowed_values = (
129             'auto',       # detect boost, if not found, use included
130             'included',   # always use included boost
131             'system',     # always use system boost, fail if can not find
132             ) ),
133     #
134     EnumOption('gettext',
135         'Use included, system gettext library, or try sytem gettext first',
136         'auto', allowed_values = (
137             'auto',       # detect gettext, if not found, use included
138             'included',   # always use included gettext
139             'system',     # always use system gettext, fail if can not find
140             ) ),
141     #
142     EnumOption('spell', 'Choose spell checker to use.', 'auto',
143         allowed_values = ('aspell', 'pspell', 'ispell', 'auto', 'no') ),
144     # packaging method
145     EnumOption('packaging', 'Packaging method to use.', default_packaging_method,
146         allowed_values = ('windows', 'posix', 'macosx')),
147     #
148     BoolOption('fast_start', 'This option is obsolete.', False),
149     # No precompiled header support (too troublesome to make it work for msvc)
150     # BoolOption('pch', 'Whether or not use pch', False),
151     # enable assertion, (config.h has ENABLE_ASSERTIOS
152     BoolOption('assertions', 'Use assertions', True),
153     # enable warning, (config.h has WITH_WARNINGS)
154     # default to False since MSVC does not have #warning
155     BoolOption('warnings', 'Use warnings', False),
156     # config.h define _GLIBCXX_CONCEPT_CHECKS
157     # Note: for earlier version of gcc (3.3) define _GLIBCPP_CONCEPT_CHECKS
158     BoolOption('concept_checks', 'Enable concept checks', True),
159     #
160     BoolOption('nls', 'Whether or not use native language support', True),
161     #
162     BoolOption('profiling', 'Whether or not enable profiling', False),
163     # config.h define _GLIBCXX_DEBUG and _GLIBCXX_DEBUG_PEDANTIC
164     BoolOption('stdlib_debug', 'Whether or not turn on stdlib debug', False),
165     # using x11?
166     BoolOption('X11', 'Use x11 windows system', default_with_x),
167     # use MS VC++ to build lyx
168     BoolOption('use_vc', 'Use MS VC++ to build lyx (cl.exe will be probed)', None),
169     #
170     PathOption('qt_dir', 'Path to qt directory', None),
171     #
172     PathOption('qt_inc_path', 'Path to qt include directory', None),
173     #
174     PathOption('qt_lib_path', 'Path to qt library directory', None),
175     # extra include and libpath
176     PathOption('extra_inc_path', 'Extra include path', None),
177     #
178     PathOption('extra_lib_path', 'Extra library path', None),
179     #
180     PathOption('extra_bin_path', 'A convenient way to add a path to $PATH', None),
181     #
182     PathOption('extra_inc_path1', 'Extra include path', None),
183     #
184     PathOption('extra_lib_path1', 'Extra library path', None),
185     # rebuild only specifed, comma separated targets
186     ('rebuild', '''rebuild only specifed, comma separated targets.
187         yes or all (default): rebuild everything
188         no or none: rebuild nothing (usually used for installation)
189         comp1,comp2,...: rebuild specified targets''', None),
190     # can be set to a non-existing directory
191     ('prefix', 'install architecture-independent files in PREFIX', default_prefix),
192     # replace the default name and location of the windows installer
193     ('win_installer', 'name or full path to the windows installer', None),
194     # the deps package used to create minimal installer (qt and other libraries)
195     ('deps_dir', 'path to the development depedency packages with zlib, iconv, zlib and qt libraries', None),
196     # whether or not build bundle installer
197     BoolOption('bundle', 'Whether or not build bundle installer', False),
198     # the bundle directory, containing bundled applications
199     PathOption('bundle_dir', 'path to the bundle dependency package with miktex setup.exe etc', None),
200     # build directory, will use $mode if not set
201     ('build_dir', 'Build directory', None),
202     # version suffix
203     ('version_suffix', 'install lyx as lyx-suffix', None),
204     # how to load options
205     ('load_option', '''load option from previous scons run. option can be
206         yes (default): load all options
207         no: do not load any option
208         opt1,opt2: load specified options
209         -opt1,opt2: load all options other than specified ones''', 'yes'),
210     #
211     ('optimization', 'optimization CCFLAGS option.', None),
212     #
213     PathOption('exec_prefix', 'install architecture-independent executable files in PREFIX', None),
214     # log file
215     ('logfile', 'save commands (not outputs) to logfile', default_log_file),
216     # provided for backward compatibility
217     ('dest_dir', 'install to DESTDIR. (Provided for backward compatibility only)', None),
218     # environment variable can be set as options.
219     ('DESTDIR', 'install to DESTDIR', None),
220     ('CC', 'replace default $CC', None),
221     ('LINK', 'replace default $LINK', None),
222     ('CPP', 'replace default $CPP', None),
223     ('CXX', 'replace default $CXX', None),
224     ('CXXCPP', 'replace default $CXXCPP', None),
225     ('CCFLAGS', 'replace default $CCFLAGS', None),
226     ('CPPFLAGS', 'replace default $CPPFLAGS', None),
227     ('LINKFLAGS', 'replace default $LINKFLAGS', None),
228 )
229
230 # allowed options
231 all_options = [x.key for x in opts.options]
232
233 # copied from SCons/Options/BoolOption.py
234 # We need to use them before a boolean ARGUMENTS option is available
235 # in env as bool.
236 true_strings  = ('y', 'yes', 'true', 't', '1', 'on' , 'all' )
237 false_strings = ('n', 'no', 'false', 'f', '0', 'off', 'none')
238
239 if ARGUMENTS.has_key('fast_start'):
240     print 'fast_start option is obsolete'
241
242 # if load_option=yes (default), load saved comand line options
243 #
244 # This option can take value yes/no/opt1,opt2/-opt1,opt2
245 # and tries to be clever in choosing options to load
246 if (not ARGUMENTS.has_key('load_option') or \
247     ARGUMENTS['load_option'] not in false_strings) \
248     and os.path.isfile(opt_cache_file):
249     cache_file = open(opt_cache_file)
250     opt_cache = cPickle.load(cache_file)
251     cache_file.close()
252     # import cached options, but we should ignore qt_dir when frontend changes
253     if ARGUMENTS.has_key('frontend') and opt_cache.has_key('frontend') \
254         and ARGUMENTS['frontend'] != opt_cache['frontend'] \
255         and opt_cache.has_key('qt_dir'):
256         opt_cache.pop('qt_dir')
257     # and we do not cache some options (dest_dir is obsolete)
258     for arg in ['load_option', 'dest_dir', 'bundle']:
259         if opt_cache.has_key(arg):
260             opt_cache.pop(arg)
261     # remove obsolete cached keys (well, SConstruct is evolving. :-)
262     for arg in opt_cache.keys():
263         if arg not in all_options:
264             print 'Option %s is obsolete, do not load it' % arg
265             opt_cache.pop(arg)
266     # now, if load_option=opt1,opt2 or -opt1,opt2
267     if ARGUMENTS.has_key('load_option') and \
268         ARGUMENTS['load_option'] not in true_strings + false_strings:
269         # if -opt1,opt2 is specified, do not load these options
270         if ARGUMENTS['load_option'][0] == '-':
271             for arg in ARGUMENTS['load_option'][1:].split(','):
272                 if opt_cache.has_key(arg):
273                     opt_cache.pop(arg)
274         # if opt1,opt2 is specified, only load specified options
275         else:
276             args = ARGUMENTS['load_option'].split(',')
277             for arg in opt_cache.keys():
278                 if arg not in args:
279                     opt_cache.pop(arg)
280     # now restore options as if entered from command line
281     for key in opt_cache.keys():
282         if not ARGUMENTS.has_key(key):
283             ARGUMENTS[key] = opt_cache[key]
284             print "Restoring cached option  %s=%s" % (key, ARGUMENTS[key])
285     print
286
287 # check if there is unused (or misspelled) argument
288 for arg in ARGUMENTS.keys():
289     if arg not in all_options:
290         import textwrap
291         print "Unknown option '%s'... exiting." % arg
292         print
293         print "Available options are (check 'scons -help' for details):"
294         print '    ' + '\n    '.join(textwrap.wrap(',  '.join(all_options)))
295         Exit(1)
296
297 # save options used
298 cache_file = open(opt_cache_file, 'w')
299 cPickle.dump(ARGUMENTS, cache_file)
300 cache_file.close()
301
302 #---------------------------------------------------------
303 # Setting up environment
304 #---------------------------------------------------------
305
306 # I do not really like ENV=os.environ, but you may add it
307 # here if you experience some environment related problem
308 env = Environment(options = opts)
309
310 # set individual variables since I do not really like ENV = os.environ
311 env['ENV']['PATH'] = os.environ.get('PATH')
312 env['ENV']['HOME'] = os.environ.get('HOME')
313 # these are defined for MSVC
314 env['ENV']['LIB'] = os.environ.get('LIB')
315 env['ENV']['INCLUDE'] = os.environ.get('INCLUDE')
316
317 # for simplicity, use var instead of env[var]
318 frontend = env['frontend']
319 prefix = env['prefix']
320 mode = env['mode']
321
322 if platform_name == 'win32':
323     if env.has_key('use_vc'):
324         use_vc = env['use_vc']
325         if WhereIs('cl.exe') is None:
326             print "cl.exe is not found. Are you using the MSVC environment?"
327             Exit(2)
328     elif WhereIs('cl.exe') is not None:
329         use_vc = True
330     else:
331         use_vc = False
332 else:
333     use_vc = False
334
335 # lyx will be built to $build/build_dir so it is possible
336 # to build multiple build_dirs using the same source
337 # $mode can be debug or release
338 if env.has_key('build_dir') and env['build_dir'] is not None:
339     # create the directory if needed
340     if not os.path.isdir(env['build_dir']):
341         try:
342             os.makedirs(env['build_dir'])
343         except:
344             pass
345         if not os.path.isdir(env['build_dir']):
346             print 'Can not create directory', env['build_dir']
347             Exit(3)
348     env['BUILDDIR'] = env['build_dir']
349 else:
350     # Determine the name of the build $mode
351     env['BUILDDIR'] = '#' + mode
352
353 # all built libraries will go to build_dir/libs
354 # (This is different from the make file approach)
355 env['LOCALLIBPATH'] = '$BUILDDIR/libs'
356 env.AppendUnique(LIBPATH = ['$LOCALLIBPATH'])
357
358
359 # Here is a summary of variables defined in env
360 # 1. defined options
361 # 2. undefined options with a non-None default value
362 # 3. compiler commands and flags like CCFLAGS.
363 #     MSGFMT used to process po files
364 # 4. Variables that will be used to replace variables in some_file.in
365 #     src/support/Package.cpp.in:
366 #       TOP_SRCDIR, LOCALEDIR, LYX_DIR, PROGRAM_SUFFIX
367 #     lib/lyx2lyx/lyx2lyx_version.py.in
368 #       PACKAGE_VERSION
369 #     src/version.cpp.in
370 #       PACKAGE_VERSION, LYX_DATE, VERSION_INFO
371
372 # full path name is used to build msvs project files
373 # and to replace TOP_SRCDIR in package.C
374 env['TOP_SRCDIR'] = Dir(top_src_dir).abspath
375 # needed by src/version.cpp.in => src/version.C
376 env['PACKAGE_VERSION'] = package_version
377 env['LYX_DATE'] = time.asctime()
378
379 # determine share_dir etc
380 packaging_method = env.get('packaging')
381 if packaging_method == 'windows':
382     share_dir = 'Resources'
383     man_dir = 'Resources/man/man1'
384     locale_dir = 'Resources/locale'
385 else:
386     share_dir = 'share/lyx'
387     locale_dir = 'share/locale'
388     if platform_name == 'cygwin':
389         man_dir = 'share/man/man1'
390     else:
391         man_dir = 'man/man1'
392
393 # program suffix: can be yes, or a string
394 if env.has_key('version_suffix'):
395     if env['version_suffix'] in true_strings:
396         program_suffix = package_version
397     elif env['version_suffix'] in false_strings:
398         program_suffix = ''
399     else:
400         program_suffix = env['version_suffix']
401 else:
402     program_suffix = ''
403 # used by Package.cpp.in
404 env['PROGRAM_SUFFIX'] = program_suffix
405
406 # whether or not add suffix to file and directory names
407 add_suffix = packaging_method != 'windows'
408 # LYX_DIR are different (used in Package.cpp.in)
409 if add_suffix:
410     env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir + program_suffix)).abspath
411 else:
412     env['LYX_DIR'] = Dir(os.path.join(prefix, share_dir)).abspath
413 # we need absolute path for package.C
414 env['LOCALEDIR'] = Dir(os.path.join(prefix, locale_dir)).abspath
415
416
417 #---------------------------------------------------------
418 # Setting building environment (Tools, compiler flags etc)
419 #---------------------------------------------------------
420
421 # Since Tool('mingw') will reset CCFLAGS etc, this should be
422 # done before getEnvVariable
423 if platform_name == 'win32':
424     if use_vc:
425         env.Tool('msvc')
426         env.Tool('mslink')
427     else:
428         env.Tool('mingw')
429         env.AppendUnique(CPPPATH = ['#c:/MinGW/include'])
430         # fix a scons winres bug (there is a missing space between ${RCINCPREFIX} and ${SOURCE.dir}
431         # in version 0.96.93
432         env['RCCOM'] = '$RC $_CPPDEFFLAGS $RCINCFLAGS ${RCINCPREFIX} ${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
433     
434
435 # we differentiate between hard-coded options and default options
436 # hard-coded options are required and will always be there
437 # default options can be replaced by enviromental variables or command line options
438 CCFLAGS_required = []
439 LINKFLAGS_required = []
440 CCFLAGS_default = []
441
442 # under windows, scons is confused by .C/.c and uses gcc instead of
443 # g++. I am forcing the use of g++ here. This is expected to change
444 # after lyx renames all .C files to .cpp
445 #
446 # save the old c compiler and CCFLAGS (used by libintl)
447 C_COMPILER = env.subst('$CC')
448 C_CCFLAGS = env.subst('$CCFLAGS').split()
449 # if we use ms vc, the commands are fine (cl.exe and link.exe)
450 if use_vc:
451     # /TP treat all source code as C++
452     # C4819: The file contains a character that cannot be represented
453     #   in the current code page (number)
454     # C4996: foo was decleared deprecated
455     CCFLAGS_required.extend(['/TP', '/EHsc'])
456     if mode == 'debug':
457         CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
458         # the flags are also needed in C mode (for intl lib)
459         C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MDd'])
460     else:
461         CCFLAGS_default.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
462         C_CCFLAGS.extend(['/wd4819', '/wd4996', '/nologo', '/MD'])
463 else:
464     if env.has_key('CXX') and env['CXX']:
465         env['CC'] = env.subst('$CXX')
466         env['LINK'] = env.subst('$CXX')
467     else:
468         env['CC'] = 'g++'
469         env['LINK'] = 'g++'
470
471 # for debug/release mode
472 if env.has_key('optimization') and env['optimization'] is not None:
473     # if user supplies optimization flags, use it anyway
474     CCFLAGS_required.extend(env['optimization'].split())
475     # and do not use default
476     set_default_optimization_flags = False
477 else:
478     set_default_optimization_flags = True
479
480 if mode == 'debug':
481     if use_vc:
482         CCFLAGS_required.append('/Zi')
483         LINKFLAGS_required.extend(['/debug', '/map'])
484     else:
485         CCFLAGS_required.append('-g')
486         CCFLAGS_default.append('-O')
487 elif mode == 'release' and set_default_optimization_flags:
488     if use_vc:
489         CCFLAGS_default.append('/O2')
490     else:
491         CCFLAGS_default.append('-O2')
492
493 # msvc uses separate tools for profiling
494 if env.has_key('profiling') and env['profiling']:
495     if use_vc:
496         print 'Visual C++ does not use profiling options'
497     else:
498         CCFLAGS_required.append('-pg')
499         LINKFLAGS_required.append('-pg')
500
501 if env.has_key('warnings') and env['warnings']:
502     if use_vc:
503         CCFLAGS_default.append('/W2')
504     else:
505         # Note: autotools detect gxx version and pass -W for 3.x
506         # and -Wextra for other versions of gcc
507         CCFLAGS_default.append('-Wall')
508
509 # Now, set the variables as follows:
510 # 1. if command line option exists: replace default
511 # 2. then if s envronment variable exists: replace default
512 # 3. set variable to required + default
513 def setEnvVariable(env, name, required = None, default = None, split = True):
514     ''' env: environment to set variable
515             name: variable
516             required: hardcoded options
517             default: default options that can be replaced by command line or
518                 environment variables
519             split: whether or not split obtained variable like '-02 -g'
520     '''
521     # 1. ARGUMENTS is already set to env[name], override default.
522     if ARGUMENTS.has_key(name):
523         # env[name] may be rewritten when building tools are reloaded
524         # if that is the case, commandline option will override it.
525         env[name] = ARGUMENTS[name]
526         default = None
527     # then use environment default
528     elif os.environ.has_key(name):
529         print "Acquiring variable %s from system environment: %s" % (name, os.environ[name])
530         default = os.environ[name]
531         if split:
532             default = default.split()
533     # the real value should be env[name] + default + required
534     if split:
535         value = []
536         if env.has_key(name):
537             value = str(env[name]).split()
538         if required is not None:
539             value += required
540         if default is not None:
541             value += default
542     else:
543         value = ""
544         if env.has_key(name):
545             value = str(env[name])
546         if required is not None:
547             value += " " + required
548         if default is not None:
549             value += " " + default
550     env[name] = value
551     # print name, env[name]
552
553 setEnvVariable(env, 'DESTDIR', split=False)
554 setEnvVariable(env, 'CC')
555 setEnvVariable(env, 'LINK')
556 setEnvVariable(env, 'CPP')
557 setEnvVariable(env, 'CXX')
558 setEnvVariable(env, 'CXXCPP')
559 setEnvVariable(env, 'CCFLAGS', CCFLAGS_required, CCFLAGS_default)
560 setEnvVariable(env, 'CXXFLAGS')
561 setEnvVariable(env, 'CPPFLAGS')
562 setEnvVariable(env, 'LINKFLAGS', LINKFLAGS_required)
563
564 # if DESTDIR is not set...
565 if env.has_key('dest_dir'):
566     print "This option is obsolete. Please use DESTDIR instead."
567     env['DESTDIR'] = env['dest_dir']
568
569 #
570 # extra_inc_path and extra_lib_path
571 #
572 extra_inc_paths = []
573 if env.has_key('extra_inc_path') and env['extra_inc_path']:
574     extra_inc_paths.append(env['extra_inc_path'])
575 if env.has_key('extra_lib_path') and env['extra_lib_path']:
576     env.AppendUnique(LIBPATH = [env['extra_lib_path']])
577 if env.has_key('extra_inc_path1') and env['extra_inc_path1']:
578     extra_inc_paths.append(env['extra_inc_path1'])
579 if env.has_key('extra_lib_path1') and env['extra_lib_path1']:
580     env.AppendUnique(LIBPATH = [env['extra_lib_path1']])
581 if env.has_key('extra_bin_path') and env['extra_bin_path']:
582     # only the first one is needed (a scons bug?)
583     os.environ['PATH'] += os.pathsep + env['extra_bin_path']
584     env.PrependENVPath('PATH', env['extra_bin_path'])
585 # extra_inc_paths will be used later by intlenv etc
586 env.AppendUnique(CPPPATH = extra_inc_paths)
587
588
589 #----------------------------------------------------------
590 # Autoconf business
591 #----------------------------------------------------------
592
593 conf = Configure(env,
594     custom_tests = {
595         'CheckPkgConfig' : utils.checkPkgConfig,
596         'CheckPackage' : utils.checkPackage,
597         'CheckMkdirOneArg' : utils.checkMkdirOneArg,
598         'CheckSelectArgType' : utils.checkSelectArgType,
599         'CheckBoostLibraries' : utils.checkBoostLibraries,
600         'CheckCommand' : utils.checkCommand,
601         'CheckNSIS' : utils.checkNSIS,
602         'CheckCXXGlobalCstd' : utils.checkCXXGlobalCstd,
603         'CheckLC_MESSAGES' : utils.checkLC_MESSAGES,
604         'CheckIconvConst' : utils.checkIconvConst,
605         'CheckSizeOfWChar' : utils.checkSizeOfWChar,
606     }
607 )
608
609 # pkg-config? (if not, we use hard-coded options)
610 if conf.CheckPkgConfig('0.15.0'):
611     env['HAS_PKG_CONFIG'] = True
612 else:
613     print 'pkg-config >= 0.1.50 is not found'
614     env['HAS_PKG_CONFIG'] = False
615
616 # zlib? This is required.
617 if (not use_vc and not conf.CheckLibWithHeader('z', 'zlib.h', 'C')) \
618     or (use_vc and not conf.CheckLibWithHeader('zdll', 'zlib.h', 'C')):
619     print 'Did not find zdll.lib or zlib.h, exiting!'
620     Exit(1)
621 if conf.CheckLib('iconv'):
622     env['ICONV_LIB'] = 'iconv'
623 elif conf.CheckLib('libiconv'):
624     env['ICONV_LIB'] = 'libiconv'
625 elif conf.CheckFunc('iconv_open'):
626     env['ICONV_LIB'] = None
627 else:
628     print 'Did not find iconv or libiconv, exiting!'
629     Exit(1)
630
631 # check socket libs
632 socket_libs = []
633 if conf.CheckLib('socket'):
634     socket_libs.append('socket')
635 # nsl is the network services library and provides a
636 # transport-level interface to networking services.
637 if conf.CheckLib('nsl'):
638     socket_libs.append('nsl')
639
640 # check available boost libs (since lyx1.4 does not use iostream)
641 boost_libs = []
642 for lib in ['signals', 'regex', 'filesystem', 'iostreams']:
643     if os.path.isdir(os.path.join(top_src_dir, 'boost', 'libs', lib)):
644         boost_libs.append(lib)
645
646 # check boost libraries
647 boost_opt = ARGUMENTS.get('boost', 'auto')
648 # check for system boost
649 lib_paths = env['LIBPATH'] + ['/usr/lib', '/usr/local/lib']
650 inc_paths = env['CPPPATH'] + ['/usr/include', '/usr/local/include']
651 # default to $BUILDDIR/libs (use None since this path will be added anyway)
652 boost_libpath = None
653 # here I assume that all libraries are in the same directory
654 if boost_opt == 'included':
655     boost_libraries = ['included_boost_%s' % x for x in boost_libs]
656     included_boost = True
657     env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
658 elif boost_opt == 'auto':
659     res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
660     # if not found, use local boost
661     if res[0] is None:
662         boost_libraries = ['included_boost_%s' % x for x in boost_libs]
663         included_boost = True
664         env['BOOST_INC_PATH'] = '$TOP_SRCDIR/boost'
665     else:
666         included_boost = False
667         (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
668 elif boost_opt == 'system':
669     res = conf.CheckBoostLibraries(boost_libs, lib_paths, inc_paths, boost_version, mode == 'debug')
670     if res[0] is None:
671         print "Can not find system boost libraries with version %s " % boost_version
672         print "Please supply a path through extra_lib_path and try again."
673         print "Or use boost=included to use included boost libraries."
674         Exit(2)
675     else:
676         included_boost = False
677         (boost_libraries, boost_libpath, env['BOOST_INC_PATH']) = res
678
679
680 if boost_libpath is not None:
681     env.AppendUnique(LIBPATH = [boost_libpath])
682
683
684 env['ENABLE_NLS'] = env['nls']
685
686 if not env['ENABLE_NLS']:
687     intl_libs = []
688     included_gettext = False
689 else:
690     # check gettext libraries
691     gettext_opt = ARGUMENTS.get('gettext', 'auto')
692     # check for system gettext
693     succ = False
694     if gettext_opt in ['auto', 'system']:
695         if conf.CheckFunc('gettext'):
696             included_gettext = False
697             intl_libs = []
698             succ = True
699         elif conf.CheckLib('intl'):
700             included_gettext = False
701             intl_libs = ['intl']
702             succ = True
703         else: # no found
704             if gettext_opt == 'system':
705                 print "Can not find system gettext library"
706                 print "Please supply a path through extra_lib_path and try again."
707                 print "Or use gettext=included to use included gettext libraries."
708                 Exit(2)
709     # now, auto and succ = false, or gettext=included
710     if not succ:
711         # we do not need to set LIBPATH now.
712         included_gettext = True
713         intl_libs = ['included_intl']
714
715
716 #
717 # check for msgfmt command
718 env['MSGFMT'] = conf.CheckCommand('msgfmt')
719 env['MSGMERGE'] = conf.CheckCommand('msgmerge')
720 env['XGETTEXT'] = conf.CheckCommand('xgettext')
721 env['MSGUNIQ'] = conf.CheckCommand('msguniq')
722
723 # if under windows, check the nsis compiler
724 if platform_name == 'win32':
725     env['NSIS'] = conf.CheckNSIS()
726
727 # cygwin packaging requires the binaries to be stripped
728 if platform_name == 'cygwin':
729     env['STRIP'] = conf.CheckCommand('strip')
730
731 #
732 # Customized builders
733 #
734 # install customized builders
735 env['BUILDERS']['substFile'] = Builder(action = utils.env_subst)
736 env['BUILDERS']['installTOC'] = Builder(action = utils.env_toc)
737
738
739 #----------------------------------------------------------
740 # Generating config.h
741 #----------------------------------------------------------
742 aspell_lib = 'aspell'
743 # assume that we use aspell, aspelld compiled for msvc
744 if platform_name == 'win32' and mode == 'debug' and use_vc:
745     aspell_lib = 'aspelld'
746
747 # check the existence of config.h
748 config_h = os.path.join(env.Dir('$BUILDDIR/common').path, 'config.h')
749 boost_config_h = os.path.join(env.Dir('$BUILDDIR/boost').path, 'config.h')
750 #
751 print "Creating %s..." % boost_config_h
752 #
753 utils.createConfigFile(conf,
754     config_file = boost_config_h,
755     config_pre = '''/* boost/config.h.  Generated by SCons.  */
756
757 /* -*- C++ -*- */
758 /*
759 * \file config.h
760 * This file is part of LyX, the document processor.
761 * Licence details can be found in the file COPYING.
762 *
763 * This is the compilation configuration file for LyX.
764 * It was generated by scon.
765 * You might want to change some of the defaults if something goes wrong
766 * during the compilation.
767 */
768
769 #ifndef _BOOST_CONFIG_H
770 #define _BOOST_CONFIG_H
771 ''',
772     headers = [
773         ('ostream', 'HAVE_OSTREAM', 'cxx'),
774         ('locale', 'HAVE_LOCALE', 'cxx'),
775         ('sstream', 'HAVE_SSTREAM', 'cxx'),
776         #('newapis.h', 'HAVE_NEWAPIS_H', 'c'),
777     ],
778     custom_tests = [
779         (env.has_key('assertions') and env['assertions'],
780             'ENABLE_ASSERTIONS',
781             'Define if you want assertions to be enabled in the code'
782         ),
783     ],
784     types = [
785         ('wchar_t', 'HAVE_WCHAR_T', None),
786     ],
787     config_post = '''
788
789 #if defined(HAVE_OSTREAM) && defined(HAVE_LOCALE) && defined(HAVE_SSTREAM)
790 #  define USE_BOOST_FORMAT 1
791 #else
792 #  define USE_BOOST_FORMAT 0
793 #endif
794
795 #if !defined(ENABLE_ASSERTIONS)
796 #  define BOOST_DISABLE_ASSERTS 1
797 #endif
798 #define BOOST_ENABLE_ASSERT_HANDLER 1
799
800 #define BOOST_DISABLE_THREADS 1
801 #define BOOST_NO_WSTRING 1
802
803 #ifdef __CYGWIN__
804 #  define BOOST_POSIX 1
805 #  define BOOST_POSIX_API 1
806 #  define BOOST_POSIX_PATH 1
807 #endif
808
809 #define BOOST_ALL_NO_LIB 1
810
811 #if defined(HAVE_NEWAPIS_H)
812 #  define WANT_GETFILEATTRIBUTESEX_WRAPPER 1
813 #endif
814
815 #if defined(HAVE_WCHAR_T) && SIZEOF_WCHAR_T == 4
816 #  define LIBC_WCTYPE_USES_UCS4
817 #endif
818
819 #endif
820 '''
821 )
822 #
823 print "\nGenerating %s..." % config_h
824
825 # AIKSAURUS_H_LOCATION
826 if (conf.CheckCXXHeader("Aiksaurus.h")):
827     aik_location = '<Aiksaurus.h>'
828 elif (conf.CheckCXXHeader("Aiksaurus/Aiksaurus.h")):
829     aik_location = '<Aiksaurus/Aiksaurus.h>'
830 else:
831     aik_location = ''
832
833 # determine headers to use
834 spell_opt = ARGUMENTS.get('spell', 'auto')
835 env['USE_ASPELL'] = False
836 env['USE_PSPELL'] = False
837 env['USE_ISPELL'] = False
838 if spell_opt in ['auto', 'aspell'] and conf.CheckLib(aspell_lib):
839     spell_engine = 'USE_ASPELL'
840 elif spell_opt in ['auto', 'pspell'] and conf.CheckLib('pspell'):
841     spell_engine = 'USE_PSPELL'
842 elif spell_opt in ['auto', 'ispell'] and conf.CheckLib('ispell'):
843     spell_engine = 'USE_ISPELL'
844 else:
845     spell_engine = None
846
847 if spell_engine is not None:
848     env[spell_engine] = True
849 else:
850     if spell_opt == 'auto':
851         print "Warning: Can not locate any spell checker"
852     elif spell_opt != 'no':
853         print "Warning: Can not locate specified spell checker:", spell_opt
854         Exit(1)
855
856 # check arg types of select function
857 (select_arg1, select_arg234, select_arg5) = conf.CheckSelectArgType()
858
859 # check the size of wchar_t
860 sizeof_wchar_t = conf.CheckSizeOfWChar()
861 # something wrong
862 if sizeof_wchar_t == 0:
863     print 'Error: Can not determine the size of wchar_t.'
864     Exit(1)
865
866 #
867 # create config.h
868 result = utils.createConfigFile(conf,
869     config_file = config_h,
870     config_pre = '''/* config.h.  Generated by SCons.  */
871
872 /* -*- C++ -*- */
873 /*
874 * \file config.h
875 * This file is part of LyX, the document processor.
876 * Licence details can be found in the file COPYING.
877 *
878 * This is the compilation configuration file for LyX.
879 * It was generated by scon.
880 * You might want to change some of the defaults if something goes wrong
881 * during the compilation.
882 */
883
884 #ifndef _CONFIG_H
885 #define _CONFIG_H
886 ''',
887     headers = [
888         ('io.h', 'HAVE_IO_H', 'c'),
889         ('limits.h', 'HAVE_LIMITS_H', 'c'),
890         ('locale.h', 'HAVE_LOCALE_H', 'c'),
891         ('process.h', 'HAVE_PROCESS_H', 'c'),
892         ('stdlib.h', 'HAVE_STDLIB_H', 'c'),
893         ('sys/stat.h', 'HAVE_SYS_STAT_H', 'c'),
894         ('sys/time.h', 'HAVE_SYS_TIME_H', 'c'),
895         ('sys/types.h', 'HAVE_SYS_TYPES_H', 'c'),
896         ('sys/utime.h', 'HAVE_SYS_UTIME_H', 'c'),
897         ('sys/socket.h', 'HAVE_SYS_SOCKET_H', 'c'),
898         ('unistd.h', 'HAVE_UNISTD_H', 'c'),
899         ('utime.h', 'HAVE_UTIME_H', 'c'),
900         ('direct.h', 'HAVE_DIRECT_H', 'c'),
901         ('istream', 'HAVE_ISTREAM', 'cxx'),
902         ('ios', 'HAVE_IOS', 'cxx'),
903     ],
904     functions = [
905         ('open', 'HAVE_OPEN', None),
906         ('chmod', 'HAVE_CHMOD', None),
907         ('close', 'HAVE_CLOSE', None),
908         ('popen', 'HAVE_POPEN', None),
909         ('pclose', 'HAVE_PCLOSE', None),
910         ('_open', 'HAVE__OPEN', None),
911         ('_close', 'HAVE__CLOSE', None),
912         ('_popen', 'HAVE__POPEN', None),
913         ('_pclose', 'HAVE__PCLOSE', None),
914         ('getpid', 'HAVE_GETPID', None),
915         ('_getpid', 'HAVE__GETPID', None),
916         ('mkdir', 'HAVE_MKDIR', None),
917         ('_mkdir', 'HAVE__MKDIR', None),
918         ('mktemp', 'HAVE_MKTEMP', None),
919         ('mkstemp', 'HAVE_MKSTEMP', None),
920         ('strerror', 'HAVE_STRERROR', None),
921         ('count', 'HAVE_STD_COUNT', '''
922 #include <algorithm>
923 int count()
924 {
925 char a[] = "hello";
926 return std::count(a, a+5, 'l');
927 }
928 '''),
929         ('getcwd', 'HAVE_GETCWD', None),
930         ('setenv', 'HAVE_SETENV', None),
931         ('putenv', 'HAVE_PUTENV', None),
932         ('fcntl', 'HAVE_FCNTL', None),
933     ],
934     types = [
935         ('std::istreambuf_iterator<std::istream>', 'HAVE_DECL_ISTREAMBUF_ITERATOR',
936             '#include <streambuf>\n#include <istream>'),
937         ('wchar_t', 'HAVE_WCHAR_T', None),
938         ('mode_t', 'HAVE_MODE_T', "#include <sys/types.h>"),
939     ],
940     libs = [
941         ('gdi32', 'HAVE_LIBGDI32'),
942         (('Aiksaurus', 'libAiksaurus'), 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB'),
943     ],
944     custom_tests = [
945         (conf.CheckType('pid_t', includes='#include <sys/types.h>'),
946             'HAVE_PID_T',
947             'Define is sys/types.h does not have pid_t',
948             '',
949             '#define pid_t int',
950         ),
951         (conf.CheckCXXGlobalCstd(),
952             'CXX_GLOBAL_CSTD',
953             'Define if your C++ compiler puts C library functions in the global namespace'
954         ),
955         (conf.CheckMkdirOneArg(),
956             'MKDIR_TAKES_ONE_ARG',
957             'Define if mkdir takes only one argument.'
958         ),
959         (conf.CheckIconvConst(),
960             'ICONV_CONST',
961             'Define as const if the declaration of iconv() needs const.',
962             '#define ICONV_CONST const',
963             '#define ICONV_CONST',
964         ),
965         (conf.CheckLC_MESSAGES(),
966             'HAVE_LC_MESSAGES',
967             'Define if your <locale.h> file defines LC_MESSAGES.'
968         ),
969         (devel_version, 'DEVEL_VERSION', 'Whether or not a development version'),
970         (env['nls'],
971             'ENABLE_NLS',
972             "Define to 1 if translation of program messages to the user's native anguage is requested.",
973         ),
974         (env['nls'] and not included_gettext,
975             'HAVE_GETTEXT',
976             'Define to 1 if using system gettext library'
977         ),
978         (env.has_key('warnings') and env['warnings'],
979             'WITH_WARNINGS',
980             'Define this if you want to see the warning directives put here and there by the developpers to get attention'
981         ),
982         (env.has_key('concept_checks') and env['concept_checks'],
983             '_GLIBCXX_CONCEPT_CHECKS',
984             'libstdc++ concept checking'
985         ),
986         (env.has_key('stdlib_debug') and env['stdlib_debug'],
987             '_GLIBCXX_DEBUG',
988             'libstdc++ debug mode'
989         ),
990         (env.has_key('stdlib_debug') and env['stdlib_debug'],
991             '_GLIBCXX_DEBUG_PEDANTIC',
992             'libstdc++ pedantic debug mode'
993         ),
994         (os.name != 'nt', 'BOOST_POSIX',
995             'Indicates to boost < 1.34 which API to use (posix or windows).'
996         ),
997         (os.name != 'nt', 'BOOST_POSIX_API',
998             'Indicates to boost 1.34 which API to use (posix or windows).'
999         ),
1000         (os.name != 'nt', 'BOOST_POSIX_PATH',
1001             'Indicates to boost 1.34 which path style to use (posix or windows).'
1002         ),
1003         (spell_engine is not None, spell_engine,
1004             'Spell engine to use'
1005         ),
1006         # we need to know the byte order for unicode conversions
1007         (sys.byteorder == 'big', 'WORDS_BIGENDIAN',
1008             'Define to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel and VAX).'
1009         ),
1010     ],
1011     extra_items = [
1012         ('#define PACKAGE "%s%s"' % (package, program_suffix),
1013             'Name of package'),
1014         ('#define PACKAGE_BUGREPORT "%s"' % package_bugreport,
1015             'Define to the address where bug reports for this package should be sent.'),
1016         ('#define PACKAGE_NAME "%s"' % package_name,
1017             'Define to the full name of this package.'),
1018         ('#define PACKAGE_STRING "%s"' % package_string,
1019             'Define to the full name and version of this package.'),
1020         ('#define PACKAGE_TARNAME "%s"' % package_tarname,
1021             'Define to the one symbol short name of this package.'),
1022         ('#define PACKAGE_VERSION "%s"' % package_version,
1023             'Define to the version of this package.'),
1024         ('#define BOOST_ALL_NO_LIB 1',
1025             'disable automatic linking of boost libraries.'),
1026         ('#define USE_%s_PACKAGING 1' % packaging_method.upper(),
1027             'Packaging method'),
1028         ('#define AIKSAURUS_H_LOCATION ' + aik_location,
1029             'Aiksaurus include file'),
1030         ('#define SELECT_TYPE_ARG1 %s' % select_arg1,
1031             "Define to the type of arg 1 for `select'."),
1032         ('#define SELECT_TYPE_ARG234 %s' % select_arg234,
1033             "Define to the type of arg 2, 3, 4 for `select'."),
1034         ('#define SELECT_TYPE_ARG5 %s' % select_arg5,
1035             "Define to the type of arg 5 for `select'."),
1036         ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1037             'Define to be the size of type wchar_t'),
1038     ],
1039     config_post = '''/************************************************************
1040 ** You should not need to change anything beyond this point */
1041
1042 #ifndef HAVE_STRERROR
1043 #if defined(__cplusplus)
1044 extern "C"
1045 #endif
1046 char * strerror(int n);
1047 #endif
1048
1049 #ifdef HAVE_MKSTEMP
1050 #ifndef HAVE_DECL_MKSTEMP
1051 #if defined(__cplusplus)
1052 extern "C"
1053 #endif
1054 int mkstemp(char*);
1055 #endif
1056 #endif
1057
1058 #include <../boost/config.h>
1059
1060 #endif
1061 '''
1062 )
1063
1064 # these keys are needed in env
1065 for key in ['USE_ASPELL', 'USE_PSPELL', 'USE_ISPELL', 'HAVE_FCNTL',\
1066     'HAVE_LIBGDI32', 'HAVE_LIBAIKSAURUS', 'AIKSAURUS_LIB']:
1067     # USE_ASPELL etc does not go through result
1068     if result.has_key(key):
1069         env[key] = result[key]
1070
1071 #
1072 # if nls=yes and gettext=included, create intl/config.h
1073 # intl/libintl.h etc
1074 #
1075 intl_config_h = os.path.join(env.Dir('$BUILDDIR/intl').path, 'config.h')
1076 if env['nls'] and included_gettext:
1077     #
1078     print "Creating %s..." % intl_config_h
1079     #
1080     # create intl/config.h
1081     result = utils.createConfigFile(conf,
1082         config_file = intl_config_h,
1083         config_pre = '''/* intl/config.h.  Generated by SCons.  */
1084
1085 /* -*- C++ -*- */
1086 /*
1087 * \file config.h
1088 * This file is part of LyX, the document processor.
1089 * Licence details can be found in the file COPYING.
1090 *
1091 * This is the compilation configuration file for LyX.
1092 * It was generated by scon.
1093 * You might want to change some of the defaults if something goes wrong
1094 * during the compilation.
1095 */
1096
1097 #ifndef _CONFIG_H
1098 #define _CONFIG_H
1099 ''',
1100         headers = [
1101             ('unistd.h', 'HAVE_UNISTD_H', 'c'),
1102             ('inttypes.h', 'HAVE_INTTYPES_H', 'c'),
1103             ('string.h', 'HAVE_STRING_H', 'c'),
1104             ('strings.h', 'HAVE_STRINGS_H', 'c'),
1105             ('argz.h', 'HAVE_ARGZ_H', 'c'),
1106             ('limits.h', 'HAVE_LIMITS_H', 'c'),
1107             ('alloca.h', 'HAVE_ALLOCA_H', 'c'),
1108             ('stddef.h', 'HAVE_STDDEF_H', 'c'),
1109             ('stdint.h', 'HAVE_STDINT_H', 'c'),
1110             ('sys/param.h', 'HAVE_SYS_PARAM_H', 'c'),
1111         ],
1112         functions = [
1113             ('getcwd', 'HAVE_GETCWD', None),
1114             ('stpcpy', 'HAVE_STPCPY', None),
1115             ('strcasecmp', 'HAVE_STRCASECMP', None),
1116             ('strdup', 'HAVE_STRDUP', None),
1117             ('strtoul', 'HAVE_STRTOUL', None),
1118             ('alloca', 'HAVE_ALLOCA', None),
1119             ('__fsetlocking', 'HAVE___FSETLOCKING', None),
1120             ('mempcpy', 'HAVE_MEMPCPY', None),
1121             ('__argz_count', 'HAVE___ARGZ_COUNT', None),
1122             ('__argz_next', 'HAVE___ARGZ_NEXT', None),
1123             ('__argz_stringify', 'HAVE___ARGZ_STRINGIFY', None),
1124             ('setlocale', 'HAVE_SETLOCALE', None),
1125             ('tsearch', 'HAVE_TSEARCH', None),
1126             ('getegid', 'HAVE_GETEGID', None),
1127             ('getgid', 'HAVE_GETGID', None),
1128             ('getuid', 'HAVE_GETUID', None),
1129             ('wcslen', 'HAVE_WCSLEN', None),
1130             ('asprintf', 'HAVE_ASPRINTF', None),
1131             ('wprintf', 'HAVE_WPRINTF', None),
1132             ('snprintf', 'HAVE_SNPRINTF', None),
1133             ('printf', 'HAVE_POSIX_PRINTF', None),
1134             ('fcntl', 'HAVE_FCNTL', None),
1135         ],
1136         types = [
1137             ('intmax_t', 'HAVE_INTMAX_T', None),
1138             ('long double', 'HAVE_LONG_DOUBLE', None),
1139             ('long long', 'HAVE_LONG_LONG', None),
1140             ('wchar_t', 'HAVE_WCHAR_T', None),
1141             ('wint_t', 'HAVE_WINT_T', None),
1142             ('uintmax_t', 'HAVE_INTTYPES_H_WITH_UINTMAX', '#include <inttypes.h>'),
1143             ('uintmax_t', 'HAVE_STDINT_H_WITH_UINTMAX', '#include <stdint.h>'),
1144         ],
1145         libs = [
1146             ('c', 'HAVE_LIBC'),
1147         ],
1148         custom_tests = [
1149             (conf.CheckLC_MESSAGES(),
1150                 'HAVE_LC_MESSAGES',
1151                 'Define if your <locale.h> file defines LC_MESSAGES.'
1152             ),
1153             (conf.CheckIconvConst(),
1154                 'ICONV_CONST',
1155                 'Define as const if the declaration of iconv() needs const.',
1156                 '#define ICONV_CONST const',
1157                 '#define ICONV_CONST',
1158             ),
1159             (conf.CheckType('intmax_t', includes='#include <stdint.h>') or \
1160             conf.CheckType('intmax_t', includes='#include <inttypes.h>'),
1161                 'HAVE_INTMAX_T',
1162                 "Define to 1 if you have the `intmax_t' type."
1163             ),
1164             (env.has_key('nls') and env['nls'],
1165                 'ENABLE_NLS',
1166                 "Define to 1 if translation of program messages to the user's native anguage is requested.",
1167             ),
1168         ],
1169         extra_items = [
1170             ('#define HAVE_ICONV 1', 'Define if iconv or libiconv is found'),
1171             ('#define SIZEOF_WCHAR_T %d' % sizeof_wchar_t,
1172                 'Define to be the size of type wchar_t'),
1173         ],
1174         config_post = '#endif'
1175     )
1176
1177     # these keys are needed in env
1178     for key in ['HAVE_ASPRINTF', 'HAVE_WPRINTF', 'HAVE_SNPRINTF', \
1179         'HAVE_POSIX_PRINTF', 'HAVE_LIBC']:
1180         # USE_ASPELL etc does not go through result
1181         if result.has_key(key):
1182             env[key] = result[key]
1183
1184
1185 # this looks misplaced, but intl/libintl.h is needed by src/message.C
1186 if env['nls'] and included_gettext:
1187     # libgnuintl.h.in => libintl.h
1188     env.Depends('$TOP_SRCDIR/intl/libintl.h', '$BUILDDIR/intl/config.h')
1189     env.substFile('$BUILDDIR/intl/libintl.h', '$TOP_SRCDIR/intl/libgnuintl.h.in')
1190     env.Command('$BUILDDIR/intl/libgnuintl.h', '$BUILDDIR/intl/libintl.h',
1191         [Copy('$TARGET', '$SOURCE')])
1192
1193 #
1194 # Finish auto-configuration
1195 env = conf.Finish()
1196
1197 #----------------------------------------------------------
1198 # Now set up our build process accordingly
1199 #----------------------------------------------------------
1200
1201 if env['ICONV_LIB'] is None:
1202     system_libs = []
1203 else:
1204     system_libs = [env['ICONV_LIB']]
1205 if platform_name in ['win32', 'cygwin']:
1206     # the final link step needs stdc++ to succeed under mingw
1207     # FIXME: shouldn't g++ automatically link to stdc++?
1208     if use_vc:
1209         system_libs += ['ole32', 'shlwapi', 'shell32', 'advapi32', 'zdll']
1210     else:
1211         system_libs += ['shlwapi', 'stdc++', 'z']
1212 elif platform_name == 'cygwin' and env['X11']:
1213     system_libs += ['GL',  'Xmu', 'Xi', 'Xrender', 'Xrandr',
1214         'Xcursor', 'Xft', 'freetype', 'fontconfig', 'Xext', 'X11', 'SM', 'ICE', 
1215         'resolv', 'pthread', 'z']
1216 else:
1217     system_libs += ['z']
1218
1219 libs = [
1220     ('HAVE_LIBGDI32', 'gdi32'),
1221     ('HAVE_LIBAIKSAURUS', env['AIKSAURUS_LIB']),
1222     ('USE_ASPELL', aspell_lib),
1223     ('USE_ISPELL', 'ispell'),
1224     ('USE_PSPELL', 'pspell'),
1225 ]
1226
1227 for lib in libs:
1228     if env[lib[0]]:
1229         system_libs.append(lib[1])
1230
1231 #
1232 # Build parameters CPPPATH etc
1233 #
1234 if env['X11']:
1235     env.AppendUnique(LIBPATH = ['/usr/X11R6/lib'])
1236
1237 #
1238 # boost: for boost header files
1239 # BUILDDIR/common: for config.h
1240 # TOP_SRCDIR/src: for support/* etc
1241 #
1242 env['CPPPATH'] += ['$BUILDDIR/common', '$TOP_SRCDIR/src']
1243 #
1244 # Separating boost directories from CPPPATH stops scons from building
1245 # the dependency tree for boost header files, and effectively reduce
1246 # the null build time of lyx from 29s to 16s. Since lyx may tweak local
1247 # boost headers, this is only done for system boost headers.
1248 if included_boost:
1249     env.AppendUnique(CPPPATH = ['$BOOST_INC_PATH'])
1250 else:
1251     if use_vc:
1252         env.PrependUnique(CCFLAGS = ['/I$BOOST_INC_PATH'])
1253     else:
1254         env.PrependUnique(CCFLAGS = ['-I$BOOST_INC_PATH'])
1255
1256 # for intl/config.h, intl/libintl.h and intl/libgnuintl.h
1257 if env['nls'] and included_gettext:
1258     env['CPPPATH'].append('$BUILDDIR/intl')
1259 #
1260
1261 #
1262 # A Link script for cygwin see
1263 # http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
1264 # http://www.cygwin.com/ml/cygwin-apps/2004-09/msg00309.html
1265 # for details
1266 #
1267 if platform_name == 'cygwin':
1268     ld_script_path = '/tmp'
1269     ld_script = utils.installCygwinLDScript(ld_script_path)
1270     env.AppendUnique(LINKFLAGS = ['-Wl,--enable-runtime-pseudo-reloc',
1271         '-Wl,--script,%s' % ld_script, '-Wl,-s'])
1272
1273
1274 #---------------------------------------------------------
1275 # Frontend related variables (QTDIR etc)
1276 #---------------------------------------------------------
1277
1278 #
1279 # create a separate environment so that other files do not have
1280 # to be built with all the include directories etc
1281 #
1282 if frontend == 'qt4':
1283     frontend_env = env.Copy()
1284
1285     # handle qt related user specified paths
1286     # set environment so that moc etc can be found even if its path is not set properly
1287     if frontend_env.has_key('qt_dir') and frontend_env['qt_dir']:
1288         frontend_env['QTDIR'] = frontend_env['qt_dir']
1289         if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'bin')):
1290             os.environ['PATH'] += os.pathsep + os.path.join(frontend_env['qt_dir'], 'bin')
1291             frontend_env.PrependENVPath('PATH', os.path.join(frontend_env['qt_dir'], 'bin'))
1292         if os.path.isdir(os.path.join(frontend_env['qt_dir'], 'lib')):
1293             frontend_env.PrependENVPath('PKG_CONFIG_PATH', os.path.join(frontend_env['qt_dir'], 'lib'))
1294
1295     # if separate qt_lib_path is given
1296     if frontend_env.has_key('qt_lib_path') and frontend_env['qt_lib_path']:
1297         qt_lib_path = frontend_env.subst('$qt_lib_path')
1298         frontend_env.AppendUnique(LIBPATH = [qt_lib_path])
1299         frontend_env.PrependENVPath('PKG_CONFIG_PATH', qt_lib_path)
1300     else:
1301         qt_lib_path = None
1302
1303     # if separate qt_inc_path is given
1304     if frontend_env.has_key('qt_inc_path') and frontend_env['qt_inc_path']:
1305         qt_inc_path = frontend_env['qt_inc_path']
1306     else:
1307         qt_inc_path = None
1308
1309     # local qt4 toolset from
1310     # http://www.iua.upf.es/~dgarcia/Codders/sconstools.html
1311     #
1312     # NOTE: I have to patch qt4.py since it does not automatically
1313     # process .C file!!! (add to cxx_suffixes )
1314     #
1315     frontend_env.Tool('qt4', [scons_dir])
1316     frontend_env['QT_AUTOSCAN'] = 0
1317     frontend_env['QT4_AUTOSCAN'] = 0
1318     frontend_env['QT4_UICDECLFLAGS'] = '-tr lyx::qt_'
1319
1320     if qt_lib_path is None:
1321         qt_lib_path = os.path.join(frontend_env.subst('$QTDIR'), 'lib')
1322     if qt_inc_path is None:
1323         qt_inc_path = os.path.join(frontend_env.subst('$QTDIR'), 'include')
1324
1325
1326     conf = Configure(frontend_env,
1327         custom_tests = { 
1328             'CheckPackage' : utils.checkPackage,
1329             'CheckCommand' : utils.checkCommand,
1330         }
1331     )
1332
1333     succ = False
1334     # first: try pkg_config
1335     if frontend_env['HAS_PKG_CONFIG']:
1336         succ = conf.CheckPackage('QtCore') or conf.CheckPackage('QtCore4')
1337         # FIXME: use pkg_config information?
1338         #frontend_env['QT4_PKG_CONFIG'] = succ
1339     # second: try to link to it
1340     if not succ:
1341         # Under linux, I can test the following perfectly
1342         # Under windows, lib names need to passed as libXXX4.a ...
1343         if platform_name == 'win32':
1344             succ = conf.CheckLibWithHeader('QtCore4', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1345         else:
1346             succ = conf.CheckLibWithHeader('QtCore', 'QtGui/QApplication', 'c++', 'QApplication qapp();')
1347     # still can not find it
1348     if not succ:
1349         print 'Did not find qt libraries, exiting!'
1350         Exit(1)
1351     #
1352     # Now, determine the correct suffix:
1353     qt_libs = ['QtCore', 'QtGui']
1354     if platform_name == 'win32':
1355         if mode == 'debug' and use_vc and \
1356             conf.CheckLibWithHeader('QtCored4', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1357             qt_lib_suffix = 'd4'
1358             use_qt_debug_libs = True
1359         else:
1360             qt_lib_suffix = '4'
1361             use_qt_debug_libs = False
1362     else:
1363         if mode == 'debug' and conf.CheckLibWithHeader('QtCore_debug', 'QtGui/QApplication', 'c++', 'QApplication qapp();'):
1364             qt_lib_suffix = '_debug'
1365             use_qt_debug_libs = True
1366         else:
1367             qt_lib_suffix = ''
1368             use_qt_debug_libs = False
1369     frontend_env.EnableQt4Modules(qt_libs, debug = (mode == 'debug' and use_qt_debug_libs))
1370     frontend_libs = [x + qt_lib_suffix for x in qt_libs]
1371     qtcore_lib = ['QtCore' + qt_lib_suffix]
1372
1373     # check uic and moc commands for qt frontends
1374     if conf.CheckCommand('uic') == None or conf.CheckCommand('moc') == None:
1375         print 'uic or moc command is not found for frontend', frontend
1376         Exit(1)
1377     
1378     # now, if msvc2005 is used, we will need that QT_LIB_PATH/QT_LIB.manifest file
1379     if use_vc:
1380         if mode == 'debug':
1381             if qt_lib_path is not None:
1382                 manifest = os.path.join(qt_lib_path, 'QtGuid4.dll.manifest')
1383             else:
1384                 manifest = 'QtGuid4.dll.manifest'
1385         else:
1386             if qt_lib_path is not None:
1387                 manifest = os.path.join(qt_lib_path, 'QtGui4.dll.manifest')
1388             else:
1389                 manifest = 'QtGui4.dll.manifest'
1390         if os.path.isfile(manifest):
1391             frontend_env['LINKCOM'] = [frontend_env['LINKCOM'], 'mt.exe /MANIFEST %s /outputresource:$TARGET;1' % manifest]
1392
1393     frontend_env = conf.Finish()
1394
1395 #
1396 # Report results
1397 #
1398 # fill in the version info
1399 env['VERSION_INFO'] = '''Configuration
1400   Host type:                      %s
1401   Special build flags:            %s
1402   C   Compiler:                   %s
1403   C   Compiler flags:             %s %s
1404   C++ Compiler:                   %s
1405   C++ Compiler LyX flags:         %s
1406   C++ Compiler flags:             %s %s
1407   Linker flags:                   %s
1408   Linker user flags:              %s
1409 Build info:
1410   Builing directory:              %s
1411   Local library directory:        %s
1412   Libraries paths:                %s
1413   Boost libraries:                %s
1414   Frontend libraries:             %s
1415   System libraries:               %s
1416   include search path:            %s
1417 Frontend:
1418   Frontend:                       %s
1419   Packaging:                      %s
1420   LyX dir:                        %s
1421   LyX files dir:                  %s
1422 ''' % (platform_name,
1423     env.subst('$CCFLAGS'), env.subst('$CC'),
1424     env.subst('$CPPFLAGS'), env.subst('$CFLAGS'),
1425     env.subst('$CXX'), env.subst('$CXXFLAGS'),
1426     env.subst('$CPPFLAGS'), env.subst('$CXXFLAGS'),
1427     env.subst('$LINKFLAGS'), env.subst('$LINKFLAGS'),
1428     env.subst('$BUILDDIR'), env.subst('$LOCALLIBPATH'),
1429     str(env['LIBPATH']), str(boost_libraries),
1430     str(frontend_libs), str(system_libs), str(env['CPPPATH']),
1431     frontend, packaging_method,
1432     prefix, env['LYX_DIR'])
1433
1434 if frontend in ['qt4']:
1435     env['VERSION_INFO'] += '''  include dir:                    %s
1436   library dir:                    %s
1437   X11:                            %s
1438 ''' % (qt_inc_path, qt_lib_path, env['X11'])
1439
1440 print env['VERSION_INFO']
1441
1442 #
1443 # Mingw command line may be too short for our link usage,
1444 # Here we use a trick from scons wiki
1445 # http://www.scons.org/cgi-sys/cgiwrap/scons/moin.cgi/LongCmdLinesOnWin32
1446 #
1447 # I also would like to add logging (commands only) capacity to the
1448 # spawn system.
1449 logfile = env.get('logfile', default_log_file)
1450 if logfile != '' or platform_name == 'win32':
1451     import time
1452     utils.setLoggedSpawn(env, logfile, longarg = (platform_name == 'win32'),
1453         info = '''# This is a log of commands used by scons to build lyx
1454 # Time: %s
1455 # Command: %s
1456 # Info: %s
1457 ''' % (time.asctime(), ' '.join(sys.argv),
1458     env['VERSION_INFO'].replace('\n','\n# ')) )
1459
1460
1461 # Cleanup stuff
1462 #
1463 # -h will print out help info
1464 Help(opts.GenerateHelpText(env))
1465
1466
1467
1468 #----------------------------------------------------------
1469 # Start building
1470 #----------------------------------------------------------
1471 # this has been the source of problems on some platforms...
1472 # I find that I need to supply it with full path name
1473 env.SConsignFile(os.path.join(Dir(env['BUILDDIR']).abspath, '.sconsign'))
1474 # this usage needs further investigation.
1475 #env.CacheDir('%s/Cache/%s' % (env['BUILDDIR'], frontend))
1476
1477 print "Building all targets recursively"
1478
1479 if env.has_key('rebuild'):
1480     rebuild_targets = env['rebuild'].split(',')
1481     if 'none' in rebuild_targets or 'no' in rebuild_targets:
1482         rebuild_targets = []
1483     elif 'all' in rebuild_targets or 'yes' in rebuild_targets:
1484         # None: let scons decide which components to build
1485         # Forcing all components to be rebuilt is in theory not necessary
1486         rebuild_targets = None    
1487 else:
1488     rebuild_targets = None
1489
1490 def libExists(libname):
1491     ''' Check whether or not lib $LOCALLIBNAME/libname already exists'''
1492     return os.path.isfile(File(env.subst('$LOCALLIBPATH/${LIBPREFIX}%s$LIBSUFFIX'%libname)).abspath)
1493
1494 def appExists(apppath, appname):
1495     ''' Check whether or not application already exists'''
1496     return os.path.isfile(File(env.subst('$BUILDDIR/common/%s/${PROGPREFIX}%s$PROGSUFFIX' % (apppath, appname))).abspath)
1497
1498 targets = BUILD_TARGETS
1499 build_install = 'install' in targets or 'installer' in targets
1500 build_installer = 'installer' in targets
1501 # msvc need to pass full target name, so I have to look for path/lyx etc
1502 build_lyx = build_installer or targets == [] or True in ['lyx' in x for x in targets] \
1503     or build_install or 'all' in targets
1504 build_boost = (included_boost and not libExists('boost_regex')) or 'boost' in targets
1505 build_intl = (included_gettext and not libExists('included_intl')) or 'intl' in targets
1506 build_support = build_lyx or True in [x in targets for x in ['support', 'client', 'tex2lyx']]
1507 build_mathed = build_lyx or 'mathed' in targets
1508 build_insets = build_lyx or 'insets' in targets
1509 build_frontends = build_lyx or 'frontends' in targets
1510 build_graphics = build_lyx or 'graphics' in targets
1511 build_controllers = build_lyx or 'controllers' in targets
1512 build_client = True in ['client' in x for x in targets] \
1513     or build_install or 'all' in targets or build_installer
1514 build_tex2lyx = True in ['tex2lyx' in x for x in targets] \
1515     or build_install or 'all' in targets or build_installer
1516 build_lyxbase = build_lyx or 'lyxbase' in targets
1517 update_po = 'update_po' in targets
1518 build_po = 'po' in targets or build_install or 'all' in targets
1519 build_qt4 = (build_lyx and frontend == 'qt4') or 'qt4' in targets
1520 build_msvs_projects = use_vc and 'msvs_projects' in targets
1521
1522
1523 # now, if rebuild_targets is specified, do not rebuild some targets
1524 if rebuild_targets is not None:
1525     #
1526     def ifBuildLib(name, libname, old_value):
1527         # explicitly asked to rebuild
1528         if name in rebuild_targets:
1529             return True
1530         # else if not rebuild, and if the library already exists
1531         elif libExists(libname):
1532             return False
1533         # do not change the original value
1534         else:
1535             return old_value
1536     build_boost = ifBuildLib('boost', 'included_boost_filesystem', build_boost)
1537     build_intl = ifBuildLib('intl', 'included_intl', build_intl)
1538     build_support = ifBuildLib('support', 'support', build_support)
1539     build_mathed = ifBuildLib('mathed', 'mathed', build_mathed)
1540     build_insets = ifBuildLib('insets', 'insets', build_insets)
1541     build_frontends = ifBuildLib('frontends', 'frontends', build_frontends)
1542     build_graphics = ifBuildLib('graphics', 'graphics', build_graphics)
1543     build_controllers = ifBuildLib('controllers', 'controllers', build_controllers)
1544     build_lyxbase = ifBuildLib('lyxbase', 'lyxbase_pre', build_lyxbase)
1545     build_qt4 = ifBuildLib('qt4', 'qt4', build_qt4)
1546     #
1547     def ifBuildApp(name, appname, old_value):
1548         # explicitly asked to rebuild
1549         if name in rebuild_targets:
1550             return True
1551         # else if not rebuild, and if the library already exists
1552         elif appExists(name, appname):
1553             return False
1554         # do not change the original value
1555         else:
1556             return old_value
1557     build_tex2lyx = ifBuildApp('tex2lyx', 'tex2lyx', build_tex2lyx)
1558     build_client = ifBuildApp('client', 'lyxclient', build_client)
1559
1560 # sync frontend and frontend (?)
1561 if build_qt4:
1562     frontend = 'qt4'
1563
1564
1565 if build_boost:
1566     #
1567     # boost libraries
1568     #
1569     # special builddir
1570     env.BuildDir('$BUILDDIR/boost', '$TOP_SRCDIR/boost/libs', duplicate = 0)
1571
1572     boostenv = env.Copy()
1573     #
1574     # boost use its own config.h
1575     boostenv['CPPPATH'] = ['$TOP_SRCDIR/boost', '$BUILDDIR/boost'] + extra_inc_paths
1576     boostenv.AppendUnique(CCFLAGS = ['-DBOOST_USER_CONFIG="<config.h>"'])
1577
1578     for lib in boost_libs:
1579         print 'Processing files in boost/libs/%s/src...' % lib
1580         boostlib = boostenv.StaticLibrary(
1581             target = '$LOCALLIBPATH/included_boost_%s' % lib,
1582             source = ['$BUILDDIR/boost/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1583         )
1584         Alias('boost', boostlib)
1585
1586
1587 if build_intl:
1588     #
1589     # intl
1590     #
1591     intlenv = env.Copy()
1592
1593     print "Processing files in intl..."
1594
1595     env.BuildDir('$BUILDDIR/intl', '$TOP_SRCDIR/intl', duplicate = 0)
1596
1597     # we need the original C compiler for these files
1598     intlenv['CC'] = C_COMPILER
1599     intlenv['CCFLAGS'] = C_CCFLAGS
1600     if use_vc:
1601         intlenv.Append(CCFLAGS=['/Dinline#', '/D__attribute__(x)#', '/Duintmax_t=UINT_MAX'])
1602     # intl does not use global config.h
1603     intlenv['CPPPATH'] = ['$BUILDDIR/intl'] + extra_inc_paths
1604
1605     intlenv.Append(CCFLAGS = [
1606         r'-DLOCALEDIR=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1607         r'-DLOCALE_ALIAS_PATH=\"' + env['LOCALEDIR'].replace('\\', '\\\\') + r'\"',
1608         r'-DLIBDIR=\"' + env['TOP_SRCDIR'].replace('\\', '\\\\') + r'/lib\"',
1609         '-DIN_LIBINTL',
1610         '-DENABLE_RELOCATABLE=1',
1611         '-DIN_LIBRARY',
1612         r'-DINSTALLDIR=\"' + prefix.replace('\\', '\\\\') + r'/lib\"',
1613         '-DNO_XMALLOC',
1614         '-Dset_relocation_prefix=libintl_set_relocation_prefix',
1615         '-Drelocate=libintl_relocate',
1616         '-DDEPENDS_ON_LIBICONV=1',
1617         '-DHAVE_CONFIG_H'
1618         ]
1619     )
1620
1621     intl = intlenv.StaticLibrary(
1622         target = '$LOCALLIBPATH/included_intl',
1623         LIBS = ['c'],
1624         source = ['$BUILDDIR/intl/%s' % x for x in intl_files]
1625     )
1626     Alias('intl', intl)
1627
1628
1629 #
1630 # Now, src code under src/
1631 #
1632 env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1633
1634
1635 if build_support:
1636     #
1637     # src/support
1638     #
1639     print "Processing files in src/support..."
1640
1641     frontend_env.Depends('$BUILDDIR/common/support/package.C', '$BUILDDIR/common/config.h')
1642     env.substFile('$BUILDDIR/common/support/package.C', '$TOP_SRCDIR/src/support/Package.cpp.in')
1643
1644     support = frontend_env.StaticLibrary(
1645         target = '$LOCALLIBPATH/support',
1646         source = ['$BUILDDIR/common/support/%s' % x for x in src_support_files],
1647     )
1648     Alias('support', support)
1649
1650
1651 if build_mathed:
1652     #
1653     # src/mathed
1654     #
1655     print "Processing files in src/mathed..."
1656     #
1657     mathed = env.StaticLibrary(
1658         target = '$LOCALLIBPATH/mathed',
1659         source = ['$BUILDDIR/common/mathed/%s' % x for x in src_mathed_files]
1660     )
1661     Alias('mathed', mathed)
1662
1663
1664 if build_insets:
1665     #
1666     # src/insets
1667     #
1668     print "Processing files in src/insets..."
1669     #
1670     insets = env.StaticLibrary(
1671         target = '$LOCALLIBPATH/insets',
1672         source = ['$BUILDDIR/common/insets/%s' % x for x in src_insets_files]
1673     )
1674     Alias('insets', insets)
1675
1676
1677 if build_frontends:
1678     #
1679     # src/frontends
1680     #
1681     print "Processing files in src/frontends..."
1682
1683     frontends = env.StaticLibrary(
1684         target = '$LOCALLIBPATH/frontends',
1685         source = ['$BUILDDIR/common/frontends/%s' % x for x in src_frontends_files]
1686     )
1687     Alias('frontends', frontends)
1688
1689
1690 if build_graphics:
1691     #
1692     # src/graphics
1693     #
1694     print "Processing files in src/graphics..."
1695
1696     graphics = env.StaticLibrary(
1697         target = '$LOCALLIBPATH/graphics',
1698         source = ['$BUILDDIR/common/graphics/%s' % x for x in src_graphics_files]
1699     )
1700     Alias('graphics', graphics)
1701
1702
1703 if build_controllers:
1704     #
1705     # src/frontends/controllers
1706     #
1707     print "Processing files in src/frontends/controllers..."
1708
1709     controllers = env.StaticLibrary(
1710         target = '$LOCALLIBPATH/controllers',
1711         source = ['$BUILDDIR/common/frontends/controllers/%s' % x for x in src_frontends_controllers_files]
1712     )
1713     Alias('controllers', controllers)
1714
1715
1716 #
1717 # src/frontend/qt4
1718 #
1719 if build_qt4:
1720     env.BuildDir('$BUILDDIR/$frontend', '$TOP_SRCDIR/src/frontend/$frontend', duplicate = 0)
1721
1722     print "Processing files in src/frontends/qt4..."
1723
1724     qt4_moc_files = ["$BUILDDIR/common/frontends/qt4/%s" % x for x in src_frontends_qt4_moc_files]
1725
1726     #
1727     # Compile resources
1728     #
1729     resources = [frontend_env.Uic4(x.split('.')[0]) for x in \
1730         ["$BUILDDIR/common/frontends/qt4/ui/%s" % x for x in src_frontends_qt4_ui_files]]
1731
1732     #
1733     # moc qt4_moc_files, the moced files are included in the original files
1734     #
1735     qt4_moced_files = [frontend_env.Moc4(x.replace('.cpp', '_moc.cpp'), x.replace('.cpp', '.h')) for x in qt4_moc_files]
1736
1737     qt4 = frontend_env.StaticLibrary(
1738         target = '$LOCALLIBPATH/qt4',
1739         source = ['$BUILDDIR/common/frontends/qt4/%s' % x for x in src_frontends_qt4_files],
1740         CPPPATH = [
1741             '$CPPPATH',
1742             '$BUILDDIR/common',
1743             '$BUILDDIR/common/images',
1744             '$BUILDDIR/common/frontends',
1745             '$BUILDDIR/common/frontends/qt4',
1746             '$BUILDDIR/common/frontends/controllers'
1747         ],
1748         CCFLAGS =  [
1749             '$CCFLAGS',
1750             '-DHAVE_CONFIG_H',
1751             '-DQT_CLEAN_NAMESPACE',
1752             '-DQT_GENUINE_STR',
1753             '-DQT_NO_STL',
1754             '-DQT_NO_KEYWORDS',
1755         ]
1756     )
1757     Alias('qt4', qt4)
1758
1759
1760 if build_client:
1761     #
1762     # src/client
1763     #
1764     frontend_env.BuildDir('$BUILDDIR/common', '$TOP_SRCDIR/src', duplicate = 0)
1765
1766     print "Processing files in src/client..."
1767
1768     if env['HAVE_FCNTL']:
1769         client = frontend_env.Program(
1770             target = '$BUILDDIR/common/client/lyxclient',
1771             LIBS = ['support'] + intl_libs + system_libs +
1772                 socket_libs + boost_libraries + qtcore_lib,
1773             source = ['$BUILDDIR/common/client/%s' % x for x in src_client_files] + \
1774                 utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/client.rc')
1775         )
1776         Alias('client', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(client[0]))[1]),
1777             client, [Copy('$TARGET', '$SOURCE')]))
1778     else:
1779         client = None
1780     Alias('client', client)
1781 else:
1782     if env['HAVE_FCNTL']:
1783         # define client even if lyxclient is not built with rebuild=no
1784         client = [env.subst('$BUILDDIR/common/client/${PROGPREFIX}lyxclient$PROGSUFFIX')]
1785     else:
1786         client = None
1787
1788
1789 if build_tex2lyx:
1790     #
1791     # tex2lyx
1792     #
1793     print "Processing files in src/tex2lyx..."
1794
1795     #
1796     for file in ['FloatList.cpp', 'Floating.cpp', 'Counters.cpp', 'LyXLayout.h', 'LyXLayout.cpp', 
1797         'LyXTextClass.h', 'LyXTextClass.cpp', 'Lexer.cpp', 'Lexer.h']:
1798         frontend_env.Command('$BUILDDIR/common/tex2lyx/'+file, '$TOP_SRCDIR/src/'+file,
1799             [Copy('$TARGET', '$SOURCE')])
1800
1801     tex2lyx = frontend_env.Program(
1802         target = '$BUILDDIR/common/tex2lyx/tex2lyx',
1803         LIBS = ['support'] + boost_libraries + intl_libs + system_libs + qtcore_lib,
1804         source = ['$BUILDDIR/common/tex2lyx/%s' % x for x in src_tex2lyx_files] + \
1805             utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/tex2lyx.rc'),
1806         CPPPATH = ['$BUILDDIR/common/tex2lyx', '$CPPPATH'],
1807         LIBPATH = ['#$LOCALLIBPATH', '$LIBPATH'],
1808     )
1809     Alias('tex2lyx', frontend_env.Command(os.path.join('$BUILDDIR', os.path.split(str(tex2lyx[0]))[1]),
1810         tex2lyx, [Copy('$TARGET', '$SOURCE')]))
1811     Alias('tex2lyx', tex2lyx)
1812 else:
1813     # define tex2lyx even if tex2lyx is not built with rebuild=no
1814     tex2lyx = [frontend_env.subst('$BUILDDIR/common/tex2lyx/${PROGPREFIX}tex2lyx$PROGSUFFIX')]
1815
1816
1817 if build_lyxbase:
1818     #
1819     # src/
1820     #
1821     print "Processing files in src..."
1822
1823     env.Depends('$BUILDDIR/common/version.C', '$BUILDDIR/common/config.h')
1824     env.substFile('$BUILDDIR/common/version.C', '$TOP_SRCDIR/src/version.cpp.in')
1825
1826     if env.has_key('USE_ASPELL') and env['USE_ASPELL']:
1827         src_post_files.append('ASpell.cpp')
1828     elif env.has_key('USE_PSPELL') and env['USE_PSPELL']:
1829         src_post_files.append('PSpell.cpp')
1830     elif env.has_key('USE_ISPELL') and env['USE_ISPELL']:
1831         src_post_files.append('ISpell.cpp')
1832
1833     # msvc requires at least one source file with main()
1834     # so I exclude main.cpp from lyxbase
1835     lyxbase_pre = env.StaticLibrary(
1836         target = '$LOCALLIBPATH/lyxbase_pre',
1837         source = ['$BUILDDIR/common/%s' % x for x in src_pre_files]
1838     )
1839     lyxbase_post = env.StaticLibrary(
1840         target = '$LOCALLIBPATH/lyxbase_post',
1841         source = ["$BUILDDIR/common/%s" % x for x in src_post_files]
1842     )
1843     Alias('lyxbase', lyxbase_pre)
1844     Alias('lyxbase', lyxbase_post)
1845
1846
1847 if build_lyx:
1848     #
1849     # Build lyx with given frontend
1850     #
1851     lyx = frontend_env.Program(
1852         target = '$BUILDDIR/lyx',
1853         source = ['$BUILDDIR/common/main.cpp'] + \
1854             utils.createResFromIcon(frontend_env, 'lyx_32x32.ico', '$LOCALLIBPATH/lyx.rc'),
1855         LIBS = [
1856             'lyxbase_pre',
1857             'mathed',
1858             'insets',
1859             'frontends',
1860             frontend,
1861             'controllers',
1862             'graphics',
1863             'support',
1864             'lyxbase_post',
1865             ] +
1866             boost_libraries +
1867             frontend_libs +
1868             intl_libs +
1869             socket_libs +
1870             system_libs
1871     )
1872     Alias('lyx', lyx)
1873 else:
1874     # define lyx even if lyx is not built with rebuild=no
1875     lyx = [frontend_env.subst('$BUILDDIR/${PROGPREFIX}lyx$PROGSUFFIX')]
1876
1877
1878 if build_msvs_projects:
1879     def build_project(target, full_target = None,
1880         src = [], inc = [], res = [], rebuildTargetOnly = True):
1881         ''' build mavs project files
1882             target:      alias (correspond to directory name)
1883             full_target: full path/filename of the target
1884             src:         source files
1885             inc:         include files
1886             res:         resource files
1887             rebuildTargetOnly:     whether or not only rebuild this target
1888
1889         For non-debug-able targets like static libraries, target (alias) is
1890         enough to build the target. For executable targets, msvs need to know
1891         the full path to start debug them.
1892         '''
1893         if rebuildTargetOnly:
1894             cmds = 'rebuild='+target
1895         else:
1896             cmds = ''
1897         if full_target is None:
1898             build_target = target
1899         else:
1900             build_target = full_target
1901         # project
1902         proj = env.MSVSProject(
1903             target = target + env['MSVSPROJECTSUFFIX'],
1904             # this allows easy access to header files (along with source)
1905             srcs = [env.subst(x) for x in src + inc],
1906             incs = [env.subst('$TOP_SRCDIR/src/config.h')],
1907             localincs = [env.subst(x) for x in inc],
1908             resources = [env.subst(x) for x in res],
1909             buildtarget = build_target,
1910             cmdargs = cmds,
1911             variant = 'Debug'
1912         )
1913         Alias('msvs_projects', proj)
1914     #
1915     boost_src = []
1916     for lib in boost_libs:
1917         boost_src += ['$TOP_SRCDIR/boost/libs/%s/src/%s' % (lib, x) for x in eval('boost_libs_%s_src_files' % lib)]
1918     build_project('boost', src = boost_src)
1919     #
1920     build_project('intl', src = ['$TOP_SRCDIR/intl/%s' % x for x in intl_files], 
1921         inc = ['$TOP_SRCDIR/intl/%s' % x for x in intl_header_files])
1922     #
1923     build_project('support', src = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files], 
1924         inc = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files])
1925     #
1926     build_project('mathed', src = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files], 
1927         inc = ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files])
1928     #
1929     build_project('insets', src = ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files], 
1930         inc = ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files])
1931     #
1932     build_project('frontends', src = ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files], 
1933         inc = ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files])
1934     #
1935     build_project('graphics', src = ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files], 
1936         inc = ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files])
1937     #
1938     build_project('controllers', src = ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files], 
1939         inc = ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files])
1940     #
1941     build_project('qt4', src = ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1942         inc = ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1943         res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files])
1944     #
1945     build_project('client', src = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_files],
1946         inc = ['$TOP_SRCDIR/src/client/%s' % x for x in src_client_header_files],
1947         rebuildTargetOnly = False,
1948         full_target = File(env.subst('$BUILDDIR/common/client/lyxclient$PROGSUFFIX')).abspath)
1949     #
1950     build_project('tex2lyx', src = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_files],
1951         inc = ['$TOP_SRCDIR/src/tex2lyx/%s' % x for x in src_tex2lyx_header_files],
1952         rebuildTargetOnly = False,
1953         full_target = File(env.subst('$BUILDDIR/common/tex2lyx/tex2lyx$PROGSUFFIX')).abspath)
1954     #
1955     build_project('lyxbase', src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files],
1956         inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files])
1957     build_project('lyx', 
1958         src = ['$TOP_SRCDIR/src/%s' % x for x in src_pre_files + src_post_files] + \
1959             ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_files] + \
1960             ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_files] + \
1961             ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_files] + \
1962             ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_files] + \
1963             ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_files] + \
1964             ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_files] + \
1965             ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_files + src_frontends_qt4_moc_files],
1966         inc = ['$TOP_SRCDIR/src/%s' % x for x in src_header_files] + \
1967             ['$TOP_SRCDIR/src/support/%s' % x for x in src_support_header_files] + \
1968             ['$TOP_SRCDIR/src/mathed/%s' % x for x in src_mathed_header_files] + \
1969             ['$TOP_SRCDIR/src/insets/%s' % x for x in src_insets_header_files] + \
1970             ['$TOP_SRCDIR/src/frontends/%s' % x for x in src_frontends_header_files] + \
1971             ['$TOP_SRCDIR/src/graphics/%s' % x for x in src_graphics_header_files] + \
1972             ['$TOP_SRCDIR/src/frontends/controllers/%s' % x for x in src_frontends_controllers_header_files] + \
1973             ['$TOP_SRCDIR/src/frontends/qt4/%s' % x for x in src_frontends_qt4_header_files],
1974         res = ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1975         rebuildTargetOnly = False,
1976         full_target = File(env.subst('$BUILDDIR/lyx$PROGSUFFIX')).abspath)
1977
1978
1979 if update_po:
1980     #
1981     # update po files
1982     #
1983     print 'Updating po/*.po files...'
1984
1985     # whether or not update po files
1986     if not env['XGETTEXT'] or not env['MSGMERGE'] or not env['MSGUNIQ']:
1987         print 'xgettext or msgmerge does not exist. Cannot merge po files'
1988         Exit(1)
1989     # build language_l10n.pot, ui_l10n.pot, layouts_l10n.pot, qt4_l10n.pot
1990     # and combine them to lyx.po
1991     env['LYX_POT'] = 'python $TOP_SRCDIR/po/lyx_pot.py'
1992     lyx_po = env.Command('$BUILDDIR/po/lyx.po',
1993         env.Command('$BUILDDIR/po/all.po',
1994             [env.Command('$BUILDDIR/po/qt4_l10n.pot', 
1995                 ['$TOP_SRCDIR/src/frontends/qt4/ui/%s' % x for x in src_frontends_qt4_ui_files],
1996                 '$LYX_POT -b $TOP_SRCDIR -t qt4 -o $TARGET $SOURCES'),
1997              env.Command('$BUILDDIR/po/layouts_l10n.pot', 
1998                 ['$TOP_SRCDIR/lib/layouts/%s' % x for x in lib_layouts_files],
1999                 '$LYX_POT -b $TOP_SRCDIR -t layouts -o $TARGET $SOURCES'),
2000              env.Command('$BUILDDIR/po/languages_l10n.pot', '$TOP_SRCDIR/lib/languages', 
2001                 '$LYX_POT -b $TOP_SRCDIR -t languages -o $TARGET $SOURCES'),
2002              env.Command('$BUILDDIR/po/ui_l10n.pot', 
2003                 ['$TOP_SRCDIR/lib/ui/%s' % x for x in lib_ui_files],
2004                 '$LYX_POT -b $TOP_SRCDIR -t ui -o $TARGET $SOURCES'),
2005              ], utils.env_cat),
2006             ['$MSGUNIQ -o $TARGET $SOURCE',
2007              '''$XGETTEXT --default-domain=${TARGET.base} \
2008                 --directory=$TOP_SRCDIR --add-comments=TRANSLATORS: \
2009                 --language=C++ --join-existing --keyword=_ --keyword=N_ --keyword=qt_ \
2010                 --files-from=$TOP_SRCDIR/po/POTFILES.in \
2011                 --copyright-holder="LyX Developers" \
2012                 --msgid-bugs-address="lyx-devel@lists.lyx.org" ''']
2013         )
2014     # copy lyx.po to lyx.pot
2015     lyx_pot = env.Command('$BUILDDIR/po/lyx.pot', lyx_po,
2016         Copy('$TARGET', '$SOURCE'))
2017     #
2018     import glob
2019     # files to translate
2020     transfiles = glob.glob(os.path.join(env.Dir('$TOP_SRCDIR/po').abspath, '*.po'))
2021     # possibly *only* handle these languages
2022     languages = None
2023     if env.has_key('languages'):
2024         languages = env.make_list(env['languages'])
2025     # merge. if I use lan.po as $TARGET, it will be removed
2026     # before it is merged. In this builder,
2027     # $BUILDDIR/po/lang.po is merged from po/lang.po and $BUILDDIR/po/lyx.pot
2028     # and is copied to po/lang.po
2029     env['BUILDERS']['msgmerge'] = Builder(action=[
2030         '$MSGMERGE $TOP_SRCDIR/po/${TARGET.filebase}.po $SOURCE -o $TARGET',
2031         Copy('$TOP_SRCDIR/po/${TARGET.filebase}.po', '$TARGET')]
2032         )
2033     # get dependency files from POTFILES.in
2034     dep_files = ['$TOP_SRCDIR/%s' % x.strip() for x in open(env.File('$TOP_SRCDIR/po/POTFILES.in').abspath).readlines()]
2035     dep_files.append('$TOP_SRCDIR/po/POTFILES.in')
2036     # for each po file, generate pot
2037     for po_file in transfiles:
2038         # get filename
2039         fname = os.path.split(po_file)[1]
2040         # country code
2041         country = fname.split('.')[0]
2042         #
2043         if not languages or country in languages:
2044             # merge po files, the generated lan.po_new file is copied to lan.po file.
2045             po = env.msgmerge('$BUILDDIR/po/%s.po' % country, lyx_pot)
2046             env.Depends(po, dep_files)
2047             Alias('update_po', po)
2048
2049
2050 if build_po:
2051     #
2052     # po/
2053     #
2054     print 'Processing files in po...'
2055
2056     import glob
2057     # handle po files
2058     #
2059     # files to translate
2060     transfiles = glob.glob(os.path.join(env.subst('$TOP_SRCDIR'), 'po', '*.po'))
2061     # possibly *only* handle these languages
2062     languages = None
2063     if env.has_key('languages'):
2064         languages = env.make_list(env['lanauges'])
2065     # use defulat msgfmt
2066     gmo_files = []
2067     if not env['MSGFMT']:
2068         print 'msgfmt does not exist. Can not process po files'
2069     else:
2070         # create a builder
2071         env['BUILDERS']['Transfiles'] = Builder(action='$MSGFMT $SOURCE -c --statistics -o $TARGET',suffix='.gmo',src_suffix='.po')
2072         #
2073         for f in transfiles:
2074             # get filename
2075             fname = os.path.split(f)[1]
2076             # country code
2077             country = fname.split('.')[0]
2078             #
2079             if not languages or country in languages:
2080                 gmo_files.extend(env.Transfiles(f))
2081
2082
2083 if build_install:
2084     #
2085     # this part is a bit messy right now. Since scons will provide
2086     # --DESTDIR option soon, at least the dest_dir handling can be 
2087     # removed later.
2088     #
2089     # how to join dest_dir and prefix
2090     def joinPaths(path1, path2):
2091         ''' join path1 and path2, do not use os.path.join because
2092             under window, c:\destdir\d:\program is invalid '''
2093         if path1 == '':
2094             return os.path.normpath(path2)
2095         # separate drive letter
2096         (drive, path) = os.path.splitdrive(os.path.normpath(path2))
2097         # ignore drive letter, so c:\destdir + c:\program = c:\destdir\program
2098         return os.path.join(os.path.normpath(path1), path[1:])
2099     #
2100     # install to dest_dir/prefix
2101     dest_dir = env.get('DESTDIR', '')
2102     dest_prefix_dir = joinPaths(dest_dir, env.Dir(prefix).abspath)
2103     # create the directory if needed
2104     if not os.path.isdir(dest_prefix_dir):
2105         try:
2106             os.makedirs(dest_prefix_dir)
2107         except:
2108             pass
2109         if not os.path.isdir(dest_prefix_dir):
2110             print 'Can not create directory', dest_prefix_dir
2111             Exit(3)
2112     #
2113     if env.has_key('exec_prefix'):
2114         bin_dest_dir = joinPaths(dest_dir, Dir(env['exec_prefix']).abspath)
2115     else:
2116         bin_dest_dir = os.path.join(dest_prefix_dir, 'bin')
2117     if add_suffix:
2118         share_dest_dir = os.path.join(dest_prefix_dir, share_dir + program_suffix)
2119     else:
2120         share_dest_dir = os.path.join(dest_prefix_dir, share_dir)
2121     man_dest_dir = os.path.join(dest_prefix_dir, man_dir)
2122     locale_dest_dir = os.path.join(dest_prefix_dir, locale_dir)
2123     env['LYX2LYX_DEST'] = os.path.join(share_dest_dir, 'lyx2lyx')
2124     #
2125     import glob
2126     #
2127     # install executables (lyxclient may be None)
2128     #
2129     if add_suffix:
2130         version_suffix = program_suffix
2131     else:
2132         version_suffix = ''
2133     #
2134     # install lyx, if in release mode, try to strip the binary
2135     if env.has_key('STRIP') and env['STRIP'] is not None and mode != 'debug':
2136         # create a builder to strip and install
2137         env['BUILDERS']['StripInstallAs'] = Builder(action='$STRIP $SOURCE -o $TARGET')
2138
2139     # install executables
2140     for (name, obj) in (('lyx', lyx), ('tex2lyx', tex2lyx), ('client', client)):
2141         if obj is None:
2142             continue
2143         target_name = os.path.split(str(obj[0]))[1].replace(name, '%s%s' % (name, version_suffix))
2144         target = os.path.join(bin_dest_dir, target_name)
2145         if env['BUILDERS'].has_key('StripInstallAs'):
2146             env.StripInstallAs(target, obj)
2147         else:
2148             env.InstallAs(target, obj)
2149         Alias('install', target)
2150
2151     # share/lyx
2152     dirs = []
2153     for (dir,files) in [
2154             ('.', lib_files),  
2155             ('bind', lib_bind_files),
2156             ('bind/de', lib_bind_de_files),
2157             ('bind/fi', lib_bind_fi_files),
2158             ('bind/pt', lib_bind_pt_files),
2159             ('bind/sv', lib_bind_sv_files),
2160             ('doc', lib_doc_files),
2161             ('doc/clipart', lib_doc_clipart_files),
2162             ('doc/cs', lib_doc_cs_files),
2163             ('doc/da', lib_doc_da_files),
2164             ('doc/de', lib_doc_de_files),
2165             ('doc/es', lib_doc_es_files),
2166             ('doc/es/clipart', lib_doc_es_clipart_files),
2167             ('doc/eu', lib_doc_eu_files),
2168             ('doc/fr', lib_doc_fr_files),
2169             ('doc/he', lib_doc_he_files),
2170             ('doc/hu', lib_doc_hu_files),
2171             ('doc/it', lib_doc_it_files),
2172             ('doc/nl', lib_doc_nl_files),
2173             ('doc/nb', lib_doc_nb_files),
2174             ('doc/pl', lib_doc_pl_files),
2175             ('doc/pt', lib_doc_pt_files),
2176             ('doc/ro', lib_doc_ro_files),
2177             ('doc/ru', lib_doc_ru_files),
2178             ('doc/sk', lib_doc_sk_files),
2179             ('doc/sl', lib_doc_sl_files),
2180             ('doc/sv', lib_doc_sv_files),
2181             ('examples', lib_examples_files),
2182             ('examples/ca', lib_examples_ca_files),
2183             ('examples/cs', lib_examples_cs_files),
2184             ('examples/da', lib_examples_da_files),
2185             ('examples/de', lib_examples_de_files),
2186             ('examples/es', lib_examples_es_files),
2187             ('examples/eu', lib_examples_eu_files),
2188             ('examples/fr', lib_examples_fr_files),
2189             ('examples/he', lib_examples_he_files),
2190             ('examples/hu', lib_examples_hu_files),
2191             ('examples/it', lib_examples_it_files),
2192             ('examples/nl', lib_examples_nl_files),
2193             ('examples/pl', lib_examples_pl_files),
2194             ('examples/pt', lib_examples_pt_files),
2195             ('examples/ru', lib_examples_ru_files),
2196             ('examples/sl', lib_examples_sl_files),
2197             ('examples/ro', lib_examples_ro_files),
2198             ('fonts', lib_fonts_files),
2199             ('images', lib_images_files),
2200             ('images/math', lib_images_math_files),
2201             ('kbd', lib_kbd_files),
2202             ('layouts', lib_layouts_files),
2203             ('lyx2lyx', lib_lyx2lyx_files),
2204             ('scripts', lib_scripts_files),
2205             ('templates', lib_templates_files),
2206             ('tex', lib_tex_files),
2207             ('ui', lib_ui_files)]:
2208         dirs.append(env.Install(os.path.join(share_dest_dir, dir),
2209             [env.subst('$TOP_SRCDIR/lib/%s/%s' % (dir, file)) for file in files]))
2210     Alias('install', dirs)
2211
2212     # subst and install lyx2lyx_version.py which is not in scons_manifest.py
2213     env.Depends(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py', '$BUILDDIR/common/config.h')
2214     env.substFile(share_dest_dir + '/lyx2lyx/lyx2lyx_version.py',
2215         '$TOP_SRCDIR/lib/lyx2lyx/lyx2lyx_version.py.in')
2216     Alias('install', share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2217     sys.path.append(share_dest_dir + '/lyx2lyx')
2218     
2219     # generate TOC files for each doc
2220     languages = depend.all_documents(env.Dir('$TOP_SRCDIR/lib/doc').abspath)
2221     tocs = []
2222     for lang in languages.keys():
2223         if os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR/lib/doc').abspath, lang)):
2224             toc = env.installTOC(os.path.join(share_dest_dir, 'doc', lang, 'TOC.lyx'),
2225                 languages[lang])
2226             tocs.append(toc)
2227             # doc_toc.build_toc needs a installed version of lyx2lyx to execute
2228             env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2229         else:
2230             # this is for English
2231             toc = env.installTOC(os.path.join(share_dest_dir, 'doc', 'TOC.lyx'),
2232                 languages[lang])
2233             tocs.append(toc)
2234             env.Depends(toc, share_dest_dir + '/lyx2lyx/lyx2lyx_version.py')
2235     Alias('install', tocs)
2236     
2237     if platform_name == 'cygwin':
2238         # cygwin packaging requires a file /usr/share/doc/Cygwin/foot-vendor-suffix.README
2239         Cygwin_README = os.path.join(dest_prefix_dir, 'share', 'doc', 'Cygwin', 
2240             '%s-%s.README' % (package, package_cygwin_version))
2241         env.InstallAs(Cygwin_README,
2242             os.path.join(env.subst('$TOP_SRCDIR'), 'README.cygwin'))
2243         Alias('install', Cygwin_README)
2244         # also a directory /usr/share/doc/lyx for README etc
2245         Cygwin_Doc = os.path.join(dest_prefix_dir, 'share', 'doc', package)
2246         env.Install(Cygwin_Doc, [os.path.join(env.subst('$TOP_SRCDIR'), x) for x in \
2247             ['INSTALL', 'README', 'README.Cygwin', 'RELEASE-NOTES', 'COPYING', 'ANNOUNCE']])
2248         Alias('install', Cygwin_Doc)
2249         # cygwin fonts also need to be installed
2250         Cygwin_fonts = os.path.join(share_dest_dir, 'fonts')
2251         env.Install(Cygwin_fonts, 
2252             [env.subst('$TOP_SRCDIR/development/Win32/packaging/bakoma/%s' % file) \
2253                   for file in win32_bakoma_fonts])
2254         Alias('install', Cygwin_fonts)
2255         # we also need a post installation script
2256         tmp_script = utils.installCygwinPostinstallScript('/tmp')
2257         postinstall_path = os.path.join(dest_dir, 'etc', 'postinstall')
2258         env.Install(postinstall_path, tmp_script)
2259         Alias('install', postinstall_path)
2260
2261
2262     # man
2263     env.InstallAs(os.path.join(man_dest_dir, 'lyx' + version_suffix + '.1'),
2264         env.subst('$TOP_SRCDIR/lyx.man'))
2265     env.InstallAs(os.path.join(man_dest_dir, 'tex2lyx' + version_suffix + '.1'),
2266         env.subst('$TOP_SRCDIR/src/tex2lyx/tex2lyx.man'))
2267     env.InstallAs(os.path.join(man_dest_dir, 'lyxclient' + version_suffix + '.1'),
2268         env.subst('$TOP_SRCDIR/src/client/lyxclient.man'))
2269     Alias('install', [os.path.join(man_dest_dir, x + version_suffix + '.1') for
2270         x in ['lyx', 'tex2lyx', 'lyxclient']])
2271     # locale files?
2272     # ru.gmo ==> ru/LC_MESSAGES/lyxSUFFIX.mo
2273     for gmo in gmo_files:
2274         lan = os.path.split(str(gmo))[1].split('.')[0]
2275         dest_file = os.path.join(locale_dest_dir, lan, 'LC_MESSAGES', 'lyx' + program_suffix + '.mo')
2276         env.InstallAs(dest_file, gmo)
2277         Alias('install', dest_file)
2278
2279
2280 if build_installer:
2281     #
2282     # build windows installer using NSIS
2283     #
2284     # NOTE:
2285     # There is a nsis builder on scons wiki but it does not work with
2286     # our lyx.nsi because it does not dig through all the include directives
2287     # and find the dependencies automatically. Also, it can not parse
2288     # OutFile in lyx.nsi since it is defined as SETUP_EXE which is in turn
2289     # something rely on date.
2290     # Because of this, I am doing a simple nsis builder here.
2291     if platform_name != 'win32':
2292         print 'installer target is only available for windows platform'
2293         Exit(1)
2294     if mode != 'release':
2295         print 'installer has to be built in release mode (use option mode=release)'
2296         Exit(1)
2297     if env.has_key('NSIS') and env['NSIS'] is not None:
2298         # create a builder to strip and install
2299         env['BUILDERS']['installer'] = Builder(generator=utils.env_nsis)
2300     else:
2301         print 'No nsis compiler is found. Existing...'
2302         Exit(2)
2303     if not env.has_key('win_installer') or env['win_installer'] is None:
2304         if devel_version:
2305             env['win_installer'] = '%s-%s-%s-Installer.exe' % (package_name, package_version, time.strftime('%Y-%m-%d'))
2306         else:
2307             env['win_installer'] = '%s-%s-Installer.exe' % (package_name, package_version)
2308     # provide default setting            
2309     if not env.has_key('deps_dir') or env['deps_dir'] is None:
2310         env['deps_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-deps-msvc-qt4')
2311     if not os.path.isdir(env.Dir('$deps_dir').abspath):
2312         print 'Development dependency package is not found.'
2313         Exit(1)    
2314     else:
2315         env['deps_dir'] = env.Dir('$deps_dir').abspath
2316     # build bundle?
2317     if env.has_key('bundle_dir') and os.path.isdir(env.Dir('$bundle_dir').abspath):
2318         env['bundle_dir'] = env.Dir('$bundle_dir').abspath
2319     elif os.path.isdir(os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')):
2320         env['bundle_dir'] = os.path.join(env.Dir('$TOP_SRCDIR').abspath, 'lyx-windows-bundle-deps')
2321     else:
2322         env['bundle_dir'] = None
2323     # if absolute path is given, use it, otherwise, write to current directory
2324     if not (':' in env['win_installer'] or '/' in env['win_installer'] or '\\' in env['win_installer']):
2325         env['win_installer'] = os.path.join(env.Dir('$BUILDDIR').abspath, env['win_installer'])
2326     env.Append(NSISDEFINES={
2327         'ExeFile':env['win_installer'],
2328         'BundleExeFile':env['win_installer'].replace('.exe', '-bundle.exe'),
2329         'FilesLyx':env.Dir(dest_prefix_dir).abspath,
2330         'FilesDeps':env['deps_dir'],
2331         'FilesBundle':env['bundle_dir'],
2332         })
2333     installer = env.installer(env['win_installer'],
2334         '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2335     # since I can not use a scanner, explicit dependent is required
2336     env.Depends(installer, 'install')
2337     env.Alias('installer', installer)
2338     # also generate bundle?
2339     if env.has_key('bundle') and env['bundle']:
2340         if env['bundle_dir'] is None or not os.path.isdir(env['bundle_dir']):
2341             print 'Bundle directory does not exist (default to %s\lyx-windows-bundle-deps.' % env.Dir('$TOP_SRCDIR').abspath
2342             print 'Use bundle_dir option to specify'
2343             Exit(1)
2344         # generator of the builder will add bundle stuff depending on output name
2345         bundle_installer = env.installer(env['win_installer'].replace('.exe', '-bundle.exe'),
2346             '$TOP_SRCDIR/development/Win32/packaging/installer/lyx.nsi')
2347         env.Depends(bundle_installer, 'install')
2348         env.Alias('installer', bundle_installer)
2349
2350 Default('lyx')
2351 Alias('all', ['lyx', 'client', 'tex2lyx'])