ext/OGDF/ogdf/fileformats/XmlObject.h

   1 /*
   2  * $Revision: 2523 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of class XmlObject.
  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_OBJECT_H
  49 #define OGDF_XML_OBJECT_H
  50
  51
  52
  53 namespace ogdf {
  54
  55
  56 typedef HashElement<String,int> *XmlKey;
  57 enum XmlObjectType { xmlIntValue, xmlDoubleValue, xmlStringValue, xmlListBegin,
  58         xmlListEnd, xmlKey, xmlEOF, xmlError };
  59
  60
  61 //---------------------------------------------------------
  62 // XmlObject
  63 // represents node in XML parse tree
  64 //---------------------------------------------------------
  65 struct OGDF_EXPORT XmlObject {
  66
  67         XmlObject *m_pBrother; // brother of node in tree
  68         XmlKey m_key; // tag of node
  69         XmlObjectType m_valueType; // type of node
  70
  71         // the entry in the union is selected according to m_valueType:
  72         //   xmlIntValue -> m_intValue
  73         //   xmlDoubleValue -> m_doubleValue
  74         //   xmlStringValue -> m_stringValue
  75         //   xmlListBegin -> m_pFirstSon (in case of a list, m_pFirstSon is pointer
  76         //     to first son and the sons are chained by m_pBrother)
  77         union {
  78                 int m_intValue;
  79                 double m_doubleValue;
  80                 const char *m_stringValue;
  81                 XmlObject *m_pFirstSon;
  82         };
  83
  84         // construction
  85
  86         // Some Reference on the XML notation:
  87         // XML consists of one or more elements.
  88         // An element is marked with the following form:
  89         //              <body>
  90         //              elementinformation
  91         //              </body>
  92         // The opening <body> and the closing </body> are the tags
  93         // of the element. The text between the two tags is considered
  94         // part of the element.
  95         // Elemets can have attributes applied, e.g.
  96         //              <body style="bold">blablabla</body>
  97         // The attribute is specified inside the opening tag
  98         // and is called "style". It is given a value "bold" which is expressed
  99         // inside quotation marks.
 100
 101
 102
 103         // Stores the "tag" of an XML element
 104         XmlObject(XmlKey key) : m_pBrother(0), m_key(key),
 105                 m_valueType(xmlListBegin), m_pFirstSon(0)  { }
 106
 107         // Stores an integer "attribute" of an XML element
 108         XmlObject(XmlKey key, int intValue) : m_pBrother(0), m_key(key),
 109                 m_valueType(xmlIntValue), m_intValue(intValue)  { }
 110
 111         // Stores a double "attribute" of an XML element
 112         XmlObject(XmlKey key, double doubleValue) : m_pBrother(0), m_key(key),
 113                 m_valueType(xmlDoubleValue), m_doubleValue(doubleValue)  { }
 114
 115         // Stores a string "attribute" of an XML element
 116         XmlObject(XmlKey key, const char *stringValue) : m_pBrother(0), m_key(key),
 117                 m_valueType(xmlStringValue), m_stringValue(stringValue)  { }
 118
 119         // Stores the body of the element
 120         XmlObject(const char *stringValue) : m_pBrother(0), m_key(0),
 121                 m_valueType(xmlStringValue), m_stringValue(stringValue)  { }
 122
 123
 124         OGDF_NEW_DELETE
 125 };
 126
 127 } // end namespace ogdf
 128
 129 #endif