org.jmodelica.modelica.compiler.ModelicaCompiler Class Reference

Main compiler class which bundles the tasks needed to compile a Modelica model. More...

List of all members.

Classes

class ModelicaLoggers

Class which can be used to fetch static loggers with different purposes.

Public Member Functions

ModelicaCompiler (OptionRegistry options, String xmlTpl, String xmlValuesTpl, String cTemplatefile)

ModelicaCompiler (OptionRegistry options)

void defaultOptionsFMUME ()

void defaultOptionsFMUCS ()

void defaultOptionsFMUX ()

void defaultTemplatePathsJMU ()

void defaultTemplatePathsFMUME ()

void defaultTemplatePathsFMUCS ()

void defaultTemplatePathsFMUX ()

void setTempFileDir (File temp)

Sets the directory new temporary files are created in.

void setOutDir (File out)

void setSubOutDir (String out)

void setRandomOutDir ()

void deleteOutDir ()

void addCompilationHooks (CompilationHooks hooks)

void removeCompilationHooks (CompilationHooks hooks)

IErrorHandler getErrorHandler ()

void setErrorHandler (IErrorHandler eh)

Set the error handler to use for collection errors.

String getStringOption (String key) throws UnknownOptionException

void setStringOption (String key, String value) throws UnknownOptionException

int getIntegerOption (String key) throws UnknownOptionException

void setIntegerOption (String key, int value) throws UnknownOptionException

double getRealOption (String key) throws UnknownOptionException

void setRealOption (String key, double value) throws UnknownOptionException

boolean getBooleanOption (String key) throws UnknownOptionException

void setBooleanOption (String key, boolean value) throws UnknownOptionException

void setDiagnosticsGenerator (DiagnosticsGenerator diagGenerator)

DiagnosticsGenerator getDiagnosticsGenerator ()

String getOptionDescription (String key) throws UnknownOptionException

String getModelicapath ()

Returns the modelicapath attribute set for this compiler instance.

void setModelicapath (String path)

Set the modelicapath attribute.

String getXMLTpl ()

Returns the XML model description template file path set for this compiler instance.

void setXMLTpl (String template)

Set the XML model description template file path attribute.

String getXMLValuesTpl ()

Returns the XML values template file path set for this compiler instance.

void setXMLValuesTpl (String template)

Set the XML values template file path attribute.

String getCTemplate ()

Returns the c template file path set for this compiler instance.

void setCTemplate (String template)

Set the c template file path attribute.

void compileJMU (String className, String fileName[]) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates a JMU.

void compileJMU (String className, String fileName[], String compileTo) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates a JMU.

void compileJMU (String className, String fileName[], String target, String compileTo) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates a JMU.

void compileFMUME (String className, String fileName[]) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMU for Model Exchange.

void compileFMUCS (String className, String fileName[]) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMU for Co-simulation.

void compileFMUME (String className, String fileName[], String compileTo) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMU for Model Exchange.

void compileFMUCS (String className, String fileName[], String compileTo) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMU for Co-simulation.

void compileFMU (String className, String fileName[], String target, String compileTo) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMU.

void compileFMUX (String className, String fileName[], String compileTo) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMUX.

FClass compileModel (String name[], String cl) throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a Modelica model.

SourceRoot parseModel (String names[]) throws FileNotFoundException, IOException, beaver.Parser.Exception, CompilerException

Parses a set of files and returns a reference to the root of a source tree where the content of all files is contained.

InstClassDecl instantiateModel (SourceRoot sr, String cl) throws ModelicaClassNotFoundException, CompilerException

Computes a model instance tree from a source tree.

FClass createFlatTree (InstClassDecl icl, String flatFile)

Create a flat tree with an empty FClass and return the FClass.

FClass flattenModel (InstClassDecl icl) throws CompilerException, ModelicaClassNotFoundException, IOException

Computes the flattened model representation from a model instance.

void generateCode (FClass fc) throws FileNotFoundException

Generates XML and c code for a flattened model represented as an instance of FClass using template files.

Static Public Member Functions

static CCompilerDelegator getCCompiler ()

static void setCCompiler (CCompilerDelegator cCompiler)

static String getJModelicaHome ()

static void setJModelicaHome (String jmHome)

