root/branches/fcptr_stable_jun07/SConstruct

#!python
#
# SCons build script for OpenSG
import os, string, sys, re, glob, copy, types, traceback, pprint, tempfile, shutil
pj = os.path.join

# If we have wingide, try loading the debugging extenstions
try:
   import wing.wingdbstub
   print "Loaded wingdb stub for debugging..."
except:
   pass

# Extend paths for scons-addons and scons-build if needed
# - this allows a development version of scons-addons to be
#   in the standard python path and used instead.
try:
   import SConsAddons.Util
   print "Using SConsAddons from: ", os.path.dirname(SConsAddons.Util.__file__)
except:
   sys.path.insert(0,pj('Tools','scons-addons','src'))
   print "Using SConsAddons from: Tools/scons-addons/src"

sys.path.insert(0,pj('Tools','scons-build'))

print "-------------------------------------------------"
print "WARNING: The build is currently in development.  "
print "            - It needs the svn version of scons-addons"
print "WARNING:"

import SCons.Environment
import SCons
import SConsAddons.Util as sca_util
import SConsAddons.Options as sca_opts
import SConsAddons.Variants as sca_variants
import SConsAddons.Builders
import SConsAddons.Options.Boost
import SConsAddons.Options.VTK
from SConsAddons.EnvironmentBuilder import EnvironmentBuilder
from LibraryUtils import *
from sets import Set
from socket import gethostname

import OpenSG.AddOnHacks
import OpenSG.ColladaOption

from BuildInfoScanner import BuildInfoScanner
from RevisionTagWriter import RevisionTagWriter

# If we have pysvn, load it
try:
   import pysvn
   have_pysvn = True
except:
   have_pysvn = False

# Aliases
GetPlatform = sca_util.GetPlatform
Export('GetPlatform')
verbose_build = False

# Build TODO
# - Support selection of WS/ES
# - Support selection of compiler to build with
# - QT support
# - Contrib libraries
# - Library specific defines (if needed)
# - Build on windows
# - Project files for windows

# ---------------------------------------------------------------------------- #
# ------------------------------ HELPER METHODS ------------------------------ #
# ---------------------------------------------------------------------------- #

# ---------------- #
# --- BUILDERS --- #
# ---------------- #

# fcd2code builder
# - Custom builder for fcd2code
def registerfcd2codeBuilder(env, required=True):
   print "Setting up fcd2code builder...",
   
   fcd2code_cmd = pj("Tools", "fcd2code","fcd2code")
   fcd2code_cmd = os.path.abspath(fcd2code_cmd)
   if not os.path.isfile(fcd2code_cmd):
      print " Warning: fcd2code not found at: ", fcd2code_cmd
      if required:
         sys.exit(1)
      return
   
   template_files = glob.glob(pj("Tools",
                                 "fcd2code",
                                 "*TemplateFieldContainer*Base*.txt"))

   template_files.append(glob.glob(pj("Tools",
                                      "fcd2code",
                                      "*TemplateFieldContainer*Field*.txt")))

   template_files.append(glob.glob(pj("Tools",
                                      "fcd2code",
                                      "*Template*.py")))


   
   def prop_emitter(target,source,env, template_files=template_files):
      """ Returns a list of files including all output forms and
          The input templates as sources.
      """
      assert str(source[0]).endswith(".fcd")
      assert len(source) == 1

      base_name = os.path.splitext(str(source[0]))[0]

      # Targets are all the files that we build
      target = []
      for ext in ["Base.cpp","Base.h","Base.inl","Fields.h"]:
         target.append(base_name+ext)
      
      # Sources are the fcd file and all the template files
      source.extend(template_files)

      return (target, source)
   
   
   fcd2code_builder = Builder(action = " ".join([sys.executable, fcd2code_cmd]) + ' -c -b -d $SOURCE -p ${TARGET.dir}',
                              src_suffix = '.fcd',
                              suffix = 'unused.h',
                              emitter = prop_emitter)
   env.Append(BUILDERS = {'fcd2code' : fcd2code_builder})
   print "[OK]"


# fbd2code builder
# - Custom builder for fbd2code
def registerfbd2codeBuilder(env, required=True):
   print "Setting up fbd2code builder...",
   
   fbd2code_cmd = pj("Tools", "fcd2code","fcd2code")
   fbd2code_cmd = os.path.abspath(fbd2code_cmd)
   if not os.path.isfile(fbd2code_cmd):
      print " Warning: fcd2code not found at: ", fbd2code_cmd
      if required:
         sys.exit(1)
      return
   
   template_files = glob.glob(pj("Tools",
                                 "fcd2code",
                                 "*TemplateFieldBundle*Base*.txt"))

   template_files.append(glob.glob(pj("Tools",
                                      "fcd2code",
                                      "*TemplateFieldBundle*Field*.txt")))

   template_files.append(glob.glob(pj("Tools",
                                      "fcd2code",
                                      "*Template*.py")))
   
   def prop_emitter(target,source,env, template_files=template_files):
      """ Returns a list of files including all output forms and
          The input templates as sources.
      """
      assert str(source[0]).endswith(".fbd")
      assert len(source) == 1

      base_name = os.path.splitext(str(source[0]))[0]

      # Targets are all the files that we build
      target = []
      for ext in ["Base.cpp","Base.h","Base.inl","Fields.h"]:
         target.append(base_name+ext)
      
      # Sources are the fbd file and all the template files
      source.extend(template_files)

      return (target, source)
   
   
   fbd2code_builder = Builder(action = " ".join([sys.executable,
                              fbd2code_cmd]) + ' -c -b -B -d $SOURCE -p ${TARGET.dir}',
                              src_suffix = '.fbd',
                              suffix = 'unused.h',
                              emitter = prop_emitter)
   env.Append(BUILDERS = {'fbd2code' : fbd2code_builder})
   print "[OK]"


def addScanParseSkel(common_env):
   """ This is an ugly hack to add the lex/yacc support into the build.  It is ugly because of a couple of things.
      - We use some very custom flags
      - We need to post process the scanner to include a different file then normal.
      - We are forcing this to be done in the source tree in a subdir without actually going there.
      - Dependency management seems to be a little messed up right now in the code or scons.
      - BUGS: Scons does not seem to recognize that the files we are building here are source
              files for the libraries.  This makes it so we have to run the build twice if the files change.
              Scons cannot recognize whether the existing files are current or not, if they come out of 
               svn. This can result in spurious regens, which break the code if the wrong versions of 
               flex/bison are present.
   """
   # Hack to handle the generation of the parser from .y
   # This pretty hacky to allow using a version of the file from the repository if yacc is not installed
   # 1. Call bison: OSGScanParseSkelParser.yy -> OSGScanParseSkelParser.hpp .cpp .output (we don't need the last one)
   if "yacc" in common_env["TOOLS"]:
      if common_env["enable_scanparse_regen"]:
         parser_env = common_env.Copy()
         parser_env.Append(YACCFLAGS = ["-d","-v","-pOSGScanParseSkel_","-bOSGScanParseSkel_"])
         source_file = "Source/System/FileIO/ScanParseSkel/OSGScanParseSkelParser.yy"
         target_file = "Source/System/FileIO/ScanParseSkel/OSGScanParseSkelParser.cpp"
         yfiles = parser_env.CXXFile(target=target_file,source=source_file)
         NoClean(yfiles)
         #print "yfiles: ", yfiles

         # Make sure the parser files have been found for OSGFileIO
         y_cpp_file = str(yfiles[0]).replace("Source/","",1)
         y_hpp_file = str(yfiles[1]).replace("Source/","",1)
         #if not y_cpp_file in lib_map["OSGSystem"].source_files:
         #   lib_map["OSGSystem"].source_files.append(y_cpp_file)
         #if not y_hpp_file in lib_map["OSGSystem"].header_files:
         #   lib_map["OSGSystem"].header_files.append(y_hpp_file)
         #print " yy source: %s \n header: %s"%(lib_map["OSGSystem"].source_files, lib_map["OSGSystem"].header_files)
      else:
         print "WARNING: enable_scanparse_regen disabled. If you change .yy files they will not be rebuilt."
         common_env["TOOLS"].remove('yacc')
   else:
      print "WARNING: bison not available.  If you change .yy files they cannot be rebuilt."
   
   # Hack to handle the generation of the scanner from .lpp
   # This pretty hacky to allow using a version of the file from the repository if lex is not installed
   # 2. Call flex: OSGScanParseSkelScanner.lpp -> OSGScanParseSkelScanner.cpp (this one needs to be filtered to change the include)
   if "lex" in common_env["TOOLS"]:
      def filter_header(target, source, env):
         """ Custom filter to change the include file for the flexlexer.h"""
         fname = str(target[0])
         contents = open(fname).readlines()
         for i in range(len(contents)):
            if contents[i] == "#include <FlexLexer.h>\n":
               contents[i] = "#include \"%s\"\n" % os.path.split(OSG_flexlexer_h)[1]
               break
         open(fname,'w').writelines(contents)
         #print "filter_header: Created ", fname

      if common_env["enable_scanparse_regen"]:
         lexer_env = common_env.Copy()
         lexer_env.Append(LEXFLAGS = ["-+","-POSGScanParseSkel_"])

         lexer_dir       = pj('Source','System','FileIO','ScanParseSkel')
         sys_flexlexer_h = "/usr/include/FlexLexer.h"
         OSG_flexlexer_h = pj(lexer_dir,"OSGScanParseSkelScanner_FlexLexer.h")
         source_file     = pj(lexer_dir,"OSGScanParseSkelScanner.ll")
         target_file     = pj(lexer_dir,"OSGScanParseSkelScanner.cpp")

         # Replace lex builder with new action that calls flex and then filters
         std_lex_action = Action("$LEXCOM", "$LEXCOMSTR")
         filter_action = Action(filter_header, lambda t,s,e: "Filtering header: %s %s"%(str(t),str(s)))
         cxx_file_builder = lexer_env['BUILDERS']['CXXFile']
         cxx_file_builder.add_action('.ll', Action([std_lex_action, filter_action]))
         lfiles = lexer_env.CXXFile(target=target_file,source=source_file)
         NoClean(lfiles)
         #print "lfiles: ", lfiles

         # If available, copy the system FlexLexer.h file to local source dir
         if os.path.exists(sys_flexlexer_h):
            flexlex_cp = lexer_env.Command(OSG_flexlexer_h, sys_flexlexer_h,[Copy('$TARGET','$SOURCE'),])
            Depends(lfiles, flexlex_cp)

         #Depends(lfiles, "Source/System/FileIO/ScanParseSkel/OSGScanParseSkelParser.hpp") # the scanner includes the token header from the parser...
         if vars().has_key('yfiles'):
            Depends(lfiles, yfiles)

         # Strip off "Source/" since this will be in the build dir
         scanner_src = target_file.replace("Source/","",1)
         #if not scanner_src in lib_map["OSGSystem"].source_files:
         #   lib_map["OSGSystem"].source_files.append(scanner_src)
         #print "FileIO source files: ", lib_map["OSGSystem"].source_files
      else:
         print "WARNING: enable_scanparse_regen disabled. If you change .ll files they will not be rebuilt."
         common_env["TOOLS"].remove('lex')
   else:
      print "WARNING: flex not available.  If you change .ll files they cannot be rebuilt."

# -------------------- #
# --- OPTION TYPES --- #
# -------------------- #

class SimpleAppendOption(sca_opts.SimpleOption):
   """
   Variant of the simple option wrapper that appends a value to the environment instead
   of replacing it.
   """
   def __init__(self, name, key, help):
      """
      Create an option
      name - the name of the commandline option
      key - the name of the key in the environment to append to
      help - Help text about the option object
      """
      sca_opts.SimpleOption.__init__(self, name, name, help + " (Use ':' to separate multiple)", \
                                     None, None, None, None)
      self.key = key

   """
   We want these options to be applied before all others, to have them have effect on e.g.
   StandardPackageOption tests, so override completeProcess instead of apply.
   """
   def completeProcess(self, env):
      if self.value:
         for i in self.value.split(os.pathsep):
            exec("env.Append(%s = [i])" % self.key)

# ---------------------------------------------------------------------------- #
# ----------------------------- Main build setup ----------------------------- #
# ---------------------------------------------------------------------------- #

EnsureSConsVersion(0,96,92)
SourceSignatures('MD5')
#SourceSignatures('timestamp')
opensg_version_string = file("VERSION").readline().strip()

print "Building OpenSG ", opensg_version_string

# Allow user to pass an options file on the command line, with the
# option_file=myOptFile syntax

platform = sca_util.GetPlatform()
unspecified_prefix = "use-instlinks"


