diff --git a/lib/std/comptime_string_map.zig b/lib/std/comptime_string_map.zig new file mode 100644 index 0000000000..b1e5513a3b --- /dev/null +++ b/lib/std/comptime_string_map.zig @@ -0,0 +1,134 @@ +const std = @import("std.zig"); +const mem = std.mem; + +/// Like ComptimeStringHashMap but optimized for small sets of disparate string keys. +/// Works by separating the keys by length at comptime and only checking strings of +/// equal length at runtime. +/// +/// `kvs` expects a list literal containing list literals or an array/slice of structs +/// where `.@"0"` is the `[]const u8` key and `.@"1"` is the associated value of type `V`. +/// TODO: https://github.com/ziglang/zig/issues/4335 +pub fn ComptimeStringMap(comptime V: type, comptime kvs: var) type { + const precomputed = comptime blk: { + @setEvalBranchQuota(2000); + const KV = struct { + key: []const u8, + value: V, + }; + var sorted_kvs: [kvs.len]KV = undefined; + const lenAsc = (struct { + fn lenAsc(a: KV, b: KV) bool { + return a.key.len < b.key.len; + } + }).lenAsc; + for (kvs) |kv, i| { + sorted_kvs[i] = .{.key = kv.@"0", .value = kv.@"1"}; + } + std.sort.sort(KV, &sorted_kvs, lenAsc); + const min_len = sorted_kvs[0].key.len; + const max_len = sorted_kvs[sorted_kvs.len - 1].key.len; + var len_indexes: [max_len + 1]usize = undefined; + var len: usize = 0; + var i: usize = 0; + while (len <= max_len) : (len += 1) { + // find the first keyword len == len + while (len > sorted_kvs[i].key.len) { + i += 1; + } + len_indexes[len] = i; + } + break :blk .{ + .min_len = min_len, + .max_len = max_len, + .sorted_kvs = sorted_kvs, + .len_indexes = len_indexes, + }; + }; + + return struct { + pub fn has(str: []const u8) bool { + return get(str) != null; + } + + pub fn get(str: []const u8) ?V { + if (str.len < precomputed.min_len or str.len > precomputed.max_len) + return null; + + var i = precomputed.len_indexes[str.len]; + while (true) { + const kv = precomputed.sorted_kvs[i]; + if (kv.key.len != str.len) + return null; + if (mem.eql(u8, kv.key, str)) + return kv.value; + i += 1; + if (i >= precomputed.sorted_kvs.len) + return null; + } + } + }; +} + +const TestEnum = enum { + A, + B, + C, + D, + E, +}; + +test "ComptimeStringMap list literal of list literals" { + const map = ComptimeStringMap(TestEnum, .{ + .{"these", .D}, + .{"have", .A}, + .{"nothing", .B}, + .{"incommon", .C}, + .{"samelen", .E}, + }); + + testMap(map); +} + +test "ComptimeStringMap array of structs" { + const KV = struct { + @"0": []const u8, + @"1": TestEnum, + }; + const map = ComptimeStringMap(TestEnum, [_]KV{ + .{.@"0" = "these", .@"1" = .D}, + .{.@"0" = "have", .@"1" = .A}, + .{.@"0" = "nothing", .@"1" = .B}, + .{.@"0" = "incommon", .@"1" = .C}, + .{.@"0" = "samelen", .@"1" = .E}, + }); + + testMap(map); +} + +test "ComptimeStringMap slice of structs" { + const KV = struct { + @"0": []const u8, + @"1": TestEnum, + }; + const slice: []const KV = &[_]KV{ + .{.@"0" = "these", .@"1" = .D}, + .{.@"0" = "have", .@"1" = .A}, + .{.@"0" = "nothing", .@"1" = .B}, + .{.@"0" = "incommon", .@"1" = .C}, + .{.@"0" = "samelen", .@"1" = .E}, + }; + const map = ComptimeStringMap(TestEnum, slice); + + testMap(map); +} + +fn testMap(comptime map: var) void { + std.testing.expectEqual(TestEnum.A, map.get("have").?); + std.testing.expectEqual(TestEnum.B, map.get("nothing").?); + std.testing.expect(null == map.get("missing")); + std.testing.expectEqual(TestEnum.D, map.get("these").?); + std.testing.expectEqual(TestEnum.E, map.get("samelen").?); + + std.testing.expect(!map.has("missing")); + std.testing.expect(map.has("these")); +} diff --git a/lib/std/std.zig b/lib/std/std.zig index 9920ca3378..b1cab77109 100644 --- a/lib/std/std.zig +++ b/lib/std/std.zig @@ -8,6 +8,7 @@ pub const BloomFilter = @import("bloom_filter.zig").BloomFilter; pub const BufMap = @import("buf_map.zig").BufMap; pub const BufSet = @import("buf_set.zig").BufSet; pub const ChildProcess = @import("child_process.zig").ChildProcess; +pub const ComptimeStringMap = @import("comptime_string_map.zig").ComptimeStringMap; pub const DynLib = @import("dynamic_library.zig").DynLib; pub const HashMap = @import("hash_map.zig").HashMap; pub const Mutex = @import("mutex.zig").Mutex;