rework document tree (#452)

Author: andiwand

CMakeLists.txt

@@ -87,6 +87,8 @@ set(ODR_SOURCE_FILES
         "src/odr/odr.cpp"
         "src/odr/quantity.cpp"
         "src/odr/style.cpp"
+        "src/odr/table_dimension.cpp"
+        "src/odr/table_position.cpp"
 
         "${CMAKE_CURRENT_BINARY_DIR}/src/odr/internal/git_info.cpp"
         "src/odr/internal/magic.cpp"
@@ -99,15 +101,14 @@ set(ODR_SOURCE_FILES
         "src/odr/internal/cfb/cfb_util.cpp"
 
         "src/odr/internal/common/document.cpp"
-        "src/odr/internal/common/document_element.cpp"
         "src/odr/internal/common/file.cpp"
         "src/odr/internal/common/filesystem.cpp"
         "src/odr/internal/common/image_file.cpp"
         "src/odr/internal/common/path.cpp"
         "src/odr/internal/common/random.cpp"
         "src/odr/internal/common/style.cpp"
         "src/odr/internal/common/table_cursor.cpp"
-        "src/odr/internal/common/table_position.cpp"
+        "src/odr/table_position.cpp"
         "src/odr/internal/common/table_range.cpp"
         "src/odr/internal/common/temporary_file.cpp"
 
@@ -133,25 +134,24 @@ set(ODR_SOURCE_FILES
 
         "src/odr/internal/odf/odf_crypto.cpp"
         "src/odr/internal/odf/odf_document.cpp"
-        "src/odr/internal/odf/odf_element.cpp"
+        "src/odr/internal/odf/odf_element_registry.cpp"
         "src/odr/internal/odf/odf_file.cpp"
         "src/odr/internal/odf/odf_manifest.cpp"
         "src/odr/internal/odf/odf_meta.cpp"
         "src/odr/internal/odf/odf_parser.cpp"
-        "src/odr/internal/odf/odf_spreadsheet.cpp"
         "src/odr/internal/odf/odf_style.cpp"
 
         "src/odr/internal/oldms/oldms_file.cpp"
 
         "src/odr/internal/ooxml/presentation/ooxml_presentation_document.cpp"
-        "src/odr/internal/ooxml/presentation/ooxml_presentation_element.cpp"
+        "src/odr/internal/ooxml/presentation/ooxml_presentation_element_registry.cpp"
         "src/odr/internal/ooxml/presentation/ooxml_presentation_parser.cpp"
         "src/odr/internal/ooxml/spreadsheet/ooxml_spreadsheet_document.cpp"
-        "src/odr/internal/ooxml/spreadsheet/ooxml_spreadsheet_element.cpp"
         "src/odr/internal/ooxml/spreadsheet/ooxml_spreadsheet_parser.cpp"
+        "src/odr/internal/ooxml/spreadsheet/ooxml_spreadsheet_element_registry.cpp"
         "src/odr/internal/ooxml/spreadsheet/ooxml_spreadsheet_style.cpp"
         "src/odr/internal/ooxml/text/ooxml_text_document.cpp"
-        "src/odr/internal/ooxml/text/ooxml_text_element.cpp"
+        "src/odr/internal/ooxml/text/ooxml_text_element_registry.cpp"
         "src/odr/internal/ooxml/text/ooxml_text_parser.cpp"
         "src/odr/internal/ooxml/text/ooxml_text_style.cpp"
         "src/odr/internal/ooxml/ooxml_crypto.cpp"

README.md

@@ -38,3 +38,13 @@ As an alternative to the Conan remote you can also export the package locally vi
 ## Version
 
 Versions and history are tracked on [GitHub](https://github.com/opendocument-app/OpenDocument.core).
+
+## Testing
+
+### Running the HTML Comparison Server
+
+Scripts and Docker images can be found here https://github.com/opendocument-app/compare-html
+
+```bash
+./test/scripts/compare_output_server.sh
+```

cli/src/back_translate.cpp

@@ -4,20 +4,22 @@
 
 #include <odr/internal/util/file_util.hpp>
 
-#include <iostream>
 #include <string>
 
 using namespace odr;
 
 int main(int, char **argv) {
+  const std::shared_ptr logger =
+      Logger::create_stdio("odr-back-translate", LogLevel::verbose);
+
   const std::string input{argv[1]};
   const std::string diff_path{argv[2]};
   const std::string output{argv[3]};
 
   const DocumentFile document_file{input};
 
   if (document_file.password_encrypted()) {
-    std::cerr << "encrypted documents are not supported" << std::endl;
+    ODR_FATAL(*logger, "encrypted documents are not supported");
     return 1;
   }
 

cli/src/meta.cpp

@@ -10,21 +10,27 @@
 using namespace odr;
 
 int main(const int argc, char **argv) {
+  const std::shared_ptr logger =
+      Logger::create_stdio("odr-meta", LogLevel::verbose);
+
   const std::string input{argv[1]};
 
-  const bool has_password = argc >= 4;
-  std::string password;
-  if (has_password) {
+  std::optional<std::string> password;
+  if (argc >= 3) {
     password = argv[2];
   }
 
   DocumentFile document_file{input};
 
-  if (document_file.password_encrypted() && has_password) {
+  if (document_file.password_encrypted() && !password) {
+    ODR_FATAL(*logger, "document encrypted but no password given");
+    return 2;
+  }
+  if (document_file.password_encrypted()) {
     try {
-      document_file = document_file.decrypt(password);
+      document_file = document_file.decrypt(*password);
     } catch (const WrongPasswordError &) {
-      std::cerr << "wrong password" << std::endl;
+      ODR_FATAL(*logger, "wrong password");
       return 1;
     }
   }

cli/src/server.cpp

@@ -1,15 +1,17 @@
+#include <odr/archive.hpp>
 #include <odr/exceptions.hpp>
 #include <odr/file.hpp>
+#include <odr/filesystem.hpp>
 #include <odr/html.hpp>
 #include <odr/http_server.hpp>
 
-#include <iostream>
 #include <string>
 
 using namespace odr;
 
 int main(const int argc, char **argv) {
-  auto logger = Logger::create_stdio("odr-server", LogLevel::verbose);
+  const std::shared_ptr logger =
+      Logger::create_stdio("odr-server", LogLevel::verbose);
 
   std::string input{argv[1]};
 
@@ -48,15 +50,36 @@ int main(const int argc, char **argv) {
   html_config.editable = true;
 
   {
-    std::string prefix = "one_file";
-    HtmlViews views = server.serve_file(decoded_file, prefix, html_config);
+    const std::string prefix = "file";
+    const HtmlViews views =
+        server.serve_file(decoded_file, prefix, html_config);
     ODR_INFO(*logger, "hosted decoded file with id: " << prefix);
     for (const auto &view : views) {
       ODR_INFO(*logger,
                "http://localhost:8080/file/" << prefix << "/" << view.path());
     }
   }
 
+  if (decoded_file.is_document_file() || decoded_file.is_archive_file()) {
+    std::optional<Filesystem> filesystem;
+    if (decoded_file.is_document_file()) {
+      filesystem = decoded_file.as_document_file().document().as_filesystem();
+    } else if (decoded_file.is_archive_file()) {
+      filesystem = decoded_file.as_archive_file().archive().as_filesystem();
+    }
+
+    const std::string prefix = "filesystem";
+    const HtmlService filesystem_service = html::translate(
+        filesystem.value(), server_config.cache_path + "/" + prefix,
+        html_config, logger);
+    server.connect_service(filesystem_service, prefix);
+    ODR_INFO(*logger, "hosted filesystem with id: " << prefix);
+    for (const auto &view : filesystem_service.list_views()) {
+      ODR_INFO(*logger,
+               "http://localhost:8080/file/" << prefix << "/" << view.path());
+    }
+  }
+
   server.listen("localhost", 8080);
 
   return 0;

cli/src/translate.cpp

@@ -3,12 +3,14 @@
 #include <odr/html.hpp>
 
 #include <filesystem>
-#include <iostream>
 #include <string>
 
 using namespace odr;
 
 int main(const int argc, char **argv) {
+  const std::shared_ptr logger =
+      Logger::create_stdio("odr-translate", LogLevel::verbose);
+
   const std::string input{argv[1]};
   const std::string output{argv[2]};
 
@@ -20,14 +22,14 @@ int main(const int argc, char **argv) {
   DecodedFile decoded_file{input};
 
   if (decoded_file.password_encrypted() && !password) {
-    std::cerr << "document encrypted but no password given" << std::endl;
+    ODR_FATAL(*logger, "document encrypted but no password given");
     return 2;
   }
   if (decoded_file.password_encrypted()) {
     try {
       decoded_file = decoded_file.decrypt(*password);
     } catch (const WrongPasswordError &) {
-      std::cerr << "wrong password" << std::endl;
+      ODR_FATAL(*logger, "wrong password");
       return 1;
     }
   }

src/odr/definitions.hpp

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <cstdint>
+
+namespace odr {
+
+using ElementIdentifier = std::uint64_t;
+
+static constexpr ElementIdentifier null_element_id{0};
+
+} // namespace odr

src/odr/document.cpp

@@ -39,7 +39,7 @@ DocumentType Document::document_type() const noexcept {
 }
 
 Element Document::root_element() const {
-  return {m_impl.get(), m_impl->root_element()};
+  return {m_impl->element_adapter(), m_impl->root_element()};
 }
 
 Filesystem Document::as_filesystem() const {