# Create base environment to use for option processing
if GetPlatform() == "win32":
   # XXX: Temp hack to get msvs version setting
   if ARGUMENTS.has_key("MSVS_VERSION"):
      common_env = Environment(MSVS_VERSION=ARGUMENTS["MSVS_VERSION"], 
                               ENV = os.environ,
                               tools = ['default', 'doxygen'], 
                               toolpath = '.')
   else:
      common_env = Environment(tools = ['default', 'doxygen'], toolpath = '.')

   # Embed the DLL manifest when building with Visual C++ 8.0 or newer.
   if common_env.has_key("MSVS") and common_env["MSVS"]["VERSION"] >= "8.0":
      common_env['SHLINKCOM'] = \
         [common_env['SHLINKCOM'],
          'mt.exe -manifest ${TARGET}.manifest -outputresource:$TARGET;2']
else:
   if ARGUMENTS.has_key("icc"):
      use_cxxlib_icc = False

      if ARGUMENTS.has_key("cxxlib-icc"):
         use_cxxlib_icc = True

      common_env = Environment(ENV = os.environ,
                               tools=['gnulink', 'intelicc', 'intelicpc', 'doxygen'],
                               cxxlib_icc=use_cxxlib_icc, 
                               toolpath = ['.', 'Tools/scons-build/OpenSG/Tools'])
   else:
      common_env = Environment(ENV = os.environ, 
                               toolpath = '.',
                               tools = ['default', 'doxygen'])

dbfile = '.sconsign.' + platform + common_env.subst('$CXX')
option_filename = "option.cache." + platform + '.' + common_env.subst('$CXX')

if common_env.has_key("MSVS"):
   msvs_ver = common_env["MSVS"]["VERSION"]
   dbfile          += "." + msvs_ver
   option_filename += "." + msvs_ver

SConsignFile(dbfile)
buildDir = "build." + platform + '.' + common_env.subst('$CXX')

if ARGUMENTS.has_key("options_file"):
   opt_file = ARGUMENTS["options_file"]
   if os.path.exists(opt_file):
      print "Reading options from: %s" % str(opt_file)
      option_filename = opt_file
   else:
      print "Options file '%s' not found.. will continue with default '%s'" % \
      (opt_file, option_filename)


# Setup the directories used for sconf processing
common_env["CONFIGUREDIR"] = '.sconf_temp_'+platform+'_'+common_env.subst('$CXX')
common_env["CONFIGURELOG"] = 'sconf.log_'+platform+'_'+common_env.subst('$CXX')
if common_env.has_key("MSVS"):
   common_env["CONFIGUREDIR"] += "." + common_env["MSVS"]["VERSION"]
   common_env["CONFIGURELOG"] += "." + common_env["MSVS"]["VERSION"]

SConsAddons.Builders.registerDefineBuilder(common_env)
SConsAddons.Builders.registerSubstBuilder(common_env)

# Create variant helper and builder
variant_helper = sca_variants.VariantsHelper(variantKeys=["type", "arch"])
base_bldr = EnvironmentBuilder()

# ----------------- #
# --- CONFIGURE --- #
# ----------------- #

# There is nothing to do ATM - sca_opts.StandardPackageOption can handle
# everything so far.

# --------------- #
# --- OPTIONS --- #
# --------------- #

# Options are stored in one of these groups:
# - required_libs_options:  Libraries needed to build OpenSG
# - optional_libs_options:  Libraries needed for/providing additional functionality
# - build_options:          Options to select build/install directories and
#                           special build steps.
# - feature_options:        Options to enable/disable or tweak certain features
#                           of OpenSG.
# - misc_options:           Options that do not fit anywhere else.
# - extra_libs_options:     Should not be changed - it's only to allow building
#                           with additional libraries that are not integrated into
#                           the build
#
# There is special handling for image formats, because some are directly
# supported and others require external libs, they may end up in different
# option groups, but in the help message they should show up together - see below.

#
# 1) Setup options
#    Create Option objects and store them in their group.

opts = sca_opts.Options(files = [option_filename, 'options.custom'],
                                   args= ARGUMENTS)

# Handle library name differences between platforms
if "win32" == platform:
    glut_libname = "glut32"
    tiff_libname = ["libtiff_i", "libtiff", "tif32"]
    zlib_libname = ["zlib1", "zlib"]
    jpeg_libname = "libjpeg"
    png_libname = ["libpng13", "libpng"]
