DefaultEnvCalls.py

Go to the documentation of this file.

#  This file is part of repro, a Python package for automating 
#  reproducible research in scientific computing.
#
#  Copyright (C) 2008  Gilles Hennenfent, Sean Ross-Ross
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

##
# 
# Let one use Builder() instead of env.Builder() in SConstruct files.
# 

from SCons.Script import Environment as _Environment
from SCons.Script import Action

##
# 
#     @brief Let one use Rush() instead of env.Rush(). Note that this call 
#     allows less flexibility than env.Rush().
#     
def Rush( target=None, source=None, flow_command=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'rush'  )
    return env._Rush( target=target, source=source, flow_command=flow_command, *p, **kw)

##
# 
#     @brief Let one use Matlab() instead of env.Matlab(). Note that this call 
#     allows less flexibility than env.Matlab().
#     
def Matlab( target=None, source=None, matfuncs=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'matlab'  )
    return env.Matlab( target=target, source=source, matfuncs=matfuncs, *p, **kw)

##
# 
#     @brief Let one use GetPar() instead of env.GetPar(). Note that this call 
#     allows less flexibility than env.GetPar().
#     
def GetPar( source, par, *p, **kw ):
    env = _Environment( )
    env.Tool( 'rush'  )
    
    return env._GetPar( source, par=par, *p, **kw )

##
# 
#     @brief Let one use FTP() instead of env.FTP(). Note that this call 
#     allows less flexibility than env.FTP().
#     
def FTP( target, *p, **kw ):
    env = _Environment( )
    env.Tool( 'fetch' )
    
    return env.FTP( target, None, *p, **kw )

##
# 
#     @brief Let one use WGET() instead of env.WGET(). Note that this call 
#     allows less flexibility than env.WGET().
#     
def WGET( target, *p, **kw ):
    env = _Environment( )
    env.Tool( 'fetch' )
    
    return env.WGET( target, None, *p, **kw )

##
# 
#     @brief Let one use View() instead of env.View(). Note that this call 
#     allows less flexibility than env.View().
#     
def View( source, *p, **kw ):
    env = _Environment()
    env.Tool( 'rush'  )
    
    return env.View( source ,*p, **kw )

##
# 
#     @brief Let one use Preamble() instead of env.Preamble(). Note that this call 
#     allows less flexibility than env.Preamble().
#     
def Preamble( target=None, source=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'paper'  )
    preamble_res = env.Preamble( target=target, source=source, *p, **kw )
    
    return preamble_res

##
# 
#     @brief Let one use HTML() instead of env.HTML(). Note that this call 
#     allows less flexibility than env.HTML().
#     
def HTML( target=None, source=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'html'  )
    html_res = env.HTML( target=target, source=source, *p, **kw )
    
    return html_res

##
# 
#     @brief Let one use PNG() instead of env.PNG(). Note that this call 
#     allows less flexibility than env.PNG().
#     
def PNG( target=None, source=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'figures'  )

    if source is None:
        source = target
        png_res = env.PNG( source=source, *p, **kw )
    else:
        png_res = env.PNG( target=target, source=source, *p, **kw )    
    
    return png_res

##
# 
#     @brief Let one use EPS() instead of env.EPS(). Note that this call 
#     allows less flexibility than env.EPS().
#     
def EPS( target=None, source=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'figures'  )
    eps_res = env.EPS( target=target, source=source, *p, **kw )
    
    return eps_res

##
# 
#     @brief Let one use EPS() instead of env.EPS(). Note that this call 
#     allows less flexibility than env.EPS().
#     
def ColorPySource( target=None, source=None, *p, **kw ):
    env = _Environment( )
    env.Tool( 'html'  )
    res = env.ColorPySource( target=target, source=source, *p, **kw )
    
    return res

##
# 
#     @brief Let one use sfbin() instead of env.sfbin(). Note that this call 
#     allows less flexibility than env.sfbin().
#     
def sfbin( targets, *p, **kw ):
    env = _Environment( )
    env.Tool( 'rush' )
    return env.sfbin( targets, *p, **kw )

---