lisp/org-colview-xemacs.el

   1 ;;; org-colview-xemacs.el --- Column View in Org-mode, XEmacs-specific version
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
   7 ;; Keywords: outlines, hypermedia, calendar, wp
   8 ;; Homepage: http://orgmode.org
   9 ;; Version: 6.26b
  10 ;;
  11 ;; This file is part of GNU Emacs.
  12 ;;
  13 ;; GNU Emacs is free software; you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 3, or (at your option)
  16 ;; any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26 ;; Boston, MA 02110-1301, USA.
  27 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  28 ;;
  29 ;;; Commentary:
  30
  31 ;; This file contains the column view for Org.
  32
  33 ;;; Code:
  34
  35 (eval-when-compile (require 'cl))
  36 (require 'org)
  37
  38 (declare-function org-agenda-redo "org-agenda" ())
  39
  40
  41 ;;; Define additional faces for column view
  42
  43 (when (featurep 'xemacs)
  44
  45   (defface org-columns-level-1;; font-lock-function-name-face
  46     (org-compatible-face
  47         'outline-1
  48       '((((class color) (min-colors 88) (background light)) (:foreground "Blue1" :background "grey90"))
  49         (((class color) (min-colors 88) (background dark)) (:foreground "LightSkyBlue" :background "grey30"))
  50         (((class color) (min-colors 16) (background light)) (:foreground "Blue" :background "grey90"))
  51         (((class color) (min-colors 16) (background dark)) (:foreground "LightSkyBlue" :background "grey30"))
  52         (((class color) (min-colors 8)) (:foreground "blue" :bold t))
  53         (t (:bold t))))
  54     "Face used for columns-level 1 headlines."
  55     :group 'org-faces)
  56
  57   (defface org-columns-level-2;; font-lock-variable-name-face
  58     (org-compatible-face
  59         'outline-2
  60       '((((class color) (min-colors 16) (background light)) (:foreground "DarkGoldenrod" :background "grey90"))
  61         (((class color) (min-colors 16) (background dark))  (:foreground "LightGoldenrod" :background "grey30"))
  62         (((class color) (min-colors 8)  (background light)) (:foreground "yellow" :background "grey90"))
  63         (((class color) (min-colors 8)  (background dark))  (:foreground "yellow" :bold t))
  64         (t (:bold t))))
  65     "Face used for columns-level 2 headlines."
  66     :group 'org-faces)
  67
  68   (defface org-columns-level-3;; font-lock-keyword-face
  69     (org-compatible-face
  70         'outline-3
  71       '((((class color) (min-colors 88) (background light)) (:foreground "Purple" :background "grey90"))
  72         (((class color) (min-colors 88) (background dark))  (:foreground "Cyan1" :background "grey30"))
  73         (((class color) (min-colors 16) (background light)) (:foreground "Purple" :background "grey90"))
  74         (((class color) (min-colors 16) (background dark))  (:foreground "Cyan" :background "grey30"))
  75         (((class color) (min-colors 8)  (background light)) (:foreground "purple" :bold t))
  76         (((class color) (min-colors 8)  (background dark))  (:foreground "cyan" :bold t))
  77         (t (:bold t))))
  78     "Face used for columns-level 3 headlines."
  79     :group 'org-faces)
  80
  81   (defface org-columns-level-4;; font-lock-comment-face
  82     (org-compatible-face
  83         'outline-4
  84       '((((class color) (min-colors 88) (background light)) (:foreground "Firebrick" :background "grey90"))
  85         (((class color) (min-colors 88) (background dark))  (:foreground "chocolate1" :background "grey30"))
  86         (((class color) (min-colors 16) (background light)) (:foreground "red"))
  87         (((class color) (min-colors 16) (background dark))  (:foreground "red1"))
  88         (((class color) (min-colors 8) (background light))  (:foreground "red" :bold t))
  89         (((class color) (min-colors 8) (background dark))   (:foreground "red" :bold t))
  90         (t (:bold t))))
  91     "Face used for columns-level 4 headlines."
  92     :group 'org-faces)
  93
  94   (defface org-columns-level-5;; font-lock-type-face
  95     (org-compatible-face
  96         'outline-5
  97       '((((class color) (min-colors 16) (background light)) (:foreground "ForestGreen" :background "grey90"))
  98         (((class color) (min-colors 16) (background dark)) (:foreground "PaleGreen" :background "grey30"))
  99         (((class color) (min-colors 8)) (:foreground "green"))))
 100     "Face used for columns-level 5 headlines."
 101     :group 'org-faces)
 102
 103   (defface org-columns-level-6;; font-lock-constant-face
 104     (org-compatible-face
 105         'outline-6
 106       '((((class color) (min-colors 16) (background light)) (:foreground "CadetBlue" :background "grey90"))
 107         (((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine" :background "grey30"))
 108         (((class color) (min-colors 8)) (:foreground "magenta"))))
 109     "Face used for columns-level 6 headlines."
 110     :group 'org-faces)
 111
 112   (defface org-columns-level-7;; font-lock-builtin-face
 113     (org-compatible-face
 114         'outline-7
 115       '((((class color) (min-colors 16) (background light)) (:foreground "Orchid" :background "grey90"))
 116         (((class color) (min-colors 16) (background dark)) (:foreground "LightSteelBlue" :background "grey30"))
 117         (((class color) (min-colors 8)) (:foreground "blue"))))
 118     "Face used for columns-level 7 headlines."
 119     :group 'org-faces)
 120
 121   (defface org-columns-level-8;; font-lock-string-face
 122     (org-compatible-face
 123         'outline-8
 124       '((((class color) (min-colors 16) (background light)) (:foreground "RosyBrown" :background "grey90"))
 125         (((class color) (min-colors 16) (background dark)) (:foreground "LightSalmon" :background "grey30"))
 126         (((class color) (min-colors 8)) (:foreground "green"))))
 127     "Face used for columns-level 8 headlines."
 128     :group 'org-faces)
 129
 130
 131   (defface org-columns-space;; font-lock-function-name-face
 132     (org-compatible-face
 133         'outline-1
 134       '((((class color) (min-colors 88) (background light)) (:background "grey90"))
 135         (((class color) (min-colors 88) (background dark))  (:background "grey30"))
 136         (((class color) (min-colors 16) (background light)) (:background "grey90"))
 137         (((class color) (min-colors 16) (background dark)) (:background "grey30"))
 138         (((class color) (min-colors 8)) (:bold t :underline t))))
 139     "Face used for columns space headlines."
 140     :group 'org-faces)
 141
 142   (defface org-columns-space1;; font-lock-function-name-face
 143     (org-compatible-face
 144         'outline-1
 145       '((((class color) (min-colors 88) (background light)) (:background "grey90"))
 146         (((class color) (min-colors 88) (background dark))  (:background "grey30"))
 147         (((class color) (min-colors 16) (background light)) (:background "grey90"))
 148         (((class color) (min-colors 16) (background dark)) (:background "grey30"))
 149         (((class color) (min-colors 8)) (:bold t :underline t))))
 150     "Face used for columns space headlines."
 151     :group 'org-faces)
 152   )
 153
 154 (when (featurep 'xemacs)
 155   (defconst org-columns-level-faces
 156     '(org-columns-level-1
 157       org-columns-level-2 org-columns-level-3
 158       org-columns-level-4 org-columns-level-5 org-columns-level-6
 159       org-columns-level-7 org-columns-level-8
 160       ))
 161
 162   (defun org-get-columns-level-face (n)
 163     "Get the right face for match N in font-lock matching of headlines."
 164     (setq org-l (- (match-end 2) (match-beginning 1) 1))
 165     (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
 166     (setq org-f (nth (% (1- org-l) org-n-level-faces) org-columns-level-faces))
 167     (cond
 168      ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
 169      ((eq n 2) org-f)
 170      (t (if org-level-color-stars-only nil org-f))))
 171   )
 172
 173
 174 ;;; Column View
 175
 176 (defvar org-columns-overlays nil
 177   "Holds the list of current column overlays.")
 178
 179 (defvar org-columns-current-fmt nil
 180   "Local variable, holds the currently active column format.")
 181 (make-variable-buffer-local 'org-columns-current-fmt)
 182 (defvar org-columns-current-fmt-compiled nil
 183   "Local variable, holds the currently active column format.
 184 This is the compiled version of the format.")
 185 (make-variable-buffer-local 'org-columns-current-fmt-compiled)
 186 (defvar org-columns-current-widths nil
 187   "Loval variable, holds the currently widths of fields.")
 188 (make-variable-buffer-local 'org-columns-current-widths)
 189 (defvar org-columns-current-maxwidths nil
 190   "Loval variable, holds the currently active maximum column widths.")
 191 (make-variable-buffer-local 'org-columns-current-maxwidths)
 192 (defvar org-columns-begin-marker (make-marker)
 193   "Points to the position where last a column creation command was called.")
 194 (defvar org-columns-top-level-marker (make-marker)
 195   "Points to the position where current columns region starts.")
 196
 197 (defvar org-columns-map (make-sparse-keymap)
 198   "The keymap valid in column display.")
 199
 200 (defun org-columns-content ()
 201   "Switch to contents view while in columns view."
 202   (interactive)
 203   (org-overview)
 204   (org-content))
 205
 206 (org-defkey org-columns-map "c" 'org-columns-content)
 207 (org-defkey org-columns-map "o" 'org-overview)
 208 (org-defkey org-columns-map "e" 'org-columns-edit-value)
 209 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
 210 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
 211 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
 212 (org-defkey org-columns-map "v" 'org-columns-show-value)
 213 (org-defkey org-columns-map "q" 'org-columns-quit)
 214 (org-defkey org-columns-map "r" 'org-columns-redo)
 215 (org-defkey org-columns-map "g" 'org-columns-redo)
 216 (org-defkey org-columns-map [left] 'org-columns-backward-char)
 217 (org-defkey org-columns-map "\M-b" 'org-columns-backward-char)
 218 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
 219 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
 220 (org-defkey org-columns-map "\M-f" 'org-columns-forward-char)
 221 (org-defkey org-columns-map [right] 'org-columns-forward-char)
 222 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
 223 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
 224 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
 225 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
 226 (org-defkey org-columns-map "<" 'org-columns-narrow)
 227 (org-defkey org-columns-map ">" 'org-columns-widen)
 228 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
 229 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
 230 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
 231 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
 232 (dotimes (i 10)
 233   (org-defkey org-columns-map (number-to-string i)
 234               `(lambda () (interactive)
 235                  (org-columns-next-allowed-value nil ,i))))
 236
 237 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
 238   '("Column"
 239     ["Edit property" org-columns-edit-value t]
 240     ["Next allowed value" org-columns-next-allowed-value t]
 241     ["Previous allowed value" org-columns-previous-allowed-value t]
 242     ["Show full value" org-columns-show-value t]
 243     ["Edit allowed values" org-columns-edit-allowed t]
 244     "--"
 245     ["Edit column attributes" org-columns-edit-attributes t]
 246     ["Increase column width" org-columns-widen t]
 247     ["Decrease column width" org-columns-narrow t]
 248     "--"
 249     ["Move column right" org-columns-move-right t]
 250     ["Move column left" org-columns-move-left t]
 251     ["Add column" org-columns-new t]
 252     ["Delete column" org-columns-delete t]
 253     "--"
 254     ["CONTENTS" org-columns-content t]
 255     ["OVERVIEW" org-overview t]
 256     ["Refresh columns display" org-columns-redo t]
 257     "--"
 258     ["Open link" org-columns-open-link t]
 259     "--"
 260     ["Quit" org-columns-quit t]))
 261
 262 (defun org-columns-current-column ()
 263   (if (featurep 'xemacs)
 264       (/ (current-column) 2)
 265     (current-column)))
 266
 267 (defun org-columns-forward-char ()
 268   (interactive)
 269   (forward-char)
 270   (if (featurep 'xemacs)
 271       (while (not (or (eolp)
 272                       (member (extent-at
 273                                (point) (current-buffer)
 274                                'org-columns-key) org-columns-overlays)))
 275         (forward-char))))
 276
 277 (defun org-columns-backward-char ()
 278   (interactive)
 279   (backward-char)
 280   (if (featurep 'xemacs)
 281       (while (not (or (bolp)
 282                       (member (extent-at (point) (current-buffer) 'org-columns-key) org-columns-overlays)))
 283         (backward-char))))
 284
 285 (defun org-columns-new-overlay (beg end &optional string face)
 286   "Create a new column overlay and add it to the list."
 287   (let ((ov (org-make-overlay beg end)))
 288     (if (featurep 'xemacs)
 289         (progn
 290           (org-overlay-put ov 'face (or face 'org-columns-space1))
 291           (org-overlay-put ov 'start-open t)
 292           (if string
 293               (org-overlay-display ov string (or face 'org-columns-space1))))
 294       (org-overlay-put ov 'face (or face 'secondary-selection))
 295       (org-overlay-display ov string face))
 296     (push ov org-columns-overlays)
 297     ov))
 298
 299 (defun org-columns-display-here (&optional props)
 300   "Overlay the current line with column display."
 301   (interactive)
 302   (let* ((fmt org-columns-current-fmt-compiled)
 303          (beg (point-at-bol))
 304          (level-face (save-excursion
 305                        (beginning-of-line 1)
 306                        (and (looking-at "\\(\\**\\)\\(\\* \\)")
 307                             (org-get-level-face 2))))
 308          (item (save-match-data
 309                  (org-no-properties
 310                   (org-remove-tabs
 311                    (buffer-substring-no-properties
 312                     (point-at-bol) (point-at-eol))))))
 313          (color (if (featurep 'xemacs)
 314                     (save-excursion
 315                       (beginning-of-line 1)
 316                       (and (looking-at "\\(\\**\\)\\(\\* \\)")
 317                            (org-get-columns-level-face 2)))
 318                   (list :foreground
 319                         (face-attribute
 320                          (or level-face
 321                              (and (eq major-mode 'org-agenda-mode)
 322                                   (get-text-property (point-at-bol) 'face))
 323                              'default) :foreground))))
 324          (face (if (featurep 'xemacs) color (list color 'org-column)))
 325          (pl (or (get-text-property (point-at-bol) 'prefix-length) 0))
 326          (cphr (get-text-property (point-at-bol) 'org-complex-heading-regexp))
 327          pom property ass width f string ov column val modval s2 title)
 328     ;; Check if the entry is in another buffer.
 329     (unless props
 330       (if (eq major-mode 'org-agenda-mode)
 331           (setq pom (or (get-text-property (point) 'org-hd-marker)
 332                         (get-text-property (point) 'org-marker))
 333                 props (if pom (org-entry-properties pom) nil))
 334         (setq props (org-entry-properties nil))))
 335     ;; Walk the format
 336     (while (setq column (pop fmt))
 337       (setq property (car column)
 338             title (nth 1 column)
 339             ass (if (equal property "ITEM")
 340                     (cons "ITEM" item)
 341                   (assoc property props))
 342             width (or (cdr (assoc property org-columns-current-maxwidths))
 343                       (nth 2 column)
 344                       (length property))
 345             f (format (if (featurep 'xemacs) "%%-%d.%ds |" "%%-%d.%ds | ")
 346                       width width)
 347             val (or (cdr ass) "")
 348             modval (or (and org-columns-modify-value-for-display-function
 349                             (functionp
 350                              org-columns-modify-value-for-display-function)
 351                             (funcall
 352                              org-columns-modify-value-for-display-function
 353                              title val))
 354                        (if (equal property "ITEM")
 355                            (if (org-mode-p)
 356                                (org-columns-cleanup-item
 357                                 val org-columns-current-fmt-compiled)
 358                              (org-agenda-columns-cleanup-item
 359                               val pl cphr org-columns-current-fmt-compiled)))))
 360       (setq s2 (org-columns-add-ellipses (or modval val) width))
 361       (setq string (format f s2))
 362       ;; Create the overlay
 363       (org-unmodified
 364        (setq ov (org-columns-new-overlay
 365                  beg (setq beg (1+ beg)) string face))
 366        (org-overlay-put ov 'keymap org-columns-map)
 367        (org-overlay-put ov 'org-columns-key property)
 368        (org-overlay-put ov 'org-columns-value (cdr ass))
 369        (org-overlay-put ov 'org-columns-value-modified modval)
 370        (org-overlay-put ov 'org-columns-pom pom)
 371        (org-overlay-put ov 'org-columns-format f)
 372        (when (featurep 'xemacs)
 373          (if (or (not (char-after beg))
 374                  (equal (char-after beg) ?\n))
 375              (let ((inhibit-read-only t))
 376                (save-excursion
 377                  (goto-char beg)
 378                  (org-unmodified (insert " "))
 379                  ;; FIXME: add props and remove later?
 380                  )))
 381          (goto-char beg)
 382          (org-columns-new-overlay
 383           beg (1+ beg) nil 'org-columns-space)
 384          (setq beg (1+ beg))))
 385
 386       (if (or (not (char-after beg))
 387               (equal (char-after beg) ?\n))
 388           (let ((inhibit-read-only t))
 389             (save-excursion
 390               (goto-char beg)
 391               ;; FIXME: add props and remove later?
 392               (org-unmodified (insert " "))))))
 393     ;; Make the rest of the line disappear.
 394     (org-unmodified
 395      (setq ov (org-columns-new-overlay beg (point-at-eol)))
 396      (org-overlay-put ov 'invisible t)
 397      (org-overlay-put ov 'keymap org-columns-map)
 398      (org-overlay-put ov 'intangible t)
 399      (push ov org-columns-overlays)
 400      (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
 401      (org-overlay-put ov 'keymap org-columns-map)
 402      (push ov org-columns-overlays)
 403      (let ((inhibit-read-only t))
 404        (put-text-property (max (point-min) (1- (point-at-bol)))
 405                           (min (point-max) (1+ (point-at-eol)))
 406                           'read-only "Type `e' to edit property")))))
 407
 408 (defun org-columns-add-ellipses (string width)
 409   "Truncate STRING with WIDTH characters, with ellipses."
 410   (cond
 411    ((<= (length string) width) string)
 412    ((<= width (length org-columns-ellipses))
 413     (substring org-columns-ellipses 0 width))
 414    (t (concat (substring string 0 (- width (length org-columns-ellipses)))
 415               org-columns-ellipses))))
 416
 417 (defvar org-columns-full-header-line-format nil
 418   "The full header line format, will be shifted by horizontal scrolling." )
 419 (defvar org-previous-header-line-format nil
 420   "The header line format before column view was turned on.")
 421 (defvar org-columns-inhibit-recalculation nil
 422   "Inhibit recomputing of columns on column view startup.")
 423
 424
 425 (defvar header-line-format)
 426 (defvar org-columns-previous-hscroll 0)
 427 (defun org-columns-display-here-title ()
 428   "Overlay the newline before the current line with the table title."
 429   (interactive)
 430   (let ((fmt org-columns-current-fmt-compiled)
 431         string (title "")
 432         property width f column str widths)
 433     (while (setq column (pop fmt))
 434       (setq property (car column)
 435             str (or (nth 1 column) property)
 436             width (or (cdr (assoc property org-columns-current-maxwidths))
 437                       (nth 2 column)
 438                       (length str))
 439             widths (push width widths)
 440             f (format "%%-%d.%ds | " width width)
 441             string (format f str)
 442             title (concat title string)))
 443     (if (featurep 'xemacs)
 444         (let ((ext (make-extent nil nil)))
 445           (set-extent-endpoints ext 0 (length title) title)
 446           (set-extent-face ext (list 'bold 'underline 'org-columns-space1))
 447           (org-set-local 'org-previous-header-line-format
 448                          (specifier-specs top-gutter))
 449           (org-set-local 'org-columns-current-widths (nreverse widths))
 450           (set-specifier top-gutter (make-gutter-specifier
 451                                      (cons (current-buffer) title))))
 452       (setq title (concat
 453                    (org-add-props " " nil 'display '(space :align-to 0))
 454                    (org-add-props title nil 'face '(:weight bold :underline t))))
 455       (org-set-local 'org-previous-header-line-format header-line-format)
 456       (org-set-local 'org-columns-current-widths (nreverse widths))
 457       (setq org-columns-full-header-line-format title)
 458       (setq org-columns-previous-hscroll -1)
 459       (org-add-hook 'post-command-hook 'org-columns-hscoll-title nil 'local))))
 460
 461 (defun org-columns-hscoll-title ()
 462   "Set the header-line-format so that it scrolls along with the table."
 463   (sit-for .0001) ; need to force a redisplay to update window-hscroll
 464   (when (not (= (window-hscroll) org-columns-previous-hscroll))
 465     (setq header-line-format
 466           (concat (substring org-columns-full-header-line-format 0 1)
 467                   (substring org-columns-full-header-line-format
 468                              (1+ (window-hscroll))))
 469           org-columns-previous-hscroll (window-hscroll))
 470     (force-mode-line-update)))
 471
 472 (defvar org-colview-initial-truncate-line-value nil
 473   "Remember the value of `truncate-lines' across colview.")
 474
 475 (defun org-columns-remove-overlays ()
 476   "Remove all currently active column overlays."
 477   (interactive)
 478   (when (marker-buffer org-columns-begin-marker)
 479     (with-current-buffer (marker-buffer org-columns-begin-marker)
 480       (when (local-variable-p 'org-previous-header-line-format (current-buffer))
 481         (if (featurep 'xemacs)
 482             (set-specifier top-gutter
 483                            (make-gutter-specifier
 484                             (cons (current-buffer)
 485                                   (cdar org-previous-header-line-format))))
 486           (setq header-line-format org-previous-header-line-format)
 487           (remove-hook 'post-command-hook 'org-columns-hscoll-title 'local))
 488         (kill-local-variable 'org-previous-header-line-format))
 489       (move-marker org-columns-begin-marker nil)
 490       (move-marker org-columns-top-level-marker nil)
 491       (org-unmodified
 492        (mapc 'org-delete-overlay org-columns-overlays)
 493        (setq org-columns-overlays nil)
 494        (let ((inhibit-read-only t))
 495          (remove-text-properties (point-min) (point-max) '(read-only t))))
 496       (when (local-variable-p 'org-colview-initial-truncate-line-value)
 497         (setq truncate-lines org-colview-initial-truncate-line-value)))))
 498
 499
 500 (defun org-columns-cleanup-item (item fmt)
 501   "Remove from ITEM what is a column in the format FMT."
 502   (if (not org-complex-heading-regexp)
 503       item
 504     (when (string-match org-complex-heading-regexp item)
 505       (setq item
 506             (concat
 507              (org-add-props (match-string 1 item) nil
 508                'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
 509              (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
 510              (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
 511              " " (save-match-data (org-columns-compact-links (match-string 4 item)))
 512              (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))
 513       (add-text-properties
 514        0 (1+ (match-end 1))
 515        (list 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
 516        item)
 517       item)))
 518
 519 (defun org-columns-compact-links (s)
 520   "Replace [[link][desc]] with [desc] or [link]."
 521   (while (string-match org-bracket-link-regexp s)
 522     (setq s (replace-match
 523              (concat "[" (match-string (if (match-end 3) 3 1) s) "]")
 524              t t s)))
 525   s)
 526
 527 (defvar org-agenda-columns-remove-prefix-from-item)
 528 (defun org-agenda-columns-cleanup-item (item pl cphr fmt)
 529   "Cleanup the time property for agenda column view.
 530 See also the variable `org-agenda-columns-remove-prefix-from-item'."
 531   (let* ((org-complex-heading-regexp cphr)
 532          (prefix (substring item 0 pl))
 533          (rest (substring item pl))
 534          (fake (concat "* " rest))
 535          (cleaned (org-trim (substring (org-columns-cleanup-item fake fmt) 1))))
 536     (if org-agenda-columns-remove-prefix-from-item
 537         cleaned
 538       (concat prefix cleaned))))
 539
 540 (defun org-columns-show-value ()
 541   "Show the full value of the property."
 542   (interactive)
 543   (let ((value (get-char-property (point) 'org-columns-value)))
 544     (message "Value is: %s" (or value ""))))
 545
 546 (defvar org-agenda-columns-active) ;; defined in org-agenda.el
 547 (defun org-columns-quit ()
 548   "Remove the column overlays and in this way exit column editing."
 549   (interactive)
 550   (org-unmodified
 551    (org-columns-remove-overlays)
 552    (let ((inhibit-read-only t))
 553      (remove-text-properties (point-min) (point-max) '(read-only t))))
 554   (when (eq major-mode 'org-agenda-mode)
 555     (setq org-agenda-columns-active nil)
 556     (message
 557      "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
 558
 559 (defun org-columns-check-computed ()
 560   "Check if this column value is computed.
 561 If yes, throw an error indicating that changing it does not make sense."
 562   (let ((val (get-char-property (point) 'org-columns-value)))
 563     (when (and (stringp val)
 564                (get-char-property 0 'org-computed val))
 565       (error "This value is computed from the entry's children"))))
 566
 567 (defun org-columns-todo (&optional arg)
 568   "Change the TODO state during column view."
 569   (interactive "P")
 570   (org-columns-edit-value "TODO"))
 571
 572 (defun org-columns-set-tags-or-toggle (&optional arg)
 573   "Toggle checkbox at point, or set tags for current headline."
 574   (interactive "P")
 575   (if (string-match "\\`\\[[ xX-]\\]\\'"
 576                     (get-char-property (point) 'org-columns-value))
 577       (org-columns-next-allowed-value)
 578     (org-columns-edit-value "TAGS")))
 579
 580 (defun org-columns-edit-value (&optional key)
 581   "Edit the value of the property at point in column view.
 582 Where possible, use the standard interface for changing this line."
 583   (interactive)
 584   (org-columns-check-computed)
 585   (let* ((col (current-column))
 586          (key (or key (get-char-property (point) 'org-columns-key)))
 587          (value (get-char-property (point) 'org-columns-value))
 588          (bol (point-at-bol)) (eol (point-at-eol))
 589          (pom (or (get-text-property bol 'org-hd-marker)
 590                   (point))) ; keep despite of compiler warning
 591          (line-overlays
 592           (delq nil (mapcar (lambda (x)
 593                               (and (eq (org-overlay-buffer x) (current-buffer))
 594                                    (>= (org-overlay-start x) bol)
 595                                    (<= (org-overlay-start x) eol)
 596                                    x))
 597                             org-columns-overlays)))
 598          nval eval allowed)
 599     (cond
 600      ((equal key "CLOCKSUM")
 601       (error "This special column cannot be edited"))
 602      ((equal key "ITEM")
 603       (setq eval '(org-with-point-at pom (org-edit-headline))))
 604      ((equal key "TODO")
 605       (setq eval '(org-with-point-at
 606                    pom
 607                    (call-interactively 'org-todo))))
 608      ((equal key "PRIORITY")
 609       (setq eval '(org-with-point-at pom
 610                                      (call-interactively 'org-priority))))
 611      ((equal key "TAGS")
 612       (setq eval '(org-with-point-at
 613                    pom
 614                    (let ((org-fast-tag-selection-single-key
 615                           (if (eq org-fast-tag-selection-single-key 'expert)
 616                               t org-fast-tag-selection-single-key)))
 617                      (call-interactively 'org-set-tags)))))
 618      ((equal key "DEADLINE")
 619       (setq eval '(org-with-point-at
 620                    pom
 621                    (call-interactively 'org-deadline))))
 622      ((equal key "SCHEDULED")
 623       (setq eval '(org-with-point-at
 624                    pom
 625                    (call-interactively 'org-schedule))))
 626      (t
 627       (setq allowed (org-property-get-allowed-values pom key 'table))
 628       (if allowed
 629           (setq nval (org-ido-completing-read "Value: " allowed nil t))
 630         (setq nval (read-string "Edit: " value)))
 631       (setq nval (org-trim nval))
 632       (when (not (equal nval value))
 633         (setq eval '(org-entry-put pom key nval)))))
 634     (when eval
 635
 636       (cond
 637        ((equal major-mode 'org-agenda-mode)
 638         (org-columns-eval eval)
 639         ;; The following let preserves the current format, and makes sure
 640         ;; that in only a single file things need to be upated.
 641         (let* ((org-agenda-overriding-columns-format org-columns-current-fmt)
 642                (buffer (marker-buffer pom))
 643                (org-agenda-contributing-files
 644                 (list (with-current-buffer buffer
 645                         (buffer-file-name (buffer-base-buffer))))))
 646           (org-agenda-columns)))
 647        (t
 648         (let ((inhibit-read-only t))
 649           (org-unmodified
 650            (remove-text-properties
 651             (max (point-min) (1- bol)) eol '(read-only t)))
 652           (unwind-protect
 653               (progn
 654                 (setq org-columns-overlays
 655                       (org-delete-all line-overlays org-columns-overlays))
 656                 (mapc 'org-delete-overlay line-overlays)
 657                 (org-columns-eval eval))
 658             (org-columns-display-here)))
 659         (org-move-to-column col)
 660         (if (and (org-mode-p)
 661                  (nth 3 (assoc key org-columns-current-fmt-compiled)))
 662             (org-columns-update key)))))))
 663
 664 (defun org-edit-headline () ; FIXME: this is not columns specific.  Make interactive?????  Use from agenda????
 665   "Edit the current headline, the part without TODO keyword, TAGS."
 666   (org-back-to-heading)
 667   (when (looking-at org-todo-line-regexp)
 668     (let ((pos (point))
 669           (pre (buffer-substring (match-beginning 0) (match-beginning 3)))
 670           (txt (match-string 3))
 671           (post "")
 672           txt2)
 673       (if (string-match (org-re "[ \t]+:[[:alnum:]:_@]+:[ \t]*$") txt)
 674           (setq post (match-string 0 txt)
 675                 txt (substring txt 0 (match-beginning 0))))
 676       (setq txt2 (read-string "Edit: " txt))
 677       (when (not (equal txt txt2))
 678         (goto-char pos)
 679         (insert pre txt2 post)
 680         (delete-region (point) (point-at-eol))
 681         (org-set-tags nil t)))))
 682
 683 (defun org-columns-edit-allowed ()
 684   "Edit the list of allowed values for the current property."
 685   (interactive)
 686   (let* ((pom (or (get-text-property (point-at-bol) 'org-marker)
 687                   (get-text-property (point-at-bol) 'org-hd-marker)
 688                   (point)))
 689          (key (get-char-property (point) 'org-columns-key))
 690          (key1 (concat key "_ALL"))
 691          (allowed (org-entry-get pom key1 t))
 692          nval)
 693     ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
 694     ;; FIXME: Write back to #+PROPERTY setting if that is needed.
 695     (setq nval (read-string "Allowed: " allowed))
 696     (org-entry-put
 697      (cond ((marker-position org-entry-property-inherited-from)
 698             org-entry-property-inherited-from)
 699            ((marker-position org-columns-top-level-marker)
 700             org-columns-top-level-marker)
 701            (t pom))
 702      key1 nval)))
 703
 704 (defun org-columns-eval (form)
 705   (let (hidep)
 706     (save-excursion
 707       (beginning-of-line 1)
 708       ;; `next-line' is needed here, because it skips invisible line.
 709       (condition-case nil (org-no-warnings (next-line 1)) (error nil))
 710       (setq hidep (org-on-heading-p 1)))
 711     (eval form)
 712     (and hidep (hide-entry))))
 713
 714 (defun org-columns-previous-allowed-value ()
 715   "Switch to the previous allowed value for this column."
 716   (interactive)
 717   (org-columns-next-allowed-value t))
 718
 719 (defun org-columns-next-allowed-value (&optional previous nth)
 720   "Switch to the next allowed value for this column.
 721 When PREVIOUS is set, go to the previous value.  When NTH is
 722 an integer, select that value."
 723   (interactive)
 724   (org-columns-check-computed)
 725   (let* ((col (current-column))
 726          (key (get-char-property (point) 'org-columns-key))
 727          (value (get-char-property (point) 'org-columns-value))
 728          (bol (point-at-bol)) (eol (point-at-eol))
 729          (pom (or (get-text-property bol 'org-hd-marker)
 730                   (point))) ; keep despite of compiler waring
 731          (line-overlays
 732           (delq nil (mapcar (lambda (x)
 733                               (and (eq (org-overlay-buffer x) (current-buffer))
 734                                    (>= (org-overlay-start x) bol)
 735                                    (<= (org-overlay-start x) eol)
 736                                    x))
 737                             org-columns-overlays)))
 738          (allowed (or (org-property-get-allowed-values pom key)
 739                       (and (memq
 740                             (nth 4 (assoc key org-columns-current-fmt-compiled))
 741                             '(checkbox checkbox-n-of-m checkbox-percent))
 742                            '("[ ]" "[X]"))
 743                       (org-colview-construct-allowed-dates value)))
 744          nval)
 745     (when (integerp nth)
 746       (setq nth (1- nth))
 747       (if (= nth -1) (setq nth 9)))
 748     (when (equal key "ITEM")
 749       (error "Cannot edit item headline from here"))
 750     (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
 751       (error "Allowed values for this property have not been defined"))
 752     (if (member key '("SCHEDULED" "DEADLINE"))
 753         (setq nval (if previous 'earlier 'later))
 754       (if previous (setq allowed (reverse allowed)))
 755       (cond
 756        (nth
 757         (setq nval (nth nth allowed))
 758         (if (not nval)
 759             (error "There are only %d allowed values for property `%s'"
 760                    (length allowed) key)))
 761        ((member value allowed)
 762         (setq nval (or (car (cdr (member value allowed)))
 763                        (car allowed)))
 764         (if (equal nval value)
 765             (error "Only one allowed value for this property")))
 766        (t (setq nval (car allowed)))))
 767     (cond
 768      ((equal major-mode 'org-agenda-mode)
 769       (org-columns-eval '(org-entry-put pom key nval))
 770       ;; The following let preserves the current format, and makes sure
 771       ;; that in only a single file things need to be upated.
 772       (let* ((org-agenda-overriding-columns-format org-columns-current-fmt)
 773              (buffer (marker-buffer pom))
 774              (org-agenda-contributing-files
 775               (list (with-current-buffer buffer
 776                       (buffer-file-name (buffer-base-buffer))))))
 777         (org-agenda-columns)))
 778      (t
 779       (let ((inhibit-read-only t))
 780         (remove-text-properties (1- bol) eol '(read-only t))
 781         (unwind-protect
 782             (progn
 783               (setq org-columns-overlays
 784                     (org-delete-all line-overlays org-columns-overlays))
 785               (mapc 'org-delete-overlay line-overlays)
 786               (org-columns-eval '(org-entry-put pom key nval)))
 787           (org-columns-display-here)))
 788       (org-move-to-column col)
 789       (and (nth 3 (assoc key org-columns-current-fmt-compiled))
 790            (org-columns-update key))))))
 791
 792 (defun org-colview-construct-allowed-dates (s)
 793   "Construct a list of three dates around the date in S.
 794 This respects the format of the time stamp in S, active or non-active,
 795 and also including time or not.  S must be just a time stamp, no text
 796 around it."
 797   (when (and s (string-match (concat "^" org-ts-regexp3 "$") s))
 798     (let* ((time (org-parse-time-string s 'nodefaults))
 799            (active (equal (string-to-char s) ?<))
 800            (fmt (funcall (if (nth 1 time) 'cdr 'car) org-time-stamp-formats))
 801            time-before time-after)
 802       (unless active (setq fmt (concat "[" (substring fmt 1 -1) "]")))
 803       (setf (car time) (or (car time) 0))
 804       (setf (nth 1 time) (or (nth 1 time) 0))
 805       (setf (nth 2 time) (or (nth 2 time) 0))
 806       (setq time-before (copy-sequence time))
 807       (setq time-after (copy-sequence time))
 808       (setf (nth 3 time-before) (1- (nth 3 time)))
 809       (setf (nth 3 time-after) (1+ (nth 3 time)))
 810       (mapcar (lambda (x) (format-time-string fmt (apply 'encode-time x)))
 811               (list time-before time time-after)))))
 812
 813 (defun org-verify-version (task)
 814   (cond
 815    ((eq task 'columns)
 816     (if (or (and (featurep 'xemacs) (not (featurep 'org-colview-xemacs)))
 817             (and (not (featurep 'xemacs)) (< emacs-major-version 22)))
 818         (error "This version of Emacs cannot run Column View")))))
 819
 820 (defun org-columns-open-link (&optional arg)
 821   (interactive "P")
 822   (let ((value (get-char-property (point) 'org-columns-value)))
 823     (org-open-link-from-string value arg)))
 824
 825 (defun org-columns-get-format-and-top-level ()
 826   (let (fmt)
 827     (when (condition-case nil (org-back-to-heading) (error nil))
 828       (setq fmt (org-entry-get nil "COLUMNS" t)))
 829     (setq fmt (or fmt org-columns-default-format))
 830     (org-set-local 'org-columns-current-fmt fmt)
 831     (org-columns-compile-format fmt)
 832     (if (marker-position org-entry-property-inherited-from)
 833         (move-marker org-columns-top-level-marker
 834                      org-entry-property-inherited-from)
 835       (move-marker org-columns-top-level-marker (point)))
 836     fmt))
 837
 838 (defun org-columns ()
 839   "Turn on column view on an org-mode file."
 840   (interactive)
 841   (org-verify-version 'columns)
 842   (when (featurep 'xemacs)
 843     (set-face-foreground 'org-columns-space
 844                          (face-background 'org-columns-space)))
 845   (org-columns-remove-overlays)
 846   (move-marker org-columns-begin-marker (point))
 847   (let (beg end fmt cache maxwidths)
 848     (setq fmt (org-columns-get-format-and-top-level))
 849     (save-excursion
 850       (goto-char org-columns-top-level-marker)
 851       (setq beg (point))
 852       (unless org-columns-inhibit-recalculation
 853         (org-columns-compute-all))
 854       (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
 855                     (point-max)))
 856       ;; Get and cache the properties
 857       (goto-char beg)
 858       (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
 859         (save-excursion
 860           (save-restriction
 861             (narrow-to-region beg end)
 862             (org-clock-sum))))
 863       (while (re-search-forward (concat "^" outline-regexp) end t)
 864         (if (and org-columns-skip-arrchived-trees
 865                  (looking-at (concat ".*:" org-archive-tag ":")))
 866             (org-end-of-subtree t)
 867           (push (cons (org-current-line) (org-entry-properties)) cache)))
 868       (when cache
 869         (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
 870         (org-set-local 'org-columns-current-maxwidths maxwidths)
 871         (org-columns-display-here-title)
 872         (unless (local-variable-p 'org-colview-initial-truncate-line-value)
 873           (org-set-local 'org-colview-initial-truncate-line-value
 874                          truncate-lines))
 875         (setq truncate-lines t)
 876         (mapc (lambda (x)
 877                 (goto-line (car x))
 878                 (org-columns-display-here (cdr x)))
 879               cache)))))
 880
 881 (defun org-columns-new (&optional prop title width op fmt &rest rest)
 882   "Insert a new column, to the left of the current column."
 883   (interactive)
 884   (let ((n (org-columns-current-column))
 885         (editp (and prop (assoc prop org-columns-current-fmt-compiled)))
 886         cell)
 887     (setq prop (org-ido-completing-read
 888                 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
 889                 nil nil prop))
 890     (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
 891     (setq width (read-string "Column width: " (if width (number-to-string width))))
 892     (if (string-match "\\S-" width)
 893         (setq width (string-to-number width))
 894       (setq width nil))
 895     (setq fmt (org-ido-completing-read "Summary [none]: "
 896                                '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
 897                                nil t))
 898     (if (string-match "\\S-" fmt)
 899         (setq fmt (intern fmt))
 900       (setq fmt nil))
 901     (if (eq fmt 'none) (setq fmt nil))
 902     (if editp
 903         (progn
 904           (setcar editp prop)
 905           (setcdr editp (list title width nil fmt)))
 906       (setq cell (nthcdr (1- n) org-columns-current-fmt-compiled))
 907       (setcdr cell (cons (list prop title width nil fmt)
 908                          (cdr cell))))
 909     (org-columns-store-format)
 910     (org-columns-redo)))
 911
 912 (defun org-columns-delete ()
 913   "Delete the column at point from columns view."
 914   (interactive)
 915   (let* ((n (org-columns-current-column))
 916          (title (nth 1 (nth n org-columns-current-fmt-compiled))))
 917     (when (y-or-n-p
 918            (format "Are you sure you want to remove column \"%s\"? " title))
 919       (setq org-columns-current-fmt-compiled
 920             (delq (nth n org-columns-current-fmt-compiled)
 921                   org-columns-current-fmt-compiled))
 922       (org-columns-store-format)
 923       (org-columns-redo)
 924       (if (>= (org-columns-current-column)
 925               (length org-columns-current-fmt-compiled))
 926           (org-columns-backward-char)))))
 927
 928 (defun org-columns-edit-attributes ()
 929   "Edit the attributes of the current column."
 930   (interactive)
 931   (let* ((n (org-columns-current-column))
 932          (info (nth n org-columns-current-fmt-compiled)))
 933     (apply 'org-columns-new info)))
 934
 935 (defun org-columns-widen (arg)
 936   "Make the column wider by ARG characters."
 937   (interactive "p")
 938   (let* ((n (org-columns-current-column))
 939          (entry (nth n org-columns-current-fmt-compiled))
 940          (width (or (nth 2 entry)
 941                     (cdr (assoc (car entry) org-columns-current-maxwidths)))))
 942     (setq width (max 1 (+ width arg)))
 943     (setcar (nthcdr 2 entry) width)
 944     (org-columns-store-format)
 945     (org-columns-redo)))
 946
 947 (defun org-columns-narrow (arg)
 948   "Make the column narrower by ARG characters."
 949   (interactive "p")
 950   (org-columns-widen (- arg)))
 951
 952 (defun org-columns-move-right ()
 953   "Swap this column with the one to the right."
 954   (interactive)
 955   (let* ((n (org-columns-current-column))
 956          (cell (nthcdr n org-columns-current-fmt-compiled))
 957          e)
 958     (when (>= n (1- (length org-columns-current-fmt-compiled)))
 959       (error "Cannot shift this column further to the right"))
 960     (setq e (car cell))
 961     (setcar cell (car (cdr cell)))
 962     (setcdr cell (cons e (cdr (cdr cell))))
 963     (org-columns-store-format)
 964     (org-columns-redo)
 965     (org-columns-forward-char)))
 966
 967 (defun org-columns-move-left ()
 968   "Swap this column with the one to the left."
 969   (interactive)
 970   (let* ((n (org-columns-current-column)))
 971     (when (= n 0)
 972       (error "Cannot shift this column further to the left"))
 973     (org-columns-backward-char)
 974     (org-columns-move-right)
 975     (org-columns-backward-char)))
 976
 977 (defun org-columns-store-format ()
 978   "Store the text version of the current columns format in appropriate place.
 979 This is either in the COLUMNS property of the node starting the current column
 980 display, or in the #+COLUMNS line of the current buffer."
 981   (let (fmt (cnt 0))
 982     (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
 983     (org-set-local 'org-columns-current-fmt fmt)
 984     (if (marker-position org-columns-top-level-marker)
 985         (save-excursion
 986           (goto-char org-columns-top-level-marker)
 987           (if (and (org-at-heading-p)
 988                    (org-entry-get nil "COLUMNS"))
 989               (org-entry-put nil "COLUMNS" fmt)
 990             (goto-char (point-min))
 991             ;; Overwrite all #+COLUMNS lines....
 992             (while (re-search-forward "^#\\+COLUMNS:.*" nil t)
 993               (setq cnt (1+ cnt))
 994               (replace-match (concat "#+COLUMNS: " fmt) t t))
 995             (unless (> cnt 0)
 996               (goto-char (point-min))
 997               (or (org-on-heading-p t) (outline-next-heading))
 998               (let ((inhibit-read-only t))
 999                 (insert-before-markers "#+COLUMNS: " fmt "\n")))
1000             (org-set-local 'org-columns-default-format fmt))))))
1001
1002 (defvar org-agenda-overriding-columns-format nil
1003   "When set, overrides any other format definition for the agenda.
1004 Don't set this, this is meant for dynamic scoping.")
1005
1006 (defun org-columns-get-autowidth-alist (s cache)
1007   "Derive the maximum column widths from the format and the cache."
1008   (let ((start 0) rtn)
1009     (while (string-match (org-re "%\\([[:alpha:]][[:alnum:]_-]*\\)") s start)
1010       (push (cons (match-string 1 s) 1) rtn)
1011       (setq start (match-end 0)))
1012     (mapc (lambda (x)
1013             (setcdr x (apply 'max
1014                              (mapcar
1015                               (lambda (y)
1016                                 (length (or (cdr (assoc (car x) (cdr y))) " ")))
1017                               cache))))
1018           rtn)
1019     rtn))
1020
1021 (defun org-columns-compute-all ()
1022   "Compute all columns that have operators defined."
1023   (org-unmodified
1024    (remove-text-properties (point-min) (point-max) '(org-summaries t)))
1025   (let ((columns org-columns-current-fmt-compiled) col)
1026     (while (setq col (pop columns))
1027       (when (nth 3 col)
1028         (save-excursion
1029           (org-columns-compute (car col)))))))
1030
1031 (defun org-columns-update (property)
1032   "Recompute PROPERTY, and update the columns display for it."
1033   (org-columns-compute property)
1034   (let (fmt val pos face)
1035     (save-excursion
1036       (mapc (lambda (ov)
1037               (when (equal (org-overlay-get ov 'org-columns-key) property)
1038                 (setq pos (org-overlay-start ov))
1039                 (goto-char pos)
1040                 (when (setq val (cdr (assoc property
1041                                             (get-text-property
1042                                              (point-at-bol) 'org-summaries))))
1043                   (setq fmt (org-overlay-get ov 'org-columns-format))
1044                   (org-overlay-put ov 'org-columns-value val)
1045                   (if (featurep 'xemacs)
1046                       (progn
1047                         (setq face (glyph-face (extent-end-glyph ov)))
1048                         (org-overlay-display ov (format fmt val) face))
1049                     (org-overlay-display ov (format fmt val))))))
1050             org-columns-overlays))))
1051
1052 (defun org-columns-compute (property)
1053   "Sum the values of property PROPERTY hierarchically, for the entire buffer."
1054   (interactive)
1055   (let* ((re (concat "^" outline-regexp))
1056          (lmax 30) ; Does anyone use deeper levels???
1057          (lsum (make-vector lmax 0))
1058          (lflag (make-vector lmax nil))
1059          (level 0)
1060          (ass (assoc property org-columns-current-fmt-compiled))
1061          (format (nth 4 ass))
1062          (printf (nth 5 ass))
1063          (beg org-columns-top-level-marker)
1064          last-level val valflag flag end sumpos sum-alist sum str str1 useval)
1065     (save-excursion
1066       ;; Find the region to compute
1067       (goto-char beg)
1068       (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
1069       (goto-char end)
1070       ;; Walk the tree from the back and do the computations
1071       (while (re-search-backward re beg t)
1072         (setq sumpos (match-beginning 0)
1073               last-level level
1074               level (org-outline-level)
1075               val (org-entry-get nil property)
1076               valflag (and val (string-match "\\S-" val)))
1077         (cond
1078          ((< level last-level)
1079           ;; put the sum of lower levels here as a property
1080           (setq sum (aref lsum last-level)   ; current sum
1081                 flag (aref lflag last-level) ; any valid entries from children?
1082                 str (org-columns-number-to-string sum format printf)
1083                 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
1084                 useval (if flag str1 (if valflag val ""))
1085                 sum-alist (get-text-property sumpos 'org-summaries))
1086           (if (assoc property sum-alist)
1087               (setcdr (assoc property sum-alist) useval)
1088             (push (cons property useval) sum-alist)
1089             (org-unmodified
1090              (add-text-properties sumpos (1+ sumpos)
1091                                   (list 'org-summaries sum-alist))))
1092           (when (and val (not (equal val (if flag str val))))
1093             (org-entry-put nil property (if flag str val)))
1094           ;; add current to current  level accumulator
1095           (when (or flag valflag)
1096             (aset lsum level (+ (aref lsum level)
1097                                 (if flag sum (org-column-string-to-number
1098                                               (if flag str val) format))))
1099             (aset lflag level t))
1100           ;; clear accumulators for deeper levels
1101           (loop for l from (1+ level) to (1- lmax) do
1102                 (aset lsum l 0)
1103                 (aset lflag l nil)))
1104          ((>= level last-level)
1105           ;; add what we have here to the accumulator for this level
1106           (aset lsum level (+ (aref lsum level)
1107                               (org-column-string-to-number (or val "0") format)))
1108           (and valflag (aset lflag level t)))
1109          (t (error "This should not happen")))))))
1110
1111 (defun org-columns-redo ()
1112   "Construct the column display again."
1113   (interactive)
1114   (message "Recomputing columns...")
1115   (save-excursion
1116     (if (marker-position org-columns-begin-marker)
1117         (goto-char org-columns-begin-marker))
1118     (org-columns-remove-overlays)
1119     (if (org-mode-p)
1120         (call-interactively 'org-columns)
1121       (org-agenda-redo)
1122       (call-interactively 'org-agenda-columns)))
1123   (when (featurep 'xemacs)
1124     (while (not (or (eolp)
1125                     (member (extent-at (point)) org-columns-overlays)))
1126       (forward-char)))
1127   (message "Recomputing columns...done"))
1128
1129 (defun org-columns-not-in-agenda ()
1130   (if (eq major-mode 'org-agenda-mode)
1131       (error "This command is only allowed in Org-mode buffers")))
1132
1133
1134 (defun org-string-to-number (s)
1135   "Convert string to number, and interpret hh:mm:ss."
1136   (if (not (string-match ":" s))
1137       (string-to-number s)
1138     (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
1139       (while l
1140         (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
1141       sum)))
1142
1143 (defun org-columns-number-to-string (n fmt &optional printf)
1144   "Convert a computed column number to a string value, according to FMT."
1145   (cond
1146    ((eq fmt 'add_times)
1147     (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
1148       (format org-time-clocksum-format h m)))
1149    ((eq fmt 'checkbox)
1150     (cond ((= n (floor n)) "[X]")
1151           ((> n 1.) "[-]")
1152           (t "[ ]")))
1153    ((memq fmt '(checkbox-n-of-m checkbox-percent))
1154     (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
1155       (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
1156    (printf (format printf n))
1157    ((eq fmt 'currency)
1158     (format "%.2f" n))
1159    (t (number-to-string n))))
1160
1161 (defun org-nofm-to-completion (n m &optional percent)
1162   (if (not percent)
1163       (format "[%d/%d]" n m)
1164     (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
1165
1166 (defun org-column-string-to-number (s fmt)
1167   "Convert a column value to a number that can be used for column computing."
1168   (cond
1169    ((string-match ":" s)
1170     (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
1171       (while l
1172         (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
1173       sum))
1174    ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
1175     (if (equal s "[X]") 1. 0.000001))
1176    (t (string-to-number s))))
1177
1178 (defun org-columns-uncompile-format (cfmt)
1179   "Turn the compiled columns format back into a string representation."
1180   (let ((rtn "") e s prop title op width fmt printf)
1181     (while (setq e (pop cfmt))
1182       (setq prop (car e)
1183             title (nth 1 e)
1184             width (nth 2 e)
1185             op (nth 3 e)
1186             fmt (nth 4 e)
1187             printf (nth 5 e))
1188       (cond
1189        ((eq fmt 'add_times) (setq op ":"))
1190        ((eq fmt 'checkbox) (setq op "X"))
1191        ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
1192        ((eq fmt 'checkbox-percent) (setq op "X%"))
1193        ((eq fmt 'add_numbers) (setq op "+"))
1194        ((eq fmt 'currency) (setq op "$")))
1195       (if (and op printf) (setq op (concat op ";" printf)))
1196       (if (equal title prop) (setq title nil))
1197       (setq s (concat "%" (if width (number-to-string width))
1198                       prop
1199                       (if title (concat "(" title ")"))
1200                       (if op (concat "{" op "}"))))
1201       (setq rtn (concat rtn " " s)))
1202     (org-trim rtn)))
1203
1204 (defun org-columns-compile-format (fmt)
1205   "Turn a column format string into an alist of specifications.
1206 The alist has one entry for each column in the format.  The elements of
1207 that list are:
1208 property     the property
1209 title        the title field for the columns
1210 width        the column width in characters, can be nil for automatic
1211 operator     the operator if any
1212 format       the output format for computed results, derived from operator
1213 printf       a printf format for computed values"
1214   (let ((start 0) width prop title op f printf)
1215     (setq org-columns-current-fmt-compiled nil)
1216     (while (string-match
1217             (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
1218             fmt start)
1219       (setq start (match-end 0)
1220             width (match-string 1 fmt)
1221             prop (match-string 2 fmt)
1222             title (or (match-string 3 fmt) prop)
1223             op (match-string 4 fmt)
1224             f nil
1225             printf nil)
1226       (if width (setq width (string-to-number width)))
1227       (when (and op (string-match ";" op))
1228         (setq printf (substring op (match-end 0))
1229               op (substring op 0 (match-beginning 0))))
1230       (cond
1231        ((equal op "+")  (setq f 'add_numbers))
1232        ((equal op "$")  (setq f 'currency))
1233        ((equal op ":")  (setq f 'add_times))
1234        ((equal op "X")  (setq f 'checkbox))
1235        ((equal op "X/") (setq f 'checkbox-n-of-m))
1236        ((equal op "X%") (setq f 'checkbox-percent))
1237        )
1238       (push (list prop title width op f printf) org-columns-current-fmt-compiled))
1239     (setq org-columns-current-fmt-compiled
1240           (nreverse org-columns-current-fmt-compiled))))
1241
1242
1243 ;;; Dynamic block for Column view
1244
1245 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
1246   "Get the column view of the current buffer or subtree.
1247 The first optional argument MAXLEVEL sets the level limit.  A
1248 second optional argument SKIP-EMPTY-ROWS tells whether to skip
1249 empty rows, an empty row being one where all the column view
1250 specifiers except ITEM are empty.  This function returns a list
1251 containing the title row and all other rows.  Each row is a list
1252 of fields."
1253   (if (featurep 'xemacs)
1254       (save-excursion
1255         (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
1256                (n (length title)) row tbl)
1257           (goto-char (point-min))
1258
1259           (while (re-search-forward "^\\(\\*+\\) " nil t)
1260             (when (and (or (null maxlevel)
1261                            (>= maxlevel
1262                                (if org-odd-levels-only
1263                                    (/ (1+ (length (match-string 1))) 2)
1264                                  (length (match-string 1)))))
1265                        (get-char-property (match-beginning 0) 'org-columns-key))
1266               (goto-char (match-beginning 0))
1267               (setq row nil)
1268               (loop for i from 0 to (1- n) do
1269                     (push (or (get-char-property (point)
1270                                                  'org-columns-value-modified)
1271                               (get-char-property (point) 'org-columns-value)
1272                               "")
1273                           row)
1274                     (org-columns-forward-char))
1275               (setq row (nreverse row))
1276               (unless (and skip-empty-rows
1277                            (eq 1 (length (delete "" (delete-dups (copy-sequence row))))))
1278                 (push row tbl))))
1279           (append (list title 'hline) (nreverse tbl))))
1280     (save-excursion
1281       (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
1282              (n (length title)) row tbl)
1283         (goto-char (point-min))
1284         (while (and (re-search-forward "^\\(\\*+\\) " nil t)
1285                     (or (null maxlevel)
1286                         (>= maxlevel
1287                             (if org-odd-levels-only
1288                                 (/ (1+ (length (match-string 1))) 2)
1289                               (length (match-string 1))))))
1290           (when (get-char-property (match-beginning 0) 'org-columns-key)
1291             (setq row nil)
1292             (loop for i from 0 to (1- n) do
1293                   (push (or (get-char-property (+ (match-beginning 0) i)
1294                                                'org-columns-value-modified)
1295                             (get-char-property (+ (match-beginning 0) i)
1296                                                'org-columns-value)
1297                             "")
1298                         row))
1299             (setq row (nreverse row))
1300             (unless (and skip-empty-rows
1301                          (eq 1 (length (delete "" (delete-dups row)))))
1302               (push row tbl))))
1303         (append (list title 'hline) (nreverse tbl))))))
1304
1305 (defun org-dblock-write:columnview (params)
1306   "Write the column view table.
1307 PARAMS is a property list of parameters:
1308
1309 :width    enforce same column widths with <N> specifiers.
1310 :id       the :ID: property of the entry where the columns view
1311           should be built.  When the symbol `local', call locally.
1312           When `global' call column view with the cursor at the beginning
1313           of the buffer (usually this means that the whole buffer switches
1314           to column view).  When \"file:path/to/file.org\", invoke column
1315           view at the start of that file.  Otherwise, the ID is located
1316           using `org-id-find'.
1317 :hlines   When t, insert a hline before each item.  When a number, insert
1318           a hline before each level <= that number.
1319 :vlines   When t, make each column a colgroup to enforce vertical lines.
1320 :maxlevel When set to a number, don't capture headlines below this level.
1321 :skip-empty-rows
1322           When t, skip rows where all specifiers other than ITEM are empty."
1323   (let ((pos (move-marker (make-marker) (point)))
1324         (hlines (plist-get params :hlines))
1325         (vlines (plist-get params :vlines))
1326         (maxlevel (plist-get params :maxlevel))
1327         (content-lines (org-split-string (plist-get params :content) "\n"))
1328         (skip-empty-rows (plist-get params :skip-empty-rows))
1329         tbl id idpos nfields tmp recalc line
1330         id-as-string view-file view-pos)
1331     (when (setq id (plist-get params :id))
1332       (setq id-as-string (cond ((numberp id) (number-to-string id))
1333                                ((symbolp id) (symbol-name id))
1334                                ((stringp id) id)
1335                                (t "")))
1336       (cond ((not id) nil)
1337             ((eq id 'global) (setq view-pos (point-min)))
1338             ((eq id 'local))
1339             ((string-match "^file:\\(.*\\)" id-as-string)
1340              (setq view-file (match-string 1 id-as-string)
1341                    view-pos 1)
1342              (unless (file-exists-p view-file)
1343                (error "No such file: \"%s\"" id-as-string)))
1344             ((setq idpos (org-find-entry-with-id id))
1345              (setq view-pos idpos))
1346             ((setq idpos (org-id-find id))
1347              (setq view-file (car idpos))
1348              (setq view-pos (cdr idpos)))
1349             (t (error "Cannot find entry with :ID: %s" id))))
1350     (with-current-buffer (if view-file
1351                              (get-file-buffer view-file)
1352                            (current-buffer))
1353       (save-excursion
1354         (save-restriction
1355           (widen)
1356           (goto-char (or view-pos (point)))
1357           (org-columns)
1358           (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
1359           (setq nfields (length (car tbl)))
1360           (org-columns-quit))))
1361     (goto-char pos)
1362     (move-marker pos nil)
1363     (when tbl
1364       (when (plist-get params :hlines)
1365         (setq tmp nil)
1366         (while tbl
1367           (if (eq (car tbl) 'hline)
1368               (push (pop tbl) tmp)
1369             (if (string-match "\\` *\\(\\*+\\)" (caar tbl))
1370                 (if (and (not (eq (car tmp) 'hline))
1371                          (or (eq hlines t)
1372                              (and (numberp hlines)
1373                                   (<= (- (match-end 1) (match-beginning 1))
1374                                       hlines))))
1375                     (push 'hline tmp)))
1376             (push (pop tbl) tmp)))
1377         (setq tbl (nreverse tmp)))
1378       (when vlines
1379         (setq tbl (mapcar (lambda (x)
1380                             (if (eq 'hline x) x (cons "" x)))
1381                           tbl))
1382         (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
1383       (setq pos (point))
1384       (when content-lines
1385         (while (string-match "^#" (car content-lines))
1386           (insert (pop content-lines) "\n")))
1387       (insert (org-listtable-to-string tbl))
1388       (when (plist-get params :width)
1389         (insert "\n|" (mapconcat (lambda (x) (format "<%d>" (max 3 x)))
1390                                  org-columns-current-widths "|")))
1391       (while (setq line (pop content-lines))
1392         (when (string-match "^#" line)
1393           (insert "\n" line)
1394           (when (string-match "^#\\+TBLFM" line)
1395             (setq recalc t))))
1396       (if recalc
1397           (progn (goto-char pos) (org-table-recalculate 'all))
1398         (goto-char pos)
1399         (org-table-align)))))
1400
1401 (defun org-listtable-to-string (tbl)
1402   "Convert a listtable TBL to a string that contains the Org-mode table.
1403 The table still need to be aligned.  The resulting string has no leading
1404 and tailing newline characters."
1405   (mapconcat
1406    (lambda (x)
1407      (cond
1408       ((listp x)
1409        (concat "|" (mapconcat 'identity x "|") "|"))
1410       ((eq x 'hline) "|-|")
1411       (t (error "Garbage in listtable: %s" x))))
1412    tbl "\n"))
1413
1414 (defun org-insert-columns-dblock ()
1415   "Create a dynamic block capturing a column view table."
1416   (interactive)
1417   (when (featurep 'xemacs) (org-columns-quit))
1418   (let ((defaults '(:name "columnview" :hlines 1))
1419         (id (org-ido-completing-read
1420              "Capture columns (local, global, entry with :ID: property) [local]: "
1421              (append '(("global") ("local"))
1422                      (mapcar 'list (org-property-values "ID"))))))
1423     (if (equal id "") (setq id 'local))
1424     (if (equal id "global") (setq id 'global))
1425     (setq defaults (append defaults (list :id id)))
1426     (org-create-dblock defaults)
1427     (org-update-dblock)))
1428
1429 ;;; Column view in the agenda
1430
1431 (defvar org-agenda-view-columns-initially nil
1432   "When set, switch to columns view immediately after creating the agenda.")
1433
1434 (defvar org-agenda-columns-show-summaries) ; defined in org-agenda.el
1435 (defvar org-agenda-columns-compute-summary-properties); defined in org-agenda.el
1436 (defvar org-agenda-columns-add-appointments-to-effort-sum); as well
1437
1438 (defun org-agenda-columns ()
1439   "Turn on or update column view in the agenda."
1440   (interactive)
1441   (org-verify-version 'columns)
1442   (org-columns-remove-overlays)
1443   (move-marker org-columns-begin-marker (point))
1444   (let (fmt cache maxwidths m p a d)
1445     (cond
1446      ((and (boundp 'org-agenda-overriding-columns-format)
1447            org-agenda-overriding-columns-format)
1448       (setq fmt org-agenda-overriding-columns-format)
1449       (org-set-local 'org-agenda-overriding-columns-format fmt))
1450      ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
1451       (setq fmt (or (org-entry-get m "COLUMNS" t)
1452                     (with-current-buffer (marker-buffer m)
1453                       org-columns-default-format))))
1454      ((and (boundp 'org-columns-current-fmt)
1455            (local-variable-p 'org-columns-current-fmt (current-buffer))
1456            org-columns-current-fmt)
1457       (setq fmt org-columns-current-fmt))
1458      ((setq m (next-single-property-change (point-min) 'org-hd-marker))
1459       (setq m (get-text-property m 'org-hd-marker))
1460       (setq fmt (or (org-entry-get m "COLUMNS" t)
1461                     (with-current-buffer (marker-buffer m)
1462                       org-columns-default-format)))))
1463     (setq fmt (or fmt org-columns-default-format))
1464     (org-set-local 'org-columns-current-fmt fmt)
1465     (org-columns-compile-format fmt)
1466     (when org-agenda-columns-compute-summary-properties
1467       (org-agenda-colview-compute org-columns-current-fmt-compiled))
1468     (save-excursion
1469       ;; Get and cache the properties
1470       (goto-char (point-min))
1471       (while (not (eobp))
1472         (when (setq m (or (get-text-property (point) 'org-hd-marker)
1473                           (get-text-property (point) 'org-marker)))
1474           (setq p (org-entry-properties m))
1475
1476           (when (or (not (setq a (assoc org-effort-property p)))
1477                          (not (string-match "\\S-" (or (cdr a) ""))))
1478             ;; OK, the property is not defined.  Use appointment duration?
1479             (when (and org-agenda-columns-add-appointments-to-effort-sum
1480                        (setq d (get-text-property (point) 'duration)))
1481               (setq d (org-minutes-to-hh:mm-string d))
1482               (put-text-property 0 (length d) 'face 'org-warning d)
1483               (push (cons org-effort-property d) p)))
1484           (push (cons (org-current-line) p) cache))
1485         (beginning-of-line 2))
1486       (when cache
1487         (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
1488         (org-set-local 'org-columns-current-maxwidths maxwidths)
1489         (org-columns-display-here-title)
1490         (mapc (lambda (x)
1491                 (goto-line (car x))
1492                 (org-columns-display-here (cdr x)))
1493               cache)
1494         (when org-agenda-columns-show-summaries
1495           (org-agenda-colview-summarize cache))))))
1496
1497 (defun org-agenda-colview-summarize (cache)
1498   "Summarize the summarizable columns in column view in the agenda.
1499 This will add overlays to the date lines, to show the summary for each day."
1500   (let* ((fmt (mapcar (lambda (x)
1501                         (list (car x) (if (equal (car x) "CLOCKSUM")
1502                                           'add_times (nth 4 x))))
1503                       org-columns-current-fmt-compiled))
1504          line c c1 stype props lsum entries prop v)
1505     (catch 'exit
1506       (when (delq nil (mapcar 'cadr fmt))
1507         ;; OK, at least one summation column, it makes sense to try this
1508         (goto-char (point-max))
1509         (while t
1510           (when (or (get-text-property (point) 'org-date-line)
1511                     (eq (get-text-property (point) 'face)
1512                         'org-agenda-structure))
1513             ;; OK, this is a date line that should be used
1514             (setq line (org-current-line))
1515             (setq entries nil c cache cache nil)
1516             (while (setq c1 (pop c))
1517               (if (> (car c1) line)
1518                   (push c1 entries)
1519                 (push c1 cache)))
1520             ;; now ENTRIES are the ones we want to use, CACHE is the rest
1521             ;; Compute the summaries for the properties we want,
1522             ;; set nil properties for the rest.
1523             (when (setq entries (mapcar 'cdr entries))
1524               (setq props
1525                     (mapcar
1526                      (lambda (f)
1527                        (setq prop (car f) stype (nth 1 f))
1528                        (cond
1529                         ((equal prop "ITEM")
1530                          (cons prop (buffer-substring (point-at-bol)
1531                                                       (point-at-eol))))
1532                         ((not stype) (cons prop ""))
1533                         (t
1534                          ;; do the summary
1535                          (setq lsum 0)
1536                          (mapc (lambda (x)
1537                                  (setq v (cdr (assoc prop x)))
1538                                  (if v (setq lsum (+ lsum
1539                                                      (org-column-string-to-number
1540                                                       v stype)))))
1541                                entries)
1542                          (setq lsum (org-columns-number-to-string lsum stype))
1543                          (put-text-property
1544                           0 (length lsum) 'face 'bold lsum)
1545                          (cons prop lsum))))
1546                      fmt))
1547               (org-columns-display-here props)
1548               (org-set-local 'org-agenda-columns-active t)))
1549           (if (bobp) (throw 'exit t))
1550           (beginning-of-line 0))))))
1551
1552 (defun org-agenda-colview-compute (fmt)
1553   "Compute the relevant columns in the contributing source buffers."
1554   (let ((files org-agenda-contributing-files)
1555         (org-columns-begin-marker (make-marker))
1556         (org-columns-top-level-marker (make-marker))
1557         f fm a b)
1558     (while (setq f (pop files))
1559       (setq b (find-buffer-visiting f))
1560       (with-current-buffer (or (buffer-base-buffer b) b)
1561         (save-excursion
1562           (save-restriction
1563             (widen)
1564             (org-unmodified
1565              (remove-text-properties (point-min) (point-max)
1566                                      '(org-summaries t)))
1567             (goto-char (point-min))
1568             (org-columns-get-format-and-top-level)
1569             (while (setq fm (pop fmt))
1570               (if (equal (car fm) "CLOCKSUM")
1571                   (org-clock-sum)
1572                 (when (and (nth 4 fm)
1573                            (setq a (assoc (car fm)
1574                                           org-columns-current-fmt-compiled))
1575                            (equal (nth 4 a) (nth 4 fm)))
1576                   (org-columns-compute (car fm)))))))))))
1577
1578 (provide 'org-colview)
1579 (provide 'org-colview-xemacs)
1580
1581 ;;; org-colview-xemacs.el ends here
1582