Cmake project changes

- Added installation
- cpm fixes

Author: MAIPA01

CMakeLists.txt

@@ -1,15 +1,19 @@
 cmake_minimum_required(VERSION 3.30)
-project(pcre2cpp VERSION 1.2.4 LANGUAGES CXX)
+project(pcre2cpp VERSION 1.2.5 LANGUAGES CXX)
 
 option(BUILD_SHARED_LIBS 					"Build shared library" 			OFF)
-option(PCRE2CPP_BUILD_TESTS 				"Build tests"			 		OFF)
-option(PCRE2CPP_BUILD_BENCHMARK  			"Build benchmark" 				OFF)
-option(PCRE2CPP_BUILD_COVERAGE 				"Enable coverage reporting" 	OFF)
-option(PCRE2CPP_BUILD_DOCUMENTATION	 		"Build documentation"	 		OFF)
-option(PCRE2CPP_ENABLE_CLANG_TIDY 			"Enables clang-tidy checks" 	OFF)
+option(PCRE2CPP_BUILD_TESTS 				"Build tests"			 		${PROJECT_IS_TOP_LEVEL})
+option(PCRE2CPP_BUILD_BENCHMARK  			"Build benchmark" 				${PROJECT_IS_TOP_LEVEL})
+option(PCRE2CPP_BUILD_COVERAGE 				"Enable coverage reporting" 	${PROJECT_IS_TOP_LEVEL})
+option(PCRE2CPP_BUILD_DOCUMENTATION	 		"Build documentation"	 		${PROJECT_IS_TOP_LEVEL})
 
-option(PCRE2CPP_USE_EXTERNAL_MSTD 			"Uses users own mstd library (tested and compatible with: 1.5.0)"		OFF)
-option(PCRE2CPP_USE_EXTERNAL_PCRE2 			"Uses users own pcre2 library (tested and compatible with: 10.47)"		OFF)
+option(PCRE2CPP_ENABLE_CLANG_TIDY 			"Enables clang-tidy checks" 	${PROJECT_IS_TOP_LEVEL})
+
+option(PCRE2CPP_INSTALL 					"Enables installation of this project"						${PROJECT_IS_TOP_LEVEL})
+option(PCRE2CPP_INSTALL_TEST				"This is only to test if installation of pcre2cpp works" 	OFF)
+
+option(PCRE2CPP_MSTD_EXTERNAL 			"Uses users own mstd library (tested and compatible with: 1.5.2)"		OFF)
+option(PCRE2CPP_PCRE2_EXTERNAL 			"Uses users own pcre2 library (tested and compatible with: 10.47)"		OFF)
 
 option(PCRE2CPP_ENABLE_CXX20 					"Enables C++20 features" 							OFF)
 option(PCRE2CPP_DISABLE_ASSERT_ON_RELEASE 		"Disables assert on release builds" 				OFF)
@@ -26,19 +30,27 @@ message(STATUS "PCRE2CPP_DISABLE_UTF16: ${PCRE2CPP_DISABLE_UTF16}")
 message(STATUS "PCRE2CPP_DISABLE_UTF32: ${PCRE2CPP_DISABLE_UTF32}")
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/third_party.cmake)
+
 if (PCRE2CPP_ENABLE_CLANG_TIDY)
 	include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/clang_tidy.cmake)
 endif()
+
 if (PCRE2CPP_BUILD_DOCUMENTATION)
 	include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/doxygen.cmake)
 endif()
 
-add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/pcre2cpp)
+if (NOT PCRE2CPP_INSTALL_TEST)
+	add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/pcre2cpp)
+endif()
 
 if (PCRE2CPP_BUILD_TESTS OR PCRE2CPP_BUILD_COVERAGE)
 	add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/tests)
 endif()
 
+if (PCRE2CPP_BUILD_COVERAGE OR PCRE2CPP_BUILD_BENCHMARK)
+	add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/benchmark)
+endif()
+
 if (PCRE2CPP_BUILD_COVERAGE)
 	include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/coverage_report.cmake)
 
@@ -48,40 +60,4 @@ if (PCRE2CPP_BUILD_COVERAGE)
 			OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/coverage_report
 			CLEAN_TEMP
 	)
-endif()
-
-if (PCRE2CPP_BUILD_BENCHMARK)
-	add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/benchmark)
-endif()
-
-# TODO: zrob install cos nie dziala z TARGETS pcre2-8
-
-# library installation
-#set(PROJECT_CONFIG_FILE ${PROJECT_NAME}-config)
-#install(TARGETS ${PROJECT_NAME} EXPORT ${PROJECT_CONFIG_FILE}
-#	LIBRARY DESTINATION lib
-#	ARCHIVE DESTINATION lib
-#	RUNTIME DESTINATION bin
-#	INCLUDES DESTINATION ${INSTALL_HEADERS_PATH}
-#)
-
-#install(DIRECTORY ${BUILD_HEADERS_PATH}/ DESTINATION ${INSTALL_HEADERS_PATH})
-#install(TARGETS ${PROJECT_NAME} EXPORT ${PROJECT_NAME}-targets)
-
-# export cmake config
-#install(EXPORT ${PROJECT_CONFIG_FILE} DESTINATION cmake/${PROJECT_NAME} NAMESPACE ${PROJECT_NAMESPACE})
-#export(EXPORT ${PROJECT_CONFIG_FILE} NAMESPACE ${PROJECT_NAMESPACE})
-
-# configuration version file
-#set(PROJECT_CONFIG_VERSION_FILE ${PROJECT_CONFIG_FILE}-version.cmake)
-#include(CMakePackageConfigHelpers)
-#write_basic_package_version_file(
-#	"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_CONFIG_VERSION_FILE}"
-#	VERSION ${PROJECT_VERSION}
-#	COMPATIBILITY AnyNewerVersion
-#)
-
-#install(FILES
-#	"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_CONFIG_VERSION_FILE}"
-#	DESTINATION cmake/${PROJECT_NAME}
-#)
+endif()

CMakePresets.json

@@ -9,6 +9,7 @@
         "CMAKE_CXX_STANDARD_REQUIRED": "ON",
         "CMAKE_CXX_EXTENSIONS": "OFF",
         "BUILD_SHARED_LIBS": "OFF",
+        "PCRE2CPP_INSTALL_TEST": "OFF",
         "PCRE2CPP_DISABLE_UTF8": "OFF",
         "PCRE2CPP_DISABLE_UTF16": "OFF",
         "PCRE2CPP_DISABLE_UTF32": "OFF",

README.md

@@ -1,11 +1,13 @@
 # pcre2cpp
 
-**pcre2cpp** is a C++ wrapper for the PCRE2 (Perl Compatible Regular Expressions) library written in C. It provides an object-oriented interface for the original PCRE2 library, while maintaining the same functionality and behavior. [DOCS](https://maipa01.github.io/pcre2cpp/html)
+**pcre2cpp** is a C++ wrapper for the PCRE2 (Perl Compatible Regular Expressions) library written in C. It provides an
+object-oriented interface for the original PCRE2 library, while maintaining the same functionality and
+behavior. [DOCS](https://maipa01.github.io/pcre2cpp/html "Documentation")
 
 ## Features
 
 - Object-oriented interface to PCRE2 10.47.
-- Compatible with C++17 and C++20.
+- Compatible with C++17 and newer.
 - Easy to use regular expression matching with built-in result capturing.
 
 ## Requirements
@@ -15,18 +17,46 @@
 
 ## Options
 
-| CMAKE Option / #define                    | Description                                    | Default |
-|:------------------------------------------|:-----------------------------------------------|:-------:|
-| **PCRE2CPP_ENABLE_CXX20**                 | Enables C++20 features                         |   OFF   |
-| **PCRE2CPP_DISABLE_ASSERT_ON_RELEASE**    | Disables assert on release builds              |   OFF   |
-| **PCRE2CPP_CHANGE_ASSERTS_TO_EXCEPTIONS** | Changes every assert to exceptions in pcre2cpp |   OFF   |
-| **PCRE2CPP_DISABLE_UTF8**                 | Disables UTF-8 support                         |   OFF   |
-| **PCRE2CPP_DISABLE_UTF16**                | Disables UTF-16 support                        |   OFF   |
-| **PCRE2CPP_DISABLE_UTF32**                | Disables UTF-32 support                        |   OFF   |
+### Compilation defines options
+
+You can enable option using `#define option_name` or use cmake `set(option_name ON CACHE BOOL)`
+
+| Cmake option/C++ define Name            | Description                                    | Default |
+|:----------------------------------------|:-----------------------------------------------|:-------:|
+| `PCRE2CPP_ENABLE_CXX20`                 | Enables C++20 features                         |   OFF   |
+| `PCRE2CPP_DISABLE_ASSERT_ON_RELEASE`    | Disables assert on release builds              |   OFF   |
+| `PCRE2CPP_CHANGE_ASSERTS_TO_EXCEPTIONS` | Changes every assert to exceptions in pcre2cpp |   OFF   |
+| `PCRE2CPP_DISABLE_UTF8`                 | Disables UTF-8 support                         |   OFF   |
+| `PCRE2CPP_DISABLE_UTF16`                | Disables UTF-16 support                        |   OFF   |
+| `PCRE2CPP_DISABLE_UTF32`                | Disables UTF-32 support                        |   OFF   |
+
+### External libraries options
+
+If you want to use external libraries not installed by project using CPM
+
+| Cmake option Name         | Description                                                      | Default |
+|:--------------------------|:-----------------------------------------------------------------|:-------:|
+| `PCRE2CPP_MSTD_EXTERNAL`  | Uses users own mstd library (tested and compatible with: 1.5.2)  |   OFF   |
+| `PCRE2CPP_PCRE2_EXTERNAL` | Uses users own pcre2 library (tested and compatible with: 10.47) |   OFF   |
+
+### Project developing options
+
+These options are used while testing or changing code in project
+
+| Cmake option Name              | Description                                            |          Default          |
+|:-------------------------------|:-------------------------------------------------------|:-------------------------:|
+| `PCRE2CPP_BUILD_TESTS`         | Build tests                                            | `${PROJECT_IS_TOP_LEVEL}` |
+| `PCRE2CPP_BUILD_BENCHMARK`     | Build benchmark                                        | `${PROJECT_IS_TOP_LEVEL}` |
+| `PCRE2CPP_BUILD_COVERAGE`      | Enable coverage reporting                              | `${PROJECT_IS_TOP_LEVEL}` |
+| `PCRE2CPP_BUILD_DOCUMENTATION` | Build documentation                                    | `${PROJECT_IS_TOP_LEVEL}` |
+| `PCRE2CPP_ENABLE_CLANG_TIDY`   | Enables clang-tidy checks                              | `${PROJECT_IS_TOP_LEVEL}` |
+| `PCRE2CPP_INSTALL`             | Enables installation of this project                   | `${PROJECT_IS_TOP_LEVEL}` |
+| `PCRE2CPP_INSTALL_TEST`        | This is only to test if installation of pcre2cpp works |            OFF            |
 
 ## Benchmarks
 
 ### Compilation (10,000 iterations)
+
 | No.     | std::regex (ms) | PCRE2 (ms)  | pcre2cpp (ms) |
 |:--------|:---------------:|:-----------:|:-------------:|
 | **1.**  |     72,9598     | **16,1092** |    18,5241    |
@@ -47,6 +77,7 @@
 | **pcre2cpp**   |   18,3117   |                  -                   |         0,0018         |                  -                  |
 
 ### Match (10,000 iterations)
+
 | No.     | std::regex (ms) | PCRE2 (ms) | pcre2cpp (ms) |
 |:--------|:---------------:|:----------:|:-------------:|
 | **1.**  |    200,0510     | **7,6231** |    7,6295     |
@@ -67,6 +98,7 @@
 | **pcre2cpp**   |   7,9713   |                   -                   |       **0,0008**       |                  -                  |
 
 ### Match with all results (10,000 iterations)
+
 | No.     | std::regex (ms) | PCRE2 (ms)  | pcre2cpp (ms) |
 |:--------|:---------------:|:-----------:|:-------------:|
 | **1.**  |    200,0060     | **9,7453**  |    11,9927    |
@@ -88,16 +120,22 @@
 
 ## Installation
 
-To use **pcre2cpp**, simply download the latest release. There are no additional dependencies required.
+After installing, you can use `find_package(pcre2cpp)`.
 
-1. Download the latest release of **pcre2cpp**.
-2. Link the `pcre2cpp` library statically in your build system (e.g., `CMake` or `Make`).
+### Components
 
-Example for linking in `CMake`:
-```cmake
-find_package(pcre2cpp REQUIRED)
-target_link_libraries(your_project_name PRIVATE pcre2cpp)
-```
+You can also include components `find_pcakage(pcre2cpp COMPONENTS comp)`. They work the same way
+as [Compilation defines options](#compilation-defines-options), but
+they provide separate components you need to include.
+
+| Component Name       | Option                                  | Target Name                    |
+|:---------------------|:----------------------------------------|:-------------------------------|
+| CXX20                | `PCRE2CPP_ENABLE_CXX20`                 | pcre2cpp::CXX20                |
+| NO_ASSERT_ON_RELEASE | `PCRE2CPP_DISABLE_ASSERT_ON_RELEASE`    | pcre2cpp::NO_ASSERT_ON_RELEASE |
+| EXCEPTIONS           | `PCRE2CPP_CHANGE_ASSERTS_TO_EXCEPTIONS` | pcre2cpp::EXCEPTIONS           |
+| NO_UTF8              | `PCRE2CPP_DISABLE_UTF8`                 | pcre2cpp::NO_UTF8              |
+| NO_UTF16             | `PCRE2CPP_DISABLE_UTF16`                | pcre2cpp::NO_UTF16             |
+| NO_UTF32             | `PCRE2CPP_DISABLE_UTF32`                | pcre2cpp::NO_UTF32             |
 
 ## Example Usage
 
@@ -293,12 +331,15 @@ int main() {
 ```
 
 ## Offsets Graph
-![offsets graph](PCRE2CPPResult.png "Title")
+
+![offsets graph](PCRE2CPPResult.png "Offsets Graph")
 
 ## License
 
-This project is licensed under the **BSD 3-Clause License with Attribution Requirement**. For more details, check the [LICENSE](./LICENSE) file.
+This project is licensed under the **BSD 3-Clause License with Attribution Requirement**. For more details, check
+the [LICENSE](./LICENSE "License") file.
 
 ## Acknowledgments
 
-This project includes code from the [PCRE2 library](https://github.com/PhilipHazel/pcre2), distributed under the BSD License.
+This project includes code from the [PCRE2 library](https://github.com/PhilipHazel/pcre2 "PCRE2 github repo"), distributed under the BSD
+License.

benchmark/CMakeLists.txt

@@ -1,13 +1,27 @@
-project(pcre2cpp-benchmark VERSION 1.2.4 LANGUAGES CXX)
+project(pcre2cpp-benchmark VERSION 1.2.5 LANGUAGES CXX)
 
 # source files
 set(PROJECT_TEST_SOURCES ${PROJECT_NAME}_TEST_SOURCES)
 file(GLOB_RECURSE ${PROJECT_TEST_SOURCES} CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
 
+# region INSTALL_TESTING
+if (PCRE2CPP_INSTALL_TEST)
+    message(STATUS TESTING_INSTALL)
+
+    find_package(pcre2cpp REQUIRED
+            HINTS "${CMAKE_SOURCE_DIR}/dist"
+            COMPONENTS CXX20
+    )
+
+    add_library(pcre2cpp::all INTERFACE IMPORTED)
+    target_link_libraries(pcre2cpp::all INTERFACE pcre2cpp::pcre2cpp pcre2cpp::CXX20)
+endif()
+# endregion
+
 # make exec
 add_executable(${PROJECT_NAME} ${${PROJECT_TEST_SOURCES}})
 
-target_link_libraries(${PROJECT_NAME} PRIVATE pcre2cpp)
+target_link_libraries(${PROJECT_NAME} PRIVATE $<IF:$<BOOL:${PCRE2CPP_INSTALL_TEST}>, pcre2cpp::all, pcre2cpp::pcre2cpp>)
 
 # Konfiguracja PCH
 target_precompile_headers(${PROJECT_NAME} PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/pch.hpp")

cmake/coverage_report.cmake

@@ -81,6 +81,7 @@ function(setup_coverage_report)
     foreach(TARGET_NAME ${EXE_TARGETS})
         # GET BINARY_DIR OF TARGET
         get_target_property(TARGET_BINARY_DIR ${TARGET_NAME} BINARY_DIR)
+
         # GET EXE FILE
         set(EXE_FILE "$<TARGET_FILE:${TARGET_NAME}>")
 
@@ -118,7 +119,7 @@ function(setup_coverage_report)
     set(TEST_FILES_REGEX ".*[\\\\\\\/]${TEST_TARGET_SOURCE_DIR}[\\\\\\\/].*")
 
     add_custom_command(TARGET ${COVERAGE_TARGET_NAME} POST_BUILD
-        COMMAND ${LLVM_COV} show ${TEST_EXE}
+        COMMAND ${LLVM_COV} show ${TARGETS_EXECS}
         -instr-profile=${PROFDATA_FILE} 
         -format=${COVERAGE_FORMAT} 
         -output-dir=${COVERAGE_OUTPUT_DIR} 

cmake/get_cpm.cmake

@@ -0,0 +1,23 @@
+set(CPM_USE_LOCAL_PACKAGES OFF)
+# Storage location
+if(NOT CPM_SOURCE_CACHE)
+    set(CPM_SOURCE_CACHE ${CMAKE_SOURCE_DIR}/third_party)
+endif()
+
+# Set download location
+if(NOT CPM_DOWNLOAD_LOCATION)
+    set(CPM_DOWNLOAD_LOCATION "${CMAKE_SOURCE_DIR}/third_party/cpm/CPM.cmake")
+endif()
+
+# download CPM.cmake
+# Expand relative path. This is important if the provided path contains a tilde (~)
+get_filename_component(CPM_DOWNLOAD_LOCATION ${CPM_DOWNLOAD_LOCATION} ABSOLUTE)
+if(NOT EXISTS ${CPM_DOWNLOAD_LOCATION})
+    message(STATUS "Downloading CPM.cmake to ${CPM_DOWNLOAD_LOCATION}")
+    file(DOWNLOAD
+            https://github.com/cpm-cmake/CPM.cmake/releases/latest/download/CPM.cmake
+            ${CPM_DOWNLOAD_LOCATION}
+    )
+endif()
+message(STATUS "Include CPM.cmake from ${CPM_DOWNLOAD_LOCATION}")
+include(${CPM_DOWNLOAD_LOCATION})

cmake/pcre2cppConfig.cmake.in

@@ -0,0 +1,75 @@
+@PACKAGE_INIT@
+
+include(CMakeFindDependencyMacro)
+
+find_dependency(pcre2 REQUIRED)
+if(pcre2_FOUND)
+    add_library(@PROJECT_NAMESPACE@pcre2-8_imported INTERFACE IMPORTED)
+    if(TARGET pcre2-8)
+        target_link_libraries(@PROJECT_NAMESPACE@pcre2-8_imported INTERFACE pcre2-8)
+    else()
+        target_compile_definitions(@PROJECT_NAMESPACE@pcre2-8_imported INTERFACE PCRE2CPP_DISABLE_UTF8)
+    endif()
+
+    add_library(@PROJECT_NAMESPACE@pcre2-16_imported INTERFACE IMPORTED)
+    if(TARGET pcre2-16)
+        target_link_libraries(@PROJECT_NAMESPACE@pcre2-16_imported INTERFACE pcre2-16)
+    else()
+        target_compile_definitions(@PROJECT_NAMESPACE@pcre2-16_imported INTERFACE PCRE2CPP_DISABLE_UTF16)
+    endif()
+
+    add_library(@PROJECT_NAMESPACE@pcre2-32_imported INTERFACE IMPORTED)
+    if(TARGET pcre2-32)
+        target_link_libraries(@PROJECT_NAMESPACE@pcre2-32_imported INTERFACE pcre2-32)
+    else()
+        target_compile_definitions(@PROJECT_NAMESPACE@pcre2-32_imported INTERFACE PCRE2CPP_DISABLE_UTF32)
+    endif()
+endif()
+
+find_dependency(mstd REQUIRED)
+if(mstd_FOUND AND NOT TARGET @PROJECT_NAMESPACE@mstd_imported)
+    add_library(@PROJECT_NAMESPACE@mstd_imported INTERFACE IMPORTED)
+    target_link_libraries(@PROJECT_NAMESPACE@mstd_imported INTERFACE mstd::mstd)
+endif()
+
+set_and_check(@PROJECT_NAME@_INCLUDE_DIR "@PACKAGE_INCLUDE_INSTALL_DIR@")
+set(@PROJECT_NAME@_PCH_PATH "${@PROJECT_NAME@_INCLUDE_DIR}/@PROJECT_NAME@/pch.hpp")
+
+if(NOT TARGET @PROJECT_NAMESPACE@@PROJECT_NAME@)
+    include(${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@Targets.cmake)
+endif()
+
+set(@PROJECT_NAME@_components NO_UTF8 NO_UTF16 NO_UTF32 CXX20 NO_ASSERT_ON_RELEASE EXCEPTIONS)
+
+foreach(comp ${@PROJECT_NAME@_FIND_COMPONENTS})
+    if (NOT comp IN_LIST @PROJECT_NAME@_components)
+        set(@PROJECT_NAME@_NOT_FOUND_MESSAGE "Unsupported components: ${comp}")
+        set(@PROJECT_NAME@_FOUND FALSE)
+        break()
+    endif()
+
+    set(comp_target "@PROJECT_NAMESPACE@${comp}")
+
+    if(NOT TARGET ${comp_target})
+        add_library(${comp_target} INTERFACE IMPORTED)
+
+        if (comp STREQUAL "NO_UTF8")
+            target_compile_definitions(${comp_target} INTERFACE PCRE2CPP_DISABLE_UTF8)
+        elseif(comp STREQUAL "NO_UTF16")
+            target_compile_definitions(${comp_target} INTERFACE PCRE2CPP_DISABLE_UTF16)
+        elseif(comp STREQUAL "UTF32")
+            target_compile_definitions(${comp_target} INTERFACE PCRE2CPP_DISABLE_UTF32)
+        elseif(comp STREQUAL "CXX20")
+            target_compile_definitions(${comp_target} INTERFACE PCRE2CPP_ENABLE_CXX20 MSTD_ENABLE_CXX20)
+            set_target_properties(${comp_target} PROPERTIES
+                INTERFACE_COMPILE_FEATURES cxx_std_20
+            )
+        elseif(comp STREQUAL "NO_ASSERT_ON_RELEASE")
+            target_compile_definitions(${comp_target} INTERFACE PCRE2CPP_DISABLE_ASSERT_ON_RELEASE MSTD_DISABLE_ASSERT_ON_RELEASE)
+        elseif(comp STREQUAL "EXCEPTIONS")
+            set_target_properties(${comp_target} PROPERTIES
+                INTERFACE_COMPILE_DEFINITIONS PCRE2CPP_CHANGE_ASSERTS_TO_EXCEPTIONS
+            )
+        endif()
+    endif()
+endforeach()