pre-commit: code formatter fixes

.pre-commit-config.yaml

@@ -21,6 +21,6 @@ repos:
         language: system
     -   id: formatting
         name: Formatting
-        entry: sh -c "git diff --staged --name-only | xargs python3 tools/codeformat.py"
+        entry: python3 tools/codeformat.py
         types_or: [c, python]
         language: system

BUILDING.md

@@ -85,3 +85,23 @@ Example:
 
 If your port/build includes `arm-none-eabi-gdb-py`, consider using it instead, as it can be used for better register
 debugging with https://github.com/bnahill/PyCortexMDebug
+
+# Code Quality Checks
+
+We apply code quality checks using pre-commit.  Install pre-commit once per system with
+
+    python3 -mpip install pre-commit
+
+Activate it once per git clone with
+
+    pre-commit --install
+
+Pre-commit also requires some additional programs to be installed through your package manager:
+
+ * Standard Unix tools such as make, find, etc
+ * The gettext package, any modern version
+ * uncrustify version 0.71 (0.72 is also tested)
+
+Each time you create a git commit, the pre-commit quality checks will be run.  You can also run them e.g., with `pre-commit run foo.c` or `pre-commit run --all` to run on all files whether modified or not.
+
+Some pre-commit quality checks require your active attention to resolve, others (such as the formatting checks of uncrustify) are made automatically and must simply be incorporated into your code changes by committing them.

ports/atmel-samd/eic_handler.c

@@ -29,7 +29,7 @@
 #include "common-hal/rotaryio/IncrementalEncoder.h"
 #include "common-hal/countio/Counter.h"
 #include "shared-bindings/microcontroller/__init__.h"
-//#include "samd/external_interrupts.h"
+// #include "samd/external_interrupts.h"
 #include "eic_handler.h"
 
 // Which handler should be called for a particular channel?
@@ -42,31 +42,31 @@ void set_eic_handler(uint8_t channel, uint8_t eic_handler) {
 void shared_eic_handler(uint8_t channel) {
     uint8_t handler = eic_channel_handler[channel];
     switch (handler) {
-#if CIRCUITPY_PULSEIO
-    case EIC_HANDLER_PULSEIN:
-        pulsein_interrupt_handler(channel);
-        break;
-#endif
+        #if CIRCUITPY_PULSEIO
+        case EIC_HANDLER_PULSEIN:
+            pulsein_interrupt_handler(channel);
+            break;
+        #endif
 
-#if CIRCUITPY_PS2IO
-    case EIC_HANDLER_PS2:
-        ps2_interrupt_handler(channel);
-        break;
-#endif
+        #if CIRCUITPY_PS2IO
+        case EIC_HANDLER_PS2:
+            ps2_interrupt_handler(channel);
+            break;
+        #endif
 
-#if CIRCUITPY_ROTARYIO
-    case EIC_HANDLER_INCREMENTAL_ENCODER:
-        incrementalencoder_interrupt_handler(channel);
-        break;
-#endif
+        #if CIRCUITPY_ROTARYIO
+        case EIC_HANDLER_INCREMENTAL_ENCODER:
+            incrementalencoder_interrupt_handler(channel);
+            break;
+        #endif
 
-#if CIRCUITPY_COUNTIO
-    case EIC_HANDLER_COUNTER:
-        counter_interrupt_handler(channel);
-        break;
-#endif
+        #if CIRCUITPY_COUNTIO
+        case EIC_HANDLER_COUNTER:
+            counter_interrupt_handler(channel);
+            break;
+        #endif
 
-    default:
-        break;
+        default:
+            break;
     }
 }

ports/atmel-samd/fatfs_port.c

@@ -35,14 +35,14 @@
 #endif
 
 DWORD get_fattime(void) {
-#if CIRCUITPY_RTC
+    #if CIRCUITPY_RTC
     timeutils_struct_time_t tm;
     common_hal_rtc_get_time(&tm);
     return ((tm.tm_year - 1980) << 25) | (tm.tm_mon << 21) | (tm.tm_mday << 16) |
-           (tm.tm_hour << 11)          | (tm.tm_min << 5)  | (tm.tm_sec >> 1);
-#else
+           (tm.tm_hour << 11) | (tm.tm_min << 5) | (tm.tm_sec >> 1);
+    #else
     return ((2016 - 1980) << 25) | ((9) << 21) | ((1) << 16) | ((16) << 11) | ((43) << 5) | (35 / 2);
-#endif
+    #endif
 
 
 }

ports/atmel-samd/ld_defines.c

@@ -9,22 +9,22 @@
 // The next line is a marker to start looking for definitions. Lines above the next line are ignored.
 // START_LD_DEFINES
 
-/*RAM_SIZE=*/                                       RAM_SIZE;
-/*FLASH_SIZE=*/                                     FLASH_SIZE;
+/*RAM_SIZE=*/ RAM_SIZE;
+/*FLASH_SIZE=*/ FLASH_SIZE;
 
-/*BOOTLOADER_SIZE=*/                                BOOTLOADER_SIZE;
-/*BOOTLOADER_START_ADDR=*/                          BOOTLOADER_START_ADDR;
+/*BOOTLOADER_SIZE=*/ BOOTLOADER_SIZE;
+/*BOOTLOADER_START_ADDR=*/ BOOTLOADER_START_ADDR;
 
-/*CIRCUITPY_DEFAULT_STACK_SIZE=*/                   CIRCUITPY_DEFAULT_STACK_SIZE;
+/*CIRCUITPY_DEFAULT_STACK_SIZE=*/ CIRCUITPY_DEFAULT_STACK_SIZE;
 
-/*CIRCUITPY_FIRMWARE_START_ADDR=*/                  CIRCUITPY_FIRMWARE_START_ADDR;
-/*CIRCUITPY_FIRMWARE_SIZE=*/                        CIRCUITPY_FIRMWARE_SIZE;
+/*CIRCUITPY_FIRMWARE_START_ADDR=*/ CIRCUITPY_FIRMWARE_START_ADDR;
+/*CIRCUITPY_FIRMWARE_SIZE=*/ CIRCUITPY_FIRMWARE_SIZE;
 
-/*CIRCUITPY_INTERNAL_CONFIG_START_ADDR=*/           CIRCUITPY_INTERNAL_CONFIG_START_ADDR;
-/*CIRCUITPY_INTERNAL_CONFIG_SIZE=*/                 CIRCUITPY_INTERNAL_CONFIG_SIZE;
+/*CIRCUITPY_INTERNAL_CONFIG_START_ADDR=*/ CIRCUITPY_INTERNAL_CONFIG_START_ADDR;
+/*CIRCUITPY_INTERNAL_CONFIG_SIZE=*/ CIRCUITPY_INTERNAL_CONFIG_SIZE;
 
-/*CIRCUITPY_INTERNAL_NVM_START_ADDR=*/              CIRCUITPY_INTERNAL_NVM_START_ADDR;
-/*CIRCUITPY_INTERNAL_NVM_SIZE=*/                    CIRCUITPY_INTERNAL_NVM_SIZE;
+/*CIRCUITPY_INTERNAL_NVM_START_ADDR=*/ CIRCUITPY_INTERNAL_NVM_START_ADDR;
+/*CIRCUITPY_INTERNAL_NVM_SIZE=*/ CIRCUITPY_INTERNAL_NVM_SIZE;
 
 /*CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_START_ADDR=*/ CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_START_ADDR;
-/*CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE=*/       CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE;
+/*CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE=*/ CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE;

ports/atmel-samd/mpconfigport.h

@@ -38,7 +38,7 @@
 
 // HMCRAMC0_SIZE is defined in the ASF4 include files for each SAMD21 chip.
 #define RAM_SIZE                                    HMCRAMC0_SIZE
-#define BOOTLOADER_SIZE                             (8*1024)
+#define BOOTLOADER_SIZE                             (8 * 1024)
 #define CIRCUITPY_MCU_FAMILY                        samd21
 #define MICROPY_PY_SYS_PLATFORM                     "Atmel SAMD21"
 #define SPI_FLASH_MAX_BAUDRATE 8000000
@@ -67,7 +67,7 @@
 
 // HSRAM_SIZE is defined in the ASF4 include files for each SAM_D5X_E5X chip.
 #define RAM_SIZE                                    HSRAM_SIZE
-#define BOOTLOADER_SIZE                             (16*1024)
+#define BOOTLOADER_SIZE                             (16 * 1024)
 #define CIRCUITPY_MCU_FAMILY                        samd51
 #ifdef SAMD51
 #define MICROPY_PY_SYS_PLATFORM                     "MicroChip SAMD51"
@@ -96,7 +96,7 @@
 #ifdef SAMD21
 
 #if INTERNAL_FLASH_FILESYSTEM
-#define CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE (64*1024)
+#define CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE (64 * 1024)
 #else
 #define CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE (0)
 #endif
@@ -131,7 +131,7 @@
 #endif
 
 #ifndef CIRCUITPY_DEFAULT_STACK_SIZE
-#define CIRCUITPY_DEFAULT_STACK_SIZE                (24*1024)
+#define CIRCUITPY_DEFAULT_STACK_SIZE                (24 * 1024)
 #endif
 
 #ifndef SAMD5x_E5x_BOD33_LEVEL
@@ -148,7 +148,7 @@
 // If CIRCUITPY is internal, use half of flash for it.
 #if INTERNAL_FLASH_FILESYSTEM
   #ifndef CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE
-    #define CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE (FLASH_SIZE/2)
+    #define CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE (FLASH_SIZE / 2)
   #endif
 #else
   #define CIRCUITPY_INTERNAL_FLASH_FILESYSTEM_SIZE (0)

ports/atmel-samd/mphalport.c

@@ -56,15 +56,15 @@ extern uint32_t common_hal_mcu_processor_get_frequency(void);
 // Testing done at 48 MHz on SAMD21 and 120 MHz on SAMD51, multiplication and division cancel out.
 // But get the frequency just in case.
 #ifdef SAMD21
-#define DELAY_LOOP_ITERATIONS_PER_US ( (10U*48000000U) / common_hal_mcu_processor_get_frequency())
+#define DELAY_LOOP_ITERATIONS_PER_US ((10U * 48000000U) / common_hal_mcu_processor_get_frequency())
 #endif
 #ifdef SAM_D5X_E5X
-#define DELAY_LOOP_ITERATIONS_PER_US ( (30U*120000000U) / common_hal_mcu_processor_get_frequency())
+#define DELAY_LOOP_ITERATIONS_PER_US ((30U * 120000000U) / common_hal_mcu_processor_get_frequency())
 #endif
 
 void mp_hal_delay_us(mp_uint_t delay) {
-    for (uint32_t i = delay*DELAY_LOOP_ITERATIONS_PER_US; i > 0; i--) {
-        asm volatile("nop");
+    for (uint32_t i = delay * DELAY_LOOP_ITERATIONS_PER_US; i > 0; i--) {
+        asm volatile ("nop");
     }
 }
 

ports/atmel-samd/mphalport.h

@@ -34,7 +34,7 @@
 #include "supervisor/shared/tick.h"
 
 // Global millisecond tick count (driven by SysTick interrupt).
-#define mp_hal_ticks_ms()       ((mp_uint_t) supervisor_ticks_ms32())
+#define mp_hal_ticks_ms()       ((mp_uint_t)supervisor_ticks_ms32())
 
 // Number of bytes in receive buffer
 extern volatile uint8_t usb_rx_count;

ports/atmel-samd/timer_handler.c

@@ -49,31 +49,31 @@ void shared_timer_handler(bool is_tc, uint8_t index) {
     // Make sure to add the handler #define to timer_handler.h
     if (is_tc) {
         uint8_t handler = tc_handler[index];
-        switch(handler) {
+        switch (handler) {
             case TC_HANDLER_PULSEIN:
-            #if CIRCUITPY_PULSEIO
+                #if CIRCUITPY_PULSEIO
                 pulsein_timer_interrupt_handler(index);
-            #endif
+                #endif
                 break;
             case TC_HANDLER_PULSEOUT:
-            #if CIRCUITPY_PULSEIO
+                #if CIRCUITPY_PULSEIO
                 pulseout_interrupt_handler(index);
-            #endif
+                #endif
                 break;
             case TC_HANDLER_PEW:
-            #if CIRCUITPY_PEW
+                #if CIRCUITPY_PEW
                 pewpew_interrupt_handler(index);
-            #endif
+                #endif
                 break;
             case TC_HANDLER_FREQUENCYIN:
-            #if CIRCUITPY_FREQUENCYIO
+                #if CIRCUITPY_FREQUENCYIO
                 frequencyin_interrupt_handler(index);
-            #endif
+                #endif
                 break;
             case TC_HANDLER_RGBMATRIX:
-            #if CIRCUITPY_RGBMATRIX
+                #if CIRCUITPY_RGBMATRIX
                 _PM_IRQ_HANDLER();
-            #endif
+                #endif
                 break;
             default:
                 break;

ports/cxd56/background.c

@@ -30,6 +30,9 @@
 #include "supervisor/filesystem.h"
 #include "supervisor/shared/stack.h"
 
-void port_background_task(void) {}
-void port_start_background_task(void) {}
-void port_finish_background_task(void) {}
+void port_background_task(void) {
+}
+void port_start_background_task(void) {
+}
+void port_finish_background_task(void) {
+}

tools/codeformat.py

@@ -27,8 +27,10 @@
 
 import argparse
 import glob
+import fnmatch
 import itertools
 import os
+import pathlib
 import re
 import subprocess
 
@@ -75,12 +77,13 @@
 PY_EXTS = (".py",)
 
 
-def list_files(paths, exclusions=None, prefix=""):
+def list_files(args, paths, exclusions=None, prefix=""):
     files = set()
+    args = [os.path.join(prefix, arg) for arg in args]
     for pattern in paths:
-        files.update(glob.glob(os.path.join(prefix, pattern), recursive=True))
+        files.update(arg for arg in args if pathlib.Path(arg).match(pattern))
     for pattern in exclusions or []:
-        files.difference_update(glob.fnmatch.filter(files, os.path.join(prefix, pattern)))
+        files.difference_update(fnmatch.filter(files, os.path.join(prefix, pattern)))
     return sorted(files)
 
 
@@ -96,6 +99,10 @@ def fixup_c(filename):
             # Get next line.
             l = lines.pop(0)
 
+            # Revert "// |" back to "//| "
+            if l.startswith("// |"):
+                l = "//|" + l[4:]
+
             # Dedent #'s to match indent of following line (not previous line).
             m = re.match(r"( +)#(if |ifdef |ifndef |elif |else|endif)", l)
             if m:
@@ -128,23 +135,19 @@ def fixup_c(filename):
 
 
 def main():
-    cmd_parser = argparse.ArgumentParser(description="Auto-format C and Python files.")
+    cmd_parser = argparse.ArgumentParser(description="Auto-format C and Python files -- to be used via pre-commit only.")
     cmd_parser.add_argument("-c", action="store_true", help="Format C code only")
     cmd_parser.add_argument("-p", action="store_true", help="Format Python code only")
     cmd_parser.add_argument("-v", action="store_true", help="Enable verbose output")
-    cmd_parser.add_argument("files", nargs="*", help="Run on specific globs")
+    cmd_parser.add_argument("files", nargs="+", help="Run on specific globs")
     args = cmd_parser.parse_args()
 
     # Setting only one of -c or -p disables the other. If both or neither are set, then do both.
     format_c = args.c or not args.p
     format_py = args.p or not args.c
 
-    # Expand the globs passed on the command line, or use the default globs above.
-    files = []
-    if args.files:
-        files = list_files(args.files)
-    else:
-        files = list_files(PATHS, EXCLUSIONS, TOP)
+    # Expand the arguments passed on the command line, subject to the PATHS and EXCLUSIONS
+    files = list_files(args.files, PATHS, EXCLUSIONS, TOP)
 
     # Extract files matching a specific language.
     def lang_files(exts):
@@ -168,11 +171,6 @@ def batch(cmd, files, N=200):
         batch(command, lang_files(C_EXTS))
         for file in lang_files(C_EXTS):
             fixup_c(file)
-        # Revert "// |" back to "//|"
-        subprocess.call(
-            "find shared-bindings ports/*/bindings -name '*.c' -exec sed -i 's/\/ |/\/|/' {} \;",
-            shell=True,
-        )
 
     # Format Python files with black.
     if format_py: