Package eu.bandm.tools.umod

Class UMod2visitors

java.lang.Object

eu.bandm.tools.umod.UMod2visitors

public class UMod2visitors
extends Object

Collection of methods for generating visitor code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	UMod2visitors.Lr_decoder
protected static enum	UMod2visitors.rewriterType
protected class	UMod2visitors.V_compileMatchCascade
protected class	UMod2visitors.V_compileSimpleActionMethods
protected class	UMod2visitors.V_makeDescend	Deprecated.
protected class	UMod2visitors.V_makeRewriterCoRewriter	Is created and called for toplevel classes, and then created anew for all sub-classes!
protected class	UMod2visitors.V_makeVDescend	Returns in "result" a Format which represents the descending code.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Integer>	allFields2codeNumber_DATA
protected final boolean	allrewriterwarnings
protected final Set<Integer>	allVisitorNums
protected final Set<Integer>	allVisitorNums_classDefs
protected final Set<Integer>	allVisitorNums_visitorDefs
protected static final GeneratedAnnotation	ANNOTATION_SUPPRESS_UNCHECKED
protected GeneratedClass	basematcher	The topmost generated visitor, one per umod model.
protected final GeneratedContext	context
static final int	descend_all_branches_case	Pseudo visitor register number for the case when NO LR-code is provided for a particular field, which means: ALL sub-expressions are visited.
protected static final String	FIELDNAME__class2reachedSccs
protected static final String	FIELDNAME__class2scc	The generated "scc data transmission code" will write into these fields.
protected static final String	FIELDNAME__field2sccs
protected static final String	FIELDNAME_lowestGeneratedVisitorClass
protected static final String	FIELDNAME_VISITOR_DEBUG_STREAM
protected static final String	METHODNAME__class2reachedSccs
protected static final String	METHODNAME__class2scc
protected static final String	METHODNAME__field2sccs
protected static final String	METHODNAME_collectFlags
protected static final String	METHODNAME_COREWRITER_rewriteDone
protected static final String	METHODNAME_getKey
protected static final String	METHODNAME_getLowestGeneratedClass
static final String	METHODNAME_MATCHFOREIGNOBJECT
static final String	METHODNAME_NOMATCH
protected static final String	METHODNAME_REWRITER_breakLoop
protected static final String	METHODNAME_REWRITER_changed
protected static final String	METHODNAME_REWRITER_GETRESULT
protected static final String	METHODNAME_REWRITER_ISMULTI
protected static final String	METHODNAME_REWRITER_LOOKUP
protected static final String	METHODNAME_REWRITER_putToCache
protected static final String	METHODNAME_REWRITER_RETURN
protected static final String	METHODNAME_REWRITER_RETURN_EMPTY
protected static final String	METHODNAME_REWRITER_RETURN_MULT_INTERN
protected static final String	METHODNAME_REWRITER_RETURN_MULTIPLE
protected static final String	METHODNAME_REWRITER_REVERT
protected static final String	METHODNAME_REWRITER_REWRITE
protected static final String	METHODNAME_REWRITER_REWRITETYPED
protected static final String	METHODNAME_REWRITER_useCache
protected static final String	METHODNAME_VISITOR_DEBUG
protected final UMod.Forest	model
protected final GeneratedClass	modelclass	The main Java class representing the complete umod model.
protected static final int	MODIF_FIELD
protected static final int	MODIF_PACKAGEVISIBLE
protected static final int	MODIF_STATICCLASS
protected static final int	MODIF_VISITENTRY
protected static final int	MODIF_VISITMETH
protected final MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>	msg
protected static final String	NAME_BASEMATCHER
protected static final String	VARNAME_TYPEVAR_REWRITETYPED
protected final boolean	visitorcompile
protected final boolean	visitordebug
protected final boolean	visitoroptimize

Method Summary

Modifier and Type	Method	Description
protected void	collectRegisters()	The algorithm is basically as follows: +
protected void	ERROR(Location<XMLDocumentIdentifier> loc, String txt, Object... args)
protected void	make_actionprepost(UMod.ClassDef cd, GeneratedClass visitor, UMod.ClassDef superclass)
static void	make_all_abstracts(GeneratedClass visitor, int key)
protected void	make_breakLoop_method(UMod.Forest model, GeneratedClass visitor)
protected void	make_dumpcode(GeneratedClass visitor, UMod.ClassDef cd, int keynum)
protected void	make_prepost(GeneratedClass visitor, String methname, UMod.ClassDef cd, UMod.ClassDef superclass)
protected GeneratedClass	make_v_dumper(UMod.Forest model, GeneratedContext context, GeneratedClass basematcher, int keynum, String name)
protected GeneratedClass	make_v_multiphase(UMod.Forest model, GeneratedContext context, GeneratedClass basematcher, int keynum, String name)
protected GeneratedClass	make_v_rewritercorewriter(UMod.Forest model, GeneratedContext context, GeneratedClass basematcher, int keynum, String name, UMod2visitors.rewriterType rtype, boolean supportMultiSubst)
protected GeneratedClass	make_v_simple(UMod.Forest model, GeneratedContext context, GeneratedClass basematcher, int keynum, String name)
protected void	makeCallDescend(GeneratedClass visitor, UMod.ClassDef cd, String methodname, int keynum, boolean optimizing)	Compiles the method which recursively calls "match()" on all selected fields, either directly or by calling "descend_[fieldname]()". The name of the generated method is "action" in the simple visitor case, or "descend" in the multiphase case.
void	makeSCCfields(GeneratedClass basevisitor, MetaType maptype, String fieldname, String methodname)	Generates in the generated base visitor class the field and the access method for one of the "scc data transfer" items.
protected GeneratedClass	makeVisitorClass(GeneratedContext context, GeneratedClass basematcher, String name)
protected void	WARNING(Location<XMLDocumentIdentifier> loc, String txt, Object... args)
protected void	warnNoVisit(UMod.ClassDef cd, UMod.FieldDef fd, boolean isPrim, boolean isAbstract)	Emit a warning or an error for not-visitbable field, erronuously selected by a V ../.. pragma.

Methods inherited from class java.lang.Object

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

Field Details

FIELDNAME__class2scc

protected static final String FIELDNAME__class2scc

The generated "scc data transmission code" will write into these fields. Is declared "abstract" in OptimizingVisitor and generated by makeSCCfields(GeneratedClass, MetaType, String, String).

See Also:

• Constant Field Values

FIELDNAME__field2sccs

protected static final String FIELDNAME__field2sccs

See Also:

• Constant Field Values

FIELDNAME__class2reachedSccs

protected static final String FIELDNAME__class2reachedSccs

See Also:

• Constant Field Values

METHODNAME__class2scc

protected static final String METHODNAME__class2scc

See Also:

• Constant Field Values

METHODNAME__field2sccs

protected static final String METHODNAME__field2sccs

See Also:

• Constant Field Values

METHODNAME__class2reachedSccs

protected static final String METHODNAME__class2reachedSccs

See Also:

• Constant Field Values

FIELDNAME_VISITOR_DEBUG_STREAM

protected static final String FIELDNAME_VISITOR_DEBUG_STREAM

See Also:

• Constant Field Values

METHODNAME_VISITOR_DEBUG

protected static final String METHODNAME_VISITOR_DEBUG

See Also:

• Constant Field Values

METHODNAME_getLowestGeneratedClass

protected static final String METHODNAME_getLowestGeneratedClass

See Also:

• Constant Field Values

METHODNAME_getKey

protected static final String METHODNAME_getKey

See Also:

• Constant Field Values

METHODNAME_collectFlags

protected static final String METHODNAME_collectFlags

See Also:

• Constant Field Values

allFields2codeNumber_DATA

protected final Map<String,Integer> allFields2codeNumber_DATA

METHODNAME_REWRITER_GETRESULT

protected static final String METHODNAME_REWRITER_GETRESULT

See Also:

• Constant Field Values

METHODNAME_REWRITER_ISMULTI

protected static final String METHODNAME_REWRITER_ISMULTI

See Also:

• Constant Field Values

