Public Member Functions | List of all members
DocSecRefList Class Reference

#include <docparser.h>

Inheritance diagram for DocSecRefList:
CompAccept< DocSecRefList > DocNode

Public Member Functions

 DocSecRefList (DocNode *parent)
 
void parse ()
 
Kind kind () const
 
void accept (DocVisitor *v)
 
- Public Member Functions inherited from CompAccept< DocSecRefList >
 CompAccept ()
 
virtual ~CompAccept ()
 
void accept (DocSecRefList *obj, DocVisitor *v)
 
const QList< DocNode > & children () const
 
QList< DocNode > & children ()
 
- Public Member Functions inherited from DocNode
 DocNode ()
 
virtual ~DocNode ()
 
DocNodeparent () const
 
void setParent (DocNode *parent)
 
bool isPreformatted () const
 

Additional Inherited Members

- Public Types inherited from 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
}
 
- Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
 
- Protected Attributes inherited from CompAccept< DocSecRefList >
QList< DocNodem_children
 
- Protected Attributes inherited from DocNode
DocNodem_parent
 

Detailed Description

Node representing a list of section references

Definition at line 978 of file docparser.h.

Constructor & Destructor Documentation

DocSecRefList::DocSecRefList ( DocNode parent)
inline

Definition at line 981 of file docparser.h.

981 { m_parent = parent; }
DocNode * parent() const
Definition: docparser.h:147
DocNode * m_parent
Definition: docparser.h:163

Member Function Documentation

void DocSecRefList::accept ( DocVisitor v)
inlinevirtual

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

Parameters
vAbstract visitor.

Implements DocNode.

Definition at line 984 of file docparser.h.

void accept(T *obj, DocVisitor *v)
Definition: docparser.h:177
Kind DocSecRefList::kind ( ) const
inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 983 of file docparser.h.

void DocSecRefList::parse ( )

Definition at line 2315 of file docparser.cpp.

2316 {
2317  DBG(("DocSecRefList::parse() start\n"));
2318  g_nodeStack.push(this);
2319 
2320  int tok=doctokenizerYYlex();
2321  // skip white space
2322  while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=doctokenizerYYlex();
2323  // handle items
2324  while (tok)
2325  {
2326  if (tok==TK_COMMAND)
2327  {
2328  switch (Mappers::cmdMapper->map(g_token->name))
2329  {
2330  case CMD_SECREFITEM:
2331  {
2332  int tok=doctokenizerYYlex();
2333  if (tok!=TK_WHITESPACE)
2334  {
2335  warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after \\refitem command");
2336  break;
2337  }
2338  tok=doctokenizerYYlex();
2339  if (tok!=TK_WORD && tok!=TK_LNKWORD)
2340  {
2341  warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of \\refitem",
2342  tokToString(tok));
2343  break;
2344  }
2345 
2346  DocSecRefItem *item = new DocSecRefItem(this,g_token->name);
2347  m_children.append(item);
2348  item->parse();
2349  }
2350  break;
2351  case CMD_ENDSECREFLIST:
2352  goto endsecreflist;
2353  default:
2354  warn_doc_error(g_fileName,doctokenizerYYlineno,"Illegal command %s as part of a \\secreflist",
2355  qPrint(g_token->name));
2356  goto endsecreflist;
2357  }
2358  }
2359  else if (tok==TK_WHITESPACE)
2360  {
2361  // ignore whitespace
2362  }
2363  else
2364  {
2365  warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected token %s inside section reference list",
2366  tokToString(tok));
2367  goto endsecreflist;
2368  }
2369  tok=doctokenizerYYlex();
2370  }
2371 
2372 endsecreflist:
2373  DBG(("DocSecRefList::parse() end\n"));
2374  DocNode *n = g_nodeStack.pop();
2375  ASSERT(n==this);
2376 }
static QCString g_fileName
Definition: docparser.cpp:95
QList< DocNode > m_children
Definition: docparser.h:189
void append(const type *d)
Definition: qlist.h:73
#define DBG(x)
Definition: docparser.cpp:59
int doctokenizerYYlineno
void warn_doc_error(const char *file, int line, const char *fmt,...)
Definition: message.cpp:210
static QStack< DocNode > g_nodeStack
Definition: docparser.cpp:91
TokenInfo * g_token
int doctokenizerYYlex(void)
void push(const type *d)
Definition: qstack.h:58
std::void_t< T > n
type * pop()
Definition: qstack.h:59
static Mapper * cmdMapper
Definition: cmdmapper.h:219
QCString name
Definition: doctokenizer.h:77
const char * tokToString(int token)
const char * qPrint(const char *s)
Definition: qcstring.h:797
#define ASSERT(x)
Definition: qglobal.h:590

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