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

2137{
2138 // + classes
2139 // + concepts
2140 // + namespaces
2141 // + files
2142 // + groups
2143 // + related pages
2144 // - examples
2145
2146 QCString outputDirectory = Config_getString(XML_OUTPUT);
2147 Dir xmlDir(outputDirectory.str());
2148 createSubDirs(xmlDir);
2149
2150 ResourceMgr::instance().copyResource("xml.xsd",outputDirectory);
2151 ResourceMgr::instance().copyResource("index.xsd",outputDirectory);
2152
2153 QCString fileName=outputDirectory+"/compound.xsd";
2154 std::ofstream f = Portable::openOutputStream(fileName);
2155 if (!f.is_open())
2156 {
2157 err("Cannot open file {} for writing!\n",fileName);
2158 return;
2159 }
2160 {
2161 TextStream t(&f);
2162
2163 // write compound.xsd, but replace special marker with the entities
2164 QCString compound_xsd = ResourceMgr::instance().getAsString("compound.xsd");
2165 const char *startLine = compound_xsd.data();
2166 while (*startLine)
2167 {
2168 // find end of the line
2169 const char *endLine = startLine+1;
2170 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2171 int len=static_cast<int>(endLine-startLine);
2172 if (len>0)
2173 {
2174 QCString s(startLine,len);
2175 if (s.find("<!-- Automatically insert here the HTML entities -->")!=-1)
2176 {
2178 }
2179 else
2180 {
2181 t.write(startLine,len);
2182 }
2183 }
2184 startLine=endLine;
2185 }
2186 }
2187 f.close();
2188
2189 fileName=outputDirectory+"/doxyfile.xsd";
2190 f = Portable::openOutputStream(fileName);
2191 if (!f.is_open())
2192 {
2193 err("Cannot open file {} for writing!\n",fileName);
2194 return;
2195 }
2196 {
2197 TextStream t(&f);
2198
2199 // write doxyfile.xsd, but replace special marker with the entities
2200 QCString doxyfile_xsd = ResourceMgr::instance().getAsString("doxyfile.xsd");
2201 const char *startLine = doxyfile_xsd.data();
2202 while (*startLine)
2203 {
2204 // find end of the line
2205 const char *endLine = startLine+1;
2206 while (*endLine && *(endLine-1)!='\n') endLine++; // skip to end of the line including \n
2207 int len=static_cast<int>(endLine-startLine);
2208 if (len>0)
2209 {
2210 QCString s(startLine,len);
2211 if (s.find("<!-- Automatically insert here the configuration settings -->")!=-1)
2212 {
2214 }
2215 else
2216 {
2217 t.write(startLine,len);
2218 }
2219 }
2220 startLine=endLine;
2221 }
2222 }
2223 f.close();
2224
2225 fileName=outputDirectory+"/Doxyfile.xml";
2226 f = Portable::openOutputStream(fileName);
2227 if (!f.is_open())
2228 {
2229 err("Cannot open file {} for writing\n",fileName);
2230 return;
2231 }
2232 else
2233 {
2234 TextStream t(&f);
2236 }
2237 f.close();
2238
2239 fileName=outputDirectory+"/index.xml";
2240 f = Portable::openOutputStream(fileName);
2241 if (!f.is_open())
2242 {
2243 err("Cannot open file {} for writing!\n",fileName);
2244 return;
2245 }
2246 else
2247 {
2248 TextStream t(&f);
2249
2250 // write index header
2251 t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
2252 t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
2253 t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
2254 t << "version=\"" << getDoxygenVersion() << "\" ";
2255 t << "xml:lang=\"" << theTranslator->trISOLang() << "\"";
2256 t << ">\n";
2257
2258 for (const auto &cd : *Doxygen::classLinkedMap)
2259 {
2260 generateXMLForClass(cd.get(),t);
2261 }
2262 for (const auto &cd : *Doxygen::conceptLinkedMap)
2263 {
2264 msg("Generating XML output for concept {}\n",cd->displayName());
2265 generateXMLForConcept(cd.get(),t);
2266 }
2267 for (const auto &nd : *Doxygen::namespaceLinkedMap)
2268 {
2269 msg("Generating XML output for namespace {}\n",nd->displayName());
2270 generateXMLForNamespace(nd.get(),t);
2271 }
2272 for (const auto &fn : *Doxygen::inputNameLinkedMap)
2273 {
2274 for (const auto &fd : *fn)
2275 {
2276 msg("Generating XML output for file {}\n",fd->name());
2277 generateXMLForFile(fd.get(),t);
2278 }
2279 }
2280 for (const auto &gd : *Doxygen::groupLinkedMap)
2281 {
2282 msg("Generating XML output for group {}\n",gd->name());
2283 generateXMLForGroup(gd.get(),t);
2284 }
2285 for (const auto &pd : *Doxygen::pageLinkedMap)
2286 {
2287 msg("Generating XML output for page {}\n",pd->name());
2288 generateXMLForPage(pd.get(),t,FALSE);
2289 }
2290 for (const auto &dd : *Doxygen::dirLinkedMap)
2291 {
2292 msg("Generate XML output for dir {}\n",dd->name());
2293 generateXMLForDir(dd.get(),t);
2294 }
2295 for (const auto &mod : ModuleManager::instance().modules())
2296 {
2297 msg("Generating XML output for module {}\n",mod->name());
2298 generateXMLForModule(mod.get(),t);
2299 }
2300 for (const auto &pd : *Doxygen::exampleLinkedMap)
2301 {
2302 msg("Generating XML output for example {}\n",pd->name());
2303 generateXMLForPage(pd.get(),t,TRUE);
2304 }
2306 {
2307 msg("Generating XML output for the main page\n");
2309 }
2310
2311 //t << " </compoundlist>\n";
2312 t << "</doxygenindex>\n";
2313 }
2314
2316 clearSubDirs(xmlDir);
2317}
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:4183
void createSubDirs(const Dir &d)
Definition util.cpp:4156
static void generateXMLForGroup(const GroupDef *gd, TextStream &ti)
Definition xmlgen.cpp:1871
static void generateXMLForClass(const ClassDef *cd, TextStream &ti)
Definition xmlgen.cpp:1415
static void generateXMLForFile(FileDef *fd, TextStream &ti)
Definition xmlgen.cpp:1756
static void generateXMLForNamespace(const NamespaceDef *nd, TextStream &ti)
Definition xmlgen.cpp:1683
static void generateXMLForModule(const ModuleDef *mod, TextStream &ti)
Definition xmlgen.cpp:1628
static void generateXMLForConcept(const ConceptDef *cd, TextStream &ti)
Definition xmlgen.cpp:1582
static void generateXMLForDir(DirDef *dd, TextStream &ti)
Definition xmlgen.cpp:1940
static void generateXMLForPage(PageDef *pd, TextStream &ti, bool isExample)
Definition xmlgen.cpp:1978
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().