docgen: support executing exe code examples

See #465
ziglang · Jan 17, 2018 · 1eda7e0 · 1eda7e0
1 parent 5aefabe
commit 1eda7e0
Show file tree

Hide file tree

Showing 5 changed files with 171 additions and 17 deletions.
diff --git a/build.zig b/build.zig
@@ -15,15 +15,18 @@ pub fn build(b: &Builder) -> %void {
 
     var docgen_exe = b.addExecutable("docgen", "doc/docgen.zig");
 
+    const rel_zig_exe = try os.path.relative(b.allocator, b.build_root, b.zig_exe);
     var docgen_cmd = b.addCommand(null, b.env_map, [][]const u8 {
         docgen_exe.getOutputPath(),
+        rel_zig_exe,
         "doc/langref.html.in",
         os.path.join(b.allocator, b.cache_root, "langref.html") catch unreachable,
     });
     docgen_cmd.step.dependOn(&docgen_exe.step);
 
     var docgen_home_cmd = b.addCommand(null, b.env_map, [][]const u8 {
         docgen_exe.getOutputPath(),
+        rel_zig_exe,
         "doc/home.html.in",
         os.path.join(b.allocator, b.cache_root, "home.html") catch unreachable,
     });

diff --git a/doc/docgen.zig b/doc/docgen.zig
@@ -4,7 +4,9 @@ const os = std.os;
 const warn = std.debug.warn;
 const mem = std.mem;
 
-pub const max_doc_file_size = 10 * 1024 * 1024;
+const max_doc_file_size = 10 * 1024 * 1024;
+
+const exe_ext = std.build.Target(std.build.Target.Native).exeFileExt();
 
 pub fn main() -> %void {
     // TODO use a more general purpose allocator here
@@ -16,6 +18,9 @@ pub fn main() -> %void {
 
     if (!args_it.skip()) @panic("expected self arg");
 
+    const zig_exe = try (args_it.next(allocator) ?? @panic("expected zig exe arg"));
+    defer allocator.free(zig_exe);
+
     const in_file_name = try (args_it.next(allocator) ?? @panic("expected input arg"));
     defer allocator.free(in_file_name);
 
@@ -38,7 +43,7 @@ pub fn main() -> %void {
     var tokenizer = Tokenizer.init(in_file_name, input_file_bytes);
     var toc = try genToc(allocator, &tokenizer);
 
-    try genHtml(allocator, &tokenizer, &toc, &buffered_out_stream.stream);
+    try genHtml(allocator, &tokenizer, &toc, &buffered_out_stream.stream, zig_exe);
     try buffered_out_stream.flush();
 }
 
@@ -246,11 +251,24 @@ const SeeAlsoItem = struct {
     token: Token,
 };
 
+const Code = struct {
+    id: Id,
+    name: []const u8,
+    source_token: Token,
+
+    const Id = enum {
+        Test,
+        Exe,
+        Error,
+    };
+};
+
 const Node = union(enum) {
     Content: []const u8,
     Nav,
     HeaderOpen: HeaderOpen,
     SeeAlso: []const SeeAlsoItem,
+    Code: Code,
 };
 
 const Toc = struct {
@@ -300,14 +318,14 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) -> %Toc {
                 const tag_name = tokenizer.buffer[tag_token.start..tag_token.end];
 
                 if (mem.eql(u8, tag_name, "nav")) {
-                    _ = eatToken(tokenizer, Token.Id.BracketClose);
+                    _ = try eatToken(tokenizer, Token.Id.BracketClose);
 
                     try nodes.append(Node.Nav);
                 } else if (mem.eql(u8, tag_name, "header_open")) {
-                    _ = eatToken(tokenizer, Token.Id.Separator);
+                    _ = 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];
-                    _ = eatToken(tokenizer, Token.Id.BracketClose);
+                    _ = try eatToken(tokenizer, Token.Id.BracketClose);
 
                     header_stack_size += 1;
 
@@ -336,7 +354,7 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) -> %Toc {
                         return parseError(tokenizer, tag_token, "unbalanced close header");
                     }
                     header_stack_size -= 1;
-                    _ = eatToken(tokenizer, Token.Id.BracketClose);
+                    _ = try eatToken(tokenizer, Token.Id.BracketClose);
 
                     if (last_action == Action.Close) {
                         try toc.writeByteNTimes(' ', 8 + header_stack_size * 4);
@@ -367,6 +385,44 @@ fn genToc(allocator: &mem.Allocator, tokenizer: &Tokenizer) -> %Toc {
                             else => return parseError(tokenizer, see_also_tok, "invalid see_also token"),
                         }
                     }
+                } 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 => {},
+                        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;
+                    if (mem.eql(u8, code_kind_str, "exe")) {
+                        code_kind_id = Code.Id.Exe;
+                    } else if (mem.eql(u8, code_kind_str, "test")) {
+                        code_kind_id = Code.Id.Test;
+                    } else if (mem.eql(u8, code_kind_str, "error")) {
+                        code_kind_id = Code.Id.Error;
+                    } else {
+                        return parseError(tokenizer, code_kind_tok, "unrecognized code kind: {}", code_kind_str);
+                    }
+                    const source_token = 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_end")) {
+                        return parseError(tokenizer, end_code_tag, "expected code_end token");
+                    }
+                    _ = try eatToken(tokenizer, Token.Id.BracketClose);
+                    try nodes.append(Node {.Code = Code{
+                        .id = code_kind_id,
+                        .name = name,
+                        .source_token = source_token,
+                    }});
                 } else {
                     return parseError(tokenizer, tag_token, "unrecognized tag name: {}", tag_name);
                 }
