Doxygen
Loading...
Searching...
No Matches
xmlgen.h File Reference
#include "outputgen.h"
Include dependency graph for xmlgen.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  XMLCodeGenerator

Functions

void generateXML ()

Function Documentation

◆ generateXML()

void generateXML ( )

Definition at line 2335 of file xmlgen.cpp.

2336{
2337 // + classes
2338 // + concepts
2339 // + namespaces
2340 // + files
2341 // + groups
2342 // + related pages
2343 // - examples
2344
2345 QCString outputDirectory = Config_getString(XML_OUTPUT);
2346 Dir xmlDir(outputDirectory.str());
2347 createSubDirs(xmlDir);
2348
2349 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2350 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2351
2352 QCString fileName=outputDirectory+"/compound.xsd";
2353 std::ofstream f = Portable::openOutputStream(fileName);
2354 if (!f.is_open())
2355 {
2356 err("Cannot open file {} for writing!\n",fileName);
2357 return;
2358 }
2359 {
2360 TextStream t(&f);
2361
2362 // write compound.xsd, but replace special marker with the entities
2363 QCString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2364 const char *startLine = compound_xsd.data();
2365 while (*startLine)
2366 {
2367 // find end of the line
2368 const char *endLine = startLine+1;
2369 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2370 int len=static_cast<int>(endLine-startLine);
2371 if (len>0)
2372 {
2373 QCString s(startLine,len);
2374 if (s.find("<!-- Automatically insert here the HTML entities -->")!=-1)
2375 {
2377 }
2378 else
2379 {
2380 t.write(startLine,len);
2381 }
2382 }
2383 startLine=endLine;
2384 }
2385 }
2386 f.close();
2387
2388 fileName=outputDirectory+"/doxyfile.xsd";
2389 f = Portable::openOutputStream(fileName);
2390 if (!f.is_open())
2391 {
2392 err("Cannot open file {} for writing!\n",fileName);
2393 return;
2394 }
2395 {
2396 TextStream t(&f);
2397
2398 // write doxyfile.xsd, but replace special marker with the entities
2399 QCString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2400 const char *startLine = doxyfile_xsd.data();
2401 while (*startLine)
2402 {
2403 // find end of the line
2404 const char *endLine = startLine+1;
2405 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2406 int len=static_cast<int>(endLine-startLine);
2407 if (len>0)
2408 {
2409 QCString s(startLine,len);
2410 if (s.find("<!-- Automatically insert here the configuration settings -->")!=-1)
2411 {
2413 }
2414 else
2415 {
2416 t.write(startLine,len);
2417 }
2418 }
2419 startLine=endLine;
2420 }
2421 }
2422 f.close();
2423
2424 fileName=outputDirectory+"/Doxyfile.xml";
2425 f = Portable::openOutputStream(fileName);
2426 if (!f.is_open())
2427 {
2428 err("Cannot open file {} for writing\n",fileName);
2429 return;
2430 }
2431 else
2432 {
2433 TextStream t(&f);
2435 }
2436 f.close();
2437
2438 fileName=outputDirectory+"/index.xml";
2439 f = Portable::openOutputStream(fileName);
2440 if (!f.is_open())
2441 {
2442 err("Cannot open file {} for writing!\n",fileName);
2443 return;
2444 }
2445 else
2446 {
2447 TextStream t(&f);
2448
2449 // write index header
2450 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2451 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2452 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2453 t << "version=\"" << getDoxygenVersion() << "\" ";
2454 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2455 t << ">\n";
2456
2457 for (const auto &cd : *Doxygen::classLinkedMap)
2458 {
2459 generateXMLForClass(cd.get(),t);
2460 }
2461 for (const auto &cd : *Doxygen::conceptLinkedMap)
2462 {
2463 msg("Generating XML output for concept {}\n",cd->displayName());
2464 generateXMLForConcept(cd.get(),t);
2465 }
2466 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2467 {
2468 msg("Generating XML output for namespace {}\n",nd->displayName());
2469 generateXMLForNamespace(nd.get(),t);
2470 }
2471 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2472 {
2473 for (const auto &fd : *fn)
2474 {
2475 msg("Generating XML output for file {}\n",fd->name());
2476 generateXMLForFile(fd.get(),t);
2477 }
2478 }
2479 for (const auto &gd : *Doxygen::groupLinkedMap)
2480 {
2481 msg("Generating XML output for group {}\n",gd->name());
2482 generateXMLForGroup(gd.get(),t);
2483 }
2484 for (const auto &pd : *Doxygen::pageLinkedMap)
2485 {
2486 msg("Generating XML output for page {}\n",pd->name());
2487 generateXMLForPage(pd.get(),t,FALSE);
2488 }
2489 for (const auto &req : RequirementManager::instance().requirements())
2490 {
2491 if (req->getTagFile().isEmpty())
2492 {
2493 msg("Generating XML output for requirement {}\n", req->id());
2495 }
2496 }
2497 for (const auto &dd : *Doxygen::dirLinkedMap)
2498 {
2499 msg("Generate XML output for dir {}\n",dd->name());
2500 generateXMLForDir(dd.get(),t);
2501 }
2502 for (const auto &mod : ModuleManager::instance().modules())
2503 {
2504 msg("Generating XML output for module {}\n",mod->name());
2505 generateXMLForModule(mod.get(),t);
2506 }
2507 for (const auto &pd : *Doxygen::exampleLinkedMap)
2508 {
2509 msg("Generating XML output for example {}\n",pd->name());
2510 generateXMLForPage(pd.get(),t,TRUE);
2511 }
2513 {
2514 msg("Generating XML output for the main page\n");
2516 }
2517
2518 //t << " </compoundlist>\n";
2519 t << "</doxygenindex>\n";
2520 }
2521
2523 clearSubDirs(xmlDir);
2524}
Class representing a directory in the file system.
Definition dir.h:75
static NamespaceLinkedMap * namespaceLinkedMap
Definition doxygen.h:114
static ConceptLinkedMap * conceptLinkedMap
Definition doxygen.h:97
static std::unique_ptr< PageDef > mainPage
Definition doxygen.h:100
static FileNameLinkedMap * inputNameLinkedMap
Definition doxygen.h:104
static ClassLinkedMap * classLinkedMap
Definition doxygen.h:95
static PageLinkedMap * exampleLinkedMap
Definition doxygen.h:98
static PageLinkedMap * pageLinkedMap
Definition doxygen.h:99
static DirLinkedMap * dirLinkedMap
Definition doxygen.h:126
static GroupLinkedMap * groupLinkedMap
Definition doxygen.h:113
void writeXMLSchema(TextStream &t)
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
static ModuleManager & instance()
This is an alternative implementation of QCString.
Definition qcstring.h:101
const std::string & str() const
Definition qcstring.h:552
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:172
static RequirementManager & instance()
static ResourceMgr & instance()
Returns the one and only instance of this class.
bool copyResource(const QCString &name, const QCString &targetDir) const
Copies a registered resource to a given target directory.
QCString getAsString(const QCString &name) const
Gets the resource data as a C string.
Text streaming class that buffers data.
Definition textstream.h:36
#define Config_getString(name)
Definition config.h:32
Translator * theTranslator
Definition language.cpp:71
#define msg(fmt,...)
Definition message.h:94
#define err(fmt,...)
Definition message.h:127
void writeXMLDoxyfile(TextStream &t)
void writeXSDDoxyfile(TextStream &t)
std::ofstream openOutputStream(const QCString &name, bool append=false)
Definition portable.cpp:648
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
void clearSubDirs(const Dir &d)
Definition util.cpp:3671
void createSubDirs(const Dir &d)
Definition util.cpp:3644
static void generateXMLForGroup(const GroupDef *gd, TextStream &ti)
Definition xmlgen.cpp:1975
static void generateXMLForClass(const ClassDef *cd, TextStream &ti)
Definition xmlgen.cpp:1482
static void generateXMLForFile(FileDef *fd, TextStream &ti)
Definition xmlgen.cpp:1859
static void generateXMLForNamespace(const NamespaceDef *nd, TextStream &ti)
Definition xmlgen.cpp:1786
static void generateXMLForRequirement(const RequirementIntf *req, TextStream &ti)
Definition xmlgen.cpp:2306
static void generateXMLForModule(const ModuleDef *mod, TextStream &ti)
Definition xmlgen.cpp:1730
static void generateXMLForConcept(const ConceptDef *cd, TextStream &ti)
Definition xmlgen.cpp:1652
static void generateXMLForDir(DirDef *dd, TextStream &ti)
Definition xmlgen.cpp:2045
static void generateXMLForPage(PageDef *pd, TextStream &ti, bool isExample)
Definition xmlgen.cpp:2139
static void writeCombineScript()
Definition xmlgen.cpp:139

References Doxygen::classLinkedMap, clearSubDirs(), Doxygen::conceptLinkedMap, Config_getString, ResourceMgr::copyResource(), createSubDirs(), QCString::data(), Doxygen::dirLinkedMap, err, Doxygen::exampleLinkedMap, FALSE, QCString::find(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), generateXMLForRequirement(), ResourceMgr::getAsString(), Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, HtmlEntityMapper::instance(), ModuleManager::instance(), RequirementManager::instance(), ResourceMgr::instance(), Doxygen::mainPage, msg, Doxygen::namespaceLinkedMap, Portable::openOutputStream(), Doxygen::pageLinkedMap, QCString::str(), theTranslator, TRUE, TextStream::write(), writeCombineScript(), Config::writeXMLDoxyfile(), HtmlEntityMapper::writeXMLSchema(), and Config::writeXSDDoxyfile().

Referenced by generateOutput().