Bug 707641 - FILTER_SOURCE_FILES=YES required to build CALL_GRAPHS

https://bugzilla.gnome.org/show_bug.cgi?id=707641 Add references if the file is filtered, as the parser does not know whether we are insideBody or not.
analizo · Sep 28, 2013 · e835d4b · e835d4b
1 parent 54f60c1
commit e835d4b
Show file tree

Hide file tree

Showing 24 changed files with 104 additions and 103 deletions.
diff --git a/src/code.h b/src/code.h
@@ -29,7 +29,8 @@ class Definition;
 void parseCCode(CodeOutputInterface &,const char *,const QCString &, 
             SrcLangExt lang, bool isExample, const char *exName,FileDef *fd,
             int startLine,int endLine,bool inlineFragment,
-            MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx);
+            MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx,
+            bool collectXRefs);
 void resetCCodeParserState();
 void codeFreeScanner();
 

diff --git a/src/code.l b/src/code.l
@@ -123,6 +123,7 @@ static bool          g_lexInit = FALSE;
 static QStack<int>   g_classScopeLengthStack;
 
 static Definition   *g_searchCtx;
+static bool          g_collectXRefs;
 
 // context for an Objective-C method call
 struct ObjCCallCtx
@@ -885,7 +886,7 @@ static bool getLinkInScope(const QCString &c,  // scope
       //        g_currentDefinition,g_currentMemberDef,g_insideBody);
 
       if (g_currentDefinition && g_currentMemberDef &&
-	  md!=g_currentMemberDef && g_insideBody)
+          md!=g_currentMemberDef && g_insideBody && g_collectXRefs)
       {
 	addDocCrossReference(g_currentMemberDef,md);
       }
