Restructure citation handling

Author: doxygen

src/cite.cpp

@@ -1,8 +1,6 @@
 /******************************************************************************
  *
- * 
- *
- * Copyright (C) 2011 by Dimitri van Heesch
+ * Copyright (C) 2020 by Dimitri van Heesch
  * Based on a patch by David Munger
  *
  * Permission to use, copy, modify, and distribute this software and its
@@ -16,83 +14,64 @@
  *
  */
 
-#ifndef CITEDB_H
-#define CITEDB_H
+#ifndef CITE_H
+#define CITE_H
 
-#include <qdict.h>
+#include <memory>
 
-class FTextStream;
+#include <qcstring.h>
 
-/// String constants for citations
-struct CiteConsts
-{
-  static const QCString fileName;
-  static const QCString anchorPrefix;
-};
+class FTextStream;
 
 /// Citation-related data.
 struct CiteInfo
 {
-  CiteInfo(const char *label_, const char *text_=0, const char *fullText_=0,
-      const char *ref_=0) :
-    label(label_), text(text_), fullText(fullText_), ref(ref_)
-  { }
-
-  CiteInfo(const CiteInfo &o)
-  { label=o.label.copy(); text=o.text.copy(); fullText=o.fullText.copy(); ref=o.ref.copy(); }
-
-  QCString label; 
-  QCString text;
-  QCString fullText;
-  QCString ref;
-
+    virtual ~CiteInfo() {}
+    virtual QCString label() const = 0;
+    virtual QCString text() const = 0;
 };
 
 /**
- * @brief Cite database access class.
- * @details This class provides access do the database of bibliographic 
+ * @brief Citation manager class.
+ * @details This class provides access do the database of bibliographic
  * references through the bibtex backend.
  */
-class CiteDict 
+class CitationManager
 {
   public:
-    /** Create the database, with an expected maximum of \a size entries */
-    CiteDict(int size);
-
-//    /** Resolve references to citations */
-//    void resolve();
+    static CitationManager &instance();
 
     /** Insert a citation identified by \a label into the database */
     void insert(const char *label);
 
-    /** Return the citation info for a given \a label */
-    CiteInfo *find(const char *label) const;
+    /** Return the citation info for a given \a label.
+     *  Ownership of the info stays with the manager.
+     */
+    const CiteInfo *find(const char *label) const;
 
     /** Generate the citations page */
-    void generatePage() const;
+    void generatePage();
 
     /** clears the database */
     void clear();
 
-    /** return TRUE if there are no citations. 
-     *  Only valid after calling resolve() 
+    /** return TRUE if there are no citations.
      */
     bool isEmpty() const;
 
-    /** writes the latex code for the standard bibliography 
-     *  section to text stream \a t 
+    /** writes the latex code for the standard bibliography
+     *  section to text stream \a t
      */
-    void writeLatexBibliography(FTextStream &t);
+    void writeLatexBibliography(FTextStream &t) const;
+
+    const char *fileName() const;
+    const char *anchorPrefix() const;
 
   private:
-//    bool writeAux();
-//    bool writeBst();
-//    bool execute();
-//    void parse();
-//    void clean();
-    QDict<CiteInfo> m_entries;
-//    QList<QCString> m_ordering;
-    QCString m_baseFileName;
+    /** Create the database, with an expected maximum of \a size entries */
+    CitationManager();
+    struct Private;
+    std::unique_ptr<Private> p;
 };
 
-#endif
+#endif // CITE_H

src/cite.h

@@ -2923,7 +2923,7 @@ static void addCite(yyscan_t yyscanner)
     name=yytext+1;
     name=name.left(yyleng-2);
   }
-  Doxygen::citeDict->insert(name.data());
+  CitationManager::instance().insert(name.data());
 }
 
 //-----------------------------------------------------------------------------

src/commentscan.l

@@ -1919,12 +1919,14 @@ DocAnchor::DocAnchor(DocNode *parent,const QCString &id,bool newAnchor)
     return;
   }
 
