Update dart:mirrors to use Symbol.

dart/runtime/lib/mirrors_impl.dart

 // Copyright (c) 2012, 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.
 
 // VM-specific implementation of the dart:mirrors library.
 
 // These values are allowed to be passed directly over the wire.
 bool _isSimpleValue(var value) {
   return (value == null || value is num || value is String || value is bool);
 }
 
 Map _filterMap(Map old_map, bool filter(key, value)) {
   Map new_map = new Map();
   old_map.forEach((key, value) {
       if (filter(key, value)) {
         new_map[key] = value;
       }
     });
   return new_map;
 }
 
+// DO NOT SUBMIT: Find better solution for dealing with privacy.
+class _PrivateSymbol implements Symbol {

[ahe, 2013/04/11 20:12:27]

This part is work in progress.  My intention is to eliminate this class before I
submit.

+  final String _name;
+
+  const _PrivateSymbol(this._name);
+
+  bool operator ==(other) {
+    return other is _PrivateSymbol && _name == other._name;
+  }
+
+  int get hashCode {
+    const arbitraryPrime = 664597;
+    return 0x1fffffff & (arbitraryPrime * _name.hashCode);
+  }
+}
+
+String _n(Symbol symbol) {

[ahe, 2013/04/11 20:12:27]

I should probably find a better name for this method.

+  if (symbol is _PrivateSymbol) {
+    return symbol._name;
+  } else {
+    return Symbol.getName(symbol);
+  }
+}
+
+Symbol _s(String name) {
+  if (name == null) return null;
+  if (name.startsWith('_')) return new _PrivateSymbol(name);
+  return new Symbol((name == '<TODO:unnamed>') ? '' : name);

[ahe, 2013/04/11 20:12:27]

I need to be able to turn validation of Symbols of for the mirror API.  I think
this is also needed to implement Invocation (nee InvocationMirror) correctly.

The trouble is that I need a way to access something private from both dart:core
and dart:mirrors.  I think I may be able to use _LocalObjectMirrorImpl._invoke
do so.  Stay tuned.

+}
+
+Symbol _computeQualifiedName(DeclarationMirror owner, Symbol simpleName) {
+  if (owner == null) return simpleName;
+  return _s('${_n(owner.qualifiedName)}.${_n(simpleName)}');
+}
+
+Map<Symbol, dynamic> _convertStringToSymbolMap(Map<String, dynamic> map) {
+  if (map == null) return null;
+  Map<Symbol, dynamic> result = new Map<Symbol, dynamic>();
+  map.forEach((name, value) => result[_s(name)] = value);
+  return result;
+}
+
 String _makeSignatureString(TypeMirror returnType,
                             List<ParameterMirror> parameters) {
   StringBuffer buf = new StringBuffer();
-  buf.write(returnType.qualifiedName);
+  buf.write(_n(returnType.qualifiedName));
   buf.write(' (');
   bool found_optional_param = false;
   for (int i = 0; i < parameters.length; i++) {
     var param = parameters[i];
     if (param.isOptional && !found_optional_param) {
       buf.write('[');
       found_optional_param = true;
     }
-    buf.write(param.type.qualifiedName);
+    buf.write(_n(param.type.qualifiedName));
     if (i < (parameters.length - 1)) {
       buf.write(', ');
     }
   }
   if (found_optional_param) {
     buf.write(']');
   }
   buf.write(')');
   return buf.toString();
 }
 
 class _LocalMirrorSystemImpl implements MirrorSystem {
-  _LocalMirrorSystemImpl(this.libraries, this.isolate)
-      : _functionTypes = new Map<String, FunctionTypeMirror>() {}
+  // TODO(ahe): [libraries] should be Map<Uri, LibraryMirror>.
+  // Change parameter back to "this.libraries" when native code is changed.
+  _LocalMirrorSystemImpl(Map<String, LibraryMirror> libraries, this.isolate)
+    : _functionTypes = new Map<String, FunctionTypeMirror>(),
+      this.libraries = _convertStringToSymbolMap(libraries);
 
-  final Map<String, LibraryMirror> libraries;
+  final Map<Symbol, LibraryMirror> libraries;
   final IsolateMirror isolate;
 
   TypeMirror _dynamicType = null;
 
   TypeMirror get dynamicType {
     if (_dynamicType == null) {
       _dynamicType =
           new _LocalClassMirrorImpl(
               null, 'dynamic', false, null, null, [], null,
               const {}, const {}, const {});
@@ skipping 71 matching lines @@
   // For now, all VMObjects hold a VMReference.  We could consider
   // storing the Object reference itself here if the object is a Dart
   // language objects (except for objects of type VMReference, of
   // course).
   VMReference _reference;
 }
 
 abstract class _LocalObjectMirrorImpl extends _LocalVMObjectMirrorImpl
     implements ObjectMirror {
   _LocalObjectMirrorImpl(ref) : super(ref) {}
-  
-Future<InstanceMirror> invokeAsync(String memberName,
-                                   List positionalArguments,
-                                   [Map<String,dynamic> namedArguments]) {
+
+  Future<InstanceMirror> invokeAsync(Symbol memberName,
+                                     List positionalArguments,
+                                     [Map<Symbol, dynamic> namedArguments]) {
     if (namedArguments != null) {
       throw new UnimplementedError(
           'named argument support is not implemented');
     }
     // Walk the arguments and make sure they are legal.
     for (int i = 0; i < positionalArguments.length; i++) {
       var arg = positionalArguments[i];
       _validateArgument(i, arg);
     }
     Completer<InstanceMirror> completer = new Completer<InstanceMirror>();
     try {
       completer.complete(
           _invoke(this, memberName, positionalArguments));
     } catch (exception, s) {
       completer.completeError(exception, s);
     }
     return completer.future;
   }
 
-  Future<InstanceMirror> getFieldAsync(String fieldName) {
+  Future<InstanceMirror> getFieldAsync(Symbol fieldName) {
     Completer<InstanceMirror> completer = new Completer<InstanceMirror>();
     try {
-      completer.complete(_getField(this, fieldName));
+      completer.complete(_getField(this, _n(fieldName)));
     } catch (exception, s) {
       completer.completeError(exception, s);
     }
     return completer.future;
   }
 
-  Future<InstanceMirror> setFieldAsync(String fieldName, Object arg) {
+  Future<InstanceMirror> setFieldAsync(Symbol fieldName, Object arg) {
     _validateArgument(0, arg);
 
     Completer<InstanceMirror> completer = new Completer<InstanceMirror>();
     try {
-      completer.complete(_setField(this, fieldName, arg));
+      completer.complete(_setField(this, _n(fieldName), arg));
     } catch (exception, s) {
       completer.completeError(exception, s);
     }
     return completer.future;
   }
 
   static _validateArgument(int i, Object arg)
   {
     if (arg is Mirror) {
         if (arg is! InstanceMirror) {
@@ skipping 106 matching lines @@
                           this.function) : super(ref, type, reflectee) {}
 
   final MethodMirror function;
 
   String get source {
     throw new UnimplementedError(
         'ClosureMirror.source is not implemented');
   }
 
   Future<InstanceMirror> applyAsync(List<Object> positionalArguments,
-                                    [Map<String,Object> namedArguments]) {
+                                    [Map<Symbol, Object> namedArguments]) {
     if (namedArguments != null) {
       throw new UnimplementedError(
           'named argument support is not implemented');
     }
     // Walk the arguments and make sure they are legal.
     for (int i = 0; i < positionalArguments.length; i++) {
       var arg = positionalArguments[i];
       _LocalObjectMirrorImpl._validateArgument(i, arg);
     }
     Completer<InstanceMirror> completer = new Completer<InstanceMirror>();
     try {
       completer.complete(
           _apply(this, positionalArguments));
     } catch (exception) {
       completer.completeError(exception);
     }
     return completer.future;
   }
 
-  Future<InstanceMirror> findInContext(String name) {
+  Future<InstanceMirror> findInContext(Symbol name) {
     throw new UnimplementedError(
         'ClosureMirror.findInContext() is not implemented');
   }
 
   static _apply(ref, positionalArguments)
       native 'LocalClosureMirrorImpl_apply';
 }
 
 class _LazyTypeMirror {
-  _LazyTypeMirror(this.libraryName, this.typeName) {}
+  _LazyTypeMirror(String libraryName, String typeName)
+    : this.libraryName = _s(libraryName),
+      this.typeName = _s(typeName);
 
   TypeMirror resolve(MirrorSystem mirrors) {
     if (libraryName == null) {
       if (typeName == 'dynamic') {
         return mirrors.dynamicType;
       } else if (typeName == 'void') {
         return mirrors.voidType;
       } else {
         throw new UnimplementedError(
             "Mirror for type '$typeName' is not implemented");
       }
     }
     var resolved = mirrors.libraries[libraryName].members[typeName];
     if (resolved == null) {
       throw new UnimplementedError(
           "Mirror for type '$typeName' is not implemented");
     }
     return resolved;
   }
 
-  final String libraryName;
-  final String typeName;
+  final Symbol libraryName;
+  final Symbol typeName;
 }
 
 class _LocalClassMirrorImpl extends _LocalObjectMirrorImpl
     implements ClassMirror {
   _LocalClassMirrorImpl(ref,
-                        this.simpleName,
+                        String simpleName,
                         this.isClass,
                         this._owner,
                         this._superclass,
                         this._superinterfaces,
                         this._defaultFactory,
-                        this.members,
-                        this.constructors,
-                        this.typeVariables) : super(ref) {}
+                        Map<String, Mirror> members,
+                        Map<String, Mirror> constructors,
+                        Map<String, Mirror> typeVariables)
+    : this.simpleName = _s(simpleName),
+      this.members = _convertStringToSymbolMap(members),
+      this.constructors = _convertStringToSymbolMap(constructors),
+      this.typeVariables = _convertStringToSymbolMap(typeVariables),
+      super(ref);
 
-  final String simpleName;
+  final Symbol simpleName;
 
-  String _qualifiedName = null;
-  String get qualifiedName {
-    if (_owner != null) {
-      if (_qualifiedName == null) {
-        _qualifiedName = '${owner.qualifiedName}.${simpleName}';
-      }
-    } else {
-      // The owner of a ClassMirror is null in certain odd cases, like
-      // 'void', 'dynamic' and function type mirrors.
-      _qualifiedName = simpleName;
+  Symbol _qualifiedName = null;
+  Symbol get qualifiedName {
+    if (_qualifiedName == null) {
+      _qualifiedName = _computeQualifiedName(owner, simpleName);
     }
     return _qualifiedName;
   }
 
   var _owner;
   DeclarationMirror get owner {
     if (_owner != null && _owner is! Mirror) {
       _owner = _owner.resolve(mirrors);
     }
     return _owner;
@@ skipping 32 matching lines @@
   }
 
   var _defaultFactory;
   ClassMirror get defaultFactory {
     if (_defaultFactory != null && _defaultFactory is! Mirror) {
       _defaultFactory = _defaultFactory.resolve(mirrors);
     }
     return _defaultFactory;
   }
 
-  final Map<String, Mirror> members;
+  final Map<Symbol, Mirror> members;
 
-  Map<String, MethodMirror> _methods = null;
-  Map<String, MethodMirror> _getters = null;
-  Map<String, MethodMirror> _setters = null;
-  Map<String, VariableMirror> _variables = null;
+  Map<Symbol, MethodMirror> _methods = null;
+  Map<Symbol, MethodMirror> _getters = null;
+  Map<Symbol, MethodMirror> _setters = null;
+  Map<Symbol, VariableMirror> _variables = null;
 
-  Map<String, MethodMirror> get methods {
+  Map<Symbol, MethodMirror> get methods {
     if (_methods == null) {
       _methods = _filterMap(
           members,
           (key, value) => (value is MethodMirror && value.isRegularMethod));
     }
     return _methods;
   }
 
-  Map<String, MethodMirror> get getters {
+  Map<Symbol, MethodMirror> get getters {
     if (_getters == null) {
       _getters = _filterMap(
           members,
           (key, value) => (value is MethodMirror && value.isGetter));
     }
     return _getters;
   }
 
-  Map<String, MethodMirror> get setters {
+  Map<Symbol, MethodMirror> get setters {
     if (_setters == null) {
       _setters = _filterMap(
           members,
           (key, value) => (value is MethodMirror && value.isSetter));
     }
     return _setters;
   }
 
-  Map<String, VariableMirror> get variables {
+  Map<Symbol, VariableMirror> get variables {
     if (_variables == null) {
       _variables = _filterMap(
           members,
           (key, value) => (value is VariableMirror));
     }
     return _variables;
   }
 
-  Map<String, MethodMirror> constructors;
-  Map<String, TypeVariableMirror> typeVariables;
+  Map<Symbol, MethodMirror> constructors;
+  Map<Symbol, TypeVariableMirror> typeVariables;
 
-  Map<String, TypeMirror> get typeArguments {
+  Map<Symbol, TypeMirror> get typeArguments {
     throw new UnimplementedError(
         'ClassMirror.typeArguments is not implemented');
   }
 
   bool get isOriginalDeclaration {
     throw new UnimplementedError(
         'ClassMirror.isOriginalDeclaration is not implemented');
   }
 
   ClassMirror get genericDeclaration {
     throw new UnimplementedError(
         'ClassMirror.originalDeclaration is not implemented');
   }
 
   String toString() => "ClassMirror on '$simpleName'";
 
-  Future<InstanceMirror> newInstanceAsync(String constructorName,
+  Future<InstanceMirror> newInstanceAsync(Symbol constructorName,
                                           List positionalArguments,
-                                          [Map<String,dynamic> namedArguments]) {
+                                          [Map<Symbol, dynamic> namedArguments]) {
     if (namedArguments != null) {
       throw new UnimplementedError(
           'named argument support is not implemented');
     }
     // Walk the arguments and make sure they are legal.
     for (int i = 0; i < positionalArguments.length; i++) {
       var arg = positionalArguments[i];
       _LocalObjectMirrorImpl._validateArgument(i, arg);
     }
     Completer<InstanceMirror> completer = new Completer<InstanceMirror>();
     try {
       completer.complete(
-          _invokeConstructor(this, constructorName, positionalArguments));
+          _invokeConstructor(this, _n(constructorName), positionalArguments));
     } catch (exception) {
       completer.completeError(exception);
     }
     return completer.future;
   }
 
   static _invokeConstructor(ref, constructorName, positionalArguments)
       native 'LocalClassMirrorImpl_invokeConstructor';
 }
 
@@ skipping 41 matching lines @@
 
 
 class _LazyTypeVariableMirror {
   _LazyTypeVariableMirror(this._variableName, this._owner) {}
 
   TypeVariableMirror resolve(MirrorSystem mirrors) {
     ClassMirror owner = _owner.resolve(mirrors);
     return owner.typeVariables[_variableName];
   }
 
+  // TODO(ahe): Symbol?
   final String _variableName;
   final _LazyTypeMirror _owner;
 }
 
 class _LocalTypeVariableMirrorImpl extends _LocalMirrorImpl
     implements TypeVariableMirror {
-  _LocalTypeVariableMirrorImpl(this.simpleName,
+  _LocalTypeVariableMirrorImpl(String simpleName,
                                this._owner,
-                               this._upperBound) {}
-  final String simpleName;
+                               this._upperBound)
+    : this.simpleName = _s(simpleName);
 
-  String _qualifiedName = null;
-  String get qualifiedName {
+  final Symbol simpleName;
+
+  Symbol _qualifiedName = null;
+  Symbol get qualifiedName {
     if (_qualifiedName == null) {
-      _qualifiedName = '${owner.qualifiedName}.${simpleName}';
+      _qualifiedName = _computeQualifiedName(owner, simpleName);
     }
     return _qualifiedName;
   }
 
   var _owner;
   DeclarationMirror get owner {
     if (_owner is! Mirror) {
       _owner = _owner.resolve(mirrors);
     }
     return _owner;
@@ skipping 15 matching lines @@
     }
     return _upperBound;
   }
 
   String toString() => "TypeVariableMirror on '$simpleName'";
 }
 
 
 class _LocalTypedefMirrorImpl extends _LocalMirrorImpl
     implements TypedefMirror {
-  _LocalTypedefMirrorImpl(this.simpleName,
+  _LocalTypedefMirrorImpl(String simpleName,
                           this._owner,
-                          this._referent) {}
-  final String simpleName;
+                          this._referent)
+    : this.simpleName = _s(simpleName);
 
-  String _qualifiedName = null;
-  String get qualifiedName {
+  final Symbol simpleName;
+
+  Symbol _qualifiedName = null;
+  Symbol get qualifiedName {
     if (_qualifiedName == null) {
-      _qualifiedName = '${owner.qualifiedName}.${simpleName}';
+      _qualifiedName = _computeQualifiedName(owner, simpleName);
     }
     return _qualifiedName;
   }
 
   var _owner;
   DeclarationMirror get owner {
     if (_owner is! Mirror) {
       _owner = _owner.resolve(mirrors);
     }
     return _owner;
@@ skipping 14 matching lines @@
       _referent = _referent.resolve(mirrors);
     }
     return _referent;
   }
 
   String toString() => "TypedefMirror on '$simpleName'";
 }
 
 
 class _LazyLibraryMirror {
-  _LazyLibraryMirror(this.libraryName) {}
+  _LazyLibraryMirror(String libraryName)
+    : this.libraryName = _s(libraryName);
 
   LibraryMirror resolve(MirrorSystem mirrors) {
     return mirrors.libraries[libraryName];
   }
 
-  final String libraryName;
+  final Symbol libraryName;
 }
 
 class _LocalLibraryMirrorImpl extends _LocalObjectMirrorImpl
     implements LibraryMirror {
   _LocalLibraryMirrorImpl(ref,
-                          this.simpleName,
+                          String simpleName,
                           this.url,
-                          this.members) : super(ref) {}
+                          Map<String, Mirror> members)
+    : this.simpleName = _s(simpleName),
+      this.members = _convertStringToSymbolMap(members),
+      super(ref);
 
-  final String simpleName;
+  final Symbol simpleName;
 
   // The simple name and the qualified name are the same for a library.
-  String get qualifiedName => simpleName;
+  Symbol get qualifiedName => simpleName;
 
   // Always null for libraries.
   final DeclarationMirror owner = null;
 
   // Always false for libraries.
   final bool isPrivate = false;
 
   // Always false for libraries.
   final bool isTopLevel = false;
 
   SourceLocation get location {
     throw new UnimplementedError(
         'LibraryMirror.location is not implemented');
   }
 
   final String url;
-  final Map<String, Mirror> members;
+  final Map<Symbol, Mirror> members;
 
-  Map<String, ClassMirror> _classes = null;
-  Map<String, MethodMirror> _functions = null;
-  Map<String, MethodMirror> _getters = null;
-  Map<String, MethodMirror> _setters = null;
-  Map<String, VariableMirror> _variables = null;
+  Map<Symbol, ClassMirror> _classes = null;
+  Map<Symbol, MethodMirror> _functions = null;
+  Map<Symbol, MethodMirror> _getters = null;
+  Map<Symbol, MethodMirror> _setters = null;
+  Map<Symbol, VariableMirror> _variables = null;
 
-  Map<String, ClassMirror> get classes {
+  Map<Symbol, ClassMirror> get classes {
     if (_classes == null) {
       _classes = _filterMap(members,
                             (key, value) => (value is ClassMirror));
     }
     return _classes;
   }
 
-  Map<String, MethodMirror> get functions {
+  Map<Symbol, MethodMirror> get functions {
     if (_functions == null) {
       _functions = _filterMap(members,
                               (key, value) => (value is MethodMirror));
     }
     return _functions;
   }
 
-  Map<String, MethodMirror> get getters {
+  Map<Symbol, MethodMirror> get getters {
     if (_getters == null) {
       _getters = _filterMap(functions,
                             (key, value) => (value.isGetter));
     }
     return _getters;
   }
 
-  Map<String, MethodMirror> get setters {
+  Map<Symbol, MethodMirror> get setters {
     if (_setters == null) {
       _setters = _filterMap(functions,
                             (key, value) => (value.isSetter));
     }
     return _setters;
   }
 
-  Map<String, VariableMirror> get variables {
+  Map<Symbol, VariableMirror> get variables {
     if (_variables == null) {
       _variables = _filterMap(members,
                               (key, value) => (value is VariableMirror));
     }
     return _variables;
   }
 
   String toString() => "LibraryMirror on '$simpleName'";
 }
 
 class _LocalMethodMirrorImpl extends _LocalMirrorImpl
     implements MethodMirror {
-  _LocalMethodMirrorImpl(this.simpleName,
+  _LocalMethodMirrorImpl(String simpleName,
                          this._owner,
                          this.parameters,
                          this._returnType,
                          this.isStatic,
                          this.isAbstract,
                          this.isGetter,
                          this.isSetter,
                          this.isConstructor,
                          this.isConstConstructor,
                          this.isGenerativeConstructor,
                          this.isRedirectingConstructor,
-                         this.isFactoryConstructor) {}
+                         this.isFactoryConstructor)
+    : this.simpleName = _s(simpleName);
 
-  final String simpleName;
+  final Symbol simpleName;
 
-  String _qualifiedName = null;
-  String get qualifiedName {
+  Symbol _qualifiedName = null;
+  Symbol get qualifiedName {
     if (_qualifiedName == null) {
-      _qualifiedName = '${owner.qualifiedName}.${simpleName}';
+      _qualifiedName = _computeQualifiedName(owner, simpleName);
     }
     return _qualifiedName;
   }
 
   var _owner;
   DeclarationMirror get owner {
     if (_owner is! Mirror) {
       _owner = _owner.resolve(mirrors);
     }
     return _owner;
@@ skipping 28 matching lines @@
   TypeMirror get isOperator {
     throw new UnimplementedError(
         'MethodMirror.isOperator is not implemented');
   }
 
   final bool isGetter;
   final bool isSetter;
   final bool isConstructor;
 
   var _constructorName = null;
-  String get constructorName {
+  Symbol get constructorName {
     if (_constructorName == null) {
       if (!isConstructor) {
         _constructorName = '';
       } else {
         var parts = simpleName.split('.');
         if (parts.length > 2) {
           throw new MirrorException(
               'Internal error in MethodMirror.constructorName: '
               'malformed name <$simpleName>');
         } else if (parts.length == 2) {
           _constructorName = parts[1];
         } else {
           _constructorName = '';
         }
       }
     }
     return _constructorName;
   }
 
   final bool isConstConstructor;
   final bool isGenerativeConstructor;
   final bool isRedirectingConstructor;
   final bool isFactoryConstructor;
 
   String toString() => "MethodMirror on '$simpleName'";
 }
 
 class _LocalVariableMirrorImpl extends _LocalMirrorImpl
     implements VariableMirror {
-  _LocalVariableMirrorImpl(this.simpleName,
+  _LocalVariableMirrorImpl(String simpleName,
                            this._owner,
                            this._type,
                            this.isStatic,
-                           this.isFinal) {}
+                           this.isFinal)
+    : this.simpleName = _s(simpleName);
 
-  final String simpleName;
+  final Symbol simpleName;
 
-  String _qualifiedName = null;
-  String get qualifiedName {
+  Symbol _qualifiedName = null;
+  Symbol get qualifiedName {
     if (_qualifiedName == null) {
-      _qualifiedName = '${owner.qualifiedName}.${simpleName}';
+      _qualifiedName = _computeQualifiedName(owner, simpleName);
     }
     return _qualifiedName;
   }
 
   var _owner;
   DeclarationMirror get owner {
     if (_owner is! Mirror) {
       _owner = _owner.resolve(mirrors);
     }
     return _owner;
@@ skipping 85 matching lines @@
 
   // Creates a new local mirror for some Object.
   static InstanceMirror reflect(Object reflectee) {
     return makeLocalInstanceMirror(reflectee);
   }
 
   static ClassMirror reflectClass(Type reflectee) {
     throw new UnimplementedError('reflectClass is not implemented');
   }
 }