Commit b488f97e92115581e12ac1a5aee6362fc4f12563 | zig

author	Krzysztof Wolicki <der.teufel.mail@gmail.com> 2023-05-08 22:34:46+02:00
committer	Krzysztof Wolicki <der.teufel.mail@gmail.com> 2023-05-08 22:34:46+02:00
log	b488f97e92115581e12ac1a5aee6362fc4f12563
tree	4db0ba400b3415efb2123846022f4ceb73dbdca2
parent	f2aa7c86980df7bcbf0405be63cf62c88ed22005

autodoc: Analyze and expose backing integer types for packed structs

2 files changed, 24 insertions(+), 4 deletions(-)

lib
- docs
  - main.js
src
- Autodoc.zig

lib/docs/main.js+13-3

 @@ -1849,6 +1849,15 @@ const NAV_MODES = {
             } else {
               name = "struct { ";
             }
+            if (structObj.backing_int !== null) {
+              if (opts.wantHtml) {
+                name = "<span class='tok-kw'>packed</span> " + name;
+              } else {
+                name = "packed " + name;
+              }
+              name += " (" + exprName(structObj.backing_int, opts) + ")";
+            }
+            name += " { ";
             if (structObj.field_types.length > 1 && opts.wantHtml) { name += "</br>"; }
             let indent = "";
             if (structObj.field_types.length > 1 && opts.wantHtml) {
 @@ -4486,9 +4495,10 @@ function addDeclToSearchResults(decl, declIndex, modNames, item, list, stack) {
           pubDecls: ty[4],
           field_types: ty[5],
           field_defaults: ty[6],
-          is_tuple: ty[7],
+          backing_int: ty[7],
-          line_number: ty[8],
+          is_tuple: ty[8],
-          parent_container: ty[9],
+          line_number: ty[9],
+          parent_container: ty[10],
         };
       case 10: // ComptimeExpr
       case 11: // ComptimeFloat

src/Autodoc.zig+11-1

 @@ -604,6 +604,7 @@ const DocData = struct {
             pubDecls: []usize = &.{}, // index into decls
             field_types: []Expr = &.{}, // (use src->fields to find names)
             field_defaults: []?Expr = &.{}, // default values is specified
+            backing_int: ?Expr = null, // backing integer if specified
             is_tuple: bool,
             line_number: usize,
             parent_container: ?usize, // index into `types`
 @@ -2854,13 +2855,21 @@ fn walkInstruction(
                         break :blk fields_len;
                     } else 0;
-                    // TODO: Expose explicit backing integer types in some way.
+                    var backing_int: ?DocData.Expr = null;
                     if (small.has_backing_int) {
                         const backing_int_body_len = file.zir.extra[extra_index];
                         extra_index += 1; // backing_int_body_len
                         if (backing_int_body_len == 0) {
+                            const backing_int_ref = @intToEnum(Ref, file.zir.extra[extra_index]);
+                            const backing_int_res = try self.walkRef(file, &scope, src_info, backing_int_ref, true);
+                            backing_int = backing_int_res.expr;
                             extra_index += 1; // backing_int_ref
                         } else {
+                            const backing_int_body = file.zir.extra[extra_index..][0..backing_int_body_len];
+                            const break_inst = backing_int_body[backing_int_body.len - 1];
+                            const operand = data[break_inst].@"break".operand;
+                            const backing_int_res = try self.walkRef(file, &scope, src_info, operand, true);
+                            backing_int = backing_int_res.expr;
                             extra_index += backing_int_body_len; // backing_int_body_inst
                         }
                     }
 @@ -2903,6 +2912,7 @@ fn walkInstruction(
                             .field_types = field_type_refs.items,
                             .field_defaults = field_default_refs.items,
                             .is_tuple = small.is_tuple,
+                            .backing_int = backing_int,
                             .line_number = self.ast_nodes.items[self_ast_node_index].line,
                             .parent_container = parent_scope.enclosing_type,
                         },