DOTGraphTraits.h

Go to the documentation of this file.

//===-- Graphs/DOTGraphTraits.h - Customize .dot output ---*- C++ -*-===//
//
// From the LLVM Project with some modifications, under the Apache License v2.0
// with LLVM Exceptions. See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines a template class that can be used to customize dot output
// graphs generated by the GraphWriter.h file.  The default implementation of
// this file will produce a simple, but not very polished graph.  By
// specializing this template, lots of customization opportunities are possible.
//
//===----------------------------------------------------------------------===//
 
#ifndef GRAPHS_DOTGRAPHTRAITS_H
#define GRAPHS_DOTGRAPHTRAITS_H
 
#include <string>
 
namespace SVF
{
 
struct DefaultDOTGraphTraits
{
private:
    bool IsSimple;
 
protected:
    bool isSimple()
    {
        return IsSimple;
    }
 
public:
    explicit DefaultDOTGraphTraits(bool simple=false) : IsSimple (simple) {}
 
    template<typename GraphType>
    static std::string getGraphName(const GraphType &)
    {
        return "";
    }
 
    template<typename GraphType>
    static std::string getGraphProperties(const GraphType &)
    {
        return "";
    }
 
    static bool renderGraphFromBottomUp()
    {
        return false;
    }
 
    template <typename NodeT>
    static const void *getNodeIdentifier(NodeT N)
    {
        return static_cast<const void *>(N);
    }
 
    template <typename NodeT, typename GraphType>
    static bool isNodeHidden(NodeT, const GraphType &)
    {
        return false;
    }
 
    template<typename NodeT, typename GraphType>
    std::string getNodeLabel(NodeT, const GraphType &)
    {
        return "";
    }
 
    // getNodeIdentifierLabel - Returns a string representing the
    // address or other unique identifier of the node. (Only used if
    // non-empty.)
    template <typename NodeT, typename GraphType>
    static std::string getNodeIdentifierLabel(NodeT, const GraphType &)
    {
        return "";
    }
 
    template<typename NodeT, typename GraphType>
    static std::string getNodeDescription(NodeT, const GraphType &)
    {
        return "";
    }
 
    template<typename NodeT, typename GraphType>
    static std::string getNodeAttributes(NodeT,
                                         const GraphType &)
    {
        return "";
    }
 
    template<typename NodeT, typename EdgeIter, typename GraphType>
    static std::string getEdgeAttributes(NodeT, EdgeIter,
                                         const GraphType &)
    {
        return "";
    }
 
    template<typename NodeT, typename EdgeIter>
    static std::string getEdgeSourceLabel(NodeT, EdgeIter)
    {
        return "";
    }
 
    template<typename NodeT, typename EdgeIter>
    static bool edgeTargetsEdgeSource(NodeT, EdgeIter)
    {
        return false;
    }
 
    template<typename NodeT, typename EdgeIter>
    static EdgeIter getEdgeTarget(NodeT, EdgeIter I)
    {
        return I;
    }
 
    static bool hasEdgeDestLabels()
    {
        return false;
    }
 
    template<typename NodeT>
    static unsigned numEdgeDestLabels(NodeT)
    {
        return 0;
    }
 
    template<typename NodeT>
    static std::string getEdgeDestLabel(NodeT, unsigned)
    {
        return "";
    }
 
    template<typename GraphType, typename GraphWriter>
    static void addCustomGraphFeatures(const GraphType &, GraphWriter &) {}
};
 
 
template <typename Ty>
struct DOTGraphTraits : public DefaultDOTGraphTraits
{
    DOTGraphTraits (bool simple=false) : DefaultDOTGraphTraits (simple) {}
};
 
} // End llvm namespace
 
#endif