@@ -1018,7 +1019,8 @@ static void generateClassOrGlobalLink(CodeOutputInterface &ol,const char *clName
       Definition *d = md->getOuterScope()==Doxygen::globalScope ?
                       md->getFileDef() : md->getOuterScope();
       if (md->getGroupDef()) d = md->getGroupDef();
-      if (d && d->isLinkable() && md->isLinkable() && g_currentMemberDef)
+      if (d && d->isLinkable() && md->isLinkable() && 
+          g_currentMemberDef && g_collectXRefs)
       {
         addDocCrossReference(g_currentMemberDef,md);
       }
@@ -1071,7 +1073,7 @@ static void generateClassOrGlobalLink(CodeOutputInterface &ol,const char *clName
 	  }
 	  writeMultiLineCodeLink(ol,md,text);
           addToSearchIndex(clName);
-	  if (g_currentMemberDef)
+	  if (g_currentMemberDef && g_collectXRefs)
 	  {
 	    addDocCrossReference(g_currentMemberDef,md);
 	  }
@@ -1127,7 +1129,7 @@ static bool generateClassMemberLink(CodeOutputInterface &ol,MemberDef *xmd,const
     {
       // add usage reference
       if (g_currentDefinition && g_currentMemberDef &&
-	  /*xmd!=g_currentMemberDef &&*/ g_insideBody)
+	  /*xmd!=g_currentMemberDef &&*/ g_insideBody && g_collectXRefs)
       {
 	addDocCrossReference(g_currentMemberDef,xmd);
       }
@@ -1504,7 +1506,7 @@ static void writeObjCMethodCall(ObjCCallCtx *ctx)
 	    if (ctx->method && ctx->method->isLinkable())
 	    {
               writeMultiLineCodeLink(*g_code,ctx->method,pName->data());
-	      if (g_currentMemberDef)
+	      if (g_currentMemberDef && g_collectXRefs)
 	      {
 	        addDocCrossReference(g_currentMemberDef,ctx->method);
 	      }
@@ -1583,7 +1585,7 @@ static void writeObjCMethodCall(ObjCCallCtx *ctx)
 	    else if (ctx->objectVar && ctx->objectVar->isLinkable()) // object is class variable
 	    {
 	      writeMultiLineCodeLink(*g_code,ctx->objectVar,pObject->data());
-	      if (g_currentMemberDef)
+	      if (g_currentMemberDef && g_collectXRefs)
 	      {
 	        addDocCrossReference(g_currentMemberDef,ctx->objectVar);
 	      }
@@ -3537,9 +3539,10 @@ void resetCCodeParserState()
 }
 
 void parseCCode(CodeOutputInterface &od,const char *className,const QCString &s, 
-                  SrcLangExt lang,bool exBlock, const char *exName,FileDef *fd,
-		  int startLine,int endLine,bool inlineFragment,
-		  MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx)
+                SrcLangExt lang,bool exBlock, const char *exName,FileDef *fd,
+		int startLine,int endLine,bool inlineFragment,
+		MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx,
+                bool collectXRefs)
 {
   //printf("***parseCode() exBlock=%d exName=%s fd=%p className=%s searchCtx=%s\n",
   //      exBlock,exName,fd,className,searchCtx?searchCtx->name().data():"<none>");
@@ -3555,6 +3558,7 @@ void parseCCode(CodeOutputInterface &od,const char *className,const QCString &s,
   g_currentFontClass = 0;
   g_needsTermination = FALSE;
   g_searchCtx = searchCtx;
+  g_collectXRefs = collectXRefs;
   g_inFunctionTryBlock = FALSE;
   if (endLine!=-1)
     g_inputLines  = endLine+1;

diff --git a/src/dbusxmlscanner.cpp b/src/dbusxmlscanner.cpp
@@ -870,7 +870,8 @@ void DBusXMLScanner::parseCode(CodeOutputInterface & /* codeOutIntf */,
                                bool /* inlineFragment */,
                                MemberDef * /* memberDef */,
                                bool /*showLineNumbers*/,
-                               Definition * /* searchCtx */)
+                               Definition * /* searchCtx */,
+                               bool /*collectXRefs*/ )
 { }
 
 void DBusXMLScanner::resetCodeParserState()

diff --git a/src/dbusxmlscanner.h b/src/dbusxmlscanner.h
@@ -51,7 +51,8 @@ class DBusXMLScanner : public ParserInterface
                    bool inlineFragment=FALSE,
                    MemberDef *memberDef=0,
                    bool showLineNumbers=TRUE,
-                   Definition *searchCtx=0
+                   Definition *searchCtx=0,
+                   bool collectXRefs=TRUE
                   );
 
     void resetCodeParserState();

diff --git a/src/filedef.cpp b/src/filedef.cpp
@@ -807,6 +807,7 @@ void FileDef::writeSource(OutputList &ol,bool sameTu,QStrList &filesInSameTu)
   static bool generateTreeView  = Config_getBool("GENERATE_TREEVIEW");
   static bool filterSourceFiles = Config_getBool("FILTER_SOURCE_FILES");
   static bool latexSourceCode   = Config_getBool("LATEX_SOURCE_CODE");
+  DevNullCodeDocInterface devNullIntf;
   QCString title = m_docname;
   if (!m_fileVersion.isEmpty())
   {
@@ -878,10 +879,33 @@ void FileDef::writeSource(OutputList &ol,bool sameTu,QStrList &filesInSameTu)
     ParserInterface *pIntf = Doxygen::parserManager->getParser(getDefFileExtension());
     pIntf->resetCodeParserState();
     ol.startCodeFragment();
+    bool needs2PassParsing = 
+        Doxygen::parseSourcesNeeded &&                // we need to parse (filtered) sources for cross-references
+        !filterSourceFiles &&                         // but user wants to show sources as-is
+        !getFileFilter(absFilePath(),TRUE).isEmpty(); // and there is a filter used while parsing
+
+    if (needs2PassParsing)
+    {
+      // parse code for cross-references only (see bug707641)
+      pIntf->parseCode(devNullIntf,0,
+                       fileToString(absFilePath(),TRUE,TRUE),
+                       getLanguage(),
+                       FALSE,0,this
+                      );
+    }
     pIntf->parseCode(ol,0,
         fileToString(absFilePath(),filterSourceFiles,TRUE),
-        getLanguage(),
-        FALSE,0,this
+        getLanguage(),      // lang
+        FALSE,              // isExampleBlock
+        0,                  // exampleName
+        this,               // fileDef
+        -1,                 // startLine
+        -1,                 // endLine
+        FALSE,              // inlineFragment
+        0,                  // memberDef
+        TRUE,               // showLineNumbers
+        0,                  // searchCtx
+        !needs2PassParsing  // collectXRefs
         );
     ol.endCodeFragment();
   }

diff --git a/src/fortrancode.h b/src/fortrancode.h
@@ -27,7 +27,8 @@ class Definition;
 void parseFortranCode(CodeOutputInterface &,const char *,const QCString &, 
             bool ,const char *,FileDef *fd,
             int startLine,int endLine,bool inlineFragment,
-            MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx);
+            MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx,
+            bool collectRefs);
 void resetFortranCodeParserState();
 void codeFreeScanner();
 

diff --git a/src/fortrancode.l b/src/fortrancode.l
@@ -132,6 +132,7 @@ static int           g_inputLines;      //!< number of line in the code fragment
 static int	     g_yyLineNr;        //!< current line number
 static bool          g_needsTermination;
 static Definition   *g_searchCtx;
+static bool          g_collectXRefs;
 static bool          g_isFixedForm;
 
 static bool          g_insideBody;      //!< inside subprog/program body? => create links
@@ -378,36 +379,6 @@ static void writeMultiLineCodeLink(CodeOutputInterface &ol,
   }
 }
 
-#if 0
-static QCString fileLocation() 
-{
-  QCString result = g_sourceFileDef?g_sourceFileDef->absFilePath():QCString("[unknown]");
-  result+=":"+QCString().setNum(g_yyLineNr);
-  result+=":"+QCString().setNum(1);
-  return result;
-}
-
-
-/**
-  generates dictionay entries that are used if REFERENCED_BY_RELATION ... options are set
-  (e.g. the "referenced by ..." list after the function documentation) 
-*/
-
-static void addDocCrossReference(MemberDef *src, MemberDef *dst)
-{
-  if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
- //printf("======= addDocCrossReference src=%s,dst=%s\n",src->name().data(),dst->name().data());
-  if ((Config_getBool("REFERENCED_BY_RELATION") || Config_getBool("CALLER_GRAPH")) && 
-      (src->isFunction()))
-  {
-    dst->addSourceReferencedBy(src,fileLocation());
-  }
-  if ((Config_getBool("REFERENCES_RELATION") || Config_getBool("CALL_GRAPH")) && (src->isFunction()))
-  {
-    src->addSourceReferences(dst,fileLocation());
-  }
-}
-#endif
 
 //-------------------------------------------------------------------------------
 /**
@@ -565,7 +536,8 @@ static bool getLink(UseSDict *usedict, // dictonary with used modules
     if (md->getGroupDef()) d = md->getGroupDef();
     if (d && d->isLinkable())
     {
-      if (g_currentDefinition && g_currentMemberDef && md!=g_currentMemberDef && g_insideBody)
+      if (g_currentDefinition && g_currentMemberDef && 
+          md!=g_currentMemberDef && g_insideBody && g_collectXRefs)
       { 
 	addDocCrossReference(g_currentMemberDef,md); 
       }     
@@ -1133,7 +1105,8 @@ void resetFortranCodeParserState() {}
 void parseFortranCode(CodeOutputInterface &od,const char *className,const QCString &s, 
                   bool exBlock, const char *exName,FileDef *fd,
 		  int startLine,int endLine,bool inlineFragment,
-		  MemberDef *memberDef,bool,Definition *searchCtx)
+		  MemberDef *memberDef,bool,Definition *searchCtx,
+                  bool collectXRefs)
 {
   //printf("***parseCode() exBlock=%d exName=%s fd=%p\n",exBlock,exName,fd);
 
@@ -1150,6 +1123,7 @@ void parseFortranCode(CodeOutputInterface &od,const char *className,const QCStri
   g_currentFontClass = 0;
   g_needsTermination = FALSE;
   g_searchCtx = searchCtx;
+  g_collectXRefs = collectXRefs;
   if (endLine!=-1)
     g_inputLines  = endLine+1;
   else

diff --git a/src/fortranscanner.h b/src/fortranscanner.h
@@ -48,7 +48,8 @@ class FortranLanguageScanner : public ParserInterface
                    bool inlineFragment=FALSE,
                    MemberDef *memberDef=0,
                    bool showLineNumbers=TRUE,
-                   Definition *searchCtx=0
+                   Definition *searchCtx=0,
+                   bool collectXRefs=TRUE
                   );
     void resetCodeParserState();
     void parsePrototype(const char *text);

diff --git a/src/fortranscanner.l b/src/fortranscanner.l
@@ -2354,12 +2354,13 @@ void FortranLanguageScanner::parseCode(CodeOutputInterface & codeOutIntf,
                    bool inlineFragment,
 		   MemberDef *memberDef,
                    bool showLineNumbers,
-                   Definition *searchCtx
+                   Definition *searchCtx,
+                   bool collectXRefs
                   )
 {
   ::parseFortranCode(codeOutIntf,scopeName,input,isExampleBlock,exampleName,
                      fileDef,startLine,endLine,inlineFragment,memberDef,
-                     showLineNumbers,searchCtx);
+                     showLineNumbers,searchCtx,collectXRefs);
 }
 
 bool FortranLanguageScanner::needsPreprocessing(const QCString &extension)

diff --git a/src/markdown.cpp b/src/markdown.cpp
@@ -2347,15 +2347,17 @@ void MarkdownFileParser::parseCode(CodeOutputInterface &codeOutIntf,
                bool inlineFragment,
                MemberDef *memberDef,
                bool showLineNumbers,
-               Definition *searchCtx
+               Definition *searchCtx,
+               bool collectXRefs
               )
 {
   ParserInterface *pIntf = Doxygen::parserManager->getParser("*.cpp");
   if (pIntf!=this)
   {
     pIntf->parseCode(
        codeOutIntf,scopeName,input,lang,isExampleBlock,exampleName,
-       fileDef,startLine,endLine,inlineFragment,memberDef,showLineNumbers,searchCtx);
+       fileDef,startLine,endLine,inlineFragment,memberDef,showLineNumbers,
+       searchCtx,collectXRefs);
   }
 }
 

diff --git a/src/markdown.h b/src/markdown.h
@@ -48,7 +48,8 @@ class MarkdownFileParser : public ParserInterface
                    bool inlineFragment=FALSE,
                    MemberDef *memberDef=0,
                    bool showLineNumbers=TRUE,
-                   Definition *searchCtx=0
+                   Definition *searchCtx=0,
+                   bool collectXRefs=TRUE
                   );
     void resetCodeParserState();
     void parsePrototype(const char *text);

diff --git a/src/parserintf.h b/src/parserintf.h
@@ -98,6 +98,7 @@ class ParserInterface
      *  @param[in] showLineNumbers if set to TRUE and also fileDef is not 0,
      *             line numbers will be added to the source fragement
      *  @param[in] searchCtx context under which search data has to be stored.
+     *  @param[in] collectXRefs collect cross-reference relations.
      */
     virtual void parseCode(CodeOutputInterface &codeOutIntf,
                            const char *scopeName,
@@ -111,7 +112,8 @@ class ParserInterface
                            bool inlineFragment=FALSE,
                            MemberDef *memberDef=0,
                            bool showLineNumbers=TRUE,
-                           Definition *searchCtx=0
+                           Definition *searchCtx=0,
+                           bool collectXRefs=TRUE
                           ) = 0;
 
     /** Resets the state of the code parser.

diff --git a/src/pycode.h b/src/pycode.h
@@ -36,7 +36,8 @@ class Definition;
 extern void parsePythonCode(CodeOutputInterface &,const char *,const QCString &,
              bool ,const char *,FileDef *fd,
 	     int startLine,int endLine,bool inlineFragment,
-             MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx);
+             MemberDef *memberDef,bool showLineNumbers,Definition *searchCtx,
+             bool collectXRefs);
 extern void resetPythonCodeParserState();
 
 #endif