Small tweaks for Zig 0.14.0, updating docs, updating copyright

Author: deckarep

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Ralph Caraveo
+Copyright (c) 2025 Ralph Caraveo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -3,7 +3,7 @@
 ![License](https://img.shields.io/github/license/deckarep/ziglang-set) ![Issue](https://img.shields.io/github/issues-raw/deckarep/ziglang-set?style=flat) ![Commit](https://img.shields.io/github/last-commit/deckarep/ziglang-set) ![CI](https://github.com/deckarep/ziglang-set/workflows/CI/badge.svg)
 
 <p align="center">
-Ziglang-Set: a generic and general-purpose Set implementation for Zig. <br/> 🚧 PRE-ALPHA 🚧
+Ziglang-Set: a generic and general-purpose Set implementation for Zig. <br/> 🚧 BETA 🚧
 </p>
 
 #
@@ -21,21 +21,22 @@ Ziglang-Set: a generic and general-purpose Set implementation for Zig. <br/> 
 
 Zig currently [does not have](https://github.com/ziglang/zig/issues/6919) a built-in, general purpose Set data structure at this point in time. Until it does, try this!
 
-Rationale: It may be common knowledge that a dictionary or map or hashset can be used as a set where the value is basically void. While this is true, there's a lot to think about in terms of supporting all the common set operations in a performant and correct way and there's no good reason why a common module for this can't exist. After studying the Zig stdlib, I'm hoping this implementation can fill that gap and provide some value.
+Rationale: It may be common knowledge that a dictionary, map or hashset can be used as a set with a value of `void`. While this is true, there's a lot to think about in terms of supporting all the common set operations in a performant and correct way and there's no good reason why a common module for this shouldn't exist. After studying the Zig stdlib, I'm hoping this implementation can fill that gap and provide some value.
 
 #
 
 This module offers a Set implementation built in the same vein and spirit of the other data structures within the Zig standard library. This is my attempt to model one that can get better over time and grow with community interest and support. See a problem, file a bug! Or better yet contribute and let's build the best implementation together.
 
-I am the original author of the popular Go based set package: [golang-set](https://github.com/deckarep/golang-set) that is used by software components built by Docker, 1Password, Ethereum, SendGrid, CrowdStrike and HashiCorp. At just shy of `4k stars`, I figured I'd take a crack at building a comprehensive and generic Zig-based set that goes above and beyond the original Go implementation. After using Zig for over 2.5 years on personal projects, I thought it was time that Zig had a robust Set implementation for itself.
+I am the original author of the popular Go based set package: [golang-set](https://github.com/deckarep/golang-set) that is used by software components built by Docker, 1Password, Ethereum, SendGrid, CrowdStrike and HashiCorp. At just shy of `4.5k stars`, I figured I'd take a crack at building a comprehensive and generic Zig-based set that goes above and beyond the original Go implementation. After using Zig for over 3+ years on personal projects, I thought it was time that Zig had a robust Set implementation for itself.
 
 This implementation gives credit and acknowledgement to the [Zig language](https://ziglang.org) and powerful [Std Library](https://ziglang.org/documentation/master/std/#std) [HashMap](https://ziglang.org/documentation/master/std/#std.hash_map.HashMap) data structure of which this set implementation is built on top of. Without that, this probably wouldn't exist. Efforts will be made to keep the Ziglang Set code fast and straightforward but this Set's raw speed will largely be bounded by the performance of the Zig HashMap of which it is built on top of.
 
 #
 
 #### Features
-  * Offers idiomatic, generic-based Zig API - allocators, iterators, capacity hints, clearing, resizing, etc.
+  * Offers idiomatic, generic-based Zig API - allocator support, iterators, capacity hints, clearing, resizing, etc.
   * A few flavors to choose from
+    * NOTE: Future versions of Zig will be deprecating the `managed` variants, and this repo will be following suit.
     * Hash-based: everyday usecase, optimized for lookups primarily, insertion/removal secondarily - [further reading](https://devlog.hexops.com/2022/zig-hashmaps-explained/)
       * HashSetManaged - initializes with an allocator and holds it internally (built on top of unmanaged)
       * HashSetUnmanaged - does not hold an allocator, smaller footprint
@@ -57,11 +58,11 @@ This implementation gives credit and acknowledgement to the [Zig language](https
     * isProperSubset
     * isProperSuperset
     * pop
-  * Fully documented and robustly tested - in progress
+  * Fully documented and robustly tested
   * Performance aware to minimize unecessary allocs/iteration internally
   * Custom hash function support
-  * "string" support - coming soon
-  * Benchmarks - coming soon
+  * "string" support
+  * Benchmarks
 #
 #### Why use a set?
   * A set offers a fast way to manipulate data and avoid excessive looping. Look into it as there is already tons of literature on the advantages of having a set in your arsenal of tools.
@@ -213,3 +214,13 @@ Check the tests for more comprehensive examples on how to use this package.
 ```sh
 zig build test
 ```
+
+#### Docs Generation
+
+```sh
+# With Zig installed:
+zig build-lib -femit-docs src/root.zig
+
+# Alternatively, using Zigup:
+zigup run {zig-version} build-lib -femit-docs src/root.zig
+```

build.zig.zon

@@ -1,7 +1,8 @@
 .{
-    .name = "ziglangSet",
+    .name = .ziglangSet,
     .version = "0.0.1",
-    .minimum_zig_version = "0.12.0",
+    .fingerprint = 0x65aa5acd2ef4855,
+    .minimum_zig_version = "0.14.0",
 
     .dependencies = .{},
 

docs/index.html

@@ -2,9 +2,13 @@
 <html>
   <head>
     <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Zig Documentation</title>
     <link rel="icon" href="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxNTMgMTQwIj48ZyBmaWxsPSIjRjdBNDFEIj48Zz48cG9seWdvbiBwb2ludHM9IjQ2LDIyIDI4LDQ0IDE5LDMwIi8+PHBvbHlnb24gcG9pbnRzPSI0NiwyMiAzMywzMyAyOCw0NCAyMiw0NCAyMiw5NSAzMSw5NSAyMCwxMDAgMTIsMTE3IDAsMTE3IDAsMjIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMzEsOTUgMTIsMTE3IDQsMTA2Ii8+PC9nPjxnPjxwb2x5Z29uIHBvaW50cz0iNTYsMjIgNjIsMzYgMzcsNDQiLz48cG9seWdvbiBwb2ludHM9IjU2LDIyIDExMSwyMiAxMTEsNDQgMzcsNDQgNTYsMzIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTE2LDk1IDk3LDExNyA5MCwxMDQiLz48cG9seWdvbiBwb2ludHM9IjExNiw5NSAxMDAsMTA0IDk3LDExNyA0MiwxMTcgNDIsOTUiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTUwLDAgNTIsMTE3IDMsMTQwIDEwMSwyMiIvPjwvZz48Zz48cG9seWdvbiBwb2ludHM9IjE0MSwyMiAxNDAsNDAgMTIyLDQ1Ii8+PHBvbHlnb24gcG9pbnRzPSIxNTMsMjIgMTUzLDExNyAxMDYsMTE3IDEyMCwxMDUgMTI1LDk1IDEzMSw5NSAxMzEsNDUgMTIyLDQ1IDEzMiwzNiAxNDEsMjIiIHNoYXBlLXJlbmRlcmluZz0iY3Jpc3BFZGdlcyIvPjxwb2x5Z29uIHBvaW50cz0iMTI1LDk1IDEzMCwxMTAgMTA2LDExNyIvPjwvZz48L2c+PC9zdmc+">
     <style type="text/css">
+      *, *::before, *::after {
+        box-sizing: border-box;
+      }
       body {
         font-family: system-ui, -apple-system, Roboto, "Segoe UI", sans-serif;
         color: #000000;
@@ -26,6 +30,9 @@
         margin: 0;
         overflow-x: auto;
       }
+      :not(pre) > code {
+        white-space: break-spaces;
+      }
       code {
         font-family:"Source Code Pro",monospace;
         font-size: 0.9em;
@@ -153,6 +160,23 @@
         cursor: default;
       }
 
+      #errors {
+        background-color: #faa;
+        position: fixed;
+        left: 0;
+        bottom: 0;
+        width: 100%;
+        max-height: min(20em, 50vh);
+        padding: 0.5em;
+        overflow: auto;
+      }
+      #errors h1 {
+        font-size: 1.5em;
+      }
+      #errors pre {
+        background-color: #fcc;
+      }
+
       #listSearchResults li.selected {
         background-color: #93e196;
       }
@@ -167,7 +191,8 @@
           margin-top: 0.5em;
       }
 
-      td {
+      td, th {
+        text-align: unset;
         vertical-align: top;
         margin: 0;
         padding: 0.5em;
@@ -247,6 +272,14 @@
         #listSearchResults li.selected a {
           color: #fff;
         }
+        #errors {
+          background-color: #800;
+          color: #fff;
+        }
+        #errors pre {
+          background-color: #a00;
+          color: #fff;
+        }
         dl > div {
           border-color: #373737;
         }
@@ -409,6 +442,10 @@ <h1>Keyboard Shortcuts</h1>
       <dl><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd></dl>
       <dl><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd></dl>
     </div>
+    <div id="errors" class="hidden">
+      <h1>Errors</h1>
+      <pre id="errorsText"></pre>
+    </div>
     <script src="main.js"></script>
   </body>
 </html>

docs/main.js

@@ -1,14 +1,20 @@
 (function() {
     const CAT_namespace = 0;
-    const CAT_global_variable = 1;
-    const CAT_function = 2;
-    const CAT_primitive = 3;
-    const CAT_error_set = 4;
-    const CAT_global_const = 5;
-    const CAT_alias = 6;
-    const CAT_type = 7;
-    const CAT_type_type = 8;
-    const CAT_type_function = 9;
+    const CAT_container = 1;
+    const CAT_global_variable = 2;
+    const CAT_function = 3;
+    const CAT_primitive = 4;
+    const CAT_error_set = 5;
+    const CAT_global_const = 6;
+    const CAT_alias = 7;
+    const CAT_type = 8;
+    const CAT_type_type = 9;
+    const CAT_type_function = 10;
+
+    const LOG_err = 0;
+    const LOG_warn = 1;
+    const LOG_info = 2;
+    const LOG_debug = 3;
 
     const domDocTestsCode = document.getElementById("docTestsCode");
     const domFnErrorsAnyError = document.getElementById("fnErrorsAnyError");
@@ -47,6 +53,8 @@
     const domStatus = document.getElementById("status");
     const domTableFnErrors = document.getElementById("tableFnErrors");
     const domTldDocs = document.getElementById("tldDocs");
+    const domErrors = document.getElementById("errors");
+    const domErrorsText = document.getElementById("errorsText");
 
     var searchTimer = null;
 
@@ -83,13 +91,24 @@
 
     WebAssembly.instantiateStreaming(wasm_promise, {
       js: {
-        log: function(ptr, len) {
+        log: function(level, ptr, len) {
           const msg = decodeString(ptr, len);
-          console.log(msg);
-        },
-        panic: function (ptr, len) {
-            const msg = decodeString(ptr, len);
-            throw new Error("panic: " + msg);
+          switch (level) {
+            case LOG_err:
+              console.error(msg);
+              domErrorsText.textContent += msg + "\n";
+              domErrors.classList.remove("hidden");
+              break;
+            case LOG_warn:
+              console.warn(msg);
+              break;
+            case LOG_info:
+              console.info(msg);
+              break;
+            case LOG_debug:
+              console.debug(msg);
+              break;
+          }
         },
       },
     }).then(function(obj) {
@@ -184,6 +203,7 @@
       const category = wasm_exports.categorize_decl(decl_index, 0);
       switch (category) {
         case CAT_namespace:
+        case CAT_container:
           return renderNamespacePage(decl_index);
         case CAT_global_variable:
         case CAT_primitive:
@@ -426,16 +446,12 @@
         while (true) {
           const member_category = wasm_exports.categorize_decl(member, 0);
           switch (member_category) {
-            case CAT_namespace:
-              if (wasm_exports.decl_field_count(member) > 0) {
-                typesList.push({original: original, member: member});
-              } else {
-                namespacesList.push({original: original, member: member});
-              }
-              continue member_loop;
             case CAT_namespace:
               namespacesList.push({original: original, member: member});
               continue member_loop;
+            case CAT_container:
+              typesList.push({original: original, member: member});
+              continue member_loop;
             case CAT_global_variable:
               varsList.push(member);
               continue member_loop;

docs/main.wasm

@@ -1,6 +1,6 @@
 /// Open Source Initiative OSI - The MIT License (MIT):Licensing
 /// The MIT License (MIT)
-/// Copyright (c) 2024 Ralph Caraveo ([email protected])
+/// Copyright (c) 2025 Ralph Caraveo ([email protected])
 /// Permission is hereby granted, free of charge, to any person obtaining a copy of
 /// this software and associated documentation files (the "Software"), to deal in
 /// the Software without restriction, including without limitation the rights to

docs/sources.tar

@@ -1,6 +1,6 @@
 /// Open Source Initiative OSI - The MIT License (MIT):Licensing
 /// The MIT License (MIT)
-/// Copyright (c) 2024 Ralph Caraveo ([email protected])
+/// Copyright (c) 2025 Ralph Caraveo ([email protected])
 /// Permission is hereby granted, free of charge, to any person obtaining a copy of
 /// this software and associated documentation files (the "Software"), to deal in
 /// the Software without restriction, including without limitation the rights to

src/array_hash_set/managed.zig

@@ -1,6 +1,6 @@
 /// Open Source Initiative OSI - The MIT License (MIT):Licensing
 /// The MIT License (MIT)
-/// Copyright (c) 2024 Ralph Caraveo ([email protected])
+/// Copyright (c) 2025 Ralph Caraveo ([email protected])
 /// Permission is hereby granted, free of charge, to any person obtaining a copy of
 /// this software and associated documentation files (the "Software"), to deal in
 /// the Software without restriction, including without limitation the rights to