OgmlParser.h

Go to the documentation of this file.

/*
 * $Revision: 2523 $
 *
 * last checkin:
 *   $Author: gutwenger $
 *   $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
 ***************************************************************/

#ifdef _MSC_VER
#pragma once
#endif

//KK: Commented out the constraint stuff using //o
//CG: compound graph stuff has been removed with commit 2465

#ifndef OGDF_OGML_PARSER_H
#define OGDF_OGML_PARSER_H

#include <ogdf/fileformats/Ogml.h>
#include <ogdf/fileformats/DinoXmlParser.h>
#include <ogdf/basic/Hashing.h>
#include <ogdf/basic/String.h>
#include <ogdf/cluster/ClusterGraph.h>
#include <ogdf/cluster/ClusterGraphAttributes.h>

// constraints
//o#include <ogdf/Constraints.h>


namespace ogdf {

//
// ---------- O g m l P a r s e r ------------------------
//

class OgmlParser
{
private:

    // struct definitions for mapping of templates
    struct OgmlNodeTemplate;
    struct OgmlEdgeTemplate;
    //struct OgmlLabelTemplate;

    struct OgmlSegment;

    class OgmlAttributeValue;
    class OgmlAttribute;
    class OgmlTag;

    friend ostream& operator<<(ostream& os, const OgmlParser::OgmlAttribute& oa);
    friend ostream& operator<<(ostream& os, const OgmlParser::OgmlTag& ot);

    static Hashing<int, OgmlTag>            *s_tags;       
    static Hashing<int, OgmlAttribute>      *s_attributes; 
    static Hashing<int, OgmlAttributeValue> *s_attValues;  


    static void buildHashTables();

    mutable Ogml::GraphType m_graphType; 

    Hashing<String, const XmlTagObject*> m_ids; 

    int validate(const XmlTagObject *xmlTag, int ogmlTag);

    //bool validate(const char* fileName);

    void printValidityInfo(const OgmlTag &ot,
        const XmlTagObject &xto,
        int valStatus,
        int line);

    //bool getXmlTagObjectById(XmlTagObject *recTag, String id, XmlTagObject *&xmlTag);

    bool checkGraphType(const XmlTagObject *xmlTag) const;

    bool isGraphHierarchical(const XmlTagObject *xmlTag) const;

    bool isNodeHierarchical(const XmlTagObject *xmlTag) const;

    Ogml::GraphType getGraphType() { return m_graphType; };


    // id hash tables
    // required variables for building
    // hash table with id from file and node
    Hashing<String, node> m_nodes;
    Hashing<String, edge> m_edges;
    Hashing<String, cluster> m_clusters;
    // hash table for bend-points
    Hashing<String, DPoint> m_points;

    // hash table for checking uniqueness of ids
    // (key:) int = id in the created graph
    // (info:) String = id in the ogml file
    Hashing<int, String> m_nodeIds;
    Hashing<int, String> m_edgeIds;
    Hashing<int, String> m_clusterIds;

    // build methods

    bool buildGraph(Graph &G);

    bool buildCluster(
        const XmlTagObject *rootTag,
        Graph &G,
        ClusterGraph &CG);

    bool buildClusterRecursive(
        const XmlTagObject *xmlTag,
        cluster parent,
        Graph &G,
        ClusterGraph &CG);

    bool buildAttributedClusterGraph(
        Graph &G,
        ClusterGraphAttributes &CGA,
        const XmlTagObject *root);

    bool setLabelsRecursive(
        Graph &G,
        ClusterGraphAttributes &CGA,
        XmlTagObject *root);

    // helping pointer for constraints-loading
    // this pointer is set in the building methods
    // so we don't have to traverse the tree in buildConstraints
    XmlTagObject* m_constraintsTag;

    // hashing lists for templates
    //  string = id
    Hashing<String, OgmlNodeTemplate*> m_ogmlNodeTemplates;
    Hashing<String, OgmlEdgeTemplate*> m_ogmlEdgeTemplates;
    //Hashing<String, OgmlLabelTemplate> m_ogmlLabelTemplates;

    // auxiliary methods for mapping graph attributes

    int getBrushPatternAsInt(String s);

    int getShapeAsInt(String s);

    String getNodeTemplateFromOgmlValue(String s);

    int getLineTypeAsInt(String s);

    int getImageStyleAsInt(String s);

    int getImageAlignmentAsInt(String s);

    // arrow style, actually a "boolean" function
    // because it returns only 0 or 1 according to GDE
    // sot <=> source or target
    int getArrowStyleAsInt(String s, String sot);

    // the matching method to getArrowStyleAsInt
    GraphAttributes::EdgeArrow getArrowStyle(int i);

    // function that operates on a string
    // the input string contains "&lt;" instead of "<"
    //  and "&gt;" instead of ">"
    //  to disable interpreting the string as xml-tags (by DinoXmlParser)
    // so this function substitutes  "<" for "&lt;"
    String getLabelCaptionFromString(String str);

    bool getIdFromString(String str, int &id);

    void validate(const char* fileName);

public:

    OgmlParser() { }

    ~OgmlParser() { }



    bool read(
        const char* fileName,
        Graph &G,
        ClusterGraph &CG);


    bool read(
        const char* fileName,
        Graph &G,
        ClusterGraph &CG,
        ClusterGraphAttributes &CGA);

};//end class OGMLParser

}//end namespace ogdf

#endif