X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Finput%2Finput.c;h=9d471ca4fdad53612889036dec3d0c498d00c6df;hb=bcf9384d3d2cad0effb5ef2769697d8af05b8a17;hp=4b0804a58b3efe77418f0f51b37a108b2cacd86c;hpb=60107497fed4b307a7d64d23e3d8d6137f64c4e4;p=libsigrok.git
diff --git a/src/input/input.c b/src/input/input.c
index 4b0804a5..9d471ca4 100644
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -17,16 +17,17 @@
* along with this program. If not, see .
*/
+#include
#include
-#include
-#include
-#include
-#include
#include
-#include "libsigrok.h"
+#include
+#include
+#include
#include "libsigrok-internal.h"
+/** @cond PRIVATE */
#define LOG_PREFIX "input"
+/** @endcond */
/**
* @file
@@ -89,14 +90,14 @@ SR_API const struct sr_input_module **sr_input_list(void)
*
* @since 0.4.0
*/
-SR_API const char *sr_input_id_get(const struct sr_input_module *o)
+SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
{
- if (!o) {
+ if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
- return o->id;
+ return imod->id;
}
/**
@@ -104,14 +105,14 @@ SR_API const char *sr_input_id_get(const struct sr_input_module *o)
*
* @since 0.4.0
*/
-SR_API const char *sr_input_name_get(const struct sr_input_module *o)
+SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
{
- if (!o) {
+ if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
- return o->name;
+ return imod->name;
}
/**
@@ -119,14 +120,33 @@ SR_API const char *sr_input_name_get(const struct sr_input_module *o)
*
* @since 0.4.0
*/
-SR_API const char *sr_input_description_get(const struct sr_input_module *o)
+SR_API const char *sr_input_description_get(const struct sr_input_module *imod)
+{
+ if (!imod) {
+ sr_err("Invalid input module NULL!");
+ return NULL;
+ }
+
+ return imod->desc;
+}
+
+/**
+ * Returns the specified input 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_input_extensions_get(
+ const struct sr_input_module *imod)
{
- if (!o) {
+ if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
- return o->desc;
+ return imod->exts;
}
/**
@@ -210,8 +230,9 @@ SR_API void sr_input_options_free(const struct sr_option **options)
* This function is used when a client wants to use a specific input
* module to parse a stream. No effort is made to identify the format.
*
+ * @param imod The input module to use. Must not be NULL.
* @param options GHashTable consisting of keys corresponding with
- * the module options \c id field. The values should be GVariant
+ * the module options @c id field. The values should be GVariant
* pointers with sunk references, of the same GVariantType as the option's
* default value.
*
@@ -221,7 +242,7 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
GHashTable *options)
{
struct sr_input *in;
- struct sr_option *mod_opts;
+ const struct sr_option *mod_opts;
const GVariantType *gvt;
GHashTable *new_opts;
GHashTableIter iter;
@@ -241,7 +262,8 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
/* Option not given: insert the default value. */
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(in);
return NULL;
}
@@ -259,7 +281,8 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
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("Input module '%s' has no option '%s'", imod->id, key);
+ sr_err("Input module '%s' has no option '%s'",
+ imod->id, (char *)key);
g_hash_table_destroy(new_opts);
g_free(in);
return NULL;
@@ -271,15 +294,17 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
g_free(in);
in = NULL;
+ } else {
+ in->buf = g_string_sized_new(128);
}
+
if (new_opts)
g_hash_table_destroy(new_opts);
- in->buf = g_string_sized_new(128);
return in;
}
-/* Returns TRUE is all required meta items are available. */
+/* Returns TRUE if all required meta items are available. */
static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
{
int m, a;
@@ -387,42 +412,64 @@ SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
*/
SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
{
+ int64_t filesize;
+ FILE *stream;
const struct sr_input_module *imod;
GHashTable *meta;
- GString *header_buf;
- struct stat st;
- unsigned int midx, m, i;
- int fd, ret;
- ssize_t size;
- uint8_t mitem, avail_metadata[8];
+ GString *header;
+ size_t count;
+ unsigned int midx, i;
+ int ret;
+ uint8_t avail_metadata[8];
+
+ *in = NULL;
if (!filename || !filename[0]) {
sr_err("Invalid filename.");
return SR_ERR_ARG;
}
-
- if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
- sr_err("No such file.");
- return SR_ERR_ARG;
+ stream = g_fopen(filename, "rb");
+ if (!stream) {
+ sr_err("Failed to open %s: %s", filename, g_strerror(errno));
+ return SR_ERR;
}
-
- if (stat(filename, &st) < 0) {
- sr_err("%s", strerror(errno));
- return SR_ERR_ARG;
+ filesize = sr_file_get_size(stream);
+ if (filesize < 0) {
+ sr_err("Failed to get size of %s: %s",
+ filename, g_strerror(errno));
+ fclose(stream);
+ return SR_ERR;
}
-
+ /* This actually allocates 256 bytes to allow for NUL termination. */
+ header = g_string_sized_new(255);
+ count = fread(header->str, 1, header->allocated_len - 1, stream);
+
+ if (count != header->allocated_len - 1 && ferror(stream)) {
+ sr_err("Failed to read %s: %s", filename, g_strerror(errno));
+ fclose(stream);
+ g_string_free(header, TRUE);
+ return SR_ERR;
+ }
+ fclose(stream);
+ g_string_set_size(header, count);
+
+ meta = g_hash_table_new(NULL, NULL);
+ g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILENAME),
+ (char *)filename);
+ g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILESIZE),
+ GSIZE_TO_POINTER(MIN(filesize, G_MAXSSIZE)));
+ g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_HEADER),
+ header);
midx = 0;
avail_metadata[midx++] = SR_INPUT_META_FILENAME;
avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
avail_metadata[midx++] = SR_INPUT_META_HEADER;
+ avail_metadata[midx] = 0;
/* TODO: MIME type */
- *in = NULL;
ret = SR_ERR;
- header_buf = g_string_sized_new(128);
- for (i = 0; input_module_list[i]; i++) {
- g_string_truncate(header_buf, 0);
+ for (i = 0; input_module_list[i]; i++) {
imod = input_module_list[i];
if (!imod->metadata[0]) {
/* Module has no metadata for matching so will take
@@ -433,60 +480,24 @@ SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
/* Cannot satisfy this module's requirements. */
continue;
- meta = g_hash_table_new(NULL, NULL);
- for (m = 0; m < sizeof(imod->metadata); m++) {
- mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
- if (!mitem)
- /* Metadata list is 0-terminated. */
- break;
- if (mitem == SR_INPUT_META_FILENAME) {
- g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
- (gpointer)filename);
- } else if (mitem == SR_INPUT_META_FILESIZE) {
- g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
- GINT_TO_POINTER(st.st_size));
- } else if (mitem == SR_INPUT_META_HEADER) {
- if ((fd = open(filename, O_RDONLY)) < 0) {
- sr_err("%s", strerror(errno));
- return SR_ERR;
- }
- size = read(fd, header_buf->str, 128);
- header_buf->len = size;
- close(fd);
- if (size <= 0) {
- g_string_free(header_buf, TRUE);
- sr_err("%s", strerror(errno));
- return SR_ERR;
- }
- g_hash_table_insert(meta, GINT_TO_POINTER(mitem), header_buf);
- }
- }
- if (g_hash_table_size(meta) == 0) {
- /* No metadata for this module, so there's no way it
- * can match. */
- g_hash_table_destroy(meta);
- continue;
- }
- sr_spew("Trying module %s.", imod->id);
+ sr_dbg("Trying module %s.", imod->id);
+
ret = imod->format_match(meta);
- g_hash_table_destroy(meta);
- if (ret == SR_ERR_DATA) {
- /* Module recognized this buffer, but cannot handle it. */
- break;
- } else if (ret == SR_ERR) {
+ if (ret == SR_ERR) {
/* Module didn't recognize this buffer. */
continue;
} else if (ret != SR_OK) {
- /* Can be SR_ERR_NA. */
- return ret;
+ /* Module recognized this buffer, but cannot handle it. */
+ break;
}
-
/* Found a matching module. */
- sr_spew("Module %s matched.", imod->id);
+ sr_dbg("Module %s matched.", imod->id);
+
*in = sr_input_new(imod, NULL);
break;
}
- g_string_free(header_buf, TRUE);
+ g_hash_table_destroy(meta);
+ g_string_free(header, TRUE);
return ret;
}
@@ -525,7 +536,8 @@ SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
*/
SR_API int sr_input_send(const struct sr_input *in, GString *buf)
{
- sr_spew("Sending %d bytes to %s module.", buf->len, in->module->id);
+ sr_spew("Sending %" G_GSIZE_FORMAT " bytes to %s module.",
+ buf->len, in->module->id);
return in->module->receive((struct sr_input *)in, buf);
}
@@ -559,12 +571,12 @@ SR_API void sr_input_free(const struct sr_input *in)
sr_dev_inst_free(in->sdi);
if (in->buf->len > 64) {
/* That seems more than just some sub-unitsize leftover... */
- sr_warn("Found %d unprocessed bytes at free time.", in->buf->len);
+ sr_warn("Found %" G_GSIZE_FORMAT
+ " unprocessed bytes at free time.", in->buf->len);
}
g_string_free(in->buf, TRUE);
g_free(in->priv);
g_free((gpointer)in);
}
-
/** @} */