#include <src/qhp.h>

Inheritance diagram for Qhp:

Collaboration diagram for Qhp:

Classes
class	Private

Public Member Functions
	Qhp ()

	~Qhp ()

void	initialize ()

void	finalize ()

void	incContentsDepth ()

void	decContentsDepth ()

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

void	addIndexItem (const Definition context, const MemberDef md, const QCString &sectionAnchor, const QCString &title)

void	addIndexFile (const QCString &name)

void	addImageFile (const QCString &name)

void	addStyleSheetFile (const QCString &name)

Public Member Functions inherited from IndexIntf

Static Public Member Functions
static QCString	getQchFileName ()

Static Public Attributes
static const QCString	qhpFileName = "index.qhp"

Private Member Functions
void	addFile (const QCString &)

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Definition at line 26 of file qhp.h.

Constructor & Destructor Documentation

◆ Qhp()

Qhp::Qhp ( )

Definition at line 196 of file qhp.cpp.

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

Qhp::p

std::unique_ptr< Private > p

Definition qhp.h:53

References p.

Referenced by ~Qhp().

◆ ~Qhp()

Qhp::~Qhp ( )

default

References Qhp().

Member Function Documentation

◆ addContentsItem()

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

virtual

Implements IndexIntf.

Definition at line 314 of file qhp.cpp.

{
  /*
  <toc>
    <section title="My Application Manual" ref="index.html">
      <section title="Chapter 1" ref="doc.html#chapter1"/>
      <section title="Chapter 2" ref="doc.html#chapter2"/>
      <section title="Chapter 3" ref="doc.html#chapter3"/>
    </section>
  </toc>
  */
 
  QCString f = file;
  if (!f.isEmpty() && f.at(0)=='^') return; // absolute URL not supported
 
  if (f.isEmpty())
  {
    f = "doxygen_blank";
    addHtmlExtensionIfMissing(f);
    std::call_once(g_blankWritten,[this,&f]()
    {
      QCString fileName = Config_getString(HTML_OUTPUT) + "/" + f;
      std::ofstream blankFile = Portable::openOutputStream(fileName); // we just need an empty file
      if (!blankFile.is_open())
      {
        term("Could not open file %s for writing\n", qPrint(fileName));
      }
      TextStream blank;
      blank.setStream(&blankFile);
      blank << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
      blank << "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"" + theTranslator->trISOLang() + "\">\n";
      blank << "<head>\n";
      blank << "<title>Validator / crawler helper</title>\n";
      blank << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>\n";
      blank << "<meta http-equiv=\"X-UA-Compatible\" content=\"IE=11\"/>\n";
 
      blank << "<meta name=\"generator\" content=\"Doxygen " + getDoxygenVersion() + "\"/>\n";
      blank << "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"/>\n";
      blank << "</head>\n";
      blank << "<body>\n";
      blank << "</body>\n";
      blank << "</html>\n";
      blank.flush();
      blankFile.close();
      addFile(f);
    });
  }
  QCString finalRef = makeRef(f, anchor);
  p->sectionTree.addSection(name,finalRef);
}

References addFile(), addHtmlExtensionIfMissing(), QCString::at(), Config_getString, TextStream::flush(), g_blankWritten, QCString::isEmpty(), makeRef(), Portable::openOutputStream(), p, qPrint(), TextStream::setStream(), term, and theTranslator.

◆ addFile()

void Qhp::addFile ( const QCString & fileName )

private

Definition at line 408 of file qhp.cpp.

{
  p->files.insert(("<file>" + convertToXML(fileName) + "</file>").str());
}

References convertToXML(), and p.

Referenced by addContentsItem(), addImageFile(), addIndexFile(), and addStyleSheetFile().

◆ addImageFile()

void Qhp::addImageFile ( const QCString & name )

virtual

Implements IndexIntf.

Definition at line 418 of file qhp.cpp.

{
  addFile(fileName);
}

References addFile().

◆ addIndexFile()

void Qhp::addIndexFile ( const QCString & name )

virtual

Implements IndexIntf.

Definition at line 413 of file qhp.cpp.

{
  addFile(fileName);
}

References addFile().

◆ addIndexItem()

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

virtual

Implements IndexIntf.

