//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
// PLEASE DO NOT EDIT WITHOUT THE EXPLICIT CONSENT OF THE AUTHOR! \\
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
package hlt.language.syntax;
import hlt.language.util.ArrayList;
import hlt.language.util.IntArrayList;
import hlt.language.tools.Misc;
/**
* The class XmlTextInfo packages information parsed from an
* XML serialization annotation, which may be of one of the following
* three possible kinds:
*
*
*
* - a literal (unquoted, single-quoted, or double-quoted) text
* string; or,
*
*
- a path expression (of type an XmlTreePath) of the form
* c[x1...xn]/a, where c
* and the xi's are positive integers,
* a is a symbol, and where both
* [x1...xn] and /a, are
* optional; or,
*
*
- a special form of the form $VALUE or $TEXT(...).
*
*
*
* Thus, its structure extends that of an XmlTextInfoArg,
* which explains why it is a subclass of it.
*
*
*
*
* Basically, this contains all the information needed to manufacture a
* piece of text out of the partial CST and XML trees at parse time that
* will be the actual value of text. It can have one of five forms:
*
*
*
* - a literal (unquoted, or posssibly single- or double-quote) string;
*
*
- a reference to an XML tree node's
*
* - text contents, in the form c or c[x1 ... xn]; or
*
*
- attribute's value (in the form c/a or c[x1 ... xn]/a);
*
*
* - the special form
*
* - $VALUE; or,
*
*
- $TEXT(...), where each argument is
* either:
*
*
* - a literal (unquoted, or posssibly single- or double-quote)
* string; or,
*
*
- a reference to an XML tree node (in the form
* c or c[x1 ... xn]); or,
*
*
- a reference to an XML tree node's attribute's value
* (in the form c/a or c[x1 ... xn]/a).
*
*
*
*
*
* According to which the attribute value computed in each case will
* be, respectively:
*
*
*
* - Case 1: the literal string;
*
*
- Case 2.a: the text content of the referenced XML tree node;
*
*
- Case 2.b: the text value of the referenced XML tree node's attribute;
*
*
- Case 3.a: the value parsed for the corresponding terminal;
*
*
- Case 3.b: the concatenation of the text strings corresponding
* to the parse-time values denoted by each argument.
*
*
*
* @version Last modified on Fri Apr 13 20:22:30 2012 by hak
* @author Hassan Aït-Kaci
* @copyright © by the author
*/
public class XmlTextInfo extends XmlTextInfoArg
{
/**
* When non-null, this XmlTextInfo is a special form and
* _specialForm contains the special form data it needs.
*/
private XmlSpecialForm _specialForm = null;
/**
* isSpecialForm() returns true whenever
* this is a special form.
*/
public boolean isSpecialForm ()
{
return _specialForm != null;
}
/**
* Returns this XmlTextInfo's _specialForm.
*/
public XmlSpecialForm specialForm ()
{
return _specialForm;
}
/**
* isXmlTreePath() returns true whenever
* this is an XML tree path.
*/
public boolean isXmlTreePath ()
{
return hasXmlTreePath ();
}
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
/**
* Constructs an empty XmlTextInfoArg.
*/
public XmlTextInfo ()
{
}
/**
* Constructs an XmlTextInfo with specified XmlTreePath.
*/
public XmlTextInfo (XmlTreePath xmlTreePath)
{
super(xmlTreePath);
}
/**
* Constructs an XmlTextInfo with specified child position,
* (possibly null) xml path, and a (possibly null) attribute name.
*/
public XmlTextInfo (int child,
int[] path,
String attribute)
{
super(child,path,attribute);
}
/**
* Constructs an XmlTextInfo with specified child position,
* (possibly null) xml path, and a (possibly null) attribute name.
*/
public XmlTextInfo (int child,
IntArrayList path,
String attribute)
{
super(child,path,attribute);
}
/**
* Constructs an XmlTextInfo with specified special
* form.
*/
public XmlTextInfo (XmlSpecialForm form)
{
_specialForm = form;
}
/**
* Constructs an XmlTextInfo with specified attribute name.
*/
public XmlTextInfo (String attribute)
{
super(attribute);
}
/**
* Constructs an XmlTextInfo with specified child position,
*
*/
public XmlTextInfo (int child,
IntArrayList path,
boolean isTerminal,
ArrayList textInfo,
String attribute)
{
this(child,path,attribute);
if (isTerminal)
_specialForm = XmlSpecialForm.value();
else
_specialForm = new XmlSpecialForm(textInfo);
}
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
/**
* Returns a String form of this XmlTextInfo.
*/
public final String toString ()
{
if (isSpecialForm())
return _specialForm.toString();
return super.toString();
}
}