]> sigrok.org Git - libsigrok.git/blobdiff - output/output_gnuplot.c
gnuplot output: More error checks.
[libsigrok.git] / output / output_gnuplot.c
index 18e7631811d36ebf352148d1823cd560aba8feed..ec50b9d2bfa8a6c3bc794986f5bb98351eb9134d 100644 (file)
 struct context {
        unsigned int num_enabled_probes;
        unsigned int unitsize;
-       char *probelist[MAX_NUM_PROBES+1];
+       char *probelist[SR_MAX_NUM_PROBES + 1];
        char *header;
 };
 
-#define MAX_HEADER_LEN   1024 + (MAX_NUM_PROBES * (MAX_PROBENAME_LEN + 10))
-const char *gnuplot_header = "\
+#define MAX_HEADER_LEN \
+       (1024 + (SR_MAX_NUM_PROBES * (SR_MAX_PROBENAME_LEN + 10)))
+
+static const char *gnuplot_header = "\
 # Sample data in space-separated columns format usable by gnuplot\n\
 #\n\
 # Generated by: %s on %s%s\
@@ -43,7 +45,7 @@ const char *gnuplot_header = "\
 ----------------------------------------\n\
 # 0\t\tSample counter (for internal gnuplot purposes)\n%s\n";
 
-const char *gnuplot_header_comment = "\
+static const char *gnuplot_header_comment = "\
 # Comment: Acquisition with %d/%d probes at %s\n";
 
 static int init(struct sr_output *o)
@@ -58,10 +60,30 @@ static int init(struct sr_output *o)
        char wbuf[1000], comment[128];
        time_t t;
 
