truecalc-core 0.5.0

Spreadsheet formula engine — parser and evaluator for Excel-compatible formulas
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use super::{FunctionMeta, Registry};

pub mod address;
pub mod array_utils;
pub mod cell_ref;
pub mod choose;
pub mod index_match;
pub mod indirect;
pub mod lookup_fn;
pub mod misc;
pub mod row_col;
pub mod vlookup;

#[cfg(test)]
mod tests;

pub fn register_lookup(registry: &mut Registry) {
    registry.register_eager(
        "ADDRESS",
        address::address_fn,
        FunctionMeta {
            category: "lookup",
            signature: "ADDRESS(row, col, [abs_mode], [a1], [sheet_text])",
            description: "Returns a cell address string",
        },
    );
    registry.register_lazy(
        "CHOOSE",
        choose::choose_fn,
        FunctionMeta {
            category: "lookup",
            signature: "CHOOSE(index, value1, value2, ...)",
            description: "Returns the value at the given 1-based index",
        },
    );
    registry.register_lazy(
        "ROW",
        row_col::row_fn,
        FunctionMeta {
            category: "lookup",
            signature: "ROW([cell_ref])",
            description: "Returns the row number of a cell reference",
        },
    );
    registry.register_lazy(
        "COLUMN",
        row_col::column_fn,
        FunctionMeta {
            category: "lookup",
            signature: "COLUMN([cell_ref])",
            description: "Returns the column number of a cell reference",
        },
    );
    registry.register_eager(
        "VLOOKUP",
        vlookup::vlookup_fn,
        FunctionMeta {
            category: "lookup",
            signature: "VLOOKUP(search_key, range, index, [is_sorted])",
            description: "Searches first column of range, returns value from index column",
        },
    );
    registry.register_eager(
        "HLOOKUP",
        vlookup::hlookup_fn,
        FunctionMeta {
            category: "lookup",
            signature: "HLOOKUP(search_key, range, index, [is_sorted])",
            description: "Searches first row of range, returns value from index row",
        },
    );
    registry.register_eager(
        "MATCH",
        index_match::match_fn,
        FunctionMeta {
            category: "lookup",
            signature: "MATCH(search_key, range, [match_type])",
            description: "Returns 1-based position of first match",
        },
    );
    registry.register_eager(
        "LOOKUP",
        lookup_fn::lookup_fn,
        FunctionMeta {
            category: "lookup",
            signature: "LOOKUP(search_key, search_range, [result_range])",
            description: "Approximate lookup in sorted range",
        },
    );
    registry.register_eager(
        "XLOOKUP",
        lookup_fn::xlookup_fn,
        FunctionMeta {
            category: "lookup",
            signature: "XLOOKUP(search_key, lookup_array, return_array, [if_not_found], [match_mode], [search_mode])",
            description: "Modern lookup function with fallback and match options",
        },
    );
    registry.register_eager(
        "XMATCH",
        lookup_fn::xmatch_fn,
        FunctionMeta {
            category: "lookup",
            signature: "XMATCH(search_key, lookup_array, [match_mode], [search_mode])",
            description: "Modern MATCH function with match and search mode options",
        },
    );
    registry.register_lazy(
        "SHEET",
        misc::sheet_fn,
        FunctionMeta {
            category: "lookup",
            signature: "SHEET([name])",
            description: "Returns the sheet number of the current or named sheet",
        },
    );
}