glib/gstrvbuilder.h

   1 /*
   2  * Copyright © 2020 Canonical Ltd.
   3  * Copyright © 2021 Alexandros Theodotou
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library 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 GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef __G_STRVBUILDER_H__
  22 #define __G_STRVBUILDER_H__
  23
  24 #if !defined(__GLIB_H_INSIDE__) && !defined(GLIB_COMPILATION)
  25 #error "Only <glib.h> can be included directly."
  26 #endif
  27
  28 #include <glib/gstrfuncs.h>
  29 #include <glib/gtypes.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  * GStrvBuilder:
  35  *
  36  * A helper object to build a %NULL-terminated string array
  37  * by appending. See g_strv_builder_new().
  38  *
  39  * Since: 2.68
  40  */
  41 typedef struct _GStrvBuilder GStrvBuilder;
  42
  43 GLIB_AVAILABLE_IN_2_68
  44 GStrvBuilder *g_strv_builder_new (void);
  45
  46 GLIB_AVAILABLE_IN_2_68
  47 void g_strv_builder_unref (GStrvBuilder *builder);
  48
  49 GLIB_AVAILABLE_IN_2_68
  50 GStrvBuilder *g_strv_builder_ref (GStrvBuilder *builder);
  51
  52 GLIB_AVAILABLE_IN_2_68
  53 void g_strv_builder_add (GStrvBuilder *builder,
  54                          const char *value);
  55
  56 GLIB_AVAILABLE_IN_2_70
  57 void g_strv_builder_addv (GStrvBuilder *builder,
  58                           const char **value);
  59
  60 GLIB_AVAILABLE_IN_2_70
  61 void g_strv_builder_add_many (GStrvBuilder *builder,
  62                               ...) G_GNUC_NULL_TERMINATED;
  63
  64 GLIB_AVAILABLE_IN_2_68
  65 GStrv g_strv_builder_end (GStrvBuilder *builder);
  66
  67 G_END_DECLS
  68
  69 #endif /* __G_STRVBUILDER_H__ */