Rename cmake option variables: URL_... -> UPA_...

The URL_BUILD_TESTS variable has been retained for backward
compatibility and is identical to UPA_BUILD_TESTS, but will be removed
in future releases.

.github/workflows/documentation.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Extract and try to build C++ examples from docs
         run: |
           tools/extract-cpp.py examples/extracted-cpp README.md
-          cmake -S . -B build -DCMAKE_CXX_COMPILER=g++ -DCMAKE_CXX_STANDARD=20 -DURL_BUILD_TESTS=OFF -DURL_BUILD_EXTRACTED=ON
+          cmake -S . -B build -DCMAKE_CXX_COMPILER=g++ -DCMAKE_CXX_STANDARD=20 -DUPA_BUILD_TESTS=OFF -DUPA_BUILD_EXTRACTED=ON
           cmake --build build
 
       # Install and run doxygen

.github/workflows/test-macos.yml

@@ -17,7 +17,7 @@ jobs:
           - name: clang++ C++17
             cxx_compiler: clang++
             cxx_standard: 17
-            cmake_options: "-DURL_BUILD_BENCH=ON"
+            cmake_options: "-DUPA_BUILD_BENCH=ON"
             after_test: |
               build/bench-url test/wpt/urltestdata.json
 

.github/workflows/test-ubuntu.yml

@@ -22,12 +22,12 @@ jobs:
           - name: clang++ C++17 with sanitizer
             cxx_compiler: clang++
             cxx_standard: 17
-            cmake_options: "-DURL_TEST_SANITIZER=ON"
+            cmake_options: "-DUPA_TEST_SANITIZER=ON"
 
           - name: clang++ C++17 with valgrind
             cxx_compiler: clang++
             cxx_standard: 17
-            cmake_options: "-DURL_TEST_VALGRIND=ON"
+            cmake_options: "-DUPA_TEST_VALGRIND=ON"
             install: "valgrind"
 
           - name: g++-12 C++20
@@ -38,7 +38,7 @@ jobs:
           - name: g++ C++17 Codecov
             cxx_compiler: g++
             cxx_standard: 17
-            cmake_options: "-DURL_TEST_COVERAGE=ON"
+            cmake_options: "-DUPA_TEST_COVERAGE=ON"
             install: "lcov"
             after_test: |
               # See: https://github.com/codecov/example-cpp11-cmake
@@ -50,18 +50,18 @@ jobs:
           - name: g++ C++17 amalgamated
             cxx_compiler: g++
             cxx_standard: 17
-            cmake_options: "-DURL_AMALGAMATED=ON -DURL_BUILD_EXAMPLES=ON"
+            cmake_options: "-DUPA_AMALGAMATED=ON -DUPA_BUILD_EXAMPLES=ON"
             before_cmake: tools/amalgamate.sh
 
           - name: g++-9 C++14
             cxx_compiler: g++-9
             cxx_standard: 14
-            cmake_options: "-DURL_BUILD_EXAMPLES=ON"
+            cmake_options: "-DUPA_BUILD_EXAMPLES=ON"
 
           - name: g++-9 C++11
             cxx_compiler: g++-9
             cxx_standard: 11
-            cmake_options: "-DURL_BUILD_EXAMPLES=ON"
+            cmake_options: "-DUPA_BUILD_EXAMPLES=ON"
 
     steps:
     - uses: actions/checkout@v4

CMakeLists.txt

@@ -36,32 +36,33 @@ if (NOT CMAKE_CXX_STANDARD)
 endif()
 
 # Upa URL is top level project?
-if (NOT DEFINED URL_MAIN_PROJECT)
-  set(URL_MAIN_PROJECT OFF)
+if (NOT DEFINED UPA_MAIN_PROJECT)
+  set(UPA_MAIN_PROJECT OFF)
   if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-    set(URL_MAIN_PROJECT ON)
+    set(UPA_MAIN_PROJECT ON)
   endif()
 endif()
 
 # Options
-option(URL_BUILD_TESTS "Build the Upa URL tests." ${URL_MAIN_PROJECT})
-option(URL_BUILD_BENCH "Build the Upa URL benchmarks." OFF)
-option(URL_BUILD_FUZZER "Build the Upa URL fuzzer." OFF)
-option(URL_BUILD_EXAMPLES "Build the Upa URL examples." OFF)
-option(URL_BUILD_EXTRACTED "Build Upa URL examples extracted from the docs." OFF)
-option(URL_BUILD_TOOLS "Build tools." OFF)
-option(URL_INSTALL "Generate the install target." ON)
+option(URL_BUILD_TESTS "Build the Upa URL tests." ${UPA_MAIN_PROJECT})
+option(UPA_BUILD_TESTS "Build the Upa URL tests." ${URL_BUILD_TESTS})
+option(UPA_BUILD_BENCH "Build the Upa URL benchmarks." OFF)
+option(UPA_BUILD_FUZZER "Build the Upa URL fuzzer." OFF)
+option(UPA_BUILD_EXAMPLES "Build the Upa URL examples." OFF)
+option(UPA_BUILD_EXTRACTED "Build Upa URL examples extracted from the docs." OFF)
+option(UPA_BUILD_TOOLS "Build tools." OFF)
+option(UPA_INSTALL "Generate the install target." ON)
 # library options
-option(URL_AMALGAMATED "Use amalgamated URL library source." OFF)
+option(UPA_AMALGAMATED "Use amalgamated URL library source." OFF)
 # tests build options
-option(URL_TEST_COVERAGE "Build tests with code coverage reporting" OFF)
-option(URL_TEST_COVERAGE_CLANG "Build tests with Clang source-based code coverage" OFF)
-option(URL_TEST_SANITIZER "Build tests with Clang sanitizer" OFF)
-option(URL_TEST_VALGRIND "Run tests with Valgrind" OFF)
+option(UPA_TEST_COVERAGE "Build tests with code coverage reporting" OFF)
+option(UPA_TEST_COVERAGE_CLANG "Build tests with Clang source-based code coverage" OFF)
+option(UPA_TEST_SANITIZER "Build tests with Clang sanitizer" OFF)
+option(UPA_TEST_VALGRIND "Run tests with Valgrind" OFF)
 
 # AFL, Honggfuzz, or Clang libFuzzer
-if (URL_BUILD_FUZZER)
-  set(URL_BUILD_TESTS OFF)
+if (UPA_BUILD_FUZZER)
+  set(UPA_BUILD_TESTS OFF)
   get_filename_component(cxx_name ${CMAKE_CXX_COMPILER} NAME)
   # https://aflplus.plus/docs/env_variables/
   string(REGEX MATCH "^afl-((c|clang|clang-fast|clang-lto|g)\\+\\+|g\\+\\+-fast)$" AFL ${cxx_name})
@@ -78,7 +79,7 @@ if (URL_BUILD_FUZZER)
 endif()
 
 # Code coverage reporting
