Blame src/msc.cpp

Packit Service 50c9f2
/******************************************************************************
Packit Service 50c9f2
 *
Packit Service 50c9f2
 * 
Packit Service 50c9f2
 *
Packit Service 50c9f2
 * Copyright (C) 1997-2015 by Dimitri van Heesch.
Packit Service 50c9f2
 *
Packit Service 50c9f2
 * Permission to use, copy, modify, and distribute this software and its
Packit Service 50c9f2
 * documentation under the terms of the GNU General Public License is hereby 
Packit Service 50c9f2
 * granted. No representations are made about the suitability of this software 
Packit Service 50c9f2
 * for any purpose. It is provided "as is" without express or implied warranty.
Packit Service 50c9f2
 * See the GNU General Public License for more details.
Packit Service 50c9f2
 *
Packit Service 50c9f2
 * Documents produced by Doxygen are derivative works derived from the
Packit Service 50c9f2
 * input used in their production; they are not affected by this license.
Packit Service 50c9f2
 *
Packit Service 50c9f2
 */
Packit Service 50c9f2
Packit Service 50c9f2
#include "msc.h"
Packit Service 50c9f2
#include "portable.h"
Packit Service 50c9f2
#include "config.h"
Packit Service 50c9f2
#include "message.h"
Packit Service 50c9f2
#include "docparser.h"
Packit Service 50c9f2
#include "doxygen.h"
Packit Service 50c9f2
#include "index.h"
Packit Service 50c9f2
#include "util.h"
Packit Service 50c9f2
#include "ftextstream.h"
Packit Service 50c9f2
Packit Service 50c9f2
#include <qdir.h>
Packit Service 50c9f2
Packit Service 50c9f2
static const int maxCmdLine = 40960;
Packit Service 50c9f2
Packit Service 50c9f2
static bool convertMapFile(FTextStream &t,const char *mapName,const QCString relPath,
Packit Service 50c9f2
                           const QCString &context)
