You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/kexi/plugins/macros/lib/xmlhandler.cpp

227 lines
7.1 KiB

/***************************************************************************
* This file is part of the KDE project
* copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
* copyright (C) 2006 by Bernd Steindorff (bernd@itii.de)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library 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
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#include "xmlhandler.h"
#include "macro.h"
#include "macroitem.h"
#include "action.h"
#include <tqdom.h>
#include <kdebug.h>
using namespace KoMacro;
namespace KoMacro {
/**
* @internal d-pointer class to be more flexible on future extension of the
* functionality without to much risk to break the binary compatibility.
*/
class XMLHandler::Private
{
public:
/**
* The @a Macro instance this @a XMLHandler
* manages.
*/
Macro* const macro;
/**
* Constructor.
*
* @param macro The @a Macro instance this
* @a XMLHandler manages.
*/
Private(Macro* const macro)
: macro(macro)
{
}
};
}
XMLHandler::XMLHandler(Macro* const macro)
: d( new Private(macro) )
{
}
XMLHandler::~XMLHandler()
{
delete d;
}
bool XMLHandler::parseXML(const TQDomElement& element)
{
// Remove old items. We should clear first.
d->macro->clearItems();
// We expect a <macro> element. Do we really need to be such strict or
// would it be more wise to trust the application in that case?
if(element.tagName() != "macro") {
kdDebug() << TQString("XMLHandler::parseXML() Invalid tagname \"%1\"").tqarg(element.tagName()) << endl;
return false;
}
// To be flexible with the xml-scheme, we need a version-number for xml.
// If there is more than one version, parsing should update old macro-data, so that it
// could write out in the newer version in toXML().
if( element.attribute("xmlversion") != "1"){
kdDebug() << TQString("XMLHandler::parseXML() Invalid xml-version \"%1\"").tqarg(element.attribute("xmlversion")) << endl;
return false;
}
// Do we need to load the macro's name?
// d->macro->setName(element.attribute("name"));
// Iterate through the child nodes the passed TQDomElement has and
// build the MacroItem elements.
for(TQDomNode itemnode = element.firstChild(); ! itemnode.isNull(); itemnode = itemnode.nextSibling()) {
// The tagname should be "item"
if(itemnode.nodeName() == "item") {
// The node is an element.
const TQDomElement itemelem = itemnode.toElement();
// Create a new MacroItem
KSharedPtr<MacroItem> item = new MacroItem();
// Add the new item to our Macro.
d->macro->addItem( item );
// Each MacroItem may point to an Action instance. We
// try to determinate this action now and if it's defined
// and available, we set it.
KSharedPtr<Action> action = Manager::self()->action( itemelem.attribute("action") );
if(action.data()) {
item->setAction(action);
}
// Set the comment
item->setComment( itemelem.attribute("comment") );
// Iterate through the tqchildren this item has and try
// to fill the list of variables our new MacroItem has.
for(TQDomNode childnode = itemnode.firstChild(); ! childnode.isNull(); childnode = childnode.nextSibling()) {
// The tagname should be "variable"
if(childnode.nodeName() == "variable") {
// The node is an element.
const TQDomElement childelem = childnode.toElement();
// The name the variable has.
const TQString name = childelem.attribute("name");
// The value the variable has.
const TQString value = childelem.text();
// Store the new variable in our macroitem.
item->addVariable(name, value);
}
}
}
}
// Job was done successfully.
return true;
}
TQDomElement XMLHandler::toXML()
{
// The TQDomDocument provides us the functionality to create new TQDomElement instances.
TQDomDocument document;
// Create the Macro-TQDomElement. This element will be returned.
TQDomElement macroelem = document.createElement("macro");
// Set the Macro-XML-Version, it should be the newest Version.
macroelem.setAttribute("xmlversion","1");
// Do we need to store the macro's name? Normaly the application
// could/should take care of it cause we don't know how the app
// may store the XML and cause we don't like to introduce
// redundancy at this point.
//macroelem.setAttribute("name",d->macro->name());
// The list of MacroItem-tqchildren a Macro provides.
TQValueList<KSharedPtr<MacroItem > > items = d->macro->items();
// Create an iterator...
TQValueList<KSharedPtr<MacroItem > >::ConstIterator it(items.constBegin()), end(items.constEnd());
// ...and iterate over the list of tqchildren the Macro provides.
for(;it != end; ++it) {
// We are iterating over MacroItem instances.
KSharedPtr<MacroItem> item = *it;
// Flag to determinate if we really need to remember this item what
// is only the case if comment or action is defined.
bool append = false;
// Each MacroItem will have an own node.
TQDomElement itemelem = document.createElement("item");
// Each MacroItem could point to an Action provided by the Manager.
const KSharedPtr<Action> action = item->action();
if( action ) {
append = true;
// Remember the name of the action.
itemelem.setAttribute("action", action->name());
// Each MacroItem could have a list of variables. We
// iterate through that list and build a element
// for each single variable.
TQMap<TQString, KSharedPtr<Variable > > varmap = item->variables();
for(TQMap<TQString, KSharedPtr<Variable > >::ConstIterator vit = varmap.constBegin(); vit != varmap.constEnd(); ++vit) {
const KSharedPtr<Variable> v = vit.data();
if(! v.data()) {
// skip if the variable is NULL.
continue;
}
// Create an own element for the variable. The tagname will be
// the name of the variable.
TQDomElement varelement = document.createElement("variable");
// Remember the name the value has.
varelement.setAttribute("name", vit.key());
// Remember the value as textnode.
varelement.appendChild(document.createTextNode(v->toString()));
// Add the new variable-element to our MacroItem.
itemelem.appendChild(varelement);
}
}
// Each MacroItem could have an optional comment.
const TQString comment = item->comment();
if(! comment.isEmpty()) {
append = true;
itemelem.setAttribute("comment", item->comment());
}
// Check if we really need to remember the item.
if(append) {
macroelem.appendChild(itemelem);
}
}
// Job done. Return the macro's element.
return macroelem;
}