ext/OGDF/ogdf/fileformats/XmlParser.h

   1 /*
   2  * $Revision: 2564 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-07 00:03:48 +0200 (Sa, 07. Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of class XmlParser.
  11  *
  12  * \author Sebastian Leipert and Carsten Gutwenger
  13  *
  14  * \par License:
  15  * This file is part of the Open Graph Drawing Framework (OGDF).
  16  *
  17  * \par
  18  * Copyright (C)<br>
  19  * See README.txt in the root directory of the OGDF installation for details.
  20  *
  21  * \par
  22  * This program is free software; you can redistribute it and/or
  23  * modify it under the terms of the GNU General Public License
  24  * Version 2 or 3 as published by the Free Software Foundation;
  25  * see the file LICENSE.txt included in the packaging of this file
  26  * for details.
  27  *
  28  * \par
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * \par
  35  * You should have received a copy of the GNU General Public
  36  * License along with this program; if not, write to the Free
  37  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  38  * Boston, MA 02110-1301, USA.
  39  *
  40  * \see  http://www.gnu.org/copyleft/gpl.html
  41  ***************************************************************/
  42
  43
  44 #ifdef _MSC_VER
  45 #pragma once
  46 #endif
  47
  48 #ifndef OGDF_XML_PARSER_H
  49 #define OGDF_XML_PARSER_H
  50
  51
  52 #include <ogdf/basic/Hashing.h>
  53 #include <ogdf/basic/String.h>
  54 #include <ogdf/basic/GraphAttributes.h>
  55 #include <ogdf/fileformats/XmlObject.h>
  56 #include <ogdf/basic/SList.h>
  57
  58
  59 namespace ogdf {
  60
  61
  62
  63 //---------------------------------------------------------
  64 // XmlParser
  65 // reads XML file and constructs XML parse tree
  66 //---------------------------------------------------------
  67 class OGDF_EXPORT XmlParser {
  68         Hashing<String,int> m_hashTable; // hash table for tags
  69         int m_num;
  70
  71         istream *m_is;
  72         bool m_error;
  73         String m_errorString;
  74
  75         char *m_rLineBuffer, *m_lineBuffer, *m_pCurrent, *m_pStore, m_cStore;
  76
  77         int         m_intSymbol;    // integer attribute
  78         double      m_doubleSymbol; // double attribute
  79         const char *m_stringSymbol; // string attribute
  80         char       *m_keyName;          // Tag name
  81         XmlKey          m_keySymbol;    // Tag name and Attribute Name in Hash Table
  82         String          m_longString;
  83         bool            m_eoTag;                // end of Tag recognized
  84
  85         XmlObject *m_objectTree; // root node of XML parse tree
  86
  87         bool m_doCheck;
  88
  89         SList<char*> m_objectBody;
  90
  91 public:
  92         // predefined id constants for all used keys
  93         enum PredefinedKey { idPredefKey = 0, labelPredefKey, CreatorPredefKey,
  94                 namePredefKey, graphPredefKey, versionPredefKey, directedPredefKey,
  95                 nodePredefKey, edgePredefKey, graphicsPredefKey, xPredefKey,
  96                 yPredefKey, wPredefKey, hPredefKey, nodetypePredefKey, edgetypePredefKey,
  97                 typePredefKey, widthPredefKey, heightPredefKey, sizePredefKey,
  98                 positionPredefKey, pathPredefKey,
  99                 sourcePredefKey, targetPredefKey, sensePredefKey, arrowPredefKey, LinePredefKey,
 100                 pointPredefKey, NEXTPREDEFKEY };
 101
 102         // construction: creates object tree
 103         // sets m_error flag if an error occured
 104         XmlParser(const char *fileName, bool doCheck = false);
 105         XmlParser(istream &is, bool doCheck = false);
 106
 107         // destruction: destroys object tree
 108         ~XmlParser();
 109
 110         // returns root object
 111         XmlObject *root() { return m_objectTree; }
 112
 113         // id of a string in hash table; -1 if not contained
 114         int getId(const String &tag) const {
 115                 HashElement<String,int> *it = m_hashTable.lookup(tag);
 116                 return (it != 0) ? it->info() : -1;
 117         }
 118
 119         // returns id of object
 120         int id(XmlObject *object) const { return object->m_key->info(); }
 121
 122         // true <=> an error in XML files has been detected
 123         bool error() const { return m_error; }
 124         // returns error message
 125         const String &errorString() const { return m_errorString; }
 126
 127         // creates graph from XML parse tree
 128         bool read(Graph &G);
 129         // creates attributed graph from XML parse tree
 130         bool read(Graph &G, GraphAttributes &AG);
 131
 132 private:
 133         void createObjectTree(istream &is, bool doCheck);
 134         void initPredefinedKeys();
 135         void setError(const char *errorString);
 136
 137         XmlObject *parseList(XmlObjectType closingKey, XmlObjectType errorKey, const char *objectBodyName);
 138         XmlObjectType getNextSymbol();
 139         bool getLine();
 140
 141         XmlKey hashString(const String &str);
 142
 143         XmlObject *getNodeIdRange(
 144                 int &minId,
 145                 int &maxId,
 146                 int &nodetypeCount,
 147                 XmlObject *graphObject);
 148
 149         bool makeIdMap(
 150                 int maxId,
 151                 Array<char*> &idMap,
 152                 int nodetypeCount,
 153                 Array<char*> & typeName,
 154                 Array<double> &typeWidth,
 155                 Array<double> &typeHeight,
 156                 XmlObject *graphObject);
 157
 158         void closeLabels(Array<char*> idMap, Array<char*>  typeName);
 159
 160         void readLineAttribute(XmlObject *object, DPolyline &dpl);
 161
 162         void destroyObjectList(XmlObject *object);
 163
 164         void indent(ostream &os, int d);
 165         void output(ostream &os, XmlObject *object, int d);
 166
 167 };
 168
 169
 170 } // end namespace ogdf
 171
 172 #endif