Add cell clear payload (#223)

* feat: add cell clear payload

* feat: new render data provider

crates/controller/src/api/worksheet.rs

@@ -164,10 +164,16 @@ impl<'a> Worksheet<'a> {
 
         for row in start_row..=end_row {
             let row_info = self.get_row_info(row).unwrap_or(RowInfo::default(row));
+            if row_info.hidden {
+                continue;
+            }
             row_infos.push(row_info);
 
-            for col in start_col..=end_col {
+            'col: for col in start_col..=end_col {
                 let col_info = self.get_col_info(col).unwrap_or(ColInfo::default(col));
+                if col_info.hidden {
+                    continue 'col;
+                }
                 col_infos.push(col_info);
 
                 if let Some(comment) = self.get_comment(row, col) {

crates/controller/src/container/executor.rs

@@ -77,6 +77,14 @@ impl ContainerExecutor {
                 self.container.update_value(sheet_id, cell_id, cell_value);
                 Ok(self)
             }
+            EditPayload::CellClear(p) => {
+                let sheet_id = ctx
+                    .fetch_sheet_id_by_index(p.sheet_idx)
+                    .map_err(|l| BasicError::SheetIdxExceed(l))?;
+                let cell_id = ctx.fetch_cell_id(&sheet_id, p.row, p.col)?;
+                self.container.remove_cell(sheet_id, &cell_id);
+                Ok(self)
+            }
             EditPayload::SetColWidth(p) => {
                 let sheet_id = ctx
                     .fetch_sheet_id_by_index(p.sheet_idx)

crates/controller/src/container/mod.rs

@@ -98,6 +98,11 @@ impl DataContainer {
         sheet_container.cells.insert(cell_id, cell);
     }
 
+    pub fn remove_cell(&mut self, sheet_id: SheetId, cell_id: &CellId) {
+        let sheet_container = self.get_sheet_container_mut(sheet_id);
+        sheet_container.cells.remove(cell_id);
+    }
+
     pub fn update_value(&mut self, sheet_id: SheetId, cell_id: CellId, value: CellValue) {
         let sheet_container = self.get_sheet_container_mut(sheet_id);
         if let Some(v) = sheet_container.cells.get_mut(&cell_id) {

crates/controller/src/cube_manager/executors/mod.rs

@@ -42,6 +42,13 @@ impl CubeExecutor {
                     .map_err(|l| BasicError::SheetIdxExceed(l))?;
                 Ok(input(self, sheet_id, cell_input.row, cell_input.col, ctx))
             }
+            EditPayload::CellClear(cell_clear) => {
+                let sheet_idx = cell_clear.sheet_idx;
+                let sheet_id = ctx
+                    .fetch_sheet_id_by_index(sheet_idx)
+                    .map_err(|l| BasicError::SheetIdxExceed(l))?;
+                Ok(input(self, sheet_id, cell_clear.row, cell_clear.col, ctx))
+            }
             EditPayload::InsertCols(insert_cols) => {
                 let sheet_idx = insert_cols.sheet_idx;
                 let sheet_id = ctx

crates/controller/src/edit_action/mod.rs

@@ -97,6 +97,7 @@ pub enum EditPayload {
     BlockStyleUpdate(BlockStyleUpdate),
 
     CellInput(CellInput),
+    CellClear(CellClear),
     SetColWidth(SetColWidth),
     SetRowHeight(SetRowHeight),
     SetVisible(SetVisible),
@@ -211,6 +212,18 @@ pub struct CellInput {
     pub content: String,
 }
 
+#[derive(Debug, Clone)]
+#[cfg_attr(feature = "gents", derive(gents_derives::TS))]
+#[cfg_attr(
+    feature = "gents",
+    ts(file_name = "cell_clear.ts", rename_all = "camelCase")
+)]
+pub struct CellClear {
+    pub sheet_idx: usize,
+    pub row: usize,
+    pub col: usize,
+}
+
 /// Create a new block.
 ///
 /// Note that the block id is assigned by you. You are supposed to

crates/controller/src/range_manager/executors/mod.rs

@@ -103,6 +103,13 @@ impl RangeExecutor {
                 let res = input(self, sheet_id, p.row, p.col, ctx)?;
                 Ok(res)
             }
+            EditPayload::CellClear(p) => {
+                let sheet_id = ctx
+                    .fetch_sheet_id_by_index(p.sheet_idx)
+                    .map_err(|l| BasicError::SheetIdxExceed(l))?;
+                let res = input(self, sheet_id, p.row, p.col, ctx)?;
+                Ok(res)
+            }
             EditPayload::DeleteSheet(_) => todo!(),
             EditPayload::InsertCols(insert_cols) => {
                 let sheet_id = ctx

crates/controller/src/version_manager/diff.rs

@@ -195,5 +195,12 @@ fn convert_diff<C: VersionExecCtx>(
                 .map_err(|l| BasicError::SheetIdxExceed(l))?;
             Ok(Some((Diff::Unavailable, sheet_id)))
         }
+        EditPayload::CellClear(cr) => {
+            let sheet_id = ctx
+                .fetch_sheet_id_by_index(cr.sheet_idx)
+                .map_err(|l| BasicError::SheetIdxExceed(l))?;
+            let cell_id = ctx.fetch_cell_id(&sheet_id, cr.row, cr.col)?;
+            Ok(Some((Diff::CellValue(cell_id), sheet_id)))
+        }
     }
 }

crates/wasms/server/src/controller.rs

@@ -1,6 +1,6 @@
 use logisheets_controller::controller::display::{DisplayRequest, DisplayWindowWithStartPoint};
 use logisheets_controller::edit_action::{
-    AsyncFuncResult, BlockInput, CellInput, CreateBlock, CreateSheet, DeleteCols,
+    AsyncFuncResult, BlockInput, CellClear, CellInput, CreateBlock, CreateSheet, DeleteCols,
     DeleteColsInBlock, DeleteRows, DeleteRowsInBlock, DeleteSheet, EditAction, EditPayload,
     InsertCols, InsertColsInBlock, InsertRows, InsertRowsInBlock, MoveBlock, PayloadsAction,
     SheetRename, StyleUpdate, StyleUpdateType,
@@ -496,6 +496,19 @@ pub fn cell_input(id: usize, sheet_idx: usize, row: usize, col: usize, content:
     );
 }
 
+#[wasm_bindgen]
+pub fn cell_clear(id: usize, sheet_idx: usize, row: usize, col: usize) {
+    init();
+    MANAGER.get_mut().add_payload(
+        id,
+        EditPayload::CellClear(CellClear {
+            sheet_idx,
+            row,
+            col,
+        }),
+    );
+}
+
 #[wasm_bindgen]
 pub fn row_insert(id: usize, sheet_idx: usize, start: usize, count: usize) {
     init();

packages/web/src/api/workbook.ts

@@ -2,6 +2,7 @@ import {Payload} from '../payloads'
 import {
     block_input,
     block_line_shift,
+    cell_clear,
     cell_input,
     col_delete,
     col_insert,
@@ -224,6 +225,8 @@ export class Workbook {
         if (p.type === 'deleteSheet') return delete_sheet(this._id, p.sheetIdx)
         if (p.type === 'insertSheet')
             return create_sheet(this._id, p.sheetIdx, p.name)
+        if (p.type === 'cellClear')
+            return cell_clear(this._id, p.sheetIdx, p.row, p.col)
         // eslint-disable-next-line no-console
         console.log('Unimplemented!')
     }

packages/web/src/bindings/cell_clear.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface CellClear {
+    sheetIdx: number
+    row: number
+    col: number
+}

packages/web/src/bindings/edit_payload.ts

@@ -1,6 +1,7 @@
 // DO NOT EDIT. CODE GENERATED BY gents.
 import {BlockInput} from './block_input'
 import {BlockStyleUpdate} from './block_style_update'
+import {CellClear} from './cell_clear'
 import {CellInput} from './cell_input'
 import {CreateBlock} from './create_block'
 import {CreateSheet} from './create_sheet'
@@ -31,6 +32,7 @@ export type EditPayload =
     | {styleUpdate: StyleUpdate}
     | {blockStyleUpdate: BlockStyleUpdate}
     | {cellInput: CellInput}
+    | {cellClear: CellClear}
     | {setColWidth: SetColWidth}
     | {setRowHeight: SetRowHeight}
     | {setVisible: SetVisible}

packages/web/src/bindings/index.ts

@@ -8,6 +8,7 @@ export * from './block_style_update'
 export * from './border'
 export * from './border_pr'
 export * from './cell_alignment'
+export * from './cell_clear'
 export * from './cell_formula_value'
 export * from './cell_id'
 export * from './cell_info'

packages/web/src/index.ts

@@ -11,6 +11,7 @@ export type {
     Color,
     Comment,
     CtCellAlignment,
+    CellInfo,
     CtCellProtection,
     CtFontFamily,
     CtFontName,
@@ -19,6 +20,8 @@ export type {
     DisplayPatch,
     DisplayRequest,
     DisplayResponse,
+    DisplayWindow,
+    DisplayWindowWithStartPoint,
     EditAction,
     Fill,
     Font,

packages/web/src/payloads/cell_clear.ts

@@ -0,0 +1,36 @@
+export interface CellClear {
+    readonly type: 'cellClear'
+    readonly sheetIdx: number
+    readonly row: number
+    readonly col: number
+}
+
+export class CellClearBuilder {
+    private _sheetIdx?: number
+    private _row?: number
+    private _col?: number
+    public sheetIdx(sheetIdx: number): this {
+        this._sheetIdx = sheetIdx
+        return this
+    }
+    public row(row: number): this {
+        this._row = row
+        return this
+    }
+    public col(col: number): this {
+        this._col = col
+        return this
+    }
+    public build(): CellClear {
+        if (this._sheetIdx === undefined) throw Error('sheetIdx is undefined!')
+        if (this._row === undefined) throw Error('row is undefined!')
+        if (this._col === undefined) throw Error('col is undefined!')
+
+        return {
+            type: 'cellClear',
+            sheetIdx: this._sheetIdx,
+            row: this._row,
+            col: this._col,
+        }
+    }
+}

packages/web/src/payloads/index.ts

@@ -19,6 +19,7 @@ import {SetFont} from './set_font'
 import {SetRowHeight} from './set_row_height'
 import {SetRowVisible} from './set_row_visible'
 import {SheetRename} from './sheet_rename'
+import {CellClear} from './cell_clear'
 
 export * from './cell_input'
 export * from './create_block'
@@ -41,10 +42,12 @@ export * from './set_row_height'
 export * from './set_row_visible'
 export * from './sheet_rename'
 export * from './block_input'
+export * from './cell_clear'
 
 export type Payload =
     | BlockInput
     | CellInput
+    | CellClear
     | CreateBlock
     | DeleteBlockCols
     | DeleteBlockRows

src/core/data2/index.ts

@@ -1 +1,2 @@
 export * from './workbook'
+export * from './render'