sbuff: I suppose we should use standard names

diff --git a/src/lib/util/sbuff.c b/src/lib/util/sbuff.c
index fdcdb5ee2c752aa1407cdfb9216e8f0babed4221..64d75964e82303f924f7fb8f6954e3976f16850f 100644 (file)
--- a/src/lib/util/sbuff.c
+++ b/src/lib/util/sbuff.c
@@ -522,7 +522,7 @@ done:
  *     - 0 no bytes copied.
  *     - >0 the number of bytes copied including escape sequences.
  */
-size_t fr_sbuff_out_descape_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
+size_t fr_sbuff_out_unescape_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
                                  bool const until[static UINT8_MAX + 1],
                                  char escape,
                                  char const escape_subs[static UINT8_MAX + 1])
@@ -573,7 +573,7 @@ size_t fr_sbuff_out_descape_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
                                 *      Copy out any data we got before
                                 *      we hit the escape char.
                                 *
-                                *      We need to do this before we
+                                *      We need to do this before we
                                 *      can write the escape char to
                                 *      the output sbuff.
                                 */

diff --git a/src/lib/util/sbuff.h b/src/lib/util/sbuff.h
index 3f78dc6f4cd1f15b6518430355cb510d2d02afd2..084a6ba5921b6bd15ade43c774c964d26325e5f4 100644 (file)
--- a/src/lib/util/sbuff.h
+++ b/src/lib/util/sbuff.h
@@ -674,7 +674,7 @@ size_t      fr_sbuff_out_bstrncpy_allowed(fr_sbuff_t *out, fr_sbuff_t *in, size_t len
 size_t fr_sbuff_out_bstrncpy_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
                                    bool const until[static UINT8_MAX + 1], char escape);
 
-size_t fr_sbuff_out_descape_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
+size_t fr_sbuff_out_unescape_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
                                  bool const until[static UINT8_MAX + 1],
                                  char escape,
                                  char const escape_subs[static UINT8_MAX + 1]);

diff --git a/src/lib/util/sbuff_tests.c b/src/lib/util/sbuff_tests.c
index 046254d7d9ab05420c5c1af8fce3d8a49baed41f..f3f38100f501d631c3b42ca6a6a4b59b6295ef28 100644 (file)
--- a/src/lib/util/sbuff_tests.c
+++ b/src/lib/util/sbuff_tests.c
@@ -385,7 +385,7 @@ static void test_bstrncpy_until(void)
        TEST_CHECK_STRCMP("", out);
 }
 
-static void test_descape_until(void)
+static void test_unescape_until(void)
 {
        char const      in[] = "i am a test string";
        char const      in_long[] = "i am a longer test string";
@@ -403,14 +403,14 @@ static void test_descape_until(void)
         *      set.
         */
        TEST_CASE("Copy 5 bytes to out");
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 5,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 5,
                                           (bool[UINT8_MAX + 1]){ }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(5, slen);
        TEST_CHECK_STRCMP("i am ", out);
        TEST_CHECK_STRCMP("a test string", sbuff.p);
 
        TEST_CASE("Copy 13 bytes to out");
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 13,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 13,
                                           (bool[UINT8_MAX + 1]){ }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(13, slen);
        TEST_CHECK_STRCMP("a test string", out);
@@ -418,7 +418,7 @@ static void test_descape_until(void)
        TEST_CHECK(sbuff.p == sbuff.end);
 
        TEST_CASE("Copy would overrun input");
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 1,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 1,
                                           (bool[UINT8_MAX + 1]){ }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(0, slen);
        TEST_CHECK(sbuff.p == sbuff.end);
@@ -426,7 +426,7 @@ static void test_descape_until(void)
        TEST_CASE("Copy would overrun output (and SIZE_MAX special value)");
        fr_sbuff_init(&sbuff, in_long, sizeof(in_long));
 
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff,
                                           SIZE_MAX, (bool[UINT8_MAX + 1]){ }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(18, slen);
        TEST_CHECK_STRCMP("i am a longer test", out);
@@ -434,7 +434,7 @@ static void test_descape_until(void)
        TEST_CASE("Zero length output buffer");
        fr_sbuff_set_to_start(&sbuff);
        out[0] = 'a';
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, (size_t)1), &sbuff,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, (size_t)1), &sbuff,
                                           SIZE_MAX, (bool[UINT8_MAX + 1]){ }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(0, slen);
        TEST_CHECK(out[0] == '\0');     /* should be set to \0 */
