Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.9

FormatterToXML_UTF16.hpp

Go to the documentation of this file.

/*
 * 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(FORMATTERTOXML_UTF16_HEADER_GUARD_1357924680)
#define FORMATTERTOXML_UTF16_HEADER_GUARD_1357924680




// Base include file.  Must be first.
#include <xalanc/XMLSupport/XMLSupportDefinitions.hpp>



#include <xalanc/XalanDOM/XalanDOMString.hpp>



// Base class header file.
#include "FormatterToXMLBase.hpp"



XALAN_CPP_NAMESPACE_BEGIN



class XALAN_XMLSUPPORT_EXPORT FormatterToXML_UTF16 : public FormatterToXMLBase 
{
public:
    


    static void
    initialize(MemoryManagerType& theManager);
 
    static void
    terminate();

    FormatterToXML_UTF16(
            Writer&                 writer,
            const XalanDOMString&   version = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            const XalanDOMString&   mediaType = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            const XalanDOMString&   doctypeSystem = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            const XalanDOMString&   doctypePublic = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            bool                    xmlDecl = true,
            const XalanDOMString&   standalone = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            MemoryManagerType&      theManager XALAN_DEFAULT_MEMMGR);

    static FormatterToXML_UTF16*
    create(
            MemoryManagerType&      theManager,
            Writer&                 writer,
            const XalanDOMString&   version = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            const XalanDOMString&   mediaType = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            const XalanDOMString&   doctypeSystem = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            const XalanDOMString&   doctypePublic = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
            bool                    xmlDecl = true,
            const XalanDOMString&   standalone = XalanDOMString(XalanMemMgrs::getDummyMemMgr()));

    virtual
    ~FormatterToXML_UTF16();


    // These methods are inherited from FormatterListener ...

    virtual void
    startElement(
            const XMLCh* const  name,
            AttributeListType&  attrs);

    virtual void
    endElement(const XMLCh* const   name);

    virtual void
    charactersRaw(
            const XMLCh* const  chars,
            const unsigned int  length);

    virtual void
    entityReference(const XMLCh* const  name);

    virtual void
    comment(const XMLCh* const  data);

    virtual const XalanDOMString&
    getEncoding() const;

protected:

    virtual void
    writeXMLHeader();

    virtual void
    flushBuffer();

    virtual void
    writeDoctypeDecl(const XalanDOMChar*    name);

    virtual void
    writeProcessingInstruction(
            const XMLCh*    target,
            const XMLCh*    data);

    virtual void
    writeCharacters(
            const XMLCh*    chars,
            unsigned int    length);

    virtual void
    writeCDATA(
            const XMLCh*    chars,
            unsigned int    length);

    virtual void
    outputNewline();

    void
    writeDefaultEscape(XalanDOMChar     ch);

    void
    writeDefaultAttributeEscape(XalanDOMChar    ch);

    bool
    writeDefaultEntity(XalanDOMChar     ch);

    bool
    writeDefaultAttributeEntity(XalanDOMChar    ch);

    void
    writeCommentData(const XalanDOMChar*    data);

    void
    writeParentTagEnd();

    void
    writeNormalizedChar(XalanDOMChar    ch);

    void
    writeCDATAChars(
            const XalanDOMChar          ch[],
            XalanDOMString::size_type   length);

    void
    writeAttrString(
            const XalanDOMChar*         theString,
            XalanDOMString::size_type   theStringLength);

private:

    // These are not implemented.
    FormatterToXML_UTF16(const FormatterToXML_UTF16&);

    FormatterToXML_UTF16&
    operator=(const FormatterToXML_UTF16&);

    bool
    operator==(const FormatterToXML_UTF16&) const;

    void
    write(
            const XalanDOMChar*         theChars,
            XalanDOMString::size_type   theLength);

    void
    writeName(const XalanDOMChar*   theChars);

    void
    write(const XalanDOMChar*   theChars)
    {
        write(theChars, XalanDOMString::length(theChars));
    }

    void
    write(XalanDOMChar  theChar)
    {
        write(&theChar, 1);
    }

    void
    write(const XalanDOMString&     theChars)
    {
        write(theChars.c_str(), theChars.length());
    }

    void
    outputDocTypeDecl(const XalanDOMChar*   name);

    void
    processAttribute(
            const XalanDOMChar*     name,
            const XalanDOMChar*     value);

    void
    writeNormalizedPIData(
            const XalanDOMChar*         theData,
            XalanDOMString::size_type   theLength);

    // Data members...

    static const XalanDOMString&    s_utf16String;

    static const XalanDOMChar               s_doctypeHeaderStartString[];

    static const XalanDOMString::size_type  s_doctypeHeaderStartStringLength;

    static const XalanDOMChar               s_doctypeHeaderPublicString[];

    static const XalanDOMString::size_type  s_doctypeHeaderPublicStringLength;

    static const XalanDOMChar               s_doctypeHeaderSystemString[];

    static const XalanDOMString::size_type  s_doctypeHeaderSystemStringLength;

    static const XalanDOMChar               s_xmlHeaderStartString[];

    static const XalanDOMString::size_type  s_xmlHeaderStartStringLength;

    static const XalanDOMChar               s_xmlHeaderEncodingString[];

    static const XalanDOMString::size_type  s_xmlHeaderEncodingStringLength;

    static const XalanDOMChar               s_xmlHeaderStandaloneString[];

    static const XalanDOMString::size_type  s_xmlHeaderStandaloneStringLength;

    static const XalanDOMChar               s_xmlHeaderEndString[];

    static const XalanDOMString::size_type  s_xmlHeaderEndStringLength;

    static const XalanDOMChar               s_defaultVersionString[];

    static const XalanDOMString::size_type  s_defaultVersionStringLength;

    static const XalanDOMChar               s_xhtmlDocTypeString[];

    static const XalanDOMString::size_type  s_xhtmlDocTypeStringLength;

    static const XalanDOMChar               s_cdataOpenString[];

    static const XalanDOMString::size_type  s_cdataOpenStringLength;

    static const XalanDOMChar               s_cdataCloseString[];

    static const XalanDOMString::size_type  s_cdataCloseStringLength;

    static const XalanDOMChar               s_lessThanEntityString[];

    static const XalanDOMString::size_type  s_lessThanEntityStringLength;

    static const XalanDOMChar               s_greaterThanEntityString[];

    static const XalanDOMString::size_type  s_greaterThanEntityStringLength;

    static const XalanDOMChar               s_ampersandEntityString[];

    static const XalanDOMString::size_type  s_ampersandEntityStringLength;

    static const XalanDOMChar               s_quoteEntityString[];

    static const XalanDOMString::size_type  s_quoteEntityStringLength;

    static const XalanDOMChar               s_linefeedNCRString[];

    static const XalanDOMString::size_type  s_linefeedNCRStringLength;

    static const XalanDOMChar               s_carriageReturnNCRString[];

    static const XalanDOMString::size_type  s_carriageReturnNCRStringLength;

    static const XalanDOMChar               s_htabNCRString[];

    static const XalanDOMString::size_type  s_htabNCRStringLength;

    enum
    {
        kBufferSize = 512       // The size of the buffer
    };

    static bool
    isContentSpecial(XalanDOMChar   theChar)
    {
        if ((theChar < kSpecialsSize) && (s_specialChars[theChar] & kContentSpecial))
        {
            return true;
        }
        else
        {
            return false;
        }
    }

    static bool
    isAttributeSpecial(XalanDOMChar     theChar)
    {
        if ((theChar < kSpecialsSize) && (s_specialChars[theChar] & kAttributeSpecial))
        {
            return true;
        }
        else
        {
            return false;
        }
    }


    XalanDOMChar                m_buffer[kBufferSize];

    XalanDOMChar*               m_bufferPosition;

    XalanDOMString::size_type   m_bufferRemaining;
};



XALAN_CPP_NAMESPACE_END



#endif  // FORMATTERTOXML_UTF16_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.9 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.