static void addGlobalCompilationHooks (CompilationHooks hooks)

static void removeGlobalCompilationHooks (CompilationHooks hooks)

static void setLogger (ModelicaLogger log)

Use the specified logger.

static void setDefaultLogger ()

Use the default logger.

static void setStreamLogger (OutputStream stream)

Create and use a logger that logs to a stream.

static void closeStreamLogger ()

Close and disconnect any stream connected to the stream logger.

static void setLogLevel (String level)

Sets logging to the level specified.

static String getLogLevel ()

Returns the log level that is currently set.

static void setLogLevel (ModelicaLogger logger, String level)

Sets logging to the level specified.

static String getLogLevel (ModelicaLogger logger)

Returns the log level that is currently set.

static void setLogLevel (String logger, String level)

Sets logging to the level specified.

static String getLogLevel (String logger)

Returns the log level that is currently set.

static int loggedProcess (String[] cmd, String[] env, File workDir)

Executes the given command as a separate process, writing any output to the logger.

static void main (String[] args)

static String getPlatform ()

Helper function.

Static Public Attributes

static final String DEBUG = "d"

static final String INFO = "i"

static final String WARNING = "w"

static final String ERROR = "e"

static final String INHERITED = "inh"

static final String DEFAULT_LEVEL = ERROR

Protected Member Functions

ModelicaCompiler ()

void recursiveDelete (File dir)

void hookCheckAbort ()

Throws a CompilationAbortedException if any hooks class signals an abort.

void hookFilesParsed (SourceRoot sr)

Calls the hook to be called after the supplied code files are parsed.

void hookModelInstantiatied (InstClassDecl icd)

Calls the hook to be called after the error checks on the instantiated model are finished without errors.

void hookModelFlattened (FClass fc)

Calls the hook to be called after the model is flattened.

void hookModelTransformed (FClass fc)

Calls the hook to be called after transformations are applied to the model.

void hookFlatModelChecked (FClass fc)

Calls the hook to be called after error checks of the flat model are finished without errors.

void hookCodeGeneratorCreated (AbstractGenerator gen)

Calls the hook to be called after a code generator is created.

void hookCodeGenerated (File dir)

Calls the hook to be called after output code is generated.

void hookCodeCompiled ()

Calls the hook to be called after the generated C code is compiled.

void hookFmuPacked (File path)

Calls the hook to be called after the FMU is packed.

void resetCompilationInfo ()

Initilize vars gathering debug information about compilation.

void logCompilationInfo ()

Log debug information about compilation.

void noteUsedMemory ()

Saves away the current amount of memory used.

void dumpMemoryUseFile (ASTNode root, String type) throws FileNotFoundException

Save a dump of the memory use of an AST.

void dumpMemoryUseFile (ASTNode root, String type, String name) throws FileNotFoundException

Save a dump of the memory use of an AST.

void dumpNodeCountFile (String file) throws FileNotFoundException

Save a dump of the number of AST nodes created of each type.

void packUnit (String className, String path, String unitType)

Packs either a JMU or FMU (helper function for compileUnit).

void parseFiles (String[] files)

void zipDir (File dir, ZipOutputStream out)

Write all files in a directory and its subdirectories to a zip stream.

void zipDir (File dir, ZipOutputStream out, File zipDir)

Write all files in a directory and its subdirectories to a zip stream.

String getUnitSuffix (String unitType)

Gets the file suffix for a given unit type.

void handleCompilerProblems (Collection< Problem > problems) throws CompilerException

FClass createFClass (InstClassDecl icd)

Create a new FClass object.

XMLGenerator createXMLGenerator (FClass fc)

Create a new XMLGenerator object.

XMLValueGenerator createXMLValueGenerator (FClass fc)

Create a new XMLValueGenerator object.

CGenerator createCGenerator (FClass fc)

Create a new CGenerator object.

String getXmlTpl (FClass fc)

get the XML template.

String getXmlValuesTpl (FClass fc)

get the XML values template.

String getCTemplatefile (FClass fc)

get the C template.

void setArguments (String compilerName, String[] args, Hashtable< String, String > programarguments) throws JModelicaHomeNotFoundException

void compileModelFromCommandLine (String[] args, Hashtable< String, String > programarguments)

Compile model given in command line options and and print any error messages.