@@ -443,7 +443,7 @@ static void test_descape_until(void)
        TEST_CASE("Zero length size");
        fr_sbuff_set_to_start(&sbuff);
        out[0] = 'a';
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 0,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, 0,
                                           (bool[UINT8_MAX + 1]){ }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(0, slen);
        TEST_CHECK(out[0] == '\0');     /* should be set to \0 */
@@ -454,28 +454,28 @@ static void test_descape_until(void)
         */
        TEST_CASE("Copy until first t");
        fr_sbuff_set_to_start(&sbuff);
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, SIZE_MAX,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, sizeof(out)), &sbuff, SIZE_MAX,
                                           (bool[UINT8_MAX + 1]){ ['t'] = true }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(14, slen);
        TEST_CHECK_STRCMP("i am a longer ", out);
 
        TEST_CASE("Copy until first t with length constraint (same len as token)");
        fr_sbuff_set_to_start(&sbuff);
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, 15), &sbuff, SIZE_MAX,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, 15), &sbuff, SIZE_MAX,
                                           (bool[UINT8_MAX + 1]){ ['t'] = true }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(14, slen);
        TEST_CHECK_STRCMP("i am a longer ", out);
 
        TEST_CASE("Copy until first t with length constraint (one shorter than token)");
        fr_sbuff_set_to_start(&sbuff);
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, 14), &sbuff, SIZE_MAX,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, 14), &sbuff, SIZE_MAX,
                                           (bool[UINT8_MAX + 1]){ ['t'] = true }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(13, slen);
        TEST_CHECK_STRCMP("i am a longer", out);
 
        TEST_CASE("Zero length token (should still be terminated)");
        fr_sbuff_set_to_start(&sbuff);
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(out, 14), &sbuff, SIZE_MAX,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(out, 14), &sbuff, SIZE_MAX,
                                           (bool[UINT8_MAX + 1]){ ['i'] = true }, '\\', (char[UINT8_MAX + 1]){});
        TEST_CHECK_SLEN(0, slen);
        TEST_CHECK_STRCMP("", out);
@@ -485,7 +485,7 @@ static void test_descape_until(void)
         */
        TEST_CASE("Escape with substition to same char");
        fr_sbuff_init(&sbuff, in_escapes, sizeof(in_escapes));
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(escape_out, sizeof(escape_out)), &sbuff, SIZE_MAX,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(escape_out, sizeof(escape_out)), &sbuff, SIZE_MAX,
                                           (bool[UINT8_MAX + 1]){ ['g'] = true },
                                           '|',
                                           (char[UINT8_MAX + 1]){ ['g'] = 'g' });
@@ -495,7 +495,7 @@ static void test_descape_until(void)
 
        TEST_CASE("Escape with substition to different char");
        fr_sbuff_init(&sbuff, in_escapes, sizeof(in_escapes));
-       slen = fr_sbuff_out_descape_until(&FR_SBUFF_TMP(escape_out, sizeof(escape_out)), &sbuff, SIZE_MAX,
+       slen = fr_sbuff_out_unescape_until(&FR_SBUFF_TMP(escape_out, sizeof(escape_out)), &sbuff, SIZE_MAX,
                                           (bool[UINT8_MAX + 1]){ ['g'] = true },
                                           '|',
                                           (char[UINT8_MAX + 1]){ ['g'] = 'h' });