Doxygen
DocEmoji类 参考

Node representing a n emoji 更多...

#include <docparser.h>

+ 类 DocEmoji 继承关系图:
+ DocEmoji 的协作图:

Public 成员函数

 DocEmoji (DocParser &parser, DocNode *parent, const QCString &symName)
 
QCString name () const
 
int index () const
 
Kind kind () const override
 
void accept (DocVisitor *v) override
 
- Public 成员函数 继承自 DocNode
 DocNode (DocParser &parser)
 
virtual ~DocNode ()
 
DocNodeparent () const
 
void setParent (DocNode *parent)
 
bool isPreformatted () const
 

Private 属性

QCString m_symName
 
int m_index = 0
 

额外继承的成员函数

- Public 类型 继承自 DocNode
enum  Kind {
  Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,
  Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,
  Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,
  Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,
  Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,
  Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,
  Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,
  Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,
  Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,
  Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,
  Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,
  Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,
  Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,
  Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54
}
 
- Protected 类型 继承自 DocNode
enum  RefType { Unknown, Anchor, Section, Table }
 
- Protected 成员函数 继承自 DocNode
void setInsidePreformatted (bool p)
 
- Protected 属性 继承自 DocNode
DocNodem_parent = 0
 
DocParserm_parser
 

详细描述

Node representing a n emoji

在文件 docparser.h469 行定义.

构造及析构函数说明

◆ DocEmoji()

DocEmoji::DocEmoji ( DocParser parser,
DocNode parent,
const QCString symName 
)

在文件 docparser.cpp1721 行定义.

1721  :
1722  DocNode(parser), m_symName(symName), m_index(-1)
1723 {
1724  m_parent = parent;
1725  QCString locSymName = symName;
1726  uint len=locSymName.length();
1727  if (len>0)
1728  {
1729  if (locSymName.at(len-1)!=':') locSymName.append(":");
1730  if (locSymName.at(0)!=':') locSymName.prepend(":");
1731  }
1732  m_symName = locSymName;
1734  if (m_index==-1)
1735  {
1736  warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"Found unsupported emoji symbol '%s'\n",qPrint(m_symName));
1737  }
1738 }

引用了 QCString::append(), QCString::at(), DocParser::context, DocParserContext::fileName, DocTokenizer::getLineNr(), EmojiEntityMapper::instance(), QCString::length(), m_index, DocNode::m_parent, m_symName, DocNode::parent(), QCString::prepend(), qPrint(), QCString::str(), EmojiEntityMapper::symbol2index(), DocParser::tokenizer , 以及 warn_doc_error().

成员函数说明

◆ accept()

void DocEmoji::accept ( DocVisitor v)
inlineoverridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数
vAbstract visitor.

实现了 DocNode.

在文件 docparser.h476 行定义.

476 { v->visit(this); }

引用了 DocVisitor::visit().

◆ index()

◆ kind()

Kind DocEmoji::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h475 行定义.

475 { return Kind_Emoji; }

引用了 DocNode::Kind_Emoji.

◆ name()

类成员变量说明

◆ m_index

int DocEmoji::m_index = 0
private

在文件 docparser.h480 行定义.

被这些函数引用 DocEmoji() , 以及 index().

◆ m_symName

QCString DocEmoji::m_symName
private

在文件 docparser.h479 行定义.

被这些函数引用 DocEmoji() , 以及 name().


该类的文档由以下文件生成:
DocParser::context
DocParserContext context
Definition: docparser.cpp:175
DocVisitor::visit
virtual void visit(DocWord *)=0
QCString::length
uint length() const
Returns the length of the string, not counting the 0-terminator.
Definition: qcstring.h:147
DocNode::Kind_Emoji
@ Kind_Emoji
Definition: docparser.h:153
DocParser::tokenizer
DocTokenizer tokenizer
Definition: docparser.cpp:176
QCString::str
std::string str() const
Definition: qcstring.h:442
warn_doc_error
void warn_doc_error(const QCString &file, int line, const char *fmt,...)
Definition: message.cpp:186
QCString::at
char & at(size_t i)
Returns a reference to the character at index i.
Definition: qcstring.h:477
DocEmoji::m_symName
QCString m_symName
Definition: docparser.h:479
DocEmoji::m_index
int m_index
Definition: docparser.h:480
uint
unsigned uint
Definition: qcstring.h:40
DocParserContext::fileName
QCString fileName
Definition: docparser.cpp:110
EmojiEntityMapper::symbol2index
int symbol2index(const std::string &symName) const
Returns a code for the requested Emoji entity name
Definition: emoji.cpp:1558
DocTokenizer::getLineNr
int getLineNr(void)
QCString::append
QCString & append(char c)
Definition: qcstring.h:318
qPrint
const char * qPrint(const char *s)
Definition: qcstring.h:589
EmojiEntityMapper::instance
static EmojiEntityMapper * instance()
Returns the one and only instance of the Emoji entity mapper
Definition: emoji.cpp:1536
DocNode::DocNode
DocNode(DocParser &parser)
Definition: docparser.h:157
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
QCString::prepend
QCString & prepend(const char *s)
Definition: qcstring.h:339
DocNode::m_parent
DocNode * m_parent
Definition: docparser.h:182
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108