// demjava.cd -- class dictionary for Demeter/Java

(@
    import java.util.*;
    import java.io.*;
@)


Main = .

GenerateEqualVisitor = .
GenerateEdgeVisitor = .

// Begin Utility function visitors
GetCSNameVisitor = <theName> Ident.
GetCDNameVisitor = <theName> Ident.
GetPNameVisitor = <theName> Ident.
GetPCNameVisitor = <theName> Ident.
IsDemeterClassVisitor = .
IsAlternationClassVisitor = .
// End Utility function visitors

Program			= [ <pkg> Package ] [ <preamble> JavaCode ] ClassGraph.

Package			~ "package" DirName { "." DirName } ";".

ClassGraph		= <classes> DList(ClassDef).

ClassDef		= ParamClassName ClassParts [ ClassMethods ] "." .

ParamClassName		= ClassName ["(" <parameters> Commalist(ClassName) ")"].

ClassParts		: ConstOrAltClass | RepetitionClass.

ConstOrAltClass		: ConstructionClass | AlternationClass
			*common* + + +
				<parts> List(PartOrSyntax)
				<parents> ClassParents
				 - - -.

PartOrSyntax		: Part | OptionalPart | Syntax.

Part			= [ "<" PartName ">" ] ClassSpec.

OptionalPart		= "[" <part> Sandwich(Part) "]".

ClassParents		= [ "*extends*" <parent> Superclass ]
			  [ "*implements*" <interfaces> Commalist(Interface) ] .

Superclass		= ClassSpec.
Interface		= ClassSpec.

ConstructionClass	= "=".

AlternationClass	= ":" + + + <subclasses> Barlist(Subclass) - - -
			[ Common ].

Subclass		= ClassSpec.

Common			= *l + + + "*common*" - - -.

RepetitionClass		= "~" <sandwiched> Sandwich(RepeatedPart).

RepeatedPart		= [ <nonempty> ClassSpec ]
			"{" <repeated> Sandwich(ClassSpec) "}".

Sandwich(S)		= <first> List(Syntax) <inner> S <second> List(Syntax) .

ClassSpec		= ClassName
			["(" <actual_parameters> Commalist(ClassSpec) ")" ]
			.

Syntax			: PlainSyntax | PrintCommand
			.

PlainSyntax		= <string> String.

PrintCommand		: PrintIndent | PrintUnindent | PrintSkip | PrintSpace.
PrintIndent		= "+" .
PrintUnindent		= "-" .
PrintSkip		= "*l" .
PrintSpace		= "*s" .


//////////////////////
// Behavior (methods).
//////////////////////
ProgramBehavior		= [ <behavior> DList(ClassBehavior) ].

ClassBehavior		= <classes> ClassGlobSpec ClassMethods.

ClassMethods		= "{" *l + [ <methods> SList(Method) ] - "}" .

Method			: Traversal | Behavior.
Behavior		: Wrapper | Verbatim.


// Class graph traversal specifications.
Traversal		= "traversal" TraversalName <parms> TraversalParms "{" *l
			+ PathDirective ";" - *l
			"}".

TraversalParms		= "(" [ <visitors> Commalist(Visitor) ] ")" .

Visitor			= ClassName VisitorName.

PathDirective		= [ BypassingDirective ]
			  [ ThroughDirective ]
			  TargetDirective.

BypassingDirective	= "bypassing" <glob> GlobSpec.
ThroughDirective	= "through" <glob> GlobSpec.

TargetDirective		: To | ToStop *common* <targets> ClassGlobSpec.
To			= "to".
ToStop			= "to-stop".

GlobSpec		: OneGlob | GlobSet.
OneGlob			= Glob.
GlobSet			= "{" [ <globs> Commalist(Glob) ] "}".

Glob			: ClassGlob | EdgeGlob.
EdgeGlob		: PartGlob | SubclassGlob | SuperclassGlob.

ClassGlob		= <name> ClassNameGlob.
PartGlob		= "->" <source> SourceGlob "," <name> PartNameGlob ","
			       <dest> DestGlob.
SubclassGlob		= "=>" <source> SourceGlob "," <dest> DestGlob.
SuperclassGlob		= ":>" <source> SourceGlob "," <dest> DestGlob.

SourceGlob		= <name> ClassNameGlob.
DestGlob		= <name> ClassNameGlob.

ClassNameGlob		: ClassNameExact | AnyClass.
ClassNameExact		= ClassName.
AnyClass		= "*".

PartNameGlob		: PartNameExact | AnyPart.
PartNameExact		= PartName.
AnyPart			= "*".

ClassGlobSpec		: OneClassGlob | ClassGlobSet.
OneClassGlob		= ClassGlob.
ClassGlobSet		= "{" <classglobs> Commalist(ClassGlob) "}".


// Before and after wrappers.
Wrapper			: Before | After *common* <hosts> HostSpec JavaCode.

Before			= "before".
After			= "after".

HostSpec		: GlobSpec.


// Verbatim java code.
Verbatim		= JavaCode.


// Terminal buffer classes.
DirName			= <name> Ident.
ClassName		= <name> Ident.
PartName		= <name> Ident.
TraversalName		= <name> Ident.
VisitorName		= <name> Ident.
MethodName		= <name> Ident.
JavaCode		= <code> Text.


// Parameterized class definitions.
List(S) ~ {S}.
SList(S) ~ S { *l S } *l .
DList(S) ~ S { *l *l S } *l .
Commalist(S) ~ S {"," S}.
Barlist(S) ~ S { *l "|" S}.

