File: pps-link-action.c

package info (click to toggle)
papers 49.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 21,044 kB
  • sloc: ansic: 37,728; sh: 197; xml: 127; makefile: 113
file content (562 lines) | stat: -rw-r--r-- 19,302 bytes parent folder | download | duplicates (2)
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
// SPDX-License-Identifier: GPL-2.0-or-later
/* this file is part of papers, a gnome document viewer
 *
 *  Copyright (C) 2006 Carlos Garcia Campos <carlosgc@gnome.org>
 *  Copyright (C) 2005 Red Hat, Inc.
 */

#include "pps-link-action.h"
#include "pps-document-type-builtins.h"
#include <config.h>

enum {
	PROP_0,
	PROP_TYPE,
	PROP_DEST,
	PROP_URI,
	PROP_FILENAME,
	PROP_PARAMS,
	PROP_NAME,
	PROP_SHOW_LIST,
	PROP_HIDE_LIST,
	PROP_TOGGLE_LIST,
	PROP_RESET_FIELDS,
	PROP_EXCLUDE_RESET_FIELDS
};

struct _PpsLinkAction {
	GObject base_instance;
};

struct _PpsLinkActionPrivate {
	PpsLinkActionType type;
	PpsLinkDest *dest;
	gchar *uri;
	gchar *filename;
	gchar *params;
	gchar *name;
	GList *show_list;
	GList *hide_list;
	GList *toggle_list;
	GList *reset_fields;
	gboolean exclude_reset_fields;
};

typedef struct _PpsLinkActionPrivate PpsLinkActionPrivate;

#define GET_PRIVATE(o) pps_link_action_get_instance_private (o)

G_DEFINE_TYPE_WITH_PRIVATE (PpsLinkAction, pps_link_action, G_TYPE_OBJECT)

PpsLinkActionType
pps_link_action_get_action_type (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), 0);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->type;
}

/**
 * pps_link_action_get_dest:
 * @self: an #PpsLinkAction
 *
 * Returns: (transfer none): an #PpsLinkDest
 */
PpsLinkDest *
pps_link_action_get_dest (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->dest;
}

const gchar *
pps_link_action_get_uri (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->uri;
}

const gchar *
pps_link_action_get_filename (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->filename;
}

const gchar *
pps_link_action_get_params (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->params;
}

const gchar *
pps_link_action_get_name (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->name;
}

/**
 * pps_link_action_get_show_list:
 * @self: an #PpsLinkAction
 *
 * Returns: (transfer none) (element-type PpsLayer): a list of #PpsLayer objects
 */
GList *
pps_link_action_get_show_list (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->show_list;
}

/**
 * pps_link_action_get_hide_list:
 * @self: an #PpsLinkAction
 *
 * Returns: (transfer none) (element-type PpsLayer): a list of #PpsLayer objects
 */
GList *
pps_link_action_get_hide_list (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->hide_list;
}

/**
 * pps_link_action_get_toggle_list:
 * @self: an #PpsLinkAction
 *
 * Returns: (transfer none) (element-type PpsLayer): a list of #PpsLayer objects
 */
GList *
pps_link_action_get_toggle_list (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->toggle_list;
}

/**
 * pps_link_action_get_reset_fields:
 * @self: an #PpsLinkAction
 *
 * Returns: (transfer none) (element-type gchar*): a list of fields to reset
 */
GList *
pps_link_action_get_reset_fields (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), NULL);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->reset_fields;
}

/**
 * pps_link_action_get_exclude_reset_fields:
 * @self: an #PpsLinkAction
 *
 * Returns: whether to exclude reset fields when resetting form
 */
gboolean
pps_link_action_get_exclude_reset_fields (PpsLinkAction *self)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (self), FALSE);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	return priv->exclude_reset_fields;
}

