gnulib/tests/test-string-buffer.c

/* Test of buffer that accumulates a string by piecewise concatenation.
   Copyright (C) 2021-2026 Free Software Foundation, Inc.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, see <https://www.gnu.org/licenses/>.  */

/* Written by Bruno Haible <bruno@clisp.org>, 2021.  */

#include <config.h>

#include "string-buffer.h"

#include <errno.h>
#include <string.h>
#include <wchar.h>

#include "macros.h"

static int
my_appendf (struct string_buffer *buffer, const char *formatstring, ...)
{
  va_list args;

  va_start (args, formatstring);
  int ret = sb_appendvf (buffer, formatstring, args);
  va_end (args);

  return ret;
}

char invalid_format_string_1[] = "%&";
char invalid_format_string_2[] = "%^";

int
main ()
{
  /* Test accumulation.  */
  {
    struct string_buffer buffer;

    sb_init (&buffer);
    rw_string_desc_t contents = sb_dupfree (&buffer);
    ASSERT (sd_is_empty (contents));
    /* Here it is important to distinguish (0, NULL), which stands for an error,
       from (0, non-NULL), which is a successful result.  */
    ASSERT (sd_data (contents) != NULL);
    sd_free (contents);
  }
  {
    struct string_buffer buffer;

    sb_init (&buffer);
    sb_append1 (&buffer, 'x');
    sb_append1 (&buffer, '\377');
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && streq (s, "x\377"));
    free (s);
  }
  {
    struct string_buffer buffer;

    sb_init (&buffer);
    sb_append1 (&buffer, 'x');
    sb_append1 (&buffer, '\377');
    {
      string_desc_t sd = sb_contents (&buffer);
      ASSERT (sd_length (sd) == 2);
      ASSERT (sd_char_at (sd, 0) == 'x');
      ASSERT (sd_char_at (sd, 1) == '\377');
    }
    sb_append1 (&buffer, '\0');
    sb_append1 (&buffer, 'z');
    {
      string_desc_t sd = sb_contents (&buffer);
      ASSERT (sd_length (sd) == 4);
      ASSERT (sd_char_at (sd, 0) == 'x');
      ASSERT (sd_char_at (sd, 1) == '\377');
      ASSERT (sd_char_at (sd, 2) == '\0');
      ASSERT (sd_char_at (sd, 3) == 'z');
    }
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && memeq (s, "x\377\0z\0", 5));
    free (s);
  }

  /* Test simple string concatenation.  */
  {
    struct string_buffer buffer;

    sb_init (&buffer);
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && streq (s, ""));
    free (s);
  }

  {
    struct string_buffer buffer;

    sb_init (&buffer);
    sb_append_c (&buffer, "abc");
    sb_append_c (&buffer, "");
    sb_append_c (&buffer, "defg");
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && streq (s, "abcdefg"));
    free (s);
  }

  {
    struct string_buffer buffer;

    sb_init (&buffer);
    sb_append_c (&buffer, "abc");
    sb_append_desc (&buffer, sd_new_addr (5, "de\0fg"));
    sb_append_c (&buffer, "hij");
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && memeq (s, "abcde\0fghij", 12));
    free (s);
  }

  /* Test printf-like formatting.  */
  {
    struct string_buffer buffer;

    sb_init (&buffer);
    sb_append_c (&buffer, "<");
    sb_appendf (&buffer, "%x", 3735928559U);
    sb_append_c (&buffer, ">");
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && streq (s, "<deadbeef>"));
    free (s);
  }

  /* Test vprintf-like formatting.  */
  {
    struct string_buffer buffer;

    sb_init (&buffer);
    sb_append_c (&buffer, "<");
    my_appendf (&buffer, "%x", 3735928559U);
    sb_append_c (&buffer, ">");
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s != NULL && streq (s, "<deadbeef>"));
    free (s);
  }

  /* Test printf-like formatting failure.
     On all systems except AIX, trying to convert the wide-character 0x76543210
     to a multibyte string (in the "C" locale) fails.
     On all systems, invalid format directives make the vsnzprintf() call
     fail.  */
  {
    struct string_buffer buffer;
    int ret;

    sb_init (&buffer);
    sb_append_c (&buffer, "<");

    ret = sb_appendf (&buffer, "%lc", (wint_t) 0x76543210);
    #if !(defined _AIX || (defined _WIN32 && !defined __CYGWIN__))
    ASSERT (ret < 0);
    ASSERT (errno == EILSEQ);
    #endif

    sb_append_c (&buffer, "|");

    ret = sb_appendf (&buffer, invalid_format_string_1, 1);
    ASSERT (ret < 0);
    ASSERT (errno == EINVAL);

    sb_append_c (&buffer, "|");

    ret = sb_appendf (&buffer, invalid_format_string_2, 2);
    ASSERT (ret < 0);
    ASSERT (errno == EINVAL);

    sb_append_c (&buffer, ">");
    char *s = sb_dupfree_c (&buffer);
    ASSERT (s == NULL);
  }

  return test_exit_status;
}