Support union return type for anonymous named/indexed getter

Source/bindings/scripts/CodeGeneratorV8.pm

 # Copyright (C) 2005, 2006 Nikolas Zimmermann <zimmermann@kde.org>
 # Copyright (C) 2006 Anders Carlsson <andersca@mac.com>
 # Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
 # Copyright (C) 2006 Alexey Proskuryakov <ap@webkit.org>
 # Copyright (C) 2006 Apple Computer, Inc.
 # Copyright (C) 2007, 2008, 2009, 2012 Google Inc.
 # Copyright (C) 2009 Cameron McCormack <cam@mcc.id.au>
 # Copyright (C) Research In Motion Limited 2010. All rights reserved.
 # Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
 # Copyright (C) 2012 Ericsson AB. All rights reserved.
@@ skipping 1562 matching lines @@
         $code .= "    return toV8Fast$forMainWorldSuffix($wrappedValue, info, imp);\n";
     } elsif ($attribute->signature->type eq "SerializedScriptValue" && $attrExt->{"CachedAttribute"}) {
         my $getterFunc = ToMethodName($attribute->signature->name);
         $code .= <<END;
     RefPtr<SerializedScriptValue> serialized = imp->${getterFunc}();
     value = serialized ? serialized->deserialize() : v8::Handle<v8::Value>(v8Null(info.GetIsolate()));
     info.Holder()->SetHiddenValue(propertyName, value);
     return value;
 END
     } else {
-        $code .= NativeToJSValue($attribute->signature, $expression, "    ", "return", "info.Holder()", "info.GetIsolate()", "info", "imp", "ReturnUnsafeHandle", $forMainWorldSuffix) . "\n";
+        $code .= NativeToJSValue($attribute->signature->type, $attribute->signature->extendedAttributes, $expression, "    ", "return", "info.Holder()", "info.GetIsolate()", "info", "imp", "ReturnUnsafeHandle", $forMainWorldSuffix) . "\n";
     }
 
     $code .= "}\n\n";  # end of getter
     $code .= "#endif // ${conditionalString}\n\n" if $conditionalString;
     $implementation{nameSpaceInternal}->add($code);
 }
 
 sub ShouldKeepAttributeAlive
 {
     my ($interface, $attribute, $returnType) = @_;
@@ skipping 1459 matching lines @@
         $code .= "    } else {\n";
         $code .= "        ${conditional}$template->Set(v8::String::NewSymbol(\"$name\"), v8::FunctionTemplate::New(${implClassName}V8Internal::${name}MethodCallback, v8Undefined(), ${signature}, $functionLength)$property_attributes);\n";
         $code .= "    }\n";
     } else {
         $code .= "    ${conditional}$template->Set(v8::String::NewSymbol(\"$name\"), v8::FunctionTemplate::New(${implClassName}V8Internal::${name}MethodCallback, v8Undefined(), ${signature}, $functionLength)$property_attributes);\n";
     }
     $code .= "#endif // ${conditionalString}\n" if $conditionalString;
     return $code;
 }
 
+sub GetUnionMemberVariableName
+{
+    my $unionMemberIndex = shift;
+    my $unionMemberNumber = $unionMemberIndex + 1;
+    return sprintf("Member%d", $unionMemberIndex+1);
+}
+
+sub GenerateIsNullExpression
+{
+    my $type = shift;
+    my $variableName = shift;
+    if (IsUnionType($type)) {
+        my $types = $type->unionMemberTypes;
+        my @expression = ();
+        for my $i (0 .. scalar(@$types)-1) {
+            my $unionMemberType = $types->[$i];
+            my $unionMemberVariable = $variableName . GetUnionMemberVariableName($i);

[haraken, 2013/05/17 07:10:37]

Nit: You can write this like:

  my $unionMemberVariable = $variableName . $i;

Then you can remove GetUnionMemberVariableName().

+            my $isNull = GenerateIsNullExpression($unionMemberType, $unionMemberVariable);
+            push @expression, $isNull;
+        }
+        return join " && ", @expression;
+    }
+    if (IsRefPtrType($type)) {
+        return "!${variableName}";
+    } else {
+        return "${variableName}.isNull()";
+    }
+}
+
 sub GenerateImplementationIndexedProperty
 {
     my $interface = shift;
     my $interfaceName = $interface->name;
     my $implClassName = GetImplName($interface);
     my $v8ClassName = GetV8ClassName($interface);
 
     my $indexedGetterFunction = GetIndexedGetterFunction($interface);
     my $hasCustomIndexedSetter = $interface->extendedAttributes->{"CustomIndexedSetter"};
     my $hasCustomIndexedGetter = $interface->extendedAttributes->{"CustomIndexedGetter"};
@@ skipping 27 matching lines @@
     my $code = "";
     $code .= "    desc->${setOn}Template()->SetIndexedPropertyHandler(${v8ClassName}::indexedPropertyGetter";
     $code .= $hasCustomIndexedSetter ? ", ${v8ClassName}::indexedPropertySetter" : ", 0";
     $code .= ", 0"; # IndexedPropertyQuery -- not being used at the moment.
     $code .= $hasDeleter ? ", ${v8ClassName}::indexedPropertyDeleter" : ", 0";
     $code .= ", nodeCollectionIndexedPropertyEnumerator<${implClassName}>" if $hasEnumerator;
     $code .= ");\n";
 
     if ($indexedGetterFunction && !$hasCustomIndexedGetter) {
         my $returnType = $indexedGetterFunction->signature->type;
+        my $nativeType = GetNativeType($returnType);
         my $methodName = GetImplName($indexedGetterFunction->signature);
         AddToImplIncludes("bindings/v8/V8Collection.h");
-        my $returnJSValueCode = "";
-        my $nativeType = GetNativeType($returnType);
-        my $isNull = "";
-
-        if (IsRefPtrType($returnType)) {
-            AddToImplIncludes("V8$returnType.h");
-            $isNull = "!element";
-            $returnJSValueCode = NativeToJSValue($indexedGetterFunction->signature, "element.release()", "    ", "return", "info.Holder()", "info.GetIsolate()", "info", "collection", "", "");
-        } else {
-            $isNull = "element.isNull()";
-            $returnJSValueCode = NativeToJSValue($indexedGetterFunction->signature, "element", "    ", "return", "info.Holder()", "info.GetIsolate()");
-        }
-
-        $implementation{nameSpaceWebCore}->add(<<END);
+        my $nativeValue = "element";
+        $nativeValue .= ".release()" if (IsRefPtrType($returnType));
+        my $isNull = GenerateIsNullExpression($returnType, "element");
+        my $returnJSValueCode = NativeToJSValue($indexedGetterFunction->signature->type, $indexedGetterFunction->signature->extendedAttributes, $nativeValue, "    ", "return", "info.Holder()", "info.GetIsolate()", "info", "collection");
+        my $callMethodCode = GenerateMethodCall($returnType, "element", "collection->${methodName}", "index");

[haraken, 2013/05/17 07:10:37]

Nit: $callMethodCode => $methodCallCode

+        my $getterCode = <<END;
 v8::Handle<v8::Value> ${v8ClassName}::indexedPropertyGetter(uint32_t index, const v8::AccessorInfo& info)
 {
     ASSERT(V8DOMWrapper::maybeDOMWrapper(info.Holder()));
     ${implClassName}* collection = toNative(info.Holder());
-    $nativeType element = collection->$methodName(index);
-    if ($isNull)
+$callMethodCode
+END
+        if (IsUnionType($returnType)) {
+            $getterCode .= <<END;
+${returnJSValueCode}
+    return v8Undefined();
+END

[haraken, 2013/05/17 07:10:37]

Nit: You don't need to use here document just for two lines of code.

+        } else {
+            $getterCode .= <<END;
+    if (${isNull})
         return v8Undefined();
 ${returnJSValueCode}
+END

[haraken, 2013/05/17 07:10:37]

Ditto.

+        }
+        $getterCode .= <<END;
 }
 
 END

[haraken, 2013/05/17 07:10:37]

Ditto.

+        $implementation{nameSpaceWebCore}->add($getterCode);
     }
     return $code;
 }
 
 sub GenerateImplementationNamedPropertyAccessors
 {
     my $interface = shift;
 
     my $interfaceName = $interface->name;
     my $implClassName = GetImplName($interface);
@@ skipping 43 matching lines @@
         $subCode .= $hasSetter ? "${v8ClassName}::namedPropertySetter, " : "0, ";
         $subCode .= $hasQuery ? "${v8ClassName}::namedPropertyQuery, " : "0, ";
         $subCode .= $hasDeleter ? "${v8ClassName}::namedPropertyDeleter, " : "0, ";
         $subCode .= $hasEnumerator ? "${v8ClassName}::namedPropertyEnumerator" : "0";
         $subCode .= ");\n";
     }
 
     return $subCode;
 }
 