@@ -402,7 +458,27 @@ fn urlize(allocator: &mem.Allocator, input: []const u8) -> %[]u8 {
     return buf.toOwnedSlice();
 }
 
-fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: &io.OutStream) -> %void {
+fn escapeHtml(allocator: &mem.Allocator, input: []const u8) -> %[]u8 {
+    var buf = try std.Buffer.initSize(allocator, 0);
+    defer buf.deinit();
+
+    var buf_adapter = io.BufferOutStream.init(&buf);
+    var out = &buf_adapter.stream;
+    for (input) |c| {
+        try switch (c) {
+            '&' => out.write("&amp;"),
+            '<' => out.write("&lt;"),
+            '>' => out.write("&gt;"),
+            '"' => out.write("&quot;"),
+            else => out.writeByte(c),
+        };
+    }
+    return buf.toOwnedSlice();
+}
+
+error ExampleFailedToCompile;
+
+fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: &io.OutStream, zig_exe: []const u8) -> %void {
     for (toc.nodes) |node| {
         switch (node) {
             Node.Content => |data| {
@@ -425,6 +501,65 @@ fn genHtml(allocator: &mem.Allocator, tokenizer: &Tokenizer, toc: &Toc, out: &io
                 }
                 try out.write("</ul>\n");
             },
+            Node.Code => |code| {
+                const raw_source = tokenizer.buffer[code.source_token.start..code.source_token.end];
+                const trimmed_raw_source = mem.trim(u8, raw_source, " \n");
+                const escaped_source = try escapeHtml(allocator, trimmed_raw_source);
+                try out.print("<pre><code class=\"zig\">{}</code></pre>", escaped_source);
+                const tmp_dir_name = "docgen_tmp";
+                try os.makePath(allocator, tmp_dir_name);
+                const name_plus_ext = try std.fmt.allocPrint(allocator, "{}.zig", code.name);
+                const name_plus_bin_ext = try std.fmt.allocPrint(allocator, "{}{}", code.name, exe_ext);
+                const tmp_source_file_name = try os.path.join(allocator, tmp_dir_name, name_plus_ext);
+                const tmp_bin_file_name = try os.path.join(allocator, tmp_dir_name, name_plus_bin_ext);
+                try io.writeFile(tmp_source_file_name, trimmed_raw_source, null);
+
+                switch (code.id) {
+                    Code.Id.Exe => {
+                        {
+                            const args = [][]const u8 {zig_exe, "build-exe", tmp_source_file_name, "--output", tmp_bin_file_name};
+                            const result = try os.ChildProcess.exec(allocator, args, null, null, max_doc_file_size);
+                            switch (result.term) {
+                                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");
+                                        return parseError(tokenizer, code.source_token, "example failed to compile");
+                                    }
+                                },
+                                else => {
+                                    warn("{}\nThe following command crashed:\n", result.stderr);
+                                    for (args) |arg| warn("{} ", arg) else warn("\n");
+                                    return parseError(tokenizer, code.source_token, "example failed to compile");
+                                },
+                            }
+                        }
+                        const args = [][]const u8 {tmp_bin_file_name};
+                        const result = try os.ChildProcess.exec(allocator, args, null, null, max_doc_file_size);
+                        switch (result.term) {
+                            os.ChildProcess.Term.Exited => |exit_code| {
+                                if (exit_code != 0) {
+                                    warn("The following command exited with code {}:\n", exit_code);
+                                    for (args) |arg| warn("{} ", arg) else warn("\n");
+                                    return parseError(tokenizer, code.source_token, "example exited with code {}", exit_code);
+                                }
+                            },
+                            else => {
+                                warn("The following command crashed:\n");
+                                for (args) |arg| warn("{} ", arg) else warn("\n");
+                                return parseError(tokenizer, code.source_token, "example crashed");
+                            },
+                        }
+                        try out.print("<pre><code class=\"sh\">$ zig build-exe {}.zig\n$ ./{}\n{}{}</code></pre>\n", code.name, code.name, result.stderr, result.stdout);
+                    },
+                    Code.Id.Test => {
+                        @panic("TODO");
+                    },
+                    Code.Id.Error => {
+                        @panic("TODO");
+                    },
+                }
+            },
         }
     }
 

diff --git a/doc/langref.html.in b/doc/langref.html.in
@@ -55,28 +55,30 @@
       </p>
       {#header_close#}
       {#header_open|Hello World#}
-    <pre><code class="zig">const std = @import("std");
 
-pub fn main() -&gt; %void {
+      {#code_begin|exe|hello#}
+const std = @import("std");
+
+pub fn main() -> %void {
     // If this program is run without stdout attached, exit with an error.
     var stdout_file = try std.io.getStdOut();
     // If this program encounters pipe failure when printing to stdout, exit
     // with an error.
     try stdout_file.write("Hello, world!\n");
-}</code></pre>
-      <pre><code class="sh">$ zig build-exe hello.zig
-$ ./hello
-Hello, world!</code></pre>
+}
+      {#code_end#}
       <p>
       Usually you don't want to write to stdout. You want to write to stderr. And you
       don't care if it fails. It's more like a <em>warning message</em> that you want
       to emit. For that you can use a simpler API:
       </p>
-    <pre><code class="zig">const warn = @import("std").debug.warn;
+      {#code_begin|exe|hello#}
+const warn = @import("std").debug.warn;
 
-pub fn main() -&gt; %void {
+pub fn main() -> %void {
     warn("Hello, world!\n");
-}</code></pre>
+}
+      {#code_end#}
       {#see_also|Values|@import|Errors|Root Source File#}
       {#header_close#}
       {#header_open|Source Encoding#}

diff --git a/std/build.zig b/std/build.zig
@@ -760,7 +760,7 @@ const CrossTarget = struct {
     environ: builtin.Environ,
 };
 
-const Target = union(enum) {
+pub const Target = union(enum) {
     Native: void,
     Cross: CrossTarget,
 

diff --git a/std/mem.zig b/std/mem.zig
@@ -203,6 +203,20 @@ pub fn dupe(allocator: &Allocator, comptime T: type, m: []const T) -> %[]T {
     return new_buf;
 }
 
+/// Remove values from the beginning and end of a slice.
+pub fn trim(comptime T: type, slice: []const T, values_to_strip: []const T) -> []const T {
+    var begin: usize = 0;
+    var end: usize = slice.len;
+    while (begin < end and indexOfScalar(T, values_to_strip, slice[begin]) != null) : (begin += 1) {}
+    while (end > begin and indexOfScalar(T, values_to_strip, slice[end - 1]) != null) : (end -= 1) {}
+    return slice[begin..end];
+}
+
+test "mem.trim" {
+    assert(eql(u8, trim(u8, " foo\n ", " \n"), "foo"));
+    assert(eql(u8, trim(u8, "foo", " \n"), "foo"));
+}
+
 /// Linear search for the index of a scalar value inside a slice.
 pub fn indexOfScalar(comptime T: type, slice: []const T, value: T) -> ?usize {
     return indexOfScalarPos(T, slice, 0, value);