checkpoint

darcs-hash:20060716073828-5007d-a5e673f18340193e45bd253285027ef11436f364.gz

diff --git a/TODO b/TODO
index f3b6476..7186baf 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,7 +2,8 @@ _____________________________________________________________________________
 Immediately
 
   - do Forest/Tree still need a Region?
-  - the unwrap bit in Forest makes it really hard to expose an API for forests
+  - Forest needs a "manual access" API
+      - the unwrap bit in Forest makes it really hard to expose an API for forests
 
   - evil problems with      (x y? z /ws)
   - ParseFailed, GSS, Walk, Parser, Sequence, Forest

diff --git a/src/edu/berkeley/sbp/Tree.java b/src/edu/berkeley/sbp/Tree.java
index 1b9ddfa..d2bfc4b 100644 (file)
--- a/src/edu/berkeley/sbp/Tree.java
+++ b/src/edu/berkeley/sbp/Tree.java
@@ -17,16 +17,22 @@ public class Tree<T>
     private final Tree<T>[]    children;
     private final boolean      lift;
 
+    /** the element at the head of the tree */
     public T                 head()        { return head; }
 
     private Tree<T> lifted() { return children[children.length-1]; }
 
+    /** the number of children the tree has */
     public int               numChildren() {
         return lift
             ? (children.length-1)+lifted().numChildren()
             : children.length;
     }
+
+    /** the tree's children */
     public Iterable<Tree<T>> children()    { return this; }
+
+    /** the tree's children */
     public Iterator<Tree<T>> iterator()    {
         return lift
             ? new ConcatenateIterator(new ArrayIterator(children, 0, children.length-1),
@@ -34,17 +40,19 @@ public class Tree<T>
             : new ArrayIterator(children);
     }
 
+    /** get the <tt>i</t>th child */
     public Tree<T> child(int i)  {
         return lift && i >= children.length-1
             ? children[children.length-1].child(i-(children.length-1))
             : children[i];
     }
 
+    /** get the input region that this tree was parsed from */
     public Input.Region    getRegion() { return location; }
 
     public Tree(Input.Region loc, T head)                     { this(loc, head, null); }
     public Tree(Input.Region loc, T head, Tree<T>[] children) { this(loc, head, children, false); }
-    public Tree(Input.Region loc, T head, Tree<T>[] children, boolean lift) {
+    Tree(Input.Region loc, T head, Tree<T>[] children, boolean lift) {
         this.location = loc;
         this.head = head;
         this.lift = lift && children != null && children.length > 0;