Doxygen
Loading...
Searching...
No Matches
sitemap.cpp
Go to the documentation of this file.
1/*
2 * Copyright (C) 1997-2023 Dimitri van Heesch.
3 *
4 * Permission to use, copy, modify, and distribute this software and its
5 * documentation under the terms of the GNU General Public License is hereby
6 * granted. No representations are made about the suitability of this software
7 * for any purpose. It is provided "as is" without express or implied warranty.
8 * See the GNU General Public License for more details.
9 *
10 * Documents produced by Doxygen are derivative works derived from the
11 * input used in their production; they are not affected by this license.
12 */
13
14#include <algorithm>
15#include <memory>
16#include <string.h>
17#include <vector>
18#include <cassert>
19
20#include "config.h"
21#include "debug.h"
22#include "doxygen.h"
23#include "groupdef.h"
24#include "memberdef.h"
25#include "message.h"
26#include "sitemap.h"
27#include "textstream.h"
28#include "util.h"
29#include "portable.h"
30#include "language.h"
31#include "version.h"
32#include "containers.h"
33
34//-------------------------------------------------------------------------------------------
35
36class Sitemap::Private
37{
38 public:
39 std::ofstream docFile;
40 TextStream doc;
41};
42
43Sitemap::Sitemap() : p(std::make_unique<Private>()) {}
44Sitemap::~Sitemap() = default;
45
46void Sitemap::initialize()
47{
48 DString fileName = Config_getString(HTML_OUTPUT) + "/" + sitemapFileName;
49
50 p->docFile = Portable::openOutputStream(fileName);
51 if (!p->docFile.is_open())
52 {
53 term("Could not open file {} for writing\n", fileName);
54 }
55 p->doc.setStream(&p->docFile);
56
57 p->doc << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
58 p->doc << "<urlset\n";
59 p->doc << " xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"\n";
60 p->doc << " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
61 p->doc << " xsi:schemaLocation=\"http://www.sitemaps.org/schemas/sitemap/0.9\n";
62 p->doc << " http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd\">\n";
63}
64
65void Sitemap::finalize()
66{
67 p->doc << "</urlset>\n";
68 p->doc.flush();
69 p->docFile.close();
70}
71
72void Sitemap::addIndexFile(const DString & fileName)
73{
74 DString fn = fileName;
75 DString sitemapUrl = Config_getString(SITEMAP_URL);
76 addHtmlExtensionIfMissing(fn);
77 p->doc << " <url>\n";
78 p->doc << " <loc>" << convertToXML(sitemapUrl + fn) << "</loc>\n";
79 p->doc << " </url>\n";
80}
81
82//-------------------------------------------------------------------------------------------
83//
91
92Crawlmap::Crawlmap() : p(std::make_unique<Private>()) {}
93Crawlmap::~Crawlmap() = default;
94
95void Crawlmap::initialize()
96{
97 DString fileName = Config_getString(HTML_OUTPUT) + "/" + crawlFileName;
98 addHtmlExtensionIfMissing(fileName);
99 p->crawlFile = Portable::openOutputStream(fileName);
100 if (!p->crawlFile.is_open())
101 {
102 term("Could not open file {} for writing\n",fileName);
103 }
104 p->crawl.setStream(&p->crawlFile);
105 p->crawl << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
106 p->crawl << "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"" + theTranslator->trISOLang() + "\">\n";
107 p->crawl << "<head>\n";
108 p->crawl << "<title>Validator / crawler helper</title>\n";
109 p->crawl << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>\n";
110 p->crawl << "<meta http-equiv=\"X-UA-Compatible\" content=\"IE=11\"/>\n";
111
112 p->crawl << "<meta name=\"generator\" content=\"Doxygen " + getDoxygenVersion() + "\"/>\n";
113 p->crawl << "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/>\n";
114 p->crawl << "</head>\n";
115 p->crawl << "<body>\n";
116}
117
118void Crawlmap::finalize()
119{
120 std::sort(p->crawlLinks.begin(),p->crawlLinks.end());
121 p->crawlLinks.erase(std::unique(p->crawlLinks.begin(),p->crawlLinks.end()),p->crawlLinks.end());
122 for (auto &s : p->crawlLinks)
123 {
124 p->crawl << "<a href=\"" << s << "\"/>\n";
125 }
126
127 p->crawl << "</body>\n";
128 p->crawl << "</html>\n";
129 p->crawl.flush();
130 p->crawlFile.close();
131}
132
133void Crawlmap::addIndexFile(const DString & fileName)
134{
135 DString fn = fileName;
136 addHtmlExtensionIfMissing(fn);
137 p->crawlLinks.push_back(fn.str());
138}
139
140void Crawlmap::addContentsItem(bool, const DString &, const DString & ref,
141 const DString & file, const DString & anchor,
142 bool ,bool ,
143 const Definition *, const DString &)
144{
145 if (!file.empty() && ref.empty()) // made file optional param and
146 // don't place links in crawl file imported
147 // by tags
148 {
149 std::string link;
150 if (file[0]=='!' || file[0]=='^') // special markers for user defined URLs
151 {
152 link+=&file[1];
153 }
154 else
155 {
156 DString currFile = file;
157 addHtmlExtensionIfMissing(currFile);
158 DString currAnc = anchor;
159 link += currFile.data();
160 if (!currAnc.empty())
161 {
162 link += "#";
163 link += currAnc.str();
164 }
165 }
166 p->crawlLinks.push_back(link);
167 }
168}
169
170static DString makeFileName(const DString & withoutExtension)
171{
172 DString result=withoutExtension;
173 if (!result.empty())
174 {
175 if (result.at(0)=='!') // relative URL -> strip marker
176 {
177 result=result.mid(1);
178 }
179 else // add specified HTML extension
180 {
181 addHtmlExtensionIfMissing(result);
182 }
183 }
184 return result;
185}
186
187static DString makeRef(const DString & withoutExtension, const DString & anchor)
188{
189 if (withoutExtension.empty()) return DString();
190 DString result = makeFileName(withoutExtension);
191 if (anchor.empty()) return result;
192 return result+"#"+anchor;
193}
194
195void Crawlmap::addIndexItem(const Definition *context, const MemberDef *md,
196 const DString &sectionAnchor, const DString &title)
197{
198 if (context && md) // member
199 {
200 if (sectionAnchor.empty() && !md->hasDocumentation()) return;
201 DString cfname = md->getOutputFileBase();
202 DString anchor = !sectionAnchor.empty() ? sectionAnchor : md->anchor();
203 DString ref = makeRef(cfname, anchor);
204 p->crawlLinks.push_back(ref.str());
205 }
206 else if (context) // container
207 {
208 DString contRef = context->getOutputFileBase();
209 DString ref = makeRef(contRef,sectionAnchor);
210 p->crawlLinks.push_back(ref.str());
211 }
212}
Crawlmap::Private::crawl
TextStream crawl
Definition sitemap.cpp:88
Crawlmap::Private::crawlLinks
StringVector crawlLinks
Definition sitemap.cpp:89
Crawlmap::Private::crawlFile
std::ofstream crawlFile
Definition sitemap.cpp:87
Crawlmap::initialize
void initialize()
Definition sitemap.cpp:95
Crawlmap::addContentsItem
void addContentsItem(bool isDir, const DString &name, const DString &ref, const DString &file, const DString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const DString &nameAsHtml)
Definition sitemap.cpp:140
Crawlmap::crawlFileName
static const DString crawlFileName
Definition sitemap.h:72
Crawlmap::p
std::unique_ptr< Private > p
Definition sitemap.h:76
Crawlmap::addIndexItem
void addIndexItem(const Definition *context, const MemberDef *md, const DString &sectionAnchor, const DString &title)
Definition sitemap.cpp:195
Crawlmap::addIndexFile
void addIndexFile(const DString &name)
Definition sitemap.cpp:133
Crawlmap::finalize
void finalize()
Definition sitemap.cpp:118
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:88
DString::DString
DString()=default
DString::mid
DString mid(size_t index, size_t len=npos) const
Definition dstring.h:322
DString::empty
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:152
DString::at
char & at(size_t i)
Returns a reference to the character at index i.
Definition dstring.h:690
DString::str
const std::string & str() const
Definition dstring.h:649
DString::data
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition dstring.h:161
Definition
The common base class of all entity definitions found in the sources.
Definition definition.h:77
Definition::hasDocumentation
virtual bool hasDocumentation() const =0
Definition::anchor
virtual DString anchor() const =0
Definition::getOutputFileBase
virtual DString getOutputFileBase() const =0
MemberDef
A model of a class/file/namespace member symbol.
Definition memberdef.h:45
Sitemap::Private::doc
TextStream doc
Definition sitemap.cpp:40
Sitemap::Private::docFile
std::ofstream docFile
Definition sitemap.cpp:39
Sitemap::addIndexFile
void addIndexFile(const DString &name)
Definition sitemap.cpp:72
Sitemap::p
std::unique_ptr< Private > p
Definition sitemap.h:48
Sitemap::sitemapFileName
static const DString sitemapFileName
Definition sitemap.h:44
Sitemap::finalize
void finalize()
Definition sitemap.cpp:65
Sitemap::Sitemap
Sitemap()
Definition sitemap.cpp:43
Sitemap::initialize
void initialize()
Definition sitemap.cpp:46
TextStream
Text streaming class that buffers data.
Definition textstream.h:36
Translator::trISOLang
virtual DString trISOLang()=0
Config_getString
#define Config_getString(name)
Definition config.h:32
StringVector
std::vector< std::string > StringVector
Definition containers.h:33
theTranslator
Translator * theTranslator
Definition language.cpp:71
term
#define term(fmt,...)
Definition message.h:137
Portable::openOutputStream
std::ofstream openOutputStream(const DString &name, bool append=false)
Definition portable.cpp:665
std
Definition dstring.h:917
portable.h
Portable versions of functions that are platform dependent.
makeFileName
static DString makeFileName(const DString &withoutExtension)
Definition sitemap.cpp:170
makeRef
static DString makeRef(const DString &withoutExtension, const DString &anchor)
Definition sitemap.cpp:187
addHtmlExtensionIfMissing
void addHtmlExtensionIfMissing(DString &fName)
Definition util.cpp:3933
convertToXML
DString convertToXML(const DString &s, bool keepEntities, const bool citeEntry)
Definition util.cpp:3234
util.h
A bunch of utility functions.