/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { Event } from '../../../../vs/base/common/event';
import {
  ICodeEditor,
  IDiffEditor,
} from '../../../../vs/editor/browser/editorBrowser';
import { IDecorationRenderOptions } from '../../../../vs/editor/common/editorCommon';
import { IModelDecorationOptions } from '../../../../vs/editor/common/model';
import { ITextResourceEditorInput } from '../../../../vs/platform/editor/common/editor';
import { createDecorator } from '../../../../vs/platform/instantiation/common/instantiation';
import { URI } from '../../../../vs/base/common/uri';

export const ICodeEditorService =
  createDecorator<ICodeEditorService>('codeEditorService');

export interface ICodeEditorService {
  readonly _serviceBrand: undefined;

  readonly onCodeEditorAdd: Event<ICodeEditor>;
  readonly onCodeEditorRemove: Event<ICodeEditor>;

  addCodeEditor(editor: ICodeEditor): void;
  removeCodeEditor(editor: ICodeEditor): void;
  listCodeEditors(): readonly ICodeEditor[];

  addDiffEditor(editor: IDiffEditor): void;
  removeDiffEditor(editor: IDiffEditor): void;
  listDiffEditors(): readonly IDiffEditor[];

  /**
   * Returns the current focused code editor (if the focus is in the editor or in an editor widget) or null.
   */
  getFocusedCodeEditor(): ICodeEditor | null;

  registerDecorationType(
    description: string,
    key: string,
    options: IDecorationRenderOptions,
    parentTypeKey?: string,
    editor?: ICodeEditor
  ): void;
  removeDecorationType(key: string): void;
  resolveDecorationOptions(
    typeKey: string,
    writable: boolean
  ): IModelDecorationOptions;

  setModelProperty(resource: URI, key: string, value: any): void;
  getModelProperty(resource: URI, key: string): any;

  getActiveCodeEditor(): ICodeEditor | null;
  openCodeEditor(
    input: ITextResourceEditorInput,
    source: ICodeEditor | null,
    sideBySide?: boolean
  ): Promise<ICodeEditor | null>;
}