Introduce [Exposed(Arguments)] in IDL code generator.

Source/bindings/scripts/v8_utilities.py

 # Copyright (C) 2013 Google Inc. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 # copyright notice, this list of conditions and the following disclaimer
@@ skipping 19 matching lines @@
 
 Extends IdlTypeBase type with |enum_validation_expression| property.
 
 Design doc: http://www.chromium.org/developers/design-documents/idl-compiler
 """
 
 import re
 
 from idl_types import IdlTypeBase
 import idl_types
+from idl_definitions import Exposure
 from v8_globals import includes
 import v8_types
 
 ACRONYMS = [
     'CSSOM',  # must come *before* CSS to match full acronym
     'CSS',
     'HTML',
     'IME',
     'JS',
     'SVG',
@@ skipping 196 matching lines @@
 # [Exposed]
 EXPOSED_EXECUTION_CONTEXT_METHOD = {
     'DedicatedWorker': 'isDedicatedWorkerGlobalScope',
     'ServiceWorker': 'isServiceWorkerGlobalScope',
     'SharedWorker': 'isSharedWorkerGlobalScope',
     'Window': 'isDocument',
     'Worker': 'isWorkerGlobalScope',
 }
 
 
+class ExposureSet:
+    """An ExposureSet is a collection of Exposure instructions."""
+    def __init__(self, exposures=None):
+        self.exposures = set(exposures) if exposures else set()
+
+    def issubset(self, other):
+        """Returns true if |self|'s exposure set is subset of

[haraken, 2014/12/09 16:07:56]

a subset

[yhirano, 2014/12/11 01:38:25]

Done.

+        |other|'s exposure set. This function doesn't case about

[haraken, 2014/12/09 16:07:56]

care about

[yhirano, 2014/12/11 01:38:25]

Done.

+        RuntimeEnabled."""
+        self_set = self._extended(set(e.exposed for e in self.exposures))
+        other_set = self._extended(set(e.exposed for e in other.exposures))
+        return self_set.issubset(other_set)
+
+    @staticmethod
+    def _extended(target):
+        workers = set(['DedicatedWorker', 'SharedWorker', 'ServiceWorker'])

[bashi, 2014/12/09 23:42:19]

I prefer putting this set next to EXPOSED_EXECUTION_CONTEXT_METHOD.

[yhirano, 2014/12/11 01:38:25]

Done.

+        if workers.issubset(target):
+            return target | set(['Worker'])
+        elif 'Worker' in target:
+            return target | workers
+        return target
+
+    def add(self, exposure):
+        self.exposures.add(exposure)
+
+    def __len__(self):
+        return len(self.exposures)
+
+    def __iter__(self):
+        return self.exposures.__iter__()
+
+    @staticmethod
+    def _code(exposure):
+        exposed = ('context->%s()' %
+                   EXPOSED_EXECUTION_CONTEXT_METHOD[exposure.exposed])
+        if exposure.runtime_enabled is not None:
+            runtime_enabled = ('RuntimeEnabledFeatures::%sEnabled()' %
+                               uncapitalize(exposure.runtime_enabled))
+            return '({0} && {1})'.format(exposed, runtime_enabled)
+        return exposed
+
+    def code(self):
+        if len(self.exposures) == 0:
+            return None
+        # We use sorted here to deflake output.
+        return ' || '.join(sorted(self._code(e) for e in self.exposures))
+
+
 def exposed(definition_or_member, interface):

[haraken, 2014/12/09 16:07:56]

What does 'definition' mean? It looks a bit confusing that methods, attributes
and constants are included in 'definition' but interfaces and members are not
included in 'definition'. Probably we should rename the variable.

[Jens Widell, 2014/12/09 16:19:23]

Yeah, it ought to just be 'member'.

[Exposed] is relevant for definitions (i.e. interfaces) as well, but that's
handled in generate_global_constructors.py and doesn't use this code at all.

The name probably comes from e.g. v8_utilities.has_extended_attribute_value()'s
argument, which is anything that has an 'extended_attributes' attribute, i.e. a
definition or a member.

[yhirano, 2014/12/11 01:38:25]

Done.

-    exposure_set = extended_attribute_value_as_list(definition_or_member, 'Exposed')
-    if not exposure_set:
-        return None
+    """Returns a C++ code that checks if a method/attribute/etc is exposed.
 
-    interface_exposure_set = expanded_exposure_set_for_interface(interface)
+    When the Exposed attribute contains RuntimeEnabledFeatures (i.e.
+    Exposed(Arguments) form is given), the code contains check for them as
+    well.
+
+    EXAMPLE: [Exposed=Window, RuntimeEnabledFeature=Feature1]
+      => context->isDocument()

[haraken, 2014/12/09 16:07:56]

context->isDocument() && RuntimeEnabledFeatures::feature1Enabled()

[Jens Widell, 2014/12/09 16:19:23]

While that's the actual logic in the end, it's not the code returned by this
function. [RuntimeEnabledFeature=X] is handled as before, via a separate {%
filter %} in the template producing a separate if-statement.

[yhirano, 2014/12/11 01:38:25]

Yeah, so I would like to leave it be.

+
+    EXAMPLE: [Exposed(Window Feature1, Window Feature2)]
+      => context->isDocument() && RuntimeEnabledFeatures::feature1Enabled() ||
+         context->isDocument() && RuntimeEnabledFeatures::feature2Enabled()
+    """
+    exposure_set = ExposureSet(
+        extended_attribute_value_as_list(definition_or_member, 'Exposed'))
+    interface_exposure_set = ExposureSet(
+        extended_attribute_value_as_list(interface, 'Exposed'))
+    for e in exposure_set:
+        if e.exposed not in EXPOSED_EXECUTION_CONTEXT_METHOD:
+            raise ValueError('Invalid execution context: %s' % e.exposed)
 
     # Methods must not be exposed to a broader scope than their interface.
-    if not set(exposure_set).issubset(interface_exposure_set):
+    if not exposure_set.issubset(interface_exposure_set):
         raise ValueError('Interface members\' exposure sets must be a subset of the interface\'s.')
 
-    exposure_checks = []
-    for environment in exposure_set:
-        # Methods must be exposed on one of the scopes known to Blink.
-        if environment not in EXPOSED_EXECUTION_CONTEXT_METHOD:
-            raise ValueError('Values for the [Exposed] annotation must reflect to a valid exposure scope.')
-
-        exposure_checks.append('context->%s()' % EXPOSED_EXECUTION_CONTEXT_METHOD[environment])
-
-    return ' || '.join(exposure_checks)
-
-
-def expanded_exposure_set_for_interface(interface):
-    exposure_set = extended_attribute_value_as_list(interface, 'Exposed')
-
-    # "Worker" is an aggregation for the different kinds of workers.
-    if 'Worker' in exposure_set:
-        exposure_set.extend(('DedicatedWorker', 'SharedWorker', 'ServiceWorker'))
-
-    return sorted(set(exposure_set))
+    return exposure_set.code()
 
 
 # [GarbageCollected], [WillBeGarbageCollected]
 def gc_type(definition):
     extended_attributes = definition.extended_attributes
     if 'GarbageCollected' in extended_attributes:
         return 'GarbageCollectedObject'
     elif 'WillBeGarbageCollected' in extended_attributes:
         return 'WillBeGarbageCollectedObject'
     return 'RefCountedObject'
@@ skipping 42 matching lines @@
 
     The returned function checks if a method/attribute is enabled.
     Given extended attribute RuntimeEnabled=FeatureName, return:
         RuntimeEnabledFeatures::{featureName}Enabled
     """
     extended_attributes = definition_or_member.extended_attributes
     if 'RuntimeEnabled' not in extended_attributes:
         return None
     feature_name = extended_attributes['RuntimeEnabled']
     return 'RuntimeEnabledFeatures::%sEnabled' % uncapitalize(feature_name)