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

2232{
2233 // + classes
2234 // + concepts
2235 // + namespaces
2236 // + files
2237 // + groups
2238 // + related pages
2239 // - examples
2240
2241 QCString outputDirectory = Config_getString(XML_OUTPUT);
2242 Dir xmlDir(outputDirectory.str());
2243 createSubDirs(xmlDir);
2244
2245 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2246 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2247
2248 QCString fileName=outputDirectory+"/compound.xsd";
2249 std::ofstream f = Portable::openOutputStream(fileName);
2250 if (!f.is_open())
2251 {
2252 err("Cannot open file {} for writing!\n",fileName);
2253 return;
2254 }
2255 {
2256 TextStream t(&f);
2257
2258 // write compound.xsd, but replace special marker with the entities
2259 QCString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2260 const char *startLine = compound_xsd.data();
2261 while (*startLine)
2262 {
2263 // find end of the line
2264 const char *endLine = startLine+1;
2265 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2266 int len=static_cast<int>(endLine-startLine);
2267 if (len>0)
2268 {
2269 QCString s(startLine,len);
2270 if (s.find("<!-- Automatically insert here the HTML entities -->")!=-1)
2271 {
2273 }
2274 else
2275 {
2276 t.write(startLine,len);
2277 }
2278 }
2279 startLine=endLine;
2280 }
2281 }
2282 f.close();
2283
2284 fileName=outputDirectory+"/doxyfile.xsd";
2285 f = Portable::openOutputStream(fileName);
2286 if (!f.is_open())
2287 {
2288 err("Cannot open file {} for writing!\n",fileName);
2289 return;
2290 }
2291 {
2292 TextStream t(&f);
2293
2294 // write doxyfile.xsd, but replace special marker with the entities
2295 QCString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2296 const char *startLine = doxyfile_xsd.data();
2297 while (*startLine)
2298 {
2299 // find end of the line
2300 const char *endLine = startLine+1;
2301 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2302 int len=static_cast<int>(endLine-startLine);
2303 if (len>0)
2304 {
2305 QCString s(startLine,len);
2306 if (s.find("<!-- Automatically insert here the configuration settings -->")!=-1)
2307 {
2309 }
2310 else
2311 {
2312 t.write(startLine,len);
2313 }
2314 }
2315 startLine=endLine;
2316 }
2317 }
2318 f.close();
2319
2320 fileName=outputDirectory+"/Doxyfile.xml";
2321 f = Portable::openOutputStream(fileName);
2322 if (!f.is_open())
2323 {
2324 err("Cannot open file {} for writing\n",fileName);
2325 return;
2326 }
2327 else
2328 {
2329 TextStream t(&f);
2331 }
2332 f.close();
2333
2334 fileName=outputDirectory+"/index.xml";
2335 f = Portable::openOutputStream(fileName);
2336 if (!f.is_open())
2337 {
2338 err("Cannot open file {} for writing!\n",fileName);
2339 return;
2340 }
2341 else
2342 {
2343 TextStream t(&f);
2344
2345 // write index header
2346 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2347 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2348 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2349 t << "version=\"" << getDoxygenVersion() << "\" ";
2350 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2351 t << ">\n";
2352
2353 for (const auto &cd : *Doxygen::classLinkedMap)
2354 {
2355 generateXMLForClass(cd.get(),t);
2356 }
2357 for (const auto &cd : *Doxygen::conceptLinkedMap)
2358 {
2359 msg("Generating XML output for concept {}\n",cd->displayName());
2360 generateXMLForConcept(cd.get(),t);
2361 }
2362 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2363 {
2364 msg("Generating XML output for namespace {}\n",nd->displayName());
2365 generateXMLForNamespace(nd.get(),t);
2366 }
2367 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2368 {
2369 for (const auto &fd : *fn)
2370 {
2371 msg("Generating XML output for file {}\n",fd->name());
2372 generateXMLForFile(fd.get(),t);
2373 }
2374 }
2375 for (const auto &gd : *Doxygen::groupLinkedMap)
2376 {
2377 msg("Generating XML output for group {}\n",gd->name());
2378 generateXMLForGroup(gd.get(),t);
2379 }
2380 for (const auto &pd : *Doxygen::pageLinkedMap)
2381 {
2382 msg("Generating XML output for page {}\n",pd->name());
2383 generateXMLForPage(pd.get(),t,FALSE);
2384 }
2385 for (const auto &dd : *Doxygen::dirLinkedMap)
2386 {
2387 msg("Generate XML output for dir {}\n",dd->name());
2388 generateXMLForDir(dd.get(),t);
2389 }
2390 for (const auto &mod : ModuleManager::instance().modules())
2391 {
2392 msg("Generating XML output for module {}\n",mod->name());
2393 generateXMLForModule(mod.get(),t);
2394 }
2395 for (const auto &pd : *Doxygen::exampleLinkedMap)
2396 {
2397 msg("Generating XML output for example {}\n",pd->name());
2398 generateXMLForPage(pd.get(),t,TRUE);
2399 }
2401 {
2402 msg("Generating XML output for the main page\n");
2404 }
2405
2406 //t << " </compoundlist>\n";
2407 t << "</doxygenindex>\n";
2408 }
2409
2411 clearSubDirs(xmlDir);
2412}
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 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:3621
void createSubDirs(const Dir &d)
Definition util.cpp:3594
static void generateXMLForGroup(const GroupDef *gd, TextStream &ti)
Definition xmlgen.cpp:1966
static void generateXMLForClass(const ClassDef *cd, TextStream &ti)
Definition xmlgen.cpp:1480
static void generateXMLForFile(FileDef *fd, TextStream &ti)
Definition xmlgen.cpp:1851
static void generateXMLForNamespace(const NamespaceDef *nd, TextStream &ti)
Definition xmlgen.cpp:1778
static void generateXMLForModule(const ModuleDef *mod, TextStream &ti)
Definition xmlgen.cpp:1723
static void generateXMLForConcept(const ConceptDef *cd, TextStream &ti)
Definition xmlgen.cpp:1647
static void generateXMLForDir(DirDef *dd, TextStream &ti)
Definition xmlgen.cpp:2035
static void generateXMLForPage(PageDef *pd, TextStream &ti, bool isExample)
Definition xmlgen.cpp:2073
static void writeCombineScript()
Definition xmlgen.cpp:134

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(), ResourceMgr::getAsString(), Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, HtmlEntityMapper::instance(), ModuleManager::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().