mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-25 09:00:22 +00:00
86744449e3
Separating out the browser documentation doesn't make much sense now that we are only a browser. :^)
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
# Adding a new IDL file
|
|
|
|
Serenity's build system does a lot of work of turning the IDL from a Web spec into code, but there are a few things you'll need to do yourself.
|
|
|
|
For the sake of example, let's say you're wanting to add the `HTMLDetailsElement`.
|
|
|
|
1. Create `LibWeb/HTML/HTMLDetailsElement.idl` with the contents of the IDL section of the spec. In this case, that would be:
|
|
```webidl
|
|
[Exposed=Window]
|
|
interface HTMLDetailsElement : HTMLElement {
|
|
[HTMLConstructor] constructor();
|
|
|
|
[CEReactions] attribute boolean open;
|
|
};
|
|
```
|
|
|
|
2. If the IDL refers to other IDL types, you need to import those. For example, `CSSRule` has an attribute that returns a `CSSStyleSheet`, so that needs to be imported:
|
|
```webidl
|
|
#import <CSS/CSSStyleSheet.idl>
|
|
|
|
interface CSSRule {
|
|
readonly attribute CSSStyleSheet? parentStyleSheet;
|
|
};
|
|
```
|
|
|
|
3. Add a `libweb_js_bindings(HTML/HTMLDetailsElement)` call to [`LibWeb/idl_files.cmake`](../Userland/Libraries/LibWeb/idl_files.cmake)
|
|
|
|
4. Forward declare the generated class in [`LibWeb/Forward.h`](../Userland/Libraries/LibWeb/Forward.h):
|
|
- `HTMLDetailsElement` in its namespace.
|
|
|
|
5. If your type isn't an Event or Element, you will need to add it to [`is_platform_object()`](../Meta/Lagom/Tools/CodeGenerators/LibWeb/BindingsGenerator/IDLGenerators.cpp)
|
|
so that it can be accepted as an IDL parameter, attribute or return type.
|