Fix dependencies for each component.

Add ability to clear LCD screen, and write at a label position.

.gitignore

@@ -10,5 +10,5 @@
 **/Makefile
 **/*.cbp
 **/node-modules/
-**/CmakeLists.txt.user
+**/CMakeLists.txt.user
 **/catch2/bin/

README.md

@@ -2,15 +2,16 @@
 
 This repository is a collection of useful code snippets and configurations.
 
-```
+```bash
-github.com/shaunrd0/klips/
+shaunrd0/klips/
 ├── ansible     # Ansible roles, playbooks, and examples
 ├── blockchain  # Blockchain related project templates and examples
 ├── cpp         # C++ programs, datastructures, and other examples
 ├── dotnet      # .NET projects and examples
+├── esp         # ESP32 projects and examples
 ├── figlet      # Figlet fonts I like :)
 ├── javascript  # Javascript projects and examples
-├── python      # Python scripts or tools I've made   
+├── python      # Python scripts and tools I've made
-├── README.md   
+├── scripts     # Bash scripts
-└── scripts     # Bash scripts
+└── README.md
 ```

ansible/README.md

@@ -1,4 +1,4 @@
-# Ansible 
+# ansible
 
 A few simple roles / plays I've put together in learning how to use Ansible can be found under their corresponding directories.
 

blockchain/eth/truffle-solidity/README.md

@@ -1,3 +1,4 @@
+# blockchain
 
 A template project for getting started working on the Ethereum blockchain.
 This project comes with basic packages for compiling and deploying Solidity contracts with Truffle.
@@ -72,7 +73,7 @@ I explain how to configure metamask on ropsten on [Knoats - Solidity](https://kn
 
 Give yourself test Ethereum with the [Ropsten ETH Faucet](https://faucet.ropsten.be)
 
-To deploy to ropsten test network, and verify using `truffle-verify-plugin` - 
+To deploy to ropsten test network, and verify using `truffle-verify-plugin` -
 
 ```asm
 npx truffle migrate --network ropsten

cpp/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ## About: A root project for practicing C++                                   ##
 ##        This project can be built to debug and run all nested projects      ##
 ##        Or, any subdirectory with a project() statement can be selected     ##
@@ -16,10 +16,32 @@ project(
     DESCRIPTION "A root project for several small cpp practice projects"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 add_compile_options("-Wall")
 
+option(KLIPS_CCACHE "Enable ccache" ON)
+
+if (KLIPS_CCACHE)
+  find_program(SCCACHE_PATH sccache)
+  if(SCCACHE_PATH)
+    message(STATUS "[Klips] Found sccache: ${SCCACHE_PATH}")
+    set(CMAKE_CXX_COMPILER_LAUNCHER ${SCCACHE_PATH})
+    set(CMAKE_C_COMPILER_LAUNCHER ${SCCACHE_PATH})
+  else()
+    message(STATUS "[Klips] Failed to find sccache, falling back to ccache.")
+    find_program(CCACHE_PATH ccache)
+    if(CCACHE_PATH)
+      message(STATUS "[Klips] Found ccache: ${CCACHE_PATH}")
+      set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE_PATH})
+      set(CMAKE_C_COMPILER_LAUNCHER ${CCACHE_PATH})
+    else()
+      message(WARNING "[Klips] Failed to find sccache and ccache. Compilation will not be cached.")
+    endif()
+  endif()
+endif()
+
 add_subdirectory(algorithms)
 add_subdirectory(catch2)
 add_subdirectory(cmake-example)
@@ -28,4 +50,15 @@ add_subdirectory(datastructs)
 add_subdirectory(graphics)
 add_subdirectory(multithreading)
 add_subdirectory(patterns)
-add_subdirectory(qt)
+
+find_package(Qt6 COMPONENTS UiPlugin Core Gui Widgets)
+if (NOT Qt6_FOUND)
+  message(
+      WARNING
+      "[Klips] Qt examples will not be built.\n"
+      "On Ubuntu 24.04 Qt6 can be installed using apt:\n"
+      "  sudo apt install qt6-base-dev qt6-tools-dev\n"
+  )
+else()
+  add_subdirectory(qt)
+endif()

cpp/README.md

@@ -1,4 +1,4 @@
-# Cpp
+# cpp
 
 ```bash
 shaunrd0/klips/cpp/
@@ -13,11 +13,11 @@ shaunrd0/klips/cpp/
 └── README.md
 ```
 
-This directory contains a `CMakeLists.txt`, which can be selected to open as a 
+This directory contains a `CMakeLists.txt`, which can be selected to open as a
 project within your preferred IDE. From there, all nested examples can be built,
 debugged, and ran.
 
-Some of the more recent projects in this repository requires the latest CMake LTS. 
+Some of the more recent projects in this repository requires the latest CMake LTS.
 To install `cmake` LTS with `apt` we can follow [official instructions from kitware](https://apt.kitware.com/)
 Alternatively, we can install the LTS with python's `pip`.
 ```bash
@@ -34,7 +34,7 @@ cmake version 3.22.1
 
 Once cmake is installed, dependencies for all examples can be installed with the command below.
 ```bash
-sudo apt install libsdl2-dev freeglut3-dev 
+sudo apt install libsdl2-dev freeglut3-dev
 ```
 
 If we build from this directory, we build all C++ projects and examples
@@ -63,7 +63,7 @@ graph-test-object            sdl-test              visitor-test
 graph-test-simple            select-sort
 ```
 
-We can also build from subdirectories. 
+We can also build from subdirectories.
 To only build projects related to design patterns we build from the `patterns/` subdirectory, for example
 ```bash
 cd /path/to/klips/cpp/patterns
@@ -80,5 +80,5 @@ adapter-test           factory-test  prototype-test  state-test
 
 If cmake is not being used in a project, it can be built with `g++` manually using
 the commands outlined in `*/.vscode/tasks.json`, or by using VSCode to open the example
-and running the build task. 
+and running the build task.
 Check the header comments in the main source file for the example for instructions.

cpp/algorithms/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing various algorithms in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/graphs/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing algorithms using graphs in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/graphs/object/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "Practice implementing and using object graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-graphs-object graph.cpp

cpp/algorithms/graphs/simple/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "Practice implementing and using simple graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-graphs-simple graph.cpp

cpp/algorithms/graphs/simple/lib-graph.cpp

@@ -8,9 +8,8 @@
 ################################################################################
 */
 
-#include <algorithm>
 #include "lib-graph.hpp"
-
+#include <algorithm>
 
 void Graph::BFS(int startNode)
 {

cpp/algorithms/graphs/simple/lib-graph.hpp

@@ -15,6 +15,7 @@
 #include <unordered_map>
 #include <unordered_set>
 #include <vector>
+#include <cstdint>
 
 
 class Graph {

cpp/algorithms/graphs/templated/CMakeLists.txt

@@ -14,5 +14,6 @@ project(
     DESCRIPTION "Practice implementing and using templated graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(algo-graphs-templated graph.cpp)

cpp/algorithms/graphs/templated/lib-graph.hpp

@@ -18,6 +18,7 @@
 #include <unordered_set>
 #include <utility>
 #include <vector>
+#include <cstdint>
 
 
 /******************************************************************************/

cpp/algorithms/graphs/weighted/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "Practice implementing and using weighted graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-graphs-weighted graph.cpp

cpp/algorithms/graphs/weighted/lib-graph.hpp

@@ -18,6 +18,7 @@
 #include <unordered_set>
 #include <utility>
 #include <vector>
+#include <cstdint>
 
 
 /******************************************************************************/

cpp/algorithms/sorting/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing various sorting algorithms in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/sorting/insertion/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing insertion sort in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-sort-insertion insertion-sort.cpp

cpp/algorithms/sorting/merge/CMakeLists.txt

@@ -14,6 +14,8 @@ project (
     DESCRIPTION "A project for practicing merge sort in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
 add_executable(
     algo-sort-merge merge-sort.cpp
     lib-merge.cpp lib-merge.h

cpp/algorithms/sorting/merge/lib-merge.cpp

@@ -12,6 +12,7 @@
 #include <algorithm>
 #include <iostream>
 #include <vector>
+#include <cstdint>
 
 void MergeSort(std::vector<int> &array, size_t lhs, size_t rhs)
 {

cpp/algorithms/sorting/quick/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing quick sort in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-sort-quick quick-sort.cpp

cpp/algorithms/sorting/radix/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing radix sort in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-sort-radix radix-sort.cpp

cpp/algorithms/sorting/selection/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing selection sort in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-sort-select select-sort.cpp

cpp/algorithms/trees/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing algorithms using trees in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/trees/binary/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing BST algorithms"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-trees-bst driver.cpp

cpp/algorithms/trees/redblack/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing red-black tree algorithms"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     algo-trees-redblack driver.cpp

cpp/algorithms/trees/redblack/redblack.h

@@ -12,6 +12,7 @@
 #define REDBLACK_H
 
 #include <iostream>
+#include <cstdint>
 
 enum Color {Black, Red};
 

cpp/catch2/CMakeLists.txt

@@ -14,18 +14,22 @@ project(
     DESCRIPTION     "Practice project for learning Catch2"
     LANGUAGES       CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_compile_options(-Wall)
 
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 Include(FetchContent)
 FetchContent_Declare(
     Catch2
     GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-    GIT_TAG        v3.0.1
+    GIT_TAG        v3.4.0
 )
 FetchContent_MakeAvailable(Catch2)
 
-add_subdirectory(src)
+add_library(klips SHARED src/klips.cpp)
-add_subdirectory(test)
+target_include_directories(klips PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+add_executable(test_klips src/test_klips.cpp)
+target_link_libraries(test_klips PUBLIC Catch2::Catch2WithMain klips)

cpp/catch2/src/CMakeLists.txt

@@ -1,22 +0,0 @@
-################################################################################
-## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
-## About: Practice project for testing with catch2 framework                  ##
-##                                                                            ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
-################################################################################
-
-cmake_minimum_required(VERSION 3.15)
-
-project(
-    #[[NAME]]       Catch2
-    VERSION         1.0
-    DESCRIPTION     "Practice project for learning Catch2"
-    LANGUAGES       CXX
-)
-
-add_compile_options(-Wall)
-add_definitions("-std=c++17")
-
-add_library(klips SHARED klips.cpp)
-target_include_directories(klips PRIVATE ${CMAKE_SOURCE_DIR}/include)

cpp/catch2/src/test_klips.cpp

@@ -2,7 +2,8 @@
 
 #include <iostream>
 
-#include "../bin/catch.hpp"
+#include "catch2/catch_all.hpp"
+
 #include "klips.hpp"
 #include "type_name.hpp"
 
@@ -139,7 +140,7 @@ template <> template <bool must_find> void test_config_get<std::string>::run() {
 TEMPLATE_PRODUCT_TEST_CASE("Test", "[test]", test_config_get,
                            (int, std::string)) {
   TT();
-  TestType t;
+  // TestType t;
   test_config_get<int> s;
   s.template run<true>();
   //  TestType t;

cpp/catch2/test/CMakeLists.txt

@@ -1,22 +0,0 @@
-################################################################################
-## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
-## About: Practice project for testing with catch2 framework                  ##
-##                                                                            ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
-################################################################################
-
-cmake_minimum_required(VERSION 3.15)
-
-project(
-    #[[NAME]]       Catch2
-    VERSION         1.0
-    DESCRIPTION     "Practice project for learning Catch2"
-    LANGUAGES       CXX
-)
-
-add_compile_options(-Wall)
-
-add_executable(test_klips test_klips.cpp)
-target_link_libraries(test_klips PRIVATE Catch2::Catch2WithMain klips)
-target_include_directories(test_klips PRIVATE ${CMAKE_SOURCE_DIR}/include)

cpp/cmake-example/CMakeLists.txt

@@ -22,6 +22,7 @@ project (
     DESCRIPTION "A basic CMake template for C++ projects"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 # Include any directories the compiler may need
 include_directories(./include)

cpp/cryptography/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing cryptography in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/cryptography/columnar-transposition/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "Practice implementing columnar transposition in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     crypto-columnar-transposition driver.cpp

cpp/datastructs/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing various data structures in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/datastructs/binarysearchtree/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing a basic implementation of a BST"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-bst driver.cpp

cpp/datastructs/binarysearchtree/bst.cpp

@@ -10,10 +10,11 @@
 
 #include "bst.h"
 
+#include <cstdint>
 
 /********************************************************************************
-* Constructors, Destructors, Operators
+ * Constructors, Destructors, Operators
-*********************************************************************************/
+ *********************************************************************************/
 
 /** Copy Assignment Operator
  * @brief Empty the calling object's root BinaryNode, and copy the rhs data

cpp/datastructs/circledoublelist/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "Project for testing circular doubly linked list implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-circular-doubly-linked-list driver.cpp

cpp/datastructs/circledoublelist/circledoublelist.cpp

@@ -10,6 +10,7 @@
 
 #include "circledoublelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/circlesinglelist/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "Project for testing circular singly linked list implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-circular-singly-linked-list driver.cpp

cpp/datastructs/circlesinglelist/circlesinglelist.cpp

@@ -10,6 +10,7 @@
 
 #include "circlesinglelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/doublelist/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing a doubly linked list implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-doubly-linked-list driver.cpp

cpp/datastructs/doublelist/doublelist.cpp

@@ -10,6 +10,7 @@
 
 #include "doublelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/maxheap/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing a max heap implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-max-heap driver.cpp

cpp/datastructs/maxheap/maxheap.cpp

@@ -10,10 +10,11 @@
 
 #include "maxheap.h"
 
+#include <cstdint>
 
 /********************************************************************************
-* Constructors, Destructors, Operators
+ * Constructors, Destructors, Operators
-*********************************************************************************/
+ *********************************************************************************/
 
 /** default constructor
  *  Constructs a heap with the given default values

cpp/datastructs/queuelist/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "Project for testing queue implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-queue driver.cpp

cpp/datastructs/queuelist/queuelist.cpp

@@ -10,6 +10,7 @@
 
 #include "queuelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/singlelist/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing a singly linked list implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-singly-linked-list driver.cpp

cpp/datastructs/singlelist/singlelist.cpp

@@ -10,6 +10,7 @@
 
 #include "singlelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/stacklist/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing a Stack implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-stack driver.cpp

cpp/datastructs/stacklist/stacklist.cpp

@@ -10,6 +10,7 @@
 
 #include "stacklist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/templates/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing templated data structures in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_subdirectory(doublelist)
 add_subdirectory(queuelist)

cpp/datastructs/templates/doublelist/CMakeLists.txt

@@ -14,5 +14,6 @@ project (
     DESCRIPTION "A project for practicing templated doubly linked list implementations"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(data-templates-doubly-linked-list driver.cpp)

cpp/datastructs/templates/queuelist/CMakeLists.txt

@@ -14,5 +14,6 @@ project (
     DESCRIPTION "A project for practicing templated queue implementations"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(data-templates-queue driver.cpp)

cpp/datastructs/templates/stacklist/CMakeLists.txt

@@ -14,5 +14,6 @@ project (
     DESCRIPTION "A project for practicing templated Stack implementations"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(data-templates-stack driver.cpp)

cpp/datastructs/templates/vector/CMakeLists.txt

@@ -14,5 +14,6 @@ project (
     DESCRIPTION "A project for practicing templated Vector implementations"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(data-templates-vectors driver.cpp)

cpp/datastructs/vector/CMakeLists.txt

@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for testing a basic Vector implementation"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     data-vectors driver.cpp

cpp/datastructs/vector/vector.cpp

@@ -10,6 +10,7 @@
 
 #include "vector.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/graphics/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ## About: A root project for practicing C++                                   ##
 ##        This project can be built to debug and run all nested projects      ##
 ##        Or, any subdirectory with a project() statement can be selected     ##
@@ -16,6 +16,7 @@ project(
     DESCRIPTION "A root project for practicing graphics programming in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/graphics/opengl-cmake/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
@@ -8,40 +8,46 @@
 # Define CMake version
 cmake_minimum_required(VERSION 3.15)
 
+include(FetchContent)
 project(
     #[[NAME]]    OpenGL-Cmake
     DESCRIPTION  "Example project for building OpenGL projects with CMake"
     LANGUAGES    CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_library(graphics-lib-opengl src/lib-opengl-test.cpp)
 target_include_directories(graphics-lib-opengl PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src)
 
 # Find OpenGL package
-find_package(OpenGL REQUIRED)
+find_package(OpenGL)
-if (OPENGL_FOUND)
+if (NOT OPENGL_FOUND)
-  # Link opengl-test executable to OpenGL
-  target_include_directories(graphics-lib-opengl PUBLIC ${OPENGL_INCLUDE_DIR})
-  target_link_libraries(graphics-lib-opengl PUBLIC ${OPENGL_LIBRARIES})
-else()
   message(
-      "Error: CMake was unable to find the OpenGL package\n"
+      "[Klips] Error: CMake was unable to find OpenGL.\n"
-      "Please install OpenGL and try again\n"
+      "On Ubuntu 24.04 OpenGL can be installed using apt:\n"
+      "  sudo apt install libopengl-dev libgl1-mesa-dev mesa-common-dev libglu1-mesa-dev\n"
   )
 endif()
+# Link opengl-test executable to OpenGL
+message(STATUS "[Klips] Found OpenGL: ${OPENGL_INCLUDE_DIR}")
+target_include_directories(graphics-lib-opengl PUBLIC ${OPENGL_INCLUDE_DIR})
+target_link_libraries(graphics-lib-opengl PUBLIC ${OPENGL_LIBRARIES})
 
-# Find GLUT package
+find_package(GLUT QUIET)
-find_package(GLUT REQUIRED)
+if(NOT GLUT_FOUND)
-if (GLUT_FOUND)
-  # Link lib-opengl-test executable to GLUT
-  target_include_directories(graphics-lib-opengl PUBLIC ${GLUT_INCLUDE_DIR})
-  target_link_libraries(graphics-lib-opengl PUBLIC ${GLUT_LIBRARIES})
-else()
   message(
-      "Error: CMake was unable to find the GLUT package\n"
+      FATAL_ERROR
-      "Please install GLUT (freeglut3-dev) and try again\n"
+      "[Klips] Failed to fetch GLUT. Could not find dependency X11 input libraries.\n"
+      "On Ubuntu 24.04 Xi can be installed using apt:\n"
+      "  sudo apt install libxi-dev\n"
+      "Alternatively, on Ubuntu 24.04 GLUT can be installed with apt:\n"
+      "  sudo apt install freeglut3-dev\n"
   )
 endif()
+message(STATUS "[Klips] Found GLUT: ${GLUT_INCLUDE_DIR}")
+# Link lib-opengl-test executable to GLUT
+target_include_directories(graphics-lib-opengl PUBLIC ${GLUT_INCLUDE_DIR})
+target_link_libraries(graphics-lib-opengl PUBLIC ${GLUT_LIBRARIES})
 
 # Add test executable
 add_executable(graphics-cmake-opengl apps/test-gl.cpp)

cpp/graphics/sdl-cmake/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
@@ -13,6 +13,7 @@ project(
     DESCRIPTION  "Example project for building SDL projects with CMake"
     LANGUAGES    CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 # Add Library
 add_library(
@@ -27,31 +28,30 @@ target_include_directories(            # When calling library, include a directo
 )
 
 # Search for SDL2 package
-find_package(SDL2 REQUIRED sdl2)
+find_package(SDL2 QUIET)
-
+if (NOT SDL2_FOUND)
-# If SDL2 was found successfully, link to lib-sdl-test
+  message(FATAL_ERROR
-if (SDL2_FOUND)
+      "[Klips] Failed to find SDL2.\n"
-  # Any target that links with this library will also link to SDL2
+      "On Ubuntu 24.04 SDL2 can be installed using apt:\n"
-  # + Because we choose PUBLIC visibility
+      "  sudo apt install libsdl2-dev\n"
-  target_include_directories(graphics-lib-sdl PUBLIC ${SDL2_INCLUDE_DIRS})
-  target_link_libraries(graphics-lib-sdl PUBLIC "${SDL2_LIBRARIES}")
-
-  # Creating executable
-  add_executable(
-      graphics-cmake-sdl  # Exe name
-      apps/sdl-test.cpp   # Exe Source(s)
-  )
-
-  # Linking the exe to library
-  target_link_libraries(
-      graphics-cmake-sdl    # Executable to link
-      PRIVATE               # Visibility
-      graphics-lib-sdl      # Library to link
-  )
-
-else()
-  message(
-      "Error: CMake was unable to find SDL2 package.\n"
-      "Please install the libsdl2-dev package and try again.\n"
   )
 endif()
+message(STATUS "[Klips] Found SDL2: ${SDL2_INCLUDE_DIRS}")
+
+# Any target that links with this library will also link to SDL2
+# + Because we choose PUBLIC visibility
+target_include_directories(graphics-lib-sdl PUBLIC ${SDL2_INCLUDE_DIRS})
+target_link_libraries(graphics-lib-sdl PUBLIC "${SDL2_LIBRARIES}")
+
+# Creating executable
+add_executable(
+    graphics-cmake-sdl  # Exe name
+    apps/sdl-test.cpp   # Exe Source(s)
+)
+
+# Linking the exe to library
+target_link_libraries(
+    graphics-cmake-sdl    # Executable to link
+    PRIVATE               # Visibility
+    graphics-lib-sdl      # Library to link
+)

cpp/multithreading/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "Practice with multithreaded programming in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 add_compile_options("-Wall")

cpp/multithreading/conditions/CMakeLists.txt

@@ -18,6 +18,7 @@ project(
     DESCRIPTION "Example of condition_variables in multithreaded C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     multithread-conditions driver.cpp

cpp/multithreading/deadlock/CMakeLists.txt

@@ -18,6 +18,7 @@ project(
     DESCRIPTION "Example and solution for deadlocks in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     multithread-deadlock driver.cpp

cpp/multithreading/livelock/CMakeLists.txt

@@ -18,6 +18,7 @@ project(
     DESCRIPTION "Example and solution for livelocks in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     multithread-livelock driver.cpp

cpp/multithreading/race-condition/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "Example and solution for race conditions"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     multithread-race-condition driver.cpp

cpp/patterns/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "A project for practicing various design patterns in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/patterns/abstract-factory/CMakeLists.txt

@@ -13,6 +13,7 @@ project(
     DESCRIPTION "An example of the abstract factory design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/adapter/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the adapter design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/adapter/adapter.hpp

@@ -2,6 +2,7 @@
 #ifndef ADAPTER_HPP
 #define ADAPTER_HPP
 
+#include <ctime>
 #include <random>
 
 // Target implementation to adapt to a new interface

cpp/patterns/bridge/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the bridge design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/factory/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the factory design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/observer/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the state design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/prototype/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the prototype design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/singleton/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the singleton design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_executable(
     patterns-singleton main.cpp

cpp/patterns/state/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the state design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/patterns/visitor/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "An example of the visitor design pattern in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 add_compile_options("-Wall")
 
 add_executable(

cpp/qt/CMakeLists.txt

@@ -14,6 +14,7 @@ project(
     DESCRIPTION "A root project for several small Qt6 practice projects"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 add_compile_options("-Wall")

cpp/qt/designer-plugin-collection/CMakeLists.txt

@@ -14,6 +14,9 @@ project(
     DESCRIPTION     "Example of a widget plugin collection for Qt Designer"
     LANGUAGES       CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+# Lowercase string to use as a slug for executable names for identification.
+string(TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER)
 
 include(GenerateExportHeader)
 
@@ -51,43 +54,56 @@ endif()
 set(QT_INSTALL_DIR "${QT_DIR}/6.3.1/gcc_64/" CACHE PATH "Path to Qt6 install")
 list(APPEND CMAKE_PREFIX_PATH "${QT_INSTALL_DIR}")
 
-find_package(Qt6 REQUIRED COMPONENTS UiPlugin Core Gui Widgets)
+find_package(Qt6 COMPONENTS UiPlugin Core Gui Widgets)
+if (NOT Qt6_FOUND)
+    message(
+        FATAL_ERROR
+        "[Klips] Error: CMake was unable to find Qt6 libraries.\n"
+        "The example will not be built until the build is configured with these packages installed.\n"
+        "On Ubuntu 24.04 Qt6 can be installed using apt:\n"
+        "  sudo apt-get install qt6-base-dev qt6-tools-dev\n"
+    )
+endif()
 
 # Creating a library with two plugins for the collection.
-qt_add_library(widget-plugin-library
+set(WIDGET_PLUGIN_LIBRARY widget-plugin-library_${PROJECT_NAME_LOWER})
+qt_add_library(${WIDGET_PLUGIN_LIBRARY}
     textview.cpp textview.h
     widgetplugin.cpp widgetplugin.h
 )
-target_sources(widget-plugin-library PRIVATE
+target_sources(${WIDGET_PLUGIN_LIBRARY} PRIVATE
     textview.cpp textview.h
     treeview.cpp treeview.h
     widgetplugin.cpp widgetplugin.h
 )
-set_target_properties(widget-plugin-library PROPERTIES
+set_target_properties(${WIDGET_PLUGIN_LIBRARY} PROPERTIES
     WIN32_EXECUTABLE TRUE
     MACOSX_BUNDLE TRUE
 )
-target_link_libraries(widget-plugin-library
+target_link_libraries(${WIDGET_PLUGIN_LIBRARY}
     PUBLIC Qt::UiPlugin Qt::Core Qt::Gui Qt::Widgets
 )
 
-install(TARGETS widget-plugin-library
+install(TARGETS ${WIDGET_PLUGIN_LIBRARY}
     RUNTIME DESTINATION "${QT_PLUGIN_LIBRARY_DIR}"
     BUNDLE DESTINATION "${QT_PLUGIN_LIBRARY_DIR}"
     LIBRARY DESTINATION "${QT_PLUGIN_LIBRARY_DIR}"
 )
 
-generate_export_header(widget-plugin-library)
+generate_export_header(${WIDGET_PLUGIN_LIBRARY}
+    BASE_NAME widget_plugin_library
+    EXPORT_FILE_NAME "${CMAKE_CURRENT_BINARY_DIR}/widget-plugin-library_export.h"
+)
 
 # Creating the collection
-
+set(WIDGET_PLUGIN_COLLECTION widget-plugin-collection_${PROJECT_NAME_LOWER})
-qt_add_library(widget-plugin-collection
+qt_add_library(${WIDGET_PLUGIN_COLLECTION}
     widgetplugincollection.cpp widgetplugincollection.h
 )
-target_link_libraries(widget-plugin-collection
+target_link_libraries(${WIDGET_PLUGIN_COLLECTION}
-    Qt6::Widgets Qt6::UiPlugin widget-plugin-library
+    Qt6::Widgets Qt6::UiPlugin ${WIDGET_PLUGIN_LIBRARY}
 )
-install(TARGETS widget-plugin-collection
+install(TARGETS ${WIDGET_PLUGIN_COLLECTION}
     RUNTIME DESTINATION "${QT_PLUGIN_INSTALL_DIR}"
     BUNDLE DESTINATION "${QT_PLUGIN_INSTALL_DIR}"
     LIBRARY DESTINATION "${QT_PLUGIN_INSTALL_DIR}"
@@ -101,10 +117,11 @@ configure_file("${CMAKE_CURRENT_SOURCE_DIR}/app-dir.h.in"
     @ONLY
 )
 
-qt_add_executable(widget-app
+set(WIDGET_APP widget-app_${PROJECT_NAME_LOWER})
+qt_add_executable(${WIDGET_APP}
     widgetapp.cpp widgetapp.h widgetapp.ui
     main.cpp
 )
-target_link_libraries(widget-app
+target_link_libraries(${WIDGET_APP}
-    PRIVATE Qt::Widgets widget-plugin-library
+    PRIVATE Qt::Widgets ${WIDGET_PLUGIN_LIBRARY}
 )

cpp/qt/designer-plugin-collection/CMakeLists.txt.user

@@ -1,197 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 9.0.1, 2022-12-24T09:28:53. -->
-<qtcreator>
- <data>
-  <variable>EnvironmentId</variable>
-  <value type="QByteArray">{ce8a8d3d-318d-4c62-a573-71d1755252ce}</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.ActiveTarget</variable>
-  <value type="qlonglong">0</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.EditorSettings</variable>
-  <valuemap type="QVariantMap">
-   <value type="bool" key="EditorConfiguration.AutoIndent">true</value>
-   <value type="bool" key="EditorConfiguration.AutoSpacesForTabs">false</value>
-   <value type="bool" key="EditorConfiguration.CamelCaseNavigation">true</value>
-   <valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.0">
-    <value type="QString" key="language">Cpp</value>
-    <valuemap type="QVariantMap" key="value">
-     <value type="QByteArray" key="CurrentPreferences">CppGlobal</value>
-    </valuemap>
-   </valuemap>
-   <valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.1">
-    <value type="QString" key="language">QmlJS</value>
-    <valuemap type="QVariantMap" key="value">
-     <value type="QByteArray" key="CurrentPreferences">QmlJSGlobal</value>
-    </valuemap>
-   </valuemap>
-   <value type="qlonglong" key="EditorConfiguration.CodeStyle.Count">2</value>
-   <value type="QByteArray" key="EditorConfiguration.Codec">UTF-8</value>
-   <value type="bool" key="EditorConfiguration.ConstrainTooltips">false</value>
-   <value type="int" key="EditorConfiguration.IndentSize">4</value>
-   <value type="bool" key="EditorConfiguration.KeyboardTooltips">false</value>
-   <value type="int" key="EditorConfiguration.MarginColumn">80</value>
-   <value type="bool" key="EditorConfiguration.MouseHiding">true</value>
-   <value type="bool" key="EditorConfiguration.MouseNavigation">true</value>
-   <value type="int" key="EditorConfiguration.PaddingMode">1</value>
-   <value type="bool" key="EditorConfiguration.PreferSingleLineComments">false</value>
-   <value type="bool" key="EditorConfiguration.ScrollWheelZooming">true</value>
-   <value type="bool" key="EditorConfiguration.ShowMargin">false</value>
-   <value type="int" key="EditorConfiguration.SmartBackspaceBehavior">0</value>
-   <value type="bool" key="EditorConfiguration.SmartSelectionChanging">true</value>
-   <value type="bool" key="EditorConfiguration.SpacesForTabs">true</value>
-   <value type="int" key="EditorConfiguration.TabKeyBehavior">0</value>
-   <value type="int" key="EditorConfiguration.TabSize">8</value>
-   <value type="bool" key="EditorConfiguration.UseGlobal">true</value>
-   <value type="bool" key="EditorConfiguration.UseIndenter">false</value>
-   <value type="int" key="EditorConfiguration.Utf8BomBehavior">1</value>
-   <value type="bool" key="EditorConfiguration.addFinalNewLine">true</value>
-   <value type="bool" key="EditorConfiguration.cleanIndentation">true</value>
-   <value type="bool" key="EditorConfiguration.cleanWhitespace">true</value>
-   <value type="QString" key="EditorConfiguration.ignoreFileTypes">*.md, *.MD, Makefile</value>
-   <value type="bool" key="EditorConfiguration.inEntireDocument">false</value>
-   <value type="bool" key="EditorConfiguration.skipTrailingWhitespace">true</value>
-   <value type="bool" key="EditorConfiguration.tintMarginArea">true</value>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.PluginSettings</variable>
-  <valuemap type="QVariantMap">
-   <valuemap type="QVariantMap" key="AutoTest.ActiveFrameworks">
-    <value type="bool" key="AutoTest.Framework.Boost">true</value>
-    <value type="bool" key="AutoTest.Framework.CTest">false</value>
-    <value type="bool" key="AutoTest.Framework.Catch">true</value>
-    <value type="bool" key="AutoTest.Framework.GTest">true</value>
-    <value type="bool" key="AutoTest.Framework.QtQuickTest">true</value>
-    <value type="bool" key="AutoTest.Framework.QtTest">true</value>
-   </valuemap>
-   <valuemap type="QVariantMap" key="AutoTest.CheckStates"/>
-   <value type="int" key="AutoTest.RunAfterBuild">0</value>
-   <value type="bool" key="AutoTest.UseGlobal">true</value>
-   <valuemap type="QVariantMap" key="ClangTools">
-    <value type="bool" key="ClangTools.AnalyzeOpenFiles">true</value>
-    <value type="bool" key="ClangTools.BuildBeforeAnalysis">true</value>
-    <value type="QString" key="ClangTools.DiagnosticConfig">Builtin.DefaultTidyAndClazy</value>
-    <value type="int" key="ClangTools.ParallelJobs">4</value>
-    <valuelist type="QVariantList" key="ClangTools.SelectedDirs"/>
-    <valuelist type="QVariantList" key="ClangTools.SelectedFiles"/>
-    <valuelist type="QVariantList" key="ClangTools.SuppressedDiagnostics"/>
-    <value type="bool" key="ClangTools.UseGlobalSettings">true</value>
-   </valuemap>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.Target.0</variable>
-  <valuemap type="QVariantMap">
-   <value type="QString" key="DeviceType">Desktop</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Qt 6.3.1 GCC 64bit</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Qt 6.3.1 GCC 64bit</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">{70d5e2e6-ad48-44fa-b4dd-c54058c4b48b}</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveBuildConfiguration">0</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveDeployConfiguration">0</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveRunConfiguration">0</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.BuildConfiguration.0">
-    <value type="QString" key="CMake.Build.Type">Debug</value>
-    <value type="bool" key="CMake.Configure.ClearSystemEnvironment">false</value>
-    <valuelist type="QVariantList" key="CMake.Configure.UserEnvironmentChanges"/>
-    <value type="QString" key="CMake.Initial.Parameters">-DCMAKE_GENERATOR:STRING=Ninja
--DCMAKE_BUILD_TYPE:STRING=Debug
--DQT_QMAKE_EXECUTABLE:FILEPATH=%{Qt:qmakeExecutable}
--DCMAKE_PREFIX_PATH:PATH=%{Qt:QT_INSTALL_PREFIX}
--DCMAKE_C_COMPILER:FILEPATH=%{Compiler:Executable:C}
--DCMAKE_CXX_COMPILER:FILEPATH=%{Compiler:Executable:Cxx}
--DCMAKE_CXX_FLAGS_INIT:STRING=%{Qt:QML_DEBUG_FLAG}</value>
-    <value type="QString" key="CMake.Source.Directory">/home/kapper/Code/klips/cpp/qt/designer-plugin-collection</value>
-    <value type="QString" key="ProjectExplorer.BuildConfiguration.BuildDirectory">/home/kapper/Code/klips/cpp/qt/designer-plugin-collection/cmake-build-debug</value>
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
-     <valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
-      <value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
-       <value type="QString">all</value>
-      </valuelist>
-      <value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
-      <value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
-     </valuemap>
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Build</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Build</value>
-    </valuemap>
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.1">
-     <valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
-      <value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
-       <value type="QString">clean</value>
-      </valuelist>
-      <value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
-      <value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
-     </valuemap>
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Clean</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Clean</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Clean</value>
-    </valuemap>
-    <value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">2</value>
-    <value type="bool" key="ProjectExplorer.BuildConfiguration.ClearSystemEnvironment">false</value>
-    <valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.CustomParsers"/>
-    <value type="bool" key="ProjectExplorer.BuildConfiguration.ParseStandardOutput">false</value>
-    <valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.UserEnvironmentChanges"/>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Debug</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeBuildConfiguration</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.BuildConfigurationCount">1</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.DeployConfiguration.0">
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">0</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Deploy</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Deploy</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Deploy</value>
-    </valuemap>
-    <value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">1</value>
-    <valuemap type="QVariantMap" key="ProjectExplorer.DeployConfiguration.CustomData"/>
-    <value type="bool" key="ProjectExplorer.DeployConfiguration.CustomDataEnabled">false</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.DefaultDeployConfiguration</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.DeployConfigurationCount">1</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.RunConfiguration.0">
-    <value type="bool" key="Analyzer.Perf.Settings.UseGlobalSettings">true</value>
-    <value type="bool" key="Analyzer.QmlProfiler.Settings.UseGlobalSettings">true</value>
-    <value type="bool" key="Analyzer.Valgrind.Settings.UseGlobalSettings">true</value>
-    <valuelist type="QVariantList" key="CustomOutputParsers"/>
-    <value type="int" key="PE.EnvironmentAspect.Base">2</value>
-    <valuelist type="QVariantList" key="PE.EnvironmentAspect.Changes"/>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">widget-app</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeRunConfiguration.widget-app</value>
-    <value type="QString" key="ProjectExplorer.RunConfiguration.BuildKey">widget-app</value>
-    <value type="bool" key="RunConfiguration.UseCppDebugger">false</value>
-    <value type="bool" key="RunConfiguration.UseCppDebuggerAuto">true</value>
-    <value type="bool" key="RunConfiguration.UseLibrarySearchPath">true</value>
-    <value type="bool" key="RunConfiguration.UseQmlDebugger">false</value>
-    <value type="bool" key="RunConfiguration.UseQmlDebuggerAuto">true</value>
-    <value type="QString" key="RunConfiguration.WorkingDirectory.default">/home/kapper/Code/klips/cpp/qt/designer-plugin-collection/cmake-build-debug</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.RunConfigurationCount">1</value>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.TargetCount</variable>
-  <value type="qlonglong">1</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.Updater.FileVersion</variable>
-  <value type="int">22</value>
- </data>
- <data>
-  <variable>Version</variable>
-  <value type="int">22</value>
- </data>
-</qtcreator>

cpp/qt/designer-plugin-collection/app-dir.h

@@ -1,6 +1,6 @@
 #ifndef APPDIR_H_IN
 #define APPDIR_H_IN
 
-#define APP_DIR "/home/kapper/Code/klips/cpp/qt/designer-plugin-collection"
+#define APP_DIR "/media/shaun/Storage/Code/klips/cpp/qt/designer-plugin-collection"
 
 #endif // APPDIR_H_IN

cpp/qt/designer-plugin/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ## About: Example of making widget plugins for Qt Designer                    ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
@@ -14,6 +14,9 @@ project(
     DESCRIPTION     "Example of a widget plugin for Qt Designer"
     LANGUAGES       CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+# Lowercase string to use as a slug for executable names for identification.
+string(TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER)
 
 include(GenerateExportHeader)
 
@@ -42,35 +45,44 @@ endif()
 set(QT_INSTALL_DIR "${QT_DIR}/6.3.1/gcc_64/" CACHE PATH "Path to Qt6 install")
 list(APPEND CMAKE_PREFIX_PATH "${QT_INSTALL_DIR}")
 
-find_package(Qt6 REQUIRED COMPONENTS UiPlugin Core Gui Widgets)
+find_package(Qt6 COMPONENTS UiPlugin Core Gui Widgets)
+if (NOT Qt6_FOUND)
+    message(
+        FATAL_ERROR
+        "[Klips] Error: CMake was unable to find Qt6 libraries.\n"
+        "The example will not be built until the build is configured with these packages installed.\n"
+        "On Ubuntu 24.04 Qt6 can be installed using apt:\n"
+        "  sudo apt-get install qt6-base-dev qt6-tools-dev\n"
+    )
+endif()
 
 # Creating the plugin
-
+set(WIDGET_PLUGIN widget-plugin_${PROJECT_NAME_LOWER})
-qt_add_library(widget-plugin)
+qt_add_library(${WIDGET_PLUGIN})
-target_sources(widget-plugin PRIVATE
+target_sources(${WIDGET_PLUGIN} PRIVATE
     text-view.cpp text-view.h
     widget-plugin.cpp widget-plugin.h
 )
-set_target_properties(widget-plugin PROPERTIES
+set_target_properties(${WIDGET_PLUGIN} PROPERTIES
     WIN32_EXECUTABLE TRUE
     MACOSX_BUNDLE TRUE
 )
-target_link_libraries(widget-plugin PUBLIC
+target_link_libraries(${WIDGET_PLUGIN} PUBLIC
     Qt::UiPlugin Qt::Core Qt::Gui Qt::Widgets
 )
 
-install(TARGETS widget-plugin
+install(TARGETS ${WIDGET_PLUGIN}
     RUNTIME DESTINATION "${QT_PLUGIN_INSTALL_DIR}"
     BUNDLE DESTINATION "${QT_PLUGIN_INSTALL_DIR}"
     LIBRARY DESTINATION "${QT_PLUGIN_INSTALL_DIR}"
 )
 
 # Application that will use the widget plugin
-
+set(WIDGET_APP widget-app_${PROJECT_NAME_LOWER})
-qt_add_executable(widget-app
+qt_add_executable(${WIDGET_APP}
     widget-app.cpp widget-app.h widget-app.ui
     main.cpp
 )
-target_link_libraries(widget-app PRIVATE
+target_link_libraries(${WIDGET_APP} PRIVATE
-    Qt::Widgets widget-plugin
+    Qt::Widgets ${WIDGET_PLUGIN}
 )

cpp/qt/designer-plugin/CMakeLists.txt.user

@@ -1,197 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 9.0.1, 2022-12-24T09:58:46. -->
-<qtcreator>
- <data>
-  <variable>EnvironmentId</variable>
-  <value type="QByteArray">{ce8a8d3d-318d-4c62-a573-71d1755252ce}</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.ActiveTarget</variable>
-  <value type="qlonglong">0</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.EditorSettings</variable>
-  <valuemap type="QVariantMap">
-   <value type="bool" key="EditorConfiguration.AutoIndent">true</value>
-   <value type="bool" key="EditorConfiguration.AutoSpacesForTabs">false</value>
-   <value type="bool" key="EditorConfiguration.CamelCaseNavigation">true</value>
-   <valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.0">
-    <value type="QString" key="language">Cpp</value>
-    <valuemap type="QVariantMap" key="value">
-     <value type="QByteArray" key="CurrentPreferences">CppGlobal</value>
-    </valuemap>
-   </valuemap>
-   <valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.1">
-    <value type="QString" key="language">QmlJS</value>
-    <valuemap type="QVariantMap" key="value">
-     <value type="QByteArray" key="CurrentPreferences">QmlJSGlobal</value>
-    </valuemap>
-   </valuemap>
-   <value type="qlonglong" key="EditorConfiguration.CodeStyle.Count">2</value>
-   <value type="QByteArray" key="EditorConfiguration.Codec">UTF-8</value>
-   <value type="bool" key="EditorConfiguration.ConstrainTooltips">false</value>
-   <value type="int" key="EditorConfiguration.IndentSize">4</value>
-   <value type="bool" key="EditorConfiguration.KeyboardTooltips">false</value>
-   <value type="int" key="EditorConfiguration.MarginColumn">80</value>
-   <value type="bool" key="EditorConfiguration.MouseHiding">true</value>
-   <value type="bool" key="EditorConfiguration.MouseNavigation">true</value>
-   <value type="int" key="EditorConfiguration.PaddingMode">1</value>
-   <value type="bool" key="EditorConfiguration.PreferSingleLineComments">false</value>
-   <value type="bool" key="EditorConfiguration.ScrollWheelZooming">true</value>
-   <value type="bool" key="EditorConfiguration.ShowMargin">false</value>
-   <value type="int" key="EditorConfiguration.SmartBackspaceBehavior">0</value>
-   <value type="bool" key="EditorConfiguration.SmartSelectionChanging">true</value>
-   <value type="bool" key="EditorConfiguration.SpacesForTabs">true</value>
-   <value type="int" key="EditorConfiguration.TabKeyBehavior">0</value>
-   <value type="int" key="EditorConfiguration.TabSize">8</value>
-   <value type="bool" key="EditorConfiguration.UseGlobal">true</value>
-   <value type="bool" key="EditorConfiguration.UseIndenter">false</value>
-   <value type="int" key="EditorConfiguration.Utf8BomBehavior">1</value>
-   <value type="bool" key="EditorConfiguration.addFinalNewLine">true</value>
-   <value type="bool" key="EditorConfiguration.cleanIndentation">true</value>
-   <value type="bool" key="EditorConfiguration.cleanWhitespace">true</value>
-   <value type="QString" key="EditorConfiguration.ignoreFileTypes">*.md, *.MD, Makefile</value>
-   <value type="bool" key="EditorConfiguration.inEntireDocument">false</value>
-   <value type="bool" key="EditorConfiguration.skipTrailingWhitespace">true</value>
-   <value type="bool" key="EditorConfiguration.tintMarginArea">true</value>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.PluginSettings</variable>
-  <valuemap type="QVariantMap">
-   <valuemap type="QVariantMap" key="AutoTest.ActiveFrameworks">
-    <value type="bool" key="AutoTest.Framework.Boost">true</value>
-    <value type="bool" key="AutoTest.Framework.CTest">false</value>
-    <value type="bool" key="AutoTest.Framework.Catch">true</value>
-    <value type="bool" key="AutoTest.Framework.GTest">true</value>
-    <value type="bool" key="AutoTest.Framework.QtQuickTest">true</value>
-    <value type="bool" key="AutoTest.Framework.QtTest">true</value>
-   </valuemap>
-   <valuemap type="QVariantMap" key="AutoTest.CheckStates"/>
-   <value type="int" key="AutoTest.RunAfterBuild">0</value>
-   <value type="bool" key="AutoTest.UseGlobal">true</value>
-   <valuemap type="QVariantMap" key="ClangTools">
-    <value type="bool" key="ClangTools.AnalyzeOpenFiles">true</value>
-    <value type="bool" key="ClangTools.BuildBeforeAnalysis">true</value>
-    <value type="QString" key="ClangTools.DiagnosticConfig">Builtin.DefaultTidyAndClazy</value>
-    <value type="int" key="ClangTools.ParallelJobs">4</value>
-    <valuelist type="QVariantList" key="ClangTools.SelectedDirs"/>
-    <valuelist type="QVariantList" key="ClangTools.SelectedFiles"/>
-    <valuelist type="QVariantList" key="ClangTools.SuppressedDiagnostics"/>
-    <value type="bool" key="ClangTools.UseGlobalSettings">true</value>
-   </valuemap>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.Target.0</variable>
-  <valuemap type="QVariantMap">
-   <value type="QString" key="DeviceType">Desktop</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Qt 6.3.1 GCC 64bit</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Qt 6.3.1 GCC 64bit</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">{70d5e2e6-ad48-44fa-b4dd-c54058c4b48b}</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveBuildConfiguration">0</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveDeployConfiguration">0</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveRunConfiguration">0</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.BuildConfiguration.0">
-    <value type="QString" key="CMake.Build.Type">Debug</value>
-    <value type="bool" key="CMake.Configure.ClearSystemEnvironment">false</value>
-    <valuelist type="QVariantList" key="CMake.Configure.UserEnvironmentChanges"/>
-    <value type="QString" key="CMake.Initial.Parameters">-DCMAKE_GENERATOR:STRING=Ninja
--DCMAKE_BUILD_TYPE:STRING=Debug
--DQT_QMAKE_EXECUTABLE:FILEPATH=%{Qt:qmakeExecutable}
--DCMAKE_PREFIX_PATH:PATH=%{Qt:QT_INSTALL_PREFIX}
--DCMAKE_C_COMPILER:FILEPATH=%{Compiler:Executable:C}
--DCMAKE_CXX_COMPILER:FILEPATH=%{Compiler:Executable:Cxx}
--DCMAKE_CXX_FLAGS_INIT:STRING=%{Qt:QML_DEBUG_FLAG}</value>
-    <value type="QString" key="CMake.Source.Directory">/home/kapper/Code/klips/cpp/qt/designer-plugin</value>
-    <value type="QString" key="ProjectExplorer.BuildConfiguration.BuildDirectory">/home/kapper/Code/klips/cpp/qt/designer-plugin/cmake-build-debug</value>
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
-     <valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
-      <value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
-       <value type="QString">all</value>
-      </valuelist>
-      <value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
-      <value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
-     </valuemap>
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Build</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Build</value>
-    </valuemap>
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.1">
-     <valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
-      <value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
-       <value type="QString">clean</value>
-      </valuelist>
-      <value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
-      <value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
-     </valuemap>
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Clean</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Clean</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Clean</value>
-    </valuemap>
-    <value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">2</value>
-    <value type="bool" key="ProjectExplorer.BuildConfiguration.ClearSystemEnvironment">false</value>
-    <valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.CustomParsers"/>
-    <value type="bool" key="ProjectExplorer.BuildConfiguration.ParseStandardOutput">false</value>
-    <valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.UserEnvironmentChanges"/>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Debug</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeBuildConfiguration</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.BuildConfigurationCount">1</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.DeployConfiguration.0">
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">0</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Deploy</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Deploy</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Deploy</value>
-    </valuemap>
-    <value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">1</value>
-    <valuemap type="QVariantMap" key="ProjectExplorer.DeployConfiguration.CustomData"/>
-    <value type="bool" key="ProjectExplorer.DeployConfiguration.CustomDataEnabled">false</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.DefaultDeployConfiguration</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.DeployConfigurationCount">1</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.RunConfiguration.0">
-    <value type="bool" key="Analyzer.Perf.Settings.UseGlobalSettings">true</value>
-    <value type="bool" key="Analyzer.QmlProfiler.Settings.UseGlobalSettings">true</value>
-    <value type="bool" key="Analyzer.Valgrind.Settings.UseGlobalSettings">true</value>
-    <valuelist type="QVariantList" key="CustomOutputParsers"/>
-    <value type="int" key="PE.EnvironmentAspect.Base">2</value>
-    <valuelist type="QVariantList" key="PE.EnvironmentAspect.Changes"/>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">widget-app</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeRunConfiguration.widget-app</value>
-    <value type="QString" key="ProjectExplorer.RunConfiguration.BuildKey">widget-app</value>
-    <value type="bool" key="RunConfiguration.UseCppDebugger">false</value>
-    <value type="bool" key="RunConfiguration.UseCppDebuggerAuto">true</value>
-    <value type="bool" key="RunConfiguration.UseLibrarySearchPath">true</value>
-    <value type="bool" key="RunConfiguration.UseQmlDebugger">false</value>
-    <value type="bool" key="RunConfiguration.UseQmlDebuggerAuto">true</value>
-    <value type="QString" key="RunConfiguration.WorkingDirectory.default">/home/kapper/Code/klips/cpp/qt/designer-plugin/cmake-build-debug</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.RunConfigurationCount">1</value>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.TargetCount</variable>
-  <value type="qlonglong">1</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.Updater.FileVersion</variable>
-  <value type="int">22</value>
- </data>
- <data>
-  <variable>Version</variable>
-  <value type="int">22</value>
- </data>
-</qtcreator>

cpp/qt/designer/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ## About: Practice project for using Qt Designer with custom C++ widgets      ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
@@ -14,6 +14,7 @@ project(
     DESCRIPTION     "Practice using Qt designer for desktop applications"
     LANGUAGES       CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_compile_options(-Wall)
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
@@ -28,7 +29,16 @@ set(QT_DIR "$ENV{HOME}/Code/Clones/Qt/6.3.1/gcc_64/" CACHE PATH "Path to Qt6")
 
 list(APPEND CMAKE_PREFIX_PATH "${QT_DIR}")
 
-find_package(Qt6 REQUIRED COMPONENTS Core Gui Widgets)
+find_package(Qt6 COMPONENTS Core Gui Widgets)
+if (NOT Qt6_FOUND)
+  message(
+      FATAL_ERROR
+      "[Klips] Error: CMake was unable to find Qt6 libraries.\n"
+      "The example will not be built until the build is configured with these packages installed.\n"
+      "On Ubuntu 24.04 Qt6 can be installed using apt:\n"
+      "  sudo apt-get install qt6-base-dev qt6-tools-dev\n"
+  )
+endif()
 
 qt_add_executable(designer
     designer.cpp designer.h designer.ui

cpp/qt/designer/CMakeLists.txt.user

@@ -1,189 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 8.0.1, 2022-12-18T08:59:41. -->
-<qtcreator>
- <data>
-  <variable>EnvironmentId</variable>
-  <value type="QByteArray">{ce8a8d3d-318d-4c62-a573-71d1755252ce}</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.ActiveTarget</variable>
-  <value type="qlonglong">0</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.EditorSettings</variable>
-  <valuemap type="QVariantMap">
-   <value type="bool" key="EditorConfiguration.AutoIndent">true</value>
-   <value type="bool" key="EditorConfiguration.AutoSpacesForTabs">false</value>
-   <value type="bool" key="EditorConfiguration.CamelCaseNavigation">true</value>
-   <valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.0">
-    <value type="QString" key="language">Cpp</value>
-    <valuemap type="QVariantMap" key="value">
-     <value type="QByteArray" key="CurrentPreferences">CppGlobal</value>
-    </valuemap>
-   </valuemap>
-   <valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.1">
-    <value type="QString" key="language">QmlJS</value>
-    <valuemap type="QVariantMap" key="value">
-     <value type="QByteArray" key="CurrentPreferences">QmlJSGlobal</value>
-    </valuemap>
-   </valuemap>
-   <value type="qlonglong" key="EditorConfiguration.CodeStyle.Count">2</value>
-   <value type="QByteArray" key="EditorConfiguration.Codec">UTF-8</value>
-   <value type="bool" key="EditorConfiguration.ConstrainTooltips">false</value>
-   <value type="int" key="EditorConfiguration.IndentSize">4</value>
-   <value type="bool" key="EditorConfiguration.KeyboardTooltips">false</value>
-   <value type="int" key="EditorConfiguration.MarginColumn">80</value>
-   <value type="bool" key="EditorConfiguration.MouseHiding">true</value>
-   <value type="bool" key="EditorConfiguration.MouseNavigation">true</value>
-   <value type="int" key="EditorConfiguration.PaddingMode">1</value>
-   <value type="bool" key="EditorConfiguration.PreferSingleLineComments">false</value>
-   <value type="bool" key="EditorConfiguration.ScrollWheelZooming">true</value>
-   <value type="bool" key="EditorConfiguration.ShowMargin">false</value>
-   <value type="int" key="EditorConfiguration.SmartBackspaceBehavior">0</value>
-   <value type="bool" key="EditorConfiguration.SmartSelectionChanging">true</value>
-   <value type="bool" key="EditorConfiguration.SpacesForTabs">true</value>
-   <value type="int" key="EditorConfiguration.TabKeyBehavior">0</value>
-   <value type="int" key="EditorConfiguration.TabSize">8</value>
-   <value type="bool" key="EditorConfiguration.UseGlobal">true</value>
-   <value type="bool" key="EditorConfiguration.UseIndenter">false</value>
-   <value type="int" key="EditorConfiguration.Utf8BomBehavior">1</value>
-   <value type="bool" key="EditorConfiguration.addFinalNewLine">true</value>
-   <value type="bool" key="EditorConfiguration.cleanIndentation">true</value>
-   <value type="bool" key="EditorConfiguration.cleanWhitespace">true</value>
-   <value type="QString" key="EditorConfiguration.ignoreFileTypes">*.md, *.MD, Makefile</value>
-   <value type="bool" key="EditorConfiguration.inEntireDocument">false</value>
-   <value type="bool" key="EditorConfiguration.skipTrailingWhitespace">true</value>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.PluginSettings</variable>
-  <valuemap type="QVariantMap">
-   <valuemap type="QVariantMap" key="AutoTest.ActiveFrameworks">
-    <value type="bool" key="AutoTest.Framework.Boost">true</value>
-    <value type="bool" key="AutoTest.Framework.CTest">false</value>
-    <value type="bool" key="AutoTest.Framework.Catch">true</value>
-    <value type="bool" key="AutoTest.Framework.GTest">true</value>
-    <value type="bool" key="AutoTest.Framework.QtQuickTest">true</value>
-    <value type="bool" key="AutoTest.Framework.QtTest">true</value>
-   </valuemap>
-   <valuemap type="QVariantMap" key="AutoTest.CheckStates"/>
-   <value type="int" key="AutoTest.RunAfterBuild">0</value>
-   <value type="bool" key="AutoTest.UseGlobal">true</value>
-   <valuemap type="QVariantMap" key="ClangTools">
-    <value type="bool" key="ClangTools.AnalyzeOpenFiles">true</value>
-    <value type="bool" key="ClangTools.BuildBeforeAnalysis">true</value>
-    <value type="QString" key="ClangTools.DiagnosticConfig">Builtin.DefaultTidyAndClazy</value>
-    <value type="int" key="ClangTools.ParallelJobs">4</value>
-    <valuelist type="QVariantList" key="ClangTools.SelectedDirs"/>
-    <valuelist type="QVariantList" key="ClangTools.SelectedFiles"/>
-    <valuelist type="QVariantList" key="ClangTools.SuppressedDiagnostics"/>
-    <value type="bool" key="ClangTools.UseGlobalSettings">true</value>
-   </valuemap>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.Target.0</variable>
-  <valuemap type="QVariantMap">
-   <value type="QString" key="DeviceType">Desktop</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Qt 6.3.1 GCC 64bit</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Qt 6.3.1 GCC 64bit</value>
-   <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">{6ade7dd7-47b1-42f6-b09c-570bb7fbeb1c}</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveBuildConfiguration">0</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveDeployConfiguration">0</value>
-   <value type="qlonglong" key="ProjectExplorer.Target.ActiveRunConfiguration">0</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.BuildConfiguration.0">
-    <value type="QString" key="CMake.Build.Type">Debug</value>
-    <value type="QString" key="CMake.Initial.Parameters">-DCMAKE_GENERATOR:STRING=Ninja
--DCMAKE_BUILD_TYPE:STRING=Debug
--DCMAKE_PROJECT_INCLUDE_BEFORE:FILEPATH=%{IDE:ResourcePath}/package-manager/auto-setup.cmake
--DQT_QMAKE_EXECUTABLE:FILEPATH=%{Qt:qmakeExecutable}
--DCMAKE_PREFIX_PATH:PATH=%{Qt:QT_INSTALL_PREFIX}
--DCMAKE_C_COMPILER:FILEPATH=%{Compiler:Executable:C}
--DCMAKE_CXX_COMPILER:FILEPATH=%{Compiler:Executable:Cxx}
--DCMAKE_CXX_FLAGS_INIT:STRING=%{Qt:QML_DEBUG_FLAG}</value>
-    <value type="QString" key="CMake.Source.Directory">/home/kapper/Code/klips/cpp/qt/designer</value>
-    <value type="QString" key="ProjectExplorer.BuildConfiguration.BuildDirectory">/home/kapper/Code/klips/cpp/qt/designer/cmake-build-debug</value>
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
-     <valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
-       <value type="QString">all</value>
-      </valuelist>
-      <value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
-     </valuemap>
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Build</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Build</value>
-    </valuemap>
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.1">
-     <valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
-      <valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
-       <value type="QString">clean</value>
-      </valuelist>
-      <value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
-      <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
-     </valuemap>
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Clean</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Clean</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Clean</value>
-    </valuemap>
-    <value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">2</value>
-    <value type="bool" key="ProjectExplorer.BuildConfiguration.ClearSystemEnvironment">false</value>
-    <valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.CustomParsers"/>
-    <value type="bool" key="ProjectExplorer.BuildConfiguration.ParseStandardOutput">false</value>
-    <valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.UserEnvironmentChanges"/>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Debug</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeBuildConfiguration</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.BuildConfigurationCount">1</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.DeployConfiguration.0">
-    <valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
-     <value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">0</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Deploy</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Deploy</value>
-     <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Deploy</value>
-    </valuemap>
-    <value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">1</value>
-    <valuemap type="QVariantMap" key="ProjectExplorer.DeployConfiguration.CustomData"/>
-    <value type="bool" key="ProjectExplorer.DeployConfiguration.CustomDataEnabled">false</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.DefaultDeployConfiguration</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.DeployConfigurationCount">1</value>
-   <valuemap type="QVariantMap" key="ProjectExplorer.Target.RunConfiguration.0">
-    <value type="bool" key="Analyzer.Perf.Settings.UseGlobalSettings">true</value>
-    <value type="bool" key="Analyzer.QmlProfiler.Settings.UseGlobalSettings">true</value>
-    <value type="bool" key="Analyzer.Valgrind.Settings.UseGlobalSettings">true</value>
-    <valuelist type="QVariantList" key="CustomOutputParsers"/>
-    <value type="int" key="PE.EnvironmentAspect.Base">2</value>
-    <valuelist type="QVariantList" key="PE.EnvironmentAspect.Changes"/>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">designer</value>
-    <value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeRunConfiguration.designer</value>
-    <value type="QString" key="ProjectExplorer.RunConfiguration.BuildKey">designer</value>
-    <value type="bool" key="RunConfiguration.UseCppDebugger">false</value>
-    <value type="bool" key="RunConfiguration.UseCppDebuggerAuto">true</value>
-    <value type="bool" key="RunConfiguration.UseLibrarySearchPath">true</value>
-    <value type="bool" key="RunConfiguration.UseQmlDebugger">false</value>
-    <value type="bool" key="RunConfiguration.UseQmlDebuggerAuto">true</value>
-    <value type="QString" key="RunConfiguration.WorkingDirectory.default">/home/kapper/Code/klips/cpp/qt/designer/cmake-build-debug</value>
-   </valuemap>
-   <value type="qlonglong" key="ProjectExplorer.Target.RunConfigurationCount">1</value>
-  </valuemap>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.TargetCount</variable>
-  <value type="qlonglong">1</value>
- </data>
- <data>
-  <variable>ProjectExplorer.Project.Updater.FileVersion</variable>
-  <value type="int">22</value>
- </data>
- <data>
-  <variable>Version</variable>
-  <value type="int">22</value>
- </data>
-</qtcreator>

cpp/qt/slots/CMakeLists.txt

@@ -1,6 +1,6 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
 ## About: Practice project for using signals and slots in Qt                  ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
@@ -14,6 +14,7 @@ project(
     DESCRIPTION     "Practice using signals and slots in Qt 6"
     LANGUAGES       CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 add_compile_options(-Wall)
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
@@ -28,7 +29,16 @@ set(QT_DIR "$ENV{HOME}/Code/Clones/Qt/6.3.1/gcc_64/" CACHE PATH "Path to Qt6")
 
 list(APPEND CMAKE_PREFIX_PATH "${QT_DIR}")
 
-find_package(Qt6 REQUIRED COMPONENTS Core Gui Widgets)
+find_package(Qt6 COMPONENTS Core Gui Widgets)
+if (NOT Qt6_FOUND)
+  message(
+      FATAL_ERROR
+      "[Klips] Error: CMake was unable to find Qt6 libraries.\n"
+      "The example will not be built until the build is configured with these packages installed.\n"
+      "On Ubuntu 24.04 Qt6 can be installed using apt:\n"
+      "  sudo apt-get install qt6-base-dev qt6-tools-dev\n"
+  )
+endif()
 
 qt_add_executable(slots
     text-view.cpp text-view.h

cpp/qt/slots/text-view.h

@@ -22,7 +22,7 @@ public:
 
 public:
 signals:
-  void sendTest()QWidget;
+  void sendTest();
 
 private:
 signals:

dotnet/README.md

@@ -1,4 +1,4 @@
-# Dotnet
+# dotnet
 
 ```bash
 shaunrd0/klips/dotnet/

esp/README.md

@@ -0,0 +1,8 @@
+# esp
+
+```bash
+shaunrd0/klips/esp/
+├── cpp     # Examples of ESP32 projects written in C++
+├── rust    # Examples of ESP32 projects written in Rust
+└── README.md
+```

esp/cpp/01_led-button/01_led-button.ino

@@ -0,0 +1,38 @@
+// set pin numbers
+const int buttonPin = 4;  // the number of the pushbutton pin
+const int ledPin =  5;    // the number of the LED pin
+
+// variable for storing the pushbutton status
+int buttonState = 0;
+
+bool light_on = false;
+bool handled = false;
+
+void setup() {
+  Serial.begin(115200);
+  // initialize the pushbutton pin as an input
+  pinMode(buttonPin, INPUT);
+  // initialize the LED pin as an output
+  pinMode(ledPin, OUTPUT);
+}
+
+void loop() {
+  // read the state of the pushbutton value
+  buttonState = digitalRead(buttonPin);
+  // check if the pushbutton is pressed.
+  if (buttonState == HIGH) {
+    if (!handled) {
+      Serial.println("Handling button pressed.");
+      light_on = !light_on;
+      handled = true;
+      digitalWrite(ledPin, light_on ? HIGH : LOW);
+    }
+    // turn LED on
+  } else {
+    if (handled) {
+      Serial.println("Reset button handled state.");
+      handled = false;
+
+    }
+  }
+}

esp/cpp/01_led-button/README.md

@@ -0,0 +1,9 @@
+# 01_led-button
+
+This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
+
+The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
+
+![schematic](./schematic.png)
+
+Simple LED controlled by an on-board button.

esp/cpp/02_led-button-web/02_led-button-web.ino

@@ -0,0 +1,183 @@
+#include <WiFi.h>
+
+//
+// Web server project globals
+
+// Replace with your network credentials
+const char* ssid = "network-name";
+const char* password = "password";
+
+WiFiServer server(80);
+
+// Variable to store the HTTP request
+String header;
+
+// Current time
+unsigned long currentTime = millis();
+// Previous time
+unsigned long previousTime = 0;
+// Define timeout time in milliseconds (example: 2000ms = 2s)
+const long timeoutTime = 2000;
+
+//
+// Button / light project globals
+
+// set pin numbers
+const int buttonPin = 4;  // the number of the pushbutton pin
+const int ledPin =  5;    // the number of the LED pin
+
+// variable for storing the pushbutton status
+int buttonState = 0;
+
+bool light_on = false;
+bool handled = false;
+
+void setup() {
+  Serial.begin(115200);
+  // initialize the pushbutton pin as an input
+  pinMode(buttonPin, INPUT);
+  // initialize the LED pin as an output
+  pinMode(ledPin, OUTPUT);
+
+  // wait for the Serial Monitor to be open
+  while (!Serial) {
+    delay(100);
+  }
+
+  // Connect to Wi-Fi network with SSID and password
+  Serial.print("Connecting to ");
+  Serial.println(ssid);
+  WiFi.begin(ssid, password);
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    Serial.print(".");
+  }
+  // Print local IP address and start web server
+  Serial.println("");
+  Serial.println("WiFi connected.");
+  Serial.println("Web Server IP address: ");
+  Serial.println(WiFi.localIP());
+  server.begin();
+}
+
+// Handles the on-board button press.
+void handleButtonPress() {
+  // read the state of the pushbutton value
+  buttonState = digitalRead(buttonPin);
+  // check if the pushbutton is pressed.
+  if (buttonState == HIGH) {
+    if (!handled) {
+      Serial.println("Handling button pressed.");
+      light_on = !light_on;
+      handled = true;
+      digitalWrite(ledPin, light_on ? HIGH : LOW);
+    }
+    // turn LED on
+  } else {
+    if (handled) {
+      Serial.println("Reset button handled state.");
+      handled = false;
+    }
+  }
+}
+
+void displayPinState(WiFiClient client, int gpio_pin, bool state) {
+  // Display current state, and ON/OFF buttons for GPIO <gpio_pin>
+  client.println(String("<p>GPIO ") + String(gpio_pin) + String(" - Current State ") + String(state ? "ON" : "OFF") + String("</p>"));
+  // If the output state is off, it displays the ON button
+  if (state) {
+    client.println(String("<p><a href=\"/") + String(gpio_pin) + String("/off\"><button class=\"button button2\">OFF</button></a></p>"));
+  } else {
+    client.println(String("<p><a href=\"/") + String(gpio_pin) + String("/on\"><button class=\"button\">ON</button></a></p>"));
+  }
+}
+
+void handleStateChange(WiFiClient client, int gpio_pin) {
+  if (header.indexOf(String("GET /") + String(gpio_pin) + String("/on")) >= 0) {
+    Serial.println(String("GPIO ") + String(gpio_pin) + String(" on"));
+    light_on = true;
+    digitalWrite(gpio_pin, HIGH);
+  } else if (header.indexOf(String("GET /") + String(gpio_pin) + String("/off")) >= 0) {
+    Serial.println(String("GPIO ") + String(gpio_pin) + String(" off"));
+    light_on = false;
+    digitalWrite(gpio_pin, LOW);
+  }
+}
+
+void loop() {
+  WiFiClient client = server.available();   // Listen for incoming clients
+
+  handleButtonPress();
+
+  if (client) {                             // If a new client connects,
+    currentTime = millis();
+    previousTime = currentTime;
+    Serial.println("New Client.");          // print a message out in the serial port
+    Serial.println("Web Server IP address: ");
+    Serial.println(WiFi.localIP());
+
+    String currentLine = "";                // make a String to hold incoming data from the client
+    while (client.connected() && currentTime - previousTime <= timeoutTime) {  // loop while the client's connected
+      // Also handle the button press in this loop to not miss events.
+      handleButtonPress();
+
+      currentTime = millis();
+      if (client.available()) {             // if there's bytes to read from the client,
+        char c = client.read();             // read a byte, then
+        Serial.write(c);                    // print it out the serial monitor
+        header += c;
+        if (c == '\n') {                    // if the byte is a newline character
+          // if the current line is blank, you got two newline characters in a row.
+          // that's the end of the client HTTP request, so send a response:
+          if (currentLine.length() == 0) {
+            // HTTP headers always start with a response code (e.g. HTTP/1.1 200 OK)
+            // and a content-type so the client knows what's coming, then a blank line:
+            client.println("HTTP/1.1 200 OK");
+            client.println("Content-type:text/html");
+            client.println("Connection: close");
+            client.println();
+
+            // turns the GPIOs on and off
+            // Display the HTML web page
+            client.println("<!DOCTYPE html><html>");
+            client.println("<head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">");
+            client.println("<link rel=\"icon\" href=\"data:,\">");
+            // CSS to style the on/off buttons
+            // Feel free to change the background-color and font-size attributes to fit your preferences
+            client.println("<style>html { font-family: Helvetica; display: inline-block; margin: 0px auto; text-align: center;}");
+            client.println(".button { background-color: #4CAF50; border: none; color: white; padding: 16px 40px;");
+            client.println("text-decoration: none; font-size: 30px; margin: 2px; cursor: pointer;}");
+            client.println(".button2 {background-color: #555555;}</style></head>");
+
+            //
+            // Web Page Heading
+            client.println("<body><h1>ESP32 Web Server</h1>");
+            //
+            // Web Page Body Contents
+
+            // Button Controls
+            displayPinState(client, ledPin, light_on);
+
+            //
+            // Close Web Page Body / Heading
+            client.println("</body></html>");
+            // The HTTP response ends with another blank line
+            client.println();
+            // Break out of the while loop
+            break;
+          } else { // if you got a newline, then clear currentLine
+            currentLine = "";
+          }
+        } else if (c != '\r') {  // if you got anything else but a carriage return character,
+          currentLine += c;      // add it to the end of the currentLine
+        }
+      }
+    }
+    // Clear the header variable
+    header = "";
+    // Close the connection
+    client.stop();
+    Serial.println("Client disconnected.");
+    Serial.println("");
+  }
+}

esp/cpp/02_led-button-web/README.md

@@ -0,0 +1,15 @@
+# 02_led-button-web
+
+This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
+
+The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
+
+![schematic](./schematic.png)
+
+This example uses the same schematic as [01_led-button](../01_led-button/).
+
+The only difference is that you can also control the button through a web browser from any device connected to your local network.
+
+This example was adapted from the example code in the [Arduino ESP32 API reference](https://docs.espressif.com/projects/arduino-esp32/en/latest/api/wifi.html#wi-fi-ap-example).
+
+![screenshot](./screenshot.png)

esp/cpp/03_temp-humidity-web/03_temp-humidity-web.ino

@@ -0,0 +1,161 @@
+// Import required libraries
+
+#include "WiFi.h"
+#include "ESPAsyncWebServer.h"
+#include <Adafruit_Sensor.h>
+#include <DHT.h>
+
+// Replace with your network credentials
+const char* ssid = "network-name";
+const char* password = "password";
+
+#define DHTPIN 4     // Digital pin connected to the DHT sensor
+
+// Uncomment the type of sensor in use:
+#define DHTTYPE    DHT11     // DHT 11
+//#define DHTTYPE    DHT22     // DHT 22 (AM2302)
+//#define DHTTYPE    DHT21     // DHT 21 (AM2301)
+
+DHT dht(DHTPIN, DHTTYPE);
+
+// Create AsyncWebServer object on port 80
+AsyncWebServer server(80);
+
+String readDHTTemperature() {
+  // Sensor readings may also be up to 2 seconds 'old' (its a very slow sensor)
+  // Read temperature as Celsius (the default)
+  float t = dht.readTemperature();
+  // Read temperature as Fahrenheit (isFahrenheit = true)
+  //float t = dht.readTemperature(true);
+  // Check if any reads failed and exit early (to try again).
+  if (isnan(t)) {
+    Serial.println("Failed to read from DHT sensor!");
+    return "--";
+  }
+  else {
+    Serial.println(t);
+    return String(t);
+  }
+}
+
+String readDHTHumidity() {
+  // Sensor readings may also be up to 2 seconds 'old' (its a very slow sensor)
+  float h = dht.readHumidity();
+  if (isnan(h)) {
+    Serial.println("Failed to read from DHT sensor!");
+    return "--";
+  }
+  else {
+    Serial.println(h);
+    return String(h);
+  }
+}
+
+const char index_html[] PROGMEM = R"rawliteral(
+<!DOCTYPE HTML><html>
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
+  <style>
+    html {
+     font-family: Arial;
+     display: inline-block;
+     margin: 0px auto;
+     text-align: center;
+    }
+    h2 { font-size: 3.0rem; }
+    p { font-size: 3.0rem; }
+    .units { font-size: 1.2rem; }
+    .dht-labels{
+      font-size: 1.5rem;
+      vertical-align:middle;
+      padding-bottom: 15px;
+    }
+  </style>
+</head>
+<body>
+  <h2>ESP32 DHT Server</h2>
+  <p>
+    <i class="fas fa-thermometer-half" style="color:#059e8a;"></i>
+    <span class="dht-labels">Temperature</span>
+    <span id="temperature">%TEMPERATURE%</span>
+    <sup class="units">&deg;C</sup>
+  </p>
+  <p>
+    <i class="fas fa-tint" style="color:#00add6;"></i>
+    <span class="dht-labels">Humidity</span>
+    <span id="humidity">%HUMIDITY%</span>
+    <sup class="units">&percnt;</sup>
+  </p>
+</body>
+<script>
+setInterval(function ( ) {
+  var xhttp = new XMLHttpRequest();
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      document.getElementById("temperature").innerHTML = this.responseText;
+    }
+  };
+  xhttp.open("GET", "/temperature", true);
+  xhttp.send();
+}, 10000 ) ;
+
+setInterval(function ( ) {
+  var xhttp = new XMLHttpRequest();
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      document.getElementById("humidity").innerHTML = this.responseText;
+    }
+  };
+  xhttp.open("GET", "/humidity", true);
+  xhttp.send();
+}, 10000 ) ;
+</script>
+</html>)rawliteral";
+
+// Replaces placeholder with DHT values
+String processor(const String& var){
+  //Serial.println(var);
+  if(var == "TEMPERATURE"){
+    return readDHTTemperature();
+  }
+  else if(var == "HUMIDITY"){
+    return readDHTHumidity();
+  }
+  return String();
+}
+
+void setup(){
+  // Serial port for debugging purposes
+  Serial.begin(115200);
+
+  dht.begin();
+
+  // Connect to Wi-Fi
+  WiFi.begin(ssid, password);
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(1000);
+    Serial.println("Connecting to WiFi..");
+  }
+
+  // Print ESP32 Local IP Address
+  Serial.println(WiFi.localIP());
+
+  // Route for root / web page
+  server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
+    request->send_P(200, "text/html", index_html, processor);
+  });
+  server.on("/temperature", HTTP_GET, [](AsyncWebServerRequest *request){
+    request->send_P(200, "text/plain", readDHTTemperature().c_str());
+  });
+  server.on("/humidity", HTTP_GET, [](AsyncWebServerRequest *request){
+    request->send_P(200, "text/plain", readDHTHumidity().c_str());
+  });
+
+  // Start server
+  server.begin();
+}
+
+void loop(){
+
+}

