Qhp类 参考

#include <qhp.h>

类 Qhp 继承关系图:

Qhp 的协作图:

Public 成员函数
	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 成员函数 继承自 IndexIntf
virtual	~IndexIntf ()

静态 Public 成员函数
static QCString	getQhpFileName ()

Private 成员函数
void	handlePrevSection ()
void	clearPrevSection ()
void	setPrevSection (const QCString &title, const QCString &basename, const QCString &anchor, int level)
void	addFile (const QCString &fileName)

静态 Private 成员函数
static QCString	getFullProjectName ()

Private 属性
QhpXmlWriter	m_doc
QhpXmlWriter	m_toc
QhpXmlWriter	m_index
QhpXmlWriter	m_files
QCString	m_prevSectionTitle
QCString	m_prevSectionBaseName
QCString	m_prevSectionAnchor
int	m_prevSectionLevel = 0
int	m_sectionLevel = 0
int	m_openCount = 0
bool	m_skipMainPageSection = false

详细描述

在文件 qhp.h 第 23 行定义.

构造及析构函数说明

Qhp()

Qhp::Qhp

(

)

在文件 qhp.cpp 第 56 行定义.

{
  m_doc.setIndentLevel(0);
  m_toc.setIndentLevel(2);
  m_index.setIndentLevel(2);
  m_files.setIndentLevel(2);
}

引用了 m_doc, m_files, m_index, m_toc , 以及 QhpXmlWriter::setIndentLevel().

~Qhp()

Qhp::~Qhp

(

)

在文件 qhp.cpp 第 64 行定义.

{
  clearPrevSection();
}

引用了 clearPrevSection().

成员函数说明

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

实现了 IndexIntf.

在文件 qhp.cpp 第 196 行定义.

{
  //printf("Qhp::addContentsItem(%s) %d\n",name,m_sectionLevel);
  // Backup difference before modification
 
  QCString f = file;
  if (!f.isEmpty() && f.at(0)=='^') return; // absolute URL not supported
 
  int diff = m_prevSectionLevel - m_sectionLevel;
 
  handlePrevSection();
  setPrevSection(name, f, anchor, m_sectionLevel);
 
  // Close sections as needed
  //printf("Qhp::addContentsItem() closing %d sections\n",diff);
  while (diff>0)
  {
    m_toc.close("section");
    m_openCount--;
    diff--;
  }
}

引用了 QCString::at(), QhpXmlWriter::close(), handlePrevSection(), QCString::isEmpty(), m_openCount, m_prevSectionLevel, m_sectionLevel, m_toc , 以及 setPrevSection().

addFile()

void Qhp::addFile ( const QCString &  fileName )

private

在文件 qhp.cpp 第 364 行定义.

{
  m_files.openCloseContent("file", fileName);
}

引用了 m_files , 以及 QhpXmlWriter::openCloseContent().

被这些函数引用 addImageFile(), addIndexFile() , 以及 addStyleSheetFile().

addImageFile()

void Qhp::addImageFile ( const QCString &  name )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 369 行定义.

{
  addFile(fileName);
}

引用了 addFile().

addIndexFile()

void Qhp::addIndexFile ( const QCString &  name )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 281 行定义.

{
  addFile(name);
}

引用了 addFile().

addIndexItem()

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

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 223 行定义.

