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

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

Referenced by generateOutput().