X-Git-Url: http://git.megacz.com/?p=sbp.git;a=blobdiff_plain;f=src%2Fedu%2Fberkeley%2Fsbp%2FInput.java;h=ac2c486e94db2cef4490805c1de49911b62227c1;hp=13c45d49de0476210819bc76befe901ce5c7e653;hb=HEAD;hpb=dcf8aafe73cbd899d8aebd2ef92df5a75a2c2b69

diff --git a/src/edu/berkeley/sbp/Input.java b/src/edu/berkeley/sbp/Input.java
index 13c45d4..ac2c486 100644
--- a/src/edu/berkeley/sbp/Input.java
+++ b/src/edu/berkeley/sbp/Input.java
@@ -1,35 +1,38 @@
-// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license
+// (C) 2006-2007 all rights reserved; see LICENSE file for BSD-style license
 
 package edu.berkeley.sbp;
 import java.io.*;
 import java.util.*;
-import java.lang.reflect.*;
-import java.lang.ref.*;
-import edu.berkeley.sbp.*;
 import edu.berkeley.sbp.util.*;
 
+// FEATURE: Region implements Topology<Location<Tok>>
+
 /** <font color=purple>a stream of <tt>Token</tt>s to be parsed</font> */
 public interface Input<Token> {
 
-    /** returns the token just beyond the current location and advances beyond it */
-    public Token           next() throws IOException;
-
-    /** returns the location the input stream is currently at */
+    /** the current location within the input stream */
     public Location<Token> getLocation();
-    
-    /** should return a short string describing where the input is coming from */
+
+    /** returns the token just beyond the current location and advances beyond it */
+    public Token next() throws IOException;
+   
+    /** a short string describing where the input is coming from, such as a filename */
     public String getName();
 
+    /** might called by Parser when it is done with the input */
+    public void close();
+
     /**
      *  <b>Optional:</b> <i>If possible</i>, this method will return a
-     *  <60 char long rendering of the input region (for example, if
-     *  the input is a region of characters, it would be those
-     *  characters, possibly with ellipses in the middle to truncate
-     *  the length) -- otherwise, returns null.
+     *  rendering of the input region (for example, if the input is a
+     *  region of characters, it would be those characters) --
+     *  otherwise, returns null.  In any case, the string returned
+     *  will be no more than <tt>maxLength</tt> characters long;
+     *  typically ellipses will be inserted to perform truncation.
      */
-    public abstract String showRegion(Region<Token> r);
+    public abstract String showRegion(Region<Token> r, int maxLength);
 
-    /** <font color=purple>a location (position) in the input stream -- <i>between tokens</i></font> */
+    /** <font color=purple>a location (position) in the input stream <i>between tokens</i></font> */
     public static interface Location<Token> extends Comparable<Location> {
 
         /** return the region between this location and <tt>loc</tt> */
@@ -45,12 +48,9 @@ public interface Input<Token> {
     }
 
     /** <font color=purple>a contiguous set of <tt>Location</tt>s</font> */
-    public static interface Region<Token> /* implements Topology<Location<Tok>> */ {
+    public static interface Region<Token> {
 
-        /**
-         *  the toString() method of Region should return a <80char
-         *  "rendition" of the input region, if possible
-         */
+        /** should return less than 80 chars if possible */
         public abstract String toString();
         
         /** The location of the start of this region */