gtk/gtk.tree-model.lisp

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