From 1085950b88be3fc9ca6f4bbeb67cd0c179c235f3 Mon Sep 17 00:00:00 2001 From: Halil Durak Date: Thu, 30 Oct 2025 16:08:03 +0300 Subject: [PATCH] initial `Blob` support --- src/browser/file/Blob.zig | 145 +++++++++++++++++++++++++++++ src/browser/{xhr => file}/File.zig | 8 +- src/browser/file/root.zig | 7 ++ src/browser/js/types.zig | 2 +- src/tests/file/blob.html | 18 ++++ src/tests/{xhr => file}/file.html | 3 +- 6 files changed, 176 insertions(+), 7 deletions(-) create mode 100644 src/browser/file/Blob.zig rename src/browser/{xhr => file}/File.zig (78%) create mode 100644 src/browser/file/root.zig create mode 100644 src/tests/file/blob.html rename src/tests/{xhr => file}/file.html (84%) diff --git a/src/browser/file/Blob.zig b/src/browser/file/Blob.zig new file mode 100644 index 00000000..faa3648e --- /dev/null +++ b/src/browser/file/Blob.zig @@ -0,0 +1,145 @@ +// Copyright (C) 2023-2025 Lightpanda (Selecy SAS) +// +// Francis Bouvier +// Pierre Tachoire +// +// 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 . + +const std = @import("std"); +const Writer = std.Io.Writer; + +const builtin = @import("builtin"); +const is_windows = builtin.os.tag == .windows; + +const Page = @import("../page.zig").Page; +const js = @import("../js/js.zig"); + +/// https://w3c.github.io/FileAPI/#blob-section +/// https://developer.mozilla.org/en-US/docs/Web/API/Blob +const Blob = @This(); + +/// Immutable slice of blob. +/// Note that another blob may hold a pointer/slice to this, +/// so its better to leave the deallocation of it to arena allocator. +slice: []const u8, +/// MIME attached to blob. Can be an empty string. +mime: []const u8, + +const ConstructorOptions = struct { + /// MIME type. + type: []const u8 = "", + /// How to handle newline (LF) characters. + /// `transparent` means do nothing, `native` expects CRLF (\r\n) on Windows. + endings: []const u8 = "transparent", +}; + +/// Creates a new Blob. +pub fn constructor( + maybe_blob_parts: ?[]const []const u8, + maybe_options: ?ConstructorOptions, + page: *Page, +) !Blob { + const options: ConstructorOptions = maybe_options orelse .{}; + + if (maybe_blob_parts) |blob_parts| { + var w: Writer.Allocating = .init(page.arena); + const use_native_endings = std.mem.eql(u8, options.endings, "native"); + try writeBlobParts(&w.writer, blob_parts, use_native_endings); + + const written = w.written(); + + return .{ .slice = written, .mime = options.type }; + } + + // We don't have `blob_parts`, why would you want a Blob anyway then? + return .{ .slice = "", .mime = options.type }; +} + +/// Writes blob parts to given `Writer` by desired encoding. +fn writeBlobParts( + writer: *Writer, + blob_parts: []const []const u8, + use_native_endings: bool, +) !void { + // Transparent. + if (!use_native_endings) { + for (blob_parts) |part| { + try writer.writeAll(part); + } + + return; + } + + // TODO: Windows support. + // TODO: Vector search. + + // Linux & Unix. + // Both Firefox and Chrome implement it as such: + // CRLF => LF + // CR => LF + // So even though CR is not followed by LF, it gets replaced. + // + // I believe this is because such scenario is possible: + // ``` + // let parts = [ "the quick\r", "\nbrown fox" ]; + // ``` + // In the example, one should have to check the part before in order to + // understand that CRLF is being presented in the final buffer. + // So they took a simpler approach, here's what given blob parts produce: + // ``` + // "the quick\n\nbrown fox" + // ``` + scan_parts: for (blob_parts) |part| { + var end: usize = 0; + var start = end; + while (end < part.len) { + if (part[end] == '\r') { + try writer.writeAll(part[start..end]); + try writer.writeByte('\n'); + + // Part ends with CR. We can continue to next part. + if (end + 1 == part.len) { + continue :scan_parts; + } + + // If next char is LF, skip it too. + if (part[end + 1] == '\n') { + start = end + 2; + } else { + start = end + 1; + } + } + + end += 1; + } + + // Write the remaining. We get this in such situations: + // `the quick brown\rfox` + // `the quick brown\r\nfox` + try writer.writeAll(part[start..end]); + } +} + +pub fn get_size(self: *const Blob) usize { + return self.slice.len; +} + +pub fn get_str(self: *const Blob) []const u8 { + return self.slice; +} + +const testing = @import("../../testing.zig"); +test "Browser: File.Blob" { + try testing.htmlRunner("file/blob.html"); +} diff --git a/src/browser/xhr/File.zig b/src/browser/file/File.zig similarity index 78% rename from src/browser/xhr/File.zig rename to src/browser/file/File.zig index ebec7be6..bfec0d4f 100644 --- a/src/browser/xhr/File.zig +++ b/src/browser/file/File.zig @@ -21,14 +21,12 @@ const std = @import("std"); // https://w3c.github.io/FileAPI/#file-section const File = @This(); -// Very incomplete. The prototype for this is Blob, which we don't have. -// This minimum "implementation" is added because some JavaScript code just -// checks: if (x instanceof File) throw Error(...) +/// TODO: Implement File API. pub fn constructor() File { return .{}; } const testing = @import("../../testing.zig"); -test "Browser: File" { - try testing.htmlRunner("xhr/file.html"); +test "Browser: File.File" { + try testing.htmlRunner("file/file.html"); } diff --git a/src/browser/file/root.zig b/src/browser/file/root.zig new file mode 100644 index 00000000..570cc7d5 --- /dev/null +++ b/src/browser/file/root.zig @@ -0,0 +1,7 @@ +//! File API. +//! https://developer.mozilla.org/en-US/docs/Web/API/File_API + +pub const Interfaces = .{ + @import("./Blob.zig"), + @import("./File.zig"), +}; diff --git a/src/browser/js/types.zig b/src/browser/js/types.zig index 5f843de5..1849b72e 100644 --- a/src/browser/js/types.zig +++ b/src/browser/js/types.zig @@ -17,8 +17,8 @@ const Interfaces = generate.Tuple(.{ @import("../url/url.zig").Interfaces, @import("../xhr/xhr.zig").Interfaces, @import("../navigation/root.zig").Interfaces, + @import("../file/root.zig").Interfaces, @import("../xhr/form_data.zig").Interfaces, - @import("../xhr/File.zig"), @import("../xmlserializer/xmlserializer.zig").Interfaces, @import("../fetch/fetch.zig").Interfaces, @import("../streams/streams.zig").Interfaces, diff --git a/src/tests/file/blob.html b/src/tests/file/blob.html new file mode 100644 index 00000000..66298ea6 --- /dev/null +++ b/src/tests/file/blob.html @@ -0,0 +1,18 @@ + + + + diff --git a/src/tests/xhr/file.html b/src/tests/file/file.html similarity index 84% rename from src/tests/xhr/file.html rename to src/tests/file/file.html index 62284602..05f23ad7 100644 --- a/src/tests/xhr/file.html +++ b/src/tests/file/file.html @@ -1,6 +1,7 @@ +