X-Git-Url: http://git.megacz.com/?p=sbp.git;a=blobdiff_plain;f=src%2Fedu%2Fberkeley%2Fsbp%2FInput.java;h=bf0d50deb2e02f14ec73b0e88d1f9e1f6d0b3604;hp=c16947d24f18600ae7b0c4ee0bd0e76fa0fd1e49;hb=449c39e0dafd7c736bfcd8d56bbd08b7a99e25a4;hpb=3ee451bce342d4bb61ad6235ba57bdf817bfdd1a diff --git a/src/edu/berkeley/sbp/Input.java b/src/edu/berkeley/sbp/Input.java index c16947d..bf0d50d 100644 --- a/src/edu/berkeley/sbp/Input.java +++ b/src/edu/berkeley/sbp/Input.java @@ -16,6 +16,19 @@ public interface Input { /** returns the location the input stream is currently at */ public Location getLocation(); + + /** should return a short string describing where the input is coming from */ + public String getName(); + + /** + * Optional: If possible, this method will return a + * 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 maxLength characters long; + * typically ellipses will be inserted to perform truncation. + */ + public abstract String showRegion(Region r, int maxLength); /** a location (position) in the input stream -- between tokens */ public static interface Location extends Comparable { @@ -24,10 +37,29 @@ public interface Input { public Region createRegion(Location loc); public String toString(); + + /** the location following this one */ + public Location next(); + + /** the location preceding this one */ + public Location prev(); } /** a contiguous set of Locations */ public static interface Region /* implements Topology> */ { + + /** + * 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 getStart(); + + /** The location of the end of this region */ + public abstract Location getEnd(); + } }