String[] splitFiles (String arg)

Split the argument containing the list of files into an array of filenames.

void handleException (Throwable e, String msg)

Log error message for exception and exit.

void handleException (Throwable e)

Log error message for exception and exit.

Static Protected Member Functions

static File getTemplatesDir ()

static Hashtable< String, String > extractProgramArguments (String[] args, int pos)

Protected Attributes

String xmlTpl = null

String xmlValuesTpl = null

String cTemplatefile = null

LinkedList< CompilationHooks > hooksList = new LinkedList<CompilationHooks>(globalHooksList)

IErrorHandler errorHandler = null

File tempDir = null

File outDir = null

File sourceDir = null

File resourceDir = null

long[] usedMem = new long[NUM_USED_MEMORY_SLOTS]

int numUsedMemFilled

long timeCompilationStarted

Static Protected Attributes

static final String CONSOLE_LOG_NAME = ModelicaCompiler.class.getName() + ".console"

static final String STREAM_LOG_NAME = ModelicaCompiler.class.getName() + ".stream"

static ModelicaLogger log = ModelicaLoggers.getConsoleLogger(CONSOLE_LOG_NAME)

static final HashMap< String,
Level > levels = new HashMap<String, Level>()

static LinkedList
< CompilationHooks > globalHooksList = new LinkedList<CompilationHooks>()

static CCompilerDelegator cCompiler = new GccCompilerDelegator()

static String jmodelicaHome = System.getenv("JMODELICA_HOME")

static final int NUM_USED_MEMORY_SLOTS = 6

Detailed Description

Main compiler class which bundles the tasks needed to compile a Modelica model.

There are two usages with this class:

Compile in one step either from the command line or by calling the static method <compileModel> in your own class.
Split compilation into several steps by calling the static methods in your own class.

Use (1) for a simple and compact way of compiling a Modelica model. As a minimum, provide the modelfile name and class name as command line arguments. Optional arguments are XML template and c template files which are needed for code generation. If any of these are ommitted no code generation will be performed.

Command line example without code generation:
org.jmodelica.applications.ModelicaCompiler myModels/models.mo models.model1

Command line example with code generation:
org.jmodelica.applications.ModelicaCompiler myModels/models.mo models.model1 XMLtemplate1.xml XMLtemplate2.xml cppTemplate.cpp

Logging can be set with the optional argument -log=i, w or e where:

-d : log debug, info, warning and error messages
- -i : log info, warning and error messages
- -w : log warning and error messages (default if the log option is not used)
- -e : log error messages only

Example with log level set to INFO:
org.jmodelica.applications.ModelicaCompiler -i myModels/models.mo models.model1

The logs will be printed to standard out.

For method (2), the compilation steps are divided into 4 tasks which can be used via the methods:

parseModel (source code -> attributed source representation)
instantiateModel (source representation -> instance model)
flattenModel (instance model -> flattened model)
generateCode (flattened model -> c code and XML code)

They must be called in this order. Use provided methods to get/set logging level.

class :0

Constructor & Destructor Documentation

org.jmodelica.modelica.compiler.ModelicaCompiler.ModelicaCompiler	(	OptionRegistry	options,
		String	xmlTpl,
		String	xmlValuesTpl,
		String	cTemplatefile
	)

org.jmodelica.modelica.compiler.ModelicaCompiler.ModelicaCompiler ( OptionRegistry options )

org.jmodelica.modelica.compiler.ModelicaCompiler.ModelicaCompiler ( ) [protected]

Member Function Documentation

void org.jmodelica.modelica.compiler.ModelicaCompiler.addCompilationHooks ( CompilationHooks hooks )

static void org.jmodelica.modelica.compiler.ModelicaCompiler.addGlobalCompilationHooks ( CompilationHooks hooks ) [static]

static void org.jmodelica.modelica.compiler.ModelicaCompiler.closeStreamLogger ( ) [static]

Close and disconnect any stream connected to the stream logger.

void org.jmodelica.modelica.compiler.ModelicaCompiler.compileFMU	(	String	className,
		String	fileName[],
		String	target,
		String	compileTo
	)			throws ModelicaClassNotFoundException, CompilerException, FileNotFoundException, IOException, beaver.Parser.Exception

Compiles a model and creates an FMU.