checkpoint harmony
[sbp.git] / src / edu / berkeley / sbp / Union.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 /** an element which can produce one of several alternatives */
11 public class Union extends Element implements Iterable<Sequence> {
12
13     final String shortForm;
14     final boolean synthetic;
15     private final List<Sequence> alternatives = new ArrayList<Sequence>();
16
17     public Iterator<Sequence> iterator() { return alternatives.iterator(); }
18     public boolean contains(Sequence s) { return alternatives.contains(s); }
19
20     Topology toAtom() {
21         if (alternatives.size()==0) throw new RuntimeException("cannot build an Atom from a Union with no productions");
22         Topology ret = null;
23         for(Sequence s : this) {
24             Topology a = s.toAtom();
25             if (ret==null) ret = a;
26             else           ret = ret.union(a);
27         }
28         if (ret==null) throw new RuntimeException("confusion on " + this);
29         return ret;
30     }
31
32     /** adds an alternative */
33     public void add(Sequence s) {
34         alternatives.add(s);
35         if (/*!synthetic &&*/ shortForm!=null
36             //&& Character.isUpperCase(shortForm.charAt(0))
37             )
38             s.setName(toString());
39     }
40
41     /**
42      *  Since every cycle in a non-degenerate grammar contains at
43      *  least one Union, every instance of this class must be able to
44      *  display itself in both "long form" (list of the long forms of
45      *  its alternatives) and "short form" (some abbreviation).
46      *
47      *  @param shortForm the "short form" display; usually 
48      *  @param synthetic if true, this Union's "long form" is "obvious" and should not be displayed when printing the grammar
49      */
50     public Union(String shortForm) { this(shortForm, false); }
51     public Union(String shortForm, boolean synthetic) {
52         this.shortForm = shortForm;
53         this.synthetic = synthetic;
54     }
55
56     public static Union epsilon = new Union("()");
57     static { epsilon.add(Sequence.empty); }
58
59     private Forest.Ref epsilonForm = null;
60     Forest epsilonForm() {
61         if (epsilonForm != null) return epsilonForm;
62         epsilonForm = new Forest.Ref();
63         for(Sequence s : this)
64             if (s.possiblyEpsilon(null))
65                 epsilonForm.merge(s.epsilonForm());
66         return epsilonForm;
67     }
68
69     // Display //////////////////////////////////////////////////////////////////////////////
70
71     public String toString() { return shortForm; }
72     private static String pad(int i,String s) { return s.length() >= i ? s : pad(i-1,s)+" "; }
73     public void toString(StringBuffer sb) {
74         if (synthetic) return;
75         boolean first = true;
76         if (alternatives.size()==0) {
77             sb.append(pad(15, shortForm) + "::= ");
78         } else for(Sequence s : this) {
79             sb.append(pad(15, first ? shortForm : "") + (first ? "::= " : "  | "));
80             first = false;
81             sb.append(s.toString());
82             sb.append('\n');
83         }
84         sb.append('\n');
85     }
86
87     // SubUnion //////////////////////////////////////////////////////////////////////////////
88
89     /** FIXME this is kind of a hack */
90     public class Subset extends Union {
91         private final Set<Sequence> exclude;
92         public Subset(String shortForm, Set<Sequence> exclude) { super(shortForm, true); this.exclude = exclude; }
93         public Iterator<Sequence> iterator() {
94             final Iterator<Sequence> it = Union.this.iterator();
95             return new Iterator<Sequence>() {
96                 private Sequence next = it.hasNext() ? it.next() : null;
97                 public boolean hasNext() { return next != null; }
98                 public Sequence next() {
99                     Sequence ret = next;
100                     do {
101                         next = it.hasNext() ? it.next() : null;
102                     } while (next != null && (next instanceof Sequence) && exclude.contains((Sequence)next));
103                     return ret;
104                 }
105                 public void remove() { throw new Error(); }
106             };
107         }
108     }
109
110 }