Types¶
Macros¶
-
IXION_ASCII(literal)¶
Use this macro with a literal string and it returns the literal string followed by its length.
Primitive Types¶
-
enum ixion::celltype_t¶
This type represents a raw cell type as stored in ixion::model_context.
Values:
-
enumerator unknown¶
unknown cell type.
-
enumerator string¶
cell contains a raw string value.
-
enumerator numeric¶
cell contains a raw numeric value.
-
enumerator formula¶
cell contains a formula object.
-
enumerator boolean¶
cell contains a raw boolean value.
-
enumerator empty¶
cell is empty and contains absolutely nothing.
-
enumerator unknown¶
-
enum ixion::cell_value_t¶
Similar to celltype_t, except that it does not include a formula type. Instead it uses the formula result type to classify its type. The error type refers to an error value in formula cell.
Values:
-
enumerator unknown¶
unknown cell value type.
-
enumerator string¶
either the cell contains a raw string value, or a calculated formula cell whose result is of string type.
-
enumerator numeric¶
either the cell contains a raw numeric value, or a calculated formula cell whose result is of numeric type.
-
enumerator error¶
this type corresponds with a formula cell whose result contains an error.
-
enumerator boolean¶
either the cell contains a raw boolean value type, or a calculated formula cell whose result is of boolean type.
-
enumerator empty¶
the cell is empty and contains nothing whatsoever.
-
enumerator unknown¶
-
enum ixion::value_t¶
Values:
-
enumerator value_none¶
-
enumerator value_string¶
-
enumerator value_numeric¶
-
enumerator value_boolean¶
-
enumerator value_empty¶
-
enumerator value_none¶
-
enum ixion::table_area_t¶
Value that specifies the area inside a table.
Values:
-
enumerator table_area_none¶
-
enumerator table_area_data¶
-
enumerator table_area_headers¶
-
enumerator table_area_totals¶
-
enumerator table_area_all¶
-
enumerator table_area_none¶
-
enum ixion::formula_name_resolver_t¶
Formula name resolver type specifies how name tokens are resolved.
Values:
-
enumerator unknown¶
Unknown syntax.
-
enumerator excel_a1¶
Default A1 syntax used in Excel
-
enumerator excel_r1c1¶
R1C1 syntax available in Excel
-
enumerator calc_a1¶
Default A1 syntax used in Calc
-
enumerator odff¶
OpenFormula syntax
-
enumerator odf_cra¶
ODF cell-range-address syntax
-
enumerator unknown¶
-
enum ixion::formula_error_t¶
Formula error types. Note that only the official (i.e. non-internal) error types have their corresponding error strings. Use the get_formula_error_name() function to convert an enum member value of this type to its string representation.
Values:
-
enumerator no_error¶
-
enumerator ref_result_not_available¶
-
enumerator division_by_zero¶
-
enumerator invalid_expression¶
-
enumerator name_not_found¶
-
enumerator no_range_intersection¶
-
enumerator invalid_value_type¶
-
enumerator no_result_error¶
-
enumerator stack_error¶
-
enumerator general_error¶
-
enumerator no_error¶
-
enum ixion::rc_direction_t¶
Specifies iterator direction of a ixion::model_context.
Values:
-
enumerator horizontal¶
Flows left to right first then top to bottom.
-
enumerator vertical¶
Flows top to bottom first then left to right.
-
enumerator horizontal¶
-
using ixion::col_t = int32_t¶
Column index type.
-
using ixion::row_t = int32_t¶
Row index type.
-
using ixion::sheet_t = int32_t¶
Sheet index type.
-
using ixion::rc_t = row_t¶
Integer type that is large enough to store either a row or a column index.
-
using ixion::string_id_t = uint32_t¶
String ID type.
All string values are converted into integer tokens. You need to call the get_string() method of ixion::iface::formula_model_access to get the actual string value.
-
using ixion::table_areas_t = int32_t¶
type that stores a mixture of ixion::table_area_t values.
-
using ixion::formula_tokens_t = std::vector<std::unique_ptr<formula_token>>¶
-
const string_id_t ixion::empty_string_id¶
Global string ID representing an empty string.
-
const sheet_t ixion::global_scope¶
Special sheet ID that represents a global scope, as opposed to a sheet-local scope.
-
struct ixion::rc_size_t¶
This structure stores a 2-dimensional size information.
-
struct ixion::formula_group_t¶
This strcuture stores information about grouped formula cells. All formula cells belonging to the same group shares the same set of values.
Public Functions
-
formula_group_t()¶
-
formula_group_t(const formula_group_t &r)¶
-
~formula_group_t()¶
-
formula_group_t &operator=(const formula_group_t &other)¶
-
formula_group_t()¶
Address Types¶
-
struct ixion::address_t¶
Stores either absolute or relative address.
Public Functions
-
address_t()¶
-
address_t(sheet_t _sheet, row_t _row, col_t _column, bool _abs_sheet = true, bool _abs_row = true, bool _abs_column = true)¶
-
address_t(const abs_address_t &r)¶
-
bool valid() const¶
-
abs_address_t to_abs(const abs_address_t &origin) const¶
-
::std::string get_name() const¶
-
void set_absolute(bool abs)¶
-
struct hash¶
-
address_t()¶
-
struct ixion::rc_address_t¶
Stores either absolute or relative address, but unlike the address_t counterpart, this struct only stores row and column positions.
-
struct hash¶
Public Functions
-
size_t operator()(const rc_address_t &addr) const¶
-
size_t operator()(const rc_address_t &addr) const¶
-
struct hash¶
-
struct ixion::abs_address_t¶
Stores absolute address, and absolute address only.
Public Functions
-
abs_address_t()¶
-
abs_address_t(init_invalid)¶
-
abs_address_t(const abs_address_t &r)¶
-
bool valid() const¶
-
::std::string get_name() const¶
-
struct hash¶
Public Functions
-
size_t operator()(const abs_address_t &addr) const¶
-
size_t operator()(const abs_address_t &addr) const¶
-
abs_address_t()¶
-
struct ixion::abs_rc_address_t¶
-
Public Functions
-
abs_rc_address_t()¶
-
abs_rc_address_t(init_invalid)¶
-
abs_rc_address_t(const abs_rc_address_t &r)¶
-
abs_rc_address_t(const abs_address_t &r)¶
-
bool valid() const¶
-
struct hash¶
Public Functions
-
size_t operator()(const abs_rc_address_t &addr) const¶
-
size_t operator()(const abs_rc_address_t &addr) const¶
-
abs_rc_address_t()¶
-
struct ixion::range_t¶
Stores range whose component may be relative or absolute.
Public Functions
-
range_t()¶
-
range_t(const abs_range_t &r)¶
-
bool valid() const¶
-
void set_all_columns()¶
Expand the range horizontally to include all columns. The row range will remain unchanged.
-
void set_all_rows()¶
Expand the range vertically to include all rows. The column range will remain unchanged.
-
bool all_columns() const¶
- Returns
true if the range is unspecified in the horizontal direction i.e. all columns are selected, false otherwise.
-
bool all_rows() const¶
- Returns
true if the range is unspecified in the vertical direction i.e. all rows are selected, false otherwise.
-
abs_range_t to_abs(const abs_address_t &origin) const¶
-
void set_absolute(bool abs)¶
-
struct hash¶
-
range_t()¶
-
struct ixion::abs_range_t¶
Stores absolute range address.
Public Functions
-
abs_range_t()¶
-
abs_range_t(init_invalid)¶
-
abs_range_t(sheet_t _sheet, row_t _row, col_t _col, row_t _row_span, col_t _col_span)¶
- Parameters
_sheet – 0-based sheet index.
_row – 0-based row position of the top-left cell of the range.
_col – 0-based column position of the top-left cell of the range.
_row_span – row length of the range. It must be 1 or greater.
_col_span – column length of the range. It must be 1 or greater.
-
abs_range_t(const abs_address_t &addr)¶
-
abs_range_t(const abs_address_t &addr, row_t row_span, col_t col_span)¶
-
bool valid() const¶
-
void set_all_columns()¶
Expand the range horizontally to include all columns. The row range will remain unchanged.
-
void set_all_rows()¶
Expand the range vertically to include all rows. The column range will remain unchanged.
-
bool all_columns() const¶
- Returns
true if the range is unspecified in the horizontal direction i.e. all columns are selected, false otherwise.
-
bool all_rows() const¶
- Returns
true if the range is unspecified in the vertical direction i.e. all rows are selected, false otherwise.
-
bool contains(const abs_address_t &addr) const¶
Check whether or not a given address is contained within this range.
-
void reorder()¶
Reorder range values as needed to ensure the range is valid.
-
struct hash¶
Public Functions
-
size_t operator()(const abs_range_t &range) const¶
-
size_t operator()(const abs_range_t &range) const¶
-
abs_range_t()¶
-
struct ixion::abs_rc_range_t¶
-
Public Functions
-
abs_rc_range_t()¶
-
abs_rc_range_t(init_invalid)¶
-
abs_rc_range_t(const abs_rc_range_t &other)¶
-
abs_rc_range_t(const abs_range_t &other)¶
-
bool valid() const¶
-
void set_all_columns()¶
Expand the range horizontally to include all columns. The row range will remain unchanged.
-
void set_all_rows()¶
Expand the range vertically to include all rows. The column range will remain unchanged.
-
bool all_columns() const¶
- Returns
true if the range is unspecified in the horizontal direction i.e. all columns are selected, false otherwise.
-
bool all_rows() const¶
- Returns
true if the range is unspecified in the vertical direction i.e. all rows are selected, false otherwise.
-
bool contains(const abs_rc_address_t &addr) const¶
Check whether or not a given address is contained within this range.
-
struct hash¶
Public Functions
-
size_t operator()(const abs_rc_range_t &range) const¶
-
size_t operator()(const abs_rc_range_t &range) const¶
-
abs_rc_range_t()¶
-
using ixion::abs_address_set_t = std::unordered_set<abs_address_t, abs_address_t::hash>¶
Type that represents a collection of multiple absolute cell addresses.
-
using ixion::abs_range_set_t = std::unordered_set<abs_range_t, abs_range_t::hash>¶
-
using ixion::abs_rc_range_set_t = std::unordered_set<abs_rc_range_t, abs_rc_range_t::hash>¶
Utility Functions¶
-
std::string_view ixion::get_formula_error_name(formula_error_t fe)¶
Get a string representation of a formula error type.
- Parameters
fe – enum value representing a formula error type.
- Returns
null-terminated string representation of the formula error type.