Use file/offset/kind triplet as elements id.

pkg/analysis_server/lib/src/services/index/store/codec.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.
 
 library services.src.index.store.codec;
 
 import 'dart:collection';
 
 import 'package:analysis_server/src/services/index/index.dart';
-import 'package:analysis_server/src/services/index/store/collection.dart';
 import 'package:analyzer/src/generated/element.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/utilities_general.dart';
 
 /**
  * A helper that encodes/decodes [AnalysisContext]s from/to integers.
  */
 class ContextCodec {
   /**
@@ skipping 39 matching lines @@
     if (id != null) {
       _indexToContext.remove(id);
     }
   }
 }
 
 /**
  * A helper that encodes/decodes [Element]s to/from integers.
  */
 class ElementCodec {
+  static const int NAMED_FILE_ID = -1;
+  static const int NAMED_KIND_ID = -1;
+  static const int _CONSTRUCTOR_KIND_BASE = -100;
+
   final StringCodec _stringCodec;
 
-  /**
-   * A table mapping element encodings to a single integer.
-   */
-  final IntArrayToIntMap _pathToIndex = new IntArrayToIntMap();
-
-  /**
-   * A list that works as a mapping of integers to element encodings.
-   */
-  final List<List<int>> _indexToPath = <List<int>>[];
-
   ElementCodec(this._stringCodec);
 
   /**
-   * Returns an [Element] that corresponds to the given location.
-   *
-   * @param context the [AnalysisContext] to find [Element] in
-   * @param index an integer corresponding to the [Element]
-   * @return the [Element] or `null`
+   * Returns an [Element] that corresponds to the given identifiers.
    */
-  Element decode(AnalysisContext context, int index) {
-    List<int> path = _indexToPath[index];
-    List<String> components = _getLocationComponents(path);
-    ElementLocation location = new ElementLocationImpl.con3(components);
-    return context.getElement(location);
+  Element decode(AnalysisContext context, int fileId, int offset, int kindId) {
+    String filePath = _stringCodec.decode(fileId);
+    List<Source> unitSources = context.getSourcesWithFullName(filePath);
+    for (Source unitSource in unitSources) {
+      List<Source> libSources = context.getLibrariesContaining(unitSource);
+      for (Source libSource in libSources) {
+        LibraryElement libraryElement = context.getLibraryElement(libSource);

[Brian Wilkerson, 2015/04/09 14:06:25]

We need to handle the case where 'getLibraryElement' returns 'null'.

[scheglov, 2015/04/09 15:11:57]

Done.

+        if (kindId == ElementKind.LIBRARY.ordinal) {
+          return libraryElement;
+        } else if (kindId == ElementKind.COMPILATION_UNIT.ordinal) {
+          for (CompilationUnitElement unit in libraryElement.units) {
+            if (unit.source.fullName == filePath) {
+              return unit;
+            }
+          }
+          return null;
+        } else {
+          Element element = libraryElement.getElementAt(offset);
+          if (element == null) {
+            return null;
+          }
+          if (element is ClassElement && kindId <= _CONSTRUCTOR_KIND_BASE) {
+            int constructorIndex = -1 * (kindId - _CONSTRUCTOR_KIND_BASE);
+            return element.constructors[constructorIndex];
+          }
+          if (element is PropertyInducingElement) {
+            if (kindId == ElementKind.GETTER.ordinal) {
+              return element.getter;
+            }
+            if (kindId == ElementKind.SETTER.ordinal) {
+              return element.setter;
+            }
+          }
+          return element;
+        }
+      }
+    }
+    return null;
   }
 
   /**
-   * Returns a unique integer that corresponds to the given [Element].
-   *
-   * If [forKey] is `true` then [element] is a part of a key, so it should use
-   * file paths instead of [Element] location URIs.
+   * Returns the 1-st component of the [element] id.

[Brian Wilkerson, 2015/04/09 14:06:25]

"1-st" --> "first"

[scheglov, 2015/04/09 15:11:57]

Done.

    */
-  int encode(Element element, bool forKey) {
-    if (element is NameElement) {
-      String name = element.name;
-      int nameId = _stringCodec.encode(name);
-      return _encodePath(<int>[nameId]);
+  int encode1(Element element) {

[Brian Wilkerson, 2015/04/09 14:06:25]

Perhaps more meaningful names, such as "encodeFileName", "encodeOffset", and
"encodeKind" would be better.

[scheglov, 2015/04/09 15:11:57]

The names are intentionally opaque.
Also it's basically an unrolled array.
Clients don't need to know exact meaning of these ids.

[Brian Wilkerson, 2015/04/09 15:26:30]

I didn't suggest it for clients, I suggested it for developers/maintainers.
Integers just don't provide any semantic information when trying to understand
the code.

[scheglov, 2015/04/09 15:51:08]

I will add comments for these methods.

+    Source source = element.source;
+    if (source == null) {
+      return NAMED_FILE_ID;
     }
-    // check the location has a cached id
-    ElementLocationImpl location = element.location;
-    if (!identical(location.indexOwner, this)) {
-      location.indexKeyId = null;
-      location.indexLocationId = null;
-    }
-    if (forKey) {
-      int id = location.indexKeyId;
-      if (id != null) {
-        return id;
-      }
-    } else {
-      int id = location.indexLocationId;
-      if (id != null) {
-        return id;
-      }
-    }
-    // prepare an id
-    List<int> path = _getLocationPath(element, location, forKey);
-    int index = _encodePath(path);
-    // put the id into the location
-    if (forKey) {
-      location.indexOwner = this;
-      location.indexKeyId = index;
-    } else {
-      location.indexOwner = this;
-      location.indexLocationId = index;
-    }
-    // done
-    return index;
+    String filePath = source.fullName;
+    return _stringCodec.encode(filePath);
   }
 
   /**
+   * Returns the 2-nd component of the [element] id.

[Brian Wilkerson, 2015/04/09 14:06:25]

"2-nd" --> "second"

[scheglov, 2015/04/09 15:11:57]

Done.

+   */
+  int encode2(Element element) {
+    if (element is NameElement) {
+      String name = element.name;
+      return _stringCodec.encode(name);
+    }
+    if (element is ConstructorElement) {
+      return element.enclosingElement.nameOffset;
+    }
+    return element.nameOffset;
+  }
+
+  /**
+   * Returns the 3-rd component of the [element] id.

[Brian Wilkerson, 2015/04/09 14:06:25]

"3-rd" --> "third"

[scheglov, 2015/04/09 15:11:57]

Done.

+   */
+  int encode3(Element element) {
+    if (element is NameElement) {
+      return NAMED_KIND_ID;
+    }
+    if (element is ConstructorElement) {
+      ClassElement classElement = element.enclosingElement;
+      int constructorIndex = classElement.constructors.indexOf(element);
+      return _CONSTRUCTOR_KIND_BASE - constructorIndex;
+    }
+    return element.kind.ordinal;
+  }
+
+  /**
    * Returns an integer that corresponds to the name of [element].
    */
   int encodeHash(Element element) {
     String elementName = element.displayName;
     int elementNameId = _stringCodec.encode(elementName);
     LibraryElement libraryElement = element.library;
     if (libraryElement != null) {
       String libraryPath = libraryElement.source.fullName;
       int libraryPathId = _stringCodec.encode(libraryPath);
       return JenkinsSmiHash.combine(libraryPathId, elementNameId);
     } else {
       return elementNameId;
     }
   }
-
-  /**
-   * Returns a list with the location components of the element with the
-   * given encoded ID.
-   */
-  List<String> inspect_decodePath(int id) {
-    List<int> path = _indexToPath[id];
-    return _getLocationComponents(path);
-  }
-
-  /**
-   * Returns a map of element IDs to their locations for elements with
-   * the [requiredName].
-   */
-  Map<int, List<String>> inspect_getElements(String requiredName) {
-    Map<int, List<String>> result = <int, List<String>>{};
-    for (int i = 0; i < _indexToPath.length; i++) {
-      List<int> path = _indexToPath[i];
-      int nameIndex = path[path.length - 1];
-      if (nameIndex >= 0) {
-        String name = _stringCodec.decode(nameIndex);
-        if (name == requiredName) {
-          result[i] = path.map(_stringCodec.decode).toList();
-        }
-      }
-    }
-    return result;
-  }
-
-  int _encodePath(List<int> path) {
-    int index = _pathToIndex[path];
-    if (index == null) {
-      index = _indexToPath.length;
-      _pathToIndex[path] = index;
-      _indexToPath.add(path);
-    }
-    return index;
-  }
-
-  List<String> _getLocationComponents(List<int> path) {
-    int length = path.length;
-    List<String> components = new List<String>();
-    for (int i = 0; i < length; i++) {
-      int componentId = path[i];
-      String component = _stringCodec.decode(componentId);
-      if (i < length - 1 && path[i + 1] < 0) {
-        component += '@${(-path[i + 1])}';
-        i++;
-      }
-      components.add(component);
-    }
-    return components;
-  }
-
-  /**
-   * If [usePath] is `true` then [Source] path should be used instead of URI.
-   */
-  List<int> _getLocationPath(
-      Element element, ElementLocation location, bool usePath) {
-    // prepare the location components
-    List<String> components = location.components;
-    if (usePath) {
-      LibraryElement library = element.library;
-      if (library != null) {
-        components = components.toList();
-        components[0] = library.source.fullName;
-        for (Element e = element; e != null; e = e.enclosingElement) {
-          if (e is CompilationUnitElement) {
-            components[1] = e.source.fullName;
-            break;
-          }
-        }
-      }
-    }
-    // encode the location
-    int length = components.length;
-    if (_hasLocalOffset(components)) {
-      List<int> path = new List<int>();
-      for (String component in components) {
-        int atOffset = component.indexOf('@');
-        if (atOffset == -1) {
-          path.add(_stringCodec.encode(component));
-        } else {
-          String preAtString = component.substring(0, atOffset);
-          String atString = component.substring(atOffset + 1);
-          path.add(_stringCodec.encode(preAtString));
-          path.add(-1 * int.parse(atString));
-        }
-      }
-      return path;
-    } else {
-      List<int> path = new List<int>.filled(length, 0);
-      for (int i = 0; i < length; i++) {
-        String component = components[i];
-        path[i] = _stringCodec.encode(component);
-      }
-      return path;
-    }
-  }
-
-  static bool _hasLocalOffset(List<String> components) {
-    for (String component in components) {
-      if (component.indexOf('@') != -1) {
-        return true;
-      }
-    }
-    return false;
-  }
 }
 
 /**
  * A helper that encodes/decodes [Relationship]s to/from integers.
  */
 class RelationshipCodec {
   final StringCodec _stringCodec;
 
   RelationshipCodec(this._stringCodec);
 
@@ skipping 33 matching lines @@
   int encode(String name) {
     int index = nameToIndex[name];
     if (index == null) {
       index = _indexToName.length;
       nameToIndex[name] = index;
       _indexToName.add(name);
     }
     return index;
   }
 }