dotty.cc

Go to the documentation of this file.

/*--------------------------------------------------------------------
 *
 * (C) Copyright Koninklijke Philips Electronics NV 2006. 
 * All rights reserved. This software is licensed under the terms of
 * version 2.1 of the GNU Lesser General Public License as published 
 * by the Free Software Foundation. For licensing and warranty
 * information, see the file COPYING in the main directory.
 *
 *------------------------------------------------------------------*/

#include <sys/types.h>
#include "dotty.h"
#include "id.h"
#include "component.h"
#include "connector.h"
#include "networkbase.h"
#include "processbase.h"
#include "portbase.h"
#include "fifobase.h"
#include "dotdefs.h"
#include "check.h"
#include <stdio.h>

using std::ostream;
using std::string;

// Print Functions
void printDotty(ostream& o, NetworkBase* p);
void printNetwork(ostream& o, int level, NetworkBase* p, bool ismain = false);
void printProcess(ostream& o, ProcessBase* p);
void printInPort(ostream& o, int level, InPortBase* p);
void printOutPort(ostream& o, int level, OutPortBase* p);
void printFifo(ostream& o, int level, FifoBase* p);

// File Functions
bool fileCheck(const char* fileName);
void readConfig(const char* filePlace);

static ostream* g_errorStream = &std::cerr;

void printDotty(const ProcessNetwork& p, ostream& o, ostream& e)
{
  g_errorStream = &e;
  printDotty(o, (NetworkBase*)&p);
}

void printDotty(ostream& o, NetworkBase* p)
{
  const char* current = "dotty.cfg";
  char* home = getenv("HOME");

  if (home) {
    const char* cfgVisible = "/dotty.cfg";
    const char* cfgHidden = "/.dotty.cfg";
    char* home1 = new char[strlen(home) + strlen(cfgHidden) + 1];
    char* home2 = new char[strlen(home) + strlen(cfgVisible) + 1];
    strcpy(home1, home);
    strcpy(home2, home);
    strcat(home1, cfgHidden);
    strcat(home2, cfgVisible);

    // check for .dotty.cfg in the home directory
    if (fileCheck(home1)) {
      readConfig(home1);
    } 
    delete [] home1;
    
    // check for dotty.cfg in the home directory
    if (fileCheck(home2)) {
      readConfig(home2);
    }
    delete [] home2;
  } 

  // check for dotty.cfg in the current directory
  if (fileCheck(current)) {
    readConfig(current);
  }

  if (check(p, *g_errorStream) > 0)
  {
    *g_errorStream << "Errors in process network, cannot print dotty" << std::endl;
    return;
  }

  if (uniqueId(p, *g_errorStream) > 0)
  {
    *g_errorStream << "IDs in process network are not unique, cannot print dotty" << std::endl;
    return;
  }

        
  o << "digraph \"" << p->fullName() << "\" {\n"
  << " label=\"" << p->name()
  << " (" << p->type() << ")\";\n"
  << " fontname="   << DotDefs::fontNameClusterTitle << ";\n"
  << " fontsize="   << DotDefs::fontSizeClusterTitle << ";\n"
  << " fontcolor="  << DotDefs::fontColorClusterTitle << ";\n"
  << " rankdir="    << DotDefs::rankDir << ";\n"
  << " size="   << DotDefs::size << ";\n"
  << " ratio="    << DotDefs::ratio << ";\n"
  << " nodesep="    << DotDefs::nodeSep << ";\n"
  << " orientation="  << DotDefs::orientation << ";\n"
  << " center="   << DotDefs::center << ";\n"
  << " margin="   << DotDefs::margin << ";\n"
  << " node [shape="  << DotDefs::nodeShapeProcess << ",\n"
  << "       width="  << DotDefs::nodeWidthProcess << ",\n"
  << "       height=" << DotDefs::nodeHeightProcess << ",\n"
  << "       style="  << DotDefs::nodeStyle << "];\n"
  << " edge [decorate=" << DotDefs::edgeDecorate << ",\n"
  << "       weight=" << DotDefs::edgeWeight << ",\n"
  << "       minlen=" << DotDefs::edgeMinLen << "];\n\n";

  printNetwork(o, DotDefs::levelInit, p, true);

  o << "}\n\n";  
}


// Network

void printNetwork(ostream& o, int level, NetworkBase* p, bool ismain)
{
  if (level > 0)
  {
    // print Level as a Cluster
    if (!ismain)
    {
      o << "\n\nsubgraph \"cluster_" << p->fullName() << "\"{\n"
      << " label=\"" << p->name()
      << " (" << p->type() << ")\";\n"
      << " fontname=" << DotDefs::fontNameClusterTitle << ";\n"
      << " fontcolor=" << DotDefs::fontColorClusterTitle << ";\n"
      << " fontsize=" << DotDefs::fontSizeClusterTitle << ";\n";
          } 

    // Make sure InPorts are at beginning and OutPorts are at end
    // to improve the networkport layout

    unsigned int nrip = 0;
    if (nrip < p->nrInPorts()) 
    {
      o << "{rank = min";
      for (nrip = 0; nrip < p->nrInPorts(); ++nrip) 
      {
        o << ";\n\"" << p->getInPort(nrip)->fullName() << "\"";
          }
      o << "};\n\n";
    }    

          unsigned int nrop = 0;
    if (nrop < p->nrOutPorts()) {
      o << "{rank = max";
      for (nrop = 0; nrop < p->nrOutPorts(); ++nrop)
      {
        o << ";\n\"" << p->getOutPort(nrop)->fullName() << "\"";
      }
      o << "};\n\n";
    }    
  
    // InPorts
    for (nrip = 0; nrip < p->nrInPorts(); ++nrip) {
      printInPort(o, level, p->getInPort(nrip));
    }
  
   
    // OutPorts
    for (nrop = 0; nrop < p->nrOutPorts(); ++nrop) {
      printOutPort(o, level, p->getOutPort(nrop));
    }
     
     
    // Processes
    for (unsigned int nrpr = 0; nrpr < p->nrProcesses(); ++nrpr) {
      printProcess(o, p->getProcess(nrpr));
    }    
  

    // Networks
    for (unsigned int nrnw = 0; nrnw < p->nrNetworks(); ++nrnw) {
      printNetwork(o, level-1, p->getNetwork(nrnw));
    }    


    // Fifos
    for (unsigned int nrfi = 0; nrfi < p->nrFifos(); ++nrfi) {
      printFifo(o, level, p->getFifo(nrfi));
    }    
     
    if (!ismain) {
      o << "}\n\n";
    }

  } else {
    // print Level as a Node                         
    
    int li = DotDefs::levelInit + 1;
  
    o << "\"" << p->fullName() << "\""
    << " [label=\"" << p->name() << "\\n(" << p->type() << ")"
    << "|" << li << "\""
    << ", shape=" << DotDefs::nodeShapeProcessNetwork
    << ", width=" << DotDefs::nodeWidthProcessNetwork
    << ", height=" << DotDefs::nodeHeightProcessNetwork
    << ", style=" << DotDefs::nodeStyle
    << ", fontname=" << DotDefs::fontNameProcessNetwork
    << ", fontcolor=" << DotDefs::fontColorProcessNetwork
    << ", fontsize=" << DotDefs::fontSizeProcessNetwork
    << ", color=" << DotDefs::nodeColorProcessNetwork << "];\n";
  }
}


// Process

void printProcess(ostream& o, ProcessBase* p)
{
  o << "\"" << p->fullName() << "\""
  << " [label=\"" << p->name() 
  << "\\n(" << p->type() << ")\""
  << ", fontname=" << DotDefs::fontNameProcess
  << ", fontsize=" << DotDefs::fontSizeProcess
  << ", fontcolor=" << DotDefs::fontColorProcess
  << ", color=" << DotDefs::nodeColorProcess << "];\n";
}


// InPort

void printInPort(ostream& o, int level, InPortBase* p)
{
  o << "\"" << p->fullName() << "\""
    << " [label=\"" << p->name() << "\""
    << ", shape=" << DotDefs::nodeShapePort 
    << ", color=" << DotDefs::nodeColorPort
    << ", width=" << DotDefs::nodeWidthPort
    << ", height="  << DotDefs::nodeHeightPort
    << ", fontname="  << DotDefs::fontNamePort
    << ", fontcolor=" << DotDefs::fontColorPort
    << ", fontsize="  << DotDefs::fontSizePort << "];\n";
      
  if (level > 0) {
    string otherName, thisName = p->fullName();
    
    for(unsigned int i=0; i<p->nrDst(); i++)
    {
      InPortBase* myDestination = p->getDstPort(i);
        
      if (myDestination->nrDst() == 0) {  // processInPort
        otherName = myDestination->parent()->fullName();
      }
      else if (level == 1) {  // networkLevel
        otherName = myDestination->parent()->fullName(); 
      }
      else {  // networkInPort  
        otherName = myDestination->fullName();
      }  

      o << "\"" << thisName << "\""
        << " -> "
        << "\"" << otherName << "\""
        << ";\n";
    }
  }
}       


// OutPort

void printOutPort(ostream& o, int level, OutPortBase* p)
{
    o << "\"" << p->fullName() << "\""
      << " [label=\"" << p->name() << "\""
      << ", shape=" << DotDefs::nodeShapePort 
      << ", color=" << DotDefs::nodeColorPort
      << ", width=" << DotDefs::nodeWidthPort
      << ", height="  << DotDefs::nodeHeightPort
      << ", fontname="  << DotDefs::fontNamePort
      << ", fontcolor=" << DotDefs::fontColorPort
      << ", fontsize="  << DotDefs::fontSizePort << "];\n";
      
  if (level > 0) {
    string otherName, thisName = p->fullName();
    OutPortBase* mySource = p->getSrcPort();
        
    if (mySource->nrSrc() == 0) {                      // processOutPort  
      otherName = mySource->parent()->fullName();
    }
    else if (level == 1) {                             // networkLevel
      otherName = mySource->parent()->fullName();  
    }
    else {                                        // networkOutPort
      otherName = mySource->fullName();
    }

    o << "\"" << otherName << "\""
      << " -> "
      << "\"" << thisName << "\""
      << ";\n";
  }
}       


// Fifo

void printFifo(ostream& o, int level, FifoBase* p)
{   
  for(unsigned int i=0; i<p->nrDst(); i++)
  {
    OutPortBase* mySource = p->srcPort();
    InPortBase* myDestination = p->dstPort(i);

    string sourceName, destName, fifoName = p->fullName();
  
    if (mySource->nrSrc() == 0) {                        // processOutPort
      sourceName = mySource->parent()->fullName();
    }
    else if (level == 1) {                               // networkLevel
      sourceName = mySource->parent()->fullName();
    }
    else {                                          // networkOutPort
      sourceName = mySource->fullName();    
    }
    
    if (myDestination->nrDst() == 0) {                   // processInPort
      destName = myDestination->parent()->fullName();
    }
    else if (level == 1) {                               // networkLevel
      destName = myDestination->parent()->fullName();
    }  
    else {                                          // networkInPort
      destName = myDestination->fullName();
    }
   
    if (DotDefs::nodeFifo == "true") {        // print Fifo as a Node

        o << "\"" << p->fullName() << "\""
          << " [label=\"" << p->name() << "\""
          << ", shape="   << DotDefs::nodeShapeFifo 
          << ", color="   << DotDefs::nodeColorFifo
          << ", width="   << DotDefs::nodeWidthFifo
          << ", height="  << DotDefs::nodeHeightFifo
          << ", fontname="  << DotDefs::fontNameFifo
          << ", fontcolor=" << DotDefs::fontColorFifo
          << ", fontsize="  << DotDefs::fontSizeFifo << "];\n";

        o << "\"" << sourceName << "\""
          << " -> "
          << "\"" << fifoName << "\""
          << ";\n";
  
        o << "\"" << fifoName << "\""
          << " -> "
          << "\"" << destName << "\""
          << ";\n";
    }
    else {                                    // print Fifo as an Edge

         o << "\"" << sourceName << "\" -> \"" << destName << "\""
           << " [ label = \"" << p->name() << "\""
           << ",  fontname="  << DotDefs::fontNameFifo
           << ",  fontcolor=" << DotDefs::fontColorFifo
           << ",  fontsize="  << DotDefs::fontSizeFifo << "];\n";
    }
  }
}


// File Functions

bool fileCheck(const char* fileName)
{
    FILE* fp = fopen(fileName, "r");
    if (fp) {
        fclose(fp);
  return true;
    }
    else return false;
}

void readConfig(const char* filePlace)
{
    extern bool readDottyConfiguration(const char* f, ostream&);
    readDottyConfiguration(filePlace, *g_errorStream);
}  

---