site_scons/senfutil.py

   1 import os.path, glob, site_tools.Yaptu
   2 from SCons.Script import *
   3
   4 senfutildir = os.path.dirname(__file__)
   5
   6 # Fix for SCons 0.97 compatibility
   7 try:
   8     Variables
   9 except NameError:
  10     Variables = Options
  11     BoolVariable = BoolOption
  12
  13 def parseLogOption(value):
  14     stream, area, level = ( x.strip() for x in value.strip().split('|') )
  15     stream = ''.join('(%s)' % x for x in stream.split('::') )
  16     if area : area = ''.join( '(%s)' % x for x in area.split('::') )
  17     else    : area = '(_)'
  18     return '((%s,%s,%s))' % (stream,area,level)
  19
  20 def expandLogOption(target, source, env, for_signature):
  21     if env.get('LOGLEVELS'):
  22         return [ 'SENF_LOG_CONF="' + ''.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() )+'"']
  23     else:
  24         return []
  25
  26 class BuildTypeOptions:
  27     def __init__(self, var):
  28         self._var = var
  29
  30     def __call__(self, target, source, env, for_signature):
  31         type = env['final'] and "final" or env['debug'] and "debug" or "normal"
  32         return env[self._var + "_" + type]
  33
  34 def parseArguments(env, *defs):
  35     vars = Variables(args=ARGUMENTS)
  36     for d in defs : vars.Add(d)
  37     vars.Update(env)
  38     env.Help("""
  39 Any construction environment variable may be set from the scons
  40 command line (see SConstruct file and SCons documentation for a list
  41 of variables) using
  42
  43    VARNAME=value    Assign new value
  44    VARNAME+=value   Append value at end
  45
  46 Special command line parameters:
  47 """)
  48     env.Help(vars.GenerateHelpText(env))
  49     try                  : unknv = vars.UnknownVariables()
  50     except AttributeError: unknv = vars.UnknownOptions()
  51     for k,v in unknv.iteritems():
  52         if k.endswith('+'):
  53             env.Append(**{k[:-1]: v})
  54         else:
  55             env.Replace(**{k: v})
  56
  57
  58 ###########################################################################
  59 # This looks much more complicated than it is: We do three things here:
  60 # a) switch between final or debug options
  61 # b) parse the LOGLEVELS parameter into the correct SENF_LOG_CONF syntax
  62 # c) check for a local SENF, set options accordingly and update that SENF if needed
  63
  64 def SetupForSENF(env, senf_path = []):
  65     global senfutildir
  66     senf_path.extend(('senf', os.path.dirname(senfutildir), '/usr/local', '/usr'))
  67     tooldir = os.path.join(senfutildir, 'site_tools')
  68
  69     env.Tool('Boost',       [ tooldir ])
  70     env.Tool('PhonyTarget', [ tooldir ])
  71     env.Tool('Yaptu',       [ tooldir ])
  72     env.Tool('CopyToDir',   [ tooldir ])
  73     env.Tool('Doxygen',     [ tooldir ])
  74
  75     env.Append(
  76         LIBS              = [ 'senf', 'rt', '$BOOSTREGEXLIB',
  77                               '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
  78                               '$BOOSTFSLIB' ],
  79         BOOSTREGEXLIB     = 'boost_regex',
  80         BOOSTIOSTREAMSLIB = 'boost_iostreams',
  81         BOOSTSIGNALSLIB   = 'boost_signals',
  82         BOOSTFSLIB        = 'boost_filesystem',
  83
  84         CXXFLAGS          = [ '-Wno-long-long', '$CXXFLAGS_' ],
  85         CXXFLAGS_         = BuildTypeOptions('CXXFLAGS'),
  86
  87         CPPDEFINES        = [ '$expandLogOption', '$CPPDEFINES_' ],
  88         expandLogOption   = expandLogOption,
  89         CPPDEFINES_       = BuildTypeOptions('CPPDEFINES'),
  90
  91         LINKFLAGS         = [ '-rdynamic', '$LINKFLAGS_' ],
  92         LINKFLAGS_        = BuildTypeOptions('LINKFLAGS'),
  93
  94         LOGLEVELS         = [ '$LOGLEVELS_' ],
  95         LOGLEVELS_        = BuildTypeOptions('LOGLEVELS'),
  96         )
  97
  98     env.SetDefault(
  99         CXXFLAGS_final    = [],
 100         CXXFLAGS_normal   = [],
 101         CXXFLAGS_debug    = [],
 102
 103         CPPDEFINES_final  = [],
 104         CPPDEFINES_normal = [],
 105         CPPDEFINES_debug  = [],
 106
 107         LINKFLAGS_final   = [],
 108         LINKFLAGS_normal  = [],
 109         LINKFLAGS_debug   = [],
 110
 111         LOGLEVELS_final   = [],
 112         LOGLEVELS_normal  = [],
 113         LOGLEVELS_debug   = [],
 114
 115         PROJECTNAME       = "Unnamed project",
 116         DOCLINKS          = [],
 117         PROJECTEMAIL      = "nobody@nowhere.org",
 118         COPYRIGHT         = "nobody",
 119         REVISION          = "unknown",
 120         )
 121
 122     # Interpret command line options
 123     parseArguments(
 124         env,
 125         BoolVariable('final', 'Build final (optimized) build', False),
 126         BoolVariable('debug', 'Link in debug symbols', False),
 127     )
 128
 129     # If we have a symbolic link (or directory) 'senf', we use it as our
 130     # senf repository
 131     for path in senf_path:
 132         if not path.startswith('/') : sconspath = '#/%s' % path
 133         else                        : sconspath = path
 134         if os.path.exists(os.path.join(path,"senf/config.hh")):
 135             print "\nUsing SENF in '%s'\n" \
 136                 % ('/..' in sconspath and os.path.abspath(path) or sconspath)
 137             env.Append( LIBPATH = [ sconspath ],
 138                         CPPPATH = [ sconspath ],
 139                         BUNDLEDIR = sconspath,
 140                         SENFDIR = sconspath,
 141                         SENFSYSLAYOUT = False)
 142             try:
 143                 env.MergeFlags(file(os.path.join(path,"senf.conf")).read())
 144             except IOError:
 145                 print "(SENF configuration file 'senf.conf' not found, assuming non-final SENF)"
 146                 env.Append(CPPDEFINES = [ 'SENF_DEBUG' ])
 147             break
 148         elif os.path.exists(os.path.join(path,"include/senf/config.hh")):
 149             print "\nUsing system SENF in '%s/'\n" % sconspath
 150             env.Append(BUNDLEDIR = os.path.join(sconspath,"lib/senf"),
 151                        SENFDIR = sconspath,
 152                        SENFSYSLAYOUT = True)
 153             break
 154     else:
 155         print "\nSENF library not found .. trying build anyway !!\n"
 156
 157     env.Alias('all', '#')
 158
 159
 160 def DefaultOptions(env):
 161     env.Append(
 162         CXXFLAGS         = [ '-Wall', '-Woverloaded-virtual' ],
 163         CXXFLAGS_final   = [ '-O2' ],
 164         CXXFLAGS_normal  = [ '-O0', '-g' ],
 165         CXXFLAGS_debug   = [ '$CXXFLAGS_normal' ],
 166
 167         LINKFLAGS_normal = [ '-Wl,-S' ],
 168         LINKFLAGS_debug  = [ '-g' ],
 169     )
 170
 171 def Glob(env, exclude=[], subdirs=[]):
 172     testSources = glob.glob("*.test.cc")
 173     sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
 174     for subdir in subdirs:
 175         testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
 176         sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
 177                      if x not in testSources and x not in exclude ]
 178     return (sources, testSources)
 179
 180 tagfiles = None
 181
 182 def Doxygen(env, doxyheader=None, doxyfooter=None, doxycss=None, mydoxyfile=False, senfdoc_path=[],
 183             **kw):
 184     # Additional interesting keyword arguments or environment variables:
 185     #    PROJECTNAME, DOCLINKS, PROJECTEMAIL, COPYRIGHT, REVISION
 186
 187     global senfutildir
 188     global tagfiles
 189     libdir=os.path.join(senfutildir, 'lib')
 190
 191     if tagfiles is None:
 192         senfdocdir = None
 193         senfdoc_path.extend(('senfdoc', '$SENFDIR', '$SENFDIR/manual',
 194                              '$SENFDIR/share/doc/senf', '$SENFDIR/share/doc/libsenf-doc/html'))
 195         for path in senfdoc_path:
 196             path = env.Dir(path).get_path()
 197             if os.path.exists(os.path.join(path, "doc/doclib.tag")):
 198                 senfdocdir = path
 199                 break
 200         tagfiles = []
 201         if senfdocdir is None:
 202             print "(SENF documentation not found)"
 203         else:
 204             for dir, dirs, files in os.walk(senfdocdir):
 205                 tagfiles.extend([ os.path.join(dir,f) for f in files if f.endswith('.tag') ])
 206                 if dir.endswith('/doc') : dirs.remove('html')
 207                 for d in dirs:
 208                     if d.startswith('.') : dirs.remove(d)
 209
 210     if env.GetOption('clean'):
 211         env.Clean('doc', env.Dir('doc'))
 212         if not mydoxyfile:
 213             env.Clean('doc', "Doxyfile")
 214
 215     if not mydoxyfile:
 216         # Create Doxyfile NOW
 217         site_tools.Yaptu.yaptuAction("Doxyfile",
 218                                      os.path.join(libdir, "Doxyfile.yap"),
 219                                      env)
 220
 221     envvalues = [ env.Value('$PROJECTNAME'),
 222                   env.Value('$DOCLINKS'),
 223                   env.Value('$PROJECTEMAIL'),
 224                   env.Value('$COPYRIGHT'),
 225                   env.Value('$REVISION') ]
 226
 227     # The other files are created using dependencies
 228     if doxyheader:
 229         doxyheader = env.CopyToDir(env.Dir("doc"), doxyheader)
 230     else:
 231         doxyheader = env.Yaptu("doc/doxyheader.html", os.path.join(libdir, "doxyheader.yap"), **kw)
 232         env.Depends(doxyheader, envvalues)
 233     if doxyfooter:
 234         doxyfooter = env.CopyToDir(env.Dir("doc"), doxyfooter)
 235     else:
 236         doxyfooter = env.Yaptu("doc/doxyfooter.html", os.path.join(libdir, "doxyfooter.yap"), **kw)
 237         env.Depends(doxyfooter, envvalues)
 238     if doxycss:
 239         doxycss = env.CopyToDir(env.Dir("doc"), doxycss)
 240     else:
 241         doxycss    = env.CopyToDir(env.Dir("doc"), os.path.join(libdir, "doxy.css"))
 242
 243     doc = env.Doxygen("Doxyfile",
 244                       DOXYOPTS   = [ '--html', '--tagfiles', '"$TAGFILES"' ],
 245                       DOXYENV    = { 'TOPDIR'     : env.Dir('#').abspath,
 246                                      'LIBDIR'     : libdir,
 247                                      'REVISION'   : '$REVISION',
 248                                      'tagfiles'   : '$TAGFILES',
 249                                      'output_dir' : 'doc',
 250                                      'html_dir'   : 'html',
 251                                      'html'       : 'YES' },
 252                       TAGFILES   = tagfiles,
 253                       DOCLIBDIR  = libdir,
 254                       DOXYGENCOM = "$DOCLIBDIR/doxygen.sh $DOXYOPTS $SOURCE")
 255
 256     env.Depends(doc, [ doxyheader, doxyfooter, doxycss ])
 257
 258     return doc