pkg/analysis_server/lib/src/generated/service_interfaces.dart

// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// This code was auto-generated, is not intended to be edited, and is subject to
// significant change. Please see the README file for more information.

library service.interfaces;

import 'package:analyzer/src/generated/java_core.dart' show Enum;
import 'package:analyzer/src/generated/source.dart' show Source;

/**
 * The interface `HighlightRegion` defines the behavior of objects representing a particular
 * syntactic or semantic meaning associated with a source region.
 */
abstract class HighlightRegion implements SourceRegion {
  /**
   * Return the type of highlight associated with the region.
   *
   * @return the type of highlight associated with the region
   */
  HighlightType get type;
}

/**
 * The interface `NavigationTarget` defines the behavior of objects that provide information
 * about the target of a navigation region.
 */
abstract class NavigationTarget {
  /**
   * Return the id of the element to which this target will navigate.
   *
   * @return the id of the element to which this target will navigate
   */
  String get elementId;

  /**
   * Return the length of the region to which the target will navigate.
   *
   * @return the length of the region to which the target will navigate
   */
  int get length;

  /**
   * Return the offset to the region to which the target will navigate.
   *
   * @return the offset to the region to which the target will navigate
   */
  int get offset;

  /**
   * Return the source containing the element to which this target will navigate.
   *
   * @return the source containing the element to which this target will navigate
   */
  Source get source;
}

/**
 * The enumeration `OutlineKind` defines the various kinds of [Outline] items.
 */
class OutlineKind extends Enum<OutlineKind> {
  static const OutlineKind CLASS = const OutlineKind('CLASS', 0);

  static const OutlineKind CLASS_TYPE_ALIAS = const OutlineKind('CLASS_TYPE_ALIAS', 1);

  static const OutlineKind CONSTRUCTOR = const OutlineKind('CONSTRUCTOR', 2);

  static const OutlineKind GETTER = const OutlineKind('GETTER', 3);

  static const OutlineKind FIELD = const OutlineKind('FIELD', 4);

  static const OutlineKind FUNCTION = const OutlineKind('FUNCTION', 5);

  static const OutlineKind FUNCTION_TYPE_ALIAS = const OutlineKind('FUNCTION_TYPE_ALIAS', 6);

  static const OutlineKind METHOD = const OutlineKind('METHOD', 7);

  static const OutlineKind SETTER = const OutlineKind('SETTER', 8);

  static const OutlineKind TOP_LEVEL_VARIABLE = const OutlineKind('TOP_LEVEL_VARIABLE', 9);

  static const OutlineKind COMPILATION_UNIT = const OutlineKind('COMPILATION_UNIT', 10);

  static const List<OutlineKind> values = const [
      CLASS,
      CLASS_TYPE_ALIAS,
      CONSTRUCTOR,
      GETTER,
      FIELD,
      FUNCTION,
      FUNCTION_TYPE_ALIAS,
      METHOD,
      SETTER,
      TOP_LEVEL_VARIABLE,
      COMPILATION_UNIT];

  const OutlineKind(String name, int ordinal) : super(name, ordinal);
}

/**
 * The interface `SourceSet` defines the behavior of objects that represent a set of
 * [Source]s.
 */
abstract class SourceSet {
  /**
   * An instance of [SourceSet] for [SourceSetKind#ALL].
   */
  static final SourceSet ALL = new _ImplicitSourceSet(SourceSetKind.ALL);

  /**
   * An instance of [SourceSet] for [SourceSetKind#NON_SDK].
   */
  static final SourceSet NON_SDK = new _ImplicitSourceSet(SourceSetKind.NON_SDK);

  /**
   * An instance of [SourceSet] for [SourceSetKind#EXPLICITLY_ADDED].
   */
  static final SourceSet EXPLICITLY_ADDED = new _ImplicitSourceSet(SourceSetKind.EXPLICITLY_ADDED);

  /**
   * Return the kind of the this source set.
   */
  SourceSetKind get kind;

  /**
   * Returns [Source]s that belong to this source set, if [SourceSetKind#LIST] is used;
   * an empty array otherwise.
   */
  List<Source> get sources;
}

/**
 * The enumeration `SourceSetKind` defines the kinds of [SourceSet]s.
 */
class SourceSetKind extends Enum<SourceSetKind> {
  static const SourceSetKind ALL = const SourceSetKind('ALL', 0);

  static const SourceSetKind NON_SDK = const SourceSetKind('NON_SDK', 1);

  static const SourceSetKind EXPLICITLY_ADDED = const SourceSetKind('EXPLICITLY_ADDED', 2);

  static const SourceSetKind LIST = const SourceSetKind('LIST', 3);

  static const List<SourceSetKind> values = const [ALL, NON_SDK, EXPLICITLY_ADDED, LIST];

  const SourceSetKind(String name, int ordinal) : super(name, ordinal);
}

/**
 * The interface `SourceRegion` defines the behavior of objects representing a range of
 * characters within a [Source].
 */