METHODNAME_REWRITER_REVERT

protected static final String METHODNAME_REWRITER_REVERT

See Also:

• Constant Field Values

METHODNAME_REWRITER_changed

protected static final String METHODNAME_REWRITER_changed

See Also:

• Constant Field Values

METHODNAME_REWRITER_useCache

protected static final String METHODNAME_REWRITER_useCache

See Also:

• Constant Field Values

METHODNAME_REWRITER_breakLoop

protected static final String METHODNAME_REWRITER_breakLoop

See Also:

• Constant Field Values

METHODNAME_REWRITER_RETURN_EMPTY

protected static final String METHODNAME_REWRITER_RETURN_EMPTY

See Also:

• Constant Field Values

METHODNAME_REWRITER_RETURN

protected static final String METHODNAME_REWRITER_RETURN

See Also:

• Constant Field Values

METHODNAME_REWRITER_RETURN_MULTIPLE

protected static final String METHODNAME_REWRITER_RETURN_MULTIPLE

See Also:

• Constant Field Values

METHODNAME_REWRITER_RETURN_MULT_INTERN

protected static final String METHODNAME_REWRITER_RETURN_MULT_INTERN

See Also:

• Constant Field Values

METHODNAME_REWRITER_REWRITE

protected static final String METHODNAME_REWRITER_REWRITE

See Also:

• Constant Field Values

METHODNAME_REWRITER_REWRITETYPED

protected static final String METHODNAME_REWRITER_REWRITETYPED

See Also:

• Constant Field Values

VARNAME_TYPEVAR_REWRITETYPED

protected static final String VARNAME_TYPEVAR_REWRITETYPED

See Also:

• Constant Field Values

METHODNAME_REWRITER_LOOKUP

protected static final String METHODNAME_REWRITER_LOOKUP

See Also:

• Constant Field Values

METHODNAME_REWRITER_putToCache

protected static final String METHODNAME_REWRITER_putToCache

See Also:

• Constant Field Values

METHODNAME_COREWRITER_rewriteDone

protected static final String METHODNAME_COREWRITER_rewriteDone

See Also:

• Constant Field Values

NAME_BASEMATCHER

protected static final String NAME_BASEMATCHER

See Also:

• Constant Field Values

FIELDNAME_lowestGeneratedVisitorClass

protected static final String FIELDNAME_lowestGeneratedVisitorClass

See Also:

• Constant Field Values

METHODNAME_MATCHFOREIGNOBJECT

public static final String METHODNAME_MATCHFOREIGNOBJECT

See Also:

• Constant Field Values

METHODNAME_NOMATCH

public static final String METHODNAME_NOMATCH

See Also:

• Constant Field Values

MODIF_STATICCLASS

protected static final int MODIF_STATICCLASS

See Also:

• Constant Field Values

MODIF_VISITMETH

protected static final int MODIF_VISITMETH

See Also:

• Constant Field Values

MODIF_VISITENTRY

protected static final int MODIF_VISITENTRY

See Also:

• Constant Field Values

MODIF_FIELD

protected static final int MODIF_FIELD

See Also:

• Constant Field Values

MODIF_PACKAGEVISIBLE

protected static final int MODIF_PACKAGEVISIBLE

See Also:

• Constant Field Values

ANNOTATION_SUPPRESS_UNCHECKED

protected static final GeneratedAnnotation ANNOTATION_SUPPRESS_UNCHECKED

visitordebug

protected final boolean visitordebug

visitoroptimize

protected final boolean visitoroptimize

visitorcompile

protected final boolean visitorcompile

allrewriterwarnings

protected final boolean allrewriterwarnings

msg

protected final MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg

model

protected final UMod.Forest model

context

protected final GeneratedContext context

modelclass

protected final GeneratedClass modelclass

The main Java class representing the complete umod model.

basematcher

protected GeneratedClass basematcher

The topmost generated visitor, one per umod model. Extends either OptimizingVisitor. Is generated by code in this class.

allVisitorNums_classDefs

protected final Set<Integer> allVisitorNums_classDefs

allVisitorNums_visitorDefs

