Public release

lib/Epub/Epub.h

@@ -0,0 +1,73 @@
+#pragma once
+#include <HardwareSerial.h>
+
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+class ZipFile;
+
+class EpubTocEntry {
+ public:
+  std::string title;
+  std::string href;
+  std::string anchor;
+  int level;
+  EpubTocEntry(std::string title, std::string href, std::string anchor, const int level)
+      : title(std::move(title)), href(std::move(href)), anchor(std::move(anchor)), level(level) {}
+};
+
+class Epub {
+  // the title read from the EPUB meta data
+  std::string title;
+  // the cover image
+  std::string coverImageItem;
+  // the ncx file
+  std::string tocNcxItem;
+  // where is the EPUBfile?
+  std::string filepath;
+  // the spine of the EPUB file
+  std::vector<std::pair<std::string, std::string>> spine;
+  // the toc of the EPUB file
+  std::vector<EpubTocEntry> toc;
+  // the base path for items in the EPUB file
+  std::string contentBasePath;
+  // Uniq cache key based on filepath
+  std::string cachePath;
+
+  // find the path for the content.opf file
+  static bool findContentOpfFile(const ZipFile& zip, std::string& contentOpfFile);
+  bool parseContentOpf(ZipFile& zip, std::string& content_opf_file);
+  bool parseTocNcxFile(ZipFile& zip);
+
+ public:
+  explicit Epub(std::string filepath, const std::string& cacheDir) : filepath(std::move(filepath)) {
+    // create a cache key based on the filepath
+
+    cachePath = cacheDir + "/epub_" + std::to_string(std::hash<std::string>{}(this->filepath));
+  }
+  ~Epub() = default;
+  std::string& getBasePath() { return contentBasePath; }
+  bool load();
+
+  void clearCache() const;
+
+  void setupCacheDir() const;
+
+  const std::string& getCachePath() const;
+  const std::string& getPath() const;
+  const std::string& getTitle() const;
+  const std::string& getCoverImageItem() const;
+  uint8_t* getItemContents(const std::string& itemHref, size_t* size = nullptr) const;
+  char* getTextItemContents(const std::string& itemHref, size_t* size = nullptr) const;
+
+  std::string& getSpineItem(int spineIndex);
+  int getSpineItemsCount() const;
+
+  EpubTocEntry& getTocItem(int tocTndex);
+  int getTocItemsCount() const;
+  // work out the section index for a toc index
+  int getSpineIndexForTocIndex(int tocIndex) const;
+
+  int getTocIndexForSpineIndex(int spineIndex) const;
+};