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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
|
/*
* $Id: gwystringlist.c 21680 2018-11-26 10:39:39Z yeti-dn $
* Copyright (C) 2004,2014 David Necas (Yeti), Petr Klapetek.
* E-mail: yeti@gwyddion.net, klapetek@gwyddion.net.
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/* FIXME: we should use a better backend and also add more methods, for the
* original reason this was implemented they were not necessary */
#include "config.h"
#include <string.h>
#include <stdlib.h>
#include <libgwyddion/gwymacros.h>
#include <libgwyddion/gwymath.h>
#include <libgwyddion/gwydebugobjects.h>
#include <libgwyddion/gwyserializable.h>
#include <libgwyddion/gwystringlist.h>
#define GWY_STRING_LIST_TYPE_NAME "GwyStringList"
enum {
VALUE_CHANGED,
LAST_SIGNAL
};
static void gwy_string_list_finalize (GObject *object);
static void gwy_string_list_serializable_init(GwySerializableIface *iface);
static GByteArray* gwy_string_list_serialize (GObject *obj,
GByteArray *buffer);
static gsize gwy_string_list_get_size (GObject *obj);
static GObject* gwy_string_list_deserialize (const guchar *buffer,
gsize size,
gsize *position);
static GObject* gwy_string_list_duplicate_real (GObject *object);
static void gwy_string_list_clone_real (GObject *source,
GObject *copy);
static void clear_strings (GPtrArray *strings);
static guint string_list_signals[LAST_SIGNAL] = { 0 };
G_DEFINE_TYPE_EXTENDED
(GwyStringList, gwy_string_list, G_TYPE_OBJECT, 0,
GWY_IMPLEMENT_SERIALIZABLE(gwy_string_list_serializable_init))
static void
gwy_string_list_serializable_init(GwySerializableIface *iface)
{
iface->serialize = gwy_string_list_serialize;
iface->deserialize = gwy_string_list_deserialize;
iface->get_size = gwy_string_list_get_size;
iface->duplicate = gwy_string_list_duplicate_real;
iface->clone = gwy_string_list_clone_real;
}
static void
gwy_string_list_class_init(GwyStringListClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
gobject_class->finalize = gwy_string_list_finalize;
/**
* GwyStringList::value-changed:
* @gwystrlist: The #GwyStringList which received the signal.
*
* The ::value-changed signal is emitted whenever a string list changes.
*/
string_list_signals[VALUE_CHANGED]
= g_signal_new("value-changed",
G_OBJECT_CLASS_TYPE(gobject_class),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET(GwyStringListClass, value_changed),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
}
static void
gwy_string_list_init(GwyStringList *strlist)
{
strlist->strings = (gpointer)g_ptr_array_new();
}
static void
gwy_string_list_finalize(GObject *object)
{
GwyStringList *strlist = (GwyStringList*)object;
GPtrArray *strings;
strings = (GPtrArray*)strlist->strings;
if (strings) {
clear_strings(strings);
g_ptr_array_free(strings, TRUE);
strlist->strings = NULL;
}
G_OBJECT_CLASS(gwy_string_list_parent_class)->finalize(object);
}
static GByteArray*
gwy_string_list_serialize(GObject *obj,
GByteArray *buffer)
{
GwyStringList *strlist;
GByteArray *retval;
GPtrArray *strings;
g_return_val_if_fail(GWY_IS_STRING_LIST(obj), NULL);
strlist = GWY_STRING_LIST(obj);
strings = (GPtrArray*)strlist->strings;
{
guint32 len = strings->len;
GwySerializeSpec spec[] = {
{ 'S', "strings", &strings->pdata, &len, },
};
guint n = len ? G_N_ELEMENTS(spec) : 0;
retval = gwy_serialize_pack_object_struct(buffer,
GWY_STRING_LIST_TYPE_NAME,
n, spec);
return retval;
}
}
static gsize
gwy_string_list_get_size(GObject *obj)
{
GwyStringList *strlist;
GPtrArray *strings;
gsize size;
g_return_val_if_fail(GWY_IS_STRING_LIST(obj), 0);
strlist = GWY_STRING_LIST(obj);
strings = (GPtrArray*)strlist->strings;
{
guint32 len = strings->len;
GwySerializeSpec spec[] = {
{ 'S', "strings", &strings->pdata, &len, },
};
guint n = len ? G_N_ELEMENTS(spec) : 0;
size = gwy_serialize_get_struct_size(GWY_STRING_LIST_TYPE_NAME,
n, spec);
}
return size;
}
static GObject*
gwy_string_list_deserialize(const guchar *buffer,
gsize size,
gsize *position)
{
gchar **pstr = NULL;
guint32 len = 0;
GwySerializeSpec spec[] = {
{ 'S', "strings", &pstr, &len, },
};
GwyStringList *strlist;
GPtrArray *strings;
guint i;
g_return_val_if_fail(buffer, NULL);
if (!gwy_serialize_unpack_object_struct(buffer, size, position,
GWY_STRING_LIST_TYPE_NAME,
G_N_ELEMENTS(spec), spec)) {
return NULL;
}
strlist = gwy_string_list_new();
strings = (GPtrArray*)strlist->strings;
g_ptr_array_set_size(strings, len);
for (i = 0; i < len; i++)
g_ptr_array_index(strings, i) = pstr[i];
g_free(pstr);
return (GObject*)strlist;
}
static GObject*
gwy_string_list_duplicate_real(GObject *object)
{
GwyStringList *strlist, *duplicate;
GPtrArray *strings, *dupstrings;
guint i;
g_return_val_if_fail(GWY_IS_STRING_LIST(object), NULL);
strlist = GWY_STRING_LIST(object);
duplicate = gwy_string_list_new();
strings = (GPtrArray*)strlist->strings;
dupstrings = (GPtrArray*)duplicate->strings;
g_ptr_array_set_size(dupstrings, strings->len);
for (i = 0; i < strings->len; i++)
g_ptr_array_index(dupstrings, i)
= g_strdup(g_ptr_array_index(strings, i));
return (GObject*)duplicate;
}
static void
gwy_string_list_clone_real(GObject *source, GObject *copy)
{
GwyStringList *strlist, *clone;
GPtrArray *strings, *copystrings;
guint i;
g_return_if_fail(GWY_IS_STRING_LIST(source));
g_return_if_fail(GWY_IS_STRING_LIST(copy));
strlist = GWY_STRING_LIST(source);
clone = GWY_STRING_LIST(copy);
strings = (GPtrArray*)strlist->strings;
copystrings = (GPtrArray*)clone->strings;
for (i = 0; i < copystrings->len; i++)
g_free(g_ptr_array_index(copystrings, i));
g_ptr_array_set_size(copystrings, strings->len);
for (i = 0; i < strings->len; i++)
g_ptr_array_index(copystrings, i)
= g_strdup(g_ptr_array_index(strings, i));
g_signal_emit(copy, string_list_signals[VALUE_CHANGED], 0);
}
/**
* gwy_string_list_new:
*
* Creates a new string list.
*
* Returns: A new empty string list.
**/
GwyStringList*
gwy_string_list_new(void)
{
return g_object_new(GWY_TYPE_STRING_LIST, NULL);
}
/**
* gwy_string_list_append:
* @strlist: A string list.
* @string: A string to add.
*
* Appends a string to the end of a string list.
**/
void
gwy_string_list_append(GwyStringList *strlist,
const gchar *string)
{
GPtrArray *strings;
g_return_if_fail(GWY_IS_STRING_LIST(strlist));
g_return_if_fail(string);
strings = (GPtrArray*)strlist->strings;
g_ptr_array_add(strings, g_strdup(string));
g_signal_emit(strlist, string_list_signals[VALUE_CHANGED], 0);
}
/**
* gwy_string_list_append_take:
* @strlist: A string list.
* @string: A string to add.
*
* Appends a string to the end of a string list, taking ownership of the string.
*
* Since: 2.35
**/
void
gwy_string_list_append_take(GwyStringList *strlist,
gchar *string)
{
GPtrArray *strings;
g_return_if_fail(GWY_IS_STRING_LIST(strlist));
g_return_if_fail(string);
strings = (GPtrArray*)strlist->strings;
g_ptr_array_add(strings, string);
g_signal_emit(strlist, string_list_signals[VALUE_CHANGED], 0);
}
/**
* gwy_string_list_get_length:
* @strlist: A string list.
*
* Gets the number of strings in a string list.
*
* Returns: The number of strings in @strlist.
**/
guint
gwy_string_list_get_length(GwyStringList *strlist)
{
GPtrArray *strings;
g_return_val_if_fail(GWY_IS_STRING_LIST(strlist), 0);
strings = (GPtrArray*)strlist->strings;
return strings->len;
}
/**
* gwy_string_list_get:
* @strlist: A string list.
* @i: The position of string to get.
*
* Gets a string from a string list by position.
*
* Returns: The string, owned by @strlist. It is valid only until @strlist
* changes.
**/
const gchar*
gwy_string_list_get(GwyStringList *strlist,
guint i)
{
GPtrArray *strings;
g_return_val_if_fail(GWY_IS_STRING_LIST(strlist), NULL);
strings = (GPtrArray*)strlist->strings;
g_return_val_if_fail(i < strings->len, NULL);
return g_ptr_array_index(strings, i);
}
/**
* gwy_string_list_clear:
* @strlist: A string list.
*
* Clears the contents of a string list, removing all strings.
*
* Since: 2.35
**/
void
gwy_string_list_clear(GwyStringList *strlist)
{
GPtrArray *strings;
g_return_if_fail(GWY_IS_STRING_LIST(strlist));
strings = (GPtrArray*)strlist->strings;
if (!strings->len)
return;
clear_strings(strings);
g_signal_emit(strlist, string_list_signals[VALUE_CHANGED], 0);
}
static void
clear_strings(GPtrArray *strings)
{
guint i = 0;
for (i = 0; i < strings->len; i++)
g_free(g_ptr_array_index(strings, i));
g_ptr_array_set_size(strings, 0);
}
/************************** Documentation ****************************/
/**
* SECTION:gwystringlist
* @title: GwyStringList
* @short_description: A string list object wrapper
*
* #GwyStringList object represents a reference-counted, serializable list of
* strings. The current interface is very minimal, more methods may be added
* later as needed.
**/
/**
* GwyStringList:
*
* The #GwyStringList struct contains private data only and should be accessed
* using the functions below.
**/
/**
* gwy_string_list_duplicate:
* @strlist: A string list to duplicate.
*
* Convenience macro doing gwy_serializable_duplicate() with all the necessary
* typecasting.
**/
/* vim: set cin et ts=4 sw=4 cino=>1s,e0,n0,f0,{0,}0,^0,\:1s,=0,g1s,h0,t0,+1s,c3,(0,u0 : */
|