org.multijava.mjc
Class MJTopLevelMethodDeclaration

java.lang.Object
  org.multijava.util.Utils
      org.multijava.util.compiler.Phylum
          org.multijava.mjc.JPhylum
              org.multijava.mjc.JMemberDeclaration
                  org.multijava.mjc.JMethodDeclaration
                      org.multijava.mjc.MJTopLevelMethodDeclaration

All Implemented Interfaces:

Annotatable, Cloneable, Comparable, Constants, Constants, JMemberDeclarationType, JMethodDeclarationType, MJTopLevelDeclaration, PhylumType

Direct Known Subclasses:

MJTopLevelAbstractMethodDeclaration

public class MJTopLevelMethodDeclaration

extends JMethodDeclaration

implements MJTopLevelDeclaration, Cloneable

Field Summary
private  CType	openClassType           The class that this method extends
private  CType	receiverStaticType           The static type of this method's receiver, i.e., the receiver type of the top method of this generic function

 

Fields inherited from class org.multijava.mjc.JMethodDeclaration

typevariables

 

Fields inherited from class org.multijava.mjc.JMemberDeclaration

 

Fields inherited from class org.multijava.mjc.JPhylum

EMPTY

 

Fields inherited from class org.multijava.util.compiler.Phylum

 

Fields inherited from class org.multijava.util.Utils

DBG_LEVEL_HIGH, DBG_LEVEL_LOW, DBG_LEVEL_NO

 

Fields inherited from interface org.multijava.mjc.Constants

ACC_MODIFIER_FLAGS_MASK, ACC_NON_NULL, ACC_NON_NULL_BY_DEFAULT, ACC_NULLABLE, ACC_NULLABLE_BY_DEFAULT, ACC_PURE, ACCESS_FLAG_ARRAY, ACCESS_FLAG_NAMES, AMID_JAVA_MATH, AMID_MAX, AMID_SAFE_MATH, CMP_VERSION, IMPLICITLY_NON_NULL, JAV_ASSERTION_ERROR, JAV_CLASS, JAV_CLASSLOADER, JAV_CLASSNOTFOUND_EXCEPTION, JAV_CLONE, JAV_CLONEABLE, JAV_CONSTRUCTOR, JAV_ERROR, JAV_EXCEPTION, JAV_INIT, JAV_LENGTH, JAV_NAME_SEPARATOR, JAV_NOCLASSDEFFOUND_ERROR, JAV_OBJECT, JAV_OUTER_THIS, JAV_RMJ_RUNTIME_EXCEPTION, JAV_RUNTIME, JAV_RUNTIME_EXCEPTION, JAV_SERIALIZABLE, JAV_STATIC_INIT, JAV_STRING, JAV_STRINGBUFFER, JAV_SUPER, JAV_THIS, JAV_THROWABLE, MJ_ANCHOR, NULLITY_MODS, OPE_BAND, OPE_BNOT, OPE_BOR, OPE_BSR, OPE_BXOR, OPE_EQ, OPE_GE, OPE_GT, OPE_LAND, OPE_LE, OPE_LNOT, OPE_LOR, OPE_LT, OPE_MINUS, OPE_NE, OPE_PERCENT, OPE_PLUS, OPE_POSTDEC, OPE_POSTINC, OPE_PREDEC, OPE_PREINC, OPE_SIMPLE, OPE_SL, OPE_SLASH, OPE_SR, OPE_STAR, TID_ARRAY, TID_BOOLEAN, TID_BYTE, TID_CHAR, TID_CLASS, TID_DOUBLE, TID_FLOAT, TID_INT, TID_LONG, TID_MAX, TID_SHORT, TID_VOID, UNIV_ARRAY_TMP, UNIV_TMP

 

Fields inherited from interface org.multijava.util.classfile.Constants

