lisp/org-colview.el

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