Merge pull request #484 from yamacir-kit/release-candidate

Release candidate

.github/workflows/build.yaml

@@ -14,11 +14,11 @@ jobs:
       matrix:
         compiler: [ g++, clang++ ]
         configuration: [ Debug, Release ]
-        system: [ ubuntu-20.04, ubuntu-22.04 ]
+        system: [ ubuntu-22.04, ubuntu-24.04, macos-14 ]
     steps:
       - uses: actions/checkout@v3
-      - run: ./script/setup.sh --all
+      - run: ./script/setup-${{ matrix.system }}.sh --all
       - run: cmake -B build -DCMAKE_BUILD_TYPE=${{ matrix.configuration }}
-      - run: cmake --build build --target develop
+      - run: cmake --build build --target continuous-integration
       - run: cmake -B example/build -S example -DCMAKE_BUILD_TYPE=${{ matrix.configuration }}
-      - run: cmake --build example/build --target develop
+      - run: cmake --build example/build --target continuous-integration

.github/workflows/release.yaml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: echo "VERSION=$(cat VERSION)" >> $GITHUB_ENV
-      - run: ./script/setup.sh
+      - run: ./script/setup-ubuntu.sh
       - run: cmake -B build -DCMAKE_BUILD_TYPE=Release
       - run: cmake --build build --target package
       - run: gh release create v${{ env.VERSION }} build/meevax_${{ env.VERSION }}_amd64.deb --title "Version ${{ env.VERSION }}"

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 basis/src
 build
 document

CMakeLists.txt

@@ -1,7 +1,8 @@
-cmake_minimum_required(VERSION 3.16.3) # Ubuntu 20.04 LTS default
+cmake_minimum_required(VERSION 3.22.1) # Ubuntu 22.04 LTS default
 
 execute_process(
-  COMMAND head -c -1 ${CMAKE_CURRENT_SOURCE_DIR}/VERSION
+  COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/VERSION
+  COMMAND tr -d \n
   OUTPUT_VARIABLE CURRENT_VERSION)
 
 project(meevax
@@ -12,44 +13,42 @@ project(meevax
 
 include(GNUInstallDirs)
 
-string(JOIN " " ${PROJECT_NAME}_RELEASE_PLUS
+string(JOIN " " ${PROJECT_NAME}_UNSTABLE_OPTIONS
+  # "-flto" # This optimization causes a problem in Apple Clang 15.0.0 where some static inline data members are no longer unique. It is unclear whether this is a code issue or a compiler issue.
   # "-fmerge-all-constants" # This optimization is very effective in reducing binary size, but non-standard to the C++ standard.
   # "-march=native" # This optimization causes "Illegal instruction" error (is Valgrind's bug) on CI.
   # "-mtune=native"
   )
 
 set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_CXX_FLAGS "-Wall -Wextra -Wpedantic -pipe")
 set(CMAKE_CXX_FLAGS_DEBUG "-Og -gdwarf-4") # NOTE: The `-gdwarf-4` option is set due to the following issues with Clang 14 and Valgrind versions below 3.20: https://bugzilla.mozilla.org/show_bug.cgi?id=1758782
 set(CMAKE_CXX_FLAGS_MINSIZEREL "-Os -DNDEBUG")
-set(CMAKE_CXX_FLAGS_RELEASE "-O3 -flto -DNDEBUG ${${PROJECT_NAME}_RELEASE_PLUS}")
+set(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG ${${PROJECT_NAME}_UNSTABLE_OPTIONS}")
 set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELEASE} -gdwarf-4")
-set(CMAKE_CXX_FLAGS "-Wall -Wextra -Wpedantic -pipe")
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
 set(CMAKE_VERBOSE_MAKEFILE OFF)
 
-# ---- Configure ---------------------------------------------------------------
-
-include(TestBigEndian)
-
-TEST_BIG_ENDIAN(IS_BIG_ENDIAN) # Use CMAKE_CXX_BYTE_ORDER if CMake >= 3.20
-
-if(${IS_BIG_ENDIAN})
-  set(${PROJECT_NAME}_BYTE_ORDER "big-endian")
-else()
-  set(${PROJECT_NAME}_BYTE_ORDER "little-endian")
+if(CMAKE_SYSTEM_NAME STREQUAL Darwin)
+  set(CMAKE_INSTALL_RPATH "@executable_path/../${CMAKE_INSTALL_LIBDIR}")
 endif()
 
+# ---- CONFIGURE ---------------------------------------------------------------
+
 execute_process(COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/script/unicode.sh --digit-value OUTPUT_VARIABLE ${PROJECT_NAME}_UNICODE_DIGIT_VALUE)
 execute_process(COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/script/unicode.sh --downcase    OUTPUT_VARIABLE ${PROJECT_NAME}_UNICODE_DOWNCASE)
 execute_process(COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/script/unicode.sh --property    OUTPUT_VARIABLE ${PROJECT_NAME}_UNICODE_PROPERTY)
 execute_process(COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/script/unicode.sh --upcase      OUTPUT_VARIABLE ${PROJECT_NAME}_UNICODE_UPCASE)
 
 execute_process(
-  COMMAND head -c -1 ${CMAKE_CURRENT_SOURCE_DIR}/configure/help.txt
+  COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/configure/help.txt
+  COMMAND tr \n \r
+  COMMAND sed s/\r$//
+  COMMAND tr \r \n
   OUTPUT_VARIABLE ${PROJECT_NAME}_HELP)
 
 file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/include/${PROJECT_NAME}/unicode/digit_value.hpp "${${PROJECT_NAME}_UNICODE_DIGIT_VALUE}")
@@ -63,7 +62,7 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/configure/Doxyfile    ${CMAKE_CURRENT
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/configure/README.md   ${CMAKE_CURRENT_SOURCE_DIR}/README.md)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/configure/version.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/kernel/version.cpp)
 
