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 2326 of file xmlgen.cpp.

2327{
2328 // + classes
2329 // + concepts
2330 // + namespaces
2331 // + files
2332 // + groups
2333 // + related pages
2334 // - examples
2335
2336 QCString outputDirectory = Config_getString(XML_OUTPUT);
2337 Dir xmlDir(outputDirectory.str());
2338 createSubDirs(xmlDir);
2339
2340 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2341 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2342
2343 QCString fileName=outputDirectory+"/compound.xsd";
2344 std::ofstream f = Portable::openOutputStream(fileName);
2345 if (!f.is_open())
2346 {
2347 err("Cannot open file {} for writing!\n",fileName);
2348 return;
2349 }
2350 {
2351 TextStream t(&f);
2352
2353 // write compound.xsd, but replace special marker with the entities
2354 QCString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2355 const char *startLine = compound_xsd.data();
2356 while (*startLine)
2357 {
2358 // find end of the line
2359 const char *endLine = startLine+1;
2360 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2361 int len=static_cast<int>(endLine-startLine);
2362 if (len>0)
2363 {
2364 QCString s(startLine,len);
2365 if (s.find("<!-- Automatically insert here the HTML entities -->")!=-1)
2366 {
2368 }
2369 else
2370 {
2371 t.write(startLine,len);
2372 }
2373 }
2374 startLine=endLine;
2375 }
2376 }
2377 f.close();
2378
2379 fileName=outputDirectory+"/doxyfile.xsd";
2380 f = Portable::openOutputStream(fileName);
2381 if (!f.is_open())
2382 {
2383 err("Cannot open file {} for writing!\n",fileName);
2384 return;
2385 }
2386 {
2387 TextStream t(&f);
2388
2389 // write doxyfile.xsd, but replace special marker with the entities
2390 QCString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2391 const char *startLine = doxyfile_xsd.data();
2392 while (*startLine)
2393 {
2394 // find end of the line
2395 const char *endLine = startLine+1;
2396 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2397 int len=static_cast<int>(endLine-startLine);
2398 if (len>0)
2399 {
2400 QCString s(startLine,len);
2401 if (s.find("<!-- Automatically insert here the configuration settings -->")!=-1)
2402 {
2404 }
2405 else
2406 {
2407 t.write(startLine,len);
2408 }
2409 }
2410 startLine=endLine;
2411 }
2412 }
2413 f.close();
2414
2415 fileName=outputDirectory+"/Doxyfile.xml";
2416 f = Portable::openOutputStream(fileName);
2417 if (!f.is_open())
2418 {
2419 err("Cannot open file {} for writing\n",fileName);
2420 return;
2421 }
2422 else
2423 {
2424 TextStream t(&f);
2426 }
2427 f.close();
2428
2429 fileName=outputDirectory+"/index.xml";
2430 f = Portable::openOutputStream(fileName);
2431 if (!f.is_open())
2432 {
2433 err("Cannot open file {} for writing!\n",fileName);
2434 return;
2435 }
2436 else
2437 {
2438 TextStream t(&f);
2439
2440 // write index header
2441 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2442 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2443 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2444 t << "version=\"" << getDoxygenVersion() << "\" ";
2445 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2446 t << ">\n";
2447
2448 for (const auto &cd : *Doxygen::classLinkedMap)
2449 {
2450 generateXMLForClass(cd.get(),t);
2451 }
2452 for (const auto &cd : *Doxygen::conceptLinkedMap)
2453 {
2454 msg("Generating XML output for concept {}\n",cd->displayName());
2455 generateXMLForConcept(cd.get(),t);
2456 }
2457 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2458 {
2459 msg("Generating XML output for namespace {}\n",nd->displayName());
2460 generateXMLForNamespace(nd.get(),t);
2461 }
2462 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2463 {
2464 for (const auto &fd : *fn)
2465 {
2466 msg("Generating XML output for file {}\n",fd->name());
2467 generateXMLForFile(fd.get(),t);
2468 }
2469 }
2470 for (const auto &gd : *Doxygen::groupLinkedMap)
2471 {
2472 msg("Generating XML output for group {}\n",gd->name());
2473 generateXMLForGroup(gd.get(),t);
2474 }
2475 for (const auto &pd : *Doxygen::pageLinkedMap)
2476 {
2477 msg("Generating XML output for page {}\n",pd->name());
2478 generateXMLForPage(pd.get(),t,FALSE);
2479 }
2480 for (const auto &req : RequirementManager::instance().requirements())
2481 {
2482 if (req->getTagFile().isEmpty())
2483 {
2484 msg("Generating XML output for requirement {}\n", req->id());
2486 }
2487 }
2488 for (const auto &dd : *Doxygen::dirLinkedMap)
2489 {
2490 msg("Generate XML output for dir {}\n",dd->name());
2491 generateXMLForDir(dd.get(),t);
2492 }
2493 for (const auto &mod : ModuleManager::instance().modules())
2494 {
2495 msg("Generating XML output for module {}\n",mod->name());
2496 generateXMLForModule(mod.get(),t);
2497 }
2498 for (const auto &pd : *Doxygen::exampleLinkedMap)
2499 {
2500 msg("Generating XML output for example {}\n",pd->name());
2501 generateXMLForPage(pd.get(),t,TRUE);
2502 }
2504 {
2505 msg("Generating XML output for the main page\n");
2507 }
2508
2509 //t << " </compoundlist>\n";
2510 t << "</doxygenindex>\n";
2511 }
2512
2514 clearSubDirs(xmlDir);
2515}
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:128
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:649
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
void clearSubDirs(const Dir &d)
Definition util.cpp:3651
void createSubDirs(const Dir &d)
Definition util.cpp:3624
static void generateXMLForGroup(const GroupDef *gd, TextStream &ti)
Definition xmlgen.cpp:1966
static void generateXMLForClass(const ClassDef *cd, TextStream &ti)
Definition xmlgen.cpp:1478
static void generateXMLForFile(FileDef *fd, TextStream &ti)
Definition xmlgen.cpp:1850
static void generateXMLForNamespace(const NamespaceDef *nd, TextStream &ti)
Definition xmlgen.cpp:1777
static void generateXMLForRequirement(const RequirementIntf *req, TextStream &ti)
Definition xmlgen.cpp:2297
static void generateXMLForModule(const ModuleDef *mod, TextStream &ti)
Definition xmlgen.cpp:1721
static void generateXMLForConcept(const ConceptDef *cd, TextStream &ti)
Definition xmlgen.cpp:1645
static void generateXMLForDir(DirDef *dd, TextStream &ti)
Definition xmlgen.cpp:2036
static void generateXMLForPage(PageDef *pd, TextStream &ti, bool isExample)
Definition xmlgen.cpp:2130
static void writeCombineScript()
Definition xmlgen.cpp:140

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().