Sequence: cleanup, mostly inert
[sbp.git] / src / edu / berkeley / sbp / Sequence.java
index 975b2b1..2c36c8d 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license
+
 package edu.berkeley.sbp;
 import edu.berkeley.sbp.util.*;
 import edu.berkeley.sbp.*;
@@ -8,66 +10,90 @@ import java.lang.reflect.*;
 import java.lang.ref.*;
 
 /** <font color=green>juxtaposition; zero or more adjacent Elements; can specify a rewriting</font> */
-public abstract class Sequence extends Element implements Iterable<Element> {
+public abstract class Sequence implements Iterable<Element>, SequenceOrElement {
 
     protected final Element[] elements;
 
-    final HashSet<Sequence> hated  = new HashSet<Sequence>();
+    boolean needed_or_hated = false;
+    boolean in_a_union = false;
 
     final HashSet<Sequence> needs  = new HashSet<Sequence>();
     final HashSet<Sequence> hates  = new HashSet<Sequence>();
 
+    // FIXME: these are ugly -- migrate into Cache
+    HashMap<Sequence,Boolean> canNeed = new HashMap<Sequence,Boolean>();
+    HashMap<Sequence,Boolean> canKill = new HashMap<Sequence,Boolean>();
+
     final Position          firstp;
 
     Atom follow = null;
 
     // Static Constructors //////////////////////////////////////////////////////////////////////////////
 
-    abstract Sequence _clone();
-    Sequence dup() {
-        Sequence ret = _clone();
-        for(Sequence s : needs) { ret.needs.add(s); }
-        for(Sequence s : hates) { ret.hates.add(s); s.hated.add(ret); }
-        ret.follow = follow;
-        return ret;
-    }
-
-    /** the empty sequence (matches the empty string) */
-    public static final Sequence empty = new Sequence.Constant.Empty();
+    /** create a sequence of one element */
+    public static Sequence create(Element e) { return create(new Element[] { e }, 0); }
 
-    /** after matching the sequence, do not add anything to the output tree */
-    public static Sequence drop(Element[] e) { return new Constant.Drop(e); }
+    /** create a sequence which drops the result of all but one of its element */
+    public static Sequence create(Element[] e, int which) { return new Singleton(e, which); }
 
-    /** after matching the sequence, insert a constant into the output tree */
-    public static Sequence constant(Element[] e, Object o) { return new Constant(e, o); }
-
-    /** after matching the sequence, place the result of the <tt>idx</tt>th match in the output tree */
-    public static Sequence singleton(Element[] e, int idx) { return new Singleton(e, idx); }
-    public static Sequence singleton(Element e) { return singleton(new Element[] { e }, 0); }
+    /** create a sequence which always evaluates to a constant result  */
+    public static Sequence create(Element[] e, Object result) { return new Constant(e, result); }
 
     /**
-     *  after matching the sequence, create the specified output tree
-     *  @param tag   the tag for the output tree
-     *  @param e     the elements to match
-     *  @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
+     *  create a sequence (general form)
+     *  @param head   the head of the output tree
+     *  @param e      the elements to match
+     *  @param drop   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
+     *  @param foster if true, all children of the last child (ie
+     *                grandchildren) are promoted to children of this
+     *                node; this is very useful for matching repetitions
      **/
-    public static Sequence rewritingSequence(Object tag, Element[] e, boolean[] drops) {
-        return new RewritingSequence(tag, e, drops); }
+    public static Sequence create(Object head, Element[] e, boolean[] drop, boolean foster) {
+        return foster
+            ? new Unwrap(e, head, drop)
+            : new RewritingSequence(head, e, drop);
+    }
 
-    public static Sequence regionRewritingSequence(Functor<Input.Region,Object> tagfunctor, Element[] e, boolean[] drops) {
-        return new RegionRewritingSequence(tagfunctor, e, drops); }
+    /** return a new sequence identical to this one, but with a positive conjunct <tt>s</tt> */
+    public Sequence and(Sequence s) {
+        if (s.in_a_union)
+            throw new RuntimeException("you may not use a sequence as a conjunct if it belongs to a Union");
+        Sequence ret = dup();
+        ret.needs.add(s);
+        s.needed_or_hated=true;
+        return ret;
+    }
 
-    ////////////////////////////////////////////////////////////////////////////////
+    /** return a new sequence identical to this one, but with a negative conjunct <tt>s</tt> */
+    public Sequence andnot(Sequence s) {
+        if (s.in_a_union)
+            throw new RuntimeException("you may not use a sequence as a conjunct if it belongs to a Union");
+        Sequence ret = dup();
+        ret.hates.add(s);
+        s.needed_or_hated=true;
+        return ret;
+    }
 
-    public Sequence and(Sequence s) { Sequence ret = dup(); ret.needs.add(s); return ret; }
-    public Sequence not(Sequence s) { Sequence ret = dup(); ret.hates.add(s); s.hated.add(ret); return ret; }
+    /** return a new sequence identical to this one, but with a follow-set restricted to <tt>a</tt> */
     public Sequence followedBy(Atom a) { Sequence ret = dup(); ret.follow = a; return ret; }
 
-    public Iterable<Sequence> needs() { return needs; }
-    public Iterable<Sequence> hates() { return hates; }
+    ////////////////////////////////////////////////////////////////////////////////
+
+    abstract Sequence _clone();
+    private Sequence dup() {
+        Sequence ret = _clone();
+        for(Sequence s : needs) { ret.needs.add(s); }
+        for(Sequence s : hates) { ret.hates.add(s); }
+        ret.follow = follow;
+        return ret;
+    }
+
+    Iterable<Sequence> needs() { return needs; }
+    Iterable<Sequence> hates() { return hates; }
 
     Position firstp() { return firstp; }
+    Position lastp() { return firstp().last(); }
 
     public Iterator<Element> iterator()    { return new ArrayIterator<Element>(elements); }
     protected Sequence(Element[] elements) {
@@ -77,10 +103,10 @@ public abstract class Sequence extends Element implements Iterable<Element> {
 
     // DO NOT MESS WITH THE FOLLOWING LINE!!!
     private Forest.Many epsilonForm = null;
-    Forest epsilonForm() {
+    Forest epsilonForm(Input.Region loc) {
         if (epsilonForm!=null) return epsilonForm;
         epsilonForm = new Forest.Many();
-        epsilonForm.merge(firstp().rewrite(null, false));
+        epsilonForm.merge(firstp().rewrite(loc, false));
         return epsilonForm;
     }
 
@@ -92,22 +118,38 @@ public abstract class Sequence extends Element implements Iterable<Element> {
     /** the imaginary position before or after an element of a sequence; corresponds to an "LR item" */
     class Position implements IntegerMappable {
 
+        public int ord = -1;
+        public int compareTo(Position p, Walk.Cache cache) {
+            Position position = this;
+            Position rposition = p;
+            int ret = 0;
+            if (Reduction.canKill(cache, position, rposition) &&
+                Reduction.canKill(cache, rposition, position)) throw new Error();
+            if      (Reduction.canKill(cache, position,   rposition)) ret =  1;
+            else if (Reduction.canKill(cache, rposition, position)) ret = -1;
+            if      (Reduction.canNeed(cache, position,   rposition)) ret =  1;
+            else if (Reduction.canNeed(cache, rposition, position)) ret = -1;
+            return ret;
+        }
+
         private Forest zero = null;
-        public Forest zero() {
+        public Forest zero(Input.Region reg) {
             if (zero != null) return zero;
             if (pos > 0) throw new Error();
-            return zero = rewrite(null);
+            return zero = rewrite(reg);
         }
 
 
                 final int      pos;
         private final Position next;
+        private final Position prev;
                 final Forest[] holder;
         
         private Position(int pos) {
             this.pos      = pos;
             this.next     = pos==elements.length ? null : new Position(pos+1);
             this.holder   = new Forest[elements.length];
+            this.prev     = prev;
         }
 
         boolean isFirst() { return pos==0; }
@@ -123,15 +165,17 @@ public abstract class Sequence extends Element implements Iterable<Element> {
 
         /** true iff this Position is the last one in the sequence */
         public boolean isLast() { return next()==null; }
+        public Position last() { return isLast() ? this : next().last(); }
+        public Position prev() { return prev; }
 
         // Position /////////////////////////////////////////////////////////////////////////////////
 
         final <T> Forest<T> rewrite(Input.Region loc) { return rewrite(loc, true); }
         private final <T> Forest<T> rewrite(Input.Region loc, boolean epsilonCheck) {
-            if (epsilonCheck && this==firstp()) return epsilonForm();
+            if (epsilonCheck && this==firstp()) return epsilonForm(loc);
             for(int i=0; i<pos; i++) if (holder[i]==null) throw new Error("realbad " + i);
             for(int i=pos; i<elements.length; i++) {
-                if (holder[i]==null) holder[i] = elements[i].epsilonForm();
+                if (holder[i]==null) holder[i] = elements[i].epsilonForm(loc);
                 if (holder[i]==null) throw new Error("bad " + i);
             }
             Forest<T> ret = Sequence.this.postReduce(loc, holder, this);
@@ -162,13 +206,21 @@ public abstract class Sequence extends Element implements Iterable<Element> {
     StringBuffer toString(StringBuffer sb) { return toString(sb, true); }
     StringBuffer toString(StringBuffer sb, boolean spacing) {
         for(int i=0; i<elements.length; i++) {
-            sb.append(elements[i].toString());
+            sb.append(elements[i]+"");
             sb.append(' ');
         }
         if (follow != null) {
             sb.append("-> ");
             sb.append(follow);
         }
+        for(Sequence s : needs) {
+            sb.append("& ");
+            sb.append(s);
+        }
+        for(Sequence s : hates) {
+            sb.append("&~ ");
+            sb.append(s);
+        }
         return sb;
     }
 
@@ -177,18 +229,15 @@ public abstract class Sequence extends Element implements Iterable<Element> {
 
     static class Constant extends Sequence {
         private final Object result;
-        public Constant(Element[] e, Object result) { super(e); this.result = result; }
+        public Constant(Element[] e, Object result) {
+            super(e);
+            if (result==null) throw new Error("constant sequences may not have result==null");
+            this.result = result;
+        }
         Sequence _clone() { return new Constant(elements, result); }
         public <T> Forest<T> postReduce(Input.Region loc, Forest<T>[] args, Position p) {
             return (Forest<T>)Forest.create(loc, result, null, false);
         }
-        static class Drop extends Constant {
-            Sequence _clone() { return new Drop(elements); }
-            public Drop(Element[] e) { super(e, null); }
-        }
-        static class Empty extends Sequence.Constant.Drop {
-            Sequence _clone() { return new Empty(); }
-            public Empty() { super(new Element[] { }); } }
     }
 
     static class Singleton extends Sequence {
@@ -199,13 +248,12 @@ public abstract class Sequence extends Element implements Iterable<Element> {
         Sequence _clone() { return new Singleton(elements,idx); }
     }
 
-    public static Unwrap unwrap(Element[] e, Object tag, boolean[] drops) { return new Unwrap(e, tag, drops); }
     static class Unwrap extends Sequence {
         private boolean[] drops;
         private final Object tag;
-        public Unwrap(Element[] e, Object tag)                  { super(e); this.drops = null; this.tag = tag; }
+        public Unwrap(Element[] e, Object tag)                  { this(e, tag, null); }
         public Unwrap(Element[] e, Object tag, boolean[] drops) { super(e); this.drops = drops; this.tag = tag; }
-        Sequence _clone() { return new Unwrap(elements, drops); }
+        Sequence _clone() { return new Unwrap(elements, tag, drops); }
         public <T> Forest<T> postReduce(Input.Region loc, Forest<T>[] args, Position p) {
             for(int i=0; i<args.length; i++) if (args[i]==null) throw new Error();
             if (drops==null) return Forest.create(loc, (T)tag, args, true);
@@ -218,30 +266,15 @@ public abstract class Sequence extends Element implements Iterable<Element> {
         }
     }
 
-
-
-    static class RegionRewritingSequence extends RewritingSequence {
-        private Functor<Input.Region, Object> tagf;
-        public RegionRewritingSequence(Functor<Input.Region,Object> tagfunctor, Element[] e, boolean[] drops) {
-            super(null, e, drops);
-            this.tagf = tagfunctor;
-        }
-        public <T> Forest<T> postReduce(Input.Region loc, Forest<T>[] args, Position p) {
-            this.tag = tagf.invoke(loc);
-            Forest<T> ret = super.postReduce(loc, args, p);
-            this.tag = null;
-            return ret;
-        }
-    }
-
     static class RewritingSequence extends Sequence {
-        /*private*/public /*final*/ Object tag;
+        private Object tag;
         private final boolean[] drops;
         private int count = 0;
         Sequence _clone() { return new RewritingSequence(tag, elements, drops); }
         public RewritingSequence(Object tag, Element[] e) { this(tag, e, null); }
         public RewritingSequence(Object tag, Element[] e, boolean[] drops) {
             super(e);
+            if (tag==null) throw new Error();
             this.tag = tag;
             this.drops = drops == null ? new boolean[e.length] : drops;
             for(int i=0; i<this.drops.length; i++) if (!this.drops[i]) count++;
@@ -264,40 +297,4 @@ public abstract class Sequence extends Element implements Iterable<Element> {
         }
     }
 
-    // Repeat //////////////////////////////////////////////////////////////////////////////
-
-    /** repeat zero or one times */
-    public  static Element maybe(Element e)                             { return new Repeat(e, true, false, null, null); }
-    public  static Element maybe(Element e, Object tag)                 { return new Repeat(e, true, false, null, tag); }
-    /** repeat zero or more times */
-    public  static Element many0(Element e)                             { return new Repeat(e, true, true, null, null); }
-    public  static Element many0(Element e, Object tag)                 { return new Repeat(e, true, true, null, tag); }
-    /** repeat zero or more times, separated by <tt>sep</tt> */
-    public  static Element many0(Element e, Element sep)                { return new Repeat(e, true, true, sep, null); }
-    public  static Element many0(Element e, Element sep, Object tag)    { return new Repeat(e, true, true, sep, tag); }
-    /** repeat one or more times */
-    public  static Element many1(Element e)                             { return new Repeat(e, false, true, null, null); }
-    public  static Element many1(Element e, Object tag)                 { return new Repeat(e, false, true, null, tag); }
-    /** repeat one or more times, separated by <tt>sep</tt> */
-    public  static Element many1(Element e, Element sep)                { return new Repeat(e, false, true, sep, null); }
-    public  static Element many1(Element e, Element sep, Object tag)    { return new Repeat(e, false, true, sep, tag); }
-
-    /** repeat zero or more times, matching a maximal sequence of atoms */
-    public  static Element maximal0(Atom e)                             { return new Repeat.Maximal(e, true, true, null); }
-    public  static Element maximal0(Atom e, Object tag)                 { return new Repeat.Maximal(e, true, true, tag); }
-    /** repeat one or more times, matching a maximal sequence of atoms */
-    public  static Element maximal1(Atom e)                             { return new Repeat.Maximal(e, false, true, null); }
-    public  static Element maximal1(Atom e, Object tag)                 { return new Repeat.Maximal(e, false, true, tag); }
-    /** repeat one or more times, separated by an atom <tt>sep</tt>, matching a maximal sequence */
-    public  static Element maximal1(Element e, Atom sep)                { return new Repeat.Maximal(e, false, true, sep, null); }
-    public  static Element maximal1(Element e, Atom sep, Object tag)    { return new Repeat.Maximal(e, false, true, sep, tag); }
-
-    public  static Element repeatMaximal(Atom e, boolean zero, boolean many, Object tag) {
-        return new Repeat.Maximal(e, zero, many, tag); }
-    public  static Element repeatMaximal(Element e, boolean zero, boolean many, Atom sep, Object tag) {
-        return new Repeat.Maximal(e, zero, many, sep, tag); }
-    public  static Element repeat(Element e, boolean zero, boolean many, Object tag) {
-        return new Repeat(e, zero, many, tag); }
-    public  static Element repeat(Element e, boolean zero, boolean many, Element sep, Object tag) {
-        return new Repeat(e, zero, many, sep, tag); }
 }