Public Member Functions | Static Public Member Functions | Package Attributes

antlr.Lookahead Class Reference

List of all members.

Public Member Functions

 Lookahead ()
 Lookahead (BitSet p)
 Lookahead (String c)
Object clone ()
void combineWith (Lookahead q)
boolean containsEpsilon ()
Lookahead intersection (Lookahead q)
boolean nil ()
void resetEpsilon ()
void setEpsilon ()
String toString ()
String toString (String separator, CharFormatter formatter)
String toString (String separator, CharFormatter formatter, Grammar g)
String toString (String separator, Vector vocab)

Static Public Member Functions

static Lookahead of (int el)

Package Attributes

BitSet fset
String cycle
BitSet epsilonDepth
boolean hasEpsilon = false

Detailed Description

This object holds all information needed to represent the lookahead for any particular lookahead computation for a single lookahead depth. Final lookahead information is a simple bit set, but intermediate stages need computation cycle and FOLLOW information.

Concerning the cycle variable. If lookahead is computed for a RuleEnd node, then computation is part of a FOLLOW cycle for this rule. If lookahead is computed for a RuleBlock node, the computation is part of a FIRST cycle to this rule.

Concerning the epsilonDepth variable. This is not the depth relative to the rule reference that epsilon was encountered. That value is

 		initial_k - epsilonDepth + 1
 

Also, lookahead depths past rule ref for local follow are:

 		initial_k - (initial_k - epsilonDepth)
 

Used for rule references. If we try to compute look(k, ruleref) and there are fewer than k lookahead terminals before the end of the the rule, epsilon will be returned (don't want to pass the end of the rule). We must track when the the lookahead got stuck. For example,

 		a : b A B E F G;
 		b : C ;
 

LOOK(5, ref-to(b)) is {<EPSILON>} with depth = 4, which indicates that at 2 (5-4+1) tokens ahead, end of rule was reached. Therefore, the token at 4=5-(5-4) past rule ref b must be included in the set == F. The situation is complicated by the fact that a computation may hit the end of a rule at many different depths. For example,

 		a : b A B C ;
 		b : E F		// epsilon depth of 1 relative to initial k=3
 		  | G		// epsilon depth of 2
 		  ;
 

Here, LOOK(3,ref-to(b)) returns epsilon, but the depths are {1, 2}; i.e., 3-(3-1) and 3-(3-2). Those are the lookahead depths past the rule ref needed for the local follow.

This is null unless an epsilon is created.

See also:
antlr.Lookahead.combineWith(Lookahead)

Constructor & Destructor Documentation

antlr.Lookahead.Lookahead (  ) 
antlr.Lookahead.Lookahead ( BitSet  p  ) 

create a new lookahead set with the LL(1) set to the parameter

References antlr.Lookahead.fset.

antlr.Lookahead.Lookahead ( String  c  ) 

create an empty lookahead set, but with cycle

References antlr.Lookahead.cycle.


Member Function Documentation

Object antlr.Lookahead.clone (  ) 
void antlr.Lookahead.combineWith ( Lookahead  q  ) 
boolean antlr.Lookahead.containsEpsilon (  ) 
Lookahead antlr.Lookahead.intersection ( Lookahead  q  ) 

What is the intersection of two lookahead depths? Only the Epsilon "bit" and bitset are considered.

References antlr.collections.impl.BitSet.and(), antlr.Lookahead.fset, antlr.Lookahead.hasEpsilon, antlr.Lookahead.Lookahead(), and antlr.Lookahead.setEpsilon().

Referenced by antlr.LLkAnalyzer.deterministic(), and antlr.LLkAnalyzer.deterministicImpliedPath().

boolean antlr.Lookahead.nil (  ) 
static Lookahead antlr.Lookahead.of ( int  el  )  [static]
void antlr.Lookahead.resetEpsilon (  ) 
void antlr.Lookahead.setEpsilon (  ) 
String antlr.Lookahead.toString ( String  separator,
CharFormatter  formatter 
)
String antlr.Lookahead.toString (  ) 
String antlr.Lookahead.toString ( String  separator,
Vector  vocab 
)
String antlr.Lookahead.toString ( String  separator,
CharFormatter  formatter,
Grammar  g 
)

Member Data Documentation

String antlr.Lookahead.cycle [package]

What k values were being computed when end of rule hit?

Referenced by antlr.Lookahead.clone(), antlr.Lookahead.combineWith(), antlr.LLkAnalyzer.look(), and antlr.Lookahead.toString().

boolean antlr.Lookahead.hasEpsilon = false [package]

Does this lookahead depth include Epsilon token type? This is used to avoid having a bit in the set for Epsilon as it conflicts with parsing binary files.

Referenced by antlr.Lookahead.combineWith(), antlr.Lookahead.containsEpsilon(), antlr.Lookahead.intersection(), antlr.Lookahead.nil(), antlr.Lookahead.resetEpsilon(), and antlr.Lookahead.setEpsilon().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties