View Javadoc

1   ////////////////////////////////////////////////////////////////////////////////
2   // MillScript: an Open Spice interpreter and batch website creation tool
3   // Copyright (C) 2005 Kevin Rogers
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.loaders;
22  
23  import org.millscript.millscript.expr.ConstantExpr;
24  import org.millscript.millscript.expr.IndexExpr;
25  import org.millscript.millscript.expr.NameExpr;
26  
27  /**
28   * This class compiles a shortcut argument element in a MillScript XHTML
29   * template. A shortcut argument element has a name begining with
30   * <code>arg</code> and has a single digit after that, e.g. <code>arg1</code>
31   * is a shortcut for <code>&lt;arg n="1" /&gt;</code>.
32   */
33  public class ShortcutArgName implements SpecialTemplateName {
34  
35      /**
36       * The argument number.
37       */
38      private final Integer argumentNumber;
39  
40      /**
41       * The loader we will insert our expressions into.
42       */
43      private final BasicTemplateLoader basicTemplateLoader;
44  
45      /**
46       * Constructs a new shortcut argument element handler, to insert
47       * expressions for the specified argument number into the specified loader.
48       *
49       * @param btl   the loader to insert expressions into
50       * @param n the argument number of this shortcut
51       */
52      public ShortcutArgName( final BasicTemplateLoader btl, final int n ) {
53          this.argumentNumber = new Integer( n );
54          this.basicTemplateLoader = btl;
55      }
56  
57      /**
58       * @see org.millscript.millscript.loaders.SpecialTemplateName#handle()
59       */
60      public void handle() {
61          // Make the Expr for this XML element and push it into the parent
62          // elements body.
63          this.basicTemplateLoader.tokenVisitor.parentTokenVisitor.pushChildElement(
64              IndexExpr.make(
65                  new NameExpr( "arg" ),
66                  new ConstantExpr(
67                      this.argumentNumber
68                  )
69              )
70          );
71      }
72  
73  }