Public Member Functions | List of all members
DocVhdlFlow Class Reference

#include <docparser.h>

Inheritance diagram for DocVhdlFlow:
CompAccept< DocVhdlFlow > DocNode

Public Member Functions

 DocVhdlFlow (DocNode *parent)
 
void parse ()
 
Kind kind () const
 
bool hasCaption ()
 
void accept (DocVisitor *v)
 
- Public Member Functions inherited from CompAccept< DocVhdlFlow >
 CompAccept ()
 
virtual ~CompAccept ()
 
void accept (DocVhdlFlow *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< DocVhdlFlow >
QList< DocNodem_children
 
- Protected Attributes inherited from DocNode
DocNodem_parent
 

Detailed Description

Node representing a VHDL flow chart

Definition at line 788 of file docparser.h.

Constructor & Destructor Documentation

DocVhdlFlow::DocVhdlFlow ( DocNode parent)

Definition at line 2871 of file docparser.cpp.

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

Member Function Documentation

void DocVhdlFlow::accept ( DocVisitor v)
inlinevirtual

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

Parameters
vAbstract visitor.

Implements DocNode.

Definition at line 795 of file docparser.h.

void accept(T *obj, DocVisitor *v)
Definition: docparser.h:177
bool DocVhdlFlow::hasCaption ( )
inline

Definition at line 794 of file docparser.h.

794 { return !m_children.isEmpty(); }
QList< DocNode > m_children
Definition: docparser.h:189
bool isEmpty() const
Definition: qlist.h:67
Kind DocVhdlFlow::kind ( ) const
inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 793 of file docparser.h.

void DocVhdlFlow::parse ( )

Definition at line 2876 of file docparser.cpp.

2877 {
2878  g_nodeStack.push(this);
2879  DBG(("DocVhdlFlow::parse() start\n"));
2880 
2882  int tok;
2883  while ((tok=doctokenizerYYlex()))
2884  {
2885  if (!defaultHandleToken(this,tok,m_children))
2886  {
2887  switch (tok)
2888  {
2889  case TK_COMMAND:
2890  warn_doc_error(g_fileName,doctokenizerYYlineno,"Illegal command %s as part of a \\vhdlflow",
2891  qPrint(g_token->name));
2892  break;
2893  case TK_SYMBOL:
2894  warn_doc_error(g_fileName,doctokenizerYYlineno,"Unsupported symbol %s found",
2895  qPrint(g_token->name));
2896  break;
2897  default:
2898  warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected token %s",
2899  tokToString(tok));
2900  break;
2901  }
2902  }
2903  }
2904  tok=doctokenizerYYlex();
2905 
2908 
2909  DBG(("DocVhdlFlow::parse() end\n"));
2910  DocNode *n=g_nodeStack.pop();
2911  ASSERT(n==this);
2913 }
static QCString g_fileName
Definition: docparser.cpp:95
QList< DocNode > m_children
Definition: docparser.h:189
void doctokenizerYYsetStatePara()
#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
void doctokenizerYYsetStateTitle()
static MemberDef * g_memberDef
Definition: docparser.cpp:101
static void handlePendingStyleCommands(DocNode *parent, QList< DocNode > &children)
Definition: docparser.cpp:957
std::void_t< T > n
type * pop()
Definition: qstack.h:59
static bool defaultHandleToken(DocNode *parent, int tok, QList< DocNode > &children, bool handleWord=TRUE)
Definition: docparser.cpp:1331
QCString name
Definition: doctokenizer.h:77
const char * tokToString(int token)
static void createFlowChart(const MemberDef *)
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: