Introduce LibraryPtr and ConstLibraryPtr.

As we enforce the use of Library through a shared_ptr, let's simplify user life (and code) with new "type".
kiwix · Aug 24, 2023 · ba825d4 · ba825d4
1 parent 5af183a
commit ba825d4
Show file tree

Hide file tree

Showing 17 changed files with 30 additions and 26 deletions.
diff --git a/include/html_dumper.h b/include/html_dumper.h
@@ -33,7 +33,7 @@ namespace kiwix
 class HTMLDumper : public LibraryDumper
 {
  public:
-  HTMLDumper(std::shared_ptr<const Library> library, std::shared_ptr<const NameMapper> NameMapper);
+  HTMLDumper(ConstLibraryPtr library, std::shared_ptr<const NameMapper> NameMapper);
   ~HTMLDumper();
 
 

diff --git a/include/library.h b/include/library.h
@@ -183,6 +183,9 @@ class ConcurrentCache;
 template<typename, typename>
 class MultiKeyCache;
 
+using LibraryPtr = std::shared_ptr<Library>;
+using ConstLibraryPtr = std::shared_ptr<const Library>;
+
 /**
  * A Library store several books.
  */
@@ -198,8 +201,8 @@ class Library: public std::enable_shared_from_this<Library>
   Library();
 
  public:
-  [[nodiscard]] static std::shared_ptr<Library> create() {
-    return std::shared_ptr<Library>(new Library());
+  [[nodiscard]] static LibraryPtr create() {
+    return LibraryPtr(new Library());
   }
   ~Library();
 
@@ -405,6 +408,7 @@ class Library: public std::enable_shared_from_this<Library>
   std::unique_ptr<Xapian::WritableDatabase> m_bookDB;
 };
 
+
 }
 
 #endif
diff --git a/include/library_dumper.h b/include/library_dumper.h
@@ -38,7 +38,7 @@ namespace kiwix
 class LibraryDumper
 {
  public:
-  LibraryDumper(std::shared_ptr<const Library> library, std::shared_ptr<const NameMapper> NameMapper);
+  LibraryDumper(ConstLibraryPtr library, std::shared_ptr<const NameMapper> NameMapper);
   ~LibraryDumper();
 
   void setLibraryId(const std::string& id) { this->libraryId = id;}

diff --git a/include/libxml_dumper.h b/include/libxml_dumper.h
@@ -38,7 +38,7 @@ class LibXMLDumper
 {
  public:
   LibXMLDumper() = default;
-  LibXMLDumper(std::shared_ptr<const Library> library);
+  LibXMLDumper(ConstLibraryPtr library);
   ~LibXMLDumper();
 
   /**
@@ -72,7 +72,7 @@ class LibXMLDumper
   void setLibrary(std::shared_ptr<const Library> library) { this->library = library; }
 
  protected:
-  std::shared_ptr<const kiwix::Library> library;
+  ConstLibraryPtr library;
   std::string baseDir;
  private:
   void handleBook(Book book, pugi::xml_node root_node);

diff --git a/include/manager.h b/include/manager.h
@@ -37,10 +37,10 @@ namespace kiwix
 class LibraryManipulator
 {
  public: // functions
-  explicit LibraryManipulator(std::shared_ptr<Library> library);
+  explicit LibraryManipulator(LibraryPtr library);
   virtual ~LibraryManipulator();
 
-  std::shared_ptr<Library> getLibrary() const { return library; }
+  LibraryPtr getLibrary() const { return library; }
 
   bool addBookToLibrary(const Book& book);
   void addBookmarkToLibrary(const Bookmark& bookmark);
@@ -52,7 +52,7 @@ class LibraryManipulator
   virtual void booksWereRemovedFromLibrary();
 
  private: // data
-  std::shared_ptr<kiwix::Library> library;
+  LibraryPtr library;
 };
 
 /**
@@ -65,7 +65,7 @@ class Manager
 
  public: // functions
   explicit Manager(LibraryManipulator manipulator);
-  explicit Manager(std::shared_ptr<Library> library);
+  explicit Manager(LibraryPtr library);
 
   /**
    * Read a `library.xml` and add book in the file to the library.

diff --git a/include/opds_dumper.h b/include/opds_dumper.h
@@ -42,7 +42,7 @@ namespace kiwix
 class OPDSDumper : public LibraryDumper
 {
  public:
-  OPDSDumper(std::shared_ptr<const Library> library, std::shared_ptr<const NameMapper> NameMapper);
+  OPDSDumper(ConstLibraryPtr library, std::shared_ptr<const NameMapper> NameMapper);
   ~OPDSDumper();
 
   /**

diff --git a/include/search_renderer.h b/include/search_renderer.h
@@ -58,7 +58,7 @@ class SearchRenderer
    * @param start The start offset used for the srs.
    * @param estimatedResultCount The estimatedResultCount of the whole search
    */
-  SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<const NameMapper> mapper, std::shared_ptr<const Library> library,
+  SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<const NameMapper> mapper, ConstLibraryPtr library,
                  unsigned int start, unsigned int estimatedResultCount);
 
   ~SearchRenderer();
@@ -107,7 +107,7 @@ class SearchRenderer
   std::string beautifyInteger(const unsigned int number);
   zim::SearchResultSet m_srs;
   std::shared_ptr<const NameMapper> mp_nameMapper;
-  std::shared_ptr<const Library> mp_library;
+  ConstLibraryPtr mp_library;
   std::string searchBookQuery;
   std::string searchPattern;
   std::string protocolPrefix;

diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp
@@ -9,7 +9,7 @@ namespace kiwix
 {
 
 /* Constructor */
-HTMLDumper::HTMLDumper(std::shared_ptr<const Library> library, std::shared_ptr<const NameMapper> nameMapper)
+HTMLDumper::HTMLDumper(ConstLibraryPtr library, std::shared_ptr<const NameMapper> nameMapper)
   : LibraryDumper(library, nameMapper)
 {
 }

diff --git a/src/library_dumper.cpp b/src/library_dumper.cpp
@@ -6,7 +6,7 @@
 namespace kiwix
 {
 /* Constructor */
-LibraryDumper::LibraryDumper(std::shared_ptr<const Library> library, std::shared_ptr<const NameMapper> nameMapper)
+LibraryDumper::LibraryDumper(ConstLibraryPtr library, std::shared_ptr<const NameMapper> nameMapper)
   : library(library),
     nameMapper(nameMapper)
 {

diff --git a/src/libxml_dumper.cpp b/src/libxml_dumper.cpp
@@ -28,7 +28,7 @@
 namespace kiwix
 {
 /* Constructor */
-LibXMLDumper::LibXMLDumper(std::shared_ptr<const Library> library)
+LibXMLDumper::LibXMLDumper(ConstLibraryPtr library)
   : library(library)
 {
 }

diff --git a/src/manager.cpp b/src/manager.cpp
@@ -33,7 +33,7 @@ namespace kiwix
 // LibraryManipulator
 ////////////////////////////////////////////////////////////////////////////////
 
-LibraryManipulator::LibraryManipulator(std::shared_ptr<Library> library)
+LibraryManipulator::LibraryManipulator(LibraryPtr library)
   : library(library)
 {}
 
@@ -87,7 +87,7 @@ Manager::Manager(LibraryManipulator manipulator):
 {
 }
 
-Manager::Manager(std::shared_ptr<Library> library) :
+Manager::Manager(LibraryPtr library) :
   writableLibraryPath(""),
   manipulator(LibraryManipulator(library))
 {

diff --git a/src/name_mapper.cpp b/src/name_mapper.cpp
@@ -24,7 +24,7 @@
 
 namespace kiwix {
 
-HumanReadableNameMapper::HumanReadableNameMapper(std::shared_ptr<const kiwix::Library> library, bool withAlias) {
+HumanReadableNameMapper::HumanReadableNameMapper(ConstLibraryPtr library, bool withAlias) {
   for (auto& bookId: library->filter(kiwix::Filter().local(true).valid(true))) {
     auto& currentBook = library->getBookById(bookId);
     auto bookName = currentBook.getHumanReadableIdFromPath();
@@ -63,7 +63,7 @@ std::string HumanReadableNameMapper::getIdForName(const std::string& name) const
 // UpdatableNameMapper
 ////////////////////////////////////////////////////////////////////////////////
 
-UpdatableNameMapper::UpdatableNameMapper(std::shared_ptr<Library> lib, bool withAlias)
+UpdatableNameMapper::UpdatableNameMapper(LibraryPtr lib, bool withAlias)
   : library(lib)
   , withAlias(withAlias)
 {

diff --git a/src/opds_dumper.cpp b/src/opds_dumper.cpp
@@ -30,7 +30,7 @@ namespace kiwix
 {
 
 /* Constructor */
-OPDSDumper::OPDSDumper(std::shared_ptr<const Library> library, std::shared_ptr<const NameMapper> nameMapper)
+OPDSDumper::OPDSDumper(ConstLibraryPtr library, std::shared_ptr<const NameMapper> nameMapper)
   : LibraryDumper(library, nameMapper)
 {
 }

diff --git a/src/search_renderer.cpp b/src/search_renderer.cpp
@@ -41,7 +41,7 @@ SearchRenderer::SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<const N
     : SearchRenderer(srs, mapper, nullptr, start, estimatedResultCount)
 {}
 
-SearchRenderer::SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<const NameMapper> mapper, std::shared_ptr<const Library> library,
+SearchRenderer::SearchRenderer(zim::SearchResultSet srs, std::shared_ptr<const NameMapper> mapper, ConstLibraryPtr library,
                       unsigned int start, unsigned int estimatedResultCount)
     : m_srs(srs),
       mp_nameMapper(mapper),

diff --git a/src/server.cpp b/src/server.cpp
@@ -29,7 +29,7 @@
 
 namespace kiwix {
 
-Server::Server(std::shared_ptr<Library> library, std::shared_ptr<const NameMapper> nameMapper) :
+Server::Server(LibraryPtr library, std::shared_ptr<const NameMapper> nameMapper) :
   mp_library(library),
   mp_nameMapper(nameMapper),
   mp_server(nullptr)

diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp
@@ -411,7 +411,7 @@ class InternalServer::CustomizedResources : public std::map<std::string, Customi
 };
 
 
-InternalServer::InternalServer(std::shared_ptr<Library> library,
+InternalServer::InternalServer(LibraryPtr library,
                                std::shared_ptr<const NameMapper> nameMapper,
                                std::string addr,
                                int port,

diff --git a/src/server/internalServer.h b/src/server/internalServer.h
@@ -92,7 +92,7 @@ class OPDSDumper;
 
 class InternalServer {
   public:
-    InternalServer(std::shared_ptr<Library> library,
+    InternalServer(LibraryPtr library,
                    std::shared_ptr<const NameMapper> nameMapper,
                    std::string addr,
                    int port,
@@ -178,7 +178,7 @@ class InternalServer {
     int m_ipConnectionLimit;
     struct MHD_Daemon* mp_daemon;
 
-    std::shared_ptr<Library> mp_library;
+    LibraryPtr mp_library;
     std::shared_ptr<const NameMapper> mp_nameMapper;
 
     SearchCache searchCache;