Doxygen
Loading...
Searching...
No Matches
xmlgen.h File Reference

#include <src/xmlgen.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 2357 of file xmlgen.cpp.

2358{
2359 // + classes
2360 // + concepts
2361 // + namespaces
2362 // + files
2363 // + groups
2364 // + related pages
2365 // - examples
2366
2367 DString outputDirectory = Config_getString(XML_OUTPUT);
2368 Dir xmlDir(outputDirectory.str());
2369 createSubDirs(xmlDir);
2370
2371 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2372 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2373
2374 DString fileName=outputDirectory+"/compound.xsd";
2375 std::ofstream f = Portable::openOutputStream(fileName);
2376 if (!f.is_open())
2377 {
2378 err("Cannot open file {} for writing!\n",fileName);
2379 return;
2380 }
2381 {
2382 TextStream t(&f);
2383
2384 // write compound.xsd, but replace special marker with the entities
2385 DString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2386 const char *startLine = compound_xsd.data();
2387 while (*startLine)
2388 {
2389 // find end of the line
2390 const char *endLine = startLine+1;
2391 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2392 int len=static_cast<int>(endLine-startLine);
2393 if (len>0)
2394 {
2395 DString s(startLine,len);
2396 if (s.find("<!-- Automatically insert here the HTML entities -->")!=DString::npos)
2397 {
2399 }
2400 else
2401 {
2402 t.write(startLine,len);
2403 }
2404 }
2405 startLine=endLine;
2406 }
2407 }
2408 f.close();
2409
2410 fileName=outputDirectory+"/doxyfile.xsd";
2411 f = Portable::openOutputStream(fileName);
2412 if (!f.is_open())
2413 {
2414 err("Cannot open file {} for writing!\n",fileName);
2415 return;
2416 }
2417 {
2418 TextStream t(&f);
2419
2420 // write doxyfile.xsd, but replace special marker with the entities
2421 DString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2422 const char *startLine = doxyfile_xsd.data();
2423 while (*startLine)
2424 {
2425 // find end of the line
2426 const char *endLine = startLine+1;
2427 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2428 int len=static_cast<int>(endLine-startLine);
2429 if (len>0)
2430 {
2431 DString s(startLine,len);
2432 if (s.find("<!-- Automatically insert here the configuration settings -->")!=DString::npos)
2433 {
2435 }
2436 else
2437 {
2438 t.write(startLine,len);
2439 }
2440 }
2441 startLine=endLine;
2442 }
2443 }
2444 f.close();
2445
2446 fileName=outputDirectory+"/Doxyfile.xml";
2447 f = Portable::openOutputStream(fileName);
2448 if (!f.is_open())
2449 {
2450 err("Cannot open file {} for writing\n",fileName);
2451 return;
2452 }
2453 else
2454 {
2455 TextStream t(&f);
2457 }
2458 f.close();
2459
2460 fileName=outputDirectory+"/index.xml";
2461 f = Portable::openOutputStream(fileName);
2462 if (!f.is_open())
2463 {
2464 err("Cannot open file {} for writing!\n",fileName);
2465 return;
2466 }
2467 else
2468 {
2469 TextStream t(&f);
2470
2471 // write index header
2472 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2473 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2474 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2475 t << "version=\"" << getDoxygenVersion() << "\" ";
2476 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2477 t << ">\n";
2478
2479 for (const auto &cd : *Doxygen::classLinkedMap)
2480 {
2481 generateXMLForClass(cd.get(),t);
2482 }
2483 for (const auto &cd : *Doxygen::conceptLinkedMap)
2484 {
2485 msg("Generating XML output for concept {}\n",cd->displayName());
2486 generateXMLForConcept(cd.get(),t);
2487 }
2488 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2489 {
2490 msg("Generating XML output for namespace {}\n",nd->displayName());
2491 generateXMLForNamespace(nd.get(),t);
2492 }
2493 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2494 {
2495 for (const auto &fd : *fn)
2496 {
2497 msg("Generating XML output for file {}\n",fd->name());
2498 generateXMLForFile(fd.get(),t);
2499 }
2500 }
2501 for (const auto &gd : *Doxygen::groupLinkedMap)
2502 {
2503 msg("Generating XML output for group {}\n",gd->name());
2504 generateXMLForGroup(gd.get(),t);
2505 }
2506 for (const auto &pd : *Doxygen::pageLinkedMap)
2507 {
2508 msg("Generating XML output for page {}\n",pd->name());
2509 generateXMLForPage(pd.get(),t,false);
2510 }
2511 for (const auto &req : RequirementManager::instance().requirements())
2512 {
2513 if (req->getTagFile().empty())
2514 {
2515 msg("Generating XML output for requirement {}\n", req->id());
2517 }
2518 }
2519 for (const auto &dd : *Doxygen::dirLinkedMap)
2520 {
2521 msg("Generate XML output for dir {}\n",dd->name());
2522 generateXMLForDir(dd.get(),t);
2523 }
2524 for (const auto &mod : ModuleManager::instance().modules())
2525 {
2526 msg("Generating XML output for module {}\n",mod->name());
2527 generateXMLForModule(mod.get(),t);
2528 }
2529 for (const auto &pd : *Doxygen::exampleLinkedMap)
2530 {
2531 msg("Generating XML output for example {}\n",pd->name());
2532 generateXMLForPage(pd.get(),t,true);
2533 }
2535 {
2536 msg("Generating XML output for the main page\n");
2538 }
2539
2540 //t << " </compoundlist>\n";
2541 t << "</doxygenindex>\n";
2542 }
2543
2545 clearSubDirs(xmlDir);
2546}
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:84
static constexpr size_t npos
value used to indicate 'not found' or 'to the end of the string', matching std::string::npos
Definition dstring.h:178
const std::string & str() const
Definition dstring.h:645
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition dstring.h:157
Class representing a directory in the file system.
Definition dir.h:73
static NamespaceLinkedMap * namespaceLinkedMap
Definition doxygen.h:108
static ConceptLinkedMap * conceptLinkedMap
Definition doxygen.h:90
static std::unique_ptr< PageDef > mainPage
Definition doxygen.h:93
static FileNameLinkedMap * inputNameLinkedMap
Definition doxygen.h:97
static ClassLinkedMap * classLinkedMap
Definition doxygen.h:88
static PageLinkedMap * exampleLinkedMap
Definition doxygen.h:91
static PageLinkedMap * pageLinkedMap
Definition doxygen.h:92
static DirLinkedMap * dirLinkedMap
Definition doxygen.h:120
static GroupLinkedMap * groupLinkedMap
Definition doxygen.h:107
void writeXMLSchema(TextStream &t)
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
static ModuleManager & instance()
static RequirementManager & instance()
static ResourceMgr & instance()
Returns the one and only instance of this class.
bool copyResource(const DString &name, const DString &targetDir) const
Copies a registered resource to a given target directory.
DString getAsString(const DString &name) const
Gets the resource data as a C string.
Text streaming class that buffers data.
Definition textstream.h:36
virtual DString trISOLang()=0
#define Config_getString(name)
Definition config.h:32
Translator * theTranslator
Definition language.cpp:76
#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 DString &name, bool append=false)
Definition portable.cpp:681
void clearSubDirs(const Dir &d)
Definition util.cpp:3002
void createSubDirs(const Dir &d)
Definition util.cpp:2975
static void generateXMLForGroup(const GroupDef *gd, TextStream &ti)
Definition xmlgen.cpp:1997
static void generateXMLForClass(const ClassDef *cd, TextStream &ti)
Definition xmlgen.cpp:1503
static void generateXMLForFile(FileDef *fd, TextStream &ti)
Definition xmlgen.cpp:1881
static void generateXMLForNamespace(const NamespaceDef *nd, TextStream &ti)
Definition xmlgen.cpp:1808
static void generateXMLForRequirement(const RequirementIntf *req, TextStream &ti)
Definition xmlgen.cpp:2328
static void generateXMLForModule(const ModuleDef *mod, TextStream &ti)
Definition xmlgen.cpp:1752
static void generateXMLForConcept(const ConceptDef *cd, TextStream &ti)
Definition xmlgen.cpp:1674
static void generateXMLForDir(DirDef *dd, TextStream &ti)
Definition xmlgen.cpp:2067
static void generateXMLForPage(PageDef *pd, TextStream &ti, bool isExample)
Definition xmlgen.cpp:2161
static void writeCombineScript()
Definition xmlgen.cpp:140

References Doxygen::classLinkedMap, clearSubDirs(), Doxygen::conceptLinkedMap, Config_getString, ResourceMgr::copyResource(), createSubDirs(), DString::data(), Doxygen::dirLinkedMap, err, Doxygen::exampleLinkedMap, DString::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, DString::npos, Portable::openOutputStream(), Doxygen::pageLinkedMap, DString::str(), theTranslator, Translator::trISOLang(), TextStream::write(), writeCombineScript(), Config::writeXMLDoxyfile(), HtmlEntityMapper::writeXMLSchema(), and Config::writeXSDDoxyfile().

Referenced by generateOutput().