Modules: return bool to indicate whether the detection is succeeded

Author: CarterLi

src/common/option.h

@@ -29,11 +29,12 @@ typedef struct FFModuleBaseInfo
     // This is UB, because `void*` is not compatible with `FF*Options*`.
     // However we can't do it better unless we move to C++, so that `option` becomes a `this` pointer
     // https://stackoverflow.com/questions/559581/casting-a-function-pointer-to-another-type
+
     void (*initOptions)(void* options);
     void (*destroyOptions)(void* options);
     void (*parseJsonObject)(void* options, struct yyjson_val *module);
-    void (*printModule)(void* options);
-    void (*generateJsonResult)(void* options, struct yyjson_mut_doc* doc, struct yyjson_mut_val* module);
+    bool (*printModule)(void* options); // true on success
+    bool (*generateJsonResult)(void* options, struct yyjson_mut_doc* doc, struct yyjson_mut_val* module); // true on success
     void (*generateJsonConfig)(void* options, struct yyjson_mut_doc* doc, struct yyjson_mut_val* obj);
     FFModuleFormatArgList formatArgs;
 } FFModuleBaseInfo;

src/modules/battery/battery.c

@@ -125,7 +125,7 @@ static void printBattery(FFBatteryOptions* options, FFBatteryResult* result, uin
     }
 }
 
-void ffPrintBattery(FFBatteryOptions* options)
+bool ffPrintBattery(FFBatteryOptions* options)
 {
     FF_LIST_AUTO_DESTROY results = ffListCreate(sizeof(FFBatteryResult));
 
@@ -134,12 +134,12 @@ void ffPrintBattery(FFBatteryOptions* options)
     if (error)
     {
         ffPrintError(FF_BATTERY_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", error);
-        return;
+        return false;
     }
     if(results.length == 0)
     {
         ffPrintError(FF_BATTERY_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", "No batteries found");
-        return;
+        return false;
     }
 
     for(uint32_t i = 0; i < results.length; i++)
@@ -157,6 +157,7 @@ void ffPrintBattery(FFBatteryOptions* options)
         ffStrbufDestroy(&result->serial);
         ffStrbufDestroy(&result->manufactureDate);
     }
+    return true;
 }
 
 void ffParseBatteryJsonObject(FFBatteryOptions* options, yyjson_val* module)
@@ -198,15 +199,15 @@ void ffGenerateBatteryJsonConfig(FFBatteryOptions* options, yyjson_mut_doc* doc,
     ffPercentGenerateJsonConfig(doc, module, options->percent);
 }
 
-void ffGenerateBatteryJsonResult(FFBatteryOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+bool ffGenerateBatteryJsonResult(FFBatteryOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
 {
     FF_LIST_AUTO_DESTROY results = ffListCreate(sizeof(FFBatteryResult));
 
     const char* error = ffDetectBattery(options, &results);
     if (error)
     {
         yyjson_mut_obj_add_str(doc, module, "error", error);
-        return;
+        return false;
     }
 
     yyjson_mut_val* arr = yyjson_mut_obj_add_arr(doc, module, "result");
@@ -241,6 +242,8 @@ void ffGenerateBatteryJsonResult(FFBatteryOptions* options, yyjson_mut_doc* doc,
         ffStrbufDestroy(&battery->status);
         ffStrbufDestroy(&battery->serial);
     }
+
+    return true;
 }
 
 void ffInitBatteryOptions(FFBatteryOptions* options)

src/modules/battery/battery.h

@@ -4,7 +4,7 @@
 
 #define FF_BATTERY_MODULE_NAME "Battery"
 
-void ffPrintBattery(FFBatteryOptions* options);
+bool ffPrintBattery(FFBatteryOptions* options);
 void ffInitBatteryOptions(FFBatteryOptions* options);
 void ffDestroyBatteryOptions(FFBatteryOptions* options);
 

src/modules/bios/bios.c

@@ -4,8 +4,9 @@
 #include "modules/bios/bios.h"
 #include "util/stringUtils.h"
 
-void ffPrintBios(FFBiosOptions* options)
+bool ffPrintBios(FFBiosOptions* options)
 {
+    bool success = false;
     FFBiosResult bios;
     ffStrbufInit(&bios.date);
     ffStrbufInit(&bios.release);
@@ -66,13 +67,16 @@ void ffPrintBios(FFBiosOptions* options)
             FF_FORMAT_ARG(bios.type, "type"),
         }));
     }
