isomorfeus-iodine 0.7.49 → 0.7.50

data/ext/{iodine → iodine_ext}/fiobj_ary.h

@@ -1,139 +1,139 @@
-#ifndef FIOBJ_ARRAY_H
-/*
-Copyright: Boaz Segev, 2017-2019
-License: MIT
-*/
-
-/**
-A dynamic Array type for the fiobj_s dynamic type system.
-*/
-#define FIOBJ_ARRAY_H
-
-#include <fiobject.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* *****************************************************************************
-Array creation API
-***************************************************************************** */
-
-/** Creates a mutable empty Array object. Use `fiobj_free` when done. */
-FIOBJ fiobj_ary_new(void);
-
-/** Creates a mutable empty Array object with the requested capacity. */
-FIOBJ fiobj_ary_new2(size_t capa);
-
-/* *****************************************************************************
-Array direct entry access API
-***************************************************************************** */
-
-/** Returns the number of elements in the Array. */
-size_t fiobj_ary_count(FIOBJ ary);
-
-/** Returns the current, temporary, array capacity (it's dynamic). */
-size_t fiobj_ary_capa(FIOBJ ary);
-
-/**
- * Returns a TEMPORARY pointer to the beginning of the array.
- *
- * This pointer can be used for sorting and other direct access operations as
- * long as no other actions (insertion/deletion) are performed on the array.
- */
-FIOBJ *fiobj_ary2ptr(FIOBJ ary);
-
-/**
- * Returns a temporary object owned by the Array.
- *
- * Wrap this function call within `fiobj_dup` to get a persistent handle. i.e.:
- *
- *     fiobj_dup(fiobj_ary_index(array, 0));
- *
- * Negative values are retrieved from the end of the array. i.e., `-1`
- * is the last item.
- */
-FIOBJ fiobj_ary_index(FIOBJ ary, int64_t pos);
-/** alias for `fiobj_ary_index` */
-#define fiobj_ary_entry(a, p) fiobj_ary_index((a), (p))
-
-/**
- * Sets an object at the requested position.
- */
-void fiobj_ary_set(FIOBJ ary, FIOBJ obj, int64_t pos);
-
-/* *****************************************************************************
-Array push / shift API
-***************************************************************************** */
-
-/**
- * Pushes an object to the end of the Array.
- */
-void fiobj_ary_push(FIOBJ ary, FIOBJ obj);
-
-/** Pops an object from the end of the Array. */
-FIOBJ fiobj_ary_pop(FIOBJ ary);
-
-/**
- * Unshifts an object to the beginning of the Array. This could be
- * expensive.
- */
-void fiobj_ary_unshift(FIOBJ ary, FIOBJ obj);
-
-/** Shifts an object from the beginning of the Array. */
-FIOBJ fiobj_ary_shift(FIOBJ ary);
-
-/* *****************************************************************************
-Array Find / Remove / Replace
-***************************************************************************** */
-
-/**
- * Replaces the object at a specific position, returning the old object -
- * remember to `fiobj_free` the old object.
- */
-FIOBJ fiobj_ary_replace(FIOBJ ary, FIOBJ obj, int64_t pos);
-
-/**
- * Finds the index of a specifide object (if any). Returns -1 if the object
- * isn't found.
- */
-int64_t fiobj_ary_find(FIOBJ ary, FIOBJ data);
-
-/**
- * Removes the object at the index (if valid), changing the index of any
- * following objects.
- *
- * Returns 0 on success or -1 (if no object or out of bounds).
- */
-int fiobj_ary_remove(FIOBJ ary, int64_t pos);
-
-/**
- * Removes the first instance of an object from the Array (if any), changing the
- * index of any following objects.
- *
- * Returns 0 on success or -1 (if the object wasn't found).
- */
-int fiobj_ary_remove2(FIOBJ ary, FIOBJ data);
-
-/* *****************************************************************************
-Array compacting (untested)
-***************************************************************************** */
-
-/**
- * Removes any NULL *pointers* from an Array, keeping all Objects (including
- * explicit NULL objects) in the array.
- *
- * This action is O(n) where n in the length of the array.
- * It could get expensive.
- */
-void fiobj_ary_compact(FIOBJ ary);
-
-#if DEBUG
-void fiobj_test_array(void);
-#endif
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif
+#ifndef FIOBJ_ARRAY_H
+/*
+Copyright: Boaz Segev, 2017-2019
+License: MIT
+*/
+
+/**
+A dynamic Array type for the fiobj_s dynamic type system.
+*/
+#define FIOBJ_ARRAY_H
+
+#include <fiobject.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* *****************************************************************************
+Array creation API
+***************************************************************************** */
+
+/** Creates a mutable empty Array object. Use `fiobj_free` when done. */
+FIOBJ fiobj_ary_new(void);
+
+/** Creates a mutable empty Array object with the requested capacity. */
+FIOBJ fiobj_ary_new2(size_t capa);
+
+/* *****************************************************************************
+Array direct entry access API
+***************************************************************************** */
+
+/** Returns the number of elements in the Array. */
+size_t fiobj_ary_count(FIOBJ ary);
+
+/** Returns the current, temporary, array capacity (it's dynamic). */
+size_t fiobj_ary_capa(FIOBJ ary);
+
+/**
+ * Returns a TEMPORARY pointer to the beginning of the array.
+ *
+ * This pointer can be used for sorting and other direct access operations as
+ * long as no other actions (insertion/deletion) are performed on the array.
+ */
+FIOBJ *fiobj_ary2ptr(FIOBJ ary);
+
+/**
+ * Returns a temporary object owned by the Array.
+ *
+ * Wrap this function call within `fiobj_dup` to get a persistent handle. i.e.:
+ *
+ *     fiobj_dup(fiobj_ary_index(array, 0));
+ *
+ * Negative values are retrieved from the end of the array. i.e., `-1`
+ * is the last item.
+ */
+FIOBJ fiobj_ary_index(FIOBJ ary, int64_t pos);
+/** alias for `fiobj_ary_index` */
+#define fiobj_ary_entry(a, p) fiobj_ary_index((a), (p))
+
+/**
+ * Sets an object at the requested position.
+ */
+void fiobj_ary_set(FIOBJ ary, FIOBJ obj, int64_t pos);
+
+/* *****************************************************************************
+Array push / shift API
+***************************************************************************** */
+
+/**
+ * Pushes an object to the end of the Array.
+ */
+void fiobj_ary_push(FIOBJ ary, FIOBJ obj);
+
+/** Pops an object from the end of the Array. */
+FIOBJ fiobj_ary_pop(FIOBJ ary);
+
+/**
+ * Unshifts an object to the beginning of the Array. This could be
+ * expensive.
+ */
+void fiobj_ary_unshift(FIOBJ ary, FIOBJ obj);
+
+/** Shifts an object from the beginning of the Array. */
+FIOBJ fiobj_ary_shift(FIOBJ ary);
+
+/* *****************************************************************************
+Array Find / Remove / Replace
+***************************************************************************** */
+
+/**
+ * Replaces the object at a specific position, returning the old object -
+ * remember to `fiobj_free` the old object.
+ */
+FIOBJ fiobj_ary_replace(FIOBJ ary, FIOBJ obj, int64_t pos);
+
+/**
+ * Finds the index of a specifide object (if any). Returns -1 if the object
+ * isn't found.
+ */
+int64_t fiobj_ary_find(FIOBJ ary, FIOBJ data);
+
+/**
+ * Removes the object at the index (if valid), changing the index of any
+ * following objects.
+ *
+ * Returns 0 on success or -1 (if no object or out of bounds).
+ */
+int fiobj_ary_remove(FIOBJ ary, int64_t pos);
+
+/**
+ * Removes the first instance of an object from the Array (if any), changing the
+ * index of any following objects.
+ *
+ * Returns 0 on success or -1 (if the object wasn't found).
+ */
+int fiobj_ary_remove2(FIOBJ ary, FIOBJ data);
+
+/* *****************************************************************************
+Array compacting (untested)
+***************************************************************************** */
+
+/**
+ * Removes any NULL *pointers* from an Array, keeping all Objects (including
+ * explicit NULL objects) in the array.
+ *
+ * This action is O(n) where n in the length of the array.
+ * It could get expensive.
+ */
+void fiobj_ary_compact(FIOBJ ary);
+
+#if DEBUG
+void fiobj_test_array(void);
+#endif
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif

data/ext/{iodine → iodine_ext}/fiobj_hash.h

@@ -1,176 +1,176 @@
-/*
-Copyright: Boaz Segev, 2017-2019
-License: MIT
-*/
-#ifndef H_FIOBJ_HASH_H
-/**
- * The facil.io Hash object is an ordered Hash Table implementation.
- *
- * By compromising some of the HashMap's collision resistance (comparing only
- * the Hash values rather than comparing key data), memory comparison can be
- * avoided and performance increased.
- *
- * By being ordered it's possible to iterate over key-value pairs in the order
- * in which they were added to the Hash table, making it possible to output JSON
- * in a controlled manner.
- */
-#define H_FIOBJ_HASH_H
-
-#include <fiobject.h>
-
-#include <fio_siphash.h>
-#include <fiobj_str.h>
-
-#include <errno.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* MUST be a power of 2 */
-#define HASH_INITIAL_CAPACITY 16
-
-/** attempts to rehash the hashmap. */
-void fiobj_hash_rehash(FIOBJ h);
-
-/* *****************************************************************************
-Hash Creation
-***************************************************************************** */
-
-/**
- * Creates a mutable empty Hash object. Use `fiobj_free` when done.
- *
- * Notice that these Hash objects are optimized for smaller collections and
- * retain order of object insertion.
- */
-FIOBJ fiobj_hash_new(void);
-
-/**
- * Creates a mutable empty Hash object with an initial capacity of `capa`. Use
- * `fiobj_free` when done.
- *
- * This allows optimizations for larger (or smaller) collections.
- */
-FIOBJ fiobj_hash_new2(size_t capa);
-
-/* *****************************************************************************
-Hash properties and state
-***************************************************************************** */
-
-/**
- * Returns a temporary theoretical Hash map capacity.
- * This could be used for testing performance and memory consumption.
- */
-size_t fiobj_hash_capa(const FIOBJ hash);
-
-/** Returns the number of elements in the Hash. */
-size_t fiobj_hash_count(const FIOBJ hash);
-
-/** Returns the key for the object in the current `fiobj_each` loop (if any). */
-FIOBJ fiobj_hash_key_in_loop(void);
-
-/* *****************************************************************************
-Populating the Hash
-***************************************************************************** */
-
-/**
- * Sets a key-value pair in the Hash, duplicating the Symbol and **moving**
- * the ownership of the object to the Hash.
- *
- * Returns -1 on error.
- */
-int fiobj_hash_set(FIOBJ hash, FIOBJ key, FIOBJ obj);
-
-/**
- * Allows the Hash to be used as a stack.
- *
- * If a pointer `key` is provided, it will receive ownership of the key
- * (remember to free).
- *
- * Returns FIOBJ_INVALID on error.
- *
- * Returns and object if successful (remember to free).
- */
-FIOBJ fiobj_hash_pop(FIOBJ hash, FIOBJ *key);
-
-/**
- * Replaces the value in a key-value pair, returning the old value (and it's
- * ownership) to the caller.
- *
- * A return value of FIOBJ_INVALID indicates that no previous object existed
- * (but a new key-value pair was created.
- *
- * Errors are silently ignored.
- *
- * Remember to free the returned object.
- */
-FIOBJ fiobj_hash_replace(FIOBJ hash, FIOBJ key, FIOBJ obj);
-
-/**
- * Removes a key-value pair from the Hash, if it exists, returning the old
- * object (instead of freeing it).
- */
-FIOBJ fiobj_hash_remove(FIOBJ hash, FIOBJ key);
-
-/**
- * Removes a key-value pair from the Hash, if it exists, returning the old
- * object (instead of freeing it).
- */
-FIOBJ fiobj_hash_remove2(FIOBJ hash, uint64_t key_hash);
-
-/**
- * Deletes a key-value pair from the Hash, if it exists, freeing the
- * associated object.
- *
- * Returns -1 on type error or if the object never existed.
- */
-int fiobj_hash_delete(FIOBJ hash, FIOBJ key);
-
-/**
- * Deletes a key-value pair from the Hash, if it exists, freeing the
- * associated object.
- *
- * This function takes a `uint64_t` Hash value (see `fio_siphash`) to
- * perform a lookup in the HashMap, which is slightly faster than the other
- * variations.
- *
- * Returns -1 on type error or if the object never existed.
- */
-int fiobj_hash_delete2(FIOBJ hash, uint64_t key_hash);
-
-/**
- * Returns a temporary handle to the object associated with the Symbol,
- * FIOBJ_INVALID if none.
- */
-FIOBJ fiobj_hash_get(const FIOBJ hash, FIOBJ key);
-
-/**
- * Returns a temporary handle to the object associated hashed key value.
- *
- * This function takes a `uint64_t` Hash value (see `fio_siphash`) to
- * perform a lookup in the HashMap, which is slightly faster than the other
- * variations.
- *
- * Returns FIOBJ_INVALID if no object is associated with this hashed key value.
- */
-FIOBJ fiobj_hash_get2(const FIOBJ hash, uint64_t key_hash);
-
-/**
- * Returns 1 if the key (Symbol) exists in the Hash, even if it's value is NULL.
- */
-int fiobj_hash_haskey(const FIOBJ hash, FIOBJ key);
-
-/**
- * Empties the Hash.
- */
-void fiobj_hash_clear(const FIOBJ hash);
-
-#if DEBUG
-void fiobj_test_hash(void);
-#endif
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif
+/*
+Copyright: Boaz Segev, 2017-2019
+License: MIT
+*/
+#ifndef H_FIOBJ_HASH_H
+/**
+ * The facil.io Hash object is an ordered Hash Table implementation.
+ *
+ * By compromising some of the HashMap's collision resistance (comparing only
+ * the Hash values rather than comparing key data), memory comparison can be
+ * avoided and performance increased.
+ *
+ * By being ordered it's possible to iterate over key-value pairs in the order
+ * in which they were added to the Hash table, making it possible to output JSON
+ * in a controlled manner.
+ */
+#define H_FIOBJ_HASH_H
+
+#include <fiobject.h>
+
+#include <fio_siphash.h>
+#include <fiobj_str.h>
+
+#include <errno.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* MUST be a power of 2 */
+#define HASH_INITIAL_CAPACITY 16
+
+/** attempts to rehash the hashmap. */
+void fiobj_hash_rehash(FIOBJ h);
+
+/* *****************************************************************************
+Hash Creation
+***************************************************************************** */
+
+/**
+ * Creates a mutable empty Hash object. Use `fiobj_free` when done.
+ *
+ * Notice that these Hash objects are optimized for smaller collections and
+ * retain order of object insertion.
+ */
+FIOBJ fiobj_hash_new(void);
+
+/**
+ * Creates a mutable empty Hash object with an initial capacity of `capa`. Use
+ * `fiobj_free` when done.
+ *
+ * This allows optimizations for larger (or smaller) collections.
+ */
+FIOBJ fiobj_hash_new2(size_t capa);
+
+/* *****************************************************************************
+Hash properties and state
+***************************************************************************** */
+
+/**
+ * Returns a temporary theoretical Hash map capacity.
+ * This could be used for testing performance and memory consumption.
+ */
+size_t fiobj_hash_capa(const FIOBJ hash);
+
+/** Returns the number of elements in the Hash. */
+size_t fiobj_hash_count(const FIOBJ hash);
+
+/** Returns the key for the object in the current `fiobj_each` loop (if any). */
+FIOBJ fiobj_hash_key_in_loop(void);
+
+/* *****************************************************************************
+Populating the Hash
+***************************************************************************** */
+
+/**
+ * Sets a key-value pair in the Hash, duplicating the Symbol and **moving**
+ * the ownership of the object to the Hash.
+ *
+ * Returns -1 on error.
+ */
+int fiobj_hash_set(FIOBJ hash, FIOBJ key, FIOBJ obj);
+
+/**
+ * Allows the Hash to be used as a stack.
+ *
+ * If a pointer `key` is provided, it will receive ownership of the key
+ * (remember to free).
+ *
+ * Returns FIOBJ_INVALID on error.
+ *
+ * Returns and object if successful (remember to free).
+ */
+FIOBJ fiobj_hash_pop(FIOBJ hash, FIOBJ *key);
+
+/**
+ * Replaces the value in a key-value pair, returning the old value (and it's
+ * ownership) to the caller.
+ *
+ * A return value of FIOBJ_INVALID indicates that no previous object existed
+ * (but a new key-value pair was created.
+ *
+ * Errors are silently ignored.
+ *
+ * Remember to free the returned object.
+ */
+FIOBJ fiobj_hash_replace(FIOBJ hash, FIOBJ key, FIOBJ obj);
+
+/**
+ * Removes a key-value pair from the Hash, if it exists, returning the old
+ * object (instead of freeing it).
+ */
+FIOBJ fiobj_hash_remove(FIOBJ hash, FIOBJ key);
+
+/**
+ * Removes a key-value pair from the Hash, if it exists, returning the old
+ * object (instead of freeing it).
+ */
+FIOBJ fiobj_hash_remove2(FIOBJ hash, uint64_t key_hash);
+
+/**
+ * Deletes a key-value pair from the Hash, if it exists, freeing the
+ * associated object.
+ *
+ * Returns -1 on type error or if the object never existed.
+ */
+int fiobj_hash_delete(FIOBJ hash, FIOBJ key);
+
+/**
+ * Deletes a key-value pair from the Hash, if it exists, freeing the
+ * associated object.
+ *
+ * This function takes a `uint64_t` Hash value (see `fio_siphash`) to
+ * perform a lookup in the HashMap, which is slightly faster than the other
+ * variations.
+ *
+ * Returns -1 on type error or if the object never existed.
+ */
+int fiobj_hash_delete2(FIOBJ hash, uint64_t key_hash);
+
+/**
+ * Returns a temporary handle to the object associated with the Symbol,
+ * FIOBJ_INVALID if none.
+ */
+FIOBJ fiobj_hash_get(const FIOBJ hash, FIOBJ key);
+
+/**
+ * Returns a temporary handle to the object associated hashed key value.
+ *
+ * This function takes a `uint64_t` Hash value (see `fio_siphash`) to
+ * perform a lookup in the HashMap, which is slightly faster than the other
+ * variations.
+ *
+ * Returns FIOBJ_INVALID if no object is associated with this hashed key value.
+ */
+FIOBJ fiobj_hash_get2(const FIOBJ hash, uint64_t key_hash);
+
+/**
+ * Returns 1 if the key (Symbol) exists in the Hash, even if it's value is NULL.
+ */
+int fiobj_hash_haskey(const FIOBJ hash, FIOBJ key);
+
+/**
+ * Empties the Hash.
+ */
+void fiobj_hash_clear(const FIOBJ hash);
+
+#if DEBUG
+void fiobj_test_hash(void);
+#endif
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif