vscode: support icons contribution point

packages/monaco/src/browser/monaco-frontend-module.ts

@@ -68,6 +68,9 @@ import { MimeService } from '@theia/core/lib/browser/mime-service';
 import { MonacoEditorServices } from './monaco-editor';
 import { MonacoColorRegistry } from './monaco-color-registry';
 import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
+import { IconRegistry, IconStyleSheetService } from './monaco-icon-registry-types';
+import { MonacoIconRegistry } from './monaco-icon-registry';
+import { MonacoIconStyleSheetService } from './monaco-icon-style-sheet';
 import { MonacoThemingService } from './monaco-theming-service';
 import { bindContributionProvider } from '@theia/core';
 import { WorkspaceSymbolCommand } from './workspace-symbol-command';
@@ -187,6 +190,12 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
 
     bind(ThemeServiceWithDB).toSelf().inSingletonScope();
     rebind(ThemeService).toService(ThemeServiceWithDB);
+
+    bind(MonacoIconRegistry).toSelf().inSingletonScope();
+    bind(IconRegistry).toService(MonacoIconRegistry);
+
+    bind(MonacoIconStyleSheetService).toSelf().inSingletonScope();
+    bind(IconStyleSheetService).toService(MonacoIconStyleSheetService);
 });
 
 export const MonacoConfigurationService = Symbol('MonacoConfigurationService');

packages/monaco/src/browser/monaco-icon-registry-types.ts

@@ -0,0 +1,127 @@
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Event } from '@theia/core';
+import { IJSONSchema } from '@theia/core/lib/common/json-schema';
+import { ThemeIcon } from '@theia/monaco-editor-core/esm/vs/platform/theme/common/themeService';
+import { URI } from '@theia/core/shared/vscode-uri';
+
+//  ------ API types
+
+export type IconIdentifier = string;
+
+// icon registry
+export const Extensions = {
+    IconContribution: 'base.contributions.icons'
+};
+
+export type IconDefaults = ThemeIcon | IconDefinition;
+
+export interface IconDefinition {
+    font?: IconFontContribution; // undefined for the default font (codicon)
+    fontCharacter: string;
+}
+
+export interface IconContribution {
+    readonly id: string;
+    description: string | undefined;
+    deprecationMessage?: string;
+    readonly defaults: IconDefaults;
+}
+
+export interface IconFontContribution {
+    readonly id: string;
+    readonly definition: IconFontDefinition;
+}
+
+export interface IconFontDefinition {
+    readonly weight?: string;
+    readonly style?: string;
+    readonly src: IconFontSource[];
+}
+
+export interface IconFontSource {
+    readonly location: URI;
+    readonly format: string;
+}
+
+export const IconRegistry = Symbol('IconRegistry');
+export interface IconRegistry {
+
+    readonly onDidChange: Event<void>;
+
+    /**
+     * Register a icon to the registry.
+     * @param id The icon id
+     * @param defaults The default values
+     * @param description The description
+     */
+    registerIcon(id: IconIdentifier, defaults: IconDefaults, description?: string): ThemeIcon;
+
+    /**
+     * Deregister a icon from the registry.
+     */
+    deregisterIcon(id: IconIdentifier): void;
+
+    /**
+     * Get all icon contributions
+     */
+    getIcons(): IconContribution[];
+
+    /**
+     * Get the icon for the given id
+     */
+    getIcon(id: IconIdentifier): IconContribution | undefined;
+
+    /**
+     * JSON schema for an object to assign icon values to one of the icon contributions.
+     */
+    getIconSchema(): IJSONSchema;
+
+    /**
+     * JSON schema to for a reference to a icon contribution.
+     */
+    getIconReferenceSchema(): IJSONSchema;
+
+    /**
+     * Register a icon font to the registry.
+     * @param id The icon font id
+     * @param definition The icon font definition
+     */
+    registerIconFont(id: string, definition: IconFontDefinition): IconFontDefinition;
+
+    /**
+     * Deregister an icon font to the registry.
+     */
+    deregisterIconFont(id: string): void;
+
+    /**
+     * Get the icon font for the given id
+     */
+    getIconFont(id: string): IconFontDefinition | undefined;
+}
+
+export const IconsStyleSheet = Symbol('IconsStyleSheet');
+export interface IconsStyleSheet {
+    getCSS(): string;
+    readonly onDidChange: Event<void>;
+}
+
+export const IconStyleSheetService = Symbol('IconStyleSheetService');
+export interface IconStyleSheetService {
+    getIconsStyleSheet(): IconsStyleSheet;
+}
+

packages/monaco/src/browser/monaco-icon-registry.ts

@@ -0,0 +1,58 @@
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+import * as monaco from '@theia/monaco-editor-core/esm/vs/platform/theme/common/iconRegistry';
+import { IconContribution, IconDefaults, IconFontDefinition, IconRegistry } from './monaco-icon-registry-types';
+import { Event } from '@theia/core';
+import { IJSONSchema } from '@theia/core/lib/common/json-schema';
+import { ThemeIcon } from '@theia/monaco-editor-core/esm/vs/platform/theme/common/themeService';
+
+@injectable()
+export class MonacoIconRegistry implements IconRegistry {
+    protected readonly iconRegistry = monaco.getIconRegistry();
+
+    onDidChange: Event<void> = this.iconRegistry.onDidChange;
+
+    registerIcon(id: string, defaults: IconDefaults, description?: string | undefined): ThemeIcon {
+        return this.iconRegistry.registerIcon(id, defaults, description);
+    }
+    deregisterIcon(id: string): void {
+        return this.iconRegistry.deregisterIcon(id);
+    }
+    getIcons(): IconContribution[] {
+        return this.iconRegistry.getIcons();
+    }
+    getIcon(id: string): IconContribution | undefined {
+        return this.iconRegistry.getIcon(id);
+    }
+    getIconSchema(): IJSONSchema {
+        return this.iconRegistry.getIconSchema();
+    }
+    getIconReferenceSchema(): IJSONSchema {
+        return this.iconRegistry.getIconReferenceSchema();
+    }
+    registerIconFont(id: string, definition: IconFontDefinition): IconFontDefinition {
+        return this.iconRegistry.registerIconFont(id, definition);
+    }
+    deregisterIconFont(id: string): void {
+        return this.iconRegistry.deregisterIconFont(id);
+    }
+    getIconFont(id: string): IconFontDefinition | undefined {
+        return this.iconRegistry.getIconFont(id);
+    }
+
+}

packages/monaco/src/browser/monaco-icon-style-sheet.ts

@@ -0,0 +1,27 @@
+// *****************************************************************************
+// Copyright (C) 2023 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+import { getIconsStyleSheet } from '@theia/monaco-editor-core/esm/vs/platform/theme/browser/iconsStyleSheet';
+import { IconsStyleSheet } from './monaco-icon-registry-types';
+
+@injectable()
+export class MonacoIconStyleSheetService {
+    protected getIconsStyleSheet(): IconsStyleSheet {
+        return getIconsStyleSheet(undefined);
+    }
+
+}

packages/plugin-ext/src/common/plugin-protocol.ts

@@ -17,7 +17,7 @@ import { RpcServer } from '@theia/core/lib/common/messaging/proxy-factory';
 import { RPCProtocol } from './rpc-protocol';
 import { Disposable } from '@theia/core/lib/common/disposable';
 import { LogPart, KeysToAnyValues, KeysToKeysToAnyValue } from './types';
-import { CharacterPair, CommentRule, PluginAPIFactory, Plugin } from './plugin-api-rpc';
+import { CharacterPair, CommentRule, PluginAPIFactory, Plugin, ThemeIcon } from './plugin-api-rpc';
 import { ExtPluginApi } from './plugin-ext-api-contribution';
 import { IJSONSchema, IJSONSchemaSnippet } from '@theia/core/lib/common/json-schema';
 import { RecursivePartial } from '@theia/core/lib/common/types';
@@ -90,6 +90,7 @@ export interface PluginPackageContribution {
     snippets?: PluginPackageSnippetsContribution[];
     themes?: PluginThemeContribution[];
     iconThemes?: PluginIconThemeContribution[];
+    icons?: PluginIconContribution[];
     colors?: PluginColorContribution[];
     taskDefinitions?: PluginTaskDefinitionContribution[];
     problemMatchers?: PluginProblemMatcherContribution[];
@@ -262,6 +263,13 @@ export interface PluginIconThemeContribution {
     uiTheme?: PluginUiTheme;
 }
 
+export interface PluginIconContribution {
+    [id: string]: {
+        description: string;
+        default: { fontPath: string; fontCharacter: string } | string;
+    };
+}
+
 export interface PlatformSpecificAdapterContribution {
     program?: string;
     args?: string[];
@@ -586,6 +594,7 @@ export interface PluginContribution {
     snippets?: SnippetContribution[];
     themes?: ThemeContribution[];
     iconThemes?: IconThemeContribution[];
+    icons?: IconContribution[];
     colors?: ColorDefinition[];
     taskDefinitions?: TaskDefinition[];
     problemMatchers?: ProblemMatcherContribution[];
@@ -662,6 +671,26 @@ export interface IconThemeContribution {
     uiTheme?: UiTheme;
 }
 
+export interface IconDefinition {
+    fontCharacter: string;
+    location: string;
+}
+
+export type IconDefaults = ThemeIcon | IconDefinition;
+
+export interface IconContribution {
+    id: string;
+    extensionId: string;
+    description: string | undefined;
+    defaults: IconDefaults;
+}
+
+export namespace IconContribution {
+    export function isIconDefinition(defaults: IconDefaults): defaults is IconDefinition {
+        return 'fontCharacter' in defaults;
+    }
+}
+
 export interface GrammarsContribution {
     format: 'json' | 'plist';
     language?: string;