Make MonacoPane calls createDecorationsCollection in a single place…

… instead of forcing many subclasses to remember to call `initDecorations`. Some subclasses never use DecorationsCollection and call init for no reason now, but it still seems healthier. Also remove the depracated `deltaDecorations` from stack-usage-view.
OfekShilon · May 3, 2024 · 08395d9 · 08395d9
1 parent 9f5906a
commit 08395d9
Show file tree

Hide file tree

Showing 9 changed files with 4 additions and 15 deletions.
diff --git a/static/colour.ts b/static/colour.ts
@@ -86,7 +86,6 @@ export const schemes: ColourSchemeInfo[] = [
     },
 ];
 
-// In every MonacoPane-child that needs to use this, make sure `createEditor` calls `this.initDecorations()`
 export function applyColours(
     colours: Record<number, number>,
     schemeName: string,

diff --git a/static/panes/ast-view.ts b/static/panes/ast-view.ts
@@ -119,7 +119,6 @@ export class Ast extends MonacoPane<monaco.editor.IStandaloneCodeEditor, AstStat
                 lineNumbersMinChars: 3,
             }),
         );
-        this.initDecorations();
     }
 
     override getPrintName() {

diff --git a/static/panes/compiler.ts b/static/panes/compiler.ts
@@ -391,7 +391,6 @@ export class Compiler extends MonacoPane<monaco.editor.IStandaloneCodeEditor, Co
                 this.settings,
             ),
         );
-        this.initDecorations();
     }
 
     override getPrintName() {

diff --git a/static/panes/device-view.ts b/static/panes/device-view.ts
@@ -97,7 +97,6 @@ export class DeviceAsm extends MonacoPane<monaco.editor.IStandaloneCodeEditor, D
                 lineNumbersMinChars: 3,
             }),
         );
-        this.initDecorations();
     }
 
     override getPrintName() {

diff --git a/static/panes/editor.ts b/static/panes/editor.ts
@@ -228,7 +228,6 @@ export class Editor extends MonacoPane<monaco.editor.IStandaloneCodeEditor, Edit
         );
 
         this.editor.getModel()?.setEOL(monaco.editor.EndOfLineSequence.LF);
-        this.initDecorations();
     }
 
     override getPrintName() {

diff --git a/static/panes/ir-view.ts b/static/panes/ir-view.ts
@@ -89,7 +89,6 @@ export class Ir extends MonacoPane<monaco.editor.IStandaloneCodeEditor, IrState>
                 lineNumbersMinChars: 3,
             }),
         );
-        this.initDecorations();
     }
 
     override getPrintName() {

diff --git a/static/panes/opt-view.ts b/static/panes/opt-view.ts
@@ -74,7 +74,6 @@ export class Opt extends MonacoPane<monaco.editor.IStandaloneCodeEditor, OptStat
                 glyphMargin: true,
             }),
         );
-        this.initDecorations();
     }
 
     override getPrintName() {

diff --git a/static/panes/pane.ts b/static/panes/pane.ts
@@ -294,6 +294,7 @@ export abstract class MonacoPane<E extends monaco.editor.IEditor, S> extends Pan
     override registerButtons(state: S): void {
         const editorRoot = this.domRoot.find('.monaco-placeholder')[0];
         this.createEditor(editorRoot);
+        this.editorDecorations = this.editor.createDecorationsCollection();
         this.fontScale = new FontScale(this.domRoot, state, this.editor);
     }
 
@@ -329,10 +330,6 @@ export abstract class MonacoPane<E extends monaco.editor.IEditor, S> extends Pan
      */
     abstract createEditor(editorRoot: HTMLElement): void;
 
-    initDecorations(): void {
-        this.editorDecorations = this.editor.createDecorationsCollection();
-    }
-
     protected override onSettingsChange(settings: SiteSettings) {
         super.onSettingsChange(settings);
         this.editor.updateOptions({

diff --git a/static/panes/stack-usage-view.ts b/static/panes/stack-usage-view.ts
@@ -39,7 +39,6 @@ import {CompilerInfo} from '../compiler.interfaces.js';
 import {unwrap} from '../assert.js';
 
 export class StackUsage extends MonacoPane<monaco.editor.IStandaloneCodeEditor, StackUsageState> {
-    currentDecorations: string[] = [];
     // Note: bool | undef here instead of just bool because of an issue with field initialization order
     isCompilerSupported?: boolean;
 
@@ -129,7 +128,7 @@ export class StackUsage extends MonacoPane<monaco.editor.IStandaloneCodeEditor,
     }
 
     showStackUsageResults(results: suCodeEntry[]) {
-        const su: monaco.editor.IModelDeltaDecoration[] = [];
+        const suDecorations: monaco.editor.IModelDeltaDecoration[] = [];
 
         const groupedResults = _.groupBy(results, x => x.DebugLoc.Line);
 
@@ -145,7 +144,7 @@ export class StackUsage extends MonacoPane<monaco.editor.IStandaloneCodeEditor,
                 return 'Mixed';
             }, '');
             const contents = value.map(this.getDisplayableOpt);
-            su.push({
+            suDecorations.push({
                 range: new monaco.Range(linenumber, 1, linenumber, Infinity),
                 options: {
                     isWholeLine: true,
@@ -156,7 +155,7 @@ export class StackUsage extends MonacoPane<monaco.editor.IStandaloneCodeEditor,
             });
         }
 
-        this.currentDecorations = this.editor.deltaDecorations(this.currentDecorations, su);
+        this.editorDecorations.set(suDecorations);
     }
 
     override onCompiler(id: number, compiler) {