code beautifying

2024-02-16 20:56:03 +01:00 · 2024-02-16 20:56:03 +01:00 · 08885a3aac
commit 08885a3aac
parent 9a07c24d8f
8 changed files with 292 additions and 113 deletions
--- a/.clang-format
+++ b/.clang-format
@ -0,0 +1,236 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveAssignments:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  PadOperators:    true
+AlignConsecutiveBitFields:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  PadOperators:    false
+AlignConsecutiveDeclarations:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  PadOperators:    false
+AlignConsecutiveMacros:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  PadOperators:    false
+AlignConsecutiveShortCaseStatements:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCaseColons: false
+AlignEscapedNewlines: Right
+AlignOperands:   Align
+AlignTrailingComments:
+  Kind:            Always
+  OverEmptyLines:  0
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BitFieldColonSpacing: Both
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterExternBlock: false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakAfterAttributes: Never
+BreakAfterJavaFieldAnnotations: false
+BreakArrays:     true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: Always
+BreakBeforeBraces: Linux
+BreakBeforeInlineASMColon: OnlyMultiline
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+BreakStringLiterals: true
+ColumnLimit:     120
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseBlocks: false
+IndentCaseLabels: false
+IndentExternBlock: AfterExternBlock
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentRequiresClause: true
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+InsertBraces:    false
+InsertNewlineAtEOF: false
+InsertTrailingCommas: None
+IntegerLiteralSeparator:
+  Binary:          0
+  BinaryMinDigits: 0
+  Decimal:         0
+  DecimalMinDigits: 0
+  Hex:             0
+  HexMinDigits:    0
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+KeepEmptyLinesAtEOF: false
+LambdaBodyIndentation: Signature
+LineEnding:      DeriveLF
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: BinPack
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyIndentedWhitespace: 0
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+PPIndentWidth:   -1
+QualifierAlignment: Leave
+ReferenceAlignment: Pointer
+ReflowComments:  true
+RemoveBracesLLVM: false
+RemoveParentheses: Leave
+RemoveSemicolon: false
+RequiresClausePosition: OwnLine
+RequiresExpressionIndentation: OuterScope
+SeparateDefinitionBlocks: Leave
+ShortNamespaceLines: 1
+SortIncludes:    CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: LexicographicNumeric
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeJsonColon: false
+SpaceBeforeParens: ControlStatements
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterForeachMacros: true
+  AfterFunctionDefinitionName: false
+  AfterFunctionDeclarationName: false
+  AfterIfMacros:   true
+  AfterOverloadedOperator: false
+  AfterRequiresInClause: false
+  AfterRequiresInExpression: false
+  BeforeNonEmptyParentheses: false
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  Never
+SpacesInContainerLiterals: true
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParens:  Never
+SpacesInParensOptions:
+  InCStyleCasts:   false
+  InConditionalStatements: false
+  InEmptyParentheses: false
+  Other:           false
+SpacesInSquareBrackets: false
+Standard:        Latest
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseTab:          Never
+VerilogBreakBetweenInstancePorts: true
+WhitespaceSensitiveMacros:
+  - BOOST_PP_STRINGIZE
+  - CF_SWIFT_NAME
+  - NS_SWIFT_NAME
+  - PP_STRINGIZE
+  - STRINGIZE
+...
+
--- a/src/keyer.cpp
+++ b/src/keyer.cpp
@ -13,8 +13,7 @@ const uint SIDETONE_FREQ = 622;

 bool left_paddle_pressed()
 {
-    if (!gpio_get(LEFT_PADDLE_PIN))
-    {
+    if (!gpio_get(LEFT_PADDLE_PIN)) {
        return true;
    }
    return false;
@ -22,8 +21,7 @@ bool left_paddle_pressed()

 bool right_paddle_pressed()
 {
-    if (!gpio_get(RIGHT_PADDLE_PIN))
-    {
+    if (!gpio_get(RIGHT_PADDLE_PIN)) {
        return true;
    }
    return false;
@ -35,10 +33,7 @@ uint64_t calcElementDurationUs(uint8_t wpm)
    return duration;
 }

-Keyer::Keyer(uint8_t wpm, Mode mode) : m_wpm(wpm), m_mode(mode)
-{
-    m_elementDuration = calcElementDurationUs(m_wpm);
-}
+Keyer::Keyer(uint8_t wpm, Mode mode) : m_wpm(wpm), m_mode(mode) { m_elementDuration = calcElementDurationUs(m_wpm); }

 void Keyer::setSpeed(uint8_t wpm)
 {
@ -50,23 +45,16 @@ void Keyer::run()
 {
    auto timestamp = get_absolute_time();

-    switch (m_state)
-    {
+    switch (m_state) {
    case State::Wait:
-        if (left_paddle_pressed())
-        {
+        if (left_paddle_pressed()) {
            m_keyNextIambicB = false;
            m_state = State::Dit;
-        }
-        else if (right_paddle_pressed())
-        {
+        } else if (right_paddle_pressed()) {
            m_keyNextIambicB = false;
            m_state = State::Dah;
-        }
-        else
-        {
-            if (m_mode == Mode::IAMBIC_B && m_keyNextIambicB)
-            {
+        } else {
+            if (m_mode == Mode::IAMBIC_B && m_keyNextIambicB) {
                if (m_previousState == State::Dit)
                    m_state = State::Dah;
                else
@ -77,24 +65,19 @@ void Keyer::run()
        }
        break;
    case State::Dit:
-        if (!m_currentlyKeying)
-        {
+        if (!m_currentlyKeying) {
            m_currentlyKeying = true;
            m_keying_until = make_timeout_time_us(m_elementDuration);
            gpio_put(LED_PIN, 1);
            m_Sidetone.on(SIDETONE_FREQ);
-        }
-        else
-        {
+        } else {
            // If right paddle üressed -> note for Iambic B
-            if (right_paddle_pressed() && !m_keyNextIambicB)
-            {
+            if (right_paddle_pressed() && !m_keyNextIambicB) {
                printf("Iambic B -> lang\n");
                m_keyNextIambicB = true;
            }

-            if (absolute_time_diff_us(timestamp, m_keying_until) <= 0)
-            {
+            if (absolute_time_diff_us(timestamp, m_keying_until) <= 0) {
                m_currentlyKeying = false;
                gpio_put(LED_PIN, 0);
                m_Sidetone.off();
@ -104,24 +87,19 @@ void Keyer::run()
        }
        break;
    case State::Dah:
-        if (!m_currentlyKeying)
-        {
+        if (!m_currentlyKeying) {
            m_currentlyKeying = true;
            m_keying_until = make_timeout_time_us(m_elementDuration * 3);
            gpio_put(LED_PIN, 1);
            m_Sidetone.on(SIDETONE_FREQ);
-        }
-        else
-        {
+        } else {
            // If left paddle pressed -> Note for Iambic B
-            if (left_paddle_pressed() && !m_keyNextIambicB)
-            {
+            if (left_paddle_pressed() && !m_keyNextIambicB) {
                printf("Iambic B -> kurz\n");
                m_keyNextIambicB = true;
            }

-            if (absolute_time_diff_us(timestamp, m_keying_until) <= 0)
-            {
+            if (absolute_time_diff_us(timestamp, m_keying_until) <= 0) {
                m_currentlyKeying = false;
                gpio_put(LED_PIN, 0);
                m_Sidetone.off();
@ -131,58 +109,40 @@ void Keyer::run()
        }
        break;
    case State::DitPause:
-        if (!m_currentlyPausing)
-        {
+        if (!m_currentlyPausing) {
            m_pausing_until = make_timeout_time_us(m_elementDuration);
            m_currentlyPausing = true;
-        }
-        else
-        {
-            if (absolute_time_diff_us(timestamp, m_pausing_until) <= 0)
-            {
+        } else {
+            if (absolute_time_diff_us(timestamp, m_pausing_until) <= 0) {
                m_currentlyPausing = false;

-                if (right_paddle_pressed())
-                {
+                if (right_paddle_pressed()) {
                    m_state = State::Dah;
                    m_keyNextIambicB = false;
-                }
-                else if (left_paddle_pressed())
-                {
+                } else if (left_paddle_pressed()) {
                    m_state = State::Dit;
                    m_keyNextIambicB = false;
-                }
-                else
-                {
+                } else {
                    m_state = State::Wait;
                }
            }
        }
        break;
    case State::DahPause:
-        if (!m_currentlyPausing)
-        {
+        if (!m_currentlyPausing) {
            m_pausing_until = make_timeout_time_us(m_elementDuration);
            m_currentlyPausing = true;
-        }
-        else
-        {
-            if (absolute_time_diff_us(timestamp, m_pausing_until) <= 0)
-            {
+        } else {
+            if (absolute_time_diff_us(timestamp, m_pausing_until) <= 0) {
                m_currentlyPausing = false;

-                if (left_paddle_pressed())
-                {
+                if (left_paddle_pressed()) {
                    m_state = State::Dit;
                    m_keyNextIambicB = false;
-                }
-                else if (right_paddle_pressed())
-                {
+                } else if (right_paddle_pressed()) {
                    m_state = State::Dah;
                    m_keyNextIambicB = false;
-                }
-                else
-                {
+                } else {
                    m_state = State::Wait;
                }
            }
@ -202,7 +162,4 @@ void Keyer::run()
    }
 }

-void Keyer::stop()
-{
-    m_state = State::Abort;
-}
+void Keyer::stop() { m_state = State::Abort; }
--- a/src/keyer.h
+++ b/src/keyer.h
@ -1,8 +1,8 @@
 #ifndef KEYER_H
 #define KEYER_H

-#include "sidetone.h"
 #include "settings.h"
+#include "sidetone.h"

 extern const uint BUZZER_PIN;

@ -19,8 +19,7 @@ public:
    void stop();

  private:
-    enum class State
-    {
+    enum class State {
        Wait,
        Dit,
        Dah,
--- a/src/raspi_keyer.cpp
+++ b/src/raspi_keyer.cpp
@ -1,11 +1,11 @@
 #include <stdio.h>

-#include "pico/stdlib.h"
 #include "pico/multicore.h"
+#include "pico/stdlib.h"
 #include "pico/util/queue.h"

-#include "settings.h"
 #include "keyer.h"
+#include "settings.h"

 namespace
 {
@ -18,15 +18,13 @@ extern const uint RIGHT_PADDLE_PIN = 15;
 extern const uint BUZZER_PIN = 18;

 // Stuff for communicating between cores
-enum class KeyerQueueCommand
-{
+enum class KeyerQueueCommand {
    Run,
    Stop,
    Config,
    Wait,
 };
-struct KeyerQueueData
-{
+struct KeyerQueueData {
    KeyerQueueCommand cmd;
    uint8_t wpm;
    Mode mode;
@ -61,12 +59,10 @@ void core1_main()

    Keyer keyer(data.wpm, data.mode);

-    while (true)
-    {
+    while (true) {
        queue_try_remove(&keyerQueue, &data);

-        switch (data.cmd)
-        {
+        switch (data.cmd) {
        case KeyerQueueCommand::Run:
            keyer.run();
            break;
@ -106,8 +102,7 @@ int main()
    KeyerQueueData keyerQueueData{KeyerQueueCommand::Run, settings.wpm, settings.mode};
    queue_add_blocking(&keyerQueue, &keyerQueueData);

-    while (true)
-    {
+    while (true) {
        // Currently there's nothing to do on core0
        sleep_ms(1000);
    }
--- a/src/settings.cpp
+++ b/src/settings.cpp
@ -9,7 +9,7 @@ namespace
 constexpr const uint32_t FLASH_TARGET_OFFSET = PICO_FLASH_SIZE_BYTES - FLASH_SECTOR_SIZE;
 const uint8_t *flash_target_contents = (const uint8_t *)(XIP_BASE + FLASH_TARGET_OFFSET);
 const uint LED_PIN = PICO_DEFAULT_LED_PIN;
-}
+} // namespace

 void flash_store_callback(void *settings)
 {
@ -24,8 +24,7 @@ void store_settings(Settings &settings)
    uint8_t *settingsAsBytes = (uint8_t *)&settings;

    int result = flash_safe_execute(flash_store_callback, settingsAsBytes, 1000);
-    if (result == PICO_OK)
-    {
+    if (result == PICO_OK) {
        gpio_put(LED_PIN, 1);
        sleep_ms(250);
        gpio_put(LED_PIN, 0);
@ -47,8 +46,7 @@ Settings read_settings()

    memcpy(&settings, flash_target_contents, sizeof(struct Settings));

-    if (settings.magic_number != MAGIC_NUMBER)
-    {
+    if (settings.magic_number != MAGIC_NUMBER) {
        settings = Settings();

        gpio_put(LED_PIN, 1);
--- a/src/settings.h
+++ b/src/settings.h
@ -5,15 +5,12 @@

 const uint16_t MAGIC_NUMBER = 2;

-enum class Mode : uint8_t
-{
+enum class Mode : uint8_t {
    IAMBIC_A = 0,
    IAMBIC_B,
-    // ULTIMATE
 };

-struct Settings
-{
+struct Settings {
    uint16_t magic_number{MAGIC_NUMBER};   // Bytes:  2
    Mode mode{Mode::IAMBIC_B};             // Bytes:  1
    uint8_t wpm{18};                       // Bytes:  1
--- a/src/sidetone.cpp
+++ b/src/sidetone.cpp
@ -1,5 +1,5 @@
-#include "pico/stdlib.h"
 #include "hardware/pwm.h"
+#include "pico/stdlib.h"

 #include "sidetone.h"

@ -23,7 +23,4 @@ void Sidetone::on(uint freq)
    pwm_set_gpio_level(m_gpio, 32768U);
 }

-void Sidetone::off()
-{
-    pwm_set_gpio_level(m_gpio, 0);
-}
+void Sidetone::off() { pwm_set_gpio_level(m_gpio, 0); }