/* * Copyright 1999-2004 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #if !defined(XALANSOURCETREETEXT_HEADER_GUARD_1357924680) #define XALANSOURCETREETEXT_HEADER_GUARD_1357924680 #include #include #include XALAN_CPP_NAMESPACE_BEGIN class XalanSourceTreeComment; class XalanSourceTreeDocumentFragment; class XalanSourceTreeElement; class XalanSourceTreeProcessingInstruction; class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeText : public XalanText { public: /** * Perform static initialization. See class XalanSourceTreeInit. */ static void initialize(MemoryManagerType& theManager); /** * Perform static shut down. See class XalanSourceTreeInit. */ static void terminate(); /** * Constructor. * * @param theData The text data of the node * @param isIgnorableWhitespace true if the text data is only ignorable whitespace * @param theParentNode The parent node, if any. * @param thePreviousSibling The previous sibling, if any. * @param theNextSibling The next sibling, if any. * @param theIndex The document-order index of the node. */ XalanSourceTreeText( const XalanDOMString& theData, XalanNode* theParentNode = 0, XalanNode* thePreviousSibling = 0, XalanNode* theNextSibling = 0, IndexType theIndex = 0); virtual ~XalanSourceTreeText(); /** * Gets the name of this node. */ virtual const XalanDOMString& getNodeName() const; /** * Gets the value of this node, depending on its type. */ virtual const XalanDOMString& getNodeValue() const; /** * An enum value representing the type of the underlying object. */ virtual NodeType getNodeType() const; /** * Gets the parent of this node. * * All nodes, except Document, * DocumentFragment, and Attr may have a parent. * However, if a node has just been created and not yet added to the tree, * or if it has been removed from the tree, a null DOM_Node * is returned. */ virtual XalanNode* getParentNode() const; /** * Gets a NodeList that contains all children of this node. * * If there * are no children, this is a NodeList containing no nodes. * The content of the returned NodeList is "live" in the sense * that, for instance, changes to the children of the node object that * it was created from are immediately reflected in the nodes returned by * the NodeList accessors; it is not a static snapshot of the * content of the node. This is true for every NodeList, * including the ones returned by the getElementsByTagName * method. */ virtual const XalanNodeList* getChildNodes() const; /** * Gets the first child of this node. * * If there is no such node, this returns null. */ virtual XalanNode* getFirstChild() const; /** * Gets the last child of this node. * * If there is no such node, this returns null. */ virtual XalanNode* getLastChild() const; /** * Gets the node immediately preceding this node. * * If there is no such node, this returns null. */ virtual XalanNode* getPreviousSibling() const; /** * Gets the node immediately following this node. * * If there is no such node, this returns null. */ virtual XalanNode* getNextSibling() const; /** * Gets a NamedNodeMap containing the attributes of this node (if it * is an Element) or null otherwise. */ virtual const XalanNamedNodeMap* getAttributes() const; /** * Gets the DOM_Document object associated with this node. * * This is also * the DOM_Document object used to create new nodes. When this * node is a DOM_Document or a DOM_DocumentType * which is not used with any DOM_Document yet, this is * null. */ virtual XalanDocument* getOwnerDocument() const; //@} /** @name Cloning function. */ //@{ /** * Returns a duplicate of this node. * * This function serves as a generic copy constructor for nodes. * * The duplicate node has no parent ( * parentNode returns null.). *
Cloning an Element copies all attributes and their * values, including those generated by the XML processor to represent * defaulted attributes, but this method does not copy any text it contains * unless it is a deep clone, since the text is contained in a child * Text node. Cloning any other type of node simply returns a * copy of this node. * @param deep If true, recursively clone the subtree under the * specified node; if false, clone only the node itself (and * its attributes, if it is an Element). * @return The duplicate node. */ #if defined(XALAN_NO_COVARIANT_RETURN_TYPE) virtual XalanNode* #else virtual XalanSourceTreeText* #endif cloneNode(bool deep) const; //@} /** @name Functions to modify the DOM Node. */ //@{ /** * Inserts the node newChild before the existing child node * refChild. * * If refChild is null, * insert newChild at the end of the list of children. *
If newChild is a DocumentFragment object, * all of its children are inserted, in the same order, before * refChild. If the newChild is already in the * tree, it is first removed. Note that a DOM_Node that * has never been assigned to refer to an actual node is == null. * @param newChild The node to insert. * @param refChild The reference node, i.e., the node before which the new * node must be inserted. * @return The node being inserted. */ virtual XalanNode* insertBefore( XalanNode* newChild, XalanNode* refChild); /** * Replaces the child node oldChild with newChild * in the list of children, and returns the oldChild node. * * If newChild is a DOM_DocumentFragment object, * oldChild is replaced by all of the DOM_DocumentFragment * children, which are inserted in the same order. * * If the newChild is already in the tree, it is first removed. * @param newChild The new node to put in the child list. * @param oldChild The node being replaced in the list. * @return The node replaced. */ virtual XalanNode* replaceChild( XalanNode* newChild, XalanNode* oldChild); /** * Removes the child node indicated by oldChild from the list * of children, and returns it. * * @param oldChild The node being removed. * @return The node removed. */ virtual XalanNode* removeChild(XalanNode* oldChild); /** * Adds the node newChild to the end of the list of children of * this node. * * If the newChild is already in the tree, it is * first removed. * @param newChild The node to add.If it is a DocumentFragment * object, the entire contents of the document fragment are moved into * the child list of this node * @return The node added. */ virtual XalanNode* appendChild(XalanNode* newChild); //@} /** @name Query functions. */ //@{ /** * This is a convenience method to allow easy determination of whether a * node has any children. * * @return true if the node has any children, * false if the node has no children. */ virtual bool hasChildNodes() const; //@} /** @name Set functions. */ //@{ /** * Sets the value of the node. * * Any node which can have a nodeValue (@see getNodeValue) will * also accept requests to set it to a string. The exact response to * this varies from node to node -- Attribute, for example, stores * its values in its children and has to replace them with a new Text * holding the replacement value. * * For most types of Node, value is null and attempting to set it * will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will * also be thrown if the node is read-only. */ virtual void setNodeValue(const XalanDOMString& nodeValue); //@} /** @name Functions introduced in DOM Level 2. */ //@{ /** * Puts all DOM_Text * nodes in the full depth of the sub-tree underneath this DOM_Node, * including attribute nodes, into a "normal" form where only markup (e.g., * tags, comments, processing instructions, CDATA sections, and entity * references) separates DOM_Text * nodes, i.e., there are no adjacent DOM_Text * nodes. This can be used to ensure that the DOM view of a document is the * same as if it were saved and re-loaded, and is useful when operations * (such as XPointer lookups) that depend on a particular document tree * structure are to be used. *

