Refactoring: modernize Doxygen::symbolMap

1 files changed, 79 insertions, 0 deletions

diff --git a/src/symbolmap.h b/src/symbolmap.h
new file mode 100644
index 0000000..44c363c
--- /dev/null
+++ b/src/symbolmap.h
@@ -0,0 +1,79 @@
+/******************************************************************************
+ *
+ * Copyright (C) 1997-2020 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.
+ *
+ */
+
+#ifndef SYMBOLMAP_H
+#define SYMBOLMAP_H
+
+#include <algorithm>
+#include <unordered_map>
+#include <vector>
+#include <string>
+#include <utility>
+
+//! Class implementing a symbol map that maps symbol names to objects.
+//! Symbol names do not have to be unique.
+//! Supports adding symbols with add(), removing symbols with remove(), and
+//! finding symbols with find().
+template<class T>
+class SymbolMap
+{
+  public:
+    using Ptr = T *;
+    using Map = std::unordered_multimap<std::string,Ptr>;
+    using iterator = typename Map::iterator;
+    using const_iterator = typename Map::const_iterator;
+
+    //! Add a symbol \a def into the map under key \a name
+    void add(const char *name,Ptr def)
+    {
+      m_map.insert({std::string(name),def});
+    }
+
+    //! Remove a symbol \a def from the map that was stored under key \a name
+    void remove(const char *name,Ptr def)
+    {
+      auto range = find(name);
+      for (auto it=range.first; it!=range.second; )
+      {
+        if (it->second==def) it = m_map.erase(it); else ++it;
+      }
+    }
+
+    //! Find the list of symbols stored under key \a name
+    //! Returns a pair of iterators pointing to the start and end of the range of matching symbols
+    std::pair<const_iterator,const_iterator> find(const char *name) const
+    {
+      return m_map.equal_range(name ? name : "");
+    }
+
+    //! Find the list of symbols stored under key \a name
+    //! Returns a pair of iterators pointing to the start and end of the range of matching symbols
+    std::pair<iterator,iterator> find(const char *name)
+    {
+      return m_map.equal_range(name ? name : "");
+    }
+
+    iterator begin()             { return m_map.begin();  }
+    iterator end()               { return m_map.end();    }
+    const_iterator begin() const { return m_map.cbegin(); }
+    const_iterator end() const   { return m_map.cend();   }
+    bool empty() const           { return m_map.empty();  }
+    size_t size() const          { return m_map.size();   }
+
+  private:
+    Map m_map;
+};
+
+#endif