/****************************************************************************** * * * * * Copyright (C) 1997-2002 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ #include #include #include #include #include #include #include #include #include #include "doxygen.h" #include "debug.h" #include "util.h" #include "page.h" #include "docparser.h" #include "doctokenizer.h" #include "cmdmapper.h" #include "printdocvisitor.h" #include "message.h" #define DBG(x) do {} while(0) //#define DBG(x) printf x #define INTERNAL_ASSERT(x) do {} while(0) //#define INTERNAL_ASSERT(x) if (!(x)) DBG(("INTERNAL_ASSERT(%s) failed retval=0x%x: file=%s line=%d\n",#x,retval,__FILE__,__LINE__)); //--------------------------------------------------------------------------- static const char *sectionLevelToName[] = { "page", "section", "subsection", "subsubsection", "paragraph" }; //--------------------------------------------------------------------------- // global variables during a call to validatingParseDoc static bool g_hasParamCommand; static MemberDef * g_memberDef; static QDict g_paramsFound; static bool g_isExample; // include file state static QString g_includeFileText; static uint g_includeFileOffset; static uint g_includeFileLength; // parser state static QString g_context; static bool g_inSeeBlock; static bool g_insideHtmlLink; static QStack g_nodeStack; static QStack g_styleStack; static QList g_copyStack; static QString g_fileName; struct DocParserContext { QString context; bool inSeeBlock; bool insideHtmlLink; QStack nodeStack; QStack styleStack; QList copyStack; MemberDef *memberDef; QString fileName; }; static QStack g_parserStack; //--------------------------------------------------------------------------- static void docParserPushContext() { doctokenizerYYpushContext(); DocParserContext *ctx = new DocParserContext; ctx->context = g_context; ctx->inSeeBlock = g_inSeeBlock; ctx->insideHtmlLink = g_insideHtmlLink; ctx->nodeStack = g_nodeStack; ctx->styleStack = g_styleStack; ctx->copyStack = g_copyStack; ctx->fileName = g_fileName; g_parserStack.push(ctx); } static void docParserPopContext() { DocParserContext *ctx = g_parserStack.pop(); g_context = ctx->context; g_inSeeBlock = ctx->inSeeBlock; g_insideHtmlLink = ctx->insideHtmlLink; g_nodeStack = ctx->nodeStack; g_styleStack = ctx->styleStack; g_copyStack = ctx->copyStack; g_fileName = ctx->fileName; delete ctx; doctokenizerYYpopContext(); } //--------------------------------------------------------------------------- /*! search for an image in the imageNameDict and if found * copies the image to the output directory (which is the * html directory if type==0 or the latex directory if type==1) */ static QCString findAndCopyImage(const char *fileName,DocImage::Type type) { QCString result; bool ambig; FileDef *fd; //printf("Search for %s\n",fileName); if ((fd=findFileDef(Doxygen::imageNameDict,fileName,ambig))) { QFile inImage(QString(fd->absFilePath().data())); if (inImage.open(IO_ReadOnly)) { result = fileName; int i; if ((i=result.findRev('/'))!=-1 || (i=result.findRev('\\'))!=-1) { result.right(result.length()-i-1); } QCString outputDir; switch(type) { case DocImage::Html: if (!Config_getBool("GENERATE_HTML")) return result; outputDir = Config_getString("HTML_OUTPUT"); break; case DocImage::Latex: if (!Config_getBool("GENERATE_LATEX")) return result; outputDir = Config_getString("LATEX_OUTPUT"); break; case DocImage::Rtf: if (!Config_getBool("GENERATE_RTF")) return result; outputDir = Config_getString("RTF_OUTPUT"); break; } QCString outputFile = outputDir+"/"+result; QFile outImage(QString(outputFile.data())); if (outImage.open(IO_WriteOnly)) // copy the image { char *buffer = new char[inImage.size()]; inImage.readBlock(buffer,inImage.size()); outImage.writeBlock(buffer,inImage.size()); outImage.flush(); delete buffer; } else { warn(g_fileName,doctokenizerYYlineno, "Warning: could not write output image %s",outputFile.data()); } } else { warn(g_fileName,doctokenizerYYlineno, "Warning: could not open image %s",fileName); } if (type==DocImage::Latex && Config_getBool("USE_PDFLATEX") && fd->name().right(4)==".eps" ) { // we have an .eps image in pdflatex mode => convert it to a pdf. QCString outputDir = Config_getString("LATEX_OUTPUT"); QCString baseName = fd->name().left(fd->name().length()-4); QCString epstopdfArgs(4096); epstopdfArgs.sprintf("\"%s/%s.eps\" --outfile=\"%s/%s.pdf\"", outputDir.data(), baseName.data(), outputDir.data(), baseName.data()); if (iSystem("epstopdf",epstopdfArgs,TRUE)!=0) { err("Error: Problems running epstopdf. Check your TeX installation!\n"); } return baseName; } } else if (ambig) { QCString text; text.sprintf("Warning: image file name %s is ambigious.\n",fileName); text+="Possible candidates:\n"; text+=showFileDefMatches(Doxygen::imageNameDict,fileName); warn(g_fileName,doctokenizerYYlineno,text); } else { result=fileName; if (result.left(5)!="http:" && result.left(6)!="https:") { warn(g_fileName,doctokenizerYYlineno, "Warning: image file %s is not found in IMAGE_PATH: " "assuming external image.",fileName ); } } return result; } static void checkArgumentName(const QString &name,bool isParam) { if (g_memberDef==0) return; // not a member ArgumentList *al=g_memberDef->isDocsForDefinition() ? g_memberDef->argumentList() : g_memberDef->declArgumentList(); if (al==0) return; // no argument list if (!Config_getBool("WARN_IF_UNDOCUMENTED")) return; static QRegExp re("[a-zA-Z0-9_]+\\.*"); int p=0,i=0,l; while ((i=re.match(name,p,&l))!=-1) { QString aName=name.mid(i,l); //printf("aName=%s\n",aName.data()); ArgumentListIterator ali(*al); Argument *a; bool found=FALSE; for (ali.toFirst();(a=ali.current());++ali) { QString argName = g_memberDef->isDefine() ? a->type : a->name; if (argName.right(3)=="...") argName=argName.left(argName.length()-3); if (aName==argName) { //printf("adding `%s'\n",aName.data()); g_paramsFound.insert(aName,(void *)(0x8)); found=TRUE; break; } } if (!found && isParam) { //printf("member type=%d\n",memberDef->memberType()); QString scope=g_memberDef->getScopeString(); if (!scope.isEmpty()) scope+="::"; else scope=""; warn(g_memberDef->docFile(),g_memberDef->docLine(), "Warning: argument `%s' of command @param " "is not found in the argument list of %s%s%s", aName.data(),scope.data(),g_memberDef->name().data(), argListToString(al).data() ); } p=i+l; } } static void checkUndocumentedParams() { if (g_memberDef && g_hasParamCommand && Config_getBool("WARN_IF_UNDOCUMENTED")) { ArgumentList *al=g_memberDef->isDocsForDefinition() ? g_memberDef->argumentList() : g_memberDef->declArgumentList(); if (al) { ArgumentListIterator ali(*al); Argument *a; bool found=FALSE; for (ali.toFirst();(a=ali.current());++ali) { QString argName = g_memberDef->isDefine() ? a->type : a->name; if (argName.right(3)=="...") argName=argName.left(argName.length()-3); if (!argName.isEmpty() && g_paramsFound.find(argName)==0 && a->docs.isEmpty()) { found = TRUE; break; } } if (found) { QString scope=g_memberDef->getScopeString(); if (!scope.isEmpty()) scope+="::"; else scope=""; warn(g_memberDef->docFile(),g_memberDef->docLine(), "Warning: The following parameters of " "%s%s%s are not documented:", scope.data(),g_memberDef->name().data(), argListToString(al).data()); for (ali.toFirst();(a=ali.current());++ali) { QString argName = g_memberDef->isDefine() ? a->type : a->name; if (!argName.isEmpty() && g_paramsFound.find(argName)==0) { warn_cont( " parameter %s\n",argName.data()); } } } } } } //--------------------------------------------------------------------------- static QString stripKnownExtensions(const char *text) { QString result=text; if (result.right(4)==".tex") { result=result.left(result.length()-4); } else if (result.right(Doxygen::htmlFileExtension.length())== QString(Doxygen::htmlFileExtension)) { result=result.left(result.length()-Doxygen::htmlFileExtension.length()); } return result; } //--------------------------------------------------------------------------- /*! Returns TRUE iff node n is a child of a preformatted node */ static bool insidePRE(DocNode *n) { while (n) { if (n->isPreformatted()) return TRUE; n=n->parent(); } return FALSE; } //--------------------------------------------------------------------------- /*! Returns TRUE iff node n is a child of a html list item node */ static bool insideLI(DocNode *n) { while (n) { if (n->kind()==DocNode::Kind_HtmlListItem) return TRUE; n=n->parent(); } return FALSE; } //--------------------------------------------------------------------------- /*! Returns TRUE iff node n is a child of a unordered html list node */ static bool insideUL(DocNode *n) { while (n) { if (n->kind()==DocNode::Kind_HtmlList && ((DocHtmlList *)n)->type()==DocHtmlList::Unordered) return TRUE; n=n->parent(); } return FALSE; } //--------------------------------------------------------------------------- /*! Returns TRUE iff node n is a child of a ordered html list node */ static bool insideOL(DocNode *n) { while (n) { if (n->kind()==DocNode::Kind_HtmlList && ((DocHtmlList *)n)->type()==DocHtmlList::Ordered) return TRUE; n=n->parent(); } return FALSE; } //--------------------------------------------------------------------------- /*! Returns TRUE iff node n is a child of a language node */ static bool insideLang(DocNode *n) { while (n) { if (n->kind()==DocNode::Kind_Language) return TRUE; n=n->parent(); } return FALSE; } //--------------------------------------------------------------------------- /*! Looks for a documentation block with name commandName in the current * context (g_context). The resulting documentation string is * put in pDoc, the definition in which the documentation was found is * put in pDef. * @retval TRUE if name was found. * @retval FALSE if name was not found. */ static bool findDocsForMemberOrCompound(const char *commandName, QString *pDoc, Definition **pDef) { *pDoc=""; *pDef=0; QString cmdArg=commandName; int l=cmdArg.length(); if (l==0) return FALSE; int funcStart=cmdArg.find('('); if (funcStart==-1) funcStart=l; //int lastScopeStart=cmdArg.findRev("::",funcStart); //int lastScopeEnd = lastScopeStart==-1 ? 0 : lastScopeStart+2; //QString scope=cmdArg.left(QMAX(lastScopeStart,0)); //QString name=cmdArg.mid(lastScopeEnd,funcStart-lastScopeEnd); QString name=cmdArg.left(funcStart); QString args=cmdArg.right(l-funcStart); // try if the link is to a member MemberDef *md=0; ClassDef *cd=0; FileDef *fd=0; NamespaceDef *nd=0; GroupDef *gd=0; PageInfo *pi=0; bool found = getDefs( g_context.find('.')==-1?g_context.latin1():"", // `find('.') is a hack to detect files name.latin1(), args.isEmpty()?0:args.latin1(), md,cd,fd,nd,gd,FALSE,0,TRUE); if (found && md) { *pDoc=md->documentation(); *pDef=md; return TRUE; } int scopeOffset=g_context.length(); do // for each scope { QString fullName=cmdArg; if (scopeOffset>0) { fullName.prepend(g_context.left(scopeOffset)+"::"); } //printf("Trying fullName=`%s'\n",fullName.data()); // try class, namespace, group, page, file reference cd = Doxygen::classSDict[fullName]; if (cd) // class { *pDoc=cd->documentation(); *pDef=cd; return TRUE; } nd = Doxygen::namespaceSDict[fullName]; if (nd) // namespace { *pDoc=nd->documentation(); *pDef=nd; return TRUE; } gd = Doxygen::groupSDict[cmdArg]; if (gd) // group { *pDoc=gd->documentation(); *pDef=gd; return TRUE; } pi = Doxygen::pageSDict->find(cmdArg); if (pi) // page { *pDoc=pi->doc; *pDef=(Definition *)pi; return TRUE; } bool ambig; fd = findFileDef(Doxygen::inputNameDict,cmdArg,ambig); if (fd && !ambig) // file { *pDoc=fd->documentation(); *pDef=fd; return TRUE; } if (scopeOffset==0) { scopeOffset=-1; } else { scopeOffset = g_context.findRev("::",scopeOffset-1); if (scopeOffset==-1) scopeOffset=0; } } while (scopeOffset>=0); return FALSE; } //--------------------------------------------------------------------------- // forward declaration static bool defaultHandleToken(DocNode *parent,int tok, QList &children,bool handleWord=TRUE); static int handleStyleArgument(DocNode *parent,QList &children, const QString &cmdName) { QString tokenName = g_token->name; int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return tok; } while ((tok=doctokenizerYYlex()) && tok!=TK_WHITESPACE && tok!=TK_NEWPARA && tok!=TK_LISTITEM && tok!=TK_ENDLIST ) { if (!defaultHandleToken(parent,tok,children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command \\%s as the argument of a \\%s command", tokenName.data(),cmdName.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", tokenName.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } return tok==TK_NEWPARA ? TK_NEWPARA : RetVal_OK; } static void handleStyleEnter(DocNode *parent,QList &children, DocStyleChange::Style s,const HtmlAttribList *attribs) { DBG(("HandleStyleEnter\n")); DocStyleChange *sc= new DocStyleChange(parent,g_nodeStack.count(),s,TRUE,attribs); children.append(sc); g_styleStack.push(sc); } static void handleStyleLeave(DocNode *parent,QList &children, DocStyleChange::Style s,const char *tagName) { DBG(("HandleStyleLeave\n")); if (g_styleStack.isEmpty() || // no style change g_styleStack.top()->style()!=s || // wrong style change g_styleStack.top()->position()!=g_nodeStack.count() // wrong position ) { warn(g_fileName,doctokenizerYYlineno,"Warning: found tag without matching <%s> in the same paragraph", tagName,tagName); } else // end the section { DocStyleChange *sc= new DocStyleChange(parent,g_nodeStack.count(),s,FALSE); children.append(sc); g_styleStack.pop(); } } static void handlePendingStyleCommands(DocNode *parent,QList &children) { if (!g_styleStack.isEmpty()) { DocStyleChange *sc = g_styleStack.top(); while (sc && sc->position()>=g_nodeStack.count()) { // there are unclosed style modifiers in the paragraph const char *cmd=""; switch (sc->style()) { case DocStyleChange::Bold: cmd = "b"; break; case DocStyleChange::Italic: cmd = "em"; break; case DocStyleChange::Code: cmd = "code"; break; case DocStyleChange::Center: cmd = "center"; break; case DocStyleChange::Small: cmd = "small"; break; case DocStyleChange::Subscript: cmd = "subscript"; break; case DocStyleChange::Superscript: cmd = "superscript"; break; case DocStyleChange::Preformatted: cmd = "pre"; break; } warn(g_fileName,doctokenizerYYlineno,"Warning: end of paragraph without end of style " "command ",cmd); children.append(new DocStyleChange(parent,g_nodeStack.count(),sc->style(),FALSE)); g_styleStack.pop(); sc = g_styleStack.top(); } } } static void handleLinkedWord(DocNode *parent,QList &children) { Definition *compound=0; MemberDef *member=0; QString name = g_token->name; if (name.at(0)=='#') name=name.right(name.length()-1); if (resolveRef(g_context,g_token->name,g_inSeeBlock,&compound,&member)) { if (member) // member link { children.append(new DocLinkedWord(parent,name, compound->getReference(), compound->getOutputFileBase(), member->anchor() ) ); } else // compound link { children.append(new DocLinkedWord(parent,name, compound->getReference(), compound->getOutputFileBase(), "" ) ); } } else // normal word { children.append(new DocWord(parent,g_token->name)); } } /* Helper function that deals with the most common tokens allowed in * title like sections. * @param parent Parent node, owner of the children list passed as * the third argument. * @param tok The token to process. * @param children The list of child nodes to which the node representing * the token can be added. * @param handleWord Indicates if word token should be processed * @retval TRUE The token was handled. * @retval FALSE The token was not handled. */ static bool defaultHandleToken(DocNode *parent,int tok, QList &children,bool handleWord) { 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",g_token->name.data())); } DBG(("\n")); QString tokenName = g_token->name; switch (tok) { case TK_COMMAND: switch (CmdMapper::map(tokenName)) { case CMD_BSLASH: children.append(new DocSymbol(parent,DocSymbol::BSlash)); break; case CMD_AT: children.append(new DocSymbol(parent,DocSymbol::At)); break; case CMD_LESS: children.append(new DocSymbol(parent,DocSymbol::Less)); break; case CMD_GREATER: children.append(new DocSymbol(parent,DocSymbol::Greater)); break; case CMD_AMP: children.append(new DocSymbol(parent,DocSymbol::Amp)); break; case CMD_DOLLAR: children.append(new DocSymbol(parent,DocSymbol::Dollar)); break; case CMD_HASH: children.append(new DocSymbol(parent,DocSymbol::Hash)); break; case CMD_PERCENT: children.append(new DocSymbol(parent,DocSymbol::Percent)); break; case CMD_EMPHASIS: { children.append(new DocStyleChange(parent,g_nodeStack.count(),DocStyleChange::Italic,TRUE)); int retval=handleStyleArgument(parent,children,tokenName); children.append(new DocStyleChange(parent,g_nodeStack.count(),DocStyleChange::Italic,FALSE)); children.append(new DocWhiteSpace(parent," ")); if (retval==TK_NEWPARA) goto handlepara; } break; case CMD_BOLD: { children.append(new DocStyleChange(parent,g_nodeStack.count(),DocStyleChange::Bold,TRUE)); int retval=handleStyleArgument(parent,children,tokenName); children.append(new DocStyleChange(parent,g_nodeStack.count(),DocStyleChange::Bold,FALSE)); children.append(new DocWhiteSpace(parent," ")); if (retval==TK_NEWPARA) goto handlepara; } break; case CMD_CODE: { children.append(new DocStyleChange(parent,g_nodeStack.count(),DocStyleChange::Code,TRUE)); int retval=handleStyleArgument(parent,children,tokenName); children.append(new DocStyleChange(parent,g_nodeStack.count(),DocStyleChange::Code,FALSE)); children.append(new DocWhiteSpace(parent," ")); if (retval==TK_NEWPARA) goto handlepara; } break; case CMD_HTMLONLY: { doctokenizerYYsetStateHtmlOnly(); int retval = doctokenizerYYlex(); children.append(new DocVerbatim(parent,g_context,g_token->verb,DocVerbatim::HtmlOnly,g_isExample,g_fileName)); if (retval==0) warn(g_fileName,doctokenizerYYlineno,"Warning: htmlonly section ended without end marker"); doctokenizerYYsetStatePara(); } break; case CMD_LATEXONLY: { doctokenizerYYsetStateLatexOnly(); int retval = doctokenizerYYlex(); children.append(new DocVerbatim(parent,g_context,g_token->verb,DocVerbatim::LatexOnly,g_isExample,g_fileName)); if (retval==0) warn(g_fileName,doctokenizerYYlineno,"Warning: latexonly section ended without end marker",doctokenizerYYlineno); doctokenizerYYsetStatePara(); } break; case CMD_FORMULA: { DocFormula *form=new DocFormula(parent,g_token->id); children.append(form); } break; case CMD_ANCHOR: { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", tokenName.data()); break; } tok=doctokenizerYYlex(); if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s",tokenName.data()); break; } else if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),tokenName.data()); break; } DocAnchor *anchor = new DocAnchor(parent,g_token->name,FALSE); children.append(anchor); } break; case CMD_INTERNALREF: { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", tokenName.data()); break; } doctokenizerYYsetStateInternalRef(); tok=doctokenizerYYlex(); // get the reference id DocInternalRef *ref=0; if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),tokenName.data()); doctokenizerYYsetStatePara(); break; } ref = new DocInternalRef(parent,g_token->name); children.append(ref); ref->parse(); doctokenizerYYsetStatePara(); } break; default: return FALSE; } break; case TK_HTMLTAG: { switch (HtmlTagMapper::map(tokenName)) { case HTML_BOLD: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Bold,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Bold,tokenName); } break; case HTML_PRE: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Preformatted,&g_token->attribs); parent->setInsidePreformatted(TRUE); doctokenizerYYsetInsidePre(TRUE); } else { handleStyleLeave(parent,children,DocStyleChange::Preformatted,tokenName); parent->setInsidePreformatted(FALSE); doctokenizerYYsetInsidePre(FALSE); } break; case HTML_CODE: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Code,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Code,tokenName); } break; case HTML_EMPHASIS: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Italic,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Italic,tokenName); } break; case HTML_SUB: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Subscript,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Subscript,tokenName); } break; case HTML_SUP: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Superscript,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Superscript,tokenName); } break; case HTML_CENTER: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Center,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Center,tokenName); } break; case HTML_SMALL: if (!g_token->endTag) { handleStyleEnter(parent,children,DocStyleChange::Small,&g_token->attribs); } else { handleStyleLeave(parent,children,DocStyleChange::Small,tokenName); } break; default: return FALSE; break; } } break; case TK_SYMBOL: { char letter='\0'; DocSymbol::SymType s = DocSymbol::decodeSymbol(tokenName,&letter); if (s!=DocSymbol::Unknown) { children.append(new DocSymbol(parent,s,letter)); } else { return FALSE; } } break; case TK_WHITESPACE: case TK_NEWPARA: handlepara: if (insidePRE(parent) || !children.isEmpty()) { children.append(new DocWhiteSpace(parent,g_token->chars)); } break; case TK_LNKWORD: if (handleWord) { handleLinkedWord(parent,children); } else return FALSE; break; case TK_WORD: if (handleWord) { children.append(new DocWord(parent,g_token->name)); } else return FALSE; break; case TK_URL: children.append(new DocURL(parent,g_token->name,g_token->isEMailAddr)); break; default: return FALSE; } return TRUE; } //--------------------------------------------------------------------------- DocSymbol::SymType DocSymbol::decodeSymbol(const QString &symName,char *letter) { int l=symName.length(); DBG(("decodeSymbol(%s) l=%d\n",symName.data(),l)); if (symName=="©") return DocSymbol::Copy; else if (symName=="<") return DocSymbol::Less; else if (symName==">") return DocSymbol::Greater; else if (symName=="&") return DocSymbol::Amp; else if (symName=="'") return DocSymbol::Apos; else if (symName==""") return DocSymbol::Quot; else if (symName=="ß") return DocSymbol::Szlig; else if (symName==" ") return DocSymbol::Nbsp; else if (l==6 && symName.right(4)=="uml;") { *letter=symName.at(1); return DocSymbol::Uml; } else if (l==8 && symName.right(6)=="acute;") { *letter=symName.at(1); return DocSymbol::Acute; } else if (l==8 && symName.right(6)=="grave;") { *letter=symName.at(1); return DocSymbol::Grave; } else if (l==7 && symName.right(5)=="circ;") { *letter=symName.at(1); return DocSymbol::Circ; } else if (l==8 && symName.right(6)=="tilde;") { *letter=symName.at(1); return DocSymbol::Tilde; } else if (l==8 && symName.right(6)=="cedil;") { *letter=symName.at(1); return DocSymbol::Cedil; } else if (l==7 && symName.right(5)=="ring;") { *letter=symName.at(1); return DocSymbol::Ring; } return DocSymbol::Unknown; } //--------------------------------------------------------------------------- static int internalValidatingParseDoc(DocNode *parent,QList &children, const QString &doc) { int retval = RetVal_OK; doctokenizerYYinit(doc,g_fileName); // first parse any number of paragraphs bool isFirst=FALSE; DocPara *lastPar=0; do { DocPara *par = new DocPara(parent); if (isFirst) { par->markFirst(); isFirst=FALSE; } retval=par->parse(); if (!par->isEmpty()) { children.append(par); lastPar=par; } else { delete par; } } while (retval==TK_NEWPARA); if (lastPar) lastPar->markLast(); return retval; } //--------------------------------------------------------------------------- static void readTextFileByName(const QString &file,QString &text) { bool ambig; FileDef *fd; if ((fd=findFileDef(Doxygen::exampleNameDict,file,ambig))) { text = fileToString(fd->absFilePath(),Config_getBool("FILTER_SOURCE_FILES")); } else if (ambig) { warn(g_fileName,doctokenizerYYlineno,"Warning: included file name %s is ambigious" "Possible candidates:\n%s",file.data(), showFileDefMatches(Doxygen::exampleNameDict,file).data() ); } else { warn(g_fileName,doctokenizerYYlineno,"Warning: included file %s is not found" "Check you EXAMPLE_PATH",file.data()); } } //--------------------------------------------------------------------------- DocAnchor::DocAnchor(DocNode *parent,const QString &id,bool newAnchor) : m_parent(parent) { if (id.isEmpty()) { warn(g_fileName,doctokenizerYYlineno,"Warning: Empty anchor label"); } if (newAnchor) // found { m_anchor = id; } else // found \anchor label { SectionInfo *sec = Doxygen::sectionDict[id]; if (sec) { m_file = sec->fileName; m_anchor = sec->label; } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Invalid anchor id `%s'",id.data()); } } } //--------------------------------------------------------------------------- void DocInclude::parse() { switch(m_type) { case Include: // fall through case DontInclude: readTextFileByName(m_file,m_text); g_includeFileText = m_text; g_includeFileOffset = 0; g_includeFileLength = m_text.length(); break; case VerbInclude: // fall through case HtmlInclude: readTextFileByName(m_file,m_text); break; } } //--------------------------------------------------------------------------- void DocIncOperator::parse() { const char *p = g_includeFileText; uint l = g_includeFileLength; uint o = g_includeFileOffset; //printf("DocIncOperator::parse() text=%s off=%d len=%d\n",p,o,l); uint so = o,bo; bool nonEmpty = FALSE; switch(type()) { case Line: while (oname(); g_styleStack.clear(); g_nodeStack.clear(); g_copyStack.append(def); internalValidatingParseDoc(this,m_children,doc); ASSERT(g_copyStack.remove(def)); ASSERT(g_styleStack.isEmpty()); ASSERT(g_nodeStack.isEmpty()); docParserPopContext(); } else // oops, recursion { warn(g_fileName,doctokenizerYYlineno,"Warning: recursive call chain of \\copydoc commands detected at %d\n", doctokenizerYYlineno); } } else { warn(g_fileName,doctokenizerYYlineno,"Warning: target %s of \\copydoc command not found", m_link.data()); } } //--------------------------------------------------------------------------- void DocXRefItem::parse() { QString listName; switch(m_type) { case Bug: listName="bug"; break; case Test: listName="test"; break; case Todo: listName="todo"; break; case Deprecated: listName="deprecated"; break; } RefList *refList = Doxygen::specialLists->find(listName); if (Config_getBool(refList->optionName())) // list is enabled { RefItem *item = refList->getRefItem(m_id); ASSERT(item!=0); m_file = refList->listName(); m_anchor = item->listAnchor; m_title = refList->sectionTitle(); if (!item->text.isEmpty()) { docParserPushContext(); internalValidatingParseDoc(this,m_children,item->text); docParserPopContext(); } } } //--------------------------------------------------------------------------- DocFormula::DocFormula(DocNode *parent,int id) : m_parent(parent) { QString formCmd; formCmd.sprintf("\\form#%d",id); Formula *formula=Doxygen::formulaNameDict[formCmd]; if (formula) { m_id = formula->getId(); m_name.sprintf("form_%d",m_id); m_text = formula->getFormulaText(); } } //--------------------------------------------------------------------------- int DocLanguage::parse() { int retval; DBG(("DocLanguage::parse() start\n")); g_nodeStack.push(this); // parse one or more paragraphs bool isFirst=TRUE; DocPara *par=0; do { par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } m_children.append(par); retval=par->parse(); } while (retval==TK_NEWPARA); if (par) par->markLast(); DBG(("DocLanguage::parse() end\n")); DocNode *n = g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- void DocSecRefItem::parse() { DBG(("DocSecRefItem::parse() start\n")); g_nodeStack.push(this); doctokenizerYYsetStateTitle(); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\refitem", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } doctokenizerYYsetStatePara(); handlePendingStyleCommands(this,m_children); SectionInfo *sec=0; if (!m_target.isEmpty()) { sec=Doxygen::sectionDict[m_target]; if (sec) { m_file = sec->fileName; m_anchor = sec->label; } else { warn(g_fileName,doctokenizerYYlineno,"Warning reference to unknown section %s", m_target.data()); } } else { warn(g_fileName,doctokenizerYYlineno,"Warning reference to empty target"); } DBG(("DocSecRefItem::parse() end\n")); DocNode *n = g_nodeStack.pop(); ASSERT(n==this); } //--------------------------------------------------------------------------- void DocSecRefList::parse() { DBG(("DocSecRefList::parse() start\n")); g_nodeStack.push(this); int tok=doctokenizerYYlex(); // skip white space while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=doctokenizerYYlex(); // handle items while (tok) { if (tok==TK_COMMAND) { switch (CmdMapper::map(g_token->name)) { case CMD_SECREFITEM: { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after \\refitem command"); break; } tok=doctokenizerYYlex(); if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of \\refitem", tokToString(tok)); break; } DocSecRefItem *item = new DocSecRefItem(this,g_token->name); m_children.append(item); item->parse(); } break; case CMD_ENDSECREFLIST: goto endsecreflist; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\secreflist", g_token->name.data()); goto endsecreflist; } } else if (tok==TK_WHITESPACE) { // ignore whitespace } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s inside section reference list", tokToString(tok)); goto endsecreflist; } tok=doctokenizerYYlex(); } endsecreflist: DBG(("DocSecRefList::parse() end\n")); DocNode *n = g_nodeStack.pop(); ASSERT(n==this); } //--------------------------------------------------------------------------- DocInternalRef::DocInternalRef(DocNode *parent,const QString &ref) : m_parent(parent) { int i=ref.find('#'); if (i!=-1) { m_anchor = ref.right(ref.length()-i-1); m_file = ref.left(i); } else { m_file = ref; } } void DocInternalRef::parse() { g_nodeStack.push(this); DBG(("DocInternalRef::parse() start\n")); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\ref", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } handlePendingStyleCommands(this,m_children); DBG(("DocInternalRef::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); } //--------------------------------------------------------------------------- DocRef::DocRef(DocNode *parent,const QString &target) : m_parent(parent), m_refToSection(FALSE), m_refToAnchor(FALSE) { Definition *compound = 0; PageInfo *pageInfo = 0; QCString anchor; ASSERT(!target.isEmpty()); SectionInfo *sec = Doxygen::sectionDict[target]; if (sec) // ref to section or anchor { m_text = sec->title; if (m_text.isEmpty()) m_text = sec->label; m_ref = sec->ref; m_file = stripKnownExtensions(sec->fileName); if (sec->type!=SectionInfo::Page) m_anchor = sec->label; m_refToAnchor = sec->type==SectionInfo::Anchor; m_refToSection = sec->type!=SectionInfo::Anchor; } else if (resolveLink(g_context,target,TRUE,&compound,&pageInfo,anchor)) { m_text = target; m_anchor = anchor; if (pageInfo) // ref to page { m_file = pageInfo->getOutputFileBase(); m_ref = pageInfo->getReference(); } else if (compound) // ref to compound { if (anchor.isEmpty() && /* compound link */ compound->definitionType()==Definition::TypeGroup && /* is group */ ((GroupDef *)compound)->groupTitle() /* with title */ ) { m_text=((GroupDef *)compound)->groupTitle(); // use group's title as l } m_file = compound->getOutputFileBase(); m_ref = compound->getReference(); } else { err("%s:%d: Internal error: resolveLink successful but no compound found!\n",__FILE__,__LINE__); } } else // oops, bogus target { warn(g_fileName,doctokenizerYYlineno,"Warning: unable to resolve reference to `%s' for \\ref command", target.data()); } } void DocRef::parse() { g_nodeStack.push(this); DBG(("DocRef::parse() start\n")); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\ref", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } handlePendingStyleCommands(this,m_children); DBG(("DocRef::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); } //--------------------------------------------------------------------------- DocLink::DocLink(DocNode *parent,const QString &target) : m_parent(parent) { Definition *compound; PageInfo *page; QCString anchor; m_refText = target; if (!m_refText.isEmpty() && m_refText.at(0)=='#') { m_refText = m_refText.right(m_refText.length()-1); } if (resolveLink(g_context,stripKnownExtensions(target),g_inSeeBlock, &compound,&page,anchor)) { m_anchor = anchor; if (compound) { m_file = compound->getOutputFileBase(); m_ref = compound->getReference(); } else if (page) { m_file = page->getOutputFileBase(); m_ref = page->getReference(); } } else // oops, bogus target { warn(g_fileName,doctokenizerYYlineno,"Warning: unable to resolve link to `%s' for \\link command", target.data()); } } QString DocLink::parse(bool isJavaLink) { QString result; g_nodeStack.push(this); DBG(("DocLink::parse() start\n")); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children,FALSE)) { switch (tok) { case TK_COMMAND: switch (CmdMapper::map(g_token->name)) { case CMD_ENDLINK: if (isJavaLink) { warn(g_fileName,doctokenizerYYlineno,"Warning: {@link.. ended with @endlink command"); } goto endlink; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\link", g_token->name.data()); break; } break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; case TK_LNKWORD: case TK_WORD: if (isJavaLink) // special case to detect closing } { QString w = g_token->name; int p; if (w=="}") { goto endlink; } else if ((p=w.find('}'))!=-1) { uint l=w.length(); m_children.append(new DocWord(this,w.left(p))); if ((uint)pname)); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected end of comment while inside" " link command\n"); } endlink: if (isJavaLink) { if (m_children.isEmpty()) // no link text { m_children.append(new DocWord(this,m_refText)); } } handlePendingStyleCommands(this,m_children); DBG(("DocLink::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return result; } //--------------------------------------------------------------------------- void DocDotFile::parse() { g_nodeStack.push(this); DBG(("DocDotFile::parse() start\n")); doctokenizerYYsetStateTitle(); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\dotfile", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } tok=doctokenizerYYlex(); while (tok==TK_WORD) // there are values following the title { if (g_token->name=="width") { m_width=g_token->chars; } else if (g_token->name=="height") { m_height=g_token->chars; } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unknown option %s after image title", g_token->name.data()); } tok=doctokenizerYYlex(); } ASSERT(tok==0); doctokenizerYYsetStatePara(); handlePendingStyleCommands(this,m_children); bool ambig; FileDef *fd = findFileDef(Doxygen::dotFileNameDict,m_name,ambig); if (fd) { m_file = fd->absFilePath(); } else if (ambig) { warn(g_fileName,doctokenizerYYlineno,"Warning: included dot file name %s is ambigious.\n" "Possible candidates:\n%s",m_name.data(), showFileDefMatches(Doxygen::exampleNameDict,m_name).data() ); } else { warn(g_fileName,doctokenizerYYlineno,"Warning: included dot file %s is not found " "in any of the paths specified via DOTFILE_DIRS!",m_name.data()); } DBG(("DocDotFile::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); } //--------------------------------------------------------------------------- void DocImage::parse() { g_nodeStack.push(this); DBG(("DocImage::parse() start\n")); doctokenizerYYsetStateTitle(); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a \\image", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } tok=doctokenizerYYlex(); while (tok==TK_WORD) // there are values following the title { if (g_token->name=="width") { m_width=g_token->chars; } else if (g_token->name=="height") { m_height=g_token->chars; } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unknown option %s after image title", g_token->name.data()); } tok=doctokenizerYYlex(); } ASSERT(tok==0); doctokenizerYYsetStatePara(); handlePendingStyleCommands(this,m_children); DBG(("DocImage::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); } //--------------------------------------------------------------------------- int DocHtmlHeader::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocHtmlHeader::parse() start\n")); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a tag", g_token->name.data(),m_level); break; case TK_HTMLTAG: { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_H1 && g_token->endTag) // found tag { if (m_level!=1) { warn(g_fileName,doctokenizerYYlineno,"Warning: ended with ", m_level); } goto endheader; } else if (tagId==HTML_H2 && g_token->endTag) // found tag { if (m_level!=2) { warn(g_fileName,doctokenizerYYlineno,"Warning: ended with ", m_level); } goto endheader; } else if (tagId==HTML_H3 && g_token->endTag) // found tag { if (m_level!=3) { warn(g_fileName,doctokenizerYYlineno,"Warning: ended with ", m_level); } goto endheader; } else if (tagId==HTML_H4 && g_token->endTag) // found tag { if (m_level!=4) { warn(g_fileName,doctokenizerYYlineno,"Warning: ended with ", m_level); } goto endheader; } else if (tagId==HTML_H5 && g_token->endTag) // found tag { if (m_level!=5) { warn(g_fileName,doctokenizerYYlineno,"Warning: ended with ", m_level); } goto endheader; } else if (tagId==HTML_H6 && g_token->endTag) // found tag { if (m_level!=6) { warn(g_fileName,doctokenizerYYlineno,"Warning: ended with ", m_level); } goto endheader; } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected html tag <%s%s> found within context", g_token->endTag?"/":"",g_token->name.data(),m_level); } } break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected end of comment while inside" " tag\n",m_level); } endheader: handlePendingStyleCommands(this,m_children); DBG(("DocHtmlHeader::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHRef::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocHRef::parse() start\n")); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a .. block", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; case TK_HTMLTAG: { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_A && g_token->endTag) // found tag { goto endhref; } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected html tag <%s%s> found within context", g_token->endTag?"/":"",g_token->name.data(),doctokenizerYYlineno); } } break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok),doctokenizerYYlineno); break; } } } if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected end of comment while inside" " tag",doctokenizerYYlineno); } endhref: handlePendingStyleCommands(this,m_children); DBG(("DocHRef::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocInternal::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocInternal::parse() start\n")); // first parse any number of paragraphs bool isFirst=FALSE; DocPara *lastPar=0; do { DocPara *par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } retval=par->parse(); if (!par->isEmpty()) { m_children.append(par); lastPar=par; } else { delete par; } if (retval==TK_LISTITEM) { warn(g_fileName,doctokenizerYYlineno,"Warning: Invalid list item found",doctokenizerYYlineno); } } while (retval!=0 && retval!=RetVal_Section); if (lastPar) lastPar->markLast(); // then parse any number of level1 sections while (retval==RetVal_Section) { //SectionInfo *sec=Doxygen::sectionDict[g_token->sectionId]; //int secLev = sec->type==SectionInfo::Subsection ? 2 : 1; //if (secLev!=1) // wrong level //{ // warn(g_fileName,doctokenizerYYlineno,"Warning: Expected level 1 section, found a section with level %d.",secLev); // break; //} //else //{ DocSection *s=new DocSection(this,1,g_token->sectionId); m_children.append(s); retval = s->parse(); //} } if (retval==RetVal_Internal) { warn(g_fileName,doctokenizerYYlineno,"Warning: \\internal command found inside internal section"); } DBG(("DocInternal::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocIndexEntry::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocIndexEntry::parse() start\n")); int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after \\addindex command"); goto endindexentry; } m_entry=""; while ((tok=doctokenizerYYlex()) && tok!=TK_WHITESPACE && tok!=TK_NEWPARA) { switch (tok) { case TK_WORD: case TK_LNKWORD: m_entry+=g_token->name; break; case TK_SYMBOL: { char letter='\0'; DocSymbol::SymType s = DocSymbol::decodeSymbol(g_token->name,&letter); switch (s) { case DocSymbol::BSlash: m_entry+='\\'; break; case DocSymbol::At: m_entry+='@'; break; case DocSymbol::Less: m_entry+='<'; break; case DocSymbol::Greater: m_entry+='>'; break; case DocSymbol::Amp: m_entry+='&'; break; case DocSymbol::Dollar: m_entry+='$'; break; case DocSymbol::Hash: m_entry+='#'; break; case DocSymbol::Percent: m_entry+='%'; break; case DocSymbol::Apos: m_entry+='\''; break; case DocSymbol::Quot: m_entry+='"'; break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected symbol found as argument of \\addindex"); break; } } break; case TK_COMMAND: switch (CmdMapper::map(g_token->name)) { case CMD_BSLASH: m_entry+='\\'; break; case CMD_AT: m_entry+='@'; break; case CMD_LESS: m_entry+='<'; break; case CMD_GREATER: m_entry+='>'; break; case CMD_AMP: m_entry+='&'; break; case CMD_DOLLAR: m_entry+='$'; break; case CMD_HASH: m_entry+='#'; break; case CMD_PERCENT: m_entry+='%'; break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected command %s found as argument of \\addindex", g_token->name.data()); break; } break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } if (tok!=TK_WHITESPACE) retval=tok; endindexentry: DBG(("DocIndexEntry::parse() end retval=%x\n",retval)); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHtmlCaption::parse() { 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(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a tag", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; case TK_HTMLTAG: { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_CAPTION && g_token->endTag) // found tag { retval = RetVal_OK; goto endcaption; } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected html tag <%s%s> found within context", g_token->endTag?"/":"",g_token->name.data()); } } break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected end of comment while inside" " tag",doctokenizerYYlineno); } endcaption: handlePendingStyleCommands(this,m_children); DBG(("DocHtmlCaption::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHtmlCell::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocHtmlCell::parse() start\n")); // parse one or more paragraphs bool isFirst=FALSE; DocPara *par=0; do { par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } m_children.append(par); retval=par->parse(); } while (retval==TK_NEWPARA); if (par) par->markLast(); DBG(("DocHtmlCell::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHtmlRow::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocHtmlRow::parse() start\n")); bool isHeading=FALSE; bool isFirst=TRUE; DocHtmlCell *cell=0; // get next token int tok=doctokenizerYYlex(); // skip whitespace while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=doctokenizerYYlex(); // should find a html tag now if (tok==TK_HTMLTAG) { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_TD && !g_token->endTag) // found tag { } else if (tagId==HTML_TH && !g_token->endTag) // found tag { isHeading=TRUE; } else // found some other tag { warn(g_fileName,doctokenizerYYlineno,"Warning: expected or tag but " "found <%s> instead!",g_token->name.data()); goto endrow; } } else if (tok==0) // premature end of comment { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment while looking" " for a html description title"); goto endrow; } else // token other than html token { warn(g_fileName,doctokenizerYYlineno,"Warning: expected or tag but found %s token instead!", tokToString(tok)); goto endrow; } // parse one or more cells do { cell=new DocHtmlCell(this,g_token->attribs,isHeading); cell->markFirst(isFirst); isFirst=FALSE; m_children.append(cell); retval=cell->parse(); isHeading = retval==RetVal_TableHCell; } while (retval==RetVal_TableCell || retval==RetVal_TableHCell); if (cell) cell->markLast(TRUE); endrow: DBG(("DocHtmlRow::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHtmlTable::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocHtmlTable::parse() start\n")); getrow: // get next token int tok=doctokenizerYYlex(); // skip whitespace while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=doctokenizerYYlex(); // should find a html tag now if (tok==TK_HTMLTAG) { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_TR && !g_token->endTag) // found tag { // no caption, just rows retval=RetVal_TableRow; } else if (tagId==HTML_CAPTION && !g_token->endTag) // found tag { if (m_caption) { warn(g_fileName,doctokenizerYYlineno,"Warning: table already has a caption, found another one"); } else { m_caption = new DocHtmlCaption(this,g_token->attribs); retval=m_caption->parse(); if (retval==RetVal_OK) // caption was parsed ok { goto getrow; } } } else // found wrong token { warn(g_fileName,doctokenizerYYlineno,"Warning: expected or tag but " "found <%s%s> instead!", g_token->endTag ? "/" : "", g_token->name.data()); } } else if (tok==0) // premature end of comment { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment while looking" " for a or tag"); } else // token other than html token { warn(g_fileName,doctokenizerYYlineno,"Warning: expected tag but found %s token instead!", tokToString(tok)); } // parse one or more rows while (retval==RetVal_TableRow) { DocHtmlRow *tr=new DocHtmlRow(this,g_token->attribs); m_children.append(tr); retval=tr->parse(); } DBG(("DocHtmlTable::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval==RetVal_EndTable ? RetVal_OK : retval; } //--------------------------------------------------------------------------- int DocHtmlDescTitle::parse() { int retval=0; g_nodeStack.push(this); DBG(("DocHtmlDescTitle::parse() start\n")); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a
tag", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; case TK_HTMLTAG: { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_DD && !g_token->endTag) // found
tag { retval = RetVal_DescData; goto endtitle; } else if (tagId==HTML_DT && g_token->endTag) { // ignore tag. } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected html tag <%s%s> found within
context", g_token->endTag?"/":"",g_token->name.data()); } } break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected end of comment while inside" "
tag"); } endtitle: handlePendingStyleCommands(this,m_children); DBG(("DocHtmlDescTitle::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHtmlDescData::parse() { m_attribs = g_token->attribs; int retval=0; g_nodeStack.push(this); DBG(("DocHtmlDescData::parse() start\n")); bool isFirst=FALSE; DocPara *par=0; do { par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } m_children.append(par); retval=par->parse(); } while (retval==TK_NEWPARA); if (par) par->markLast(); DBG(("DocHtmlDescData::parse() end\n")); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //--------------------------------------------------------------------------- int DocHtmlDescList::parse() { int retval=RetVal_OK; g_nodeStack.push(this); DBG(("DocHtmlDescList::parse() start\n")); // get next token int tok=doctokenizerYYlex(); // skip whitespace while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=doctokenizerYYlex(); // should find a html tag now if (tok==TK_HTMLTAG) { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_DT && !g_token->endTag) // found
tag { // continue } else // found some other tag { warn(g_fileName,doctokenizerYYlineno,"Warning: expected
tag but " "found <%s> instead!",g_token->name.data()); goto enddesclist; } } else if (tok==0) // premature end of comment { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment while looking" " for a html description title"); goto enddesclist; } else // token other than html token { warn(g_fileName,doctokenizerYYlineno,"Warning: expected
tag but found %s token instead!", tokToString(tok)); goto enddesclist; } do { DocHtmlDescTitle *dt=new DocHtmlDescTitle(this,g_token->attribs); m_children.append(dt); DocHtmlDescData *dd=new DocHtmlDescData(this); m_children.append(dd); retval=dt->parse(); if (retval==RetVal_DescData) { retval=dd->parse(); } else { // error break; } } while (retval==RetVal_DescTitle); if (retval==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment while inside
block"); } enddesclist: DocNode *n=g_nodeStack.pop(); ASSERT(n==this); DBG(("DocHtmlDescList::parse() end\n")); return retval==RetVal_EndDesc ? RetVal_OK : retval; } //--------------------------------------------------------------------------- #if 0 int DocHtmlPre::parse() { int rv; g_nodeStack.push(this); bool isFirst=FALSE; DocPara *par=0; do { par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } m_children.append(par); rv=par->parse(); } while (rv==TK_NEWPARA); if (par) par->markLast(); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return rv==RetVal_EndPre ? RetVal_OK : rv; } #endif //--------------------------------------------------------------------------- int DocHtmlListItem::parse() { DBG(("DocHtmlListItem::parse() start\n")); int retval=0; g_nodeStack.push(this); // parse one or more paragraphs bool isFirst=FALSE; DocPara *par=0; do { par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } m_children.append(par); retval=par->parse(); } while (retval==TK_NEWPARA); if (par) par->markLast(); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); DBG(("DocHtmlListItem::parse() end retval=%x\n",retval)); return retval; } //--------------------------------------------------------------------------- int DocHtmlList::parse() { DBG(("DocHtmlList::parse() start\n")); int retval=RetVal_OK; int num=1; g_nodeStack.push(this); // get next token int tok=doctokenizerYYlex(); // skip whitespace and paragraph breaks while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=doctokenizerYYlex(); // should find a html tag now if (tok==TK_HTMLTAG) { int tagId=HtmlTagMapper::map(g_token->name); if (tagId==HTML_LI && !g_token->endTag) // found
  • tag { // ok, we can go on. } else // found some other tag { warn(g_fileName,doctokenizerYYlineno,"Warning: expected
  • tag but " "found <%s> instead!",g_token->name.data()); goto endlist; } } else if (tok==0) // premature end of comment { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment while looking" " for a html list item"); goto endlist; } else // token other than html token { warn(g_fileName,doctokenizerYYlineno,"Warning: expected
  • tag but found %s token instead!", tokToString(tok)); goto endlist; } do { DocHtmlListItem *li=new DocHtmlListItem(this,g_token->attribs,num++); m_children.append(li); retval=li->parse(); } while (retval==RetVal_ListItem); if (retval==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment while inside <%cl> block", m_type==Unordered ? 'u' : 'o'); } endlist: DBG(("DocHtmlList::parse() end retval=%x\n",retval)); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval==RetVal_EndList ? RetVal_OK : retval; } //--------------------------------------------------------------------------- int DocSimpleListItem::parse() { g_nodeStack.push(this); int rv=m_paragraph->parse(); m_paragraph->markFirst(); m_paragraph->markLast(); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return rv; } //-------------------------------------------------------------------------- int DocSimpleList::parse() { g_nodeStack.push(this); int rv; do { DocSimpleListItem *li=new DocSimpleListItem(this); m_children.append(li); rv=li->parse(); } while (rv==RetVal_ListItem); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return (rv!=TK_NEWPARA) ? rv : RetVal_OK; } //-------------------------------------------------------------------------- int DocAutoListItem::parse() { int retval = RetVal_OK; g_nodeStack.push(this); retval=m_paragraph->parse(); m_paragraph->markFirst(); m_paragraph->markLast(); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //-------------------------------------------------------------------------- int DocAutoList::parse() { int retval = RetVal_OK; int num=1; g_nodeStack.push(this); // first item or sub list => create new list do { DocAutoListItem *li = new DocAutoListItem(this,num++); m_children.append(li); retval=li->parse(); } while (retval==TK_LISTITEM && // new list item m_indent==g_token->indent && // at same indent level m_isEnumList==g_token->isEnumList // of the same kind ); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //-------------------------------------------------------------------------- void DocTitle::parse() { DBG(("DocTitle::parse() start\n")); g_nodeStack.push(this); doctokenizerYYsetStateTitle(); int tok; while ((tok=doctokenizerYYlex())) { if (!defaultHandleToken(this,tok,m_children)) { switch (tok) { case TK_COMMAND: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal command %s as part of a title section", g_token->name.data()); break; case TK_SYMBOL: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } } doctokenizerYYsetStatePara(); handlePendingStyleCommands(this,m_children); DBG(("DocTitle::parse() end\n")); DocNode *n = g_nodeStack.pop(); ASSERT(n==this); } //-------------------------------------------------------------------------- DocSimpleSect::DocSimpleSect(DocNode *parent,Type t) : m_parent(parent), m_type(t) { m_title=0; } DocSimpleSect::~DocSimpleSect() { delete m_title; } void DocSimpleSect::accept(DocVisitor *v) { v->visitPre(this); if (m_title) m_title->accept(v); QListIterator cli(m_children); DocNode *n; for (cli.toFirst();(n=cli.current());++cli) n->accept(v); v->visitPost(this); } int DocSimpleSect::parse(bool userTitle) { DBG(("DocSimpleSect::parse() start\n")); g_nodeStack.push(this); // handle case for user defined title if (userTitle) { m_title = new DocTitle(this); m_title->parse(); } // add new paragraph as child DocPara *par = new DocPara(this); if (m_children.isEmpty()) { par->markFirst(); } else { ASSERT(m_children.last()->kind()==DocNode::Kind_Para); ((DocPara *)m_children.last())->markLast(FALSE); } par->markLast(); m_children.append(par); // parse the contents of the paragraph int retval = par->parse(); DBG(("DocSimpleSect::parse() end retval=%d\n",retval)); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; // 0==EOF, TK_NEWPARA, TK_LISTITEM, TK_ENDLIST, RetVal_SimpleSec } //-------------------------------------------------------------------------- int DocParamList::parse(const QString &cmdName) { int retval=RetVal_OK; DBG(("DocParamList::parse() start\n")); g_nodeStack.push(this); int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); } doctokenizerYYsetStateParam(); tok=doctokenizerYYlex(); while (tok==TK_WORD) /* there is a parameter name */ { if (m_type==DocParamSect::Param) { g_hasParamCommand=TRUE; checkArgumentName(g_token->name,TRUE); } else if (m_type==DocParamSect::RetVal) { //g_hasParamCommand=TRUE; checkArgumentName(g_token->name,FALSE); } m_params.append(g_token->name); tok=doctokenizerYYlex(); } doctokenizerYYsetStatePara(); if (tok==0) /* premature end of comment block */ { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s",cmdName.data()); return 0; } ASSERT(tok==TK_WHITESPACE); retval = m_paragraph->parse(); m_paragraph->markFirst(); m_paragraph->markLast(); DBG(("DocParamList::parse() end retval=%d\n",retval)); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //-------------------------------------------------------------------------- int DocParamSect::parse(const QString &cmdName) { int retval=RetVal_OK; DBG(("DocParamSect::parse() start\n")); g_nodeStack.push(this); DocParamList *pl = new DocParamList(this,m_type); if (m_children.isEmpty()) { pl->markFirst(); pl->markLast(); } else { ASSERT(m_children.last()->kind()==DocNode::Kind_ParamList); ((DocParamList *)m_children.last())->markLast(FALSE); pl->markLast(); } m_children.append(pl); retval = pl->parse(cmdName); DBG(("DocParamSect::parse() end retval=%d\n",retval)); DocNode *n=g_nodeStack.pop(); ASSERT(n==this); return retval; } //-------------------------------------------------------------------------- int DocPara::handleSimpleSection(DocSimpleSect::Type t) { DocSimpleSect *ss=0; if (!m_children.isEmpty() && // previous element m_children.last()->kind()==Kind_SimpleSect && // was a simple sect ((DocSimpleSect *)m_children.last())->type()==t && // of same type t!=DocSimpleSect::User) // but not user defined { // append to previous section ss=(DocSimpleSect *)m_children.last(); } else // start new section { ss=new DocSimpleSect(this,t); m_children.append(ss); } int rv = ss->parse(t==DocSimpleSect::User); return (rv!=TK_NEWPARA) ? rv : RetVal_OK; } int DocPara::handleParamSection(const QString &cmdName,DocParamSect::Type t) { DocParamSect *ps=0; if (!m_children.isEmpty() && // previous element m_children.last()->kind()==Kind_ParamSect && // was a param sect ((DocParamSect *)m_children.last())->type()==t) // of same type { // append to previous section ps=(DocParamSect *)m_children.last(); } else // start new section { ps=new DocParamSect(this,t); m_children.append(ps); } int rv=ps->parse(cmdName); return (rv!=TK_NEWPARA) ? rv : RetVal_OK; } int DocPara::handleXRefItem(DocXRefItem::Type t) { int retval=doctokenizerYYlex(); ASSERT(retval==TK_WHITESPACE); doctokenizerYYsetStateXRefItem(); retval=doctokenizerYYlex(); if (retval!=0) { DocXRefItem *ref = new DocXRefItem(this,g_token->id,t); m_children.append(ref); ref->parse(); } doctokenizerYYsetStatePara(); return retval; } void DocPara::handleIncludeOperator(const QString &cmdName,DocIncOperator::Type t) { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } doctokenizerYYsetStatePattern(); tok=doctokenizerYYlex(); doctokenizerYYsetStatePara(); if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s", cmdName.data()); return; } else if (tok!=TK_WORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } DocIncOperator *op = new DocIncOperator(this,t,g_token->name,g_context,g_isExample,g_fileName); DocNode *n1 = m_children.last(); DocNode *n2 = n1!=0 ? m_children.prev() : 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::handleImage(const QString &cmdName) { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } tok=doctokenizerYYlex(); if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } DocImage::Type t; QString imgType = g_token->name.lower(); if (imgType=="html") t=DocImage::Html; else if (imgType=="latex") t=DocImage::Latex; else if (imgType=="rtf") t=DocImage::Rtf; else { warn(g_fileName,doctokenizerYYlineno,"Warning: image type %s specified as the first argument of " "%s is not valid", imgType.data(),cmdName.data()); return; } doctokenizerYYsetStateFile(); tok=doctokenizerYYlex(); if (tok!=TK_WORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } doctokenizerYYsetStatePara(); DocImage *img = new DocImage(this,findAndCopyImage(g_token->name,t),t); m_children.append(img); img->parse(); } void DocPara::handleDotFile(const QString &cmdName) { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } doctokenizerYYsetStateFile(); tok=doctokenizerYYlex(); if (tok!=TK_WORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } doctokenizerYYsetStatePara(); DocDotFile *df = new DocDotFile(this,g_token->name); m_children.append(df); df->parse(); } void DocPara::handleLink(const QString &cmdName,bool isJavaLink) { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } doctokenizerYYsetStateLink(); tok=doctokenizerYYlex(); if (tok!=TK_WORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } doctokenizerYYsetStatePara(); DocLink *lnk = new DocLink(this,g_token->name); m_children.append(lnk); QString leftOver = lnk->parse(isJavaLink); if (!leftOver.isEmpty()) { m_children.append(new DocWord(this,leftOver)); } } void DocPara::handleRef(const QString &cmdName) { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } doctokenizerYYsetStateRef(); tok=doctokenizerYYlex(); // get the reference id DocRef *ref=0; if (tok!=TK_WORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); goto endref; } ref = new DocRef(this,g_token->name); m_children.append(ref); ref->parse(); endref: doctokenizerYYsetStatePara(); } int DocPara::handleLanguageSwitch() { int retval=RetVal_OK; if (!insideLang(this)) // start a language section at this level { do { int tok = doctokenizerYYlex(); if (tok==TK_WHITESPACE) { // end of language specific sections retval=RetVal_OK; goto endlang; } else if (tok==TK_NEWPARA) { // end of language specific sections retval = tok; goto endlang; } else if (tok==TK_WORD || tok==TK_LNKWORD) { DocLanguage *dl = new DocLanguage(this,g_token->name); m_children.append(dl); retval = dl->parse(); } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s as parameter of \\~", tokToString(tok)); goto endlang; } } while (retval==RetVal_SwitchLang); } else // return from this section { retval = RetVal_SwitchLang; } endlang: return retval; } void DocPara::handleInclude(const QString &cmdName,DocInclude::Type t) { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } doctokenizerYYsetStateFile(); tok=doctokenizerYYlex(); doctokenizerYYsetStatePara(); if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s",cmdName.data()); return; } else if (tok!=TK_WORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } DocInclude *inc = new DocInclude(this,g_token->name,g_context,t,g_isExample,g_fileName); m_children.append(inc); inc->parse(); } void DocPara::handleSection(const QString &cmdName) { // get the argument of the section command. int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); return; } tok=doctokenizerYYlex(); if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s\n", cmdName.data()); return; } else if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); return; } g_token->sectionId = g_token->name; doctokenizerYYsetStateSkipTitle(); doctokenizerYYlex(); doctokenizerYYsetStatePara(); } int DocPara::handleCommand(const QString &cmdName) { int retval = RetVal_OK; switch (CmdMapper::map(cmdName)) { case CMD_UNKNOWN: warn(g_fileName,doctokenizerYYlineno,"Warning: Found unknown command `\\%s'",cmdName.data()); 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)); 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)); 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)); m_children.append(new DocWhiteSpace(this," ")); break; case CMD_BSLASH: m_children.append(new DocSymbol(this,DocSymbol::BSlash)); break; case CMD_AT: m_children.append(new DocSymbol(this,DocSymbol::At)); break; case CMD_LESS: m_children.append(new DocSymbol(this,DocSymbol::Less)); break; case CMD_GREATER: m_children.append(new DocSymbol(this,DocSymbol::Greater)); break; case CMD_AMP: m_children.append(new DocSymbol(this,DocSymbol::Amp)); break; case CMD_DOLLAR: m_children.append(new DocSymbol(this,DocSymbol::Dollar)); break; case CMD_HASH: m_children.append(new DocSymbol(this,DocSymbol::Hash)); break; case CMD_PERCENT: m_children.append(new DocSymbol(this,DocSymbol::Percent)); break; case CMD_SA: g_inSeeBlock=TRUE; retval = handleSimpleSection(DocSimpleSect::See); g_inSeeBlock=FALSE; break; case CMD_RETURN: retval = handleSimpleSection(DocSimpleSect::Return); 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_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 = doctokenizerYYlex(); m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::Code,g_isExample,g_fileName)); if (retval==0) warn(g_fileName,doctokenizerYYlineno,"Warning: code section ended without end marker"); doctokenizerYYsetStatePara(); } break; case CMD_HTMLONLY: { doctokenizerYYsetStateHtmlOnly(); retval = doctokenizerYYlex(); m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::HtmlOnly,g_isExample,g_fileName)); if (retval==0) warn(g_fileName,doctokenizerYYlineno,"Warning: htmlonly 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_fileName)); if (retval==0) warn(g_fileName,doctokenizerYYlineno,"Warning: latexonly section ended without end marker"); doctokenizerYYsetStatePara(); } break; case CMD_VERBATIM: { doctokenizerYYsetStateVerbatim(); retval = doctokenizerYYlex(); m_children.append(new DocVerbatim(this,g_context,g_token->verb,DocVerbatim::Verbatim,g_isExample,g_fileName)); if (retval==0) warn(g_fileName,doctokenizerYYlineno,"Warning: verbatim section ended without end marker"); doctokenizerYYsetStatePara(); } break; case CMD_ENDCODE: case CMD_ENDHTMLONLY: case CMD_ENDLATEXONLY: case CMD_ENDLINK: case CMD_ENDVERBATIM: warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected command %s",g_token->name.data()); break; case CMD_PARAM: retval = handleParamSection(cmdName,DocParamSect::Param); break; case CMD_RETVAL: retval = handleParamSection(cmdName,DocParamSect::RetVal); break; case CMD_EXCEPTION: retval = handleParamSection(cmdName,DocParamSect::Exception); break; case CMD_BUG: retval = handleXRefItem(DocXRefItem::Bug); break; case CMD_TODO: retval = handleXRefItem(DocXRefItem::Todo); break; case CMD_TEST: retval = handleXRefItem(DocXRefItem::Test); break; case CMD_DEPRECATED: retval = handleXRefItem(DocXRefItem::Deprecated); break; case CMD_LINEBREAK: { DocLineBreak *lb = new DocLineBreak(this); m_children.append(lb); } break; case CMD_ANCHOR: { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); break; } tok=doctokenizerYYlex(); if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s",cmdName.data()); break; } else if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); break; } DocAnchor *anchor = new DocAnchor(this,g_token->name,FALSE); m_children.append(anchor); } break; case CMD_ADDINDEX: { DocIndexEntry *ie = new DocIndexEntry(this); m_children.append(ie); retval = ie->parse(); } break; case CMD_INTERNAL: retval = RetVal_Internal; break; case CMD_COPYDOC: { int tok=doctokenizerYYlex(); if (tok!=TK_WHITESPACE) { warn(g_fileName,doctokenizerYYlineno,"Warning: expected whitespace after %s command", cmdName.data()); break; } tok=doctokenizerYYlex(); if (tok==0) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected end of comment block while parsing the " "argument of command %s\n", cmdName.data()); break; } else if (tok!=TK_WORD && tok!=TK_LNKWORD) { warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected token %s as the argument of %s", tokToString(tok),cmdName.data()); break; } DocCopy *cpy = new DocCopy(this,g_token->name); m_children.append(cpy); cpy->parse(); } break; case CMD_INCLUDE: handleInclude(cmdName,DocInclude::Include); break; case CMD_DONTINCLUDE: handleInclude(cmdName,DocInclude::DontInclude); break; case CMD_HTMLINCLUDE: handleInclude(cmdName,DocInclude::HtmlInclude); break; case CMD_VERBINCLUDE: handleInclude(cmdName,DocInclude::VerbInclude); 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: handleDotFile(cmdName); break; case CMD_LINK: handleLink(cmdName,FALSE); break; case CMD_JAVALINK: handleLink(cmdName,TRUE); break; case CMD_REF: handleRef(cmdName); break; case CMD_SECREFLIST: { DocSecRefList *list = new DocSecRefList(this); m_children.append(list); list->parse(); } break; case CMD_SECREFITEM: warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected command %s",g_token->name.data()); break; case CMD_ENDSECREFLIST: warn(g_fileName,doctokenizerYYlineno,"Warning: unexpected command %s",g_token->name.data()); 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(g_fileName,doctokenizerYYlineno,"Warning: unexpected command %s",g_token->name.data()); 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 ); return retval; } int DocPara::handleHtmlStartTag(const QString &tagName,const HtmlAttribList &tagHtmlAttribs) { DBG(("handleHtmlStartTag(%s,%d)\n",tagName.data(),tagHtmlAttribs.count())); int retval=RetVal_OK; int tagId = HtmlTagMapper::map(tagName); 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(g_fileName,doctokenizerYYlineno,"Warning: lonely
  • tag found"); } else { retval=RetVal_ListItem; } break; //case HTML_PRE: // { // DocHtmlPre *pre = new DocHtmlPre(this,tagHtmlAttribs); // m_children.append(pre); // retval=pre->parse(); // } // break; case HTML_BOLD: handleStyleEnter(this,m_children,DocStyleChange::Bold,&g_token->attribs); break; case HTML_CODE: 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_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(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag
    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(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag 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: { HtmlAttribListIterator li(tagHtmlAttribs); HtmlAttrib *opt; for (li.toFirst();(opt=li.current());++li) { if (opt->name=="name") // tag { if (!opt->value.isEmpty()) { DocAnchor *anc = new DocAnchor(this,opt->value,TRUE); m_children.append(anc); break; // stop looking for other tag attribs } else { warn(g_fileName,doctokenizerYYlineno,"Warning: found tag with name option but without value!"); } } else if (opt->name=="href") // .. tag { DocHRef *href = new DocHRef(this,opt->value); m_children.append(href); g_insideHtmlLink=TRUE; retval = href->parse(); g_insideHtmlLink=FALSE; break; } else // unsupport option for tag a { } } } break; case HTML_H1: { DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,1); m_children.append(header); retval = header->parse(); } break; case HTML_H2: { DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,2); m_children.append(header); retval = header->parse(); } break; case HTML_H3: { DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,3); m_children.append(header); retval = header->parse(); } break; case HTML_H4: { DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,4); m_children.append(header); retval = header->parse(); } break; case HTML_H5: { DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,5); m_children.append(header); retval = header->parse(); } break; case HTML_H6: { DocHtmlHeader *header = new DocHtmlHeader(this,tagHtmlAttribs,6); m_children.append(header); retval = header->parse(); } break; case HTML_IMG: { HtmlAttribListIterator li(tagHtmlAttribs); HtmlAttrib *opt; for (li.toFirst();(opt=li.current());++li) { if (opt->name=="src" && !opt->value.isEmpty()) { DocImage *img = new DocImage(this,opt->value,DocImage::Html); m_children.append(img); } } } break; case HTML_UNKNOWN: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported html tag <%s> found", tagName.data()); break; default: // we should not get here! ASSERT(0); break; } return retval; } int DocPara::handleHtmlEndTag(const QString &tagName) { DBG(("handleHtmlEndTag(%s)\n",tagName.data())); int tagId = HtmlTagMapper::map(tagName); int retval=RetVal_OK; switch (tagId) { case HTML_UL: if (!insideUL(this)) { warn(g_fileName,doctokenizerYYlineno,"Warning: found tag without matching
      "); } else { retval=RetVal_EndList; } break; case HTML_OL: if (!insideOL(this)) { warn(g_fileName,doctokenizerYYlineno,"Warning: found tag without matching
        "); } else { retval=RetVal_EndList; } break; case HTML_LI: if (!insideLI(this)) { warn(g_fileName,doctokenizerYYlineno,"Warning: found tag without matching
      1. "); } else { // ignore
      2. tags } break; //case HTML_PRE: // if (!insidePRE(this)) // { // warn(g_fileName,doctokenizerYYlineno,"Warning: found tag without matching
        ");
            //  }
            //  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_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,"preformatted");
              setInsidePreformatted(FALSE);
              doctokenizerYYsetInsidePre(FALSE);
              break;
            case HTML_P:
              // ignore 

        tag break; case HTML_DL: retval=RetVal_EndDesc; break; case HTML_DT: // ignore
  • tag break; case HTML_DD: // ignore tag break; case HTML_TABLE: retval=RetVal_EndTable; break; case HTML_TR: // ignore tag break; case HTML_TD: // ignore tag break; case HTML_TH: // ignore tag break; case HTML_CAPTION: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); break; case HTML_BR: warn(g_fileName,doctokenizerYYlineno,"Warning: Illegal
    tag found\n"); break; case HTML_H1: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); break; case HTML_H2: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); break; case HTML_H3: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); break; case HTML_IMG: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); break; case HTML_HR: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); break; case HTML_A: //warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected tag found"); // ignore tag (can be part of break; case HTML_UNKNOWN: warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported html tag found", tagName.data()); break; default: // we should not get here! ASSERT(0); break; } return retval; } int DocPara::parse() { DBG(("DocPara::parse() start\n")); g_nodeStack.push(this); 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",g_token->name.data())); } 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 relavant ( // remove leading whitespace !m_children.isEmpty() && // and whitespace after certain constructs (k=m_children.last()->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_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; } } // first item or sub list => create new list DocAutoList *al=0; do { al = new DocAutoList(this,g_token->indent,g_token->isEnumList); m_children.append(al); retval = al->parse(); } while (retval==TK_LISTITEM && // new list al->indent()==g_token->indent // at some 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; tok = TK_COMMAND; DBG(("reparsing command %s\n",g_token->name.data())); 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(g_fileName,doctokenizerYYlineno,"Warning: End of list marker found " "has invalid indent level"); } } else { warn(g_fileName,doctokenizerYYlineno,"Warning: 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 = 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 //|| // no section or root as parent // (parent()->kind()!=DocNode::Kind_Root && // parent()->kind()!=DocNode::Kind_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.copy()); // 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; tok = TK_COMMAND; DBG(("reparsing command %s\n",g_token->name.data())); goto reparsetoken; } else if (retval==RetVal_OK) { // the command ended normally, keep scanner for new tokens. retval = 0; } 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: { char letter='\0'; DocSymbol::SymType s = DocSymbol::decodeSymbol(g_token->name,&letter); if (s!=DocSymbol::Unknown) { m_children.append(new DocSymbol(this,s,letter)); } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); } break; } case TK_NEWPARA: retval=TK_NEWPARA; goto endparagraph; } } 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; } //-------------------------------------------------------------------------- int DocSection::parse() { DBG(("DocSection::parse() start %s level=%d\n",g_token->sectionId.data(),m_level)); int retval=RetVal_OK; g_nodeStack.push(this); SectionInfo *sec; if (!m_id.isEmpty()) { sec=Doxygen::sectionDict[m_id]; if (sec) { m_file = sec->fileName; m_anchor = sec->label; m_title = sec->title; if (m_title.isEmpty()) m_title = sec->label; } } // first parse any number of paragraphs bool isFirst=FALSE; DocPara *lastPar=0; do { DocPara *par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } retval=par->parse(); if (!par->isEmpty()) { m_children.append(par); lastPar=par; } else { delete par; } if (retval==TK_LISTITEM) { warn(g_fileName,doctokenizerYYlineno,"Warning: Invalid list item found"); } } while (retval!=0 && retval!=RetVal_Internal && retval!=RetVal_Section && retval!=RetVal_Subsection && retval!=RetVal_Subsubsection && retval!=RetVal_Paragraph ); if (lastPar) lastPar->markLast(); if (retval==RetVal_Subsection && m_level==1) { // then parse any number of nested sections while (retval==RetVal_Subsection) // more sections follow { //SectionInfo *sec=Doxygen::sectionDict[g_token->sectionId]; DocSection *s=new DocSection(this,2,g_token->sectionId); m_children.append(s); retval = s->parse(); } } else if (retval==RetVal_Subsubsection && m_level==2) { // then parse any number of nested sections while (retval==RetVal_Subsubsection) // more sections follow { //SectionInfo *sec=Doxygen::sectionDict[g_token->sectionId]; DocSection *s=new DocSection(this,3,g_token->sectionId); m_children.append(s); retval = s->parse(); } } else if (retval==RetVal_Paragraph && m_level==3) { // then parse any number of nested sections while (retval==RetVal_Paragraph) // more sections follow { //SectionInfo *sec=Doxygen::sectionDict[g_token->sectionId]; DocSection *s=new DocSection(this,4,g_token->sectionId); m_children.append(s); retval = s->parse(); } } else if ((m_level<=1 && retval==RetVal_Subsubsection) || (m_level<=2 && retval==RetVal_Paragraph) ) { int level; if (retval==RetVal_Subsection) level=2; else if (retval==RetVal_Subsubsection) level=3; else level=4; warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected %s " "command found inside %s!", sectionLevelToName[level],sectionLevelToName[m_level]); retval=0; // stop parsing } INTERNAL_ASSERT(retval==0 || retval==RetVal_Section || retval==RetVal_Subsection || retval==RetVal_Subsubsection || retval==RetVal_Paragraph || retval==RetVal_Internal ); DBG(("DocSection::parse() end\n")); DocNode *n = g_nodeStack.pop(); ASSERT(n==this); return retval; } //-------------------------------------------------------------------------- void DocText::parse() { g_nodeStack.push(this); doctokenizerYYsetStateText(); int tok; while ((tok=doctokenizerYYlex())) // get the next token { switch(tok) { case TK_WORD: m_children.append(new DocWord(this,g_token->name)); break; case TK_WHITESPACE: m_children.append(new DocWhiteSpace(this,g_token->chars)); break; case TK_SYMBOL: { char letter='\0'; DocSymbol::SymType s = DocSymbol::decodeSymbol(g_token->name,&letter); if (s!=DocSymbol::Unknown) { m_children.append(new DocSymbol(this,s,letter)); } else { warn(g_fileName,doctokenizerYYlineno,"Warning: Unsupported symbol %s found", g_token->name.data()); } } break; case TK_COMMAND: switch (CmdMapper::map(g_token->name)) { case CMD_BSLASH: m_children.append(new DocSymbol(this,DocSymbol::BSlash)); break; case CMD_AT: m_children.append(new DocSymbol(this,DocSymbol::At)); break; case CMD_LESS: m_children.append(new DocSymbol(this,DocSymbol::Less)); break; case CMD_GREATER: m_children.append(new DocSymbol(this,DocSymbol::Greater)); break; case CMD_AMP: m_children.append(new DocSymbol(this,DocSymbol::Amp)); break; case CMD_DOLLAR: m_children.append(new DocSymbol(this,DocSymbol::Dollar)); break; case CMD_HASH: m_children.append(new DocSymbol(this,DocSymbol::Hash)); break; case CMD_PERCENT: m_children.append(new DocSymbol(this,DocSymbol::Percent)); break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected command `%s' found", g_token->name.data()); break; } break; default: warn(g_fileName,doctokenizerYYlineno,"Warning: Unexpected token %s", tokToString(tok)); break; } } DocNode *n = g_nodeStack.pop(); ASSERT(n==this); } //-------------------------------------------------------------------------- void DocRoot::parse() { g_nodeStack.push(this); doctokenizerYYsetStatePara(); int retval=0; // first parse any number of paragraphs bool isFirst=FALSE; DocPara *lastPar=0; do { DocPara *par = new DocPara(this); if (isFirst) { par->markFirst(); isFirst=FALSE; } retval=par->parse(); if (!par->isEmpty()) { m_children.append(par); lastPar=par; } else { delete par; } if (retval==TK_LISTITEM) { warn(g_fileName,doctokenizerYYlineno,"Warning: Invalid list item found"); } } while (retval!=0 && retval!=RetVal_Section && retval!=RetVal_Internal); if (lastPar) lastPar->markLast(); // then parse any number of level1 sections while (retval==RetVal_Section) { SectionInfo *sec=Doxygen::sectionDict[g_token->sectionId]; ASSERT(sec!=0); DocSection *s=new DocSection(this,1,g_token->sectionId); m_children.append(s); retval = s->parse(); } if (retval==RetVal_Internal) { DocInternal *in = new DocInternal(this); m_children.append(in); retval = in->parse(); } DocNode *n = g_nodeStack.pop(); ASSERT(n==this); } //-------------------------------------------------------------------------- DocNode *validatingParseDoc(const char *fileName,int startLine, const char *context,MemberDef *md, const char *input,bool isExample) { //printf("========== validating %s at line %d\n",fileName,startLine); //printf("---------------- input --------------------\n%s\n----------- end input -------------------\n",input); g_token = new TokenInfo; g_context = context; g_fileName = fileName; g_memberDef = md; g_nodeStack.clear(); g_styleStack.clear(); g_inSeeBlock = FALSE; g_insideHtmlLink = FALSE; g_includeFileText = ""; g_includeFileOffset = 0; g_includeFileLength = 0; g_isExample = isExample; g_hasParamCommand = FALSE; g_paramsFound.setAutoDelete(FALSE); g_paramsFound.clear(); doctokenizerYYlineno=startLine; doctokenizerYYinit(input,g_fileName); // build abstract syntax tree DocRoot *root = new DocRoot; root->parse(); if (Debug::isFlagSet(Debug::PrintTree)) { // pretty print the result PrintDocVisitor *v = new PrintDocVisitor; root->accept(v); delete v; } checkUndocumentedParams(); delete g_token; // TODO: These should be called at the end of the program. //doctokenizerYYcleanup(); //CmdMapper::freeInstance(); //HtmlTagMapper::freeInstance(); return root; } DocNode *validatingParseText(const char *input) { //printf("------------ input ---------\n%s\n" // "------------ end input -----\n",input); g_token = new TokenInfo; g_context = ""; g_fileName = ""; g_memberDef = 0; g_nodeStack.clear(); g_styleStack.clear(); g_inSeeBlock = FALSE; g_insideHtmlLink = FALSE; g_includeFileText = ""; g_includeFileOffset = 0; g_includeFileLength = 0; g_isExample = FALSE; g_hasParamCommand = FALSE; g_paramsFound.setAutoDelete(FALSE); g_paramsFound.clear(); doctokenizerYYlineno=1; doctokenizerYYinit(input,g_fileName); // build abstract syntax tree DocText *txt = new DocText; txt->parse(); if (Debug::isFlagSet(Debug::PrintTree)) { // pretty print the result PrintDocVisitor *v = new PrintDocVisitor; txt->accept(v); delete v; } delete g_token; return txt; } void docFindSections(const char *input,PageInfo *pi,Definition *d,MemberGroup *mg) { doctokenizerYYFindSections(input,pi,d,mg); }