element capabilities and cleanup

Author: andiwand

CMakeLists.txt

@@ -178,6 +178,7 @@ set(ODR_SOURCE_FILES
         "src/odr/internal/text/text_util.cpp"
 
         "src/odr/internal/util/byte_util.cpp"
+        "src/odr/internal/util/document_util.cpp"
         "src/odr/internal/util/file_util.cpp"
         "src/odr/internal/util/hash_util.cpp"
         "src/odr/internal/util/odr_meta_util.cpp"

src/odr/document_element.cpp

@@ -1,5 +1,6 @@
 #include <odr/document_element.hpp>
 
+#include <odr/document_path.hpp>
 #include <odr/file.hpp>
 #include <odr/style.hpp>
 #include <odr/table_dimension.hpp>
@@ -48,10 +49,30 @@ Element Element::next_sibling() const {
              : Element();
 }
 
+bool Element::is_unique() const {
+  return exists_() ? m_adapter->element_is_unique(m_identifier) : false;
+}
+
+bool Element::is_self_locatable() const {
+  return exists_() ? m_adapter->element_is_self_locatable(m_identifier) : false;
+}
+
 bool Element::is_editable() const {
   return exists_() ? m_adapter->element_is_editable(m_identifier) : false;
 }
 
+DocumentPath Element::document_path() const {
+  return exists_() ? m_adapter->element_document_path(m_identifier)
+                   : DocumentPath();
+}
+
+Element Element::navigate_path(const DocumentPath &path) const {
+  return exists_()
+             ? Element(m_adapter,
+                       m_adapter->element_navigate_path(m_identifier, path))
+             : Element();
+}
+
 TextRoot Element::as_text_root() const {
   return {m_adapter, m_identifier, m_adapter->text_root_adapter(m_identifier)};
 }

src/odr/document_element.hpp

@@ -9,6 +9,7 @@
 namespace odr {
 class TablePosition;
 struct TableDimensions;
+class DocumentPath;
 class File;
 struct TextStyle;
 struct ParagraphStyle;
@@ -153,7 +154,11 @@ class Element {
   [[nodiscard]] Element previous_sibling() const;
   [[nodiscard]] Element next_sibling() const;
 
+  [[nodiscard]] bool is_unique() const;
+  [[nodiscard]] bool is_self_locatable() const;
   [[nodiscard]] bool is_editable() const;
+  [[nodiscard]] DocumentPath document_path() const;
+  [[nodiscard]] Element navigate_path(const DocumentPath &path) const;
 
   [[nodiscard]] ElementRange children() const;
 
@@ -183,7 +188,7 @@ class Element {
 
 protected:
   const internal::abstract::ElementAdapter *m_adapter{nullptr};
-  ElementIdentifier m_identifier;
+  ElementIdentifier m_identifier{null_element_id};
 
   friend bool operator==(const Element &lhs, const Element &rhs) {
     return lhs.m_identifier == rhs.m_identifier;

src/odr/document_path.cpp

@@ -1,8 +1,5 @@
 #include <odr/document_path.hpp>
 
-#include <odr/document_element.hpp>
-
-#include <algorithm>
 #include <stdexcept>
 
 namespace odr {
@@ -12,45 +9,10 @@ const std::string &DocumentPath::Child::prefix_string() {
   return result;
 }
 
-std::pair<Element, DocumentPath::Child>
-DocumentPath::Child::extract(const Element element) {
-  if (!element) {
-    throw std::invalid_argument("element is null");
-  }
-  const Element parent = element.parent();
-  if (!parent) {
-    throw std::invalid_argument("parent not found");
-  }
-
-  Element current = element;
-  std::uint32_t distance = 0;
-  for (; current.previous_sibling(); current = current.previous_sibling()) {
-    ++distance;
-  }
-
-  return {parent, Child(distance)};
-}
-
-Element DocumentPath::Child::resolve(const Element element,
-                                     const Child &child) {
-  if (!element) {
-    throw std::invalid_argument("element is null");
-  }
-  if (!element.first_child()) {
-    throw std::invalid_argument("child not found");
-  }
-  Element result = element.first_child();
-  for (std::uint32_t i = 0; i < child.m_number; ++i) {
-    if (!result.next_sibling()) {
-      throw std::invalid_argument("sibling not found");
-    }
-    result = result.next_sibling();
-  }
-  return result;
-}
-
 DocumentPath::Child::Child(const std::uint32_t number) : m_number{number} {}
 
+std::uint32_t DocumentPath::Child::number() const { return m_number; }
+
 bool DocumentPath::Child::operator==(const Child &other) const noexcept {
   return m_number == other.m_number;
 }
@@ -64,37 +26,11 @@ const std::string &DocumentPath::Cell::prefix_string() {
   return result;
 }
 
-std::pair<Sheet, DocumentPath::Cell>
-DocumentPath::Cell::extract(const SheetCell &element) {
-  if (!element) {
-    throw std::invalid_argument("element is null");
-  }
-  const Element parent = element.parent();
-  if (!parent) {
-    throw std::invalid_argument("parent not found");
-  }
-  const Sheet sheet = parent.as_sheet();
-  if (!sheet) {
-    throw std::invalid_argument("parent is not a sheet");
-  }
-  const SheetCell cell = element.as_sheet_cell();
-  if (!cell) {
-    throw std::invalid_argument("element is not a sheet cell");
-  }
-  return {sheet, Cell(cell.position())};
-}
-
-SheetCell DocumentPath::Cell::resolve(const Sheet &element, const Cell &cell) {
-  if (!element) {
-    throw std::invalid_argument("element is null");
-  }
-  return element.as_sheet().cell(cell.m_position.column(),
-                                 cell.m_position.row());
-}
-
 DocumentPath::Cell::Cell(const TablePosition &position)
     : m_position{position} {}
 
+TablePosition DocumentPath::Cell::position() const { return m_position; }
+
 bool DocumentPath::Cell::operator==(const Cell &other) const noexcept {
   return m_position == other.m_position;
 }
@@ -124,57 +60,6 @@ DocumentPath::component_from_string(const std::string &string) {
   throw std::invalid_argument("string");
 }
 
-DocumentPath DocumentPath::extract(const Element element) {
-  return extract(element, {});
-}
-
-DocumentPath DocumentPath::extract(const Element element, const Element root) {
-  std::vector<Component> reverse;
-
-  for (Element current = element; current != root;) {
-    if (!current.parent()) {
-      break;
-    }
-
-    if (const SheetCell sheet_cell = current.as_sheet_cell(); sheet_cell) {
-      const auto [parent, cell] = Cell::extract(sheet_cell);
-      reverse.emplace_back(cell);
-      current = static_cast<Element>(parent);
-    } else {
-      const auto [parent, child] = Child::extract(current);
-      reverse.emplace_back(child);
-      current = parent;
-    }
-  }
-
-  std::ranges::reverse(reverse);
-  return DocumentPath(reverse);
-}
-
-Element DocumentPath::resolve(const Element root, const DocumentPath &path) {
-  Element element = root;
-
-  for (const Component &c : path) {
-    if (const auto *child = std::get_if<Child>(&c); child != nullptr) {
-      element = Child::resolve(element, *child);
-    } else if (const auto *cell = std::get_if<Cell>(&c); cell != nullptr) {
-      const Sheet sheet = element.as_sheet();
-      if (!sheet) {
-        throw std::invalid_argument("element is not a sheet");
-      }
-      const SheetCell sheet_cell = Cell::resolve(sheet, *cell);
-      element = static_cast<Element>(sheet_cell);
-    } else {
-      throw std::invalid_argument("unknown component");
-    }
-    if (!element) {
-      throw std::invalid_argument("element not found");
-    }
-  }
-
-  return element;
-}
-
 DocumentPath::DocumentPath() noexcept = default;
 
 DocumentPath::DocumentPath(const Container &components)
@@ -228,7 +113,7 @@ std::string DocumentPath::to_string() const noexcept {
 
 bool DocumentPath::empty() const noexcept { return m_components.empty(); }
 
-DocumentPath::Component DocumentPath::back() const {
+const DocumentPath::Component &DocumentPath::back() const {
   return m_components.back();
 }
 

src/odr/document_path.hpp

@@ -4,15 +4,10 @@
 
 #include <cstdint>
 #include <string>
-#include <utility>
 #include <variant>
 #include <vector>
 
 namespace odr {
-class Document;
-class Element;
-class Sheet;
-class SheetCell;
 
 /// @brief A path to a specific element in a document.
 class DocumentPath final {
@@ -22,11 +17,11 @@ class DocumentPath final {
     static constexpr std::string_view prefix = "child";
 
     static const std::string &prefix_string();
-    static std::pair<Element, Child> extract(Element element);
-    static Element resolve(Element element, const Child &child);
 
     explicit Child(std::uint32_t number);
 
+    [[nodiscard]] std::uint32_t number() const;
+
     bool operator==(const Child &other) const noexcept;
     [[nodiscard]] std::string to_string() const noexcept;
 
@@ -39,11 +34,11 @@ class DocumentPath final {
     static constexpr std::string_view prefix = "cell";
 
     static const std::string &prefix_string();
-    static std::pair<Sheet, Cell> extract(const SheetCell &element);
-    static SheetCell resolve(const Sheet &element, const Cell &cell);
 
     explicit Cell(const TablePosition &position);
 
+    [[nodiscard]] TablePosition position() const;
+
     bool operator==(const Cell &other) const noexcept;
     [[nodiscard]] std::string to_string() const noexcept;
 
@@ -56,9 +51,6 @@ class DocumentPath final {
   using const_iterator = Container::const_iterator;
 
   static Component component_from_string(const std::string &string);
-  static DocumentPath extract(Element element);
-  static DocumentPath extract(Element element, Element root);
-  static Element resolve(Element root, const DocumentPath &path);
 
   DocumentPath() noexcept;
   explicit DocumentPath(const Container &components);
@@ -73,7 +65,7 @@ class DocumentPath final {
 
   [[nodiscard]] bool empty() const noexcept;
 
-  [[nodiscard]] Component back() const;
+  [[nodiscard]] const Component &back() const;
   [[nodiscard]] DocumentPath parent() const;
   [[nodiscard]] DocumentPath join(const DocumentPath &other) const;
 

src/odr/html.cpp

@@ -40,7 +40,7 @@ void bring_offline(const HtmlResources &resources,
         resource.is_external() || !resource.is_accessible()) {
       continue;
     }
-    auto path = Path(output_path).join(RelPath(*location));
+    const Path path = Path(output_path).join(RelPath(*location));
 
     std::filesystem::create_directories(path.parent().path());
     std::ofstream ostream = util::file::create(path.string());
@@ -113,8 +113,8 @@ Html HtmlService::bring_offline(const std::string &output_path,
 
   HtmlResources resources;
 
-  for (const auto &view : views) {
-    auto path = Path(output_path).join(RelPath(view.path()));
+  for (const HtmlView &view : views) {
+    const Path path = Path(output_path).join(RelPath(view.path()));
 
     std::filesystem::create_directories(path.parent().path());
     std::ofstream ostream = util::file::create(path.string());
@@ -164,7 +164,7 @@ HtmlResources HtmlView::write_html(std::ostream &out) const {
 Html HtmlView::bring_offline(const std::string &output_path) const {
   HtmlResources resources;
 
-  const auto path = Path(output_path).join(RelPath(this->path()));
+  const Path path = Path(output_path).join(RelPath(this->path()));
 
   {
     std::filesystem::create_directories(path.parent().path());
@@ -248,7 +248,7 @@ HtmlResourceLocator html::standard_resource_locator() {
     }
 
     if (resource.is_shipped()) {
-      auto resource_path =
+      Path resource_path =
           Path(config.resource_path).join(RelPath(resource.path()));
       if (config.relative_resource_paths && config.output_path.has_value()) {
         resource_path = resource_path.rebase(Path(*config.output_path));
@@ -294,7 +294,7 @@ HtmlService html::translate(const DocumentFile &document_file,
       document_file.impl();
 
 #ifdef ODR_WITH_WVWARE
-  if (const auto wv_document_file =
+  if (const std::shared_ptr wv_document_file =
           std::dynamic_pointer_cast<WvWareLegacyMicrosoftFile>(
               document_file_impl)) {
     std::filesystem::create_directories(cache_path);
@@ -314,7 +314,7 @@ HtmlService html::translate(const PdfFile &pdf_file,
   const std::shared_ptr<abstract::PdfFile> pdf_file_impl = pdf_file.impl();
 
 #ifdef ODR_WITH_PDF2HTMLEX
-  if (const auto poppler_pdf_file =
+  if (const std::shared_ptr poppler_pdf_file =
           std::dynamic_pointer_cast<PopplerPdfFile>(pdf_file_impl)) {
     std::filesystem::create_directories(cache_path);
     return internal::html::create_poppler_pdf_service(
@@ -354,10 +354,10 @@ HtmlService html::translate(const Document &document,
 
 void html::edit(const Document &document, const char *diff,
                 Logger & /*logger*/) {
-  for (auto json = nlohmann::json::parse(diff);
-       const auto &[key, value] : json["modifiedText"].items()) {
-    auto element =
-        DocumentPath::resolve(document.root_element(), DocumentPath(key));
+  const nlohmann::json json = nlohmann::json::parse(diff);
+  for (const auto &[key, value] : json["modifiedText"].items()) {
+    const Element element =
+        document.root_element().navigate_path(DocumentPath(key));
     if (!element) {
       throw std::invalid_argument("element with path " + key + " not found");
     }