1 ;;; org-colview-xemacs.el --- Column View in Org-mode, XEmacs-specific version
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
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)
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.
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
31 ;; This file contains the column view for Org.
35 (eval-when-compile (require 'cl
))
38 (declare-function org-agenda-redo
"org-agenda" ())
41 ;;; Define additional faces for column view
43 (when (featurep 'xemacs
)
45 (defface org-columns-level-1
;; font-lock-function-name-face
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
))
54 "Face used for columns-level 1 headlines."
57 (defface org-columns-level-2
;; font-lock-variable-name-face
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
))
65 "Face used for columns-level 2 headlines."
68 (defface org-columns-level-3
;; font-lock-keyword-face
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
))
78 "Face used for columns-level 3 headlines."
81 (defface org-columns-level-4
;; font-lock-comment-face
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
))
91 "Face used for columns-level 4 headlines."
94 (defface org-columns-level-5
;; font-lock-type-face
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."
103 (defface org-columns-level-6
;; font-lock-constant-face
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."
112 (defface org-columns-level-7
;; font-lock-builtin-face
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."
121 (defface org-columns-level-8
;; font-lock-string-face
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."
131 (defface org-columns-space
;; font-lock-function-name-face
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."
142 (defface org-columns-space1
;; font-lock-function-name-face
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."
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
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
))
168 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
170 (t (if org-level-color-stars-only nil org-f
))))
176 (defvar org-columns-overlays nil
177 "Holds the list of current column overlays.")
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.")
197 (defvar org-columns-map
(make-sparse-keymap)
198 "The keymap valid in column display.")
200 (defun org-columns-content ()
201 "Switch to contents view while in columns view."
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)
233 (org-defkey org-columns-map (number-to-string i)
234 `(lambda () (interactive)
235 (org-columns-next-allowed-value nil ,i))))
237 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
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]
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]
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]
254 ["CONTENTS" org-columns-content t]
255 ["OVERVIEW" org-overview t]
256 ["Refresh columns display" org-columns-redo t]
258 ["Open link" org-columns-open-link t]
260 ["Quit" org-columns-quit t]))
262 (defun org-columns-current-column ()
263 (if (featurep 'xemacs)
264 (/ (current-column) 2)
267 (defun org-columns-forward-char ()
270 (if (featurep 'xemacs)
271 (while (not (or (eolp)
273 (point) (current-buffer)
274 'org-columns-key) org-columns-overlays)))
277 (defun org-columns-backward-char ()
280 (if (featurep 'xemacs)
281 (while (not (or (bolp)
282 (member (extent-at (point) (current-buffer) 'org-columns-key) org-columns-overlays)))
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)
290 (org-overlay-put ov 'face (or face 'org-columns-space1))
291 (org-overlay-put ov 'start-open t)
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)
299 (defun org-columns-display-here (&optional props)
300 "Overlay the current line with column display."
302 (let* ((fmt org-columns-current-fmt-compiled)
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
311 (buffer-substring-no-properties
312 (point-at-bol) (point-at-eol))))))
313 (color (if (featurep 'xemacs)
315 (beginning-of-line 1)
316 (and (looking-at "\\(\\**\\)\\(\\* \\)")
317 (org-get-columns-level-face 2)))
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 calc)
328 ;; Check if the entry is in another buffer.
330 (if (eq major-mode 'org-agenda-mode)
331 (setq pom (or (org-get-at-bol 'org-hd-marker)
332 (org-get-at-bol 'org-marker))
333 props (if pom (org-entry-properties pom) nil))
334 (setq props (org-entry-properties nil))))
336 (while (setq column (pop fmt))
337 (setq property (car column)
339 ass (if (equal property "ITEM")
341 (assoc property props))
342 width (or (cdr (assoc property org-columns-current-maxwidths))
345 f (format (if (featurep 'xemacs) "%%-%d.%ds |" "%%-%d.%ds | ")
347 val (or (cdr ass) "")
349 modval (cond ((and org-columns-modify-value-for-display-function
351 org-columns-modify-value-for-display-function))
352 (funcall org-columns-modify-value-for-display-function
354 ((equal property "ITEM")
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 ((and calc (functionp calc)
361 (not (string= val ""))
362 (not (get-text-property 0 'org-computed val)))
363 (org-columns-number-to-string
364 (funcall calc (org-columns-string-to-number
367 (setq s2 (org-columns-add-ellipses (or modval val) width))
368 (setq string (format f s2))
369 ;; Create the overlay
371 (setq ov (org-columns-new-overlay
372 beg (setq beg (1+ beg)) string face))
373 (org-overlay-put ov 'keymap org-columns-map)
374 (org-overlay-put ov 'org-columns-key property)
375 (org-overlay-put ov 'org-columns-value (cdr ass))
376 (org-overlay-put ov 'org-columns-value-modified modval)
377 (org-overlay-put ov 'org-columns-pom pom)
378 (org-overlay-put ov 'org-columns-format f)
379 (when (featurep 'xemacs)
380 (if (or (not (char-after beg))
381 (equal (char-after beg) ?\n))
382 (let ((inhibit-read-only t))
385 (org-unmodified (insert " "))
386 ;; FIXME: add props and remove later?
389 (org-columns-new-overlay
390 beg (1+ beg) nil 'org-columns-space)
391 (setq beg (1+ beg))))
393 (if (or (not (char-after beg))
394 (equal (char-after beg) ?\n))
395 (let ((inhibit-read-only t))
398 ;; FIXME: add props and remove later?
399 (org-unmodified (insert " "))))))
400 ;; Make the rest of the line disappear.
402 (setq ov (org-columns-new-overlay beg (point-at-eol)))
403 (org-overlay-put ov 'invisible t)
404 (org-overlay-put ov 'keymap org-columns-map)
405 (org-overlay-put ov 'intangible t)
406 (push ov org-columns-overlays)
407 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
408 (org-overlay-put ov 'keymap org-columns-map)
409 (push ov org-columns-overlays)
410 (let ((inhibit-read-only t))
411 (put-text-property (max (point-min) (1- (point-at-bol)))
412 (min (point-max) (1+ (point-at-eol)))
413 'read-only "Type `e' to edit property")))))
415 (defun org-columns-add-ellipses (string width)
416 "Truncate STRING with WIDTH characters, with ellipses."
418 ((<= (length string) width) string)
419 ((<= width (length org-columns-ellipses))
420 (substring org-columns-ellipses 0 width))
421 (t (concat (substring string 0 (- width (length org-columns-ellipses)))
422 org-columns-ellipses))))
424 (defvar org-columns-full-header-line-format nil
425 "The full header line format, will be shifted by horizontal scrolling." )
426 (defvar org-previous-header-line-format nil
427 "The header line format before column view was turned on.")
428 (defvar org-columns-inhibit-recalculation nil
429 "Inhibit recomputing of columns on column view startup.")
432 (defvar header-line-format)
433 (defvar org-columns-previous-hscroll 0)
435 (defun org-columns-display-here-title ()
436 "Overlay the newline before the current line with the table title."
438 (let ((fmt org-columns-current-fmt-compiled)
440 property width f column str widths)
441 (while (setq column (pop fmt))
442 (setq property (car column)
443 str (or (nth 1 column) property)
444 width (or (cdr (assoc property org-columns-current-maxwidths))
447 widths (push width widths)
448 f (format "%%-%d.%ds | " width width)
449 string (format f str)
450 title (concat title string)))
451 (if (featurep 'xemacs)
452 (let ((ext (make-extent nil nil)))
453 (set-extent-endpoints ext 0 (length title) title)
454 (set-extent-face ext (list 'bold 'underline 'org-columns-space1))
455 (org-set-local 'org-previous-header-line-format
456 (specifier-specs top-gutter))
457 (org-set-local 'org-columns-current-widths (nreverse widths))
458 (set-specifier top-gutter (make-gutter-specifier
459 (cons (current-buffer) title))))
461 (org-add-props " " nil 'display '(space :align-to 0))
462 (org-add-props title nil 'face '(:weight bold :underline t))))
463 (org-set-local 'org-previous-header-line-format header-line-format)
464 (org-set-local 'org-columns-current-widths (nreverse widths))
465 (setq org-columns-full-header-line-format title)
466 (setq org-columns-previous-hscroll -1)
467 (org-add-hook 'post-command-hook 'org-columns-hscoll-title nil 'local))))
469 (defun org-columns-hscoll-title ()
470 "Set the header-line-format so that it scrolls along with the table."
471 (sit-for .0001) ; need to force a redisplay to update window-hscroll
472 (when (not (= (window-hscroll) org-columns-previous-hscroll))
473 (setq header-line-format
474 (concat (substring org-columns-full-header-line-format 0 1)
475 (substring org-columns-full-header-line-format
476 (1+ (window-hscroll))))
477 org-columns-previous-hscroll (window-hscroll))
478 (force-mode-line-update)))
480 (defvar org-colview-initial-truncate-line-value nil
481 "Remember the value of `truncate-lines' across colview.")
483 (defun org-columns-remove-overlays ()
484 "Remove all currently active column overlays."
486 (when (marker-buffer org-columns-begin-marker)
487 (with-current-buffer (marker-buffer org-columns-begin-marker)
488 (when (local-variable-p 'org-previous-header-line-format (current-buffer))
489 (if (featurep 'xemacs)
490 (set-specifier top-gutter
491 (make-gutter-specifier
492 (cons (current-buffer)
493 (cdar org-previous-header-line-format))))
494 (setq header-line-format org-previous-header-line-format)
495 (remove-hook 'post-command-hook 'org-columns-hscoll-title 'local))
496 (kill-local-variable 'org-previous-header-line-format))
497 (move-marker org-columns-begin-marker nil)
498 (move-marker org-columns-top-level-marker nil)
500 (mapc 'org-delete-overlay org-columns-overlays)
501 (setq org-columns-overlays nil)
502 (let ((inhibit-read-only t))
503 (remove-text-properties (point-min) (point-max) '(read-only t))))
504 (when (local-variable-p 'org-colview-initial-truncate-line-value
506 (setq truncate-lines org-colview-initial-truncate-line-value)))))
509 (defun org-columns-cleanup-item (item fmt)
510 "Remove from ITEM what is a column in the format FMT."
511 (if (not org-complex-heading-regexp)
513 (when (string-match org-complex-heading-regexp item)
516 (org-add-props (match-string 1 item) nil
517 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
518 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
519 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
520 " " (save-match-data (org-columns-compact-links (match-string 4 item)))
521 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))
524 (list 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
528 (defun org-columns-compact-links (s)
529 "Replace [[link][desc]] with [desc] or [link]."
530 (while (string-match org-bracket-link-regexp s)
531 (setq s (replace-match
532 (concat "[" (match-string (if (match-end 3) 3 1) s) "]")
536 (defvar org-agenda-columns-remove-prefix-from-item)
538 (defun org-agenda-columns-cleanup-item (item pl cphr fmt)
539 "Cleanup the time property for agenda column view.
540 See also the variable `org-agenda-columns-remove-prefix-from-item'."
541 (let* ((org-complex-heading-regexp cphr)
542 (prefix (substring item 0 pl))
543 (rest (substring item pl))
544 (fake (concat "* " rest))
545 (cleaned (org-trim (substring (org-columns-cleanup-item fake fmt) 1))))
546 (if org-agenda-columns-remove-prefix-from-item
548 (concat prefix cleaned))))
550 (defun org-columns-show-value ()
551 "Show the full value of the property."
553 (let ((value (get-char-property (point) 'org-columns-value)))
554 (message "Value is: %s" (or value ""))))
556 (defvar org-agenda-columns-active) ;; defined in org-agenda.el
558 (defun org-columns-quit ()
559 "Remove the column overlays and in this way exit column editing."
562 (org-columns-remove-overlays)
563 (let ((inhibit-read-only t))
564 (remove-text-properties (point-min) (point-max) '(read-only t))))
565 (when (eq major-mode 'org-agenda-mode)
566 (setq org-agenda-columns-active nil)
568 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
570 (defun org-columns-check-computed ()
571 "Check if this column value is computed.
572 If yes, throw an error indicating that changing it does not make sense."
573 (let ((val (get-char-property (point) 'org-columns-value)))
574 (when (and (stringp val)
575 (get-char-property 0 'org-computed val))
576 (error "This value is computed from the entry's children"))))
578 (defun org-columns-todo (&optional arg)
579 "Change the TODO state during column view."
581 (org-columns-edit-value "TODO"))
583 (defun org-columns-set-tags-or-toggle (&optional arg)
584 "Toggle checkbox at point, or set tags for current headline."
586 (if (string-match "\\`\\[[ xX-]\\]\\'"
587 (get-char-property (point) 'org-columns-value))
588 (org-columns-next-allowed-value)
589 (org-columns-edit-value "TAGS")))
591 (defun org-columns-edit-value (&optional key)
592 "Edit the value of the property at point in column view.
593 Where possible, use the standard interface for changing this line."
595 (org-columns-check-computed)
596 (let* ((col (current-column))
597 (key (or key (get-char-property (point) 'org-columns-key)))
598 (value (get-char-property (point) 'org-columns-value))
599 (bol (point-at-bol)) (eol (point-at-eol))
600 (pom (or (get-text-property bol 'org-hd-marker)
601 (point))) ; keep despite of compiler warning
603 (delq nil (mapcar (lambda (x)
604 (and (eq (org-overlay-buffer x) (current-buffer))
605 (>= (org-overlay-start x) bol)
606 (<= (org-overlay-start x) eol)
608 org-columns-overlays)))
609 (org-columns-time (time-to-number-of-days (current-time)))
612 ((equal key "CLOCKSUM")
613 (error "This special column cannot be edited"))
615 (setq eval '(org-with-point-at pom (org-edit-headline))))
617 (setq eval '(org-with-point-at
619 (call-interactively 'org-todo))))
620 ((equal key "PRIORITY")
621 (setq eval '(org-with-point-at pom
622 (call-interactively 'org-priority))))
624 (setq eval '(org-with-point-at
626 (let ((org-fast-tag-selection-single-key
627 (if (eq org-fast-tag-selection-single-key 'expert)
628 t org-fast-tag-selection-single-key)))
629 (call-interactively 'org-set-tags)))))
630 ((equal key "DEADLINE")
631 (setq eval '(org-with-point-at
633 (call-interactively 'org-deadline))))
634 ((equal key "SCHEDULED")
635 (setq eval '(org-with-point-at
637 (call-interactively 'org-schedule))))
639 (setq allowed (org-property-get-allowed-values pom key 'table))
641 (setq nval (org-icompleting-read "Value: " allowed nil t))
642 (setq nval (read-string "Edit: " value)))
643 (setq nval (org-trim nval))
644 (when (not (equal nval value))
645 (setq eval '(org-entry-put pom key nval)))))
649 ((equal major-mode 'org-agenda-mode)
650 (org-columns-eval eval)
651 ;; The following let preserves the current format, and makes sure
652 ;; that in only a single file things need to be upated.
653 (let* ((org-agenda-overriding-columns-format org-columns-current-fmt)
654 (buffer (marker-buffer pom))
655 (org-agenda-contributing-files
656 (list (with-current-buffer buffer
657 (buffer-file-name (buffer-base-buffer))))))
658 (org-agenda-columns)))
660 (let ((inhibit-read-only t))
662 (remove-text-properties
663 (max (point-min) (1- bol)) eol '(read-only t)))
666 (setq org-columns-overlays
667 (org-delete-all line-overlays org-columns-overlays))
668 (mapc 'org-delete-overlay line-overlays)
669 (org-columns-eval eval))
670 (org-columns-display-here)))
671 (org-move-to-column col)
672 (if (and (org-mode-p)
673 (nth 3 (assoc key org-columns-current-fmt-compiled)))
674 (org-columns-update key)))))))
676 (defun org-edit-headline () ; FIXME: this is not columns specific. Make interactive????? Use from agenda????
677 "Edit the current headline, the part without TODO keyword, TAGS."
678 (org-back-to-heading)
679 (when (looking-at org-todo-line-regexp)
681 (pre (buffer-substring (match-beginning 0) (match-beginning 3)))
682 (txt (match-string 3))
685 (if (string-match (org-re "[ \t]+:[[:alnum:]:_@]+:[ \t]*$") txt)
686 (setq post (match-string 0 txt)
687 txt (substring txt 0 (match-beginning 0))))
688 (setq txt2 (read-string "Edit: " txt))
689 (when (not (equal txt txt2))
691 (insert pre txt2 post)
692 (delete-region (point) (point-at-eol))
693 (org-set-tags nil t)))))
695 (defun org-columns-edit-allowed ()
696 "Edit the list of allowed values for the current property."
698 (let* ((pom (or (org-get-at-bol 'org-marker)
699 (org-get-at-bol 'org-hd-marker)
701 (key (get-char-property (point) 'org-columns-key))
702 (key1 (concat key "_ALL"))
703 (allowed (org-entry-get pom key1 t))
705 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
706 ;; FIXME: Write back to #+PROPERTY setting if that is needed.
707 (setq nval (read-string "Allowed: " allowed))
709 (cond ((marker-position org-entry-property-inherited-from)
710 org-entry-property-inherited-from)
711 ((marker-position org-columns-top-level-marker)
712 org-columns-top-level-marker)
716 (defun org-columns-eval (form)
719 (beginning-of-line 1)
720 ;; `next-line' is needed here, because it skips invisible line.
721 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
722 (setq hidep (org-on-heading-p 1)))
724 (and hidep (hide-entry))))
726 (defun org-columns-previous-allowed-value ()
727 "Switch to the previous allowed value for this column."
729 (org-columns-next-allowed-value t))
731 (defun org-columns-next-allowed-value (&optional previous nth)
732 "Switch to the next allowed value for this column.
733 When PREVIOUS is set, go to the previous value. When NTH is
734 an integer, select that value."
736 (org-columns-check-computed)
737 (let* ((col (current-column))
738 (key (get-char-property (point) 'org-columns-key))
739 (value (get-char-property (point) 'org-columns-value))
740 (bol (point-at-bol)) (eol (point-at-eol))
741 (pom (or (get-text-property bol 'org-hd-marker)
742 (point))) ; keep despite of compiler waring
744 (delq nil (mapcar (lambda (x)
745 (and (eq (org-overlay-buffer x) (current-buffer))
746 (>= (org-overlay-start x) bol)
747 (<= (org-overlay-start x) eol)
749 org-columns-overlays)))
750 (allowed (or (org-property-get-allowed-values pom key)
752 (nth 4 (assoc key org-columns-current-fmt-compiled))
753 '(checkbox checkbox-n-of-m checkbox-percent))
755 (org-colview-construct-allowed-dates value)))
759 (if (= nth -1) (setq nth 9)))
760 (when (equal key "ITEM")
761 (error "Cannot edit item headline from here"))
762 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
763 (error "Allowed values for this property have not been defined"))
764 (if (member key '("SCHEDULED" "DEADLINE"))
765 (setq nval (if previous 'earlier 'later))
766 (if previous (setq allowed (reverse allowed)))
769 (setq nval (nth nth allowed))
771 (error "There are only %d allowed values for property `%s'"
772 (length allowed) key)))
773 ((member value allowed)
774 (setq nval (or (car (cdr (member value allowed)))
776 (if (equal nval value)
777 (error "Only one allowed value for this property")))
778 (t (setq nval (car allowed)))))
780 ((equal major-mode 'org-agenda-mode)
781 (org-columns-eval '(org-entry-put pom key nval))
782 ;; The following let preserves the current format, and makes sure
783 ;; that in only a single file things need to be upated.
784 (let* ((org-agenda-overriding-columns-format org-columns-current-fmt)
785 (buffer (marker-buffer pom))
786 (org-agenda-contributing-files
787 (list (with-current-buffer buffer
788 (buffer-file-name (buffer-base-buffer))))))
789 (org-agenda-columns)))
791 (let ((inhibit-read-only t))
792 (remove-text-properties (1- bol) eol '(read-only t))
795 (setq org-columns-overlays
796 (org-delete-all line-overlays org-columns-overlays))
797 (mapc 'org-delete-overlay line-overlays)
798 (org-columns-eval '(org-entry-put pom key nval)))
799 (org-columns-display-here)))
800 (org-move-to-column col)
801 (and (nth 3 (assoc key org-columns-current-fmt-compiled))
802 (org-columns-update key))))))
804 (defun org-colview-construct-allowed-dates (s)
805 "Construct a list of three dates around the date in S.
806 This respects the format of the time stamp in S, active or non-active,
807 and also including time or not. S must be just a time stamp, no text
809 (when (and s (string-match (concat "^" org-ts-regexp3 "$") s))
810 (let* ((time (org-parse-time-string s 'nodefaults))
811 (active (equal (string-to-char s) ?<))
812 (fmt (funcall (if (nth 1 time) 'cdr 'car) org-time-stamp-formats))
813 time-before time-after)
814 (unless active (setq fmt (concat "[" (substring fmt 1 -1) "]")))
815 (setf (car time) (or (car time) 0))
816 (setf (nth 1 time) (or (nth 1 time) 0))
817 (setf (nth 2 time) (or (nth 2 time) 0))
818 (setq time-before (copy-sequence time))
819 (setq time-after (copy-sequence time))
820 (setf (nth 3 time-before) (1- (nth 3 time)))
821 (setf (nth 3 time-after) (1+ (nth 3 time)))
822 (mapcar (lambda (x) (format-time-string fmt (apply 'encode-time x)))
823 (list time-before time time-after)))))
825 (defun org-verify-version (task)
828 (if (or (and (featurep 'xemacs) (not (featurep 'org-colview-xemacs)))
829 (and (not (featurep 'xemacs)) (< emacs-major-version 22)))
830 (error "This version of Emacs cannot run Column View")))))
832 (defun org-columns-open-link (&optional arg)
834 (let ((value (get-char-property (point) 'org-columns-value)))
835 (org-open-link-from-string value arg)))
837 (defun org-columns-get-format-and-top-level ()
839 (when (condition-case nil (org-back-to-heading) (error nil))
840 (setq fmt (org-entry-get nil "COLUMNS" t)))
841 (setq fmt (or fmt org-columns-default-format))
842 (org-set-local 'org-columns-current-fmt fmt)
843 (org-columns-compile-format fmt)
844 (if (marker-position org-entry-property-inherited-from)
845 (move-marker org-columns-top-level-marker
846 org-entry-property-inherited-from)
847 (move-marker org-columns-top-level-marker (point)))
850 (defun org-columns ()
851 "Turn on column view on an org-mode file."
853 (org-verify-version 'columns)
854 (when (featurep 'xemacs)
855 (set-face-foreground 'org-columns-space
856 (face-background 'org-columns-space)))
857 (org-columns-remove-overlays)
858 (move-marker org-columns-begin-marker (point))
859 (let ((org-columns-time (time-to-number-of-days (current-time)))
860 beg end fmt cache maxwidths)
861 (setq fmt (org-columns-get-format-and-top-level))
863 (goto-char org-columns-top-level-marker)
865 (unless org-columns-inhibit-recalculation
866 (org-columns-compute-all))
867 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
869 ;; Get and cache the properties
871 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
874 (narrow-to-region beg end)
876 (while (re-search-forward (concat "^" outline-regexp) end t)
877 (if (and org-columns-skip-archived-trees
878 (looking-at (concat ".*:" org-archive-tag ":")))
879 (org-end-of-subtree t)
880 (push (cons (org-current-line) (org-entry-properties)) cache)))
882 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
883 (org-set-local 'org-columns-current-maxwidths maxwidths)
884 (org-columns-display-here-title)
885 (unless (local-variable-p 'org-colview-initial-truncate-line-value
887 (org-set-local 'org-colview-initial-truncate-line-value
889 (setq truncate-lines t)
891 (org-goto-line (car x))
892 (org-columns-display-here (cdr x)))
895 (eval-when-compile (defvar org-columns-time))
897 (defvar org-columns-compile-map
903 ("X/" checkbox-n-of-m +)
904 ("X%" checkbox-percent +)
905 ("max" max_numbers max)
906 ("min" min_numbers min)
908 (lambda (&rest x) (/ (apply '+ x) (float (length x)))))
909 (":max" max_times max)
910 (":min" min_times min)
912 (lambda (&rest x) (/ (apply '+ x) (float (length x)))))
913 ("@min" min_age min (lambda (x) (- org-columns-time x)))
914 ("@max" max_age max (lambda (x) (- org-columns-time x)))
916 (lambda (&rest x) (/ (apply '+ x) (float (length x))))
917 (lambda (x) (- org-columns-time x))))
918 "Operator <-> format,function,calc map.
919 Used to compile/uncompile columns format and completing read in
920 interactive function org-columns-new.
922 operator string used in #+COLUMNS definition describing the
924 format symbol describing summary type selected interactively in
925 org-columns-new and internally in
926 org-columns-number-to-string and
927 org-columns-string-to-number
928 function called with a list of values as argument to calculate
930 calc function called on every element before summarizing. This is
931 optional and should only be specified if needed")
934 (defun org-columns-new (&optional prop title width op fmt fun &rest rest)
935 "Insert a new column, to the left of the current column."
937 (let ((n (org-columns-current-column))
938 (editp (and prop (assoc prop org-columns-current-fmt-compiled)))
940 (setq prop (org-icompleting-read
941 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
943 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
944 (setq width (read-string "Column width: " (if width (number-to-string width))))
945 (if (string-match "\\S-" width)
946 (setq width (string-to-number width))
948 (setq fmt (org-icompleting-read "Summary [none]: "
949 (mapcar (lambda (x) (list (symbol-name (cadr x)))) org-columns-compile-map)
951 (setq fmt (intern fmt)
952 fun (cdr (assoc fmt (mapcar 'cdr org-columns-compile-map))))
953 (if (eq fmt 'none) (setq fmt nil))
957 (setcdr editp (list title width nil fmt nil fun)))
958 (setq cell (nthcdr (1- n) org-columns-current-fmt-compiled))
959 (setcdr cell (cons (list prop title width nil fmt nil
960 (car fun) (cadr fun))
962 (org-columns-store-format)
965 (defun org-columns-delete ()
966 "Delete the column at point from columns view."
968 (let* ((n (org-columns-current-column))
969 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
971 (format "Are you sure you want to remove column \"%s\"? " title))
972 (setq org-columns-current-fmt-compiled
973 (delq (nth n org-columns-current-fmt-compiled)
974 org-columns-current-fmt-compiled))
975 (org-columns-store-format)
977 (if (>= (org-columns-current-column)
978 (length org-columns-current-fmt-compiled))
979 (org-columns-backward-char)))))
981 (defun org-columns-edit-attributes ()
982 "Edit the attributes of the current column."
984 (let* ((n (org-columns-current-column))
985 (info (nth n org-columns-current-fmt-compiled)))
986 (apply 'org-columns-new info)))
988 (defun org-columns-widen (arg)
989 "Make the column wider by ARG characters."
991 (let* ((n (org-columns-current-column))
992 (entry (nth n org-columns-current-fmt-compiled))
993 (width (or (nth 2 entry)
994 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
995 (setq width (max 1 (+ width arg)))
996 (setcar (nthcdr 2 entry) width)
997 (org-columns-store-format)
1000 (defun org-columns-narrow (arg)
1001 "Make the column narrower by ARG characters."
1003 (org-columns-widen (- arg)))
1005 (defun org-columns-move-right ()
1006 "Swap this column with the one to the right."
1008 (let* ((n (org-columns-current-column))
1009 (cell (nthcdr n org-columns-current-fmt-compiled))
1011 (when (>= n (1- (length org-columns-current-fmt-compiled)))
1012 (error "Cannot shift this column further to the right"))
1014 (setcar cell (car (cdr cell)))
1015 (setcdr cell (cons e (cdr (cdr cell))))
1016 (org-columns-store-format)
1018 (org-columns-forward-char)))
1020 (defun org-columns-move-left ()
1021 "Swap this column with the one to the left."
1023 (let* ((n (org-columns-current-column)))
1025 (error "Cannot shift this column further to the left"))
1026 (org-columns-backward-char)
1027 (org-columns-move-right)
1028 (org-columns-backward-char)))
1030 (defun org-columns-store-format ()
1031 "Store the text version of the current columns format in appropriate place.
1032 This is either in the COLUMNS property of the node starting the current column
1033 display, or in the #+COLUMNS line of the current buffer."
1035 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
1036 (org-set-local 'org-columns-current-fmt fmt)
1037 (if (marker-position org-columns-top-level-marker)
1039 (goto-char org-columns-top-level-marker)
1040 (if (and (org-at-heading-p)
1041 (org-entry-get nil "COLUMNS"))
1042 (org-entry-put nil "COLUMNS" fmt)
1043 (goto-char (point-min))
1044 ;; Overwrite all #+COLUMNS lines....
1045 (while (re-search-forward "^#\\+COLUMNS:.*" nil t)
1047 (replace-match (concat "#+COLUMNS: " fmt) t t))
1049 (goto-char (point-min))
1050 (or (org-on-heading-p t) (outline-next-heading))
1051 (let ((inhibit-read-only t))
1052 (insert-before-markers "#+COLUMNS: " fmt "\n")))
1053 (org-set-local 'org-columns-default-format fmt))))))
1055 (defvar org-agenda-overriding-columns-format nil
1056 "When set, overrides any other format definition for the agenda.
1057 Don't set this, this is meant for dynamic scoping.")
1059 (defun org-columns-get-autowidth-alist (s cache)
1060 "Derive the maximum column widths from the format and the cache."
1061 (let ((start 0) rtn)
1062 (while (string-match (org-re "%\\([[:alpha:]][[:alnum:]_-]*\\)") s start)
1063 (push (cons (match-string 1 s) 1) rtn)
1064 (setq start (match-end 0)))
1066 (setcdr x (apply 'max
1069 (length (or (cdr (assoc (car x) (cdr y))) " ")))
1074 (defun org-columns-compute-all ()
1075 "Compute all columns that have operators defined."
1077 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
1078 (let ((columns org-columns-current-fmt-compiled)
1079 (org-columns-time (time-to-number-of-days (current-time)))
1081 (while (setq col (pop columns))
1084 (org-columns-compute (car col)))))))
1086 (defun org-columns-update (property)
1087 "Recompute PROPERTY, and update the columns display for it."
1088 (org-columns-compute property)
1089 (let (fmt val pos face)
1092 (when (equal (org-overlay-get ov 'org-columns-key) property)
1093 (setq pos (org-overlay-start ov))
1095 (when (setq val (cdr (assoc property
1097 (point-at-bol) 'org-summaries))))
1098 (setq fmt (org-overlay-get ov 'org-columns-format))
1099 (org-overlay-put ov 'org-columns-value val)
1100 (if (featurep 'xemacs)
1102 (setq face (glyph-face (extent-end-glyph ov)))
1103 (org-overlay-display ov (format fmt val) face))
1104 (org-overlay-display ov (format fmt val))))))
1105 org-columns-overlays))))
1107 (defun org-columns-compute (property)
1108 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
1110 (let* ((re (concat "^" outline-regexp))
1111 (lmax 30) ; Does anyone use deeper levels???
1112 (lvals (make-vector lmax nil))
1113 (lflag (make-vector lmax nil))
1115 (ass (assoc property org-columns-current-fmt-compiled))
1116 (format (nth 4 ass))
1117 (printf (nth 5 ass))
1119 (calc (or (nth 7 ass) 'identity))
1120 (beg org-columns-top-level-marker)
1121 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
1123 ;; Find the region to compute
1125 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
1127 ;; Walk the tree from the back and do the computations
1128 (while (re-search-backward re beg t)
1129 (setq sumpos (match-beginning 0)
1131 level (org-outline-level)
1132 val (org-entry-get nil property)
1133 valflag (and val (string-match "\\S-" val)))
1135 ((< level last-level)
1136 ;; put the sum of lower levels here as a property
1137 (setq sum (when (aref lvals last-level)
1138 (apply fun (aref lvals last-level)))
1139 flag (aref lflag last-level) ; any valid entries from children?
1140 str (org-columns-number-to-string sum format printf)
1141 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
1142 useval (if flag str1 (if valflag val ""))
1143 sum-alist (get-text-property sumpos 'org-summaries))
1144 (if (assoc property sum-alist)
1145 (setcdr (assoc property sum-alist) useval)
1146 (push (cons property useval) sum-alist)
1148 (add-text-properties sumpos (1+ sumpos)
1149 (list 'org-summaries sum-alist))))
1150 (when (and val (not (equal val (if flag str val))))
1151 (org-entry-put nil property (if flag str val)))
1152 ;; add current to current level accumulator
1153 (when (or flag valflag)
1156 (funcall calc (org-columns-string-to-number
1157 (if flag str val) format)))
1159 (aset lflag level t))
1160 ;; clear accumulators for deeper levels
1161 (loop for l from (1+ level) to (1- lmax) do
1163 (aset lflag l nil)))
1164 ((>= level last-level)
1165 ;; add what we have here to the accumulator for this level
1167 (push (funcall calc (org-columns-string-to-number val format))
1169 (aset lflag level t)))
1170 (t (error "This should not happen")))))))
1172 (defun org-columns-redo ()
1173 "Construct the column display again."
1175 (message "Recomputing columns...")
1177 (if (marker-position org-columns-begin-marker)
1178 (goto-char org-columns-begin-marker))
1179 (org-columns-remove-overlays)
1181 (call-interactively 'org-columns)
1183 (call-interactively 'org-agenda-columns)))
1184 (when (featurep 'xemacs)
1185 (while (not (or (eolp)
1186 (member (extent-at (point)) org-columns-overlays)))
1188 (message "Recomputing columns...done"))
1190 (defun org-columns-not-in-agenda ()
1191 (if (eq major-mode 'org-agenda-mode)
1192 (error "This command is only allowed in Org-mode buffers")))
1194 (defun org-string-to-number (s)
1195 "Convert string to number, and interpret hh:mm:ss."
1196 (if (not (string-match ":" s))
1197 (string-to-number s)
1198 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
1200 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
1203 (defun org-columns-number-to-string (n fmt &optional printf)
1204 "Convert a computed column number to a string value, according to FMT."
1206 ((not (numberp n)) "")
1207 ((memq fmt '(add_times max_times min_times mean_times))
1208 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
1209 (format org-time-clocksum-format h m)))
1211 (cond ((= n (floor n)) "[X]")
1214 ((memq fmt '(checkbox-n-of-m checkbox-percent))
1215 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
1216 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
1217 (printf (format printf n))
1220 ((memq fmt '(min_age max_age mean_age))
1221 (org-format-time-period n))
1222 (t (number-to-string n))))
1224 (defun org-nofm-to-completion (n m &optional percent)
1226 (format "[%d/%d]" n m)
1227 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
1229 (defun org-columns-string-to-number (s fmt)
1230 "Convert a column value to a number that can be used for column computing."
1233 ((memq fmt '(min_age max_age mean_age))
1234 (cond ((string= s "") org-columns-time)
1236 "\\([0-9]+\\)d \\([0-9]+\\)h \\([0-9]+\\)m \\([0-9]+\\)s"
1238 (+ (* 60 (+ (* 60 (+ (* 24 (string-to-number (match-string 1 s)))
1239 (string-to-number (match-string 2 s))))
1240 (string-to-number (match-string 3 s))))
1241 (string-to-number (match-string 4 s))))
1242 (t (time-to-number-of-days (apply 'encode-time
1243 (org-parse-time-string s t))))))
1244 ((string-match ":" s)
1245 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
1247 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
1249 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
1250 (if (equal s "[X]") 1. 0.000001))
1251 (t (string-to-number s)))
1254 (defun org-columns-uncompile-format (cfmt)
1255 "Turn the compiled columns format back into a string representation."
1256 (let ((rtn "") e s prop title op op-match width fmt printf fun calc)
1257 (while (setq e (pop cfmt))
1266 (when (setq op-match (rassoc (list fmt fun calc) org-columns-compile-map))
1267 (setq op (car op-match)))
1268 (if (and op printf) (setq op (concat op ";" printf)))
1269 (if (equal title prop) (setq title nil))
1270 (setq s (concat "%" (if width (number-to-string width))
1272 (if title (concat "(" title ")"))
1273 (if op (concat "{" op "}"))))
1274 (setq rtn (concat rtn " " s)))
1277 (defun org-columns-compile-format (fmt)
1278 "Turn a column format string into an alist of specifications.
1279 The alist has one entry for each column in the format. The elements of
1281 property the property
1282 title the title field for the columns
1283 width the column width in characters, can be nil for automatic
1284 operator the operator if any
1285 format the output format for computed results, derived from operator
1286 printf a printf format for computed values
1287 fun the lisp function to compute summary values, derived from operator
1288 calc function to get values from base elements
1290 (let ((start 0) width prop title op op-match f printf fun calc)
1291 (setq org-columns-current-fmt-compiled nil)
1292 (while (string-match
1293 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
1295 (setq start (match-end 0)
1296 width (match-string 1 fmt)
1297 prop (match-string 2 fmt)
1298 title (or (match-string 3 fmt) prop)
1299 op (match-string 4 fmt)
1304 (if width (setq width (string-to-number width)))
1305 (when (and op (string-match ";" op))
1306 (setq printf (substring op (match-end 0))
1307 op (substring op 0 (match-beginning 0))))
1308 (when (setq op-match (assoc op org-columns-compile-map))
1309 (setq f (cadr op-match)
1310 fun (caddr op-match)
1311 calc (cadddr op-match)))
1312 (push (list prop title width op f printf fun calc)
1313 org-columns-current-fmt-compiled))
1314 (setq org-columns-current-fmt-compiled
1315 (nreverse org-columns-current-fmt-compiled))))
1318 ;;; Dynamic block for Column view
1320 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
1321 "Get the column view of the current buffer or subtree.
1322 The first optional argument MAXLEVEL sets the level limit. A
1323 second optional argument SKIP-EMPTY-ROWS tells whether to skip
1324 empty rows, an empty row being one where all the column view
1325 specifiers except ITEM are empty. This function returns a list
1326 containing the title row and all other rows. Each row is a list
1328 (if (featurep 'xemacs)
1330 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
1331 (re-comment (concat "\\*+[ \t]+" org-comment-string "\\>"))
1332 (re-archive (concat ".*:" org-archive-tag ":"))
1333 (n (length title)) row tbl)
1334 (goto-char (point-min))
1336 (while (re-search-forward "^\\(\\*+\\) " nil t)
1338 (when (and (or (null maxlevel)
1340 (if org-odd-levels-only
1341 (/ (1+ (length (match-string 1))) 2)
1342 (length (match-string 1)))))
1343 (get-char-property (match-beginning 0) 'org-columns-key))
1344 (goto-char (match-beginning 0))
1345 (when (save-excursion
1346 (goto-char (point-at-bol))
1347 (or (looking-at re-comment)
1348 (looking-at re-archive)))
1349 (org-end-of-subtree t)
1352 (loop for i from 0 to (1- n) do
1355 (or (get-char-property (point)
1356 'org-columns-value-modified)
1357 (get-char-property (point) 'org-columns-value)
1360 (org-columns-forward-char))
1361 (setq row (nreverse row))
1362 (unless (and skip-empty-rows
1363 (eq 1 (length (delete "" (delete-dups (copy-sequence row))))))
1365 (append (list title 'hline) (nreverse tbl))))
1367 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
1368 (n (length title)) row tbl)
1369 (goto-char (point-min))
1370 (while (and (re-search-forward "^\\(\\*+\\) " nil t)
1373 (if org-odd-levels-only
1374 (/ (1+ (length (match-string 1))) 2)
1375 (length (match-string 1))))))
1376 (when (get-char-property (match-beginning 0) 'org-columns-key)
1378 (loop for i from 0 to (1- n) do
1379 (push (or (get-char-property (+ (match-beginning 0) i)
1380 'org-columns-value-modified)
1381 (get-char-property (+ (match-beginning 0) i)
1385 (setq row (nreverse row))
1386 (unless (and skip-empty-rows
1387 (eq 1 (length (delete "" (delete-dups row)))))
1389 (append (list title 'hline) (nreverse tbl))))))
1391 (defun org-dblock-write:columnview (params)
1392 "Write the column view table.
1393 PARAMS is a property list of parameters:
1395 :width enforce same column widths with <N> specifiers.
1396 :id the :ID: property of the entry where the columns view
1397 should be built. When the symbol `local', call locally.
1398 When `global' call column view with the cursor at the beginning
1399 of the buffer (usually this means that the whole buffer switches
1400 to column view). When \"file:path/to/file.org\", invoke column
1401 view at the start of that file. Otherwise, the ID is located
1402 using `org-id-find'.
1403 :hlines When t, insert a hline before each item. When a number, insert
1404 a hline before each level <= that number.
1405 :vlines When t, make each column a colgroup to enforce vertical lines.
1406 :maxlevel When set to a number, don't capture headlines below this level.
1408 When t, skip rows where all specifiers other than ITEM are empty."
1409 (let ((pos (move-marker (make-marker) (point)))
1410 (hlines (plist-get params :hlines))
1411 (vlines (plist-get params :vlines))
1412 (maxlevel (plist-get params :maxlevel))
1413 (content-lines (org-split-string (plist-get params :content) "\n"))
1414 (skip-empty-rows (plist-get params :skip-empty-rows))
1415 tbl id idpos nfields tmp recalc line
1416 id-as-string view-file view-pos)
1417 (when (setq id (plist-get params :id))
1418 (setq id-as-string (cond ((numberp id) (number-to-string id))
1419 ((symbolp id) (symbol-name id))
1422 (cond ((not id) nil)
1423 ((eq id 'global) (setq view-pos (point-min)))
1425 ((string-match "^file:\\(.*\\)" id-as-string)
1426 (setq view-file (match-string 1 id-as-string)
1428 (unless (file-exists-p view-file)
1429 (error "No such file: \"%s\"" id-as-string)))
1430 ((setq idpos (org-find-entry-with-id id))
1431 (setq view-pos idpos))
1432 ((setq idpos (org-id-find id))
1433 (setq view-file (car idpos))
1434 (setq view-pos (cdr idpos)))
1435 (t (error "Cannot find entry with :ID: %s" id))))
1436 (with-current-buffer (if view-file
1437 (get-file-buffer view-file)
1442 (goto-char (or view-pos (point)))
1444 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
1445 (setq nfields (length (car tbl)))
1446 (org-columns-quit))))
1448 (move-marker pos nil)
1450 (when (plist-get params :hlines)
1453 (if (eq (car tbl) 'hline)
1454 (push (pop tbl) tmp)
1455 (if (string-match "\\` *\\(\\*+\\)" (caar tbl))
1456 (if (and (not (eq (car tmp) 'hline))
1458 (and (numberp hlines)
1459 (<= (- (match-end 1) (match-beginning 1))
1462 (push (pop tbl) tmp)))
1463 (setq tbl (nreverse tmp)))
1465 (setq tbl (mapcar (lambda (x)
1466 (if (eq 'hline x) x (cons "" x)))
1468 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
1471 (while (string-match "^#" (car content-lines))
1472 (insert (pop content-lines) "\n")))
1473 (insert (org-listtable-to-string tbl))
1474 (when (plist-get params :width)
1475 (insert "\n|" (mapconcat (lambda (x) (format "<%d>" (max 3 x)))
1476 org-columns-current-widths "|")))
1477 (while (setq line (pop content-lines))
1478 (when (string-match "^#" line)
1480 (when (string-match "^[ \t]*#\\+TBLFM" line)
1483 (progn (goto-char pos) (org-table-recalculate 'all))
1485 (org-table-align)))))
1487 (defun org-listtable-to-string (tbl)
1488 "Convert a listtable TBL to a string that contains the Org-mode table.
1489 The table still need to be aligned. The resulting string has no leading
1490 and tailing newline characters."
1495 (concat "|" (mapconcat 'identity x "|") "|"))
1496 ((eq x 'hline) "|-|")
1497 (t (error "Garbage in listtable: %s" x))))
1500 (defun org-insert-columns-dblock ()
1501 "Create a dynamic block capturing a column view table."
1503 (when (featurep 'xemacs) (org-columns-quit))
1504 (let ((defaults '(:name "columnview" :hlines 1))
1505 (id (org-icompleting-read
1506 "Capture columns (local, global, entry with :ID: property) [local]: "
1507 (append '(("global") ("local"))
1508 (mapcar 'list (org-property-values "ID"))))))
1509 (if (equal id "") (setq id 'local))
1510 (if (equal id "global") (setq id 'global))
1511 (setq defaults (append defaults (list :id id)))
1512 (org-create-dblock defaults)
1513 (org-update-dblock)))
1515 ;;; Column view in the agenda
1517 (defvar org-agenda-view-columns-initially nil
1518 "When set, switch to columns view immediately after creating the agenda.")
1520 (defvar org-agenda-columns-show-summaries) ; defined in org-agenda.el
1521 (defvar org-agenda-columns-compute-summary-properties); defined in org-agenda.el
1522 (defvar org-agenda-columns-add-appointments-to-effort-sum); as well
1524 (defun org-agenda-columns ()
1525 "Turn on or update column view in the agenda."
1527 (org-verify-version 'columns)
1528 (org-columns-remove-overlays)
1529 (move-marker org-columns-begin-marker (point))
1530 (let ((org-columns-time (time-to-number-of-days (current-time)))
1531 cache maxwidths m p a d fmt)
1533 ((and (boundp 'org-agenda-overriding-columns-format)
1534 org-agenda-overriding-columns-format)
1535 (setq fmt org-agenda-overriding-columns-format)
1536 (org-set-local 'org-agenda-overriding-columns-format fmt))
1537 ((setq m (org-get-at-bol 'org-hd-marker))
1538 (setq fmt (or (org-entry-get m "COLUMNS" t)
1539 (with-current-buffer (marker-buffer m)
1540 org-columns-default-format))))
1541 ((and (boundp 'org-columns-current-fmt)
1542 (local-variable-p 'org-columns-current-fmt (current-buffer))
1543 org-columns-current-fmt)
1544 (setq fmt org-columns-current-fmt))
1545 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
1546 (setq m (get-text-property m 'org-hd-marker))
1547 (setq fmt (or (org-entry-get m "COLUMNS" t)
1548 (with-current-buffer (marker-buffer m)
1549 org-columns-default-format)))))
1550 (setq fmt (or fmt org-columns-default-format))
1551 (org-set-local 'org-columns-current-fmt fmt)
1552 (org-columns-compile-format fmt)
1553 (when org-agenda-columns-compute-summary-properties
1554 (org-agenda-colview-compute org-columns-current-fmt-compiled))
1556 ;; Get and cache the properties
1557 (goto-char (point-min))
1559 (when (setq m (or (org-get-at-bol 'org-hd-marker)
1560 (org-get-at-bol 'org-marker)))
1561 (setq p (org-entry-properties m))
1563 (when (or (not (setq a (assoc org-effort-property p)))
1564 (not (string-match "\\S-" (or (cdr a) ""))))
1565 ;; OK, the property is not defined. Use appointment duration?
1566 (when (and org-agenda-columns-add-appointments-to-effort-sum
1567 (setq d (get-text-property (point) 'duration)))
1568 (setq d (org-minutes-to-hh:mm-string d))
1569 (put-text-property 0 (length d) 'face 'org-warning d)
1570 (push (cons org-effort-property d) p)))
1571 (push (cons (org-current-line) p) cache))
1572 (beginning-of-line 2))
1574 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
1575 (org-set-local 'org-columns-current-maxwidths maxwidths)
1576 (org-columns-display-here-title)
1578 (org-goto-line (car x))
1579 (org-columns-display-here (cdr x)))
1581 (when org-agenda-columns-show-summaries
1582 (org-agenda-colview-summarize cache))))))
1584 (defun org-agenda-colview-summarize (cache)
1585 "Summarize the summarizable columns in column view in the agenda.
1586 This will add overlays to the date lines, to show the summary for each day."
1587 (let* ((fmt (mapcar (lambda (x)
1588 (if (equal (car x) "CLOCKSUM")
1589 (list "CLOCKSUM" (nth 2 x) nil 'add_times nil '+ 'identity)
1591 org-columns-current-fmt-compiled))
1592 line c c1 stype calc sumfunc props lsum entries prop v)
1594 (when (delq nil (mapcar 'cadr fmt))
1595 ;; OK, at least one summation column, it makes sense to try this
1596 (goto-char (point-max))
1598 (when (or (get-text-property (point) 'org-date-line)
1599 (eq (get-text-property (point) 'face)
1600 'org-agenda-structure))
1601 ;; OK, this is a date line that should be used
1602 (setq line (org-current-line))
1603 (setq entries nil c cache cache nil)
1604 (while (setq c1 (pop c))
1605 (if (> (car c1) line)
1608 ;; now ENTRIES are the ones we want to use, CACHE is the rest
1609 ;; Compute the summaries for the properties we want,
1610 ;; set nil properties for the rest.
1611 (when (setq entries (mapcar 'cdr entries))
1618 calc (or (nth 6 f) 'identity))
1620 ((equal prop "ITEM")
1621 (cons prop (buffer-substring (point-at-bol)
1623 ((not stype) (cons prop ""))
1624 (t ;; do the summary
1627 (setq v (cdr (assoc prop x)))
1631 (if (not (get-text-property 0 'org-computed v))
1634 (org-columns-string-to-number
1637 (setq lsum (remove nil lsum))
1639 (cond ((> (length lsum) 1)
1640 (org-columns-number-to-string
1641 (apply sumfunc lsum) stype))
1642 ((eq (length lsum) 1)
1643 (org-columns-number-to-string
1646 (put-text-property 0 (length lsum) 'face 'bold lsum)
1647 (unless (eq calc 'identity)
1648 (put-text-property 0 (length lsum) 'org-computed t lsum))
1651 (org-columns-display-here props)
1652 (org-set-local 'org-agenda-columns-active t)))
1653 (if (bobp) (throw 'exit t))
1654 (beginning-of-line 0))))))
1656 (defun org-agenda-colview-compute (fmt)
1657 "Compute the relevant columns in the contributing source buffers."
1658 (let ((files org-agenda-contributing-files)
1659 (org-columns-begin-marker (make-marker))
1660 (org-columns-top-level-marker (make-marker))
1662 (while (setq f (pop files))
1663 (setq b (find-buffer-visiting f))
1664 (with-current-buffer (or (buffer-base-buffer b) b)
1669 (remove-text-properties (point-min) (point-max)
1670 '(org-summaries t)))
1671 (goto-char (point-min))
1672 (org-columns-get-format-and-top-level)
1673 (while (setq fm (pop fmt))
1674 (if (equal (car fm) "CLOCKSUM")
1676 (when (and (nth 4 fm)
1677 (setq a (assoc (car fm)
1678 org-columns-current-fmt-compiled))
1679 (equal (nth 4 a) (nth 4 fm)))
1680 (org-columns-compute (car fm)))))))))))
1682 (defun org-format-time-period (interval)
1683 "Convert time in fractional days to days/hours/minutes/seconds"
1684 (if (numberp interval)
1685 (let* ((days (floor interval))
1686 (frac-hours (* 24 (- interval days)))
1687 (hours (floor frac-hours))
1688 (minutes (floor (* 60 (- frac-hours hours))))
1689 (seconds (floor (* 60 (- (* 60 (- frac-hours hours)) minutes)))))
1690 (format "%dd %02dh %02dm %02ds" days hours minutes seconds))
1694 (provide 'org-colview)
1695 (provide 'org-colview-xemacs)
1697 ;;; org-colview-xemacs.el ends here