1 files changed, 83 insertions, 0 deletions
diff --git a/src/python/document.hpp b/src/python/document.hpp
new file mode 100644
index 0000000..b52c9b8
--- /dev/null
+++ b/src/python/document.hpp
@@ -0,0 +1,83 @@
+/* -*- 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_ORCUS_PYTHON_DOCUMENT_HPP
+#define INCLUDED_ORCUS_PYTHON_DOCUMENT_HPP
+
+#include "orcus/spreadsheet/document.hpp"
+
+#include "memory.hpp"
+
+namespace orcus { namespace python {
+
+/** non-python part of the document object. */
+struct document_data
+{
+    std::unique_ptr<spreadsheet::document> m_doc;
+
+    ~document_data();
+};
+
+document_data* get_document_data(PyObject* self);
+
+struct stream_with_formulas
+{
+    py_unique_ptr stream;
+    bool recalc_formula_cells = false;
+    spreadsheet::formula_error_policy_t error_policy = spreadsheet::formula_error_policy_t::fail;
+};
+
+/**
+ * Extract a python object representing the byte stream from the arguments
+ * passed to the python orcus.<file format>.read() function, as well as
+ * several parameters related to formula calculation settings.
+ *
+ * This function handles the following python arguments: stream, recalc, and
+ * error_policy.
+ *
+ * @param args positional argument object.
+ * @param kwargs keyword argument object.
+ *
+ * @return object representing the bytes as well as formula calculation
+ *         settings.
+ */
+stream_with_formulas read_stream_and_formula_params_from_args(PyObject* args, PyObject* kwargs);
+
+/**
+ * This one is similar to the function above, except that it only handles
+ * one argument called 'stream'.
+ *
+ * @return object representing the bytes.
+ */
+py_unique_ptr read_stream_from_args(PyObject* args, PyObject* kwargs);
+
+/**
+ * Import a document from a python object containing the byte stream, and
+ * create a python object of class orcus.Document.
+ *
+ * @param obj_bytes python object containing the byte stream.
+ * @param app filter instance to use to load the document.
+ * @param doc orcus document instance which will be stored within the python
+ *            document object.
+ *
+ * @return python document object.
+ */
+PyObject* import_from_stream_into_document(
+    PyObject* obj_bytes, iface::import_filter& app, std::unique_ptr<spreadsheet::document>&& doc);
+
+PyObject* create_document(std::unique_ptr<spreadsheet::document>&& doc);
+
+/**
+ * Get the definition of the python class Document.
+ */
+PyTypeObject* get_document_type();
+
+}}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */