CMakeLists.txt

# CMakeLists.txt
#
# DPTLib
#
# Copyright (c) David Thomas, 2020-2024
#
# vim: sw=4 ts=8 et

cmake_minimum_required(VERSION 3.8)

if(NOT CMAKE_BUILD_TYPE)
    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel." FORCE)
endif()

list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/)

project(DPTLib VERSION 0.4.0 DESCRIPTION "DPT's C Library" LANGUAGES C)

# The values set in the toolchain file aren't available until this point.
if(TARGET_RISCOS)
    riscos_set_flags()
endif()


find_program(CCACHE_FOUND ccache)
if(CCACHE_FOUND)
    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
    set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)
endif(CCACHE_FOUND)


option(USE_FORTIFY "Use Fortify" OFF)
option(DPTLIB_IMAGES_READ_ONLY "Remove libpng write support" OFF)

# Referencing CMAKE_TOOLCHAIN_FILE avoids a warning on rebuilds.
if(NOT ${CMAKE_TOOLCHAIN_FILE} STREQUAL "")
    message(STATUS "DPTLib: Using toolchain file: ${CMAKE_TOOLCHAIN_FILE}")
endif()

add_subdirectory(libraries/fortify)

add_library(DPTLib)

set_target_properties(DPTLib PROPERTIES
    VERSION 0.4.0
    DESCRIPTION "DPT's Portable C Library"
    C_STANDARD 99
    PREFIX ""  # remove 'lib' prefix
    ARCHIVE_OUTPUT_NAME_DEBUG DPTLib-debug
    ARCHIVE_OUTPUT_NAME_RELEASE DPTLib
    ARCHIVE_OUTPUT_NAME_RELWITHDEBINFO DPTLib-relwithdebinfo
    ARCHIVE_OUTPUT_NAME_MINSIZEREL DPTLib-minsizerel)

target_include_directories(DPTLib PUBLIC include)

set(PUBLIC_HEADERS
    include/base/debug.h
    include/base/result.h
    include/base/types.h
    include/base/utils.h
    include/databases/digest-db.h
    include/databases/filename-db.h
    include/databases/pickle-reader-hash.h
    include/databases/pickle-writer-hash.h
    include/databases/pickle.h
    include/databases/tag-db.h
    include/datastruct/atom.h
    include/datastruct/bitarr.h
    include/datastruct/bitfifo.h
    include/datastruct/bitvec.h
    include/datastruct/cache.h
    include/datastruct/hash.h
    include/datastruct/hlist.h
    include/datastruct/list.h
    include/datastruct/ntree.h
    include/datastruct/vector.h
    include/framebuf/bitmap-set.h
    include/framebuf/bitmap.h
    include/framebuf/bmfont.h
    include/framebuf/colour.h
    include/framebuf/composite.h
    include/framebuf/pixelfmt.h
    include/framebuf/screen.h
    include/geom/box.h
    include/geom/layout.h
    include/geom/packer.h
    include/geom/point.h
    include/io/path.h
    include/io/stream-mem.h
    include/io/stream-mtfcomp.h
    include/io/stream-packbits.h
    include/io/stream-stdio.h
    include/io/stream.h
    include/test/txtscr.h
    include/utils/array.h
    include/utils/barith.h
    include/utils/bsearch.h
    include/utils/bytesex.h
    include/utils/fxp.h
    include/utils/maths.h
    include/utils/pack.h
    include/utils/primes.h)

# The public headers must be set as properties of the library, not as
# target_sources. The quoting is essential.
set_target_properties(DPTLib PROPERTIES PUBLIC_HEADER "${PUBLIC_HEADERS}")

set(DATABASE_SOURCES
    libraries/databases/digest-db/digest-db.c
    libraries/databases/filename-db/filename-db.c
    libraries/databases/pickle/delete.c
    libraries/databases/pickle/hash-reader.c
    libraries/databases/pickle/hash-writer.c
    libraries/databases/pickle/pickle.c
    libraries/databases/pickle/unpickle.c
    libraries/databases/tag-db/tag-db.c)

set(DATASTRUCT_SOURCES
    libraries/datastruct/atom/create.c
    libraries/datastruct/atom/delete-block.c
    libraries/datastruct/atom/delete.c
    libraries/datastruct/atom/destroy.c
    libraries/datastruct/atom/for-block.c
    libraries/datastruct/atom/get.c
    libraries/datastruct/atom/impl.h
    libraries/datastruct/atom/new.c
    libraries/datastruct/atom/set.c
    libraries/datastruct/bitarr/count.c
    libraries/datastruct/bitfifo/bitfifo.c
    libraries/datastruct/bitvec/and.c
    libraries/datastruct/bitvec/clear-all.c
    libraries/datastruct/bitvec/clear.c
    libraries/datastruct/bitvec/count.c
    libraries/datastruct/bitvec/create.c
    libraries/datastruct/bitvec/destroy.c
    libraries/datastruct/bitvec/ensure.c
    libraries/datastruct/bitvec/eq.c
    libraries/datastruct/bitvec/get.c
    libraries/datastruct/bitvec/impl.h
    libraries/datastruct/bitvec/length.c
    libraries/datastruct/bitvec/next.c
    libraries/datastruct/bitvec/or.c
    libraries/datastruct/bitvec/set-all.c
    libraries/datastruct/bitvec/set.c
    libraries/datastruct/bitvec/toggle.c
    libraries/datastruct/cache/cache.c
    libraries/datastruct/hash/count.c
    libraries/datastruct/hash/create.c
    libraries/datastruct/hash/destroy.c
    libraries/datastruct/hash/impl.h
    libraries/datastruct/hash/insert.c
    libraries/datastruct/hash/lookup-node.c
    libraries/datastruct/hash/lookup.c
    libraries/datastruct/hash/remove.c
    libraries/datastruct/hash/walk-cont.c
    libraries/datastruct/hash/walk.c
    libraries/datastruct/hlist/append.c
    libraries/datastruct/hlist/copy.c
    libraries/datastruct/hlist/free.c
    libraries/datastruct/hlist/impl.h
    libraries/datastruct/hlist/length.c
    libraries/datastruct/hlist/list.c
    libraries/datastruct/hlist/map.c
    libraries/datastruct/hlist/pop.c
    libraries/datastruct/hlist/push.c
    libraries/datastruct/hlist/reverse.c
    libraries/datastruct/hlist/to-array.c
    libraries/datastruct/list/add-head.c
    libraries/datastruct/list/find.c
    libraries/datastruct/list/init.c
    libraries/datastruct/list/remove.c
    libraries/datastruct/list/walk.c
    libraries/datastruct/ntree/copy.c
    libraries/datastruct/ntree/delete.c
    libraries/datastruct/ntree/depth.c
    libraries/datastruct/ntree/first-child.c
    libraries/datastruct/ntree/free.c
    libraries/datastruct/ntree/get-data.c
    libraries/datastruct/ntree/impl.h
    libraries/datastruct/ntree/insert-after.c
    libraries/datastruct/ntree/insert-before.c
    libraries/datastruct/ntree/insert.c
    libraries/datastruct/ntree/last-child.c
    libraries/datastruct/ntree/max-height.c
    libraries/datastruct/ntree/n-nodes.c
    libraries/datastruct/ntree/new.c
    libraries/datastruct/ntree/next-sibling.c
    libraries/datastruct/ntree/nth-child.c
    libraries/datastruct/ntree/parent.c
    libraries/datastruct/ntree/prepend.c
    libraries/datastruct/ntree/prev-sibling.c
    libraries/datastruct/ntree/set-data.c
    libraries/datastruct/ntree/unlink.c
    libraries/datastruct/ntree/walk.c
    libraries/datastruct/vector/clear.c
    libraries/datastruct/vector/create.c
    libraries/datastruct/vector/destroy.c
    libraries/datastruct/vector/ensure.c
    libraries/datastruct/vector/get.c
    libraries/datastruct/vector/impl.h
    libraries/datastruct/vector/insert.c
    libraries/datastruct/vector/length.c
    libraries/datastruct/vector/set-length.c
    libraries/datastruct/vector/set-width.c
    libraries/datastruct/vector/set.c
    libraries/datastruct/vector/width.c)

