11 |
12 | 
13 |
14 | 
15 |
16 | ## What is hevi?
17 | Hevi (pronounced like "heavy") is a hex viewer, just like `xxd` or `hexdump`.
18 |
19 | ## Features
20 | ### Parsers
21 | Hevi can parse things like ELF or PE files and give you syntax-highlighting.
22 | 
23 |
24 | ### Custom color palettes
25 | You can specify custom color palettes. Color palettes can use standard ANSI colors or truecolor.
26 |
27 | ## Usage
28 | The command should be used as `hevi [flags]`. The flags are described [below](#flags).
29 |
30 | ### Flags
31 | | Flag(s) | Description |
32 | | -------------------------------- | ------------------------------------------------------- |
33 | | `-h`/`--help` | Show a help message |
34 | | `-v`/`--version` | Show version information |
35 | | `--color`/`--no-color` | Enable or disable colored output |
36 | | `--lowercase`/`--uppercase` | Toggle between lowercase and uppercase hex |
37 | | `--size`/`--no-size` | Enable or disable the line showing the size at the end |
38 | | `--offset`/`--no-offset` | Enable or disable showing the offset |
39 | | `--ascii`/`--no-ascii` | Enable or disable ASCII interpretation |
40 | | `--skip-lines`/`--no-skip-lines` | Enable or disable skipping of identical lines |
41 | | `--raw` | Raw format (disables most features) |
42 | | `--show-palette` | Show the current color palette in a table |
43 | | `--parser` | Specify the parser to use. For a list use `hevi --help` |
44 |
45 | ### Environment variables
46 | The `NO_COLOR` variable is supported, and disables color (see ) printing. Note that it can be overwritten by an explicit `--color`.
47 |
48 | ### Config file
49 | The config file is a [ziggy](https://ziggy-lang.io) file. The following fields are available:
50 | ```zig
51 | color: bool,
52 | uppercase: bool,
53 | show_size: bool,
54 | show_offset: bool,
55 | show_ascii: bool,
56 | skip_lines: bool,
57 | raw: bool,
58 | palette: Palette,
59 | ```
60 |
61 | All fields are optional.
62 |
63 | **Note**: for the `palette` field you must specify all styles!
64 |
65 | #### Example config
66 | ```zig
67 | .color = true,
68 | .skip_lines = false,
69 | .palette = Palette{
70 | .normal = @color("yellow"),
71 | .normal_alt = @color("yellow::dim"),
72 | .normal_accent = @color("yellow:bright_black:bold"),
73 | .c1 = @color("red"),
74 | .c1_alt = @color("red::dim"),
75 | .c1_accent = @color("red:bright_black:bold"),
76 | .c2 = @color("green"),
77 | .c2_alt = @color("green::dim"),
78 | .c2_accent = @color("green:bright_black:bold"),
79 | .c3 = @color("blue"),
80 | .c3_alt = @color("blue::dim"),
81 | .c3_accent = @color("blue:bright_black:bold"),
82 | .c4 = @color("cyan"),
83 | .c4_alt = @color("cyan::dim"),
84 | .c4_accent = @color("cyan:bright_black:bold"),
85 | .c5 = @color("magenta"),
86 | .c5_alt = @color("magenta::dim"),
87 | .c5_accent = @color("magenta:bright_black:bold"),
88 | },
89 | ```
90 |
91 | #### Location
92 |
93 | The config file is located at:
94 | | OS | Path |
95 | | -------------------------------------- | ------------------------------------------------------------------------------------------------ |
96 | | Linux, MacOS, FreeBSD, OpenBSD, NetBSD | `$XDG_CONFIG_HOME/hevi/config.ziggy` or if the env doesn't exist `$HOME/.config/hevi/config.ziggy` |
97 | | Windows | `%APPDATA%/hevi/config.ziggy` |
98 | | Other | Not supported. No config file will be read |
99 |
100 | #### Precedence
101 | Hevi has a precedence for configuration and it is:
102 | 1. Flags
103 | 2. Environment variables
104 | 3. Config file
105 | 4. Defaults
106 |
107 | ## About
108 | It is written in [zig](https://github.com/ziglang/zig), in an attempt to simplify hex viewers.
109 |
110 | ## Installation
111 |
112 | ### Some Linux package managers
113 | If your package manager is in the following list (and preferably in green), you can simply install it from there:
114 |
115 | [](https://repology.org/project/hevi/versions)
116 |
117 | ### Homebrew
118 |
119 | You can install [hevi](https://formulae.brew.sh/formula/hevi) with [brew](https://brew.sh/):
120 |
121 | ```sh
122 | $ brew install hevi
123 | ```
124 |
125 | ### Nix
126 | There is a nix flake you can use. You can also try hevi without installing it:
127 |
128 | ```sh
129 | $ nix shell github:Arnau478/hevi
130 | ```
131 |
132 | ### X-CMD
133 |
134 | If you are a user of [x-cmd](https://x-cmd.com), you can run:
135 |
136 | ```sh
137 | $ x install hevi
138 | ```
139 |
140 | ### Other platforms
141 | You can download a binary from the [releases](https://github.com/Arnau478/hevi/releases/) page. You can also clone the repository and compile it with `zig build`.
142 |
143 | ## Contribute
144 | Contributions are welcome! Even if you don't want to write code, you can help a lot creating new issues or testing this software.
145 |
146 | ## License
147 | See [LICENSE](LICENSE)
148 |
149 | SPDX-License-Identifier: GPL-3.0-or-later
150 |
151 | [](https://spdx.org/licenses/GPL-3.0-or-later.html)
152 |
--------------------------------------------------------------------------------
/src/main.zig:
--------------------------------------------------------------------------------
1 | const std = @import("std");
2 | const hevi = @import("hevi");
3 | const build_options = @import("build_options");
4 | const pennant = @import("pennant");
5 | const options = @import("options.zig");
6 |
7 | pub const std_options = std.Options{
8 | .logFn = logFn,
9 | };
10 |
11 | fn logFn(comptime message_level: std.log.Level, comptime scope: @Type(.enum_literal), comptime format: []const u8, args: anytype) void {
12 | const level_txt = comptime message_level.asText();
13 | const prefix2 = if (scope == .default) ": " else "(" ++ @tagName(scope) ++ "): ";
14 |
15 | var stderr_buffer: [4096]u8 = undefined;
16 | var stderr_file = std.fs.File.stderr();
17 | var stderr_writer = stderr_file.writer(&stderr_buffer);
18 | const stderr = &stderr_writer.interface;
19 |
20 | std.debug.lockStdErr();
21 | defer std.debug.unlockStdErr();
22 |
23 | const log_color = stderr_file.supportsAnsiEscapeCodes();
24 |
25 | const col = switch (message_level) {
26 | .err => "31",
27 | .warn => "33",
28 | .info => "34",
29 | .debug => "37",
30 | };
31 |
32 | nosuspend {
33 | stderr.print(
34 | "{s}{s}{s}" ++ level_txt ++ "{s}",
35 | if (log_color) .{ "\x1b[", col, "m\x1b[1m", "\x1b[0m" } else .{ "", "", "", "" },
36 | ) catch return;
37 | stderr.print(prefix2 ++ format ++ "\n", args) catch return;
38 | stderr.flush() catch return;
39 | }
40 | }
41 |
42 | pub fn fail(comptime fmt: []const u8, args: anytype) noreturn {
43 | std.log.err(fmt, args);
44 | std.process.exit(1);
45 | }
46 |
47 | fn printPalette(opts: hevi.DisplayOptions, writer: *std.Io.Writer) std.Io.Writer.Error!void {
48 | try writer.print(" (alt) (accent)\n", .{});
49 | try writer.print("(main) ", .{});
50 | try opts.palette.normal.ansiCode(writer);
51 | try writer.print("0x112233\x1b[0m ", .{});
52 | try opts.palette.normal_alt.ansiCode(writer);
53 | try writer.print("0x112233\x1b[0m ", .{});
54 | try opts.palette.normal_accent.ansiCode(writer);
55 | try writer.print("0x112233\x1b[0m\n", .{});
56 |
57 | inline for (0..5) |i| {
58 | const name = std.fmt.comptimePrint("c{d}", .{i + 1});
59 | try writer.print(" ", .{});
60 | try @field(opts.palette, name).ansiCode(writer);
61 | try writer.print("0x112233\x1b[0m ", .{});
62 | try @field(opts.palette, name ++ "_alt").ansiCode(writer);
63 | try writer.print("0x112233\x1b[0m ", .{});
64 | try @field(opts.palette, name ++ "_accent").ansiCode(writer);
65 | try writer.print("0x112233\x1b[0m\n", .{});
66 | }
67 | }
68 |
69 | fn printVersion() void {
70 | const version = build_options.version;
71 |
72 | if (version.build != null) {
73 | // Development version
74 | std.debug.print(
75 | \\hevi {d}.{d}.{d}-{s}+{s}
76 | \\
77 | , .{
78 | version.major,
79 | version.minor,
80 | version.patch,
81 | version.pre.?,
82 | version.build.?,
83 | });
84 | } else if (version.pre != null) {
85 | // Development version because git information is not available
86 | std.debug.print(
87 | \\hevi {d}.{d}.{d}-{s}
88 | \\
89 | , .{
90 | version.major,
91 | version.minor,
92 | version.patch,
93 | version.pre.?,
94 | });
95 | } else {
96 | // Tagged version
97 | std.debug.print(
98 | \\hevi {d}.{d}.{d}
99 | \\
100 | , .{ version.major, version.minor, version.patch });
101 | }
102 | }
103 |
104 | pub const CliOptions = struct {
105 | help: bool = false,
106 | version: bool = false,
107 | @"show-palette": bool = false,
108 | color: ?bool = null,
109 | uppercase: ?bool = null,
110 | size: ?bool = null,
111 | offset: ?bool = null,
112 | ascii: ?bool = null,
113 | @"skip-lines": ?bool = null,
114 | raw: ?bool = null,
115 | parser: ?hevi.Parser = null,
116 |
117 | pub const shorthands = .{
118 | .h = "help",
119 | .v = "version",
120 | };
121 |
122 | pub const opposites = .{
123 | .color = "no-color",
124 | .uppercase = "lowercase",
125 | .size = "no-size",
126 | .offset = "no-offset",
127 | .ascii = "no-ascii",
128 | .@"skip-lines" = "no-skip-lines",
129 | };
130 |
131 | pub const descriptions = .{
132 | .help = "Print this help message",
133 | .version = "Print version information",
134 | .@"show-palette" = "Print the color palette being used",
135 | .color = "Colored output",
136 | .uppercase = "Lowercase or uppercase hexadecimal",
137 | .size = "Show the file size at the end",
138 | .offset = "Show the offset into the file at each line",
139 | .ascii = "Show the ASCII interpretation",
140 | .@"skip-lines" = "Skip identical lines",
141 | .raw = "Raw format (disables most features)",
142 | .parser = "The parser to use",
143 | };
144 | };
145 |
146 | pub fn main() void {
147 | var gpa = std.heap.GeneralPurposeAllocator(.{}){};
148 | defer if (gpa.deinit() == .leak) fail("Memory leak detected", .{});
149 |
150 | const allocator = gpa.allocator();
151 |
152 | const args_res = pennant.parseForProcess(CliOptions, allocator) catch |err| switch (err) {
153 | error.OutOfMemory => fail("Out of memory", .{}),
154 | };
155 | defer args_res.deinit(allocator);
156 |
157 | switch (args_res) {
158 | .valid => |args| {
159 | var stdout_buffer: [4096]u8 = undefined;
160 | var stdout_file = std.fs.File.stdout();
161 | var stdout_writer = stdout_file.writer(&stdout_buffer);
162 | const stdout = &stdout_writer.interface;
163 |
164 | const opts = options.getOptions(allocator, args.options, stdout_file) catch |err| switch (err) {
165 | error.InvalidConfig => fail("Invalid config found", .{}),
166 | else => fail("Error getting options and config file", .{}),
167 | };
168 |
169 | if (args.options.help) {
170 | pennant.printHelp(CliOptions, .{ .text =
171 | \\hevi - hex viewer
172 | \\
173 | \\Usage:
174 | \\ hevi
175 | });
176 | } else if (args.options.version) {
177 | printVersion();
178 | } else if (args.options.@"show-palette") {
179 | printPalette(opts, stdout) catch |err| switch (err) {
180 | else => fail("{s}", .{@errorName(err)}),
181 | };
182 | } else {
183 | if (args.positionals.len == 1) {
184 | const true_filename = args.positionals[0];
185 | const is_stdin = std.mem.eql(u8, true_filename, "-");
186 | const filename = if (is_stdin) "" else true_filename;
187 |
188 | const file = if (is_stdin)
189 | std.fs.File.stdin()
190 | else
191 | std.fs.cwd().openFile(filename, .{}) catch |err| switch (err) {
192 | error.FileNotFound => fail("{s} not found", .{filename}),
193 | error.IsDir => fail("{s} is a directory", .{filename}),
194 | else => fail("{s} could not be opened", .{filename}),
195 | };
196 | defer if (!is_stdin) file.close();
197 |
198 | const data = file.readToEndAlloc(allocator, std.math.maxInt(usize)) catch |err| switch (err) {
199 | error.OutOfMemory => fail("Out of memory", .{}),
200 | error.IsDir => fail("{s} is a directory", .{filename}),
201 | else => fail("Cannot read {s}", .{filename}),
202 | };
203 |
204 | defer allocator.free(data);
205 |
206 | hevi.dump(allocator, data, stdout, opts) catch |err| switch (err) {
207 | error.NonMatchingParser => fail("{s} does not match parser {s}", .{ filename, @tagName(opts.parser.?) }),
208 | error.OutOfMemory => fail("Out of memory", .{}),
209 | else => fail("Error writing to stdout: {s}", .{@errorName(err)}),
210 | };
211 | } else {
212 | if (args.positionals.len == 0) {
213 | std.log.err("No file specified", .{});
214 | } else {
215 | std.log.err("Invalid command usage", .{});
216 | }
217 | std.log.info("Use `--help` for help", .{});
218 | std.process.exit(1);
219 | }
220 | }
221 |
222 | stdout.flush() catch fail("Cannot flush", .{});
223 | },
224 | .err => |err| {
225 | fail("{f}", .{err});
226 | },
227 | }
228 | }
229 |
230 | test {
231 | _ = options;
232 | }
233 |
--------------------------------------------------------------------------------
/src/options.zig:
--------------------------------------------------------------------------------
1 | const builtin = @import("builtin");
2 | const std = @import("std");
3 | const root = @import("root");
4 | const hevi = @import("hevi");
5 | const ziggy = @import("ziggy");
6 | const pennant = @import("pennant");
7 |
8 | fn openConfigFile(allocator: std.mem.Allocator, env_map: std.process.EnvMap) ?std.meta.Tuple(&.{ std.fs.File, []const u8 }) {
9 | const path: ?[]const u8 = switch (builtin.os.tag) {
10 | .linux, .macos, .freebsd, .openbsd, .netbsd => if (env_map.get("XDG_CONFIG_HOME")) |xdg_config_home|
11 | std.fs.path.join(allocator, &.{ xdg_config_home, "hevi/config.ziggy" }) catch null
12 | else if (env_map.get("HOME")) |home|
13 | std.fs.path.join(allocator, &.{ home, ".config/hevi/config.ziggy" }) catch null
14 | else
15 | null,
16 | .windows => if (env_map.get("APPDATA")) |appdata|
17 | std.fs.path.join(allocator, &.{ appdata, "hevi/config.ziggy" }) catch null
18 | else
19 | null,
20 | else => null,
21 | };
22 |
23 | return .{ std.fs.openFileAbsolute(path orelse return null, .{}) catch {
24 | allocator.free(path.?);
25 | return null;
26 | }, path orelse return null };
27 | }
28 |
29 | const Config = struct {
30 | color: ?bool = null,
31 | uppercase: ?bool = null,
32 | show_size: ?bool = null,
33 | show_offset: ?bool = null,
34 | show_ascii: ?bool = null,
35 | skip_lines: ?bool = null,
36 | raw: ?bool = null,
37 | palette: ?Palette = null,
38 |
39 | const Palette = struct {
40 | normal: Color,
41 | normal_alt: Color,
42 | normal_accent: Color,
43 | c1: Color,
44 | c1_alt: Color,
45 | c1_accent: Color,
46 | c2: Color,
47 | c2_alt: Color,
48 | c2_accent: Color,
49 | c3: Color,
50 | c3_alt: Color,
51 | c3_accent: Color,
52 | c4: Color,
53 | c4_alt: Color,
54 | c4_accent: Color,
55 | c5: Color,
56 | c5_alt: Color,
57 | c5_accent: Color,
58 |
59 | const Color = struct {
60 | col: hevi.TextColor,
61 |
62 | fn parseBase(str: []const u8) ?hevi.TextColor.BaseColor {
63 | inline for (std.meta.fields(hevi.TextColor.BaseColor.Standard)) |field| {
64 | if (std.mem.eql(u8, field.name, str)) {
65 | return .{
66 | .standard = @field(hevi.TextColor.BaseColor.Standard, field.name),
67 | };
68 | }
69 | }
70 |
71 | if (str.len == 7 and str[0] == '#') {
72 | return .{
73 | .true_color = .{
74 | .r = std.fmt.parseUnsigned(u8, str[1..3], 16) catch return null,
75 | .g = std.fmt.parseUnsigned(u8, str[3..5], 16) catch return null,
76 | .b = std.fmt.parseUnsigned(u8, str[5..7], 16) catch return null,
77 | },
78 | };
79 | }
80 |
81 | return null;
82 | }
83 |
84 | pub fn fromString(str: []const u8) ?Color {
85 | var iter = std.mem.splitScalar(u8, str, ':');
86 |
87 | const fg = iter.next() orelse return null;
88 |
89 | var maybe_bg = iter.next();
90 | if (maybe_bg) |bg| {
91 | if (bg.len == 0) maybe_bg = null;
92 | }
93 |
94 | const maybe_mod = iter.next();
95 |
96 | if (iter.next() != null) return null;
97 |
98 | var dim = false;
99 | var bold = false;
100 |
101 | if (maybe_mod) |mod| {
102 | if (std.mem.eql(u8, mod, "dim")) {
103 | dim = true;
104 | } else if (std.mem.eql(u8, mod, "bold")) {
105 | bold = true;
106 | } else {
107 | return null;
108 | }
109 | }
110 |
111 | return .{
112 | .col = .{
113 | .foreground = parseBase(fg) orelse return null,
114 | .background = if (maybe_bg) |bg| parseBase(bg) orelse return null else null,
115 | .dim = dim,
116 | .bold = bold,
117 | },
118 | };
119 | }
120 |
121 | pub const ziggy_options = struct {
122 | pub fn parse(parser: *ziggy.Parser, first_tok: ziggy.Tokenizer.Token) !Color {
123 | try parser.must(first_tok, .at);
124 | const ident = try parser.nextMust(.identifier);
125 | if (!std.mem.eql(u8, ident.loc.src(parser.code), "color")) {
126 | return parser.addError(.{
127 | .syntax = .{
128 | .name = "@color",
129 | .sel = ident.loc.getSelection(parser.code),
130 | },
131 | });
132 | }
133 | _ = try parser.nextMust(.lp);
134 | const str = try parser.nextMust(.string);
135 | _ = try parser.nextMust(.rp);
136 |
137 | return Color.fromString(str.loc.unquote(parser.code) orelse {
138 | return parser.addError(.{
139 | .syntax = .{
140 | .name = first_tok.tag.lexeme(),
141 | .sel = first_tok.loc.getSelection(parser.code),
142 | },
143 | });
144 | }) orelse {
145 | return parser.addError(.{
146 | .syntax = .{
147 | .name = first_tok.tag.lexeme(),
148 | .sel = first_tok.loc.getSelection(parser.code),
149 | },
150 | });
151 | };
152 | }
153 | };
154 |
155 | pub fn toHevi(self: Color) hevi.TextColor {
156 | return self.col;
157 | }
158 | };
159 |
160 | pub fn toHevi(self: Palette) hevi.ColorPalette {
161 | return .{
162 | .normal = self.normal.toHevi(),
163 | .normal_alt = self.normal_alt.toHevi(),
164 | .normal_accent = self.normal_accent.toHevi(),
165 | .c1 = self.c1.toHevi(),
166 | .c1_alt = self.c1_alt.toHevi(),
167 | .c1_accent = self.c1_accent.toHevi(),
168 | .c2 = self.c2.toHevi(),
169 | .c2_alt = self.c2_alt.toHevi(),
170 | .c2_accent = self.c2_accent.toHevi(),
171 | .c3 = self.c3.toHevi(),
172 | .c3_alt = self.c3_alt.toHevi(),
173 | .c3_accent = self.c3_accent.toHevi(),
174 | .c4 = self.c4.toHevi(),
175 | .c4_alt = self.c4_alt.toHevi(),
176 | .c4_accent = self.c4_accent.toHevi(),
177 | .c5 = self.c5.toHevi(),
178 | .c5_alt = self.c5_alt.toHevi(),
179 | .c5_accent = self.c5_accent.toHevi(),
180 | };
181 | }
182 | };
183 | };
184 |
185 | pub fn getOptions(allocator: std.mem.Allocator, args: root.CliOptions, stdout: std.fs.File) !hevi.DisplayOptions {
186 | var envs = try std.process.getEnvMap(allocator);
187 | defer envs.deinit();
188 |
189 | // Default values
190 | var options = hevi.DisplayOptions{
191 | .color = stdout.getOrEnableAnsiEscapeSupport(),
192 | .uppercase = false,
193 | .show_size = true,
194 | .show_offset = true,
195 | .show_ascii = true,
196 | .skip_lines = true,
197 | .raw = false,
198 | };
199 |
200 | // Config file
201 | if (openConfigFile(allocator, envs)) |tuple| {
202 | defer {
203 | tuple[0].close();
204 | allocator.free(tuple[1]);
205 | }
206 |
207 | const source = try tuple[0].readToEndAllocOptions(allocator, std.math.maxInt(usize), null, .of(u8), 0);
208 | defer allocator.free(source);
209 |
210 | if (source.len != 0) {
211 | var arena = std.heap.ArenaAllocator.init(allocator);
212 | defer arena.deinit();
213 |
214 | var diag = ziggy.Diagnostic{ .path = tuple[1] };
215 | defer diag.deinit(arena.allocator());
216 |
217 | const config = ziggy.parseLeaky(Config, arena.allocator(), source, .{
218 | .diagnostic = &diag,
219 | }) catch |err| switch (err) {
220 | error.OutOfMemory, error.Overflow => return error.OutOfMemory,
221 | error.Syntax, error.MissingFrontmatter, error.OpenFrontmatter => {
222 | std.log.err("{}", .{diag});
223 | return error.InvalidConfig;
224 | },
225 | };
226 |
227 | if (config.color) |color| options.color = color;
228 | if (config.uppercase) |uppercase| options.uppercase = uppercase;
229 | if (config.show_size) |show_size| options.show_size = show_size;
230 | if (config.show_offset) |show_offset| options.show_offset = show_offset;
231 | if (config.show_ascii) |show_ascii| options.show_ascii = show_ascii;
232 | if (config.skip_lines) |skip_lines| options.skip_lines = skip_lines;
233 | if (config.raw) |raw| options.raw = raw;
234 | if (config.palette) |palette| options.palette = palette.toHevi();
235 | }
236 | }
237 |
238 | // Environment variables
239 | if (envs.get("NO_COLOR")) |s| {
240 | if (!std.mem.eql(u8, s, "")) options.color = false;
241 | }
242 |
243 | // Flags
244 | if (args.color) |color| options.color = color;
245 | if (args.uppercase) |uppercase| options.uppercase = uppercase;
246 | if (args.size) |show_size| options.show_size = show_size;
247 | if (args.offset) |show_offset| options.show_offset = show_offset;
248 | if (args.ascii) |show_ascii| options.show_ascii = show_ascii;
249 | if (args.@"skip-lines") |skip_lines| options.skip_lines = skip_lines;
250 | if (args.raw) |raw| options.raw = raw;
251 | if (args.parser) |parser| options.parser = parser;
252 |
253 | return options;
254 | }
255 |
--------------------------------------------------------------------------------
/src/hevi.zig:
--------------------------------------------------------------------------------
1 | const std = @import("std");
2 | const NormalizedSize = @import("NormalizedSize.zig");
3 |
4 | pub const DisplayOptions = @import("DisplayOptions.zig");
5 |
6 | /// ANSI color
7 | pub const TextColor = struct {
8 | foreground: ?BaseColor = null,
9 | background: ?BaseColor = null,
10 | dim: bool = false,
11 | bold: bool = false,
12 |
13 | pub const BaseColor = union(enum) {
14 | standard: Standard,
15 | true_color: TrueColor,
16 |
17 | pub const Standard = enum(u4) {
18 | black,
19 | red,
20 | green,
21 | yellow,
22 | blue,
23 | magenta,
24 | cyan,
25 | white,
26 | bright_black,
27 | bright_red,
28 | bright_green,
29 | bright_yellow,
30 | bright_blue,
31 | bright_magenta,
32 | bright_cyan,
33 | bright_white,
34 | };
35 |
36 | pub const TrueColor = struct {
37 | r: u8,
38 | g: u8,
39 | b: u8,
40 | };
41 | };
42 |
43 | pub fn ansiCode(self: TextColor, writer: *std.Io.Writer) !void {
44 | if (self.foreground) |foreground| {
45 | switch (foreground) {
46 | .standard => |standard| _ = try writer.write(switch (standard) {
47 | .black => "\x1b[30m",
48 | .red => "\x1b[31m",
49 | .green => "\x1b[32m",
50 | .yellow => "\x1b[33m",
51 | .blue => "\x1b[34m",
52 | .magenta => "\x1b[35m",
53 | .cyan => "\x1b[36m",
54 | .white => "\x1b[37m",
55 | .bright_black => "\x1b[90m",
56 | .bright_red => "\x1b[91m",
57 | .bright_green => "\x1b[92m",
58 | .bright_yellow => "\x1b[93m",
59 | .bright_blue => "\x1b[94m",
60 | .bright_magenta => "\x1b[95m",
61 | .bright_cyan => "\x1b[96m",
62 | .bright_white => "\x1b[97m",
63 | }),
64 | .true_color => |true_color| try writer.print("\x1b[38;2;{d};{d};{d}m", .{
65 | true_color.r,
66 | true_color.g,
67 | true_color.b,
68 | }),
69 | }
70 | }
71 |
72 | if (self.background) |background| {
73 | switch (background) {
74 | .standard => |standard| _ = try writer.write(switch (standard) {
75 | .black => "\x1b[40m",
76 | .red => "\x1b[41m",
77 | .green => "\x1b[42m",
78 | .yellow => "\x1b[43m",
79 | .blue => "\x1b[44m",
80 | .magenta => "\x1b[45m",
81 | .cyan => "\x1b[46m",
82 | .white => "\x1b[47m",
83 | .bright_black => "\x1b[100m",
84 | .bright_red => "\x1b[101m",
85 | .bright_green => "\x1b[102m",
86 | .bright_yellow => "\x1b[103m",
87 | .bright_blue => "\x1b[104m",
88 | .bright_magenta => "\x1b[105m",
89 | .bright_cyan => "\x1b[106m",
90 | .bright_white => "\x1b[107m",
91 | }),
92 | .true_color => |true_color| try writer.print("\x1b[48;2;{d};{d};{d}m", .{
93 | true_color.r,
94 | true_color.g,
95 | true_color.b,
96 | }),
97 | }
98 | }
99 |
100 | if (self.dim) _ = try writer.write("\x1b[2m");
101 | if (self.bold) _ = try writer.write("\x1b[1m");
102 | }
103 | };
104 |
105 | /// Generalized color, agnostic to the current color palette
106 | pub const PaletteColor = enum {
107 | normal,
108 | normal_alt,
109 | normal_accent,
110 | c1,
111 | c1_alt,
112 | c1_accent,
113 | c2,
114 | c2_alt,
115 | c2_accent,
116 | c3,
117 | c3_alt,
118 | c3_accent,
119 | c4,
120 | c4_alt,
121 | c4_accent,
122 | c5,
123 | c5_alt,
124 | c5_accent,
125 | };
126 |
127 | /// A color palette, that associates `PaletteColor`s to `TextColor`s
128 | pub const ColorPalette = std.enums.EnumFieldStruct(PaletteColor, TextColor, null);
129 |
130 | /// The default color palette
131 | pub const default_palette: ColorPalette = .{
132 | .normal = .{ .foreground = .{ .standard = .yellow } },
133 | .normal_alt = .{ .foreground = .{ .standard = .yellow }, .dim = true },
134 | .normal_accent = .{ .foreground = .{ .standard = .bright_yellow }, .bold = true },
135 | .c1 = .{ .foreground = .{ .standard = .red } },
136 | .c1_alt = .{ .foreground = .{ .standard = .red }, .dim = true },
137 | .c1_accent = .{ .foreground = .{ .standard = .bright_red }, .bold = true },
138 | .c2 = .{ .foreground = .{ .standard = .green } },
139 | .c2_alt = .{ .foreground = .{ .standard = .green }, .dim = true },
140 | .c2_accent = .{ .foreground = .{ .standard = .bright_green }, .bold = true },
141 | .c3 = .{ .foreground = .{ .standard = .blue } },
142 | .c3_alt = .{ .foreground = .{ .standard = .blue }, .dim = true },
143 | .c3_accent = .{ .foreground = .{ .standard = .bright_blue }, .bold = true },
144 | .c4 = .{ .foreground = .{ .standard = .magenta } },
145 | .c4_alt = .{ .foreground = .{ .standard = .magenta }, .dim = true },
146 | .c4_accent = .{ .foreground = .{ .standard = .bright_magenta }, .bold = true },
147 | .c5 = .{ .foreground = .{ .standard = .cyan } },
148 | .c5_alt = .{ .foreground = .{ .standard = .cyan }, .dim = true },
149 | .c5_accent = .{ .foreground = .{ .standard = .bright_cyan }, .bold = true },
150 | };
151 |
152 | pub const Parser = enum {
153 | elf,
154 | pe,
155 | qoi,
156 | data,
157 |
158 | pub const Meta = struct {
159 | description: []const u8,
160 | };
161 |
162 | fn Namespace(self: Parser) type {
163 | return switch (self) {
164 | .elf => @import("parsers/elf.zig"),
165 | .pe => @import("parsers/pe.zig"),
166 | .qoi => @import("parsers/qoi.zig"),
167 | .data => @import("parsers/data.zig"),
168 | };
169 | }
170 |
171 | pub fn meta(self: Parser) Meta {
172 | return switch (self) {
173 | inline else => |p| p.Namespace().meta,
174 | };
175 | }
176 |
177 | pub fn matches(self: Parser, data: []const u8) bool {
178 | return switch (self) {
179 | inline else => |p| p.Namespace().matches(data),
180 | };
181 | }
182 |
183 | pub fn getColors(self: Parser, colors: []PaletteColor, data: []const u8) void {
184 | switch (self) {
185 | inline else => |p| p.Namespace().getColors(colors, data),
186 | }
187 | }
188 | };
189 |
190 | fn getColors(allocator: std.mem.Allocator, data: []const u8, options: DisplayOptions) ![]const PaletteColor {
191 | const colors = try allocator.alloc(PaletteColor, data.len);
192 |
193 | inline for (comptime std.enums.values(Parser)) |parser| {
194 | if (options.parser) |p| {
195 | if (parser == p) {
196 | if (parser.matches(data)) {
197 | parser.getColors(colors, data);
198 | return colors;
199 | } else {
200 | return error.NonMatchingParser;
201 | }
202 | }
203 | } else if (parser.matches(data)) {
204 | parser.getColors(colors, data);
205 | return colors;
206 | }
207 | }
208 |
209 | @panic("No parser matched");
210 | }
211 |
212 | inline fn isPrintable(c: u8) bool {
213 | return switch (c) {
214 | 0x20...0x7E => true,
215 | else => false,
216 | };
217 | }
218 |
219 | const DisplayLineOptions = struct {
220 | color: bool,
221 | uppercase: bool,
222 | show_ascii: bool,
223 | raw: bool,
224 | };
225 |
226 | fn displayLine(line: []const u8, colors: []const TextColor, writer: *std.Io.Writer, options: DisplayLineOptions) !void {
227 | if (!options.raw) {
228 | if (options.color) {
229 | try writer.print("\x1b[2m|\x1b[0m ", .{});
230 | } else try writer.print("| ", .{});
231 | }
232 |
233 | for (line, colors, 0..) |byte, color, i| {
234 | if (options.color) {
235 | try color.ansiCode(writer);
236 | }
237 |
238 | if (options.uppercase) {
239 | try writer.print("{X:0>2}", .{byte});
240 | } else try writer.print("{x:0>2}", .{byte});
241 |
242 | if (options.color) try writer.print("\x1b[0m", .{});
243 |
244 | if (i % 2 == 1) try writer.print(" ", .{});
245 | }
246 |
247 | if (line.len != 16) {
248 | for (0..(16 - line.len)) |_| try writer.print(" ", .{});
249 | for (0..std.math.divCeil(usize, 16 - line.len, 2) catch unreachable) |_| try writer.print(" ", .{});
250 | }
251 |
252 | if (!options.raw) {
253 | if (options.color) {
254 | try writer.print("\x1b[2m|\x1b[0m", .{});
255 | } else try writer.print("|", .{});
256 | }
257 |
258 | if (options.show_ascii) {
259 | try writer.print(" ", .{});
260 | for (line, colors) |byte, color| {
261 | const printable = isPrintable(byte);
262 |
263 | if (options.color) {
264 | if (printable) {
265 | try color.ansiCode(writer);
266 | } else {
267 | _ = try writer.write("\x1b[2m");
268 | }
269 | }
270 |
271 | try writer.print("{c}", .{if (printable) byte else '.'});
272 |
273 | if (options.color) try writer.print("\x1b[0m", .{});
274 | }
275 |
276 | if (line.len != 16) {
277 | for (0..(16 - line.len)) |_| try writer.print(" ", .{});
278 | }
279 |
280 | if (options.color) {
281 | try writer.print(" \x1b[2m|\x1b[0m", .{});
282 | } else try writer.print(" |", .{});
283 | }
284 |
285 | try writer.print("\n", .{});
286 | }
287 |
288 | fn printBuffer(line: []const u8, colors: []const TextColor, count: usize, writer: *std.Io.Writer, options: DisplayOptions) !void {
289 | if (options.show_offset) {
290 | if (options.uppercase) {
291 | try writer.print("{X:0>8} ", .{count});
292 | } else try writer.print("{x:0>8} ", .{count});
293 | }
294 |
295 | try displayLine(line, colors[count .. count + line.len], writer, .{
296 | .color = options.color,
297 | .uppercase = options.uppercase,
298 | .show_ascii = options.show_ascii,
299 | .raw = options.raw,
300 | });
301 | }
302 |
303 | fn display(fixed_reader: *std.Io.Reader, colors: []const TextColor, writer: *std.Io.Writer, options: DisplayOptions) !void {
304 | var count: usize = 0;
305 |
306 | var buf: [16]u8 = undefined;
307 |
308 | // Variables for `--skip-lines`
309 | var previous_buf: [16]u8 = undefined;
310 | var previous_line_len: ?usize = null;
311 | var lines_skipped: usize = 0;
312 |
313 | while (true) {
314 | const line_len = try fixed_reader.readSliceShort(&buf);
315 |
316 | if (line_len == 0) {
317 | switch (lines_skipped) {
318 | 0 => {},
319 | 1 => try printBuffer(previous_buf[0..previous_line_len.?], colors, count - previous_line_len.?, writer, options),
320 | else => {
321 | try writer.print("... {d} lines skipped ...\n", .{lines_skipped - 1});
322 | try printBuffer(previous_buf[0..previous_line_len.?], colors, count - previous_line_len.?, writer, options);
323 | },
324 | }
325 | break;
326 | }
327 |
328 | const line = buf[0..line_len];
329 |
330 | if (options.skip_lines) {
331 | if (previous_line_len) |p_line_len| {
332 | if (std.mem.eql(u8, line, previous_buf[0..p_line_len])) {
333 | lines_skipped += 1;
334 | count += line_len;
335 | continue;
336 | }
337 |
338 | switch (lines_skipped) {
339 | 0 => {},
340 | 1 => {
341 | try printBuffer(previous_buf[0..previous_line_len.?], colors, count - previous_line_len.?, writer, options);
342 | lines_skipped = 0;
343 | },
344 | else => {
345 | try writer.print("... {d} lines skipped ...\n", .{lines_skipped - 1});
346 | try printBuffer(previous_buf[0..previous_line_len.?], colors, count - previous_line_len.?, writer, options);
347 | lines_skipped = 0;
348 | },
349 | }
350 | }
351 |
352 | previous_buf = buf;
353 | previous_line_len = line_len;
354 | }
355 |
356 | try printBuffer(line, colors, count, writer, options);
357 |
358 | count += line_len;
359 |
360 | try writer.flush();
361 | }
362 |
363 | if (options.show_size) {
364 | if (count < 1024) {
365 | try writer.print("File size: {} bytes\n", .{count});
366 | } else try writer.print("File size: {} bytes ({f})\n", .{ count, NormalizedSize.fromBytes(count) });
367 | }
368 |
369 | try writer.flush();
370 | }
371 |
372 | /// Dump `data` to `writer`
373 | pub fn dump(allocator: std.mem.Allocator, data: []const u8, writer: *std.Io.Writer, options: DisplayOptions) !void {
374 | const colors = try getColors(allocator, data, options);
375 | defer allocator.free(colors);
376 |
377 | const text_colors = try allocator.alloc(TextColor, colors.len);
378 | defer allocator.free(text_colors);
379 |
380 | for (colors, text_colors) |color, *text_color| {
381 | text_color.* = switch (color) {
382 | inline else => |c| @field(options.palette, @tagName(c)),
383 | };
384 | }
385 |
386 | var new_options = options;
387 | if (options.raw) {
388 | new_options.color = false;
389 | new_options.show_size = false;
390 | new_options.show_ascii = false;
391 | new_options.show_offset = false;
392 | new_options.skip_lines = false;
393 | }
394 |
395 | var fixed_reader = std.Io.Reader.fixed(data);
396 | try display(
397 | &fixed_reader,
398 | text_colors,
399 | writer,
400 | new_options,
401 | );
402 | }
403 |
404 | test {
405 | _ = std.testing.refAllDeclsRecursive(@This());
406 | }
407 |
408 | fn testDump(expected: []const u8, input: []const u8, options: DisplayOptions) !void {
409 | var out: std.Io.Writer.Allocating = try .initCapacity(std.testing.allocator, expected.len);
410 | defer out.deinit();
411 |
412 | try dump(std.testing.allocator, input, &out.writer, options);
413 |
414 | try std.testing.expectEqualSlices(u8, expected, out.written());
415 | }
416 |
417 | test "basic dump" {
418 | try testDump(
419 | "| 6865 6c6c 6faa |\n",
420 | "hello\xaa",
421 | .{
422 | .color = false,
423 | .uppercase = false,
424 | .show_size = false,
425 | .show_ascii = false,
426 | .skip_lines = false,
427 | .show_offset = false,
428 | },
429 | );
430 | }
431 |
432 | test "raw dump" {
433 | try testDump(
434 | "6865 6c6c 6faa \n",
435 | "hello\xaa",
436 | .{
437 | .color = false,
438 | .uppercase = false,
439 | .show_size = false,
440 | .show_ascii = false,
441 | .skip_lines = false,
442 | .show_offset = false,
443 | .raw = true,
444 | },
445 | );
446 | }
447 |
448 | test "empty dump" {
449 | try testDump(
450 | "",
451 | "",
452 | .{
453 | .color = false,
454 | .uppercase = false,
455 | .show_size = false,
456 | .show_ascii = false,
457 | .skip_lines = false,
458 | .show_offset = false,
459 | },
460 | );
461 | }
462 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
17 |
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/NormalizedSize.zig:
--------------------------------------------------------------------------------
1 | const std = @import("std");
2 |
3 | const NormalizedSize = @This();
4 |
5 | /// The actual size in the appropiate unit
6 | magnitude: f64,
7 | /// The unit the size is in
8 | unit: Unit,
9 |
10 | /// A byte multiple unit
11 | const Unit = struct {
12 | order: usize,
13 |
14 | inline fn getName(self: Unit) []const u8 {
15 | return switch (self.order) {
16 | 0 => "B",
17 | 1 => "KiB",
18 | 2 => "MiB",
19 | 3 => "GiB",
20 | 4 => "TiB",
21 | 5 => "PiB",
22 | 6 => "EiB",
23 | 7 => "ZiB",
24 | 8 => "YiB",
25 | else => ">>B",
26 | };
27 | }
28 | };
29 |
30 | /// Create a normalized size from a raw size (in bytes)
31 | pub fn fromBytes(bytes: usize) NormalizedSize {
32 | var size = NormalizedSize{ .magnitude = @floatFromInt(bytes), .unit = .{ .order = 0 } };
33 |
34 | while (size.magnitude >= 1024) {
35 | size.magnitude /= 1024;
36 | size.unit.order += 1;
37 | }
38 |
39 | return size;
40 | }
41 |
42 | pub fn format(self: NormalizedSize, writer: *std.Io.Writer) !void {
43 | try writer.print("{d:.2} {s}", .{ self.magnitude, self.unit.getName() });
44 | }
45 |
--------------------------------------------------------------------------------
/doc/hevi.1.man:
--------------------------------------------------------------------------------
1 | .TH HEVI 1 2024-08-21 "hevi 2.0.0"
2 | .SH NAME
3 | hevi \- a hex viewer
4 |
5 | .SH SYNOPSIS
6 | hevi [\fIOPTION\fR]... \fBFILE\fR
7 |
8 | .SH DESCRIPTION
9 | hevi is a hex viewer that focuses on modularity, simplicity and appearance.
10 |
11 | .SH OPTIONS
12 | .TP
13 | \fB\-\-ascii\fR, \fB\-\-no\-ascii\fR
14 | enable or disable ASCII interpretation
15 |
16 | .TP
17 | \fB\-\-color\fR, \fB\-\-no\-color\fR
18 | enable or disable color support
19 |
20 | .TP
21 | \fB\-\-lowercase\fR, \fB\-\-uppercase\fR
22 | toggle between lowercase and uppercase hex
23 |
24 | .TP
25 | \fB\-\-offset\fR, \fB\-\-no\-offset\fR
26 | enable or disable showing the offset
27 |
28 | .TP
29 | \fB\-\-size\fR, \fB\-\-no\-size\fR
30 | enable or disable the line showing at the end the size of the file
31 |
32 | .TP
33 | \fB\-\-skip\-lines\fR, \fB\-\-no\-skip\-lines\fR
34 | enable or disable skipping of identical lines
35 |
36 | .TP
37 | \fB\-\-raw\fR
38 | raw format (disables most features)
39 |
40 | .TP
41 | \fB\-\-show\-palette\fR
42 | Show the current color palette in a table
43 |
44 | .TP
45 | \fB\-\-parser\fR=\fIPARSER\fR
46 | specify the parser to use. For a list of available parsers type
47 | .in +4
48 | `hevi \-\-help`
49 | .in
50 |
51 | .TP
52 | \fB\-h\fR, \fB\-\-help\fR
53 | display a help message and exit
54 |
55 | .TP
56 | \fB\-v\fR, \fB\-\-version\fR
57 | output version information and exit
58 |
59 | .SH FILES
60 | .TP
61 | .I \[ti]/.config/hevi/config.json
62 | The main configuration file. See also
63 | .BR hevi (5)
64 |
65 | .SH ENVIRONMENT VARIABLES
66 | .TP
67 | .I NO_COLOR
68 | If set with anything disables color. For more information go to https://no-color.org/
69 |
70 | .SH REPORTING BUGS
71 | Report bugs to https://github.com/Arnau478/hevi/issues
72 |
73 | .SH SEE ALSO
74 | .BR hevi (5)
75 |
--------------------------------------------------------------------------------
/doc/hevi.5.man:
--------------------------------------------------------------------------------
1 | .TH HEVI 5 2024-08-21 "hevi 2.0.0"
2 | .SH NAME
3 | hevi configuration file
4 |
5 | .SH SYNOPSIS
6 | .I \[ti]/.config/hevi/config.ziggy
7 |
8 | .SH DESCRIPTION
9 | This page explains how the configuration file is structured and what its fields are.
10 |
11 | The configuration file is a ziggy file.
12 |
13 | These are the fields of the configuration file:
14 | .in +4
15 | .nf
16 | color: \fItrue\fR|\fIfalse\fR
17 | uppercase: \fItrue\fR|\fIfalse\fR
18 | show_size: \fItrue\fR|\fIfalse\fR
19 | show_offset: \fItrue\fR|\fIfalse\fR
20 | show_ascii: \fItrue\fR|\fIfalse\fR
21 | skip_lines: \fItrue\fR|\fIfalse\fR
22 | raw: \fItrue\fR|\fIfalse\fR
23 | palette: Palette{\fIpalettes\fR}
24 | .fi
25 | .in
26 |
27 | The palette is a series of mappings from style names to colors. The styles are:
28 | .in +4
29 | .nf
30 | normal
31 | normal_alt
32 | normal_accent
33 | c1
34 | c1_alt
35 | c1_accent
36 | c2
37 | c2_alt
38 | c2_accent
39 | c3
40 | c3_alt
41 | c3_accent
42 | c4
43 | c4_alt
44 | c4_accent
45 | c5
46 | c5_alt
47 | c5_accent
48 | .fi
49 | .in
50 |
51 | A color is specified either as \fB@color("foreground")\fR or \fB@color("foreground:background")\fR. Attributes (either \fBdim\fR or \fBbold\fR) can be added like \fB@color("foreground::attr")\fR or \fB@color("foreground:background:attr")\fR.
52 |
53 | \fBNote\fR: for the \fIpalette\fR field you must specify all styles!
54 |
55 | The config file is located at:
56 | .in +4
57 | .nf
58 | \fBLinux\fR, \fBMacOS\fR, \fBFreeBSD\fR, \fBOpenBSD\fR, \fBNetBSD\fR --> \fI$XDG_CONFIG_HOME/hevi/config.ziggy\fR or if the env doesn't exist \fI$HOME/.config/hevi/config.ziggy\fR
59 | \fBWindows\fR --> \fI%APPDATA%/hevi/config.ziggy\fR
60 | \fBOther\fR --> Not supported. No config file will be read.
61 | .in
62 |
63 | .SH EXAMPLES
64 | .in +4
65 | .EX
66 | \[char46]color = true,
67 | \[char46]skip_lines = false,
68 | \[char46]palette = Palette{
69 | .normal = @color("yellow"),
70 | .normal_alt = @color("yellow::dim"),
71 | .normal_accent = @color("yellow:bright_black:bold"),
72 | .c1 = @color("red"),
73 | .c1_alt = @color("red::dim"),
74 | .c1_accent = @color("red:bright_black:bold"),
75 | .c2 = @color("green"),
76 | .c2_alt = @color("green::dim"),
77 | .c2_accent = @color("green:bright_black:bold"),
78 | .c3 = @color("blue"),
79 | .c3_alt = @color("blue::dim"),
80 | .c3_accent = @color("blue:bright_black:bold"),
81 | .c4 = @color("cyan"),
82 | .c4_alt = @color("cyan::dim"),
83 | .c4_accent = @color("cyan:bright_black:bold"),
84 | .c5 = @color("magenta"),
85 | .c5_alt = @color("magenta::dim"),
86 | .c5_accent = @color("magenta:bright_black:bold"),
87 | },
88 | .EE
89 | .in
90 |
91 | .SH NOTES
92 | hevi has a precedence for configuration and is:
93 | .nf
94 | 1. Flags
95 | 2. Environment variables
96 | 3. Config file
97 | 4. Defaults
98 | .in
99 |
100 | .SH SEE ALSO
101 | .BR hevi (1)
102 |
--------------------------------------------------------------------------------
/src/parsers/pe.zig:
--------------------------------------------------------------------------------
1 | const std = @import("std");
2 | const hevi = @import("../hevi.zig");
3 |
4 | pub const meta = hevi.Parser.Meta{
5 | .description = "PE (portable executable) files",
6 | };
7 |
8 | const DosHeader = packed struct(u512) {
9 | magic: u16,
10 | cblp: u16,
11 | cp: u16,
12 | crlc: u16,
13 | cparhdr: u16,
14 | minalloc: u16,
15 | maxalloc: u16,
16 | ss: u16,
17 | sp: u16,
18 | csum: u16,
19 | ip: u16,
20 | cs: u16,
21 | lfarlc: u16,
22 | ovno: u16,
23 | rsv_a: u64 = 0,
24 | oemid: u16,
25 | oeminfo: u16,
26 | rsv_b: u160 = 0,
27 | lfanew: u32,
28 | };
29 |
30 | const PeHeader = extern struct {
31 | signature: u32,
32 | file_header: std.coff.CoffHeader,
33 | };
34 |
35 | pub fn matches(data: []const u8) bool {
36 | return std.mem.startsWith(u8, data, "MZ");
37 | }
38 |
39 | fn setRange(colors: []hevi.PaletteColor, offset: usize, len: usize, color: hevi.PaletteColor) void {
40 | @memset(colors[offset .. offset + len], color);
41 | }
42 |
43 | pub fn getColors(colors: []hevi.PaletteColor, data: []const u8) void {
44 | @memset(colors, .normal_alt);
45 |
46 | var fbs = std.io.fixedBufferStream(data);
47 | const reader = fbs.reader();
48 |
49 | const dos_header = reader.readStruct(DosHeader) catch return;
50 | setRange(colors, 0, @sizeOf(DosHeader), .c1);
51 | setRange(colors, @offsetOf(DosHeader, "magic"), @sizeOf(u16), .c1_accent);
52 | setRange(colors, @offsetOf(DosHeader, "lfanew"), @sizeOf(u32), .c1_accent);
53 |
54 | fbs.pos = dos_header.lfanew;
55 |
56 | setRange(colors, fbs.pos, @sizeOf(PeHeader), .c2_accent);
57 | setRange(colors, fbs.pos + @offsetOf(PeHeader, "file_header"), @sizeOf(std.coff.CoffHeader), .c2);
58 |
59 | const pe_header = reader.readStruct(PeHeader) catch return;
60 |
61 | reader.skipBytes(pe_header.file_header.size_of_optional_header, .{}) catch return;
62 |
63 | setRange(
64 | colors,
65 | fbs.pos - pe_header.file_header.size_of_optional_header,
66 | pe_header.file_header.size_of_optional_header,
67 | .c3,
68 | );
69 |
70 | if (pe_header.file_header.size_of_optional_header > 216) {
71 | setRange(
72 | colors,
73 | fbs.pos - pe_header.file_header.size_of_optional_header + 216,
74 | pe_header.file_header.size_of_optional_header - 216,
75 | .c3_alt,
76 | );
77 | }
78 |
79 | for (0..pe_header.file_header.number_of_sections) |i| {
80 | const section_header = reader.readStruct(std.coff.SectionHeader) catch return;
81 | setRange(colors, fbs.pos - @sizeOf(std.coff.SectionHeader), @sizeOf(std.coff.SectionHeader), if (i % 2 == 0) .c4 else .c5);
82 | setRange(colors, fbs.pos - @sizeOf(std.coff.SectionHeader), 8, if (i % 2 == 0) .c4_accent else .c5_accent);
83 | setRange(colors, section_header.pointer_to_raw_data, section_header.size_of_raw_data, if (i % 2 == 0) .c4_alt else .c5_alt);
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/src/parsers/elf.zig:
--------------------------------------------------------------------------------
1 | const std = @import("std");
2 | const hevi = @import("../hevi.zig");
3 |
4 | pub const meta = hevi.Parser.Meta{
5 | .description = "32-bit and 64-bit ELF files",
6 | };
7 |
8 | pub fn matches(data: []const u8) bool {
9 | return std.mem.startsWith(u8, data, std.elf.MAGIC);
10 | }
11 |
12 | fn setRange(colors: []hevi.PaletteColor, offset: usize, len: usize, color: hevi.PaletteColor) void {
13 | @memset(colors[offset .. offset + len], color);
14 | }
15 |
16 | pub fn getColors(colors: []hevi.PaletteColor, data: []const u8) void {
17 | @memset(colors, .normal_alt);
18 |
19 | var fbs = std.io.fixedBufferStream(data);
20 | const reader = fbs.reader();
21 |
22 | switch (data[std.elf.EI_CLASS]) {
23 | std.elf.ELFCLASS64 => {
24 | setRange(colors, 0, @sizeOf(std.elf.Elf64_Ehdr), .c1);
25 | const ehdr = reader.readStruct(std.elf.Elf64_Ehdr) catch return;
26 |
27 | fbs.pos = @truncate(ehdr.e_phoff);
28 | for (0..ehdr.e_phnum) |i| {
29 | setRange(colors, fbs.pos, @sizeOf(std.elf.Elf64_Phdr), if (i % 2 == 0) .c2 else .c3);
30 | const phdr = reader.readStruct(std.elf.Elf64_Phdr) catch return;
31 | if (phdr.p_offset != 0 and phdr.p_type != std.elf.PT_PHDR) {
32 | setRange(colors, @truncate(phdr.p_offset), @truncate(phdr.p_filesz), if (i % 2 == 0) .c2_alt else .c3_alt);
33 | }
34 | }
35 |
36 | fbs.pos = @truncate(ehdr.e_shoff);
37 | for (0..ehdr.e_shnum) |i| {
38 | setRange(colors, fbs.pos, @sizeOf(std.elf.Elf64_Shdr), if (i % 2 == 0) .c4 else .c5);
39 | const shdr = reader.readStruct(std.elf.Elf64_Shdr) catch return;
40 | if (shdr.sh_offset != 0 and shdr.sh_type != std.elf.SHT_NOBITS and shdr.sh_type != std.elf.SHT_NULL) {
41 | setRange(colors, @truncate(shdr.sh_offset), @truncate(shdr.sh_size), if (i % 2 == 0) .c4_alt else .c5_alt);
42 | }
43 | }
44 | },
45 | std.elf.ELFCLASS32 => {
46 | setRange(colors, 0, @sizeOf(std.elf.Elf32_Ehdr), .c1);
47 | const ehdr = reader.readStruct(std.elf.Elf32_Ehdr) catch return;
48 |
49 | fbs.pos = ehdr.e_phoff;
50 | for (0..ehdr.e_phnum) |i| {
51 | setRange(colors, fbs.pos, @sizeOf(std.elf.Elf32_Phdr), if (i % 2 == 0) .c2 else .c3);
52 | const phdr = reader.readStruct(std.elf.Elf32_Phdr) catch return;
53 | if (phdr.p_offset != 0 and phdr.p_type != std.elf.PT_PHDR) setRange(colors, phdr.p_offset, phdr.p_filesz, if (i % 2 == 0) .c2_alt else .c3_alt);
54 | }
55 |
56 | fbs.pos = ehdr.e_shoff;
57 | for (0..ehdr.e_shnum) |i| {
58 | setRange(colors, fbs.pos, @sizeOf(std.elf.Elf32_Shdr), if (i % 2 == 0) .c4 else .c5);
59 | const shdr = reader.readStruct(std.elf.Elf32_Shdr) catch return;
60 | if (shdr.sh_offset != 0 and shdr.sh_type != std.elf.SHT_NOBITS and shdr.sh_type != std.elf.SHT_NULL) {
61 | setRange(colors, shdr.sh_offset, shdr.sh_size, if (i % 2 == 0) .c4_alt else .c5_alt);
62 | }
63 | }
64 | },
65 | else => return,
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/flake.lock:
--------------------------------------------------------------------------------
1 | {
2 | "nodes": {
3 | "flake-parts": {
4 | "inputs": {
5 | "nixpkgs-lib": "nixpkgs-lib"
6 | },
7 | "locked": {
8 | "lastModified": 1717285511,
9 | "narHash": "sha256-iKzJcpdXih14qYVcZ9QC9XuZYnPc6T8YImb6dX166kw=",
10 | "owner": "hercules-ci",
11 | "repo": "flake-parts",
12 | "rev": "2a55567fcf15b1b1c7ed712a2c6fadaec7412ea8",
13 | "type": "github"
14 | },
15 | "original": {
16 | "owner": "hercules-ci",
17 | "repo": "flake-parts",
18 | "type": "github"
19 | }
20 | },
21 | "flake-utils": {
22 | "inputs": {
23 | "systems": "systems"
24 | },
25 | "locked": {
26 | "lastModified": 1731533236,
27 | "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
28 | "owner": "numtide",
29 | "repo": "flake-utils",
30 | "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
31 | "type": "github"
32 | },
33 | "original": {
34 | "owner": "numtide",
35 | "repo": "flake-utils",
36 | "type": "github"
37 | }
38 | },
39 | "nixpkgs": {
40 | "locked": {
41 | "lastModified": 1743964447,
42 | "narHash": "sha256-nEo1t3Q0F+0jQ36HJfbJtiRU4OI+/0jX/iITURKe3EE=",
43 | "owner": "NixOS",
44 | "repo": "nixpkgs",
45 | "rev": "063dece00c5a77e4a0ea24e5e5a5bd75232806f8",
46 | "type": "github"
47 | },
48 | "original": {
49 | "owner": "NixOS",
50 | "ref": "nixos-unstable",
51 | "repo": "nixpkgs",
52 | "type": "github"
53 | }
54 | },
55 | "nixpkgs-lib": {
56 | "locked": {
57 | "lastModified": 1717284937,
58 | "narHash": "sha256-lIbdfCsf8LMFloheeE6N31+BMIeixqyQWbSr2vk79EQ=",
59 | "type": "tarball",
60 | "url": "https://github.com/NixOS/nixpkgs/archive/eb9ceca17df2ea50a250b6b27f7bf6ab0186f198.tar.gz"
61 | },
62 | "original": {
63 | "type": "tarball",
64 | "url": "https://github.com/NixOS/nixpkgs/archive/eb9ceca17df2ea50a250b6b27f7bf6ab0186f198.tar.gz"
65 | }
66 | },
67 | "nixpkgs_2": {
68 | "locked": {
69 | "lastModified": 1718428119,
70 | "narHash": "sha256-WdWDpNaq6u1IPtxtYHHWpl5BmabtpmLnMAx0RdJ/vo8=",
71 | "owner": "NixOS",
72 | "repo": "nixpkgs",
73 | "rev": "e6cea36f83499eb4e9cd184c8a8e823296b50ad5",
74 | "type": "github"
75 | },
76 | "original": {
77 | "owner": "NixOS",
78 | "ref": "nixpkgs-unstable",
79 | "repo": "nixpkgs",
80 | "type": "github"
81 | }
82 | },
83 | "root": {
84 | "inputs": {
85 | "flake-utils": "flake-utils",
86 | "nixpkgs": "nixpkgs",
87 | "zig-deps-fod": "zig-deps-fod"
88 | }
89 | },
90 | "systems": {
91 | "locked": {
92 | "lastModified": 1681028828,
93 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
94 | "owner": "nix-systems",
95 | "repo": "default",
96 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
97 | "type": "github"
98 | },
99 | "original": {
100 | "owner": "nix-systems",
101 | "repo": "default",
102 | "type": "github"
103 | }
104 | },
105 | "zig-deps-fod": {
106 | "inputs": {
107 | "flake-parts": "flake-parts",
108 | "nixpkgs": "nixpkgs_2"
109 | },
110 | "locked": {
111 | "lastModified": 1720999842,
112 | "narHash": "sha256-9G/mlNIbamhnTs1VGB0RlU+JcJGHw5bN0D9BcnQf+DM=",
113 | "owner": "water-sucks",
114 | "repo": "zig-deps-fod",
115 | "rev": "f0a57cdf06f2100d7a045a4062592aeb89468868",
116 | "type": "github"
117 | },
118 | "original": {
119 | "owner": "water-sucks",
120 | "repo": "zig-deps-fod",
121 | "type": "github"
122 | }
123 | }
124 | },
125 | "root": "root",
126 | "version": 7
127 | }
128 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | > [!WARNING]
2 | > This repo was **migrated** to [codeberg](https://codeberg.org/arnauc/hevi).
3 | > The github repo is **not a mirror**. It won't receive any new commits. Please use the new repo.
4 |
5 | ---
6 |
7 |