starts to refactor into tree of dynamic content

Author: Felix "xq" Queißner

README.md

@@ -32,14 +32,14 @@ The *Fill* type will fill the remaining size in its space with the given `<byte>
 fill <byte>
 ```
 
-### Raw Binary Content (`raw`)
+### Paste File Contents (`paste-file`)
 
 The *Raw* type will include the file at `<path>` verbatim and will error, if not enough space is available.
 
 `<path>` is relative to the current file.
 
 ```plain
-raw <path>
+paste-file <path>
 ```
 
 ### MBR Partition Table (`mbr-part`)

build.zig.zon

@@ -5,7 +5,7 @@
     .dependencies = .{
         .zfat = .{
             .url = "https://github.com/ZigEmbeddedGroup/zfat/archive/3ce06d43a4e04d387034dcae2f486b050701f321.tar.gz",
-            .hash = "12205d874e8c9fd08d93c09ccbfddb045809afcc28e232b36b5abe3d288278ce458f",
+            .hash = "zfat-0.0.0-AAAAAMYlcABdh06Mn9CNk8Ccy_3bBFgJr8wo4jKza1q-",
         },
         .args = .{
             .url = "git+https://github.com/ikskuh/zig-args.git#9425b94c103a031777fdd272c555ce93a7dea581",

concept/script.dis

@@ -1,5 +1,5 @@
 mbr-part
-  bootloader $PATH1
+  bootloader paste-file $PATH1
   part # partition 1
     type fat32-lba
     size 500M

justfile

@@ -19,11 +19,9 @@ behaviour-tests: \
     (behaviour-test "tests/basic/raw.dis") \
     (behaviour-test "tests/part/mbr/minimal.dis")
 
-behaviour-test script:
-    {{zig}} build install
-    
+behaviour-test script: install
     ./zig-out/bin/dim --output .zig-cache/disk.img --script "{{script}}" 
-    ./zig-out/bin/dim --output .zig-cache/disk.img --size 30M --script "{{script}}" 
+    ./zig-out/bin/dim --output .zig-cache/disk.img --script "{{script}}" --size 30M
 
 
 fuzz:

src/build.old.zig

@@ -712,210 +712,6 @@ pub const Content = union(enum) {
     }
 };
 
-pub const mbr = struct {
-    pub const Table = struct {
-        bootloader: [440]u8 = .{0} ** 440,
-        disk_id: ?u32 = null,
-        partitions: [4]?*const Partition,
-    };
-
-    pub const Partition = struct {
-        offset: ?u64 = null,
-        size: u64,
-
-        bootable: bool,
-        type: PartitionType,
-
-        data: Content,
-    };
-
-    /// https://en.wikipedia.org/wiki/Partition_type
-    pub const PartitionType = enum(u8) {
-        empty = 0x00,
-
-        fat12 = 0x01,
-        ntfs = 0x07,
-
-        fat32_chs = 0x0B,
-        fat32_lba = 0x0C,
-
-        fat16_lba = 0x0E,
-
-        linux_swap = 0x82,
-        linux_fs = 0x83,
-        linux_lvm = 0x8E,
-
-        // Output from fdisk (util-linux 2.38.1)
-        // 00 Leer             27 Verst. NTFS Win  82 Linux Swap / So  c1 DRDOS/sec (FAT-
-        // 01 FAT12            39 Plan 9           83 Linux            c4 DRDOS/sec (FAT-
-        // 02 XENIX root       3c PartitionMagic   84 versteckte OS/2  c6 DRDOS/sec (FAT-
-        // 03 XENIX usr        40 Venix 80286      85 Linux erweitert  c7 Syrinx
-        // 04 FAT16 <32M       41 PPC PReP Boot    86 NTFS Datenträge  da Keine Dateisyst
-        // 05 Erweiterte       42 SFS              87 NTFS Datenträge  db CP/M / CTOS / .
-        // 06 FAT16            4d QNX4.x           88 Linux Klartext   de Dell Dienstprog
-        // 07 HPFS/NTFS/exFAT  4e QNX4.x 2. Teil   8e Linux LVM        df BootIt
-        // 08 AIX              4f QNX4.x 3. Teil   93 Amoeba           e1 DOS-Zugriff
-        // 09 AIX bootfähig    50 OnTrack DM       94 Amoeba BBT       e3 DOS R/O
-        // 0a OS/2-Bootmanage  51 OnTrack DM6 Aux  9f BSD/OS           e4 SpeedStor
-        // 0b W95 FAT32        52 CP/M             a0 IBM Thinkpad Ru  ea Linux erweitert
-        // 0c W95 FAT32 (LBA)  53 OnTrack DM6 Aux  a5 FreeBSD          eb BeOS Dateisyste
-        // 0e W95 FAT16 (LBA)  54 OnTrackDM6       a6 OpenBSD          ee GPT
-        // 0f W95 Erw. (LBA)   55 EZ-Drive         a7 NeXTSTEP         ef EFI (FAT-12/16/
-        // 10 OPUS             56 Golden Bow       a8 Darwin UFS       f0 Linux/PA-RISC B
-        // 11 Verst. FAT12     5c Priam Edisk      a9 NetBSD           f1 SpeedStor
-        // 12 Compaq Diagnost  61 SpeedStor        ab Darwin Boot      f4 SpeedStor
-        // 14 Verst. FAT16 <3  63 GNU HURD oder S  af HFS / HFS+       f2 DOS sekundär
-        // 16 Verst. FAT16     64 Novell Netware   b7 BSDi Dateisyste  f8 EBBR geschützt
-        // 17 Verst. HPFS/NTF  65 Novell Netware   b8 BSDI Swap        fb VMware VMFS
-        // 18 AST SmartSleep   70 DiskSecure Mult  bb Boot-Assistent   fc VMware VMKCORE
-        // 1b Verst. W95 FAT3  75 PC/IX            bc Acronis FAT32 L  fd Linux RAID-Auto
-        // 1c Verst. W95 FAT3  80 Altes Minix      be Solaris Boot     fe LANstep
-        // 1e Verst. W95 FAT1  81 Minix / altes L  bf Solaris          ff BBT
-        // 24 NEC DOS
-
-        _,
-    };
-
-    pub fn encodeMbrChsEntry(lba: u32) [3]u8 {
-        var chs = lbaToChs(lba);
-
-        if (chs.cylinder >= 1024) {
-            chs = .{
-                .cylinder = 1023,
-                .head = 255,
-                .sector = 63,
-            };
-        }
-
-        const cyl: u10 = @intCast(chs.cylinder);
-        const head: u8 = @intCast(chs.head);
-        const sect: u6 = @intCast(chs.sector);
-
-        const sect_cyl: u8 = @as(u8, 0xC0) & @as(u8, @truncate(cyl >> 2)) + sect;
-        const sect_8: u8 = @truncate(cyl);
-
-        return .{ head, sect_cyl, sect_8 };
-    }
-
-    const CHS = struct {
-        cylinder: u32,
-        head: u8, // limit: 256
-        sector: u6, // limit: 64
-
-        pub fn init(c: u32, h: u8, s: u6) CHS {
-            return .{ .cylinder = c, .head = h, .sector = s };
-        }
-    };
-
-    pub fn lbaToChs(lba: u32) CHS {
-        const hpc = 255;
-        const spt = 63;
-
-        // C, H and S are the cylinder number, the head number, and the sector number
-        // LBA is the logical block address
-        // HPC is the maximum number of heads per cylinder (reported by disk drive, typically 16 for 28-bit LBA)
-        // SPT is the maximum number of sectors per track (reported by disk drive, typically 63 for 28-bit LBA)
-        // LBA = (C * HPC + H) * SPT + (S - 1)
-
-        const sector = (lba % spt);
-        const cyl_head = (lba / spt);
-
-        const head = (cyl_head % hpc);
-        const cyl = (cyl_head / hpc);
-
-        return CHS{
-            .sector = @intCast(sector + 1),
-            .head = @intCast(head),
-            .cylinder = cyl,
-        };
-    }
-};
-
-// test "lba to chs" {
-//     // table from https://en.wikipedia.org/wiki/Logical_block_addressing#CHS_conversion
-//     try std.testing.expectEqual(mbr.CHS.init(0, 0, 1), mbr.lbaToChs(0));
-//     try std.testing.expectEqual(mbr.CHS.init(0, 0, 2), mbr.lbaToChs(1));
-//     try std.testing.expectEqual(mbr.CHS.init(0, 0, 3), mbr.lbaToChs(2));
-//     try std.testing.expectEqual(mbr.CHS.init(0, 0, 63), mbr.lbaToChs(62));
-//     try std.testing.expectEqual(mbr.CHS.init(0, 1, 1), mbr.lbaToChs(63));
-//     try std.testing.expectEqual(mbr.CHS.init(0, 15, 1), mbr.lbaToChs(945));
-//     try std.testing.expectEqual(mbr.CHS.init(0, 15, 63), mbr.lbaToChs(1007));
-//     try std.testing.expectEqual(mbr.CHS.init(1, 0, 1), mbr.lbaToChs(1008));
-//     try std.testing.expectEqual(mbr.CHS.init(1, 0, 63), mbr.lbaToChs(1070));
-//     try std.testing.expectEqual(mbr.CHS.init(1, 1, 1), mbr.lbaToChs(1071));
-//     try std.testing.expectEqual(mbr.CHS.init(1, 1, 63), mbr.lbaToChs(1133));
-//     try std.testing.expectEqual(mbr.CHS.init(1, 2, 1), mbr.lbaToChs(1134));
-//     try std.testing.expectEqual(mbr.CHS.init(1, 15, 63), mbr.lbaToChs(2015));
-//     try std.testing.expectEqual(mbr.CHS.init(2, 0, 1), mbr.lbaToChs(2016));
-//     try std.testing.expectEqual(mbr.CHS.init(15, 15, 63), mbr.lbaToChs(16127));
-//     try std.testing.expectEqual(mbr.CHS.init(16, 0, 1), mbr.lbaToChs(16128));
-//     try std.testing.expectEqual(mbr.CHS.init(31, 15, 63), mbr.lbaToChs(32255));
-//     try std.testing.expectEqual(mbr.CHS.init(32, 0, 1), mbr.lbaToChs(32256));
-//     try std.testing.expectEqual(mbr.CHS.init(16319, 15, 63), mbr.lbaToChs(16450559));
-//     try std.testing.expectEqual(mbr.CHS.init(16382, 15, 63), mbr.lbaToChs(16514063));
-// }
-
-pub const gpt = struct {
-    pub const Guid = [16]u8;
-
-    pub const Table = struct {
-        disk_id: Guid,
-
-        partitions: []const Partition,
-    };
-
-    pub const Partition = struct {
-        type: Guid,
-        part_id: Guid,
-
-        offset: ?u64 = null,
-        size: u64,
-
-        name: [36]u16,
-
-        attributes: Attributes,
-
-        data: Content,
-
-        pub const Attributes = packed struct(u32) {
-            system: bool,
-            efi_hidden: bool,
-            legacy: bool,
-            read_only: bool,
-            hidden: bool,
-            no_automount: bool,
-
-            padding: u26 = 0,
-        };
-    };
-
-    /// https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs
-    pub const PartitionType = struct {
-        pub const unused: Guid = .{};
-
-        pub const microsoft_basic_data: Guid = .{};
-        pub const microsoft_reserved: Guid = .{};
-
-        pub const windows_recovery: Guid = .{};
-
-        pub const plan9: Guid = .{};
-
-        pub const linux_swap: Guid = .{};
-        pub const linux_fs: Guid = .{};
-        pub const linux_reserved: Guid = .{};
-        pub const linux_lvm: Guid = .{};
-    };
-
-    pub fn nameLiteral(comptime name: []const u8) [36]u16 {
-        return comptime blk: {
-            var buf: [36]u16 = undefined;
-            const len = std.unicode.utf8ToUtf16Le(&buf, name) catch |err| @compileError(@tagName(err));
-            @memset(buf[len..], 0);
-            break :blk &buf;
-        };
-    }
-};
-
 pub const FileSystem = struct {
     pub const Format = union(enum) {
         pub const Tag = std.meta.Tag(@This());

src/components/EmptyData.zig

@@ -6,6 +6,22 @@
 const std = @import("std");
 const dim = @import("../dim.zig");
 
-pub fn execute(ctx: dim.Context) !void {
-    _ = ctx;
+const EmptyData = @This();
+
+pub fn parse(ctx: dim.Context) !dim.Content {
+    const pf = try ctx.alloc_object(EmptyData);
+    pf.* = .{};
+    return .create_handle(pf, .create(@This(), .{
+        .guess_size_fn = guess_size,
+        .render_fn = render,
+    }));
+}
+
+fn guess_size(_: *EmptyData) dim.Content.GuessError!dim.SizeGuess {
+    return .{ .at_least = 0 };
+}
+
+fn render(self: *EmptyData, stream: *dim.BinaryStream) dim.Content.RenderError!void {
+    _ = self;
+    _ = stream;
 }

src/components/FillData.zig

@@ -5,10 +5,28 @@
 const std = @import("std");
 const dim = @import("../dim.zig");
 
-pub fn execute(ctx: dim.Context) !void {
-    const fill_value: u8 = try ctx.get_integer(u8, 0);
+const FillData = @This();
 
-    if (ctx.get_remaining_size()) |size| {
-        try ctx.writer().writeByteNTimes(fill_value, size);
-    }
+fill_value: u8,
+
+pub fn parse(ctx: dim.Context) !dim.Content {
+    const pf = try ctx.alloc_object(FillData);
+    pf.* = .{
+        .fill_value = try ctx.parse_integer(u8, 0),
+    };
+    return .create_handle(pf, .create(@This(), .{
+        .guess_size_fn = guess_size,
+        .render_fn = render,
+    }));
+}
+
+fn guess_size(_: *FillData) dim.Content.GuessError!dim.SizeGuess {
+    return .{ .at_least = 0 };
+}
+
+fn render(self: *FillData, stream: *dim.BinaryStream) dim.Content.RenderError!void {
+    try stream.writer().writeByteNTimes(
+        self.fill_value,
+        stream.capacity,
+    );
 }

src/components/PasteFile.zig

@@ -0,0 +1,27 @@
+const std = @import("std");
+const dim = @import("../dim.zig");
+
+const PasteFile = @This();
+
+file_handle: dim.FileName,
+
+pub fn parse(ctx: dim.Context) !dim.Content {
+    const pf = try ctx.alloc_object(PasteFile);
+    pf.* = .{
+        .file_handle = try ctx.parse_file_name(),
+    };
+    return .create_handle(pf, .create(@This(), .{
+        .guess_size_fn = guess_size,
+        .render_fn = render,
+    }));
+}
+
+fn guess_size(self: *PasteFile) dim.Content.GuessError!dim.SizeGuess {
+    const size = try self.file_handle.get_size();
+
+    return .{ .exact = size };
+}
+
+fn render(self: *PasteFile, stream: *dim.BinaryStream) dim.Content.RenderError!void {
+    try self.file_handle.copy_to(stream);
+}