else:
    glut_libname = "glut"
    tiff_libname = "tiff"
    zlib_libname = "z"
    jpeg_libname = "jpeg"
    png_libname = "png"


# Build options - source and destination directories etc.
build_options = {}
build_options["install_prefix"] = sca_opts.SimpleOption(
    "prefix", "prefix", "Installation prefix", unspecified_prefix, None, None, None)
build_options["build_suffix"] = sca_opts.SimpleOption(
    "build_suffix", "build_suffix",
    "Suffix to append to build directory.  Useful for compiling multiple variations on the same platform",
    "", None, None, None)
build_options["enable_fcd2code"] = sca_opts.BoolOption(
    "enable_fcd2code", "Enable code generation pass (from .fcd files) during build", False)
build_options["enable_fbd2code"] = sca_opts.BoolOption(
    "enable_fbd2code", "Enable code generation pass (from .fbd files) during build", False)
build_options["enable_distcc"] = sca_opts.BoolOption(
    "enable_distcc", "Enable use of distcc during build. (distcc must be in your path)", False)
build_options["enable_unittests"] = sca_opts.BoolOption(
    "enable_unittests", "Enable building and running of the unit tests after build", True)
build_options["enable_revision_tags"] = sca_opts.BoolOption(
    "enable_revision_tags", "Enable updating of OSG*Def.cpp files with current svn revision numbers", False)
build_options["enable_gv_beta"] = sca_opts.BoolOption(
    "enable_gv_beta", "Enable gv testing stuff", False)

# Options for required external libraries
required_libs_options = {}
if "win32" == platform:

    toolset = "auto"

    if common_env.has_key("MSVS"):
       toolset = 'vc' + common_env["MSVS"]["VERSION"].replace('.', '')

    required_libs_options["boost"] = sca_opts.Boost.Boost(
        "boost", "1.31.0", libs = ["filesystem"], required = True, 
        useVersion = True, allowLibNameFallbacks=True, toolset = toolset);
else:
    required_libs_options["boost"] = sca_opts.Boost.Boost(
        "boost", "1.31.0", libs = ["filesystem"], required = True, useVersion = True, allowLibNameFallbacks=True);

# Options for optional external libraries
optional_libs_options = {}
optional_libs_options["jpeg"] = sca_opts.StandardPackageOption(
    "jpeg", "Location of the JPEG library", library = jpeg_libname, required = False)

optional_libs_options["tiff"] = sca_opts.MultiNamePackageOption(
    "tiff", "Location of the TIFF library", library = tiff_libname, required = False)

optional_libs_options["png"] = sca_opts.MultiNamePackageOption(
    "png", "Location of the PNG library", library = png_libname, required = False)

optional_libs_options["glut"] = sca_opts.StandardPackageOption(
    "glut", "Location of the GLUT library", library = glut_libname,
    header = "GL/glut.h", required = False)

optional_libs_options["freetype"] = sca_opts.StandardPackageOption(
    "freetype", "Location of freetype2 library", library = "freetype",
    header = "freetype/config/ftheader.h", required = False)

if "win32" != platform:
   optional_libs_options["freetype"].incDir = '/usr/include/freetype2'

optional_libs_options["fontconfig"] = sca_opts.StandardPackageOption(
    "fontconfig", "Location of fontconfig library", library = "fontconfig",
    header = "fontconfig/fontconfig.h", required = False)

optional_libs_options["zlib"] = sca_opts.MultiNamePackageOption(
    "zlib", "Location of the zlib compression library", library = zlib_libname,
    header = "zlib.h", required = False)

optional_libs_options["NVPerfSDK"] = sca_opts.StandardPackageOption(
    "NVPerfSDK", "Location of the NVPerfSDK library", library = "NVPerfSDK",
    header = "NVPerfSDK.h", required = False)

collada_libs = ["collada_dae", "collada_dom"]
if "win32" == platform:
   # Linking against the DLL version of COLLADA DOM results in unresolved
   # symbols at link time.
   #collada_libs = ["libcollada141dom12", ["libcollada_dae", "libcollada_dom"]]
   collada_libs = ["libcollada_dae", "libcollada_dom"]
optional_libs_options["collada"] = OpenSG.ColladaOption.ColladaOption(
    "collada", "Location of the collada dom library", library = collada_libs,
    header = "dae/daeIntegrationObject.h", required = False)

xml2_lib = ["xml2"]
if "win32" == platform:
    xml2_lib = ["libxml2", "libxml2_a"]
optional_libs_options["xml2"] = sca_opts.MultiNamePackageOption(
    "xml2", "Location of the xml2 library", library = xml2_lib,
    header = "libxml/xmlversion.h", required = False)

iconv_lib = "iconv"
if "win32" == platform:
   iconv_lib = ["iconv", "iconv_a"]
optional_libs_options["iconv"] = sca_opts.MultiNamePackageOption(
    "iconv", "Location of the iconv library", library = iconv_lib,
    required = False)

optional_libs_options['vtk'] = sca_opts.VTK.VTK(
   "vtk",
   "Location of the vtk libraries",
   required = False,
   libList = ['vtkRendering',
              'vtkIO',
              'vtkGraphics',
              'vtkImaging',
              'vtkFiltering',
              'vtkCommon',
              'vtkftgl',
              'vtkDICOMParser',
              'vtksys',
              'vtkMPEG2Encode'])

# Feature options - select library/interface features
feature_options = {}
feature_options["gif"] = sca_opts.BoolOption(
    "enable_gif", "Enable GIF support", True)

feature_options["fcptr_mode"] = sca_opts.EnumOption(
    "fcptr_mode", "Select the mode for field container pointers",
    "MT_FCPTR", ["SINGLE_THREAD", "MT_CPTR", "MT_FCPTR"])

feature_options["disable_deprecated"] = sca_opts.BoolOption(
    "disable_deprecated", "Disable deprecated interfaces and code", False)

feature_options["disable_glut_glsubdir"] = sca_opts.BoolOption(
    "disable_glut_glsubdir", "Do not use GL subdir when including glut.h", False)

feature_options["enable_osg1_compat"] = sca_opts.BoolOption(
    "enable_osg1_compat", "Enable OpenSG 1.x compatibility", False)

feature_options["enable_deprecated_props"] = sca_opts.BoolOption(
    "enable_deprecated_props", "Enable deprecated property types.", False)

feature_options["enable_new_osb_io"] = sca_opts.BoolOption(
    "enable_new_osb_io", "Enable the new OSB IO facilities.", False)

feature_options["enable_collada"] = sca_opts.BoolOption(
    "enable_collada", "Enable the Collada IO facilities.", False)

feature_options["enable_scanparse_regen"] = sca_opts.BoolOption(
    "enable_scanparse_regen", "Enable regenerating the scanner/parser files using flex and bison", False);

feature_options["enable_testcontainer"] = sca_opts.BoolOption(
    "enable_testcontainer", "Enable container used for testing (from Source/Test)", False)

feature_options["docs_mode"] = sca_opts.EnumOption(
    "docs_mode", "Select the mode for documentation generation",
    "NONE", ["NONE", "STANDALONE", "TRAC", "DEVELOPER"])

feature_options["enable_valgrind_checks"] = sca_opts.BoolOption(
    "enable_valgrind_checks", "Enable valgrind check code embedded in OpenSG.", False)

feature_options["enable_memory_debugging"] = sca_opts.BoolOption(
    "enable_memory_debugging", "Enable memory debugging checks in OpenSG.", False)

feature_options["enable_double_matrix_stack"] = sca_opts.BoolOption(
    "enable_double_matrix_stack", "Enable double precision matrix stack in render traversal.", False)

if "win32" == platform:
    feature_options["enable_win_localstorage"] = sca_opts.BoolOption(
        "enable_win_localstorage", "Enable use of local storage instead of __declspec to "+
        "get thread local storage on windows", True)

if "win32" != platform:
    feature_options["enable_elf_localstorage"] = sca_opts.BoolOption(
        "enable_elf_localstorage", "Enable use of elf thread local storage with pthreads",
        ("linux" == platform))

# Misc options
misc_options = {}
#misc_options["icc_compat"] = sca_opts.SimpleOption(
#    "icc_gnu_compat", "icc_gnu_compat", "<GCC Version> Make the binaries built " +
#                      "with icc compatible with the given verion of gcc. (unsupported)",
#                      "", None, None, None)

