Reference guide

Class Inheritance diagram

openalea.sconsx.config module

Download the source file ../src/openalea/sconsx/config.py.

See OpenAlea WebSite / Packages / SConsX

exception ToolNotFound

Bases: UserWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception CircularDependency

Bases: Exception

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

import_tool(name, import_dir)

Import a module based on its name from a list of directories.

exist(s, path)

Test if the file s exist in the path

getLocalPath()

Return the absolute path of this package

BisonFlex(env, bison, flex, prefix)

Smart autoscan function.

class Platform

Bases: object

class Posix

Bases: Platform

class Linux

Bases: Posix

distribution()

class Irix

Bases: Posix

class Cygwin

Bases: Posix

class Darwin

Bases: Posix

class Win32

Bases: Platform

GetPlatform()

Factory function returning the correct platform instance.

class Config(tools=[], dir=[])

Bases: object

add_tool(tool)

Add a specific tool and its dependencies recursively in the tool set. Check the circular dependencies.

find_tool(toolname)

Search for a specific tool

Options(*args, **kwds)

Add each tool options

UpdateOptions(opts)

Configure(env)

Configure each tools

Update(env)

Update the environment for each tools.

class ALEAConfig(package_name, *args, **kwds)

Bases: Config

Update(env)

Update the environment for each tools.

Configure(env)

Configure each tools

Options(*args, **kwds)

Add each tool options

UpdateOptions(opts)

add_tool(tool)

Add a specific tool and its dependencies recursively in the tool set. Check the circular dependencies.

find_tool(toolname)

Search for a specific tool

ALEAEnvironment(conf, *args, **kwds)

ALEASolution(options, tools=[], dir=[])

openalea.sconsx.environ module

Download the source file ../src/openalea/sconsx/environ.py.

This module add some facilities to simplify the SConscript files to the minimum. It contains wrapper functions that extend the SCons environment and abstract the operating system.

Each function defines or populate global aliases like build or install.

ALEALibrary(env, target, source, *args, **kwds)

Build static or dynamic library depending on user flags. Install the build library and associated files in specific directories. Define ‘build’ and ‘install’ target.

ALEAIncludes(env, target, includes, *args, **kwds)

Install the headers in the directory …/include/mypackage Define ‘build’ and ‘install’ target.

ALEAProgram(env, target, source, *args, **kwds)

Build a program and install it in local and system directories.

ALEAWrapper(env, python_dir, target, source, *args, **kwds)

Build a python wrapper and install it in a python package.

ALEAGlob(env, pattern, dir='.')

ALEAGlobDir(env, pattern, dir='.')

openalea.sconsx.lex module

Download the source file ../src/openalea/sconsx/lex.py.

SCons.Tool.lex

Tool-specific initialization for lex.

There normally shouldn’t be any need to import this module directly. It will usually be imported through the generic SCons.Tool.Tool() selection method.

generate(env)

Add Builders and construction variables for lex to an Environment.

exists(env)

openalea.sconsx.qt4 module

Download the source file ../src/openalea/sconsx/qt4.py.

SCons.Tool.qt

Tool-specific initialization for Qt.

There normally shouldn’t be any need to import this module directly. It will usually be imported through the generic SCons.Tool.Tool() selection method.

exception ToolQtWarning

Bases: SConsWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception GeneratedMocFileNotIncluded

Bases: ToolQtWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception QtdirNotFound

Bases: ToolQtWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

checkMocIncluded(target, source, env)

find_file(filename, paths, node_factory)

generate(env)

Add Builders and construction variables for qt to an Environment.

enable_modules(self, modules, debug=False, suffix='')

exists(env)

openalea.sconsx.qt5 module

Download the source file ../src/openalea/sconsx/qt5.py.

SCons.Tool.qt

Tool-specific initialization for Qt.

There normally shouldn’t be any need to import this module directly. It will usually be imported through the generic SCons.Tool.Tool() selection method.

exception ToolQtWarning

Bases: SConsWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception GeneratedMocFileNotIncluded

Bases: ToolQtWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception QtdirNotFound

Bases: ToolQtWarning

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

checkMocIncluded(target, source, env)

find_file(filename, paths, node_factory)

generate(env)

Add Builders and construction variables for qt to an Environment.

enable_modules(self, modules, debug=False, suffix='')

exists(env)

openalea.sconsx.tools.alea module

Download the source file ../src/openalea/sconsx/tools/alea.py.

OpenAlea configure environment.

class Alea(config)

Bases: object

default()

Set default tool values

option(opts)

Add scons options to opts

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create alea tool

openalea.sconsx.tools.bison module

Download the source file ../src/openalea/sconsx/tools/bison.py.

Bison configure environment.

get_bison_version(bisonpath)

