gtktreestore.c 16.8 KB
Newer Older
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
/* gtktreestore.c
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include "gtktreemodel.h"
#include "gtktreestore.h"
#include "gtktreedatalist.h"
#include "gtksignal.h"
#include <string.h>

#define G_NODE(node) ((GNode *)node)

static void           gtk_tree_store_init            (GtkTreeStore      *TreeStore);
static void           gtk_tree_store_class_init      (GtkTreeStoreClass *klass);
static gint           gtk_tree_store_get_n_columns   (GtkTreeModel      *tree_model);
static GtkTreeNode    gtk_tree_store_get_node        (GtkTreeModel      *tree_model,
						      GtkTreePath       *path);
static GtkTreePath   *gtk_tree_store_get_path        (GtkTreeModel      *tree_model,
						      GtkTreeNode        node);
static void           gtk_tree_store_node_get_value  (GtkTreeModel      *tree_model,
						      GtkTreeNode        node,
						      gint               column,
						      GValue            *value);
static gboolean       gtk_tree_store_node_next       (GtkTreeModel      *tree_model,
						      GtkTreeNode       *node);
static GtkTreeNode    gtk_tree_store_node_children   (GtkTreeModel      *tree_model,
						      GtkTreeNode        node);
static gboolean       gtk_tree_store_node_has_child  (GtkTreeModel      *tree_model,
						      GtkTreeNode        node);
static gint           gtk_tree_store_node_n_children (GtkTreeModel      *tree_model,
						      GtkTreeNode        node);
static GtkTreeNode    gtk_tree_store_node_nth_child  (GtkTreeModel      *tree_model,
						      GtkTreeNode        node,
						      gint               n);
static GtkTreeNode    gtk_tree_store_node_parent     (GtkTreeModel      *tree_model,
						      GtkTreeNode        node);


static GtkTreeModelClass *parent_class = NULL;


GtkType
gtk_tree_store_get_type (void)
{
  static GtkType tree_store_type = 0;

  if (!tree_store_type)
    {
      static const GTypeInfo tree_store_info =
      {
        sizeof (GtkTreeStoreClass),
	NULL,		/* base_init */
	NULL,		/* base_finalize */
        (GClassInitFunc) gtk_tree_store_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
        sizeof (GtkTreeStore),
	0,              /* n_preallocs */
        (GInstanceInitFunc) gtk_tree_store_init
      };

      tree_store_type = g_type_register_static (GTK_TYPE_TREE_MODEL, "GtkTreeStore", &tree_store_info);
    }

  return tree_store_type;
}

static void
gtk_tree_store_class_init (GtkTreeStoreClass *klass)
{
  GtkObjectClass *object_class;
  GtkTreeModelClass *tree_model_class;

  object_class = (GtkObjectClass *) klass;
  tree_model_class = (GtkTreeModelClass *) klass;

  parent_class = gtk_type_class (gtk_tree_model_get_type ());

  tree_model_class->get_n_columns = gtk_tree_store_get_n_columns;
  tree_model_class->get_node = gtk_tree_store_get_node;
  tree_model_class->get_path = gtk_tree_store_get_path;
  tree_model_class->node_get_value = gtk_tree_store_node_get_value;
  tree_model_class->node_next = gtk_tree_store_node_next;
  tree_model_class->node_children = gtk_tree_store_node_children;
  tree_model_class->node_has_child = gtk_tree_store_node_has_child;
  tree_model_class->node_n_children = gtk_tree_store_node_n_children;
  tree_model_class->node_nth_child = gtk_tree_store_node_nth_child;
  tree_model_class->node_parent = gtk_tree_store_node_parent;
}

static void
gtk_tree_store_init (GtkTreeStore *tree_store)
{
  tree_store->root = gtk_tree_store_node_new ();
}

GtkObject *
gtk_tree_store_new (void)
{
  return GTK_OBJECT (gtk_type_new (gtk_tree_store_get_type ()));
}

GtkObject *
gtk_tree_store_new_with_values (gint n_columns,
				...)
{
  GtkObject *retval;
  va_list args;
  gint i;

  g_return_val_if_fail (n_columns > 0, NULL);

  retval = gtk_tree_store_new ();
  gtk_tree_store_set_n_columns (GTK_TREE_STORE (retval),
				n_columns);

  va_start (args, n_columns);
  for (i = 0; i < n_columns; i++)
    gtk_tree_store_set_column_type (GTK_TREE_STORE (retval),
				    i, va_arg (args, GType));

  va_end (args);

  return retval;
}

