From bd10771e7d03a2f803244f747f1a5805690ea13f Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sat, 21 Oct 2023 14:51:02 -0300 Subject: [PATCH 01/95] =?UTF-8?q?=F0=9F=94=A7=20Update=20CMakeLists=20to?= =?UTF-8?q?=20cpp?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 22a19c5..5a1be98 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -22,7 +22,7 @@ set(CMAKE_C_STANDARD 11) set(CMAKE_BUILD_TYPE Debug) # Cube file name without .ioc extension -project(stm32_project_template C ASM) +project(stm32_project_template C CXX ASM) # Set the board version to an empty string if your board doesn't have a version set(BOARD_VERSION "") @@ -125,12 +125,12 @@ set(TEST_INCLUDE_DIRECTORIES ## Input files ############################################################################### -file(GLOB_RECURSE C_SOURCES CONFIGURE_DEPENDS "src/*.c") -file(GLOB_RECURSE C_HEADERS CONFIGURE_DEPENDS "inc/*.h") +file(GLOB_RECURSE C_SOURCES CONFIGURE_DEPENDS "src/*.cpp") +file(GLOB_RECURSE C_HEADERS CONFIGURE_DEPENDS "inc/*.hpp") -file(GLOB_RECURSE TESTS_SOURCES CONFIGURE_DEPENDS "tests/src/*.c") -file(GLOB_RECURSE TESTS_HEADERS CONFIGURE_DEPENDS "tests/inc/*.h") -file(GLOB_RECURSE TESTS_BIN CONFIGURE_DEPENDS "tests/bin/*.c") +file(GLOB_RECURSE TESTS_SOURCES CONFIGURE_DEPENDS "tests/src/*.cpp") +file(GLOB_RECURSE TESTS_HEADERS CONFIGURE_DEPENDS "tests/inc/*.hpp") +file(GLOB_RECURSE TESTS_BIN CONFIGURE_DEPENDS "tests/bin/*.cpp") file(GLOB_RECURSE CUBE_SOURCES CONFIGURE_DEPENDS "cube/Src/*.c") @@ -184,12 +184,12 @@ targets_generate_helpme_target() ## Generate test executables ############################################################################### -# Since each test has its own main function, we don't need the main.c from the project -list(REMOVE_ITEM C_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c) +# Since each test has its own main function, we don't need the main.cpp from the project +list(REMOVE_ITEM C_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp) foreach(TEST_FILE ${TESTS_BIN}) - # If TEST_FILE contains /dir1/dir2/file.c, TEST_NAME will be 'file' + # If TEST_FILE contains /dir1/dir2/file.cpp, TEST_NAME will be 'file' get_filename_component(TEST_NAME ${TEST_FILE} NAME_WLE) add_executable(${TEST_NAME} EXCLUDE_FROM_ALL From 0050396406c871a6b27a24ec42b8f752cde60382 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sat, 21 Oct 2023 14:51:20 -0300 Subject: [PATCH 02/95] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20Update=20cube?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cube/stm32_project_template.ioc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cube/stm32_project_template.ioc b/cube/stm32_project_template.ioc index b4efc92..3e57cc9 100644 --- a/cube/stm32_project_template.ioc +++ b/cube/stm32_project_template.ioc @@ -32,8 +32,8 @@ Mcu.PinsNb=14 Mcu.ThirdPartyNb=0 Mcu.UserConstants= Mcu.UserName=STM32F303RETx -MxCube.Version=6.9.0 -MxDb.Version=DB.6.0.90 +MxCube.Version=6.9.1 +MxDb.Version=DB.6.0.91 NVIC.BusFault_IRQn=true\:0\:0\:false\:false\:false\:true\:false\:false NVIC.DebugMonitor_IRQn=true\:0\:0\:false\:false\:false\:true\:false\:false NVIC.ForceEnableDMAVector=true From f93583d31ae2a78fc410b734e4988ce4e7818007 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sat, 21 Oct 2023 14:55:39 -0300 Subject: [PATCH 03/95] =?UTF-8?q?=E2=9C=A8=20Migrate=20mcu=20utility=20to?= =?UTF-8?q?=20cpp?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- inc/mcu.h | 39 -------------------------------- inc/mcu.hpp | 48 ++++++++++++++++++++++++++++++++++++++++ src/{main.c => main.cpp} | 16 ++++++++------ src/{mcu.c => mcu.cpp} | 11 +++++---- 4 files changed, 64 insertions(+), 50 deletions(-) delete mode 100644 inc/mcu.h create mode 100644 inc/mcu.hpp rename src/{main.c => main.cpp} (57%) rename src/{mcu.c => mcu.cpp} (75%) diff --git a/inc/mcu.h b/inc/mcu.h deleted file mode 100644 index 3d09bf9..0000000 --- a/inc/mcu.h +++ /dev/null @@ -1,39 +0,0 @@ -/** - * @file mcu.h - * - * @brief MCU related - */ - -#ifndef __MCU_H__ -#define __MCU_H__ - -#include - -/***************************************** - * Public Function Prototypes - *****************************************/ - -/** - * @brief Initializes MCU and some peripherals. - */ -void mcu_init(void); - -/** - * @brief Initializes System Clock. - * @note Defined by cube. - */ -void SystemClock_Config(void); - -/** - * @brief Put the MCU to sleep. - * - * @param ms Sleep time in milliseconds - */ -void mcu_sleep(uint32_t ms); - -/** - * @brief Toggles LED. - */ -void led_toggle(void); - -#endif // __MCU_H__ diff --git a/inc/mcu.hpp b/inc/mcu.hpp new file mode 100644 index 0000000..3cbf375 --- /dev/null +++ b/inc/mcu.hpp @@ -0,0 +1,48 @@ +/** + * @file mcu.h + * + * @brief MCU related + */ + +#ifndef __MCU_H__ +#define __MCU_H__ + +#include + +/***************************************** + * Public Function Prototypes + *****************************************/ + +extern "C" +{ + /** + * @brief Initializes System Clock. + * @note Defined by cube. + */ + void SystemClock_Config(void); +} + +namespace hal +{ + class mcu + { + public: + /** + * @brief Initializes MCU and some peripherals. + */ + static void init(void); + + /** + * @brief Put the MCU to sleep. + * + * @param ms Sleep time in milliseconds + */ + static void sleep(uint32_t ms); + + /** + * @brief Toggles LED. + */ + static void led_toggle(void); + }; +}; +#endif // __MCU_H__ diff --git a/src/main.c b/src/main.cpp similarity index 57% rename from src/main.c rename to src/main.cpp index 90f8109..c4dedd4 100644 --- a/src/main.c +++ b/src/main.cpp @@ -4,23 +4,25 @@ * @brief Main function */ -#include "mcu.h" +#include "mcu.hpp" /***************************************** * Private Constant Definitions *****************************************/ -#define LED_TOGGLE_DELAY_MS 1500 +static constexpr uint16_t led_toggle_delay_ms = 1500; /***************************************** * Main Function *****************************************/ -int main(void) { - mcu_init(); +int main(void) +{ + hal::mcu::init(); - for (;;) { - led_toggle(); - mcu_sleep(LED_TOGGLE_DELAY_MS); + for (;;) + { + hal::mcu::led_toggle(); + hal::mcu::sleep(led_toggle_delay_ms); } } diff --git a/src/mcu.c b/src/mcu.cpp similarity index 75% rename from src/mcu.c rename to src/mcu.cpp index 12b6877..eae3b03 100644 --- a/src/mcu.c +++ b/src/mcu.cpp @@ -6,7 +6,7 @@ #include -#include "mcu.h" +#include "mcu.hpp" #include "gpio.h" #include "main.h" @@ -15,7 +15,8 @@ * Public Function Body Definitions *****************************************/ -void mcu_init(void) { +void hal::mcu::init(void) +{ HAL_Init(); SystemClock_Config(); @@ -23,10 +24,12 @@ void mcu_init(void) { MX_GPIO_Init(); } -void mcu_sleep(uint32_t ms) { +void hal::mcu::sleep(uint32_t ms) +{ HAL_Delay(ms); } -void led_toggle(void) { +void hal::mcu::led_toggle(void) +{ HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5); } From aa33fbb2833af6b7153493192b12eeea773335c8 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sat, 21 Oct 2023 14:56:35 -0300 Subject: [PATCH 04/95] =?UTF-8?q?=F0=9F=93=9D=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e1fa8d..a8ee989 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Para isso é necessário mudar o nome do projeto, o qual deve ter o mesmo do arq ```c # Cube file name without .ioc extension -project(stm32_project_template C ASM) +project(stm32_project_template C CXX ASM) ``` > Os argumentos `C` e `ASM` estão relacionados ao tipo de linguagem que o projeto utiliza (C e Assembly). From b0b82483d5aa2d85157477dd068cd326ada375e3 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sat, 21 Oct 2023 15:19:18 -0300 Subject: [PATCH 05/95] =?UTF-8?q?=F0=9F=93=9D=20Update=20file=20header?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- inc/mcu.hpp | 2 +- src/main.cpp | 2 +- src/mcu.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/inc/mcu.hpp b/inc/mcu.hpp index 3cbf375..cb5ea2d 100644 --- a/inc/mcu.hpp +++ b/inc/mcu.hpp @@ -1,5 +1,5 @@ /** - * @file mcu.h + * @file mcu.hpp * * @brief MCU related */ diff --git a/src/main.cpp b/src/main.cpp index c4dedd4..2ebd573 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,5 +1,5 @@ /** - * @file main.c + * @file main.cpp * * @brief Main function */ diff --git a/src/mcu.cpp b/src/mcu.cpp index eae3b03..3cc472d 100644 --- a/src/mcu.cpp +++ b/src/mcu.cpp @@ -1,5 +1,5 @@ /** - * @file mcu.c + * @file mcu.cpp * * @brief MCU related */ From 281e42cfe56ea67febbda5e2cc4cef5e14570110 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sat, 21 Oct 2023 15:19:51 -0300 Subject: [PATCH 06/95] =?UTF-8?q?=E2=9C=A8=20Update=20tests=20to=20CPP?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/bin/{test_main.c => test_main.cpp} | 10 ++++++---- tests/inc/{test_core.h => test_core.hpp} | 2 +- tests/src/{test_core.c => test_core.cpp} | 11 ++++++----- 3 files changed, 13 insertions(+), 10 deletions(-) rename tests/bin/{test_main.c => test_main.cpp} (53%) rename tests/inc/{test_core.h => test_core.hpp} (94%) rename tests/src/{test_core.c => test_core.cpp} (66%) diff --git a/tests/bin/test_main.c b/tests/bin/test_main.cpp similarity index 53% rename from tests/bin/test_main.c rename to tests/bin/test_main.cpp index 4cc9e4b..c581fb3 100644 --- a/tests/bin/test_main.c +++ b/tests/bin/test_main.cpp @@ -1,15 +1,17 @@ /** - * @file test_main.c + * @file test_main.cpp * * @brief Main function for tests. */ #include -#include "tests_core.h" +#include "test_core.hpp" -int main(void) { +int main(void) +{ test_core_init(); - for (;;) { + for (;;) + { } } diff --git a/tests/inc/test_core.h b/tests/inc/test_core.hpp similarity index 94% rename from tests/inc/test_core.h rename to tests/inc/test_core.hpp index 058dc8b..e81243f 100644 --- a/tests/inc/test_core.h +++ b/tests/inc/test_core.hpp @@ -1,5 +1,5 @@ /** - * @file test_core.h + * @file test_core.hpp * * @brief Core functions to the test * diff --git a/tests/src/test_core.c b/tests/src/test_core.cpp similarity index 66% rename from tests/src/test_core.c rename to tests/src/test_core.cpp index 3387397..6072f59 100644 --- a/tests/src/test_core.c +++ b/tests/src/test_core.cpp @@ -1,5 +1,5 @@ /** - * @file test_core.c + * @file test_core.cpp * * @brief Core functions to the test * @@ -9,13 +9,14 @@ * */ -#include "test_core.h" -#include "mcu.h" +#include "test_core.hpp" +#include "mcu.hpp" /***************************************** * Public Functions Bodies Definitions *****************************************/ -void test_core_init(void) { - mcu_init(); +void test_core_init(void) +{ + hal::mcu::init(); } From 2b08065c0a815636e9355e74fda90bd178f0bd7a Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 22 Oct 2023 16:22:57 -0300 Subject: [PATCH 07/95] =?UTF-8?q?=E2=9C=A8=20Readd=20C=20support?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bruno1406 --- CMakeLists.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5a1be98..fefdcc0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -125,12 +125,12 @@ set(TEST_INCLUDE_DIRECTORIES ## Input files ############################################################################### -file(GLOB_RECURSE C_SOURCES CONFIGURE_DEPENDS "src/*.cpp") -file(GLOB_RECURSE C_HEADERS CONFIGURE_DEPENDS "inc/*.hpp") +file(GLOB_RECURSE C_SOURCES CONFIGURE_DEPENDS "src/*.cpp" "src/*.c") +file(GLOB_RECURSE C_HEADERS CONFIGURE_DEPENDS "inc/*.hpp" "inc/*.h") -file(GLOB_RECURSE TESTS_SOURCES CONFIGURE_DEPENDS "tests/src/*.cpp") -file(GLOB_RECURSE TESTS_HEADERS CONFIGURE_DEPENDS "tests/inc/*.hpp") -file(GLOB_RECURSE TESTS_BIN CONFIGURE_DEPENDS "tests/bin/*.cpp") +file(GLOB_RECURSE TESTS_SOURCES CONFIGURE_DEPENDS "tests/src/*.cpp" "tests/src/*.c") +file(GLOB_RECURSE TESTS_HEADERS CONFIGURE_DEPENDS "tests/inc/*.hpp" "tests/inc/*.h") +file(GLOB_RECURSE TESTS_BIN CONFIGURE_DEPENDS "tests/bin/*.cpp" "tests/bin/*.c") file(GLOB_RECURSE CUBE_SOURCES CONFIGURE_DEPENDS "cube/Src/*.c") @@ -185,7 +185,10 @@ targets_generate_helpme_target() ############################################################################### # Since each test has its own main function, we don't need the main.cpp from the project -list(REMOVE_ITEM C_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp) +list(REMOVE_ITEM C_SOURCES + ${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c +) foreach(TEST_FILE ${TESTS_BIN}) From 693fe59ef5c7de014358cfbf7b4f5c148c6ed8f0 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 22 Oct 2023 16:42:11 -0300 Subject: [PATCH 08/95] =?UTF-8?q?=F0=9F=94=A7=20Set=20uncrustify=20as=20de?= =?UTF-8?q?fault=20formatter?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vscode/settings.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 3eaff06..a7fb1d5 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,18 +2,16 @@ "editor.tabSize": 4, "editor.detectIndentation": false, "editor.insertSpaces": true, - "files.trimFinalNewlines": true, "files.trimTrailingWhitespace": true, "files.insertFinalNewline": true, "files.eol": "\n", "files.encoding": "utf8", + "editor.defaultFormatter": "zachflower.uncrustify", "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools", - "[c]": { "editor.formatOnSave": true }, - "[markdown]": { "files.trimTrailingWhitespace": false, "files.trimFinalNewlines": false From 345a274fe93b20cf7fe54ef9a4b0ca994d09d3e6 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 22 Oct 2023 16:53:43 -0300 Subject: [PATCH 09/95] =?UTF-8?q?=F0=9F=8E=A8=20Function=20definitions=20i?= =?UTF-8?q?nside=20namespace?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bruno1406 --- src/mcu.cpp | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/mcu.cpp b/src/mcu.cpp index 3cc472d..b11fcff 100644 --- a/src/mcu.cpp +++ b/src/mcu.cpp @@ -15,8 +15,8 @@ * Public Function Body Definitions *****************************************/ -void hal::mcu::init(void) -{ +namespace hal { +void mcu::init(void) { HAL_Init(); SystemClock_Config(); @@ -24,12 +24,11 @@ void hal::mcu::init(void) MX_GPIO_Init(); } -void hal::mcu::sleep(uint32_t ms) -{ +void mcu::sleep(uint32_t ms) { HAL_Delay(ms); } -void hal::mcu::led_toggle(void) -{ +void mcu::led_toggle(void) { HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5); } +} From 545a38eaca72fd59485d6b361821f5cb783de943 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 22 Oct 2023 16:54:06 -0300 Subject: [PATCH 10/95] =?UTF-8?q?=F0=9F=8E=A8=20Format=20with=20uncrustify?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- inc/mcu.hpp | 18 ++++++++---------- src/main.cpp | 6 ++---- tests/bin/test_main.cpp | 6 ++---- tests/src/test_core.cpp | 3 +-- 4 files changed, 13 insertions(+), 20 deletions(-) diff --git a/inc/mcu.hpp b/inc/mcu.hpp index cb5ea2d..223c8c4 100644 --- a/inc/mcu.hpp +++ b/inc/mcu.hpp @@ -15,17 +15,15 @@ extern "C" { - /** - * @brief Initializes System Clock. - * @note Defined by cube. - */ - void SystemClock_Config(void); +/** + * @brief Initializes System Clock. + * @note Defined by cube. + */ +void SystemClock_Config(void); } -namespace hal -{ - class mcu - { +namespace hal { +class mcu { public: /** * @brief Initializes MCU and some peripherals. @@ -43,6 +41,6 @@ namespace hal * @brief Toggles LED. */ static void led_toggle(void); - }; +}; }; #endif // __MCU_H__ diff --git a/src/main.cpp b/src/main.cpp index 2ebd573..98620eb 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -16,12 +16,10 @@ static constexpr uint16_t led_toggle_delay_ms = 1500; * Main Function *****************************************/ -int main(void) -{ +int main(void) { hal::mcu::init(); - for (;;) - { + for (;;) { hal::mcu::led_toggle(); hal::mcu::sleep(led_toggle_delay_ms); } diff --git a/tests/bin/test_main.cpp b/tests/bin/test_main.cpp index c581fb3..76447bd 100644 --- a/tests/bin/test_main.cpp +++ b/tests/bin/test_main.cpp @@ -7,11 +7,9 @@ #include #include "test_core.hpp" -int main(void) -{ +int main(void) { test_core_init(); - for (;;) - { + for (;;) { } } diff --git a/tests/src/test_core.cpp b/tests/src/test_core.cpp index 6072f59..ed9f909 100644 --- a/tests/src/test_core.cpp +++ b/tests/src/test_core.cpp @@ -16,7 +16,6 @@ * Public Functions Bodies Definitions *****************************************/ -void test_core_init(void) -{ +void test_core_init(void) { hal::mcu::init(); } From fd43d6ccda8ca9d12a650bd6fe6bab58ece035bb Mon Sep 17 00:00:00 2001 From: Eduardo Santos Barreto Date: Mon, 30 Oct 2023 20:07:11 -0300 Subject: [PATCH 11/95] =?UTF-8?q?=F0=9F=93=9D=20Fix=20guard=20macros=20nam?= =?UTF-8?q?e?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Lucas Haug <39196309+LucasHaug@users.noreply.github.com> --- inc/mcu.hpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/inc/mcu.hpp b/inc/mcu.hpp index 223c8c4..b5834e9 100644 --- a/inc/mcu.hpp +++ b/inc/mcu.hpp @@ -4,8 +4,8 @@ * @brief MCU related */ -#ifndef __MCU_H__ -#define __MCU_H__ +#ifndef __MCU_HPP__ +#define __MCU_HPP__ #include From 66891682d583be90fb5c1e24202d9926d00eb63f Mon Sep 17 00:00:00 2001 From: Eduardo Santos Barreto Date: Mon, 30 Oct 2023 20:07:46 -0300 Subject: [PATCH 12/95] =?UTF-8?q?=F0=9F=93=9D=20Fix=20guard=20macros=20nam?= =?UTF-8?q?e=20comment?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Lucas Haug <39196309+LucasHaug@users.noreply.github.com> --- inc/mcu.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/inc/mcu.hpp b/inc/mcu.hpp index b5834e9..b543948 100644 --- a/inc/mcu.hpp +++ b/inc/mcu.hpp @@ -43,4 +43,4 @@ class mcu { static void led_toggle(void); }; }; -#endif // __MCU_H__ +#endif // __MCU_HPP__ From 42f102d446305cc37ee7386b2570d8f1bbdab608 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Mon, 30 Oct 2023 20:26:07 -0300 Subject: [PATCH 13/95] =?UTF-8?q?=F0=9F=A9=B9=20Rename=20C=5FThings=20to?= =?UTF-8?q?=20PROJECT=5FThings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index fefdcc0..213c51c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -112,7 +112,7 @@ set(LIB_INCLUDE_DIRECTORIES ## Include directories ############################################################################### -set(C_INCLUDE_DIRECTORIES +set(PROJECT_INCLUDE_DIRECTORIES ./inc ./cube/Inc ) @@ -125,8 +125,8 @@ set(TEST_INCLUDE_DIRECTORIES ## Input files ############################################################################### -file(GLOB_RECURSE C_SOURCES CONFIGURE_DEPENDS "src/*.cpp" "src/*.c") -file(GLOB_RECURSE C_HEADERS CONFIGURE_DEPENDS "inc/*.hpp" "inc/*.h") +file(GLOB_RECURSE PROJECT_SOURCES CONFIGURE_DEPENDS "src/*.cpp" "src/*.c") +file(GLOB_RECURSE PROJECT_HEADERS CONFIGURE_DEPENDS "inc/*.hpp" "inc/*.h") file(GLOB_RECURSE TESTS_SOURCES CONFIGURE_DEPENDS "tests/src/*.cpp" "tests/src/*.c") file(GLOB_RECURSE TESTS_HEADERS CONFIGURE_DEPENDS "tests/inc/*.hpp" "tests/inc/*.h") @@ -142,7 +142,7 @@ list(REMOVE_ITEM CUBE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/cube/Src/system_${DEVI set(FORCED_INCLUDE_HEADERS ) -targets_generate_format_target(C_SOURCES C_HEADERS TESTS_SOURCES TESTS_HEADERS TESTS_BIN) +targets_generate_format_target(PROJECT_SOURCES PROJECT_HEADERS TESTS_SOURCES TESTS_HEADERS TESTS_BIN) ############################################################################### ## Main executable target @@ -150,12 +150,12 @@ targets_generate_format_target(C_SOURCES C_HEADERS TESTS_SOURCES TESTS_HEADERS T add_executable(${PROJECT_NAME} ${CUBE_SOURCES} - ${C_SOURCES} + ${PROJECT_SOURCES} ${LIB_SOURCES} ) target_include_directories(${PROJECT_NAME} PUBLIC - ${C_INCLUDE_DIRECTORIES} + ${PROJECT_INCLUDE_DIRECTORIES} ${LIB_INCLUDE_DIRECTORIES} ${CMSIS_INCLUDE_DIRS} ${HAL_INCLUDE_DIRS} @@ -185,7 +185,7 @@ targets_generate_helpme_target() ############################################################################### # Since each test has its own main function, we don't need the main.cpp from the project -list(REMOVE_ITEM C_SOURCES +list(REMOVE_ITEM PROJECT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c ) @@ -198,13 +198,13 @@ foreach(TEST_FILE ${TESTS_BIN}) add_executable(${TEST_NAME} EXCLUDE_FROM_ALL ${TEST_FILE} ${CUBE_SOURCES} - ${C_SOURCES} + ${PROJECT_SOURCES} ${TESTS_SOURCES} ${LIB_SOURCES} ) target_include_directories(${TEST_NAME} PUBLIC - ${C_INCLUDE_DIRECTORIES} + ${PROJECT_INCLUDE_DIRECTORIES} ${LIB_INCLUDE_DIRECTORIES} ${CMSIS_INCLUDE_DIRS} ${HAL_INCLUDE_DIRS} From c6497cd7351aedd14eb2e1b96bfa710a9b8d005d Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Fri, 23 Feb 2024 10:26:30 -0300 Subject: [PATCH 14/95] =?UTF-8?q?=F0=9F=94=A5=20Remove=20mcu=20led=20toggl?= =?UTF-8?q?e?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cube/stm32_project_template.ioc | 4 ++-- inc/mcu.hpp | 5 ----- src/main.cpp | 1 - src/mcu.cpp | 4 ---- 4 files changed, 2 insertions(+), 12 deletions(-) diff --git a/cube/stm32_project_template.ioc b/cube/stm32_project_template.ioc index 3e57cc9..c5eaea7 100644 --- a/cube/stm32_project_template.ioc +++ b/cube/stm32_project_template.ioc @@ -32,8 +32,8 @@ Mcu.PinsNb=14 Mcu.ThirdPartyNb=0 Mcu.UserConstants= Mcu.UserName=STM32F303RETx -MxCube.Version=6.9.1 -MxDb.Version=DB.6.0.91 +MxCube.Version=6.10.0 +MxDb.Version=DB.6.0.100 NVIC.BusFault_IRQn=true\:0\:0\:false\:false\:false\:true\:false\:false NVIC.DebugMonitor_IRQn=true\:0\:0\:false\:false\:false\:true\:false\:false NVIC.ForceEnableDMAVector=true diff --git a/inc/mcu.hpp b/inc/mcu.hpp index b543948..168a505 100644 --- a/inc/mcu.hpp +++ b/inc/mcu.hpp @@ -36,11 +36,6 @@ class mcu { * @param ms Sleep time in milliseconds */ static void sleep(uint32_t ms); - - /** - * @brief Toggles LED. - */ - static void led_toggle(void); }; }; #endif // __MCU_HPP__ diff --git a/src/main.cpp b/src/main.cpp index 98620eb..94baf12 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -20,7 +20,6 @@ int main(void) { hal::mcu::init(); for (;;) { - hal::mcu::led_toggle(); hal::mcu::sleep(led_toggle_delay_ms); } } diff --git a/src/mcu.cpp b/src/mcu.cpp index b11fcff..35df8e2 100644 --- a/src/mcu.cpp +++ b/src/mcu.cpp @@ -27,8 +27,4 @@ void mcu::init(void) { void mcu::sleep(uint32_t ms) { HAL_Delay(ms); } - -void mcu::led_toggle(void) { - HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5); -} } From 28c344402f5de1201295267dce3b76ef45768bbf Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:27:46 -0300 Subject: [PATCH 15/95] =?UTF-8?q?=F0=9F=94=A7=20Change=20Cube=20toolchain?= =?UTF-8?q?=20to=20CMake?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cube/stm32_project_template.ioc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/cube/stm32_project_template.ioc b/cube/stm32_project_template.ioc index c5eaea7..b6bc248 100644 --- a/cube/stm32_project_template.ioc +++ b/cube/stm32_project_template.ioc @@ -32,8 +32,8 @@ Mcu.PinsNb=14 Mcu.ThirdPartyNb=0 Mcu.UserConstants= Mcu.UserName=STM32F303RETx -MxCube.Version=6.10.0 -MxDb.Version=DB.6.0.100 +MxCube.Version=6.13.0 +MxDb.Version=DB.6.0.130 NVIC.BusFault_IRQn=true\:0\:0\:false\:false\:false\:true\:false\:false NVIC.DebugMonitor_IRQn=true\:0\:0\:false\:false\:false\:true\:false\:false NVIC.ForceEnableDMAVector=true @@ -102,7 +102,7 @@ ProjectManager.CustomerFirmwarePackage= ProjectManager.DefaultFWLocation=true ProjectManager.DeletePrevious=true ProjectManager.DeviceId=STM32F303RETx -ProjectManager.FirmwarePackage=STM32Cube FW_F3 V1.11.4 +ProjectManager.FirmwarePackage=STM32Cube FW_F3 V1.11.5 ProjectManager.FreePins=false ProjectManager.HalAssertFull=false ProjectManager.HeapSize=0x200 @@ -118,7 +118,7 @@ ProjectManager.ProjectName=stm32_project_template ProjectManager.ProjectStructure= ProjectManager.RegisterCallBack= ProjectManager.StackSize=0x400 -ProjectManager.TargetToolchain=Makefile +ProjectManager.TargetToolchain=CMake ProjectManager.ToolChainLocation= ProjectManager.UAScriptAfterPath= ProjectManager.UAScriptBeforePath= From 7b63f561d5c1fbb831ec32d13bf6d8fefce17592 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:29:54 -0300 Subject: [PATCH 16/95] =?UTF-8?q?=F0=9F=94=A7=20Change=20uncrustify=20to?= =?UTF-8?q?=20clang?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .clang-format | 186 +++++ .clang-tidy | 60 ++ uncrustify.cfg | 2132 ------------------------------------------------ 3 files changed, 246 insertions(+), 2132 deletions(-) create mode 100644 .clang-format create mode 100644 .clang-tidy delete mode 100644 uncrustify.cfg diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..4c488a9 --- /dev/null +++ b/.clang-format @@ -0,0 +1,186 @@ +--- +Language: Cpp +BasedOnStyle: LLVM +AccessModifierOffset: -4 +AlignAfterOpenBracket: BlockIndent +AlignArrayOfStructures: None +AlignConsecutiveMacros: None +AlignConsecutiveAssignments: None +AlignConsecutiveBitFields: Consecutive +AlignConsecutiveDeclarations: Consecutive +AlignEscapedNewlines: Left +AlignOperands: Align +AlignTrailingComments: true +AllowAllArgumentsOnNextLine: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortEnumsOnASingleLine: false +AllowShortBlocksOnASingleLine: Empty +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Inline +AllowShortLambdasOnASingleLine: All +AllowShortIfStatementsOnASingleLine: Never +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: Yes +AttributeMacros: + - __capability +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterCaseLabel: false + AfterClass: false + AfterControlStatement: Never + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + AfterExternBlock: false + BeforeCatch: false + BeforeElse: false + BeforeLambdaBody: false + BeforeWhile: false + IndentBraces: false + SplitEmptyFunction: true + SplitEmptyRecord: true + SplitEmptyNamespace: true +BreakBeforeBinaryOperators: None +BreakBeforeConceptDeclarations: true +BreakBeforeBraces: Attach +BreakBeforeInheritanceComma: false +BreakInheritanceList: AfterColon +BreakBeforeTernaryOperators: false +BreakConstructorInitializersBeforeComma: false +BreakConstructorInitializers: AfterColon +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 120 +CommentPragmas: '^ IWYU pragma:' +QualifierAlignment: Leave +CompactNamespaces: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DeriveLineEnding: true +DerivePointerAlignment: false +DisableFormat: false +EmptyLineAfterAccessModifier: Never +EmptyLineBeforeAccessModifier: Always +ExperimentalAutoDetectBinPacking: false +PackConstructorInitializers: NextLine +ConstructorInitializerAllOnOneLineOrOnePerLine: false +AllowAllConstructorInitializersOnNextLine: true +FixNamespaceComments: true +ForEachMacros: + - foreach + - Q_FOREACH + - BOOST_FOREACH +IfMacros: + - KJ_IF_MAYBE +IncludeBlocks: Preserve +IncludeCategories: + - Regex: '^<.*>' + Priority: 1 + SortPriority: 1 + CaseSensitive: false + - Regex: '^".*"' + Priority: 2 + SortPriority: 2 + CaseSensitive: false +IncludeIsMainRegex: '$' +IncludeIsMainSourceRegex: '' +IndentAccessModifiers: false +IndentCaseLabels: true +IndentCaseBlocks: false +IndentGotoLabels: true +IndentPPDirectives: BeforeHash +IndentExternBlock: NoIndent +IndentRequires: false +IndentWidth: 4 +IndentWrappedFunctionNames: true +InsertTrailingCommas: None +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: false +LambdaBodyIndentation: Signature +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBinPackProtocolList: Auto +ObjCBlockIndentWidth: 2 +ObjCBreakBeforeNestedBlockParam: true +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: true +PenaltyBreakAssignment: 2 +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakOpenParenthesis: 0 +PenaltyBreakString: 1000 +PenaltyBreakTemplateDeclaration: 10 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PenaltyIndentedWhitespace: 0 +PointerAlignment: Left +PPIndentWidth: -1 +ReferenceAlignment: Pointer +ReflowComments: true +RemoveBracesLLVM: false +SeparateDefinitionBlocks: Always +ShortNamespaceLines: 0 +SortIncludes: Never +SortJavaStaticImport: Before +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterLogicalNot: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeCaseColon: false +SpaceBeforeCpp11BracedList: false +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: ControlStatements +SpaceBeforeParensOptions: + AfterControlStatements: true + AfterForeachMacros: true + AfterFunctionDefinitionName: false + AfterFunctionDeclarationName: false + AfterIfMacros: true + AfterOverloadedOperator: false + BeforeNonEmptyParentheses: false +SpaceAroundPointerQualifiers: Default +SpaceBeforeRangeBasedForLoopColon: true +SpaceInEmptyBlock: true +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 2 +SpacesInAngles: Never +SpacesInConditionalStatement: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInLineCommentPrefix: + Minimum: 1 + Maximum: -1 +SpacesInParentheses: false +SpacesInSquareBrackets: false +SpaceBeforeSquareBrackets: false +BitFieldColonSpacing: Both +Standard: c++20 +StatementAttributeLikeMacros: + - Q_EMIT +StatementMacros: + - Q_UNUSED + - QT_REQUIRE_VERSION +TabWidth: 4 +UseCRLF: false +UseTab: Never +WhitespaceSensitiveMacros: + - STRINGIZE + - PP_STRINGIZE + - BOOST_PP_STRINGIZE + - NS_SWIFT_NAME + - CF_SWIFT_NAME +... diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 0000000..fd05192 --- /dev/null +++ b/.clang-tidy @@ -0,0 +1,60 @@ +--- +Checks: + -*, + bugprone-*, + -bugprone-easily-swappable-parameters, + -bugprone-narrowing-conversions, + -bugprone-dynamic-static-initializers, + clang-*, + -clang-diagnostic-unused-command-line-argument, + cppcoreguidelines-*, + -cppcoreguidelines-avoid-magic-numbers, + -cppcoreguidelines-pro-bounds-pointer-arithmetic, + -cppcoreguidelines-avoid-do-while, + -cppcoreguidelines-pro-type-union-access, + google-*, + llvm-*, + -llvm-header-guard, + misc-*, + -misc-include-cleaner, + -misc-const-correctness, + -misc-use-anonymous-namespace, + modernize-*, + -modernize-use-nodiscard, + -modernize-use-trailing-return-type, + performance-*, + readability-*, + -readability-duplicate-include, + -readability-magic-numbers, +WarningsAsErrors: '*' +HeaderFileExtensions: + - '' + - h + - hh + - hpp + - hxx +ImplementationFileExtensions: + - c + - cc + - cpp + - cxx +HeaderFilterRegex: '(include|config)/.*.hpp' +FormatStyle: none +CheckOptions: + readability-magic-numbers.IgnorePowersOf2IntegerValues: true + readability-magic-numbers.IgnoreBitFieldsWidths: true + readability-magic-numbers.IgnoreUserDefinedLiterals: true + readability-identifier-length.MinimumVariableNameLength: 2 + readability-identifier-length.IgnoredVariableNames: ^[nxyz]$ + readability-identifier-length.MinimumParameterNameLength: 2 + readability-identifier-length.IgnoredParameterNames: ^[nxyz]$ + misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic: true + cppcoreguidelines-narrowing-conversions.WarnOnIntegerToFloatingPointNarrowingConversion: false + readability-function-cognitive-complexity.Threshold: 30 +SystemHeaders: false +ExtraArgsBefore: + - '--target=arm-none-eabi' + - '--sysroot=/usr/lib/arm-none-eabi/' + - '-I/usr/lib/arm-none-eabi/include/c++/13.2.1/' + - '-I/usr/lib/arm-none-eabi/include/c++/13.2.1/arm-none-eabi/' +... diff --git a/uncrustify.cfg b/uncrustify.cfg deleted file mode 100644 index 26fd455..0000000 --- a/uncrustify.cfg +++ /dev/null @@ -1,2132 +0,0 @@ -# Uncrustify-0.66.1_f - -# -# General options -# - -# The type of line endings. Default=Auto. -newlines = auto # auto/lf/crlf/cr - -# The original size of tabs in the input. Default=8. -input_tab_size = 4 # unsigned number - -# The size of tabs in the output (only used if align_with_tabs=true). Default=8. -output_tab_size = 4 # unsigned number - -# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn). -string_escape_char = 92 # unsigned number - -# Alternate string escape char for Pawn. Only works right before the quote char. -string_escape_char2 = 0 # unsigned number - -# Replace tab characters found in string literals with the escape sequence \t instead. -string_replace_tab_chars = false # false/true - -# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list>=val);'. -# If True, 'assert(x<0 && y>=3)' will be broken. Default=False -# Improvements to template detection may make this option obsolete. -tok_split_gte = false # false/true - -# Override the default ' *INDENT-OFF*' in comments for disabling processing of part of the file. -disable_processing_cmt = "FORMAT_OFF" # string - -# Override the default ' *INDENT-ON*' in comments for enabling processing of part of the file. -enable_processing_cmt = "FORMAT_ON" # string - -# Enable parsing of digraphs. Default=False. -enable_digraphs = false # false/true - -# Control what to do with the UTF-8 BOM (recommend 'remove'). -utf8_bom = ignore # ignore/add/remove/force - -# If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8. -utf8_byte = false # false/true - -# Force the output encoding to UTF-8. -utf8_force = false # false/true - -# -# Spacing options -# - -# Add or remove space around arithmetic operator '+', '-', '/', '*', etc -# also '>>>' '<<' '>>' '%' '|'. -sp_arith = add # ignore/add/remove/force - -# Add or remove space around arithmetic operator '+' and '-'. Overrides sp_arith -sp_arith_additive = ignore # ignore/add/remove/force - -# Add or remove space around assignment operator '=', '+=', etc. -sp_assign = force # ignore/add/remove/force - -# Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign. -sp_cpp_lambda_assign = ignore # ignore/add/remove/force - -# Add or remove space after the capture specification in C++11 lambda. -sp_cpp_lambda_paren = ignore # ignore/add/remove/force - -# Add or remove space around assignment operator '=' in a prototype. -sp_assign_default = force # ignore/add/remove/force - -# Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. -sp_before_assign = ignore # ignore/add/remove/force - -# Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign. -sp_after_assign = ignore # ignore/add/remove/force - -# Add or remove space in 'NS_ENUM ('. -sp_enum_paren = ignore # ignore/add/remove/force - -# Add or remove space around assignment '=' in enum. -sp_enum_assign = force # ignore/add/remove/force - -# Add or remove space before assignment '=' in enum. Overrides sp_enum_assign. -sp_enum_before_assign = ignore # ignore/add/remove/force - -# Add or remove space after assignment '=' in enum. Overrides sp_enum_assign. -sp_enum_after_assign = ignore # ignore/add/remove/force - -# Add or remove space around assignment ':' in enum. -sp_enum_colon = ignore # ignore/add/remove/force - -# Add or remove space around preprocessor '##' concatenation operator. Default=Add. -sp_pp_concat = remove # ignore/add/remove/force - -# Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator. -sp_pp_stringify = remove # ignore/add/remove/force - -# Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'. -sp_before_pp_stringify = ignore # ignore/add/remove/force - -# Add or remove space around boolean operators '&&' and '||'. -sp_bool = force # ignore/add/remove/force - -# Add or remove space around compare operator '<', '>', '==', etc. -sp_compare = force # ignore/add/remove/force - -# Add or remove space inside '(' and ')'. -sp_inside_paren = remove # ignore/add/remove/force - -# Add or remove space between nested parens: '((' vs ') )'. -sp_paren_paren = remove # ignore/add/remove/force - -# Add or remove space between back-to-back parens: ')(' vs ') ('. -sp_cparen_oparen = ignore # ignore/add/remove/force - -# Whether to balance spaces inside nested parens. -sp_balance_nested_parens = false # false/true - -# Add or remove space between ')' and '{'. -sp_paren_brace = force # ignore/add/remove/force - -# Add or remove space before pointer star '*'. -sp_before_ptr_star = remove # ignore/add/remove/force - -# Add or remove space before pointer star '*' that isn't followed by a variable name -# If set to 'ignore', sp_before_ptr_star is used instead. -sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force - -# Add or remove space between pointer stars '*'. -sp_between_ptr_star = remove # ignore/add/remove/force - -# Add or remove space after pointer star '*', if followed by a word. -sp_after_ptr_star = add # ignore/add/remove/force - -# Add or remove space after pointer star '*', if followed by a qualifier. -sp_after_ptr_star_qualifier = ignore # ignore/add/remove/force - -# Add or remove space after a pointer star '*', if followed by a func proto/def. -sp_after_ptr_star_func = add # ignore/add/remove/force - -# Add or remove space after a pointer star '*', if followed by an open paren (function types). -sp_ptr_star_paren = ignore # ignore/add/remove/force - -# Add or remove space before a pointer star '*', if followed by a func proto/def. -sp_before_ptr_star_func = remove # ignore/add/remove/force - -# Add or remove space before a reference sign '&'. -sp_before_byref = remove # ignore/add/remove/force - -# Add or remove space before a reference sign '&' that isn't followed by a variable name. -# If set to 'ignore', sp_before_byref is used instead. -sp_before_unnamed_byref = ignore # ignore/add/remove/force - -# Add or remove space after reference sign '&', if followed by a word. -sp_after_byref = add # ignore/add/remove/force - -# Add or remove space after a reference sign '&', if followed by a func proto/def. -sp_after_byref_func = force # ignore/add/remove/force - -# Add or remove space before a reference sign '&', if followed by a func proto/def. -sp_before_byref_func = remove # ignore/add/remove/force - -# Add or remove space between type and word. Default=Force. -sp_after_type = force # ignore/add/remove/force - -# Add or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('. -sp_before_template_paren = ignore # ignore/add/remove/force - -# Add or remove space in 'template <' vs 'template<'. -# If set to ignore, sp_before_angle is used. -sp_template_angle = force # ignore/add/remove/force - -# Add or remove space before '<>'. -sp_before_angle = remove # ignore/add/remove/force - -# Add or remove space inside '<' and '>'. -sp_inside_angle = remove # ignore/add/remove/force - -# Add or remove space between '<>' and ':'. -sp_angle_colon = ignore # ignore/add/remove/force - -# Add or remove space after '<>'. -sp_after_angle = force # ignore/add/remove/force - -# Add or remove space between '<>' and '(' as found in 'new List(foo);'. -sp_angle_paren = remove # ignore/add/remove/force - -# Add or remove space between '<>' and '()' as found in 'new List();'. -sp_angle_paren_empty = ignore # ignore/add/remove/force - -# Add or remove space between '<>' and a word as in 'List m;' or 'template static ...'. -sp_angle_word = force # ignore/add/remove/force - -# Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add. -sp_angle_shift = remove # ignore/add/remove/force - -# Permit removal of the space between '>>' in 'foo >' (C++11 only). Default=False. -# sp_angle_shift cannot remove the space without this option. -sp_permit_cpp11_shift = true # false/true - -# Add or remove space before '(' of 'if', 'for', 'switch', 'while', etc. -sp_before_sparen = force # ignore/add/remove/force - -# Add or remove space inside if-condition '(' and ')'. -sp_inside_sparen = remove # ignore/add/remove/force - -# Add or remove space before if-condition ')'. Overrides sp_inside_sparen. -sp_inside_sparen_close = ignore # ignore/add/remove/force - -# Add or remove space after if-condition '('. Overrides sp_inside_sparen. -sp_inside_sparen_open = ignore # ignore/add/remove/force - -# Add or remove space after ')' of 'if', 'for', 'switch', and 'while', etc. -sp_after_sparen = ignore # ignore/add/remove/force - -# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while', etc. -sp_sparen_brace = ignore # ignore/add/remove/force - -# Add or remove space between 'invariant' and '(' in the D language. -sp_invariant_paren = ignore # ignore/add/remove/force - -# Add or remove space after the ')' in 'invariant (C) c' in the D language. -sp_after_invariant_paren = ignore # ignore/add/remove/force - -# Add or remove space before empty statement ';' on 'if', 'for' and 'while'. -sp_special_semi = remove # ignore/add/remove/force - -# Add or remove space before ';'. Default=Remove. -sp_before_semi = remove # ignore/add/remove/force - -# Add or remove space before ';' in non-empty 'for' statements. -sp_before_semi_for = remove # ignore/add/remove/force - -# Add or remove space before a semicolon of an empty part of a for statement. -sp_before_semi_for_empty = remove # ignore/add/remove/force - -# Add or remove space after ';', except when followed by a comment. Default=Add. -sp_after_semi = force # ignore/add/remove/force - -# Add or remove space after ';' in non-empty 'for' statements. Default=Force. -sp_after_semi_for = force # ignore/add/remove/force - -# Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; ). -sp_after_semi_for_empty = remove # ignore/add/remove/force - -# Add or remove space before '[' (except '[]'). -sp_before_square = remove # ignore/add/remove/force - -# Add or remove space before '[]'. -sp_before_squares = remove # ignore/add/remove/force - -# Add or remove space inside a non-empty '[' and ']'. -sp_inside_square = remove # ignore/add/remove/force - -# Add or remove space after ',', 'a,b' vs 'a, b'. -sp_after_comma = force # ignore/add/remove/force - -# Add or remove space before ','. Default=Remove. -sp_before_comma = remove # ignore/add/remove/force - -# Add or remove space between ',' and ']' in multidimensional array type 'int[,,]'. Only for C#. -sp_after_mdatype_commas = ignore # ignore/add/remove/force - -# Add or remove space between '[' and ',' in multidimensional array type 'int[,,]'. Only for C#. -sp_before_mdatype_commas = ignore # ignore/add/remove/force - -# Add or remove space between ',' in multidimensional array type 'int[,,]'. Only for C#. -sp_between_mdatype_commas = ignore # ignore/add/remove/force - -# Add or remove space between an open paren and comma: '(,' vs '( ,'. Default=Force. -sp_paren_comma = force # ignore/add/remove/force - -# Add or remove space before the variadic '...' when preceded by a non-punctuator. -sp_before_ellipsis = ignore # ignore/add/remove/force - -# Add or remove space after class ':'. -sp_after_class_colon = force # ignore/add/remove/force - -# Add or remove space before class ':'. -sp_before_class_colon = force # ignore/add/remove/force - -# Add or remove space after class constructor ':'. -sp_after_constr_colon = ignore # ignore/add/remove/force - -# Add or remove space before class constructor ':'. -sp_before_constr_colon = ignore # ignore/add/remove/force - -# Add or remove space before case ':'. Default=Remove. -sp_before_case_colon = remove # ignore/add/remove/force - -# Add or remove space between 'operator' and operator sign. -sp_after_operator = force # ignore/add/remove/force - -# Add or remove space between the operator symbol and the open paren, as in 'operator ++('. -sp_after_operator_sym = remove # ignore/add/remove/force - -# Overrides sp_after_operator_sym when the operator has no arguments, as in 'operator *()'. -sp_after_operator_sym_empty = ignore # ignore/add/remove/force - -# Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'. -sp_after_cast = force # ignore/add/remove/force - -# Add or remove spaces inside cast parens. -sp_inside_paren_cast = remove # ignore/add/remove/force - -# Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'. -sp_cpp_cast_paren = remove # ignore/add/remove/force - -# Add or remove space between 'sizeof' and '('. -sp_sizeof_paren = remove # ignore/add/remove/force - -# Add or remove space after the tag keyword (Pawn). -sp_after_tag = ignore # ignore/add/remove/force - -# Add or remove space inside enum '{' and '}'. -sp_inside_braces_enum = ignore # ignore/add/remove/force - -# Add or remove space inside struct/union '{' and '}'. -sp_inside_braces_struct = ignore # ignore/add/remove/force - -# Add or remove space after open brace in an unnamed temporary direct-list-initialization. -sp_after_type_brace_init_lst_open = ignore # ignore/add/remove/force - -# Add or remove space before close brace in an unnamed temporary direct-list-initialization. -sp_before_type_brace_init_lst_close = ignore # ignore/add/remove/force - -# Add or remove space inside an unnamed temporary direct-list-initialization. -sp_inside_type_brace_init_lst = ignore # ignore/add/remove/force - -# Add or remove space inside '{' and '}'. -sp_inside_braces = ignore # ignore/add/remove/force - -# Add or remove space inside '{}'. -sp_inside_braces_empty = force # ignore/add/remove/force - -# Add or remove space between return type and function name -# A minimum of 1 is forced except for pointer return types. -sp_type_func = force # ignore/add/remove/force - -# Add or remove space between type and open brace of an unnamed temporary direct-list-initialization. -sp_type_brace_init_lst = ignore # ignore/add/remove/force - -# Add or remove space between function name and '(' on function declaration. -sp_func_proto_paren = remove # ignore/add/remove/force - -# Add or remove space between function name and '()' on function declaration without parameters. -sp_func_proto_paren_empty = ignore # ignore/add/remove/force - -# Add or remove space between function name and '(' on function definition. -sp_func_def_paren = remove # ignore/add/remove/force - -# Add or remove space between function name and '()' on function definition without parameters. -sp_func_def_paren_empty = ignore # ignore/add/remove/force - -# Add or remove space inside empty function '()'. -sp_inside_fparens = remove # ignore/add/remove/force - -# Add or remove space inside function '(' and ')'. -sp_inside_fparen = remove # ignore/add/remove/force - -# Add or remove space inside the first parens in the function type: 'void (*x)(...)'. -sp_inside_tparen = ignore # ignore/add/remove/force - -# Add or remove between the parens in the function type: 'void (*x)(...)'. -sp_after_tparen_close = ignore # ignore/add/remove/force - -# Add or remove space between ']' and '(' when part of a function call. -sp_square_fparen = remove # ignore/add/remove/force - -# Add or remove space between ')' and '{' of function. -sp_fparen_brace = force # ignore/add/remove/force - -# Java: Add or remove space between ')' and '{{' of double brace initializer. -sp_fparen_dbrace = ignore # ignore/add/remove/force - -# Add or remove space between function name and '(' on function calls. -sp_func_call_paren = remove # ignore/add/remove/force - -# Add or remove space between function name and '()' on function calls without parameters. -# If set to 'ignore' (the default), sp_func_call_paren is used. -sp_func_call_paren_empty = remove # ignore/add/remove/force - -# Add or remove space between the user function name and '(' on function calls -# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file. -sp_func_call_user_paren = ignore # ignore/add/remove/force - -# Add or remove space between a constructor/destructor and the open paren. -sp_func_class_paren = remove # ignore/add/remove/force - -# Add or remove space between a constructor without parameters or destructor and '()'. -sp_func_class_paren_empty = ignore # ignore/add/remove/force - -# Add or remove space between 'return' and '('. -sp_return_paren = force # ignore/add/remove/force - -# Add or remove space between '__attribute__' and '('. -sp_attribute_paren = remove # ignore/add/remove/force - -# Add or remove space between 'defined' and '(' in '#if defined (FOO)'. -sp_defined_paren = remove # ignore/add/remove/force - -# Add or remove space between 'throw' and '(' in 'throw (something)'. -sp_throw_paren = force # ignore/add/remove/force - -# Add or remove space between 'throw' and anything other than '(' as in '@throw [...];'. -sp_after_throw = ignore # ignore/add/remove/force - -# Add or remove space between 'catch' and '(' in 'catch (something) { }' -# If set to ignore, sp_before_sparen is used. -sp_catch_paren = force # ignore/add/remove/force - -# Add or remove space between 'version' and '(' in 'version (something) { }' (D language) -# If set to ignore, sp_before_sparen is used. -sp_version_paren = ignore # ignore/add/remove/force - -# Add or remove space between 'scope' and '(' in 'scope (something) { }' (D language) -# If set to ignore, sp_before_sparen is used. -sp_scope_paren = ignore # ignore/add/remove/force - -# Add or remove space between 'super' and '(' in 'super (something)'. Default=Remove. -sp_super_paren = remove # ignore/add/remove/force - -# Add or remove space between 'this' and '(' in 'this (something)'. Default=Remove. -sp_this_paren = remove # ignore/add/remove/force - -# Add or remove space between macro and value. -sp_macro = force # ignore/add/remove/force - -# Add or remove space between macro function ')' and value. -sp_macro_func = force # ignore/add/remove/force - -# Add or remove space between 'else' and '{' if on the same line. -sp_else_brace = force # ignore/add/remove/force - -# Add or remove space between '}' and 'else' if on the same line. -sp_brace_else = force # ignore/add/remove/force - -# Add or remove space between '}' and the name of a typedef on the same line. -sp_brace_typedef = force # ignore/add/remove/force - -# Add or remove space between 'catch' and '{' if on the same line. -sp_catch_brace = force # ignore/add/remove/force - -# Add or remove space between '}' and 'catch' if on the same line. -sp_brace_catch = force # ignore/add/remove/force - -# Add or remove space between 'finally' and '{' if on the same line. -sp_finally_brace = force # ignore/add/remove/force - -# Add or remove space between '}' and 'finally' if on the same line. -sp_brace_finally = force # ignore/add/remove/force - -# Add or remove space between 'try' and '{' if on the same line. -sp_try_brace = force # ignore/add/remove/force - -# Add or remove space between get/set and '{' if on the same line. -sp_getset_brace = force # ignore/add/remove/force - -# Add or remove space between a variable and '{' for C++ uniform initialization. Default=Add. -sp_word_brace = add # ignore/add/remove/force - -# Add or remove space between a variable and '{' for a namespace. Default=Add. -sp_word_brace_ns = add # ignore/add/remove/force - -# Add or remove space before the '::' operator. -sp_before_dc = remove # ignore/add/remove/force - -# Add or remove space after the '::' operator. -sp_after_dc = remove # ignore/add/remove/force - -# Add or remove around the D named array initializer ':' operator. -sp_d_array_colon = ignore # ignore/add/remove/force - -# Add or remove space after the '!' (not) operator. Default=Remove. -sp_not = remove # ignore/add/remove/force - -# Add or remove space after the '~' (invert) operator. Default=Remove. -sp_inv = remove # ignore/add/remove/force - -# Add or remove space after the '&' (address-of) operator. Default=Remove -# This does not affect the spacing after a '&' that is part of a type. -sp_addr = remove # ignore/add/remove/force - -# Add or remove space around the '.' or '->' operators. Default=Remove. -sp_member = remove # ignore/add/remove/force - -# Add or remove space after the '*' (dereference) operator. Default=Remove -# This does not affect the spacing after a '*' that is part of a type. -sp_deref = remove # ignore/add/remove/force - -# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove. -sp_sign = remove # ignore/add/remove/force - -# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove. -sp_incdec = remove # ignore/add/remove/force - -# Add or remove space before a backslash-newline at the end of a line. Default=Add. -sp_before_nl_cont = force # ignore/add/remove/force - -# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'. -sp_after_oc_scope = ignore # ignore/add/remove/force - -# Add or remove space after the colon in message specs -# '-(int) f:(int) x;' vs '-(int) f: (int) x;'. -sp_after_oc_colon = ignore # ignore/add/remove/force - -# Add or remove space before the colon in message specs -# '-(int) f: (int) x;' vs '-(int) f : (int) x;'. -sp_before_oc_colon = ignore # ignore/add/remove/force - -# Add or remove space after the colon in immutable dictionary expression -# 'NSDictionary *test = @{@"foo" :@"bar"};'. -sp_after_oc_dict_colon = ignore # ignore/add/remove/force - -# Add or remove space before the colon in immutable dictionary expression -# 'NSDictionary *test = @{@"foo" :@"bar"};'. -sp_before_oc_dict_colon = ignore # ignore/add/remove/force - -# Add or remove space after the colon in message specs -# '[object setValue:1];' vs '[object setValue: 1];'. -sp_after_send_oc_colon = ignore # ignore/add/remove/force - -# Add or remove space before the colon in message specs -# '[object setValue:1];' vs '[object setValue :1];'. -sp_before_send_oc_colon = ignore # ignore/add/remove/force - -# Add or remove space after the (type) in message specs -# '-(int)f: (int) x;' vs '-(int)f: (int)x;'. -sp_after_oc_type = ignore # ignore/add/remove/force - -# Add or remove space after the first (type) in message specs -# '-(int) f:(int)x;' vs '-(int)f:(int)x;'. -sp_after_oc_return_type = ignore # ignore/add/remove/force - -# Add or remove space between '@selector' and '(' -# '@selector(msgName)' vs '@selector (msgName)' -# Also applies to @protocol() constructs. -sp_after_oc_at_sel = ignore # ignore/add/remove/force - -# Add or remove space between '@selector(x)' and the following word -# '@selector(foo) a:' vs '@selector(foo)a:'. -sp_after_oc_at_sel_parens = ignore # ignore/add/remove/force - -# Add or remove space inside '@selector' parens -# '@selector(foo)' vs '@selector( foo )' -# Also applies to @protocol() constructs. -sp_inside_oc_at_sel_parens = ignore # ignore/add/remove/force - -# Add or remove space before a block pointer caret -# '^int (int arg){...}' vs. ' ^int (int arg){...}'. -sp_before_oc_block_caret = ignore # ignore/add/remove/force - -# Add or remove space after a block pointer caret -# '^int (int arg){...}' vs. '^ int (int arg){...}'. -sp_after_oc_block_caret = ignore # ignore/add/remove/force - -# Add or remove space between the receiver and selector in a message. -# '[receiver selector ...]'. -sp_after_oc_msg_receiver = ignore # ignore/add/remove/force - -# Add or remove space after @property. -sp_after_oc_property = ignore # ignore/add/remove/force - -# Add or remove space around the ':' in 'b ? t : f'. -sp_cond_colon = ignore # ignore/add/remove/force - -# Add or remove space before the ':' in 'b ? t : f'. Overrides sp_cond_colon. -sp_cond_colon_before = ignore # ignore/add/remove/force - -# Add or remove space after the ':' in 'b ? t : f'. Overrides sp_cond_colon. -sp_cond_colon_after = ignore # ignore/add/remove/force - -# Add or remove space around the '?' in 'b ? t : f'. -sp_cond_question = force # ignore/add/remove/force - -# Add or remove space before the '?' in 'b ? t : f'. Overrides sp_cond_question. -sp_cond_question_before = ignore # ignore/add/remove/force - -# Add or remove space after the '?' in 'b ? t : f'. Overrides sp_cond_question. -sp_cond_question_after = ignore # ignore/add/remove/force - -# In the abbreviated ternary form (a ?: b), add/remove space between ? and :.'. Overrides all other sp_cond_* options. -sp_cond_ternary_short = ignore # ignore/add/remove/force - -# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here. -sp_case_label = force # ignore/add/remove/force - -# Control the space around the D '..' operator. -sp_range = ignore # ignore/add/remove/force - -# Control the spacing after ':' in 'for (TYPE VAR : EXPR)'. Only JAVA. -sp_after_for_colon = ignore # ignore/add/remove/force - -# Control the spacing before ':' in 'for (TYPE VAR : EXPR)'. Only JAVA. -sp_before_for_colon = ignore # ignore/add/remove/force - -# Control the spacing in 'extern (C)' (D). -sp_extern_paren = ignore # ignore/add/remove/force - -# Control the space after the opening of a C++ comment '// A' vs '//A'. -sp_cmt_cpp_start = force # ignore/add/remove/force - -# True: If space is added with sp_cmt_cpp_start, do it after doxygen sequences like '///', '///<', '//!' and '//!<'. -sp_cmt_cpp_doxygen = true # false/true - -# True: If space is added with sp_cmt_cpp_start, do it after Qt translator or meta-data comments like '//:', '//=', and '//~'. -sp_cmt_cpp_qttr = false # false/true - -# Controls the spaces between #else or #endif and a trailing comment. -sp_endif_cmt = force # ignore/add/remove/force - -# Controls the spaces after 'new', 'delete' and 'delete[]'. -sp_after_new = force # ignore/add/remove/force - -# Controls the spaces between new and '(' in 'new()'. -sp_between_new_paren = ignore # ignore/add/remove/force - -# Controls the spaces between ')' and 'type' in 'new(foo) BAR'. -sp_after_newop_paren = ignore # ignore/add/remove/force - -# Controls the spaces inside paren of the new operator: 'new(foo) BAR'. -sp_inside_newop_paren = ignore # ignore/add/remove/force - -# Controls the space after open paren of the new operator: 'new(foo) BAR'. -# Overrides sp_inside_newop_paren. -sp_inside_newop_paren_open = ignore # ignore/add/remove/force - -# Controls the space before close paren of the new operator: 'new(foo) BAR'. -# Overrides sp_inside_newop_paren. -sp_inside_newop_paren_close = ignore # ignore/add/remove/force - -# Controls the spaces before a trailing or embedded comment. -sp_before_tr_emb_cmt = force # ignore/add/remove/force - -# Number of spaces before a trailing or embedded comment. -sp_num_before_tr_emb_cmt = 2 # unsigned number - -# Control space between a Java annotation and the open paren. -sp_annotation_paren = ignore # ignore/add/remove/force - -# If True, vbrace tokens are dropped to the previous token and skipped. -sp_skip_vbrace_tokens = false # false/true - -# If True, a is inserted after #define. -force_tab_after_define = false # false/true - -# -# Indenting -# - -# The number of columns to indent per level. -# Usually 2, 3, 4, or 8. Default=8. -indent_columns = 4 # unsigned number - -# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents. -# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each '(' level. -indent_continue = 0 # number - -# The continuation indent for func_*_param if they are true. -# If non-zero, this overrides the indent. -indent_param = 0 # unsigned number - -# How to use tabs when indenting code -# 0=spaces only -# 1=indent with tabs to brace level, align with spaces (default) -# 2=indent and align with tabs, using spaces when not on a tabstop -indent_with_tabs = 0 # unsigned number - -# Comments that are not a brace level are indented with tabs on a tabstop. -# Requires indent_with_tabs=2. If false, will use spaces. -indent_cmt_with_tabs = false # false/true - -# Whether to indent strings broken by '\' so that they line up. -indent_align_string = false # false/true - -# The number of spaces to indent multi-line XML strings. -# Requires indent_align_string=True. -indent_xml_string = 0 # unsigned number - -# Spaces to indent '{' from level. -indent_brace = 0 # unsigned number - -# Whether braces are indented to the body level. -indent_braces = false # false/true - -# Disabled indenting function braces if indent_braces is True. -indent_braces_no_func = false # false/true - -# Disabled indenting class braces if indent_braces is True. -indent_braces_no_class = false # false/true - -# Disabled indenting struct braces if indent_braces is True. -indent_braces_no_struct = false # false/true - -# Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc. -indent_brace_parent = false # false/true - -# Indent based on the paren open instead of the brace open in '({\n', default is to indent by brace. -indent_paren_open_brace = false # false/true - -# indent a C# delegate by another level, default is to not indent by another level. -indent_cs_delegate_brace = false # false/true - -# Whether the 'namespace' body is indented. -indent_namespace = false # false/true - -# Only indent one namespace and no sub-namespaces. -# Requires indent_namespace=True. -indent_namespace_single_indent = false # false/true - -# The number of spaces to indent a namespace block. -indent_namespace_level = 0 # unsigned number - -# If the body of the namespace is longer than this number, it won't be indented. -# Requires indent_namespace=True. Default=0 (no limit) -indent_namespace_limit = 0 # unsigned number - -# Whether the 'extern "C"' body is indented. -indent_extern = false # false/true - -# Whether the 'class' body is indented. -indent_class = true # false/true - -# Whether to indent the stuff after a leading base class colon. -indent_class_colon = false # false/true - -# Indent based on a class colon instead of the stuff after the colon. -# Requires indent_class_colon=True. Default=False. -indent_class_on_colon = false # false/true - -# Whether to indent the stuff after a leading class initializer colon. -indent_constr_colon = false # false/true - -# Virtual indent from the ':' for member initializers. Default=2. -indent_ctor_init_leading = 2 # unsigned number - -# Additional indent for constructor initializer list. -# Negative values decrease indent down to the first column. Default=0. -indent_ctor_init = 0 # number - -# False=treat 'else\nif' as 'else if' for indenting purposes -# True=indent the 'if' one level. -indent_else_if = false # false/true - -# Amount to indent variable declarations after a open brace. neg=relative, pos=absolute. -indent_var_def_blk = 0 # number - -# Indent continued variable declarations instead of aligning. -indent_var_def_cont = false # false/true - -# Indent continued shift expressions ('<<' and '>>') instead of aligning. -# Turn align_left_shift off when enabling this. -indent_shift = false # false/true - -# True: force indentation of function definition to start in column 1 -# False: use the default behavior. -indent_func_def_force_col1 = false # false/true - -# True: indent continued function call parameters one indent level -# False: align parameters under the open paren. -indent_func_call_param = false # false/true - -# Same as indent_func_call_param, but for function defs. -indent_func_def_param = false # false/true - -# Same as indent_func_call_param, but for function protos. -indent_func_proto_param = false # false/true - -# Same as indent_func_call_param, but for class declarations. -indent_func_class_param = false # false/true - -# Same as indent_func_call_param, but for class variable constructors. -indent_func_ctor_var_param = false # false/true - -# Same as indent_func_call_param, but for templates. -indent_template_param = false # false/true - -# Double the indent for indent_func_xxx_param options. -# Use both values of the options indent_columns and indent_param. -indent_func_param_double = false # false/true - -# Indentation column for standalone 'const' function decl/proto qualifier. -indent_func_const = 0 # unsigned number - -# Indentation column for standalone 'throw' function decl/proto qualifier. -indent_func_throw = 0 # unsigned number - -# The number of spaces to indent a continued '->' or '.' -# Usually set to 0, 1, or indent_columns. -indent_member = 4 # unsigned number - -# Spaces to indent single line ('//') comments on lines before code. -indent_sing_line_comments = 0 # unsigned number - -# If set, will indent trailing single line ('//') comments relative -# to the code instead of trying to keep the same absolute column. -indent_relative_single_line_comments = false # false/true - -# Spaces to indent 'case' from 'switch' -# Usually 0 or indent_columns. -indent_switch_case = 4 # unsigned number - -# Whether to indent preproccesor statements inside of switch statements. -indent_switch_pp = true # false/true - -# Spaces to shift the 'case' line, without affecting any other lines -# Usually 0. -indent_case_shift = 0 # unsigned number - -# Spaces to indent '{' from 'case'. -# By default, the brace will appear under the 'c' in case. -# Usually set to 0 or indent_columns. -# negative value are OK. -indent_case_brace = 0 # number - -# Whether to indent comments found in first column. -indent_col1_comment = false # false/true - -# How to indent goto labels -# >0: absolute column where 1 is the leftmost column -# <=0: subtract from brace indent -# Default=1 -indent_label = 1 # number - -# Same as indent_label, but for access specifiers that are followed by a colon. Default=1 -indent_access_spec = 1 # number - -# Indent the code after an access specifier by one level. -# If set, this option forces 'indent_access_spec=0'. -indent_access_spec_body = true # false/true - -# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended). -indent_paren_nl = false # false/true - -# Controls the indent of a close paren after a newline. -# 0: Indent to body level -# 1: Align under the open paren -# 2: Indent to the brace level -indent_paren_close = 0 # unsigned number - -# Controls the indent of the open paren of a function definition, if on it's own line.If True, indents the open paren -indent_paren_after_func_def = false # false/true - -# Controls the indent of the open paren of a function declaration, if on it's own line.If True, indents the open paren -indent_paren_after_func_decl = false # false/true - -# Controls the indent of the open paren of a function call, if on it's own line.If True, indents the open paren -indent_paren_after_func_call = false # false/true - -# Controls the indent of a comma when inside a paren.If True, aligns under the open paren. -indent_comma_paren = false # false/true - -# Controls the indent of a BOOL operator when inside a paren.If True, aligns under the open paren. -indent_bool_paren = false # false/true - -# If 'indent_bool_paren' is True, controls the indent of the first expression. If True, aligns the first expression to the following ones. -indent_first_bool_expr = true # false/true - -# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended). -indent_square_nl = false # false/true - -# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies. -indent_preserve_sql = false # false/true - -# Align continued statements at the '='. Default=True -# If False or the '=' is followed by a newline, the next line is indent one tab. -indent_align_assign = true # false/true - -# Indent OC blocks at brace level instead of usual rules. -indent_oc_block = false # false/true - -# Indent OC blocks in a message relative to the parameter name. -# 0=use indent_oc_block rules, 1+=spaces to indent -indent_oc_block_msg = 0 # unsigned number - -# Minimum indent for subsequent parameters -indent_oc_msg_colon = 0 # unsigned number - -# If True, prioritize aligning with initial colon (and stripping spaces from lines, if necessary). -# Default=True. -indent_oc_msg_prioritize_first_colon = true # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented the way that Xcode does by default (from keyword if the parameter is on its own line; otherwise, from the previous indentation level). -indent_oc_block_msg_xcode_style = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is relative to a msg keyword. -indent_oc_block_msg_from_keyword = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is relative to a msg colon. -indent_oc_block_msg_from_colon = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the block caret is. -indent_oc_block_msg_from_caret = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is. -indent_oc_block_msg_from_brace = false # false/true - -# When identing after virtual brace open and newline add further spaces to reach this min. indent. -indent_min_vbrace_open = 0 # unsigned number - -# True: When identing after virtual brace open and newline add further spaces after regular indent to reach next tabstop. -indent_vbrace_open_on_tabstop = false # false/true - -# If True, a brace followed by another token (not a newline) will indent all contained lines to match the token.Default=True. -indent_token_after_brace = true # false/true - -# If True, cpp lambda body will be indentedDefault=False. -indent_cpp_lambda_body = true # false/true - -# indent (or not) an using block if no braces are used. Only for C#.Default=True. -indent_using_block = true # false/true - -# indent the continuation of ternary operator. -# 0: (Default) off -# 1: When the `if_false` is a continuation, indent it under `if_false` -# 2: When the `:` is a continuation, indent it under `?` -indent_ternary_operator = 0 # unsigned number - -# If true, ignore indent and align for asm blocks as they have their own indentation. -indent_ignore_asm_block = false # false/true - -# -# Newline adding and removing options -# - -# Whether to collapse empty blocks between '{' and '}'. -nl_collapse_empty_body = false # false/true - -# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'. -nl_assign_leave_one_liners = true # false/true - -# Don't split one-line braced statements inside a class xx { } body. -nl_class_leave_one_liners = true # false/true - -# Don't split one-line enums: 'enum foo { BAR = 15 };' -nl_enum_leave_one_liners = false # false/true - -# Don't split one-line get or set functions. -nl_getset_leave_one_liners = false # false/true - -# Don't split one-line function definitions - 'int foo() { return 0; }'. -nl_func_leave_one_liners = false # false/true - -# Don't split one-line C++11 lambdas - '[]() { return 0; }'. -nl_cpp_lambda_leave_one_liners = false # false/true - -# Don't split one-line if/else statements - 'if(a) b++;'. -nl_if_leave_one_liners = false # false/true - -# Don't split one-line while statements - 'while(a) b++;'. -nl_while_leave_one_liners = false # false/true - -# Don't split one-line OC messages. -nl_oc_msg_leave_one_liner = false # false/true - -# Add or remove newline between Objective-C block signature and '{'. -nl_oc_block_brace = ignore # ignore/add/remove/force - -# Add or remove newlines at the start of the file. -nl_start_of_file = ignore # ignore/add/remove/force - -# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'. -nl_start_of_file_min = 0 # unsigned number - -# Add or remove newline at the end of the file. -nl_end_of_file = force # ignore/add/remove/force - -# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force'). -nl_end_of_file_min = 1 # unsigned number - -# Add or remove newline between '=' and '{'. -nl_assign_brace = remove # ignore/add/remove/force - -# Add or remove newline between '=' and '[' (D only). -nl_assign_square = ignore # ignore/add/remove/force - -# Add or remove newline after '= [' (D only). Will also affect the newline before the ']'. -nl_after_square_assign = ignore # ignore/add/remove/force - -# The number of blank lines after a block of variable definitions at the top of a function body -# 0 = No change (default). -nl_func_var_def_blk = 0 # unsigned number - -# The number of newlines before a block of typedefs -# 0 = No change (default) -# is overridden by the option 'nl_after_access_spec'. -nl_typedef_blk_start = 0 # unsigned number - -# The number of newlines after a block of typedefs -# 0 = No change (default). -nl_typedef_blk_end = 0 # unsigned number - -# The maximum consecutive newlines within a block of typedefs -# 0 = No change (default). -nl_typedef_blk_in = 0 # unsigned number - -# The number of newlines before a block of variable definitions not at the top of a function body -# 0 = No change (default) -# is overridden by the option 'nl_after_access_spec'. -nl_var_def_blk_start = 0 # unsigned number - -# The number of newlines after a block of variable definitions not at the top of a function body -# 0 = No change (default). -nl_var_def_blk_end = 0 # unsigned number - -# The maximum consecutive newlines within a block of variable definitions -# 0 = No change (default). -nl_var_def_blk_in = 0 # unsigned number - -# Add or remove newline between a function call's ')' and '{', as in: -# list_for_each(item, &list) { }. -nl_fcall_brace = force # ignore/add/remove/force - -# Add or remove newline between 'enum' and '{'. -nl_enum_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'enum' and 'class'. -nl_enum_class = ignore # ignore/add/remove/force - -# Add or remove newline between 'enum class' and the identifier. -nl_enum_class_identifier = ignore # ignore/add/remove/force - -# Add or remove newline between 'enum class' type and ':'. -nl_enum_identifier_colon = ignore # ignore/add/remove/force - -# Add or remove newline between 'enum class identifier :' and 'type' and/or 'type'. -nl_enum_colon_type = ignore # ignore/add/remove/force - -# Add or remove newline between 'struct and '{'. -nl_struct_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'union' and '{'. -nl_union_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'if' and '{'. -nl_if_brace = remove # ignore/add/remove/force - -# Add or remove newline between '}' and 'else'. -nl_brace_else = remove # ignore/add/remove/force - -# Add or remove newline between 'else if' and '{' -# If set to ignore, nl_if_brace is used instead. -nl_elseif_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'else' and '{'. -nl_else_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'else' and 'if'. -nl_else_if = remove # ignore/add/remove/force - -# Add or remove newline before 'if'/'else if' closing parenthesis. -nl_before_if_closing_paren = ignore # ignore/add/remove/force - -# Add or remove newline between '}' and 'finally'. -nl_brace_finally = remove # ignore/add/remove/force - -# Add or remove newline between 'finally' and '{'. -nl_finally_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'try' and '{'. -nl_try_brace = remove # ignore/add/remove/force - -# Add or remove newline between get/set and '{'. -nl_getset_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'for' and '{'. -nl_for_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'catch' and '{'. -nl_catch_brace = remove # ignore/add/remove/force - -# Add or remove newline between '}' and 'catch'. -nl_brace_catch = remove # ignore/add/remove/force - -# Add or remove newline between '}' and ']'. -nl_brace_square = ignore # ignore/add/remove/force - -# Add or remove newline between '}' and ')' in a function invocation. -nl_brace_fparen = ignore # ignore/add/remove/force - -# Add or remove newline between 'while' and '{'. -nl_while_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'scope (x)' and '{' (D). -nl_scope_brace = ignore # ignore/add/remove/force - -# Add or remove newline between 'unittest' and '{' (D). -nl_unittest_brace = ignore # ignore/add/remove/force - -# Add or remove newline between 'version (x)' and '{' (D). -nl_version_brace = ignore # ignore/add/remove/force - -# Add or remove newline between 'using' and '{'. -nl_using_brace = remove # ignore/add/remove/force - -# Add or remove newline between two open or close braces. -# Due to general newline/brace handling, REMOVE may not work. -nl_brace_brace = ignore # ignore/add/remove/force - -# Add or remove newline between 'do' and '{'. -nl_do_brace = remove # ignore/add/remove/force - -# Add or remove newline between '}' and 'while' of 'do' statement. -nl_brace_while = remove # ignore/add/remove/force - -# Add or remove newline between 'switch' and '{'. -nl_switch_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'synchronized' and '{'. -nl_synchronized_brace = ignore # ignore/add/remove/force - -# Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc. -# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and nl_catch_brace. -nl_multi_line_cond = false # false/true - -# Force a newline in a define after the macro name for multi-line defines. -nl_multi_line_define = false # false/true - -# Whether to put a newline before 'case' statement, not after the first 'case'. -nl_before_case = true # false/true - -# Add or remove newline between ')' and 'throw'. -nl_before_throw = ignore # ignore/add/remove/force - -# Whether to put a newline after 'case' statement. -nl_after_case = true # false/true - -# Add or remove a newline between a case ':' and '{'. Overrides nl_after_case. -nl_case_colon_brace = remove # ignore/add/remove/force - -# Newline between namespace and {. -nl_namespace_brace = remove # ignore/add/remove/force - -# Add or remove newline between 'template<>' and whatever follows. -nl_template_class = add # ignore/add/remove/force - -# Add or remove newline between 'class' and '{'. -nl_class_brace = remove # ignore/add/remove/force - -# Add or remove newline before/after each ',' in the base class list, -# (tied to pos_class_comma). -nl_class_init_args = ignore # ignore/add/remove/force - -# Add or remove newline after each ',' in the constructor member initialization. -# Related to nl_constr_colon, pos_constr_colon and pos_constr_comma. -nl_constr_init_args = ignore # ignore/add/remove/force - -# Add or remove newline before first element, after comma, and after last element in enum. -nl_enum_own_lines = ignore # ignore/add/remove/force - -# Add or remove newline between return type and function name in a function definition. -nl_func_type_name = remove # ignore/add/remove/force - -# Add or remove newline between return type and function name inside a class {} -# Uses nl_func_type_name or nl_func_proto_type_name if set to ignore. -nl_func_type_name_class = remove # ignore/add/remove/force - -# Add or remove newline between class specification and '::' in 'void A::f() { }' -# Only appears in separate member implementation (does not appear with in-line implmementation). -nl_func_class_scope = ignore # ignore/add/remove/force - -# Add or remove newline between function scope and name -# Controls the newline after '::' in 'void A::f() { }'. -nl_func_scope_name = remove # ignore/add/remove/force - -# Add or remove newline between return type and function name in a prototype. -nl_func_proto_type_name = remove # ignore/add/remove/force - -# Add or remove newline between a function name and the opening '(' in the declaration. -nl_func_paren = remove # ignore/add/remove/force - -# Overrides nl_func_paren for functions with no parameters. -nl_func_paren_empty = ignore # ignore/add/remove/force - -# Add or remove newline between a function name and the opening '(' in the definition. -nl_func_def_paren = remove # ignore/add/remove/force - -# Overrides nl_func_def_paren for functions with no parameters. -nl_func_def_paren_empty = ignore # ignore/add/remove/force - -# Add or remove newline between a function name and the opening '(' in the call -nl_func_call_paren = ignore # ignore/add/remove/force - -# Overrides nl_func_call_paren for functions with no parameters. -nl_func_call_paren_empty = ignore # ignore/add/remove/force - -# Add or remove newline after '(' in a function declaration. -nl_func_decl_start = remove # ignore/add/remove/force - -# Add or remove newline after '(' in a function definition. -nl_func_def_start = remove # ignore/add/remove/force - -# Overrides nl_func_decl_start when there is only one parameter. -nl_func_decl_start_single = ignore # ignore/add/remove/force - -# Overrides nl_func_def_start when there is only one parameter. -nl_func_def_start_single = ignore # ignore/add/remove/force - -# Whether to add newline after '(' in a function declaration if '(' and ')' are in different lines. -nl_func_decl_start_multi_line = false # false/true - -# Whether to add newline after '(' in a function definition if '(' and ')' are in different lines. -nl_func_def_start_multi_line = false # false/true - -# Add or remove newline after each ',' in a function declaration. -nl_func_decl_args = remove # ignore/add/remove/force - -# Add or remove newline after each ',' in a function definition. -nl_func_def_args = remove # ignore/add/remove/force - -# Whether to add newline after each ',' in a function declaration if '(' and ')' are in different lines. -nl_func_decl_args_multi_line = false # false/true - -# Whether to add newline after each ',' in a function definition if '(' and ')' are in different lines. -nl_func_def_args_multi_line = false # false/true - -# Add or remove newline before the ')' in a function declaration. -nl_func_decl_end = remove # ignore/add/remove/force - -# Add or remove newline before the ')' in a function definition. -nl_func_def_end = remove # ignore/add/remove/force - -# Overrides nl_func_decl_end when there is only one parameter. -nl_func_decl_end_single = ignore # ignore/add/remove/force - -# Overrides nl_func_def_end when there is only one parameter. -nl_func_def_end_single = ignore # ignore/add/remove/force - -# Whether to add newline before ')' in a function declaration if '(' and ')' are in different lines. -nl_func_decl_end_multi_line = false # false/true - -# Whether to add newline before ')' in a function definition if '(' and ')' are in different lines. -nl_func_def_end_multi_line = false # false/true - -# Add or remove newline between '()' in a function declaration. -nl_func_decl_empty = remove # ignore/add/remove/force - -# Add or remove newline between '()' in a function definition. -nl_func_def_empty = remove # ignore/add/remove/force - -# Add or remove newline between '()' in a function call. -nl_func_call_empty = ignore # ignore/add/remove/force - -# Whether to add newline after '(' in a function call if '(' and ')' are in different lines. -nl_func_call_start_multi_line = false # false/true - -# Whether to add newline after each ',' in a function call if '(' and ')' are in different lines. -nl_func_call_args_multi_line = false # false/true - -# Whether to add newline before ')' in a function call if '(' and ')' are in different lines. -nl_func_call_end_multi_line = false # false/true - -# Whether to put each OC message parameter on a separate line -# See nl_oc_msg_leave_one_liner. -nl_oc_msg_args = false # false/true - -# Add or remove newline between function signature and '{'. -nl_fdef_brace = remove # ignore/add/remove/force - -# Add or remove newline between C++11 lambda signature and '{'. -nl_cpp_ldef_brace = remove # ignore/add/remove/force - -# Add or remove a newline between the return keyword and return expression. -nl_return_expr = remove # ignore/add/remove/force - -# Whether to put a newline after semicolons, except in 'for' statements. -nl_after_semicolon = true # false/true - -# Java: Control the newline between the ')' and '{{' of the double brace initializer. -nl_paren_dbrace_open = ignore # ignore/add/remove/force - -# Whether to put a newline after the type in an unnamed temporary direct-list-initialization. -nl_type_brace_init_lst = ignore # ignore/add/remove/force - -# Whether to put a newline after open brace in an unnamed temporary direct-list-initialization. -nl_type_brace_init_lst_open = ignore # ignore/add/remove/force - -# Whether to put a newline before close brace in an unnamed temporary direct-list-initialization. -nl_type_brace_init_lst_close = ignore # ignore/add/remove/force - -# Whether to put a newline after brace open. -# This also adds a newline before the matching brace close. -nl_after_brace_open = true # false/true - -# If nl_after_brace_open and nl_after_brace_open_cmt are True, a newline is -# placed between the open brace and a trailing single-line comment. -nl_after_brace_open_cmt = true # false/true - -# Whether to put a newline after a virtual brace open with a non-empty body. -# These occur in un-braced if/while/do/for statement bodies. -nl_after_vbrace_open = false # false/true - -# Whether to put a newline after a virtual brace open with an empty body. -# These occur in un-braced if/while/do/for statement bodies. -nl_after_vbrace_open_empty = false # false/true - -# Whether to put a newline after a brace close. -# Does not apply if followed by a necessary ';'. -nl_after_brace_close = false # false/true - -# Whether to put a newline after a virtual brace close. -# Would add a newline before return in: 'if (foo) a++; return;'. -nl_after_vbrace_close = false # false/true - -# Control the newline between the close brace and 'b' in: 'struct { int a; } b;' -# Affects enums, unions and structures. If set to ignore, uses nl_after_brace_close. -nl_brace_struct_var = ignore # ignore/add/remove/force - -# Whether to alter newlines in '#define' macros. -nl_define_macro = false # false/true - -# Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and '#endif'. Does not affect top-level #ifdefs. -nl_squeeze_ifdef = false # false/true - -# Makes the nl_squeeze_ifdef option affect the top-level #ifdefs as well. -nl_squeeze_ifdef_top_level = false # false/true - -# Add or remove blank line before 'if'. -nl_before_if = force # ignore/add/remove/force - -# Add or remove blank line after 'if' statement. -# Add/Force work only if the next token is not a closing brace. -nl_after_if = force # ignore/add/remove/force - -# Add or remove blank line before 'for'. -nl_before_for = force # ignore/add/remove/force - -# Add or remove blank line after 'for' statement. -nl_after_for = force # ignore/add/remove/force - -# Add or remove blank line before 'while'. -nl_before_while = force # ignore/add/remove/force - -# Add or remove blank line after 'while' statement. -nl_after_while = force # ignore/add/remove/force - -# Add or remove blank line before 'switch'. -nl_before_switch = force # ignore/add/remove/force - -# Add or remove blank line after 'switch' statement. -nl_after_switch = force # ignore/add/remove/force - -# Add or remove blank line before 'synchronized'. -nl_before_synchronized = ignore # ignore/add/remove/force - -# Add or remove blank line after 'synchronized' statement. -nl_after_synchronized = ignore # ignore/add/remove/force - -# Add or remove blank line before 'do'. -nl_before_do = force # ignore/add/remove/force - -# Add or remove blank line after 'do/while' statement. -nl_after_do = force # ignore/add/remove/force - -# Whether to double-space commented-entries in struct/union/enum. -nl_ds_struct_enum_cmt = false # false/true - -# force nl before } of a struct/union/enum -# (lower priority than 'eat_blanks_before_close_brace'). -nl_ds_struct_enum_close_brace = false # false/true - -# Add or remove blank line before 'func_class_def'. -nl_before_func_class_def = 0 # unsigned number - -# Add or remove blank line before 'func_class_proto'. -nl_before_func_class_proto = 0 # unsigned number - -# Add or remove a newline before/after a class colon, -# (tied to pos_class_colon). -nl_class_colon = force # ignore/add/remove/force - -# Add or remove a newline around a class constructor colon. -# Related to nl_constr_init_args, pos_constr_colon and pos_constr_comma. -nl_constr_colon = ignore # ignore/add/remove/force - -# Change simple unbraced if statements into a one-liner -# 'if(b)\n i++;' => 'if(b) i++;'. -nl_create_if_one_liner = false # false/true - -# Change simple unbraced for statements into a one-liner -# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'. -nl_create_for_one_liner = false # false/true - -# Change simple unbraced while statements into a one-liner -# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'. -nl_create_while_one_liner = false # false/true - -# Change a one-liner if statement into simple unbraced if -# 'if(b) i++;' => 'if(b)\n i++;'. -nl_split_if_one_liner = false # false/true - -# Change a one-liner for statement into simple unbraced for -# 'for (i=0;<5;i++) foo(i);' => 'for (i=0;<5;i++)\n foo(i);'. -nl_split_for_one_liner = true # false/true - -# Change a one-liner while statement into simple unbraced while -# 'while (i<5) foo(i++);' => 'while (i<5)\n foo(i++);'. -nl_split_while_one_liner = true # false/true - -# -# Blank line options -# - -# The maximum consecutive newlines (3 = 2 blank lines). -nl_max = 2 # unsigned number - -# The maximum consecutive newlines in function. -nl_max_blank_in_func = 0 # unsigned number - -# The number of newlines after a function prototype, if followed by another function prototype. -nl_after_func_proto = 2 # unsigned number - -# The number of newlines after a function prototype, if not followed by another function prototype. -nl_after_func_proto_group = 0 # unsigned number - -# The number of newlines after a function class prototype, if followed by another function class prototype. -nl_after_func_class_proto = 0 # unsigned number - -# The number of newlines after a function class prototype, if not followed by another function class prototype. -nl_after_func_class_proto_group = 0 # unsigned number - -# The number of newlines before a multi-line function def body. -nl_before_func_body_def = 0 # unsigned number - -# The number of newlines before a multi-line function prototype body. -nl_before_func_body_proto = 0 # unsigned number - -# The number of newlines after '}' of a multi-line function body. -nl_after_func_body = 2 # unsigned number - -# The number of newlines after '}' of a multi-line function body in a class declaration. -nl_after_func_body_class = 2 # unsigned number - -# The number of newlines after '}' of a single line function body. -nl_after_func_body_one_liner = 2 # unsigned number - -# The minimum number of newlines before a multi-line comment. -# Doesn't apply if after a brace open or another multi-line comment. -nl_before_block_comment = 2 # unsigned number - -# The minimum number of newlines before a single-line C comment. -# Doesn't apply if after a brace open or other single-line C comments. -nl_before_c_comment = 2 # unsigned number - -# The minimum number of newlines before a CPP comment. -# Doesn't apply if after a brace open or other CPP comments. -nl_before_cpp_comment = 2 # unsigned number - -# Whether to force a newline after a multi-line comment. -nl_after_multiline_comment = false # false/true - -# Whether to force a newline after a label's colon. -nl_after_label_colon = false # false/true - -# The number of newlines after '}' or ';' of a struct/enum/union definition. -nl_after_struct = 2 # unsigned number - -# The number of newlines before a class definition. -nl_before_class = 0 # unsigned number - -# The number of newlines after '}' or ';' of a class definition. -nl_after_class = 2 # unsigned number - -# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. -# Will not change the newline count if after a brace open. -# 0 = No change. -nl_before_access_spec = 2 # unsigned number - -# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:' or 'slots:' label. -# 0 = No change. -# Overrides 'nl_typedef_blk_start' and 'nl_var_def_blk_start'. -nl_after_access_spec = 1 # unsigned number - -# The number of newlines between a function def and the function comment. -# 0 = No change. -nl_comment_func_def = 0 # unsigned number - -# The number of newlines after a try-catch-finally block that isn't followed by a brace close. -# 0 = No change. -nl_after_try_catch_finally = 2 # unsigned number - -# The number of newlines before and after a property, indexer or event decl. -# 0 = No change. -nl_around_cs_property = 0 # unsigned number - -# The number of newlines between the get/set/add/remove handlers in C#. -# 0 = No change. -nl_between_get_set = 0 # unsigned number - -# Add or remove newline between C# property and the '{'. -nl_property_brace = ignore # ignore/add/remove/force - -# Whether to remove blank lines after '{'. -eat_blanks_after_open_brace = true # false/true - -# Whether to remove blank lines before '}'. -eat_blanks_before_close_brace = true # false/true - -# How aggressively to remove extra newlines not in preproc. -# 0: No change -# 1: Remove most newlines not handled by other config -# 2: Remove all newlines and reformat completely by config -nl_remove_extra_newlines = 0 # unsigned number - -# Whether to put a blank line before 'return' statements, unless after an open brace. -nl_before_return = false # false/true - -# Whether to put a blank line after 'return' statements, unless followed by a close brace. -nl_after_return = false # false/true - -# Whether to put a newline after a Java annotation statement. -# Only affects annotations that are after a newline. -nl_after_annotation = ignore # ignore/add/remove/force - -# Controls the newline between two annotations. -nl_between_annotation = ignore # ignore/add/remove/force - -# -# Positioning options -# - -# The position of arithmetic operators in wrapped expressions. -pos_arith = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of assignment in wrapped expressions. -# Do not affect '=' followed by '{'. -pos_assign = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of boolean operators in wrapped expressions. -pos_bool = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of comparison operators in wrapped expressions. -pos_compare = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of conditional (b ? t : f) operators in wrapped expressions. -pos_conditional = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in wrapped expressions. -pos_comma = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in enum entries. -pos_enum_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in the base class list if there are more than one line, -# (tied to nl_class_init_args). -pos_class_comma = lead_force # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in the constructor initialization list. -# Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon. -pos_constr_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of trailing/leading class colon, between class and base class list -# (tied to nl_class_colon). -pos_class_colon = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of colons between constructor and member initialization, -# (tied to nl_constr_colon). -# Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma. -pos_constr_colon = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# -# Line Splitting options -# - -# Try to limit code width to N number of columns -code_width = 120 # unsigned number - -# Whether to fully split long 'for' statements at semi-colons. -ls_for_split_full = true # false/true - -# Whether to fully split long function protos/calls at commas. -ls_func_split_full = false # false/true - -# Whether to split lines as close to code_width as possible and ignore some groupings. -ls_code_width = false # false/true - -# -# Code alignment (not left column spaces/tabs) -# - -# Whether to keep non-indenting tabs. -align_keep_tabs = false # false/true - -# Whether to use tabs for aligning. -align_with_tabs = false # false/true - -# Whether to bump out to the next tab when aligning. -align_on_tabstop = false # false/true - -# Whether to right-align numbers. -align_number_right = false # false/true - -# Whether to keep whitespace not required for alignment. -align_keep_extra_space = false # false/true - -# Align variable definitions in prototypes and functions. -align_func_params = true # false/true - -# The span for aligning parameter definitions in function on parameter name (0=don't align). -align_func_params_span = 0 # unsigned number - -# The threshold for aligning function parameter definitions (0=no limit). -align_func_params_thresh = 0 # unsigned number - -# The gap for aligning function parameter definitions. -align_func_params_gap = 0 # unsigned number - -# Align parameters in single-line functions that have the same name. -# The function names must already be aligned with each other. -align_same_func_call_params = false # false/true - -# The span for aligning variable definitions (0=don't align) -align_var_def_span = 0 # unsigned number - -# How to align the star in variable definitions. -# 0=Part of the type 'void * foo;' -# 1=Part of the variable 'void *foo;' -# 2=Dangling 'void *foo;' -align_var_def_star_style = 0 # unsigned number - -# How to align the '&' in variable definitions. -# 0=Part of the type -# 1=Part of the variable -# 2=Dangling -align_var_def_amp_style = 0 # unsigned number - -# The threshold for aligning variable definitions (0=no limit) -align_var_def_thresh = 0 # unsigned number - -# The gap for aligning variable definitions. -align_var_def_gap = 0 # unsigned number - -# Whether to align the colon in struct bit fields. -align_var_def_colon = false # false/true - -# align variable defs gap for bit colons. -align_var_def_colon_gap = 0 # unsigned number - -# Whether to align any attribute after the variable name. -align_var_def_attribute = true # false/true - -# Whether to align inline struct/enum/union variable definitions. -align_var_def_inline = false # false/true - -# The span for aligning on '=' in assignments (0=don't align) -align_assign_span = 0 # unsigned number - -# The threshold for aligning on '=' in assignments (0=no limit) -align_assign_thresh = 0 # unsigned number - -# The span for aligning on '=' in enums (0=don't align) -align_enum_equ_span = 0 # unsigned number - -# The threshold for aligning on '=' in enums (0=no limit) -align_enum_equ_thresh = 0 # unsigned number - -# The span for aligning class (0=don't align) -align_var_class_span = 0 # unsigned number - -# The threshold for aligning class member definitions (0=no limit). -align_var_class_thresh = 0 # unsigned number - -# The gap for aligning class member definitions. -align_var_class_gap = 0 # unsigned number - -# The span for aligning struct/union (0=don't align) -align_var_struct_span = 20 # unsigned number - -# The threshold for aligning struct/union member definitions (0=no limit) -align_var_struct_thresh = 0 # unsigned number - -# The gap for aligning struct/union member definitions. -align_var_struct_gap = 1 # unsigned number - -# The span for aligning struct initializer values (0=don't align) -align_struct_init_span = 0 # unsigned number - -# The minimum space between the type and the synonym of a typedef. -align_typedef_gap = 0 # unsigned number - -# The span for aligning single-line typedefs (0=don't align). -align_typedef_span = 0 # unsigned number - -# How to align typedef'd functions with other typedefs -# 0: Don't mix them at all -# 1: align the open paren with the types -# 2: align the function type name with the other type names -align_typedef_func = 0 # unsigned number - -# Controls the positioning of the '*' in typedefs. Just try it. -# 0: Align on typedef type, ignore '*' -# 1: The '*' is part of type name: typedef int *pint; -# 2: The '*' is part of the type, but dangling: typedef int *pint; -align_typedef_star_style = 0 # unsigned number - -# Controls the positioning of the '&' in typedefs. Just try it. -# 0: Align on typedef type, ignore '&' -# 1: The '&' is part of type name: typedef int &pint; -# 2: The '&' is part of the type, but dangling: typedef int &pint; -align_typedef_amp_style = 0 # unsigned number - -# The span for aligning comments that end lines (0=don't align) -align_right_cmt_span = 2 # unsigned number - -# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment. -align_right_cmt_mix = false # false/true - -# If a trailing comment is more than this number of columns away from the text it follows, -# it will qualify for being aligned. This has to be > 0 to do anything. -align_right_cmt_gap = 1 # unsigned number - -# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore) -align_right_cmt_at_col = 0 # unsigned number - -# The span for aligning function prototypes (0=don't align). -align_func_proto_span = 0 # unsigned number - -# Minimum gap between the return type and the function name. -align_func_proto_gap = 0 # unsigned number - -# Align function protos on the 'operator' keyword instead of what follows. -align_on_operator = false # false/true - -# Whether to mix aligning prototype and variable declarations. -# If True, align_var_def_XXX options are used instead of align_func_proto_XXX options. -align_mix_var_proto = false # false/true - -# Align single-line functions with function prototypes, uses align_func_proto_span. -align_single_line_func = false # false/true - -# Aligning the open brace of single-line functions. -# Requires align_single_line_func=True, uses align_func_proto_span. -align_single_line_brace = false # false/true - -# Gap for align_single_line_brace. -align_single_line_brace_gap = 0 # unsigned number - -# The span for aligning ObjC msg spec (0=don't align) -align_oc_msg_spec_span = 0 # unsigned number - -# Whether to align macros wrapped with a backslash and a newline. -# This will not work right if the macro contains a multi-line comment. -align_nl_cont = true # false/true - -# # Align macro functions and variables together. -align_pp_define_together = false # false/true - -# The minimum space between label and value of a preprocessor define. -align_pp_define_gap = 0 # unsigned number - -# The span for aligning on '#define' bodies (0=don't align, other=number of lines including comments between blocks) -align_pp_define_span = 0 # unsigned number - -# Align lines that start with '<<' with previous '<<'. Default=True. -align_left_shift = false # false/true - -# Align text after asm volatile () colons. -align_asm_colon = false # false/true - -# Span for aligning parameters in an Obj-C message call on the ':' (0=don't align) -align_oc_msg_colon_span = 0 # unsigned number - -# If True, always align with the first parameter, even if it is too short. -align_oc_msg_colon_first = false # false/true - -# Aligning parameters in an Obj-C '+' or '-' declaration on the ':'. -align_oc_decl_colon = false # false/true - -# -# Comment modifications -# - -# Try to wrap comments at cmt_width columns -cmt_width = 0 # unsigned number - -# Set the comment reflow mode (Default=0) -# 0: no reflowing (apart from the line wrapping due to cmt_width) -# 1: no touching at all -# 2: full reflow -cmt_reflow_mode = 1 # unsigned number - -# Whether to convert all tabs to spaces in comments. Default is to leave tabs inside comments alone, unless used for indenting. -cmt_convert_tab_to_spaces = false # false/true - -# If False, disable all multi-line comment changes, including cmt_width. keyword substitution and leading chars. -# Default=True. -cmt_indent_multi = true # false/true - -# Whether to group c-comments that look like they are in a block. -cmt_c_group = false # false/true - -# Whether to put an empty '/*' on the first line of the combined c-comment. -cmt_c_nl_start = false # false/true - -# Whether to put a newline before the closing '*/' of the combined c-comment. -cmt_c_nl_end = false # false/true - -# Whether to group cpp-comments that look like they are in a block. -cmt_cpp_group = false # false/true - -# Whether to put an empty '/*' on the first line of the combined cpp-comment. -cmt_cpp_nl_start = false # false/true - -# Whether to put a newline before the closing '*/' of the combined cpp-comment. -cmt_cpp_nl_end = false # false/true - -# Whether to change cpp-comments into c-comments. -cmt_cpp_to_c = false # false/true - -# Whether to put a star on subsequent comment lines. -cmt_star_cont = true # false/true - -# The number of spaces to insert at the start of subsequent comment lines. -cmt_sp_before_star_cont = 0 # unsigned number - -# The number of spaces to insert after the star on subsequent comment lines. -cmt_sp_after_star_cont = 0 # number - -# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of -# the comment are the same length. Default=True. -cmt_multi_check_last = false # false/true - -# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of -# the comment are the same length AND if the length is bigger as the first_len minimum. Default=4 -cmt_multi_first_len_minimum = 4 # unsigned number - -# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment. -# Will substitute $(filename) with the current file's name. -cmt_insert_file_header = "" # string - -# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment. -# Will substitute $(filename) with the current file's name. -cmt_insert_file_footer = "" # string - -# The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment. -# Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff. -# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }. -cmt_insert_func_header = "" # string - -# The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment. -# Will substitute $(class) with the class name. -cmt_insert_class_header = "" # string - -# The filename that contains text to insert before a Obj-C message specification if the method isn't preceded with a C/C++ comment. -# Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff. -cmt_insert_oc_msg_header = "" # string - -# If a preprocessor is encountered when stepping backwards from a function name, then -# this option decides whether the comment should be inserted. -# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header. -cmt_insert_before_preproc = false # false/true - -# If a function is declared inline to a class definition, then -# this option decides whether the comment should be inserted. -# Affects cmt_insert_func_header. -cmt_insert_before_inlines = true # false/true - -# If the function is a constructor/destructor, then -# this option decides whether the comment should be inserted. -# Affects cmt_insert_func_header. -cmt_insert_before_ctor_dtor = false # false/true - -# -# Code modifying options (non-whitespace) -# - -# Add or remove braces on single-line 'do' statement. -mod_full_brace_do = force # ignore/add/remove/force - -# Add or remove braces on single-line 'for' statement. -mod_full_brace_for = ignore # ignore/add/remove/force - -# Add or remove braces on single-line function definitions. (Pawn). -mod_full_brace_function = force # ignore/add/remove/force - -# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'. -mod_full_brace_if = force # ignore/add/remove/force - -# Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if. -# If any must be braced, they are all braced. If all can be unbraced, then the braces are removed. -mod_full_brace_if_chain = false # false/true - -# Make all if/elseif/else statements with at least one 'else' or 'else if' fully braced. -# If mod_full_brace_if_chain is used together with this option, all if-else chains will get braces, -# and simple 'if' statements will lose them (if possible). -mod_full_brace_if_chain_only = false # false/true - -# Don't remove braces around statements that span N newlines -mod_full_brace_nl = 0 # unsigned number - -# Blocks removal of braces if the parenthesis of if/for/while/.. span multiple lines. -mod_full_brace_nl_block_rem_mlcond = false # false/true - -# Add or remove braces on single-line 'while' statement. -mod_full_brace_while = ignore # ignore/add/remove/force - -# Add or remove braces on single-line 'using ()' statement. -mod_full_brace_using = force # ignore/add/remove/force - -# Add or remove unnecessary paren on 'return' statement. -mod_paren_on_return = ignore # ignore/add/remove/force - -# Whether to change optional semicolons to real semicolons. -mod_pawn_semicolon = false # false/true - -# Add parens on 'while' and 'if' statement around bools. -mod_full_paren_if_bool = true # false/true - -# Whether to remove superfluous semicolons. -mod_remove_extra_semicolon = false # false/true - -# If a function body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_function_closebrace_comment = 0 # unsigned number - -# If a namespace body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_namespace_closebrace_comment = 0 # unsigned number - -# If a class body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_class_closebrace_comment = 0 # unsigned number - -# If a switch body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_switch_closebrace_comment = 0 # unsigned number - -# If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after -# the #endif, a comment will be added. -mod_add_long_ifdef_endif_comment = 0 # unsigned number - -# If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after -# the #else, a comment will be added. -mod_add_long_ifdef_else_comment = 0 # unsigned number - -# If True, will sort consecutive single-line 'import' statements [Java, D]. -mod_sort_import = false # false/true - -# If True, will sort consecutive single-line 'using' statements [C#]. -mod_sort_using = false # false/true - -# If True, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C] -# This is generally a bad idea, as it may break your code. -mod_sort_include = false # false/true - -# If True, it will move a 'break' that appears after a fully braced 'case' before the close brace. -mod_move_case_break = true # false/true - -# Will add or remove the braces around a fully braced case statement. -# Will only remove the braces if there are no variable declarations in the block. -mod_case_brace = ignore # ignore/add/remove/force - -# If True, it will remove a void 'return;' that appears as the last statement in a function. -mod_remove_empty_return = false # false/true - -# If True, it will organize the properties (Obj-C). -mod_sort_oc_properties = false # false/true - -# Determines weight of class property modifier (Obj-C). -mod_sort_oc_property_class_weight = 0 # number - -# Determines weight of atomic, nonatomic (Obj-C). -mod_sort_oc_property_thread_safe_weight = 0 # number - -# Determines weight of readwrite (Obj-C). -mod_sort_oc_property_readwrite_weight = 0 # number - -# Determines weight of reference type (retain, copy, assign, weak, strong) (Obj-C). -mod_sort_oc_property_reference_weight = 0 # number - -# Determines weight of getter type (getter=) (Obj-C). -mod_sort_oc_property_getter_weight = 0 # number - -# Determines weight of setter type (setter=) (Obj-C). -mod_sort_oc_property_setter_weight = 0 # number - -# Determines weight of nullability type (nullable, nonnull, null_unspecified, null_resettable) (Obj-C). -mod_sort_oc_property_nullability_weight = 0 # number - -# -# Preprocessor options -# - -# Control indent of preprocessors inside #if blocks at brace level 0 (file-level). -pp_indent = ignore # ignore/add/remove/force - -# Whether to indent #if/#else/#endif at the brace level (True) or from column 1 (False). -pp_indent_at_level = false # false/true - -# Specifies the number of columns to indent preprocessors per level at brace level 0 (file-level). -# If pp_indent_at_level=False, specifies the number of columns to indent preprocessors per level at brace level > 0 (function-level). -# Default=1. -pp_indent_count = 1 # unsigned number - -# Add or remove space after # based on pp_level of #if blocks. -pp_space = ignore # ignore/add/remove/force - -# Sets the number of spaces added with pp_space. -pp_space_count = 0 # unsigned number - -# The indent for #region and #endregion in C# and '#pragma region' in C/C++. -pp_indent_region = 0 # number - -# Whether to indent the code between #region and #endregion. -pp_region_indent_code = false # false/true - -# If pp_indent_at_level=True, sets the indent for #if, #else and #endif when not at file-level. -# 0: indent preprocessors using output_tab_size. -# >0: column at which all preprocessors will be indented. -pp_indent_if = 0 # number - -# Control whether to indent the code between #if, #else and #endif. -pp_if_indent_code = false # false/true - -# Whether to indent '#define' at the brace level (True) or from column 1 (false). -pp_define_at_level = false # false/true - -# Whether to ignore the '#define' body while formatting. -pp_ignore_define_body = false # false/true - -# Whether to indent case statements between #if, #else, and #endif. -# Only applies to the indent of the preprocesser that the case statements directly inside of. -pp_indent_case = true # false/true - -# Whether to indent whole function definitions between #if, #else, and #endif. -# Only applies to the indent of the preprocesser that the function definition is directly inside of. -pp_indent_func_def = true # false/true - -# Whether to indent extern C blocks between #if, #else, and #endif. -# Only applies to the indent of the preprocesser that the extern block is directly inside of. -pp_indent_extern = true # false/true - -# Whether to indent braces directly inside #if, #else, and #endif. -# Only applies to the indent of the preprocesser that the braces are directly inside of. -pp_indent_brace = true # false/true - -# -# Sort includes options -# - -# The regex for include category with priority 0. -include_category_0 = "" # string - -# The regex for include category with priority 1. -include_category_1 = "" # string - -# The regex for include category with priority 2. -include_category_2 = "" # string - -# -# Use or Do not Use options -# - -# True: indent_func_call_param will be used (default) -# False: indent_func_call_param will NOT be used. -use_indent_func_call_param = true # false/true - -# The value of the indentation for a continuation line is calculate differently if the line is: -# a declaration :your case with QString fileName ... -# an assignment :your case with pSettings = new QSettings( ... -# At the second case the option value might be used twice: -# at the assignment -# at the function call (if present) -# To prevent the double use of the option value, use this option with the value 'True'. -# True: indent_continue will be used only once -# False: indent_continue will be used every time (default). -use_indent_continue_only_once = false # false/true - -# SIGNAL/SLOT Qt macros have special formatting options. See options_for_QT.cpp for details. -# Default=True. -use_options_overriding_for_qt_macros = true # false/true - -# -# Warn levels - 1: error, 2: warning (default), 3: note -# - -# Warning is given if doing tab-to-\t replacement and we have found one in a C# verbatim string literal. -warn_level_tabs_found_in_verbatim_string_literals = 2 # unsigned number - -# Meaning of the settings: -# Ignore - do not do any changes -# Add - makes sure there is 1 or more space/brace/newline/etc -# Force - makes sure there is exactly 1 space/brace/newline/etc, -# behaves like Add in some contexts -# Remove - removes space/brace/newline/etc -# -# -# - Token(s) can be treated as specific type(s) with the 'set' option: -# `set tokenType tokenString [tokenString...]` -# -# Example: -# `set BOOL __AND__ __OR__` -# -# tokenTypes are defined in src/token_enum.h, use them without the -# 'CT_' prefix: 'CT_BOOL' -> 'BOOL' -# -# -# - Token(s) can be treated as type(s) with the 'type' option. -# `type tokenString [tokenString...]` -# -# Example: -# `type int c_uint_8 Rectangle` -# -# This can also be achieved with `set TYPE int c_uint_8 Rectangle` -# -# -# To embed whitespace in tokenStrings use the '\' escape character, or quote -# the tokenStrings. These quotes are supported: "'` -# -# -# - Support for the auto detection of languages through the file ending can be -# added using the 'file_ext' command. -# `file_ext langType langString [langString..]` -# -# Example: -# `file_ext CPP .ch .cxx .cpp.in` -# -# langTypes are defined in uncrusify_types.h in the lang_flag_e enum, use -# them without the 'LANG_' prefix: 'LANG_CPP' -> 'CPP' -# -# -# - Custom macro-based indentation can be set up using 'macro-open', -# 'macro-else' and 'macro-close'. -# `(macro-open | macro-else | macro-close) tokenString` -# -# Example: -# `macro-open BEGIN_TEMPLATE_MESSAGE_MAP` -# `macro-open BEGIN_MESSAGE_MAP` -# `macro-close END_MESSAGE_MAP` -# -## option(s) with 'not default' value: 204 -# From 127c0e5c277fb27446594ee24c89ee98a624bdab Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:30:05 -0300 Subject: [PATCH 17/95] =?UTF-8?q?=E2=9C=A8=20Add=20linter?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cmake/linter.cmake | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 cmake/linter.cmake diff --git a/cmake/linter.cmake b/cmake/linter.cmake new file mode 100644 index 0000000..1cf1233 --- /dev/null +++ b/cmake/linter.cmake @@ -0,0 +1,24 @@ +# Name: linter.cmake +# ThundeRatz Robotics Team +# Brief: This file checks if linter was enabled and sets the proper flags +# 03/2025 + +############################################################################### +## Linter Check +############################################################################### + +if(LINTER_MODE STREQUAL "ON") + set(CMAKE_CXX_CLANG_TIDY "clang-tidy") + add_compile_options(-fms-extensions) + message(STATUS "Enabling clang-tidy") + +elseif(LINTER_MODE STREQUAL "FIX") + set(CMAKE_CXX_CLANG_TIDY "clang-tidy;--fix") + add_compile_options(-fms-extensions) + message(STATUS "Enabling clang-tidy with fix") + +else() + set(LINTER_MODE "OFF") + message(STATUS "Linter is disabled") + +endif() From e969f47a3b570afde88877184b3fee14580df3fb Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:30:36 -0300 Subject: [PATCH 18/95] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Refactor=20structure?= =?UTF-8?q?=20to=20new=20cmake?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 203 +++++++++------------------------- cmake/config_validation.cmake | 80 ++++++++------ cmake/targets.cmake | 2 +- cmake/utilities.cmake | 72 ++++++++++++ cmake/workspace.cmake | 22 ---- {inc => include}/mcu.hpp | 29 +++-- src/mcu.cpp | 12 +- tests/bin/test_main.cpp | 15 --- tests/inc/test_core.hpp | 25 ----- tests/src/test_core.cpp | 21 ---- tests/src/test_main.cpp | 13 +++ 11 files changed, 204 insertions(+), 290 deletions(-) create mode 100644 cmake/utilities.cmake delete mode 100644 cmake/workspace.cmake rename {inc => include}/mcu.hpp (53%) delete mode 100644 tests/bin/test_main.cpp delete mode 100644 tests/inc/test_core.hpp delete mode 100644 tests/src/test_core.cpp create mode 100644 tests/src/test_main.cpp diff --git a/CMakeLists.txt b/CMakeLists.txt index c6b5af1..2fa0c64 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,179 +2,104 @@ # ThundeRatz Robotics Team # Brief: This file contains the configuration of the CMake project ## and all the files that you should edit to configure your project -# 04/2023 +# 03/2025 -cmake_minimum_required(VERSION 3.16) +cmake_minimum_required(VERSION 3.22) ############################################################################### ## CMake Configuration ############################################################################### -set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_SOURCE_DIR}/lib/stm32-cmake/cmake/stm32_gcc.cmake) -set(CMAKE_C_STANDARD 11) +set(CMAKE_C_STANDARD 17) +set(CMAKE_CXX_STANDARD 20) -## Options: -# Release: high optimization level, no debug info, code or asserts. -# Debug: No optimization, asserts enabled, [custom debug (output) code enabled], debug info included in executable (so you can step through the code with a debugger and have address to source-file:line-number translation). -# RelWithDebInfo: optimized, with debug info, but no debug (output) code or asserts. -# MinSizeRel: same as Release but optimizing for size rather than speed. +set(CMAKE_C_STANDARD_REQUIRED ON) +set(CMAKE_C_EXTENSIONS ON) + +set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE) + +# Debug, Release, RelWithDebInfo and MinSizeRel # @see: https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html set(CMAKE_BUILD_TYPE Debug) -# Generate compile_commands.json for compatibility with LSPs -# @see: https://cmake.org/cmake/help/latest/variable/CMAKE_EXPORT_COMPILE_COMMANDS.html -set(CMAKE_EXPORT_COMPILE_COMMANDS ON) +############################################################################### +## Project Configuration +############################################################################### -# Cube file name without .ioc extension -project(stm32_project_template C CXX ASM) +set(CMAKE_PROJECT_NAME stm32_project_template) # Set the board version to an empty string if your board doesn't have a version set(BOARD_VERSION "") -# Device Configuration -set(DEVICE_CORTEX F3) -set(DEVICE_FAMILY STM32F3xx) -set(DEVICE_TYPE STM32F303xx) -set(DEVICE_DEF STM32F303xE) -set(DEVICE STM32F303RE) - -# DEVICE_FAMILY_COMPACT is the same as DEVICE_FAMILY but without the STM32 prefix -string(REPLACE "STM32" "" DEVICE_FAMILY_COMPACT ${DEVICE}) - if(BOARD_VERSION STREQUAL "") - set(PROJECT_RELEASE ${PROJECT_NAME}) + set(PROJECT_RELEASE ${CMAKE_PROJECT_NAME}) else() - set(PROJECT_RELEASE ${PROJECT_NAME}_${BOARD_VERSION}) + set(PROJECT_RELEASE ${CMAKE_PROJECT_NAME}_${BOARD_VERSION}) endif() -set(TARGET_BOARD target_${PROJECT_RELEASE}) ############################################################################### ## Global compilation config ############################################################################### set(LAUNCH_JSON_PATH ${CMAKE_CURRENT_SOURCE_DIR}/.vscode/launch.json) -set(DEBUG_FILE_NAME ${PROJECT_NAME}) +set(DEBUG_FILE_NAME ${CMAKE_PROJECT_NAME}) include(cmake/config_validation.cmake) -include(cmake/workspace.cmake) -include(cmake/targets.cmake) - -find_package(CMSIS COMPONENTS ${DEVICE} REQUIRED) -find_package(HAL COMPONENTS STM32${DEVICE_CORTEX} REQUIRED) - -add_compile_options( - -Wall - -Wextra - -Wfatal-errors - -mthumb - -fdata-sections - -ffunction-sections - -fmessage-length=0 - -MMD - -MP -) - -add_compile_definitions(${DEVICE_DEF} USE_HAL_DRIVER) - -############################################################################### -## Project dependencies -############################################################################### - -set(DEPENDENCIES - m # math library - HAL::STM32::${DEVICE_CORTEX} +set(CMAKE_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/cube) +include(cube/cmake/gcc-arm-none-eabi.cmake) +set(CMAKE_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}) - HAL::STM32::${DEVICE_CORTEX}::ADCEx - HAL::STM32::${DEVICE_CORTEX}::DMA - HAL::STM32::${DEVICE_CORTEX}::GPIO - HAL::STM32::${DEVICE_CORTEX}::I2C - HAL::STM32::${DEVICE_CORTEX}::SPI - HAL::STM32::${DEVICE_CORTEX}::TIMEx - HAL::STM32::${DEVICE_CORTEX}::UARTEx - HAL::STM32::${DEVICE_CORTEX}::WWDG - - HAL::STM32::${DEVICE_CORTEX}::RCCEx - HAL::STM32::${DEVICE_CORTEX}::CORTEX - - CMSIS::STM32::${DEVICE_FAMILY_COMPACT} - STM32::NoSys -) +project(${CMAKE_PROJECT_NAME} C CXX ASM) -# Add libraries .c files here -set(LIB_SOURCES - # lib/lib_name/src/file1.c - # lib/lib_name/src/file2.c -) +include(cmake/targets.cmake) +include(cmake/utilities.cmake) +include(cmake/linter.cmake) -# Add libraries include directories here -set(LIB_INCLUDE_DIRECTORIES - # lib/lib_name/inc/ -) +add_subdirectory(cube/cmake/stm32cubemx) ############################################################################### -## Include directories +## CubeMX Configuration ############################################################################### -set(PROJECT_INCLUDE_DIRECTORIES - ./inc - ./cube/Inc -) +get_target_property(CUBE_INCLUDE_DIRECTORIES stm32cubemx INTERFACE_INCLUDE_DIRECTORIES) +get_target_property(CUBE_SOURCES stm32cubemx INTERFACE_SOURCES) +get_target_property(CUBE_COMPILE_DEFINITIONS stm32cubemx INTERFACE_COMPILE_DEFINITIONS) -set(TEST_INCLUDE_DIRECTORIES - ./tests/inc +# Remove warnings from Cube sources +set_source_files_properties( + ${CUBE_SOURCES} + PROPERTIES + COMPILE_FLAGS "-w" ) +add_compile_definitions(${CUBE_COMPILE_DEFINITIONS}) + ############################################################################### ## Input files ############################################################################### -file(GLOB_RECURSE PROJECT_SOURCES CONFIGURE_DEPENDS "src/*.cpp" "src/*.c") -file(GLOB_RECURSE PROJECT_HEADERS CONFIGURE_DEPENDS "inc/*.hpp" "inc/*.h") - -file(GLOB_RECURSE TESTS_SOURCES CONFIGURE_DEPENDS "tests/src/*.cpp" "tests/src/*.c") -file(GLOB_RECURSE TESTS_HEADERS CONFIGURE_DEPENDS "tests/inc/*.hpp" "tests/inc/*.h") -file(GLOB_RECURSE TESTS_BIN CONFIGURE_DEPENDS "tests/bin/*.cpp" "tests/bin/*.c") - -file(GLOB_RECURSE CUBE_SOURCES CONFIGURE_DEPENDS "cube/Src/*.c") +file(GLOB_RECURSE FORMAT_SOURCES CONFIGURE_DEPENDS "lib/*.cpp" "src/*.cpp" "config/*.cpp" "tests/*.cpp" "thunder_*/include/*.cpp*") +file(GLOB_RECURSE FORMAT_HEADERS CONFIGURE_DEPENDS "lib/*.hpp" "include/*.hpp" "config/*.hpp" "tests/*.hpp" "thunder_*/include/*.hpp*") -# Remove system_xxx.c file from CubeMX, as it is already included in CMSIS -string(TOLOWER ${DEVICE_FAMILY} DEVICE_FAMILY_LOWER) -list(REMOVE_ITEM CUBE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/cube/Src/system_${DEVICE_FAMILY_LOWER}.c) +targets_generate_format_target(FORMAT_SOURCES FORMAT_HEADERS) -# Add here the headers to be included in all files -set(FORCED_INCLUDE_HEADERS -) - -targets_generate_format_target(PROJECT_SOURCES PROJECT_HEADERS TESTS_SOURCES TESTS_HEADERS TESTS_BIN) +file(GLOB_RECURSE PROJECT_SOURCES CONFIGURE_DEPENDS "src/*.cpp") +file(GLOB_RECURSE PROJECT_TESTS CONFIGURE_DEPENDS "tests/src/**.cpp") +message(STATUS "Project tests: ${PROJECT_TESTS}") ############################################################################### ## Main executable target ############################################################################### add_executable(${PROJECT_NAME} - ${CUBE_SOURCES} ${PROJECT_SOURCES} - ${LIB_SOURCES} ) target_include_directories(${PROJECT_NAME} PUBLIC - ${PROJECT_INCLUDE_DIRECTORIES} - ${LIB_INCLUDE_DIRECTORIES} - ${CMSIS_INCLUDE_DIRS} - ${HAL_INCLUDE_DIRS} -) - -target_precompile_headers(${PROJECT_NAME} PUBLIC - ${FORCED_INCLUDE_HEADERS} -) - -target_link_libraries(${PROJECT_NAME} - ${DEPENDENCIES} -) - -target_link_options(${PROJECT_NAME} PUBLIC - --specs=nano.specs + ${CUBE_INCLUDE_DIRECTORIES} + include + config ) stm32_print_size_of_target(${PROJECT_NAME}) @@ -188,47 +113,27 @@ targets_generate_helpme_target() ## Generate test executables ############################################################################### -# Since each test has its own main function, we don't need the main.cpp from the project -list(REMOVE_ITEM PROJECT_SOURCES - ${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c -) - -foreach(TEST_FILE ${TESTS_BIN}) +message(STATUS "Tests:") - # If TEST_FILE contains /dir1/dir2/file.cpp, TEST_NAME will be 'file' +foreach(TEST_FILE ${PROJECT_TESTS}) get_filename_component(TEST_NAME ${TEST_FILE} NAME_WLE) add_executable(${TEST_NAME} EXCLUDE_FROM_ALL ${TEST_FILE} - ${CUBE_SOURCES} - ${PROJECT_SOURCES} - ${TESTS_SOURCES} - ${LIB_SOURCES} + ${PROJECT_TESTS_SOURCES} ) target_include_directories(${TEST_NAME} PUBLIC - ${PROJECT_INCLUDE_DIRECTORIES} - ${LIB_INCLUDE_DIRECTORIES} - ${CMSIS_INCLUDE_DIRS} - ${HAL_INCLUDE_DIRS} - ${TEST_INCLUDE_DIRECTORIES} - ) - - target_precompile_headers(${TEST_NAME} PUBLIC - ${FORCED_INCLUDE_HEADERS} - ) - - target_link_libraries(${TEST_NAME} - ${DEPENDENCIES} - ) - - target_link_options(${TEST_NAME} PUBLIC - --specs=nano.specs + ${CUBE_INCLUDE_DIRECTORIES} + include + tests/include + config ) stm32_generate_hex_file(${TEST_NAME}) + message(STATUS "Test: ${TEST_NAME}") + targets_generate_vsfiles_target(${TEST_NAME}) targets_generate_flash_target(${TEST_NAME}) diff --git a/cmake/config_validation.cmake b/cmake/config_validation.cmake index 390dc5b..a7398c5 100644 --- a/cmake/config_validation.cmake +++ b/cmake/config_validation.cmake @@ -3,69 +3,79 @@ # Brief: This file contains the existence checks of the declared variables # 04/2023 -############################################################################### -## Auxiliary Sets -############################################################################### - -# This variable is used by the stm32-cmake lib to find the STM32CubeMX files -# @see: https://github.com/ObKo/stm32-cmake#configuration -set(STM32_CUBE_${DEVICE_CORTEX}_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cube) - -# This set contains all the variables that must be defined by the user -# It is used to check if all of them are properly defined -set(USER_INPUT_VARIABLES - DEVICE_CORTEX - DEVICE_FAMILY - DEVICE_TYPE - DEVICE_DEF - DEVICE_FAMILY_COMPACT - DEVICE - BOARD_VERSION - TARGET_BOARD -) - ############################################################################### ## Existence checks ############################################################################### -## Check if STM32CubeMX variables are properly defined +# Check if CMake build type is correctly configured +if(NOT (BUILD_TYPE STREQUAL "Release" OR BUILD_TYPE STREQUAL "Debug" OR + BUILD_TYPE STREQUAL "RelWithDebInfo" OR BUILD_TYPE STREQUAL "MinSizeRel")) + set(BUILD_TYPE "RelWithDebInfo") +endif() +set(CMAKE_BUILD_TYPE ${BUILD_TYPE}) +message(STATUS "Build type: " ${CMAKE_BUILD_TYPE}) + +# Check if STM32CubeMX variables are properly defined if(DEFINED ENV{CUBE_PATH}) message(STATUS "CUBE_PATH defined as $ENV{CUBE_PATH}") else() message(FATAL_ERROR "CUBE_PATH not defined") endif() -if(CMAKE_HOST_WIN32) - set(JAVA_EXE "$ENV{CUBE_PATH}\\STM32CubeMX.exe") - set(CUBE_JAR "$ENV{CUBE_PATH}\\jre\\bin\\java.exe") +# Set CubeMX and JLink executables +if(NOT "$ENV{WSL_DISTRO_NAME}" STREQUAL "") + set(CUBE_CMD "$ENV{CUBE_PATH}/STM32CubeMX.exe") set(JLINK_EXE JLink.exe) + message(STATUS "WSL detected") else() set(JAVA_EXE $ENV{CUBE_PATH}/jre/bin/java) set(CUBE_JAR $ENV{CUBE_PATH}/STM32CubeMX) + set(CUBE_CMD ${JAVA_EXE} -jar ${CUBE_JAR}) set(JLINK_EXE JLinkExe) + message(STATUS "Linux detected") +endif() + +# Check if OpenOCD variables are properly defined +if (DEFINED ENV{OPENOCD_SCRIPTS_PATH}) + message(STATUS "OPENOCD_SCRIPTS_PATH defined as $ENV{OPENOCD_SCRIPTS_PATH}") + set(OPENOCD_SCRIPTS_PATH $ENV{OPENOCD_SCRIPTS_PATH}) +else() + set(OPENOCD_SCRIPTS_PATH "/usr/share/openocd/scripts") + message(STATUS "OPENOCD_SCRIPTS_PATH not defined. Using default path ${OPENOCD_SCRIPTS_PATH}") +endif() + +# Check if STM32CubeMX project is correctly configured +set(CUBE_CMAKE_TOOLCHAIN_CONFIG "ProjectManager.TargetToolchain=CMake") +set(IOC_FILE cube/${PROJECT_RELEASE}.ioc) +file(READ ${IOC_FILE} IOC_CONTENTS) +string(FIND "${IOC_CONTENTS}" ${CUBE_CMAKE_TOOLCHAIN_CONFIG} CUBE_CMAKE_TOOLCHAIN_CONFIG_POS) +if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${IOC_FILE}) + message(FATAL_ERROR "CubeMX ${IOC_FILE} project file not found") +elseif(${CUBE_CMAKE_TOOLCHAIN_CONFIG_POS} EQUAL -1) + message(FATAL_ERROR "CMake toolchain not selected in CubeMX project") +else() + message(STATUS "CMake toolchain selected in CubeMX project") endif() -# Check if necessary variables are defined: -foreach(VARIABLE ${USER_INPUT_VARIABLES}) - if(NOT DEFINED ${VARIABLE}) - message(FATAL_ERROR "${VARIABLE} not defined") - endif() -endforeach() -message(STATUS "All necessary variables defined!") +# Set DEVICE variable based on cube configuration +string(REGEX MATCH "ProjectManager\.DeviceId=[^\n]+" DEVICE_LINE "${IOC_CONTENTS}") +string(SUBSTRING ${DEVICE_LINE} 24 11 DEVICE) +string(TOLOWER ${DEVICE} LOWERCASE_DEVICE) +string(SUBSTRING ${LOWERCASE_DEVICE} 0 7 TARGET_CFG) +message(STATUS "Device is ${DEVICE}") # Check cube directory for files # If it's empty, generate the files -# It's important to do it before find_package(CMSIS) file(GLOB_RECURSE CUBE_SOURCES_CHECK "${CMAKE_CURRENT_SOURCE_DIR}/cube/Src/*.c") list(LENGTH CUBE_SOURCES_CHECK CUBE_LENGHT) if(CUBE_LENGHT EQUAL 0) message(STATUS "Cube directory is empty. Generating cube files...") file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/.cube - "config load ${CMAKE_CURRENT_SOURCE_DIR}/cube/${PROJECT_RELEASE}.ioc\n" + "config load ../cube/${PROJECT_RELEASE}.ioc\n" "project generate\n" "exit\n" ) - execute_process(COMMAND ${JAVA_EXE} -jar ${CUBE_JAR} -q ${CMAKE_CURRENT_BINARY_DIR}/.cube) + execute_process(COMMAND ${CUBE_CMD} -q ${CMAKE_CURRENT_BINARY_DIR}/.cube) endif() diff --git a/cmake/targets.cmake b/cmake/targets.cmake index 0a29039..fa3c490 100644 --- a/cmake/targets.cmake +++ b/cmake/targets.cmake @@ -61,7 +61,7 @@ function(targets_generate_format_target) list(APPEND FILES_LIST ${${FILE}}) endforeach() add_custom_target(format - COMMAND uncrustify -c ${CMAKE_CURRENT_SOURCE_DIR}/uncrustify.cfg --replace --no-backup ${FILES_LIST} + COMMAND clang-format -style=file -i ${FILES_LIST} --verbose ) endfunction() diff --git a/cmake/utilities.cmake b/cmake/utilities.cmake new file mode 100644 index 0000000..4a50182 --- /dev/null +++ b/cmake/utilities.cmake @@ -0,0 +1,72 @@ +# Name: utilities.cmake +# ThundeRatz Robotics Team +# Brief: This file contains utilities functions for file generation and size check +# 04/2024 + +############################################################################### +## Utilities Functions +############################################################################### + +# This function adds a target with name '${TARGET}_always_display_size'. The new +# target builds a TARGET and then calls the program defined in CMAKE_SIZE to +# display the size of the final ELF. +function(stm32_print_size_of_target TARGET) + add_custom_target(${TARGET}_always_display_size + ALL COMMAND ${CMAKE_SIZE} "$" + COMMENT "Target Sizes: " + DEPENDS ${TARGET} + ) +endfunction() + +# This function calls the objcopy program defined in CMAKE_OBJCOPY to generate +# file with object format specified in OBJCOPY_BFD_OUTPUT. +# The generated file has the name of the target output but with extension +# corresponding to the OUTPUT_EXTENSION argument value. +# The generated file will be placed in the same directory as the target output file. +function(_stm32_generate_file TARGET OUTPUT_EXTENSION OBJCOPY_BFD_OUTPUT) + # If linter is enabled, do not generate files + if(LINTER_MODE STREQUAL "ON" OR LINTER_MODE STREQUAL "FIX") + message(STATUS "Linter is enabled, skipping generation of ${OBJCOPY_BFD_OUTPUT} file for target ${TARGET}") + return() + endif() + + get_target_property(TARGET_OUTPUT_NAME ${TARGET} OUTPUT_NAME) + if(TARGET_OUTPUT_NAME) + set(OUTPUT_FILE_NAME "${TARGET_OUTPUT_NAME}.${OUTPUT_EXTENSION}") + else() + set(OUTPUT_FILE_NAME "${TARGET}.${OUTPUT_EXTENSION}") + endif() + + get_target_property(RUNTIME_OUTPUT_DIRECTORY ${TARGET} RUNTIME_OUTPUT_DIRECTORY) + if(RUNTIME_OUTPUT_DIRECTORY) + set(OUTPUT_FILE_PATH "${RUNTIME_OUTPUT_DIRECTORY}/${OUTPUT_FILE_NAME}") + else() + set(OUTPUT_FILE_PATH "${OUTPUT_FILE_NAME}") + endif() + + add_custom_command( + TARGET ${TARGET} + POST_BUILD + COMMAND ${CMAKE_OBJCOPY} -O ${OBJCOPY_BFD_OUTPUT} "$" ${OUTPUT_FILE_PATH} + BYPRODUCTS ${OUTPUT_FILE_PATH} + COMMENT "Generating ${OBJCOPY_BFD_OUTPUT} file ${OUTPUT_FILE_NAME}" + ) +endfunction() + +# This function adds post-build generation of the binary file from the target ELF. +# The generated file will be placed in the same directory as the ELF file. +function(stm32_generate_binary_file TARGET) + _stm32_generate_file(${TARGET} "bin" "binary") +endfunction() + +# This function adds post-build generation of the Motorola S-record file from the target ELF. +# The generated file will be placed in the same directory as the ELF file. +function(stm32_generate_srec_file TARGET) + _stm32_generate_file(${TARGET} "srec" "srec") +endfunction() + +# This function adds post-build generation of the Intel hex file from the target ELF. +# The generated file will be placed in the same directory as the ELF file. +function(stm32_generate_hex_file TARGET) + _stm32_generate_file(${TARGET} "hex" "ihex") +endfunction() diff --git a/cmake/workspace.cmake b/cmake/workspace.cmake deleted file mode 100644 index 6577724..0000000 --- a/cmake/workspace.cmake +++ /dev/null @@ -1,22 +0,0 @@ -# Name: workspace.cmake -# ThundeRatz Robotics Team -# Brief: CMake file to generate VS Code files and link githooks -# 04/2023 - -############################################################################### -## VS Code files -############################################################################### - -message(STATUS "Configuring VS Code files") -configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/cmake/templates/launch.json.in ${LAUNCH_JSON_PATH} -) - -############################################################################### -## Link Githooks -############################################################################### - -message(STATUS "Linking githooks") -execute_process( - COMMAND git config core.hooksPath ${CMAKE_CURRENT_SOURCE_DIR}/.githooks -) diff --git a/inc/mcu.hpp b/include/mcu.hpp similarity index 53% rename from inc/mcu.hpp rename to include/mcu.hpp index 168a505..01e2a1a 100644 --- a/inc/mcu.hpp +++ b/include/mcu.hpp @@ -13,8 +13,7 @@ * Public Function Prototypes *****************************************/ -extern "C" -{ +extern "C" { /** * @brief Initializes System Clock. * @note Defined by cube. @@ -24,18 +23,18 @@ void SystemClock_Config(void); namespace hal { class mcu { - public: - /** - * @brief Initializes MCU and some peripherals. - */ - static void init(void); +public: + /** + * @brief Initializes MCU and some peripherals. + */ + static void init(void); - /** - * @brief Put the MCU to sleep. - * - * @param ms Sleep time in milliseconds - */ - static void sleep(uint32_t ms); + /** + * @brief Put the MCU to sleep. + * + * @param ms Sleep time in milliseconds + */ + static void sleep(uint32_t ms); }; -}; -#endif // __MCU_HPP__ +}; // namespace hal +#endif // __MCU_HPP__ diff --git a/src/mcu.cpp b/src/mcu.cpp index 35df8e2..d22fbaf 100644 --- a/src/mcu.cpp +++ b/src/mcu.cpp @@ -4,19 +4,17 @@ * @brief MCU related */ -#include - #include "mcu.hpp" - -#include "gpio.h" -#include "main.h" +// #include +// #include "gpio.h" +#include "../cube/Inc/gpio.h" /***************************************** * Public Function Body Definitions *****************************************/ namespace hal { -void mcu::init(void) { +void mcu::init() { HAL_Init(); SystemClock_Config(); @@ -27,4 +25,4 @@ void mcu::init(void) { void mcu::sleep(uint32_t ms) { HAL_Delay(ms); } -} +} // namespace hal diff --git a/tests/bin/test_main.cpp b/tests/bin/test_main.cpp deleted file mode 100644 index 76447bd..0000000 --- a/tests/bin/test_main.cpp +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @file test_main.cpp - * - * @brief Main function for tests. - */ - -#include -#include "test_core.hpp" - -int main(void) { - test_core_init(); - - for (;;) { - } -} diff --git a/tests/inc/test_core.hpp b/tests/inc/test_core.hpp deleted file mode 100644 index e81243f..0000000 --- a/tests/inc/test_core.hpp +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @file test_core.hpp - * - * @brief Core functions to the test - * - * @date 04/2021 - * - * @copyright MIT License - * - */ - -#ifndef __TEST_CORE_H__ -#define __TEST_CORE_H__ - -/***************************************** - * Public Functions Prototypes - *****************************************/ - -/** - * @brief Initialize test core - * - */ -void test_core_init(void); - -#endif // __TEST_CORE_H__ diff --git a/tests/src/test_core.cpp b/tests/src/test_core.cpp deleted file mode 100644 index ed9f909..0000000 --- a/tests/src/test_core.cpp +++ /dev/null @@ -1,21 +0,0 @@ -/** - * @file test_core.cpp - * - * @brief Core functions to the test - * - * @date 04/2021 - * - * @copyright MIT License - * - */ - -#include "test_core.hpp" -#include "mcu.hpp" - -/***************************************** - * Public Functions Bodies Definitions - *****************************************/ - -void test_core_init(void) { - hal::mcu::init(); -} diff --git a/tests/src/test_main.cpp b/tests/src/test_main.cpp new file mode 100644 index 0000000..d06a5e3 --- /dev/null +++ b/tests/src/test_main.cpp @@ -0,0 +1,13 @@ +/** + * @file test_main.cpp + * + * @brief Main function for tests. + */ + +#include "mcu.hpp" + +int main() { + hal::mcu::init(); + + for (;;) { } +} From e82cafa740e8e9e4e3f6b4127962902388e6362e Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:32:30 -0300 Subject: [PATCH 19/95] =?UTF-8?q?=F0=9F=94=87=20Remove=20debug=20logs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 5 ----- 1 file changed, 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2fa0c64..fc47f46 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -86,7 +86,6 @@ targets_generate_format_target(FORMAT_SOURCES FORMAT_HEADERS) file(GLOB_RECURSE PROJECT_SOURCES CONFIGURE_DEPENDS "src/*.cpp") file(GLOB_RECURSE PROJECT_TESTS CONFIGURE_DEPENDS "tests/src/**.cpp") -message(STATUS "Project tests: ${PROJECT_TESTS}") ############################################################################### ## Main executable target @@ -113,8 +112,6 @@ targets_generate_helpme_target() ## Generate test executables ############################################################################### -message(STATUS "Tests:") - foreach(TEST_FILE ${PROJECT_TESTS}) get_filename_component(TEST_NAME ${TEST_FILE} NAME_WLE) @@ -132,8 +129,6 @@ foreach(TEST_FILE ${PROJECT_TESTS}) stm32_generate_hex_file(${TEST_NAME}) - message(STATUS "Test: ${TEST_NAME}") - targets_generate_vsfiles_target(${TEST_NAME}) targets_generate_flash_target(${TEST_NAME}) From 95d5d61ad5a0f4e51fa25bac503fcd92c4f87582 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:33:50 -0300 Subject: [PATCH 20/95] =?UTF-8?q?=E2=9C=A8=20Add=20test=5Fall=20target?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 2 ++ cmake/targets.cmake | 12 ++++++++++++ 2 files changed, 14 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index fc47f46..3eb4140 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -133,3 +133,5 @@ foreach(TEST_FILE ${PROJECT_TESTS}) targets_generate_flash_target(${TEST_NAME}) endforeach() + +targets_generate_test_all_target(${PROJECT_TESTS}) diff --git a/cmake/targets.cmake b/cmake/targets.cmake index fa3c490..b199738 100644 --- a/cmake/targets.cmake +++ b/cmake/targets.cmake @@ -65,6 +65,18 @@ function(targets_generate_format_target) ) endfunction() +function(targets_generate_test_all_target) + foreach(FILE ${ARGV}) + get_filename_component(TEST_NAME ${FILE} NAME_WLE) + list(APPEND TEST_TARGETS ${TEST_NAME}) + endforeach() + + add_custom_target(test_all + COMMAND ${CMAKE_MAKE_PROGRAM} ${TEST_TARGETS} + ) +endfunction() + + # Flash via st-link or jlink function(targets_generate_flash_target TARGET) if("${TARGET}" STREQUAL "${PROJECT_NAME}") From 7c7f99f00f25bcdf1e5afae135af0c6fa1313954 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:34:16 -0300 Subject: [PATCH 21/95] =?UTF-8?q?=F0=9F=9A=A8=20Fix=20linter=20warnings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- include/mcu.hpp | 10 +++++----- src/main.cpp | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/include/mcu.hpp b/include/mcu.hpp index 01e2a1a..42b560a 100644 --- a/include/mcu.hpp +++ b/include/mcu.hpp @@ -4,10 +4,10 @@ * @brief MCU related */ -#ifndef __MCU_HPP__ -#define __MCU_HPP__ +#ifndef MCU_HPP +#define MCU_HPP -#include +#include /***************************************** * Public Function Prototypes @@ -27,7 +27,7 @@ class mcu { /** * @brief Initializes MCU and some peripherals. */ - static void init(void); + static void init(); /** * @brief Put the MCU to sleep. @@ -37,4 +37,4 @@ class mcu { static void sleep(uint32_t ms); }; }; // namespace hal -#endif // __MCU_HPP__ +#endif // MCU_HPP diff --git a/src/main.cpp b/src/main.cpp index 94baf12..a85ea31 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -16,7 +16,7 @@ static constexpr uint16_t led_toggle_delay_ms = 1500; * Main Function *****************************************/ -int main(void) { +int main() { hal::mcu::init(); for (;;) { From 34d1f55d9bec3e679dfbcbf68ab086eea35b6396 Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:46:03 -0300 Subject: [PATCH 22/95] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Update=20targets?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cmake/targets.cmake | 63 +++++++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 22 deletions(-) diff --git a/cmake/targets.cmake b/cmake/targets.cmake index b199738..2797b09 100644 --- a/cmake/targets.cmake +++ b/cmake/targets.cmake @@ -7,6 +7,12 @@ ## Auxiliary Targets ############################################################################### +if("$ENV{PROGRAMMER_CMD}" STREQUAL "") + set(PROGRAMMER_CMD "STM32_Programmer_CLI") +else() + set(PROGRAMMER_CMD $ENV{PROGRAMMER_CMD}) +endif() + add_custom_target(helpme COMMAND cat ${CMAKE_CURRENT_BINARY_DIR}/.helpme ) @@ -14,28 +20,37 @@ add_custom_target(helpme add_custom_target(cube COMMAND echo "Generating cube files..." - COMMAND echo "config load ${CMAKE_CURRENT_SOURCE_DIR}/cube/${PROJECT_RELEASE}.ioc" > ${CMAKE_CURRENT_BINARY_DIR}/.cube + COMMAND echo "config load ../cube/${PROJECT_RELEASE}.ioc" > ${CMAKE_CURRENT_BINARY_DIR}/.cube COMMAND echo "project generate" >> ${CMAKE_CURRENT_BINARY_DIR}/.cube COMMAND echo "exit" >> ${CMAKE_CURRENT_BINARY_DIR}/.cube - COMMAND ${JAVA_EXE} -jar ${CUBE_JAR} -q ${CMAKE_CURRENT_BINARY_DIR}/.cube + COMMAND ${CUBE_CMD} -q ${CMAKE_CURRENT_BINARY_DIR}/.cube ) add_custom_target(info - STM32_Programmer_CLI -c port=SWD + COMMAND ${PROGRAMMER_CMD} -c port=SWD ) add_custom_target(reset COMMAND echo "Reseting device" - COMMAND STM32_Programmer_CLI -c port=SWD -rst + COMMAND ${PROGRAMMER_CMD} -c port=SWD -rst ) -add_custom_target(clean_all +add_custom_target(clear COMMAND echo "Cleaning all build files..." COMMAND rm -rf ${CMAKE_CURRENT_BINARY_DIR}/* ) -add_custom_target(clean_cube +add_custom_target(clear_cube + COMMAND echo "Cleaning cube files..." + COMMAND mv ${CMAKE_CURRENT_SOURCE_DIR}/cube/*.ioc . + COMMAND rm -rf ${CMAKE_CURRENT_SOURCE_DIR}/cube/* + COMMAND mv *.ioc ${CMAKE_CURRENT_SOURCE_DIR}/cube/ +) + +add_custom_target(clear_all + COMMAND echo "Cleaning all build files..." + COMMAND rm -rf ${CMAKE_CURRENT_BINARY_DIR}/* COMMAND echo "Cleaning cube files..." COMMAND mv ${CMAKE_CURRENT_SOURCE_DIR}/cube/*.ioc . COMMAND rm -rf ${CMAKE_CURRENT_SOURCE_DIR}/cube/* @@ -43,27 +58,23 @@ add_custom_target(clean_cube ) add_custom_target(rebuild - COMMAND ${CMAKE_MAKE_PROGRAM} clean_all + COMMAND ${CMAKE_MAKE_PROGRAM} clear COMMAND cmake .. COMMAND ${CMAKE_MAKE_PROGRAM} ) add_custom_target(rebuild_all - COMMAND ${CMAKE_MAKE_PROGRAM} clean_cube - COMMAND ${CMAKE_MAKE_PROGRAM} clean_all + COMMAND ${CMAKE_MAKE_PROGRAM} clear_all COMMAND cmake .. COMMAND ${CMAKE_MAKE_PROGRAM} ) -function(targets_generate_format_target) - set(FILES_LIST "") - foreach(FILE ${ARGV}) - list(APPEND FILES_LIST ${${FILE}}) - endforeach() - add_custom_target(format - COMMAND clang-format -style=file -i ${FILES_LIST} --verbose - ) -endfunction() +add_custom_target(docs + COMMAND cd ${CMAKE_CURRENT_SOURCE_DIR} && doxygen Doxyfile + COMMAND make -C ${CMAKE_CURRENT_SOURCE_DIR}/docs/latex || true + COMMAND mv ${CMAKE_CURRENT_SOURCE_DIR}/docs/latex/refman.pdf ${CMAKE_CURRENT_SOURCE_DIR}/docs/ + COMMAND rm -rf ${CMAKE_CURRENT_SOURCE_DIR}/docs/latex +) function(targets_generate_test_all_target) foreach(FILE ${ARGV}) @@ -76,6 +87,15 @@ function(targets_generate_test_all_target) ) endfunction() +function(targets_generate_format_target) + set(FILES_LIST "") + foreach(FILE ${ARGV}) + list(APPEND FILES_LIST ${${FILE}}) + endforeach() + add_custom_target(format + COMMAND clang-format -style=file -i ${FILES_LIST} --verbose + ) +endfunction() # Flash via st-link or jlink function(targets_generate_flash_target TARGET) @@ -87,7 +107,7 @@ function(targets_generate_flash_target TARGET) add_custom_target(flash${TARGET_SUFFIX} COMMAND echo "Flashing..." - COMMAND STM32_Programmer_CLI -c port=SWD -w ${TARGET}.hex -v -rst + COMMAND ${PROGRAMMER_CMD} -c port=SWD -w ${TARGET}.hex -v -rst ) add_dependencies(flash${TARGET_SUFFIX} ${TARGET}) @@ -97,7 +117,6 @@ function(targets_generate_flash_target TARGET) add_custom_target(jflash${TARGET_SUFFIX} COMMAND echo "Flashing ${PROJECT_NAME}.hex with J-Link" - COMMAND ${JLINK_EXE} ${CMAKE_CURRENT_BINARY_DIR}/.jlink-flash${TARGET_SUFFIX} COMMAND ${JLINK_EXE} ${CMAKE_CURRENT_BINARY_DIR}/jlinkflash/.jlink-flash${TARGET_SUFFIX} ) @@ -118,12 +137,12 @@ function(targets_generate_vsfiles_target TARGET) configure_file(${input_file} ${ouput_save_file}) - add_custom_target(debug_files${TARGET_SUFFIX} + add_custom_target(debug${TARGET_SUFFIX} COMMAND echo "Configuring VS Code files for ${TARGET}" COMMAND cat ${ouput_save_file} > ${LAUNCH_JSON_PATH} ) - add_dependencies(debug_files${TARGET_SUFFIX} ${TARGET}) + add_dependencies(debug${TARGET_SUFFIX} ${TARGET}) endfunction() function(targets_generate_helpme_target) From ffd8dca647888aaabfd9af848a820cc91cf2e47f Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:46:41 -0300 Subject: [PATCH 23/95] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20Update=20extensions?= =?UTF-8?q?=20recommendations?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vscode/extensions.json | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index dcc196a..15415b6 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -6,10 +6,16 @@ "recommendations": [ "ms-vscode.cpptools", "cschlosser.doxdocgen", - "editorconfig.editorconfig", "davidanson.vscode-markdownlint", - "zachflower.uncrustify", "marus25.Cortex-Debug", + "dan-c-underwood.arm", + "streetsidesoftware.code-spell-checker", + "streetsidesoftware.code-spell-checker-portuguese-brazilian", + "twxs.cmake", + "ms-vscode.cmake-tools", + "seatonjiang.gitmoji-vscode", + "mhutchie.git-graph", + "xaver.clang-format", ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. From 523b0260499618cf6c692920643c581fca9c225d Mon Sep 17 00:00:00 2001 From: Eduardo-Barreto Date: Sun, 16 Mar 2025 17:58:00 -0300 Subject: [PATCH 24/95] =?UTF-8?q?=F0=9F=9A=A7=20Add=20doxyfile?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Doxyfile | 2860 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2860 insertions(+) create mode 100644 Doxyfile diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..61cf577 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2860 @@ +# Doxyfile 1.9.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "STM32 Project Template" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs/ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 0 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = NO + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, +# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = "tests/" \ + "cube/" \ + "build/" + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = "*/libs/*" + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = "sed -e 's/#include <.*>/ /'" + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = NO + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /