/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this file, * You can obtain one at http://mozilla.org/MPL/2.0/. */ [Constructor, Constructor(DOMString str), Constructor(unsigned long num, boolean? boolArg), Constructor(TestInterface? iface), Constructor(long arg1, IndirectlyImplementedInterface iface), // Constructor(long arg1, long arg2, (TestInterface or OnlyForUseInConstructor) arg3), NamedConstructor=Example, NamedConstructor=Example(DOMString str), NamedConstructor=Example2(DictForConstructor dict, any any1, object obj1, object? obj2, sequence seq, optional any any2, optional object obj3, optional object? obj4) ] interface TestExampleInterface { // Integer types // XXXbz add tests for throwing versions of all the integer stuff readonly attribute byte readonlyByte; attribute byte writableByte; void passByte(byte arg); byte receiveByte(); void passOptionalByte(optional byte arg); void passOptionalByteBeforeRequired(optional byte arg1, byte arg2); void passOptionalByteWithDefault(optional byte arg = 0); void passOptionalByteWithDefaultBeforeRequired(optional byte arg1 = 0, byte arg2); void passNullableByte(byte? arg); void passOptionalNullableByte(optional byte? arg); void passVariadicByte(byte... arg); readonly attribute short readonlyShort; attribute short writableShort; void passShort(short arg); short receiveShort(); void passOptionalShort(optional short arg); void passOptionalShortWithDefault(optional short arg = 5); readonly attribute long readonlyLong; attribute long writableLong; void passLong(long arg); long receiveLong(); void passOptionalLong(optional long arg); void passOptionalLongWithDefault(optional long arg = 7); readonly attribute long long readonlyLongLong; attribute long long writableLongLong; void passLongLong(long long arg); long long receiveLongLong(); void passOptionalLongLong(optional long long arg); void passOptionalLongLongWithDefault(optional long long arg = -12); readonly attribute octet readonlyOctet; attribute octet writableOctet; void passOctet(octet arg); octet receiveOctet(); void passOptionalOctet(optional octet arg); void passOptionalOctetWithDefault(optional octet arg = 19); readonly attribute unsigned short readonlyUnsignedShort; attribute unsigned short writableUnsignedShort; void passUnsignedShort(unsigned short arg); unsigned short receiveUnsignedShort(); void passOptionalUnsignedShort(optional unsigned short arg); void passOptionalUnsignedShortWithDefault(optional unsigned short arg = 2); readonly attribute unsigned long readonlyUnsignedLong; attribute unsigned long writableUnsignedLong; void passUnsignedLong(unsigned long arg); unsigned long receiveUnsignedLong(); void passOptionalUnsignedLong(optional unsigned long arg); void passOptionalUnsignedLongWithDefault(optional unsigned long arg = 6); readonly attribute unsigned long long readonlyUnsignedLongLong; attribute unsigned long long writableUnsignedLongLong; void passUnsignedLongLong(unsigned long long arg); unsigned long long receiveUnsignedLongLong(); void passOptionalUnsignedLongLong(optional unsigned long long arg); void passOptionalUnsignedLongLongWithDefault(optional unsigned long long arg = 17); attribute float writableFloat; attribute unrestricted float writableUnrestrictedFloat; attribute float? writableNullableFloat; attribute unrestricted float? writableNullableUnrestrictedFloat; attribute double writableDouble; attribute unrestricted double writableUnrestrictedDouble; attribute double? writableNullableDouble; attribute unrestricted double? writableNullableUnrestrictedDouble; void passFloat(float arg1, unrestricted float arg2, float? arg3, unrestricted float? arg4, double arg5, unrestricted double arg6, double? arg7, unrestricted double? arg8, sequence arg9, sequence arg10, sequence arg11, sequence arg12, sequence arg13, sequence arg14, sequence arg15, sequence arg16); [LenientFloat] void passLenientFloat(float arg1, unrestricted float arg2, float? arg3, unrestricted float? arg4, double arg5, unrestricted double arg6, double? arg7, unrestricted double? arg8, sequence arg9, sequence arg10, sequence arg11, sequence arg12, sequence arg13, sequence arg14, sequence arg15, sequence arg16); [LenientFloat] attribute float lenientFloatAttr; [LenientFloat] attribute double lenientDoubleAttr; // Castable interface types // XXXbz add tests for throwing versions of all the castable interface stuff TestInterface receiveSelf(); TestInterface? receiveNullableSelf(); TestInterface receiveWeakSelf(); TestInterface? receiveWeakNullableSelf(); void passSelf(TestInterface arg); void passNullableSelf(TestInterface? arg); attribute TestInterface nonNullSelf; attribute TestInterface? nullableSelf; // Optional arguments void passOptionalSelf(optional TestInterface? arg); void passOptionalNonNullSelf(optional TestInterface arg); void passOptionalSelfWithDefault(optional TestInterface? arg = null); // Non-wrapper-cache interface types [NewObject] TestNonWrapperCacheInterface receiveNonWrapperCacheInterface(); [NewObject] TestNonWrapperCacheInterface? receiveNullableNonWrapperCacheInterface(); [NewObject] sequence receiveNonWrapperCacheInterfaceSequence(); [NewObject] sequence receiveNullableNonWrapperCacheInterfaceSequence(); [NewObject] sequence? receiveNonWrapperCacheInterfaceNullableSequence(); [NewObject] sequence? receiveNullableNonWrapperCacheInterfaceNullableSequence(); // Non-castable interface types IndirectlyImplementedInterface receiveOther(); IndirectlyImplementedInterface? receiveNullableOther(); IndirectlyImplementedInterface receiveWeakOther(); IndirectlyImplementedInterface? receiveWeakNullableOther(); void passOther(IndirectlyImplementedInterface arg); void passNullableOther(IndirectlyImplementedInterface? arg); attribute IndirectlyImplementedInterface nonNullOther; attribute IndirectlyImplementedInterface? nullableOther; // Optional arguments void passOptionalOther(optional IndirectlyImplementedInterface? arg); void passOptionalNonNullOther(optional IndirectlyImplementedInterface arg); void passOptionalOtherWithDefault(optional IndirectlyImplementedInterface? arg = null); // External interface types TestExternalInterface receiveExternal(); TestExternalInterface? receiveNullableExternal(); TestExternalInterface receiveWeakExternal(); TestExternalInterface? receiveWeakNullableExternal(); void passExternal(TestExternalInterface arg); void passNullableExternal(TestExternalInterface? arg); attribute TestExternalInterface nonNullExternal; attribute TestExternalInterface? nullableExternal; // Optional arguments void passOptionalExternal(optional TestExternalInterface? arg); void passOptionalNonNullExternal(optional TestExternalInterface arg); void passOptionalExternalWithDefault(optional TestExternalInterface? arg = null); // Callback interface types TestCallbackInterface receiveCallbackInterface(); TestCallbackInterface? receiveNullableCallbackInterface(); TestCallbackInterface receiveWeakCallbackInterface(); TestCallbackInterface? receiveWeakNullableCallbackInterface(); void passCallbackInterface(TestCallbackInterface arg); void passNullableCallbackInterface(TestCallbackInterface? arg); attribute TestCallbackInterface nonNullCallbackInterface; attribute TestCallbackInterface? nullableCallbackInterface; // Optional arguments void passOptionalCallbackInterface(optional TestCallbackInterface? arg); void passOptionalNonNullCallbackInterface(optional TestCallbackInterface arg); void passOptionalCallbackInterfaceWithDefault(optional TestCallbackInterface? arg = null); // Miscellaneous interface tests IndirectlyImplementedInterface receiveConsequentialInterface(); void passConsequentialInterface(IndirectlyImplementedInterface arg); // Sequence types sequence receiveSequence(); sequence? receiveNullableSequence(); sequence receiveSequenceOfNullableInts(); sequence? receiveNullableSequenceOfNullableInts(); void passSequence(sequence arg); void passNullableSequence(sequence? arg); void passSequenceOfNullableInts(sequence arg); void passOptionalSequenceOfNullableInts(optional sequence arg); void passOptionalNullableSequenceOfNullableInts(optional sequence? arg); sequence receiveCastableObjectSequence(); sequence receiveCallbackObjectSequence(); sequence receiveNullableCastableObjectSequence(); sequence receiveNullableCallbackObjectSequence(); sequence? receiveCastableObjectNullableSequence(); sequence? receiveNullableCastableObjectNullableSequence(); sequence receiveWeakCastableObjectSequence(); sequence receiveWeakNullableCastableObjectSequence(); sequence? receiveWeakCastableObjectNullableSequence(); sequence? receiveWeakNullableCastableObjectNullableSequence(); void passCastableObjectSequence(sequence arg); void passNullableCastableObjectSequence(sequence arg); void passCastableObjectNullableSequence(sequence? arg); void passNullableCastableObjectNullableSequence(sequence? arg); void passOptionalSequence(optional sequence arg); void passOptionalNullableSequence(optional sequence? arg); void passOptionalNullableSequenceWithDefaultValue(optional sequence? arg = null); void passOptionalObjectSequence(optional sequence arg); void passExternalInterfaceSequence(sequence arg); void passNullableExternalInterfaceSequence(sequence arg); sequence receiveStringSequence(); void passStringSequence(sequence arg); sequence receiveByteStringSequence(); void passByteStringSequence(sequence arg); sequence receiveAnySequence(); sequence? receiveNullableAnySequence(); //XXXbz No support for sequence of sequence return values yet. //sequence> receiveAnySequenceSequence(); sequence receiveObjectSequence(); sequence receiveNullableObjectSequence(); void passSequenceOfSequences(sequence> arg); //XXXbz No support for sequence of sequence return values yet. //sequence> receiveSequenceOfSequences(); // Typed array types void passArrayBuffer(ArrayBuffer arg); void passNullableArrayBuffer(ArrayBuffer? arg); void passOptionalArrayBuffer(optional ArrayBuffer arg); void passOptionalNullableArrayBuffer(optional ArrayBuffer? arg); void passOptionalNullableArrayBufferWithDefaultValue(optional ArrayBuffer? arg= null); void passArrayBufferView(ArrayBufferView arg); void passInt8Array(Int8Array arg); void passInt16Array(Int16Array arg); void passInt32Array(Int32Array arg); void passUint8Array(Uint8Array arg); void passUint16Array(Uint16Array arg); void passUint32Array(Uint32Array arg); void passUint8ClampedArray(Uint8ClampedArray arg); void passFloat32Array(Float32Array arg); void passFloat64Array(Float64Array arg); void passSequenceOfArrayBuffers(sequence arg); void passSequenceOfNullableArrayBuffers(sequence arg); void passVariadicTypedArray(Float32Array... arg); void passVariadicNullableTypedArray(Float32Array?... arg); Uint8Array receiveUint8Array(); // DOMString types void passString(DOMString arg); void passNullableString(DOMString? arg); void passOptionalString(optional DOMString arg); void passOptionalStringWithDefaultValue(optional DOMString arg = "abc"); void passOptionalNullableString(optional DOMString? arg); void passOptionalNullableStringWithDefaultValue(optional DOMString? arg = null); void passVariadicString(DOMString... arg); // ByteString types void passByteString(ByteString arg); void passNullableByteString(ByteString? arg); void passOptionalByteString(optional ByteString arg); void passOptionalNullableByteString(optional ByteString? arg); void passVariadicByteString(ByteString... arg); // Enumerated types void passEnum(TestEnum arg); void passNullableEnum(TestEnum? arg); void passOptionalEnum(optional TestEnum arg); void passEnumWithDefault(optional TestEnum arg = "a"); void passOptionalNullableEnum(optional TestEnum? arg); void passOptionalNullableEnumWithDefaultValue(optional TestEnum? arg = null); void passOptionalNullableEnumWithDefaultValue2(optional TestEnum? arg = "a"); TestEnum receiveEnum(); TestEnum? receiveNullableEnum(); attribute TestEnum enumAttribute; readonly attribute TestEnum readonlyEnumAttribute; // Callback types void passCallback(TestCallback arg); void passNullableCallback(TestCallback? arg); void passOptionalCallback(optional TestCallback arg); void passOptionalNullableCallback(optional TestCallback? arg); void passOptionalNullableCallbackWithDefaultValue(optional TestCallback? arg = null); TestCallback receiveCallback(); TestCallback? receiveNullableCallback(); void passNullableTreatAsNullCallback(TestTreatAsNullCallback? arg); void passOptionalNullableTreatAsNullCallback(optional TestTreatAsNullCallback? arg); void passOptionalNullableTreatAsNullCallbackWithDefaultValue(optional TestTreatAsNullCallback? arg = null); // Any types void passAny(any arg); void passVariadicAny(any... arg); void passOptionalAny(optional any arg); void passAnyDefaultNull(optional any arg = null); void passSequenceOfAny(sequence arg); void passNullableSequenceOfAny(sequence? arg); void passOptionalSequenceOfAny(optional sequence arg); void passOptionalNullableSequenceOfAny(optional sequence? arg); void passOptionalSequenceOfAnyWithDefaultValue(optional sequence? arg = null); void passSequenceOfSequenceOfAny(sequence> arg); void passSequenceOfNullableSequenceOfAny(sequence?> arg); void passNullableSequenceOfNullableSequenceOfAny(sequence?>? arg); void passOptionalNullableSequenceOfNullableSequenceOfAny(optional sequence?>? arg); any receiveAny(); // object types void passObject(object arg); void passVariadicObject(object... arg); void passNullableObject(object? arg); void passVariadicNullableObject(object... arg); void passOptionalObject(optional object arg); void passOptionalNullableObject(optional object? arg); void passOptionalNullableObjectWithDefaultValue(optional object? arg = null); void passSequenceOfObject(sequence arg); void passSequenceOfNullableObject(sequence arg); void passNullableSequenceOfObject(sequence? arg); void passOptionalNullableSequenceOfNullableSequenceOfObject(optional sequence?>? arg); void passOptionalNullableSequenceOfNullableSequenceOfNullableObject(optional sequence?>? arg); object receiveObject(); object? receiveNullableObject(); // Union types void passUnion((object or long) arg); // Some union tests are debug-only to avoid creating all those // unused union types in opt builds. #ifdef DEBUG void passUnion2((long or boolean) arg); void passUnion3((object or long or boolean) arg); void passUnion4((Node or long or boolean) arg); void passUnion5((object or boolean) arg); void passUnion6((object or DOMString) arg); void passUnion7((object or DOMString or long) arg); void passUnion8((object or DOMString or boolean) arg); void passUnion9((object or DOMString or long or boolean) arg); void passUnion10(optional (EventInit or long) arg); void passUnion11(optional (CustomEventInit or long) arg); void passUnion12(optional (EventInit or long) arg = 5); void passUnion13(optional (object or long?) arg = null); void passUnion14(optional (object or long?) arg = 5); #endif void passUnionWithNullable((object? or long) arg); void passNullableUnion((object or long)? arg); void passOptionalUnion(optional (object or long) arg); void passOptionalNullableUnion(optional (object or long)? arg); void passOptionalNullableUnionWithDefaultValue(optional (object or long)? arg = null); //void passUnionWithInterfaces((TestInterface or TestExternalInterface) arg); //void passUnionWithInterfacesAndNullable((TestInterface? or TestExternalInterface) arg); //void passUnionWithSequence((sequence or long) arg); void passUnionWithArrayBuffer((ArrayBuffer or long) arg); void passUnionWithString((DOMString or object) arg); //void passUnionWithEnum((TestEnum or object) arg); // Trying to use a callback in a union won't include the test // headers, unfortunately, so won't compile. // void passUnionWithCallback((TestCallback or long) arg); void passUnionWithObject((object or long) arg); //void passUnionWithDict((Dict or long) arg); void passUnionWithDefaultValue1(optional (double or DOMString) arg = ""); void passUnionWithDefaultValue2(optional (double or DOMString) arg = 1); void passUnionWithDefaultValue3(optional (double or DOMString) arg = 1.5); void passUnionWithDefaultValue4(optional (float or DOMString) arg = ""); void passUnionWithDefaultValue5(optional (float or DOMString) arg = 1); void passUnionWithDefaultValue6(optional (float or DOMString) arg = 1.5); void passUnionWithDefaultValue7(optional (unrestricted double or DOMString) arg = ""); void passUnionWithDefaultValue8(optional (unrestricted double or DOMString) arg = 1); void passUnionWithDefaultValue9(optional (unrestricted double or DOMString) arg = 1.5); void passUnionWithDefaultValue10(optional (unrestricted double or DOMString) arg = Infinity); void passUnionWithDefaultValue11(optional (unrestricted float or DOMString) arg = ""); void passUnionWithDefaultValue12(optional (unrestricted float or DOMString) arg = 1); void passUnionWithDefaultValue13(optional (unrestricted float or DOMString) arg = Infinity); void passNullableUnionWithDefaultValue1(optional (double or DOMString)? arg = ""); void passNullableUnionWithDefaultValue2(optional (double or DOMString)? arg = 1); void passNullableUnionWithDefaultValue3(optional (double or DOMString)? arg = null); void passNullableUnionWithDefaultValue4(optional (float or DOMString)? arg = ""); void passNullableUnionWithDefaultValue5(optional (float or DOMString)? arg = 1); void passNullableUnionWithDefaultValue6(optional (float or DOMString)? arg = null); void passNullableUnionWithDefaultValue7(optional (unrestricted double or DOMString)? arg = ""); void passNullableUnionWithDefaultValue8(optional (unrestricted double or DOMString)? arg = 1); void passNullableUnionWithDefaultValue9(optional (unrestricted double or DOMString)? arg = null); void passNullableUnionWithDefaultValue10(optional (unrestricted float or DOMString)? arg = ""); void passNullableUnionWithDefaultValue11(optional (unrestricted float or DOMString)? arg = 1); void passNullableUnionWithDefaultValue12(optional (unrestricted float or DOMString)? arg = null); //(CanvasPattern or CanvasGradient) receiveUnion(); //(object or long) receiveUnion2(); //(CanvasPattern? or CanvasGradient) receiveUnionContainingNull(); //(CanvasPattern or CanvasGradient)? receiveNullableUnion(); //(object or long)? receiveNullableUnion2(); //attribute (CanvasPattern or CanvasGradient) writableUnion; //attribute (CanvasPattern? or CanvasGradient) writableUnionContainingNull; //attribute (CanvasPattern or CanvasGradient)? writableNullableUnion; // Date types void passDate(Date arg); void passNullableDate(Date? arg); void passOptionalDate(optional Date arg); void passOptionalNullableDate(optional Date? arg); void passOptionalNullableDateWithDefaultValue(optional Date? arg = null); void passDateSequence(sequence arg); void passNullableDateSequence(sequence arg); Date receiveDate(); Date? receiveNullableDate(); // binaryNames tests void methodRenamedFrom(); void methodRenamedFrom(byte argument); readonly attribute byte attributeGetterRenamedFrom; attribute byte attributeRenamedFrom; void passDictionary(optional Dict x); // FIXME: Bug 863949 no dictionary return values in callbacks // Dict receiveDictionary(); // Dict? receiveNullableDictionary(); void passOtherDictionary(optional GrandparentDict x); void passSequenceOfDictionaries(sequence x); // No support for nullable dictionaries inside a sequence (nor should there be) // void passSequenceOfNullableDictionaries(sequence x); void passDictionaryOrLong(optional Dict x); void passDictionaryOrLong(long x); void passDictContainingDict(optional DictContainingDict arg); void passDictContainingSequence(optional DictContainingSequence arg); //UNSUPPORTED DictContainingSequence receiveDictContainingSequence(); // EnforceRange/Clamp tests void dontEnforceRangeOrClamp(byte arg); void doEnforceRange([EnforceRange] byte arg); void doClamp([Clamp] byte arg); [EnforceRange] attribute byte enforcedByte; [Clamp] attribute byte clampedByte; // Typedefs const myLong myLongConstant = 5; void exerciseTypedefInterfaces1(AnotherNameForTestInterface arg); AnotherNameForTestInterface exerciseTypedefInterfaces2(NullableTestInterface arg); void exerciseTypedefInterfaces3(YetAnotherNameForTestInterface arg); // Static methods and attributes static attribute boolean staticAttribute; static void staticMethod(boolean arg); static void staticMethodWithContext(any arg); // Overload resolution tests //void overload1(DOMString... strs); boolean overload1(TestInterface arg); TestInterface overload1(DOMString strs, TestInterface arg); void overload2(TestInterface arg); void overload2(optional Dict arg); void overload2(boolean arg); void overload2(DOMString arg); void overload2(Date arg); void overload3(TestInterface arg); void overload3(TestCallback arg); void overload3(boolean arg); void overload4(TestInterface arg); void overload4(TestCallbackInterface arg); void overload4(DOMString arg); void overload5(long arg); void overload5(TestEnum arg); void overload6(long arg); void overload6(boolean arg); void overload7(long arg); void overload7(boolean arg); void overload7(ByteString arg); void overload8(long arg); void overload8(TestInterface arg); void overload9(long? arg); void overload9(DOMString arg); void overload10(long? arg); void overload10(object arg); void overload11(long arg); void overload11(DOMString? arg); void overload12(long arg); void overload12(boolean? arg); void overload13(long? arg); void overload13(boolean arg); void overload14(optional long arg); void overload14(TestInterface arg); void overload15(long arg); void overload15(optional TestInterface arg); void overload16(long arg); void overload16(optional TestInterface? arg); // Variadic handling void passVariadicThirdArg(DOMString arg1, long arg2, TestInterface... arg3); // Conditionally exposed methods/attributes [Pref="abc.def"] readonly attribute boolean prefable1; [Pref="abc.def"] readonly attribute boolean prefable2; [Pref="ghi.jkl"] readonly attribute boolean prefable3; [Pref="ghi.jkl"] readonly attribute boolean prefable4; [Pref="abc.def"] readonly attribute boolean prefable5; [Pref="abc.def", Func="nsGenericHTMLElement::TouchEventsEnabled"] readonly attribute boolean prefable6; [Pref="abc.def", Func="nsGenericHTMLElement::TouchEventsEnabled"] readonly attribute boolean prefable7; [Pref="ghi.jkl", Func="nsGenericHTMLElement::TouchEventsEnabled"] readonly attribute boolean prefable8; [Pref="abc.def", Func="nsGenericHTMLElement::TouchEventsEnabled"] readonly attribute boolean prefable9; [Pref="abc.def"] void prefable10(); [Pref="abc.def", Func="nsGenericHTMLElement::TouchEventsEnabled"] void prefable11(); [Pref="abc.def", Func="TestFuncControlledMember"] readonly attribute boolean prefable12; [Pref="abc.def", Func="nsGenericHTMLElement::TouchEventsEnabled"] void prefable13(); [Pref="abc.def", Func="TestFuncControlledMember"] readonly attribute boolean prefable14; [Func="TestFuncControlledMember"] readonly attribute boolean prefable15; [Func="TestFuncControlledMember"] readonly attribute boolean prefable16; [Pref="abc.def", Func="TestFuncControlledMember"] void prefable17(); [Func="TestFuncControlledMember"] void prefable18(); [Func="TestFuncControlledMember"] void prefable19(); // Miscellania [LenientThis] attribute long attrWithLenientThis; [Unforgeable] readonly attribute long unforgeableAttr; [Unforgeable, ChromeOnly] readonly attribute long unforgeableAttr2; stringifier; void passRenamedInterface(TestRenamedInterface arg); [PutForwards=writableByte] readonly attribute TestExampleInterface putForwardsAttr; [PutForwards=writableByte, LenientThis] readonly attribute TestExampleInterface putForwardsAttr2; [PutForwards=writableByte, ChromeOnly] readonly attribute TestExampleInterface putForwardsAttr3; [Throws] void throwingMethod(); [Throws] attribute boolean throwingAttr; [GetterThrows] attribute boolean throwingGetterAttr; [SetterThrows] attribute boolean throwingSetterAttr; legacycaller short(unsigned long arg1, TestInterface arg2); void passArgsWithDefaults(optional long arg1, optional TestInterface? arg2 = null, optional Dict arg3, optional double arg4 = 5.0, optional float arg5); attribute any jsonifierShouldSkipThis; attribute TestParentInterface jsonifierShouldSkipThis2; attribute TestCallbackInterface jsonifierShouldSkipThis3; jsonifier; // If you add things here, add them to TestCodeGen and TestJSImplGen as well }; interface TestExampleProxyInterface { getter long longIndexedGetter(unsigned long ix); deleter void (unsigned long ix); setter creator void longIndexedSetter(unsigned long y, long z); stringifier DOMString myStringifier(); getter short shortNameGetter(DOMString nom); deleter void (DOMString nomnom); setter creator void shortNamedSetter(DOMString me, short value); };