Cmake overhaul (#2)

* INDEV: Overhaul CMakeLists

* INDEV: Add integration test

* Create CI.yml

* Fix broken tests

* Add integration test pipeline

Author: nerudaj

.github/workflows/CI.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "master" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "master" ]
   workflow_dispatch:
 
 env:

.github/workflows/Integration.yml

@@ -0,0 +1,36 @@
+name: IntegrationTests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+env:
+  IT_DIR: ${{github.workspace}}/integration_tests
+
+jobs:
+  build:
+    runs-on: windows-2022
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Get branch names.
+      id: branch-names
+      uses: tj-actions/branch-names@v8
+
+    - name: Configure
+      working-directory: ${{env.IT_DIR}}/cpm
+      run: |
+        mkdir _build
+        cd _build
+        cmake -D GIT_BRANCH=${{ steps.branch-names.outputs.current_branch }} ..
+      shell: cmd
+
+    - name: Build
+      working-directory: ${{env.IT_DIR}}/cpm/_build
+      run: |
+        cmake --build . --config Debug
+      shell: cmd

.gitignore

@@ -0,0 +1 @@
+_build

CMakeLists.txt

@@ -1,15 +1,24 @@
 cmake_minimum_required(VERSION 3.10)
-project(BitmapPlusPlus VERSION "1.1.0" DESCRIPTION "Simple and Fast header only Bitmap (BMP) C++ library" LANGUAGES CXX)
+
+project(BitmapPlusPlus
+    VERSION "1.1.0"
+    DESCRIPTION "Simple and Fast header only Bitmap (BMP) C++ library"
+    LANGUAGES CXX
+)
+
+if (${CMAKE_SOURCE_DIR} STREQUAL ${PROJECT_SOURCE_DIR} )
+    set ( BUILD_EXAMPLES_DEFAULT ON )
+else ()
+    set ( BUILD_EXAMPLES_DEFAULT OFF )
+endif ()
+
+option( BPP_BUILD_EXAMPLES "Requires BPP to build all examples inside examples/ folder." ${BUILD_EXAMPLES_DEFAULT} )
+
 set(CMAKE_CXX_STANDARD 17)
 
-# Examples
-option(BPP_BUILD_EXAMPLES "Requires BPP to build all examples inside examples/ folder." ON)
+add_subdirectory( "${CMAKE_CURRENT_SOURCE_DIR}/lib" )
+
 if(BPP_BUILD_EXAMPLES)
-    file(GLOB_RECURSE EXAMPLES_FILES ${CMAKE_SOURCE_DIR}/examples/*.cpp)
-    foreach(example_file ${EXAMPLES_FILES})
-        message(STATUS "Adding example ${example_file}")
-        get_filename_component(target_name ${example_file} NAME_WE)
-        include_directories(${target_name} ${CMAKE_CURRENT_SOURCE_DIR})
-        add_executable(${target_name} ${example_file})
-    endforeach()
+    enable_testing()
+    add_subdirectory( "${CMAKE_CURRENT_SOURCE_DIR}/examples" )
 endif()

examples/CMakeLists.txt

@@ -0,0 +1,18 @@
+cmake_minimum_required ( VERSION 3.10 )
+
+file( GLOB_RECURSE EXAMPLES_FILES "${CMAKE_CURRENT_SOURCE_DIR}/*.cpp" )
+
+foreach(example_file ${EXAMPLES_FILES})
+    message(STATUS "Adding example ${example_file}")
+    get_filename_component(target_name ${example_file} NAME_WE)
+
+    add_executable(${target_name} ${example_file})
+    target_link_libraries( ${target_name} bpp::BitmapPlusPlus )
+    target_compile_definitions ( ${target_name} PRIVATE "ROOT_DIR=\"${PROJECT_SOURCE_DIR}\"" )
+    target_compile_definitions ( ${target_name} PRIVATE "BIN_DIR=\"${PROJECT_BINARY_DIR}\"" )
+
+    add_test (
+        NAME ${target_name}
+        COMMAND ${target_name}
+    )
+endforeach()

examples/bernoulli_dist.cpp

@@ -3,24 +3,25 @@
 #include <random>
 
 int main() {
-  try {
-    // Generate a bitmap of 10% white and 90% black pixels
-    bmp::Bitmap image(512, 512);
+	try {
+		// Generate a bitmap of 10% white and 90% black pixels
+		bmp::Bitmap image(512, 512);
 
-    std::random_device seed{};
-    std::default_random_engine eng{seed()};
-    std::bernoulli_distribution dist(0.10); // 10% White, 90% Black
+		std::random_device seed{};
+		std::default_random_engine eng{ seed() };
+		std::bernoulli_distribution dist(0.10); // 10% White, 90% Black
 
-    for (bmp::Pixel &pixel: image) {
-      const bmp::Pixel color = dist(eng) ? bmp::White : bmp::Black;
-      pixel = color;
-    }
+		for (bmp::Pixel& pixel : image) {
+			const bmp::Pixel color = dist(eng) ? bmp::White : bmp::Black;
+			pixel = color;
+		}
 
-    image.save("bernoulli.bmp");
+		image.save(std::string(BIN_DIR) + "/bernoulli.bmp");
 
-    return EXIT_SUCCESS;
-  } catch (const bmp::Exception &e) {
-    std::cerr << "[BMP ERROR]: " << e.what() << '\n';
-    return EXIT_FAILURE;
-  }
+		return EXIT_SUCCESS;
+	}
+	catch (const bmp::Exception& e) {
+		std::cerr << "[BMP ERROR]: " << e.what() << '\n';
+		return EXIT_FAILURE;
+	}
 }

examples/chess_board.cpp

@@ -2,32 +2,33 @@
 #include "BitmapPlusPlus.hpp"
 
 int main() {
-  try {
-    // 8x8 chess board
-    bmp::Bitmap image(640, 640);
-    const std::size_t board_dims = 8;
-    const std::int32_t rect_w = image.width() / board_dims;
-    const std::int32_t rect_h = image.height() / board_dims;
+	try {
+		// 8x8 chess board
+		bmp::Bitmap image(640, 640);
+		const std::size_t board_dims = 8;
+		const std::int32_t rect_w = image.width() / board_dims;
+		const std::int32_t rect_h = image.height() / board_dims;
 
-    // Iterate over rects
-    bool is_white = true;
-    for (std::size_t x = 0; x < image.width(); x += rect_w) {
-      for (std::size_t y = 0; y < image.height(); y += rect_h) {
-        const bmp::Pixel color = is_white ? bmp::White : bmp::Black;
-        // Fill rect
-        image.fill_rect(x, y, rect_w, rect_h, color);
-        // Next rect in will be the opposite color
-        is_white = !is_white;
-      }
-      is_white = !is_white;
-    }
+		// Iterate over rects
+		bool is_white = true;
+		for (std::size_t x = 0; x < image.width(); x += rect_w) {
+			for (std::size_t y = 0; y < image.height(); y += rect_h) {
+				const bmp::Pixel color = is_white ? bmp::White : bmp::Black;
+				// Fill rect
+				image.fill_rect(x, y, rect_w, rect_h, color);
+				// Next rect in will be the opposite color
+				is_white = !is_white;
+			}
+			is_white = !is_white;
+		}
 
-    // Save bitmap to file
-    image.save("chess_board.bmp");
+		// Save bitmap to file
+		image.save(std::string(BIN_DIR) + "/chess_board.bmp");
 
-    return EXIT_SUCCESS;
-  } catch (const bmp::Exception &e) {
-    std::cerr << "[BMP ERROR]: " << e.what() << '\n';
-    return EXIT_FAILURE;
-  }
+		return EXIT_SUCCESS;
+	}
+	catch (const bmp::Exception& e) {
+		std::cerr << "[BMP ERROR]: " << e.what() << '\n';
+		return EXIT_FAILURE;
+	}
 }

examples/draw_primitives.cpp

@@ -4,32 +4,32 @@
 using namespace bmp;
 
 int main() {
-  // Create a 512x240 blank image
-  Bitmap image(512, 240);
-  image.clear(Pixel(0x25292e));
-
-  /** Line **/
-  // Draw a yellow line from position (250, 50) to position (500, 50)
-  image.draw_line(250, 50, 500, 50, Yellow);
-
-  /** Rectangle **/
-  // Draw a red rectangle in position (10, 10) with size 100x100
-  image.draw_rect(10, 10, 100, 100, Red);
-  // Draw a white filled rectangle in position (120, 10) with size 100x100
-  image.fill_rect(120, 10, 100, 100, White);
-
-  /** Triangle **/
-  image.draw_triangle(60, 120, 10, 220, 120, 220, Cyan);
-  image.fill_triangle(180, 120, 130, 220, 245, 220, Magenta);
-
-  /** Circle **/
-  // Draw a non-filled Gray circle in position (300, 170) with 50 pixels radius
-  image.draw_circle(300, 170, 50, Gray);
-  // Draw a filled Lime circle in position (300, 170) with 50 pixels radius
-  image.fill_circle(420, 170, 50, Lime);
-
-  // Save bitmap
-  image.save("primitives.bmp");
-
-  return EXIT_SUCCESS;
+	// Create a 512x240 blank image
+	Bitmap image(512, 240);
+	image.clear(Pixel(0x25292e));
+
+	/** Line **/
+	// Draw a yellow line from position (250, 50) to position (500, 50)
+	image.draw_line(250, 50, 500, 50, Yellow);
+
+	/** Rectangle **/
+	// Draw a red rectangle in position (10, 10) with size 100x100
+	image.draw_rect(10, 10, 100, 100, Red);
+	// Draw a white filled rectangle in position (120, 10) with size 100x100
+	image.fill_rect(120, 10, 100, 100, White);
+
+	/** Triangle **/
+	image.draw_triangle(60, 120, 10, 220, 120, 220, Cyan);
+	image.fill_triangle(180, 120, 130, 220, 245, 220, Magenta);
+
+	/** Circle **/
+	// Draw a non-filled Gray circle in position (300, 170) with 50 pixels radius
+	image.draw_circle(300, 170, 50, Gray);
+	// Draw a filled Lime circle in position (300, 170) with 50 pixels radius
+	image.fill_circle(420, 170, 50, Lime);
+
+	// Save bitmap
+	image.save(std::string(BIN_DIR) + "/primitives.bmp");
+
+	return EXIT_SUCCESS;
 }

examples/fractals/julia.cpp

@@ -2,37 +2,37 @@
 #include "color_maps.inl"
 
 int main(void) {
-  bmp::Bitmap image(1280, 960);
+	bmp::Bitmap image(1280, 960);
 
-  constexpr const std::uint16_t max_iterations = 300;
+	constexpr const std::uint16_t max_iterations = 300;
 
-  constexpr const double cr = -0.70000;
-  constexpr const double ci = 0.27015;
+	constexpr const double cr = -0.70000;
+	constexpr const double ci = 0.27015;
 
-  double prevr, previ;
+	double prevr, previ;
 
-  for (std::int32_t y = 0; y < image.height(); ++y) {
-    for (std::int32_t x = 0; x < image.width(); ++x) {
-      double nextr = 1.5 * (2.0 * x / image.width() - 1.0);
-      double nexti = (2.0 * y / image.height() - 1.0);
+	for (std::int32_t y = 0; y < image.height(); ++y) {
+		for (std::int32_t x = 0; x < image.width(); ++x) {
+			double nextr = 1.5 * (2.0 * x / image.width() - 1.0);
+			double nexti = (2.0 * y / image.height() - 1.0);
 
-      for (std::uint16_t i = 0; i < max_iterations; ++i) {
-        prevr = nextr;
-        previ = nexti;
+			for (std::uint16_t i = 0; i < max_iterations; ++i) {
+				prevr = nextr;
+				previ = nexti;
 
-        nextr = prevr * prevr - previ * previ + cr;
-        nexti = 2 * prevr * previ + ci;
+				nextr = prevr * prevr - previ * previ + cr;
+				nexti = 2 * prevr * previ + ci;
 
-        if (((nextr * nextr) + (nexti * nexti)) > 4) {
-          const bmp::Pixel color = hsv_colormap[static_cast<std::size_t>((1000.0 * i) / max_iterations)];
-          image.set(x, y, color);
-          break;
-        }
-      }
-    }
-  }
+				if (((nextr * nextr) + (nexti * nexti)) > 4) {
+					const bmp::Pixel color = hsv_colormap[static_cast<std::size_t>((1000.0 * i) / max_iterations)];
+					image.set(x, y, color);
+					break;
+				}
+			}
+		}
+	}
 
-  image.save("julia.bmp");
+	image.save(std::string(BIN_DIR) + "/julia.bmp");
 
-  return EXIT_SUCCESS;
+	return EXIT_SUCCESS;
 }