diff --git a/.drone.yml b/.drone.yml index 2f5c690..9065622 100644 --- a/.drone.yml +++ b/.drone.yml @@ -38,7 +38,7 @@ name: tag steps: - name: Build release - image: registry.riba-interactive.de/alpine-build:1 + image: registry.riba-interactive.de/alpine-build:2 commands: - cmake -S. -Bcmake-build-ci -DCMAKE_BUILD_TYPE=Release - cd cmake-build-ci @@ -58,12 +58,12 @@ name: Build and Test steps: - name: Build and run tests - image: registry.riba-interactive.de/alpine-build:1 + image: registry.riba-interactive.de/alpine-build:2 commands: - cmake -S. -Bcmake-build-ci -DCMAKE_BUILD_TYPE=Debug -DENABLE_TEST_COVERAGE=on - cd cmake-build-ci - cmake --build . - - ctest -T Test -T Coverage + - make coverage - name: Report test and coverage image: alpine diff --git a/CMakeLists.txt b/CMakeLists.txt index 3450350..5023cf5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -18,9 +18,6 @@ option(ENABLE_TEST_COVERAGE "Enable test coverage" OFF) if (CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) set_property(GLOBAL PROPERTY USE_FOLDERS ON) include(CTest) - if (ENABLE_TEST_COVERAGE) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g -fprofile-arcs -ftest-coverage") - endif () endif () add_subdirectory(app) @@ -29,9 +26,17 @@ add_subdirectory(library/log) if ((CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME OR MODERN_CMAKE_BUILD_TESTING) AND BUILD_TESTING) - configure_file( - ${CMAKE_SOURCE_DIR}/CTestCustom.cmake - ${CMAKE_BINARY_DIR}/CTestCustom.cmake COPYONLY - ) add_subdirectory(tests) + + if (ENABLE_TEST_COVERAGE) + include(CodeCoverage) + + setup_target_for_coverage_lcov( + NAME coverage + EXECUTABLE ${CMAKE_CTEST_COMMAND} + EXCLUDE "tests/*" + LCOV_ARGS --rc lcov_branch_coverage=1 + GENHTML_ARGS --rc genhtml_branch_coverage=1 + ) + endif () endif () diff --git a/CTestCustom.cmake b/CTestCustom.cmake deleted file mode 100644 index ebf0384..0000000 --- a/CTestCustom.cmake +++ /dev/null @@ -1 +0,0 @@ -set(CTEST_CUSTOM_COVERAGE_EXCLUDE tests/) diff --git a/build/Dockerfile.build b/build/Dockerfile.build index 277cb5f..43a2f3a 100644 --- a/build/Dockerfile.build +++ b/build/Dockerfile.build @@ -1,7 +1,9 @@ FROM alpine:3.16.0 -RUN apk --no-cache add \ +RUN echo "@testing http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories; \ + apk --no-cache add \ bison \ build-base \ cmake \ - flex \ No newline at end of file + flex \ + lcov@testing \ No newline at end of file diff --git a/cmake/CodeCoverage.cmake b/cmake/CodeCoverage.cmake new file mode 100644 index 0000000..719be50 --- /dev/null +++ b/cmake/CodeCoverage.cmake @@ -0,0 +1,721 @@ +# Copyright (c) 2012 - 2017, Lars Bilke +# 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. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software without +# specific prior written permission. +# +# 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. +# +# CHANGES: +# +# 2012-01-31, Lars Bilke +# - Enable Code Coverage +# +# 2013-09-17, Joakim Söderberg +# - Added support for Clang. +# - Some additional usage instructions. +# +# 2016-02-03, Lars Bilke +# - Refactored functions to use named parameters +# +# 2017-06-02, Lars Bilke +# - Merged with modified version from github.com/ufz/ogs +# +# 2019-05-06, Anatolii Kurotych +# - Remove unnecessary --coverage flag +# +# 2019-12-13, FeRD (Frank Dana) +# - Deprecate COVERAGE_LCOVR_EXCLUDES and COVERAGE_GCOVR_EXCLUDES lists in favor +# of tool-agnostic COVERAGE_EXCLUDES variable, or EXCLUDE setup arguments. +# - CMake 3.4+: All excludes can be specified relative to BASE_DIRECTORY +# - All setup functions: accept BASE_DIRECTORY, EXCLUDE list +# - Set lcov basedir with -b argument +# - Add automatic --demangle-cpp in lcovr, if 'c++filt' is available (can be +# overridden with NO_DEMANGLE option in setup_target_for_coverage_lcovr().) +# - Delete output dir, .info file on 'make clean' +# - Remove Python detection, since version mismatches will break gcovr +# - Minor cleanup (lowercase function names, update examples...) +# +# 2019-12-19, FeRD (Frank Dana) +# - Rename Lcov outputs, make filtered file canonical, fix cleanup for targets +# +# 2020-01-19, Bob Apthorpe +# - Added gfortran support +# +# 2020-02-17, FeRD (Frank Dana) +# - Make all add_custom_target()s VERBATIM to auto-escape wildcard characters +# in EXCLUDEs, and remove manual escaping from gcovr targets +# +# 2021-01-19, Robin Mueller +# - Add CODE_COVERAGE_VERBOSE option which will allow to print out commands which are run +# - Added the option for users to set the GCOVR_ADDITIONAL_ARGS variable to supply additional +# flags to the gcovr command +# +# 2020-05-04, Mihchael Davis +# - Add -fprofile-abs-path to make gcno files contain absolute paths +# - Fix BASE_DIRECTORY not working when defined +# - Change BYPRODUCT from folder to index.html to stop ninja from complaining about double defines +# +# 2021-05-10, Martin Stump +# - Check if the generator is multi-config before warning about non-Debug builds +# +# 2022-02-22, Marko Wehle +# - Change gcovr output from -o for --xml and --html output respectively. +# This will allow for Multiple Output Formats at the same time by making use of GCOVR_ADDITIONAL_ARGS, e.g. GCOVR_ADDITIONAL_ARGS "--txt". +# +# USAGE: +# +# 1. Copy this file into your cmake modules path. +# +# 2. Add the following line to your CMakeLists.txt (best inside an if-condition +# using a CMake option() to enable it just optionally): +# include(CodeCoverage) +# +# 3. Append necessary compiler flags for all supported source files: +# append_coverage_compiler_flags() +# Or for specific target: +# append_coverage_compiler_flags_to_target(YOUR_TARGET_NAME) +# +# 3.a (OPTIONAL) Set appropriate optimization flags, e.g. -O0, -O1 or -Og +# +# 4. If you need to exclude additional directories from the report, specify them +# using full paths in the COVERAGE_EXCLUDES variable before calling +# setup_target_for_coverage_*(). +# Example: +# set(COVERAGE_EXCLUDES +# '${PROJECT_SOURCE_DIR}/src/dir1/*' +# '/path/to/my/src/dir2/*') +# Or, use the EXCLUDE argument to setup_target_for_coverage_*(). +# Example: +# setup_target_for_coverage_lcov( +# NAME coverage +# EXECUTABLE testrunner +# EXCLUDE "${PROJECT_SOURCE_DIR}/src/dir1/*" "/path/to/my/src/dir2/*") +# +# 4.a NOTE: With CMake 3.4+, COVERAGE_EXCLUDES or EXCLUDE can also be set +# relative to the BASE_DIRECTORY (default: PROJECT_SOURCE_DIR) +# Example: +# set(COVERAGE_EXCLUDES "dir1/*") +# setup_target_for_coverage_gcovr_html( +# NAME coverage +# EXECUTABLE testrunner +# BASE_DIRECTORY "${PROJECT_SOURCE_DIR}/src" +# EXCLUDE "dir2/*") +# +# 5. Use the functions described below to create a custom make target which +# runs your test executable and produces a code coverage report. +# +# 6. Build a Debug build: +# cmake -DCMAKE_BUILD_TYPE=Debug .. +# make +# make my_coverage_target +# + +include(CMakeParseArguments) + +option(CODE_COVERAGE_VERBOSE "Verbose information" FALSE) + +# Check prereqs +find_program( GCOV_PATH gcov ) +find_program( LCOV_PATH NAMES lcov lcov.bat lcov.exe lcov.perl) +find_program( FASTCOV_PATH NAMES fastcov fastcov.py ) +find_program( GENHTML_PATH NAMES genhtml genhtml.perl genhtml.bat ) +find_program( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/scripts/test) +find_program( CPPFILT_PATH NAMES c++filt ) + +if(NOT GCOV_PATH) + message(FATAL_ERROR "gcov not found! Aborting...") +endif() # NOT GCOV_PATH + +get_property(LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES) +list(GET LANGUAGES 0 LANG) + +if("${CMAKE_${LANG}_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang") + if("${CMAKE_${LANG}_COMPILER_VERSION}" VERSION_LESS 3) + message(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...") + endif() +elseif (CMAKE_${LANG}_COMPILER_ID STREQUAL "GNU") + # Do nothing; exit conditional without error if true +elseif(NOT CMAKE_COMPILER_IS_GNUCXX) + if("${CMAKE_Fortran_COMPILER_ID}" MATCHES "[Ff]lang") + # Do nothing; exit conditional without error if true + elseif("${CMAKE_Fortran_COMPILER_ID}" MATCHES "GNU") + # Do nothing; exit conditional without error if true + else() + message(FATAL_ERROR "Compiler is not GNU gcc! Aborting...") + endif() +endif() + +set(COVERAGE_COMPILER_FLAGS "-g -fprofile-arcs -ftest-coverage" + CACHE INTERNAL "") +if(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Clang)") + include(CheckCXXCompilerFlag) + check_cxx_compiler_flag(-fprofile-abs-path HAVE_fprofile_abs_path) + if(HAVE_fprofile_abs_path) + set(COVERAGE_COMPILER_FLAGS "${COVERAGE_COMPILER_FLAGS} -fprofile-abs-path") + endif() +endif() + +set(CMAKE_Fortran_FLAGS_COVERAGE + ${COVERAGE_COMPILER_FLAGS} + CACHE STRING "Flags used by the Fortran compiler during coverage builds." + FORCE ) +set(CMAKE_CXX_FLAGS_COVERAGE + ${COVERAGE_COMPILER_FLAGS} + CACHE STRING "Flags used by the C++ compiler during coverage builds." + FORCE ) +set(CMAKE_C_FLAGS_COVERAGE + ${COVERAGE_COMPILER_FLAGS} + CACHE STRING "Flags used by the C compiler during coverage builds." + FORCE ) +set(CMAKE_EXE_LINKER_FLAGS_COVERAGE + "" + CACHE STRING "Flags used for linking binaries during coverage builds." + FORCE ) +set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE + "" + CACHE STRING "Flags used by the shared libraries linker during coverage builds." + FORCE ) +mark_as_advanced( + CMAKE_Fortran_FLAGS_COVERAGE + CMAKE_CXX_FLAGS_COVERAGE + CMAKE_C_FLAGS_COVERAGE + CMAKE_EXE_LINKER_FLAGS_COVERAGE + CMAKE_SHARED_LINKER_FLAGS_COVERAGE ) + +get_property(GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG)) + message(WARNING "Code coverage results with an optimised (non-Debug) build may be misleading") +endif() # NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG) + +if(CMAKE_C_COMPILER_ID STREQUAL "GNU" OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU") + link_libraries(gcov) +endif() + +# Defines a target for running and collection code coverage information +# Builds dependencies, runs the given executable and outputs reports. +# NOTE! The executable should always have a ZERO as exit code otherwise +# the coverage generation will not complete. +# +# setup_target_for_coverage_lcov( +# NAME testrunner_coverage # New target name +# EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR +# DEPENDENCIES testrunner # Dependencies to build first +# BASE_DIRECTORY "../" # Base directory for report +# # (defaults to PROJECT_SOURCE_DIR) +# EXCLUDE "src/dir1/*" "src/dir2/*" # Patterns to exclude (can be relative +# # to BASE_DIRECTORY, with CMake 3.4+) +# NO_DEMANGLE # Don't demangle C++ symbols +# # even if c++filt is found +# ) +function(setup_target_for_coverage_lcov) + + set(options NO_DEMANGLE) + set(oneValueArgs BASE_DIRECTORY NAME) + set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES LCOV_ARGS GENHTML_ARGS) + cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT LCOV_PATH) + message(FATAL_ERROR "lcov not found! Aborting...") + endif() # NOT LCOV_PATH + + if(NOT GENHTML_PATH) + message(FATAL_ERROR "genhtml not found! Aborting...") + endif() # NOT GENHTML_PATH + + # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR + if(DEFINED Coverage_BASE_DIRECTORY) + get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE) + else() + set(BASEDIR ${PROJECT_SOURCE_DIR}) + endif() + + # Collect excludes (CMake 3.4+: Also compute absolute paths) + set(LCOV_EXCLUDES "") + foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_LCOV_EXCLUDES}) + if(CMAKE_VERSION VERSION_GREATER 3.4) + get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR}) + endif() + list(APPEND LCOV_EXCLUDES "${EXCLUDE}") + endforeach() + list(REMOVE_DUPLICATES LCOV_EXCLUDES) + + # Conditional arguments + if(CPPFILT_PATH AND NOT ${Coverage_NO_DEMANGLE}) + set(GENHTML_EXTRA_ARGS "--demangle-cpp") + endif() + + # Setting up commands which will be run to generate coverage data. + # Cleanup lcov + set(LCOV_CLEAN_CMD + ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} -directory . + -b ${BASEDIR} --zerocounters + ) + # Create baseline to make sure untouched files show up in the report + set(LCOV_BASELINE_CMD + ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} -c -i -d . -b + ${BASEDIR} -o ${Coverage_NAME}.base + ) + # Run tests + set(LCOV_EXEC_TESTS_CMD + ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS} + ) + # Capturing lcov counters and generating report + set(LCOV_CAPTURE_CMD + ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} --directory . -b + ${BASEDIR} --capture --output-file ${Coverage_NAME}.capture + ) + # add baseline counters + set(LCOV_BASELINE_COUNT_CMD + ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} -a ${Coverage_NAME}.base + -a ${Coverage_NAME}.capture --output-file ${Coverage_NAME}.total + ) + # filter collected data to final coverage report + set(LCOV_FILTER_CMD + ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} --remove + ${Coverage_NAME}.total ${LCOV_EXCLUDES} --output-file ${Coverage_NAME}.info + ) + # Generate HTML output + set(LCOV_GEN_HTML_CMD + ${GENHTML_PATH} ${GENHTML_EXTRA_ARGS} ${Coverage_GENHTML_ARGS} -o + ${Coverage_NAME} ${Coverage_NAME}.info + ) + + + if(CODE_COVERAGE_VERBOSE) + message(STATUS "Executed command report") + message(STATUS "Command to clean up lcov: ") + string(REPLACE ";" " " LCOV_CLEAN_CMD_SPACED "${LCOV_CLEAN_CMD}") + message(STATUS "${LCOV_CLEAN_CMD_SPACED}") + + message(STATUS "Command to create baseline: ") + string(REPLACE ";" " " LCOV_BASELINE_CMD_SPACED "${LCOV_BASELINE_CMD}") + message(STATUS "${LCOV_BASELINE_CMD_SPACED}") + + message(STATUS "Command to run the tests: ") + string(REPLACE ";" " " LCOV_EXEC_TESTS_CMD_SPACED "${LCOV_EXEC_TESTS_CMD}") + message(STATUS "${LCOV_EXEC_TESTS_CMD_SPACED}") + + message(STATUS "Command to capture counters and generate report: ") + string(REPLACE ";" " " LCOV_CAPTURE_CMD_SPACED "${LCOV_CAPTURE_CMD}") + message(STATUS "${LCOV_CAPTURE_CMD_SPACED}") + + message(STATUS "Command to add baseline counters: ") + string(REPLACE ";" " " LCOV_BASELINE_COUNT_CMD_SPACED "${LCOV_BASELINE_COUNT_CMD}") + message(STATUS "${LCOV_BASELINE_COUNT_CMD_SPACED}") + + message(STATUS "Command to filter collected data: ") + string(REPLACE ";" " " LCOV_FILTER_CMD_SPACED "${LCOV_FILTER_CMD}") + message(STATUS "${LCOV_FILTER_CMD_SPACED}") + + message(STATUS "Command to generate lcov HTML output: ") + string(REPLACE ";" " " LCOV_GEN_HTML_CMD_SPACED "${LCOV_GEN_HTML_CMD}") + message(STATUS "${LCOV_GEN_HTML_CMD_SPACED}") + endif() + + # Setup target + add_custom_target(${Coverage_NAME} + COMMAND ${LCOV_CLEAN_CMD} + COMMAND ${LCOV_BASELINE_CMD} + COMMAND ${LCOV_EXEC_TESTS_CMD} + COMMAND ${LCOV_CAPTURE_CMD} + COMMAND ${LCOV_BASELINE_COUNT_CMD} + COMMAND ${LCOV_FILTER_CMD} + COMMAND ${LCOV_GEN_HTML_CMD} + + # Set output files as GENERATED (will be removed on 'make clean') + BYPRODUCTS + ${Coverage_NAME}.base + ${Coverage_NAME}.capture + ${Coverage_NAME}.total + ${Coverage_NAME}.info + ${Coverage_NAME}/index.html + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + DEPENDS ${Coverage_DEPENDENCIES} + VERBATIM # Protect arguments to commands + COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report." + ) + + # Show where to find the lcov info report + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD + COMMAND ; + COMMENT "Lcov code coverage info report saved in ${Coverage_NAME}.info." + ) + + # Show info where to find the report + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD + COMMAND ; + COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report." + ) + +endfunction() # setup_target_for_coverage_lcov + +# Defines a target for running and collection code coverage information +# Builds dependencies, runs the given executable and outputs reports. +# NOTE! The executable should always have a ZERO as exit code otherwise +# the coverage generation will not complete. +# +# setup_target_for_coverage_gcovr_xml( +# NAME ctest_coverage # New target name +# EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR +# DEPENDENCIES executable_target # Dependencies to build first +# BASE_DIRECTORY "../" # Base directory for report +# # (defaults to PROJECT_SOURCE_DIR) +# EXCLUDE "src/dir1/*" "src/dir2/*" # Patterns to exclude (can be relative +# # to BASE_DIRECTORY, with CMake 3.4+) +# ) +# The user can set the variable GCOVR_ADDITIONAL_ARGS to supply additional flags to the +# GCVOR command. +function(setup_target_for_coverage_gcovr_xml) + + set(options NONE) + set(oneValueArgs BASE_DIRECTORY NAME) + set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES) + cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT GCOVR_PATH) + message(FATAL_ERROR "gcovr not found! Aborting...") + endif() # NOT GCOVR_PATH + + # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR + if(DEFINED Coverage_BASE_DIRECTORY) + get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE) + else() + set(BASEDIR ${PROJECT_SOURCE_DIR}) + endif() + + # Collect excludes (CMake 3.4+: Also compute absolute paths) + set(GCOVR_EXCLUDES "") + foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_GCOVR_EXCLUDES}) + if(CMAKE_VERSION VERSION_GREATER 3.4) + get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR}) + endif() + list(APPEND GCOVR_EXCLUDES "${EXCLUDE}") + endforeach() + list(REMOVE_DUPLICATES GCOVR_EXCLUDES) + + # Combine excludes to several -e arguments + set(GCOVR_EXCLUDE_ARGS "") + foreach(EXCLUDE ${GCOVR_EXCLUDES}) + list(APPEND GCOVR_EXCLUDE_ARGS "-e") + list(APPEND GCOVR_EXCLUDE_ARGS "${EXCLUDE}") + endforeach() + + # Set up commands which will be run to generate coverage data + # Run tests + set(GCOVR_XML_EXEC_TESTS_CMD + ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS} + ) + # Running gcovr + set(GCOVR_XML_CMD + ${GCOVR_PATH} --xml ${Coverage_NAME}.xml -r ${BASEDIR} ${GCOVR_ADDITIONAL_ARGS} + ${GCOVR_EXCLUDE_ARGS} --object-directory=${PROJECT_BINARY_DIR} + ) + + if(CODE_COVERAGE_VERBOSE) + message(STATUS "Executed command report") + + message(STATUS "Command to run tests: ") + string(REPLACE ";" " " GCOVR_XML_EXEC_TESTS_CMD_SPACED "${GCOVR_XML_EXEC_TESTS_CMD}") + message(STATUS "${GCOVR_XML_EXEC_TESTS_CMD_SPACED}") + + message(STATUS "Command to generate gcovr XML coverage data: ") + string(REPLACE ";" " " GCOVR_XML_CMD_SPACED "${GCOVR_XML_CMD}") + message(STATUS "${GCOVR_XML_CMD_SPACED}") + endif() + + add_custom_target(${Coverage_NAME} + COMMAND ${GCOVR_XML_EXEC_TESTS_CMD} + COMMAND ${GCOVR_XML_CMD} + + BYPRODUCTS ${Coverage_NAME}.xml + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + DEPENDS ${Coverage_DEPENDENCIES} + VERBATIM # Protect arguments to commands + COMMENT "Running gcovr to produce Cobertura code coverage report." + ) + + # Show info where to find the report + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD + COMMAND ; + COMMENT "Cobertura code coverage report saved in ${Coverage_NAME}.xml." + ) +endfunction() # setup_target_for_coverage_gcovr_xml + +# Defines a target for running and collection code coverage information +# Builds dependencies, runs the given executable and outputs reports. +# NOTE! The executable should always have a ZERO as exit code otherwise +# the coverage generation will not complete. +# +# setup_target_for_coverage_gcovr_html( +# NAME ctest_coverage # New target name +# EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR +# DEPENDENCIES executable_target # Dependencies to build first +# BASE_DIRECTORY "../" # Base directory for report +# # (defaults to PROJECT_SOURCE_DIR) +# EXCLUDE "src/dir1/*" "src/dir2/*" # Patterns to exclude (can be relative +# # to BASE_DIRECTORY, with CMake 3.4+) +# ) +# The user can set the variable GCOVR_ADDITIONAL_ARGS to supply additional flags to the +# GCVOR command. +function(setup_target_for_coverage_gcovr_html) + + set(options NONE) + set(oneValueArgs BASE_DIRECTORY NAME) + set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES) + cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT GCOVR_PATH) + message(FATAL_ERROR "gcovr not found! Aborting...") + endif() # NOT GCOVR_PATH + + # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR + if(DEFINED Coverage_BASE_DIRECTORY) + get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE) + else() + set(BASEDIR ${PROJECT_SOURCE_DIR}) + endif() + + # Collect excludes (CMake 3.4+: Also compute absolute paths) + set(GCOVR_EXCLUDES "") + foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_GCOVR_EXCLUDES}) + if(CMAKE_VERSION VERSION_GREATER 3.4) + get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR}) + endif() + list(APPEND GCOVR_EXCLUDES "${EXCLUDE}") + endforeach() + list(REMOVE_DUPLICATES GCOVR_EXCLUDES) + + # Combine excludes to several -e arguments + set(GCOVR_EXCLUDE_ARGS "") + foreach(EXCLUDE ${GCOVR_EXCLUDES}) + list(APPEND GCOVR_EXCLUDE_ARGS "-e") + list(APPEND GCOVR_EXCLUDE_ARGS "${EXCLUDE}") + endforeach() + + # Set up commands which will be run to generate coverage data + # Run tests + set(GCOVR_HTML_EXEC_TESTS_CMD + ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS} + ) + # Create folder + set(GCOVR_HTML_FOLDER_CMD + ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/${Coverage_NAME} + ) + # Running gcovr + set(GCOVR_HTML_CMD + ${GCOVR_PATH} --html ${Coverage_NAME}/index.html --html-details -r ${BASEDIR} ${GCOVR_ADDITIONAL_ARGS} + ${GCOVR_EXCLUDE_ARGS} --object-directory=${PROJECT_BINARY_DIR} + ) + + if(CODE_COVERAGE_VERBOSE) + message(STATUS "Executed command report") + + message(STATUS "Command to run tests: ") + string(REPLACE ";" " " GCOVR_HTML_EXEC_TESTS_CMD_SPACED "${GCOVR_HTML_EXEC_TESTS_CMD}") + message(STATUS "${GCOVR_HTML_EXEC_TESTS_CMD_SPACED}") + + message(STATUS "Command to create a folder: ") + string(REPLACE ";" " " GCOVR_HTML_FOLDER_CMD_SPACED "${GCOVR_HTML_FOLDER_CMD}") + message(STATUS "${GCOVR_HTML_FOLDER_CMD_SPACED}") + + message(STATUS "Command to generate gcovr HTML coverage data: ") + string(REPLACE ";" " " GCOVR_HTML_CMD_SPACED "${GCOVR_HTML_CMD}") + message(STATUS "${GCOVR_HTML_CMD_SPACED}") + endif() + + add_custom_target(${Coverage_NAME} + COMMAND ${GCOVR_HTML_EXEC_TESTS_CMD} + COMMAND ${GCOVR_HTML_FOLDER_CMD} + COMMAND ${GCOVR_HTML_CMD} + + BYPRODUCTS ${PROJECT_BINARY_DIR}/${Coverage_NAME}/index.html # report directory + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + DEPENDS ${Coverage_DEPENDENCIES} + VERBATIM # Protect arguments to commands + COMMENT "Running gcovr to produce HTML code coverage report." + ) + + # Show info where to find the report + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD + COMMAND ; + COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report." + ) + +endfunction() # setup_target_for_coverage_gcovr_html + +# Defines a target for running and collection code coverage information +# Builds dependencies, runs the given executable and outputs reports. +# NOTE! The executable should always have a ZERO as exit code otherwise +# the coverage generation will not complete. +# +# setup_target_for_coverage_fastcov( +# NAME testrunner_coverage # New target name +# EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR +# DEPENDENCIES testrunner # Dependencies to build first +# BASE_DIRECTORY "../" # Base directory for report +# # (defaults to PROJECT_SOURCE_DIR) +# EXCLUDE "src/dir1/" "src/dir2/" # Patterns to exclude. +# NO_DEMANGLE # Don't demangle C++ symbols +# # even if c++filt is found +# SKIP_HTML # Don't create html report +# POST_CMD perl -i -pe s!${PROJECT_SOURCE_DIR}/!!g ctest_coverage.json # E.g. for stripping source dir from file paths +# ) +function(setup_target_for_coverage_fastcov) + + set(options NO_DEMANGLE SKIP_HTML) + set(oneValueArgs BASE_DIRECTORY NAME) + set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES FASTCOV_ARGS GENHTML_ARGS POST_CMD) + cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT FASTCOV_PATH) + message(FATAL_ERROR "fastcov not found! Aborting...") + endif() + + if(NOT Coverage_SKIP_HTML AND NOT GENHTML_PATH) + message(FATAL_ERROR "genhtml not found! Aborting...") + endif() + + # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR + if(Coverage_BASE_DIRECTORY) + get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE) + else() + set(BASEDIR ${PROJECT_SOURCE_DIR}) + endif() + + # Collect excludes (Patterns, not paths, for fastcov) + set(FASTCOV_EXCLUDES "") + foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_FASTCOV_EXCLUDES}) + list(APPEND FASTCOV_EXCLUDES "${EXCLUDE}") + endforeach() + list(REMOVE_DUPLICATES FASTCOV_EXCLUDES) + + # Conditional arguments + if(CPPFILT_PATH AND NOT ${Coverage_NO_DEMANGLE}) + set(GENHTML_EXTRA_ARGS "--demangle-cpp") + endif() + + # Set up commands which will be run to generate coverage data + set(FASTCOV_EXEC_TESTS_CMD ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}) + + set(FASTCOV_CAPTURE_CMD ${FASTCOV_PATH} ${Coverage_FASTCOV_ARGS} --gcov ${GCOV_PATH} + --search-directory ${BASEDIR} + --process-gcno + --output ${Coverage_NAME}.json + --exclude ${FASTCOV_EXCLUDES} + --exclude ${FASTCOV_EXCLUDES} + ) + + set(FASTCOV_CONVERT_CMD ${FASTCOV_PATH} + -C ${Coverage_NAME}.json --lcov --output ${Coverage_NAME}.info + ) + + if(Coverage_SKIP_HTML) + set(FASTCOV_HTML_CMD ";") + else() + set(FASTCOV_HTML_CMD ${GENHTML_PATH} ${GENHTML_EXTRA_ARGS} ${Coverage_GENHTML_ARGS} + -o ${Coverage_NAME} ${Coverage_NAME}.info + ) + endif() + + set(FASTCOV_POST_CMD ";") + if(Coverage_POST_CMD) + set(FASTCOV_POST_CMD ${Coverage_POST_CMD}) + endif() + + if(CODE_COVERAGE_VERBOSE) + message(STATUS "Code coverage commands for target ${Coverage_NAME} (fastcov):") + + message(" Running tests:") + string(REPLACE ";" " " FASTCOV_EXEC_TESTS_CMD_SPACED "${FASTCOV_EXEC_TESTS_CMD}") + message(" ${FASTCOV_EXEC_TESTS_CMD_SPACED}") + + message(" Capturing fastcov counters and generating report:") + string(REPLACE ";" " " FASTCOV_CAPTURE_CMD_SPACED "${FASTCOV_CAPTURE_CMD}") + message(" ${FASTCOV_CAPTURE_CMD_SPACED}") + + message(" Converting fastcov .json to lcov .info:") + string(REPLACE ";" " " FASTCOV_CONVERT_CMD_SPACED "${FASTCOV_CONVERT_CMD}") + message(" ${FASTCOV_CONVERT_CMD_SPACED}") + + if(NOT Coverage_SKIP_HTML) + message(" Generating HTML report: ") + string(REPLACE ";" " " FASTCOV_HTML_CMD_SPACED "${FASTCOV_HTML_CMD}") + message(" ${FASTCOV_HTML_CMD_SPACED}") + endif() + if(Coverage_POST_CMD) + message(" Running post command: ") + string(REPLACE ";" " " FASTCOV_POST_CMD_SPACED "${FASTCOV_POST_CMD}") + message(" ${FASTCOV_POST_CMD_SPACED}") + endif() + endif() + + # Setup target + add_custom_target(${Coverage_NAME} + + # Cleanup fastcov + COMMAND ${FASTCOV_PATH} ${Coverage_FASTCOV_ARGS} --gcov ${GCOV_PATH} + --search-directory ${BASEDIR} + --zerocounters + + COMMAND ${FASTCOV_EXEC_TESTS_CMD} + COMMAND ${FASTCOV_CAPTURE_CMD} + COMMAND ${FASTCOV_CONVERT_CMD} + COMMAND ${FASTCOV_HTML_CMD} + COMMAND ${FASTCOV_POST_CMD} + + # Set output files as GENERATED (will be removed on 'make clean') + BYPRODUCTS + ${Coverage_NAME}.info + ${Coverage_NAME}.json + ${Coverage_NAME}/index.html # report directory + + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + DEPENDS ${Coverage_DEPENDENCIES} + VERBATIM # Protect arguments to commands + COMMENT "Resetting code coverage counters to zero. Processing code coverage counters and generating report." + ) + + set(INFO_MSG "fastcov code coverage info report saved in ${Coverage_NAME}.info and ${Coverage_NAME}.json.") + if(NOT Coverage_SKIP_HTML) + string(APPEND INFO_MSG " Open ${PROJECT_BINARY_DIR}/${Coverage_NAME}/index.html in your browser to view the coverage report.") + endif() + # Show where to find the fastcov info report + add_custom_command(TARGET ${Coverage_NAME} POST_BUILD + COMMAND ${CMAKE_COMMAND} -E echo ${INFO_MSG} + ) + +endfunction() # setup_target_for_coverage_fastcov + +function(append_coverage_compiler_flags) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE) + set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE) + message(STATUS "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}") +endfunction() # append_coverage_compiler_flags + +# Setup coverage for specific library +function(append_coverage_compiler_flags_to_target name) + target_compile_options(${name} + PRIVATE ${COVERAGE_COMPILER_FLAGS}) +endfunction() diff --git a/library/list/CMakeLists.txt b/library/list/CMakeLists.txt index cd3f5e3..6d1a26f 100644 --- a/library/list/CMakeLists.txt +++ b/library/list/CMakeLists.txt @@ -15,6 +15,8 @@ target_sources(list "src/list.c" PUBLIC "include/waitui/list.h" + "include/waitui/list_generic.h" + "include/waitui/list_generic_impl.h" ) target_include_directories(list PUBLIC "include") \ No newline at end of file diff --git a/library/list/include/waitui/list.h b/library/list/include/waitui/list.h index b8586e0..ad4cf0e 100644 --- a/library/list/include/waitui/list.h +++ b/library/list/include/waitui/list.h @@ -1,9 +1,9 @@ /** -* @file list.h -* @author rick -* @date 22.07.20 -* @brief File for the List implementation -*/ + * @file list.h + * @author rick + * @date 22.07.20 + * @brief File for the List implementation + */ #ifndef WAITUI_LIST_H #define WAITUI_LIST_H @@ -16,223 +16,115 @@ // ----------------------------------------------------------------------------- /** -* @brief Type representing a List node. -*/ + * @brief Type representing a List node + */ typedef struct waitui_list_node waitui_list_node; /** -* @brief Type for element destroy function. -*/ + * @brief Type for element destroy function + */ typedef void (*waitui_list_element_destroy)(void **element); /** -* @brief Type representing a List. -*/ + * @brief Type representing a List + */ typedef struct waitui_list waitui_list; /** -* @brief Type representing a List iterator. -*/ + * @brief Type representing a List iterator + */ typedef struct waitui_list_iter waitui_list_iter; -// ----------------------------------------------------------------------------- -// Public defines -// ----------------------------------------------------------------------------- - -#define INTERFACE_LIST_TYPEDEF(type) \ - typedef waitui_list type##_list; \ - typedef waitui_list_iter type##_list_iter -#define IMPLEMENTATION_LIST_TYPEDEF(type) - -#define INTERFACE_LIST_NEW(type) extern type##_list *type##_list_new() -#define IMPLEMENTATION_LIST_NEW(type) \ - type##_list *type##_list_new() { \ - return (type##_list *) waitui_list_new( \ - (waitui_list_element_destroy) type##_destroy); \ - } - -#define INTERFACE_LIST_DESTROY(type) \ - extern void type##_list_destroy(type##_list **this) -#define IMPLEMENTATION_LIST_DESTROY(type) \ - void type##_list_destroy(type##_list **this) { \ - waitui_list_destroy((waitui_list **) this); \ - } - -#define INTERFACE_LIST_PUSH(type) \ - extern int type##_list_push(type##_list *this, type *type##Element) -#define IMPLEMENTATION_LIST_PUSH(type) \ - int type##_list_push(type##_list *this, type *type##Element) { \ - return waitui_list_push((waitui_list *) this, (void *) type##Element); \ - } - -#define INTERFACE_LIST_POP(type) extern type *type##_list_pop(type##_list *this) -#define IMPLEMENTATION_LIST_POP(type) \ - type *type##_list_pop(type##_list *this) { \ - return (type *) waitui_list_pop((waitui_list *) this); \ - } - -#define INTERFACE_LIST_UNSHIFT(type) \ - extern int type##_list_unshift(type##_list *this, type *type##Element) -#define IMPLEMENTATION_LIST_UNSHIFT(type) \ - int type##_list_unshift(type##_list *this, type *type##Element) { \ - return waitui_list_unshift((waitui_list *) this, \ - (void *) type##Element); \ - } - -#define INTERFACE_LIST_SHIFT(type) \ - extern type *type##_list_shift(type##_list *this) -#define IMPLEMENTATION_LIST_SHIFT(type) \ - type *type##_list_shift(type##_list *this) { \ - return (type *) waitui_list_shift((waitui_list *) this); \ - } - -#define INTERFACE_LIST_PEEK(type) \ - extern type *type##_list_peek(type##_list *this) -#define IMPLEMENTATION_LIST_PEEK(type) \ - type *type##_list_peek(type##_list *this) { \ - return (type *) waitui_list_peek((waitui_list *) this); \ - } - -#define INTERFACE_LIST_GET_ITERATOR(type) \ - extern type##_list_iter *type##_list_getIterator(type##_list *this) -#define IMPLEMENTATION_LIST_GET_ITERATOR(type) \ - type##_list_iter *type##_list_getIterator(type##_list *this) { \ - return (type##_list_iter *) waitui_list_getIterator( \ - (waitui_list *) this); \ - } - -#define INTERFACE_LIST_ITER_HAS_NEXT(type) \ - extern bool type##_list_iter_hasNext(type##_list_iter *this) -#define IMPLEMENTATION_LIST_ITER_HAS_NEXT(type) \ - bool type##_list_iter_hasNext(type##_list_iter *this) { \ - return waitui_list_iter_hasNext((waitui_list_iter *) this); \ - } - -#define INTERFACE_LIST_ITER_NEXT(type) \ - extern type *type##_list_iter_next(type##_list_iter *this) -#define IMPLEMENTATION_LIST_ITER_NEXT(type) \ - type *type##_list_iter_next(type##_list_iter *this) { \ - return (type *) waitui_list_iter_next((waitui_list_iter *) this); \ - } - -#define INTERFACE_LIST_ITER_DESTROY(type) \ - extern void type##_list_iter_destroy(type##_list_iter **this) -#define IMPLEMENTATION_LIST_ITER_DESTROY(type) \ - void type##_list_iter_destroy(type##_list_iter **this) { \ - waitui_list_iter_destroy((waitui_list_iter **) this); \ - } - -/** -* @brief Define for quickly created list implementations for a value type. -* @param[in] kind Whether to create interface list definition -* or actual implementation -* @param[in] type For what type to create the list -*/ -#define CREATE_LIST_TYPE(kind, type) \ - kind##_LIST_TYPEDEF(type); \ - kind##_LIST_NEW(type); \ - kind##_LIST_DESTROY(type); \ - kind##_LIST_PUSH(type); \ - kind##_LIST_POP(type); \ - kind##_LIST_UNSHIFT(type); \ - kind##_LIST_SHIFT(type); \ - kind##_LIST_PEEK(type); \ - kind##_LIST_GET_ITERATOR(type); \ - kind##_LIST_ITER_HAS_NEXT(type); \ - kind##_LIST_ITER_NEXT(type); \ - kind##_LIST_ITER_DESTROY(type); - - // ----------------------------------------------------------------------------- // Public functions // ----------------------------------------------------------------------------- /** -* @brief Create a List. -* @param[in] elementDestroyCallback Function to call for element destruction -* @return A pointer to waitui_list or NULL if memory allocation failed -*/ + * @brief Create a List + * @param[in] elementDestroyCallback Function to call for element destruction + * @return A pointer to waitui_list or NULL if memory allocation failed + */ extern waitui_list * waitui_list_new(waitui_list_element_destroy elementDestroyCallback); /** -* @brief Destroy a List. -* @param[in,out] this The List to destroy -* @note This will free call for every element the elementDestroyCallback -*/ + * @brief Destroy a List + * @param[in,out] this The List to destroy + * @note This will free call for every element the elementDestroyCallback + */ extern void waitui_list_destroy(waitui_list **this); /** -* @brief Add the element to the end of the List. -* @param[in,out] this The List to add the element at the end -* @param[in] element The element to add -* @note This function does steel the pointer to the element. -* @retval 1 Ok -* @retval 0 Memory allocation failed -*/ + * @brief Add the element to the end of the List + * @param[in,out] this The List to add the element at the end + * @param[in] element The element to add + * @note This function does steel the pointer to the element + * @retval 1 Ok + * @retval 0 Memory allocation failed + */ extern int waitui_list_push(waitui_list *this, void *element); /** -* @brief Remove the element from the end of the List and return it. -* @param[in,out] this The List to remove the element from -* @note The caller has to destroy element on its own. -* @return The element or NULL if waitui_list is empty -*/ + * @brief Remove the element from the end of the List and return it + * @param[in,out] this The List to remove the element from + * @note The caller has to destroy element on its own + * @return The element or NULL if waitui_list is empty + */ extern void *waitui_list_pop(waitui_list *this); /** -* @brief Add the element to the beginning of the List. -* @param[in,out] this The List to add the element at the beginning -* @param[in] element The element to add -* @note This function does steel the pointer to the element. -* @retval 1 Ok -* @retval 0 Memory allocation failed -*/ + * @brief Add the element to the beginning of the List + * @param[in,out] this The List to add the element at the beginning + * @param[in] element The element to add + * @note This function does steel the pointer to the element + * @retval 1 Ok + * @retval 0 Memory allocation failed + */ extern int waitui_list_unshift(waitui_list *this, void *element); /** -* @brief Remove the element from the beginning of the List and return it. -* @param[in,out] this The List to remove the element from -* @note The caller has to destroy element on its own. -* @return The element or NULL if waitui_list is empty -*/ + * @brief Remove the element from the beginning of the List and return it + * @param[in,out] this The List to remove the element from + * @note The caller has to destroy element on its own + * @return The element or NULL if waitui_list is empty + */ extern void *waitui_list_shift(waitui_list *this); /** -* @brief Return the element from the end of the List, without removing it. -* @param[in] this The List to get the last element from -* @warning The caller has not to destroy element on its own. -* @return The element or NULL if waitui_list is empty -*/ + * @brief Return the element from the end of the List, without removing it + * @param[in] this The List to get the last element from + * @warning The caller has not to destroy element on its own + * @return The element or NULL if waitui_list is empty + */ extern void *waitui_list_peek(waitui_list *this); /** -* @brief Return the iterator to iterate over the List. -* @param[in] this The List to get the iterator for -* @return A pointer to waitui_list_iter or NULL if memory allocation failed -*/ + * @brief Return the iterator to iterate over the List + * @param[in] this The List to get the iterator for + * @return A pointer to waitui_list_iter or NULL if memory allocation failed + */ extern waitui_list_iter *waitui_list_getIterator(waitui_list *this); /** -* @brief Return true if the List iterator has a next element. -* @param[in] this The List iterator to test for next element available -* @retval true If the iterator has a next element available -* @retval false If the iterator has no next element available -*/ + * @brief Return true if the List iterator has a next element + * @param[in] this The List iterator to test for next element available + * @retval true If the iterator has a next element available + * @retval false If the iterator has no next element available + */ extern bool waitui_list_iter_hasNext(waitui_list_iter *this); /** -* @brief Return the next element from the List iterator. -* @param[in] this The List iterator to get the next element -* @return The element or NULL if no more elements are available -*/ + * @brief Return the next element from the List iterator + * @param[in] this The List iterator to get the next element + * @return The element or NULL if no more elements are available + */ extern void *waitui_list_iter_next(waitui_list_iter *this); /** -* @brief Destroy a List iterator. -* @param[in,out] this The List iterator to destroy -*/ + * @brief Destroy a List iterator + * @param[in,out] this The List iterator to destroy + */ extern void waitui_list_iter_destroy(waitui_list_iter **this); #endif//WAITUI_LIST_H \ No newline at end of file diff --git a/library/list/include/waitui/list_generic.h b/library/list/include/waitui/list_generic.h new file mode 100644 index 0000000..4831768 --- /dev/null +++ b/library/list/include/waitui/list_generic.h @@ -0,0 +1,78 @@ +/** +* @file list_generic.h +* @author rick +* @date 26.07.22 +* @brief File for the generic List implementation +*/ + +#ifndef WAITUI_LIST_GENERIC_H +#define WAITUI_LIST_GENERIC_H + + +// ----------------------------------------------------------------------------- +// Public defines +// ----------------------------------------------------------------------------- + +#define INTERFACE_LIST_TYPEDEF(type) \ + typedef waitui_list type##_list; \ + typedef waitui_list_iter type##_list_iter + +#define INTERFACE_LIST_NEW(type) extern type##_list *type##_list_new() + +#define INTERFACE_LIST_DESTROY(type) \ + extern void type##_list_destroy(type##_list **this) + +#define INTERFACE_LIST_PUSH(type) \ + extern int type##_list_push(type##_list *this, type *type##Element) + +#define INTERFACE_LIST_POP(type) extern type *type##_list_pop(type##_list *this) + +#define INTERFACE_LIST_UNSHIFT(type) \ + extern int type##_list_unshift(type##_list *this, type *type##Element) + + +#define INTERFACE_LIST_SHIFT(type) \ + extern type *type##_list_shift(type##_list *this) + + +#define INTERFACE_LIST_PEEK(type) \ + extern type *type##_list_peek(type##_list *this) + + +#define INTERFACE_LIST_GET_ITERATOR(type) \ + extern type##_list_iter *type##_list_getIterator(type##_list *this) + + +#define INTERFACE_LIST_ITER_HAS_NEXT(type) \ + extern bool type##_list_iter_hasNext(type##_list_iter *this) + + +#define INTERFACE_LIST_ITER_NEXT(type) \ + extern type *type##_list_iter_next(type##_list_iter *this) + + +#define INTERFACE_LIST_ITER_DESTROY(type) \ + extern void type##_list_iter_destroy(type##_list_iter **this) + + +/** + * @brief Define for quickly created list implementations for a value type + * @param[in] kind Whether to create interface list definition + * or actual implementation + * @param[in] type For what type to create the list + */ +#define CREATE_LIST_TYPE(kind, type) \ + kind##_LIST_TYPEDEF(type); \ + kind##_LIST_NEW(type); \ + kind##_LIST_DESTROY(type); \ + kind##_LIST_PUSH(type); \ + kind##_LIST_POP(type); \ + kind##_LIST_UNSHIFT(type); \ + kind##_LIST_SHIFT(type); \ + kind##_LIST_PEEK(type); \ + kind##_LIST_GET_ITERATOR(type); \ + kind##_LIST_ITER_HAS_NEXT(type); \ + kind##_LIST_ITER_NEXT(type); \ + kind##_LIST_ITER_DESTROY(type); + +#endif//WAITUI_LIST_GENERIC_H \ No newline at end of file diff --git a/library/list/include/waitui/list_generic_impl.h b/library/list/include/waitui/list_generic_impl.h new file mode 100644 index 0000000..f937726 --- /dev/null +++ b/library/list/include/waitui/list_generic_impl.h @@ -0,0 +1,79 @@ +/** +* @file list_generic_impl.h +* @author rick +* @date 26.07.22 +* @brief File for the generic List implementation +*/ + +#ifndef WAITUI_LIST_GENERIC_IMPL_H +#define WAITUI_LIST_GENERIC_IMPL_H + +#include "waitui/list_generic.h" +#include "waitui/list.h" + + +// ----------------------------------------------------------------------------- +// Public defines +// ----------------------------------------------------------------------------- + +#define IMPLEMENTATION_LIST_TYPEDEF(type) + +#define IMPLEMENTATION_LIST_NEW(type) \ + type##_list *type##_list_new() { \ + return (type##_list *) waitui_list_new( \ + (waitui_list_element_destroy) type##_destroy); \ + } + +#define IMPLEMENTATION_LIST_DESTROY(type) \ + void type##_list_destroy(type##_list **this) { \ + waitui_list_destroy((waitui_list **) this); \ + } + +#define IMPLEMENTATION_LIST_PUSH(type) \ + int type##_list_push(type##_list *this, type *type##Element) { \ + return waitui_list_push((waitui_list *) this, (void *) type##Element); \ + } + +#define IMPLEMENTATION_LIST_POP(type) \ + type *type##_list_pop(type##_list *this) { \ + return (type *) waitui_list_pop((waitui_list *) this); \ + } + +#define IMPLEMENTATION_LIST_UNSHIFT(type) \ + int type##_list_unshift(type##_list *this, type *type##Element) { \ + return waitui_list_unshift((waitui_list *) this, \ + (void *) type##Element); \ + } + +#define IMPLEMENTATION_LIST_SHIFT(type) \ + type *type##_list_shift(type##_list *this) { \ + return (type *) waitui_list_shift((waitui_list *) this); \ + } + +#define IMPLEMENTATION_LIST_PEEK(type) \ + type *type##_list_peek(type##_list *this) { \ + return (type *) waitui_list_peek((waitui_list *) this); \ + } + +#define IMPLEMENTATION_LIST_GET_ITERATOR(type) \ + type##_list_iter *type##_list_getIterator(type##_list *this) { \ + return (type##_list_iter *) waitui_list_getIterator( \ + (waitui_list *) this); \ + } + +#define IMPLEMENTATION_LIST_ITER_HAS_NEXT(type) \ + bool type##_list_iter_hasNext(type##_list_iter *this) { \ + return waitui_list_iter_hasNext((waitui_list_iter *) this); \ + } + +#define IMPLEMENTATION_LIST_ITER_NEXT(type) \ + type *type##_list_iter_next(type##_list_iter *this) { \ + return (type *) waitui_list_iter_next((waitui_list_iter *) this); \ + } + +#define IMPLEMENTATION_LIST_ITER_DESTROY(type) \ + void type##_list_iter_destroy(type##_list_iter **this) { \ + waitui_list_iter_destroy((waitui_list_iter **) this); \ + } + +#endif//WAITUI_LIST_GENERIC_IMPL_H \ No newline at end of file diff --git a/library/list/src/list.c b/library/list/src/list.c index 0f1fa3c..5f2cf71 100644 --- a/library/list/src/list.c +++ b/library/list/src/list.c @@ -1,9 +1,9 @@ /** -* @file list.c -* @author rick -* @date 22.07.20 -* @brief File for the List implementation -*/ + * @file list.c + * @author rick + * @date 22.07.20 + * @brief File for the List implementation + */ #include "waitui/list.h" @@ -15,8 +15,8 @@ // ----------------------------------------------------------------------------- /** -* @brief Struct representing a List node. -*/ + * @brief Struct representing a List node + */ struct waitui_list_node { void *element; waitui_list_node *next; @@ -24,8 +24,8 @@ struct waitui_list_node { }; /** -* @brief Struct representing a List. -*/ + * @brief Struct representing a List + */ struct waitui_list { waitui_list_node *head; waitui_list_node *tail; @@ -34,8 +34,8 @@ struct waitui_list { }; /** -* @brief Struct representing a List iterator. -*/ + * @brief Struct representing a List iterator + */ struct waitui_list_iter { waitui_list_node *node; }; @@ -46,10 +46,10 @@ struct waitui_list_iter { // ----------------------------------------------------------------------------- /** -* @brief Create a List iterator. -* @param[in] node The node to use as a start for the iterator -* @return A pointer to waitui_list_iter or NULL if memory allocation failed -*/ + * @brief Create a List iterator + * @param[in] node The node to use as a start for the iterator + * @return A pointer to waitui_list_iter or NULL if memory allocation failed + */ static waitui_list_iter *waitui_list_iter_new(waitui_list_node *node) { waitui_list_iter *this = NULL; diff --git a/tests/library/list/CMakeLists.txt b/tests/library/list/CMakeLists.txt index 356d070..db8abb8 100644 --- a/tests/library/list/CMakeLists.txt +++ b/tests/library/list/CMakeLists.txt @@ -9,7 +9,7 @@ target_link_libraries(waitui-test_list PRIVATE list) add_test(NAME waitui-test_list COMMAND waitui-test_list) -#if(ENABLE_TEST_COVERAGE) -# target_compile_options(list PUBLIC -O0 -g -fprofile-arcs -ftest-coverage) -# target_link_options(list PUBLIC -fprofile-arcs -ftest-coverage) -#endif() +if(ENABLE_TEST_COVERAGE) + target_compile_options(list PUBLIC -O0 -g -fprofile-arcs -ftest-coverage) + target_link_options(list PUBLIC -fprofile-arcs -ftest-coverage) +endif() diff --git a/tests/library/list/test_list.c b/tests/library/list/test_list.c index 0795ac5..40e8206 100644 --- a/tests/library/list/test_list.c +++ b/tests/library/list/test_list.c @@ -5,7 +5,8 @@ * @brief Test for the List implementation */ -#include "waitui/list.h" +#include "waitui/list_generic.h" +#include "waitui/list_generic_impl.h" #include "../../bdd-for-c-ext.h" @@ -46,7 +47,7 @@ spec("list") { describe("value_list_push()") { for_it( - "should push values onto the end list and it should be there", + "should add values to the end of the list and it should be there", params_format(2, "start: %d", "elements: %d"), format_args(test_param.start, test_param.count), { @@ -74,6 +75,179 @@ spec("list") { } } for_it_end(); + + it("should return 0 with NULL as this param") { + check(value_list_push(NULL, value_new(1)) == 0, "return should not be 0"); + } + + it("should return 0 with NULL as valueElement param") { + check(value_list_push(list, NULL) == 0, "return should not be 0"); + } + } + + describe("value_list_pop()") { + it("should return NULL with NULL as this param") { + static value *value = NULL; + value = value_list_pop(NULL); + check(value == NULL, "value should be NULL"); + } + + it("should return NULL with an empty list as this param") { + static value *value = NULL; + value = value_list_pop(list); + check(value == NULL, "value should be NULL"); + } + } + + describe("value_list_unshift()") { + for_it( + "should add values to the begin of the list and it should be there", + params_format(2, "start: %d", "elements: %d"), + format_args(test_param.start, test_param.count), + { + int start; + int count; + }, + test_params( + {0, 0}, + {0, 1}, + {1, 1}, + {4, 20}, + ) + ) { + for (int i = test_param.start; i < test_param.start + test_param.count; ++i) { + check(value_list_unshift(list, value_new(i)) == 1); + } + + for (int i = test_param.start + test_param.count - 1; i >= test_param.start; --i) { + value *value = value_list_shift(list); + check(value != NULL, "value should not be NULL"); + check(value->i == i, "value should be %d but is %d", i, value->i); + value_destroy(&value); + } + } + for_it_end(); + + it("should return 0 with NULL as this param") { + check(value_list_unshift(NULL, value_new(1)) == 0, "return should not be 0"); + } + + it("should return 0 with NULL as valueElement param") { + check(value_list_unshift(list, NULL) == 0, "return should not be 0"); + } + } + + describe("value_list_shift()") { + it("should return NULL with NULL as this param") { + static value *value = NULL; + value = value_list_shift(NULL); + check(value == NULL, "value should be NULL"); + } + + it("should return NULL with an empty list as this param") { + static value *value = NULL; + value = value_list_shift(list); + check(value == NULL, "value should be NULL"); + } + } + + describe("value_list_getIterator()") { + for_it( + "should iterate over all values from the list", + params_format(2, "start: %d", "elements: %d"), + format_args(test_param.start, test_param.count), + { + int start; + int count; + }, + test_params( + {0, 0}, + {0, 1}, + {1, 1}, + {4, 20}, + ) + ) { + static value_list_iter *iter = NULL; + + for (int i = test_param.start; i < test_param.start + test_param.count; ++i) { + check(value_list_push(list, value_new(i)) == 1); + } + + iter = value_list_getIterator(list); + check(iter != NULL, "iter should not be NULL"); + + int i = test_param.start; + while (value_list_iter_hasNext(iter)) { + check(i < test_param.start + test_param.count, "iteration should not iterate more than values added"); + value *value = value_list_iter_next(iter); + check(value != NULL, "value should not be NULL"); + check(value->i == i, "value should be %d but is %d", i, value->i); + ++i; + } + + value_list_iter_destroy(&iter); + check(iter == NULL, "iter should be NULL"); + } + for_it_end(); + + it("should return NULL with NULL as this param") { + static value_list_iter *iter = NULL; + iter = value_list_getIterator(NULL); + check(iter == NULL, "iter should be NULL"); + } + } + + describe("value_list_iter_next()") { + it("should return NULL with NULL as this param") { + static value *value = NULL; + value = value_list_iter_next(NULL); + check(value == NULL, "value should be NULL"); + } + } + + describe("value_list_iter_hasNext()") { + it("should return false with NULL as this param") { + check(value_list_iter_hasNext(NULL) == false, "return should be false"); + } + } + + describe("value_list_iter_destroy()") { + it("should work with NULL as this param") { + value_list_iter_destroy(NULL); + } + + it("should work with a pointer to NULL as this param") { + static value_list_iter *empty = NULL; + value_list_iter_destroy(&empty); + check(empty == NULL, "empty should be NULL"); + } + } + + describe("value_list_destroy()") { + it("should work with NULL as this param") { + value_list_destroy(NULL); + } + + it("should work with a pointer to NULL as this param") { + static value_list *empty = NULL; + value_list_destroy(NULL); + value_list_destroy(&empty); + check(empty == NULL, "empty should be NULL"); + } + } + + describe("value_list_peek()") { + it("should return NULL with NULL as this param") { + static value *value = NULL; + value = value_list_peek(NULL); + check(value == NULL, "value should be NULL"); + } + + it("should return NULL with an empty list as this param") { + static value *value = NULL; + value = value_list_peek(list); + check(value == NULL, "value should be NULL"); + } } } } \ No newline at end of file