{
  (void)word;
  //printf("addIndexItem(%s %s %s\n",
  //       context?context->name().data():"<none>",
  //       md?md->name().data():"<none>",
  //       qPrint(word));
 
  if (md) // member
  {
    static bool separateMemberPages = Config_getBool(SEPARATE_MEMBER_PAGES);
    if (context==0) // global member
    {
      if (md->getGroupDef())
        context = md->getGroupDef();
      else if (md->getFileDef())
        context = md->getFileDef();
    }
    if (context==0) return; // should not happen
    QCString cfname  = md->getOutputFileBase();
    QCString cfiname = context->getOutputFileBase();
    QCString level1  = context->name();
    QCString level2  = !word.isEmpty() ? word : md->name();
    QCString contRef = separateMemberPages ? cfname : cfiname;
    QCString anchor  = !sectionAnchor.isEmpty() ? sectionAnchor : md->anchor();
 
    QCString ref;
 
    // <keyword name="foo" id="MyApplication::foo" ref="doc.html#foo"/>
    ref = makeRef(contRef, anchor);
    QCString id = level1+"::"+level2;
    const char * attributes[] =
    {
      "name", level2.data(),
      "id",   id.data(),
      "ref",  ref.data(),
      0
    };
    m_index.openClose("keyword", attributes);
  }
  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);
    const char * attributes[] =
    {
      "name", level1.data(),
      "id",   level1.data(),
      "ref",  ref.data(),
      0
    };
    m_index.openClose("keyword", attributes);
  }
}

引用了 MemberDef::anchor(), Config_getBool, QCString::data(), MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getOutputFileBase(), Definition::getOutputFileBase(), QCString::isEmpty(), m_index, makeRef(), Definition::name() , 以及 QhpXmlWriter::openClose().

addStyleSheetFile()

void Qhp::addStyleSheetFile ( const QCString &  name )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 374 行定义.

{
  addFile(fileName);
}

引用了 addFile().

clearPrevSection()

void Qhp::clearPrevSection ( )

private

在文件 qhp.cpp 第 357 行定义.

{
  m_prevSectionTitle.resize(0);
  m_prevSectionBaseName.resize(0);
  m_prevSectionAnchor.resize(0);
}

引用了 m_prevSectionAnchor, m_prevSectionBaseName, m_prevSectionTitle , 以及 QCString::resize().

被这些函数引用 handlePrevSection() , 以及 ~Qhp().

decContentsDepth()

void Qhp::decContentsDepth ( )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 186 行定义.

{
  if (m_sectionLevel<=0 || (m_sectionLevel==1 && m_skipMainPageSection))
  {
    m_skipMainPageSection=FALSE;
    return;
  }
  m_sectionLevel--;
}

引用了 FALSE, m_sectionLevel , 以及 m_skipMainPageSection.

finalize()

void Qhp::finalize ( )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 148 行定义.

{
  // Finish TOC
  handlePrevSection();
  while (m_openCount>0)
  {
    m_toc.close("section");
    m_openCount--;
  }
  m_toc.close("toc");
  m_doc.insert(m_toc);
 
  // Finish index
  m_index.close("keywords");
  m_doc.insert(m_index);
 
  // Finish files
  m_files.close("files");
  m_doc.insert(m_files);
 
  m_doc.close("filterSection");
  m_doc.close("QtHelpProject");
 
  QCString fileName = Config_getString(HTML_OUTPUT) + "/" + getQhpFileName();
  std::ofstream file(fileName.str(),std::ofstream::out | std::ofstream::binary);
  if (!file.is_open())
  {
    term("Could not open file %s for writing\n", fileName.data());
  }
  TextStream t(&file);
  m_doc.dumpTo(t);
}

引用了 QhpXmlWriter::close(), Config_getString, QCString::data(), QhpXmlWriter::dumpTo(), getQhpFileName(), handlePrevSection(), QhpXmlWriter::insert(), m_doc, m_files, m_index, m_openCount, m_toc, QCString::str() , 以及 term().

getFullProjectName()

QCString Qhp::getFullProjectName ( )

staticprivate

在文件 qhp.cpp 第 291 行定义.

{
  QCString projectName = Config_getString(PROJECT_NAME);
  QCString versionText = Config_getString(PROJECT_NUMBER);
  if (projectName.isEmpty()) projectName="Root";
  return projectName + (versionText.isEmpty()
      ? QCString("")
      : QCString(" ") + versionText);
}

引用了 Config_getString , 以及 QCString::isEmpty().

