Model Context

class ixion::model_context

This class stores all data relevant to current session. You can think of this like a document model for each formula calculation run. Note that only those methods called from the formula interpreter are specified in the interface; this explains why accessors for the most part only have the ‘get’ method not paired with its ‘set’ counterpart.

Inherits from ixion::iface::formula_model_access

Public Types

typedef std::vector<shared_tokens> shared_tokens_type

Public Functions

model_context()
virtual ~model_context()
virtual const config &get_config() const
virtual cell_listener_tracker &get_cell_listener_tracker()
virtual bool is_empty(const abs_address_t &addr) const
virtual celltype_t get_celltype(const abs_address_t &addr) const
virtual double get_numeric_value(const abs_address_t &addr) const

Get a numeric representation of the cell value at specified position. If the cell at the specified position is a formula cell and its result has not yet been computed, it will block until the result becomes available. Call this only during formula (re-)calculation.

Return
numeric representation of the cell value.
Parameters
  • addr: position of the cell.

virtual string_id_t get_string_identifier(const abs_address_t &addr) const
virtual string_id_t get_string_identifier(const char *p, size_t n) const
virtual const formula_cell *get_formula_cell(const abs_address_t &addr) const
virtual formula_cell *get_formula_cell(const abs_address_t &addr)
virtual const formula_cell *get_named_expression(const std::string &name) const
virtual const std::string *get_named_expression_name(const formula_cell *expr) const
virtual double count_range(const abs_range_t &range, const values_t &values_type) const
virtual matrix get_range_value(const abs_range_t &range) const

Obtain range value in matrix form. Multi-sheet ranges are not supported. If the specified range consists of multiple sheets, it throws an exception.

Return
range value represented as matrix.
Parameters
  • range: absolute, single-sheet range address. Multi-sheet ranges are not allowed.

virtual std::unique_ptr<iface::session_handler> create_session_handler()

Session handler instance receives various events from the formula interpretation run, in order to respond to those events. This is optional; the model context implementation is not required to provide a handler.

Return
a new session handler instance. It may be nullptr.

virtual iface::table_handler *get_table_handler()

Table interface provides access to all table ranges stored in the document model. A table is a 2-dimensional range of cells that include named columns. It is used when resolving a table reference that refers to a cell or a range of cells by the table name and/or column name.

Return
non-NULL pointer to the table storage inside the model, or NULL if no table is present or supported by the model implementation.

virtual const iface::table_handler *get_table_handler() const
virtual const formula_tokens_t *get_formula_tokens(sheet_t sheet, size_t identifier) const
virtual const formula_tokens_t *get_shared_formula_tokens(sheet_t sheet, size_t identifier) const
virtual abs_range_t get_shared_formula_range(sheet_t sheet, size_t identifier) const
virtual string_id_t append_string(const char *p, size_t n)
virtual string_id_t add_string(const char *p, size_t n)
virtual const std::string *get_string(string_id_t identifier) const
virtual sheet_t get_sheet_index(const char *p, size_t n) const

Get the index of sheet from sheet name.

Return
sheet index
Parameters
  • p: pointer to the first character of the sheet name string.
  • n: length of the sheet name string.

virtual std::string get_sheet_name(sheet_t sheet) const
double get_numeric_value_nowait(const abs_address_t &addr) const
string_id_t get_string_identifier_nowait(const abs_address_t &addr) const
size_t add_formula_tokens(sheet_t sheet, formula_tokens_t *p)
void set_shared_formula_range(sheet_t sheet, size_t identifier, const abs_range_t &range)
size_t set_formula_tokens_shared(sheet_t sheet, size_t identifier)
void remove_formula_tokens(sheet_t sheet, size_t identifier)
void set_shared_formula(const abs_address_t &addr, size_t si, const char *p_formula, size_t n_formula, const char *p_range, size_t n_range, const formula_name_resolver &resolver)
void set_shared_formula(const abs_address_t &addr, size_t si, const char *p_formula, size_t n_formula, const formula_name_resolver &resolver)
void erase_cell(const abs_address_t &addr)
void set_numeric_cell(const abs_address_t &addr, double val)
void set_boolean_cell(const abs_address_t &adr, bool val)
void set_string_cell(const abs_address_t &addr, const char *p, size_t n)
void set_string_cell(const abs_address_t &addr, string_id_t identifier)
void set_formula_cell(const abs_address_t &addr, const char *p, size_t n, const formula_name_resolver &resolver)
void set_formula_cell(const abs_address_t &addr, size_t identifier, bool shared)
abs_range_t get_data_range(sheet_t sheet) const
void set_named_expression(const char *p, size_t n, formula_cell *cell)
formula_cell *get_named_expression(const std::string &name)
sheet_t append_sheet(const char *p, size_t n, row_t row_size, col_t col_size)

Append a new sheet to the model. The caller must ensure that the name of the new sheet is unique within the model context. When the name being used for the new sheet already exists, it throws a model_context_error exception.

Return
sheet index of the inserted sheet.
Parameters
  • p: pointer to the char array storing the name of the inserted sheet.
  • n: size of the sheet name char array.
  • row_size: number of rows in the inserted sheet.
  • col_size: number of columns in the inserted sheet.

void set_session_handler_factory(std::unique_ptr<session_handler_factory> &&factory)
void set_table_handler(iface::table_handler *handler)
size_t get_string_count() const
void dump_strings() const
const column_store_t *get_column(sheet_t sheet, col_t col) const

Get column storage.

Return
const pointer to column storage, or NULL in case sheet index or column index is out of bound.
Parameters
  • sheet: sheet index.
  • col: column index.

const column_stores_t *get_columns(sheet_t sheet) const

Get an array of column stores for the entire sheet.

Return
const pointer to an array of column stores, or nullptr in case the sheet index is out of bound.
Parameters
  • sheet: sheet index.

dirty_formula_cells_t get_all_formula_cells() const
class session_handler_factory

Public Functions

virtual std::unique_ptr<iface::session_handler> create()
struct shared_tokens

Public Functions

shared_tokens()
shared_tokens(formula_tokens_t *tokens)
shared_tokens(const shared_tokens &r)
bool operator==(const shared_tokens &r) const

Public Members

formula_tokens_t *tokens
abs_range_t range