Skip to main content

The Crawlmap Class Reference

Declaration​

class Crawlmap { ... }

Included Headers​

#include <src/sitemap.h>

Base class​

classIndexIntf

Abstract interface for index generators. More...

Public Constructors Index​

Crawlmap ()

Public Destructor Index​

~Crawlmap ()

Public Member Functions Index​

voidinitialize ()
voidfinalize ()
voidincContentsDepth ()
voiddecContentsDepth ()
voidaddContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const QCString &nameAsHtml)
voidaddIndexItem (const Definition *context, const MemberDef *md, const QCString &sectionAnchor, const QCString &title)
voidaddIndexFile (const QCString &name)
voidaddImageFile (const QCString &name)
voidaddStyleSheetFile (const QCString &name)

Private Member Attributes Index​

std::unique_ptr< Private >p

Public Static Attributes Index​

static const QCStringcrawlFileName = "doxygen_crawl"

Definition at line 54 of file sitemap.h.

Public Constructors​

Crawlmap()​

Crawlmap::Crawlmap ()

Declaration at line 57 of file sitemap.h, definition at line 92 of file sitemap.cpp.

92Crawlmap::Crawlmap() : p(std::make_unique<Private>()) {}

Reference p.

Referenced by ~Crawlmap.

Public Destructor​

~Crawlmap()​

Crawlmap::~Crawlmap ()

Definition at line 58 of file sitemap.h.

Reference Crawlmap.

Public Member Functions​

addContentsItem()​

void Crawlmap::addContentsItem (bool isDir, const QCString & name, const QCString & ref, const QCString & file, const QCString & anchor, bool separateIndex, bool addToNavIndex, const Definition * def, const QCString & nameAsHtml)
 virtual

Declaration at line 65 of file sitemap.h, definition at line 140 of file sitemap.cpp.

140void Crawlmap::addContentsItem(bool, const QCString &, const QCString & ref,
141 const QCString & file, const QCString & anchor,
142 bool ,bool ,
143 const Definition *, const QCString &)
144{
145 if (!file.isEmpty() && ref.isEmpty()) // 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 QCString currFile = file;
157 addHtmlExtensionIfMissing(currFile);
158 QCString currAnc = anchor;
159 link += currFile.data();
160 if (!currAnc.isEmpty())
161 {
162 link += "#";
163 link += currAnc.str();
164 }
165 }
166 p->crawlLinks.push_back(link);
167 }
168}

References addHtmlExtensionIfMissing, QCString::data, QCString::isEmpty, p and QCString::str.

addImageFile()​

void Crawlmap::addImageFile (const QCString & name)
 inline virtual

Definition at line 72 of file sitemap.h.

72 void addImageFile(const QCString & name){}

addIndexFile()​

void Crawlmap::addIndexFile (const QCString & name)
 virtual

Declaration at line 71 of file sitemap.h, definition at line 133 of file sitemap.cpp.

133void Crawlmap::addIndexFile(const QCString & fileName)
134{
135 QCString fn = fileName;
136 addHtmlExtensionIfMissing(fn);
137 p->crawlLinks.push_back(fn.str());
138}

References addHtmlExtensionIfMissing, p and QCString::str.

addIndexItem()​

void Crawlmap::addIndexItem (const Definition * context, const MemberDef * md, const QCString & sectionAnchor, const QCString & title)
 virtual

Declaration at line 69 of file sitemap.h, definition at line 195 of file sitemap.cpp.

195void Crawlmap::addIndexItem(const Definition *context, const MemberDef *md,
196 const QCString &sectionAnchor, const QCString &title)
197{
198 if (context && md) // member
199 {
200 QCString cfname = md->getOutputFileBase();
201 QCString anchor = !sectionAnchor.isEmpty() ? sectionAnchor : md->anchor();
202 QCString ref = makeRef(cfname, anchor);
203 p->crawlLinks.push_back(ref.str());
204 }
205 else if (context) // container
206 {
207 QCString contRef = context->getOutputFileBase();
208 QCString ref = makeRef(contRef,sectionAnchor);
209 p->crawlLinks.push_back(ref.str());
210 }
211}

References Definition::anchor, Definition::getOutputFileBase, QCString::isEmpty, makeRef, p and QCString::str.

addStyleSheetFile()​

void Crawlmap::addStyleSheetFile (const QCString & name)
 inline virtual

Definition at line 73 of file sitemap.h.

73 void addStyleSheetFile(const QCString & name){}

decContentsDepth()​

void Crawlmap::decContentsDepth ()
 inline virtual

Definition at line 64 of file sitemap.h.

64 void decContentsDepth(){}

finalize()​

void Crawlmap::finalize ()
 virtual

Declaration at line 62 of file sitemap.h, definition at line 118 of file sitemap.cpp.

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}

Reference p.

incContentsDepth()​

void Crawlmap::incContentsDepth ()
 inline virtual

Definition at line 63 of file sitemap.h.

63 void incContentsDepth(){}

initialize()​

void Crawlmap::initialize ()
 virtual

Declaration at line 61 of file sitemap.h, definition at line 95 of file sitemap.cpp.

95void Crawlmap::initialize()
96{
97 QCString 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 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}

References addHtmlExtensionIfMissing, Config_getString, crawlFileName, Portable::openOutputStream, p, term and theTranslator.

Private Member Attributes​

p​

std::unique_ptr<Private> Crawlmap::p

Definition at line 79 of file sitemap.h.

79 std::unique_ptr<Private> p;

Referenced by addContentsItem, addIndexFile, addIndexItem, Crawlmap, finalize and initialize.

Public Static Attributes​

crawlFileName​

const QCString Crawlmap::crawlFileName = "doxygen_crawl"
 static

Definition at line 75 of file sitemap.h.

75 static inline const QCString crawlFileName = "doxygen_crawl";

Referenced by initialize and writeIndex.

The documentation for this class was generated from the following files:

Generated via doxygen2docusaurus by Doxygen 1.14.0.