Package ptolemy.cg.kernel.generic.syntactic

Class SyntacticCodeGenerator

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.cg.kernel.generic.GenericCodeGenerator

ptolemy.cg.kernel.generic.syntactic.SyntacticCodeGenerator

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Decorator, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class SyntacticCodeGenerator
extends GenericCodeGenerator

Generate a syntactic representation of a ptolemy model.

To generate a syntactic representation, use:

     java -classpath $PTII ptolemy.cg.kernel.generic.syntactic.SyntacticCodeGenerator
  

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Chris Shaver

Pt.AcceptedRating:

red

Pt.ProposedRating:

red (shaver)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.cg.kernel.generic.GenericCodeGenerator

_codeFileName, _eol, _executeCommands, _generateInSubdirectory, _model, _sanitizedModelName, codeDirectory, generateInSubdirectory, generatorPackage, generatorPackageList, INDENT1, INDENT2, INDENT3, overwriteFiles

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor	Description
SyntacticCodeGenerator(NamedObj container, java.lang.String name)	Create a new instance of the SyntacticCodeGenerator.

Method Summary

Modifier and Type	Method	Description
protected int	_generateCode(java.lang.StringBuffer code)	Generate a syntactic representation and append it to the given string buffer.
protected java.lang.Class<?>	_getAdapterClassFilter()	Return the filter class to find adapters.
protected void	_showGraph()	Show the SyntacticGraph in a Tableau.
java.lang.String	comment(java.lang.String comment)	Format a string as a code comment.

Methods inherited from class ptolemy.cg.kernel.generic.GenericCodeGenerator

_copyCFilesTosrc, _copyCFileTosrc, _executeCommands, _getAdapter, _getAutoGeneratedAdapter, _getOutputFilename, _instantiateAdapter, _isTopLevel, _printTimeAndMemory, _reset, _resetAll, _writeCode, _writeCodeFileName, attributeChanged, clone, createDecoratorAttributes, decoratedObjects, generateCode, generateCode, generateCode, generateCopyright, getAdapter, getCodeFileName, getComponent, getExecuteCommands, getMethodExceptionString, getMethodVisibilityString, isGlobalDecorator, main, setCodeGenerator, setContainer, setExecuteCommands, updateCommandOptions

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Constructor Detail

SyntacticCodeGenerator

public SyntacticCodeGenerator(NamedObj container,
                              java.lang.String name)
                       throws IllegalActionException,
                              NameDuplicationException

Create a new instance of the SyntacticCodeGenerator. The value of the generatorPackageList parameter of the base class is set to generic.syntactic

Parameters:

container - The container.

name - The name of the SyntacticCodeGenerator.

Throws:

IllegalActionException - If the super class throws the exception or error occurs when setting the file path.

NameDuplicationException - If the super class throws the exception or an error occurs when setting the file path.

Method Detail

comment

public java.lang.String comment(java.lang.String comment)

Format a string as a code comment. This format is specific to the grammar of the generated syntax. Inheriting classes should override this function for the appropriate conventions of the syntax.

Overrides:

comment in class GenericCodeGenerator

Parameters:

comment - The string to format as a comment.

Returns:

A formatted comment.

_generateCode

protected int _generateCode(java.lang.StringBuffer code)
                     throws KernelException

Generate a syntactic representation 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.syntactic, then the file that is written will be $HOME/Foo.html This method is the main entry point to generate code.

Overrides:

_generateCode in class GenericCodeGenerator

Parameters:

code - The given string buffer.

Returns:

The return value of the last subprocess that was executed. or -1 if no commands were executed.

Throws:

KernelException - If the target file cannot be overwritten or write-to-file throw any exception.

_getAdapterClassFilter

protected java.lang.Class<?> _getAdapterClassFilter()

Return the filter class to find adapters. All adapters have to extend this class.

Overrides:

_getAdapterClassFilter in class GenericCodeGenerator

Returns:

The base class for the adapters.

_showGraph

protected void _showGraph()
                   throws IllegalActionException

Show the SyntacticGraph in a Tableau.

Throws:

IllegalActionException - Thrown if there is a problem getting the configuration, opening the instance of the syntactic graph or showing the tableau.