Format files and add linter (#202)

* format files

* remove prints

Author: abenso

.github/workflows/lint.yml

@@ -0,0 +1,51 @@
+name: Lint and format 💅
+
+on:
+  workflow_dispatch:
+  push:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            build-essential \
+            cmake \
+            clang-format \
+            clang-tidy
+
+      - name: Lint and format 💅
+        uses: cpp-linter/cpp-linter-action@v2
+        id: linter
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          file-annotations: true
+          files-changed-only: false
+          ignore: "build|.github|cmake|fuzzing|.vscode|.idea"
+          step-summary: true
+          style: file # uses .clang-format
+          thread-comments: true
+          tidy-checks: "-*" # disable clang-tidy, only use clang-format
+          format-review-errors: false # ignore parsing errors, only check formatting
+
+      - name: Fail if errors
+        if: ${{ steps.linter.outputs['checks-failed'] > 0 }}
+        run: |
+          echo "Linter or formatter failed!"
+          exit 1

Makefile

@@ -1,7 +1,7 @@
 # Simple Makefile for zxlib tests
 # Wrapper around CMake build system
 
-.PHONY: all build test clean test-verbose test-filter
+.PHONY: all build test clean test-verbose test-filter format
 
 # Default target
 all: build
@@ -26,4 +26,7 @@ test-verbose: build
 
 # Run specific test
 test-filter: build
-	cd build && ./zxlib_tests --gtest_filter="$(FILTER)"
+	cd build && ./zxlib_tests --gtest_filter="$(FILTER)"
+
+format:
+	find src evm tests include app \( -iname '*.h' -o -iname '*.c' -o -iname '*.cpp' -o -iname '*.hpp' \) | xargs clang-format -i

app/ui/view.c

@@ -60,20 +60,15 @@ void view_review_init(viewfunc_getItem_t viewfuncGetItem, viewfunc_getNumItems_t
 #if defined(TARGET_NANOS) || defined(TARGET_NANOS2) || defined(TARGET_NANOX)
     viewdata.with_confirmation = false;
 #endif
-
 }
 
-void view_review_init_progressive(
-    viewfunc_getItem_t viewfuncGetItem,
-    viewfunc_getNumItems_t viewfuncGetNumItems,
-    viewfunc_accept_t viewfuncAccept) {
-
+void view_review_init_progressive(viewfunc_getItem_t viewfuncGetItem, viewfunc_getNumItems_t viewfuncGetNumItems,
+                                  viewfunc_accept_t viewfuncAccept) {
     view_review_init(viewfuncGetItem, viewfuncGetNumItems, viewfuncAccept);
 
 #if defined(TARGET_NANOS) || defined(TARGET_NANOS2) || defined(TARGET_NANOX)
     viewdata.with_confirmation = true;
 #endif
-
 }
 
 void view_initialize_init(viewfunc_initialize_t viewFuncInit) { viewdata.viewfuncInitialize = viewFuncInit; }

app/ui/view.h

@@ -120,10 +120,8 @@ void view_blindsign_error_show();
 void view_review_init(viewfunc_getItem_t viewfuncGetItem, viewfunc_getNumItems_t viewfuncGetNumItems,
                       viewfunc_accept_t viewfuncAccept);
 
-void view_review_init_progressive(
-    viewfunc_getItem_t viewfuncGetItem,
-    viewfunc_getNumItems_t viewfuncGetNumItems,
-    viewfunc_accept_t viewfuncAccept);
+void view_review_init_progressive(viewfunc_getItem_t viewfuncGetItem, viewfunc_getNumItems_t viewfuncGetNumItems,
+                                  viewfunc_accept_t viewfuncAccept);
 
 void view_inspect_init(viewfunc_getInnerItem_t view_funcGetInnerItem, viewfunc_getNumItems_t view_funcGetInnerNumItems,
                        viewfunc_canInspectItem_t view_funcCanInspectItem);
@@ -150,4 +148,4 @@ typedef enum {
 } settings_list_e;
 
 void view_set_switch_subtext(settings_list_e switch_id, const char *subtext);
-#endif // TARGET_STAX || TARGET_FLEX
+#endif  // TARGET_STAX || TARGET_FLEX

app/ui/view_inspect_x.c

@@ -1,25 +1,25 @@
 /*******************************************************************************
-*   (c) 2018 - 2023 Zondax AG
-*
-*  Licensed under the Apache License, Version 2.0 (the "License");
-*  you may not use this file except in compliance with the License.
-*  You may obtain a copy of the License at
-*
-*      http://www.apache.org/licenses/LICENSE-2.0
-*
-*  Unless required by applicable law or agreed to in writing, software
-*  distributed under the License is distributed on an "AS IS" BASIS,
-*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-*  See the License for the specific language governing permissions and
-*  limitations under the License.
-********************************************************************************/
+ *   (c) 2018 - 2023 Zondax AG
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ ********************************************************************************/
 #include "bolos_target.h"
 
 #if defined(TARGET_NANOX) || defined(TARGET_NANOS2)
 #include "view_internal.h"
+#include "view_nano.h"
 #include "view_nano_inspect.h"
 #include "view_templates.h"
-#include "view_nano.h"
 #include "zxmacros.h"
 
 extern const ux_flow_step_t *ux_review_flow[MAX_REVIEW_UX_SCREENS];
@@ -38,18 +38,22 @@ uint8_t flow_inside_inspect_loop;
 extern unsigned int review_type;
 
 // Menu to recursively inspect elements from a transaction
-UX_STEP_VALID(ux_inspect_flow_root_step, pb, h_rootTxn(), { &C_icon_back, "Go to root" });
+UX_STEP_VALID(ux_inspect_flow_root_step, pb, h_rootTxn(), {&C_icon_back, "Go to root"});
 
 UX_STEP_INIT(ux_inspect_flow_start_step, NULL, NULL, { h_inspect_loop_start(); });
-UX_STEP_CB_INIT(ux_inspect_flow_step, bnnn_paging, h_inspect_loop_inside(), h_inspect(), { .title = viewdata.key, .text = viewdata.value, });
+UX_STEP_CB_INIT(ux_inspect_flow_step, bnnn_paging, h_inspect_loop_inside(), h_inspect(),
+                {
+                    .title = viewdata.key,
+                    .text = viewdata.value,
+                });
 
 UX_STEP_INIT(ux_inspect_flow_end_step, NULL, NULL, { h_inspect_loop_end(); });
 
-UX_STEP_VALID(ux_inspect_flow_back_step, pb, h_back(), { &C_icon_back, "BACK" });
+UX_STEP_VALID(ux_inspect_flow_back_step, pb, h_back(), {&C_icon_back, "BACK"});
 
-void view_inspect_show_impl(){
+void view_inspect_show_impl() {
     // h_inspect_loop_inside();
-    if(G_ux.stack_count == 0) {
+    if (G_ux.stack_count == 0) {
         ux_stack_push();
     }
 
@@ -65,24 +69,23 @@ void view_inspect_show_impl(){
 }
 
 void inspect_init() {
-    #ifdef HAVE_INSPECT
-        h_inspect_init();
-        if (!viewdata.viewfuncCanInspectItem(viewdata.innerField.level,
-                                            viewdata.innerField.trace,
-                                            viewdata.innerField.paging.itemIdx)) {
-            h_rootTxn();
-            return;
-        }
+#ifdef HAVE_INSPECT
+    h_inspect_init();
+    if (!viewdata.viewfuncCanInspectItem(viewdata.innerField.level, viewdata.innerField.trace,
+                                         viewdata.innerField.paging.itemIdx)) {
+        h_rootTxn();
+        return;
+    }
 
-        const zxerr_t err = h_inspect_update_data();
-        if (err != zxerr_ok) {
-            // Show error
-            view_error_show();
-            // h_rootTxn();
-            return;
-        }
-        view_inspect_show_impl();
-    #endif
+    const zxerr_t err = h_inspect_update_data();
+    if (err != zxerr_ok) {
+        // Show error
+        view_error_show();
+        // h_rootTxn();
+        return;
+    }
+    view_inspect_show_impl();
+#endif
 }
 
 void h_inspect() {
@@ -93,9 +96,8 @@ void h_inspect() {
 
     // Check if we can inspect this element
     if (viewdata.innerField.level >= MAX_DEPTH ||
-        !viewdata.viewfuncCanInspectItem(viewdata.innerField.level+1,
-                                        viewdata.innerField.trace,
-                                        viewdata.innerField.paging.itemIdx)) {
+        !viewdata.viewfuncCanInspectItem(viewdata.innerField.level + 1, viewdata.innerField.trace,
+                                         viewdata.innerField.paging.itemIdx)) {
         flow_inside_inspect_loop = 0;
         h_inspect_update_data();
         view_inspect_show_impl();
@@ -190,7 +192,7 @@ void h_inspect_loop_end() {
     }
 
     ux_layout_bnnn_paging_reset();
-    CUR_FLOW.prev_index = CUR_FLOW.index-2;
+    CUR_FLOW.prev_index = CUR_FLOW.index - 2;
     CUR_FLOW.index--;
     ux_flow_relayout();
 }

app/ui/view_nano.h

@@ -1,25 +1,26 @@
 /*******************************************************************************
-*   (c) 2018 - 2024 Zondax AG
-*
-*  Licensed under the Apache License, Version 2.0 (the "License");
-*  you may not use this file except in compliance with the License.
-*  You may obtain a copy of the License at
-*
-*      http://www.apache.org/licenses/LICENSE-2.0
-*
-*  Unless required by applicable law or agreed to in writing, software
-*  distributed under the License is distributed on an "AS IS" BASIS,
-*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-*  See the License for the specific language governing permissions and
-*  limitations under the License.
-********************************************************************************/
+ *   (c) 2018 - 2024 Zondax AG
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ ********************************************************************************/
 #pragma once
-#include "bolos_target.h"
 #include <stdint.h>
 
+#include "bolos_target.h"
+
 #if defined(TARGET_NANOS)
 #define INCLUDE_ACTIONS_AS_ITEMS 2
-#define INCLUDE_ACTIONS_COUNT (INCLUDE_ACTIONS_AS_ITEMS-1)
+#define INCLUDE_ACTIONS_COUNT (INCLUDE_ACTIONS_AS_ITEMS - 1)
 typedef uint8_t max_char_display;
 #else
 #define INCLUDE_ACTIONS_COUNT 0

app/ui/view_nano_inspect.c

@@ -1,25 +1,25 @@
 /*******************************************************************************
-*   (c) 2018 - 2023 Zondax AG
-*
-*  Licensed under the Apache License, Version 2.0 (the "License");
-*  you may not use this file except in compliance with the License.
-*  You may obtain a copy of the License at
-*
-*      http://www.apache.org/licenses/LICENSE-2.0
-*
-*  Unless required by applicable law or agreed to in writing, software
-*  distributed under the License is distributed on an "AS IS" BASIS,
-*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-*  See the License for the specific language governing permissions and
-*  limitations under the License.
-********************************************************************************/
+ *   (c) 2018 - 2023 Zondax AG
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ ********************************************************************************/
 #include "bolos_target.h"
 
 #if defined(TARGET_NANOS) || defined(TARGET_NANOS2) || defined(TARGET_NANOX)
-#include "view_nano_inspect.h"
 #include "view_internal.h"
-#include "view_templates.h"
 #include "view_nano.h"
+#include "view_nano_inspect.h"
+#include "view_templates.h"
 #include "zxmacros.h"
 
 void h_inspect_init() {
@@ -33,22 +33,20 @@ void h_inspect_init() {
     viewdata.innerField.paging.itemCount = 0xFF;
 }
 
-void view_inspect_init(viewfunc_getInnerItem_t view_funcGetInnerItem,
-                       viewfunc_getNumItems_t view_funcGetInnerNumItems,
+void view_inspect_init(viewfunc_getInnerItem_t view_funcGetInnerItem, viewfunc_getNumItems_t view_funcGetInnerNumItems,
                        viewfunc_canInspectItem_t view_funcCanInspectItem) {
     viewdata.viewfuncGetInnerItem = view_funcGetInnerItem;
     viewdata.viewfuncGetInnerNumItems = view_funcGetInnerNumItems;
     viewdata.viewfuncCanInspectItem = view_funcCanInspectItem;
 }
 
 bool h_paging_inspect_go_to_root_screen() {
-    return (viewdata.innerField.paging.itemIdx == 0)
-           && (viewdata.innerField.trace[0] != 0);
+    return (viewdata.innerField.paging.itemIdx == 0) && (viewdata.innerField.trace[0] != 0);
 }
 
 bool h_paging_inspect_back_screen() {
-    return (viewdata.innerField.paging.itemIdx == (viewdata.innerField.paging.itemCount - 1))
-            && (viewdata.innerField.trace[0] != 0);
+    return (viewdata.innerField.paging.itemIdx == (viewdata.innerField.paging.itemCount - 1)) &&
+           (viewdata.innerField.trace[0] != 0);
 }
 
 bool h_can_increase(paging_t *paging, uint8_t actionsCount) {
@@ -137,15 +135,15 @@ zxerr_t h_inspect_update_data() {
     viewdata.innerField.paging.itemCount += 2;
     viewdata.innerField.paging.pageCount = 1;
     if (h_paging_inspect_go_to_root_screen()) {
-        snprintf(viewdata.key, MAX_CHARS_PER_KEY_LINE, "%s","");
+        snprintf(viewdata.key, MAX_CHARS_PER_KEY_LINE, "%s", "");
         snprintf(viewdata.value, MAX_CHARS_PER_VALUE1_LINE, "%s", "Go to root");
         splitValueField();
         page.pageIdx = 0;
         return zxerr_ok;
     }
 
     if (h_paging_inspect_back_screen()) {
-        snprintf(viewdata.key, MAX_CHARS_PER_KEY_LINE, "%s","");
+        snprintf(viewdata.key, MAX_CHARS_PER_KEY_LINE, "%s", "");
         snprintf(viewdata.value, MAX_CHARS_PER_VALUE1_LINE, "%s", "BACK");
         splitValueField();
         page.pageIdx = 0;
@@ -165,10 +163,7 @@ zxerr_t h_inspect_update_data() {
         .pageCount = &viewdata.innerField.paging.pageCount,
     };
 
-    CHECK_ZXERR(viewdata.viewfuncGetInnerItem(
-                            viewdata.innerField.level,
-                            viewdata.innerField.trace,
-                            &thisItem))
+    CHECK_ZXERR(viewdata.viewfuncGetInnerItem(viewdata.innerField.level, viewdata.innerField.trace, &thisItem))
 
     return zxerr_ok;
 }