Changes between Version 57 and Version 58 of WebKitIDL

Timestamp:

Feb 21, 2012, 4:55:29 PM (13 years ago)

Author:

haraken@chromium.org

Comment:

--

WebKitIDL

@@ -5 +5 @@
 [#Overview Overview][[br]]
 [#Basics Basics of IDL][[br]]
+[#IDLAttributeChecker IDL attribute checker][[br]]
+[#RunBindingsTests run-bindings-tests][[br]]
 [#BindingsCode Where is the bindings code generated?][[br]]
 [#NamingRules Basic naming rules of IDL attributes][[br]]
@@ -82 +84 @@
 Let us introduce some terminologies:
 
- * The above IDL file describes the Node ''''interface''''.
- * ELEMENT_NODE is a ''''constant'''' of the Node interface.
- * parentNode and nodeName are ''''attribute''''s of the Node interface.
- * appendChild(...) and addEventListener(...) are ''''method''''s of the Node interface.
- * type, listener and useCapture are ''''parameter''''s of the Node interface.
- * [JSCustomHeader], [CustomToJSObject], [TreatReturnedNullStringAs=Null], [Custom], [CustomReturn] and [Optional] are ''''IDL attribute''''s.
+ * The above IDL file describes the Node '''interface'''.
+ * ELEMENT_NODE is a '''constant''' of the Node interface.
+ * parentNode and nodeName are '''attribute'''s of the Node interface.
+ * appendChild(...) and addEventListener(...) are '''method'''s of the Node interface.
+ * type, listener and useCapture are '''parameter'''s of the Node interface.
+ * [JSCustomHeader], [CustomToJSObject], [TreatReturnedNullStringAs=Null], [Custom], [CustomReturn] and [Optional] are '''IDL attribute'''s.
 
 Note: These terminologies are not aligned with the Web IDL spec.
@@ -127 +129 @@
 }
 }}}
+
+= IDL attribute checker = #IDLAttributeChecker
+
+Previously there had been many bugs caused by typos of IDL attributes in IDL files.
+To avoid such bugs, the IDL attribute checker is introduced to the WebKit build flow
+to check if all the IDL attributes used in IDL files are implemented in code generators.
+If you use an IDL attribute not implemented in code generators, the IDL attribute checker fails, and the WebKit build fails.
+
+A list of IDL attributes implemented in code generators is described in WebCore/bindings/scripts/IDLAttributes.txt.
+If you want to add a new IDL attribute, you need to
+
+ 1. add the IDL attribute to WebCore/bindings/scripts/IDLAttributes.txt.
+ 1. add the explanation to this document.
+ 1. add test cases to run-bindings-tests (explained below).
+
+= run-bindings-tests = #RunBindingsTests
+
+Tools/Scripts/run-bindings-tests tests IDL attributes.
+Specifically, run-bindings-tests reads WebCore/bindings/scripts/test/*.idl,
+and then generates bindings code to WebCore/bindings/scripts/test/{JS,V8,ObjC,GObject,CPP}/*.
+For example, run-bindings-tests reads WebCore/bindings/scripts/test/TestObj.idl,
+and then generates bindings code to WebCore/bindings/scripts/test/JS/JSTestObj.h, WebCore/bindings/scripts/test/JS/JSTestObj.cpp, etc.
+
+If you change the behavior of code generators or add a new IDL attribute,
+please add test cases to WebCore/bindings/scripts/test/*.idl.
+You can reset the results of run-bindings-tests using the --reset-results option:
+{{{
+    $ ./Tools/Scripts/run-bindings-tests --reset-results
+}}}
+
+'''The objective of run-bindings-tests is to show you and reviewers how the code generation is changed by your patch.
+If you change the behavior of code generators, please update the results of run-bindings-tests'''.
+
+That being said, people 
+
 
 = Where is the bindings code generated? = #BindingsCode