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