feat(add): make numbers able to be included by other code (#15)

* adopt the package layout of Cargo

* re-arrange tests

* remove dependency of pthread

* make numbers include-able

Author: guuzaa

CMakeLists.txt

@@ -4,21 +4,35 @@ set(BUILD_SHARED_LIBS OFF)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-set(version 0.0.1)
+string(COMPARE EQUAL ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_SOURCE_DIR} PROJECT_IS_TOP_LEVEL)
+
+if (PROJECT_IS_TOP_LEVEL)
+        message(STATUS "Project is top level")
+endif()
+
+option(NUMBERS_TEST "Build and perform numbers tests" ${PROJECT_IS_TOP_LEVEL})
+
+set(version 0.0.2)
 
 project(numbers VERSION ${version} LANGUAGES CXX)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 # Includes.
 set(SRC_INCLUDE_DIR ${PROJECT_SOURCE_DIR}/src/include)
-set(THIRD_PARTY_INCLUDE_DIR
-        ${PROJECT_SOURCE_DIR}/third_party
-)
 
-include_directories(${SRC_INCLUDE_DIR}  ${THIRD_PARTY_INCLUDE_DIR})
+include_directories(${SRC_INCLUDE_DIR})
 
 add_subdirectory(src)
-add_subdirectory(examples)
-add_subdirectory(third_party)
-add_subdirectory(test)
+
+if (NUMBERS_TEST) 
+        message(STATUS "Building and running tests")
+        set(THIRD_PARTY_INCLUDE_DIR
+                ${PROJECT_SOURCE_DIR}/third_party
+        )
+        include_directories(${THIRD_PARTY_INCLUDE_DIR})
+
+        add_subdirectory(examples)
+        add_subdirectory(third_party)
+        add_subdirectory(tests)
+endif()

README.md

@@ -17,7 +17,7 @@ numbers
 
 - **Full Control** over handling integer overflow
 
-- Same as **Plain Old Data** (WIP)
+- Same as **Primitive Types** (WIP)
 
 - **Support Integers**: i8, i16, i32, i64, u8, u16, u32, u64, even i128 & u128 (not ready yet)
 

examples/CMakeLists.txt

@@ -1,13 +1,31 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(NumbersExample LANGUAGES CXX)
+file(GLOB_RECURSE EXAMPLE_SOURCES "${PROJECT_SOURCE_DIR}/examples/*.cc")
 
-add_executable(${PROJECT_NAME} EXCLUDE_FROM_ALL main.cc)
+add_custom_target(example)
 
-target_link_libraries(${PROJECT_NAME} PRIVATE numbers_obj)
+foreach (example_source ${EXAMPLE_SOURCES})
+    get_filename_component(example_filename ${example_source} NAME)
+    string(REPLACE ".cc" "" example_name ${example_filename})
+    add_executable(${example_name} EXCLUDE_FROM_ALL ${example_source})
 
-add_custom_target(example
-    COMMAND ${PROJECT_NAME}
-    DEPENDS ${PROJECT_NAME}
-    COMMENT "Running Example..."
-)
+    add_custom_command(
+        TARGET example
+        COMMENT "Running example ${example_name}..."
+        COMMAND $<TARGET_FILE:${example_name}>
+        USES_TERMINAL
+    )
+
+    target_link_libraries(${example_name} PRIVATE numbers_obj)
+
+    set_target_properties(${example_name}
+            PROPERTIES
+            RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/examples"
+            COMMAND ${example_name}
+    )
+
+    add_custom_target(example-${example_name}
+        COMMENT "Running example ${example_name}..."
+        COMMAND ${example_name}
+    )
+endforeach ()

examples/arithmetic.cc

@@ -0,0 +1,36 @@
+#include <iostream>
+#include "numbers.h"
+
+int main(int argc, char const *argv[]) {
+  std::cout << "==== arithmetic_example ==== \n";
+  numbers::i8 a = 100;
+  std::cout << a << '\n';
+  try {
+    a = a + a;
+    std::cout << a << '\n';
+  } catch (std::runtime_error &err) {
+    std::cout << "Catch error: " << err.what() << '\n';
+  }
+
+  numbers::i8 b = 127;
+  numbers::i8 c = 0;
+  try {
+    numbers::i8 ret = c - b;
+    std::cout << ret << '\n';
+    c = -10;
+    ret = c - b;
+    std::cout << ret << '\n';
+  } catch (std::runtime_error &err) {
+    std::cout << "Catch error: " << err.what() << '\n';
+  }
+
+  auto d = static_cast<numbers::i16>(b);
+  try {
+    d = d + d;
+    std::cout << d << '\n';
+  } catch (std::runtime_error &err) {
+    std::cout << "Catch error: " << err.what() << '\n';
+  }
+
+  return 0;
+}

examples/checked_sub.cc

@@ -0,0 +1,15 @@
+#include <iostream>
+#include "numbers.h"
+
+int main(int argc, char const *argv[]) {
+  std::cout << "==== checked_sub_example ==== \n";
+  numbers::i8 a = numbers::i8::MIN;
+  std::cout << a << '\n';
+  std::optional<numbers::i8> ret = a.checked_sub(1);
+  if (ret) {
+    std::cout << ret.value() << '\n';
+  } else {
+    std::cout << "Overflow!\n";
+  }
+  return 0;
+}

examples/i128.cc

@@ -0,0 +1,12 @@
+#include "numbers.h"
+
+int main(int argc, char const *argv[]) {
+  std::cout << "==== i128_example ==== \n";
+  numbers::i128 a = 40;
+  numbers::i128 max = numbers::i128::MAX;
+  numbers::i128 min = numbers::i128::MIN;
+  std::cout << "a= " << a << ", max= " << max << ", min= " << min << '\n';
+  numbers::i128 ret = max - a;
+  std::cout << "max - a = " << ret << '\n';
+  return 0;
+}

examples/main.cc

@@ -0,0 +1,18 @@
+#include <iostream>
+#include <tuple>
+
+#include "numbers.h"
+
+int main(int argc, char const *argv[]) {
+  std::cout << "==== overflowing_div_example ==== \n";
+  numbers::i16 a = 40;
+  numbers::i16 b = 2;
+  auto [ret, overflowing] = a.overflowing_div(b);
+  std::cout << "a= " << a << ", b= " << b << '\n';
+  if (!overflowing) {
+    std::cout << "Never Overflow!\tret = " << ret << '\n';
+  } else {
+    std::cout << "Overflow!\n";
+  }
+  return 0;
+}

examples/overflowing_div.cc

@@ -0,0 +1,12 @@
+#include <iostream>
+#include "numbers.h"
+
+int main(int argc, char const *argv[]) {
+  std::cout << "==== saturating_mul_example ==== \n";
+  numbers::i64 a = 40;
+  numbers::i64 b = numbers::i64::MAX;
+  std::cout << "a= " << a << ", b= " << b << '\n';
+  numbers::i64 ret = a.saturating_mul(b);
+  std::cout << ret << '\n';
+  return 0;
+}

examples/saturating_mul.cc

@@ -0,0 +1,13 @@
+#include <iostream>
+#include "numbers.h"
+
+int main(int argc, char const *argv[]) {
+  std::cout << "==== u128_example ==== \n";
+  numbers::u128 a = 40;
+  numbers::u128 max = numbers::u128::MAX;
+  numbers::u128 min = numbers::u128::MIN;
+  std::cout << "a= " << a << ", max= " << max << ", min= " << min << '\n';
+  numbers::u128 ret = max - a;
+  std::cout << "max - a = " << ret << '\n';
+  return 0;
+}

examples/u128.cc

@@ -1,15 +1,7 @@
 add_subdirectory(numbers)
 
-add_library(numbers_lib STATIC ${ALL_OBJECT_FILES})
+add_library(numbers STATIC ${ALL_OBJECT_FILES})
 
-find_package(Threads REQUIRED)
-
-set(THIRDPARTY_LIBS
-        Threads::Threads
-)
-
-target_link_libraries(numbers_lib ${THIRDPARTY_LIBS})
-
-target_include_directories(numbers_lib PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+target_include_directories(numbers PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
         $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEIR}>
 )

src/CMakeLists.txt

@@ -2,7 +2,7 @@ enable_testing()
 
 include(GoogleTest)
 
-set(SRC_TEST_INCLUDE_DIR ${PROJECT_SOURCE_DIR}/test/include)
+set(SRC_TEST_INCLUDE_DIR ${PROJECT_SOURCE_DIR}/tests/include)
 include_directories(${SRC_TEST_INCLUDE_DIR})
 
 add_subdirectory(utils)

test/CMakeLists.txt tests/CMakeLists.txt

@@ -27,4 +27,4 @@ set_target_properties(${PROJECT_NAME}
 list(APPEND TEST_TARGETS ${PROJECT_NAME} PARENT_SCOPE)
 
 # Add the test targets
-add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})
+add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})