//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
// PLEASE DO NOT EDIT WITHOUT THE EXPLICIT CONSENT OF THE AUTHOR! \\
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
package hlt.language.syntax;
import org.jdom2.Element;
import hlt.language.util.ArrayList;
import hlt.language.util.IntToIntMap;
import hlt.language.util.IntArrayList;
import hlt.language.tools.Misc;
/**
* This is the class of information packaging an argument of a
* $TEXT special forms. A special form $TEXT(...) has
* arguments, each one being either:
*
*
*
* - a literal (unquoted, or posssibly single- or double-quote)
* string; or,
*
*
- an XmlTreePath representing
* a path expression 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.
*
*
*
* @version Last modified on Wed Jul 25 07:08:51 2018 by hak
* @author Hassan Aït-Kaci
* @copyright © by the author
*/
public class XmlTextInfoArg
{
/**
* If non-null, xmlTreePath indicates a node in an XML tree
* below whose text contents is then the value of _text.
*/
protected XmlTreePath _xmlTreePath;
/**
* When _xmlTreePath == null, _text, this argument
* contains a literal text string.
*/
protected String _text;
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
/**
* Constructs an empty XmlTextInfoArg.
*/
public XmlTextInfoArg ()
{
}
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
/**
* Constructs an XmlTextInfoArg with specified child position
* and an attribute name.
*/
public XmlTextInfoArg (XmlTreePath xmlTreePath)
{
_xmlTreePath = xmlTreePath;
}
/**
* Constructs an XmlTextInfoArg with specified child position,
* (possibly null) xml path, and a (possibly null) attribute name.
*/
public XmlTextInfoArg (String attribute)
{
this(new XmlTreePath(attribute));
}
/**
* Constructs an XmlTextInfoArg with specified child position
* and a (possibly null) attribute name.
*/
public XmlTextInfoArg (int child,
String attribute)
{
this(new XmlTreePath(child,attribute));
}
/**
* Constructs an XmlTextInfoArg with specified child position,
* (possibly null) xml path, and a (possibly null) attribute name.
*/
public XmlTextInfoArg (int child,
int[] path,
String attribute)
{
this(new XmlTreePath(child,path,attribute));
}
/**
* Constructs an XmlTextInfoArg with specified child position,
* (possibly null) xml path, and a (possibly null) attribute name.
*/
public XmlTextInfoArg (int child,
IntArrayList path,
String attribute)
{
this(new XmlTreePath(child,path,attribute));
}
//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
/**
* Returns true whenever this represents a literal string.
*/
public boolean isLiteral ()
{
return _text != null;
}
/**
* Returns the text string.
*/
public String text ()
{
return _text;
}
/**
* Sets the _text filed to text and returns
* this.
*/
public XmlTextInfoArg setText (String text)
{
_text = text;
return this;
}
/**
* Returns the child index, when there is one.
*/
public int child ()
{
return _xmlTreePath.child();
}
/**
* Returns true whenever this has a child index.
*/
public boolean hasChild ()
{
return _xmlTreePath != null && _xmlTreePath.hasChild();
}
/**
* Sets the child position index to the specified integer
* and returns this XmlTextInfoArg.
*/
public XmlTextInfoArg setChild (int child)
{
_xmlTreePath.setChild(child);
return this;
}
/**
* Returns the XmlTreePath object
* if there is one, or null, otherwise.
*/
public XmlTreePath xmlTreePath ()
{
return _xmlTreePath;
}
/**
* Sets _xmlTreePath to the specified XmlTreePath and
* returns this XmlTextInfoArg.
*/
public XmlTextInfoArg setXmlTreePath (XmlTreePath path)
{
_xmlTreePath = path;
return this;
}
/**
* Returns true whenever this has a non-null
* XmlTreePath.
*/
public boolean hasXmlTreePath ()
{
return _xmlTreePath != null;
}
/**
* Returns the XML tree address, when there is one.
*/
public int[] path ()
{
return _xmlTreePath.path();
}
/**
* Returns true whenever this has a non-vacuous XML tree
* address.
*/
public boolean hasPath ()
{
return hasXmlTreePath() && path() != null;
}
/**
* Sets the XML tree address path to the specified int[] and
* returns this XmlTextInfoArg.
*/
public XmlTextInfoArg setPath (int[] path)
{
_xmlTreePath.setPath(path);
return this;
}
/**
* Returns the Xml tree attribute, when there is one.
*/
public String attribute ()
{
return _xmlTreePath.attribute();
}
/**
* Returns the true whenever this refers to an attribute.
*/
public boolean hasAttribute ()
{
return _xmlTreePath != null && _xmlTreePath.hasAttribute();
}
/**
* Returns a text form for this XmlTextInfoArg given
* the supplied context.
*/
public String makeTextForm (ArrayList xmlForms, IntToIntMap childMap)
{
if (isLiteral())
return _text;
int formPos = childMap.get(child());
ArrayList xmlForm = (ArrayList)xmlForms.get(formPos);
Element ref = (Element)xmlForm.get(0);
if (hasPath())
for (int j=0; jString form of this XmlTextInfoArg.
*/
public String toString ()
{
if (isLiteral())
return "\""+_text+"\"";
return _xmlTreePath.toString();
}
}