mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2025-12-06 06:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Autodoc: use browser console log levels and simplify panic

Browse Source 
Using the browser's `console.error`, etc. functions instead of `console.log` produces prettier output in the console. Additionally, `console.error` in particular includes a stack trace, which is useful for debugging where the error occurred.

Additionally, this commit leverages the enhanced logging to delete the separate `panic` function from the JS code and write it in Zig instead.
This commit is contained in:
Ian Johnson 2025-02-15 16:23:33 -05:00
parent 293603f040
commit b745a96d20
2 changed files with 37 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
lib/docs/main.js
View File

@ -11,6 +11,11 @@
const CAT_type_type = 9;
const CAT_type_function = 10;
const LOG_err = 0;
const LOG_warn = 1;
const LOG_info = 2;
const LOG_debug = 3;
const domDocTestsCode = document.getElementById("docTestsCode");
const domFnErrorsAnyError = document.getElementById("fnErrorsAnyError");
const domFnProto = document.getElementById("fnProto");
@ -84,13 +89,22 @@
WebAssembly.instantiateStreaming(wasm_promise, {
js: {
log: function(ptr, len) {
log: function(level, ptr, len) {
const msg = decodeString(ptr, len);
console.log(msg);
},
panic: function (ptr, len) {
const msg = decodeString(ptr, len);
throw new Error("panic: " + msg);
switch (level) {
case LOG_err:
console.error(msg);
break;
case LOG_warn:
console.warn(msg);
break;
case LOG_info:
console.info(msg);
break;
case LOG_debug:
console.debug(msg);
break;
}
},
},
}).then(function(obj) {

37
lib/docs/wasm/main.zig
View File

@ -14,8 +14,15 @@ const missing_feature_url_escape = @import("html_render.zig").missing_feature_ur
const gpa = std.heap.wasm_allocator;
const js = struct {
extern "js" fn log(ptr: [*]const u8, len: usize) void;
extern "js" fn panic(ptr: [*]const u8, len: usize) noreturn;
/// Keep in sync with the `LOG_` constants in `main.js`.
const LogLevel = enum(u8) {
err,
warn,
info,
debug,
};
extern "js" fn log(level: LogLevel, ptr: [*]const u8, len: usize) void;
};
pub const std_options: std.Options = .{
@ -36,14 +43,13 @@ fn logFn(
comptime format: []const u8,
args: anytype,
) void {
const level_txt = comptime message_level.asText();
const prefix2 = if (scope == .default) ": " else "(" ++ @tagName(scope) ++ "): ";
const prefix = if (scope == .default) "" else @tagName(scope) ++ ": ";
var buf: [500]u8 = undefined;
const line = std.fmt.bufPrint(&buf, level_txt ++ prefix2 ++ format, args) catch l: {
const line = std.fmt.bufPrint(&buf, prefix ++ format, args) catch l: {
buf[buf.len - 3 ..][0..3].* = "...".*;
break :l &buf;
};
js.log(line.ptr, line.len);
js.log(@field(js.LogLevel, @tagName(message_level)), line.ptr, line.len);
}
export fn alloc(n: usize) [*]u8 {
@ -56,7 +62,7 @@ export fn unpack(tar_ptr: [*]u8, tar_len: usize) void {
//log.debug("received {d} bytes of tar file", .{tar_bytes.len});
unpackInner(tar_bytes) catch |err| {
fatal("unable to unpack tar: {s}", .{@errorName(err)});
std.debug.panic("unable to unpack tar: {s}", .{@errorName(err)});
};
}
@ -514,7 +520,7 @@ export fn decl_fn_proto_html(decl_index: Decl.Index, linkify_fn_name: bool) Stri
.collapse_whitespace = true,
.fn_link = if (linkify_fn_name) decl_index else .none,
}) catch |err| {
fatal("unable to render source: {s}", .{@errorName(err)});
std.debug.panic("unable to render source: {s}", .{@errorName(err)});
};
return String.init(string_result.items);
}
@ -524,7 +530,7 @@ export fn decl_source_html(decl_index: Decl.Index) String {
string_result.clearRetainingCapacity();
fileSourceHtml(decl.file, &string_result, decl.ast_node, .{}) catch |err| {
fatal("unable to render source: {s}", .{@errorName(err)});
std.debug.panic("unable to render source: {s}", .{@errorName(err)});
};
return String.init(string_result.items);
}
@ -536,7 +542,7 @@ export fn decl_doctest_html(decl_index: Decl.Index) String {
string_result.clearRetainingCapacity();
fileSourceHtml(decl.file, &string_result, doctest_ast_node, .{}) catch |err| {
fatal("unable to render source: {s}", .{@errorName(err)});
std.debug.panic("unable to render source: {s}", .{@errorName(err)});
};
return String.init(string_result.items);
}
@ -740,7 +746,7 @@ export fn decl_type_html(decl_index: Decl.Index) String {
.skip_comments = true,
.collapse_whitespace = true,
}) catch |e| {
fatal("unable to render html: {s}", .{@errorName(e)});
std.debug.panic("unable to render html: {s}", .{@errorName(e)});
};
string_result.appendSlice(gpa, "</code>") catch @panic("OOM");
break :t;
@ -791,15 +797,6 @@ fn unpackInner(tar_bytes: []u8) !void {
}
}
fn fatal(comptime format: []const u8, args: anytype) noreturn {
var buf: [500]u8 = undefined;
const line = std.fmt.bufPrint(&buf, format, args) catch l: {
buf[buf.len - 3 ..][0..3].* = "...".*;
break :l &buf;
};
js.panic(line.ptr, line.len);
}
fn ascii_lower(bytes: []u8) void {
for (bytes) |*b| b.* = std.ascii.toLower(b.*);
}