ACC_ABSTRACT, ACC_FINAL, ACC_INTERFACE, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VOLATILE, ATT_ANCHOR, ATT_BRIDGE, ATT_CODE, ATT_CONSTANTVALUE, ATT_DEPRECATED, ATT_DISPATCHER, ATT_EXCEPTIONS, ATT_GENERIC, ATT_GENERIC_FUNCTIONS, ATT_INNERCLASSES, ATT_LINENUMBERTABLE, ATT_LOCALVARIABLETABLE, ATT_MM_BODY, ATT_REDIRECTOR, ATT_RMJ_GLUE, ATT_RMJ_SIGNATURE, ATT_RUNTIME_VISIBLE_ANNOTATIONS, ATT_RUNTIME_VISIBLE_PARAMETER_ANNOTATIONS, ATT_SIGNATURE, ATT_SOURCEFILE, ATT_SYNTHETIC, ATT_UNIVERSE_FIELD, ATT_UNIVERSE_METHOD, ATT_UNIVERSE_VERSION, CST_CLASS, CST_DOUBLE, CST_FIELD, CST_FLOAT, CST_INTEGER, CST_INTERFACEMETHOD, CST_LONG, CST_METHOD, CST_NAMEANDTYPE, CST_STRING, CST_UTF8, ENV_DEBUG_MODE, ENV_USE_CACHE, JAVA_MAGIC, JAVA_MAJOR, JAVA_MINOR, MAX_CODE_PER_METHOD, opc_aaload, opc_aastore, opc_aconst_null, opc_aload, opc_aload_0, opc_aload_1, opc_aload_2, opc_aload_3, opc_anewarray, opc_areturn, opc_arraylength, opc_astore, opc_astore_0, opc_astore_1, opc_astore_2, opc_astore_3, opc_athrow, opc_baload, opc_bastore, opc_bipush, opc_caload, opc_castore, opc_checkcast, opc_d2f, opc_d2i, opc_d2l, opc_dadd, opc_daload, opc_dastore, opc_dcmpg, opc_dcmpl, opc_dconst_0, opc_dconst_1, opc_ddiv, opc_dload, opc_dload_0, opc_dload_1, opc_dload_2, opc_dload_3, opc_dmul, opc_dneg, opc_drem, opc_dreturn, opc_dstore, opc_dstore_0, opc_dstore_1, opc_dstore_2, opc_dstore_3, opc_dsub, opc_dup, opc_dup2, opc_dup2_x1, opc_dup2_x2, opc_dup_x1, opc_dup_x2, opc_f2d, opc_f2i, opc_f2l, opc_fadd, opc_faload, opc_fastore, opc_fcmpg, opc_fcmpl, opc_fconst_0, opc_fconst_1, opc_fconst_2, opc_fdiv, opc_fload, opc_fload_0, opc_fload_1, opc_fload_2, opc_fload_3, opc_fmul, opc_fneg, opc_frem, opc_freturn, opc_fstore, opc_fstore_0, opc_fstore_1, opc_fstore_2, opc_fstore_3, opc_fsub, opc_getfield, opc_getstatic, opc_goto, opc_goto_w, opc_i2b, opc_i2c, opc_i2d, opc_i2f, opc_i2l, opc_i2s, opc_iadd, opc_iaload, opc_iand, opc_iastore, opc_iconst_0, opc_iconst_1, opc_iconst_2, opc_iconst_3, opc_iconst_4, opc_iconst_5, opc_iconst_m1, opc_idiv, opc_if_acmpeq, opc_if_acmpne, opc_if_icmpeq, opc_if_icmpge, opc_if_icmpgt, opc_if_icmple, opc_if_icmplt, opc_if_icmpne, opc_ifeq, opc_ifge, opc_ifgt, opc_ifle, opc_iflt, opc_ifne, opc_ifnonnull, opc_ifnull, opc_iinc, opc_iload, opc_iload_0, opc_iload_1, opc_iload_2, opc_iload_3, opc_imul, opc_ineg, opc_instanceof, opc_invokeinterface, opc_invokespecial, opc_invokestatic, opc_invokevirtual, opc_ior, opc_irem, opc_ireturn, opc_ishl, opc_ishr, opc_istore, opc_istore_0, opc_istore_1, opc_istore_2, opc_istore_3, opc_isub, opc_iushr, opc_ixor, opc_jsr, opc_jsr_w, opc_l2d, opc_l2f, opc_l2i, opc_ladd, opc_laload, opc_land, opc_lastore, opc_lcmp, opc_lconst_0, opc_lconst_1, opc_ldc, opc_ldc2_w, opc_ldc_w, opc_ldiv, opc_lload, opc_lload_0, opc_lload_1, opc_lload_2, opc_lload_3, opc_lmul, opc_lneg, opc_lookupswitch, opc_lor, opc_lrem, opc_lreturn, opc_lshl, opc_lshr, opc_lstore, opc_lstore_0, opc_lstore_1, opc_lstore_2, opc_lstore_3, opc_lsub, opc_lushr, opc_lxor, opc_monitorenter, opc_monitorexit, opc_multianewarray, opc_new, opc_newarray, opc_nop, opc_pop, opc_pop2, opc_putfield, opc_putstatic, opc_ret, opc_return, opc_saload, opc_sastore, opc_sipush, opc_swap, opc_tableswitch, opc_wide, opc_xxxunusedxxx, POO_ASCII_CONSTANT, POO_CLASS_CONSTANT, POO_DOUBLE_CONSTANT, POO_FLOAT_CONSTANT, POO_INTEGER_CONSTANT, POO_LONG_CONSTANT, POO_NAT_CONSTANT, POO_REF_CONSTANT, POO_STRING_CONSTANT, TYP_ADDRESS, TYP_DOUBLE, TYP_FLOAT, TYP_INT, TYP_LONG, TYP_REFERENCE, TYP_VOID

 

