Changeset 0c43130 in rtems for cpukit/libcsupport/include/rtems/assoc.h

Timestamp:

01/11/17 10:03:24 (6 years ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

5, master

Children:

b7f1fc3b

Parents:

fa9f964f

git-author:

Sebastian Huber <sebastian.huber@…> (01/11/17 10:03:24)

git-committer:

Sebastian Huber <sebastian.huber@…> (01/12/17 06:44:36)

Message:

Add rtems_assoc_32_to_string()

File:

• cpukit/libcsupport/include/rtems/assoc.h (modified) (2 diffs)

cpukit/libcsupport/include/rtems/assoc.h

@@ -17 +17 @@
 /**@{*/
 
-#include <stdint.h> /* uint32_t */
+#include <stddef.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
@@ -151 +152 @@
 #endif
 
+typedef struct {
+  uint32_t    bits;
+  const char *name;
+} rtems_assoc_32_pair;
+
+/**
+ * @brief Converts the specified value into a text representation.
+ *
+ * @param[in] value The value to convert.
+ * @param[in] buffer The buffer for the text representation.
+ * @param[in] buffer_size The buffer size in characters.
+ * @param[in] pairs Names for particular bits.
+ * @param[in] pair_count Count of pairs.
+ * @param[in] separator Separator between individual names.
+ * @param[in] fallback Fallback value in case no bits contained in the pairs
+ *   are set in the value.
+ *
+ * @retval The length of the text representation.  May be greater than the
+ * buffer size if truncation occurred.
+ */
+size_t rtems_assoc_32_to_string(
+  uint32_t                   value,
+  char                      *buffer,
+  size_t                     buffer_size,
+  const rtems_assoc_32_pair *pairs,
+  size_t                     pair_count,
+  const char                *separator,
+  const char                *fallback
+);
+
 #ifdef __cplusplus
 }