1 files changed, 132 insertions, 0 deletions
diff --git a/include/ixion/cell.hpp b/include/ixion/cell.hpp
new file mode 100644
index 0000000..59f09bb
--- /dev/null
+++ b/include/ixion/cell.hpp
@@ -0,0 +1,132 @@
+/* -*- 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_CELL_HPP
+#define INCLUDED_IXION_CELL_HPP
+
+#include "types.hpp"
+#include "formula_tokens_fwd.hpp"
+
+#include <memory>
+#include <vector>
+#include <string>
+
+namespace ixion {
+
+class formula_result;
+class formula_cell;
+class model_context;
+struct abs_address_t;
+struct rc_address_t;
+
+// calc_status is internal.
+struct calc_status;
+using calc_status_ptr_t = boost::intrusive_ptr<calc_status>;
+
+class IXION_DLLPUBLIC formula_cell
+{
+    struct impl;
+    std::unique_ptr<impl> mp_impl;
+
+public:
+    formula_cell(const formula_cell&) = delete;
+    formula_cell& operator= (formula_cell) = delete;
+
+    formula_cell();
+    formula_cell(const formula_tokens_store_ptr_t& tokens);
+
+    formula_cell(
+        row_t group_row, col_t group_col,
+        const calc_status_ptr_t& cs,
+        const formula_tokens_store_ptr_t& tokens);
+
+    ~formula_cell();
+
+    const formula_tokens_store_ptr_t& get_tokens() const;
+    void set_tokens(const formula_tokens_store_ptr_t& tokens);
+
+    double get_value(formula_result_wait_policy_t policy) const;
+    std::string_view get_string(formula_result_wait_policy_t policy) const;
+
+    void interpret(model_context& context, const abs_address_t& pos);
+
+    /**
+     * Determine if this cell contains circular reference by walking through
+     * all its reference tokens.
+     */
+    void check_circular(const model_context& cxt, const abs_address_t& pos);
+
+    /**
+     * Reset cell's internal state.
+     */
+    void reset();
+
+    /**
+     * Get a series of all reference tokens included in the formula
+     * expression stored in this cell.
+     *
+     * @param cxt model context instance.
+     * @param pos position of the cell.
+     *
+     * @return an array of reference formula tokens.  Each element is a
+     *         pointer to the actual token instance stored in the cell object.
+     *         Be aware that the pointer is valid only as long as the actual
+     *         token instance is alive.
+     */
+    std::vector<const formula_token*> get_ref_tokens(
+        const model_context& cxt, const abs_address_t& pos) const;
+
+    /**
+     * Get the cached result without post-processing in case of a grouped
+     * formula cell.
+     *
+     * @param policy action to take in case the result is not yet available.
+     *
+     * @return formula result.
+     */
+    const formula_result& get_raw_result_cache(formula_result_wait_policy_t policy) const;
+
+    /**
+     * Get the cached result as a single cell.  For a non-grouped formula
+     * cell, it should be identical to the value from the get_raw_result_cache()
+     * call.  For a grouped formula cell, you'll get a single value assigned to
+     * the position of the cell in case the original result is a matrix value.
+     *
+     * @param policy action to take in case the result is not yet available.
+     *
+     * @return formula result.
+     */
+    formula_result get_result_cache(formula_result_wait_policy_t policy) const;
+
+    /**
+     * Set a cached result to this formula cell instance.
+     *
+     *
+     * @param result cached result.
+     */
+    void set_result_cache(formula_result result);
+
+    formula_group_t get_group_properties() const;
+
+    /**
+     * Get the absolute parent position of a grouped formula cell.  If the
+     * cell is not grouped, it simply returns the original position passed to
+     * this method.
+     *
+     * @param pos original position from which to calculate the parent
+     *            position.
+     *
+     * @return parent position of the grouped formula cell.
+     */
+    abs_address_t get_parent_position(const abs_address_t& pos) const;
+};
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */