HtmlCodeGenerator类 参考

#include <htmlgen.h>

类 HtmlCodeGenerator 继承关系图:

HtmlCodeGenerator 的协作图:

Public 成员函数
	HtmlCodeGenerator (TextStream &t, const QCString &relPath)
	HtmlCodeGenerator (TextStream &t)
int	id () const
	Identifier for the output file 更多...
void	setId (int id)
void	setRelativePath (const QCString &path)
void	codify (const QCString &text)
void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
void	writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
void	writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool)
void	startCodeLine (bool)
void	endCodeLine ()
void	startFontClass (const QCString &s)
void	endFontClass ()
void	writeCodeAnchor (const QCString &anchor)
void	setCurrentDoc (const Definition *, const QCString &, bool)
void	addWord (const QCString &, bool)
void	startCodeFragment (const QCString &style)
void	endCodeFragment (const QCString &)
Public 成员函数 继承自 CodeOutputInterface
virtual	~CodeOutputInterface ()
	CodeOutputInterface ()
	CodeOutputInterface (const CodeOutputInterface &)=delete
CodeOutputInterface &	operator= (const CodeOutputInterface &)=delete

Private 成员函数
void	_writeCodeLink (const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
void	docify (const QCString &str)

Private 属性
TextStream &	m_t
int	m_col = 0
QCString	m_relPath
bool	m_lineOpen = false
int	m_id = 0

详细描述

在文件 htmlgen.h 第 21 行定义.

构造及析构函数说明

HtmlCodeGenerator() [1/2]

HtmlCodeGenerator::HtmlCodeGenerator	(	TextStream &	t,
		const QCString &	relPath
	)

在文件 htmlgen.cpp 第 577 行定义.

  : m_t(t), m_relPath(relPath)
{
}

HtmlCodeGenerator() [2/2]

HtmlCodeGenerator::HtmlCodeGenerator

(

TextStream &

t

)

在文件 htmlgen.cpp 第 573 行定义.

                                                  : m_t(t)
{
}

成员函数说明

_writeCodeLink()

void HtmlCodeGenerator::_writeCodeLink ( const QCString &  className, const QCString &  ref, const QCString &  file, const QCString &  anchor, const QCString &  name, const QCString &  tooltip  )

private

在文件 htmlgen.cpp 第 742 行定义.

{
  if (!ref.isEmpty())
  {
    m_t << "<a class=\"" << className << "Ref\" ";
    m_t << externalLinkTarget();
  }
  else
  {
    m_t << "<a class=\"" << className << "\" ";
  }
  m_t << "href=\"";
  m_t << externalRef(m_relPath,ref,TRUE);
  if (!f.isEmpty()) m_t << addHtmlExtensionIfMissing(f);
  if (!anchor.isEmpty()) m_t << "#" << anchor;
  m_t << "\"";
  if (!tooltip.isEmpty()) m_t << " title=\"" << convertToHtml(tooltip) << "\"";
  m_t << ">";
  docify(name);
  m_t << "</a>";
  m_col+=name.length();
}

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

被这些函数引用 writeCodeLink() , 以及 writeLineNumber().

addWord()

void HtmlCodeGenerator::addWord ( const QCString &  , bool    )

inlinevirtual

实现了 CodeOutputInterface.

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

: public OutputGenerator

codify()

void HtmlCodeGenerator::codify ( const QCString &  s )

virtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 587 行定义.

{
  int tabSize = Config_getInt(TAB_SIZE);
  if (!str.isEmpty())
  {
    const char *p=str.data();
    char c;
    int spacesToNextTabStop;
    while (*p)
    {
      c=*p++;
      switch(c)
      {
        case '\t': spacesToNextTabStop =
                         tabSize - (m_col%tabSize);
                   m_t << Doxygen::spaces.left(spacesToNextTabStop);
                   m_col+=spacesToNextTabStop;
                   break;
        case '\n': m_t << "\n"; m_col=0;
                   break;
        case '\r': break;
        case '<':  m_t << "&lt;"; m_col++;
                   break;
        case '>':  m_t << "&gt;"; m_col++;
                   break;
        case '&':  m_t << "&amp;"; m_col++;
                   break;
        case '\'': m_t << "&#39;"; m_col++; // &apos; is not valid XHTML
                   break;
        case '"':  m_t << "&quot;"; m_col++;
                   break;
        case '\\':
                   if (*p=='<')
                     { m_t << "&lt;"; p++; }
                   else if (*p=='>')
                     { m_t << "&gt;"; p++; }
                   else if (*p=='(')
                     { m_t << "\\&zwj;("; m_col++;p++; }
                   else if (*p==')')
                     { m_t << "\\&zwj;)"; m_col++;p++; }
                   else
                     m_t << "\\";
                   m_col++;
                   break;
        default:
          {
            uchar uc = static_cast<uchar>(c);
            if (uc<32)
            {
              m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
              m_col++;
            }
            else
            {
              p=writeUTF8Char(m_t,p-1);
              m_col++;
            }
          }
          break;
      }
    }
  }
}

引用了 Config_getInt, QCString::data(), hex, QCString::isEmpty(), QCString::left(), m_col, m_t, Doxygen::spaces , 以及 writeUTF8Char().

被这些函数引用 HtmlGenerator::codify() , 以及 writeLineNumber().

docify()

void HtmlCodeGenerator::docify ( const QCString &  str )

private

在文件 htmlgen.cpp 第 651 行定义.

{
  //m_t << getHtmlDirEmbeddingChar(getTextDirByConfig(str));
 
  if (!str.isEmpty())
  {
    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 '"':  m_t << "&quot;"; break;
        case '\\':
          if (*p=='<')
            { m_t << "&lt;"; p++; }
          else if (*p=='>')
            { m_t << "&gt;"; p++; }
          else if (*p=='(')
            { m_t << "\\&zwj;("; p++; }
          else if (*p==')')
            { m_t << "\\&zwj;)"; p++; }
          else
            m_t << "\\";
          break;
        default:
          {
            uchar uc = static_cast<uchar>(c);
            if (uc<32 && !isspace(c))
            {
              m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
            }
            else
            {
              m_t << c;
            }
          }
          break;
      }
    }
  }
}

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

