domutil.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2001 by Bernd Gehrmann                                  *
 *   bernd@kdevelop.org                                                    *
 *   jakob@simon-gaarde.dk                                                 *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef _DOMUTIL_H_
#define _DOMUTIL_H_
 
#include <tqdom.h>
#include <tqpair.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
#include <tqmap.h>
 
struct DomAttribute
{
  TQString name;
  TQString value;
};
 
struct DomPathElement
{
  TQString tagName;
  TQValueList<DomAttribute> attribute;
  int matchNumber;  // for use when more than one element matches the path
};
 
typedef TQValueList<DomPathElement> DomPath;
 
class DomUtil
{
public:
    typedef TQPair<TQString, TQString> Pair;
    typedef TQValueList<Pair> PairList;
    static void makeEmpty( TQDomElement& );
    static TQString readEntry(const TQDomDocument &doc, const TQString &path, const TQString &defaultEntry = TQString());
    static int readIntEntry(const TQDomDocument &doc, const TQString &path, int defaultEntry = 0);
    static bool readBoolEntry(const TQDomDocument &doc, const TQString &path, bool defaultEntry = false);
    static TQStringList readListEntry(const TQDomDocument &doc, const TQString &path, const TQString &tag);
    static PairList readPairListEntry(const TQDomDocument &doc, const TQString &path, const TQString &tag,
                                      const TQString &firstAttr, const TQString &secondAttr);
    static TQMap<TQString, TQString> readMapEntry(const TQDomDocument &doc, const TQString &path);
    static TQDomElement elementByPath( const TQDomDocument& doc, const TQString& path );
    static TQDomElement createElementByPath( TQDomDocument& doc, const TQString& path );
    static TQDomElement namedChildElement( TQDomElement& el, const TQString& name );
    static void writeEntry(TQDomDocument &doc, const TQString &path, const TQString &value);
    static void writeIntEntry(TQDomDocument &doc, const TQString &path, int value);
    static void writeBoolEntry(TQDomDocument &doc, const TQString &path, bool value);
    static void writeListEntry(TQDomDocument &doc, const TQString &path, const TQString &tag,
                               const TQStringList &value);
    static void writePairListEntry(TQDomDocument &doc, const TQString &path, const TQString &tag,
                                   const TQString &firstAttr, const TQString &secondAttr,
                                   const PairList &value);
    static void writeMapEntry(TQDomDocument &doc, const TQString& path, const TQMap<TQString,TQString> &map);
 
    static DomPath resolvPathStringExt(const TQString pathstring);
 
    static TQDomElement elementByPathExt(TQDomDocument &doc, const TQString &pathstring);
 
    static bool openDOMFile(TQDomDocument &doc, TQString filename);
 
    static bool saveDOMFile(TQDomDocument &doc, TQString filename);
 
    static bool removeTextNodes(TQDomDocument doc,TQString pathExt);
 
    static bool appendText(TQDomDocument doc, TQString pathExt, TQString text);
 
    static bool replaceText(TQDomDocument doc, TQString pathExt, TQString text);
 
private:
    static TQString readEntryAux(const TQDomDocument &doc, const TQString &path);
};
 
#endif