1 ////////////////////////////////////////////////////////////////////////////////
2 // MillScript: an Open Spice interpreter and batch website creation tool
3 // Copyright (C) 2001-2004 Open World Ltd
4 //
5 // This file is part of MillScript.
6 //
7 // MillScript is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU General Public License as published by the Free
9 // Software Foundation; either version 2 of the License, or (at your option)
10 // any later version.
11 //
12 // MillScript is distributed in the hope that it will be useful, but WITHOUT
13 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 // more details.
16 //
17 // You should have received a copy of the GNU General Public License along with
18 // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19 // Place, Suite 330, Boston, MA 02111-1307 USA
20 ////////////////////////////////////////////////////////////////////////////////
21 package org.millscript.millscript.syntax;
22
23 import org.millscript.millscript.expr.Expr;
24
25 /**
26 * The PrefixSyntaxInterface interface should be implemented by any class which
27 * provides a piece of prefix syntax. Prefix syntax is that which preceeds the
28 * expression it operates on. An instance of this class may be responsible for
29 * more than one symbol, e.g in the case of <code>if</code> and
30 * <code>unless</code>, which have the same syntax.
31 */
32 public interface PrefixSyntaxInterface {
33
34 /**
35 * Parse the syntax for the specified symbol, using the specified
36 * <code>Parser</code>. The symbol is specified because different symbols
37 * may share the same syntax, but result in slightly different expressions.
38 * The <code>Parser</code> is supplied as the source to parse from.
39 *
40 * @param sym the symbol to parse this syntax for
41 * @param parser Parser to parse from, i.e. the source to parse from
42 * @return an expression for this syntax
43 */
44 Expr prefix( final String sym, final Parser parser );
45
46 }