Build: Set local include directories in Makefile.am

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

diff --git a/src/input/input.c b/src/input/input.c
index 43b49d3f381a99caead2fe9eb5d5b96905bcce8a..8e51e3f96b7285d23611d77b8ac8d46083ce1593 100644 (file)
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -23,10 +23,12 @@
 #include <unistd.h>
 #include <fcntl.h>
 #include <errno.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "input"
+/** @endcond */
 
 /**
  * @file
@@ -89,14 +91,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 +106,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 +121,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 +231,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.
  *
@@ -271,15 +293,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;
@@ -364,7 +388,7 @@ SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
                        /* Module didn't recognize this buffer. */
                        continue;
                } else if (ret != SR_OK) {
-                       /* Can be SR_OK_CONTINUE. */
+                       /* Can be SR_ERR_NA. */
                        return ret;
                }
 
@@ -477,7 +501,7 @@ SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
                        /* Module didn't recognize this buffer. */
                        continue;
                } else if (ret != SR_OK) {
-                       /* Can be SR_OK_CONTINUE. */
+                       /* Can be SR_ERR_NA. */
                        return ret;
                }
 
@@ -519,7 +543,7 @@ SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
  * the device instance associated with this input instance, this is
  * guaranteed to return the moment it's ready. This gives the caller
  * the chance to examine the device instance, attach session callbacks
- * and on so.
+ * and so on.
  *
  * @since 0.4.0
  */
@@ -548,29 +572,22 @@ SR_API int sr_input_end(const struct sr_input *in)
  *
  * @since 0.4.0
  */
-SR_API int sr_input_free(const struct sr_input *in)
+SR_API void sr_input_free(const struct sr_input *in)
 {
-       int ret;
-
        if (!in)
-               return SR_ERR_ARG;
+               return;
 
-       ret = SR_OK;
        if (in->module->cleanup)
-               ret = in->module->cleanup((struct sr_input *)in);
+               in->module->cleanup((struct sr_input *)in);
        if (in->sdi)
                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);
        }
-       if (in->buf)
-               g_string_free(in->buf, TRUE);
+       g_string_free(in->buf, TRUE);
        g_free(in->priv);
        g_free((gpointer)in);
-
-       return ret;
 }
 
-
 /** @} */