esp/cpp/03_temp-humidity-web/README.md

@@ -0,0 +1,60 @@
+# 03_temp-humidity-web
+
+This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
+
+The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
+
+![schematic](./schematic.png)
+
+Temperature and humidity sensor served on a web page within the local network.
+
+![screenshot](./screenshot.png)
+
+## Dependencies
+
+You need to install a couple of libraries for this project:
+
+* The DHT and the Adafruit Unified Sensor Driver libraries to read from the DHT sensor.
+* ESPAsyncWebServer and Async TCP libraries to build the asynchronous web server.
+
+The default Arduino IDE installation will store libraries at `~/Arduino/ibraries` - if this directory doesn't exist, create it.
+
+### Installing DHT Sensor Library
+
+To read from the DHT sensor using Arduino IDE, you need to install the [DHT sensor library](https://github.com/adafruit/DHT-sensor-library).
+
+```bash
+wget -O DHT_sensor.zip https://github.com/adafruit/DHT-sensor-library/archive/master.zip
+unzip DHT_sensor.zip
+mv DHT-sensor-library-master/ ~/Arduino/libraries/DHT_sensor
+```
+
+## Install Adafruit Unified Sensor Driver Library
+
+You also need to install the [Adafruit Unified Sensor Driver library](https://github.com/adafruit/Adafruit_Sensor) to work with the DHT sensor.
+
+```bash
+wget -O Adafruit_sensor.zip https://github.com/adafruit/Adafruit_Sensor/archive/master.zip
+unzip Adafruit_sensor.zip
+mv Adafruit_Sensor-master/ ~/Arduino/libraries/Adafruit_sensor
+```
+
+## Installing ESPAsyncWebServer Library
+
+Follow the next steps to install the [ESPAsyncWebServer library](https://github.com/me-no-dev/ESPAsyncWebServer):
+
+```bash
+wget -O ESPAsyncWebServer.zip https://github.com/me-no-dev/ESPAsyncWebServer/archive/master.zip
+unzip ESPAsyncWebServer.zip
+mv ESPAsyncWebServer-master/ ~/Arduino/libraries/ESPAsyncWebServer
+```
+
+## Installing Async TCP Library
+
+The ESPAsyncWebServer library requires the [AsyncTCP library](https://github.com/me-no-dev/AsyncTCP) to work. Follow the next steps to install that library:
+
+```bash
+wget -O AsyncTCP.zip https://github.com/me-no-dev/AsyncTCP/archive/master.zip
+unzip AsyncTCP.zip
+mv AsyncTCP-master/ ~/Arduino/libraries/AsyncTCP
+```