---

DOMString.hpp

/*
 * 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.1  2002/05/11 19:46:28  bhavani
 * CR#CR062582# adding xercesc 1.7 file
 *
 * Revision 1.2  2002/02/20 18:17:00  tng
 * [Bug 5977] Warnings on generating apiDocs.
 *
 * Revision 1.1.1.1  2002/02/01 22:21:44  peiyongz
 * sane_include
 *
 * 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 <xercesc/util/XercesDefs.hpp>

#ifdef XML_DEBUG
#include "DOMStringImpl.hpp"
#else
class DOMStringHandle;
#endif

class DOM_NullPtr;

class CDOM_EXPORT DOMString {
public:
    DOMString();

    DOMString(const DOMString &other);

    DOMString(const XMLCh *other);

    DOMString(const XMLCh *other, unsigned int length);

    DOMString(const char *other);

    DOMString(int nullPointerValue);

    DOMString &        operator = (const DOMString &other);



    DOMString &        operator = (DOM_NullPtr *other);



    ~DOMString();



    // DOMString   operator + (const DOMString &other);



    bool        operator == (const DOMString &other) const;

    bool        operator != (const DOMString &other) const;

    bool        operator == (const DOM_NullPtr *other) const;

    bool        operator != (const DOM_NullPtr *other) const;




    void reserve(unsigned int size);


    void        appendData(const DOMString &other);

    void        appendData(XMLCh ch);

    void        appendData(const XMLCh *other);


        DOMString& operator +=(const DOMString &other);


    DOMString& operator +=(const XMLCh* other);


        DOMString& operator +=(XMLCh ch);


    void        deleteData(unsigned int offset, unsigned int count);

    void        insertData(unsigned int offset, const DOMString &data);



    XMLCh       charAt(unsigned int index) const;

    const XMLCh *rawBuffer() const;

    char        *transcode() const;


    static DOMString transcode(const char* str);



    DOMString   substringData(unsigned int offset, unsigned int count) const;

    unsigned int length() const;



    DOMString   clone() const;



    void        print() const;

    void        println() const;



    int         compareString(const DOMString &other) const;

    bool        equals(const DOMString &other) const;


    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 ******/

DOMString CDOM_EXPORT operator + (const DOMString &lhs, const DOMString &rhs);

DOMString CDOM_EXPORT operator + (const DOMString &lhs, const XMLCh* rhs);


DOMString CDOM_EXPORT operator + (const XMLCh* lhs, const DOMString &rhs);


DOMString CDOM_EXPORT operator + (const DOMString &lhs, XMLCh rhs);


DOMString CDOM_EXPORT operator + (XMLCh lhs, const DOMString &rhs);

#endif

---