I'm making an Arduino and PlatformIO library! Haha...

Author: Brahvim

.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,69 @@
+{
+    "files.associations": {
+        "*.s": "asm-intel-x86-generic",
+        "*.asm": "asm-intel-x86-generic",
+        "*.luac": "lua",
+        "initializer_list": "cpp",
+        "map": "cpp",
+        "utility": "cpp",
+        "algorithm": "cpp",
+        "associative_base": "cpp",
+        "basic_definitions": "cpp",
+        "bitset": "cpp",
+        "cctype": "cpp",
+        "char_traits": "cpp",
+        "cmath": "cpp",
+        "complex": "cpp",
+        "cstddef": "cpp",
+        "cstdio": "cpp",
+        "cstdlib": "cpp",
+        "cstring": "cpp",
+        "cwchar": "cpp",
+        "cwctype": "cpp",
+        "deque": "cpp",
+        "exception": "cpp",
+        "func_exception": "cpp",
+        "functional": "cpp",
+        "iomanip": "cpp",
+        "ios": "cpp",
+        "iosfwd": "cpp",
+        "iostream": "cpp",
+        "istream": "cpp",
+        "istream_helpers": "cpp",
+        "iterator": "cpp",
+        "iterator_base": "cpp",
+        "limits": "cpp",
+        "list": "cpp",
+        "locale": "cpp",
+        "memory": "cpp",
+        "new": "cpp",
+        "numeric": "cpp",
+        "ostream": "cpp",
+        "ostream_helpers": "cpp",
+        "queue": "cpp",
+        "serstream": "cpp",
+        "set": "cpp",
+        "sstream": "cpp",
+        "stack": "cpp",
+        "stdexcept": "cpp",
+        "streambuf": "cpp",
+        "string": "cpp",
+        "string_iostream": "cpp",
+        "type_traits": "cpp",
+        "typeinfo": "cpp",
+        "valarray": "cpp",
+        "vector": "cpp",
+        "debuglogging": "cpp"
+    },
+    "cSpell.words": [
+        "NOPM",
+        "NOPRE",
+        "PRINTLNF",
+        "PRINTNP",
+        "PRINTNPF",
+        "PRINTNPLN",
+        "PRINTNPLNF",
+        "PROGMEM"
+    ],
+    "sonarlint.pathToCompileCommands": "${workspaceFolder}/compile_commands.json"
+}

compile_commands.json

@@ -0,0 +1,60 @@
+#pragma once
+
+#ifdef DEBUG_LOGS_PREFIX
+#include <Arduino.h>
+
+#pragma region // Logging without a prefix.
+/** @brief Simply logs whatever is passed. */
+#define DEBUG_PRINT_NOPRE_NOPM(...)             \
+Serial.print(__VA_ARGS__)
+
+/** @brief Logs whatever is passed, storing the input into flash memory using `F()`. */
+#define DEBUG_PRINT_NOPRE(string)               \
+Serial.print(F(string))
+
+/** @brief Logs whatever is passed, with a new-line at the end. */
+#define DEBUG_PRINT_NOPRE_LN_NOPM(...)          \
+Serial.println(__VA_ARGS__)
+
+/** @brief Logs whatever is passed, with a new-line at the end, storing the input into flash memory using `F()`. */
+#define DEBUG_PRINT_NOPRE_LN(string)            \
+Serial.println(F(string))
+#pragma endregion
+
+#pragma region // Logging with a prefix.
+/** @brief Logs with the prefix, and a new-line at the end, storing the input into flash memory using `F()`. */
+#define DEBUG_PRINT_LN(string)		              \
+  Serial.print(F(DEBUG_LOGS_PREFIX));	          \
+  Serial.println(F(string))
+
+/** @brief Simply logs whatever is passed with the prefix. */
+#define DEBUG_PRINT_NOPM(...)                   \
+    Serial.print(DEBUG_LOGS_PREFIX);            \
+    Serial.print(__VA_ARGS__)
+
+/** @brief Logs with the prefix, storing the input into flash memory using `F()`. */
+#define DEBUG_PRINT(string)                     \
+    Serial.print(F(DEBUG_LOGS_PREFIX));         \
+    Serial.print(F(string))
+
+/** @brief Logs with the prefix, and a new-line at the end. */
+#define DEBUG_PRINT_LN_NOPM(...)		            \
+  Serial.print(F(DEBUG_LOGS_PREFIX));	          \
+  Serial.println(__VA_ARGS__)
+#pragma endregion
+
+#else // Else, we define these as empty:
+
+// Without a prefix:
+#define DEBUG_PRINT_NOPRE_NOPM(...)
+#define DEBUG_PRINT_NOPRE(string)
+#define DEBUG_PRINT_NOPRE_LN_NOPM(...)
+#define DEBUG_PRINT_NOPRE_LN(string)
+
+// With a prefix:
+#define DEBUG_PRINT_NOPM(...)
+#define DEBUG_PRINT(string)
+#define DEBUG_PRINT_LN_NOPM(...)
+#define DEBUG_PRINT_LN(string)
+
+#endif

include/DebugLogging.hpp

