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 2399 of file docnode.cpp.

2400{
2401 AUTO_TRACE();
2402 Token retval = Token::make_TK_NONE();
2403 auto ns = AutoNodeStack(parser(),thisVariant());
2404
2405 Token tok = parser()->tokenizer.lex();
2406 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
2407 {
2408 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
2409 {
2410 switch (tok.value())
2411 {
2412 case TokenRetval::TK_COMMAND_AT:
2413 // fall through
2414 case TokenRetval::TK_COMMAND_BS:
2415 {
2416 QCString cmdName=parser()->context.token->name;
2417 bool isJavaLink=FALSE;
2418 switch (Mappers::cmdMapper->map(cmdName))
2419 {
2421 {
2422 tok=parser()->tokenizer.lex();
2423 if (!tok.is(TokenRetval::TK_WHITESPACE))
2424 {
2425 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after '{:c}{}' command",
2426 tok.command_to_char(),cmdName);
2427 }
2428 else
2429 {
2431 tok=parser()->tokenizer.lex(); // get the reference id
2432 if (!tok.is(TokenRetval::TK_WORD))
2433 {
2434 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} as the argument of '{:c}{}' command",
2435 tok.to_string(),tok.command_to_char(),cmdName);
2436 }
2437 else
2438 {
2440 children().get_last<DocRef>()->parse();
2441 }
2443 }
2444 }
2445 break;
2447 isJavaLink=TRUE;
2448 // fall through
2450 {
2451 tok=parser()->tokenizer.lex();
2452 if (!tok.is(TokenRetval::TK_WHITESPACE))
2453 {
2454 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after \\{} command",
2455 cmdName);
2456 }
2457 else
2458 {
2460 tok=parser()->tokenizer.lex();
2461 if (!tok.is(TokenRetval::TK_WORD))
2462 {
2463 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} as the argument of \\{} command",
2464 tok.to_string(),cmdName);
2465 }
2466 else
2467 {
2470 DocLink *lnk = children().get_last<DocLink>();
2471 QCString leftOver = lnk->parse(isJavaLink);
2472 if (!leftOver.isEmpty())
2473 {
2474 children().append<DocWord>(parser(),thisVariant(),leftOver);
2475 }
2476 }
2477 }
2478 }
2479
2480 break;
2481 default:
2482 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Illegal command '{:c}{}' found as part of a <dt> tag",
2483 tok.command_to_char(),cmdName);
2484 }
2485 }
2486 break;
2487 case TokenRetval::TK_SYMBOL:
2488 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found as part of a <dt> tag",
2489 parser()->context.token->name);
2490 break;
2491 case TokenRetval::TK_HTMLTAG:
2492 {
2493 HtmlTagType tagId=Mappers::htmlTagMapper->map(parser()->context.token->name);
2494 if (tagId==HtmlTagType::HTML_DD && !parser()->context.token->endTag) // found <dd> tag
2495 {
2496 retval = Token::make_RetVal_DescData();
2497 goto endtitle;
2498 }
2499 else if (tagId==HtmlTagType::HTML_DT && parser()->context.token->endTag)
2500 {
2501 // ignore </dt> tag.
2502 }
2503 else if (tagId==HtmlTagType::HTML_DT)
2504 {
2505 // missing <dt> tag.
2506 retval = Token::make_RetVal_DescTitle();
2507 goto endtitle;
2508 }
2509 else if (tagId==HtmlTagType::HTML_DL && parser()->context.token->endTag)
2510 {
2511 retval = Token::make_RetVal_EndDesc();
2512 goto endtitle;
2513 }
2514 else if (tagId==HtmlTagType::HTML_A)
2515 {
2516 if (!parser()->context.token->endTag)
2517 {
2518 parser()->handleAHref(thisVariant(),children(),parser()->context.token->attribs);
2519 }
2520 }
2521 else
2522 {
2523 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected html tag <{}{}> found within <dt> context",
2524 parser()->context.token->endTag?"/":"",parser()->context.token->name);
2525 }
2526 }
2527 break;
2528 default:
2529 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {} found as part of a <dt> tag",
2530 tok.to_string());
2531 break;
2532 }
2533 }
2534 tok = parser()->tokenizer.lex();
2535 }
2536 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF))
2537 {
2538 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected end of comment while inside"
2539 " <dt> tag");
2540 }
2541endtitle:
2543 return retval;
2544}
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: