@trebco/treb 27.2.1 → 27.5.3

package/treb-grid/src/types/grid.ts

@@ -60,7 +60,7 @@ import {
 
 import { Yield, SerializeHTML } from 'treb-utils';
 import type { ParseResult as ParseResult2 } from 'treb-format';
-import { NumberFormatCache, LotusDate, ValueParser, Hints, NumberFormat } from 'treb-format';
+import { NumberFormatCache, LotusDate, ValueParser, type Hints, NumberFormat } from 'treb-format';
 import { SelectionRenderer } from '../render/selection-renderer';
 
 import { TabBar } from './tab_bar';
@@ -114,6 +114,8 @@ import { GridBase } from './grid_base';
 import type { SetRangeOptions } from './set_range_options';
 import type { ClipboardCellData } from './clipboard_data';
 
+import type { ExternalEditorType } from './external_editor';
+
 interface DoubleClickData {
   timeout?: number;
   address?: ICellAddress;
@@ -125,6 +127,7 @@ enum EditingState {
   FormulaBar = 2,
 }
 
+
 export class Grid extends GridBase {
 
   // --- public members --------------------------------------------------------
@@ -263,6 +266,13 @@ export class Grid extends GridBase {
 
   private select_argument = false; // temp, WIP
 
+  /**
+   * not sure what select_argument was for (possibly outside client), but
+   * we're formalizing the concept of external selection to support outside
+   * tooling.
+   */
+  private external_editor: Partial<ExternalEditorType> | undefined;
+
   /**
    * flag indicating we're resizing, or hovering over a resize.
    * we use this so we know what to do when we see a click on the headers.
@@ -1644,6 +1654,33 @@ export class Grid extends GridBase {
     this.RenderSelections();
   }
 
+  /**
+   * set or remove external editor. this is not an accessor because I don't
+   * want to have to use a duplicate internal field, it's clumsy and this
+   * class isn't public-facing so it's not super important.
+   */
+  public ExternalEditor(external_editor: Partial<ExternalEditorType>|undefined) {
+
+    this.external_editor = external_editor;
+
+    if (external_editor) {
+      if (external_editor.dependencies) {
+
+        // FIXME: this is getting messy and we're doing it twice, consolidate
+
+        this.HighlightDependencies(external_editor.dependencies.filter(
+          <T>(entry: T|undefined): entry is T => !!entry).map(reference => 
+            IsCellAddress(reference) ? new Area(reference) : new Area(reference.start, reference.end)));
+      }
+    }
+    else {
+      this.ClearAdditionalSelections();
+      this.RenderSelections(true);
+    }
+
+  } 
+
+
   /** API method */
   public SelectRange(range?: Area): void {
     this.Select(this.primary_selection, range);
@@ -3984,6 +4021,9 @@ export class Grid extends GridBase {
         if (this.overlay_editor?.editing) {
           // ...
         }
+        else if (this.external_editor) {
+          // ...
+        }
         else if (this.select_argument) {
           // ...
         }
@@ -4237,8 +4277,6 @@ export class Grid extends GridBase {
     // if this is a single merged block, we want to insert it as the
     // root cell and not the range.
 
-    // let label = selection.area.spreadsheet_label;
-
     const data = this.active_sheet.CellData(selection.area.start);
     const target = new Area(data.merge_area ? data.merge_area.start : selection.target);
 
@@ -4246,13 +4284,12 @@ export class Grid extends GridBase {
 
     if (!label) {
 
-      // label = Area.CellAddressToLabel(target.start);
       label = selection.area.spreadsheet_label;
       if (data.merge_area && data.merge_area.Equals(selection.area)) {
         label = Area.CellAddressToLabel(data.merge_area.start);
       }
 
-      if (this.active_sheet.id !== this.editing_cell.sheet_id) {
+      if (this.external_editor || this.active_sheet.id !== this.editing_cell.sheet_id) {
         const name = this.active_sheet.name;
 
         if (QuotedSheetNameRegex.test(name)) {
@@ -4265,12 +4302,25 @@ export class Grid extends GridBase {
 
     }
 
+    // the external editor should just handle normal select events
+    // for now, we might update that in the future.
+
     if (this.overlay_editor?.editing && this.overlay_editor.selecting) {
       this.overlay_editor.InsertReference(label, 0);
     }
     else if (this.formula_bar && this.formula_bar.selecting) {
       this.formula_bar.InsertReference(label, 0);
     }
+    else if (this.external_editor) {
+      if (this.external_editor.update) {
+        const result = this.external_editor.update.call(0, label);
+        if (result && Array.isArray(result)) {
+          this.HighlightDependencies(
+            result.filter(<T>(entry: T|undefined): entry is T => !!entry).map(reference => 
+             IsCellAddress(reference) ? new Area(reference) : new Area(reference.start, reference.end)));
+        }
+      }
+    }
     else if (this.select_argument) {
       this.grid_events.Publish({
         type: 'alternate-selection',
@@ -4288,6 +4338,7 @@ export class Grid extends GridBase {
   private SelectingArgument() {
     return (this.overlay_editor?.editing && this.overlay_editor?.selecting)
       || (this.formula_bar && this.formula_bar.selecting)
+      || (this.external_editor)
       || (this.select_argument);
   }
 
@@ -4911,6 +4962,12 @@ export class Grid extends GridBase {
             if (!cell.style || !cell.style.number_format || NumberFormatCache.Equals(cell.style.number_format, 'General')) {
               const func = formula_parse_result.expression.name.toLowerCase();
               let number_format: string|undefined;
+
+              // FIXME: these should be defined on the functions themselves,
+              // so we don't have to maintain a list. that also implies we
+              // need the list of functions, which we don't have atm? maybe
+              // through the AC instance? (...)
+
               switch (func) {
                 case 'today':
                   number_format = 'Short Date';
@@ -4928,25 +4985,51 @@ export class Grid extends GridBase {
             }
           }
           if (formula_parse_result.dependencies) {
+
+            // this was set up to just use the first format we found. 
+            // updating to change priority -- if the first one is a 
+            // percentage formula, look for another one before using
+            // the percentage. this is almost always what you want.
+
+            let found_number_format: string|undefined = undefined;
+
             const list = formula_parse_result.dependencies;
             for (const key of Object.keys(list.addresses)) {
               const address = list.addresses[key];
               if (this.active_sheet.HasCellStyle({ ...address })) {
+
+                // FIXME: this should not be active_sheet
+
                 const test = this.active_sheet.CellData({ ...address });
                 if (test.style && test.style.number_format) {
-                  const style: CellStyle = {
-                    number_format: test.style.number_format,
-                  };
-                  // if (array) this.model.sheet.UpdateAreaStyle(selection.area, style, true, true);
-                  // else this.model.sheet.UpdateCellStyle(target, style, true, true);
-                  commands.push({
-                    key: CommandKey.UpdateStyle,
-                    area: array ? selection.area : target, style, delta: true
-                  });
+                  if (!found_number_format || /%/.test(found_number_format)) {
+
+                    // convert to a string format if it's symbolic. that
+                    // is purely so we can check for a %. FIXME: I don't 
+                    // like the name of this method (Translate)
+
+                    found_number_format = NumberFormatCache.Translate(test.style.number_format);
+                    if (!/%/.test(found_number_format)) {
+                      break;
+                    }
+
+                  }
                 }
-                break;
               }
             }
+
+            if (found_number_format) {
+
+              const style: CellStyle = {
+                number_format: found_number_format,
+              };
+
+              commands.push({
+                key: CommandKey.UpdateStyle,
+                area: array ? selection.area : target, style, delta: true
+              });
+            }
+
           }
         }
       }
@@ -4988,7 +5071,7 @@ export class Grid extends GridBase {
       // const text = value.toString();
 
       let number_format = '';
-      const hints = parse_result.hints || Hints.None;
+      const hints: Hints = parse_result.hints || {};
 
       // be stricter about number format. don't implicitly /change/
       // the number format (you can /set/, but don't /change/). 
@@ -4999,24 +5082,19 @@ export class Grid extends GridBase {
 
       if (!cell.style || !cell.style.number_format || NumberFormatCache.Equals(cell.style.number_format, 'General')) {
 
-        // tslint:disable-next-line:no-bitwise
-        if (hints & Hints.Date) {
+        if (hints.Date) {
           number_format = 'Short Date';
         }
-        // tslint:disable-next-line:no-bitwise
-        else if (hints & Hints.Exponential) {
+        else if (hints.Exponential) {
           number_format = 'Exponential';
         }
-        // tslint:disable-next-line:no-bitwise
-        else if (hints & Hints.Percent) {
+        else if (hints.Percent) {
           number_format = 'Percent';
         }
-        // tslint:disable-next-line:no-bitwise
-        else if (hints & Hints.Currency) {
+        else if (hints.Currency) {
           number_format = 'Currency';
         }
-        // tslint:disable-next-line:no-bitwise
-        else if ((hints & Hints.Grouping) || (hints & Hints.Parens)) {
+        else if (hints.Grouping || hints.Parens) {
           number_format = 'Accounting';
         }