To generate an FMIMA version of a model, use: *
$PTII/bin/ptcg -generatorPackage ptolemy.cg.kernel.generic.program.procedural.fmima \
-generatorPackagelist generic.program.procedural.fmima \
$PTII/ptolemy/cg/kernel/generic/program/procedural/fmima/test/auto/FMUIncScale20RC1pt.xml
*
* @author Christopher Brooks
* @version $Id: FMIMACodeGenerator.java 70402 2014-10-23 00:52:20Z cxh $
* @since Ptolemy II 10.0
* @Pt.ProposedRating red (cxh)
* @Pt.AcceptedRating red (cxh)
*/
public class FMIMACodeGenerator extends ProceduralCodeGenerator /*GenericCodeGenerator*/{
/** Create a new instance of the FMIMACodeGenerator.
* The value of the generatorPackageList parameter of the
* base class is set to generic.program.procedural.fmima
* @param container The container.
* @param name The name of the FMIMACodeGenerator.
* @exception IllegalActionException If the super class throws the
* exception or error occurs when setting the file path.
* @exception NameDuplicationException If the super class throws the
* exception or an error occurs when setting the file path.
*/
public FMIMACodeGenerator(NamedObj container, String name)
throws IllegalActionException, NameDuplicationException {
//super(container, name, "c");
super(container, name, "c", "c");
generatorPackageList.setExpression("generic.program.procedural.fmima");
}
/** Return a formatted comment containing the specified string. In
* this base class, the comments is a C-style comment, which
* begins with "/ *" and ends with "* /" followed by the platform
* dependent end of line character(s): under Unix: backslash n, under
* Windows: backslash n backslash r. Subclasses may override this produce comments
* that match the code generation language.
* @param comment The string to put in the comment.
* @return A formatted comment.
*/
@Override
public String comment(String comment) {
return "/" + "* " + comment + " *" + "/" + _eol;
}
/** Generate the main entry point.
* @return Return the definition of the main entry point for a program.
* In C, this would be defining main().
* @exception IllegalActionException Not thrown in this base class.
*/
@Override
public String generateMainEntryCode() throws IllegalActionException {
StringBuffer code = new StringBuffer();
code.append(comment("ptolemy/cg/kernel/generic/program/procedural/fmima/FMIMACodeGenerator.java"));
code.append(comment("Probably the thing to do is to create .c files and copy them over to the cg/ directory."));
code.append(comment("Then we can create a few functions that do the real work."));
if (_isTopLevel()) {
code.append(_eol + _eol + "int main(int argc, char *argv[]) {"
+ _eol);
code.append(((FMIMACodeGeneratorAdapter) getAdapter(toplevel()))
.generateFMIMA());
code.append(_eol + "return 0;" + _eol + "}");
}
return code.toString();
}
///////////////////////////////////////////////////////////////////
//// protected methods ////
/** Generate FMIMA and append it to the given string buffer.
* Write the code to the directory specified by the codeDirectory
* parameter. The file name is a sanitized version of the model
* name with a suffix that is based on last package name of the
* generatorPackage parameter. Thus if the
* codeDirectory is $HOME, the name of the
* model is Foo and the generatorPackage
* is ptolemy.cg.kernel.generic.program.procedural.fmima, then the file that is
* written will be $HOME/Foo.html
* This method is the main entry point to generate fmima
*
* @param code The given string buffer.
* @return The return value of the last subprocess that was executed.
* or -1 if no commands were executed.
* @exception KernelException If the target file cannot be overwritten
* or write-to-file throw any exception.
*/
@Override
protected int _generateCode(StringBuffer code) throws KernelException {
// Hint: Look at ptolemy/cg/kernel/generic/program/procedural/c/CCodeGenerator.java
code.append(comment("Generated from ptolemy/cg/kernel/generic/program/procedural/fmima/FMIMACodeGenerator.java _generateCode"));
// Copy the .c and .h files from $PTII/ptolemy/actor/lib/fmi/ma.
String directory = codeDirectory.stringValue();
if (!directory.endsWith("/")) {
directory += "/";
}
String directoryFmi = directory + "fmi/";
if (new File(directoryFmi).mkdirs()) {
if (!_includes.contains("-I " + directoryFmi)) {
_includes.add("-I " + directoryFmi);
}
}
String directoryFmiShared = directoryFmi + "shared/";
if (new File(directoryFmiShared).mkdirs()) {
if (!_includes.contains("-I " + directoryFmiShared)) {
_includes.add("-I " + directoryFmiShared);
}
}
_copyCFileTosrc("ptolemy/actor/lib/fmi/ma/shared/", directoryFmiShared,
"sim_support.c");
_copyCFileTosrc("ptolemy/actor/lib/fmi/ma/shared/", directoryFmiShared,
"sim_support.h");
String directoryFmiIncludes = directoryFmi + "includes/";
if (new File(directoryFmiIncludes).mkdirs()) {
if (!_includes.contains("-I " + directoryFmiIncludes)) {
_includes.add("-I " + directoryFmiIncludes);
}
}
_copyCFilesTosrc("ptolemy/actor/lib/fmi/ma/includes/",
directoryFmiIncludes, new String[] { "fmi.h",
"fmiFunctionTypes.h", "fmiFunctions.h",
"fmiTypesPlatform.h" });
String directoryFmiParser = directoryFmi + "parser/";
if (new File(directoryFmiParser).mkdirs()) {
if (!_includes.contains("-I " + directoryFmiParser)) {
_includes.add("-I " + directoryFmiParser);
}
}
_copyCFilesTosrc(
"ptolemy/actor/lib/fmi/ma/parser/",
directoryFmiParser,
new String[] { "XmlElement.cpp", "XmlElement.h",
"XmlParserCApi.cpp", "XmlParserCApi.h",
"XmlParser.cpp", "XmlParserException.h", "XmlParser.h" });
String directoryFmiParserLibxml = directoryFmi + "parser/libxml/";
if (new File(directoryFmiParserLibxml).mkdirs()) {
if (!_includes.contains("-I " + directoryFmiParserLibxml)) {
_includes.add("-I " + directoryFmiParserLibxml);
}
}
_copyCFilesTosrc("ptolemy/actor/lib/fmi/ma/parser/libxml/",
directoryFmiParserLibxml, new String[] { "dict.h",
"encoding.h", "entities.h", "globals.h", "hash.h",
"list.h", "parser.h", "relaxng.h", "SAX2.h", "SAX.h",
"threads.h", "tree.h", "valid.h", "xlink.h",
"xmlautomata.h", "xmlerror.h", "xmlexports.h",
"xmlIO.h", "xmlmemory.h", "xmlreader.h", "xmlregexp.h",
"xmlschemas.h", "xmlstring.h", "xmlversion.h" });
if (_executeCommands == null) {
_executeCommands = new StreamExec();
}
// Writing the Makefile
CompositeActor container = (CompositeActor) getContainer();
_writeMakefile(container, directory);
// Hopefully, we can skip the XML parsing because we have
// already parsed the modelDescription.xml file.
return super._generateCode(code);
}
/** Return the filter class to find adapters. All
* adapters have to extend this class.
* @return The base class for the adapters.
*/
@Override
protected Class _getAdapterClassFilter() {
return FMIMACodeGeneratorAdapter.class;
}
/** Read in a template makefile, substitute variables and write
* the resulting makefile.
*
* See {@link ptolemy.cg.kernel.generic.program.procedural.ProceduralCodeGenerator#_writeMakefile(CompositeEntity, String)} * for a complete list of variables that are substituted.
*In this class, the following variables are substituted *
@PTCGPPCompiler@
* @PTCGCompler@
*