DOMString.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:17k
源码类别:
xml/soap/webservice
开发平台:
C/C++
- /*
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 1999-2000 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Xerces" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation, and was
- * originally based on software copyright (c) 1999, International
- * Business Machines, Inc., http://www.ibm.com . For more information
- * on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
- /*
- * $Log: DOMString.hpp,v $
- * Revision 1.12 2000/06/02 00:45:42 andyh
- * DOM Fixes: DOMString::rawBuffer() now returns a const XMLCh * pointer.
- * Two plain deletes changed to array deletes.
- *
- * Revision 1.11 2000/03/02 19:53:52 roddey
- * This checkin includes many changes done while waiting for the
- * 1.1.0 code to be finished. I can't list them all here, but a list is
- * available elsewhere.
- *
- * Revision 1.10 2000/02/24 20:11:27 abagchi
- * Swat for removing Log from API docs
- *
- * Revision 1.9 2000/02/16 22:54:56 abagchi
- * Switched the order of CDOM_EXPORT DomString for operators, to make OS/390 happy
- *
- * Revision 1.8 2000/02/06 07:47:27 rahulj
- * Year 2K copyright swat.
- *
- * Revision 1.7 2000/02/04 05:06:30 andyh
- * Change all DOMString offsets and lengths form signed to unsigned
- * Other misc. cleanups.
- *
- * Revision 1.6 2000/02/04 00:52:58 rahulj
- * Changed size_t to int.
- *
- * Revision 1.5 2000/02/03 23:07:27 andyh
- * Add several new functions from Robert Weir to DOMString.
- *
- * Revision 1.4 2000/01/05 22:16:26 robweir
- * Move DOMString implementation class declarations into a new
- * file: DOMStringImpl.hpp. Include this header in DOMString.hpp
- * for XML_DEBUG builds so the underlying character array will be
- * visible in the debugger. <robert_weir@lotus.com>
- *
- * Revision 1.3 1999/12/03 00:11:22 andyh
- * Added DOMString.clone() to node parameters in and out of the DOM,
- * where they had been missed.
- *
- * DOMString::rawBuffer, removed incorrect assumptions about it
- * being null terminated.
- *
- * Revision 1.2 1999/11/30 21:16:25 roddey
- * Changes to add the transcode() method to DOMString, which returns a transcoded
- * version (to local code page) of the DOM string contents. And I changed all of the
- * exception 'throw by pointer' to 'throw by value' style.
- *
- * Revision 1.1.1.1 1999/11/09 01:08:48 twl
- * Initial checkin
- *
- * Revision 1.2 1999/11/08 20:44:12 rahul
- * Swat for adding in Product name and CVS comment log variable.
- *
- */
- #ifndef DOMString_HEADER_GUARD_
- #define DOMString_HEADER_GUARD_
- #include <util/XercesDefs.hpp>
- #ifdef XML_DEBUG
- #include "DOMStringImpl.hpp"
- #else
- class DOMStringHandle;
- #endif
- class DOM_NullPtr;
- /**
- * <code>DOMString</code> is the generic string class that stores all strings
- * used in the DOM C++ API.
- *
- * Though this class supports most of the common string operations to manipulate
- * strings, it is not meant to be a comphrehensive string class.
- */
- class CDOM_EXPORT DOMString {
- public:
- /** @name Constructors and assignment operator */
- //@{
- /**
- * Default constructor for DOMString. The resulting DOMString
- * object refers to no string at all; it will compare == 0.
- *
- */
- DOMString();
- /**
- * Copy constructor.
- *
- * @param other The object to be copied.
- */
- DOMString(const DOMString &other);
- /**
- * Constructor to build a DOMString from an XML character array.
- * (XMLCh is a 16 bit UNICODE character).
- *
- * @param other The null-terminated character array to be
- * that provides the initial value for the DOMString.
- */
- DOMString(const XMLCh *other);
- /**
- * Constructor to build a DOMString from a character array of given length.
- *
- * @param other The character array to be imported into the <code>DOMString</code>
- * @param length The length of the character array to be imported
- */
- DOMString(const XMLCh *other, unsigned int length);
- /**
- * Constructor to build a DOMString from an 8 bit character array.
- * The char * string will be transcoded to UNICODE using the default
- * code page on the system where the code is running.
- *
- * @param other The character array to be imported into the <code>DOMString</code>
- */
- DOMString(const char *other);
- /**
- * Construct a null DOMString.
- */
- DOMString(int nullPointerValue);
- /**
- * Assignment operator. Make destination DOMString refer to the same
- * underlying string in memory as the source string.
- *
- * @param the source DOMString.
- */
- DOMString & operator = (const DOMString &other);
- DOMString & operator = (DOM_NullPtr *other);
- //@}
- /** @name Destructor. */
- //@{
- /**
- * Destructor for DOMString
- *
- */
- ~DOMString();
- //@}
- /** @name Operators for string manipulation. */
- //@{
- /**
- * Concatenate a DOMString to another.
- *
- * @param other The string to be concatenated.
- * @return The concatenated object
- */
- // DOMString operator + (const DOMString &other);
- //@}
- /** @name Equality and Inequality operators. */
- //@{
- /**
- * Equality operator.
- *
- * @param other The object to be compared with.
- * @return True if the two DOMStrings refer to the same underlying string
- * in memory.
- * <p>
- * WARNING: operator == does NOT compare the contents of
- * the two strings. To do this, use the <code>DOMString::equals()</code>
- * This behavior is modelled after the String operations in Java, and
- * is also similar to operator == on the other DOM_* classes.
- */
- bool operator == (const DOMString &other) const;
- /**
- * Inequality operator.
- *
- * @param other The object to be compared with.
- * @return True if the two DOMStrings refer to different underlying strings in
- * memory.
- * <p>
- * WARNING: operator == does NOT compare the contents of
- * the two strings. To do this, use the <code>DOMString::equals()</code>
- * This behavior is modelled after the String operations in Java, and
- * is also similar to operator == on the other DOM_* classes.
- */
- bool operator != (const DOMString &other) const;
- /**
- * Equality operator. Test for a null DOMString, which is one that does
- * not refer to any string at all; similar to a null object reference
- * variable in Java.
- *
- * @param other must be 0 or null.
- * @return
- */
- bool operator == (const DOM_NullPtr *other) const;
- /**
- * Inequality operator, for null test.
- *
- * @param other must be 0 or null.
- * @return True if the two strings are different, false otherwise
- */
- bool operator != (const DOM_NullPtr *other) const;
- //@}
- /** @name Functions to change the string. */
- //@{
- /**
- * Preallocate storage in the string to hold a given number of characters.
- * A DOMString will grow its buffer on demand, as characters are added,
- * but it can be more efficient to allocate once in advance, if the size is known.
- *
- * @param size The number of 16 bit characters to reserve.
- */
- void reserve(unsigned int size);
- /**
- * Appends the content of another <code>DOMString</code> to this string.
- *
- * @param other The object to be appended
- */
- void appendData(const DOMString &other);
- /**
- * Append a single Unicode character to this string.
- *
- * @param other The object to be appended
- */
- void appendData(XMLCh ch);
- /**
- * Append a null-terminated XMLCh * (Unicode) string to this string.
- *
- * @param other The object to be appended
- */
- void appendData(const XMLCh *other);
- /**
- * Appends the content of another <code>DOMString</code> to this string.
- *
- * @param other The object to be appended
- */
- DOMString& operator +=(const DOMString &other);
- /**
- * Appends the content of a c-style string to this string.
- *
- * @param other The string to be appended
- */
- DOMString& operator +=(const XMLCh* other);
- /**
- * Appends a character to this string.
- *
- * @param ch The character to be appended
- */
- DOMString& operator +=(XMLCh ch);
- /**
- * Clears the data of this <code>DOMString</code>.
- *
- * @param offset The position from the beginning from which the data must be deleted
- * @param count The count of characters from the offset that must be deleted
- */
- void deleteData(unsigned int offset, unsigned int count);
- /**
- * Inserts a string within the existing <code>DOMString</code> at an arbitrary position.
- *
- * @param offset The offset from the beginning at which the insertion needs to be done
- * in <code>this</code> object
- * @param data The <code>DOMString</code> containing the data that needs to be inserted
- * @return The object to be returned.
- */
- void insertData(unsigned int offset, const DOMString &data);
- //@}
- /** @name Functions to get properties of the string. */
- //@{
- /**
- * Returns the character at the specified position.
- *
- * @param index The position at which the character is being requested
- * @return Returns the character at the specified position.
- */
- XMLCh charAt(unsigned int index) const;
- /**
- * Returns a handle to the raw buffer in the <code>DOMString</code>.
- *
- * @return The pointer inside the <code>DOMString</code> containg the string data.
- * Note: the data is not always null terminated. Do not rely on
- * a null being there, and do not add one, as several DOMStrings
- * with different lengths may share the same raw buffer.
- */
- const XMLCh *rawBuffer() const;
- /**
- * Returns a copy of the string, transcoded to the local code page. The
- * caller owns the (char *) string that is returned, and is responsible
- * for deleting it.
- *
- * @return A pointer to a newly allocated buffer of char elements, which
- * represents the original string, but in the local encoding.
- */
- char *transcode() const;
- /**
- * Creates a DOMString, transcoded from an input 8 bit char * string
- * in the local code page.
- *
- * @param str The string to be transcoded
- * @return A new DOMString object
- */
- static DOMString transcode(const char* str);
- /**
- * Returns a sub-string of the <code>DOMString</code> starting at a specified position.
- *
- * @param offset The offset from the beginning from which the sub-string is being requested.
- * @param count The count of characters in the requested sub-string
- * @return The sub-string of the <code>DOMString</code> being requested
- */
- DOMString substringData(unsigned int offset, unsigned int count) const;
- /**
- * Returns the length of the DOMString.
- *
- * @return The length of the string
- */
- unsigned int length() const;
- //@}
- /** @name Cloning function. */
- //@{
- /**
- * Makes a clone of a the DOMString.
- *
- * @return The object to be cloned.
- */
- DOMString clone() const;
- //@}
- /** @name Print functions. */
- //@{
- /**
- * Dumps the <code>DOMString</code> on the console.
- *
- */
- void print() const;
- /**
- * Dumps the <code>DOMString</code> on the console with a line feed at the end.
- *
- */
- void println() const;
- //@}
- /** @name Functions to compare a string with another. */
- //@{
- /**
- * Compares a DOMString with another.
- *
- * This compareString does not match the semantics of the standard C strcmp.
- * All it needs to do is define some less than - equals - greater than
- * ordering of strings. How doesn't matter.
- *
- *
- * @param other The object to be compared with
- * @return Either -1, 0, or 1 based on the comparison.
- */
- int compareString(const DOMString &other) const;
- /**
- * Tells if a <code>DOMString</code> contains the same character data
- * as another.
- *
- * @param other The DOMString to be compared with.
- * @return True if the two <code>DOMString</code>s are same, false otherwise.
- */
- bool equals(const DOMString &other) const;
- /**
- * Compare a DOMString with a null-terminated raw 16-bit character
- * string.
- *
- * @param other The character string to be compared with.
- * @return True if the strings are the same, false otherwise.
- */
- bool equals(const XMLCh *other) const;
- //@}
- friend class DOMStringData;
- friend class DOMStringHandle;
- friend class DomMemDebug;
- private:
- DOMStringHandle *fHandle;
- static int gLiveStringHandleCount;
- static int gTotalStringHandleCount;
- static int gLiveStringDataCount;
- static int gTotalStringDataCount;
- };
- /****** Global Helper Functions ******/
- /**
- * Concatenate two DOMString's.
- *
- * @param lhs the first string
- * @param rhs the second string
- * @return The concatenated object
- */
- DOMString CDOM_EXPORT operator + (const DOMString &lhs, const DOMString &rhs);
- /**
- * Concatenate a null terminated Unicode string to a DOMString.
- *
- * @param lhs the DOMString
- * @param rhs the XMLCh * string
- * @return The concatenated object
- */
- DOMString CDOM_EXPORT operator + (const DOMString &lhs, const XMLCh* rhs);
- /**
- * Concatenate a DOMString to a null terminated Unicode string
- *
- * @param lhs the null-terminated Unicode string
- * @param rhs the DOMString
- * @return The concatenated object
- */
- DOMString CDOM_EXPORT operator + (const XMLCh* lhs, const DOMString &rhs);
- /**
- * Concatenate a single Unicode character to a DOMString.
- *
- * @param lhs the DOMString
- * @param rhs the character
- * @return The concatenated object
- */
- DOMString CDOM_EXPORT operator + (const DOMString &lhs, XMLCh rhs);
- /**
- * Concatenate a DOMString to a single Unicode character.
- *
- * @param lhs the character
- * @param rhs the DOMString
- * @return The concatenated object
- */
- DOMString CDOM_EXPORT operator + (XMLCh lhs, const DOMString &rhs);
- #endif