class Bison(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create bison tool

openalea.sconsx.tools.boost_python module

Download the source file ../src/openalea/sconsx/tools/boost_python.py.

Boost.Python configure environment.

class Boost_Python(config)

Bases: BoostBase

depends()

get_default_flags()

get_default_defines()

configure(config)

default()

option(opts)

update(env)

Update the environment with specific flags

create(config)

Create boost tool

openalea.sconsx.tools.builddir module

Download the source file ../src/openalea/sconsx/tools/builddir.py.

Build directory configure environment.

class BuildDir(config)

Bases: object

Define Variant Dir options for putting build files outside the source tree.

Pluggin definition.

default()

Set the default directory values for build_prefix.

option(opts)

Define user options to redefine the default values.

update(env)

Update the environment with specific flags.

configure(config)

Configure code needs to go here.

create(config)

Create builddir tool.

openalea.sconsx.tools.cgal module

Download the source file ../src/openalea/sconsx/tools/cgal.py.

CGAL configure environment.

class CGAL(config)

Bases: object

depends()

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create cgal tool

openalea.sconsx.tools.compiler module

Download the source file ../src/openalea/sconsx/tools/compiler.py.

Build directory configure environment.

get_default_msvc()

class Compiler(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create compiler tool

openalea.sconsx.tools.egglib module

Download the source file ../src/openalea/sconsx/tools/egglib.py.

OpenAlea configure environment.

class EggLib(name, config)

Bases: object

default()

Set default tool values

option(opts)

Add scons options to opts

update(env)

Update the environment with specific flags

configure(config)

create(name, config)

openalea.sconsx.tools.flex module

Download the source file ../src/openalea/sconsx/tools/flex.py.

Flex configure environment.

class Flex(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create flex tool

openalea.sconsx.tools.gcc module

Download the source file ../src/openalea/sconsx/tools/gcc.py.

Gcc configure environment.

class Gcc(config)

Bases: object

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create gcc tool

openalea.sconsx.tools.gmp module

Download the source file ../src/openalea/sconsx/tools/gmp.py.

GMP configure environment.

class GMP(config)

Bases: object

depends()

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create gmp tool

openalea.sconsx.tools.gnuplot module

Download the source file ../src/openalea/sconsx/tools/gnuplot.py.

Gnuplot configure environment.

class Gnuplot(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create gnuplot tool

openalea.sconsx.tools.install module

Download the source file ../src/openalea/sconsx/tools/install.py.

Install configure environment.

class Install(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create install tool

openalea.sconsx.tools.mingw module

Download the source file ../src/openalea/sconsx/tools/mingw.py.

MinGW configure environment.

class MinGW(config)

Bases: object

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create mingw tool

openalea.sconsx.tools.msvc module

Download the source file ../src/openalea/sconsx/tools/msvc.py.

Visual Studio C++ configure environment.

class Msvc(config)

Bases: object

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create msvc tool

openalea.sconsx.tools.multicpu module

Download the source file ../src/openalea/sconsx/tools/multicpu.py.

QHull configure environment.

class MultiCPU(config)

Bases: object

option(opts)

Add Options to opts

update(env)

Update the environment with specific flags

configure(config)

create(config)

openalea.sconsx.tools.opengl module

Download the source file ../src/openalea/sconsx/tools/opengl.py.

OpenGL configure environment.

class OpenGL(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create opengl tool

openalea.sconsx.tools.pthread module

Download the source file ../src/openalea/sconsx/tools/pthread.py.

Pthread configure environment.

class Pthread(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create pthread tool

openalea.sconsx.tools.python module

Download the source file ../src/openalea/sconsx/tools/python.py.

Python configure environment.

class Python(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create python tool

openalea.sconsx.tools.qhull module

Download the source file ../src/openalea/sconsx/tools/qhull.py.

QHull configure environment.

class Qhull(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create qhull tool

openalea.sconsx.tools.qt module

Download the source file ../src/openalea/sconsx/tools/qt.py.

QT configure environment.

class QT(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create qt tool

openalea.sconsx.tools.qt4 module

Download the source file ../src/openalea/sconsx/tools/qt4.py.

QT4 configure environment.

class QT(config)

Bases: object

default()

option(opts)

update(env)

Update the environment with specific flags

configure(config)

create(config)

Create qt tool

openalea.sconsx.tools.readline module

Download the source file ../src/openalea/sconsx/tools/readline.py.

Readline configure environment.

class Readline(config)

Bases: object

depends()

default()

option(opts)

update(env)

configure(config)

create(config)

Create readline tool

openalea.sconsx.tools.termcap module

Download the source file ../src/openalea/sconsx/tools/termcap.py.

Termcap configure environment.

class Termcap(config)

Bases: object

default()

option(opts)

update(env)

configure(config)

create(config)

Create termcap tool

openalea.sconsx.yacc module

Download the source file ../src/openalea/sconsx/yacc.py.

SCons.Tool.yacc

Tool-specific initialization for yacc.

There normally shouldn’t be any need to import this module directly. It will usually be imported through the generic SCons.Tool.Tool() selection method.

yEmitter(target, source, env)

yyEmitter(target, source, env)

generate(env)

Add Builders and construction variables for yacc to an Environment.

exists(env)