protected final Set<Integer> allVisitorNums_visitorDefs

allVisitorNums

protected final Set<Integer> allVisitorNums

descend_all_branches_case

public static final int descend_all_branches_case

Pseudo visitor register number for the case when NO LR-code is provided for a particular field, which means: ALL sub-expressions are visited.

See Also:

• Constant Field Values

Method Details

ERROR

protected void ERROR(Location<XMLDocumentIdentifier> loc,
 String txt,
 Object... args)

WARNING

protected void WARNING(Location<XMLDocumentIdentifier> loc,
 String txt,
 Object... args)

make_all_abstracts

public static void make_all_abstracts(GeneratedClass visitor,
 int key)

makeSCCfields

public void makeSCCfields(GeneratedClass basevisitor,
 MetaType maptype,
 String fieldname,
 String methodname)

Generates in the generated base visitor class the field and the access method for one of the "scc data transfer" items. All these fiels are maps indexed by integers; their values are again maps or multimaps.

collectRegisters

protected void collectRegisters()

The algorithm is basically as follows: +

 field2declaredClasses : Fd -> F Cd // F is *f*inite power set, as in "Z"
 select: Cd -> N -> seq Fd // seq of fields selected for a certain register
 super:  Cd -> Cd
 supSub: Cd <-> Cd = symmetricClosurre(reflexiveClosure
                                           (transitiveClosure(super)))
 // CANNOT exchange sequence of symmetric and transitive !!

 class2declaredClasses: N -> Cd -> F Cd 
    = {n|->c|->field2declaredClasses(|select(c,n).range|)} 
 reach: N-> Cd -> F Cd = subSub(|class2declaredClasses(|n, subSub(|{c}|)|)|)
 r2 = transitiveClosure ( scc (reach))
 

warnNoVisit

protected void warnNoVisit(UMod.ClassDef cd,
 UMod.FieldDef fd,
 boolean isPrim,
 boolean isAbstract)

Emit a warning or an error for not-visitbable field, erronuously selected by a V ../.. pragma. Whether the field is indeed selected is tested here. FIXME IS WRONG!!!! myfield int->Object V 0/0 V 1/0 L must only warn for register 1, not 0 !!!

makeCallDescend

protected void makeCallDescend(GeneratedClass visitor,
 UMod.ClassDef cd,
 String methodname,
 int keynum,
 boolean optimizing)

Compiles the method which recursively calls "match()" on all selected fields, either directly or by calling "descend_[fieldname]()".
The name of the generated method is "action" in the simple visitor case, or "descend" in the multiphase case.

makeVisitorClass

protected GeneratedClass makeVisitorClass(GeneratedContext context,
 GeneratedClass basematcher,
 String name)

make_v_simple

protected GeneratedClass make_v_simple(UMod.Forest model,
 GeneratedContext context,
 GeneratedClass basematcher,
 int keynum,
 String name)

make_v_multiphase

protected GeneratedClass make_v_multiphase(UMod.Forest model,
 GeneratedContext context,
 GeneratedClass basematcher,
 int keynum,
 String name)

make_prepost

protected void make_prepost(GeneratedClass visitor,
 String methname,
 UMod.ClassDef cd,
 UMod.ClassDef superclass)

make_actionprepost

protected void make_actionprepost(UMod.ClassDef cd,
 GeneratedClass visitor,
 UMod.ClassDef superclass)

make_v_dumper

protected GeneratedClass make_v_dumper(UMod.Forest model,
 GeneratedContext context,
 GeneratedClass basematcher,
 int keynum,
 String name)

make_dumpcode

protected void make_dumpcode(GeneratedClass visitor,
 UMod.ClassDef cd,
 int keynum)

make_v_rewritercorewriter

protected GeneratedClass make_v_rewritercorewriter(UMod.Forest model,
 GeneratedContext context,
 GeneratedClass basematcher,
 int keynum,
 String name,
 UMod2visitors.rewriterType rtype,
 boolean supportMultiSubst)

make_breakLoop_method

protected void make_breakLoop_method(UMod.Forest model,
 GeneratedClass visitor)