Packit Service 50c9f2
{
Packit Service 50c9f2
  QFile f(mapName);
Packit Service 50c9f2
  if (!f.open(IO_ReadOnly))
Packit Service 50c9f2
  {
Packit Service 50c9f2
    err("failed to open map file %s for inclusion in the docs!\n"
Packit Service 50c9f2
        "If you installed Graphviz/dot after a previous failing run, \n"
Packit Service 50c9f2
        "try deleting the output directory and rerun doxygen.\n",mapName);
Packit Service 50c9f2
    return FALSE;
Packit Service 50c9f2
  }
Packit Service 50c9f2
  const int maxLineLen=1024;
Packit Service 50c9f2
  char buf[maxLineLen];
Packit Service 50c9f2
  char url[maxLineLen];
Packit Service 50c9f2
  char ref[maxLineLen];
Packit Service 50c9f2
  int x1,y1,x2,y2;
Packit Service 50c9f2
  while (!f.atEnd())
Packit Service 50c9f2
  {
Packit Service 50c9f2
    bool isRef = FALSE;
Packit Service 50c9f2
    int numBytes = f.readLine(buf,maxLineLen);
Packit Service 50c9f2
    buf[numBytes-1]='\0';
Packit Service 50c9f2
    //printf("ReadLine `%s'\n",buf);
Packit Service 50c9f2
    if (qstrncmp(buf,"rect",4)==0)
Packit Service 50c9f2
    {
Packit Service 50c9f2
      // obtain the url and the coordinates in the order used by graphviz-1.5
Packit Service 50c9f2
      sscanf(buf,"rect %s %d,%d %d,%d",url,&x1,&y1,&x2,&y2;;
Packit Service 50c9f2
Packit Service 50c9f2
      if (qstrcmp(url,"\\ref")==0 || qstrcmp(url,"@ref")==0)
Packit Service 50c9f2
      {
Packit Service 50c9f2
        isRef = TRUE;
Packit Service 50c9f2
        sscanf(buf,"rect %s %s %d,%d %d,%d",ref,url,&x1,&y1,&x2,&y2;;
Packit Service 50c9f2
      }
Packit Service 50c9f2
Packit Service 50c9f2
      // sanity checks
Packit Service 50c9f2
      if (y2
Packit Service 50c9f2
      if (x2
Packit Service 50c9f2
Packit Service 50c9f2
      t << "
Packit Service 50c9f2
Packit Service 50c9f2
      if ( isRef )
Packit Service 50c9f2
      {
Packit Service 50c9f2
        // handle doxygen \ref tag URL reference
Packit Service 50c9f2
        DocRef *df = new DocRef( (DocNode*) 0, url, context );
Packit Service 50c9f2
        t << externalRef(relPath,df->ref(),TRUE);
Packit Service 50c9f2
        if (!df->file().isEmpty()) t << df->file() << Doxygen::htmlFileExtension;
Packit Service 50c9f2
        if (!df->anchor().isEmpty()) t << "#" << df->anchor();
Packit Service 50c9f2
        delete df;
Packit Service 50c9f2
      }
Packit Service 50c9f2
      else
Packit Service 50c9f2
      {
Packit Service 50c9f2
        t << url;
Packit Service 50c9f2
      }
Packit Service 50c9f2
      t << "\" shape=\"rect\" coords=\""
Packit Service 50c9f2
        << x1 << "," << y1 << "," << x2 << "," << y2 << "\""
Packit Service 50c9f2
        << " alt=\"\"/>" << endl;
Packit Service 50c9f2
    }
Packit Service 50c9f2
  }
Packit Service 50c9f2
Packit Service 50c9f2
  return TRUE;
Packit Service 50c9f2
}
Packit Service 50c9f2
Packit Service 50c9f2
void writeMscGraphFromFile(const char *inFile,const char *outDir,
Packit Service 50c9f2
                           const char *outFile,MscOutputFormat format)
Packit Service 50c9f2
{
Packit Service 50c9f2
  QCString absOutFile = outDir;
Packit Service 50c9f2
  absOutFile+=portable_pathSeparator();
Packit Service 50c9f2
  absOutFile+=outFile;
Packit Service 50c9f2
Packit Service 50c9f2
  // chdir to the output dir, so dot can find the font file.
Packit Service 50c9f2
  QCString oldDir = QDir::currentDirPath().utf8();
Packit Service 50c9f2
  // go to the html output directory (i.e. path)
Packit Service 50c9f2
  QDir::setCurrent(outDir);
Packit Service 50c9f2
  //printf("Going to dir %s\n",QDir::currentDirPath().data());
Packit Service 50c9f2
  QCString mscExe = Config_getString(MSCGEN_PATH)+"mscgen"+portable_commandExtension();
Packit Service 50c9f2
  QCString mscArgs;
Packit Service 50c9f2
  QCString imgName = outFile;
Packit Service 50c9f2
  switch (format)
Packit Service 50c9f2
  {
Packit Service 50c9f2
    case MSC_BITMAP:
Packit Service 50c9f2
      mscArgs+="-T png";
Packit Service 50c9f2
      imgName+=".png";
Packit Service 50c9f2
      break;
Packit Service 50c9f2
    case MSC_EPS:
Packit Service 50c9f2
      mscArgs+="-T eps";
Packit Service 50c9f2
      imgName+=".eps";
Packit Service 50c9f2
      break;
Packit Service 50c9f2
    case MSC_SVG:
Packit Service 50c9f2
      mscArgs+="-T svg";
Packit Service 50c9f2
      imgName+=".svg";
Packit Service 50c9f2
      break;
Packit Service 50c9f2
    default:
Packit Service 50c9f2
      goto error; // I am not very fond of goto statements, but when in Rome...
Packit Service 50c9f2
  }
Packit Service 50c9f2
  mscArgs+=" -i \"";
Packit Service 50c9f2
  mscArgs+=inFile;
Packit Service 50c9f2
 
Packit Service 50c9f2
  mscArgs+="\" -o \"";
Packit Service 50c9f2
  mscArgs+=imgName+"\"";
Packit Service 50c9f2
  int exitCode;
Packit Service 50c9f2
//  printf("*** running: %s %s outDir:%s %s\n",mscExe.data(),mscArgs.data(),outDir,outFile);
Packit Service 50c9f2
  portable_sysTimerStart();
Packit Service 50c9f2
  if ((exitCode=portable_system(mscExe,mscArgs,FALSE))!=0)
Packit Service 50c9f2
  {
Packit Service 50c9f2
    portable_sysTimerStop();
Packit Service 50c9f2
    goto error;
Packit Service 50c9f2
  }
Packit Service 50c9f2
  portable_sysTimerStop();
Packit Service 50c9f2
  if ( (format==MSC_EPS) && (Config_getBool(USE_PDFLATEX)) )
Packit Service 50c9f2
  {
Packit Service 50c9f2
    QCString epstopdfArgs(maxCmdLine);
Packit Service 50c9f2
    epstopdfArgs.sprintf("\"%s.eps\" --outfile=\"%s.pdf\"",
Packit Service 50c9f2
                         outFile,outFile);
Packit Service 50c9f2
    portable_sysTimerStart();
Packit Service 50c9f2
    if (portable_system("epstopdf",epstopdfArgs)!=0)
Packit Service 50c9f2
    {
Packit Service 50c9f2
      err("Problems running epstopdf. Check your TeX installation!\n");
Packit Service 50c9f2
    }
Packit Service 50c9f2
    portable_sysTimerStop();
Packit Service 50c9f2
  }
Packit Service 50c9f2
Packit Service 50c9f2
  Doxygen::indexList->addImageFile(imgName);
Packit Service 50c9f2
Packit Service 50c9f2
error:
Packit Service 50c9f2
  QDir::setCurrent(oldDir);
Packit Service 50c9f2
}
Packit Service 50c9f2
Packit Service 50c9f2
QCString getMscImageMapFromFile(const QCString& inFile, const QCString& outDir,
Packit Service 50c9f2
                                const QCString& relPath,const QCString& context)
Packit Service 50c9f2
{
Packit Service 50c9f2
  QCString outFile = inFile + ".map";
Packit Service 50c9f2
Packit Service 50c9f2
Packit Service 50c9f2
  //printf("*** running:getMscImageMapFromFile \n");
Packit Service 50c9f2
  // chdir to the output dir, so dot can find the font file.
Packit Service 50c9f2
  QCString oldDir = QDir::currentDirPath().utf8();
Packit Service 50c9f2
  // go to the html output directory (i.e. path)
Packit Service 50c9f2
  QDir::setCurrent(outDir);
Packit Service 50c9f2
  //printf("Going to dir %s\n",QDir::currentDirPath().data());
Packit Service 50c9f2
Packit Service 50c9f2
  QCString mscExe = Config_getString(MSCGEN_PATH)+"mscgen"+portable_commandExtension();
Packit Service 50c9f2
  QCString mscArgs = "-T ismap -i \"";
Packit Service 50c9f2
  mscArgs+=inFile;
Packit Service 50c9f2
  mscArgs+="\" -o \"";
Packit Service 50c9f2
  mscArgs+=outFile + "\"";
Packit Service 50c9f2
Packit Service 50c9f2
  int exitCode;
Packit Service 50c9f2
  portable_sysTimerStart();
Packit Service 50c9f2
  if ((exitCode=portable_system(mscExe,mscArgs,FALSE))!=0)
Packit Service 50c9f2
  {
Packit Service 50c9f2
    portable_sysTimerStop();
Packit Service 50c9f2
    QDir::setCurrent(oldDir);
Packit Service 50c9f2
    return "";
Packit Service 50c9f2
  }
Packit Service 50c9f2
  portable_sysTimerStop();
Packit Service 50c9f2
  
Packit Service 50c9f2
  QGString result;
Packit Service 50c9f2
  FTextStream tmpout(&result);
Packit Service 50c9f2
  convertMapFile(tmpout, outFile, relPath, context);
Packit Service 50c9f2
  QDir().remove(outFile);
Packit Service 50c9f2
Packit Service 50c9f2
  QDir::setCurrent(oldDir);
Packit Service 50c9f2
  return result.data();
Packit Service 50c9f2
}
Packit Service 50c9f2
Packit Service 50c9f2
void writeMscImageMapFromFile(FTextStream &t,const QCString &inFile,
Packit Service 50c9f2
                              const QCString &outDir,
Packit Service 50c9f2
                              const QCString &relPath,
Packit Service 50c9f2
                              const QCString &baseName,
Packit Service 50c9f2
                              const QCString &context,
Packit Service 50c9f2
			      MscOutputFormat format
Packit Service 50c9f2
 			    )
Packit Service 50c9f2
{
Packit Service 50c9f2
  QCString mapName = baseName+".map";
Packit Service 50c9f2
  t << "
Packit Service 50c9f2
  switch (format)
Packit Service 50c9f2
  {
Packit Service 50c9f2
    case MSC_BITMAP:
Packit Service 50c9f2
      t << "png";
Packit Service 50c9f2
      break;
Packit Service 50c9f2
    case MSC_EPS:
Packit Service 50c9f2
      t << "eps";
Packit Service 50c9f2
      break;
Packit Service 50c9f2
    case MSC_SVG:
Packit Service 50c9f2
      t << "svg";
Packit Service 50c9f2
      break;
Packit Service 50c9f2
    default:
Packit Service 50c9f2
      t << "unknown";
Packit Service 50c9f2
  }
Packit Service 50c9f2
  t << "\" alt=\""
Packit Service 50c9f2
    << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\"/>" << endl;
Packit Service 50c9f2
  QCString imap = getMscImageMapFromFile(inFile,outDir,relPath,context);
Packit Service 50c9f2
  t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">" << imap << "</map>" << endl;
Packit Service 50c9f2
}
Packit Service 50c9f2