Crawlmap Class Reference

#include <src/sitemap.h>

Inheritance diagram for Crawlmap:

Collaboration diagram for Crawlmap:

Classes
class	Private

Public Member Functions
	Crawlmap ()
	~Crawlmap ()
void	initialize ()
void	finalize ()
void	incContentsDepth ()
void	decContentsDepth ()
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)
void	addIndexItem (const Definition *context, const MemberDef *md, const DString &sectionAnchor, const DString &title)
void	addIndexFile (const DString &name)
void	addImageFile (const DString &name)
void	addStyleSheetFile (const DString &name)

Static Public Attributes
static const DString	crawlFileName = "doxygen_crawl"

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Definition at line 51 of file sitemap.h.

Constructor & Destructor Documentation

Crawlmap()

Crawlmap::Crawlmap

(

)

Definition at line 92 of file sitemap.cpp.

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

References p.

Referenced by ~Crawlmap().

~Crawlmap()

Crawlmap::~Crawlmap ( )

default

References Crawlmap(), finalize(), initialize(), and NON_COPYABLE.

Member Function Documentation

addContentsItem()

void Crawlmap::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 )

virtual

Implements IndexIntf.

Definition at line 140 of file sitemap.cpp.

{
  if (!file.empty() && ref.empty())      // made file optional param and
                                             // don't place links in crawl file imported
                                             // by tags
  {
    std::string link;
    if (file[0]=='!' || file[0]=='^') // special markers for user defined URLs
    {
      link+=&file[1];
    }
    else
    {
      DString currFile = file;
      addHtmlExtensionIfMissing(currFile);
      DString currAnc = anchor;
      link += currFile.data();
      if (!currAnc.empty())
      {
        link += "#";
        link += currAnc.str();
      }
    }
    p->crawlLinks.push_back(link);
  }
}

References addHtmlExtensionIfMissing(), DString::data(), DString::empty(), p, and DString::str().

addImageFile()

void Crawlmap::addImageFile ( const DString & name )

inlinevirtual

Implements IndexIntf.

Definition at line 69 of file sitemap.h.

{}

addIndexFile()

void Crawlmap::addIndexFile ( const DString & name )

virtual

Implements IndexIntf.

Definition at line 133 of file sitemap.cpp.

{
  DString fn = fileName;
  addHtmlExtensionIfMissing(fn);
  p->crawlLinks.push_back(fn.str());
}

References addHtmlExtensionIfMissing(), p, and DString::str().

addIndexItem()

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

virtual

Implements IndexIntf.

Definition at line 195 of file sitemap.cpp.

{
  if (context && md) // member
  {
    if (sectionAnchor.empty() && !md->hasDocumentation()) return;
    DString cfname  = md->getOutputFileBase();
    DString anchor  = !sectionAnchor.empty() ? sectionAnchor : md->anchor();
    DString ref     = makeRef(cfname, anchor);
    p->crawlLinks.push_back(ref.str());
  }
  else if (context) // container
  {
    DString contRef = context->getOutputFileBase();
    DString ref = makeRef(contRef,sectionAnchor);
    p->crawlLinks.push_back(ref.str());
  }
}

References Definition::anchor(), DString::empty(), Definition::getOutputFileBase(), Definition::hasDocumentation(), makeRef(), p, and DString::str().

addStyleSheetFile()

void Crawlmap::addStyleSheetFile ( const DString & name )

inlinevirtual

Implements IndexIntf.

Definition at line 70 of file sitemap.h.

{}

decContentsDepth()

void Crawlmap::decContentsDepth ( )

inlinevirtual

Implements IndexIntf.

Definition at line 61 of file sitemap.h.

{}

finalize()

void Crawlmap::finalize ( )

virtual

Implements IndexIntf.

Definition at line 118 of file sitemap.cpp.

{
  std::sort(p->crawlLinks.begin(),p->crawlLinks.end());
  p->crawlLinks.erase(std::unique(p->crawlLinks.begin(),p->crawlLinks.end()),p->crawlLinks.end());
  for (auto &s : p->crawlLinks)
  {
    p->crawl << "<a href=\"" << s << "\"/>\n";
  }
 
  p->crawl << "</body>\n";
  p->crawl << "</html>\n";
  p->crawl.flush();
  p->crawlFile.close();
}

References p.

Referenced by ~Crawlmap().

incContentsDepth()

void Crawlmap::incContentsDepth ( )

inlinevirtual

Implements IndexIntf.

Definition at line 60 of file sitemap.h.

{}

initialize()

void Crawlmap::initialize ( )

virtual

Implements IndexIntf.

Definition at line 95 of file sitemap.cpp.

{
  DString fileName = Config_getString(HTML_OUTPUT) + "/" + crawlFileName;
  addHtmlExtensionIfMissing(fileName);
  p->crawlFile = Portable::openOutputStream(fileName);
  if (!p->crawlFile.is_open())
  {
    term("Could not open file {} for writing\n",fileName);
  }
  p->crawl.setStream(&p->crawlFile);
  p->crawl << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
  p->crawl << "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"" + theTranslator->trISOLang() + "\">\n";
  p->crawl << "<head>\n";
  p->crawl << "<title>Validator / crawler helper</title>\n";
  p->crawl << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>\n";
  p->crawl << "<meta http-equiv=\"X-UA-Compatible\" content=\"IE=11\"/>\n";
 
  p->crawl << "<meta name=\"generator\" content=\"Doxygen " + getDoxygenVersion() + "\"/>\n";
  p->crawl << "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/>\n";
  p->crawl << "</head>\n";
  p->crawl << "<body>\n";
}

References addHtmlExtensionIfMissing(), Config_getString, crawlFileName, Portable::openOutputStream(), p, term, theTranslator, and Translator::trISOLang().

Referenced by ~Crawlmap().

Member Data Documentation

crawlFileName

const DString Crawlmap::crawlFileName = "doxygen_crawl"

inlinestatic

Definition at line 72 of file sitemap.h.

Referenced by initialize().

p

std::unique_ptr<Private> Crawlmap::p

private

Definition at line 76 of file sitemap.h.

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

---

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

• src/sitemap.h
• src/sitemap.cpp