Definition at line 369 of file qhp.cpp.

{
  (void)word;
  //printf("addIndexItem(%s %s %s\n",
  //       context?context->name().data():"<none>",
  //       md?md->name().data():"<none>",
  //       qPrint(word));
 
  if (context && md) // member
  {
    QCString cfname  = md->getOutputFileBase();
    QCString argStr  = md->argsString();
    QCString level1  = context->name();
    QCString level2  = !word.isEmpty() ? word : md->name();
    QCString anchor  = !sectionAnchor.isEmpty() ? sectionAnchor : md->anchor();
    QCString ref;
 
    // <keyword name="foo" id="MyApplication::foo" ref="doc.html#foo"/>
    ref = makeRef(cfname, anchor);
    QCString id = level1+"::"+level2;
    writeIndent(p->index,3);
    p->index << "<keyword name=\"" << convertToXML(level2 + argStr) << "\""
                          " id=\"" << convertToXML(id + "_" + anchor) << "\""
                         " ref=\"" << convertToXML(ref) << "\"/>\n";
  }
  else if (context) // container
  {
    // <keyword name="Foo" id="Foo" ref="doc.html#Foo"/>
    QCString contRef = context->getOutputFileBase();
    QCString level1  = !word.isEmpty() ? word : context->name();
    QCString ref = makeRef(contRef,sectionAnchor);
    writeIndent(p->index,3);
    p->index << "<keyword name=\"" << convertToXML(level1) << "\""
             <<           " id=\"" << convertToXML(level1 +"_" + sectionAnchor) << "\""
             <<          " ref=\"" << convertToXML(ref) << "\"/>\n";
  }
}

References Definition::anchor(), MemberDef::argsString(), convertToXML(), Definition::getOutputFileBase(), QCString::isEmpty(), makeRef(), Definition::name(), p, word, and writeIndent().

◆ addStyleSheetFile()

void Qhp::addStyleSheetFile ( const QCString & name )

virtual

Implements IndexIntf.

Definition at line 423 of file qhp.cpp.

{
  addFile(fileName);
}

References addFile().

◆ decContentsDepth()

void Qhp::decContentsDepth ( )

virtual

Implements IndexIntf.

Definition at line 309 of file qhp.cpp.

{
  p->sectionTree.decLevel();
}

References p.

◆ finalize()

void Qhp::finalize ( )

virtual

Implements IndexIntf.

Definition at line 272 of file qhp.cpp.

{
  // close root node
  p->sectionTree.decLevel();
 
  // Finish TOC
  p->sectionTree.writeToc(p->doc);
 
  // Finish index
  writeIndent(p->index,2);
  p->index << "</keywords>\n";
  p->doc << p->index.str();
 
  // Finish files
  writeIndent(p->doc,2);
  p->doc << "<files>\n";
  for (auto &s : p->files)
  {
    writeIndent(p->doc,3);
    p->doc << s.c_str() << "\n";
  }
  writeIndent(p->doc,2);
  p->doc << "</files>\n";
 
  writeIndent(p->doc,1);
  p->doc << "</filterSection>\n";
  p->doc << "</QtHelpProject>\n";
 
  p->doc.flush();
  p->docFile.close();
}

References p, and writeIndent().

◆ getQchFileName()

QCString Qhp::getQchFileName ( )

static

Definition at line 428 of file qhp.cpp.

{
  QCString const & qchFile = Config_getString(QCH_FILE);
  if (!qchFile.isEmpty())
  {
    return qchFile;
  }
 
  QCString const & projectName = Config_getString(PROJECT_NAME);
  QCString const & versionText = Config_getString(PROJECT_NUMBER);
 
  return QCString("../qch/")
      + (projectName.isEmpty() ? QCString("index") : projectName)
      + (versionText.isEmpty() ? QCString("") : QCString("-") + versionText)
      + QCString(".qch");
}

References Config_getString, and QCString::isEmpty().

Referenced by runQHelpGenerator().

◆ incContentsDepth()

void Qhp::incContentsDepth ( )

virtual

Implements IndexIntf.

Definition at line 304 of file qhp.cpp.

{
  p->sectionTree.incLevel();
}

References p.

◆ initialize()

void Qhp::initialize ( )

virtual

