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