Compare commits

..

14 Commits

Author SHA1 Message Date
Nicolás Hatcher
c99aea7b3d UPDATE: Webapp 2024-10-06 16:06:56 +02:00
Nicolás Hatcher
ac0567e897 FIX: Initial browse mode within sheets 2024-09-28 15:26:55 +02:00
Nicolás Hatcher
fde1e13ffb FIX: Minimal implementation of browse mode 2024-09-28 13:55:52 +02:00
Nicolás Hatcher
90cf5f74f7 FIX: Do not loose focus when clicking on the formula we are editing 2024-09-27 19:25:26 +02:00
Nicolás Hatcher
f53b39b220 UPDATE: Adds cell and formula editing 2024-09-26 19:08:16 +02:00
Nicolás Hatcher Andrés
bf9a1ed9f4 FIX: Add infrastructure for python tests (#91)
Also integrated with CI and runs tests in documentation
2024-09-21 15:46:32 +02:00
Nicolás Hatcher Andrés
11df4a55c7 UPDATE: Adds python bindings (#90)
* UPDATE: Adds python bindings

Exclude pyroncalc and wasm from test coverage
2024-09-21 11:58:50 +02:00
Nicolás Hatcher Andrés
00b5b65588 UPDATE: bump version to 0.2.0 (#89) 2024-09-17 00:27:06 +02:00
Varun Hegde
2b03b3e3b9 Error Handling of public Set functions (#88)
What are we trying to achieve ?

++ Currently all the major public set functions is panic prone and does not handle and return error. This PR tries to address to all those functions.

What major errors that could happen in these functions ?

++ All the functions which are being made as error safe is being tested against invalid sheet, row and column values, which could given by user

What are the list of functions whose return type has been altered ?

**base/src/model.rs**
1. update_cell_with_text
2. update_cell_with_bool
3. update_cell_with_number
4. set_user_input
5. get_cell_style_index
6. get_style_for_cell
7. set_cell_with_string

++> New functions being added

1. set_cell_with_boolean
2. set_cell_with_number

**base/src/styles.rs**

1. get_style_with_quote_prefix
3. get_style_with_format
4. get_style_without_quote_prefix
5. get_style

**base/src/worksheet.rs**

1. update_cell
2. set_cell_style
3. set_cell_with_formula
4. set_cell_with_number
6. set_cell_with_string
8. set_cell_with_boolean
9. set_cell_with_error
10. cell_clear_contents
11. cell_clear_contents_with_style

++> Above is the comprehensive list of all functions being ( most are public, some are private ) altered for better error handling. As a side effect of changing function signature, there are many changes being done to other functions ( mostly adding "?" to enable to error propagation further )
2024-09-14 17:37:31 +02:00
Nicolás Hatcher Andrés
83a4431417 FIX[WebApp]: Simplify loading logic of workbook (#87)
Note that previously the model would have been fetched twice
2024-08-24 06:59:19 +02:00
Nicolás Hatcher Andrés
40aa8bebaf UPDATE: Adds load_from_xlsx_bytes (#86)
This is usefull if we are transfering bytes, for instance over the internet
2024-08-24 06:50:31 +02:00
Nicolás Hatcher Andrés
b9bf485379 Update README.md (#80)
We don't need a logo anymore
2024-08-18 12:50:34 +02:00
Nicolás Hatcher Andrés
dc23a7f29c UPDATE: Adds web app (#79)
Things missing:

* Browse mode
* Front end tests
* Storybook
2024-08-18 11:44:16 +02:00
Varun Hegde
083548608e Exporting the Merged Cell : Exports the merged cell properly with testcase to verify the scenario (#76)
* adding the functionality of exporting the merged cell with testcase to vreify the above enhancement

* addressing review comments : 1) moving the testing to appropriate folder 2) fixing lint errors 3) fixing the scenario when merge cell count is 0

* addressing 2nd round review comments : cosmetic fixes

* addressing review comments : taking reference instead of cloning
2024-07-21 16:13:58 +02:00
129 changed files with 7211 additions and 16539 deletions

View File

@@ -14,7 +14,7 @@ jobs:
- name: Install cargo-llvm-cov
uses: taiki-e/install-action@cargo-llvm-cov
- name: Generate code coverage
run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
run: cargo llvm-cov --all-features --workspace --exclude pyroncalc --exclude wasm --lcov --output-path lcov.info
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:

32
.readthedocs.yaml Normal file
View File

@@ -0,0 +1,32 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: bindings/python/docs/conf.py
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt

124
Cargo.lock generated
View File

@@ -299,6 +299,12 @@ dependencies = [
"wasi",
]
[[package]]
name = "heck"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "hmac"
version = "0.12.1"
@@ -331,6 +337,12 @@ dependencies = [
"cc",
]
[[package]]
name = "indoc"
version = "2.0.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5"
[[package]]
name = "inout"
version = "0.1.3"
@@ -342,7 +354,7 @@ dependencies = [
[[package]]
name = "ironcalc"
version = "0.1.3"
version = "0.2.0"
dependencies = [
"bitcode",
"chrono",
@@ -358,7 +370,7 @@ dependencies = [
[[package]]
name = "ironcalc_base"
version = "0.1.3"
version = "0.2.0"
dependencies = [
"bitcode",
"chrono",
@@ -423,6 +435,15 @@ version = "2.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6c8640c5d730cb13ebd907d8d04b52f55ac9a2eec55b440c8892f40d56c76c1d"
[[package]]
name = "memoffset"
version = "0.9.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
dependencies = [
"autocfg",
]
[[package]]
name = "miniz_oxide"
version = "0.7.2"
@@ -529,6 +550,12 @@ version = "0.3.30"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d231b230927b5e4ad203db57bbcbee2802f6bce620b1e4a9024a07d94e2907ec"
[[package]]
name = "portable-atomic"
version = "1.7.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "da544ee218f0d287a911e9c99a39a8c9bc8fcad3cb8db5959940044ecfc67265"
[[package]]
name = "powerfmt"
version = "0.2.0"
@@ -543,13 +570,86 @@ checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de"
[[package]]
name = "proc-macro2"
version = "1.0.79"
version = "1.0.86"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e835ff2298f5721608eb1a980ecaee1aef2c132bf95ecc026a11b7bf3c01c02e"
checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77"
dependencies = [
"unicode-ident",
]
[[package]]
name = "pyo3"
version = "0.22.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "15ee168e30649f7f234c3d49ef5a7a6cbf5134289bc46c29ff3155fa3221c225"
dependencies = [
"cfg-if",
"indoc",
"libc",
"memoffset",
"once_cell",
"portable-atomic",
"pyo3-build-config",
"pyo3-ffi",
"pyo3-macros",
"unindent",
]
[[package]]
name = "pyo3-build-config"
version = "0.22.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e61cef80755fe9e46bb8a0b8f20752ca7676dcc07a5277d8b7768c6172e529b3"
dependencies = [
"once_cell",
"target-lexicon",
]
[[package]]
name = "pyo3-ffi"
version = "0.22.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "67ce096073ec5405f5ee2b8b31f03a68e02aa10d5d4f565eca04acc41931fa1c"
dependencies = [
"libc",
"pyo3-build-config",
]
[[package]]
name = "pyo3-macros"
version = "0.22.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2440c6d12bc8f3ae39f1e775266fa5122fd0c8891ce7520fa6048e683ad3de28"
dependencies = [
"proc-macro2",
"pyo3-macros-backend",
"quote",
"syn",
]
[[package]]
name = "pyo3-macros-backend"
version = "0.22.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1be962f0e06da8f8465729ea2cb71a416d2257dff56cbe40a70d3e62a93ae5d1"
dependencies = [
"heck",
"proc-macro2",
"pyo3-build-config",
"quote",
"syn",
]
[[package]]
name = "pyroncalc"
version = "0.1.2"
dependencies = [
"ironcalc",
"pyo3",
"serde",
"serde_json",
]
[[package]]
name = "quote"
version = "1.0.35"
@@ -714,15 +814,21 @@ checksum = "81cdd64d312baedb58e21336b31bc043b77e01cc99033ce76ef539f78e965ebc"
[[package]]
name = "syn"
version = "2.0.58"
version = "2.0.77"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "44cfb93f38070beee36b3fef7d4f5a16f27751d94b187b666a5cc5e9b0d30687"
checksum = "9f35bcdf61fd8e7be6caf75f429fdca8beb3ed76584befb503b1569faee373ed"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "target-lexicon"
version = "0.12.16"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
[[package]]
name = "thiserror"
version = "1.0.58"
@@ -774,6 +880,12 @@ version = "1.0.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
[[package]]
name = "unindent"
version = "0.2.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c7de7d73e1754487cb58364ee906a499937a0dfabd86bcb980fa99ec8c8fa2ce"
[[package]]
name = "uuid"
version = "1.8.0"

View File

@@ -5,6 +5,7 @@ members = [
"base",
"xlsx",
"bindings/wasm",
"bindings/python",
]
exclude = [

View File

@@ -1,41 +1,53 @@
.PHONY: lint
lint:
cargo fmt -- --check
cargo clippy --all-targets --all-features
cd webapp && npm install && npm run check
.PHONY: format
format:
cargo fmt
.PHONY: tests
tests: lint
cargo test
./target/debug/documentation
cmp functions.md wiki/functions.md || exit 1
make remove-artifacts
cd bindings/wasm/ && wasm-pack build --target nodejs && node tests/test.mjs
# Regretabbly we need to build the wasm twice, once for the nodejs tests
# and a second one for the vitest.
cd bindings/wasm/ && wasm-pack build --target nodejs && node tests/test.mjs && make
cd webapp && npm run test
cd bindings/python && ./run_tests.sh && ./run_examples.sh
.PHONY: remove-artifacts
remove-artifacts:
rm -f xlsx/hello-calc.xlsx
rm -f xlsx/hello-styles.xlsx
rm -f xlsx/widths-and-heights.xlsx
rm -f functions.md
.PHONY: clean
clean: remove-artifacts
cargo clean
rm -r -f base/target
rm -r -f xlsx/target
rm -r -f bindings/python/target
rm -r -f bindings/wasm/targets
rm -f cargo-test-*
rm -f base/cargo-test-*
rm -f xlsx/cargo-test-*
.PHONY: coverage
coverage:
CARGO_INCREMENTAL=0 RUSTFLAGS='-C instrument-coverage' LLVM_PROFILE_FILE='cargo-test-%p-%m.profraw' cargo test
grcov . --binary-path ./target/debug/deps/ -s . -t html --branch --ignore-not-existing --ignore '../*' --ignore "/*" -o target/coverage/html
.PHONY: update-docs
update-docs:
cargo build
./target/debug/documentation -o wiki/functions.md
.PHONY: docs
docs:
cargo doc --no-deps
.PHONY: lint format tests docs coverage all

View File

@@ -128,7 +128,7 @@ https://playground.ironcalc.com
# Collaborators needed!. Call to action
We don't have a vibrant community just yet. This is the very stages of the project. But if you are passionate about code with high standards and no compromises, if you are looking for a project with high impact, if you are interested in a better, more open infrastructure for spreadsheets, whether you are a developer (rust, python, TypeScript, electron/tauri/anything else native app, React, you name it), a designer (we need a logo desperately!), an Excel power user who wants features, a business looking to integrate a MIT/Apache licensed spreadsheet in your own SaaS application join us!
We don't have a vibrant community just yet. This is the very stages of the project. But if you are passionate about code with high standards and no compromises, if you are looking for a project with high impact, if you are interested in a better, more open infrastructure for spreadsheets, whether you are a developer (rust, python, TypeScript, electron/tauri/anything else native app, React, you name it), a designer, an Excel power user who wants features, a business looking to integrate a MIT/Apache licensed spreadsheet in your own SaaS application join us!
The best place to start will be to join or [discord channel](https://discord.gg/zZYWfh3RHJ) or send us an email at hello@ironcalc.com.

View File

@@ -1,6 +1,6 @@
[package]
name = "ironcalc_base"
version = "0.1.3"
version = "0.2.0"
authors = ["Nicolás Hatcher <nicolas@theuniverse.today>"]
edition = "2021"
homepage = "https://www.ironcalc.com"

View File

@@ -3,15 +3,15 @@ use ironcalc_base::{types::CellType, Model};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut model = Model::new_empty("formulas-and-errors", "en", "UTC")?;
// A1
model.set_user_input(0, 1, 1, "1".to_string());
model.set_user_input(0, 1, 1, "1".to_string())?;
// A2
model.set_user_input(0, 2, 1, "2".to_string());
model.set_user_input(0, 2, 1, "2".to_string())?;
// A3
model.set_user_input(0, 3, 1, "3".to_string());
model.set_user_input(0, 3, 1, "3".to_string())?;
// B1
model.set_user_input(0, 1, 2, "=SUM(A1:A3)".to_string());
model.set_user_input(0, 1, 2, "=SUM(A1:A3)".to_string())?;
// B2
model.set_user_input(0, 2, 2, "=B1/0".to_string());
model.set_user_input(0, 2, 2, "=B1/0".to_string())?;
// Evaluate
model.evaluate();

View File

@@ -3,11 +3,11 @@ use ironcalc_base::{cell::CellValue, Model};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut model = Model::new_empty("hello-world", "en", "UTC")?;
// A1
model.set_user_input(0, 1, 1, "Hello".to_string());
model.set_user_input(0, 1, 1, "Hello".to_string())?;
// B1
model.set_user_input(0, 1, 2, "world!".to_string());
model.set_user_input(0, 1, 2, "world!".to_string())?;
// C1
model.set_user_input(0, 1, 3, "=CONCAT(A1, \" \", B1".to_string());
model.set_user_input(0, 1, 3, "=CONCAT(A1, \" \", B1".to_string())?;
// evaluates
model.evaluate();

View File

@@ -79,12 +79,11 @@ impl Model {
let formula_or_value = self
.get_cell_formula(sheet, source_row, source_column)?
.unwrap_or_else(|| source_cell.get_text(&self.workbook.shared_strings, &self.language));
self.set_user_input(sheet, target_row, target_column, formula_or_value);
self.set_user_input(sheet, target_row, target_column, formula_or_value)?;
self.workbook
.worksheet_mut(sheet)?
.set_cell_style(target_row, target_column, style);
self.cell_clear_all(sheet, source_row, source_column)?;
Ok(())
.set_cell_style(target_row, target_column, style)?;
self.cell_clear_all(sheet, source_row, source_column)
}
/// Inserts one or more new columns into the model at the specified index.

View File

@@ -6,6 +6,8 @@ pub(crate) const DEFAULT_COLUMN_WIDTH: f64 = 100.0;
pub(crate) const DEFAULT_ROW_HEIGHT: f64 = 21.0;
pub(crate) const COLUMN_WIDTH_FACTOR: f64 = 12.0;
pub(crate) const ROW_HEIGHT_FACTOR: f64 = 2.0;
pub(crate) const DEFAULT_WINDOW_HEIGH: i64 = 600;
pub(crate) const DEFAULT_WINDOW_WIDTH: i64 = 800;
pub(crate) const LAST_COLUMN: i32 = 16_384;
pub(crate) const LAST_ROW: i32 = 1_048_576;

View File

@@ -57,5 +57,5 @@ pub mod mock_time;
pub use model::get_milliseconds_since_epoch;
pub use model::Model;
pub use user_model::UserModel;
pub use user_model::BorderArea;
pub use user_model::UserModel;

View File

@@ -7,19 +7,15 @@ use crate::{
calc_result::{CalcResult, Range},
cell::CellValue,
constants::{self, LAST_COLUMN, LAST_ROW},
expressions::token::{Error, OpCompare, OpProduct, OpSum, OpUnary},
expressions::{
parser::move_formula::{move_formula, MoveContext},
token::get_error_by_name,
types::*,
utils::{self, is_valid_row},
},
expressions::{
parser::{
move_formula::{move_formula, MoveContext},
stringify::{to_rc_format, to_string},
Node, Parser,
},
utils::is_valid_column_number,
token::{get_error_by_name, Error, OpCompare, OpProduct, OpSum, OpUnary},
types::*,
utils::{self, is_valid_column_number, is_valid_row},
},
formatter::{
format::{format_number, parse_formatted_number},
@@ -1204,10 +1200,10 @@ impl Model {
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut model = Model::new_empty("model", "en", "UTC")?;
/// let (sheet, row, column) = (0, 1, 1);
/// model.set_user_input(sheet, row, column, "Hello!".to_string());
/// model.set_user_input(sheet, row, column, "Hello!".to_string())?;
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "Hello!".to_string());
///
/// model.update_cell_with_text(sheet, row, column, "Goodbye!");
/// model.update_cell_with_text(sheet, row, column, "Goodbye!")?;
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "Goodbye!".to_string());
/// # Ok(())
/// # }
@@ -1218,23 +1214,30 @@ impl Model {
/// * [Model::update_cell_with_number()]
/// * [Model::update_cell_with_bool()]
/// * [Model::update_cell_with_formula()]
pub fn update_cell_with_text(&mut self, sheet: u32, row: i32, column: i32, value: &str) {
let style_index = self.get_cell_style_index(sheet, row, column);
pub fn update_cell_with_text(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: &str,
) -> Result<(), String> {
let style_index = self.get_cell_style_index(sheet, row, column)?;
let new_style_index;
if common::value_needs_quoting(value, &self.language) {
new_style_index = self
.workbook
.styles
.get_style_with_quote_prefix(style_index);
.get_style_with_quote_prefix(style_index)?;
} else if self.workbook.styles.style_is_quote_prefix(style_index) {
new_style_index = self
.workbook
.styles
.get_style_without_quote_prefix(style_index);
.get_style_without_quote_prefix(style_index)?;
} else {
new_style_index = style_index;
}
self.set_cell_with_string(sheet, row, column, value, new_style_index);
self.set_cell_with_string(sheet, row, column, value, new_style_index)
}
/// Updates the value of a cell with a boolean value
@@ -1247,10 +1250,10 @@ impl Model {
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut model = Model::new_empty("model", "en", "UTC")?;
/// let (sheet, row, column) = (0, 1, 1);
/// model.set_user_input(sheet, row, column, "TRUE".to_string());
/// model.set_user_input(sheet, row, column, "TRUE".to_string())?;
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "TRUE".to_string());
///
/// model.update_cell_with_bool(sheet, row, column, false);
/// model.update_cell_with_bool(sheet, row, column, false)?;
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "FALSE".to_string());
/// # Ok(())
/// # }
@@ -1261,17 +1264,22 @@ impl Model {
/// * [Model::update_cell_with_number()]
/// * [Model::update_cell_with_text()]
/// * [Model::update_cell_with_formula()]
pub fn update_cell_with_bool(&mut self, sheet: u32, row: i32, column: i32, value: bool) {
let style_index = self.get_cell_style_index(sheet, row, column);
pub fn update_cell_with_bool(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: bool,
) -> Result<(), String> {
let style_index = self.get_cell_style_index(sheet, row, column)?;
let new_style_index = if self.workbook.styles.style_is_quote_prefix(style_index) {
self.workbook
.styles
.get_style_without_quote_prefix(style_index)
.get_style_without_quote_prefix(style_index)?
} else {
style_index
};
let worksheet = &mut self.workbook.worksheets[sheet as usize];
worksheet.set_cell_with_boolean(row, column, value, new_style_index);
self.set_cell_with_boolean(sheet, row, column, value, new_style_index)
}
/// Updates the value of a cell with a number
@@ -1284,10 +1292,10 @@ impl Model {
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut model = Model::new_empty("model", "en", "UTC")?;
/// let (sheet, row, column) = (0, 1, 1);
/// model.set_user_input(sheet, row, column, "42".to_string());
/// model.set_user_input(sheet, row, column, "42".to_string())?;
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "42".to_string());
///
/// model.update_cell_with_number(sheet, row, column, 23.0);
/// model.update_cell_with_number(sheet, row, column, 23.0)?;
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "23".to_string());
/// # Ok(())
/// # }
@@ -1298,17 +1306,22 @@ impl Model {
/// * [Model::update_cell_with_text()]
/// * [Model::update_cell_with_bool()]
/// * [Model::update_cell_with_formula()]
pub fn update_cell_with_number(&mut self, sheet: u32, row: i32, column: i32, value: f64) {
let style_index = self.get_cell_style_index(sheet, row, column);
pub fn update_cell_with_number(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: f64,
) -> Result<(), String> {
let style_index = self.get_cell_style_index(sheet, row, column)?;
let new_style_index = if self.workbook.styles.style_is_quote_prefix(style_index) {
self.workbook
.styles
.get_style_without_quote_prefix(style_index)
.get_style_without_quote_prefix(style_index)?
} else {
style_index
};
let worksheet = &mut self.workbook.worksheets[sheet as usize];
worksheet.set_cell_with_number(row, column, value, new_style_index);
self.set_cell_with_number(sheet, row, column, value, new_style_index)
}
/// Updates the formula of given cell
@@ -1322,11 +1335,11 @@ impl Model {
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut model = Model::new_empty("model", "en", "UTC")?;
/// let (sheet, row, column) = (0, 1, 1);
/// model.set_user_input(sheet, row, column, "=A2*2".to_string());
/// model.set_user_input(sheet, row, column, "=A2*2".to_string())?;
/// model.evaluate();
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "=A2*2".to_string());
///
/// model.update_cell_with_formula(sheet, row, column, "=A3*2".to_string());
/// model.update_cell_with_formula(sheet, row, column, "=A3*2".to_string())?;
/// model.evaluate();
/// assert_eq!(model.get_cell_content(sheet, row, column)?, "=A3*2".to_string());
/// # Ok(())
@@ -1345,12 +1358,12 @@ impl Model {
column: i32,
formula: String,
) -> Result<(), String> {
let mut style_index = self.get_cell_style_index(sheet, row, column);
let mut style_index = self.get_cell_style_index(sheet, row, column)?;
if self.workbook.styles.style_is_quote_prefix(style_index) {
style_index = self
.workbook
.styles
.get_style_without_quote_prefix(style_index);
.get_style_without_quote_prefix(style_index)?;
}
let formula = formula
.strip_prefix('=')
@@ -1390,31 +1403,36 @@ impl Model {
/// * [Model::update_cell_with_number()]
/// * [Model::update_cell_with_bool()]
/// * [Model::update_cell_with_text()]
pub fn set_user_input(&mut self, sheet: u32, row: i32, column: i32, value: String) {
pub fn set_user_input(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: String,
) -> Result<(), String> {
// If value starts with "'" then we force the style to be quote_prefix
let style_index = self.get_cell_style_index(sheet, row, column);
let style_index = self.get_cell_style_index(sheet, row, column)?;
if let Some(new_value) = value.strip_prefix('\'') {
// First check if it needs quoting
let new_style = if common::value_needs_quoting(new_value, &self.language) {
self.workbook
.styles
.get_style_with_quote_prefix(style_index)
.get_style_with_quote_prefix(style_index)?
} else {
style_index
};
self.set_cell_with_string(sheet, row, column, new_value, new_style);
self.set_cell_with_string(sheet, row, column, new_value, new_style)?;
} else {
let mut new_style_index = style_index;
if self.workbook.styles.style_is_quote_prefix(style_index) {
new_style_index = self
.workbook
.styles
.get_style_without_quote_prefix(style_index);
.get_style_without_quote_prefix(style_index)?;
}
if let Some(formula) = value.strip_prefix('=') {
let formula_index = self
.set_cell_with_formula(sheet, row, column, formula, new_style_index)
.expect("could not set the cell formula");
let formula_index =
self.set_cell_with_formula(sheet, row, column, formula, new_style_index)?;
// Update the style if needed
let cell = CellReferenceIndex { sheet, row, column };
let parsed_formula = &self.parsed_formulas[sheet as usize][formula_index as usize];
@@ -1422,15 +1440,11 @@ impl Model {
let new_style_index = self
.workbook
.styles
.get_style_with_format(new_style_index, &units.get_num_fmt());
let style = self.workbook.styles.get_style(new_style_index);
self.set_cell_style(sheet, row, column, &style)
.expect("Failed setting the style");
.get_style_with_format(new_style_index, &units.get_num_fmt())?;
let style = self.workbook.styles.get_style(new_style_index)?;
self.set_cell_style(sheet, row, column, &style)?
}
} else {
let worksheets = &mut self.workbook.worksheets;
let worksheet = &mut worksheets[sheet as usize];
// The list of currencies is '$', '€' and the local currency
let mut currencies = vec!["$", ""];
let currency = &self.locale.currency.symbol;
@@ -1443,35 +1457,39 @@ impl Model {
// Should not apply the format in the following cases:
// - we assign a date to already date-formatted cell
let should_apply_format = !(is_likely_date_number_format(
&self.workbook.styles.get_style(new_style_index).num_fmt,
&self.workbook.styles.get_style(new_style_index)?.num_fmt,
) && is_likely_date_number_format(&num_fmt));
if should_apply_format {
new_style_index = self
.workbook
.styles
.get_style_with_format(new_style_index, &num_fmt);
.get_style_with_format(new_style_index, &num_fmt)?;
}
}
worksheet.set_cell_with_number(row, column, v, new_style_index);
return;
let worksheet = self.workbook.worksheet_mut(sheet)?;
worksheet.set_cell_with_number(row, column, v, new_style_index)?;
return Ok(());
}
// We try to parse as boolean
if let Ok(v) = value.to_lowercase().parse::<bool>() {
worksheet.set_cell_with_boolean(row, column, v, new_style_index);
return;
let worksheet = self.workbook.worksheet_mut(sheet)?;
worksheet.set_cell_with_boolean(row, column, v, new_style_index)?;
return Ok(());
}
// Check is it is error value
let upper = value.to_uppercase();
let worksheet = self.workbook.worksheet_mut(sheet)?;
match get_error_by_name(&upper, &self.language) {
Some(error) => {
worksheet.set_cell_with_error(row, column, error, new_style_index);
worksheet.set_cell_with_error(row, column, error, new_style_index)?;
}
None => {
self.set_cell_with_string(sheet, row, column, &value, new_style_index);
self.set_cell_with_string(sheet, row, column, &value, new_style_index)?;
}
}
}
}
Ok(())
}
fn set_cell_with_formula(
@@ -1512,24 +1530,66 @@ impl Model {
self.parsed_formulas[sheet as usize].push(parsed_formula);
formula_index = (shared_formulas.len() as i32) - 1;
}
worksheet.set_cell_with_formula(row, column, formula_index, style);
worksheet.set_cell_with_formula(row, column, formula_index, style)?;
Ok(formula_index)
}
fn set_cell_with_string(&mut self, sheet: u32, row: i32, column: i32, value: &str, style: i32) {
let worksheets = &mut self.workbook.worksheets;
let worksheet = &mut worksheets[sheet as usize];
fn set_cell_with_string(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: &str,
style: i32,
) -> Result<(), String> {
match self.shared_strings.get(value) {
Some(string_index) => {
worksheet.set_cell_with_string(row, column, *string_index as i32, style);
self.workbook.worksheet_mut(sheet)?.set_cell_with_string(
row,
column,
*string_index as i32,
style,
)?;
}
None => {
let string_index = self.workbook.shared_strings.len();
self.workbook.shared_strings.push(value.to_string());
self.shared_strings.insert(value.to_string(), string_index);
worksheet.set_cell_with_string(row, column, string_index as i32, style);
self.workbook.worksheet_mut(sheet)?.set_cell_with_string(
row,
column,
string_index as i32,
style,
)?;
}
}
Ok(())
}
fn set_cell_with_boolean(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: bool,
style: i32,
) -> Result<(), String> {
self.workbook
.worksheet_mut(sheet)?
.set_cell_with_boolean(row, column, value, style)
}
fn set_cell_with_number(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: f64,
style: i32,
) -> Result<(), String> {
self.workbook
.worksheet_mut(sheet)?
.set_cell_with_number(row, column, value, style)
}
/// Gets the Excel Value (Bool, Number, String) of a cell
@@ -1596,7 +1656,7 @@ impl Model {
) -> Result<String, String> {
match self.workbook.worksheet(sheet_index)?.cell(row, column) {
Some(cell) => {
let format = self.get_style_for_cell(sheet_index, row, column).num_fmt;
let format = self.get_style_for_cell(sheet_index, row, column)?.num_fmt;
let formatted_value =
cell.formatted_value(&self.workbook.shared_strings, &self.language, |value| {
format_number(value, &format, &self.locale).text
@@ -1699,7 +1759,7 @@ impl Model {
pub fn cell_clear_contents(&mut self, sheet: u32, row: i32, column: i32) -> Result<(), String> {
self.workbook
.worksheet_mut(sheet)?
.cell_clear_contents(row, column);
.cell_clear_contents(row, column)?;
Ok(())
}
@@ -1734,43 +1794,40 @@ impl Model {
}
/// Returns the style index for cell (`sheet`, `row`, `column`)
pub fn get_cell_style_index(&self, sheet: u32, row: i32, column: i32) -> i32 {
pub fn get_cell_style_index(&self, sheet: u32, row: i32, column: i32) -> Result<i32, String> {
// First check the cell, then row, the column
let cell = self
.workbook
.worksheet(sheet)
.expect("Invalid sheet")
.cell(row, column);
let cell = self.workbook.worksheet(sheet)?.cell(row, column);
match cell {
Some(cell) => cell.get_style(),
Some(cell) => Ok(cell.get_style()),
None => {
let rows = &self.workbook.worksheets[sheet as usize].rows;
let rows = &self.workbook.worksheet(sheet)?.rows;
for r in rows {
if r.r == row {
if r.custom_format {
return r.s;
return Ok(r.s);
}
break;
}
}
let cols = &self.workbook.worksheets[sheet as usize].cols;
let cols = &self.workbook.worksheet(sheet)?.cols;
for c in cols.iter() {
let min = c.min;
let max = c.max;
if column >= min && column <= max {
return c.style.unwrap_or(0);
return Ok(c.style.unwrap_or(0));
}
}
0
Ok(0)
}
}
}
/// Returns the style for cell (`sheet`, `row`, `column`)
pub fn get_style_for_cell(&self, sheet: u32, row: i32, column: i32) -> Style {
self.workbook
.styles
.get_style(self.get_cell_style_index(sheet, row, column))
pub fn get_style_for_cell(&self, sheet: u32, row: i32, column: i32) -> Result<Style, String> {
let style_index = self.get_cell_style_index(sheet, row, column)?;
let style = self.workbook.styles.get_style(style_index)?;
Ok(style)
}
/// Returns an internal binary representation of the workbook
@@ -1810,7 +1867,7 @@ impl Model {
Some(formula) => formula,
None => self.get_formatted_cell_value(sheet, row, column)?,
};
let style = self.get_style_for_cell(sheet, row, column);
let style = self.get_style_for_cell(sheet, row, column)?;
if style.font.b {
cell_markup = format!("**{cell_markup}**")
}

View File

@@ -4,6 +4,7 @@ use std::collections::HashMap;
use crate::{
calc_result::Range,
constants::{DEFAULT_WINDOW_HEIGH, DEFAULT_WINDOW_WIDTH},
expressions::{
lexer::LexerMode,
parser::{
@@ -357,8 +358,8 @@ impl Model {
0,
WorkbookView {
sheet: 0,
window_width: 800,
window_height: 600,
window_width: DEFAULT_WINDOW_WIDTH,
window_height: DEFAULT_WINDOW_HEIGH,
},
);

View File

@@ -161,26 +161,29 @@ impl Styles {
pub fn create_named_style(&mut self, style_name: &str, style: &Style) -> Result<(), String> {
let style_index = self.create_new_style(style);
self.add_named_cell_style(style_name, style_index)?;
Ok(())
self.add_named_cell_style(style_name, style_index)
}
pub(crate) fn get_style_with_quote_prefix(&mut self, index: i32) -> i32 {
let mut style = self.get_style(index);
pub(crate) fn get_style_with_quote_prefix(&mut self, index: i32) -> Result<i32, String> {
let mut style = self.get_style(index)?;
style.quote_prefix = true;
self.get_style_index_or_create(&style)
Ok(self.get_style_index_or_create(&style))
}
pub(crate) fn get_style_with_format(&mut self, index: i32, num_fmt: &str) -> i32 {
let mut style = self.get_style(index);
pub(crate) fn get_style_with_format(
&mut self,
index: i32,
num_fmt: &str,
) -> Result<i32, String> {
let mut style = self.get_style(index)?;
style.num_fmt = num_fmt.to_string();
self.get_style_index_or_create(&style)
Ok(self.get_style_index_or_create(&style))
}
pub(crate) fn get_style_without_quote_prefix(&mut self, index: i32) -> i32 {
let mut style = self.get_style(index);
pub(crate) fn get_style_without_quote_prefix(&mut self, index: i32) -> Result<i32, String> {
let mut style = self.get_style(index)?;
style.quote_prefix = false;
self.get_style_index_or_create(&style)
Ok(self.get_style_index_or_create(&style))
}
pub(crate) fn style_is_quote_prefix(&self, index: i32) -> bool {
@@ -188,9 +191,11 @@ impl Styles {
cell_xf.quote_prefix
}
pub(crate) fn get_style(&self, index: i32) -> Style {
let cell_xf = &self.cell_xfs[index as usize];
pub(crate) fn get_style(&self, index: i32) -> Result<Style, String> {
let cell_xf = &self
.cell_xfs
.get(index as usize)
.ok_or("Invalid index provided".to_string())?;
let border_id = cell_xf.border_id as usize;
let fill_id = cell_xf.fill_id as usize;
let font_id = cell_xf.font_id as usize;
@@ -198,14 +203,14 @@ impl Styles {
let quote_prefix = cell_xf.quote_prefix;
let alignment = cell_xf.alignment.clone();
Style {
Ok(Style {
alignment,
num_fmt: get_num_fmt(num_fmt_id, &self.num_fmts),
fill: self.fills[fill_id].clone(),
font: self.fonts[font_id].clone(),
border: self.borders[border_id].clone(),
quote_prefix,
}
})
}
}
@@ -221,8 +226,7 @@ impl Model {
let style_index = self.workbook.styles.get_style_index_or_create(style);
self.workbook
.worksheet_mut(sheet)?
.set_cell_style(row, column, style_index);
Ok(())
.set_cell_style(row, column, style_index)
}
pub fn copy_cell_style(
@@ -237,9 +241,7 @@ impl Model {
self.workbook
.worksheet_mut(destination_cell.0)?
.set_cell_style(destination_cell.1, destination_cell.2, source_style_index);
Ok(())
.set_cell_style(destination_cell.1, destination_cell.2, source_style_index)
}
/// Sets the style "style_name" in cell
@@ -253,8 +255,7 @@ impl Model {
let style_index = self.workbook.styles.get_style_index_by_name(style_name)?;
self.workbook
.worksheet_mut(sheet)?
.set_cell_style(row, column, style_index);
Ok(())
.set_cell_style(row, column, style_index)
}
pub fn set_sheet_style(&mut self, sheet: u32, style_name: &str) -> Result<(), String> {

View File

@@ -52,6 +52,7 @@ mod test_fn_type;
mod test_frozen_rows_and_columns;
mod test_get_cell_content;
mod test_percentage;
mod test_set_functions_error_handling;
mod test_today;
mod test_types;
mod user_model;

View File

@@ -26,7 +26,7 @@ fn test_column_width() {
assert!((worksheet.get_column_width(1).unwrap() - DEFAULT_COLUMN_WIDTH).abs() < f64::EPSILON);
assert!((worksheet.get_column_width(2).unwrap() - 30.0).abs() < f64::EPSILON);
assert!((worksheet.get_column_width(3).unwrap() - DEFAULT_COLUMN_WIDTH).abs() < f64::EPSILON);
assert_eq!(model.get_cell_style_index(0, 23, 2), 6);
assert_eq!(model.get_cell_style_index(0, 23, 2), Ok(6));
}
#[test]
@@ -53,7 +53,7 @@ fn test_column_width_lower_edge() {
assert!(
(worksheet.get_column_width(6).unwrap() - 10.0 * COLUMN_WIDTH_FACTOR).abs() < f64::EPSILON
);
assert_eq!(model.get_cell_style_index(0, 23, 5), 1);
assert_eq!(model.get_cell_style_index(0, 23, 5), Ok(1));
}
#[test]
@@ -80,5 +80,5 @@ fn test_column_width_higher_edge() {
);
assert!((worksheet.get_column_width(16).unwrap() - 30.0).abs() < f64::EPSILON);
assert!((worksheet.get_column_width(17).unwrap() - DEFAULT_COLUMN_WIDTH).abs() < f64::EPSILON);
assert_eq!(model.get_cell_style_index(0, 23, 16), 1);
assert_eq!(model.get_cell_style_index(0, 23, 16), Ok(1));
}

View File

@@ -17,7 +17,9 @@ fn test_empty_model() {
#[test]
fn test_model_simple_evaluation() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "= 1 + 3".to_string());
model
.set_user_input(0, 1, 1, "= 1 + 3".to_string())
.unwrap();
model.evaluate();
let result = model._get_text_at(0, 1, 1);
assert_eq!(result, *"4");
@@ -43,7 +45,7 @@ fn test_model_simple_evaluation_order() {
#[test]
fn test_model_invalid_formula() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "= 1 +".to_string());
model.set_user_input(0, 1, 1, "= 1 +".to_string()).unwrap();
model.evaluate();
let result = model._get_text_at(0, 1, 1);
assert_eq!(result, *"#ERROR!");
@@ -54,8 +56,10 @@ fn test_model_invalid_formula() {
#[test]
fn test_model_dependencies() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "23".to_string()); // A1
model.set_user_input(0, 1, 2, "= A1* 2-4".to_string()); // B1
model.set_user_input(0, 1, 1, "23".to_string()).unwrap(); // A1
model
.set_user_input(0, 1, 2, "= A1* 2-4".to_string())
.unwrap(); // B1
model.evaluate();
let result = model._get_text_at(0, 1, 1);
assert_eq!(result, *"23");
@@ -65,7 +69,9 @@ fn test_model_dependencies() {
let result = model._get_formula("B1");
assert_eq!(result, *"=A1*2-4");
model.set_user_input(0, 2, 1, "=SUM(A1, B1)".to_string()); // A2
model
.set_user_input(0, 2, 1, "=SUM(A1, B1)".to_string())
.unwrap(); // A2
model.evaluate();
let result = model._get_text_at(0, 2, 1);
assert_eq!(result, *"65");
@@ -74,8 +80,10 @@ fn test_model_dependencies() {
#[test]
fn test_model_strings() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "Hello World".to_string());
model.set_user_input(0, 1, 2, "=A1".to_string());
model
.set_user_input(0, 1, 1, "Hello World".to_string())
.unwrap();
model.set_user_input(0, 1, 2, "=A1".to_string()).unwrap();
model.evaluate();
let result = model._get_text_at(0, 1, 1);
assert_eq!(result, *"Hello World");
@@ -152,21 +160,35 @@ fn test_to_excel_precision_str() {
#[test]
fn test_booleans() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "true".to_string());
model.set_user_input(0, 2, 1, "TRUE".to_string());
model.set_user_input(0, 3, 1, "True".to_string());
model.set_user_input(0, 4, 1, "false".to_string());
model.set_user_input(0, 5, 1, "FALSE".to_string());
model.set_user_input(0, 6, 1, "False".to_string());
model.set_user_input(0, 1, 1, "true".to_string()).unwrap();
model.set_user_input(0, 2, 1, "TRUE".to_string()).unwrap();
model.set_user_input(0, 3, 1, "True".to_string()).unwrap();
model.set_user_input(0, 4, 1, "false".to_string()).unwrap();
model.set_user_input(0, 5, 1, "FALSE".to_string()).unwrap();
model.set_user_input(0, 6, 1, "False".to_string()).unwrap();
model.set_user_input(0, 1, 2, "=ISLOGICAL(A1)".to_string());
model.set_user_input(0, 2, 2, "=ISLOGICAL(A2)".to_string());
model.set_user_input(0, 3, 2, "=ISLOGICAL(A3)".to_string());
model.set_user_input(0, 4, 2, "=ISLOGICAL(A4)".to_string());
model.set_user_input(0, 5, 2, "=ISLOGICAL(A5)".to_string());
model.set_user_input(0, 6, 2, "=ISLOGICAL(A6)".to_string());
model
.set_user_input(0, 1, 2, "=ISLOGICAL(A1)".to_string())
.unwrap();
model
.set_user_input(0, 2, 2, "=ISLOGICAL(A2)".to_string())
.unwrap();
model
.set_user_input(0, 3, 2, "=ISLOGICAL(A3)".to_string())
.unwrap();
model
.set_user_input(0, 4, 2, "=ISLOGICAL(A4)".to_string())
.unwrap();
model
.set_user_input(0, 5, 2, "=ISLOGICAL(A5)".to_string())
.unwrap();
model
.set_user_input(0, 6, 2, "=ISLOGICAL(A6)".to_string())
.unwrap();
model.set_user_input(0, 1, 5, "=IF(false, True, FALSe)".to_string());
model
.set_user_input(0, 1, 5, "=IF(false, True, FALSe)".to_string())
.unwrap();
model.evaluate();
@@ -191,19 +213,19 @@ fn test_booleans() {
#[test]
fn test_set_cell_style() {
let mut model = new_empty_model();
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
assert!(!style.font.b);
style.font.b = true;
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
assert!(style.font.b);
style.font.b = false;
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
let style = model.get_style_for_cell(0, 1, 1);
let style = model.get_style_for_cell(0, 1, 1).unwrap();
assert!(!style.font.b);
}
@@ -211,21 +233,21 @@ fn test_set_cell_style() {
fn test_copy_cell_style() {
let mut model = new_empty_model();
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
style.font.b = true;
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
let mut style = model.get_style_for_cell(0, 1, 2);
let mut style = model.get_style_for_cell(0, 1, 2).unwrap();
style.font.i = true;
assert!(model.set_cell_style(0, 1, 2, &style).is_ok());
assert!(model.copy_cell_style((0, 1, 1), (0, 1, 2)).is_ok());
let style = model.get_style_for_cell(0, 1, 1);
let style = model.get_style_for_cell(0, 1, 1).unwrap();
assert!(style.font.b);
assert!(!style.font.i);
let style = model.get_style_for_cell(0, 1, 2);
let style = model.get_style_for_cell(0, 1, 2).unwrap();
assert!(style.font.b);
assert!(!style.font.i);
}
@@ -234,15 +256,15 @@ fn test_copy_cell_style() {
fn test_get_cell_style_index() {
let mut model = new_empty_model();
let mut style = model.get_style_for_cell(0, 1, 1);
let style_index = model.get_cell_style_index(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
let style_index = model.get_cell_style_index(0, 1, 1).unwrap();
assert_eq!(style_index, 0);
assert!(!style.font.b);
style.font.b = true;
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
let style_index = model.get_cell_style_index(0, 1, 1);
let style_index = model.get_cell_style_index(0, 1, 1).unwrap();
assert_eq!(style_index, 1);
}
@@ -250,29 +272,29 @@ fn test_get_cell_style_index() {
fn test_model_set_cells_with_values_styles() {
let mut model = new_empty_model();
// Inputs
model.set_user_input(0, 1, 1, "21".to_string()); // A1
model.set_user_input(0, 2, 1, "2".to_string()); // A2
model.set_user_input(0, 1, 1, "21".to_string()).unwrap(); // A1
model.set_user_input(0, 2, 1, "2".to_string()).unwrap(); // A2
let style_index = model.get_cell_style_index(0, 1, 1);
let style_index = model.get_cell_style_index(0, 1, 1).unwrap();
assert_eq!(style_index, 0);
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
style.font.b = true;
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
assert!(model.set_cell_style(0, 2, 1, &style).is_ok());
let style_index = model.get_cell_style_index(0, 1, 1);
let style_index = model.get_cell_style_index(0, 1, 1).unwrap();
assert_eq!(style_index, 1);
let style_index = model.get_cell_style_index(0, 2, 1);
let style_index = model.get_cell_style_index(0, 2, 1).unwrap();
assert_eq!(style_index, 1);
model.update_cell_with_number(0, 1, 2, 1.0);
model.update_cell_with_number(0, 2, 1, 2.0);
model.update_cell_with_number(0, 1, 2, 1.0).unwrap();
model.update_cell_with_number(0, 2, 1, 2.0).unwrap();
model.evaluate();
// Styles are not modified
let style_index = model.get_cell_style_index(0, 1, 1);
let style_index = model.get_cell_style_index(0, 1, 1).unwrap();
assert_eq!(style_index, 1);
let style_index = model.get_cell_style_index(0, 2, 1);
let style_index = model.get_cell_style_index(0, 2, 1).unwrap();
assert_eq!(style_index, 1);
}
@@ -280,20 +302,20 @@ fn test_model_set_cells_with_values_styles() {
fn test_style_fmt_id() {
let mut model = new_empty_model();
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
style.num_fmt = "#.##".to_string();
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
let style = model.get_style_for_cell(0, 1, 1);
let style = model.get_style_for_cell(0, 1, 1).unwrap();
assert_eq!(style.num_fmt, "#.##");
let mut style = model.get_style_for_cell(0, 10, 1);
let mut style = model.get_style_for_cell(0, 10, 1).unwrap();
style.num_fmt = "$$#,##0.0000".to_string();
assert!(model.set_cell_style(0, 10, 1, &style).is_ok());
let style = model.get_style_for_cell(0, 10, 1);
let style = model.get_style_for_cell(0, 10, 1).unwrap();
assert_eq!(style.num_fmt, "$$#,##0.0000");
// Make sure old style is not touched
let style = model.get_style_for_cell(0, 1, 1);
let style = model.get_style_for_cell(0, 1, 1).unwrap();
assert_eq!(style.num_fmt, "#.##");
}
@@ -357,9 +379,13 @@ fn set_input_autocomplete() {
let mut model = new_empty_model();
model._set("A1", "1");
model._set("A2", "2");
model.set_user_input(0, 3, 1, "=SUM(A1:A2".to_string());
model
.set_user_input(0, 3, 1, "=SUM(A1:A2".to_string())
.unwrap();
// This will fail anyway
model.set_user_input(0, 4, 1, "=SUM(A1*".to_string());
model
.set_user_input(0, 4, 1, "=SUM(A1*".to_string())
.unwrap();
model.evaluate();
assert_eq!(model._get_formula("A3"), "=SUM(A1:A2)");
@@ -405,7 +431,7 @@ fn test_get_formatted_cell_value() {
model._set("A5", "123.456");
// change A5 format
let mut style = model.get_style_for_cell(0, 5, 1);
let mut style = model.get_style_for_cell(0, 5, 1).unwrap();
style.num_fmt = "$#,##0.00".to_string();
model.set_cell_style(0, 5, 1, &style).unwrap();

View File

@@ -5,8 +5,12 @@ use crate::test::util::new_empty_model;
#[test]
fn test_formulas() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "$100.348".to_string());
model.set_user_input(0, 1, 2, "=ISNUMBER(A1)".to_string());
model
.set_user_input(0, 1, 1, "$100.348".to_string())
.unwrap();
model
.set_user_input(0, 1, 2, "=ISNUMBER(A1)".to_string())
.unwrap();
model.evaluate();

View File

@@ -3,7 +3,7 @@ use crate::test::util::new_empty_model;
#[test]
fn test_metadata_new_model() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "5.5".to_string());
model.set_user_input(0, 1, 1, "5.5".to_string()).unwrap();
model.evaluate();
let metadata = &model.workbook.metadata;
assert_eq!(metadata.application, "IronCalc Sheets");

View File

@@ -14,7 +14,9 @@ fn test_is_empty_cell_non_existing_sheet() {
fn test_is_empty_cell() {
let mut model = new_empty_model();
assert!(model.is_empty_cell(0, 3, 1).unwrap());
model.set_user_input(0, 3, 1, "Hello World".to_string());
model
.set_user_input(0, 3, 1, "Hello World".to_string())
.unwrap();
assert!(!model.is_empty_cell(0, 3, 1).unwrap());
model.cell_clear_contents(0, 3, 1).unwrap();
assert!(model.is_empty_cell(0, 3, 1).unwrap());

View File

@@ -57,12 +57,12 @@ fn test_quote_prefix_enter() {
model._set("A2", "=ISTEXT(A1)");
model.evaluate();
// We introduce a value with a "quote prefix" index
model.set_user_input(0, 1, 3, "'=A1".to_string());
model.set_user_input(0, 1, 3, "'=A1".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("C1"), *"=A1");
// But if we enter with a quote_prefix but without the "'" it won't be quote_prefix
model.set_user_input(0, 1, 4, "=A1".to_string());
model.set_user_input(0, 1, 4, "=A1".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("D1"), *"123");
}
@@ -75,7 +75,7 @@ fn test_quote_prefix_reenter() {
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
// We introduce a value with a "quote prefix" index
model.set_user_input(0, 1, 1, "123".to_string());
model.set_user_input(0, 1, 1, "123".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("A2"), *"FALSE");
}
@@ -83,7 +83,7 @@ fn test_quote_prefix_reenter() {
#[test]
fn test_update_cell_quote() {
let mut model = new_empty_model();
model.update_cell_with_text(0, 1, 1, "= 1 + 3");
model.update_cell_with_text(0, 1, 1, "= 1 + 3").unwrap();
model.evaluate();
assert_eq!(model._get_text("A1"), *"= 1 + 3");
assert!(!model._has_formula("A1"));
@@ -92,12 +92,12 @@ fn test_update_cell_quote() {
#[test]
fn test_update_quote_prefix_reenter() {
let mut model = new_empty_model();
model.update_cell_with_text(0, 1, 1, "123");
model.update_cell_with_text(0, 1, 1, "123").unwrap();
model._set("A2", "=ISTEXT(A1)");
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
// We reenter as a number
model.update_cell_with_number(0, 1, 1, 123.0);
model.update_cell_with_number(0, 1, 1, 123.0).unwrap();
model.evaluate();
assert_eq!(model._get_text("A2"), *"FALSE");
}
@@ -105,12 +105,12 @@ fn test_update_quote_prefix_reenter() {
#[test]
fn test_update_quote_prefix_reenter_bool() {
let mut model = new_empty_model();
model.update_cell_with_text(0, 1, 1, "TRUE");
model.update_cell_with_text(0, 1, 1, "TRUE").unwrap();
model._set("A2", "=ISTEXT(A1)");
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
// We enter a bool
model.update_cell_with_bool(0, 1, 1, true);
model.update_cell_with_bool(0, 1, 1, true).unwrap();
model.evaluate();
assert_eq!(model._get_text("A2"), *"FALSE");
}
@@ -118,29 +118,29 @@ fn test_update_quote_prefix_reenter_bool() {
#[test]
fn test_update_quote_prefix_reenter_text() {
let mut model = new_empty_model();
model.update_cell_with_text(0, 1, 1, "123");
model.update_cell_with_text(0, 1, 1, "123").unwrap();
model._set("A2", "=ISTEXT(A1)");
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
assert!(model.get_style_for_cell(0, 1, 1).quote_prefix);
assert!(model.get_style_for_cell(0, 1, 1).unwrap().quote_prefix);
// We enter a string
model.update_cell_with_text(0, 1, 1, "Hello");
model.update_cell_with_text(0, 1, 1, "Hello").unwrap();
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
assert!(!model.get_style_for_cell(0, 1, 1).quote_prefix);
assert!(!model.get_style_for_cell(0, 1, 1).unwrap().quote_prefix);
}
#[test]
fn test_update_quote_prefix_reenter_text_2() {
let mut model = new_empty_model();
model.update_cell_with_text(0, 1, 1, "123");
model.update_cell_with_text(0, 1, 1, "123").unwrap();
model._set("A2", "=ISTEXT(A1)");
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
assert!(model.get_style_for_cell(0, 1, 1).quote_prefix);
assert!(model.get_style_for_cell(0, 1, 1).unwrap().quote_prefix);
// We enter another number
model.update_cell_with_text(0, 1, 1, "42");
model.update_cell_with_text(0, 1, 1, "42").unwrap();
model.evaluate();
assert_eq!(model._get_text("A2"), *"TRUE");
assert!(model.get_style_for_cell(0, 1, 1).quote_prefix);
assert!(model.get_style_for_cell(0, 1, 1).unwrap().quote_prefix);
}

View File

@@ -0,0 +1,449 @@
use crate::{expressions::token, test::util::new_empty_model, types::Cell};
#[test]
fn test_update_cell_with_text() {
let mut model = new_empty_model();
// Below are safe inputs
model.set_user_input(0, 1, 1, "Hello".to_string()).unwrap();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.update_cell_with_text(1, 1, 1, "new value");
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// Case2 : Invalid Row
let update_result = model.update_cell_with_text(0, 0, 1, "new value");
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Invalid Column
let update_result = model.update_cell_with_text(0, 1, 1048579, "new value");
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_update_cell_with_number() {
let mut model = new_empty_model();
// Below are safe inputs
model.update_cell_with_number(0, 1, 1, 10.0).unwrap();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.update_cell_with_number(1, 1, 1, 20.0);
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// Case2 : Invalid Row
let update_result = model.update_cell_with_number(0, 0, 1, 20.0);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Invalid Column
let update_result = model.update_cell_with_number(0, 1, 1048579, 20.0);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_update_cell_with_bool() {
let mut model = new_empty_model();
// Below are safe inputs
model.update_cell_with_bool(0, 1, 1, true).unwrap();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.update_cell_with_bool(1, 1, 1, false);
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// Case2 : Invalid Row
let update_result = model.update_cell_with_bool(0, 0, 1, false);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Invalid Column
let update_result = model.update_cell_with_bool(0, 1, 1048579, false);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_update_cell_with_formula() {
let mut model = new_empty_model();
// Below are safe inputs
model.update_cell_with_number(0, 1, 1, 10.0).unwrap();
model
.update_cell_with_formula(0, 1, 2, "=A1*2".to_string())
.unwrap();
model.evaluate();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.update_cell_with_formula(1, 1, 2, "=A1*2".to_string());
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// Case2 : Invalid Row
let update_result = model.update_cell_with_formula(0, 0, 2, "=A1*2".to_string());
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Invalid Column
let update_result = model.update_cell_with_formula(0, 1, 1048579, "=A1*2".to_string());
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_set_user_input() {
let mut model = new_empty_model();
// Below are safe inputs
model.update_cell_with_number(0, 1, 1, 10.0).unwrap();
model.evaluate();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.set_user_input(1, 1, 2, "20.0".to_string());
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// Case2 : Invalid Row
let update_result = model.set_user_input(0, 0, 2, "20.0".to_string());
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Invalid Column
let update_result = model.set_user_input(0, 1, 1048579, "20.0".to_string());
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_get_style_for_cell() {
let mut model = new_empty_model();
// Below are safe inputs
model.update_cell_with_number(0, 1, 1, 10.0).unwrap();
model.evaluate();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.get_style_for_cell(1, 1, 2);
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// ATTENTION : get_cell_style_index tries to get cell using row and col
// if we invalid row or column is given, it will return index 0.
// Case2 : Invalid Row
let update_result = model.get_style_for_cell(0, 0, 2);
assert!(update_result.is_ok());
// Case3 : Invalid Column
let update_result = model.get_style_for_cell(0, 1, 1048579);
assert!(update_result.is_ok());
}
#[test]
fn test_get_cell_style_index() {
let mut model = new_empty_model();
// Below are safe inputs
model.update_cell_with_number(0, 1, 1, 10.0).unwrap();
model.evaluate();
// Now testing all the possible error scenarios
// Case1 : Invalid sheet
let update_result = model.get_cell_style_index(1, 1, 2);
assert_eq!(update_result, Err("Invalid sheet index".to_string()));
// ATTENTION : get_cell_style_index tries to get cell using row and col
// if we invalid row or column is given, it will return index 0.
// Case2 : Invalid Row
let update_result = model.get_cell_style_index(0, 0, 2);
assert_eq!(update_result, Ok(0));
// Case3 : Invalid Column
let update_result = model.get_cell_style_index(0, 1, 1048579);
assert_eq!(update_result, Ok(0));
}
#[test]
fn test_worksheet_update_cell() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result =
model
.workbook
.worksheet_mut(0)
.unwrap()
.update_cell(0, 1, Cell::new_number(10.0, 1));
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result =
model
.workbook
.worksheet_mut(0)
.unwrap()
.update_cell(1, 1048579, Cell::new_number(10.0, 1));
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_set_cell_style() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_style(0, 1, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_style(1, 1048579, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_set_cell_with_formula() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_formula(0, 1, 1, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_formula(1, 1048579, 1, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_set_cell_with_number() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_number(0, 1, 1.0, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_number(1, 1048579, 1.0, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_set_cell_with_string() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_string(0, 1, 1, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_string(1, 1048579, 1, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_set_cell_with_boolean() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_boolean(0, 1, true, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_boolean(1, 1048579, true, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_set_cell_with_error() {
let mut model = new_empty_model();
// Now testing all the possible error scenarios
// Case1: Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_error(0, 1, token::Error::ERROR, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.set_cell_with_error(1, 1048579, token::Error::ERROR, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
}
#[test]
fn test_worksheet_cell_clear_contents() {
let mut model = new_empty_model();
model
.workbook
.worksheet_mut(0)
.unwrap()
.update_cell(1, 1, Cell::new_number(10.0, 1))
.unwrap();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.cell_clear_contents(0, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.cell_clear_contents(1, 1048579);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Valid case
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.cell_clear_contents(1, 1);
assert_eq!(update_result, Ok(()))
}
#[test]
fn test_worksheet_cell_clear_contents_with_style() {
let mut model = new_empty_model();
model
.workbook
.worksheet_mut(0)
.unwrap()
.update_cell(1, 1, Cell::new_number(10.0, 1))
.unwrap();
// Now testing all the possible error scenarios
// Case1 : Invalid Row
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.cell_clear_contents_with_style(0, 1, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case2 : Invalid Column
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.cell_clear_contents_with_style(1, 1048579, 1);
assert_eq!(update_result, Err("Incorrect row or column".to_string()));
// Case3 : Valid case
let update_result = model
.workbook
.worksheet_mut(0)
.unwrap()
.cell_clear_contents_with_style(1, 1, 1);
assert_eq!(update_result, Ok(()))
}
#[test]
fn workbook_styles_get_style_error_handling() {
let model = new_empty_model();
// case 1 : Invalid index
assert_eq!(
model.workbook.styles.get_style(15),
Err("Invalid index provided".to_string())
);
}
#[test]
fn workbook_styles_get_style_without_quote_prefix_error_handling() {
let mut model = new_empty_model();
// case 1 : Invalid index
assert_eq!(
model.workbook.styles.get_style_without_quote_prefix(15),
Err("Invalid index provided".to_string())
);
}
#[test]
fn workbook_styles_get_style_with_format_error_handling() {
let mut model = new_empty_model();
// case 1 : Invalid index
assert_eq!(
model
.workbook
.styles
.get_style_with_format(15, "dummy_num_format"),
Err("Invalid index provided".to_string())
);
}
#[test]
fn workbook_styles_get_style_with_quote_prefix_handling() {
let mut model = new_empty_model();
// case 1 : Invalid index
assert_eq!(
model.workbook.styles.get_style_with_quote_prefix(15),
Err("Invalid index provided".to_string())
);
}

View File

@@ -5,16 +5,28 @@ use crate::{cell::CellValue, test::util::new_empty_model};
#[test]
fn test_currencies() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "$100.348".to_string());
model.set_user_input(0, 1, 2, "=ISNUMBER(A1)".to_string());
model
.set_user_input(0, 1, 1, "$100.348".to_string())
.unwrap();
model
.set_user_input(0, 1, 2, "=ISNUMBER(A1)".to_string())
.unwrap();
model.set_user_input(0, 2, 1, "$ 100.348".to_string());
model.set_user_input(0, 2, 2, "=ISNUMBER(A2)".to_string());
model
.set_user_input(0, 2, 1, "$ 100.348".to_string())
.unwrap();
model
.set_user_input(0, 2, 2, "=ISNUMBER(A2)".to_string())
.unwrap();
model.set_user_input(0, 3, 1, "100$".to_string());
model.set_user_input(0, 3, 2, "=ISNUMBER(A3)".to_string());
model.set_user_input(0, 3, 1, "100$".to_string()).unwrap();
model
.set_user_input(0, 3, 2, "=ISNUMBER(A3)".to_string())
.unwrap();
model.set_user_input(0, 4, 1, "3.1415926$".to_string());
model
.set_user_input(0, 4, 1, "3.1415926$".to_string())
.unwrap();
model.evaluate();
@@ -43,9 +55,9 @@ fn test_currencies() {
#[test]
fn scientific() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "3e-4".to_string());
model.set_user_input(0, 2, 1, "5e-4$".to_string());
model.set_user_input(0, 3, 1, "6e-4%".to_string());
model.set_user_input(0, 1, 1, "3e-4".to_string()).unwrap();
model.set_user_input(0, 2, 1, "5e-4$".to_string()).unwrap();
model.set_user_input(0, 3, 1, "6e-4%".to_string()).unwrap();
model.evaluate();
@@ -61,9 +73,13 @@ fn scientific() {
#[test]
fn test_percentage() {
let mut model = new_empty_model();
model.set_user_input(0, 10, 1, "50%".to_string());
model.set_user_input(0, 10, 2, "=ISNUMBER(A10)".to_string());
model.set_user_input(0, 11, 1, "55.759%".to_string());
model.set_user_input(0, 10, 1, "50%".to_string()).unwrap();
model
.set_user_input(0, 10, 2, "=ISNUMBER(A10)".to_string())
.unwrap();
model
.set_user_input(0, 11, 1, "55.759%".to_string())
.unwrap();
model.evaluate();
@@ -81,8 +97,8 @@ fn test_percentage_ops() {
let mut model = new_empty_model();
model._set("A1", "5%");
model._set("A2", "20%");
model.set_user_input(0, 3, 1, "=A1+A2".to_string());
model.set_user_input(0, 4, 1, "=A1*A2".to_string());
model.set_user_input(0, 3, 1, "=A1+A2".to_string()).unwrap();
model.set_user_input(0, 4, 1, "=A1*A2".to_string()).unwrap();
model.evaluate();
@@ -93,11 +109,19 @@ fn test_percentage_ops() {
#[test]
fn test_numbers() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "1,000,000".to_string());
model
.set_user_input(0, 1, 1, "1,000,000".to_string())
.unwrap();
model.set_user_input(0, 20, 1, "50,123.549".to_string());
model.set_user_input(0, 21, 1, "50,12.549".to_string());
model.set_user_input(0, 22, 1, "1,234567".to_string());
model
.set_user_input(0, 20, 1, "50,123.549".to_string())
.unwrap();
model
.set_user_input(0, 21, 1, "50,12.549".to_string())
.unwrap();
model
.set_user_input(0, 22, 1, "1,234567".to_string())
.unwrap();
model.evaluate();
@@ -131,7 +155,7 @@ fn test_numbers() {
#[test]
fn test_negative_numbers() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "-100".to_string());
model.set_user_input(0, 1, 1, "-100".to_string()).unwrap();
model.evaluate();
@@ -144,15 +168,19 @@ fn test_negative_numbers() {
#[test]
fn test_negative_currencies() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "-$100".to_string());
model.set_user_input(0, 2, 1, "-$99.123".to_string());
model.set_user_input(0, 1, 1, "-$100".to_string()).unwrap();
model
.set_user_input(0, 2, 1, "-$99.123".to_string())
.unwrap();
// This is valid!
model.set_user_input(0, 3, 1, "$-345".to_string());
model.set_user_input(0, 3, 1, "$-345".to_string()).unwrap();
model.set_user_input(0, 1, 2, "-200$".to_string());
model.set_user_input(0, 2, 2, "-92.689$".to_string());
model.set_user_input(0, 1, 2, "-200$".to_string()).unwrap();
model
.set_user_input(0, 2, 2, "-92.689$".to_string())
.unwrap();
// This is valid!
model.set_user_input(0, 3, 2, "-22$".to_string());
model.set_user_input(0, 3, 2, "-22$".to_string()).unwrap();
model.evaluate();
@@ -174,8 +202,10 @@ fn test_formulas() {
let mut model = new_empty_model();
model._set("A1", "$100");
model._set("A2", "$200");
model.set_user_input(0, 3, 1, "=A1+A2".to_string());
model.set_user_input(0, 4, 1, "=SUM(A1:A3)".to_string());
model.set_user_input(0, 3, 1, "=A1+A2".to_string()).unwrap();
model
.set_user_input(0, 4, 1, "=SUM(A1:A3)".to_string())
.unwrap();
model.evaluate();
@@ -198,9 +228,9 @@ fn test_product() {
model._set("A2", "$5");
model._set("A3", "4");
model.set_user_input(0, 1, 2, "=A1*A2".to_string());
model.set_user_input(0, 2, 2, "=A1*A3".to_string());
model.set_user_input(0, 3, 2, "=A1*3".to_string());
model.set_user_input(0, 1, 2, "=A1*A2".to_string()).unwrap();
model.set_user_input(0, 2, 2, "=A1*A3".to_string()).unwrap();
model.set_user_input(0, 3, 2, "=A1*3".to_string()).unwrap();
model.evaluate();
@@ -216,10 +246,12 @@ fn test_division() {
model._set("A2", "$5");
model._set("A3", "4");
model.set_user_input(0, 1, 2, "=A1/A2".to_string());
model.set_user_input(0, 2, 2, "=A1/A3".to_string());
model.set_user_input(0, 3, 2, "=A1/2".to_string());
model.set_user_input(0, 4, 2, "=100/A2".to_string());
model.set_user_input(0, 1, 2, "=A1/A2".to_string()).unwrap();
model.set_user_input(0, 2, 2, "=A1/A3".to_string()).unwrap();
model.set_user_input(0, 3, 2, "=A1/2".to_string()).unwrap();
model
.set_user_input(0, 4, 2, "=100/A2".to_string())
.unwrap();
model.evaluate();
@@ -235,54 +267,54 @@ fn test_some_complex_examples() {
// $3.00 / 2 = $1.50
model._set("A1", "$3.00");
model._set("A2", "2");
model.set_user_input(0, 3, 1, "=A1/A2".to_string());
model.set_user_input(0, 3, 1, "=A1/A2".to_string()).unwrap();
// $3 / 2 = $1
model._set("B1", "$3");
model._set("B2", "2");
model.set_user_input(0, 3, 2, "=B1/B2".to_string());
model.set_user_input(0, 3, 2, "=B1/B2".to_string()).unwrap();
// $5.00 * 25% = 25% * $5.00 = $1.25
model._set("C1", "$5.00");
model._set("C2", "25%");
model.set_user_input(0, 3, 3, "=C1*C2".to_string());
model.set_user_input(0, 4, 3, "=C2*C1".to_string());
model.set_user_input(0, 3, 3, "=C1*C2".to_string()).unwrap();
model.set_user_input(0, 4, 3, "=C2*C1".to_string()).unwrap();
// $5 * 75% = 75% * $5 = $1
model._set("D1", "$5");
model._set("D2", "75%");
model.set_user_input(0, 3, 4, "=D1*D2".to_string());
model.set_user_input(0, 4, 4, "=D2*D1".to_string());
model.set_user_input(0, 3, 4, "=D1*D2".to_string()).unwrap();
model.set_user_input(0, 4, 4, "=D2*D1".to_string()).unwrap();
// $10 + $9.99 = $9.99 + $10 = $19.99
model._set("E1", "$10");
model._set("E2", "$9.99");
model.set_user_input(0, 3, 5, "=E1+E2".to_string());
model.set_user_input(0, 4, 5, "=E2+E1".to_string());
model.set_user_input(0, 3, 5, "=E1+E2".to_string()).unwrap();
model.set_user_input(0, 4, 5, "=E2+E1".to_string()).unwrap();
// $2 * 2 = 2 * $2 = $4
model._set("F1", "$2");
model._set("F2", "2");
model.set_user_input(0, 3, 6, "=F1*F2".to_string());
model.set_user_input(0, 4, 6, "=F2*F1".to_string());
model.set_user_input(0, 3, 6, "=F1*F2".to_string()).unwrap();
model.set_user_input(0, 4, 6, "=F2*F1".to_string()).unwrap();
// $2.50 * 2 = 2 * $2.50 = $5.00
model._set("G1", "$2.50");
model._set("G2", "2");
model.set_user_input(0, 3, 7, "=G1*G2".to_string());
model.set_user_input(0, 4, 7, "=G2*G1".to_string());
model.set_user_input(0, 3, 7, "=G1*G2".to_string()).unwrap();
model.set_user_input(0, 4, 7, "=G2*G1".to_string()).unwrap();
// $2 * 2.5 = 2.5 * $2 = $5
model._set("H1", "$2");
model._set("H2", "2.5");
model.set_user_input(0, 3, 8, "=H1*H2".to_string());
model.set_user_input(0, 4, 8, "=H2*H1".to_string());
model.set_user_input(0, 3, 8, "=H1*H2".to_string()).unwrap();
model.set_user_input(0, 4, 8, "=H2*H1".to_string()).unwrap();
// 10% * 1,000 = 1,000 * 10% = 100
model._set("I1", "10%");
model._set("I2", "1,000");
model.set_user_input(0, 3, 9, "=I1*I2".to_string());
model.set_user_input(0, 4, 9, "=I2*I1".to_string());
model.set_user_input(0, 3, 9, "=I1*I2".to_string()).unwrap();
model.set_user_input(0, 4, 9, "=I2*I1".to_string()).unwrap();
model.evaluate();
@@ -320,9 +352,15 @@ fn test_financial_functions() {
model._set("A3", "10");
model._set("A4", "$10,000");
model.set_user_input(0, 5, 1, "=PMT(A2/12,A3,A4)".to_string());
model.set_user_input(0, 6, 1, "=PMT(A2/12,A3,A4,,1)".to_string());
model.set_user_input(0, 7, 1, "=PMT(0.2, 3, -200)".to_string());
model
.set_user_input(0, 5, 1, "=PMT(A2/12,A3,A4)".to_string())
.unwrap();
model
.set_user_input(0, 6, 1, "=PMT(A2/12,A3,A4,,1)".to_string())
.unwrap();
model
.set_user_input(0, 7, 1, "=PMT(0.2, 3, -200)".to_string())
.unwrap();
model.evaluate();
@@ -339,9 +377,15 @@ fn test_sum_function() {
model._set("A1", "$100");
model._set("A2", "$300");
model.set_user_input(0, 1, 2, "=SUM(A:A)".to_string());
model.set_user_input(0, 2, 2, "=SUM(A1:A2)".to_string());
model.set_user_input(0, 3, 2, "=SUM(A1, A2, A3)".to_string());
model
.set_user_input(0, 1, 2, "=SUM(A:A)".to_string())
.unwrap();
model
.set_user_input(0, 2, 2, "=SUM(A1:A2)".to_string())
.unwrap();
model
.set_user_input(0, 3, 2, "=SUM(A1, A2, A3)".to_string())
.unwrap();
model.evaluate();
@@ -353,7 +397,7 @@ fn test_sum_function() {
#[test]
fn test_number() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "3".to_string());
model.set_user_input(0, 1, 1, "3".to_string()).unwrap();
model.evaluate();
@@ -367,7 +411,9 @@ fn test_number() {
#[test]
fn test_currencies_eur_prefix() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "€100.348".to_string());
model
.set_user_input(0, 1, 1, "€100.348".to_string())
.unwrap();
model.evaluate();
@@ -381,19 +427,27 @@ fn test_currencies_eur_prefix() {
#[test]
fn test_currencies_eur_suffix() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "100.348€".to_string());
model.set_user_input(0, 2, 1, "25".to_string());
model
.set_user_input(0, 1, 1, "100.348".to_string())
.unwrap();
model.set_user_input(0, 2, 1, "25€".to_string()).unwrap();
// negatives
model.set_user_input(0, 1, 2, "-123.348€".to_string());
model.set_user_input(0, 2, 2, "-42".to_string());
model
.set_user_input(0, 1, 2, "-123.348".to_string())
.unwrap();
model.set_user_input(0, 2, 2, "-42€".to_string()).unwrap();
// with a space
model.set_user_input(0, 1, 3, "101.348 €".to_string());
model.set_user_input(0, 2, 3, "26".to_string());
model
.set_user_input(0, 1, 3, "101.348".to_string())
.unwrap();
model.set_user_input(0, 2, 3, "26 €".to_string()).unwrap();
model.set_user_input(0, 1, 4, "-12.348 €".to_string());
model.set_user_input(0, 2, 4, "-45".to_string());
model
.set_user_input(0, 1, 4, "-12.348".to_string())
.unwrap();
model.set_user_input(0, 2, 4, "-45 €".to_string()).unwrap();
model.evaluate();
@@ -449,9 +503,15 @@ fn test_sum_function_eur() {
model._set("A1", "€100");
model._set("A2", "€300");
model.set_user_input(0, 1, 2, "=SUM(A:A)".to_string());
model.set_user_input(0, 2, 2, "=SUM(A1:A2)".to_string());
model.set_user_input(0, 3, 2, "=SUM(A1, A2, A3)".to_string());
model
.set_user_input(0, 1, 2, "=SUM(A:A)".to_string())
.unwrap();
model
.set_user_input(0, 2, 2, "=SUM(A1:A2)".to_string())
.unwrap();
model
.set_user_input(0, 3, 2, "=SUM(A1, A2, A3)".to_string())
.unwrap();
model.evaluate();
@@ -463,7 +523,9 @@ fn test_sum_function_eur() {
#[test]
fn input_dates() {
let mut model = new_empty_model();
model.set_user_input(0, 1, 1, "3/4/2025".to_string());
model
.set_user_input(0, 1, 1, "3/4/2025".to_string())
.unwrap();
model.evaluate();
@@ -474,7 +536,9 @@ fn input_dates() {
);
// further date assignments do not change the format
model.set_user_input(0, 1, 1, "08-08-2028".to_string());
model
.set_user_input(0, 1, 1, "08-08-2028".to_string())
.unwrap();
model.evaluate();
assert_eq!(model._get_text("A1"), "8/8/2028");
}

View File

@@ -14,7 +14,7 @@ fn test_sheet_markup() {
model._set("A4", "Total");
model._set("B4", "=SUM(B2:B3)");
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
style.font.b = true;
model.set_cell_style(0, 1, 1, &style).unwrap();
model.set_cell_style(0, 1, 2, &style).unwrap();

View File

@@ -138,14 +138,14 @@ fn test_insert_sheet() {
// Insert the sheet at the end and check the formula
assert!(model.insert_sheet("Bacchus", 1, None).is_ok());
model.set_user_input(1, 3, 1, "42".to_string());
model.set_user_input(1, 3, 1, "42".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("A1"), "42");
assert_eq!(model._get_text("A2"), "#REF!");
// Insert a sheet in between the other two
assert!(model.insert_sheet("Dionysus", 1, None).is_ok());
model.set_user_input(1, 3, 1, "111".to_string());
model.set_user_input(1, 3, 1, "111".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("A1"), "42");
assert_eq!(model._get_text("A2"), "111");
@@ -176,7 +176,7 @@ fn test_rename_sheet() {
let mut model = new_empty_model();
model.new_sheet();
model._set("A1", "=NewSheet!A3");
model.set_user_input(1, 3, 1, "25".to_string());
model.set_user_input(1, 3, 1, "25".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("A1"), "#REF!");
assert!(model.rename_sheet("Sheet2", "NewSheet").is_ok());
@@ -189,7 +189,7 @@ fn test_rename_sheet_by_index() {
let mut model = new_empty_model();
model.new_sheet();
model._set("A1", "=NewSheet!A1");
model.set_user_input(1, 1, 1, "25".to_string());
model.set_user_input(1, 1, 1, "25".to_string()).unwrap();
model.evaluate();
assert_eq!(model._get_text("A1"), "#REF!");
assert!(model.rename_sheet_by_index(1, "NewSheet").is_ok());

View File

@@ -7,10 +7,10 @@ use crate::types::Style;
fn test_model_set_cells_with_values_styles() {
let mut model = new_empty_model();
// Inputs
model.set_user_input(0, 1, 1, "21".to_string()); // A1
model.set_user_input(0, 2, 1, "42".to_string()); // A2
model.set_user_input(0, 1, 1, "21".to_string()).unwrap(); // A1
model.set_user_input(0, 2, 1, "42".to_string()).unwrap(); // A2
let style_base = model.get_style_for_cell(0, 1, 1);
let style_base = model.get_style_for_cell(0, 1, 1).unwrap();
let mut style = style_base.clone();
style.font.b = true;
style.num_fmt = "#,##0.00".to_string();
@@ -19,7 +19,7 @@ fn test_model_set_cells_with_values_styles() {
let mut style = style_base;
style.num_fmt = "#,##0.00".to_string();
assert!(model.set_cell_style(0, 2, 1, &style).is_ok());
let style: Style = model.get_style_for_cell(0, 2, 1);
let style: Style = model.get_style_for_cell(0, 2, 1).unwrap();
assert_eq!(style.num_fmt, "#,##0.00".to_string());
}
@@ -27,21 +27,21 @@ fn test_model_set_cells_with_values_styles() {
fn test_named_styles() {
let mut model = new_empty_model();
model._set("A1", "42");
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
style.font.b = true;
assert!(model.set_cell_style(0, 1, 1, &style).is_ok());
let bold_style_index = model.get_cell_style_index(0, 1, 1);
let bold_style_index = model.get_cell_style_index(0, 1, 1).unwrap();
let e = model
.workbook
.styles
.add_named_cell_style("bold", bold_style_index);
assert!(e.is_ok());
model._set("A2", "420");
let a2_style_index = model.get_cell_style_index(0, 2, 1);
let a2_style_index = model.get_cell_style_index(0, 2, 1).unwrap();
assert!(a2_style_index != bold_style_index);
let e = model.set_cell_style_by_name(0, 2, 1, "bold");
assert!(e.is_ok());
assert_eq!(model.get_cell_style_index(0, 2, 1), bold_style_index);
assert_eq!(model.get_cell_style_index(0, 2, 1), Ok(bold_style_index));
}
#[test]
@@ -49,7 +49,7 @@ fn test_create_named_style() {
let mut model = new_empty_model();
model._set("A1", "42");
let mut style = model.get_style_for_cell(0, 1, 1);
let mut style = model.get_style_for_cell(0, 1, 1).unwrap();
assert!(!style.font.b);
style.font.b = true;
@@ -59,6 +59,6 @@ fn test_create_named_style() {
let e = model.set_cell_style_by_name(0, 1, 1, "bold");
assert!(e.is_ok());
let style = model.get_style_for_cell(0, 1, 1);
let style = model.get_style_for_cell(0, 1, 1).unwrap();
assert!(style.font.b);
}

View File

@@ -100,7 +100,9 @@ fn test_worksheet_dimension_progressive() {
}
);
model.set_user_input(0, 30, 50, "Hello World".to_string());
model
.set_user_input(0, 30, 50, "Hello World".to_string())
.unwrap();
assert_eq!(
model.workbook.worksheet(0).unwrap().dimension(),
WorksheetDimension {
@@ -111,7 +113,9 @@ fn test_worksheet_dimension_progressive() {
}
);
model.set_user_input(0, 10, 15, "Hello World".to_string());
model
.set_user_input(0, 10, 15, "Hello World".to_string())
.unwrap();
assert_eq!(
model.workbook.worksheet(0).unwrap().dimension(),
WorksheetDimension {
@@ -122,7 +126,9 @@ fn test_worksheet_dimension_progressive() {
}
);
model.set_user_input(0, 5, 25, "Hello World".to_string());
model
.set_user_input(0, 5, 25, "Hello World".to_string())
.unwrap();
assert_eq!(
model.workbook.worksheet(0).unwrap().dimension(),
WorksheetDimension {
@@ -133,7 +139,9 @@ fn test_worksheet_dimension_progressive() {
}
);
model.set_user_input(0, 10, 250, "Hello World".to_string());
model
.set_user_input(0, 10, 250, "Hello World".to_string())
.unwrap();
assert_eq!(
model.workbook.worksheet(0).unwrap().dimension(),
WorksheetDimension {
@@ -162,12 +170,14 @@ fn test_worksheet_navigate_to_edge_in_direction() {
for (row_index, row) in inline_spreadsheet.into_iter().enumerate() {
for (column_index, value) in row.into_iter().enumerate() {
if value != 0 {
model.update_cell_with_number(
0,
(row_index as i32) + 1,
(column_index as i32) + 1,
value.into(),
);
model
.update_cell_with_number(
0,
(row_index as i32) + 1,
(column_index as i32) + 1,
value.into(),
)
.unwrap();
}
}
}

View File

@@ -1,14 +1,20 @@
mod test_add_delete_sheets;
mod test_autofill_columns;
mod test_autofill_rows;
mod test_border;
mod test_clear_cells;
mod test_diff_queue;
mod test_evaluation;
mod test_general;
mod test_grid_lines;
mod test_keyboard_navigation;
mod test_on_area_selection;
mod test_on_expand_selected_range;
mod test_on_paste_styles;
mod test_rename_sheet;
mod test_row_column;
mod test_styles;
mod test_to_from_bytes;
mod test_undo_redo;
mod test_view;
mod test_window_size;

View File

@@ -82,3 +82,15 @@ fn delete_sheet_propagates() {
let sheets_info = model2.get_worksheets_properties();
assert_eq!(sheets_info.len(), 1);
}
#[test]
fn delete_last_sheet() {
// Deleting the last sheet, selects the previous
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
model.new_sheet();
model.new_sheet();
model.set_selected_sheet(2).unwrap();
model.delete_sheet(2).unwrap();
assert_eq!(model.get_selected_sheet(), 1);
}

View File

@@ -0,0 +1,416 @@
#![allow(clippy::unwrap_used)]
use crate::{
expressions::{types::Area, utils::number_to_column},
types::{Border, BorderItem, BorderStyle},
BorderArea, UserModel,
};
#[test]
fn borders_all() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "All"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
for row in 5..9 {
for column in 6..9 {
let style = model.get_cell_style(0, row, column).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: Some(border_item.clone()),
right: Some(border_item.clone()),
top: Some(border_item.clone()),
bottom: Some(border_item.clone()),
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
// Lets remove all of them:
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "None"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
for row in 5..9 {
for column in 6..9 {
let style = model.get_cell_style(0, row, column).unwrap();
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: None,
right: None,
top: None,
bottom: None,
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
}
#[test]
fn borders_inner() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "Inner"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
// The inner part all have borders
for row in 6..8 {
for column in 7..8 {
let style = model.get_cell_style(0, row, column).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: Some(border_item.clone()),
right: Some(border_item.clone()),
top: Some(border_item.clone()),
bottom: Some(border_item.clone()),
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
// F5 has border only left and bottom
{
// We check the border on F5
let style = model.get_cell_style(0, 5, 6).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
// It should be right and bottom
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: None,
right: Some(border_item.clone()),
top: None,
bottom: Some(border_item),
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
{
// Then let's try the bottom-right border
let style = model.get_cell_style(0, 8, 8).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
// It should be only left and top
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: Some(border_item.clone()),
right: None,
top: Some(border_item.clone()),
bottom: None,
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
#[test]
fn borders_outer() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "Outer"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
{
// We check the border on F5
let style = model.get_cell_style(0, 5, 6).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
// It should be only left and top
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: Some(border_item.clone()),
right: None,
top: Some(border_item),
bottom: None,
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
{
// Then let's try the bottom-right border
let style = model.get_cell_style(0, 8, 8).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
// It should be only left and top
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: None,
right: Some(border_item.clone()),
top: None,
bottom: Some(border_item.clone()),
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
#[test]
fn borders_top() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "Top"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
for row in 5..9 {
for column in 6..9 {
let style = model.get_cell_style(0, row, column).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: None,
right: None,
top: Some(border_item.clone()),
bottom: None,
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
}
#[test]
fn borders_right() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "Right"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
for row in 5..9 {
for column in 6..9 {
let style = model.get_cell_style(0, row, column).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: None,
right: Some(border_item.clone()),
top: None,
bottom: None,
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
}
#[test]
fn borders_bottom() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "Bottom"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
for row in 5..9 {
for column in 6..9 {
let style = model.get_cell_style(0, row, column).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: None,
right: None,
top: None,
bottom: Some(border_item.clone()),
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
}
#[test]
fn borders_left() {
let mut model = UserModel::new_empty("model", "en", "UTC").unwrap();
// We set an outer border in cells F5:H9
let range = &Area {
sheet: 0,
row: 5,
column: 6,
width: 3,
height: 4,
};
assert_eq!(number_to_column(6).unwrap(), "F");
assert_eq!(number_to_column(8).unwrap(), "H");
// ATM we don't have a way to create the object from Rust, that's ok.
let border_area: BorderArea = serde_json::from_str(
r##"{
"item": {
"style": "thin",
"color": "#FF5566"
},
"type": "Left"
}"##,
)
.unwrap();
model.set_area_with_border(range, &border_area).unwrap();
for row in 5..9 {
for column in 6..9 {
let style = model.get_cell_style(0, row, column).unwrap();
let border_item = BorderItem {
style: BorderStyle::Thin,
color: Some("#FF5566".to_string()),
};
let expected_border = Border {
diagonal_up: false,
diagonal_down: false,
left: Some(border_item.clone()),
right: None,
top: None,
bottom: None,
diagonal: None,
};
assert_eq!(style.border, expected_border);
}
}
}

View File

@@ -0,0 +1,136 @@
#![allow(clippy::unwrap_used)]
use crate::{
constants::{
DEFAULT_COLUMN_WIDTH, DEFAULT_ROW_HEIGHT, DEFAULT_WINDOW_HEIGH, DEFAULT_WINDOW_WIDTH,
LAST_COLUMN,
},
test::util::new_empty_model,
UserModel,
};
#[test]
fn basic_navigation() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_arrow_right().unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 2, 1, 2]);
assert_eq!(view.column, 2);
assert_eq!(view.row, 1);
model.on_arrow_left().unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 1, 1]);
assert_eq!(view.column, 1);
assert_eq!(view.row, 1);
model.on_arrow_left().unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 1, 1]);
assert_eq!(view.column, 1);
assert_eq!(view.row, 1);
model.on_arrow_down().unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [2, 1, 2, 1]);
assert_eq!(view.column, 1);
assert_eq!(view.row, 2);
model.on_arrow_up().unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 1, 1]);
assert_eq!(view.column, 1);
assert_eq!(view.row, 1);
model.on_arrow_up().unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 1, 1]);
assert_eq!(view.column, 1);
assert_eq!(view.row, 1);
}
#[test]
fn scroll_right() {
let window_width = DEFAULT_WINDOW_WIDTH as f64;
let column_width = DEFAULT_COLUMN_WIDTH;
let column_count = f64::floor(window_width / column_width) as i32;
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_arrow_right().unwrap();
model.set_selected_cell(3, column_count).unwrap();
model.on_arrow_right().unwrap();
let view = model.get_selected_view();
assert_eq!(view.left_column, 2);
model.on_arrow_right().unwrap();
let view = model.get_selected_view();
assert_eq!(view.left_column, 3);
}
#[test]
fn last_colum() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.set_selected_cell(3, LAST_COLUMN).unwrap();
let view = model.get_selected_view();
assert_eq!(view.column, LAST_COLUMN);
model.on_arrow_right().unwrap();
let view = model.get_selected_view();
assert_eq!(view.column, LAST_COLUMN);
}
#[test]
fn page_down() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
let window_height = DEFAULT_WINDOW_HEIGH as f64;
let row_height = DEFAULT_ROW_HEIGHT;
let row_count = f64::floor(window_height / row_height) as i32;
model.on_page_down().unwrap();
let view = model.get_selected_view();
assert_eq!(view.row, 1 + row_count);
let scroll_y = model.get_scroll_y().unwrap();
assert_eq!(scroll_y, (row_count as f64) * DEFAULT_ROW_HEIGHT);
}
// we just test that page up and page down are inverse operations
#[test]
fn page_up() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_page_down().unwrap();
let row1 = model.get_selected_view().row;
model.on_page_down().unwrap();
let row2 = model.get_selected_view().row;
model.on_page_down().unwrap();
let row3 = model.get_selected_view().row;
model.on_page_down().unwrap();
model.on_page_up().unwrap();
assert_eq!(model.get_selected_view().row, row3);
model.on_page_up().unwrap();
assert_eq!(model.get_selected_view().row, row2);
model.on_page_up().unwrap();
assert_eq!(model.get_selected_view().row, row1);
model.on_page_up().unwrap();
assert_eq!(model.get_selected_view().row, 1);
}
#[test]
fn page_up_fails_on_row1() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_arrow_up().unwrap();
assert_eq!(model.get_selected_view().row, 1);
}

View File

@@ -0,0 +1,33 @@
#![allow(clippy::unwrap_used)]
use crate::{
constants::{DEFAULT_COLUMN_WIDTH, DEFAULT_WINDOW_WIDTH},
test::util::new_empty_model,
UserModel,
};
#[test]
fn basic_test() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_area_selecting(2, 4).unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 2, 4]);
}
// this checks that is we select in the boundary we automatically scroll
#[test]
fn scroll_right() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
let window_width = DEFAULT_WINDOW_WIDTH as f64;
let column_width = DEFAULT_COLUMN_WIDTH;
let column_count = f64::floor(window_width / column_width) as i32;
model.set_selected_cell(3, column_count).unwrap();
model.on_area_selecting(3, column_count + 3).unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [3, column_count, 3, column_count + 3]);
assert_eq!(view.left_column, 4);
}

View File

@@ -0,0 +1,151 @@
#![allow(clippy::unwrap_used)]
use crate::{
constants::{DEFAULT_COLUMN_WIDTH, DEFAULT_WINDOW_WIDTH, LAST_COLUMN},
test::util::new_empty_model,
UserModel,
};
#[test]
fn arrow_right() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_expand_selected_range("ArrowRight").unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 1, 2]);
}
#[test]
fn arrow_right_decreases() {
// if the selected cell is on the upper right corner, right-arrow will decrease the size of teh area
let model = new_empty_model();
let mut model = UserModel::from_model(model);
let (start_row, start_column, end_row, end_column) = (5, 3, 10, 8);
model.set_selected_cell(start_row, end_column).unwrap();
model
.set_selected_range(start_row, start_column, end_row, end_column)
.unwrap();
model.on_expand_selected_range("ArrowRight").unwrap();
let view = model.get_selected_view();
assert_eq!(
view.range,
[start_row, start_column + 1, end_row, end_column]
);
}
#[test]
fn arrow_right_last_column() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.set_selected_cell(1, LAST_COLUMN).unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, LAST_COLUMN, 1, LAST_COLUMN]);
}
#[test]
fn arrow_right_scroll_right() {
let window_width = DEFAULT_WINDOW_WIDTH as f64;
let column_width = DEFAULT_COLUMN_WIDTH;
let column_count = f64::floor(window_width / column_width) as i32;
let model = new_empty_model();
let mut model = UserModel::from_model(model);
// initially the column to the left is A
let view = model.get_selected_view();
assert_eq!(view.left_column, 1);
// We select all columns from 1 to the last visible
let (start_row, start_column, end_row, end_column) = (1, 1, 1, column_count);
model.set_selected_cell(start_row, start_column).unwrap();
model
.set_selected_range(start_row, start_column, end_row, end_column)
.unwrap();
// Now we select one more column
model.on_expand_selected_range("ArrowRight").unwrap();
// The view has updated and the first visible column is B
let view = model.get_selected_view();
assert_eq!(
view.range,
[start_row, start_column, end_row, end_column + 1]
);
assert_eq!(view.left_column, 2);
// now we click on cell B2 and we
model.set_selected_cell(2, 2).unwrap();
model.on_expand_selected_range("ArrowLeft").unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [2, 1, 2, 2]);
assert_eq!(view.left_column, 1);
// a second arrow left won't do anything
model.on_expand_selected_range("ArrowLeft").unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [2, 1, 2, 2]);
assert_eq!(view.left_column, 1);
}
#[test]
fn arrow_left() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.set_selected_cell(5, 3).unwrap();
model.set_selected_range(5, 3, 10, 8).unwrap();
model.on_expand_selected_range("ArrowLeft").unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [5, 3, 10, 7]);
}
#[test]
fn arrow_left_left_border() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.on_expand_selected_range("ArrowLeft").unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 1, 1, 1]);
}
#[test]
fn arrow_left_increases() {
// If the selected cell is on the top right corner
// arrow left increases the selected area by
let model = new_empty_model();
let mut model = UserModel::from_model(model);
let (start_row, start_column, end_row, end_column) = (4, 10, 4, 20);
model.set_selected_cell(start_row, end_column).unwrap();
model
.set_selected_range(start_row, start_column, end_row, end_column)
.unwrap();
model.on_expand_selected_range("ArrowLeft").unwrap();
let view = model.get_selected_view();
assert_eq!(
view.range,
[start_row, start_column - 1, end_row, end_column]
);
}
#[test]
fn arrow_left_scrolls_left() {
// If the selected cell is on the top right corner
// arrow left increases the selected area by
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.set_top_left_visible_cell(1, 50).unwrap();
model.set_selected_cell(1, 50).unwrap();
// arrow left x 2
model.on_expand_selected_range("ArrowLeft").unwrap();
model.on_expand_selected_range("ArrowLeft").unwrap();
let view = model.get_selected_view();
assert_eq!(view.range, [1, 48, 1, 50]);
assert_eq!(view.left_column, 48);
assert_eq!(view.column, 50);
}

View File

@@ -0,0 +1,48 @@
#![allow(clippy::unwrap_used)]
use crate::test::util::new_empty_model;
use crate::types::Fill;
use crate::UserModel;
#[test]
fn simple_pasting() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
let mut style = model.get_cell_style(0, 1, 1).unwrap();
style.fill = Fill {
pattern_type: "solid".to_string(),
fg_color: Some("#FF5577".to_string()),
bg_color: Some("#33FF44".to_string()),
};
let styles = vec![vec![style.clone()]];
model.set_selected_cell(5, 4).unwrap();
model.set_selected_range(5, 4, 10, 9).unwrap();
model.on_paste_styles(&styles).unwrap();
for row in 5..10 {
for column in 4..9 {
let cell_style = model.get_cell_style(0, row, column).unwrap();
assert_eq!(cell_style, style);
}
}
model.undo().unwrap();
let base_style = model.get_cell_style(0, 100, 100).unwrap();
for row in 5..10 {
for column in 4..9 {
let cell_style = model.get_cell_style(0, row, column).unwrap();
assert_eq!(cell_style, base_style);
}
}
model.redo().unwrap();
for row in 5..10 {
for column in 4..9 {
let cell_style = model.get_cell_style(0, row, column).unwrap();
assert_eq!(cell_style, style);
}
}
}

View File

@@ -52,19 +52,12 @@ fn set_the_cell_sets_the_range() {
fn set_the_range_does_not_set_the_cell() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
model.set_selected_range(5, 4, 10, 6).unwrap();
assert_eq!(model.get_selected_sheet(), 0);
assert_eq!(model.get_selected_cell(), (0, 1, 1));
assert_eq!(
model.get_selected_view(),
SelectedView {
sheet: 0,
row: 1,
column: 1,
range: [5, 4, 10, 6],
top_row: 1,
left_column: 1
}
model.set_selected_range(5, 4, 10, 6),
Err(
"The selected cells is not in one of the corners. Row: '1' and row range '(5, 10)'"
.to_string()
)
);
}

View File

@@ -0,0 +1,29 @@
#![allow(clippy::unwrap_used)]
use crate::{
constants::{DEFAULT_ROW_HEIGHT, DEFAULT_WINDOW_HEIGH, DEFAULT_WINDOW_WIDTH},
test::util::new_empty_model,
UserModel,
};
#[test]
fn basic_test() {
let model = new_empty_model();
let mut model = UserModel::from_model(model);
let window_height = model.get_window_height().unwrap();
assert_eq!(window_height, DEFAULT_WINDOW_HEIGH);
let window_width = model.get_window_width().unwrap();
assert_eq!(window_width, DEFAULT_WINDOW_WIDTH);
// Set the window height to double the default and check that page_down behaves as expected
model.set_window_height((window_height * 2) as f64);
model.on_page_down().unwrap();
let row_height = DEFAULT_ROW_HEIGHT;
let row_count = f64::floor((window_height * 2) as f64 / row_height) as i32;
let view = model.get_selected_view();
assert_eq!(view.row, 1 + row_count);
let scroll_y = model.get_scroll_y().unwrap();
assert_eq!(scroll_y, (row_count as f64) * DEFAULT_ROW_HEIGHT);
}

View File

@@ -20,7 +20,8 @@ impl Model {
let cell_reference = self._parse_reference(cell);
let column = cell_reference.column;
let row = cell_reference.row;
self.set_user_input(cell_reference.sheet, row, column, value.to_string());
self.set_user_input(cell_reference.sheet, row, column, value.to_string())
.unwrap();
}
pub fn _has_formula(&self, cell: &str) -> bool {
self._get_formula_opt(cell).is_some()

View File

@@ -86,12 +86,15 @@ fn get_units_from_format_string(num_fmt: &str) -> Option<Units> {
impl Model {
fn compute_cell_units(&self, cell_reference: &CellReferenceIndex) -> Option<Units> {
let style = &self.get_style_for_cell(
let cell_style_res = &self.get_style_for_cell(
cell_reference.sheet,
cell_reference.row,
cell_reference.column,
);
get_units_from_format_string(&style.num_fmt)
match cell_style_res {
Ok(style) => get_units_from_format_string(&style.num_fmt),
Err(_) => None,
}
}
pub(crate) fn compute_node_units(

View File

@@ -205,6 +205,16 @@ impl UserModel {
self.model.to_bytes()
}
/// Returns the workbook name
pub fn get_name(&self) -> String {
self.model.workbook.name.clone()
}
/// Sets the name of a workbook
pub fn set_name(&mut self, name: &str) {
self.model.workbook.name = name.to_string();
}
/// Undoes last change if any, places the change in the redo list and evaluates the model if needed
///
/// See also:
@@ -331,7 +341,7 @@ impl UserModel {
.cell(row, column)
.cloned();
self.model
.set_user_input(sheet, row, column, value.to_string());
.set_user_input(sheet, row, column, value.to_string())?;
self.evaluate_if_not_paused();
@@ -394,6 +404,14 @@ impl UserModel {
self.push_diff_list(vec![Diff::DeleteSheet { sheet }]);
// There is no coming back
self.history.clear();
let sheet_count = self.model.workbook.worksheets.len() as u32;
// If we are deleting the last sheet we need to change the selected sheet
if sheet == sheet_count - 1 && sheet_count > 1 {
if let Some(view) = self.model.workbook.views.get_mut(&self.model.view_id) {
view.sheet = sheet_count - 2;
};
}
self.model.delete_sheet(sheet)?;
Ok(())
}
@@ -449,7 +467,7 @@ impl UserModel {
.worksheet(sheet)?
.cell(row, column)
.cloned();
let old_style = self.model.get_style_for_cell(sheet, row, column);
let old_style = self.model.get_style_for_cell(sheet, row, column)?;
self.model.cell_clear_all(sheet, row, column)?;
diff_list.push(Diff::CellClearAll {
sheet,
@@ -712,7 +730,7 @@ impl UserModel {
let row_index = ((row - row_start) % styles_heigh) as usize;
let column_index = ((column - column_start) % styles_width) as usize;
let style = &styles[row_index][column_index];
let old_value = self.model.get_style_for_cell(sheet, row, column);
let old_value = self.model.get_style_for_cell(sheet, row, column)?;
self.model.set_cell_style(sheet, row, column, style)?;
diff_list.push(Diff::SetCellStyle {
sheet,
@@ -740,13 +758,14 @@ impl UserModel {
range: &Area,
border_area: &BorderArea,
) -> Result<(), String> {
// FIXME: We need to set the border also in neighbouring cells.
let sheet = range.sheet;
let mut diff_list = Vec::new();
let last_row = range.row + range.height - 1;
let last_column = range.column + range.width - 1;
for row in range.row..=last_row {
for column in range.column..=last_column {
let old_value = self.model.get_style_for_cell(sheet, row, column);
let old_value = self.model.get_style_for_cell(sheet, row, column)?;
let mut style = old_value.clone();
// First remove all existing borders
@@ -843,7 +862,7 @@ impl UserModel {
let mut diff_list = Vec::new();
for row in range.row..range.row + range.height {
for column in range.column..range.column + range.width {
let old_value = self.model.get_style_for_cell(sheet, row, column);
let old_value = self.model.get_style_for_cell(sheet, row, column)?;
let mut style = old_value.clone();
match style_path {
"font.b" => {
@@ -942,7 +961,7 @@ impl UserModel {
/// * [Model::get_style_for_cell]
#[inline]
pub fn get_cell_style(&mut self, sheet: u32, row: i32, column: i32) -> Result<Style, String> {
Ok(self.model.get_style_for_cell(sheet, row, column))
self.model.get_style_for_cell(sheet, row, column)
}
/// Fills the cells from `source_area` until `to_row`.
@@ -1008,7 +1027,7 @@ impl UserModel {
.worksheet(sheet)?
.cell(row, column)
.cloned();
let old_style = self.model.get_style_for_cell(sheet, row, column);
let old_style = self.model.get_style_for_cell(sheet, row, column)?;
// compute the new value and set it
let source_row = anchor_row + index;
@@ -1016,10 +1035,10 @@ impl UserModel {
.model
.extend_to(sheet, source_row, column, row, column)?;
self.model
.set_user_input(sheet, row, column, target_value.to_string());
.set_user_input(sheet, row, column, target_value.to_string())?;
// Compute the new style and set it
let new_style = self.model.get_style_for_cell(sheet, source_row, column);
let new_style = self.model.get_style_for_cell(sheet, source_row, column)?;
self.model.set_cell_style(sheet, row, column, &new_style)?;
// Add the diffs
@@ -1109,7 +1128,7 @@ impl UserModel {
.worksheet(sheet)?
.cell(row, column)
.cloned();
let old_style = self.model.get_style_for_cell(sheet, row, column);
let old_style = self.model.get_style_for_cell(sheet, row, column)?;
// compute the new value and set it
let source_column = anchor_column + index;
@@ -1117,10 +1136,10 @@ impl UserModel {
.model
.extend_to(sheet, row, source_column, row, column)?;
self.model
.set_user_input(sheet, row, column, target_value.to_string());
.set_user_input(sheet, row, column, target_value.to_string())?;
// Compute the new style and set it
let new_style = self.model.get_style_for_cell(sheet, row, source_column);
let new_style = self.model.get_style_for_cell(sheet, row, source_column)?;
self.model.set_cell_style(sheet, row, column, &new_style)?;
// Add the diffs
@@ -1207,7 +1226,7 @@ impl UserModel {
self.model
.workbook
.worksheet_mut(*sheet)?
.update_cell(*row, *column, value);
.update_cell(*row, *column, value)?;
}
None => {
self.model.cell_clear_all(*sheet, *row, *column)?;
@@ -1237,7 +1256,7 @@ impl UserModel {
self.model
.workbook
.worksheet_mut(*sheet)?
.update_cell(*row, *column, value);
.update_cell(*row, *column, value)?;
}
}
Diff::CellClearAll {
@@ -1252,7 +1271,7 @@ impl UserModel {
self.model
.workbook
.worksheet_mut(*sheet)?
.update_cell(*row, *column, value);
.update_cell(*row, *column, value)?;
self.model
.set_cell_style(*sheet, *row, *column, old_style)?;
}
@@ -1298,7 +1317,7 @@ impl UserModel {
// puts all the data back
let worksheet = self.model.workbook.worksheet_mut(*sheet)?;
for (row, cell) in &old_data.data {
worksheet.update_cell(*row, *column, cell.clone());
worksheet.update_cell(*row, *column, cell.clone())?;
}
// makes sure that the width and style is correct
if let Some(col) = &old_data.column {
@@ -1366,7 +1385,7 @@ impl UserModel {
} => {
needs_evaluation = true;
self.model
.set_user_input(*sheet, *row, *column, new_value.to_string());
.set_user_input(*sheet, *row, *column, new_value.to_string())?;
}
Diff::SetColumnWidth {
sheet,

View File

@@ -84,7 +84,7 @@ impl UserModel {
Ok(())
}
/// Sets the selected cell
/// Sets the selected cell for the current view. Note that this also sets the selected range
pub fn set_selected_cell(&mut self, row: i32, column: i32) -> Result<(), String> {
let sheet = if let Some(view) = self.model.workbook.views.get(&self.model.view_id) {
view.sheet
@@ -110,7 +110,7 @@ impl UserModel {
Ok(())
}
/// Sets the selected range
/// Sets the selected range. Note that the selected cell must be in one of the corners.
pub fn set_selected_range(
&mut self,
start_row: i32,
@@ -142,6 +142,21 @@ impl UserModel {
}
if let Ok(worksheet) = self.model.workbook.worksheet_mut(sheet) {
if let Some(view) = worksheet.views.get_mut(&0) {
let selected_row = view.row;
let selected_column = view.column;
// The selected cells must be on one of the corners of the selected range:
if selected_row != start_row && selected_row != end_row {
return Err(format!(
"The selected cells is not in one of the corners. Row: '{}' and row range '({}, {})'",
selected_row, start_row, end_row
));
}
if selected_column != start_column && selected_column != end_column {
return Err(format!(
"The selected cells is not in one of the corners. Column '{}' and column range '({}, {})'",
selected_column, start_column, end_column
));
}
view.range = [start_row, start_column, end_row, end_column];
}
}
@@ -521,7 +536,8 @@ impl UserModel {
Ok(scroll_y)
}
/// User presses page down
/// User presses page down.
/// The `top_row` is now the first row that is not fully visible
pub fn on_page_down(&mut self) -> Result<(), String> {
let (sheet, window_height) =
if let Some(view) = self.model.workbook.views.get(&self.model.view_id) {
@@ -537,12 +553,11 @@ impl UserModel {
Some(s) => s,
None => return Err("View not found".to_string()),
};
let mut height = 0.0;
let mut last_row = view.top_row;
let mut height = self.model.get_row_height(sheet, last_row)?;
while height <= window_height as f64 {
height += self.model.get_row_height(sheet, last_row)?;
last_row += 1;
height += self.model.get_row_height(sheet, last_row)?;
}
if !is_valid_row(last_row) {
return Ok(());
@@ -558,11 +573,11 @@ impl UserModel {
Ok(())
}
/// On page up
/// On page up. tis needs to be the inverse of page down
pub fn on_page_up(&mut self) -> Result<(), String> {
let (sheet, window_height) =
if let Some(view) = self.model.workbook.views.get(&self.model.view_id) {
(view.sheet, view.window_height)
(view.sheet, view.window_height as f64)
} else {
return Err("View not found".to_string());
};
@@ -575,16 +590,17 @@ impl UserModel {
None => return Err("View not found".to_string()),
};
let mut height = 0.0;
let mut last_row = view.top_row;
while height <= window_height as f64 && last_row > 1 {
height += self.model.get_row_height(sheet, last_row)?;
last_row -= 1;
let mut first_row = view.top_row;
let mut height = self.model.get_row_height(sheet, first_row)?;
while height <= window_height && first_row > 1 {
first_row -= 1;
height += self.model.get_row_height(sheet, first_row)?;
}
let row_delta = view.row - view.top_row;
if let Ok(worksheet) = self.model.workbook.worksheet_mut(sheet) {
if let Some(view) = worksheet.views.get_mut(&self.model.view_id) {
view.top_row = last_row;
view.top_row = first_row;
view.row = view.top_row + row_delta;
view.range = [view.row, view.column, view.row, view.column];
}

View File

@@ -42,7 +42,17 @@ impl Worksheet {
self.sheet_data.get_mut(&row)?.get_mut(&column)
}
pub(crate) fn update_cell(&mut self, row: i32, column: i32, new_cell: Cell) {
pub(crate) fn update_cell(
&mut self,
row: i32,
column: i32,
new_cell: Cell,
) -> Result<(), String> {
// validate row and column arg before updating cell of worksheet
if !is_valid_row(row) || !is_valid_column_number(column) {
return Err("Incorrect row or column".to_string());
}
match self.sheet_data.get_mut(&row) {
Some(column_data) => match column_data.get(&column) {
Some(_cell) => {
@@ -58,6 +68,7 @@ impl Worksheet {
self.sheet_data.insert(row, column_data);
}
}
Ok(())
}
// TODO [MVP]: Pass the cell style from the model
@@ -128,53 +139,94 @@ impl Worksheet {
Ok(())
}
pub fn set_cell_style(&mut self, row: i32, column: i32, style_index: i32) {
pub fn set_cell_style(
&mut self,
row: i32,
column: i32,
style_index: i32,
) -> Result<(), String> {
match self.cell_mut(row, column) {
Some(cell) => {
cell.set_style(style_index);
}
None => {
self.cell_clear_contents_with_style(row, column, style_index);
self.cell_clear_contents_with_style(row, column, style_index)?;
}
}
Ok(())
// TODO: cleanup check if the old cell style is still in use
}
pub fn set_cell_with_formula(&mut self, row: i32, column: i32, index: i32, style: i32) {
pub fn set_cell_with_formula(
&mut self,
row: i32,
column: i32,
index: i32,
style: i32,
) -> Result<(), String> {
let cell = Cell::new_formula(index, style);
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn set_cell_with_number(&mut self, row: i32, column: i32, value: f64, style: i32) {
pub fn set_cell_with_number(
&mut self,
row: i32,
column: i32,
value: f64,
style: i32,
) -> Result<(), String> {
let cell = Cell::new_number(value, style);
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn set_cell_with_string(&mut self, row: i32, column: i32, index: i32, style: i32) {
pub fn set_cell_with_string(
&mut self,
row: i32,
column: i32,
index: i32,
style: i32,
) -> Result<(), String> {
let cell = Cell::new_string(index, style);
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn set_cell_with_boolean(&mut self, row: i32, column: i32, value: bool, style: i32) {
pub fn set_cell_with_boolean(
&mut self,
row: i32,
column: i32,
value: bool,
style: i32,
) -> Result<(), String> {
let cell = Cell::new_boolean(value, style);
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn set_cell_with_error(&mut self, row: i32, column: i32, error: Error, style: i32) {
pub fn set_cell_with_error(
&mut self,
row: i32,
column: i32,
error: Error,
style: i32,
) -> Result<(), String> {
let cell = Cell::new_error(error, style);
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn cell_clear_contents(&mut self, row: i32, column: i32) {
pub fn cell_clear_contents(&mut self, row: i32, column: i32) -> Result<(), String> {
let s = self.get_style(row, column);
let cell = Cell::EmptyCell { s };
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn cell_clear_contents_with_style(&mut self, row: i32, column: i32, style: i32) {
pub fn cell_clear_contents_with_style(
&mut self,
row: i32,
column: i32,
style: i32,
) -> Result<(), String> {
let cell = Cell::EmptyCell { s: style };
self.update_cell(row, column, cell);
self.update_cell(row, column, cell)
}
pub fn set_frozen_rows(&mut self, frozen_rows: i32) -> Result<(), String> {

5
bindings/python/.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
target/*
venv/*
sphinx-venv/*
html/*
tests/__pycache*

884
bindings/python/Cargo.lock generated Normal file
View File

@@ -0,0 +1,884 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "adler"
version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
[[package]]
name = "aho-corasick"
version = "1.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0"
dependencies = [
"memchr",
]
[[package]]
name = "android-tzdata"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e999941b234f3131b00bc13c22d06e8c5ff726d1b6318ac7eb276997bbb4fef0"
[[package]]
name = "android_system_properties"
version = "0.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311"
dependencies = [
"libc",
]
[[package]]
name = "autocfg"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
[[package]]
name = "bitflags"
version = "1.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
[[package]]
name = "bumpalo"
version = "3.14.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7f30e7476521f6f8af1a1c4c0b8cc94f0bee37d91763d0ca2665f299b6cd8aec"
[[package]]
name = "byteorder"
version = "1.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
[[package]]
name = "bzip2"
version = "0.4.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bdb116a6ef3f6c3698828873ad02c3014b3c85cadb88496095628e3ef1e347f8"
dependencies = [
"bzip2-sys",
"libc",
]
[[package]]
name = "bzip2-sys"
version = "0.1.11+1.0.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "736a955f3fa7875102d57c82b8cac37ec45224a07fd32d58f9f7a186b6cd4cdc"
dependencies = [
"cc",
"libc",
"pkg-config",
]
[[package]]
name = "cc"
version = "1.0.83"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f1174fb0b6ec23863f8b971027804a42614e347eafb0a95bf0b12cdae21fc4d0"
dependencies = [
"libc",
]
[[package]]
name = "cfg-if"
version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
[[package]]
name = "chrono"
version = "0.4.31"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7f2c685bad3eb3d45a01354cedb7d5faa66194d1d58ba6e267a8de788f79db38"
dependencies = [
"android-tzdata",
"iana-time-zone",
"js-sys",
"num-traits",
"wasm-bindgen",
"windows-targets",
]
[[package]]
name = "chrono-tz"
version = "0.7.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bbc529705a6e0028189c83f0a5dd9fb214105116f7e3c0eeab7ff0369766b0d1"
dependencies = [
"chrono",
"chrono-tz-build",
"phf",
]
[[package]]
name = "chrono-tz-build"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d9998fb9f7e9b2111641485bf8beb32f92945f97f92a3d061f744cfef335f751"
dependencies = [
"parse-zoneinfo",
"phf",
"phf_codegen",
]
[[package]]
name = "core-foundation-sys"
version = "0.8.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e496a50fda8aacccc86d7529e2c1e0892dbd0f898a6b5645b5561b89c3210efa"
[[package]]
name = "crc32fast"
version = "1.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b540bd8bc810d3885c6ea91e2018302f68baba2129ab3e88f32389ee9370880d"
dependencies = [
"cfg-if",
]
[[package]]
name = "either"
version = "1.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07"
[[package]]
name = "flate2"
version = "1.0.28"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "46303f565772937ffe1d394a4fac6f411c6013172fadde9dcdb1e147a086940e"
dependencies = [
"crc32fast",
"miniz_oxide",
]
[[package]]
name = "getrandom"
version = "0.2.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fe9006bed769170c11f845cf00c7c1e9092aeb3f268e007c3e760ac68008070f"
dependencies = [
"cfg-if",
"libc",
"wasi 0.11.0+wasi-snapshot-preview1",
]
[[package]]
name = "iana-time-zone"
version = "0.1.58"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8326b86b6cff230b97d0d312a6c40a60726df3332e721f72a1b035f451663b20"
dependencies = [
"android_system_properties",
"core-foundation-sys",
"iana-time-zone-haiku",
"js-sys",
"wasm-bindgen",
"windows-core",
]
[[package]]
name = "iana-time-zone-haiku"
version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f"
dependencies = [
"cc",
]
[[package]]
name = "indoc"
version = "1.0.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bfa799dd5ed20a7e349f3b4639aa80d74549c81716d9ec4f994c9b5815598306"
[[package]]
name = "instant"
version = "0.1.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7a5bbe824c507c5da5956355e86a746d82e0e1464f65d862cc5e71da70e94b2c"
dependencies = [
"cfg-if",
]
[[package]]
name = "ironcalc"
version = "0.1.0"
dependencies = [
"chrono",
"ironcalc_base",
"itertools",
"roxmltree",
"serde",
"serde_json",
"thiserror",
"zip",
]
[[package]]
name = "ironcalc_base"
version = "0.1.0"
dependencies = [
"chrono",
"chrono-tz",
"js-sys",
"once_cell",
"rand",
"regex",
"ryu",
"serde",
"serde_json",
"serde_repr",
]
[[package]]
name = "itertools"
version = "0.10.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b0fd2260e829bddf4cb6ea802289de2f86d6a7a690192fbe91b3f46e0f2c8473"
dependencies = [
"either",
]
[[package]]
name = "itoa"
version = "1.0.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "af150ab688ff2122fcef229be89cb50dd66af9e01a4ff320cc137eecc9bacc38"
[[package]]
name = "js-sys"
version = "0.3.65"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "54c0c35952f67de54bb584e9fd912b3023117cbafc0a77d8f3dee1fb5f572fe8"
dependencies = [
"wasm-bindgen",
]
[[package]]
name = "libc"
version = "0.2.150"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "89d92a4743f9a61002fae18374ed11e7973f530cb3a3255fb354818118b2203c"
[[package]]
name = "lock_api"
version = "0.4.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3c168f8615b12bc01f9c17e2eb0cc07dcae1940121185446edc3744920e8ef45"
dependencies = [
"autocfg",
"scopeguard",
]
[[package]]
name = "log"
version = "0.4.20"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f"
[[package]]
name = "memchr"
version = "2.6.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f665ee40bc4a3c5590afb1e9677db74a508659dfd71e126420da8274909a0167"
[[package]]
name = "memoffset"
version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5a634b1c61a95585bd15607c6ab0c4e5b226e695ff2800ba0cdccddf208c406c"
dependencies = [
"autocfg",
]
[[package]]
name = "miniz_oxide"
version = "0.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e7810e0be55b428ada41041c41f32c9f1a42817901b4ccf45fa3d4b6561e74c7"
dependencies = [
"adler",
]
[[package]]
name = "num-traits"
version = "0.2.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "39e3200413f237f41ab11ad6d161bc7239c84dcb631773ccd7de3dfe4b5c267c"
dependencies = [
"autocfg",
]
[[package]]
name = "once_cell"
version = "1.18.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d"
[[package]]
name = "parking_lot"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7d17b78036a60663b797adeaee46f5c9dfebb86948d1255007a1d6be0271ff99"
dependencies = [
"instant",
"lock_api",
"parking_lot_core",
]
[[package]]
name = "parking_lot_core"
version = "0.8.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "60a2cfe6f0ad2bfc16aefa463b497d5c7a5ecd44a23efa72aa342d90177356dc"
dependencies = [
"cfg-if",
"instant",
"libc",
"redox_syscall",
"smallvec",
"winapi",
]
[[package]]
name = "parse-zoneinfo"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c705f256449c60da65e11ff6626e0c16a0a0b96aaa348de61376b249bc340f41"
dependencies = [
"regex",
]
[[package]]
name = "phf"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ade2d8b8f33c7333b51bcf0428d37e217e9f32192ae4772156f65063b8ce03dc"
dependencies = [
"phf_shared",
]
[[package]]
name = "phf_codegen"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e8d39688d359e6b34654d328e262234662d16cc0f60ec8dcbe5e718709342a5a"
dependencies = [
"phf_generator",
"phf_shared",
]
[[package]]
name = "phf_generator"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "48e4cc64c2ad9ebe670cb8fd69dd50ae301650392e81c05f9bfcb2d5bdbc24b0"
dependencies = [
"phf_shared",
"rand",
]
[[package]]
name = "phf_shared"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "90fcb95eef784c2ac79119d1dd819e162b5da872ce6f3c3abe1e8ca1c082f72b"
dependencies = [
"siphasher",
]
[[package]]
name = "pkg-config"
version = "0.3.27"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "26072860ba924cbfa98ea39c8c19b4dd6a4a25423dbdf219c1eca91aa0cf6964"
[[package]]
name = "ppv-lite86"
version = "0.2.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de"
[[package]]
name = "proc-macro2"
version = "1.0.69"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "134c189feb4956b20f6f547d2cf727d4c0fe06722b20a0eec87ed445a97f92da"
dependencies = [
"unicode-ident",
]
[[package]]
name = "pyo3"
version = "0.19.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e681a6cfdc4adcc93b4d3cf993749a4552018ee0a9b65fc0ccfad74352c72a38"
dependencies = [
"cfg-if",
"indoc",
"libc",
"memoffset",
"parking_lot",
"pyo3-build-config",
"pyo3-ffi",
"pyo3-macros",
"unindent",
]
[[package]]
name = "pyo3-build-config"
version = "0.19.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "076c73d0bc438f7a4ef6fdd0c3bb4732149136abd952b110ac93e4edb13a6ba5"
dependencies = [
"once_cell",
"target-lexicon",
]
[[package]]
name = "pyo3-ffi"
version = "0.19.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e53cee42e77ebe256066ba8aa77eff722b3bb91f3419177cf4cd0f304d3284d9"
dependencies = [
"libc",
"pyo3-build-config",
]
[[package]]
name = "pyo3-macros"
version = "0.19.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dfeb4c99597e136528c6dd7d5e3de5434d1ceaf487436a3f03b2d56b6fc9efd1"
dependencies = [
"proc-macro2",
"pyo3-macros-backend",
"quote",
"syn 1.0.109",
]
[[package]]
name = "pyo3-macros-backend"
version = "0.19.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "947dc12175c254889edc0c02e399476c2f652b4b9ebd123aa655c224de259536"
dependencies = [
"proc-macro2",
"quote",
"syn 1.0.109",
]
[[package]]
name = "pyroncalc"
version = "0.1.0"
dependencies = [
"ironcalc",
"pyo3",
"serde",
"serde_json",
]
[[package]]
name = "quote"
version = "1.0.33"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae"
dependencies = [
"proc-macro2",
]
[[package]]
name = "rand"
version = "0.8.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
dependencies = [
"libc",
"rand_chacha",
"rand_core",
]
[[package]]
name = "rand_chacha"
version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
dependencies = [
"ppv-lite86",
"rand_core",
]
[[package]]
name = "rand_core"
version = "0.6.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
dependencies = [
"getrandom",
]
[[package]]
name = "redox_syscall"
version = "0.2.16"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fb5a58c1855b4b6819d59012155603f0b22ad30cad752600aadfcb695265519a"
dependencies = [
"bitflags",
]
[[package]]
name = "regex"
version = "1.10.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "380b951a9c5e80ddfd6136919eef32310721aa4aacd4889a8d39124b026ab343"
dependencies = [
"aho-corasick",
"memchr",
"regex-automata",
"regex-syntax",
]
[[package]]
name = "regex-automata"
version = "0.4.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5f804c7828047e88b2d32e2d7fe5a105da8ee3264f01902f796c8e067dc2483f"
dependencies = [
"aho-corasick",
"memchr",
"regex-syntax",
]
[[package]]
name = "regex-syntax"
version = "0.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f"
[[package]]
name = "roxmltree"
version = "0.13.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dbf7d7b1ea646d380d0e8153158063a6da7efe30ddbf3184042848e3f8a6f671"
dependencies = [
"xmlparser",
]
[[package]]
name = "ryu"
version = "1.0.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1ad4cc8da4ef723ed60bced201181d83791ad433213d8c24efffda1eec85d741"
[[package]]
name = "scopeguard"
version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
[[package]]
name = "serde"
version = "1.0.192"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bca2a08484b285dcb282d0f67b26cadc0df8b19f8c12502c13d966bf9482f001"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.192"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d6c7207fbec9faa48073f3e3074cbe553af6ea512d7c21ba46e434e70ea9fbc1"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.39",
]
[[package]]
name = "serde_json"
version = "1.0.108"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3d1c7e3eac408d115102c4c24ad393e0821bb3a5df4d506a80f85f7a742a526b"
dependencies = [
"itoa",
"ryu",
"serde",
]
[[package]]
name = "serde_repr"
version = "0.1.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3081f5ffbb02284dda55132aa26daecedd7372a42417bbbab6f14ab7d6bb9145"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.39",
]
[[package]]
name = "siphasher"
version = "0.3.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "38b58827f4464d87d377d175e90bf58eb00fd8716ff0a62f80356b5e61555d0d"
[[package]]
name = "smallvec"
version = "1.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4dccd0940a2dcdf68d092b8cbab7dc0ad8fa938bf95787e1b916b0e3d0e8e970"
[[package]]
name = "syn"
version = "1.0.109"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "syn"
version = "2.0.39"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "23e78b90f2fcf45d3e842032ce32e3f2d1545ba6636271dcbf24fa306d87be7a"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "target-lexicon"
version = "0.12.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "14c39fd04924ca3a864207c66fc2cd7d22d7c016007f9ce846cbb9326331930a"
[[package]]
name = "thiserror"
version = "1.0.50"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f9a7210f5c9a7156bb50aa36aed4c95afb51df0df00713949448cf9e97d382d2"
dependencies = [
"thiserror-impl",
]
[[package]]
name = "thiserror-impl"
version = "1.0.50"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "266b2e40bc00e5a6c09c3584011e08b06f123c00362c92b975ba9843aaaa14b8"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.39",
]
[[package]]
name = "time"
version = "0.1.45"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1b797afad3f312d1c66a56d11d0316f916356d11bd158fbc6ca6389ff6bf805a"
dependencies = [
"libc",
"wasi 0.10.0+wasi-snapshot-preview1",
"winapi",
]
[[package]]
name = "unicode-ident"
version = "1.0.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
[[package]]
name = "unindent"
version = "0.1.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e1766d682d402817b5ac4490b3c3002d91dfa0d22812f341609f97b08757359c"
[[package]]
name = "wasi"
version = "0.10.0+wasi-snapshot-preview1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1a143597ca7c7793eff794def352d41792a93c481eb1042423ff7ff72ba2c31f"
[[package]]
name = "wasi"
version = "0.11.0+wasi-snapshot-preview1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
[[package]]
name = "wasm-bindgen"
version = "0.2.88"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7daec296f25a1bae309c0cd5c29c4b260e510e6d813c286b19eaadf409d40fce"
dependencies = [
"cfg-if",
"wasm-bindgen-macro",
]
[[package]]
name = "wasm-bindgen-backend"
version = "0.2.88"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e397f4664c0e4e428e8313a469aaa58310d302159845980fd23b0f22a847f217"
dependencies = [
"bumpalo",
"log",
"once_cell",
"proc-macro2",
"quote",
"syn 2.0.39",
"wasm-bindgen-shared",
]
[[package]]
name = "wasm-bindgen-macro"
version = "0.2.88"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5961017b3b08ad5f3fe39f1e79877f8ee7c23c5e5fd5eb80de95abc41f1f16b2"
dependencies = [
"quote",
"wasm-bindgen-macro-support",
]
[[package]]
name = "wasm-bindgen-macro-support"
version = "0.2.88"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c5353b8dab669f5e10f5bd76df26a9360c748f054f862ff5f3f8aae0c7fb3907"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.39",
"wasm-bindgen-backend",
"wasm-bindgen-shared",
]
[[package]]
name = "wasm-bindgen-shared"
version = "0.2.88"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0d046c5d029ba91a1ed14da14dca44b68bf2f124cfbaf741c54151fdb3e0750b"
[[package]]
name = "winapi"
version = "0.3.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
dependencies = [
"winapi-i686-pc-windows-gnu",
"winapi-x86_64-pc-windows-gnu",
]
[[package]]
name = "winapi-i686-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
[[package]]
name = "winapi-x86_64-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
[[package]]
name = "windows-core"
version = "0.51.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f1f8cf84f35d2db49a46868f947758c7a1138116f7fac3bc844f43ade1292e64"
dependencies = [
"windows-targets",
]
[[package]]
name = "windows-targets"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
dependencies = [
"windows_aarch64_gnullvm",
"windows_aarch64_msvc",
"windows_i686_gnu",
"windows_i686_msvc",
"windows_x86_64_gnu",
"windows_x86_64_gnullvm",
"windows_x86_64_msvc",
]
[[package]]
name = "windows_aarch64_gnullvm"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
[[package]]
name = "windows_aarch64_msvc"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
[[package]]
name = "windows_i686_gnu"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
[[package]]
name = "windows_i686_msvc"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
[[package]]
name = "windows_x86_64_gnu"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
[[package]]
name = "windows_x86_64_gnullvm"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
[[package]]
name = "windows_x86_64_msvc"
version = "0.48.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
[[package]]
name = "xmlparser"
version = "0.13.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "66fee0b777b0f5ac1c69bb06d361268faafa61cd4682ae064a171c16c433e9e4"
[[package]]
name = "zip"
version = "0.5.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "93ab48844d61251bb3835145c521d88aa4031d7139e8485990f60ca911fa0815"
dependencies = [
"byteorder",
"bzip2",
"crc32fast",
"flate2",
"thiserror",
"time",
]

View File

@@ -0,0 +1,24 @@
[package]
name = "pyroncalc"
version = "0.1.2"
edition = "2021"
[lib]
name = "ironcalc"
crate-type = ["cdylib"]
[dependencies]
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
xlsx = { package= "ironcalc", path = "../../xlsx", version = "0.2.0" }
pyo3 = { version = "0.22.3", features = ["extension-module"] }
[features]
extension-module = ["pyo3/extension-module"]
default = ["extension-module"]
[tool.maturin]
features = ["pyo3/extension-module"]

View File

@@ -0,0 +1,191 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Copyright 2023 EqualTo GmbH, 2023 Nicolás Hatcher
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@@ -0,0 +1,9 @@
MIT License
Copyright (c) 2023 EqualTo GmbH, 2023 Nicolás Hatcher
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

31
bindings/python/README.md Normal file
View File

@@ -0,0 +1,31 @@
# IronCalc python bindings
With IronCalc you can create, read and manipulate xlsx files.
You can manage sheets, add, remove, delete rename.
You can add cell values, retrieve them and most importantly you can evaluate spreadsheets.
## Installation
```bash
pip install ironcalc
```
## Compile and test
To compile this and test it:
```bash
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install maturin
$ maturin develop
$ cd examples
examples $ python example.py
```
From there if you use `python` you can `import ironcalc`. You can either create a new file, read it from a JSON string or import from Excel.
Hopefully the API is straightforward.

View File

@@ -0,0 +1,14 @@
project = 'IronCalc'
author = 'Nicolás Hatcher'
release = '0.1'
version = '0.1.2'
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
templates_path = ['_templates']
exclude_patterns = []
html_theme = 'alabaster'

View File

@@ -0,0 +1,8 @@
import ironcalc as ic
model = ic.create("model", "en", "UTC")
model.set_user_input(0, 1, 1, "=21*2")
model.evaluate()
assert model.get_formatted_cell_value(0, 1, 1), 42

View File

@@ -0,0 +1,13 @@
IronCalc: The democratization of spreadsheets
=============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
IronCalc is a spreadsheet engine that allows you to create, modify and safe spreadsheets.
A simple example that creates a model, sets a formula, evaluates it and gets the result back:
.. literalinclude:: examples/simple.py
:language: python

View File

@@ -0,0 +1,36 @@
[project]
name = "ironcalc"
version = "0.1.2"
description = "Create, edit and evaluate Excel spreadsheets"
requires-python = ">=3.10"
keywords = [
"xlsx",
"spreadsheet",
]
classifiers = [
"License :: OSI Approved :: MIT License",
"License :: OSI Approved :: Apache Software License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Topic :: Software Development :: Libraries",
"Topic :: Software Development :: Libraries :: Python Modules",
"Office/Business :: Financial :: Spreadsheet",
]
authors = [
{ name = "Nicolás Hatcher", email = "nicolas@theuniverse.today" },
]
[project.urls]
Homepage = "https://www.ironcalc.com/"
Source = "https://github.com/ironcalc/ironcalc"
Tracker = "https://github.com/ironcalc/ironcalc/issues"
[build-system]
requires = ["maturin>=1.0,<2.0"]
build-backend = "maturin"
[tool.maturin]
features = ["pyo3/extension-module"]

29
bindings/python/run_examples.sh Executable file
View File

@@ -0,0 +1,29 @@
#!/bin/bash
# Define the directory containing the Python files
EXAMPLES_DIR="docs/examples"
# Check if the directory exists
if [ ! -d "$EXAMPLES_DIR" ]; then
echo "Directory $EXAMPLES_DIR does not exist."
exit 1
fi
# Iterate over all Python files in the examples directory
for file in "$EXAMPLES_DIR"/*.py; do
# Check if there are any Python files
if [ -f "$file" ]; then
echo "Running $file..."
python "$file"
# Check if the script ran successfully
if [ $? -ne 0 ]; then
echo "Error running $file"
else
echo "$file ran successfully"
fi
else
echo "No Python files found in $EXAMPLES_DIR"
exit 1
fi
done

9
bindings/python/run_tests.sh Executable file
View File

@@ -0,0 +1,9 @@
#!/bin/bash
python -m venv venv
source venv/bin/activate
# not sure why this is needed
pip install patchelf
pip install maturin
pip install pytest
maturin develop
pytest tests/

259
bindings/python/src/lib.rs Normal file
View File

@@ -0,0 +1,259 @@
use pyo3::exceptions::PyException;
use pyo3::{create_exception, prelude::*, wrap_pyfunction};
use types::{PySheetProperty, PyStyle};
use xlsx::base::types::Style;
use xlsx::base::Model;
use xlsx::export::{save_to_icalc, save_to_xlsx};
use xlsx::import;
mod types;
create_exception!(_ironcalc, WorkbookError, PyException);
/// This is a model implementing the 'raw' API
#[pyclass]
pub struct PyModel {
model: Model,
}
#[pymethods]
impl PyModel {
/// Saves the model to an xlsx file
pub fn save_to_xlsx(&self, file: &str) -> PyResult<()> {
save_to_xlsx(&self.model, file).map_err(|e| WorkbookError::new_err(e.to_string()))
}
/// Saves the model to file in the internal binary ic format
pub fn save_to_icalc(&self, file: &str) -> PyResult<()> {
save_to_icalc(&self.model, file).map_err(|e| WorkbookError::new_err(e.to_string()))
}
/// Evaluates the workbook
pub fn evaluate(&mut self) {
self.model.evaluate()
}
// Set values
/// Set an input
pub fn set_user_input(
&mut self,
sheet: u32,
row: i32,
column: i32,
value: &str,
) -> PyResult<()> {
self.model
.set_user_input(sheet, row, column, value.to_string())
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn clear_cell_contents(&mut self, sheet: u32, row: i32, column: i32) -> PyResult<()> {
self.model
.cell_clear_contents(sheet, row, column)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
// Get values
/// Get formatted value
pub fn get_formatted_cell_value(&self, sheet: u32, row: i32, column: i32) -> PyResult<String> {
self.model
.get_formatted_cell_value(sheet, row, column)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
// Set styles
pub fn set_cell_style(
&mut self,
sheet: u32,
row: i32,
column: i32,
py_style: &PyStyle,
) -> PyResult<()> {
let style: Style = py_style.into();
self.model
.set_cell_style(sheet, row, column, &style)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
// Get styles
pub fn get_cell_style(&self, sheet: u32, row: i32, column: i32) -> PyResult<PyStyle> {
let style = self
.model
.get_style_for_cell(sheet, row, column)
.map_err(|e| WorkbookError::new_err(e.to_string()))?;
Ok(style.into())
}
// column widths, row heights
// insert/delete rows/columns
pub fn insert_rows(&mut self, sheet: u32, row: i32, row_count: i32) -> PyResult<()> {
self.model
.insert_rows(sheet, row, row_count)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn insert_columns(&mut self, sheet: u32, column: i32, column_count: i32) -> PyResult<()> {
self.model
.insert_columns(sheet, column, column_count)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn delete_rows(&mut self, sheet: u32, row: i32, row_count: i32) -> PyResult<()> {
self.model
.delete_rows(sheet, row, row_count)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn delete_columns(&mut self, sheet: u32, column: i32, column_count: i32) -> PyResult<()> {
self.model
.delete_columns(sheet, column, column_count)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn get_column_width(&self, sheet: u32, column: i32) -> PyResult<f64> {
self.model
.get_column_width(sheet, column)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn get_row_height(&self, sheet: u32, row: i32) -> PyResult<f64> {
self.model
.get_row_height(sheet, row)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn set_column_width(&mut self, sheet: u32, column: i32, width: f64) -> PyResult<()> {
self.model
.set_column_width(sheet, column, width)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn set_row_height(&mut self, sheet: u32, row: i32, height: f64) -> PyResult<()> {
self.model
.set_row_height(sheet, row, height)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
// frozen rows/columns
pub fn get_frozen_columns_count(&self, sheet: u32) -> PyResult<i32> {
self.model
.get_frozen_columns_count(sheet)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn get_frozen_rows_count(&self, sheet: u32) -> PyResult<i32> {
self.model
.get_frozen_rows_count(sheet)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn set_frozen_columns_count(&mut self, sheet: u32, column_count: i32) -> PyResult<()> {
self.model
.set_frozen_columns(sheet, column_count)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn set_frozen_rows_count(&mut self, sheet: u32, row_count: i32) -> PyResult<()> {
self.model
.set_frozen_rows(sheet, row_count)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
// Manipulate sheets (add/remove/rename/change color)
pub fn get_worksheets_properties(&self) -> PyResult<Vec<PySheetProperty>> {
Ok(self
.model
.get_worksheets_properties()
.into_iter()
.map(|s| PySheetProperty {
name: s.name,
state: s.state,
sheet_id: s.sheet_id,
color: s.color,
})
.collect())
}
pub fn set_sheet_color(&mut self, sheet: u32, color: &str) -> PyResult<()> {
self.model
.set_sheet_color(sheet, color)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn add_sheet(&mut self, sheet_name: &str) -> PyResult<()> {
self.model
.add_sheet(sheet_name)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn new_sheet(&mut self) {
self.model.new_sheet();
}
pub fn delete_sheet(&mut self, sheet: u32) -> PyResult<()> {
self.model
.delete_sheet(sheet)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn rename_sheet(&mut self, sheet: u32, new_name: &str) -> PyResult<()> {
self.model
.rename_sheet_by_index(sheet, new_name)
.map_err(|e| WorkbookError::new_err(e.to_string()))
}
pub fn test_panic(&self) -> PyResult<()> {
panic!("This function panics for testing panic handling");
}
}
/// Create methods
/// Loads a function from an xlsx file
#[pyfunction]
pub fn load_from_xlsx(file_path: &str, locale: &str, tz: &str) -> PyResult<PyModel> {
let model = import::load_from_xlsx(file_path, locale, tz)
.map_err(|e| WorkbookError::new_err(e.to_string()))?;
Ok(PyModel { model })
}
/// Loads a function from icalc binary representation
#[pyfunction]
pub fn load_from_icalc(file_name: &str) -> PyResult<PyModel> {
let model =
import::load_from_icalc(file_name).map_err(|e| WorkbookError::new_err(e.to_string()))?;
Ok(PyModel { model })
}
/// Creates an empty model
#[pyfunction]
pub fn create(name: &str, locale: &str, tz: &str) -> PyResult<PyModel> {
let model =
Model::new_empty(name, locale, tz).map_err(|e| WorkbookError::new_err(e.to_string()))?;
Ok(PyModel { model })
}
#[pyfunction]
pub fn test_panic() {
panic!("This function panics for testing panic handling");
}
#[pymodule]
fn ironcalc(m: &Bound<'_, PyModule>) -> PyResult<()> {
// Add the package version to the module
m.add("__version__", env!("CARGO_PKG_VERSION"))?;
// Add the functions to the module using the `?` operator
m.add_function(wrap_pyfunction!(create, m)?)?;
m.add_function(wrap_pyfunction!(load_from_xlsx, m)?)?;
m.add_function(wrap_pyfunction!(load_from_icalc, m)?)?;
m.add_function(wrap_pyfunction!(test_panic, m)?)?;
Ok(())
}

View File

@@ -0,0 +1,428 @@
use pyo3::prelude::*;
use xlsx::base::types::{
Alignment, Border, BorderItem, BorderStyle, Fill, Font, FontScheme, HorizontalAlignment, Style,
VerticalAlignment,
};
#[derive(Clone)]
#[pyclass]
pub struct PySheetProperty {
#[pyo3(get)]
pub name: String,
#[pyo3(get)]
pub state: String,
#[pyo3(get)]
pub sheet_id: u32,
#[pyo3(get)]
pub color: Option<String>,
}
#[pyclass]
#[derive(Clone)]
pub struct Cell {
#[pyo3(get, set)]
pub row: i32,
#[pyo3(get, set)]
pub column: i32,
}
#[pyclass(eq, eq_int)]
#[derive(PartialEq, Clone)]
pub enum PyHorizontalAlignment {
Center,
CenterContinuous,
Distributed,
Fill,
General,
Justify,
Left,
Right,
}
#[pyclass(eq, eq_int)]
#[derive(PartialEq, Clone)]
pub enum PyVerticalAlignment {
Bottom,
Center,
Distributed,
Justify,
Top,
}
#[pyclass]
#[derive(Clone)]
pub struct PyAlignment {
#[pyo3(get)]
pub horizontal: PyHorizontalAlignment,
#[pyo3(get)]
pub vertical: PyVerticalAlignment,
#[pyo3(get)]
pub wrap_text: bool,
}
#[pyclass]
#[derive(Clone)]
pub struct PyStyle {
#[pyo3(get)]
pub alignment: Option<PyAlignment>,
#[pyo3(get)]
pub num_fmt: String,
#[pyo3(get)]
pub fill: PyFill,
#[pyo3(get)]
pub font: PyFont,
#[pyo3(get)]
pub border: PyBorder,
#[pyo3(get)]
pub quote_prefix: bool,
}
#[pyclass(eq, eq_int)]
#[derive(PartialEq, Clone)]
pub enum PyBorderStyle {
Thin,
Medium,
Thick,
Double,
Dotted,
SlantDashDot,
MediumDashed,
MediumDashDotDot,
MediumDashDot,
}
#[pyclass]
#[derive(Clone)]
pub struct PyBorderItem {
#[pyo3(get)]
pub style: PyBorderStyle,
#[pyo3(get)]
pub color: Option<String>,
}
#[pyclass]
#[derive(Clone)]
pub struct PyBorder {
#[pyo3(get)]
pub diagonal_up: bool,
#[pyo3(get)]
pub diagonal_down: bool,
#[pyo3(get)]
pub left: Option<PyBorderItem>,
#[pyo3(get)]
pub right: Option<PyBorderItem>,
#[pyo3(get)]
pub top: Option<PyBorderItem>,
#[pyo3(get)]
pub bottom: Option<PyBorderItem>,
#[pyo3(get)]
pub diagonal: Option<PyBorderItem>,
}
#[pyclass(eq, eq_int)]
#[derive(PartialEq, Clone)]
pub enum PyFontScheme {
Minor,
Major,
None,
}
#[pyclass]
#[derive(Clone)]
pub struct PyFont {
#[pyo3(get)]
pub strike: bool,
#[pyo3(get)]
pub u: bool,
#[pyo3(get)]
pub b: bool,
#[pyo3(get)]
pub i: bool,
#[pyo3(get)]
pub sz: i32,
#[pyo3(get)]
pub color: Option<String>,
#[pyo3(get)]
pub name: String,
#[pyo3(get)]
pub family: i32,
#[pyo3(get)]
pub scheme: PyFontScheme,
}
#[pyclass]
#[derive(Clone)]
pub struct PyFill {
#[pyo3(get)]
pub pattern_type: String,
#[pyo3(get)]
pub fg_color: Option<String>,
#[pyo3(get)]
pub bg_color: Option<String>,
}
// Conversions from references to Py* types to non-Py types
// Enums
impl From<PyHorizontalAlignment> for HorizontalAlignment {
fn from(py_align: PyHorizontalAlignment) -> Self {
match py_align {
PyHorizontalAlignment::Center => HorizontalAlignment::Center,
PyHorizontalAlignment::CenterContinuous => HorizontalAlignment::CenterContinuous,
PyHorizontalAlignment::Distributed => HorizontalAlignment::Distributed,
PyHorizontalAlignment::Fill => HorizontalAlignment::Fill,
PyHorizontalAlignment::General => HorizontalAlignment::General,
PyHorizontalAlignment::Justify => HorizontalAlignment::Justify,
PyHorizontalAlignment::Left => HorizontalAlignment::Left,
PyHorizontalAlignment::Right => HorizontalAlignment::Right,
}
}
}
impl From<PyVerticalAlignment> for VerticalAlignment {
fn from(py_align: PyVerticalAlignment) -> Self {
match py_align {
PyVerticalAlignment::Bottom => VerticalAlignment::Bottom,
PyVerticalAlignment::Center => VerticalAlignment::Center,
PyVerticalAlignment::Distributed => VerticalAlignment::Distributed,
PyVerticalAlignment::Justify => VerticalAlignment::Justify,
PyVerticalAlignment::Top => VerticalAlignment::Top,
}
}
}
impl From<PyFontScheme> for FontScheme {
fn from(py_scheme: PyFontScheme) -> Self {
match py_scheme {
PyFontScheme::Minor => FontScheme::Minor,
PyFontScheme::Major => FontScheme::Major,
PyFontScheme::None => FontScheme::None,
}
}
}
impl From<&PyBorderStyle> for BorderStyle {
fn from(py_style: &PyBorderStyle) -> Self {
match *py_style {
PyBorderStyle::Thin => BorderStyle::Thin,
PyBorderStyle::Medium => BorderStyle::Medium,
PyBorderStyle::Thick => BorderStyle::Thick,
PyBorderStyle::Double => BorderStyle::Double,
PyBorderStyle::Dotted => BorderStyle::Dotted,
PyBorderStyle::SlantDashDot => BorderStyle::SlantDashDot,
PyBorderStyle::MediumDashed => BorderStyle::MediumDashed,
PyBorderStyle::MediumDashDotDot => BorderStyle::MediumDashDotDot,
PyBorderStyle::MediumDashDot => BorderStyle::MediumDashDot,
}
}
}
// Structs
impl From<&PyFill> for Fill {
fn from(py_fill: &PyFill) -> Self {
Fill {
pattern_type: py_fill.pattern_type.clone(),
fg_color: py_fill.fg_color.clone(),
bg_color: py_fill.bg_color.clone(),
}
}
}
impl From<&PyFont> for Font {
fn from(py_font: &PyFont) -> Self {
Font {
strike: py_font.strike,
u: py_font.u,
b: py_font.b,
i: py_font.i,
sz: py_font.sz,
color: py_font.color.clone(),
name: py_font.name.clone(),
family: py_font.family,
scheme: py_font.scheme.clone().into(),
}
}
}
impl From<&PyBorderItem> for BorderItem {
fn from(py_item: &PyBorderItem) -> Self {
BorderItem {
style: (&py_item.style).into(),
color: py_item.color.clone(),
}
}
}
impl From<&PyBorder> for Border {
fn from(py_border: &PyBorder) -> Self {
Border {
diagonal_up: py_border.diagonal_up,
diagonal_down: py_border.diagonal_down,
left: py_border.left.as_ref().map(|item| item.into()),
right: py_border.right.as_ref().map(|item| item.into()),
top: py_border.top.as_ref().map(|item| item.into()),
bottom: py_border.bottom.as_ref().map(|item| item.into()),
diagonal: py_border.diagonal.as_ref().map(|item| item.into()),
}
}
}
impl From<&PyAlignment> for Alignment {
fn from(py_align: &PyAlignment) -> Self {
Alignment {
horizontal: py_align.horizontal.clone().into(),
vertical: py_align.vertical.clone().into(),
wrap_text: py_align.wrap_text,
}
}
}
impl From<&PyStyle> for Style {
fn from(py_style: &PyStyle) -> Self {
Style {
alignment: py_style.alignment.as_ref().map(|a| a.into()),
num_fmt: py_style.num_fmt.clone(),
fill: (&py_style.fill).into(),
font: (&py_style.font).into(),
border: (&py_style.border).into(),
quote_prefix: py_style.quote_prefix,
}
}
}
// From non-Py to Py
impl From<Fill> for PyFill {
fn from(fill: Fill) -> Self {
PyFill {
pattern_type: fill.pattern_type,
fg_color: fill.fg_color,
bg_color: fill.bg_color,
}
}
}
// From non-Py to Py
impl From<HorizontalAlignment> for PyHorizontalAlignment {
fn from(align: HorizontalAlignment) -> Self {
match align {
HorizontalAlignment::Center => PyHorizontalAlignment::Center,
HorizontalAlignment::CenterContinuous => PyHorizontalAlignment::CenterContinuous,
HorizontalAlignment::Distributed => PyHorizontalAlignment::Distributed,
HorizontalAlignment::Fill => PyHorizontalAlignment::Fill,
HorizontalAlignment::General => PyHorizontalAlignment::General,
HorizontalAlignment::Justify => PyHorizontalAlignment::Justify,
HorizontalAlignment::Left => PyHorizontalAlignment::Left,
HorizontalAlignment::Right => PyHorizontalAlignment::Right,
}
}
}
// From non-Py to Py
impl From<VerticalAlignment> for PyVerticalAlignment {
fn from(align: VerticalAlignment) -> Self {
match align {
VerticalAlignment::Bottom => PyVerticalAlignment::Bottom,
VerticalAlignment::Center => PyVerticalAlignment::Center,
VerticalAlignment::Distributed => PyVerticalAlignment::Distributed,
VerticalAlignment::Justify => PyVerticalAlignment::Justify,
VerticalAlignment::Top => PyVerticalAlignment::Top,
}
}
}
// From non-Py to Py
impl From<FontScheme> for PyFontScheme {
fn from(scheme: FontScheme) -> Self {
match scheme {
FontScheme::Minor => PyFontScheme::Minor,
FontScheme::Major => PyFontScheme::Major,
FontScheme::None => PyFontScheme::None,
}
}
}
// From non-Py to Py
impl From<BorderStyle> for PyBorderStyle {
fn from(style: BorderStyle) -> Self {
match style {
BorderStyle::Thin => PyBorderStyle::Thin,
BorderStyle::Medium => PyBorderStyle::Medium,
BorderStyle::Thick => PyBorderStyle::Thick,
BorderStyle::Double => PyBorderStyle::Double,
BorderStyle::Dotted => PyBorderStyle::Dotted,
BorderStyle::SlantDashDot => PyBorderStyle::SlantDashDot,
BorderStyle::MediumDashed => PyBorderStyle::MediumDashed,
BorderStyle::MediumDashDotDot => PyBorderStyle::MediumDashDotDot,
BorderStyle::MediumDashDot => PyBorderStyle::MediumDashDot,
}
}
}
// From non-Py to Py
impl From<Font> for PyFont {
fn from(font: Font) -> Self {
PyFont {
strike: font.strike,
u: font.u,
b: font.b,
i: font.i,
sz: font.sz,
color: font.color,
name: font.name,
family: font.family,
scheme: font.scheme.into(),
}
}
}
// From non-Py to Py
impl From<BorderItem> for PyBorderItem {
fn from(item: BorderItem) -> Self {
PyBorderItem {
style: item.style.into(),
color: item.color,
}
}
}
// From non-Py to Py
impl From<Border> for PyBorder {
fn from(border: Border) -> Self {
PyBorder {
diagonal_up: border.diagonal_up,
diagonal_down: border.diagonal_down,
left: border.left.map(|item| item.into()),
right: border.right.map(|item| item.into()),
top: border.top.map(|item| item.into()),
bottom: border.bottom.map(|item| item.into()),
diagonal: border.diagonal.map(|item| item.into()),
}
}
}
// From non-Py to Py
impl From<Alignment> for PyAlignment {
fn from(align: Alignment) -> Self {
PyAlignment {
horizontal: align.horizontal.into(),
vertical: align.vertical.into(),
wrap_text: align.wrap_text,
}
}
}
// From non-Py to Py
impl From<Style> for PyStyle {
fn from(style: Style) -> Self {
PyStyle {
alignment: style.alignment.map(|a| a.into()),
num_fmt: style.num_fmt,
fill: style.fill.into(),
font: style.font.into(),
border: style.border.into(),
quote_prefix: style.quote_prefix,
}
}
}

View File

@@ -0,0 +1,8 @@
import ironcalc as ic
def test_simple():
model = ic.create("model", "en", "UTC")
model.set_user_input(0, 1, 1, "=1+2")
model.evaluate()
assert model.get_formatted_cell_value(0, 1, 1) == "3"

View File

@@ -14,7 +14,7 @@ crate-type = ["cdylib"]
# Uses `../ironcalc/base` when used locally, and uses
# the inicated version from crates.io when published.
# https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#multiple-locations
ironcalc_base = { path = "../../base", version = "0.1" }
ironcalc_base = { path = "../../base", version = "0.2" }
serde = { version = "1.0", features = ["derive"] }
wasm-bindgen = "0.2.92"
serde-wasm-bindgen = "0.4"

View File

@@ -4,7 +4,7 @@ use wasm_bindgen::{
};
use ironcalc_base::{
expressions::{lexer::util::get_tokens as tokenizer, types::Area},
expressions::{lexer::util::get_tokens as tokenizer, types::Area, utils::number_to_column},
types::{CellType, Style},
BorderArea, UserModel as BaseModel,
};
@@ -20,6 +20,15 @@ pub fn get_tokens(formula: &str) -> Result<JsValue, JsError> {
let tokens = tokenizer(formula);
serde_wasm_bindgen::to_value(&tokens).map_err(JsError::from)
}
#[wasm_bindgen(js_name = "columnNameFromNumber")]
pub fn column_name_from_number(column: i32) -> Result<String, JsError> {
match number_to_column(column) {
Some(c) => Ok(c),
None => Err(JsError::new("Invalid column number")),
}
}
#[wasm_bindgen]
pub struct Model {
model: BaseModel,
@@ -28,8 +37,8 @@ pub struct Model {
#[wasm_bindgen]
impl Model {
#[wasm_bindgen(constructor)]
pub fn new(locale: &str, timezone: &str) -> Result<Model, JsError> {
let model = BaseModel::new_empty("workbook", locale, timezone).map_err(to_js_error)?;
pub fn new(name: &str, locale: &str, timezone: &str) -> Result<Model, JsError> {
let model = BaseModel::new_empty(name, locale, timezone).map_err(to_js_error)?;
Ok(Model { model })
}
@@ -473,4 +482,19 @@ impl Model {
.map_err(|e| to_js_error(e.to_string()))?;
Ok(())
}
#[wasm_bindgen(js_name = "toBytes")]
pub fn to_bytes(&self) -> Vec<u8> {
self.model.to_bytes()
}
#[wasm_bindgen(js_name = "getName")]
pub fn get_name(&self) -> String {
self.model.get_name()
}
#[wasm_bindgen(js_name = "setName")]
pub fn set_name(&mut self, name: &str) {
self.model.set_name(name);
}
}

View File

@@ -133,20 +133,6 @@ interface CellStyleFont {
scheme: string;
}
// export enum BorderType {
// BorderAll,
// BorderInner,
// BorderCenterH,
// BorderCenterV,
// BorderOuter,
// BorderNone,
// BorderTop,
// BorderRight,
// BorderBottom,
// BorderLeft,
// None,
// }
export interface BorderOptions {
color: string;
style: BorderStyle;

1
webapp/.gitignore vendored
View File

@@ -1,3 +1,2 @@
node_modules/*
dist/*
example.json

View File

@@ -1,21 +0,0 @@
import type { StorybookConfig } from '@storybook/react-vite';
const config: StorybookConfig = {
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
addons: [
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/addon-onboarding',
'@storybook/addon-interactions',
'@storybook/addon-mdx-gfm',
'@chromatic-com/storybook'
],
framework: {
name: '@storybook/react-vite',
options: {},
},
docs: {
autodocs: 'tag',
},
};
export default config;

View File

@@ -1,29 +0,0 @@
import type { Preview } from '@storybook/react';
import i18n from '../src/i18n';
import { I18nextProvider } from 'react-i18next';
import React from 'react';
const withI18next = (Story: any) => {
return (
<I18nextProvider i18n={i18n}>
<Story />
</I18nextProvider>
);
};
const preview: Preview = {
parameters: {
actions: { argTypesRegex: '^on[A-Z].*' },
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/i,
},
},
},
};
export const decorators = [withI18next];
export default preview;

View File

@@ -1,21 +1,58 @@
# IronCalc Web App
The webapp is build with React and TypeScript. We use icons from [Lucide](https://lucide.dev/)
## Build
First thing build the wasm is the `../bindings/wasm` folder.
If you have nodejs installed you just need to:
```bash
npm install
```
## Local development
```bash
npm run dev
```
# Deploy
## Linter and formatting
We use [biome](https://biomejs.dev/):
```
npm run check
```
Will check for linter and formatting issues.
## Testing
We use vitest. Simply:
```
npm run test
```
Warning: There is only the testing infrastructure in place.
## Deploy
Deploying is a bit of a manual hassle right now:
To build a deployable frontend:
```bash
npm install
npm run build
```
Please copy the `inroncalc.svg` icon and the models you want to have as 'examples' in the internal 'ic' format.
I normally compress the wasm and js files with brotli
```
brotli wasm_bg-*****.wasm
```
Copy to the final destination and you are good to go.

18
webapp/biome.json Normal file
View File

@@ -0,0 +1,18 @@
{
"organizeImports": { "enabled": true },
"linter": {
"enabled": true,
"rules": {
"correctness": { "noUnusedImports": "error" }
}
},
"formatter": {
"indentStyle": "space",
"indentWidth": 2
},
"css": {
"formatter": {
"enabled": true
}
}
}

Binary file not shown.

View File

@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<!-- <link rel="icon" type="image/svg+xml" href="/vite.svg" /> -->
<link rel="icon" type="image/svg+xml" href="/ironcalc.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!-- <meta name="theme-color" content="#1bb566"> -->
<meta name="theme-color" media="(prefers-color-scheme: light)" content="#F2994A" />

View File

@@ -1,15 +0,0 @@
import type { Config } from "jest";
// import {defaults} from 'jest-config';
const config: Config = {
// testMatch:["**.jest.mjs"],
moduleFileExtensions: ["js", "ts", "mts", "mjs"],
transform: {
"^.+\\.[jt]s?$": "ts-jest",
},
moduleNameMapper: {
"^@ironcalc/wasm$": "<rootDir>/node_modules/@ironcalc/nodejs/"
},
};
export default config;

14540
webapp/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,57 +1,37 @@
{
"name": "frontend",
"private": true,
"version": "0.1.3",
"version": "0.2.0",
"type": "module",
"scripts": {
"restore": "cp node_modules/@ironcalc/wasm/wasm_bg.wasm node_modules/.vite/deps/",
"dev": "vite",
"test": "jest",
"build": "tsc && vite build",
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"preview": "vite preview",
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build"
"check": "biome check ./src",
"check-write": "biome check --write ./src",
"test": "vitest run"
},
"dependencies": {
"@emotion/react": "^11.11.4",
"@emotion/styled": "^11.11.5",
"@ironcalc/wasm": "file:../bindings/wasm/pkg",
"@mui/material": "^5.15.15",
"@storybook/test": "^8.0.8",
"i18next": "^23.11.1",
"lucide-react": "^0.375.0",
"lucide-react": "^0.427.0",
"react": "^18.2.0",
"react-colorful": "^5.6.1",
"react-dom": "^18.2.0",
"react-i18next": "^13.5.0"
},
"devDependencies": {
"@chromatic-com/storybook": "^1.3.2",
"@storybook/addon-essentials": "^8.0.8",
"@storybook/addon-interactions": "^8.0.8",
"@storybook/addon-links": "^8.0.8",
"@storybook/addon-mdx-gfm": "^8.0.8",
"@storybook/addon-onboarding": "^8.0.8",
"@storybook/blocks": "^8.0.8",
"@storybook/react": "^8.0.8",
"@storybook/react-vite": "^8.0.8",
"@types/jest": "^29.5.12",
"@biomejs/biome": "1.8.3",
"@types/react": "^18.2.75",
"@types/react-dom": "^18.2.24",
"@typescript-eslint/eslint-plugin": "^6.21.0",
"@typescript-eslint/parser": "^6.21.0",
"@vitejs/plugin-react": "^4.2.1",
"eslint": "^8.57.0",
"eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-react-refresh": "^0.4.6",
"eslint-plugin-storybook": "^0.6.15",
"jest": "^29.7.0",
"storybook": "^8.0.8",
"ts-jest": "^29.1.2",
"ts-node": "^10.9.2",
"typescript": "^5.4.5",
"vite": "^5.2.8",
"vite-plugin-svgr": "^4.2.0"
"vite-plugin-svgr": "^4.2.0",
"vitest": "^2.0.5"
}
}

View File

@@ -1,6 +1,6 @@
#root {
position: absolute;
inset: 10px;
border: 1px solid #AAA;
border-radius: 4px;
}
position: absolute;
inset: 0px;
margin: 0px;
border: none;
}

View File

@@ -1,37 +1,112 @@
import "./App.css";
import Workbook from "./components/workbook";
import "./i18n";
import { useEffect, useState } from "react";
import styled from "@emotion/styled";
import init, { Model } from "@ironcalc/wasm";
import { useEffect, useState } from "react";
import { FileBar } from "./AppComponents/FileBar";
import {
createNewModel,
loadModelFromStorageOrCreate,
saveModelToStorage,
saveSelectedModelInStorage,
selectModelFromStorage,
} from "./AppComponents/storage";
import { WorkbookState } from "./components/workbookState";
function App() {
const [model, setModel] = useState<Model | null>(null);
const [workbookState, setWorkbookState] = useState<WorkbookState | null>(
null
null,
);
useEffect(() => {
async function start() {
await init();
const model_bytes = new Uint8Array(await (await fetch("./example.ic")).arrayBuffer());
const _model = Model.from_bytes(model_bytes);
// const _model = new Model("en", "UTC");
if (!model) setModel(_model);
if (!workbookState) setWorkbookState(new WorkbookState());
const queryString = window.location.search;
const urlParams = new URLSearchParams(queryString);
const modelHash = urlParams.get("model");
// If there is a model name ?model=modelHash we try to load it
// if there is not, or the loading failed we load an empty model
if (modelHash) {
// Get a remote model
try {
const model_bytes = new Uint8Array(
await (await fetch(`/api/model/${modelHash}`)).arrayBuffer(),
);
const importedModel = Model.from_bytes(model_bytes);
localStorage.removeItem("selected");
setModel(importedModel);
} catch (e) {
alert("Model not found, or failed to load");
}
} else {
// try to load from local storage
const newModel = loadModelFromStorageOrCreate();
setModel(newModel);
}
setWorkbookState(new WorkbookState());
}
start();
}, []);
if (!model || !workbookState) {
return <div>Loading</div>;
return <Loading>Loading</Loading>;
}
// We try to save the model every second
setInterval(() => {
const queue = model.flushSendQueue();
if (queue.length !== 1) {
saveSelectedModelInStorage(model);
}
}, 1000);
// We could use context for model, but the problem is that it should initialized to null.
// Passing the property down makes sure it is always defined.
return (
<Workbook model={model} workbookState={workbookState} />
<Wrapper>
<FileBar
model={model}
onModelUpload={async (blob) => {
const bytes = new Uint8Array(await blob.arrayBuffer());
const newModel = Model.from_bytes(bytes);
saveModelToStorage(newModel);
setModel(newModel);
}}
newModel={() => {
setModel(createNewModel());
}}
setModel={(uuid: string) => {
const newModel = selectModelFromStorage(uuid);
if (newModel) {
setModel(newModel);
}
}}
/>
<Workbook model={model} workbookState={workbookState} />
</Wrapper>
);
}
export default App;
const Wrapper = styled("div")`
margin: 0px;
padding: 0px;
width: 100%;
height: 100%;
display: flex;
flex-direction: column;
position: absolute;
`;
const Loading = styled("div")`
height: 100%;
display: flex;
align-items: center;
justify-content: center;
font-size: 36px;
`;
export default App;

View File

@@ -0,0 +1,108 @@
import styled from "@emotion/styled";
import type { Model } from "@ironcalc/wasm";
import { IronCalcLogo } from "./../icons";
import { FileMenu } from "./FileMenu";
import { ShareButton } from "./ShareButton";
import { WorkbookTitle } from "./WorkbookTitle";
import { updateNameSelectedWorkbook } from "./storage";
export function FileBar(properties: {
model: Model;
newModel: () => void;
setModel: (key: string) => void;
onModelUpload: (blob: Blob) => void;
}) {
return (
<FileBarWrapper>
<IronCalcLogo style={{ width: "120px", marginLeft: "10px" }} />
<Divider />
<FileMenu
newModel={properties.newModel}
setModel={properties.setModel}
onModelUpload={properties.onModelUpload}
onDownload={() => {
const model = properties.model;
const arrayBuffer = model.toBytes();
const fileName = model.getName();
fetch("/api/download", {
method: "POST",
headers: {
"Content-Type": "application/octet-stream",
"Content-Disposition": `attachment; filename="${fileName}"`,
},
body: arrayBuffer,
})
.then((response) => {
if (!response.ok) throw new Error("Network response was not ok");
return response.blob();
})
.then((blob) => {
// Create a link element and trigger a download
const url = window.URL.createObjectURL(blob);
const a = document.createElement("a");
a.style.display = "none";
a.href = url;
// Use the same filename or change as needed
a.download = `${fileName}.xlsx`;
document.body.appendChild(a);
a.click();
// Clean up
window.URL.revokeObjectURL(url);
a.remove();
})
.catch((error) => {
console.error("Error:", error);
});
}}
/>
<WorkbookTitle
name={properties.model.getName()}
onNameChange={(name) => {
properties.model.setName(name);
updateNameSelectedWorkbook(properties.model, name);
}}
/>
<ShareButton
onClick={() => {
const model = properties.model;
const arrayBuffer = model.toBytes();
const fileName = model.getName();
fetch("/api/share", {
method: "POST",
headers: {
"Content-Type": "application/octet-stream",
"Content-Disposition": `attachment; filename="${fileName}"`,
},
body: arrayBuffer,
})
.then((response) => {
if (!response.ok) throw new Error("Network response was not ok");
return response.text();
})
.then((hash) => {
console.log(hash);
});
}}
/>
</FileBarWrapper>
);
}
const Divider = styled("div")`
margin: 10px;
height: 12px;
border-left: 1px solid #e0e0e0;
`;
const FileBarWrapper = styled("div")`
height: 60px;
width: 100%;
background: "#FFF";
display: flex;
line-height: 60px;
align-items: center;
border-bottom: 1px solid grey;
position: relative;
`;

View File

@@ -0,0 +1,120 @@
import styled from "@emotion/styled";
import { Menu, MenuItem, Modal } from "@mui/material";
import { useRef, useState } from "react";
import { UploadFileDialog } from "./UploadFileDialog";
import { getModelsMetadata, getSelectedUuuid } from "./storage";
export function FileMenu(props: {
newModel: () => void;
setModel: (key: string) => void;
onDownload: () => void;
onModelUpload: (blob: Blob) => void;
}) {
const [isMenuOpen, setMenuOpen] = useState(false);
const [isImportMenuOpen, setImportMenuOpen] = useState(false);
const anchorElement = useRef<HTMLDivElement>(null);
const models = getModelsMetadata();
const uuids = Object.keys(models);
const selectedUuid = getSelectedUuuid();
const elements = [];
for (const uuid of uuids) {
elements.push(
<MenuItemWrapper
key={uuid}
onClick={() => {
props.setModel(uuid);
setMenuOpen(false);
}}
style={{ justifyContent: "flex-start" }}
>
<span style={{ width: "20px" }}>
{uuid === selectedUuid ? "•" : ""}
</span>
<MenuItemText>{models[uuid]}</MenuItemText>
</MenuItemWrapper>,
);
}
return (
<>
<FileMenuWrapper
onClick={(): void => setMenuOpen(true)}
ref={anchorElement}
>
File
</FileMenuWrapper>
<Menu
open={isMenuOpen}
onClose={(): void => setMenuOpen(false)}
anchorEl={anchorElement.current}
// anchorOrigin={properties.anchorOrigin}
>
<MenuItemWrapper onClick={props.newModel}>
<MenuItemText>New</MenuItemText>
</MenuItemWrapper>
<MenuItemWrapper
onClick={() => {
setImportMenuOpen(true);
setMenuOpen(false);
}}
>
<MenuItemText>Import</MenuItemText>
</MenuItemWrapper>
<MenuItemWrapper>
<MenuItemText onClick={props.onDownload}>
Download (.xlsx)
</MenuItemText>
</MenuItemWrapper>
<MenuDivider />
{elements}
</Menu>
<Modal
open={isImportMenuOpen}
onClose={() => {
setImportMenuOpen(false);
}}
aria-labelledby="modal-modal-title"
aria-describedby="modal-modal-description"
>
<>
<UploadFileDialog
onClose={() => setImportMenuOpen(false)}
onModelUpload={props.onModelUpload}
/>
</>
</Modal>
</>
);
}
const MenuDivider = styled("div")`
width: 80%;
margin: auto;
border-top: 1px solid #e0e0e0;
`;
const MenuItemText = styled("div")`
color: #000;
`;
const MenuItemWrapper = styled(MenuItem)`
display: flex;
justify-content: space-between;
font-size: 14px;
width: 100%;
`;
const FileMenuWrapper = styled("div")`
display: flex;
align-items: center;
font-size: 12px;
font-family: Inter;
padding: 10px;
height: 20px;
border-radius: 4px;
margin: 10px;
&:hover {
background-color: #f2f2f2;
}
`;

View File

@@ -0,0 +1,28 @@
import { Share2 } from "lucide-react";
export function ShareButton(properties: { onClick: () => void }) {
const { onClick } = properties;
return (
<div
onClick={onClick}
onKeyDown={() => {}}
style={{
position: "absolute",
right: "0px",
cursor: "pointer",
color: "#FFFFFF",
background: "#F2994A",
padding: "0px 10px",
height: "36px",
lineHeight: "36px",
borderRadius: "4px",
marginRight: "10px",
display: "flex",
alignItems: "center",
}}
>
<Share2 style={{ width: "16px", height: "16px", marginRight: "10px" }} />
<span>Share</span>
</div>
);
}

View File

@@ -0,0 +1,263 @@
import styled from "@emotion/styled";
import { BookOpen, FileUp } from "lucide-react";
import { type DragEvent, useRef, useState } from "react";
export function UploadFileDialog(properties: {
onClose: () => void;
onModelUpload: (blob: Blob) => void;
}) {
const [hover, setHover] = useState(false);
const [message, setMessage] = useState("Drop file here");
const fileInputRef = useRef<HTMLInputElement>(null);
const { onClose, onModelUpload } = properties;
const handleDragEnter = (event: DragEvent<HTMLDivElement>) => {
event.preventDefault();
event.stopPropagation();
console.log("Enter");
setHover(true);
};
const handleDragOver = (event: DragEvent<HTMLDivElement>) => {
event.preventDefault();
event.stopPropagation();
event.dataTransfer.dropEffect = "copy";
// setHover(true);
};
const handleDragLeave = (event: DragEvent<HTMLDivElement>) => {
event.preventDefault();
event.stopPropagation();
console.log("Leave");
setHover(false);
};
const handleDrop = (event: DragEvent<HTMLDivElement>) => {
event.preventDefault();
event.stopPropagation();
console.log("Dropping");
const dt = event.dataTransfer;
const items = dt.items;
if (items) {
// Use DataTransferItemList to access the file(s)
for (let i = 0; i < items.length; i++) {
// If dropped items aren't files, skip them
if (items[i].kind === "file") {
const file = items[i].getAsFile();
if (file) {
handleFileUpload(file);
}
}
}
} else {
const files = dt.files;
for (let i = 0; i < files.length; i++) {
handleFileUpload(files[i]);
}
}
};
const handleFileUpload = (file: File) => {
setMessage(`Uploading ${file.name}...`);
// Read the file as ArrayBuffer
const reader = new FileReader();
reader.onload = () => {
const arrayBuffer = reader.result;
// Fetch request to upload the file
fetch("/api/upload", {
method: "POST",
headers: {
"Content-Type": "application/octet-stream",
"Content-Disposition": `attachment; filename="${file.name}"`,
},
body: arrayBuffer,
})
.then((response) => {
if (!response.ok) throw new Error("Network response was not ok");
return response.blob();
})
.then((blob) => {
setMessage(`File ${file.name} uploaded successfully!`);
onModelUpload(blob);
})
.catch((error) => {
setMessage(`Error uploading file: ${error.message}`);
});
};
reader.readAsArrayBuffer(file);
};
return (
<UploadDialog>
<UploadTitle>
<span style={{ flexGrow: 2, marginLeft: 12 }}>Import a .xlsx File</span>
<Cross
style={{ marginRight: 12 }}
onClick={onClose}
onKeyDown={() => {}}
>
<svg
width="16"
height="16"
viewBox="0 0 16 16"
fill="none"
xmlns="http://www.w3.org/2000/svg"
>
<title>Close</title>
<path
d="M12 4.5L4 12.5"
stroke="#333333"
strokeLinecap="round"
strokeLinejoin="round"
/>
<path
d="M4 4.5L12 12.5"
stroke="#333333"
strokeLinecap="round"
strokeLinejoin="round"
/>
</svg>
</Cross>
</UploadTitle>
<DropZone
onDragEnter={handleDragEnter}
onDragOver={handleDragOver}
// onDragLeave={handleDragLeave}
onDragExit={handleDragLeave}
onDrop={handleDrop}
>
{!hover ? (
<>
<div style={{ flexGrow: 2 }} />
<div>
<FileUp
style={{
width: 16,
color: "#EFAA6D",
backgroundColor: "#F2994A1A",
padding: "2px 4px",
borderRadius: 4,
}}
/>
</div>
<div style={{ fontSize: 12 }}>
<span style={{ color: "#333333" }}>
Drag and drop a file here or{" "}
</span>
<input
ref={fileInputRef}
type="file"
multiple
accept="*"
style={{ display: "none" }}
onChange={(event) => {
const files = event.target.files;
if (files) {
for (const file of files) {
handleFileUpload(file);
}
}
}}
/>
<DocLink
onClick={() => {
if (fileInputRef.current) {
fileInputRef.current.click();
}
}}
>
click to browse
</DocLink>
</div>
<div style={{ flexGrow: 2 }} />
</>
) : (
<>
<div style={{ flexGrow: 2 }} />
<div>Drop file here</div>
<div style={{ flexGrow: 2 }} />
</>
)}
</DropZone>
<UploadFooter>
<BookOpen
style={{ width: 16, height: 16, marginLeft: 12, marginRight: 8 }}
/>
<span>Learn more about importing files into IronCalc</span>
</UploadFooter>
</UploadDialog>
);
}
const Cross = styled("div")`
&:hover {
background-color: #f5f5f5;
}
border-radius: 4px;
height: 16px;
width: 16px;
`;
const DocLink = styled("span")`
color: #f2994a;
text-decoration: underline;
`;
const UploadFooter = styled("div")`
height: 40px;
border-top: 1px solid #e0e0e0;
font-size: 12px;
font-weight: 400;
color: #757575;
display: flex;
align-items: center;
`;
const UploadTitle = styled("div")`
display: flex;
align-items: center;
border-bottom: 1px solid #e0e0e0;
height: 40px;
font-size: 14px;
font-weight: 500;
`;
const UploadDialog = styled("div")`
display: flex;
flex-direction: column;
position: absolute;
left: 50%;
top: 50%;
transform: translate(-50%, -50%);
width: 455px;
height: 285px;
background: #fff;
border: 1px solid #e0e0e0;
border-radius: 8px;
box-shadow: 0px 1px 3px 0px #0000001a;
font-family: Inter;
`;
const DropZone = styled("div")`
flex-grow: 2;
border-radius: 10px;
text-align: center;
margin: 12px;
color: #aaa;
font-family: Arial, sans-serif;
cursor: pointer;
background-color: #faebd7;
border: 1px dashed #f2994a;
background: linear-gradient(
180deg,
rgba(242, 153, 74, 0.08) 0%,
rgba(242, 153, 74, 0) 100%
);
display: flex;
flex-direction: column;
vertical-align: center;
`;

View File

@@ -0,0 +1,100 @@
import styled from "@emotion/styled";
import { type ChangeEvent, useEffect, useRef, useState } from "react";
export function WorkbookTitle(props: {
name: string;
onNameChange: (name: string) => void;
}) {
const [width, setWidth] = useState(0);
const [value, setValue] = useState(props.name);
const mirrorDivRef = useRef<HTMLDivElement>(null);
const handleChange = (event: ChangeEvent<HTMLTextAreaElement>) => {
setValue(event.target.value);
if (mirrorDivRef.current) {
setWidth(mirrorDivRef.current.scrollWidth);
}
};
useEffect(() => {
if (mirrorDivRef.current) {
setWidth(mirrorDivRef.current.scrollWidth);
}
}, []);
useEffect(() => {
setValue(props.name);
}, [props.name]);
return (
<div
style={{
position: "absolute",
left: "50%",
textAlign: "center",
transform: "translateX(-50%)",
// height: "60px",
// lineHeight: "60px",
padding: "8px",
fontSize: "14px",
fontWeight: "700",
fontFamily: "Inter",
width,
}}
>
<TitleWrapper
value={value}
rows={1}
onChange={handleChange}
onBlur={(event) => {
props.onNameChange(event.target.value);
}}
style={{ width: width }}
spellCheck="false"
>
{value}
</TitleWrapper>
<div
ref={mirrorDivRef}
style={{
position: "absolute",
top: "-9999px",
left: "-9999px",
whiteSpace: "pre-wrap",
textWrap: "nowrap",
visibility: "hidden",
fontFamily: "inherit",
fontSize: "inherit",
lineHeight: "inherit",
padding: "inherit",
border: "inherit",
}}
>
{value}
</div>
</div>
);
}
const TitleWrapper = styled("textarea")`
vertical-align: middle;
text-align: center;
height: 20px;
line-height: 20px;
border-radius: 4px;
padding: inherit;
overflow: hidden;
outline: none;
resize: none;
text-wrap: nowrap;
border: none;
&:hover {
background-color: #f2f2f2;
}
&:focus {
border: 1px solid grey;
}
font-weight: inherit;
font-family: inherit;
font-size: inherit;
`;

View File

@@ -0,0 +1,112 @@
import { Model } from "@ironcalc/wasm";
import { base64ToBytes, bytesToBase64 } from "./util";
const MAX_WORKBOOKS = 50;
type ModelsMetadata = Record<string, string>;
export function updateNameSelectedWorkbook(model: Model, newName: string) {
const uuid = localStorage.getItem("selected");
if (uuid) {
const modelsJson = localStorage.getItem("models");
if (modelsJson) {
try {
const models = JSON.parse(modelsJson);
models[uuid] = newName;
localStorage.setItem("models", JSON.stringify(models));
} catch (e) {
console.warn("Failed saving new name");
}
}
const modeBytes = model.toBytes();
localStorage.setItem(uuid, bytesToBase64(modeBytes));
}
}
export function getModelsMetadata(): ModelsMetadata {
let modelsJson = localStorage.getItem("models");
if (!modelsJson) {
modelsJson = "{}";
}
return JSON.parse(modelsJson);
}
// Pick a different name Workbook{N} where N = 1, 2, 3
function getNewName(existingNames: string[]): string {
const baseName = "Workbook";
let index = 1;
while (index < MAX_WORKBOOKS) {
const name = `${baseName}${index}`;
index += 1;
if (!existingNames.includes(name)) {
return name;
}
}
// FIXME: Too many workbooks?
return "Workbook-Infinity";
}
export function createNewModel(): Model {
const models = getModelsMetadata();
const name = getNewName(Object.values(models));
const model = new Model(name, "en", "UTC");
const uuid = crypto.randomUUID();
localStorage.setItem("selected", uuid);
localStorage.setItem(uuid, bytesToBase64(model.toBytes()));
models[uuid] = name;
localStorage.setItem("models", JSON.stringify(models));
return model;
}
export function loadModelFromStorageOrCreate(): Model {
const uuid = localStorage.getItem("selected");
if (uuid) {
// We try to load the selected model
const modelBytesString = localStorage.getItem(uuid);
if (modelBytesString) {
return Model.from_bytes(base64ToBytes(modelBytesString));
}
// If it doesn't exist we create one at that uuid
const newModel = new Model("Workbook1", "en", "UTC");
localStorage.setItem("selected", uuid);
localStorage.setItem(uuid, bytesToBase64(newModel.toBytes()));
return newModel;
}
// If there was no selected model we create a new one
return createNewModel();
}
export function saveSelectedModelInStorage(model: Model) {
const uuid = localStorage.getItem("selected");
if (uuid) {
const modeBytes = model.toBytes();
localStorage.setItem(uuid, bytesToBase64(modeBytes));
}
}
export function saveModelToStorage(model: Model) {
const uuid = crypto.randomUUID();
localStorage.setItem("selected", uuid);
localStorage.setItem(uuid, bytesToBase64(model.toBytes()));
let modelsJson = localStorage.getItem("models");
if (!modelsJson) {
modelsJson = "{}";
}
const models = JSON.parse(modelsJson);
models[uuid] = model.getName();
localStorage.setItem("models", JSON.stringify(models));
}
export function selectModelFromStorage(uuid: string): Model | undefined {
localStorage.setItem("selected", uuid);
const modelBytesString = localStorage.getItem(uuid);
if (modelBytesString) {
return Model.from_bytes(base64ToBytes(modelBytesString));
}
}
export function getSelectedUuuid(): string | null {
return localStorage.getItem("selected");
}

View File

@@ -0,0 +1,18 @@
export function base64ToBytes(base64: string): Uint8Array {
// const binString = atob(base64);
// return Uint8Array.from(binString, (m) => m.codePointAt(0));
return new Uint8Array(
atob(base64)
.split("")
.map((c) => c.charCodeAt(0)),
);
}
export function bytesToBase64(bytes: Uint8Array): string {
const binString = Array.from(bytes, (byte) =>
String.fromCodePoint(byte),
).join("");
// btoa(String.fromCharCode(...bytes));
return btoa(binString);
}

View File

@@ -1,18 +1,18 @@
export const headerCornerBackground = '#FFF';
export const headerTextColor = '#333';
export const headerBackground = '#FFF';
export const headerGlobalSelectorColor = '#EAECF4';
export const headerSelectedBackground = '#EEEEEE';
export const headerFullSelectedBackground = '#D3D6E9';
export const headerSelectedColor = '#333';
export const headerBorderColor = '#DEE0EF';
export const headerCornerBackground = "#FFF";
export const headerTextColor = "#333";
export const headerBackground = "#FFF";
export const headerGlobalSelectorColor = "#EAECF4";
export const headerSelectedBackground = "#EEEEEE";
export const headerFullSelectedBackground = "#D3D6E9";
export const headerSelectedColor = "#333";
export const headerBorderColor = "#DEE0EF";
export const gridColor = '#D3D6E9';
export const gridSeparatorColor = '#D3D6E9';
export const defaultTextColor = '#2E414D';
export const gridColor = "#D3D6E9";
export const gridSeparatorColor = "#D3D6E9";
export const defaultTextColor = "#2E414D";
export const outlineColor = '#F2994A';
export const outlineBackgroundColor = '#F2994A1A';
export const outlineColor = "#F2994A";
export const outlineBackgroundColor = "#F2994A1A";
export const LAST_COLUMN = 16_384;
export const LAST_ROW = 1_048_576;

View File

@@ -1,23 +0,0 @@
export interface Cell {
row: number;
column: number;
}
export interface Area {
rowStart: number;
rowEnd: number;
columnStart: number;
columnEnd: number;
}
export interface SheetArea extends Area {
sheet: number;
color: string;
}
interface AreaWithBorderInterface extends Area {
border: "left" | "top" | "right" | "bottom";
}
export type AreaWithBorder = AreaWithBorderInterface | null;

View File

@@ -1,396 +0,0 @@
const letters = [
'A',
'B',
'C',
'D',
'E',
'F',
'G',
'H',
'I',
'J',
'K',
'L',
'M',
'N',
'O',
'P',
'Q',
'R',
'S',
'T',
'U',
'V',
'W',
'X',
'Y',
'Z',
];
interface Reference {
row: number;
column: number;
absoluteRow: boolean;
absoluteColumn: boolean;
}
export function referenceToString(rf: Reference): string {
const absC = rf.absoluteColumn ? '$' : '';
const absR = rf.absoluteRow ? '$' : '';
return absC + columnNameFromNumber(rf.column) + absR + rf.row;
}
export function columnNameFromNumber(column: number): string {
let columnName = '';
let index = column;
while (index > 0) {
columnName = `${letters[(index - 1) % 26]}${columnName}`;
index = Math.floor((index - 1) / 26);
}
return columnName;
}
export function columnNumberFromName(columnName: string): number {
let column = 0;
for (const character of columnName) {
const index = (character.codePointAt(0) ?? 0) - 64;
column = column * 26 + index;
}
return column;
}
// EqualTo Color Palette
export function getColor(index: number, alpha = 1): string {
const colors = [
{
name: 'Cyan',
rgba: [89, 185, 188, 1],
hex: '#59B9BC',
},
{
name: 'Flamingo',
rgba: [236, 87, 83, 1],
hex: '#EC5753',
},
{
hex: '#3358B7',
rgba: [51, 88, 183, 1],
name: 'Blue',
},
{
hex: '#F8CD3C',
rgba: [248, 205, 60, 1],
name: 'Yellow',
},
{
hex: '#3BB68A',
rgba: [59, 182, 138, 1],
name: 'Emerald',
},
{
hex: '#523E93',
rgba: [82, 62, 147, 1],
name: 'Violet',
},
{
hex: '#A23C52',
rgba: [162, 60, 82, 1],
name: 'Burgundy',
},
{
hex: '#8CB354',
rgba: [162, 60, 82, 1],
name: 'Wasabi',
},
{
hex: '#D03627',
rgba: [208, 54, 39, 1],
name: 'Red',
},
{
hex: '#1B717E',
rgba: [27, 113, 126, 1],
name: 'Teal',
},
];
if (alpha === 1) {
return colors[index % 10].hex;
}
const { rgba } = colors[index % 10];
return `rgba(${rgba[0]}, ${rgba[1]}, ${rgba[2]}, ${alpha})`;
}
export function mergedAreas(area1: Area, area2: Area): Area {
return {
rowStart: Math.min(area1.rowStart, area2.rowStart, area1.rowEnd, area2.rowEnd),
rowEnd: Math.max(area1.rowStart, area2.rowStart, area1.rowEnd, area2.rowEnd),
columnStart: Math.min(area1.columnStart, area2.columnStart, area1.columnEnd, area2.columnEnd),
columnEnd: Math.max(area1.columnStart, area2.columnStart, area1.columnEnd, area2.columnEnd),
};
}
export function getExpandToArea(area: Area, cell: Cell): AreaWithBorder {
let { rowStart, rowEnd, columnStart, columnEnd } = area;
if (rowStart > rowEnd) {
[rowStart, rowEnd] = [rowEnd, rowStart];
}
if (columnStart > columnEnd) {
[columnStart, columnEnd] = [columnEnd, columnStart];
}
const { row, column } = cell;
if (row <= rowEnd && row >= rowStart && column >= columnStart && column <= columnEnd) {
return null;
}
// Two rules:
// * The extendTo area must be larger than the selected area
// * The extendTo area must be of the same width or the same height as the selected area
if (row >= rowEnd && column >= columnStart) {
// Normal case: we are expanding down and right
if (row - rowEnd > column - columnEnd) {
// Expanding by rows (down)
return {
rowStart: rowEnd + 1,
rowEnd: row,
columnStart,
columnEnd,
border: 'top',
};
}
// expanding by columns (right)
return {
rowStart,
rowEnd,
columnStart: columnEnd + 1,
columnEnd: column,
border: 'left',
};
}
if (row >= rowEnd && column <= columnStart) {
// We are expanding down and left
if (row - rowEnd > columnStart - column) {
// Expanding by rows (down)
return {
rowStart: rowEnd + 1,
rowEnd: row,
columnStart,
columnEnd,
border: 'top',
};
}
// Expanding by columns (left)
return {
rowStart,
rowEnd,
columnStart: column,
columnEnd: columnStart - 1,
border: 'right',
};
}
if (row <= rowEnd && column >= columnEnd) {
// We are expanding up and right
if (rowStart - row > column - columnEnd) {
// Expanding by rows (up)
return {
rowStart: row,
rowEnd: rowStart - 1,
columnStart,
columnEnd,
border: 'bottom',
};
}
// Expanding by columns (right)
return {
rowStart,
rowEnd,
columnStart: columnEnd + 1,
columnEnd: column,
border: 'left',
};
}
if (row <= rowEnd && column <= columnStart) {
// We are expanding up and left
if (rowStart - row > columnStart - column) {
// Expanding by rows (up)
return {
rowStart: row,
rowEnd: rowStart - 1,
columnStart,
columnEnd,
border: 'bottom',
};
}
// Expanding by columns (left)
return {
rowStart,
rowEnd,
columnStart: column,
columnEnd: columnStart - 1,
border: 'right',
};
}
return null;
}
/**
* Returns true if the keypress should start editing
*/
export function isEditingKey(key: string): boolean {
if (key.length !== 1) {
return false;
}
const code = key.codePointAt(0) ?? 0;
if (code > 0 && code < 255) {
return true;
}
return false;
}
// / Common types
export interface Area {
rowStart: number;
rowEnd: number;
columnStart: number;
columnEnd: number;
}
interface AreaWithBorderInterface extends Area {
border: 'left' | 'top' | 'right' | 'bottom';
}
export type AreaWithBorder = AreaWithBorderInterface | null;
export interface Cell {
row: number;
column: number;
}
export interface ScrollPosition {
left: number;
top: number;
}
export interface StateSettings {
selectedCell: Cell;
selectedArea: Area;
scrollPosition: ScrollPosition;
extendToArea: AreaWithBorder;
}
export type Dispatch<A> = (value: A) => void;
export type SetStateAction<S> = S | ((prevState: S) => S);
export enum FocusType {
Cell = 'cell',
FormulaBar = 'formula-bar',
}
/**
* In Excel there are two "modes" of editing
* * `init`: When you start typing in a cell. In this mode arrow keys will move away from the cell
* * `edit`: If you double click on a cell or click in the cell while editing.
* In this mode arrow keys will move within the cell.
*
* In a formula bar mode is always `edit`.
*/
export type CellEditMode = 'init' | 'edit';
export interface CellEditingType {
/**
* ID of cell editing. Useful when one edit transforms into another and some code needs to run
* when target changes.
*
* Due to problems with focus management (see #339) it's possible to start a new cell editing
* without properly cleaning up previous one (lose focus in workbook, regain focus NOT in
* the input and then use the keyboard.
*/
id: number;
sheet: number;
row: number;
column: number;
text: string;
base: string;
mode: CellEditMode;
focus: FocusType;
}
export type NavigationKey = 'ArrowRight' | 'ArrowLeft' | 'ArrowDown' | 'ArrowUp' | 'Home' | 'End';
export const isNavigationKey = (key: string): key is NavigationKey =>
['ArrowRight', 'ArrowLeft', 'ArrowDown', 'ArrowUp', 'Home', 'End'].includes(key);
function nameNeedsQuoting(name: string): boolean {
const chars = [' ', '(', ')', "'", '$', ',', ';', '-', '+', '{', '}'];
const l = chars.length;
for (let index = 0; index < l; index += 1) {
if (name.includes(chars[index])) {
return true;
}
}
return false;
}
// FIXME: We should use the function of a similar name in the rust code.
export const quoteSheetName = (name: string): string => {
if (nameNeedsQuoting(name)) {
return `'${name.replace("'", "''")}'`;
}
return name;
};
export function cellReprToRowColumn(cellRepr: string): { row: number; column: number } {
let row = 0;
let column = 0;
for (const character of cellRepr) {
if (Number.isNaN(Number.parseInt(character, 10))) {
column *= 26;
const characterCode = character.codePointAt(0);
const ACharacterCode = 'A'.codePointAt(0);
if (typeof characterCode === 'undefined' || typeof ACharacterCode === 'undefined') {
throw new TypeError('Failed to find character code');
}
const deltaCodes = characterCode - ACharacterCode;
if (deltaCodes < 0) {
throw new Error('Incorrect character');
}
column += deltaCodes + 1;
} else {
row *= 10;
row += Number.parseInt(character, 10);
}
}
return { row, column };
}
export const getMessageCellText = (
cell: string,
getMessageSheetNumber: (sheet: string) => number | undefined,
getCellText?: (sheet: number, row: number, column: number) => string | undefined,
) => {
const messageMatch = /^=?(?<sheet>\w+)!(?<cell>\w+)/.exec(cell);
if (messageMatch && messageMatch.groups) {
const messageSheet = getMessageSheetNumber(messageMatch.groups.sheet);
const dynamicIconCell = cellReprToRowColumn(messageMatch.groups.cell);
if (messageSheet !== undefined && getCellText) {
return getCellText(messageSheet, dynamicIconCell.row, dynamicIconCell.column) || '';
}
}
return '';
};
export const getCellAddress = (selectedArea: Area, selectedCell?: Cell) => {
const isSingleCell =
selectedArea.rowStart === selectedArea.rowEnd &&
selectedArea.columnEnd === selectedArea.columnStart;
return isSingleCell && selectedCell
? `${columnNameFromNumber(selectedCell.column)}${selectedCell.row}`
: `${columnNameFromNumber(selectedArea.columnStart)}${
selectedArea.rowStart
}:${columnNameFromNumber(selectedArea.columnEnd)}${selectedArea.rowEnd}`;
};
export enum Border {
Top = 'top',
Bottom = 'bottom',
Right = 'right',
Left = 'left',
}

View File

@@ -1,6 +1,10 @@
import { Model } from "@ironcalc/wasm";
import { WorkbookState } from "../workbookState";
import type { Model } from "@ironcalc/wasm";
import { columnNameFromNumber } from "@ironcalc/wasm";
import type { Cell } from "../types";
import type { WorkbookState } from "../workbookState";
import {
LAST_COLUMN,
LAST_ROW,
defaultTextColor,
gridColor,
gridSeparatorColor,
@@ -9,11 +13,8 @@ import {
headerSelectedBackground,
headerSelectedColor,
headerTextColor,
LAST_COLUMN,
LAST_ROW,
outlineColor,
} from "./constants";
import { columnNameFromNumber } from "./util";
export interface CanvasSettings {
model: Model;
@@ -29,16 +30,12 @@ export interface CanvasSettings {
columnGuide: HTMLDivElement;
rowGuide: HTMLDivElement;
columnHeaders: HTMLDivElement;
editor: HTMLDivElement;
};
onColumnWidthChanges: (sheet: number, column: number, width: number) => void;
onRowHeightChanges: (sheet: number, row: number, height: number) => void;
}
export interface CellCoordinates {
row: number;
column: number;
}
export const fonts = {
regular: 'Inter, "Adjusted Arial Fallback", sans-serif',
mono: '"Fira Mono", "Adjusted Courier New Fallback", serif',
@@ -46,12 +43,29 @@ export const fonts = {
export const headerRowHeight = 24;
export const headerColumnWidth = 30;
export const devicePixelRatio = 1;//window.devicePixelRatio || 1;
export const devicePixelRatio = window.devicePixelRatio || 1;
export const defaultCellFontFamily = fonts.regular;
export const headerFontFamily = fonts.regular;
export const frozenSeparatorWidth = 3;
// Get a 10% transparency of an hex color
function hexToRGBA10Percent(colorHex: string): string {
// Remove the leading hash (#) if present
const hex = colorHex.replace(/^#/, "");
// Parse the hex color
const red = Number.parseInt(hex.substring(0, 2), 16);
const green = Number.parseInt(hex.substring(2, 4), 16);
const blue = Number.parseInt(hex.substring(4, 6), 16);
// Set the alpha (opacity) to 0.1 (10%)
const alpha = 0.1;
// Return the RGBA color string
return `rgba(${red}, ${green}, ${blue}, ${alpha})`;
}
export default class WorksheetCanvas {
sheetWidth: number;
@@ -65,6 +79,8 @@ export default class WorksheetCanvas {
canvas: HTMLCanvasElement;
editor: HTMLDivElement;
areaOutline: HTMLDivElement;
cellOutline: HTMLDivElement;
@@ -96,6 +112,7 @@ export default class WorksheetCanvas {
this.height = options.height;
this.ctx = this.setContext();
this.workbookState = options.workbookState;
this.editor = options.elements.editor;
this.cellOutline = options.elements.cellOutline;
this.cellOutlineHandle = options.elements.cellOutlineHandle;
@@ -105,7 +122,6 @@ export default class WorksheetCanvas {
this.columnGuide = options.elements.columnGuide;
this.columnHeaders = options.elements.columnHeaders;
// this.cellEditing = options.cellEditing;
this.onColumnWidthChanges = options.onColumnWidthChanges;
this.onRowHeightChanges = options.onRowHeightChanges;
this.resetHeaders();
@@ -124,12 +140,12 @@ export default class WorksheetCanvas {
resetHeaders(): void {
for (const handle of this.columnHeaders.querySelectorAll(
".column-resize-handle"
".column-resize-handle",
)) {
handle.remove();
}
for (const columnSeparator of this.columnHeaders.querySelectorAll(
".frozen-column-separator"
".frozen-column-separator",
)) {
columnSeparator.remove();
}
@@ -143,7 +159,7 @@ export default class WorksheetCanvas {
const context = canvas.getContext("2d");
if (!context) {
throw new Error(
"This browser does not support 2-dimensional canvas rendering contexts."
"This browser does not support 2-dimensional canvas rendering contexts.",
);
}
// If the devicePixelRatio is 2 then the canvas is twice as large to avoid blurring.
@@ -167,7 +183,7 @@ export default class WorksheetCanvas {
*/
getFrozenRowsHeight(): number {
const frozenRows = this.model.getFrozenRowsCount(
this.model.getSelectedSheet()
this.model.getSelectedSheet(),
);
if (frozenRows === 0) {
return 0;
@@ -185,7 +201,7 @@ export default class WorksheetCanvas {
*/
getFrozenColumnsWidth(): number {
const frozenColumns = this.model.getFrozenColumnsCount(
this.model.getSelectedSheet()
this.model.getSelectedSheet(),
);
if (frozenColumns === 0) {
return 0;
@@ -194,7 +210,7 @@ export default class WorksheetCanvas {
for (let column = 1; column <= frozenColumns; column += 1) {
frozenColumnsWidth += this.getColumnWidth(
this.model.getSelectedSheet(),
column
column,
);
}
return frozenColumnsWidth + frozenSeparatorWidth;
@@ -202,16 +218,16 @@ export default class WorksheetCanvas {
// Get the visible cells (aside from the frozen rows and columns)
getVisibleCells(): {
topLeftCell: CellCoordinates;
bottomRightCell: CellCoordinates;
topLeftCell: Cell;
bottomRightCell: Cell;
} {
const view = this.model.getSelectedView();
let selectedSheet = view.sheet;
const selectedSheet = view.sheet;
const frozenRows = this.model.getFrozenRowsCount(selectedSheet);
const frozenColumns = this.model.getFrozenColumnsCount(selectedSheet);
let rowTop = Math.max(frozenRows + 1, view.top_row);
const rowTop = Math.max(frozenRows + 1, view.top_row);
let rowBottom = rowTop;
let columnLeft = Math.max(frozenColumns + 1, view.left_column);
const columnLeft = Math.max(frozenColumns + 1, view.left_column);
let columnRight = columnLeft;
const frozenColumnsWidth = this.getFrozenColumnsWidth();
const frozenRowsHeight = this.getFrozenRowsHeight();
@@ -221,9 +237,8 @@ export default class WorksheetCanvas {
if (y >= this.height - rowHeight || row === LAST_ROW) {
rowBottom = row;
break;
} else {
y += rowHeight;
}
y += rowHeight;
}
let x = headerColumnWidth + frozenColumnsWidth;
@@ -232,17 +247,14 @@ export default class WorksheetCanvas {
if (x >= this.width - columnWidth || column === LAST_COLUMN) {
columnRight = column;
break;
} else {
x += columnWidth;
}
x += columnWidth;
}
let cells = {
const cells = {
topLeftCell: { row: rowTop, column: columnLeft },
bottomRightCell: { row: rowBottom, column: columnRight },
}
this.workbookState.setVisibleCells(cells)
};
return cells;
}
@@ -321,7 +333,7 @@ export default class WorksheetCanvas {
x: number,
y: number,
width: number,
height: number
height: number,
): void {
const selectedSheet = this.model.getSelectedSheet();
const style = this.model.getCellStyle(selectedSheet, row, column);
@@ -345,11 +357,11 @@ export default class WorksheetCanvas {
}
}
let horizontalAlign = "general";
if (style.alignment && style.alignment.horizontal) {
if (style.alignment?.horizontal) {
horizontalAlign = style.alignment.horizontal;
}
let verticalAlign = "bottom";
if (style.alignment && style.alignment.vertical) {
if (style.alignment?.vertical) {
verticalAlign = style.alignment.vertical;
}
@@ -383,7 +395,7 @@ export default class WorksheetCanvas {
borderLeftWidth = 3;
}
} else {
let leftStyle = this.model.getCellStyle(selectedSheet, row, column - 1);
const leftStyle = this.model.getCellStyle(selectedSheet, row, column - 1);
if (leftStyle.border.right) {
borderLeftColor = leftStyle.border.right.color;
switch (leftStyle.border.right.style) {
@@ -422,7 +434,7 @@ export default class WorksheetCanvas {
borderTopWidth = 3;
}
} else {
let topStyle = this.model.getCellStyle(selectedSheet, row - 1, column);
const topStyle = this.model.getCellStyle(selectedSheet, row - 1, column);
if (topStyle.border.bottom) {
borderTopColor = topStyle.border.bottom.color;
switch (topStyle.border.bottom.style) {
@@ -458,7 +470,7 @@ export default class WorksheetCanvas {
const fullText = this.model.getFormattedCellValue(
selectedSheet,
row,
column
column,
);
const padding = 4;
if (horizontalAlign === "general") {
@@ -482,11 +494,11 @@ export default class WorksheetCanvas {
fullText.split("\n").forEach((text, line) => {
const textWidth = context.measureText(text).width;
let textX;
let textY;
let textX: number;
let textY: number;
// The idea is that in the present font-size and default row heigh,
// top/bottom and center horizontalAlign coincide
let verticalPadding = 4;
const verticalPadding = 4;
if (horizontalAlign === "right") {
textX = width - padding + x - textWidth / 2;
} else if (horizontalAlign === "center") {
@@ -536,7 +548,7 @@ export default class WorksheetCanvas {
private addColumnResizeHandle(
x: number,
column: number,
columnWidth: number
columnWidth: number,
): void {
const div = document.createElement("div");
div.className = "column-resize-handle";
@@ -562,7 +574,7 @@ export default class WorksheetCanvas {
this.onColumnWidthChanges(
this.model.getSelectedSheet(),
column,
newColumnWidth
newColumnWidth,
);
};
resizeHandleUp = resizeHandleUp.bind(this);
@@ -614,7 +626,7 @@ export default class WorksheetCanvas {
private styleColumnHeader(
width: number,
div: HTMLDivElement,
selected: boolean
selected: boolean,
): void {
div.style.boxSizing = "border-box";
div.style.width = `${width}px`;
@@ -644,10 +656,10 @@ export default class WorksheetCanvas {
private renderRowHeaders(
frozenRows: number,
topLeftCell: CellCoordinates,
bottomRightCell: CellCoordinates
topLeftCell: Cell,
bottomRightCell: Cell,
): void {
let { sheet: selectedSheet, range } = this.model.getSelectedView();
const { sheet: selectedSheet, range } = this.model.getSelectedView();
let rowStart = range[0];
let rowEnd = range[2];
if (rowStart > rowEnd) {
@@ -670,7 +682,7 @@ export default class WorksheetCanvas {
1,
topLeftCornerY + 1,
headerColumnWidth - 2,
rowHeight - 2
rowHeight - 2,
);
if (selected) {
context.fillStyle = outlineColor;
@@ -682,7 +694,7 @@ export default class WorksheetCanvas {
`${row}`,
headerColumnWidth / 2,
topLeftCornerY + rowHeight / 2,
headerColumnWidth
headerColumnWidth,
);
topLeftCornerY += rowHeight;
this.addRowResizeHandle(topLeftCornerY, row, rowHeight);
@@ -696,11 +708,11 @@ export default class WorksheetCanvas {
private renderColumnHeaders(
frozenColumns: number,
firstColumn: number,
lastColumn: number
lastColumn: number,
): void {
const { columnHeaders } = this;
let deltaX = 0;
let { range } = this.model.getSelectedView();
const { range } = this.model.getSelectedView();
let columnStart = range[1];
let columnEnd = range[3];
if (columnStart > columnEnd) {
@@ -709,11 +721,11 @@ export default class WorksheetCanvas {
for (const header of columnHeaders.querySelectorAll(".column-header"))
header.remove();
for (const handle of columnHeaders.querySelectorAll(
".column-resize-handle"
".column-resize-handle",
))
handle.remove();
for (const separator of columnHeaders.querySelectorAll(
".frozen-column-separator"
".frozen-column-separator",
))
separator.remove();
columnHeaders.style.fontFamily = headerFontFamily;
@@ -750,11 +762,11 @@ export default class WorksheetCanvas {
private addColumnHeader(
deltaX: number,
column: number,
selected: boolean
selected: boolean,
): number {
const columnWidth = this.getColumnWidth(
this.model.getSelectedSheet(),
column
column,
);
const div = document.createElement("div");
div.className = "column-header";
@@ -776,10 +788,10 @@ export default class WorksheetCanvas {
y += this.getRowHeight(this.model.getSelectedSheet(), row);
}
this.sheetWidth = Math.floor(
x + this.getColumnWidth(this.model.getSelectedSheet(), LAST_COLUMN)
x + this.getColumnWidth(this.model.getSelectedSheet(), LAST_COLUMN),
);
this.sheetHeight = Math.floor(
y + 2 * this.getRowHeight(this.model.getSelectedSheet(), LAST_ROW)
y + 2 * this.getRowHeight(this.model.getSelectedSheet(), LAST_ROW),
);
return [this.sheetWidth, this.sheetHeight];
}
@@ -798,7 +810,7 @@ export default class WorksheetCanvas {
width: number,
height: number,
includeFrozenRows: boolean,
includeFrozenColumns: boolean
includeFrozenColumns: boolean,
): string {
if (!includeFrozenRows && !includeFrozenColumns) {
return "";
@@ -829,30 +841,30 @@ export default class WorksheetCanvas {
startRow: number,
startColumn: number,
endRow: number,
endColumn: number
endColumn: number,
): [number, number] {
const [xStart, yStart] = this.getCoordinatesByCell(startRow, startColumn);
let [xEnd, yEnd] = this.getCoordinatesByCell(endRow, endColumn);
xEnd += this.getColumnWidth(this.model.getSelectedSheet(), endColumn);
yEnd += this.getRowHeight(this.model.getSelectedSheet(), endRow);
const frozenRows = this.model.getFrozenRowsCount(
this.model.getSelectedSheet()
this.model.getSelectedSheet(),
);
const frozenColumns = this.model.getFrozenColumnsCount(
this.model.getSelectedSheet()
this.model.getSelectedSheet(),
);
if (frozenRows !== 0 || frozenColumns !== 0) {
let [xFrozenEnd, yFrozenEnd] = this.getCoordinatesByCell(
frozenRows,
frozenColumns
frozenColumns,
);
xFrozenEnd += this.getColumnWidth(
this.model.getSelectedSheet(),
frozenColumns
frozenColumns,
);
yFrozenEnd += this.getRowHeight(
this.model.getSelectedSheet(),
frozenRows
frozenRows,
);
if (startRow <= frozenRows && endRow > frozenRows) {
yEnd = Math.max(yEnd, yFrozenEnd);
@@ -876,7 +888,8 @@ export default class WorksheetCanvas {
const frozenRows = this.model.getFrozenRowsCount(selectedSheet);
const frozenRowsHeight = this.getFrozenRowsHeight();
const { topLeftCell } = this.getVisibleCells();
let x, y;
let x: number;
let y: number;
if (row <= frozenRows) {
// row is one of the frozen rows
y = headerRowHeight;
@@ -926,14 +939,14 @@ export default class WorksheetCanvas {
*/
getCellByCoordinates(
x: number,
y: number
y: number,
): { row: number; column: number } | null {
const frozenColumns = this.model.getFrozenColumnsCount(
this.model.getSelectedSheet()
this.model.getSelectedSheet(),
);
const frozenColumnsWidth = this.getFrozenColumnsWidth();
const frozenRows = this.model.getFrozenRowsCount(
this.model.getSelectedSheet()
this.model.getSelectedSheet(),
);
const frozenRowsHeight = this.getFrozenRowsHeight();
let column = 0;
@@ -982,7 +995,6 @@ export default class WorksheetCanvas {
}
cellY -= this.getRowHeight(this.model.getSelectedSheet(), row);
}
} else if (y < headerRowHeight + frozenRowsHeight) {
while (cellY <= y) {
row += 1;
@@ -1032,7 +1044,7 @@ export default class WorksheetCanvas {
rowStart,
columnStart,
rowEnd,
columnEnd
columnEnd,
);
// const { border } = extendToArea;
extendToOutline.style.border = `1px dashed ${outlineColor}`;
@@ -1094,14 +1106,14 @@ export default class WorksheetCanvas {
const style = this.model.getCellStyle(
selectedSheet,
selectedRow,
selectedColumn
selectedColumn,
);
const padding = -1;
const width =
this.getColumnWidth(selectedSheet, selectedColumn) + 2 * padding;
const height = this.getRowHeight(selectedSheet, selectedRow) + 2 * padding;
const { cellOutline, areaOutline, cellOutlineHandle } = this;
const { cellOutline, editor, areaOutline, cellOutlineHandle } = this;
const cellEditing = null;
cellOutline.style.visibility = "visible";
@@ -1114,6 +1126,19 @@ export default class WorksheetCanvas {
cellOutlineHandle.style.visibility = "hidden";
}
if (this.workbookState.getEditingCell()?.sheet === selectedSheet) {
editor.style.left = `${x + 3}px`;
editor.style.top = `${y + 3}px`;
} else {
// If the editing cell is not in the same sheet as the selected sheet
// we take the editor out of view
editor.style.left = "-9999px";
editor.style.top = "-9999px";
}
editor.style.width = `${width - 1}px`;
editor.style.height = `${height - 1}px`;
// Position the cell outline and clip it
cellOutline.style.left = `${x - padding}px`;
cellOutline.style.top = `${y - padding}px`;
@@ -1147,8 +1172,8 @@ export default class WorksheetCanvas {
if (columnStart > columnEnd) {
[columnStart, columnEnd] = [columnEnd, columnStart];
}
let handleX;
let handleY;
let handleX: number;
let handleY: number;
// Position the selected area outline
if (columnStart === columnEnd && rowStart === rowEnd) {
areaOutline.style.visibility = "hidden";
@@ -1163,7 +1188,7 @@ export default class WorksheetCanvas {
rowStart,
columnStart,
rowEnd,
columnEnd
columnEnd,
);
handleX = areaX + areaWidth;
handleY = areaY + areaHeight;
@@ -1180,7 +1205,7 @@ export default class WorksheetCanvas {
areaWidth + 2 * padding,
areaHeight + 2 * padding,
clipLeft,
clipTop
clipTop,
);
areaOutline.style.border = `1px solid ${outlineColor}`;
// hide the handle if it is out of the visible area
@@ -1223,11 +1248,67 @@ export default class WorksheetCanvas {
cellOutlineHandle.style.top = `${handleY - handleHeight / 2}px`;
}
renderSheet(): void {
console.time('renderSheet');
this._renderSheet();
console.timeEnd('renderSheet');
private drawActiveRanges(topLeftCell: Cell, bottomRightCell: Cell): void {
let activeRanges = this.workbookState.getActiveRanges();
const ctx = this.ctx;
ctx.setLineDash([2, 2]);
const referencedRange =
this.workbookState.getEditingCell()?.referencedRange || null;
if (referencedRange) {
activeRanges = activeRanges.concat([
{
...referencedRange.range,
color: "#343423",
},
]);
}
const activeRangesCount = activeRanges.length;
for (let rangeIndex = 0; rangeIndex < activeRangesCount; rangeIndex += 1) {
const range = activeRanges[rangeIndex];
const allowedOffset = 1; // to make borders look nicer
const minRow = topLeftCell.row - allowedOffset;
const maxRow = bottomRightCell.row + allowedOffset;
const minColumn = topLeftCell.column - allowedOffset;
const maxColumn = bottomRightCell.column + allowedOffset;
if (
minRow <= range.rowEnd &&
range.rowStart <= maxRow &&
minColumn <= range.columnEnd &&
range.columnStart < maxColumn
) {
// Range in the viewport.
const displayRange: typeof range = {
...range,
rowStart: Math.max(minRow, range.rowStart),
rowEnd: Math.min(maxRow, range.rowEnd),
columnStart: Math.max(minColumn, range.columnStart),
columnEnd: Math.min(maxColumn, range.columnEnd),
};
const [xStart, yStart] = this.getCoordinatesByCell(
displayRange.rowStart,
displayRange.columnStart,
);
const [xEnd, yEnd] = this.getCoordinatesByCell(
displayRange.rowEnd + 1,
displayRange.columnEnd + 1,
);
ctx.strokeStyle = range.color;
ctx.lineWidth = 1;
ctx.strokeRect(xStart, yStart, xEnd - xStart, yEnd - yStart);
ctx.fillStyle = hexToRGBA10Percent(range.color);
ctx.fillRect(xStart, yStart, xEnd - xStart, yEnd - yStart);
}
}
ctx.setLineDash([]);
}
renderSheet(): void {
console.time("renderSheet");
this._renderSheet();
console.timeEnd("renderSheet");
}
private _renderSheet(): void {
@@ -1350,7 +1431,7 @@ export default class WorksheetCanvas {
this.renderColumnHeaders(
frozenColumns,
topLeftCell.column,
bottomRightCell.column
bottomRightCell.column,
);
// Draw row headers
@@ -1362,5 +1443,6 @@ export default class WorksheetCanvas {
this.drawCellOutline();
this.drawExtendToArea();
this.drawActiveRanges(topLeftCell, bottomRightCell);
}
}

View File

@@ -1,4 +1,13 @@
import React, { useRef, useState } from "react";
import { type BorderOptions, BorderStyle, BorderType } from "@ironcalc/wasm";
import Popover, { type PopoverOrigin } from "@mui/material/Popover";
import { styled } from "@mui/material/styles";
import {
Grid2X2 as BorderAllIcon,
ChevronRight,
PencilLine,
} from "lucide-react";
import type React from "react";
import { useRef, useState } from "react";
import { useTranslation } from "react-i18next";
import {
BorderBottomIcon,
@@ -6,24 +15,14 @@ import {
BorderCenterVIcon,
BorderInnerIcon,
BorderLeftIcon,
BorderNoneIcon,
BorderOuterIcon,
BorderRightIcon,
BorderTopIcon,
BorderNoneIcon,
BorderStyleIcon,
BorderTopIcon,
} from "../icons";
import ColorPicker from "./colorPicker";
import Popover, { PopoverOrigin } from "@mui/material/Popover";
import {
Check,
ChevronDown,
Grid2X2 as BorderAllIcon,
PencilLine,
ChevronRight,
} from "lucide-react";
import { styled } from "@mui/material/styles";
import { theme } from "../theme";
import { BorderOptions, BorderStyle, BorderType } from "@ironcalc/wasm";
import ColorPicker from "./colorPicker";
type BorderPickerProps = {
className?: string;
@@ -233,10 +232,13 @@ const BorderPicker = (properties: BorderPickerProps) => {
>
<PencilLine />
</Button>
<div style={{flexGrow:2}}>Border color</div>
<div style={{ flexGrow: 2 }}>Border color</div>
<ChevronRightStyled />
</ButtonWrapper>
<ButtonWrapper onClick={() => setStylePickerOpen(true)} ref={borderStyleButton}>
<ButtonWrapper
onClick={() => setStylePickerOpen(true)}
ref={borderStyleButton}
>
<Button
type="button"
$pressed={false}
@@ -245,7 +247,7 @@ const BorderPicker = (properties: BorderPickerProps) => {
>
<BorderStyleIcon />
</Button>
<div style={{flexGrow:2}}>Border style</div>
<div style={{ flexGrow: 2 }}>Border style</div>
<ChevronRightStyled />
</ButtonWrapper>
</Styles>
@@ -256,6 +258,9 @@ const BorderPicker = (properties: BorderPickerProps) => {
setBorderColor(color);
setColorPickerOpen(false);
}}
onClose={() => {
setColorPickerOpen(false);
}}
anchorEl={borderColorButton}
open={colorPickerOpen}
/>
@@ -269,7 +274,7 @@ const BorderPicker = (properties: BorderPickerProps) => {
transformOrigin={{ vertical: 38, horizontal: -6 }}
>
<BorderStyleDialog>
<LineWrapper
<LineWrapper
onClick={() => {
setBorderStyle(BorderStyle.Dashed);
setStylePickerOpen(false);
@@ -353,15 +358,14 @@ const LineWrapper = styled("div")<LineWrapperProperties>`
align-items: center;
background-color: ${({ $checked }): string => {
if ($checked) {
return '#EEEEEE;';
} else {
return 'inherit;';
return "#EEEEEE;";
}
return "inherit;";
}};
&:hover {
border: 1px solid #EEEEEE;
border: 1px solid #eeeeee;
}
padding:8px;
padding: 8px;
cursor: pointer;
border-radius: 4px;
border: 1px solid white;
@@ -374,7 +378,7 @@ const CheckIconWrapper = styled("div")`
type CheckIconProperties = { $checked: boolean };
const CheckIcon = styled("div")<CheckIconProperties>`
width: 2px;
background-color: #EEE;
background-color: #eee;
height: 28px;
visibility: ${({ $checked }): string => {
if ($checked) {
@@ -385,7 +389,7 @@ const CheckIcon = styled("div")<CheckIconProperties>`
`;
const NoneLine = styled("div")`
width: 68px;
border-top: 1px solid #E0E0E0;
border-top: 1px solid #e0e0e0;
`;
const SolidLine = styled("div")`
width: 68px;
@@ -407,7 +411,7 @@ const DottedLine = styled("div")`
width: 68px;
border-top: 1px dotted #333333;
`;
const DoubleLine = styled('div')`
const DoubleLine = styled("div")`
width: 68px;
border-top: 3px double #333333;
`;
@@ -415,7 +419,7 @@ const DoubleLine = styled('div')`
const Divider = styled("div")`
display: inline-flex;
heigh: 1px;
border-bottom: 1px solid #EEE;
border-bottom: 1px solid #eee;
margin-left: 0px;
margin-right: 0px;
`;
@@ -442,11 +446,11 @@ const ButtonWrapper = styled("div")`
flex-direction: row;
align-items: center;
&:hover {
background-color: #EEE;
background-color: #eee;
border-top-color: ${(): string => theme.palette.grey["400"]};
}
cursor: pointer;
padding: 8px
padding: 8px;
`;
const BorderStyleDialog = styled("div")`
@@ -481,45 +485,13 @@ const BorderPickerDialog = styled("div")`
`;
const BorderDescription = styled("div")`
width: 70px;
width: 70px;
`;
// type TypeButtonProperties = { $pressed: boolean; $underlinedColor?: string };
// const Button = styled.button<TypeButtonProperties>`
// width: 23px;
// height: 23px;
// display: inline-flex;
// align-items: center;
// justify-content: center;
// font-size: 14px;
// border-radius: 2px;
// margin-right: 5px;
// transition: all 0.2s;
// ${({ theme, disabled, $pressed, $underlinedColor }): string => {
// if (disabled) {
// return `
// color: ${theme.palette.grey['600']};
// cursor: default;
// `;
// }
// return `
// border-top: ${$underlinedColor ? '3px solid #FFF' : 'none'};
// border-bottom: ${$underlinedColor ? `3px solid ${$underlinedColor}` : 'none'};
// color: ${theme.palette.text.primary};
// background-color: ${$pressed ? theme.palette.grey['600'] : '#FFF'};
// &:hover {
// background-color: ${theme.palette.grey['400']};
// border-top-color: ${theme.palette.grey['400']};
// }
// `;
// }}
// `;
type TypeButtonProperties = { $pressed: boolean; $underlinedColor?: string };
const Button = styled("button")<TypeButtonProperties>(
({ disabled, $pressed, $underlinedColor }) => {
let result: Record<string, any> = {
const result = {
width: "24px",
height: "24px",
display: "inline-flex",
@@ -534,28 +506,28 @@ const Button = styled("button")<TypeButtonProperties>(
padding: "0px",
};
if (disabled) {
result.color = theme.palette.grey["600"];
result.cursor = "default";
} else {
result.borderTop = $underlinedColor ? "3px solid #FFF" : "none";
result.borderBottom = $underlinedColor
? `3px solid ${$underlinedColor}`
: "none";
(result.color = "#21243A"),
(result.backgroundColor = $pressed
? theme.palette.grey["600"]
: "inherit");
result["&:hover"] = {
backgroundColor: "#F1F2F8",
borderTopColor: "#F1F2F8",
};
result["svg"] = {
width: "16px",
height: "16px",
return {
...result,
color: theme.palette.grey["600"],
cursor: "default",
};
}
return result;
}
return {
...result,
borderTop: $underlinedColor ? "3px solid #FFF" : "none",
borderBottom: $underlinedColor ? `3px solid ${$underlinedColor}` : "none",
color: "#21243A",
backgroundColor: $pressed ? theme.palette.grey["600"] : "inherit",
"&:hover": {
backgroundColor: "#F1F2F8",
borderTopColor: "#F1F2F8",
},
svg: {
width: "16px",
height: "16px",
},
};
},
);
const ChevronRightStyled = styled(ChevronRight)`

View File

@@ -1,6 +1,7 @@
import styled from "@emotion/styled";
import Popover, { PopoverOrigin } from "@mui/material/Popover";
import React, { useEffect, useRef, useState } from "react";
import Popover, { type PopoverOrigin } from "@mui/material/Popover";
import type React from "react";
import { useEffect, useRef, useState } from "react";
import { HexColorInput, HexColorPicker } from "react-colorful";
import { theme } from "../theme";
@@ -8,6 +9,7 @@ type ColorPickerProps = {
className?: string;
color: string;
onChange: (color: string) => void;
onClose: () => void;
anchorEl: React.RefObject<HTMLElement>;
anchorOrigin?: PopoverOrigin;
transformOrigin?: PopoverOrigin;
@@ -28,6 +30,10 @@ const ColorPicker = (properties: ColorPickerProps) => {
recentColors.current = [newColor, ...colors].slice(0, maxRecentColors);
};
const handleClose = (): void => {
properties.onClose();
};
useEffect(() => {
setColor(properties.color);
}, [properties.color]);
@@ -49,7 +55,7 @@ const ColorPicker = (properties: ColorPickerProps) => {
return (
<Popover
open={properties.open}
onClose={(): void => closePicker(color)}
onClose={handleClose}
anchorEl={properties.anchorEl.current}
anchorOrigin={
properties.anchorOrigin || { vertical: "bottom", horizontal: "left" }
@@ -78,9 +84,12 @@ const ColorPicker = (properties: ColorPickerProps) => {
/>
</HexColorInputBox>
</HexWrapper>
<Swatch $color={color} onClick={(): void => {
closePicker(color);
}} />
<Swatch
$color={color}
onClick={(): void => {
closePicker(color);
}}
/>
</ColorPickerInput>
<HorizontalDivider />
<ColorList>

View File

@@ -1,30 +1,35 @@
// This is the cell editor for IronCalc
// It is also the most difficult part of the UX. It is based on an idea of Mateusz Kopec.
// There is a hidden texarea and we only show the caret. What we see is a div with the same text content
// but in HTML so we can have different colors.
// Some keystrokes have different behaviour than a raw HTML text area.
// For those cases we capture the keydown event and stop its propagation.
// As the editor changes content we need to propagate those changes so the spreadsheet can
// mark with colors the active ranges or update the formula in the formula bar
//
// Events outside the editor might influence the editor
// 1. Clicking on a different cell:
// * might either terminate the editing
// * or add the external cell to the formula
// 2. Clicking on a sheet tab would open the new sheet or terminate editing
// 3. Clicking somewhere else will finish editing
//
// Keyboard navigation is also fairly complex. For instance RightArrow might:
// 1. End editing and navigate to the cell on the right
// 2. Move the cursor to the right
// 3. Insert in the formula the cell name on the right
import type { Model } from "@ironcalc/wasm";
import {
CSSProperties,
type CSSProperties,
type KeyboardEvent,
useCallback,
useEffect,
useRef,
useState,
KeyboardEvent,
useContext,
} from "react";
import { useRef } from "react";
import EditorContext, { Area } from "./editorContext";
import { getStringRange } from "./util";
/**
* This is the Cell Editor for IronCalc
* I uses a transparent textarea and a styled mask. What you see is the HTML styled content of the mask
* and the caret from the textarea. The alternative would be to have a 'contenteditable' div.
* That turns out to be a much more difficult implementation.
*
* The editor grows horizontally with text if it fits in the screen.
* If it doesn't fit, it wraps and grows vertically. If it doesn't fit vertically it scrolls.
*
* Many keyboard and mouse events are handled gracefully by the textarea in full or in part.
* For example letter key strokes like 'q' or '1' are handled full by the textarea.
* Some keyboard events like "RightArrow" might need to be handled separately and let them bubble up,
* or might be handled by the textarea, depending on the "editor mode".
* Some other like "Enter" we need to intercept and change the normal behaviour.
*/
import type { WorkbookState } from "../workbookState";
import getFormulaHTML from "./util";
const commonCSS: CSSProperties = {
fontWeight: "inherit",
@@ -36,147 +41,61 @@ const commonCSS: CSSProperties = {
whiteSpace: "pre",
width: "100%",
padding: 0,
lineHeight: "22px",
};
interface Cell {
sheet: number;
row: number;
column: number;
}
const caretColor = "#FF8899";
interface EditorOptions {
minimalWidth: number;
minimalHeight: number;
textColor: string;
originalText: string;
getStyledText: (
text: string,
insertRangeText: string
) => {
html: JSX.Element[];
isInReferenceMode: boolean;
};
onEditEnd: (text: string) => void;
minimalWidth: number | string;
minimalHeight: number | string;
display: boolean;
cell: Cell;
sheetNames: string[];
expand: boolean;
originalText: string;
onEditEnd: () => void;
onTextUpdated: () => void;
model: Model;
workbookState: WorkbookState;
type: "cell" | "formula-bar";
}
// You can either be editing a formula or content.
// When editing content (behaviour is common to Excel and Google Sheets):
// * If you start editing by typing you are in *accept* mode
// * If you start editing by F2 you are in *cruise* mode
// * If you start editing by double click you are in *cruise* mode
// In Google Sheets "Enter" starts editing and puts you in *cruise* mode. We do not do that
// Once you are in cruise mode it is not possible to switch to accept mode
// The only way to go from accept mode to cruise mode is clicking in the content somewhere
// When editing a formula.
// In Google Sheets you are either in insert mode or cruise mode.
// You can get back to accept mode if you delete the whole formula
// In Excel you can be either in insert or accept but if you click in the formula body
// you switch to cruise mode. Once in cruise mode you can go to insert mode by selecting a range.
// Then you are back in accept/insert modes
const Editor = (options: EditorOptions) => {
const {
minimalWidth,
minimalHeight,
textColor,
onEditEnd,
originalText,
display,
cell,
sheetNames,
expand,
minimalHeight,
minimalWidth,
model,
onEditEnd,
onTextUpdated,
originalText,
workbookState,
type,
} = options;
const [width, setWidth] = useState(minimalWidth);
const [height, setHeight] = useState(minimalHeight);
const { editorContext, setEditorContext } = useContext(EditorContext);
const setBaseText = (newText: string) => {
console.log('Calling setBaseText');
setEditorContext((c) => {
return {
...c,
baseText: newText,
};
});
};
const insertRangeText = editorContext.insertRange
? getStringRange(editorContext.insertRange, sheetNames)
: "";
const baseText = editorContext.baseText;
const text = baseText + insertRangeText;
// console.log('baseText', baseText, 'insertRange:', insertRangeText);
const [text, setText] = useState(originalText);
const [styledFormula, setStyledFormula] = useState(
getFormulaHTML(model, text, "").html,
);
const formulaRef = useRef<HTMLDivElement>(null);
const maskRef = useRef<HTMLDivElement>(null);
const textareaRef = useRef<HTMLTextAreaElement>(null);
// useEffect(() => {
// setBaseText(originalText);
// }, [cell]);
const { html: styledFormula, isInReferenceMode } = options.getStyledText(
baseText,
insertRangeText
);
if (display && textareaRef.current) {
textareaRef.current.focus();
}
useEffect(() => {
if (formulaRef.current) {
const scrollWidth = formulaRef.current.scrollWidth;
if (scrollWidth > width) {
setWidth(scrollWidth);
} else if (scrollWidth <= minimalWidth) {
setWidth(minimalWidth);
}
const scrollHeight = formulaRef.current.scrollHeight;
if (scrollHeight > height) {
setHeight(scrollHeight);
}
setText(originalText);
setStyledFormula(getFormulaHTML(model, originalText, "").html);
if (textareaRef.current) {
textareaRef.current.value = originalText;
}
}, [text]);
useEffect(() => {
if (isInReferenceMode) {
setEditorContext((c) => {
return {
...c,
mode: "insert",
};
});
} else {
setEditorContext((c) => {
return {
...c,
mode: "cruise",
insertRange: null,
};
});
}
}, [isInReferenceMode]);
useEffect(() => {
if (display && textareaRef.current) {
textareaRef.current.focus();
}
}, [display]);
// console.log("Ok, this is running", text, editorContext.id);
}, [originalText, model]);
const onKeyDown = useCallback(
(event: KeyboardEvent) => {
const { key, shiftKey, altKey } = event;
const textarea = textareaRef.current;
const mode = editorContext.mode;
if (!textarea) {
return;
}
@@ -186,153 +105,134 @@ const Editor = (options: EditorOptions) => {
// new line
const start = textarea.selectionStart;
const end = textarea.selectionEnd;
const newText = text.slice(0, start) + "\n" + text.slice(end);
setBaseText(newText);
const newText = `${text.slice(0, start)}\n${text.slice(end)}`;
setText(newText);
setTimeout(() => {
textarea.setSelectionRange(start + 1, start + 1);
}, 1);
}, 0);
event.stopPropagation();
event.preventDefault();
return;
} else {
// end edit
onEditEnd(text);
textarea.blur();
// event bubbles up
return;
}
break;
// end edit and select cell bellow
setTimeout(() => {
const cell = workbookState.getEditingCell();
if (cell) {
model.setUserInput(
cell.sheet,
cell.row,
cell.column,
cell.text + (cell.referencedRange?.str || ""),
);
const sign = shiftKey ? -1 : 1;
model.setSelectedSheet(cell.sheet);
model.setSelectedCell(cell.row + sign, cell.column);
workbookState.clearEditingCell();
}
onEditEnd();
}, 0);
// event bubbles up
return;
}
case "Escape": {
setBaseText(originalText);
textarea.blur();
event.stopPropagation();
event.preventDefault();
break;
}
case "ArrowLeft": {
if (mode === "accept") {
onEditEnd(text);
textarea.blur();
// event bubbles up
return;
} else if (mode == "insert") {
if (shiftKey) {
// increase the inserted range to the left
if (!editorContext.insertRange) {
setEditorContext((c) => {
return {
...c,
insertRange: {
absoluteColumnEnd: false,
absoluteColumnStart: false,
absoluteRowEnd: false,
absoluteRowStart: false,
sheet: cell.sheet,
rowStart: cell.row,
rowEnd: cell.row,
columnStart: cell.column,
columnEnd: cell.column,
},
};
});
} else {
// const r = insertRage;
// r.columnStart = Math.max(r.columnStart - 1, 1);
// setInsertRange(r);
}
} else {
// move inserted cell to the left
if (!editorContext.insertRange) {
setEditorContext((c) => {
return {
...c,
insertRange: {
absoluteColumnEnd: false,
absoluteColumnStart: false,
absoluteRowEnd: false,
absoluteRowStart: false,
sheet: cell.sheet,
rowStart: cell.row,
rowEnd: cell.row,
columnStart: cell.column,
columnEnd: cell.column,
},
};
});
} else {
setEditorContext((c) => {
const range = c.insertRange as Area;
const row = range.rowStart;
let column = range.columnStart - 1;
if (column < 1) {
column = 1;
}
return {
...c,
insertRange: {
absoluteColumnEnd: false,
absoluteColumnStart: false,
absoluteRowEnd: false,
absoluteRowStart: false,
sheet: range.sheet,
rowStart: row,
rowEnd: row,
columnStart: column,
columnEnd: column,
},
};
});
}
case "Tab": {
// end edit and select cell to the right
const cell = workbookState.getEditingCell();
if (cell) {
workbookState.clearEditingCell();
model.setUserInput(
cell.sheet,
cell.row,
cell.column,
cell.text + (cell.referencedRange?.str || ""),
);
const sign = shiftKey ? -1 : 1;
model.setSelectedSheet(cell.sheet);
model.setSelectedCell(cell.row, cell.column + sign);
if (textareaRef.current) {
textareaRef.current.value = "";
setStyledFormula(getFormulaHTML(model, "", "").html);
}
event.stopPropagation();
event.preventDefault();
return;
}
// We don't do anything in "cruise mode" and rely on the textarea default behaviour
break;
onEditEnd();
return;
}
case "ArrowDown": {
if (mode === "accept") {
onEditEnd(text);
textarea.blur();
case "Escape": {
// quit editing without modifying the cell
const cell = workbookState.getEditingCell();
if (cell) {
model.setSelectedSheet(cell.sheet);
}
break;
workbookState.clearEditingCell();
onEditEnd();
return;
}
// TODO: Arrow keys navigate in Excel
case "ArrowRight": {
if (mode === "accept") {
onEditEnd(text);
textarea.blur();
}
break;
return;
}
case "ArrowUp": {
if (mode === "accept") {
onEditEnd(text);
textarea.blur();
}
break;
default: {
// We run this in a timeout because the value is not yet in the textarea
// since we are capturing the keydown event
setTimeout(() => {
const cell = workbookState.getEditingCell();
if (cell) {
// accept whatever is in the referenced range
const value = textarea.value;
const styledFormula = getFormulaHTML(model, value, "");
cell.text = value;
cell.referencedRange = null;
cell.cursorStart = textarea.selectionStart;
cell.cursorEnd = textarea.selectionEnd;
workbookState.setEditingCell(cell);
workbookState.setActiveRanges(styledFormula.activeRanges);
setStyledFormula(styledFormula.html);
onTextUpdated();
}
}, 0);
}
case "Tab": {
onEditEnd(text);
textarea.blur();
// event bubbles up
}
}
if (editorContext.mode === "insert") {
setBaseText(text);
setEditorContext((context) => {
return {
...context,
mode: "cruise",
insertRange: null,
};
});
}
},
[text, editorContext]
[model, text, onEditEnd, onTextUpdated, workbookState],
);
useEffect(() => {
if (display) {
textareaRef.current?.focus();
}
}, [display]);
const onChange = useCallback(() => {
if (textareaRef.current) {
textareaRef.current.value = "";
setStyledFormula(getFormulaHTML(model, "", "").html);
}
// This happens if the blur hasn't been taken care before by
// onclick or onpointerdown events
// If we are editing a cell finish that
const cell = workbookState.getEditingCell();
if (cell) {
model.setUserInput(
cell.sheet,
cell.row,
cell.column,
workbookState.getEditingText(),
);
workbookState.clearEditingCell();
}
onEditEnd();
}, [model, workbookState, onEditEnd]);
const isCellEditing = workbookState.getEditingCell() !== null;
const showEditor =
(isCellEditing && display) || type === "formula-bar" ? "block" : "none";
return (
<div
style={{
@@ -340,14 +240,8 @@ const Editor = (options: EditorOptions) => {
width,
height,
overflow: "hidden",
display: showEditor,
background: "#FFF",
display: display ? "block" : "none",
}}
onClick={(_event) => {
console.log("Click on wrapper");
}}
onPointerDown={() => {
console.log("On pointer down wrapper");
}}
>
<div
@@ -358,12 +252,6 @@ const Editor = (options: EditorOptions) => {
pointerEvents: "none",
height,
}}
onClick={(_event) => {
console.log("Click on mask");
}}
onPointerDown={() => {
console.log("On pointer down mask");
}}
>
<div ref={formulaRef}>{styledFormula}</div>
</div>
@@ -374,47 +262,25 @@ const Editor = (options: EditorOptions) => {
...commonCSS,
color: "transparent",
backgroundColor: "transparent",
caretColor: textColor,
caretColor,
outline: "none",
resize: "none",
border: "none",
height,
overflow: "hidden",
}}
defaultValue={text}
spellCheck="false"
value={text}
onChange={(event) => {
console.log("onChange", event.target.value);
setBaseText(event.target.value);
}}
onScroll={() => {
if (maskRef.current && textareaRef.current) {
maskRef.current.style.left = `-${textareaRef.current.scrollLeft}px`;
maskRef.current.style.top = `-${textareaRef.current.scrollTop}px`;
onKeyDown={onKeyDown}
onBlur={onChange}
onClick={(event) => {
// Prevents this from bubbling up and focusing on the spreadsheet
if (isCellEditing && type === "cell") {
event.stopPropagation();
}
}}
onKeyDown={onKeyDown}
onClick={(event) => {
console.log("Setting mode");
setEditorContext((c) => {
return {
...c,
mode: "cruise",
};
});
console.log("here");
// if (display) {
event.stopPropagation();
// }
}}
onBlur={() => {
// on blur
}}
onPointerDown={(event) => {
event.stopPropagation();
}}
></textarea>
/>
</div>
);
};
export default Editor;

View File

@@ -1,45 +0,0 @@
import { Dispatch, SetStateAction, createContext } from "react";
export interface Area {
sheet: number | null;
rowStart: number;
rowEnd: number;
columnStart: number;
columnEnd: number;
absoluteRowStart: boolean;
absoluteRowEnd: boolean;
absoluteColumnStart: boolean;
absoluteColumnEnd: boolean;
}
// Arrow keys behave in different ways depending on the "edit mode":
// * In _cruise_ mode arrowy keys navigate within the editor
// * In _accept_ mode pressing an arrow key will end editing
// * In _insert_ mode arrow keys will change the selected range
export type EditorMode = "cruise" | "accept" | "insert";
export interface EditorState {
mode: EditorMode;
insertRange: null | Area;
baseText: string;
id: number;
}
interface EditorContextType {
editorContext: EditorState;
setEditorContext: Dispatch<
SetStateAction<{ mode: EditorMode; insertRange: null | Area }>
>;
}
const EditorContext = createContext<EditorContextType>({
editorContext: {
mode: "accept",
insertRange: null,
baseText: '',
id: Math.floor(Math.random()*1000),
},
setEditorContext: () => {},
});
export default EditorContext;

View File

@@ -1,3 +0,0 @@
export { default } from './editor';

View File

@@ -1,92 +0,0 @@
type ErrorType =
| 'REF'
| 'NAME'
| 'VALUE'
| 'DIV'
| 'NA'
| 'NUM'
| 'ERROR'
| 'NIMPL'
| 'SPILL'
| 'CALC'
| 'CIRC';
type OpCompareType =
| 'LessThan'
| 'GreaterThan'
| 'Equal'
| 'LessOrEqualThan'
| 'GreaterOrEqualThan'
| 'NonEqual';
type OpSumType = 'Add' | 'Minus';
type OpProductType = 'Times' | 'Divide';
interface ReferenceType {
sheet: string | null;
row: number;
column: number;
absolute_column: boolean;
absolute_row: boolean;
}
interface ParsedReferenceType {
column: number;
row: number;
absolute_column: boolean;
absolute_row: boolean;
}
interface Reference {
Reference: ReferenceType;
}
interface Range {
Range: {
sheet: string | null;
left: ParsedReferenceType;
right: ParsedReferenceType;
};
}
export type TokenType =
| 'Illegal'
| 'Eof'
| { Ident: string }
| { String: string }
| { Boolean: boolean }
| { Number: number }
| { ERROR: ErrorType }
| { COMPARE: OpCompareType }
| { SUM: OpSumType }
| { PRODUCT: OpProductType }
| 'POWER'
| 'LPAREN'
| 'RPAREN'
| 'COLON'
| 'SEMICOLON'
| 'LBRACKET'
| 'RBRACKET'
| 'LBRACE'
| 'RBRACE'
| 'COMMA'
| 'BANG'
| 'PERCENT'
| 'AND'
| Reference
| Range;
export interface MarkedToken {
token: TokenType;
start: number;
end: number;
}
export function tokenIsReferenceType(token: TokenType): token is Reference {
return typeof token === 'object' && 'Reference' in token;
}
export function tokenIsRangeType(token: TokenType): token is Range {
return typeof token === 'object' && 'Range' in token;
}

View File

@@ -1,108 +0,0 @@
import { useCallback, KeyboardEvent } from "react";
import { WorkbookState } from "../workbookState";
import { Model } from "@ironcalc/wasm";
interface Options {
// onMoveCaretToStart: () => void;
// onMoveCaretToEnd: () => void;
// onEditEnd: (delta: { deltaRow: number; deltaColumn: number }) => void;
// onEditEscape: () => void;
// onReferenceCycle: () => void;
// text: string;
// setText: (text: string) => void;
model: Model;
state: WorkbookState;
refresh: () => void;
}
const useEditorKeydown = (
options: Options
): {
onKeyDown: (event: KeyboardEvent) => void;
} => {
const { state, model } = options;
const onKeyDown = useCallback((event: KeyboardEvent) => {
const { key, shiftKey } = event;
const { mode, text } = state.getEditor() ?? { mode: "init", text: "" };
switch (key) {
// case "Enter":
// // options.onEditEnd({ deltaRow: 1, deltaColumn: 0 });
// const { row, column } = state.getSelectedCell();
// const sheet = state.getSelectedSheet();
// model.setUserInput(sheet, row, column, text);
// state.selectCell({ row: row + 1, column });
// event.preventDefault();
// event.stopPropagation();
// options.refresh();
// break;
// case 'ArrowUp': {
// if (mode === 'init') {
// options.onEditEnd({ deltaRow: -1, deltaColumn: 0 });
// } else {
// options.onMoveCaretToStart();
// }
// event.preventDefault();
// event.stopPropagation();
// break;
// }
// case 'ArrowDown': {
// if (mode === 'init') {
// options.onEditEnd({ deltaRow: 1, deltaColumn: 0 });
// } else {
// options.onMoveCaretToEnd();
// }
// event.preventDefault();
// event.stopPropagation();
// break;
// }
// case 'Tab': {
// if (event.shiftKey) {
// options.onEditEnd({ deltaRow: 0, deltaColumn: -1 });
// } else {
// options.onEditEnd({ deltaRow: 0, deltaColumn: 1 });
// }
// event.preventDefault();
// event.stopPropagation();
// break;
// }
// case 'Escape': {
// options.onEditEscape();
// event.preventDefault();
// event.stopPropagation();
// break;
// }
// case 'ArrowLeft': {
// if (mode === 'init') {
// options.onEditEnd({ deltaRow: 0, deltaColumn: -1 });
// event.preventDefault();
// event.stopPropagation();
// }
// break;
// }
// case 'ArrowRight': {
// if (mode === 'init') {
// options.onEditEnd({ deltaRow: 0, deltaColumn: 1 });
// event.preventDefault();
// event.stopPropagation();
// }
// break;
// }
// case 'F4': {
// options.onReferenceCycle();
// event.preventDefault();
// event.stopPropagation();
// break;
// }
default:
break;
}
}, [model, state]);
return { onKeyDown };
};
export default useEditorKeydown;

View File

@@ -1,108 +1,41 @@
import { getTokens } from "@ironcalc/wasm";
import { tokenIsRangeType, tokenIsReferenceType } from "./tokenTypes";
import { Area } from "./editorContext";
import {
type Model,
type Range,
type Reference,
type TokenType,
getTokens,
} from "@ironcalc/wasm";
import type { ActiveRange } from "../workbookState";
const letters = [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
];
interface Reference {
row: number;
column: number;
absoluteRow: boolean;
absoluteColumn: boolean;
export function tokenIsReferenceType(token: TokenType): token is Reference {
return typeof token === "object" && "Reference" in token;
}
export function referenceToString(rf: Reference): string {
const absC = rf.absoluteColumn ? "$" : "";
const absR = rf.absoluteRow ? "$" : "";
return absC + columnNameFromNumber(rf.column) + absR + rf.row;
export function tokenIsRangeType(token: TokenType): token is Range {
return typeof token === "object" && "Range" in token;
}
export function columnNameFromNumber(column: number): string {
let columnName = "";
let index = column;
while (index > 0) {
columnName = `${letters[(index - 1) % 26]}${columnName}`;
index = Math.floor((index - 1) / 26);
export function isInReferenceMode(text: string, cursor: number): boolean {
// FIXME
// This is a gross oversimplification
// Returns true if both are true:
// 1. Cursor is at the end
// 2. Last char is one of [',', '(', '+', '*', '-', '/', '<', '>', '=', '&']
// This has many false positives like '="1+' and also likely some false negatives
// The right way of doing this is to have a partial parse of the formula tree
// and check if the next token could be a reference
if (!text.startsWith("=")) {
return false;
}
return columnName;
}
export function columnNumberFromName(columnName: string): number {
let column = 0;
for (const character of columnName) {
const index = (character.codePointAt(0) ?? 0) - 64;
column = column * 26 + index;
if (text === "=") {
return true;
}
return column;
}
interface Range {
sheet: number | null;
rowStart: number;
rowEnd: number;
columnStart: number;
columnEnd: number;
absoluteRowStart: boolean;
absoluteRowEnd: boolean;
absoluteColumnStart: boolean;
absoluteColumnEnd: boolean;
}
export function getStringRange(range: Range, sheetNames: string[]) {
const name = range.sheet ? `${sheetNames[range.sheet]}!` : "";
const left = referenceToString({
row: range.rowStart,
column: range.columnStart,
absoluteRow: range.absoluteRowStart,
absoluteColumn: range.absoluteColumnStart,
});
if (
range.rowStart === range.rowEnd &&
range.columnStart === range.columnEnd
) {
return `${name}${left}`;
const l = text.length;
const chars = [",", "(", "+", "*", "-", "/", "<", ">", "=", "&"];
if (cursor === l && chars.includes(text[l - 1])) {
return true;
}
const right = referenceToString({
row: range.rowEnd,
column: range.columnEnd,
absoluteRow: range.absoluteRowEnd,
absoluteColumn: range.absoluteColumnEnd,
});
return `${name}${left}:${right}`;
}
interface ActiveRange {
sheet: number;
rowStart: number;
rowEnd: number;
columnStart: number;
columnEnd: number;
color: string;
return false;
}
// IronCalc Color Palette
@@ -166,34 +99,21 @@ export function getColor(index: number, alpha = 1): string {
return `rgba(${rgba[0]}, ${rgba[1]}, ${rgba[2]}, ${alpha})`;
}
/**
*
* This function get a formula like `=A1*SUM(B5:C6)` and transforms it to:
*
* `<span>=</span><span>A1</span><span>SUM</span><span>(</span><span>B5:C6</span><span>)</span>`
*
* While also returning the set of ranges [A1, B5:C6] with specific color assignments for each range
*/
export function getFormulaHTML(
function getFormulaHTML(
model: Model,
text: string,
sheet: number,
sheetList: string[],
insertRage: Area | null,
insertRangeText: string
): {
html: JSX.Element[];
activeRanges: ActiveRange[];
isInReferenceMode: boolean;
} {
let html = [];
referenceRange: string,
): { html: JSX.Element[]; activeRanges: ActiveRange[] } {
let html: JSX.Element[] = [];
const activeRanges: ActiveRange[] = [];
let colorCount = 0;
if (text.startsWith("=")) {
const formula = text.slice(1);
const tokens = getTokens(formula);
const tokenCount = tokens.length;
const usedColors: Record<string, string> = {};
const sheet = model.getSelectedSheet();
const sheetList = model.getWorksheetsProperties().map((s) => s.name);
for (let index = 0; index < tokenCount; index += 1) {
const { token, start, end } = tokens[index];
if (tokenIsReferenceType(token)) {
@@ -209,7 +129,7 @@ export function getFormulaHTML(
html.push(
<span key={index} style={{ color }}>
{formula.slice(start, end)}
</span>
</span>,
);
activeRanges.push({
sheet: sheetIndex,
@@ -244,7 +164,7 @@ export function getFormulaHTML(
html.push(
<span key={index} style={{ color }}>
{formula.slice(start, end)}
</span>
</span>,
);
colorCount += 1;
@@ -260,75 +180,15 @@ export function getFormulaHTML(
html.push(<span key={index}>{formula.slice(start, end)}</span>);
}
}
if (tokenCount > 0) {
const lastToken = tokens[tokens.length - 1];
if (lastToken.end < text.length - 1) {
html.push(
<span key="rest">{text.slice(lastToken.end + 1, text.length)}</span>
);
}
// If there is a reference range add it at the end
if (referenceRange !== "") {
html.push(<span key="reference">{referenceRange}</span>);
}
html = [<span key="equals">=</span>].concat(html);
} else {
html = [<span key="single">{text}</span>];
}
const isRefMode = isInReferenceMode(text, text.length);
if (isRefMode) {
if (insertRage) {
const color = getColor(colorCount);
activeRanges.push({
sheet: insertRage.sheet || sheet,
rowStart: insertRage.rowStart,
rowEnd: insertRage.rowEnd,
columnStart: insertRage.columnStart,
columnEnd: insertRage.columnEnd,
color,
});
colorCount += 1;
html.push(
<span key="insert-range" style={{ color, textDecoration: "underline" }}>
{insertRangeText}
</span>
);
} else {
html.push(
<span
key="insert-cue"
style={{
border: "1px solid #d5d5d5",
height: "2px",
width: "7px",
borderTop: 0,
display: "inline-block",
}}
/>
);
}
}
// We add a clickable element that spans the rest of the available space
html.push(<span key="spacer" style={{ flexGrow: 1 }}></span>);
return { html, activeRanges, isInReferenceMode: isRefMode };
return { html, activeRanges };
}
export function isInReferenceMode(text: string, cursor: number): boolean {
// FIXME
// This is a gross oversimplification
// Returns true if both are true:
// 1. Cursor is at the end
// 2. Last char is one of [',', '(', '+', '*', '-', '/', '<', '>', '=', '&']
// This has many false positives like '="1+' and also likely some false negatives
// The right way of doing this is to have a partial parse of the formula tree
// and check if the next token could be a reference
if (!text.startsWith("=")) {
return false;
}
if (text === "=") {
return true;
}
const l = text.length;
const chars = [",", "(", "+", "*", "-", "/", "<", ">", "=", "&"];
if (cursor === l && chars.includes(text[l - 1])) {
return true;
}
return false;
}
export default getFormulaHTML;

View File

@@ -1,15 +1,15 @@
import { useState, useRef, ComponentProps } from 'react';
import { useTranslation } from 'react-i18next';
import { NumberFormats } from './formatUtil';
import { Menu, MenuItem, styled } from '@mui/material';
import FormatPicker from './formatPicker';
import { Menu, MenuItem, styled } from "@mui/material";
import { type ComponentProps, useRef, useState } from "react";
import { useTranslation } from "react-i18next";
import FormatPicker from "./formatPicker";
import { NumberFormats } from "./formatUtil";
type FormatMenuProps = {
children: any; //ReactI18NextChild | Iterable<ReactI18NextChild>;
children: React.ReactNode;
numFmt: string;
onChange: (numberFmt: string) => void;
onExited?: () => void;
anchorOrigin?: ComponentProps<typeof Menu>['anchorOrigin'];
anchorOrigin?: ComponentProps<typeof Menu>["anchorOrigin"];
};
const FormatMenu = (properties: FormatMenuProps) => {
@@ -21,57 +21,84 @@ const FormatMenu = (properties: FormatMenuProps) => {
return (
<>
<ChildrenWrapper onClick={(): void => setMenuOpen(true)} ref={anchorElement}>
<ChildrenWrapper
onClick={(): void => setMenuOpen(true)}
ref={anchorElement}
>
{properties.children}
</ChildrenWrapper>
<Menu
open={isMenuOpen}
onClose={(): void => setMenuOpen(false)}
// onExited={properties.onExited}
anchorEl={anchorElement.current}
anchorOrigin={properties.anchorOrigin}
>
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.AUTO)}>
<MenuItemText>{t('toolbar.format_menu.auto')}</MenuItemText>
<MenuItemText>{t("toolbar.format_menu.auto")}</MenuItemText>
</MenuItemWrapper>
{/** TODO: Text option that transforms into plain text */}
<MenuDivider />
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.NUMBER)}>
<MenuItemText>{t('toolbar.format_menu.number')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.number_example')}</MenuItemExample>
<MenuItemText>{t("toolbar.format_menu.number")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.number_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.PERCENTAGE)}>
<MenuItemText>{t('toolbar.format_menu.percentage')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.percentage_example')}</MenuItemExample>
<MenuItemWrapper
onClick={(): void => onChange(NumberFormats.PERCENTAGE)}
>
<MenuItemText>{t("toolbar.format_menu.percentage")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.percentage_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuDivider />
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.CURRENCY_EUR)}>
<MenuItemText>{t('toolbar.format_menu.currency_eur')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.currency_eur_example')}</MenuItemExample>
<MenuItemWrapper
onClick={(): void => onChange(NumberFormats.CURRENCY_EUR)}
>
<MenuItemText>{t("toolbar.format_menu.currency_eur")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.currency_eur_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.CURRENCY_USD)}>
<MenuItemText>{t('toolbar.format_menu.currency_usd')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.currency_usd_example')}</MenuItemExample>
<MenuItemWrapper
onClick={(): void => onChange(NumberFormats.CURRENCY_USD)}
>
<MenuItemText>{t("toolbar.format_menu.currency_usd")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.currency_usd_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.CURRENCY_GBP)}>
<MenuItemText>{t('toolbar.format_menu.currency_gbp')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.currency_gbp_example')}</MenuItemExample>
<MenuItemWrapper
onClick={(): void => onChange(NumberFormats.CURRENCY_GBP)}
>
<MenuItemText>{t("toolbar.format_menu.currency_gbp")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.currency_gbp_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuDivider />
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.DATE_SHORT)}>
<MenuItemText>{t('toolbar.format_menu.date_short')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.date_short_example')}</MenuItemExample>
<MenuItemWrapper
onClick={(): void => onChange(NumberFormats.DATE_SHORT)}
>
<MenuItemText>{t("toolbar.format_menu.date_short")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.date_short_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuItemWrapper onClick={(): void => onChange(NumberFormats.DATE_LONG)}>
<MenuItemText>{t('toolbar.format_menu.date_long')}</MenuItemText>
<MenuItemExample>{t('toolbar.format_menu.date_long_example')}</MenuItemExample>
<MenuItemWrapper
onClick={(): void => onChange(NumberFormats.DATE_LONG)}
>
<MenuItemText>{t("toolbar.format_menu.date_long")}</MenuItemText>
<MenuItemExample>
{t("toolbar.format_menu.date_long_example")}
</MenuItemExample>
</MenuItemWrapper>
<MenuDivider />
<MenuItemWrapper onClick={(): void => setPickerOpen(true)}>
<MenuItemText>{t('toolbar.format_menu.custom')}</MenuItemText>
<MenuItemText>{t("toolbar.format_menu.custom")}</MenuItemText>
</MenuItemWrapper>
</Menu>
<FormatPicker
@@ -92,17 +119,17 @@ const MenuItemWrapper = styled(MenuItem)`
width: 100%;
`;
const ChildrenWrapper = styled('div')`
const ChildrenWrapper = styled("div")`
display: flex;
`;
const MenuDivider = styled('div')``;
const MenuDivider = styled("div")``;
const MenuItemText = styled('div')`
const MenuItemText = styled("div")`
color: #000;
`;
const MenuItemExample = styled('div')`
const MenuItemExample = styled("div")`
margin-left: 20px;
`;

View File

@@ -1,6 +1,13 @@
import { Button, Dialog, DialogActions, DialogContent, DialogTitle, TextField } from '@mui/material';
import { useState } from 'react';
import { useTranslation } from 'react-i18next';
import {
Button,
Dialog,
DialogActions,
DialogContent,
DialogTitle,
TextField,
} from "@mui/material";
import { useState } from "react";
import { useTranslation } from "react-i18next";
type FormatPickerProps = {
className?: string;
@@ -20,27 +27,23 @@ const FormatPicker = (properties: FormatPickerProps) => {
properties.onClose();
};
return (
<Dialog
open={properties.open}
onClose={properties.onClose}
>
<DialogTitle>{t('num_fmt.title')}</DialogTitle>
<Dialog open={properties.open} onClose={properties.onClose}>
<DialogTitle>{t("num_fmt.title")}</DialogTitle>
<DialogContent dividers>
<TextField
defaultValue={properties.numFmt}
label={t('num_fmt.label')}
label={t("num_fmt.label")}
name="format_code"
onChange={(event) => setFormatCode(event.target.value)}
/>
</DialogContent>
<DialogActions>
<Button onClick={() => onSubmit(formatCode)}>
{t('num_fmt.save')}
</Button>
</DialogActions>
<Button onClick={() => onSubmit(formatCode)}>
{t("num_fmt.save")}
</Button>
</DialogActions>
</Dialog>
);
};
export default FormatPicker;

View File

@@ -1,36 +1,36 @@
export function increaseDecimalPlaces(numberFormat: string): string {
// FIXME: Should it be done in the Rust? How should it work?
// Increase decimal places for existing numbers with decimals
const newNumberFormat = numberFormat.replace(/\.0/g, '.00');
// If no decimal places declared, add 0.0
if (!newNumberFormat.includes('.')) {
if (newNumberFormat.includes('0')) {
return newNumberFormat.replace(/0/g, '0.0');
}
if (newNumberFormat.includes('#')) {
return newNumberFormat.replace(/#([^#,]|$)/g, '0.0$1');
}
return '0.0';
// FIXME: Should it be done in the Rust? How should it work?
// Increase decimal places for existing numbers with decimals
const newNumberFormat = numberFormat.replace(/\.0/g, ".00");
// If no decimal places declared, add 0.0
if (!newNumberFormat.includes(".")) {
if (newNumberFormat.includes("0")) {
return newNumberFormat.replace(/0/g, "0.0");
}
return newNumberFormat;
if (newNumberFormat.includes("#")) {
return newNumberFormat.replace(/#([^#,]|$)/g, "0.0$1");
}
return "0.0";
}
export function decreaseDecimalPlaces(numberFormat: string): string {
// FIXME: Should it be done in the Rust? How should it work?
// Decrease decimal places for existing numbers with decimals
let newNumberFormat = numberFormat.replace(/\.0/g, '.');
// Fix leftover dots
newNumberFormat = newNumberFormat.replace(/0\.([^0]|$)/, '0$1');
return newNumberFormat;
}
export enum NumberFormats {
AUTO = 'general',
CURRENCY_EUR = '"€"#,##0.00',
CURRENCY_USD = '"$"#,##0.00',
CURRENCY_GBP = '"£"#,##0.00',
DATE_SHORT = 'dd"/"mm"/"yyyy',
DATE_LONG = 'dddd"," mmmm dd"," yyyy',
PERCENTAGE = '0.00%',
NUMBER = '#,##0.00',
}
return newNumberFormat;
}
export function decreaseDecimalPlaces(numberFormat: string): string {
// FIXME: Should it be done in the Rust? How should it work?
// Decrease decimal places for existing numbers with decimals
let newNumberFormat = numberFormat.replace(/\.0/g, ".");
// Fix leftover dots
newNumberFormat = newNumberFormat.replace(/0\.([^0]|$)/, "0$1");
return newNumberFormat;
}
export enum NumberFormats {
AUTO = "general",
CURRENCY_EUR = '""#,##0.00',
CURRENCY_USD = '"$"#,##0.00',
CURRENCY_GBP = '"£"#,##0.00',
DATE_SHORT = 'dd"/"mm"/"yyyy',
DATE_LONG = 'dddd"," mmmm dd"," yyyy',
PERCENTAGE = "0.00%",
NUMBER = "#,##0.00",
}

View File

@@ -1,51 +0,0 @@
import {
Button,
Dialog,
DialogActions,
DialogContent,
DialogTitle,
styled,
TextField,
} from "@mui/material";
import { useTranslation } from "react-i18next";
import { useState } from "react";
interface FormulaDialogProps {
isOpen: boolean;
close: () => void;
onFormulaChanged: (name: string) => void;
defaultName: string;
}
export const FormulaDialog = (properties: FormulaDialogProps) => {
const { t } = useTranslation();
const [name, setName] = useState(properties.defaultName);
return (
<Dialog open={properties.isOpen} onClose={properties.close}>
<DialogTitle>{t("sheet_rename.title")}</DialogTitle>
<DialogContent dividers>
<TextField
defaultValue={name}
label={t("sheet_rename.label")}
onClick={(event) => event.stopPropagation()}
onKeyDown={(event) => {
event.stopPropagation();
}}
onChange={(event) => {
setName(event.target.value);
}}
spellCheck="false"
/>
</DialogContent>
<DialogActions>
<Button
onClick={() => {
properties.onFormulaChanged(name);
}}
>
{t("sheet_rename.rename")}
</Button>
</DialogActions>
</Dialog>
);
};

View File

@@ -1,28 +1,35 @@
import type { Model } from "@ironcalc/wasm";
import { Button, styled } from "@mui/material";
import { ChevronDown } from "lucide-react";
import { Fx } from "../icons";
import { useState } from "react";
import { FormulaDialog } from "./formulaDialog";
import Editor from "./editor/editor";
import type { WorkbookState } from "./workbookState";
type FormulaBarProps = {
cellAddress: string;
formulaValue: string;
onChange: (value: string) => void;
model: Model;
workbookState: WorkbookState;
onChange: () => void;
onTextUpdated: () => void;
};
const formulaBarHeight = 30;
const headerColumnWidth = 30;
const headerColumnWidth = 35;
function FormulaBar(properties: FormulaBarProps) {
const [formulaDialogOpen, setFormulaDialogOpen] = useState(false);
const handleCloseFormulaDialog = () => {
setFormulaDialogOpen(false);
};
const {
cellAddress,
formulaValue,
model,
onChange,
onTextUpdated,
workbookState,
} = properties;
return (
<Container>
<AddressContainer>
<CellBarAddress>{properties.cellAddress}</CellBarAddress>
<CellBarAddress>{cellAddress}</CellBarAddress>
<StyledButton>
<ChevronDown />
</StyledButton>
@@ -32,23 +39,40 @@ function FormulaBar(properties: FormulaBarProps) {
<FormulaSymbolButton>
<Fx />
</FormulaSymbolButton>
<Editor
onClick={() => {
setFormulaDialogOpen(true);
<EditorWrapper
onClick={(event) => {
const [sheet, row, column] = model.getSelectedCell();
workbookState.setEditingCell({
sheet,
row,
column,
text: formulaValue,
referencedRange: null,
cursorStart: formulaValue.length,
cursorEnd: formulaValue.length,
focus: "formula-bar",
activeRanges: [],
});
event.stopPropagation();
event.preventDefault();
}}
>
{properties.formulaValue}
</Editor>
<Editor
minimalWidth={"100%"}
minimalHeight={"100%"}
display={true}
expand={false}
originalText={formulaValue}
model={model}
workbookState={workbookState}
onEditEnd={() => {
onChange();
}}
onTextUpdated={onTextUpdated}
type="formula-bar"
/>
</EditorWrapper>
</FormulaContainer>
<FormulaDialog
isOpen={formulaDialogOpen}
close={handleCloseFormulaDialog}
defaultName={properties.formulaValue}
onFormulaChanged={(newName) => {
properties.onChange(newName);
setFormulaDialogOpen(false);
}}
/>
</Container>
);
}
@@ -113,7 +137,7 @@ const CellBarAddress = styled("div")`
text-align: "center";
`;
const Editor = styled("div")`
const EditorWrapper = styled("div")`
position: relative;
width: 100%;
padding: 0px;
@@ -127,6 +151,7 @@ const Editor = styled("div")`
span {
min-width: 1px;
}
font-family: monospace;
`;
export default FormulaBar;

View File

@@ -1,2 +1,2 @@
export { default } from './navigation';
export type { NavigationProps } from './navigation';
export { default } from "./navigation";
export type { NavigationProps } from "./navigation";

View File

@@ -4,14 +4,14 @@ import {
DialogActions,
DialogContent,
DialogTitle,
styled,
TextField,
styled,
} from "@mui/material";
import { SheetOptions } from "./types";
import Menu from "@mui/material/Menu";
import MenuItem from "@mui/material/MenuItem";
import { useTranslation } from "react-i18next";
import { useState } from "react";
import { useTranslation } from "react-i18next";
import type { SheetOptions } from "./types";
interface SheetRenameDialogProps {
isOpen: boolean;

View File

@@ -2,14 +2,16 @@ import { styled } from "@mui/material";
import { ChevronLeft, ChevronRight, Menu, Plus } from "lucide-react";
import { useState } from "react";
import { useTranslation } from "react-i18next";
import { SheetOptions } from "./types";
import SheetListMenu, { SheetRenameDialog } from "./menus";
import Sheet from "./sheet";
import { StyledButton } from "../toolbar";
import type { WorkbookState } from "../workbookState";
import SheetListMenu from "./menus";
import Sheet from "./sheet";
import type { SheetOptions } from "./types";
export interface NavigationProps {
sheets: SheetOptions[];
selectedIndex: number;
workbookState: WorkbookState;
onSheetSelected: (index: number) => void;
onAddBlankSheet: () => void;
onSheetColorChanged: (hex: string) => void;
@@ -19,7 +21,7 @@ export interface NavigationProps {
function Navigation(props: NavigationProps) {
const { t } = useTranslation();
const { onSheetSelected, sheets, selectedIndex } = props;
const { workbookState, onSheetSelected, sheets, selectedIndex } = props;
const [anchorEl, setAnchorEl] = useState<null | HTMLButtonElement>(null);
const open = Boolean(anchorEl);
const handleClick = (event: React.MouseEvent<HTMLButtonElement>) => {
@@ -31,7 +33,11 @@ function Navigation(props: NavigationProps) {
return (
<Container>
<StyledButton title={t("navigation.add_sheet")} $pressed={false}>
<StyledButton
title={t("navigation.add_sheet")}
$pressed={false}
onClick={props.onAddBlankSheet}
>
<Plus />
</StyledButton>
<StyledButton
@@ -50,15 +56,16 @@ function Navigation(props: NavigationProps) {
color={tab.color}
selected={index === selectedIndex}
onSelected={() => onSheetSelected(index)}
onColorChanged={function (hex: string): void {
onColorChanged={(hex: string): void => {
props.onSheetColorChanged(hex);
}}
onRenamed={function (name: string): void {
onRenamed={(name: string): void => {
props.onSheetRenamed(name);
}}
onDeleted={function (): void {
onDeleted={(): void => {
props.onSheetDeleted();
}}
workbookState={workbookState}
/>
))}
</SheetInner>

View File

@@ -1,8 +1,11 @@
import { Button, Menu, MenuItem, styled } from "@mui/material";
import { ChevronDown } from "lucide-react";
import { useRef, useState } from "react";
import { SheetRenameDialog } from "./menus";
import ColorPicker from "../colorPicker";
import { isInReferenceMode } from "../editor/util";
import type { WorkbookState } from "../workbookState";
import { SheetRenameDialog } from "./menus";
interface SheetProps {
name: string;
color: string;
@@ -11,9 +14,11 @@ interface SheetProps {
onColorChanged: (hex: string) => void;
onRenamed: (name: string) => void;
onDeleted: () => void;
workbookState: WorkbookState;
}
function Sheet(props: SheetProps) {
const { name, color, selected, onSelected } = props;
const { name, color, selected, workbookState, onSelected } = props;
const [anchorEl, setAnchorEl] = useState<null | HTMLButtonElement>(null);
const [colorPickerOpen, setColorPickerOpen] = useState(false);
const colorButton = useRef(null);
@@ -32,15 +37,29 @@ function Sheet(props: SheetProps) {
setRenameDialogOpen(true);
};
return (
<Wrapper
style={{ borderBottomColor: color, fontWeight: selected ? 600 : 400 }}
onClick={onSelected}
ref={colorButton}
>
<Name>{name}</Name>
<StyledButton onClick={handleOpen}>
<ChevronDown />
</StyledButton>
<>
<Wrapper
style={{ borderBottomColor: color, fontWeight: selected ? 600 : 400 }}
onClick={(event) => {
onSelected();
event.stopPropagation();
event.preventDefault();
}}
onPointerDown={(event) => {
// If it is in browse mode stop he event
const cell = workbookState.getEditingCell();
if (cell && isInReferenceMode(cell.text, cell.cursorStart)) {
event.stopPropagation();
event.preventDefault();
}
}}
ref={colorButton}
>
<Name>{name}</Name>
<StyledButton onClick={handleOpen}>
<ChevronDown />
</StyledButton>
</Wrapper>
<StyledMenu
anchorEl={anchorEl}
open={open}
@@ -70,7 +89,15 @@ function Sheet(props: SheetProps) {
>
Change Color
</MenuItem>
<MenuItem onClick={() => props.onDeleted()}> Delete</MenuItem>
<MenuItem
onClick={() => {
props.onDeleted();
handleClose();
}}
>
{" "}
Delete
</MenuItem>
</StyledMenu>
<SheetRenameDialog
isOpen={renameDialogOpen}
@@ -87,10 +114,13 @@ function Sheet(props: SheetProps) {
props.onColorChanged(color);
setColorPickerOpen(false);
}}
onClose={() => {
setColorPickerOpen(false);
}}
anchorEl={colorButton}
open={colorPickerOpen}
/>
</Wrapper>
</>
);
}

Some files were not shown because too many files have changed in this diff Show More