Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add splint, modified some files to pass checks #2639

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/workflows/splint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Splint Check
on: [push, pull_request, workflow_dispatch]
jobs:
analyzer_check_job:
runs-on: ubuntu-22.04
name: Analyze with 'splint'
steps:
- uses: actions/checkout@v4
- name: Install 'splint'
run: |
sudo apt-get update -q && sudo apt install splint
- name: splint analyzer
run: |
./do_splint.sh | tee splint.out
grep -q "Finished checking --- no warnings" splint.out
68 changes: 68 additions & 0 deletions do_splint.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
#!/bin/bash
# When files are provided as arguments, no messages are excluded
FILES="$@"
EXCLUDE_OPTS=""
{
PRJ_DIR=$(realpath $(dirname $(realpath $0)))/
if [ "$FILES" == "" ] ; then
FILES=$(find "${PRJ_DIR}" -type d \( -path "${PRJ_DIR}build" \) -prune -o -name '*.c'|grep -v -E '((tests/.*|src/(am_analyze|abuf|baseband|bitbuffer|confparse|data|data_tag|decoder_util|fileformat|http_server|list|mongoose|optparse|output_file|output_influx|output_log|output_mqtt|output_trigger|output_udp|pulse_analyzer|pulse_data|pulse_detect|pulse_slicer|rfraw|rtl_433|r_api|r_util|samp_grab|sdr|term_ctl|util|write_sigrok|devices/(acurite|acurite_01185m|alecto|ambientweather_tx8300|ambientweather_wh31e|ambient_weather|ant_antplus|archos_tbh|atech_ws308|auriol_4ld5661|auriol_aft77b2|auriol_hg02832|badger_water|baldr_rain|blueline|blyss|brennenstuhl_rcs_2044|bresser_5in1|bresser_6in1|bresser_7in1|bt_rain|burnhardbbq|calibeur|cardin|cavius|ced7000|celsia_czc1|cmr113|companion_wtr001|cotech_36_7959|current_cost|danfoss|digitech_xc0324|directv|dsc|ecodhome|ecowitt|efergy_e2_classic|efergy_optical|efth800|elro_db286a|elv|emax|emos_e6016|emos_e6016_rain|enocean_erp1|ert_idm|esic_emt7110|esperanza_ews|fineoffset|fineoffset_wh1050|fineoffset_wh1080|fineoffset_wh31l|fineoffset_wh45|fineoffset_wn34|fineoffset_ws80|fineoffset_ws90|flex|flowis|fordremote|fs20|ft004b|funkbus|gasmate_ba1008|generic_motion|generic_remote|geo_minim|ge_coloreffects|govee|gt_tmbbq05|gt_wt_02|gt_wt_03|hcs200|hideki|holman_ws5029|hondaremote|honeywell_cm921|ht680|ikea_sparsnas|infactory|inkbird_ith20r|inovalley-kw9015b|insteon|interlogix|intertechno|jasco|kedsum|klimalogg|lacrosse|lacrossews|lacrosse_r1|lacrosse_tx141x|lacrosse_tx31u|lacrosse_tx34|lacrosse_tx35|lacrosse_ws7000|lightwave_rf|markisol|marlec_solar|maverick_et73x|maverick_xr30|megacode|m_bus|neptune_r900|newkaku|nexa|nice_flor_s|norgo|oil_smart|oil_standard|oil_watchman|oil_watchman_advanced|oregon_scientific|oregon_scientific_sl109h|oregon_scientific_v1|philips_aj7010|proflame2|prologue|proove|quhwa|radiohead_ask|rainpoint|regency_fan|revolt_nc5462|rftech|rojaflex|rubicson_48659|rubicson_pool_48942|s3318p|schraeder|scmplus|secplus_v1|secplus_v2|sharp_spc775|simplisafe|simplisafe_gen3|somfy_iohc|somfy_rts|springfield|srsmith_pool_srs_2c_tx|steelmate|telldus_ft0385r|tfa_14_1504_v2|tfa_30_3196|tfa_30_3221|tfa_drop_30.3233|tfa_marbella|tfa_twin_plus_30.3049|thermopro_tp11|thermopro_tx2|thermopro_tx2c|tpms_eezrv|tpms_jansite_solar|tpms_kia|tpms_pmv107j|tpms_porsche|tpms_renault_0435r|tpms_truck|tpms_tyreguard400|ts_ft002|vaillant_vrt340f|vauno_en8822c|wec2103|wg_pb12v1|ws2032|wssensor|x10_rf|yale_hsa)))\.c|build)' )
EXCLUDE_OPTS="
-globs \
+boolint \
+charint \
-exportlocal \
-retvalint \
-noeffect \
-fcnuse \
-compdef \
-usedef \
+skipsysheaders \
+relaxtypes \
-shiftnegative \
-nullinit \
-unrecog \
-globstate \
-paramuse \
-branchstate \
+matchanyintegral \
-mayaliasunique \
-nullassign \
-nullret \
-formatconst \
-nullderef \
-nullpass \
-initallelements \
-fullinitblock \
-bufferoverflowhigh \
-redef \
-type \
-statictrans \
-nestcomment \
-observertrans \
-immediatetrans \
-mustfreefresh \
-mustfreeonly \
-boolops \
-shiftimplementation
"
fi
echo "Check $FILES"
splint \
-I"${PRJ_DIR}include" \
+trytorecover \
+forcehints \
+posixstrictlib \
-preproc \
$EXCLUDE_OPTS \
-D__unix__ \
-Drestrict= \
-D_MSC_VER=1300 \
"-Ddata_array_t=int" \
"-Ddata_t=int" \
"-Duint16_t=unsigned short" \
"-Dint16_t=short" \
"-DUINT16_MAX=0xFFFFU" \
"-DSSIZE_T=unsigned long" \
$FILES
} |& tee splint.log

3 changes: 3 additions & 0 deletions include/abuf.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ void abuf_pop(abuf_t *buf, char *end);

void abuf_cat(abuf_t *buf, const char *str);

#ifndef S_SPLINT_S
int abuf_printf(abuf_t *buf, _Printf_format_string_ char const *restrict format, ...)
#endif

#if defined(__GNUC__) || defined(__clang__)
__attribute__((format(printf, 2, 3)))
#endif
Expand Down