mirrors/zap
1
0
Fork 0
mirror of https://github.com/zigzap/zap.git synced 2025-10-20 15:14:08 +00:00
Code Activity

Updated mustache.zig to be more Zig like - mustache.zig now returns a Mustache struct. This allows functions to be called on the mustache instance, e.g. zap.mustacheFree(mustache) -> mustache.free(). - Updated mustache example. - Added doc strings to majority of mustache functions.

Browse source
This commit is contained in:
Brook Jeynes 2023-12-30 13:15:07 +10:00 • committed by Rene Schallner
parent 57370b4e31
commit 9c19038082
2 changed files with 250 additions and 223 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
examples/mustache/mustache.zig
View file

@ -1,15 +1,26 @@
const std = @import("std");
const zap = @import("zap");
const Mustache = @import("zap").Mustache;
fn on_request(r: zap.SimpleRequest) void {
const template = "{{=<< >>=}}* Users:\r\n<<#users>><<id>>. <<& name>> (<<name>>)\r\n<</users>>\r\nNested: <<& nested.item >>.";
const p = zap.mustacheData(template) catch return;
defer zap.mustacheFree(p);
const template =
\\ {{=<< >>=}}
\\ * Users:
\\ <<#users>>
\\ <<id>>. <<& name>> (<<name>>)
\\ <</users>>
\\ Nested: <<& nested.item >>.
;
var mustache = Mustache.fromData(template) catch return;
defer mustache.deinit();
const User = struct {
name: []const u8,
id: isize,
};
const ret = zap.mustacheBuild(p, .{
const ret = mustache.build(.{
.users = [_]User{
.{
.name = "Rene",
@ -25,6 +36,7 @@ fn on_request(r: zap.SimpleRequest) void {
},
});
defer ret.deinit();
if (r.setContentType(.TEXT)) {
if (ret.str()) |s| {
r.sendBody(s) catch return;

161
src/mustache.zig
View file

@ -1,44 +1,47 @@
// supporting code to make using facilio's mustache stuff
// (see http://facil.io/0.7.x/fiobj_mustache)
// easier / possible / more zig-like
const std = @import("std");
const fio = @import("fio.zig");
const util = @import("util.zig");
pub const struct_mustache_s = opaque {};
pub const enum_mustache_error_en = c_uint;
pub const mustache_error_en = enum_mustache_error_en;
/// A struct to handle Mustache templating.
///
/// This is a wrapper around fiobj's mustache template handling.
/// See http://facil.io/0.7.x/fiobj_mustache for more information.
pub const Mustache = struct {
const Self = @This();
pub const mustache_s = struct_mustache_s;
pub extern fn fiobj_mustache_new(args: MustacheLoadArgsFio) ?*mustache_s;
pub extern fn fiobj_mustache_build(mustache: ?*mustache_s, data: fio.FIOBJ) fio.FIOBJ;
pub extern fn fiobj_mustache_build2(dest: fio.FIOBJ, mustache: ?*mustache_s, data: fio.FIOBJ) fio.FIOBJ;
pub extern fn fiobj_mustache_free(mustache: ?*mustache_s) void;
pub const struct_mustache_s = opaque {};
pub const enum_mustache_error_en = c_uint;
pub const mustache_error_en = enum_mustache_error_en;
/// Mustache load args used in mustacheNew
pub const MustacheLoadArgs = struct {
/// optional filename, enables partial templates on filesystem
pub const mustache_s = struct_mustache_s;
pub extern fn fiobj_mustache_new(args: MustacheLoadArgsFio) ?*mustache_s;
pub extern fn fiobj_mustache_build(mustache: ?*mustache_s, data: fio.FIOBJ) fio.FIOBJ;
pub extern fn fiobj_mustache_build2(dest: fio.FIOBJ, mustache: ?*mustache_s, data: fio.FIOBJ) fio.FIOBJ;
pub extern fn fiobj_mustache_free(mustache: ?*mustache_s) void;
/// Load arguments used when creating a new Mustache instance.
/// One source of data must be passed in, otherwise an error will occur.
pub const MustacheLoadArgs = struct {
/// Filename. This enables partial templates on filesystem.
filename: ?[]const u8 = null,
/// optional string data. should be used if no filename is specified.
/// String data. Should be used if no filename is specified.
data: ?[]const u8 = null,
};
};
// used internally for interfacing with fio
const MustacheLoadArgsFio = extern struct {
/// Internal struct used for interfacing with fio.
const MustacheLoadArgsFio = extern struct {
filename: [*c]const u8,
filename_len: usize,
data: [*c]const u8,
data_len: usize,
err: [*c]mustache_error_en,
};
};
pub const Mustache = mustache_s;
handler: *mustache_s,
pub const MustacheStatus = enum(c_int) {};
pub const MustacheError = error{
pub const Status = enum(c_int) {};
pub const Error = error{
MUSTACHE_ERR_TOO_DEEP,
MUSTACHE_ERR_CLOSURE_MISMATCH,
MUSTACHE_ERR_FILE_NOT_FOUND,
@ -50,14 +53,14 @@ pub const MustacheError = error{
MUSTACHE_ERR_NAME_TOO_LONG,
MUSTACHE_ERR_UNKNOWN,
MUSTACHE_ERR_USER_ERROR,
};
};
// pub extern fn fiobj_mustache_build2(dest: FIOBJ, mustache: ?*mustache_s, data: FIOBJ) FIOBJ;
pub fn mustacheNew(load_args: MustacheLoadArgs) MustacheError!*Mustache {
/// Create a new `Mustache` instance; `deinit()` should be called to free
/// the object after usage.
pub fn init(load_args: MustacheLoadArgs) Error!Self {
var err: mustache_error_en = undefined;
var args: MustacheLoadArgsFio = .{
const args: MustacheLoadArgsFio = .{
.filename = filn: {
if (load_args.filename) |filn| break :filn filn.ptr else break :filn null;
},
@ -73,58 +76,73 @@ pub fn mustacheNew(load_args: MustacheLoadArgs) MustacheError!*Mustache {
.err = &err,
};
var ret = fiobj_mustache_new(args);
const ret = fiobj_mustache_new(args);
switch (err) {
0 => return ret.?,
1 => return MustacheError.MUSTACHE_ERR_TOO_DEEP,
2 => return MustacheError.MUSTACHE_ERR_CLOSURE_MISMATCH,
3 => return MustacheError.MUSTACHE_ERR_FILE_NOT_FOUND,
4 => return MustacheError.MUSTACHE_ERR_FILE_TOO_BIG,
5 => return MustacheError.MUSTACHE_ERR_FILE_NAME_TOO_LONG,
6 => return MustacheError.MUSTACHE_ERR_FILE_NAME_TOO_SHORT,
7 => return MustacheError.MUSTACHE_ERR_EMPTY_TEMPLATE,
8 => return MustacheError.MUSTACHE_ERR_DELIMITER_TOO_LONG,
9 => return MustacheError.MUSTACHE_ERR_NAME_TOO_LONG,
10 => return MustacheError.MUSTACHE_ERR_UNKNOWN,
11 => return MustacheError.MUSTACHE_ERR_USER_ERROR,
else => return MustacheError.MUSTACHE_ERR_UNKNOWN,
0 => return Self{
.handler = ret.?,
},
1 => return Error.MUSTACHE_ERR_TOO_DEEP,
2 => return Error.MUSTACHE_ERR_CLOSURE_MISMATCH,
3 => return Error.MUSTACHE_ERR_FILE_NOT_FOUND,
4 => return Error.MUSTACHE_ERR_FILE_TOO_BIG,
5 => return Error.MUSTACHE_ERR_FILE_NAME_TOO_LONG,
6 => return Error.MUSTACHE_ERR_FILE_NAME_TOO_SHORT,
7 => return Error.MUSTACHE_ERR_EMPTY_TEMPLATE,
8 => return Error.MUSTACHE_ERR_DELIMITER_TOO_LONG,
9 => return Error.MUSTACHE_ERR_NAME_TOO_LONG,
10 => return Error.MUSTACHE_ERR_UNKNOWN,
11 => return Error.MUSTACHE_ERR_USER_ERROR,
else => return Error.MUSTACHE_ERR_UNKNOWN,
}
return Error.MUSTACHE_ERR_UNKNOWN;
}
return MustacheError.MUSTACHE_ERR_UNKNOWN;
}
/// Convenience function if you only want to use in-memory data (as opposed to file data)
pub fn mustacheData(data: []const u8) MustacheError!*Mustache {
return mustacheNew(.{ .data = data });
}
/// Convenience function to create a new `Mustache` instance with in-memory data loaded;
/// `deinit()` should be called to free the object after usage..
pub fn fromData(data: []const u8) Error!Mustache {
return Self.init(.{ .data = data });
}
/// Convenience function if you only want to use file-based data (as opposed to in-memory data)
pub fn mustacheLoad(filename: []const u8) MustacheError!*Mustache {
return mustacheNew(.{ .filename = filename });
}
/// Convenience function to create a new `Mustache` instance with file-based data loaded;
/// `deinit()` should be called to free the object after usage..
pub fn fromFile(filename: []const u8) Error!Mustache {
return Self.init(.{ .filename = filename });
}
// implement these: fiobj_mustache.c
// pub extern fn fiobj_mustache_build(mustache: ?*mustache_s, data: FIOBJ) FIOBJ;
// pub extern fn fiobj_mustache_build2(dest: FIOBJ, mustache: ?*mustache_s, data: FIOBJ) FIOBJ;
/// Free the data backing a `Mustache` instance.
pub fn deinit(self: *Self) void {
fiobj_mustache_free(self.handler);
}
const MustacheBuildResult = struct {
// TODO: implement these - fiobj_mustache.c
// pub extern fn fiobj_mustache_build(mustache: ?*mustache_s, data: FIOBJ) FIOBJ;
// pub extern fn fiobj_mustache_build2(dest: FIOBJ, mustache: ?*mustache_s, data: FIOBJ) FIOBJ;
/// The result from calling `build`.
const MustacheBuildResult = struct {
fiobj_result: fio.FIOBJ = 0,
/// holds the context converted into a fiobj, used in build
/// Holds the context converted into a fiobj.
/// This is used in `build`.
fiobj_context: fio.FIOBJ = 0,
/// Free the data backing a `MustacheBuildResult` instance.
pub fn deinit(m: *const MustacheBuildResult) void {
fio.fiobj_free_wrapped(m.fiobj_result);
fio.fiobj_free_wrapped(m.fiobj_context);
}
/// Retrieve a string representation of the built template.
pub fn str(m: *const MustacheBuildResult) ?[]const u8 {
return util.fio2str(m.fiobj_result);
}
};
};
// this build is slow because it needs to translate to a FIOBJ data
// object FIOBJ_T_HASH
pub fn mustacheBuild(mustache: *Mustache, data: anytype) MustacheBuildResult {
/// Build the Mustache template; `deinit()` should be called on the build
/// result to free the data.
/// TODO: This build is slow because it needs to translate to a FIOBJ data
/// object - FIOBJ_T_HASH
pub fn build(self: *Self, data: anytype) MustacheBuildResult {
const T = @TypeOf(data);
if (@typeInfo(T) != .Struct) {
@compileError("No struct: '" ++ @typeName(T) ++ "'");
@ -133,13 +151,13 @@ pub fn mustacheBuild(mustache: *Mustache, data: anytype) MustacheBuildResult {
var result: MustacheBuildResult = .{};
result.fiobj_context = fiobjectify(data);
result.fiobj_result = fiobj_mustache_build(mustache, result.fiobj_context);
result.fiobj_result = fiobj_mustache_build(self.handler, result.fiobj_context);
return result;
}
}
pub fn fiobjectify(
pub fn fiobjectify(
value: anytype,
) fio.FIOBJ {
) fio.FIOBJ {
const T = @TypeOf(value);
switch (@typeInfo(T)) {
.Float, .ComptimeFloat => {
@ -178,7 +196,7 @@ pub fn fiobjectify(
},
.Struct => |S| {
// create a new fio hashmap
var m = fio.fiobj_hash_new();
const m = fio.fiobj_hash_new();
// std.debug.print("new struct\n", .{});
inline for (S.fields) |Field| {
// don't include void fields
@ -215,7 +233,7 @@ pub fn fiobjectify(
return fio.fiobj_str_new(util.toCharPtr(value), value.len);
}
var arr = fio.fiobj_ary_new2(value.len);
const arr = fio.fiobj_ary_new2(value.len);
for (value) |x| {
const v = fiobjectify(x);
fio.fiobj_ary_push(arr, v);
@ -232,8 +250,5 @@ pub fn fiobjectify(
else => @compileError("Unable to fiobjectify type '" ++ @typeName(T) ++ "'"),
}
unreachable;
}
pub fn mustacheFree(m: ?*Mustache) void {
fiobj_mustache_free(m);
}
}
};