001: /*
002: * Java HTML Tidy - JTidy
003: * HTML parser and pretty printer
004: *
005: * Copyright (c) 1998-2000 World Wide Web Consortium (Massachusetts
006: * Institute of Technology, Institut National de Recherche en
007: * Informatique et en Automatique, Keio University). All Rights
008: * Reserved.
009: *
010: * Contributing Author(s):
011: *
012: * Dave Raggett <dsr@w3.org>
013: * Andy Quick <ac.quick@sympatico.ca> (translation to Java)
014: * Gary L Peskin <garyp@firstech.com> (Java development)
015: * Sami Lempinen <sami@lempinen.net> (release management)
016: * Fabrizio Giustina <fgiust at users.sourceforge.net>
017: *
018: * The contributing author(s) would like to thank all those who
019: * helped with testing, bug fixes, and patience. This wouldn't
020: * have been possible without all of you.
021: *
022: * COPYRIGHT NOTICE:
023: *
024: * This software and documentation is provided "as is," and
025: * the copyright holders and contributing author(s) make no
026: * representations or warranties, express or implied, including
027: * but not limited to, warranties of merchantability or fitness
028: * for any particular purpose or that the use of the software or
029: * documentation will not infringe any third party patents,
030: * copyrights, trademarks or other rights.
031: *
032: * The copyright holders and contributing author(s) will not be
033: * liable for any direct, indirect, special or consequential damages
034: * arising out of any use of the software or documentation, even if
035: * advised of the possibility of such damage.
036: *
037: * Permission is hereby granted to use, copy, modify, and distribute
038: * this source code, or portions hereof, documentation and executables,
039: * for any purpose, without fee, subject to the following restrictions:
040: *
041: * 1. The origin of this source code must not be misrepresented.
042: * 2. Altered versions must be plainly marked as such and must
043: * not be misrepresented as being the original source.
044: * 3. This Copyright notice may not be removed or altered from any
045: * source or altered source distribution.
046: *
047: * The copyright holders and contributing author(s) specifically
048: * permit, without fee, and encourage the use of this source code
049: * as a component for supporting the Hypertext Markup Language in
050: * commercial products. If you use this source code in a product,
051: * acknowledgment is not required but would be appreciated.
052: *
053: */
054: package org.w3c.tidy;
055:
056: /**
057: * Input Stream.
058: * @author Dave Raggett <a href="mailto:dsr@w3.org">dsr@w3.org </a>
059: * @author Andy Quick <a href="mailto:ac.quick@sympatico.ca">ac.quick@sympatico.ca </a> (translation to Java)
060: * @author Fabrizio Giustina
061: * @version $Revision: 1.13 $ ($Author: fgiust $)
062: */
063:
064: public interface StreamIn {
065:
066: /**
067: * end of stream char.
068: */
069: int END_OF_STREAM = -1;
070:
071: /**
072: * Getter for <code>curcol</code>.
073: * @return Returns the curcol.
074: */
075: int getCurcol();
076:
077: /**
078: * Getter for <code>curline</code>.
079: * @return Returns the curline.
080: */
081: int getCurline();
082:
083: /**
084: * reads a char from the stream.
085: * @return char
086: */
087: int readCharFromStream();
088:
089: /**
090: * Read a char.
091: * @return char
092: */
093: int readChar();
094:
095: /**
096: * Unget a char.
097: * @param c char
098: */
099: void ungetChar(int c);
100:
101: /**
102: * Has end of stream been reached?
103: * @return <code>true</code> if end of stream has been reached
104: */
105: boolean isEndOfStream();
106:
107: /**
108: * Setter for lexer instance (needed for error reporting).
109: * @param lexer Lexer
110: */
111: void setLexer(Lexer lexer);
112:
113: }
|