static void
pps_link_action_get_property (GObject *object,
                              guint prop_id,
                              GValue *value,
                              GParamSpec *param_spec)
{
	PpsLinkAction *self = PPS_LINK_ACTION (object);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	switch (prop_id) {
	case PROP_TYPE:
		g_value_set_enum (value, priv->type);
		break;
	case PROP_DEST:
		g_value_set_object (value, priv->dest);
		break;
	case PROP_URI:
		g_value_set_string (value, priv->uri);
		break;
	case PROP_FILENAME:
		g_value_set_string (value, priv->filename);
		break;
	case PROP_PARAMS:
		g_value_set_string (value, priv->params);
		break;
	case PROP_NAME:
		g_value_set_string (value, priv->name);
		break;
	case PROP_SHOW_LIST:
		g_value_set_pointer (value, priv->show_list);
		break;
	case PROP_HIDE_LIST:
		g_value_set_pointer (value, priv->hide_list);
		break;
	case PROP_TOGGLE_LIST:
		g_value_set_pointer (value, priv->toggle_list);
		break;
	case PROP_RESET_FIELDS:
		g_value_set_pointer (value, priv->reset_fields);
		break;
	case PROP_EXCLUDE_RESET_FIELDS:
		g_value_set_boolean (value, priv->exclude_reset_fields);
		break;
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID (object,
		                                   prop_id,
		                                   param_spec);
		break;
	}
}

static void
pps_link_action_set_property (GObject *object,
                              guint prop_id,
                              const GValue *value,
                              GParamSpec *param_spec)
{
	PpsLinkAction *self = PPS_LINK_ACTION (object);
	PpsLinkActionPrivate *priv = GET_PRIVATE (self);

	switch (prop_id) {
	case PROP_TYPE:
		priv->type = g_value_get_enum (value);
		break;
	case PROP_DEST:
		priv->dest = g_value_dup_object (value);
		break;
	case PROP_URI:
		g_free (priv->uri);
		priv->uri = g_value_dup_string (value);
		break;
	case PROP_FILENAME:
		g_free (priv->filename);
		priv->filename = g_value_dup_string (value);
		break;
	case PROP_PARAMS:
		g_free (priv->params);
		priv->params = g_value_dup_string (value);
		break;
	case PROP_NAME:
		g_free (priv->name);
		priv->name = g_value_dup_string (value);
		break;
	case PROP_SHOW_LIST:
		priv->show_list = g_value_get_pointer (value);
		break;
	case PROP_HIDE_LIST:
		priv->hide_list = g_value_get_pointer (value);
		break;
	case PROP_TOGGLE_LIST:
		priv->toggle_list = g_value_get_pointer (value);
		break;
	case PROP_RESET_FIELDS:
		priv->reset_fields = g_value_get_pointer (value);
		break;
	case PROP_EXCLUDE_RESET_FIELDS:
		priv->exclude_reset_fields = g_value_get_boolean (value);
		break;
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID (object,
		                                   prop_id,
		                                   param_spec);
		break;
	}
}

static void
pps_link_action_finalize (GObject *object)
{
	PpsLinkActionPrivate *priv = GET_PRIVATE (PPS_LINK_ACTION (object));

	g_clear_object (&priv->dest);

	g_clear_pointer (&priv->uri, g_free);
	g_clear_pointer (&priv->filename, g_free);
	g_clear_pointer (&priv->params, g_free);
	g_clear_pointer (&priv->name, g_free);

	g_clear_list (&priv->show_list, g_object_unref);
	g_clear_list (&priv->hide_list, g_object_unref);
	g_clear_list (&priv->toggle_list, g_object_unref);
	g_clear_list (&priv->reset_fields, g_free);

	G_OBJECT_CLASS (pps_link_action_parent_class)->finalize (object);
}

static void
pps_link_action_init (PpsLinkAction *pps_link_action)
{
}

