Code reformatting and reorganization (#167)

* Rearrangement of files: - "Include" directory removed (.h files moved to "src") - MFEEPROM.h moved to MF_Modules (.cpp was under "_Boards/Atmel") Other: - Device type constants moved to "config.h" - Header inclusion optimized (main includes collected in "mobifligt.h) - Code formatting and headers made uniform - introduced VS Code formatting config (settings.json) * Fixed include case
MobiFlight · Apr 1, 2022 · e00bc34 · e00bc34
1 parent 134ce39
commit e00bc34
Show file tree

Hide file tree

Showing 62 changed files with 2,063 additions and 1,941 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,8 +1,11 @@
-{
-    // See http://go.microsoft.com/fwlink/?LinkId=827846
-    // for the documentation about the extensions.json format
-    "recommendations": [
-        "platformio.platformio-ide",
-        "vsls-contrib.codetour"
-    ]
-}
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide",
+        "vsls-contrib.codetour"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,7 @@
+{
+    "C_Cpp.clang_format_fallbackStyle": "{ BasedOnStyle: LLVM, UseTab: Never, IndentWidth: 4, TabWidth: 4, BreakBeforeBraces: Linux, AllowShortIfStatementsOnASingleLine: false, IndentCaseLabels: false, ColumnLimit: 0, AccessModifierOffset: -4, NamespaceIndentation: All, FixNamespaceComments: false, AlignConsecutiveAssignments: AcrossComments, AlignConsecutiveBitFields: AcrossEmptyLinesAndComments, AlignConsecutiveDeclarations: AcrossEmptyLinesAndComments, AlignConsecutiveMacros: AcrossComments, AlignTrailingComments: true, AllowShortBlocksOnASingleLine: Empty, AllowShortEnumsOnASingleLine: true, AllowShortFunctionsOnASingleLine: Inline, AllowShortIfStatementsOnASingleLine: WithoutElse,  BreakInheritanceList: BeforeColon, EmptyLineBeforeAccessModifier: LogicalBlock, SortIncludes: Never }",
+    "[cpp]": {
+        "editor.defaultFormatter": "ms-vscode.cpptools",
+        "editor.formatOnSave": true
+    }
+}
diff --git a/_Boards/Atmel/Board_Mega/MFBoards.h b/_Boards/Atmel/Board_Mega/MFBoards.h
@@ -1,3 +1,9 @@
+//
+// MFBoards.h (Arduino Mega)
+//
+// (C) MobiFlight Project 2022
+//
+
 #ifndef MFBoardMega_h
 #define MFBoardMega_h
 
@@ -24,29 +30,31 @@
 #endif
 
 //#define MODULE_MAX_PINS 69
-#define MAX_OUTPUTS 40
-#define MAX_BUTTONS 68
-#define MAX_LEDSEGMENTS 4
-#define MAX_ENCODERS 20
-#define MAX_STEPPERS 10
-#define MAX_MFSERVOS 10
-#define MAX_MFLCD_I2C 2
-#define MAX_ANALOG_INPUTS 16
+#define MAX_OUTPUTS         40
+#define MAX_BUTTONS         68
+#define MAX_LEDSEGMENTS     4
+#define MAX_ENCODERS        20
+#define MAX_STEPPERS        10
+#define MAX_MFSERVOS        10
+#define MAX_MFLCD_I2C       2
+#define MAX_ANALOG_INPUTS   16
 #define MAX_OUTPUT_SHIFTERS 4
-#define MAX_INPUT_SHIFTERS 4
+#define MAX_INPUT_SHIFTERS  4
 
-#define STEPS 64
+#define STEPS         64
 #define STEPPER_SPEED 400 // 300 already worked, 467, too?
 #define STEPPER_ACCEL 800
 
-#define MOBIFLIGHT_TYPE         "MobiFlight Mega"
-#define MOBIFLIGHT_SERIAL       "1234567890"
-#define MOBIFLIGHT_NAME         "MobiFlight Mega"
-#define EEPROM_SIZE             4096    // EEPROMSizeMega
-#define MEMLEN_CONFIG           1496    // max. size for config which wil be stored in EEPROM
-#define MEMLEN_CONFIG_BUFFER    1000    // max. size for configBuffer, contains only names from inputs
-#define MF_MAX_DEVICEMEM        1500    // max. memory size for devices
+#define MOBIFLIGHT_TYPE     "MobiFlight Mega"
+#define MOBIFLIGHT_SERIAL   "1234567890"
+#define MOBIFLIGHT_NAME     "MobiFlight Mega"
+#define EEPROM_SIZE         4096 // EEPROMSizeMega
+#define MEMLEN_CONFIG       1496 // max. size for config which wil be stored in EEPROM
+#define MEMLEN_NAMES_BUFFER 1000 // max. size for configBuffer, contains only names from inputs
+#define MF_MAX_DEVICEMEM    1500 // max. memory size for devices
 
 #define RANDOM_SEED_INPUT A0
 
 #endif
+
+// MFBoards.h
diff --git a/_Boards/Atmel/Board_ProMicro/MFBoards.h b/_Boards/Atmel/Board_ProMicro/MFBoards.h
@@ -1,3 +1,9 @@
+//
+// MFBoards.h (Arduino ProMicro)
+//
+// (C) MobiFlight Project 2022
+//
+
 #ifndef MFBoardMicro_h
 #define MFBoardMicro_h
 
@@ -24,29 +30,31 @@
 #endif
 
 //#define MODULE_MAX_PINS 21
-#define MAX_OUTPUTS 18
-#define MAX_BUTTONS 18
-#define MAX_LEDSEGMENTS 1
-#define MAX_ENCODERS 5
-#define MAX_STEPPERS 3
-#define MAX_MFSERVOS 3
-#define MAX_MFLCD_I2C 2
-#define MAX_ANALOG_INPUTS 5
+#define MAX_OUTPUTS         18
+#define MAX_BUTTONS         18
+#define MAX_LEDSEGMENTS     1
+#define MAX_ENCODERS        5
+#define MAX_STEPPERS        3
+#define MAX_MFSERVOS        3
+#define MAX_MFLCD_I2C       2
+#define MAX_ANALOG_INPUTS   5
 #define MAX_OUTPUT_SHIFTERS 2
-#define MAX_INPUT_SHIFTERS 2
+#define MAX_INPUT_SHIFTERS  2
 
-#define STEPS 64
+#define STEPS         64
 #define STEPPER_SPEED 400 // 300 already worked, 467, too?
 #define STEPPER_ACCEL 800
 
-#define MOBIFLIGHT_TYPE         "MobiFlight Micro"
-#define MOBIFLIGHT_SERIAL       "0987654321"
-#define MOBIFLIGHT_NAME         "MobiFlight Micro"
-#define EEPROM_SIZE             1024    // EEPROMSizeMicro
-#define MEMLEN_CONFIG           440     // max. size for config which wil be stored in EEPROM
-#define MEMLEN_CONFIG_BUFFER    350     // max. size for configBuffer, contains only names from inputs
-#define MF_MAX_DEVICEMEM        400     // max. memory size for devices
+#define MOBIFLIGHT_TYPE     "MobiFlight Micro"
+#define MOBIFLIGHT_SERIAL   "0987654321"
+#define MOBIFLIGHT_NAME     "MobiFlight Micro"
+#define EEPROM_SIZE         1024 // EEPROMSizeMicro
+#define MEMLEN_CONFIG       440  // max. size for config which wil be stored in EEPROM
+#define MEMLEN_NAMES_BUFFER 350  // max. size for configBuffer, contains only names from inputs
+#define MF_MAX_DEVICEMEM    400  // max. memory size for devices
 
 #define RANDOM_SEED_INPUT A0
 
 #endif
+
+// MFBoards.h
diff --git a/_Boards/Atmel/Board_Uno/MFBoards.h b/_Boards/Atmel/Board_Uno/MFBoards.h
@@ -1,3 +1,9 @@
+//
+// MFBoards.h (Arduino Uno/Nano)
+//
+// (C) MobiFlight Project 2022
+//
+
 #ifndef MFBoardUno_h
 #define MFBoardUno_h
 
@@ -24,29 +30,31 @@
 #endif
 
 //#define MODULE_MAX_PINS 13
-#define MAX_OUTPUTS 18
-#define MAX_BUTTONS 18
-#define MAX_LEDSEGMENTS 1
-#define MAX_ENCODERS 3
-#define MAX_STEPPERS 2
-#define MAX_MFSERVOS 2
-#define MAX_MFLCD_I2C 2
-#define MAX_ANALOG_INPUTS 6
+#define MAX_OUTPUTS         18
+#define MAX_BUTTONS         18
+#define MAX_LEDSEGMENTS     1
+#define MAX_ENCODERS        3
+#define MAX_STEPPERS        2
+#define MAX_MFSERVOS        2
+#define MAX_MFLCD_I2C       2
+#define MAX_ANALOG_INPUTS   6
 #define MAX_OUTPUT_SHIFTERS 2
-#define MAX_INPUT_SHIFTERS 2
+#define MAX_INPUT_SHIFTERS  2
 
-#define STEPS 64
+#define STEPS         64
 #define STEPPER_SPEED 400 // 300 already worked, 467, too?
 #define STEPPER_ACCEL 800
 
-#define MOBIFLIGHT_TYPE         "MobiFlight Uno"
-#define MOBIFLIGHT_SERIAL       "0987654321"
-#define MOBIFLIGHT_NAME         "MobiFlight Uno"
-#define EEPROM_SIZE             1024    // EEPROMSizeUno
-#define MEMLEN_CONFIG           286     // max. size for config which wil be stored in EEPROM
-#define MEMLEN_CONFIG_BUFFER    220     // max. size for configBuffer, contains only names from inputs
-#define MF_MAX_DEVICEMEM        300     // max. memory size for devices
+#define MOBIFLIGHT_TYPE     "MobiFlight Uno"
+#define MOBIFLIGHT_SERIAL   "0987654321"
+#define MOBIFLIGHT_NAME     "MobiFlight Uno"
+#define EEPROM_SIZE         1024 // EEPROMSizeUno
+#define MEMLEN_CONFIG       286  // max. size for config which wil be stored in EEPROM
+#define MEMLEN_NAMES_BUFFER 220  // max. size for configBuffer, contains only names from inputs
+#define MF_MAX_DEVICEMEM    300  // max. memory size for devices
 
 #define RANDOM_SEED_INPUT A0
 
 #endif
+
+// MFBoards.h
diff --git a/include/MFEEPROM.h b/include/MFEEPROM.h
diff --git a/include/README b/include/README
diff --git a/include/allocateMem.h b/include/allocateMem.h
diff --git a/include/commandmessenger.h b/include/commandmessenger.h
diff --git a/include/config.h b/include/config.h
diff --git a/include/mobiflight.h b/include/mobiflight.h
diff --git a/platformio.ini b/platformio.ini
@@ -40,10 +40,9 @@ build_flags =
 	-I./src/MF_Output
 	-I./src/MF_OutputShifter
 	-I./src/MF_Segment
-	-I./src/MF_OutputShifter
 	-I./src/MF_Servo
-	-I./src/MF_OutputShifter
 	-I./src/MF_Stepper
+	-I./src/MF_Modules
 src_filter =
 	+<*>
 extra_scripts =