aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrew Kelley <superjoe30@gmail.com>2018-05-26 18:16:39 -0400
committerAndrew Kelley <superjoe30@gmail.com>2018-05-26 23:00:29 -0400
commitb184ae5ca5d3d3c0a4b9de564a6e30555e596e65 (patch)
tree791669ad85847bd268fcd1d8dc51f25a84757bea /doc
parent118d41ef8325b4c1ca8be1fea66c2e8368b67e32 (diff)
downloadzig-b184ae5ca5d3d3c0a4b9de564a6e30555e596e65.tar.gz
zig-b184ae5ca5d3d3c0a4b9de564a6e30555e596e65.zip
run zig fmt on some of the codebase
See #1003
Diffstat (limited to 'doc')
-rw-r--r--doc/docgen.zig182
1 files changed, 117 insertions, 65 deletions
diff --git a/doc/docgen.zig b/doc/docgen.zig
index bd9dc6c147..7dc444f127 100644
--- a/doc/docgen.zig
+++ b/doc/docgen.zig
@@ -95,7 +95,7 @@ const Tokenizer = struct {
};
fn init(source_file_name: []const u8, buffer: []const u8) Tokenizer {
- return Tokenizer {
+ return Tokenizer{
.buffer = buffer,
.index = 0,
.state = State.Start,
@@ -105,7 +105,7 @@ const Tokenizer = struct {
}
fn next(self: &Tokenizer) Token {
- var result = Token {
+ var result = Token{
.id = Token.Id.Eof,
.start = self.index,
.end = undefined,
@@ -197,7 +197,7 @@ const Tokenizer = struct {
};
fn getTokenLocation(self: &Tokenizer, token: &const Token) Location {
- var loc = Location {
+ var loc = Location{
.line = 0,
.column = 0,
.line_start = 0,
@@ -346,7 +346,7 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
break;
},
Token.Id.Content => {
- try nodes.append(Node {.Content = tokenizer.buffer[token.start..token.end] });
+ try nodes.append(Node{ .Content = tokenizer.buffer[token.start..token.end] });
},
Token.Id.BracketOpen => {
const tag_token = try eatToken(tokenizer, Token.Id.TagContent);
@@ -365,11 +365,13 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
header_stack_size += 1;
const urlized = try urlize(allocator, content);
- try nodes.append(Node{.HeaderOpen = HeaderOpen {
- .name = content,
- .url = urlized,
- .n = header_stack_size,
- }});
+ try nodes.append(Node{
+ .HeaderOpen = HeaderOpen{
+ .name = content,
+ .url = urlized,
+ .n = header_stack_size,
+ },
+ });
if (try urls.put(urlized, tag_token)) |other_tag_token| {
parseError(tokenizer, tag_token, "duplicate header url: #{}", urlized) catch {};
parseError(tokenizer, other_tag_token, "other tag here") catch {};
@@ -407,14 +409,14 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
switch (see_also_tok.id) {
Token.Id.TagContent => {
const content = tokenizer.buffer[see_also_tok.start..see_also_tok.end];
- try list.append(SeeAlsoItem {
+ try list.append(SeeAlsoItem{
.name = content,
.token = see_also_tok,
});
},
Token.Id.Separator => {},
Token.Id.BracketClose => {
- try nodes.append(Node {.SeeAlso = list.toOwnedSlice() } );
+ try nodes.append(Node{ .SeeAlso = list.toOwnedSlice() });
break;
},
else => return parseError(tokenizer, see_also_tok, "invalid see_also token"),
@@ -438,8 +440,8 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
}
};
- try nodes.append(Node {
- .Link = Link {
+ try nodes.append(Node{
+ .Link = Link{
.url = try urlize(allocator, url_name),
.name = name,
.token = name_tok,
@@ -463,24 +465,24 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
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 };
+ 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 };
+ code_kind_id = Code.Id{ .Exe = ExpectedOutcome.Fail };
} 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};
+ 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};
+ 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 };
+ code_kind_id = Code.Id{ .Obj = null };
} else if (mem.eql(u8, code_kind_str, "obj_err")) {
- code_kind_id = Code.Id { .Obj = name };
+ code_kind_id = Code.Id{ .Obj = name };
name = "test";
} else if (mem.eql(u8, code_kind_str, "syntax")) {
- code_kind_id = Code.Id { .Obj = null };
+ code_kind_id = Code.Id{ .Obj = null };
is_inline = true;
} else {
return parseError(tokenizer, code_kind_tok, "unrecognized code kind: {}", code_kind_str);
@@ -514,17 +516,20 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
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_windows = target_windows,
- .link_libc = link_libc,
- }});
+ } 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_windows = target_windows,
+ .link_libc = link_libc,
+ },
+ });
tokenizer.code_node_count += 1;
} else {
return parseError(tokenizer, tag_token, "unrecognized tag name: {}", tag_name);
@@ -534,7 +539,7 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) !Toc {
}
}
- return Toc {
+ return Toc{
.nodes = nodes.toOwnedSlice(),
.toc = toc_buf.toOwnedSlice(),
.urls = urls,
@@ -727,16 +732,19 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
const name_plus_ext = try std.fmt.allocPrint(allocator, "{}.zig", code.name);
const tmp_source_file_name = try os.path.join(allocator, tmp_dir_name, name_plus_ext);
try io.writeFile(allocator, tmp_source_file_name, trimmed_raw_source);
-
+
switch (code.id) {
Code.Id.Exe => |expected_outcome| {
const name_plus_bin_ext = try std.fmt.allocPrint(allocator, "{}{}", code.name, exe_ext);
const tmp_bin_file_name = try os.path.join(allocator, tmp_dir_name, name_plus_bin_ext);
var build_args = std.ArrayList([]const u8).init(allocator);
defer build_args.deinit();
- try build_args.appendSlice([][]const u8 {zig_exe,
- "build-exe", tmp_source_file_name,
- "--output", tmp_bin_file_name,
+ try build_args.appendSlice([][]const u8{
+ zig_exe,
+ "build-exe",
+ tmp_source_file_name,
+ "--output",
+ tmp_bin_file_name,
});
try out.print("<pre><code class=\"shell\">$ zig build-exe {}.zig", code.name);
switch (code.mode) {
@@ -766,10 +774,9 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
try build_args.append("c");
try out.print(" --library c");
}
- _ = exec(allocator, build_args.toSliceConst()) catch return parseError(
- tokenizer, code.source_token, "example failed to compile");
+ _ = exec(allocator, build_args.toSliceConst()) catch return parseError(tokenizer, code.source_token, "example failed to compile");
- const run_args = [][]const u8 {tmp_bin_file_name};
+ const run_args = [][]const u8{tmp_bin_file_name};
const result = if (expected_outcome == ExpectedOutcome.Fail) blk: {
const result = try os.ChildProcess.exec(allocator, run_args, null, null, max_doc_file_size);
@@ -777,7 +784,10 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
os.ChildProcess.Term.Exited => |exit_code| {
if (exit_code == 0) {
warn("{}\nThe following command incorrectly succeeded:\n", result.stderr);
- for (run_args) |arg| warn("{} ", arg) else warn("\n");
+ for (run_args) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example incorrectly compiled");
}
},
@@ -785,11 +795,9 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
}
break :blk result;
} else blk: {
- break :blk exec(allocator, run_args) catch return parseError(
- tokenizer, code.source_token, "example crashed");
+ break :blk exec(allocator, 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);
@@ -802,7 +810,11 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
- try test_args.appendSlice([][]const u8 {zig_exe, "test", tmp_source_file_name});
+ try test_args.appendSlice([][]const u8{
+ zig_exe,
+ "test",
+ tmp_source_file_name,
+ });
try out.print("<pre><code class=\"shell\">$ zig test {}.zig", code.name);
switch (code.mode) {
builtin.Mode.Debug => {},
@@ -821,13 +833,15 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
}
if (code.target_windows) {
try test_args.appendSlice([][]const u8{
- "--target-os", "windows",
- "--target-arch", "x86_64",
- "--target-environ", "msvc",
+ "--target-os",
+ "windows",
+ "--target-arch",
+ "x86_64",
+ "--target-environ",
+ "msvc",
});
}
- const result = exec(allocator, test_args.toSliceConst()) catch return parseError(
- tokenizer, code.source_token, "test failed");
+ const result = exec(allocator, test_args.toSliceConst()) 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);
try out.print("\n{}{}</code></pre>\n", escaped_stderr, escaped_stdout);
@@ -836,7 +850,13 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
- try test_args.appendSlice([][]const u8 {zig_exe, "test", "--color", "on", tmp_source_file_name});
+ try test_args.appendSlice([][]const u8{
+ zig_exe,
+ "test",
+ "--color",
+ "on",
+ tmp_source_file_name,
+ });
try out.print("<pre><code class=\"shell\">$ zig test {}.zig", code.name);
switch (code.mode) {
builtin.Mode.Debug => {},
@@ -858,13 +878,19 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
os.ChildProcess.Term.Exited => |exit_code| {
if (exit_code == 0) {
warn("{}\nThe following command incorrectly succeeded:\n", result.stderr);
- for (test_args.toSliceConst()) |arg| warn("{} ", arg) else warn("\n");
+ for (test_args.toSliceConst()) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example incorrectly compiled");
}
},
else => {
warn("{}\nThe following command crashed:\n", result.stderr);
- for (test_args.toSliceConst()) |arg| warn("{} ", arg) else warn("\n");
+ for (test_args.toSliceConst()) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example compile crashed");
},
}
@@ -881,7 +907,11 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
var test_args = std.ArrayList([]const u8).init(allocator);
defer test_args.deinit();
- try test_args.appendSlice([][]const u8 {zig_exe, "test", tmp_source_file_name});
+ try test_args.appendSlice([][]const u8{
+ zig_exe,
+ "test",
+ tmp_source_file_name,
+ });
switch (code.mode) {
builtin.Mode.Debug => {},
builtin.Mode.ReleaseSafe => try test_args.append("--release-safe"),
@@ -894,13 +924,19 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
os.ChildProcess.Term.Exited => |exit_code| {
if (exit_code == 0) {
warn("{}\nThe following command incorrectly succeeded:\n", result.stderr);
- for (test_args.toSliceConst()) |arg| warn("{} ", arg) else warn("\n");
+ for (test_args.toSliceConst()) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example test incorrectly succeeded");
}
},
else => {
warn("{}\nThe following command crashed:\n", result.stderr);
- for (test_args.toSliceConst()) |arg| warn("{} ", arg) else warn("\n");
+ for (test_args.toSliceConst()) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example compile crashed");
},
}
@@ -918,9 +954,15 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
var build_args = std.ArrayList([]const u8).init(allocator);
defer build_args.deinit();
- try build_args.appendSlice([][]const u8 {zig_exe, "build-obj", tmp_source_file_name,
- "--color", "on",
- "--output", tmp_obj_file_name});
+ try build_args.appendSlice([][]const u8{
+ zig_exe,
+ "build-obj",
+ tmp_source_file_name,
+ "--color",
+ "on",
+ "--output",
+ tmp_obj_file_name,
+ });
if (!code.is_inline) {
try out.print("<pre><code class=\"shell\">$ zig build-obj {}.zig", code.name);
@@ -954,13 +996,19 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
os.ChildProcess.Term.Exited => |exit_code| {
if (exit_code == 0) {
warn("{}\nThe following command incorrectly succeeded:\n", result.stderr);
- for (build_args.toSliceConst()) |arg| warn("{} ", arg) else warn("\n");
+ for (build_args.toSliceConst()) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example build incorrectly succeeded");
}
},
else => {
warn("{}\nThe following command crashed:\n", result.stderr);
- for (build_args.toSliceConst()) |arg| warn("{} ", arg) else warn("\n");
+ for (build_args.toSliceConst()) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return parseError(tokenizer, code.source_token, "example compile crashed");
},
}
@@ -975,8 +1023,7 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
try out.print("</code></pre>\n");
}
} else {
- _ = exec(allocator, build_args.toSliceConst()) catch return parseError(
- tokenizer, code.source_token, "example failed to compile");
+ _ = exec(allocator, build_args.toSliceConst()) catch return parseError(tokenizer, code.source_token, "example failed to compile");
}
if (!code.is_inline) {
try out.print("</code></pre>\n");
@@ -987,7 +1034,6 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: var
},
}
}
-
}
fn exec(allocator: &mem.Allocator, args: []const []const u8) !os.ChildProcess.ExecResult {
@@ -996,13 +1042,19 @@ fn exec(allocator: &mem.Allocator, args: []const []const u8) !os.ChildProcess.Ex
os.ChildProcess.Term.Exited => |exit_code| {
if (exit_code != 0) {
warn("{}\nThe following command exited with code {}:\n", result.stderr, exit_code);
- for (args) |arg| warn("{} ", arg) else warn("\n");
+ for (args) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return error.ChildExitError;
}
},
else => {
warn("{}\nThe following command crashed:\n", result.stderr);
- for (args) |arg| warn("{} ", arg) else warn("\n");
+ for (args) |arg|
+ warn("{} ", arg)
+ else
+ warn("\n");
return error.ChildCrashed;
},
}