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

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