output/null: Add a null module that discards all data.

[libsigrok.git] / src / output / output.c

diff --git a/src/output/output.c b/src/output/output.c
index 7eaa489ee8561142f97fabc3aa964526ab47cf8c..c6c2d7206cbb2fce828177546659a13284127258 100644 (file)
--- a/src/output/output.c
+++ b/src/output/output.c
@@ -17,11 +17,14 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <string.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "output"
+/** @endcond */
 
 /**
  * @file
@@ -35,7 +38,7 @@
  * Output module handling.
  *
  * libsigrok supports several output modules for file formats such as binary,
- * VCD, gnuplot, and so on. It provides an output API that frontends can use.
+ * VCD, csv, and so on. It provides an output API that frontends can use.
  * New output modules can be added/implemented in libsigrok without having
  * to change the frontends at all.
  *
@@ -56,12 +59,12 @@ extern SR_PRIV struct sr_output_module output_ascii;
 extern SR_PRIV struct sr_output_module output_binary;
 extern SR_PRIV struct sr_output_module output_vcd;
 extern SR_PRIV struct sr_output_module output_ols;
-extern SR_PRIV struct sr_output_module output_gnuplot;
 extern SR_PRIV struct sr_output_module output_chronovu_la8;
 extern SR_PRIV struct sr_output_module output_csv;
 extern SR_PRIV struct sr_output_module output_analog;
 extern SR_PRIV struct sr_output_module output_srzip;
 extern SR_PRIV struct sr_output_module output_wav;
+extern SR_PRIV struct sr_output_module output_null;
 /* @endcond */
 
 static const struct sr_output_module *output_module_list[] = {
@@ -69,7 +72,6 @@ static const struct sr_output_module *output_module_list[] = {
        &output_binary,
        &output_bits,
        &output_csv,
-       &output_gnuplot,
        &output_hex,
        &output_ols,
        &output_vcd,
@@ -77,6 +79,7 @@ static const struct sr_output_module *output_module_list[] = {
        &output_analog,
        &output_srzip,
        &output_wav,
+       &output_null,
        NULL,
 };
 
@@ -95,14 +98,14 @@ SR_API const struct sr_output_module **sr_output_list(void)
  *
  * @since 0.4.0
  */
-SR_API const char *sr_output_id_get(const struct sr_output_module *o)
+SR_API const char *sr_output_id_get(const struct sr_output_module *omod)
 {
-       if (!o) {
+       if (!omod) {
                sr_err("Invalid output module NULL!");
                return NULL;
        }
 
-       return o->id;
+       return omod->id;
 }
 
 /**
@@ -110,14 +113,14 @@ SR_API const char *sr_output_id_get(const struct sr_output_module *o)
  *
  * @since 0.4.0
  */
-SR_API const char *sr_output_name_get(const struct sr_output_module *o)
+SR_API const char *sr_output_name_get(const struct sr_output_module *omod)
 {
-       if (!o) {
+       if (!omod) {
                sr_err("Invalid output module NULL!");
                return NULL;
        }
 
-       return o->name;
+       return omod->name;
 }
 
 /**
@@ -125,14 +128,14 @@ SR_API const char *sr_output_name_get(const struct sr_output_module *o)
  *
  * @since 0.4.0
  */
-SR_API const char *sr_output_description_get(const struct sr_output_module *o)
+SR_API const char *sr_output_description_get(const struct sr_output_module *omod)
 {
-       if (!o) {
+       if (!omod) {
                sr_err("Invalid output module NULL!");
                return NULL;
        }
 
-       return o->desc;
+       return omod->desc;
 }
 
 /**
@@ -144,14 +147,26 @@ SR_API const char *sr_output_description_get(const struct sr_output_module *o)
  * @since 0.4.0
  */
 SR_API const char *const *sr_output_extensions_get(
-               const struct sr_output_module *o)
+               const struct sr_output_module *omod)
 {
-       if (!o) {
+       if (!omod) {
                sr_err("Invalid output module NULL!");
                return NULL;
        }
 
-       return o->exts;
+       return omod->exts;
+}
+
+/*
+ * Checks whether a given flag is set.
+ *
+ * @see sr_output_flag
+ * @since 0.4.0
+ */
+SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
+               uint64_t flag)
+{
+       return (flag & omod->flags);
 }
 
 /**
@@ -181,15 +196,15 @@ SR_API const struct sr_output_module *sr_output_find(char *id)
  *
  * @since 0.4.0
  */
-SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *o)
+SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod)
 {
        const struct sr_option *mod_opts, **opts;
        int size, i;
 
-       if (!o || !o->options)
+       if (!omod || !omod->options)
                return NULL;
 
-       mod_opts = o->options();
+       mod_opts = omod->options();
 
        for (size = 0; mod_opts[size].id; size++)
                ;
@@ -242,8 +257,9 @@ SR_API void sr_output_options_free(const struct sr_option **options)
  *
  * @since 0.4.0
  */
-SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
-               GHashTable *options, const struct sr_dev_inst *sdi)
+SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
+               GHashTable *options, const struct sr_dev_inst *sdi,
+               const char *filename)
 {
        struct sr_output *op;
        const struct sr_option *mod_opts;
@@ -254,20 +270,22 @@ SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
        int i;
 
        op = g_malloc(sizeof(struct sr_output));
-       op->module = o;
+       op->module = omod;
        op->sdi = sdi;
+       op->filename = g_strdup(filename);
 
        new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
                        (GDestroyNotify)g_variant_unref);
-       if (o->options) {
-               mod_opts = o->options();
+       if (omod->options) {
+               mod_opts = omod->options();
                for (i = 0; mod_opts[i].id; i++) {
                        if (options && g_hash_table_lookup_extended(options,
                                        mod_opts[i].id, &key, &value)) {
                                /* Pass option along. */
                                gvt = g_variant_get_type(mod_opts[i].def);
                                if (!g_variant_is_of_type(value, gvt)) {
-                                       sr_err("Invalid type for '%s' option.", key);
+                                       sr_err("Invalid type for '%s' option.",
+                                               (char *)key);
                                        g_free(op);
                                        return NULL;
                                }
@@ -285,7 +303,8 @@ SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
                        g_hash_table_iter_init(&iter, options);
                        while (g_hash_table_iter_next(&iter, &key, &value)) {
                                if (!g_hash_table_lookup(new_opts, key)) {
-                                       sr_err("Output module '%s' has no option '%s'", o->id, key);
+                                       sr_err("Output module '%s' has no option '%s'",
+                                               omod->id, (char *)key);
                                        g_hash_table_destroy(new_opts);
                                        g_free(op);
                                        return NULL;
@@ -333,6 +352,7 @@ SR_API int sr_output_free(const struct sr_output *o)
        ret = SR_OK;
        if (o->module->cleanup)
                ret = o->module->cleanup((struct sr_output *)o);
+       g_free((char *)o->filename);
        g_free((gpointer)o);
 
        return ret;