summaryrefslogtreecommitdiffstats
path: root/include/ixion/document.hpp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:47:37 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:47:37 +0000
commit00e2eb4fd0266c5be01e3a527a66aaad5ab4b634 (patch)
treea6a58bd544eb0b76b9d3acc678ea88791acca045 /include/ixion/document.hpp
parentInitial commit. (diff)
downloadlibixion-00e2eb4fd0266c5be01e3a527a66aaad5ab4b634.tar.xz
libixion-00e2eb4fd0266c5be01e3a527a66aaad5ab4b634.zip
Adding upstream version 0.19.0.upstream/0.19.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'include/ixion/document.hpp')
-rw-r--r--include/ixion/document.hpp94
1 files changed, 94 insertions, 0 deletions
diff --git a/include/ixion/document.hpp b/include/ixion/document.hpp
new file mode 100644
index 0000000..a612898
--- /dev/null
+++ b/include/ixion/document.hpp
@@ -0,0 +1,94 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#ifndef INCLUDED_IXION_DOCUMENT_HPP
+#define INCLUDED_IXION_DOCUMENT_HPP
+
+#include "types.hpp"
+#include "address.hpp"
+
+#include <memory>
+#include <string>
+#include <variant>
+
+namespace ixion {
+
+class cell_access;
+
+/**
+ * Higher level document representation designed to handle both cell value
+ * storage as well as formula cell calculations.
+ */
+class IXION_DLLPUBLIC document
+{
+ struct impl;
+ std::unique_ptr<impl> mp_impl;
+public:
+ document();
+
+ /**
+ * Constructor with custom cell address type.
+ *
+ * @param cell_address_type cell address type to use for cell addresses
+ * represented by string values.
+ */
+ document(formula_name_resolver_t cell_address_type);
+ ~document();
+
+ struct IXION_DLLPUBLIC cell_pos
+ {
+ enum class cp_type { string, address };
+ cp_type type;
+
+ std::variant<std::string_view, ixion::abs_address_t> value;
+
+ cell_pos(const char* p);
+ cell_pos(const char* p, size_t n);
+ cell_pos(const std::string& s);
+ cell_pos(const abs_address_t& addr);
+ };
+
+ void append_sheet(std::string name);
+
+ /**
+ * Set a new name to an existing sheet.
+ *
+ * @param sheet 0-based sheet index.
+ * @param name New name of a sheet.
+ */
+ void set_sheet_name(sheet_t sheet, std::string name);
+
+ cell_access get_cell_access(cell_pos pos) const;
+
+ void set_numeric_cell(cell_pos pos, double val);
+
+ void set_string_cell(cell_pos pos, std::string_view s);
+
+ void set_boolean_cell(cell_pos pos, bool val);
+
+ void empty_cell(cell_pos pos);
+
+ double get_numeric_value(cell_pos pos) const;
+
+ std::string_view get_string_value(cell_pos pos) const;
+
+ void set_formula_cell(cell_pos pos, std::string_view formula);
+
+ /**
+ * Calculate all the "dirty" formula cells in the document.
+ *
+ * @param thread_count number of threads to use to perform calculation.
+ * When 0 is specified, it only uses the main thread.
+ */
+ void calculate(size_t thread_count);
+};
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */