XspfXmlFormatter.h

Go to the documentation of this file.

/*
 * libxspf - XSPF playlist handling library
 *
 * Copyright (C) 2006-2008, Sebastian Pipping / Xiph.Org 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:
 *
 *     * Redistributions   of  source  code  must  retain  the   above
 *       copyright  notice, this list of conditions and the  following
 *       disclaimer.
 *
 *     * 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.
 *
 *     * Neither  the name of the Xiph.Org Foundation nor the names of
 *       its  contributors may be used to endorse or promote  products
 *       derived  from  this software without specific  prior  written
 *       permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS  IS" AND ANY EXPRESS 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
 * COPYRIGHT OWNER OR 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.
 *
 * Sebastian Pipping, sping@xiph.org
 */

#ifndef XSPF_XML_FORMATTER_H
#define XSPF_XML_FORMATTER_H


#include "XspfDefines.h"
#include <sstream>

namespace Xspf {


class XspfWriter;



struct XspfNamespaceRegistrationUndo {
        int level; 
        XML_Char const * uri; 

        XspfNamespaceRegistrationUndo(int level, XML_Char const * uri)
                        : level(level), uri(uri) {

        }

};



class XspfXmlFormatterPrivate;


class XspfXmlFormatter {

private:
        XspfXmlFormatterPrivate * const d; 


protected:
        XspfXmlFormatter();

        XspfXmlFormatter(XspfXmlFormatter const & source);

        XspfXmlFormatter & operator=(XspfXmlFormatter const & source);

        virtual ~XspfXmlFormatter();

        virtual void writeXmlDeclaration();

private:
        XML_Char const * getPrefix(XML_Char const * nsUri) const;

        XML_Char * makeFullName(XML_Char const * nsUri,
                        XML_Char const * localName) const;

        void cleanupNamespaceRegs();

        bool registerNamespace(XML_Char const * uri,
                        XML_Char const * prefixSuggestion);

public:
        void setOutput(std::basic_ostringstream<XML_Char> & output);

        void writeStart(XML_Char const * ns, XML_Char const * localName,
                        XML_Char const * const * atts, XML_Char const * const * nsRegs = NULL);

        void writeEnd(XML_Char const * ns, XML_Char const * localName);

        void writeHomeStart(XML_Char const * localName,
                        XML_Char const * const * atts, XML_Char const * const * nsRegs = NULL);

        void writeHomeEnd(XML_Char const * localName);

protected:
        virtual void writeStart(XML_Char const * name,
                        XML_Char const * const * atts) = 0;

        virtual void writeEnd(XML_Char const * name) = 0;

public:
        virtual void writeBody(XML_Char const * text) = 0;

        virtual void writeBody(int number) = 0;

        void writeCharacterData(XML_Char const * data);

        static XML_Char const * const namespaceKey; 

protected:
        std::basic_ostringstream<XML_Char> * & getOutput();

        void virtualHook(int methodId, void * parameters);

        friend class XspfWriter; // allow access to registerNamespace

};


} // namespace Xspf

#endif // XSPF_XML_FORMATTER_H

---