/* String descriptors, with out-of-memory checking.
Copyright (C) 2023 Free Software Foundation, Inc.
This file 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 3 of the License,
or (at your option) any later version.
This file 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 . */
/* Written by Bruno Haible , 2023. */
#ifndef _XSTRING_DESC_H
#define _XSTRING_DESC_H 1
#include
#include "string-desc.h"
#include "xalloc.h"
#ifndef _GL_INLINE_HEADER_BEGIN
#error "Please include config.h first."
#endif
_GL_INLINE_HEADER_BEGIN
#ifndef GL_XSTRING_DESC_INLINE
# define GL_XSTRING_DESC_INLINE _GL_INLINE
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* ==== Memory-allocating operations on string descriptors ==== */
/* Return a string of length N, with uninitialized contents. */
#if 0 /* Defined inline below. */
extern string_desc_t xstring_desc_new (idx_t n);
#endif
/* Return a string of length N, filled with C. */
#if 0 /* Defined inline below. */
extern string_desc_t xstring_desc_new_filled (idx_t n, char c);
#endif
/* Return a copy of string S. */
#if 0 /* Defined inline below. */
extern string_desc_t xstring_desc_copy (string_desc_t s);
#endif
/* Return the concatenation of N strings. N must be > 0. */
extern string_desc_t xstring_desc_concat (idx_t n, string_desc_t string1, ...);
/* Construct and return a copy of string S, as a NUL-terminated C string. */
#if 0 /* Defined inline below. */
extern char * xstring_desc_c (string_desc_t s) _GL_ATTRIBUTE_DEALLOC_FREE;
#endif
/* ==== Inline function definitions ==== */
GL_XSTRING_DESC_INLINE string_desc_t
xstring_desc_new (idx_t n)
{
string_desc_t result;
if (string_desc_new (&result, n) < 0)
xalloc_die ();
return result;
}
GL_XSTRING_DESC_INLINE string_desc_t
xstring_desc_new_filled (idx_t n, char c)
{
string_desc_t result;
if (string_desc_new_filled (&result, n, c) < 0)
xalloc_die ();
return result;
}
GL_XSTRING_DESC_INLINE string_desc_t
xstring_desc_copy (string_desc_t s)
{
string_desc_t result;
if (string_desc_copy (&result, s) < 0)
xalloc_die ();
return result;
}
GL_XSTRING_DESC_INLINE
_GL_ATTRIBUTE_DEALLOC_FREE
char *
xstring_desc_c (string_desc_t s)
{
char *result = string_desc_c (s);
if (result == NULL)
xalloc_die ();
return result;
}
#ifdef __cplusplus
}
#endif
_GL_INLINE_HEADER_END
#endif /* _XSTRING_DESC_H */