Note: In cases where the document contains DOM_CDATASections, * the normalize operation alone may not be sufficient, since XPointers do * not differentiate between DOM_Text * nodes and DOM_CDATASection nodes.

*/ virtual void normalize(); /** * Tests whether the DOM implementation implements a specific * feature and that feature is supported by this node. * @param feature The string of the feature to test. This is the same * name as what can be passed to the method hasFeature on * DOMImplementation. * @param version This is the version number of the feature to test. In * Level 2, version 1, this is the string "2.0". If the version is not * specified, supporting any version of the feature will cause the * method to return true. * @return Returns true if the specified feature is supported * on this node, false otherwise. */ virtual bool isSupported( const XalanDOMString& feature, const XalanDOMString& version) const; /** * Get the namespace URI of * this node, or null if it is unspecified. *

* This is not a computed value that is the result of a namespace lookup * based on an examination of the namespace declarations in scope. It is * merely the namespace URI given at creation time. *

* For nodes of any type other than ELEMENT_NODE and * ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, * such as createElement from the Document * interface, this is always null. */ virtual const XalanDOMString& getNamespaceURI() const; /** * Get the namespace prefix * of this node, or null if it is unspecified. */ virtual const XalanDOMString& getPrefix() const; /** * Returns the local part of the qualified name of this node. *

* For nodes created with a DOM Level 1 method, such as * createElement from the DOM_Document interface, * it is null. */ virtual const XalanDOMString& getLocalName() const; /** * Set the namespace prefix of this node. *

* Note that setting this attribute, when permitted, changes * the nodeName attribute, which holds the qualified * name, as well as the tagName and name * attributes of the DOM_Element and DOM_Attr * interfaces, when applicable. *

* Note also that changing the prefix of an * attribute, that is known to have a default value, does not make a new * attribute with the default value and the original prefix appear, since the * namespaceURI and localName do not change. * * @param prefix The prefix of this node. * @exception DOMException * INVALID_CHARACTER_ERR: Raised if the specified prefix contains * an illegal character. *
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. *
* NAMESPACE_ERR: Raised if the specified prefix is * malformed, if the specified prefix is "xml" and the * namespaceURI of this node is different from * "http://www.w3.org/XML/1998/namespace", if specified prefix is * "xmlns" and the namespaceURI is neither * null nor an empty string, or if the * localName is null. */ virtual void setPrefix(const XalanDOMString& prefix); virtual bool isIndexed() const; virtual IndexType getIndex() const; //@} // These interfaces are inherited from XalanCDATASection... /** @name Getter functions. */ //@{ /** * Returns the character data of the node that implements this interface. * * The DOM implementation may not put arbitrary limits on the amount of data that * may be stored in a CharacterData node. However, * implementation limits may mean that the entirety of a node's data may * not fit into a single DOMString. In such cases, the user * may call substringData to retrieve the data in * appropriately sized pieces. * @exception DOMException * NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. * @exception DOMException * DOMSTRING_SIZE_ERR: Raised when it would return more characters than * fit in a DOMString variable on the implementation * platform. */ virtual const XalanDOMString& getData() const; /** * Returns the number of characters that are available through data and * the substringData method below. * * This may have the value * zero, i.e., CharacterData nodes may be empty. */ virtual unsigned int getLength() const; /** * Extracts a range of data from the node. * * @param offset Start offset of substring to extract. * @param count The number of characters to extract. * @return The specified substring. If the sum of offset and * count exceeds the length, then all * characters to the end of the data are returned. * @exception DOMException * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater * than the number of characters in data, or if the * specified count is negative. *
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not * fit into a DOMString. */ virtual XalanDOMString& substringData( unsigned int offset, unsigned int count, XalanDOMString& theResult) const; //@} /** @name Functions that set or change data. */ //@{ /** * Append the string to the end of the character data of the node. * * Upon success, data provides access to the concatenation of * data and the DOMString specified. * @param arg The DOMString to append. * @exception DOMException * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. */ virtual void appendData(const XalanDOMString& arg); /** * Insert a string at the specified character offset. * * @param offset The character offset at which to insert. * @param arg The DOMString to insert. * @exception DOMException * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater * than the number of characters in data. *
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. */ virtual void insertData( unsigned int offset, const XalanDOMString& arg); /** * Remove a range of characters from the node. * * Upon success, * data and length reflect the change. * @param offset The offset from which to remove characters. * @param count The number of characters to delete. If the sum of * offset and count exceeds length * then all characters from offset to the end of the data * are deleted. * @exception DOMException * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater * than the number of characters in data, or if the * specified count is negative. *
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. */ virtual void deleteData( unsigned int offset, unsigned int count); /** * Replace the characters starting at the specified character offset with * the specified string. * * @param offset The offset from which to start replacing. * @param count The number of characters to replace. If the sum of * offset and count exceeds length * , then all characters to the end of the data are replaced (i.e., the * effect is the same as a remove method call with the same * range, followed by an append method invocation). * @param arg The DOMString with which the range must be * replaced. * @exception DOMException * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater * than the number of characters in data, or if the * specified count is negative. *
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. */ virtual void replaceData( unsigned int offset, unsigned int count, const XalanDOMString& arg); //@} //@} /** @name Functions to modify the Text node. */ //@{ /** * Breaks this node into two nodes at the specified * offset, keeping both in the tree as siblings. * * This node then only * contains all the content up to the offset point. And a new * node of the same nodeType, which is inserted as the next sibling of this * node, contains all the content at and after the offset * point. When the offset is equal to the lenght of this node, * the new node has no data. * @param offset The offset at which to split, starting from 0. * @return The new Text node. * @exception DOMException * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater * than the number of characters in data. *
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. */ virtual XalanText* splitText(unsigned int offset); //@} virtual bool isIgnorableWhitespace() const; // public interfaces not inherited from XalanCDATASection... void setParent(XalanSourceTreeElement* theParent); void setParent(XalanSourceTreeDocumentFragment* theParent); void setPreviousSibling(XalanSourceTreeComment* thePreviousSibling); void setPreviousSibling(XalanSourceTreeElement* thePreviousSibling); void setPreviousSibling(XalanSourceTreeProcessingInstruction* thePreviousSibling); void setPreviousSibling(XalanSourceTreeText* thePreviousSibling); void appendSiblingNode(XalanSourceTreeComment* theSibling); void appendSiblingNode(XalanSourceTreeElement* theSibling); void appendSiblingNode(XalanSourceTreeProcessingInstruction* theSibling); void appendSiblingNode(XalanSourceTreeText* theSibling); void setIndex(IndexType theIndex) { m_index = theIndex; } protected: XalanSourceTreeText( const XalanSourceTreeText& theSource, bool /* deep */); private: // Not implemented... XalanSourceTreeText& operator=(const XalanSourceTreeText& theSource); bool operator==(const XalanSourceTreeText& theRHS) const; // Data members... const XalanDOMString& m_data; XalanNode* m_parentNode; XalanNode* m_previousSibling; XalanNode* m_nextSibling; IndexType m_index; static const XalanDOMString& s_nameString; }; XALAN_CPP_NAMESPACE_END #endif // !defined(XALANSOURCETREETEXT_HEADER_GUARD_1357924680)