cmake + hello world

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

@@ -0,0 +1,75 @@
+# This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
+name: CMake on multiple platforms
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
+      fail-fast: true
+
+      # Set up a matrix to run the following 3 configurations:
+      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
+      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
+      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
+      #
+      # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        build_type: [Release]
+        c_compiler: [gcc, clang, cl]
+        include:
+          - os: windows-latest
+            c_compiler: cl
+            cpp_compiler: cl
+          - os: ubuntu-latest
+            c_compilel: gcc
+            cpp_compiler: g++
+          - os: ubuntu-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+        exclude:
+          - os: windows-latest
+            c_compiler: gcc
+          - os: windows-latest
+            c_compiler: clang
+          - os: ubuntu-latest
+            c_compiler: cl
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set reusable strings
+      # Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
+      id: strings
+      shell: bash
+      run: |
+        echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
+
+    - 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 ${{ steps.strings.outputs.build-output-dir }}
+        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
+        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
+        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+        -S ${{ github.workspace }}
+
+    - name: Build
+      # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
+
+    - name: Test
+      working-directory: ${{ steps.strings.outputs.build-output-dir }}
+      # Execute tests defined by the CMake configuration. Note that --build-config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest --build-config ${{ matrix.build_type }}

.gitignore

@@ -0,0 +1,3 @@
+#CMAKE 
+build
+Testing

CMakeLists.txt

@@ -0,0 +1,71 @@
+cmake_minimum_required(VERSION 3.23)
+
+project(
+  DataStructures
+  #DESCRITPRION "C++ Data Stuctures"
+  LANGUAGES CXX
+)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+
+
+# include(CTest)
+# add_subdirectory(tests)
+
+# ------------------------------------------------------------------------------
+# Options
+# ------------------------------------------------------------------------------
+
+option(DSA_BUILD_TESTS "Build unit tests" ON)
+option(DSA_BUILD_EXAMPLES "Build examples" ON)
+
+# ------------------------------------------------------------------------------
+# Dependencies
+# ------------------------------------------------------------------------------
+
+if (DSA_BUILD_TESTS)
+    include(FetchContent)
+
+    FetchContent_Declare(
+        googletest
+        URL https://github.com/google/googletest/archive/refs/tags/v1.17.0.zip
+        DOWNLOAD_EXTRACT_TIMESTAMP TRUE # updates file stamps on extraction
+    )
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    FetchContent_MakeAvailable(googletest)
+
+    enable_testing()
+endif()
+
+# ------------------------------------------------------------------------------
+# Compiler warnings
+# ------------------------------------------------------------------------------
+
+add_library(project_warnings INTERFACE)
+
+if (MSVC)
+    target_compile_options(project_warnings INTERFACE
+        /W4
+        /permissive-
+    )
+else()
+    target_compile_options(project_warnings INTERFACE
+        -Wall
+        -Wextra
+        -Wpedantic
+        -Wconversion
+        -Wsign-conversion
+    )
+endif()
+
+# ------------------------------------------------------------------------------
+# Modules
+# ------------------------------------------------------------------------------
+
+add_subdirectory(hello_world)
+# add_subdirectory(linked_list)

README.md

@@ -1 +1,8 @@
 Data structures and algorithms in C++
+
+
+
+## How to build and run tests
+cmake -S . -B build
+cmake --build build
+ctest --test-dir build --output-on-failure

hello_world/CMakeLists.txt

@@ -0,0 +1,14 @@
+add_library(HelloWorld)
+
+target_sources(HelloWorld
+    PRIVATE
+        src/hw.cpp
+)
+
+target_include_directories(HelloWorld
+    PUBLIC
+        include
+)
+
+add_subdirectory(tests)
+add_subdirectory(examples)

hello_world/examples/CMakeLists.txt

@@ -0,0 +1,9 @@
+add_executable(basic_usage
+    basic_usage.cpp
+)
+
+target_link_libraries(basic_usage
+    PRIVATE
+    HelloWorld
+)
+

hello_world/examples/basic_usage.cpp

@@ -0,0 +1,4 @@
+#include "hw.hpp"
+#include <iostream>
+
+int main() { std::cout << HW::hello() << std::endl; }

hello_world/include/hw.hpp

@@ -0,0 +1,7 @@
+#pragma once
+
+#include <string>
+
+namespace HW {
+  std::string hello();
+}

hello_world/src/hw.cpp

@@ -0,0 +1,6 @@
+#include <iostream>
+#include <string>
+
+namespace HW{
+std::string hello() { return "Hello, world"; }
+} // namespace

hello_world/tests/CMakeLists.txt

@@ -0,0 +1,13 @@
+add_executable(hello_world_tests
+    hw_tests.cpp
+)
+
+target_link_libraries(hello_world_tests
+    PRIVATE
+        HelloWorld
+        #project_warnings
+        GTest::gtest_main
+)
+
+include(GoogleTest)
+gtest_discover_tests(hello_world_tests)

hello_world/tests/hw_tests.cpp

@@ -0,0 +1,9 @@
+#include "hw.hpp"
+#include <gtest/gtest.h>
+
+
+TEST(Hello_world, returns) {
+  auto hw = HW::hello();
+  EXPECT_EQ(hw, "Hello, world");
+}
+