From efeb15f36a809f453379b96b9c806602d5dc7267 Mon Sep 17 00:00:00 2001
From: Hugues Delorme <delorme.hugues@fougue.pro>
Date: Thu, 19 Nov 2015 15:35:20 +0100
Subject: [PATCH] gmio_core/internal: more doc in string.h, also add
 gmio_const_string()

---
 src/gmio_core/internal/string.h | 43 +++++++++++++++++++++------------
 1 file changed, 27 insertions(+), 16 deletions(-)

diff --git a/src/gmio_core/internal/string.h b/src/gmio_core/internal/string.h
index 0f3c659..955c729 100644
--- a/src/gmio_core/internal/string.h
+++ b/src/gmio_core/internal/string.h
@@ -20,41 +20,44 @@
 
 #include <stddef.h>
 
-/*! Stores traditional 8-bit read-only strings
+/*! Stores a read-only string of 8-bit chars
  *
  *  For faster lookups, it knowns the length of its contents.
  */
 struct gmio_const_string
 {
-    const char* ptr;
-    size_t len;
+    const char* ptr; /*!< Contents */
+    size_t len;      /*!< Size(length) of current contents */
 };
 typedef struct gmio_const_string gmio_const_string_t;
 
-/*! Expands to bracket initialization of a gmio_const_string from const char[]
- *
- *  Example:
- *  \code
- *      const char token[] = "woops";
- *      const gmio_const_string_t token_s = GMIO_CONST_STRING_FROM_ARRAY(token);
- *  \endcode
- */
-#define GMIO_CONST_STRING_FROM_ARRAY(array) { &(array)[0], sizeof(array) - 1 }
-
-/*! Stores traditional 8-bit mutable strings
+/*! Stores a mutable string of 8-bit chars
  *
  *  For faster lookups, it knowns the length of its contents. Length must not
  *  exceeds the maximum size(capacity).
  */
 struct gmio_string
 {
-    char*  ptr; /*!< Buffer contents */
+    char*  ptr; /*!< Contents */
     size_t len; /*!< Size(length) of current contents */
     size_t max_len; /*!< Maximum contents size(capacity) */
 };
-
 typedef struct gmio_string gmio_string_t;
 
+/*! Expands to bracket initialization of a gmio_const_string from const char[]
+ *
+ *  Example:
+ *  \code
+ *      const char token[] = "woops";
+ *      gmio_const_string_t token_s = GMIO_CONST_STRING_FROM_ARRAY(token);
+ *  \endcode
+ */
+#define GMIO_CONST_STRING_FROM_ARRAY(array) { &(array)[0], sizeof(array) - 1 }
+
+/*! Returns an initialized gmio_const_string_t object */
+GMIO_INLINE gmio_const_string_t gmio_const_string(const char* ptr, size_t len);
+
+/*! Clears the contents of the string \p str and makes it null */
 GMIO_INLINE void gmio_string_clear(gmio_string_t* str);
 
 
@@ -63,6 +66,14 @@ GMIO_INLINE void gmio_string_clear(gmio_string_t* str);
  * -- Implementation
  */
 
+gmio_const_string_t gmio_const_string(const char* ptr, size_t len)
+{
+    gmio_const_string_t cstr;
+    cstr.ptr = ptr;
+    cstr.len = len;
+    return cstr;
+}
+
 void gmio_string_clear(gmio_string_t* str)
 {
     str->ptr[0] = 0;