Singleton helper class to map html entities to other formats 更多...

#include <htmlentity.h>

HtmlEntityMapper 的协作图:

Public 成员函数
DocSymbol::SymType	name2sym (const QCString &symName) const
	Give code of the requested HTML entity name 更多...

const char *	utf8 (DocSymbol::SymType symb, bool useInPrintf=FALSE) const
	Access routine to the UTF8 code of the HTML entity 更多...

const char *	html (DocSymbol::SymType symb, bool useInPrintf=FALSE) const
	Access routine to the html code of the HTML entity 更多...

const char *	xml (DocSymbol::SymType symb) const
	Access routine to the XML code of the HTML entity 更多...

const char *	docbook (DocSymbol::SymType symb) const
	Access routine to the docbook code of the HTML entity 更多...

const char *	latex (DocSymbol::SymType symb) const
	Access routine to the LaTeX code of the HTML entity 更多...

const char *	man (DocSymbol::SymType symb) const
	Access routine to the man code of the HTML entity 更多...

const char *	rtf (DocSymbol::SymType symb) const
	Access routine to the RTF code of the HTML entity 更多...

const DocSymbol::PerlSymb *	perl (DocSymbol::SymType symb) const
	Access routine to the perl struct with the perl code of the HTML entity 更多...

void	writeXMLSchema (TextStream &t)

静态 Public 成员函数
static HtmlEntityMapper *	instance ()
	Returns the one and only instance of the HTML entity mapper 更多...

static void	deleteInstance ()
	Deletes the one and only instance of the HTML entity mapper 更多...

Private 成员函数
void	validate ()
	Routine to check if the entries of the html_entities are numbered correctly 更多...

	HtmlEntityMapper ()

	~HtmlEntityMapper ()

Private 属性
std::unordered_map< std::string, DocSymbol::SymType >	m_name2sym

静态 Private 属性
static HtmlEntityMapper *	s_instance = 0

详细描述

Singleton helper class to map html entities to other formats

在文件 htmlentity.h 第 26 行定义.

构造及析构函数说明

◆ HtmlEntityMapper()

HtmlEntityMapper::HtmlEntityMapper ( )

private

在文件 htmlentity.cpp 第 326 行定义.

 {
  
   for (int i = 0; i < g_numHtmlEntities; i++)
   {
     m_name2sym.insert(std::make_pair(g_htmlEntities[i].item,g_htmlEntities[i].symb));
   }
   validate();
 }

引用了 g_htmlEntities, g_numHtmlEntities, m_name2sym , 以及 validate().

被这些函数引用 instance().

◆ ~HtmlEntityMapper()

HtmlEntityMapper::~HtmlEntityMapper ( )

private

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

337 {

338 }

成员函数说明

◆ deleteInstance()

void HtmlEntityMapper::deleteInstance ( )

static

Deletes the one and only instance of the HTML entity mapper

在文件 htmlentity.cpp 第 351 行定义.

 {
   delete s_instance;
   s_instance=0;
 }

引用了 s_instance.

◆ docbook()

const char * HtmlEntityMapper::docbook ( DocSymbol::SymType symb ) const

Access routine to the docbook code of the HTML entity

参数

symb	Code of the requested HTML entity

返回: the docbook code of the HTML entity, in case the docbook code is unknown NULL is returned.

在文件 htmlentity.cpp 第 415 行定义.

 {
   return g_htmlEntities[symb].docbook;
 }

引用了 htmlEntityInfo::docbook , 以及 g_htmlEntities.

被这些函数引用 DocbookDocVisitor::visit().

◆ html()

const char * HtmlEntityMapper::html	(	DocSymbol::SymType	symb,
		bool	useInPrintf = `FALSE`
	)		const

Access routine to the html code of the HTML entity

参数

symb	Code of the requested HTML entity
useInPrintf	If TRUE the result will be escaped such that it can be used in a printf string pattern

返回: the html representation of the HTML entity, in case the html code is unknown NULL is returned.

