nxhtml/util/org-panel.el

   1 ;;; org-panel.el --- Simple routines for us with bad memory
   2 ;;
   3 ;; Author: Lennart Borgman (lennart O borgman A gmail O com)
   4 ;; Created: Thu Nov 15 15:35:03 2007
   5 ;; Version: 0.21
   6 ;; Lxast-Updated: Wed Nov 21 03:06:03 2007 (3600 +0100)
   7 ;; URL:
   8 ;; Keywords:
   9 ;; Compatibility:
  10 ;;
  11 ;; Fxeatures that might be required by this library:
  12 ;;
  13 ;;   `easymenu', `font-lock', `noutline', `org', `outline', `syntax',
  14 ;;   `time-date'.
  15 ;;
  16 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  17 ;;
  18 ;;; Commentary:
  19 ;;
  20 ;; This defines a kind of control panel for `org-mode'. This control
  21 ;; panel should make it fast to move around and edit structure etc.
  22 ;;
  23 ;; To bring up the control panel type
  24 ;;
  25 ;;   M-x orgpan-panel
  26 ;;
  27 ;; Type ? there for help.
  28 ;;
  29 ;; I suggest you add the following to your .emacs for quick access of
  30 ;; the panel:
  31 ;;
  32 ;;   (eval-after-load 'org-mode
  33 ;;     (define-key org-mode-map [(control ?c) ?p] 'orgpan-panel))
  34 ;;
  35 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  36 ;;
  37 ;;; Change log:
  38 ;;
  39 ;;
  40 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  41 ;;
  42 ;; This program is free software; you can redistribute it and/or
  43 ;; modify it under the terms of the GNU General Public License as
  44 ;; published by the Free Software Foundation; either version 2, or
  45 ;; (at your option) any later version.
  46 ;;
  47 ;; This program is distributed in the hope that it will be useful,
  48 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  49 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  50 ;; General Public License for more details.
  51 ;;
  52 ;; You should have received a copy of the GNU General Public License
  53 ;; along with this program; see the file COPYING.  If not, write to
  54 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  55 ;; Floor, Boston, MA 02110-1301, USA.
  56 ;;
  57 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  58 ;;
  59 ;;; Code:
  60
  61 (require 'org)
  62 (require 'outline)
  63
  64 ;; Fix-me: this is for testing. A minor mode version interferes badly
  65 ;; with emulation minor modes.
  66 (defconst orgpan-minor-mode-version nil)
  67
  68 (defface orgpan-field
  69   '((t (:inherit widget-field)))
  70   "Face for fields."
  71   :group 'orgpan)
  72 (defvar orgpan-field-face 'orgpan-field)
  73
  74 (defface orgpan-active-field
  75   '((t (:inherit highlight)))
  76   "Face for fields."
  77   :group 'orgpan)
  78 (defvar orgpan-active-field-face 'orgpan-active-field)
  79
  80 (defface orgpan-spaceline
  81   '((t (:height 0.2)))
  82   "Face for spacing lines."
  83   :group 'orgpan)
  84
  85 (defcustom orgpan-panel-at-top nil
  86   "Put org panel at top if non-nil."
  87   :type 'boolean
  88   :group 'orgpan)
  89
  90 (defcustom orgpan-panel-buttons nil
  91   "Panel style, if non-nil use buttons.
  92 If there are buttons in the panel they are used to change the way
  93 the arrow keys work.  The panel looks something like this, with
  94 the first button chosen:
  95
  96   [Navigate] [Restructure] [TODO/Priority]
  97   ----------
  98   up/down, left: Go to, right: Visibility
  99
 100 The line below the buttons try to give a short hint about what
 101 the arrow keys does.  \(Personally I prefer the version without
 102 buttons since I then do not have to remember which button is
 103 active.)"
 104   :type 'boolean
 105   :group 'orgpan)
 106
 107 ;; Fix-me: add org-mode-map
 108 ;; (memq 'org-self-insert-command orgpan-org-mode-commands)
 109 ;; (memq 'org-self-insert-command orgpan-org-commands)
 110 (defvar orgpan-org-mode-commands nil)
 111 (setq orgpan-org-mode-commands nil)
 112
 113 (defconst orgpan-org-commands
 114   '(
 115     orgpan-copy-subtree
 116     orgpan-cut-subtree
 117     orgpan-paste-subtree
 118     undo
 119     save-buffer
 120     ;;
 121     ;orgpan-occur
 122     orgpan-find-org-file
 123     ;;
 124     org-cycle
 125     org-global-cycle
 126     outline-up-heading
 127     outline-next-visible-heading
 128     outline-previous-visible-heading
 129     outline-forward-same-level
 130     outline-backward-same-level
 131     org-todo
 132     org-show-todo-tree
 133     org-priority-up
 134     org-priority-down
 135     org-move-subtree-up
 136     org-move-subtree-down
 137     org-do-promote
 138     org-do-demote
 139     org-promote-subtree
 140     org-demote-subtree))
 141
 142
 143 (defvar orgpan-panel-window nil
 144   "The window showing `orgpan-panel-buffer'.")
 145
 146 (defvar orgpan-panel-buffer nil
 147   "The panel buffer.
 148 There can be only one such buffer at any time.")
 149
 150 (defvar orgpan-org-window nil)
 151 ;;(make-variable-buffer-local 'orgpan-org-window)
 152
 153 ;; Fix-me: used?
 154 (defvar orgpan-org-buffer nil)
 155 ;;(make-variable-buffer-local 'orgpan-org-buffer)
 156
 157 (defvar orgpan-last-org-buffer nil)
 158 ;;(make-variable-buffer-local 'orgpan-last-org-buffer)
 159
 160 (defvar orgpan-point nil)
 161 ;;(make-variable-buffer-local 'orgpan-point)
 162
 163 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 164 ;;; Hook functions etc
 165
 166 (defun orgpan-delete-panel ()
 167   "Remove the panel."
 168   (interactive)
 169   (let ((was-in-panel (and (window-live-p orgpan-panel-window)
 170                            (eq (selected-window) orgpan-panel-window))))
 171     (when (buffer-live-p orgpan-panel-buffer)
 172       (delete-windows-on orgpan-panel-buffer)
 173       (kill-buffer orgpan-panel-buffer))
 174     (when was-in-panel
 175       (select-window orgpan-org-window)))
 176   (setq orgpan-panel-buffer nil)
 177   (setq orgpan-panel-window nil)
 178   (orgpan-panel-minor-mode 0)
 179   (remove-hook 'post-command-hook 'orgpan-minor-post-command)
 180   (remove-hook 'post-command-hook 'orgpan-mode-post-command)
 181   ;;(remove-hook 'window-configuration-change-hook 'orgpan-window-config-change)
 182   )
 183
 184 (defvar orgpan-from-panel 0)
 185 (defun orgpan-mode-pre-command ()
 186   ;;(setq orgpan-from-panel nil)
 187   (condition-case err
 188       (if (not (and (windowp orgpan-org-window)
 189                     (window-live-p orgpan-org-window)))
 190           (progn
 191             (setq this-command 'ignore)
 192             (orgpan-delete-panel)
 193             (message "The window belonging to the panel had disappeared, removed panel."))
 194         (let ((buf (window-buffer orgpan-org-window)))
 195           (when (with-current-buffer buf
 196                   (derived-mode-p 'org-mode))
 197             (setq orgpan-last-org-buffer buf))
 198           ;; Fix me: add a list of those commands that are not
 199           ;; meaningful from the panel (for example org-time-stamp)
 200           (when (or (memq this-command orgpan-org-commands)
 201                     (memq this-command orgpan-org-mode-commands)
 202                     ;; For some reason not all org commands are found above:
 203                     (unless (eq this-command 'org-self-insert-command)
 204                       (let ((this-name (format "%s" this-command)))
 205                         (when (< 4 (length this-name))
 206                           (string= "org-" (substring this-name 0 4))))))
 207             (if (not (with-current-buffer buf
 208                        (derived-mode-p 'org-mode)))
 209                 (progn
 210                   (if (buffer-live-p orgpan-org-buffer)
 211                       (set-window-buffer orgpan-org-window orgpan-org-buffer)
 212                     (message "Please use `l' or `b' to choose an org-mode buffer"))
 213                   (setq this-command 'ignore))
 214               (setq orgpan-org-buffer (window-buffer orgpan-org-window))
 215               (setq orgpan-from-panel 1)
 216               (select-window orgpan-org-window)
 217               ))))
 218     (error (lwarn 't :warning "orgpan-pre: %S" err))))
 219
 220 (defun orgpan-mode-post-command ()
 221   (condition-case err
 222       (progn
 223         ;;(message "post %s" (current-time-string))(sit-for 1)
 224         (unless (and (windowp orgpan-panel-window)
 225                      (window-live-p orgpan-panel-window)
 226                      (bufferp orgpan-panel-buffer)
 227                      (buffer-live-p orgpan-panel-buffer))
 228           (orgpan-delete-panel))
 229         (unless (active-minibuffer-window)
 230           (when (and (= 1 orgpan-from-panel)
 231                      (windowp orgpan-panel-window)
 232                      (window-live-p orgpan-panel-window))
 233             (select-window orgpan-panel-window)
 234             (when (derived-mode-p 'orgpan-mode)
 235               (setq deactivate-mark t)
 236               (when orgpan-panel-buttons
 237                 (unless (and orgpan-point
 238                              (= (point) orgpan-point))
 239                   ;; Go backward so it is possible to click on a "button":
 240                   (orgpan-backward-field)))))
 241           (when (< 0 orgpan-from-panel)
 242             (setq orgpan-from-panel (1- orgpan-from-panel)))
 243           (unless (eq (selected-window) orgpan-panel-window)
 244             (orgpan-delete-panel))))
 245     (error (lwarn 't :warning "orgpan-post: %S" err))))
 246
 247
 248 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 249 ;;; Commands
 250
 251 (defun orgpan-last-buffer ()
 252   "Open last org-mode buffer in panels org window."
 253   (interactive)
 254   (let ((buf (window-buffer orgpan-org-window))
 255         (last-buf orgpan-last-org-buffer))
 256 ;;     (when (with-current-buffer buf
 257 ;;             (derived-mode-p 'org-mode))
 258 ;;       (setq orgpan-last-org-buffer buf))
 259     (when (eq last-buf buf)
 260       (setq last-buf nil))
 261     (if (not last-buf)
 262         (orgpan-switch-buffer)
 263       (set-window-buffer orgpan-org-window last-buf))))
 264
 265 (defun orgpan-switch-buffer ()
 266   "Switch to next org-mode buffer in panels org window."
 267   (interactive)
 268   (let ((buf (window-buffer orgpan-org-window))
 269         (org-buffers nil))
 270     (with-current-buffer buf
 271       (when (derived-mode-p 'org-mode)
 272         (bury-buffer buf)
 273         ;;(setq orgpan-last-org-buffer buf)
 274         ))
 275     (setq org-buffers (delq nil (mapcar (lambda (buf)
 276                                           (when (with-current-buffer buf
 277                                                   (derived-mode-p 'org-mode))
 278                                             buf))
 279                                         (buffer-list))))
 280     (setq org-buffers (delq buf org-buffers))
 281     (if (not org-buffers)
 282         (message "No other org-mode buffers")
 283       (set-window-buffer orgpan-org-window (car org-buffers))
 284       (setq orgpan-org-buffer (car org-buffers)))))
 285
 286 (defcustom orgpan-cautious-cut-copy-paste nil
 287   "Ask the user about panel cut, paste and copy before doing them.
 288 This refers to the functions `orgpan-paste-subtree',
 289 `orgpan-cut-subtree' and `orgpan-copy-subtree'."
 290   :type 'boolean
 291   :group 'orgpan)
 292
 293 (defun orgpan-paste-subtree ()
 294   (interactive)
 295   (if orgpan-cautious-cut-copy-paste
 296       (if (y-or-n-p "Paste subtree here? ")
 297           (org-paste-subtree)
 298         (message "Nothing was pasted"))
 299     (org-paste-subtree)))
 300
 301 (defun orgpan-cut-subtree ()
 302   (interactive)
 303   (let ((heading (progn
 304                    (org-back-to-heading)
 305                    (buffer-substring (point) (line-end-position))
 306                    )))
 307     (if orgpan-cautious-cut-copy-paste
 308         (if (y-or-n-p (format "Do you want to cut the subtree\n%s\n? " heading))
 309             (org-cut-subtree)
 310           (message "Nothing was cut"))
 311       (org-cut-subtree))))
 312
 313 (defun orgpan-copy-subtree ()
 314   (interactive)
 315   (let ((heading (progn
 316                    (org-back-to-heading)
 317                    (buffer-substring (point) (line-end-position))
 318                    )))
 319     (if orgpan-cautious-cut-copy-paste
 320         (if (y-or-n-p (format "Do you want to copy the subtree\n%s\n? " heading))
 321             (org-copy-subtree)
 322           (message "Nothing was copied"))
 323       (org-copy-subtree))))
 324
 325
 326 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 327 ;;; Buttons
 328
 329 (defvar orgpan-ovl-help nil)
 330
 331 (defun orgpan-check-panel-mode ()
 332   (unless (derived-mode-p 'orgpan-mode)
 333     (error "Not orgpan-mode in buffer: %s" major-mode)))
 334
 335 (defun orgpan-display-bindings-help ()
 336   ;;(orgpan-check-panel-mode)
 337   (setq orgpan-point (point-marker))
 338   (let* ((ovls (overlays-at orgpan-point))
 339          (ovl (car ovls))
 340          (help (when ovl (overlay-get ovl 'orgpan-explain))))
 341     (dolist (o (overlays-in (point-min) (point-max)))
 342       (unless ovl (setq ovl o))
 343       (overlay-put o 'face orgpan-field-face))
 344     (overlay-put ovl 'face orgpan-active-field-face)
 345     (unless orgpan-ovl-help
 346       (setq orgpan-ovl-help (make-overlay orgpan-point orgpan-point)))
 347     (overlay-put orgpan-ovl-help 'before-string help)))
 348
 349 (defun orgpan-forward-field ()
 350   (interactive)
 351   (orgpan-check-panel-mode)
 352   (let ((pos (next-overlay-change (point))))
 353     (unless (overlays-at pos)
 354       (setq pos (next-overlay-change pos)))
 355     (when (= pos (point-max))
 356       (setq pos (point-min))
 357       (unless (overlays-at pos)
 358         (setq pos (next-overlay-change pos))))
 359     (goto-char pos))
 360   (orgpan-display-bindings-help))
 361
 362 (defun orgpan-backward-field ()
 363   (interactive)
 364   (orgpan-check-panel-mode)
 365   (when (= (point) (point-min))
 366     (goto-char (point-max)))
 367   (let ((pos (previous-overlay-change (point))))
 368     (unless (overlays-at pos)
 369       (setq pos (previous-overlay-change pos)))
 370     (goto-char pos))
 371   (orgpan-display-bindings-help))
 372
 373
 374 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 375 ;;; Mode
 376 (defun orgpan-agenda ()
 377   "Start agenda"
 378   (interactive)
 379   (orgpan-delete-panel)
 380   (call-interactively 'org-agenda))
 381
 382 (defun orgpan-outline-up-heading (arg &optional invisible-ok)
 383   (interactive "p")
 384   (outline-back-to-heading invisible-ok)
 385   (let ((start-level (funcall outline-level)))
 386     (if (<= start-level 1)
 387         (message "Already at top level of the outline")
 388       (outline-up-heading arg invisible-ok))))
 389
 390 (defvar orgpan-mode-map
 391   ;; Fix-me: clean up here!
 392   ;; Fix-me: viper support
 393   (let ((map (make-sparse-keymap)))
 394     (define-key map [?q] 'orgpan-delete-panel)
 395     (define-key map [??] 'orgpan-help)
 396     (define-key map [?a] 'orgpan-agenda)
 397     ;; Copying etc
 398     (define-key map [?c] 'orgpan-copy-subtree)
 399     (define-key map [?x] 'orgpan-cut-subtree)
 400     (define-key map [?v] 'orgpan-paste-subtree)
 401     (define-key map [?z] 'undo)
 402     (define-key map [(control ?c)] 'orgpan-copy-subtree)
 403     (define-key map [(control ?x)] 'orgpan-cut-subtree)
 404     (define-key map [(control ?v)] 'orgpan-paste-subtree)
 405     (define-key map [(control ?z)] 'undo)
 406     ;; Buffers:
 407     (define-key map [?b] 'orgpan-switch-buffer)
 408     (define-key map [?l] 'orgpan-last-buffer)
 409     (define-key map [?o] 'orgpan-find-org-file)
 410     (define-key map [?w] 'save-buffer)
 411     ;; Some keys for moving between headings. Emacs keys for next/prev
 412     ;; line seems ok:
 413     (define-key map [(control ?p)] 'outline-previous-visible-heading)
 414     (define-key map [(control ?n)] 'outline-next-visible-heading)
 415     (define-key map [(shift control ?p)] 'outline-backward-same-level)
 416     (define-key map [(shift control ?n)] 'outline-forward-same-level)
 417     ;; A mnemunic for up:
 418     (define-key map [(control ?u)] 'orgpan-outline-up-heading)
 419     ;; Search sparse tree:
 420     (define-key map [?s] 'org-sparse-tree)
 421     ;;(define-key map [?s] 'orgpan-occur)
 422     ;;(define-key map [?s] 'org-occur)
 423     ;; Same as in org-mode:
 424     ;;(define-key map [(control ?c)(control ?v)] 'org-show-todo-tree)
 425     ;; Fix-me: This leads to strange problems:
 426     ;;(define-key map [t] 'ignore)
 427     map))
 428
 429 (defun orgpan-find-org-file ()
 430   "Prompt for an .org file and open it."
 431   (interactive)
 432   (let ((file-name
 433          (read-file-name
 434           "Find .org file: " nil nil t nil
 435           (lambda (fn)
 436             (unless (backup-file-name-p fn)
 437               (let ((ext (file-name-extension fn)))
 438                 (when ext
 439                   (string= "org" ext))))))))
 440     (find-file file-name)))
 441
 442 (defun orgpan-occur ()
 443   "Replacement for `org-occur'.
 444 Technical reasons."
 445   (interactive)
 446   (let ((rgx (read-from-minibuffer "(panel) Regexp: ")))
 447     (setq orgpan-from-panel 1)
 448     (select-window orgpan-org-window)
 449     (org-occur rgx)))
 450
 451 (defun orgpan-sparse-tree (&optional arg)
 452   "Create a sparse tree, prompt for the details.
 453 This command can create sparse trees.  You first need to select the type
 454 of match used to create the tree:
 455
 456 t      Show entries with a specific TODO keyword.
 457 T      Show entries selected by a tags match.
 458 p      Enter a property name and its value (both with completion on existing
 459        names/values) and show entries with that property.
 460 r      Show entries matching a regular expression"
 461   (interactive "P")
 462   (let (ans kwd value)
 463     (message "Sparse tree: [r]egexp   [t]odo-kwd   [T]ag   [p]roperty")
 464     (setq ans (read-char-exclusive))
 465     (cond
 466      ((equal ans ?t)
 467       (org-show-todo-tree '(4)))
 468      ((equal ans ?T)
 469       (call-interactively 'org-tags-sparse-tree))
 470      ((member ans '(?p ?P))
 471       (setq kwd (completing-read "Property: "
 472                                  (mapcar 'list (org-buffer-property-keys))))
 473       (setq value (completing-read "Value: "
 474                                    (mapcar 'list (org-property-values kwd))))
 475       (unless (string-match "\\`{.*}\\'" value)
 476         (setq value (concat "\"" value "\"")))
 477       (org-tags-sparse-tree arg (concat kwd "=" value)))
 478      ((member ans '(?r ?R))
 479       (call-interactively 'org-occur))
 480      (t (error "No such sparse tree command \"%c\"" ans)))))
 481
 482 ;; (defun orgpan-avoid-viper-in-buffer ()
 483 ;;   ;; Fix-me: This is ugly. However see `this-major-mode-requires-vi-state':
 484 ;;   (set (make-local-variable 'viper-emacs-state-mode-list) '(orgpan-mode))
 485 ;;   (set (make-local-variable 'viper-new-major-mode-buffer-list) nil)
 486 ;;   (local-set-key [?\ ] 'ignore))
 487
 488 (define-derived-mode orgpan-mode nil "Org-Panel"
 489   "Mode for org-simple.el control panel."
 490   (set (make-local-variable 'buffer-read-only) t)
 491   (unless orgpan-minor-mode-version
 492     (add-hook 'pre-command-hook 'orgpan-mode-pre-command nil t)
 493     (add-hook 'post-command-hook 'orgpan-mode-post-command t))
 494   (set (make-local-variable 'cursor-type) nil)
 495   (when (boundp 'yas/dont-activate) (setq yas/dont-activate t))
 496   ;; Avoid emulation modes here (cua, viper):
 497   (set (make-local-variable 'emulation-mode-map-alists) nil))
 498
 499
 500 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 501 ;;; Panel layout
 502
 503 (defun orgpan-insert-field (text keymap explain)
 504   (insert text)
 505   (let* ((end (point))
 506          (len (length text))
 507          (beg (- end len))
 508          (ovl (make-overlay beg end)))
 509     (overlay-put ovl 'face orgpan-field-face)
 510     (overlay-put ovl 'keymap keymap)
 511     (overlay-put ovl 'orgpan-explain explain)))
 512
 513 (defconst orgpan-with-keymap
 514   (let ((map (make-sparse-keymap)))
 515     (set-keymap-parent map org-mode-map)
 516     ;; Users are used to tabbing between fields:
 517     (define-key map [(tab)]       'orgpan-forward-field)
 518     (define-key map [(shift tab)] 'orgpan-backward-field)
 519     (define-key map [backtab]     'orgpan-backward-field)
 520     ;; Now we must use something else for visibility (first does not
 521     ;; work if Viper):
 522     (define-key map [(meta tab)]  'org-cycle)
 523     (define-key map [(control meta tab)] 'org-global-cycle)
 524     map))
 525
 526 (defconst orgpan-without-keymap
 527   (let ((map (make-sparse-keymap)))
 528     (set-keymap-parent map org-mode-map)
 529     ;; Visibility (those are in org-mode-map):
 530     ;;(define-key map [tab] 'org-cycle)
 531     ;;(define-key map [(shift tab)] 'org-global-cycle)
 532     ;; Navigate:
 533     (define-key map [left] 'orgpan-outline-up-heading)
 534     (define-key map [right] 'org-cycle)
 535     (define-key map [up] 'outline-previous-visible-heading)
 536     (define-key map [down] 'outline-next-visible-heading)
 537     (define-key map [(shift down)] 'outline-forward-same-level)
 538     (define-key map [(shift up)] 'outline-backward-same-level)
 539     ;; Restructure:
 540     (define-key map [(control up)] 'org-move-subtree-up)
 541     (define-key map [(control down)] 'org-move-subtree-down)
 542     (define-key map [(control left)] 'org-do-promote)
 543     (define-key map [(control right)] 'org-do-demote)
 544     (define-key map [(control shift left)] 'org-promote-subtree)
 545     (define-key map [(control shift right)] 'org-demote-subtree)
 546     ;; Todo etc
 547     (define-key map [?+] 'org-priority-up)
 548     (define-key map [?-] 'org-priority-down)
 549     (define-key map [?t] 'org-todo)
 550     map))
 551
 552 (defun orgpan-make-panel-without-buttons (buf)
 553   (with-current-buffer buf
 554     (insert (propertize "*Org Panel*" 'face 'orgpan-active-field))
 555     (let ((ovl (make-overlay (point-min) (point-max))))
 556       (overlay-put ovl 'priority 10)
 557       (overlay-put ovl 'face 'orgpan-active-field))
 558     (insert "  ? for help, q quit\n")
 559     (insert (propertize "arrows" 'face 'font-lock-keyword-face)
 560             ": Go to, "
 561             (propertize "C-arrows" 'face 'font-lock-keyword-face)
 562             ": Edit tree\n"
 563             (propertize "C-cxvz" 'face 'font-lock-keyword-face)
 564             ": copy cut paste undo, "
 565             (propertize "tT+-" 'face 'font-lock-keyword-face)
 566             ": todo priority, "
 567             (propertize "s" 'face 'font-lock-keyword-face)
 568             ": search, "
 569             (propertize "o" 'face 'font-lock-keyword-face)
 570             ": open file\n"
 571             (propertize "w" 'face 'font-lock-keyword-face)
 572             ": write, "
 573             (propertize "a" 'face 'font-lock-keyword-face)
 574             ": agenda"
 575             "\n"
 576             )
 577     (set-keymap-parent orgpan-mode-map orgpan-without-keymap)
 578     (let ((ovl (make-overlay (point-min) (point-max))))
 579       (overlay-put ovl 'face 'secondary-selection))
 580     ))
 581
 582 (defun orgpan-make-panel-with-buttons (buf)
 583   (with-current-buffer buf
 584     (let* ((base-map (make-sparse-keymap))
 585            (space-line (propertize "\n\n" 'face 'orgpan-spaceline))
 586            (arrow-face 'font-lock-keyword-face)
 587            (L (propertize "left" 'face arrow-face))
 588            (R (propertize "right" 'face arrow-face))
 589            (U (propertize "up" 'face arrow-face))
 590            (D (propertize "down" 'face arrow-face)))
 591       ;;(message D)(sit-for 2)
 592       (define-key base-map [left] 'ignore)
 593       (define-key base-map [right] 'ignore)
 594       (define-key base-map [up] 'ignore)
 595       (define-key base-map [down] 'ignore)
 596       (define-key base-map [?q] 'delete-window)
 597       (define-key base-map [??] 'orgpan-help)
 598       ;; Navigating
 599       (let ((map (copy-keymap base-map)))
 600         (define-key map [left] 'outline-up-heading)
 601         (define-key map [right] 'org-cycle)
 602         (define-key map [up] 'outline-previous-visible-heading)
 603         (define-key map [down] 'outline-next-visible-heading)
 604         (define-key map [(shift down)] 'outline-forward-same-level)
 605         (define-key map [(shift up)] 'outline-backward-same-level)
 606         (orgpan-insert-field "Navigate" map (concat U "/" D ", " L ": Go to, " R ": Visibility")))
 607       (insert "  ")
 608       (let ((map (copy-keymap base-map)))
 609         (define-key map [up] 'org-move-subtree-up)
 610         (define-key map [down] 'org-move-subtree-down)
 611         (define-key map [left] 'org-do-promote)
 612         (define-key map [right] 'org-do-demote)
 613         (define-key map [(shift left)] 'org-promote-subtree)
 614         (define-key map [(shift right)] 'org-demote-subtree)
 615         (orgpan-insert-field
 616          "Restructure" map
 617          (concat U "/" D ": "
 618                  (propertize "Move" 'face 'font-lock-warning-face)
 619                  ", " L "/" R ": "
 620                  (propertize "Level (w S: Subtree Level)" 'face 'font-lock-warning-face))))
 621       (insert "  ")
 622       (let ((map (copy-keymap base-map)))
 623         (define-key map [up] 'org-priority-up)
 624         (define-key map [down] 'org-priority-down)
 625         (define-key map [right] 'org-todo)
 626         (orgpan-insert-field "TODO/priority" map
 627                              (concat R ": TODO, " U "/" D ": Priority")))
 628       )
 629     (insert "   ? for help, q quit\n")
 630     (orgpan-display-bindings-help)
 631     (set-keymap-parent orgpan-mode-map orgpan-with-keymap)
 632     ))
 633
 634 (defun orgpan-make-panel-buffer ()
 635   "Make the panel buffer."
 636   (let* ((buf-name "*Org Panel*"))
 637     (when orgpan-panel-buffer (kill-buffer orgpan-panel-buffer))
 638     ;;(with-current-buffer orgpan-panel-buffer (orgpan-mode))
 639     (setq orgpan-panel-buffer (get-buffer-create buf-name))
 640     (if orgpan-panel-buttons
 641         (orgpan-make-panel-with-buttons orgpan-panel-buffer)
 642       (orgpan-make-panel-without-buttons orgpan-panel-buffer))
 643     (with-current-buffer orgpan-panel-buffer
 644       (orgpan-mode)
 645       (goto-char (point-min)))
 646     orgpan-panel-buffer))
 647
 648 (defun orgpan-help ()
 649   (interactive)
 650   (set-keymap-parent orgpan-with-keymap nil)
 651   (set-keymap-parent orgpan-without-keymap nil)
 652   (describe-function 'orgpan-panel)
 653   (set-keymap-parent orgpan-with-keymap org-mode-map)
 654   (set-keymap-parent orgpan-without-keymap org-mode-map)
 655   (message "Use 'l' to get back to last viewed org file"))
 656
 657 (defcustom orgpan-panel-height 5
 658   "Panel height"
 659   :type '(choice (integer :tag "One line" 2)
 660                  (integer :tag "All lines" 5))
 661   :group 'orgpan)
 662
 663 (defun orgpan-panel ()
 664   "Create a control panel for current `org-mode' buffer.
 665 The control panel may be used to quickly move around and change
 666 the headings. The idea is that when you want to to a lot of this
 667 kind of editing you should be able to do that with few
 668 keystrokes (and without having to remember the complicated
 669 keystrokes). A typical situation when this perhaps can be useful
 670 is when you are looking at your notes file \(usually ~/.notes,
 671 see `remember-data-file') where you have saved quick notes with
 672 `remember'.
 673
 674 The keys below are defined in the panel. Note that the commands
 675 are carried out in the `org-mode' buffer that belongs to the
 676 panel.
 677
 678 \\{orgpan-mode-map}
 679
 680 In addition to the keys above most of the keys in `org-mode' can
 681 also be used from the panel.
 682
 683 Note: There are two forms of the control panel, one with buttons
 684 and one without. The default is without, see
 685 `orgpan-panel-buttons'.  If buttons are used choosing a different
 686 button changes the binding of the arrow keys."
 687   (interactive)
 688   (unless (derived-mode-p 'org-mode)
 689     (error "Buffer is not in org-mode"))
 690   (orgpan-delete-panel)
 691   (unless orgpan-org-mode-commands
 692     (map-keymap (lambda (ev def)
 693                   (when (and def
 694                              (symbolp def)
 695                              (fboundp def))
 696                     (setq orgpan-org-mode-commands
 697                           (cons def orgpan-org-mode-commands))))
 698                 org-mode-map))
 699   (remq 'org-self-insert-command orgpan-org-mode-commands)
 700   ;;(org-back-to-heading)
 701   ;;(remove-hook 'window-configuration-change-hook 'orgpan-window-config-change)
 702   (split-window)
 703   (if orgpan-panel-at-top
 704       (setq orgpan-org-window (next-window))
 705     (setq orgpan-org-window (selected-window))
 706     (select-window (next-window)))
 707   (set-window-buffer (selected-window) (orgpan-make-panel-buffer))
 708   (setq orgpan-panel-window (selected-window))
 709   (set-window-dedicated-p orgpan-panel-window t)
 710   (adjust-window-trailing-edge orgpan-org-window
 711                                (- (window-height) orgpan-panel-height)  nil)
 712   ;; The minor mode version starts here:
 713   (when orgpan-minor-mode-version
 714     (select-window orgpan-org-window)
 715     (orgpan-panel-minor-mode 1)
 716     (add-hook 'post-command-hook 'orgpan-minor-post-command t)))
 717
 718 (define-minor-mode orgpan-panel-minor-mode
 719   "Minor mode used in `org-mode' buffer when showing panel."
 720   :keymap orgpan-mode-map
 721   :lighter " PANEL"
 722   :group 'orgpan
 723   )
 724
 725 (defun orgpan-minor-post-command ()
 726   ;; Check org window and buffer
 727   (if (and (windowp orgpan-org-window)
 728            (window-live-p orgpan-org-window)
 729            (eq orgpan-org-window (selected-window))
 730            (derived-mode-p 'org-mode)
 731            ;; Check panel window and buffer
 732            (windowp orgpan-panel-window)
 733            (window-live-p orgpan-panel-window)
 734            (bufferp orgpan-panel-buffer)
 735            (buffer-live-p orgpan-panel-buffer)
 736            (eq (window-buffer orgpan-panel-window) orgpan-panel-buffer)
 737            ;; Check minor mode
 738            orgpan-panel-minor-mode)
 739       (setq cursor-type nil)
 740     (orgpan-delete-panel)))
 741
 742
 743 (provide 'org-panel)
 744 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 745 ;;; org-panel.el ends here