diff options
Diffstat (limited to '')
| -rw-r--r-- | include/ixion/formula_tokens.hpp | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/include/ixion/formula_tokens.hpp b/include/ixion/formula_tokens.hpp new file mode 100644 index 0000000..d843dbd --- /dev/null +++ b/include/ixion/formula_tokens.hpp @@ -0,0 +1,215 @@ +/* -*- 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_FORMULA_TOKENS_HPP +#define INCLUDED_FORMULA_TOKENS_HPP + +#include "address.hpp" +#include "table.hpp" +#include "formula_opcode.hpp" +#include "formula_function_opcode.hpp" +#include "formula_tokens_fwd.hpp" + +#include <string> +#include <variant> + +namespace ixion { + +/** + * Get a printable name for a formula opcode. The printable name is to be + * used only for informational purposes. + * + * @param oc formula opcode + * + * @return printable name for a formula opcode. + */ +IXION_DLLPUBLIC std::string_view get_opcode_name(fopcode_t oc); + +/** + * Get the string representation of a simple formula opcode. This function + * will return a non-empty string only for operator opcodes. + * + * @param oc formula opcode + * + * @return string representation of a formula opcode. + */ +IXION_DLLPUBLIC std::string_view get_formula_opcode_string(fopcode_t oc); + +/** + * Represents a single formula token. + */ +struct IXION_DLLPUBLIC formula_token final +{ + using value_type = std::variant< + address_t, range_t, table_t, formula_function_t, + double, string_id_t, std::string>; + + /** + * Opcode that specifies the type of token. The value of this data member + * should <i>not</i> be modified after construction. + */ + const fopcode_t opcode; + + /** + * Value stored in the token. The type of this value varies depending on the + * token opcode value. + */ + value_type value; + + formula_token() = delete; + + /** + * Constructor for opcode-only token. + * + * @param op formula opcode. + */ + formula_token(fopcode_t op); + + /** + * Constructor for a single-cell reference token. The opcode will be + * implicitly set to fop_single_ref. + * + * @param addr single-cell reference. + */ + formula_token(const address_t& addr); + + /** + * Constructor for a range reference token. The opcode will be + * implicitly set to fop_range_ref. + * + * @param range range reference. + */ + formula_token(const range_t& range); + + /** + * Constructor for a table reference token. The opcode will be implicitly + * set to fop_table_ref. + * + * @param table table reference. + */ + formula_token(const table_t& table); + + /** + * Constructor for a formula function token. The opcode will be implicitly + * set to fop_function. + * + * @param func function name enum value. + */ + formula_token(formula_function_t func); + + /** + * Constructor for a numeric value token. The opcode will be implicitly set + * to fop_value. + * + * @param v numeric value to be stored in the token. + */ + formula_token(double v); + + /** + * Constructor for a string value token. The opcode will be implicitly + * set to fop_string. + * + * @param sid string ID to be stored in the token. + */ + formula_token(string_id_t sid); + + /** + * Constructor for a named-expression token. The opcode will be implicitly + * set to fop_named_expression. + * + * @param name named expression to be stored in the token. + */ + formula_token(std::string name); + + /** + * Copy constructor. + */ + formula_token(const formula_token& r); + + /** + * Move constructor. + * + * @note This will be the same as the copy constructor if the stored value + * is not movable. + */ + formula_token(formula_token&& r); + + ~formula_token(); + + bool operator== (const formula_token& r) const; + bool operator!= (const formula_token& r) const; +}; + +/** + * Storage for a series of formula tokens. + */ +class IXION_DLLPUBLIC formula_tokens_store +{ + friend void intrusive_ptr_add_ref(formula_tokens_store*); + friend void intrusive_ptr_release(formula_tokens_store*); + + struct impl; + std::unique_ptr<impl> mp_impl; + + void add_ref(); + void release_ref(); + + formula_tokens_store(); + +public: + + static formula_tokens_store_ptr_t create(); + + ~formula_tokens_store(); + + formula_tokens_store(const formula_tokens_store&) = delete; + formula_tokens_store& operator= (const formula_tokens_store&) = delete; + + size_t get_reference_count() const; + + formula_tokens_t& get(); + const formula_tokens_t& get() const; +}; + +inline void intrusive_ptr_add_ref(formula_tokens_store* p) +{ + p->add_ref(); +} + +inline void intrusive_ptr_release(formula_tokens_store* p) +{ + p->release_ref(); +} + +/** + * Represents a named expression which stores a series of formula tokens. + */ +struct IXION_DLLPUBLIC named_expression_t +{ + /** + * Origin cell position which affects any relative references stored in + * the named expression. + */ + abs_address_t origin; + + /** Formula tokens. */ + formula_tokens_t tokens; + + named_expression_t(); + named_expression_t(const abs_address_t& _origin, formula_tokens_t _tokens); + named_expression_t(const named_expression_t&) = delete; + named_expression_t(named_expression_t&& other); + ~named_expression_t(); +}; + +IXION_DLLPUBLIC std::ostream& operator<< (std::ostream& os, const formula_token& ft); + +} + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |