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

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