GraphDumper.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#include "GraphDumper.h"
 
#include <boost/algorithm/string/replace.hpp>
 
namespace {
  std::string escapeSpecialCharactersForMl( std::string_view view ) {
    std::string result;
    result.reserve( view.size() * 6 ); // Worst case: all characters become "&quot;" (6 chars)
    for ( char c : view ) {
      switch ( c ) {
      case '&':
        result += "&amp;";
        break;
      case '<':
        result += "&lt;";
        break;
      case '>':
        result += "&gt;";
        break;
      case '"':
        result += "&quot;";
        break;
      default:
        result.push_back( c );
        break;
      }
    }
 
    return std::string{ result };
  }
} // namespace
 
namespace Gaudi::Hive {
 
  Graph::Graph( std::string_view fileName, FileType type ) : m_fileName{ fileName }, m_type{ type } {
    // find out type of file if not given
    if ( type == FileType::UNKNOWN ) {
      // Check file extension
      if ( m_fileName.ends_with( ".dot" ) ) {
        m_type = FileType::DOT;
      } else if ( m_fileName.ends_with( ".md" ) ) {
        m_type = FileType::MD;
      } else if ( m_fileName.ends_with( ".graphml" ) ) {
        m_type = FileType::ML;
      } else {
        m_type = FileType::DOT;
        m_fileName += ".dot";
      }
    }
    // open file
    m_stream = std::ofstream{ m_fileName, std::ofstream::out };
    writeHeader();
  }
 
  Graph::~Graph() {
    writeTrailer();
    m_stream.close();
  }
 
  std::string const& Graph::fileName() { return m_fileName; }
 
  void Graph::addNode( std::string_view id, std::string_view name ) {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "  " << id << " [label=\"" << name << "\";shape=box];\n";
      break;
    case FileType::MD:
      m_stream << "  " << id << "{{" << name << "}}\n";
      break;
    case FileType::ML:
      m_stream << "    <node id=\"" << id
               << "\">\n"
                  "      <data key=\"d0\">"
               << escapeSpecialCharactersForMl( name )
               << "</data>\n"
                  "    </node>\n";
      break;
    case FileType::UNKNOWN:
      break;
    }
  };
 
  void Graph::addEdge( std::string_view srcId, std::string_view tgtId, std::string_view label ) {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "  " << srcId << " -> " << tgtId;
      if ( label != "" ) m_stream << " [label=\"" << label << "\"]";
      m_stream << ";\n";
      break;
    case FileType::MD:
      m_stream << "  " << srcId << " --> " << tgtId;
      if ( label != "" ) m_stream << " : " << label;
      m_stream << "\n";
      break;
    case FileType::ML:
      if ( label != "" ) {
        m_stream << "    <edge source=\"" << srcId << "\" target=\"" << tgtId
                 << "\">\n"
                    "      <data key=\"d1\">"
                 << escapeSpecialCharactersForMl( label )
                 << "</data>\n"
                    "    </edge>\n";
      } else {
        m_stream << "    <edge source=\"" << srcId << "\" target=\"" << tgtId << "\"/>\n";
      }
      break;
    case FileType::UNKNOWN:
      break;
    }
  };
 
  //---------------------------------------------------------------------------
 
  void Graph::writeHeader() {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "digraph datadeps {\n  rankdir=\"LR\";\n";
      break;
    case FileType::MD:
      m_stream << "```mermaid\ngraph LR;\n\n";
      break;
    case FileType::ML:
      m_stream << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
                  "<graphml xmlns=\"http://graphml.graphdrawing.org/xmlns\"\n"
                  "         xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
                  "         xsi:schemaLocation=\"http://graphml.graphdrawing.org/xmlns "
                  "http://graphml.graphdrawing.org/xmlns/1.0/graphml.xsd\">\n"
                  "  <key id=\"d1\" for=\"edge\" attr.name=\"label\" attr.type=\"string\"/>\n"
                  "  <key id=\"d0\" for=\"node\" attr.name=\"label\" attr.type=\"string\"/>\n"
                  "  <graph id=\"Dependencies\" edgedefault=\"directed\">\n";
      break;
    case FileType::UNKNOWN:
      break;
    }
  }
 
  void Graph::writeTrailer() {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "}\n";
      break;
    case FileType::MD:
      m_stream << "```\n";
      break;
    case FileType::ML:
      m_stream << "  </graph>\n</graphml>";
      break;
    case FileType::UNKNOWN:
      break;
    }
  }
 
} // end namespace Gaudi::Hive