@@ -0,0 +1,60 @@
+#pragma once
+
+#ifdef ERROR_LOGS_PREFIX
+#include <Arduino.h>
+
+#pragma region // Logging without a prefix.
+/** @brief Simply logs whatever is passed. */
+#define ERROR_PRINT_NOPRE_NOPM(...)             \
+Serial.print(__VA_ARGS__)
+
+/** @brief Logs whatever is passed, storing the input into flash memory using `F()`. */
+#define ERROR_PRINT_NOPRE(string)               \
+Serial.print(F(string))
+
+/** @brief Logs whatever is passed, with a new-line at the end. */
+#define ERROR_PRINT_NOPRE_LN_NOPM(...)          \
+Serial.println(__VA_ARGS__)
+
+/** @brief Logs whatever is passed, with a new-line at the end, storing the input into flash memory using `F()`. */
+#define ERROR_PRINT_NOPRE_LN(string)            \
+Serial.println(F(string))
+#pragma endregion
+
+#pragma region // Logging with a prefix.
+/** @brief Logs with the prefix, and a new-line at the end, storing the input into flash memory using `F()`. */
+#define ERROR_PRINT_LN(string)		              \
+  Serial.print(F(ERROR_LOGS_PREFIX));	          \
+  Serial.println(F(string))
+
+/** @brief Simply logs whatever is passed with the prefix. */
+#define ERROR_PRINT_NOPM(...)                   \
+    Serial.print(ERROR_LOGS_PREFIX);            \
+    Serial.print(__VA_ARGS__)
+
+/** @brief Logs with the prefix, storing the input into flash memory using `F()`. */
+#define ERROR_PRINT(string)                     \
+    Serial.print(F(ERROR_LOGS_PREFIX));         \
+    Serial.print(F(string))
+
+/** @brief Logs with the prefix, and a new-line at the end. */
+#define ERROR_PRINT_LN_NOPM(...)		            \
+  Serial.print(F(ERROR_LOGS_PREFIX));	          \
+  Serial.println(__VA_ARGS__)
+#pragma endregion
+
+#else // Else, we define these as empty:
+
+// Without a prefix:
+#define ERROR_PRINT_NOPRE_NOPM(...)
+#define ERROR_PRINT_NOPRE(string)
+#define ERROR_PRINT_NOPRE_LN_NOPM(...)
+#define ERROR_PRINT_NOPRE_LN(string)
+
+// With a prefix:
+#define ERROR_PRINT_NOPM(...)
+#define ERROR_PRINT(string)
+#define ERROR_PRINT_LN_NOPM(...)
+#define ERROR_PRINT_LN(string)
+
+#endif

include/ErrorLogging.hpp

@@ -0,0 +1,60 @@
+#pragma once
+
+#ifdef WARN_LOGS_PREFIX
+#include <Arduino.h>
+
+#pragma region // Logging without a prefix.
+/** @brief Simply logs whatever is passed. */
+#define WARN_PRINT_NOPRE_NOPM(...)             \
+Serial.print(__VA_ARGS__)
+
+/** @brief Logs whatever is passed, storing the input into flash memory using `F()`. */
+#define WARN_PRINT_NOPRE(string)               \
+Serial.print(F(string))
+
+/** @brief Logs whatever is passed, with a new-line at the end. */
+#define WARN_PRINT_NOPRE_LN_NOPM(...)          \
+Serial.println(__VA_ARGS__)
+
+/** @brief Logs whatever is passed, with a new-line at the end, storing the input into flash memory using `F()`. */
+#define WARN_PRINT_NOPRE_LN(string)            \
+Serial.println(F(string))
+#pragma endregion
+
+#pragma region // Logging with a prefix.
+/** @brief Logs with the prefix, and a new-line at the end, storing the input into flash memory using `F()`. */
+#define WARN_PRINT_LN(string)		              \
+  Serial.print(F(WARN_LOGS_PREFIX));	          \
+  Serial.println(F(string))
+
+/** @brief Simply logs whatever is passed with the prefix. */
+#define WARN_PRINT_NOPM(...)                   \
+    Serial.print(WARN_LOGS_PREFIX);            \
+    Serial.print(__VA_ARGS__)
+
+/** @brief Logs with the prefix, storing the input into flash memory using `F()`. */
+#define WARN_PRINT(string)                     \
+    Serial.print(F(WARN_LOGS_PREFIX));         \
+    Serial.print(F(string))
+
+/** @brief Logs with the prefix, and a new-line at the end. */
+#define WARN_PRINT_LN_NOPM(...)		            \
+  Serial.print(F(WARN_LOGS_PREFIX));	          \
+  Serial.println(__VA_ARGS__)
+#pragma endregion
+
+#else // Else, we define these as empty:
+
+// Without a prefix:
+#define WARN_PRINT_NOPRE_NOPM(...)
+#define WARN_PRINT_NOPRE(string)
+#define WARN_PRINT_NOPRE_LN_NOPM(...)
+#define WARN_PRINT_NOPRE_LN(string)
+
+// With a prefix:
+#define WARN_PRINT_NOPM(...)
+#define WARN_PRINT(string)
+#define WARN_PRINT_LN_NOPM(...)
+#define WARN_PRINT_LN(string)
+
+#endif

include/WarnLogging.hpp

@@ -0,0 +1,19 @@
+{
+    "name": "PerFileLogging",
+    "version": "0.1.0",
+    "description": "A header-library to assist with logging.",
+    "keywords": [
+        "logging"
+    ],
+    "authors": [
+        {
+            "name": "Brahvim",
+            "maintainer": true
+        }
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Brahvim/PerFileLogging"
+    },
+    "frameworks": "*"
+}

library.json

@@ -0,0 +1,7 @@
+version=0.1.0
+author=Brahvim
+architecture=*
+maintainer=Brahvim
+name=PerFileLogging
+; url=https://github.com/Brahvim/ArduinoRoutinesApi
+sentence=A header-library to assist with logging.

library.properties

@@ -0,0 +1,18 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:uno]
+board = uno
+platform = atmelavr
+framework = arduino
+monitor_encoding = ascii
+; lib_deps = mike-matera/ArduinoSTL@1.3.3
+; build_unflags = -fno-rtti
+; build_flags = -DROUTINES_API_ENABLE_DEBUG_LOGS