被这些函数引用 handlePrevSection() , 以及 initialize().

getQhpFileName()

QCString Qhp::getQhpFileName ( )

static

在文件 qhp.cpp 第 286 行定义.

{
  return "index.qhp";
}

被这些函数引用 finalize() , 以及 generateOutput().

handlePrevSection()

void Qhp::handlePrevSection ( )

private

在文件 qhp.cpp 第 301 行定义.

{
  /*
  <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>
  */
 
  if (m_prevSectionTitle.isNull())
  {
    m_prevSectionTitle=" "; // should not happen...
  }
 
  // We skip "Main Page" as our extra root is pointing to that
  if (!((m_prevSectionLevel==1) && (m_prevSectionTitle==getFullProjectName())))
  {
    QCString finalRef = makeRef(m_prevSectionBaseName, m_prevSectionAnchor);
 
    const char * const attributes[] =
    { "title", m_prevSectionTitle.data(),
      "ref",   finalRef.data(),
      NULL
    };
 
    if (m_prevSectionLevel < m_sectionLevel)
    {
      // Section with children
      m_toc.open("section", attributes);
      m_openCount++;
    }
    else
    {
      // Section without children
      m_toc.openClose("section", attributes);
    }
  }
  else
  {
    m_skipMainPageSection=TRUE;
  }
 
  clearPrevSection();
}

引用了 clearPrevSection(), QCString::data(), getFullProjectName(), QCString::isNull(), m_openCount, m_prevSectionAnchor, m_prevSectionBaseName, m_prevSectionLevel, m_prevSectionTitle, m_sectionLevel, m_skipMainPageSection, m_toc, makeRef(), QhpXmlWriter::open(), QhpXmlWriter::openClose() , 以及 TRUE.

被这些函数引用 addContentsItem() , 以及 finalize().

incContentsDepth()

void Qhp::incContentsDepth ( )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 181 行定义.

{
  m_sectionLevel++;
}

引用了 m_sectionLevel.

initialize()

void Qhp::initialize ( )

virtual

实现了 IndexIntf.

在文件 qhp.cpp 第 69 行定义.

