authorgravatar for me@paperdave.netdave caruso <me@paperdave.net> 2024-09-14 20:21:19-04:00
committergravatar for me@paperdave.netdave caruso <me@paperdave.net> 2024-09-14 20:21:19-04:00
loge52a575edb42a6339b121ed77629b3874d1fe8f4
tree61799ec08d57af7449ca48b4361e49686dfa1f91
parent03d5aa6a575bcd5237473b8f87d273504e6ed4b9
signature Commit is signed but in an unrecognized format.

chore: rework some CLI programs to use Cli.zig

4 files changed, 176 insertions(+), 98 deletions(-)

src/cli.zig+5-1
...@@ -8,7 +8,7 @@ options: []const Option = &.{},...@@ -8,7 +8,7 @@ options: []const Option = &.{},
8positionals: Positionals = .none,8positionals: Positionals = .none,
9help: HelpConfig = .{},9help: HelpConfig = .{},
1010
11const Option = struct {11pub const Option = struct {
12 /// Should be formatted as the flag name: '--dump-ir'12 /// Should be formatted as the flag name: '--dump-ir'
13 name: []const u8,13 name: []const u8,
14 /// Displayed in generated help menu14 /// Displayed in generated help menu
...@@ -32,6 +32,10 @@ const Option = struct {...@@ -32,6 +32,10 @@ const Option = struct {
32 }32 }
33 };33 };
3434
35 pub fn optional(comptime cond: bool, opts: []const Option) []const Option {
36 return if (cond) opts else &.{};
37 }
38
35 const help: Option = .{39 const help: Option = .{
36 .name = "--help",40 .name = "--help",
37 .short = 'h',41 .short = 'h',
src/cli_compiler.zig created+145
...@@ -0,0 +1,145 @@
1//! For testing the core compiler with minimal feature and
2//! additional debugging parameters.
3
4const config = @import("config");
5
6const arg_config: Cli = .{
7 .options = &.{
8 .{ .short = 'i', .name = "--dump-ir", .desc = "Dump intermediate representations" },
9 .{ .name = "--dump-state", .desc = "Dump compiler state to JSON", .kind = .string },
10 .{ .short = 'r', .name = "--report-trace", .desc = "Print stack traces to errors" },
11 .{ .short = 'L', .name = "--no-leak-checks", .desc = "" },
12 },
13 .positionals = .single,
14 .help = .{
15 .usage = "[options...] [entry file]",
16 },
17};
18
19pub fn main() !u8 {
20 try tracer.init();
21 defer tracer.deinit();
22 try tracer.init_thread(null);
23 defer tracer.deinit_thread();
24
25 // unicode props is asserted to be initialized before core.Tokenizer is used
26 // this will result in a static page allocation, which is never cleaned up.
27 try core.unicode_props.init();
28
29 const use_gpa = builtin.mode == .Debug;
30 var gpa = if (use_gpa)
31 std.heap.GeneralPurposeAllocator(.{
32 .stack_trace_frames = 100,
33 }){}
34 else
35 std.heap.ArenaAllocator.init(std.heap.page_allocator);
36 var no_leak_checks = false;
37 defer _ = if (use_gpa and !no_leak_checks) gpa.deinit();
38 const alloc = gpa.allocator();
39
40 // Current working directory is required for CLI resolution.
41 var cwd_buf: [std.fs.max_path_bytes]u8 = undefined;
42 const cwd = try std.posix.getcwd(&cwd_buf);
43
44 // Command line argument parsing.
45 const program_name = "zig build compiler --";
46 _, const args = try Cli.programArgsAlloc(alloc, program_name);
47 const opts = arg_config.parse(program_name, args);
48
49 const file_path = try std.fs.path.resolve(alloc, &.{
50 cwd,
51 opts.positionals orelse
52 arg_config.showHelpAndExit(program_name),
53 });
54 defer alloc.free(file_path);
55
56 no_leak_checks = opts.no_leak_checks orelse false;
57
58 // Execute compiler
59 {
60 var js_backend = core.Js{};
61
62 var comp = try core.Comp.init(.{
63 .gpa = tracer.tracingAllocator(&alloc),
64 .options = .{
65 .dump_ir = opts.dump_ir orelse false,
66 },
67 .backend = .{ .js = &js_backend },
68 });
69 defer comp.deinit();
70
71 defer if (opts.dump_state) |path| {
72 dumpState(&comp, path) catch |err| {
73 std.debug.print("Failed to dump compilation state: {}", .{err});
74 };
75 };
76
77 const main_file = try comp.getFile(file_path);
78
79 var fail_report: Report = undefined;
80 const teg = main_file.getTeg(&comp, &fail_report) catch |err| switch (err) {
81 error.TransformFail => {
82 std.debug.print("Transform failed:\n", .{});
83 try fail_report.dump(.initComp(&comp, main_file), comp.out);
84 fail_report.deinit(comp.gpa);
85 return 1;
86 },
87 error.ParseFail => {
88 // Already printed.
89 return 1;
90 },
91 else => return err,
92 };
93
94 if (comp.options.dump_ir) {
95 const stderr = std.io.getStdErr().writer();
96 try teg.dumpToWriter(stderr, null);
97 }
98
99 const entry_point = try comp.enqueueEntryModule(main_file);
100 comp.runAllJobs() catch |err| switch (err) {
101 error.AnalysisFail => {
102 // error is already printed
103 return 1;
104 },
105 else => return err,
106 };
107
108 {
109 // Output to standard out
110 const output = std.io.getStdOut().writer();
111 var bufw = std.io.bufferedWriter(output);
112 const writer = bufw.writer();
113 try js_backend.link(&comp, entry_point, writer.any());
114 try bufw.flush();
115 }
116 }
117
118 std.process.cleanExit();
119 return 0;
120}
121
122const core = @import("core");
123const Comp = core.Comp;
124const Report = core.Report;
125
126const tracer = @import("tracer");
127pub const tracer_impl = @field(tracer, @tagName(@import("config").tracing_mode));
128
129const std = @import("std");
130const builtin = @import("builtin");
131const Cli = @import("Cli.zig");
132
133fn dumpState(comp: *const Comp, dump_path: []const u8) !void {
134 const file = try std.fs.cwd().createFile(dump_path, .{});
135 defer file.close();
136
137 var bufw = std.io.bufferedWriter(file.writer());
138 var jw = std.json.writeStream(bufw.writer(), .{
139 .whitespace = .indent_2,
140 });
141
142 try comp.jsonStringify(&jw);
143 try bufw.writer().writeAll("\n");
144 try bufw.flush();
145}
src/cli_transform.zig+1-2
...@@ -25,8 +25,7 @@ pub fn main() !u8 {...@@ -25,8 +25,7 @@ pub fn main() !u8 {
25 const program_name, const raw_args = try Cli.programArgsAlloc(alloc, "transform");25 const program_name, const raw_args = try Cli.programArgsAlloc(alloc, "transform");
26 defer Cli.programArgsFree(alloc, raw_args);26 defer Cli.programArgsFree(alloc, raw_args);
2727
28 const args = arg_config.parse(raw_args) catch28 const args = arg_config.parse(program_name, raw_args);
29 arg_config.showHelpAndExit(program_name);
3029
31 const file_path = args.positionals orelse30 const file_path = args.positionals orelse
32 arg_config.fatalWithHelp(program_name, "missing filepath argument\n", .{});31 arg_config.fatalWithHelp(program_name, "missing filepath argument\n", .{});
src/main.zig+25-95
...@@ -4,9 +4,18 @@...@@ -4,9 +4,18 @@
4//! for example, test the `core` module's compilation features without4//! for example, test the `core` module's compilation features without
5//! needing to compile the formatter.5//! needing to compile the formatter.
66
7const have_debug_features = builtin.mode == .Debug;
8const config = @import("config");7const config = @import("config");
98
9const arg_config: Cli = .{
10 .options = .{
11 .{ .short = 'i', .name = "--dump-ir", .desc = "Dump intermediate representations" },
12 .{ .name = "--dump-state", .desc = "Dump compiler state to JSON", .kind = .string },
13 } ++ Cli.Option.optional(config.have_embedded_quickjs, &.{
14 .{ .name = "--run", .desc = "Execute with QuickJS" },
15 }),
16 .positionals = .single,
17};
18
10pub fn main() !u8 {19pub fn main() !u8 {
11 try tracer.init();20 try tracer.init();
12 defer tracer.deinit();21 defer tracer.deinit();
...@@ -24,8 +33,7 @@ pub fn main() !u8 {...@@ -24,8 +33,7 @@ pub fn main() !u8 {
24 }){}33 }){}
25 else34 else
26 std.heap.ArenaAllocator.init(std.heap.page_allocator);35 std.heap.ArenaAllocator.init(std.heap.page_allocator);
27 var no_leak_checks = false;36 defer _ = if (use_gpa) gpa.deinit();
28 defer _ = if (use_gpa and !no_leak_checks) gpa.deinit();
29 const alloc = gpa.allocator();37 const alloc = gpa.allocator();
3038
31 // Current working directory is required for CLI resolution.39 // Current working directory is required for CLI resolution.
...@@ -33,95 +41,16 @@ pub fn main() !u8 {...@@ -33,95 +41,16 @@ pub fn main() !u8 {
33 const cwd = try std.posix.getcwd(&cwd_buf);41 const cwd = try std.posix.getcwd(&cwd_buf);
3442
35 // Command line argument parsing.43 // Command line argument parsing.
36 var maybe_file_path: ?[]const u8 = null;44 const program_name = "zig build compiler --";
37 defer if (maybe_file_path) |path| alloc.free(path);45 _, const args = try Cli.programArgsAlloc(alloc, program_name);
38 var exe_name: ?[]const u8 = null;46 const opts = arg_config.parse(program_name, args);
39 defer if (exe_name) |path| alloc.free(path);47
40 var dump_ir = false;48 const file_path = try std.fs.path.resolve(alloc, &.{
41 var dump_state: ?[]const u8 = null;49 cwd,
42 var run = false;50 opts.positionals orelse
43 var has_errors = false;51 arg_config.showHelpAndExit(program_name),
44 {52 });
45 var args = try std.process.argsWithAllocator(alloc);53 defer alloc.free(file_path);
46 defer args.deinit();
47
48 exe_name = try alloc.dupe(u8, std.fs.path.basename(args.next() orelse "cli"));
49
50 while (args.next()) |arg| {
51 if (std.mem.startsWith(u8, arg, "-")) {
52 if (have_debug_features) {
53 if (std.mem.eql(u8, arg, "--report-trace")) {
54 core.Report.debug_show_report_trace = true;
55 continue;
56 }
57 if (std.mem.eql(u8, arg, "--no-leak-checks")) {
58 no_leak_checks = true;
59 continue;
60 }
61 }
62
63 if (std.mem.eql(u8, arg, "--dump-ir")) {
64 dump_ir = true;
65 continue;
66 }
67
68 if (std.mem.startsWith(u8, arg, "--dump-state=")) {
69 dump_state = arg["--dump-state=".len..];
70 continue;
71 }
72
73 if (config.have_embedded_quickjs and std.mem.eql(u8, arg, "--run")) {
74 run = true;
75 continue;
76 }
77
78 std.debug.print("error: unknown flag '{s}'\n", .{arg});
79 has_errors = true;
80 break;
81 }
82
83 if (maybe_file_path == null) {
84 maybe_file_path = try std.fs.path.resolve(alloc, &.{ cwd, arg });
85 } else {
86 std.debug.print("error: multiple files specified\n", .{});
87 maybe_file_path = null;
88 break;
89 }
90 }
91 }
92
93 if (maybe_file_path == null) has_errors = true;
94 if (has_errors) {
95 std.debug.print("Usage: {s} [flags] <input file>\n", .{exe_name.?});
96 {
97 std.debug.print(
98 // | 60 chars wrap point|
99 \\
100 \\Flags:
101 \\ --dump-ir Dump intermediate representations
102 \\ --dump-state=<path> Dump compiler state to JSON
103 \\
104 , .{});
105 }
106 if (config.have_embedded_quickjs) {
107 std.debug.print(
108 \\ --run Run program using QuickJS
109 \\
110 , .{});
111 }
112 if (have_debug_features) {
113 std.debug.print(
114 \\
115 \\Debug Mode Flags:
116 \\ --report-trace Print stack traces per error
117 \\ --no-leak-checks
118 \\
119 , .{});
120 }
121 std.debug.print("\nLanguage SDK v" ++ config.version_string ++ "\n", .{});
122 return 1;
123 }
124 const file_path = maybe_file_path.?;
12554
126 // Execute compiler55 // Execute compiler
127 {56 {
...@@ -130,13 +59,13 @@ pub fn main() !u8 {...@@ -130,13 +59,13 @@ pub fn main() !u8 {
130 var comp = try core.Comp.init(.{59 var comp = try core.Comp.init(.{
131 .gpa = tracer.tracingAllocator(&alloc),60 .gpa = tracer.tracingAllocator(&alloc),
132 .options = .{61 .options = .{
133 .dump_ir = dump_ir,62 .dump_ir = opts.dump_ir orelse false,
134 },63 },
135 .backend = .{ .js = &js_backend },64 .backend = .{ .js = &js_backend },
136 });65 });
137 defer comp.deinit();66 defer comp.deinit();
13867
139 defer if (dump_state) |path| {68 defer if (opts.dump_state) |path| {
140 dumpState(&comp, path) catch |err| {69 dumpState(&comp, path) catch |err| {
141 std.debug.print("Failed to dump compilation state: {}", .{err});70 std.debug.print("Failed to dump compilation state: {}", .{err});
142 };71 };
...@@ -173,7 +102,7 @@ pub fn main() !u8 {...@@ -173,7 +102,7 @@ pub fn main() !u8 {
173 else => return err,102 else => return err,
174 };103 };
175104
176 if (config.have_embedded_quickjs and run) {105 if (config.have_embedded_quickjs and (opts.run orelse false)) {
177 // Execute with QuickJS106 // Execute with QuickJS
178 var out: std.ArrayListUnmanaged(u8) = .{};107 var out: std.ArrayListUnmanaged(u8) = .{};
179 defer out.deinit(alloc);108 defer out.deinit(alloc);
...@@ -244,6 +173,7 @@ pub const tracer_impl = @field(tracer, @tagName(@import("config").tracing_mode))...@@ -244,6 +173,7 @@ pub const tracer_impl = @field(tracer, @tagName(@import("config").tracing_mode))
244173
245const std = @import("std");174const std = @import("std");
246const builtin = @import("builtin");175const builtin = @import("builtin");
176const Cli = @import("Cli.zig");
247177
248fn dumpState(comp: *const Comp, dump_path: []const u8) !void {178fn dumpState(comp: *const Comp, dump_path: []const u8) !void {
249 const file = try std.fs.cwd().createFile(dump_path, .{});179 const file = try std.fs.cwd().createFile(dump_path, .{});