blob: ccd092281c5264e69acc00c36d0013f130c65466 [file] [log] [blame]
{% from 'utilities.cpp' import declare_enum_validation_variable, v8_value_to_local_cpp_value %}
{##############################################################################}
{% macro attribute_getter(attribute, world_suffix) %}
static void {{attribute.name}}AttributeGetter{{world_suffix}}(
{%- if attribute.is_data_type_property %}
const v8::PropertyCallbackInfo<v8::Value>& info
{%- else %}
const v8::FunctionCallbackInfo<v8::Value>& info
{%- endif %})
{
{% if attribute.is_reflect and not attribute.is_url
and attribute.idl_type == 'DOMString' and is_node
and not attribute.is_implemented_in_private_script %}
{% set cpp_class, v8_class = 'Element', 'V8Element' %}
{% endif %}
{# holder #}
{% if not attribute.is_static %}
{% if attribute.is_lenient_this %}
{# Make sure that info.Holder() really points to an instance if [LenientThis]. #}
if (!{{v8_class}}::hasInstance(info.Holder(), info.GetIsolate()))
return; // Return silently because of [LenientThis].
{% endif %}
v8::Local<v8::Object> holder = info.Holder();
{% endif %}
{# impl #}
{% if attribute.is_save_same_object %}
{% set same_object_private_symbol = 'SameObject' + interface_name + attribute.name[0]|capitalize + attribute.name[1:] %}
// If you see a compile error that
// V8PrivateProperty::get{{same_object_private_symbol}}
// is not defined, then you need to register your attribute at
// V8_PRIVATE_PROPERTY_FOR_EACH defined in V8PrivateProperty.h as
// X(SameObject, {{interface_name}}{{attribute.name[0]|capitalize}}{{attribute.name[1:]}})
auto privateSameObject = V8PrivateProperty::getSameObject{{interface_name}}{{attribute.name[0]|capitalize}}{{attribute.name[1:]}}(info.GetIsolate());
{
v8::Local<v8::Value> v8Value = privateSameObject.get(info.GetIsolate()->GetCurrentContext(), holder);
if (!v8Value.IsEmpty()) {
v8SetReturnValue(info, v8Value);
return;
}
}
{% endif %}
{% if not attribute.is_static %}
{{cpp_class}}* impl = {{v8_class}}::toImpl(holder);
{% endif %}
{% if attribute.cached_attribute_validation_method %}
v8::Local<v8::String> propertyName = v8AtomicString(info.GetIsolate(), "{{attribute.name}}");
if (!impl->{{attribute.cached_attribute_validation_method}}()) {
v8::Local<v8::Value> v8Value = V8HiddenValue::getHiddenValue(ScriptState::current(info.GetIsolate()), holder, propertyName);
if (!v8Value.IsEmpty() && !v8Value->IsUndefined()) {
v8SetReturnValue(info, v8Value);
return;
}
}
{% endif %}
{% if interface_name == 'Window' and attribute.idl_type == 'EventHandler' %}
if (!impl->document())
return;
{% endif %}
{# Local variables #}
{% if attribute.is_call_with_execution_context %}
ExecutionContext* executionContext = currentExecutionContext(info.GetIsolate());
{% endif %}
{% if attribute.is_call_with_script_state %}
ScriptState* scriptState = ScriptState::current(info.GetIsolate());
{% endif %}
{% if (attribute.is_check_security_for_receiver and
not attribute.is_data_type_property) or
attribute.is_check_security_for_return_value or
attribute.is_getter_raises_exception %}
ExceptionState exceptionState(ExceptionState::GetterContext, "{{attribute.name}}", "{{interface_name}}", holder, info.GetIsolate());
{% endif %}
{% if attribute.is_explicit_nullable %}
bool isNull = false;
{% endif %}
{% if attribute.is_implemented_in_private_script %}
{{attribute.cpp_type}} result{{attribute.cpp_type_initializer}};
if (!{{attribute.cpp_value_original}})
return;
{% elif attribute.cpp_value_original %}
{{attribute.cpp_type}} {{attribute.cpp_value}}({{attribute.cpp_value_original}});
{% endif %}
{# Checks #}
{% if attribute.is_getter_raises_exception %}
if (UNLIKELY(exceptionState.throwIfNeeded()))
return;
{% endif %}
{# Security checks #}
{% if not attribute.is_data_type_property %}
{% if attribute.is_check_security_for_receiver %}
if (!BindingSecurity::shouldAllowAccessTo(info.GetIsolate(), currentDOMWindow(info.GetIsolate()), impl, exceptionState)) {
v8SetReturnValueNull(info);
exceptionState.throwIfNeeded();
return;
}
{% endif %}
{% endif %}
{% if attribute.is_check_security_for_return_value %}
if (!BindingSecurity::shouldAllowAccessTo(info.GetIsolate(), currentDOMWindow(info.GetIsolate()), {{attribute.cpp_value}}, exceptionState)) {
v8SetReturnValueNull(info);
exceptionState.throwIfNeeded();
return;
}
{% endif %}
{% if attribute.reflect_only %}
{{release_only_check(attribute.reflect_only, attribute.reflect_missing,
attribute.reflect_invalid, attribute.reflect_empty,
attribute.cpp_value)
| indent}}
{% endif %}
{% if attribute.is_explicit_nullable %}
if (isNull) {
v8SetReturnValueNull(info);
return;
}
{% endif %}
{% if attribute.cached_attribute_validation_method %}
v8::Local<v8::Value> v8Value({{attribute.cpp_value_to_v8_value}});
V8HiddenValue::setHiddenValue(ScriptState::current(info.GetIsolate()), holder, propertyName, v8Value);
{% endif %}
{# v8SetReturnValue #}
{% if attribute.is_keep_alive_for_gc %}
if ({{attribute.cpp_value}} && DOMDataStore::setReturnValue{{world_suffix}}(info.GetReturnValue(), {{attribute.cpp_value}}))
return;
v8::Local<v8::Value> v8Value(toV8({{attribute.cpp_value}}, holder, info.GetIsolate()));
if (!v8Value.IsEmpty()) {
V8HiddenValue::setHiddenValue(ScriptState::current(info.GetIsolate()), holder, v8AtomicString(info.GetIsolate(), "{{attribute.name}}"), v8Value);
{{attribute.v8_set_return_value}};
}
{% elif world_suffix %}
{{attribute.v8_set_return_value_for_main_world}};
{% else %}
{% if attribute.use_output_parameter_for_result %}
{{attribute.cpp_type}} result;
{{attribute.cpp_value}};
{% endif %}
{{attribute.v8_set_return_value}};
{% endif %}
{% if attribute.is_save_same_object %}
privateSameObject.set(info.GetIsolate()->GetCurrentContext(), holder, info.GetReturnValue().Get());
{% endif %}
}
{% endmacro %}
{######################################}
{% macro release_only_check(reflect_only_values, reflect_missing,
reflect_invalid, reflect_empty, cpp_value) %}
{# Attribute is limited to only known values: check that the attribute value is
one of those. If not, set it to the empty string.
http://www.whatwg.org/specs/web-apps/current-work/#limited-to-only-known-values #}
{% if reflect_empty %}
if ({{cpp_value}}.isNull()) {
{% if reflect_missing %}
{{cpp_value}} = "{{reflect_missing}}";
{% else %}
;
{% endif %}
} else if ({{cpp_value}}.isEmpty()) {
{{cpp_value}} = "{{reflect_empty}}";
{% else %}
if ({{cpp_value}}.isEmpty()) {
{# FIXME: should use [ReflectEmpty] instead; need to change IDL files #}
{% if reflect_missing %}
{{cpp_value}} = "{{reflect_missing}}";
{% else %}
;
{% endif %}
{% endif %}
{% for value in reflect_only_values %}
} else if (equalIgnoringCase({{cpp_value}}, "{{value}}")) {
{{cpp_value}} = "{{value}}";
{% endfor %}
} else {
{{cpp_value}} = "{{reflect_invalid}}";
}
{% endmacro %}
{##############################################################################}
{% macro attribute_getter_callback(attribute, world_suffix) %}
static void {{attribute.name}}AttributeGetterCallback{{world_suffix}}(
{%- if attribute.is_data_type_property %}
v8::Local<v8::Name>, const v8::PropertyCallbackInfo<v8::Value>& info
{%- else %}
const v8::FunctionCallbackInfo<v8::Value>& info
{%- endif %})
{
{% if attribute.deprecate_as %}
Deprecation::countDeprecationIfNotPrivateScript(info.GetIsolate(), currentExecutionContext(info.GetIsolate()), UseCounter::{{attribute.deprecate_as}});
{% endif %}
{% if attribute.measure_as %}
UseCounter::countIfNotPrivateScript(info.GetIsolate(), currentExecutionContext(info.GetIsolate()), UseCounter::{{attribute.measure_as('AttributeGetter')}});
{% endif %}
{% if world_suffix in attribute.activity_logging_world_list_for_getter %}
ScriptState* scriptState = ScriptState::from(info.GetIsolate()->GetCurrentContext());
V8PerContextData* contextData = scriptState->perContextData();
{% if attribute.activity_logging_world_check %}
if (scriptState->world().isIsolatedWorld() && contextData && contextData->activityLogger())
{% else %}
if (contextData && contextData->activityLogger())
{% endif %}
contextData->activityLogger()->logGetter("{{interface_name}}.{{attribute.name}}");
{% endif %}
{% if attribute.has_custom_getter %}
{{v8_class}}::{{attribute.name}}AttributeGetterCustom(info);
{% else %}
{{cpp_class_or_partial}}V8Internal::{{attribute.name}}AttributeGetter{{world_suffix}}(info);
{% endif %}
}
{% endmacro %}
{##############################################################################}
{% macro constructor_getter_callback(attribute, world_suffix) %}
static void {{attribute.name}}ConstructorGetterCallback{{world_suffix}}(v8::Local<v8::Name> property, const v8::PropertyCallbackInfo<v8::Value>& info)
{
{% if attribute.deprecate_as %}
Deprecation::countDeprecationIfNotPrivateScript(info.GetIsolate(), currentExecutionContext(info.GetIsolate()), UseCounter::{{attribute.deprecate_as}});
{% endif %}
{% if attribute.measure_as %}
UseCounter::countIfNotPrivateScript(info.GetIsolate(), currentExecutionContext(info.GetIsolate()), UseCounter::{{attribute.measure_as('ConstructorGetter')}});
{% endif %}
v8ConstructorAttributeGetter(property, info);
}
{% endmacro %}
{##############################################################################}
{% macro attribute_setter(attribute, world_suffix) %}
static void {{attribute.name}}AttributeSetter{{world_suffix}}(
{%- if attribute.is_data_type_property %}
v8::Local<v8::Value> v8Value, const v8::PropertyCallbackInfo<void>& info
{%- else %}
v8::Local<v8::Value> v8Value, const v8::FunctionCallbackInfo<v8::Value>& info
{%- endif %})
{
{% if attribute.is_reflect and attribute.idl_type == 'DOMString'
and is_node and not attribute.is_implemented_in_private_script %}
{% set cpp_class, v8_class = 'Element', 'V8Element' %}
{% endif %}
{% if attribute.has_setter_exception_state or
((not attribute.is_replaceable and
not attribute.constructor_type and
not attribute.is_data_type_property) and
(attribute.is_check_security_for_receiver or
attribute.is_check_security_for_return_value)) %}
{% set raise_exception = 1 %}
{% else %}
{% set raise_exception = 0 %}
{% endif %}
{# Local variables #}
{% if (not attribute.is_static and
not attribute.is_replaceable and
not attribute.constructor_type) or
raise_exception %}
{% if attribute.is_lenient_this %}
{# Make sure that info.Holder() really points to an instance if [LenientThis]. #}
if (!{{v8_class}}::hasInstance(info.Holder(), info.GetIsolate()))
return; // Return silently because of [LenientThis].
{% endif %}
v8::Local<v8::Object> holder = info.Holder();
{% endif %}
{% if raise_exception %}
ExceptionState exceptionState(ExceptionState::SetterContext, "{{attribute.name}}", "{{interface_name}}", holder, info.GetIsolate());
{% endif %}
{% if attribute.is_replaceable or
attribute.constructor_type %}
v8::Local<v8::String> propertyName = v8AtomicString(info.GetIsolate(), "{{attribute.name}}");
{% endif %}
{# impl #}
{% if attribute.is_put_forwards %}
{{cpp_class}}* proxyImpl = {{v8_class}}::toImpl(holder);
{{attribute.cpp_type}} impl = WTF::getPtr(proxyImpl->{{attribute.name}}());
if (!impl)
return;
{% elif not attribute.is_static and
not attribute.is_replaceable and
not attribute.constructor_type %}
{{cpp_class}}* impl = {{v8_class}}::toImpl(holder);
{% endif %}
{% if attribute.idl_type == 'EventHandler' and interface_name == 'Window' %}
if (!impl->document())
return;
{% endif %}
{# Security checks #}
{% if not attribute.is_replaceable and
not attribute.constructor_type %}
{% if not attribute.is_data_type_property %}
{% if attribute.is_check_security_for_receiver %}
if (!BindingSecurity::shouldAllowAccessTo(info.GetIsolate(), currentDOMWindow(info.GetIsolate()), impl, exceptionState)) {
v8SetReturnValue(info, v8Value);
exceptionState.throwIfNeeded();
return;
}
{% endif %}
{% endif %}
{% if attribute.is_check_security_for_return_value %}
#error Attribute setter with the security check for the return value is not supported.
{% endif %}
{% endif %}{# not attribute.is_replaceable and
not attribute.constructor_type #}
{# Convert JS value to C++ value #}
{% if attribute.idl_type != 'EventHandler' %}
{% if v8_value_to_local_cpp_value(attribute) %}
{{v8_value_to_local_cpp_value(attribute) | indent}}
{% endif %}
{% elif not is_node %}{# EventHandler hack #}
moveEventListenerToNewWrapper(info.GetIsolate(), holder, {{attribute.event_handler_getter_expression}}, v8Value, {{v8_class}}::eventListenerCacheIndex);
{% endif %}
{# Type checking, possibly throw a TypeError, per:
http://www.w3.org/TR/WebIDL/#es-type-mapping #}
{% if attribute.has_type_checking_interface %}
{# Type checking for interface types (if interface not implemented, throw
TypeError), per http://www.w3.org/TR/WebIDL/#es-interface #}
if (!cppValue{% if attribute.is_nullable %} && !isUndefinedOrNull(v8Value){% endif %}) {
exceptionState.throwTypeError("The provided value is not of type '{{attribute.idl_type}}'.");
exceptionState.throwIfNeeded();
return;
}
{% elif attribute.enum_values %}
{# Setter ignores invalid enum values:
http://www.w3.org/TR/WebIDL/#idl-enums #}
{% if not attribute.has_setter_exception_state %}
NonThrowableExceptionState exceptionState;
{% endif %}
{{declare_enum_validation_variable(attribute.enum_values) | indent}}
if (!isValidEnum(cppValue, validValues, WTF_ARRAY_LENGTH(validValues), "{{attribute.enum_type}}", exceptionState)) {
currentExecutionContext(info.GetIsolate())->addConsoleMessage(ConsoleMessage::create(JSMessageSource, WarningMessageLevel, exceptionState.message()));
return;
}
{% endif %}
{# Pre-set context #}
{% if attribute.is_custom_element_callbacks or
(attribute.is_reflect and
not(attribute.idl_type == 'DOMString' and is_node)) %}
{# Skip on compact node DOMString getters #}
V0CustomElementProcessingStack::CallbackDeliveryScope deliveryScope;
{% endif %}
{% if attribute.is_call_with_execution_context or
attribute.is_setter_call_with_execution_context %}
ExecutionContext* executionContext = currentExecutionContext(info.GetIsolate());
{% endif %}
{% if attribute.is_call_with_script_state %}
ScriptState* scriptState = ScriptState::current(info.GetIsolate());
{% endif %}
{# Set #}
{% if attribute.cpp_setter %}
{{attribute.cpp_setter}};
{% endif %}
{# Post-set #}
{% if attribute.is_setter_raises_exception %}
exceptionState.throwIfNeeded();
{% endif %}
{% if attribute.cached_attribute_validation_method %}
V8HiddenValue::deleteHiddenValue(ScriptState::current(info.GetIsolate()), holder, v8AtomicString(info.GetIsolate(), "{{attribute.name}}")); // Invalidate the cached value.
{% endif %}
}
{% endmacro %}
{##############################################################################}
{% macro attribute_setter_callback(attribute, world_suffix) %}
static void {{attribute.name}}AttributeSetterCallback{{world_suffix}}(
{%- if attribute.is_data_type_property %}
v8::Local<v8::Name>, v8::Local<v8::Value> v8Value, const v8::PropertyCallbackInfo<void>& info
{%- else %}
const v8::FunctionCallbackInfo<v8::Value>& info
{%- endif %})
{
{% if not attribute.is_data_type_property %}
v8::Local<v8::Value> v8Value = info[0];
{% endif %}
{% if attribute.deprecate_as %}
Deprecation::countDeprecationIfNotPrivateScript(info.GetIsolate(), currentExecutionContext(info.GetIsolate()), UseCounter::{{attribute.deprecate_as}});
{% endif %}
{% if attribute.measure_as %}
UseCounter::countIfNotPrivateScript(info.GetIsolate(), currentExecutionContext(info.GetIsolate()), UseCounter::{{attribute.measure_as('AttributeSetter')}});
{% endif %}
{% if world_suffix in attribute.activity_logging_world_list_for_setter %}
ScriptState* scriptState = ScriptState::from(info.GetIsolate()->GetCurrentContext());
V8PerContextData* contextData = scriptState->perContextData();
{% if attribute.activity_logging_world_check %}
if (scriptState->world().isIsolatedWorld() && contextData && contextData->activityLogger()) {
{% else %}
if (contextData && contextData->activityLogger()) {
{% endif %}
contextData->activityLogger()->logSetter("{{interface_name}}.{{attribute.name}}", v8Value);
}
{% endif %}
{% if attribute.is_ce_reactions %}
CEReactionsScope ceReactionsScope;
{% endif %}
{% if attribute.is_custom_element_callbacks or attribute.is_reflect %}
V0CustomElementProcessingStack::CallbackDeliveryScope deliveryScope;
{% endif %}
{% if attribute.has_custom_setter %}
{{v8_class}}::{{attribute.name}}AttributeSetterCustom(v8Value, info);
{% else %}
{{cpp_class_or_partial}}V8Internal::{{attribute.name}}AttributeSetter{{world_suffix}}(v8Value, info);
{% endif %}
}
{% endmacro %}
{##############################################################################}
{% macro attribute_getter_implemented_in_private_script(attribute) %}
bool {{v8_class}}::PrivateScript::{{attribute.name}}AttributeGetter(LocalFrame* frame, {{cpp_class}}* holderImpl, {{attribute.cpp_type}}* result)
{
if (!frame)
return false;
v8::HandleScope handleScope(toIsolate(frame));
ScriptForbiddenScope::AllowUserAgentScript script;
ScriptState* scriptState = ScriptState::forWorld(frame, DOMWrapperWorld::privateScriptIsolatedWorld());
if (!scriptState)
return false;
ScriptState* scriptStateInUserScript = ScriptState::forMainWorld(frame);
if (!scriptStateInUserScript)
return false;
ScriptState::Scope scope(scriptState);
v8::Local<v8::Value> holder = toV8(holderImpl, scriptState->context()->Global(), scriptState->isolate());
if (holder.IsEmpty())
return false;
ExceptionState exceptionState(ExceptionState::GetterContext, "{{attribute.name}}", "{{cpp_class}}", scriptState->context()->Global(), scriptState->isolate());
v8::Local<v8::Value> v8Value = PrivateScriptRunner::runDOMAttributeGetter(scriptState, scriptStateInUserScript, "{{cpp_class}}", "{{attribute.name}}", holder);
if (v8Value.IsEmpty())
return false;
{{v8_value_to_local_cpp_value(attribute.private_script_v8_value_to_local_cpp_value) | indent}}
RELEASE_ASSERT(!exceptionState.hadException());
*result = cppValue;
return true;
}
{% endmacro %}
{% macro attribute_setter_implemented_in_private_script(attribute) %}
bool {{v8_class}}::PrivateScript::{{attribute.name}}AttributeSetter(LocalFrame* frame, {{cpp_class}}* holderImpl, {{attribute.argument_cpp_type}} cppValue)
{
if (!frame)
return false;
v8::HandleScope handleScope(toIsolate(frame));
ScriptForbiddenScope::AllowUserAgentScript script;
ScriptState* scriptState = ScriptState::forWorld(frame, DOMWrapperWorld::privateScriptIsolatedWorld());
if (!scriptState)
return false;
ScriptState* scriptStateInUserScript = ScriptState::forMainWorld(frame);
if (!scriptStateInUserScript)
return false;
ScriptState::Scope scope(scriptState);
v8::Local<v8::Value> holder = toV8(holderImpl, scriptState->context()->Global(), scriptState->isolate());
if (holder.IsEmpty())
return false;
ExceptionState exceptionState(ExceptionState::SetterContext, "{{attribute.name}}", "{{cpp_class}}", scriptState->context()->Global(), scriptState->isolate());
return PrivateScriptRunner::runDOMAttributeSetter(scriptState, scriptStateInUserScript, "{{cpp_class}}", "{{attribute.name}}", holder, {{attribute.private_script_cpp_value_to_v8_value}});
}
{% endmacro %}
{##############################################################################}
{% macro attribute_configuration(attribute) %}
{% from 'utilities.cpp' import property_location %}
{% if attribute.constructor_type %}
{% set getter_callback =
'%sV8Internal::%sConstructorGetterCallback' % (cpp_class_or_partial, attribute.name)
if attribute.needs_constructor_getter_callback else
'v8ConstructorAttributeGetter' %}
{% set setter_callback = '0' %}
{% else %}{# regular attributes #}
{% set getter_callback = '%sV8Internal::%sAttributeGetterCallback' %
(cpp_class_or_partial, attribute.name) %}
{% set setter_callback = '%sV8Internal::%sAttributeSetterCallback' %
(cpp_class_or_partial, attribute.name)
if attribute.has_setter else '0' %}
{% endif %}
{% set getter_callback_for_main_world =
'%sForMainWorld' % getter_callback
if attribute.is_per_world_bindings else '0' %}
{% set setter_callback_for_main_world =
'%sForMainWorld' % setter_callback
if attribute.is_per_world_bindings and attribute.has_setter else '0' %}
{% set wrapper_type_info =
'const_cast<WrapperTypeInfo*>(&V8%s::wrapperTypeInfo)' %
attribute.constructor_type
if attribute.constructor_type else '0' %}
{% if attribute.is_data_type_property %}
{% set access_control = 'static_cast<v8::AccessControl>(%s)' %
' | '.join(attribute.access_control_list) %}
{% else %}
{% set access_control = 'v8::DEFAULT' %}
{% endif %}
{% set property_attribute = 'static_cast<v8::PropertyAttribute>(%s)' %
' | '.join(attribute.property_attributes) %}
{% set only_exposed_to_private_script =
'V8DOMConfiguration::OnlyExposedToPrivateScript'
if attribute.only_exposed_to_private_script else
'V8DOMConfiguration::ExposedToAllScripts' %}
{% set holder_check = 'V8DOMConfiguration::DoNotCheckHolder'
if attribute.is_lenient_this else 'V8DOMConfiguration::CheckHolder' %}
{% set attribute_configuration_list = [
'"%s"' % attribute.name,
getter_callback,
setter_callback,
getter_callback_for_main_world,
setter_callback_for_main_world,
wrapper_type_info,
access_control,
property_attribute,
only_exposed_to_private_script,
property_location(attribute),
holder_check,
] %}
{{'{'}}{{attribute_configuration_list | join(', ')}}{{'}'}}
{%- endmacro %}