Fri, 20 Dec 2024 16:55:23 +0100
add missing documentation in iterator.h
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright 2023 Mike Becker, Olaf Wintermann All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #include "cx/common.h" #include "cx/test.h" CxTestSuite *cx_test_suite_testing_allocator(void); CxTestSuite *cx_test_suite_szmul(void); CxTestSuite *cx_test_suite_allocator(void); CxTestSuite *cx_test_suite_streams(void); CxTestSuite *cx_test_suite_compare(void); CxTestSuite *cx_test_suite_string(void); CxTestSuite *cx_test_suite_buffer(void); CxTestSuite *cx_test_suite_hash_key(void); CxTestSuite *cx_test_suite_hash_map(void); CxTestSuite *cx_test_suite_iterator(void); CxTestSuite *cx_test_suite_empty_list(void); CxTestSuite *cx_test_suite_array_list(void); CxTestSuite *cx_test_suite_array_list_defaulted_funcs(void); CxTestSuite *cx_test_suite_linked_list(void); CxTestSuite *cx_test_suite_linked_list_defaulted_funcs(void); CxTestSuite *cx_test_suite_tree_low_level(void); CxTestSuite *cx_test_suite_tree_high_level(void); CxTestSuite *cx_test_suite_properties(void); CxTestSuite *cx_test_suite_json(void); CxTestSuite *cx_test_suite_printf(void); CxTestSuite *cx_test_suite_mempool(void); #define run_tests(suite) cx_test_run_stdout(suite); success += (suite)->success; failure += (suite)->failure #define execute_test_suites(...) unsigned success = 0, failure = 0; CxTestSuite* test_suites[] = {__VA_ARGS__}; \ for (size_t i = 0; i < cx_nmemb(test_suites) ; i++) {run_tests(test_suites[i]);} (void)0 #define free_test_suites for (size_t i = 0 ; i < cx_nmemb(test_suites) ; i++) {cx_test_suite_free(test_suites[i]);} (void)0 int main(void) { printf("UCX Tests\n---------\n"); execute_test_suites( cx_test_suite_testing_allocator(), cx_test_suite_szmul(), cx_test_suite_allocator(), cx_test_suite_streams(), cx_test_suite_compare(), cx_test_suite_string(), cx_test_suite_buffer(), cx_test_suite_hash_key(), cx_test_suite_hash_map(), cx_test_suite_iterator(), cx_test_suite_empty_list(), cx_test_suite_array_list(), cx_test_suite_array_list_defaulted_funcs(), cx_test_suite_linked_list(), cx_test_suite_linked_list_defaulted_funcs(), cx_test_suite_tree_low_level(), cx_test_suite_tree_high_level(), cx_test_suite_properties(), cx_test_suite_mempool(), cx_test_suite_json(), cx_test_suite_printf() ); printf("=== OVERALL RESULT ===\n"); printf(" Total: %u\n Success: %u\n Failure: %u\n", success + failure, success, failure); free_test_suites; return failure > 0 ? 1 : 0; }