被这些函数引用 _writeCodeLink() , 以及 writeTooltip().

endCodeFragment()

void HtmlCodeGenerator::endCodeFragment ( const QCString &  style )

virtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 894 行定义.

{
  //endCodeLine checks is there is still an open code line, if so closes it.
  endCodeLine();
 
  m_t << "</div><!-- fragment -->";
}

引用了 endCodeLine() , 以及 m_t.

被这些函数引用 HtmlGenerator::endCodeFragment().

endCodeLine()

void HtmlCodeGenerator::endCodeLine ( )

virtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 860 行定义.

{
  if (m_col == 0)
  {
    m_t << " ";
    m_col++;
  }
  if (m_lineOpen)
  {
    m_t << "</div>\n";
    m_lineOpen = FALSE;
  }
}

引用了 FALSE, m_col, m_lineOpen , 以及 m_t.

被这些函数引用 endCodeFragment() , 以及 HtmlGenerator::endCodeLine().

endFontClass()

void HtmlCodeGenerator::endFontClass ( )

virtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 879 行定义.

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

引用了 m_t.

被这些函数引用 HtmlGenerator::endFontClass().

id()

int HtmlCodeGenerator::id ( ) const

inlinevirtual

Identifier for the output file

重载 CodeOutputInterface .

在文件 htmlgen.h 第 39 行定义.

{}

setCurrentDoc()

void HtmlCodeGenerator::setCurrentDoc ( const Definition *  , const QCString &  , bool    )

inlinevirtual

实现了 CodeOutputInterface.

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

: public OutputGenerator

setId()

void HtmlCodeGenerator::setId ( int  id )

inline

在文件 htmlgen.h 第 40 行定义.

{}

被这些函数引用 HtmlGenerator::startFile() , 以及 HtmlGenerator::writeDoc().

setRelativePath()

void HtmlCodeGenerator::setRelativePath

(

const QCString &

path

)

在文件 htmlgen.cpp 第 582 行定义.

{
  m_relPath = path;
}

引用了 m_relPath.

被这些函数引用 HtmlGenerator::startFile().

startCodeFragment()

void HtmlCodeGenerator::startCodeFragment ( const QCString &  style )

virtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

参数

style

The kind of code fragment.

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 889 行定义.

{
  m_t << "<div class=\"fragment\">";
}