abstract class SourceRegion {
  /**
   * Check if <code>x</code> is in [offset, offset + length] interval.
   */
  bool containsInclusive(int x);

  /**
   * Return the length of the region.
   *
   * @return the length of the region
   */
  int get length;

  /**
   * Return the offset to the beginning of the region.
   *
   * @return the offset to the beginning of the region
   */
  int get offset;
}

/**
 * The enumeration `NotificationKind` defines the kinds of notification clients may subscribe
 * for.
 */
class NotificationKind extends Enum<NotificationKind> {
  static const NotificationKind ERRORS = const NotificationKind('ERRORS', 0);

  static const NotificationKind HIGHLIGHT = const NotificationKind('HIGHLIGHT', 1);

  static const NotificationKind NAVIGATION = const NotificationKind('NAVIGATION', 2);

  static const NotificationKind OUTLINE = const NotificationKind('OUTLINE', 3);

  static const List<NotificationKind> values = const [ERRORS, HIGHLIGHT, NAVIGATION, OUTLINE];

  const NotificationKind(String name, int ordinal) : super(name, ordinal);
}

/**
 * The interface `NavigationRegion` defines the behavior of objects representing a list of
 * elements with which a source region is associated.
 */
abstract class NavigationRegion implements SourceRegion {
  /**
   * An empty array of navigation regions.
   */
  static final List<NavigationRegion> EMPTY_ARRAY = new List<NavigationRegion>(0);

  /**
   * Return the identifiers of the elements associated with the region.
   *
   * @return the identifiers of the elements associated with the region
   */
  List<NavigationTarget> get targets;
}

/**
 * An implementation of [SourceSet] for some [SourceSetKind].
 */
class _ImplicitSourceSet implements SourceSet {
  final SourceSetKind kind;

  _ImplicitSourceSet(this.kind);

  @override
  List<Source> get sources => Source.EMPTY_ARRAY;

  @override
  String toString() => kind.toString();
}

/**
 * The enumeration `HighlightType` defines the kinds of highlighting that can be associated
 * with a region of text.
 */
class HighlightType extends Enum<HighlightType> {
  static const HighlightType COMMENT_BLOCK = const HighlightType('COMMENT_BLOCK', 0);

  static const HighlightType COMMENT_DOCUMENTATION = const HighlightType('COMMENT_DOCUMENTATION', 1);

  static const HighlightType COMMENT_END_OF_LINE = const HighlightType('COMMENT_END_OF_LINE', 2);

  static const HighlightType KEYWORD = const HighlightType('KEYWORD', 3);

  static const HighlightType LITERAL_BOOLEAN = const HighlightType('LITERAL_BOOLEAN', 4);

  static const HighlightType LITERAL_DOUBLE = const HighlightType('LITERAL_DOUBLE', 5);

  static const HighlightType LITERAL_INTEGER = const HighlightType('LITERAL_INTEGER', 6);

  static const HighlightType LITERAL_LIST = const HighlightType('LITERAL_LIST', 7);

  static const HighlightType LITERAL_MAP = const HighlightType('LITERAL_MAP', 8);

  static const HighlightType LITERAL_STRING = const HighlightType('LITERAL_STRING', 9);

  static const List<HighlightType> values = const [
      COMMENT_BLOCK,
      COMMENT_DOCUMENTATION,
      COMMENT_END_OF_LINE,
      KEYWORD,
      LITERAL_BOOLEAN,
      LITERAL_DOUBLE,
      LITERAL_INTEGER,
      LITERAL_LIST,
      LITERAL_MAP,
      LITERAL_STRING];

  const HighlightType(String name, int ordinal) : super(name, ordinal);
}

/**
 * The interface `Outline` defines the behavior of objects that represent an outline for a
 * single source.
 */
abstract class Outline {
  /**
   * An empty array of outlines.
   */
  static final List<Outline> EMPTY_ARRAY = new List<Outline>(0);

  /**
   * Return the argument list for the element, or `null` if the element is not a method or
   * function. If the element has zero arguments, the string `"()"` will be returned.
   *
   * @return the argument list for the element
   */
  String get arguments;

  /**
   * Return an array containing the children of the element. The array will be empty if the element
   * has no children.
   *
   * @return an array containing the children of the element
   */
  List<Outline> get children;

  /**
   * Return the kind of the element.
   *
   * @return the kind of the element
   */
  OutlineKind get kind;

  /**
   * Return the length of the element's name.
   *
   * @return the length of the element's name
   */
  int get length;

  /**
   * Return the name of the element.
   *
   * @return the name of the element
   */
  String get name;

  /**
   * Return the offset to the beginning of the element's name.
   *
   * @return the offset to the beginning of the element's name
   */
  int get offset;

  /**
   * Return the outline that either physically or logically encloses this outline. This will be
   * `null` if this outline is a unit outline.
   *
   * @return the outline that encloses this outline
   */
  Outline get parent;

  /**
   * Return the return type of the element, or `null` if the element is not a method or
   * function. If the element does not have a declared return type then an empty string will be
   * returned.
   *
   * @return the return type of the element
   */
  String get returnType;
}