set(FRAMEBUF_SOURCES
    libraries/framebuf/bitmap/bitmap.c
    libraries/framebuf/bitmap/load.c
    libraries/framebuf/bitmap/save.c
    libraries/framebuf/bmfont/bmfont.c
    libraries/framebuf/colour/colour.c
    libraries/framebuf/composite/composite.c
    libraries/framebuf/pixelfmt/log2bpp.c
    libraries/framebuf/screen/screen.c)

set(GEOM_SOURCES
    libraries/geom/box/clipped.c
    libraries/geom/box/contains-box.c
    libraries/geom/box/contains-point.c
    libraries/geom/box/could-hold.c
    libraries/geom/box/grow.c
    libraries/geom/box/intersection.c
    libraries/geom/box/intersects.c
    libraries/geom/box/is-empty.c
    libraries/geom/box/reset.c
    libraries/geom/box/round.c
    libraries/geom/box/round4.c
    libraries/geom/box/translated.c
    libraries/geom/box/union.c
    libraries/geom/layout/layout.c
    libraries/geom/packer/impl.h
    libraries/geom/packer/packer.c)

set(IO_SOURCES
    libraries/io/path/path.c
    libraries/io/stream/stream-mem.c
    libraries/io/stream/stream-mtfcomp.c
    libraries/io/stream/stream-packbitscomp.c
    libraries/io/stream/stream-packbitsdecomp.c
    libraries/io/stream/stream-stdio.c
    libraries/io/stream/stream.c)

set(TESTLIB_SOURCES
    libraries/test/txtscr/txtscr.c)

set(UTILS_SOURCES
    libraries/utils/array/delelem.c
    libraries/utils/array/delelems.c
    libraries/utils/array/grow.c
    libraries/utils/array/shrink.c
    libraries/utils/array/squeeze.c
    libraries/utils/array/stretch.c
    libraries/utils/barith/barith.c
    libraries/utils/bsearch/bsearch-impl.h
    libraries/utils/bsearch/bsearch-int.c
    libraries/utils/bsearch/bsearch-short.c
    libraries/utils/bsearch/bsearch-uint.c
    libraries/utils/bsearch/bsearch-ushort.c
    libraries/utils/bytesex/rev-l-block.c
    libraries/utils/bytesex/rev-l-m.c
    libraries/utils/bytesex/rev-l.c
    libraries/utils/bytesex/rev-s-block.c
    libraries/utils/bytesex/rev-s-m.c
    libraries/utils/bytesex/rev-s-pair-m.c
    libraries/utils/bytesex/rev-s-pair.c
    libraries/utils/bytesex/rev-s.c
    libraries/utils/bytesex/util.h
    libraries/utils/fxp/smull-fxp16.c
    libraries/utils/fxp/umull-fxp16.c
    libraries/utils/maths/degs-to-rads.c
    libraries/utils/maths/gcd.c
    libraries/utils/pack/pack.c
    libraries/utils/pack/unpack.c
    libraries/utils/primes/primes.c)

set(ALL_SOURCES
    ${PUBLIC_HEADERS}
    ${DATABASE_SOURCES}
    ${DATASTRUCT_SOURCES}
    ${FRAMEBUF_SOURCES}
    ${GEOM_SOURCES}
    ${IO_SOURCES}
    ${TESTLIB_SOURCES}
    ${UTILS_SOURCES})

source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}" FILES ${ALL_SOURCES})

target_sources(DPTLib PRIVATE ${ALL_SOURCES})

target_compile_options(DPTLib PRIVATE -Wall -Wextra -pedantic)

if(CMAKE_BUILD_TYPE MATCHES Debug)
    target_compile_definitions(DPTLib PRIVATE DPTLIB_DEBUG)
endif()

# Library dependencies
#

if(TARGET_RISCOS)
    # OSLib (& anything else in GCCSDK)
    target_include_directories(DPTLib PUBLIC $ENV{GCCSDK_INSTALL_ENV}/include)
    target_link_libraries(DPTLib PUBLIC $ENV{GCCSDK_INSTALL_ENV}/lib/libOSLib32.a)
endif()

if(USE_FORTIFY)
    target_compile_definitions(DPTLib PRIVATE FORTIFY)
    target_link_libraries(DPTLib PUBLIC Fortify)
endif()

if(DPTLIB_IMAGES_READ_ONLY)
    target_compile_definitions(DPTLib PRIVATE DPTLIB_IMAGES_READ_ONLY)
