removed illegal use of double-star
[sbp.git] / src / edu / berkeley / sbp / Sequence.java
1 package edu.berkeley.sbp;
2 import edu.berkeley.sbp.util.*;
3 import edu.berkeley.sbp.*;
4 import edu.berkeley.sbp.*;
5 import java.io.*;
6 import java.util.*;
7 import java.lang.reflect.*;
8 import java.lang.ref.*;
9
10 /** juxtaposition; zero or more adjacent Elements; can specify a rewriting */
11 public abstract class Sequence extends Element implements Iterable<Element> {
12
13     // Static Constructors //////////////////////////////////////////////////////////////////////////////
14
15     /** the empty sequence (matches the empty string) */
16     public static final Sequence empty = new Sequence.Constant.Empty();
17
18     /** after matching the sequence, do not add anything to the output tree */
19     public static Sequence drop(Element[] e, HashSet<Sequence> and, HashSet<Sequence> not, boolean lame) { return new Constant.Drop(e, and, not, lame); }
20
21     /** after matching the sequence, insert a constant into the output tree */
22     public static Sequence constant(Element[] e, Object o, HashSet<Sequence> and, HashSet<Sequence> not) { return new Constant(e, o, and, not); }
23
24     /** after matching the sequence, place the result of the <tt>idx</tt>th match in the output tree */
25     public static Sequence singleton(Element[] e, int idx, HashSet<Sequence> and, HashSet<Sequence> not) { return new Singleton(e, idx, and, not); }
26
27     /**
28      *  after matching the sequence, create the specified output tree
29      *  @param tag   the tag for the output tree
30      *  @param e     the elements to match
31      *  @param drops only elements of <tt>e</tt> whose corresponding <tt>boolean</tt> in <tt>drops</tt> is <i>false</i> will be included in the output tree
32      **/
33     public static Sequence rewritingSequence(Object tag, Element[] e, boolean[] drops, HashSet<Sequence> and, HashSet<Sequence> not) {
34         return new RewritingSequence(tag, e, drops, and, not); }
35
36     ////////////////////////////////////////////////////////////////////////////////
37
38     public Topology noFollow() { return null; }
39
40     Topology toAtom() {
41         if (elements.length>1) throw new RuntimeException("cannot invoke toAtom() on a Sequence with " + elements.length + " elements: " + this);
42         if (elements.length==0) return null;
43         return elements[0].toAtom();
44     }
45
46     protected final Element[] elements;
47
48     final HashSet<Sequence> needs;
49     final HashSet<Sequence> hates;
50           boolean           lame  = false;
51
52     final Position          firstp;
53     Position firstp() { return firstp; }
54
55     public Iterator<Element> iterator()    { return new ArrayIterator<Element>(elements); }
56     protected Sequence(Element[] elements, HashSet<Sequence> and, HashSet<Sequence> not) {
57         this.needs = and==null ? new HashSet<Sequence>() : and;
58         this.hates = not==null ? new HashSet<Sequence>() : not;
59         //for(Sequence s : needs) s.lame = true;
60         //for(Sequence s : hates) s.lame = true;
61         this.elements = elements;
62         this.firstp = new Position(0);
63     }
64
65     void reachable(HashSet<Position> h) { firstp().reachable(h); }
66
67     Forest epsilonForm() { return firstp().rewrite(null); }
68
69     protected abstract <T> Forest<T> postReduce(Token.Location loc, Forest<T>[] args);
70
71
72     // Position //////////////////////////////////////////////////////////////////////////////
73
74     /** the imaginary position before or after an element of a sequence; corresponds to an "LR item" */
75     public class Position {
76
77         void reachable(HashSet<Position> h) {
78             if (h.contains(this)) return;
79             h.add(this);
80             if (element() != null) element().reachable(h);
81         }
82
83                 final int      pos;
84         private final Position next;
85                 final Forest[] holder;
86         
87         private Position(int pos) {
88             this.pos      = pos;
89             this.next     = pos==elements.length ? null : new Position(pos+1);
90             this.holder   = new Forest[elements.length];
91         }
92
93         boolean isFirst() { return pos==0; }
94         boolean isRightNullable(Walk.Cache cache) {
95             if (isLast()) return true;
96             if (!element().possiblyEpsilon(cache)) return false;
97             return next().isRightNullable(cache);
98         }
99
100         /** the element immediately after this Position, or null if this is the last Position */
101         public Element  element() { return pos>=elements.length ? null : elements[pos]; }
102
103         /** the element which produces the sequence to which this Position belongs */
104         public Sequence owner() { return Sequence.this; }
105
106         /** the next Position (the Position after <tt>this.element()</tt>) */
107         public Position next() { return next; }
108
109         /** true iff this Position is the last one in the sequence */
110         public boolean isLast() { return next()==null; }
111
112         // Reduction /////////////////////////////////////////////////////////////////////////////////
113
114         <T> Forest<T> rewrite(Token.Location loc) {
115             for(int i=pos; i<elements.length; i++) if (holder[i]==null) holder[i] = elements[i].epsilonForm();
116             Forest<T> ret = Sequence.this.postReduce(loc, holder);
117             for(int k=0; k<pos; k++) holder[k] = null; // to help GC
118             return ret;
119         }
120
121         public String   toString() {
122             StringBuffer ret = new StringBuffer();
123             ret.append("<{");
124             for(Position p = Sequence.this.firstp(); p != null; p = p.next()) {
125                 ret.append(' ');
126                 if (p==this) ret.append(" | ");
127                 if (p.element()!=null) ret.append(p.element().possiblyEpsilon(null) ? "["+p.element()+"]" : p.element());
128                 else                   ret.append(' ');
129             }
130             ret.append("}>");
131             return ret.toString();
132         }
133     }
134
135
136     // toString //////////////////////////////////////////////////////////////////////////////
137
138     public String toString() { return toString(new StringBuffer(), false).toString(); }
139     StringBuffer toString(StringBuffer sb) { return toString(sb, true); }
140     StringBuffer toString(StringBuffer sb, boolean spacing) {
141         for(int i=0; i<elements.length; i++) {
142             sb.append(elements[i].toString());
143             sb.append(' ');
144         }
145         return sb;
146     }
147
148
149     // Specialized Subclasses //////////////////////////////////////////////////////////////////////////////
150
151     static class Constant extends Sequence {
152         private final Object result;
153         public Constant(Element[] e, Object result, HashSet<Sequence> and, HashSet<Sequence> not) { super(e, and, not); this.result = result; }
154         public <T> Forest<T> postReduce(Token.Location loc, Forest<T>[] args) {
155             return (Forest<T>)Forest.leaf(loc, result, this);
156         }
157         static class Drop extends Constant {
158             public Drop(Element[] e, HashSet<Sequence> and, HashSet<Sequence> not, boolean lame) {
159                 super(e, null, and, not);
160                 this.lame = lame;
161             }
162         }
163         static class Empty extends Sequence.Constant.Drop { public Empty() { super(new Element[] { }, null, null, false); } }
164     }
165
166     static class Singleton extends Sequence {
167         private final int idx;
168         public Singleton(Element e, HashSet<Sequence> and, HashSet<Sequence> not) { this(new Element[] { e }, 0, and, not); }
169         public Singleton(Element[] e, int idx, HashSet<Sequence> and, HashSet<Sequence> not) { super(e, and, not); this.idx = idx; }
170         public <T> Forest<T> postReduce(Token.Location loc, Forest<T>[] args) { return (Forest<T>)Forest.singleton(loc, args[idx], this); }
171     }
172
173     static class Unwrap extends Sequence {
174         private boolean[] drops;
175         public Unwrap(Element[] e, HashSet<Sequence> and, HashSet<Sequence> not)                  { super(e, and, not); this.drops = null; }
176         public Unwrap(Element[] e, boolean[] drops, HashSet<Sequence> and, HashSet<Sequence> not) { super(e, and, not); this.drops = drops; }
177         public <T> Forest<T> postReduce(Token.Location loc, Forest<T>[] args) {
178             if (drops==null) return Forest.create(loc, null, args, this, true, false);
179             int count = 0;
180             for(int i=0; i<drops.length; i++) if (!drops[i]) count++;
181             Forest<T>[] args2 = new Forest[count];
182             int j = 0;
183             for(int i=0; i<args.length; i++) if (!drops[i]) args2[j++] = args[i];
184             return Forest.create(loc, null, args2, this, true, false);            
185         }
186     }
187
188     static class RewritingSequence extends Sequence {
189         private final Object tag;
190         private final boolean[] drops;
191         private int count = 0;
192         public RewritingSequence(Object tag, Element[] e, HashSet<Sequence> and, HashSet<Sequence> not) { this(tag, e, null, and, not); }
193         public RewritingSequence(Object tag, Element[] e, boolean[] drops, HashSet<Sequence> and, HashSet<Sequence> not) {
194             super(e, and, not);
195             this.tag = tag;
196             this.drops = drops == null ? new boolean[e.length] : drops;
197             for(int i=0; i<this.drops.length; i++) if (!this.drops[i]) count++;
198         }
199         public <T> Forest<T> postReduce(Token.Location loc, Forest<T>[] args) {
200             Forest<T>[] args2 = new Forest[count];
201             int j = 0;
202             for(int i=0; i<args.length; i++) if (!drops[i]) args2[j++] = args[i];
203             return Forest.create(loc, (T)tag, args2, this, false, false);
204         }
205         public StringBuffer toString(StringBuffer sb, boolean spacing) {
206             int len = sb.length();
207             super.toString(sb, spacing);
208             len = sb.length()-len;
209             if (spacing) for(int i=0; i<50-len; i++) sb.append(' ');
210             sb.append(" => ");
211             sb.append(tag);
212             return sb;
213         }
214     }
215 }