Merge pull request #20 from utox39/fix/invalid-module-memory-leak

Fix a memory leak when the InvalidModule error occurs

.github/workflows/build.yml

@@ -0,0 +1,95 @@
+name: Build
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        include:
+          # Linux x86_64
+          - os: ubuntu-latest
+            target: x86_64-linux
+            runner_arch: x64
+            setup_deps: |
+              sudo apt-get update
+              sudo apt-get install -y libpci-dev
+
+          # macOS x86_64
+          - os: macos-13
+            target: x86_64-darwin
+            runner_arch: x64
+            setup_deps: ""
+
+          # macOS aarch64 (Apple Silicon)
+          - os: macos-latest
+            target: aarch64-darwin
+            runner_arch: arm64
+            setup_deps: ""
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Zig
+      uses: mlugg/setup-zig@v2
+      with:
+        version: 0.15.1
+
+    - name: Setup platform dependencies
+      if: matrix.setup_deps != ''
+      run: ${{ matrix.setup_deps }}
+
+    - name: Cache Zig
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cache/zig
+          zig-cache
+        key: ${{ runner.os }}-${{ matrix.target }}-zig-${{ hashFiles('build.zig', 'build.zig.zon') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.target }}-zig-
+
+    - name: Build for target
+      run: |
+        zig build -Doptimize=ReleaseSafe
+
+        mv zig-out/bin/zigfetch zig-out/bin/zigfetch-${{ matrix.target }}
+
+    - name: Verify binary
+      run: |
+        ls -la zig-out/bin/
+        file zig-out/bin/zigfetch-${{ matrix.target }}
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: zigfetch-${{ matrix.target }}
+        path: zig-out/bin/zigfetch-${{ matrix.target }}
+        retention-days: 3
+
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Zig
+      uses: mlugg/setup-zig@v2
+      with:
+        version: 0.15.1
+
+    - name: Setup dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libpci-dev
+
+    - name: Run tests
+      run: |
+        zig test src/ascii.zig
+        zig test src/utils.zig

README.md

@@ -1,5 +1,18 @@
 # Zigfetch
 
+![Zig](https://img.shields.io/badge/Zig-%23F7A41D.svg?style=flat&logo=zig&logoColor=white)
+![GitHub Release](https://img.shields.io/github/v/release/utox39/zigfetch)
+![GitHub License](https://img.shields.io/github/license/utox39/zigfetch)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/utox39/zigfetch/build.yml)
+![macOS](https://img.shields.io/badge/mac%20os-000000?style=flat&logo=macos&logoColor=F0F0F0)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=flat&logo=linux&logoColor=black)
+
+|                     Default config                      |                     Custom config                     |
+| :-----------------------------------------------------: | :---------------------------------------------------: |
+| ![dafault-config](assets/screenshot-default-config.png) | ![custom-config](assets/screenshot-custom-config.png) |
+
+---
+
 -   [Description](#description)
 -   [Requirements](#requirements)
 -   [Installation](#installation)
@@ -66,6 +79,83 @@ $ touch config.json
 $ cp /path/to/zigfetch/config.json ~/.config/zigfetch/config.json
 ```
 
+#### Modules
+
+Available modules:
+
+-   Os
+-   Kernel
+-   Uptime
+-   Packages
+-   Shell
+-   Cpu
+-   Gpu
+-   Ram
+-   Swap
+-   Disk
+-   Net
+-   Terminal
+-   Locale
+-   Custom
+
+| Module type |      Linux      |          macOS           | Windows |
+| :---------: | :-------------: | :----------------------: | :-----: |
+|     os      |       Yes       |           Yes            |   WIP   |
+|   kernel    |       Yes       |           Yes            |   WIP   |
+|   uptime    |       Yes       |           Yes            |   WIP   |
+|  packages   |       WIP       | Yes (Homebrew, Macports) |   WIP   |
+|    shell    | Yes (bash, zsh) |     Yes (bash, zsh)      |   WIP   |
+|     cpu     |       Yes       |           Yes            |   WIP   |
+|     gpu     |       Yes       | Yes (Apple Silicon only) |   WIP   |
+|     ram     |       Yes       |           Yes            |   WIP   |
+|    swap     |       Yes       |           Yes            |   WIP   |
+|    disk     |       Yes       |           Yes            |   WIP   |
+|     net     |       Yes       |           Yes            |   WIP   |
+|  terminal   |       Yes       |           Yes            |   WIP   |
+|   locale    |       Yes       |           Yes            |   WIP   |
+
+```json
+  "modules": [
+    {
+      "type": "os",
+      "key": "OS",
+      "key_color": "#5E81AC"
+    },
+    ...
+  ]
+```
+
+#### Custom module
+
+```json
+  "modules": [
+    {
+      "type": "custom",
+      "key": "-----------",
+      "key_color": "#5E81AC"
+    },
+    ...
+  ]
+```
+
+#### Custom ASCII art
+
+To use an ASCII art of your choice:
+
+```json
+"ascii_abs_path": "absolute_path/to/your/ascii_art.txt"
+```
+
+Don't use the `~` character.
+
+#### Username and Hostname color
+
+To change the Username and Hostname color (HEX colors only):
+
+```json
+"username_hostname_color": "#5E81AC"
+```
+
 ## Roadtrip
 
 -   [ ] Add ASCII art for each operating system and Linux distro

build.zig.zon

@@ -10,7 +10,7 @@
 
     // This is a [Semantic Version](https://semver.org/).
     // In a future version of Zig it will be used for package deduplication.
-    .version = "0.20.0",
+    .version = "0.22.1",
 
     // Together with name, this represents a globally unique package
     // identifier. This field is generated by the Zig toolchain when the

src/ascii.zig

@@ -65,18 +65,23 @@ test "parse ffffff" {
     try std.testing.expect((result.r == 255) and (result.g == 255) and (result.b == 255));
 }
 
-pub fn printAscii(allocator: std.mem.Allocator, sys_info_list: std.array_list.Managed([]u8)) !void {
+pub fn printAsciiAndModules(allocator: std.mem.Allocator, ascii_art_path: ?[]u8, sys_info_list: std.array_list.Managed([]u8)) !void {
     var stdout_buffer: [2048]u8 = undefined;
     var stdout_writer = std.fs.File.stdout().writer(&stdout_buffer);
     const stdout = &stdout_writer.interface;
 
-    // const ascii_art_path = "./assets/ascii/guy_fawks.txt";
+    var ascii_art_data: []const u8 = undefined;
-    // var file = try std.fs.cwd().openFile(ascii_art_path, .{});
+    if (ascii_art_path) |ascii| {
-    // defer file.close();
+        var ascii_file = try std.fs.cwd().openFile(ascii, .{});
-    // const ascii_art_data = try file.readToEndAlloc(allocator, std.math.maxInt(usize));
+        defer ascii_file.close();
-    // defer allocator.free(ascii_art_data);
+        ascii_art_data = try ascii_file.readToEndAlloc(allocator, std.math.maxInt(usize));
+    } else {
+        ascii_art_data = @embedFile("./assets/ascii/guy_fawks.txt");
+    }
 
-    const ascii_art_data = @embedFile("./assets/ascii/guy_fawks.txt");
+    defer if (ascii_art_path != null) {
+        allocator.free(ascii_art_data);
+    };
 
     var lines = std.mem.splitScalar(u8, ascii_art_data, '\n');
 
@@ -90,7 +95,7 @@ pub fn printAscii(allocator: std.mem.Allocator, sys_info_list: std.array_list.Ma
     const ascii_art_items = ascii_art_content_list.items;
     const sys_info_items = sys_info_list.items;
 
-    const terminal_size = try utils.getTerminalSize();
+    const terminal_size = utils.getTerminalSize() catch utils.TermSize{ .height = 50, .width = 50 };
     const terminal_width: usize = @intCast(terminal_size.width);
 
     const spacing: usize = 5;
@@ -110,7 +115,7 @@ pub fn printAscii(allocator: std.mem.Allocator, sys_info_list: std.array_list.Ma
     while (i < max_len) : (i += 1) {
         // Print the ascii art if the width of the terminal is greater than the spacing (5) + the longest ascii art row length + the longest sys info string length
         if (can_print_ascii_art) {
-            const alignment_buffer = try allocator.alloc(u8, longest_ascii_art_row_len - (try utils.countCodepoints(ascii_art_items[i])) + spacing);
+            const alignment_buffer = try allocator.alloc(u8, if (i < ascii_art_len) longest_ascii_art_row_len - (try utils.countCodepoints(ascii_art_items[i])) + spacing else longest_ascii_art_row_len + spacing);
             @memset(alignment_buffer, ' ');
 
             if (i < ascii_art_len) {

src/config.zig

@@ -1,5 +1,4 @@
 const std = @import("std");
-const builtin = @import("builtin");
 const ascii = @import("ascii.zig");
 
 pub const Module = struct {
@@ -9,6 +8,8 @@ pub const Module = struct {
 };
 
 pub const Config = struct {
+    ascii_abs_path: ?[]u8 = null,
+    username_hostname_color: ?[]u8 = null,
     modules: []Module,
 };
 
@@ -29,6 +30,18 @@ pub const ModuleType = enum {
     custom,
 };
 
+pub fn getAsciiPath(config: ?std.json.Parsed(Config)) ?[]u8 {
+    if (config) |c| {
+        return c.value.ascii_abs_path;
+    } else return null;
+}
+
+pub fn getUsernameHostnameColor(config: ?std.json.Parsed(Config)) ?[]u8 {
+    if (config) |c| {
+        return c.value.username_hostname_color;
+    } else return null;
+}
+
 pub fn getModulesTypes(allocator: std.mem.Allocator, config: ?std.json.Parsed(Config)) !std.array_list.Managed(ModuleType) {
     var modules_list = std.array_list.Managed(ModuleType).init(allocator);
 
@@ -38,6 +51,7 @@ pub fn getModulesTypes(allocator: std.mem.Allocator, config: ?std.json.Parsed(Co
             if (module_enum) |m| {
                 try modules_list.append(m);
             } else {
+                modules_list.deinit();
                 return error.InvalidModule;
             }
         }

src/formatters.zig

@@ -41,6 +41,17 @@ pub const default_formatters = [_]*const fn (allocator: std.mem.Allocator) anyer
     &getDefaultFormattedLocaleInfo,
 };
 
+pub fn getFormattedUsernameHostname(allocator: std.mem.Allocator, color: []const u8, username: []const u8, hostname: []const u8) ![]u8 {
+    return try std.fmt.allocPrint(allocator, "{s}{s}{s}@{s}{s}{s}", .{
+        color,
+        username,
+        ascii.Reset,
+        color,
+        hostname,
+        ascii.Reset,
+    });
+}
+
 pub fn getDefaultFormattedKernelInfo(allocator: std.mem.Allocator) !Result {
     return try getFormattedKernelInfo(allocator, "Kernel", ascii.Yellow);
 }

src/main.zig

@@ -10,11 +10,11 @@ pub fn main() !void {
     const allocator = gpa.allocator();
     defer _ = gpa.deinit();
 
-    var sys_info_list = std.array_list.Managed([]u8).init(allocator);
+    var modules_list = std.array_list.Managed([]u8).init(allocator);
-    defer sys_info_list.deinit();
+    defer modules_list.deinit();
 
     errdefer {
-        for (sys_info_list.items) |info| {
+        for (modules_list.items) |info| {
             allocator.free(info);
         }
     }
@@ -27,29 +27,30 @@ pub fn main() !void {
 
     const username = try detection.user.getUsername(allocator);
     const hostname = try detection.system.getHostname(allocator);
-    try sys_info_list.append(try std.fmt.allocPrint(allocator, "{s}{s}{s}@{s}{s}{s}", .{
+
-        ascii.Yellow,
+    const username_hostname_color = if (config.getUsernameHostnameColor(conf)) |color| blk: {
-        username,
+        var buf: [32]u8 = undefined;
-        ascii.Reset,
+        const rgb = try ascii.hexColorToRgb(color);
-        ascii.Yellow,
+        const formatted_color = try std.fmt.bufPrint(&buf, "\x1b[38;2;{d};{d};{d}m", .{ rgb.r, rgb.g, rgb.b });
-        hostname,
+        break :blk formatted_color;
-        ascii.Reset,
+    } else ascii.Yellow;
-    }));
+
+    try modules_list.append(try formatters.getFormattedUsernameHostname(allocator, username_hostname_color, username, hostname));
     allocator.free(hostname);
     allocator.free(username);
 
     const separtor_buffer = try allocator.alloc(u8, username.len + hostname.len + 1);
     @memset(separtor_buffer, '-');
-    try sys_info_list.append(separtor_buffer);
+    try modules_list.append(separtor_buffer);
 
     if (modules_types.items.len == 0) {
         inline for (0..formatters.default_formatters.len) |i| {
             const result = try formatters.default_formatters[i](allocator);
             switch (result) {
-                .string => |r| try sys_info_list.append(r),
+                .string => |r| try modules_list.append(r),
                 .string_arraylist => |r| {
                     defer r.deinit();
-                    try sys_info_list.appendSlice(r.items);
+                    try modules_list.appendSlice(r.items);
                 },
             }
         }
@@ -61,14 +62,14 @@ pub fn main() !void {
 
             const result = try formatters.formatters[@intFromEnum(module_type)](allocator, module.key, key_color);
             switch (result) {
-                .string => |r| try sys_info_list.append(r),
+                .string => |r| try modules_list.append(r),
                 .string_arraylist => |r| {
                     defer r.deinit();
-                    try sys_info_list.appendSlice(r.items);
+                    try modules_list.appendSlice(r.items);
                 },
             }
         }
     }
 
-    try ascii.printAscii(allocator, sys_info_list);
+    try ascii.printAsciiAndModules(allocator, config.getAsciiPath(conf), modules_list);
 }

src/utils.zig

@@ -43,7 +43,7 @@ pub fn getTerminalSize() !TermSize {
 }
 
 test "getTerminalSize" {
-    const terminal_size = try getTerminalSize();
+    const terminal_size = getTerminalSize() catch TermSize{ .height = 50, .width = 50 };
 
     std.debug.print("Height: {}, Width {}\n", .{ terminal_size.height, terminal_size.width });