tree-widget.el 30.5 KB
Newer Older
David Ponce's avatar
David Ponce committed
1 2
;;; tree-widget.el --- Tree widget

3
;; Copyright (C) 2004, 2005 Free Software Foundation, Inc.
David Ponce's avatar
David Ponce committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; Author: David Ponce <david@dponce.com>
;; Maintainer: David Ponce <david@dponce.com>
;; Created: 16 Feb 2001
;; Keywords: extensions

;; This file is part of GNU Emacs

;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2, or (at
;; your option) any later version.

;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
David Ponce's avatar
David Ponce committed
26 27 28 29 30 31 32 33

;;; Commentary:
;;
;; This library provide a tree widget useful to display data
;; structures organized in a hierarchical order.
;;
;; The following properties are specific to the tree widget:
;;
34 35 36
;; :open
;;    Set to non-nil to expand the tree.  By default the tree is
;;    collapsed.
David Ponce's avatar
David Ponce committed
37
;;
38 39 40 41 42
;; :node
;;    Specify the widget used to represent the value of a tree node.
;;    By default this is an `item' widget which displays the
;;    tree-widget :tag property value if defined, or a string
;;    representation of the tree-widget value.
David Ponce's avatar
David Ponce committed
43
;;
44 45 46 47
;; :keep
;;    Specify a list of properties to keep when the tree is collapsed
;;    so they can be recovered when the tree is expanded.  This
;;    property can be used in child widgets too.
David Ponce's avatar
David Ponce committed
48
;;
49 50 51 52 53
;; :expander (obsoletes :dynargs)
;;    Specify a function to be called to dynamically provide the
;;    tree's children in response to an expand request.  This function
;;    will be passed the tree widget and must return a list of child
;;    widgets.
David Ponce's avatar
David Ponce committed
54
;;
55 56 57 58 59 60
;;    *Please note:* Child widgets returned by the :expander function
;;    are stored in the :args property of the tree widget.  To speed
;;    up successive expand requests, the :expander function is not
;;    called again when the :args value is non-nil.  To refresh child
;;    values, it is necessary to set the :args property to nil, then
;;    redraw the tree.
David Ponce's avatar
David Ponce committed
61
;;
David Ponce's avatar
David Ponce committed
62 63 64 65 66 67 68 69 70 71 72 73 74
;; :open-icon  (default `tree-widget-open-icon')
;; :close-icon (default `tree-widget-close-icon')
;; :empty-icon (default `tree-widget-empty-icon')
;; :leaf-icon  (default `tree-widget-leaf-icon')
;;    Those properties define the icon widgets associated to tree
;;    nodes.  Icon widgets must derive from the `tree-widget-icon'
;;    widget.  The :tag and :glyph-name property values are
;;    respectively used when drawing the text and graphic
;;    representation of the tree.  The :tag value must be a string
;;    that represent a node icon, like "[+]" for example.  The
;;    :glyph-name value must the name of an image found in the current
;;    theme, like "close" for example (see also the variable
;;    `tree-widget-theme').
David Ponce's avatar
David Ponce committed
75
;;
David Ponce's avatar
David Ponce committed
76 77 78 79 80 81 82 83 84 85 86
;; :guide      (default `tree-widget-guide')
;; :end-guide  (default `tree-widget-end-guide')
;; :no-guide   (default `tree-widget-no-guide')
;; :handle     (default `tree-widget-handle')
;; :no-handle  (default `tree-widget-no-handle')
;;    Those properties define `item'-like widgets used to draw the
;;    tree guide lines.  The :tag property value is used when drawing
;;    the text representation of the tree.  The graphic look and feel
;;    is given by the images named "guide", "no-guide", "end-guide",
;;    "handle", and "no-handle" found in the current theme (see also
;;    the variable `tree-widget-theme').
David Ponce's avatar
David Ponce committed
87
;;
David Ponce's avatar
David Ponce committed
88
;; These are the default :tag values for icons, and guide lines:
David Ponce's avatar
David Ponce committed
89
;;
David Ponce's avatar
David Ponce committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
;; open-icon    "[-]"
;; close-icon   "[+]"
;; empty-icon   "[X]"
;; leaf-icon    ""
;; guide        " |"
;; no-guide     "  "
;; end-guide    " `"
;; handle       "-"
;; no-handle    " "
;;
;; The text representation of a tree looks like this:
;;
;; [-] 1        (open-icon :node)
;;  |-[+] 1.0   (guide+handle+close-icon :node)
;;  |-[X] 1.1   (guide+handle+empty-icon :node)
;;  `-[-] 1.2   (end-guide+handle+open-icon :node)
;;     |- 1.2.1 (no-guide+no-handle+guide+handle+leaf-icon leaf)
;;     `- 1.2.2 (no-guide+no-handle+end-guide+handle+leaf-icon leaf)
David Ponce's avatar
David Ponce committed
108
;;
109 110 111 112
;; By default, images will be used instead of strings to draw a
;; nice-looking tree.  See the `tree-widget-image-enable',
;; `tree-widget-themes-directory', and `tree-widget-theme' options for
;; more details.
David Ponce's avatar
David Ponce committed
113 114 115 116 117 118 119 120 121 122 123

;;; History:
;;

;;; Code:
(eval-when-compile (require 'cl))
(require 'wid-edit)

;;; Customization
;;
(defgroup tree-widget nil
124
  "Customization support for the Tree Widget library."
125
  :version "22.1"
David Ponce's avatar
David Ponce committed
126 127 128 129
  :group 'widgets)

(defcustom tree-widget-image-enable
  (not (or (featurep 'xemacs) (< emacs-major-version 21)))
130
  "*Non-nil means that tree-widget will try to use images."
David Ponce's avatar
David Ponce committed
131 132 133
  :type  'boolean
  :group 'tree-widget)

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
(defvar tree-widget-themes-load-path
  '(load-path
    (let ((dir (if (fboundp 'locate-data-directory)
                   (locate-data-directory "tree-widget") ;; XEmacs
                 data-directory)))
      (and dir (list dir (expand-file-name "images" dir))))
    )
  "List of locations where to search for the themes sub-directory.
Each element is an expression that will be evaluated to return a
single directory or a list of directories to search.

The default is to search in the `load-path' first, then in the
\"images\" sub directory in the data directory, then in the data
directory.
The data directory is the value of the variable `data-directory' on
Emacs, and what `(locate-data-directory \"tree-widget\")' returns on
XEmacs.")

David Ponce's avatar
David Ponce committed
152
(defcustom tree-widget-themes-directory "tree-widget"
153
  "*Name of the directory where to look up for image themes.
David Ponce's avatar
David Ponce committed
154
When nil use the directory where the tree-widget library is located.
155
When a relative name is specified, try to locate that sub directory in
156
the locations specified in `tree-widget-themes-load-path'.
157
The default is to use the \"tree-widget\" relative name."
David Ponce's avatar
David Ponce committed
158 159 160 161 162 163
  :type '(choice (const :tag "Default" "tree-widget")
                 (const :tag "With the library" nil)
                 (directory :format "%{%t%}:\n%v"))
  :group 'tree-widget)

(defcustom tree-widget-theme nil
164 165
  "*Name of the theme where to look up for images.
It must be a sub directory of the directory specified in variable
David Ponce's avatar
David Ponce committed
166 167 168 169 170 171
`tree-widget-themes-directory'.  The default theme is \"default\".
When an image is not found in a theme, it is searched in the default
theme.

A complete theme must at least contain images with these file names
with a supported extension (see also `tree-widget-image-formats'):
172 173 174 175 176 177 178 179

\"guide\"
  A vertical guide line.
\"no-guide\"
  An invisible vertical guide line.
\"end-guide\"
  End of a vertical guide line.
\"handle\"
David Ponce's avatar
David Ponce committed
180
  Horizontal guide line that joins the vertical guide line to an icon.
181
\"no-handle\"
David Ponce's avatar
David Ponce committed
182 183 184 185 186 187 188 189 190 191 192 193 194
  An invisible handle.

Plus images whose name is given by the :glyph-name property of the
icon widgets used to draw the tree.  By default these images are used:

\"open\"
  Icon associated to an expanded tree.
\"close\"
  Icon associated to a collapsed tree.
\"empty\"
  Icon associated to an expanded tree with no child.
\"leaf\"
  Icon associated to a leaf node."
David Ponce's avatar
David Ponce committed
195 196 197 198 199 200
  :type '(choice (const  :tag "Default" nil)
                 (string :tag "Name"))
  :group 'tree-widget)

(defcustom tree-widget-image-properties-emacs
  '(:ascent center :mask (heuristic t))
201
  "*Default properties of Emacs images."
David Ponce's avatar
David Ponce committed
202 203 204 205 206
  :type 'plist
  :group 'tree-widget)

(defcustom tree-widget-image-properties-xemacs
  nil
207
  "*Default properties of XEmacs images."
David Ponce's avatar
David Ponce committed
208 209
  :type 'plist
  :group 'tree-widget)
David Ponce's avatar
David Ponce committed
210 211 212 213 214 215

(defcustom tree-widget-space-width 0.5
  "Amount of space between an icon image and a node widget.
Must be a valid space :width display property."
  :group 'tree-widget
  :type 'sexp)
David Ponce's avatar
David Ponce committed
216 217 218

;;; Image support
;;
219
(eval-and-compile ;; Emacs/XEmacs compatibility stuff
David Ponce's avatar
David Ponce committed
220 221 222 223 224 225 226 227 228
  (cond
   ;; XEmacs
   ((featurep 'xemacs)
    (defsubst tree-widget-use-image-p ()
      "Return non-nil if image support is currently enabled."
      (and tree-widget-image-enable
           widget-glyph-enable
           (console-on-window-system-p)))
    (defsubst tree-widget-create-image (type file &optional props)
229 230
      "Create an image of type TYPE from FILE, and return it.
Give the image the specified properties PROPS."
David Ponce's avatar
David Ponce committed
231 232
      (apply 'make-glyph `([,type :file ,file ,@props])))
    (defsubst tree-widget-image-formats ()
233
      "Return the alist of image formats/file name extensions.
David Ponce's avatar
David Ponce committed
234 235 236 237 238 239 240
See also the option `widget-image-file-name-suffixes'."
      (delq nil
            (mapcar
             #'(lambda (fmt)
                 (and (valid-image-instantiator-format-p (car fmt)) fmt))
             widget-image-file-name-suffixes)))
    )
241
   ;; Emacs
David Ponce's avatar
David Ponce committed
242 243 244 245 246 247 248
   (t
    (defsubst tree-widget-use-image-p ()
      "Return non-nil if image support is currently enabled."
      (and tree-widget-image-enable
           widget-image-enable
           (display-images-p)))
    (defsubst tree-widget-create-image (type file &optional props)
249 250
      "Create an image of type TYPE from FILE, and return it.
Give the image the specified properties PROPS."
David Ponce's avatar
David Ponce committed
251 252
      (apply 'create-image `(,file ,type nil ,@props)))
    (defsubst tree-widget-image-formats ()
253
      "Return the alist of image formats/file name extensions.
254
See also the option `widget-image-conversion'."
David Ponce's avatar
David Ponce committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
      (delq nil
            (mapcar
             #'(lambda (fmt)
                 (and (image-type-available-p (car fmt)) fmt))
             widget-image-conversion)))
    ))
  )

;; Buffer local cache of theme data.
(defvar tree-widget--theme nil)

(defsubst tree-widget-theme-name ()
  "Return the current theme name, or nil if no theme is active."
  (and tree-widget--theme (aref tree-widget--theme 0)))

(defsubst tree-widget-set-theme (&optional name)
  "In the current buffer, set the theme to use for images.
272 273
The current buffer must be where the tree widget is drawn.
Optional argument NAME is the name of the theme to use.  It defaults
David Ponce's avatar
David Ponce committed
274
to the value of the variable `tree-widget-theme'.
275
Does nothing if NAME is already the current theme."
David Ponce's avatar
David Ponce committed
276
  (or name (setq name (or tree-widget-theme "default")))
277
  (unless (string-equal name (tree-widget-theme-name))
David Ponce's avatar
David Ponce committed
278 279 280 281
    (set (make-local-variable 'tree-widget--theme)
         (make-vector 4 nil))
    (aset tree-widget--theme 0 name)))

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
(defun tree-widget--locate-sub-directory (name path)
  "Locate the sub-directory NAME in PATH.
Return the absolute name of the directory found, or nil if not found."
  (let (dir elt)
    (while (and (not dir) (consp path))
      (setq elt  (condition-case nil (eval (car path)) (error nil))
            path (cdr path))
      (cond
       ((stringp elt)
        (setq dir (expand-file-name name elt))
        (or (file-accessible-directory-p dir)
            (setq dir nil)))
       ((and elt (not (equal elt (car path))))
        (setq dir (tree-widget--locate-sub-directory name elt)))))
    dir))

David Ponce's avatar
David Ponce committed
298 299 300 301 302 303
(defun tree-widget-themes-directory ()
  "Locate the directory where to search for a theme.
It is defined in variable `tree-widget-themes-directory'.
Return the absolute name of the directory found, or nil if the
specified directory is not accessible."
  (let ((found (aref tree-widget--theme 1)))
304 305 306 307 308 309 310 311 312 313 314
    (cond
     ;; The directory was not found.
     ((eq found 'void)
      (setq found nil))
     ;; The directory is available in the cache.
     (found)
     ;; Use the directory where this library is located.
     ((null tree-widget-themes-directory)
      (setq found (locate-library "tree-widget"))
      (when found
        (setq found (file-name-directory found))
David Ponce's avatar
David Ponce committed
315
        (or (file-accessible-directory-p found)
316 317 318 319 320 321 322 323 324 325 326 327 328 329
            (setq found nil))))
     ;; Check accessibility of absolute directory name.
     ((file-name-absolute-p tree-widget-themes-directory)
      (setq found (expand-file-name tree-widget-themes-directory))
      (or (file-accessible-directory-p found)
          (setq found nil)))
     ;; Locate a sub-directory in `tree-widget-themes-load-path'.
     (t
      (setq found (tree-widget--locate-sub-directory
                   tree-widget-themes-directory
                   tree-widget-themes-load-path))))
    ;; Store the result in the cache for later use.
    (aset tree-widget--theme 1 (or found 'void))
    found))
David Ponce's avatar
David Ponce committed
330 331 332 333 334 335

(defsubst tree-widget-set-image-properties (props)
  "In current theme, set images properties to PROPS."
  (aset tree-widget--theme 2 props))

(defun tree-widget-image-properties (file)
336 337 338 339 340 341
  "Return the properties of an image in current theme.
FILE is the absolute file name of an image.

If there is a \"tree-widget-theme-setup\" library in the theme
directory, where is located FILE, load it to setup theme images
properties.  Typically it should contain something like this:
David Ponce's avatar
David Ponce committed
342 343 344 345 346 347 348

  (tree-widget-set-image-properties
   (if (featurep 'xemacs)
       '(:ascent center)
     '(:ascent center :mask (heuristic t))
     ))

David Ponce's avatar
David Ponce committed
349 350
When there is no \"tree-widget-theme-setup\" library in the current
theme directory, load the one from the default theme, if available.
351 352
Default global properties are provided for respectively Emacs and
XEmacs in the variables `tree-widget-image-properties-emacs', and
David Ponce's avatar
David Ponce committed
353 354
`tree-widget-image-properties-xemacs'."
  ;; If properties are in the cache, use them.
355 356 357 358 359 360 361
  (let ((plist (aref tree-widget--theme 2)))
    (unless plist
      ;; Load tree-widget-theme-setup if available.
      (load (expand-file-name "tree-widget-theme-setup"
                              (file-name-directory file)) t t)
      ;; If properties have been setup, use them.
      (unless (setq plist (aref tree-widget--theme 2))
David Ponce's avatar
David Ponce committed
362 363 364 365 366 367 368 369 370 371 372
        ;; Try from the default theme.
        (load (expand-file-name "../default/tree-widget-theme-setup"
                                (file-name-directory file)) t t)
        ;; If properties have been setup, use them.
        (unless (setq plist (aref tree-widget--theme 2))
          ;; By default, use supplied global properties.
          (setq plist (if (featurep 'xemacs)
                          tree-widget-image-properties-xemacs
                        tree-widget-image-properties-emacs))
          ;; Setup the cache.
          (tree-widget-set-image-properties plist))))
373 374 375
    plist))

(defconst tree-widget--cursors
376 377 378
  ;; Pointer shapes when the mouse pointer is over inactive
  ;; tree-widget images.  This feature works since Emacs 22, and
  ;; ignored on older versions, and XEmacs.
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
  '(
    ("guide"     . arrow)
    ("no-guide"  . arrow)
    ("end-guide" . arrow)
    ("handle"    . arrow)
    ("no-handle" . arrow)
    ))

(defun tree-widget-lookup-image (name)
  "Look up in current theme for an image with NAME.
Search first in current theme, then in default theme (see also the
variable `tree-widget-theme').
Return the first image found having a supported format, or nil if not
found."
  (let ((default-directory (tree-widget-themes-directory)))
    (when default-directory
      (let (file (theme (tree-widget-theme-name)))
        (catch 'found
          (dolist (dir (if (string-equal theme "default")
                           '("default") (list theme "default")))
            (dolist (fmt (tree-widget-image-formats))
              (dolist (ext (cdr fmt))
                (setq file (expand-file-name (concat name ext) dir))
                (and
                 (file-readable-p file)
                 (file-regular-p file)
                 (throw
                  'found
                  (tree-widget-create-image
                   (car fmt) file
                   ;; Add the pointer shape
                   (cons :pointer
                         (cons
David Ponce's avatar
David Ponce committed
412 413
                          (or (cdr (assoc name tree-widget--cursors))
                              'hand)
414 415
                          (tree-widget-image-properties file)))))))))
          nil)))))
David Ponce's avatar
David Ponce committed
416 417 418 419

(defun tree-widget-find-image (name)
  "Find the image with NAME in current theme.
NAME is an image file name sans extension.
420
Return the image found, or nil if not found."
David Ponce's avatar
David Ponce committed
421 422 423
  (when (tree-widget-use-image-p)
    ;; Ensure there is an active theme.
    (tree-widget-set-theme (tree-widget-theme-name))
424 425 426 427 428 429 430 431 432 433
    (let ((image (assoc name (aref tree-widget--theme 3))))
      ;; The image NAME is found in the cache.
      (if image
          (cdr image)
        ;; Search the image in current, and default themes.
        (prog1
            (setq image (tree-widget-lookup-image name))
          ;; Store image reference in the cache for later use.
          (push (cons name image) (aref tree-widget--theme 3))))
      )))
David Ponce's avatar
David Ponce committed
434 435 436

;;; Widgets
;;
437 438 439 440 441 442 443 444 445
(defun tree-widget-button-click (event)
  "Move to the position clicked on, and if it is a button, invoke it.
EVENT is the mouse event received."
  (interactive "e")
  (mouse-set-point event)
  (let ((pos (widget-event-point event)))
    (if (get-char-property pos 'button)
        (widget-button-click event))))

David Ponce's avatar
David Ponce committed
446
(defvar tree-widget-button-keymap
447 448 449 450 451
  (let ((km (make-sparse-keymap)))
    (if (boundp 'widget-button-keymap)
        ;; XEmacs
        (progn
          (set-keymap-parent km widget-button-keymap)
452
          (define-key km [button1] 'tree-widget-button-click))
453 454
      ;; Emacs
      (set-keymap-parent km widget-keymap)
455
      (define-key km [down-mouse-1] 'tree-widget-button-click))
456 457 458
    km)
  "Keymap used inside node buttons.
Handle mouse button 1 click on buttons.")
David Ponce's avatar
David Ponce committed
459

David Ponce's avatar
David Ponce committed
460 461
(define-widget 'tree-widget-icon 'push-button
  "Basic widget other tree-widget icons are derived from."
David Ponce's avatar
David Ponce committed
462 463 464
  :format        "%[%t%]"
  :button-keymap tree-widget-button-keymap ; XEmacs
  :keymap        tree-widget-button-keymap ; Emacs
David Ponce's avatar
David Ponce committed
465 466 467
  :create        'tree-widget-icon-create
  :action        'tree-widget-icon-action
  :help-echo     'tree-widget-icon-help-echo
David Ponce's avatar
David Ponce committed
468 469
  )

David Ponce's avatar
David Ponce committed
470 471 472 473
(define-widget 'tree-widget-open-icon 'tree-widget-icon
  "Icon for an expanded tree-widget node."
  :tag        "[-]"
  :glyph-name "open"
David Ponce's avatar
David Ponce committed
474 475
  )

David Ponce's avatar
David Ponce committed
476 477 478 479
(define-widget 'tree-widget-empty-icon 'tree-widget-icon
  "Icon for an expanded tree-widget node with no child."
  :tag        "[X]"
  :glyph-name "empty"
David Ponce's avatar
David Ponce committed
480 481
  )

David Ponce's avatar
David Ponce committed
482 483 484 485
(define-widget 'tree-widget-close-icon 'tree-widget-icon
  "Icon for a collapsed tree-widget node."
  :tag        "[+]"
  :glyph-name "close"
David Ponce's avatar
David Ponce committed
486 487
  )

David Ponce's avatar
David Ponce committed
488 489 490 491 492
(define-widget 'tree-widget-leaf-icon 'tree-widget-icon
  "Icon for a tree-widget leaf node."
  :tag        ""
  :glyph-name "leaf"
  :button-face 'default
David Ponce's avatar
David Ponce committed
493 494 495
  )

(define-widget 'tree-widget-guide 'item
496
  "Vertical guide line."
David Ponce's avatar
David Ponce committed
497 498 499 500 501 502
  :tag       " |"
  ;;:tag-glyph (tree-widget-find-image "guide")
  :format    "%t"
  )

(define-widget 'tree-widget-end-guide 'item
503
  "End of a vertical guide line."
David Ponce's avatar
David Ponce committed
504 505 506 507 508 509
  :tag       " `"
  ;;:tag-glyph (tree-widget-find-image "end-guide")
  :format    "%t"
  )

(define-widget 'tree-widget-no-guide 'item
510
  "Invisible vertical guide line."
David Ponce's avatar
David Ponce committed
511 512 513 514 515 516
  :tag       "  "
  ;;:tag-glyph (tree-widget-find-image "no-guide")
  :format    "%t"
  )

(define-widget 'tree-widget-handle 'item
517
  "Horizontal guide line that joins a vertical guide line to a node."
David Ponce's avatar
David Ponce committed
518
  :tag       "-"
David Ponce's avatar
David Ponce committed
519 520 521 522 523
  ;;:tag-glyph (tree-widget-find-image "handle")
  :format    "%t"
  )

(define-widget 'tree-widget-no-handle 'item
524
  "Invisible handle."
David Ponce's avatar
David Ponce committed
525 526 527 528 529 530 531 532 533 534
  :tag       " "
  ;;:tag-glyph (tree-widget-find-image "no-handle")
  :format    "%t"
  )

(define-widget 'tree-widget 'default
  "Tree widget."
  :format         "%v"
  :convert-widget 'widget-types-convert-widget
  :value-get      'widget-value-value-get
535
  :value-delete   'widget-children-value-delete
David Ponce's avatar
David Ponce committed
536
  :value-create   'tree-widget-value-create
David Ponce's avatar
David Ponce committed
537 538 539 540 541 542
  :action         'tree-widget-action
  :help-echo      'tree-widget-help-echo
  :open-icon      'tree-widget-open-icon
  :close-icon     'tree-widget-close-icon
  :empty-icon     'tree-widget-empty-icon
  :leaf-icon      'tree-widget-leaf-icon
543 544 545 546 547
  :guide          'tree-widget-guide
  :end-guide      'tree-widget-end-guide
  :no-guide       'tree-widget-no-guide
  :handle         'tree-widget-handle
  :no-handle      'tree-widget-no-handle
David Ponce's avatar
David Ponce committed
548 549 550 551 552
  )

;;; Widget support functions
;;
(defun tree-widget-p (widget)
553
  "Return non-nil if WIDGET is a tree-widget."
David Ponce's avatar
David Ponce committed
554 555 556 557 558
  (let ((type (widget-type widget)))
    (while (and type (not (eq type 'tree-widget)))
      (setq type (widget-type (get type 'widget-type))))
    (eq type 'tree-widget)))

559 560 561 562 563
(defun tree-widget-node (widget)
  "Return WIDGET's :node child widget.
If not found, setup an `item' widget as default.
Signal an error if the :node widget is a tree-widget.
WIDGET is, or derives from, a tree-widget."
David Ponce's avatar
David Ponce committed
564
  (let ((node (widget-get widget :node)))
565 566 567 568 569
    (if node
        ;; Check that the :node widget is not a tree-widget.
        (and (tree-widget-p node)
             (error "Invalid tree-widget :node %S" node))
      ;; Setup an item widget as default :node.
David Ponce's avatar
David Ponce committed
570 571 572 573 574 575 576
      (setq node `(item :tag ,(or (widget-get widget :tag)
                                  (widget-princ-to-string
                                   (widget-value widget)))))
      (widget-put widget :node node))
    node))

(defun tree-widget-keep (arg widget)
577
  "Save in ARG the WIDGET's properties specified by :keep."
David Ponce's avatar
David Ponce committed
578 579 580 581 582
  (dolist (prop (widget-get widget :keep))
    (widget-put arg prop (widget-get widget prop))))

(defun tree-widget-children-value-save (widget &optional args node)
  "Save WIDGET children values.
583 584 585 586 587 588 589 590
WIDGET is, or derives from, a tree-widget.
Children properties and values are saved in ARGS if non-nil, else in
WIDGET's :args property value.  Properties and values of the
WIDGET's :node sub-widget are saved in NODE if non-nil, else in
WIDGET's :node sub-widget."
  (let ((args (cons (or node (widget-get widget :node))
                    (or args (widget-get widget :args))))
        (children (widget-get widget :children))
David Ponce's avatar
David Ponce committed
591 592 593 594 595 596 597 598 599 600 601
        arg child)
    (while (and args children)
      (setq arg      (car args)
            args     (cdr args)
            child    (car children)
            children (cdr children))
       (if (tree-widget-p child)
;;;; The child is a tree node.
           (progn
             ;; Backtrack :args and :node properties.
             (widget-put arg :args (widget-get child :args))
602
             (widget-put arg :node (widget-get child :node))
David Ponce's avatar
David Ponce committed
603 604 605 606 607 608 609 610 611 612 613 614
             ;; Save :open property.
             (widget-put arg :open (widget-get child :open))
             ;; The node is open.
             (when (widget-get child :open)
               ;; Save the widget value.
               (widget-put arg :value (widget-value child))
               ;; Save properties specified in :keep.
               (tree-widget-keep arg child)
               ;; Save children.
               (tree-widget-children-value-save
                child (widget-get arg :args) (widget-get arg :node))))
;;;; Another non tree node.
615
         ;; Save the widget value.
David Ponce's avatar
David Ponce committed
616 617
         (widget-put arg :value (widget-value child))
         ;; Save properties specified in :keep.
618
         (tree-widget-keep arg child)))))
David Ponce's avatar
David Ponce committed
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647

;;; Widget creation
;;
(defvar tree-widget-before-create-icon-functions nil
  "Hooks run before to create a tree-widget icon.
Each function is passed the icon widget not yet created.
The value of the icon widget :node property is a tree :node widget or
a leaf node widget, not yet created.
This hook can be used to dynamically change properties of the icon and
associated node widgets.  For example, to dynamically change the look
and feel of the tree-widget by changing the values of the :tag
and :glyph-name properties of the icon widget.
This hook should be local in the buffer setup to display widgets.")

(defun tree-widget-icon-create (icon)
  "Create the ICON widget."
  (run-hook-with-args 'tree-widget-before-create-icon-functions icon)
  (widget-put icon :tag-glyph
              (tree-widget-find-image (widget-get icon :glyph-name)))
  ;; Ensure there is at least one char to display the image.
  (and (widget-get icon :tag-glyph)
       (equal "" (or (widget-get icon :tag) ""))
       (widget-put icon :tag " "))
  (widget-default-create icon)
  ;; Insert space between the icon and the node widget.
  (insert-char ?  1)
  (put-text-property
   (1- (point)) (point)
   'display (list 'space :width tree-widget-space-width)))
David Ponce's avatar
David Ponce committed
648 649

(defun tree-widget-value-create (tree)
650 651 652
  "Create the TREE tree-widget."
  (let* ((node   (tree-widget-node tree))
         (flags  (widget-get tree :tree-widget--guide-flags))
653
         (indent (widget-get tree :indent))
654 655 656 657 658
         ;; Setup widget's image support.  Looking up for images, and
         ;; setting widgets' :tag-glyph is done here, to allow to
         ;; dynamically change the image theme.
         (widget-image-enable (tree-widget-use-image-p))     ; Emacs
         (widget-glyph-enable widget-image-enable)           ; XEmacs
David Ponce's avatar
David Ponce committed
659
         children buttons)
660
    (and indent (not (widget-get tree :parent))
661
         (insert-char ?\  indent))
David Ponce's avatar
David Ponce committed
662
    (if (widget-get tree :open)
663
;;;; Expanded node.
664
        (let ((args     (widget-get tree :args))
665 666 667 668 669 670 671
              (xpandr   (or (widget-get tree :expander)
                            (widget-get tree :dynargs)))
              (guide    (widget-get tree :guide))
              (noguide  (widget-get tree :no-guide))
              (endguide (widget-get tree :end-guide))
              (handle   (widget-get tree :handle))
              (nohandle (widget-get tree :no-handle))
672 673 674 675
              (guidi    (tree-widget-find-image "guide"))
              (noguidi  (tree-widget-find-image "no-guide"))
              (endguidi (tree-widget-find-image "end-guide"))
              (handli   (tree-widget-find-image "handle"))
David Ponce's avatar
David Ponce committed
676
              (nohandli (tree-widget-find-image "no-handle")))
677 678 679 680
          ;; Request children at run time, when not already done.
          (when (and (not args) xpandr)
            (setq args (mapcar 'widget-convert (funcall xpandr tree)))
            (widget-put tree :args args))
681 682
          ;; Defer the node widget creation after icon creation.
          (widget-put tree :node (widget-convert node))
David Ponce's avatar
David Ponce committed
683
          ;; Create the icon widget for the expanded tree.
David Ponce's avatar
David Ponce committed
684
          (push (widget-create-child-and-convert
685 686 687
                 tree (widget-get tree (if args :open-icon :empty-icon))
                 ;; Pass the node widget to child.
                 :node (widget-get tree :node))
David Ponce's avatar
David Ponce committed
688
                buttons)
David Ponce's avatar
David Ponce committed
689
          ;; Create the tree node widget.
690 691
          (push (widget-create-child tree (widget-get tree :node))
                children)
David Ponce's avatar
David Ponce committed
692 693 694
          ;; Update the icon :node with the created node widget.
          (widget-put (car buttons) :node (car children))
          ;; Create the tree children.
David Ponce's avatar
David Ponce committed
695
          (while args
David Ponce's avatar
David Ponce committed
696 697
            (setq node (car args)
                  args (cdr args))
698
            (and indent (insert-char ?\  indent))
699
            ;; Insert guide lines elements from previous levels.
700
            (dolist (f (reverse flags))
David Ponce's avatar
David Ponce committed
701 702 703 704
              (widget-create-child-and-convert
               tree (if f guide noguide)
               :tag-glyph (if f guidi noguidi))
              (widget-create-child-and-convert
705 706
               tree nohandle :tag-glyph nohandli))
            ;; Insert guide line element for this level.
David Ponce's avatar
David Ponce committed
707 708 709 710 711 712
            (widget-create-child-and-convert
             tree (if args guide endguide)
             :tag-glyph (if args guidi endguidi))
            ;; Insert the node handle line
            (widget-create-child-and-convert
             tree handle :tag-glyph handli)
David Ponce's avatar
David Ponce committed
713 714 715 716 717 718 719
            (if (tree-widget-p node)
                ;; Create a sub-tree node.
                (push (widget-create-child-and-convert
                       tree node :tree-widget--guide-flags
                       (cons (if args t) flags))
                      children)
              ;; Create the icon widget for a leaf node.
David Ponce's avatar
David Ponce committed
720
              (push (widget-create-child-and-convert
David Ponce's avatar
David Ponce committed
721 722 723 724 725 726 727 728 729 730 731
                     tree (widget-get tree :leaf-icon)
                     ;; At this point the node widget isn't yet created.
                     :node (setq node (widget-convert
                                       node :tree-widget--guide-flags
                                       (cons (if args t) flags)))
                     :tree-widget--leaf-flag t)
                    buttons)
              ;; Create the leaf node widget.
              (push (widget-create-child tree node) children)
              ;; Update the icon :node with the created node widget.
              (widget-put (car buttons) :node (car children)))))
732
;;;; Collapsed node.
733 734
      ;; Defer the node widget creation after icon creation.
      (widget-put tree :node (widget-convert node))
David Ponce's avatar
David Ponce committed
735
      ;; Create the icon widget for the collapsed tree.
David Ponce's avatar
David Ponce committed
736
      (push (widget-create-child-and-convert
737 738 739
             tree (widget-get tree :close-icon)
             ;; Pass the node widget to child.
             :node (widget-get tree :node))
David Ponce's avatar
David Ponce committed
740
            buttons)
David Ponce's avatar
David Ponce committed
741
      ;; Create the tree node widget.
742 743
      (push (widget-create-child tree (widget-get tree :node))
            children)
David Ponce's avatar
David Ponce committed
744 745 746 747
      ;; Update the icon :node with the created node widget.
      (widget-put (car buttons) :node (car children)))
    ;; Save widget children and buttons.  The tree-widget :node child
    ;; is the first element in :children.
David Ponce's avatar
David Ponce committed
748
    (widget-put tree :children (nreverse children))
David Ponce's avatar
David Ponce committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
    (widget-put tree :buttons  buttons)))

;;; Widget callbacks
;;
(defsubst tree-widget-leaf-node-icon-p (icon)
  "Return non-nil if ICON is a leaf node icon.
That is, if its :node property value is a leaf node widget."
  (widget-get icon :tree-widget--leaf-flag))

(defun tree-widget-icon-action (icon &optional event)
  "Handle the ICON widget :action.
If ICON :node is a leaf node it handles the :action.  The tree-widget
parent of ICON handles the :action otherwise.
Pass the received EVENT to :action."
  (let ((node (widget-get icon (if (tree-widget-leaf-node-icon-p icon)
                                   :node :parent))))
    (widget-apply node :action event)))

(defun tree-widget-icon-help-echo (icon)
  "Return the help-echo string of ICON.
If ICON :node is a leaf node it handles the :help-echo.  The tree-widget
parent of ICON handles the :help-echo otherwise."
  (let* ((node (widget-get icon (if (tree-widget-leaf-node-icon-p icon)
                                    :node :parent)))
         (help-echo (widget-get node :help-echo)))
    (if (functionp help-echo)
        (funcall help-echo node)
      help-echo)))

(defvar tree-widget-after-toggle-functions nil
  "Hooks run after toggling a tree-widget expansion.
Each function is passed a tree-widget.  If the value of the :open
property is non-nil the tree has been expanded, else collapsed.
This hook should be local in the buffer setup to display widgets.")

(defun tree-widget-action (tree &optional event)
  "Handle the :action of the TREE tree-widget.
That is, toggle expansion of the TREE tree-widget.
Ignore the EVENT argument."
  (let ((open (not (widget-get tree :open))))
    (or open
        ;; Before to collapse the node, save children values so next
        ;; open can recover them.
        (tree-widget-children-value-save tree))
    (widget-put tree :open open)
    (widget-value-set tree open)
    (run-hook-with-args 'tree-widget-after-toggle-functions tree)))

(defun tree-widget-help-echo (tree)
  "Return the help-echo string of the TREE tree-widget."
  (if (widget-get tree :open)
      "Collapse node"
    "Expand node"))
David Ponce's avatar
David Ponce committed
802 803 804

(provide 'tree-widget)

805
;; arch-tag: c3a1ada2-1663-41dc-9d16-2479ed8320e8
David Ponce's avatar
David Ponce committed
806
;;; tree-widget.el ends here