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

2271{
2272 // + classes
2273 // + concepts
2274 // + namespaces
2275 // + files
2276 // + groups
2277 // + related pages
2278 // - examples
2279
2280 QCString outputDirectory = Config_getString(XML_OUTPUT);
2281 Dir xmlDir(outputDirectory.str());
2282 createSubDirs(xmlDir);
2283
2284 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2285 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2286
2287 QCString fileName=outputDirectory+"/compound.xsd";
2288 std::ofstream f = Portable::openOutputStream(fileName);
2289 if (!f.is_open())
2290 {
2291 err("Cannot open file {} for writing!\n",fileName);
2292 return;
2293 }
2294 {
2295 TextStream t(&f);
2296
2297 // write compound.xsd, but replace special marker with the entities
2298 QCString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2299 const char *startLine = compound_xsd.data();
2300 while (*startLine)
2301 {
2302 // find end of the line
2303 const char *endLine = startLine+1;
2304 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2305 int len=static_cast<int>(endLine-startLine);
2306 if (len>0)
2307 {
2308 QCString s(startLine,len);
2309 if (s.find("<!-- Automatically insert here the HTML entities -->")!=-1)
2310 {
2312 }
2313 else
2314 {
2315 t.write(startLine,len);
2316 }
2317 }
2318 startLine=endLine;
2319 }
2320 }
2321 f.close();
2322
2323 fileName=outputDirectory+"/doxyfile.xsd";
2324 f = Portable::openOutputStream(fileName);
2325 if (!f.is_open())
2326 {
2327 err("Cannot open file {} for writing!\n",fileName);
2328 return;
2329 }
2330 {
2331 TextStream t(&f);
2332
2333 // write doxyfile.xsd, but replace special marker with the entities
2334 QCString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2335 const char *startLine = doxyfile_xsd.data();
2336 while (*startLine)
2337 {
2338 // find end of the line
2339 const char *endLine = startLine+1;
2340 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2341 int len=static_cast<int>(endLine-startLine);
2342 if (len>0)
2343 {
2344 QCString s(startLine,len);
2345 if (s.find("<!-- Automatically insert here the configuration settings -->")!=-1)
2346 {
2348 }
2349 else
2350 {
2351 t.write(startLine,len);
2352 }
2353 }
2354 startLine=endLine;
2355 }
2356 }
2357 f.close();
2358
2359 fileName=outputDirectory+"/Doxyfile.xml";
2360 f = Portable::openOutputStream(fileName);
2361 if (!f.is_open())
2362 {
2363 err("Cannot open file {} for writing\n",fileName);
2364 return;
2365 }
2366 else
2367 {
2368 TextStream t(&f);
2370 }
2371 f.close();
2372
2373 fileName=outputDirectory+"/index.xml";
2374 f = Portable::openOutputStream(fileName);
2375 if (!f.is_open())
2376 {
2377 err("Cannot open file {} for writing!\n",fileName);
2378 return;
2379 }
2380 else
2381 {
2382 TextStream t(&f);
2383
2384 // write index header
2385 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2386 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2387 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2388 t << "version=\"" << getDoxygenVersion() << "\" ";
2389 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2390 t << ">\n";
2391
2392 for (const auto &cd : *Doxygen::classLinkedMap)
2393 {
2394 generateXMLForClass(cd.get(),t);
2395 }
2396 for (const auto &cd : *Doxygen::conceptLinkedMap)
2397 {
2398 msg("Generating XML output for concept {}\n",cd->displayName());
2399 generateXMLForConcept(cd.get(),t);
2400 }
2401 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2402 {
2403 msg("Generating XML output for namespace {}\n",nd->displayName());
2404 generateXMLForNamespace(nd.get(),t);
2405 }
2406 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2407 {
2408 for (const auto &fd : *fn)
2409 {
2410 msg("Generating XML output for file {}\n",fd->name());
2411 generateXMLForFile(fd.get(),t);
2412 }
2413 }
2414 for (const auto &gd : *Doxygen::groupLinkedMap)
2415 {
2416 msg("Generating XML output for group {}\n",gd->name());
2417 generateXMLForGroup(gd.get(),t);
2418 }
2419 for (const auto &pd : *Doxygen::pageLinkedMap)
2420 {
2421 msg("Generating XML output for page {}\n",pd->name());
2422 generateXMLForPage(pd.get(),t,FALSE);
2423 }
2424 for (const auto &req : RequirementManager::instance().requirements())
2425 {
2426 if (req->getTagFile().isEmpty())
2427 {
2428 msg("Generating XML output for requirement {}\n", req->id());
2430 }
2431 }
2432 for (const auto &dd : *Doxygen::dirLinkedMap)
2433 {
2434 msg("Generate XML output for dir {}\n",dd->name());
2435 generateXMLForDir(dd.get(),t);
2436 }
2437 for (const auto &mod : ModuleManager::instance().modules())
2438 {
2439 msg("Generating XML output for module {}\n",mod->name());
2440 generateXMLForModule(mod.get(),t);
2441 }
2442 for (const auto &pd : *Doxygen::exampleLinkedMap)
2443 {
2444 msg("Generating XML output for example {}\n",pd->name());
2445 generateXMLForPage(pd.get(),t,TRUE);
2446 }
2448 {
2449 msg("Generating XML output for the main page\n");
2451 }
2452
2453 //t << " </compoundlist>\n";
2454 t << "</doxygenindex>\n";
2455 }
2456
2458 clearSubDirs(xmlDir);
2459}
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:3648
void createSubDirs(const Dir &d)
Definition util.cpp:3621
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:2241
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:2075
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().