01: /*=============================================================================
02: * Copyright Texas Instruments 2000. All Rights Reserved.
03: *
04: * This program is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2 of the License, or (at your option) any later version.
08: *
09: * This program is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: *
18: * $ProjectHeader: OSCRIPT 0.155 Fri, 20 Dec 2002 18:34:22 -0800 rclark $
19: */
20:
21: package oscript;
22:
23: import oscript.syntaxtree.Node;
24:
25: /* XXX TODO: change API to:
26: * public Node parse( AbstractFile file, Value desc );
27: */
28:
29: /**
30: * An abstraction for the parser, with is the entity that converts an input
31: * source to a {@link oscript.syntaxtree.Node}.
32: *
33: * @author Rob Clark (rob@ti.com)
34: * <!--$Format: " * @version $Revision$"$-->
35: * @version 1.3
36: */
37: public interface Parser {
38: /**
39: * Get the file extension for file type to handle, eg. <code>os</code>. This
40: * is used to determine which parser to use for which file to parse.
41: *
42: * @return the file extension
43: */
44: public String getExtension();
45:
46: /**
47: * Convert a file to Node.
48: *
49: * @param file the file to parse
50: * @return the parsed syntaxtree
51: */
52: public Node parse(oscript.fs.AbstractFile file)
53: throws oscript.parser.ParseException, java.io.IOException;
54: }
55:
56: /*
57: * Local Variables:
58: * tab-width: 2
59: * indent-tabs-mode: nil
60: * mode: java
61: * c-indentation-style: java
62: * c-basic-offset: 2
63: * eval: (c-set-offset 'substatement-open '0)
64: * End:
65: */
|