aaf1bb4784
Create USAGE.md to serve as a friendly guide for usage. Move the libxev and zig-aio event loops to serve as an example of how to implement a custom event loop in USAGE.md. Remove dependency on these libraries and all associated examples and source code. The motivation for this change is to provide a simpler library. The power to create a custom event loop will always be kept, however the support burden of maintaining three event loops is not where I want to focus my energy. The code is small enough that it's easy enough to be copy/pasted into a project or provided as a third-party library.
99 lines
3.2 KiB
Zig
99 lines
3.2 KiB
Zig
const std = @import("std");
|
|
|
|
pub fn build(b: *std.Build) void {
|
|
const include_images = b.option(bool, "images", "Enable support for images (default: true)") orelse true;
|
|
|
|
const options = b.addOptions();
|
|
options.addOption(bool, "images", include_images);
|
|
|
|
const options_mod = options.createModule();
|
|
|
|
const target = b.standardTargetOptions(.{});
|
|
const optimize = b.standardOptimizeOption(.{});
|
|
const root_source_file = b.path("src/main.zig");
|
|
|
|
// Dependencies
|
|
const zg_dep = b.dependency("zg", .{
|
|
.optimize = optimize,
|
|
.target = target,
|
|
});
|
|
const zigimg_dep = if (include_images) b.lazyDependency("zigimg", .{
|
|
.optimize = optimize,
|
|
.target = target,
|
|
}) else null;
|
|
|
|
// Module
|
|
const vaxis_mod = b.addModule("vaxis", .{
|
|
.root_source_file = root_source_file,
|
|
.target = target,
|
|
.optimize = optimize,
|
|
});
|
|
vaxis_mod.addImport("code_point", zg_dep.module("code_point"));
|
|
vaxis_mod.addImport("grapheme", zg_dep.module("grapheme"));
|
|
vaxis_mod.addImport("DisplayWidth", zg_dep.module("DisplayWidth"));
|
|
if (zigimg_dep) |dep| vaxis_mod.addImport("zigimg", dep.module("zigimg"));
|
|
vaxis_mod.addImport("build_options", options_mod);
|
|
|
|
// Examples
|
|
const Example = enum {
|
|
aio,
|
|
cli,
|
|
image,
|
|
main,
|
|
nvim,
|
|
table,
|
|
text_input,
|
|
vaxis,
|
|
view,
|
|
vt,
|
|
xev,
|
|
};
|
|
const example_option = b.option(Example, "example", "Example to run (default: text_input)") orelse .text_input;
|
|
const example_step = b.step("example", "Run example");
|
|
const example = b.addExecutable(.{
|
|
.name = "example",
|
|
// future versions should use b.path, see zig PR #19597
|
|
.root_source_file = b.path(
|
|
b.fmt("examples/{s}.zig", .{@tagName(example_option)}),
|
|
),
|
|
.target = target,
|
|
.optimize = optimize,
|
|
});
|
|
example.root_module.addImport("vaxis", vaxis_mod);
|
|
|
|
const example_run = b.addRunArtifact(example);
|
|
example_step.dependOn(&example_run.step);
|
|
|
|
// Tests
|
|
const tests_step = b.step("test", "Run tests");
|
|
|
|
const tests = b.addTest(.{
|
|
.root_source_file = b.path("src/main.zig"),
|
|
.target = target,
|
|
.optimize = optimize,
|
|
});
|
|
tests.root_module.addImport("code_point", zg_dep.module("code_point"));
|
|
tests.root_module.addImport("grapheme", zg_dep.module("grapheme"));
|
|
tests.root_module.addImport("DisplayWidth", zg_dep.module("DisplayWidth"));
|
|
if (zigimg_dep) |dep| tests.root_module.addImport("zigimg", dep.module("zigimg"));
|
|
tests.root_module.addImport("build_options", options_mod);
|
|
|
|
const tests_run = b.addRunArtifact(tests);
|
|
b.installArtifact(tests);
|
|
tests_step.dependOn(&tests_run.step);
|
|
|
|
// Docs
|
|
const docs_step = b.step("docs", "Build the vaxis library docs");
|
|
const docs_obj = b.addObject(.{
|
|
.name = "vaxis",
|
|
.root_source_file = root_source_file,
|
|
.target = target,
|
|
.optimize = optimize,
|
|
});
|
|
const docs = docs_obj.getEmittedDocs();
|
|
docs_step.dependOn(&b.addInstallDirectory(.{
|
|
.source_dir = docs,
|
|
.install_dir = .prefix,
|
|
.install_subdir = "docs",
|
|
}).step);
|
|
}
|