void
gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
			      gint          n_columns)
{
  GType *new_columns;

  g_return_if_fail (tree_store != NULL);
  g_return_if_fail (GTK_IS_TREE_STORE (tree_store));

  if (tree_store->n_columns == n_columns)
    return;

  new_columns = g_new0 (GType, n_columns);
  if (tree_store->column_headers)
    {
      /* copy the old header orders over */
      if (n_columns >= tree_store->n_columns)
	memcpy (new_columns, tree_store->column_headers, tree_store->n_columns * sizeof (gchar *));
      else
	memcpy (new_columns, tree_store->column_headers, n_columns * sizeof (GType));

      g_free (tree_store->column_headers);
    }

  tree_store->column_headers = new_columns;
  tree_store->n_columns = n_columns;
}

void
gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
				gint          column,
				GType         type)
{
  g_return_if_fail (tree_store != NULL);
  g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
  g_return_if_fail (column >=0 && column < tree_store->n_columns);

  tree_store->column_headers[column] = type;
}

/* fulfill the GtkTreeModel requirements */
/* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node.  However,
 * it is not visible to the tree or to the user., and the path "1" refers to the
 * first child of GtkTreeStore::root.
 */
static gint
gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
{
  g_return_val_if_fail (tree_model != NULL, 0);
  g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);

  return GTK_TREE_STORE (tree_model)->n_columns;
}

static GtkTreeNode
gtk_tree_store_get_node (GtkTreeModel *tree_model,
			 GtkTreePath  *path)
{
  gint i;
201
  GtkTreeNode node;
202
203
204
205
206
207
  gint *indices = gtk_tree_path_get_indices (path);

  node = GTK_TREE_STORE (tree_model)->root;

  for (i = 0; i < gtk_tree_path_get_depth (path); i ++)
    {
208
209
210
      node = (GtkTreeNode) gtk_tree_store_node_nth_child (tree_model,
							  (GtkTreeNode) node,
							  indices[i]);
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
      if (node == NULL)
	return NULL;
    };
  return (GtkTreeNode) node;
}

static GtkTreePath *
gtk_tree_store_get_path (GtkTreeModel *tree_model,
			 GtkTreeNode   node)
{
  GtkTreePath *retval;
  GNode *tmp_node;
  gint i = 0;

  g_return_val_if_fail (tree_model != NULL, NULL);

  if (node == NULL)
    return NULL;
  if (node == G_NODE (GTK_TREE_STORE (tree_model)->root))
    return NULL;

  if (G_NODE (node)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
    {
      retval = gtk_tree_path_new ();
      tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
    }
  else
    {
      retval = gtk_tree_store_get_path (tree_model,
					G_NODE (node)->parent);
      tmp_node = G_NODE (node)->parent->children;
    }

  if (retval == NULL)
    return NULL;
  if (tmp_node == NULL)
    {
      gtk_tree_path_free (retval);
      return NULL;
    }

  for (; tmp_node; tmp_node = tmp_node->next)
    {
      if (tmp_node == G_NODE (node))
	break;
      i++;
    }
  if (tmp_node == NULL)
    {
      /* We couldn't find node, meaning it's prolly not ours */
      gtk_tree_path_free (retval);
      return NULL;
    }

  gtk_tree_path_append_index (retval, i);

  return retval;
}


static void
gtk_tree_store_node_get_value (GtkTreeModel *tree_model,
			       GtkTreeNode   node,
			       gint          column,
			       GValue       *value)
{
  GtkTreeDataList *list;
  gint tmp_column = column;

  g_return_if_fail (tree_model != NULL);
  g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
  g_return_if_fail (node != NULL);
  g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);

  list = G_NODE (node)->data;

  while (tmp_column-- > 0 && list)
    list = list->next;

  g_return_if_fail (list != NULL);

  gtk_tree_data_list_node_to_value (list,
				    GTK_TREE_STORE (tree_model)->column_headers[column],
				    value);
}

static gboolean
gtk_tree_store_node_next (GtkTreeModel  *tree_model,
			  GtkTreeNode   *node)
{
  if (node == NULL || *node == NULL)
    return FALSE;

304
  *node = (GtkTreeNode) G_NODE (*node)->next;
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
  return (*node != NULL);
}

static GtkTreeNode
gtk_tree_store_node_children (GtkTreeModel *tree_model,
			      GtkTreeNode   node)
{
  return (GtkTreeNode) G_NODE (node)->children;
}

static gboolean
gtk_tree_store_node_has_child (GtkTreeModel *tree_model,
			       GtkTreeNode   node)
{
  return G_NODE (node)->children != NULL;
}

static gint
gtk_tree_store_node_n_children (GtkTreeModel *tree_model,
				GtkTreeNode   node)
{
  gint i = 0;

328
  node = (GtkTreeNode) G_NODE (node)->children;
329
330
331
  while (node != NULL)
    {
      i++;
332
      node = (GtkTreeNode) G_NODE (node)->next;
333
334
335
336
337
338
339
340
341
342
343
344
    }

  return i;
}

static GtkTreeNode
gtk_tree_store_node_nth_child (GtkTreeModel *tree_model,
			       GtkTreeNode   node,
			       gint          n)
{
  g_return_val_if_fail (node != NULL, NULL);

345
  return (GtkTreeNode) g_node_nth_child (G_NODE (node), n);
346
347
348
349
350
351
352
353
354
355
}

static GtkTreeNode
gtk_tree_store_node_parent (GtkTreeModel *tree_model,
			    GtkTreeNode   node)
{
  return (GtkTreeNode) G_NODE (node)->parent;
}

/* Public accessors */
356
GtkTreeNode
357
358
gtk_tree_store_node_new (void)
{
359
  GtkTreeNode retval;
360

361
  retval = (GtkTreeNode) g_node_new (NULL);
362
363
364
365
366
367
368
369
370
  return retval;
}

/*
 * This is a somewhat inelegant function that does a lot of list
 * manipulations on it's own.
 */
void
gtk_tree_store_node_set_cell (GtkTreeStore *tree_store,
371
			      GtkTreeNode   node,
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
			      gint          column,
			      GValue       *value)
{
  GtkTreeDataList *list;
  GtkTreeDataList *prev;

  g_return_if_fail (tree_store != NULL);
  g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
  g_return_if_fail (node != NULL);
  g_return_if_fail (column >= 0 && column < tree_store->n_columns);

  prev = list = G_NODE (node)->data;

  while (list != NULL)
    {
      if (column == 0)
	{
	  gtk_tree_data_list_value_to_node (list, value);
	  return;
	}

      column--;
      prev = list;
      list = list->next;
    }

  if (G_NODE (node)->data == NULL)
    {
      G_NODE (node)->data = list = gtk_tree_data_list_alloc ();
      list->next = NULL;
    }
  else
    {
      list = prev->next = gtk_tree_data_list_alloc ();
      list->next = NULL;
    }

  while (column != 0)
    {
      list->next = gtk_tree_data_list_alloc ();
      list = list->next;
      list->next = NULL;
      column --;
    }
  gtk_tree_data_list_value_to_node (list, value);
}

void
gtk_tree_store_node_remove (GtkTreeStore *model,
421
			    GtkTreeNode   node)
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
{
  GtkTreePath *path;
  GNode *parent;

  g_return_if_fail (model != NULL);
  g_return_if_fail (GTK_IS_TREE_STORE (model));
  g_return_if_fail (node != NULL);
  /* FIXME: if node is NULL, do I want to free the tree? */

  parent = G_NODE (node)->parent;

  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), node);
  g_node_destroy (G_NODE (node));
  gtk_signal_emit_by_name (GTK_OBJECT (model),
			   "node_deleted",
			   path);
  if (parent != G_NODE (model->root) && parent->children == NULL)
    {
      gtk_tree_path_up (path);
      gtk_signal_emit_by_name (GTK_OBJECT (model),
			       "node_child_toggled",
			       path,
			       parent);
    }
  gtk_tree_path_free (path);
}

449
GtkTreeNode
450
gtk_tree_store_node_insert (GtkTreeStore *model,
451
			    GtkTreeNode   parent,
452
			    gint          position,
453
			    GtkTreeNode   node)
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
{
  GtkTreePath *path;

  g_return_val_if_fail (model != NULL, node);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), node);
  g_return_val_if_fail (node != NULL, node);

  if (parent == NULL)
    parent = model->root;

  g_node_insert (G_NODE (parent), position, G_NODE (node));

  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), node);
  gtk_signal_emit_by_name (GTK_OBJECT (model),
			   "node_inserted",
			   path, node);
  gtk_tree_path_free (path);

  return node;
}

475
GtkTreeNode
476
gtk_tree_store_node_insert_before (GtkTreeStore *model,
477
478
479
				   GtkTreeNode   parent,
				   GtkTreeNode   sibling,
				   GtkTreeNode   node)
480
481
482
483
484
485
486
487
488
489
490
{
  GtkTreePath *path;

  g_return_val_if_fail (model != NULL, node);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), node);
  g_return_val_if_fail (node != NULL, node);

  if (parent == NULL && sibling == NULL)
    parent = model->root;

  if (parent == NULL)
491
    parent = (GtkTreeNode) G_NODE (sibling)->parent;
492
493
494
495
496
497
498
499
500
501
502
503

  g_node_insert_before (G_NODE (parent), G_NODE (sibling), G_NODE (node));

  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), node);
  gtk_signal_emit_by_name (GTK_OBJECT (model),
			   "node_inserted",
			   path, node);
  gtk_tree_path_free (path);

  return node;
}

504
GtkTreeNode
505
gtk_tree_store_node_insert_after (GtkTreeStore *model,
506
507
508
				  GtkTreeNode   parent,
				  GtkTreeNode   sibling,
				  GtkTreeNode   node)
509
510
511
512
513
514
515
516
517
518
519
{
  GtkTreePath *path;

  g_return_val_if_fail (model != NULL, node);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), node);
  g_return_val_if_fail (node != NULL, node);

  if (parent == NULL && sibling == NULL)
    parent = model->root;

  if (parent == NULL)
520
    parent = (GtkTreeNode) G_NODE (sibling)->parent;
521
522
523
524
525
526
527
528
529
530
531

  g_node_insert_after (G_NODE (parent), G_NODE (sibling), G_NODE (node));

  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), node);
  gtk_signal_emit_by_name (GTK_OBJECT (model),
			   "node_inserted",
			   path, node);
  gtk_tree_path_free (path);
  return node;
}

532
GtkTreeNode
533
gtk_tree_store_node_prepend (GtkTreeStore *model,
534
535
			     GtkTreeNode   parent,
			     GtkTreeNode   node)
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
568
569
570
571
572
573
574
575
576
{
  g_return_val_if_fail (model != NULL, node);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), node);
  g_return_val_if_fail (node != NULL, node);

  if (parent == NULL)
    parent = model->root;

  if (G_NODE (parent)->children == NULL)
    {
      GtkTreePath *path;
      g_node_prepend (G_NODE (parent), G_NODE (node));
      if (parent != model->root)
	{
	  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), parent);
	  gtk_signal_emit_by_name (GTK_OBJECT (model),
				   "node_child_toggled",
				   path,
				   parent);
	  gtk_tree_path_append_index (path, 1);
	}
      else
	{
	  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), G_NODE (parent)->children);
	}
      gtk_signal_emit_by_name (GTK_OBJECT (model),
			       "node_inserted",
			       path,
			       G_NODE (parent)->children);
      gtk_tree_path_free (path);
    }
  else
    {
      gtk_tree_store_node_insert_after (model,
					 parent == model->root?NULL:parent,
					 NULL,
					 node);
    }
  return node;
}

577
GtkTreeNode
578
gtk_tree_store_node_append (GtkTreeStore *model,
579
580
			    GtkTreeNode   parent,
			    GtkTreeNode   node)
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
{
  g_return_val_if_fail (model != NULL, node);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), node);
  g_return_val_if_fail (node != NULL, node);

  if (parent == NULL)
    parent = model->root;

  if (G_NODE (parent)->children == NULL)
    {
      GtkTreePath *path;
      g_node_append (G_NODE (parent), G_NODE (node));
      if (parent != model->root)
	{
	  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), parent);
	  gtk_signal_emit_by_name (GTK_OBJECT (model),
				   "node_child_toggled",
				   path,
				   parent);
	  gtk_tree_path_append_index (path, 1);
	}
      else
	{
	  path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), G_NODE (parent)->children);
	}
      gtk_signal_emit_by_name (GTK_OBJECT (model),
			       "node_inserted",
			       path,
			       G_NODE (parent)->children);
      gtk_tree_path_free (path);
    }
  else
    {
      gtk_tree_store_node_insert_before (model,
					 parent == model->root?NULL:parent,
					 NULL,
					 node);
    }
  return node;
}

622
GtkTreeNode
623
624
625
626
627
gtk_tree_store_node_get_root (GtkTreeStore *model)
{
  g_return_val_if_fail (model != NULL, NULL);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), NULL);

628
  return (GtkTreeNode) model->root;
629
630
631
632
633
}


gboolean
gtk_tree_store_node_is_ancestor (GtkTreeStore *model,
634
635
				 GtkTreeNode   node,
				 GtkTreeNode   descendant)
636
637
638
639
640
641
642
643
644
645
646
647
{
  g_return_val_if_fail (model != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), FALSE);
  g_return_val_if_fail (node != NULL, FALSE);
  g_return_val_if_fail (descendant != NULL, FALSE);

  return g_node_is_ancestor (G_NODE (node), G_NODE (descendant));
}


gint
gtk_tree_store_node_depth (GtkTreeStore *model,
648
			   GtkTreeNode   node)
649
650
651
652
653
654
655
{
  g_return_val_if_fail (model != NULL, 0);
  g_return_val_if_fail (GTK_IS_TREE_STORE (model), 0);
  g_return_val_if_fail (node != NULL, 0);

  return g_node_depth (G_NODE (node));
}