{
  /*
  <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 nameSpace       = Config_getString(QHP_NAMESPACE);
  QCString virtualFolder   = Config_getString(QHP_VIRTUAL_FOLDER);
 
  m_doc.declaration("1.0", "UTF-8");
 
  const char * rootAttributes[] =
  { "version", "1.0", 0 };
 
  m_doc.open("QtHelpProject", rootAttributes);
  m_doc.openCloseContent("namespace", nameSpace);
  m_doc.openCloseContent("virtualFolder", virtualFolder);
 
  // Add custom filter
  QCString filterName = Config_getString(QHP_CUST_FILTER_NAME);
  if (!filterName.isEmpty())
  {
    const char * tagAttributes[] =
    { "name", filterName.data(), 0 };
    m_doc.open("customFilter", tagAttributes);
 
    StringVector customFilterAttributes =
        split(Config_getString(QHP_CUST_FILTER_ATTRS).str(), " ");
    for (const auto &attr : customFilterAttributes)
    {
      m_doc.openCloseContent("filterAttribute", attr.c_str());
    }
    m_doc.close("customFilter");
  }
 
  m_doc.open("filterSection");
 
  // Add section attributes
  StringVector sectionFilterAttributes =
      split(Config_getString(QHP_SECT_FILTER_ATTRS).str(), " ");
  if (std::find(sectionFilterAttributes.begin(), sectionFilterAttributes.end(), "doxygen") ==
      sectionFilterAttributes.end())
  {
    sectionFilterAttributes.push_back("doxygen");
  }
  for (const auto &attr : sectionFilterAttributes)
  {
    m_doc.openCloseContent("filterAttribute", attr.c_str());
  }
 
  m_toc.open("toc");
 
  // Add extra root node
  QCString fullProjectname = getFullProjectName();
  QCString indexFile = "index"+Doxygen::htmlFileExtension;
  const char * const attributes[] =
  { "title", fullProjectname.data(),
    "ref",   indexFile.data(),
    NULL
  };
  m_toc.open("section", attributes);
  m_openCount=1;
  m_prevSectionTitle = getFullProjectName();
  m_prevSectionLevel = 1;
  m_sectionLevel = 1;
 
  m_index.open("keywords");
  m_files.open("files");
}

引用了 QhpXmlWriter::close(), Config_getString, QCString::data(), QhpXmlWriter::declaration(), getFullProjectName(), Doxygen::htmlFileExtension, QCString::isEmpty(), m_doc, m_files, m_index, m_openCount, m_prevSectionLevel, m_prevSectionTitle, m_sectionLevel, m_toc, QhpXmlWriter::open(), QhpXmlWriter::openCloseContent() , 以及 split().

setPrevSection()

void Qhp::setPrevSection ( const QCString &  title, const QCString &  basename, const QCString &  anchor, int  level  )

private

在文件 qhp.cpp 第 349 行定义.

{
  m_prevSectionTitle = title;
  m_prevSectionBaseName = basename;
  m_prevSectionAnchor = anchor;
  m_prevSectionLevel = level;
}

引用了 m_prevSectionAnchor, m_prevSectionBaseName, m_prevSectionLevel , 以及 m_prevSectionTitle.

被这些函数引用 addContentsItem().

类成员变量说明

m_doc

QhpXmlWriter Qhp::m_doc

private

在文件 qhp.h 第 55 行定义.

被这些函数引用 finalize(), initialize() , 以及 Qhp().

m_files

QhpXmlWriter Qhp::m_files

private

在文件 qhp.h 第 58 行定义.

被这些函数引用 addFile(), finalize(), initialize() , 以及 Qhp().

m_index

QhpXmlWriter Qhp::m_index

private

在文件 qhp.h 第 57 行定义.

被这些函数引用 addIndexItem(), finalize(), initialize() , 以及 Qhp().

m_openCount

int Qhp::m_openCount = 0

private

在文件 qhp.h 第 66 行定义.

被这些函数引用 addContentsItem(), finalize(), handlePrevSection() , 以及 initialize().

m_prevSectionAnchor

QCString Qhp::m_prevSectionAnchor

private

在文件 qhp.h 第 62 行定义.

被这些函数引用 clearPrevSection(), handlePrevSection() , 以及 setPrevSection().

m_prevSectionBaseName

QCString Qhp::m_prevSectionBaseName

private

在文件 qhp.h 第 61 行定义.

被这些函数引用 clearPrevSection(), handlePrevSection() , 以及 setPrevSection().

m_prevSectionLevel

int Qhp::m_prevSectionLevel = 0

private

在文件 qhp.h 第 64 行定义.

被这些函数引用 addContentsItem(), handlePrevSection(), initialize() , 以及 setPrevSection().

m_prevSectionTitle

QCString Qhp::m_prevSectionTitle

private

在文件 qhp.h 第 60 行定义.

被这些函数引用 clearPrevSection(), handlePrevSection(), initialize() , 以及 setPrevSection().

m_sectionLevel

int Qhp::m_sectionLevel = 0

private

在文件 qhp.h 第 65 行定义.

被这些函数引用 addContentsItem(), decContentsDepth(), handlePrevSection(), incContentsDepth() , 以及 initialize().

m_skipMainPageSection

bool Qhp::m_skipMainPageSection = false

private

在文件 qhp.h 第 67 行定义.

被这些函数引用 decContentsDepth() , 以及 handlePrevSection().

m_toc

QhpXmlWriter Qhp::m_toc

private

在文件 qhp.h 第 56 行定义.

被这些函数引用 addContentsItem(), finalize(), handlePrevSection(), initialize() , 以及 Qhp().

---

该类的文档由以下文件生成:

• src/qhp.h
• src/qhp.cpp