HtmlDocVisitor类 参考

Concrete visitor implementation for HTML output. 更多...

#include <htmldocvisitor.h>

类 HtmlDocVisitor 继承关系图:

HtmlDocVisitor 的协作图:

Public 成员函数
	HtmlDocVisitor (TextStream &t, CodeOutputInterface &ci, const Definition *ctx)
void	visit (DocWord *)
void	visit (DocLinkedWord *)
void	visit (DocWhiteSpace *)
void	visit (DocSymbol *)
void	visit (DocEmoji *)
void	visit (DocURL *)
void	visit (DocLineBreak *)
void	visit (DocHorRuler *)
void	visit (DocStyleChange *)
void	visit (DocVerbatim *)
void	visit (DocAnchor *)
void	visit (DocInclude *)
void	visit (DocIncOperator *)
void	visit (DocFormula *)
void	visit (DocIndexEntry *)
void	visit (DocSimpleSectSep *)
void	visit (DocCite *)
void	visitPre (DocAutoList *)
void	visitPost (DocAutoList *)
void	visitPre (DocAutoListItem *)
void	visitPost (DocAutoListItem *)
void	visitPre (DocPara *)
void	visitPost (DocPara *)
void	visitPre (DocRoot *)
void	visitPost (DocRoot *)
void	visitPre (DocSimpleSect *)
void	visitPost (DocSimpleSect *)
void	visitPre (DocTitle *)
void	visitPost (DocTitle *)
void	visitPre (DocSimpleList *)
void	visitPost (DocSimpleList *)
void	visitPre (DocSimpleListItem *)
void	visitPost (DocSimpleListItem *)
void	visitPre (DocSection *)
void	visitPost (DocSection *)
void	visitPre (DocHtmlList *)
void	visitPost (DocHtmlList *)
void	visitPre (DocHtmlListItem *)
void	visitPost (DocHtmlListItem *)
void	visitPre (DocHtmlDescList *)
void	visitPost (DocHtmlDescList *)
void	visitPre (DocHtmlDescTitle *)
void	visitPost (DocHtmlDescTitle *)
void	visitPre (DocHtmlDescData *)
void	visitPost (DocHtmlDescData *)
void	visitPre (DocHtmlTable *)
void	visitPost (DocHtmlTable *)
void	visitPre (DocHtmlRow *)
void	visitPost (DocHtmlRow *)
void	visitPre (DocHtmlCell *)
void	visitPost (DocHtmlCell *)
void	visitPre (DocHtmlCaption *)
void	visitPost (DocHtmlCaption *)
void	visitPre (DocInternal *)
void	visitPost (DocInternal *)
void	visitPre (DocHRef *)
void	visitPost (DocHRef *)
void	visitPre (DocHtmlHeader *)
void	visitPost (DocHtmlHeader *)
void	visitPre (DocImage *)
void	visitPost (DocImage *)
void	visitPre (DocDotFile *)
void	visitPost (DocDotFile *)
void	visitPre (DocMscFile *)
void	visitPost (DocMscFile *)
void	visitPre (DocDiaFile *)
void	visitPost (DocDiaFile *)
void	visitPre (DocLink *)
void	visitPost (DocLink *)
void	visitPre (DocRef *)
void	visitPost (DocRef *)
void	visitPre (DocSecRefItem *)
void	visitPost (DocSecRefItem *)
void	visitPre (DocSecRefList *)
void	visitPost (DocSecRefList *)
void	visitPre (DocParamSect *)
void	visitPost (DocParamSect *)
void	visitPre (DocParamList *)
void	visitPost (DocParamList *)
void	visitPre (DocXRefItem *)
void	visitPost (DocXRefItem *)
void	visitPre (DocInternalRef *)
void	visitPost (DocInternalRef *)
void	visitPre (DocText *)
void	visitPost (DocText *)
void	visitPre (DocHtmlBlockQuote *)
void	visitPost (DocHtmlBlockQuote *)
void	visitPre (DocVhdlFlow *)
void	visitPost (DocVhdlFlow *)
void	visitPre (DocParBlock *)
void	visitPost (DocParBlock *)
Public 成员函数 继承自 DocVisitor
	DocVisitor (int id)
virtual	~DocVisitor ()
int	id () const
CodeParserInterface &	getCodeParser (const QCString &langExt)
void	pushHidden (bool hide)
bool	popHidden ()

Private 成员函数
void	writeObfuscatedMailAddress (const QCString &url)
void	filter (const QCString &str)
void	filterQuotedCdataAttr (const QCString &str)
	Escape basic entities to produce a valid CDATA attribute value, assume that the outer quoting will be using the double quote " 更多...
void	startLink (const QCString &ref, const QCString &file, const QCString &relPath, const QCString &anchor, const QCString &tooltip="")
void	endLink ()
void	writeDotFile (const QCString &fileName, const QCString &relPath, const QCString &context, const QCString &srcFile, int srcLine)
void	writeMscFile (const QCString &fileName, const QCString &relPath, const QCString &context, const QCString &srcFile, int srcLine)
void	writeDiaFile (const QCString &fileName, const QCString &relPath, const QCString &context, const QCString &srcFile, int srcLine)
void	writePlantUMLFile (const QCString &fileName, const QCString &relPath, const QCString &context, const QCString &srcFile, int srcLine)
void	forceEndParagraph (DocNode *n)
	Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph. 更多...
void	forceStartParagraph (DocNode *n)
	Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph. 更多...

Private 属性
TextStream &	m_t
CodeOutputInterface &	m_ci
bool	m_insidePre
bool	m_hide
const Definition *	m_ctx
QCString	m_langExt

详细描述

Concrete visitor implementation for HTML output.

在文件 htmldocvisitor.h 第 29 行定义.

构造及析构函数说明

HtmlDocVisitor()

HtmlDocVisitor::HtmlDocVisitor	(	TextStream &	t,
		CodeOutputInterface &	ci,
		const Definition *	ctx
	)

在文件 htmldocvisitor.cpp 第 267 行定义.

  : DocVisitor(DocVisitor_Html), m_t(t), m_ci(ci), m_insidePre(FALSE),
                                 m_hide(FALSE), m_ctx(ctx)
{
  if (ctx) m_langExt=ctx->getDefFileExtension();
}

引用了 Definition::getDefFileExtension() , 以及 m_langExt.

成员函数说明

endLink()

void HtmlDocVisitor::endLink ( )

private

在文件 htmldocvisitor.cpp 第 2250 行定义.

{
  m_t << "</a>";
}

引用了 m_t.

被这些函数引用 visit() , 以及 visitPost().

filter()

void HtmlDocVisitor::filter ( const QCString &  str )

private

在文件 htmldocvisitor.cpp 第 2151 行定义.

{
  if (str.isEmpty()) return;
  const char *p=str.data();
  char c;
  while (*p)
  {
    c=*p++;
    switch(c)
    {
      case '<':  m_t << "&lt;"; break;
      case '>':  m_t << "&gt;"; break;
      case '&':  m_t << "&amp;"; break;
      case '\\': if ((*p == '(') || (*p == ')'))
          m_t << "\\&zwj;" << *p++;
        else
          m_t << c;
        break;
      default:
        {
          uchar uc = static_cast<uchar>(c);
          if (uc<32 && !isspace(c)) // non-printable control characters
          {
            m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
          }
          else
          {
            m_t << c;
          }
        }
        break;
    }
  }
}

引用了 QCString::data(), hex, QCString::isEmpty(), reg::isspace() , 以及 m_t.

被这些函数引用 visit() , 以及 visitPre().

filterQuotedCdataAttr()

void HtmlDocVisitor::filterQuotedCdataAttr ( const QCString &  str )

private

Escape basic entities to produce a valid CDATA attribute value, assume that the outer quoting will be using the double quote "

在文件 htmldocvisitor.cpp 第 2188 行定义.

{
  if (str.isEmpty()) return;
  const char *p=str.data();
  char c;
  while (*p)
  {
    c=*p++;
    switch(c)
    {
      case '&':  m_t << "&amp;"; break;
      case '"':  m_t << "&quot;"; break;
      case '<':  m_t << "&lt;"; break;
      case '>':  m_t << "&gt;"; break;
      case '\\': if ((*p == '(') || (*p == ')'))
          m_t << "\\&zwj;" << *p++;
        else
          m_t << c;
        break;
      default:
        {
          uchar uc = static_cast<uchar>(c);
          if (uc<32 && !isspace(c)) // non-printable control characters
          {
            m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
          }
          else
          {
            m_t << c;
          }
        }
        break;
    }
  }
}

引用了 QCString::data(), hex, QCString::isEmpty(), reg::isspace() , 以及 m_t.

被这些函数引用 visit().

forceEndParagraph()

void HtmlDocVisitor::forceEndParagraph ( DocNode *  n )

private

Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph.

This method will forcefully end the current paragraph and forceStartParagraph() will restart it.

在文件 htmldocvisitor.cpp 第 2387 行定义.

{
  //printf("forceEndParagraph(%p) %d\n",n,n->kind());
  if (n->parent() && n->parent()->kind()==DocNode::Kind_Para)
  {
    DocPara *para = (DocPara*)n->parent();
    const DocNodeList &children = para->children();
    auto it = std::find_if(children.begin(),children.end(),[n](const auto &np) { return np.get()==n; });
    if (it==children.end()) return;
    int nodeIndex = static_cast<int>(it - children.begin());
    nodeIndex--;
    if (nodeIndex<0) return; // first node in paragraph
    while (nodeIndex>=0 && isInvisibleNode(children.at(nodeIndex).get()))
    {
      nodeIndex--;
    }
    if (nodeIndex<0) return; // first visible node in paragraph
    n = children.at(nodeIndex).get();
    if (mustBeOutsideParagraph(n)) return; // previous node already outside paragraph context
    nodeIndex--;
    bool styleOutsideParagraph=insideStyleChangeThatIsOutsideParagraph(para,nodeIndex);
    bool isFirst;
    bool isLast;
    getParagraphContext(para,isFirst,isLast);
    //printf("forceEnd first=%d last=%d styleOutsideParagraph=%d\n",isFirst,isLast,styleOutsideParagraph);
    if (isFirst && isLast) return;
    if (styleOutsideParagraph) return;
 
    m_t << "</p>";
  }
}

引用了 CompAccept< T >::children(), getParagraphContext(), insideStyleChangeThatIsOutsideParagraph(), isInvisibleNode(), DocNode::kind(), DocNode::Kind_Para, m_t, mustBeOutsideParagraph() , 以及 DocNode::parent().

被这些函数引用 visit() , 以及 visitPre().

forceStartParagraph()

void HtmlDocVisitor::forceStartParagraph ( DocNode *  n )

private

Used for items found inside a paragraph, which due to XHTML restrictions have to be outside of the paragraph.

This method will forcefully start the paragraph, that was previously ended by forceEndParagraph().

在文件 htmldocvisitor.cpp 第 2423 行定义.

