Added first version of ACPI support to the battery plugin

[collectd.git] / src / common.h

diff --git a/src/common.h b/src/common.h
index a3fe5fde361ffdd85c98ebcd4913e41ad9bd51be..59984b182a0e1ac1e2ef3837fefec7e6bfddd1ab 100644 (file)
--- a/src/common.h
+++ b/src/common.h
@@ -37,8 +37,72 @@ void sstrncpy(char *d, const char *s, int len);
 char *sstrdup(const char *s);
 void *smalloc(size_t size);
 
+/*
+ * NAME
+ *   strsplit
+ *
+ * DESCRIPTION
+ *   Splits a string into parts and stores pointers to the parts in `fields'.
+ *   The characters split at are ` ' (space) and "\t" (tab).
+ *
+ * PARAMETERS
+ *   `string'      String to split. This string will be modified. `fields' will
+ *                 contain pointers to parts of this string, so free'ing it
+ *                 will destroy `fields' as well.
+ *   `fields'      Array of strings where pointers to the parts will be stored.
+ *   `size'        Number of elements in the array. No more than `size'
+ *                 pointers will be stored in `fields'.
+ *
+ * RETURN VALUE
+ *    Returns the number of parts stored in `fields'.
+ */
 int strsplit (char *string, char **fields, size_t size);
 
+/*
+ * NAME
+ *   strjoin
+ *
+ * DESCRIPTION
+ *   Joins together several parts of a string using `sep' as a seperator. This
+ *   is equipollent to the perl buildin `join'.
+ *
+ * PARAMETERS
+ *   `dst'         Buffer where the result is stored.
+ *   `dst_len'     Length of the destination buffer. No more than this many
+ *                 bytes will be written to the memory pointed to by `dst',
+ *                 including the trailing null-byte.
+ *   `fields'      Array of strings to be joined.
+ *   `fields_num'  Number of elements in the `fields' array.
+ *   `sep'         String to be inserted between any two elements of `fields'.
+ *                 This string is neither prepended nor appended to the result.
+ *                 Instead of passing "" (empty string) one can pass NULL.
+ *
+ * RETURN VALUE
+ *   Returns the number of characters in `dst', NOT including the trailing
+ *   null-byte. If an error occured (empty array or `dst' too small) a value
+ *   smaller than zero will be returned.
+ */
+int strjoin (char *dst, size_t dst_len, char **fields, size_t fields_num, const char *sep);
+
+/*
+ * NAME
+ *   escape_slashes
+ *
+ * DESCRIPTION
+ *   Removes slashes from the string `buf' and substitutes them with something
+ *   appropriate. This function should be used whenever a path is to be used as
+ *   (part of) an instance.
+ *
+ * PARAMETERS
+ *   `buf'         String to be escaped.
+ *   `buf_len'     Length of the buffer. No more then this many bytes will be
+ *   written to `buf', including the trailing null-byte.
+ *
+ * RETURN VALUE
+ *   Returns zero upon success and a value smaller than zero upon failure.
+ */
+int escape_slashes (char *buf, int buf_len);
+
 int rrd_update_file (char *host, char *file, char *values, char **ds_def,
                int ds_num);