Merge pull request #19 from leedave/feature/ufbt_update

Update for ufbt compatibility

Author: leedave

.clang-format

@@ -0,0 +1,191 @@
+---
+Language:        Cpp
+AccessModifierOffset: -4
+AlignAfterOpenBracket: AlwaysBreak
+AlignArrayOfStructures: None
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Left
+AlignOperands:   Align
+AlignTrailingComments: false
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+AttributeMacros:
+  - __capability
+BinPackArguments: false
+BinPackParameters: false
+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: BeforeColon
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeComma
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: false
+ColumnLimit:     99
+CommentPragmas:  '^ IWYU pragma:'
+QualifierAlignment: Leave
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+PackConstructorInitializers: BinPack
+BasedOnStyle:    ''
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+AllowAllConstructorInitializersOnNextLine: true
+FixNamespaceComments: false
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '.*'
+    Priority:        1
+    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
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+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: 4
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 10
+PenaltyBreakBeforeFirstCallParameter: 30
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakString: 10
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 100
+PenaltyReturnTypeOnItsOwnLine: 60
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Left
+PPIndentWidth:   -1
+ReferenceAlignment: Pointer
+ReflowComments:  false
+RemoveBracesLLVM: false
+SeparateDefinitionBlocks: Leave
+ShortNamespaceLines: 1
+SortIncludes:    Never
+SortJavaStaticImport: Before
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: Never
+SpaceBeforeParensOptions:
+  AfterControlStatements: false
+  AfterForeachMacros: false
+  AfterFunctionDefinitionName: false
+  AfterFunctionDeclarationName: false
+  AfterIfMacros:   false
+  AfterOverloadedOperator: false
+  BeforeNonEmptyParentheses: false
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard:        c++03
+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
+...
+

application.fam

@@ -10,8 +10,8 @@ App(
     ],
     stack_size=2 * 1024,
     order=10,
-    fap_libs=["assets"],
     fap_icon="icons/boilerplate_10px.png",
     fap_icon_assets="icons",
     fap_category="Misc",
+    fap_version="1.0",
 )

boilerplate.c