在文件 htmlentity.cpp 第 386 行定义.

 {
   if (useInPrintf && symb==DocSymbol::Sym_Percent)
   {
     return "%%"; // escape for printf
   }
   else
   {
     return g_htmlEntities[symb].html;
   }
 }

引用了 g_htmlEntities, htmlEntityInfo::html , 以及 DocSymbol::Sym_Percent.

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

◆ instance()

HtmlEntityMapper * HtmlEntityMapper::instance ( )

static

Returns the one and only instance of the HTML entity mapper

在文件 htmlentity.cpp 第 341 行定义.

 {
   if (s_instance==0)
   {
     s_instance = new HtmlEntityMapper;
   }
   return s_instance;
 }

引用了 HtmlEntityMapper() , 以及 s_instance.

被这些函数引用 convertCharEntitiesToUTF8(), convertToDocBook(), DocSymbol::decodeSymbol(), filterLatexString(), generateXML(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), TextDocVisitor::visit() , 以及 PerlModDocVisitor::visit().

◆ latex()

const char * HtmlEntityMapper::latex ( DocSymbol::SymType symb ) const

Access routine to the LaTeX code of the HTML entity

参数

symb	Code of the requested HTML entity

返回: the LaTeX code of the HTML entity, in case the LaTeX code is unknown NULL is returned.

在文件 htmlentity.cpp 第 426 行定义.

 {
   return g_htmlEntities[symb].latex;
 }

引用了 g_htmlEntities , 以及 htmlEntityInfo::latex.

被这些函数引用 filterLatexString() , 以及 LatexDocVisitor::visit().

◆ man()

const char * HtmlEntityMapper::man ( DocSymbol::SymType symb ) const

Access routine to the man code of the HTML entity

参数

symb	Code of the requested HTML entity

返回: the man of the HTML entity, in case the man code is unknown NULL is returned.

在文件 htmlentity.cpp 第 437 行定义.

 {
   return g_htmlEntities[symb].man;
 }

引用了 g_htmlEntities , 以及 htmlEntityInfo::man.

被这些函数引用 ManDocVisitor::visit().

◆ name2sym()

DocSymbol::SymType HtmlEntityMapper::name2sym ( const QCString & symName ) const

Give code of the requested HTML entity name

参数

symName HTML entity name without & and ;

返回: the code for the requested HTML entity name, in case the requested HTML item does not exist DocSymbol::Sym_unknown is returned.

在文件 htmlentity.cpp 第 471 行定义.

 {
   auto it = m_name2sym.find(symName.str());
   return it!=m_name2sym.end() ? it->second : DocSymbol::Sym_Unknown;
 }

引用了 m_name2sym, QCString::str() , 以及 DocSymbol::Sym_Unknown.

被这些函数引用 convertCharEntitiesToUTF8(), convertToDocBook(), DocSymbol::decodeSymbol() , 以及 filterLatexString().

◆ perl()

const DocSymbol::PerlSymb * HtmlEntityMapper::perl ( DocSymbol::SymType symb ) const

Access routine to the perl struct with the perl code of the HTML entity

参数

symb	Code of the requested HTML entity

返回: the pointer to perl struct with the perl code of the HTML entity, in case the perl code does not exists the NULL pointer is entered in the symb field and in the DocSymbol::Perl_unknown in the type field.

在文件 htmlentity.cpp 第 460 行定义.

 {
   return &g_htmlEntities[symb].perl;
 }

引用了 g_htmlEntities , 以及 htmlEntityInfo::perl.

被这些函数引用 PerlModDocVisitor::visit().

◆ rtf()

const char * HtmlEntityMapper::rtf ( DocSymbol::SymType symb ) const

Access routine to the RTF code of the HTML entity

参数

symb	Code of the requested HTML entity

返回: the RTF of the HTML entity, in case the RTF code is unknown NULL is returned.

在文件 htmlentity.cpp 第 448 行定义.

 {
   return g_htmlEntities[symb].rtf;
 }

引用了 g_htmlEntities , 以及 htmlEntityInfo::rtf.

被这些函数引用 RTFDocVisitor::visit().

◆ utf8()

