zig/doc/docgen.zig

1554 lines
65 KiB
Zig
Raw Normal View History

const std = @import("std");
2020-02-27 18:32:49 +00:00
const builtin = std.builtin;
const io = std.io;
2019-05-26 18:17:34 +01:00
const fs = std.fs;
const process = std.process;
const ChildProcess = std.ChildProcess;
const warn = std.debug.warn;
const mem = std.mem;
const testing = std.testing;
const max_doc_file_size = 10 * 1024 * 1024;
separate std.Target and std.zig.CrossTarget Zig now supports a more fine-grained sense of what is native and what is not. Some examples: This is now allowed: -target native Different OS but native CPU, default Windows C ABI: -target native-windows This could be useful for example when running in Wine. Different CPU but native OS, native C ABI. -target x86_64-native -mcpu=skylake Different C ABI but otherwise native target: -target native-native-musl -target native-native-gnu Lots of breaking changes to related std lib APIs. Calls to getOs() will need to be changed to getOsTag(). Calls to getArch() will need to be changed to getCpuArch(). Usage of Target.Cross and Target.Native need to be updated to use CrossTarget API. `std.build.Builder.standardTargetOptions` is changed to accept its parameters as a struct with default values. It now has the ability to specify a whitelist of targets allowed, as well as the default target. Rather than two different ways of collecting the target, it's now always a string that is validated, and prints helpful diagnostics for invalid targets. This feature should now be actually useful, and contributions welcome to further improve the user experience. `std.build.LibExeObjStep.setTheTarget` is removed. `std.build.LibExeObjStep.setTarget` is updated to take a CrossTarget parameter. `std.build.LibExeObjStep.setTargetGLibC` is removed. glibc versions are handled in the CrossTarget API and can be specified with the `-target` triple. `std.builtin.Version` gains a `format` method.
2020-02-26 06:18:23 +00:00
const exe_ext = @as(std.zig.CrossTarget, .{}).exeFileExt();
const obj_ext = @as(std.zig.CrossTarget, .{}).oFileExt();
const tmp_dir_name = "docgen_tmp";
2019-05-26 18:17:34 +01:00
const test_out_path = tmp_dir_name ++ fs.path.sep_str ++ "test" ++ exe_ext;
2018-02-01 03:48:40 +00:00
pub fn main() !void {
var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
defer arena.deinit();
const allocator = &arena.allocator;
2019-05-26 18:17:34 +01:00
var args_it = process.args();
if (!args_it.skip()) @panic("expected self arg");
const zig_exe = try (args_it.next(allocator) orelse @panic("expected zig exe arg"));
defer allocator.free(zig_exe);
const in_file_name = try (args_it.next(allocator) orelse @panic("expected input arg"));
defer allocator.free(in_file_name);
const out_file_name = try (args_it.next(allocator) orelse @panic("expected output arg"));
defer allocator.free(out_file_name);
var in_file = try fs.cwd().openFile(in_file_name, .{ .read = true });
defer in_file.close();
var out_file = try fs.cwd().createFile(out_file_name, .{});
defer out_file.close();
2020-03-11 00:22:30 +00:00
const input_file_bytes = try in_file.inStream().readAllAlloc(allocator, max_doc_file_size);
2020-03-11 00:22:30 +00:00
var buffered_out_stream = io.bufferedOutStream(out_file.outStream());
var tokenizer = Tokenizer.init(in_file_name, input_file_bytes);
var toc = try genToc(allocator, &tokenizer);
2020-03-03 21:01:09 +00:00
try fs.cwd().makePath(tmp_dir_name);
defer fs.cwd().deleteTree(tmp_dir_name) catch {};
2020-03-11 00:22:30 +00:00
try genHtml(allocator, &tokenizer, &toc, buffered_out_stream.outStream(), zig_exe);
try buffered_out_stream.flush();
}
const Token = struct {
id: Id,
start: usize,
end: usize,
const Id = enum {
Invalid,
Content,
BracketOpen,
TagContent,
Separator,
BracketClose,
Eof,
};
};
const Tokenizer = struct {
buffer: []const u8,
index: usize,
state: State,
source_file_name: []const u8,
code_node_count: usize,
const State = enum {
Start,
LBracket,
Hash,
TagName,
Eof,
};
fn init(source_file_name: []const u8, buffer: []const u8) Tokenizer {
return Tokenizer{
.buffer = buffer,
.index = 0,
.state = State.Start,
.source_file_name = source_file_name,
.code_node_count = 0,
};
}
fn next(self: *Tokenizer) Token {
var result = Token{
.id = Token.Id.Eof,
.start = self.index,
.end = undefined,
};
while (self.index < self.buffer.len) : (self.index += 1) {
const c = self.buffer[self.index];
switch (self.state) {
State.Start => switch (c) {
'{' => {
self.state = State.LBracket;
},
else => {
result.id = Token.Id.Content;
},
},
State.LBracket => switch (c) {
'#' => {
if (result.id != Token.Id.Eof) {
self.index -= 1;
self.state = State.Start;
break;
} else {
result.id = Token.Id.BracketOpen;
self.index += 1;
self.state = State.TagName;
break;
}
},
else => {
result.id = Token.Id.Content;
self.state = State.Start;
},
},
State.TagName => switch (c) {
'|' => {
if (result.id != Token.Id.Eof) {
break;
} else {
result.id = Token.Id.Separator;
self.index += 1;
break;
}
},
'#' => {
self.state = State.Hash;
},
else => {
result.id = Token.Id.TagContent;
},
},
State.Hash => switch (c) {
'}' => {
if (result.id != Token.Id.Eof) {
self.index -= 1;
self.state = State.TagName;
break;
} else {
result.id = Token.Id.BracketClose;
self.index += 1;
self.state = State.Start;
break;
}
},
else => {
result.id = Token.Id.TagContent;
self.state = State.TagName;
},
},
State.Eof => unreachable,
}
} else {
switch (self.state) {
State.Start, State.LBracket, State.Eof => {},
else => {
result.id = Token.Id.Invalid;
},
}
self.state = State.Eof;
}
result.end = self.index;
return result;
}
const Location = struct {
line: usize,
column: usize,
line_start: usize,
line_end: usize,
};
fn getTokenLocation(self: *Tokenizer, token: Token) Location {
var loc = Location{
.line = 0,
.column = 0,
.line_start = 0,
.line_end = 0,
};
for (self.buffer) |c, i| {
if (i == token.start) {
loc.line_end = i;
while (loc.line_end < self.buffer.len and self.buffer[loc.line_end] != '\n') : (loc.line_end += 1) {}
return loc;
}
if (c == '\n') {
loc.line += 1;
loc.column = 0;
loc.line_start = i + 1;
} else {
loc.column += 1;
}
}
return loc;
}
};
fn parseError(tokenizer: *Tokenizer, token: Token, comptime fmt: []const u8, args: anytype) anyerror {
const loc = tokenizer.getTokenLocation(token);
2019-12-09 05:18:01 +00:00
const args_prefix = .{ tokenizer.source_file_name, loc.line + 1, loc.column + 1 };
warn("{}:{}:{}: error: " ++ fmt ++ "\n", args_prefix ++ args);
if (loc.line_start <= loc.line_end) {
2019-12-09 05:18:01 +00:00
warn("{}\n", .{tokenizer.buffer[loc.line_start..loc.line_end]});
{
var i: usize = 0;
while (i < loc.column) : (i += 1) {
2019-12-09 05:18:01 +00:00
warn(" ", .{});
}
}
{
const caret_count = token.end - token.start;
var i: usize = 0;
while (i < caret_count) : (i += 1) {
2019-12-09 05:18:01 +00:00
warn("~", .{});
}
}
2019-12-09 05:18:01 +00:00
warn("\n", .{});
}
return error.ParseError;
}
fn assertToken(tokenizer: *Tokenizer, token: Token, id: Token.Id) !void {
if (token.id != id) {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, token, "expected {}, found {}", .{ @tagName(id), @tagName(token.id) });
}
}
fn eatToken(tokenizer: *Tokenizer, id: Token.Id) !Token {
const token = tokenizer.next();
try assertToken(tokenizer, token, id);
return token;
}
const HeaderOpen = struct {
name: []const u8,
url: []const u8,
n: usize,
};
const SeeAlsoItem = struct {
name: []const u8,
token: Token,
};
const ExpectedOutcome = enum {
Succeed,
Fail,
2019-05-01 20:34:17 +01:00
BuildFail,
};
const Code = struct {
id: Id,
name: []const u8,
source_token: Token,
is_inline: bool,
mode: builtin.Mode,
link_objects: []const []const u8,
target_str: ?[]const u8,
link_libc: bool,
const Id = union(enum) {
Test,
TestError: []const u8,
TestSafety: []const u8,
Exe: ExpectedOutcome,
Obj: ?[]const u8,
Lib,
};
};
const Link = struct {
2018-01-23 04:06:07 +00:00
url: []const u8,
name: []const u8,
token: Token,
};
const Node = union(enum) {
Content: []const u8,
Nav,
Builtin: Token,
HeaderOpen: HeaderOpen,
SeeAlso: []const SeeAlsoItem,
Code: Code,
2018-01-23 04:06:07 +00:00
Link: Link,
2018-09-14 15:35:03 +01:00
Syntax: Token,
};
const Toc = struct {
nodes: []Node,
toc: []u8,
urls: std.StringHashMap(Token),
};
const Action = enum {
Open,
Close,
};
fn genToc(allocator: *mem.Allocator, tokenizer: *Tokenizer) !Toc {
var urls = std.StringHashMap(Token).init(allocator);
errdefer urls.deinit();
var header_stack_size: usize = 0;
var last_action = Action.Open;
var last_columns: ?u8 = null;
var toc_buf = std.ArrayList(u8).init(allocator);
defer toc_buf.deinit();
2020-03-11 00:22:30 +00:00
var toc = toc_buf.outStream();
var nodes = std.ArrayList(Node).init(allocator);
defer nodes.deinit();
try toc.writeByte('\n');
while (true) {
const token = tokenizer.next();
switch (token.id) {
Token.Id.Eof => {
if (header_stack_size != 0) {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, token, "unbalanced headers", .{});
}
2020-03-11 00:22:30 +00:00
try toc.writeAll(" </ul>\n");
break;
},
Token.Id.Content => {
try nodes.append(Node{ .Content = tokenizer.buffer[token.start..token.end] });
},
Token.Id.BracketOpen => {
const tag_token = try eatToken(tokenizer, Token.Id.TagContent);
const tag_name = tokenizer.buffer[tag_token.start..tag_token.end];
if (mem.eql(u8, tag_name, "nav")) {
_ = try eatToken(tokenizer, Token.Id.BracketClose);
try nodes.append(Node.Nav);
} else if (mem.eql(u8, tag_name, "builtin")) {
_ = try eatToken(tokenizer, Token.Id.BracketClose);
try nodes.append(Node{ .Builtin = tag_token });
} else if (mem.eql(u8, tag_name, "header_open")) {
_ = try eatToken(tokenizer, Token.Id.Separator);
const content_token = try eatToken(tokenizer, Token.Id.TagContent);
const content = tokenizer.buffer[content_token.start..content_token.end];
var columns: ?u8 = null;
while (true) {
const bracket_tok = tokenizer.next();
switch (bracket_tok.id) {
.BracketClose => break,
.Separator => continue,
.TagContent => {
const param = tokenizer.buffer[bracket_tok.start..bracket_tok.end];
if (mem.eql(u8, param, "2col")) {
columns = 2;
} else {
2019-12-09 05:18:01 +00:00
return parseError(
tokenizer,
bracket_tok,
"unrecognized header_open param: {}",
.{param},
);
}
},
2019-12-09 05:18:01 +00:00
else => return parseError(tokenizer, bracket_tok, "invalid header_open token", .{}),
}
}
header_stack_size += 1;
const urlized = try urlize(allocator, content);
try nodes.append(Node{
.HeaderOpen = HeaderOpen{
.name = content,
.url = urlized,
.n = header_stack_size,
},
});
2020-07-04 23:25:49 +01:00
if (try urls.fetchPut(urlized, tag_token)) |entry| {
2019-12-09 05:18:01 +00:00
parseError(tokenizer, tag_token, "duplicate header url: #{}", .{urlized}) catch {};
parseError(tokenizer, entry.value, "other tag here", .{}) catch {};
return error.ParseError;
}
if (last_action == Action.Open) {
try toc.writeByte('\n');
try toc.writeByteNTimes(' ', header_stack_size * 4);
if (last_columns) |n| {
2019-12-09 05:18:01 +00:00
try toc.print("<ul style=\"columns: {}\">\n", .{n});
} else {
2020-03-11 00:22:30 +00:00
try toc.writeAll("<ul>\n");
}
} else {
last_action = Action.Open;
}
last_columns = columns;
try toc.writeByteNTimes(' ', 4 + header_stack_size * 4);
2019-12-09 05:18:01 +00:00
try toc.print("<li><a id=\"toc-{}\" href=\"#{}\">{}</a>", .{ urlized, urlized, content });
} else if (mem.eql(u8, tag_name, "header_close")) {
if (header_stack_size == 0) {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, tag_token, "unbalanced close header", .{});
}
header_stack_size -= 1;
_ = try eatToken(tokenizer, Token.Id.BracketClose);
if (last_action == Action.Close) {
try toc.writeByteNTimes(' ', 8 + header_stack_size * 4);
2020-03-11 00:22:30 +00:00
try toc.writeAll("</ul></li>\n");
} else {
2020-03-11 00:22:30 +00:00
try toc.writeAll("</li>\n");
last_action = Action.Close;
}
} else if (mem.eql(u8, tag_name, "see_also")) {
var list = std.ArrayList(SeeAlsoItem).init(allocator);
errdefer list.deinit();
while (true) {
const see_also_tok = tokenizer.next();
switch (see_also_tok.id) {
Token.Id.TagContent => {
const content = tokenizer.buffer[see_also_tok.start..see_also_tok.end];
try list.append(SeeAlsoItem{
.name = content,
.token = see_also_tok,
});
},
Token.Id.Separator => {},
Token.Id.BracketClose => {
try nodes.append(Node{ .SeeAlso = list.toOwnedSlice() });
break;
},
2019-12-09 05:18:01 +00:00
else => return parseError(tokenizer, see_also_tok, "invalid see_also token", .{}),
}
}
2018-01-23 04:06:07 +00:00
} else if (mem.eql(u8, tag_name, "link")) {
_ = try eatToken(tokenizer, Token.Id.Separator);
const name_tok = try eatToken(tokenizer, Token.Id.TagContent);
const name = tokenizer.buffer[name_tok.start..name_tok.end];
const url_name = blk: {
const tok = tokenizer.next();
switch (tok.id) {
Token.Id.BracketClose => break :blk name,
Token.Id.Separator => {
const explicit_text = try eatToken(tokenizer, Token.Id.TagContent);
_ = try eatToken(tokenizer, Token.Id.BracketClose);
break :blk tokenizer.buffer[explicit_text.start..explicit_text.end];
},
2019-12-09 05:18:01 +00:00
else => return parseError(tokenizer, tok, "invalid link token", .{}),
2018-01-23 04:06:07 +00:00
}
};
try nodes.append(Node{
.Link = Link{
2018-01-23 04:06:07 +00:00
.url = try urlize(allocator, url_name),
.name = name,
.token = name_tok,
},
});
} else if (mem.eql(u8, tag_name, "code_begin")) {
_ = try eatToken(tokenizer, Token.Id.Separator);
const code_kind_tok = try eatToken(tokenizer, Token.Id.TagContent);
var name: []const u8 = "test";
const maybe_sep = tokenizer.next();
switch (maybe_sep.id) {
Token.Id.Separator => {
const name_tok = try eatToken(tokenizer, Token.Id.TagContent);
name = tokenizer.buffer[name_tok.start..name_tok.end];
_ = try eatToken(tokenizer, Token.Id.BracketClose);
},
Token.Id.BracketClose => {},
2019-12-09 05:18:01 +00:00
else => return parseError(tokenizer, token, "invalid token", .{}),
}
const code_kind_str = tokenizer.buffer[code_kind_tok.start..code_kind_tok.end];
var code_kind_id: Code.Id = undefined;
var is_inline = false;
if (mem.eql(u8, code_kind_str, "exe")) {
code_kind_id = Code.Id{ .Exe = ExpectedOutcome.Succeed };
} else if (mem.eql(u8, code_kind_str, "exe_err")) {
code_kind_id = Code.Id{ .Exe = ExpectedOutcome.Fail };
2019-05-01 20:34:17 +01:00
} else if (mem.eql(u8, code_kind_str, "exe_build_err")) {
code_kind_id = Code.Id{ .Exe = ExpectedOutcome.BuildFail };
} else if (mem.eql(u8, code_kind_str, "test")) {
code_kind_id = Code.Id.Test;
} else if (mem.eql(u8, code_kind_str, "test_err")) {
code_kind_id = Code.Id{ .TestError = name };
name = "test";
} else if (mem.eql(u8, code_kind_str, "test_safety")) {
code_kind_id = Code.Id{ .TestSafety = name };
name = "test";
} else if (mem.eql(u8, code_kind_str, "obj")) {
code_kind_id = Code.Id{ .Obj = null };
} else if (mem.eql(u8, code_kind_str, "obj_err")) {
code_kind_id = Code.Id{ .Obj = name };
name = "test";
} else if (mem.eql(u8, code_kind_str, "lib")) {
code_kind_id = Code.Id.Lib;
} else if (mem.eql(u8, code_kind_str, "syntax")) {
code_kind_id = Code.Id{ .Obj = null };
is_inline = true;
} else {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, code_kind_tok, "unrecognized code kind: {}", .{code_kind_str});
}
2020-02-27 18:32:49 +00:00
var mode: builtin.Mode = .Debug;
var link_objects = std.ArrayList([]const u8).init(allocator);
defer link_objects.deinit();
var target_str: ?[]const u8 = null;
var link_libc = false;
const source_token = while (true) {
const content_tok = try eatToken(tokenizer, Token.Id.Content);
_ = try eatToken(tokenizer, Token.Id.BracketOpen);
const end_code_tag = try eatToken(tokenizer, Token.Id.TagContent);
const end_tag_name = tokenizer.buffer[end_code_tag.start..end_code_tag.end];
if (mem.eql(u8, end_tag_name, "code_release_fast")) {
2020-02-27 18:32:49 +00:00
mode = .ReleaseFast;
} else if (mem.eql(u8, end_tag_name, "code_release_safe")) {
2020-02-27 18:32:49 +00:00
mode = .ReleaseSafe;
} else if (mem.eql(u8, end_tag_name, "code_link_object")) {
_ = try eatToken(tokenizer, Token.Id.Separator);
const obj_tok = try eatToken(tokenizer, Token.Id.TagContent);
try link_objects.append(tokenizer.buffer[obj_tok.start..obj_tok.end]);
} else if (mem.eql(u8, end_tag_name, "target_windows")) {
target_str = "x86_64-windows";
} else if (mem.eql(u8, end_tag_name, "target_linux_x86_64")) {
target_str = "x86_64-linux";
} else if (mem.eql(u8, end_tag_name, "target_linux_riscv64")) {
target_str = "riscv64-linux";
2019-05-01 23:48:26 +01:00
} else if (mem.eql(u8, end_tag_name, "target_wasm")) {
target_str = "wasm32-freestanding";
} else if (mem.eql(u8, end_tag_name, "target_wasi")) {
target_str = "wasm32-wasi";
} else if (mem.eql(u8, end_tag_name, "link_libc")) {
link_libc = true;
} else if (mem.eql(u8, end_tag_name, "code_end")) {
_ = try eatToken(tokenizer, Token.Id.BracketClose);
break content_tok;
} else {
2019-12-09 05:18:01 +00:00
return parseError(
tokenizer,
end_code_tag,
"invalid token inside code_begin: {}",
.{end_tag_name},
);
}
_ = try eatToken(tokenizer, Token.Id.BracketClose);
} else
unreachable; // TODO issue #707
try nodes.append(Node{
.Code = Code{
.id = code_kind_id,
.name = name,
.source_token = source_token,
.is_inline = is_inline,
.mode = mode,
.link_objects = link_objects.toOwnedSlice(),
.target_str = target_str,
.link_libc = link_libc,
},
});
tokenizer.code_node_count += 1;
2018-09-14 15:35:03 +01:00
} else if (mem.eql(u8, tag_name, "syntax")) {
_ = try eatToken(tokenizer, Token.Id.BracketClose);
const content_tok = try eatToken(tokenizer, Token.Id.Content);
_ = try eatToken(tokenizer, Token.Id.BracketOpen);
const end_syntax_tag = try eatToken(tokenizer, Token.Id.TagContent);
const end_tag_name = tokenizer.buffer[end_syntax_tag.start..end_syntax_tag.end];
if (!mem.eql(u8, end_tag_name, "endsyntax")) {
2019-12-09 05:18:01 +00:00
return parseError(
tokenizer,
end_syntax_tag,
"invalid token inside syntax: {}",
.{end_tag_name},
);
2018-09-14 15:35:03 +01:00
}
_ = try eatToken(tokenizer, Token.Id.BracketClose);
try nodes.append(Node{ .Syntax = content_tok });
} else {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, tag_token, "unrecognized tag name: {}", .{tag_name});
}
},
2019-12-09 05:18:01 +00:00
else => return parseError(tokenizer, token, "invalid token", .{}),
}
}
return Toc{
.nodes = nodes.toOwnedSlice(),
.toc = toc_buf.toOwnedSlice(),
.urls = urls,
};
}
fn urlize(allocator: *mem.Allocator, input: []const u8) ![]u8 {
var buf = std.ArrayList(u8).init(allocator);
defer buf.deinit();
2020-03-11 00:22:30 +00:00
const out = buf.outStream();
for (input) |c| {
switch (c) {
2019-04-05 22:32:19 +01:00
'a'...'z', 'A'...'Z', '_', '-', '0'...'9' => {
try out.writeByte(c);
},
' ' => {
try out.writeByte('-');
},
else => {},
}
}
return buf.toOwnedSlice();
}
fn escapeHtml(allocator: *mem.Allocator, input: []const u8) ![]u8 {
var buf = std.ArrayList(u8).init(allocator);
defer buf.deinit();
2020-03-11 00:22:30 +00:00
const out = buf.outStream();
2018-09-12 22:26:51 +01:00
try writeEscaped(out, input);
return buf.toOwnedSlice();
}
fn writeEscaped(out: anytype, input: []const u8) !void {
for (input) |c| {
try switch (c) {
2020-03-11 00:22:30 +00:00
'&' => out.writeAll("&amp;"),
'<' => out.writeAll("&lt;"),
'>' => out.writeAll("&gt;"),
'"' => out.writeAll("&quot;"),
else => out.writeByte(c),
};
}
}
//#define VT_RED "\x1b[31;1m"
//#define VT_GREEN "\x1b[32;1m"
//#define VT_CYAN "\x1b[36;1m"
//#define VT_WHITE "\x1b[37;1m"
//#define VT_BOLD "\x1b[0;1m"
//#define VT_RESET "\x1b[0m"
const TermState = enum {
Start,
Escape,
LBracket,
Number,
AfterNumber,
Arg,
ArgNumber,
ExpectEnd,
};
test "term color" {
const input_bytes = "A\x1b[32;1mgreen\x1b[0mB";
const result = try termColor(std.testing.allocator, input_bytes);
defer std.testing.allocator.free(result);
2019-02-09 00:37:59 +00:00
testing.expectEqualSlices(u8, "A<span class=\"t32\">green</span>B", result);
}
fn termColor(allocator: *mem.Allocator, input: []const u8) ![]u8 {
var buf = std.ArrayList(u8).init(allocator);
defer buf.deinit();
2020-03-11 00:22:30 +00:00
var out = buf.outStream();
var number_start_index: usize = undefined;
var first_number: usize = undefined;
var second_number: usize = undefined;
var i: usize = 0;
var state = TermState.Start;
var open_span_count: usize = 0;
while (i < input.len) : (i += 1) {
const c = input[i];
switch (state) {
TermState.Start => switch (c) {
'\x1b' => state = TermState.Escape,
else => try out.writeByte(c),
},
TermState.Escape => switch (c) {
'[' => state = TermState.LBracket,
else => return error.UnsupportedEscape,
},
TermState.LBracket => switch (c) {
'0'...'9' => {
number_start_index = i;
state = TermState.Number;
},
else => return error.UnsupportedEscape,
},
TermState.Number => switch (c) {
'0'...'9' => {},
else => {
first_number = std.fmt.parseInt(usize, input[number_start_index..i], 10) catch unreachable;
second_number = 0;
state = TermState.AfterNumber;
i -= 1;
},
},
TermState.AfterNumber => switch (c) {
';' => state = TermState.Arg,
else => {
state = TermState.ExpectEnd;
i -= 1;
},
},
TermState.Arg => switch (c) {
'0'...'9' => {
number_start_index = i;
state = TermState.ArgNumber;
},
else => return error.UnsupportedEscape,
},
TermState.ArgNumber => switch (c) {
'0'...'9' => {},
else => {
second_number = std.fmt.parseInt(usize, input[number_start_index..i], 10) catch unreachable;
state = TermState.ExpectEnd;
i -= 1;
},
},
TermState.ExpectEnd => switch (c) {
'm' => {
state = TermState.Start;
while (open_span_count != 0) : (open_span_count -= 1) {
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
}
if (first_number != 0 or second_number != 0) {
2019-12-09 05:18:01 +00:00
try out.print("<span class=\"t{}_{}\">", .{ first_number, second_number });
open_span_count += 1;
}
},
else => return error.UnsupportedEscape,
},
}
}
return buf.toOwnedSlice();
}
const builtin_types = [_][]const u8{
"f16", "f32", "f64", "f128", "c_longdouble", "c_short",
"c_ushort", "c_int", "c_uint", "c_long", "c_ulong", "c_longlong",
"c_ulonglong", "c_char", "c_void", "void", "bool", "isize",
"usize", "noreturn", "type", "anyerror", "comptime_int", "comptime_float",
2018-09-12 22:26:51 +01:00
};
fn isType(name: []const u8) bool {
for (builtin_types) |t| {
if (mem.eql(u8, t, name))
return true;
}
return false;
}
fn tokenizeAndPrintRaw(docgen_tokenizer: *Tokenizer, out: anytype, source_token: Token, raw_src: []const u8) !void {
2018-09-14 15:35:03 +01:00
const src = mem.trim(u8, raw_src, " \n");
2020-03-11 00:22:30 +00:00
try out.writeAll("<code class=\"zig\">");
2018-09-12 22:26:51 +01:00
var tokenizer = std.zig.Tokenizer.init(src);
var index: usize = 0;
var next_tok_is_fn = false;
while (true) {
const prev_tok_was_fn = next_tok_is_fn;
next_tok_is_fn = false;
const token = tokenizer.next();
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[index..token.loc.start]);
2018-09-12 22:26:51 +01:00
switch (token.id) {
2019-07-19 22:54:06 +01:00
.Eof => break,
.Keyword_align,
.Keyword_and,
.Keyword_asm,
.Keyword_async,
.Keyword_await,
.Keyword_break,
.Keyword_catch,
.Keyword_comptime,
.Keyword_const,
.Keyword_continue,
.Keyword_defer,
.Keyword_else,
.Keyword_enum,
.Keyword_errdefer,
.Keyword_error,
.Keyword_export,
.Keyword_extern,
.Keyword_for,
.Keyword_if,
.Keyword_inline,
.Keyword_noalias,
.Keyword_noinline,
.Keyword_nosuspend,
2019-07-19 22:54:06 +01:00
.Keyword_or,
.Keyword_orelse,
.Keyword_packed,
2019-08-12 00:53:10 +01:00
.Keyword_anyframe,
2019-07-19 22:54:06 +01:00
.Keyword_pub,
.Keyword_resume,
.Keyword_return,
.Keyword_linksection,
2019-12-23 20:52:06 +00:00
.Keyword_callconv,
2019-07-19 22:54:06 +01:00
.Keyword_struct,
.Keyword_suspend,
.Keyword_switch,
.Keyword_test,
.Keyword_threadlocal,
.Keyword_try,
.Keyword_union,
.Keyword_unreachable,
.Keyword_usingnamespace,
.Keyword_var,
.Keyword_volatile,
.Keyword_allowzero,
.Keyword_while,
.Keyword_anytype,
2018-09-12 22:26:51 +01:00
=> {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-kw\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
},
2019-07-19 22:54:06 +01:00
.Keyword_fn => {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-kw\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
next_tok_is_fn = true;
},
2019-07-19 22:54:06 +01:00
.Keyword_undefined,
.Keyword_null,
.Keyword_true,
.Keyword_false,
2018-09-12 22:26:51 +01:00
=> {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-null\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
},
2019-07-19 22:54:06 +01:00
.StringLiteral,
.MultilineStringLiteralLine,
.CharLiteral,
2018-09-12 22:26:51 +01:00
=> {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-str\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
},
2019-07-19 22:54:06 +01:00
.Builtin => {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-builtin\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
},
2019-07-19 22:54:06 +01:00
.LineComment,
.DocComment,
.ContainerDocComment,
2019-07-19 22:54:06 +01:00
.ShebangLine,
2018-09-12 22:26:51 +01:00
=> {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-comment\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
},
2019-07-19 22:54:06 +01:00
.Identifier => {
2018-09-12 22:26:51 +01:00
if (prev_tok_was_fn) {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-fn\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
} else {
const is_int = blk: {
2020-05-24 01:40:09 +01:00
if (src[token.loc.start] != 'i' and src[token.loc.start] != 'u')
2018-09-12 22:26:51 +01:00
break :blk false;
2020-05-24 01:40:09 +01:00
var i = token.loc.start + 1;
if (i == token.loc.end)
2018-09-12 22:26:51 +01:00
break :blk false;
2020-05-24 01:40:09 +01:00
while (i != token.loc.end) : (i += 1) {
2018-09-12 22:26:51 +01:00
if (src[i] < '0' or src[i] > '9')
break :blk false;
}
break :blk true;
};
2020-05-24 01:40:09 +01:00
if (is_int or isType(src[token.loc.start..token.loc.end])) {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-type\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
} else {
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2018-09-12 22:26:51 +01:00
}
}
},
2019-07-19 22:54:06 +01:00
.IntegerLiteral,
.FloatLiteral,
2018-09-12 22:26:51 +01:00
=> {
2020-03-11 00:22:30 +00:00
try out.writeAll("<span class=\"tok-number\">");
2020-05-24 01:40:09 +01:00
try writeEscaped(out, src[token.loc.start..token.loc.end]);
2020-03-11 00:22:30 +00:00
try out.writeAll("</span>");
2018-09-12 22:26:51 +01:00
},
2019-07-19 22:54:06 +01:00
.Bang,
.Pipe,
.PipePipe,
.PipeEqual,
.Equal,
.EqualEqual,
.EqualAngleBracketRight,
.BangEqual,
.LParen,
.RParen,
.Semicolon,
.Percent,
.PercentEqual,
.LBrace,
.RBrace,
.LBracket,
.RBracket,
.Period,
.PeriodAsterisk,
2019-07-19 22:54:06 +01:00
.Ellipsis2,
.Ellipsis3,
.Caret,
.CaretEqual,
.Plus,
.PlusPlus,
.PlusEqual,
.PlusPercent,
.PlusPercentEqual,
.Minus,
.MinusEqual,
.MinusPercent,
.MinusPercentEqual,
.Asterisk,
.AsteriskEqual,
.AsteriskAsterisk,
.AsteriskPercent,
.AsteriskPercentEqual,
.Arrow,
.Colon,
.Slash,
.SlashEqual,
.Comma,
.Ampersand,
.AmpersandEqual,
.QuestionMark,
.AngleBracketLeft,
.AngleBracketLeftEqual,
.AngleBracketAngleBracketLeft,
.AngleBracketAngleBracketLeftEqual,
.AngleBracketRight,
.AngleBracketRightEqual,
.AngleBracketAngleBracketRight,
.AngleBracketAngleBracketRightEqual,
.Tilde,
2020-05-24 01:40:09 +01:00
=> try writeEscaped(out, src[token.loc.start..token.loc.end]),
2018-09-14 15:35:03 +01:00
2019-07-19 22:54:06 +01:00
.Invalid, .Invalid_ampersands => return parseError(
2018-09-14 15:35:03 +01:00
docgen_tokenizer,
source_token,
"syntax error",
2019-12-09 05:18:01 +00:00
.{},
2018-09-14 15:35:03 +01:00
),
2018-09-12 22:26:51 +01:00
}
2020-05-24 01:40:09 +01:00
index = token.loc.end;
2018-09-12 22:26:51 +01:00
}
2020-03-11 00:22:30 +00:00
try out.writeAll("</code>");
2018-09-12 22:26:51 +01:00
}
fn tokenizeAndPrint(docgen_tokenizer: *Tokenizer, out: anytype, source_token: Token) !void {
const raw_src = docgen_tokenizer.buffer[source_token.start..source_token.end];
return tokenizeAndPrintRaw(docgen_tokenizer, out, source_token, raw_src);
}
fn genHtml(allocator: *mem.Allocator, tokenizer: *Tokenizer, toc: *Toc, out: anytype, zig_exe: []const u8) !void {
var code_progress_index: usize = 0;
2019-05-26 18:17:34 +01:00
var env_map = try process.getEnvMap(allocator);
try env_map.set("ZIG_DEBUG_COLOR", "1");
const builtin_code = try getBuiltinCode(allocator, &env_map, zig_exe);
for (toc.nodes) |node| {
switch (node) {
2020-02-27 18:32:49 +00:00
.Content => |data| {
2020-03-11 00:22:30 +00:00
try out.writeAll(data);
},
2020-02-27 18:32:49 +00:00
.Link => |info| {
2018-01-23 04:06:07 +00:00
if (!toc.urls.contains(info.url)) {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, info.token, "url not found: {}", .{info.url});
2018-01-23 04:06:07 +00:00
}
2019-12-09 05:18:01 +00:00
try out.print("<a href=\"#{}\">{}</a>", .{ info.url, info.name });
2018-01-23 04:06:07 +00:00
},
2020-02-27 18:32:49 +00:00
.Nav => {
2020-03-11 00:22:30 +00:00
try out.writeAll(toc.toc);
},
2020-02-27 18:32:49 +00:00
.Builtin => |tok| {
2020-03-11 00:22:30 +00:00
try out.writeAll("<pre>");
try tokenizeAndPrintRaw(tokenizer, out, tok, builtin_code);
2020-03-11 00:22:30 +00:00
try out.writeAll("</pre>");
},
2020-02-27 18:32:49 +00:00
.HeaderOpen => |info| {
try out.print(
"<h{} id=\"{}\"><a href=\"#toc-{}\">{}</a> <a class=\"hdr\" href=\"#{}\">§</a></h{}>\n",
2019-12-09 05:18:01 +00:00
.{ info.n, info.url, info.url, info.name, info.url, info.n },
);
},
2020-02-27 18:32:49 +00:00
.SeeAlso => |items| {
2020-03-11 00:22:30 +00:00
try out.writeAll("<p>See also:</p><ul>\n");
for (items) |item| {
const url = try urlize(allocator, item.name);
if (!toc.urls.contains(url)) {
2019-12-09 05:18:01 +00:00
return parseError(tokenizer, item.token, "url not found: {}", .{url});
}
2019-12-09 05:18:01 +00:00
try out.print("<li><a href=\"#{}\">{}</a></li>\n", .{ url, item.name });
}
2020-03-11 00:22:30 +00:00
try out.writeAll("</ul>\n");
},
2020-02-27 18:32:49 +00:00
.Syntax => |content_tok| {
try tokenizeAndPrint(tokenizer, out, content_tok);
2018-09-14 15:35:03 +01:00
},
2020-02-27 18:32:49 +00:00
.Code => |code| {
code_progress_index += 1;
2019-12-09 05:18:01 +00:00
warn("docgen example code {}/{}...", .{ code_progress_index, tokenizer.code_node_count });
const raw_source = tokenizer.buffer[code.source_token.start..code.source_token.end];
const trimmed_raw_source = mem.trim(u8, raw_source, " \n");
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print("<p class=\"file\">{}.zig</p>", .{code.name});
}
2020-03-11 00:22:30 +00:00
try out.writeAll("<pre>");
try tokenizeAndPrint(tokenizer, out, code.source_token);
2020-03-11 00:22:30 +00:00
try out.writeAll("</pre>");
2019-12-09 05:18:01 +00:00
const name_plus_ext = try std.fmt.allocPrint(allocator, "{}.zig", .{code.name});
2019-05-26 18:17:34 +01:00
const tmp_source_file_name = try fs.path.join(
allocator,
2019-12-02 02:27:55 +00:00
&[_][]const u8{ tmp_dir_name, name_plus_ext },
);
try fs.cwd().writeFile(tmp_source_file_name, trimmed_raw_source);
switch (code.id) {
Code.Id.Exe => |expected_outcome| code_block: {
2019-12-09 05:18:01 +00:00
const name_plus_bin_ext = try std.fmt.allocPrint(allocator, "{}{}", .{ code.name, exe_ext });
var build_args = std.ArrayList([]const u8).init(allocator);
defer build_args.deinit();
2019-12-02 02:27:55 +00:00
try build_args.appendSlice(&[_][]const u8{
zig_exe,
"build-exe",
tmp_source_file_name,
"--name",
code.name,
2019-05-01 20:34:17 +01:00
"--color",
"on",
2019-09-25 22:59:41 +01:00
"--cache",
"on",
});
2019-12-09 05:18:01 +00:00
try out.print("<pre><code class=\"shell\">$ zig build-exe {}.zig", .{code.name});
switch (code.mode) {
2020-02-27 18:32:49 +00:00
.Debug => {},
.ReleaseSafe => {
try build_args.append("--release-safe");
2019-12-09 05:18:01 +00:00
try out.print(" --release-safe", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseFast => {
try build_args.append("--release-fast");
2019-12-09 05:18:01 +00:00
try out.print(" --release-fast", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseSmall => {
2018-04-16 02:18:52 +01:00
try build_args.append("--release-small");
2019-12-09 05:18:01 +00:00
try out.print(" --release-small", .{});
2018-04-16 02:18:52 +01:00
},
}
for (code.link_objects) |link_object| {
2019-12-09 05:18:01 +00:00
const name_with_ext = try std.fmt.allocPrint(allocator, "{}{}", .{ link_object, obj_ext });
2019-05-26 18:17:34 +01:00
const full_path_object = try fs.path.join(
allocator,
2019-12-02 02:27:55 +00:00
&[_][]const u8{ tmp_dir_name, name_with_ext },
);
try build_args.append("--object");
try build_args.append(full_path_object);
2019-12-09 05:18:01 +00:00
try out.print(" --object {}", .{name_with_ext});
}
if (code.link_libc) {
try build_args.append("-lc");
2019-12-09 05:18:01 +00:00
try out.print(" -lc", .{});
}
const target = try std.zig.CrossTarget.parse(.{
.arch_os_abi = code.target_str orelse "native",
});
if (code.target_str) |triple| {
2019-12-02 02:27:55 +00:00
try build_args.appendSlice(&[_][]const u8{ "-target", triple });
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print(" -target {}", .{triple});
}
}
2019-05-01 20:34:17 +01:00
if (expected_outcome == .BuildFail) {
const result = try ChildProcess.exec(.{
.allocator = allocator,
2020-04-09 13:46:13 +01:00
.argv = build_args.items,
.env_map = &env_map,
.max_output_bytes = max_doc_file_size,
});
2019-05-01 20:34:17 +01:00
switch (result.term) {
2019-05-26 18:17:34 +01:00
.Exited => |exit_code| {
2019-05-01 20:34:17 +01:00
if (exit_code == 0) {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command incorrectly succeeded:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (build_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
2019-05-01 20:34:17 +01:00
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example incorrectly compiled", .{});
2019-05-01 20:34:17 +01:00
}
},
else => {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command crashed:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (build_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
2019-05-01 20:34:17 +01:00
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example compile crashed", .{});
2019-05-01 20:34:17 +01:00
},
}
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const colored_stderr = try termColor(allocator, escaped_stderr);
2019-12-09 05:18:01 +00:00
try out.print("\n{}</code></pre>\n", .{colored_stderr});
2019-05-01 20:34:17 +01:00
break :code_block;
}
2020-04-09 13:46:13 +01:00
const exec_result = exec(allocator, &env_map, build_args.items) catch
2020-02-27 18:32:49 +00:00
return parseError(tokenizer, code.source_token, "example failed to compile", .{});
if (code.target_str) |triple| {
2020-02-27 19:41:44 +00:00
if (mem.startsWith(u8, triple, "wasm32") or
mem.startsWith(u8, triple, "riscv64-linux") or
2020-02-27 19:41:44 +00:00
(mem.startsWith(u8, triple, "x86_64-linux") and
std.Target.current.os.tag != .linux or std.Target.current.cpu.arch != .x86_64))
{
// skip execution
2019-12-09 05:18:01 +00:00
try out.print("</code></pre>\n", .{});
break :code_block;
}
}
const path_to_exe_dir = mem.trim(u8, exec_result.stdout, " \r\n");
const path_to_exe_basename = try std.fmt.allocPrint(allocator, "{}{}", .{
code.name,
target.exeFileExt(),
});
const path_to_exe = try fs.path.join(allocator, &[_][]const u8{
path_to_exe_dir,
path_to_exe_basename,
});
2019-12-02 02:27:55 +00:00
const run_args = &[_][]const u8{path_to_exe};
var exited_with_signal = false;
const result = if (expected_outcome == ExpectedOutcome.Fail) blk: {
const result = try ChildProcess.exec(.{
.allocator = allocator,
.argv = run_args,
.env_map = &env_map,
.max_output_bytes = max_doc_file_size,
});
switch (result.term) {
2019-05-26 18:17:34 +01:00
.Exited => |exit_code| {
if (exit_code == 0) {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command incorrectly succeeded:\n", .{result.stderr});
for (run_args) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example incorrectly compiled", .{});
}
},
.Signal => exited_with_signal = true,
else => {},
}
break :blk result;
} else blk: {
2019-12-09 05:18:01 +00:00
break :blk exec(allocator, &env_map, run_args) catch return parseError(tokenizer, code.source_token, "example crashed", .{});
};
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const escaped_stdout = try escapeHtml(allocator, result.stdout);
const colored_stderr = try termColor(allocator, escaped_stderr);
const colored_stdout = try termColor(allocator, escaped_stdout);
2019-12-09 05:18:01 +00:00
try out.print("\n$ ./{}\n{}{}", .{ code.name, colored_stdout, colored_stderr });
if (exited_with_signal) {
2019-12-09 05:18:01 +00:00
try out.print("(process terminated by signal)", .{});
}
2019-12-09 05:18:01 +00:00
try out.print("</code></pre>\n", .{});
},
Code.Id.Test => {
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
2019-12-02 02:27:55 +00:00
try test_args.appendSlice(&[_][]const u8{
zig_exe,
"test",
tmp_source_file_name,
2019-09-25 22:59:41 +01:00
"--cache",
"on",
});
2019-12-09 05:18:01 +00:00
try out.print("<pre><code class=\"shell\">$ zig test {}.zig", .{code.name});
switch (code.mode) {
2020-02-27 18:32:49 +00:00
.Debug => {},
.ReleaseSafe => {
try test_args.append("--release-safe");
2019-12-09 05:18:01 +00:00
try out.print(" --release-safe", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseFast => {
try test_args.append("--release-fast");
2019-12-09 05:18:01 +00:00
try out.print(" --release-fast", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseSmall => {
2018-04-16 02:18:52 +01:00
try test_args.append("--release-small");
2019-12-09 05:18:01 +00:00
try out.print(" --release-small", .{});
2018-04-16 02:18:52 +01:00
},
}
if (code.link_libc) {
try test_args.append("-lc");
2019-12-09 05:18:01 +00:00
try out.print(" -lc", .{});
}
if (code.target_str) |triple| {
2019-12-02 02:27:55 +00:00
try test_args.appendSlice(&[_][]const u8{ "-target", triple });
2019-12-09 05:18:01 +00:00
try out.print(" -target {}", .{triple});
}
2020-04-09 13:46:13 +01:00
const result = exec(allocator, &env_map, test_args.items) catch return parseError(tokenizer, code.source_token, "test failed", .{});
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const escaped_stdout = try escapeHtml(allocator, result.stdout);
2019-12-09 05:18:01 +00:00
try out.print("\n{}{}</code></pre>\n", .{ escaped_stderr, escaped_stdout });
},
Code.Id.TestError => |error_match| {
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
2019-12-02 02:27:55 +00:00
try test_args.appendSlice(&[_][]const u8{
zig_exe,
"test",
"--color",
"on",
tmp_source_file_name,
"--output-dir",
tmp_dir_name,
});
2019-12-09 05:18:01 +00:00
try out.print("<pre><code class=\"shell\">$ zig test {}.zig", .{code.name});
switch (code.mode) {
2020-02-27 18:32:49 +00:00
.Debug => {},
.ReleaseSafe => {
try test_args.append("--release-safe");
2019-12-09 05:18:01 +00:00
try out.print(" --release-safe", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseFast => {
try test_args.append("--release-fast");
2019-12-09 05:18:01 +00:00
try out.print(" --release-fast", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseSmall => {
2018-04-16 02:18:52 +01:00
try test_args.append("--release-small");
2019-12-09 05:18:01 +00:00
try out.print(" --release-small", .{});
2018-04-16 02:18:52 +01:00
},
}
const result = try ChildProcess.exec(.{
.allocator = allocator,
2020-04-09 13:46:13 +01:00
.argv = test_args.items,
.env_map = &env_map,
.max_output_bytes = max_doc_file_size,
});
switch (result.term) {
2019-05-26 18:17:34 +01:00
.Exited => |exit_code| {
if (exit_code == 0) {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command incorrectly succeeded:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (test_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example incorrectly compiled", .{});
}
},
else => {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command crashed:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (test_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example compile crashed", .{});
},
}
if (mem.indexOf(u8, result.stderr, error_match) == null) {
2019-12-09 05:18:01 +00:00
warn("{}\nExpected to find '{}' in stderr", .{ result.stderr, error_match });
return parseError(tokenizer, code.source_token, "example did not have expected compile error", .{});
}
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const colored_stderr = try termColor(allocator, escaped_stderr);
2019-12-09 05:18:01 +00:00
try out.print("\n{}</code></pre>\n", .{colored_stderr});
},
Code.Id.TestSafety => |error_match| {
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
2019-12-02 02:27:55 +00:00
try test_args.appendSlice(&[_][]const u8{
zig_exe,
"test",
tmp_source_file_name,
"--output-dir",
tmp_dir_name,
});
var mode_arg: []const u8 = "";
switch (code.mode) {
2020-02-27 18:32:49 +00:00
.Debug => {},
.ReleaseSafe => {
try test_args.append("--release-safe");
mode_arg = " --release-safe";
},
2020-02-27 18:32:49 +00:00
.ReleaseFast => {
try test_args.append("--release-fast");
mode_arg = " --release-fast";
},
2020-02-27 18:32:49 +00:00
.ReleaseSmall => {
try test_args.append("--release-small");
mode_arg = " --release-small";
},
}
const result = try ChildProcess.exec(.{
.allocator = allocator,
2020-04-09 13:46:13 +01:00
.argv = test_args.items,
.env_map = &env_map,
.max_output_bytes = max_doc_file_size,
});
switch (result.term) {
2019-05-26 18:17:34 +01:00
.Exited => |exit_code| {
if (exit_code == 0) {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command incorrectly succeeded:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (test_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example test incorrectly succeeded", .{});
}
},
else => {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command crashed:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (test_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example compile crashed", .{});
},
}
if (mem.indexOf(u8, result.stderr, error_match) == null) {
2019-12-09 05:18:01 +00:00
warn("{}\nExpected to find '{}' in stderr", .{ result.stderr, error_match });
return parseError(tokenizer, code.source_token, "example did not have expected runtime safety error message", .{});
}
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const colored_stderr = try termColor(allocator, escaped_stderr);
2019-12-09 05:18:01 +00:00
try out.print("<pre><code class=\"shell\">$ zig test {}.zig{}\n{}</code></pre>\n", .{
code.name,
mode_arg,
colored_stderr,
2019-12-09 05:18:01 +00:00
});
},
Code.Id.Obj => |maybe_error_match| {
2019-12-09 05:18:01 +00:00
const name_plus_obj_ext = try std.fmt.allocPrint(allocator, "{}{}", .{ code.name, obj_ext });
2019-05-26 18:17:34 +01:00
const tmp_obj_file_name = try fs.path.join(
allocator,
2019-12-02 02:27:55 +00:00
&[_][]const u8{ tmp_dir_name, name_plus_obj_ext },
);
var build_args = std.ArrayList([]const u8).init(allocator);
defer build_args.deinit();
2019-12-09 05:18:01 +00:00
const name_plus_h_ext = try std.fmt.allocPrint(allocator, "{}.h", .{code.name});
2019-05-26 18:17:34 +01:00
const output_h_file_name = try fs.path.join(
allocator,
2019-12-02 02:27:55 +00:00
&[_][]const u8{ tmp_dir_name, name_plus_h_ext },
);
2019-12-02 02:27:55 +00:00
try build_args.appendSlice(&[_][]const u8{
zig_exe,
"build-obj",
tmp_source_file_name,
"--color",
"on",
"--name",
code.name,
"--output-dir",
tmp_dir_name,
});
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print("<pre><code class=\"shell\">$ zig build-obj {}.zig", .{code.name});
}
switch (code.mode) {
2020-02-27 18:32:49 +00:00
.Debug => {},
.ReleaseSafe => {
try build_args.append("--release-safe");
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print(" --release-safe", .{});
}
},
2020-02-27 18:32:49 +00:00
.ReleaseFast => {
try build_args.append("--release-fast");
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print(" --release-fast", .{});
}
},
2020-02-27 18:32:49 +00:00
.ReleaseSmall => {
2018-04-16 02:18:52 +01:00
try build_args.append("--release-small");
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print(" --release-small", .{});
2018-04-16 02:18:52 +01:00
}
},
}
if (code.target_str) |triple| {
2019-12-02 02:27:55 +00:00
try build_args.appendSlice(&[_][]const u8{ "-target", triple });
2019-12-09 05:18:01 +00:00
try out.print(" -target {}", .{triple});
}
if (maybe_error_match) |error_match| {
const result = try ChildProcess.exec(.{
.allocator = allocator,
2020-04-09 13:46:13 +01:00
.argv = build_args.items,
.env_map = &env_map,
.max_output_bytes = max_doc_file_size,
});
switch (result.term) {
2019-05-26 18:17:34 +01:00
.Exited => |exit_code| {
if (exit_code == 0) {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command incorrectly succeeded:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (build_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example build incorrectly succeeded", .{});
}
},
else => {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command crashed:\n", .{result.stderr});
2020-04-09 13:46:13 +01:00
for (build_args.items) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return parseError(tokenizer, code.source_token, "example compile crashed", .{});
},
}
if (mem.indexOf(u8, result.stderr, error_match) == null) {
2019-12-09 05:18:01 +00:00
warn("{}\nExpected to find '{}' in stderr", .{ result.stderr, error_match });
return parseError(tokenizer, code.source_token, "example did not have expected compile error message", .{});
}
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const colored_stderr = try termColor(allocator, escaped_stderr);
2019-12-09 05:18:01 +00:00
try out.print("\n{}", .{colored_stderr});
} else {
2020-04-09 13:46:13 +01:00
_ = exec(allocator, &env_map, build_args.items) catch return parseError(tokenizer, code.source_token, "example failed to compile", .{});
}
if (!code.is_inline) {
2019-12-09 05:18:01 +00:00
try out.print("</code></pre>\n", .{});
}
},
Code.Id.Lib => {
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
2019-12-02 02:27:55 +00:00
try test_args.appendSlice(&[_][]const u8{
zig_exe,
"build-lib",
tmp_source_file_name,
"--output-dir",
tmp_dir_name,
});
2019-12-09 05:18:01 +00:00
try out.print("<pre><code class=\"shell\">$ zig build-lib {}.zig", .{code.name});
switch (code.mode) {
2020-02-27 18:32:49 +00:00
.Debug => {},
.ReleaseSafe => {
try test_args.append("--release-safe");
2019-12-09 05:18:01 +00:00
try out.print(" --release-safe", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseFast => {
try test_args.append("--release-fast");
2019-12-09 05:18:01 +00:00
try out.print(" --release-fast", .{});
},
2020-02-27 18:32:49 +00:00
.ReleaseSmall => {
try test_args.append("--release-small");
2019-12-09 05:18:01 +00:00
try out.print(" --release-small", .{});
},
}
if (code.target_str) |triple| {
2019-12-02 02:27:55 +00:00
try test_args.appendSlice(&[_][]const u8{ "-target", triple });
2019-12-09 05:18:01 +00:00
try out.print(" -target {}", .{triple});
}
2020-04-09 13:46:13 +01:00
const result = exec(allocator, &env_map, test_args.items) catch return parseError(tokenizer, code.source_token, "test failed", .{});
const escaped_stderr = try escapeHtml(allocator, result.stderr);
const escaped_stdout = try escapeHtml(allocator, result.stdout);
2019-12-09 05:18:01 +00:00
try out.print("\n{}{}</code></pre>\n", .{ escaped_stderr, escaped_stdout });
},
}
2019-12-09 05:18:01 +00:00
warn("OK\n", .{});
},
}
}
}
2019-05-26 18:17:34 +01:00
fn exec(allocator: *mem.Allocator, env_map: *std.BufMap, args: []const []const u8) !ChildProcess.ExecResult {
const result = try ChildProcess.exec(.{
.allocator = allocator,
.argv = args,
.env_map = env_map,
.max_output_bytes = max_doc_file_size,
});
switch (result.term) {
2019-05-26 18:17:34 +01:00
.Exited => |exit_code| {
if (exit_code != 0) {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command exited with code {}:\n", .{ result.stderr, exit_code });
for (args) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return error.ChildExitError;
}
},
else => {
2019-12-09 05:18:01 +00:00
warn("{}\nThe following command crashed:\n", .{result.stderr});
for (args) |arg|
2019-12-09 05:18:01 +00:00
warn("{} ", .{arg})
else
2019-12-09 05:18:01 +00:00
warn("\n", .{});
return error.ChildCrashed;
},
}
return result;
}
fn getBuiltinCode(allocator: *mem.Allocator, env_map: *std.BufMap, zig_exe: []const u8) ![]const u8 {
2019-12-02 02:27:55 +00:00
const result = try exec(allocator, env_map, &[_][]const u8{
zig_exe,
"builtin",
});
return result.stdout;
}