/usr/include/cutter/gcutter/gcut-data.h is in cutter-glib-support 1.1.7-1.2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 | /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* Copyright (C) 2009-2010 Kouhei Sutou <kou@clear-code.com>
*
* 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 3 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 program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef __GCUT_DATA_H__
#define __GCUT_DATA_H__
#include <gcutter/gcut-data-helper.h>
G_BEGIN_DECLS
/**
* SECTION: gcut-data
* @title: Convenience test data API
* @short_description: API to create test data without
* structure definition.
*
* cut_add_data() requires custom data type for complex test
* data. But it's not easy to write. gcut_add_datum()
* provides API to use complex test data without custom data
* type. It uses #GType for providing complex data.
*/
/**
* gcut_add_datum:
* @name: the name of the data.
* @first_field_name: the first field name.
* @...: the type and value pair of the first field,
* followed optionally by the next field name, type
* and value triples. %NULL-terminated. See
* description for more details.
*
* Adds a datum to be used in data driven test. It's
* convenient rather than cut_add_data() because you doesn't
* need to define a new structure for a complex test data.
*
* e.g.:
* |[
* #include <gcutter.h>
*
* void data_translate (void);
* void test_translate (gconstpointer data);
*
* static const gchar*
* translate (gint input)
* {
* switch(input) {
* case 1:
* return "first";
* case 111:
* return "a hundred eleven";
* default:
* return "unsupported";
* }
* }
*
* void
* data_translate(void)
* {
* gcut_add_datum("simple data",
* "translated", G_TYPE_STRING, "first",
* "input", G_TYPE_INT, 1,
* NULL);
* gcut_add_datum("complex data",
* "translated", G_TYPE_STRING, "a hundred eleven",
* "input", G_TYPE_INT, 111,
* NULL);
* }
*
* void
* test_translate(gconstpointer data)
* {
* cut_assert_equal_string(gcut_data_get_string(data, "translated"),
* gcut_data_get_int(data, "input"));
* }
* ]|
*
* Available types and their values are the followings:
*
* <variablelist>
* <varlistentry>
* <term>#G_TYPE_CHAR</term>
* <listitem>
* <para>#gchar value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_CHAR, 'X',
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_STRING</term>
* <listitem>
* <para>const #gchar *value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_STRING, "string value",
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_INT</term>
* <listitem>
* <para>#gint value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_INT, 100,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_UINT</term>
* <listitem>
* <para>#guint value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_UINT, 100,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_INT64</term>
* <listitem>
* <para>#gint64 value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_INT64, G_GINT64_CONSTANT(100),
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_UINT64</term>
* <listitem>
* <para>#guint64 value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_UINT64, G_GUINT64_CONSTANT(100),
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_GTYPE</term>
* <listitem>
* <para>#GType value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_GTYPE, G_TYPE_OBJECT,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>GFlags types</term>
* <listitem>
* <para>its type value.</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", GTK_TYPE_WIDGET_FLAGS, GTK_TOPLEVEL | GTK_MAPPED,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>GEnum types</term>
* <listitem>
* <para>its type value.</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", GTK_TYPE_WRAP_MODE, GTK_WRAP_NONE,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_POINTER</term>
* <listitem>
* <para>#gconstpointer value, #GDestroyNotify notify</para>
* <para>notify is called when value is destroyed.</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_POINTER, my_structure_new(...), my_structure_free,
* NULL);
* ]|
* </para>
* <para>NOTE: value's ownership is passed to Cutter. Don't free it.</para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>GBoxed types</term>
* <listitem>
* <para>its type value.</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_HASH_TABLE,
* gcut_hash_table_string_string_new("name1", "value1",
* "name2", "value2",
* NULL),
* NULL);
* ]|
* </para>
* <para>NOTE: value's ownership is passed to Cutter. Don't free it.</para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_BOOLEAN</term>
* <listitem>
* <para>#gboolean value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_BOOLEAN, TRUE,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* <varlistentry>
* <term>#G_TYPE_DOUBLE</term>
* <listitem>
* <para>#gdouble value</para>
* <para>e.g.:
* |[
* gcut_add_datum("data name",
* "field-name", G_TYPE_DOUBLE, 2.9,
* NULL);
* ]|
* </para>
* </listitem>
* </varlistentry>
* </variablelist>
*
* Since: 1.0.6
*/
#define gcut_add_datum(name, first_field_name, ...) \
cut_test_context_add_data( \
cut_get_current_test_context(), \
name, \
gcut_dynamic_data_new(first_field_name, __VA_ARGS__), \
g_object_unref, \
NULL)
/**
* gcut_data_has_field:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Returns: %TRUE if @data has a @field_name field is
* available, %FALSE otherwise.
*
* Since: 1.1.5
*/
#define gcut_data_has_field(data, field_name) \
gcut_dynamic_data_has_field(data, field_name)
/**
* gcut_data_get_char:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as char.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.3
*/
#define gcut_data_get_char(data, field_name) \
gcut_data_get_char_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_char(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_string:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as string.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_string(data, field_name) \
gcut_data_get_string_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_string(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_int:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as integer.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_int(data, field_name) \
gcut_data_get_int_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_int(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_uint:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* unsigned integer.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_uint(data, field_name) \
gcut_data_get_uint_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_uint(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_int64:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as 64-bit
* integer.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.3
*/
#define gcut_data_get_int64(data, field_name) \
gcut_data_get_int64_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_int64(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_uint64:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* 64-bit unsigned integer.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.3
*/
#define gcut_data_get_uint64(data, field_name) \
gcut_data_get_uint64_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_uint64(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_size:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as size_t.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.3
*/
#define gcut_data_get_size(data, field_name) \
gcut_data_get_size_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_size(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_type:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as #GType.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_type(data, field_name) \
gcut_data_get_type_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_type(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_flags:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* unsigned integer of GFlags.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_flags(data, field_name) \
gcut_data_get_flags_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_flags(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_enum:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* integer of GEnum type.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_enum(data, field_name) \
gcut_data_get_enum_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_enum(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_pointer:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* pointer.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.6
*/
#define gcut_data_get_pointer(data, field_name) \
gcut_data_get_pointer_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_pointer(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_boxed:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* GBoxed type value.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.0.7
*/
#define gcut_data_get_boxed(data, field_name) \
gcut_data_get_boxed_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_boxed(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_object:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as
* #GObject type value.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.1
*/
#define gcut_data_get_object(data, field_name) \
gcut_data_get_object_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_object(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_boolean:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as boolean.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.3
*/
#define gcut_data_get_boolean(data, field_name) \
gcut_data_get_boolean_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_boolean(data, field_name)), \
cut_pop_backtrace))
/**
* gcut_data_get_double:
* @data: the data added by gcut_add_datum().
* @field_name: the field name.
*
* Gets a field value identified by @field_name as double
* floating point number.
*
* Returns: a field value corresponded to @field_name.
*
* Since: 1.1.3
*/
#define gcut_data_get_double(data, field_name) \
gcut_data_get_double_helper( \
data, field_name, \
(cut_push_backtrace(gcut_data_get_double(data, field_name)), \
cut_pop_backtrace))
G_END_DECLS
#endif /* __GCUT_DATA_H__ */
/*
vi:nowrap:ai:expandtab:sw=4:ts=4
*/
|