#include <docparser.h>

Inheritance diagram for DocPara:

Public Member Functions
	DocPara (DocNode *parent)

int	parse ()

Kind	kind () const

bool	isEmpty () const

void	accept (DocVisitor *v)

void	markFirst (bool v=TRUE)

void	markLast (bool v=TRUE)

bool	isFirst () const

bool	isLast () const

int	handleCommand (const QCString &cmdName)

int	handleHtmlStartTag (const QCString &tagName, const HtmlAttribList &tagHtmlAttribs)

int	handleHtmlEndTag (const QCString &tagName)

int	handleSimpleSection (DocSimpleSect::Type t, bool xmlContext=FALSE)

int	handleXRefItem ()

int	handleParamSection (const QCString &cmdName, DocParamSect::Type t, bool xmlContext, int direction)

void	handleIncludeOperator (const QCString &cmdName, DocIncOperator::Type t)

void	handleImage (const QCString &cmdName)

template<class T >
void	handleFile (const QCString &cmdName)

void	handleInclude (const QCString &cmdName, DocInclude::Type t)

void	handleLink (const QCString &cmdName, bool isJavaLink)

void	handleCite ()

void	handleRef (const QCString &cmdName)

void	handleSection (const QCString &cmdName)

void	handleInheritDoc ()

void	handleVhdlFlow ()

int	handleStartCode ()

int	handleHtmlHeader (const HtmlAttribList &tagHtmlAttribs, int level)

bool	injectToken (int tok, const QCString &tokText)

Public Member Functions inherited from CompAccept< DocPara >
	CompAccept ()

virtual	~CompAccept ()

void	accept (DocPara 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
QCString	m_sectionId

bool	m_isFirst

bool	m_isLast

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< DocPara >
QList< DocNode >	m_children

Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a paragraph in the documentation tree

Definition at line 1113 of file docparser.h.

Constructor & Destructor Documentation

DocPara::DocPara ( DocNode * parent )

inline

Definition at line 1116 of file docparser.h.

1116 :

1117 m_isFirst(FALSE), m_isLast(FALSE) { m_parent = parent; }

DocNode::parent

DocNode * parent() const

Definition: docparser.h:147

DocPara::m_isFirst

bool m_isFirst

Definition: docparser.h:1152

FALSE

const bool FALSE

Definition: qglobal.h:370

DocNode::m_parent

DocNode * m_parent

Definition: docparser.h:163

DocPara::m_isLast

bool m_isLast

Definition: docparser.h:1153

Member Function Documentation

void DocPara::accept ( DocVisitor * v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 1121 of file docparser.h.

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

CompAccept::accept

void accept(T *obj, DocVisitor *v)

Definition: docparser.h:177

void DocPara::handleCite ( )

Definition at line 4892 of file docparser.cpp.

 {
   // get the argument of the cite command.
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint("cite"));
     return;
   }
   doctokenizerYYsetStateCite();
   tok=doctokenizerYYlex();
   if (tok==0)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected end of comment block while parsing the "
         "argument of command %s\n", qPrint("cite"));
     return;
   }
   else if (tok!=TK_WORD && tok!=TK_LNKWORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint("cite"));
     return;
   }
   g_token->sectionId = g_token->name;
   DocCite *cite = new DocCite(this,g_token->name,g_context);
   m_children.append(cite);
   //cite->parse();
 
   doctokenizerYYsetStatePara();
 }

int DocPara::handleCommand ( const QCString & cmdName )

Definition at line 5282 of file docparser.cpp.

 {
   DBG(("handleCommand(%s)\n",qPrint(cmdName)));
   int retval = RetVal_OK;
   int cmdId = Mappers::cmdMapper->map(cmdName);
   switch (cmdId)
   {
     case CMD_UNKNOWN:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Found unknown command `\\%s'",qPrint(cmdName));
       break;
     case CMD_EMPHASIS:
       m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Italic,TRUE));
       retval=handleStyleArgument(this,m_children,cmdName); 
       m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Italic,FALSE));
       if (retval!=TK_WORD) m_children.append(new DocWhiteSpace(this," "));
       break;
     case CMD_BOLD:
       m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Bold,TRUE));
       retval=handleStyleArgument(this,m_children,cmdName); 
       m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Bold,FALSE));
       if (retval!=TK_WORD) m_children.append(new DocWhiteSpace(this," "));
       break;
     case CMD_CODE:
       m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Code,TRUE));
       retval=handleStyleArgument(this,m_children,cmdName); 
       m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Code,FALSE));
       if (retval!=TK_WORD) m_children.append(new DocWhiteSpace(this," "));
       break;
     case CMD_BSLASH:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_BSlash));
       break;
     case CMD_AT:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_At));
       break;
     case CMD_LESS:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Less));
       break;
     case CMD_GREATER:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Greater));
       break;
     case CMD_AMP:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Amp));
       break;
     case CMD_DOLLAR:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Dollar));
       break;
     case CMD_HASH:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Hash));
       break;
     case CMD_PIPE:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Pipe));
       break;
     case CMD_DCOLON:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_DoubleColon));
       break;
     case CMD_PERCENT:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Percent));
       break;
     case CMD_NDASH:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Minus));
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Minus));
       break;
     case CMD_MDASH:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Minus));
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Minus));
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Minus));
       break;
     case CMD_QUOTE:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Quot));
       break;
     case CMD_PUNT:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Dot));
       break;
     case CMD_PLUS:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Plus));
       break;
     case CMD_MINUS:
       m_children.append(new DocSymbol(this,DocSymbol::Sym_Minus));
       break;
     case CMD_SA:
       g_inSeeBlock=TRUE;
       retval = handleSimpleSection(DocSimpleSect::See);
       g_inSeeBlock=FALSE;
       break;
     case CMD_RETURN:
       retval = handleSimpleSection(DocSimpleSect::Return);
       g_hasReturnCommand=TRUE;
       break;
     case CMD_AUTHOR:
       retval = handleSimpleSection(DocSimpleSect::Author);
       break;
     case CMD_AUTHORS:
       retval = handleSimpleSection(DocSimpleSect::Authors);
       break;
     case CMD_VERSION:
       retval = handleSimpleSection(DocSimpleSect::Version);
       break;
     case CMD_SINCE:
       retval = handleSimpleSection(DocSimpleSect::Since);
       break;
     case CMD_DATE:
       retval = handleSimpleSection(DocSimpleSect::Date);
       break;
     case CMD_NOTE:
       retval = handleSimpleSection(DocSimpleSect::Note);
       break;
     case CMD_WARNING:
       retval = handleSimpleSection(DocSimpleSect::Warning);
       break;
     case CMD_PRE:
       retval = handleSimpleSection(DocSimpleSect::Pre);
       break;
     case CMD_POST:
       retval = handleSimpleSection(DocSimpleSect::Post);
       break;
     case CMD_COPYRIGHT:
       retval = handleSimpleSection(DocSimpleSect::Copyright);
       break;
     case CMD_INVARIANT:
       retval = handleSimpleSection(DocSimpleSect::Invar);
       break;
     case CMD_REMARK:
       retval = handleSimpleSection(DocSimpleSect::Remark);
       break;
     case CMD_ATTENTION:
       retval = handleSimpleSection(DocSimpleSect::Attention);
       break;
     case CMD_PAR:
       retval = handleSimpleSection(DocSimpleSect::User);
       break;
     case CMD_LI:
       {
         DocSimpleList *sl=new DocSimpleList(this);
         m_children.append(sl);
         retval = sl->parse();
       }
       break;
     case CMD_SECTION:
       {
         handleSection(cmdName);
         retval = RetVal_Section;
       }
       break;
     case CMD_SUBSECTION:
       {
         handleSection(cmdName);
         retval = RetVal_Subsection;
       }
       break;
     case CMD_SUBSUBSECTION:
       {
         handleSection(cmdName);
         retval = RetVal_Subsubsection;
       }
       break;
     case CMD_PARAGRAPH:
       {
         handleSection(cmdName);
         retval = RetVal_Paragraph;
       }
       break;
     case CMD_STARTCODE:
       {
         doctokenizerYYsetStateCode();
         retval = handleStartCode();
       }
       break;
     case CMD_HTMLONLY:
       {
         doctokenizerYYsetStateHtmlOnly();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::HtmlOnly,g_isExample,g_exampleName,g_token->name=="block"));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"htmlonly section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_MANONLY:
       {
         doctokenizerYYsetStateManOnly();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::ManOnly,g_isExample,g_exampleName));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"manonly section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_RTFONLY:
       {
         doctokenizerYYsetStateRtfOnly();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::RtfOnly,g_isExample,g_exampleName));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"rtfonly section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_LATEXONLY:
       {
         doctokenizerYYsetStateLatexOnly();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::LatexOnly,g_isExample,g_exampleName));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"latexonly section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_XMLONLY:
       {
         doctokenizerYYsetStateXmlOnly();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::XmlOnly,g_isExample,g_exampleName));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"xmlonly section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_DBONLY:
       {
         doctokenizerYYsetStateDbOnly();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::DocbookOnly,g_isExample,g_exampleName));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"docbookonly section ended without end marker",doctokenizerYYlineno);
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_VERBATIM:
       {
         doctokenizerYYsetStateVerbatim();
         retval = doctokenizerYYlex();
         m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::Verbatim,g_isExample,g_exampleName));
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"verbatim section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_DOT:
       {
         DocVerbatim *dv = new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::Dot,g_isExample,g_exampleName);
         doctokenizerYYsetStatePara();
         QCString width,height;
         defaultHandleTitleAndSize(CMD_DOT,dv,dv->children(),width,height);
         doctokenizerYYsetStateDot();
         retval = doctokenizerYYlex();
         dv->setText(g_token->verb);
         dv->setWidth(width);
         dv->setHeight(height);
         m_children.append(dv);
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"dot section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_MSC:
       {
         DocVerbatim *dv = new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::Msc,g_isExample,g_exampleName);
         doctokenizerYYsetStatePara();
         QCString width,height;
         defaultHandleTitleAndSize(CMD_MSC,dv,dv->children(),width,height);
         doctokenizerYYsetStateMsc();
         retval = doctokenizerYYlex();
         dv->setText(g_token->verb);
         dv->setWidth(width);
         dv->setHeight(height);
         m_children.append(dv);
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"msc section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_STARTUML:
       {
         static QCString jarPath = Config_getString("PLANTUML_JAR_PATH");
         doctokenizerYYsetStatePlantUMLOpt();
         retval = doctokenizerYYlex();
         QCString plantFile(g_token->sectionId);
         DocVerbatim *dv = new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::PlantUML,FALSE,plantFile);
         doctokenizerYYsetStatePara();
         QCString width,height;
         defaultHandleTitleAndSize(CMD_STARTUML,dv,dv->children(),width,height);
         doctokenizerYYsetStatePlantUML();
         retval = doctokenizerYYlex();
         dv->setText(g_token->verb);
         dv->setWidth(width);
         dv->setHeight(height);
         if (jarPath.isEmpty())
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"ignoring \\startuml command because PLANTUML_JAR_PATH is not set");
           delete dv;
         }
         else
         {
           m_children.append(dv);
         }
         if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"startuml section ended without end marker");
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_ENDPARBLOCK:
       retval=RetVal_EndParBlock;
       break;
     case CMD_ENDCODE:
     case CMD_ENDHTMLONLY:
     case CMD_ENDMANONLY:
     case CMD_ENDRTFONLY:
     case CMD_ENDLATEXONLY:
     case CMD_ENDXMLONLY:
     case CMD_ENDDBONLY:
     case CMD_ENDLINK:
     case CMD_ENDVERBATIM:
     case CMD_ENDDOT:
     case CMD_ENDMSC:
     case CMD_ENDUML:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected command %s",qPrint(g_token->name));
       break; 
     case CMD_PARAM:
       retval = handleParamSection(cmdName,DocParamSect::Param,FALSE,g_token->paramDir);
       break;
     case CMD_TPARAM:
       retval = handleParamSection(cmdName,DocParamSect::TemplateParam,FALSE,g_token->paramDir);
       break;
     case CMD_RETVAL:
       retval = handleParamSection(cmdName,DocParamSect::RetVal);
       break;
     case CMD_EXCEPTION:
       retval = handleParamSection(cmdName,DocParamSect::Exception);
       break;
     case CMD_XREFITEM:
       retval = handleXRefItem();
       break;
     case CMD_LINEBREAK:
       {
         DocLineBreak *lb = new DocLineBreak(this);
         m_children.append(lb);
       }
       break;
     case CMD_ANCHOR:
       {
         DocAnchor *anchor = handleAnchor(this);
         if (anchor)
         {
           m_children.append(anchor);
         }
       }
       break;
     case CMD_ADDINDEX:
       {
         DocIndexEntry *ie = new DocIndexEntry(this,
                      g_scope!=Doxygen::globalScope?g_scope:0,
                      g_memberDef);
         m_children.append(ie);
         retval = ie->parse();
       }
       break;
     case CMD_INTERNAL:
       retval = RetVal_Internal;
       break;
     case CMD_ENDINTERNAL:
       retval = RetVal_EndInternal;
       break;
     case CMD_PARBLOCK:
       {
         DocParBlock *block = new DocParBlock(this);
         m_children.append(block);
         retval = block->parse();
       }
       break;
     case CMD_COPYDOC:   // fall through
     case CMD_COPYBRIEF: // fall through
     case CMD_COPYDETAILS:
       //retval = RetVal_CopyDoc;
       // these commands should already be resolved by processCopyDoc()
       break;
     case CMD_INCLUDE:
       handleInclude(cmdName,DocInclude::Include);
       break;
     case CMD_INCWITHLINES:
       handleInclude(cmdName,DocInclude::IncWithLines);
       break;
     case CMD_DONTINCLUDE:
       handleInclude(cmdName,DocInclude::DontInclude);
       break;
     case CMD_HTMLINCLUDE:
       handleInclude(cmdName,DocInclude::HtmlInclude);
       break;
     case CMD_LATEXINCLUDE:
       handleInclude(cmdName,DocInclude::LatexInclude);
       break;
     case CMD_VERBINCLUDE:
       handleInclude(cmdName,DocInclude::VerbInclude);
       break;
     case CMD_SNIPPET:
       handleInclude(cmdName,DocInclude::Snippet);
       break;
     case CMD_SKIP:
       handleIncludeOperator(cmdName,DocIncOperator::Skip);
       break;
     case CMD_UNTIL:
       handleIncludeOperator(cmdName,DocIncOperator::Until);
       break;
     case CMD_SKIPLINE:
       handleIncludeOperator(cmdName,DocIncOperator::SkipLine);
       break;
     case CMD_LINE:
       handleIncludeOperator(cmdName,DocIncOperator::Line);
       break;
     case CMD_IMAGE:
       handleImage(cmdName);
       break;
     case CMD_DOTFILE:
       handleFile<DocDotFile>(cmdName);
       break;
     case CMD_VHDLFLOW:
       handleVhdlFlow();
       break;
     case CMD_MSCFILE:
       handleFile<DocMscFile>(cmdName);
       break;
     case CMD_DIAFILE:
       handleFile<DocDiaFile>(cmdName);
       break;
     case CMD_LINK:
       handleLink(cmdName,FALSE);
       break;
     case CMD_JAVALINK:
       handleLink(cmdName,TRUE);
       break;
     case CMD_CITE:
       handleCite();
       break;
     case CMD_REF: // fall through
     case CMD_SUBPAGE:
       handleRef(cmdName);
       break;
     case CMD_SECREFLIST:
       {
         DocSecRefList *list = new DocSecRefList(this);
         m_children.append(list);
         list->parse();
       }
       break;
     case CMD_SECREFITEM:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected command %s",qPrint(g_token->name));
       break;
     case CMD_ENDSECREFLIST:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected command %s",qPrint(g_token->name));
       break;
     case CMD_FORMULA:
       {
         DocFormula *form=new DocFormula(this,g_token->id);
         m_children.append(form);
       }
       break;
     //case CMD_LANGSWITCH:
     //  retval = handleLanguageSwitch();
     //  break;
     case CMD_INTERNALREF:
       //warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected command %s",qPrint(g_token->name));
       {
         DocInternalRef *ref = handleInternalRef(this);
         if (ref)
         {
           m_children.append(ref);
           ref->parse();
         }
         doctokenizerYYsetStatePara();
       }
       break;
     case CMD_INHERITDOC:
       handleInheritDoc();
       break;
     default:
       // we should not get here!
       ASSERT(0);
       break;
   }
   INTERNAL_ASSERT(retval==0 || retval==RetVal_OK || retval==RetVal_SimpleSec || 
          retval==TK_LISTITEM || retval==TK_ENDLIST || retval==TK_NEWPARA ||
          retval==RetVal_Section || retval==RetVal_EndList || 
          retval==RetVal_Internal || retval==RetVal_SwitchLang || 
          retval==RetVal_EndInternal
         );
   DBG(("handleCommand(%s) end retval=%x\n",qPrint(cmdName),retval));
   return retval;
 }

template<class T >

void DocPara::handleFile ( const QCString & cmdName )

Definition at line 5051 of file docparser.cpp.

 {
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStateFile();
   tok=doctokenizerYYlex();
   doctokenizerYYsetStatePara();
   if (tok!=TK_WORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   QCString name = g_token->name;
   T *df = new T(this,name,g_context);
   m_children.append(df);
   df->parse();
 }

int DocPara::handleHtmlEndTag ( const QCString & tagName )

Definition at line 6164 of file docparser.cpp.

 {
   DBG(("handleHtmlEndTag(%s)\n",qPrint(tagName)));
   int tagId = Mappers::htmlTagMapper->map(tagName);
   int retval=RetVal_OK;
   switch (tagId)
   {
     case HTML_UL: 
       if (!insideUL(this))
       {
         warn_doc_error(g_fileName,doctokenizerYYlineno,"found </ul> tag without matching <ul>");
       }
       else
       {
         retval=RetVal_EndList;
       }
       break;
     case HTML_OL: 
       if (!insideOL(this))
       {
         warn_doc_error(g_fileName,doctokenizerYYlineno,"found </ol> tag without matching <ol>");
       }
       else
       {
         retval=RetVal_EndList;
       }
       break;
     case HTML_LI:
       if (!insideLI(this))
       {
         warn_doc_error(g_fileName,doctokenizerYYlineno,"found </li> tag without matching <li>");
       }
       else
       {
         // ignore </li> tags
       }
       break;
     case HTML_BLOCKQUOTE:
       retval=RetVal_EndBlockQuote;
       break;
     //case HTML_PRE:
     //  if (!insidePRE(this))
     //  {
     //    warn_doc_error(g_fileName,doctokenizerYYlineno,"found </pre> tag without matching <pre>");
     //  }
     //  else
     //  {
     //    retval=RetVal_EndPre;
     //  }
     //  break;
     case HTML_BOLD:
       handleStyleLeave(this,m_children,DocStyleChange::Bold,"b");
       break;
     case HTML_CODE:
       handleStyleLeave(this,m_children,DocStyleChange::Code,"code");
       break;
     case HTML_EMPHASIS:
       handleStyleLeave(this,m_children,DocStyleChange::Italic,"em");
       break;
     case HTML_DIV:
       handleStyleLeave(this,m_children,DocStyleChange::Div,"div");
       break;
     case HTML_SPAN:
       handleStyleLeave(this,m_children,DocStyleChange::Span,"span");
       break;
     case HTML_SUB:
       handleStyleLeave(this,m_children,DocStyleChange::Subscript,"sub");
       break;
     case HTML_SUP:
       handleStyleLeave(this,m_children,DocStyleChange::Superscript,"sup");
       break;
     case HTML_CENTER:
       handleStyleLeave(this,m_children,DocStyleChange::Center,"center");
       break;
     case HTML_SMALL:
       handleStyleLeave(this,m_children,DocStyleChange::Small,"small");
       break;
     case HTML_PRE:
       handleStyleLeave(this,m_children,DocStyleChange::Preformatted,"pre");
       setInsidePreformatted(FALSE);
       doctokenizerYYsetInsidePre(FALSE);
       break;
     case HTML_P:
       retval=TK_NEWPARA;
       break;
     case HTML_DL:
       retval=RetVal_EndDesc;
       break;
     case HTML_DT:
       // ignore </dt> tag
       break;
     case HTML_DD:
       // ignore </dd> tag
       break;
     case HTML_TABLE:
       retval=RetVal_EndTable;
       break;
     case HTML_TR:
       // ignore </tr> tag
       break;
     case HTML_TD:
       // ignore </td> tag
       break;
     case HTML_TH:
       // ignore </th> tag
       break;
     case HTML_CAPTION:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </caption> found");
       break;
     case HTML_BR:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Illegal </br> tag found\n");
       break;
     case HTML_H1:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </h1> found");
       break;
     case HTML_H2:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </h2> found");
       break;
     case HTML_H3:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </h3> found");
       break;
     case HTML_H4:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </h4> found");
       break;
     case HTML_H5:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </h5> found");
       break;
     case HTML_H6:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </h6> found");
       break;
     case HTML_IMG:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </img> found");
       break;
     case HTML_HR:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </hr> found");
       break;
     case HTML_A:
       //warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag </a> found");
       // ignore </a> tag (can be part of <a name=...></a>
       break;
 
     case XML_TERM:
       //m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Bold,FALSE));
       break;
     case XML_SUMMARY:
     case XML_REMARKS:
     case XML_PARA:
     case XML_VALUE:
     case XML_EXAMPLE:
     case XML_PARAM:
     case XML_LIST:
     case XML_TYPEPARAM:
     case XML_RETURNS:
     case XML_SEE:
     case XML_SEEALSO:
     case XML_EXCEPTION:
     case XML_INHERITDOC:
       retval = RetVal_CloseXml;
       break;
     case XML_C:
       handleStyleLeave(this,m_children,DocStyleChange::Code,"c");
       break;
     case XML_ITEM:
     case XML_LISTHEADER:
     case XML_INCLUDE:
     case XML_PERMISSION:
     case XML_DESCRIPTION:
     case XML_PARAMREF:
     case XML_TYPEPARAMREF:
       // These tags are defined in .Net but are currently unsupported
       break;
     case HTML_UNKNOWN:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unsupported xml/html tag </%s> found", qPrint(tagName));
       m_children.append(new DocWord(this,"</"+tagName+">"));
       break;
     default:
       // we should not get here!
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected end tag %s\n",qPrint(tagName));
       ASSERT(0);
       break;
   }
   return retval;
 }

int DocPara::handleHtmlHeader	(	const HtmlAttribList &	tagHtmlAttribs,
		int	level
	)

Definition at line 5211 of file docparser.cpp.

 {
   DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,level);
   m_children.append(header);
   int retval = header->parse();
   return (retval==RetVal_OK) ? TK_NEWPARA : retval;
 }

int DocPara::handleHtmlStartTag	(	const QCString &	tagName,
		const HtmlAttribList &	tagHtmlAttribs
	)

Definition at line 5778 of file docparser.cpp.

 {
   DBG(("handleHtmlStartTag(%s,%d)\n",qPrint(tagName),tagHtmlAttribs.count()));
   int retval=RetVal_OK;
   int tagId = Mappers::htmlTagMapper->map(tagName);
   if (g_token->emptyTag && !(tagId&XML_CmdMask) && 
       tagId!=HTML_UNKNOWN && tagId!=HTML_IMG && tagId!=HTML_BR)
   {
       warn_doc_error(g_fileName,doctokenizerYYlineno,"HTML tags may not use the 'empty tag' XHTML syntax.");
   }
   switch (tagId)
   {
     case HTML_UL: 
       {
         DocHtmlList *list = new DocHtmlList(this,tagHtmlAttribs,DocHtmlList::Unordered);
         m_children.append(list);
         retval=list->parse();
       }
       break;
     case HTML_OL: 
       {
         DocHtmlList *list = new DocHtmlList(this,tagHtmlAttribs,DocHtmlList::Ordered);
         m_children.append(list);
         retval=list->parse();
       }
       break;
     case HTML_LI:
       if (!insideUL(this) && !insideOL(this))
       {
         warn_doc_error(g_fileName,doctokenizerYYlineno,"lonely <li> tag found");
       }
       else
       {
         retval=RetVal_ListItem;
       }
       break;
     case HTML_BOLD:
       handleStyleEnter(this,m_children,DocStyleChange::Bold,&g_token->attribs);
       break;
     case HTML_CODE:
       if (/*getLanguageFromFileName(g_fileName)==SrcLangExt_CSharp ||*/ g_xmlComment) 
         // for C# source or inside a <summary> or <remark> section we 
         // treat <code> as an XML tag (so similar to @code)
       {
         doctokenizerYYsetStateXmlCode();
         retval = handleStartCode();
       }
       else // normal HTML markup
       {
         handleStyleEnter(this,m_children,DocStyleChange::Code,&g_token->attribs);
       }
       break;
     case HTML_EMPHASIS:
       handleStyleEnter(this,m_children,DocStyleChange::Italic,&g_token->attribs);
       break;
     case HTML_DIV:
       handleStyleEnter(this,m_children,DocStyleChange::Div,&g_token->attribs);
       break;
     case HTML_SPAN:
       handleStyleEnter(this,m_children,DocStyleChange::Span,&g_token->attribs);
       break;
     case HTML_SUB:
       handleStyleEnter(this,m_children,DocStyleChange::Subscript,&g_token->attribs);
       break;
     case HTML_SUP:
       handleStyleEnter(this,m_children,DocStyleChange::Superscript,&g_token->attribs);
       break;
     case HTML_CENTER:
       handleStyleEnter(this,m_children,DocStyleChange::Center,&g_token->attribs);
       break;
     case HTML_SMALL:
       handleStyleEnter(this,m_children,DocStyleChange::Small,&g_token->attribs);
       break;
     case HTML_PRE:
       handleStyleEnter(this,m_children,DocStyleChange::Preformatted,&g_token->attribs);
       setInsidePreformatted(TRUE);
       doctokenizerYYsetInsidePre(TRUE);
       break;
     case HTML_P:
       retval=TK_NEWPARA;
       break;
     case HTML_DL:
       {
         DocHtmlDescList *list = new DocHtmlDescList(this,tagHtmlAttribs);
         m_children.append(list);
         retval=list->parse();
       }
       break;
     case HTML_DT:
       retval = RetVal_DescTitle;
       break;
     case HTML_DD:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag <dd> found");
       break;
     case HTML_TABLE:
       {
         DocHtmlTable *table = new DocHtmlTable(this,tagHtmlAttribs);
         m_children.append(table);
         retval=table->parse();
       }
       break;
     case HTML_TR:
       retval = RetVal_TableRow;
       break;
     case HTML_TD:
       retval = RetVal_TableCell;
       break;
     case HTML_TH:
       retval = RetVal_TableHCell;
       break;
     case HTML_CAPTION:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unexpected tag <caption> found");
       break;
     case HTML_BR:
       {
         DocLineBreak *lb = new DocLineBreak(this);
         m_children.append(lb);
       }
       break;
     case HTML_HR:
       {
         DocHorRuler *hr = new DocHorRuler(this);
         m_children.append(hr);
       }
       break;
     case HTML_A:
       retval=handleAHref(this,m_children,tagHtmlAttribs);
       break;
     case HTML_H1:
       retval=handleHtmlHeader(tagHtmlAttribs,1);
       break;
     case HTML_H2:
       retval=handleHtmlHeader(tagHtmlAttribs,2);
       break;
     case HTML_H3:
       retval=handleHtmlHeader(tagHtmlAttribs,3);
       break;
     case HTML_H4:
       retval=handleHtmlHeader(tagHtmlAttribs,4);
       break;
     case HTML_H5:
       retval=handleHtmlHeader(tagHtmlAttribs,5);
       break;
     case HTML_H6:
       retval=handleHtmlHeader(tagHtmlAttribs,6);
       break;
     case HTML_IMG:
       {
         handleImg(this,m_children,tagHtmlAttribs);
       }
       break;
     case HTML_BLOCKQUOTE:
       {
         DocHtmlBlockQuote *block = new DocHtmlBlockQuote(this,tagHtmlAttribs);
         m_children.append(block);
         retval = block->parse();
       }
       break;
 
     case XML_SUMMARY:
     case XML_REMARKS:
     case XML_EXAMPLE:
       g_xmlComment=TRUE;
       // fall through
     case XML_VALUE:
     case XML_PARA:
       if (!m_children.isEmpty())
       {
         retval = TK_NEWPARA;
       }
       break;
     case XML_DESCRIPTION:
       if (insideTable(this))
       {
         retval=RetVal_TableCell;
       }
       break;
     case XML_C:
       handleStyleEnter(this,m_children,DocStyleChange::Code,&g_token->attribs);
       break;
     case XML_PARAM:
     case XML_TYPEPARAM:
       {
         g_xmlComment=TRUE;
         QCString paramName;
         if (findAttribute(tagHtmlAttribs,"name",&paramName))
         {
           if (paramName.isEmpty())
           {
             if (Config_getBool("WARN_NO_PARAMDOC"))
             {
               warn_doc_error(g_fileName,doctokenizerYYlineno,"empty 'name' attribute for <param%s> tag.",tagId==XML_PARAM?"":"type");
             }
           }
           else
           {
             retval = handleParamSection(paramName,
                 tagId==XML_PARAM ? DocParamSect::Param : DocParamSect::TemplateParam,
                 TRUE);
           }
         }
         else
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'name' attribute from <param%s> tag.",tagId==XML_PARAM?"":"type");
         }
       }
       break;
     case XML_PARAMREF:
     case XML_TYPEPARAMREF:
       {
         QCString paramName;
         if (findAttribute(tagHtmlAttribs,"name",&paramName))
         {
           //printf("paramName=%s\n",paramName.data());
           m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Italic,TRUE));
           m_children.append(new DocWord(this,paramName)); 
           m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Italic,FALSE));
           if (retval!=TK_WORD) m_children.append(new DocWhiteSpace(this," "));
         }
         else
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'name' attribute from <param%sref> tag.",tagId==XML_PARAMREF?"":"type");
         }
       }
       break;
     case XML_EXCEPTION:
       {
         g_xmlComment=TRUE;
         QCString exceptName;
         if (findAttribute(tagHtmlAttribs,"cref",&exceptName))
         {
           unescapeCRef(exceptName);
           retval = handleParamSection(exceptName,DocParamSect::Exception,TRUE);
         }
         else
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'cref' attribute from <exception> tag.");
         }
       }
       break;
     case XML_ITEM:
     case XML_LISTHEADER:
       if (insideTable(this))
       {
         retval=RetVal_TableRow;
       }
       else if (insideUL(this) || insideOL(this))
       {
         retval=RetVal_ListItem;
       }
       else
       {
         warn_doc_error(g_fileName,doctokenizerYYlineno,"lonely <item> tag found");
       }
       break;
     case XML_RETURNS:
       g_xmlComment=TRUE;
       retval = handleSimpleSection(DocSimpleSect::Return,TRUE);
       g_hasReturnCommand=TRUE;
       break;
     case XML_TERM:
       //m_children.append(new DocStyleChange(this,g_nodeStack.count(),DocStyleChange::Bold,TRUE));
       if (insideTable(this))
       {
         retval=RetVal_TableCell;
       }
       break;
     case XML_SEE:
       // I'm not sure if <see> is the same as <seealso> or if it
       // should you link a member without producing a section. The
       // C# specification is extremely vague about this (but what else 
       // can we expect from Microsoft...)
       {
         QCString cref;
         //printf("XML_SEE: empty tag=%d\n",g_token->emptyTag);
         if (findAttribute(tagHtmlAttribs,"cref",&cref))
         {
           unescapeCRef(cref);
           if (g_token->emptyTag) // <see cref="..."/> style
           {
             bool inSeeBlock = g_inSeeBlock;
             g_token->name = cref;
             g_inSeeBlock = TRUE;
             handleLinkedWord(this,m_children,TRUE);
             g_inSeeBlock = inSeeBlock;
           }
           else // <see cref="...">...</see> style
           {
             //DocRef *ref = new DocRef(this,cref);
             //m_children.append(ref);
             //ref->parse();
             doctokenizerYYsetStatePara();
             DocLink *lnk = new DocLink(this,cref);
             m_children.append(lnk);
             QCString leftOver = lnk->parse(FALSE,TRUE);
             if (!leftOver.isEmpty())
             {
               m_children.append(new DocWord(this,leftOver));
             }
           }
         }
         else
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'cref' attribute from <see> tag.");
         }
       }
       break;
     case XML_SEEALSO:
       {
         g_xmlComment=TRUE;
         QCString cref;
         if (findAttribute(tagHtmlAttribs,"cref",&cref))
         {
           unescapeCRef(cref);
           // Look for an existing "see" section
           DocSimpleSect *ss=0;
           QListIterator<DocNode> cli(m_children);
           DocNode *n;
           for (cli.toFirst();(n=cli.current());++cli)
           {
             if (n->kind()==Kind_SimpleSect && ((DocSimpleSect *)n)->type()==DocSimpleSect::See)
             {
               ss = (DocSimpleSect *)n;
             }
           }
 
           if (!ss)  // start new section
           {
             ss=new DocSimpleSect(this,DocSimpleSect::See);
             m_children.append(ss);
           }
 
           ss->appendLinkWord(cref);
           retval = RetVal_OK;
         }
         else
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'cref' attribute from <seealso> tag.");
         }
       }
       break;
     case XML_LIST:
       {
         QCString type;
         findAttribute(tagHtmlAttribs,"type",&type);
         DocHtmlList::Type listType = DocHtmlList::Unordered;
         HtmlAttribList emptyList;
         if (type=="number")
         {
           listType=DocHtmlList::Ordered;
         }
         if (type=="table")
         {
           DocHtmlTable *table = new DocHtmlTable(this,emptyList);
           m_children.append(table);
           retval=table->parseXml();
         }
         else
         {
           DocHtmlList *list = new DocHtmlList(this,emptyList,listType);
           m_children.append(list);
           retval=list->parseXml();
         }
       }
       break;
     case XML_INCLUDE:
     case XML_PERMISSION:
       // These tags are defined in .Net but are currently unsupported
       g_xmlComment=TRUE;
       break;
     case HTML_UNKNOWN:
       warn_doc_error(g_fileName,doctokenizerYYlineno,"Unsupported xml/html tag <%s> found", qPrint(tagName));
       m_children.append(new DocWord(this, "<"+tagName+tagHtmlAttribs.toString()+">"));
       break;
   case XML_INHERITDOC:
       handleInheritDoc();
       break;
           
     default:
       // we should not get here!
       ASSERT(0);
       break;
   }
   return retval;
 }

void DocPara::handleImage ( const QCString & cmdName )

Definition at line 4999 of file docparser.cpp.

 {
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   tok=doctokenizerYYlex();
   if (tok!=TK_WORD && tok!=TK_LNKWORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   DocImage::Type t;
   QCString imgType = g_token->name.lower();
   if      (imgType=="html")    t=DocImage::Html;
   else if (imgType=="latex")   t=DocImage::Latex;
   else if (imgType=="docbook") t=DocImage::DocBook;
   else if (imgType=="rtf")     t=DocImage::Rtf;
   else
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"image type %s specified as the first argument of "
         "%s is not valid",
         qPrint(imgType),qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStateFile();
   tok=doctokenizerYYlex();
   doctokenizerYYsetStatePara();
   if (tok!=TK_WORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   HtmlAttribList attrList;
   DocImage *img = new DocImage(this,attrList,findAndCopyImage(g_token->name,t),t);
   m_children.append(img);
   img->parse();
 }

void DocPara::handleInclude	(	const QCString &	cmdName,
		DocInclude::Type	t
	)

Definition at line 5136 of file docparser.cpp.

 {
   DBG(("handleInclude(%s)\n",qPrint(cmdName)));
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStateFile();
   tok=doctokenizerYYlex();
   doctokenizerYYsetStatePara();
   if (tok==0)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected end of comment block while parsing the "
         "argument of command %s",qPrint(cmdName));
     return;
   }
   else if (tok!=TK_WORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   QCString fileName = g_token->name;
   QCString blockId;
   if (t==DocInclude::Snippet)
   {
     if (fileName == "this") fileName=g_fileName;
     doctokenizerYYsetStateSnippet();
     tok=doctokenizerYYlex();
     doctokenizerYYsetStatePara();
     if (tok!=TK_WORD)
     {
       warn_doc_error(g_fileName,doctokenizerYYlineno,"expected block identifier, but found token %s instead while parsing the %s command",
           tokToString(tok),qPrint(cmdName));
       return;
     }
     blockId = "["+g_token->name+"]";
   }
   DocInclude *inc = new DocInclude(this,fileName,g_context,t,g_isExample,g_exampleName,blockId);
   m_children.append(inc);
   inc->parse();
 }

void DocPara::handleIncludeOperator	(	const QCString &	cmdName,
		DocIncOperator::Type	t
	)

Definition at line 4946 of file docparser.cpp.

 {
   DBG(("handleIncludeOperator(%s)\n",qPrint(cmdName)));
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStatePattern();
   tok=doctokenizerYYlex();
   doctokenizerYYsetStatePara();
   if (tok==0)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected end of comment block while parsing the "
         "argument of command %s", qPrint(cmdName));
     return;
   }
   else if (tok!=TK_WORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   DocIncOperator *op = new DocIncOperator(this,t,g_token->name,g_context,g_isExample,g_exampleName);
   QListIterator<DocNode> it(m_children);
   DocNode *n1 = it.toLast();
   --it;
   DocNode *n2 = n1!=0 ? it.current() : 0;
   bool isFirst = n1==0 || // no last node
                  (n1->kind()!=DocNode::Kind_IncOperator &&
                   n1->kind()!=DocNode::Kind_WhiteSpace
                  ) || // last node is not operator or whitespace
                  (n1->kind()==DocNode::Kind_WhiteSpace &&
                   n2!=0 && n2->kind()!=DocNode::Kind_IncOperator
                  ); // previous not is not operator
   op->markFirst(isFirst);
   op->markLast(TRUE);
   if (n1!=0 && n1->kind()==DocNode::Kind_IncOperator)
   {
     ((DocIncOperator *)n1)->markLast(FALSE);
   }
   else if (n1!=0 && n1->kind()==DocNode::Kind_WhiteSpace &&
            n2!=0 && n2->kind()==DocNode::Kind_IncOperator
           )
   {
     ((DocIncOperator *)n2)->markLast(FALSE);
   }
   m_children.append(op);
   op->parse();
 }

void DocPara::handleInheritDoc ( )

Definition at line 5253 of file docparser.cpp.

 {
   if (g_memberDef) // inheriting docs from a member
   {
     MemberDef *reMd = g_memberDef->reimplements();
     if (reMd) // member from which was inherited.
     {
       MemberDef *thisMd = g_memberDef;
       //printf("{InheritDocs:%s=>%s}\n",g_memberDef->qualifiedName().data(),reMd->qualifiedName().data());
       docParserPushContext();
       g_scope=reMd->getOuterScope();
       if (g_scope!=Doxygen::globalScope)
       {
         g_context=g_scope->name();
       }
       g_memberDef=reMd;
       g_styleStack.clear();
       g_nodeStack.clear();
       g_copyStack.append(reMd);
       internalValidatingParseDoc(this,m_children,reMd->briefDescription());
       internalValidatingParseDoc(this,m_children,reMd->documentation());
       g_copyStack.remove(reMd);
       docParserPopContext(TRUE);
       g_memberDef = thisMd;
     }
   }
 }

void DocPara::handleLink	(	const QCString &	cmdName,
		bool	isJavaLink
	)

Definition at line 5082 of file docparser.cpp.

 {
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStateLink();
   tok=doctokenizerYYlex();
   if (tok!=TK_WORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"%s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStatePara();
   DocLink *lnk = new DocLink(this,g_token->name);
   m_children.append(lnk);
   QCString leftOver = lnk->parse(isJavaLink);
   if (!leftOver.isEmpty())
   {
     m_children.append(new DocWord(this,leftOver));
   }
 }

int DocPara::handleParamSection	(	const QCString &	cmdName,
		DocParamSect::Type	t,
		bool	xmlContext = `FALSE`,
		int	direction = `DocParamSect::Unspecified`
	)

Definition at line 4870 of file docparser.cpp.

 {
   DocParamSect *ps=0;
   if (!m_children.isEmpty() &&                        // previous element
       m_children.getLast()->kind()==Kind_ParamSect &&    // was a param sect
       ((DocParamSect *)m_children.getLast())->type()==t) // of same type
   {
     // append to previous section
     ps=(DocParamSect *)m_children.getLast();
   }
   else // start new section
   {
     ps=new DocParamSect(this,t);
     m_children.append(ps);
   }
   int rv=ps->parse(cmdName,xmlContext,(DocParamSect::Direction)direction);
   return (rv!=TK_NEWPARA) ? rv : RetVal_OK;
 }

void DocPara::handleRef ( const QCString & cmdName )

Definition at line 5109 of file docparser.cpp.

 {
   DBG(("handleRef(%s)\n",qPrint(cmdName)));
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   doctokenizerYYsetStateRef();
   tok=doctokenizerYYlex(); // get the reference id
   DocRef *ref=0;
   if (tok!=TK_WORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     goto endref;
   }
   ref = new DocRef(this,g_token->name,g_context);
   m_children.append(ref);
   ref->parse();
 endref:
   doctokenizerYYsetStatePara();
 }

void DocPara::handleSection ( const QCString & cmdName )

Definition at line 5182 of file docparser.cpp.

 {
   // get the argument of the section command.
   int tok=doctokenizerYYlex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"expected whitespace after %s command",
         qPrint(cmdName));
     return;
   }
   tok=doctokenizerYYlex();
   if (tok==0)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected end of comment block while parsing the "
         "argument of command %s\n", qPrint(cmdName));
     return;
   }
   else if (tok!=TK_WORD && tok!=TK_LNKWORD)
   {
     warn_doc_error(g_fileName,doctokenizerYYlineno,"unexpected token %s as the argument of %s",
         tokToString(tok),qPrint(cmdName));
     return;
   }
   g_token->sectionId = g_token->name;
   doctokenizerYYsetStateSkipTitle();
   doctokenizerYYlex();
   doctokenizerYYsetStatePara();
 }

int DocPara::handleSimpleSection	(	DocSimpleSect::Type	t,
		bool	xmlContext = `FALSE`
	)

Definition at line 4840 of file docparser.cpp.

 {
   DocSimpleSect *ss=0;
   bool needsSeparator = FALSE;
   if (!m_children.isEmpty() &&                           // previous element
       m_children.getLast()->kind()==Kind_SimpleSect &&      // was a simple sect
       ((DocSimpleSect *)m_children.getLast())->type()==t && // of same type
       t!=DocSimpleSect::User)                            // but not user defined
   {
     // append to previous section
     ss=(DocSimpleSect *)m_children.getLast();
     needsSeparator = TRUE;
   }
   else // start new section
   {
     ss=new DocSimpleSect(this,t);
     m_children.append(ss);
   }
   int rv = RetVal_OK;
   if (xmlContext)
   {
     return ss->parseXml();
   }
   else
   {
     rv = ss->parse(t==DocSimpleSect::User,needsSeparator);
   }
   return (rv!=TK_NEWPARA) ? rv : RetVal_OK;
 }

int DocPara::handleStartCode ( )

Definition at line 5228 of file docparser.cpp.

 {
   int retval = doctokenizerYYlex();
   QCString lang = g_token->name;
   if (!lang.isEmpty() && lang.at(0)!='.')
   {
     lang="."+lang;
   }
   if (g_xmlComment)
   {
     g_token->verb = substitute(substitute(g_token->verb,"&lt;","<"),"&gt;",">");
   }
   // search for the first non-whitespace line, index is stored in li
   int i=0,li=0,l=g_token->verb.length();
   while (i<l && (g_token->verb.at(i)==' ' || g_token->verb.at(i)=='\n'))
   {
     if (g_token->verb.at(i)=='\n') li=i+1;
     i++;
   }
   m_children.append(new DocVerbatim(this,g_context,stripIndentation(g_token->verb.mid(li)),DocVerbatim::Code,g_isExample,g_exampleName,FALSE,lang));
   if (retval==0) warn_doc_error(g_fileName,doctokenizerYYlineno,"code section ended without end marker");
   doctokenizerYYsetStatePara();
   return retval;
 }

void DocPara::handleVhdlFlow ( )

Definition at line 5075 of file docparser.cpp.

 {
   DocVhdlFlow *vf = new DocVhdlFlow(this);
   m_children.append(vf);
   vf->parse();
 }

int DocPara::handleXRefItem ( )

Definition at line 4924 of file docparser.cpp.

 {
   int retval=doctokenizerYYlex();
   ASSERT(retval==TK_WHITESPACE);
   doctokenizerYYsetStateXRefItem();
   retval=doctokenizerYYlex();
   if (retval==RetVal_OK)
   {
     DocXRefItem *ref = new DocXRefItem(this,g_token->id,g_token->name);
     if (ref->parse())
     {
       m_children.append(ref);
     }
     else 
     {
       delete ref;
     }
   }
   doctokenizerYYsetStatePara();
   return retval;
 }

bool DocPara::injectToken	(	int	tok,
		const QCString &	tokText
	)

Definition at line 5222 of file docparser.cpp.

 {
   g_token->name = tokText;
   return defaultHandleToken(this,tok,m_children);
 }

bool DocPara::isEmpty ( ) const

inline

Definition at line 1120 of file docparser.h.

1120 { return m_children.isEmpty(); }

CompAccept< DocPara >::m_children

QList< DocNode > m_children

Definition: docparser.h:189

QList::isEmpty

bool isEmpty() const

Definition: qlist.h:67

bool DocPara::isFirst ( ) const

inline

Definition at line 1124 of file docparser.h.

1124 { return m_isFirst; }

DocPara::m_isFirst

bool m_isFirst

Definition: docparser.h:1152

bool DocPara::isLast ( ) const

inline

Definition at line 1125 of file docparser.h.

1125 { return m_isLast; }

DocPara::m_isLast

bool m_isLast

Definition: docparser.h:1153

Kind DocPara::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 1119 of file docparser.h.

1119 { return Kind_Para; }

DocNode::Kind_Para

Definition: docparser.h:86

void DocPara::markFirst ( bool v = TRUE )

inline

Definition at line 1122 of file docparser.h.

1122 { m_isFirst=v; }

DocPara::m_isFirst

bool m_isFirst

Definition: docparser.h:1152

void DocPara::markLast ( bool v = TRUE )

inline

Definition at line 1123 of file docparser.h.

1123 { m_isLast=v; }

DocPara::m_isLast

bool m_isLast

Definition: docparser.h:1153

int DocPara::parse ( )

Definition at line 6348 of file docparser.cpp.

 {
   DBG(("DocPara::parse() start\n"));
   g_nodeStack.push(this);
   // handle style commands "inherited" from the previous paragraph
   handleInitialStyleCommands(this,m_children);
   int tok;
   int retval=0;
   while ((tok=doctokenizerYYlex())) // get the next token
   {
 reparsetoken:
     DBG(("token %s at %d",tokToString(tok),doctokenizerYYlineno));
     if (tok==TK_WORD || tok==TK_LNKWORD || tok==TK_SYMBOL || tok==TK_URL || 
         tok==TK_COMMAND || tok==TK_HTMLTAG
        )
     {
       DBG((" name=%s",qPrint(g_token->name)));
     }
     DBG(("\n"));
     switch(tok)
     {
       case TK_WORD:
         m_children.append(new DocWord(this,g_token->name));
         break;
       case TK_LNKWORD:
         handleLinkedWord(this,m_children);
         break;
       case TK_URL:
         m_children.append(new DocURL(this,g_token->name,g_token->isEMailAddr));
         break;
       case TK_WHITESPACE:
         {
           // prevent leading whitespace and collapse multiple whitespace areas
           DocNode::Kind k;
           if (insidePRE(this) || // all whitespace is relevant
               (
                // remove leading whitespace 
                !m_children.isEmpty()  && 
                // and whitespace after certain constructs
                (k=m_children.getLast()->kind())!=DocNode::Kind_HtmlDescList &&
                k!=DocNode::Kind_HtmlTable &&
                k!=DocNode::Kind_HtmlList &&
                k!=DocNode::Kind_SimpleSect &&
                k!=DocNode::Kind_AutoList &&
                k!=DocNode::Kind_SimpleList &&
                /*k!=DocNode::Kind_Verbatim &&*/
                k!=DocNode::Kind_HtmlHeader &&
                k!=DocNode::Kind_HtmlBlockQuote &&
                k!=DocNode::Kind_ParamSect &&
                k!=DocNode::Kind_XRefItem
               )
              )
           {
             m_children.append(new DocWhiteSpace(this,g_token->chars));
           }
         }
         break;
       case TK_LISTITEM:
         {
           DBG(("found list item at %d parent=%d\n",g_token->indent,parent()->kind()));
           DocNode *n=parent();
           while (n && n->kind()!=DocNode::Kind_AutoList) n=n->parent();
           if (n) // we found an auto list up in the hierarchy
           {
             DocAutoList *al = (DocAutoList *)n;
             DBG(("previous list item at %d\n",al->indent()));
             if (al->indent()>=g_token->indent) 
               // new item at the same or lower indent level
             {
               retval=TK_LISTITEM;
               goto endparagraph;
             }
           }
 
           // determine list depth
           int depth = 0;
           n=parent();
           while(n) 
           {
             if (n->kind() == DocNode::Kind_AutoList && 
                 ((DocAutoList*)n)->isEnumList()) depth++;
             n=n->parent();
           }
 
           // first item or sub list => create new list
           DocAutoList *al=0;
           do
           {
             al = new DocAutoList(this,g_token->indent,
                                  g_token->isEnumList,depth);
             m_children.append(al);
             retval = al->parse();
           } while (retval==TK_LISTITEM &&         // new list
               al->indent()==g_token->indent  // at same indent level
               );
 
           // check the return value
           if (retval==RetVal_SimpleSec) // auto list ended due to simple section command
           {
             // Reparse the token that ended the section at this level,
             // so a new simple section will be started at this level.
             // This is the same as unputting the last read token and continuing.
             g_token->name = g_token->simpleSectName;
             if (g_token->name.left(4)=="rcs:") // RCS section
             {
               g_token->name = g_token->name.mid(4);
               g_token->text = g_token->simpleSectText;
               tok = TK_RCSTAG;
             }
             else // other section
             {
               tok = TK_COMMAND;
             }
             DBG(("reparsing command %s\n",qPrint(g_token->name)));
             goto reparsetoken;
           }
           else if (retval==TK_ENDLIST)
           {
             if (al->indent()>g_token->indent) // end list
             {
               goto endparagraph;
             }
             else // continue with current paragraph
             {
             }
           }
           else // paragraph ended due to TK_NEWPARA, TK_LISTITEM, or EOF
           {
             goto endparagraph;
           }
         }
         break;
       case TK_ENDLIST:     
         DBG(("Found end of list inside of paragraph at line %d\n",doctokenizerYYlineno));
         if (parent()->kind()==DocNode::Kind_AutoListItem)
         {
           ASSERT(parent()->parent()->kind()==DocNode::Kind_AutoList);
           DocAutoList *al = (DocAutoList *)parent()->parent();
           if (al->indent()>=g_token->indent)
           {
             // end of list marker ends this paragraph
             retval=TK_ENDLIST;
             goto endparagraph;
           }
           else
           {
             warn_doc_error(g_fileName,doctokenizerYYlineno,"End of list marker found "
                 "has invalid indent level");
           }
         }
         else
         {
           warn_doc_error(g_fileName,doctokenizerYYlineno,"End of list marker found without any preceding "
               "list items");
         }
         break;
       case TK_COMMAND:    
         {
           // see if we have to start a simple section
           int cmd = Mappers::cmdMapper->map(g_token->name);
           DocNode *n=parent();
           while (n && 
               n->kind()!=DocNode::Kind_SimpleSect && 
               n->kind()!=DocNode::Kind_ParamSect
               ) 
           {
             n=n->parent();
           }
           if (cmd&SIMPLESECT_BIT)
           {
             if (n)  // already in a simple section
             {
               // simple section cannot start in this paragraph, need
               // to unwind the stack and remember the command.
               g_token->simpleSectName = g_token->name.copy();
               retval=RetVal_SimpleSec;
               goto endparagraph;
             }
           }
           // see if we are in a simple list
           n=parent();
           while (n && n->kind()!=DocNode::Kind_SimpleListItem) n=n->parent();
           if (n)
           {
             if (cmd==CMD_LI)
             {
               retval=RetVal_ListItem;
               goto endparagraph;
             }
           }
 
           // handle the command
           retval=handleCommand(g_token->name);
           DBG(("handleCommand returns %x\n",retval));
 
           // check the return value
           if (retval==RetVal_SimpleSec)
           {
             // Reparse the token that ended the section at this level,
             // so a new simple section will be started at this level.
             // This is the same as unputting the last read token and continuing.
             g_token->name = g_token->simpleSectName;
             if (g_token->name.left(4)=="rcs:") // RCS section
             {
               g_token->name = g_token->name.mid(4);
               g_token->text = g_token->simpleSectText;
               tok = TK_RCSTAG;
             }
             else // other section
             {
               tok = TK_COMMAND;
             }
             DBG(("reparsing command %s\n",qPrint(g_token->name)));
             goto reparsetoken;
           }
           else if (retval==RetVal_OK) 
           {
             // the command ended normally, keep scanning for new tokens.
             retval = 0;
           }
           else if (retval>0 && retval<RetVal_OK)
           { 
             // the command ended with a new command, reparse this token
             tok = retval;
             goto reparsetoken;
           }
           else // end of file, end of paragraph, start or end of section 
             // or some auto list marker
           {
             goto endparagraph;
           }
         }
         break;
       case TK_HTMLTAG:    
         {
           if (!g_token->endTag) // found a start tag
           {
             retval = handleHtmlStartTag(g_token->name,g_token->attribs);
           }
           else // found an end tag
           {
             retval = handleHtmlEndTag(g_token->name);
           }
           if (retval==RetVal_OK) 
           {
             // the command ended normally, keep scanner for new tokens.
             retval = 0;
           }
           else
           {
             goto endparagraph;
           }
         }
         break;
       case TK_SYMBOL:     
         {
           DocSymbol::SymType s = DocSymbol::decodeSymbol(g_token->name);
           if (s!=DocSymbol::Sym_Unknown)
           {
             m_children.append(new DocSymbol(this,s));
           }
           else
           {
             warn_doc_error(g_fileName,doctokenizerYYlineno,"Unsupported symbol %s found",
                 qPrint(g_token->name));
           }
           break;
         }
       case TK_NEWPARA:     
         retval=TK_NEWPARA;
         goto endparagraph;
       case TK_RCSTAG:
         {
           DocNode *n=parent();
           while (n && 
               n->kind()!=DocNode::Kind_SimpleSect && 
               n->kind()!=DocNode::Kind_ParamSect
               ) 
           {
             n=n->parent();
           }
           if (n)  // already in a simple section
           {
             // simple section cannot start in this paragraph, need
             // to unwind the stack and remember the command.
             g_token->simpleSectName = "rcs:"+g_token->name;
             g_token->simpleSectText = g_token->text;
             retval=RetVal_SimpleSec;
             goto endparagraph;
           }
 
           // see if we are in a simple list
           DocSimpleSect *ss=new DocSimpleSect(this,DocSimpleSect::Rcs);
           m_children.append(ss);
           ss->parseRcs();
         }
         break;
       default:
         warn_doc_error(g_fileName,doctokenizerYYlineno,
             "Found unexpected token (id=%x)\n",tok);
         break;
     }
   }
   retval=0;
 endparagraph:
   handlePendingStyleCommands(this,m_children);
   DocNode *n = g_nodeStack.pop();
   ASSERT(n==this);
   DBG(("DocPara::parse() end retval=%x\n",retval));
   INTERNAL_ASSERT(retval==0 || retval==TK_NEWPARA || retval==TK_LISTITEM || 
          retval==TK_ENDLIST || retval>RetVal_OK 
         );
 
   return retval; 
 }

Member Data Documentation

bool DocPara::m_isFirst

private

Definition at line 1152 of file docparser.h.

bool DocPara::m_isLast

private

Definition at line 1153 of file docparser.h.

QCString DocPara::m_sectionId

private

Definition at line 1151 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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation