cetus.hir

Class PreAnnotation

java.lang.Object

cetus.hir.Declaration

cetus.hir.PreAnnotation

All Implemented Interfaces:

Annotatable, Printable, Traversable, java.lang.Cloneable

public class PreAnnotation
extends Declaration

Represents a text annotation (comment or pragma) or a list of keyed values. Internally, an annotation is a single string or a map of keys to values. There is no restriction on the type or content of the keys and values. Compiler passes are free to use annotations as they see fit, although annotations used by multiple passes should be well-documented. By default, annotations are printed as a multi-line comment. They can also be printed as pragmas. If the text value of the annotation has been set, the text is printed, otherwise the list of keyed values is printed. As of version 1.1 (July, 2009), PreAnnotation is used only internally. Pass writers should use Annotatable interface instead.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.reflect.Method	print_as_comment_method Useful for passing to setPrintMethod or setClassPrintMethod.
static java.lang.reflect.Method	print_as_pragma_method Useful for passing to setPrintMethod or setClassPrintMethod.
static java.lang.reflect.Method	print_raw_method Useful for passing to setPrintMethod or setClassPrintMethod.

Constructor Summary

Constructors

Constructor and Description
PreAnnotation() Creates an empty annotation.
PreAnnotation(java.lang.String text) Creates a text annotation.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.Object key, java.lang.Object value)
static void	defaultPrint(PreAnnotation a, java.io.PrintWriter o) Prints an annotation to a stream.
boolean	equals(java.lang.Object o) Checks if the declaration is equal to the given object.
java.util.List<IDExpression>	getDeclaredIDs() Returns a list of name ID introduced by this declaration.
java.util.Map	getMap() Provides access to the annotation map.
java.lang.String	getText()
int	hashCode() Returns the hash code of the declaration.
static void	printAsComment(PreAnnotation a, java.io.PrintWriter o) Prints an annotation as a multi-line comment.
static void	printAsPragma(PreAnnotation a, java.io.PrintWriter o) Prints an annotation as a single-line pragma.
static void	printRaw(PreAnnotation a, java.io.PrintWriter o) Prints an annotation's contents without enclosing them in comments.
void	setChild(int index, Traversable t) Unsupported - this object has no children.
static void	setClassPrintMethod(java.lang.reflect.Method m) Overrides the class print method, so that all subsequently created objects will use the supplied method.
void	setText(java.lang.String text) Sets the text of the annotation.

Methods inherited from class cetus.hir.Declaration

annotate, annotateAfter, annotateBefore, clone, containsAnnotation, detach, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getChildren, getParent, print, removeAnnotations, removeAnnotations, removeChild, setParent, setPrintMethod, setSemiColon, toString, verify

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

print_as_comment_method

public static final java.lang.reflect.Method print_as_comment_method

Useful for passing to setPrintMethod or setClassPrintMethod.

print_as_pragma_method

public static final java.lang.reflect.Method print_as_pragma_method

Useful for passing to setPrintMethod or setClassPrintMethod.

print_raw_method

public static final java.lang.reflect.Method print_raw_method

Useful for passing to setPrintMethod or setClassPrintMethod.

Constructor Detail

PreAnnotation

public PreAnnotation()

Creates an empty annotation.

PreAnnotation

public PreAnnotation(java.lang.String text)

Creates a text annotation.

Parameters:

text - The text to be used as a comment or pragma.

Method Detail

add

public void add(java.lang.Object key,
       java.lang.Object value)

defaultPrint

public static void defaultPrint(PreAnnotation a,
                java.io.PrintWriter o)

Prints an annotation to a stream.

Parameters:

a - The annotation to print.

o - The writer on which to print the annotation.

equals

public boolean equals(java.lang.Object o)

Description copied from class: Declaration

Checks if the declaration is equal to the given object.

Overrides:

equals in class Declaration

Parameters:

o - the object to be compared.

Returns:

true if o == this.

getDeclaredIDs

public java.util.List<IDExpression> getDeclaredIDs()

Description copied from class: Declaration

Returns a list of name ID introduced by this declaration.

Specified by:

getDeclaredIDs in class Declaration

Returns:

a list of IDExpressions. The list will not be null but may be empty.

getMap

public java.util.Map getMap()

Provides access to the annotation map.

getText

public java.lang.String getText()

hashCode

public int hashCode()

Description copied from class: Declaration

Returns the hash code of the declaration. It returns the identity hash code of the declaration.

Overrides:

hashCode in class Declaration

Returns:

the identity hash code of the declaration.

printAsComment

public static void printAsComment(PreAnnotation a,
                  java.io.PrintWriter o)

Prints an annotation as a multi-line comment.

Parameters:

a - The annotation to print.

o - The writer on which to print the annotation.

printAsPragma

public static void printAsPragma(PreAnnotation a,
                 java.io.PrintWriter o)

Prints an annotation as a single-line pragma.

Parameters:

a - The annotation to print.

o - The writer on which to print the annotation.

printRaw

public static void printRaw(PreAnnotation a,
            java.io.PrintWriter o)

Prints an annotation's contents without enclosing them in comments.

Parameters:

a - The annotation to print.

o - The writer on which to print the annotation.

setChild

public void setChild(int index,
            Traversable t)

Unsupported - this object has no children.

Specified by:

setChild in interface Traversable

Overrides:

setChild in class Declaration

setClassPrintMethod

public static void setClassPrintMethod(java.lang.reflect.Method m)

Overrides the class print method, so that all subsequently created objects will use the supplied method.

Parameters:

m - The new print method.

setText

public void setText(java.lang.String text)

Sets the text of the annotation.

Parameters:

text - The text to be used as a comment or pragma.