Implements IndexIntf.

Definition at line 199 of file qhp.cpp.

{
  /*
  <QtHelpProject version="1.0">
    <namespace>mycompany.com.myapplication.1_0</namespace>
    <virtualFolder>doc</virtualFolder>
    <customFilter name="My Application 1.0">
      <filterAttribute>myapp</filterAttribute>
      <filterAttribute>1.0</filterAttribute>
    </customFilter>
    <filterSection>
      <filterAttribute>myapp</filterAttribute>
      <filterAttribute>1.0</filterAttribute>
  ..
  */
  QCString fileName = Config_getString(HTML_OUTPUT) + "/" + qhpFileName;
  p->docFile = Portable::openOutputStream(fileName);
  if (!p->docFile.is_open())
  {
    term("Could not open file %s for writing\n", fileName.data());
  }
  p->doc.setStream(&p->docFile);
 
  p->doc << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
  p->doc << "<QtHelpProject version=\"1.0\">\n";
  writeIndent(p->doc,1);
  p->doc << "<namespace>" << convertToXML(Config_getString(QHP_NAMESPACE)) << "</namespace>\n";
  writeIndent(p->doc,1);
  p->doc << "<virtualFolder>" << convertToXML(Config_getString(QHP_VIRTUAL_FOLDER)) << "</virtualFolder>\n";
 
  // Add custom filter
  QCString filterName = Config_getString(QHP_CUST_FILTER_NAME);
  if (!filterName.isEmpty())
  {
    writeIndent(p->doc,1);
    p->doc << "<customFilter name=\"" << convertToXML(filterName) << "\">\n";
 
    StringVector customFilterAttributes =
        split(Config_getString(QHP_CUST_FILTER_ATTRS).str(), " ");
    for (const auto &attr : customFilterAttributes)
    {
      writeIndent(p->doc,2);
      p->doc << "<filterAttribute>" << convertToXML(QCString(attr)) << "</filterAttribute>\n";
    }
    writeIndent(p->doc,1);
    p->doc << "</customFilter>\n";
  }
 
  writeIndent(p->doc,1);
  p->doc << "<filterSection>\n";
 
  // Add section attributes
  StringVector sectionFilterAttributes = split(Config_getString(QHP_SECT_FILTER_ATTRS).str(), " ");
  // always add doxygen as filter attribute
  if (std::find(sectionFilterAttributes.begin(), sectionFilterAttributes.end(), "doxygen") ==
      sectionFilterAttributes.end())
  {
    sectionFilterAttributes.emplace_back("doxygen");
  }
  for (const auto &attr : sectionFilterAttributes)
  {
    writeIndent(p->doc,2);
    p->doc << "<filterAttribute>" << convertToXML(QCString(attr)) << "</filterAttribute>\n";
  }
 
  // Add extra root node to the TOC
  p->sectionTree.addSection(getFullProjectName(),"index"+Doxygen::htmlFileExtension);
  p->sectionTree.incLevel();
 
  writeIndent(p->index,2);
  p->index << "<keywords>\n";
}

References Config_getString, convertToXML(), QCString::data(), getFullProjectName(), Doxygen::htmlFileExtension, QCString::isEmpty(), Portable::openOutputStream(), p, qhpFileName, split(), term, and writeIndent().

Member Data Documentation

◆ p

std::unique_ptr<Private> Qhp::p

private

Definition at line 53 of file qhp.h.

Referenced by addContentsItem(), addFile(), addIndexItem(), decContentsDepth(), finalize(), incContentsDepth(), initialize(), and Qhp().

◆ qhpFileName

const QCString Qhp::qhpFileName = "index.qhp"

inlinestatic

Definition at line 47 of file qhp.h.

Referenced by initialize(), and runQHelpGenerator().

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

src/qhp.h
src/qhp.cpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Qhp()

◆ ~Qhp()

Member Function Documentation

◆ addContentsItem()

◆ addFile()

◆ addImageFile()

◆ addIndexFile()

◆ addIndexItem()

◆ addStyleSheetFile()

◆ decContentsDepth()

◆ finalize()

◆ getQchFileName()

◆ incContentsDepth()

◆ initialize()

Member Data Documentation

◆ p

◆ qhpFileName