lib/xstring-desc.h

   1 /* String descriptors, with out-of-memory checking.
   2    Copyright (C) 2023-2024 Free Software Foundation, Inc.
   3
   4    This file is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published
   6    by the Free Software Foundation, either version 3 of the License,
   7    or (at your option) any later version.
   8
   9    This file is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  16
  17 /* Written by Bruno Haible <bruno@clisp.org>, 2023.  */
  18
  19 #ifndef _XSTRING_DESC_H
  20 #define _XSTRING_DESC_H 1
  21
  22 /* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE.  */
  23 #if !_GL_CONFIG_H_INCLUDED
  24  #error "Please include config.h first."
  25 #endif
  26
  27 #include <string.h>
  28 #include "string-desc.h"
  29 #include "xalloc.h"
  30
  31
  32 _GL_INLINE_HEADER_BEGIN
  33 #ifndef GL_XSTRING_DESC_INLINE
  34 # define GL_XSTRING_DESC_INLINE _GL_INLINE
  35 #endif
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41
  42 /* ==== Memory-allocating operations on string descriptors ==== */
  43
  44 /* Return a string of length N, with uninitialized contents.  */
  45 #if 0 /* Defined inline below.  */
  46 extern string_desc_t xstring_desc_new (idx_t n);
  47 #endif
  48
  49 /* Return a string of length N, filled with C.  */
  50 #if 0 /* Defined inline below.  */
  51 extern string_desc_t xstring_desc_new_filled (idx_t n, char c);
  52 #endif
  53
  54 /* Return a copy of string S.  */
  55 #if 0 /* Defined inline below.  */
  56 extern string_desc_t xstring_desc_copy (string_desc_t s);
  57 #endif
  58
  59 /* Return the concatenation of N strings.  N must be > 0.  */
  60 extern string_desc_t xstring_desc_concat (idx_t n, string_desc_t string1, ...);
  61
  62 /* Construct and return a copy of string S, as a NUL-terminated C string.  */
  63 #if 0 /* Defined inline below.  */
  64 extern char * xstring_desc_c (string_desc_t s) _GL_ATTRIBUTE_DEALLOC_FREE;
  65 #endif
  66
  67
  68 /* ==== Inline function definitions ==== */
  69
  70 GL_XSTRING_DESC_INLINE string_desc_t
  71 xstring_desc_new (idx_t n)
  72 {
  73   string_desc_t result;
  74   if (string_desc_new (&result, n) < 0)
  75     xalloc_die ();
  76   return result;
  77 }
  78
  79 GL_XSTRING_DESC_INLINE string_desc_t
  80 xstring_desc_new_filled (idx_t n, char c)
  81 {
  82   string_desc_t result;
  83   if (string_desc_new_filled (&result, n, c) < 0)
  84     xalloc_die ();
  85   return result;
  86 }
  87
  88 GL_XSTRING_DESC_INLINE string_desc_t
  89 xstring_desc_copy (string_desc_t s)
  90 {
  91   string_desc_t result;
  92   if (string_desc_copy (&result, s) < 0)
  93     xalloc_die ();
  94   return result;
  95 }
  96
  97 GL_XSTRING_DESC_INLINE
  98 _GL_ATTRIBUTE_DEALLOC_FREE
  99 char *
 100 xstring_desc_c (string_desc_t s)
 101 {
 102   char *result = string_desc_c (s);
 103   if (result == NULL)
 104     xalloc_die ();
 105   return result;
 106 }
 107
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112
 113 _GL_INLINE_HEADER_END
 114
 115
 116 #endif /* _XSTRING_DESC_H */