diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a64beb..cfbcce6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Automatically support HEAD requests for all GET requests * Event loop uses `epoll` instead of `poll` * Configurable multithreading using `epoll` +* LSM + * Binary tree iterators + * Trie iterators + * Store iterators +* LTM - Lander Template Library + * Simple string templates + * Fully streamable template instances +* Lander + * Simple paste pages with syntax highlighting + * Index pages that group elements under the same namespace into an overview * Landerctl * `-c` flag to use custom config file (useful for testing) diff --git a/Makefile b/Makefile index cedc8b8..5d455f5 100644 --- a/Makefile +++ b/Makefile @@ -42,7 +42,11 @@ liblsm: liblnm: $(MAKE) -C lnm -$(BIN): liblsm liblnm $(OBJS) +.PHONY: libltm +libltm: + $(MAKE) -C ltm + +$(BIN): liblsm liblnm libltm $(OBJS) $(CC) -o $@ $(OBJS) $(_LDFLAGS) $(BUILD_DIR)/$(SRC_DIR)/%.c.o: $(SRC_DIR)/%.c @@ -67,7 +71,7 @@ run: $(BIN) valgrind: $(BIN) LANDER_API_KEY=test \ LANDER_DATA_DIR=data \ - valgrind --track-origins=yes '$(BUILD_DIR)/$(BIN_FILENAME)' + valgrind --track-origins=yes --leak-check=full '$(BUILD_DIR)/$(BIN_FILENAME)' .PHONY: test test: $(TARGETS_TEST) diff --git a/config.mk b/config.mk index 39269d8..095d577 100644 --- a/config.mk +++ b/config.mk @@ -7,16 +7,16 @@ SRC_DIR = src TEST_DIR = test THIRDPARTY_DIR = thirdparty -INC_DIRS = include $(THIRDPARTY_DIR)/include lsm/include lnm/include -LIBS = lsm lnm -LIB_DIRS = ./lsm/build ./lnm/build +INC_DIRS = include $(THIRDPARTY_DIR)/include lsm/include lnm/include ltm/include +LIBS = lsm lnm ltm +LIB_DIRS = ./lsm/build ./lnm/build ./ltm/build # -MMD: generate a .d file for every source file. This file can be imported by # make and makes make aware that a header file has been changed, ensuring an # object file is also recompiled if only a header is changed. # -MP: generate a dummy target for every header file (according to the docs it # prevents some errors when removing header files) -CFLAGS ?= -MMD -MP -g +CFLAGS ?= -MMD -MP -g -Wall # When compiling release builds, these flags are better # CLAGS = -O3 diff --git a/include/lander.h b/include/lander.h index ae2f714..7fa3199 100644 --- a/include/lander.h +++ b/include/lander.h @@ -4,16 +4,22 @@ #include "lnm/common.h" #include "lnm/http/loop.h" #include "lsm/store.h" +#include "ltm/template.h" extern const char lander_key_charset[]; typedef struct lander_gctx { const char *data_dir; lsm_store *store; + struct { + ltm_template *paste; + ltm_template *index; + } templates; } lander_gctx; typedef struct lander_ctx { lsm_entry_handle *entry; + ltm_instance *instance; } lander_ctx; typedef enum lander_attr_type : uint8_t { @@ -27,6 +33,7 @@ typedef enum lander_entry_type : uint8_t { lander_entry_type_redirect = 0, lander_entry_type_paste = 1, lander_entry_type_file = 2, + lander_entry_type_index = 3, } lander_entry_type; void *lander_gctx_init(); @@ -37,7 +44,7 @@ void lander_ctx_reset(lander_ctx *ctx); void lander_ctx_free(lander_ctx *ctx); -lnm_http_step_err lander_get_index(lnm_http_conn *conn); +lnm_http_step_err lander_get_root(lnm_http_conn *conn); lnm_http_step_err lander_get_entry(lnm_http_conn *conn); @@ -53,6 +60,8 @@ lnm_http_step_err lander_remove_entry(lnm_http_conn *conn); lnm_http_step_err lander_post_file(lnm_http_conn *conn); +lnm_http_step_err lander_post_index(lnm_http_conn *conn); + /** * Store the requested header as an attribute, if it's present. */ diff --git a/lsm/include/lsm.h b/lsm/include/lsm.h index 0a1639f..8a86f40 100644 --- a/lsm/include/lsm.h +++ b/lsm/include/lsm.h @@ -27,6 +27,7 @@ typedef enum lsm_error { lsm_error_null_value = 4, lsm_error_failed_io = 5, lsm_error_lock_busy = 6, + lsm_error_done = 7, } lsm_error; /*typedef struct lsm_string { */ diff --git a/lsm/include/lsm/bt.h b/lsm/include/lsm/bt.h index 581288f..6d79f4f 100644 --- a/lsm/include/lsm/bt.h +++ b/lsm/include/lsm/bt.h @@ -1,6 +1,8 @@ #ifndef LSM_BT #define LSM_BT +#include + #include "lsm.h" /** @@ -8,6 +10,11 @@ */ typedef struct lsm_bt lsm_bt; +/** + * A node inside an `lsm_bt` binary tree. + */ +typedef struct lsm_bt_node lsm_bt_node; + /** * Initialize a new binary tree * @@ -68,4 +75,33 @@ lsm_error lsm_bt_remove(void **out, lsm_bt *bt, char key); */ lsm_error lsm_bt_replace(void **out, lsm_bt *bt, char key, void *data); +/** + * Struct representing an in-flight iterator over the binary tree + */ +typedef struct lsm_bt_iterator { + lsm_bt_node *next; +} lsm_bt_iterator; + +/** + * Initialize the given iterator for the binary tree. + * + * The iterator is explicitely allowed to be allocated by the user, as these are + * commonly used inside functions where they can simply be stored on the stack. + * + * @param out iterator to initialize + * @param bt binary tree to iterate + */ +void lsm_bt_iter(lsm_bt_iterator *out, const lsm_bt *bt); + +/** + * Advance the iterator to the next element. + * + * @param out where to store pointer to data; ignored if NULL + * @param key_out where to store key; ignored if NULL + * @param iter iterator to advance + * @return true if a new entry was returned, false if the iterator has no more + * entries to return + */ +bool lsm_bt_iter_next(void **out, char *key_out, lsm_bt_iterator *iter); + #endif diff --git a/lsm/include/lsm/store.h b/lsm/include/lsm/store.h index c680c43..c16340b 100644 --- a/lsm/include/lsm/store.h +++ b/lsm/include/lsm/store.h @@ -98,6 +98,11 @@ lsm_error lsm_entry_attr_insert_uint8_t(lsm_entry_handle *handle, uint8_t type, lsm_error lsm_entry_attr_remove(lsm_str **out, lsm_entry_handle *handle, uint8_t type); +/** + * Retrieve a pointer to the entry's key. + */ +void lsm_entry_key(const lsm_str **out, lsm_entry_handle *handle); + /** * A store consisting of LSM entries. * @@ -228,4 +233,40 @@ lsm_error lsm_entry_data_read(uint64_t *out, char *buf, */ uint64_t lsm_entry_data_len(lsm_entry_handle *handle); +/** + * Represents an in-flight iterator over an LSM store. + */ +typedef struct lsm_store_iterator lsm_store_iterator; + +/** + * Initialize an iterator to iterate over all entries with keys starting + * with the given prefix. + * + * @param out pointer to store iterator pointer in + * @param trie trie to iterate + * @param prefix prefix of the keys; a zero-length string means iterating over + * the entire trie; NULL is interpreted as a zero-length string + */ +lsm_error lsm_store_iter(lsm_store_iterator **out, lsm_store *store, + const lsm_str *prefix); + +/** + * Advance the iterator, returning a read handle to the next entry. The caller + * is responsible for closing this handle. + */ +lsm_error lsm_store_iter_next_read(lsm_entry_handle **out, + lsm_store_iterator *iter); + +/** + * Advance the iterator, returning a write handle to the next entry. The caller + * is responsible for closing this handle. + */ +/* lsm_error lsm_store_iter_next_write(lsm_entry_handle **out, + * lsm_store_iterator *iter); */ + +/** + * Free the given iterator. + */ +void lsm_store_iter_free(lsm_store_iterator *iter); + #endif diff --git a/lsm/include/lsm/str.h b/lsm/include/lsm/str.h index b3cf965..147e4ed 100644 --- a/lsm/include/lsm/str.h +++ b/lsm/include/lsm/str.h @@ -178,6 +178,15 @@ lsm_error lsm_str_split(lsm_str *s, lsm_str *s2, uint64_t index); * @param s string to append s2 to * @param s2 string to append to s */ -lsm_error lsm_str_append(lsm_str *s, lsm_str *s2); +lsm_error lsm_str_append(lsm_str *s, const lsm_str *s2); + +/** + * Same as `lsm_str_append`, but it takes a C-style string instead. + * + * @param s string to append c_str to + * @param c_str char buffer to append + * @param len length of c_str + */ +lsm_error lsm_str_append_c(lsm_str *s, const char *c_str, uint64_t len); #endif diff --git a/lsm/include/lsm/trie.h b/lsm/include/lsm/trie.h index 58db0b6..17a9df5 100644 --- a/lsm/include/lsm/trie.h +++ b/lsm/include/lsm/trie.h @@ -1,7 +1,10 @@ #ifndef LSM_TRIE #define LSM_TRIE +#include + #include "lsm.h" +#include "lsm/bt.h" #include "lsm/str.h" /** @@ -9,6 +12,11 @@ */ typedef struct lsm_trie lsm_trie; +/** + * A node inside an `lsm_trie` trie + */ +typedef struct lsm_trie_node lsm_trie_node; + /** * Initialize a new trie. * @@ -57,4 +65,36 @@ lsm_error lsm_trie_remove(void **out, lsm_trie *trie, const lsm_str *key); */ uint64_t lsm_trie_size(const lsm_trie *trie); +/** + * Represents an in-flight iterator over a trie + */ +typedef struct lsm_trie_iterator lsm_trie_iterator; + +/** + * Initialize an iterator to iterate over all entries with keys starting + * with the given prefix. + * + * @param out pointer to store iterator pointer in + * @param trie trie to iterate + * @param prefix prefix of the keys; a zero-length string means iterating over + * the entire trie; NULL is interpreted as a zero-length string + */ +lsm_error lsm_trie_iter(lsm_trie_iterator **out, const lsm_trie *trie, + const lsm_str *prefix); + +/** + * Advance the given iterator. + * + * @param out pointer to store next data pointer in + * @param iter iterator to advance + * @return `lsm_error_ok` if next element has been returned, `lsm_error_done` if + * no more elements are present, or some other error code + */ +lsm_error lsm_trie_iter_next(void **out, lsm_trie_iterator *iter); + +/** + * Free the given iterator. + */ +void lsm_trie_iter_free(lsm_trie_iterator *iter); + #endif diff --git a/lsm/src/_include/lsm/bt_internal.h b/lsm/src/_include/lsm/bt_internal.h index 4b55771..ed353a6 100644 --- a/lsm/src/_include/lsm/bt_internal.h +++ b/lsm/src/_include/lsm/bt_internal.h @@ -9,12 +9,13 @@ /** * Node inside a binary tree */ -typedef struct lsm_bt_node { +struct lsm_bt_node { struct lsm_bt_node *left; struct lsm_bt_node *right; + struct lsm_bt_node *parent; void *data; char key; -} lsm_bt_node; +}; /** * Initialize a new binary tree node diff --git a/lsm/src/_include/lsm/store_internal.h b/lsm/src/_include/lsm/store_internal.h index e446a0d..e853308 100644 --- a/lsm/src/_include/lsm/store_internal.h +++ b/lsm/src/_include/lsm/store_internal.h @@ -34,6 +34,11 @@ typedef struct lsm_entry { uint64_t idx_file_offset; } lsm_entry; +struct lsm_store_iterator { + lsm_trie_iterator *iter; + lsm_store *store; +}; + /** * Allocate and initialize a new lsm_entry object. * diff --git a/lsm/src/_include/lsm/trie_internal.h b/lsm/src/_include/lsm/trie_internal.h index e3526d9..4259e82 100644 --- a/lsm/src/_include/lsm/trie_internal.h +++ b/lsm/src/_include/lsm/trie_internal.h @@ -5,14 +5,11 @@ #include "lsm/str_internal.h" #include "lsm/trie.h" -/** - * A node inside a trie structure - */ -typedef struct lsm_trie_node { +struct lsm_trie_node { lsm_bt bt; lsm_str skip; void *data; -} lsm_trie_node; +}; /** * Allocate and initialize a new trie node @@ -33,4 +30,13 @@ struct lsm_trie { uint64_t size; }; +struct lsm_trie_iterator { + lsm_trie_node *next; + struct { + lsm_bt_iterator *arr; + size_t len; + size_t cap; + } stack; +}; + #endif diff --git a/lsm/src/bt/lsm_bt.c b/lsm/src/bt/lsm_bt.c index c09fa01..35c9bb4 100644 --- a/lsm/src/bt/lsm_bt.c +++ b/lsm/src/bt/lsm_bt.c @@ -1,5 +1,6 @@ #include +#include "lsm/bt.h" #include "lsm/bt_internal.h" lsm_error lsm_bt_node_init(lsm_bt_node **ptr, const char key, void *data) { @@ -60,10 +61,12 @@ void lsm_bt_free(lsm_bt *bt) { uint64_t lsm_bt_size(const lsm_bt *bt) { return bt->size; } lsm_error lsm_bt_insert(lsm_bt *bt, char key, void *data) { + lsm_bt_node *parent = NULL; lsm_bt_node **dest = &bt->root; // Traverse down the tree until we reach the new point to insert our node while ((*dest != NULL) && ((*dest)->key != key)) { + parent = *dest; dest = key < (*dest)->key ? &(*dest)->left : &(*dest)->right; } @@ -71,9 +74,8 @@ lsm_error lsm_bt_insert(lsm_bt *bt, char key, void *data) { return lsm_error_already_present; } - if (lsm_bt_node_init(dest, key, data) != lsm_error_ok) { - return lsm_error_failed_alloc; - } + LSM_RES(lsm_bt_node_init(dest, key, data)); + (*dest)->parent = parent; bt->size++; @@ -125,13 +127,27 @@ lsm_error lsm_bt_remove(void **out, lsm_bt *bt, char key) { (*dest)->data = (*succ)->data; lsm_bt_node *succ_replacement = (*succ)->right; + lsm_bt_node *parent = (*succ)->parent; + lsm_bt_node_free(*succ); + *succ = succ_replacement; + + if (*succ != NULL) { + (*succ)->parent = parent; + } } else { lsm_bt_node *replacement = (*dest)->left != NULL ? (*dest)->left : (*dest)->right; + lsm_bt_node *parent = (*dest)->parent; + lsm_bt_node_free(*dest); + *dest = replacement; + + if (*dest != NULL) { + (*dest)->parent = parent; + } } return lsm_error_ok; @@ -156,3 +172,45 @@ lsm_error lsm_bt_replace(void **out, lsm_bt *bt, char key, void *data) { return lsm_error_ok; } + +void lsm_bt_iter(lsm_bt_iterator *out, const lsm_bt *bt) { + out->next = bt->root; + + if (bt->root != NULL) { + // Initialize the iterator to the smallest element in the tree + while (out->next->left != NULL) { + out->next = out->next->left; + } + } +} + +bool lsm_bt_iter_next(void **out, char *key_out, lsm_bt_iterator *iter) { + if (iter->next == NULL) { + return false; + } + + if (out != NULL) { + *out = iter->next->data; + } + + if (key_out != NULL) { + *key_out = iter->next->key; + } + + if (iter->next->right != NULL) { + iter->next = iter->next->right; + + while (iter->next->left != NULL) { + iter->next = iter->next->left; + } + } else { + while ((iter->next->parent != NULL) && + (iter->next->parent->right == iter->next)) { + iter->next = iter->next->parent; + } + + iter->next = iter->next->parent; + } + + return true; +} diff --git a/lsm/src/store/lsm_store_entry.c b/lsm/src/store/lsm_store_entry.c index 63d90a7..101641b 100644 --- a/lsm/src/store/lsm_store_entry.c +++ b/lsm/src/store/lsm_store_entry.c @@ -316,3 +316,7 @@ lsm_error lsm_entry_data_open_read(lsm_entry_handle *handle) { return lsm_error_ok; } + +void lsm_entry_key(const lsm_str **out, lsm_entry_handle *handle) { + *out = handle->wrapper->entry->key; +} diff --git a/lsm/src/store/lsm_store_iter.c b/lsm/src/store/lsm_store_iter.c new file mode 100644 index 0000000..3879d5e --- /dev/null +++ b/lsm/src/store/lsm_store_iter.c @@ -0,0 +1,58 @@ +#include "lsm/store.h" +#include "lsm/store_internal.h" + +lsm_error lsm_store_iter(lsm_store_iterator **out, lsm_store *store, + const lsm_str *prefix) { + lsm_trie_iterator *trie_iter; + LSM_RES(lsm_trie_iter(&trie_iter, store->trie, prefix)); + + lsm_store_iterator *iter = calloc(1, sizeof(lsm_store_iterator)); + + if (iter == NULL) { + lsm_trie_iter_free(trie_iter); + + return lsm_error_failed_alloc; + } + + iter->iter = trie_iter; + iter->store = store; + + *out = iter; + + return lsm_error_ok; +} + +lsm_error lsm_store_iter_next_read(lsm_entry_handle **out, + lsm_store_iterator *iter) { + lsm_entry_wrapper *wrapper = NULL; + + // Traverse through the trie until a node is found with a filled data field + do { + // Exits function if iterator is done + LSM_RES(lsm_trie_iter_next((void **)&wrapper, iter->iter)); + + // TODO error handling? + pthread_rwlock_rdlock(&wrapper->lock); + + if (wrapper->entry == NULL) { + pthread_rwlock_unlock(&wrapper->lock); + + wrapper = NULL; + } + } while (wrapper == NULL); + + lsm_entry_handle *handle; + LSM_RES2(lsm_entry_handle_init(&handle), + pthread_rwlock_unlock(&wrapper->lock)); + + handle->wrapper = wrapper; + handle->store = iter->store; + *out = handle; + + return lsm_error_ok; +} + +void lsm_store_iter_free(lsm_store_iterator *iter) { + lsm_trie_iter_free(iter->iter); + free(iter); +} diff --git a/lsm/src/str/lsm_str.c b/lsm/src/str/lsm_str.c index 217bad7..e152fc1 100644 --- a/lsm/src/str/lsm_str.c +++ b/lsm/src/str/lsm_str.c @@ -215,15 +215,15 @@ bool lsm_str_eq(const lsm_str *s1, const lsm_str *s2) { return memcmp(lsm_str_ptr(s1), lsm_str_ptr(s2), s1->len) == 0; } -lsm_error lsm_str_append(lsm_str *s, lsm_str *s2) { - if (s2->len == 0) { +lsm_error lsm_str_append_c(lsm_str *s, const char *c_str, uint64_t len) { + if (len == 0) { return lsm_error_ok; } - uint64_t new_len = s->len + s2->len; + uint64_t new_len = s->len + len; if (new_len <= 8) { - memcpy(&s->data.val[s->len], s2->data.val, s2->len); + memcpy(&s->data.val[s->len], c_str, len); } else { char *buf; @@ -243,11 +243,15 @@ lsm_error lsm_str_append(lsm_str *s, lsm_str *s2) { } } - memcpy(&buf[s->len], lsm_str_ptr(s2), s2->len); + memcpy(&buf[s->len], c_str, len); s->data.ptr = buf; } - s->len += s2->len; + s->len += len; return lsm_error_ok; } + +lsm_error lsm_str_append(lsm_str *s, const lsm_str *s2) { + return lsm_str_append_c(s, lsm_str_ptr(s2), s2->len); +} diff --git a/lsm/src/trie/lsm_trie_iter.c b/lsm/src/trie/lsm_trie_iter.c new file mode 100644 index 0000000..caadb10 --- /dev/null +++ b/lsm/src/trie/lsm_trie_iter.c @@ -0,0 +1,117 @@ +#include "lsm.h" +#include "lsm/trie_internal.h" + +/** + * Advance the iterator so that `next` now points to a node containing data. If + * no more data nodes are found, `next` is set to NULL. The initial value of + * `next` is ignored. + */ +lsm_error lsm_trie_iter_next_data_node(lsm_trie_iterator *iter) { + do { + // Traverse back up the stack until we reach either the end of the subtree, + // or an iterator that hasn't been exhausted yet + while ((iter->stack.len > 0) && + !lsm_bt_iter_next((void **)&iter->next, NULL, + &iter->stack.arr[iter->stack.len - 1])) { + iter->stack.len--; + } + + if (iter->stack.len == 0) { + iter->next = NULL; + + return lsm_error_ok; + } + + // Add node's subtree to the stack + if (iter->stack.len == iter->stack.cap) { + lsm_bt_iterator *arr = realloc( + iter->stack.arr, iter->stack.cap * 2 * sizeof(lsm_bt_iterator)); + + if (arr == NULL) { + return lsm_error_failed_alloc; + } + + iter->stack.arr = arr; + iter->stack.cap *= 2; + } + + lsm_bt_iter(&iter->stack.arr[iter->stack.len], &iter->next->bt); + iter->stack.len++; + + } while (iter->next->data == NULL); + + return lsm_error_ok; +} + +lsm_error lsm_trie_iter(lsm_trie_iterator **out, const lsm_trie *trie, + const lsm_str *prefix) { + uint64_t prefix_len = prefix == NULL ? 0 : lsm_str_len(prefix); + + uint64_t index = 0; + lsm_trie_node *node = trie->root; + + // Simplified traversal down the trie to find the root of the subtree + // contaiing all nodes with the given prefix + while ((index < prefix_len) && (node != NULL)) { + char c = lsm_str_char(prefix, index); + lsm_error res = lsm_bt_search((void **)&node, &node->bt, c); + + switch (res) { + case lsm_error_ok: + index += 1 + lsm_str_len(&node->skip); + break; + case lsm_error_not_found: + node = NULL; + break; + default: + return res; + }; + } + + lsm_trie_iterator *iter = calloc(1, sizeof(lsm_trie_iterator)); + + if (iter == NULL) { + return lsm_error_failed_alloc; + } + + iter->next = node; + + if (node != NULL) { + lsm_bt_iterator *arr = malloc(sizeof(lsm_bt_iterator)); + + if (arr == NULL) { + free(iter); + + return lsm_error_failed_alloc; + } + + iter->stack.arr = arr; + iter->stack.cap = 1; + iter->stack.len = 1; + + lsm_bt_iter(&iter->stack.arr[0], &node->bt); + + if (node->data == NULL) { + LSM_RES(lsm_trie_iter_next_data_node(iter)); + } + } + + *out = iter; + + return lsm_error_ok; +} + +lsm_error lsm_trie_iter_next(void **out, lsm_trie_iterator *iter) { + if (iter->next == NULL) { + return lsm_error_done; + } + + *out = iter->next->data; + + return lsm_trie_iter_next_data_node(iter); +} + +void lsm_trie_iter_free(lsm_trie_iterator *iter) { + free(iter->stack.arr); + free(iter); +} diff --git a/lsm/test/bt/bt.c b/lsm/test/bt/bt.c index fdff839..9206e1f 100644 --- a/lsm/test/bt/bt.c +++ b/lsm/test/bt/bt.c @@ -104,6 +104,33 @@ void test_remove_multiple() { lsm_bt_free(bt); } +void test_iter() { + char chars[] = "falcoep"; + size_t char_count = sizeof(chars) / sizeof(char) - 1; + + char sorted_chars[] = "aceflop"; + + BT_INIT(); + + for (size_t i = 0; i < char_count; i++) { + TEST_CHECK(lsm_bt_insert(bt, chars[i], (void *)(i + 1)) == lsm_error_ok); + } + + lsm_bt_iterator iter; + lsm_bt_iter(&iter, bt); + + char key; + void *data; + size_t i = 0; + + while (lsm_bt_iter_next(&data, &key, &iter)) { + TEST_CHECK_(key == sorted_chars[i], "%c == %c", key, sorted_chars[i]); + i++; + } + + TEST_CHECK(i == char_count); +} + TEST_LIST = { { "bt init", test_init }, { "bt insert first", test_insert_first }, @@ -111,5 +138,6 @@ TEST_LIST = { { "bt insert multiple", test_insert_multiple }, { "bt remove root", test_remove_root }, { "bt remove multiple", test_remove_multiple }, + { "bt iter", test_iter }, { NULL, NULL } }; diff --git a/lsm/test/trie/trie.c b/lsm/test/trie/trie.c index db3e6ee..a1e2340 100644 --- a/lsm/test/trie/trie.c +++ b/lsm/test/trie/trie.c @@ -25,8 +25,64 @@ void test_insert_one() { TEST_CHECK(data == (void *)1); } +void test_iter() { + TRIE_INIT(); + + lsm_str *s; + + lsm_str_init_copy(&s, "hello"); + TEST_CHECK(lsm_trie_insert(trie, s, (void *)1) == lsm_error_ok); + + lsm_str_init_copy(&s, "hella"); + TEST_CHECK(lsm_trie_insert(trie, s, (void *)2) == lsm_error_ok); + + lsm_str_init_copy(&s, "hel"); + TEST_CHECK(lsm_trie_insert(trie, s, (void *)3) == lsm_error_ok); + + lsm_str_init_copy(&s, "wow"); + TEST_CHECK(lsm_trie_insert(trie, s, (void *)4) == lsm_error_ok); + + lsm_str_init_copy(&s, "hel"); + + lsm_trie_iterator *iter; + TEST_CHECK(lsm_trie_iter(&iter, trie, s) == lsm_error_ok); + + void *data; + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)3, "%p == %p", data, (void *)3); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)2, "%p == %p", data, (void *)2); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)1, "%p == %p", data, (void *)1); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_done); + lsm_trie_iter_free(iter); + + // Test full trie iterator + TEST_CHECK(lsm_trie_iter(&iter, trie, NULL) == lsm_error_ok); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)3, "%p == %p", data, (void *)3); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)2, "%p == %p", data, (void *)2); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)1, "%p == %p", data, (void *)1); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_ok); + TEST_CHECK_(data == (void *)4, "%p == %p", data, (void *)4); + + TEST_CHECK(lsm_trie_iter_next(&data, iter) == lsm_error_done); + lsm_trie_iter_free(iter); +} + TEST_LIST = { { "trie init", test_init }, { "trie insert one", test_insert_one }, + { "trie iter", test_iter }, { NULL, NULL } }; diff --git a/ltm/Makefile b/ltm/Makefile new file mode 100644 index 0000000..44b2073 --- /dev/null +++ b/ltm/Makefile @@ -0,0 +1,133 @@ +# https://spin.atomicobject.com/2016/08/26/makefile-c-projects/ was a great +# base for this Makefile + +-include config.mk + +LIB := $(BUILD_DIR)/$(LIB_FILENAME) + +SRCS != find '$(SRC_DIR)' -iname '*.c' +SRCS_H != find include -iname '*.h' +SRCS_H_INTERNAL != find $(SRC_DIR) -iname '*.h' +SRCS_TEST != find '$(TEST_DIR)' -iname '*.c' +SRCS_EXAMPLE != find '$(EXAMPLE_DIR)' -iname '*.c' + +OBJS := $(SRCS:%=$(BUILD_DIR)/%.o) +OBJS_TEST := $(SRCS_TEST:%=$(BUILD_DIR)/%.o) +OBJS_EXAMPLE := $(SRCS_EXAMPLE:%=$(BUILD_DIR)/%.o) +DEPS := $(SRCS:%=$(BUILD_DIR)/%.d) $(SRCS_TEST:%=$(BUILD_DIR)/%.d) + +BINS_TEST := $(OBJS_TEST:%.c.o=%) +BINS_EXAMPLE := $(OBJS_EXAMPLE:%.c.o=%) + +TARGETS_TEST := $(BINS_TEST:%=test-%) +TARGETS_MEM_TEST := $(BINS_TEST:%=test-mem-%) +TARGETS_EXAMPLE := $(BINS_EXAMPLE:%=test-%) + +_CFLAGS := $(addprefix -I,$(INC_DIRS)) $(CFLAGS) -Wall -Wextra + +.PHONY: all +all: lib + + +# =====COMPILATION===== +# Utility used by the CI to lint +.PHONY: objs +objs: $(OBJS) + +.PHONY: lib +lib: $(LIB) +$(LIB): $(OBJS) + ar -rcs $@ $(OBJS) + +$(BUILD_DIR)/$(SRC_DIR)/%.c.o: $(SRC_DIR)/%.c + mkdir -p $(dir $@) + $(CC) -c $(_CFLAGS) $< -o $@ + +# =====TESTING===== +.PHONY: test +test: $(TARGETS_TEST) + +.PHONY: test-mem +test-mem: $(TARGETS_MEM_TEST) + +.PHONY: $(TARGETS_TEST) +$(TARGETS_TEST): test-%: % + ./$^ + +.PHONY: $(TARGETS_MEM_TEST) +$(TARGETS_MEM_TEST): test-mem-%: % + valgrind --tool=memcheck --error-exitcode=1 --track-origins=yes --leak-check=full ./$^ + +.PHONY: build-test +build-test: $(BINS_TEST) + +$(BINS_TEST): %: %.c.o $(LIB) + $(CC) \ + $^ -o $@ + +# Along with the include directory, each test includes $(TEST_DIR) (which +# contains the acutest.h header file), and the src directory of the module it's +# testing. This allows tests to access internal methods, which aren't publicly +# exposed. +$(BUILD_DIR)/$(TEST_DIR)/%.c.o: $(TEST_DIR)/%.c + mkdir -p $(dir $@) + $(CC) $(_CFLAGS) -I$(TEST_DIR) \ + -I$(dir $(@:$(BUILD_DIR)/$(TEST_DIR)/%=$(SRC_DIR)/%)) \ + -c $< -o $@ + +# =====EXAMPLES===== +.PHONY: build-example +build-example: $(BINS_EXAMPLE) + +$(BINS_EXAMPLE): %: %.c.o $(LIB) + $(CC) \ + $^ -o $@ + +# Example binaries link the resulting library +$(BUILD_DIR)/$(EXAMPLE_DIR)/%.c.o: $(EXAMPLE_DIR)/%.c + mkdir -p $(dir $@) + $(CC) $(_CFLAGS) -I$(PUB_INC_DIR) -c $< -o $@ + +# =====MAINTENANCE===== +.PHONY: lint +lint: + clang-format -n --Werror \ + $(filter-out $(THIRDPARTY),$(SRCS)) \ + $(filter-out $(THIRDPARTY),$(SRCS_H)) \ + $(filter-out $(THIRDPARTY),$(SRCS_H_INTERNAL)) + +.PHONY: fmt +fmt: + clang-format -i \ + $(filter-out $(THIRDPARTY),$(SRCS)) \ + $(filter-out $(THIRDPARTY),$(SRCS_H)) \ + $(filter-out $(THIRDPARTY),$(SRCS_H_INTERNAL)) + +.PHONY: check +check: + mkdir -p $(BUILD_DIR)/cppcheck + cppcheck \ + $(addprefix -I,$(INC_DIRS)) \ + --cppcheck-build-dir=$(BUILD_DIR)/cppcheck \ + --error-exitcode=1 \ + --enable=warning,style \ + --inline-suppr \ + --check-level=exhaustive \ + --quiet \ + -j$(shell nproc) \ + $(filter-out $(THIRDPARTY),$(SRCS)) + +.PHONY: clean +clean: + rm -rf '$(BUILD_DIR)' + + +.PHONY: bear +bear: clean + bear -- make + bear --append -- make build-test + bear --append -- make build-example + + +# Make make aware of the .d files +-include $(DEPS) diff --git a/ltm/README.md b/ltm/README.md new file mode 100644 index 0000000..6f0a86c --- /dev/null +++ b/ltm/README.md @@ -0,0 +1,32 @@ +# LTM - Lander Template Module + +This module provides an interface for generating `char` streams from a given +template. + +```html + +

