/*
* This file is part of the libsigrok project.
*
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* 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
* 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.
*
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[] = {
&output_binary,
&output_bits,
&output_csv,
- &output_gnuplot,
&output_hex,
&output_ols,
&output_vcd,
&output_chronovu_la8,
&output_analog,
+ &output_srzip,
&output_wav,
+ &output_null,
NULL,
};
*
* @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;
}
/**
*
* @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;
}
/**
*
* @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;
+}
+
+/**
+ * Returns the specified output module's file extensions typical for the file
+ * format, as a NULL terminated array, or returns a NULL pointer if there is
+ * no preferred extension.
+ * @note these are a suggestions only.
+ *
+ * @since 0.4.0
+ */
+SR_API const char *const *sr_output_extensions_get(
+ const struct sr_output_module *omod)
+{
+ if (!omod) {
+ sr_err("Invalid output module NULL!");
+ return NULL;
+ }
+
+ 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);
}
/**
*
* @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 = 1; mod_opts[size].id; size++)
+ for (size = 0; mod_opts[size].id; size++)
;
- opts = g_malloc(size * sizeof(struct sr_option *));
+ opts = g_malloc((size + 1) * sizeof(struct sr_option *));
for (i = 0; i < size; i++)
opts[i] = &mod_opts[i];
*
* @since 0.4.0
*/
-SR_API void sr_output_options_free(const struct sr_option **opts)
+SR_API void sr_output_options_free(const struct sr_option **options)
{
- struct sr_option *opt;
+ int i;
- if (!opts)
+ if (!options)
return;
- for (opt = (struct sr_option *)opts[0]; opt; opt++) {
- if (opt->def) {
- g_variant_unref(opt->def);
- opt->def = NULL;
+ for (i = 0; options[i]; i++) {
+ if (options[i]->def) {
+ g_variant_unref(options[i]->def);
+ ((struct sr_option *)options[i])->def = NULL;
}
- if (opt->values) {
- g_slist_free_full(opt->values, (GDestroyNotify)g_variant_unref);
- opt->values = NULL;
+ if (options[i]->values) {
+ g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
+ ((struct sr_option *)options[i])->values = NULL;
}
}
- g_free(opts);
+ g_free(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;
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;
}
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;
}
if (op->module->init && op->module->init(op, new_opts) != SR_OK) {
- g_hash_table_destroy(new_opts);
g_free(op);
op = NULL;
}
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;
projects / libsigrok.git / blobdiff