Refactoring: Introduce immutable and mutable interfaces

Split Definition/ClassDef/NamespaceDef/MemberDef into a immutable and mutable part
Aliases are immutable, other symbols are stored using an immutable
interface but can be made mutable explicitly by dynamic casting.

1 files changed, 25 insertions, 13 deletions

diff --git a/src/definition.h b/src/definition.h
index ee5c428..94c95b8 100644
--- a/src/definition.h
+++ b/src/definition.h
@@ -40,6 +40,7 @@ class GroupDef;
 class GroupList;
 class SectionInfo;
 class Definition;
+class DefinitionMutable;
 class FTextStream;
 
 /** Data associated with a detailed description. */
@@ -94,6 +95,8 @@ class Definition
       TypeDir        = 7
     };
 
+    static DefinitionMutable *make_mutable(const Definition *);
+
     //-----------------------------------------------------------------------------------
     // ----  getters -----
     //-----------------------------------------------------------------------------------
@@ -284,6 +287,25 @@ class Definition
     virtual QCString pathFragment() const = 0;
 
     //-----------------------------------------------------------------------------------
+    // --- cookie storage ----
+    //-----------------------------------------------------------------------------------
+    virtual void setCookie(Cookie *cookie) const = 0;
+    virtual Cookie *cookie() const = 0;
+
+    //-----------------------------------------------------------------------------------
+    // --- symbol name ----
+    //-----------------------------------------------------------------------------------
+    virtual void _setSymbolName(const QCString &name) = 0;
+    virtual QCString _symbolName() const = 0;
+
+    // ---------------------------------
+    virtual ~Definition() = default;
+};
+
+class DefinitionMutable : virtual public Definition
+{
+  public:
+    //-----------------------------------------------------------------------------------
     // ----  setters -----
     //-----------------------------------------------------------------------------------
 
@@ -358,22 +380,12 @@ class Definition
     virtual void writeDocAnchorsToTagFile(FTextStream &) const = 0;
     virtual void writeToc(OutputList &ol, const LocalToc &lt) const = 0;
 
-    //-----------------------------------------------------------------------------------
-    // --- cookie storage ----
-    //-----------------------------------------------------------------------------------
-    virtual void setCookie(Cookie *cookie) const = 0;
-    virtual Cookie *cookie() const = 0;
-
-    //-----------------------------------------------------------------------------------
-    // --- symbol name ----
-    //-----------------------------------------------------------------------------------
-    virtual void _setSymbolName(const QCString &name) = 0;
-    virtual QCString _symbolName() const = 0;
 
-    // ---------------------------------
-    virtual ~Definition() = default;
 };
 
+inline DefinitionMutable *Definition::make_mutable(const Definition *def)
+{ return dynamic_cast<DefinitionMutable*>(const_cast<Definition*>(def)); }
+
 /** Reads a fragment from file \a fileName starting with line \a startLine
  *  and ending with line \a endLine. The result is returned as a string
  *  via \a result. The function returns TRUE if successful and FALSE