-if (URL_TEST_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+if (UPA_TEST_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
   # add flags for GCC & LLVM/Clang
   add_compile_options(-O0 -g --coverage)
   add_link_options(--coverage)
@@ -87,23 +88,23 @@ endif()
 # Clang source-based code coverage
 # https://clang.llvm.org/docs/SourceBasedCodeCoverage.html
 # https://llvm.org/docs/CommandGuide/llvm-cov.html#show-command
-if (URL_TEST_COVERAGE_CLANG)
+if (UPA_TEST_COVERAGE_CLANG)
   if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
     add_compile_options(-fprofile-instr-generate=${CMAKE_CURRENT_BINARY_DIR}/%m.profraw -fcoverage-mapping)
     add_link_options(-fprofile-instr-generate)
   endif()
 endif()
 
 # Clang sanitizer
-if (URL_TEST_SANITIZER)
+if (UPA_TEST_SANITIZER)
   if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
     add_compile_options(-O1 -g -fsanitize=address -fsanitize=undefined -fsanitize=integer -fno-omit-frame-pointer)
     add_link_options(-g -fsanitize=address -fsanitize=undefined)
   endif()
 endif()
 
 # Valgrind
-if (URL_TEST_VALGRIND)
+if (UPA_TEST_VALGRIND)
   find_program(MEMORYCHECK valgrind)
   set(MEMORYCHECK_COMMAND "${MEMORYCHECK} --error-exitcode=1 --leak-check=full")
   separate_arguments(MEMORYCHECK_COMMAND)
@@ -112,12 +113,12 @@ endif()
 include_directories(deps)
 
 # Are Upa URL and ICU libraries needed?
-if (URL_BUILD_TESTS OR URL_BUILD_BENCH OR URL_BUILD_FUZZER OR URL_BUILD_EXAMPLES OR
-    URL_BUILD_EXTRACTED OR URL_INSTALL OR NOT URL_BUILD_TOOLS)
+if (UPA_BUILD_TESTS OR UPA_BUILD_BENCH OR UPA_BUILD_FUZZER OR UPA_BUILD_EXAMPLES OR
+    UPA_BUILD_EXTRACTED OR UPA_INSTALL OR NOT UPA_BUILD_TOOLS)
   # This library depends on ICU
   find_package(ICU REQUIRED COMPONENTS i18n uc)
 
-  if (URL_AMALGAMATED)
+  if (UPA_AMALGAMATED)
     add_library(${upa_lib_target} STATIC
       single_include/upa/url.cpp)
     target_include_directories(${upa_lib_target}
@@ -143,10 +144,10 @@ endif()
 
 # Test targets
 
-if (URL_BUILD_TESTS)
+if (UPA_BUILD_TESTS)
   enable_testing()
 
-  if (URL_AMALGAMATED)
+  if (UPA_AMALGAMATED)
     set(test_files
       test/test-amalgamate.cpp
     )
@@ -180,7 +181,7 @@ if (URL_BUILD_TESTS)
       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/test
       COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${test_name})
 
-    if (URL_TEST_VALGRIND)
+    if (UPA_TEST_VALGRIND)
       add_test(NAME ${test_name}_valgrind
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/test
         COMMAND ${MEMORYCHECK_COMMAND} ${CMAKE_CURRENT_BINARY_DIR}/${test_name})
@@ -190,7 +191,7 @@ endif()
 
 # Benchmark targets
 
-if (URL_BUILD_BENCH)
+if (UPA_BUILD_BENCH)
   file(GLOB bench_files test/bench-*.cpp)
 
   foreach(file ${bench_files})
@@ -202,7 +203,7 @@ endif()
 
 # Fuzzer targets
 
-if (URL_BUILD_FUZZER)
+if (UPA_BUILD_FUZZER)
   set(fuzz_files
     test/fuzz-url.cpp
   )
@@ -220,26 +221,26 @@ endif()
 
 # Example's targets
 
-if (URL_BUILD_EXAMPLES)
+if (UPA_BUILD_EXAMPLES)
   add_executable(urlparse examples/urlparse.cpp)
   target_link_libraries(urlparse ${upa_lib_target})
 endif()
 
-if (URL_BUILD_EXTRACTED)
+if (UPA_BUILD_EXTRACTED)
   add_subdirectory(examples/extracted-cpp)
 endif()
 
 # Tool's targets
 
-if (URL_BUILD_TOOLS)
+if (UPA_BUILD_TOOLS)
   add_executable(dumpCharBitSets tools/dumpCharBitSets.cpp)
   set_property(TARGET dumpCharBitSets PROPERTY CXX_STANDARD 17)
   target_include_directories(dumpCharBitSets PRIVATE include)
 endif()
 
 # Install
 
-if (URL_INSTALL AND NOT URL_AMALGAMATED)
+if (UPA_INSTALL AND NOT UPA_AMALGAMATED)
   include(GNUInstallDirs)
   include(CMakePackageConfigHelpers)
 
@@ -291,7 +292,7 @@ if (URL_INSTALL AND NOT URL_AMALGAMATED)
   )
 
   # Packaging
-  if (URL_MAIN_PROJECT)
+  if (UPA_MAIN_PROJECT)
     set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
     set(CPACK_SOURCE_GENERATOR "ZIP")
     set(CPACK_SOURCE_IGNORE_FILES \\.git* /build*/ /*\\.yml)

README.md

@@ -37,7 +37,7 @@ The simplest way is to use two amalgamated files: `url.h` and `url.cpp`. You can
 
 The library can be built and installed using CMake 3.13 or later. To build and install to default directory (usualy `/usr/local` on Linux) run following commands:
 ```sh
-cmake -B build -DURL_BUILD_TESTS=OFF
+cmake -B build -DUPA_BUILD_TESTS=OFF
 cmake --build build
 cmake --install build
 ```