Package ptolemy.cg.kernel.generic.syntactic

Class SyntacticCodeGeneratorAdapter

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.cg.kernel.generic.CodeGeneratorAdapter

ptolemy.cg.kernel.generic.syntactic.SyntacticCodeGeneratorAdapter

All Implemented Interfaces:

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

public abstract class SyntacticCodeGeneratorAdapter
extends CodeGeneratorAdapter

Base class for a syntactic representation generator adapter.

Subclasses should override generateSyntax().

Subclasses should be sure to properly indent the code by either using the code block functionality in methods like _generateBlockCode(String) or by calling CodeStream.indent(String), for example:

     StringBuffer code = new StringBuffer();
     code.append(super.generateWrapupCode());
     code.append("// Local wrapup code");
     return processCode(CodeStream.indent(code.toString()));
 

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Bert Rodiers, 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

Modifier and Type	Field	Description
protected GenericCodeGenerator	_codeGenerator	The code generator that contains this adapter class.
protected static java.lang.String	_eol	End of line character.

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
SyntacticCodeGeneratorAdapter(NamedObj component)	Construct the code generator adapter associated with the given component.

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	generateSyntax()	Generate syntactic representation code.
GenericCodeGenerator	getCodeGenerator()	Get the code generator associated with this adapter class.
NamedObj	getComponent()	Get the component associated with this adapter.
void	setCodeGenerator(GenericCodeGenerator codeGenerator)	Set the code generator associated with this adapter class.

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

createDecoratorAttributes, generateName

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

Field Detail

_eol

protected static final java.lang.String _eol

End of line character. Under Unix: "\n", under Windows: "\n\r". We use a end of line character so that the files we generate have the proper end of line character for use by other native tools.

_codeGenerator

protected GenericCodeGenerator _codeGenerator

The code generator that contains this adapter class.

Constructor Detail

SyntacticCodeGeneratorAdapter

public SyntacticCodeGeneratorAdapter(NamedObj component)

Construct the code generator adapter associated with the given component.

Parameters:

component - The associated component.

Method Detail

generateSyntax

public abstract java.lang.String generateSyntax()
                                         throws IllegalActionException

Generate syntactic representation code.

Returns:

The generated syntax.

Throws:

IllegalActionException - If there is a problem reading data from the model while generating HTML.

getCodeGenerator

public GenericCodeGenerator getCodeGenerator()

Get the code generator associated with this adapter class.

Specified by:

getCodeGenerator in class CodeGeneratorAdapter

Returns:

The code generator associated with this adapter class.

See Also:

setCodeGenerator(GenericCodeGenerator)

getComponent

public NamedObj getComponent()

Get the component associated with this adapter.

Returns:

The associated component.

setCodeGenerator

public void setCodeGenerator(GenericCodeGenerator codeGenerator)

Set the code generator associated with this adapter class.

Specified by:

setCodeGenerator in class CodeGeneratorAdapter

Parameters:

codeGenerator - The code generator associated with this adapter class.

See Also:

getCodeGenerator()