Xml.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2024 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * 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 of the License, 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see https://www.gnu.org/licenses
 *
 */
 
#ifndef H2C_XML_H
#define H2C_XML_H
 
#include <core/Object.h>
#include <QtCore/QString>
#include <QColor>
#include <QtXml/QDomDocument>
 
namespace H2Core
{
 
class XMLNode : public H2Core::Object<XMLNode>, public QDomNode
{
                H2_OBJECT(XMLNode)
        public:
                XMLNode( );
                XMLNode( QDomNode node );
 
                XMLNode createNode( const QString& name );
 
                int read_int( const QString& node, int default_value, bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
                bool read_bool( const QString& node, bool default_value, bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
        bool read_bool( const QString& node, bool default_value, bool* pFound, bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
                float read_float( const QString& node, float default_value, bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
                float read_float( const QString& node, float default_value, bool *pFound, bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
                QString read_string( const QString& node, const QString& default_value, bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
        QColor read_color( const QString& node, const QColor& defaultValue = QColor( 97, 167, 251 ), bool inexistent_ok=true, bool empty_ok=true, bool bSilent = false );
 
                QString read_attribute( const QString& attribute, const QString& default_value, bool inexistent_ok, bool empty_ok, bool bSilent = false );
 
                QString read_text( bool empty_ok, bool bSilent = false );
 
                void write_int( const QString& node, const int value );
                void write_bool( const QString& node, const bool value );
                void write_float( const QString& node, const float value );
                void write_string( const QString& node, const QString& value );
        void write_color( const QString& node, const QColor& color );
 
                void write_attribute( const QString& attribute, const QString& value );
        private:
        QString read_child_node( const QString& node, bool inexistent_ok, bool empty_ok, bool bSilent = false );
                void write_child_node( const QString& node, const QString& text );
};
 
class XMLDoc : public H2Core::Object<XMLDoc>, public QDomDocument
{
                H2_OBJECT(XMLDoc)
        public:
                XMLDoc( );
        bool read( const QString& filepath, const QString& schemapath=nullptr, bool bSilent = false );
                bool write( const QString& filepath );
                XMLNode set_root( const QString& node_name, const QString& xmlns = nullptr );
};
 
};
 
#endif  // H2C_XML_H
 
/* vim: set softtabstop=4 noexpandtab: */