The msc.h File Reference

Enumerations Index

enum class	MscOutputFormat { ... }

Functions Index

void	writeMscGraphFromFile (const QCString &inFile, const QCString &outDir, const QCString &outFile, MscOutputFormat format, const QCString &srcFile, int srcLine)
QCString	getMscImageMapFromFile (const QCString &inFile, const QCString &outDir, const QCString &relPath, const QCString &context, const QCString &srcFile, int srcLine)
void	writeMscImageMapFromFile (TextStream &t, const QCString &inFile, const QCString &outDir, const QCString &relPath, const QCString &baseName, const QCString &context, MscOutputFormat format, const QCString &srcFile, int srcLine)

Enumerations

MscOutputFormat

enum class MscOutputFormat

strong

Enumeration values

BITMAP
EPS
SVG

Definition at line 22 of file msc.h.

22enum class MscOutputFormat { BITMAP, EPS, SVG };

Functions

getMscImageMapFromFile()

QCString getMscImageMapFromFile (const QCString & inFile, const QCString & outDir, const QCString & relPath, const QCString & context, const QCString & srcFile, int srcLine)

Definition at line 28 of file msc.h.

writeMscGraphFromFile()

void writeMscGraphFromFile (const QCString & inFile, const QCString & outDir, const QCString & outFile, MscOutputFormat format, const QCString & srcFile, int srcLine)

Declaration at line 24 of file msc.h, definition at line 157 of file msc.cpp.

157void writeMscGraphFromFile(const QCString &inFile,const QCString &outDir,

158 const QCString &outFile,MscOutputFormat format,

159 const QCString &srcFile,int srcLine

160 )

161{

162 QCString absOutFile = outDir;

163 absOutFile+=Portable::pathSeparator();

164 absOutFile+=outFile;

165

166 mscgen_format_t msc_format = mscgen_format_png;

167 QCString imgName = absOutFile;

168 switch (format)

169 {

170 case MscOutputFormat::BITMAP:

171 msc_format = mscgen_format_png;

172 imgName+=".png";

173 break;

174 case MscOutputFormat::EPS:

175 msc_format = mscgen_format_eps;

176 imgName+=".eps";

177 break;

178 case MscOutputFormat::SVG:

179 msc_format = mscgen_format_svg;

180 imgName+=".svg";

181 break;

182 default:

183 return;

184 }

185 if (!do_mscgen_generate(inFile,imgName,msc_format,srcFile,srcLine))

186 {

187 return;

188 }

189

190 if ( (format==MscOutputFormat::EPS) && (Config_getBool(USE_PDFLATEX)) )

191 {

192 QCString epstopdfArgs(maxCmdLine, QCString::ExplicitSize);

193 epstopdfArgs.sprintf("\"%s.eps\" --outfile=\"%s.pdf\"",

194 qPrint(absOutFile),qPrint(absOutFile));

195 if (Portable::system("epstopdf",epstopdfArgs)!=0)

196 {

197 err_full(srcFile,srcLine,"Problems running epstopdf when processing '{}.eps'. Check your TeX installation!", absOutFile);

198 }

199 else

200 {

201 Dir().remove((absOutFile + ".eps").data());

202 }

203 }

204

205 int i=std::max(imgName.findRev('/'),imgName.findRev('\\'));

206 if (i!=-1) // strip path

207 {

208 imgName=imgName.right(imgName.length()-i-1);

209 }

210 Doxygen::indexList->addImageFile(imgName);

211

212}

References BITMAP, Config_getBool, do_mscgen_generate, EPS, err_full, QCString::ExplicitSize, QCString::findRev, Doxygen::indexList, QCString::length, maxCmdLine, Portable::pathSeparator, qPrint, Dir::remove, QCString::right, QCString::sprintf, SVG and Portable::system.

Referenced by DocbookDocVisitor::startMscFile, LatexDocVisitor::startMscFile, DocbookDocVisitor::writeMscFile, HtmlDocVisitor::writeMscFile, LatexDocVisitor::writeMscFile and RTFDocVisitor::writeMscFile.

writeMscImageMapFromFile()

void writeMscImageMapFromFile (TextStream & t, const QCString & inFile, const QCString & outDir, const QCString & relPath, const QCString & baseName, const QCString & context, MscOutputFormat format, const QCString & srcFile, int srcLine)

Declaration at line 32 of file msc.h, definition at line 233 of file msc.cpp.

233void writeMscImageMapFromFile(TextStream &t,const QCString &inFile,

234 const QCString &outDir,

235 const QCString &relPath,

236 const QCString &baseName,

237 const QCString &context,

238 MscOutputFormat format,

239 const QCString &srcFile,

240 int srcLine

241 )

242{

243 QCString mapName = baseName+".map";

244 t << "<img src=\"" << relPath << baseName << ".";

245 switch (format)

246 {

247 case MscOutputFormat::BITMAP:

248 t << "png";

249 break;

250 case MscOutputFormat::EPS:

251 t << "eps";

252 break;

253 case MscOutputFormat::SVG:

254 t << "svg";

255 break;

256 default:

257 t << "unknown";

258 }

259 QCString imap = getMscImageMapFromFile(inFile,outDir,relPath,context,format==MscOutputFormat::SVG,srcFile,srcLine);

260 if (!imap.isEmpty())

261 {

262 t << "\" alt=\""

263 << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\"/>\n";

264 t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">" << imap << "</map>\n";

265 }

266 else

267 {

268 t << "\" alt=\"" << baseName << "\" border=\"0\"/>\n";

269 }

270}

References BITMAP, EPS, getMscImageMapFromFile, QCString::isEmpty and SVG.

Referenced by HtmlDocVisitor::writeMscFile.

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.