XspfProps.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_PROPS_H
#define XSPF_PROPS_H


#include "XspfData.h"

namespace Xspf {


class XspfPropsPrivate;
class XspfDateTime;


class XspfProps : public XspfData {

        friend class XspfPropsPrivate; // Give access to static helpers

private:
        XspfPropsPrivate * const d; 


public:
        XspfProps();

        XspfProps(XspfProps const & source);

        XspfProps & operator=(XspfProps const & source);

        ~XspfProps();

        void giveIdentifier(XML_Char const * identifier, bool copy);

        void giveLicense(XML_Char const * license, bool copy);

        void giveLocation(XML_Char const * location, bool copy);

        void giveAppendAttributionIdentifier(XML_Char const * identifier, bool copy);

        void giveAppendAttributionLocation(XML_Char const * location, bool copy);

        void giveDate(XspfDateTime const * date, bool copy);

        void lendIdentifier(XML_Char const * identifier);

        void lendLicense(XML_Char const * license);

        void lendLocation(XML_Char const * location);

        void lendAppendAttributionIdentifier(XML_Char const * identifier);

        void lendAppendAttributionLocation(XML_Char const * location);

        void lendDate(XspfDateTime const * date);

        void setVersion(int version);

        XML_Char * stealLicense();

        XML_Char * stealLocation();

        XML_Char * stealIdentifier();

        std::pair<bool, XML_Char *> * stealFirstAttribution();

        XspfDateTime * stealDate();

        XML_Char const * getLicense() const;

        XML_Char const * getLocation() const;

        XML_Char const * getIdentifier() const;

        std::pair<bool, XML_Char const *> * getAttribution(int index) const;

        int getAttributionCount() const;

        XspfDateTime const * getDate() const;

        int getVersion() const;

private:
        static void appendHelper(std::deque<std::pair<bool, std::pair<XML_Char const *, bool> *> *> * & container,
                        XML_Char const * value, bool ownership, bool isLocation);

        static std::pair<bool, XML_Char const *> * getHelper(
                        std::deque<std::pair<bool, std::pair<XML_Char const *, bool> *> *> * & container, int index);

        static XspfDateTime * stealHelper(XspfDateTime const * & dateTime,
                        bool own);

        static std::pair<bool, XML_Char *> * stealFirstHelper(
                        std::deque<std::pair<bool, std::pair<XML_Char const *, bool> *> *> * & container);

        static void deleteNewAndCopy(XspfDateTime const * & dest, bool & destOwnership,
                        XspfDateTime const * source, bool sourceCopy);

};


}

#endif // XSPF_PROPS_H

---