0840b2a27843c55af853d7a577bf435f80683148
[cl-gtk2.git] / gtk / gtk.tree-model.lisp
1 (in-package :gtk)
2
3 (define-vtable ("GtkTreeModel" tree-model)
4   (:skip parent-instance g-type-interface)
5   ;;some signals
6   (:skip tree-model-row-changed :pointer)
7   (:skip tree-model-row-inserted :pointer)
8   (:skip tree-model-row-has-child-toggled :pointer)
9   (:skip tree-model-row-deleted :pointer)
10   (:skip tree-model-rows-reordered :pointer)
11   ;;methods
12   (get-flags (tree-model-flags (tree-model g-object)))
13   (get-n-columns (:int (tree-model g-object)))
14   (get-column-type (g-type-designator
15                     (tree-model g-object)
16                     (index :int)))
17   (get-iter (:boolean
18              (tree-model g-object)
19              (iter (g-boxed-foreign tree-iter))
20              (path (g-boxed-foreign tree-path))))
21   (get-path ((g-boxed-foreign tree-path :return)
22              (tree-model g-object)
23              (iter (g-boxed-foreign tree-iter))))
24   (get-value (:void
25               (tree-model g-object)
26               (iter (g-boxed-foreign tree-iter))
27               (n :int)
28               (value (:pointer g-value)))
29              :impl-call
30              ((tree-model iter n)
31               (multiple-value-bind (v type) (tree-model-get-value-impl tree-model iter n)
32                 (set-g-value value v type))))
33   (iter-next (:boolean
34               (tree-model g-object)
35               (iter (g-boxed-foreign tree-iter))))
36   (iter-children (:boolean
37                   (tree-model g-object)
38                   (iter (g-boxed-foreign tree-iter))
39                   (parent (g-boxed-foreign tree-iter))))
40   (iter-has-child (:boolean
41                    (tree-model g-object)
42                    (iter (g-boxed-foreign tree-iter))))
43   (iter-n-children (:int
44                     (tree-model g-object)
45                     (iter (g-boxed-foreign tree-iter))))
46   (iter-nth-child (:boolean
47                    (tree-model g-object)
48                    (iter (g-boxed-foreign tree-iter))
49                    (parent (g-boxed-foreign tree-iter))
50                    (n :int)))
51   (iter-parent (:boolean
52                 (tree-model g-object)
53                 (iter (g-boxed-foreign tree-iter))
54                 (child (g-boxed-foreign tree-iter))))
55   (ref-node (:void
56              (tree-model g-object)
57              (iter (g-boxed-foreign tree-iter))))
58   (unref-node (:void
59                (tree-model g-object)
60                (iter (g-boxed-foreign tree-iter)))))
61
62 (define-vtable ("GtkTreeSortable" tree-sortable)
63   (:skip parent-instance g-type-interface)
64   ;; signal
65   (:skip sort-columns-changed :pointer)
66   ;; methods
67   (get-sort-column-id
68    (:boolean (sortable (g-object tree-sortable))
69              (sort-column-id (:pointer :int))
70              (order (:pointer sort-type)))
71    :impl-call ((sortable)
72                (multiple-value-bind (sorted-p r-sort-column-id r-order) (tree-sortable-get-sort-column-id-impl sortable)
73                  (unless (null-pointer-p sort-column-id)
74                    (setf (mem-ref sort-column-id :int) r-sort-column-id))
75                  (unless (null-pointer-p order)
76                    (setf (mem-ref order 'sort-type) r-order))
77                  sorted-p)))
78   (set-sort-column-id (:void (sortable (g-object tree-sortable)) (sort-column-id :int) (order sort-type)))
79   (set-sort-func (:void (sortable (g-object tree-sortable)) (sort-column-id :int) (func :pointer) (data :pointer) (destroy-notify :pointer)))
80   (set-default-sort-func (:void (sortable (g-object tree-sortable)) (func :pointer) (data :pointer) (destroy-notify :pointer)))
81   (has-default-sort-func (:boolean (sortable (g-object tree-sortable)))))
82
83 ; TODO: GtkTreeModelSort
84
85 ; TODO: GtkTreeModelFilter
86
87 (defclass array-list-store (tree-model)
88   ((items :initform (make-array 0 :adjustable t :fill-pointer t) :reader store-items)
89    (columns-getters :initform (make-array 0 :adjustable t :fill-pointer t) :reader store-getters)
90    (columns-types :initform (make-array 0 :adjustable t :fill-pointer t) :reader store-types))
91   (:metaclass gobject-class)
92   (:g-type-name . "LispArrayListStore"))
93
94 (export 'array-list-store)
95
96 (register-object-type-implementation "LispArrayListStore" array-list-store "GObject" ("GtkTreeModel") nil)
97
98 (defun store-items-count (store)
99   (length (store-items store)))
100
101 (export 'store-items-count)
102
103 (defun store-item (store index)
104   (aref (store-items store) index))
105
106 (export 'store-item)
107
108 (defun store-add-item (store item)
109   (vector-push-extend item (store-items store))
110   (let* ((path (make-instance 'tree-path))
111          (iter (make-tree-iter)))
112     (setf (tree-path-indices path) (list (1- (length (store-items store)))))
113     (setf (tree-iter-stamp iter) 0 (tree-iter-user-data iter) (1- (length (store-items store))))
114     (emit-signal store "row-inserted" path iter)))
115
116 (export 'store-add-item)
117
118 (defun store-remove-item (store item &key (test 'eq))
119   (with-slots (items) store
120     (let ((index (position item items :test test)))
121       (unless index (error "No such item~%~A~%in list-store~%~A" item store))
122       (setf items (delete item items :test test))
123       (let ((path (make-instance 'tree-path)))
124         (setf (tree-path-indices path) (list index))
125         (emit-signal store "row-deleted" path)))))
126
127 (export 'store-remove-item)
128
129 (defun store-add-column (store type getter)
130   (vector-push-extend type (store-types store))
131   (vector-push-extend getter (store-getters store))
132   (1- (length (store-types store))))
133
134 (export 'store-add-column)
135
136 (defmethod tree-model-get-flags-impl ((model array-list-store))
137   '(:list-only))
138
139 (defmethod tree-model-get-n-columns-impl ((model array-list-store))
140   (length (store-types model)))
141
142 (defmethod tree-model-get-column-type-impl ((tree-model array-list-store) index)
143   (aref (store-types tree-model) index))
144
145 (defmethod tree-model-get-iter-impl ((model array-list-store) iter path)
146   (let ((indices (tree-path-indices path)))
147     (when (and (= 1 (length indices))
148                (< (first indices) (length (store-items model))))
149       (setf (tree-iter-stamp iter) 0 (tree-iter-user-data iter) (first indices))
150       t)))
151
152 (defmethod tree-model-ref-node-impl ((model array-list-store) iter)
153   (declare (ignorable model iter)))
154 (defmethod tree-model-unref-node-impl ((model array-list-store) iter)
155   (declare (ignorable model iter)))
156
157 (defmethod tree-model-iter-next-impl ((model array-list-store) iter)
158   (let ((n (tree-iter-user-data iter)))
159     (when (< n (1- (length (store-items model))))
160       (setf (tree-iter-user-data iter) (1+ n))
161       t)))
162
163 (defmethod tree-model-iter-nth-child-impl ((model array-list-store) iter parent n)
164   (declare (ignorable parent))
165   (setf (tree-iter-stamp iter) 0
166         (tree-iter-user-data iter) n)
167   t)
168
169 (defmethod tree-model-iter-n-children-impl ((model array-list-store) iter)
170   (if (null iter)
171       (length (store-items model))
172       0))
173
174 (defmethod tree-model-get-path-impl ((model array-list-store) iter)
175   (let ((path (make-instance 'tree-path)))
176     (setf (tree-path-indices path) (list (tree-iter-user-data iter)))
177     path))
178
179 (defmethod tree-model-iter-has-child-impl ((model array-list-store) iter)
180   (declare (ignorable iter))
181   nil)
182
183 (defgeneric tree-model-item (model iter-or-path))
184
185 (defmethod tree-model-item ((model array-list-store) (iter tree-iter))
186   (let ((n-row (tree-iter-user-data iter)))
187     (aref (store-items model) n-row)))
188
189 (defmethod tree-model-item ((model array-list-store) (path tree-path))
190   (let ((n-row (first (tree-path-indices path))))
191     (aref (store-items model) n-row)))
192
193 (export 'tree-model-item)
194
195 (defmethod tree-model-get-value-impl ((model array-list-store) iter n)
196   (let ((n-row (tree-iter-user-data iter)))
197     (values (funcall (aref (store-getters model) n) 
198                      (aref (store-items model) n-row))
199             (aref (store-types model) n))))
200
201 (defcfun (tree-model-flags "gtk_tree_model_get_flags") tree-model-flags
202   (tree-model g-object))
203
204 (export 'tree-model-flags)
205
206 (defcfun (tree-model-n-columns "gtk_tree_model_get_n_columns") :int
207   (tree-model g-object))
208
209 (export 'tree-model-flags)
210
211 (defcfun (tree-model-column-type "gtk_tree_model_get_column_type") g-type-designator
212   (tree-model g-object)
213   (index :int))
214
215 (export 'tree-model-column-type)
216
217 (defcfun (tree-model-set-iter-to-path "gtk_tree_model_get_iter") :boolean
218   (tree-model g-object)
219   (iter (g-boxed-foreign tree-iter))
220   (path (g-boxed-foreign tree-path)))
221
222 (defun tree-model-iter-by-path (tree-model tree-path)
223   (let ((iter (make-tree-iter)))
224     (if (tree-model-set-iter-to-path tree-model iter tree-path)
225         iter
226         nil)))
227
228 (export 'tree-model-iter-by-path)
229
230 (defcfun (tree-model-set-iter-from-string "gtk_tree_model_get_iter_from_string") :boolean
231   (tree-model g-object)
232   (iter (g-boxed-foreign tree-iter))
233   (path-string :string))
234
235 (defun tree-model-iter-from-string (tree-model path-string)
236   (let ((iter (make-tree-iter)))
237     (if (tree-model-set-iter-from-string tree-model iter path-string)
238         iter
239         nil)))
240
241 (export 'tree-model-iter-from-string)
242
243 (defcfun (tree-model-set-iter-to-first "gtk_tree_model_get_iter_first") :boolean
244   (model g-object)
245   (iter (g-boxed-foreign tree-iter)))
246
247 (defun tree-model-iter-first (tree-model)
248   (let ((iter (make-tree-iter)))
249     (if (tree-model-set-iter-to-first tree-model iter)
250         iter
251         nil)))
252
253 (export 'tree-model-iter-first)
254
255 (defcfun (tree-model-path "gtk_tree_model_get_path") (g-boxed-foreign tree-path :return)
256   (tree-model g-object)
257   (iter (g-boxed-foreign tree-iter)))
258
259 (export 'tree-model-path)
260
261 (defcfun gtk-tree-model-get-value :void
262   (model g-object)
263   (iter (g-boxed-foreign tree-iter))
264   (column :int)
265   (value (:pointer g-value)))
266
267 (defun tree-model-value (tree-model iter column)
268   (with-foreign-object (v 'g-value)
269     (g-value-zero v)
270     (gtk-tree-model-get-value tree-model iter column v)
271     (prog1 (parse-g-value v)
272       (g-value-unset v))))
273
274 (export 'tree-model-value)
275
276 (defcfun (tree-model-iter-next "gtk_tree_model_iter_next") :boolean
277   (tree-model g-object)
278   (iter (g-boxed-foreign tree-iter)))
279
280 (export 'tree-model-iter-next)
281
282 (defcfun gtk-tree-model-iter-children :boolean
283   (tree-model g-object)
284   (iter (g-boxed-foreign tree-iter))
285   (parent (g-boxed-foreign tree-iter)))
286
287 (defun tree-model-iter-first-child (tree-model parent)
288   (let ((iter (make-tree-iter)))
289     (if (gtk-tree-model-iter-children tree-model iter parent)
290         iter
291         nil)))
292
293 (export 'tree-model-iter-first-child)
294
295 (defcfun (tree-model-iter-has-child "gtk_tree_model_iter_has_child") :boolean
296   (tree-model g-object)
297   (iter (g-boxed-foreign tree-iter)))
298
299 (export 'tree-model-iter-has-child)
300
301 (defcfun (tree-model-iter-n-children "gtk_tree_model_iter_n_children") :int
302   (tree-model g-object)
303   (iter (g-boxed-foreign tree-iter)))
304
305 (export 'tree-model-iter-n-children)
306
307 (defcfun gtk-tree-model-iter-nth-child :boolean
308   (tree-model g-object)
309   (iter (g-boxed-foreign tree-iter))
310   (parent (g-boxed-foreign tree-iter))
311   (n :int))
312
313 (defun tree-model-iter-nth-child (tree-model parent n)
314   (let ((iter (make-tree-iter)))
315     (if (gtk-tree-model-iter-nth-child tree-model iter parent n)
316         iter
317         n)))
318
319 (export 'tree-model-iter-nth-child)
320
321 (defcfun gtk-tree-model-iter-parent :boolean
322   (tree-model g-object)
323   (iter (g-boxed-foreign tree-iter))
324   (parent (g-boxed-foreign tree-iter)))
325
326 (defun tree-model-iter-parent (tree-model iter)
327   (let ((parent (make-tree-iter)))
328     (if (gtk-tree-model-iter-parent tree-model iter parent)
329         parent
330         nil)))
331
332 (export 'tree-model-iter-parent)
333
334 (defcfun (tree-model-iter-to-string "gtk_tree_model_get_string_from_iter") (g-string :free-from-foreign t)
335   (tree-model g-object)
336   (iter (g-boxed-foreign tree-iter)))
337
338 (export 'tree-model-iter-to-string)
339
340 (defcfun (tree-model-ref-node "gtk_tree_model_ref_node") :void
341   (tree-model g-object)
342   (iter (g-boxed-foreign tree-iter)))
343
344 (export 'tree-model-ref-node)
345
346 (defcfun (tree-model-unref-node "gtk_tree_model_unref_node") :void
347   (tree-model g-object)
348   (iter (g-boxed-foreign tree-iter)))
349
350 (export 'tree-model-unref-node)
351
352 (defcallback gtk-tree-model-foreach-cb :boolean ((model g-object) (path (g-boxed-foreign tree-path)) (iter (g-boxed-foreign tree-iter)) (data :pointer))
353   (let ((fn (get-stable-pointer-value data)))
354     (restart-case
355         (funcall fn model path iter)
356       (stop-tree-model-iteration () t)
357       (skip-tree-model-current () nil))))
358
359 (defcfun gtk-tree-model-foreach :void
360   (model g-object)
361   (func :pointer)
362   (data :pointer))
363
364 (defun do-tree-model (model fn)
365   (with-stable-pointer (ptr fn)
366     (gtk-tree-model-foreach model (callback gtk-tree-model-foreach-cb) ptr)))
367
368 (export 'do-tree-model)
369
370 (defun array-insert-at (array element index)
371   (assert (adjustable-array-p array))
372   (adjust-array array (1+ (length array)) :fill-pointer t)
373   (iter (for i from (1- (length array)) above index)
374         (setf (aref array i)
375               (aref array (1- i))))
376   (setf (aref array index) element)
377   array)
378
379 (defun array-remove-at (array index)
380   (assert (adjustable-array-p array))
381   (iter (for i from index below (1- (length array)))
382         (setf (aref array i)
383               (aref array (1+ i))))
384   (adjust-array array (1- (length array)) :fill-pointer t)
385   array)
386
387 (defstruct tree-node
388   (tree nil)
389   (parent nil)
390   (id nil)
391   (item nil)
392   (children (make-array 0 :element-type 'tree-node :adjustable t :fill-pointer t)))
393
394 (defclass tree-lisp-store (tree-model)
395   ((columns-getters :initform (make-array 0 :adjustable t :fill-pointer t) :reader tree-lisp-store-getters)
396    (columns-types :initform (make-array 0 :adjustable t :fill-pointer t) :reader tree-lisp-store-types)
397    (root :initform (make-tree-node) :reader tree-lisp-store-root)
398    (id-map :initform (make-hash-table) :reader tree-lisp-store-id-map)
399    (next-id-value :initform 0 :accessor tree-lisp-store-next-id-value))
400   (:metaclass gobject-class)
401   (:g-type-name . "LispTreeStore"))
402
403 (defmethod initialize-instance :after ((object tree-lisp-store) &key &allow-other-keys)
404   (setf (tree-node-tree (tree-lisp-store-root object)) object))
405
406 (register-object-type-implementation "LispTreeStore" tree-lisp-store "GObject" ("GtkTreeModel") nil)
407
408 (defun map-subtree (node fn)
409   (funcall fn node)
410   (iter (for child in-vector (tree-node-children node))
411         (map-subtree child fn)))
412
413 (defun clear-id (node)
414   (map-subtree node
415                (lambda (n)
416                  (when (and (tree-node-id n)
417                             (tree-node-tree n))
418                    (remhash (tree-node-id n)
419                             (tree-lisp-store-id-map (tree-node-tree n))))
420                  (setf (tree-node-id n) nil))))
421
422 (defun set-node-tree (node tree)
423   (map-subtree node
424                (lambda (n)
425                  (setf (tree-node-tree n) tree))))
426
427 (defun tree-node-insert-at (node child index)
428   (assert (null (tree-node-parent child)))
429   (clear-id child)
430   (setf (tree-node-parent child) node)
431   (set-node-tree child (tree-node-tree node))
432   (array-insert-at (tree-node-children node) child index)
433   (notice-tree-node-insertion (tree-node-tree node) node child index)
434   node)
435
436 (defun tree-node-child-at (node index)
437   (aref (tree-node-children node) index))
438
439 (defun tree-node-remove-at (node index)
440   (assert (<= 0 index (1- (length (tree-node-children node)))))
441   (let ((child (tree-node-child-at node index)))
442     (clear-id child)
443     (setf (tree-node-parent child) nil)
444     (set-node-tree child nil)
445     (array-remove-at (tree-node-children node) index)
446     (notice-tree-node-removal (tree-node-tree node) node child index)))
447
448 (defun tree-lisp-store-add-column (store column-type column-getter)
449   (vector-push-extend column-getter (tree-lisp-store-getters store))
450   (vector-push-extend column-type (tree-lisp-store-types store)))
451
452 (defmethod tree-model-get-flags-impl ((store tree-lisp-store))
453   nil)
454
455 (defmethod tree-model-get-n-columns-impl ((store tree-lisp-store))
456   (length (tree-lisp-store-getters store)))
457
458 (defmethod tree-model-get-column-type-impl ((store tree-lisp-store) index)
459   (aref (tree-lisp-store-types store) index))
460
461 (defun get-node-by-indices (root indices)
462   (if indices
463       (get-node-by-indices (tree-node-child-at root (first indices)) (rest indices))
464       root))
465
466 (defun get-node-by-path (tree path)
467   (let ((indices (tree-path-indices path)))
468     (get-node-by-indices (tree-lisp-store-root tree) indices)))
469
470 (defun get-node-path (node)
471   (iter (with z = nil)
472         (for parent = (tree-node-parent node))
473         (while parent)
474         (for index = (position node (tree-node-children parent)))
475         (push index z)
476         (setf node parent)
477         (finally (return z))))
478
479 (defun tree-lisp-store-get-next-id (tree)
480   (incf (tree-lisp-store-next-id-value tree)))
481
482 (defun tree-lisp-store-add-id-map (tree id node)
483   (setf (gethash id (tree-lisp-store-id-map tree)) node))
484
485 (defun get-assigned-id (tree node)
486   (or (tree-node-id node)
487       (let ((id (tree-lisp-store-get-next-id tree)))
488         (tree-lisp-store-add-id-map tree id node)
489         (setf (tree-node-id node) id)
490         id)))
491
492 (defun get-node-by-id (tree id)
493   (gethash id (tree-lisp-store-id-map tree)))
494
495 (defmethod tree-model-get-iter-impl ((store tree-lisp-store) iter path)
496   (let* ((node (get-node-by-path store path))
497          (node-idx (get-assigned-id store node)))
498     (setf (tree-iter-stamp iter) 0
499           (tree-iter-user-data iter) node-idx)))
500
501 (defun get-node-by-iter (tree iter)
502   (get-node-by-id tree (tree-iter-user-data iter)))
503
504 (defmethod tree-model-get-path-impl ((store tree-lisp-store) iter)
505   (let* ((path (make-instance 'tree-path))
506          (node (get-node-by-iter store iter))
507          (indices (get-node-path node)))
508     (setf (tree-path-indices path) indices)
509     path))
510
511 (defmethod tree-model-get-value-impl ((store tree-lisp-store) iter n)
512   (let* ((node (get-node-by-iter store iter))
513          (getter (aref (tree-lisp-store-getters store) n))
514          (type (aref (tree-lisp-store-types store) n)))
515     (values (funcall getter (tree-node-item node))
516             type)))
517
518 (defmethod tree-model-iter-next-impl ((store tree-lisp-store) iter)
519   (let* ((node (get-node-by-iter store iter))
520          (parent (tree-node-parent node))
521          (index (position node (tree-node-children parent))))
522     (when (< (1+ index) (length (tree-node-children parent)))
523       (setf (tree-iter-stamp iter)
524             0
525             (tree-iter-user-data iter)
526             (get-assigned-id store (tree-node-child-at parent (1+ index))))
527       t)))
528
529 (defmethod tree-model-iter-children-impl ((store tree-lisp-store) iter parent)
530   (let* ((node (if parent
531                    (get-node-by-iter store parent)
532                    (tree-lisp-store-root store))))
533     (when (plusp (length (tree-node-children node)))
534       (setf (tree-iter-stamp iter)
535             0
536             (tree-iter-user-data iter)
537             (get-assigned-id store (tree-node-child-at node 0)))
538       t)))
539
540 (defmethod tree-model-iter-has-child-impl ((store tree-lisp-store) iter)
541   (let ((node (get-node-by-iter store iter)))
542     (plusp (length (tree-node-children node)))))
543
544 (defmethod tree-model-iter-n-children-impl ((store tree-lisp-store) iter)
545   (let* ((node (if iter
546                    (get-node-by-iter store iter)
547                    (tree-lisp-store-root store))))
548     (length (tree-node-children node))))
549
550 (defmethod tree-model-iter-nth-child-impl ((store tree-lisp-store) iter parent n)
551   (let* ((node (if parent
552                    (get-node-by-iter store parent)
553                    (tree-lisp-store-root store)))
554          (requested-node (tree-node-child-at node n)))
555     (setf (tree-iter-stamp iter) 0
556           (tree-iter-user-data iter) (get-assigned-id store requested-node))
557     t))
558
559 (defmethod tree-model-iter-parent-impl ((store tree-lisp-store) iter child)
560   (let ((node (get-node-by-iter store child)))
561     (when (tree-node-parent node)
562       (setf (tree-iter-stamp iter) 0
563             (tree-iter-user-data iter) (get-assigned-id store (tree-node-parent node))))))
564
565 (defmethod tree-model-ref-node-impl ((store tree-lisp-store) iter)
566   (declare (ignorable iter)))
567
568 (defmethod tree-model-unref-node-impl ((store tree-lisp-store) iter)
569   (declare (ignorable iter)))
570
571 (defun notice-tree-node-insertion (tree node child index)
572   (declare (ignore node index))
573   (when tree
574     (let* ((path (make-instance 'tree-path))
575            (iter (make-tree-iter)))
576       (setf (tree-path-indices path) (get-node-path child)
577             (tree-iter-stamp iter) 0
578             (tree-iter-user-data iter) (get-assigned-id tree child))
579       (emit-signal tree "row-inserted" path iter)
580       (when (plusp (length (tree-node-children child)))
581         (emit-signal tree "row-has-child-toggled" path iter)))))
582
583 (defun notice-tree-node-removal (tree node child index)
584   (declare (ignore child))
585   (when tree
586     (let ((path (make-instance 'tree-path)))
587       (setf (tree-path-indices path) (nconc (get-node-path node) (list index)))
588       (emit-signal tree "row-deleted" path))
589     (when (zerop (length (tree-node-children node)))
590       (let* ((path (make-instance 'tree-path))
591              (iter (make-tree-iter)))
592         (setf (tree-path-indices path) (get-node-path node)
593               (tree-iter-stamp iter) 0
594               (tree-iter-user-data iter) (get-assigned-id tree node))
595         (emit-signal tree "row-has-child-toggled" path iter)))))