// Extra utility parameterized classes.
Parameterized		= Commalist(Part).
SyntaxTable		= List(PlainSyntax).

// Visitors.
SimplePrinter		= .
PackagePrinter		= .
SubclassBacklinker	= <parent_name> ClassName.
SuperclassNameGetter	= [ <name> ClassName ].
ClassNameExpander	= ClassName.
ClassNameFinder		= <index> Integer <it> ClassName.
KeywordPrinter		= .
NameConcatenator	= <concat> String.
ParamListGetter		= <parameters> ClassName_Commalist.
RepetitionConverter	= ClassName
			  <container> ConstructionClass
			  <linknode> ConstructionClass
			  <linknodename> ClassName
			.
RepetitionNodesCompleter = <container> ConstructionClass
			  <linknode> ConstructionClass
			  <linknodename> ClassName
			.
PartOrSyntaxAdder	= <add> PartOrSyntax.

BehaviorCollector	= <filename> String <classes> ClassGlobSpec.
ClassGlobVisitor	: BehaviorAttacher | BackwardMarkerCarrier.
BehaviorAttacher	= "_BehaviorAttacher" <filename> String
			  <methods> ClassMethods.
BackwardMarkerCarrier	= "_BackwardMarkerCarrier".

BehaviorCodeGenerator	= <methodname> String <hosts> HostSpec.
WrapperCodeGenerator	= <methodname> String <code> Text.
TraversalExpander	= <source> ClassDef.
MethodAdder		= Method.
WrapperClassChecker	= ClassName.
Visitor_CommalistReverser = <list> Nonempty_Visitor_Commalist.
RuleVisitor		= .
DeclVisitor		= .
RHSVisitor		= ClassName.
ParseCodeGenerator	= ClassName.

ClassNameAccessor	: ClassNameSetter | ClassNameGetter *common* ClassName.
ClassNameGetter		= "_ClassNameGetter".
ClassNameSetter		= "_ClassNameSetter".

ClassSpecVisitor	: ParamExpander | ClassSpecFinder.
ParamExpander		= "_ParamExpander".
ClassSpecFinder		= "_ClassSpecFinder" <index> Integer <it> ClassSpec.

ParentsVisitor		: ParentSetter | ParentPrinter.
ParentSetter		= "_ParentSetter" <parent_name> ClassName
			  [ <child_name> ClassName ].
ParentPrinter		= "_ParentPrinter".

ClassGraphVisitor	: ClassDefAdder | ClassesSetter.
ClassDefAdder		= "_ClassDefAdder" ClassDef.
ClassesSetter		= "_ClassesSetter" <classes> ClassDef_DList.

ClassDefVisitor		: ClassDefCollector | ClassDefCounter
			| NonParamDefCollector | GlobalBehaviorAttacher
			| SCCchecker | CodeGenerator.
ClassDefCollector	= "_ClassDefCollector".
ClassDefCounter		= "_ClassDefCounter" . // int
NonParamDefCollector	= "_NonParamDefCollector" <classes> ClassDef_DList.
GlobalBehaviorAttacher	= "_GlobalBehaviorAttacher" <methods> ClassMethods.
SCCchecker		= "_SCCchecker" <state> SCCstate.
CodeGenerator		= "_CodeGenerator".

PartVisitor		: PartPrinter | PartCollector | PartNameSetter
			| ConstructorArgsGenerator
			| ConstructorInitsGenerator
			| ConstructorSuperInitGenerator
			| ParamReplacer
			.
PartPrinter		= "_PartPrinter".
PartCollector		= "_PartCollector" <parts> Commalist(Part).
PartNameSetter		= "_PartNameSetter".
ConstructorArgsGenerator = "_ConstructorArgsGenerator".
ConstructorSuperInitGenerator = "_ConstructorSuperInitGenerator".
ConstructorInitsGenerator = "_ConstructorInitsGenerator".
ParamReplacer		= "_ParamReplacer"
			  <params> Commalist(ClassName)
			  <actuals> Commalist(ClassSpec).

EdgeVisitor		: SCC | SubgraphMarker | TraversalMethodGenerator.
SCC			= <v> ClassDef [ <last> Superclass ] <state> SCCstate.
SCCstate		= .
SubgraphMarker		: ForwardMarker | BackwardMarker | AllBackwardMarker
			*common* <source> ClassName.
ForwardMarker		= "_ForwardMarker" <info> TraversalInfo.
BackwardMarker		= "_BackwardMarker" <dest> ClassDef.
AllBackwardMarker	= "_AllBackwardMarker".
TraversalInfo		= <source> ClassDef "_bypass" <bypass> GlobSpec
			  [ "_targets" <targets> ClassGlobSpec ].
TraversalMethodGenerator = "_TraversalMethodGenerator" <info> TraversalMethodInfo
			<source> ClassName.
TraversalMethodInfo	= <name> MethodName <parms> TraversalParms
			  <revparms> TraversalParms <args> String.

GlobMatcher		= Glob.
ClassNameMatcher	= ClassName.

VisitorNameVisitor	: VisitorNameCollector | WrapperCallGenerator.
VisitorNameCollector	= "_VisitorNameCollector" String.
WrapperCallGenerator	: BeforeCallGenerator | AfterCallGenerator
			*common* <vclass> ClassName Glob.
BeforeCallGenerator	= "_BeforeCallGenerator".
AfterCallGenerator	= "_AfterCallGenerator".

WrapperChecker		= Glob.