mirror of
https://github.com/lightpanda-io/browser.git
synced 2025-10-28 22:53:28 +00:00
470 lines
19 KiB
Zig
470 lines
19 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 parser = @import("netsurf");
|
|
|
|
const jsruntime = @import("jsruntime");
|
|
const Case = jsruntime.test_utils.Case;
|
|
const checkCases = jsruntime.test_utils.checkCases;
|
|
const Variadic = jsruntime.Variadic;
|
|
|
|
const Node = @import("node.zig").Node;
|
|
const NodeList = @import("nodelist.zig").NodeList;
|
|
const NodeUnion = @import("node.zig").Union;
|
|
|
|
const Walker = @import("walker.zig").WalkerDepthFirst;
|
|
const collection = @import("html_collection.zig");
|
|
const css = @import("css.zig");
|
|
|
|
const Element = @import("element.zig").Element;
|
|
const ElementUnion = @import("element.zig").Union;
|
|
|
|
const DocumentType = @import("document_type.zig").DocumentType;
|
|
const DocumentFragment = @import("document_fragment.zig").DocumentFragment;
|
|
const DOMImplementation = @import("implementation.zig").DOMImplementation;
|
|
|
|
const UserContext = @import("../user_context.zig").UserContext;
|
|
|
|
// WEB IDL https://dom.spec.whatwg.org/#document
|
|
pub const Document = struct {
|
|
pub const Self = parser.Document;
|
|
pub const prototype = *Node;
|
|
pub const mem_guarantied = true;
|
|
|
|
pub fn constructor(userctx: UserContext) !*parser.DocumentHTML {
|
|
const doc = try parser.documentCreateDocument(
|
|
try parser.documentHTMLGetTitle(userctx.document),
|
|
);
|
|
|
|
// we have to work w/ document instead of html document.
|
|
const ddoc = parser.documentHTMLToDocument(doc);
|
|
const ccur = parser.documentHTMLToDocument(userctx.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) !*parser.Event {
|
|
// TODO: for now only "Event" constructor is supported
|
|
// see table on https://dom.spec.whatwg.org/#dom-document-createevent $2
|
|
if (std.ascii.eqlIgnoreCase(eventCstr, "Event") or std.ascii.eqlIgnoreCase(eventCstr, "Events")) {
|
|
return try parser.eventCreate();
|
|
}
|
|
return parser.DOMError.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 {
|
|
const e = try parser.documentCreateElement(self, tag_name);
|
|
return try 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,
|
|
alloc: std.mem.Allocator,
|
|
tag_name: []const u8,
|
|
) !collection.HTMLCollection {
|
|
return try collection.HTMLCollectionByTagName(alloc, parser.documentToNode(self), tag_name, true);
|
|
}
|
|
|
|
pub fn _getElementsByClassName(
|
|
self: *parser.Document,
|
|
alloc: std.mem.Allocator,
|
|
classNames: []const u8,
|
|
) !collection.HTMLCollection {
|
|
return try collection.HTMLCollectionByClassName(alloc, parser.documentToNode(self), classNames, 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 try collection.HTMLCollectionChildren(parser.documentToNode(self), 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, alloc: std.mem.Allocator, selector: []const u8) !?ElementUnion {
|
|
if (selector.len == 0) return null;
|
|
|
|
const n = try css.querySelector(alloc, parser.documentToNode(self), selector);
|
|
|
|
if (n == null) return null;
|
|
|
|
return try Element.toInterface(parser.nodeToElement(n.?));
|
|
}
|
|
|
|
pub fn _querySelectorAll(self: *parser.Document, alloc: std.mem.Allocator, selector: []const u8) !NodeList {
|
|
return css.querySelectorAll(alloc, parser.documentToNode(self), selector);
|
|
}
|
|
|
|
// TODO according with https://dom.spec.whatwg.org/#parentnode, the
|
|
// function must accept either node or string.
|
|
// blocked by https://github.com/lightpanda-io/jsruntime-lib/issues/114
|
|
pub fn _prepend(self: *parser.Document, nodes: ?Variadic(*parser.Node)) !void {
|
|
return Node.prepend(parser.documentToNode(self), nodes);
|
|
}
|
|
|
|
// TODO according with https://dom.spec.whatwg.org/#parentnode, the
|
|
// function must accept either node or string.
|
|
// blocked by https://github.com/lightpanda-io/jsruntime-lib/issues/114
|
|
pub fn _append(self: *parser.Document, nodes: ?Variadic(*parser.Node)) !void {
|
|
return Node.append(parser.documentToNode(self), nodes);
|
|
}
|
|
|
|
// TODO according with https://dom.spec.whatwg.org/#parentnode, the
|
|
// function must accept either node or string.
|
|
// blocked by https://github.com/lightpanda-io/jsruntime-lib/issues/114
|
|
pub fn _replaceChildren(self: *parser.Document, nodes: ?Variadic(*parser.Node)) !void {
|
|
return Node.replaceChildren(parser.documentToNode(self), nodes);
|
|
}
|
|
|
|
pub fn deinit(_: *parser.Document, _: std.mem.Allocator) void {}
|
|
};
|
|
|
|
// Tests
|
|
// -----
|
|
|
|
pub fn testExecFn(
|
|
_: std.mem.Allocator,
|
|
js_env: *jsruntime.Env,
|
|
) anyerror!void {
|
|
var constructor = [_]Case{
|
|
.{ .src = "document.__proto__.__proto__.constructor.name", .ex = "Document" },
|
|
.{ .src = "document.__proto__.__proto__.__proto__.constructor.name", .ex = "Node" },
|
|
.{ .src = "document.__proto__.__proto__.__proto__.__proto__.constructor.name", .ex = "EventTarget" },
|
|
|
|
.{ .src = "let newdoc = new Document()", .ex = "undefined" },
|
|
.{ .src = "newdoc.documentElement", .ex = "null" },
|
|
.{ .src = "newdoc.children.length", .ex = "0" },
|
|
.{ .src = "newdoc.getElementsByTagName('*').length", .ex = "0" },
|
|
.{ .src = "newdoc.getElementsByTagName('*').item(0)", .ex = "null" },
|
|
.{ .src = "newdoc.inputEncoding === document.inputEncoding", .ex = "true" },
|
|
.{ .src = "newdoc.documentURI === document.documentURI", .ex = "true" },
|
|
.{ .src = "newdoc.URL === document.URL", .ex = "true" },
|
|
.{ .src = "newdoc.compatMode === document.compatMode", .ex = "true" },
|
|
.{ .src = "newdoc.characterSet === document.characterSet", .ex = "true" },
|
|
.{ .src = "newdoc.charset === document.charset", .ex = "true" },
|
|
.{ .src = "newdoc.contentType === document.contentType", .ex = "true" },
|
|
};
|
|
try checkCases(js_env, &constructor);
|
|
|
|
var getElementById = [_]Case{
|
|
.{ .src = "let getElementById = document.getElementById('content')", .ex = "undefined" },
|
|
.{ .src = "getElementById.constructor.name", .ex = "HTMLDivElement" },
|
|
.{ .src = "getElementById.localName", .ex = "div" },
|
|
};
|
|
try checkCases(js_env, &getElementById);
|
|
|
|
var getElementsByTagName = [_]Case{
|
|
.{ .src = "let getElementsByTagName = document.getElementsByTagName('p')", .ex = "undefined" },
|
|
.{ .src = "getElementsByTagName.length", .ex = "2" },
|
|
.{ .src = "getElementsByTagName.item(0).localName", .ex = "p" },
|
|
.{ .src = "getElementsByTagName.item(1).localName", .ex = "p" },
|
|
.{ .src = "let getElementsByTagNameAll = document.getElementsByTagName('*')", .ex = "undefined" },
|
|
.{ .src = "getElementsByTagNameAll.length", .ex = "8" },
|
|
.{ .src = "getElementsByTagNameAll.item(0).localName", .ex = "html" },
|
|
.{ .src = "getElementsByTagNameAll.item(7).localName", .ex = "p" },
|
|
.{ .src = "getElementsByTagNameAll.namedItem('para-empty-child').localName", .ex = "span" },
|
|
};
|
|
try checkCases(js_env, &getElementsByTagName);
|
|
|
|
var getElementsByClassName = [_]Case{
|
|
.{ .src = "let ok = document.getElementsByClassName('ok')", .ex = "undefined" },
|
|
.{ .src = "ok.length", .ex = "2" },
|
|
.{ .src = "let empty = document.getElementsByClassName('empty')", .ex = "undefined" },
|
|
.{ .src = "empty.length", .ex = "1" },
|
|
.{ .src = "let emptyok = document.getElementsByClassName('empty ok')", .ex = "undefined" },
|
|
.{ .src = "emptyok.length", .ex = "1" },
|
|
};
|
|
try checkCases(js_env, &getElementsByClassName);
|
|
|
|
var getDocumentElement = [_]Case{
|
|
.{ .src = "let e = document.documentElement", .ex = "undefined" },
|
|
.{ .src = "e.localName", .ex = "html" },
|
|
};
|
|
try checkCases(js_env, &getDocumentElement);
|
|
|
|
var getCharacterSet = [_]Case{
|
|
.{ .src = "document.characterSet", .ex = "UTF-8" },
|
|
.{ .src = "document.charset", .ex = "UTF-8" },
|
|
.{ .src = "document.inputEncoding", .ex = "UTF-8" },
|
|
};
|
|
try checkCases(js_env, &getCharacterSet);
|
|
|
|
var getCompatMode = [_]Case{
|
|
.{ .src = "document.compatMode", .ex = "CSS1Compat" },
|
|
};
|
|
try checkCases(js_env, &getCompatMode);
|
|
|
|
var getContentType = [_]Case{
|
|
.{ .src = "document.contentType", .ex = "text/html" },
|
|
};
|
|
try checkCases(js_env, &getContentType);
|
|
|
|
var getDocumentURI = [_]Case{
|
|
.{ .src = "document.documentURI", .ex = "about:blank" },
|
|
.{ .src = "document.URL", .ex = "about:blank" },
|
|
};
|
|
try checkCases(js_env, &getDocumentURI);
|
|
|
|
var getImplementation = [_]Case{
|
|
.{ .src = "let impl = document.implementation", .ex = "undefined" },
|
|
};
|
|
try checkCases(js_env, &getImplementation);
|
|
|
|
var new = [_]Case{
|
|
.{ .src = "let d = new Document()", .ex = "undefined" },
|
|
.{ .src = "d.characterSet", .ex = "UTF-8" },
|
|
.{ .src = "d.URL", .ex = "about:blank" },
|
|
.{ .src = "d.documentURI", .ex = "about:blank" },
|
|
.{ .src = "d.compatMode", .ex = "CSS1Compat" },
|
|
.{ .src = "d.contentType", .ex = "text/html" },
|
|
};
|
|
try checkCases(js_env, &new);
|
|
|
|
var createDocumentFragment = [_]Case{
|
|
.{ .src = "var v = document.createDocumentFragment()", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "#document-fragment" },
|
|
};
|
|
try checkCases(js_env, &createDocumentFragment);
|
|
|
|
var createTextNode = [_]Case{
|
|
.{ .src = "var v = document.createTextNode('foo')", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "#text" },
|
|
};
|
|
try checkCases(js_env, &createTextNode);
|
|
|
|
var createCDATASection = [_]Case{
|
|
.{ .src = "var v = document.createCDATASection('foo')", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "#cdata-section" },
|
|
};
|
|
try checkCases(js_env, &createCDATASection);
|
|
|
|
var createComment = [_]Case{
|
|
.{ .src = "var v = document.createComment('foo')", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "#comment" },
|
|
.{ .src = "let v2 = v.cloneNode()", .ex = "undefined" },
|
|
};
|
|
try checkCases(js_env, &createComment);
|
|
|
|
var createProcessingInstruction = [_]Case{
|
|
.{ .src = "let pi = document.createProcessingInstruction('foo', 'bar')", .ex = "undefined" },
|
|
.{ .src = "pi.target", .ex = "foo" },
|
|
.{ .src = "let pi2 = pi.cloneNode()", .ex = "undefined" },
|
|
};
|
|
try checkCases(js_env, &createProcessingInstruction);
|
|
|
|
var importNode = [_]Case{
|
|
.{ .src = "let nimp = document.getElementById('content')", .ex = "undefined" },
|
|
.{ .src = "var v = document.importNode(nimp)", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "DIV" },
|
|
};
|
|
try checkCases(js_env, &importNode);
|
|
|
|
var createAttr = [_]Case{
|
|
.{ .src = "var v = document.createAttribute('foo')", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "foo" },
|
|
};
|
|
try checkCases(js_env, &createAttr);
|
|
|
|
var parentNode = [_]Case{
|
|
.{ .src = "document.children.length", .ex = "1" },
|
|
.{ .src = "document.children.item(0).nodeName", .ex = "HTML" },
|
|
.{ .src = "document.firstElementChild.nodeName", .ex = "HTML" },
|
|
.{ .src = "document.lastElementChild.nodeName", .ex = "HTML" },
|
|
.{ .src = "document.childElementCount", .ex = "1" },
|
|
|
|
.{ .src = "let nd = new Document()", .ex = "undefined" },
|
|
.{ .src = "nd.children.length", .ex = "0" },
|
|
.{ .src = "nd.children.item(0)", .ex = "null" },
|
|
.{ .src = "nd.firstElementChild", .ex = "null" },
|
|
.{ .src = "nd.lastElementChild", .ex = "null" },
|
|
.{ .src = "nd.childElementCount", .ex = "0" },
|
|
|
|
.{ .src = "let emptydoc = document.createElement('html')", .ex = "undefined" },
|
|
.{ .src = "emptydoc.prepend(document.createElement('html'))", .ex = "undefined" },
|
|
|
|
.{ .src = "let emptydoc2 = document.createElement('html')", .ex = "undefined" },
|
|
.{ .src = "emptydoc2.append(document.createElement('html'))", .ex = "undefined" },
|
|
};
|
|
try checkCases(js_env, &parentNode);
|
|
|
|
var querySelector = [_]Case{
|
|
.{ .src = "document.querySelector('')", .ex = "null" },
|
|
.{ .src = "document.querySelector('*').nodeName", .ex = "HTML" },
|
|
.{ .src = "document.querySelector('#content').id", .ex = "content" },
|
|
.{ .src = "document.querySelector('#para').id", .ex = "para" },
|
|
.{ .src = "document.querySelector('.ok').id", .ex = "link" },
|
|
.{ .src = "document.querySelector('a ~ p').id", .ex = "para-empty" },
|
|
.{ .src = "document.querySelector(':root').nodeName", .ex = "HTML" },
|
|
|
|
.{ .src = "document.querySelectorAll('p').length", .ex = "2" },
|
|
.{ .src =
|
|
\\Array.from(document.querySelectorAll('#content > p#para-empty'))
|
|
\\.map(row => row.querySelector('span').textContent)
|
|
\\.length;
|
|
, .ex = "1" },
|
|
};
|
|
try checkCases(js_env, &querySelector);
|
|
|
|
// this test breaks the doc structure, keep it at the end of the test
|
|
// suite.
|
|
var adoptNode = [_]Case{
|
|
.{ .src = "let nadop = document.getElementById('content')", .ex = "undefined" },
|
|
.{ .src = "var v = document.adoptNode(nadop)", .ex = "undefined" },
|
|
.{ .src = "v.nodeName", .ex = "DIV" },
|
|
};
|
|
try checkCases(js_env, &adoptNode);
|
|
|
|
const tags = comptime parser.Tag.all();
|
|
var createElements: [(tags.len) * 2]Case = undefined;
|
|
inline for (tags, 0..) |tag, i| {
|
|
const tag_name = @tagName(tag);
|
|
createElements[i * 2] = Case{
|
|
.src = "var " ++ tag_name ++ "Elem = document.createElement('" ++ tag_name ++ "')",
|
|
.ex = "undefined",
|
|
};
|
|
createElements[(i * 2) + 1] = Case{
|
|
.src = tag_name ++ "Elem.localName",
|
|
.ex = tag_name,
|
|
};
|
|
}
|
|
try checkCases(js_env, &createElements);
|
|
}
|