{
  //printf("forceStartParagraph(%p) %d\n",n,n->kind());
  if (n->parent() && n->parent()->kind()==DocNode::Kind_Para) // if we are inside a paragraph
  {
    DocPara *para = (DocPara*)n->parent();
    const DocNodeList &children = para->children();
    auto it = std::find_if(children.begin(),children.end(),[n](const auto &np) { return np.get()==n; });
    if (it==children.end()) return;
    int nodeIndex = static_cast<int>(it - children.begin());
    int numNodes  = static_cast<int>(para->children().size());
    bool styleOutsideParagraph=insideStyleChangeThatIsOutsideParagraph(para,nodeIndex);
    if (styleOutsideParagraph) return;
    nodeIndex++;
    if (nodeIndex==numNodes) return; // last node
    while (nodeIndex<numNodes && isInvisibleNode(para->children().at(nodeIndex).get()))
    {
      nodeIndex++;
    }
    if (nodeIndex<numNodes)
    {
      n = para->children().at(nodeIndex).get();
      if (mustBeOutsideParagraph(n)) return; // next element also outside paragraph
    }
    else
    {
      return; // only whitespace at the end!
    }
 
    bool needsTag = TRUE;
    bool isFirst;
    bool isLast;
    getParagraphContext(para,isFirst,isLast);
    if (isFirst && isLast) needsTag = FALSE;
    //printf("forceStart first=%d last=%d needsTag=%d\n",isFirst,isLast,needsTag);
 
    if (needsTag) m_t << "<p>";
  }
}

引用了 CompAccept< T >::children(), FALSE, getParagraphContext(), insideStyleChangeThatIsOutsideParagraph(), isInvisibleNode(), DocNode::kind(), DocNode::Kind_Para, m_t, mustBeOutsideParagraph(), DocNode::parent() , 以及 TRUE.

被这些函数引用 visit() , 以及 visitPost().

startLink()

void HtmlDocVisitor::startLink ( const QCString &  ref, const QCString &  file, const QCString &  relPath, const QCString &  anchor, const QCString &  tooltip = ""  )

private

在文件 htmldocvisitor.cpp 第 2224 行定义.

{
  //printf("HtmlDocVisitor: file=%s anchor=%s\n",qPrint(file),qPrint(anchor));
  if (!ref.isEmpty()) // link to entity imported via tag file
  {
    m_t << "<a class=\"elRef\" ";
    m_t << externalLinkTarget();
  }
  else // local link
  {
    m_t << "<a class=\"el\" ";
  }
  m_t << "href=\"";
  m_t << externalRef(relPath,ref,TRUE);
  if (!file.isEmpty())
  {
    m_t << addHtmlExtensionIfMissing(file);
  }
  if (!anchor.isEmpty()) m_t << "#" << anchor;
  m_t << "\"";
  if (!tooltip.isEmpty()) m_t << " title=\"" << convertToHtml(tooltip) << "\"";
  m_t << ">";
}

引用了 addHtmlExtensionIfMissing(), convertToHtml(), externalLinkTarget(), externalRef(), QCString::isEmpty(), m_t , 以及 TRUE.

被这些函数引用 visit() , 以及 visitPre().

visit() [1/17]

void HtmlDocVisitor::visit ( DocAnchor *  anc )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 646 行定义.

{
  if (m_hide) return;
  m_t << "<a class=\"anchor\" id=\"" << anc->anchor() << "\"" << htmlAttribsToString(anc->attribs()) << "></a>";
}

引用了 DocAnchor::anchor(), DocAnchor::attribs(), htmlAttribsToString(), m_hide , 以及 m_t.

visit() [2/17]

void HtmlDocVisitor::visit ( DocCite *  cite )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 925 行定义.

{
  if (m_hide) return;
  if (!cite->file().isEmpty())
  {
    startLink(cite->ref(),cite->file(),cite->relPath(),cite->anchor());
  }
  else
  {
    m_t << "<b>[";
  }
  filter(cite->text());
  if (!cite->file().isEmpty())
  {
    endLink();
  }
  else
  {
    m_t << "]</b>";
  }
}

引用了 DocCite::anchor(), endLink(), DocCite::file(), filter(), QCString::isEmpty(), m_hide, m_t, DocCite::ref(), DocCite::relPath(), startLink() , 以及 DocCite::text().

visit() [3/17]

void HtmlDocVisitor::visit ( DocEmoji *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 322 行定义.

{
  if (m_hide) return;
  const char *res = EmojiEntityMapper::instance()->unicode(s->index());
  if (res)
  {
    m_t << "<span class=\"emoji\">"<<res<<"</span>";
  }
  else
  {
    m_t << s->name();
  }
}

引用了 DocEmoji::index(), EmojiEntityMapper::instance(), m_hide, m_t, DocEmoji::name() , 以及 EmojiEntityMapper::unicode().

visit() [4/17]

void HtmlDocVisitor::visit ( DocFormula *  f )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 837 行定义.

{
  if (m_hide) return;
  bool bDisplay = !f->isInline();
  if (bDisplay)
  {
    forceEndParagraph(f);
    m_t << "<p class=\"formulaDsp\">\n";
  }
 
  if (Config_getBool(USE_MATHJAX))
  {
    QCString text = f->text();
    bool closeInline = FALSE;
    if (!bDisplay && !text.isEmpty() && text.at(0)=='$' &&
                      text.at(text.length()-1)=='$')
    {
      closeInline=TRUE;
      text = text.mid(1,text.length()-2);
      m_t << "\\(";
    }
    else if (!bDisplay && !text.isEmpty())
    {
      closeInline=TRUE;
      m_t << "\\(";
    }
    m_t << convertToHtml(text);
    if (closeInline)
    {
      m_t << "\\)";
    }
  }
  else
  {
    m_t << "<img class=\"formula"
      << (bDisplay ? "Dsp" : "Inl");
    m_t << "\" alt=\"";
    filterQuotedCdataAttr(f->text());
    m_t << "\"";
    m_t << " src=\"" << f->relPath() << f->name();
    if (Config_getEnum(HTML_FORMULA_FORMAT)==HTML_FORMULA_FORMAT_t::svg)
    {
      m_t << ".svg";
    }
    else
    {
      m_t << ".png";
    }
    FormulaManager::DisplaySize size = FormulaManager::instance().displaySize(f->id());
    if (size.width!=-1)
    {
      m_t << "\" width=\"" << size.width;
    }
    if (size.height!=-1)
    {
      m_t << "\" height=\"" << size.height;
    }
    m_t << "\"/>";
  }
  if (bDisplay)
  {
    m_t << "\n</p>\n";
    forceStartParagraph(f);
  }
}

引用了 QCString::at(), Config_getBool, Config_getEnum, convertToHtml(), FormulaManager::displaySize(), FALSE, filterQuotedCdataAttr(), forceEndParagraph(), forceStartParagraph(), FormulaManager::DisplaySize::height, DocFormula::id(), FormulaManager::instance(), QCString::isEmpty(), DocFormula::isInline(), QCString::length(), m_hide, m_t, QCString::mid(), DocFormula::name(), DocFormula::relPath(), DocFormula::text(), TRUE , 以及 FormulaManager::DisplaySize::width.

visit() [5/17]

void HtmlDocVisitor::visit ( DocHorRuler *  hr )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 382 行定义.

{
  if (m_hide) return;
  forceEndParagraph(hr);
  m_t << "<hr "<< htmlAttribsToString(hr->attribs()) << " />\n";
  forceStartParagraph(hr);
}

引用了 DocHorRuler::attribs(), forceEndParagraph(), forceStartParagraph(), htmlAttribsToString(), m_hide , 以及 m_t.

visit() [6/17]

void HtmlDocVisitor::visit ( DocInclude *  inc )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 652 行定义.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc->extension());
  switch(inc->type())
  {
    case DocInclude::Include:
      forceEndParagraph(inc);
      m_ci.startCodeFragment("DoxyCode");
      getCodeParser(inc->extension()).parseCode(m_ci,
                                        inc->context(),
                                        inc->text(),
                                        langExt,
                                        inc->isExample(),
                                        inc->exampleFile(),
                                        0,     // fileDef
                                        -1,    // startLine
                                        -1,    // endLine
                                        TRUE,  // inlineFragment
                                        0,     // memberDef
                                        FALSE, // show line numbers
                                        m_ctx  // search context
                                       );
      m_ci.endCodeFragment("DoxyCode");
      forceStartParagraph(inc);
      break;
    case DocInclude::IncWithLines:
      {
         forceEndParagraph(inc);
         m_ci.startCodeFragment("DoxyCode");
         FileInfo cfi( inc->file().str() );
         FileDef *fd = createFileDef( cfi.dirPath(), cfi.fileName() );
         getCodeParser(inc->extension()).parseCode(m_ci,
                                           inc->context(),
                                           inc->text(),
                                           langExt,
                                           inc->isExample(),
                                           inc->exampleFile(),
                                           fd,   // fileDef,
                                           -1,    // start line
                                           -1,    // end line
                                           FALSE, // inline fragment
                                           0,     // memberDef
                                           TRUE,  // show line numbers
                                           m_ctx  // search context
                                           );
         delete fd;
         m_ci.endCodeFragment("DoxyCode");
         forceStartParagraph(inc);
      }
      break;
    case DocInclude::DontInclude:
    case DocInclude::LatexInclude:
    case DocInclude::RtfInclude:
    case DocInclude::ManInclude:
    case DocInclude::XmlInclude:
    case DocInclude::DocbookInclude:
    case DocInclude::DontIncWithLines:
      break;
    case DocInclude::HtmlInclude:
      {
        if (inc->isBlock()) forceEndParagraph(inc);
        m_t << inc->text();
        if (inc->isBlock()) forceStartParagraph(inc);
      }
      break;
    case DocInclude::VerbInclude:
      forceEndParagraph(inc);
      m_t << "<pre class=\"fragment\">";
      filter(inc->text());
      m_t << "</pre>";
      forceStartParagraph(inc);
      break;
    case DocInclude::Snippet:
      {
         forceEndParagraph(inc);
         m_ci.startCodeFragment("DoxyCode");
         getCodeParser(inc->extension()).parseCode(m_ci,
                                           inc->context(),
                                           extractBlock(inc->text(),inc->blockId()),
                                           langExt,
                                           inc->isExample(),
                                           inc->exampleFile(),
                                           0,
                                           -1,    // startLine
                                           -1,    // endLine
                                           TRUE,  // inlineFragment
                                           0,     // memberDef
                                           FALSE, // show line number
                                           m_ctx  // search context
                                          );
         m_ci.endCodeFragment("DoxyCode");
         forceStartParagraph(inc);
      }
      break;
    case DocInclude::SnipWithLines:
      {
         forceEndParagraph(inc);
         m_ci.startCodeFragment("DoxyCode");
         FileInfo cfi( inc->file().str() );
         FileDef *fd = createFileDef( cfi.dirPath(), cfi.fileName() );
         getCodeParser(inc->extension()).parseCode(m_ci,
                                           inc->context(),
                                           extractBlock(inc->text(),inc->blockId()),
                                           langExt,
                                           inc->isExample(),
                                           inc->exampleFile(),
                                           fd,
                                           lineBlock(inc->text(),inc->blockId()),
                                           -1,    // endLine
                                           FALSE, // inlineFragment
                                           0,     // memberDef
                                           TRUE,  // show line number
                                           m_ctx  // search context
                                          );
         delete fd;
         m_ci.endCodeFragment("DoxyCode");
         forceStartParagraph(inc);
      }
      break;
    case DocInclude::SnippetDoc:
    case DocInclude::IncludeDoc:
      err("Internal inconsistency: found switch SnippetDoc / IncludeDoc in file: %s"
          "Please create a bug report\n",__FILE__);
      break;
  }
}

引用了 DocInclude::blockId(), DocInclude::context(), createFileDef(), FileInfo::dirPath(), DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, CodeOutputInterface::endCodeFragment(), err(), DocInclude::exampleFile(), DocInclude::extension(), extractBlock(), FALSE, DocInclude::file(), FileInfo::fileName(), filter(), forceEndParagraph(), forceStartParagraph(), DocVisitor::getCodeParser(), getLanguageFromFileName(), DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncludeDoc, DocInclude::IncWithLines, DocInclude::isBlock(), DocInclude::isExample(), DocInclude::LatexInclude, lineBlock(), m_ci, m_ctx, m_hide, m_t, DocInclude::ManInclude, CodeParserInterface::parseCode(), DocInclude::RtfInclude, DocInclude::Snippet, DocInclude::SnippetDoc, DocInclude::SnipWithLines, CodeOutputInterface::startCodeFragment(), QCString::str(), DocInclude::text(), TRUE, DocInclude::type(), DocInclude::VerbInclude , 以及 DocInclude::XmlInclude.

visit() [7/17]

void HtmlDocVisitor::visit ( DocIncOperator *  op )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 780 行定义.

{
  //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
  //    op->type(),op->isFirst(),op->isLast(),qPrint(op->text()));
  if (op->isFirst())
  {
    forceEndParagraph(op);
    if (!m_hide) m_ci.startCodeFragment("DoxyCode");
    pushHidden(m_hide);
    m_hide=TRUE;
  }
  QCString locLangExt = getFileNameExtension(op->includeFileName());
  if (locLangExt.isEmpty()) locLangExt = m_langExt;
  SrcLangExt langExt = getLanguageFromFileName(locLangExt);
  if (op->type()!=DocIncOperator::Skip)
  {
    m_hide = popHidden();
    if (!m_hide)
    {
      FileDef *fd = 0;
      if (!op->includeFileName().isEmpty())
      {
        FileInfo cfi( op->includeFileName().str() );
        fd = createFileDef( cfi.dirPath(), cfi.fileName() );
      }
      getCodeParser(locLangExt).parseCode(
                                m_ci,
                                op->context(),
                                op->text(),
                                langExt,
                                op->isExample(),
                                op->exampleFile(),
                                fd,     // fileDef
                                op->line(),    // startLine
                                -1,    // endLine
                                FALSE, // inline fragment
                                0,     // memberDef
                                op->showLineNo(),  // show line numbers
                                m_ctx  // search context
                               );
      if (fd) delete fd;
    }
    pushHidden(m_hide);
    m_hide=TRUE;
  }
  if (op->isLast())
  {
    m_hide = popHidden();
    if (!m_hide) m_ci.endCodeFragment("DoxyCode");
    forceStartParagraph(op);
  }
  else
  {
    if (!m_hide) m_t << "\n";
  }
}

引用了 DocIncOperator::context(), createFileDef(), FileInfo::dirPath(), CodeOutputInterface::endCodeFragment(), DocIncOperator::exampleFile(), FALSE, FileInfo::fileName(), forceEndParagraph(), forceStartParagraph(), DocVisitor::getCodeParser(), getFileNameExtension(), getLanguageFromFileName(), DocIncOperator::includeFileName(), QCString::isEmpty(), DocIncOperator::isExample(), DocIncOperator::isFirst(), DocIncOperator::isLast(), DocIncOperator::line(), m_ci, m_ctx, m_hide, m_langExt, m_t, CodeParserInterface::parseCode(), DocVisitor::popHidden(), DocVisitor::pushHidden(), DocIncOperator::showLineNo(), DocIncOperator::Skip, CodeOutputInterface::startCodeFragment(), QCString::str(), DocIncOperator::text(), TRUE , 以及 DocIncOperator::type().

visit() [8/17]

void HtmlDocVisitor::visit ( DocIndexEntry *  e )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 903 行定义.

{
  QCString anchor = convertIndexWordToAnchor(e->entry());
  if (e->member())
  {
    anchor.prepend(e->member()->anchor()+"_");
  }
  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
  //printf("*** DocIndexEntry: word='%s' scope='%s' member='%s'\n",
  //       qPrint(e->entry()),
  //       e->scope()  ? qPrint(e->scope()->name())  : "<null>",
  //       e->member() ? qPrint(e->member()->name()) : "<null>"
  //      );
  Doxygen::indexList->addIndexItem(e->scope(),e->member(),anchor,e->entry());
}

引用了 IndexList::addIndexItem(), MemberDef::anchor(), convertIndexWordToAnchor(), DocIndexEntry::entry(), Doxygen::indexList, m_t, DocIndexEntry::member(), QCString::prepend() , 以及 DocIndexEntry::scope().

visit() [9/17]

void HtmlDocVisitor::visit ( DocLineBreak *  br )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 376 行定义.

{
  if (m_hide) return;
  m_t << "<br "<< htmlAttribsToString(br->attribs()) << " />\n";
}

引用了 DocLineBreak::attribs(), htmlAttribsToString(), m_hide , 以及 m_t.

visit() [10/17]

void HtmlDocVisitor::visit ( DocLinkedWord *  w )

virtual

实现了 DocVisitor.

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

{
  if (m_hide) return;
  //printf("linked word: %s\n",qPrint(w->word()));
  startLink(w->ref(),w->file(),w->relPath(),w->anchor(),w->tooltip());
  filter(w->word());
  endLink();
}

引用了 DocLinkedWord::anchor(), endLink(), DocLinkedWord::file(), filter(), m_hide, DocLinkedWord::ref(), DocLinkedWord::relPath(), startLink(), DocLinkedWord::tooltip() , 以及 DocLinkedWord::word().

visit() [11/17]

void HtmlDocVisitor::visit ( DocSimpleSectSep *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 919 行定义.

{
  m_t << "</dd>\n";
  m_t << "<dd>\n";
}

引用了 m_t.

visit() [12/17]

void HtmlDocVisitor::visit ( DocStyleChange *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 390 行定义.

{
  if (m_hide) return;
  switch (s->style())
  {
    case DocStyleChange::Bold:
      if (s->enable()) m_t << "<b" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</b>";
      break;
    case DocStyleChange::S:
      if (s->enable()) m_t << "<s" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</s>";
      break;
    case DocStyleChange::Strike:
      if (s->enable()) m_t << "<strike" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</strike>";
      break;
    case DocStyleChange::Del:
      if (s->enable()) m_t << "<del" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</del>";
      break;
    case DocStyleChange::Underline:
      if (s->enable()) m_t << "<u" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</u>";
      break;
    case DocStyleChange::Ins:
      if (s->enable()) m_t << "<ins" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</ins>";
      break;
    case DocStyleChange::Italic:
      if (s->enable()) m_t << "<em" << htmlAttribsToString(s->attribs()) << ">";     else m_t << "</em>";
      break;
    case DocStyleChange::Code:
      if (s->enable()) m_t << "<code" << htmlAttribsToString(s->attribs()) << ">";   else m_t << "</code>";
      break;
    case DocStyleChange::Subscript:
      if (s->enable()) m_t << "<sub" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sub>";
      break;
    case DocStyleChange::Superscript:
      if (s->enable()) m_t << "<sup" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sup>";
      break;
    case DocStyleChange::Center:
      if (s->enable())
      {
        forceEndParagraph(s);
        m_t << "<center" << htmlAttribsToString(s->attribs()) << ">";
      }
      else
      {
        m_t << "</center>";
        forceStartParagraph(s);
      }
      break;
    case DocStyleChange::Small:
      if (s->enable()) m_t << "<small" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "</small>";
      break;
    case DocStyleChange::Preformatted:
      if (s->enable())
      {
        forceEndParagraph(s);
        m_t << "<pre" << htmlAttribsToString(s->attribs()) << ">";
        m_insidePre=TRUE;
      }
      else
      {
        m_insidePre=FALSE;
        m_t << "</pre>";
        forceStartParagraph(s);
      }
      break;
    case DocStyleChange::Div:
      if (s->enable())
      {
        forceEndParagraph(s);
        m_t << "<div" << htmlAttribsToString(s->attribs()) << ">";
      }
      else
      {
        m_t << "</div>";
        forceStartParagraph(s);
      }
      break;
    case DocStyleChange::Span:
      if (s->enable()) m_t << "<span" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "</span>";
      break;
 
  }
}

引用了 DocStyleChange::attribs(), DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), FALSE, forceEndParagraph(), forceStartParagraph(), htmlAttribsToString(), DocStyleChange::Ins, DocStyleChange::Italic, m_hide, m_insidePre, m_t, DocStyleChange::Preformatted, DocStyleChange::S, DocStyleChange::Small, DocStyleChange::Span, DocStyleChange::Strike, DocStyleChange::style(), DocStyleChange::Subscript, DocStyleChange::Superscript, TRUE , 以及 DocStyleChange::Underline.

visit() [13/17]

void HtmlDocVisitor::visit ( DocSymbol *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 308 行定义.

{
  if (m_hide) return;
  const char *res = HtmlEntityMapper::instance()->html(s->symbol());
  if (res)
  {
    m_t << res;
  }
  else
  {
    err("HTML: non supported HTML-entity found: %s\n",HtmlEntityMapper::instance()->html(s->symbol(),TRUE));
  }
}

引用了 err(), HtmlEntityMapper::html(), HtmlEntityMapper::instance(), m_hide, m_t, DocSymbol::symbol() , 以及 TRUE.

visit() [14/17]

void HtmlDocVisitor::visit ( DocURL *  u )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 350 行定义.

{
  if (m_hide) return;
  if (u->isEmail()) // mail address
  {
    QCString url = u->url();
    writeObfuscatedMailAddress(url);
    uint size=5,i;
    for (i=0;i<url.length();)
    {
      filter(url.mid(i,size));
      if (i<url.length()-size) m_t << "<span style=\"display: none;\">.nosp@m.</span>";
      i+=size;
      if (size==5) size=4; else size=5;
    }
    m_t << "</a>";
  }
  else // web address
  {
    m_t << "<a href=\"";
    m_t << u->url() << "\">";
    filter(u->url());
    m_t << "</a>";
  }
}

引用了 filter(), DocURL::isEmail(), QCString::length(), m_hide, m_t, QCString::mid(), DocURL::url() , 以及 writeObfuscatedMailAddress().

visit() [15/17]

void HtmlDocVisitor::visit ( DocVerbatim *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 497 行定义.

{
  if (m_hide) return;
  QCString lang = m_langExt;
  if (!s->language().isEmpty()) // explicit language setting
  {
    lang = s->language();
  }
  SrcLangExt langExt = getLanguageFromCodeLang(lang);
  switch(s->type())
  {
    case DocVerbatim::Code:
      forceEndParagraph(s);
      m_ci.startCodeFragment("DoxyCode");
      getCodeParser(lang).parseCode(m_ci,
                                        s->context(),
                                        s->text(),
                                        langExt,
                                        s->isExample(),
                                        s->exampleFile(),
                                        0,     // fileDef
                                        -1,    // startLine
                                        -1,    // endLine
                                        FALSE, // inlineFragment
                                        0,     // memberDef
                                        TRUE,  // show line numbers
                                        m_ctx  // search context
                                       );
      m_ci.endCodeFragment("DoxyCode");
      forceStartParagraph(s);
      break;
    case DocVerbatim::Verbatim:
      forceEndParagraph(s);
      m_t << "<pre class=\"fragment\">";
      filter(s->text());
      m_t << "</pre>";
      forceStartParagraph(s);
      break;
    case DocVerbatim::HtmlOnly:
      {
        if (s->isBlock()) forceEndParagraph(s);
        m_t << s->text();
        if (s->isBlock()) forceStartParagraph(s);
      }
      break;
    case DocVerbatim::ManOnly:
    case DocVerbatim::LatexOnly:
    case DocVerbatim::XmlOnly:
    case DocVerbatim::RtfOnly:
    case DocVerbatim::DocbookOnly:
      /* nothing */
      break;
 
    case DocVerbatim::Dot:
      {
        static int dotindex = 1;
        QCString fileName(4096);
 
        forceEndParagraph(s);
        fileName.sprintf("%s%d%s",
            qPrint(Config_getString(HTML_OUTPUT)+"/inline_dotgraph_"),
            dotindex++,
            ".dot"
           );
        std::ofstream file(fileName.str(),std::ofstream::out | std::ofstream::binary);
        if (!file.is_open())
        {
          err("Could not open file %s for writing\n",qPrint(fileName));
        }
        else
        {
          QCString stext = s->text();
          file.write( stext.data(), stext.length() );
          file.close();
 
          m_t << "<div class=\"dotgraph\">\n";
          writeDotFile(fileName,s->relPath(),s->context(),s->srcFile(),s->srcLine());
          visitPreCaption(m_t, s);
          visitCaption(this, s->children());
          visitPostCaption(m_t, s);
          m_t << "</div>\n";
 
          if (Config_getBool(DOT_CLEANUP)) Dir().remove(fileName.str());
        }
        forceStartParagraph(s);
      }
      break;
    case DocVerbatim::Msc:
      {
        forceEndParagraph(s);
 
        static int mscindex = 1;
        QCString baseName(4096);
 
        baseName.sprintf("%s%d",
            qPrint(Config_getString(HTML_OUTPUT)+"/inline_mscgraph_"),
            mscindex++
            );
        std::ofstream file(baseName.str()+".msc",std::ofstream::out | std::ofstream::binary);
        if (!file.is_open())
        {
          err("Could not open file %s.msc for writing\n",qPrint(baseName));
        }
        else
        {
          QCString text = "msc {";
          text+=s->text();
          text+="}";
 
          file.write( text.data(), text.length() );
          file.close();
 
          m_t << "<div class=\"mscgraph\">\n";
          writeMscFile(baseName+".msc",s->relPath(),s->context(),s->srcFile(),s->srcLine());
          visitPreCaption(m_t, s);
          visitCaption(this, s->children());
          visitPostCaption(m_t, s);
          m_t << "</div>\n";
 
          if (Config_getBool(DOT_CLEANUP)) Dir().remove(baseName.str()+".msc");
        }
        forceStartParagraph(s);
      }
      break;
    case DocVerbatim::PlantUML:
      {
        forceEndParagraph(s);
        static QCString htmlOutput = Config_getString(HTML_OUTPUT);
        QCString imgExt = getDotImageExtension();
        PlantumlManager::OutputFormat format = PlantumlManager::PUML_BITMAP;    // default : PUML_BITMAP
        if (imgExt=="svg")
        {
          format = PlantumlManager::PUML_SVG;
        }
        QCString baseName = PlantumlManager::instance().writePlantUMLSource(
                                    htmlOutput,s->exampleFile(),
                                    s->text(),format,s->engine(),s->srcFile(),s->srcLine());
        m_t << "<div class=\"plantumlgraph\">\n";
        writePlantUMLFile(baseName,s->relPath(),s->context(),s->srcFile(),s->srcLine());
        visitPreCaption(m_t, s);
        visitCaption(this, s->children());
        visitPostCaption(m_t, s);
        m_t << "</div>\n";
        forceStartParagraph(s);
      }
      break;
  }
}

引用了 DocVerbatim::children(), DocVerbatim::Code, Config_getBool, Config_getString, DocVerbatim::context(), QCString::data(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, CodeOutputInterface::endCodeFragment(), DocVerbatim::engine(), err(), DocVerbatim::exampleFile(), FALSE, filter(), forceEndParagraph(), forceStartParagraph(), DocVisitor::getCodeParser(), getDotImageExtension(), getLanguageFromCodeLang(), DocVerbatim::HtmlOnly, PlantumlManager::instance(), DocVerbatim::isBlock(), QCString::isEmpty(), DocVerbatim::isExample(), DocVerbatim::language(), DocVerbatim::LatexOnly, QCString::length(), m_ci, m_ctx, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Msc, CodeParserInterface::parseCode(), DocVerbatim::PlantUML, PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_SVG, qPrint(), DocVerbatim::relPath(), Dir::remove(), DocVerbatim::RtfOnly, QCString::sprintf(), DocVerbatim::srcFile(), DocVerbatim::srcLine(), CodeOutputInterface::startCodeFragment(), QCString::str(), DocVerbatim::text(), TRUE, DocVerbatim::type(), DocVerbatim::Verbatim, visitCaption(), visitPostCaption(), visitPreCaption(), writeDotFile(), writeMscFile(), writePlantUMLFile(), PlantumlManager::writePlantUMLSource() , 以及 DocVerbatim::XmlOnly.

visit() [16/17]

void HtmlDocVisitor::visit ( DocWhiteSpace *  w )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 295 行定义.

{
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w->chars();
  }
  else
  {
    m_t << " ";
  }
}

引用了 DocWhiteSpace::chars(), m_hide, m_insidePre , 以及 m_t.

visit() [17/17]

void HtmlDocVisitor::visit ( DocWord *  w )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 279 行定义.

{
  //printf("word: %s\n",qPrint(w->word()));
  if (m_hide) return;
  filter(w->word());
}

引用了 filter(), m_hide , 以及 DocWord::word().

被这些函数引用 visitPre().

visitPost() [1/37]

void HtmlDocVisitor::visitPost ( DocAutoList *  l )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 977 行定义.

{
  //printf("DocAutoList::visitPost\n");
  if (m_hide) return;
  if (l->isEnumList())
  {
    m_t << "</ol>";
  }
  else
  {
    m_t << "</ul>";
  }
  if (!l->isPreformatted()) m_t << "\n";
  forceStartParagraph(l);
}

引用了 forceStartParagraph(), DocAutoList::isEnumList(), DocNode::isPreformatted(), m_hide , 以及 m_t.

visitPost() [2/37]

void HtmlDocVisitor::visitPost ( DocAutoListItem *  li )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 999 行定义.

{
  if (m_hide) return;
  m_t << "</li>";
  if (!li->isPreformatted()) m_t << "\n";
}

引用了 DocNode::isPreformatted(), m_hide , 以及 m_t.

visitPost() [3/37]

void HtmlDocVisitor::visitPost ( DocDiaFile *  df )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1846 行定义.

{
  if (m_hide) return;
  if (df->hasCaption())
  {
    m_t << "</div>\n";
  }
  m_t << "</div>\n";
}

引用了 DocDiagramFileBase< T >::hasCaption(), m_hide , 以及 m_t.

visitPost() [4/37]

void HtmlDocVisitor::visitPost ( DocDotFile *  df )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1806 行定义.

{
  if (m_hide) return;
  if (df->hasCaption())
  {
    m_t << "</div>\n";
  }
  m_t << "</div>\n";
}

引用了 DocDiagramFileBase< T >::hasCaption(), m_hide , 以及 m_t.

visitPost() [5/37]

void HtmlDocVisitor::visitPost ( DocHRef *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1647 行定义.

{
  if (m_hide) return;
  m_t << "</a>";
}

引用了 m_hide , 以及 m_t.

visitPost() [6/37]

void HtmlDocVisitor::visitPost ( DocHtmlBlockQuote *  b )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2101 行定义.

{
  if (m_hide) return;
  m_t << "</blockquote>\n";
  forceStartParagraph(b);
}

引用了 forceStartParagraph(), m_hide , 以及 m_t.

visitPost() [7/37]

void HtmlDocVisitor::visitPost ( DocHtmlCaption *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1613 行定义.

{
  if (m_hide) return;
  m_t << "</caption>\n";
}

引用了 m_hide , 以及 m_t.

visitPost() [8/37]

void HtmlDocVisitor::visitPost ( DocHtmlCell *  c )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1601 行定义.

{
  if (m_hide) return;
  if (c->isHeading()) m_t << "</th>"; else m_t << "</td>";
}

引用了 DocHtmlCell::isHeading(), m_hide , 以及 m_t.

visitPost() [9/37]

void HtmlDocVisitor::visitPost ( DocHtmlDescData *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1537 行定义.

{
  if (m_hide) return;
  m_t << "</dd>\n";
}

引用了 m_hide , 以及 m_t.

visitPost() [10/37]

void HtmlDocVisitor::visitPost ( DocHtmlDescList *  dl )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1512 行定义.

{
  if (m_hide) return;
  m_t << "</dl>\n";
  forceStartParagraph(dl);
}

引用了 forceStartParagraph(), m_hide , 以及 m_t.

visitPost() [11/37]

void HtmlDocVisitor::visitPost ( DocHtmlDescTitle *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1525 行定义.

{
  if (m_hide) return;
  m_t << "</dt>\n";
}

引用了 m_hide , 以及 m_t.

visitPost() [12/37]

void HtmlDocVisitor::visitPost ( DocHtmlHeader *  header )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1660 行定义.

{
  if (m_hide) return;
  m_t << "</h" << header->level() << ">\n";
  forceStartParagraph(header);
}

引用了 forceStartParagraph(), DocHtmlHeader::level(), m_hide , 以及 m_t.

visitPost() [13/37]

void HtmlDocVisitor::visitPost ( DocHtmlList *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1477 行定义.

{
  if (m_hide) return;
  if (s->type()==DocHtmlList::Ordered)
  {
    m_t << "</ol>";
  }
  else
  {
    m_t << "</ul>";
  }
  if (!s->isPreformatted()) m_t << "\n";
  forceStartParagraph(s);
}

引用了 forceStartParagraph(), DocNode::isPreformatted(), m_hide, m_t, DocHtmlList::Ordered , 以及 DocHtmlList::type().

visitPost() [14/37]

void HtmlDocVisitor::visitPost ( DocHtmlListItem *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1499 行定义.

{
  if (m_hide) return;
  m_t << "</li>\n";
}

引用了 m_hide , 以及 m_t.

visitPost() [15/37]

void HtmlDocVisitor::visitPost ( DocHtmlRow *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1582 行定义.

{
  if (m_hide) return;
  m_t << "</tr>\n";
}

引用了 m_hide , 以及 m_t.

visitPost() [16/37]

void HtmlDocVisitor::visitPost ( DocHtmlTable *  t )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1569 行定义.

{
  if (m_hide) return;
  m_t << "</table>\n";
  forceStartParagraph(t);
}

引用了 forceStartParagraph(), m_hide , 以及 m_t.

visitPost() [17/37]

void HtmlDocVisitor::visitPost ( DocImage *  img )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1766 行定义.

{
  if (img->type()==DocImage::Html)
  {
    if (m_hide) return;
    bool inlineImage = img->isInlineImage();
    if (img->hasCaption())
    {
      if (inlineImage)
      {
        m_t << "\"/>";
      }
      else // end <div class="caption">
      {
        m_t << "</div>";
      }
    }
    if (!inlineImage) // end <div class="image">
    {
      m_t << "</div>\n";
      forceStartParagraph(img);
    }
  }
  else // other format
  {
    m_hide = popHidden();
  }
}

引用了 forceStartParagraph(), DocImage::hasCaption(), DocImage::Html, DocImage::isInlineImage(), m_hide, m_t, DocVisitor::popHidden() , 以及 DocImage::type().

visitPost() [18/37]

void HtmlDocVisitor::visitPost ( DocInternal *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1626 行定义.

{
  if (m_hide) return;
  //forceStartParagraph(i);
}

引用了 m_hide.

visitPost() [19/37]

void HtmlDocVisitor::visitPost ( DocInternalRef *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2078 行定义.

{
  if (m_hide) return;
  endLink();
  m_t << " ";
}

引用了 endLink(), m_hide , 以及 m_t.

visitPost() [20/37]

void HtmlDocVisitor::visitPost ( DocLink *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1862 行定义.

{
  if (m_hide) return;
  endLink();
}

引用了 endLink() , 以及 m_hide.

visitPost() [21/37]

void HtmlDocVisitor::visitPost ( DocMscFile *  df )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1826 行定义.

{
  if (m_hide) return;
  if (df->hasCaption())
  {
    m_t << "</div>\n";
  }
  m_t << "</div>\n";
}

引用了 DocDiagramFileBase< T >::hasCaption(), m_hide , 以及 m_t.

visitPost() [22/37]

void HtmlDocVisitor::visitPost ( DocPara *  p )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1277 行定义.

{
 
  //printf("DocPara::visitPost: parent of kind %d ",
  //       p->parent() ? p->parent()->kind() : -1);
 
  bool needsTag = FALSE;
  if (p->parent())
  {
    switch (p->parent()->kind())
    {
      case DocNode::Kind_Section:
      case DocNode::Kind_Internal:
      case DocNode::Kind_HtmlListItem:
      case DocNode::Kind_HtmlDescData:
      case DocNode::Kind_HtmlCell:
      case DocNode::Kind_SimpleListItem:
      case DocNode::Kind_AutoListItem:
      case DocNode::Kind_SimpleSect:
      case DocNode::Kind_XRefItem:
      case DocNode::Kind_Copy:
      case DocNode::Kind_HtmlBlockQuote:
      case DocNode::Kind_ParBlock:
        needsTag = TRUE;
        break;
      case DocNode::Kind_Root:
        needsTag = !((DocRoot*)p->parent())->singleLine();
        break;
      default:
        needsTag = FALSE;
    }
  }
 
  // if the last element of a paragraph is something that should be outside of
  // the paragraph (<ul>,<dl>,<table>) then that will already have ended the
  // paragraph and we don't need to do it here
  if (!p->children().empty())
  {
    int nodeIndex = static_cast<int>(p->children().size()-1);
    while (nodeIndex>=0 && isInvisibleNode(p->children().at(nodeIndex).get()))
    {
      nodeIndex--;
    }
    if (nodeIndex>=0)
    {
      const DocNode *n = p->children().at(nodeIndex).get();
      if (mustBeOutsideParagraph(n))
      {
        needsTag = FALSE;
      }
    }
  }
 
  bool isFirst;
  bool isLast;
  getParagraphContext(p,isFirst,isLast);
  //printf("endPara first=%d last=%d\n",isFirst,isLast);
  if (isFirst && isLast) needsTag=FALSE;
 
  //printf("DocPara::visitPost needsTag=%d\n",needsTag);
 
  if (needsTag) m_t << "</p>\n";
 
}

引用了 CompAccept< T >::children(), FALSE, getParagraphContext(), isInvisibleNode(), DocNode::kind(), DocNode::Kind_AutoListItem, DocNode::Kind_Copy, DocNode::Kind_HtmlBlockQuote, DocNode::Kind_HtmlCell, DocNode::Kind_HtmlDescData, DocNode::Kind_HtmlListItem, DocNode::Kind_Internal, DocNode::Kind_ParBlock, DocNode::Kind_Root, DocNode::Kind_Section, DocNode::Kind_SimpleListItem, DocNode::Kind_SimpleSect, DocNode::Kind_XRefItem, m_t, mustBeOutsideParagraph(), DocNode::parent() , 以及 TRUE.

visitPost() [23/37]

void HtmlDocVisitor::visitPost ( DocParamList *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2034 行定义.

{
  //printf("DocParamList::visitPost\n");
  if (m_hide) return;
  m_t << "</td></tr>\n";
}

引用了 m_hide , 以及 m_t.

visitPost() [24/37]

void HtmlDocVisitor::visitPost ( DocParamSect *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1956 行定义.

{
  if (m_hide) return;
  m_t << "  </table>\n";
  m_t << "  </dd>\n";
  m_t << "</dl>\n";
  forceStartParagraph(s);
}

引用了 forceStartParagraph(), m_hide , 以及 m_t.

visitPost() [25/37]

void HtmlDocVisitor::visitPost ( DocParBlock *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2144 行定义.

{
  if (m_hide) return;
}

引用了 m_hide.

visitPost() [26/37]

void HtmlDocVisitor::visitPost ( DocRef *  ref )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1880 行定义.

{
  if (m_hide) return;
  if (!ref->file().isEmpty()) endLink();
  //m_t << " ";
}

引用了 endLink(), DocRef::file(), QCString::isEmpty() , 以及 m_hide.

visitPost() [27/37]

void HtmlDocVisitor::visitPost ( DocRoot *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1346 行定义.

{
}

visitPost() [28/37]

void HtmlDocVisitor::visitPost ( DocSecRefItem *  ref )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1897 行定义.

{
  if (m_hide) return;
  if (!ref->file().isEmpty())
  {
    endLink();
    m_t << "</li>\n";
  }
}

引用了 endLink(), DocSecRefItem::file(), QCString::isEmpty(), m_hide , 以及 m_t.

visitPost() [29/37]

void HtmlDocVisitor::visitPost ( DocSecRefList *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1915 行定义.

{
  if (m_hide) return;
  m_t << "</ul>\n";
  m_t << "</div>\n";
  forceStartParagraph(s);
}

引用了 forceStartParagraph(), m_hide , 以及 m_t.

visitPost() [30/37]

void HtmlDocVisitor::visitPost ( DocSection *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1457 行定义.

{
  forceStartParagraph(s);
}

引用了 forceStartParagraph().

visitPost() [31/37]

void HtmlDocVisitor::visitPost ( DocSimpleList *  sl )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1425 行定义.

{
  if (m_hide) return;
  m_t << "</ul>";
  if (!sl->isPreformatted()) m_t << "\n";
  forceStartParagraph(sl);
}

引用了 forceStartParagraph(), DocNode::isPreformatted(), m_hide , 以及 m_t.

visitPost() [32/37]

void HtmlDocVisitor::visitPost ( DocSimpleListItem *  li )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1439 行定义.

{
  if (m_hide) return;
  m_t << "</li>";
  if (!li->isPreformatted()) m_t << "\n";
}

引用了 DocNode::isPreformatted(), m_hide , 以及 m_t.

visitPost() [33/37]

void HtmlDocVisitor::visitPost ( DocSimpleSect *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1399 行定义.

{
  if (m_hide) return;
  m_t << "</dd></dl>\n";
  forceStartParagraph(s);
}

引用了 forceStartParagraph(), m_hide , 以及 m_t.

visitPost() [34/37]

void HtmlDocVisitor::visitPost ( DocText *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2089 行定义.

{
}

visitPost() [35/37]

void HtmlDocVisitor::visitPost ( DocTitle *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1410 行定义.

{
  if (m_hide) return;
  m_t << "</dt><dd>";
}

引用了 m_hide , 以及 m_t.

visitPost() [36/37]

void HtmlDocVisitor::visitPost ( DocVhdlFlow *  vf )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2129 行定义.

{
  if (m_hide) return;
  if (VhdlDocGen::getFlowMember()) // use VHDL flow chart creator
  {
    m_t << "</p>";
    forceStartParagraph(vf);
  }
}

引用了 forceStartParagraph(), VhdlDocGen::getFlowMember(), m_hide , 以及 m_t.

visitPost() [37/37]

void HtmlDocVisitor::visitPost ( DocXRefItem *  x )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2064 行定义.

{
  if (m_hide) return;
  if (x->title().isEmpty()) return;
  m_t << "</dd></dl>\n";
  forceStartParagraph(x);
}

引用了 forceStartParagraph(), QCString::isEmpty(), m_hide, m_t , 以及 DocXRefItem::title().

visitPre() [1/37]

void HtmlDocVisitor::visitPre ( DocAutoList *  l )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 953 行定义.

{
  //printf("DocAutoList::visitPre\n");
  if (m_hide) return;
  forceEndParagraph(l);
  if (l->isEnumList())
  {
    //
    // Do list type based on depth:
    // 1.
    //   a.
    //     i.
    //       A.
    //         1. (repeat)...
    //
    m_t << "<ol type=\"" << types[l->depth() % NUM_HTML_LIST_TYPES] << "\">";
  }
  else
  {
    m_t << "<ul>";
  }
  if (!l->isPreformatted()) m_t << "\n";
}

引用了 DocAutoList::depth(), forceEndParagraph(), DocAutoList::isEnumList(), DocNode::isPreformatted(), m_hide, m_t, NUM_HTML_LIST_TYPES , 以及 types.

visitPre() [2/37]

void HtmlDocVisitor::visitPre ( DocAutoListItem *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 993 行定义.

{
  if (m_hide) return;
  m_t << "<li>";
}

引用了 m_hide , 以及 m_t.

visitPre() [3/37]

void HtmlDocVisitor::visitPre ( DocDiaFile *  df )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1836 行定义.

{
  if (m_hide) return;
  m_t << "<div class=\"diagraph\">\n";
  writeDiaFile(df->file(),df->relPath(),df->context(),df->srcFile(),df->srcLine());
  if (df->hasCaption())
  {
    m_t << "<div class=\"caption\">\n";
  }
}

引用了 DocDiagramFileBase< T >::context(), DocDiagramFileBase< T >::file(), DocDiagramFileBase< T >::hasCaption(), m_hide, m_t, DocDiagramFileBase< T >::relPath(), DocDiagramFileBase< T >::srcFile(), DocDiagramFileBase< T >::srcLine() , 以及 writeDiaFile().

visitPre() [4/37]

void HtmlDocVisitor::visitPre ( DocDotFile *  df )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1795 行定义.

{
  if (m_hide) return;
  m_t << "<div class=\"dotgraph\">\n";
  writeDotFile(df->file(),df->relPath(),df->context(),df->srcFile(),df->srcLine());
  if (df->hasCaption())
  {
    m_t << "<div class=\"caption\">\n";
  }
}

引用了 DocDiagramFileBase< T >::context(), DocDiagramFileBase< T >::file(), DocDiagramFileBase< T >::hasCaption(), m_hide, m_t, DocDiagramFileBase< T >::relPath(), DocDiagramFileBase< T >::srcFile(), DocDiagramFileBase< T >::srcLine() , 以及 writeDotFile().

visitPre() [5/37]

void HtmlDocVisitor::visitPre ( DocHRef *  href )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1632 行定义.

{
  if (m_hide) return;
  if (href->url().left(7)=="mailto:")
  {
    writeObfuscatedMailAddress(href->url().mid(7));
  }
  else
  {
    QCString url = correctURL(href->url(),href->relPath());
    m_t << "<a href=\"" << convertToHtml(url)  << "\""
        << htmlAttribsToString(href->attribs()) << ">";
  }
}

引用了 DocHRef::attribs(), convertToHtml(), correctURL(), htmlAttribsToString(), QCString::left(), m_hide, m_t, QCString::mid(), DocHRef::relPath(), DocHRef::url() , 以及 writeObfuscatedMailAddress().

visitPre() [6/37]

void HtmlDocVisitor::visitPre ( DocHtmlBlockQuote *  b )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2093 行定义.

{
  if (m_hide) return;
  forceEndParagraph(b);
  QCString attrs = htmlAttribsToString(b->attribs());
  m_t << "<blockquote class=\"doxtable\"" << htmlAttribsToString(b->attribs()) << ">\n";
}

引用了 DocHtmlBlockQuote::attribs(), forceEndParagraph(), htmlAttribsToString(), m_hide , 以及 m_t.

visitPre() [7/37]

void HtmlDocVisitor::visitPre ( DocHtmlCaption *  c )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1607 行定义.

{
  if (m_hide) return;
  m_t << "<caption" << htmlAttribsToString(c->attribs()) << ">";
}

引用了 DocHtmlCaption::attribs(), htmlAttribsToString(), m_hide , 以及 m_t.

visitPre() [8/37]

void HtmlDocVisitor::visitPre ( DocHtmlCell *  c )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1588 行定义.

{
  if (m_hide) return;
  if (c->isHeading())
  {
    m_t << "<th" << htmlAttribsToString(c->attribs()) << ">";
  }
  else
  {
    m_t << "<td" << htmlAttribsToString(c->attribs()) << ">";
  }
}

引用了 DocHtmlCell::attribs(), htmlAttribsToString(), DocHtmlCell::isHeading(), m_hide , 以及 m_t.

visitPre() [9/37]

void HtmlDocVisitor::visitPre ( DocHtmlDescData *  dd )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1531 行定义.

{
  if (m_hide) return;
  m_t << "<dd" << htmlAttribsToString(dd->attribs()) << ">";
}

引用了 DocHtmlDescData::attribs(), htmlAttribsToString(), m_hide , 以及 m_t.

visitPre() [10/37]

void HtmlDocVisitor::visitPre ( DocHtmlDescList *  dl )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1505 行定义.

{
  if (m_hide) return;
  forceEndParagraph(dl);
  m_t << "<dl" << htmlAttribsToString(dl->attribs()) << ">\n";
}

引用了 DocHtmlDescList::attribs(), forceEndParagraph(), htmlAttribsToString(), m_hide , 以及 m_t.

visitPre() [11/37]

void HtmlDocVisitor::visitPre ( DocHtmlDescTitle *  dt )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1519 行定义.

{
  if (m_hide) return;
  m_t << "<dt" << htmlAttribsToString(dt->attribs()) << ">";
}

引用了 DocHtmlDescTitle::attribs(), htmlAttribsToString(), m_hide , 以及 m_t.

visitPre() [12/37]

void HtmlDocVisitor::visitPre ( DocHtmlHeader *  header )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1653 行定义.

{
  if (m_hide) return;
  forceEndParagraph(header);
  m_t << "<h" << header->level() << htmlAttribsToString(header->attribs()) << ">";
}

引用了 DocHtmlHeader::attribs(), forceEndParagraph(), htmlAttribsToString(), DocHtmlHeader::level(), m_hide , 以及 m_t.

visitPre() [13/37]

void HtmlDocVisitor::visitPre ( DocHtmlList *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1462 行定义.

{
  if (m_hide) return;
  forceEndParagraph(s);
  if (s->type()==DocHtmlList::Ordered)
  {
    m_t << "<ol" << htmlAttribsToString(s->attribs());
  }
  else
  {
    m_t << "<ul" << htmlAttribsToString(s->attribs());
  }
  m_t << ">\n";
}

引用了 DocHtmlList::attribs(), forceEndParagraph(), htmlAttribsToString(), m_hide, m_t, DocHtmlList::Ordered , 以及 DocHtmlList::type().

visitPre() [14/37]

void HtmlDocVisitor::visitPre ( DocHtmlListItem *  i )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1492 行定义.

{
  if (m_hide) return;
  m_t << "<li" << htmlAttribsToString(i->attribs()) << ">";
  if (!i->isPreformatted()) m_t << "\n";
}

引用了 DocHtmlListItem::attribs(), htmlAttribsToString(), DocNode::isPreformatted(), m_hide , 以及 m_t.

visitPre() [15/37]

void HtmlDocVisitor::visitPre ( DocHtmlRow *  tr )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1576 行定义.

{
  if (m_hide) return;
  m_t << "<tr" << htmlAttribsToString(tr->attribs()) << ">\n";
}

引用了 DocHtmlRow::attribs(), htmlAttribsToString(), m_hide , 以及 m_t.

visitPre() [16/37]

void HtmlDocVisitor::visitPre ( DocHtmlTable *  t )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1543 行定义.

{
  if (m_hide) return;
 
  forceEndParagraph(t);
 
  if (t->hasCaption())
  {
    QCString anc =  t->caption()->anchor();
    if (!anc.isEmpty())
    {
      m_t << "<a class=\"anchor\" id=\"" << anc << "\"></a>\n";
    }
  }
 
  QCString attrs = htmlAttribsToString(t->attribs());
  if (attrs.isEmpty())
  {
    m_t << "<table class=\"doxtable\">\n";
  }
  else
  {
    m_t << "<table" << htmlAttribsToString(t->attribs()) << ">\n";
  }
}

引用了 DocHtmlCaption::anchor(), DocHtmlTable::attribs(), DocHtmlTable::caption(), forceEndParagraph(), DocHtmlTable::hasCaption(), htmlAttribsToString(), QCString::isEmpty(), m_hide , 以及 m_t.

visitPre() [17/37]

void HtmlDocVisitor::visitPre ( DocImage *  img )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1667 行定义.

{
  if (img->type()==DocImage::Html)
  {
    bool inlineImage = img->isInlineImage();
    bool typeSVG = img->isSVG();
    QCString url = img->url();
 
    if (!inlineImage)
    {
      forceEndParagraph(img);
    }
    if (m_hide) return;
    QCString baseName=img->name();
    int i;
    if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1)
    {
      baseName=baseName.right(baseName.length()-i-1);
    }
    if (!inlineImage) m_t << "<div class=\"image\">\n";
    QCString sizeAttribs;
    if (!img->width().isEmpty())
    {
      sizeAttribs+=" width=\""+img->width()+"\"";
    }
    if (!img->height().isEmpty()) // link to local file
    {
      sizeAttribs+=" height=\""+img->height()+"\"";
    }
    // 16 cases: url.isEmpty() | typeSVG | inlineImage | img->hasCaption()
 
    HtmlAttribList extraAttribs;
    if (typeSVG)
    {
      HtmlAttrib opt;
      opt.name  = "style";
      opt.value = "pointer-events: none;";
      extraAttribs.push_back(opt);
    }
    QCString alt;
    mergeHtmlAttributes(img->attribs(),extraAttribs);
    QCString attrs = htmlAttribsToString(extraAttribs,&alt);
    QCString src;
    if (url.isEmpty())
    {
      src = img->relPath()+img->name();
    }
    else
    {
      src = correctURL(url,img->relPath());
    }
    if (typeSVG && !inlineImage)
    {
      m_t << "<object type=\"image/svg+xml\" data=\"" << convertToHtml(src)
        << "\"" << sizeAttribs << attrs;
      if (inlineImage)
      {
        // skip closing tag
      }
      else
      {
        m_t << ">" << alt << "</object>\n";
      }
    }
    else
    {
      m_t << "<img src=\"" << convertToHtml(src) << "\" alt=\"" << alt << "\"" << sizeAttribs << attrs;
      if (inlineImage)
      {
        m_t << " class=\"inline\"";
      }
      else
      {
        m_t << "/>\n";
      }
    }
    if (img->hasCaption())
    {
      if (inlineImage)
      {
        m_t << " title=\"";
      }
      else
      {
        m_t << "<div class=\"caption\">\n";
      }
    }
    else if (inlineImage)
    {
      m_t << "/>";
    }
  }
  else // other format -> skip
  {
    pushHidden(m_hide);
    m_hide=TRUE;
  }
}

引用了 DocImage::attribs(), convertToHtml(), correctURL(), QCString::findRev(), forceEndParagraph(), DocImage::hasCaption(), DocImage::height(), DocImage::Html, htmlAttribsToString(), QCString::isEmpty(), DocImage::isInlineImage(), DocImage::isSVG(), QCString::length(), m_hide, m_t, mergeHtmlAttributes(), HtmlAttrib::name, DocImage::name(), DocVisitor::pushHidden(), DocImage::relPath(), QCString::right(), TRUE, DocImage::type(), DocImage::url(), HtmlAttrib::value , 以及 DocImage::width().

visitPre() [18/37]

void HtmlDocVisitor::visitPre ( DocInternal *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1619 行定义.

{
  if (m_hide) return;
  //forceEndParagraph(i);
  //m_t << "<p><b>" << theTranslator->trForInternalUseOnly() << "</b></p>\n";
}

引用了 m_hide.

visitPre() [19/37]

void HtmlDocVisitor::visitPre ( DocInternalRef *  ref )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2072 行定义.

{
  if (m_hide) return;
  startLink(QCString(),ref->file(),ref->relPath(),ref->anchor());
}

引用了 DocInternalRef::anchor(), DocInternalRef::file(), m_hide, DocInternalRef::relPath() , 以及 startLink().

visitPre() [20/37]

void HtmlDocVisitor::visitPre ( DocLink *  lnk )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1856 行定义.

{
  if (m_hide) return;
  startLink(lnk->ref(),lnk->file(),lnk->relPath(),lnk->anchor());
}

引用了 DocLink::anchor(), DocLink::file(), m_hide, DocLink::ref(), DocLink::relPath() , 以及 startLink().

visitPre() [21/37]

void HtmlDocVisitor::visitPre ( DocMscFile *  df )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1816 行定义.

{
  if (m_hide) return;
  m_t << "<div class=\"mscgraph\">\n";
  writeMscFile(df->file(),df->relPath(),df->context(),df->srcFile(),df->srcLine());
  if (df->hasCaption())
  {
    m_t << "<div class=\"caption\">\n";
  }
}

引用了 DocDiagramFileBase< T >::context(), DocDiagramFileBase< T >::file(), DocDiagramFileBase< T >::hasCaption(), m_hide, m_t, DocDiagramFileBase< T >::relPath(), DocDiagramFileBase< T >::srcFile(), DocDiagramFileBase< T >::srcLine() , 以及 writeMscFile().

visitPre() [22/37]

void HtmlDocVisitor::visitPre ( DocPara *  p )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1202 行定义.

{
  if (m_hide) return;
 
  //printf("DocPara::visitPre: parent of kind %d ",
  //       p->parent() ? p->parent()->kind() : -1);
 
  bool needsTag = FALSE;
  if (p && p->parent())
  {
    switch (p->parent()->kind())
    {
      case DocNode::Kind_Section:
      case DocNode::Kind_Internal:
      case DocNode::Kind_HtmlListItem:
      case DocNode::Kind_HtmlDescData:
      case DocNode::Kind_HtmlCell:
      case DocNode::Kind_SimpleListItem:
      case DocNode::Kind_AutoListItem:
      case DocNode::Kind_SimpleSect:
      case DocNode::Kind_XRefItem:
      case DocNode::Kind_Copy:
      case DocNode::Kind_HtmlBlockQuote:
      case DocNode::Kind_ParBlock:
        needsTag = TRUE;
        break;
      case DocNode::Kind_Root:
        needsTag = !((DocRoot*)p->parent())->singleLine();
        break;
      default:
        needsTag = FALSE;
    }
  }
 
  // if the first element of a paragraph is something that should be outside of
  // the paragraph (<ul>,<dl>,<table>,..) then that will already started the
  // paragraph and we don't need to do it here
  size_t nodeIndex = 0;
  if (p && nodeIndex<p->children().size())
  {
    while (nodeIndex<p->children().size() && isInvisibleNode(p->children().at(nodeIndex).get()))
    {
      nodeIndex++;
    }
    if (nodeIndex<p->children().size())
    {
      const DocNode *n = p->children().at(nodeIndex).get();
      if (mustBeOutsideParagraph(n))
      {
        needsTag = FALSE;
      }
    }
  }
 
  // check if this paragraph is the first or last or intermediate child of a <li> or <dd>.
  // this allows us to mark the tag with a special class so we can
  // fix the otherwise ugly spacing.
  int t;
  bool isFirst;
  bool isLast;
  t = getParagraphContext(p,isFirst,isLast);
  //printf("startPara first=%d last=%d\n",isFirst,isLast);
  if (isFirst && isLast) needsTag=FALSE;
 
  //printf("  needsTag=%d\n",needsTag);
  // write the paragraph tag (if needed)
  if (needsTag)
  {
    if (strlen(contexts[t]))
      m_t << "<p class=\"" << contexts[t] << "\"" << htmlAttribsToString(p->attribs()) << ">";
    else
      m_t << "<p " << htmlAttribsToString(p->attribs()) << ">";
  }
}

引用了 DocPara::attribs(), CompAccept< T >::children(), contexts, FALSE, getParagraphContext(), htmlAttribsToString(), isInvisibleNode(), DocNode::kind(), DocNode::Kind_AutoListItem, DocNode::Kind_Copy, DocNode::Kind_HtmlBlockQuote, DocNode::Kind_HtmlCell, DocNode::Kind_HtmlDescData, DocNode::Kind_HtmlListItem, DocNode::Kind_Internal, DocNode::Kind_ParBlock, DocNode::Kind_Root, DocNode::Kind_Section, DocNode::Kind_SimpleListItem, DocNode::Kind_SimpleSect, DocNode::Kind_XRefItem, m_hide, m_t, mustBeOutsideParagraph(), DocNode::parent() , 以及 TRUE.

visitPre() [23/37]

void HtmlDocVisitor::visitPre ( DocParamList *  pl )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1965 行定义.

{
  //printf("DocParamList::visitPre\n");
  if (m_hide) return;
  m_t << "    <tr>";
  DocParamSect *sect = 0;
  if (pl->parent()->kind()==DocNode::Kind_ParamSect)
  {
    sect=(DocParamSect*)pl->parent();
  }
  if (sect && sect->hasInOutSpecifier())
  {
    m_t << "<td class=\"paramdir\">";
    if (pl->direction()!=DocParamSect::Unspecified)
    {
      m_t << "[";
      if (pl->direction()==DocParamSect::In)
      {
        m_t << "in";
      }
      else if (pl->direction()==DocParamSect::Out)
      {
        m_t << "out";
      }
      else if (pl->direction()==DocParamSect::InOut)
      {
        m_t << "in,out";
      }
      m_t << "]";
    }
    m_t << "</td>";
  }
  if (sect && sect->hasTypeSpecifier())
  {
    m_t << "<td class=\"paramtype\">";
    for (const auto &type : pl->paramTypes())
    {
      if (type->kind()==DocNode::Kind_Word)
      {
        visit((DocWord*)type.get());
      }
      else if (type->kind()==DocNode::Kind_LinkedWord)
      {
        visit((DocLinkedWord*)type.get());
      }
      else if (type->kind()==DocNode::Kind_Sep)
      {
        m_t << "&#160;" << ((DocSeparator *)type.get())->chars() << "&#160;";
      }
    }
    m_t << "</td>";
  }
  m_t << "<td class=\"paramname\">";
  bool first=TRUE;
  for (const auto &param : pl->parameters())
  {
    if (!first) m_t << ","; else first=FALSE;
    if (param->kind()==DocNode::Kind_Word)
    {
      visit((DocWord*)param.get());
    }
    else if (param->kind()==DocNode::Kind_LinkedWord)
    {
      visit((DocLinkedWord*)param.get());
    }
  }
  m_t << "</td><td>";
}

引用了 DocParamList::direction(), FALSE, DocParamSect::hasInOutSpecifier(), DocParamSect::hasTypeSpecifier(), DocParamSect::In, DocParamSect::InOut, DocNode::kind(), DocNode::Kind_LinkedWord, DocNode::Kind_ParamSect, DocNode::Kind_Sep, DocNode::Kind_Word, m_hide, m_t, DocParamSect::Out, DocParamList::parameters(), DocParamList::paramTypes(), DocNode::parent(), TRUE, DocParamSect::Unspecified , 以及 visit().

visitPre() [24/37]

void HtmlDocVisitor::visitPre ( DocParamSect *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1923 行定义.

{
  if (m_hide) return;
  forceEndParagraph(s);
  QCString className;
  QCString heading;
  switch(s->type())
  {
    case DocParamSect::Param:
      heading=theTranslator->trParameters();
      className="params";
      break;
    case DocParamSect::RetVal:
      heading=theTranslator->trReturnValues();
      className="retval";
      break;
    case DocParamSect::Exception:
      heading=theTranslator->trExceptions();
      className="exception";
      break;
    case DocParamSect::TemplateParam:
      heading=theTranslator->trTemplateParameters();
      className="tparams";
      break;
    default:
      ASSERT(0);
  }
  m_t << "<dl class=\"" << className << "\"><dt>";
  m_t << heading;
  m_t << "</dt><dd>\n";
  m_t << "  <table class=\"" << className << "\">\n";
}

引用了 ASSERT, DocParamSect::Exception, forceEndParagraph(), m_hide, m_t, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, theTranslator, Translator::trExceptions(), Translator::trParameters(), Translator::trReturnValues(), Translator::trTemplateParameters() , 以及 DocParamSect::type().

visitPre() [25/37]

void HtmlDocVisitor::visitPre ( DocParBlock *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2139 行定义.

{
  if (m_hide) return;
}

引用了 m_hide.

visitPre() [26/37]

void HtmlDocVisitor::visitPre ( DocRef *  ref )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1868 行定义.

{
  if (m_hide) return;
  if (!ref->file().isEmpty())
  {
    // when ref->isSubPage()==TRUE we use ref->file() for HTML and
    // ref->anchor() for LaTeX/RTF
    startLink(ref->ref(),ref->file(),ref->relPath(),ref->isSubPage() ? QCString() : ref->anchor());
  }
  if (!ref->hasLinkText()) filter(ref->targetTitle());
}

引用了 DocRef::anchor(), DocRef::file(), filter(), DocRef::hasLinkText(), QCString::isEmpty(), DocRef::isSubPage(), m_hide, DocRef::ref(), DocRef::relPath(), startLink() , 以及 DocRef::targetTitle().

visitPre() [27/37]

void HtmlDocVisitor::visitPre ( DocRoot *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1342 行定义.

{
}

visitPre() [28/37]

void HtmlDocVisitor::visitPre ( DocSecRefItem *  ref )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1887 行定义.

{
  if (m_hide) return;
  if (!ref->file().isEmpty())
  {
    m_t << "<li>";
    startLink(ref->ref(),ref->file(),ref->relPath(),ref->isSubPage() ? QCString() : ref->anchor());
  }
}

引用了 DocSecRefItem::anchor(), DocSecRefItem::file(), QCString::isEmpty(), DocSecRefItem::isSubPage(), m_hide, m_t, DocSecRefItem::ref(), DocSecRefItem::relPath() , 以及 startLink().

visitPre() [29/37]

void HtmlDocVisitor::visitPre ( DocSecRefList *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1907 行定义.

{
  if (m_hide) return;
  forceEndParagraph(s);
  m_t << "<div>\n";
  m_t << "<ul class=\"multicol\">\n";
}

引用了 forceEndParagraph(), m_hide , 以及 m_t.

visitPre() [30/37]

void HtmlDocVisitor::visitPre ( DocSection *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1446 行定义.

{
  if (m_hide) return;
  forceEndParagraph(s);
  m_t << "<h" << s->level() << ">";
  m_t << "<a class=\"anchor\" id=\"" << s->anchor();
  m_t << "\"></a>\n";
  filter(convertCharEntitiesToUTF8(s->title()));
  m_t << "</h" << s->level() << ">\n";
}

引用了 DocSection::anchor(), convertCharEntitiesToUTF8(), filter(), forceEndParagraph(), DocSection::level(), m_hide, m_t , 以及 DocSection::title().

visitPre() [31/37]

void HtmlDocVisitor::visitPre ( DocSimpleList *  sl )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1416 行定义.

{
  if (m_hide) return;
  forceEndParagraph(sl);
  m_t << "<ul>";
  if (!sl->isPreformatted()) m_t << "\n";
 
}

引用了 forceEndParagraph(), DocNode::isPreformatted(), m_hide , 以及 m_t.

visitPre() [32/37]

void HtmlDocVisitor::visitPre ( DocSimpleListItem *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1433 行定义.

{
  if (m_hide) return;
  m_t << "<li>";
}

引用了 m_hide , 以及 m_t.

visitPre() [33/37]

void HtmlDocVisitor::visitPre ( DocSimpleSect *  s )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1350 行定义.

{
  if (m_hide) return;
  forceEndParagraph(s);
  m_t << "<dl class=\"section " << s->typeString() << "\"><dt>";
  switch(s->type())
  {
    case DocSimpleSect::See:
      m_t << theTranslator->trSeeAlso(); break;
    case DocSimpleSect::Return:
      m_t << theTranslator->trReturns(); break;
    case DocSimpleSect::Author:
      m_t << theTranslator->trAuthor(TRUE,TRUE); break;
    case DocSimpleSect::Authors:
      m_t << theTranslator->trAuthor(TRUE,FALSE); break;
    case DocSimpleSect::Version:
      m_t << theTranslator->trVersion(); break;
    case DocSimpleSect::Since:
      m_t << theTranslator->trSince(); break;
    case DocSimpleSect::Date:
      m_t << theTranslator->trDate(); break;
    case DocSimpleSect::Note:
      m_t << theTranslator->trNote(); break;
    case DocSimpleSect::Warning:
      m_t << theTranslator->trWarning(); break;
    case DocSimpleSect::Pre:
      m_t << theTranslator->trPrecondition(); break;
    case DocSimpleSect::Post:
      m_t << theTranslator->trPostcondition(); break;
    case DocSimpleSect::Copyright:
      m_t << theTranslator->trCopyright(); break;
    case DocSimpleSect::Invar:
      m_t << theTranslator->trInvariant(); break;
    case DocSimpleSect::Remark:
      m_t << theTranslator->trRemarks(); break;
    case DocSimpleSect::Attention:
      m_t << theTranslator->trAttention(); break;
    case DocSimpleSect::User: break;
    case DocSimpleSect::Rcs: break;
    case DocSimpleSect::Unknown:  break;
  }
 
  // special case 1: user defined title
  if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs)
  {
    m_t << "</dt><dd>";
  }
}

引用了 DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Copyright, DocSimpleSect::Date, FALSE, forceEndParagraph(), DocSimpleSect::Invar, m_hide, m_t, DocSimpleSect::Note, DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, theTranslator, Translator::trAttention(), Translator::trAuthor(), Translator::trCopyright(), Translator::trDate(), Translator::trInvariant(), Translator::trNote(), Translator::trPostcondition(), Translator::trPrecondition(), Translator::trRemarks(), Translator::trReturns(), Translator::trSeeAlso(), Translator::trSince(), TRUE, Translator::trVersion(), Translator::trWarning(), DocSimpleSect::type(), DocSimpleSect::typeString(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version , 以及 DocSimpleSect::Warning.

visitPre() [34/37]

void HtmlDocVisitor::visitPre ( DocText *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2085 行定义.

{
}

visitPre() [35/37]

void HtmlDocVisitor::visitPre ( DocTitle *  )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 1406 行定义.

{
}

visitPre() [36/37]

void HtmlDocVisitor::visitPre ( DocVhdlFlow *  vf )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2108 行定义.

{
  if (m_hide) return;
  if (VhdlDocGen::getFlowMember()) // use VHDL flow chart creator
  {
    forceEndParagraph(vf);
    QCString fname=FlowChart::convertNameToFileName();
    m_t << "<p>";
    m_t << "flowchart: " ; // TODO: translate me
    m_t << "<a href=\"";
    m_t << fname;
    m_t << ".svg\">";
    m_t << VhdlDocGen::getFlowMember()->name();
    m_t << "</a>";
    if (vf->hasCaption())
    {
      m_t << "<br />";
    }
  }
}

引用了 FlowChart::convertNameToFileName(), forceEndParagraph(), VhdlDocGen::getFlowMember(), DocVhdlFlow::hasCaption(), m_hide, m_t , 以及 Definition::name().

visitPre() [37/37]

void HtmlDocVisitor::visitPre ( DocXRefItem *  x )

virtual

实现了 DocVisitor.

在文件 htmldocvisitor.cpp 第 2041 行定义.

{
  if (m_hide) return;
  if (x->title().isEmpty()) return;
 
  forceEndParagraph(x);
  bool anonymousEnum = x->file()=="@";
  if (!anonymousEnum)
  {
    m_t << "<dl class=\"" << x->key() << "\"><dt><b><a class=\"el\" href=\""
        << x->relPath() << addHtmlExtensionIfMissing(x->file())
        << "#" << x->anchor() << "\">";
  }
  else
  {
    m_t << "<dl class=\"" << x->key() << "\"><dt><b>";
  }
  filter(x->title());
  m_t << ":";
  if (!anonymousEnum) m_t << "</a>";
  m_t << "</b></dt><dd>";
}

引用了 addHtmlExtensionIfMissing(), DocXRefItem::anchor(), DocXRefItem::file(), filter(), forceEndParagraph(), QCString::isEmpty(), DocXRefItem::key(), m_hide, m_t, DocXRefItem::relPath() , 以及 DocXRefItem::title().

writeDiaFile()

void HtmlDocVisitor::writeDiaFile ( const QCString &  fileName, const QCString &  relPath, const QCString &  context, const QCString &  srcFile, int  srcLine  )

private

在文件 htmldocvisitor.cpp 第 2297 行定义.

{
  QCString baseName=fileName;
  int i;
  if ((i=baseName.findRev('/'))!=-1) // strip path
  {
    baseName=baseName.right(baseName.length()-i-1);
  }
  if ((i=baseName.find('.'))!=-1) // strip extension
  {
    baseName=baseName.left(i);
  }
  baseName.prepend("dia_");
  QCString outDir = Config_getString(HTML_OUTPUT);
  writeDiaGraphFromFile(fileName,outDir,baseName,DIA_BITMAP,srcFile,srcLine);
 
  m_t << "<img src=\"" << relPath << baseName << ".png" << "\" />\n";
}

引用了 Config_getString, DIA_BITMAP, QCString::find(), QCString::findRev(), QCString::left(), QCString::length(), m_t, QCString::prepend(), QCString::right() , 以及 writeDiaGraphFromFile().

被这些函数引用 visitPre().

writeDotFile()

void HtmlDocVisitor::writeDotFile ( const QCString &  fileName, const QCString &  relPath, const QCString &  context, const QCString &  srcFile, int  srcLine  )

private

在文件 htmldocvisitor.cpp 第 2255 行定义.

{
  QCString baseName=fn;
  int i;
  if ((i=baseName.findRev('/'))!=-1)
  {
    baseName=baseName.right(baseName.length()-i-1);
  }
  if ((i=baseName.find('.'))!=-1) // strip extension
  {
    baseName=baseName.left(i);
  }
  baseName.prepend("dot_");
  QCString outDir = Config_getString(HTML_OUTPUT);
  writeDotGraphFromFile(fn,outDir,baseName,GOF_BITMAP,srcFile,srcLine);
  writeDotImageMapFromFile(m_t,fn,outDir,relPath,baseName,context,-1,srcFile,srcLine);
}

引用了 Config_getString, QCString::find(), QCString::findRev(), GOF_BITMAP, QCString::left(), QCString::length(), m_t, QCString::prepend(), QCString::right(), writeDotGraphFromFile() , 以及 writeDotImageMapFromFile().

被这些函数引用 visit() , 以及 visitPre().

writeMscFile()

void HtmlDocVisitor::writeMscFile ( const QCString &  fileName, const QCString &  relPath, const QCString &  context, const QCString &  srcFile, int  srcLine  )

private

在文件 htmldocvisitor.cpp 第 2274 行定义.

{
  QCString baseName=fileName;
  int i;
  if ((i=baseName.findRev('/'))!=-1) // strip path
  {
    baseName=baseName.right(baseName.length()-i-1);
  }
  if ((i=baseName.find('.'))!=-1) // strip extension
  {
    baseName=baseName.left(i);
  }
  baseName.prepend("msc_");
  QCString outDir = Config_getString(HTML_OUTPUT);
  QCString imgExt = getDotImageExtension();
  MscOutputFormat mscFormat = MSC_BITMAP;
  if ("svg" == imgExt)
    mscFormat = MSC_SVG;
  writeMscGraphFromFile(fileName,outDir,baseName,mscFormat,srcFile,srcLine);
  writeMscImageMapFromFile(m_t,fileName,outDir,relPath,baseName,context,mscFormat,srcFile,srcLine);
}

引用了 Config_getString, QCString::find(), QCString::findRev(), getDotImageExtension(), QCString::left(), QCString::length(), m_t, MSC_BITMAP, MSC_SVG, QCString::prepend(), QCString::right(), writeMscGraphFromFile() , 以及 writeMscImageMapFromFile().

被这些函数引用 visit() , 以及 visitPre().

writeObfuscatedMailAddress()

void HtmlDocVisitor::writeObfuscatedMailAddress ( const QCString &  url )

private

在文件 htmldocvisitor.cpp 第 336 行定义.

{
  m_t << "<a href=\"#\" onclick=\"location.href='mai'+'lto:'";
  uint i;
  int size=3;
  for (i=0;i<url.length();)
  {
    m_t << "+'" << url.mid(i,size) << "'";
    i+=size;
    if (size==3) size=2; else size=3;
  }
  m_t << "; return false;\">";
}

引用了 QCString::length(), m_t , 以及 QCString::mid().

被这些函数引用 visit() , 以及 visitPre().

writePlantUMLFile()

void HtmlDocVisitor::writePlantUMLFile ( const QCString &  fileName, const QCString &  relPath, const QCString &  context, const QCString &  srcFile, int  srcLine  )

private

在文件 htmldocvisitor.cpp 第 2317 行定义.

{
  QCString baseName=fileName;
  int i;
  if ((i=baseName.findRev('/'))!=-1) // strip path
  {
    baseName=baseName.right(baseName.length()-i-1);
  }
  if ((i=baseName.findRev('.'))!=-1) // strip extension
  {
    baseName=baseName.left(i);
  }
  static QCString outDir = Config_getString(HTML_OUTPUT);
  QCString imgExt = getDotImageExtension();
  if (imgExt=="svg")
  {
    PlantumlManager::instance().generatePlantUMLOutput(fileName,outDir,PlantumlManager::PUML_SVG);
    //m_t << "<iframe scrolling=\"no\" frameborder=\"0\" src=\"" << relPath << baseName << ".svg" << "\" />\n";
    //m_t << "<p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p>";
    //m_t << "</iframe>\n";
    m_t << "<object type=\"image/svg+xml\" data=\"" << relPath << baseName << ".svg\"></object>\n";
  }
  else
  {
    PlantumlManager::instance().generatePlantUMLOutput(fileName,outDir,PlantumlManager::PUML_BITMAP);
    m_t << "<img src=\"" << relPath << baseName << ".png" << "\" />\n";
  }
}

引用了 Config_getString, QCString::findRev(), PlantumlManager::generatePlantUMLOutput(), getDotImageExtension(), PlantumlManager::instance(), QCString::left(), QCString::length(), m_t, PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_SVG , 以及 QCString::right().

被这些函数引用 visit().

类成员变量说明

m_ci

CodeOutputInterface& HtmlDocVisitor::m_ci

private

在文件 htmldocvisitor.h 第 165 行定义.

被这些函数引用 visit().

m_ctx

const Definition* HtmlDocVisitor::m_ctx

private

在文件 htmldocvisitor.h 第 168 行定义.

被这些函数引用 visit().

m_hide

bool HtmlDocVisitor::m_hide

private

在文件 htmldocvisitor.h 第 167 行定义.

被这些函数引用 visit(), visitPost() , 以及 visitPre().

m_insidePre

bool HtmlDocVisitor::m_insidePre

private

在文件 htmldocvisitor.h 第 166 行定义.

被这些函数引用 visit().

m_langExt

QCString HtmlDocVisitor::m_langExt

private

在文件 htmldocvisitor.h 第 169 行定义.

被这些函数引用 HtmlDocVisitor() , 以及 visit().

m_t

TextStream& HtmlDocVisitor::m_t

private

在文件 htmldocvisitor.h 第 164 行定义.

被这些函数引用 endLink(), filter(), filterQuotedCdataAttr(), forceEndParagraph(), forceStartParagraph(), startLink(), visit(), visitPost(), visitPre(), writeDiaFile(), writeDotFile(), writeMscFile(), writeObfuscatedMailAddress() , 以及 writePlantUMLFile().

---

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

• src/htmldocvisitor.h
• src/htmldocvisitor.cpp