Feature/doxygen generation

.github/workflows/analysis.yml

@@ -0,0 +1,87 @@
+name: Analysis Pipeline
+
+on:
+  push:
+    branches: [ "master", "development" ]
+  pull_request:
+    branches: [ "master", "development" ]
+
+env:
+  BUILD_TYPE: Debug # Note: This default BUILD_TYPE will be overridden in specific jobs as needed
+
+jobs:
+  asan-msan:
+    name: ASan/MSan
+    runs-on: ubuntu-latest
+    env: # Overriding BUILD_TYPE for this specific job
+      BUILD_TYPE: Debug
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Doxygen
+      run: sudo apt-get update && sudo apt-get install -y doxygen
+
+    - name: Generate Doxygen Documentation
+      run: doxygen Doxyfile
+
+    - name: Upload Doxygen Documentation
+      uses: actions/upload-artifact@v3
+      with:
+        name: doxygen-html-docs
+        path: docs/doxygen/html
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DENABLE_ASAN=ON -DENABLE_MSAN=ON
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      run: ctest -C ${{env.BUILD_TYPE}}
+
+  valgrind:
+    name: Valgrind
+    needs: asan-msan
+    runs-on: ubuntu-latest
+    env: # Overriding BUILD_TYPE for this specific job
+      BUILD_TYPE: Release
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Valgrind
+      run: sudo apt-get update && sudo apt-get install -y valgrind
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Test with Valgrind
+      working-directory: ${{github.workspace}}/build
+      run: ctest -T memcheck -C ${{env.BUILD_TYPE}}
+
+  codeql-analysis:
+    name: CodeQL Analysis
+    needs: asan-msan # Depends on the initial build and test phase
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write # Required to upload CodeQL analysis results
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: cpp # Specify 'cpp' for C++
+        # config-file: ./.github/codeql/codeql-config.yml # Optional: if you have a custom config
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+      # If autobuild fails, you might need to specify custom build steps here.
+      # For CMake projects, it usually works well.
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

.github/workflows/cmake-single-platform.yml

@@ -0,0 +1,39 @@
+# This starter workflow is for a CMake project running on a single platform. There is a different starter workflow if you need cross-platform coverage.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-multi-platform.yml
+name: CMake on a single platform
+
+on:
+  push:
+    branches: [ "master", "development" ]
+  pull_request:
+    branches: [ "master", "development" ]
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+    - name: Build
+      # Build your program with the given configuration
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest -C ${{env.BUILD_TYPE}}
+

.github/workflows/fuzzing.yml

@@ -0,0 +1,73 @@
+name: Fuzzing
+
+on:
+  push:
+    branches: [ main, development ]
+  pull_request:
+    branches: [ main, development ]
+
+jobs:
+  fuzz:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install Clang
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y clang llvm
+
+    - name: Configure CMake for Fuzzing
+      run: |
+        cmake -S . -B build_fuzz -DENABLE_FUZZING=ON -DCMAKE_BUILD_TYPE=Debug
+      env:
+        CC: clang
+        CXX: clang++
+
+    - name: Build all fuzz targets
+      run: cmake --build build_fuzz --config Debug # This will build all executables configured for the Debug build
+
+    - name: Create corpus directories
+      run: |
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_bitmap_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_bmp_tool_save_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_bitmap_file_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_image_operations_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_matrix_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_convert_bgr_to_bgra_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_swizzle_bgra_to_rgba_corpus
+        mkdir -p build_fuzz/corpus_fuzzing/fuzz_swizzle_rgba_to_bgra_corpus
+
+    - name: Run fuzz_bitmap
+      run: |
+        ./build_fuzz/tests/fuzz_bitmap -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_bitmap_corpus/
+
+    - name: Run fuzz_bmp_tool_save
+      run: |
+        ./build_fuzz/tests/fuzz_bmp_tool_save -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_bmp_tool_save_corpus/
+
+    - name: Run fuzz_bitmap_file
+      run: |
+        ./build_fuzz/tests/fuzz_bitmap_file -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_bitmap_file_corpus/
+
+    - name: Run fuzz_image_operations
+      run: |
+        ./build_fuzz/tests/fuzz_image_operations -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_image_operations_corpus/
+
+    - name: Run fuzz_matrix
+      run: |
+        ./build_fuzz/tests/fuzz_matrix -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_matrix_corpus/
+
+    - name: Run fuzz_convert_bgr_to_bgra
+      run: |
+        ./build_fuzz/tests/fuzz_convert_bgr_to_bgra -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_convert_bgr_to_bgra_corpus/
+
+    - name: Run fuzz_swizzle_bgra_to_rgba
+      run: |
+        ./build_fuzz/tests/fuzz_swizzle_bgra_to_rgba -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_swizzle_bgra_to_rgba_corpus/
+
+    - name: Run fuzz_swizzle_rgba_to_bgra
+      run: |
+        ./build_fuzz/tests/fuzz_swizzle_rgba_to_bgra -max_total_time=60 -print_final_stats=1 -print_pcs=1 -error_exitcode=1 build_fuzz/corpus_fuzzing/fuzz_swizzle_rgba_to_bgra_corpus/

.gitignore

@@ -0,0 +1 @@
+/build

CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.3.0] - 2025-05-28
+
+### Added
+- **New Bitmap API Layer (`BmpTool`)**:
+    - Introduced a new public API header `include/bitmap.hpp`.
+    - Added `BmpTool::load(std::span<const uint8_t>)` function to load BMP data from a memory span into a `BmpTool::Bitmap` (RGBA format). This function bridges to the existing library's `::CreateMatrixFromBitmap` after parsing the input span.
+    - Added `BmpTool::save(const BmpTool::Bitmap&, std::span<uint8_t>)` function to save a `BmpTool::Bitmap` (RGBA) to a memory span. This function bridges to the existing library's `::CreateBitmapFromMatrix` and then serializes the resulting `::Bitmap::File` to the span.
+    - Defined `BmpTool::Bitmap` struct for RGBA pixel data and `BmpTool::Result` for error handling.
+    - Implemented the bridging logic in `src/format/bitmap.cpp`.
+    - Added Doxygen comments for the new public API.
+- **API Roundtrip Test**:
+    - Added `tests/api_roundtrip.cpp` to verify that loading, saving, and re-loading a bitmap using the new API results in identical data.
+- **Build System Updates**:
+    - Updated CMakeLists.txt files (root and tests) to include the new API implementation and test.
+    - Set C++ standard to C++20 globally in the root CMakeLists.txt.
+
+### Changed
+- The `bitmap` library now exposes the `BmpTool` API via `include/bitmap.hpp` for simplified bitmap operations.
+- **Documentation**:
+    - Reviewed and significantly updated `README.md` for accuracy regarding features, API examples (old vs. new), build instructions, and added "Code Documentation" and "Contributing" sections.
+    - Reviewed and extensively updated `src/matrix/Documentation/Matrix.MD` to align with the current `src/matrix/matrix.h` implementation, including documenting move semantics, new functions, and correcting outdated information.
+
+## [0.2.0] - 2024-07-27
+
+### Changed
+- Reorganized project structure: moved `bitmap.h` and `bitmap.cpp` to `src/bitmap/`. Updated include paths and CMakeLists.txt accordingly.
+- Integrated `matrix` and `bitmapfile` modules directly into `src/` instead of a separate `dependencies` folder.
+
+### Added
+- Comprehensive unit tests for the `Bitmap::File` module (`tests/test_bitmap_file.cpp`), covering constructors, file operations (open, save, saveas), and validation logic.
+- Comprehensive unit tests for the `Matrix` module (`tests/test_matrix.cpp`), covering constructors, arithmetic operations, manipulations (transpose, inverse, determinant), and merge/split functionality.
+
+### Fixed
+- Corrected include paths in various files to reflect the new project structure.
+- Updated CMakeLists.txt files to correctly locate and build all source files and tests under the new structure.
+
+## [0.1.0] - 2025-05-23
+
+### Added
+- New image manipulation functions:
+    - `InvertImageColors` / `InvertPixelColor`
+    - `ApplySepiaTone` / `ApplySepiaToPixel`
+    - `ApplyBoxBlur`
+- Comprehensive unit testing framework (`tests/test_bitmap.cpp`) using basic assertions.
+- Unit tests for most pixel-level functions (Greyscale, Invert, Sepia, Brightness, Contrast, Saturation, Luminance - including color-specific variants).
+- Unit tests for image-level functions (`ApplyBoxBlur`, `ShrinkImage`, `RotateImageCounterClockwise`, and basic checks for others).
+- This `README.md` and `CHANGELOG.md` file.
+
+### Changed
+- Refined contrast adjustment logic for secondary colors (`ChangePixelContrastMagenta`, `ChangePixelContrastYellow`, `ChangePixelContrastCyan`) to apply contrast to constituent primary channels directly.
+- Improved inline code documentation (comments) in `src/bitmap.h` and `src/bitmap.cpp` for clarity and maintainability.
+- Standardized clamping of pixel component values (0-255) in various functions.
+- Corrected `std::min` usage in saturation and luminance functions.
+
+### Fixed
+- Corrected syntax errors in the original implementations of `ChangePixelContrastMagenta` and `ChangePixelContrastCyan`.
+- Corrected variable name usage (`magenta` vs `cyan`) in `ChangePixelContrastCyan`.
+- Improved GDI resource management in `ScreenShotWindow` by ensuring `DeleteDC`, `ReleaseDC`, and `DeleteObject` are called.
+- Corrected a typo in `ChangePixelSaturationBlue` condition.
+- Corrected a typo in the `ChangePixelBrightness` parameter name in `src/bitmap.h`.

CMakeLists.txt

@@ -1,33 +1,60 @@
-cmake_minimum_required(VERSION 3.0.0)
+cmake_minimum_required(VERSION 3.10)
 project(bitmap VERSION 1.0.0)
 
+option(ENABLE_FUZZING "Enable fuzzing builds" OFF)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+if(ENABLE_FUZZING)
+  if(NOT CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    find_program(CLANG_COMPILER NAMES clang++ clang)
+    if(CLANG_COMPILER)
+      set(CMAKE_CXX_COMPILER ${CLANG_COMPILER})
+    else()
+      message(WARNING "Clang compiler not found. Disabling fuzzing.")
+      set(ENABLE_FUZZING OFF)
+    endif()
+  endif()
+
+  if(ENABLE_FUZZING AND CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    message(STATUS "Fuzzing enabled. Using Clang compiler.")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -fsanitize=address,undefined,fuzzer-no-link")
+    # For linking fuzz targets, we'll use -fsanitize=fuzzer later
+  else()
+    message(STATUS "Fuzzing disabled or Clang not used.")
+  endif()
+endif()
+
 include(CTest)
 enable_testing()
-include(FetchContent)
-
-FetchContent_Declare(
-    matrix
-    GIT_REPOSITORY https://github.com/JacobBorden/Matrix.git
-    SOURCE_DIR ../dependencies/matrix
-)
 
-FetchContent_Declare(
-    bitmapfile
-    GIT_REPOSITORY https://github.com/JacobBorden/BitmapFile.git
-    SOURCE_DIR ../dependencies/bitmapfile
+# Add your main library with all sources
+add_library(bitmap STATIC 
+    src/bitmap/bitmap.cpp
+    src/bitmapfile/bitmap_file.cpp
+    src/format/bitmap.cpp
 )
 
-FetchContent_MakeAvailable(bitmapfile)
-FetchContent_MakeAvailable(matrix)
-
-link_libraries(matrix)
-link_libraries(bitmapfile)
-add_library(bitmap STATIC src/bitmap.cpp )
-link_libraries(bitmap)
+# Executable for main.cpp (if it's a demo or separate utility)
 add_executable(testexe main.cpp)
+target_link_libraries(testexe PRIVATE bitmap)
 
+target_include_directories(bitmap PUBLIC 
+    ${CMAKE_CURRENT_SOURCE_DIR}/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/src
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/bitmapfile
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/matrix
+)
 
+# GoogleTest
+include(FetchContent)
+FetchContent_Declare(
+  googletest
+  URL https://github.com/google/googletest/archive/refs/tags/v1.14.0.zip
+)
+FetchContent_MakeAvailable(googletest)
 
-set(CPACK_PROJECT_NAME ${PROJECT_NAME})
-set( CPACK_PROJECT_VERSION ${PROJECT_VERSION}) 
-include (Cpack)
+# Add subdirectory for tests (enables gtest_discover_tests and test auto-discovery)
+add_subdirectory(tests)