Generate getters and setters dynamically.

lib/compiler/implementation/emitter.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.
 
 /**
  * A function element that represents a closure call. The signature is copied
  * from the given element.
  */
 class ClosureInvocationElement extends FunctionElement {
   ClosureInvocationElement(SourceString name,
@@ skipping 34 matching lines @@
       => '${namer.ISOLATE}.\$defineClass';
   String get finishClassesName()
       => '${namer.ISOLATE}.\$finishClasses';
   String get finishIsolateConstructorName()
       => '${namer.ISOLATE}.\$finishIsolateConstructor';
   String get pendingClassesName()
       => '${namer.ISOLATE}.\$pendingClasses';
   String get isolatePropertiesName()
       => '${namer.ISOLATE}.${namer.ISOLATE_PROPERTIES}';
 
+  final String GETTER_SUFFIX = "?";
+  final String SETTER_SUFFIX = "!";
+  final String GETTER_SETTER_SUFFIX = "=";
+
   String get defineClassFunction() {
     // First the class name, then the super class name, followed by the fields
     // (in an array) and the members (inside an Object literal).
     // The caller can also pass in the constructor as a function if needed.
     //
     // Example:
     // defineClass("A", "B", ["x", "y"], {
     //  foo$1: function(y) {
     //   print(this.x + y);
     //  },
     //  bar$2: function(t, v) {
     //   this.x = t - v;
     //  },
     // });
     return """
 function(cls, superclass, fields, prototype) {
   var constructor;
   if (typeof fields == 'function') {
     constructor = fields;
   } else {
     var str = "(function " + cls + "(";
     var body = "";
     for (var i = 0; i < fields.length; i++) {
       if (i != 0) str += ", ";
-      str += fields[i];
-      body += "this." + fields[i] + " = " + fields[i] + ";\\n";
+      var field = fields[i];
+      var len = field.length;
+      var lastChar = field[len - 1];
+      var needsGetter = false;
+      var needsSetter = false;
+      switch (lastChar) {
+      case '$GETTER_SUFFIX': needsGetter = true; break;

[kasperl, 2012/05/09 14:07:49]

Indent cases.

[floitsch, 2012/05/09 14:11:19]

Done.

+      case '$GETTER_SETTER_SUFFIX': needsGetter = true; // fallthrough.

[kasperl, 2012/05/09 14:07:49]

fallthrough -> Fall-through

[floitsch, 2012/05/09 14:11:19]

Done.

+      case '$SETTER_SUFFIX': needsSetter = true;
+      }
+      if (needsGetter || needsSetter) field = field.substring(0, len - 1);
+      str += field;
+      body += "this." + field + " = " + field + ";\\n";
+      if (needsGetter) {
+        var getterString = "return this." + field + ";";
+        prototype["get\$" + field] = new Function(getterString);
+      }
+      if (needsSetter) {
+        var setterString = "this." + field + " = v;";
+        prototype["set\$" + field] = new Function("v", setterString);
+      }
     }
     str += ") {" + body + "})";
     constructor = eval(str);
   }
   $isolatePropertiesName[cls] = constructor;
   constructor.prototype = prototype;
   if (superclass !== "") {
     $pendingClassesName[cls] = superclass;
   }
 }""";
@@ skipping 228 matching lines @@
                          void defineInstanceMember(String invocationName,
                                                    String definition)) {
     Set<Selector> selectors = compiler.universe.invokedNames[member.name];
     if (selectors == null) return;
     for (Selector selector in selectors) {
       if (!selector.applies(member, compiler)) continue;
       addParameterStub(member, selector, defineInstanceMember);
     }
   }
 
+  bool instanceFieldNeedsGetter(Element member) {
+    assert(member.kind === ElementKind.FIELD);
+    return compiler.universe.hasGetter(member, compiler);
+  }
+
+  bool instanceFieldNeedsSetter(Element member) {
+    assert(member.kind === ElementKind.FIELD);
+    return (member.modifiers === null || !member.modifiers.isFinal())
+        && compiler.universe.hasSetter(member, compiler);
+  }
+
+  String compiledFieldName(Element member) {
+    assert(member.kind === ElementKind.FIELD);
+    return member.isNative()
+        ? member.name.slowToString()
+        : namer.getName(member);
+  }
+
   void addInstanceMember(Element member,
+                         bool needGettersAndSetters,
                          void defineInstanceMember(String invocationName,
                                                    String definition)) {
     // TODO(floitsch): we don't need to deal with members of
     // uninstantiated classes, that have been overwritten by subclasses.
 
     if (member.kind === ElementKind.FUNCTION
         || member.kind === ElementKind.GENERATIVE_CONSTRUCTOR_BODY
         || member.kind === ElementKind.GETTER
         || member.kind === ElementKind.SETTER) {
       if (member.modifiers !== null && member.modifiers.isAbstract()) return;
       String codeBlock = compiler.universe.generatedCode[member];
       if (codeBlock == null) return;
       defineInstanceMember(namer.getName(member), codeBlock);
       codeBlock = compiler.universe.generatedBailoutCode[member];
       if (codeBlock !== null) {
         defineInstanceMember(compiler.namer.getBailoutName(member), codeBlock);
       }
       FunctionElement function = member;
       FunctionSignature parameters = function.computeSignature(compiler);
       if (!parameters.optionalParameters.isEmpty()) {
         addParameterStubs(member, defineInstanceMember);
       }
     } else if (member.kind === ElementKind.FIELD) {
-      // TODO(ngeoffray): Have another class generate the code for the
-      // fields.
-      if ((member.modifiers === null || !member.modifiers.isFinal()) &&
-          compiler.universe.hasSetter(member, compiler)) {
-        String setterName = namer.setterName(member.getLibrary(), member.name);
-        String name = member.isNative()
-            ? member.name.slowToString()
-            : namer.getName(member);
-        defineInstanceMember(setterName, "function(v) { this.$name = v; }");
-      }
-      if (compiler.universe.hasGetter(member, compiler)) {
-        String getterName = namer.getterName(member.getLibrary(), member.name);
-        String name = member.isNative()
-            ? member.name.slowToString()
-            : namer.getName(member);
-        defineInstanceMember(getterName, "function() { return this.$name; }");
+      // Getters and setters for non native members are generated dynamically.

[kasperl, 2012/05/09 14:07:49]

non-native

[floitsch, 2012/05/09 14:11:19]

forgot to upload latest cosmetic changes patchset.
This line is gone. (The bool has a sufficiently explanatory name).

+      if (needGettersAndSetters) {
+        if (instanceFieldNeedsGetter(member)) {
+          String getter = namer.getterName(member.getLibrary(), member.name);
+          String name = compiledFieldName(member);
+          defineInstanceMember(getter, "function() { return this.$name; }");
+        }
+
+        if (instanceFieldNeedsSetter(member)) {
+          String setter = namer.setterName(member.getLibrary(), member.name);
+          String name = compiledFieldName(member);
+          defineInstanceMember(setter, "function(v) { this.$name = v; }");
+        }
       }
     } else {
       compiler.internalError('unexpected kind: "${member.kind}"',
                              element: member);
     }
     emitExtraAccessors(member, defineInstanceMember);
   }
 
-  List<String> generateFieldList(ClassElement classElement) {
-    List<String> result = <String>[];
+  Set<Element> emitClassFields(ClassElement classElement, StringBuffer buffer) {
+    // If the class is never instantiated we still need to set it up for
+    // inheritance purposes, but we can simplify its JavaScript constructor.
+    bool isInstantiated =
+        compiler.universe.instantiatedClasses.contains(classElement);
+
+    bool isFirstField = true;
     void addField(ClassElement enclosingClass, Element member) {
-      result.add(namer.instanceFieldName(member.getLibrary(), member.name));
+      assert(!member.isNative());
+      LibraryElement library = member.getLibrary();
+      SourceString name = member.name;
+      String fieldName = namer.instanceFieldName(library, name);
+      // See if we can dynamically create getters and setters.
+      // We can only generate getters and setters for [classElement] since
+      // the fields of super classes could be overwritten with getters or
+      // setters.
+      bool needsDynamicGetter = false;
+      bool needsDynamicSetter = false;
+      if (enclosingClass === classElement) {
+        needsDynamicGetter = instanceFieldNeedsGetter(member);
+        needsDynamicSetter = instanceFieldNeedsSetter(member);
+      }
+
+      if (isInstantiated || needsDynamicGetter || needsDynamicSetter) {
+        if (isFirstField) {
+          isFirstField = false;
+        } else {
+          buffer.add(", ");
+        }
+        // Getters and setters with suffixes will be generated dynamically.
+        buffer.add('"$fieldName');
+        if (needsDynamicGetter || needsDynamicSetter) {
+          if (needsDynamicGetter && needsDynamicSetter) {
+            buffer.add(GETTER_SETTER_SUFFIX);
+          } else if (needsDynamicGetter) {
+            buffer.add(GETTER_SUFFIX);
+          } else {
+            buffer.add(SETTER_SUFFIX);
+          }
+        }
+        buffer.add('"');
+      }
     }
 
+    // If a class is not instantiated then we add the field just so we can
+    // generate the field getter/setter dynamically. Since this is only
+    // allowed on fields that are in [classElement] we don't need to visit
+    // superclasses for non-instantiated classes.
     classElement.forEachInstanceField(addField,
                                       includeBackendMembers: true,
-                                      includeSuperMembers: true);
-    return result;
+                                      includeSuperMembers: isInstantiated);
   }
 
-  void generateClass(ClassElement classElement, StringBuffer buffer) {
-    needsDefineClass = true;
-
-    if (classElement.isNative()) {
-      nativeEmitter.generateNativeClass(classElement);
-      return;
-    } else {
-      // TODO(ngeoffray): Instead of switching between buffer, we
-      // should create code sections, and decide where to emit them at
-      // the end.
-      buffer = mainBuffer;
-    }
-
-    String className = namer.getName(classElement);
-    ClassElement superclass = classElement.superclass;
-    String superName = "";
-    if (superclass !== null) {
-      superName = namer.getName(superclass);
-    }
-    String constructorName = namer.safeName(classElement.name.slowToString());
-    buffer.add('$defineClassName("$className", "$superName", ');
-    // If the class is never instantiated we still need to set it up for
-    // inheritance purposes, but we can simplify its JavaScript constructor.
-    if (!compiler.universe.instantiatedClasses.contains(classElement)) {
-      buffer.add("[]");
-    } else {
-      List<String> fields = generateFieldList(classElement);
-      buffer.add('[');
-      for (int i = 0; i < fields.length; i++) {
-        if (i != 0) buffer.add(", ");
-        buffer.add('"${fields[i]}"');
-      }
-      buffer.add(']');
-    }
-    buffer.add(', {\n');
-
+  void emitInstanceMembers(ClassElement classElement, StringBuffer buffer) {
     void defineInstanceMember(String name, String value) {
       buffer.add(' $name: $value,\n');
     }
 
     classElement.forEachMember(includeBackendMembers: true,
                                f: (ClassElement enclosing, Element member) {
       if (member.isInstanceMember()) {
-        addInstanceMember(member, defineInstanceMember);
+        // All getters and setters for non-native classes are generated
+        // dynamically.
+        bool needGettersAndSetters = false;
+        addInstanceMember(member, needGettersAndSetters, defineInstanceMember);
       }
     });
 
     generateTypeTests(classElement, (Element other) {
       if (nativeEmitter.requiresNativeIsCheck(other)) {
         defineInstanceMember(namer.operatorIs(other),
                              'function() { return true; }');
       } else {
         defineInstanceMember(namer.operatorIs(other), 'true');
       }
     });
 
     if (classElement === compiler.objectClass && compiler.enabledNoSuchMethod) {
       // Emit the noSuchMethods on the Object prototype now, so that
       // the code in the dynamicMethod can find them. Note that the
       // code in dynamicMethod is invoked before analyzing the full JS
       // script.
       emitNoSuchMethodCalls(defineInstanceMember);
     }
+  }
+
+  void generateClass(ClassElement classElement, StringBuffer buffer) {
+    needsDefineClass = true;
+
+    if (classElement.isNative()) {
+      nativeEmitter.generateNativeClass(classElement);
+      return;
+    } else {
+      // TODO(ngeoffray): Instead of switching between buffer, we
+      // should create code sections, and decide where to emit them at
+      // the end.
+      buffer = mainBuffer;
+    }
+
+    String className = namer.getName(classElement);
+    ClassElement superclass = classElement.superclass;
+    String superName = "";
+    if (superclass !== null) {
+      superName = namer.getName(superclass);
+    }
+    String constructorName = namer.safeName(classElement.name.slowToString());
+
+    buffer.add('$defineClassName("$className", "$superName", [');
+    emitClassFields(classElement, buffer);
+    buffer.add('], {\n');
+    emitInstanceMembers(classElement, buffer);
     buffer.add('});\n\n');
   }
 
   void generateTypeTests(ClassElement cls,
                          void generateTypeTest(ClassElement element)) {
     if (compiler.universe.isChecks.contains(cls)) {
       generateTypeTest(cls);
     }
     generateInterfacesIsTests(cls, generateTypeTest, new Set<Element>());
   }
@@ skipping 444 matching lines @@
       mainBuffer.add('function init() {\n');
       mainBuffer.add('  $isolateProperties = {};\n');
       addDefineClassAndFinishClassFunctionsIfNecessary(mainBuffer);
       emitFinishIsolateConstructor(mainBuffer);
       mainBuffer.add('}\n');
       compiler.assembledCode = mainBuffer.toString();
     });
     return compiler.assembledCode;
   }
 }