const char * HtmlEntityMapper::utf8	(	DocSymbol::SymType	symb,
		bool	useInPrintf = `FALSE`
	)		const

Access routine to the UTF8 code of the HTML entity

参数

symb	Code of the requested HTML entity
useInPrintf	If TRUE the result will be escaped such that it can be used in a printf string pattern

返回: the UTF8 code of the HTML entity, in case the UTF code is unknown NULL is returned.

在文件 htmlentity.cpp 第 366 行定义.

 {
   if (useInPrintf && symb==DocSymbol::Sym_Percent)
   {
     return "%%"; // escape for printf
   }
   else
   {
     return g_htmlEntities[symb].UTF8;
   }
 }

引用了 g_htmlEntities, DocSymbol::Sym_Percent , 以及 htmlEntityInfo::UTF8.

◆ validate()

void HtmlEntityMapper::validate ( )

private

Routine to check if the entries of the html_entities are numbered correctly

in case of a mismatch a warning message is given.

在文件 htmlentity.cpp 第 493 行定义.

 {
   for (int i = 0; i < g_numHtmlEntities; i++)
   {
     if (i != g_htmlEntities[i].symb)
     {
       warn_uncond("Internal inconsistency, htmlentries code %d (item=%s)\n",i,g_htmlEntities[i].item);
     }
   }
 }

引用了 g_htmlEntities, g_numHtmlEntities , 以及 warn_uncond().

被这些函数引用 HtmlEntityMapper().

◆ writeXMLSchema()

void HtmlEntityMapper::writeXMLSchema ( TextStream & t )

在文件 htmlentity.cpp 第 477 行定义.

 {
   for (int i=0;i<g_numHtmlEntities - g_numberHtmlMappedCmds;i++)
   {
     QCString bareName = g_htmlEntities[i].xml;
     if (!bareName.isEmpty() && bareName.at(0)=='<' && bareName.right(2)=="/>")
     {
       bareName = bareName.mid(1,bareName.length()-3); // strip < and />
       t << "      <xsd:element name=\"" << bareName << "\" type=\"docEmptyType\" />\n";
     }
   }
 }

引用了 QCString::at(), g_htmlEntities, g_numberHtmlMappedCmds, g_numHtmlEntities, QCString::isEmpty(), QCString::length(), QCString::mid(), QCString::right() , 以及 htmlEntityInfo::xml.

被这些函数引用 generateXML().

◆ xml()

const char * HtmlEntityMapper::xml ( DocSymbol::SymType symb ) const

Access routine to the XML code of the HTML entity

参数

symb	Code of the requested HTML entity

返回: the XML code of the HTML entity, in case the XML code is unknown NULL is returned.

在文件 htmlentity.cpp 第 404 行定义.

 {
   return g_htmlEntities[symb].xml;
 }

引用了 g_htmlEntities , 以及 htmlEntityInfo::xml.

被这些函数引用 XmlDocVisitor::visit().

类成员变量说明

◆ m_name2sym

std::unordered_map<std::string,DocSymbol::SymType> HtmlEntityMapper::m_name2sym

private

在文件 htmlentity.h 第 46 行定义.

被这些函数引用 HtmlEntityMapper() , 以及 name2sym().

◆ s_instance

HtmlEntityMapper * HtmlEntityMapper::s_instance = 0

staticprivate

在文件 htmlentity.h 第 45 行定义.

被这些函数引用 deleteInstance() , 以及 instance().

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

src/htmlentity.h
src/htmlentity.cpp

Public 成员函数

静态 Public 成员函数

Private 成员函数

Private 属性

静态 Private 属性

详细描述

构造及析构函数说明

◆ HtmlEntityMapper()

◆ ~HtmlEntityMapper()

成员函数说明

◆ deleteInstance()

◆ docbook()

◆ html()

◆ instance()

◆ latex()

◆ man()

◆ name2sym()

◆ perl()

◆ rtf()

◆ utf8()

◆ validate()

◆ writeXMLSchema()

◆ xml()

类成员变量说明

◆ m_name2sym

◆ s_instance