arduino-ide/arduino-ide-extension/src/browser/contributions/sketchbook.ts

import { inject, injectable } from '@theia/core/shared/inversify';
import { CommandHandler } from '@theia/core/lib/common/command';
import { CommandRegistry, MenuModelRegistry } from './contribution';
import { ArduinoMenus } from '../menu/arduino-menus';
import { MainMenuManager } from '../../common/main-menu-manager';
import { NotificationCenter } from '../notification-center';
import { Examples } from './examples';
import {
  SketchContainer,
  SketchesError,
  SketchRef,
} from '../../common/protocol';
import { OpenSketch } from './open-sketch';
import { nls } from '@theia/core/lib/common';

@injectable()
export class Sketchbook extends Examples {
  @inject(CommandRegistry)
  protected override readonly commandRegistry: CommandRegistry;

  @inject(MenuModelRegistry)
  protected override readonly menuRegistry: MenuModelRegistry;

  @inject(MainMenuManager)
  protected readonly mainMenuManager: MainMenuManager;

  @inject(NotificationCenter)
  protected readonly notificationCenter: NotificationCenter;

  override onStart(): void {
    this.sketchServiceClient.onSketchbookDidChange(() => this.update());
  }

  override async onReady(): Promise<void> {
    this.update();
  }

  private update() {
    this.sketchService.getSketches({}).then((container) => {
      this.register(container);
      this.mainMenuManager.update();
    });
  }

  override registerMenus(registry: MenuModelRegistry): void {
    registry.registerSubmenu(
      ArduinoMenus.FILE__SKETCHBOOK_SUBMENU,
      nls.localize('arduino/sketch/sketchbook', 'Sketchbook'),
      { order: '3' }
    );
  }

  protected register(container: SketchContainer): void {
    this.toDispose.dispose();
    this.registerRecursively(
      [...container.children, ...container.sketches],
      ArduinoMenus.FILE__SKETCHBOOK_SUBMENU,
      this.toDispose
    );
  }

  protected override createHandler(uri: string): CommandHandler {
    return {
      execute: async () => {
        let sketch: SketchRef | undefined = undefined;
        try {
          sketch = await this.sketchService.loadSketch(uri);
        } catch (err) {
          if (SketchesError.NotFound.is(err)) {
            // To handle the following:
            // Open IDE2, delete a sketch from sketchbook, click on File > Sketchbook > the deleted sketch.
            // Filesystem watcher misses out delete events on macOS; hence IDE2 has no chance to update the menu items.
            this.messageService.error(err.message);
            this.update();
          }
        }
        if (sketch) {
          await this.commandService.executeCommand(
            OpenSketch.Commands.OPEN_SKETCH.id,
            sketch
          );
        }
      },
    };
  }
}