Refactoring: remove CodeOutputInterface base class from OutputCodeList

Author: doxygen

src/htmlgen.cpp

@@ -2455,7 +2455,7 @@ void HtmlGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const
   const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast);
   if (astImpl)
   {
-    m_codeGen.setId(id);
+    m_codeList.setId(id);
     HtmlDocVisitor visitor(m_t,m_codeList,ctx);
     std::visit(visitor,astImpl->root);
   }

src/outputgen.h

@@ -68,10 +68,6 @@ class CodeOutputInterface
 
     virtual OutputType type() const = 0;
 
-    /** Identifier for the output file */
-    virtual int id() const { return m_id; }
-    virtual void setId(int id) { m_id=id; }
-
     virtual void setEnabled(bool e) { m_active = e; }
     virtual bool isEnabled() const { return m_active; }
 
@@ -153,7 +149,6 @@ class CodeOutputInterface
     virtual void endCodeFragment(const QCString &style) = 0;
 
   private:
-    int m_id = -1;
     bool m_active = true;
 };
 

src/outputlist.cpp

@@ -48,8 +48,8 @@ OutputList::OutputList(const OutputList &ol)
   for (const auto &og : ol.m_outputs)
   {
     auto docGen = og->clone();
-    docGen->codeGen()->setId(m_id);
     m_codeGenList.add(docGen->codeGen());
+    m_codeGenList.setId(m_id);
     m_outputs.emplace_back(std::move(docGen));
   }
 }
@@ -63,8 +63,8 @@ OutputList &OutputList::operator=(const OutputList &ol)
     for (const auto &og : ol.m_outputs)
     {
       auto docGen = og->clone();
-      docGen->codeGen()->setId(m_id);
       m_codeGenList.add(docGen->codeGen());
+      m_codeGenList.setId(m_id);
       m_outputs.emplace_back(std::move(docGen));
     }
   }
@@ -195,7 +195,7 @@ void OutputList::generateDoc(const QCString &fileName,int startLine,
                                      fileName,startLine,
                                      ctx,md,docStr,indexWords,isExample,exampleName,
                                      singleLine,linkFromIndex,markdownSupport) };
-    if (ast) writeDoc(ast.get(),ctx,md,m_id);
+    if (ast) writeDoc(ast.get(),ctx,md);
   }
 }
 
@@ -206,7 +206,7 @@ void OutputList::startFile(const QCString &name,const QCString &manName,const QC
   forall(&OutputGenerator::startFile,name,manName,title,m_id);
 }
 
-void OutputList::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *md,int)
+void OutputList::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *md)
 {
   for (const auto &og : m_outputs)
   {

src/outputlist.h

@@ -30,22 +30,23 @@ class DotInclDepGraph;
 class DotGfxHierarchyTable;
 class DotGroupCollaboration;
 
-class OutputCodeList : public CodeOutputInterface
+class OutputCodeList
 {
   public:
     OutputCodeList() = default;
     virtual ~OutputCodeList() = default;
 
-    OutputType type() const override { return OutputType::List; }
+    OutputType type() const { return OutputType::List; }
 
+    /** Identifier for the output file */
     void add(CodeOutputInterface *codeGen)
     {
       m_outputCodeList.push_back(codeGen);
     }
-    void setId(int id) override
+    virtual int id() const { return m_id; }
+    void setId(int id)
     {
-      CodeOutputInterface::setId(id);
-      forall(&CodeOutputInterface::setId,id);
+      m_id = id;
     }
     void setEnabledFiltered(OutputType o,bool enabled)
     {
@@ -57,32 +58,32 @@ class OutputCodeList : public CodeOutputInterface
 
     // ---- CodeOutputInterface forwarding
 
-    void codify(const QCString &s) override
+    void codify(const QCString &s)
     { forall(&CodeOutputInterface::codify,s); }
     void writeCodeLink(CodeSymbolType type,
                        const QCString &ref,const QCString &file,
                        const QCString &anchor,const QCString &name,
-                       const QCString &tooltip) override
+                       const QCString &tooltip)
     { forall(&CodeOutputInterface::writeCodeLink,type,ref,file,anchor,name,tooltip); }
     void writeLineNumber(const QCString &ref,const QCString &file,const QCString &anchor,
-                         int lineNumber, bool writeLineAnchor) override
+                         int lineNumber, bool writeLineAnchor)
     { forall(&CodeOutputInterface::writeLineNumber,ref,file,anchor,lineNumber,writeLineAnchor); }
     void writeTooltip(const QCString &id, const DocLinkInfo &docInfo, const QCString &decl,
-                      const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override
+                      const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
     { forall(&CodeOutputInterface::writeTooltip,id,docInfo,decl,desc,defInfo,declInfo); }
-    void startCodeLine(bool hasLineNumbers) override
+    void startCodeLine(bool hasLineNumbers)
     { forall(&CodeOutputInterface::startCodeLine,hasLineNumbers); }
-    void endCodeLine() override
+    void endCodeLine()
     { forall(&CodeOutputInterface::endCodeLine); }
-    void startFontClass(const QCString &c) override
+    void startFontClass(const QCString &c)
     { forall(&CodeOutputInterface::startFontClass,c); }
-    void endFontClass() override
+    void endFontClass()
     { forall(&CodeOutputInterface::endFontClass); }
-    void writeCodeAnchor(const QCString &name) override
+    void writeCodeAnchor(const QCString &name)
     { forall(&CodeOutputInterface::writeCodeAnchor,name); }
-    void startCodeFragment(const QCString &style) override
+    void startCodeFragment(const QCString &style)
     { forall(&CodeOutputInterface::startCodeFragment,style); }
-    void endCodeFragment(const QCString &style) override
+    void endCodeFragment(const QCString &style)
     { forall(&CodeOutputInterface::endCodeFragment,style); }
 
   private:
@@ -95,6 +96,7 @@ class OutputCodeList : public CodeOutputInterface
       }
     }
     std::vector< CodeOutputInterface* > m_outputCodeList;
+    int m_id = -1;
 };
 
 /** Class representing a list of output generators that are written to
@@ -112,8 +114,8 @@ class OutputList
     void add()
     {
       auto docGen = std::make_unique<DocGenerator>();
-      docGen->codeGen()->setId(m_id);
       m_codeGenList.add(docGen->codeGen());
+      m_codeGenList.setId(m_id);
       m_outputs.emplace_back(std::move(docGen));
     }
 
@@ -140,7 +142,7 @@ class OutputList
                      bool indexWords,bool isExample,const QCString &exampleName /*=0*/,
                      bool singleLine /*=FALSE*/,bool linkFromIndex /*=FALSE*/,
                      bool markdownSupport /*=FALSE*/);
-    void writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *md,int id=0);
+    void writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *md);
     void parseText(const QCString &textStr);
     void startFile(const QCString &name,const QCString &manName,const QCString &title);
 

src/tooltip.cpp

@@ -21,7 +21,7 @@
 
 #include "tooltip.h"
 #include "definition.h"
-#include "outputgen.h"
+#include "outputlist.h"
 #include "util.h"
 #include "filedef.h"
 #include "doxygen.h"
@@ -84,7 +84,7 @@ void TooltipManager::addTooltip(const Definition *d)
   //printf("%p: addTooltip(%s)\n",this,id.data());
 }
 
-void TooltipManager::writeTooltips(CodeOutputInterface &ol)
+void TooltipManager::writeTooltips(OutputCodeList &ol)
 {
   // critical section
   std::lock_guard<std::mutex> lock(g_tooltipsMutex);

src/tooltip.h

@@ -18,7 +18,7 @@
 #include <memory>
 
 class Definition;
-class CodeOutputInterface;
+class OutputCodeList;
 
 //! Class that manages the tooltips for a source file
 class TooltipManager
@@ -31,7 +31,7 @@ class TooltipManager
     void addTooltip(const Definition *d);
 
     /** write the list of all collected tooltip to the given outputs */
-    void writeTooltips(CodeOutputInterface &ol);
+    void writeTooltips(OutputCodeList &ol);
 
   private:
     class Private;