-       if (!(ctx = calloc(1, sizeof(struct context))))
+       if (!o) {
+               g_warning("gnuplot out: %s: o was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!o->device) {
+               g_warning("gnuplot out: %s: o->device was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!o->device->plugin) {
+               g_warning("gnuplot out: %s: o->device->plugin was NULL",
+                         __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!(ctx = calloc(1, sizeof(struct context)))) {
+               g_warning("gnuplot out: %s: ctx calloc failed", __func__);
                return SR_ERR_MALLOC;
+       }
 
        if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
+               g_warning("gnuplot out: %s: ctx->header calloc failed",
+                         __func__);
                free(ctx);
                return SR_ERR_MALLOC;
        }
@@ -69,7 +91,7 @@ static int init(struct sr_output *o)
        o->internal = ctx;
        ctx->num_enabled_probes = 0;
        for (l = o->device->probes; l; l = l->next) {
-               probe = l->data;
+               probe = l->data; /* TODO: Error checks. */
                if (!probe->enabled)
                        continue;
                ctx->probelist[ctx->num_enabled_probes++] = probe->name;
@@ -79,10 +101,12 @@ static int init(struct sr_output *o)
 
        num_probes = g_slist_length(o->device->probes);
        comment[0] = '\0';
-       if (o->device->plugin && sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
+       if (sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
                samplerate = *((uint64_t *) o->device->plugin->get_device_info(
                                o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
                if (!(frequency_s = sr_samplerate_string(samplerate))) {
+                       g_warning("gnuplot out: %s: sr_samplerate_string "
+                                 "failed", __func__);
                        free(ctx->header);
                        free(ctx);
                        return SR_ERR;
@@ -100,10 +124,12 @@ static int init(struct sr_output *o)
        }
 
        if (!(frequency_s = sr_period_string(samplerate))) {
+               g_warning("gnuplot out: %s: sr_period_string failed", __func__);
                free(ctx->header);
                free(ctx);
                return SR_ERR;
        }
+
        t = time(NULL);
        b = snprintf(ctx->header, MAX_HEADER_LEN, gnuplot_header,
                     PACKAGE_STRING, ctime(&t), comment, frequency_s,
@@ -111,6 +137,7 @@ static int init(struct sr_output *o)
        free(frequency_s);
 
        if (b < 0) {
+               g_warning("gnuplot out: %s: sprintf failed", __func__);
                free(ctx->header);
                free(ctx);
                return SR_ERR;
@@ -124,15 +151,35 @@ static int event(struct sr_output *o, int event_type, char **data_out,
 {
        struct context *ctx;
 
+       if (!o) {
+               g_warning("gnuplot out: %s: o was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!data_out) {
+               g_warning("gnuplot out: %s: data_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!length_out) {
+               g_warning("gnuplot out: %s: length_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
        ctx = o->internal;
+
        switch (event_type) {
        case SR_DF_TRIGGER:
-               /* TODO: can a trigger mark be in a gnuplot data file? */
+               /* TODO: Can a trigger mark be in a gnuplot data file? */
                break;
        case SR_DF_END:
                free(o->internal);
                o->internal = NULL;
                break;
+       default:
+               g_warning("gnuplot out: %s: unsupported event type: %d",
+                         __func__, event_type);
+               break;
        }
 
        *data_out = NULL;
@@ -141,7 +188,7 @@ static int event(struct sr_output *o, int event_type, char **data_out,
        return SR_OK;
 }
 
-static int data(struct sr_output *o, char *data_in, uint64_t length_in,
+static int data(struct sr_output *o, const char *data_in, uint64_t length_in,
                char **data_out, uint64_t *length_out)
 {
        struct context *ctx;
@@ -150,14 +197,41 @@ static int data(struct sr_output *o, char *data_in, uint64_t length_in,
        static uint64_t samplecount = 0;
        char *outbuf, *c;
 
+       if (!o) {
+               g_warning("gnuplot out: %s: o was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!o->internal) {
+               g_warning("gnuplot out: %s: o->internal was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!data_in) {
+               g_warning("gnuplot out: %s: data_in was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!data_out) {
+               g_warning("gnuplot out: %s: data_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (!length_out) {
+               g_warning("gnuplot out: %s: length_out was NULL", __func__);
+               return SR_ERR_ARG;
+       }
+
        ctx = o->internal;
        max_linelen = 16 + ctx->num_enabled_probes * 2;
        outsize = length_in / ctx->unitsize * max_linelen;
        if (ctx->header)
                outsize += strlen(ctx->header);
 
-       if (!(outbuf = calloc(1, outsize)))
+       if (!(outbuf = calloc(1, outsize))) {
+               g_warning("gnuplot out: %s: outbuf calloc failed", __func__);
                return SR_ERR_MALLOC;
+       }
 
        outbuf[0] = '\0';
        if (ctx->header) {
@@ -192,12 +266,12 @@ static int data(struct sr_output *o, char *data_in, uint64_t length_in,
 }
 
 struct sr_output_format output_gnuplot = {
-       "gnuplot",
-       "Gnuplot",
-       SR_DF_LOGIC,
-       init,
-       data,
-       event,
+       .id = "gnuplot",
+       .description = "Gnuplot",
+       .df_type = SR_DF_LOGIC,
+       .init = init,
+       .data = data,
+       .event = event,
 };
 
 /* Temporarily disabled. */
@@ -232,8 +306,8 @@ static int analog_init(struct sr_output *o)
        }
        ctx->probelist[ctx->num_enabled_probes] = 0;
 //     ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
-       ctx->unitsize = sizeof(struct analog_sample) +
-                       (ctx->num_enabled_probes * sizeof(struct analog_probe));
+       ctx->unitsize = sizeof(struct sr_analog_sample) +
+                       (ctx->num_enabled_probes * sizeof(struct sr_analog_probe));
 
        num_probes = g_slist_length(o->device->probes);
        comment[0] = '\0';
@@ -285,7 +359,7 @@ static int analog_data(struct sr_output *o, char *data_in, uint64_t length_in,
 //     uint64_t sample;
        static uint64_t samplecount = 0;
        char *outbuf, *c;
-       struct analog_sample *sample;
+       struct sr_analog_sample *sample;
 
        ctx = o->internal;
 //     max_linelen = 16 + ctx->num_enabled_probes * 2;
@@ -307,7 +381,7 @@ static int analog_data(struct sr_output *o, char *data_in, uint64_t length_in,
 
        for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 //             memcpy(&sample, data_in + i, ctx->unitsize);
-               sample = (struct analog_sample *) (data_in + i);
+               sample = (struct sr_analog_sample *) (data_in + i);
 
                /* The first column is a counter (needed for gnuplot). */
                c = outbuf + strlen(outbuf);
@@ -338,11 +412,11 @@ static int analog_data(struct sr_output *o, char *data_in, uint64_t length_in,
 }
 
 struct sr_output_format output_analog_gnuplot = {
-       "analog_gnuplot",
-       "Gnuplot analog",
-       SR_DF_ANALOG,
-       analog_init,
-       analog_data,
-       event,
+       .id = "analog_gnuplot",
+       .description = "Gnuplot analog",
+       .df_type = SR_DF_ANALOG,
+       .init = analog_init,
+       .data = analog_data,
+       .event = event,
 };
 #endif