@@ -23,7 +23,7 @@ Boilerplate* boilerplate_app_alloc() {
     Boilerplate* app = malloc(sizeof(Boilerplate));
     app->gui = furi_record_open(RECORD_GUI);
     app->notification = furi_record_open(RECORD_NOTIFICATION);
-    
+
     //Turn backlight on, believe me this makes testing your app easier
     notification_message(app->notification, &sequence_display_backlight_on);
 
@@ -33,9 +33,12 @@ Boilerplate* boilerplate_app_alloc() {
 
     app->scene_manager = scene_manager_alloc(&boilerplate_scene_handlers, app);
     view_dispatcher_set_event_callback_context(app->view_dispatcher, app);
-    view_dispatcher_set_navigation_event_callback(app->view_dispatcher, boilerplate_navigation_event_callback);
-    view_dispatcher_set_tick_event_callback(app->view_dispatcher, boilerplate_tick_event_callback, 100);
-    view_dispatcher_set_custom_event_callback(app->view_dispatcher, boilerplate_custom_event_callback);
+    view_dispatcher_set_navigation_event_callback(
+        app->view_dispatcher, boilerplate_navigation_event_callback);
+    view_dispatcher_set_tick_event_callback(
+        app->view_dispatcher, boilerplate_tick_event_callback, 100);
+    view_dispatcher_set_custom_event_callback(
+        app->view_dispatcher, boilerplate_custom_event_callback);
     app->submenu = submenu_alloc();
 
     // Set defaults, in case no config loaded
@@ -51,18 +54,32 @@ Boilerplate* boilerplate_app_alloc() {
     // Load configs
     boilerplate_read_settings(app);
 
-    view_dispatcher_add_view(app->view_dispatcher, BoilerplateViewIdMenu, submenu_get_view(app->submenu));
+    view_dispatcher_add_view(
+        app->view_dispatcher, BoilerplateViewIdMenu, submenu_get_view(app->submenu));
     app->boilerplate_startscreen = boilerplate_startscreen_alloc();
-    view_dispatcher_add_view(app->view_dispatcher, BoilerplateViewIdStartscreen, boilerplate_startscreen_get_view(app->boilerplate_startscreen));
+    view_dispatcher_add_view(
+        app->view_dispatcher,
+        BoilerplateViewIdStartscreen,
+        boilerplate_startscreen_get_view(app->boilerplate_startscreen));
     app->boilerplate_scene_1 = boilerplate_scene_1_alloc();
-    view_dispatcher_add_view(app->view_dispatcher, BoilerplateViewIdScene1, boilerplate_scene_1_get_view(app->boilerplate_scene_1));
+    view_dispatcher_add_view(
+        app->view_dispatcher,
+        BoilerplateViewIdScene1,
+        boilerplate_scene_1_get_view(app->boilerplate_scene_1));
     app->boilerplate_scene_2 = boilerplate_scene_2_alloc();
-    view_dispatcher_add_view(app->view_dispatcher, BoilerplateViewIdScene2, boilerplate_scene_2_get_view(app->boilerplate_scene_2));
+    view_dispatcher_add_view(
+        app->view_dispatcher,
+        BoilerplateViewIdScene2,
+        boilerplate_scene_2_get_view(app->boilerplate_scene_2));
     app->button_menu = button_menu_alloc();
-    view_dispatcher_add_view(app->view_dispatcher, BoilerplateViewIdScene3, button_menu_get_view(app->button_menu));
-    
+    view_dispatcher_add_view(
+        app->view_dispatcher, BoilerplateViewIdScene3, button_menu_get_view(app->button_menu));
+
     app->variable_item_list = variable_item_list_alloc();
-    view_dispatcher_add_view(app->view_dispatcher, BoilerplateViewIdSettings, variable_item_list_get_view(app->variable_item_list));
+    view_dispatcher_add_view(
+        app->view_dispatcher,
+        BoilerplateViewIdSettings,
+        variable_item_list_get_view(app->variable_item_list));
 
     //End Scene Additions
 
@@ -71,7 +88,7 @@ Boilerplate* boilerplate_app_alloc() {
 
 void boilerplate_app_free(Boilerplate* app) {
     furi_assert(app);
-    
+
     // Scene manager
     scene_manager_free(app->scene_manager);
 
@@ -84,7 +101,7 @@ void boilerplate_app_free(Boilerplate* app) {
 
     view_dispatcher_free(app->view_dispatcher);
     furi_record_close(RECORD_GUI);
-    
+
     app->gui = NULL;
     app->notification = NULL;
 
@@ -99,23 +116,21 @@ void boilerplate_app_free(Boilerplate* app) {
 int32_t boilerplate_app(void* p) {
     UNUSED(p);
     Boilerplate* app = boilerplate_app_alloc();
-    
+
     view_dispatcher_attach_to_gui(app->view_dispatcher, app->gui, ViewDispatcherTypeFullscreen);
-    
-    scene_manager_next_scene(app->scene_manager, BoilerplateSceneStartscreen); //Start with start screen
+
+    scene_manager_next_scene(
+        app->scene_manager, BoilerplateSceneStartscreen); //Start with start screen
     //scene_manager_next_scene(app->scene_manager, BoilerplateSceneMenu); //if you want to directly start with Menu
 
     furi_hal_power_suppress_charge_enter();
 
     view_dispatcher_run(app->view_dispatcher);
 
     boilerplate_save_settings(app);
-    
+
     furi_hal_power_suppress_charge_exit();
     boilerplate_app_free(app);
 
     return 0;
 }
-
-
-

boilerplate.h

@@ -5,7 +5,6 @@
 #include <gui/gui.h>
 #include <input/input.h>
 #include <stdlib.h>
-#include <assets_icons.h>
 #include <dialogs/dialogs.h>
 #include <notification/notification_messages.h>
 #include <gui/view_dispatcher.h>
@@ -19,6 +18,7 @@
 #include "views/boilerplate_scene_1.h"
 #include "views/boilerplate_scene_2.h"
 #include "helpers/boilerplate_storage.h"
+#include "boilerplate_icons.h"
 
 #define TAG "Boilerplate"
 
@@ -37,7 +37,7 @@ typedef struct {
     BoilerplateScene2* boilerplate_scene_2;
     DialogsApp* dialogs; // File Browser
     FuriString* file_path; // File Browser
-    uint32_t haptic; 
+    uint32_t haptic;
     uint32_t speaker;
     uint32_t led;
     uint32_t save_settings;

docs/README.md

@@ -0,0 +1,19 @@
+## Boilerplate
+
+Boilerplate for a Flipper Zero application, you can use this code as a starting point for developing your own app. 
+### Features
+- Start Screen
+- Menu
+- Button Menu
+- File Browser
+- Different Scenes / Views
+- Settings Page (On/Off for haptics, sound, led)
+- Handling of Button Inputs
+- Handling of Tick events
+- Handling of Enter/Exit events
+- Rendering to GUI
+- Haptic Feedback 
+- Sound Effects
+- LED Effects
+- Dolphin Deeds (make dolphin happy)
+- Storage (Saves settings)

docs/changelog.md

@@ -0,0 +1,5 @@
+## 1.0
+- Added versioning
+- Fixed icon dependency for full support of ufbt and custom firmware compilations
+- Added Changelog and docs
+- Code formatting updated

helpers/boilerplate_custom_event.h

@@ -41,7 +41,8 @@ static inline uint32_t boilerplate_custom_menu_event_pack(uint16_t type, int16_t
     BoilerplateCustomEventMenu event = {.content = {.type = type, .value = value}};
     return event.packed_value;
 }
-static inline void boilerplate_custom_menu_event_unpack(uint32_t packed_value, uint16_t* type, int16_t* value) {
+static inline void
+    boilerplate_custom_menu_event_unpack(uint32_t packed_value, uint16_t* type, int16_t* value) {
     BoilerplateCustomEventMenu event = {.packed_value = packed_value};
     if(type) *type = event.content.type;
     if(value) *value = event.content.value;