引用了 m_t.

被这些函数引用 HtmlGenerator::startCodeFragment().

startCodeLine()

void HtmlCodeGenerator::startCodeLine ( bool  )

virtual

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 850 行定义.

{
  m_col=0;
  if (!m_lineOpen)
  {
    m_t << "<div class=\"line\">";
    m_lineOpen = TRUE;
  }
}

引用了 m_col, m_lineOpen, m_t , 以及 TRUE.

被这些函数引用 HtmlGenerator::startCodeLine().

startFontClass()

void HtmlCodeGenerator::startFontClass ( const QCString &  clsName )

virtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

参数

clsName

The category name.

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 874 行定义.

{
  m_t << "<span class=\"" << s << "\">";
}

引用了 m_t.

被这些函数引用 HtmlGenerator::startFontClass().

writeCodeAnchor()

void HtmlCodeGenerator::writeCodeAnchor ( const QCString &  name )

virtual

Write an anchor to a source listing.

参数

name	The name of the anchor.

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 884 行定义.

{
  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
}

引用了 m_t.

被这些函数引用 HtmlGenerator::writeCodeAnchor().

writeCodeLink()

void HtmlCodeGenerator::writeCodeLink ( CodeSymbolType  type, const QCString &  ref, const QCString &  file, const QCString &  anchor, const QCString &  name, const QCString &  tooltip  )

virtual

Writes a link to an object in a code fragment.

参数

type	The type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
ref	If this is non-zero, the object is to be found in an external documentation file.
file	The file in which the object is located.
anchor	The anchor uniquely identifying the object within the file.
name	The text to display as a placeholder for the link.
tooltip	The tooltip to display when the mouse is on the link.

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 727 行定义.

{
  const char *hl = codeSymbolType2Str(type);
  QCString hlClass = "code";
  if (hl)
  {
    hlClass+=" hl_";
    hlClass+=hl;
  }
  _writeCodeLink(hlClass,ref,f,anchor,name,tooltip);
}

引用了 _writeCodeLink() , 以及 codeSymbolType2Str().

被这些函数引用 HtmlGenerator::writeCodeLink().

writeLineNumber()

void HtmlCodeGenerator::writeLineNumber ( const QCString &  ref, const QCString &  file, const QCString &  anchor, int  lineNumber, bool  writeLineAnchor  )

virtual

Writes the line number of a source listing

参数

ref	External reference (when imported from a tag file)
file	The file part of the URL pointing to the docs.
anchor	The anchor part of the URL pointing to the docs.
lineNumber	The line number to write
writeLineAnchor	Indicates if an anchor for the line number needs to be written

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 698 行定义.

{
  const int maxLineNrStr = 10;
  char lineNumber[maxLineNrStr];
  char lineAnchor[maxLineNrStr];
  qsnprintf(lineNumber,maxLineNrStr,"%5d",l);
  qsnprintf(lineAnchor,maxLineNrStr,"l%05d",l);
 
  if (!m_lineOpen)
  {
    m_t << "<div class=\"line\">";
    m_lineOpen = TRUE;
  }
 
  if (writeLineAnchor) m_t << "<a id=\"" << lineAnchor << "\" name=\"" << lineAnchor << "\"></a>";
  m_t << "<span class=\"lineno\">";
  if (!filename.isEmpty())
  {
    _writeCodeLink("line",ref,filename,anchor,lineNumber,QCString());
  }
  else
  {
    codify(lineNumber);
  }
  m_t << "</span>";
  m_col=0;
}

引用了 _writeCodeLink(), codify(), QCString::isEmpty(), m_col, m_lineOpen, m_t, qsnprintf , 以及 TRUE.

被这些函数引用 HtmlGenerator::writeLineNumber().

writeTooltip()

void HtmlCodeGenerator::writeTooltip ( const QCString &  id, const DocLinkInfo &  docInfo, const QCString &  decl, const QCString &  desc, const SourceLinkInfo &  defInfo, const SourceLinkInfo &  declInfo  )

virtual

Writes a tool tip definition

参数

id	unique identifier for the tooltip
docInfo	Info about the symbol's documentation.
decl	full declaration of the symbol (for functions)
desc	brief description for the symbol
defInfo	Info about the symbol's definition in the source code
declInfo	Info about the symbol's declaration in the source code