endif()

if(NOT TARGET_RISCOS)
    ## Where PkgConfig is available, use it
    find_package(PkgConfig REQUIRED)
    # Use IMPORTED_TARGET to avoid header/lib mismatch on macOS.
    pkg_check_modules(PNG REQUIRED IMPORTED_TARGET libpng)
    target_include_directories(DPTLib PUBLIC ${PNG_INCLUDE_DIRS})
    target_compile_options(DPTLib PUBLIC ${PNG_CFLAGS_OTHER})
    target_link_libraries(DPTLib PUBLIC PkgConfig::PNG)
else()
    ## On RISC OS we must build libpng & zlib
    include(FetchContent)

    FetchContent_Declare(zlib
                         GIT_REPOSITORY https://github.com/madler/zlib.git
                         GIT_TAG v1.2.11)
    FetchContent_Declare(libpng
                         GIT_REPOSITORY https://github.com/glennrp/libpng.git
                         GIT_TAG v1.6.37)

    FetchContent_GetProperties(zlib)
    if(NOT zlib_POPULATED)
        message(STATUS "zlib: fetching and patching...")

        FetchContent_Populate(zlib)

        # Patch CMake minimum to 3.0.0
        execute_process(COMMAND           ${GIT_EXECUTABLE} apply ${CMAKE_CURRENT_LIST_DIR}/cmake/zlib.patch
                        WORKING_DIRECTORY ${zlib_SOURCE_DIR}
                        OUTPUT_QUIET
                        ERROR_QUIET) # because it'll error upon re-run

        # https://stackoverflow.com/questions/37582508/silence-cmp0048-warnings-in-vendored-projects
        set(CMAKE_PROJECT_INCLUDE_BEFORE "${CMAKE_CURRENT_SOURCE_DIR}/cmake/enable_cmp0048.cmake")
        add_subdirectory(${zlib_SOURCE_DIR} ${zlib_BINARY_DIR} EXCLUDE_FROM_ALL)
        unset(CMAKE_PROJECT_INCLUDE_BEFORE)

        # Set vars that libpng's CMakeLists will use to get zlib (as FindZLIB would set)
        set(ZLIB_INCLUDE_DIR ${zlib_SOURCE_DIR} ${zlib_BINARY_DIR})
        set(ZLIB_LIBRARY ${zlib_BINARY_DIR}/libz.a)
    endif()

    FetchContent_GetProperties(libpng)
    if(NOT libpng_POPULATED)
        message(STATUS "libpng: fetching and patching...")

        FetchContent_Populate(libpng)

        # Patch libm find_library problem
        execute_process(COMMAND           ${GIT_EXECUTABLE} apply ${CMAKE_CURRENT_LIST_DIR}/cmake/libpng-libm-unix.patch
                        WORKING_DIRECTORY ${libpng_SOURCE_DIR}
                        OUTPUT_QUIET
                        ERROR_QUIET) # because it'll error upon re-run

        cmake_policy(SET CMP0077 NEW)

        set(PNG_SHARED OFF CACHE BOOL "" FORCE)
        set(PNG_STATIC ON CACHE BOOL "" FORCE)
        set(PNG_EXECUTABLES OFF CACHE BOOL "" FORCE) # we only want lib
        set(PNG_TESTS OFF CACHE BOOL "" FORCE) # we only want lib
        set(SKIP_INSTALL_ALL OFF CACHE BOOL "" FORCE) # we only want lib

        add_subdirectory(${libpng_SOURCE_DIR} ${libpng_BINARY_DIR} EXCLUDE_FROM_ALL)
    endif()

    if(DPTLIB_IMAGES_READ_ONLY)
        message(STATUS "libpng: configuring for read only")
        set(PNGUSR pngusr-ro.dfa)
    else()
        message(STATUS "libpng: configuring for read-write")
        set(PNGUSR pngusr-rw.dfa)
    endif()
    set(DFA_XTRA ${libpng_BINARY_DIR}/pngusr-dptlib.dfa CACHE FILEPATH "File containing extra configuration settings" FORCE)
    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PNGUSR} ${DFA_XTRA} COPYONLY)

    include_directories(SYSTEM ${libpng_SOURCE_DIR}/ ${libpng_BINARY_DIR}/)
    include_directories(SYSTEM ${zlib_SOURCE_DIR}/)

    target_include_directories(DPTLib PUBLIC ${libpng_SOURCE_DIR}/ ${libpng_BINARY_DIR}/)
    target_link_libraries(DPTLib PUBLIC zlibstatic png_static)
