diff --git a/README.md b/README.md index 0c33ab0..9381fb1 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,6 @@ All file names, function names... (even internals) should follow snake case convention and have a prefix unique to that module, starting with `vieter_`. For example, the `cron` modules uses the `vieter_cron_` prefix for everything. -Header files should only import what they explicitely need. If some function is -only used in a .c file, the import should be placed in the .c file instead. - ### Testing This library uses [Acutest](https://github.com/mity/acutest) for its tests. diff --git a/include/vieter_cron.h b/include/vieter_cron.h index 81a2630..9088d4d 100644 --- a/include/vieter_cron.h +++ b/include/vieter_cron.h @@ -1,6 +1,7 @@ #ifndef VIETER_CRON #define VIETER_CRON +#include #include #include #include @@ -34,38 +35,18 @@ typedef struct vieter_cron_simple_time { int minute; } vieter_cron_simple_time; -/* - * Allocate and initialize a new empty cron expression. - */ vieter_cron_expression *ce_init(); -/* - * Deallocate a cron expression. - */ void vieter_cron_expr_free(vieter_cron_expression *ce); -/* - * Given a cron expression and a reference time, calculate the next time after - * the reference time that this expression matches. - */ void vieter_cron_expr_next(vieter_cron_simple_time *out, vieter_cron_expression *ce, vieter_cron_simple_time *ref); -/* - * Convencience wrapper around vieter_cron_expr_next that uses the current time - * as the reference time. - */ void vieter_cron_expr_next_from_now(vieter_cron_simple_time *out, vieter_cron_expression *ce); -/* - * Try to parse a string into a cron expression. Note that the cron expression - * is updated in-place, meaning it can contain invalid information if the - * function returns an error. The cron expression should only be used if the - * function succeeded. - */ -vieter_cron_parse_error vieter_cron_expr_parse(vieter_cron_expression *out, - const char *expression); +enum vieter_cron_parse_error vieter_cron_expr_parse(vieter_cron_expression *out, + const char *expression); #endif diff --git a/include/vieter_heap.h b/include/vieter_heap.h index 5d08ebc..c7a9706 100644 --- a/include/vieter_heap.h +++ b/include/vieter_heap.h @@ -1,6 +1,7 @@ #ifndef VIETER_HEAP #define VIETER_HEAP +#include #include typedef struct vieter_heap vieter_heap; @@ -10,35 +11,17 @@ typedef enum vieter_heap_error { vieter_heap_empty = 1 } vieter_heap_error; -/* - * Allocate and initalize an empty heap. - */ vieter_heap *vieter_heap_init(); -/* - * Deallocate a heap. - */ void vieter_heap_free(vieter_heap *heap); -/* - * Return how many elements are currently in the heap. - */ uint64_t vieter_heap_size(vieter_heap *heap); -/* - * Insert a new value into the heap. - */ vieter_heap_error vieter_heap_insert(vieter_heap *heap, uint64_t key, void *data); -/* - * Remove the smallest element from the heap. - */ vieter_heap_error vieter_heap_pop(void **out, vieter_heap *heap); -/* - * Get the smallest element in the heap without removing it. - */ vieter_heap_error vieter_heap_peek(void **out, vieter_heap *heap); #endif diff --git a/src/cron/vieter_cron_parse.c b/src/cron/vieter_cron_parse.c index a82d1c3..5c8da06 100644 --- a/src/cron/vieter_cron_parse.c +++ b/src/cron/vieter_cron_parse.c @@ -1,8 +1,4 @@ #include "vieter_cron.h" -#include -#include -#include -#include // This prefix is needed to properly compile const uint8_t parse_month_days[] = {31, 28, 31, 30, 31, 30,