Constructor Summary

MJTopLevelMethodDeclaration(TokenReference where, long modifiers, CTypeVariable[] typevariables, CType returnType, CType openClassType, String ident, JFormalParameter[] parameters, CClassType[] exceptions, JBlock body, JavadocComment javadoc, JavaStyleComment[] comments)           This class represents a MultiJava external method in the syntax tree Construct a node in the parsing tree This method is directly called by the parser

 

Method Summary
void	accept(MjcVisitor p)           Accepts the specified visitor
CMember	checkInterface(CContextType context)           Checks the basic interfaces to make sure things generally look OK.
Object	clone()           Creates a shallow copy of this.
int	compareTo(Object o)           Compares this method to a given method and returns 0 if the methods belong to the same generic function, otherwise returns -1 or +1 to sort the methods.
CExtendedCompilationUnitContext	createExtendedCompilationUnitContext(CContextType parent, CTypeVariable[] typevariables)
void	genCode(CodeSequence code)           Generates a sequence of bytecodes
CType	getOpenClassType()           Returns the type that this open member extends
boolean	isExternal()           Indicates that this member is external.
CType	receiverStaticType()           Returns the static type of this method's receiver, i.e., the receiver type of the top method of this generic function.
protected  void	registerPendingGFCollection(String packageName)           Registers with the compilation session that an external generic function to which this top-level method will belong is being compiled.
boolean	usesMultipleDispatch()           Indicates whether this method uses multiple dispatch

 

Methods inherited from class org.multijava.mjc.JMethodDeclaration

addBridge, addParameter, body, checkInterfaceType, checkOverriding, createExtendedClassContext, createSelfContext, getExceptions, hasBody, ident, isDeclaredNonNull, isOverriding, makeMemberAccess, makeMethodSignature, modifiers, noBodyOK, overriddenMethods, parameters, resolveExtMethods, resolveSpecializers, resolveTopMethods, returnType, setBody, setIdent, setModifiers, setNonNull, setParameters, toString, typecheck, typevariables

 

Methods inherited from class org.multijava.mjc.JMemberDeclaration

genComments, getCClass, getField, getMethod, isDeprecated, javadocComment, setInterface

 

Methods inherited from class org.multijava.mjc.JPhylum

check, check, check, check, fail, fail, fail, warn, warn, warn, warn

 

Methods inherited from class org.multijava.util.compiler.Phylum

getTokenReference, setTokenReference

 

Methods inherited from class org.multijava.util.Utils

assertTrue, assertTrue, combineArrays, escapeString, escapeString, fail, fail, getFilePath, hasFlag, hasOtherFlags, parsePathParts, relativePathTo, splitQualifiedName, splitQualifiedName, stripJavaModifiers, stripNonJavaModifiers, stripPrivateModifier, unescapeString, vectorToArray, vectorToIntArray

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface org.multijava.mjc.JMemberDeclarationType

genComments, getCClass, getField, getMethod, isDeprecated

 

Methods inherited from interface org.multijava.util.compiler.PhylumType

getTokenReference, setTokenReference

 

Methods inherited from interface org.multijava.javadoc.Annotatable

javadocComment

 

Field Detail

openClassType

private CType openClassType

The class that this method extends

receiverStaticType

private CType receiverStaticType

The static type of this method's receiver, i.e., the receiver type of the top method of this generic function

MJTopLevelMethodDeclaration

public MJTopLevelMethodDeclaration(TokenReference where,
                                   long modifiers,
                                   CTypeVariable[] typevariables,
                                   CType returnType,
                                   CType openClassType,
                                   String ident,
                                   JFormalParameter[] parameters,
                                   CClassType[] exceptions,
                                   JBlock body,
                                   JavadocComment javadoc,
                                   JavaStyleComment[] comments)

This class represents a MultiJava external method in the syntax tree Construct a node in the parsing tree This method is directly called by the parser

Parameters:

where - the line of this node in the source code

modifiers - list of modifiers

returnType - the return type of this method

openClassType - the class that this method extends

ident - the name of this method

parameters - the parameters of this method

exceptions - the exceptions throw by this method

body - the body of this method

javadoc - javadoc comments, including deprecated flag

comments - non-javadoc comments

registerPendingGFCollection

protected void registerPendingGFCollection(String packageName)

Registers with the compilation session that an external generic function to which this top-level method will belong is being compiled. This registration occurs during the parsing pass.

 requires packageName != null && 
		(* any separators in packageName are 
             slashes ('/') not dots ('.') *);
 

getOpenClassType

public CType getOpenClassType()

Description copied from interface: MJTopLevelDeclaration

Returns the type that this open member extends

Specified by:

getOpenClassType in interface MJTopLevelDeclaration

Returns:

a class representing the type extended by this open member

receiverStaticType

public CType receiverStaticType()

Returns the static type of this method's receiver, i.e., the receiver type of the top method of this generic function.

Returns:

the static type of this method's receiver

isExternal

public boolean isExternal()

Indicates that this member is external.

Specified by:

isExternal in interface MJTopLevelDeclaration

Overrides:

isExternal in class JMethodDeclaration

Returns:

true

usesMultipleDispatch

public boolean usesMultipleDispatch()

Indicates whether this method uses multiple dispatch

Specified by:

usesMultipleDispatch in interface JMethodDeclarationType

Overrides:

usesMultipleDispatch in class JMethodDeclaration

Returns:

true iff a parameter of this method has a dynamic dispatch annotation or, for an external method, this methods receiver is of a different type than the generic function's top method

compareTo

public int compareTo(Object o)
              throws ClassCastException

Compares this method to a given method and returns 0 if the methods belong to the same generic function, otherwise returns -1 or +1 to sort the methods. This comparator is used to separate methods by generic function in the MJGenericFunctionDispatcher class.

Specified by:

compareTo in interface JMethodDeclarationType

Overrides:

compareTo in class JMethodDeclaration

Parameters:

o - the object to be compared against, must be a JMethodDeclarationType

Returns:

-1, +1, or 0

Throws:

ClassCastException - if o is not an instance of CType

clone

public Object clone()
             throws CloneNotSupportedException

Creates a shallow copy of this.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

checkInterface

public CMember checkInterface(CContextType context)
                       throws PositionedError

Checks the basic interfaces to make sure things generally look OK. This pass gathers information about the type signatures of everything (imported class files, classes being compiled, methods, fields, etc...) needed for the later passes. This information is stored in a context hierarchy that is bound to the AST.

Specified by:

checkInterface in interface MJTopLevelDeclaration

Overrides:

checkInterface in class JMethodDeclaration

Parameters:

context - the context in which this method appears

Returns:

a representation of the interface and body of this method (iff no errors are detected)

Throws:

PositionedError - if any checks fail

createExtendedCompilationUnitContext

public CExtendedCompilationUnitContext createExtendedCompilationUnitContext(CContextType parent,
                                                                            CTypeVariable[] typevariables)

accept

public void accept(MjcVisitor p)

Accepts the specified visitor

Specified by:

accept in interface MJTopLevelDeclaration

Overrides:

accept in class JMethodDeclaration

Parameters:

p - the visitor

genCode

public void genCode(CodeSequence code)

Generates a sequence of bytecodes

Overrides:

genCode in class JMethodDeclaration

Parameters:

code - the code list