DocSimpleSect Class Reference

Node representing a simple section. More...

#include <src/docnode.h>

Inheritance diagram for DocSimpleSect:

Collaboration diagram for DocSimpleSect:

Public Types
enum	Type {   Unknown , See , Return , Author ,   Authors , Version , Since , Date ,   Note , Warning , Copyright , Pre ,   Post , Invar , Remark , Attention ,   Important , User , Rcs }

Public Member Functions
	DocSimpleSect (DocParser *parser, DocNodeVariant *parent, Type t)
Type	type () const
QCString	typeString () const
Token	parse (bool userTitle, bool needsSeparator)
Token	parseRcs ()
Token	parseXml ()
void	appendLinkWord (const QCString &word)
bool	hasTitle () const
const DocNodeVariant *	title () const
Public Member Functions inherited from DocCompoundNode
	DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList &	children ()
const DocNodeList &	children () const
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

Private Attributes
Type	m_type = Unknown
std::unique_ptr< DocNodeVariant >	m_title

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 simple section.

Definition at line 996 of file docnode.h.

Member Enumeration Documentation

Type

enum DocSimpleSect::Type

Enumerator
Unknown
See
Return
Author
Authors
Version
Since
Date
Note
Warning
Copyright
Pre
Post
Invar
Remark
Attention
Important
User
Rcs

Definition at line 999 of file docnode.h.

    {
       Unknown, See, Return, Author, Authors, Version, Since, Date,
       Note, Warning, Copyright, Pre, Post, Invar, Remark, Attention, Important,
       User, Rcs
    };

Constructor & Destructor Documentation

DocSimpleSect()

DocSimpleSect::DocSimpleSect	(	DocParser *	parser,
		DocNodeVariant *	parent,
		Type	t )

Definition at line 2886 of file docnode.cpp.

                                                                            :
     DocCompoundNode(parser,parent), m_type(t)
{
}

References DocCompoundNode::DocCompoundNode(), m_type, DocNode::parent(), and DocNode::parser().

Member Function Documentation

appendLinkWord()

void DocSimpleSect::appendLinkWord

(

const QCString &

word

)

Definition at line 2986 of file docnode.cpp.

{
  DocPara *p=nullptr;
  if (children().empty() || (p=std::get_if<DocPara>(&children().back()))==nullptr)
  {
    children().append<DocPara>(parser(),thisVariant());
    p = children().get_last<DocPara>();
  }
  else
  {
    // Comma-separate <seealso> links.
    p->injectToken(Token::make_TK_WORD(),",");
    p->injectToken(Token::make_TK_WHITESPACE()," ");
  }
 
  parser()->context.inSeeBlock=TRUE;
  p->injectToken(Token::make_TK_LNKWORD(),word);
  parser()->context.inSeeBlock=FALSE;
}

References DocNodeList::append(), DocCompoundNode::children(), DocParser::context, FALSE, DocNodeList::get_last(), DocPara::injectToken(), DocParserContext::inSeeBlock, DocNode::parser(), DocNode::thisVariant(), TRUE, and word.

hasTitle()

bool DocSimpleSect::hasTitle

(

)

const

Definition at line 2891 of file docnode.cpp.

{
  return m_title && std::get<DocTitle>(*m_title).hasTitle();
}

References m_title.

Referenced by DocbookDocVisitor::operator()().

parse()

Token DocSimpleSect::parse	(	bool	userTitle,
		bool	needsSeparator )

Definition at line 2896 of file docnode.cpp.

{
  AUTO_TRACE();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  // handle case for user defined title
  if (userTitle)
  {
    m_title = createDocNode<DocTitle>(parser(),thisVariant());
    std::get_if<DocTitle>(m_title.get())->parse();
  }
 
  // add new paragraph as child
  if (!children().empty() && std::holds_alternative<DocPara>(children().back()))
  {
    std::get<DocPara>(children().back()).markLast(FALSE);
  }
  bool markFirst = children().empty();
  if (needsSeparator)
  {
    children().append<DocSimpleSectSep>(parser(),thisVariant());
  }
  children().append<DocPara>(parser(),thisVariant());
  DocPara *par  = children().get_last<DocPara>();
  if (markFirst)
  {
    par->markFirst();
  }
  par->markLast();
 
  // parse the contents of the paragraph
  Token retval = par->parse();
 
  AUTO_TRACE_EXIT("retval={}",retval.to_string());
  return retval; // 0==EOF, TokenRetval::TK_NEWPARA, TokenRetval::TK_LISTITEM, TokenRetval::TK_ENDLIST, TokenRetval::RetVal_SimpleSec
}

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), createDocNode(), GrowVector< T >::empty(), FALSE, DocNodeList::get_last(), m_title, DocNode::parser(), DocNode::thisVariant(), and Token::to_string().

Referenced by DocPara::handleSimpleSection().

parseRcs()

Token DocSimpleSect::parseRcs

(

)

Definition at line 2933 of file docnode.cpp.

{
  AUTO_TRACE();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  m_title = createDocNode<DocTitle>(parser(),thisVariant());
  DocTitle *title = &std::get<DocTitle>(*m_title);
  title->parseFromString(thisVariant(),parser()->context.token->name);
 
  QCString text = parser()->context.token->text;
  parser()->pushContext(); // this will create a new parser->context.token
  parser()->internalValidatingParseDoc(thisVariant(),children(),text);
  parser()->popContext(); // this will restore the old parser->context.token
 
  return Token::make_RetVal_OK();
}

References AUTO_TRACE, DocCompoundNode::children(), DocParser::context, createDocNode(), DocParser::internalValidatingParseDoc(), m_title, DocNode::parser(), DocParser::popContext(), DocParser::pushContext(), TokenInfo::text, DocNode::thisVariant(), title(), and DocParserContext::token.

parseXml()

Token DocSimpleSect::parseXml

(

)

Definition at line 2950 of file docnode.cpp.

{
  AUTO_TRACE();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  Token retval = Token::make_RetVal_OK();
  for (;;)
  {
    // add new paragraph as child
    if (!children().empty() && std::holds_alternative<DocPara>(children().back()))
    {
      std::get<DocPara>(children().back()).markLast(false);
    }
    bool markFirst = children().empty();
    children().append<DocPara>(parser(),thisVariant());
    DocPara *par  = children().get_last<DocPara>();
    if (markFirst)
    {
      par->markFirst();
    }
    par->markLast();
 
    // parse the contents of the paragraph
    retval = par->parse();
    if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
    if (retval.is(TokenRetval::RetVal_CloseXml))
    {
      retval = Token::make_RetVal_OK();
      break;
    }
  }
 
  AUTO_TRACE_EXIT("retval={}",retval.to_string());
  return retval;
}

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), GrowVector< T >::empty(), DocNodeList::get_last(), Token::is(), Token::is_any_of(), DocNode::parser(), DocNode::thisVariant(), and Token::to_string().

Referenced by DocPara::handleSimpleSection().

title()

const DocNodeVariant * DocSimpleSect::title ( ) const

inline

Definition at line 1013 of file docnode.h.

{ return m_title.get(); }

References m_title.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), and parseRcs().

type()

Type DocSimpleSect::type ( ) const

inline

Definition at line 1006 of file docnode.h.

{ return m_type; }

References m_type.

Referenced by DocPara::handleHtmlStartTag(), DocPara::handleSimpleSection(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and startSimpleSect().

typeString()

QCString DocSimpleSect::typeString

(

)

const

Definition at line 3006 of file docnode.cpp.

{
  switch (m_type)
  {
    case Unknown:    break;
    case See:        return "see";
    case Return:     return "return";
    case Author:     // fall through
    case Authors:    return "author";
    case Version:    return "version";
    case Since:      return "since";
    case Date:       return "date";
    case Note:       return "note";
    case Warning:    return "warning";
    case Pre:        return "pre";
    case Post:       return "post";
    case Copyright:  return "copyright";
    case Invar:      return "invariant";
    case Remark:     return "remark";
    case Attention:  return "attention";
    case Important:  return "important";
    case User:       return "user";
    case Rcs:        return "rcs";
  }
  return "unknown";
}

References Attention, Author, Authors, Copyright, Date, Important, Invar, m_type, Note, Post, Pre, Rcs, Remark, Return, See, Since, Unknown, User, Version, and Warning.

Referenced by HtmlDocVisitor::operator()().

Member Data Documentation

m_title

std::unique_ptr<DocNodeVariant> DocSimpleSect::m_title

private

Definition at line 1017 of file docnode.h.

Referenced by hasTitle(), parse(), parseRcs(), and title().

m_type

Type DocSimpleSect::m_type = Unknown

private

Definition at line 1016 of file docnode.h.

Referenced by DocSimpleSect(), type(), and typeString().

---

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

• src/docnode.h
• src/docnode.cpp