src/edu/berkeley/sbp/Parser.java

   1 package edu.berkeley.sbp;
   2 import edu.berkeley.sbp.*;
   3 import edu.berkeley.sbp.util.*;
   4 import edu.berkeley.sbp.Sequence.Position;
   5 import java.io.*;
   6 import java.util.*;
   7
   8 /** a parser which translates streams of Tokens of type T into a Forest<R> */
   9 public abstract class Parser<T extends Token, R> {
  10
  11     private final Table pt;
  12
  13     /** create a parser to parse the grammar with start symbol <tt>u</tt> */
  14     protected Parser(Union u)  { this.pt = new Table(u, top()); }
  15     protected Parser(Table pt) { this.pt = pt; }
  16
  17     /** implement this method to create the output forest corresponding to a lone shifted input token */
  18     public abstract Forest<R> shiftedToken(T t, Token.Location loc);
  19
  20     /** this method must return an empty topology of the input token type */
  21     public abstract Topology<T> top();
  22
  23     /** parse <tt>input</tt>, using the table <tt>pt</tt> to drive the parser */
  24     public Forest<R> parse(Token.Stream<T> input) throws IOException, ParseFailed {
  25         GSS gss = new GSS();
  26         Token.Location loc = input.getLocation();
  27         GSS.Phase current = gss.new Phase(null, this, null, input.next(1, 0, 0), loc, null);
  28         current.newNode(null, Forest.leaf(null, null), pt.start, true);
  29         int count = 1;
  30         for(;;) {
  31             loc = input.getLocation();
  32             current.reduce();
  33             Forest forest = current.token==null ? null : shiftedToken((T)current.token, loc);
  34             GSS.Phase next = gss.new Phase(current, this, current, input.next(count, gss.resets, gss.waits), loc, forest);
  35             count = next.hash.size();
  36             if (current.isDone()) return (Forest<R>)current.finalResult;
  37             current = next;
  38         }
  39     }
  40
  41     // Table //////////////////////////////////////////////////////////////////////////////
  42
  43     /** an SLR(1) parse table which may contain conflicts */
  44     static class Table extends Walk.Cache {
  45
  46         public final Walk.Cache cache = this;
  47
  48         private void walk(Element e, HashSet<Element> hs) {
  49             if (e==null) return;
  50             if (hs.contains(e)) return;
  51             hs.add(e);
  52             if (e instanceof Atom) return;
  53             for(Sequence s : (Union)e) {
  54                 hs.add(s);
  55                 for(Position p = s.firstp(); p != null; p = p.next())
  56                     walk(p.element(), hs);
  57             }
  58         }
  59
  60         /** the start state */
  61         public final State   start;
  62
  63         /** used to generate unique values for State.idx */
  64         private int master_state_idx = 0;
  65
  66         /** construct a parse table for the given grammar */
  67         public Table(Topology top) { this("s", top); }
  68         public Table(String startSymbol, Topology top) { this(new Union(startSymbol), top); }
  69         public Table(Union ux, Topology top) {
  70             Union start0 = new Union("0");
  71             start0.add(new Sequence.Singleton(ux, null, null));
  72
  73             for(Sequence s : start0) cache.eof.put(s, true);
  74             cache.eof.put(start0, true);
  75
  76             // construct the set of states
  77             HashMap<HashSet<Position>,State>   all_states    = new HashMap<HashSet<Position>,State>();
  78             HashSet<Element>                   all_elements  = new HashSet<Element>();
  79             walk(start0, all_elements);
  80             for(Element e : all_elements)
  81                 cache.ys.addAll(e, new Walk.YieldSet(e, cache).walk());
  82             HashSet<Position> hp = new HashSet<Position>();
  83             reachable(start0, hp);
  84             this.start = new State(hp, all_states, all_elements);
  85
  86             // for each state, fill in the corresponding "row" of the parse table
  87             for(State state : all_states.values())
  88                 for(Position p : state.hs) {
  89
  90                     // the Grammar's designated "last position" is the only accepting state
  91                     if (start0.contains(p.owner()) && p.next()==null)
  92                         state.accept = true;
  93
  94                     if (isRightNullable(p)) {
  95                         Walk.Follow wf = new Walk.Follow(top.empty(), p.owner(), all_elements, cache);
  96                         Reduction red = new Reduction(p);
  97
  98                         Topology follow = wf.walk(p.owner());
  99                         for(Position p2 = p; p2 != null && p2.element() != null; p2 = p2.next())
 100                             follow = follow.intersect(new Walk.Follow(top.empty(), p2.element(), all_elements, cache).walk(p2.element()));
 101                         state.reductions.put(follow, red);
 102                         if (wf.includesEof()) state.eofReductions.add(red);
 103                     }
 104
 105                     // if the element following this position is an atom, copy the corresponding
 106                     // set of rows out of the "master" goto table and into this state's shift table
 107                     if (p.element() != null && p.element() instanceof Atom)
 108                         state.shifts.addAll(state.gotoSetTerminals.subset(((Atom)p.element())));
 109                 }
 110             for(State state : all_states.values()) {
 111                 state.oreductions = state.reductions.optimize();
 112                 state.oshifts = state.shifts.optimize();
 113             }
 114         }
 115
 116         private boolean isRightNullable(Position p) {
 117             if (p.isLast()) return true;
 118             if (!p.element().possiblyEpsilon(this)) return false;
 119             return isRightNullable(p.next());
 120         }
 121
 122         /** a single state in the LR table and the transitions possible from it */
 123
 124         public class State implements Comparable<Table.State>, IntegerMappable, Iterable<Position> {
 125
 126             public  final     int               idx    = master_state_idx++;
 127             private final     HashSet<Position> hs;
 128
 129             private transient HashMap<Element,State>          gotoSetNonTerminals = new HashMap<Element,State>();
 130             private transient TopologicalBag<Token,State>     gotoSetTerminals    = new TopologicalBag<Token,State>();
 131
 132             private           TopologicalBag<Token,Reduction> reductions          = new TopologicalBag<Token,Reduction>();
 133             private           HashSet<Reduction>              eofReductions       = new HashSet<Reduction>();
 134             private           TopologicalBag<Token,State>     shifts              = new TopologicalBag<Token,State>();
 135             private           boolean                         accept              = false;
 136
 137             private VisitableMap<Token,State> oshifts = null;
 138             private VisitableMap<Token,Reduction> oreductions = null;
 139
 140             // Interface Methods //////////////////////////////////////////////////////////////////////////////
 141
 142             public boolean             isAccepting()               { return accept; }
 143
 144             public boolean             canShift(Token t)           { return oshifts.contains(t); }
 145             public boolean             canReduce(Token t)          { return t==null ? eofReductions.size()>0 : oreductions.contains(t); }
 146
 147             public Iterator<Position>  iterator()                  { return hs.iterator(); }
 148
 149             public <B,C> void          invokeShifts(Token t, Invokable<State,B,C> irbc, B b, C c) {
 150                 oshifts.invoke(t, irbc, b, c);
 151             }
 152             public <B,C> void          invokeReductions(Token t, Invokable<Reduction,B,C> irbc, B b, C c) {
 153                 if (t==null) for(Reduction r : eofReductions) irbc.invoke(r, b, c);
 154                 else         oreductions.invoke(t, irbc, b, c);
 155             }
 156
 157             // Constructor //////////////////////////////////////////////////////////////////////////////
 158
 159             /**
 160              *  create a new state consisting of all the <tt>Position</tt>s in <tt>hs</tt>
 161              *  @param hs           the set of <tt>Position</tt>s comprising this <tt>State</tt>
 162              *  @param all_states   the set of states already constructed (to avoid recreating states)
 163              *  @param all_elements the set of all elements (Atom instances need not be included)
 164              *
 165              *   In principle these two steps could be merged, but they
 166              *   are written separately to highlight these two facts:
 167              * <ul>
 168              * <li> Non-atom elements either match all-or-nothing, and do not overlap
 169              *      with each other (at least not in the sense of which element corresponds
 170              *      to the last reduction performed).  Therefore, in order to make sure we
 171              *      wind up with the smallest number of states and shifts, we wait until
 172              *      we've figured out all the token-to-position multimappings before creating
 173              *      any new states
 174              *
 175              * <li> In order to be able to run the state-construction algorithm in a single
 176              *      shot (rather than repeating until no new items appear in any state set),
 177              *      we need to use the "yields" semantics rather than the "produces" semantics
 178              *      for non-Atom Elements.
 179              *  </ul>
 180              */
 181             public State(HashSet<Position> hs,
 182                          HashMap<HashSet<Position>,State> all_states,
 183                          HashSet<Element> all_elements) {
 184                 this.hs = hs;
 185
 186                 // register ourselves in the all_states hash so that no
 187                 // two states are ever created with an identical position set
 188                 all_states.put(hs, this);
 189
 190                 // Step 1a: examine all Position's in this state and compute the mappings from
 191                 //          sets of follow tokens (tokens which could follow this position) to sets
 192                 //          of _new_ positions (positions after shifting).  These mappings are
 193                 //          collectively known as the _closure_
 194
 195                 TopologicalBag<Token,Position> bag0 = new TopologicalBag<Token,Position>();
 196                 for(Position position : hs) {
 197                     if (position.isLast() || !(position.element() instanceof Atom)) continue;
 198                     Atom a = (Atom)position.element();
 199                     HashSet<Position> hp = new HashSet<Position>();
 200                     reachable(position.next(), hp);
 201                     bag0.addAll(a, hp);
 202                 }
 203
 204                 // Step 1b: for each _minimal, contiguous_ set of characters having an identical next-position
 205                 //          set, add that character set to the goto table (with the State corresponding to the
 206                 //          computed next-position set).
 207
 208                 for(Topology<Token> r : bag0) {
 209                     HashSet<Position> h = new HashSet<Position>();
 210                     for(Position p : bag0.getAll(r)) h.add(p);
 211                     gotoSetTerminals.put(r, all_states.get(h) == null ? new State(h, all_states, all_elements) : all_states.get(h));
 212                 }
 213
 214                 // Step 2: for every non-Atom element (ie every Element which has a corresponding reduction),
 215                 //         compute the closure over every position in this set which is followed by a symbol
 216                 //         which could yield the Element in question.
 217                 //
 218                 //         "yields" [in one or more step] is used instead of "produces" [in exactly one step]
 219                 //         to avoid having to iteratively construct our set of States as shown in most
 220                 //         expositions of the algorithm (ie "keep doing XYZ until things stop changing").
 221                 HashMapBag<Element,Position> move = new HashMapBag<Element,Position>();
 222                 for(Position p : hs) {
 223                     Element e = p.element();
 224                     if (e==null) continue;
 225                     for(Element y : cache.ys.getAll(e)) {
 226                         HashSet<Position> hp = new HashSet<Position>();
 227                         reachable(p.next(), hp);
 228                         move.addAll(y, hp);
 229                     }
 230                 }
 231                 for(Element y : move) {
 232                     HashSet<Position> h = move.getAll(y);
 233                     State s = all_states.get(h) == null ? new State(h, all_states, all_elements) : all_states.get(h);
 234                     gotoSetNonTerminals.put(y, s);
 235                 }
 236             }
 237
 238             public String toString() {
 239                 //return "state["+idx+"]";
 240                 StringBuffer ret = new StringBuffer();
 241                 ret.append("state["+idx+"]: ");
 242                 for(Position p : this) ret.append("{"+p+"}  ");
 243                 return ret.toString();
 244             }
 245
 246             public int compareTo(Table.State s) { return idx==s.idx ? 0 : idx < s.idx ? -1 : 1; }
 247             public int toInt() { return idx; }
 248         }
 249
 250         /**
 251          *  the information needed to perform a reduction; copied here to
 252          *  avoid keeping references to <tt>Element</tt> objects in a Table
 253          */
 254         public class Reduction {
 255             // FIXME: cleanup; almost everything in here could go in either Sequence.Position.getRewrite() or else in GSS.Reduct
 256             public final int numPop;
 257             /*private*/ final Position position;
 258             private final Forest[] holder;    // to avoid constant reallocation
 259             public int hashCode() { return position.hashCode(); }
 260             public boolean equals(Object o) {
 261                 if (o==null) return false;
 262                 if (o==this) return true;
 263                 if (!(o instanceof Reduction)) return false;
 264                 Reduction r = (Reduction)o;
 265                 return r.position == position;
 266             }
 267             public Reduction(Position p) {
 268                 this.position = p;
 269                 this.numPop = p.pos;
 270                 this.holder = new Forest[numPop];
 271             }
 272             public String toString() { return "[reduce " + position + "]"; }
 273
 274             private Forest zero = null;
 275             public Forest zero() {
 276                 if (zero != null) return zero;
 277                 if (numPop > 0) throw new Error();
 278                 return zero = position.rewrite(null);
 279             }
 280
 281             public void reduce(GSS.Phase.Node parent) {
 282                 if (numPop==0) finish(parent, zero(), parent.phase());
 283                 else           reduce(parent, numPop-1, parent.phase());
 284             }
 285
 286             public void reduce(GSS.Phase.Node parent, GSS.Phase.Node onlychild) {
 287                 if (numPop<=0) throw new Error("called wrong form of reduce()");
 288                 int pos = numPop-1;
 289                 Forest old = holder[pos];
 290                 holder[pos] = parent.pending();
 291                 if (pos==0) {
 292                     System.arraycopy(holder, 0, position.holder, 0, holder.length);
 293                     finish(onlychild, position.rewrite(parent.phase().getLocation()), parent.phase());
 294                 } else {
 295                     reduce(onlychild, pos-1, parent.phase());
 296                 }
 297                 holder[pos] = old;
 298             }
 299
 300             // FIXME: this could be more elegant and/or cleaner and/or somewhere else
 301             private void reduce(GSS.Phase.Node parent, int pos, GSS.Phase target) {
 302                 Forest old = holder[pos];
 303                 holder[pos] = parent.pending();
 304                 if (pos==0) {
 305                     System.arraycopy(holder, 0, position.holder, 0, holder.length);
 306                     for(int i=0; i<position.pos; i++) if (position.holder[i]==null) throw new Error("realbad");
 307                     Forest rex = position.rewrite(target.getLocation());
 308                     for(GSS.Phase.Node child : parent.parents()) finish(child, rex, target);
 309                 } else {
 310                     for(GSS.Phase.Node child : parent.parents()) reduce(child, pos-1, target);
 311                 }
 312                 holder[pos] = old;
 313             }
 314             private void finish(GSS.Phase.Node parent, Forest result, GSS.Phase target) {
 315                 State state = parent.state.gotoSetNonTerminals.get(position.owner());
 316                 if (result==null) throw new Error();
 317                 if (state!=null)
 318                     target.newNode(parent, result, state, numPop<=0, this);
 319             }
 320         }
 321     }
 322
 323     private static final Forest[] emptyForestArray = new Forest[0];
 324
 325
 326     // Helpers //////////////////////////////////////////////////////////////////////////////
 327
 328     private static void reachable(Element e, HashSet<Position> h) {
 329         if (e instanceof Atom) return;
 330         for(Sequence s : ((Union)e))
 331             reachable(s.firstp(), h);
 332     }
 333     private static void reachable(Position p, HashSet<Position> h) {
 334         if (h.contains(p)) return;
 335         h.add(p);
 336         if (p.element() != null) reachable(p.element(), h);
 337     }
 338
 339 }