实现了 CodeOutputInterface.

在文件 htmlgen.cpp 第 768 行定义.

{
  m_t << "<div class=\"ttc\" id=\"" << id << "\">";
  m_t << "<div class=\"ttname\">";
  if (!docInfo.url.isEmpty())
  {
    m_t << "<a href=\"";
    m_t << externalRef(m_relPath,docInfo.ref,TRUE);
    m_t << addHtmlExtensionIfMissing(docInfo.url);
    if (!docInfo.anchor.isEmpty())
    {
      m_t << "#" << docInfo.anchor;
    }
    m_t << "\">";
  }
  docify(docInfo.name);
  if (!docInfo.url.isEmpty())
  {
    m_t << "</a>";
  }
  m_t << "</div>";
  if (!decl.isEmpty())
  {
    m_t << "<div class=\"ttdeci\">";
    docify(decl);
    m_t << "</div>";
  }
  if (!desc.isEmpty())
  {
    m_t << "<div class=\"ttdoc\">";
    docify(desc);
    m_t << "</div>";
  }
  if (!defInfo.file.isEmpty())
  {
    m_t << "<div class=\"ttdef\"><b>Definition:</b> ";
    if (!defInfo.url.isEmpty())
    {
      m_t << "<a href=\"";
      m_t << externalRef(m_relPath,defInfo.ref,TRUE);
      m_t << addHtmlExtensionIfMissing(defInfo.url);
      if (!defInfo.anchor.isEmpty())
      {
        m_t << "#" << defInfo.anchor;
      }
      m_t << "\">";
    }
    m_t << defInfo.file << ":" << defInfo.line;
    if (!defInfo.url.isEmpty())
    {
      m_t << "</a>";
    }
    m_t << "</div>";
  }
  if (!declInfo.file.isEmpty())
  {
    m_t << "<div class=\"ttdecl\"><b>Declaration:</b> ";
    if (!declInfo.url.isEmpty())
    {
      m_t << "<a href=\"";
      m_t << externalRef(m_relPath,declInfo.ref,TRUE);
      m_t << addHtmlExtensionIfMissing(declInfo.url);
      if (!declInfo.anchor.isEmpty())
      {
        m_t << "#" << declInfo.anchor;
      }
      m_t << "\">";
    }
    m_t << declInfo.file << ":" << declInfo.line;
    if (!declInfo.url.isEmpty())
    {
      m_t << "</a>";
    }
    m_t << "</div>";
  }
  m_t << "</div>\n";
}

引用了 addHtmlExtensionIfMissing(), DocLinkInfo::anchor, SourceLinkInfo::anchor, docify(), externalRef(), SourceLinkInfo::file, QCString::isEmpty(), SourceLinkInfo::line, m_relPath, m_t, DocLinkInfo::name, DocLinkInfo::ref, SourceLinkInfo::ref, TRUE, DocLinkInfo::url , 以及 SourceLinkInfo::url.

被这些函数引用 HtmlGenerator::writeTooltip().

类成员变量说明

m_col

int HtmlCodeGenerator::m_col = 0

private

在文件 htmlgen.h 第 72 行定义.

被这些函数引用 _writeCodeLink(), codify(), endCodeLine(), startCodeLine() , 以及 writeLineNumber().

m_id

int HtmlCodeGenerator::m_id = 0

private

在文件 htmlgen.h 第 75 行定义.

m_lineOpen

bool HtmlCodeGenerator::m_lineOpen = false

private

在文件 htmlgen.h 第 74 行定义.

被这些函数引用 endCodeLine(), startCodeLine() , 以及 writeLineNumber().

m_relPath

QCString HtmlCodeGenerator::m_relPath

private

在文件 htmlgen.h 第 73 行定义.

被这些函数引用 _writeCodeLink(), setRelativePath() , 以及 writeTooltip().

m_t

TextStream& HtmlCodeGenerator::m_t

private

在文件 htmlgen.h 第 71 行定义.

被这些函数引用 _writeCodeLink(), codify(), docify(), endCodeFragment(), endCodeLine(), endFontClass(), startCodeFragment(), startCodeLine(), startFontClass(), writeCodeAnchor(), writeLineNumber() , 以及 writeTooltip().

---

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

• src/htmlgen.h
• src/htmlgen.cpp