DocHtmlCaption Class Reference

#include <docparser.h>

Inheritance diagram for DocHtmlCaption:

Public Member Functions
	DocHtmlCaption (DocNode *parent, const HtmlAttribList &attribs)
Kind	kind () const
void	accept (DocVisitor *v)
const HtmlAttribList &	attribs () const
int	parse ()
bool	hasCaptionId () const
QCString	file () const
QCString	anchor () const
Public Member Functions inherited from CompAccept< DocHtmlCaption >
	CompAccept ()
virtual	~CompAccept ()
void	accept (DocHtmlCaption *obj, DocVisitor *v)
const QList< DocNode > &	children () const
QList< DocNode > &	children ()
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
HtmlAttribList	m_attribs
bool	m_hasCaptionId
QCString	m_file
QCString	m_anchor

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< DocHtmlCaption >
QList< DocNode >	m_children
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a HTML table caption

Definition at line 1288 of file docparser.h.

Constructor & Destructor Documentation

DocHtmlCaption::DocHtmlCaption	(	DocNode *	parent,
		const HtmlAttribList &	attribs
	)

Definition at line 3267 of file docparser.cpp.

{
  m_hasCaptionId = FALSE;
  HtmlAttribListIterator li(attribs);
  HtmlAttrib *opt;
  for (li.toFirst();(opt=li.current());++li)
  {
    if (opt->name=="id") // interpret id attribute as an anchor
    {
      SectionInfo *sec = Doxygen::sectionDict->find(opt->value);
      if (sec)
      {
        //printf("Found anchor %s\n",id.data());
        m_file   = sec->fileName;
        m_anchor = sec->label;
        m_hasCaptionId = TRUE;
        if (g_sectionDict && g_sectionDict->find(opt->value)==0)
        {
          //printf("Inserting in dictionary!\n");
          g_sectionDict->append(opt->value,sec);
        }
      }
      else
      {
        warn_doc_error(g_fileName,doctokenizerYYlineno,"Invalid caption id `%s'",qPrint(opt->value));
      }
    }
    else // copy attribute
    {
      m_attribs.append(new HtmlAttrib(*opt));
    }
  }
  m_parent = parent;
}

Member Function Documentation

void DocHtmlCaption::accept ( DocVisitor *  v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 1293 of file docparser.h.

{ CompAccept<DocHtmlCaption>::accept(this,v); }

QCString DocHtmlCaption::anchor ( ) const

inline

Definition at line 1298 of file docparser.h.

{ return m_anchor;       }

const HtmlAttribList& DocHtmlCaption::attribs ( ) const

inline

Definition at line 1294 of file docparser.h.

{ return m_attribs; }

QCString DocHtmlCaption::file ( ) const

inline

Definition at line 1297 of file docparser.h.

{ return m_file;         }

bool DocHtmlCaption::hasCaptionId ( ) const

inline

Definition at line 1296 of file docparser.h.

{ return m_hasCaptionId; }

Kind DocHtmlCaption::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 1292 of file docparser.h.

{ return Kind_HtmlCaption; }

int DocHtmlCaption::parse

(

)

Definition at line 3302 of file docparser.cpp.

{
  int retval=0;
  g_nodeStack.push(this);
  DBG(("DocHtmlCaption::parse() start\n"));
  int tok;
  while ((tok=doctokenizerYYlex()))
  {
    if (!defaultHandleToken(this,tok,m_children))
    {
      switch (tok)
      {
        case TK_COMMAND: 
          warn_doc_error(g_fileName,doctokenizerYYlineno,"Illegal command %s as part of a <caption> tag",
              qPrint(g_token->name));
          break;
        case TK_SYMBOL: 
          warn_doc_error(g_fileName,doctokenizerYYlineno,"Unsupported symbol %s found",
              qPrint(g_token->name));
          break;
        case TK_HTMLTAG:
          {
            int tagId=Mappers::htmlTagMapper->map(g_token->name);
            if (tagId==HTML_CAPTION && g_token->endTag) // found </caption> tag
            {
              retval = RetVal_OK;
              goto endcaption;
            }
            else
            {
              warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected html tag <%s%s> found within <caption> context",
                  g_token->endTag?"/":"",qPrint(g_token->name));
            }
          }
          break;
        default:
          warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected token %s",
              tokToString(tok));
          break;
      }
    }
  }
  if (tok==0)
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected end of comment while inside"
           " <caption> tag",doctokenizerYYlineno); 
  }
endcaption:
  handlePendingStyleCommands(this,m_children);
  DBG(("DocHtmlCaption::parse() end\n"));
  DocNode *n=g_nodeStack.pop();
  ASSERT(n==this);
  return retval;
}

Member Data Documentation

QCString DocHtmlCaption::m_anchor

private

Definition at line 1304 of file docparser.h.

HtmlAttribList DocHtmlCaption::m_attribs

private

Definition at line 1301 of file docparser.h.

QCString DocHtmlCaption::m_file

private

Definition at line 1303 of file docparser.h.

bool DocHtmlCaption::m_hasCaptionId

private

Definition at line 1302 of file docparser.h.

---

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

• doxygen-1.8.11/src/docparser.h
• doxygen-1.8.11/src/docparser.cpp