Home | History | Annotate | Download | only in bindings
      1 #
      2 # This file describes all Blink IDL extended attributes and allowed values.
      3 # If any IDL file uses an extended attribute or values not listed below, the
      4 # build will fail.
      5 # If you would like to add a new extended attribute or value, please:
      6 #     (1) add the extended attribute or value to this file
      7 #     (2) add an explanation to the Blink IDL extended attributes document:
      8 #         http://www.chromium.org/blink/webidl/blink-idl-extended-attributes
      9 #     (3) add appropriate test cases to run-bindings-tests
     10 #
     11 # The syntax of this file is as follows:
     12 #     - One extended attribute per one line: Name and (optionally) Values.
     13 #     - "Attr" means that the Attr does not take a value, i.e. [Attr].
     14 #     - "Attr=X" means that Attr takes a required value, which must be X;
     15 #       i.e. [Attr=X].
     16 #     - "Attr=X|Y|Z" means that Attr takes a required value, and the valid
     17 #       values are X, Y, and Z, and combinations thereof;
     18 #       e.g. [Attr=X], [Attr=Y], [Attr=X|Z].
     19 #       The separator must be | or &, so [Attr=X&Z] is also valid; the
     20 #       separator makes a difference for Conditional, but otherwise is simply
     21 #       a style convention.
     22 #     - "Attr=|X|Y|Z" means that Attr takes an optional value, whose valid
     23 #       values (if present) are X, Y, and Z, and combinations thereof; e.g.
     24 #       [Attr], [Attr=X], [Attr=Y], [Attr=X|Z], [Attr=X|Y|Z], [Attr=X&Z].
     25 #       Note that including an empty value in the list, as in [Attr=X||Y],
     26 #       is NOT valid: the value is optional, but empty values are not allowed.
     27 #     - "Attr=*" means that Attr takes a required value, which can be
     28 #       arbitrary and combinations thereof, e.g. [Attr=IndexedDB],
     29 #       [Attr=DeleteFunction], [Attr=X|Y].
     30 #     - "Attr=|*" means that Attr takes an optional value, which can be
     31 #       arbitrary, e.g. [Attr], [Attr=X].
     32 #     - "Attr=X|*" means that Attr takes an required value, which can be
     33 #       arbitrary, but that "X" is standard, e.g. [Attr=X], [Attr=Foo].
     34 #
     35 
     36 ActiveDOMObject
     37 ActivityLogging=ForAllWorlds|GetterForAllWorlds|SetterForAllWorlds|ForIsolatedWorlds|GetterForIsolatedWorlds|SetterForIsolatedWorlds
     38 CachedAttribute=*
     39 CallWith=ExecutionContext|ScriptState|ScriptArguments|ActiveWindow|FirstWindow|ThisValue
     40 CheckSecurity=Frame|Node
     41 Clamp
     42 Conditional=*
     43 Constructor
     44 # FIXME: remove [ConstructorCallWith=Document], as can instead use
     45 # [ConstructorCallWith=ExecutionContext] + toDocument(executionContext)
     46 ConstructorCallWith=ExecutionContext|Document
     47 Custom=|Getter|Setter|LegacyCallAsFunction|ToV8|VisitDOMWrapper|Wrap
     48 CustomConstructor
     49 CustomElementCallbacks
     50 CustomEnumerateProperty
     51 Default=NullString|Undefined
     52 DependentLifetime
     53 DeprecateAs=*
     54 DoNotCheckConstants
     55 DoNotCheckSecurity=|Setter
     56 DoNotCheckSignature
     57 EnforceRange
     58 EventConstructor
     59 ExposeJSAccessors
     60 GenerateVisitDOMWrapper=document|element|owner|ownerNode
     61 GlobalContext=Window|WorkerGlobalScope|SharedWorkerGlobalScope|DedicatedWorkerGlobalScope|ServiceWorkerGlobalScope
     62 Immutable
     63 ImplementedAs=*
     64 InitializedByEventConstructor
     65 # FIXME: We should remove this extended attribute once the needed refactoring is complete.
     66 LegacyImplementedInBaseClass
     67 MeasureAs=*
     68 NamedConstructor=*
     69 NoInterfaceObject
     70 NotEnumerable
     71 OverrideBuiltins
     72 # Valid values for [PerContextEnabled] are Context Features, in
     73 # ContextFeatures::FeatureType in Source/core/dom/ContextFeatures.h
     74 PerContextEnabled=*
     75 PerWorldBindings
     76 PutForwards=*
     77 RaisesException=|Getter|Setter|Constructor
     78 ReadOnly
     79 Reflect=|*
     80 Replaceable
     81 # Valid values for [RuntimeEnabled] are the Runtime Enabled Features, listed in
     82 # Source/core/page/RuntimeEnabledFeatures.in
     83 RuntimeEnabled=*
     84 SetReference=*
     85 SetterCallWith=ExecutionContext|ScriptState|ScriptArguments|ActiveWindow|FirstWindow
     86 SpecialWrapFor=*
     87 StrictTypeChecking
     88 TreatNullAs=NullString|*
     89 TreatReturnedNullStringAs=Null|Undefined
     90 TreatUndefinedAs=NullString|*
     91 URL
     92 Unforgeable
     93