Resynthesize codeOffset/codeLength properties.

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 411 matching lines @@
    */
   @Id(0)
   int get unit;
 }
 
 /**
  * Linked summary of a compilation unit.
  */
 abstract class LinkedUnit extends base.SummaryClass {
   /**
+   * List of slot ids (referring to [UnlinkedExecutable.constCycleSlot])
+   * corresponding to const constructors that are part of cycles.
+   */
+  @Id(2)
+  List<int> get constCycles;
+
+  /**
    * Information about the resolution of references within the compilation
    * unit.  Each element of [UnlinkedUnit.references] has a corresponding
    * element in this list (at the same index).  If this list has additional
    * elements beyond the number of elements in [UnlinkedUnit.references], those
    * additional elements are references that are only referred to implicitly
    * (e.g. elements involved in inferred or propagated types).
    */
   @Id(0)
   List<LinkedReference> get references;
 
   /**
    * List associating slot ids found inside the unlinked summary for the
    * compilation unit with propagated and inferred types.
    */
   @Id(1)
   List<EntityRef> get types;
-
-  /**
-   * List of slot ids (referring to [UnlinkedExecutable.constCycleSlot])
-   * corresponding to const constructors that are part of cycles.
-   */
-  @Id(2)
-  List<int> get constCycles;
 }
 
 /**
  * Summary information about a package.
  */
 @TopLevel('PBdl')
 abstract class PackageBundle extends base.SummaryClass {
   factory PackageBundle.fromBuffer(List<int> buffer) =>
       generated.readPackageBundle(buffer);
 
@@ skipping 266 matching lines @@
  * Unlinked summary information about a class declaration.
  */
 abstract class UnlinkedClass extends base.SummaryClass {
   /**
    * Annotations for this class.
    */
   @Id(5)
   List<UnlinkedConst> get annotations;
 
   /**
+   * Length of the class code.
+   */
+  @Id(15)
+  int get codeLength;

[Paul Berry, 2016/03/04 16:36:07]

Instead of adding these three getters to all these classes, I'd prefer if we
added a CodeRange class, e.g.:

abstract class CodeRange extends base.SummaryClass {
  @Id(1)
  int get length;
  @Id(0)
  int get offset;
}

abstract class UnlinkedClass extends base.SummaryClass {
  ...
  Id(13)
  CodeRange get codeRange;
}

This would let us eliminate the `hasCodeRange` bool (since the absence of a code
range would be represented by setting `codeRange` to `null`).  It would also
have the advantage of letting us get rid of all the `is` checks in
`buildCodeRange` and `serializeCodeRange` (they would be more like
`buildDocumentation` and `serializeDocumentation`).

[scheglov, 2016/03/04 17:15:19]

Good idea.
Thank you.

+
+  /**
+   * Offset of the class code relative to the beginning of the file.
+   */
+  @Id(14)
+  int get codeOffset;
+
+  /**
    * Documentation comment for the class, or `null` if there is no
    * documentation comment.
    */
   @informative
   @Id(6)
   UnlinkedDocumentationComment get documentationComment;
 
   /**
    * Executable objects (methods, getters, and setters) contained in the class.
    */
   @Id(2)
   List<UnlinkedExecutable> get executables;
 
   /**
    * Field declarations contained in the class.
    */
   @Id(4)
   List<UnlinkedVariable> get fields;
 
   /**
+   * Indicates whether the class has the code range.
+   */
+  @Id(13)
+  bool get hasCodeRange;
+
+  /**
    * Indicates whether this class is the core "Object" class (and hence has no
    * supertype)
    */
   @Id(12)
   bool get hasNoSupertype;
 
   /**
    * Interfaces appearing in an `implements` clause, if any.
    */
   @Id(7)
@@ skipping 510 matching lines @@
  * Unlinked summary information about an enum declaration.
  */
 abstract class UnlinkedEnum extends base.SummaryClass {
   /**
    * Annotations for this enum.
    */
   @Id(4)
   List<UnlinkedConst> get annotations;
 
   /**
+   * Length of the enum code.
+   */
+  @Id(7)
+  int get codeLength;
+
+  /**
+   * Offset of the enum code relative to the beginning of the file.
+   */
+  @Id(6)
+  int get codeOffset;
+
+  /**
    * Documentation comment for the enum, or `null` if there is no documentation
    * comment.
    */
   @informative
   @Id(3)
   UnlinkedDocumentationComment get documentationComment;
 
   /**
+   * Indicates whether the enum has the code range.
+   */
+  @Id(5)
+  bool get hasCodeRange;
+
+  /**
    * Name of the enum type.
    */
   @Id(0)
   String get name;
 
   /**
    * Offset of the enum name relative to the beginning of the file.
    */
   @informative
   @Id(1)
@@ skipping 38 matching lines @@
  * declaration.
  */
 abstract class UnlinkedExecutable extends base.SummaryClass {
   /**
    * Annotations for this executable.
    */
   @Id(6)
   List<UnlinkedConst> get annotations;
 
   /**
+   * Length of the executable code.
+   */
+  @Id(28)
+  int get codeLength;
+
+  /**
+   * Offset of the executable code relative to the beginning of the file.
+   */
+  @Id(27)
+  int get codeOffset;
+
+  /**
    * If a constant [UnlinkedExecutableKind.constructor], the constructor
    * initializers.  Otherwise empty.
    */
   @Id(14)
   List<UnlinkedConstructorInitializer> get constantInitializers;
 
   /**
+   * If [kind] is [UnlinkedExecutableKind.constructor] and [isConst] is `true`,
+   * a nonzero slot id which is unique within this compilation unit.  If this id
+   * is found in [LinkedUnit.constCycles], then this constructor is part of a
+   * cycle.
+   *
+   * Otherwise, zero.
+   */
+  @Id(25)
+  int get constCycleSlot;
+
+  /**
    * Documentation comment for the executable, or `null` if there is no
    * documentation comment.
    */
   @informative
   @Id(7)
   UnlinkedDocumentationComment get documentationComment;
 
   /**
+   * Indicates whether the executable has the code range.
+   */
+  @Id(26)
+  bool get hasCodeRange;
+
+  /**
    * If this executable's return type is inferable, nonzero slot id
    * identifying which entry in [LinkedUnit.types] contains the inferred
    * return type.  If there is no matching entry in [LinkedUnit.types], then
    * no return type was inferred for this variable, so its static type is
    * `dynamic`.
    */
   @Id(5)
   int get inferredReturnTypeSlot;
 
   /**
@@ skipping 139 matching lines @@
    * If a local function, the length of the visible range; zero otherwise.
    */
   @Id(20)
   int get visibleLength;
 
   /**
    * If a local function, the beginning of the visible range; zero otherwise.
    */
   @Id(21)
   int get visibleOffset;
-
-  /**
-   * If [kind] is [UnlinkedExecutableKind.constructor] and [isConst] is `true`,
-   * a nonzero slot id which is unique within this compilation unit.  If this id
-   * is found in [LinkedUnit.constCycles], then this constructor is part of a
-   * cycle.
-   *
-   * Otherwise, zero.
-   */
-  @Id(25)
-  int get constCycleSlot;
 }
 
 /**
  * Enum used to indicate the kind of an executable.
  */
 enum UnlinkedExecutableKind {
   /**
    * Executable is a function or method.
    */
   functionOrMethod,
@@ skipping 178 matching lines @@
  * Unlinked summary information about a function parameter.
  */
 abstract class UnlinkedParam extends base.SummaryClass {
   /**
    * Annotations for this parameter.
    */
   @Id(9)
   List<UnlinkedConst> get annotations;
 
   /**
+   * Length of the parameter code.
+   */
+  @Id(16)
+  int get codeLength;
+
+  /**
+   * Offset of the parameter code relative to the beginning of the file.
+   */
+  @Id(15)
+  int get codeOffset;
+
+  /**
    * If the parameter has a default value, the constant expression in the
    * default value.  Note that the presence of this expression does not mean
    * that it is a valid, check [UnlinkedConst.isInvalid].
    */
   @Id(7)
   UnlinkedConst get defaultValue;
 
   /**
    * If the parameter has a default value, the source text of the constant
    * expression in the default value.  Otherwise the empty string.
    */
   @informative
   @Id(13)
   String get defaultValueCode;
 
   /**
+   * Indicates whether the parameter has the code range.
+   */
+  @Id(14)
+  bool get hasCodeRange;
+
+  /**
    * If this parameter's type is inferable, nonzero slot id identifying which
    * entry in [LinkedLibrary.types] contains the inferred type.  If there is no
    * matching entry in [LinkedLibrary.types], then no type was inferred for
    * this variable, so its static type is `dynamic`.
    *
    * Note that although strong mode considers initializing formals to be
    * inferable, they are not marked as such in the summary; if their type is
    * not specified, they always inherit the static type of the corresponding
    * field.
    */
@@ skipping 214 matching lines @@
  * Unlinked summary information about a typedef declaration.
  */
 abstract class UnlinkedTypedef extends base.SummaryClass {
   /**
    * Annotations for this typedef.
    */
   @Id(4)
   List<UnlinkedConst> get annotations;
 
   /**
+   * Length of the typedef code.
+   */
+  @Id(9)
+  int get codeLength;
+
+  /**
+   * Offset of the typedef code relative to the beginning of the file.
+   */
+  @Id(8)
+  int get codeOffset;
+
+  /**
    * Documentation comment for the typedef, or `null` if there is no
    * documentation comment.
    */
   @informative
   @Id(6)
   UnlinkedDocumentationComment get documentationComment;
 
   /**
+   * Indicates whether the typedef has the code range.
+   */
+  @Id(7)
+  bool get hasCodeRange;
+
+  /**
    * Name of the typedef.
    */
   @Id(0)
   String get name;
 
   /**
    * Offset of the typedef name relative to the beginning of the file.
    */
   @informative
   @Id(1)
@@ skipping 29 matching lines @@
   List<UnlinkedConst> get annotations;
 
   /**
    * Bound of the type parameter, if a bound is explicitly declared.  Otherwise
    * null.
    */
   @Id(2)
   EntityRef get bound;
 
   /**
+   * Length of the type parameter code.
+   */
+  @Id(6)
+  int get codeLength;
+
+  /**
+   * Offset of the type parameter code relative to the beginning of the file.
+   */
+  @Id(5)
+  int get codeOffset;
+
+  /**
+   * Indicates whether the parameter has the code range.
+   */
+  @Id(4)
+  bool get hasCodeRange;
+
+  /**
    * Name of the type parameter.
    */
   @Id(0)
   String get name;
 
   /**
    * Offset of the type parameter name relative to the beginning of the file.
    */
   @informative
   @Id(1)
   int get nameOffset;
 }
 
 /**
  * Unlinked summary information about a compilation unit ("part file").
  */
 @TopLevel('UUnt')
 abstract class UnlinkedUnit extends base.SummaryClass {
   factory UnlinkedUnit.fromBuffer(List<int> buffer) =>
       generated.readUnlinkedUnit(buffer);
 
   /**
    * Classes declared in the compilation unit.
    */
   @Id(2)
   List<UnlinkedClass> get classes;
 
   /**
+   * Length of the unit code.
+   */
+  @Id(17)
+  int get codeLength;
+
+  /**
+   * Offset of the unit code relative to the beginning of the file.
+   */
+  @Id(16)
+  int get codeOffset;
+
+  /**
    * Enums declared in the compilation unit.
    */
   @Id(12)
   List<UnlinkedEnum> get enums;
 
   /**
    * Top level executable objects (functions, getters, and setters) declared in
    * the compilation unit.
    */
   @Id(4)
   List<UnlinkedExecutable> get executables;
 
   /**
    * Export declarations in the compilation unit.
    */
   @Id(13)
   List<UnlinkedExportNonPublic> get exports;
 
   /**
+   * Indicates whether the unit has the code range.
+   */
+  @Id(15)
+  bool get hasCodeRange;
+
+  /**
    * Import declarations in the compilation unit.
    */
   @Id(5)
   List<UnlinkedImport> get imports;
 
   /**
    * Annotations for the library declaration, or the empty list if there is no
    * library declaration.
    */
   @Id(14)
@@ skipping 69 matching lines @@
  * a field.
  */
 abstract class UnlinkedVariable extends base.SummaryClass {
   /**
    * Annotations for this variable.
    */
   @Id(8)
   List<UnlinkedConst> get annotations;
 
   /**
+   * Length of the variable code.
+   */
+  @Id(16)
+  int get codeLength;
+
+  /**
+   * Offset of the variable code relative to the beginning of the file.
+   */
+  @Id(15)
+  int get codeOffset;
+
+  /**
    * If [isConst] is true, and the variable has an initializer, the constant
    * expression in the initializer.  Note that the presence of this expression
    * does not mean that it is a valid, check [UnlinkedConst.isInvalid].
    */
   @Id(5)
   UnlinkedConst get constExpr;
 
   /**
    * Documentation comment for the variable, or `null` if there is no
    * documentation comment.
    */
   @informative
   @Id(10)
   UnlinkedDocumentationComment get documentationComment;
 
   /**
+   * Indicates whether the variable has the code range.
+   */
+  @Id(14)
+  bool get hasCodeRange;
+
+  /**
    * If this variable is inferable, nonzero slot id identifying which entry in
    * [LinkedLibrary.types] contains the inferred type for this variable.  If
    * there is no matching entry in [LinkedLibrary.types], then no type was
    * inferred for this variable, so its static type is `dynamic`.
    */
   @Id(9)
   int get inferredTypeSlot;
 
   /**
    * The synthetic initializer function of the variable.  Absent if the variable
@@ skipping 59 matching lines @@
    */
   @Id(11)
   int get visibleLength;
 
   /**
    * If a local variable, the beginning of the visible range; zero otherwise.
    */
   @Id(12)
   int get visibleOffset;
 }