galleryxmlutils.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2006-04-04
 * Description : a tool to generate HTML image galleries
 *
 * Copyright (C) 2006-2010 by Aurelien Gateau <aurelien dot gateau at free dot fr>
 * Copyright (C) 2012-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_GALLERY_XML_UTILS_H
#define DIGIKAM_GALLERY_XML_UTILS_H
 
// Qt includes
 
#include <QString>
#include <QMap>
 
// libxml includes
 
#include <libxml/xmlwriter.h>
 
namespace DigikamGenericHtmlGalleryPlugin
{
 
template <class Ptr, void(*freeFcn)(Ptr)>
 
class CWrapper
{
public:
 
    CWrapper()
        : m_ptr(nullptr)
    {
    }
 
    // cppcheck-suppress noExplicitConstructor
    CWrapper(Ptr ptr)        // krazy:exclude=explicit
        : m_ptr(ptr)
    {
    }
 
    ~CWrapper()
    {
        freeFcn(m_ptr);
    }
 
    operator Ptr() const
    {
        return m_ptr;
    }
 
    bool operator!() const
    {
        return !m_ptr;
    }
 
    void assign(Ptr ptr)
    {
        if (m_ptr)
        {
            freeFcn(m_ptr);
        }
 
        m_ptr = ptr;
    }
 
private:
 
    Ptr m_ptr;
};
 
// --------------------------------------------------------------------------
 
class XMLWriter
{
public:
 
    bool open(const QString& name);
    operator xmlTextWriterPtr() const;
 
    void writeElement(const char* element, const QString& value);
    void writeElement(const char* element, int value);
 
private:
 
    CWrapper<xmlTextWriterPtr, xmlFreeTextWriter> m_writer;
};
 
 
// --------------------------------------------------------------------------
class XMLAttributeList
{
public:
 
    void write(XMLWriter& writer) const;
    void append(const QString& key, const QString& value);
    void append(const QString& key, int value);
 
private:
 
    typedef QMap<QString, QString> Map;
 
    Map m_map;
};
 
// --------------------------------------------------------------------------
 
class XMLElement
{
public:
 
    explicit XMLElement(XMLWriter& writer,
                        const QString& element,
                        const XMLAttributeList* attributeList = nullptr);
    ~XMLElement();
 
private:
 
    XMLWriter& m_writer;
};
 
} // namespace DigikamGenericHtmlGalleryPlugin
 
#endif // DIGIKAM_GALLERY_XML_UTILS_H