+    success = true;
 
 exit:
     ffStrbufDestroy(&bios.date);
     ffStrbufDestroy(&bios.release);
     ffStrbufDestroy(&bios.vendor);
     ffStrbufDestroy(&bios.version);
     ffStrbufDestroy(&bios.type);
+
+    return success;
 }
 
 void ffParseBiosJsonObject(FFBiosOptions* options, yyjson_val* module)
@@ -93,8 +97,9 @@ void ffGenerateBiosJsonConfig(FFBiosOptions* options, yyjson_mut_doc* doc, yyjso
     ffJsonConfigGenerateModuleArgsConfig(doc, module, &options->moduleArgs);
 }
 
-void ffGenerateBiosJsonResult(FF_MAYBE_UNUSED FFBiosOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+bool ffGenerateBiosJsonResult(FF_MAYBE_UNUSED FFBiosOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
 {
+    bool success = false;
     FFBiosResult bios;
     ffStrbufInit(&bios.date);
     ffStrbufInit(&bios.release);
@@ -116,13 +121,15 @@ void ffGenerateBiosJsonResult(FF_MAYBE_UNUSED FFBiosOptions* options, yyjson_mut
     yyjson_mut_obj_add_strbuf(doc, obj, "vendor", &bios.vendor);
     yyjson_mut_obj_add_strbuf(doc, obj, "version", &bios.version);
     yyjson_mut_obj_add_strbuf(doc, obj, "type", &bios.type);
+    success = true;
 
 exit:
     ffStrbufDestroy(&bios.date);
     ffStrbufDestroy(&bios.release);
     ffStrbufDestroy(&bios.vendor);
     ffStrbufDestroy(&bios.version);
     ffStrbufDestroy(&bios.type);
+    return success;
 }
 
 void ffInitBiosOptions(FFBiosOptions* options)

src/modules/bios/bios.h

@@ -4,7 +4,7 @@
 
 #define FF_BIOS_MODULE_NAME "BIOS"
 
-void ffPrintBios(FFBiosOptions* options);
+bool ffPrintBios(FFBiosOptions* options);
 void ffInitBiosOptions(FFBiosOptions* options);
 void ffDestroyBiosOptions(FFBiosOptions* options);
 

src/modules/bluetooth/bluetooth.c

@@ -56,37 +56,36 @@ static void printDevice(FFBluetoothOptions* options, const FFBluetoothResult* de
     }
 }
 
-void ffPrintBluetooth(FFBluetoothOptions* options)
+bool ffPrintBluetooth(FFBluetoothOptions* options)
 {
     FF_LIST_AUTO_DESTROY devices = ffListCreate(sizeof (FFBluetoothResult));
     const char* error = ffDetectBluetooth(options, &devices);
 
     if(error)
     {
         ffPrintError(FF_BLUETOOTH_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", error);
+        return false;
     }
-    else
-    {
-        FF_LIST_AUTO_DESTROY filtered = ffListCreate(sizeof(FFBluetoothResult*));
 
-        FF_LIST_FOR_EACH(FFBluetoothResult, device, devices)
-        {
-            if(!device->connected && !options->showDisconnected)
-                continue;
+    FF_LIST_AUTO_DESTROY filtered = ffListCreate(sizeof(FFBluetoothResult*));
 
-            *(FFBluetoothResult**)ffListAdd(&filtered) = device;
-        }
+    FF_LIST_FOR_EACH(FFBluetoothResult, device, devices)
+    {
+        if(!device->connected && !options->showDisconnected)
+            continue;
 
-        if(filtered.length == 0)
-        {
-            ffPrintError(FF_BLUETOOTH_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "No bluetooth devices found");
-        }
+        *(FFBluetoothResult**)ffListAdd(&filtered) = device;
+    }
 
-        for(uint32_t i = 0; i < filtered.length; i++)
-        {
-            uint8_t index = (uint8_t) (filtered.length == 1 ? 0 : i + 1);
-            printDevice(options, *FF_LIST_GET(FFBluetoothResult*, filtered, i), index);
-        }
+    if(filtered.length == 0)
+    {
+        ffPrintError(FF_BLUETOOTH_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "No bluetooth devices found");
+    }
+
+    for(uint32_t i = 0; i < filtered.length; i++)
+    {
+        uint8_t index = (uint8_t) (filtered.length == 1 ? 0 : i + 1);
+        printDevice(options, *FF_LIST_GET(FFBluetoothResult*, filtered, i), index);
     }
 
     FF_LIST_FOR_EACH(FFBluetoothResult, device, devices)
@@ -95,6 +94,7 @@ void ffPrintBluetooth(FFBluetoothOptions* options)
         ffStrbufDestroy(&device->type);
         ffStrbufDestroy(&device->address);
     }
+    return true;
 }
 
 void ffParseBluetoothJsonObject(FFBluetoothOptions* options, yyjson_val* module)
@@ -128,15 +128,15 @@ void ffGenerateBluetoothJsonConfig(FFBluetoothOptions* options, yyjson_mut_doc*
     ffPercentGenerateJsonConfig(doc, module, options->percent);
 }
 
-void ffGenerateBluetoothJsonResult(FFBluetoothOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+bool ffGenerateBluetoothJsonResult(FFBluetoothOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
 {
     FF_LIST_AUTO_DESTROY results = ffListCreate(sizeof(FFBluetoothResult));
 
     const char* error = ffDetectBluetooth(options, &results);
     if (error)
     {
         yyjson_mut_obj_add_str(doc, module, "error", error);
-        return;
+        return false;
     }
 
     yyjson_mut_val* arr = yyjson_mut_obj_add_arr(doc, module, "result");
@@ -157,6 +157,7 @@ void ffGenerateBluetoothJsonResult(FFBluetoothOptions* options, yyjson_mut_doc*
         ffStrbufDestroy(&device->type);
         ffStrbufDestroy(&device->address);
     }
+    return true;
 }
 
 void ffInitBluetoothOptions(FFBluetoothOptions* options)

src/modules/bluetooth/bluetooth.h

@@ -4,7 +4,7 @@
 
 #define FF_BLUETOOTH_MODULE_NAME "Bluetooth"
 
-void ffPrintBluetooth(FFBluetoothOptions* options);
+bool ffPrintBluetooth(FFBluetoothOptions* options);
 void ffInitBluetoothOptions(FFBluetoothOptions* options);
 void ffDestroyBluetoothOptions(FFBluetoothOptions* options);
 

src/modules/bluetoothradio/bluetoothradio.c

@@ -67,34 +67,33 @@ static void printDevice(FFBluetoothRadioOptions* options, const FFBluetoothRadio
     }
 }
 
-void ffPrintBluetoothRadio(FFBluetoothRadioOptions* options)
+bool ffPrintBluetoothRadio(FFBluetoothRadioOptions* options)
 {
     FF_LIST_AUTO_DESTROY radios = ffListCreate(sizeof (FFBluetoothRadioResult));
     const char* error = ffDetectBluetoothRadio(&radios);
 
     if(error)
     {
         ffPrintError(FF_BLUETOOTHRADIO_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", error);
+        return false;
     }
-    else
+
+    uint8_t index = 0;
+    FF_LIST_FOR_EACH(FFBluetoothRadioResult, radio, radios)
+    {
+        if (!radio->enabled)
+            continue;
+
+        index++;
+        printDevice(options, radio, index);
+    }
+
+    if (index == 0)
     {
-        uint8_t index = 0;
-        FF_LIST_FOR_EACH(FFBluetoothRadioResult, radio, radios)
-        {
-            if (!radio->enabled)
-                continue;
-
-            index++;
-            printDevice(options, radio, index);
-        }
-
-        if (index == 0)
-        {
-            if (radios.length > 0)
-                ffPrintError(FF_BLUETOOTHRADIO_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "Bluetooth radios found but none enabled");
-            else
-                ffPrintError(FF_BLUETOOTHRADIO_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "No devices detected");
-        }
+        if (radios.length > 0)
+            ffPrintError(FF_BLUETOOTHRADIO_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "Bluetooth radios found but none enabled");
+        else
+            ffPrintError(FF_BLUETOOTHRADIO_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "No devices detected");
     }
 
     FF_LIST_FOR_EACH(FFBluetoothRadioResult, radio, radios)
@@ -103,6 +102,7 @@ void ffPrintBluetoothRadio(FFBluetoothRadioOptions* options)
         ffStrbufDestroy(&radio->address);
         ffStrbufDestroy(&radio->vendor);
     }
+    return true;
 }
 
 void ffParseBluetoothRadioJsonObject(FFBluetoothRadioOptions* options, yyjson_val* module)
@@ -123,15 +123,15 @@ void ffGenerateBluetoothRadioJsonConfig(FFBluetoothRadioOptions* options, yyjson
     ffJsonConfigGenerateModuleArgsConfig(doc, module, &options->moduleArgs);
 }
 
-void ffGenerateBluetoothRadioJsonResult(FF_MAYBE_UNUSED FFBluetoothRadioOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+bool ffGenerateBluetoothRadioJsonResult(FF_MAYBE_UNUSED FFBluetoothRadioOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
 {
     FF_LIST_AUTO_DESTROY results = ffListCreate(sizeof(FFBluetoothRadioResult));
 
     const char* error = ffDetectBluetoothRadio(&results);
     if (error)
     {
         yyjson_mut_obj_add_str(doc, module, "error", error);
-        return;
+        return false;
     }
 
     yyjson_mut_val* arr = yyjson_mut_obj_add_arr(doc, module, "result");
@@ -161,6 +161,8 @@ void ffGenerateBluetoothRadioJsonResult(FF_MAYBE_UNUSED FFBluetoothRadioOptions*
         ffStrbufDestroy(&radio->address);
         ffStrbufDestroy(&radio->vendor);
     }
+
+    return true;
 }
 
 void ffInitBluetoothRadioOptions(FFBluetoothRadioOptions* options)

src/modules/bluetoothradio/bluetoothradio.h

@@ -4,7 +4,7 @@
 
 #define FF_BLUETOOTHRADIO_MODULE_NAME "BluetoothRadio"
 
-void ffPrintBluetoothRadio(FFBluetoothRadioOptions* options);
+bool ffPrintBluetoothRadio(FFBluetoothRadioOptions* options);
 void ffInitBluetoothRadioOptions(FFBluetoothRadioOptions* options);
 void ffDestroyBluetoothRadioOptions(FFBluetoothRadioOptions* options);
 

src/modules/board/board.c

@@ -4,8 +4,9 @@
 #include "modules/board/board.h"
 #include "util/stringUtils.h"
 
-void ffPrintBoard(FFBoardOptions* options)
+bool ffPrintBoard(FFBoardOptions* options)
 {
+    bool success = false;
     FFBoardResult result;
     ffStrbufInit(&result.name);
     ffStrbufInit(&result.vendor);
@@ -42,12 +43,14 @@ void ffPrintBoard(FFBoardOptions* options)
             FF_FORMAT_ARG(result.serial, "serial"),
         }));
     }
+    success = true;
 
 exit:
     ffStrbufDestroy(&result.name);
     ffStrbufDestroy(&result.vendor);
     ffStrbufDestroy(&result.version);
     ffStrbufDestroy(&result.serial);
+    return success;
 }
 
 void ffParseBoardJsonObject(FFBoardOptions* options, yyjson_val* module)
@@ -68,8 +71,9 @@ void ffGenerateBoardJsonConfig(FFBoardOptions* options, yyjson_mut_doc* doc, yyj
     ffJsonConfigGenerateModuleArgsConfig(doc, module, &options->moduleArgs);
 }
 
-void ffGenerateBoardJsonResult(FF_MAYBE_UNUSED FFBoardOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
+bool ffGenerateBoardJsonResult(FF_MAYBE_UNUSED FFBoardOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module)
 {
+    bool success = false;
     FFBoardResult board;
     ffStrbufInit(&board.name);
     ffStrbufInit(&board.vendor);
@@ -95,12 +99,14 @@ void ffGenerateBoardJsonResult(FF_MAYBE_UNUSED FFBoardOptions* options, yyjson_m
     yyjson_mut_obj_add_strbuf(doc, obj, "vendor", &board.vendor);
     yyjson_mut_obj_add_strbuf(doc, obj, "version", &board.version);
     yyjson_mut_obj_add_strbuf(doc, obj, "serial", &board.serial);
+    success = true;
 
 exit:
     ffStrbufDestroy(&board.name);
     ffStrbufDestroy(&board.vendor);
     ffStrbufDestroy(&board.version);
     ffStrbufDestroy(&board.serial);
+    return success;
 }
 
 void ffInitBoardOptions(FFBoardOptions* options)