/********************************************************************************
 * Copyright (C) 2018 Red Hat, Inc. 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 WITH Classpath-exception-2.0
 ********************************************************************************/

import { URI } from '@gedit/utils';
import { MaybeArray } from '@gedit/utils';
import { BaseWidget, Widget } from './widgets';
import { WidgetOpenerOptions, WidgetOpenHandler } from './widget-open-handler';

/**
 * `Navigatable` provides an access to an URI of an underlying instance of `Resource`.
 */
export interface Navigatable {
  /**
   * Return an underlying resource URI.
   */
  getResourceUri(): URI | undefined;

  /**
   * Return reference URI
   */
  getReferenceUri?(): URI | undefined;
  /**
   * Creates a new URI to which this navigatable should moved based on the given target resource URI.
   */
  createMoveToUri(resourceUri: URI): URI | undefined;
}

export namespace Navigatable {
  export function is(arg: Object | undefined): arg is Navigatable {
    return !!arg && 'getResourceUri' in arg && 'createMoveToUri' in arg;
  }
}

export type NavigatableWidget = BaseWidget & Navigatable;
export namespace NavigatableWidget {
  export function is(arg: Object | undefined): arg is NavigatableWidget {
    return arg instanceof BaseWidget && Navigatable.is(arg);
  }

  export function* getAffected<T extends Widget>(
    widgets: IterableIterator<T> | ArrayLike<T>,
    context: MaybeArray<URI>
  ): IterableIterator<[URI, T & NavigatableWidget]> {
    const uris = Array.isArray(context) ? context : [context];
    return get(widgets, resourceUri => uris.some(uri => uri.isEqualOrParent(resourceUri)));
  }

  export function* get<T extends Widget>(
    widgets: IterableIterator<T> | ArrayLike<T>,
    filter: (resourceUri: URI) => boolean = () => true
  ): IterableIterator<[URI, T & NavigatableWidget]> {
    // @ts-ignore
    for (const widget of widgets) {
      if (NavigatableWidget.is(widget)) {
        const resourceUri = widget.getResourceUri();
        if (resourceUri && filter(resourceUri)) {
          // @ts-ignore
          yield [resourceUri, widget];
        }
      }
    }
  }
}

export interface NavigatableWidgetOptions {
  kind: 'navigatable',
  uri: string
}

export namespace NavigatableWidgetOptions {
  export function is(arg: Object | undefined): arg is NavigatableWidgetOptions {
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    return !!arg && 'kind' in arg && (arg as any).kind === 'navigatable';
  }
}

export abstract class NavigatableWidgetOpenHandler<W extends NavigatableWidget> extends WidgetOpenHandler<W> {

  protected createWidgetOptions(uri: URI, options?: WidgetOpenerOptions): NavigatableWidgetOptions {
    return {
      kind: 'navigatable',
      uri: this.serializeUri(uri)
    };
  }

  protected serializeUri(uri: URI): string {
    if (uri.scheme === 'file') {
      return uri.withoutFragment().normalizePath().toString();
    } else {
      return uri.withoutFragment().toString();
    }
  }

}