endif()

# Installation
#

# Set install location
# - We can't use set(...) with FORCE because that will override any passed-in
#   configuration values.
# - We can't use set(...) without FORCE because that won't override the default
#   value...
# - So, just check for the default value and override it if set.
if(${CMAKE_INSTALL_PREFIX} STREQUAL "/usr/local")
    set(CMAKE_INSTALL_PREFIX "${CMAKE_CURRENT_BINARY_DIR}/install" CACHE PATH "CMake install prefix" FORCE)
endif()

# Install headers and library
# - We have to use EXCLUDE_FROM_ALL to stop the PUBLIC_HEADERs getting
#   installed by install(TARGETS ...).
install(TARGETS DPTLib ARCHIVE
    PUBLIC_HEADER EXCLUDE_FROM_ALL)
# - We can't use install(TARGETS ... PUBLIC_HEADER) to install headers, as
#   expected, since that flattens the include directory's hierarchy. Use
#   install(DIRECTORY ...) instead.
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include
    DESTINATION ${CMAKE_INSTALL_PREFIX}
    FILES_MATCHING PATTERN "*.h")


# Self-test executable
#

option(BUILD_TESTS "Build test program" OFF)
option(BUILD_SDL_TESTS "Build tests that use SDL" OFF)

if(BUILD_TESTS)
    set(TEST_SOURCES
        apps/test/main.c
        libraries/databases/tag-db/test/tag-db-test.c
        libraries/databases/pickle/test/pickle-test.c
        libraries/datastruct/atom/test/atom-test.c
        libraries/datastruct/bitarr/test/bitarr-test.c
        libraries/datastruct/bitfifo/test/bitfifo-test.c
        libraries/datastruct/bitvec/test/bitvec-test.c
        libraries/datastruct/cache/test/cache-test.c
        libraries/datastruct/hash/test/hash-test.c
        libraries/datastruct/list/test/list-test.c
        libraries/datastruct/ntree/test/ntree-test.c
        libraries/framebuf/bmfont/test/bmfont-test.c
        libraries/framebuf/composite/test/composite-test.c
        libraries/geom/box/test/box-test.c
        libraries/geom/layout/test/layout-test.c
        libraries/geom/packer/test/packer-test.c
        libraries/io/stream/test/stream-test.c
        libraries/utils/array/test/array-test.c
        libraries/utils/bsearch/test/bsearch-test.c
        libraries/datastruct/vector/test/vector-test.c)

    source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}" FILES ${TEST_SOURCES})

    # Avoid a warning from CMake
    set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)

    add_executable(DPTLibTest ${TEST_SOURCES})

    set_target_properties(DPTLibTest PROPERTIES
        DESCRIPTION "DPTLib test program"
        C_STANDARD 99
        OUTPUT_NAME_DEBUG DPTLibTest-debug
        OUTPUT_NAME_RELEASE DPTLibTest
        OUTPUT_NAME_RELWITHDEBINFO DPTLibTest-relwithdebinfo
        OUTPUT_NAME_MINSIZEREL DPTLibTest-minsizerel)

    # DPTTest dependencies
    # Of course, DPTLibTest depends on DPTLib.
    target_link_libraries(DPTLibTest DPTLib m)

    if(BUILD_SDL_TESTS)
        find_package(PkgConfig REQUIRED)
        pkg_check_modules(SDL2 REQUIRED sdl2 SDL2_image)
        target_link_libraries(DPTLibTest ${SDL2_LINK_LIBRARIES})
        target_include_directories(DPTLibTest PUBLIC ${SDL2_INCLUDE_DIRS})
        target_compile_options(DPTLibTest PUBLIC ${SDL2_CFLAGS_OTHER})

        target_compile_definitions(DPTLibTest PUBLIC USE_SDL)
    endif()

    install(TARGETS DPTLibTest RUNTIME
        DESTINATION ${CMAKE_INSTALL_PREFIX})
endif()