-# ---- Target basis ------------------------------------------------------------
+# ---- TARGET basis ------------------------------------------------------------
 
 file(GLOB ${PROJECT_NAME}_BASIS_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/basis/*.ss)
 
@@ -90,7 +89,7 @@ set_target_properties(basis PROPERTIES
   SOVERSION   ${PROJECT_VERSION_MAJOR}
   LINK_FLAGS_RELEASE -s)
 
-# ---- Target kernel -----------------------------------------------------------
+# ---- TARGET kernel -----------------------------------------------------------
 
 add_library(kernel SHARED)
 
@@ -100,7 +99,11 @@ target_sources(kernel PRIVATE ${${PROJECT_NAME}_KERNEL_SOURCES})
 
 target_include_directories(kernel
   PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-  PUBLIC $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
+  PUBLIC $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+  PUBLIC $<$<PLATFORM_ID:Darwin>:/opt/homebrew/include>)
+
+target_link_directories(kernel
+  PUBLIC $<$<PLATFORM_ID:Darwin>:/opt/homebrew/lib>)
 
 target_link_libraries(kernel
   PRIVATE ${CMAKE_DL_LIBS}
@@ -112,7 +115,7 @@ set_target_properties(kernel PROPERTIES
   SOVERSION   ${PROJECT_VERSION_MAJOR}
   LINK_FLAGS_RELEASE -s)
 
-# ---- Target shell ------------------------------------------------------------
+# ---- TARGET shell ------------------------------------------------------------
 
 add_executable(shell)
 
@@ -124,16 +127,14 @@ set_target_properties(shell PROPERTIES
   OUTPUT_NAME ${PROJECT_NAME} # Rename shell => meevax
   LINK_FLAGS_RELEASE -s)
 
-# ---- CMake Package -----------------------------------------------------------
+# ---- TARGET install ----------------------------------------------------------
 
 include(CMakePackageConfigHelpers)
 
 write_basic_package_version_file(
   ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
   COMPATIBILITY SameMajorVersion)
 
-# ---- Target install ----------------------------------------------------------
-
 install( # /usr/lib/libmeevax
   TARGETS basis kernel
   EXPORT ${PROJECT_NAME}-config
@@ -159,74 +160,73 @@ install( # /usr/share/meevax/meevax-config-version.cmake
   FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
   DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})
 
-# ---- Target package ----------------------------------------------------------
+# ---- TARGET uninstall --------------------------------------------------------
 
-set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
-set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Tatsuya Yamasaki")
-set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON)
-set(CPACK_GENERATOR DEB)
-set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE)
-set(CPACK_RESOURCE_FILE_README  ${CMAKE_CURRENT_SOURCE_DIR}/README.md)
-set(CPACK_THREADS 0)
+add_custom_target(uninstall
+  COMMAND sudo rm -rf ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}/${PROJECT_NAME}
+  COMMAND sudo rm -rf ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}
+  COMMAND sudo rm -rf ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/${CMAKE_SHARED_LIBRARY_PREFIX}${PROJECT_NAME}*
+  COMMAND sudo rm -rf ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})
 
-include(CPack)
+# ---- TARGET package ----------------------------------------------------------
 
-# ---- Target test -------------------------------------------------------------
-
-enable_testing()
+if(CMAKE_SYSTEM_NAME STREQUAL Linux)
+  set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
+  set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Tatsuya Yamasaki")
+  set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON)
+  set(CPACK_GENERATOR DEB)
+  set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE)
+  set(CPACK_RESOURCE_FILE_README ${CMAKE_CURRENT_SOURCE_DIR}/README.md)
+  include(CPack)
+endif()
 
-find_program(${PROJECT_NAME}_MEMORY_CHECK_COMMAND valgrind)
+# ---- TARGET test -------------------------------------------------------------
 
-set(${PROJECT_NAME}_MEMORY_CHECK_OPTIONS
-  --error-exitcode=1 # = EXIT_FAILURE)
-  --leak-check=full
-  --quiet
-  --show-leak-kinds=all)
+enable_testing()
 
-file(GLOB ${PROJECT_NAME}_TEST_SS ${CMAKE_CURRENT_SOURCE_DIR}/test/*.ss)
+find_program(${PROJECT_NAME}_VALGRIND valgrind)
 
-foreach(EACH IN LISTS ${PROJECT_NAME}_TEST_SS)
-  get_filename_component(FILENAME ${EACH} NAME_WE)
-  add_test(
-    NAME ${FILENAME}
-    COMMAND ${${PROJECT_NAME}_MEMORY_CHECK_COMMAND}
-            ${${PROJECT_NAME}_MEMORY_CHECK_OPTIONS}
-            ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/meevax
-            ${EACH})
-endforeach()
+if(${PROJECT_NAME}_VALGRIND STREQUAL ${PROJECT_NAME}_VALGRIND-NOTFOUND)
+  set(${PROJECT_NAME}_TEST "")
+else()
+  set(${PROJECT_NAME}_TEST ${${PROJECT_NAME}_VALGRIND} --error-exitcode=1 --leak-check=full --quiet --show-leak-kinds=all)
+endif()
 
 file(GLOB ${PROJECT_NAME}_TEST_CPP ${CMAKE_CURRENT_SOURCE_DIR}/test/*.cpp)
+file(GLOB ${PROJECT_NAME}_TEST_SH  ${CMAKE_CURRENT_SOURCE_DIR}/test/*.sh)
+file(GLOB ${PROJECT_NAME}_TEST_SS  ${CMAKE_CURRENT_SOURCE_DIR}/test/*.ss)
 
 foreach(EACH IN LISTS ${PROJECT_NAME}_TEST_CPP)
   get_filename_component(FILENAME ${EACH} NAME_WE)
   add_executable(test_${FILENAME} ${EACH})
   target_link_libraries(test_${FILENAME} PRIVATE basis kernel)
   target_compile_options(test_${FILENAME} PUBLIC -Wno-deprecated-declarations)
-  add_test(
-    NAME test/${FILENAME}
-    COMMAND ${${PROJECT_NAME}_MEMORY_CHECK_COMMAND}
-            ${${PROJECT_NAME}_MEMORY_CHECK_OPTIONS}
-            ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/test_${FILENAME})
+  add_test(NAME test/${FILENAME} COMMAND ${${PROJECT_NAME}_TEST} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/test_${FILENAME})
 endforeach()
 
-file(GLOB ${PROJECT_NAME}_TEST_SH ${CMAKE_CURRENT_SOURCE_DIR}/test/*.sh)
-
 foreach(EACH IN LISTS ${PROJECT_NAME}_TEST_SH)
   get_filename_component(FILENAME ${EACH} NAME_WE)
-  add_test(
-    NAME ${FILENAME}
-    COMMAND ${${PROJECT_NAME}_MEMORY_CHECK_COMMAND}
-            ${${PROJECT_NAME}_MEMORY_CHECK_OPTIONS}
-            ${EACH}
-            ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/meevax)
+  add_test(NAME ${FILENAME} COMMAND ${${PROJECT_NAME}_TEST} ${EACH} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/meevax)
 endforeach()
 
-# ---- Additional Targets ------------------------------------------------------
+foreach(EACH IN LISTS ${PROJECT_NAME}_TEST_SS)
+  get_filename_component(FILENAME ${EACH} NAME_WE)
+  add_test(NAME ${FILENAME} COMMAND ${${PROJECT_NAME}_TEST} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/meevax ${EACH})
+endforeach()
 
-execute_process(COMMAND nproc OUTPUT_VARIABLE ${PROJECT_NAME}_NPROC)
+# ---- TARGET continuous-integration -------------------------------------------
 
-add_custom_target(develop
-  COMMAND ${CMAKE_MAKE_PROGRAM} -j${${PROJECT_NAME}_NPROC}
-  COMMAND ${CMAKE_MAKE_PROGRAM} test ARGS=-j${${PROJECT_NAME}_NPROC}
-  COMMAND ${CMAKE_MAKE_PROGRAM} package
-  COMMAND sudo dpkg -i ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_${PROJECT_VERSION}_amd64.deb)
+if(CMAKE_SYSTEM_NAME STREQUAL Linux)
+  execute_process(COMMAND nproc OUTPUT_VARIABLE ${PROJECT_NAME}_NPROC)
+  add_custom_target(continuous-integration
+    COMMAND ${CMAKE_MAKE_PROGRAM} -j${${PROJECT_NAME}_NPROC}
+    COMMAND ${CMAKE_MAKE_PROGRAM} test ARGS=-j${${PROJECT_NAME}_NPROC}
+    COMMAND ${CMAKE_MAKE_PROGRAM} package
+    COMMAND sudo dpkg -i ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_${PROJECT_VERSION}_amd64.deb)
+else()
+  execute_process(COMMAND sysctl -n hw.ncpu OUTPUT_VARIABLE ${PROJECT_NAME}_NCPU)
+  add_custom_target(continuous-integration
+    COMMAND ${CMAKE_MAKE_PROGRAM} -j${${PROJECT_NAME}_NCPU}
+    COMMAND ${CMAKE_MAKE_PROGRAM} test ARGS=-j${${PROJECT_NAME}_NCPU}
+    COMMAND sudo ${CMAKE_MAKE_PROGRAM} install)
+endif()