/****************************************************************************** * * * * * Copyright (C) 1997-2001 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 "qtbc.h" #include #include #include #include #include #include #include #include #include #include "version.h" #include "doxygen.h" #include "scanner.h" #include "doc.h" #include "entry.h" #include "index.h" #include "logos.h" #include "instdox.h" #include "message.h" #include "code.h" #include "config.h" #include "util.h" #include "pre.h" #include "tagreader.h" #include "dot.h" #include "outputlist.h" #include "declinfo.h" #include "htmlgen.h" #include "latexgen.h" #include "mangen.h" #include "language.h" #include "debug.h" #include "htmlhelp.h" #include "ftvhelp.h" #include "defargs.h" #include "rtfgen.h" #include "xml.h" #include "reflist.h" #include "page.h" #include "packagedef.h" #include "bufstr.h" #if defined(_MSC_VER) || defined(__BORLANDC__) #define popen _popen #define pclose _pclose #endif // lists ClassList classList; // all documented classes NamespaceList namespaceList; // all namespaces MemberNameList memberNameList; // class member + related functions MemberNameList functionNameList; // all unrelated functions FileNameList inputNameList; // all input files StringList inputFiles; GroupList groupList; // all groups FormulaList formulaList; // all formulas // dictionaries PageSDict *pageSDict = new PageSDict(1009); // all doc pages PageSDict *exampleSDict = new PageSDict(1009); // all examples ClassDict classDict(1009); // all documented classes NamespaceDict namespaceDict(257); // all documented namespaces MemberNameDict memberNameDict(10007); // all class member names MemberNameDict functionNameDict(10007); // all functions //StringDict substituteDict(1009); // class name substitutes SectionDict sectionDict(257); // all page sections StringDict excludeNameDict(1009); // sections StringDict aliasDict(257); // aliases FileNameDict *inputNameDict; // sections FileNameDict *includeNameDict; // include names FileNameDict *exampleNameDict; // examples FileNameDict *imageNameDict; // images StringDict typedefDict(1009); // all typedefs StringDict namespaceAliasDict(257); // all namespace aliases GroupDict groupDict(257); // all groups FormulaDict formulaDict(1009); // all formulas FormulaDict formulaNameDict(1009); // the label name of all formulas StringDict tagDestinationDict(257); // all tag locations // a member group QDict compoundKeywordDict(7); // keywords recognised as compounds QDict expandAsDefinedDict(257); // all macros that should be expanded OutputList *outputList = 0; // list of output generating objects PageInfo *mainPage = 0; QIntDict memberHeaderDict(1009); // dictionary of the member groups heading QIntDict memberDocDict(1009); // dictionary of the member groups heading PackageSDict packageDict(257); // java packages void clearAll() { classList.clear(); namespaceList.clear(); pageSDict->clear(); exampleSDict->clear(); memberNameList.clear(); functionNameList.clear(); inputNameList.clear(); inputFiles.clear(); groupList.clear(); formulaList.clear(); classDict.clear(); namespaceDict.clear(); memberNameDict.clear(); functionNameDict.clear(); sectionDict.clear(); inputNameDict->clear(); excludeNameDict.clear(); includeNameDict->clear(); exampleNameDict->clear(); imageNameDict->clear(); typedefDict.clear(); groupDict.clear(); formulaDict.clear(); formulaNameDict.clear(); tagDestinationDict.clear(); delete outputList; outputList=0; delete mainPage; mainPage=0; } void statistics() { fprintf(stderr,"--- inputNameDict stats ----\n"); inputNameDict->statistics(); fprintf(stderr,"--- includeNameDict stats ----\n"); includeNameDict->statistics(); fprintf(stderr,"--- exampleNameDict stats ----\n"); exampleNameDict->statistics(); fprintf(stderr,"--- imageNameDict stats ----\n"); imageNameDict->statistics(); fprintf(stderr,"--- classDict stats ----\n"); classDict.statistics(); fprintf(stderr,"--- namespaceDict stats ----\n"); namespaceDict.statistics(); fprintf(stderr,"--- memberNameDict stats ----\n"); memberNameDict.statistics(); fprintf(stderr,"--- functionNameDict stats ----\n"); functionNameDict.statistics(); fprintf(stderr,"--- sectionDict stats ----\n"); sectionDict.statistics(); fprintf(stderr,"--- excludeNameDict stats ----\n"); excludeNameDict.statistics(); fprintf(stderr,"--- aliasDict stats ----\n"); aliasDict.statistics(); fprintf(stderr,"--- typedefDict stats ----\n"); typedefDict.statistics(); fprintf(stderr,"--- namespaceAliasDict stats ----\n"); namespaceAliasDict.statistics(); fprintf(stderr,"--- groupDict stats ----\n"); groupDict.statistics(); fprintf(stderr,"--- formulaDict stats ----\n"); formulaDict.statistics(); fprintf(stderr,"--- formulaNameDict stats ----\n"); formulaNameDict.statistics(); fprintf(stderr,"--- tagDestinationDict stats ----\n"); tagDestinationDict.statistics(); fprintf(stderr,"--- compoundKeywordDict stats ----\n"); compoundKeywordDict.statistics(); fprintf(stderr,"--- expandAsDefinedDict stats ----\n"); expandAsDefinedDict.statistics(); fprintf(stderr,"--- memberHeaderDict stats ----\n"); memberHeaderDict.statistics(); fprintf(stderr,"--- memberDocDict stats ----\n"); memberDocDict.statistics(); } int annotatedClasses; int hierarchyClasses; int documentedFunctions; int documentedMembers; int documentedHtmlFiles; int documentedFiles; int documentedGroups; int documentedNamespaces; int documentedNamespaceMembers; int documentedIncludeFiles; int documentedPages; int documentedPackages; QTextStream tagFile; static void addMemberDocs(Entry *root,MemberDef *md, const char *funcDecl, ArgumentList *al,bool over_load,NamespaceList *nl=0); const char idMask[] = "[A-Za-z_][A-Za-z_0-9]*"; QCString spaces; //---------------------------------------------------------------------- // Returns the standard string that is generated when the \overload // command is used. const char *getOverloadDocs() { return "This is an overloaded member function, " "provided for convenience. It differs from the above " "function only in what argument(s) it accepts."; } //---------------------------------------------------------------------------- static void addRelatedPage(const char *name,const QCString &ptitle, const QCString &doc,QList *anchors, const char *fileName,int startLine, int todoId,int testId,GroupDef *gd=0 ) { PageInfo *pi=0; if ((pi=pageSDict->find(name))) { // append documentation block to the page. pi->doc+="\n\n"+doc; } else // new page { QCString baseName=name; if (baseName.right(4)==".tex") baseName=baseName.left(baseName.length()-4); else if (baseName.right(5)==".html") baseName=baseName.left(baseName.length()-5); QCString title=ptitle.stripWhiteSpace(); pi=new PageInfo(fileName,startLine,baseName,doc,title); pi->todoId=todoId; pi->testId=testId; QCString pageName; if (Config::caseSensitiveNames) pageName=pi->name.copy(); else pageName=pi->name.lower(); setFileNameForSections(anchors,pageName); pageSDict->append(baseName,pi); if (gd) gd->addPage(pi); if (!pi->title.isEmpty()) { //outputList->writeTitle(pi->name,pi->title); // a page name is a label as well! SectionInfo *si=new SectionInfo( pi->name,pi->title,SectionInfo::Section); if (gd) { si->fileName=gd->getOutputFileBase(); } else { si->fileName=pageName; } //printf(" SectionInfo: sec=%p sec->fileName=%s\n",si,si->fileName.data()); //printf("Adding section info %s\n",pi->name.data()); sectionDict.insert(pageName,si); } } } static void addRelatedPage(Entry *root) { GroupDef *gd=0; QListIterator sli(*root->groups); QCString *s; for (;(s=sli.current());++sli) { if (!s->isEmpty() && (gd=groupDict[*s])) break; } addRelatedPage(root->name,root->args,root->doc,root->anchors, root->fileName,root->startLine,root->todoId,root->testId,gd ); } //---------------------------------------------------------------------------- static void addRefItem(int todoId,int testId,const char *prefix, const char *name,const char *title,const char *args=0) { //printf("addRefItem(%s) todoId=%d testId\n",name,todoId,testId); //////////////////////////////////////////////////////////// // add item to the todo list //////////////////////////////////////////////////////////// if (todoId>0 && Config::generateTodoList) { RefItem *item = todoList.getRefItem(todoId); ASSERT(item!=0); if (item->written) return; QCString doc; doc += "
\\anchor "; doc += item->listAnchor; doc += "\n"; doc += prefix; doc += " \\_internalref "; doc += name; doc += " \""; doc += title; doc += "\""; if (args) doc += args; doc += "
\n
"; doc += item->text; doc += "
\n"; addRelatedPage("todo",theTranslator->trTodoList(),doc,0,"generated",1,0,0); item->written=TRUE; } //////////////////////////////////////////////////////////// // add item to the test list //////////////////////////////////////////////////////////// if (testId>0 && Config::generateTestList) { RefItem *item = testList.getRefItem(testId); ASSERT(item!=0); if (item->written) return; QCString doc; doc += "
\\anchor "; doc += item->listAnchor; doc += "\n"; doc += prefix; doc += " \\_internalref "; doc += name; doc += " \""; doc += title; doc += "\""; if (args) doc += args; doc += "
\n
"; doc += item->text; doc += "
\n"; addRelatedPage("test",theTranslator->trTestList(),doc,0,"generated",1,0,0); item->written=TRUE; } } //---------------------------------------------------------------------------- static void buildGroupList(Entry *root) { if (root->section==Entry::GROUPDOC_SEC && !root->name.isEmpty()) { //printf("Found group %s title=`%s'\n",root->name.data(),root->type.data()); GroupDef *gd; if ((gd=groupDict[root->name])) { warn(root->fileName,root->startLine, "Warning: group %s already documented. " "Skipping documentation.", root->name.data()); } else { gd = new GroupDef(root->fileName,root->startLine,root->name,root->type); if (root->tagInfo) { gd->setReference(root->tagInfo->tagName); } gd->setBriefDescription(root->brief); gd->setDocumentation(root->doc); gd->addSectionsToDefinition(root->anchors); groupList.append(gd); groupDict.insert(root->name,gd); addGroupToGroups(root,gd); gd->setRefItems(root->todoId,root->testId); } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildGroupList(e); } } //---------------------------------------------------------------------- //void computeGroupRelations(Entry *root) //{ // if (root->section==Entry::GROUPDOC_SEC && !root->name.isEmpty()) // { // GroupDef *gd; // // if ((gd=groupDict[root->name])) // { // QListIterator sli(*root->groups); // QCString *s; // for (;(s=sli.current());++sli) // { // GroupDef *pgd; // if (!s->isEmpty() && (pgd=groupDict[*s])) // { // pgd->addGroup(gd); // printf("Group %s: in group %s\n",gd->groupName(),s->data()); // } // } // } // } // EntryListIterator eli(*root->sublist); // Entry *e; // for (;(e=eli.current());++eli) // { // computeGroupRelations(e); // } //} //---------------------------------------------------------------------- static void buildFileList(Entry *root) { if (((root->section==Entry::FILEDOC_SEC) || ((root->section & Entry::FILE_MASK) && Config::extractAllFlag)) && !root->name.isEmpty() ) { bool ambig; FileDef *fd=findFileDef(inputNameDict,root->name,ambig); if (fd && !ambig) { if ((!root->doc.isEmpty() && !fd->documentation().isEmpty()) || (!root->brief.isEmpty() && !fd->briefDescription().isEmpty())) { warn( root->fileName,root->startLine, "Warning: file %s already documented. " "Skipping documentation.", root->name.data() ); } else { // using FALSE in setDocumentation is small hack to make sure a file // is documented even if a \file command is used without further // documentation fd->setDocumentation(root->doc,FALSE); fd->setBriefDescription(root->brief); fd->addSectionsToDefinition(root->anchors); fd->setRefItems(root->todoId,root->testId); QListIterator sli(*root->groups); QCString *s; for (;(s=sli.current());++sli) { GroupDef *gd=0; if (!s->isEmpty() && (gd=groupDict[*s])) { gd->addFile(fd); //printf("File %s: in group %s\n",fd->name().data(),s->data()); } } } } else { const char *fn = root->fileName.data(); QCString text; text.sprintf("Warning: the name `%s' supplied as " "the second argument in the \\file statement ", root->name.data() ); if (ambig) // name is ambigious { text+="matches the following input files:\n"; text+=showFileDefMatches(inputNameDict,root->name); text+="Please use a more specific name by " "including a (larger) part of the path!"; } else // name is not an input file { text+="is not an input file"; } warn(fn,root->startLine,text); } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildFileList(e); } } static void addIncludeFile(ClassDef *cd,FileDef *ifd,Entry *root) { if ( (!root->doc.stripWhiteSpace().isEmpty() || !root->brief.stripWhiteSpace().isEmpty() || Config::extractAllFlag ) && root->protection!=Private ) { //printf(">>>>>> includeFile=%s\n",root->includeFile.data()); bool ambig; FileDef *fd=0; // see if we need to include a verbatim copy of the header file //printf("root->includeFile=%s\n",root->includeFile.data()); if (!root->includeFile.isEmpty() && (fd=findFileDef(inputNameDict,root->includeFile,ambig))==0 ) { // explicit request QCString text; text.sprintf("Warning: the name `%s' supplied as " "the second argument in the \\class statement ", root->includeFile.data() ); if (ambig) // name is ambigious { text+="matches the following input files:\n"; text+=showFileDefMatches(inputNameDict,root->includeFile); text+="Please use a more specific name by " "including a (larger) part of the path!"; } else // name is not an input file { text+="is not an input file"; } warn(root->fileName,root->startLine,text); } else if (root->includeFile.isEmpty() && ifd && // see if the file extension makes sense guessSection(ifd->name())==Entry::HEADER_SEC) { // implicit assumption fd=ifd; } // if a file is found, we mark it as a source file. if (fd) { QCString iName = !root->includeName.isEmpty() ? root->includeName.data() : root->includeFile.data(); bool local=FALSE; if (!iName.isEmpty()) // user specified include file { local = iName.at(0)=='"'; // is it a local include file if (local || iName.at(0)=='<') { iName=iName.mid(1,iName.length()-2); // strip quotes or brackets } } else // use name of the file containing the class definition { iName=fd->name(); } if (fd->generateSourceFile()) // generate code for header { cd->setIncludeFile(fd,iName,local); } else // put #include in the class documentation without link { cd->setIncludeFile(0,iName,local); } } } } static bool addNamespace(Entry *root,ClassDef *cd) { // see if this class is defined inside a namespace if (root->section & Entry::COMPOUND_MASK) { Entry *e = root->parent; while (e) { if (e->section==Entry::NAMESPACE_SEC) { NamespaceDef *nd=0; //printf("addNameSpace() trying: %s\n",e->name.data()); QCString nsName = stripAnnonymousNamespaceScope(e->name); if (!nsName.isEmpty() && nsName.at(0)!='@' && (nd=getResolvedNamespace(nsName)) ) { cd->setNamespace(nd); nd->insertClass(cd); return TRUE; } } e=e->parent; } } return FALSE; } //---------------------------------------------------------------------- // build a list of all classes mentioned in the documentation // and all classes that have a documentation block before their definition. static void buildClassList(Entry *root) { if ( ((root->section & Entry::COMPOUNDDOC_MASK) || ((root->section & Entry::COMPOUND_MASK)) ) && !root->name.isEmpty() ) { QCString fullName=root->name.copy(); if (fullName.isEmpty()) { // this should not be called warn(root->fileName,root->startLine, "Warning: invalid class name found!" ); } else { fullName=stripAnnonymousNamespaceScope(fullName); Debug::print(Debug::Classes,0," Found class with name %s\n",fullName.data()); bool ambig; ClassDef *cd; //printf("findFileDef(%s)\n",root->fileName.data()); FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); if ((cd=getClass(fullName))) { Debug::print(Debug::Classes,0," Existing class!\n",fullName.data()); if (cd->templateArguments()==0) { //printf("existing ClassDef tempArgList=%p specScope=%s\n",root->tArgList,root->scopeSpec.data()); cd->setTemplateArguments(root->tArgList); } if (!root->doc.isEmpty() || !root->brief.isEmpty() || (root->bodyLine!=-1 && Config::sourceBrowseFlag) ) // block contains something that ends up in the docs { if (!root->doc.isEmpty() && !cd->documentation().isEmpty()) { warn( root->fileName,root->startLine, "Warning: class %s already has a detailed description. " "Skipping the one found here.", fullName.data() ); } else if (!root->doc.isEmpty()) { cd->setDocumentation(root->doc); } if (!root->brief.isEmpty() && !cd->briefDescription().isEmpty()) { warn( root->fileName,root->startLine, "Warning: class %s already has a brief description\n" " skipping the one found here.", fullName.data() ); } else if (!root->brief.isEmpty()) { cd->setBriefDescription(root->brief); } if (root->bodyLine!=-1 && cd->getStartBodyLine()==-1) { cd->setBodySegment(root->bodyLine,root->endBodyLine); cd->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); } cd->addSectionsToDefinition(root->anchors); cd->setName(fullName); // change name to match docs } cd->setFileDef(fd); if (cd->hasDocumentation()) { addIncludeFile(cd,fd,root); } addNamespace(root,cd); if (fd && (root->section & Entry::COMPOUND_MASK)) { //printf(">> Inserting class `%s' in file `%s' (root->fileName=`%s')\n", // cd->name().data(), // fd->name().data(), // root->fileName.data() // ); fd->insertClass(cd); } addClassToGroups(root,cd); cd->setRefItems(root->todoId,root->testId); if (!root->subGrouping) cd->setSubGrouping(FALSE); } else // new class { ClassDef::CompoundType sec=ClassDef::Class; switch(root->section) { case Entry::UNION_SEC: case Entry::UNIONDOC_SEC: sec=ClassDef::Union; break; case Entry::STRUCT_SEC: case Entry::STRUCTDOC_SEC: sec=ClassDef::Struct; break; case Entry::INTERFACE_SEC: case Entry::INTERFACEDOC_SEC: sec=ClassDef::Interface; break; case Entry::EXCEPTION_SEC: case Entry::EXCEPTIONDOC_SEC: sec=ClassDef::Exception; break; } Debug::print(Debug::Classes,0," New class `%s' (sec=0x%08x)!\n",fullName.data(),root->section); QCString className; QCString namespaceName; extractNamespaceName(fullName,className,namespaceName); //printf("New class: namespace `%s' name=`%s'\n",className.data(),namespaceName.data()); QCString tagName; QCString refFileName; if (root->tagInfo) { tagName = root->tagInfo->tagName; refFileName = root->tagInfo->fileName; } ClassDef *cd=new ClassDef(root->fileName,root->startLine,fullName,sec, tagName,refFileName); cd->setDocumentation(root->doc); // copy docs to definition cd->setBriefDescription(root->brief); //printf("new ClassDef %s tempArgList=%p specScope=%s\n",fullName.data(),root->tArgList,root->scopeSpec.data()); cd->setTemplateArguments(root->tArgList); cd->setProtection(root->protection); cd->addSectionsToDefinition(root->anchors); // file definition containing the class cd cd->setBodySegment(root->bodyLine,root->endBodyLine); cd->setBodyDef(fd); if (!root->subGrouping) cd->setSubGrouping(FALSE); addClassToGroups(root,cd); cd->setRefItems(root->todoId,root->testId); // see if the class is found inside a namespace bool found=addNamespace(root,cd); cd->setFileDef(fd); if (cd->hasDocumentation()) { addIncludeFile(cd,fd,root); } // namespace is part of the class name if (!found && !namespaceName.isEmpty()) { NamespaceDef *nd = getResolvedNamespace(namespaceName); if (nd) { cd->setNamespace(nd); nd->insertClass(cd); found=TRUE; } } // if the class is not in a namespace then we insert // it in the file definition if (!found && fd && (root->section & Entry::COMPOUND_MASK)) { //printf(">> Inserting class `%s' in file `%s' (root->fileName=`%s')\n", // cd->name().data(), // fd->name().data(), // root->fileName.data() // ); fd->insertClass(cd); } // the empty string test is needed for extract all case cd->setBriefDescription(root->brief); cd->insertUsedFile(root->fileName); // add class to the list classList.inSort(cd); //printf("ClassDict.insert(%s)\n",resolveDefines(fullName).data()); //classDict.insert(resolveDefines(fullName),cd); classDict.insert(fullName,cd); } } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildClassList(e); } } //---------------------------------------------------------------------- // build a list of all namespaces mentioned in the documentation // and all namespaces that have a documentation block before their definition. static void buildNamespaceList(Entry *root) { if ( (root->section==Entry::NAMESPACE_SEC) || (root->section==Entry::NAMESPACEDOC_SEC) && !root->name.isEmpty() ) { QCString fullName=stripAnnonymousNamespaceScope(root->name.copy()); if (!fullName.isEmpty()) { //printf("Found namespace %s in %s at line %d\n",root->name.data(), // root->fileName.data(), root->startLine); NamespaceDef *nd; if ((nd=namespaceDict[fullName])) { if (!root->doc.isEmpty() || !root->brief.isEmpty()) // block contains docs { if (nd->documentation().isEmpty() && !root->doc.isEmpty()) { nd->setDocumentation(root->doc); nd->setName(fullName); // change name to match docs nd->addSectionsToDefinition(root->anchors); } else if (!nd->documentation().isEmpty() && !root->doc.isEmpty()) { warn( root->fileName,root->startLine, "Warning: namespace %s already has a detailed description. " "Skipping the documentation found here.", fullName.data()); } if (nd->briefDescription().isEmpty() && !root->brief.isEmpty()) { nd->setBriefDescription(root->brief); nd->setName(fullName); // change name to match docs } else if (!nd->briefDescription().isEmpty() && !root->brief.isEmpty()) { warn(root->fileName,root->startLine, "Warning: namespace %s already has a brief description. " "Skipping the documentation found here.", fullName.data() ); } } bool ambig; // file definition containing the namespace nd FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); // insert the namespace in the file definition if (fd) fd->insertNamespace(nd); addNamespaceToGroups(root,nd); nd->setRefItems(root->todoId,root->testId); } else /* if (!root->doc.isEmpty() || !root->brief.isEmpty() || Config::extractAllFlag ) */ { QCString tagName; if (root->tagInfo) { tagName=root->tagInfo->tagName; } NamespaceDef *nd=new NamespaceDef(root->fileName,root->startLine,fullName,tagName); nd->setDocumentation(root->doc); // copy docs to definition nd->setBriefDescription(root->brief); nd->addSectionsToDefinition(root->anchors); //printf("Adding namespace to group\n"); addNamespaceToGroups(root,nd); nd->setRefItems(root->todoId,root->testId); bool ambig; // file definition containing the namespace nd FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); // insert the namespace in the file definition if (fd) fd->insertNamespace(nd); // the empty string test is needed for extract all case nd->setBriefDescription(root->brief); nd->insertUsedFile(root->fileName); nd->setBodySegment(root->bodyLine,root->endBodyLine); nd->setBodyDef(fd); // add class to the list namespaceList.inSort(nd); namespaceDict.insert(fullName,nd); } } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildNamespaceList(e); } } //---------------------------------------------------------------------- static void findUsingDirectives(Entry *root) { if (root->section==Entry::USINGDIR_SEC) { //printf("Found using directive %s at line %d of %s\n", // root->name.data(),root->startLine,root->fileName.data()); bool ambig; if (!root->name.isEmpty()) { NamespaceDef *usingNd = 0; NamespaceDef *nd = 0; FileDef *fd = findFileDef(inputNameDict,root->fileName,ambig); QCString nsName; // see if the using statement was found inside a namespace or inside // the global file scope. if (root->parent->section == Entry::NAMESPACE_SEC) { nsName=root->parent->name.copy(); if (!nsName.isEmpty()) { nd = getResolvedNamespace(nsName); } } // find the scope in which the `using' namespace is defined by prepending // the possible scopes in which the using statement was found, starting // with the most inner scope and going to the most outer scope (i.e. // file scope). int scopeOffset = nsName.length(); do { QCString scope=scopeOffset>0 ? nsName.left(scopeOffset)+"::" : QCString(); //printf("Trying with scope=`%s'\n",scope.data()); usingNd = getResolvedNamespace(scope+root->name); if (scopeOffset==0) { scopeOffset=-1; } else if ((scopeOffset=nsName.findRev("::",scopeOffset-1))==-1) { scopeOffset=0; } } while (scopeOffset>=0 && usingNd==0); //printf("%s -> %p\n",root->name.data(),usingNd); // add the namespace the correct scope if (usingNd) { if (nd) { //printf("Inside namespace %s\n",nd->name().data()); nd->addUsingDirective(usingNd); } else if (fd) { //printf("Inside file %s\n",fd->name().data()); fd->addUsingDirective(usingNd); } } else // unknown namespace, but add it anyway. { NamespaceDef *nd=new NamespaceDef( root->fileName,root->startLine,root->name); nd->setDocumentation(root->doc); // copy docs to definition nd->setBriefDescription(root->brief); nd->addSectionsToDefinition(root->anchors); QListIterator sli(*root->groups); QCString *s; for (;(s=sli.current());++sli) { GroupDef *gd=0; if (!s->isEmpty() && (gd=groupDict[*s])) gd->addNamespace(nd); } bool ambig; // file definition containing the namespace nd FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); // insert the namespace in the file definition if (fd) { fd->insertNamespace(nd); fd->addUsingDirective(nd); } // the empty string test is needed for extract all case nd->setBriefDescription(root->brief); nd->insertUsedFile(root->fileName); // add class to the list namespaceList.inSort(nd); namespaceDict.insert(root->name,nd); nd->setRefItems(root->todoId,root->testId); } } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { findUsingDirectives(e); } } //---------------------------------------------------------------------- static void findUsingDeclarations(Entry *root) { if (root->section==Entry::USINGDECL_SEC) { //printf("Found using declaration %s at line %d of %s\n", // root->name.data(),root->startLine,root->fileName.data()); bool ambig; if (!root->name.isEmpty()) { ClassDef *usingCd = 0; NamespaceDef *nd = 0; FileDef *fd = findFileDef(inputNameDict,root->fileName,ambig); QCString scName; // see if the using statement was found inside a namespace or inside // the global file scope. if (root->parent->section == Entry::NAMESPACE_SEC) { scName=root->parent->name.copy(); if (!scName.isEmpty()) { nd = getResolvedNamespace(scName); } } // Assume the using statement was used to import a class. // Find the scope in which the `using' namespace is defined by prepending // the possible scopes in which the using statement was found, starting // with the most inner scope and going to the most outer scope (i.e. // file scope). int scopeOffset = scName.length(); do { QCString scope=scopeOffset>0 ? scName.left(scopeOffset)+"::" : QCString(); //printf("Trying with scope=`%s'\n",scope.data()); usingCd = getClass(scope+root->name); if (scopeOffset==0) { scopeOffset=-1; } else if ((scopeOffset=scName.findRev("::",scopeOffset-1))==-1) { scopeOffset=0; } } while (scopeOffset>=0 && usingCd==0); //printf("%s -> %p\n",root->name.data(),usingCd); // add the namespace the correct scope if (usingCd) { if (nd) { //printf("Inside namespace %s\n",nd->name().data()); nd->addUsingDeclaration(usingCd); } else if (fd) { fd->addUsingDeclaration(usingCd); } } } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { findUsingDeclarations(e); } } //---------------------------------------------------------------------- static MemberDef *addVariableToClass( Entry *root, ClassDef *cd, MemberDef::MemberType mtype, const QCString &scope, const QCString &name, bool fromAnnScope, int indentDepth, MemberDef *fromAnnMemb, Protection prot) { Debug::print(Debug::Variables,0, " class variable:\n" " %s' %s'::`%s' `%s' prot=`%d ann=%d\n", root->type.data(), scope.data(), name.data(), root->args.data(), root->protection, fromAnnScope ); // class friends may be templatized //QCString name=n; //int i; //if (root->type.left(7)=="friend " && (i=name.find('<'))!=-1) //{ // name=name.left(i); //} // add template names, if the class is a non-specialized template //if (scope.find('<')==-1 && cd->templateArguments()) //{ // scope+=cd->getTemplateNameString(); //} // generate member definition. QCString def; if (!root->type.isEmpty()) { if (mtype==MemberDef::Friend || Config::hideScopeNames) { def=root->type+" "+name+root->args; } else { def=root->type+" "+scope+"::"+name+root->args; } } else { if (Config::hideScopeNames) { def=name+root->args; } else { def=scope+"::"+name+root->args; } } if (def.left(7)=="static ") def=def.right(def.length()-7); // see if the member is already found in the same scope // (this may be the case for a static member that is initialized // outside the class) MemberName *mn=memberNameDict[name]; if (mn) { MemberNameIterator mni(*mn); MemberDef *md; for (mni.toFirst();(md=mni.current());++mni) { if (md->getClassDef()==cd && root->type==md->typeString()) // member already in the scope { addMemberDocs(root,md,def,0,FALSE); return md; } } } // new member variable, typedef or enum value MemberDef *md=new MemberDef( root->fileName,root->startLine, root->type,name,root->args,0, prot,Normal,root->stat,FALSE, mtype,0,0); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } md->setMemberClass(cd); //md->setDefFile(root->fileName); //md->setDefLine(root->startLine); md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->setDefinition(def); md->setBitfields(root->bitfields); md->addSectionsToDefinition(root->anchors); md->setFromAnnonymousScope(fromAnnScope); md->setFromAnnonymousMember(fromAnnMemb); md->setIndentDepth(indentDepth); md->setBodySegment(root->bodyLine,root->endBodyLine); md->setInitializer(root->initializer); md->setMaxInitLines(root->initLines); md->setMemberGroupId(root->mGrpId); //if (root->mGrpId!=-1) //{ // printf("memberdef %s in memberGroup %d\n",name.data(),root->mGrpId); // md->setMemberGroup(memberGroupDict[root->mGrpId]); // bool ambig; md->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); // add the member to the global list if (mn) { mn->append(md); } else // new variable name { mn = new MemberName(name); mn->append(md); //printf("Adding memberName=%s\n",mn->memberName()); memberNameDict.insert(name,mn); memberNameList.append(mn); // add the member to the class } cd->insertMember(md); md->setRefItems(root->todoId,root->testId); //TODO: insert FileDef instead of filename strings. cd->insertUsedFile(root->fileName); return md; } //---------------------------------------------------------------------- static MemberDef *addVariableToFile( Entry *root, MemberDef::MemberType mtype, const QCString &scope, const QCString &name, bool fromAnnScope, int indentDepth, MemberDef *fromAnnMemb) { Debug::print(Debug::Variables,0, " global variable:\n" " type=`%s' scope=`%s' name=`%s' args=`%s' prot=`%d\n", root->type.data(), scope.data(), name.data(), root->args.data(), root->protection ); bool ambig; FileDef *fd = findFileDef(inputNameDict,root->fileName,ambig); // see if the function is inside a namespace NamespaceDef *nd = 0; if (!scope.isEmpty()) { QCString nscope=removeAnonymousScopes(scope); if (!nscope.isEmpty()) { nd = getResolvedNamespace(nscope); } } QCString def; // determine the definition of the global variable if (nd && !nd->name().isEmpty() && nd->name().at(0)!='@' && !Config::hideScopeNames ) // variable is inside a namespace, so put the scope before the name { if (!root->type.isEmpty()) { def=root->type+" "+nd->name()+"::"+name+root->args; } else { def=nd->name()+"::"+name+root->args; } } else { if (!root->type.isEmpty()) { if (name.at(0)=='@') // dummy variable representing annonymous union def=root->type; else def=root->type+" "+name+root->args; } else { def=name+root->args; } } if (def.left(7)=="static ") def=def.right(def.length()-7); MemberName *mn=functionNameDict[name]; if (mn) { QCString nscope=removeAnonymousScopes(scope); NamespaceDef *nd=0; if (!nscope.isEmpty()) { nd = getResolvedNamespace(nscope); } MemberNameIterator mni(*mn); MemberDef *md; for (mni.toFirst();(md=mni.current());++mni) { if ((nd==0 && md->getFileDef() && root->fileName==md->getFileDef()->absFilePath()) || (nd!=0 && md->getNamespaceDef()==nd)) // variable already in the scope { addMemberDocs(root,md,def,0,FALSE); md->setRefItems(root->todoId,root->testId); return md; } if (nd==0 && md->isExplicit()!=root->explicitExternal) { // merge ingroup specifiers if (md->getGroupDef()==0 && root->groups->first()) { GroupDef *gd=groupDict[root->groups->first()->data()]; md->setGroupDef(gd); } else if (md->getGroupDef()!=0 && root->groups->count()==0) { root->groups->append(new QCString(md->getGroupDef()->name())); } } } } // new global variable, enum value or typedef MemberDef *md=new MemberDef( root->fileName,root->startLine, root->type,name,root->args,0, Public, Normal,root->stat,FALSE, mtype,0,0); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } //md->setDefFile(root->fileName); //md->setDefLine(root->startLine); md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->addSectionsToDefinition(root->anchors); md->setFromAnnonymousScope(fromAnnScope); md->setFromAnnonymousMember(fromAnnMemb); md->setIndentDepth(indentDepth); md->setBodySegment(root->bodyLine,root->endBodyLine); md->setInitializer(root->initializer); md->setMaxInitLines(root->initLines); md->setMemberGroupId(root->mGrpId); md->setBodyDef(fd); md->setDefinition(def); md->setExplicitExternal(root->explicitExternal); //if (root->mGrpId!=-1) //{ // md->setMemberGroup(memberGroupDict[root->mGrpId]); //} md->setRefItems(root->todoId,root->testId); if (nd && !nd->name().isEmpty() && nd->name().at(0)!='@') { nd->insertMember(md); md->setNamespace(nd); } else { // find file definition if (fd) { fd->insertMember(md); md->setFileDef(fd); } } // add member definition to the list of globals if (mn) { mn->append(md); } else { mn = new MemberName(name); mn->append(md); functionNameDict.insert(name,mn); functionNameList.append(mn); } return md; } //---------------------------------------------------------------------- // Searches the Entry tree for Variable documentation sections. // If found they are stored in their class or in the global list. void buildVarList(Entry *root) { static const QRegExp re("([^)]*)"); int i=-1; if (!root->name.isEmpty() && //root->type!="class" && root->type!="interface" && //root->type!="struct" && root->type!="union" && (root->type.isEmpty() || compoundKeywordDict.find(root->type)==0) && ( (root->section==Entry::VARIABLE_SEC ) || (root->section==Entry::FUNCTION_SEC && // function variable !root->type.isEmpty() && root->type.find(re,0)!=-1 && // special case to catch function pointers root->type.find("operator")==-1 && root->type.find(")(")==-1 ) ) ) // documented variable { Debug::print(Debug::Variables,0, "VARIABLE_SEC: \n" " type=`%s' name=`%s' args=`%s' bodyLine=`%d' mGrpId=%d\n", root->type.data(), root->name.data(), root->args.data(), root->bodyLine, root->mGrpId ); //printf("root->parent->name=%s\n",root->parent->name.data()); if (root->type.isEmpty() && root->name.find("operator")==-1 && (root->name.find('*')!=-1 || root->name.find('&')!=-1)) { // recover from parse error caused by redundant braces root->type=root->name; static const QRegExp reName("[a-z_A-Z][a-z_A-Z0-9]*"); int l; i=root->args.isEmpty() ? -1 : reName.match(root->args,0,&l); root->name=root->args.mid(i,l); root->args=root->args.mid(i+l,root->args.find(')',i+l)-i-l); //printf("new: type=`%s' name=`%s' args=`%s'\n", // root->type.data(),root->name.data(),root->args.data()); } else { i=root->type.find(re,0); if (i!=-1) // function pointer { int ai = root->type.find('[',i); if (ai>i) // function pointer array { root->args.prepend(root->type.right(root->type.length()-ai)); root->type=root->type.left(ai); } else { root->type=root->type.left(root->type.length()-1); root->args.prepend(")"); } } } QCString scope,name=root->name.copy(); //int si; //if ((si=name.findRev("::"))!=-1) //{ // scope=name.left(si); // name=name.right(name.length()-si-2); //} // find the scope of this variable Entry *p = root->parent; while ((p->section & Entry::SCOPE_MASK)) { QCString scopeName = p->name.copy(); if (!scopeName.isEmpty()) { scope.prepend(scopeName); break; } p=p->parent; } // scope annonymous scope name at the end to determine the scope // where we can put this variable //while ((i=scope.findRev("::"))!=-1 && (int)scope.length()>i+2 && // scope.at(i+2)=='@' // ) //{ // scope=scope.left(i); //} MemberDef::MemberType mtype; QCString type=root->type.stripWhiteSpace(); ClassDef *cd=0; if (root->name.findRev("::")!=-1) goto nextMember; /* skip this member, because it is a * static variable definition (always?), which will be * found in a class scope as well, but then we know the * correct protection level, so only then it will be * inserted in the correct list! */ if (type=="@") mtype=MemberDef::EnumValue; else if (type.left(8)=="typedef ") mtype=MemberDef::Typedef; else if (type.left(7)=="friend ") mtype=MemberDef::Friend; else if (root->mtype==Property) mtype=MemberDef::Property; else mtype=MemberDef::Variable; QCString classScope=stripAnnonymousNamespaceScope(scope); QCString annScopePrefix=scope.left(scope.length()-classScope.length()); scope=classScope; if (!scope.isEmpty() && !name.isEmpty() && (cd=getClass(scope))) { MemberDef *md=0; // if cd is an annonymous scope we insert the member // into a non-annonymous scope as well. int indentDepth=0; int si=scope.find('@'); if (si!=-1) { //printf("name=`%s' scope=%s\n",name.data(),scope.data()); QCString pScope; ClassDef *pcd=0; pScope = scope.left(QMAX(si-2,0)); indentDepth = scope.right(scope.length()-si).contains("::")+1; if (!pScope.isEmpty()) pScope.prepend(annScopePrefix); else if (annScopePrefix.length()>2) pScope=annScopePrefix.left(annScopePrefix.length()-2); //printf("pScope=`%s'\n",pScope.data()); if (name.at(0)!='@') { if (!pScope.isEmpty() && (pcd=getClass(pScope))) { Protection p = (Protection)QMAX((int)root->protection,(int)cd->protection()); md=addVariableToClass(root,pcd,mtype,pScope,name,TRUE,indentDepth,0,p); } else // annonymous scope inside namespace or file => put variable in the global scope { //printf("Inserting member in global scope %s!\n",pScope.data()); //md=addVariableToFile(root,mtype,pScope,name,!pScope.isEmpty(),indentDepth,0); md=addVariableToFile(root,mtype,pScope,name,TRUE,indentDepth,0); } } } addVariableToClass(root,cd,mtype,scope,name,FALSE,indentDepth,md,root->protection); } else if (!name.isEmpty()) // global variable { //printf("Inserting member in global scope %s!\n",scope.data()); addVariableToFile(root,mtype,scope,name,FALSE,0,0); } //if (mtype==MemberDef::Typedef) //{ // static QRegExp r("[a-z_A-Z][a-z_A-Z0-9]*"); // int i,l; // if ((i=r.match(type,8,&l))!=-1) // { // //printf(">>> inserting typedef `%s'->`%s'\n",type.mid(i,l).data(),name.data()); // if (getClass(type.mid(i,l))!=0) // { // typedefDict.insert(name,new QCString(type.mid(i,l))); // } // } //} } nextMember: EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { if (e->section!=Entry::ENUM_SEC) buildVarList(e); } } //---------------------------------------------------------------------- // Searches the Entry tree for Function sections. // If found they are stored in their class or in the global list. static void buildMemberList(Entry *root) { if (root->section==Entry::FUNCTION_SEC) { Debug::print(Debug::Functions,0, "FUNCTION_SEC:\n" " `%s' `%s'::`%s' `%s' relates=`%s' file=`%s' line=`%d' bodyLine=`%d' #targs=%d #mtargs=%d mGrpId=%d memSpec=%d\n", root->type.data(), root->parent->name.data(), root->name.data(), root->args.data(), root->relates.data(), root->fileName.data(), root->startLine, root->bodyLine, root->tArgList ? (int)root->tArgList->count() : -1, root->mtArgList ? (int)root->mtArgList->count() : -1, root->mGrpId, root->memSpec ); bool isFriend=root->type.find("friend ")!=-1; QCString rname = removeRedundantWhiteSpace(root->name); if (!rname.isEmpty()) { ClassDef *cd=0; // check if this function's parent is a class QRegExp re("([a-z_A-Z0-9: ]*[ *]*[ ]*"); //printf("root->parent=`%s' cd=%p root->type.find(re,0)=%d\n", // root->parent->name.data(),getClass(root->parent->name), // root->type.find(re,0)); QCString scope=stripAnnonymousNamespaceScope(root->parent->name.copy()); bool isMember=FALSE; int memIndex=rname.find("::"); if (memIndex!=-1) { int ts=rname.find('<'); int te=rname.find('>'); if (ts==-1 || te==-1) { isMember=TRUE; } else { isMember=memIndexte; } } int i; if (root->parent && !root->parent->name.isEmpty() && (root->parent->section & Entry::COMPOUND_MASK) && (cd=getClass(scope)) && // do some fuzzy things to exclude function pointers (root->type.isEmpty() || root->type.find(re,0)==-1 || root->type.find(")(")!=-1 || root->type.find("operator")!=-1 ) ) { int l; if (!root->type.isEmpty() && (i=re.match(root->type,0,&l))!=-1) // function variable { root->args+=root->type.right(root->type.length()-i-l); root->type=root->type.left(i+l); } QCString name=removeRedundantWhiteSpace(rname); if (name.left(2)=="::") name=name.right(name.length()-2); MemberDef::MemberType mtype; if (isFriend) mtype=MemberDef::Friend; else if (root->mtype==Signal) mtype=MemberDef::Signal; else if (root->mtype==Slot) mtype=MemberDef::Slot; else if (root->mtype==DCOP) mtype=MemberDef::DCOP; else mtype=MemberDef::Function; // strip redundant template specifier for constructors if ((i=name.find('<'))!=-1 && name.find('>')!=-1) { name=name.left(i); } //if (Config::includeSourceFlag && !root->body.isEmpty()) //{ // printf("Function: %s\n-----------------\n%s\n------------------\n", // rname.data(),root->body.data()); //} // new member function, signal or slot. //printf("new member: %s member template args=`%s'\n", // root->args.data(), // argListToString(root->mtArgList).data()); MemberDef *md=new MemberDef( root->fileName,root->startLine, root->type,name,root->args,root->exception, root->protection,root->virt,root->stat,!root->relates.isEmpty(), mtype,root->mtArgList,root->argList); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } md->setMemberClass(cd); md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->setBodySegment(root->bodyLine,root->endBodyLine); md->setMemberSpecifiers(root->memSpec); md->setMemberGroupId(root->mGrpId); bool ambig; md->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); //md->setScopeTemplateArguments(root->tArgList); md->addSectionsToDefinition(root->anchors); QCString def; if (!root->relates.isEmpty() || isFriend || Config::hideScopeNames) { if (!root->type.isEmpty()) { if (root->argList) { def=root->type+" "+name; } else { def=root->type+" "+name+root->args; } } else { if (root->argList) { def=name; } else { def=name+root->args; } } } else { if (!root->type.isEmpty()) { if (root->argList) { def=root->type+" "+scope+"::"+name; } else { def=root->type+" "+scope+"::"+name+root->args; } } else { if (root->argList) { def=scope+"::"+name; } else { def=scope+"::"+name+root->args; } } } if (def.left(7)=="friend ") def=def.right(def.length()-7); md->setDefinition(def); Debug::print(Debug::Functions,0, " Func Member:\n" " `%s' `%s'::`%s' `%s' proto=%d\n" " def=`%s'\n", root->type.data(), root->parent->name.data(), rname.data(), root->args.data(), root->proto, def.data() ); // add member to the global list of all members MemberName *mn; if ((mn=memberNameDict[name])) { mn->append(md); } else { mn = new MemberName(name); mn->append(md); //printf("Adding memberName=%s\n",mn->memberName()); memberNameDict.insert(name,mn); memberNameList.append(mn); } // add member to the class cd cd->insertMember(md); // add file to list of used files cd->insertUsedFile(root->fileName); addMemberToGroups(root,md); } else if (root->parent && !(root->parent->section & Entry::COMPOUND_MASK) && !isMember && root->relates.isEmpty() && root->type.left(7)!="extern " && root->type.left(8)!="typedef " ) // no member => unrelated function { /* check the uniqueness of the function name in the file. * A file could contain a function prototype and a function definition * or even multiple function prototypes. */ bool found=FALSE; MemberName *mn; //MemberDef *fmd; if ((mn=functionNameDict[rname])) { //printf("--> function %s already found!\n",rname.data()); MemberNameIterator mni(*mn); MemberDef *md; for (mni.toFirst();((md=mni.current()) && !found);++mni) { NamespaceDef *nd = md->getNamespaceDef(); NamespaceDef *rnd = 0; if (!root->parent->name.isEmpty()) { rnd = getResolvedNamespace(root->parent->name); } FileDef *fd = md->getFileDef(); QCString nsName,rnsName; if (nd) nsName = nd->name().copy(); if (rnd) rnsName = rnd->name().copy(); if ( matchArguments(md->argumentList(),root->argList,0,nsName) ) { // see if we need to create a new member found=(nd && rnd && nsName==rnsName) || // members are in the same namespace ((fd!=0 && // no external reference and fd->absFilePath()==root->fileName // prototype in the same file ) ); // otherwise, allow a duplicate global member with the same argument list //printf("combining function with prototype found=%d `%s'<->`%s'!\n", // found,fd->absFilePath().data(),root->fileName.data()); // merge argument lists mergeArguments(root->argList,md->argumentList()); // merge documentation if (!md->documentation() && !root->doc.isEmpty()) { md->setDocumentation(root->doc); } if (!md->briefDescription() && !root->brief.isEmpty()) { md->setBriefDescription(root->brief); } // merge body definitions if (md->getStartBodyLine()==-1 && root->bodyLine!=-1) { md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; md->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); } md->addSectionsToDefinition(root->anchors); // merge ingroup specifiers if (md->getGroupDef()==0 && root->groups->first()) { GroupDef *gd=groupDict[root->groups->first()->data()]; md->setGroupDef(gd); } else if (md->getGroupDef()!=0 && root->groups->count()==0) { root->groups->append(new QCString(md->getGroupDef()->name())); } } } } if (!found) /* global function is unique with respect to the file */ { //printf("New function type=`%s' name=`%s' args=`%s' bodyLine=%d\n", // root->type.data(),rname.data(),root->args.data(),root->bodyLine); // new global function QCString name=removeRedundantWhiteSpace(rname); MemberDef *md=new MemberDef( root->fileName,root->startLine, root->type,name,root->args,root->exception, root->protection,root->virt,root->stat,FALSE, MemberDef::Function,root->tArgList,root->argList); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } //md->setDefFile(root->fileName); //md->setDefLine(root->startLine); md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->setPrototype(root->proto); //md->setBody(root->body); md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); md->setBodyDef(fd); md->addSectionsToDefinition(root->anchors); md->setMemberSpecifiers(root->memSpec); md->setMemberGroupId(root->mGrpId); QCString def; if (!root->type.isEmpty()) { if (root->argList) { def=root->type+" "+name; } else { def=root->type+" "+name+root->args; } } else { if (root->argList) { def=name.copy(); } else { def=name+root->args; } } Debug::print(Debug::Functions,0, " Global Function:\n" " `%s' `%s'::`%s' `%s' proto=%d\n" " def=`%s'\n", root->type.data(), root->parent->name.data(), rname.data(), root->args.data(), root->proto, def.data() ); md->setDefinition(def); //if (root->mGrpId!=-1) //{ // md->setMemberGroup(memberGroupDict[root->mGrpId]); //} // see if the function is inside a namespace NamespaceDef *nd = 0; if (root->parent->section == Entry::NAMESPACE_SEC ) { QCString nscope=removeAnonymousScopes(root->parent->name); if (!nscope.isEmpty()) { nd = getResolvedNamespace(nscope); } } if (nd && !nd->name().isEmpty() && nd->name().at(0)!='@') { // add member to namespace nd->insertMember(md); md->setNamespace(nd); md->setRefItems(root->todoId,root->testId); } else if (fd) { // add member to the file fd->insertMember(md); md->setFileDef(fd); md->setRefItems(root->todoId,root->testId); } // add member to the list of file members MemberName *mn; if ((mn=functionNameDict[name])) { mn->append(md); } else { mn = new MemberName(name); mn->append(md); functionNameDict.insert(name,mn); functionNameList.append(mn); } addMemberToGroups(root,md); } else { //printf("Function already found!\n"); } //printf("unrelated function %d `%s' `%s' `%s'\n", // root->parent->section,root->type.data(),rname.data(),root->args.data()); } } else if (rname.isEmpty()) { warn(root->fileName,root->startLine, "Warning: Illegal member name found." ); } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildMemberList(e); } } //---------------------------------------------------------------------- static void findFriends() { //printf("findFriends()\n"); MemberNameListIterator fnli(functionNameList); MemberName *fn; for (;(fn=fnli.current());++fnli) // for each global function name { //printf("Function name=`%s'\n",fn->memberName()); MemberName *mn; if ((mn=memberNameDict[fn->memberName()])) { // there are members with the same name //printf("Function name is also a member name\n"); MemberNameIterator fni(*fn); MemberDef *fmd; for (;(fmd=fni.current());++fni) // for each function with that name { MemberNameIterator mni(*mn); MemberDef *mmd; for (;(mmd=mni.current());++mni) // for each member with that name { //printf("Checking for matching arguments // mmd->isRelated()=%d mmd->isFriend()=%d mmd->isFunction()=%d\n", // mmd->isRelated(),mmd->isFriend(),mmd->isFunction()); NamespaceDef *nd=mmd->getNamespaceDef(); if ((mmd->isFriend() || (mmd->isRelated() && mmd->isFunction())) && matchArguments(mmd->argumentList(), fmd->argumentList(), mmd->getClassDef()->name(), nd ? nd->name().data() : 0 ) ) // if the member is related and the arguments match then the // function is actually a friend. { mergeArguments(mmd->argumentList(),fmd->argumentList()); if (!fmd->documentation().isEmpty()) mmd->setDocumentation(fmd->documentation()); else if (!mmd->documentation().isEmpty()) fmd->setDocumentation(mmd->documentation()); if (mmd->briefDescription().isEmpty() && !fmd->briefDescription().isEmpty()) mmd->setBriefDescription(fmd->briefDescription()); else if (!mmd->briefDescription().isEmpty() && !fmd->briefDescription().isEmpty()) fmd->setBriefDescription(mmd->briefDescription()); if (mmd->getStartBodyLine()==-1 && fmd->getStartBodyLine()!=-1) { mmd->setBodySegment(fmd->getStartBodyLine(),fmd->getEndBodyLine()); mmd->setBodyDef(fmd->getBodyDef()); } else if (mmd->getStartBodyLine()!=-1 && fmd->getStartBodyLine()==-1) { fmd->setBodySegment(mmd->getStartBodyLine(),mmd->getEndBodyLine()); fmd->setBodyDef(mmd->getBodyDef()); } } } } } } } //---------------------------------------------------------------------- static void transferFunctionDocumentation() { //printf("transferFunctionDocumentation()\n"); // find matching function declaration and definitions. MemberNameListIterator mnli(functionNameList); MemberName *mn; for (;(mn=mnli.current());++mnli) { MemberDef *md,*mdef=0,*mdec=0; MemberNameIterator mni(*mn); /* find a matching function declaration and definition for this function */ for (;(md=mni.current());++mni) { if (md->isPrototype()) mdec=md; else if (md->isVariable() && md->isExternal()) mdec=md; if (md->isFunction() && !md->isStatic() && !md->isPrototype()) mdef=md; else if (md->isVariable() && !md->isExternal() && !md->isStatic()) mdef=md; } //printf("mdef=(%p,%s) mdec=(%p,%s)\n", // mdef, mdef ? mdef->name().data() : "", // mdec, mdec ? mdec->name().data() : ""); if (mdef && mdec && matchArguments(mdef->argumentList(),mdec->argumentList()) ) /* match found */ { FileDef *fdef = mdef->getFileDef(); FileDef *fdec = mdec->getFileDef(); // check if not in different but documented files if (Config::extractAllFlag || fdef==fdec || (fdef!=0 && (!fdef->hasDocumentation() || !mdec->hasDocumentation())) ) { //printf("Found member %s: def in %s and dec in %s\n", // mn->memberName(),mdef->getFileDef()->name().data(), // mdec->getFileDef()->name().data()); /* copy documentation between function definition and declaration */ if (mdec->briefDescription()) { mdef->setBriefDescription(mdec->briefDescription()); } else if (mdef->briefDescription()) { mdec->setBriefDescription(mdef->briefDescription()); } if (mdef->documentation()) { mdec->setDocumentation(mdef->documentation()); } else if (mdec->documentation()) { mdef->setDocumentation(mdec->documentation()); } if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1) { mdef->setBodySegment(mdec->getStartBodyLine(),mdec->getEndBodyLine()); mdef->setBodyDef(mdec->getFileDef()); } else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1) { mdec->setBodySegment(mdef->getStartBodyLine(),mdef->getEndBodyLine()); mdec->setBodyDef(mdef->getFileDef()); } mdec->mergeMemberSpecifiers(mdef->getMemberSpecifiers()); mdef->mergeMemberSpecifiers(mdec->getMemberSpecifiers()); } } } } //---------------------------------------------------------------------- static void transferRelatedFunctionDocumentation() { // find match between function declaration and definition for // related functions MemberNameListIterator mnli(functionNameList); MemberName *mn; for (mnli.toFirst();(mn=mnli.current());++mnli) { MemberDef *md; MemberNameIterator mni(*mn); /* find a matching function declaration and definition for this function */ for (mni.toFirst();(md=mni.current());++mni) // for each global function { //printf(" Function `%s'\n",md->name().data()); MemberName *rmn; if ((rmn=memberNameDict[md->name()])) // check if there is a member with the same name { //printf(" Member name found\n"); MemberDef *rmd; MemberNameIterator rmni(*rmn); for (rmni.toFirst();(rmd=rmni.current());++rmni) // for each member with the same name { //printf(" Member found: related=`%d'\n",rmd->isRelated()); if (rmd->isRelated() && // related function matchArguments(md->argumentList(),rmd->argumentList()) // match argument lists ) { //printf(" Found related member `%s'\n",md->name().data()); md->makeRelated(); } } } } } } //---------------------------------------------------------------------- static void replaceNamespaceAliases(QCString &scope,int i) { //printf("replaceNamespaceAliases(%s,%d)\n",scope.data(),i); while (i>0) { QCString *s = namespaceAliasDict[scope.left(i)]; if (s) { scope=*s+scope.right(scope.length()-i); i=s->length(); } i=scope.findRev("::",i-1); } //printf("replaceNamespaceAliases() result=%s\n",scope.data()); } static bool findBaseClassRelation(Entry *root,ClassDef *cd, BaseInfo *bi, bool insertUndocumented ) { Entry *parentNode=root->parent; bool lastParent=FALSE; do // for each parent scope, starting with the largest scope // (in case of nested classes) { QCString scopeName= parentNode ? parentNode->name.data() : ""; int scopeOffset=scopeName.length(); do // try all parent scope prefixes, starting with the largest scope { //printf("scopePrefix=`%s' bi->name=`%s'\n", // scopeName.left(scopeOffset).data(),bi->name.data()); QCString baseClassName=removeRedundantWhiteSpace(bi->name); if (scopeOffset>0) { baseClassName.prepend(scopeName.left(scopeOffset)+"::"); } ClassDef *baseClass=getResolvedClass(baseClassName); //printf("baseClassName=`%s' baseClass=%p\n",baseClassName.data(),baseClass); if (baseClassName!=root->name) // check for base class with the same name, // look in the outer scope for a match { Debug::print( Debug::Classes,0," class relation %s inherited by %s found (%s and %s)\n", baseClassName.data(), root->name.data(), (bi->prot==Private)?"private":((bi->prot==Protected)?"protected":"public"), (bi->virt==Normal)?"normal":"virtual" ); int i; QCString templSpec; if (baseClass==0 && (i=baseClassName.find('<'))!=-1) // base class has template specifiers { // TODO: here we should try to find the correct template specialization // but for now, we only look for the unspecializated base class. // locate end of template int e=i+1; int brCount=1; int typeLen = baseClassName.length(); while (e') { if (e') e++; else brCount--; } e++; } if (brCount==0) // end of template was found at e { templSpec=baseClassName.mid(i,e-i); baseClassName=baseClassName.left(i)+baseClassName.right(baseClassName.length()-e); baseClass=getResolvedClass(baseClassName); //printf("baseClass=%p -> baseClass=%s templSpec=%s\n", // baseClass,baseClassName.data(),templSpec.data()); } } bool found=baseClass!=0 && baseClass!=cd; NamespaceDef *nd=cd->getNamespaceDef(); if (!found && (i=baseClassName.findRev("::"))!=-1) { // replace any namespace aliases replaceNamespaceAliases(baseClassName,i); baseClass=getResolvedClass(baseClassName); found=baseClass!=0 && baseClass!=cd; } if (!found) { FileDef *fd=cd->getFileDef(); if (fd) { // look for the using statement in this file in which the // class was found NamespaceList *nl = fd->getUsedNamespaces(); if (nl) // try to prepend any of the using namespace scopes. { NamespaceListIterator nli(*nl); NamespaceDef *nd; for (nli.toFirst() ; (nd=nli.current()) && !found ; ++nli) { QCString fName = nd->name()+"::"+baseClassName; found = (baseClass=getResolvedClass(fName))!=0 && baseClass!=cd && root->name!=fName; } } if (fd && !found) // and in the global namespace { ClassList *cl = fd->getUsedClasses(); if (cl) { ClassListIterator cli(*cl); ClassDef *ucd; for (cli.toFirst(); (ucd=cli.current()) && !found; ++cli) { if (rightScopeMatch(ucd->name(),bi->name)) { baseClass = ucd; found = TRUE; } } } } } if (!found && nd) // class is inside a namespace { NamespaceList *nl = nd->getUsedNamespaces(); QCString fName = nd->name()+"::"+baseClassName; found = (baseClass=getResolvedClass(fName))!=0 && root->name!=fName; if (nl) // try to prepend any of the using namespace scopes. { NamespaceListIterator nli(*nl); NamespaceDef *nd; for (nli.toFirst() ; (nd=nli.current()) && !found ; ++nli) { fName = nd->name()+"::"+baseClassName; found = (baseClass=getResolvedClass(fName))!=0 && baseClass!=cd && root->name!=fName; } } if (!found) // also check imported classes within this namespace { ClassList *cl = nd->getUsedClasses(); if (cl) { ClassListIterator cli(*cl); ClassDef *ucd; for (cli.toFirst(); (ucd=cli.current()) && !found; ++cli) { if (rightScopeMatch(ucd->name(),bi->name)) { baseClass = ucd; found = TRUE; } } } } // TODO: check any inbetween namespaces as well! if (fd && !found) // and in the global namespace { ClassList *cl = fd->getUsedClasses(); if (cl) { ClassListIterator cli(*cl); ClassDef *ucd; for (cli.toFirst(); (ucd=cli.current()) && !found; ++cli) { if (rightScopeMatch(ucd->name(),bi->name)) { baseClass = ucd; found = TRUE; } } } } } } if (found) { Debug::print(Debug::Classes,0," Documented base class `%s'\n",bi->name.data()); // add base class to this class cd->insertBaseClass(baseClass,bi->prot,bi->virt,templSpec); // add this class as super class to the base class baseClass->insertSuperClass(cd,bi->prot,bi->virt,templSpec); return TRUE; } else if (scopeOffset==0 && insertUndocumented) { Debug::print(Debug::Classes,0, " Undocumented base class `%s' baseClassName=%s\n", bi->name.data(),baseClassName.data() ); baseClass=new ClassDef(root->fileName,root->startLine, baseClassName,ClassDef::Class); // add base class to this class cd->insertBaseClass(baseClass,bi->prot,bi->virt,templSpec); // add this class as super class to the base class baseClass->insertSuperClass(cd,bi->prot,bi->virt,templSpec); // the undocumented base was found in this file baseClass->insertUsedFile(root->fileName); // add class to the list //classList.inSort(baseClass); classList.inSort(baseClass); //printf("ClassDict.insert(%s)\n",resolveDefines(fullName).data()); //classDict.insert(resolveDefines(bi->name),baseClass); classDict.insert(baseClassName,baseClass); return TRUE; } else { Debug::print(Debug::Classes,0," Base class `%s' not found\n",bi->name.data()); } } if (scopeOffset==0) { scopeOffset=-1; } else if ((scopeOffset=scopeName.findRev("::",scopeOffset-1))==-1) { scopeOffset=0; } //printf("new scopeOffset=`%d'",scopeOffset); } while (scopeOffset>=0); if (parentNode==0) { lastParent=TRUE; } else { parentNode=parentNode->parent; } } while (lastParent); return FALSE; } //---------------------------------------------------------------------- // Computes the base and super classes for each class in the tree static void computeClassRelations(Entry *root) { if ( ( ( // is it a compound (class, struct, union, interface ...) root->section & Entry::COMPOUND_MASK ) || ( // is it a documentation block with inheritance info. (root->section & Entry::COMPOUNDDOC_MASK) && root->extends->count()>0 ) ) && !root->name.isEmpty() // sanity check ) { ClassDef *cd; // strip any annonymous scopes first QCString bName=stripAnnonymousNamespaceScope(root->name); Debug::print(Debug::Classes,0," Class %s : \n",bName.data()); if ((cd=getClass(bName))) { //printf("Class %s %d\n",cd->name().data(),root->extends->count()); if (!cd->visited) // check integrity of the tree { cd->visited=TRUE; // mark class as used if (root->extends->count()>0) // there are base classes { // The base class could ofcouse also be a non-nested class QList *baseList=root->extends; BaseInfo *bi=baseList->first(); while (bi) // for each base class { // find a documented base class in the correct scope if (!findBaseClassRelation(root,cd,bi,FALSE)) { // no documented base class -> try to find an undocumented one findBaseClassRelation(root,cd,bi,TRUE); } bi=baseList->next(); } } // class has no base classes } // else class is already found } else if (bName.right(2)!="::") { if (!root->name.isEmpty() && root->name[0]!='@') warn_undoc( root->fileName,root->startLine, "Warning: Compound %s is not documented.", root->name.data() ); } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { computeClassRelations(e); } } //----------------------------------------------------------------------- // compute the references (anchors in HTML) for each function in the file static void computeMemberReferences() { ClassDef *cd=classList.first(); while (cd) { cd->computeAnchors(); cd=classList.next(); } FileName *fn=inputNameList.first(); while (fn) { FileDef *fd=fn->first(); while (fd) { fd->computeAnchors(); fd=fn->next(); } fn=inputNameList.next(); } NamespaceDef *nd=namespaceList.first(); while (nd) { nd->computeAnchors(); nd=namespaceList.next(); } GroupDef *gd=groupList.first(); while (gd) { gd->computeAnchors(); gd=groupList.next(); } } //---------------------------------------------------------------------- static void addTodoTestReferences() { ClassDef *cd=classList.first(); while (cd) { addRefItem(cd->todoId(),cd->testId(),"class",cd->getOutputFileBase(),cd->name()); cd=classList.next(); } FileName *fn=inputNameList.first(); while (fn) { FileDef *fd=fn->first(); while (fd) { addRefItem(fd->todoId(),fd->testId(),"file",fd->getOutputFileBase(),fd->name()); fd=fn->next(); } fn=inputNameList.next(); } NamespaceDef *nd=namespaceList.first(); while (nd) { addRefItem(nd->todoId(),nd->testId(),"namespace",nd->getOutputFileBase(),nd->name()); nd=namespaceList.next(); } GroupDef *gd=groupList.first(); while (gd) { addRefItem(gd->todoId(),gd->testId(),"group",gd->getOutputFileBase(),gd->name()); gd=groupList.next(); } PageSDictIterator pdi(*pageSDict); PageInfo *pi=0; for (pdi.toFirst();(pi=pdi.current());++pdi) { addRefItem(pi->todoId,pi->testId,"page",pi->name,pi->title); } MemberNameListIterator mnli(memberNameList); MemberName *mn=0; for (mnli.toFirst();(mn=mnli.current());++mnli) { MemberNameIterator mni(*mn); MemberDef *md=0; for (mni.toFirst();(md=mni.current());++mni) { Definition *d=md->getClassDef(); QCString scopeName; if (d) scopeName=d->name(); if (d==0) d=md->getFileDef(); if (d==0) d=md->getGroupDef(); if (d) { addRefItem(md->todoId(),md->testId(),"member",d->getOutputFileBase()+":"+md->anchor(),scopeName+"::"+md->name(),md->argsString()); } } } MemberNameListIterator fnli(functionNameList); for (fnli.toFirst();(mn=fnli.current());++fnli) { MemberNameIterator mni(*mn); MemberDef *md=0; for (mni.toFirst();(md=mni.current());++mni) { Definition *d=md->getNamespaceDef(); QCString scopeName; if (d) scopeName=d->name(); if (d==0) d=md->getBodyDef(); if (d==0) d=md->getGroupDef(); if (d) { addRefItem(md->todoId(),md->testId(),"member",d->getOutputFileBase()+":"+md->anchor(),scopeName+"::"+md->name(),md->argsString()); } } } } //---------------------------------------------------------------------- // Copy the documentation in entry `root' to member definition `md' and // set the function declaration of the member to `funcDecl'. If the boolean // over_load is set the standard overload text is added. static void addMemberDocs(Entry *root, MemberDef *md, const char *funcDecl, ArgumentList *al, bool over_load, NamespaceList *nl ) { //printf("addMemberDocs: `%s'::`%s' `%s' funcDecl=`%s' memSpec=%d\n", // root->parent->name.data(),md->name().data(),md->argsString(),funcDecl,root->memSpec); QCString fDecl=funcDecl; // strip extern specifier if (fDecl.left(7)=="extern ") fDecl=fDecl.right(fDecl.length()-7); md->setDefinition(fDecl); ClassDef *cd=md->getClassDef(); NamespaceDef *nd=md->getNamespaceDef(); QCString fullName; if (cd) fullName = cd->name(); else if (nd) fullName = nd->name(); if (!fullName.isEmpty()) fullName+="::"; fullName+=md->name(); if (al) { mergeArguments(md->argumentList(),al); } else { if (matchArguments(md->argumentList(),root->argList, cd ? cd->name().data() : 0, nd ? nd->name().data() : 0, TRUE, nl ) ) { mergeArguments(md->argumentList(),root->argList); } } if (over_load) // the \overload keyword was used { QCString doc=getOverloadDocs(); if (!root->doc.isEmpty()) { doc+="

"; doc+=root->doc; } md->setDocumentation(doc); } else { //printf("Adding docs md->docs=`%s' root->docs=`%s'!\n", // md->documentation().data(),root->doc.data()); // documentation outside a compound overrides the documentation inside it if ( /* !md->isStatic() && !root->stat && do not replace doc of a static */ ( md->documentation().isEmpty() || /* no docs yet */ (root->parent->name.isEmpty() && /* or overwrite prototype docs */ !root->proto && md->isPrototype() /* with member definition docs */ ) ) && !root->doc.isEmpty() ) { md->setDocumentation(root->doc); } // brief descriptions inside a compound override the documentation // outside it if ( /* !md->isStatic() && !root->stat && do not replace doc of static */ ( md->briefDescription().isEmpty() || /* no docs yet */ !root->parent->name.isEmpty() /* member of a class */ ) && !root->brief.isEmpty() ) { md->setBriefDescription(root->brief); } if (md->initializer().isEmpty() && !root->initializer.isEmpty()) { md->setInitializer(root->initializer); md->setMaxInitLines(root->initLines); } //if (md->bodyCode().isEmpty() && !root->body.isEmpty()) /* no body yet */ //{ // md->setBody(root->body); //} bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); if (fd) { if ((md->getStartBodyLine()==-1 && root->bodyLine!=-1) || (md->isVariable() && !root->explicitExternal)) { md->setBodySegment(root->bodyLine,root->endBodyLine); md->setBodyDef(fd); } md->setRefItems(root->todoId,root->testId); } } //md->setDefFile(root->fileName); //md->setDefLine(root->startLine); md->mergeMemberSpecifiers(root->memSpec); md->addSectionsToDefinition(root->anchors); addMemberToGroups(root,md); if (cd) cd->insertUsedFile(root->fileName); //printf("root->mGrpId=%d\n",root->mGrpId); if (root->mGrpId!=-1) { if (md->getMemberGroupId()!=-1) { if (md->getMemberGroupId()!=root->mGrpId) { warn( root->fileName,root->startLine, "Warning: member %s belongs to two different groups. The second " "one found here will be ignored.", md->name().data() ); } } else // set group id { //printf("setMemberGroupId=%d md=%s\n",root->mGrpId,md->name().data()); md->setMemberGroupId(root->mGrpId); } } } //---------------------------------------------------------------------- // find a class definition given the scope name and (optionally) a // template list specifier static ClassDef *findSimpleClassDefinition(const char *scopeName,const char *classTempList) { ClassDef *tcd=0; if (classTempList) // try to find the correct specialization { tcd=getClass( insertTemplateSpecifierInScope( scopeName, classTempList ) ); // try specialization } if (tcd==0) { tcd=getClass(scopeName); // try general class } return tcd; } static ClassDef *findClassDefinition(FileDef *fd,NamespaceDef *nd, const char *scopeName,const char *classTempList) { ClassDef *tcd = findSimpleClassDefinition(scopeName,classTempList); if (tcd==0) // try using declaration { ClassList *cl = 0; if (nd) { cl=nd->getUsedClasses(); } else { cl=fd->getUsedClasses(); } if (cl) { ClassListIterator cli(*cl); ClassDef *cd; for (;(cd=cli.current()) && tcd==0;++cli) { QCString scName = scopeName; int scopeOffset = scName.length(); do { QCString scope=scName.left(scopeOffset); //printf("`%s'<->`%s' `%s'\n",cd->name().data(),scope.data(),scopeName); if (rightScopeMatch(cd->name(),scope)) { //printf("Trying to find `%s'\n",(cd->name()+scName.right(scName.length()-scopeOffset)).data()); tcd = findSimpleClassDefinition(cd->name()+scName.right(scName.length()-scopeOffset),classTempList); } scopeOffset=scName.findRev("::",scopeOffset-1); } while (scopeOffset>=0 && tcd==0); } } } if (tcd==0) // try using directive { NamespaceList *nl = 0; if (nd) { nl=nd->getUsedNamespaces(); } else if (fd) { nl=fd->getUsedNamespaces(); } if (nl) { NamespaceListIterator nli(*nl); NamespaceDef *nd; for (;(nd=nli.current()) && tcd==0;++nli) { //printf("Trying with scope=%s\n",nd->name().data()); tcd = findSimpleClassDefinition(nd->name()+"::"+scopeName,classTempList); } } } return tcd; } //---------------------------------------------------------------------- // Adds the documentation contained in `root' to a global function // with name `name' and argument list `args' (for overloading) and // function declaration `decl' to the corresponding member definition. static bool findUnrelatedFunction(Entry *root, const QCString &namespaceName, const char *name, const char *tempArg, const char *, const char *decl) { QCString n=name; if (n.isEmpty()) return FALSE; if (n.find("::")!=-1) return FALSE; // skip undefined class members Debug::print(Debug::FindMembers,0, "2. findUnrelatedFunction(namespace=%s,name=%s,tempArg=%s,decl=%s)\n", namespaceName.data(),name,tempArg,decl); MemberName *mn=functionNameDict[n+tempArg]; // look in function dictionary if (mn==0) { mn=functionNameDict[n]; // try without template arguments } if (mn) // function name defined { Debug::print(Debug::FindMembers,0,"3. Found function scope\n"); //int count=0; MemberNameIterator mni(*mn); MemberDef *md; bool found=FALSE; for (mni.toFirst();(md=mni.current()) && !found;++mni) { bool ambig; NamespaceDef *nd=md->getNamespaceDef(); //printf("Namespace namespaceName=%s nd=%s\n", // namespaceName.data(),nd ? nd->name().data() : ""); FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); //printf("File %s\n",fd ? fd->name().data() : ""); NamespaceList *nl = fd ? fd->getUsedNamespaces() : 0; //printf("NamespaceList %p\n",nl); // search in the list of namespaces that are imported via a // using declaration bool viaUsingDirective = nl && nd && nl->find(nd)!=-1; if ((namespaceName.isEmpty() && nd==0) || // not in a namespace (nd && nd->name()==namespaceName) || // or in the same namespace viaUsingDirective // member in `using' namespace ) { Debug::print(Debug::FindMembers,0,"4. Try to add member `%s' to scope `%s'\n", md->name().data(),namespaceName.data()); QCString nsName = nd ? nd->name().data() : ""; bool matching= (md->argumentList()==0 && root->argList->count()==0) || md->isVariable() || md->isTypedef() || /* in case of function pointers */ matchArguments(md->argumentList(),root->argList,0,nsName); if (matching) // add docs to the member { Debug::print(Debug::FindMembers,0,"5. Match found\n"); addMemberDocs(root,md,decl,root->argList,FALSE); found=TRUE; } } } if (!found) // no match { QCString fullFuncDecl=decl; if (root->argList) fullFuncDecl+=argListToString(root->argList); warn(root->fileName,root->startLine, "Warning: no matching file member found for \n%s",fullFuncDecl.data()); if (mn->count()>0) { warn_cont("Possible candidates:\n"); for (mni.toFirst();(md=mni.current());++mni) { warn_cont(" %s\n",md->declaration()); } } } } else // got docs for an undefined member! { warn(root->fileName,root->startLine, "Warning: documented function `%s' was not defined.",decl ); } return TRUE; } static void substituteTemplateArgNames(ArgumentList *src, const QCString &s, ArgumentList *tempArgs, ArgumentList *dst) { ArgumentListIterator ali(*src); Argument *a=0; for (ali.toFirst();(a=ali.current());++ali) // for each member argument { QCString type=a->type.copy(); bool isReplaced=FALSE; QRegExp re(idMask); int i,p=0,l,c=0; while (!s.isEmpty() && (i=re.match(s,p,&l))!=-1) // for each template name found at the // member definition { Argument *ta = c<(int)tempArgs->count() ? tempArgs->at(c) : 0; if (ta) // get matching template argument of the class { QCString dstName=s.mid(i,l); QCString srcName=ta->name.copy(); if (srcName.isEmpty()) srcName=ta->type.copy(); //printf("1.Template Name = `%s' -> `%s'\n",srcName.data(),dstName.data()); int bi; if ((bi=srcName.findRev(' '))!=-1) // search for separator { // strip the type specifier (usually class or typename) srcName=srcName.right(srcName.length()-bi-1); } //if (srcName.left(6)=="class ") srcName=srcName.right(srcName.length()-6); //if (srcName.left(9)=="typename ") srcName=srcName.right(srcName.length()-9); //printf("2.Template Name = `%s' -> `%s'\n",srcName.data(),dstName.data()); if (srcName!=dstName) /* we need to substitute */ { int ti,tp=0; QCString result; int sl=srcName.length(); while ((ti=type.find(srcName,tp))!=-1) { result+=type.mid(tp,ti-tp); if ( (ti==0 || !isId(type.at(ti-1))) && (ti+sl==(int)type.length() || !isId(type.at(ti+sl))) ) /* idenitifier -> replace */ { result+=dstName; } else /* substring of an identifier */ { result+=srcName; } tp=ti+sl; } result+=type.right(type.length()-tp); type=result; isReplaced = TRUE; } } p=i+l; c++; } Argument *na = new Argument(*a); if (isReplaced) { //printf("Template Arg: `%s' -> `%s'\n",na->type.data(),type.data()); na->type=type; } else { //printf("Template Arg `%s' not changed\n",a->type.data()); } dst->append(na); } //printf("substituteTemplateArgNames(\nsrc=`%s',\ntempNameStr=`%s',\ntempArgs=`%s',\ndest=`%s'\n)\n", // argListToString(src).data(), // s.data(), // argListToString(tempArgs).data(), // argListToString(dst).data() // ); dst->constSpecifier = src->constSpecifier; dst->volatileSpecifier = src->volatileSpecifier; dst->pureSpecifier = src->pureSpecifier; } /*! This function tries to find a member (in a documented class/file/namespace) * that corresponds to the function declaration given in \a funcDecl. * * The \a related field may be used to specify a related class name. * It is only used if the class name cannot be extracted from the function * declaration. * * The boolean \a overloaded is used to specify whether or not a standard * overload documentation line should be generated. */ static void findMember(Entry *root,QCString funcDecl,QCString related,bool overloaded, bool isFunc) { Debug::print(Debug::FindMembers,0, "findMember(root=%p,funcDecl=`%s',related=`%s',overload=%d," "isFunc=%d mGrpId=%d tArgList=%p=\"%s\" mtArgList=%p=\"%s\" " "scopeSpec=%s memberSpec=%s memSpec=%d\n", root,funcDecl.data(),related.data(),overloaded,isFunc,root->mGrpId, root->tArgList,tempArgListToString(root->tArgList).data(), root->mtArgList,tempArgListToString(root->mtArgList).data(), root->scopeSpec.data(),root->memberSpec.data(),root->memSpec ); //if (Config::includeSourceFlag && !root->body.isEmpty()) //{ // //printf("Function: %s\n-----------------\n%s\n------------------\n", // //root->name.data(),root->body.data()); //} QCString scopeName; QCString className; QCString namespaceName; QCString classTempList; QCString funcType; QCString funcName; QCString funcArgs; QCString funcTempList; QCString exceptions; bool isRelated=FALSE; bool isFriend=FALSE; bool done; do { done=TRUE; if (funcDecl.left(7)=="friend ") // treat friends as related members { funcDecl=funcDecl.right(funcDecl.length()-7); isFriend=TRUE; done=FALSE; } if (funcDecl.left(7)=="inline ") { funcDecl=funcDecl.right(funcDecl.length()-7); root->memSpec|=Entry::Inline; done=FALSE; } if (funcDecl.left(9)=="explicit ") { funcDecl=funcDecl.right(funcDecl.length()-9); root->memSpec|=Entry::Explicit; done=FALSE; } if (funcDecl.left(8)=="mutable ") { funcDecl=funcDecl.right(funcDecl.length()-8); root->memSpec|=Entry::Mutable; done=FALSE; } if (funcDecl.left(8)=="virtual ") { funcDecl=funcDecl.right(funcDecl.length()-7); done=FALSE; } } while (!done); // delete any ; from the function declaration int sep; while ((sep=funcDecl.find(';'))!=-1) { funcDecl=(funcDecl.left(sep)+funcDecl.right(funcDecl.length()-sep-1)).stripWhiteSpace(); } // make sure the first character is a space to simplify searching. if (!funcDecl.isEmpty() && funcDecl[0]!=' ') funcDecl.prepend(" "); // remove some superfluous spaces funcDecl=substitute( substitute( substitute(funcDecl,"~ ","~"), ":: ","::" ), " ::","::" ); // extract information from the declarations parseFuncDecl(funcDecl,scopeName,classTempList,funcType,funcName, funcArgs,funcTempList,exceptions ); //printf("scopeName=`%s' funcType=`%s' funcName=`%s'\n", // scopeName.data(),funcType.data(),funcName.data()); //bool isSpecialization = !root->scopeSpec.isEmpty() && // root->scopeSpec != tempArgListToString(root->tArgList); // if this is a member template inside non template class, the parser puts // template specifier in scopeSepc, so we copy it to the right location here if (scopeName.isEmpty() && !root->scopeSpec.isEmpty() && root->memberSpec.isEmpty() && funcTempList.isEmpty() ) // template specifier that was found is for a function { funcTempList = root->scopeSpec; } // the class name can also be a namespace name, we decide this later. // if a related class name is specified and the class name could // not be derived from the function declaration, then use the // related field. //printf("scopeName=`%s' className=`%s' namespaceName=`%s'\n", // scopeName.data(),className.data(),namespaceName.data()); if (!related.isEmpty() && !isRelated) { // related member, prefix user specified scope isRelated=TRUE; //scopeName=resolveDefines(related); if (!scopeName.isEmpty() && scopeName!=related) scopeName+="::"+related; else scopeName=related.copy(); } // split scope into a namespace and a class part extractNamespaceName(scopeName,className,namespaceName); //printf("scopeName=`%s' className=`%s' namespaceName=`%s'\n", // scopeName.data(),className.data(),namespaceName.data()); if (related.isEmpty() && root->parent && !root->parent->name.isEmpty() ) // prefix scope in which the member was found { Entry *p=root->parent; while (p) // get full scope as class name { QCString sc = stripAnnonymousNamespaceScope(p->name); if ((p->section & Entry::SCOPE_MASK) && !sc.isEmpty() && sc[0]!='@' ) { QCString cn; QCString nn; extractNamespaceName(sc,cn,nn); if (leftScopeMatch(nn,namespaceName) || namespaceName.isEmpty()) { namespaceName=nn.copy(); } if (leftScopeMatch(cn,className) || className.isEmpty()) { className=cn.copy(); } //printf("sc=`%s' cn=`%s' nn=`%s'\n",sc.data(),cn.data(),nn.data()); //printf("p->name=`%s' scopeName=`%s' classTempList=%s\n", // p->name.data(),scopeName.data(),classTempList.data()); QCString tryClass; if (className.find('<')==-1 && !classTempList.isEmpty()) tryClass=insertTemplateSpecifierInScope(className,classTempList); else tryClass=className.copy(); //printf("tryClass=%s\n",tryClass.data()); if (leftScopeMatch(tryClass,cn)) break; // scope already present, so stop now // prepend name to scope if (!scopeName.isEmpty()) scopeName.prepend("::"); scopeName.prepend(sc); break; } p=p->parent; } //printf("3. scopeName=`%s'\n",scopeName.data()); //printf("result: scope=%s\n",scopeName.data()); } namespaceName=removeAnonymousScopes(namespaceName); //printf("namespaceName=`%s' className=`%s'\n",namespaceName.data(),className.data()); // merge class and namespace scopes again scopeName.resize(0); if (!namespaceName.isEmpty()) { if (className.isEmpty()) { scopeName=namespaceName; } else { scopeName=namespaceName+"::"+className; } } else if (!className.isEmpty()) { scopeName=className; } //printf("new scope=`%s'\n",scopeName.data()); if (!scopeName.isEmpty() && scopeName.find('<')==-1 && classTempList.isEmpty() ) { ClassDef *cd=getClass(scopeName); // class is a template, but no template name list found if (root->tArgList && cd && cd->templateArguments()) { classTempList = tempArgListToString(root->tArgList); } } QCString tempScopeName=scopeName.copy(); int ti=tempScopeName.find('<'); if (ti==-1) { int spi = namespaceName.isEmpty() ? 0 : namespaceName.length()+2; if ((ti=tempScopeName.find("::",spi))!=-1 && !classTempList.isEmpty()) { // insert template parameters after the first scope name tempScopeName=tempScopeName.left(ti)+classTempList+ tempScopeName.right(tempScopeName.length()-ti); } else { tempScopeName+=classTempList; } } if (root->tArgList==0 && root->mtArgList==0 && !classTempList.isEmpty()) { // no template specifiers found during parsing (because \fn was used), // but there are template names in the scope, so we build the template // specifiers from that. //printf("Building template list from `%s'\n",classTempList.data()); root->tArgList = new ArgumentList; QRegExp re(idMask); int i,p=0,l; while ((i=re.match(classTempList,p,&l))!=-1) // for each template name found { Argument *a = new Argument; a->type = "class "+classTempList.mid(i,l); root->tArgList->append(a); p=i+l; } } //printf("scopeName=`%s' className=`%s'\n",scopeName.data(),className.data()); // rebuild the function declaration (needed to get the scope right). if (!scopeName.isEmpty() && !isRelated && !isFriend && !Config::hideScopeNames) { if (!funcType.isEmpty()) { if (isFunc) // a function -> we use argList for the arguments { funcDecl=funcType+" "+tempScopeName+"::"+funcName+funcTempList; } else { funcDecl=funcType+" "+tempScopeName+"::"+funcName+funcArgs; } } else { if (isFunc) // a function => we use argList for the arguments { funcDecl=tempScopeName+"::"+funcName+funcTempList; } else // variable => add `argument' list { funcDecl=tempScopeName+"::"+funcName+funcArgs; } } } else // build declaration without scope { if (!funcType.isEmpty()) // but with a type { if (isFunc) // function => omit argument list { funcDecl=funcType+" "+funcName+funcTempList; } else // variable => add `argument' list { funcDecl=funcType+" "+funcName+funcArgs; } } else // no type { if (isFunc) { funcDecl=funcName+funcTempList; } else { funcDecl=funcName+funcArgs; } } } QCString fullFuncDecl=funcDecl.copy(); if (isFunc) fullFuncDecl+=argListToString(root->argList); if (funcType=="template class" && !funcTempList.isEmpty()) return; // ignore explicit template instantiations Debug::print(Debug::FindMembers,0, "findMember() Parse results:\n" " namespaceName=`%s'\n" " className=`%s`\n" " classTempList=`%s'\n" " funcType=`%s'\n" " funcName=`%s'\n" " funcArgs=`%s'\n" " funcTempList=`%s'\n" " funcDecl=`%s'\n" " related=`%s'\n" " exceptions=`%s'\n" " isRelated=%d\n" " isFiend=%d\n" " isFunc=%d\n\n", namespaceName.data(),className.data(),classTempList.data(), funcType.data(),funcName.data(),funcArgs.data(),funcTempList.data(), funcDecl.data(),related.data(),exceptions.data(),isRelated,isFriend, isFunc ); MemberName *mn=0; if (!funcName.isEmpty()) // function name is valid { Debug::print(Debug::FindMembers,0, "1. funcName=`%s'\n",funcName.data()); if (!funcTempList.isEmpty()) // try with member specialization { mn=memberNameDict[funcName+funcTempList]; } if (mn==0) // try without specialization { mn=memberNameDict[funcName]; } if (!isRelated && mn) // function name already found { Debug::print(Debug::FindMembers,0, "2. member name exists \n"); if (!className.isEmpty()) // class name is valid { int count=0; MemberNameIterator mni(*mn); MemberDef *md; for (mni.toFirst();(md=mni.current());++mni) { Debug::print(Debug::FindMembers,0, "3. member definition found scopeName=`%s'\n",scopeName.data()); ClassDef *cd=md->getClassDef(); //printf("Member %s (member scopeName=%s) (this scopeName=%s) classTempList=%s\n",md->name().data(),cd->name().data(),scopeName.data(),classTempList.data()); ClassDef *tcd=0; bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); NamespaceDef *nd=0; if (!namespaceName.isEmpty()) nd=getResolvedNamespace(namespaceName); tcd = findClassDefinition(fd,nd,scopeName,classTempList); if (cd && tcd==cd) // member's classes match { Debug::print(Debug::FindMembers,0, "4. class definition %s found\n",cd->name().data()); int ci; ArgumentList *classTemplArgs = cd->templateArguments(); ArgumentList *funcTemplArgs = md->memberDefTemplateArguments(); if ((ci=cd->name().find("::"))!=-1) // nested class { ClassDef *parentClass = getClass(cd->name().left(ci)); if (parentClass) classTemplArgs = parentClass->templateArguments(); } //printf("cd->name=%s classTemplArgs=%s\n",cd->name().data(), // argListToString(classTemplArgs).data()); ArgumentList *argList = 0; bool substDone=FALSE; /* substitute the occurrences of class template names in the * argument list before matching */ if (!classTempList.isEmpty() && classTemplArgs && md->argumentList() ) { /* the function definition has template arguments * and the class also has template arguments, so * we must substitute the template names if they are * different before doing the match */ argList = new ArgumentList; argList->setAutoDelete(TRUE); substituteTemplateArgNames( md->argumentList(), /* source argument list */ classTempList, /* template names source */ classTemplArgs, /* template names dest */ argList /* dest argument list */ ); substDone=TRUE; } else /* no template arguments, compare argument lists directly */ { argList = md->argumentList(); } /* substitute the occurrences of member template names in the * argument list before matching */ if (!funcTempList.isEmpty() && funcTemplArgs && md->argumentList() ) { ArgumentList *oldArgList = argList; argList = new ArgumentList; substituteTemplateArgNames( oldArgList, /* source argument list */ funcTempList, /* template names source */ funcTemplArgs, /* template names dest */ argList /* dest argument list */ ); if (substDone) // delete old argument list { delete oldArgList; } substDone=TRUE; } Debug::print(Debug::FindMembers,0, "5. matching `%s'<=>`%s' className=%s namespaceName=%s\n", argListToString(argList).data(),argListToString(root->argList).data(), className.data(),namespaceName.data() ); // TODO: match loop for all possible scopes bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); // list of namespaces using in the file that this member definition is part of NamespaceList *nl = fd ? fd->getUsedNamespaces() : 0; bool matching= md->isVariable() || md->isTypedef() || // needed for function pointers (md->argumentList()==0 && root->argList->count()==0) || matchArguments(argList, root->argList,className,namespaceName,TRUE,nl); Debug::print(Debug::FindMembers,0, "6. match results = %d\n",matching); if (substDone) // found a new argument list { //printf("root->tArgList=`%s'\n",argListToString(root->tArgList).data()); if (matching) // replace member's argument list { //printf("Setting scope template argument of member %s to %s\n", // md->name().data(), argListToString(root->tArgList).data() // ); //printf("Setting member template argument of member %s to %s\n", // md->name().data(), argListToString(root->mtArgList).data() // ); md->setScopeDefTemplateArguments(root->tArgList); md->setMemberDefTemplateArguments(root->mtArgList); md->setArgumentList(argList); } else // no match -> delete argument list { delete argList; } } if (matching) { //printf("addMemberDocs root->inLine=%d md->isInline()=%d\n", // root->inLine,md->isInline()); addMemberDocs(root,md,funcDecl,0,overloaded,nl); count++; } } } if (count==0 && !(isFriend && funcType=="class")) { warn(root->fileName,root->startLine, "Warning: no matching class member found for \n %s", fullFuncDecl.data() ); int candidates=0; if (mn->count()>0) { for (mni.toFirst();(md=mni.current());++mni) { ClassDef *cd=md->getClassDef(); if (cd!=0 && cd->name()==className) candidates++; } } if (candidates>0) { warn_cont("Possible candidates:\n"); for (mni.toFirst();(md=mni.current());++mni) { ClassDef *cd=md->getClassDef(); if (cd!=0 && cd->name()==className) { warn_cont(" %s\n",md->declaration()); } } } } } else if (overloaded) // check if the function belongs to only one class { // for unique overloaded member we allow the class to be // omitted, this is to be Qt compatable. Using this should // however be avoided, because it is error prone MemberNameIterator mni(*mn); MemberDef *md=mni.toFirst(); ASSERT(md); ClassDef *cd=md->getClassDef(); ASSERT(cd); QCString className=cd->name().copy(); ++mni; bool unique=TRUE; for (;(md=mni.current());++mni) { ClassDef *cd=md->getClassDef(); if (className!=cd->name()) unique=FALSE; } if (unique) { MemberDef::MemberType mtype; if (root->mtype==Signal) mtype=MemberDef::Signal; else if (root->mtype==Slot) mtype=MemberDef::Slot; else if (root->mtype==DCOP) mtype=MemberDef::DCOP; else mtype=MemberDef::Function; // new overloaded member function MemberDef *md=new MemberDef( root->fileName,root->startLine, funcType,funcName,funcArgs,exceptions, root->protection,root->virt,root->stat,TRUE, mtype,root->tArgList,root->argList); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } md->setMemberClass(cd); md->setDefinition(funcDecl); QCString doc=getOverloadDocs(); doc+="

"; doc+=root->doc; md->setDocumentation(doc); md->setPrototype(root->proto); md->addSectionsToDefinition(root->anchors); md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); md->setBodyDef(fd); md->setMemberSpecifiers(root->memSpec); md->setMemberGroupId(root->mGrpId); mn->append(md); cd->insertMember(md); cd->insertUsedFile(root->fileName); md->setRefItems(root->todoId,root->testId); } } else // unrelated function with the same name as a member { if (!findUnrelatedFunction(root,namespaceName,funcName,funcTempList,funcArgs,funcDecl)) { warn(root->fileName,root->startLine, "Warning: Cannot determine class for function\n%s", fullFuncDecl.data() ); } } } else if (isRelated && !related.isEmpty()) { if (className.isEmpty()) className=related.copy(); ClassDef *cd; if ((cd=getClass(scopeName))) { bool newMember=TRUE; // assume we have a new member bool newMemberName=FALSE; if ((mn=memberNameDict[funcName])==0) { mn=new MemberName(funcName); newMemberName=TRUE; // we create a new member name } else { MemberDef *rmd=mn->first(); while (rmd && newMember) // see if we got another member with matching arguments { newMember=newMember && !matchArguments(rmd->argumentList(),root->argList,className,namespaceName); if (newMember) rmd=mn->next(); } if (!newMember && rmd) // member already exists as rmd -> add docs { //printf("addMemberDocs for related member %s\n",root->name.data()); rmd->setMemberDefTemplateArguments(root->mtArgList); addMemberDocs(root,rmd,funcDecl,0,overloaded); } } if (newMember) // need to create a new member { MemberDef::MemberType mtype; if (root->mtype==Signal) mtype=MemberDef::Signal; else if (root->mtype==Slot) mtype=MemberDef::Slot; else if (root->mtype==DCOP) mtype=MemberDef::DCOP; else mtype=MemberDef::Function; // new related (member) function MemberDef *md=new MemberDef( root->fileName,root->startLine, funcType,funcName,funcArgs,exceptions, root->protection,root->virt,root->stat,TRUE, mtype,root->tArgList,root->argList); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } //printf("Related member name=`%s' decl=`%s' bodyLine=`%d'\n", // funcName.data(),funcDecl.data(),root->bodyLine); // try to find the matching line number of the body from the // global function list bool found=FALSE; if (root->bodyLine==-1) { MemberName *rmn=functionNameDict[funcName]; if (rmn) { MemberDef *rmd=rmn->first(); while (rmd && !found) // see if we got another member with matching arguments { // check for matching argument lists if (matchArguments(rmd->argumentList(), root->argList, className, namespaceName) ) { found=TRUE; } if (!found) rmd=rmn->next(); } if (rmd) // member found -> copy line number info { md->setBodySegment(rmd->getStartBodyLine(),rmd->getEndBodyLine()); md->setBodyDef(rmd->getBodyDef()); } } } if (!found) // line number could not be found or is available in this // entry { md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); md->setBodyDef(fd); } //if (root->mGrpId!=-1) //{ // md->setMemberGroup(memberGroupDict[root->mGrpId]); //} md->setMemberClass(cd); md->setMemberSpecifiers(root->memSpec); md->setDefinition(funcDecl); md->setPrototype(root->proto); md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->addSectionsToDefinition(root->anchors); md->setMemberGroupId(root->mGrpId); md->setMemberDefTemplateArguments(root->mtArgList); mn->append(md); cd->insertMember(md); cd->insertUsedFile(root->fileName); md->setRefItems(root->todoId,root->testId); if (newMemberName) { //printf("Adding memberName=%s\n",mn->memberName()); memberNameList.append(mn); memberNameDict.insert(funcName,mn); } } } else { warn_undoc(root->fileName,root->startLine, "Warning: class `%s' for related function `%s' is not " "documented.", className.data(),funcName.data() ); } } else // unrelated not overloaded member found { if (className.isEmpty() && !findUnrelatedFunction(root,namespaceName,funcName,funcTempList,funcArgs,funcDecl)) { warn(root->fileName,root->startLine, "Warning: class for member %s cannot " "be found.", funcName.data() ); } else if (!className.isEmpty()) { warn(root->fileName,root->startLine, "Warning: member %s of class %s cannot be found", funcName.data(),className.data()); } } } else { // this should not be called warn(root->fileName,root->startLine, "Warning: member with no name found."); } return; } //---------------------------------------------------------------------- // find the members corresponding to the different documentation blocks // that are extracted from the sources. static void findMemberDocumentation(Entry *root) { int i=-1,l; QRegExp re("([a-z_A-Z0-9: ]*\\*+[ \\*]*"); Debug::print(Debug::FindMembers,0, "root->type=`%s' root->inside=`%s' root->name=`%s' root->args=`%s' section=%x root->memSpec=%d root->mGrpId=%d\n", root->type.data(),root->inside.data(),root->name.data(),root->args.data(),root->section,root->memSpec,root->mGrpId ); bool isFunc=TRUE; if (!root->type.isEmpty() && (i=re.match(root->type,0,&l))!=-1) // func variable/typedef to func ptr { root->args+=root->type.right(root->type.length()-i-l); root->type=root->type.left(i+l); isFunc=FALSE; } else if (root->name.find(re)!=-1 && root->name.find("operator")==-1) // func ptr entered with \fn, \var or \typedef { isFunc=FALSE; } else if ((root->type.isEmpty() && root->name.left(8)=="typedef ") || root->args.find('(')==-1) { isFunc=FALSE; } //printf("Member %s isFunc=%d\n",root->name.data(),isFunc); if (root->section==Entry::MEMBERDOC_SEC) { //printf("Documentation for inline member `%s' found args=`%s'\n", // root->name.data(),root->args.data()); //if (root->relates.length()) printf(" Relates %s\n",root->relates.data()); findMember(root,root->name+root->args+root->exception,root->relates,FALSE,isFunc); } else if (root->section==Entry::OVERLOADDOC_SEC) { //printf("Overloaded member %s found\n",root->name.data()); findMember(root,root->name,root->relates,TRUE,isFunc); } else if ((root->section==Entry::FUNCTION_SEC // function || (root->section==Entry::VARIABLE_SEC && // variable !root->type.isEmpty() && /*root->type.left(8)!="typedef " &&*/ compoundKeywordDict.find(root->type)==0 ) ) && (!root->doc.isEmpty() || !root->brief.isEmpty() || root->bodyLine!=-1 || (root->memSpec&Entry::Inline) || root->mGrpId!=-1 ) ) { //printf("Documentation for member `%s' found args=`%s' excp=`%s'\n", // root->name.data(),root->args.data(),root->exception.data()); //if (root->relates.length()) printf(" Relates %s\n",root->relates.data()); //printf("Inside=%s\n Relates=%s\n",root->inside.data(),root->relates.data()); if (!root->type.isEmpty()) { findMember(root, root->type+" "+ root->inside+ root->name+ root->args+ root->exception, root->relates, FALSE,isFunc); } else { findMember(root, root->inside+ root->name+ root->args+ root->exception, root->relates, FALSE,isFunc); } } else if (root->section==Entry::VARIABLEDOC_SEC) { //printf("Documentation for variable %s found\n",root->name.data()); //if (!root->relates.isEmpty()) printf(" Relates %s\n",root->relates.data()); findMember(root,root->name,root->relates,FALSE,FALSE); } else { // skip section } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { if (e->section!=Entry::ENUM_SEC) findMemberDocumentation(e); } } //---------------------------------------------------------------------- // find and add the enumeration to their classes, namespaces or files static void findEnums(Entry *root) { if (root->section==Entry::ENUM_SEC) // non anonymous enumeration { MemberDef *md=0; ClassDef *cd=0; FileDef *fd=0; NamespaceDef *nd=0; MemberNameDict *mnd=0; MemberNameList *mnl=0; bool isGlobal; //printf("Found enum with name `%s'\n",root->name.data()); int i; QCString name; if ((i=root->name.findRev("::"))!=-1) // scope is specified { QCString scope=root->name.left(i); // extract scope name=root->name.right(root->name.length()-i-2); // extract name if ((cd=getClass(scope))==0) nd=getResolvedNamespace(scope); } else // no scope, check the scope in which the docs where found { if (( root->parent->section & Entry::SCOPE_MASK ) && !root->parent->name.isEmpty() ) // found enum docs inside a compound { QCString scope=root->parent->name; if ((cd=getClass(scope))==0) nd=getResolvedNamespace(scope); } name=root->name.copy(); } if (cd && !name.isEmpty()) // found a enum inside a compound { //printf("Enum `%s'::`%s'\n",cd->name(),name.data()); fd=0; mnd=&memberNameDict; mnl=&memberNameList; isGlobal=FALSE; } else if (nd && !nd->name().isEmpty() && nd->name().at(0)!='@') // found enum inside namespace { mnd=&functionNameDict; mnl=&functionNameList; isGlobal=TRUE; } else // found a global enum { bool ambig; fd=findFileDef(inputNameDict,root->fileName,ambig); mnd=&functionNameDict; mnl=&functionNameList; isGlobal=TRUE; } if (!name.isEmpty()) { // new enum type md = new MemberDef( root->fileName,root->startLine, 0,name,0,0,root->protection,Normal,FALSE,FALSE, MemberDef::Enumeration,0,0); if (root->tagInfo) { md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); } if (!isGlobal) md->setMemberClass(cd); else md->setFileDef(fd); //md->setDefFile(root->fileName); //md->setDefLine(root->startLine); md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; md->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); //printf("Enum %s definition at line %d of %s: protection=%d\n", // root->name.data(),root->bodyLine,root->fileName.data(),root->protection); md->addSectionsToDefinition(root->anchors); md->setMemberGroupId(root->mGrpId); //if (root->mGrpId!=-1) //{ // md->setMemberGroup(memberGroupDict[root->mGrpId]); //} md->setRefItems(root->todoId,root->testId); if (nd && !nd->name().isEmpty() && nd->name().at(0)!='@') { if (Config::hideScopeNames) { md->setDefinition(name); } else { md->setDefinition(nd->name()+"::"+name); } nd->insertMember(md); md->setNamespace(nd); } else if (isGlobal) { md->setDefinition(name); if (fd==0 && root->tagInfo) { bool ambig; QCString filePathName = root->parent->fileName; fd=findFileDef(inputNameDict,filePathName,ambig); } if (fd) { fd->insertMember(md); md->setFileDef(fd); } } else if (cd) { if (Config::hideScopeNames) { md->setDefinition(name); } else { md->setDefinition(cd->name()+"::"+name); } cd->insertMember(md); cd->insertUsedFile(root->fileName); } md->setDocumentation(root->doc); md->setBriefDescription(root->brief); MemberName *mn; if ((mn=(*mnd)[name])) { // this is used if the same enum is in multiple namespaces/classes mn->append(md); } else // new enum name { mn = new MemberName(name); mn->append(md); mnd->insert(name,mn); mnl->append(mn); //printf("add %s to new memberName. Now %d members\n", // name.data(),mn->count()); } addMemberToGroups(root,md); EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { MemberName *fmn=0; if (!e->name.isEmpty() && (fmn=(*mnd)[e->name])) // get list of members with the same name as the field { MemberNameIterator fmni(*fmn); MemberDef *fmd; for (fmni.toFirst(); (fmd=fmni.current()) && fmd->isEnumValue(); ++fmni ) // search for the scope with the right name { if (nd && !nd->name().isEmpty() && nd->name().at(0)!='@') { NamespaceDef *fnd=fmd->getNamespaceDef(); if (fnd==nd) // enum value is inside a namespace { md->insertEnumField(fmd); fmd->setEnumScope(md); } } else if (isGlobal) { FileDef *ffd=fmd->getFileDef(); if (ffd==fd) // enum value has file scope { md->insertEnumField(fmd); fmd->setEnumScope(md); } } else { ClassDef *fcd=fmd->getClassDef(); if (fcd==cd) // enum value is inside a class { md->insertEnumField(fmd); // add field def to list fmd->setEnumScope(md); // cross ref with enum name } } } } } } } else { EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { findEnums(e); } } } //---------------------------------------------------------------------- // find the documentation blocks for the enumerations static void findEnumDocumentation(Entry *root) { if (root->section==Entry::ENUMDOC_SEC && !root->name.isEmpty() && root->name[0]!='@' // skip anonymous enums ) { //printf("Found docs for enum with name `%s'\n",root->name.data()); int i; ClassDef *cd=0; QCString name; if ((i=root->name.findRev("::"))!=-1) // scope is specified { QCString scope=root->name.left(i); // extract scope name=root->name.right(root->name.length()-i-2); // extract name cd=getClass(scope); //printf("Scope=`%s' Name=`%s'\n",scope.data(),name.data()); } else // no scope, check the scope in which the docs where found { if (( root->parent->section & Entry::COMPOUND_MASK ) && !root->parent->name.isEmpty() ) // found enum docs inside a compound { cd=getClass(root->parent->name); } name=root->name.copy(); } if (!name.isEmpty()) { bool found=FALSE; if (cd) { //printf("Enum: scope=`%s' name=`%s'\n",cd->name(),name.data()); QCString className=cd->name().copy(); MemberName *mn=memberNameDict[name]; if (mn) { MemberNameIterator mni(*mn); MemberDef *md; for (mni.toFirst();(md=mni.current()) && !found;++mni) { ClassDef *cd=md->getClassDef(); if (cd && cd->name()==className) { // documentation outside a compound overrides the documentation inside it if (!md->documentation() || root->parent->name.isEmpty()) { md->setDocumentation(root->doc); } // brief descriptions inside a compound override the documentation // outside it if (!md->briefDescription() || !root->parent->name.isEmpty()) { md->setBriefDescription(root->brief); } if (root->mGrpId!=-1 && md->getMemberGroupId()==-1) { md->setMemberGroupId(root->mGrpId); } md->addSectionsToDefinition(root->anchors); found=TRUE; } } } else { //printf("MemberName %s not found!\n",name.data()); } } else // enum outside class { MemberDef *md; MemberName *mn=functionNameDict[name]; if (mn && (md=mn->getFirst())) { md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->addSectionsToDefinition(root->anchors); md->setMemberGroupId(root->mGrpId); found=TRUE; } } if (!found) { warn(root->fileName,root->startLine, "Warning: Documentation for undefined enum `%s' found.", name.data() ); } } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { findEnumDocumentation(e); } } // seach for each enum (member or function) in mnl if it has documented // enum values. static void findDEV(const MemberNameList &mnl) { MemberName *mn; MemberNameListIterator mnli(mnl); // for each member name for (mnli.toFirst();(mn=mnli.current());++mnli) { MemberDef *md; MemberNameIterator mni(*mn); // for each member definition for (mni.toFirst();(md=mni.current());++mni) { if (md->isEnumerate()) // member is an enum { MemberList *fmdl = md->enumFieldList(); int documentedEnumValues=0; if (fmdl) // enum has values { MemberListIterator fmni(*fmdl); MemberDef *fmd; // for each enum value for (fmni.toFirst();(fmd=fmni.current());++fmni) { if (fmd->isLinkableInProject()) documentedEnumValues++; } } // at least one enum value is documented if (documentedEnumValues>0) md->setDocumentedEnumValues(TRUE); } } } } // seach for each enum (member or function) if it has documented enum // values. static void findDocumentedEnumValues() { findDEV(memberNameList); findDEV(functionNameList); } //---------------------------------------------------------------------- // computes the relation between all members. For each member `m' // the members that override the implementation of `m' are searched and // the member that `m' overrides is searched. static void computeMemberRelations() { MemberNameListIterator mnli(memberNameList); MemberName *mn; for ( ; (mn=mnli.current()) ; ++mnli ) // for each member name { MemberNameIterator mdi(*mn); MemberDef *md; for ( ; (md=mdi.current()) ; ++mdi ) // for each member with a specific arg list { MemberNameIterator bmdi(*mn); MemberDef *bmd; for ( ; (bmd=bmdi.current()) ; ++bmdi ) // for each other member with that signature { ClassDef *bmcd = bmd->getClassDef(); ClassDef *mcd = md->getClassDef(); //printf("Check relation between `%s'::`%s' and `%s'::`%s'\n", // mcd->name().data(),md->name().data(), // bmcd->name().data(),bmd->name().data() // ); if (md!=bmd && bmcd && mcd && bmcd!=mcd && mcd->isBaseClass(bmcd)) { //printf(" Base argList=`%s'\n Super argList=`%s'\n", // argListToString(bmd->argumentList()).data(), // argListToString(md->argumentList()).data() // ); if ( matchArguments(bmd->argumentList(),md->argumentList()) ) { //printf(" match found!\n"); if (mcd && bmcd && mcd->isLinkable() && bmcd->isLinkable() ) { MemberDef *rmd; if ((rmd=md->reimplements())==0 || minClassDistance(mcd,bmcd)getClassDef()) ) { //printf("setting (new) reimplements member\n"); md->setReimplements(bmd); } bmd->insertReimplementedBy(md); } } } } } } } //---------------------------------------------------------------------------- static void computeClassImplUsageRelations() { ClassDef *cd; ClassListIterator cli(classList); for (;(cd=cli.current());++cli) { cd->determineImplUsageRelation(); } } //---------------------------------------------------------------------------- // builds the list of all members for each class static void buildCompleteMemberLists() { ClassDef *cd; // merge the member list of base classes into the inherited classes. ClassListIterator cli(classList); for (cli.toFirst();(cd=cli.current());++cli) { if (!cd->isReference() && // not an external class cd->superClasses()->count()==0 && // is a root of the hierarchy cd->baseClasses()->count()>0) // and has at least one base class { cd->mergeMembers(); } } // now sort the member list of all classes. for (cli.toFirst();(cd=cli.current());++cli) { cd->memberNameInfoList()->sort(); } } //---------------------------------------------------------------------------- static void generateFileSources() { if (documentedHtmlFiles==0) return; if (inputNameList.count()>0) { FileNameListIterator fnli(inputNameList); FileName *fn; for (;(fn=fnli.current());++fnli) { FileNameIterator fni(*fn); FileDef *fd; for (;(fd=fni.current());++fni) { if (fd->generateSourceFile()) { msg("Generating code for file %s...\n",fd->name().data()); fd->writeSource(*outputList); } } } } } //---------------------------------------------------------------------------- static void generateFileDocs() { if (documentedHtmlFiles==0) return; if (inputNameList.count()>0) { FileNameListIterator fnli(inputNameList); FileName *fn; for (fnli.toFirst();(fn=fnli.current());++fnli) { FileNameIterator fni(*fn); FileDef *fd; for (fni.toFirst();(fd=fni.current());++fni) { bool doc = fd->isLinkableInProject(); if (doc) { msg("Generating docs for file %s...\n",fd->name().data()); fd->writeDocumentation(*outputList); } } } } } //---------------------------------------------------------------------------- static void addSourceReferences() { // add source references for class definitions ClassListIterator cli(classList); ClassDef *cd=0; for (cli.toFirst();(cd=cli.current());++cli) { FileDef *fd=cd->getBodyDef(); if (fd && cd->isLinkableInProject() && cd->getStartBodyLine()!=-1) { fd->addSourceRef(cd->getStartBodyLine(),cd,0); } } // add source references for namespace definitions NamespaceListIterator nli(namespaceList); NamespaceDef *nd=0; for (nli.toFirst();(nd=nli.current());++nli) { FileDef *fd=nd->getBodyDef(); if (fd && nd->isLinkableInProject() && nd->getStartBodyLine()!=-1) { fd->addSourceRef(nd->getStartBodyLine(),nd,0); } } // add source references for member names MemberNameListIterator mnli(memberNameList); MemberName *mn=0; for (mnli.toFirst();(mn=mnli.current());++mnli) { MemberNameIterator mni(*mn); MemberDef *md=0; for (mni.toFirst();(md=mni.current());++mni) { ClassDef *cd=md->getClassDef(); FileDef *fd=md->getBodyDef(); if (fd && cd && cd->isLinkableInProject() && md->getStartBodyLine()!=-1 && md->isLinkableInProject()) { Definition *d=cd; if (d==0) d=md->getNamespaceDef(); if (d==0) d=md->getFileDef(); fd->addSourceRef(md->getStartBodyLine(),d,md); } } } MemberNameListIterator fnli(functionNameList); for (fnli.toFirst();(mn=fnli.current());++fnli) { MemberNameIterator mni(*mn); MemberDef *md=0; for (mni.toFirst();(md=mni.current());++mni) { NamespaceDef *nd=md->getNamespaceDef(); FileDef *fd=md->getBodyDef(); GroupDef *gd=md->getGroupDef(); if (md->getStartBodyLine()!=-1 && md->isLinkableInProject() && ((nd && nd->isLinkableInProject()) || (fd && fd->isLinkableInProject()) || (gd && gd->isLinkableInProject()) ) ) { //printf("Found member `%s' in file `%s' at line `%d'\n", // md->name().data(),fd->name().data(),md->getStartBodyLine()); Definition *d=gd!=0 ? (Definition *)gd : (nd!=0 ? (Definition *)nd : (Definition *)fd); fd->addSourceRef(md->getStartBodyLine(),d,md); } } } } //---------------------------------------------------------------------------- // generate the documentation of all classes static void generateClassDocs() { // write the installdox script if necessary if (Config::generateHtml && (Config::tagFileList.count()>0 || Config::searchEngineFlag)) writeInstallScript(); msg("Generating annotated compound index...\n"); writeAnnotatedIndex(*outputList); if (Config::alphaIndexFlag) { msg("Generating alphabetical compound index...\n"); writeAlphabeticalIndex(*outputList); } msg("Generating hierarchical class index...\n"); writeHierarchicalIndex(*outputList); msg("Generating member index...\n"); writeMemberIndex(*outputList); if (exampleSDict->count()>0) { msg("Generating example index...\n"); } ClassListIterator cli(classList); for ( ; cli.current() ; ++cli ) { ClassDef *cd=cli.current(); if ( cd->isLinkableInProject() ) // skip external references and anonymous compounds { msg("Generating docs for compound %s...\n",cd->name().data()); cd->writeDocumentation(*outputList); cd->writeMemberList(*outputList); } } } //---------------------------------------------------------------------------- static void inheritDocumentation() { MemberNameListIterator mnli(memberNameList); MemberName *mn; //int count=0; for (;(mn=mnli.current());++mnli) { MemberNameIterator mni(*mn); MemberDef *md; for (;(md=mni.current());++mni) { //printf("%04d Member `%s'\n",count++,md->name().data()); if (md->documentation().isEmpty() && md->briefDescription().isEmpty()) { // no documentation yet MemberDef *bmd = md->reimplements(); while (bmd && bmd->documentation().isEmpty() && bmd->briefDescription().isEmpty() ) { // search up the inheritance tree for a documentation member bmd = bmd->reimplements(); } if (bmd) // copy the documentation from the reimplemented member { md->setDocumentation(bmd->documentation()); md->setBriefDescription(bmd->briefDescription()); } } } } } //---------------------------------------------------------------------------- static void addMembersToMemberGroup() { // for each class ClassListIterator cli(classList); ClassDef *cd; for ( ; (cd=cli.current()) ; ++cli ) { cd->addMembersToMemberGroup(); } // for each file FileName *fn=inputNameList.first(); while (fn) { FileDef *fd=fn->first(); while (fd) { fd->addMembersToMemberGroup(); fd=fn->next(); } fn=inputNameList.next(); } // for each namespace NamespaceDef *nd=namespaceList.first(); while (nd) { nd->addMembersToMemberGroup(); nd=namespaceList.next(); } // for each group GroupDef *gd=groupList.first(); while (gd) { gd->addMembersToMemberGroup(); gd=groupList.next(); } } //---------------------------------------------------------------------------- static void distributeMemberGroupDocumentation() { // for each class ClassListIterator cli(classList); ClassDef *cd; for ( ; (cd=cli.current()) ; ++cli ) { cd->distributeMemberGroupDocumentation(); } // for each file FileName *fn=inputNameList.first(); while (fn) { FileDef *fd=fn->first(); while (fd) { fd->distributeMemberGroupDocumentation(); fd=fn->next(); } fn=inputNameList.next(); } // for each namespace NamespaceDef *nd=namespaceList.first(); while (nd) { nd->distributeMemberGroupDocumentation(); nd=namespaceList.next(); } // for each group GroupDef *gd=groupList.first(); while (gd) { gd->distributeMemberGroupDocumentation(); gd=groupList.next(); } } //---------------------------------------------------------------------------- static void findDefineDocumentation(Entry *root) { if ((root->section==Entry::DEFINEDOC_SEC || root->section==Entry::DEFINE_SEC) && !root->name.isEmpty() ) { //printf("found define `%s' `%s' brief=`%s' doc=`%s'\n", // root->name.data(),root->args.data(),root->brief.data(),root->doc.data()); if (root->tagInfo && !root->name.isEmpty()) // define read from a tag file { MemberDef *md=new MemberDef("",1, "#define",root->name,root->args,0, Public,Normal,FALSE,FALSE,MemberDef::Define,0,0); md->setAnchor(root->tagInfo->anchor); md->setReference(root->tagInfo->tagName); bool ambig; QCString filePathName = root->parent->fileName; FileDef *fd=findFileDef(inputNameDict,filePathName,ambig); //printf("Searching for `%s' fd=%p\n",filePathName.data(),fd); md->setFileDef(fd); MemberName *mn; if ((mn=functionNameDict[root->name])) { mn->append(md); } else { mn = new MemberName(root->name); mn->append(md); functionNameDict.insert(root->name,mn); functionNameList.append(mn); } } MemberName *mn=functionNameDict[root->name]; if (mn) { int count=0; MemberDef *md=mn->first(); while (md) { if (md->memberType()==MemberDef::Define) count++; md=mn->next(); } if (count==1) { md=mn->first(); while (md) { if (md->memberType()==MemberDef::Define) { if (md->documentation().isEmpty()) md->setDocumentation(root->doc); if (md->briefDescription().isEmpty()) md->setBriefDescription(root->brief); md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; md->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); md->addSectionsToDefinition(root->anchors); md->setMaxInitLines(root->initLines); if (root->mGrpId!=-1) md->setMemberGroupId(root->mGrpId); addMemberToGroups(root,md); } md=mn->next(); } } else if (count>1 && (!root->doc.isEmpty() || !root->brief.isEmpty() || root->bodyLine!=-1 ) ) // multiple defines don't know where to add docs // but maybe they are in different files together with their documentation { md=mn->first(); while (md) { if (md->memberType()==MemberDef::Define) { FileDef *fd=md->getFileDef(); if (fd && fd->absFilePath()==root->fileName) // doc and define in the same file assume they belong together. { if (md->documentation().isEmpty()) md->setDocumentation(root->doc); if (md->briefDescription().isEmpty()) md->setBriefDescription(root->brief); md->setBodySegment(root->bodyLine,root->endBodyLine); bool ambig; md->setBodyDef(findFileDef(inputNameDict,root->fileName,ambig)); md->addSectionsToDefinition(root->anchors); if (root->mGrpId!=-1) md->setMemberGroupId(root->mGrpId); addMemberToGroups(root,md); } } md=mn->next(); } //warn("Warning: define %s found in the following files:\n",root->name.data()); //warn("Cannot determine where to add the documentation found " // "at line %d of file %s. \n", // root->startLine,root->fileName.data()); } } else if (!root->doc.isEmpty() || !root->brief.isEmpty()) // define not found { warn(root->fileName,root->startLine, "Warning: documentation for unknown define %s found.\n", root->name.data() ); } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { findDefineDocumentation(e); } } //---------------------------------------------------------------------------- // create a (sorted) list of separate documentation pages static void buildPageList(Entry *root) { if (root->section == Entry::PAGEDOC_SEC) { if (!root->name.isEmpty()) { addRelatedPage(root); } } else if (root->section == Entry::MAINPAGEDOC_SEC) { QCString title=root->args.stripWhiteSpace(); if (title.isEmpty()) title=theTranslator->trMainPage(); addRefItem(root->todoId,root->testId,"page","index",title); } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildPageList(e); } } static void findMainPage(Entry *root) { if (root->section == Entry::MAINPAGEDOC_SEC) { if (mainPage==0) { //printf("Found main page! \n======\n%s\n=======\n",root->doc.data()); QCString title=root->args.stripWhiteSpace(); mainPage = new PageInfo(root->fileName,root->startLine, "index", root->doc,title); setFileNameForSections(root->anchors,"index"); // a page name is a label as well! SectionInfo *si=new SectionInfo( mainPage->name,mainPage->title,SectionInfo::Section); si->fileName="index"; sectionDict.insert("index",si); } else { warn(root->fileName,root->startLine, "Warning: found more than one \\mainpage comment block! Skipping this " "block." ); } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { findMainPage(e); } } //---------------------------------------------------------------------------- /*! Search for all Java package statements */ static void buildPackageList(Entry *root) { if (root->section == Entry::PACKAGE_SEC) { PackageDef *pd=0; if (!root->name.isEmpty() && (pd=packageDict.find(root->name))==0) { pd = new PackageDef(root->fileName,root->startLine,root->name); packageDict.inSort(root->name,pd); } if (pd) { bool ambig; FileDef *fd=findFileDef(inputNameDict,root->fileName,ambig); if (fd) { fd->setPackageDef(pd); } } } EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildPackageList(e); } } //---------------------------------------------------------------------------- /*! Add Java classes to their respective packages */ static void addClassesToPackages() { ClassDef *cd; ClassListIterator cli(classList); for (;(cd=cli.current());++cli) { PackageDef *pd = cd->packageDef(); if (pd) pd->addClass(cd); } } //---------------------------------------------------------------------------- static void resolveUserReferences() { QDictIterator sdi(sectionDict); SectionInfo *si; for (;(si=sdi.current());++sdi) { if (si->definition) { //printf("si=`%s' def=`%s' file=`%s'\n", // si->label.data(), // si->definition->name().data(), // si->definition->getOutputFileBase().data()); si->fileName=si->definition->getOutputFileBase().copy(); } // hack: the items of a todo/test list are all fragments from different files, // so the resulting section's all have the wrong file name (not from the // todo/test list, but from the file in which they are defined). We correct this // here by looking at the generated section labels! if (si->label.left(5)=="_todo" || si->label.left(5)=="_test") { si->fileName=si->label.mid(1,4); // extract "todo" or "test" } } } //---------------------------------------------------------------------------- // generate all separate documentation pages //void generateMainPageDocs() //{ // if (mainPage) // { // msg("Generating docs for the main page\n",mainPage->name.data()); // outputList->disable(OutputGenerator::Man); // startFile(*outputList,mainPage->name,mainPage->title); // SectionInfo *si=0; // if (!mainPage->title.isEmpty() && !mainPage->name.isEmpty() && // (si=sectionDict[mainPage->name])!=0) // { // outputList->writeSection(si->label,si->title,FALSE); // } // parseDoc(*outputList,0,0,mainPage->doc); // endFile(*outputList); // outputList->enable(OutputGenerator::Man); // } //} static void generatePageDocs() { if (documentedPages==0) return; PageSDictIterator pdi(*pageSDict); PageInfo *pi=0; for (pdi.toFirst();(pi=pdi.current());++pdi) { if (!pi->inGroup && !pi->isReference()) { msg("Generating docs for page %s...\n",pi->name.data()); outputList->disable(OutputGenerator::Man); QCString pageName; if (Config::caseSensitiveNames) pageName=pi->name.copy(); else pageName=pi->name.lower(); startFile(*outputList,pageName,pi->title); SectionInfo *si=0; if (!pi->title.isEmpty() && !pi->name.isEmpty() && (si=sectionDict[pi->name])!=0) { outputList->startSection(si->label,si->title,FALSE); outputList->docify(si->title); outputList->endSection(si->label,FALSE); } outputList->startTextBlock(); parseDoc(*outputList,pi->defFileName,pi->defLine,0,0,pi->doc); outputList->endTextBlock(); endFile(*outputList); outputList->enable(OutputGenerator::Man); if (!Config::genTagFile.isEmpty()) { tagFile << " " << endl; tagFile << " " << pi->name << "" << endl; tagFile << " " << pi->title << "" << endl; tagFile << " " << pi->name << "" << endl; tagFile << " " << endl; } } } } //---------------------------------------------------------------------------- // create a (sorted) list & dictionary of example pages static void buildExampleList(Entry *root) { if (root->section == Entry::EXAMPLE_SEC) { if (!root->name.isEmpty()) { if (exampleSDict->find(root->name)) { warn(root->fileName,root->startLine, "Warning: Example %s was already documented. Ignoring " "documentation found here.", root->name.data() ); } else { PageInfo *pi=new PageInfo(root->fileName,root->startLine, root->name,root->doc,root->args); setFileNameForSections(root->anchors, convertFileName(pi->name)+"-example" ); exampleSDict->inSort(root->name,pi); addExampleToGroups(root,pi); } } } //EntryList *entryList=root->sublist; //Entry *e = entryList->first(); //while (e) //{ // buildExampleList(e); // e=entryList->next(); //} EntryListIterator eli(*root->sublist); Entry *e; for (;(e=eli.current());++eli) { buildExampleList(e); } } //---------------------------------------------------------------------------- // generate the example documentation static void generateExampleDocs() { outputList->disable(OutputGenerator::Man); PageSDictIterator pdi(*exampleSDict); PageInfo *pi=0; for (pdi.toFirst();(pi=pdi.current());++pdi) { msg("Generating docs for example %s...\n",pi->name.data()); QCString n=convertFileName(pi->name)+"-example"; startFile(*outputList,n,"Example Documentation"); startTitle(*outputList,n); outputList->docify(pi->name); endTitle(*outputList,n,0); parseExample(*outputList,pi->doc+"\n\\include "+pi->name,pi->name); endFile(*outputList); } outputList->enable(OutputGenerator::Man); } //---------------------------------------------------------------------------- // generate module pages static void generateGroupDocs() { GroupListIterator gli(groupList); GroupDef *gd; for (;(gd=gli.current());++gli) { if (!gd->isReference()) { gd->writeDocumentation(*outputList); } } } //---------------------------------------------------------------------------- static void generatePackageDocs() { writePackageIndex(*outputList); if (packageDict.count()>0) { PackageSDict::Iterator pdi(packageDict); PackageDef *pd; for (pdi.toFirst();(pd=pdi.current());++pdi) { pd->writeDocumentation(*outputList); } } } //---------------------------------------------------------------------------- // generate module pages static void generateNamespaceDocs() { writeNamespaceIndex(*outputList); NamespaceListIterator nli(namespaceList); NamespaceDef *nd; for (;(nd=nli.current());++nli) { if (nd->isLinkableInProject()) { msg("Generating docs for namespace %s\n",nd->name().data()); nd->writeDocumentation(*outputList); } } } #if defined(_WIN32) static QCString fixSlashes(QCString &s) { QCString result; uint i; for (i=0;iError: $DOXYSEARCH not found. Check cgi script!\"" << endl << "fi" << endl; f.close(); struct stat stat_struct; stat(fileName,&stat_struct); chmod(fileName,stat_struct.st_mode|S_IXUSR|S_IXGRP|S_IXOTH); } else { err("Error: Cannot open file %s for writing\n",fileName.data()); } #else /* Windows platform */ // create cgi program fileName = Config::cgiName.copy(); if (fileName.right(4)==".cgi") fileName=fileName.left(fileName.length()-4); fileName+=".c"; fileName.prepend(Config::htmlOutputDir+"/"); QFile f(fileName); if (f.open(IO_WriteOnly)) { QTextStream t(&f); t << "#include " << endl; t << "#include " << endl; t << "#include " << endl; t << endl; t << "const char *DOXYSEARCH = \"" << fixSlashes(Config::binAbsPath) << "\\\\doxysearch.exe\";" << endl; t << "const char *DOXYPATH = \"" << fixSlashes(Config::docAbsPath) << "\";" << endl; t << endl; t << "int main(void)" << endl; t << "{" << endl; t << " char buf[1024];" << endl; t << " sprintf(buf,\"%s %s\",DOXYSEARCH,DOXYPATH);" << endl; t << " if (system(buf))" << endl; t << " {" << endl; t << " printf(\"Content-Type: text/html\\n\\n\");" << endl; t << " printf(\"

Error: failed to execute %s

\\n\",DOXYSEARCH);" << endl; t << " exit(1);" << endl; t << " }" << endl; t << " return 0;" << endl; t << "}" << endl; f.close(); } else { err("Error: Cannot open file %s for writing\n",fileName.data()); } #endif /* !defined(_WIN32) */ // create config file fileName = Config::htmlOutputDir+"/search.cfg"; f.setName(fileName); if (f.open(IO_WriteOnly)) { QTextStream t(&f); t << Config::docURL << "/" << endl << Config::cgiURL << "/" << Config::cgiName << endl; f.close(); } else { err("Error: Cannot open file %s for writing\n",fileName.data()); } //outputList->generateExternalIndex(); outputList->pushGeneratorState(); outputList->disableAllBut(OutputGenerator::Html); startFile(*outputList,"header.html","Search Engine",TRUE); outputList->endPlainFile(); outputList->startPlainFile("footer.html"); endFile(*outputList,TRUE); outputList->popGeneratorState(); } } //---------------------------------------------------------------------------- static bool openOutputFile(const char *outFile,QFile &f) { bool fileOpened=FALSE; bool writeToStdout=(outFile[0]=='-' && outFile[1]=='\0'); if (writeToStdout) // write to stdout { fileOpened = f.open(IO_WriteOnly,stdout); } else // write to file { QFileInfo fi(outFile); if (fi.exists()) // create a backup { QDir dir=fi.dir(); QFileInfo backup(fi.fileName()+".bak"); if (backup.exists()) // remove existing backup dir.remove(backup.fileName()); dir.rename(fi.fileName(),fi.fileName()+".bak"); } f.setName(outFile); fileOpened = f.open(IO_WriteOnly); } return fileOpened; } /*! Generate a template version of the configuration file. * If the \a shortList parameter is TRUE a configuration file without * comments will be generated. */ static void generateConfigFile(const char *configFile,bool shortList) { QFile f; bool fileOpened=openOutputFile(configFile,f); bool writeToStdout=(configFile[0]=='-' && configFile[1]=='\0'); if (fileOpened) { writeTemplateConfig(&f,shortList); if (!writeToStdout) { msg("\n\nConfiguration file `%s' created.\n\n",configFile); msg("Now edit the configuration file and enter\n\n"); if (strcmp(configFile,"Doxyfile") || strcmp(configFile,"doxyfile")) msg(" doxygen %s\n\n",configFile); else msg(" doxygen\n\n"); msg("to generate the documentation for your project\n\n"); } } else { err("Error: Cannot open file %s for writing\n",configFile); exit(1); } } //---------------------------------------------------------------------------- // read and parse a tag file //static bool readLineFromFile(QFile &f,QCString &s) //{ // char c=0; // s.resize(0); // while (!f.atEnd() && (c=f.getch())!='\n') s+=c; // return f.atEnd(); //} //---------------------------------------------------------------------------- static void readTagFile(Entry *root,const char *tl) { QCString tagLine = tl; QCString fileName; QCString destName; int eqPos = tagLine.find('='); if (eqPos!=-1) // tag command contains a destination { fileName = tagLine.left(eqPos).stripWhiteSpace(); destName = tagLine.right(tagLine.length()-eqPos-1).stripWhiteSpace(); QFileInfo fi(fileName); tagDestinationDict.insert(fi.fileName(),new QCString(destName)); //printf("insert tagDestination %s->%s\n",fi.fileName().data(),destName.data()); } else { fileName = tagLine; } QFileInfo fi(fileName); if (!fi.exists() || !fi.isFile()) { err("Error: Tag file `%s' does not exist or is not a file. Skipping it...\n", fileName.data()); return; } if (!destName.isEmpty()) msg("Reading tag file `%s', location `%s'...\n",fileName.data(),destName.data()); else msg("Reading tag file `%s'...\n",fileName.data()); parseTagFile(root,fi.absFilePath(),fi.fileName()); } //---------------------------------------------------------------------------- // returns TRUE if the name of the file represented by `fi' matches // one of the file patterns in the `patList' list. static bool patternMatch(QFileInfo *fi,QStrList *patList) { bool found=FALSE; if (patList) { char *pattern=patList->first(); while (pattern && !found) { //printf("Matching `%s' against pattern `%s'\n",fi->fileName().data(),pattern); #if defined(_WIN32) // windows QRegExp re(pattern,FALSE,TRUE); // case insensitive match #else // unix QRegExp re(pattern,TRUE,TRUE); // case sensitive match #endif found = found || re.match(fi->fileName())!=-1 || re.match(fi->filePath())!=-1 || re.match(fi->absFilePath())!=-1; pattern=patList->next(); } } return found; } //---------------------------------------------------------------------------- // reads a file into an array and filters out any 0x00 and 0x06 bytes, // because these are special for the parser. static void copyAndFilterFile(const char *fileName,BufStr &dest) { // try to open file int size=0; uint oldPos = dest.curPos(); QFileInfo fi(fileName); if (!fi.exists()) return; if (Config::inputFilter.isEmpty()) { QFile f(fileName); if (!f.open(IO_ReadOnly)) { err("Error: could not open file %s\n",fileName); return; } size=fi.size(); // read the file dest.skip(size); if (f.readBlock(dest.data()+oldPos,size)!=size) { err("Error while reading file %s\n",fileName); return; } } else { QCString cmd=Config::inputFilter+" "+fileName; FILE *f=popen(cmd,"r"); if (!f) { err("Error: could not execute filter %s\n",Config::inputFilter.data()); return; } const int bufSize=1024; char buf[bufSize]; int numRead; while ((numRead=fread(buf,1,bufSize,f))>0) { //printf(">>>>>>>>Reading %d bytes\n",numRead); dest.addArray(buf,numRead),size+=numRead; } pclose(f); } // filter unwanted bytes from the resulting data uchar *p=(uchar *)dest.data()+oldPos; uchar conv[256]; int i; for (i=0;i<256;i++) conv[i]=i; conv[0x06]=0x20; // replace the offending characters with spaces conv[0x00]=0x20; // remove any special markers from the input for (i=0;idata()); preprocessFile(fileName,output); } else { msg("Reading %s...\n",s->data()); copyAndFilterFile(fileName,output); } output.addChar('\n'); /* to prevent problems under Windows ? */ s=inputFiles.next(); //printf("-------> adding new line\n"); } output.addChar(0); } //---------------------------------------------------------------------------- // Read all files matching at least one pattern in `patList' in the // directory represented by `fi'. // The directory is read iff the recusiveFlag is set. // The contents of all files is append to the input string static int readDir(QFileInfo *fi, FileNameList *fnList, FileNameDict *fnDict, StringDict *exclDict, QStrList *patList, QStrList *exclPatList, StringList *resultList, StringDict *resultDict, bool errorIfNotExist ) { QDir dir((const char *)fi->absFilePath()); dir.setFilter( QDir::Files | QDir::Dirs ); int totalSize=0; //printf("readDir `%s'\n",fi->absFilePath().data()); const QFileInfoList *list = dir.entryInfoList(); QFileInfoListIterator it( *list ); QFileInfo *cfi; while ((cfi=it.current())) { if (exclDict==0 || exclDict->find(cfi->absFilePath())==0) { // file should not be excluded if ((!cfi->exists() || !cfi->isReadable()) && errorIfNotExist) { err("Error: source %s is not a readable file or directory... skipping.\n",cfi->absFilePath().data()); } else if (cfi->isFile() && (patList==0 || patternMatch(cfi,patList)) && !patternMatch(cfi,exclPatList)) { totalSize+=cfi->size()+cfi->absFilePath().length()+4; QCString name=convertToQCString(cfi->fileName()); //printf("New file %s\n",name.data()); if (fnDict) { FileDef *fd=new FileDef(cfi->dirPath()+"/",name); FileName *fn=0; if (!name.isEmpty() && (fn=(*fnDict)[name])) { fn->append(fd); } else { fn = new FileName(cfi->absFilePath(),name); fn->append(fd); if (fnList) fnList->inSort(fn); fnDict->insert(name,fn); } } QCString *rs=0; if (resultList || resultDict) { rs=new QCString(cfi->absFilePath()); } if (resultList) resultList->append(rs); if (resultDict) resultDict->insert(cfi->absFilePath(),rs); } else if (Config::recursiveFlag && cfi->isDir() && cfi->fileName()!="." && cfi->fileName()!="..") { cfi->setFile(cfi->absFilePath()); totalSize+=readDir(cfi,fnList,fnDict,exclDict, patList,exclPatList,resultList,resultDict,errorIfNotExist); } } ++it; } return totalSize; } //---------------------------------------------------------------------------- // read the file with name `name' into a string. //static QCString readExampleFile(const char *name) //{ // QCString example; // QFileInfo fi(name); // if (fi.exists()) // { // QFile f((const char *)fi.absFilePath()); // if (f.open(IO_ReadOnly)) // { // example.resize(fi.size()+1); // if ((int)fi.size()!=f.readBlock(example.data(),fi.size())) // { // err("Error while reading file %s\n",fi.absFilePath().data()); // //exit(1); // return ""; // } // example.at(fi.size())='\0'; // } // else // { // err("Error opening file %s\n",fi.absFilePath().data()); // //exit(1); // return ""; // } // } // else // { // err("Error: example file %s does not exist\n",name); // exit(1); // } // return example; //} //---------------------------------------------------------------------------- // read a file or all files in a directory and append their contents to the // input string. The names of the files are appended to the `fiList' list. static int readFileOrDirectory(const char *s, FileNameList *fnList, FileNameDict *fnDict, StringDict *exclDict, QStrList *patList, QStrList *exclPatList, StringList *resultList, StringDict *resultDict, bool errorIfNotExist=TRUE ) { QFileInfo fi(s); //printf("readFileOrDirectory(%s)\n",s); int totalSize=0; { if (exclDict==0 || exclDict->find(fi.absFilePath())==0) { if ((!fi.exists() || !fi.isReadable()) && errorIfNotExist) { err("Error: source %s is not a readable file or directory... skipping.\n",s); } else if (fi.isFile()) { totalSize+=fi.size()+fi.absFilePath().length()+4; //readFile(&fi,fiList,input); //fiList->inSort(new FileInfo(fi)); QCString name=convertToQCString(fi.fileName()); //printf("New file %s\n",name.data()); if (fnDict) { FileDef *fd=new FileDef(fi.dirPath(TRUE)+"/",name); FileName *fn=0; if (!name.isEmpty() && (fn=(*fnDict)[name])) { fn->append(fd); } else { fn = new FileName(fi.absFilePath(),name); fn->append(fd); if (fnList) fnList->inSort(fn); fnDict->insert(name,fn); } } QCString *rs=0; if (resultList || resultDict) { rs=new QCString(fi.absFilePath()); } if (resultList) resultList->append(rs); if (resultDict) resultDict->insert(fi.absFilePath(),rs); } else if (fi.isDir()) // readable dir totalSize+=readDir(&fi,fnList,fnDict,exclDict,patList, exclPatList,resultList,resultDict,errorIfNotExist); } } return totalSize; } //---------------------------------------------------------------------------- static void readFormulaRepository() { QFile f(Config::htmlOutputDir+"/formula.repository"); if (f.open(IO_ReadOnly)) // open repository { QTextStream t(&f); QCString line; while (!t.eof()) { line=t.readLine(); int se=line.find(':'); // find name and text separator. if (se==-1) { err("Error: formula.repository is corrupted!\n"); break; } else { QCString formName = line.left(se); QCString formText = line.right(line.length()-se-1); Formula *f=new Formula(formText); formulaList.append(f); formulaDict.insert(formText,f); formulaNameDict.insert(formName,f); } } } } //---------------------------------------------------------------------------- // print the usage of doxygen static void usage(const char *name) { msg("Doxygen version %s\nCopyright Dimitri van Heesch 1997-2001\n\n",versionString); msg("You can use doxygen in four ways:\n\n"); msg("1) Use doxygen to generate a template configuration file:\n"); msg(" %s [-s] -g [configName]\n\n",name); msg(" If - is used for configName doxygen will write to standard output.\n\n"); msg("2) Use doxygen to update an old configuration file:\n"); msg(" %s [-s] -u [configName]\n\n",name); msg("3) Use doxygen to generate documentation using an existing "); msg("configuration file:\n"); msg(" %s [configName]\n\n",name); msg(" If - is used for configName doxygen will read from standard input.\n\n"); msg("4) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.\n"); msg(" RTF: %s -w rtf styleSheetFile\n",name); msg(" HTML: %s -w html headerFile footerFile styleSheetFile [configFile]\n",name); msg(" LaTeX: %s -w latex headerFile styleSheetFile [configFile]\n\n",name); msg("If -s is specified the comments in the config file will be omitted.\n"); msg("If configName is omitted `Doxyfile' will be used as a default.\n\n"); exit(1); } //---------------------------------------------------------------------------- // read the argument of option `c' from the comment argument list and // update the option index `optind'. static const char *getArg(int argc,char **argv,int &optind) { char *s=0; if (strlen(&argv[optind][2])>0) s=&argv[optind][2]; else if (optind+1= 200 setlocale(LC_ALL,""); #endif initPreprocessor(); /************************************************************************** * Handle arguments * **************************************************************************/ char *s; int optind=1; const char *configName=0; const char *debugLabel; const char *formatName; bool genConfig=FALSE; bool shortList=FALSE; bool updateConfig=FALSE; while (optind=argc) { err("Error: option \"-w rtf\" is missing a style sheet file name\n"); exit(1); } QFile f; if (openOutputFile(argv[optind+1],f)) { RTFGenerator::writeStyleSheetFile(f); } exit(1); } else if (stricmp(formatName,"html")==0) { if (optind+4=argc) { err("Error: option \"-w html\" does not have enough arguments\n"); exit(1); } QFile f; if (openOutputFile(argv[optind+1],f)) { HtmlGenerator::writeHeaderFile(f); } f.close(); if (openOutputFile(argv[optind+2],f)) { HtmlGenerator::writeFooterFile(f); } f.close(); if (openOutputFile(argv[optind+3],f)) { HtmlGenerator::writeStyleSheetFile(f); } exit(1); } else if (stricmp(formatName,"latex")==0) { if (optind+3=argc) { err("Error: option \"-w html\" does not have enough arguments\n"); exit(1); } QFile f; if (openOutputFile(argv[optind+1],f)) { LatexGenerator::writeHeaderFile(f); } f.close(); if (openOutputFile(argv[optind+2],f)) { LatexGenerator::writeStyleSheetFile(f); } exit(1); } else { err("Error: Illegal format specifier %s: should be one of rtf, html, or latex\n",formatName); exit(1); } break; case '-': if (strcmp(&argv[optind][2],"help")==0) { usage(argv[0]); } else if (strcmp(&argv[optind][2],"version")==0) { msg("%s\n",versionString); exit(1); } break; case 'h': case '?': usage(argv[0]); break; default: err("Unknown option -%c\n",argv[optind][1]); usage(argv[0]); } optind++; } /************************************************************************** * Parse or generate the config file * **************************************************************************/ if (genConfig) { generateConfigFile(configName,shortList); exit(1); } QFileInfo configFileInfo1("Doxyfile"),configFileInfo2("doxyfile"); QCString config; if (optind>=argc) { if (configFileInfo1.exists()) { config=fileToString("Doxyfile"); configName="Doxyfile"; } else if (configFileInfo2.exists()) { config=fileToString("doxyfile"); configName="doxyfile"; } else { err("Doxyfile not found and no input file specified!\n"); usage(argv[0]); } } else { QFileInfo fi(argv[optind]); if (fi.exists() || strcmp(argv[optind],"-")==0) { config=fileToString(argv[optind]); configName=argv[optind]; } else { err("Error: configuration file %s not found!\n",argv[optind]); usage(argv[0]); } } parseConfig(config,configName); configStrToVal(); if (updateConfig) { generateConfigFile(configName,shortList); exit(1); } substituteEnvironmentVars(); checkConfig(); inputNameDict = new FileNameDict(1009); includeNameDict = new FileNameDict(1009); exampleNameDict = new FileNameDict(1009); imageNameDict = new FileNameDict(257); if (!Config::docURL.isEmpty()) { tagDestinationDict.insert("_doc",new QCString(Config::docURL)); } if (!Config::cgiURL.isEmpty()) { tagDestinationDict.insert("_cgi",new QCString(Config::cgiURL+"/"+Config::cgiName)); } /************************************************************************** * Initialize some global constants **************************************************************************/ spaces.resize(Config::tabSize+1); int sp;for (sp=0;spadd(new HtmlGenerator); HtmlGenerator::init(); if (Config::htmlHelpFlag) HtmlHelp::getInstance()->initialize(); if (Config::ftvHelpFlag) FTVHelp::getInstance()->initialize(); copyStyleSheet(); } if (Config::generateLatex) { outputList->add(new LatexGenerator); LatexGenerator::init(); } if (Config::generateMan) { outputList->add(new ManGenerator); ManGenerator::init(); } if (Config::generateRTF) { outputList->add(new RTFGenerator); RTFGenerator::init(); } /************************************************************************** * Read and preprocess input * **************************************************************************/ // gather names of all files in the include path msg("Searching for include files...\n"); s=Config::includePath.first(); while (s) { QStrList *pl = &Config::includeFilePatternList; if (pl->count()==0) pl = &Config::filePatternList; readFileOrDirectory(s,0,includeNameDict,0,pl, &Config::excludePatternList,0,0); s=Config::includePath.next(); } msg("Searching for example files...\n"); s=Config::examplePath.first(); while (s) { readFileOrDirectory(s,0,exampleNameDict,0,&Config::examplePatternList, 0,0,0); s=Config::examplePath.next(); } msg("Searching for images...\n"); s=Config::imagePath.first(); while (s) { readFileOrDirectory(s,0,imageNameDict,0,0, 0,0,0); s=Config::imagePath.next(); } msg("Searching for files to exclude\n"); s=Config::excludeSources.first(); while (s) { readFileOrDirectory(s,0,0,0,&Config::filePatternList, 0,0,&excludeNameDict,FALSE); s=Config::excludeSources.next(); } msg("Reading input files...\n"); int inputSize=0; s=Config::inputSources.first(); while (s) { inputSize+=readFileOrDirectory(s,&inputNameList, inputNameDict,&excludeNameDict, &Config::filePatternList, &Config::excludePatternList, &inputFiles,0); s=Config::inputSources.next(); } // add predefined macro name to a dictionary s=Config::expandAsDefinedList.first(); while (s) { if (expandAsDefinedDict[s]==0) { expandAsDefinedDict.insert(s,(void *)666); } s=Config::expandAsDefinedList.next(); } // add aliases to a dictionary aliasDict.setAutoDelete(TRUE); s=Config::aliasList.first(); while (s) { if (aliasDict[s]==0) { QCString alias=s; int i=alias.find('='); if (i>0) { QCString name=alias.left(i).stripWhiteSpace(); QCString value=alias.right(alias.length()-i-1); QCString newValue; int in,p=0; // for each \n in the alias command value while ((in=value.find("\\n",p))!=-1) { newValue+=value.mid(p,in-p); // expand \n's except if \n is part of a built-in command. if (value.mid(in,5)!="\\note" && value.mid(in,5)!="\\name" && value.mid(in,10)!="\\namespace" && value.mid(in,14)!="\\nosubgrouping" ) { newValue+="\n"; } else { newValue+="\\n"; } p=in+2; } newValue+=value.mid(p,value.length()-p); value=newValue; //printf("Alias: found name=`%s' value=`%s'\n",name.data(),value.data()); if (!name.isEmpty()) { QCString *dn=aliasDict[name]; if (dn==0) // insert new alias { aliasDict.insert(name,new QCString(value)); } else // overwrite previous alias { *dn=value; } } } } s=Config::aliasList.next(); } BufStr input(inputSize+1); // Add one byte extra for \0 termination // read and preprocess all input files readFiles(input); if (input.isEmpty()) { err("No input read, no output generated!\n"); exit(1); } else { msg("Read %d bytes\n",input.curPos()); } // Notice: the order of the function calls below is very important! if (Config::generateHtml) { msg("Reading formula repository...\n"); readFormulaRepository(); } Entry *root=new Entry; root->program=input; /************************************************************************** * Handle Tag Files * **************************************************************************/ msg("Reading tag files\n"); s=Config::tagFileList.first(); while (s) { readTagFile(root,s); s=Config::tagFileList.next(); } QFile *tag=0; if (!Config::genTagFile.isEmpty()) { tag=new QFile(Config::genTagFile); if (!tag->open(IO_WriteOnly)) { err("Error: cannot open tag file %s for writing\n", Config::genTagFile.data() ); exit(1); } tagFile.setDevice(tag); tagFile << "" << endl; } /************************************************************************** * Gather information * **************************************************************************/ msg("Parsing input...\n"); parseMain(root); // build a tree of entries msg("Freeing input...\n"); input.resize(0); msg("Building group list...\n"); buildGroupList(root); msg("Building namespace list...\n"); buildNamespaceList(root); findUsingDirectives(root); //msg("Computing group relations...\n"); //computeGroupRelations(root); msg("Building file list...\n"); buildFileList(root); msg("Building class list...\n"); buildClassList(root); findUsingDeclarations(root); msg("Building example list...\n"); buildExampleList(root); msg("Searching for documented variables...\n"); buildVarList(root); msg("Building member list...\n"); // using class info only ! buildMemberList(root); transferFunctionDocumentation(); msg("Searching for friends...\n"); findFriends(); msg("Searching for documented defines...\n"); findDefineDocumentation(root); msg("Computing class relations...\n"); computeClassRelations(root); msg("Searching for enumerations...\n"); findEnums(root); findEnumDocumentation(root); msg("Searching for member function documentation...\n"); findMemberDocumentation(root); // may introduce new members ! transferRelatedFunctionDocumentation(); msg("Building page list...\n"); buildPageList(root); msg("Buidling package list...\n"); buildPackageList(root); msg("Search for main page...\n"); findMainPage(root); msg("Sorting member lists...\n"); memberNameList.sort(); functionNameList.sort(); msg("Freeing entry tree\n"); delete root; msg("Determining which enums are documented\n"); findDocumentedEnumValues(); msg("Computing member references...\n"); computeMemberReferences(); msg("Computing member relations...\n"); computeMemberRelations(); msg("Adding classes to their packages...\n"); addClassesToPackages(); if (Config::haveDotFlag && Config::collGraphFlag) { msg("Computing class implementation usage relations...\n"); computeClassImplUsageRelations(); } msg("Adding members to member groups.\n"); addMembersToMemberGroup(); if (Config::distributeDocFlag) { msg("Distributing member group documentation.\n"); distributeMemberGroupDocumentation(); } msg("Building full member lists recursively...\n"); buildCompleteMemberLists(); //msg("Computing class interface usage relations...\n"); //computeClassIntfUsageRelations(); //msg("Determining member group documentation...\n"); //computeMemberGroupDocumentation(); //unrelatedFunctionsUsed=hasUnrelatedFunctions(); if (Config::inheritDocsFlag) { msg("Inheriting documentation...\n"); inheritDocumentation(); } //msg("Computing member groups...\n"); //computeMemberGroups(); msg("Adding source references...\n"); addSourceReferences(); msg("Adding todo/test references...\n"); addTodoTestReferences(); /************************************************************************** * Generate documentation * **************************************************************************/ if (Config::generateHtml) writeDoxFont(Config::htmlOutputDir); if (Config::generateRTF) writeDoxFont(Config::rtfOutputDir); //statistics(); // count the number of documented elements in the lists we have built. // If the result is 0 we do not generate the lists and omit the // corresponding links in the index. msg("Counting data structures...\n"); annotatedClasses = countAnnotatedClasses(); hierarchyClasses = countClassHierarchy(); documentedMembers = countClassMembers(); documentedFunctions = countFileMembers(); countFiles(documentedHtmlFiles,documentedFiles); documentedGroups = countGroups(); documentedNamespaces = countNamespaces(); documentedNamespaceMembers = countNamespaceMembers(); documentedPages = countRelatedPages(); documentedPackages = countPackages(); // compute the shortest possible names of all files // without loosing the uniqueness of the file names. msg("Generating disk names...\n"); inputNameList.generateDiskNames(); msg("Resolving user defined references...\n"); resolveUserReferences(); msg("Generating index page...\n"); writeIndex(*outputList); msg("Generating file index...\n"); writeFileIndex(*outputList); msg("Generating example documentation...\n"); generateExampleDocs(); msg("Generating file sources...\n"); generateFileSources(); msg("Generating file documentation...\n"); generateFileDocs(); msg("Generating class documentation...\n"); generateClassDocs(); msg("Generating page documentation...\n"); generatePageDocs(); msg("Generating group documentation...\n"); generateGroupDocs(); msg("Generating namespace index...\n"); generateNamespaceDocs(); msg("Generating group index...\n"); writeGroupIndex(*outputList); msg("Generating package index...\n"); generatePackageDocs(); msg("Generating example index...\n"); writeExampleIndex(*outputList); msg("Generating file member index...\n"); writeFileMemberIndex(*outputList); msg("Generating namespace member index...\n"); writeNamespaceMemberIndex(*outputList); msg("Generating page index...\n"); writePageIndex(*outputList); if (Config::generateLegend) { msg("Generating graph info page...\n"); writeGraphInfo(*outputList); } msg("Generating search index...\n"); generateSearchIndex(); msg("Generating style sheet...\n"); outputList->writeStyleInfo(0); // write first part outputList->disableAllBut(OutputGenerator::Latex); parseText(*outputList, theTranslator->trGeneratedAt(dateToString(TRUE),Config::projectName) ); outputList->writeStyleInfo(1); // write second part parseText(*outputList,theTranslator->trWrittenBy()); outputList->writeStyleInfo(2); // write third part parseText(*outputList, theTranslator->trGeneratedAt(dateToString(TRUE),Config::projectName) ); outputList->writeStyleInfo(3); // write fourth part parseText(*outputList,theTranslator->trWrittenBy()); outputList->writeStyleInfo(4); // write last part outputList->enableAll(); if (Config::generateRTF) { msg("Combining RTF output...\n"); if (!RTFGenerator::preProcessFileInplace(Config::rtfOutputDir,"refman.rtf")) { err("An error occurred during post-processing the RTF files!\n"); } } if (Config::haveDotFlag && Config::gfxHierarchyFlag) { msg("Generating graphical class hierarchy...\n"); writeGraphicalClassHierarchy(*outputList); } if (Config::generateXML) { msg("Generating XML output\n"); generateXML(); } if (formulaList.count()>0 && Config::generateHtml) { msg("Generating bitmaps for formulas in HTML...\n"); formulaList.generateBitmaps(Config::htmlOutputDir); } if (Config::searchEngineFlag || Config::tagFileList.count()>0) { msg("\nNow copy the file\n\n %s\n\nto the directory where the CGI binaries are " "located and don't forget to run\n\n",(Config::htmlOutputDir+"/"+Config::cgiName).data()); msg(" %s/installdox\n\nto replace any dummy links.\n\n", Config::htmlOutputDir.data()); } if (Config::generateHtml && Config::htmlHelpFlag) { HtmlHelp::getInstance()->finalize(); } if (Config::generateHtml && Config::ftvHelpFlag) { FTVHelp::getInstance()->finalize(); } if (!Config::genTagFile.isEmpty()) { tagFile << "" << endl; delete tag; } if (Config::generateHtml) removeDoxFont(Config::htmlOutputDir); if (Config::generateRTF) removeDoxFont(Config::rtfOutputDir); return 0; }