-  if (id.left(CiteConsts::anchorPrefix.length()) == CiteConsts::anchorPrefix) 
+  const CitationManager &ct = CitationManager::instance();
+  QCString anchorPrefix = ct.anchorPrefix();
+  if (id.left(anchorPrefix.length()) == anchorPrefix)
   {
-    CiteInfo *cite = Doxygen::citeDict->find(id.mid(CiteConsts::anchorPrefix.length()));
-    if (cite) 
+    const CiteInfo *cite = ct.find(id.mid(anchorPrefix.length()));
+    if (cite)
     {
-      m_file = convertNameToFile(CiteConsts::fileName,FALSE,TRUE);
+      m_file = convertNameToFile(ct.fileName(),FALSE,TRUE);
       m_anchor = id;
     }
     else 
@@ -2585,14 +2587,15 @@ DocCite::DocCite(DocNode *parent,const QCString &target,const QCString &) //cont
   //printf("DocCite::DocCite(target=%s)\n",target.data());
   ASSERT(!target.isEmpty());
   m_relPath = g_relPath;
-  CiteInfo *cite = Doxygen::citeDict->find(target);
+  const CitationManager &ct = CitationManager::instance();
+  const CiteInfo *cite = ct.find(target);
   //printf("cite=%p text='%s' numBibFiles=%d\n",cite,cite?cite->text.data():"<null>",numBibFiles);
-  if (numBibFiles>0 && cite && !cite->text.isEmpty()) // ref to citation
+  if (numBibFiles>0 && cite && !cite->text().isEmpty()) // ref to citation
   {
-    m_text         = cite->text;
-    m_ref          = cite->ref;
-    m_anchor       = CiteConsts::anchorPrefix+cite->label;
-    m_file         = convertNameToFile(CiteConsts::fileName,FALSE,TRUE);
+    m_text         = cite->text();
+    m_ref          = "";
+    m_anchor       = ct.anchorPrefix()+cite->label();
+    m_file         = convertNameToFile(ct.fileName(),FALSE,TRUE);
     //printf("CITE ==> m_text=%s,m_ref=%s,m_file=%s,m_anchor=%s\n",
     //    m_text.data(),m_ref.data(),m_file.data(),m_anchor.data());
     return;

src/docparser.cpp

@@ -129,7 +129,6 @@ GroupSDict      *Doxygen::groupSDict = 0;
 PageSDict       *Doxygen::pageSDict = 0;
 PageSDict       *Doxygen::exampleSDict = 0;
 SectionDict     *Doxygen::sectionDict = 0;        // all page sections
-CiteDict        *Doxygen::citeDict=0;              // database of bibliographic references
 StringDict       Doxygen::aliasDict(257);          // aliases
 QDict<void>      Doxygen::inputPaths(1009);
 FileNameDict    *Doxygen::includeNameDict = 0;     // include names
@@ -202,7 +201,7 @@ void clearAll()
   Doxygen::mscFileNameDict->clear();
   Doxygen::diaFileNameDict->clear();
   Doxygen::tagDestinationDict.clear();
-  delete Doxygen::citeDict;
+  CitationManager::instance().clear();
   delete Doxygen::mainPage; Doxygen::mainPage=0;
   FormulaManager::instance().clear();
 }
@@ -9862,7 +9861,6 @@ void initDoxygen()
   Doxygen::memGrpInfoDict.setAutoDelete(TRUE);
   Doxygen::tagDestinationDict.setAutoDelete(TRUE);
   Doxygen::dirRelations.setAutoDelete(TRUE);
-  Doxygen::citeDict = new CiteDict(257);
   Doxygen::genericsDict = new GenericsSDict;
   Doxygen::indexList = new IndexList;
   Doxygen::sectionDict = new SectionDict(257);
@@ -11252,11 +11250,8 @@ void parseInput()
     g_s.end();
   }
 
-  //g_s.begin("Resolving citations...\n");
-  //Doxygen::citeDict->resolve();
-
   g_s.begin("Generating citations page...\n");
-  Doxygen::citeDict->generatePage();
+  CitationManager::instance().generatePage();
   g_s.end();
 
   g_s.begin("Counting members...\n");

src/doxygen.cpp

@@ -139,7 +139,6 @@ class Doxygen
     static QCString                  objDBFileName;
     static QCString                  entryDBFileName;
     static QCString                  filterDBFileName;
-    static CiteDict                 *citeDict;
     static bool                      userComments;
     static IndexList                *indexList;
     static int                       subpageNestingLevel;

src/doxygen.h

@@ -657,7 +657,8 @@ void LatexDocVisitor::visit(DocCite *cite)
   {
     //startLink(cite->ref(),cite->file(),cite->anchor());
     QCString anchor = cite->anchor();
-    anchor = anchor.mid(CiteConsts::anchorPrefix.length()); // strip prefix
+    QCString anchorPrefix = CitationManager::instance().anchorPrefix();
+    anchor = anchor.mid(anchorPrefix.length()); // strip prefix
     m_t << "\\cite{" << anchor << "}";
   }
   else

src/latexdocvisitor.cpp

@@ -283,7 +283,7 @@ LatexGenerator::~LatexGenerator()
 
 static void writeLatexMakefile()
 {
-  bool generateBib = !Doxygen::citeDict->isEmpty();
+  bool generateBib = !CitationManager::instance().isEmpty();
   QCString dir=Config_getString(LATEX_OUTPUT);
   QCString fileName=dir+"/Makefile";
   QFile file(fileName);
@@ -829,7 +829,7 @@ static void writeDefaultFooter(FTextStream &t)
        "\n";
 
   // Bibliography
-  Doxygen::citeDict->writeLatexBibliography(t);
+  CitationManager::instance().writeLatexBibliography(t);
 
   // Index
   t << "% Index\n";