1 files changed, 129 insertions, 0 deletions
diff --git a/include/ixion/formula_name_resolver.hpp b/include/ixion/formula_name_resolver.hpp
new file mode 100644
index 0000000..eb2a8a9
--- /dev/null
+++ b/include/ixion/formula_name_resolver.hpp
@@ -0,0 +1,129 @@
+/* -*- 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_FORMULA_NAME_RESOLVER_HPP
+#define INCLUDED_IXION_FORMULA_NAME_RESOLVER_HPP
+
+#include "address.hpp"
+#include "formula_function_opcode.hpp"
+
+#include <string>
+#include <memory>
+#include <variant>
+
+namespace ixion {
+
+class model_context;
+struct table_t;
+
+/**
+ * Structure that represents the type of a 'name' in a formula expression.
+ *
+ * A name can be either one of:
+ * <ul>
+ * <li>cell reference</li>
+ * <li>range reference</li>
+ * <li>table reference</li>
+ * <li>named expression</li>
+ * <li>function</li>
+ * </ul>
+ */
+struct IXION_DLLPUBLIC formula_name_t
+{
+    enum name_type
+    {
+        invalid = 0,
+        cell_reference,
+        range_reference,
+        table_reference,
+        named_expression,
+        function
+    };
+
+    /**
+     * Table information for a table reference name.  Unlike the ixion::table_t
+     * counterpart, we store strings as string views as the resolver doesn't
+     * have access to the string pool.
+     */
+    struct table_type
+    {
+        std::string_view name;
+        std::string_view column_first;
+        std::string_view column_last;
+        table_areas_t areas;
+    };
+
+    using value_type = std::variant<address_t, range_t, table_type, formula_function_t>;
+
+    name_type type;
+    value_type value;
+
+    formula_name_t();
+
+    /**
+     * Return a string that represents the data stored internally.  Useful for
+     * debugging.
+     */
+    std::string to_string() const;
+};
+
+/**
+ * Formula name resolvers resolves a name in a formula expression to a more
+ * concrete name type.
+ */
+class formula_name_resolver
+{
+public:
+    formula_name_resolver();
+    virtual ~formula_name_resolver() = 0;
+
+    /**
+     * Parse and resolve a reference string.
+     *
+     * @param s reference string to be parsed.
+     * @param pos base cell position, which influences the resolved reference
+     *            position(s) containing relative address(es).  When the
+     *            reference string does not contain an explicit sheet name,
+     *            the sheet address of the base cell position is used.
+     *
+     * @return result of the resovled reference.
+     */
+    virtual formula_name_t resolve(std::string_view s, const abs_address_t& pos) const = 0;
+    virtual std::string get_name(const address_t& addr, const abs_address_t& pos, bool sheet_name) const = 0;
+    virtual std::string get_name(const range_t& range, const abs_address_t& pos, bool sheet_name) const = 0;
+    virtual std::string get_name(const table_t& table) const = 0;
+
+    /**
+     * Given a numerical representation of column position, return its
+     * textural representation.
+     *
+     * @param col numerical column position.
+     *
+     * @return textural representation of column position.
+     */
+    virtual std::string get_column_name(col_t col) const = 0;
+
+    /**
+     * Create a formula name resolver instance according to the requested
+     * type.
+     *
+     * @param type type formula name resolver being requested.
+     * @param cxt document model context for resolving sheet names, or nullptr
+     *            in case names being resolved don't contain sheet names.
+     *
+     * @return formula name resolver instance created on the heap.  The caller
+     *         is responsible for managing its life cycle.
+     */
+    IXION_DLLPUBLIC static std::unique_ptr<formula_name_resolver>
+        get(formula_name_resolver_t type, const model_context* cxt);
+};
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */