View Javadoc

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.expr;
22  
23  /**
24   * This class implements an index expression. An index expression doesn't
25   * have its own actions, rather it wraps to the index function.
26   *
27   * @see org.millscript.millscript.syntax.IndexSyntax
28   * @see org.millscript.millscript.functions.IndexFunction
29   */
30  public final class IndexExpr extends FakeExpr implements OneResult /* defensive */ {
31  
32      /**
33       * Returns an expression applying the index function to the specified left
34       * and right hand side expressions.
35       *
36       * @param   lhs the expression returning the object to index
37       * @param   rhs an expression returning the object to index with
38       * @return  an {@link ApplyExpr} applying the
39       *          {@link org.millscript.millscript.functions.IndexFunction} to
40       *          the specified left and right hand side expressions
41       */
42      public static ApplyExpr make( final Expr lhs, final Expr rhs ) {
43          return (
44              new ApplyExpr(
45                  new NameExpr( "indexSequence" ),
46                  CommaExpr.make( lhs, rhs )
47              )
48          );
49      }
50  
51  }