GeoGen API Reference
Public Member Functions | List of all members
geogen::compiler::Compiler Class Reference

A script compiler based on ANTLR 3. More...

Public Member Functions

 Compiler (Configuration configuration=Configuration())
 Default constructor. More...
 
runtime::CompiledScriptCompileScript (String const &code) const
 Compiles script string into a runtime::CompiledString. More...
 
Configuration const & GetConfiguration () const
 Gets the configuration of the compiler. More...
 

Detailed Description

A script compiler based on ANTLR 3.

Examples:
AdvancedScriptParameters.cpp, BasicUsage.cpp, ErrorHandling.cpp, MultipleTiles.cpp, RenderProgress.cpp, ScriptParameters.cpp, and TextMessages.cpp.

Constructor & Destructor Documentation

geogen::compiler::Compiler::Compiler ( Configuration  configuration = Configuration())

Default constructor.

Parameters
configuration(Optional) Configuration. Default is used if not specified.

Member Function Documentation

CompiledScript * Compiler::CompileScript ( String const &  code) const

Compiles script string into a runtime::CompiledString.

Parameters
codeThe code.
Returns
A compiled script.
Examples:
AdvancedScriptParameters.cpp, BasicUsage.cpp, ErrorHandling.cpp, MultipleTiles.cpp, RenderProgress.cpp, ScriptParameters.cpp, and TextMessages.cpp.
Configuration const& geogen::compiler::Compiler::GetConfiguration ( ) const
inline

Gets the configuration of the compiler.

Returns
The configuration.