+sub GenerateMethodCall
+{
+    my $returnType = shift; # string or UnionType
+    my $returnName = shift;
+    my $functionExpression = shift;
+    my $firstArgument = shift;
+    if (IsUnionType($returnType)) {
+        my $code = "";
+        my @extraArguments = ();
+        for my $i (0..scalar(@{$returnType->unionMemberTypes})-1) {
+            my $unionMemberType = $returnType->unionMemberTypes->[$i];
+            my $nativeType = GetNativeType($unionMemberType);
+            my $unionMemberVariable = $returnName . GetUnionMemberVariableName($i);

[haraken, 2013/05/17 07:10:37]

Nit: my $unionMemberVariable = $returnName . $i;

+            $code .= "    ${nativeType} ${unionMemberVariable};\n";
+            push @extraArguments, $unionMemberVariable;
+        }
+        $code .= "    ${functionExpression}(${firstArgument}, " . (join ", ", @extraArguments) . ");";
+        return $code;
+    } else {
+        my $nativeType = GetNativeType($returnType);
+        return "    ${nativeType} element = ${functionExpression}(${firstArgument});"
+    }
+}
+
+
 sub GenerateImplementationNamedPropertyGetter
 {
     my $interface = shift;
     my $namedGetterFunction = shift;
     my $implClassName = GetImplName($interface);
     my $v8ClassName = GetV8ClassName($interface);
     my $methodName = GetImplName($namedGetterFunction->signature);
 
     AddToImplIncludes("bindings/v8/V8Collection.h");
     my $returnType = $namedGetterFunction->signature->type;
-    my $nativeType = GetNativeType($returnType);
-    my $isNull = "";
-    my $returnJSValueCode = "";
+    my $isNull = GenerateIsNullExpression($returnType, "element");
+    my $nativeValue = "element";
+    $nativeValue .= ".release()" if (IsRefPtrType($returnType));
+    my $returnJSValueCode = NativeToJSValue($namedGetterFunction->signature->type, $namedGetterFunction->signature->extendedAttributes, $nativeValue, "    ", "return", "info.Holder()", "info.GetIsolate()", "info", "collection");
+    my $callMethodCode = GenerateMethodCall($returnType, "element", "collection->${methodName}", "propertyName");

[haraken, 2013/05/17 07:10:37]

Nit: $methodCallCode

 
-    if (IsRefPtrType($returnType)) {
-        AddToImplIncludes("V8$returnType.h");
-        $isNull = "!element";
-        $returnJSValueCode = NativeToJSValue($namedGetterFunction->signature, "element.release()", "    ", "return", "info.Holder()", "info.GetIsolate()", "info", "collection", "", "");
-    } else {
-        $isNull = "element.isNull()";
-        $returnJSValueCode = NativeToJSValue($namedGetterFunction->signature, "element", "    ", "return", "info.Holder()", "info.GetIsolate()");
-    }
-
-    $implementation{nameSpaceWebCore}->add(<<END);
+    my $code = <<END;
 v8::Handle<v8::Value> ${v8ClassName}::namedPropertyGetter(v8::Local<v8::String> name, const v8::AccessorInfo& info)
 {
     if (!info.Holder()->GetRealNamedPropertyInPrototypeChain(name).IsEmpty())
         return v8Undefined();
     if (info.Holder()->HasRealNamedCallbackProperty(name))
         return v8Undefined();
 
     ASSERT(V8DOMWrapper::maybeDOMWrapper(info.Holder()));
     ${implClassName}* collection = toNative(info.Holder());
     AtomicString propertyName = toWebCoreAtomicString(name);
-    ${nativeType} element = collection->${methodName}(propertyName);
+$callMethodCode
+END
+        if (IsUnionType($returnType)) {
+            $code .= <<END;
+${returnJSValueCode}
+    return v8Undefined();
+END

[haraken, 2013/05/17 07:10:37]

Nit: Here document might not be needed.

+        } else {
+            $code .= <<END;
     if (${isNull})
         return v8Undefined();
 ${returnJSValueCode}
+END

[haraken, 2013/05/17 07:10:37]

Ditto.

+        }
+        $code .= <<END;
 }
 
 END

[haraken, 2013/05/17 07:10:37]

Ditto.

+    $implementation{nameSpaceWebCore}->add($code);
 }
 
 sub GenerateImplementationCustomCall
 {
     my $interface = shift;
     my $code = "";
 
     my $v8ClassName = GetV8ClassName($interface);
 
     if ($interface->extendedAttributes->{"CustomCall"}) {
@@ skipping 828 matching lines @@
             $code .= "        return true;\n\n";
             $code .= "    v8::HandleScope handleScope;\n\n";
             $code .= "    v8::Handle<v8::Context> v8Context = toV8Context(scriptExecutionContext(), m_world.get());\n";
             $code .= "    if (v8Context.IsEmpty())\n";
             $code .= "        return true;\n\n";
             $code .= "    v8::Context::Scope scope(v8Context);\n\n";
 
             @args = ();
             foreach my $param (@params) {
                 my $paramName = $param->name;
-                $code .= NativeToJSValue($param, $paramName, "    ", "v8::Handle<v8::Value> ${paramName}Handle =", "v8::Handle<v8::Object>()", "v8Context->GetIsolate()", "") . "\n";
+                $code .= NativeToJSValue($param->type, $param->extendedAttributes, $paramName, "    ", "v8::Handle<v8::Value> ${paramName}Handle =", "v8::Handle<v8::Object>()", "v8Context->GetIsolate()", "") . "\n";
                 $code .= "    if (${paramName}Handle.IsEmpty()) {\n";
                 $code .= "        if (!isScriptControllerTerminating())\n";
                 $code .= "            CRASH();\n";
                 $code .= "        return true;\n";
                 $code .= "    }\n";
                 push(@args, "        ${paramName}Handle");
             }
 
             if (scalar(@args) > 0) {
                 $code .= "\n    v8::Handle<v8::Value> argv[] = {\n";
@@ skipping 244 matching lines @@
     # If the implementing class is a POD type, commit changes
     if (IsSVGTypeNeedingTearOff($interfaceName) and not $interfaceName =~ /List$/) {
         $code .= $indent . "wrapper->commitChange();\n";
     }
 
     $return .= ".release()" if ($returnIsRef);
 
     my $nativeValue;
     # FIXME: Update for all ScriptWrappables.
     if (IsDOMNodeType($interfaceName)) {
-        $nativeValue = NativeToJSValue($function->signature, $return, $indent, "return", "args.Holder()", "args.GetIsolate()", "args", "imp", "ReturnUnsafeHandle", $forMainWorldSuffix);
+        $nativeValue = NativeToJSValue($function->signature->type, $function->signature->extendedAttributes, $return, $indent, "return", "args.Holder()", "args.GetIsolate()", "args", "imp", "ReturnUnsafeHandle", $forMainWorldSuffix);
     } else {
-        $nativeValue = NativeToJSValue($function->signature, $return, $indent, "return", "args.Holder()", "args.GetIsolate()", 0, 0, "ReturnUnsafeHandle", $forMainWorldSuffix);
+        $nativeValue = NativeToJSValue($function->signature->type, $function->signature->extendedAttributes, $return, $indent, "return", "args.Holder()", "args.GetIsolate()", 0, 0, "ReturnUnsafeHandle", $forMainWorldSuffix);
     }
 
     $code .= $nativeValue . "\n";
 
     return $code;
 }
 
 sub GetNativeTypeFromSignature
 {
     my $signature = shift;
@@ skipping 54 matching lines @@
     return "double" if $type eq "Date";
     return "ScriptValue" if $type eq "any";
     return "Dictionary" if $type eq "Dictionary";
 
     return "RefPtr<DOMStringList>" if $type eq "DOMStringList";
     return "RefPtr<MediaQueryListListener>" if $type eq "MediaQueryListListener";
     return "RefPtr<NodeFilter>" if $type eq "NodeFilter";
     return "RefPtr<SerializedScriptValue>" if $type eq "SerializedScriptValue";
     return "RefPtr<XPathNSResolver>" if $type eq "XPathNSResolver";
 
+    die "UnionType is not supported" if IsUnionType($type);
+
     # We need to check [ImplementedBy] extended attribute for wrapper types.
     if (IsWrapperType($type)) {
         my $interface = ParseInterface($type);
         my $implClassName = GetImplName($interface);
         return $isParameter ? "${implClassName}*" : "RefPtr<${implClassName}>";
     }
     return "RefPtr<${type}>" if IsRefPtrType($type) and not $isParameter;
 
     my $arrayType = GetArrayType($type);
     my $sequenceType = GetSequenceType($type);
@@ skipping 202 matching lines @@
     'long long' => 1,
     'long' => 1,
     'short' => 1,
     'unsigned int' => 1,
     'unsigned long long' => 1,
     'unsigned long' => 1,
     'unsigned short' => 1,
     'void' => 1
 );
 
+sub IsUnionType
+{
+    my $type = shift; # string or UnionType
+    if(ref($type) eq "UnionType") {
+        die "Currently only 2 values of non-union type is supported as union type.\n" unless @{$type->unionMemberTypes} == 2;
+        return 1;
+    }
+    return 0;
+}
 
 sub IsWrapperType
 {
     my $type = shift;
     return 0 if GetArrayType($type);
     return 0 if GetSequenceType($type);
     return 0 if IsEnumType($type);
     return !($non_wrapper_types{$type});
 }
 
@@ skipping 56 matching lines @@
     return 1 if $type =~ /^SVG.*Element$/;
 
     return 1 if $type eq 'TestNode';
 
     return 0;
 }
 
 
 sub NativeToJSValue
 {
-    my $signature = shift;
+    my $type = shift;
+    my $extendedAttributes = shift;
     my $nativeValue = shift;
     my $indent = shift;  # added before every line
     my $receiver = shift;  # "return" or "<variableName> ="
     my $getCreationContext = shift;
     my $getIsolate = shift;
     die "An Isolate is mandatory for native value => JS value conversion." unless $getIsolate;
-    my $getHolderContainer = shift;
+    my $getHolderContainer = shift || "";
     my $getHolderContainerArg = $getHolderContainer ? ", $getHolderContainer" : "";
-    my $getScriptWrappable = shift;
+    my $getScriptWrappable = shift || "";
     my $getScriptWrappableArg = $getScriptWrappable ? ", $getScriptWrappable" : "";
-    my $returnHandleType = shift;
+    my $returnHandleType = shift || "";
     my $returnHandleTypeArg = $returnHandleType ? ", $returnHandleType" : "";
-    my $forMainWorldSuffix = shift;
+    my $forMainWorldSuffix = shift || "";
 
-    my $type = $signature->type;
+    if (IsUnionType($type)) {
+        my $types = $type->unionMemberTypes;
+        my @codes = ();
+        for my $i (0 .. scalar(@$types)-1) {
+            my $unionMemberType = $types->[$i];
+            my $unionMemberNumber = $i + 1;
+            my $unionMemberVariable = $nativeValue . GetUnionMemberVariableName($i);
+            my $unionMemberNativeValue = $unionMemberVariable;
+            $unionMemberNativeValue .= ".release()" if (IsRefPtrType($unionMemberType));
+            my $returnJSValueCode = NativeToJSValue($unionMemberType, $extendedAttributes, $unionMemberNativeValue, $indent . "    ", $receiver, $getCreationContext, $getIsolate, $getHolderContainer, $getScriptWrappable, $returnHandleType, $forMainWorldSuffix);
+            my $isNotNull = "!" . GenerateIsNullExpression($unionMemberType, $unionMemberVariable);
+            my $code = "";
+            $code .= "${indent}if (${isNotNull})\n";
+            $code .= "${returnJSValueCode}";
+            push @codes, $code;
+        }
+        return join "\n", @codes;
+    }
 
     return "$indent$receiver v8Boolean($nativeValue, $getIsolate);" if $type eq "boolean";
     return "$indent$receiver v8Undefined();" if $type eq "void";     # equivalent to v8Undefined()
 
     # HTML5 says that unsigned reflected attributes should be in the range
     # [0, 2^31). When a value isn't in this range, a default value (or 0)
     # should be returned instead.
-    if ($signature->extendedAttributes->{"Reflect"} and ($type eq "unsigned long" or $type eq "unsigned short")) {
+    if ($extendedAttributes->{"Reflect"} and ($type eq "unsigned long" or $type eq "unsigned short")) {
         $nativeValue =~ s/getUnsignedIntegralAttribute/getIntegralAttribute/g;
         return "$indent$receiver v8UnsignedInteger(std::max(0, " . $nativeValue . "), $getIsolate);";
     }
 
     # For all the types where we use 'int' as the representation type,
     # we use v8Integer() which has a fast small integer conversion check.
     my $nativeType = GetNativeType($type);
     return "$indent$receiver v8Integer($nativeValue, $getIsolate);" if $nativeType eq "int";
     return "$indent$receiver v8UnsignedInteger($nativeValue, $getIsolate);" if $nativeType eq "unsigned";
 
     return "$indent$receiver v8DateOrNull($nativeValue, $getIsolate);" if $type eq "Date";
     # long long and unsigned long long are not representable in ECMAScript.
     return "$indent$receiver v8::Number::New(static_cast<double>($nativeValue));" if $type eq "long long" or $type eq "unsigned long long" or $type eq "DOMTimeStamp";
     return "$indent$receiver v8::Number::New($nativeValue);" if IsPrimitiveType($type);
     return "$indent$receiver $nativeValue.v8Value();" if $nativeType eq "ScriptValue";
 
     if ($type eq "DOMString" or IsEnumType($type)) {
-        my $conv = $signature->extendedAttributes->{"TreatReturnedNullStringAs"};
+        my $conv = $extendedAttributes->{"TreatReturnedNullStringAs"};
         if (defined $conv) {
             return "$indent$receiver v8StringOrNull($nativeValue, $getIsolate$returnHandleTypeArg);" if $conv eq "Null";
             return "$indent$receiver v8StringOrUndefined($nativeValue, $getIsolate$returnHandleTypeArg);" if $conv eq "Undefined";
 
             die "Unknown value for TreatReturnedNullStringAs extended attribute";
         }
         return "$indent$receiver v8String($nativeValue, $getIsolate$returnHandleTypeArg);";
     }
 
     my $arrayType = GetArrayType($type);
@@ skipping 279 matching lines @@
 
 sub IsRefPtrType
 {
     my $type = shift;
 
     return 0 if IsPrimitiveType($type);
     return 0 if GetArrayType($type);
     return 0 if GetSequenceType($type);
     return 0 if $type eq "DOMString";
     return 0 if IsEnumType($type);
+    return 0 if IsUnionType($type);
 
     return 1;
 }
 
 sub GetSVGTypeNeedingTearOff
 {
     my $type = shift;
 
     return $svgTypeNeedingTearOff{$type} if exists $svgTypeNeedingTearOff{$type};
     return undef;
@@ skipping 326 matching lines @@
         if ($currentInterface->extendedAttributes->{$extendedAttribute}) {
             $found = 1;
         }
         return 1 if $found;
     }, 0);
 
     return $found;
 }
 
 1;