IDL for index.

pkg/analyzer/lib/src/summary/idl.dart

 // Copyright (c) 2015, 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 file is an "idl" style description of the summary format.  It
  * contains abstract classes which declare the interface for reading data from
  * summaries.  It is parsed and transformed into code that implements the
  * summary format.
  *
@@ skipping 119 matching lines @@
   /**
    * If this is an instantiation of a generic type or generic executable, the
    * type arguments used to instantiate it.  Trailing type arguments of type
    * `dynamic` are omitted.
    */
   @Id(1)
   List<EntityRef> get typeArguments;
 }
 
 /**
+ * TODO(scheglov) document

[Paul Berry, 2016/02/25 17:14:25]

Please document this.

+ */
+enum IndexRelationKind {
+  EXTEND,
+  IMPLEMENT,
+  MIXIN,
+  READ,
+  READ_WRITE,
+  WRITE,
+  INVOKE,
+  REFERENCE
+}
+
+/**
  * Information about a dependency that exists between one library and another
  * due to an "import" declaration.
  */
 abstract class LinkedDependency extends base.SummaryClass {
   /**
    * URI for the compilation units listed in the library's `part` declarations.
    * These URIs are relative to the importing library.
    */
   @Id(1)
   List<String> get parts;
 
   /**
    * The relative URI of the dependent library.  This URI is relative to the
    * importing library, even if there are intervening `export` declarations.
    * So, for example, if `a.dart` imports `b/c.dart` and `b/c.dart` exports
    * `d/e.dart`, the URI listed for `a.dart`'s dependency on `e.dart` will be
    * `b/d/e.dart`.
    */
   @Id(0)
   String get uri;
 }
 
 /**
+ * TODO(scheglov) document

[Paul Berry, 2016/02/25 17:14:25]

Remove this.

+ */
+/**
  * Information about a single name in the export namespace of the library that
  * is not in the public namespace.
  */
 abstract class LinkedExportName extends base.SummaryClass {
   /**
    * Index into [LinkedLibrary.dependencies] for the library in which the
    * entity is defined.
    */
   @Id(0)
   int get dependency;
@@ skipping 215 matching lines @@
   List<UnlinkedUnit> get unlinkedUnits;
 
   /**
    * The list of URIs of items in [unlinkedUnits], e.g. `dart:core/bool.dart`.
    */
   @Id(3)
   List<String> get unlinkedUnitUris;
 }
 
 /**
+ * Index information about a package.
+ */
+@topLevel
+abstract class PackageIndex extends base.SummaryClass {
+  factory PackageIndex.fromBuffer(List<int> buffer) =>
+      generated.readPackageIndex(buffer);
+
+  /**
+   * Each item of this list corresponds to a unique library URI with an element
+   * referenced in the [PackageIndex].  It is index into [uris] list.

[Paul Berry, 2016/02/25 17:14:25]

s/It is index/It is an index/

+   */
+  @Id(2)
+  List<int> get elementLibraryUris;
+
+  /**
+   * Each item of this list corresponds to a unique referenced element.  It is
+   * the offset of the element name relative to the beginning of the file.  The
+   * list is sorted in ascending order, so that the client can quickly check
+   * whether an element is referenced in this [PackageIndex].
+   */
+  @Id(1)
+  List<int> get elementOffsets;
+
+  /**
+   * Each item of this list corresponds to a unique referenced element.  It is
+   * the index into [elementLibraryUris] and [elementUnitUris] for the library
+   * specific unit where the element is declared.
+   */
+  @Id(0)
+  List<int> get elementUnits;
+
+  /**
+   * Each item of this list corresponds to a unique unit URI with an element
+   * referenced in the [PackageIndex].  It is index into [uris] list.
+   */
+  @Id(3)
+  List<int> get elementUnitUris;
+
+  /**
+   * List of unit indexed in this [PackageIndex].

[Paul Berry, 2016/02/25 17:14:25]

s/unit/units/

+   */
+  @Id(5)
+  List<UnitIndex> get units;
+
+  /**
+   * List of unique URIs used in this [PackageIndex].
+   */
+  @Id(4)
+  List<String> get uris;
+}
+
+/**
  * Enum used to indicate the kind of entity referred to by a
  * [LinkedReference].
  */
 enum ReferenceKind {
   /**
    * The entity is a class or enum.
    */
   classOrEnum,
 
   /**
@@ skipping 48 matching lines @@
    */
   prefix,
 
   /**
    * The entity being referred to does not exist.
    */
   unresolved
 }
 
 /**
+ * Index information about a unit in a [PackageIndex].
+ */
+abstract class UnitIndex extends base.SummaryClass {
+  /**
+   * Each item of this list is the index into [PackageIndex.elementUnits] and
+   * [PackageIndex.elementOffsets].  The list is sorted in ascending order, so
+   * that the client can quickly find element references in this [UnitIndex].
+   */
+  @Id(4)
+  List<int> get elements;
+
+  /**
+   * Each item of this list is the kind of the element usage.
+   */
+  @Id(5)
+  List<IndexRelationKind> get kinds;
+
+  /**
+   * The library source URI of this unit, e.g. `dart:core` or
+   * `package:foo/bar.dart`, as index into [PackageIndex.uris].
+   */
+  @Id(0)
+  int get libraryUri;
+
+  /**
+   * Each item of this list is the length of the element usage.
+   */
+  @Id(2)
+  List<int> get locationLengths;
+
+  /**
+   * Each item of this list is the offset of the element usage relative to the
+   * beginning of the file.
+   */
+  @Id(3)
+  List<int> get locationOffsets;
+
+  /**
+   * The unit source URI of this unit, e.g. `dart:core/int.dart` or
+   * `package:foo/bar/baz.dart`, as index into [PackageIndex.uris].
+   */
+  @Id(1)
+  int get unitUri;
+}
+
+/**
  * Unlinked summary information about a class declaration.
  */
 abstract class UnlinkedClass extends base.SummaryClass {
   /**
    * Annotations for this class.
    */
   @Id(5)
   List<UnlinkedConst> get annotations;
 
   /**
@@ skipping 1516 matching lines @@
    */
   @Id(11)
   int get visibleLength;
 
   /**
    * If a local variable, the beginning of the visible range; zero otherwise.
    */
   @Id(12)
   int get visibleOffset;
 }