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