26 Commits
0.0.2 ... main

Author SHA1 Message Date
abd56b75d3 add: search text field in preparation for fuzzy search feature
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 59s
2026-01-18 00:02:32 +01:00
9559aa974d mod: remove stack reference of unnecessary intermediate Container 2026-01-17 22:51:50 +01:00
1f93e24a37 fix: free Document only if allocated otherwise treat as static
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m10s
2026-01-17 21:42:00 +01:00
0ec9839cc7 mod: bump zlog dependency 2026-01-17 21:41:43 +01:00
9ae9dcfce2 mod(nav): button automatically resizes as necessary 2026-01-17 21:39:51 +01:00
db8485d88e lint: correct formatting
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 59s
2026-01-17 13:27:57 +01:00
8199a23566 ref: move Model manipulation logic in own Element *website*
Some checks failed
Zig Project Action / Lint, Spell-check and test zig project (push) Failing after 47s
This way no `Element` that is only there for rendering requires
any internal state.
2026-01-17 13:25:26 +01:00
83d83c17fa mod: make Element's for rendering stateless
The elements derive their corresponding content to render from
the `Model` without any local state.
2026-01-17 13:11:26 +01:00
1b4c1bbab8 mod(ci): update release process to also include spell-checking 2026-01-17 12:42:09 +01:00
361623d0f1 doc: remove warning about required zig version
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 54s
2026-01-17 12:31:23 +01:00
6bf4c98d44 mod(ci): adapt to use zig latest release version
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m13s
2026-01-17 12:28:29 +01:00
bfdaf82626 mod: bump zterm dependency with required code adaptations
Some checks failed
Zig Project Action / Lint, Spell-check and test zig project (push) Failing after 1m16s
2026-01-17 12:26:36 +01:00
b4836b8d2b mod: bump to version 0.0.4
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 55s
Release Zig Application / Release zig project (release) Successful in 1m36s
2025-11-08 12:54:20 +01:00
5ee2c6662e feat: invalid page for unavailable resources
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m46s
Accessing resources which are not available, the invalid page will be
rendered instead. The original attempt for access will be logged.
2025-11-08 12:50:25 +01:00
28afdc0ff9 mod: bump to version 0.0.3
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 55s
Release Zig Application / Release zig project (release) Successful in 1m35s
2025-11-05 22:12:27 +01:00
b228c69ae5 mod: bump zterm dependency
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m7s
2025-11-05 22:10:48 +01:00
489d958ac5 mod: bump zterm dependency; respect scrollbar in calculated size requirement for content
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m19s
2025-11-05 18:47:59 +01:00
f197416b43 feat: accept argument for path to open
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m14s
2025-11-02 21:34:11 +01:00
c599bc55c7 mod: bump zterm dependency; show no background for content scrollbar 2025-11-02 21:33:30 +01:00
c5d674ac5c mod: include timestamps for logging 2025-11-02 21:31:56 +01:00
ba15f4e93f mod: bump zlog dependency
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m14s
2025-11-02 13:21:01 +01:00
a877ac3e7d feat(content): routing to provided .blog paths
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m7s
This is a starting point to dynamically loading `markdown` files as blog
entries. With this change the *doc/about.md* and *doc/blog.md* files
are no longer builded into the executable and instead read from the
filesystem during runtime (along with the new test file *doc/test.md*).
2025-11-01 22:36:48 +01:00
e4c3f69821 mod: remove dead code
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 53s
2025-11-01 17:43:03 +01:00
55861114dc feat(content): parse document preemble
Some checks failed
Zig Project Action / Lint, Spell-check and test zig project (push) Has been cancelled
Show title stored in preemble of markdown file if available.
2025-11-01 17:41:33 +01:00
74bf941820 feat(content): scrollable contents; bump zterm dependency
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m23s
With functional increments in `zterm`'s `Scrollable` `Element`, an
implementation (such as `Content`) can provide a size hint for the
minimal required size to dynamically change its dimensions for the
scrollable `Container` in the `Scrollable` `Element`.
2025-11-01 14:44:05 +01:00
8ac6c16289 mod: bump zterm dependency; add zlog dependency
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 1m22s
`zlog` is used to log messages to the log file that is also used by
`serve` by default, making it a single source for all the log messages.
2025-11-01 00:18:44 +01:00
11 changed files with 416 additions and 120 deletions

View File

@@ -15,9 +15,15 @@ jobs:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup zig installation - name: Setup zig installation
uses: mlugg/setup-zig@v2 uses: https://codeberg.org/mlugg/setup-zig@v2
with: with:
version: master version: latest
- name: Lint check
run: zig fmt --check .
- name: Spell checking
uses: crate-ci/typos@v1.39.0
with:
config: ./.typos-config
- name: Run tests - name: Run tests
run: zig build --release=fast run: zig build --release=fast
- name: Release build artifacts - name: Release build artifacts

View File

@@ -14,9 +14,9 @@ jobs:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup zig installation - name: Setup zig installation
uses: mlugg/setup-zig@v2 uses: https://codeberg.org/mlugg/setup-zig@v2
with: with:
version: master version: latest
- name: Lint check - name: Lint check
run: zig fmt --check . run: zig fmt --check .
- name: Spell checking - name: Spell checking

View File

@@ -4,9 +4,6 @@ This is my terminal based website. It is served as a tui application via ssh and
It contains information about me and my projects as well as blog entries about something I feel like writing something about. It contains information about me and my projects as well as blog entries about something I feel like writing something about.
> [!caution]
> Only builds using the zig master version are tested to work.
## zterm ## zterm
This tui application also serves as an example implementation of the [zterm](https://gitea.yves-biener.de/yves-biener/zterm) library. This tui application also serves as an example implementation of the [zterm](https://gitea.yves-biener.de/yves-biener/zterm) library.

View File

@@ -4,6 +4,14 @@ pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{}); const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{}); const optimize = b.standardOptimizeOption(.{});
const zlog = b.dependency("zlog", .{
.target = target,
.optimize = optimize,
.timestamp = true,
.stderr = false,
.file = "log",
});
const zterm = b.dependency("zterm", .{ const zterm = b.dependency("zterm", .{
.target = target, .target = target,
.optimize = optimize, .optimize = optimize,
@@ -17,18 +25,7 @@ pub fn build(b: *std.Build) void {
.optimize = optimize, .optimize = optimize,
.imports = &.{ .imports = &.{
.{ .name = "zterm", .module = zterm.module("zterm") }, .{ .name = "zterm", .module = zterm.module("zterm") },
.{ .{ .name = "zlog", .module = zlog.module("zlog") },
.name = "about",
.module = b.createModule(.{
.root_source_file = b.path("doc/about.md"),
}),
},
.{
.name = "blog",
.module = b.createModule(.{
.root_source_file = b.path("doc/blog.md"),
}),
},
}, },
}), }),
}); });

View File

@@ -1,13 +1,17 @@
.{ .{
.name = .tui_website, .name = .tui_website,
// This is a [Semantic Version](https://semver.org/). // This is a [Semantic Version](https://semver.org/).
.version = "0.0.2", .version = "0.0.4",
.fingerprint = 0x93d98a4d9d000e9c, // Changing this has security and trust implications. .fingerprint = 0x93d98a4d9d000e9c, // Changing this has security and trust implications.
.minimum_zig_version = "0.16.0-dev.463+f624191f9", .minimum_zig_version = "0.16.0-dev.463+f624191f9",
.dependencies = .{ .dependencies = .{
.zterm = .{ .zterm = .{
.url = "git+https://gitea.yves-biener.de/yves-biener/zterm#89aeac1e968f1390bd945f734aac8612efbab179", .url = "git+https://gitea.yves-biener.de/yves-biener/zterm#4874252e8c3a5d645ac2c37bbfd0e669964912fc",
.hash = "zterm-0.3.0-1xmmELjzGwBxVlqXRHn7p-sXFU9xPxqFMxF0PY2CkzFn", .hash = "zterm-0.3.0-1xmmEH82HABfsn5imAK8lw93LevIaqNV10g6xfkNj_OT",
},
.zlog = .{
.url = "git+https://gitea.yves-biener.de/yves-biener/zlog#b3c8a3ab1ccae1ba50efbdf26d68a18da8594d2c",
.hash = "zlog-0.16.0-6JSlRwNJAACVd89xnhXRHzCnCs7qab9Jcmx11VMS2ZpL",
}, },
}, },
.paths = .{ .paths = .{

View File

@@ -1,5 +1,7 @@
# Blog ---
title: Welcome to my Blog
date: 2025-11-01
---
This is the main entry page for my blog. I plan on writing on things I feel like worth sharing, mentioning for other developers, tinkers like me. This is the main entry page for my blog. I plan on writing on things I feel like worth sharing, mentioning for other developers, tinkers like me.
The blog is currently a work in progress and will be updated once a first version of the tui website supports more dynamic contents. The blog is currently a work in progress and will be updated once a first version of the tui website supports more dynamic contents.

51
doc/test.md Normal file
View File

@@ -0,0 +1,51 @@
---
title: Capabilities of tui-website
---
Not everything that can be done with markdown can be representented by this tui-application. It is simple enough to
support basic markdown files. Currently the text has to be manually reflowed to 120 characters, such that there is no
issue when rendering (i.e. correct line breaks, etc.)
The following list contains all the available features that are supported (with some examples below):
- unordered lists (using `-`, `+` and `*`, where the corresponding symbol is used when rendering)
* links
+ blocks
- `inline blocks` (written as `inline blocks`)
* _italic_ (written as `_italic_`)
+ **bold** (written as `**bold**`)
- headlines (corresponding sub heading six levels deep)
Headings currently require a second newline before the list items to render correctly with a empty line in between the
following contents and the last list item.
Another paragraph.
# Examples
> quotes are not supported (yet)
The following is a block. Which renders as follows (containing line numbers and **no code highlighting**):
---
```zig
fn myFunction() void {
if (hasFeature()) {
// Feature-specific code
} else {
// Default code
}
}
inline fn hasFeature() bool {
return (comptime comptimeCheck()) and runtimeCheck();
}
```
## Combinations are possible
1. see this excellent blog post: [Conditionally Disabling Code with comptime in Zig - Mitchell Hashimoto](https://mitchellh.com/writing/zig-comptime-conditional-disable)
### See deeper levels are possible and will be rendered correctly
This is just some placeholder text.

View File

@@ -1,8 +1,9 @@
pub fn Content(App: type) type { pub fn Website(App: type) type {
return struct { return struct {
pub fn init(allocator: Allocator) @This() { gpa: Allocator,
_ = allocator;
return .{}; pub fn init(gpa: Allocator) @This() {
return .{ .gpa = gpa };
} }
pub fn element(this: *@This()) App.Element { pub fn element(this: *@This()) App.Element {
@@ -10,34 +11,72 @@ pub fn Content(App: type) type {
.ptr = this, .ptr = this,
.vtable = &.{ .vtable = &.{
.handle = handle, .handle = handle,
.content = content,
}, },
}; };
} }
fn handle(ctx: *anyopaque, model: *App.Model, event: App.Event) !void { fn handle(ctx: *anyopaque, model: *App.Model, event: App.Event) !void {
_ = ctx; const this: *@This() = @ptrCast(@alignCast(ctx));
switch (event) { switch (event) {
.about => model.page = .about, .page => |page| switch (page) {
.blog => model.page = .blog, .about => {
model.page.deinit(this.gpa);
model.page = .about;
model.document.deinit(this.gpa);
model.document = .init(try std.fs.cwd().readFileAlloc(this.gpa, "./doc/about.md", std.math.maxInt(usize)));
},
.blog => |path| {
model.page.deinit(this.gpa);
model.document.deinit(this.gpa);
errdefer {
if (path) |p| this.gpa.free(p);
model.document = .invalidPage;
model.page = .{ .blog = null };
}
model.document = .init(try std.fs.cwd().readFileAlloc(this.gpa, if (path) |p| p else "./doc/blog.md", std.math.maxInt(usize)));
model.page = .{ .blog = path };
},
},
.key => |key| {
if (key.eql(.{ .cp = '/' })) model.searching = true;
if (key.eql(.{ .cp = zterm.input.Escape })) model.searching = false;
},
else => {}, else => {},
} }
} }
};
}
fn content(ctx: *anyopaque, model: *const App.Model, cells: []zterm.Cell, size: zterm.Point) !void { pub fn Content(App: type) type {
_ = ctx; return struct {
pub fn element(this: *@This()) App.Element {
return .{
.ptr = this,
.vtable = &.{
.minSize = minSize,
.content = content,
},
};
}
fn minSize(_: *anyopaque, model: *const App.Model, _: zterm.Point) zterm.Point {
// NOTE currently the contents are assumed to fit into the viewport, excessive lines are cut off
// (there currently no horizontal scrolling)
return .{ .y = @intCast(std.mem.count(u8, model.document.content, "\n") + 1) };
}
fn content(_: *anyopaque, model: *const App.Model, cells: []zterm.Cell, size: zterm.Point) !void {
assert(cells.len == @as(usize, size.x) * @as(usize, size.y)); assert(cells.len == @as(usize, size.x) * @as(usize, size.y));
const text = switch (model.page) { const text = model.document.content;
.about => @embedFile("about"),
.blog => @embedFile("blog"),
};
var index: usize = 0; var index: usize = 0;
for (0..size.y) |row| { for (0..size.y) |row| {
for (0..size.x) |col| { for (0..size.x) |col| {
const cell = row * size.x + col; const cell = row * size.x + col;
assert(cell < cells.len);
if (index == text.len) return; if (index == text.len) return;
const cp = text[index]; const cp = text[index];
@@ -48,6 +87,10 @@ pub fn Content(App: type) type {
else => cp, else => cp,
}; };
} }
if (text[index - 1] != '\n') {
// go to the end of the line
while (index < text.len and text[index] != '\n') index += 1;
}
} }
} }
}; };
@@ -55,14 +98,6 @@ pub fn Content(App: type) type {
pub fn Title(App: type) type { pub fn Title(App: type) type {
return struct { return struct {
text: []const u8,
pub fn init() @This() {
return .{
.text = "<Title>",
};
}
pub fn element(this: *@This()) App.Element { pub fn element(this: *@This()) App.Element {
return .{ return .{
.ptr = this, .ptr = this,
@@ -72,10 +107,11 @@ pub fn Title(App: type) type {
}; };
} }
fn content(ctx: *anyopaque, _: *const App.Model, cells: []zterm.Cell, size: zterm.Point) !void { fn content(_: *anyopaque, model: *const App.Model, cells: []zterm.Cell, size: zterm.Point) !void {
const this: *const @This() = @ptrCast(@alignCast(ctx));
assert(cells.len == @as(usize, size.x) * @as(usize, size.y)); assert(cells.len == @as(usize, size.x) * @as(usize, size.y));
for (0.., this.text) |idx, cp| {
if (model.document.title) |text| {
for (0.., text) |idx, cp| {
cells[idx].style.fg = .green; cells[idx].style.fg = .green;
cells[idx].style.emphasis = &.{.bold}; cells[idx].style.emphasis = &.{.bold};
cells[idx].cp = cp; cells[idx].cp = cp;
@@ -84,18 +120,24 @@ pub fn Title(App: type) type {
if (idx == cells.len - 1) break; if (idx == cells.len - 1) break;
} }
} }
}
}; };
} }
pub fn InfoBanner(App: type) type { pub fn InfoBanner(App: type) type {
return struct { const left_text: []const u8 = "Build using zig";
left_text: []const u8, const right_text: []const u8 = "Yves Biener";
right_text: []const u8,
pub fn init() @This() { return struct {
gpa: Allocator,
search: App.TextField,
queue: *App.Queue,
pub fn init(gpa: Allocator, queue: *App.Queue) @This() {
return .{ return .{
.left_text = "Build with zig", .gpa = gpa,
.right_text = "Yves Biener (@yves-biener)", .search = .init(gpa, .init(.default, .default)),
.queue = queue,
}; };
} }
@@ -103,16 +145,49 @@ pub fn InfoBanner(App: type) type {
return .{ return .{
.ptr = this, .ptr = this,
.vtable = &.{ .vtable = &.{
.deinit = deinit,
.minSize = minSize,
.handle = handle,
.content = content, .content = content,
}, },
}; };
} }
fn content(ctx: *anyopaque, _: *const App.Model, cells: []zterm.Cell, size: zterm.Point) !void { fn deinit(ctx: *anyopaque) void {
const this: *const @This() = @ptrCast(@alignCast(ctx)); const this: *@This() = @ptrCast(@alignCast(ctx));
this.search.deinit();
}
fn minSize(ctx: *anyopaque, model: *const App.Model, _: zterm.Point) zterm.Point {
const this: *@This() = @ptrCast(@alignCast(ctx));
if (!model.searching) this.search.clear();
return .{ .y = if (model.searching) 2 else 1 };
}
fn handle(ctx: *anyopaque, model: *App.Model, event: App.Event) !void {
const this: *@This() = @ptrCast(@alignCast(ctx));
switch (event) {
.key => if (model.searching) {
const prev_len = this.search.input.items.len;
try this.search.element().handle(model, event);
const next_len = this.search.input.items.len;
if (next_len == 0) {
model.searching = false;
return;
}
// NOTE do not include the leading '/' in the `.search` event payload!
if (prev_len != next_len) this.queue.push(.{ .search = this.search.input.items[1..] });
},
else => {},
}
}
fn content(ctx: *anyopaque, model: *const App.Model, cells: []zterm.Cell, size: zterm.Point) !void {
assert(cells.len == @as(usize, size.x) * @as(usize, size.y)); assert(cells.len == @as(usize, size.x) * @as(usize, size.y));
for (0.., this.left_text) |idx, cp| { for (0.., left_text) |idx, cp| {
// NOTE do not write over the contents of this `Container`'s `Size` // NOTE do not write over the contents of this `Container`'s `Size`
if (idx == cells.len) break; if (idx == cells.len) break;
@@ -121,10 +196,26 @@ pub fn InfoBanner(App: type) type {
cells[idx].cp = cp; cells[idx].cp = cp;
} }
var start_idx = size.x -| this.right_text.len; switch (model.page) {
if (start_idx <= this.left_text.len) start_idx = this.left_text.len + 1; .about => {},
.blog => |path| if (path) |p| page: {
const start_idx = (size.x -| p.len) / 2;
if (start_idx <= left_text.len) break :page;
for (start_idx.., this.right_text) |idx, cp| { for (start_idx.., p) |idx, cp| {
// NOTE do not write over the contents of this `Container`'s `Size`
if (idx == cells.len) break;
cells[idx].style.fg = .default;
cells[idx].cp = cp;
}
},
}
var start_idx = size.x -| right_text.len;
if (start_idx <= left_text.len) start_idx = left_text.len + 1;
for (start_idx.., right_text) |idx, cp| {
// NOTE do not write over the contents of this `Container`'s `Size` // NOTE do not write over the contents of this `Container`'s `Size`
if (idx == cells.len) break; if (idx == cells.len) break;
@@ -132,6 +223,11 @@ pub fn InfoBanner(App: type) type {
cells[idx].style.emphasis = &.{.dim}; cells[idx].style.emphasis = &.{.dim};
cells[idx].cp = cp; cells[idx].cp = cp;
} }
if (model.searching) {
const this: *@This() = @ptrCast(@alignCast(ctx));
try this.search.element().content(model, cells[size.x..], .{ .x = size.x, .y = 1 });
}
} }
}; };
} }
@@ -140,3 +236,4 @@ const std = @import("std");
const Allocator = std.mem.Allocator; const Allocator = std.mem.Allocator;
const assert = std.debug.assert; const assert = std.debug.assert;
const zterm = @import("zterm"); const zterm = @import("zterm");
const Model = @import("model.zig");

View File

@@ -1,3 +1,11 @@
// TODO
// - should the path containing the contents of the tui-website reside in the
// hardcode `./doc` directory or shall this become a compilation argument to
// allow for custom directory locations?
// usage: tui_website <location>
// <location>: partial path to the document without the file extension and the beginning `./doc` path
// ending `/` (as used from the web-world) are trimmed automatically
pub fn main() !void { pub fn main() !void {
errdefer |err| log.err("Application Error: {any}", .{err}); errdefer |err| log.err("Application Error: {any}", .{err});
@@ -6,17 +14,29 @@ pub fn main() !void {
const allocator = gpa.allocator(); const allocator = gpa.allocator();
var app: App = .init(.{}); var arg_it = try std.process.argsWithAllocator(allocator);
errdefer arg_it.deinit();
// skip own executable name
_ = arg_it.skip();
var app: App = .init(.{}, .{
.page = .about,
.document = .init(try std.fs.cwd().readFileAlloc(allocator, "./doc/about.md", std.math.maxInt(usize))),
});
defer app.model.deinit(allocator);
var renderer = zterm.Renderer.Buffered.init(allocator); var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit(); defer renderer.deinit();
var website: Website = .init(allocator);
var container = try App.Container.init(allocator, .{ var container = try App.Container.init(allocator, .{
.layout = .{ .layout = .{
.padding = .horizontal(2), .padding = .horizontal(2),
.direction = .vertical, .direction = .vertical,
.separator = .{ .enabled = true }, .separator = .{ .enabled = true },
}, },
}, .{}); }, website.element());
defer container.deinit(); defer container.deinit();
// header with navigation buttons and content's title // header with navigation buttons and content's title
@@ -32,7 +52,7 @@ pub fn main() !void {
}, .{}); }, .{});
// title // title
{ {
var title: Title = .init(); var title: Title = .{};
try header.append(try .init(allocator, .{}, title.element())); try header.append(try .init(allocator, .{}, title.element()));
} }
// about navigation button // about navigation button
@@ -40,7 +60,6 @@ pub fn main() !void {
var button: NavigationButton(.about) = .init(&app.model, &app.queue); var button: NavigationButton(.about) = .init(&app.model, &app.queue);
try header.append(try .init(allocator, .{ try header.append(try .init(allocator, .{
.size = .{ .size = .{
.dim = .{ .x = 5 + 2 },
.grow = .vertical, .grow = .vertical,
}, },
}, button.element())); }, button.element()));
@@ -50,31 +69,30 @@ pub fn main() !void {
var button: NavigationButton(.blog) = .init(&app.model, &app.queue); var button: NavigationButton(.blog) = .init(&app.model, &app.queue);
try header.append(try .init(allocator, .{ try header.append(try .init(allocator, .{
.size = .{ .size = .{
.dim = .{ .x = 4 + 2 },
.grow = .vertical, .grow = .vertical,
}, },
}, button.element())); }, button.element()));
} }
try container.append(header); try container.append(header);
} }
// main actual tui_website page content // page contents
{ {
// intermediate container for *padding* var content: Content = .{};
var content: Content = .init(allocator); var scrollable: App.Scrollable = .init(try .init(allocator, .{}, content.element()), .enabled(.green, false));
var content_container: App.Container = try .init(allocator, .{
// intermediate container for *padding* containing the scrollable `Content`
var scrollable_container: App.Container = try .init(allocator, .{
.layout = .{ .padding = .horizontal(2) }, .layout = .{ .padding = .horizontal(2) },
}, .{}); }, .{});
try content_container.append(try .init(allocator, .{}, content.element())); try scrollable_container.append(try .init(allocator, .{}, scrollable.element()));
try container.append(content_container);
try container.append(scrollable_container);
} }
// footer // footer
{ {
var info_banner: InfoBanner = .init(); var info_banner: InfoBanner = .init(allocator, &app.queue);
const footer: App.Container = try .init(allocator, .{ const footer: App.Container = try .init(allocator, .{
.size = .{ .size = .{ .grow = .horizontal },
.dim = .{ .y = 1 },
.grow = .horizontal,
},
}, info_banner.element()); }, info_banner.element());
try container.append(footer); try container.append(footer);
} }
@@ -82,15 +100,53 @@ pub fn main() !void {
try app.start(); try app.start();
defer app.stop() catch |err| log.err("Failed to stop application: {any}", .{err}); defer app.stop() catch |err| log.err("Failed to stop application: {any}", .{err});
if (arg_it.next()) |path| {
// TODO check path is only pointing to allowed files?
// - only *markdown* files (file extension `.md`)
// - only in a specific path / directory?
// -> enforce a specific structure?
// -> in case an invalid path is provided the 404 error page shall be shown
// -> reporte an corresponding error! (such that I can see that in the log)
var blog = path[0..path.len];
blog = std.mem.trimStart(u8, blog, "./");
blog = std.mem.trimEnd(u8, blog, ".md");
blog = std.mem.trimEnd(u8, blog, "/");
app.postEvent(.{
.page = .{
.blog = try std.fmt.allocPrint(allocator, "./doc/{s}.md", .{blog}),
},
});
}
arg_it.deinit();
// event loop // event loop
while (true) { loop: while (true) {
// batch events since last iteration
const len = blk: {
app.queue.poll();
app.queue.lock();
defer app.queue.unlock();
break :blk app.queue.len();
};
// handle events // handle events
const event = app.nextEvent(); for (0..len) |_| {
const event = app.queue.pop();
// pre event handling // pre event handling
switch (event) { switch (event) {
.key => |key| { .key => |key| {
if (key.eql(.{ .cp = 'c', .mod = .{ .ctrl = true } })) app.quit(); if (key.eql(.{ .cp = 'c', .mod = .{ .ctrl = true } }) or key.eql(.{ .cp = 'q' })) app.quit();
// test if the event handling is working correctly
if (key.eql(.{ .cp = zterm.input.Space })) app.postEvent(.{
.page = .{
.blog = try allocator.dupe(u8, "./doc/test.md"),
},
});
},
.page => |page| switch (page) {
.about => log.info(ResourceRequestFormat, .{"./doc/about.md"}),
.blog => |path| log.info(ResourceRequestFormat, .{if (path) |p| p else "./doc/blog.md"}),
}, },
.err => |err| log.err("Received {s} with message: {s}", .{ @errorName(err.err), err.msg }), .err => |err| log.err("Received {s} with message: {s}", .{ @errorName(err.err), err.msg }),
else => {}, else => {},
@@ -105,34 +161,39 @@ pub fn main() !void {
// post event handling // post event handling
switch (event) { switch (event) {
.quit => break, .quit => break :loop,
else => {}, else => {},
} }
}
container.resize(try renderer.resize()); container.resize(&app.model, try renderer.resize());
container.reposition(.{}); container.reposition(&app.model, .{});
try renderer.render(@TypeOf(container), &container, App.Model, &app.model); try renderer.render(@TypeOf(container), &container, App.Model, &app.model);
try renderer.flush(); try renderer.flush();
} }
} }
pub const panic = App.panic_handler; pub const panic = App.panic_handler;
pub const std_options = zlog.std_options;
const log = std.log.scoped(.default); const log = std.log.scoped(.default);
const ResourceRequestFormat = "Requesting resource: `{s}`";
const std = @import("std"); const std = @import("std");
const assert = std.debug.assert; const assert = std.debug.assert;
const zlog = @import("zlog");
const zterm = @import("zterm"); const zterm = @import("zterm");
const App = zterm.App( const App = zterm.App(
Model, Model,
union(enum) { union(enum) {
about, search: []const u21,
blog, page: Model.Pages,
}, },
); );
const contents = @import("content.zig"); const contents = @import("content.zig");
const Model = @import("model.zig"); const Model = @import("model.zig");
const Website = contents.Website(App);
const Content = contents.Content(App); const Content = contents.Content(App);
const Title = contents.Title(App); const Title = contents.Title(App);
const InfoBanner = contents.InfoBanner(App); const InfoBanner = contents.InfoBanner(App);

View File

@@ -1,6 +1,79 @@
page: Pages = .blog, page: Pages,
document: Document,
const Pages = enum { searching: bool = false,
pub fn deinit(this: *@This(), allocator: Allocator) void {
this.page.deinit(allocator);
this.document.deinit(allocator);
this.page = undefined;
this.document = undefined;
}
pub const Pages = union(enum) {
about, about,
blog, blog: ?[]const u8,
pub fn deinit(this: @This(), allocator: Allocator) void {
switch (this) {
.blog => |path| if (path) |p| allocator.free(p),
else => {},
}
}
}; };
pub const Document = struct {
// preemble:
title: ?[]const u8 = null,
date: ?[]const u8 = null,
content: []const u8 = undefined,
ptr: ?[]const u8,
const Preemble = enum {
title,
date,
};
pub const invalidPage: @This() = .{
.title = "Page not found",
.content = "Requested page does not exist",
.ptr = null,
};
pub fn init(content: []const u8) @This() {
if (std.mem.startsWith(u8, content, "---\n")) {
var document: @This() = .{ .ptr = content };
// we assume the content includes a preemble
var iter = std.mem.splitSequence(u8, content, "---\n");
assert(iter.next().?.len == 0);
if (iter.next()) |preemble| {
var lines = std.mem.splitScalar(u8, preemble, '\n');
while (lines.next()) |line| {
var entry = std.mem.splitSequence(u8, line, ": ");
const key = entry.next().?;
const value = entry.next();
assert(entry.next() == null);
if (std.meta.stringToEnum(Preemble, key)) |k| switch (k) {
.title => document.title = value,
.date => document.date = value,
};
}
}
document.content = iter.rest();
return document;
} else return .{
.content = content,
.ptr = content,
};
}
pub fn deinit(this: *@This(), allocator: Allocator) void {
if (this.ptr) |ptr| allocator.free(ptr);
this.* = .{ .ptr = null };
}
};
const std = @import("std");
const assert = std.debug.assert;
const Allocator = std.mem.Allocator;

View File

@@ -1,6 +1,6 @@
pub fn NavigationButton(App: type) fn (std.meta.FieldEnum(App.Event)) type { pub fn NavigationButton(App: type) fn (std.meta.FieldEnum(App.Model.Pages)) type {
const navigation_struct = struct { const navigation_struct = struct {
fn navigation_fn(page: std.meta.FieldEnum(App.Event)) type { fn navigation_fn(page: std.meta.FieldEnum(App.Model.Pages)) type {
return struct { return struct {
text: []const u8, text: []const u8,
highlight: bool, highlight: bool,
@@ -12,7 +12,6 @@ pub fn NavigationButton(App: type) fn (std.meta.FieldEnum(App.Event)) type {
.highlight = switch (page) { .highlight = switch (page) {
.about => model.page == .about, .about => model.page == .about,
.blog => model.page == .blog, .blog => model.page == .blog,
else => @compileError("NavigationButton initiated with non page `App.Event` variant"),
}, },
.queue = queue, .queue = queue,
}; };
@@ -22,18 +21,28 @@ pub fn NavigationButton(App: type) fn (std.meta.FieldEnum(App.Event)) type {
return .{ return .{
.ptr = this, .ptr = this,
.vtable = &.{ .vtable = &.{
.minSize = minSize,
.handle = handle, .handle = handle,
.content = content, .content = content,
}, },
}; };
} }
fn minSize(_: *anyopaque, _: *const App.Model, _: zterm.Point) zterm.Point {
return .{ .x = @tagName(page).len + 2 };
}
fn handle(ctx: *anyopaque, _: *App.Model, event: App.Event) !void { fn handle(ctx: *anyopaque, _: *App.Model, event: App.Event) !void {
const this: *@This() = @ptrCast(@alignCast(ctx)); const this: *@This() = @ptrCast(@alignCast(ctx));
switch (event) { switch (event) {
.about, .blog => this.highlight = event == page, .page => |p| this.highlight = p == page,
// TODO accept key input too? // TODO accept key input too?
.mouse => |mouse| if (mouse.button == .left and mouse.kind == .release) this.queue.push(page), .mouse => |mouse| if (mouse.button == .left and mouse.kind == .release) this.queue.push(switch (page) {
.about => .{ .page = .about },
.blog => .{
.page = .{ .blog = null },
},
}),
else => {}, else => {},
} }
} }
@@ -45,8 +54,7 @@ pub fn NavigationButton(App: type) fn (std.meta.FieldEnum(App.Event)) type {
assert(size.y == 1); assert(size.y == 1);
for (1.., this.text) |idx, cp| { for (1.., this.text) |idx, cp| {
cells[idx].style.fg = if (this.highlight) .black else .default; if (this.highlight) cells[idx].style.ul = .green;
cells[idx].style.bg = if (this.highlight) .green else .default;
cells[idx].style.emphasis = &.{.underline}; cells[idx].style.emphasis = &.{.underline};
cells[idx].cp = cp; cells[idx].cp = cp;
} }