Doxygen
Loading...
Searching...
No Matches
DocHtmlDescTitle Class Reference

Node representing a Html description item. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlDescTitle:
Collaboration diagram for DocHtmlDescTitle:

Public Member Functions

 DocHtmlDescTitle (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs)
const HtmlAttribListattribs () const
Token parse ()
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Private Attributes

HtmlAttribList m_attribs

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node representing a Html description item.

Definition at line 887 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlDescTitle()

DocHtmlDescTitle::DocHtmlDescTitle ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs )
inline

Definition at line 890 of file docnode.h.

890 :
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
HtmlAttribList m_attribs
Definition docnode.h:896
const HtmlAttribList & attribs() const
Definition docnode.h:892
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References attribs(), DocCompoundNode::DocCompoundNode(), m_attribs, DocNode::parent(), and DocNode::parser().

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocHtmlDescTitle::attribs ( ) const
inline

Definition at line 892 of file docnode.h.

892{ return m_attribs; }

References m_attribs.

Referenced by DocHtmlDescTitle(), and HtmlDocVisitor::operator()().

◆ parse()

Token DocHtmlDescTitle::parse ( )

Definition at line 2394 of file docnode.cpp.

2395{
2396 AUTO_TRACE();
2397 Token retval = Token::make_TK_NONE();
2398 auto ns = AutoNodeStack(parser(),thisVariant());
2399
2400 Token tok = parser()->tokenizer.lex();
2401 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
2402 {
2403 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
2404 {
2405 switch (tok.value())
2406 {
2407 case TokenRetval::TK_COMMAND_AT:
2408 // fall through
2409 case TokenRetval::TK_COMMAND_BS:
2410 {
2411 QCString cmdName=parser()->context.token->name;
2412 bool isJavaLink=FALSE;
2413 switch (Mappers::cmdMapper->map(cmdName))
2414 {
2416 {
2417 tok=parser()->tokenizer.lex();
2418 if (!tok.is(TokenRetval::TK_WHITESPACE))
2419 {
2420 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after '{:c}{}' command",
2421 tok.command_to_char(),cmdName);
2422 }
2423 else
2424 {
2426 tok=parser()->tokenizer.lex(); // get the reference id
2427 if (!tok.is(TokenRetval::TK_WORD))
2428 {
2429 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} as the argument of '{:c}{}' command",
2430 tok.to_string(),tok.command_to_char(),cmdName);
2431 }
2432 else
2433 {
2435 children().get_last<DocRef>()->parse();
2436 }
2438 }
2439 }
2440 break;
2442 isJavaLink=TRUE;
2443 // fall through
2445 {
2446 tok=parser()->tokenizer.lex();
2447 if (!tok.is(TokenRetval::TK_WHITESPACE))
2448 {
2449 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after \\{} command",
2450 cmdName);
2451 }
2452 else
2453 {
2455 tok=parser()->tokenizer.lex();
2456 if (!tok.is(TokenRetval::TK_WORD))
2457 {
2458 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} as the argument of \\{} command",
2459 tok.to_string(),cmdName);
2460 }
2461 else
2462 {
2465 DocLink *lnk = children().get_last<DocLink>();
2466 QCString leftOver = lnk->parse(isJavaLink);
2467 if (!leftOver.isEmpty())
2468 {
2469 children().append<DocWord>(parser(),thisVariant(),leftOver);
2470 }
2471 }
2472 }
2473 }
2474
2475 break;
2476 default:
2477 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Illegal command '{:c}{}' found as part of a <dt> tag",
2478 tok.command_to_char(),cmdName);
2479 }
2480 }
2481 break;
2482 case TokenRetval::TK_SYMBOL:
2483 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found as part of a <dt> tag",
2484 parser()->context.token->name);
2485 break;
2486 case TokenRetval::TK_HTMLTAG:
2487 {
2488 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2489 if (tagId==HtmlTagType::HTML_DD && !parser()->context.token->endTag) // found <dd> tag
2490 {
2491 retval = Token::make_RetVal_DescData();
2492 goto endtitle;
2493 }
2494 else if (tagId==HtmlTagType::HTML_DT && parser()->context.token->endTag)
2495 {
2496 // ignore </dt> tag.
2497 }
2498 else if (tagId==HtmlTagType::HTML_DT)
2499 {
2500 // missing <dt> tag.
2501 retval = Token::make_RetVal_DescTitle();
2502 goto endtitle;
2503 }
2504 else if (tagId==HtmlTagType::HTML_DL && parser()->context.token->endTag)
2505 {
2506 retval = Token::make_RetVal_EndDesc();
2507 goto endtitle;
2508 }
2509 else if (tagId==HtmlTagType::HTML_A)
2510 {
2511 if (!parser()->context.token->endTag)
2512 {
2513 parser()->handleAHref(thisVariant(),children(),parser()->context.token->attribs);
2514 }
2515 }
2516 else
2517 {
2518 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected html tag <{}{}> found within <dt> context",
2519 parser()->context.token->endTag?"/":"",parser()->context.token->name);
2520 }
2521 }
2522 break;
2523 default:
2524 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {} found as part of a <dt> tag",
2525 tok.to_string());
2526 break;
2527 }
2528 }
2529 tok = parser()->tokenizer.lex();
2530 }
2531 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2532 {
2533 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
2534 " <dt> tag");
2535 }
2536endtitle:
2538 return retval;
2539}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
Token handleAHref(DocNodeVariant *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)
void handlePendingStyleCommands(DocNodeVariant *parent, DocNodeList &children)
DocParserContext context
void setStateLink()
void setStatePara()
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
TokenRetval value() const
bool is_any_of(ARGS... args) const
char command_to_char() const
HtmlTagType
Definition cmdmapper.h:169
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< HtmlTagType > * htmlTagMapper
const Mapper< CommandType > * cmdMapper
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1399
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1410
TokenInfo * token
Definition docparser_p.h:93
QCString name

References DocNodeList::append(), AUTO_TRACE, DocCompoundNode::children(), CMD_JAVALINK, CMD_LINK, CMD_REF, Mappers::cmdMapper, Token::command_to_char(), DocParser::context, DocParserContext::context, FALSE, DocNodeList::get_last(), DocParser::handleAHref(), DocParser::handlePendingStyleCommands(), HTML_A, HTML_DD, HTML_DL, HTML_DT, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), DocTokenizer::lex(), TokenInfo::name, parse(), DocNode::parser(), DocTokenizer::setStateLink(), DocTokenizer::setStatePara(), DocTokenizer::setStateRef(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, TRUE, Token::value(), and warn_doc_error.

Referenced by parse().

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlDescTitle::m_attribs
private

Definition at line 896 of file docnode.h.

Referenced by attribs(), and DocHtmlDescTitle().


The documentation for this class was generated from the following files: