authorgravatar for der.teufel.mail@gmail.comKrzysztof Wolicki <der.teufel.mail@gmail.com> 2023-04-17 03:01:55+02:00
committergravatar for der.teufel.mail@gmail.comKrzysztof Wolicki <der.teufel.mail@gmail.com> 2023-04-22 02:36:19+02:00
log428f7452704d1a7b3d9da8e7d4d408db4cbff81f
tree9284f7e551ad30820be805661270868011e795f1
parent4374ce51b0ffdaa317b6678d6622ecb88877f7f9

autodoc: Change html file destination dirs

Each file is now saved with its package index in data.json

2 files changed, 50 insertions(+), 30 deletions(-)

lib/docs/main.js+13-3
......@@ -66,7 +66,7 @@ const NAV_MODES = {
6666 const domHdrName = document.getElementById("hdrName");
6767 const domHelpModal = document.getElementById("helpModal");
6868 const domSearchPlaceholder = document.getElementById("searchPlaceholder");
69 const sourceFileUrlTemplate = "src/{{file}}.html#L{{line}}"
69 const sourceFileUrlTemplate = "src/{{pkg}}/{{file}}.html#L{{line}}"
7070 const domLangRefLink = document.getElementById("langRefLink");
7171
7272 let searchTimer = null;
......@@ -446,7 +446,7 @@ const NAV_MODES = {
446446
447447 if (activeGuide == undefined) {
448448 const root_file_idx = zigAnalysis.packages[zigAnalysis.rootPkg].file;
449 const root_file_name = zigAnalysis.files[root_file_idx];
449 const root_file_name = getFile(root_file_idx).name;
450450 domGuides.innerHTML = markdown(`
451451 # Zig Guides
452452 These autodocs don't contain any guide.
......@@ -2685,8 +2685,10 @@ const NAV_MODES = {
26852685
26862686 function sourceFileLink(decl) {
26872687 const srcNode = getAstNode(decl.src);
2688 const srcFile = getFile(srcNode.file);
26882689 return sourceFileUrlTemplate.
2689 replace("{{file}}", zigAnalysis.files[srcNode.file]).
2690 replace("{{pkg}}", zigAnalysis.packages[srcFile.pkgIndex].name).
2691 replace("{{file}}", srcFile.name).
26902692 replace("{{line}}", srcNode.line + 1);
26912693 }
26922694
......@@ -4135,6 +4137,14 @@ function addDeclToSearchResults(decl, declIndex, pkgNames, item, list, stack) {
41354137 };
41364138 }
41374139
4140 function getFile(idx) {
4141 const file = zigAnalysis.files[idx];
4142 return {
4143 name: file[0],
4144 pkgIndex: file[1],
4145 };
4146 }
4147
41384148 function getType(idx) {
41394149 const ty = zigAnalysis.types[idx];
41404150 switch (ty[0]) {
src/Autodoc.zig+37-27
......@@ -255,7 +255,7 @@ pub fn generateZirData(self: *Autodoc) !void {
255255
256256 var data = DocData{
257257 .params = .{},
258 .packages = self.packages.values(),
258 .packages = self.packages,
259259 .files = self.files,
260260 .calls = self.calls.items,
261261 .types = self.types.items,
......@@ -313,9 +313,26 @@ pub fn generateZirData(self: *Autodoc) !void {
313313 var files_iterator = self.files.iterator();
314314
315315 while (files_iterator.next()) |entry| {
316 const new_html_path = try std.mem.concat(self.arena, u8, &.{ entry.key_ptr.*.sub_file_path, ".html" });
316 const sub_file_path = entry.key_ptr.*.sub_file_path;
317 const file_package = entry.key_ptr.*.pkg;
318 const package_name = (self.packages.get(file_package) orelse continue).name;
317319
318 const html_file = try createFromPath(html_dir, new_html_path);
320 const file_path = std.fs.path.dirname(sub_file_path) orelse "";
321 const file_name = if (file_path.len > 0) sub_file_path[file_path.len + 1 ..] else sub_file_path;
322
323 const html_file_name = try std.mem.concat(self.arena, u8, &.{ file_name, ".html" });
324 defer self.arena.free(html_file_name);
325
326 const dir_name = try std.fs.path.join(self.arena, &.{ package_name, file_path });
327 defer self.arena.free(dir_name);
328
329 var dir = try html_dir.makeOpenPath(dir_name, .{});
330 defer dir.close();
331
332 const html_file = dir.createFile(html_file_name, .{}) catch |err| switch (err) {
333 error.PathAlreadyExists => try dir.openFile(html_file_name, .{}),
334 else => return err,
335 };
319336 defer html_file.close();
320337 var buffer = std.io.bufferedWriter(html_file.writer());
321338
......@@ -333,26 +350,6 @@ pub fn generateZirData(self: *Autodoc) !void {
333350 try docs_dir.copyFile("index.html", output_dir, "index.html", .{});
334351}
335352
336fn createFromPath(base_dir: std.fs.Dir, path: []const u8) !std.fs.File {
337 var path_tokens = std.mem.tokenize(u8, path, std.fs.path.sep_str);
338 var dir = base_dir;
339 while (path_tokens.next()) |toc| {
340 if (path_tokens.peek() != null) {
341 dir.makeDir(toc) catch |e| switch (e) {
342 error.PathAlreadyExists => {},
343 else => |err| return err,
344 };
345 dir = try dir.openDir(toc, .{});
346 } else {
347 return dir.createFile(toc, .{}) catch |e| switch (e) {
348 error.PathAlreadyExists => try dir.openFile(toc, .{}),
349 else => |err| return err,
350 };
351 }
352 }
353 return error.EmptyPath;
354}
355
356353/// Represents a chain of scopes, used to resolve decl references to the
357354/// corresponding entry in `self.decls`. It also keeps track of whether
358355/// a given decl has been analyzed or not.
......@@ -417,7 +414,7 @@ const DocData = struct {
417414 .{ .target = "arst" },
418415 },
419416 },
420 packages: []const DocPackage,
417 packages: std.AutoArrayHashMapUnmanaged(*Package, DocPackage),
421418 errors: []struct {} = &.{},
422419
423420 // non-hardcoded stuff
......@@ -449,8 +446,12 @@ const DocData = struct {
449446 const f_name = @tagName(f);
450447 try jsw.objectField(f_name);
451448 switch (f) {
452 .files => try writeFileTableToJson(self.files, &jsw),
449 .files => try writeFileTableToJson(self.files, self.packages, &jsw),
453450 .guide_sections => try writeGuidesToJson(self.guide_sections, &jsw),
451 .packages => {
452 try std.json.stringify(self.packages.values(), opts, w);
453 jsw.state_index -= 1;
454 },
454455 else => {
455456 try std.json.stringify(@field(self, f_name), opts, w);
456457 jsw.state_index -= 1;
......@@ -950,7 +951,7 @@ fn walkInstruction(
950951 .table = .{},
951952 };
952953
953 // TODO: Add this package as a dependency to the current pakcage
954 // TODO: Add this package as a dependency to the current package
954955 // TODO: this seems something that could be done in bulk
955956 // at the beginning or the end, or something.
956957 const root_src_dir = other_package.root_src_directory;
......@@ -4627,12 +4628,21 @@ fn cteTodo(self: *Autodoc, msg: []const u8) error{OutOfMemory}!DocData.WalkResul
46274628 return DocData.WalkResult{ .expr = .{ .comptimeExpr = cte_slot_index } };
46284629}
46294630
4630fn writeFileTableToJson(map: std.AutoArrayHashMapUnmanaged(*File, usize), jsw: anytype) !void {
4631fn writeFileTableToJson(
4632 map: std.AutoArrayHashMapUnmanaged(*File, usize),
4633 pkgs: std.AutoArrayHashMapUnmanaged(*Package, DocData.DocPackage),
4634 jsw: anytype,
4635) !void {
46314636 try jsw.beginArray();
46324637 var it = map.iterator();
46334638 while (it.next()) |entry| {
4639 try jsw.arrayElem();
4640 try jsw.beginArray();
46344641 try jsw.arrayElem();
46354642 try jsw.emitString(entry.key_ptr.*.sub_file_path);
4643 try jsw.arrayElem();
4644 try jsw.emitNumber(pkgs.getIndex(entry.key_ptr.*.pkg) orelse 0);
4645 try jsw.endArray();
46364646 }
46374647 try jsw.endArray();
46384648}