-
Notifications
You must be signed in to change notification settings - Fork 1
/
ttkTreeview.c
3447 lines (2983 loc) · 89.3 KB
/
ttkTreeview.c
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
568
569
570
571
572
573
574
575
576
577
578
579
580
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
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2004, Joe English
*
* ttk::treeview widget implementation.
*/
#include <string.h>
#include <stdio.h>
#include <tk.h>
#include "ttkTheme.h"
#include "ttkWidget.h"
#define DEF_TREE_ROWS "10"
#define DEF_COLWIDTH "200"
#define DEF_MINWIDTH "20"
static const int DEFAULT_ROWHEIGHT = 20;
static const int DEFAULT_INDENT = 20;
static const int HALO = 4; /* separator */
#define TTK_STATE_OPEN TTK_STATE_USER1
#define TTK_STATE_LEAF TTK_STATE_USER2
#define STATE_CHANGED (0x100) /* item state option changed */
/*------------------------------------------------------------------------
* +++ Tree items.
*
* INVARIANTS:
* item->children ==> item->children->parent == item
* item->next ==> item->next->parent == item->parent
* item->next ==> item->next->prev == item
* item->prev ==> item->prev->next == item
*/
typedef struct TreeItemRec TreeItem;
struct TreeItemRec {
Tcl_HashEntry *entryPtr; /* Back-pointer to hash table entry */
TreeItem *parent; /* Parent item */
TreeItem *children; /* Linked list of child items */
TreeItem *next; /* Next sibling */
TreeItem *prev; /* Previous sibling */
/*
* Options and instance data:
*/
Ttk_State state;
Tcl_Obj *textObj;
Tcl_Obj *imageObj;
Tcl_Obj *valuesObj;
Tcl_Obj *openObj;
Tcl_Obj *tagsObj;
/*
* Derived resources:
*/
Ttk_TagSet tagset;
Ttk_ImageSpec *imagespec;
};
#define ITEM_OPTION_TAGS_CHANGED 0x100
#define ITEM_OPTION_IMAGE_CHANGED 0x200
static Tk_OptionSpec ItemOptionSpecs[] = {
{TK_OPTION_STRING, "-text", "text", "Text",
"", Tk_Offset(TreeItem,textObj), -1,
0,0,0 },
{TK_OPTION_STRING, "-image", "image", "Image",
NULL, Tk_Offset(TreeItem,imageObj), -1,
TK_OPTION_NULL_OK,0,ITEM_OPTION_IMAGE_CHANGED },
{TK_OPTION_STRING, "-values", "values", "Values",
NULL, Tk_Offset(TreeItem,valuesObj), -1,
TK_OPTION_NULL_OK,0,0 },
{TK_OPTION_BOOLEAN, "-open", "open", "Open",
"0", Tk_Offset(TreeItem,openObj), -1,
0,0,0 },
{TK_OPTION_STRING, "-tags", "tags", "Tags",
NULL, Tk_Offset(TreeItem,tagsObj), -1,
TK_OPTION_NULL_OK,0,ITEM_OPTION_TAGS_CHANGED },
{TK_OPTION_END, 0,0,0, NULL, -1,-1, 0,0,0}
};
/* + NewItem --
* Allocate a new, uninitialized, unlinked item
*/
static TreeItem *NewItem(void)
{
TreeItem *item = (TreeItem*)ckalloc(sizeof(*item));
item->entryPtr = 0;
item->parent = item->children = item->next = item->prev = NULL;
item->state = 0ul;
item->textObj = NULL;
item->imageObj = NULL;
item->valuesObj = NULL;
item->openObj = NULL;
item->tagsObj = NULL;
item->tagset = NULL;
item->imagespec = NULL;
return item;
}
/* + FreeItem --
* Destroy an item
*/
static void FreeItem(TreeItem *item)
{
if (item->textObj) { Tcl_DecrRefCount(item->textObj); }
if (item->imageObj) { Tcl_DecrRefCount(item->imageObj); }
if (item->valuesObj) { Tcl_DecrRefCount(item->valuesObj); }
if (item->openObj) { Tcl_DecrRefCount(item->openObj); }
if (item->tagsObj) { Tcl_DecrRefCount(item->tagsObj); }
if (item->tagset) { Ttk_FreeTagSet(item->tagset); }
if (item->imagespec) { TtkFreeImageSpec(item->imagespec); }
ckfree((ClientData)item);
}
static void FreeItemCB(void *clientData) { FreeItem(clientData); }
/* + DetachItem --
* Unlink an item from the tree.
*/
static void DetachItem(TreeItem *item)
{
if (item->parent && item->parent->children == item)
item->parent->children = item->next;
if (item->prev)
item->prev->next = item->next;
if (item->next)
item->next->prev = item->prev;
item->next = item->prev = item->parent = NULL;
}
/* + InsertItem --
* Insert an item into the tree after the specified item.
*
* Preconditions:
* + item is currently detached
* + prev != NULL ==> prev->parent == parent.
*/
static void InsertItem(TreeItem *parent, TreeItem *prev, TreeItem *item)
{
item->parent = parent;
item->prev = prev;
if (prev) {
item->next = prev->next;
prev->next = item;
} else {
item->next = parent->children;
parent->children = item;
}
if (item->next) {
item->next->prev = item;
}
}
/* + NextPreorder --
* Return the next item in preorder traversal order.
*/
static TreeItem *NextPreorder(TreeItem *item)
{
if (item->children)
return item->children;
while (!item->next) {
item = item->parent;
if (!item)
return 0;
}
return item->next;
}
/*------------------------------------------------------------------------
* +++ Display items and tag options.
*/
typedef struct {
Tcl_Obj *textObj; /* taken from item / data cell */
Tcl_Obj *imageObj; /* taken from item */
Tcl_Obj *anchorObj; /* from column <<NOTE-ANCHOR>> */
Tcl_Obj *backgroundObj; /* remainder from tag */
Tcl_Obj *foregroundObj;
Tcl_Obj *fontObj;
} DisplayItem;
static Tk_OptionSpec TagOptionSpecs[] = {
{TK_OPTION_STRING, "-text", "text", "Text",
NULL, Tk_Offset(DisplayItem,textObj), -1,
TK_OPTION_NULL_OK,0,0 },
{TK_OPTION_STRING, "-image", "image", "Image",
NULL, Tk_Offset(DisplayItem,imageObj), -1,
TK_OPTION_NULL_OK,0,0 },
{TK_OPTION_ANCHOR, "-anchor", "anchor", "Anchor",
NULL, Tk_Offset(DisplayItem,anchorObj), -1,
TK_OPTION_NULL_OK, 0, GEOMETRY_CHANGED}, /* <<NOTE-ANCHOR>> */
{TK_OPTION_COLOR, "-background", "windowColor", "WindowColor",
NULL, Tk_Offset(DisplayItem,backgroundObj), -1,
TK_OPTION_NULL_OK,0,0 },
{TK_OPTION_COLOR, "-foreground", "textColor", "TextColor",
NULL, Tk_Offset(DisplayItem,foregroundObj), -1,
TK_OPTION_NULL_OK,0,0 },
{TK_OPTION_FONT, "-font", "font", "Font",
NULL, Tk_Offset(DisplayItem,fontObj), -1,
TK_OPTION_NULL_OK,0,GEOMETRY_CHANGED },
{TK_OPTION_END, 0,0,0, NULL, -1,-1, 0,0,0}
};
/*------------------------------------------------------------------------
* +++ Columns.
*
* There are separate option tables associated with the column record:
* ColumnOptionSpecs is for configuring the column,
* and HeadingOptionSpecs is for drawing headings.
*/
typedef struct {
int width; /* Column width, in pixels */
int minWidth; /* Minimum column width, in pixels */
int stretch; /* Should column stretch while resizing? */
Tcl_Obj *idObj; /* Column identifier, from -columns option */
Tcl_Obj *anchorObj; /* -anchor for cell data <<NOTE-ANCHOR>> */
/* Column heading data:
*/
Tcl_Obj *headingObj; /* Heading label */
Tcl_Obj *headingImageObj; /* Heading image */
Tcl_Obj *headingAnchorObj; /* -anchor for heading label */
Tcl_Obj *headingCommandObj; /* Command to execute */
Tcl_Obj *headingStateObj; /* @@@ testing ... */
Ttk_State headingState; /* ... */
/* Temporary storage for cell data
*/
Tcl_Obj *data;
} TreeColumn;
static void InitColumn(TreeColumn *column)
{
column->width = 200;
column->minWidth = 20;
column->stretch = 1;
column->idObj = 0;
column->anchorObj = 0;
column->headingState = 0;
column->headingObj = 0;
column->headingImageObj = 0;
column->headingAnchorObj = 0;
column->headingStateObj = 0;
column->headingCommandObj = 0;
column->data = 0;
}
static void FreeColumn(TreeColumn *column)
{
if (column->idObj) { Tcl_DecrRefCount(column->idObj); }
if (column->anchorObj) { Tcl_DecrRefCount(column->anchorObj); }
if (column->headingObj) { Tcl_DecrRefCount(column->headingObj); }
if (column->headingImageObj) { Tcl_DecrRefCount(column->headingImageObj); }
if (column->headingAnchorObj) { Tcl_DecrRefCount(column->headingAnchorObj); }
if (column->headingStateObj) { Tcl_DecrRefCount(column->headingStateObj); }
if (column->headingCommandObj) { Tcl_DecrRefCount(column->headingCommandObj); }
/* Don't touch column->data, it's scratch storage */
}
static Tk_OptionSpec ColumnOptionSpecs[] = {
{TK_OPTION_INT, "-width", "width", "Width",
DEF_COLWIDTH, -1, Tk_Offset(TreeColumn,width),
0,0,GEOMETRY_CHANGED },
{TK_OPTION_INT, "-minwidth", "minWidth", "MinWidth",
DEF_MINWIDTH, -1, Tk_Offset(TreeColumn,minWidth),
0,0,0 },
{TK_OPTION_BOOLEAN, "-stretch", "stretch", "Stretch",
"1", -1, Tk_Offset(TreeColumn,stretch),
0,0,0 },
{TK_OPTION_ANCHOR, "-anchor", "anchor", "Anchor",
"w", Tk_Offset(TreeColumn,anchorObj), -1, /* <<NOTE-ANCHOR>> */
0,0,0 },
{TK_OPTION_STRING, "-id", "id", "ID",
NULL, Tk_Offset(TreeColumn,idObj), -1,
TK_OPTION_NULL_OK,0,READONLY_OPTION },
{TK_OPTION_END, 0,0,0, NULL, -1,-1, 0,0,0}
};
static Tk_OptionSpec HeadingOptionSpecs[] = {
{TK_OPTION_STRING, "-text", "text", "Text",
"", Tk_Offset(TreeColumn,headingObj), -1,
0,0,0 },
{TK_OPTION_STRING, "-image", "image", "Image",
"", Tk_Offset(TreeColumn,headingImageObj), -1,
0,0,0 },
{TK_OPTION_ANCHOR, "-anchor", "anchor", "Anchor",
"center", Tk_Offset(TreeColumn,headingAnchorObj), -1,
0,0,0 },
{TK_OPTION_STRING, "-command", "", "",
"", Tk_Offset(TreeColumn,headingCommandObj), -1,
TK_OPTION_NULL_OK,0,0 },
{TK_OPTION_STRING, "state", "", "",
"", Tk_Offset(TreeColumn,headingStateObj), -1,
0,0,STATE_CHANGED },
{TK_OPTION_END, 0,0,0, NULL, -1,-1, 0,0,0}
};
/*------------------------------------------------------------------------
* +++ -show option:
* TODO: Implement SHOW_BRANCHES.
*/
#define SHOW_TREE (0x1) /* Show tree column? */
#define SHOW_HEADINGS (0x2) /* Show heading row? */
#define DEFAULT_SHOW "tree headings"
static const char *showStrings[] = {
"tree", "headings", NULL
};
static int GetEnumSetFromObj(
Tcl_Interp *interp,
Tcl_Obj *objPtr,
const char *table[],
unsigned *resultPtr)
{
unsigned result = 0;
int i, objc;
Tcl_Obj **objv;
if (Tcl_ListObjGetElements(interp, objPtr, &objc, &objv) != TCL_OK)
return TCL_ERROR;
for (i = 0; i < objc; ++i) {
int index;
if (TCL_OK != Tcl_GetIndexFromObj(
interp, objv[i], table, "value", TCL_EXACT, &index))
{
return TCL_ERROR;
}
result |= (1 << index);
}
*resultPtr = result;
return TCL_OK;
}
/*------------------------------------------------------------------------
* +++ Treeview widget record.
*
* Dependencies:
* columns, columnNames: -columns
* displayColumns: -columns, -displaycolumns
* headingHeight: [layout]
* rowHeight, indent: style
*/
typedef struct {
/* Resources acquired at initialization-time:
*/
Tk_OptionTable itemOptionTable;
Tk_OptionTable columnOptionTable;
Tk_OptionTable headingOptionTable;
Tk_OptionTable tagOptionTable;
Tk_BindingTable bindingTable;
Ttk_TagTable tagTable;
/* Acquired in GetLayout hook:
*/
Ttk_Layout itemLayout;
Ttk_Layout cellLayout;
Ttk_Layout headingLayout;
Ttk_Layout rowLayout;
int headingHeight; /* Space for headings */
int rowHeight; /* Height of each item */
int indent; /* #pixels horizontal offset for child items */
/* Tree data:
*/
Tcl_HashTable items; /* Map: item name -> item */
int serial; /* Next item # for autogenerated names */
TreeItem *root; /* Root item */
TreeColumn column0; /* Column options for display column #0 */
TreeColumn *columns; /* Array of column options for data columns */
TreeItem *focus; /* Current focus item */
TreeItem *endPtr; /* See EndPosition() */
/* Widget options:
*/
Tcl_Obj *columnsObj; /* List of symbolic column names */
Tcl_Obj *displayColumnsObj; /* List of columns to display */
Tcl_Obj *heightObj; /* height (rows) */
Tcl_Obj *paddingObj; /* internal padding */
Tcl_Obj *showObj; /* -show list */
Tcl_Obj *selectModeObj; /* -selectmode option */
Scrollable xscroll;
ScrollHandle xscrollHandle;
Scrollable yscroll;
ScrollHandle yscrollHandle;
/* Derived resources:
*/
Tcl_HashTable columnNames; /* Map: column name -> column table entry */
int nColumns; /* #columns */
unsigned showFlags; /* bitmask of subparts to display */
TreeColumn **displayColumns; /* List of columns for display (incl tree) */
int nDisplayColumns; /* #display columns */
Ttk_Box headingArea; /* Display area for column headings */
Ttk_Box treeArea; /* Display area for tree */
int slack; /* Slack space (see Resizing section) */
} TreePart;
typedef struct {
WidgetCore core;
TreePart tree;
} Treeview;
#define USER_MASK 0x0100
#define COLUMNS_CHANGED (USER_MASK)
#define DCOLUMNS_CHANGED (USER_MASK<<1)
#define SCROLLCMD_CHANGED (USER_MASK<<2)
#define SHOW_CHANGED (USER_MASK<<3)
static const char *SelectModeStrings[] = { "none", "browse", "extended", NULL };
static Tk_OptionSpec TreeviewOptionSpecs[] = {
{TK_OPTION_STRING, "-columns", "columns", "Columns",
"", Tk_Offset(Treeview,tree.columnsObj), -1,
0,0,COLUMNS_CHANGED | GEOMETRY_CHANGED /*| READONLY_OPTION*/ },
{TK_OPTION_STRING, "-displaycolumns","displayColumns","DisplayColumns",
"#all", Tk_Offset(Treeview,tree.displayColumnsObj), -1,
0,0,DCOLUMNS_CHANGED | GEOMETRY_CHANGED },
{TK_OPTION_STRING, "-show", "show", "Show",
DEFAULT_SHOW, Tk_Offset(Treeview,tree.showObj), -1,
0,0,SHOW_CHANGED | GEOMETRY_CHANGED },
{TK_OPTION_STRING_TABLE, "-selectmode", "selectMode", "SelectMode",
"extended", Tk_Offset(Treeview,tree.selectModeObj), -1,
0,(ClientData)SelectModeStrings,0 },
{TK_OPTION_PIXELS, "-height", "height", "Height",
DEF_TREE_ROWS, Tk_Offset(Treeview,tree.heightObj), -1,
0,0,GEOMETRY_CHANGED},
{TK_OPTION_STRING, "-padding", "padding", "Pad",
NULL, Tk_Offset(Treeview,tree.paddingObj), -1,
TK_OPTION_NULL_OK,0,GEOMETRY_CHANGED },
{TK_OPTION_STRING, "-xscrollcommand", "xScrollCommand", "ScrollCommand",
NULL, -1, Tk_Offset(Treeview, tree.xscroll.scrollCmd),
TK_OPTION_NULL_OK, 0, SCROLLCMD_CHANGED},
{TK_OPTION_STRING, "-yscrollcommand", "yScrollCommand", "ScrollCommand",
NULL, -1, Tk_Offset(Treeview, tree.yscroll.scrollCmd),
TK_OPTION_NULL_OK, 0, SCROLLCMD_CHANGED},
WIDGET_TAKEFOCUS_TRUE,
WIDGET_INHERIT_OPTIONS(ttkCoreOptionSpecs)
};
/*------------------------------------------------------------------------
* +++ Utilities.
*/
typedef void (*HashEntryIterator)(void *hashValue);
static void foreachHashEntry(Tcl_HashTable *ht, HashEntryIterator func)
{
Tcl_HashSearch search;
Tcl_HashEntry *entryPtr = Tcl_FirstHashEntry(ht, &search);
while (entryPtr != NULL) {
func(Tcl_GetHashValue(entryPtr));
entryPtr = Tcl_NextHashEntry(&search);
}
}
/* + unshareObj(objPtr) --
* Ensure that a Tcl_Obj * has refcount 1 -- either return objPtr
* itself, or a duplicated copy.
*/
static Tcl_Obj *unshareObj(Tcl_Obj *objPtr)
{
if (Tcl_IsShared(objPtr)) {
Tcl_Obj *newObj = Tcl_DuplicateObj(objPtr);
Tcl_DecrRefCount(objPtr);
Tcl_IncrRefCount(newObj);
return newObj;
}
return objPtr;
}
/* DisplayLayout --
* Rebind, place, and draw a layout + object combination.
*/
static void DisplayLayout(
Ttk_Layout layout, void *recordPtr, Ttk_State state, Ttk_Box b, Drawable d)
{
Ttk_RebindSublayout(layout, recordPtr);
Ttk_PlaceLayout(layout, state, b);
Ttk_DrawLayout(layout, state, d);
}
/* + GetColumn --
* Look up column by name or number.
* Returns: pointer to column table entry, NULL if not found.
* Leaves an error message in interp->result on error.
*/
static TreeColumn *GetColumn(
Tcl_Interp *interp, Treeview *tv, Tcl_Obj *columnIDObj)
{
Tcl_HashEntry *entryPtr;
int columnIndex;
/* Check for named column:
*/
entryPtr = Tcl_FindHashEntry(
&tv->tree.columnNames, Tcl_GetString(columnIDObj));
if (entryPtr) {
return Tcl_GetHashValue(entryPtr);
}
/* Check for number:
*/
if (Tcl_GetIntFromObj(NULL, columnIDObj, &columnIndex) == TCL_OK) {
if (columnIndex < 0 || columnIndex >= tv->tree.nColumns) {
Tcl_ResetResult(interp);
Tcl_AppendResult(interp,
"Column index ",
Tcl_GetString(columnIDObj),
" out of bounds",
NULL);
return NULL;
}
return tv->tree.columns + columnIndex;
}
Tcl_ResetResult(interp);
Tcl_AppendResult(interp,
"Invalid column index ", Tcl_GetString(columnIDObj),
NULL);
return NULL;
}
/* + FindColumn --
* Look up column by name, number, or display index.
*/
static TreeColumn *FindColumn(
Tcl_Interp *interp, Treeview *tv, Tcl_Obj *columnIDObj)
{
int colno;
if (sscanf(Tcl_GetString(columnIDObj), "#%d", &colno) == 1)
{ /* Display column specification, #n */
if (colno >= 0 && colno < tv->tree.nDisplayColumns) {
return tv->tree.displayColumns[colno];
}
/* else */
Tcl_ResetResult(interp);
Tcl_AppendResult(interp,
"Column ", Tcl_GetString(columnIDObj), " out of range",
NULL);
return NULL;
}
return GetColumn(interp, tv, columnIDObj);
}
/* + FindItem --
* Locates the item with the specified identifier in the tree.
* If there is no such item, leaves an error message in interp.
*/
static TreeItem *FindItem(
Tcl_Interp *interp, Treeview *tv, Tcl_Obj *itemNameObj)
{
const char *itemName = Tcl_GetString(itemNameObj);
Tcl_HashEntry *entryPtr = Tcl_FindHashEntry(&tv->tree.items, itemName);
if (!entryPtr) {
Tcl_ResetResult(interp);
Tcl_AppendResult(interp, "Item ", itemName, " not found", NULL);
return 0;
}
return Tcl_GetHashValue(entryPtr);
}
/* + GetItemListFromObj --
* Parse a Tcl_Obj * as a list of items.
* Returns a NULL-terminated array of items; result must
* be ckfree()d. On error, returns NULL and leaves an error
* message in interp.
*/
static TreeItem **GetItemListFromObj(
Tcl_Interp *interp, Treeview *tv, Tcl_Obj *objPtr)
{
TreeItem **items;
Tcl_Obj **elements;
int i, nElements;
if (Tcl_ListObjGetElements(interp,objPtr,&nElements,&elements) != TCL_OK) {
return NULL;
}
items = (TreeItem**)ckalloc((nElements + 1)*sizeof(TreeItem*));
for (i = 0; i < nElements; ++i) {
items[i] = FindItem(interp, tv, elements[i]);
if (!items[i]) {
ckfree((ClientData)items);
return NULL;
}
}
items[i] = NULL;
return items;
}
/* + ItemName --
* Returns the item's ID.
*/
static const char *ItemName(Treeview *tv, TreeItem *item)
{
return Tcl_GetHashKey(&tv->tree.items, item->entryPtr);
}
/* + ItemID --
* Returns a fresh Tcl_Obj * (refcount 0) holding the
* item identifier of the specified item.
*/
static Tcl_Obj *ItemID(Treeview *tv, TreeItem *item)
{
return Tcl_NewStringObj(ItemName(tv, item), -1);
}
/*------------------------------------------------------------------------
* +++ Column configuration.
*/
/* + TreeviewFreeColumns --
* Free column data.
*/
static void TreeviewFreeColumns(Treeview *tv)
{
int i;
Tcl_DeleteHashTable(&tv->tree.columnNames);
Tcl_InitHashTable(&tv->tree.columnNames, TCL_STRING_KEYS);
if (tv->tree.columns) {
for (i = 0; i < tv->tree.nColumns; ++i)
FreeColumn(tv->tree.columns + i);
ckfree((ClientData)tv->tree.columns);
tv->tree.columns = 0;
}
}
/* + TreeviewInitColumns --
* Initialize column data when -columns changes.
* Returns: TCL_OK or TCL_ERROR;
*/
static int TreeviewInitColumns(Tcl_Interp *interp, Treeview *tv)
{
Tcl_Obj **columns;
int i, ncols;
if (Tcl_ListObjGetElements(
interp, tv->tree.columnsObj, &ncols, &columns) != TCL_OK)
{
return TCL_ERROR;
}
/*
* Free old values:
*/
TreeviewFreeColumns(tv);
/*
* Initialize columns array and columnNames hash table:
*/
tv->tree.nColumns = ncols;
tv->tree.columns =
(TreeColumn*)ckalloc(tv->tree.nColumns * sizeof(TreeColumn));
for (i = 0; i < ncols; ++i) {
int isNew;
Tcl_Obj *columnName = Tcl_DuplicateObj(columns[i]);
Tcl_HashEntry *entryPtr = Tcl_CreateHashEntry(
&tv->tree.columnNames, Tcl_GetString(columnName), &isNew);
Tcl_SetHashValue(entryPtr, tv->tree.columns + i);
InitColumn(tv->tree.columns + i);
Tk_InitOptions(
interp, (ClientData)(tv->tree.columns + i),
tv->tree.columnOptionTable, tv->core.tkwin);
Tk_InitOptions(
interp, (ClientData)(tv->tree.columns + i),
tv->tree.headingOptionTable, tv->core.tkwin);
Tcl_IncrRefCount(columnName);
tv->tree.columns[i].idObj = columnName;
}
return TCL_OK;
}
/* + TreeviewInitDisplayColumns --
* Initializes the 'displayColumns' array.
*
* Note that displayColumns[0] is always the tree column,
* even when SHOW_TREE is not set.
*
* @@@ TODO: disallow duplicated columns
*/
static int TreeviewInitDisplayColumns(Tcl_Interp *interp, Treeview *tv)
{
Tcl_Obj **dcolumns;
int index, ndcols;
TreeColumn **displayColumns = 0;
if (Tcl_ListObjGetElements(interp,
tv->tree.displayColumnsObj, &ndcols, &dcolumns) != TCL_OK) {
return TCL_ERROR;
}
if (!strcmp(Tcl_GetString(tv->tree.displayColumnsObj), "#all")) {
ndcols = tv->tree.nColumns;
displayColumns = (TreeColumn**)ckalloc((ndcols+1)*sizeof(TreeColumn*));
for (index = 0; index < ndcols; ++index) {
displayColumns[index+1] = tv->tree.columns + index;
}
} else {
displayColumns = (TreeColumn**)ckalloc((ndcols+1)*sizeof(TreeColumn*));
for (index = 0; index < ndcols; ++index) {
displayColumns[index+1] = GetColumn(interp, tv, dcolumns[index]);
if (!displayColumns[index+1]) {
ckfree((ClientData)displayColumns);
return TCL_ERROR;
}
}
}
displayColumns[0] = &tv->tree.column0;
if (tv->tree.displayColumns)
ckfree((ClientData)tv->tree.displayColumns);
tv->tree.displayColumns = displayColumns;
tv->tree.nDisplayColumns = ndcols + 1;
return TCL_OK;
}
/*------------------------------------------------------------------------
* +++ Resizing.
* slack invariant: TreeWidth(tree) + slack = treeArea.width
*/
#define FirstColumn(tv) ((tv->tree.showFlags&SHOW_TREE) ? 0 : 1)
/* + TreeWidth --
* Compute the requested tree width from the sum of visible column widths.
*/
static int TreeWidth(Treeview *tv)
{
int i = FirstColumn(tv);
int width = 0;
while (i < tv->tree.nDisplayColumns) {
width += tv->tree.displayColumns[i++]->width;
}
return width;
}
/* + RecomputeSlack --
*/
static void RecomputeSlack(Treeview *tv)
{
tv->tree.slack = tv->tree.treeArea.width - TreeWidth(tv);
}
/* + PickupSlack/DepositSlack --
* When resizing columns, distribute extra space to 'slack' first,
* and only adjust column widths if 'slack' goes to zero.
* That is, don't bother changing column widths if the tree
* is already scrolled or short.
*/
static int PickupSlack(Treeview *tv, int extra)
{
int newSlack = tv->tree.slack + extra;
if ( (newSlack < 0 && 0 <= tv->tree.slack)
|| (newSlack > 0 && 0 >= tv->tree.slack))
{
tv->tree.slack = 0;
return newSlack;
} else {
tv->tree.slack = newSlack;
return 0;
}
}
static void DepositSlack(Treeview *tv, int extra)
{
tv->tree.slack += extra;
}
/* + Stretch --
* Adjust width of column by N pixels, down to minimum width.
* Returns: #pixels actually moved.
*/
static int Stretch(TreeColumn *c, int n)
{
int newWidth = n + c->width;
if (newWidth < c->minWidth) {
n = c->minWidth - c->width;
c->width = c->minWidth;
} else {
c->width = newWidth;
}
return n;
}
/* + ShoveLeft --
* Adjust width of (stretchable) columns to the left by N pixels.
* Returns: leftover slack.
*/
static int ShoveLeft(Treeview *tv, int i, int n)
{
int first = FirstColumn(tv);
while (n != 0 && i >= first) {
TreeColumn *c = tv->tree.displayColumns[i];
if (c->stretch) {
n -= Stretch(c, n);
}
--i;
}
return n;
}
/* + ShoveRight --
* Adjust width of (stretchable) columns to the right by N pixels.
* Returns: leftover slack.
*/
static int ShoveRight(Treeview *tv, int i, int n)
{
while (n != 0 && i < tv->tree.nDisplayColumns) {
TreeColumn *c = tv->tree.displayColumns[i];
if (c->stretch) {
n -= Stretch(c, n);
}
++i;
}
return n;
}
/* + DistributeWidth --
* Distribute n pixels evenly across all stretchable display columns.
* Returns: leftover slack.
* Notes:
* The "((++w % m) < r)" term is there so that the remainder r = n % m
* is distributed round-robin.
*/
static int DistributeWidth(Treeview *tv, int n)
{
int w = TreeWidth(tv);
int m = 0;
int i, d, r;
for (i = FirstColumn(tv); i < tv->tree.nDisplayColumns; ++i) {
if (tv->tree.displayColumns[i]->stretch) {
++m;
}
}
if (m == 0) {
return n;
}
d = n / m;
r = n % m;
if (r < 0) { r += m; --d; }
for (i = FirstColumn(tv); i < tv->tree.nDisplayColumns; ++i) {
TreeColumn *c = tv->tree.displayColumns[i];
if (c->stretch) {
n -= Stretch(c, d + ((++w % m) < r));
}
}
return n;
}
/* + ResizeColumns --
* Recompute column widths based on available width.
* Pick up slack first;
* Distribute the remainder evenly across stretchable columns;
* If any is still left over due to minwidth constraints, shove left.
*/
static void ResizeColumns(Treeview *tv, int newWidth)
{
int delta = newWidth - (TreeWidth(tv) + tv->tree.slack);
DepositSlack(tv,
ShoveLeft(tv, tv->tree.nDisplayColumns - 1,
DistributeWidth(tv, PickupSlack(tv, delta))));
}
/* + DragColumn --
* Move the separator to the right of specified column,
* adjusting other column widths as necessary.
*/
static void DragColumn(Treeview *tv, int i, int delta)
{
TreeColumn *c = tv->tree.displayColumns[i];
int dl = delta - ShoveLeft(tv, i-1, delta - Stretch(c, delta));
int dr = ShoveRight(tv, i+1, PickupSlack(tv, -dl));
DepositSlack(tv, dr);
}
/*------------------------------------------------------------------------
* +++ Event handlers.
*/
static TreeItem *IdentifyItem(Treeview *tv, int y); /*forward*/
static const unsigned int TreeviewBindEventMask =
KeyPressMask|KeyReleaseMask
| ButtonPressMask|ButtonReleaseMask
| PointerMotionMask|ButtonMotionMask
| VirtualEventMask
;
static void TreeviewBindEventProc(void *clientData, XEvent *event)
{
Treeview *tv = clientData;
TreeItem *item = NULL;
Ttk_TagSet tagset;
/*
* Figure out where to deliver the event.
*/
switch (event->type)
{
case KeyPress:
case KeyRelease:
case VirtualEvent:
item = tv->tree.focus;
break;
case ButtonPress:
case ButtonRelease:
item = IdentifyItem(tv, event->xbutton.y);
break;
case MotionNotify:
item = IdentifyItem(tv, event->xmotion.y);
break;
default:
break;
}
if (!item) {
return;
}
/* ASSERT: Ttk_GetTagSetFromObj succeeds.
* NB: must use a local copy of the tagset,
* in case a binding script stomps on -tags.
*/
tagset = Ttk_GetTagSetFromObj(NULL, tv->tree.tagTable, item->tagsObj);
/*
* Fire binding:
*/
Tcl_Preserve(clientData);
Tk_BindEvent(tv->tree.bindingTable, event, tv->core.tkwin,
tagset->nTags, (void **)tagset->tags);
Tcl_Release(clientData);
Ttk_FreeTagSet(tagset);
}
/*------------------------------------------------------------------------
* +++ Initialization and cleanup.
*/
static void TreeviewInitialize(Tcl_Interp *interp, void *recordPtr)
{
Treeview *tv = recordPtr;
int unused;
tv->tree.itemOptionTable =
Tk_CreateOptionTable(interp, ItemOptionSpecs);
tv->tree.columnOptionTable =
Tk_CreateOptionTable(interp, ColumnOptionSpecs);
tv->tree.headingOptionTable =
Tk_CreateOptionTable(interp, HeadingOptionSpecs);
tv->tree.tagOptionTable =