cborpretty.c: add an internal flags argument

We'll use it soon. This commit is separate so it's easier to review the
new functionality without the code changes to support them.

Signed-off-by: Thiago Macieira <[email protected]>

Author: thiagomacieira

src/cbor.h

@@ -482,11 +482,17 @@ CBOR_INLINE_API CborError cbor_value_get_double(const CborValue *value, double *
 }
 
 /* Human-readable (dump) API */
+
+enum CborPrettyFlags {
+    CborPrettyDefaultFlags          = 0
+};
+
+CBOR_API CborError cbor_value_to_pretty_advance_flags(FILE *out, CborValue *value, int flags);
 CBOR_API CborError cbor_value_to_pretty_advance(FILE *out, CborValue *value);
 CBOR_INLINE_API CborError cbor_value_to_pretty(FILE *out, const CborValue *value)
 {
     CborValue copy = *value;
-    return cbor_value_to_pretty_advance(out, &copy);
+    return cbor_value_to_pretty_advance_flags(out, &copy, CborPrettyDefaultFlags);
 }
 
 #ifdef __cplusplus

src/cborpretty.c

@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2016 Intel Corporation
+** Copyright (C) 2017 Intel Corporation
 **
 ** Permission is hereby granted, free of charge, to any person obtaining a copy
 ** of this software and associated documentation files (the "Software"), to deal
@@ -110,6 +110,13 @@
  *      If the map length is indeterminate, an underscore ("_") appears immediately after the opening brace.
  */
 
+/**
+ * \enum CborPrettyFlags
+ * The CborPrettyFlags enum contains flags that control the conversion of CBOR to text format.
+ *
+ * \value CborPrettyDefaultFlags       Default conversion flags.
+ */
+
 static int hexDump(FILE *out, const uint8_t *buffer, size_t n)
 {
     while (n--) {
@@ -238,16 +245,16 @@ static int utf8EscapedDump(FILE *out, const char *buffer, size_t n)
     return CborNoError;
 }
 
-static CborError value_to_pretty(FILE *out, CborValue *it);
-static CborError container_to_pretty(FILE *out, CborValue *it, CborType containerType)
+static CborError value_to_pretty(FILE *out, CborValue *it, int flags);
+static CborError container_to_pretty(FILE *out, CborValue *it, CborType containerType, int flags)
 {
     const char *comma = "";
     while (!cbor_value_at_end(it)) {
         if (fprintf(out, "%s", comma) < 0)
             return CborErrorIO;
         comma = ", ";
 
-        CborError err = value_to_pretty(out, it);
+        CborError err = value_to_pretty(out, it, flags);
         if (err)
             return err;
 
@@ -257,14 +264,14 @@ static CborError container_to_pretty(FILE *out, CborValue *it, CborType containe
         /* map: that was the key, so get the value */
         if (fprintf(out, ": ") < 0)
             return CborErrorIO;
-        err = value_to_pretty(out, it);
+        err = value_to_pretty(out, it, flags);
         if (err)
             return err;
     }
     return CborNoError;
 }
 
-static CborError value_to_pretty(FILE *out, CborValue *it)
+static CborError value_to_pretty(FILE *out, CborValue *it, int flags)
 {
     CborError err;
     CborType type = cbor_value_get_type(it);
@@ -286,7 +293,7 @@ static CborError value_to_pretty(FILE *out, CborValue *it)
             it->ptr = recursed.ptr;
             return err;       /* parse error */
         }
-        err = container_to_pretty(out, &recursed, type);
+        err = container_to_pretty(out, &recursed, type, flags);
         if (err) {
             it->ptr = recursed.ptr;
             return err;       /* parse error */
@@ -360,7 +367,7 @@ static CborError value_to_pretty(FILE *out, CborValue *it)
         err = cbor_value_advance_fixed(it);
         if (err)
             return err;
-        err = value_to_pretty(out, it);
+        err = value_to_pretty(out, it, flags);
         if (err)
             return err;
         if (fprintf(out, ")") < 0)
@@ -465,7 +472,26 @@ static CborError value_to_pretty(FILE *out, CborValue *it)
  */
 CborError cbor_value_to_pretty_advance(FILE *out, CborValue *value)
 {
-    return value_to_pretty(out, value);
+    return value_to_pretty(out, value, CborPrettyDefaultFlags);
+}
+
+/**
+ * Converts the current CBOR type pointed by \a value to its textual
+ * representation and writes it to the \a out stream. If an error occurs, this
+ * function returns an error code similar to CborParsing.
+ *
+ * The textual representation can be controlled by the \a flags parameter (see
+ * CborPrettyFlags for more information).
+ *
+ * If no error ocurred, this function advances \a value to the next element.
+ * Often, concatenating the text representation of multiple elements can be
+ * done by appending a comma to the output stream.
+ *
+ * \sa cbor_value_to_pretty(), cbor_value_to_json_advance()
+ */
+CborError cbor_value_to_pretty_advance_flags(FILE *out, CborValue *value, int flags)
+{
+    return value_to_pretty(out, value, flags);
 }
 
 /** @} */