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.syntax;
22  
23  import org.millscript.millscript.expr.PackageExpr;
24  
25  /**
26   * This class implements <code>package</code> syntax. This is used to declare
27   * the current package name.
28   *
29   * <p>
30   * <code>package &lt;expr&gt;</code>
31   * </p>
32   *
33   * <p>
34   * The package name expression is made up of names separated by periods. There
35   * is no restriction on the length of a package name. The name following the
36   * last period is referred to as the nickname for the package. It is the
37   * nickname that is used to refer to a specific pacakge within MillScript. The
38   * full name cannot be used as the period is used for function applications.
39   * </p>
40   *
41   * @see PackageExpr
42   */
43  public final class PackageSyntax extends PkgReaderSyntax {
44  
45      /**
46       * @see org.millscript.millscript.syntax.PrefixSyntaxInterface#prefix(java.lang.String, org.millscript.millscript.syntax.Parser)
47       */
48      @Override
49      public PackageExpr prefix( final String sym, final Parser parser ) {
50          return new PackageExpr( readPackageName( parser ) );
51      }
52  
53  }