X-Git-Url: http://git.megacz.com/?p=sbp.git;a=blobdiff_plain;f=src%2Fedu%2Fberkeley%2Fsbp%2FInput.java;h=13c45d49de0476210819bc76befe901ce5c7e653;hp=d19b20890411bc062eb51a8c49dc9b5b9f214b3c;hb=0ddfec9ac2783f59115205dc0f3806137265c59c;hpb=0e17670bcfa7b0fe8eb3a2cac81f4b080a09fc98 diff --git a/src/edu/berkeley/sbp/Input.java b/src/edu/berkeley/sbp/Input.java index d19b208..13c45d4 100644 --- a/src/edu/berkeley/sbp/Input.java +++ b/src/edu/berkeley/sbp/Input.java @@ -1,3 +1,5 @@ +// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license + package edu.berkeley.sbp; import java.io.*; import java.util.*; @@ -14,6 +16,18 @@ 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 + * <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 r); /** a location (position) in the input stream -- between tokens */ public static interface Location extends Comparable { @@ -22,10 +36,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(); + } }