static void
pps_link_action_class_init (PpsLinkActionClass *pps_link_action_class)
{
	GObjectClass *g_object_class;

	g_object_class = G_OBJECT_CLASS (pps_link_action_class);

	g_object_class->set_property = pps_link_action_set_property;
	g_object_class->get_property = pps_link_action_get_property;

	g_object_class->finalize = pps_link_action_finalize;

	g_object_class_install_property (g_object_class,
	                                 PROP_TYPE,
	                                 g_param_spec_enum ("type",
	                                                    "Action Type",
	                                                    "The link action type",
	                                                    PPS_TYPE_LINK_ACTION_TYPE,
	                                                    PPS_LINK_ACTION_TYPE_GOTO_DEST,
	                                                    G_PARAM_READWRITE |
	                                                        G_PARAM_CONSTRUCT_ONLY |
	                                                        G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_DEST,
	                                 g_param_spec_object ("dest",
	                                                      "Action destination",
	                                                      "The link action destination",
	                                                      PPS_TYPE_LINK_DEST,
	                                                      G_PARAM_READWRITE |
	                                                          G_PARAM_CONSTRUCT_ONLY |
	                                                          G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_URI,
	                                 g_param_spec_string ("uri",
	                                                      "Link Action URI",
	                                                      "The link action URI",
	                                                      NULL,
	                                                      G_PARAM_READWRITE |
	                                                          G_PARAM_CONSTRUCT_ONLY |
	                                                          G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_FILENAME,
	                                 g_param_spec_string ("filename",
	                                                      "Filename",
	                                                      "The link action filename",
	                                                      NULL,
	                                                      G_PARAM_READWRITE |
	                                                          G_PARAM_CONSTRUCT_ONLY |
	                                                          G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_PARAMS,
	                                 g_param_spec_string ("params",
	                                                      "Params",
	                                                      "The link action params",
	                                                      NULL,
	                                                      G_PARAM_READWRITE |
	                                                          G_PARAM_CONSTRUCT_ONLY |
	                                                          G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_NAME,
	                                 g_param_spec_string ("name",
	                                                      "Name",
	                                                      "The link action name",
	                                                      NULL,
	                                                      G_PARAM_READWRITE |
	                                                          G_PARAM_CONSTRUCT_ONLY |
	                                                          G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_SHOW_LIST,
	                                 g_param_spec_pointer ("show-list",
	                                                       "ShowList",
	                                                       "The list of layers that should be shown",
	                                                       G_PARAM_READWRITE |
	                                                           G_PARAM_CONSTRUCT_ONLY |
	                                                           G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_HIDE_LIST,
	                                 g_param_spec_pointer ("hide-list",
	                                                       "HideList",
	                                                       "The list of layers that should be hidden",
	                                                       G_PARAM_READWRITE |
	                                                           G_PARAM_CONSTRUCT_ONLY |
	                                                           G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_TOGGLE_LIST,
	                                 g_param_spec_pointer ("toggle-list",
	                                                       "ToggleList",
	                                                       "The list of layers that should be toggled",
	                                                       G_PARAM_READWRITE |
	                                                           G_PARAM_CONSTRUCT_ONLY |
	                                                           G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_RESET_FIELDS,
	                                 g_param_spec_pointer ("reset-fields",
	                                                       "ResetFields",
	                                                       "The list of fields that should be/should not be reset",
	                                                       G_PARAM_READWRITE |
	                                                           G_PARAM_CONSTRUCT_ONLY |
	                                                           G_PARAM_STATIC_STRINGS));
	g_object_class_install_property (g_object_class,
	                                 PROP_EXCLUDE_RESET_FIELDS,
	                                 g_param_spec_boolean ("exclude-reset-fields",
	                                                       "ExcludeResetFields",
	                                                       "Whether to exclude/include reset-fields when resetting form",
	                                                       FALSE,
	                                                       G_PARAM_READWRITE |
	                                                           G_PARAM_CONSTRUCT_ONLY |
	                                                           G_PARAM_STATIC_STRINGS));
}

PpsLinkAction *
pps_link_action_new_dest (PpsLinkDest *dest)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "dest", dest,
	                                      "type", PPS_LINK_ACTION_TYPE_GOTO_DEST,
	                                      NULL));
}

PpsLinkAction *
pps_link_action_new_remote (PpsLinkDest *dest,
                            const gchar *filename)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "dest", dest,
	                                      "filename", filename,
	                                      "type", PPS_LINK_ACTION_TYPE_GOTO_REMOTE,
	                                      NULL));
}

PpsLinkAction *
pps_link_action_new_external_uri (const gchar *uri)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "uri", uri,
	                                      "type", PPS_LINK_ACTION_TYPE_EXTERNAL_URI,
	                                      NULL));
}

PpsLinkAction *
pps_link_action_new_launch (const gchar *filename,
                            const gchar *params)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "filename", filename,
	                                      "params", params,
	                                      "type", PPS_LINK_ACTION_TYPE_LAUNCH,
	                                      NULL));
}

PpsLinkAction *
pps_link_action_new_named (const gchar *name)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "name", name,
	                                      "type", PPS_LINK_ACTION_TYPE_NAMED,
	                                      NULL));
}

/**
 * pps_link_action_new_layers_state:
 * @show_list: (element-type PpsLayer): a list of #PpsLayer objects
 * @hide_list: (element-type PpsLayer): a list of #PpsLayer objects
 * @toggle_list: (element-type PpsLayer): a list of #PpsLayer objects
 *
 * Returns: (transfer full): a new #PpsLinkAction
 */
PpsLinkAction *
pps_link_action_new_layers_state (GList *show_list,
                                  GList *hide_list,
                                  GList *toggle_list)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "show-list", show_list,
	                                      "hide-list", hide_list,
	                                      "toggle-list", toggle_list,
	                                      "type", PPS_LINK_ACTION_TYPE_LAYERS_STATE,
	                                      NULL));
}

/**
 * pps_link_action_new_reset_form:
 * @fields: (element-type gchar*): a list of fields to reset
 * @exclude_fields: whether to exclude reset fields when resetting form
 *
 * Returns: (transfer full): a new #PpsLinkAction
 */
PpsLinkAction *
pps_link_action_new_reset_form (GList *reset_fields,
                                gboolean exclude_reset_fields)
{
	return PPS_LINK_ACTION (g_object_new (PPS_TYPE_LINK_ACTION,
	                                      "exclude-reset-fields", exclude_reset_fields,
	                                      "reset-fields", reset_fields,
	                                      "type", PPS_LINK_ACTION_TYPE_RESET_FORM,
	                                      NULL));
}

/**
 * pps_link_action_equal:
 * @a: a #PpsLinkAction
 * @b: a #PpsLinkAction
 *
 * Checks whether @a and @b are equal.
 *
 * Returns: %TRUE iff @a and @b are equal
 */
gboolean
pps_link_action_equal (PpsLinkAction *a,
                       PpsLinkAction *b)
{
	g_return_val_if_fail (PPS_IS_LINK_ACTION (a), FALSE);
	g_return_val_if_fail (PPS_IS_LINK_ACTION (b), FALSE);
	PpsLinkActionPrivate *a_priv = GET_PRIVATE (a);
	PpsLinkActionPrivate *b_priv = GET_PRIVATE (b);

	if (a == b)
		return TRUE;

	if (a_priv->type != b_priv->type)
		return FALSE;

	switch (a_priv->type) {
	case PPS_LINK_ACTION_TYPE_GOTO_DEST:
		return pps_link_dest_equal (a_priv->dest, b_priv->dest);

	case PPS_LINK_ACTION_TYPE_GOTO_REMOTE:
		return pps_link_dest_equal (a_priv->dest, b_priv->dest) &&
		       !g_strcmp0 (a_priv->filename, b_priv->filename);

	case PPS_LINK_ACTION_TYPE_EXTERNAL_URI:
		return !g_strcmp0 (a_priv->uri, b_priv->uri);

	case PPS_LINK_ACTION_TYPE_LAUNCH:
		return !g_strcmp0 (a_priv->filename, b_priv->filename) &&
		       !g_strcmp0 (a_priv->params, b_priv->params);

	case PPS_LINK_ACTION_TYPE_NAMED:
		return !g_strcmp0 (a_priv->name, b_priv->name);

	default:
		return FALSE;
	}

	return FALSE;
}