Build: Set local include directories in Makefile.am

[libsigrok.git] / src / analog.c

diff --git a/src/analog.c b/src/analog.c
index 4fd6a6f9a4410d06d0152e789b31bf662680ee6c..a0a48de9754115647f90c0ea844683aa5a5db719 100644 (file)
--- a/src/analog.c
+++ b/src/analog.c
@@ -21,10 +21,26 @@
 #include <stdint.h>
 #include <string.h>
 #include <ctype.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "analog"
+/** @endcond */
+
+/**
+ * @file
+ *
+ * Handling and converting analog data.
+ */
+
+/**
+ * @defgroup grp_analog Analog data handling
+ *
+ * Handling and converting analog data.
+ *
+ * @{
+ */
 
 struct unit_mq_string {
        uint64_t value;
@@ -165,25 +181,26 @@ SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
  *
  * @param value The value to convert.
  * @param digits Number of digits after the decimal point to print.
- * @param outbuf Buffer in which the resulting string will be placed.
- * @param bufsize Size of the buffer in bytes.
+ * @param result Pointer to store result.
+ *
+ * The string is allocated by the function and must be freed by the caller
+ * after use by calling g_free().
  *
  * @retval SR_OK
  *
  * @since 0.4.0
  */
-SR_API int sr_analog_float_to_string(float value, int digits, char *outbuf,
-               int bufsize)
+SR_API int sr_analog_float_to_string(float value, int digits, char **result)
 {
        int cnt, i;
 
        /* This produces at least one too many digits */
-       snprintf(outbuf, bufsize, "%.*f", digits, value);
-       for (i = 0, cnt = 0; outbuf[i] && i < bufsize; i++) {
-               if (isdigit(outbuf[i++]))
+       *result = g_strdup_printf("%.*f", digits, value);
+       for (i = 0, cnt = 0; (*result)[i]; i++) {
+               if (isdigit((*result)[i++]))
                        cnt++;
                if (cnt == digits) {
-                       outbuf[i] = 0;
+                       (*result)[i] = 0;
                        break;
                }
        }
@@ -195,34 +212,49 @@ SR_API int sr_analog_float_to_string(float value, int digits, char *outbuf,
  * Convert the unit/MQ/MQ flags in the analog struct to a string.
  *
  * @param analog Struct containing the unit, MQ and MQ flags.
- * @param outbuf Buffer in which the resulting string will be placed.
- * @param bufsize Size of the buffer in bytes.
+ * @param result Pointer to store result.
+ *
+ * The string is allocated by the function and must be freed by the caller
+ * after use by calling g_free().
  *
  * @retval SR_OK
  *
  * @since 0.4.0
  */
 SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog2 *analog,
-               char *outbuf, int bufsize)
+               char **result)
 {
-       int len, i;
+       int i;
+       GString *buf = g_string_new(NULL);
 
-       outbuf[0] = 0;
        for (i = 0; unit_strings[i].value; i++) {
                if (analog->meaning->unit == unit_strings[i].value) {
-                       strncpy(outbuf, unit_strings[i].str, bufsize);
+                       g_string_assign(buf, unit_strings[i].str);
                        break;
                }
        }
 
        /* More than one MQ flag may apply. */
-       for (i = 0; mq_strings[i].value; i++) {
-               if (analog->meaning->mqflags & mq_strings[i].value) {
-                       len = strlen(outbuf);
-                       strncat(outbuf + len, mq_strings[i].str, bufsize - len);
-               }
-       }
+       for (i = 0; mq_strings[i].value; i++)
+               if (analog->meaning->mqflags & mq_strings[i].value)
+                       g_string_append(buf, mq_strings[i].str);
+
+       *result = buf->str;
+       g_string_free(buf, FALSE);
 
        return SR_OK;
 }
 
+/*
+ * Set sr_rational r to the given value.
+ *
+ * @param p Numerator
+ * @param q Denominator
+ */
+SR_API void sr_rational_set(struct sr_rational *r, uint64_t p, uint64_t q)
+{
+       r->p = p;
+       r->q = q;
+}
+
+/** @} */