{{ title }}

+
    +{{ item start }} +
  • {{ name }}
    • +{{ item end }} +
+ +``` + +The above snippet shows everything the templating language currently offers; +either singular variables (here: `title`) or nested templates (here: `item`). +Note the absence of a loop construct. This is because each variable and nested +template is implicitely already a loop; a variable or a nested template can be +added as many times as needed, and they will appear in the order they were +added. + +Template strings are compiled into templates. From a template, an instance can +be created to which the required data can be added to fill in the template. +Instantiating a template does not modify the original template, meaning +templates can be safely used concurrently. + +Each inserted variable can get its data from a variety of sources, namely +`char` buffers, files or a custom reader function. The resulting `char` stream +is never fully loaded into memory; an instance can stream its content to a +provided buffer to prevent unnecessary memory usage. diff --git a/ltm/config.mk b/ltm/config.mk new file mode 100644 index 0000000..b950e29 --- /dev/null +++ b/ltm/config.mk @@ -0,0 +1,17 @@ +LIB_FILENAME = libltm.a + +BUILD_DIR = build +SRC_DIR = src +TEST_DIR = test +EXAMPLE_DIR = example +THIRDPARTY = + +PUB_INC_DIR = include +INC_DIRS = $(PUB_INC_DIR) src/_include + +# -MMD: generate a .d file for every source file. This file can be imported by +# make and makes make aware that a header file has been changed, ensuring an +# object file is also recompiled if only a header is changed. +# -MP: generate a dummy target for every header file (according to the docs it +# prevents some errors when removing header files) +CFLAGS ?= -MMD -MP -g -Wall -Werror diff --git a/ltm/example/test.c b/ltm/example/test.c new file mode 100644 index 0000000..cff2922 --- /dev/null +++ b/ltm/example/test.c @@ -0,0 +1,48 @@ +#include +#include + +#include "ltm/template.h" + +const char *s = "\n" + "\n" + "\n" + "
{{ paste }}
"; + + ltm_err reader(size_t *written, char *buf, size_t len, void *data) { + FILE *f = data; + + *written = fread(buf, 1, len, f); + + return ltm_err_ok; + } + +int main() { + ltm_template *template; + ltm_template_compile(&template, s); + ltm_instance *instance; + ltm_template_instantiate(&instance, template); + + const char *filename = "src/ltm_instance.c"; + + struct stat sb; + stat(filename, &sb); + + FILE *f = fopen(filename, "rb"); + + ltm_instance_block_add_var_fn(instance, "paste", reader, f, sb.st_size); + /* ltm_instance_block_add_var(instance, "paste", ltm_instance_block_type_file_owned, f, sb.st_size); */ + /* ltm_instance_block_add_var(instance, "paste", ltm_instance_block_type_buf, "hello\n", 6); */ + /* ltm_instance_block_add_var(instance, "paste", ltm_instance_block_type_buf, "world\n", 6); */ + + char buf[128]; + size_t written = 0; + + while (ltm_instance_write(&written, buf, 128, instance) != ltm_err_done) { + printf("%.*s", (int)written, buf); + } + + printf("%.*s", (int)written, buf); + + ltm_instance_free(instance); + ltm_template_free(template); +} diff --git a/ltm/include/ltm/common.h b/ltm/include/ltm/common.h new file mode 100644 index 0000000..ab028af --- /dev/null +++ b/ltm/include/ltm/common.h @@ -0,0 +1,33 @@ +#ifndef LTM_COMMON +#define LTM_COMMON + +#define LTM_RES(x) \ + { \ + ltm_err res = x; \ + if (res != ltm_err_ok) \ + return res; \ + } + +#define LTM_RES2(x, e) \ + { \ + ltm_err res = x; \ + if (res != ltm_err_ok) { \ + e; \ + return res; \ + } \ + } + +#define LTM_MIN(x, y) ((x) < (y) ? (x) : (y)) +#define LTM_MAX(x, y) ((x) > (y) ? (x) : (y)) + +typedef enum ltm_err { + ltm_err_ok = 0, + ltm_err_invalid_template, + ltm_err_failed_alloc, + ltm_err_failed_io, + ltm_err_not_found, + ltm_err_wrong_block_type, + ltm_err_done, +} ltm_err; + +#endif diff --git a/ltm/include/ltm/template.h b/ltm/include/ltm/template.h new file mode 100644 index 0000000..fc45c07 --- /dev/null +++ b/ltm/include/ltm/template.h @@ -0,0 +1,104 @@ +#ifndef LTM_TEMPLATE +#define LTM_TEMPLATE + +#include + +#include "ltm/common.h" + +/** + * Represents a compiled template + */ +typedef struct ltm_template ltm_template; + +/** + * Compile the given template. + * + * @param out where to store pointer to newly allocated `ltm_template` + * @param template nul-terminated string containing the template + */ +ltm_err ltm_template_compile(ltm_template **out, const char *template); + +/** + * Compile the given template with a given length. + * + * @param out where to store pointer to newly allocated `ltm_template` + * @param template char buffer containing the template + * @param len length of the char buffer + */ +ltm_err ltm_template_compile_n(ltm_template **out, const char *template, + size_t len); + +/** + * Free the template instance. After freeing a template, no instances associated + * with it are safe to use. + */ +void ltm_template_free(ltm_template *template); + +/** + * Represents a specific instance of a template. + */ +typedef struct ltm_instance ltm_instance; + +typedef ltm_err (*ltm_data_fn)(size_t *written, char *buf, size_t len, + void *data); + +/** + * Create a new instance of the given template. + */ +ltm_err ltm_template_instantiate(ltm_instance **out, + const ltm_template *template); + +/** + * Free the given instance, as well as all nested instances. + */ +void ltm_instance_free(ltm_instance *instance); + +typedef enum ltm_instance_block_type { + ltm_instance_block_type_buf = 0, + ltm_instance_block_type_buf_owned, + ltm_instance_block_type_file, + ltm_instance_block_type_file_owned, + ltm_instance_block_type_nested, + ltm_instance_block_type_fn, +} ltm_instance_block_type; + +/** + * Add a new variable to the template. + */ +ltm_err ltm_instance_block_add_var(ltm_instance *instance, const char *name, + ltm_instance_block_type type, void *data, + size_t len); + +/** + * Add a new variable to the template whose data is provided by a data function. + */ +ltm_err ltm_instance_block_add_var_fn(ltm_instance *instance, const char *name, + ltm_data_fn fn, void *data, size_t len); + +/** + * Add a new nested instance to the instance, returning a handle to the nested + * instance. + */ +ltm_err ltm_instance_block_add_nested(ltm_instance **out, + ltm_instance *instance, const char *name); + +/** + * Calculate the size of the resulting output of this instance. + */ +size_t ltm_instance_size(const ltm_instance *instance); + +/** + * Write at most `len` bytes to the given buffer. + * + * @param written outputs how many bytes were written to `buf` + * @param buf buffer to write to + * @param len length of the buffer + * @param instance instance to write + * @return `ltm_err_ok` if write was successful but there's more to be written, + * `ltm_err_done` if everything has been written successfully, or some other + * error code + */ +ltm_err ltm_instance_write(size_t *written, char *buf, size_t len, + ltm_instance *instance); + +#endif diff --git a/ltm/src/_include/ltm/template_internal.h b/ltm/src/_include/ltm/template_internal.h new file mode 100644 index 0000000..f095183 --- /dev/null +++ b/ltm/src/_include/ltm/template_internal.h @@ -0,0 +1,119 @@ +#ifndef LTM_TEMPLATE_INTERNAL +#define LTM_TEMPLATE_INTERNAL + +#include "ltm/template.h" + +typedef enum ltm_placeholder_type { + ltm_placeholder_type_invalid = 0, + ltm_placeholder_type_var, + ltm_placeholder_type_nested_start, + ltm_placeholder_type_nested_end, +} ltm_placeholder_type; + +/** + * Internal struct used when compiling templates + */ +typedef struct ltm_placeholder { + const char *start; + const char *end; + struct { + const char *s; + size_t len; + } name; + ltm_placeholder_type type; +} ltm_placeholder; + +/** + * The type of a template block + */ +typedef enum ltm_template_block_type { + ltm_template_block_type_literal = 0, + ltm_template_block_type_var, + ltm_template_block_type_nested, +} ltm_template_block_type; + +/** + * A block in a template. + */ +typedef struct ltm_template_block { + ltm_template_block_type type; + struct { + void *ptr; + size_t len; + } data; +} ltm_template_block; + +typedef struct ltm_template_block_name { + struct { + const char *s; + size_t len; + } name; + size_t index; +} ltm_template_block_name; + +/** + * Represents a compiled template. A template consists of a list of blocks, of + * which some have names that can be indexed (e.g. variables, nested templates). + */ +struct ltm_template { + struct { + ltm_template_block *arr; + size_t len; + } blocks; + struct { + ltm_template_block_name *arr; + size_t len; + } names; +}; + +/** + * Allocate a new `ltm_template`. + */ +ltm_err ltm_template_init(ltm_template **out); + +/** + * Append a name to the template's list. + */ +ltm_err ltm_template_name_append(ltm_template *template, const char *s, + size_t len, size_t index); + +/** + * Append a block to the template's list. + */ +ltm_err ltm_template_block_append(ltm_template *template, + ltm_template_block_type type, void *data, + size_t len); + +typedef struct ltm_instance_block { + ltm_instance_block_type type; + ltm_data_fn fn; + struct { + void *ptr; + size_t len; + } data; + struct ltm_instance_block *next; +} ltm_instance_block; + +ltm_err ltm_instance_block_init(ltm_instance_block **out); + +/** + * Add a new block to the instance with the given type. + */ +ltm_err ltm_instance_block_add(ltm_instance_block **out, ltm_instance *instance, + const char *name, ltm_instance_block_type type); + +struct ltm_instance { + const ltm_template *template; + struct { + ltm_instance_block *head; + ltm_instance_block *tail; + ltm_instance_block *current; + } blocks; + ltm_instance_block ***vars; + // How many bytes of the current block have been written + size_t written; +}; + +ltm_err ltm_instance_init(ltm_instance **out); + +#endif diff --git a/ltm/src/ltm_instance.c b/ltm/src/ltm_instance.c new file mode 100644 index 0000000..1c23bd7 --- /dev/null +++ b/ltm/src/ltm_instance.c @@ -0,0 +1,350 @@ +#include +#include +#include + +#include "ltm/common.h" +#include "ltm/template.h" +#include "ltm/template_internal.h" + +ltm_err ltm_instance_block_init(ltm_instance_block **out) { + ltm_instance_block *block = calloc(1, sizeof(ltm_instance_block)); + + if (block == NULL) { + return ltm_err_failed_alloc; + } + + *out = block; + + return ltm_err_ok; +} + +ltm_err ltm_instance_init(ltm_instance **out) { + ltm_instance *instance = calloc(1, sizeof(ltm_instance)); + + if (instance == NULL) { + return ltm_err_failed_alloc; + } + + *out = instance; + + return ltm_err_ok; +} + +void ltm_instance_free(ltm_instance *instance) { + if (instance->vars != NULL) { + free(instance->vars); + } + + ltm_instance_block *block = instance->blocks.head; + + while (block != NULL) { + switch (block->type) { + case ltm_instance_block_type_buf_owned: + free(block->data.ptr); + break; + case ltm_instance_block_type_file_owned: + fclose(block->data.ptr); + break; + case ltm_instance_block_type_nested: + ltm_instance_free(block->data.ptr); + break; + case ltm_instance_block_type_file: + case ltm_instance_block_type_fn: + case ltm_instance_block_type_buf:; + } + + ltm_instance_block *temp = block->next; + free(block); + block = temp; + } + + free(instance); +} + +ltm_err ltm_template_instantiate(ltm_instance **out, + const ltm_template *template) { + ltm_instance *instance; + LTM_RES(ltm_instance_init(&instance)); + + instance->template = template; + + ltm_instance_block ***vars = NULL; + + if (template->names.len > 0) { + vars = malloc(template->names.len * sizeof(ltm_instance_block **)); + + if (vars == NULL) { + ltm_instance_free(instance); + + return ltm_err_failed_alloc; + } + + instance->vars = vars; + } + + for (size_t block_index = 0; block_index < template->blocks.len; + block_index++) { + ltm_template_block *template_block = &template->blocks.arr[block_index]; + + switch (template_block->type) { + case ltm_template_block_type_literal: { + ltm_instance_block *block; + LTM_RES2(ltm_instance_block_init(&block), ltm_instance_free(instance)); + + block->type = ltm_instance_block_type_buf; + block->data.ptr = template_block->data.ptr; + block->data.len = template_block->data.len; + + if (instance->blocks.head == NULL) { + instance->blocks.head = block; + instance->blocks.tail = block; + instance->blocks.current = block; + } else { + instance->blocks.tail->next = block; + instance->blocks.tail = block; + } + } break; + case ltm_template_block_type_var: + case ltm_template_block_type_nested: + // Account for the possibility a template starts with a placeholder + *vars = instance->blocks.tail != NULL ? &instance->blocks.tail->next + : &instance->blocks.head; + vars++; + break; + } + } + + *out = instance; + + return ltm_err_ok; +} + +ltm_err ltm_instance_block_add(ltm_instance_block **out, ltm_instance *instance, + const char *name, ltm_instance_block_type type) { + const ltm_template *template = instance->template; + + ltm_template_block_name *block_name = NULL; + size_t i = 0; + + while (i < template->names.len) { + block_name = &template->names.arr[i]; + + if (strncmp(name, block_name->name.s, block_name->name.len) == 0) { + break; + } + + i++; + } + + if (i == template->names.len) { + return ltm_err_not_found; + } + + ltm_template_block *template_block = &template->blocks.arr[block_name->index]; + bool correct_type = false; + + switch (type) { + case ltm_instance_block_type_nested: + correct_type = template_block->type == ltm_template_block_type_nested; + break; + case ltm_instance_block_type_buf: + case ltm_instance_block_type_buf_owned: + case ltm_instance_block_type_file: + case ltm_instance_block_type_file_owned: + case ltm_instance_block_type_fn: + correct_type = template_block->type == ltm_template_block_type_var; + break; + } + + if (!correct_type) { + return ltm_err_wrong_block_type; + } + + ltm_instance_block *block; + LTM_RES(ltm_instance_block_init(&block)); + + block->type = type; + + // Insert the block in the linked list + block->next = *instance->vars[i]; + *instance->vars[i] = block; + instance->vars[i] = &block->next; + + *out = block; + + return ltm_err_ok; +} + +ltm_err ltm_instance_block_add_var(ltm_instance *instance, const char *name, + ltm_instance_block_type type, void *data, + size_t len) { + ltm_instance_block *block; + LTM_RES(ltm_instance_block_add(&block, instance, name, type)); + + block->data.ptr = data; + block->data.len = len; + + return ltm_err_ok; +} + +ltm_err ltm_instance_block_add_var_fn(ltm_instance *instance, const char *name, + ltm_data_fn fn, void *data, size_t len) { + ltm_instance_block *block; + LTM_RES(ltm_instance_block_add(&block, instance, name, + ltm_instance_block_type_fn)); + + block->fn = fn; + block->data.ptr = data; + block->data.len = len; + + return ltm_err_ok; +} + +ltm_err ltm_instance_block_add_nested(ltm_instance **out, + ltm_instance *instance, + const char *name) { + const ltm_template *template = instance->template; + + ltm_template_block_name *block_name = NULL; + size_t i = 0; + + while (i < template->names.len) { + block_name = &template->names.arr[i]; + + if (strncmp(name, block_name->name.s, block_name->name.len) == 0) { + break; + } + + i++; + } + + if (i == template->names.len) { + return ltm_err_not_found; + } + + ltm_template_block *template_block = &template->blocks.arr[block_name->index]; + + if (template_block->type != ltm_template_block_type_nested) { + return ltm_err_wrong_block_type; + } + + ltm_instance_block *block; + LTM_RES(ltm_instance_block_init(&block)); + + ltm_instance *nested; + LTM_RES2(ltm_template_instantiate(&nested, template_block->data.ptr), + free(block)); + + block->type = ltm_instance_block_type_nested; + block->data.ptr = nested; + + // We insert the block in the linked list and replace its next pointer as the + // new attachment point for this variable + block->next = *instance->vars[i]; + *instance->vars[i] = block; + instance->vars[i] = &block->next; + + *out = nested; + + return ltm_err_ok; +} + +size_t ltm_instance_size(const ltm_instance *instance) { + size_t total = 0; + ltm_instance_block *block = instance->blocks.head; + + while (block != NULL) { + switch (block->type) { + case ltm_instance_block_type_buf: + case ltm_instance_block_type_buf_owned: + case ltm_instance_block_type_file: + case ltm_instance_block_type_file_owned: + case ltm_instance_block_type_fn: + total += block->data.len; + break; + case ltm_instance_block_type_nested: + total += ltm_instance_size(block->data.ptr); + break; + } + + block = block->next; + } + + return total; +} + +ltm_err ltm_instance_write(size_t *written, char *buf, size_t len, + ltm_instance *instance) { + *written = 0; + + while ((*written < len) && (instance->blocks.current != NULL)) { + ltm_instance_block *current = instance->blocks.current; + + switch (current->type) { + case ltm_instance_block_type_buf: + case ltm_instance_block_type_buf_owned: { + size_t cap = + LTM_MIN(current->data.len - instance->written, len - *written); + memcpy(&buf[*written], &((char *)current->data.ptr)[instance->written], + cap); + *written += cap; + instance->written += cap; + + if (instance->written == current->data.len) { + instance->blocks.current = current->next; + instance->written = 0; + } + } break; + case ltm_instance_block_type_file: + case ltm_instance_block_type_file_owned: { + size_t cap = + LTM_MIN(current->data.len - instance->written, len - *written); + size_t read = fread(&buf[*written], 1, cap, current->data.ptr); + + if ((read == 0) && (ferror(current->data.ptr) != 0)) { + return ltm_err_failed_io; + } + + *written += read; + instance->written += read; + + if (instance->written == current->data.len) { + instance->blocks.current = current->next; + instance->written = 0; + } + } break; + case ltm_instance_block_type_fn: { + size_t cap = + LTM_MIN(current->data.len - instance->written, len - *written); + size_t fn_written = 0; + LTM_RES(current->fn(&fn_written, &buf[*written], cap, current->data.ptr)); + *written += fn_written; + instance->written += fn_written; + + if (instance->written == current->data.len) { + instance->blocks.current = current->next; + instance->written = 0; + } + } break; + case ltm_instance_block_type_nested: { + size_t nested_written = 0; + ltm_err res = ltm_instance_write(&nested_written, &buf[*written], + len - *written, current->data.ptr); + *written += nested_written; + + switch (res) { + case ltm_err_done: + instance->blocks.current = current->next; + instance->written = 0; + break; + case ltm_err_ok: + break; + default: + return res; + } + } break; + } + } + + return instance->blocks.current == NULL ? ltm_err_done : ltm_err_ok; +} diff --git a/ltm/src/ltm_template.c b/ltm/src/ltm_template.c new file mode 100644 index 0000000..03dcbd3 --- /dev/null +++ b/ltm/src/ltm_template.c @@ -0,0 +1,93 @@ +#include "ltm/template.h" +#include "ltm/template_internal.h" + +ltm_err ltm_template_init(ltm_template **out) { + ltm_template *template = calloc(1, sizeof(ltm_template)); + + if (template == NULL) { + return ltm_err_failed_alloc; + } + + *out = template; + + return ltm_err_ok; +} + +void ltm_template_free(ltm_template *template) { + if (template->blocks.len > 0) { + for (size_t i = 0; i < template->blocks.len; i++) { + ltm_template_block *block = &template->blocks.arr[i]; + + switch (block->type) { + case ltm_template_block_type_nested: + ltm_template_free(block->data.ptr); + break; + case ltm_template_block_type_var: + case ltm_template_block_type_literal:; + } + } + + free(template->blocks.arr); + } + + if (template->names.len > 0) { + free(template->names.arr); + } + + free(template); +} + +ltm_err ltm_template_name_append(ltm_template *template, const char *s, + size_t len, size_t index) { + ltm_template_block_name *names = + realloc(template->names.arr, + (template->names.len + 1) * sizeof(ltm_template_block_name)); + + if (names == NULL) { + return ltm_err_failed_alloc; + } + + ltm_template_block_name *name = &names[template->names.len]; + + name->name.s = s; + name->name.len = len; + name->index = index; + + template->names.arr = names; + template->names.len++; + + return ltm_err_ok; +} + +ltm_err ltm_template_block_append(ltm_template *template, + ltm_template_block_type type, void *data, + size_t len) { + ltm_template_block *blocks = + realloc(template->blocks.arr, + (template->blocks.len + 1) * sizeof(ltm_template_block)); + + if (blocks == NULL) { + return ltm_err_failed_alloc; + } + + ltm_template_block *block = &blocks[template->blocks.len]; + + block->type = type; + + switch (type) { + case ltm_template_block_type_literal: + block->data.ptr = data; + block->data.len = len; + break; + case ltm_template_block_type_nested: + block->data.ptr = data; + break; + // For the other cases, we explicitely ignore the data and len arguments + default:; + } + + template->blocks.arr = blocks; + template->blocks.len++; + + return ltm_err_ok; +} diff --git a/ltm/src/ltm_template_compile.c b/ltm/src/ltm_template_compile.c new file mode 100644 index 0000000..b69aa4b --- /dev/null +++ b/ltm/src/ltm_template_compile.c @@ -0,0 +1,198 @@ +#include +#include +#include + +#include "ltm/common.h" +#include "ltm/template.h" +#include "ltm/template_internal.h" + +static bool ltm_template_next_placeholder(ltm_placeholder *ph, const char *s, + size_t len) { + if (len == 0) { + return false; + } + + ph->start = memchr(s, '{', len - 1); + + if ((ph->start == NULL) || (ph->start[1] != '{')) { + return false; + } + + size_t new_len = len - (ph->start - s); + + // A template can never be valid without at least 5 characters + if (new_len < 5) { + ph->type = ltm_placeholder_type_invalid; + + return true; + } + + ph->end = memchr(ph->start + 2, '}', new_len - 3); + + // Non-terminated placeholders aren't valid + if ((ph->end == NULL) || (ph->end[1] != '}')) { + ph->type = ltm_placeholder_type_invalid; + + return true; + } + + // End should point to final character + ph->end++; + + // Parse the words + ph->name.s = ph->start + 2; + + while ((*ph->name.s == ' ') && (ph->name.s != ph->end - 1)) { + ph->name.s++; + } + + // Placeholder is empty + if (ph->name.s == ph->end - 1) { + ph->type = ltm_placeholder_type_invalid; + + return true; + } + + const char *ident = ph->name.s; + + while ((*ident != ' ') && (ident != ph->end - 1)) { + ident++; + } + + ph->name.len = ident - ph->name.s; + + // Skip whitespace over to next word + while ((*ident == ' ') && (ident != ph->end - 1)) { + ident++; + } + + if (ident == ph->end - 1) { + ph->type = ltm_placeholder_type_var; + } else { + // Further parse the identifier + const char *temp = ident; + + while ((*temp != ' ') && (temp != ph->end - 1)) { + temp++; + } + + size_t ident_len = temp - ident; + + if (strncmp("start", ident, ident_len) == 0) { + ph->type = ltm_placeholder_type_nested_start; + } else if (strncmp("end", ident, ident_len) == 0) { + ph->type = ltm_placeholder_type_nested_end; + } else { + ph->type = ltm_placeholder_type_invalid; + } + } + + return true; +} + +ltm_err ltm_template_compile_n(ltm_template **out, const char *s, size_t len) { + ltm_template *template; + LTM_RES(ltm_template_init(&template)); + + ltm_placeholder ph; + bool in_nested = false; + const char *nested_start = NULL, *nested_name = NULL; + size_t nested_depth = 0, nested_name_len = 0; + + size_t cur_nested_depth = 0; + + while (ltm_template_next_placeholder(&ph, s, len)) { + // Add part before placeholder as literal + if (!in_nested && (ph.start != s)) { + LTM_RES2(ltm_template_block_append(template, + ltm_template_block_type_literal, + (void *)s, ph.start - s), + ltm_template_free(template)); + } + + switch (ph.type) { + // Invalid placeholders can be detected as early as possible + case ltm_placeholder_type_invalid: + ltm_template_free(template); + + return ltm_err_invalid_template; + case ltm_placeholder_type_var: + if (!in_nested) { + LTM_RES2(ltm_template_block_append( + template, ltm_template_block_type_var, NULL, 0), + ltm_template_free(template)); + LTM_RES2(ltm_template_name_append(template, ph.name.s, ph.name.len, + template->blocks.len - 1), + ltm_template_free(template)); + } + break; + case ltm_placeholder_type_nested_start: + if (!in_nested) { + nested_start = ph.end + 1; + nested_depth = cur_nested_depth; + nested_name = ph.name.s; + nested_name_len = ph.name.len; + in_nested = true; + } + cur_nested_depth++; + break; + case ltm_placeholder_type_nested_end: + // This means there's more nested end placeholders than nested starts + if (cur_nested_depth == 0) { + ltm_template_free(template); + + return ltm_err_invalid_template; + } + + cur_nested_depth--; + + if (in_nested && (cur_nested_depth == nested_depth)) { + size_t nested_len = ph.start - nested_start; + ltm_template *nested_template; + LTM_RES2( + ltm_template_compile_n(&nested_template, nested_start, nested_len), + ltm_template_free(template)); + LTM_RES(ltm_template_block_append( + template, ltm_template_block_type_nested, nested_template, 0)); + LTM_RES2(ltm_template_name_append(template, nested_name, + nested_name_len, + template->blocks.len - 1), + ltm_template_free(template)); + + in_nested = false; + } + // We encountered a nested end without a start + else if (!in_nested) { + ltm_template_free(template); + + return ltm_err_invalid_template; + } + break; + } + + len -= ph.end + 1 - s; + s = ph.end + 1; + } + + // Unfinished nested + if (in_nested) { + ltm_template_free(template); + + return ltm_err_invalid_template; + } + + // Add remaining trailing literal + if (len > 0) { + LTM_RES2(ltm_template_block_append( + template, ltm_template_block_type_literal, (void *)s, len), + ltm_template_free(template)); + } + + *out = template; + + return ltm_err_ok; +} + +ltm_err ltm_template_compile(ltm_template **out, const char *template) { + return ltm_template_compile_n(out, template, strlen(template)); +} diff --git a/ltm/test/instance.c b/ltm/test/instance.c new file mode 100644 index 0000000..3ea46f5 --- /dev/null +++ b/ltm/test/instance.c @@ -0,0 +1,44 @@ +#include "test.h" + +#include "ltm/common.h" +#include "ltm/template.h" +#include "ltm/template_internal.h" + +void test_single_placeholder() { + const char *s = "Hello, {{ world }}!"; + + ltm_template *template; + TEST_ASSERT(ltm_template_compile(&template, s) == ltm_err_ok); + + ltm_instance *instance; + TEST_CHECK(ltm_template_instantiate(&instance, template) == ltm_err_ok); + + TEST_CHECK(ltm_instance_block_add_var(instance, "world", ltm_instance_block_type_buf, "World", 5) == ltm_err_ok); + + TEST_CHECK(ltm_instance_size(instance) == 13); + + char buf[13]; + + size_t written = 0; + TEST_CHECK(ltm_instance_write(&written, buf, 5, instance) == ltm_err_ok); + TEST_CHECK(written == 5); + + written = 0; + TEST_CHECK(ltm_instance_write(&written, buf + 5, 5, instance) == ltm_err_ok); + TEST_CHECK(written == 5); + + written = 0; + TEST_CHECK(ltm_instance_write(&written, buf + 10, 5, instance) == ltm_err_done); + TEST_CHECK(written == 3); + + TEST_CHECK(strncmp(buf, "Hello, World!", 13) == 0); + TEST_DUMP("buf", buf, 13); + + ltm_instance_free(instance); + ltm_template_free(template); +} + +TEST_LIST = { + { "instance single placeholder", test_single_placeholder }, + { NULL, NULL } +}; diff --git a/ltm/test/template_compile.c b/ltm/test/template_compile.c new file mode 100644 index 0000000..127b5fc --- /dev/null +++ b/ltm/test/template_compile.c @@ -0,0 +1,118 @@ +#include "test.h" + +#include "ltm/common.h" +#include "ltm/template.h" +#include "ltm/template_internal.h" + +void test_single_placeholder() { + const char *s = "Hello, {{ world }}"; + + ltm_template *template; + TEST_CHECK(ltm_template_compile(&template, s) == ltm_err_ok); + + TEST_CHECK(template->blocks.len == 2); + + TEST_CHECK(template->blocks.arr[0].type == ltm_template_block_type_literal); + TEST_CHECK(template->blocks.arr[0].data.ptr == s); + TEST_CHECK(template->blocks.arr[0].data.len == 7); + + TEST_CHECK(template->blocks.arr[1].type == ltm_template_block_type_var); + + TEST_CHECK(template->names.len == 1); + + TEST_CHECK(template->names.arr[0].name.s == s + 10); + TEST_CHECK(template->names.arr[0].name.len == 5); + TEST_CHECK(template->names.arr[0].index == 1); + + ltm_template_free(template); +} + +void test_single_placeholder_trailing() { + const char *s = "Hello, {{ world }}!"; + + ltm_template *template; + TEST_CHECK(ltm_template_compile(&template, s) == ltm_err_ok); + + TEST_CHECK(template->blocks.len == 3); + + TEST_CHECK(template->blocks.arr[0].type == ltm_template_block_type_literal); + TEST_CHECK(template->blocks.arr[0].data.ptr == s); + TEST_CHECK(template->blocks.arr[0].data.len == 7); + + TEST_CHECK(template->blocks.arr[1].type == ltm_template_block_type_var); + + TEST_CHECK(template->blocks.arr[2].type == ltm_template_block_type_literal); + TEST_CHECK(template->blocks.arr[2].data.ptr == s + 18); + TEST_CHECK(template->blocks.arr[2].data.len == 1); + + TEST_CHECK(template->names.len == 1); + + TEST_CHECK(template->names.arr[0].name.s == s + 10); + TEST_CHECK(template->names.arr[0].name.len == 5); + TEST_CHECK(template->names.arr[0].index == 1); + + ltm_template_free(template); +} + +void test_single_nested() { + const char *s = "abc {{ l start }}some content {{ var }} {{ l end }}"; + + ltm_template *template; + TEST_CHECK(ltm_template_compile(&template, s) == ltm_err_ok); + + TEST_CHECK(template->names.len == 1); + TEST_CHECK(template->names.arr[0].name.s == s + 7); + TEST_CHECK(template->names.arr[0].name.len == 1); + TEST_CHECK(template->names.arr[0].index == 1); + + TEST_CHECK(template->blocks.len == 2); + + TEST_CHECK(template->blocks.arr[0].type == ltm_template_block_type_literal); + TEST_CHECK(template->blocks.arr[0].data.ptr == s); + TEST_CHECK(template->blocks.arr[0].data.len == 4); + + TEST_CHECK(template->blocks.arr[1].type == ltm_template_block_type_nested); + ltm_template *nested_template = template->blocks.arr[1].data.ptr; + + TEST_CHECK(nested_template->blocks.len == 3); + TEST_CHECK(nested_template->blocks.arr[0].type == ltm_template_block_type_literal); + TEST_CHECK(nested_template->blocks.arr[0].data.ptr == s + 17); + TEST_CHECK(nested_template->blocks.arr[0].data.len == 13); + TEST_CHECK(nested_template->blocks.arr[1].type == ltm_template_block_type_var); + TEST_CHECK(nested_template->blocks.arr[2].type == ltm_template_block_type_literal); + TEST_CHECK(nested_template->blocks.arr[2].data.ptr == s + 39); + TEST_CHECK(nested_template->blocks.arr[2].data.len == 1); + + TEST_CHECK(nested_template->names.len == 1); + TEST_CHECK(nested_template->names.arr[0].name.s == s + 33); + TEST_CHECK(nested_template->names.arr[0].name.len == 3); + TEST_CHECK(nested_template->names.arr[0].index == 1); + + ltm_template_free(template); +} + +void test_unclosed_placeholder() { + ltm_template *template; + + const char *s = "abc {{ var }"; + TEST_CHECK(ltm_template_compile(&template, s) == ltm_err_invalid_template); + + s = "abc {{ var "; + TEST_CHECK(ltm_template_compile(&template, s) == ltm_err_invalid_template); +} + +void test_unclosed_nested() { + ltm_template *template; + + const char *s = "abc {{ var start }} {{ hello }}"; + TEST_CHECK(ltm_template_compile(&template, s) == ltm_err_invalid_template); +} + +TEST_LIST = { + { "template single placeholder", test_single_placeholder }, + { "template single placeholder trailing", test_single_placeholder_trailing }, + { "template single nested", test_single_nested }, + { "template unclosed placeholder", test_unclosed_placeholder }, + { "template unclosed nested", test_unclosed_nested }, + { NULL, NULL } +}; diff --git a/ltm/test/test.h b/ltm/test/test.h new file mode 100644 index 0000000..9ab8f88 --- /dev/null +++ b/ltm/test/test.h @@ -0,0 +1,1839 @@ +/* + * Acutest -- Another C/C++ Unit Test facility + * + * + * Copyright 2013-2020 Martin Mitas + * Copyright 2019 Garrett D'Amore + * + * 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 use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#ifndef ACUTEST_H +#define ACUTEST_H + + +/************************ + *** Public interface *** + ************************/ + +/* By default, "acutest.h" provides the main program entry point (function + * main()). However, if the test suite is composed of multiple source files + * which include "acutest.h", then this causes a problem of multiple main() + * definitions. To avoid this problem, #define macro TEST_NO_MAIN in all + * compilation units but one. + */ + +/* Macro to specify list of unit tests in the suite. + * The unit test implementation MUST provide list of unit tests it implements + * with this macro: + * + * TEST_LIST = { + * { "test1_name", test1_func_ptr }, + * { "test2_name", test2_func_ptr }, + * ... + * { NULL, NULL } // zeroed record marking the end of the list + * }; + * + * The list specifies names of each test (must be unique) and pointer to + * a function implementing it. The function does not take any arguments + * and has no return values, i.e. every test function has to be compatible + * with this prototype: + * + * void test_func(void); + * + * Note the list has to be ended with a zeroed record. + */ +#define TEST_LIST const struct acutest_test_ acutest_list_[] + + +/* Macros for testing whether an unit test succeeds or fails. These macros + * can be used arbitrarily in functions implementing the unit tests. + * + * If any condition fails throughout execution of a test, the test fails. + * + * TEST_CHECK takes only one argument (the condition), TEST_CHECK_ allows + * also to specify an error message to print out if the condition fails. + * (It expects printf-like format string and its parameters). The macros + * return non-zero (condition passes) or 0 (condition fails). + * + * That can be useful when more conditions should be checked only if some + * preceding condition passes, as illustrated in this code snippet: + * + * SomeStruct* ptr = allocate_some_struct(); + * if(TEST_CHECK(ptr != NULL)) { + * TEST_CHECK(ptr->member1 < 100); + * TEST_CHECK(ptr->member2 > 200); + * } + */ +#define TEST_CHECK_(cond,...) acutest_check_((cond), __FILE__, __LINE__, __VA_ARGS__) +#define TEST_CHECK(cond) acutest_check_((cond), __FILE__, __LINE__, "%s", #cond) + + +/* These macros are the same as TEST_CHECK_ and TEST_CHECK except that if the + * condition fails, the currently executed unit test is immediately aborted. + * + * That is done either by calling abort() if the unit test is executed as a + * child process; or via longjmp() if the unit test is executed within the + * main Acutest process. + * + * As a side effect of such abortion, your unit tests may cause memory leaks, + * unflushed file descriptors, and other phenomena caused by the abortion. + * + * Therefore you should not use these as a general replacement for TEST_CHECK. + * Use it with some caution, especially if your test causes some other side + * effects to the outside world (e.g. communicating with some server, inserting + * into a database etc.). + */ +#define TEST_ASSERT_(cond,...) \ + do { \ + if(!acutest_check_((cond), __FILE__, __LINE__, __VA_ARGS__)) \ + acutest_abort_(); \ + } while(0) +#define TEST_ASSERT(cond) \ + do { \ + if(!acutest_check_((cond), __FILE__, __LINE__, "%s", #cond)) \ + acutest_abort_(); \ + } while(0) + + +#ifdef __cplusplus +/* Macros to verify that the code (the 1st argument) throws exception of given + * type (the 2nd argument). (Note these macros are only available in C++.) + * + * TEST_EXCEPTION_ is like TEST_EXCEPTION but accepts custom printf-like + * message. + * + * For example: + * + * TEST_EXCEPTION(function_that_throw(), ExpectedExceptionType); + * + * If the function_that_throw() throws ExpectedExceptionType, the check passes. + * If the function throws anything incompatible with ExpectedExceptionType + * (or if it does not thrown an exception at all), the check fails. + */ +#define TEST_EXCEPTION(code, exctype) \ + do { \ + bool exc_ok_ = false; \ + const char *msg_ = NULL; \ + try { \ + code; \ + msg_ = "No exception thrown."; \ + } catch(exctype const&) { \ + exc_ok_= true; \ + } catch(...) { \ + msg_ = "Unexpected exception thrown."; \ + } \ + acutest_check_(exc_ok_, __FILE__, __LINE__, #code " throws " #exctype);\ + if(msg_ != NULL) \ + acutest_message_("%s", msg_); \ + } while(0) +#define TEST_EXCEPTION_(code, exctype, ...) \ + do { \ + bool exc_ok_ = false; \ + const char *msg_ = NULL; \ + try { \ + code; \ + msg_ = "No exception thrown."; \ + } catch(exctype const&) { \ + exc_ok_= true; \ + } catch(...) { \ + msg_ = "Unexpected exception thrown."; \ + } \ + acutest_check_(exc_ok_, __FILE__, __LINE__, __VA_ARGS__); \ + if(msg_ != NULL) \ + acutest_message_("%s", msg_); \ + } while(0) +#endif /* #ifdef __cplusplus */ + + +/* Sometimes it is useful to split execution of more complex unit tests to some + * smaller parts and associate those parts with some names. + * + * This is especially handy if the given unit test is implemented as a loop + * over some vector of multiple testing inputs. Using these macros allow to use + * sort of subtitle for each iteration of the loop (e.g. outputting the input + * itself or a name associated to it), so that if any TEST_CHECK condition + * fails in the loop, it can be easily seen which iteration triggers the + * failure, without the need to manually output the iteration-specific data in + * every single TEST_CHECK inside the loop body. + * + * TEST_CASE allows to specify only single string as the name of the case, + * TEST_CASE_ provides all the power of printf-like string formatting. + * + * Note that the test cases cannot be nested. Starting a new test case ends + * implicitly the previous one. To end the test case explicitly (e.g. to end + * the last test case after exiting the loop), you may use TEST_CASE(NULL). + */ +#define TEST_CASE_(...) acutest_case_(__VA_ARGS__) +#define TEST_CASE(name) acutest_case_("%s", name) + + +/* Maximal output per TEST_CASE call. Longer messages are cut. + * You may define another limit prior including "acutest.h" + */ +#ifndef TEST_CASE_MAXSIZE +#define TEST_CASE_MAXSIZE 64 +#endif + + +/* printf-like macro for outputting an extra information about a failure. + * + * Intended use is to output some computed output versus the expected value, + * e.g. like this: + * + * if(!TEST_CHECK(produced == expected)) { + * TEST_MSG("Expected: %d", expected); + * TEST_MSG("Produced: %d", produced); + * } + * + * Note the message is only written down if the most recent use of any checking + * macro (like e.g. TEST_CHECK or TEST_EXCEPTION) in the current test failed. + * This means the above is equivalent to just this: + * + * TEST_CHECK(produced == expected); + * TEST_MSG("Expected: %d", expected); + * TEST_MSG("Produced: %d", produced); + * + * The macro can deal with multi-line output fairly well. It also automatically + * adds a final new-line if there is none present. + */ +#define TEST_MSG(...) acutest_message_(__VA_ARGS__) + + +/* Maximal output per TEST_MSG call. Longer messages are cut. + * You may define another limit prior including "acutest.h" + */ +#ifndef TEST_MSG_MAXSIZE +#define TEST_MSG_MAXSIZE 1024 +#endif + + +/* Macro for dumping a block of memory. + * + * Its intended use is very similar to what TEST_MSG is for, but instead of + * generating any printf-like message, this is for dumping raw block of a + * memory in a hexadecimal form: + * + * TEST_CHECK(size_produced == size_expected && + * memcmp(addr_produced, addr_expected, size_produced) == 0); + * TEST_DUMP("Expected:", addr_expected, size_expected); + * TEST_DUMP("Produced:", addr_produced, size_produced); + */ +#define TEST_DUMP(title, addr, size) acutest_dump_(title, addr, size) + +/* Maximal output per TEST_DUMP call (in bytes to dump). Longer blocks are cut. + * You may define another limit prior including "acutest.h" + */ +#ifndef TEST_DUMP_MAXSIZE +#define TEST_DUMP_MAXSIZE 1024 +#endif + + +/* Common test initialiation/clean-up + * + * In some test suites, it may be needed to perform some sort of the same + * initialization and/or clean-up in all the tests. + * + * Such test suites may use macros TEST_INIT and/or TEST_FINI prior including + * this header. The expansion of the macro is then used as a body of helper + * function called just before executing every single (TEST_INIT) or just after + * it ends (TEST_FINI). + * + * Examples of various ways how to use the macro TEST_INIT: + * + * #define TEST_INIT my_init_func(); + * #define TEST_INIT my_init_func() // Works even without the semicolon + * #define TEST_INIT setlocale(LC_ALL, NULL); + * #define TEST_INIT { setlocale(LC_ALL, NULL); my_init_func(); } + * + * TEST_FINI is to be used in the same way. + */ + + +/********************** + *** Implementation *** + **********************/ + +/* The unit test files should not rely on anything below. */ + +#include +#include +#include +#include +#include +#include + +#if defined(unix) || defined(__unix__) || defined(__unix) || defined(__APPLE__) +#define ACUTEST_UNIX_ 1 +#include +#include +#include +#include +#include +#include +#include + +#if defined CLOCK_PROCESS_CPUTIME_ID && defined CLOCK_MONOTONIC +#define ACUTEST_HAS_POSIX_TIMER_ 1 +#endif +#endif + +#if defined(_gnu_linux_) || defined(__linux__) +#define ACUTEST_LINUX_ 1 +#include +#include +#endif + +#if defined(_WIN32) || defined(__WIN32__) || defined(__WINDOWS__) +#define ACUTEST_WIN_ 1 + #include + #include +#endif + +#if defined(__APPLE__) +#define ACUTEST_MACOS_ + #include + #include + #include + #include + #include +#endif + +#ifdef __cplusplus +#include +#endif + +#ifdef __has_include +#if __has_include() +#include +#endif +#endif + +/* Enable the use of the non-standard keyword __attribute__ to silence warnings under some compilers */ +#if defined(__GNUC__) || defined(__clang__) +#define ACUTEST_ATTRIBUTE_(attr) __attribute__((attr)) +#else +#define ACUTEST_ATTRIBUTE_(attr) +#endif + +/* Note our global private identifiers end with '_' to mitigate risk of clash + * with the unit tests implementation. */ + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef _MSC_VER +/* In the multi-platform code like ours, we cannot use the non-standard + * "safe" functions from Microsoft C lib like e.g. sprintf_s() instead of + * standard sprintf(). Hence, lets disable the warning C4996. */ + #pragma warning(push) + #pragma warning(disable: 4996) +#endif + + +struct acutest_test_ { + const char* name; + void (*func)(void); +}; + +struct acutest_test_data_ { + unsigned char flags; + double duration; +}; + +enum { + ACUTEST_FLAG_RUN_ = 1 << 0, + ACUTEST_FLAG_SUCCESS_ = 1 << 1, + ACUTEST_FLAG_FAILURE_ = 1 << 2, +}; + +extern const struct acutest_test_ acutest_list_[]; + +int acutest_check_(int cond, const char* file, int line, const char* fmt, ...); +void acutest_case_(const char* fmt, ...); +void acutest_message_(const char* fmt, ...); +void acutest_dump_(const char* title, const void* addr, size_t size); +void acutest_abort_(void) ACUTEST_ATTRIBUTE_(noreturn); + + +#ifndef TEST_NO_MAIN + +static char* acutest_argv0_ = NULL; +static size_t acutest_list_size_ = 0; +static struct acutest_test_data_* acutest_test_data_ = NULL; +static size_t acutest_count_ = 0; +static int acutest_no_exec_ = -1; +static int acutest_no_summary_ = 0; +static int acutest_tap_ = 0; +static int acutest_skip_mode_ = 0; +static int acutest_worker_ = 0; +static int acutest_worker_index_ = 0; +static int acutest_cond_failed_ = 0; +static int acutest_was_aborted_ = 0; +static FILE *acutest_xml_output_ = NULL; + +static int acutest_stat_failed_units_ = 0; +static int acutest_stat_run_units_ = 0; + +static const struct acutest_test_* acutest_current_test_ = NULL; +static int acutest_current_index_ = 0; +static char acutest_case_name_[TEST_CASE_MAXSIZE] = ""; +static int acutest_test_already_logged_ = 0; +static int acutest_case_already_logged_ = 0; +static int acutest_verbose_level_ = 2; +static int acutest_test_failures_ = 0; +static int acutest_colorize_ = 0; +static int acutest_timer_ = 0; + +static int acutest_abort_has_jmp_buf_ = 0; +static jmp_buf acutest_abort_jmp_buf_; + + +static void +acutest_cleanup_(void) +{ + free((void*) acutest_test_data_); +} + +static void ACUTEST_ATTRIBUTE_(noreturn) +acutest_exit_(int exit_code) +{ + acutest_cleanup_(); + exit(exit_code); +} + +#if defined ACUTEST_WIN_ +typedef LARGE_INTEGER acutest_timer_type_; + static LARGE_INTEGER acutest_timer_freq_; + static acutest_timer_type_ acutest_timer_start_; + static acutest_timer_type_ acutest_timer_end_; + + static void + acutest_timer_init_(void) + { + QueryPerformanceFrequency(´st_timer_freq_); + } + + static void + acutest_timer_get_time_(LARGE_INTEGER* ts) + { + QueryPerformanceCounter(ts); + } + + static double + acutest_timer_diff_(LARGE_INTEGER start, LARGE_INTEGER end) + { + double duration = (double)(end.QuadPart - start.QuadPart); + duration /= (double)acutest_timer_freq_.QuadPart; + return duration; + } + + static void + acutest_timer_print_diff_(void) + { + printf("%.6lf secs", acutest_timer_diff_(acutest_timer_start_, acutest_timer_end_)); + } +#elif defined ACUTEST_HAS_POSIX_TIMER_ +static clockid_t acutest_timer_id_; +typedef struct timespec acutest_timer_type_; +static acutest_timer_type_ acutest_timer_start_; +static acutest_timer_type_ acutest_timer_end_; + +static void +acutest_timer_init_(void) +{ + if(acutest_timer_ == 1) + acutest_timer_id_ = CLOCK_MONOTONIC; + else if(acutest_timer_ == 2) + acutest_timer_id_ = CLOCK_PROCESS_CPUTIME_ID; +} + +static void +acutest_timer_get_time_(struct timespec* ts) +{ + clock_gettime(acutest_timer_id_, ts); +} + +static double +acutest_timer_diff_(struct timespec start, struct timespec end) +{ + double endns; + double startns; + + endns = end.tv_sec; + endns *= 1e9; + endns += end.tv_nsec; + + startns = start.tv_sec; + startns *= 1e9; + startns += start.tv_nsec; + + return ((endns - startns)/ 1e9); +} + +static void +acutest_timer_print_diff_(void) +{ + printf("%.6lf secs", + acutest_timer_diff_(acutest_timer_start_, acutest_timer_end_)); +} +#else +typedef int acutest_timer_type_; + static acutest_timer_type_ acutest_timer_start_; + static acutest_timer_type_ acutest_timer_end_; + + void + acutest_timer_init_(void) + {} + + static void + acutest_timer_get_time_(int* ts) + { + (void) ts; + } + + static double + acutest_timer_diff_(int start, int end) + { + (void) start; + (void) end; + return 0.0; + } + + static void + acutest_timer_print_diff_(void) + {} +#endif + +#define ACUTEST_COLOR_DEFAULT_ 0 +#define ACUTEST_COLOR_GREEN_ 1 +#define ACUTEST_COLOR_RED_ 2 +#define ACUTEST_COLOR_DEFAULT_INTENSIVE_ 3 +#define ACUTEST_COLOR_GREEN_INTENSIVE_ 4 +#define ACUTEST_COLOR_RED_INTENSIVE_ 5 + +static int ACUTEST_ATTRIBUTE_(format (printf, 2, 3)) +acutest_colored_printf_(int color, const char* fmt, ...) +{ + va_list args; + char buffer[256]; + int n; + + va_start(args, fmt); + vsnprintf(buffer, sizeof(buffer), fmt, args); + va_end(args); + buffer[sizeof(buffer)-1] = '\0'; + + if(!acutest_colorize_) { + return printf("%s", buffer); + } + +#if defined ACUTEST_UNIX_ + { + const char* col_str; + switch(color) { + case ACUTEST_COLOR_GREEN_: col_str = "\033[0;32m"; break; + case ACUTEST_COLOR_RED_: col_str = "\033[0;31m"; break; + case ACUTEST_COLOR_GREEN_INTENSIVE_: col_str = "\033[1;32m"; break; + case ACUTEST_COLOR_RED_INTENSIVE_: col_str = "\033[1;31m"; break; + case ACUTEST_COLOR_DEFAULT_INTENSIVE_: col_str = "\033[1m"; break; + default: col_str = "\033[0m"; break; + } + printf("%s", col_str); + n = printf("%s", buffer); + printf("\033[0m"); + return n; + } +#elif defined ACUTEST_WIN_ + { + HANDLE h; + CONSOLE_SCREEN_BUFFER_INFO info; + WORD attr; + + h = GetStdHandle(STD_OUTPUT_HANDLE); + GetConsoleScreenBufferInfo(h, &info); + + switch(color) { + case ACUTEST_COLOR_GREEN_: attr = FOREGROUND_GREEN; break; + case ACUTEST_COLOR_RED_: attr = FOREGROUND_RED; break; + case ACUTEST_COLOR_GREEN_INTENSIVE_: attr = FOREGROUND_GREEN | FOREGROUND_INTENSITY; break; + case ACUTEST_COLOR_RED_INTENSIVE_: attr = FOREGROUND_RED | FOREGROUND_INTENSITY; break; + case ACUTEST_COLOR_DEFAULT_INTENSIVE_: attr = FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY; break; + default: attr = 0; break; + } + if(attr != 0) + SetConsoleTextAttribute(h, attr); + n = printf("%s", buffer); + SetConsoleTextAttribute(h, info.wAttributes); + return n; + } +#else + n = printf("%s", buffer); + return n; +#endif +} + +static void +acutest_begin_test_line_(const struct acutest_test_* test) +{ + if(!acutest_tap_) { + if(acutest_verbose_level_ >= 3) { + acutest_colored_printf_(ACUTEST_COLOR_DEFAULT_INTENSIVE_, "Test %s:\n", test->name); + acutest_test_already_logged_++; + } else if(acutest_verbose_level_ >= 1) { + int n; + char spaces[48]; + + n = acutest_colored_printf_(ACUTEST_COLOR_DEFAULT_INTENSIVE_, "Test %s... ", test->name); + memset(spaces, ' ', sizeof(spaces)); + if(n < (int) sizeof(spaces)) + printf("%.*s", (int) sizeof(spaces) - n, spaces); + } else { + acutest_test_already_logged_ = 1; + } + } +} + +static void +acutest_finish_test_line_(int result) +{ + if(acutest_tap_) { + const char* str = (result == 0) ? "ok" : "not ok"; + + printf("%s %d - %s\n", str, acutest_current_index_ + 1, acutest_current_test_->name); + + if(result == 0 && acutest_timer_) { + printf("# Duration: "); + acutest_timer_print_diff_(); + printf("\n"); + } + } else { + int color = (result == 0) ? ACUTEST_COLOR_GREEN_INTENSIVE_ : ACUTEST_COLOR_RED_INTENSIVE_; + const char* str = (result == 0) ? "OK" : "FAILED"; + printf("[ "); + acutest_colored_printf_(color, "%s", str); + printf(" ]"); + + if(result == 0 && acutest_timer_) { + printf(" "); + acutest_timer_print_diff_(); + } + + printf("\n"); + } +} + +static void +acutest_line_indent_(int level) +{ + static const char spaces[] = " "; + int n = level * 2; + + if(acutest_tap_ && n > 0) { + n--; + printf("#"); + } + + while(n > 16) { + printf("%s", spaces); + n -= 16; + } + printf("%.*s", n, spaces); +} + +int ACUTEST_ATTRIBUTE_(format (printf, 4, 5)) +acutest_check_(int cond, const char* file, int line, const char* fmt, ...) +{ + const char *result_str; + int result_color; + int verbose_level; + + if(cond) { + result_str = "ok"; + result_color = ACUTEST_COLOR_GREEN_; + verbose_level = 3; + } else { + if(!acutest_test_already_logged_ && acutest_current_test_ != NULL) + acutest_finish_test_line_(-1); + + result_str = "failed"; + result_color = ACUTEST_COLOR_RED_; + verbose_level = 2; + acutest_test_failures_++; + acutest_test_already_logged_++; + } + + if(acutest_verbose_level_ >= verbose_level) { + va_list args; + + if(!acutest_case_already_logged_ && acutest_case_name_[0]) { + acutest_line_indent_(1); + acutest_colored_printf_(ACUTEST_COLOR_DEFAULT_INTENSIVE_, "Case %s:\n", acutest_case_name_); + acutest_test_already_logged_++; + acutest_case_already_logged_++; + } + + acutest_line_indent_(acutest_case_name_[0] ? 2 : 1); + if(file != NULL) { +#ifdef ACUTEST_WIN_ + const char* lastsep1 = strrchr(file, '\\'); + const char* lastsep2 = strrchr(file, '/'); + if(lastsep1 == NULL) + lastsep1 = file-1; + if(lastsep2 == NULL) + lastsep2 = file-1; + file = (lastsep1 > lastsep2 ? lastsep1 : lastsep2) + 1; +#else + const char* lastsep = strrchr(file, '/'); + if(lastsep != NULL) + file = lastsep+1; +#endif + printf("%s:%d: Check ", file, line); + } + + va_start(args, fmt); + vprintf(fmt, args); + va_end(args); + + printf("... "); + acutest_colored_printf_(result_color, "%s", result_str); + printf("\n"); + acutest_test_already_logged_++; + } + + acutest_cond_failed_ = (cond == 0); + return !acutest_cond_failed_; +} + +void ACUTEST_ATTRIBUTE_(format (printf, 1, 2)) +acutest_case_(const char* fmt, ...) +{ + va_list args; + + if(acutest_verbose_level_ < 2) + return; + + if(acutest_case_name_[0]) { + acutest_case_already_logged_ = 0; + acutest_case_name_[0] = '\0'; + } + + if(fmt == NULL) + return; + + va_start(args, fmt); + vsnprintf(acutest_case_name_, sizeof(acutest_case_name_) - 1, fmt, args); + va_end(args); + acutest_case_name_[sizeof(acutest_case_name_) - 1] = '\0'; + + if(acutest_verbose_level_ >= 3) { + acutest_line_indent_(1); + acutest_colored_printf_(ACUTEST_COLOR_DEFAULT_INTENSIVE_, "Case %s:\n", acutest_case_name_); + acutest_test_already_logged_++; + acutest_case_already_logged_++; + } +} + +void ACUTEST_ATTRIBUTE_(format (printf, 1, 2)) +acutest_message_(const char* fmt, ...) +{ + char buffer[TEST_MSG_MAXSIZE]; + char* line_beg; + char* line_end; + va_list args; + + if(acutest_verbose_level_ < 2) + return; + + /* We allow extra message only when something is already wrong in the + * current test. */ + if(acutest_current_test_ == NULL || !acutest_cond_failed_) + return; + + va_start(args, fmt); + vsnprintf(buffer, TEST_MSG_MAXSIZE, fmt, args); + va_end(args); + buffer[TEST_MSG_MAXSIZE-1] = '\0'; + + line_beg = buffer; + while(1) { + line_end = strchr(line_beg, '\n'); + if(line_end == NULL) + break; + acutest_line_indent_(acutest_case_name_[0] ? 3 : 2); + printf("%.*s\n", (int)(line_end - line_beg), line_beg); + line_beg = line_end + 1; + } + if(line_beg[0] != '\0') { + acutest_line_indent_(acutest_case_name_[0] ? 3 : 2); + printf("%s\n", line_beg); + } +} + +void +acutest_dump_(const char* title, const void* addr, size_t size) +{ + static const size_t BYTES_PER_LINE = 16; + size_t line_beg; + size_t truncate = 0; + + if(acutest_verbose_level_ < 2) + return; + + /* We allow extra message only when something is already wrong in the + * current test. */ + if(acutest_current_test_ == NULL || !acutest_cond_failed_) + return; + + if(size > TEST_DUMP_MAXSIZE) { + truncate = size - TEST_DUMP_MAXSIZE; + size = TEST_DUMP_MAXSIZE; + } + + acutest_line_indent_(acutest_case_name_[0] ? 3 : 2); + printf((title[strlen(title)-1] == ':') ? "%s\n" : "%s:\n", title); + + for(line_beg = 0; line_beg < size; line_beg += BYTES_PER_LINE) { + size_t line_end = line_beg + BYTES_PER_LINE; + size_t off; + + acutest_line_indent_(acutest_case_name_[0] ? 4 : 3); + printf("%08lx: ", (unsigned long)line_beg); + for(off = line_beg; off < line_end; off++) { + if(off < size) + printf(" %02x", ((const unsigned char*)addr)[off]); + else + printf(" "); + } + + printf(" "); + for(off = line_beg; off < line_end; off++) { + unsigned char byte = ((const unsigned char*)addr)[off]; + if(off < size) + printf("%c", (iscntrl(byte) ? '.' : byte)); + else + break; + } + + printf("\n"); + } + + if(truncate > 0) { + acutest_line_indent_(acutest_case_name_[0] ? 4 : 3); + printf(" ... (and more %u bytes)\n", (unsigned) truncate); + } +} + +/* This is called just before each test */ +static void +acutest_init_(const char *test_name) +{ +#ifdef TEST_INIT + TEST_INIT + ; /* Allow for a single unterminated function call */ +#endif + + /* Suppress any warnings about unused variable. */ + (void) test_name; +} + +/* This is called after each test */ +static void +acutest_fini_(const char *test_name) +{ +#ifdef TEST_FINI + TEST_FINI + ; /* Allow for a single unterminated function call */ +#endif + + /* Suppress any warnings about unused variable. */ + (void) test_name; +} + +void +acutest_abort_(void) +{ + if(acutest_abort_has_jmp_buf_) { + longjmp(acutest_abort_jmp_buf_, 1); + } else { + if(acutest_current_test_ != NULL) + acutest_fini_(acutest_current_test_->name); + abort(); + } +} + +static void +acutest_list_names_(void) +{ + const struct acutest_test_* test; + + printf("Unit tests:\n"); + for(test = ´st_list_[0]; test->func != NULL; test++) + printf(" %s\n", test->name); +} + +static void +acutest_remember_(int i) +{ + if(acutest_test_data_[i].flags & ACUTEST_FLAG_RUN_) + return; + + acutest_test_data_[i].flags |= ACUTEST_FLAG_RUN_; + acutest_count_++; +} + +static void +acutest_set_success_(int i, int success) +{ + acutest_test_data_[i].flags |= success ? ACUTEST_FLAG_SUCCESS_ : ACUTEST_FLAG_FAILURE_; +} + +static void +acutest_set_duration_(int i, double duration) +{ + acutest_test_data_[i].duration = duration; +} + +static int +acutest_name_contains_word_(const char* name, const char* pattern) +{ + static const char word_delim[] = " \t-_/.,:;"; + const char* substr; + size_t pattern_len; + + pattern_len = strlen(pattern); + + substr = strstr(name, pattern); + while(substr != NULL) { + int starts_on_word_boundary = (substr == name || strchr(word_delim, substr[-1]) != NULL); + int ends_on_word_boundary = (substr[pattern_len] == '\0' || strchr(word_delim, substr[pattern_len]) != NULL); + + if(starts_on_word_boundary && ends_on_word_boundary) + return 1; + + substr = strstr(substr+1, pattern); + } + + return 0; +} + +static int +acutest_lookup_(const char* pattern) +{ + int i; + int n = 0; + + /* Try exact match. */ + for(i = 0; i < (int) acutest_list_size_; i++) { + if(strcmp(acutest_list_[i].name, pattern) == 0) { + acutest_remember_(i); + n++; + break; + } + } + if(n > 0) + return n; + + /* Try word match. */ + for(i = 0; i < (int) acutest_list_size_; i++) { + if(acutest_name_contains_word_(acutest_list_[i].name, pattern)) { + acutest_remember_(i); + n++; + } + } + if(n > 0) + return n; + + /* Try relaxed match. */ + for(i = 0; i < (int) acutest_list_size_; i++) { + if(strstr(acutest_list_[i].name, pattern) != NULL) { + acutest_remember_(i); + n++; + } + } + + return n; +} + + +/* Called if anything goes bad in Acutest, or if the unit test ends in other + * way then by normal returning from its function (e.g. exception or some + * abnormal child process termination). */ +static void ACUTEST_ATTRIBUTE_(format (printf, 1, 2)) +acutest_error_(const char* fmt, ...) +{ + if(acutest_verbose_level_ == 0) + return; + + if(acutest_verbose_level_ >= 2) { + va_list args; + + acutest_line_indent_(1); + if(acutest_verbose_level_ >= 3) + acutest_colored_printf_(ACUTEST_COLOR_RED_INTENSIVE_, "ERROR: "); + va_start(args, fmt); + vprintf(fmt, args); + va_end(args); + printf("\n"); + } + + if(acutest_verbose_level_ >= 3) { + printf("\n"); + } +} + +/* Call directly the given test unit function. */ +static int +acutest_do_run_(const struct acutest_test_* test, int index) +{ + int status = -1; + + acutest_was_aborted_ = 0; + acutest_current_test_ = test; + acutest_current_index_ = index; + acutest_test_failures_ = 0; + acutest_test_already_logged_ = 0; + acutest_cond_failed_ = 0; + +#ifdef __cplusplus + try { +#endif + acutest_init_(test->name); + acutest_begin_test_line_(test); + + /* This is good to do in case the test unit crashes. */ + fflush(stdout); + fflush(stderr); + + if(!acutest_worker_) { + acutest_abort_has_jmp_buf_ = 1; + if(setjmp(acutest_abort_jmp_buf_) != 0) { + acutest_was_aborted_ = 1; + goto aborted; + } + } + + acutest_timer_get_time_(´st_timer_start_); + test->func(); + aborted: + acutest_abort_has_jmp_buf_ = 0; + acutest_timer_get_time_(´st_timer_end_); + + if(acutest_verbose_level_ >= 3) { + acutest_line_indent_(1); + if(acutest_test_failures_ == 0) { + acutest_colored_printf_(ACUTEST_COLOR_GREEN_INTENSIVE_, "SUCCESS: "); + printf("All conditions have passed.\n"); + + if(acutest_timer_) { + acutest_line_indent_(1); + printf("Duration: "); + acutest_timer_print_diff_(); + printf("\n"); + } + } else { + acutest_colored_printf_(ACUTEST_COLOR_RED_INTENSIVE_, "FAILED: "); + if(!acutest_was_aborted_) { + printf("%d condition%s %s failed.\n", + acutest_test_failures_, + (acutest_test_failures_ == 1) ? "" : "s", + (acutest_test_failures_ == 1) ? "has" : "have"); + } else { + printf("Aborted.\n"); + } + } + printf("\n"); + } else if(acutest_verbose_level_ >= 1 && acutest_test_failures_ == 0) { + acutest_finish_test_line_(0); + } + + status = (acutest_test_failures_ == 0) ? 0 : -1; + +#ifdef __cplusplus + } catch(std::exception& e) { + const char* what = e.what(); + acutest_check_(0, NULL, 0, "Threw std::exception"); + if(what != NULL) + acutest_message_("std::exception::what(): %s", what); + + if(acutest_verbose_level_ >= 3) { + acutest_line_indent_(1); + acutest_colored_printf_(ACUTEST_COLOR_RED_INTENSIVE_, "FAILED: "); + printf("C++ exception.\n\n"); + } + } catch(...) { + acutest_check_(0, NULL, 0, "Threw an exception"); + + if(acutest_verbose_level_ >= 3) { + acutest_line_indent_(1); + acutest_colored_printf_(ACUTEST_COLOR_RED_INTENSIVE_, "FAILED: "); + printf("C++ exception.\n\n"); + } + } +#endif + + acutest_fini_(test->name); + acutest_case_(NULL); + acutest_current_test_ = NULL; + + return status; +} + +/* Trigger the unit test. If possible (and not suppressed) it starts a child + * process who calls acutest_do_run_(), otherwise it calls acutest_do_run_() + * directly. */ +static void +acutest_run_(const struct acutest_test_* test, int index, int master_index) +{ + int failed = 1; + acutest_timer_type_ start, end; + + acutest_current_test_ = test; + acutest_test_already_logged_ = 0; + acutest_timer_get_time_(&start); + + if(!acutest_no_exec_) { + +#if defined(ACUTEST_UNIX_) + + pid_t pid; + int exit_code; + + /* Make sure the child starts with empty I/O buffers. */ + fflush(stdout); + fflush(stderr); + + pid = fork(); + if(pid == (pid_t)-1) { + acutest_error_("Cannot fork. %s [%d]", strerror(errno), errno); + failed = 1; + } else if(pid == 0) { + /* Child: Do the test. */ + acutest_worker_ = 1; + failed = (acutest_do_run_(test, index) != 0); + acutest_exit_(failed ? 1 : 0); + } else { + /* Parent: Wait until child terminates and analyze its exit code. */ + waitpid(pid, &exit_code, 0); + if(WIFEXITED(exit_code)) { + switch(WEXITSTATUS(exit_code)) { + case 0: failed = 0; break; /* test has passed. */ + case 1: /* noop */ break; /* "normal" failure. */ + default: acutest_error_("Unexpected exit code [%d]", WEXITSTATUS(exit_code)); + } + } else if(WIFSIGNALED(exit_code)) { + char tmp[32]; + const char* signame; + switch(WTERMSIG(exit_code)) { + case SIGINT: signame = "SIGINT"; break; + case SIGHUP: signame = "SIGHUP"; break; + case SIGQUIT: signame = "SIGQUIT"; break; + case SIGABRT: signame = "SIGABRT"; break; + case SIGKILL: signame = "SIGKILL"; break; + case SIGSEGV: signame = "SIGSEGV"; break; + case SIGILL: signame = "SIGILL"; break; + case SIGTERM: signame = "SIGTERM"; break; + default: sprintf(tmp, "signal %d", WTERMSIG(exit_code)); signame = tmp; break; + } + acutest_error_("Test interrupted by %s.", signame); + } else { + acutest_error_("Test ended in an unexpected way [%d].", exit_code); + } + } + +#elif defined(ACUTEST_WIN_) + + char buffer[512] = {0}; + STARTUPINFOA startupInfo; + PROCESS_INFORMATION processInfo; + DWORD exitCode; + + /* Windows has no fork(). So we propagate all info into the child + * through a command line arguments. */ + _snprintf(buffer, sizeof(buffer)-1, + "%s --worker=%d %s --no-exec --no-summary %s --verbose=%d --color=%s -- \"%s\"", + acutest_argv0_, index, acutest_timer_ ? "--time" : "", + acutest_tap_ ? "--tap" : "", acutest_verbose_level_, + acutest_colorize_ ? "always" : "never", + test->name); + memset(&startupInfo, 0, sizeof(startupInfo)); + startupInfo.cb = sizeof(STARTUPINFO); + if(CreateProcessA(NULL, buffer, NULL, NULL, FALSE, 0, NULL, NULL, &startupInfo, &processInfo)) { + WaitForSingleObject(processInfo.hProcess, INFINITE); + GetExitCodeProcess(processInfo.hProcess, &exitCode); + CloseHandle(processInfo.hThread); + CloseHandle(processInfo.hProcess); + failed = (exitCode != 0); + if(exitCode > 1) { + switch(exitCode) { + case 3: acutest_error_("Aborted."); break; + case 0xC0000005: acutest_error_("Access violation."); break; + default: acutest_error_("Test ended in an unexpected way [%lu].", exitCode); break; + } + } + } else { + acutest_error_("Cannot create unit test subprocess [%ld].", GetLastError()); + failed = 1; + } + +#else + + /* A platform where we don't know how to run child process. */ + failed = (acutest_do_run_(test, index) != 0); + +#endif + + } else { + /* Child processes suppressed through --no-exec. */ + failed = (acutest_do_run_(test, index) != 0); + } + acutest_timer_get_time_(&end); + + acutest_current_test_ = NULL; + + acutest_stat_run_units_++; + if(failed) + acutest_stat_failed_units_++; + + acutest_set_success_(master_index, !failed); + acutest_set_duration_(master_index, acutest_timer_diff_(start, end)); +} + +#if defined(ACUTEST_WIN_) +/* Callback for SEH events. */ +static LONG CALLBACK +acutest_seh_exception_filter_(EXCEPTION_POINTERS *ptrs) +{ + acutest_check_(0, NULL, 0, "Unhandled SEH exception"); + acutest_message_("Exception code: 0x%08lx", ptrs->ExceptionRecord->ExceptionCode); + acutest_message_("Exception address: 0x%p", ptrs->ExceptionRecord->ExceptionAddress); + + fflush(stdout); + fflush(stderr); + + return EXCEPTION_EXECUTE_HANDLER; +} +#endif + + +#define ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ 0x0001 +#define ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_ 0x0002 + +#define ACUTEST_CMDLINE_OPTID_NONE_ 0 +#define ACUTEST_CMDLINE_OPTID_UNKNOWN_ (-0x7fffffff + 0) +#define ACUTEST_CMDLINE_OPTID_MISSINGARG_ (-0x7fffffff + 1) +#define ACUTEST_CMDLINE_OPTID_BOGUSARG_ (-0x7fffffff + 2) + +typedef struct acutest_test_CMDLINE_OPTION_ { + char shortname; + const char* longname; + int id; + unsigned flags; +} ACUTEST_CMDLINE_OPTION_; + +static int +acutest_cmdline_handle_short_opt_group_(const ACUTEST_CMDLINE_OPTION_* options, + const char* arggroup, + int (*callback)(int /*optval*/, const char* /*arg*/)) +{ + const ACUTEST_CMDLINE_OPTION_* opt; + int i; + int ret = 0; + + for(i = 0; arggroup[i] != '\0'; i++) { + for(opt = options; opt->id != 0; opt++) { + if(arggroup[i] == opt->shortname) + break; + } + + if(opt->id != 0 && !(opt->flags & ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_)) { + ret = callback(opt->id, NULL); + } else { + /* Unknown option. */ + char badoptname[3]; + badoptname[0] = '-'; + badoptname[1] = arggroup[i]; + badoptname[2] = '\0'; + ret = callback((opt->id != 0 ? ACUTEST_CMDLINE_OPTID_MISSINGARG_ : ACUTEST_CMDLINE_OPTID_UNKNOWN_), + badoptname); + } + + if(ret != 0) + break; + } + + return ret; +} + +#define ACUTEST_CMDLINE_AUXBUF_SIZE_ 32 + +static int +acutest_cmdline_read_(const ACUTEST_CMDLINE_OPTION_* options, int argc, char** argv, + int (*callback)(int /*optval*/, const char* /*arg*/)) +{ + + const ACUTEST_CMDLINE_OPTION_* opt; + char auxbuf[ACUTEST_CMDLINE_AUXBUF_SIZE_+1]; + int after_doubledash = 0; + int i = 1; + int ret = 0; + + auxbuf[ACUTEST_CMDLINE_AUXBUF_SIZE_] = '\0'; + + while(i < argc) { + if(after_doubledash || strcmp(argv[i], "-") == 0) { + /* Non-option argument. */ + ret = callback(ACUTEST_CMDLINE_OPTID_NONE_, argv[i]); + } else if(strcmp(argv[i], "--") == 0) { + /* End of options. All the remaining members are non-option arguments. */ + after_doubledash = 1; + } else if(argv[i][0] != '-') { + /* Non-option argument. */ + ret = callback(ACUTEST_CMDLINE_OPTID_NONE_, argv[i]); + } else { + for(opt = options; opt->id != 0; opt++) { + if(opt->longname != NULL && strncmp(argv[i], "--", 2) == 0) { + size_t len = strlen(opt->longname); + if(strncmp(argv[i]+2, opt->longname, len) == 0) { + /* Regular long option. */ + if(argv[i][2+len] == '\0') { + /* with no argument provided. */ + if(!(opt->flags & ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_)) + ret = callback(opt->id, NULL); + else + ret = callback(ACUTEST_CMDLINE_OPTID_MISSINGARG_, argv[i]); + break; + } else if(argv[i][2+len] == '=') { + /* with an argument provided. */ + if(opt->flags & (ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ | ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_)) { + ret = callback(opt->id, argv[i]+2+len+1); + } else { + sprintf(auxbuf, "--%s", opt->longname); + ret = callback(ACUTEST_CMDLINE_OPTID_BOGUSARG_, auxbuf); + } + break; + } else { + continue; + } + } + } else if(opt->shortname != '\0' && argv[i][0] == '-') { + if(argv[i][1] == opt->shortname) { + /* Regular short option. */ + if(opt->flags & ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_) { + if(argv[i][2] != '\0') + ret = callback(opt->id, argv[i]+2); + else if(i+1 < argc) + ret = callback(opt->id, argv[++i]); + else + ret = callback(ACUTEST_CMDLINE_OPTID_MISSINGARG_, argv[i]); + break; + } else { + ret = callback(opt->id, NULL); + + /* There might be more (argument-less) short options + * grouped together. */ + if(ret == 0 && argv[i][2] != '\0') + ret = acutest_cmdline_handle_short_opt_group_(options, argv[i]+2, callback); + break; + } + } + } + } + + if(opt->id == 0) { /* still not handled? */ + if(argv[i][0] != '-') { + /* Non-option argument. */ + ret = callback(ACUTEST_CMDLINE_OPTID_NONE_, argv[i]); + } else { + /* Unknown option. */ + char* badoptname = argv[i]; + + if(strncmp(badoptname, "--", 2) == 0) { + /* Strip any argument from the long option. */ + char* assignment = strchr(badoptname, '='); + if(assignment != NULL) { + size_t len = assignment - badoptname; + if(len > ACUTEST_CMDLINE_AUXBUF_SIZE_) + len = ACUTEST_CMDLINE_AUXBUF_SIZE_; + strncpy(auxbuf, badoptname, len); + auxbuf[len] = '\0'; + badoptname = auxbuf; + } + } + + ret = callback(ACUTEST_CMDLINE_OPTID_UNKNOWN_, badoptname); + } + } + } + + if(ret != 0) + return ret; + i++; + } + + return ret; +} + +static void +acutest_help_(void) +{ + printf("Usage: %s [options] [test...]\n", acutest_argv0_); + printf("\n"); + printf("Run the specified unit tests; or if the option '--skip' is used, run all\n"); + printf("tests in the suite but those listed. By default, if no tests are specified\n"); + printf("on the command line, all unit tests in the suite are run.\n"); + printf("\n"); + printf("Options:\n"); + printf(" -s, --skip Execute all unit tests but the listed ones\n"); + printf(" --exec[=WHEN] If supported, execute unit tests as child processes\n"); + printf(" (WHEN is one of 'auto', 'always', 'never')\n"); + printf(" -E, --no-exec Same as --exec=never\n"); +#if defined ACUTEST_WIN_ + printf(" -t, --time Measure test duration\n"); +#elif defined ACUTEST_HAS_POSIX_TIMER_ + printf(" -t, --time Measure test duration (real time)\n"); + printf(" --time=TIMER Measure test duration, using given timer\n"); + printf(" (TIMER is one of 'real', 'cpu')\n"); +#endif + printf(" --no-summary Suppress printing of test results summary\n"); + printf(" --tap Produce TAP-compliant output\n"); + printf(" (See https://testanything.org/)\n"); + printf(" -x, --xml-output=FILE Enable XUnit output to the given file\n"); + printf(" -l, --list List unit tests in the suite and exit\n"); + printf(" -v, --verbose Make output more verbose\n"); + printf(" --verbose=LEVEL Set verbose level to LEVEL:\n"); + printf(" 0 ... Be silent\n"); + printf(" 1 ... Output one line per test (and summary)\n"); + printf(" 2 ... As 1 and failed conditions (this is default)\n"); + printf(" 3 ... As 1 and all conditions (and extended summary)\n"); + printf(" -q, --quiet Same as --verbose=0\n"); + printf(" --color[=WHEN] Enable colorized output\n"); + printf(" (WHEN is one of 'auto', 'always', 'never')\n"); + printf(" --no-color Same as --color=never\n"); + printf(" -h, --help Display this help and exit\n"); + + if(acutest_list_size_ < 16) { + printf("\n"); + acutest_list_names_(); + } +} + +static const ACUTEST_CMDLINE_OPTION_ acutest_cmdline_options_[] = { + { 's', "skip", 's', 0 }, + { 0, "exec", 'e', ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ }, + { 'E', "no-exec", 'E', 0 }, +#if defined ACUTEST_WIN_ + { 't', "time", 't', 0 }, + { 0, "timer", 't', 0 }, /* kept for compatibility */ +#elif defined ACUTEST_HAS_POSIX_TIMER_ + { 't', "time", 't', ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ }, + { 0, "timer", 't', ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ }, /* kept for compatibility */ +#endif + { 0, "no-summary", 'S', 0 }, + { 0, "tap", 'T', 0 }, + { 'l', "list", 'l', 0 }, + { 'v', "verbose", 'v', ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ }, + { 'q', "quiet", 'q', 0 }, + { 0, "color", 'c', ACUTEST_CMDLINE_OPTFLAG_OPTIONALARG_ }, + { 0, "no-color", 'C', 0 }, + { 'h', "help", 'h', 0 }, + { 0, "worker", 'w', ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_ }, /* internal */ + { 'x', "xml-output", 'x', ACUTEST_CMDLINE_OPTFLAG_REQUIREDARG_ }, + { 0, NULL, 0, 0 } +}; + +static int +acutest_cmdline_callback_(int id, const char* arg) +{ + switch(id) { + case 's': + acutest_skip_mode_ = 1; + break; + + case 'e': + if(arg == NULL || strcmp(arg, "always") == 0) { + acutest_no_exec_ = 0; + } else if(strcmp(arg, "never") == 0) { + acutest_no_exec_ = 1; + } else if(strcmp(arg, "auto") == 0) { + /*noop*/ + } else { + fprintf(stderr, "%s: Unrecognized argument '%s' for option --exec.\n", acutest_argv0_, arg); + fprintf(stderr, "Try '%s --help' for more information.\n", acutest_argv0_); + acutest_exit_(2); + } + break; + + case 'E': + acutest_no_exec_ = 1; + break; + + case 't': +#if defined ACUTEST_WIN_ || defined ACUTEST_HAS_POSIX_TIMER_ + if(arg == NULL || strcmp(arg, "real") == 0) { + acutest_timer_ = 1; +#ifndef ACUTEST_WIN_ + } else if(strcmp(arg, "cpu") == 0) { + acutest_timer_ = 2; +#endif + } else { + fprintf(stderr, "%s: Unrecognized argument '%s' for option --time.\n", acutest_argv0_, arg); + fprintf(stderr, "Try '%s --help' for more information.\n", acutest_argv0_); + acutest_exit_(2); + } +#endif + break; + + case 'S': + acutest_no_summary_ = 1; + break; + + case 'T': + acutest_tap_ = 1; + break; + + case 'l': + acutest_list_names_(); + acutest_exit_(0); + break; + + case 'v': + acutest_verbose_level_ = (arg != NULL ? atoi(arg) : acutest_verbose_level_+1); + break; + + case 'q': + acutest_verbose_level_ = 0; + break; + + case 'c': + if(arg == NULL || strcmp(arg, "always") == 0) { + acutest_colorize_ = 1; + } else if(strcmp(arg, "never") == 0) { + acutest_colorize_ = 0; + } else if(strcmp(arg, "auto") == 0) { + /*noop*/ + } else { + fprintf(stderr, "%s: Unrecognized argument '%s' for option --color.\n", acutest_argv0_, arg); + fprintf(stderr, "Try '%s --help' for more information.\n", acutest_argv0_); + acutest_exit_(2); + } + break; + + case 'C': + acutest_colorize_ = 0; + break; + + case 'h': + acutest_help_(); + acutest_exit_(0); + break; + + case 'w': + acutest_worker_ = 1; + acutest_worker_index_ = atoi(arg); + break; + case 'x': + acutest_xml_output_ = fopen(arg, "w"); + if (!acutest_xml_output_) { + fprintf(stderr, "Unable to open '%s': %s\n", arg, strerror(errno)); + acutest_exit_(2); + } + break; + + case 0: + if(acutest_lookup_(arg) == 0) { + fprintf(stderr, "%s: Unrecognized unit test '%s'\n", acutest_argv0_, arg); + fprintf(stderr, "Try '%s --list' for list of unit tests.\n", acutest_argv0_); + acutest_exit_(2); + } + break; + + case ACUTEST_CMDLINE_OPTID_UNKNOWN_: + fprintf(stderr, "Unrecognized command line option '%s'.\n", arg); + fprintf(stderr, "Try '%s --help' for more information.\n", acutest_argv0_); + acutest_exit_(2); + break; + + case ACUTEST_CMDLINE_OPTID_MISSINGARG_: + fprintf(stderr, "The command line option '%s' requires an argument.\n", arg); + fprintf(stderr, "Try '%s --help' for more information.\n", acutest_argv0_); + acutest_exit_(2); + break; + + case ACUTEST_CMDLINE_OPTID_BOGUSARG_: + fprintf(stderr, "The command line option '%s' does not expect an argument.\n", arg); + fprintf(stderr, "Try '%s --help' for more information.\n", acutest_argv0_); + acutest_exit_(2); + break; + } + + return 0; +} + + +#ifdef ACUTEST_LINUX_ +static int +acutest_is_tracer_present_(void) +{ + /* Must be large enough so the line 'TracerPid: ${PID}' can fit in. */ + static const int OVERLAP = 32; + + char buf[512]; + int tracer_present = 0; + int fd; + size_t n_read = 0; + + fd = open("/proc/self/status", O_RDONLY); + if(fd == -1) + return 0; + + while(1) { + static const char pattern[] = "TracerPid:"; + const char* field; + + while(n_read < sizeof(buf) - 1) { + ssize_t n; + + n = read(fd, buf + n_read, sizeof(buf) - 1 - n_read); + if(n <= 0) + break; + n_read += n; + } + buf[n_read] = '\0'; + + field = strstr(buf, pattern); + if(field != NULL && field < buf + sizeof(buf) - OVERLAP) { + pid_t tracer_pid = (pid_t) atoi(field + sizeof(pattern) - 1); + tracer_present = (tracer_pid != 0); + break; + } + + if(n_read == sizeof(buf) - 1) { + /* Move the tail with the potentially incomplete line we're looking + * for to the beginning of the buffer. */ + memmove(buf, buf + sizeof(buf) - 1 - OVERLAP, OVERLAP); + n_read = OVERLAP; + } else { + break; + } + } + + close(fd); + return tracer_present; +} +#endif + +#ifdef ACUTEST_MACOS_ +static bool +acutest_AmIBeingDebugged(void) +{ + int junk; + int mib[4]; + struct kinfo_proc info; + size_t size; + + // Initialize the flags so that, if sysctl fails for some bizarre + // reason, we get a predictable result. + info.kp_proc.p_flag = 0; + + // Initialize mib, which tells sysctl the info we want, in this case + // we're looking for information about a specific process ID. + mib[0] = CTL_KERN; + mib[1] = KERN_PROC; + mib[2] = KERN_PROC_PID; + mib[3] = getpid(); + + // Call sysctl. + size = sizeof(info); + junk = sysctl(mib, sizeof(mib) / sizeof(*mib), &info, &size, NULL, 0); + assert(junk == 0); + + // We're being debugged if the P_TRACED flag is set. + return ( (info.kp_proc.p_flag & P_TRACED) != 0 ); +} +#endif + +int +main(int argc, char** argv) +{ + int i; + + acutest_argv0_ = argv[0]; + +#if defined ACUTEST_UNIX_ + acutest_colorize_ = isatty(STDOUT_FILENO); +#elif defined ACUTEST_WIN_ + #if defined _BORLANDC_ + acutest_colorize_ = isatty(_fileno(stdout)); + #else + acutest_colorize_ = _isatty(_fileno(stdout)); + #endif +#else + acutest_colorize_ = 0; +#endif + + /* Count all test units */ + acutest_list_size_ = 0; + for(i = 0; acutest_list_[i].func != NULL; i++) + acutest_list_size_++; + + acutest_test_data_ = (struct acutest_test_data_*)calloc(acutest_list_size_, sizeof(struct acutest_test_data_)); + if(acutest_test_data_ == NULL) { + fprintf(stderr, "Out of memory.\n"); + acutest_exit_(2); + } + + /* Parse options */ + acutest_cmdline_read_(acutest_cmdline_options_, argc, argv, acutest_cmdline_callback_); + + /* Initialize the proper timer. */ + acutest_timer_init_(); + +#if defined(ACUTEST_WIN_) + SetUnhandledExceptionFilter(acutest_seh_exception_filter_); +#ifdef _MSC_VER + _set_abort_behavior(0, _WRITE_ABORT_MSG); +#endif +#endif + + /* By default, we want to run all tests. */ + if(acutest_count_ == 0) { + for(i = 0; acutest_list_[i].func != NULL; i++) + acutest_remember_(i); + } + + /* Guess whether we want to run unit tests as child processes. */ + if(acutest_no_exec_ < 0) { + acutest_no_exec_ = 0; + + if(acutest_count_ <= 1) { + acutest_no_exec_ = 1; + } else { +#ifdef ACUTEST_WIN_ + if(IsDebuggerPresent()) + acutest_no_exec_ = 1; +#endif +#ifdef ACUTEST_LINUX_ + if(acutest_is_tracer_present_()) + acutest_no_exec_ = 1; +#endif +#ifdef ACUTEST_MACOS_ + if(acutest_AmIBeingDebugged()) + acutest_no_exec_ = 1; +#endif +#ifdef RUNNING_ON_VALGRIND + /* RUNNING_ON_VALGRIND is provided by optionally included */ + if(RUNNING_ON_VALGRIND) + acutest_no_exec_ = 1; +#endif + } + } + + if(acutest_tap_) { + /* TAP requires we know test result ("ok", "not ok") before we output + * anything about the test, and this gets problematic for larger verbose + * levels. */ + if(acutest_verbose_level_ > 2) + acutest_verbose_level_ = 2; + + /* TAP harness should provide some summary. */ + acutest_no_summary_ = 1; + + if(!acutest_worker_) + printf("1..%d\n", (int) acutest_count_); + } + + int index = acutest_worker_index_; + for(i = 0; acutest_list_[i].func != NULL; i++) { + int run = (acutest_test_data_[i].flags & ACUTEST_FLAG_RUN_); + if (acutest_skip_mode_) /* Run all tests except those listed. */ + run = !run; + if(run) + acutest_run_(´st_list_[i], index++, i); + } + + /* Write a summary */ + if(!acutest_no_summary_ && acutest_verbose_level_ >= 1) { + if(acutest_verbose_level_ >= 3) { + acutest_colored_printf_(ACUTEST_COLOR_DEFAULT_INTENSIVE_, "Summary:\n"); + + printf(" Count of all unit tests: %4d\n", (int) acutest_list_size_); + printf(" Count of run unit tests: %4d\n", acutest_stat_run_units_); + printf(" Count of failed unit tests: %4d\n", acutest_stat_failed_units_); + printf(" Count of skipped unit tests: %4d\n", (int) acutest_list_size_ - acutest_stat_run_units_); + } + + if(acutest_stat_failed_units_ == 0) { + acutest_colored_printf_(ACUTEST_COLOR_GREEN_INTENSIVE_, "SUCCESS:"); + printf(" All unit tests have passed.\n"); + } else { + acutest_colored_printf_(ACUTEST_COLOR_RED_INTENSIVE_, "FAILED:"); + printf(" %d of %d unit tests %s failed.\n", + acutest_stat_failed_units_, acutest_stat_run_units_, + (acutest_stat_failed_units_ == 1) ? "has" : "have"); + } + + if(acutest_verbose_level_ >= 3) + printf("\n"); + } + + if (acutest_xml_output_) { +#if defined ACUTEST_UNIX_ + char *suite_name = basename(argv[0]); +#elif defined ACUTEST_WIN_ + char suite_name[_MAX_FNAME]; + _splitpath(argv[0], NULL, NULL, suite_name, NULL); +#else + const char *suite_name = argv[0]; +#endif + fprintf(acutest_xml_output_, "\n"); + fprintf(acutest_xml_output_, "\n", + suite_name, (int)acutest_list_size_, acutest_stat_failed_units_, acutest_stat_failed_units_, + (int)acutest_list_size_ - acutest_stat_run_units_); + for(i = 0; acutest_list_[i].func != NULL; i++) { + struct acutest_test_data_ *details = ´st_test_data_[i]; + fprintf(acutest_xml_output_, " \n", acutest_list_[i].name, details->duration); + if (details->flags & ACUTEST_FLAG_FAILURE_) + fprintf(acutest_xml_output_, " \n"); + if (!(details->flags & ACUTEST_FLAG_FAILURE_) && !(details->flags & ACUTEST_FLAG_SUCCESS_)) + fprintf(acutest_xml_output_, " \n"); + fprintf(acutest_xml_output_, " \n"); + } + fprintf(acutest_xml_output_, "\n"); + fclose(acutest_xml_output_); + } + + acutest_cleanup_(); + + return (acutest_stat_failed_units_ == 0) ? 0 : 1; +} + + +#endif /* #ifndef TEST_NO_MAIN */ + +#ifdef _MSC_VER +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /* #ifndef ACUTEST_H */ diff --git a/src/lander/lander.c b/src/lander/lander.c index ff44b5c..0225837 100644 --- a/src/lander/lander.c +++ b/src/lander/lander.c @@ -3,6 +3,7 @@ #include "lnm/common.h" #include "lsm/store.h" +#include "ltm/template.h" #include "lander.h" @@ -29,6 +30,12 @@ void lander_ctx_reset(lander_ctx *ctx) { ctx->entry = NULL; } + + if (ctx->instance != NULL) { + ltm_instance_free(ctx->instance); + + ctx->instance = NULL; + } } void lander_ctx_free(lander_ctx *ctx) { free(ctx); } diff --git a/src/lander/lander_get.c b/src/lander/lander_get.c index 0e90086..1cbc772 100644 --- a/src/lander/lander_get.c +++ b/src/lander/lander_get.c @@ -8,6 +8,7 @@ #include "lsm/store.h" #include "lander.h" +#include "ltm/template.h" static const char index_page[] = "\n" @@ -19,7 +20,7 @@ static const char index_page[] = " \n" "\n"; -lnm_http_step_err lander_get_index(lnm_http_conn *conn) { +lnm_http_step_err lander_get_root(lnm_http_conn *conn) { lnm_http_loop_ctx *ctx = conn->ctx; lnm_http_res_body_set_buf(&ctx->res, (char *)index_page, @@ -72,13 +73,43 @@ lnm_err lander_entry_data_streamer(uint64_t *written, char *buf, return lnm_err_ok; } -lnm_http_step_err lander_get_paste(lnm_http_conn *conn) { +lnm_err lander_template_streamer(size_t *written, char *buf, + lnm_http_conn *conn, uint64_t offset, + uint64_t len) { lnm_http_loop_ctx *ctx = conn->ctx; lander_ctx *c_ctx = ctx->c; - lnm_http_res_body_set_fn(&ctx->res, lander_entry_data_streamer, - lsm_entry_data_len(c_ctx->entry)); - lnm_http_res_add_header(&ctx->res, lnm_http_header_content_type, "text/plain", + // TODO respect offset variable + + ltm_instance_write(written, buf, len, c_ctx->instance); + + return lnm_err_ok; +} + +ltm_err lander_data_to_template(size_t *written, char *buf, size_t len, + void *data) { + lsm_entry_handle *entry = data; + + lsm_entry_data_read(written, buf, entry, len); + + return ltm_err_ok; +} + +lnm_http_step_err lander_get_paste(lnm_http_conn *conn) { + lnm_http_loop_ctx *ctx = conn->ctx; + lander_gctx *c_gctx = ctx->g->c; + lander_ctx *c_ctx = ctx->c; + + ltm_template_instantiate(&c_ctx->instance, c_gctx->templates.paste); + /* ltm_instance_block_add_var(c_ctx->instance, ltm_instance_block_type_buf, + * lsm_str_ptr(c_ctx->entry)) */ + ltm_instance_block_add_var_fn(c_ctx->instance, "paste", + lander_data_to_template, c_ctx->entry, + lsm_entry_data_len(c_ctx->entry)); + + lnm_http_res_body_set_fn(&ctx->res, lander_template_streamer, + ltm_instance_size(c_ctx->instance)); + lnm_http_res_add_header(&ctx->res, lnm_http_header_content_type, "text/html", false); return lnm_http_step_err_done; @@ -112,6 +143,93 @@ lnm_http_step_err lander_get_file(lnm_http_conn *conn) { return lnm_http_step_err_done; } +lnm_http_step_err lander_get_index(lnm_http_conn *conn) { + lnm_http_loop_ctx *ctx = conn->ctx; + lander_gctx *c_gctx = ctx->g->c; + lander_ctx *c_ctx = ctx->c; + + ltm_template_instantiate(&c_ctx->instance, c_gctx->templates.index); + + const lsm_str *key; + lsm_entry_key(&key, c_ctx->entry); + + ltm_instance_block_add_var(c_ctx->instance, "title_key", + ltm_instance_block_type_buf, + (void *)lsm_str_ptr(key), lsm_str_len(key)); + + lsm_str *prefix; + lsm_str_init_copy_n(&prefix, lsm_str_ptr(key), lsm_str_len(key)); + lsm_str_append_c(prefix, "_", 1); + + uint64_t prefix_len = lsm_str_len(prefix); + + lsm_store_iterator *iter; + lsm_store_iter(&iter, c_gctx->store, prefix); + + lsm_entry_handle *handle; + while (lsm_store_iter_next_read(&handle, iter) == lsm_error_ok) { + const lsm_str *entry_key; + lsm_entry_key(&entry_key, handle); + + lander_entry_type t; + lsm_entry_attr_get_uint8_t((uint8_t *)&t, handle, + lander_attr_type_entry_type); + + ltm_instance *nested; + + switch (t) { + case lander_entry_type_redirect: + ltm_instance_block_add_nested(&nested, c_ctx->instance, "redirect"); + + ltm_instance_block_add_var( + nested, "full_key", ltm_instance_block_type_buf, + (void *)lsm_str_ptr(entry_key), lsm_str_len(entry_key)); + ltm_instance_block_add_var(nested, "short_key", + ltm_instance_block_type_buf, + (void *)(lsm_str_ptr(entry_key) + prefix_len), + lsm_str_len(entry_key) - prefix_len); + break; + case lander_entry_type_file: + case lander_entry_type_paste: + ltm_instance_block_add_nested(&nested, c_ctx->instance, + t == lander_entry_type_file ? "file" + : "paste"); + + ltm_instance_block_add_var( + nested, "full_key", ltm_instance_block_type_buf, + (void *)lsm_str_ptr(entry_key), lsm_str_len(entry_key)); + + // Add the filename as the link name if known, or just the key otherwise + lsm_str *filename; + if (lsm_entry_attr_get(&filename, handle, lander_attr_type_file_name) == + lsm_error_ok) { + ltm_instance_block_add_var( + nested, "filename", ltm_instance_block_type_buf, + (void *)lsm_str_ptr(filename), lsm_str_len(filename)); + } else { + ltm_instance_block_add_var( + nested, "filename", ltm_instance_block_type_buf, + (void *)(lsm_str_ptr(entry_key) + prefix_len), + lsm_str_len(entry_key) - prefix_len); + } + break; + } + + // TODO this should be done after writing the template + lsm_entry_close(handle); + } + + lnm_http_res_body_set_fn(&ctx->res, lander_template_streamer, + ltm_instance_size(c_ctx->instance)); + lnm_http_res_add_header(&ctx->res, lnm_http_header_content_type, "text/html", + false); + + lsm_store_iter_free(iter); + lsm_str_free(prefix); + + return lnm_http_step_err_done; +} + lnm_http_step_err lander_get_entry(lnm_http_conn *conn) { lnm_http_loop_ctx *ctx = conn->ctx; lander_ctx *c_ctx = ctx->c; @@ -153,6 +271,9 @@ lnm_http_step_err lander_get_entry(lnm_http_conn *conn) { case lander_entry_type_file: res = lander_get_file(conn); break; + case lander_entry_type_index: + res = lander_get_index(conn); + break; } return res; diff --git a/src/lander/lander_post.c b/src/lander/lander_post.c index 1244cb7..d30eb69 100644 --- a/src/lander/lander_post.c +++ b/src/lander/lander_post.c @@ -124,3 +124,21 @@ lnm_http_step_err lander_post_file(lnm_http_conn *conn) { return lnm_http_step_err_done; } + +lnm_http_step_err lander_post_index(lnm_http_conn *conn) { + lnm_http_loop_ctx *ctx = conn->ctx; + lander_ctx *c_ctx = ctx->c; + + if (!lander_insert_entry(ctx)) { + return lnm_http_step_err_res; + } + + lsm_entry_attr_insert_uint8_t(c_ctx->entry, lander_attr_type_entry_type, + lander_entry_type_index); + /* lander_header_to_attr(ctx, "X-Lander-Content-Type", */ + /* lander_attr_type_content_type); */ + /* lander_header_to_attr(ctx, "X-Lander-Filename", + * lander_attr_type_file_name); */ + + return lnm_http_step_err_done; +} diff --git a/src/main.c b/src/main.c index 6cacf84..c2dea68 100644 --- a/src/main.c +++ b/src/main.c @@ -4,11 +4,46 @@ #include "lnm/http/loop.h" #include "lnm/log.h" +#include "ltm/template.h" #include "lander.h" #include "log.h" const char *lander_server = "lander/" LANDER_VERSION; +const char *paste_template = + "\n" + "\n" + "\n" + "\n" + "

{{ header }}

{{ paste }}
"; + +const char *index_template = + "\n" + "\n" + "

Index /{{ title_key }}

\n" + "

Redirects

\n" + "
    \n" + "{{ redirect start }}\n" + "
  • {{ short_key }}
    • \n" + "{{ redirect end }}\n" + "
\n" + "

Files

" + "
    \n" + "{{ file start }}\n" + "
  • {{ filename }}
    • \n" + "{{ file end }}\n" + "
\n" + "

Pastes

\n" + "
    \n" + "{{ paste start }}\n" + "
  • {{ filename }}
    • \n" + "{{ paste end }}\n" + "
\n" + "\n"; lnm_http_loop *loop_init(lander_gctx *gctx, const char *api_key) { lnm_http_loop *hl; @@ -20,7 +55,7 @@ lnm_http_loop *loop_init(lander_gctx *gctx, const char *api_key) { lnm_http_loop_set_api_key(hl, api_key); lnm_http_loop_set_server(hl, lander_server); - lnm_http_step_init(&step, lander_get_index); + lnm_http_step_init(&step, lander_get_root); lnm_http_route_init_literal(&route, lnm_http_method_get, "/", step); lnm_http_loop_route_add(hl, route); @@ -50,6 +85,14 @@ lnm_http_loop *loop_init(lander_gctx *gctx, const char *api_key) { lnm_http_step_append(&step, step, lander_stream_body_to_entry); lnm_http_loop_route_add(hl, route); + lnm_http_step_init(&step, lnm_http_loop_step_auth); + lnm_http_route_init_regex(&route, lnm_http_method_post, "^/i(l?)/([^/]+)$", 2, + step); + lnm_http_step_append(&step, step, lander_post_index); + /* lnm_http_step_append(&step, step, lnm_http_loop_step_body_to_buf); */ + /* lnm_http_step_append(&step, step, lander_post_redirect_body_to_attr); */ + lnm_http_loop_route_add(hl, route); + lnm_http_step_init(&step, lnm_http_loop_step_auth); lnm_http_route_init_regex(&route, lnm_http_method_delete, "^/([^/]+)$", 1, step); @@ -92,6 +135,9 @@ int main() { lander_gctx *c_gctx = lander_gctx_init(); c_gctx->data_dir = data_dir_s; + ltm_template_compile(&c_gctx->templates.paste, paste_template); + ltm_template_compile(&c_gctx->templates.index, index_template); + lsm_str *data_dir; lsm_str_init_copy(&data_dir, (char *)data_dir_s);