Changes between Version 16 and Version 17 of WebKitIDL

Timestamp:

Feb 13, 2012, 12:36:40 AM (13 years ago)

Author:

haraken@chromium.org

Comment:

--

WebKitIDL

@@ -25 +25 @@
 == IDL attributes around operations, attributes and parameters ==
 
+In the following explanations, (i), (o), (a) and (p) means that the IDL attribute can be specified on interfaces, operations, attributes and parameters, respectively. For example, (a,p) means that the IDL attribute can be specified on attributes and parameters.
+
 === * [TreatNullAs](a,p), [TreatUndefinedAs](a,p) ===
+
+ * [http://dev.w3.org/2006/webapi/WebIDL/#TreatNullAs The spec of [TreatNullAs]] (Note: The WebKit IDL explained below behaves differently from the spec)
+ * [http://dev.w3.org/2006/webapi/WebIDL/#TreatUndefinedAs The spec of [TreatUndefinedAs]] (Note: The WebKit IDL explained below behaves differently from the spec)
+
+The possible usage is [TreatNullAs=NullString] or [TreatUndefinedAs=NullString].
+They can be specified on attributes or parameters of type DOMString only, like this:
+
+{{{
+    attribute [TreatNullAs=NullString] DOMString str;
+    void operation(in [TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString str);
+}}}
+
+[TreatNullAs=NullString] indicates that if JavaScript null is passed to the attribute/parameter,
+then it is converted to the null string in WebKit, for which String::IsEmpty() and String::IsNull() will return true.
+Without [TreatNullAs=NullString], JavaScript null is converted to a string "null" in WebKit.
+
+[TreatNullAs=NullString] corresponds to [TreatNullAs=EmptyString] in the Web IDL spec.
+Unless the spec does not specify [TreatNullAs=EmptyString], you should not specify [TreatNullAs=NullString] in WebKit.
+
+[TreatUndefinedAs=NullString] indicates that if JavaScript undefined is passed to the attribute/parameter,
+then it is converted to the null string in WebKit, for which IsEmpty() and IsNull() will return true.
+Without [TreatUndefinedAs=NullString], JavaScript undefined is converted to a string "undefined" in WebKit.
+
+[TreatUndefinedAs=NullString] corresponds to [TreatUndefinedAs=EmptyString] in the Web IDL spec.
+Unless the spec does not specify [TreatUndefinedAs=EmptyString], you should not specify [TreatUndefinedAs=NullString] in WebKit.
+
+Note: For now the sole usage of [TreatUndefinedAs=NullString] is not allowed in WebKit.
+[TreatUndefinedAs=NullString] must be used with [TreatNullAs=NullString], i.e. [TreatNullAs=NullString, TreatUndefinedAs=NullString].
+
 
 === * [TreatReturnedNullStringAs](o,a,p) ===
@@ -63 +94 @@
 === * [Supplemental](i) ===
 
- * [http://dev.w3.org/2006/webapi/WebIDL/#dfn-supplemental-interface The spec]
+ * [http://dev.w3.org/2006/webapi/WebIDL/#dfn-supplemental-interface The spec of [Supplemental]]
 
- * [http://old.nabble.com/Things-missing-from-Web-IDL-for-HTML5-td24873773.html Easy explanation]
+ * [http://old.nabble.com/Things-missing-from-Web-IDL-for-HTML5-td24873773.html Easy explanation of [Supplemental]]
 
 The [Supplemental] IDL helps WebKit modularization. The [Supplemental] IDL makes it possible to add XXX's APIs (e.g. XXX=WebAudio, WebSocket, Blob, GamePad, ...etc) without modifying code outside of WebCore/Modules/XXX/. This helps make XXX a "self-contained module".