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

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