# Options to specify additional library/header search paths and librarys to
# link agains.
extra_libs_options = {}
extra_libs_options["incdir"] = SimpleAppendOption('add_incdir', 'CPPPATH', 'Additional include dir')
extra_libs_options["libdir"] = SimpleAppendOption('add_libdir', 'LIBPATH', 'Additional library dir')
extra_libs_options["lib"]    = SimpleAppendOption('add_lib',    'LIBS',    'Additional library')

# Group all image format options together.
image_format_options = {}
image_format_options["jpeg"] = optional_libs_options["jpeg"]
image_format_options["tiff"] = optional_libs_options["tiff"]
image_format_options["png"]  = optional_libs_options["png"]
image_format_options["gif"]  = feature_options["gif"]

#
# 2) Register options
#    This should not require any changes unless a new option group is added.

for opt in extra_libs_options.itervalues():
    if opt not in image_format_options.itervalues():
        opts.AddOption(opt)

opts.AddOption(sca_opts.SeparatorOption("\nBuild/Install settings"))
for opt in build_options.itervalues():
    if opt not in image_format_options.itervalues():
        opts.AddOption(opt)

opts.AddOption(sca_opts.SeparatorOption("\nPackage settings (required libs)"))
for opt in required_libs_options.itervalues():
    if opt not in image_format_options.itervalues():
        opts.AddOption(opt)

opts.AddOption(sca_opts.SeparatorOption("\nPackage settings (optional libs)"))
for opt in optional_libs_options.itervalues():
    if opt not in image_format_options.itervalues():
        opts.AddOption(opt)

for opt in image_format_options.itervalues():
    opts.AddOption(opt)


opts.AddOption(sca_opts.SeparatorOption("\nAdvanced options"))
for opt in feature_options.itervalues():
    if opt not in image_format_options.itervalues():
        opts.AddOption(opt)

for opt in misc_options.itervalues():
    if opt not in image_format_options.itervalues():
        opts.AddOption(opt)

# Add environment builder options
base_bldr.addOptions(opts)

# Add variant building options
variant_helper.addOptions(opts)

#
# 3) Process options

try:
   opts.Process(common_env)
except Exception, ex:
   if not SConsAddons.Util.hasHelpFlag():
      print "Option error: ", str(ex)
      traceback.print_exc()
      sys.exit(1)

#
# 4) Generate help message

help_text = \
"""--- OpenSG Build system ---
%s
Targets:
   install - Install OpenSG
      ex: 'scons install prefix=$HOME/software' to install in your account
   Type 'scons' to just build it

""" % (opts.GenerateHelpText(common_env),)

Help(help_text)

# --------------------------------------------------------------------------- #
# ---------------------------- MAIN BUILD STEPS ----------------------------- #
# --------------------------------------------------------------------------- #

# If we are running the build
if not SConsAddons.Util.hasHelpFlag():
   try:                                   # Try to save the options if possible
      if not ARGUMENTS.has_key("options_file"):
         opts.Save(option_filename, common_env)
   except LookupError, le:
      pass
   
   if common_env.has_key("MSVS"):
      import pprint
      print "Found MSVS. using version: ", common_env["MSVS"]["VERSION"]
      pprint.pprint(common_env["MSVS"])

   # Update settings
   if common_env.has_key("MSVS"):
      buildDir += "." + common_env["MSVS"]["VERSION"]
   if common_env["build_suffix"] != "":
      buildDir += "." + common_env["build_suffix"]
      
   # .fcd processing
   if common_env["enable_fcd2code"]:
      registerfcd2codeBuilder(common_env)
      
      fcd_files = []
      for root, dirs, files in os.walk(pj(os.getcwd(),'Source')):
         fcd_files += [pj(root,f) for f in files if f.endswith(".fcd")]
      
      for f in fcd_files:
         fcd_targets = common_env.fcd2code(source=f)
         NoClean(fcd_targets)
   
   # .fbd processing
   if common_env["enable_fbd2code"]:
      registerfbd2codeBuilder(common_env)
      
      fbd_files = []
      for root, dirs, files in os.walk(pj(os.getcwd(),'Source')):
         fbd_files += [pj(root,f) for f in files if f.endswith(".fbd")]
      
      for f in fbd_files:
         fbd_targets = common_env.fbd2code(source=f)