+// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license
+
package edu.berkeley.sbp;
import java.io.*;
import java.util.*;
import edu.berkeley.sbp.*;
import edu.berkeley.sbp.util.*;
-/** a stream of tokens to be parsed */
+/** <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 */
/** returns the location the input stream is currently at */
public Location<Token> getLocation();
- /** a location <i>between tokens<i> in the input stream */
- public static interface Location<Tok> extends Comparable<Location> {
+ /**
+ * <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.
+ */
+ public abstract String showRegion(Region<Token> r);
+
+ /** <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> */
+ public Region<Token> createRegion(Location<Token> loc);
+
public String toString();
- public Region<Tok> createRegion(Location<Tok> loc);
+
+ /** the location following this one */
+ public Location next();
+
+ /** the location preceding this one */
+ public Location prev();
+ }
+
+ /** <font color=purple>a contiguous set of <tt>Location</tt>s</font> */
+ public static interface Region<Token> /* implements Topology<Location<Tok>> */ {
+
+ /**
+ * the toString() method of Region should return a <80char
+ * "rendition" of the input region, if possible
+ */
+ public abstract String toString();
+
+ /** The location of the start of this region */
+ public abstract Location<Token> getStart();
+
+ /** The location of the end of this region */
+ public abstract Location<Token> getEnd();
+
}
- public static interface Region<Tok> /* implements Topology<Location<Tok>> */ { }
}