mirror of
https://github.com/lightpanda-io/browser.git
synced 2025-10-29 07:03:29 +00:00
332 lines
12 KiB
Zig
332 lines
12 KiB
Zig
// Copyright (C) 2023-2024 Lightpanda (Selecy SAS)
|
||
//
|
||
// Francis Bouvier <francis@lightpanda.io>
|
||
// Pierre Tachoire <pierre@lightpanda.io>
|
||
//
|
||
// This program is free software: you can redistribute it and/or modify
|
||
// it under the terms of the GNU Affero General Public License as
|
||
// published by the Free Software Foundation, either version 3 of the
|
||
// License, or (at your option) any later version.
|
||
//
|
||
// This program is distributed in the hope that it will be useful,
|
||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
// GNU Affero General Public License for more details.
|
||
//
|
||
// You should have received a copy of the GNU Affero General Public License
|
||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
|
||
const std = @import("std");
|
||
|
||
const log = @import("../../log.zig");
|
||
const parser = @import("../netsurf.zig");
|
||
const Page = @import("../page.zig").Page;
|
||
|
||
const Node = @import("node.zig").Node;
|
||
const NodeList = @import("nodelist.zig").NodeList;
|
||
const NodeUnion = @import("node.zig").Union;
|
||
|
||
const collection = @import("html_collection.zig");
|
||
const css = @import("css.zig");
|
||
|
||
const Element = @import("element.zig").Element;
|
||
const ElementUnion = @import("element.zig").Union;
|
||
const TreeWalker = @import("tree_walker.zig").TreeWalker;
|
||
const CSSStyleSheet = @import("../cssom/CSSStyleSheet.zig");
|
||
const NodeIterator = @import("node_iterator.zig").NodeIterator;
|
||
const Range = @import("range.zig").Range;
|
||
|
||
const CustomEvent = @import("../events/custom_event.zig").CustomEvent;
|
||
|
||
const Env = @import("../env.zig").Env;
|
||
|
||
const DOMImplementation = @import("implementation.zig").DOMImplementation;
|
||
|
||
// WEB IDL https://dom.spec.whatwg.org/#document
|
||
pub const Document = struct {
|
||
pub const Self = parser.Document;
|
||
pub const prototype = *Node;
|
||
pub const subtype = .node;
|
||
|
||
pub fn constructor(page: *const Page) !*parser.DocumentHTML {
|
||
const doc = try parser.documentCreateDocument(
|
||
try parser.documentHTMLGetTitle(page.window.document),
|
||
);
|
||
|
||
// we have to work w/ document instead of html document.
|
||
const ddoc = parser.documentHTMLToDocument(doc);
|
||
const ccur = parser.documentHTMLToDocument(page.window.document);
|
||
try parser.documentSetDocumentURI(ddoc, try parser.documentGetDocumentURI(ccur));
|
||
try parser.documentSetInputEncoding(ddoc, try parser.documentGetInputEncoding(ccur));
|
||
|
||
return doc;
|
||
}
|
||
|
||
// JS funcs
|
||
// --------
|
||
pub fn get_implementation(_: *parser.Document) DOMImplementation {
|
||
return DOMImplementation{};
|
||
}
|
||
|
||
pub fn get_documentElement(self: *parser.Document) !?ElementUnion {
|
||
const e = try parser.documentGetDocumentElement(self);
|
||
if (e == null) return null;
|
||
return try Element.toInterface(e.?);
|
||
}
|
||
|
||
pub fn get_documentURI(self: *parser.Document) ![]const u8 {
|
||
return try parser.documentGetDocumentURI(self);
|
||
}
|
||
|
||
pub fn get_URL(self: *parser.Document) ![]const u8 {
|
||
return try get_documentURI(self);
|
||
}
|
||
|
||
// TODO implement contentType
|
||
pub fn get_contentType(self: *parser.Document) []const u8 {
|
||
_ = self;
|
||
return "text/html";
|
||
}
|
||
|
||
// TODO implement compactMode
|
||
pub fn get_compatMode(self: *parser.Document) []const u8 {
|
||
_ = self;
|
||
return "CSS1Compat";
|
||
}
|
||
|
||
pub fn get_characterSet(self: *parser.Document) ![]const u8 {
|
||
return try parser.documentGetInputEncoding(self);
|
||
}
|
||
|
||
// alias of get_characterSet
|
||
pub fn get_charset(self: *parser.Document) ![]const u8 {
|
||
return try get_characterSet(self);
|
||
}
|
||
|
||
// alias of get_characterSet
|
||
pub fn get_inputEncoding(self: *parser.Document) ![]const u8 {
|
||
return try get_characterSet(self);
|
||
}
|
||
|
||
pub fn get_doctype(self: *parser.Document) !?*parser.DocumentType {
|
||
return try parser.documentGetDoctype(self);
|
||
}
|
||
|
||
pub fn _createEvent(_: *parser.Document, eventCstr: []const u8) !union(enum) {
|
||
base: *parser.Event,
|
||
custom: CustomEvent,
|
||
} {
|
||
const eqlIgnoreCase = std.ascii.eqlIgnoreCase;
|
||
|
||
if (eqlIgnoreCase(eventCstr, "Event") or eqlIgnoreCase(eventCstr, "Events") or eqlIgnoreCase(eventCstr, "HTMLEvents")) {
|
||
return .{ .base = try parser.eventCreate() };
|
||
}
|
||
|
||
// Not documented in MDN but supported in Chrome.
|
||
// This is actually both instance of `Event` and `CustomEvent`.
|
||
if (std.ascii.eqlIgnoreCase(eventCstr, "CustomEvent")) {
|
||
return .{ .custom = try CustomEvent.constructor(eventCstr, null) };
|
||
}
|
||
|
||
return error.NotSupported;
|
||
}
|
||
|
||
pub fn _getElementById(self: *parser.Document, id: []const u8) !?ElementUnion {
|
||
const e = try parser.documentGetElementById(self, id) orelse return null;
|
||
return try Element.toInterface(e);
|
||
}
|
||
|
||
pub fn _createElement(self: *parser.Document, tag_name: []const u8) !ElementUnion {
|
||
// The element’s namespace is the HTML namespace when document is an HTML document
|
||
// https://dom.spec.whatwg.org/#ref-for-dom-document-createelement%E2%91%A0
|
||
const e = try parser.documentCreateElementNS(self, "http://www.w3.org/1999/xhtml", tag_name);
|
||
return Element.toInterface(e);
|
||
}
|
||
|
||
pub fn _createElementNS(self: *parser.Document, ns: []const u8, tag_name: []const u8) !ElementUnion {
|
||
const e = try parser.documentCreateElementNS(self, ns, tag_name);
|
||
return try Element.toInterface(e);
|
||
}
|
||
|
||
// We can't simply use libdom dom_document_get_elements_by_tag_name here.
|
||
// Indeed, netsurf implemented a previous dom spec when
|
||
// getElementsByTagName returned a NodeList.
|
||
// But since
|
||
// https://github.com/whatwg/dom/commit/190700b7c12ecfd3b5ebdb359ab1d6ea9cbf7749
|
||
// the spec changed to return an HTMLCollection instead.
|
||
// That's why we reimplemented getElementsByTagName by using an
|
||
// HTMLCollection in zig here.
|
||
pub fn _getElementsByTagName(
|
||
self: *parser.Document,
|
||
tag_name: []const u8,
|
||
page: *Page,
|
||
) !collection.HTMLCollection {
|
||
return try collection.HTMLCollectionByTagName(page.arena, parser.documentToNode(self), tag_name, .{
|
||
.include_root = true,
|
||
});
|
||
}
|
||
|
||
pub fn _getElementsByClassName(
|
||
self: *parser.Document,
|
||
classNames: []const u8,
|
||
page: *Page,
|
||
) !collection.HTMLCollection {
|
||
return try collection.HTMLCollectionByClassName(page.arena, parser.documentToNode(self), classNames, .{
|
||
.include_root = true,
|
||
});
|
||
}
|
||
|
||
pub fn _createDocumentFragment(self: *parser.Document) !*parser.DocumentFragment {
|
||
return try parser.documentCreateDocumentFragment(self);
|
||
}
|
||
|
||
pub fn _createTextNode(self: *parser.Document, data: []const u8) !*parser.Text {
|
||
return try parser.documentCreateTextNode(self, data);
|
||
}
|
||
|
||
pub fn _createCDATASection(self: *parser.Document, data: []const u8) !*parser.CDATASection {
|
||
return try parser.documentCreateCDATASection(self, data);
|
||
}
|
||
|
||
pub fn _createComment(self: *parser.Document, data: []const u8) !*parser.Comment {
|
||
return try parser.documentCreateComment(self, data);
|
||
}
|
||
|
||
pub fn _createProcessingInstruction(self: *parser.Document, target: []const u8, data: []const u8) !*parser.ProcessingInstruction {
|
||
return try parser.documentCreateProcessingInstruction(self, target, data);
|
||
}
|
||
|
||
pub fn _importNode(self: *parser.Document, node: *parser.Node, deep: ?bool) !NodeUnion {
|
||
const n = try parser.documentImportNode(self, node, deep orelse false);
|
||
return try Node.toInterface(n);
|
||
}
|
||
|
||
pub fn _adoptNode(self: *parser.Document, node: *parser.Node) !NodeUnion {
|
||
const n = try parser.documentAdoptNode(self, node);
|
||
return try Node.toInterface(n);
|
||
}
|
||
|
||
pub fn _createAttribute(self: *parser.Document, name: []const u8) !*parser.Attribute {
|
||
return try parser.documentCreateAttribute(self, name);
|
||
}
|
||
|
||
pub fn _createAttributeNS(self: *parser.Document, ns: []const u8, qname: []const u8) !*parser.Attribute {
|
||
return try parser.documentCreateAttributeNS(self, ns, qname);
|
||
}
|
||
|
||
// ParentNode
|
||
// https://dom.spec.whatwg.org/#parentnode
|
||
pub fn get_children(self: *parser.Document) !collection.HTMLCollection {
|
||
return collection.HTMLCollectionChildren(parser.documentToNode(self), .{
|
||
.include_root = false,
|
||
});
|
||
}
|
||
|
||
pub fn get_firstElementChild(self: *parser.Document) !?ElementUnion {
|
||
const elt = try parser.documentGetDocumentElement(self) orelse return null;
|
||
return try Element.toInterface(elt);
|
||
}
|
||
|
||
pub fn get_lastElementChild(self: *parser.Document) !?ElementUnion {
|
||
const elt = try parser.documentGetDocumentElement(self) orelse return null;
|
||
return try Element.toInterface(elt);
|
||
}
|
||
|
||
pub fn get_childElementCount(self: *parser.Document) !u32 {
|
||
_ = try parser.documentGetDocumentElement(self) orelse return 0;
|
||
return 1;
|
||
}
|
||
|
||
pub fn _querySelector(self: *parser.Document, selector: []const u8, page: *Page) !?ElementUnion {
|
||
if (selector.len == 0) return null;
|
||
|
||
const n = try css.querySelector(page.call_arena, parser.documentToNode(self), selector);
|
||
|
||
if (n == null) return null;
|
||
|
||
return try Element.toInterface(parser.nodeToElement(n.?));
|
||
}
|
||
|
||
pub fn _querySelectorAll(self: *parser.Document, selector: []const u8, page: *Page) !NodeList {
|
||
return css.querySelectorAll(page.arena, parser.documentToNode(self), selector);
|
||
}
|
||
|
||
pub fn _prepend(self: *parser.Document, nodes: []const Node.NodeOrText) !void {
|
||
return Node.prepend(parser.documentToNode(self), nodes);
|
||
}
|
||
|
||
pub fn _append(self: *parser.Document, nodes: []const Node.NodeOrText) !void {
|
||
return Node.append(parser.documentToNode(self), nodes);
|
||
}
|
||
|
||
pub fn _replaceChildren(self: *parser.Document, nodes: []const Node.NodeOrText) !void {
|
||
return Node.replaceChildren(parser.documentToNode(self), nodes);
|
||
}
|
||
|
||
pub fn _createTreeWalker(_: *parser.Document, root: *parser.Node, what_to_show: ?TreeWalker.WhatToShow, filter: ?TreeWalker.TreeWalkerOpts) !TreeWalker {
|
||
return TreeWalker.init(root, what_to_show, filter);
|
||
}
|
||
|
||
pub fn _createNodeIterator(_: *parser.Document, root: *parser.Node, what_to_show: ?NodeIterator.WhatToShow, filter: ?NodeIterator.NodeIteratorOpts) !NodeIterator {
|
||
return NodeIterator.init(root, what_to_show, filter);
|
||
}
|
||
|
||
pub fn getActiveElement(self: *parser.Document, page: *Page) !?*parser.Element {
|
||
if (page.getNodeState(@ptrCast(@alignCast(self)))) |state| {
|
||
if (state.active_element) |ae| {
|
||
return ae;
|
||
}
|
||
}
|
||
|
||
if (try parser.documentHTMLBody(page.window.document)) |body| {
|
||
return @ptrCast(@alignCast(body));
|
||
}
|
||
|
||
return try parser.documentGetDocumentElement(self);
|
||
}
|
||
|
||
pub fn get_activeElement(self: *parser.Document, page: *Page) !?ElementUnion {
|
||
const ae = (try getActiveElement(self, page)) orelse return null;
|
||
return try Element.toInterface(ae);
|
||
}
|
||
|
||
// TODO: some elements can't be focused, like if they're disabled
|
||
// but there doesn't seem to be a generic way to check this. For example
|
||
// we could look for the "disabled" attribute, but that's only meaningful
|
||
// on certain types, and libdom's vtable doesn't seem to expose this.
|
||
pub fn setFocus(self: *parser.Document, e: *parser.ElementHTML, page: *Page) !void {
|
||
const state = try page.getOrCreateNodeState(@ptrCast(@alignCast(self)));
|
||
state.active_element = @ptrCast(e);
|
||
}
|
||
|
||
pub fn _createRange(_: *parser.Document, page: *Page) Range {
|
||
return Range.constructor(page);
|
||
}
|
||
|
||
// TODO: dummy implementation
|
||
pub fn get_styleSheets(_: *parser.Document) []CSSStyleSheet {
|
||
return &.{};
|
||
}
|
||
|
||
pub fn get_adoptedStyleSheets(self: *parser.Document, page: *Page) !Env.JsObject {
|
||
const state = try page.getOrCreateNodeState(@ptrCast(@alignCast(self)));
|
||
if (state.adopted_style_sheets) |obj| {
|
||
return obj;
|
||
}
|
||
|
||
const obj = try page.main_context.newArray(0).persist();
|
||
state.adopted_style_sheets = obj;
|
||
return obj;
|
||
}
|
||
|
||
pub fn set_adoptedStyleSheets(self: *parser.Document, sheets: Env.JsObject, page: *Page) !void {
|
||
const state = try page.getOrCreateNodeState(@ptrCast(@alignCast(self)));
|
||
state.adopted_style_sheets = try sheets.persist();
|
||
}
|
||
};
|
||
|
||
const testing = @import("../../testing.zig");
|
||
test "Browser: DOM.Document" {
|
||
try testing.htmlRunner("dom/document.html");
|
||
}
|