Tests/CMakeLib/testUTF8.cxx

/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst or https://cmake.org/licensing for details.  */
#include <cm/string_view>

#include <stdio.h>

#include <cm_utf8.h>

using test_utf8_char = cm::string_view const;

static void byte_array_print(test_utf8_char s)
{
  bool started = false;
  printf("[");
  for (char c : s) {
    if (started) {
      printf(",");
    }
    started = true;
    printf("0x%02X", static_cast<unsigned char>(c));
  }
  printf("]");
}

struct test_utf8_entry
{
  test_utf8_char str;
  unsigned int chr;
};

static test_utf8_entry const good_entry[] = {
  { "\x20", 0x0020 },               /* Space.  */
  { "\xC2\xA9", 0x00A9 },           /* Copyright.  */
  { "\xE2\x80\x98", 0x2018 },       /* Open-single-quote.  */
  { "\xE2\x80\x99", 0x2019 },       /* Close-single-quote.  */
  { "\xF0\xA3\x8E\xB4", 0x233B4 },  /* Example from RFC 3629.  */
  { "\xED\x80\x80", 0xD000 },       /* Valid 0xED prefixed codepoint.  */
  { "\xF4\x8F\xBF\xBF", 0x10FFFF }, /* Highest valid RFC codepoint. */
  { {}, 0 }
};

static test_utf8_char const bad_chars[] = {
  "\x80",             /* Leading continuation byte. */
  "\xC0\x80",         /* Overlong encoding. */
  "\xC1\x80",         /* Overlong encoding. */
  "\xC2",             /* Missing continuation byte. */
  "\xE0",             /* Missing continuation bytes. */
  "\xE0\x80\x80",     /* Overlong encoding. */
  "\xF0\x80\x80\x80", /* Overlong encoding. */
  "\xED\xA0\x80",     /* UTF-16 surrogate half. */
  "\xED\xBF\xBF",     /* UTF-16 surrogate half. */
  "\xF4\x90\x80\x80", /* Lowest out-of-range codepoint. */
  "\xF5\x80\x80\x80", /* Prefix forces out-of-range codepoints. */
  {}
};

static char const* good_strings[] = { "", "ASCII", "\xC2\xA9 Kitware", 0 };

static char const* bad_strings[] = {
  "\xC0\x80", /* Modified UTF-8 for embedded 0-byte. */
  0
};

static void report_good(bool passed, test_utf8_char c)
{
  printf("%s: decoding good ", passed ? "pass" : "FAIL");
  byte_array_print(c);
  printf(" (%s) ", c.data());
}

static void report_bad(bool passed, test_utf8_char c)
{
  printf("%s: decoding bad  ", passed ? "pass" : "FAIL");
  byte_array_print(c);
  printf(" ");
}

static bool decode_good(test_utf8_entry const& entry)
{
  auto const& s = entry.str;
  unsigned int uc;
  if (char const* e =
        cm_utf8_decode_character(s.data(), s.data() + s.size(), &uc)) {
    int used = static_cast<int>(e - s.data());
    if (uc != entry.chr) {
      report_good(false, s);
      printf("expected 0x%04X, got 0x%04X\n", entry.chr, uc);
      return false;
    }
    if (used != int(s.size())) {
      report_good(false, s);
      printf("had %d bytes, used %d\n", int(s.size()), used);
      return false;
    }
    report_good(true, s);
    printf("got 0x%04X\n", uc);
    return true;
  }
  report_good(false, s);
  printf("failed\n");
  return false;
}

static bool decode_bad(test_utf8_char s)
{
  unsigned int uc = 0xFFFFu;
  char const* e = cm_utf8_decode_character(s.data(), s.data() + s.size(), &uc);
  if (e) {
    report_bad(false, s);
    printf("expected failure, got 0x%04X\n", uc);
    return false;
  }
  report_bad(true, s);
  printf("failed as expected\n");
  return true;
}

static void report_valid(bool passed, test_utf8_char s)
{
  printf("%s: validity good ", passed ? "pass" : "FAIL");
  byte_array_print(s);
  printf(" (%s) ", s.data());
}

static void report_invalid(bool passed, test_utf8_char s)
{
  printf("%s: validity bad  ", passed ? "pass" : "FAIL");
  byte_array_print(s);
  printf(" ");
}

static bool is_valid(test_utf8_char s)
{
  bool valid = cm_utf8_is_valid(s.data()) != 0;
  if (!valid) {
    report_valid(false, s);
    printf("expected valid, reported as invalid\n");
    return false;
  }
  report_valid(true, s);
  printf("valid as expected\n");
  return true;
}

static bool is_invalid(test_utf8_char s)
{
  bool valid = cm_utf8_is_valid(s.data()) != 0;
  if (valid) {
    report_invalid(false, s);
    printf("expected invalid, reported as valid\n");
    return false;
  }
  report_invalid(true, s);
  printf("invalid as expected\n");
  return true;
}

int testUTF8(int /*unused*/, char* /*unused*/[])
{
  int result = 0;
  for (test_utf8_entry const* e = good_entry; !e->str.empty(); ++e) {
    if (!decode_good(*e)) {
      result = 1;
    }
    if (!is_valid(e->str)) {
      result = 1;
    }
  }
  for (test_utf8_char* c = bad_chars; !(*c).empty(); ++c) {
    if (!decode_bad(*c)) {
      result = 1;
    }
    if (!is_invalid(*c)) {
      result = 1;
    }
  }
  for (char const** s = good_strings; *s; ++s) {
    if (!is_valid(*s)) {
      result = 1;
    }
  }
  for (char const** s = bad_strings; *s; ++s) {
    if (!is_invalid(*s)) {
      result = 1;
    }
  }
  return result;
}