org.millscript.millscript.syntax
Class XMLCommentSyntax

java.lang.Object
  org.millscript.millscript.syntax.Syntax
      org.millscript.millscript.syntax.PrefixSyntax
          org.millscript.millscript.syntax.XMLCommentSyntax

All Implemented Interfaces:

PrefixSyntaxInterface

public final class XMLCommentSyntax
extends PrefixSyntax

This class implements XML comment syntax. An XML comment is not a valid MillScript comment, it is a valid datatype, whereas a MillScript comment would be discarded.

<-- (%p|.)* -->

The contents of an XML comment are treated like a special multi-line String in MillScript. This allows easier inclusion of JavaScript code within MillScript files. The XML comment are read in just the same way as a String, so all the same escape sequences are available. XML comments can also be formatted via the format function, hence be careful with "%p"s.

See Also:

CommaExpr, ConstantExpr, XMLExpr

Constructor Summary

XMLCommentSyntax()

Method Summary

Expr	prefix(java.lang.String sym, Parser parser) Parse the syntax for the specified symbol, using the specified Parser.
Expr	readXMLComment(Parser parser) Parses an XML comment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLCommentSyntax

public XMLCommentSyntax()

Method Detail

readXMLComment

public Expr readXMLComment(Parser parser)

Parses an XML comment. This is done by informing the parser we're going to read an XML comment, and then reading to the closing character sequence.

Parameters:

parser - the Parser to parse XML from

Returns:

a ConstantExpr for the parsed syntax

prefix

public Expr prefix(java.lang.String sym,
                   Parser parser)

Description copied from interface: PrefixSyntaxInterface

Parse the syntax for the specified symbol, using the specified Parser. The symbol is specified because different symbols may share the same syntax, but result in slightly different expressions. The Parser is supplied as the source to parse from.

Specified by:

prefix in interface PrefixSyntaxInterface

Specified by:

prefix in class PrefixSyntax

Parameters:

sym - the symbol to parse this syntax for

parser - Parser to parse from, i.e. the source to parse from

Returns:

an expression for this syntax

See Also:

PrefixSyntaxInterface.prefix(java.lang.String, org.millscript.millscript.syntax.Parser)