From 24faed33cd25ada7b6dcfae818b8aabc92d61088 Mon Sep 17 00:00:00 2001 From: MDW Date: Sun, 17 Dec 2023 16:19:46 +0100 Subject: [PATCH 1/8] QUAL Beautify shell scripts (#121) --- tools/generate_include_src.sh | 44 ++++++++++++++++----------------- tools/update_rtl_433_devices.sh | 26 +++++++++---------- 2 files changed, 35 insertions(+), 35 deletions(-) diff --git a/tools/generate_include_src.sh b/tools/generate_include_src.sh index d36f5c01..c4bd0ce6 100755 --- a/tools/generate_include_src.sh +++ b/tools/generate_include_src.sh @@ -10,17 +10,17 @@ echo rm include_copy_list include_copy_and_edit_list src_copy_and_edit_list src_copy_list for i in `ls ../include/ | grep -v rtl_433_devices.h | grep -v "^log.h"` do - echo - # echo "Checking " $i - diff ../include/$i ../rtl_433/include/$i >> /dev/null - retVal=$? -if [ $retVal -ne 0 ]; then - echo "File "$i "was changed" - echo $i >> include_copy_and_edit_list -else - echo "File "$i "was not changed" - echo $i >> include_copy_list -fi + echo + # echo "Checking " $i + diff ../include/$i ../rtl_433/include/$i >> /dev/null + retVal=$? + if [ $retVal -ne 0 ]; then + echo "File "$i "was changed" + echo $i >> include_copy_and_edit_list + else + echo "File "$i "was not changed" + echo $i >> include_copy_list + fi done echo @@ -32,15 +32,15 @@ ls ../src/rtl_433 | grep -v devices echo for i in `ls ../src/rtl_433 | grep -v devices` do - echo - echo "Checking " $i - diff ../src/rtl_433/$i ../rtl_433/src/$i >> /dev/null - retVal=$? -if [ $retVal -ne 0 ]; then - echo "File "$i "was changed" - echo $i >> src_copy_and_edit_list -else - echo "File "$i "was not changed" - echo $i >> src_copy_list -fi + echo + echo "Checking " $i + diff ../src/rtl_433/$i ../rtl_433/src/$i >> /dev/null + retVal=$? + if [ $retVal -ne 0 ]; then + echo "File "$i "was changed" + echo $i >> src_copy_and_edit_list + else + echo "File "$i "was not changed" + echo $i >> src_copy_list + fi done \ No newline at end of file diff --git a/tools/update_rtl_433_devices.sh b/tools/update_rtl_433_devices.sh index 232b84e1..c18681b5 100755 --- a/tools/update_rtl_433_devices.sh +++ b/tools/update_rtl_433_devices.sh @@ -8,7 +8,7 @@ rm copy.list devices.list decoder.fragment ( cd .. ; rm -rf rtl_433 ; git clone https://github.com/merbanan/rtl_433 ) ( cd ../rtl_433/src/devices/ ; egrep "\.name|\.modulation|\.decode_fn|^r_device " *.c ) |\ -awk -f device.awk | awk -F : '{ print $1 }' | sort | uniq > copy.list + awk -f device.awk | awk -F : '{ print $1 }' | sort | uniq > copy.list echo "Clone from rtl_433 complete" @@ -22,14 +22,14 @@ echo "flex.c" >> copy.list for i in `cat copy.list` do -cp ../rtl_433/src/devices/$i ../src/rtl_433/devices + cp ../rtl_433/src/devices/$i ../src/rtl_433/devices done echo "Device decoders updated" for i in `ls ../contrib/` do -cp ../contrib/$i ../src/rtl_433/devices + cp ../contrib/$i ../src/rtl_433/devices done echo "Contrib decoders updated" @@ -44,7 +44,7 @@ echo "Contrib decoders updated" for i in blueline.c secplus_v2.c do -rm ../src/rtl_433/devices/$i + rm ../src/rtl_433/devices/$i done echo "Problematic decoders removed" @@ -60,7 +60,7 @@ echo $OOK_COUNT "OOK Decoders are copied" echo $FSK_COUNT "OOK Decoders are copied" cat devices.list | awk -f device.awk | awk -F\" '{ print $3 }' | \ -awk -F, '{ print $3 }' | awk '{ print " DECL("$1") \\" }' > rtl_433_devices.fragment + awk -F, '{ print $3 }' | awk '{ print " DECL("$1") \\" }' > rtl_433_devices.fragment echo " /* Add new decoders here. */" >> rtl_433_devices.fragment @@ -80,12 +80,12 @@ echo "" >> decoder.fragment echo "if (rtl_433_ESP::ookModulation) {" >> decoder.fragment cat devices.list | awk -f device.awk | egrep ${OOK_MODULATION} | awk -F\" '{ print $3 }' | \ -awk -F, '{ print $3 }' | awk '{ print " memcpy(&cfg->devices["NR-1"], &"$1", sizeof(r_device));" }' >> decoder.fragment + awk -F, '{ print $3 }' | awk '{ print " memcpy(&cfg->devices["NR-1"], &"$1", sizeof(r_device));" }' >> decoder.fragment echo "} else {" >> decoder.fragment cat devices.list | awk -f device.awk | egrep ${FSK_MODULATION} | awk -F\" '{ print $3 }' | \ -awk -F, '{ print $3 }' | awk '{ print " memcpy(&cfg->devices["NR-1"], &"$1", sizeof(r_device));" }' >> decoder.fragment + awk -F, '{ print $3 }' | awk '{ print " memcpy(&cfg->devices["NR-1"], &"$1", sizeof(r_device));" }' >> decoder.fragment echo "}" >> decoder.fragment echo "" >> decoder.fragment @@ -100,15 +100,15 @@ echo "Copying src files" echo for i in `cat src_copy_list` do - echo "Copying rtl_433/src "$i" to src/rtl_433" - cp ../rtl_433/src/$i ../src/rtl_433 + echo "Copying rtl_433/src "$i" to src/rtl_433" + cp ../rtl_433/src/$i ../src/rtl_433 done echo echo "These src files need copying and updating" echo for i in `cat src_copy_and_edit_list` do - echo "cp ../rtl_433/src/"$i" ../src/rtl_433" + echo "cp ../rtl_433/src/"$i" ../src/rtl_433" done # copy include files from rtl_433/include to include @@ -118,13 +118,13 @@ echo "Copying include files" echo for i in `cat include_copy_list` do - echo "Copying rtl_433/include "$i" to include" - cp ../rtl_433/include/$i ../include + echo "Copying rtl_433/include "$i" to include" + cp ../rtl_433/include/$i ../include done echo echo "These include files need copying and updating" echo for i in `cat include_copy_and_edit_list` do - echo "cp ../rtl_433/include/"$i" ../include" + echo "cp ../rtl_433/include/"$i" ../include" done From eb8225837dfcf8f85ed979b4bf70829d079b4a22 Mon Sep 17 00:00:00 2001 From: MDW Date: Sun, 17 Dec 2023 16:21:33 +0100 Subject: [PATCH 2/8] QUAL Annotate README sections (#119) --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e1b34851..dfb040a2 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The initial port implements only enables a subset of the available modulations a ### OOK -``` +```plaintext OOK_MC_ZEROBIT OOK_PULSE_DMC OOK_PULSE_MANCHESTER_ZEROBIT @@ -29,7 +29,7 @@ OOK_PULSE_RZ ### FSK -``` +```plaintext FSK_PULSE_MANCHESTER_ZEROBIT FSK_PULSE_PCM FSK_PULSE_PWM @@ -40,7 +40,7 @@ FSK_PULSE_PWM ### OOK Signal Device Decoders -``` +```plaintext Registering protocol [0] "Amazon Basics Meat Thermometer" Registering protocol [1] "Acurite 896 Rain Gauge" Registering protocol [2] "Acurite 609TXC Temperature and Humidity Sensor" @@ -182,7 +182,7 @@ The gaps in the numbers are device decoders disabled by default. ### FSK Signal Device Decoders -``` +```plaintext Registering protocol [0] "Ambient Weather WH31E Thermo-Hygrometer Sensor, EcoWitt WH40 rain gauge" Registering protocol [2] "TBH weather sensor" Registering protocol [3] "Badger ORION water meter, 100kbps (-f 916.45M -s 1200k)" @@ -328,7 +328,7 @@ The first approach is what is recommended in the SX127X datasheet, and the secon # Compile definition options -``` +```plaintext DEMOD_DEBUG ; enable verbose debugging of signal processing DEVICE_DEBUG ; Validate fields are mapped to response object ( rtl_433 ) MEMORY_DEBUG ; display heap usage information @@ -351,58 +351,75 @@ OOK_MODULATION ; Enable OOK Device Decoders, setting to false enables FSK ## RF Module Wiring +```plaintext ONBOARD_LED ; GPIO pin to toggle during signal reception ( Typically onboard LED ) +``` ### SX1276 Module Options +```plaintext RF_SX1276 ; Enable support for SX1276 Transceiver OOK_FIXED_THRESHOLD ; Inital OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90 AUTOOOKFIX ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals +``` ### SX1276 Module Wiring ( Required if not using standard configuraton ) +```plaintext RF_MODULE_CS ; SX1276 SPI Chip select RF_MODULE_DIO0 ; SX1276 DIO0 PIN RF_MODULE_RST ; SX1276 RST PIN RF_MODULE_DIO1 ; SX1276 DIO1 PIN +``` ### SX1278 Module Options +```plaintext RF_SX1278 - Enable support for SX1276 OOK_FIXED_THRESHOLD ; Inital OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90 AUTOOOKFIX ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals +``` ### SX1278 Module Wiring ( Required if not using standard configuraton ) +```plaintext RF_MODULE_CS ; SX1278 SPI Chip select RF_MODULE_DIO0 ; SX1278 DIO0 PIN RF_MODULE_RST ; SX1278 RST PIN RF_MODULE_DIO1 ; SX1278 DIO1 PIN +``` ### CC1101 Module Options +```plaintext RF_CC1101 ; Enable support for CC1101 Transceiver NO_DEAF_WORKAROUND ; Workaround for issue #16 ( by default the workaround is enabaled ) +``` ### CC1101 Module Wiring +```plaintext RF_MODULE_CS ; CC1101 SPI Chip select RF_MODULE_GDO0 ; CC1101 GDOO PIN RF_MODULE_GDO2 ; CC1101 GDO2 PIN +``` ## RF Module SPI Wiring ( Required if not using standard configuraton ) When using a non standard SPI configuration ( Standard config is SCK - 18, MISO - 19, MOSI - 23, CS - 5) +```plaintext RF_MODULE_SCK ; SPI Clock RF_MODULE_MISO ; SPI Serial Output RF_MODULE_MOSI ; SPI Serial Input RF_MODULE_CS ; SPI Chip select +``` ## Porting approach Copying src files +```plaintext Copying rtl_433/src abuf.c to src/rtl_433 Copying rtl_433/src bitbuffer.c to src/rtl_433 Copying rtl_433/src compat_time.c to src/rtl_433 @@ -414,15 +431,19 @@ Copying rtl_433/src output_log.c to src/rtl_433 Copying rtl_433/src pulse_data.c to src/rtl_433 Copying rtl_433/src r_util.c to src/rtl_433 Copying rtl_433/src util.c to src/rtl_433 +``` These src files need copying and updating +```shell cp ../rtl_433/src/pulse_analyzer.c ../src/rtl_433 cp ../rtl_433/src/pulse_slicer.c ../src/rtl_433 cp ../rtl_433/src/r_api.c ../src/rtl_433 +``` Copying include files +```plaintext Copying rtl_433/include abuf.h to include Copying rtl_433/include bitbuffer.h to include Copying rtl_433/include compat_time.h to include @@ -441,19 +462,22 @@ Copying rtl_433/include r_device.h to include Copying rtl_433/include r_util.h to include Copying rtl_433/include rfraw.h to include Copying rtl_433/include util.h to include +``` These include files need copying and updating +```shell cp ../rtl_433/include/data.h ../include cp ../rtl_433/include/pulse_data.h ../include cp ../rtl_433/include/r_private.h ../include cp ../rtl_433/include/rtl_433.h ../include +``` ## Codebase conflicts * ESPiLight and rtl_433 conflict on silvercrest -``` +```plaintext .platformio/packages/toolchain-xtensa32/bin/../lib/gcc/xtensa-esp32-elf/5.2.0/../../../../xtensa-esp32-elf/bin/ld: Warning: size of symbol `silvercrest' changed from 4 in .pio/build/rtl_433-9e0770/libb28/libESPiLight.a(protocol.c.o) to 76 in .pio/build/rtl_433-9e0770/lib395/librtl_433_ESP.a(silvercrest.c.o) ``` From 3e67dcd7649a11a14c859ef2d43924091696e1a9 Mon Sep 17 00:00:00 2001 From: MDW Date: Sun, 17 Dec 2023 16:23:35 +0100 Subject: [PATCH 3/8] Correct spelling in files (#120) --- README.md | 14 +++++++------- include/rtl_433.h | 2 +- src/rtl_433_ESP.cpp | 12 ++++++------ src/rtl_433_ESP.h | 12 ++++++------ src/signalDecoder.cpp | 4 ++-- tools/update_rtl_433_devices.sh | 2 +- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index dfb040a2..085cdf5f 100644 --- a/README.md +++ b/README.md @@ -322,7 +322,7 @@ The RSSI Threshold for signal detection is automatically determined based on the For background see section 2.1.3.2. of SX127X Data sheet -To tune the SX127X OOK RSSI FIXED Threshold two values are used to determine if the threhold needs to be increased or decreased. The first is the noise recevied between signals. If the number of noise bits received between signals is greater than 100, then the threshold is incremented. Second is the unparsed signals. If an unparsed signal is received, but it has less than 20 pulses, the threhold is decremented. +To tune the SX127X OOK RSSI FIXED Threshold two values are used to determine if the threshold needs to be increased or decreased. The first is the noise received between signals. If the number of noise bits received between signals is greater than 100, then the threshold is incremented. Second is the unparsed signals. If an unparsed signal is received, but it has less than 20 pulses, the threshold is decremented. The first approach is what is recommended in the SX127X datasheet, and the second is a control to lower the threshold if it is too high and incomplete signals are received. @@ -359,11 +359,11 @@ ONBOARD_LED ; GPIO pin to toggle during signal reception ( Typically o ```plaintext RF_SX1276 ; Enable support for SX1276 Transceiver -OOK_FIXED_THRESHOLD ; Inital OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90 +OOK_FIXED_THRESHOLD ; Initial OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90 AUTOOOKFIX ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals ``` -### SX1276 Module Wiring ( Required if not using standard configuraton ) +### SX1276 Module Wiring ( Required if not using standard configuration ) ```plaintext RF_MODULE_CS ; SX1276 SPI Chip select @@ -376,11 +376,11 @@ RF_MODULE_DIO1 ; SX1276 DIO1 PIN ```plaintext RF_SX1278 - Enable support for SX1276 -OOK_FIXED_THRESHOLD ; Inital OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90 +OOK_FIXED_THRESHOLD ; Initial OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90 AUTOOOKFIX ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals ``` -### SX1278 Module Wiring ( Required if not using standard configuraton ) +### SX1278 Module Wiring ( Required if not using standard configuration ) ```plaintext RF_MODULE_CS ; SX1278 SPI Chip select @@ -404,7 +404,7 @@ RF_MODULE_GDO0 ; CC1101 GDOO PIN RF_MODULE_GDO2 ; CC1101 GDO2 PIN ``` -## RF Module SPI Wiring ( Required if not using standard configuraton ) +## RF Module SPI Wiring ( Required if not using standard configuration ) When using a non standard SPI configuration ( Standard config is SCK - 18, MISO - 19, MOSI - 23, CS - 5) @@ -501,5 +501,5 @@ January 2023 * [RTL 433 ON ESP32 DEVICE - MQTT HOME ASSISTANT](https://youtube.com/watch?v=H-JXWbWjJYE&feature=shares) * [Using low-cost wireless sensors in the unlicensed bands](https://lwn.net/Articles/921497/) -Febuary 2023 +February 2023 * [OpenMQTTGateway Connects Many Things to Your Home Automation](https://www.youtube.com/watch?v=_gdXR1uklaY) diff --git a/include/rtl_433.h b/include/rtl_433.h index c47e32b3..a2160314 100644 --- a/include/rtl_433.h +++ b/include/rtl_433.h @@ -140,7 +140,7 @@ typedef struct r_cfg { int bufferSize; // size of message buffer for message callback /** * callback to controlling program to be executed when a message is received. - * Object point passsed is a pointer to a JSON formatted message for + * Object point passed is a pointer to a JSON formatted message for * publishing. */ void (*callback)(char *message); diff --git a/src/rtl_433_ESP.cpp b/src/rtl_433_ESP.cpp index 0b23124f..b5e62f24 100644 --- a/src/rtl_433_ESP.cpp +++ b/src/rtl_433_ESP.cpp @@ -59,10 +59,10 @@ Module* _mod = radio.getMod(); #define rtl_433_ReceiverTask_Priority 2 #define rtl_433_ReceiverTask_Core 0 -/*----------------------------- Initalize variables -----------------------------*/ +/*----------------------------- Initialize variables -----------------------------*/ /** - * Is the receiver currently receving a signal + * Is the receiver currently receiving a signal */ static bool receiveMode = false; @@ -131,7 +131,7 @@ rtl_433_ESP::rtl_433_ESP() { } /** - * @brief Initalize Transceiver and rtl_433 decoders + * @brief Initialize Transceiver and rtl_433 decoders * * @param inputPin - GPIO of receiver * @param receiveFrequency - receive frequency @@ -164,7 +164,7 @@ void rtl_433_ESP::initReceiver(byte inputPin, float receiveFrequency) { newSPI.begin(RF_MODULE_SCK, RF_MODULE_MISO, RF_MODULE_MOSI, RF_MODULE_CS); #endif - /*----------------------------- Initalize Transceiver -----------------------------*/ + /*----------------------------- Initialize Transceiver -----------------------------*/ #ifdef RF_CC1101 int state = radio.begin(); @@ -413,7 +413,7 @@ void rtl_433_ESP::resetReceiver() { } /** - * @brief Enable signal reciever logic + * @brief Enable signal receiver logic * * @param inputPin */ @@ -607,7 +607,7 @@ void rtl_433_ESP::rtl_433_ReceiverTask(void* pvParameters) { totalSignals++; if ((_nrpulses > PD_MIN_PULSES) && ((signalEnd - signalStart) > - MINIMUM_SIGNAL_LENGTH)) // Minumum signal length of MINIMUM_SIGNAL_LENGTH MS + MINIMUM_SIGNAL_LENGTH)) // Minimum signal length of MINIMUM_SIGNAL_LENGTH MS { _pulseTrains[_actualPulseTrain].num_pulses = _nrpulses + 1; _pulseTrains[_actualPulseTrain].signalDuration = diff --git a/src/rtl_433_ESP.h b/src/rtl_433_ESP.h index e1a3770e..4349c270 100644 --- a/src/rtl_433_ESP.h +++ b/src/rtl_433_ESP.h @@ -86,7 +86,7 @@ # define OOK_MODULATION true #endif -// signals shorter than this are ignored in interupt handler +// signals shorter than this are ignored in interrupt handler #if OOK_MODULATION # define MINIMUM_PULSE_LENGTH 50 @@ -223,7 +223,7 @@ #endif /** - * message - JSON formated message from device + * message - JSON formatted message from device */ typedef void (*rtl_433_ESPCallBack)(char* message); @@ -252,13 +252,13 @@ class rtl_433_ESP { * callback function signature * * (char *message) - * message - JSON formated message from device + * message - JSON formatted message from device */ void setCallback(rtl_433_ESPCallBack callback, char* messageBuffer, int bufferSize); /** - * Set minumum RSSI value for receiver + * Set minimum RSSI value for receiver */ void setRSSIThreshold(int); @@ -280,7 +280,7 @@ class rtl_433_ESP { static void initReceiver(byte inputPin, float receiveFrequency); /** - * Enable pulse receiver interupt and logic + * Enable pulse receiver interrupt and logic */ static void enableReceiver(); @@ -408,7 +408,7 @@ class rtl_433_ESP { /** * Get last received PulseTrain. - * Returns: last PulseTrain or 0 if not avaiable + * Returns: last PulseTrain or 0 if not available */ static int receivePulseTrain(); diff --git a/src/signalDecoder.cpp b/src/signalDecoder.cpp index 345c7ffb..f78d8511 100644 --- a/src/signalDecoder.cpp +++ b/src/signalDecoder.cpp @@ -65,7 +65,7 @@ void rtlSetup() { logprintfLn(LOG_DEBUG, "sizeof(cfg) %d, heap %d", sizeof(cfg), ESP.getFreeHeap()); #endif - cfg->conversion_mode = CONVERT_SI; // Default all output to Celcius + cfg->conversion_mode = CONVERT_SI; // Default all output to Celsius if (rtl_433_ESP::ookModulation) { cfg->num_r_devices = NUMOF_OOK_DEVICES; } else { @@ -324,7 +324,7 @@ void rtlSetup() { memcpy(&cfg->devices[79], &tpms_truck, sizeof(r_device)); } - // end of fragement + // end of fragment #else memcpy(&cfg->devices[0], &lacrosse_tx141x, sizeof(r_device)); diff --git a/tools/update_rtl_433_devices.sh b/tools/update_rtl_433_devices.sh index c18681b5..7551aedc 100755 --- a/tools/update_rtl_433_devices.sh +++ b/tools/update_rtl_433_devices.sh @@ -89,7 +89,7 @@ cat devices.list | awk -f device.awk | egrep ${FSK_MODULATION} | awk -F\" '{ pri echo "}" >> decoder.fragment echo "" >> decoder.fragment -echo " // end of fragement" >> decoder.fragment +echo " // end of fragment" >> decoder.fragment echo echo "Please update src/signalDecoder.cpp with decoder.fragment" From be71d74e274eb6807be10048a58c92e8148423db Mon Sep 17 00:00:00 2001 From: MDW Date: Sun, 17 Dec 2023 16:24:12 +0100 Subject: [PATCH 4/8] Add pre-commit flow (#106) --- .pre-commit-config.yaml | 121 +++ pyproject.toml | 18 + uncrustify.cfg | 1579 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 1718 insertions(+) create mode 100644 .pre-commit-config.yaml create mode 100644 pyproject.toml create mode 100644 uncrustify.cfg diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..f634c61c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,121 @@ +--- +files: ^(.*\.(py|json|md|sh|yaml|txt|h|hpp|c|cpp)|setup.cfg)$ +exclude: + (?x)^( + .cache/.*| + src/rtl_433/.*| + contrib/.*| + .*\.xml| + .*\.hex + )$ +repos: + - repo: https://github.com/executablebooks/mdformat + # Do this before other tools "fixing" the line endings + rev: 0.7.17 + hooks: + - id: mdformat + stages: [manual] + name: Format Markdown + entry: mdformat # Executable to run, with fixed options + language: python + types: [markdown] + args: [--wrap, '75', --number] + additional_dependencies: + - mdformat-toc + - mdformat-gfm + # - mdformat-beautysh + # - mdformat-shfmt + # - mdformat-tables + # - mdformat-config + # - mdformat-black + # - mdformat-web + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + # - id: no-commit-to-branch + # args: [--branch, main] + - id: debug-statements + - id: end-of-file-fixer + exclude_types: [markdown] + - id: trailing-whitespace + exclude_types: [markdown] + # - id: check-json + - id: mixed-line-ending + - id: check-builtin-literals + # - id: check-ast + - id: check-merge-conflict + - id: check-executables-have-shebangs + - id: check-shebang-scripts-are-executable + - id: check-docstring-first + - id: fix-byte-order-marker + - id: check-case-conflict + # - id: check-toml + # + - repo: https://github.com/lovesegfault/beautysh.git + rev: v6.2.1 + hooks: + - id: beautysh + - repo: https://github.com/codespell-project/codespell + rev: v2.2.5 + hooks: + - id: codespell + exclude: ^((src/rtl_433/|signals/|example/).*)$ + args: + - --toml + - pyproject.toml + - --ignore-words-list=mot + # - -w # Correct in-place + additional_dependencies: + - tomli + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + # - id: no-commit-to-branch + # args: [--branch, main] + - id: debug-statements + - id: end-of-file-fixer + - id: trailing-whitespace + # - id: check-json + - id: mixed-line-ending + - id: check-builtin-literals + # - id: check-ast + - id: check-merge-conflict + - id: check-executables-have-shebangs + - id: check-shebang-scripts-are-executable + - id: check-docstring-first + - id: fix-byte-order-marker + - id: check-case-conflict + - id: check-toml + - repo: https://github.com/pocc/pre-commit-hooks + rev: v1.3.5 + # Install dependencies on windows: + # choco install llvm uncrustify cppcheck + hooks: + - id: clang-format + files: (?x)(^src/.*|include/rtl_433_devices.h|./include/log.h) + exclude: (?x)^(src/rtl_433/.*)$ + args: [-i] + - id: cppcheck + files: (?x)(^src/.*|include/rtl_433_devices.h|./include/log.h) + exclude: (?x)^(src/rtl_433/.*)$ + args: + - --check-config + - --force + #- --std=c99 + #- --language=c + #- -IInc + - '--template={file}({line}): {severity} ({id}): {message}' + #exclude: (SevenSegment_defs.h|stm32[^/]*|sysmem\.*)$ + - id: cpplint + files: (?x)(^src/.*|include/rtl_433_devices.h|./include/log.h) + exclude: (?x)^(src/rtl_433/.*)$ + args: ["--filter=-build/header_guard,-whitespace/comma,-whitespace/indent,-whitespace/comments,-whitespace/line_length,-whitespace/braces,-whitespace/newline,-whitespace/blank_line,-whitespace/todo,-build/include_subdir,-readability/braces,-readability/fn_size,-readability/todo,-legal/copyright"] + exclude: (example/.*)$ + additional_dependencies: + - cpplint + - repo: https://github.com/shellcheck-py/shellcheck-py + rev: v0.9.0.5 + hooks: + - id: shellcheck + files: ^[^\.].*\.sh$ + args: [-x,-eSC2086,-eSC2045,-eSC2010,-eSC2027,-eSC2164,-eSC2013,-eSC2035,-eSC2006,-eSC2002,-eSC2196,-eSC2129] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..d8013fa6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,18 @@ +[build-system] +requires = ["setuptools>=61.2"] +build-backend = "setuptools.build_meta" + +[project] +dynamic = ["version"] + +[tool.codespell] +ignore-words-list = """ +stdio,master,ws,hsa,proove +""" +skip = """./.*,3rdparty,*/.metadata,*.xml,*.qrc""" +quiet-level=2 +ignore-regex = '\\[fnrstv]' +builtin = "clear,rare,informal,usage,code,names" + +[tool.setuptools] +include-package-data = false diff --git a/uncrustify.cfg b/uncrustify.cfg new file mode 100644 index 00000000..7b2ceedf --- /dev/null +++ b/uncrustify.cfg @@ -0,0 +1,1579 @@ +# Uncrustify 0.60 + +# +# General options +# + +# The type of line endings +newlines = auto # auto/lf/crlf/cr + +# The original size of tabs in the input +input_tab_size = 1 # number + +# The size of tabs in the output (only used if align_with_tabs=true) +output_tab_size = 4 # number + +# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn) +string_escape_char = 92 # number + +# Alternate string escape char for Pawn. Only works right before the quote char. +string_escape_char2 = 0 # number + +# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list>=val);'. +# If true (default), 'assert(x<0 && y>=3)' will be broken. +# Improvements to template detection may make this option obsolete. +tok_split_gte = false # false/true + +# Control what to do with the UTF-8 BOM (recommend 'remove') +utf8_bom = ignore # ignore/add/remove/force + +# If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8 +utf8_byte = true # false/true + +# Force the output encoding to UTF-8 +utf8_force = true # false/true + +# +# Indenting +# + +# The number of columns to indent per level. +# Usually 2, 3, 4, or 8. +indent_columns = 4 # number + +# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents. +# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level +indent_continue = 0 # number + +# How to use tabs when indenting code +# 0=spaces only +# 1=indent with tabs to brace level, align with spaces +# 2=indent and align with tabs, using spaces when not on a tabstop +indent_with_tabs = 0 # number + +# Comments that are not a brace level are indented with tabs on a tabstop. +# Requires indent_with_tabs=2. If false, will use spaces. +indent_cmt_with_tabs = false # false/true + +# Whether to indent strings broken by '\' so that they line up +indent_align_string = false # false/true + +# The number of spaces to indent multi-line XML strings. +# Requires indent_align_string=True +indent_xml_string = 0 # number + +# Spaces to indent '{' from level +indent_brace = 0 # number + +# Whether braces are indented to the body level +indent_braces = true # false/true + +# Disabled indenting function braces if indent_braces is true +indent_braces_no_func = true # false/true + +# Disabled indenting class braces if indent_braces is true +indent_braces_no_class = false # false/true + +# Disabled indenting struct braces if indent_braces is true +indent_braces_no_struct = false # false/true + +# Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc. +indent_brace_parent = false # false/true + +# Whether the 'namespace' body is indented +indent_namespace = false # false/true + +# The number of spaces to indent a namespace block +indent_namespace_level = 0 # number + +# If the body of the namespace is longer than this number, it won't be indented. +# Requires indent_namespace=true. Default=0 (no limit) +indent_namespace_limit = 0 # number + +# Whether the 'extern "C"' body is indented +indent_extern = false # false/true + +# Whether the 'class' body is indented +indent_class = true # false/true + +# Whether to indent the stuff after a leading class colon +indent_class_colon = true # false/true + +# Virtual indent from the ':' for member initializers. Default is 2 +indent_ctor_init_leading = 2 # number + +# forceitional indenting for constructor initializer list +indent_ctor_init = 0 # number + +# False=treat 'else\nif' as 'else if' for indenting purposes +# True=indent the 'if' one level +indent_else_if = false # false/true + +# Amount to indent variable declarations after a open brace. neg=relative, pos=absolute +indent_var_def_blk = 0 # number + +# Indent continued variable declarations instead of aligning. +indent_var_def_cont = false # false/true + +# True: force indentation of function definition to start in column 1 +# False: use the default behavior +indent_func_def_force_col1 = false # false/true + +# True: indent continued function call parameters one indent level +# False: align parameters under the open paren +indent_func_call_param = true # false/true + +# Same as indent_func_call_param, but for function defs +indent_func_def_param = true # false/true + +# Same as indent_func_call_param, but for function protos +indent_func_proto_param = true # false/true + +# Same as indent_func_call_param, but for class declarations +indent_func_class_param = true # false/true + +# Same as indent_func_call_param, but for class variable constructors +indent_func_ctor_var_param = true # false/true + +# Same as indent_func_call_param, but for templates +indent_template_param = true # false/true + +# Double the indent for indent_func_xxx_param options +indent_func_param_double = false # false/true + +# Indentation column for standalone 'const' function decl/proto qualifier +indent_func_const = 0 # number + +# Indentation column for standalone 'throw' function decl/proto qualifier +indent_func_throw = 0 # number + +# The number of spaces to indent a continued '->' or '.' +# Usually set to 0, 1, or indent_columns. +indent_member = 0 # number + +# Spaces to indent single line ('//') comments on lines before code +indent_single_line_comments_before = 0 # number + +# If set, will indent trailing single line ('//') comments relative +# to the code instead of trying to keep the same absolute column +indent_relative_single_line_comments = false # false/true + +# Spaces to indent 'case' from 'switch' +# Usually 0 or indent_columns. +indent_switch_case = 0 # number + +# Spaces to shift the 'case' line, without affecting any other lines +# Usually 0. +indent_case_shift = 0 # number + +# Spaces to indent '{' from 'case'. +# By default, the brace will appear under the 'c' in case. +# Usually set to 0 or indent_columns. +indent_case_brace = 0 # number + +# Whether to indent comments found in first column +indent_col1_comment = false # false/true + +# How to indent goto labels +# >0 : absolute column where 1 is the leftmost column +# <=0 : subtract from brace indent +indent_label = 1 # number + +# Same as indent_label, but for access specifiers that are followed by a colon +indent_access_spec = 1 # number + +# Indent the code after an access specifier by one level. +# If set, this option forces 'indent_access_spec=0' +indent_access_spec_body = true # false/true + +# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended) +indent_paren_nl = false # false/true + +# Controls the indent of a close paren after a newline. +# 0: Indent to body level +# 1: Align under the open paren +# 2: Indent to the brace level +indent_paren_close = 0 # number + +# Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren +indent_comma_paren = 0 # false/true + +# Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren +indent_bool_paren = 0 + +# If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones +indent_first_bool_expr = false # false/true + +# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended) +indent_square_nl = false # false/true + +# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies +indent_preserve_sql = false # false/true + +# Align continued statements at the '='. Default=True +# If FALSE or the '=' is followed by a newline, the next line is indent one tab. +indent_align_assign = true # false/true + +# Indent OC blocks at brace level instead of usual rules. +indent_oc_block = false # false/true + +# Indent OC blocks in a message relative to the parameter name. +# 0=use indent_oc_block rules, 1+=spaces to indent +indent_oc_block_msg = 0 # number + +# Minimum indent for subsequent parameters +indent_oc_msg_colon = 0 # number + +# +# Spacing options +# + +# force or remove space around arithmetic operator '+', '-', '/', '*', etc +sp_arith = force # ignore/add/remove/force + +# force or remove space around assignment operator '=', '+=', etc +sp_assign = force # ignore/add/remove/force + +# force or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign +sp_cpp_lambda_assign = force # ignore/add/remove/force + +# force or remove space after the capture specification in C++11 lambda. +sp_cpp_lambda_square_paren = force # ignore/add/remove/force + +# force or remove space around assignment operator '=' in a prototype +sp_assign_default = force # ignore/add/remove/force + +# force or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. +sp_before_assign = force # ignore/add/remove/force + +# force or remove space after assignment operator '=', '+=', etc. Overrides sp_assign. +sp_after_assign = force # ignore/add/remove/force + +# force or remove space around assignment '=' in enum +sp_enum_assign = force # ignore/add/remove/force + +# force or remove space before assignment '=' in enum. Overrides sp_enum_assign. +sp_enum_before_assign = force # ignore/add/remove/force + +# force or remove space after assignment '=' in enum. Overrides sp_enum_assign. +sp_enum_after_assign = force # ignore/add/remove/force + +# force or remove space around preprocessor '##' concatenation operator. Default=Add +sp_pp_concat = force # ignore/add/remove/force + +# force or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator. +sp_pp_stringify = force # ignore/add/remove/force + +# force or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'. +sp_before_pp_stringify = force # ignore/add/remove/force + +# force or remove space around boolean operators '&&' and '||' +sp_bool = force # ignore/add/remove/force + +# force or remove space around compare operator '<', '>', '==', etc +sp_compare = force # ignore/add/remove/force + +# force or remove space inside '(' and ')' +sp_inside_paren = remove # ignore/add/remove/force + +# force or remove space between nested parens +sp_paren_paren = remove # ignore/add/remove/force + +# Whether to balance spaces inside nested parens +sp_balance_nested_parens = false # false/true + +# force or remove space between ')' and '{' +sp_paren_brace = force # ignore/add/remove/force + +# force or remove space before pointer star '*' +sp_before_ptr_star = force # ignore/add/remove/force + +# force or remove space before pointer star '*' that isn't followed by a variable name +# If set to 'ignore', sp_before_ptr_star is used instead. +sp_before_unnamed_ptr_star = force # ignore/add/remove/force + +# force or remove space between pointer stars '*' +sp_between_ptr_star = remove # ignore/add/remove/force + +# force or remove space after pointer star '*', if followed by a word. +sp_after_ptr_star = remove # ignore/add/remove/force + +# force or remove space after a pointer star '*', if followed by a func proto/def. +sp_after_ptr_star_func = remove # ignore/add/remove/force + +# force or remove space after a pointer star '*', if followed by an open paren (function types). +sp_ptr_star_paren = remove # ignore/add/remove/force + +# force or remove space before a pointer star '*', if followed by a func proto/def. +sp_before_ptr_star_func = remove # ignore/add/remove/force + +# force or remove space before a reference sign '&' +sp_before_byref = force # ignore/add/remove/force + +# force or remove space before a reference sign '&' that isn't followed by a variable name +# If set to 'ignore', sp_before_byref is used instead. +sp_before_unnamed_byref = force # ignore/add/remove/force + +# force or remove space after reference sign '&', if followed by a word. +sp_after_byref = remove # ignore/add/remove/force + +# force or remove space after a reference sign '&', if followed by a func proto/def. +sp_after_byref_func = remove # ignore/add/remove/force + +# force or remove space before a reference sign '&', if followed by a func proto/def. +sp_before_byref_func = remove # ignore/add/remove/force + +# force or remove space between type and word. Default=Force +sp_after_type = force # ignore/add/remove/force + +# force or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('. +sp_before_template_paren = ignore # ignore/add/remove/force + +# force or remove space in 'template <' vs 'template<'. +# If set to ignore, sp_before_angle is used. +sp_template_angle = remove # ignore/add/remove/force + +# force or remove space before '<>' +sp_before_angle = remove # ignore/add/remove/force + +# force or remove space inside '<' and '>' +sp_inside_angle = remove # ignore/add/remove/force + +# force or remove space after '<>' +sp_after_angle = force # ignore/add/remove/force + +# force or remove space between '<>' and '(' as found in 'new List();' +sp_angle_paren = remove # ignore/add/remove/force + +# force or remove space between '<>' and a word as in 'List m;' +sp_angle_word = force # ignore/add/remove/force + +# force or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add +sp_angle_shift = force # ignore/add/remove/force + +# Permit removal of the space between '>>' in 'foo >' (C++11 only). Default=False +# sp_angle_shift cannot remove the space without this option. +sp_permit_cpp11_shift = false # false/true + +# force or remove space before '(' of 'if', 'for', 'switch', and 'while' +sp_before_sparen = force # ignore/add/remove/force + +# force or remove space inside if-condition '(' and ')' +sp_inside_sparen = remove # ignore/add/remove/force + +# force or remove space before if-condition ')'. Overrides sp_inside_sparen. +sp_inside_sparen_close = remove # ignore/add/remove/force + +# force or remove space before if-condition '('. Overrides sp_inside_sparen. +sp_inside_sparen_open = remove # ignore/add/remove/force + +# force or remove space after ')' of 'if', 'for', 'switch', and 'while' +sp_after_sparen = force # ignore/add/remove/force + +# force or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while' +sp_sparen_brace = force # ignore/add/remove/force + +# force or remove space between 'invariant' and '(' in the D language. +sp_invariant_paren = force # ignore/add/remove/force + +# force or remove space after the ')' in 'invariant (C) c' in the D language. +sp_after_invariant_paren = force # ignore/add/remove/force + +# force or remove space before empty statement ';' on 'if', 'for' and 'while' +sp_special_semi = remove # ignore/add/remove/force + +# force or remove space before ';'. Default=Remove +sp_before_semi = remove # ignore/add/remove/force + +# force or remove space before ';' in non-empty 'for' statements +sp_before_semi_for = remove # ignore/add/remove/force + +# force or remove space before a semicolon of an empty part of a for statement. +sp_before_semi_for_empty = remove # ignore/add/remove/force + +# force or remove space after ';', except when followed by a comment. Default=Add +sp_after_semi = force # ignore/add/remove/force + +# force or remove space after ';' in non-empty 'for' statements. Default=Force +sp_after_semi_for = force # ignore/add/remove/force + +# force or remove space after the final semicolon of an empty part of a for statement: for ( ; ; ). +sp_after_semi_for_empty = remove # ignore/add/remove/force + +# force or remove space before '[' (except '[]') +sp_before_square = remove # ignore/add/remove/force + +# force or remove space before '[]' +sp_before_squares = remove # ignore/add/remove/force + +# force or remove space inside a non-empty '[' and ']' +sp_inside_square = remove # ignore/add/remove/force + +# force or remove space after ',' +sp_after_comma = force # ignore/add/remove/force + +# force or remove space before ',' +sp_before_comma = remove # ignore/add/remove/force + +# force or remove space between an open paren and comma: '(,' vs '( ,' +sp_paren_comma = force # ignore/add/remove/force + +# force or remove space before the variadic '...' when preceded by a non-punctuator +sp_before_ellipsis = remove # ignore/add/remove/force + +# force or remove space after class ':' +sp_after_class_colon = force # ignore/add/remove/force + +# force or remove space before class ':' +sp_before_class_colon = force # ignore/add/remove/force + +# force or remove space before case ':'. Default=Remove +sp_before_case_colon = remove # ignore/add/remove/force + +# force or remove space between 'operator' and operator sign +sp_after_operator = remove # ignore/add/remove/force + +# force or remove space between the operator symbol and the open paren, as in 'operator ++(' +sp_after_operator_sym = remove # ignore/add/remove/force + +# force or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a' +sp_after_cast = remove # ignore/add/remove/force + +# force or remove spaces inside cast parens +sp_inside_paren_cast = remove # ignore/add/remove/force + +# force or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)' +sp_cpp_cast_paren = force # ignore/add/remove/force + +# force or remove space between 'sizeof' and '(' +sp_sizeof_paren = force # ignore/add/remove/force + +# force or remove space after the tag keyword (Pawn) +sp_after_tag = ignore # ignore/add/remove/force + +# force or remove space inside enum '{' and '}' +sp_inside_braces_enum = remove # ignore/add/remove/force + +# force or remove space inside struct/union '{' and '}' +sp_inside_braces_struct = remove # ignore/add/remove/force + +# force or remove space inside '{' and '}' +sp_inside_braces = remove # ignore/add/remove/force + +# force or remove space inside '{}' +sp_inside_braces_empty = remove # ignore/add/remove/force + +# force or remove space between return type and function name +# A minimum of 1 is forced except for pointer return types. +sp_type_func = force # ignore/add/remove/force + +# force or remove space between function name and '(' on function declaration +sp_func_proto_paren = remove # ignore/add/remove/force + +# force or remove space between function name and '(' on function definition +sp_func_def_paren = remove # ignore/add/remove/force + +# force or remove space inside empty function '()' +sp_inside_fparens = remove # ignore/add/remove/force + +# force or remove space inside function '(' and ')' +sp_inside_fparen = remove # ignore/add/remove/force + +# force or remove space inside the first parens in the function type: 'void (*x)(...)' +sp_inside_tparen = remove # ignore/add/remove/force + +# force or remove between the parens in the function type: 'void (*x)(...)' +sp_after_tparen_close = remove # ignore/add/remove/force + +# force or remove space between ']' and '(' when part of a function call. +sp_square_fparen = remove # ignore/add/remove/force + +# force or remove space between ')' and '{' of function +sp_fparen_brace = force # ignore/add/remove/force + +# force or remove space between function name and '(' on function calls +sp_func_call_paren = remove # ignore/add/remove/force + +# force or remove space between function name and '()' on function calls without parameters. +# If set to 'ignore' (the default), sp_func_call_paren is used. +sp_func_call_paren_empty = remove # ignore/add/remove/force + +# force or remove space between the user function name and '(' on function calls +# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file. +sp_func_call_user_paren = ignore # ignore/add/remove/force + +# force or remove space between a constructor/destructor and the open paren +sp_func_class_paren = remove # ignore/add/remove/force + +# force or remove space between 'return' and '(' +sp_return_paren = force # ignore/add/remove/force + +# force or remove space between '__attribute__' and '(' +sp_attribute_paren = remove # ignore/add/remove/force + +# force or remove space between 'defined' and '(' in '#if defined (FOO)' +sp_defined_paren = remove # ignore/add/remove/force + +# force or remove space between 'throw' and '(' in 'throw (something)' +sp_throw_paren = remove # ignore/add/remove/force + +# force or remove space between 'throw' and anything other than '(' as in '@throw [...];' +sp_after_throw = remove # ignore/add/remove/force + +# force or remove space between 'catch' and '(' in 'catch (something) { }' +# If set to ignore, sp_before_sparen is used. +sp_catch_paren = ignore # ignore/add/remove/force + +# force or remove space between 'version' and '(' in 'version (something) { }' (D language) +# If set to ignore, sp_before_sparen is used. +sp_version_paren = ignore # ignore/add/remove/force + +# force or remove space between 'scope' and '(' in 'scope (something) { }' (D language) +# If set to ignore, sp_before_sparen is used. +sp_scope_paren = ignore # ignore/add/remove/force + +# force or remove space between macro and value +sp_macro = ignore # ignore/add/remove/force + +# force or remove space between macro function ')' and value +sp_macro_func = ignore # ignore/add/remove/force + +# force or remove space between 'else' and '{' if on the same line +sp_else_brace = force # ignore/add/remove/force + +# force or remove space between '}' and 'else' if on the same line +sp_brace_else = force # ignore/add/remove/force + +# force or remove space between '}' and the name of a typedef on the same line +sp_brace_typedef = force # ignore/add/remove/force + +# force or remove space between 'catch' and '{' if on the same line +sp_catch_brace = force # ignore/add/remove/force + +# force or remove space between '}' and 'catch' if on the same line +sp_brace_catch = force # ignore/add/remove/force + +# force or remove space between 'finally' and '{' if on the same line +sp_finally_brace = force # ignore/add/remove/force + +# force or remove space between '}' and 'finally' if on the same line +sp_brace_finally = force # ignore/add/remove/force + +# force or remove space between 'try' and '{' if on the same line +sp_try_brace = force # ignore/add/remove/force + +# force or remove space between get/set and '{' if on the same line +sp_getset_brace = ignore # ignore/add/remove/force + +# force or remove space before the '::' operator +sp_before_dc = remove # ignore/add/remove/force + +# force or remove space after the '::' operator +sp_after_dc = remove # ignore/add/remove/force + +# force or remove around the D named array initializer ':' operator +sp_d_array_colon = ignore # ignore/add/remove/force + +# force or remove space after the '!' (not) operator. Default=Remove +sp_not = remove # ignore/add/remove/force + +# force or remove space after the '~' (invert) operator. Default=Remove +sp_inv = remove # ignore/add/remove/force + +# force or remove space after the '&' (address-of) operator. Default=Remove +# This does not affect the spacing after a '&' that is part of a type. +sp_addr = remove # ignore/add/remove/force + +# force or remove space around the '.' or '->' operators. Default=Remove +sp_member = remove # ignore/add/remove/force + +# force or remove space after the '*' (dereference) operator. Default=Remove +# This does not affect the spacing after a '*' that is part of a type. +sp_deref = remove # ignore/add/remove/force + +# force or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove +sp_sign = remove # ignore/add/remove/force + +# force or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove +sp_incdec = remove # ignore/add/remove/force + +# force or remove space before a backslash-newline at the end of a line. Default=Add +sp_before_nl_cont = force # ignore/add/remove/force + +# force or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;' +sp_after_oc_scope = ignore # ignore/add/remove/force + +# force or remove space after the colon in message specs +# '-(int) f:(int) x;' vs '-(int) f: (int) x;' +sp_after_oc_colon = ignore # ignore/add/remove/force + +# force or remove space before the colon in message specs +# '-(int) f: (int) x;' vs '-(int) f : (int) x;' +sp_before_oc_colon = ignore # ignore/add/remove/force + +# force or remove space after the colon in immutable dictionary expression +# 'NSDictionary *test = @{@"foo" :@"bar"};' +sp_after_oc_dict_colon = ignore # ignore/add/remove/force + +# force or remove space before the colon in immutable dictionary expression +# 'NSDictionary *test = @{@"foo" :@"bar"};' +sp_before_oc_dict_colon = ignore # ignore/add/remove/force + +# force or remove space after the colon in message specs +# '[object setValue:1];' vs '[object setValue: 1];' +sp_after_send_oc_colon = ignore # ignore/add/remove/force + +# force or remove space before the colon in message specs +# '[object setValue:1];' vs '[object setValue :1];' +sp_before_send_oc_colon = ignore # ignore/add/remove/force + +# force or remove space after the (type) in message specs +# '-(int)f: (int) x;' vs '-(int)f: (int)x;' +sp_after_oc_type = ignore # ignore/add/remove/force + +# force or remove space after the first (type) in message specs +# '-(int) f:(int)x;' vs '-(int)f:(int)x;' +sp_after_oc_return_type = ignore # ignore/add/remove/force + +# force or remove space between '@selector' and '(' +# '@selector(msgName)' vs '@selector (msgName)' +# Also applies to @protocol() constructs +sp_after_oc_at_sel = ignore # ignore/add/remove/force + +# force or remove space between '@selector(x)' and the following word +# '@selector(foo) a:' vs '@selector(foo)a:' +sp_after_oc_at_sel_parens = ignore # ignore/add/remove/force + +# force or remove space inside '@selector' parens +# '@selector(foo)' vs '@selector( foo )' +# Also applies to @protocol() constructs +sp_inside_oc_at_sel_parens = ignore # ignore/add/remove/force + +# force or remove space before a block pointer caret +# '^int (int arg){...}' vs. ' ^int (int arg){...}' +sp_before_oc_block_caret = ignore # ignore/add/remove/force + +# force or remove space after a block pointer caret +# '^int (int arg){...}' vs. '^ int (int arg){...}' +sp_after_oc_block_caret = ignore # ignore/add/remove/force + +# force or remove space between the receiver and selector in a message. +# '[receiver selector ...]' +sp_after_oc_msg_receiver = ignore # ignore/add/remove/force + +# force or remove space after @property. +sp_after_oc_property = ignore # ignore/add/remove/force + +# force or remove space around the ':' in 'b ? t : f' +sp_cond_colon = force # ignore/add/remove/force + +# force or remove space around the '?' in 'b ? t : f' +sp_cond_question = ignore # ignore/add/remove/force + +# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here. +sp_case_label = force # ignore/add/remove/force + +# Control the space around the D '..' operator. +sp_range = ignore # ignore/add/remove/force + +# Control the spacing after ':' in 'for (TYPE VAR : EXPR)' (Java) +sp_after_for_colon = ignore # ignore/add/remove/force + +# Control the spacing before ':' in 'for (TYPE VAR : EXPR)' (Java) +sp_before_for_colon = ignore # ignore/add/remove/force + +# Control the spacing in 'extern (C)' (D) +sp_extern_paren = ignore # ignore/add/remove/force + +# Control the space after the opening of a C++ comment '// A' vs '//A' +sp_cmt_cpp_start = force # ignore/add/remove/force + +# Controls the spaces between #else or #endif and a trailing comment +sp_endif_cmt = force # ignore/add/remove/force + +# Controls the spaces after 'new', 'delete', and 'delete[]' +sp_after_new = ignore # ignore/add/remove/force + +# Controls the spaces before a trailing or embedded comment +sp_before_tr_cmt = force # ignore/add/remove/force + +# Number of spaces before a trailing or embedded comment +sp_num_before_tr_cmt = 2 # number + +# Control space between a Java annotation and the open paren. +sp_annotation_paren = ignore # ignore/add/remove/force + +# +# Code alignment (not left column spaces/tabs) +# + +# Whether to keep non-indenting tabs +align_keep_tabs = false # false/true + +# Whether to use tabs for aligning +align_with_tabs = false # false/true + +# Whether to bump out to the next tab when aligning +align_on_tabstop = false # false/true + +# Whether to left-align numbers +# align_number_left = false # false/true + +# Align variable definitions in prototypes and functions +align_func_params = false # false/true + +# Align parameters in single-line functions that have the same name. +# The function names must already be aligned with each other. +align_same_func_call_params = false # false/true + +# The span for aligning variable definitions (0=don't align) +align_var_def_span = 0 # number + +# How to align the star in variable definitions. +# 0=Part of the type 'void * foo;' +# 1=Part of the variable 'void *foo;' +# 2=Dangling 'void *foo;' +align_var_def_star_style = 0 # number + +# How to align the '&' in variable definitions. +# 0=Part of the type +# 1=Part of the variable +# 2=Dangling +align_var_def_amp_style = 0 # number + +# The threshold for aligning variable definitions (0=no limit) +align_var_def_thresh = 0 # number + +# The gap for aligning variable definitions +align_var_def_gap = 0 # number + +# Whether to align the colon in struct bit fields +align_var_def_colon = false # false/true + +# Whether to align any attribute after the variable name +align_var_def_attribute = false # false/true + +# Whether to align inline struct/enum/union variable definitions +align_var_def_inline = false # false/true + +# The span for aligning on '=' in assignments (0=don't align) +align_assign_span = 0 # number + +# The threshold for aligning on '=' in assignments (0=no limit) +align_assign_thresh = 0 # number + +# The span for aligning on '=' in enums (0=don't align) +align_enum_equ_span = 1 # number + +# The threshold for aligning on '=' in enums (0=no limit) +align_enum_equ_thresh = 0 # number + +# The span for aligning struct/union (0=don't align) +align_var_struct_span = 20 # number + +# The threshold for aligning struct/union member definitions (0=no limit) +align_var_struct_thresh = 0 # number + +# The gap for aligning struct/union member definitions +align_var_struct_gap = 0 # number + +# The span for aligning struct initializer values (0=don't align) +align_struct_init_span = 0 # number + +# The minimum space between the type and the synonym of a typedef +align_typedef_gap = 0 # number + +# The span for aligning single-line typedefs (0=don't align) +align_typedef_span = 0 # number + +# How to align typedef'd functions with other typedefs +# 0: Don't mix them at all +# 1: align the open paren with the types +# 2: align the function type name with the other type names +align_typedef_func = 0 # number + +# Controls the positioning of the '*' in typedefs. Just try it. +# 0: Align on typedef type, ignore '*' +# 1: The '*' is part of type name: typedef int *pint; +# 2: The '*' is part of the type, but dangling: typedef int *pint; +align_typedef_star_style = 0 # number + +# Controls the positioning of the '&' in typedefs. Just try it. +# 0: Align on typedef type, ignore '&' +# 1: The '&' is part of type name: typedef int &pint; +# 2: The '&' is part of the type, but dangling: typedef int &pint; +align_typedef_amp_style = 0 # number + +# The span for aligning comments that end lines (0=don't align) +align_right_cmt_span = 2 # number + +# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment +align_right_cmt_mix = false # false/true + +# If a trailing comment is more than this number of columns away from the text it follows, +# it will qualify for being aligned. This has to be > 0 to do anything. +align_right_cmt_gap = 0 # number + +# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore) +align_right_cmt_at_col = 0 # number + +# The span for aligning function prototypes (0=don't align) +align_func_proto_span = 0 # number + +# Minimum gap between the return type and the function name. +align_func_proto_gap = 0 # number + +# Align function protos on the 'operator' keyword instead of what follows +align_on_operator = false # false/true + +# Whether to mix aligning prototype and variable declarations. +# If true, align_var_def_XXX options are used instead of align_func_proto_XXX options. +align_mix_var_proto = false # false/true + +# Align single-line functions with function prototypes, uses align_func_proto_span +align_single_line_func = false # false/true + +# Aligning the open brace of single-line functions. +# Requires align_single_line_func=true, uses align_func_proto_span +align_single_line_brace = false # false/true + +# Gap for align_single_line_brace. +align_single_line_brace_gap = 0 # number + +# The span for aligning ObjC msg spec (0=don't align) +align_oc_msg_spec_span = 0 # number + +# Whether to align macros wrapped with a backslash and a newline. +# This will not work right if the macro contains a multi-line comment. +#align_nl_cont = false # false/true + +# # Align macro functions and variables together +align_pp_define_together = false # false/true + +# The minimum space between label and value of a preprocessor define +align_pp_define_gap = 1 # number + +# The span for aligning on '#define' bodies (0=don't align) +align_pp_define_span = 0 # number + +# Align lines that start with '<<' with previous '<<'. Default=true +align_left_shift = true # false/true + +# Span for aligning parameters in an Obj-C message call on the ':' (0=don't align) +align_oc_msg_colon_span = 0 # number + +# If true, always align with the first parameter, even if it is too short. +align_oc_msg_colon_first = false # false/true + +# Aligning parameters in an Obj-C '+' or '-' declaration on the ':' +align_oc_decl_colon = false # false/true + +# +# Newline forceing and removing options +# + +# Whether to collapse empty blocks between '{' and '}' +nl_collapse_empty_body = false # false/true + +# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };' +nl_assign_leave_one_liners = true # false/true + +# Don't split one-line braced statements inside a class xx { } body +nl_class_leave_one_liners = true # false/true + +# Don't split one-line enums: 'enum foo { BAR = 15 };' +nl_enum_leave_one_liners = true # false/true + +# Don't split one-line get or set functions +nl_getset_leave_one_liners = true # false/true + +# Don't split one-line function definitions - 'int foo() { return 0; }' +nl_func_leave_one_liners = true # false/true + +# Don't split one-line if/else statements - 'if(a) b++;' +nl_if_leave_one_liners = false # false/true + +# Don't split one-line OC messages +nl_oc_msg_leave_one_liner = false # false/true + +# force or remove newlines at the start of the file +nl_start_of_file = remove # ignore/add/remove/force + +# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force' +nl_start_of_file_min = 0 # number + +# force or remove newline at the end of the file +nl_end_of_file = force # ignore/add/remove/force + +# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force') +nl_end_of_file_min = 1 # number + +# force or remove newline between '=' and '{' +nl_assign_brace = ignore # ignore/add/remove/force + +# force or remove newline between '=' and '[' (D only) +nl_assign_square = ignore # ignore/add/remove/force + +# force or remove newline after '= [' (D only). Will also affect the newline before the ']' +nl_after_square_assign = ignore # ignore/add/remove/force + +# The number of blank lines after a block of variable definitions at the top of a function body +# 0 = No change (default) +# nl_func_var_def_blk = 0 # number +nl_var_def_blk_end_func_top = 0 + +# The number of newlines before a block of typedefs +# 0 = No change (default) +nl_typedef_blk_start = 0 # number + +# The number of newlines after a block of typedefs +# 0 = No change (default) +nl_typedef_blk_end = 0 # number + +# The maximum consecutive newlines within a block of typedefs +# 0 = No change (default) +nl_typedef_blk_in = 0 # number + +# The number of newlines before a block of variable definitions not at the top of a function body +# 0 = No change (default) +nl_var_def_blk_start = 0 # number + +# The number of newlines after a block of variable definitions not at the top of a function body +# 0 = No change (default) +nl_var_def_blk_end = 0 # number + +# The maximum consecutive newlines within a block of variable definitions +# 0 = No change (default) +nl_var_def_blk_in = 0 # number + +# force or remove newline between a function call's ')' and '{', as in: +# list_for_each(item, &list) { } +nl_fcall_brace = remove # ignore/add/remove/force + +# force or remove newline between 'enum' and '{' +nl_enum_brace = remove # ignore/add/remove/force + +# force or remove newline between 'struct and '{' +nl_struct_brace = remove # ignore/add/remove/force + +# force or remove newline between 'union' and '{' +nl_union_brace = remove # ignore/add/remove/force + +# force or remove newline between 'if' and '{' +nl_if_brace = remove # ignore/add/remove/force + +# force or remove newline between '}' and 'else' +nl_brace_else = remove # ignore/add/remove/force + +# force or remove newline between 'else if' and '{' +# If set to ignore, nl_if_brace is used instead +nl_elseif_brace = remove # ignore/add/remove/force + +# force or remove newline between 'else' and '{' +nl_else_brace = remove # ignore/add/remove/force + +# force or remove newline between 'else' and 'if' +nl_else_if = remove # ignore/add/remove/force + +# force or remove newline between '}' and 'finally' +nl_brace_finally = remove # ignore/add/remove/force + +# force or remove newline between 'finally' and '{' +nl_finally_brace = remove # ignore/add/remove/force + +# force or remove newline between 'try' and '{' +nl_try_brace = remove # ignore/add/remove/force + +# force or remove newline between get/set and '{' +nl_getset_brace = ignore # ignore/add/remove/force + +# force or remove newline between 'for' and '{' +nl_for_brace = remove # ignore/add/remove/force + +# force or remove newline between 'catch' and '{' +nl_catch_brace = remove # ignore/add/remove/force + +# force or remove newline between '}' and 'catch' +nl_brace_catch = remove # ignore/add/remove/force + +# force or remove newline between 'while' and '{' +nl_while_brace = remove # ignore/add/remove/force + +# force or remove newline between 'scope (x)' and '{' (D) +nl_scope_brace = remove # ignore/add/remove/force + +# force or remove newline between 'unittest' and '{' (D) +nl_unittest_brace = remove # ignore/add/remove/force + +# force or remove newline between 'version (x)' and '{' (D) +nl_version_brace = remove # ignore/add/remove/force + +# force or remove newline between 'using' and '{' +nl_using_brace = remove # ignore/add/remove/force + +# force or remove newline between two open or close braces. +# Due to general newline/brace handling, REMOVE may not work. +nl_brace_brace = force # ignore/add/remove/force + +# force or remove newline between 'do' and '{' +nl_do_brace = remove # ignore/add/remove/force + +# force or remove newline between '}' and 'while' of 'do' statement +nl_brace_while = remove # ignore/add/remove/force + +# force or remove newline between 'switch' and '{' +nl_switch_brace = remove # ignore/add/remove/force + +# force a newline between ')' and '{' if the ')' is on a different line than the if/for/etc. +# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch, and nl_catch_brace. +nl_multi_line_cond = false # false/true + +# Force a newline in a define after the macro name for multi-line defines. +nl_multi_line_define = false # false/true + +# Whether to put a newline before 'case' statement +nl_before_case = false # false/true + +# force or remove newline between ')' and 'throw' +nl_before_throw = remove # ignore/add/remove/force + +# Whether to put a newline after 'case' statement +nl_after_case = false # false/true + +# force or remove a newline between a case ':' and '{'. Overrides nl_after_case. +nl_case_colon_brace = remove # ignore/add/remove/force + +# Newline between namespace and { +nl_namespace_brace = remove # ignore/add/remove/force + +# force or remove newline between 'template<>' and whatever follows. +nl_template_class = force # ignore/add/remove/force + +# force or remove newline between 'class' and '{' +nl_class_brace = remove # ignore/add/remove/force + +# force or remove newline after each ',' in the constructor member initialization +nl_class_init_args = ignore # ignore/add/remove/force + +# force or remove newline between return type and function name in a function definition +nl_func_type_name = ignore # ignore/add/remove/force + +# force or remove newline between return type and function name inside a class {} +# Uses nl_func_type_name or nl_func_proto_type_name if set to ignore. +nl_func_type_name_class = ignore # ignore/add/remove/force + +# force or remove newline between function scope and name in a definition +# Controls the newline after '::' in 'void A::f() { }' +nl_func_scope_name = ignore # ignore/add/remove/force + +# force or remove newline between return type and function name in a prototype +nl_func_proto_type_name = ignore # ignore/add/remove/force + +# force or remove newline between a function name and the opening '(' +nl_func_paren = ignore # ignore/add/remove/force + +# force or remove newline between a function name and the opening '(' in the definition +nl_func_def_paren = ignore # ignore/add/remove/force + +# force or remove newline after '(' in a function declaration +nl_func_decl_start = ignore # ignore/add/remove/force + +# force or remove newline after '(' in a function definition +nl_func_def_start = ignore # ignore/add/remove/force + +# Overrides nl_func_decl_start when there is only one parameter. +nl_func_decl_start_single = ignore # ignore/add/remove/force + +# Overrides nl_func_def_start when there is only one parameter. +nl_func_def_start_single = ignore # ignore/add/remove/force + +# force or remove newline after each ',' in a function declaration +nl_func_decl_args = ignore # ignore/add/remove/force + +# force or remove newline after each ',' in a function definition +nl_func_def_args = ignore # ignore/add/remove/force + +# force or remove newline before the ')' in a function declaration +nl_func_decl_end = remove # ignore/add/remove/force + +# force or remove newline before the ')' in a function definition +nl_func_def_end = remove # ignore/add/remove/force + +# Overrides nl_func_decl_end when there is only one parameter. +nl_func_decl_end_single = ignore # ignore/add/remove/force + +# Overrides nl_func_def_end when there is only one parameter. +nl_func_def_end_single = ignore # ignore/add/remove/force + +# force or remove newline between '()' in a function declaration. +nl_func_decl_empty = remove # ignore/add/remove/force + +# force or remove newline between '()' in a function definition. +nl_func_def_empty = remove # ignore/add/remove/force + +# Whether to put each OC message parameter on a separate line +# See nl_oc_msg_leave_one_liner +nl_oc_msg_args = false # false/true + +# force or remove newline between function signature and '{' +nl_fdef_brace = remove # ignore/add/remove/force + +# force or remove a newline between the return keyword and return expression. +nl_return_expr = ignore # ignore/add/remove/force + +# Whether to put a newline after semicolons, except in 'for' statements +nl_after_semicolon = true # false/true + +# Whether to put a newline after brace open. +# This also forces a newline before the matching brace close. +nl_after_brace_open = false # false/true + +# If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is +# placed between the open brace and a trailing single-line comment. +nl_after_brace_open_cmt = false # false/true + +# Whether to put a newline after a virtual brace open with a non-empty body. +# These occur in un-braced if/while/do/for statement bodies. +nl_after_vbrace_open = false # false/true + +# Whether to put a newline after a virtual brace open with an empty body. +# These occur in un-braced if/while/do/for statement bodies. +nl_after_vbrace_open_empty = false # false/true + +# Whether to put a newline after a brace close. +# Does not apply if followed by a necessary ';'. +nl_after_brace_close = false # false/true + +# Whether to put a newline after a virtual brace close. +# Would force a newline before return in: 'if (foo) a++; return;' +nl_after_vbrace_close = true # false/true + +# Control the newline between the close brace and 'b' in: 'struct { int a; } b;' +# Affects enums, unions, and structures. If set to ignore, uses nl_after_brace_close +nl_brace_struct_var = ignore # ignore/add/remove/force + +# Whether to alter newlines in '#define' macros +nl_define_macro = false # false/true + +# Whether to not put blanks after '#ifxx', '#elxx', or before '#endif' +nl_squeeze_ifdef = false # false/true + +# force or remove blank line before 'if' +nl_before_if = ignore # ignore/add/remove/force + +# force or remove blank line after 'if' statement +nl_after_if = ignore # ignore/add/remove/force + +# force or remove blank line before 'for' +nl_before_for = ignore # ignore/add/remove/force + +# force or remove blank line after 'for' statement +nl_after_for = ignore # ignore/add/remove/force + +# force or remove blank line before 'while' +nl_before_while = ignore # ignore/add/remove/force + +# force or remove blank line after 'while' statement +nl_after_while = ignore # ignore/add/remove/force + +# force or remove blank line before 'switch' +nl_before_switch = ignore # ignore/add/remove/force + +# force or remove blank line after 'switch' statement +nl_after_switch = ignore # ignore/add/remove/force + +# force or remove blank line before 'do' +nl_before_do = ignore # ignore/add/remove/force + +# force or remove blank line after 'do/while' statement +nl_after_do = ignore # ignore/add/remove/force + +# Whether to double-space commented-entries in struct/enum +nl_ds_struct_enum_cmt = false # false/true + +# Whether to double-space before the close brace of a struct/union/enum +# (lower priority than 'eat_blanks_before_close_brace') +nl_ds_struct_enum_close_brace = false # false/true + +# force or remove a newline around a class colon. +# Related to pos_class_colon, nl_class_init_args, and pos_comma. +nl_class_colon = ignore # ignore/add/remove/force + +# Change simple unbraced if statements into a one-liner +# 'if(b)\n i++;' => 'if(b) i++;' +nl_create_if_one_liner = false # false/true + +# Change simple unbraced for statements into a one-liner +# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);' +nl_create_for_one_liner = false # false/true + +# Change simple unbraced while statements into a one-liner +# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);' +nl_create_while_one_liner = false # false/true + +# +# Positioning options +# + +# The position of arithmetic operators in wrapped expressions +pos_arith = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of assignment in wrapped expressions. +# Do not affect '=' followed by '{' +pos_assign = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of boolean operators in wrapped expressions +pos_bool = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of comparison operators in wrapped expressions +pos_compare = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of conditional (b ? t : f) operators in wrapped expressions +pos_conditional = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of the comma in wrapped expressions +pos_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of the comma in the constructor initialization list +pos_class_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# The position of colons between constructor and member initialization +pos_class_colon = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force + +# +# Line Splitting options +# + +# Try to limit code width to N number of columns +code_width = 120 # number + +# Whether to fully split long 'for' statements at semi-colons +ls_for_split_full = true # false/true + +# Whether to fully split long function protos/calls at commas +ls_func_split_full = true # false/true + +# Whether to split lines as close to code_width as possible and ignore some groupings +ls_code_width = false # false/true + +# +# Blank line options +# + +# The maximum consecutive newlines +nl_max = 2 # number + +# The number of newlines after a function prototype, if followed by another function prototype +nl_after_func_proto = 0 # number + +# The number of newlines after a function prototype, if not followed by another function prototype +nl_after_func_proto_group = 0 # number + +# The number of newlines after '}' of a multi-line function body +nl_after_func_body = 0 # number + +# The number of newlines after '}' of a multi-line function body in a class declaration +nl_after_func_body_class = 0 # number + +# The number of newlines after '}' of a single line function body +nl_after_func_body_one_liner = 0 # number + +# The minimum number of newlines before a multi-line comment. +# Doesn't apply if after a brace open or another multi-line comment. +nl_before_block_comment = 0 # number + +# The minimum number of newlines before a single-line C comment. +# Doesn't apply if after a brace open or other single-line C comments. +nl_before_c_comment = 0 # number + +# The minimum number of newlines before a CPP comment. +# Doesn't apply if after a brace open or other CPP comments. +nl_before_cpp_comment = 0 # number + +# Whether to force a newline after a multi-line comment. +nl_after_multiline_comment = false # false/true + +# The number of newlines after '}' or ';' of a struct/enum/union definition +nl_after_struct = 0 # number + +# The number of newlines after '}' or ';' of a class definition +nl_after_class = 1 # number + +# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. +# Will not change the newline count if after a brace open. +# 0 = No change. +nl_before_access_spec = 2 # number + +# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. +# 0 = No change. +nl_after_access_spec = 0 # number + +# The number of newlines between a function def and the function comment. +# 0 = No change. +nl_comment_func_def = 0 # number + +# The number of newlines after a try-catch-finally block that isn't followed by a brace close. +# 0 = No change. +nl_after_try_catch_finally = 0 # number + +# The number of newlines before and after a property, indexer or event decl. +# 0 = No change. +nl_around_cs_property = 0 # number + +# The number of newlines between the get/set/add/remove handlers in C#. +# 0 = No change. +nl_between_get_set = 0 # number + +# force or remove newline between C# property and the '{' +nl_property_brace = ignore # ignore/add/remove/force + +# Whether to remove blank lines after '{' +eat_blanks_after_open_brace = true # false/true + +# Whether to remove blank lines before '}' +eat_blanks_before_close_brace = true # false/true + +# How aggressively to remove extra newlines not in preproc. +# 0: No change +# 1: Remove most newlines not handled by other config +# 2: Remove all newlines and reformat completely by config +nl_remove_extra_newlines = 0 # number + +# Whether to put a blank line before 'return' statements, unless after an open brace. +nl_before_return = false # false/true + +# Whether to put a blank line after 'return' statements, unless followed by a close brace. +nl_after_return = false # false/true + +# Whether to put a newline after a Java annotation statement. +# Only affects annotations that are after a newline. +nl_after_annotation = ignore # ignore/add/remove/force + +# Controls the newline between two annotations. +nl_between_annotation = ignore # ignore/add/remove/force + +# +# Code modifying options (non-whitespace) +# + +# force or remove braces on single-line 'do' statement +mod_full_brace_do = ignore # ignore/add/remove/force + +# force or remove braces on single-line 'for' statement +mod_full_brace_for = force # ignore/add/remove/force + +# force or remove braces on single-line function definitions. (Pawn) +mod_full_brace_function = ignore # ignore/add/remove/force + +# force or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'. +mod_full_brace_if = force # ignore/add/remove/force + +# Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if. +# If any must be braced, they are all braced. If all can be unbraced, then the braces are removed. +mod_full_brace_if_chain = 0 + +# Don't remove braces around statements that span N newlines +mod_full_brace_nl = 0 # number + +# force or remove braces on single-line 'while' statement +mod_full_brace_while = force # ignore/add/remove/force + +# force or remove braces on single-line 'using ()' statement +mod_full_brace_using = ignore # ignore/add/remove/force + +# force or remove unnecessary paren on 'return' statement +mod_paren_on_return = remove # ignore/add/remove/force + +# Whether to change optional semicolons to real semicolons +mod_pawn_semicolon = false # false/true + +# force parens on 'while' and 'if' statement around bools +mod_full_paren_if_bool = true # false/true + +# Whether to remove superfluous semicolons +mod_remove_extra_semicolon = true # false/true + +# If a function body exceeds the specified number of newlines and doesn't have a comment after +# the close brace, a comment will be forceed. +mod_add_long_function_closebrace_comment = 0 # number + +# If a switch body exceeds the specified number of newlines and doesn't have a comment after +# the close brace, a comment will be forceed. +mod_add_long_switch_closebrace_comment = 0 # number + +# If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after +# the #endif, a comment will be forceed. +mod_add_long_ifdef_endif_comment = 0 # number + +# If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after +# the #else, a comment will be forceed. +mod_add_long_ifdef_else_comment = 10 # number + +# If TRUE, will sort consecutive single-line 'import' statements [Java, D] +mod_sort_import = false # false/true + +# If TRUE, will sort consecutive single-line 'using' statements [C#] +mod_sort_using = true # false/true + +# If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C] +# This is generally a bad idea, as it may break your code. +mod_sort_include = true # false/true + +# If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace. +mod_move_case_break = false # false/true + +# Will force or remove the braces around a fully braced case statement. +# Will only remove the braces if there are no variable declarations in the block. +mod_case_brace = ignore # ignore/add/remove/force + +# If TRUE, it will remove a void 'return;' that appears as the last statement in a function. +mod_remove_empty_return = true # false/true + +# +# Comment modifications +# + +# Try to wrap comments at cmt_width columns +cmt_width = 0 # number + +# Set the comment reflow mode (default: 0) +# 0: no reflowing (apart from the line wrapping due to cmt_width) +# 1: no touching at all +# 2: full reflow +cmt_reflow_mode = 0 # number + +# If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars. +# Default is true. +cmt_indent_multi = true # false/true + +# Whether to group c-comments that look like they are in a block +cmt_c_group = false # false/true + +# Whether to put an empty '/*' on the first line of the combined c-comment +cmt_c_nl_start = false # false/true + +# Whether to put a newline before the closing '*/' of the combined c-comment +cmt_c_nl_end = false # false/true + +# Whether to group cpp-comments that look like they are in a block +cmt_cpp_group = false # false/true + +# Whether to put an empty '/*' on the first line of the combined cpp-comment +cmt_cpp_nl_start = false # false/true + +# Whether to put a newline before the closing '*/' of the combined cpp-comment +cmt_cpp_nl_end = false # false/true + +# Whether to change cpp-comments into c-comments +cmt_cpp_to_c = false # false/true + +# Whether to put a star on subsequent comment lines +cmt_star_cont = false # false/true + +# The number of spaces to insert at the start of subsequent comment lines +cmt_sp_before_star_cont = 0 # number + +# The number of spaces to insert after the star on subsequent comment lines +cmt_sp_after_star_cont = 0 # number + +# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of +# the comment are the same length. Default=True +cmt_multi_check_last = false # false/true + +# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment. +# Will substitute $(filename) with the current file's name. +cmt_insert_file_header = "" # string + +# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment. +# Will substitute $(filename) with the current file's name. +cmt_insert_file_footer = "" # string + +# The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment. +# Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff. +# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... } +cmt_insert_func_header = "" # string + +# The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment. +# Will substitute $(class) with the class name. +cmt_insert_class_header = "" # string + +# The filename that contains text to insert before a Obj-C message specification if the method isn't preceeded with a C/C++ comment. +# Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff. +cmt_insert_oc_msg_header = "" # string + +# If a preprocessor is encountered when stepping backwards from a function name, then +# this option decides whether the comment should be inserted. +# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header. +cmt_insert_before_preproc = false # false/true + +# +# Preprocessor options +# + +# Control indent of preprocessors inside #if blocks at brace level 0 +pp_indent = remove # ignore/add/remove/force + +# Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false) +pp_indent_at_level = false # false/true + +# If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1. +pp_indent_count = 2 # number + +# force or remove space after # based on pp_level of #if blocks +pp_space_after = add # ignore/add/remove/force + +# Sets the number of spaces forceed with pp_space +pp_space_count = 1 # number + +# The indent for #region and #endregion in C# and '#pragma region' in C/C++ +pp_indent_region = 0 # number + +# Whether to indent the code between #region and #endregion +pp_region_indent_code = false # false/true + +# If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level +pp_indent_if = 1 # number + +# Control whether to indent the code between #if, #else and #endif when not at file-level +pp_if_indent_code = false # false/true + +# Whether to indent '#define' at the brace level (true) or from column 1 (false) +pp_define_at_level = true # false/true + +# You can force a token to be a type with the 'type' option. +# Example: +# type myfoo1 myfoo2 +# +# You can create custom macro-based indentation using macro-open, +# macro-else and macro-close. +# Example: +# macro-open BEGIN_TEMPLATE_MESSAGE_MAP +# macro-open BEGIN_MESSAGE_MAP +# macro-close END_MESSAGE_MAP +# +# You can assign any keyword to any type with the set option. +# set func_call_user _ N_ +# +# The full syntax description of all custom definition config entries +# is shown below: +# +# define custom tokens as: +# - embed whitespace in token using '' escape character, or +# put token in quotes +# - these: ' " and ` are recognized as quote delimiters +# +# type token1 token2 token3 ... +# ^ optionally specify multiple tokens on a single line +# define def_token output_token +# ^ output_token is optional, then NULL is assumed +# macro-open token +# macro-close token +# macro-else token +# set id token1 token2 ... +# ^ optionally specify multiple tokens on a single line +# ^ id is one of the names in token_enum.h sans the CT_ prefix, +# e.g. PP_PRAGMA +# +# all tokens are separated by any mix of ',' commas, '=' equal signs +# and whitespace (space, tab) +# From b5428d203d7c3df5b5da54f12b4aa8ccaf63680b Mon Sep 17 00:00:00 2001 From: Ian Taylor Date: Sun, 17 Dec 2023 08:26:49 -0700 Subject: [PATCH 5/8] Fix memory leak in unit conversion (#122) * Set memory debug flag. * Fix memory leak converting inches to mm. * Remove memory debug flag. * Remove memory debug flag. --- src/rtl_433/r_api.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/rtl_433/r_api.c b/src/rtl_433/r_api.c index ba3a2d85..ec8c255d 100644 --- a/src/rtl_433/r_api.c +++ b/src/rtl_433/r_api.c @@ -798,10 +798,12 @@ void data_acquired_handler(r_device* r_dev, data_t* data) { else if ((d->type == DATA_DOUBLE) && (str_endswith(d->key, "_in") || str_endswith(d->key, "_inch"))) { d->value.v_dbl = inch2mm(d->value.v_dbl); - char* new_label = - str_replace(str_replace(d->key, "_inch", "_in"), "_in", "_mm"); + // need to free ptr returned from str_replace + char* new_label1 = str_replace(d->key, "_inch", "_in"); + char* new_label2 = str_replace(new_label1, "_in", "_mm"); + free(new_label1); free(d->key); - d->key = new_label; + d->key = new_label2; char* new_format_label = str_replace(d->format, "in", "mm"); free(d->format); d->format = new_format_label; From 4e6267796d9fccd6c70d0cc5fbc501922d6e8781 Mon Sep 17 00:00:00 2001 From: Northern Man <19808920+NorthernMan54@users.noreply.github.com> Date: Sun, 17 Dec 2023 10:29:13 -0500 Subject: [PATCH 6/8] Update library.json --- library.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.json b/library.json index 3ea6f1c3..8d5f1514 100644 --- a/library.json +++ b/library.json @@ -6,7 +6,7 @@ "type": "git", "url": "https://github.com/NorthernMan54/rtl_433_ESP.git" }, - "version": "0.3.1", + "version": "0.3.2", "license": "GPL-3.0", "frameworks": "arduino", "platforms": [ From 13171ea3d5a75fb6a119a14becfb81fb2c19f3b1 Mon Sep 17 00:00:00 2001 From: Lucio Tarantino Date: Sun, 17 Dec 2023 16:32:12 +0100 Subject: [PATCH 7/8] Add Support for ESP32-C3 e S3 (#124) * Add Support for ESP32-C3 e S3 * Update rtl_433_ESP.cpp --------- Co-authored-by: Northern Man <19808920+NorthernMan54@users.noreply.github.com> --- src/rtl_433_ESP.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/rtl_433_ESP.cpp b/src/rtl_433_ESP.cpp index b5e62f24..b566d950 100644 --- a/src/rtl_433_ESP.cpp +++ b/src/rtl_433_ESP.cpp @@ -32,7 +32,11 @@ #if defined(RF_MODULE_SCK) && defined(RF_MODULE_MISO) && \ defined(RF_MODULE_MOSI) && defined(RF_MODULE_CS) # include +# if CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32S3 +SPIClass newSPI(FSPI); +# else SPIClass newSPI(VSPI); +# endif #endif #ifdef RF_SX1276 From d3e27a5679b8199caf50cc0d069527795aae215c Mon Sep 17 00:00:00 2001 From: Northern Man <19808920+NorthernMan54@users.noreply.github.com> Date: Sun, 17 Dec 2023 17:00:31 -0500 Subject: [PATCH 8/8] Adjust rtl_433_ReceiverTask_Stack size, #116 --- src/rtl_433_ESP.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/rtl_433_ESP.cpp b/src/rtl_433_ESP.cpp index b566d950..d7792682 100644 --- a/src/rtl_433_ESP.cpp +++ b/src/rtl_433_ESP.cpp @@ -59,7 +59,7 @@ Module* _mod = radio.getMod(); /*----------------------------- rtl_433_ESP Internals -----------------------------*/ -#define rtl_433_ReceiverTask_Stack 2000 +#define rtl_433_ReceiverTask_Stack 2048 #define rtl_433_ReceiverTask_Priority 2 #define rtl_433_ReceiverTask_Core 0