Union.java: visibility fixes

[sbp.git] / src / edu / berkeley / sbp / Union.java

diff --git a/src/edu/berkeley/sbp/Union.java b/src/edu/berkeley/sbp/Union.java
index 484616d..474a542 100644 (file)
--- a/src/edu/berkeley/sbp/Union.java
+++ b/src/edu/berkeley/sbp/Union.java
@@ -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.*;
@@ -7,63 +9,89 @@ import java.util.*;
 import java.lang.reflect.*;
 import java.lang.ref.*;
 
-/** an element which can produce one of several alternatives */
+/**
+ *  <font color=green>an element which can produce one of several alternatives</font>.
+ *  <p>
+ *
+ *  Unlike the other Elements, Union is not immutable once
+ *  constructed.  To simulate this desirable feature, it is immutable
+ *  <i>once examined</i> by taking its iterator or calling contains().
+ */
 public class Union extends Element implements Iterable<Sequence> {
 
-    private final String name;
+    private final String  name;
     private final boolean synthetic;
+    private boolean viewed = false;
+
     private final List<Sequence> alternatives = new ArrayList<Sequence>();
 
+    public Union(String name) { this(name, false); }
+
     /**
      *  Since every cycle in a non-degenerate grammar contains at
      *  least one Union, every instance of this class must be able to
      *  display itself in both "long form" (list of the long forms of
-     *  its alternatives) and "short form" (some abbreviation).
+     *  its alternatives) and "short form" (some name).
      *
-     *  @param shortForm the "short form" display; usually 
+     *  @param shortForm the "short form" display; for display purposes only
      *  @param synthetic if true, this Union's "long form" is "obvious" and should not be displayed when printing the grammar
      */
-    public Union() { this(null, false); }
-    public Union(String name) { this(name, false); }
     public Union(String name, boolean synthetic) {
         this.name = name;
         this.synthetic = synthetic;
     }
 
-    public Iterator<Sequence> iterator() { return alternatives.iterator(); }
-    public boolean contains(Sequence s) { return alternatives.contains(s); }
+    public boolean contains(Sequence s) {
+        viewed = true;
+        return alternatives.contains(s);
+    }
+
+    /** iterator over this Union's Sequences */
+    public Iterator<Sequence> iterator() {
+        viewed = true;
+        return alternatives.iterator();
+    }
 
     /** adds an alternative */
     public void add(Sequence s) {
+        /*
+          FIXME
+        if (viewed)
+            throw new RuntimeException("attempt to add a Sequence to a Union that has already been examined:\n  "+this);
+        */
+        if (alternatives.contains(s)) return;
         alternatives.add(s);
+    }
 
-        // FIXME: does this make sense?
-        for(Sequence n : s.needs) add(n);
-        for(Sequence n : s.hates) add(n);
+    /** adds a one-element sequence */
+    public void add(Element e) {
+        add(Sequence.create(e));
     }
 
+
     // Epsilon Form //////////////////////////////////////////////////////////////////////////////
 
     // FIXME
-    private Forest.Many epsilonForm = null;
-    Forest epsilonForm() {
-        if (epsilonForm != null) return epsilonForm;
-        epsilonForm = new Forest.Many();
+    //private Forest.Many epsilonForm = null;
+    Forest epsilonForm(Input.Region loc) {
+        //if (epsilonForm != null) return epsilonForm;
+        Forest.Many epsilonForm = new Forest.Many();
         for(Sequence s : this) {
             // FIXME FIXME FIXME
             if (new Walk.Cache().possiblyEpsilon(s))
-                epsilonForm.merge(s.epsilonForm());
+                epsilonForm.merge(s.epsilonForm(loc));
         }
         return epsilonForm;
     }
 
+
     // Display //////////////////////////////////////////////////////////////////////////////
 
-    public String getName() {
-        if (name != null) return name;
-        return "(anon_union)";
-    }
+    boolean isSynthetic() { return synthetic; }
+    String getName()      { return name==null ? "(anon_union)" : name; }
+
     public String toString() {
+        viewed = true;
         if (name != null) return name;
         StringBuffer sb = new StringBuffer();
         sb.append("(");
@@ -71,7 +99,10 @@ public class Union extends Element implements Iterable<Sequence> {
         sb.append(")");
         return sb.toString();
     }
+
+    /** display this union in long/expanded form */
     public StringBuffer toString(StringBuffer sb) {
+        viewed = true;
         if (synthetic) return sb;
         boolean first = true;
         String before = StringUtil.pad(15, getName()) + " = ";
@@ -87,9 +118,9 @@ public class Union extends Element implements Iterable<Sequence> {
     }
     
     private void bodyToString(StringBuffer sb, String before, String between) {
+        viewed = true;
         boolean first = true;
         for(Sequence s : this) {
-            if (s.lame) continue;
             // FIXME: what to do here about printing out negated sequences?
             sb.append(first ? before : between);
             first = false;