gdb/unittests/common-utils-selftests.c

   1 /* Self tests for general utility routines for GDB, the GNU debugger.
   2
   3    Copyright (C) 2016-2022 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "gdbsupport/common-defs.h"
  21 #include "gdbsupport/selftest.h"
  22
  23 namespace selftests {
  24
  25 /* Type of both 'string_printf' and the 'format' function below.  Used
  26    to run the same tests against both string_printf and
  27    string_vprintf.  */
  28 typedef std::string (format_func) (const char *fmt, ...)
  29   ATTRIBUTE_PRINTF (1, 2);
  30
  31 static void
  32 test_format_func (format_func *func)
  33 {
  34   /* Basic smoke tests.  */
  35   SELF_CHECK (func ("%s", "") == "");
  36   SELF_CHECK (func ("%s", "test") == "test");
  37   SELF_CHECK (func ("%d", 23) == "23");
  38   SELF_CHECK (func ("%s %d %s", "test", 23, "done") == "test 23 done");
  39   SELF_CHECK (func ("nothing") == "nothing");
  40   SELF_CHECK (func ("%d comes before 2", 1) == "1 comes before 2");
  41   SELF_CHECK (func ("hello %s", "world") == "hello world");
  42
  43   /* Check that we don't mishandle very large strings.  (An earlier
  44      non-public implementation of string_printf mishandled this).  */
  45 #define X10 "0123456789"
  46 #define X100 X10 X10 X10 X10 X10 X10 X10 X10 X10 X10
  47 #define X1000 X100 X100 X100 X100 X100 X100 X100 X100 X100 X100
  48 #define X10000 X1000 X1000 X1000 X1000 X1000 X1000 X1000 X1000 X1000 X1000
  49 #define X100000 X10000 X10000 X10000 X10000 X10000 X10000 X10000 X10000 X10000 X10000
  50   SELF_CHECK (func ("%s", X10) == X10);
  51   SELF_CHECK (func ("%s", X100) == X100);
  52   SELF_CHECK (func ("%s", X1000) == X1000);
  53   SELF_CHECK (func ("%s", X10000) == X10000);
  54   SELF_CHECK (func ("%s", X100000) == X100000);
  55 }
  56
  57 static void
  58 string_printf_tests ()
  59 {
  60   test_format_func (string_printf);
  61 }
  62
  63 static std::string ATTRIBUTE_PRINTF (1, 2)
  64 format (const char *fmt, ...)
  65 {
  66   va_list vp;
  67
  68   va_start (vp, fmt);
  69   std::string result = string_vprintf (fmt, vp);
  70   va_end (vp);
  71   return result;
  72 }
  73
  74 static void
  75 string_vprintf_tests ()
  76 {
  77   test_format_func (format);
  78 }
  79
  80 /* Type of both 'string_appendf' and the 'string_vappendf_wrapper'
  81    function below.  Used to run the same tests against both
  82    string_appendf and string_vappendf.  */
  83 typedef std::string &(string_appendf_func) (std::string &str, const char *fmt,
  84                                             ...)
  85   ATTRIBUTE_PRINTF (2, 3);
  86
  87 static void
  88 test_appendf_func (string_appendf_func *func)
  89 {
  90   std::string str;
  91
  92   func (str, "%s", "");
  93   SELF_CHECK (str == "");
  94
  95   func (str, "%s", "test");
  96   SELF_CHECK (str == "test");
  97
  98   func (str, "%d", 23);
  99   SELF_CHECK (str == "test23");
 100
 101   func (str, "%s %d %s", "foo", 45, "bar");
 102   SELF_CHECK (str == "test23foo 45 bar");
 103 }
 104
 105 static std::string & ATTRIBUTE_PRINTF (2, 3)
 106 string_vappendf_wrapper (std::string &str, const char *fmt, ...)
 107 {
 108   va_list vp;
 109
 110   va_start (vp, fmt);
 111   string_vappendf (str, fmt, vp);
 112   va_end (vp);
 113
 114   return str;
 115 }
 116
 117 static void
 118 string_appendf_tests ()
 119 {
 120   test_appendf_func (string_appendf);
 121 }
 122
 123 static void
 124 string_vappendf_tests ()
 125 {
 126   test_appendf_func (string_vappendf_wrapper);
 127 }
 128
 129 } /* namespace selftests */
 130
 131 void _initialize_common_utils_selftests ();
 132 void
 133 _initialize_common_utils_selftests ()
 134 {
 135   selftests::register_test ("string_printf", selftests::string_printf_tests);
 136   selftests::register_test ("string_vprintf", selftests::string_vprintf_tests);
 137   selftests::register_test ("string_appendf", selftests::string_appendf_tests);
 138   selftests::register_test ("string_vappendf",
 139                             selftests::string_vappendf_tests);
 140 }