lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _PLUGIN_XML_H_
lbajardsilogic@0: #define _PLUGIN_XML_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "base/XmlExportable.h"
lbajardsilogic@0: 
lbajardsilogic@0: namespace Vamp { class PluginBase; }
lbajardsilogic@0: 
lbajardsilogic@0: class QXmlAttributes;
lbajardsilogic@0: 
lbajardsilogic@0: class PluginXml : public XmlExportable
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     PluginXml(Vamp::PluginBase *plugin);
lbajardsilogic@0:     virtual ~PluginXml();
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Export plugin settings to XML.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual QString toXmlString(QString indent = "",
lbajardsilogic@0:                                 QString extraAttributes = "") const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the parameters and program of a plugin from a set of XML
lbajardsilogic@0:      * attributes.  This is a partial inverse of toXmlString.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setParameters(const QXmlAttributes &);
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the parameters and program of a plugin from an XML plugin
lbajardsilogic@0:      * element as returned by toXmlString.  This is a partial inverse
lbajardsilogic@0:      * of toXmlString.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setParametersFromXml(QString xml);
lbajardsilogic@0: 
lbajardsilogic@0:     static QString encodeConfigurationChars(QString text);
lbajardsilogic@0:     static QString decodeConfigurationChars(QString text);
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     QString stripInvalidParameterNameCharacters(QString) const;
lbajardsilogic@0: 
lbajardsilogic@0:     Vamp::PluginBase *m_plugin;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif