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

2215{
2216 // + classes
2217 // + concepts
2218 // + namespaces
2219 // + files
2220 // + groups
2221 // + related pages
2222 // - examples
2223
2224 QCString outputDirectory = Config_getString(XML_OUTPUT);
2225 Dir xmlDir(outputDirectory.str());
2226 createSubDirs(xmlDir);
2227
2228 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2229 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2230
2231 QCString fileName=outputDirectory+"/compound.xsd";
2232 std::ofstream f = Portable::openOutputStream(fileName);
2233 if (!f.is_open())
2234 {
2235 err("Cannot open file {} for writing!\n",fileName);
2236 return;
2237 }
2238 {
2239 TextStream t(&f);
2240
2241 // write compound.xsd, but replace special marker with the entities
2242 QCString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2243 const char *startLine = compound_xsd.data();
2244 while (*startLine)
2245 {
2246 // find end of the line
2247 const char *endLine = startLine+1;
2248 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2249 int len=static_cast<int>(endLine-startLine);
2250 if (len>0)
2251 {
2252 QCString s(startLine,len);
2253 if (s.find("<!-- Automatically insert here the HTML entities -->")!=-1)
2254 {
2256 }
2257 else
2258 {
2259 t.write(startLine,len);
2260 }
2261 }
2262 startLine=endLine;
2263 }
2264 }
2265 f.close();
2266
2267 fileName=outputDirectory+"/doxyfile.xsd";
2268 f = Portable::openOutputStream(fileName);
2269 if (!f.is_open())
2270 {
2271 err("Cannot open file {} for writing!\n",fileName);
2272 return;
2273 }
2274 {
2275 TextStream t(&f);
2276
2277 // write doxyfile.xsd, but replace special marker with the entities
2278 QCString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2279 const char *startLine = doxyfile_xsd.data();
2280 while (*startLine)
2281 {
2282 // find end of the line
2283 const char *endLine = startLine+1;
2284 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2285 int len=static_cast<int>(endLine-startLine);
2286 if (len>0)
2287 {
2288 QCString s(startLine,len);
2289 if (s.find("<!-- Automatically insert here the configuration settings -->")!=-1)
2290 {
2292 }
2293 else
2294 {
2295 t.write(startLine,len);
2296 }
2297 }
2298 startLine=endLine;
2299 }
2300 }
2301 f.close();
2302
2303 fileName=outputDirectory+"/Doxyfile.xml";
2304 f = Portable::openOutputStream(fileName);
2305 if (!f.is_open())
2306 {
2307 err("Cannot open file {} for writing\n",fileName);
2308 return;
2309 }
2310 else
2311 {
2312 TextStream t(&f);
2314 }
2315 f.close();
2316
2317 fileName=outputDirectory+"/index.xml";
2318 f = Portable::openOutputStream(fileName);
2319 if (!f.is_open())
2320 {
2321 err("Cannot open file {} for writing!\n",fileName);
2322 return;
2323 }
2324 else
2325 {
2326 TextStream t(&f);
2327
2328 // write index header
2329 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2330 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2331 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2332 t << "version=\"" << getDoxygenVersion() << "\" ";
2333 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2334 t << ">\n";
2335
2336 for (const auto &cd : *Doxygen::classLinkedMap)
2337 {
2338 generateXMLForClass(cd.get(),t);
2339 }
2340 for (const auto &cd : *Doxygen::conceptLinkedMap)
2341 {
2342 msg("Generating XML output for concept {}\n",cd->displayName());
2343 generateXMLForConcept(cd.get(),t);
2344 }
2345 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2346 {
2347 msg("Generating XML output for namespace {}\n",nd->displayName());
2348 generateXMLForNamespace(nd.get(),t);
2349 }
2350 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2351 {
2352 for (const auto &fd : *fn)
2353 {
2354 msg("Generating XML output for file {}\n",fd->name());
2355 generateXMLForFile(fd.get(),t);
2356 }
2357 }
2358 for (const auto &gd : *Doxygen::groupLinkedMap)
2359 {
2360 msg("Generating XML output for group {}\n",gd->name());
2361 generateXMLForGroup(gd.get(),t);
2362 }
2363 for (const auto &pd : *Doxygen::pageLinkedMap)
2364 {
2365 msg("Generating XML output for page {}\n",pd->name());
2366 generateXMLForPage(pd.get(),t,FALSE);
2367 }
2368 for (const auto &dd : *Doxygen::dirLinkedMap)
2369 {
2370 msg("Generate XML output for dir {}\n",dd->name());
2371 generateXMLForDir(dd.get(),t);
2372 }
2373 for (const auto &mod : ModuleManager::instance().modules())
2374 {
2375 msg("Generating XML output for module {}\n",mod->name());
2376 generateXMLForModule(mod.get(),t);
2377 }
2378 for (const auto &pd : *Doxygen::exampleLinkedMap)
2379 {
2380 msg("Generating XML output for example {}\n",pd->name());
2381 generateXMLForPage(pd.get(),t,TRUE);
2382 }
2384 {
2385 msg("Generating XML output for the main page\n");
2387 }
2388
2389 //t << " </compoundlist>\n";
2390 t << "</doxygenindex>\n";
2391 }
2392
2394 clearSubDirs(xmlDir);
2395}
Class representing a directory in the file system.
Definition dir.h:75
static NamespaceLinkedMap * namespaceLinkedMap
Definition doxygen.h:115
static ConceptLinkedMap * conceptLinkedMap
Definition doxygen.h:98
static std::unique_ptr< PageDef > mainPage
Definition doxygen.h:101
static FileNameLinkedMap * inputNameLinkedMap
Definition doxygen.h:105
static ClassLinkedMap * classLinkedMap
Definition doxygen.h:96
static PageLinkedMap * exampleLinkedMap
Definition doxygen.h:99
static PageLinkedMap * pageLinkedMap
Definition doxygen.h:100
static DirLinkedMap * dirLinkedMap
Definition doxygen.h:129
static GroupLinkedMap * groupLinkedMap
Definition doxygen.h:114
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:3588
void createSubDirs(const Dir &d)
Definition util.cpp:3561
static void generateXMLForGroup(const GroupDef *gd, TextStream &ti)
Definition xmlgen.cpp:1949
static void generateXMLForClass(const ClassDef *cd, TextStream &ti)
Definition xmlgen.cpp:1493
static void generateXMLForFile(FileDef *fd, TextStream &ti)
Definition xmlgen.cpp:1834
static void generateXMLForNamespace(const NamespaceDef *nd, TextStream &ti)
Definition xmlgen.cpp:1761
static void generateXMLForModule(const ModuleDef *mod, TextStream &ti)
Definition xmlgen.cpp:1706
static void generateXMLForConcept(const ConceptDef *cd, TextStream &ti)
Definition xmlgen.cpp:1660
static void generateXMLForDir(DirDef *dd, TextStream &ti)
Definition xmlgen.cpp:2018
static void generateXMLForPage(PageDef *pd, TextStream &ti, bool isExample)
Definition xmlgen.cpp:2056
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().