blob: 909360c950911f60f6e0878e87c9edd1fba9283b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/*
* Copyright © 2020 Canonical Ltd.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include "gstrvbuilder.h"
#include "garray.h"
#include "gmem.h"
/**
* SECTION:gstrvbuilder
* @title: GStrvBuilder
* @short_description: Helper to create NULL-terminated string arrays.
*
* #GStrvBuilder is a method of easily building dynamically sized
* NULL-terminated string arrays.
*
* The following example shows how to build a two element array:
*
* |[<!-- language="C" -->
* g_autoptr(GStrvBuilder) builder = g_strv_builder_new ();
* g_strv_builder_add (builder, "hello");
* g_strv_builder_add (builder, "world");
* g_auto(GStrv) array = g_strv_builder_end (builder);
* ]|
*
* Since: 2.68
*/
struct _GStrvBuilder
{
GPtrArray array;
};
/**
* g_strv_builder_new:
*
* Creates a new #GStrvBuilder with a reference count of 1.
* Use g_strv_builder_unref() on the returned value when no longer needed.
*
* Returns: (transfer full): the new #GStrvBuilder
*
* Since: 2.68
*/
GStrvBuilder *
g_strv_builder_new (void)
{
return (GStrvBuilder *) g_ptr_array_new_with_free_func (g_free);
}
/**
* g_strv_builder_unref:
* @builder: (transfer full): a #GStrvBuilder allocated by g_strv_builder_new()
*
* Decreases the reference count on @builder.
*
* In the event that there are no more references, releases all memory
* associated with the #GStrvBuilder.
*
* Since: 2.68
**/
void
g_strv_builder_unref (GStrvBuilder *builder)
{
g_ptr_array_unref (&builder->array);
}
/**
* g_strv_builder_ref:
* @builder: (transfer none): a #GStrvBuilder
*
* Atomically increments the reference count of @builder by one.
* This function is thread-safe and may be called from any thread.
*
* Returns: (transfer full): The passed in #GStrvBuilder
*
* Since: 2.68
*/
GStrvBuilder *
g_strv_builder_ref (GStrvBuilder *builder)
{
return (GStrvBuilder *) g_ptr_array_ref (&builder->array);
}
/**
* g_strv_builder_add:
* @builder: a #GStrvBuilder
* @value: a string.
*
* Add a string to the end of the array.
*
* Since 2.68
*/
void
g_strv_builder_add (GStrvBuilder *builder,
const char *value)
{
g_ptr_array_add (&builder->array, g_strdup (value));
}
/**
* g_strv_builder_end:
* @builder: a #GStrvBuilder
*
* Ends the builder process and returns the constructed NULL-terminated string
* array. The returned value should be freed with g_strfreev() when no longer
* needed.
*
* Returns: (transfer full): the constructed string array.
*
* Since 2.68
*/
GStrv
g_strv_builder_end (GStrvBuilder *builder)
{
/* Add NULL terminator */
g_ptr_array_add (&builder->array, NULL);
return (GStrv) g_ptr_array_steal (&builder->array, NULL);
}
|
