contrib/lisp/org-e-texinfo: Remove markup from headlines when
[org-mode.git] / lisp / org-agenda.el
blob9c7f29b01563d1401e26160edd3dafb6ea964bd2
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
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.
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.
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.
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (require 'org-macs)
50 (eval-when-compile
51 (require 'cl))
53 (declare-function diary-add-to-list "diary-lib"
54 (date string specifier &optional marker globcolor literal))
55 (declare-function calendar-absolute-from-iso "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-datetree-find-date-create "org-datetree"
73 (date &optional keep-restriction))
74 (declare-function org-columns-quit "org-colview" ())
75 (declare-function diary-date-display-form "diary-lib" (&optional type))
76 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
77 (declare-function org-habit-insert-consistency-graphs
78 "org-habit" (&optional line))
79 (declare-function org-is-habit-p "org-habit" (&optional pom))
80 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
81 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
82 (declare-function org-pop-to-buffer-same-window "org-compat"
83 (&optional buffer-or-name norecord label))
84 (declare-function org-agenda-columns "org-colview" ())
85 (declare-function org-add-archive-files "org-archive" (files))
87 (defvar calendar-mode-map)
88 (defvar org-clock-current-task) ; defined in org-clock.el
89 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
90 (defvar org-habit-show-habits)
91 (defvar org-habit-show-habits-only-for-today)
92 (defvar org-habit-show-all-today nil)
94 ;; Defined somewhere in this file, but used before definition.
95 (defvar org-agenda-buffer-name)
96 (defvar org-agenda-overriding-header)
97 (defvar org-agenda-title-append nil)
98 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
99 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
100 (defvar org-agenda-undo-list)
101 (defvar org-agenda-pending-undo-list)
102 (defvar original-date) ; dynamically scoped, calendar.el does scope this
104 (defcustom org-agenda-confirm-kill 1
105 "When set, remote killing from the agenda buffer needs confirmation.
106 When t, a confirmation is always needed. When a number N, confirmation is
107 only needed when the text to be killed contains more than N non-white lines."
108 :group 'org-agenda
109 :type '(choice
110 (const :tag "Never" nil)
111 (const :tag "Always" t)
112 (integer :tag "When more than N lines")))
114 (defcustom org-agenda-compact-blocks nil
115 "Non-nil means make the block agenda more compact.
116 This is done globally by leaving out lines like the agenda span
117 name and week number or the separator lines."
118 :group 'org-agenda
119 :type 'boolean)
121 (defcustom org-agenda-block-separator ?=
122 "The separator between blocks in the agenda.
123 If this is a string, it will be used as the separator, with a newline added.
124 If it is a character, it will be repeated to fill the window width.
125 If nil the separator is disabled. In `org-agenda-custom-commands' this
126 addresses the separator between the current and the previous block."
127 :group 'org-agenda
128 :type '(choice
129 (const :tag "Disabled" nil)
130 (character)
131 (string)))
133 (defgroup org-agenda-export nil
134 "Options concerning exporting agenda views in Org-mode."
135 :tag "Org Agenda Export"
136 :group 'org-agenda)
138 (defcustom org-agenda-with-colors t
139 "Non-nil means use colors in agenda views."
140 :group 'org-agenda-export
141 :type 'boolean)
143 (defcustom org-agenda-exporter-settings nil
144 "Alist of variable/value pairs that should be active during agenda export.
145 This is a good place to set options for ps-print and for htmlize.
146 Note that the way this is implemented, the values will be evaluated
147 before assigned to the variables. So make sure to quote values you do
148 *not* want evaluated, for example
150 (setq org-agenda-exporter-settings
151 '((ps-print-color-p 'black-white)))"
152 :group 'org-agenda-export
153 :type '(repeat
154 (list
155 (variable)
156 (sexp :tag "Value"))))
158 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
159 "Hook run in temporary buffer before writing it to an export file.
160 A useful function is `org-agenda-add-entry-text'."
161 :group 'org-agenda-export
162 :type 'hook
163 :options '(org-agenda-add-entry-text))
165 (defcustom org-agenda-add-entry-text-maxlines 0
166 "Maximum number of entry text lines to be added to agenda.
167 This is only relevant when `org-agenda-add-entry-text' is part of
168 `org-agenda-before-write-hook', which it is by default.
169 When this is 0, nothing will happen. When it is greater than 0, it
170 specifies the maximum number of lines that will be added for each entry
171 that is listed in the agenda view.
173 Note that this variable is not used during display, only when exporting
174 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
175 and `org-agenda-entry-text-maxlines'."
176 :group 'org-agenda
177 :type 'integer)
179 (defcustom org-agenda-add-entry-text-descriptive-links t
180 "Non-nil means export org-links as descriptive links in agenda added text.
181 This variable applies to the text added to the agenda when
182 `org-agenda-add-entry-text-maxlines' is larger than 0.
183 When this variable nil, the URL will (also) be shown."
184 :group 'org-agenda
185 :type 'boolean)
187 (defcustom org-agenda-export-html-style ""
188 "The style specification for exported HTML Agenda files.
189 If this variable contains a string, it will replace the default <style>
190 section as produced by `htmlize'.
191 Since there are different ways of setting style information, this variable
192 needs to contain the full HTML structure to provide a style, including the
193 surrounding HTML tags. The style specifications should include definitions
194 the fonts used by the agenda, here is an example:
196 <style type=\"text/css\">
197 p { font-weight: normal; color: gray; }
198 .org-agenda-structure {
199 font-size: 110%;
200 color: #003399;
201 font-weight: 600;
203 .org-todo {
204 color: #cc6666;
205 font-weight: bold;
207 .org-agenda-done {
208 color: #339933;
210 .org-done {
211 color: #339933;
213 .title { text-align: center; }
214 .todo, .deadline { color: red; }
215 .done { color: green; }
216 </style>
218 or, if you want to keep the style in a file,
220 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
222 As the value of this option simply gets inserted into the HTML <head> header,
223 you can \"misuse\" it to also add other text to the header. However,
224 <style>...</style> is required, if not present the variable will be ignored."
225 :group 'org-agenda-export
226 :group 'org-export-html
227 :type 'string)
229 (defcustom org-agenda-persistent-filter nil
230 "When set, keep filters from one agenda view to the next."
231 :group 'org-agenda
232 :type 'boolean)
234 (defgroup org-agenda-custom-commands nil
235 "Options concerning agenda views in Org-mode."
236 :tag "Org Agenda Custom Commands"
237 :group 'org-agenda)
239 (defconst org-sorting-choice
240 '(choice
241 (const time-up) (const time-down)
242 (const category-keep) (const category-up) (const category-down)
243 (const tag-down) (const tag-up)
244 (const priority-up) (const priority-down)
245 (const todo-state-up) (const todo-state-down)
246 (const effort-up) (const effort-down)
247 (const habit-up) (const habit-down)
248 (const alpha-up) (const alpha-down)
249 (const user-defined-up) (const user-defined-down))
250 "Sorting choices.")
252 ;; Keep custom values for `org-agenda-filter-preset' compatible with
253 ;; the new variable `org-agenda-tag-filter-preset'.
254 (if (fboundp 'defvaralias)
255 (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
256 (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
258 (defconst org-agenda-custom-commands-local-options
259 `(repeat :tag "Local settings for this command. Remember to quote values"
260 (choice :tag "Setting"
261 (list :tag "Heading for this block"
262 (const org-agenda-overriding-header)
263 (string :tag "Headline"))
264 (list :tag "Files to be searched"
265 (const org-agenda-files)
266 (list
267 (const :format "" quote)
268 (repeat (file))))
269 (list :tag "Sorting strategy"
270 (const org-agenda-sorting-strategy)
271 (list
272 (const :format "" quote)
273 (repeat
274 ,org-sorting-choice)))
275 (list :tag "Prefix format"
276 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
277 (string))
278 (list :tag "Number of days in agenda"
279 (const org-agenda-span)
280 (choice (const :tag "Day" 'day)
281 (const :tag "Week" 'week)
282 (const :tag "Month" 'month)
283 (const :tag "Year" 'year)
284 (integer :tag "Custom")))
285 (list :tag "Fixed starting date"
286 (const org-agenda-start-day)
287 (string :value "2007-11-01"))
288 (list :tag "Start on day of week"
289 (const org-agenda-start-on-weekday)
290 (choice :value 1
291 (const :tag "Today" nil)
292 (integer :tag "Weekday No.")))
293 (list :tag "Include data from diary"
294 (const org-agenda-include-diary)
295 (boolean))
296 (list :tag "Deadline Warning days"
297 (const org-deadline-warning-days)
298 (integer :value 1))
299 (list :tag "Category filter preset"
300 (const org-agenda-category-filter-preset)
301 (list
302 (const :format "" quote)
303 (repeat
304 (string :tag "+category or -category"))))
305 (list :tag "Tags filter preset"
306 (const org-agenda-tag-filter-preset)
307 (list
308 (const :format "" quote)
309 (repeat
310 (string :tag "+tag or -tag"))))
311 (list :tag "Set daily/weekly entry types"
312 (const org-agenda-entry-types)
313 (list
314 (const :format "" quote)
315 (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
316 (const :deadline)
317 (const :scheduled)
318 (const :timestamp)
319 (const :sexp))))
320 (list :tag "Standard skipping condition"
321 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
322 (const org-agenda-skip-function)
323 (list
324 (const :format "" quote)
325 (list
326 (choice
327 :tag "Skipping range"
328 (const :tag "Skip entry" org-agenda-skip-entry-if)
329 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
330 (repeat :inline t :tag "Conditions for skipping"
331 (choice
332 :tag "Condition type"
333 (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
334 (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
335 (list :tag "TODO state is" :inline t
336 (const 'todo)
337 (choice
338 (const :tag "any not-done state" 'todo)
339 (const :tag "any done state" 'done)
340 (const :tag "any state" 'any)
341 (list :tag "Keyword list"
342 (const :format "" quote)
343 (repeat (string :tag "Keyword")))))
344 (list :tag "TODO state is not" :inline t
345 (const 'nottodo)
346 (choice
347 (const :tag "any not-done state" 'todo)
348 (const :tag "any done state" 'done)
349 (const :tag "any state" 'any)
350 (list :tag "Keyword list"
351 (const :format "" quote)
352 (repeat (string :tag "Keyword")))))
353 (const :tag "scheduled" 'scheduled)
354 (const :tag "not scheduled" 'notscheduled)
355 (const :tag "deadline" 'deadline)
356 (const :tag "no deadline" 'notdeadline)
357 (const :tag "timestamp" 'timestamp)
358 (const :tag "no timestamp" 'nottimestamp))))))
359 (list :tag "Non-standard skipping condition"
360 :value (org-agenda-skip-function)
361 (const org-agenda-skip-function)
362 (sexp :tag "Function or form (quoted!)"))
363 (list :tag "Any variable"
364 (variable :tag "Variable")
365 (sexp :tag "Value (sexp)"))))
366 "Selection of examples for agenda command settings.
367 This will be spliced into the custom type of
368 `org-agenda-custom-commands'.")
371 (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
372 ((agenda "") (alltodo))))
373 "Custom commands for the agenda.
374 These commands will be offered on the splash screen displayed by the
375 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
377 (key desc type match settings files)
379 key The key (one or more characters as a string) to be associated
380 with the command.
381 desc A description of the command, when omitted or nil, a default
382 description is built using MATCH.
383 type The command type, any of the following symbols:
384 agenda The daily/weekly agenda.
385 todo Entries with a specific TODO keyword, in all agenda files.
386 search Entries containing search words entry or headline.
387 tags Tags/Property/TODO match in all agenda files.
388 tags-todo Tags/P/T match in all agenda files, TODO entries only.
389 todo-tree Sparse tree of specific TODO keyword in *current* file.
390 tags-tree Sparse tree with all tags matches in *current* file.
391 occur-tree Occur sparse tree for *current* file.
392 ... A user-defined function.
393 match What to search for:
394 - a single keyword for TODO keyword searches
395 - a tags match expression for tags searches
396 - a word search expression for text searches.
397 - a regular expression for occur searches
398 For all other commands, this should be the empty string.
399 settings A list of option settings, similar to that in a let form, so like
400 this: ((opt1 val1) (opt2 val2) ...). The values will be
401 evaluated at the moment of execution, so quote them when needed.
402 files A list of files file to write the produced agenda buffer to
403 with the command `org-store-agenda-views'.
404 If a file name ends in \".html\", an HTML version of the buffer
405 is written out. If it ends in \".ps\", a postscript version is
406 produced. Otherwise, only the plain text is written to the file.
408 You can also define a set of commands, to create a composite agenda buffer.
409 In this case, an entry looks like this:
411 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
413 where
415 desc A description string to be displayed in the dispatcher menu.
416 cmd An agenda command, similar to the above. However, tree commands
417 are not allowed, but instead you can get agenda and global todo list.
418 So valid commands for a set are:
419 (agenda \"\" settings)
420 (alltodo \"\" settings)
421 (stuck \"\" settings)
422 (todo \"match\" settings files)
423 (search \"match\" settings files)
424 (tags \"match\" settings files)
425 (tags-todo \"match\" settings files)
427 Each command can carry a list of options, and another set of options can be
428 given for the whole set of commands. Individual command options take
429 precedence over the general options.
431 When using several characters as key to a command, the first characters
432 are prefix commands. For the dispatcher to display useful information, you
433 should provide a description for the prefix, like
435 (setq org-agenda-custom-commands
436 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
437 (\"hl\" tags \"+HOME+Lisa\")
438 (\"hp\" tags \"+HOME+Peter\")
439 (\"hk\" tags \"+HOME+Kim\")))"
440 :group 'org-agenda-custom-commands
441 :type `(repeat
442 (choice :value ("x" "Describe command here" tags "" nil)
443 (list :tag "Single command"
444 (string :tag "Access Key(s) ")
445 (option (string :tag "Description"))
446 (choice
447 (const :tag "Agenda" agenda)
448 (const :tag "TODO list" alltodo)
449 (const :tag "Search words" search)
450 (const :tag "Stuck projects" stuck)
451 (const :tag "Tags/Property match (all agenda files)" tags)
452 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
453 (const :tag "TODO keyword search (all agenda files)" todo)
454 (const :tag "Tags sparse tree (current buffer)" tags-tree)
455 (const :tag "TODO keyword tree (current buffer)" todo-tree)
456 (const :tag "Occur tree (current buffer)" occur-tree)
457 (sexp :tag "Other, user-defined function"))
458 (string :tag "Match (only for some commands)")
459 ,org-agenda-custom-commands-local-options
460 (option (repeat :tag "Export" (file :tag "Export to"))))
461 (list :tag "Command series, all agenda files"
462 (string :tag "Access Key(s)")
463 (string :tag "Description ")
464 (repeat :tag "Component"
465 (choice
466 (list :tag "Agenda"
467 (const :format "" agenda)
468 (const :tag "" :format "" "")
469 ,org-agenda-custom-commands-local-options)
470 (list :tag "TODO list (all keywords)"
471 (const :format "" alltodo)
472 (const :tag "" :format "" "")
473 ,org-agenda-custom-commands-local-options)
474 (list :tag "Search words"
475 (const :format "" search)
476 (string :tag "Match")
477 ,org-agenda-custom-commands-local-options)
478 (list :tag "Stuck projects"
479 (const :format "" stuck)
480 (const :tag "" :format "" "")
481 ,org-agenda-custom-commands-local-options)
482 (list :tag "Tags search"
483 (const :format "" tags)
484 (string :tag "Match")
485 ,org-agenda-custom-commands-local-options)
486 (list :tag "Tags search, TODO entries only"
487 (const :format "" tags-todo)
488 (string :tag "Match")
489 ,org-agenda-custom-commands-local-options)
490 (list :tag "TODO keyword search"
491 (const :format "" todo)
492 (string :tag "Match")
493 ,org-agenda-custom-commands-local-options)
494 (list :tag "Other, user-defined function"
495 (symbol :tag "function")
496 (string :tag "Match")
497 ,org-agenda-custom-commands-local-options)))
499 (repeat :tag "Settings for entire command set"
500 (list (variable :tag "Any variable")
501 (sexp :tag "Value")))
502 (option (repeat :tag "Export" (file :tag "Export to"))))
503 (cons :tag "Prefix key documentation"
504 (string :tag "Access Key(s)")
505 (string :tag "Description ")))))
507 (defcustom org-agenda-query-register ?o
508 "The register holding the current query string.
509 The purpose of this is that if you construct a query string interactively,
510 you can then use it to define a custom command."
511 :group 'org-agenda-custom-commands
512 :type 'character)
514 (defcustom org-stuck-projects
515 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
516 "How to identify stuck projects.
517 This is a list of four items:
518 1. A tags/todo/property matcher string that is used to identify a project.
519 See the manual for a description of tag and property searches.
520 The entire tree below a headline matched by this is considered one project.
521 2. A list of TODO keywords identifying non-stuck projects.
522 If the project subtree contains any headline with one of these todo
523 keywords, the project is considered to be not stuck. If you specify
524 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
525 3. A list of tags identifying non-stuck projects.
526 If the project subtree contains any headline with one of these tags,
527 the project is considered to be not stuck. If you specify \"*\" as
528 a tag, any tag will mark the project unstuck. Note that this is about
529 the explicit presence of a tag somewhere in the subtree, inherited
530 tags to not count here. If inherited tags make a project not stuck,
531 use \"-TAG\" in the tags part of the matcher under (1.) above.
532 4. An arbitrary regular expression matching non-stuck projects.
534 If the project turns out to be not stuck, search continues also in the
535 subtree to see if any of the subtasks have project status.
537 See also the variable `org-tags-match-list-sublevels' which applies
538 to projects matched by this search as well.
540 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
541 or `C-c a #' to produce the list."
542 :group 'org-agenda-custom-commands
543 :type '(list
544 (string :tag "Tags/TODO match to identify a project")
545 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
546 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
547 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
549 (defcustom org-agenda-filter-effort-default-operator "<"
550 "The default operator for effort estimate filtering.
551 If you select an effort estimate limit without first pressing an operator,
552 this one will be used."
553 :group 'org-agenda-custom-commands
554 :type '(choice (const :tag "less or equal" "<")
555 (const :tag "greater or equal"">")
556 (const :tag "equal" "=")))
558 (defgroup org-agenda-skip nil
559 "Options concerning skipping parts of agenda files."
560 :tag "Org Agenda Skip"
561 :group 'org-agenda)
563 (defcustom org-agenda-skip-function-global nil
564 "Function to be called at each match during agenda construction.
565 If this function returns nil, the current match should not be skipped.
566 If the function decided to skip an agenda match, is must return the
567 buffer position from which the search should be continued.
568 This may also be a Lisp form, which will be evaluated.
570 This variable will be applied to every agenda match, including
571 tags/property searches and TODO lists. So try to make the test function
572 do its checking as efficiently as possible. To implement a skipping
573 condition just for specific agenda commands, use the variable
574 `org-agenda-skip-function' which can be set in the options section
575 of custom agenda commands."
576 :group 'org-agenda-skip
577 :type 'sexp)
579 (defgroup org-agenda-daily/weekly nil
580 "Options concerning the daily/weekly agenda."
581 :tag "Org Agenda Daily/Weekly"
582 :group 'org-agenda)
583 (defgroup org-agenda-todo-list nil
584 "Options concerning the global todo list agenda view."
585 :tag "Org Agenda Todo List"
586 :group 'org-agenda)
587 (defgroup org-agenda-match-view nil
588 "Options concerning the general tags/property/todo match agenda view."
589 :tag "Org Agenda Match View"
590 :group 'org-agenda)
591 (defgroup org-agenda-search-view nil
592 "Options concerning the general tags/property/todo match agenda view."
593 :tag "Org Agenda Match View"
594 :group 'org-agenda)
596 (defvar org-agenda-archives-mode nil
597 "Non-nil means the agenda will include archived items.
598 If this is the symbol `trees', trees in the selected agenda scope
599 that are marked with the ARCHIVE tag will be included anyway. When this is
600 t, also all archive files associated with the current selection of agenda
601 files will be included.")
603 (defcustom org-agenda-skip-comment-trees t
604 "Non-nil means skip trees that start with the COMMENT keyword.
605 When nil, these trees are also scanned by agenda commands."
606 :group 'org-agenda-skip
607 :type 'boolean)
609 (defcustom org-agenda-todo-list-sublevels t
610 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
611 When nil, the sublevels of a TODO entry are not checked, resulting in
612 potentially much shorter TODO lists."
613 :group 'org-agenda-skip
614 :group 'org-agenda-todo-list
615 :type 'boolean)
617 (defcustom org-agenda-todo-ignore-with-date nil
618 "Non-nil means don't show entries with a date in the global todo list.
619 You can use this if you prefer to mark mere appointments with a TODO keyword,
620 but don't want them to show up in the TODO list.
621 When this is set, it also covers deadlines and scheduled items, the settings
622 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
623 will be ignored.
624 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
625 :group 'org-agenda-skip
626 :group 'org-agenda-todo-list
627 :type 'boolean)
629 (defcustom org-agenda-todo-ignore-timestamp nil
630 "Non-nil means don't show entries with a timestamp.
631 This applies when creating the global todo list.
632 Valid values are:
634 past Don't show entries for today or in the past.
636 future Don't show entries with a timestamp in the future.
637 The idea behind this is that if it has a future
638 timestamp, you don't want to think about it until the
639 date.
641 all Don't show any entries with a timestamp in the global todo list.
642 The idea behind this is that by setting a timestamp, you
643 have already \"taken care\" of this item.
645 This variable can also have an integer as a value. If positive (N),
646 todos with a timestamp N or more days in the future will be ignored. If
647 negative (-N), todos with a timestamp N or more days in the past will be
648 ignored. If 0, todos with a timestamp either today or in the future will
649 be ignored. For example, a value of -1 will exclude todos with a
650 timestamp in the past (yesterday or earlier), while a value of 7 will
651 exclude todos with a timestamp a week or more in the future.
653 See also `org-agenda-todo-ignore-with-date'.
654 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
655 to make his option also apply to the tags-todo list."
656 :group 'org-agenda-skip
657 :group 'org-agenda-todo-list
658 :version "24.1"
659 :type '(choice
660 (const :tag "Ignore future timestamp todos" future)
661 (const :tag "Ignore past or present timestamp todos" past)
662 (const :tag "Ignore all timestamp todos" all)
663 (const :tag "Show timestamp todos" nil)
664 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
666 (defcustom org-agenda-todo-ignore-scheduled nil
667 "Non-nil means, ignore some scheduled TODO items when making TODO list.
668 This applies when creating the global todo list.
669 Valid values are:
671 past Don't show entries scheduled today or in the past.
673 future Don't show entries scheduled in the future.
674 The idea behind this is that by scheduling it, you don't want to
675 think about it until the scheduled date.
677 all Don't show any scheduled entries in the global todo list.
678 The idea behind this is that by scheduling it, you have already
679 \"taken care\" of this item.
681 t Same as `all', for backward compatibility.
683 This variable can also have an integer as a value. See
684 `org-agenda-todo-ignore-timestamp' for more details.
686 See also `org-agenda-todo-ignore-with-date'.
687 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
688 to make his option also apply to the tags-todo list."
689 :group 'org-agenda-skip
690 :group 'org-agenda-todo-list
691 :type '(choice
692 (const :tag "Ignore future-scheduled todos" future)
693 (const :tag "Ignore past- or present-scheduled todos" past)
694 (const :tag "Ignore all scheduled todos" all)
695 (const :tag "Ignore all scheduled todos (compatibility)" t)
696 (const :tag "Show scheduled todos" nil)
697 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
699 (defcustom org-agenda-todo-ignore-deadlines nil
700 "Non-nil means ignore some deadlined TODO items when making TODO list.
701 There are different motivations for using different values, please think
702 carefully when configuring this variable.
704 This applies when creating the global todo list.
705 Valid values are:
707 near Don't show near deadline entries. A deadline is near when it is
708 closer than `org-deadline-warning-days' days. The idea behind this
709 is that such items will appear in the agenda anyway.
711 far Don't show TODO entries where a deadline has been defined, but
712 the deadline is not near. This is useful if you don't want to
713 use the todo list to figure out what to do now.
715 past Don't show entries with a deadline timestamp for today or in the past.
717 future Don't show entries with a deadline timestamp in the future, not even
718 when they become `near' ones. Use it with caution.
720 all Ignore all TODO entries that do have a deadline.
722 t Same as `near', for backward compatibility.
724 This variable can also have an integer as a value. See
725 `org-agenda-todo-ignore-timestamp' for more details.
727 See also `org-agenda-todo-ignore-with-date'.
728 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
729 to make his option also apply to the tags-todo list."
730 :group 'org-agenda-skip
731 :group 'org-agenda-todo-list
732 :type '(choice
733 (const :tag "Ignore near deadlines" near)
734 (const :tag "Ignore near deadlines (compatibility)" t)
735 (const :tag "Ignore far deadlines" far)
736 (const :tag "Ignore all TODOs with a deadlines" all)
737 (const :tag "Show all TODOs, even if they have a deadline" nil)
738 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
740 (defcustom org-agenda-tags-todo-honor-ignore-options nil
741 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
742 The variables
743 `org-agenda-todo-ignore-with-date',
744 `org-agenda-todo-ignore-timestamp',
745 `org-agenda-todo-ignore-scheduled',
746 `org-agenda-todo-ignore-deadlines'
747 make the global TODO list skip entries that have time stamps of certain
748 kinds. If this option is set, the same options will also apply for the
749 tags-todo search, which is the general tags/property matcher
750 restricted to unfinished TODO entries only."
751 :group 'org-agenda-skip
752 :group 'org-agenda-todo-list
753 :group 'org-agenda-match-view
754 :type 'boolean)
756 (defcustom org-agenda-skip-scheduled-if-done nil
757 "Non-nil means don't show scheduled items in agenda when they are done.
758 This is relevant for the daily/weekly agenda, not for the TODO list. And
759 it applies only to the actual date of the scheduling. Warnings about
760 an item with a past scheduling dates are always turned off when the item
761 is DONE."
762 :group 'org-agenda-skip
763 :group 'org-agenda-daily/weekly
764 :type 'boolean)
766 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
767 "Non-nil means skip scheduling line if same entry shows because of deadline.
768 In the agenda of today, an entry can show up multiple times because
769 it is both scheduled and has a nearby deadline, and maybe a plain time
770 stamp as well.
771 When this variable is t, then only the deadline is shown and the fact that
772 the entry is scheduled today or was scheduled previously is not shown.
773 When this variable is nil, the entry will be shown several times. When
774 the variable is the symbol `not-today', then skip scheduled previously,
775 but not scheduled today."
776 :group 'org-agenda-skip
777 :group 'org-agenda-daily/weekly
778 :type '(choice
779 (const :tag "Never" nil)
780 (const :tag "Always" t)
781 (const :tag "Not when scheduled today" not-today)))
783 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
784 "Non-nil means skip timestamp line if same entry shows because of deadline.
785 In the agenda of today, an entry can show up multiple times
786 because it has both a plain timestamp and has a nearby deadline.
787 When this variable is t, then only the deadline is shown and the
788 fact that the entry has a timestamp for or including today is not
789 shown. When this variable is nil, the entry will be shown
790 several times."
791 :group 'org-agenda-skip
792 :group 'org-agenda-daily/weekly
793 :version "24.1"
794 :type '(choice
795 (const :tag "Never" nil)
796 (const :tag "Always" t)))
798 (defcustom org-agenda-skip-deadline-if-done nil
799 "Non-nil means don't show deadlines when the corresponding item is done.
800 When nil, the deadline is still shown and should give you a happy feeling.
801 This is relevant for the daily/weekly agenda. And it applied only to the
802 actually date of the deadline. Warnings about approaching and past-due
803 deadlines are always turned off when the item is DONE."
804 :group 'org-agenda-skip
805 :group 'org-agenda-daily/weekly
806 :type 'boolean)
808 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
809 "Non-nil means skip deadline prewarning when entry is also scheduled.
810 This will apply on all days where a prewarning for the deadline would
811 be shown, but not at the day when the entry is actually due. On that day,
812 the deadline will be shown anyway.
813 This variable may be set to nil, t, or a number which will then give
814 the number of days before the actual deadline when the prewarnings
815 should resume.
816 This can be used in a workflow where the first showing of the deadline will
817 trigger you to schedule it, and then you don't want to be reminded of it
818 because you will take care of it on the day when scheduled."
819 :group 'org-agenda-skip
820 :group 'org-agenda-daily/weekly
821 :version "24.1"
822 :type '(choice
823 (const :tag "Alwas show prewarning" nil)
824 (const :tag "Remove prewarning if entry is scheduled" t)
825 (integer :tag "Restart prewarning N days before deadline")))
827 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
828 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
829 When non-nil, after the search for timestamps has matched once in an
830 entry, the rest of the entry will not be searched."
831 :group 'org-agenda-skip
832 :type 'boolean)
834 (defcustom org-agenda-skip-timestamp-if-done nil
835 "Non-nil means don't select item by timestamp or -range if it is DONE."
836 :group 'org-agenda-skip
837 :group 'org-agenda-daily/weekly
838 :type 'boolean)
840 (defcustom org-agenda-dim-blocked-tasks t
841 "Non-nil means dim blocked tasks in the agenda display.
842 This causes some overhead during agenda construction, but if you
843 have turned on `org-enforce-todo-dependencies',
844 `org-enforce-todo-checkbox-dependencies', or any other blocking
845 mechanism, this will create useful feedback in the agenda.
847 Instead of t, this variable can also have the value `invisible'.
848 Then blocked tasks will be invisible and only become visible when
849 they become unblocked. An exemption to this behavior is when a task is
850 blocked because of unchecked checkboxes below it. Since checkboxes do
851 not show up in the agenda views, making this task invisible you remove any
852 trace from agenda views that there is something to do. Therefore, a task
853 that is blocked because of checkboxes will never be made invisible, it
854 will only be dimmed."
855 :group 'org-agenda-daily/weekly
856 :group 'org-agenda-todo-list
857 :type '(choice
858 (const :tag "Do not dim" nil)
859 (const :tag "Dim to a gray face" t)
860 (const :tag "Make invisible" invisible)))
862 (defcustom org-timeline-show-empty-dates 3
863 "Non-nil means `org-timeline' also shows dates without an entry.
864 When nil, only the days which actually have entries are shown.
865 When t, all days between the first and the last date are shown.
866 When an integer, show also empty dates, but if there is a gap of more than
867 N days, just insert a special line indicating the size of the gap."
868 :group 'org-agenda-skip
869 :type '(choice
870 (const :tag "None" nil)
871 (const :tag "All" t)
872 (integer :tag "at most")))
874 (defgroup org-agenda-startup nil
875 "Options concerning initial settings in the Agenda in Org Mode."
876 :tag "Org Agenda Startup"
877 :group 'org-agenda)
879 (defcustom org-agenda-menu-show-matcher t
880 "Non-nil means show the match string in the agenda dispatcher menu.
881 When nil, the matcher string is not shown, but is put into the help-echo
882 property so than moving the mouse over the command shows it.
883 Setting it to nil is good if matcher strings are very long and/or if
884 you want to use two-columns display (see `org-agenda-menu-two-columns')."
885 :group 'org-agenda
886 :version "24.1"
887 :type 'boolean)
889 (make-obsolete-variable 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
891 (defcustom org-agenda-menu-two-columns nil
892 "Non-nil means, use two columns to show custom commands in the dispatcher.
893 If you use this, you probably want to set `org-agenda-menu-show-matcher'
894 to nil."
895 :group 'org-agenda
896 :version "24.1"
897 :type 'boolean)
899 (defcustom org-finalize-agenda-hook nil
900 "Hook run just before displaying an agenda buffer."
901 :group 'org-agenda-startup
902 :type 'hook)
904 (defcustom org-agenda-mouse-1-follows-link nil
905 "Non-nil means mouse-1 on a link will follow the link in the agenda.
906 A longer mouse click will still set point. Does not work on XEmacs.
907 Needs to be set before org.el is loaded."
908 :group 'org-agenda-startup
909 :type 'boolean)
911 (defcustom org-agenda-start-with-follow-mode nil
912 "The initial value of follow mode in a newly created agenda window."
913 :group 'org-agenda-startup
914 :type 'boolean)
916 (defcustom org-agenda-follow-indirect nil
917 "Non-nil means `org-agenda-follow-mode' displays only the
918 current item's tree, in an indirect buffer."
919 :group 'org-agenda
920 :version "24.1"
921 :type 'boolean)
923 (defcustom org-agenda-show-outline-path t
924 "Non-nil means show outline path in echo area after line motion."
925 :group 'org-agenda-startup
926 :type 'boolean)
928 (defcustom org-agenda-start-with-entry-text-mode nil
929 "The initial value of entry-text-mode in a newly created agenda window."
930 :group 'org-agenda-startup
931 :type 'boolean)
933 (defcustom org-agenda-entry-text-maxlines 5
934 "Number of text lines to be added when `E' is pressed in the agenda.
936 Note that this variable only used during agenda display. Add add entry text
937 when exporting the agenda, configure the variable
938 `org-agenda-add-entry-ext-maxlines'."
939 :group 'org-agenda
940 :type 'integer)
942 (defcustom org-agenda-entry-text-exclude-regexps nil
943 "List of regular expressions to clean up entry text.
944 The complete matches of all regular expressions in this list will be
945 removed from entry text before it is shown in the agenda."
946 :group 'org-agenda
947 :type '(repeat (regexp)))
949 (defvar org-agenda-entry-text-cleanup-hook nil
950 "Hook that is run after basic cleanup of entry text to be shown in agenda.
951 This cleanup is done in a temporary buffer, so the function may inspect and
952 change the entire buffer.
953 Some default stuff like drawers and scheduling/deadline dates will already
954 have been removed when this is called, as will any matches for regular
955 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
957 (defvar org-agenda-include-inactive-timestamps nil
958 "Non-nil means include inactive time stamps in agenda and timeline.
959 Dynamically scoped.")
961 (defgroup org-agenda-windows nil
962 "Options concerning the windows used by the Agenda in Org Mode."
963 :tag "Org Agenda Windows"
964 :group 'org-agenda)
966 (defcustom org-agenda-window-setup 'reorganize-frame
967 "How the agenda buffer should be displayed.
968 Possible values for this option are:
970 current-window Show agenda in the current window, keeping all other windows.
971 other-window Use `switch-to-buffer-other-window' to display agenda.
972 reorganize-frame Show only two windows on the current frame, the current
973 window and the agenda.
974 other-frame Use `switch-to-buffer-other-frame' to display agenda.
975 Also, when exiting the agenda, kill that frame.
976 See also the variable `org-agenda-restore-windows-after-quit'."
977 :group 'org-agenda-windows
978 :type '(choice
979 (const current-window)
980 (const other-frame)
981 (const other-window)
982 (const reorganize-frame)))
984 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
985 "The min and max height of the agenda window as a fraction of frame height.
986 The value of the variable is a cons cell with two numbers between 0 and 1.
987 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
988 :group 'org-agenda-windows
989 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
991 (defcustom org-agenda-restore-windows-after-quit nil
992 "Non-nil means restore window configuration upon exiting agenda.
993 Before the window configuration is changed for displaying the agenda,
994 the current status is recorded. When the agenda is exited with
995 `q' or `x' and this option is set, the old state is restored. If
996 `org-agenda-window-setup' is `other-frame', the value of this
997 option will be ignored."
998 :group 'org-agenda-windows
999 :type 'boolean)
1001 (defcustom org-agenda-ndays nil
1002 "Number of days to include in overview display.
1003 Should be 1 or 7.
1004 Obsolete, see `org-agenda-span'."
1005 :group 'org-agenda-daily/weekly
1006 :type 'integer)
1008 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1010 (defcustom org-agenda-span 'week
1011 "Number of days to include in overview display.
1012 Can be day, week, month, year, or any number of days.
1013 Custom commands can set this variable in the options section."
1014 :group 'org-agenda-daily/weekly
1015 :type '(choice (const :tag "Day" day)
1016 (const :tag "Week" week)
1017 (const :tag "Month" month)
1018 (const :tag "Year" year)
1019 (integer :tag "Custom")))
1021 (defcustom org-agenda-start-on-weekday 1
1022 "Non-nil means start the overview always on the specified weekday.
1023 0 denotes Sunday, 1 denotes Monday etc.
1024 When nil, always start on the current day.
1025 Custom commands can set this variable in the options section."
1026 :group 'org-agenda-daily/weekly
1027 :type '(choice (const :tag "Today" nil)
1028 (integer :tag "Weekday No.")))
1030 (defcustom org-agenda-show-all-dates t
1031 "Non-nil means `org-agenda' shows every day in the selected range.
1032 When nil, only the days which actually have entries are shown."
1033 :group 'org-agenda-daily/weekly
1034 :type 'boolean)
1036 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1037 "Format string for displaying dates in the agenda.
1038 Used by the daily/weekly agenda and by the timeline. This should be
1039 a format string understood by `format-time-string', or a function returning
1040 the formatted date as a string. The function must take a single argument,
1041 a calendar-style date list like (month day year)."
1042 :group 'org-agenda-daily/weekly
1043 :type '(choice
1044 (string :tag "Format string")
1045 (function :tag "Function")))
1047 (defun org-agenda-format-date-aligned (date)
1048 "Format a date string for display in the daily/weekly agenda, or timeline.
1049 This function makes sure that dates are aligned for easy reading."
1050 (require 'cal-iso)
1051 (let* ((dayname (calendar-day-name date))
1052 (day (cadr date))
1053 (day-of-week (calendar-day-of-week date))
1054 (month (car date))
1055 (monthname (calendar-month-name month))
1056 (year (nth 2 date))
1057 (iso-week (org-days-to-iso-week
1058 (calendar-absolute-from-gregorian date)))
1059 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1060 (1- year))
1061 ((and (= month 12) (<= iso-week 1))
1062 (1+ year))
1063 (t year)))
1064 (weekstring (if (= day-of-week 1)
1065 (format " W%02d" iso-week)
1066 "")))
1067 (format "%-10s %2d %s %4d%s"
1068 dayname day monthname year weekstring)))
1070 (defcustom org-agenda-time-leading-zero nil
1071 "Non-nil means use leading zero for military times in agenda.
1072 For example, 9:30am would become 09:30 rather than 9:30."
1073 :group 'org-agenda-daily/weekly
1074 :version "24.1"
1075 :type 'boolean)
1077 (defcustom org-agenda-timegrid-use-ampm nil
1078 "When set, show AM/PM style timestamps on the timegrid."
1079 :group 'org-agenda
1080 :version "24.1"
1081 :type 'boolean)
1083 (defun org-agenda-time-of-day-to-ampm (time)
1084 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1085 (let* ((hour-number (string-to-number (substring time 0 -3)))
1086 (minute (substring time -2))
1087 (ampm "am"))
1088 (cond
1089 ((equal hour-number 12)
1090 (setq ampm "pm"))
1091 ((> hour-number 12)
1092 (setq ampm "pm")
1093 (setq hour-number (- hour-number 12))))
1094 (concat
1095 (if org-agenda-time-leading-zero
1096 (format "%02d" hour-number)
1097 (format "%02s" (number-to-string hour-number)))
1098 ":" minute ampm)))
1100 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1101 "Conditionally convert TIME to AM/PM format
1102 based on `org-agenda-timegrid-use-ampm'"
1103 (if org-agenda-timegrid-use-ampm
1104 (org-agenda-time-of-day-to-ampm time)
1105 time))
1107 (defcustom org-agenda-weekend-days '(6 0)
1108 "Which days are weekend?
1109 These days get the special face `org-agenda-date-weekend' in the agenda
1110 and timeline buffers."
1111 :group 'org-agenda-daily/weekly
1112 :type '(set :greedy t
1113 (const :tag "Monday" 1)
1114 (const :tag "Tuesday" 2)
1115 (const :tag "Wednesday" 3)
1116 (const :tag "Thursday" 4)
1117 (const :tag "Friday" 5)
1118 (const :tag "Saturday" 6)
1119 (const :tag "Sunday" 0)))
1121 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1122 "Non-nil means jump to today when moving a past date forward in time.
1123 When using S-right in the agenda to move a a date forward, and the date
1124 stamp currently points to the past, the first key press will move it
1125 to today. WHen nil, just move one day forward even if the date stays
1126 in the past."
1127 :group 'org-agenda-daily/weekly
1128 :version "24.1"
1129 :type 'boolean)
1131 (defcustom org-agenda-include-diary nil
1132 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1133 Custom commands can set this variable in the options section."
1134 :group 'org-agenda-daily/weekly
1135 :type 'boolean)
1137 (defcustom org-agenda-include-deadlines t
1138 "If non-nil, include entries within their deadline warning period.
1139 Custom commands can set this variable in the options section."
1140 :group 'org-agenda-daily/weekly
1141 :version "24.1"
1142 :type 'boolean)
1144 (defcustom org-agenda-repeating-timestamp-show-all t
1145 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1146 When set to a list of strings, only show occurrences of repeating
1147 stamps for these TODO keywords. When nil, only one occurrence is
1148 shown, either today or the nearest into the future."
1149 :group 'org-agenda-daily/weekly
1150 :type '(choice
1151 (const :tag "Show repeating stamps" t)
1152 (repeat :tag "Show repeating stamps for these TODO keywords"
1153 (string :tag "TODO Keyword"))
1154 (const :tag "Don't show repeating stamps" nil)))
1156 (defcustom org-scheduled-past-days 10000
1157 "No. of days to continue listing scheduled items that are not marked DONE.
1158 When an item is scheduled on a date, it shows up in the agenda on this
1159 day and will be listed until it is marked done for the number of days
1160 given here."
1161 :group 'org-agenda-daily/weekly
1162 :type 'integer)
1164 (defcustom org-agenda-log-mode-items '(closed clock)
1165 "List of items that should be shown in agenda log mode.
1166 This list may contain the following symbols:
1168 closed Show entries that have been closed on that day.
1169 clock Show entries that have received clocked time on that day.
1170 state Show all logged state changes.
1171 Note that instead of changing this variable, you can also press `C-u l' in
1172 the agenda to display all available LOG items temporarily."
1173 :group 'org-agenda-daily/weekly
1174 :type '(set :greedy t (const closed) (const clock) (const state)))
1176 (defcustom org-agenda-clock-consistency-checks
1177 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1178 :gap-ok-around ("4:00")
1179 :default-face ((:background "DarkRed") (:foreground "white"))
1180 :overlap-face nil :gap-face nil :no-end-time-face nil
1181 :long-face nil :short-face nil)
1182 "This is a property list, with the following keys:
1184 :max-duration Mark clocking chunks that are longer than this time.
1185 This is a time string like \"HH:MM\", or the number
1186 of minutes as an integer.
1188 :min-duration Mark clocking chunks that are shorter that this.
1189 This is a time string like \"HH:MM\", or the number
1190 of minutes as an integer.
1192 :max-gap Mark gaps between clocking chunks that are longer than
1193 this duration. A number of minutes, or a string
1194 like \"HH:MM\".
1196 :gap-ok-around List of times during the day which are usually not working
1197 times. When a gap is detected, but the gap contains any
1198 of these times, the gap is *not* reported. For example,
1199 if this is (\"4:00\" \"13:00\") then gaps that contain
1200 4:00 in the morning (i.e. the night) and 13:00
1201 (i.e. a typical lunch time) do not cause a warning.
1202 You should have at least one time during the night in this
1203 list, or otherwise the first task each morning will trigger
1204 a warning because it follows a long gap.
1206 Furthermore, the following properties can be used to define faces for
1207 issue display.
1209 :default-face the default face, if the specific face is undefined
1210 :overlap-face face for overlapping clocks
1211 :gap-face face for gaps between clocks
1212 :no-end-time-face face for incomplete clocks
1213 :long-face face for clock intervals that are too long
1214 :short-face face for clock intervals that are too short"
1215 :group 'org-agenda-daily/weekly
1216 :group 'org-clock
1217 :version "24.1"
1218 :type 'plist)
1220 (defcustom org-agenda-log-mode-add-notes t
1221 "Non-nil means add first line of notes to log entries in agenda views.
1222 If a log item like a state change or a clock entry is associated with
1223 notes, the first line of these notes will be added to the entry in the
1224 agenda display."
1225 :group 'org-agenda-daily/weekly
1226 :type 'boolean)
1228 (defcustom org-agenda-start-with-log-mode nil
1229 "The initial value of log-mode in a newly created agenda window.
1230 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1231 explanations on the possible values."
1232 :group 'org-agenda-startup
1233 :group 'org-agenda-daily/weekly
1234 :type '(choice (const :tag "Don't show log items" nil)
1235 (const :tag "Show only log items" 'only)
1236 (const :tag "Show all possible log items" 'clockcheck)
1237 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1238 (choice (const :tag "Show closed log items" 'closed)
1239 (const :tag "Show clocked log items" 'clock)
1240 (const :tag "Show all logged state changes" 'state)))))
1242 (defcustom org-agenda-start-with-clockreport-mode nil
1243 "The initial value of clockreport-mode in a newly created agenda window."
1244 :group 'org-agenda-startup
1245 :group 'org-agenda-daily/weekly
1246 :type 'boolean)
1248 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1249 "Property list with parameters for the clocktable in clockreport mode.
1250 This is the display mode that shows a clock table in the daily/weekly
1251 agenda, the properties for this dynamic block can be set here.
1252 The usual clocktable parameters are allowed here, but you cannot set
1253 the properties :name, :tstart, :tend, :block, and :scope - these will
1254 be overwritten to make sure the content accurately reflects the
1255 current display in the agenda."
1256 :group 'org-agenda-daily/weekly
1257 :type 'plist)
1259 (defcustom org-agenda-search-view-always-boolean nil
1260 "Non-nil means the search string is interpreted as individual parts.
1262 The search string for search view can either be interpreted as a phrase,
1263 or as a list of snippets that define a boolean search for a number of
1264 strings.
1266 When this is non-nil, the string will be split on whitespace, and each
1267 snippet will be searched individually, and all must match in order to
1268 select an entry. A snippet is then a single string of non-white
1269 characters, or a string in double quotes, or a regexp in {} braces.
1270 If a snippet is preceded by \"-\", the snippet must *not* match.
1271 \"+\" is syntactic sugar for positive selection. Each snippet may
1272 be found as a full word or a partial word, but see the variable
1273 `org-agenda-search-view-force-full-words'.
1275 When this is nil, search will look for the entire search phrase as one,
1276 with each space character matching any amount of whitespace, including
1277 line breaks.
1279 Even when this is nil, you can still switch to Boolean search dynamically
1280 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1281 is a regexp marked with braces like \"{abc}\", this will also switch to
1282 boolean search."
1283 :group 'org-agenda-search-view
1284 :version "24.1"
1285 :type 'boolean)
1287 (if (fboundp 'defvaralias)
1288 (defvaralias 'org-agenda-search-view-search-words-only
1289 'org-agenda-search-view-always-boolean))
1291 (defcustom org-agenda-search-view-force-full-words nil
1292 "Non-nil means, search words must be matches as complete words.
1293 When nil, they may also match part of a word."
1294 :group 'org-agenda-search-view
1295 :version "24.1"
1296 :type 'boolean)
1298 (defgroup org-agenda-time-grid nil
1299 "Options concerning the time grid in the Org-mode Agenda."
1300 :tag "Org Agenda Time Grid"
1301 :group 'org-agenda)
1303 (defcustom org-agenda-search-headline-for-time t
1304 "Non-nil means search headline for a time-of-day.
1305 If the headline contains a time-of-day in one format or another, it will
1306 be used to sort the entry into the time sequence of items for a day.
1307 Some people have time stamps in the headline that refer to the creation
1308 time or so, and then this produces an unwanted side effect. If this is
1309 the case for your, use this variable to turn off searching the headline
1310 for a time."
1311 :group 'org-agenda-time-grid
1312 :type 'boolean)
1314 (defcustom org-agenda-use-time-grid t
1315 "Non-nil means show a time grid in the agenda schedule.
1316 A time grid is a set of lines for specific times (like every two hours between
1317 8:00 and 20:00). The items scheduled for a day at specific times are
1318 sorted in between these lines.
1319 For details about when the grid will be shown, and what it will look like, see
1320 the variable `org-agenda-time-grid'."
1321 :group 'org-agenda-time-grid
1322 :type 'boolean)
1324 (defcustom org-agenda-time-grid
1325 '((daily today require-timed)
1326 "----------------"
1327 (800 1000 1200 1400 1600 1800 2000))
1329 "The settings for time grid for agenda display.
1330 This is a list of three items. The first item is again a list. It contains
1331 symbols specifying conditions when the grid should be displayed:
1333 daily if the agenda shows a single day
1334 weekly if the agenda shows an entire week
1335 today show grid on current date, independent of daily/weekly display
1336 require-timed show grid only if at least one item has a time specification
1338 The second item is a string which will be placed behind the grid time.
1340 The third item is a list of integers, indicating the times that should have
1341 a grid line."
1342 :group 'org-agenda-time-grid
1343 :type
1344 '(list
1345 (set :greedy t :tag "Grid Display Options"
1346 (const :tag "Show grid in single day agenda display" daily)
1347 (const :tag "Show grid in weekly agenda display" weekly)
1348 (const :tag "Always show grid for today" today)
1349 (const :tag "Show grid only if any timed entries are present"
1350 require-timed)
1351 (const :tag "Skip grid times already present in an entry"
1352 remove-match))
1353 (string :tag "Grid String")
1354 (repeat :tag "Grid Times" (integer :tag "Time"))))
1356 (defcustom org-agenda-show-current-time-in-grid t
1357 "Non-nil means show the current time in the time grid."
1358 :group 'org-agenda-time-grid
1359 :version "24.1"
1360 :type 'boolean)
1362 (defcustom org-agenda-current-time-string
1363 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1364 "The string for the current time marker in the agenda."
1365 :group 'org-agenda-time-grid
1366 :version "24.1"
1367 :type 'string)
1369 (defgroup org-agenda-sorting nil
1370 "Options concerning sorting in the Org-mode Agenda."
1371 :tag "Org Agenda Sorting"
1372 :group 'org-agenda)
1374 (defcustom org-agenda-sorting-strategy
1375 '((agenda habit-down time-up priority-down category-keep)
1376 (todo priority-down category-keep)
1377 (tags priority-down category-keep)
1378 (search category-keep))
1379 "Sorting structure for the agenda items of a single day.
1380 This is a list of symbols which will be used in sequence to determine
1381 if an entry should be listed before another entry. The following
1382 symbols are recognized:
1384 time-up Put entries with time-of-day indications first, early first
1385 time-down Put entries with time-of-day indications first, late first
1386 category-keep Keep the default order of categories, corresponding to the
1387 sequence in `org-agenda-files'.
1388 category-up Sort alphabetically by category, A-Z.
1389 category-down Sort alphabetically by category, Z-A.
1390 tag-up Sort alphabetically by last tag, A-Z.
1391 tag-down Sort alphabetically by last tag, Z-A.
1392 priority-up Sort numerically by priority, high priority last.
1393 priority-down Sort numerically by priority, high priority first.
1394 todo-state-up Sort by todo state, tasks that are done last.
1395 todo-state-down Sort by todo state, tasks that are done first.
1396 effort-up Sort numerically by estimated effort, high effort last.
1397 effort-down Sort numerically by estimated effort, high effort first.
1398 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1399 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1400 habit-up Put entries that are habits first
1401 habit-down Put entries that are habits last
1402 alpha-up Sort headlines alphabetically
1403 alpha-down Sort headlines alphabetically, reversed
1405 The different possibilities will be tried in sequence, and testing stops
1406 if one comparison returns a \"not-equal\". For example, the default
1407 '(time-up category-keep priority-down)
1408 means: Pull out all entries having a specified time of day and sort them,
1409 in order to make a time schedule for the current day the first thing in the
1410 agenda listing for the day. Of the entries without a time indication, keep
1411 the grouped in categories, don't sort the categories, but keep them in
1412 the sequence given in `org-agenda-files'. Within each category sort by
1413 priority.
1415 Leaving out `category-keep' would mean that items will be sorted across
1416 categories by priority.
1418 Instead of a single list, this can also be a set of list for specific
1419 contents, with a context symbol in the car of the list, any of
1420 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1422 Custom commands can bind this variable in the options section."
1423 :group 'org-agenda-sorting
1424 :type `(choice
1425 (repeat :tag "General" ,org-sorting-choice)
1426 (list :tag "Individually"
1427 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1428 (repeat ,org-sorting-choice))
1429 (cons (const :tag "Strategy for TODO lists" todo)
1430 (repeat ,org-sorting-choice))
1431 (cons (const :tag "Strategy for Tags matches" tags)
1432 (repeat ,org-sorting-choice))
1433 (cons (const :tag "Strategy for search matches" search)
1434 (repeat ,org-sorting-choice)))))
1436 (defcustom org-agenda-cmp-user-defined nil
1437 "A function to define the comparison `user-defined'.
1438 This function must receive two arguments, agenda entry a and b.
1439 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1440 the user comparison, return nil.
1441 When this is defined, you can make `user-defined-up' and `user-defined-down'
1442 part of an agenda sorting strategy."
1443 :group 'org-agenda-sorting
1444 :type 'symbol)
1446 (defcustom org-sort-agenda-notime-is-late t
1447 "Non-nil means items without time are considered late.
1448 This is only relevant for sorting. When t, items which have no explicit
1449 time like 15:30 will be considered as 99:01, i.e. later than any items which
1450 do have a time. When nil, the default time is before 0:00. You can use this
1451 option to decide if the schedule for today should come before or after timeless
1452 agenda entries."
1453 :group 'org-agenda-sorting
1454 :type 'boolean)
1456 (defcustom org-sort-agenda-noeffort-is-high t
1457 "Non-nil means items without effort estimate are sorted as high effort.
1458 This also applies when filtering an agenda view with respect to the
1459 < or > effort operator. Then, tasks with no effort defined will be treated
1460 as tasks with high effort.
1461 When nil, such items are sorted as 0 minutes effort."
1462 :group 'org-agenda-sorting
1463 :type 'boolean)
1465 (defgroup org-agenda-line-format nil
1466 "Options concerning the entry prefix in the Org-mode agenda display."
1467 :tag "Org Agenda Line Format"
1468 :group 'org-agenda)
1470 (defcustom org-agenda-prefix-format
1471 '((agenda . " %i %-12:c%?-12t% s")
1472 (timeline . " % s")
1473 (todo . " %i %-12:c")
1474 (tags . " %i %-12:c")
1475 (search . " %i %-12:c"))
1476 "Format specifications for the prefix of items in the agenda views.
1477 An alist with five entries, each for the different agenda types. The
1478 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1479 The values are format strings.
1481 This format works similar to a printf format, with the following meaning:
1483 %c the category of the item, \"Diary\" for entries from the diary,
1484 or as given by the CATEGORY keyword or derived from the file name
1485 %e the effort required by the item
1486 %i the icon category of the item, see `org-agenda-category-icon-alist'
1487 %T the last tag of the item (ignore inherited tags, which come first)
1488 %t the HH:MM time-of-day specification if one applies to the entry
1489 %s Scheduling/Deadline information, a short string
1490 %(expression) Eval EXPRESSION and replace the control string
1491 by the result
1493 All specifiers work basically like the standard `%s' of printf, but may
1494 contain two additional characters: a question mark just after the `%'
1495 and a whitespace/punctuation character just before the final letter.
1497 If the first character after `%' is a question mark, the entire field
1498 will only be included if the corresponding value applies to the current
1499 entry. This is useful for fields which should have fixed width when
1500 present, but zero width when absent. For example, \"%?-12t\" will
1501 result in a 12 character time field if a time of the day is specified,
1502 but will completely disappear in entries which do not contain a time.
1504 If there is punctuation or whitespace character just before the final
1505 format letter, this character will be appended to the field value if
1506 the value is not empty. For example, the format \"%-12:c\" leads to
1507 \"Diary: \" if the category is \"Diary\". If the category were be
1508 empty, no additional colon would be inserted.
1510 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1511 which means:
1513 - Indent the line with two space characters
1514 - Give the category a 12 chars wide field, padded with whitespace on
1515 the right (because of `-'). Append a colon if there is a category
1516 (because of `:').
1517 - If there is a time-of-day, put it into a 12 chars wide field. If no
1518 time, don't put in an empty field, just skip it (because of '?').
1519 - Finally, put the scheduling information.
1521 See also the variables `org-agenda-remove-times-when-in-prefix' and
1522 `org-agenda-remove-tags'.
1524 Custom commands can set this variable in the options section."
1525 :type '(choice
1526 (string :tag "General format")
1527 (list :greedy t :tag "View dependent"
1528 (cons (const agenda) (string :tag "Format"))
1529 (cons (const timeline) (string :tag "Format"))
1530 (cons (const todo) (string :tag "Format"))
1531 (cons (const tags) (string :tag "Format"))
1532 (cons (const search) (string :tag "Format"))))
1533 :group 'org-agenda-line-format)
1535 (defvar org-prefix-format-compiled nil
1536 "The compiled prefix format and associated variables.
1537 This is a list where first element is a list of variable bindings, and second
1538 element is the compiled format expression. See the variable
1539 `org-agenda-prefix-format'.")
1541 (defcustom org-agenda-todo-keyword-format "%-1s"
1542 "Format for the TODO keyword in agenda lines.
1543 Set this to something like \"%-12s\" if you want all TODO keywords
1544 to occupy a fixed space in the agenda display."
1545 :group 'org-agenda-line-format
1546 :type 'string)
1548 (defcustom org-agenda-diary-sexp-prefix nil
1549 "A regexp that matches part of a diary sexp entry
1550 which should be treated as scheduling/deadline information in
1551 `org-agenda'.
1553 For example, you can use this to extract the `diary-remind-message' from
1554 `diary-remind' entries."
1555 :group 'org-agenda-line-format
1556 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1558 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1559 "Text preceding timerange entries in the agenda view.
1560 This is a list with two strings. The first applies when the range
1561 is entirely on one day. The second applies if the range spans several days.
1562 The strings may have two \"%d\" format specifiers which will be filled
1563 with the sequence number of the days, and the total number of days in the
1564 range, respectively."
1565 :group 'org-agenda-line-format
1566 :type '(list
1567 (string :tag "Deadline today ")
1568 (choice :tag "Deadline relative"
1569 (string :tag "Format string")
1570 (function))))
1572 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1573 "Text preceding scheduled items in the agenda view.
1574 This is a list with two strings. The first applies when the item is
1575 scheduled on the current day. The second applies when it has been scheduled
1576 previously, it may contain a %d indicating that this is the nth time that
1577 this item is scheduled, due to automatic rescheduling of unfinished items
1578 for the following day. So this number is one larger than the number of days
1579 that passed since this item was scheduled first."
1580 :group 'org-agenda-line-format
1581 :type '(list
1582 (string :tag "Scheduled today ")
1583 (string :tag "Scheduled previously")))
1585 (defcustom org-agenda-inactive-leader "["
1586 "Text preceding item pulled into the agenda by inactive time stamps.
1587 These entries are added to the agenda when pressing \"[\"."
1588 :group 'org-agenda-line-format
1589 :version "24.1"
1590 :type '(list
1591 (string :tag "Scheduled today ")
1592 (string :tag "Scheduled previously")))
1594 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
1595 "Text preceding deadline items in the agenda view.
1596 This is a list with two strings. The first applies when the item has its
1597 deadline on the current day. The second applies when it is in the past or
1598 in the future, it may contain %d to capture how many days away the deadline
1599 is (was)."
1600 :group 'org-agenda-line-format
1601 :type '(list
1602 (string :tag "Deadline today ")
1603 (choice :tag "Deadline relative"
1604 (string :tag "Format string")
1605 (function))))
1607 (defcustom org-agenda-remove-times-when-in-prefix t
1608 "Non-nil means remove duplicate time specifications in agenda items.
1609 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1610 time-of-day specification in a headline or diary entry is extracted and
1611 placed into the prefix. If this option is non-nil, the original specification
1612 \(a timestamp or -range, or just a plain time(range) specification like
1613 11:30-4pm) will be removed for agenda display. This makes the agenda less
1614 cluttered.
1615 The option can be t or nil. It may also be the symbol `beg', indicating
1616 that the time should only be removed when it is located at the beginning of
1617 the headline/diary entry."
1618 :group 'org-agenda-line-format
1619 :type '(choice
1620 (const :tag "Always" t)
1621 (const :tag "Never" nil)
1622 (const :tag "When at beginning of entry" beg)))
1624 (defcustom org-agenda-remove-timeranges-from-blocks nil
1625 "Non-nil means remove time ranges specifications in agenda
1626 items that span on several days."
1627 :group 'org-agenda-line-format
1628 :version "24.1"
1629 :type 'boolean)
1631 (defcustom org-agenda-default-appointment-duration nil
1632 "Default duration for appointments that only have a starting time.
1633 When nil, no duration is specified in such cases.
1634 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1635 :group 'org-agenda-line-format
1636 :type '(choice
1637 (integer :tag "Minutes")
1638 (const :tag "No default duration")))
1640 (defcustom org-agenda-show-inherited-tags t
1641 "Non-nil means show inherited tags in each agenda line."
1642 :group 'org-agenda-line-format
1643 :type 'boolean)
1645 (defcustom org-agenda-hide-tags-regexp nil
1646 "Regular expression used to filter away specific tags in agenda views.
1647 This means that these tags will be present, but not be shown in the agenda
1648 line. Secondary filtering will still work on the hidden tags.
1649 Nil means don't hide any tags."
1650 :group 'org-agenda-line-format
1651 :type '(choice
1652 (const :tag "Hide none" nil)
1653 (string :tag "Regexp ")))
1655 (defcustom org-agenda-remove-tags nil
1656 "Non-nil means remove the tags from the headline copy in the agenda.
1657 When this is the symbol `prefix', only remove tags when
1658 `org-agenda-prefix-format' contains a `%T' specifier."
1659 :group 'org-agenda-line-format
1660 :type '(choice
1661 (const :tag "Always" t)
1662 (const :tag "Never" nil)
1663 (const :tag "When prefix format contains %T" prefix)))
1665 (if (fboundp 'defvaralias)
1666 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1667 'org-agenda-remove-tags))
1669 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1670 "Shift tags in agenda items to this column.
1671 If this number is positive, it specifies the column. If it is negative,
1672 it means that the tags should be flushright to that column. For example,
1673 -80 works well for a normal 80 character screen."
1674 :group 'org-agenda-line-format
1675 :type 'integer)
1677 (if (fboundp 'defvaralias)
1678 (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1680 (defcustom org-agenda-fontify-priorities 'cookies
1681 "Non-nil means highlight low and high priorities in agenda.
1682 When t, the highest priority entries are bold, lowest priority italic.
1683 However, settings in `org-priority-faces' will overrule these faces.
1684 When this variable is the symbol `cookies', only fontify the
1685 cookies, not the entire task.
1686 This may also be an association list of priority faces, whose
1687 keys are the character values of `org-highest-priority',
1688 `org-default-priority', and `org-lowest-priority' (the default values
1689 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1690 color as a string, or a list like `(:background \"Red\")'.
1691 If it is a color, the variable `org-faces-easy-properties'
1692 determines if it is a foreground or a background color."
1693 :group 'org-agenda-line-format
1694 :type '(choice
1695 (const :tag "Never" nil)
1696 (const :tag "Defaults" t)
1697 (const :tag "Cookies only" cookies)
1698 (repeat :tag "Specify"
1699 (list (character :tag "Priority" :value ?A)
1700 (choice :tag "Face "
1701 (string :tag "Color")
1702 (sexp :tag "Face"))))))
1704 (defcustom org-agenda-day-face-function nil
1705 "Function called to determine what face should be used to display a day.
1706 The only argument passed to that function is the day. It should
1707 returns a face, or nil if does not want to specify a face and let
1708 the normal rules apply."
1709 :group 'org-agenda-line-format
1710 :version "24.1"
1711 :type 'function)
1713 (defcustom org-agenda-category-icon-alist nil
1714 "Alist of category icon to be displayed in agenda views.
1716 Each entry should have the following format:
1718 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1720 Where CATEGORY-REGEXP is a regexp matching the categories where
1721 the icon should be displayed.
1722 FILE-OR-DATA either a file path or a string containing image data.
1724 The other fields can be omitted safely if not needed:
1725 TYPE indicates the image type.
1726 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1727 image data.
1728 PROPS are additional image attributes to assign to the image,
1729 like, e.g. `:ascent center'.
1731 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1733 If you want to set the display properties yourself, just put a
1734 list as second element:
1736 (CATEGORY-REGEXP (MY PROPERTY LIST))
1738 For example, to display a 16px horizontal space for Emacs
1739 category, you can use:
1741 (\"Emacs\" '(space . (:width (16))))"
1742 :group 'org-agenda-line-format
1743 :version "24.1"
1744 :type '(alist :key-type (string :tag "Regexp matching category")
1745 :value-type (choice (list :tag "Icon"
1746 (string :tag "File or data")
1747 (symbol :tag "Type")
1748 (boolean :tag "Data?")
1749 (repeat :tag "Extra image properties" :inline t symbol))
1750 (list :tag "Display properties" sexp))))
1752 (defgroup org-agenda-column-view nil
1753 "Options concerning column view in the agenda."
1754 :tag "Org Agenda Column View"
1755 :group 'org-agenda)
1757 (defcustom org-agenda-columns-show-summaries t
1758 "Non-nil means show summaries for columns displayed in the agenda view."
1759 :group 'org-agenda-column-view
1760 :type 'boolean)
1762 (defcustom org-agenda-columns-compute-summary-properties t
1763 "Non-nil means recompute all summary properties before column view.
1764 When column view in the agenda is listing properties that have a summary
1765 operator, it can go to all relevant buffers and recompute the summaries
1766 there. This can mean overhead for the agenda column view, but is necessary
1767 to have thing up to date.
1768 As a special case, a CLOCKSUM property also makes sure that the clock
1769 computations are current."
1770 :group 'org-agenda-column-view
1771 :type 'boolean)
1773 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1774 "Non-nil means the duration of an appointment will add to day effort.
1775 The property to which appointment durations will be added is the one given
1776 in the option `org-effort-property'. If an appointment does not have
1777 an end time, `org-agenda-default-appointment-duration' will be used. If that
1778 is not set, an appointment without end time will not contribute to the time
1779 estimate."
1780 :group 'org-agenda-column-view
1781 :type 'boolean)
1783 (defcustom org-agenda-auto-exclude-function nil
1784 "A function called with a tag to decide if it is filtered on '/ RET'.
1785 The sole argument to the function, which is called once for each
1786 possible tag, is a string giving the name of the tag. The
1787 function should return either nil if the tag should be included
1788 as normal, or \"-<TAG>\" to exclude the tag.
1789 Note that for the purpose of tag filtering, only the lower-case version of
1790 all tags will be considered, so that this function will only ever see
1791 the lower-case version of all tags."
1792 :group 'org-agenda
1793 :type 'function)
1795 (defcustom org-agenda-bulk-custom-functions nil
1796 "Alist of characters and custom functions for bulk actions.
1797 For example, this value makes those two functions available:
1799 '((?R set-category)
1800 (?C bulk-cut))
1802 With selected entries in an agenda buffer, `B R' will call
1803 the custom function `set-category' on the selected entries.
1804 Note that functions in this alist don't need to be quoted."
1805 :type 'alist
1806 :version "24.1"
1807 :group 'org-agenda)
1809 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1810 "Execute BODY with point at location given by `org-hd-marker' property.
1811 If STRING is non-nil, the text property will be fetched from position 0
1812 in that string. If STRING is nil, it will be fetched from the beginning
1813 of the current line."
1814 (org-with-gensyms (marker)
1815 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1816 'org-hd-marker ,string)))
1817 (with-current-buffer (marker-buffer ,marker)
1818 (save-excursion
1819 (goto-char ,marker)
1820 ,@body)))))
1821 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1823 (defun org-add-agenda-custom-command (entry)
1824 "Replace or add a command in `org-agenda-custom-commands'.
1825 This is mostly for hacking and trying a new command - once the command
1826 works you probably want to add it to `org-agenda-custom-commands' for good."
1827 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1828 (if ass
1829 (setcdr ass (cdr entry))
1830 (push entry org-agenda-custom-commands))))
1832 ;;; Define the org-agenda-mode
1834 (defvar org-agenda-mode-map (make-sparse-keymap)
1835 "Keymap for `org-agenda-mode'.")
1836 (if (fboundp 'defvaralias)
1837 (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1839 (defvar org-agenda-menu) ; defined later in this file.
1840 (defvar org-agenda-restrict) ; defined later in this file.
1841 (defvar org-agenda-follow-mode nil)
1842 (defvar org-agenda-entry-text-mode nil)
1843 (defvar org-agenda-clockreport-mode nil)
1844 (defvar org-agenda-show-log nil)
1845 (defvar org-agenda-redo-command nil)
1846 (defvar org-agenda-query-string nil)
1847 (defvar org-agenda-mode-hook nil
1848 "Hook for `org-agenda-mode', run after the mode is turned on.")
1849 (defvar org-agenda-type nil)
1850 (defvar org-agenda-force-single-file nil)
1851 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1854 ;;; Multiple agenda buffers support
1856 (defcustom org-agenda-sticky nil
1857 "Non-nil means agenda q key will bury agenda buffers.
1858 Agenda commands will then show existing buffer instead of generating new ones.
1859 When nil, `q' will kill the single agenda buffer."
1860 :group 'org-agenda
1861 :type 'boolean
1862 :set (lambda (var val)
1863 (if (boundp var)
1864 (org-toggle-sticky-agenda (if val 1 0))
1865 (set var val))))
1867 (defun org-toggle-sticky-agenda (&optional arg)
1868 "Toggle `org-agenda-sticky'."
1869 (interactive "P")
1870 (let ((new-value (if arg
1871 (> (prefix-numeric-value arg) 0)
1872 (not org-agenda-sticky))))
1873 (if (equal new-value org-agenda-sticky)
1874 (and (org-called-interactively-p 'interactive)
1875 (message "Sticky agenda was already %s"
1876 (if org-agenda-sticky "enabled" "disabled")))
1877 (setq org-agenda-sticky new-value)
1878 (org-agenda-kill-all-agenda-buffers)
1879 (and (org-called-interactively-p 'interactive)
1880 (message "Sticky agenda was %s"
1881 (if org-agenda-sticky "enabled" "disabled"))))))
1883 (defvar org-agenda-buffer nil
1884 "Agenda buffer currently being generated.")
1886 (defvar org-agenda-last-prefix-arg nil)
1887 (defvar org-agenda-this-buffer-name nil)
1888 (defvar org-agenda-doing-sticky-redo nil)
1889 (defvar org-agenda-this-buffer-is-sticky nil)
1891 (defconst org-agenda-local-vars
1892 '(org-agenda-this-buffer-name
1893 org-agenda-undo-list
1894 org-agenda-pending-undo-list
1895 org-agenda-follow-mode
1896 org-agenda-entry-text-mode
1897 org-agenda-clockreport-mode
1898 org-agenda-show-log
1899 org-agenda-redo-command
1900 org-agenda-query-string
1901 org-agenda-type
1902 org-agenda-bulk-marked-entries
1903 org-agenda-undo-has-started-in
1904 org-agenda-last-arguments
1905 org-agenda-info
1906 org-agenda-tag-filter-overlays
1907 org-agenda-cat-filter-overlays
1908 org-pre-agenda-window-conf
1909 org-agenda-columns-active
1910 org-agenda-tag-filter
1911 org-agenda-category-filter
1912 org-agenda-markers
1913 org-agenda-last-search-view-search-was-boolean
1914 org-agenda-filtered-by-category
1915 org-agenda-filter-form
1916 org-agenda-show-window
1917 org-agenda-cycle-counter
1918 org-agenda-last-prefix-arg)
1919 "Variables that must be local in agenda buffers to allow multiple buffers.")
1921 (defun org-agenda-mode ()
1922 "Mode for time-sorted view on action items in Org-mode files.
1924 The following commands are available:
1926 \\{org-agenda-mode-map}"
1927 (interactive)
1928 (cond (org-agenda-doing-sticky-redo
1929 ;; Refreshing sticky agenda-buffer
1931 ;; Preserve the value of `org-agenda-local-vars' variables,
1932 ;; while letting `kill-all-local-variables' kill the rest
1933 (let ((save (buffer-local-variables)))
1934 (kill-all-local-variables)
1935 (mapc 'make-local-variable org-agenda-local-vars)
1936 (dolist (elem save)
1937 (let ((var (car elem))
1938 (val (cdr elem)))
1939 (when (and val
1940 (member var org-agenda-local-vars))
1941 (set var val)))))
1942 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1943 (org-agenda-sticky
1944 ;; Creating a sticky Agenda buffer for the first time
1945 (kill-all-local-variables)
1946 (mapc 'make-local-variable org-agenda-local-vars)
1947 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1949 ;; Creating a non-sticky agenda buffer
1950 (kill-all-local-variables)
1951 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
1952 (setq org-agenda-undo-list nil
1953 org-agenda-pending-undo-list nil
1954 org-agenda-bulk-marked-entries nil)
1955 (setq major-mode 'org-agenda-mode)
1956 ;; Keep global-font-lock-mode from turning on font-lock-mode
1957 (org-set-local 'font-lock-global-modes (list 'not major-mode))
1958 (setq mode-name "Org-Agenda")
1959 (use-local-map org-agenda-mode-map)
1960 (easy-menu-add org-agenda-menu)
1961 (if org-startup-truncated (setq truncate-lines t))
1962 (org-set-local 'line-move-visual nil)
1963 (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1964 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1965 ;; Make sure properties are removed when copying text
1966 (make-local-variable 'filter-buffer-substring-functions)
1967 (add-hook 'filter-buffer-substring-functions
1968 (lambda (fun start end delete)
1969 (substring-no-properties (funcall fun start end delete))))
1970 (unless org-agenda-keep-modes
1971 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1972 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1973 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1974 org-agenda-show-log org-agenda-start-with-log-mode))
1976 (easy-menu-change
1977 '("Agenda") "Agenda Files"
1978 (append
1979 (list
1980 (vector
1981 (if (get 'org-agenda-files 'org-restrict)
1982 "Restricted to single file"
1983 "Edit File List")
1984 '(org-edit-agenda-file-list)
1985 (not (get 'org-agenda-files 'org-restrict)))
1986 "--")
1987 (mapcar 'org-file-menu-entry (org-agenda-files))))
1988 (org-agenda-set-mode-name)
1989 (apply
1990 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1991 (list 'org-agenda-mode-hook)))
1993 (substitute-key-definition 'undo 'org-agenda-undo
1994 org-agenda-mode-map global-map)
1995 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
1996 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
1997 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
1998 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
1999 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2000 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2001 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2002 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2003 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2004 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2005 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2006 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2007 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2008 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2009 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2010 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2011 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2012 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2013 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2014 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2015 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2016 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2017 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2018 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2019 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2020 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2021 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2022 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2023 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2024 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2025 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2026 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2027 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2028 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2029 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2030 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2031 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2032 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2033 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2034 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2035 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
2036 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
2037 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2038 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2039 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2040 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2042 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2043 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2044 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2045 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2046 (while l (org-defkey org-agenda-mode-map
2047 (int-to-string (pop l)) 'digit-argument)))
2049 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2050 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2051 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2052 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2053 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2054 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2055 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2056 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2057 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2058 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
2059 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2060 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2061 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2062 'org-clock-modify-effort-estimate)
2063 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2064 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2065 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2066 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2067 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2068 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2069 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2070 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2071 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2072 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2073 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2074 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2075 (substitute-key-definition 'next-line 'org-agenda-next-line
2076 org-agenda-mode-map global-map)
2077 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2078 org-agenda-mode-map global-map)
2079 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2080 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2081 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2082 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2083 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-show-priority)
2084 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2085 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2086 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2087 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2088 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2089 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2090 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2091 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2092 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2093 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2094 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2095 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2096 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2097 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2098 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2099 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2100 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2101 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2102 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2103 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2104 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2105 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2106 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2107 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2108 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2110 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2111 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2112 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2113 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2114 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2115 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2116 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2117 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
2118 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2119 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2120 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2121 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2123 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2124 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2125 (when org-agenda-mouse-1-follows-link
2126 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2127 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2128 '("Agenda"
2129 ("Agenda Files")
2130 "--"
2131 ("Agenda Dates"
2132 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2133 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2134 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2135 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2136 "--"
2137 ("View"
2138 ["Day View" org-agenda-day-view
2139 :active (org-agenda-check-type nil 'agenda)
2140 :style radio :selected (eq org-agenda-current-span 'day)
2141 :keys "v d (or just d)"]
2142 ["Week View" org-agenda-week-view
2143 :active (org-agenda-check-type nil 'agenda)
2144 :style radio :selected (eq org-agenda-current-span 'week)
2145 :keys "v w (or just w)"]
2146 ["Month View" org-agenda-month-view
2147 :active (org-agenda-check-type nil 'agenda)
2148 :style radio :selected (eq org-agenda-current-span 'month)
2149 :keys "v m"]
2150 ["Year View" org-agenda-year-view
2151 :active (org-agenda-check-type nil 'agenda)
2152 :style radio :selected (eq org-agenda-current-span 'year)
2153 :keys "v y"]
2154 "--"
2155 ["Include Diary" org-agenda-toggle-diary
2156 :style toggle :selected org-agenda-include-diary
2157 :active (org-agenda-check-type nil 'agenda)]
2158 ["Include Deadlines" org-agenda-toggle-deadlines
2159 :style toggle :selected org-agenda-include-deadlines
2160 :active (org-agenda-check-type nil 'agenda)]
2161 ["Use Time Grid" org-agenda-toggle-time-grid
2162 :style toggle :selected org-agenda-use-time-grid
2163 :active (org-agenda-check-type nil 'agenda)]
2164 "--"
2165 ["Show clock report" org-agenda-clockreport-mode
2166 :style toggle :selected org-agenda-clockreport-mode
2167 :active (org-agenda-check-type nil 'agenda)]
2168 ["Show some entry text" org-agenda-entry-text-mode
2169 :style toggle :selected org-agenda-entry-text-mode
2170 :active t]
2171 "--"
2172 ["Show Logbook entries" org-agenda-log-mode
2173 :style toggle :selected org-agenda-show-log
2174 :active (org-agenda-check-type nil 'agenda 'timeline)
2175 :keys "v l (or just l)"]
2176 ["Include archived trees" org-agenda-archives-mode
2177 :style toggle :selected org-agenda-archives-mode :active t
2178 :keys "v a"]
2179 ["Include archive files" (org-agenda-archives-mode t)
2180 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2181 :keys "v A"]
2182 "--"
2183 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2184 ["Write view to file" org-agenda-write t]
2185 ["Rebuild buffer" org-agenda-redo t]
2186 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2187 "--"
2188 ["Show original entry" org-agenda-show t]
2189 ["Go To (other window)" org-agenda-goto t]
2190 ["Go To (this window)" org-agenda-switch-to t]
2191 ["Follow Mode" org-agenda-follow-mode
2192 :style toggle :selected org-agenda-follow-mode :active t]
2193 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2194 "--"
2195 ("TODO"
2196 ["Cycle TODO" org-agenda-todo t]
2197 ["Next TODO set" org-agenda-todo-nextset t]
2198 ["Previous TODO set" org-agenda-todo-previousset t]
2199 ["Add note" org-agenda-add-note t])
2200 ("Archive/Refile/Delete"
2201 ["Archive default" org-agenda-archive-default t]
2202 ["Archive default" org-agenda-archive-default-with-confirmation t]
2203 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2204 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2205 ["Archive subtree" org-agenda-archive t]
2206 "--"
2207 ["Refile" org-agenda-refile t]
2208 "--"
2209 ["Delete subtree" org-agenda-kill t])
2210 ("Bulk action"
2211 ["Mark entry" org-agenda-bulk-mark t]
2212 ["Mark all" org-agenda-bulk-mark-all t]
2213 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2214 ["Unmark entry" org-agenda-bulk-unmark t]
2215 ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "C-u s"])
2216 ["Act on all marked" org-agenda-bulk-action t]
2217 "--"
2218 ("Tags and Properties"
2219 ["Show all Tags" org-agenda-show-tags t]
2220 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2221 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2222 "--"
2223 ["Column View" org-columns t])
2224 ("Deadline/Schedule"
2225 ["Schedule" org-agenda-schedule t]
2226 ["Set Deadline" org-agenda-deadline t]
2227 "--"
2228 ["Mark item" org-agenda-action :active t :keys "k m"]
2229 ["Show mark item" org-agenda-action :active t :keys "k v"]
2230 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2231 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2232 "--"
2233 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2234 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2235 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2236 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2237 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2238 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2239 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2240 ("Clock and Effort"
2241 ["Clock in" org-agenda-clock-in t]
2242 ["Clock out" org-agenda-clock-out t]
2243 ["Clock cancel" org-agenda-clock-cancel t]
2244 ["Goto running clock" org-clock-goto t]
2245 "--"
2246 ["Set Effort" org-agenda-set-effort t]
2247 ["Change clocked effort" org-clock-modify-effort-estimate
2248 (org-clock-is-active)])
2249 ("Priority"
2250 ["Set Priority" org-agenda-priority t]
2251 ["Increase Priority" org-agenda-priority-up t]
2252 ["Decrease Priority" org-agenda-priority-down t]
2253 ["Show Priority" org-agenda-show-priority t])
2254 ("Calendar/Diary"
2255 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2256 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2257 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2258 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2259 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2260 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2261 "--"
2262 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2263 "--"
2264 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2265 "--"
2266 ("MobileOrg"
2267 ["Push Files and Views" org-mobile-push t]
2268 ["Get Captured and Flagged" org-mobile-pull t]
2269 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2270 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2271 "--"
2272 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2273 "--"
2274 ["Quit" org-agenda-quit t]
2275 ["Exit and Release Buffers" org-agenda-exit t]
2278 ;;; Agenda undo
2280 (defvar org-agenda-allow-remote-undo t
2281 "Non-nil means allow remote undo from the agenda buffer.")
2282 (defvar org-agenda-undo-list nil
2283 "List of undoable operations in the agenda since last refresh.")
2284 (defvar org-agenda-undo-has-started-in nil
2285 "Buffers that have already seen `undo-start' in the current undo sequence.")
2286 (defvar org-agenda-pending-undo-list nil
2287 "In a series of undo commands, this is the list of remaining undo items.")
2289 (defun org-agenda-undo ()
2290 "Undo a remote editing step in the agenda.
2291 This undoes changes both in the agenda buffer and in the remote buffer
2292 that have been changed along."
2293 (interactive)
2294 (or org-agenda-allow-remote-undo
2295 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2296 (if (not (eq this-command last-command))
2297 (setq org-agenda-undo-has-started-in nil
2298 org-agenda-pending-undo-list org-agenda-undo-list))
2299 (if (not org-agenda-pending-undo-list)
2300 (error "No further undo information"))
2301 (let* ((entry (pop org-agenda-pending-undo-list))
2302 buf line cmd rembuf)
2303 (setq cmd (pop entry) line (pop entry))
2304 (setq rembuf (nth 2 entry))
2305 (org-with-remote-undo rembuf
2306 (while (bufferp (setq buf (pop entry)))
2307 (if (pop entry)
2308 (with-current-buffer buf
2309 (let ((last-undo-buffer buf)
2310 (inhibit-read-only t))
2311 (unless (memq buf org-agenda-undo-has-started-in)
2312 (push buf org-agenda-undo-has-started-in)
2313 (make-local-variable 'pending-undo-list)
2314 (undo-start))
2315 (while (and pending-undo-list
2316 (listp pending-undo-list)
2317 (not (car pending-undo-list)))
2318 (pop pending-undo-list))
2319 (undo-more 1))))))
2320 (org-goto-line line)
2321 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2323 (defun org-verify-change-for-undo (l1 l2)
2324 "Verify that a real change occurred between the undo lists L1 and L2."
2325 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2326 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2327 (not (eq l1 l2)))
2329 ;;; Agenda dispatch
2331 (defvar org-agenda-restrict nil)
2332 (defvar org-agenda-restrict-begin (make-marker))
2333 (defvar org-agenda-restrict-end (make-marker))
2334 (defvar org-agenda-last-dispatch-buffer nil)
2335 (defvar org-agenda-overriding-restriction nil)
2337 (defcustom org-agenda-custom-commands-contexts nil
2338 "Alist of custom agenda commands and valid contexts.
2340 For example, if you have a custom agenda command \"p\" and you
2341 want this command to be accessible only from plain text files,
2342 use this:
2344 '((\"p\" (in-file . \"\\.txt\")))
2346 Here are the available checks:
2348 in-file: command displayed only in matching files
2349 in-mode: command displayed only in matching modes
2350 not-in-file: command not displayed in matching files
2351 not-in-mode: command not displayed in matching modes
2353 If you define several checks, the agenda command will be
2354 accessible if there is at least one valid check."
2355 ;; :version "24.3"
2356 :group 'org-agenda-custom-commands
2357 :type '(repeat (cons :tag "Rule"
2358 (string :tag "Agenda key")
2359 (repeat :tag "Available when"
2360 (cons :tag "Condition"
2361 (choice
2362 (const :tag "In file" in-file)
2363 (const :tag "Not in file" not-in-file)
2364 (const :tag "In mode" in-mode)
2365 (const :tag "Not in mode" not-in-mode))
2366 (regexp))))))
2368 ;;;###autoload
2369 (defun org-agenda (&optional arg keys restriction)
2370 "Dispatch agenda commands to collect entries to the agenda buffer.
2371 Prompts for a command to execute. Any prefix arg will be passed
2372 on to the selected command. The default selections are:
2374 a Call `org-agenda-list' to display the agenda for current day or week.
2375 t Call `org-todo-list' to display the global todo list.
2376 T Call `org-todo-list' to display the global todo list, select only
2377 entries with a specific TODO keyword (the user gets a prompt).
2378 m Call `org-tags-view' to display headlines with tags matching
2379 a condition (the user is prompted for the condition).
2380 M Like `m', but select only TODO entries, no ordinary headlines.
2381 L Create a timeline for the current buffer.
2382 e Export views to associated files.
2383 s Search entries for keywords.
2384 / Multi occur across all agenda files and also files listed
2385 in `org-agenda-text-search-extra-files'.
2386 < Restrict agenda commands to buffer, subtree, or region.
2387 Press several times to get the desired effect.
2388 > Remove a previous restriction.
2389 # List \"stuck\" projects.
2390 ! Configure what \"stuck\" means.
2391 C Configure custom agenda commands.
2393 More commands can be added by configuring the variable
2394 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2395 searches can be pre-defined in this way.
2397 If the current buffer is in Org-mode and visiting a file, you can also
2398 first press `<' once to indicate that the agenda should be temporarily
2399 \(until the next use of \\[org-agenda]) restricted to the current file.
2400 Pressing `<' twice means to restrict to the current subtree or region
2401 \(if active)."
2402 (interactive "P")
2403 (catch 'exit
2404 (let* ((prefix-descriptions nil)
2405 (org-agenda-buffer-name org-agenda-buffer-name)
2406 (org-agenda-window-setup (if (equal (buffer-name)
2407 org-agenda-buffer-name)
2408 'current-window
2409 org-agenda-window-setup))
2410 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2411 (org-agenda-custom-commands
2412 ;; normalize different versions
2413 (delq nil
2414 (mapcar
2415 (lambda (x)
2416 (cond ((stringp (cdr x))
2417 (push x prefix-descriptions)
2418 nil)
2419 ((stringp (nth 1 x)) x)
2420 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2421 (t (cons (car x) (cons "" (cdr x))))))
2422 org-agenda-custom-commands)))
2423 (org-agenda-custom-commands
2424 (org-contextualize-agenda-or-capture
2425 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2426 (buf (current-buffer))
2427 (bfn (buffer-file-name (buffer-base-buffer)))
2428 entry key type match lprops ans)
2429 ;; Turn off restriction unless there is an overriding one,
2430 (unless org-agenda-overriding-restriction
2431 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2432 ;; There is a request to keep the file list in place
2433 (put 'org-agenda-files 'org-restrict nil))
2434 (setq org-agenda-restrict nil)
2435 (move-marker org-agenda-restrict-begin nil)
2436 (move-marker org-agenda-restrict-end nil))
2437 ;; Delete old local properties
2438 (put 'org-agenda-redo-command 'org-lprops nil)
2439 ;; Delete previously set last-arguments
2440 (put 'org-agenda-redo-command 'last-args nil)
2441 ;; Remember where this call originated
2442 (setq org-agenda-last-dispatch-buffer (current-buffer))
2443 (unless keys
2444 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2445 keys (car ans)
2446 restriction (cdr ans)))
2447 ;; If we have sticky agenda buffers, set a name for the buffer,
2448 ;; depending on the invoking keys. The user may still set this
2449 ;; as a command option, which will overwrite what we do here.
2450 (if org-agenda-sticky
2451 (setq org-agenda-buffer-name (format "*Org Agenda(%s)*" keys)))
2452 ;; Establish the restriction, if any
2453 (when (and (not org-agenda-overriding-restriction) restriction)
2454 (put 'org-agenda-files 'org-restrict (list bfn))
2455 (cond
2456 ((eq restriction 'region)
2457 (setq org-agenda-restrict t)
2458 (move-marker org-agenda-restrict-begin (region-beginning))
2459 (move-marker org-agenda-restrict-end (region-end)))
2460 ((eq restriction 'subtree)
2461 (save-excursion
2462 (setq org-agenda-restrict t)
2463 (org-back-to-heading t)
2464 (move-marker org-agenda-restrict-begin (point))
2465 (move-marker org-agenda-restrict-end
2466 (progn (org-end-of-subtree t)))))))
2468 ;; For example the todo list should not need it (but does...)
2469 (cond
2470 ((setq entry (assoc keys org-agenda-custom-commands))
2471 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2472 (progn
2473 (setq type (nth 2 entry) match (eval (nth 3 entry))
2474 lprops (nth 4 entry))
2475 (put 'org-agenda-redo-command 'org-lprops lprops)
2476 (cond
2477 ((eq type 'agenda)
2478 (org-let lprops '(org-agenda-list current-prefix-arg)))
2479 ((eq type 'alltodo)
2480 (org-let lprops '(org-todo-list current-prefix-arg)))
2481 ((eq type 'search)
2482 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2483 ((eq type 'stuck)
2484 (org-let lprops '(org-agenda-list-stuck-projects
2485 current-prefix-arg)))
2486 ((eq type 'tags)
2487 (org-let lprops '(org-tags-view current-prefix-arg match)))
2488 ((eq type 'tags-todo)
2489 (org-let lprops '(org-tags-view '(4) match)))
2490 ((eq type 'todo)
2491 (org-let lprops '(org-todo-list match)))
2492 ((eq type 'tags-tree)
2493 (org-check-for-org-mode)
2494 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2495 ((eq type 'todo-tree)
2496 (org-check-for-org-mode)
2497 (org-let lprops
2498 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2499 (regexp-quote match) "\\>"))))
2500 ((eq type 'occur-tree)
2501 (org-check-for-org-mode)
2502 (org-let lprops '(org-occur match)))
2503 ((functionp type)
2504 (org-let lprops '(funcall type match)))
2505 ((fboundp type)
2506 (org-let lprops '(funcall type match)))
2507 (t (error "Invalid custom agenda command type %s" type))))
2508 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2509 ((equal keys "C")
2510 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2511 (customize-variable 'org-agenda-custom-commands))
2512 ((equal keys "a") (call-interactively 'org-agenda-list))
2513 ((equal keys "s") (call-interactively 'org-search-view))
2514 ((equal keys "t") (call-interactively 'org-todo-list))
2515 ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2516 ((equal keys "m") (call-interactively 'org-tags-view))
2517 ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2518 ((equal keys "e") (call-interactively 'org-store-agenda-views))
2519 ((equal keys "?") (org-tags-view nil "+FLAGGED")
2520 (org-add-hook
2521 'post-command-hook
2522 (lambda ()
2523 (unless (current-message)
2524 (let* ((m (org-agenda-get-any-marker))
2525 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2526 (when note
2527 (message (concat
2528 "FLAGGING-NOTE ([?] for more info): "
2529 (org-add-props
2530 (replace-regexp-in-string
2531 "\\\\n" "//"
2532 (copy-sequence note))
2533 nil 'face 'org-warning)))))))
2534 t t))
2535 ((equal keys "L")
2536 (unless (derived-mode-p 'org-mode)
2537 (error "This is not an Org-mode file"))
2538 (unless restriction
2539 (put 'org-agenda-files 'org-restrict (list bfn))
2540 (org-call-with-arg 'org-timeline arg)))
2541 ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2542 ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2543 ((equal keys "!") (customize-variable 'org-stuck-projects))
2544 (t (error "Invalid agenda key"))))))
2546 (defun org-agenda-append-agenda ()
2547 "Append another agenda view to the current one.
2548 This function allows interactive building of block agendas.
2549 Agenda views are separated by `org-agenda-block-separator'."
2550 (interactive)
2551 (unless (string= (buffer-name) org-agenda-buffer-name)
2552 (error "Can only append from within agenda buffer"))
2553 (let ((org-agenda-multi t))
2554 (org-agenda)
2555 (widen)))
2557 (defun org-agenda-normalize-custom-commands (cmds)
2558 (delq nil
2559 (mapcar
2560 (lambda (x)
2561 (cond ((stringp (cdr x)) nil)
2562 ((stringp (nth 1 x)) x)
2563 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2564 (t (cons (car x) (cons "" (cdr x))))))
2565 cmds)))
2567 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2568 "The user interface for selecting an agenda command."
2569 (catch 'exit
2570 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2571 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2572 (region-p (org-region-active-p))
2573 (custom org-agenda-custom-commands)
2574 (selstring "")
2575 restriction second-time
2576 c entry key type match prefixes rmheader header-end custom1 desc
2577 line lines left right n n1)
2578 (save-window-excursion
2579 (delete-other-windows)
2580 (org-switch-to-buffer-other-window " *Agenda Commands*")
2581 (erase-buffer)
2582 (insert (eval-when-compile
2583 (let ((header
2584 "Press key for an agenda command: < Buffer, subtree/region restriction
2585 -------------------------------- > Remove restriction
2586 a Agenda for current week or day e Export agenda views
2587 t List of all TODO entries T Entries with special TODO kwd
2588 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2589 L Timeline for current buffer # List stuck projects (!=configure)
2590 s Search for keywords * Toggle sticky agenda views
2591 / Multi-occur ? Find :FLAGGED: entries
2592 C Configure custom agenda commands
2594 (start 0))
2595 (while (string-match
2596 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2597 header start)
2598 (setq start (match-end 0))
2599 (add-text-properties (match-beginning 2) (match-end 2)
2600 '(face bold) header))
2601 header)))
2602 (setq header-end (move-marker (make-marker) (point)))
2603 (while t
2604 (setq custom1 custom)
2605 (when (eq rmheader t)
2606 (org-goto-line 1)
2607 (re-search-forward ":" nil t)
2608 (delete-region (match-end 0) (point-at-eol))
2609 (forward-char 1)
2610 (looking-at "-+")
2611 (delete-region (match-end 0) (point-at-eol))
2612 (move-marker header-end (match-end 0)))
2613 (goto-char header-end)
2614 (delete-region (point) (point-max))
2616 ;; Produce all the lines that describe custom commands and prefixes
2617 (setq lines nil)
2618 (while (setq entry (pop custom1))
2619 (setq key (car entry) desc (nth 1 entry)
2620 type (nth 2 entry)
2621 match (nth 3 entry))
2622 (if (> (length key) 1)
2623 (add-to-list 'prefixes (string-to-char key))
2624 (setq line
2625 (format
2626 "%-4s%-14s"
2627 (org-add-props (copy-sequence key)
2628 '(face bold))
2629 (cond
2630 ((string-match "\\S-" desc) desc)
2631 ((eq type 'agenda) "Agenda for current week or day")
2632 ((eq type 'alltodo) "List of all TODO entries")
2633 ((eq type 'search) "Word search")
2634 ((eq type 'stuck) "List of stuck projects")
2635 ((eq type 'todo) "TODO keyword")
2636 ((eq type 'tags) "Tags query")
2637 ((eq type 'tags-todo) "Tags (TODO)")
2638 ((eq type 'tags-tree) "Tags tree")
2639 ((eq type 'todo-tree) "TODO kwd tree")
2640 ((eq type 'occur-tree) "Occur tree")
2641 ((functionp type) (if (symbolp type)
2642 (symbol-name type)
2643 "Lambda expression"))
2644 (t "???"))))
2645 (if org-agenda-menu-show-matcher
2646 (setq line
2647 (concat line ": "
2648 (cond
2649 ((stringp match)
2650 (setq match (copy-sequence match))
2651 (org-add-props match nil 'face 'org-warning))
2652 (match
2653 (format "set of %d commands" (length match)))
2654 (t ""))))
2655 (if (org-string-nw-p match)
2656 (add-text-properties
2657 0 (length line) (list 'help-echo
2658 (concat "Matcher: "match)) line)))
2659 (push line lines)))
2660 (setq lines (nreverse lines))
2661 (when prefixes
2662 (mapc (lambda (x)
2663 (push
2664 (format "%s %s"
2665 (org-add-props (char-to-string x)
2666 nil 'face 'bold)
2667 (or (cdr (assoc (concat selstring
2668 (char-to-string x))
2669 prefix-descriptions))
2670 "Prefix key"))
2671 lines))
2672 prefixes))
2674 ;; Check if we should display in two columns
2675 (if org-agenda-menu-two-columns
2676 (progn
2677 (setq n (length lines)
2678 n1 (+ (/ n 2) (mod n 2))
2679 right (nthcdr n1 lines)
2680 left (copy-sequence lines))
2681 (setcdr (nthcdr (1- n1) left) nil))
2682 (setq left lines right nil))
2683 (while left
2684 (insert "\n" (pop left))
2685 (when right
2686 (if (< (current-column) 40)
2687 (move-to-column 40 t)
2688 (insert " "))
2689 (insert (pop right))))
2691 ;; Make the window the right size
2692 (goto-char (point-min))
2693 (if second-time
2694 (if (not (pos-visible-in-window-p (point-max)))
2695 (org-fit-window-to-buffer))
2696 (setq second-time t)
2697 (org-fit-window-to-buffer))
2699 ;; Ask for selection
2700 (message "Press key for agenda command%s:"
2701 (if (or restrict-ok org-agenda-overriding-restriction)
2702 (if org-agenda-overriding-restriction
2703 " (restriction lock active)"
2704 (if restriction
2705 (format " (restricted to %s)" restriction)
2706 " (unrestricted)"))
2707 ""))
2708 (setq c (read-char-exclusive))
2709 (message "")
2710 (cond
2711 ((assoc (char-to-string c) custom)
2712 (setq selstring (concat selstring (char-to-string c)))
2713 (throw 'exit (cons selstring restriction)))
2714 ((memq c prefixes)
2715 (setq selstring (concat selstring (char-to-string c))
2716 prefixes nil
2717 rmheader (or rmheader t)
2718 custom (delq nil (mapcar
2719 (lambda (x)
2720 (if (or (= (length (car x)) 1)
2721 (/= (string-to-char (car x)) c))
2723 (cons (substring (car x) 1) (cdr x))))
2724 custom))))
2725 ((eq c ?*)
2726 (call-interactively 'org-toggle-sticky-agenda)
2727 (sit-for 2))
2728 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2729 (message "Restriction is only possible in Org-mode buffers")
2730 (ding) (sit-for 1))
2731 ((eq c ?1)
2732 (org-agenda-remove-restriction-lock 'noupdate)
2733 (setq restriction 'buffer))
2734 ((eq c ?0)
2735 (org-agenda-remove-restriction-lock 'noupdate)
2736 (setq restriction (if region-p 'region 'subtree)))
2737 ((eq c ?<)
2738 (org-agenda-remove-restriction-lock 'noupdate)
2739 (setq restriction
2740 (cond
2741 ((eq restriction 'buffer)
2742 (if region-p 'region 'subtree))
2743 ((memq restriction '(subtree region))
2744 nil)
2745 (t 'buffer))))
2746 ((eq c ?>)
2747 (org-agenda-remove-restriction-lock 'noupdate)
2748 (setq restriction nil))
2749 ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2750 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2751 ((and (> (length selstring) 0) (eq c ?\d))
2752 (delete-window)
2753 (org-agenda-get-restriction-and-command prefix-descriptions))
2755 ((equal c ?q) (error "Abort"))
2756 (t (error "Invalid key %c" c))))))))
2758 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2759 (defvar org-agenda-last-arguments nil
2760 "The arguments of the previous call to `org-agenda'.")
2761 (defun org-agenda-run-series (name series)
2762 (org-let (nth 1 series) '(org-prepare-agenda name))
2763 ;; We need to reset agenda markers here, because when constructing a
2764 ;; block agenda, the individual blocks do not do that.
2765 (org-agenda-reset-markers)
2766 (let* ((org-agenda-multi t)
2767 (redo (list 'org-agenda-run-series name (list 'quote series)))
2768 (org-agenda-overriding-arguments
2769 (or org-agenda-overriding-arguments
2770 (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2771 (get 'org-agenda-redo-command 'last-args))))
2772 (cmds (car series))
2773 (gprops (nth 1 series))
2774 match ;; The byte compiler incorrectly complains about this. Keep it!
2775 cmd type lprops)
2776 (while (setq cmd (pop cmds))
2777 (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2778 (cond
2779 ((eq type 'agenda)
2780 (org-let2 gprops lprops
2781 '(call-interactively 'org-agenda-list)))
2782 ((eq type 'alltodo)
2783 (org-let2 gprops lprops
2784 '(call-interactively 'org-todo-list)))
2785 ((eq type 'search)
2786 (org-let2 gprops lprops
2787 '(org-search-view current-prefix-arg match nil)))
2788 ((eq type 'stuck)
2789 (org-let2 gprops lprops
2790 '(call-interactively 'org-agenda-list-stuck-projects)))
2791 ((eq type 'tags)
2792 (org-let2 gprops lprops
2793 '(org-tags-view current-prefix-arg match)))
2794 ((eq type 'tags-todo)
2795 (org-let2 gprops lprops
2796 '(org-tags-view '(4) match)))
2797 ((eq type 'todo)
2798 (org-let2 gprops lprops
2799 '(org-todo-list match)))
2800 ((fboundp type)
2801 (org-let2 gprops lprops
2802 '(funcall type match)))
2803 (t (error "Invalid type in command series"))))
2804 (widen)
2805 (setq org-agenda-redo-command redo)
2806 (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2807 (goto-char (point-min)))
2808 (org-fit-agenda-window)
2809 (org-let (nth 1 series) '(org-finalize-agenda)))
2811 ;;;###autoload
2812 (defmacro org-batch-agenda (cmd-key &rest parameters)
2813 "Run an agenda command in batch mode and send the result to STDOUT.
2814 If CMD-KEY is a string of length 1, it is used as a key in
2815 `org-agenda-custom-commands' and triggers this command. If it is a
2816 longer string it is used as a tags/todo match string.
2817 Parameters are alternating variable names and values that will be bound
2818 before running the agenda command."
2819 (org-eval-in-environment (org-make-parameter-alist parameters)
2820 (if (> (length cmd-key) 2)
2821 (org-tags-view nil cmd-key)
2822 (org-agenda nil cmd-key)))
2823 (set-buffer org-agenda-buffer-name)
2824 (princ (buffer-string)))
2825 (def-edebug-spec org-batch-agenda (form &rest sexp))
2827 (defvar org-agenda-info nil)
2829 ;;;###autoload
2830 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2831 "Run an agenda command in batch mode and send the result to STDOUT.
2832 If CMD-KEY is a string of length 1, it is used as a key in
2833 `org-agenda-custom-commands' and triggers this command. If it is a
2834 longer string it is used as a tags/todo match string.
2835 Parameters are alternating variable names and values that will be bound
2836 before running the agenda command.
2838 The output gives a line for each selected agenda item. Each
2839 item is a list of comma-separated values, like this:
2841 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2843 category The category of the item
2844 head The headline, without TODO kwd, TAGS and PRIORITY
2845 type The type of the agenda entry, can be
2846 todo selected in TODO match
2847 tagsmatch selected in tags match
2848 diary imported from diary
2849 deadline a deadline on given date
2850 scheduled scheduled on given date
2851 timestamp entry has timestamp on given date
2852 closed entry was closed on given date
2853 upcoming-deadline warning about deadline
2854 past-scheduled forwarded scheduled item
2855 block entry has date block including g. date
2856 todo The todo keyword, if any
2857 tags All tags including inherited ones, separated by colons
2858 date The relevant date, like 2007-2-14
2859 time The time, like 15:00-16:50
2860 extra Sting with extra planning info
2861 priority-l The priority letter if any was given
2862 priority-n The computed numerical priority
2863 agenda-day The day in the agenda where this is listed"
2864 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2865 (org-make-parameter-alist parameters))
2866 (if (> (length cmd-key) 2)
2867 (org-tags-view nil cmd-key)
2868 (org-agenda nil cmd-key)))
2869 (set-buffer org-agenda-buffer-name)
2870 (let* ((lines (org-split-string (buffer-string) "\n"))
2871 line)
2872 (while (setq line (pop lines))
2873 (catch 'next
2874 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2875 (setq org-agenda-info
2876 (org-fix-agenda-info (text-properties-at 0 line)))
2877 (princ
2878 (mapconcat 'org-agenda-export-csv-mapper
2879 '(org-category txt type todo tags date time extra
2880 priority-letter priority agenda-day)
2881 ","))
2882 (princ "\n")))))
2883 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2885 (defun org-fix-agenda-info (props)
2886 "Make sure all properties on an agenda item have a canonical form.
2887 This ensures the export commands can easily use it."
2888 (let (tmp re)
2889 (when (setq tmp (plist-get props 'tags))
2890 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2891 (when (setq tmp (plist-get props 'date))
2892 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2893 (let ((calendar-date-display-form '(year "-" month "-" day)))
2894 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2896 (setq tmp (calendar-date-string tmp)))
2897 (setq props (plist-put props 'date tmp)))
2898 (when (setq tmp (plist-get props 'day))
2899 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2900 (let ((calendar-date-display-form '(year "-" month "-" day)))
2901 (setq tmp (calendar-date-string tmp)))
2902 (setq props (plist-put props 'day tmp))
2903 (setq props (plist-put props 'agenda-day tmp)))
2904 (when (setq tmp (plist-get props 'txt))
2905 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2906 (plist-put props 'priority-letter (match-string 1 tmp))
2907 (setq tmp (replace-match "" t t tmp)))
2908 (when (and (setq re (plist-get props 'org-todo-regexp))
2909 (setq re (concat "\\`\\.*" re " ?"))
2910 (string-match re tmp))
2911 (plist-put props 'todo (match-string 1 tmp))
2912 (setq tmp (replace-match "" t t tmp)))
2913 (plist-put props 'txt tmp)))
2914 props)
2916 (defun org-agenda-export-csv-mapper (prop)
2917 (let ((res (plist-get org-agenda-info prop)))
2918 (setq res
2919 (cond
2920 ((not res) "")
2921 ((stringp res) res)
2922 (t (prin1-to-string res))))
2923 (while (string-match "," res)
2924 (setq res (replace-match ";" t t res)))
2925 (org-trim res)))
2927 ;;;###autoload
2928 (defun org-store-agenda-views (&rest parameters)
2929 (interactive)
2930 (eval (list 'org-batch-store-agenda-views)))
2932 ;;;###autoload
2933 (defmacro org-batch-store-agenda-views (&rest parameters)
2934 "Run all custom agenda commands that have a file argument."
2935 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2936 (pop-up-frames nil)
2937 (dir default-directory)
2938 (pars (org-make-parameter-alist parameters))
2939 cmd thiscmdkey files opts cmd-or-set bufname)
2940 (save-window-excursion
2941 (while cmds
2942 (setq cmd (pop cmds)
2943 thiscmdkey (car cmd)
2944 bufname (if org-agenda-sticky (format "*Org Agenda(%s)*" thiscmdkey)
2945 org-agenda-buffer-name)
2946 cmd-or-set (nth 2 cmd)
2947 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2948 files (nth (if (listp cmd-or-set) 4 5) cmd))
2949 (if (stringp files) (setq files (list files)))
2950 (when files
2951 (org-eval-in-environment (append org-agenda-exporter-settings
2952 opts pars)
2953 (org-agenda nil thiscmdkey))
2954 (set-buffer bufname)
2955 (while files
2956 (org-eval-in-environment (append org-agenda-exporter-settings
2957 opts pars)
2958 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
2959 (and (get-buffer bufname)
2960 (kill-buffer bufname)))))))
2961 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2963 (defun org-agenda-mark-header-line (pos)
2964 "Mark the line at POS as an agenda structure header."
2965 (save-excursion
2966 (goto-char pos)
2967 (put-text-property (point-at-bol) (point-at-eol)
2968 'org-agenda-structural-header t)
2969 (when org-agenda-title-append
2970 (put-text-property (point-at-bol) (point-at-eol)
2971 'org-agenda-title-append org-agenda-title-append))))
2973 (defvar org-mobile-creating-agendas)
2974 (defvar org-agenda-write-buffer-name "Agenda View")
2975 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
2976 "Write the current buffer (an agenda view) as a file.
2977 Depending on the extension of the file name, plain text (.txt),
2978 HTML (.html or .htm) or Postscript (.ps) is produced.
2979 If the extension is .ics, run icalendar export over all files used
2980 to construct the agenda and limit the export to entries listed in the
2981 agenda now.
2982 With prefix argument OPEN, open the new file immediately.
2983 If NOSETTINGS is given, do not scope the settings of
2984 `org-agenda-exporter-settings' into the export commands. This is used when
2985 the settings have already been scoped and we do not wish to overrule other,
2986 higher priority settings.
2987 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
2988 (interactive "FWrite agenda to file: \nP")
2989 (if (not (file-writable-p file))
2990 (error "Cannot write agenda to file %s" file))
2991 (org-let (if nosettings nil org-agenda-exporter-settings)
2992 '(save-excursion
2993 (save-window-excursion
2994 (org-agenda-mark-filtered-text)
2995 (let ((bs (copy-sequence (buffer-string))) beg)
2996 (org-agenda-unmark-filtered-text)
2997 (with-temp-buffer
2998 (rename-buffer org-agenda-write-buffer-name t)
2999 (set-buffer-modified-p nil)
3000 (insert bs)
3001 (org-agenda-remove-marked-text 'org-filtered)
3002 (while (setq beg (text-property-any (point-min) (point-max)
3003 'org-filtered t))
3004 (delete-region
3005 beg (or (next-single-property-change beg 'org-filtered)
3006 (point-max))))
3007 (run-hooks 'org-agenda-before-write-hook)
3008 (cond
3009 ((org-bound-and-true-p org-mobile-creating-agendas)
3010 (org-mobile-write-agenda-for-mobile file))
3011 ((string-match "\\.html?\\'" file)
3012 (require 'htmlize)
3013 (set-buffer (htmlize-buffer (current-buffer)))
3014 (when (and org-agenda-export-html-style
3015 (string-match "<style>" org-agenda-export-html-style))
3016 ;; replace <style> section with org-agenda-export-html-style
3017 (goto-char (point-min))
3018 (kill-region (- (search-forward "<style") 6)
3019 (search-forward "</style>"))
3020 (insert org-agenda-export-html-style))
3021 (write-file file)
3022 (kill-buffer (current-buffer))
3023 (message "HTML written to %s" file))
3024 ((string-match "\\.ps\\'" file)
3025 (require 'ps-print)
3026 (ps-print-buffer-with-faces file)
3027 (message "Postscript written to %s" file))
3028 ((string-match "\\.pdf\\'" file)
3029 (require 'ps-print)
3030 (ps-print-buffer-with-faces
3031 (concat (file-name-sans-extension file) ".ps"))
3032 (call-process "ps2pdf" nil nil nil
3033 (expand-file-name
3034 (concat (file-name-sans-extension file) ".ps"))
3035 (expand-file-name file))
3036 (delete-file (concat (file-name-sans-extension file) ".ps"))
3037 (message "PDF written to %s" file))
3038 ((string-match "\\.ics\\'" file)
3039 (require 'org-icalendar)
3040 (let ((org-agenda-marker-table
3041 (org-create-marker-find-array
3042 (org-agenda-collect-markers)))
3043 (org-icalendar-verify-function 'org-check-agenda-marker-table)
3044 (org-combined-agenda-icalendar-file file))
3045 (apply 'org-export-icalendar 'combine
3046 (org-agenda-files nil 'ifmode))))
3048 (let ((bs (buffer-string)))
3049 (find-file file)
3050 (erase-buffer)
3051 (insert bs)
3052 (save-buffer 0)
3053 (kill-buffer (current-buffer))
3054 (message "Plain text written to %s" file))))))))
3055 (set-buffer (or agenda-bufname
3056 (and (called-interactively-p 'any) (buffer-name))
3057 org-agenda-buffer-name)))
3058 (when open (org-open-file file)))
3060 (defvar org-agenda-tag-filter-overlays nil)
3061 (defvar org-agenda-cat-filter-overlays nil)
3063 (defun org-agenda-mark-filtered-text ()
3064 "Mark all text hidden by filtering with a text property."
3065 (let ((inhibit-read-only t))
3066 (mapc
3067 (lambda (o)
3068 (when (equal (overlay-buffer o) (current-buffer))
3069 (put-text-property
3070 (overlay-start o) (overlay-end o)
3071 'org-filtered t)))
3072 (append org-agenda-tag-filter-overlays
3073 org-agenda-cat-filter-overlays))))
3075 (defun org-agenda-unmark-filtered-text ()
3076 "Remove the filtering text property."
3077 (let ((inhibit-read-only t))
3078 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3080 (defun org-agenda-remove-marked-text (property &optional value)
3081 "Delete all text marked with VALUE of PROPERTY.
3082 VALUE defaults to t."
3083 (let (beg)
3084 (setq value (or value t))
3085 (while (setq beg (text-property-any (point-min) (point-max)
3086 property value))
3087 (delete-region
3088 beg (or (next-single-property-change beg 'org-filtered)
3089 (point-max))))))
3091 (defun org-agenda-add-entry-text ()
3092 "Add entry text to agenda lines.
3093 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3094 entry text following headings shown in the agenda.
3095 Drawers will be excluded, also the line with scheduling/deadline info."
3096 (when (and (> org-agenda-add-entry-text-maxlines 0)
3097 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3098 (let (m txt)
3099 (goto-char (point-min))
3100 (while (not (eobp))
3101 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3102 (beginning-of-line 2)
3103 (setq txt (org-agenda-get-some-entry-text
3104 m org-agenda-add-entry-text-maxlines " > "))
3105 (end-of-line 1)
3106 (if (string-match "\\S-" txt)
3107 (insert "\n" txt)
3108 (or (eobp) (forward-char 1))))))))
3110 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3111 &rest keep)
3112 "Extract entry text from MARKER, at most N-LINES lines.
3113 This will ignore drawers etc, just get the text.
3114 If INDENT is given, prefix every line with this string. If KEEP is
3115 given, it is a list of symbols, defining stuff that should not be
3116 removed from the entry content. Currently only `planning' is allowed here."
3117 (let (txt drawer-re kwd-time-re ind)
3118 (save-excursion
3119 (with-current-buffer (marker-buffer marker)
3120 (if (not (derived-mode-p 'org-mode))
3121 (setq txt "")
3122 (save-excursion
3123 (save-restriction
3124 (widen)
3125 (goto-char marker)
3126 (end-of-line 1)
3127 (setq txt (buffer-substring
3128 (min (1+ (point)) (point-max))
3129 (progn (outline-next-heading) (point)))
3130 drawer-re org-drawer-regexp
3131 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3132 ".*\n?"))
3133 (with-temp-buffer
3134 (insert txt)
3135 (when org-agenda-add-entry-text-descriptive-links
3136 (goto-char (point-min))
3137 (while (org-activate-bracket-links (point-max))
3138 (add-text-properties (match-beginning 0) (match-end 0)
3139 '(face org-link))))
3140 (goto-char (point-min))
3141 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3142 (set-text-properties (match-beginning 0) (match-end 0)
3143 nil))
3144 (goto-char (point-min))
3145 (while (re-search-forward drawer-re nil t)
3146 (delete-region
3147 (match-beginning 0)
3148 (progn (re-search-forward
3149 "^[ \t]*:END:.*\n?" nil 'move)
3150 (point))))
3151 (unless (member 'planning keep)
3152 (goto-char (point-min))
3153 (while (re-search-forward kwd-time-re nil t)
3154 (replace-match "")))
3155 (goto-char (point-min))
3156 (when org-agenda-entry-text-exclude-regexps
3157 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3158 (while (setq re (pop re-list))
3159 (goto-char (point-min))
3160 (while (re-search-forward re nil t)
3161 (replace-match "")))))
3162 (goto-char (point-max))
3163 (skip-chars-backward " \t\n")
3164 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3166 ;; find and remove min common indentation
3167 (goto-char (point-min))
3168 (untabify (point-min) (point-max))
3169 (setq ind (org-get-indentation))
3170 (while (not (eobp))
3171 (unless (looking-at "[ \t]*$")
3172 (setq ind (min ind (org-get-indentation))))
3173 (beginning-of-line 2))
3174 (goto-char (point-min))
3175 (while (not (eobp))
3176 (unless (looking-at "[ \t]*$")
3177 (move-to-column ind)
3178 (delete-region (point-at-bol) (point)))
3179 (beginning-of-line 2))
3181 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3183 (goto-char (point-min))
3184 (when indent
3185 (while (and (not (eobp)) (re-search-forward "^" nil t))
3186 (replace-match indent t t)))
3187 (goto-char (point-min))
3188 (while (looking-at "[ \t]*\n") (replace-match ""))
3189 (goto-char (point-max))
3190 (when (> (org-current-line)
3191 n-lines)
3192 (org-goto-line (1+ n-lines))
3193 (backward-char 1))
3194 (setq txt (buffer-substring (point-min) (point)))))))))
3195 txt))
3197 (defun org-agenda-collect-markers ()
3198 "Collect the markers pointing to entries in the agenda buffer."
3199 (let (m markers)
3200 (save-excursion
3201 (goto-char (point-min))
3202 (while (not (eobp))
3203 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3204 (org-get-at-bol 'org-marker)))
3205 (push m markers))
3206 (beginning-of-line 2)))
3207 (nreverse markers)))
3209 (defun org-create-marker-find-array (marker-list)
3210 "Create a alist of files names with all marker positions in that file."
3211 (let (f tbl m a p)
3212 (while (setq m (pop marker-list))
3213 (setq p (marker-position m)
3214 f (buffer-file-name (or (buffer-base-buffer
3215 (marker-buffer m))
3216 (marker-buffer m))))
3217 (if (setq a (assoc f tbl))
3218 (push (marker-position m) (cdr a))
3219 (push (list f p) tbl)))
3220 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3221 tbl)))
3223 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3224 (defun org-check-agenda-marker-table ()
3225 "Check of the current entry is on the marker list."
3226 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3228 (and (setq a (assoc file org-agenda-marker-table))
3229 (save-match-data
3230 (save-excursion
3231 (org-back-to-heading t)
3232 (member (point) (cdr a)))))))
3234 (defun org-check-for-org-mode ()
3235 "Make sure current buffer is in org-mode. Error if not."
3236 (or (derived-mode-p 'org-mode)
3237 (error "Cannot execute org-mode agenda command on buffer in %s"
3238 major-mode)))
3240 (defun org-fit-agenda-window ()
3241 "Fit the window to the buffer size."
3242 (and (memq org-agenda-window-setup '(reorganize-frame))
3243 (fboundp 'fit-window-to-buffer)
3244 (org-fit-window-to-buffer
3246 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3247 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3249 ;;; Agenda prepare and finalize
3251 (defvar org-agenda-multi nil) ; dynamically scoped
3252 (defvar org-agenda-buffer-name "*Org Agenda*")
3253 (defvar org-pre-agenda-window-conf nil)
3254 (defvar org-agenda-columns-active nil)
3255 (defvar org-agenda-name nil)
3256 (defvar org-agenda-tag-filter nil)
3257 (defvar org-agenda-category-filter nil)
3258 (defvar org-agenda-top-category-filter nil)
3259 (defvar org-agenda-tag-filter-while-redo nil)
3260 (defvar org-agenda-tag-filter-preset nil
3261 "A preset of the tags filter used for secondary agenda filtering.
3262 This must be a list of strings, each string must be a single tag preceded
3263 by \"+\" or \"-\".
3264 This variable should not be set directly, but agenda custom commands can
3265 bind it in the options section. The preset filter is a global property of
3266 the entire agenda view. In a block agenda, it will not work reliably to
3267 define a filter for one of the individual blocks. You need to set it in
3268 the global options and expect it to be applied to the entire view.")
3270 (defvar org-agenda-category-filter-preset nil
3271 "A preset of the category filter used for secondary agenda filtering.
3272 This must be a list of strings, each string must be a single category
3273 preceded by \"+\" or \"-\".
3274 This variable should not be set directly, but agenda custom commands can
3275 bind it in the options section. The preset filter is a global property of
3276 the entire agenda view. In a block agenda, it will not work reliably to
3277 define a filter for one of the individual blocks. You need to set it in
3278 the global options and expect it to be applied to the entire view.")
3281 (defun org-agenda-use-sticky-p ()
3282 "Return non-nil if an agenda buffer named
3283 `org-agenda-buffer-name' exists and should be shown instead of
3284 generating a new one."
3285 (and
3286 ;; turned off by user
3287 org-agenda-sticky
3288 ;; For multi-agenda buffer already exists
3289 (not org-agenda-multi)
3290 ;; buffer found
3291 (get-buffer org-agenda-buffer-name)
3292 ;; C-u parameter is same as last call
3293 (with-current-buffer (get-buffer org-agenda-buffer-name)
3294 (and
3295 (equal current-prefix-arg
3296 org-agenda-last-prefix-arg)
3297 ;; In case user turned stickiness on, while having existing
3298 ;; Agenda buffer active, don't reuse that buffer, because it
3299 ;; does not have org variables local
3300 org-agenda-this-buffer-is-sticky))))
3302 (defun org-prepare-agenda-window (abuf)
3303 "Setup agenda buffer in the window."
3304 (let* ((awin (get-buffer-window abuf))
3305 wconf)
3306 (cond
3307 ((equal (current-buffer) abuf) nil)
3308 (awin (select-window awin))
3309 ((not (setq wconf (current-window-configuration))))
3310 ((equal org-agenda-window-setup 'current-window)
3311 (org-pop-to-buffer-same-window abuf))
3312 ((equal org-agenda-window-setup 'other-window)
3313 (org-switch-to-buffer-other-window abuf))
3314 ((equal org-agenda-window-setup 'other-frame)
3315 (switch-to-buffer-other-frame abuf))
3316 ((equal org-agenda-window-setup 'reorganize-frame)
3317 (delete-other-windows)
3318 (org-switch-to-buffer-other-window abuf)))
3319 ;; additional test in case agenda is invoked from within agenda
3320 ;; buffer via elisp link
3321 (unless (equal (current-buffer) abuf)
3322 (org-pop-to-buffer-same-window abuf))
3323 (setq org-pre-agenda-window-conf wconf)))
3325 (defun org-prepare-agenda (&optional name)
3326 (if (org-agenda-use-sticky-p)
3327 (progn
3328 ;; Popup existing buffer
3329 (org-prepare-agenda-window (get-buffer org-agenda-buffer-name))
3330 (message "Sticky Agenda buffer, use `r' to refresh")
3331 (throw 'exit nil))
3332 (setq org-todo-keywords-for-agenda nil)
3333 (setq org-drawers-for-agenda nil)
3334 (unless org-agenda-persistent-filter
3335 (setq org-agenda-tag-filter nil
3336 org-agenda-category-filter nil))
3337 (put 'org-agenda-tag-filter :preset-filter
3338 org-agenda-tag-filter-preset)
3339 (put 'org-agenda-category-filter :preset-filter
3340 org-agenda-category-filter-preset)
3341 (if org-agenda-multi
3342 (progn
3343 (setq buffer-read-only nil)
3344 (goto-char (point-max))
3345 (unless (or (bobp) org-agenda-compact-blocks
3346 (not org-agenda-block-separator))
3347 (insert "\n"
3348 (if (stringp org-agenda-block-separator)
3349 org-agenda-block-separator
3350 (make-string (window-width) org-agenda-block-separator))
3351 "\n"))
3352 (narrow-to-region (point) (point-max)))
3353 (setq org-done-keywords-for-agenda nil)
3355 ;; Setting any org variables that are in org-agenda-local-vars
3356 ;; list need to be done after the prepare call
3357 (org-prepare-agenda-window (get-buffer-create org-agenda-buffer-name))
3358 (setq buffer-read-only nil)
3359 (org-agenda-reset-markers)
3360 (let ((inhibit-read-only t)) (erase-buffer))
3361 (org-agenda-mode)
3362 (setq org-agenda-buffer (current-buffer))
3363 (setq org-agenda-contributing-files nil)
3364 (setq org-agenda-columns-active nil)
3365 (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3366 (setq org-todo-keywords-for-agenda
3367 (org-uniquify org-todo-keywords-for-agenda))
3368 (setq org-done-keywords-for-agenda
3369 (org-uniquify org-done-keywords-for-agenda))
3370 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3371 (setq org-agenda-last-prefix-arg current-prefix-arg)
3372 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3373 (and name (not org-agenda-name)
3374 (org-set-local 'org-agenda-name name)))
3375 (setq buffer-read-only nil)))
3377 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3378 (defun org-finalize-agenda ()
3379 "Finishing touch for the agenda buffer, called just before displaying it."
3380 (unless org-agenda-multi
3381 (save-excursion
3382 (let ((inhibit-read-only t))
3383 (goto-char (point-min))
3384 (while (org-activate-bracket-links (point-max))
3385 (add-text-properties (match-beginning 0) (match-end 0)
3386 '(face org-link)))
3387 (org-agenda-align-tags)
3388 (unless org-agenda-with-colors
3389 (remove-text-properties (point-min) (point-max) '(face nil))))
3390 (if (and (boundp 'org-agenda-overriding-columns-format)
3391 org-agenda-overriding-columns-format)
3392 (org-set-local 'org-agenda-overriding-columns-format
3393 org-agenda-overriding-columns-format))
3394 (if (and (boundp 'org-agenda-view-columns-initially)
3395 org-agenda-view-columns-initially)
3396 (org-agenda-columns))
3397 (when org-agenda-fontify-priorities
3398 (org-agenda-fontify-priorities))
3399 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3400 (org-agenda-dim-blocked-tasks))
3401 (org-agenda-mark-clocking-task)
3402 (when org-agenda-entry-text-mode
3403 (org-agenda-entry-text-hide)
3404 (org-agenda-entry-text-show))
3405 (if (functionp 'org-habit-insert-consistency-graphs)
3406 (org-habit-insert-consistency-graphs))
3407 (run-hooks 'org-finalize-agenda-hook)
3408 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3409 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3410 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3411 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3412 (org-agenda-filter-apply org-agenda-category-filter 'category))
3413 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
3416 (defun org-agenda-mark-clocking-task ()
3417 "Mark the current clock entry in the agenda if it is present."
3418 (mapc (lambda (o)
3419 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3420 (delete-overlay o)))
3421 (overlays-in (point-min) (point-max)))
3422 (when (marker-buffer org-clock-hd-marker)
3423 (save-excursion
3424 (goto-char (point-min))
3425 (let (s ov)
3426 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3427 (goto-char s)
3428 (when (equal (org-get-at-bol 'org-hd-marker)
3429 org-clock-hd-marker)
3430 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3431 (overlay-put ov 'type 'org-agenda-clocking)
3432 (overlay-put ov 'face 'org-agenda-clocking)
3433 (overlay-put ov 'help-echo
3434 "The clock is running in this item")))))))
3436 (defun org-agenda-fontify-priorities ()
3437 "Make highest priority lines bold, and lowest italic."
3438 (interactive)
3439 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3440 (delete-overlay o)))
3441 (overlays-in (point-min) (point-max)))
3442 (save-excursion
3443 (let ((inhibit-read-only t)
3444 b e p ov h l)
3445 (goto-char (point-min))
3446 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3447 (setq h (or (get-char-property (point) 'org-highest-priority)
3448 org-highest-priority)
3449 l (or (get-char-property (point) 'org-lowest-priority)
3450 org-lowest-priority)
3451 p (string-to-char (match-string 1))
3452 b (match-beginning 0)
3453 e (if (eq org-agenda-fontify-priorities 'cookies)
3454 (match-end 0)
3455 (point-at-eol))
3456 ov (make-overlay b e))
3457 (overlay-put
3458 ov 'face
3459 (cond ((org-face-from-face-or-color
3460 'priority nil
3461 (cdr (assoc p org-priority-faces))))
3462 ((and (listp org-agenda-fontify-priorities)
3463 (org-face-from-face-or-color
3464 'priority nil
3465 (cdr (assoc p org-agenda-fontify-priorities)))))
3466 ((equal p l) 'italic)
3467 ((equal p h) 'bold)))
3468 (overlay-put ov 'org-type 'org-priority)))))
3470 (defun org-agenda-dim-blocked-tasks ()
3471 "Dim currently blocked TODO's in the agenda display."
3472 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3473 (delete-overlay o)))
3474 (overlays-in (point-min) (point-max)))
3475 (save-excursion
3476 (let ((inhibit-read-only t)
3477 (org-depend-tag-blocked nil)
3478 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3479 org-blocked-by-checkboxes
3480 invis1 b e p ov h l)
3481 (goto-char (point-min))
3482 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3483 (and pos (goto-char (1+ pos))))
3484 (setq org-blocked-by-checkboxes nil invis1 invis)
3485 (let ((marker (org-get-at-bol 'org-hd-marker)))
3486 (when (and marker
3487 (with-current-buffer (marker-buffer marker)
3488 (save-excursion (goto-char marker)
3489 (org-entry-blocked-p))))
3490 (if org-blocked-by-checkboxes (setq invis1 nil))
3491 (setq b (if invis1
3492 (max (point-min) (1- (point-at-bol)))
3493 (point-at-bol))
3494 e (point-at-eol)
3495 ov (make-overlay b e))
3496 (if invis1
3497 (overlay-put ov 'invisible t)
3498 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3499 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3501 (defvar org-agenda-skip-function nil
3502 "Function to be called at each match during agenda construction.
3503 If this function returns nil, the current match should not be skipped.
3504 Otherwise, the function must return a position from where the search
3505 should be continued.
3506 This may also be a Lisp form, it will be evaluated.
3507 Never set this variable using `setq' or so, because then it will apply
3508 to all future agenda commands. If you do want a global skipping condition,
3509 use the option `org-agenda-skip-function-global' instead.
3510 The correct usage for `org-agenda-skip-function' is to bind it with
3511 `let' to scope it dynamically into the agenda-constructing command.
3512 A good way to set it is through options in `org-agenda-custom-commands'.")
3514 (defun org-agenda-skip ()
3515 "Throw to `:skip' in places that should be skipped.
3516 Also moves point to the end of the skipped region, so that search can
3517 continue from there."
3518 (let ((p (point-at-bol)) to)
3519 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3520 (get-text-property p :org-archived)
3521 (org-end-of-subtree t)
3522 (throw :skip t))
3523 (and org-agenda-skip-comment-trees
3524 (get-text-property p :org-comment)
3525 (org-end-of-subtree t)
3526 (throw :skip t))
3527 (if (equal (char-after p) ?#) (throw :skip t))
3528 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3529 (org-agenda-skip-eval org-agenda-skip-function)))
3530 (goto-char to)
3531 (throw :skip t))))
3533 (defun org-agenda-skip-eval (form)
3534 "If FORM is a function or a list, call (or eval) is and return result.
3535 `save-excursion' and `save-match-data' are wrapped around the call, so point
3536 and match data are returned to the previous state no matter what these
3537 functions do."
3538 (let (fp)
3539 (and form
3540 (or (setq fp (functionp form))
3541 (consp form))
3542 (save-excursion
3543 (save-match-data
3544 (if fp
3545 (funcall form)
3546 (eval form)))))))
3548 (defvar org-agenda-markers nil
3549 "List of all currently active markers created by `org-agenda'.")
3550 (defvar org-agenda-last-marker-time (org-float-time)
3551 "Creation time of the last agenda marker.")
3553 (defun org-agenda-new-marker (&optional pos)
3554 "Return a new agenda marker.
3555 Org-mode keeps a list of these markers and resets them when they are
3556 no longer in use."
3557 (let ((m (copy-marker (or pos (point)))))
3558 (setq org-agenda-last-marker-time (org-float-time))
3559 (if org-agenda-buffer
3560 (with-current-buffer org-agenda-buffer
3561 (push m org-agenda-markers))
3562 (push m org-agenda-markers))
3565 (defun org-agenda-reset-markers ()
3566 "Reset markers created by `org-agenda'."
3567 (while org-agenda-markers
3568 (move-marker (pop org-agenda-markers) nil)))
3570 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3571 "Save relative positions of markers in region.
3572 This check for agenda markers in all agenda buffers currently active."
3573 (dolist (buf (buffer-list))
3574 (with-current-buffer buf
3575 (when (eq major-mode 'org-agenda-mode)
3576 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3577 org-agenda-markers)))))
3579 ;;; Entry text mode
3581 (defun org-agenda-entry-text-show-here ()
3582 "Add some text from the entry as context to the current line."
3583 (let (m txt o)
3584 (setq m (org-get-at-bol 'org-hd-marker))
3585 (unless (marker-buffer m)
3586 (error "No marker points to an entry here"))
3587 (setq txt (concat "\n" (org-no-properties
3588 (org-agenda-get-some-entry-text
3589 m org-agenda-entry-text-maxlines " > "))))
3590 (when (string-match "\\S-" txt)
3591 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3592 (overlay-put o 'evaporate t)
3593 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3594 (overlay-put o 'after-string txt))))
3596 (defun org-agenda-entry-text-show ()
3597 "Add entry context for all agenda lines."
3598 (interactive)
3599 (save-excursion
3600 (goto-char (point-max))
3601 (beginning-of-line 1)
3602 (while (not (bobp))
3603 (when (org-get-at-bol 'org-hd-marker)
3604 (org-agenda-entry-text-show-here))
3605 (beginning-of-line 0))))
3607 (defun org-agenda-entry-text-hide ()
3608 "Remove any shown entry context."
3609 (delq nil
3610 (mapcar (lambda (o)
3611 (if (eq (overlay-get o 'org-overlay-type)
3612 'agenda-entry-content)
3613 (progn (delete-overlay o) t)))
3614 (overlays-in (point-min) (point-max)))))
3616 (defun org-agenda-get-day-face (date)
3617 "Return the face DATE should be displayed with."
3618 (or (and (functionp org-agenda-day-face-function)
3619 (funcall org-agenda-day-face-function date))
3620 (cond ((org-agenda-todayp date)
3621 'org-agenda-date-today)
3622 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3623 'org-agenda-date-weekend)
3624 (t 'org-agenda-date))))
3626 ;;; Agenda timeline
3628 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3630 (defun org-timeline (&optional dotodo)
3631 "Show a time-sorted view of the entries in the current org file.
3632 Only entries with a time stamp of today or later will be listed. With
3633 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3634 under the current date.
3635 If the buffer contains an active region, only check the region for
3636 dates."
3637 (interactive "P")
3638 (let* ((dopast t)
3639 (org-agenda-show-log-scoped org-agenda-show-log)
3640 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3641 (current-buffer))))
3642 (date (calendar-current-date))
3643 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3644 (end (if (org-region-active-p) (region-end) (point-max)))
3645 (day-numbers (org-get-all-dates
3646 beg end 'no-ranges
3647 t org-agenda-show-log-scoped ; always include today
3648 org-timeline-show-empty-dates))
3649 (org-deadline-warning-days 0)
3650 (org-agenda-only-exact-dates t)
3651 (today (org-today))
3652 (past t)
3653 args
3654 s e rtn d emptyp)
3655 (setq org-agenda-redo-command
3656 (list 'progn
3657 (list 'org-switch-to-buffer-other-window (current-buffer))
3658 (list 'org-timeline (list 'quote dotodo))))
3659 (if (not dopast)
3660 ;; Remove past dates from the list of dates.
3661 (setq day-numbers (delq nil (mapcar (lambda(x)
3662 (if (>= x today) x nil))
3663 day-numbers))))
3664 (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3665 (org-compile-prefix-format 'timeline)
3666 (org-set-sorting-strategy 'timeline)
3667 (if org-agenda-show-log-scoped (push :closed args))
3668 (push :timestamp args)
3669 (push :deadline args)
3670 (push :scheduled args)
3671 (push :sexp args)
3672 (if dotodo (push :todo args))
3673 (insert "Timeline of file " entry "\n")
3674 (add-text-properties (point-min) (point)
3675 (list 'face 'org-agenda-structure))
3676 (org-agenda-mark-header-line (point-min))
3677 (while (setq d (pop day-numbers))
3678 (if (and (listp d) (eq (car d) :omitted))
3679 (progn
3680 (setq s (point))
3681 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3682 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3683 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3684 (if (and (>= d today)
3685 dopast
3686 past)
3687 (progn
3688 (setq past nil)
3689 (insert (make-string 79 ?-) "\n")))
3690 (setq date (calendar-gregorian-from-absolute d))
3691 (setq s (point))
3692 (setq rtn (and (not emptyp)
3693 (apply 'org-agenda-get-day-entries entry
3694 date args)))
3695 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3696 (progn
3697 (insert
3698 (if (stringp org-agenda-format-date)
3699 (format-time-string org-agenda-format-date
3700 (org-time-from-absolute date))
3701 (funcall org-agenda-format-date date))
3702 "\n")
3703 (put-text-property s (1- (point)) 'face
3704 (org-agenda-get-day-face date))
3705 (put-text-property s (1- (point)) 'org-date-line t)
3706 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3707 (if (equal d today)
3708 (put-text-property s (1- (point)) 'org-today t))
3709 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3710 (put-text-property s (1- (point)) 'day d)))))
3711 (goto-char (point-min))
3712 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3713 (point-min)))
3714 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3715 (org-finalize-agenda)
3716 (setq buffer-read-only t)))
3718 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3719 "Return a list of all relevant day numbers from BEG to END buffer positions.
3720 If NO-RANGES is non-nil, include only the start and end dates of a range,
3721 not every single day in the range. If FORCE-TODAY is non-nil, make
3722 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3723 inactive time stamps (those in square brackets) are included.
3724 When EMPTY is non-nil, also include days without any entries."
3725 (let ((re (concat
3726 (if pre-re pre-re "")
3727 (if inactive org-ts-regexp-both org-ts-regexp)))
3728 dates dates1 date day day1 day2 ts1 ts2 pos)
3729 (if force-today
3730 (setq dates (list (org-today))))
3731 (save-excursion
3732 (goto-char beg)
3733 (while (re-search-forward re end t)
3734 (setq day (time-to-days (org-time-string-to-time
3735 (substring (match-string 1) 0 10)
3736 (current-buffer) (match-beginning 0))))
3737 (or (memq day dates) (push day dates)))
3738 (unless no-ranges
3739 (goto-char beg)
3740 (while (re-search-forward org-tr-regexp end t)
3741 (setq pos (match-beginning 0))
3742 (setq ts1 (substring (match-string 1) 0 10)
3743 ts2 (substring (match-string 2) 0 10)
3744 day1 (time-to-days (org-time-string-to-time
3745 ts1 (current-buffer) pos))
3746 day2 (time-to-days (org-time-string-to-time
3747 ts2 (current-buffer) pos)))
3748 (while (< (setq day1 (1+ day1)) day2)
3749 (or (memq day1 dates) (push day1 dates)))))
3750 (setq dates (sort dates '<))
3751 (when empty
3752 (while (setq day (pop dates))
3753 (setq day2 (car dates))
3754 (push day dates1)
3755 (when (and day2 empty)
3756 (if (or (eq empty t)
3757 (and (numberp empty) (<= (- day2 day) empty)))
3758 (while (< (setq day (1+ day)) day2)
3759 (push (list day) dates1))
3760 (push (cons :omitted (- day2 day)) dates1))))
3761 (setq dates (nreverse dates1)))
3762 dates)))
3764 ;;; Agenda Daily/Weekly
3766 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3767 "Start day for the agenda view.
3768 Custom commands can set this variable in the options section.")
3769 (defvar org-starting-day nil) ; local variable in the agenda buffer
3770 (defvar org-agenda-current-span nil
3771 "The current span used in the agenda view.") ; local variable in the agenda buffer
3772 (defvar org-arg-loc nil) ; local variable
3774 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3775 "List of types searched for when creating the daily/weekly agenda.
3776 This variable is a list of symbols that controls the types of
3777 items that appear in the daily/weekly agenda. Allowed symbols in this
3778 list are are
3780 :timestamp List items containing a date stamp or date range matching
3781 the selected date. This includes sexp entries in
3782 angular brackets.
3784 :sexp List entries resulting from plain diary-like sexps.
3786 :deadline List deadline due on that date. When the date is today,
3787 also list any deadlines past due, or due within
3788 `org-deadline-warning-days'. `:deadline' must appear before
3789 `:scheduled' if the setting of
3790 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3791 any effect.
3793 :scheduled List all items which are scheduled for the given date.
3794 The diary for *today* also contains items which were
3795 scheduled earlier and are not yet marked DONE.
3797 By default, all four types are turned on.
3799 Never set this variable globally using `setq', because then it
3800 will apply to all future agenda commands. Instead, bind it with
3801 `let' to scope it dynamically into the agenda-constructing
3802 command. A good way to set it is through options in
3803 `org-agenda-custom-commands'. For a more flexible (though
3804 somewhat less efficient) way of determining what is included in
3805 the daily/weekly agenda, see `org-agenda-skip-function'.")
3807 ;;;###autoload
3808 (defun org-agenda-list (&optional arg start-day span)
3809 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3810 The view will be for the current day or week, but from the overview buffer
3811 you will be able to go to other days/weeks.
3813 With a numeric prefix argument in an interactive call, the agenda will
3814 span ARG days. Lisp programs should instead specify SPAN to change
3815 the number of days. SPAN defaults to `org-agenda-span'.
3817 START-DAY defaults to TODAY, or to the most recent match for the weekday
3818 given in `org-agenda-start-on-weekday'."
3819 (interactive "P")
3820 (if (and (integerp arg) (> arg 0))
3821 (setq span arg arg nil))
3822 (org-prepare-agenda "Day/Week")
3823 (setq start-day (or start-day org-agenda-start-day))
3824 (if org-agenda-overriding-arguments
3825 (setq arg (car org-agenda-overriding-arguments)
3826 start-day (nth 1 org-agenda-overriding-arguments)
3827 span (nth 2 org-agenda-overriding-arguments)))
3828 (if (stringp start-day)
3829 ;; Convert to an absolute day number
3830 (setq start-day (time-to-days (org-read-date nil t start-day))))
3831 (setq org-agenda-last-arguments (list arg start-day span))
3832 (org-compile-prefix-format 'agenda)
3833 (org-set-sorting-strategy 'agenda)
3834 (let* ((span (org-agenda-ndays-to-span
3835 (or span org-agenda-ndays org-agenda-span)))
3836 (today (org-today))
3837 (sd (or start-day today))
3838 (ndays (org-agenda-span-to-ndays span sd))
3839 (org-agenda-start-on-weekday
3840 (if (eq ndays 7)
3841 org-agenda-start-on-weekday))
3842 (thefiles (org-agenda-files nil 'ifmode))
3843 (files thefiles)
3844 (start (if (or (null org-agenda-start-on-weekday)
3845 (< ndays 7))
3847 (let* ((nt (calendar-day-of-week
3848 (calendar-gregorian-from-absolute sd)))
3849 (n1 org-agenda-start-on-weekday)
3850 (d (- nt n1)))
3851 (- sd (+ (if (< d 0) 7 0) d)))))
3852 (day-numbers (list start))
3853 (day-cnt 0)
3854 (inhibit-redisplay (not debug-on-error))
3855 (org-agenda-show-log-scoped org-agenda-show-log)
3856 s e rtn rtnall file date d start-pos end-pos todayp
3857 clocktable-start clocktable-end filter)
3858 (setq org-agenda-redo-command
3859 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3860 (dotimes (n (1- ndays))
3861 (push (1+ (car day-numbers)) day-numbers))
3862 (setq day-numbers (nreverse day-numbers))
3863 (setq clocktable-start (car day-numbers)
3864 clocktable-end (1+ (or (org-last day-numbers) 0)))
3865 (org-set-local 'org-starting-day (car day-numbers))
3866 (org-set-local 'org-arg-loc arg)
3867 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3868 (unless org-agenda-compact-blocks
3869 (let* ((d1 (car day-numbers))
3870 (d2 (org-last day-numbers))
3871 (w1 (org-days-to-iso-week d1))
3872 (w2 (org-days-to-iso-week d2)))
3873 (setq s (point))
3874 (if org-agenda-overriding-header
3875 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3876 nil 'face 'org-agenda-structure) "\n")
3877 (insert (org-agenda-span-name span)
3878 "-agenda"
3879 (if (< (- d2 d1) 350)
3880 (if (= w1 w2)
3881 (format " (W%02d)" w1)
3882 (format " (W%02d-W%02d)" w1 w2))
3884 ":\n")))
3885 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3886 'org-date-line t))
3887 (org-agenda-mark-header-line s))
3888 (while (setq d (pop day-numbers))
3889 (setq date (calendar-gregorian-from-absolute d)
3890 s (point))
3891 (if (or (setq todayp (= d today))
3892 (and (not start-pos) (= d sd)))
3893 (setq start-pos (point))
3894 (if (and start-pos (not end-pos))
3895 (setq end-pos (point))))
3896 (setq files thefiles
3897 rtnall nil)
3898 (while (setq file (pop files))
3899 (catch 'nextfile
3900 (org-check-agenda-file file)
3901 (let ((org-agenda-entry-types org-agenda-entry-types))
3902 (unless org-agenda-include-deadlines
3903 (setq org-agenda-entry-types
3904 (delq :deadline org-agenda-entry-types)))
3905 (cond
3906 ((memq org-agenda-show-log-scoped '(only clockcheck))
3907 (setq rtn (org-agenda-get-day-entries
3908 file date :closed)))
3909 (org-agenda-show-log-scoped
3910 (setq rtn (apply 'org-agenda-get-day-entries
3911 file date
3912 (append '(:closed) org-agenda-entry-types))))
3914 (setq rtn (apply 'org-agenda-get-day-entries
3915 file date
3916 org-agenda-entry-types)))))
3917 (setq rtnall (append rtnall rtn)))) ;; all entries
3918 (if org-agenda-include-diary
3919 (let ((org-agenda-search-headline-for-time t))
3920 (require 'diary-lib)
3921 (setq rtn (org-get-entries-from-diary date))
3922 (setq rtnall (append rtnall rtn))))
3923 (if (or rtnall org-agenda-show-all-dates)
3924 (progn
3925 (setq day-cnt (1+ day-cnt))
3926 (insert
3927 (if (stringp org-agenda-format-date)
3928 (format-time-string org-agenda-format-date
3929 (org-time-from-absolute date))
3930 (funcall org-agenda-format-date date))
3931 "\n")
3932 (put-text-property s (1- (point)) 'face
3933 (org-agenda-get-day-face date))
3934 (put-text-property s (1- (point)) 'org-date-line t)
3935 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3936 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3937 (when todayp
3938 (put-text-property s (1- (point)) 'org-today t))
3939 (setq rtnall
3940 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
3941 (if rtnall (insert ;; all entries
3942 (org-finalize-agenda-entries rtnall)
3943 "\n"))
3944 (put-text-property s (1- (point)) 'day d)
3945 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3946 (when (and org-agenda-clockreport-mode clocktable-start)
3947 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3948 ;; the above line is to ensure the restricted range!
3949 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3950 tbl)
3951 (setq p (org-plist-delete p :block))
3952 (setq p (plist-put p :tstart clocktable-start))
3953 (setq p (plist-put p :tend clocktable-end))
3954 (setq p (plist-put p :scope 'agenda))
3955 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3956 (setq filter (or org-agenda-tag-filter-while-redo
3957 (get 'org-agenda-tag-filter :preset-filter))))
3958 (setq p (plist-put p :tags (mapconcat (lambda (x)
3959 (if (string-match "[<>=]" x)
3962 filter ""))))
3963 (setq tbl (apply 'org-get-clocktable p))
3964 (insert tbl)))
3965 (goto-char (point-min))
3966 (or org-agenda-multi (org-fit-agenda-window))
3967 (unless (and (pos-visible-in-window-p (point-min))
3968 (pos-visible-in-window-p (point-max)))
3969 (goto-char (1- (point-max)))
3970 (recenter -1)
3971 (if (not (pos-visible-in-window-p (or start-pos 1)))
3972 (progn
3973 (goto-char (or start-pos 1))
3974 (recenter 1))))
3975 (goto-char (or start-pos 1))
3976 (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
3977 (if (eq org-agenda-show-log-scoped 'clockcheck)
3978 (org-agenda-show-clocking-issues))
3979 (org-finalize-agenda)
3980 (setq buffer-read-only t)
3981 (message "")))
3983 (defun org-agenda-ndays-to-span (n)
3984 "Return a span symbol for a span of N days, or N if none matches."
3985 (cond ((symbolp n) n)
3986 ((= n 1) 'day)
3987 ((= n 7) 'week)
3988 (t n)))
3990 (defun org-agenda-span-to-ndays (span start-day)
3991 "Return ndays from SPAN starting at START-DAY."
3992 (cond ((numberp span) span)
3993 ((eq span 'day) 1)
3994 ((eq span 'week) 7)
3995 ((eq span 'month)
3996 (let ((date (calendar-gregorian-from-absolute start-day)))
3997 (calendar-last-day-of-month (car date) (caddr date))))
3998 ((eq span 'year)
3999 (let ((date (calendar-gregorian-from-absolute start-day)))
4000 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4002 (defun org-agenda-span-name (span)
4003 "Return a SPAN name."
4004 (if (null span)
4006 (if (symbolp span)
4007 (capitalize (symbol-name span))
4008 (format "%d days" span))))
4010 ;;; Agenda word search
4012 (defvar org-agenda-search-history nil)
4013 (defvar org-todo-only nil)
4015 (defvar org-search-syntax-table nil
4016 "Special syntax table for org-mode search.
4017 In this table, we have single quotes not as word constituents, to
4018 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4020 (defvar org-mode-syntax-table) ; From org.el
4021 (defun org-search-syntax-table ()
4022 (unless org-search-syntax-table
4023 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4024 (modify-syntax-entry ?' "." org-search-syntax-table)
4025 (modify-syntax-entry ?` "." org-search-syntax-table))
4026 org-search-syntax-table)
4028 (defvar org-agenda-last-search-view-search-was-boolean nil)
4030 ;;;###autoload
4031 (defun org-search-view (&optional todo-only string edit-at)
4032 "Show all entries that contain a phrase or words or regular expressions.
4034 With optional prefix argument TODO-ONLY, only consider entries that are
4035 TODO entries. The argument STRING can be used to pass a default search
4036 string into this function. If EDIT-AT is non-nil, it means that the
4037 user should get a chance to edit this string, with cursor at position
4038 EDIT-AT.
4040 The search string can be viewed either as a phrase that should be found as
4041 is, or it can be broken into a number of snippets, each of which must match
4042 in a Boolean way to select an entry. The default depends on the variable
4043 `org-agenda-search-view-always-boolean'.
4044 Even if this is turned off (the default) you can always switch to
4045 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4047 The default is a direct search of the whole phrase, where each space in
4048 the search string can expand to an arbitrary amount of whitespace,
4049 including newlines.
4051 If using a Boolean search, the search string is split on whitespace and
4052 each snippet is searched separately, with logical AND to select an entry.
4053 Words prefixed with a minus must *not* occur in the entry. Words without
4054 a prefix or prefixed with a plus must occur in the entry. Matching is
4055 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4056 match whole words, not parts of a word) if
4057 `org-agenda-search-view-force-full-words' is set (default is nil).
4059 Boolean search snippets enclosed by curly braces are interpreted as
4060 regular expressions that must or (when preceded with \"-\") must not
4061 match in the entry. Snippets enclosed into double quotes will be taken
4062 as a whole, to include whitespace.
4064 - If the search string starts with an asterisk, search only in headlines.
4065 - If (possibly after the leading star) the search string starts with an
4066 exclamation mark, this also means to look at TODO entries only, an effect
4067 that can also be achieved with a prefix argument.
4068 - If (possibly after star and exclamation mark) the search string starts
4069 with a colon, this will mean that the (non-regexp) snippets of the
4070 Boolean search must match as full words.
4072 This command searches the agenda files, and in addition the files listed
4073 in `org-agenda-text-search-extra-files'."
4074 (interactive "P")
4075 (org-prepare-agenda "SEARCH")
4076 (org-compile-prefix-format 'search)
4077 (org-set-sorting-strategy 'search)
4078 (let* ((props (list 'face nil
4079 'done-face 'org-agenda-done
4080 'org-not-done-regexp org-not-done-regexp
4081 'org-todo-regexp org-todo-regexp
4082 'org-complex-heading-regexp org-complex-heading-regexp
4083 'mouse-face 'highlight
4084 'help-echo (format "mouse-2 or RET jump to location")))
4085 (full-words org-agenda-search-view-force-full-words)
4086 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4087 regexp rtn rtnall files file pos
4088 marker category category-pos tags c neg re boolean
4089 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4090 (unless (and (not edit-at)
4091 (stringp string)
4092 (string-match "\\S-" string))
4093 (setq string (read-string
4094 (if org-agenda-search-view-always-boolean
4095 "[+-]Word/{Regexp} ...: "
4096 "Phrase, or [+-]Word/{Regexp} ...: ")
4097 (cond
4098 ((integerp edit-at) (cons string edit-at))
4099 (edit-at string))
4100 'org-agenda-search-history)))
4101 (org-set-local 'org-todo-only todo-only)
4102 (setq org-agenda-redo-command
4103 (list 'org-search-view (if todo-only t nil) string
4104 '(if current-prefix-arg 1 nil)))
4105 (setq org-agenda-query-string string)
4107 (if (equal (string-to-char string) ?*)
4108 (setq hdl-only t
4109 words (substring string 1))
4110 (setq words string))
4111 (when (equal (string-to-char words) ?!)
4112 (setq todo-only t
4113 words (substring words 1)))
4114 (when (equal (string-to-char words) ?:)
4115 (setq full-words t
4116 words (substring words 1)))
4117 (if (or org-agenda-search-view-always-boolean
4118 (member (string-to-char words) '(?- ?+ ?\{)))
4119 (setq boolean t))
4120 (setq words (org-split-string words))
4121 (let (www w)
4122 (while (setq w (pop words))
4123 (while (and (string-match "\\\\\\'" w) words)
4124 (setq w (concat (substring w 0 -1) " " (pop words))))
4125 (push w www))
4126 (setq words (nreverse www) www nil)
4127 (while (setq w (pop words))
4128 (when (and (string-match "\\`[-+]?{" w)
4129 (not (string-match "}\\'" w)))
4130 (while (and words (not (string-match "}\\'" (car words))))
4131 (setq w (concat w " " (pop words))))
4132 (setq w (concat w " " (pop words))))
4133 (push w www))
4134 (setq words (nreverse www)))
4135 (setq org-agenda-last-search-view-search-was-boolean boolean)
4136 (when boolean
4137 (let (wds w)
4138 (while (setq w (pop words))
4139 (if (or (equal (substring w 0 1) "\"")
4140 (and (> (length w) 1)
4141 (member (substring w 0 1) '("+" "-"))
4142 (equal (substring w 1 2) "\"")))
4143 (while (and words (not (equal (substring w -1) "\"")))
4144 (setq w (concat w " " (pop words)))))
4145 (and (string-match "\\`\\([-+]?\\)\"" w)
4146 (setq w (replace-match "\\1" nil nil w)))
4147 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4148 (push w wds))
4149 (setq words (nreverse wds))))
4150 (if boolean
4151 (mapc (lambda (w)
4152 (setq c (string-to-char w))
4153 (if (equal c ?-)
4154 (setq neg t w (substring w 1))
4155 (if (equal c ?+)
4156 (setq neg nil w (substring w 1))
4157 (setq neg nil)))
4158 (if (string-match "\\`{.*}\\'" w)
4159 (setq re (substring w 1 -1))
4160 (if full-words
4161 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4162 (setq re (regexp-quote (downcase w)))))
4163 (if neg (push re regexps-) (push re regexps+)))
4164 words)
4165 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4166 regexps+))
4167 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4168 (if (not regexps+)
4169 (setq regexp org-outline-regexp-bol)
4170 (setq regexp (pop regexps+))
4171 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4172 regexp))))
4173 (setq files (org-agenda-files nil 'ifmode))
4174 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4175 (pop org-agenda-text-search-extra-files)
4176 (setq files (org-add-archive-files files)))
4177 (setq files (append files org-agenda-text-search-extra-files)
4178 rtnall nil)
4179 (while (setq file (pop files))
4180 (setq ee nil)
4181 (catch 'nextfile
4182 (org-check-agenda-file file)
4183 (setq buffer (if (file-exists-p file)
4184 (org-get-agenda-file-buffer file)
4185 (error "No such file %s" file)))
4186 (if (not buffer)
4187 ;; If file does not exist, make sure an error message is sent
4188 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4189 file))))
4190 (with-current-buffer buffer
4191 (with-syntax-table (org-search-syntax-table)
4192 (unless (derived-mode-p 'org-mode)
4193 (error "Agenda file %s is not in `org-mode'" file))
4194 (let ((case-fold-search t))
4195 (save-excursion
4196 (save-restriction
4197 (if org-agenda-restrict
4198 (narrow-to-region org-agenda-restrict-begin
4199 org-agenda-restrict-end)
4200 (widen))
4201 (goto-char (point-min))
4202 (unless (or (org-at-heading-p)
4203 (outline-next-heading))
4204 (throw 'nextfile t))
4205 (goto-char (max (point-min) (1- (point))))
4206 (while (re-search-forward regexp nil t)
4207 (org-back-to-heading t)
4208 (skip-chars-forward "* ")
4209 (setq beg (point-at-bol)
4210 beg1 (point)
4211 end (progn (outline-next-heading) (point)))
4212 (catch :skip
4213 (goto-char beg)
4214 (org-agenda-skip)
4215 (setq str (buffer-substring-no-properties
4216 (point-at-bol)
4217 (if hdl-only (point-at-eol) end)))
4218 (mapc (lambda (wr) (when (string-match wr str)
4219 (goto-char (1- end))
4220 (throw :skip t)))
4221 regexps-)
4222 (mapc (lambda (wr) (unless (string-match wr str)
4223 (goto-char (1- end))
4224 (throw :skip t)))
4225 (if todo-only
4226 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4227 regexps+)
4228 regexps+))
4229 (goto-char beg)
4230 (setq marker (org-agenda-new-marker (point))
4231 category (org-get-category)
4232 category-pos (get-text-property (point) 'org-category-position)
4233 tags (org-get-tags-at (point))
4234 txt (org-agenda-format-item
4236 (buffer-substring-no-properties
4237 beg1 (point-at-eol))
4238 category tags))
4239 (org-add-props txt props
4240 'org-marker marker 'org-hd-marker marker
4241 'org-todo-regexp org-todo-regexp
4242 'org-complex-heading-regexp org-complex-heading-regexp
4243 'priority 1000 'org-category category
4244 'org-category-position category-pos
4245 'type "search")
4246 (push txt ee)
4247 (goto-char (1- end))))))))))
4248 (setq rtn (nreverse ee))
4249 (setq rtnall (append rtnall rtn)))
4250 (if org-agenda-overriding-header
4251 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4252 nil 'face 'org-agenda-structure) "\n")
4253 (insert "Search words: ")
4254 (add-text-properties (point-min) (1- (point))
4255 (list 'face 'org-agenda-structure))
4256 (setq pos (point))
4257 (insert string "\n")
4258 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4259 (setq pos (point))
4260 (unless org-agenda-multi
4261 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4262 (add-text-properties pos (1- (point))
4263 (list 'face 'org-agenda-structure))))
4264 (org-agenda-mark-header-line (point-min))
4265 (when rtnall
4266 (insert (org-finalize-agenda-entries rtnall) "\n"))
4267 (goto-char (point-min))
4268 (or org-agenda-multi (org-fit-agenda-window))
4269 (add-text-properties (point-min) (point-max) '(org-agenda-type search))
4270 (org-finalize-agenda)
4271 (setq buffer-read-only t)))
4273 ;;; Agenda TODO list
4275 (defvar org-select-this-todo-keyword nil)
4276 (defvar org-last-arg nil)
4278 ;;;###autoload
4279 (defun org-todo-list (arg)
4280 "Show all (not done) TODO entries from all agenda file in a single list.
4281 The prefix arg can be used to select a specific TODO keyword and limit
4282 the list to these. When using \\[universal-argument], you will be prompted
4283 for a keyword. A numeric prefix directly selects the Nth keyword in
4284 `org-todo-keywords-1'."
4285 (interactive "P")
4286 (org-prepare-agenda "TODO")
4287 (org-compile-prefix-format 'todo)
4288 (org-set-sorting-strategy 'todo)
4289 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4290 (let* ((today (org-today))
4291 (date (calendar-gregorian-from-absolute today))
4292 (kwds org-todo-keywords-for-agenda)
4293 (completion-ignore-case t)
4294 (org-select-this-todo-keyword
4295 (if (stringp arg) arg
4296 (and arg (integerp arg) (> arg 0)
4297 (nth (1- arg) kwds))))
4298 rtn rtnall files file pos)
4299 (when (equal arg '(4))
4300 (setq org-select-this-todo-keyword
4301 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4302 (mapcar 'list kwds) nil nil)))
4303 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4304 (org-set-local 'org-last-arg arg)
4305 (setq org-agenda-redo-command
4306 '(org-todo-list (or current-prefix-arg org-last-arg)))
4307 (setq files (org-agenda-files nil 'ifmode)
4308 rtnall nil)
4309 (while (setq file (pop files))
4310 (catch 'nextfile
4311 (org-check-agenda-file file)
4312 (setq rtn (org-agenda-get-day-entries file date :todo))
4313 (setq rtnall (append rtnall rtn))))
4314 (if org-agenda-overriding-header
4315 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4316 nil 'face 'org-agenda-structure) "\n")
4317 (insert "Global list of TODO items of type: ")
4318 (add-text-properties (point-min) (1- (point))
4319 (list 'face 'org-agenda-structure
4320 'short-heading
4321 (concat "ToDo: "
4322 (or org-select-this-todo-keyword "ALL"))))
4323 (org-agenda-mark-header-line (point-min))
4324 (setq pos (point))
4325 (insert (or org-select-this-todo-keyword "ALL") "\n")
4326 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4327 (setq pos (point))
4328 (unless org-agenda-multi
4329 (insert "Available with `N r': (0)ALL")
4330 (let ((n 0) s)
4331 (mapc (lambda (x)
4332 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4333 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4334 (insert "\n "))
4335 (insert " " s))
4336 kwds))
4337 (insert "\n"))
4338 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4339 (org-agenda-mark-header-line (point-min))
4340 (when rtnall
4341 (insert (org-finalize-agenda-entries rtnall) "\n"))
4342 (goto-char (point-min))
4343 (or org-agenda-multi (org-fit-agenda-window))
4344 (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
4345 (org-finalize-agenda)
4346 (setq buffer-read-only t)))
4348 ;;; Agenda tags match
4350 ;;;###autoload
4351 (defun org-tags-view (&optional todo-only match)
4352 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4353 The prefix arg TODO-ONLY limits the search to TODO entries."
4354 (interactive "P")
4355 (let* ((org-tags-match-list-sublevels
4356 org-tags-match-list-sublevels)
4357 (completion-ignore-case t)
4358 rtn rtnall files file pos matcher
4359 buffer)
4360 (when (and (stringp match) (not (string-match "\\S-" match)))
4361 (setq match nil))
4362 (setq matcher (org-make-tags-matcher match)
4363 match (car matcher) matcher (cdr matcher))
4364 (org-prepare-agenda (concat "TAGS " match))
4365 (org-compile-prefix-format 'tags)
4366 (org-set-sorting-strategy 'tags)
4367 (setq org-agenda-query-string match)
4368 (setq org-agenda-redo-command
4369 (list 'org-tags-view (list 'quote todo-only)
4370 (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
4371 (setq files (org-agenda-files nil 'ifmode)
4372 rtnall nil)
4373 (while (setq file (pop files))
4374 (catch 'nextfile
4375 (org-check-agenda-file file)
4376 (setq buffer (if (file-exists-p file)
4377 (org-get-agenda-file-buffer file)
4378 (error "No such file %s" file)))
4379 (if (not buffer)
4380 ;; If file does not exist, error message to agenda
4381 (setq rtn (list
4382 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4383 rtnall (append rtnall rtn))
4384 (with-current-buffer buffer
4385 (unless (derived-mode-p 'org-mode)
4386 (error "Agenda file %s is not in `org-mode'" file))
4387 (save-excursion
4388 (save-restriction
4389 (if org-agenda-restrict
4390 (narrow-to-region org-agenda-restrict-begin
4391 org-agenda-restrict-end)
4392 (widen))
4393 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4394 (setq rtnall (append rtnall rtn))))))))
4395 (if org-agenda-overriding-header
4396 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4397 nil 'face 'org-agenda-structure) "\n")
4398 (insert "Headlines with TAGS match: ")
4399 (add-text-properties (point-min) (1- (point))
4400 (list 'face 'org-agenda-structure
4401 'short-heading
4402 (concat "Match: " match)))
4403 (setq pos (point))
4404 (insert match "\n")
4405 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4406 (setq pos (point))
4407 (unless org-agenda-multi
4408 (insert "Press `C-u r' to search again with new search string\n"))
4409 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4410 (org-agenda-mark-header-line (point-min))
4411 (when rtnall
4412 (insert (org-finalize-agenda-entries rtnall) "\n"))
4413 (goto-char (point-min))
4414 (or org-agenda-multi (org-fit-agenda-window))
4415 (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
4416 (org-finalize-agenda)
4417 (setq buffer-read-only t)))
4419 ;;; Agenda Finding stuck projects
4421 (defvar org-agenda-skip-regexp nil
4422 "Regular expression used in skipping subtrees for the agenda.
4423 This is basically a temporary global variable that can be set and then
4424 used by user-defined selections using `org-agenda-skip-function'.")
4426 (defvar org-agenda-overriding-header nil
4427 "When set during agenda, todo and tags searches it replaces the header.
4428 This variable should not be set directly, but custom commands can bind it
4429 in the options section.")
4431 (defun org-agenda-skip-entry-when-regexp-matches ()
4432 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4433 If yes, it returns the end position of this entry, causing agenda commands
4434 to skip the entry but continuing the search in the subtree. This is a
4435 function that can be put into `org-agenda-skip-function' for the duration
4436 of a command."
4437 (let ((end (save-excursion (org-end-of-subtree t)))
4438 skip)
4439 (save-excursion
4440 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4441 (and skip end)))
4443 (defun org-agenda-skip-subtree-when-regexp-matches ()
4444 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4445 If yes, it returns the end position of this tree, causing agenda commands
4446 to skip this subtree. This is a function that can be put into
4447 `org-agenda-skip-function' for the duration of a command."
4448 (let ((end (save-excursion (org-end-of-subtree t)))
4449 skip)
4450 (save-excursion
4451 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4452 (and skip end)))
4454 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4455 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4456 If yes, it returns the end position of the current entry (NOT the tree),
4457 causing agenda commands to skip the entry but continuing the search in
4458 the subtree. This is a function that can be put into
4459 `org-agenda-skip-function' for the duration of a command. An important
4460 use of this function is for the stuck project list."
4461 (let ((end (save-excursion (org-end-of-subtree t)))
4462 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4463 skip)
4464 (save-excursion
4465 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4466 (and skip entry-end)))
4468 (defun org-agenda-skip-entry-if (&rest conditions)
4469 "Skip entry if any of CONDITIONS is true.
4470 See `org-agenda-skip-if' for details."
4471 (org-agenda-skip-if nil conditions))
4473 (defun org-agenda-skip-subtree-if (&rest conditions)
4474 "Skip entry if any of CONDITIONS is true.
4475 See `org-agenda-skip-if' for details."
4476 (org-agenda-skip-if t conditions))
4478 (defun org-agenda-skip-if (subtree conditions)
4479 "Checks current entity for CONDITIONS.
4480 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4481 the entry (i.e. the text before the next heading) is checked.
4483 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4484 from different tests. Valid conditions are:
4486 scheduled Check if there is a scheduled cookie
4487 notscheduled Check if there is no scheduled cookie
4488 deadline Check if there is a deadline
4489 notdeadline Check if there is no deadline
4490 timestamp Check if there is a timestamp (also deadline or scheduled)
4491 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4492 regexp Check if regexp matches
4493 notregexp Check if regexp does not match.
4494 todo Check if TODO keyword matches
4495 nottodo Check if TODO keyword does not match
4497 The regexp is taken from the conditions list, it must come right after
4498 the `regexp' or `notregexp' element.
4500 `todo' and `nottodo' accept as an argument a list of todo
4501 keywords, which may include \"*\" to match any todo keyword.
4503 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4505 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4507 Instead of a list, a keyword class may be given. For example:
4509 (org-agenda-skip-entry-if 'nottodo 'done)
4511 would skip entries that haven't been marked with any of \"DONE\"
4512 keywords. Possible classes are: `todo', `done', `any'.
4514 If any of these conditions is met, this function returns the end point of
4515 the entity, causing the search to continue from there. This is a function
4516 that can be put into `org-agenda-skip-function' for the duration of a command."
4517 (let (beg end m)
4518 (org-back-to-heading t)
4519 (setq beg (point)
4520 end (if subtree
4521 (progn (org-end-of-subtree t) (point))
4522 (progn (outline-next-heading) (1- (point)))))
4523 (goto-char beg)
4524 (and
4526 (and (memq 'scheduled conditions)
4527 (re-search-forward org-scheduled-time-regexp end t))
4528 (and (memq 'notscheduled conditions)
4529 (not (re-search-forward org-scheduled-time-regexp end t)))
4530 (and (memq 'deadline conditions)
4531 (re-search-forward org-deadline-time-regexp end t))
4532 (and (memq 'notdeadline conditions)
4533 (not (re-search-forward org-deadline-time-regexp end t)))
4534 (and (memq 'timestamp conditions)
4535 (re-search-forward org-ts-regexp end t))
4536 (and (memq 'nottimestamp conditions)
4537 (not (re-search-forward org-ts-regexp end t)))
4538 (and (setq m (memq 'regexp conditions))
4539 (stringp (nth 1 m))
4540 (re-search-forward (nth 1 m) end t))
4541 (and (setq m (memq 'notregexp conditions))
4542 (stringp (nth 1 m))
4543 (not (re-search-forward (nth 1 m) end t)))
4544 (and (or
4545 (setq m (memq 'nottodo conditions))
4546 (setq m (memq 'todo-unblocked conditions))
4547 (setq m (memq 'nottodo-unblocked conditions))
4548 (setq m (memq 'todo conditions)))
4549 (org-agenda-skip-if-todo m end)))
4550 end)))
4552 (defun org-agenda-skip-if-todo (args end)
4553 "Helper function for `org-agenda-skip-if', do not use it directly.
4554 ARGS is a list with first element either `todo', `nottodo',
4555 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4556 a list of TODO keywords, or a state symbol `todo' or `done' or
4557 `any'."
4558 (let ((kw (car args))
4559 (arg (cadr args))
4560 todo-wds todo-re)
4561 (setq todo-wds
4562 (org-uniquify
4563 (cond
4564 ((listp arg) ;; list of keywords
4565 (if (member "*" arg)
4566 (mapcar 'substring-no-properties org-todo-keywords-1)
4567 arg))
4568 ((symbolp arg) ;; keyword class name
4569 (cond
4570 ((eq arg 'todo)
4571 (org-delete-all org-done-keywords
4572 (mapcar 'substring-no-properties
4573 org-todo-keywords-1)))
4574 ((eq arg 'done) org-done-keywords)
4575 ((eq arg 'any)
4576 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4577 (setq todo-re
4578 (concat "^\\*+[ \t]+\\<\\("
4579 (mapconcat 'identity todo-wds "\\|")
4580 "\\)\\>"))
4581 (cond
4582 ((eq kw 'todo) (re-search-forward todo-re end t))
4583 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
4584 ((eq kw 'todo-unblocked)
4585 (catch 'unblocked
4586 (while (re-search-forward todo-re end t)
4587 (or (org-entry-blocked-p) (throw 'unblocked t)))
4588 nil))
4589 ((eq kw 'nottodo-unblocked)
4590 (catch 'unblocked
4591 (while (re-search-forward todo-re end t)
4592 (or (org-entry-blocked-p) (throw 'unblocked nil)))
4596 ;;;###autoload
4597 (defun org-agenda-list-stuck-projects (&rest ignore)
4598 "Create agenda view for projects that are stuck.
4599 Stuck projects are project that have no next actions. For the definitions
4600 of what a project is and how to check if it stuck, customize the variable
4601 `org-stuck-projects'."
4602 (interactive)
4603 (let* ((org-agenda-skip-function
4604 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4605 ;; We could have used org-agenda-skip-if here.
4606 (org-agenda-overriding-header
4607 (or org-agenda-overriding-header "List of stuck projects: "))
4608 (matcher (nth 0 org-stuck-projects))
4609 (todo (nth 1 org-stuck-projects))
4610 (todo-wds (if (member "*" todo)
4611 (progn
4612 (org-prepare-agenda-buffers (org-agenda-files
4613 nil 'ifmode))
4614 (org-delete-all
4615 org-done-keywords-for-agenda
4616 (copy-sequence org-todo-keywords-for-agenda)))
4617 todo))
4618 (todo-re (concat "^\\*+[ \t]+\\("
4619 (mapconcat 'identity todo-wds "\\|")
4620 "\\)\\>"))
4621 (tags (nth 2 org-stuck-projects))
4622 (tags-re (if (member "*" tags)
4623 (concat org-outline-regexp-bol
4624 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4625 (if tags
4626 (concat org-outline-regexp-bol
4627 ".*:\\("
4628 (mapconcat 'identity tags "\\|")
4629 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4630 (gen-re (nth 3 org-stuck-projects))
4631 (re-list
4632 (delq nil
4633 (list
4634 (if todo todo-re)
4635 (if tags tags-re)
4636 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4637 gen-re)))))
4638 (setq org-agenda-skip-regexp
4639 (if re-list
4640 (mapconcat 'identity re-list "\\|")
4641 (error "No information how to identify unstuck projects")))
4642 (org-tags-view nil matcher)
4643 (with-current-buffer org-agenda-buffer-name
4644 (setq org-agenda-redo-command
4645 '(org-agenda-list-stuck-projects
4646 (or current-prefix-arg org-last-arg))))))
4648 ;;; Diary integration
4650 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4651 (defvar diary-list-entries-hook)
4652 (defvar diary-time-regexp)
4653 (defun org-get-entries-from-diary (date)
4654 "Get the (Emacs Calendar) diary entries for DATE."
4655 (require 'diary-lib)
4656 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4657 (diary-display-hook '(fancy-diary-display))
4658 (diary-display-function 'fancy-diary-display)
4659 (pop-up-frames nil)
4660 (diary-list-entries-hook
4661 (cons 'org-diary-default-entry diary-list-entries-hook))
4662 (diary-file-name-prefix-function nil) ; turn this feature off
4663 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4664 entries
4665 (org-disable-agenda-to-diary t))
4666 (save-excursion
4667 (save-window-excursion
4668 (funcall (if (fboundp 'diary-list-entries)
4669 'diary-list-entries 'list-diary-entries)
4670 date 1)))
4671 (if (not (get-buffer diary-fancy-buffer))
4672 (setq entries nil)
4673 (with-current-buffer diary-fancy-buffer
4674 (setq buffer-read-only nil)
4675 (if (zerop (buffer-size))
4676 ;; No entries
4677 (setq entries nil)
4678 ;; Omit the date and other unnecessary stuff
4679 (org-agenda-cleanup-fancy-diary)
4680 ;; Add prefix to each line and extend the text properties
4681 (if (zerop (buffer-size))
4682 (setq entries nil)
4683 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4684 (setq entries
4685 (with-temp-buffer
4686 (insert entries) (goto-char (point-min))
4687 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4688 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4689 (replace-match (concat "; " (match-string 1)))))
4690 (buffer-string)))))
4691 (set-buffer-modified-p nil)
4692 (kill-buffer diary-fancy-buffer)))
4693 (when entries
4694 (setq entries (org-split-string entries "\n"))
4695 (setq entries
4696 (mapcar
4697 (lambda (x)
4698 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4699 ;; Extend the text properties to the beginning of the line
4700 (org-add-props x (text-properties-at (1- (length x)) x)
4701 'type "diary" 'date date 'face 'org-agenda-diary))
4702 entries)))))
4704 (defvar org-agenda-cleanup-fancy-diary-hook nil
4705 "Hook run when the fancy diary buffer is cleaned up.")
4707 (defun org-agenda-cleanup-fancy-diary ()
4708 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4709 This gets rid of the date, the underline under the date, and
4710 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4711 date. It also removes lines that contain only whitespace."
4712 (goto-char (point-min))
4713 (if (looking-at ".*?:[ \t]*")
4714 (progn
4715 (replace-match "")
4716 (re-search-forward "\n=+$" nil t)
4717 (replace-match "")
4718 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4719 (re-search-forward "\n=+$" nil t)
4720 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4721 (goto-char (point-min))
4722 (while (re-search-forward "^ +\n" nil t)
4723 (replace-match ""))
4724 (goto-char (point-min))
4725 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4726 (replace-match ""))
4727 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4729 ;; Make sure entries from the diary have the right text properties.
4730 (eval-after-load "diary-lib"
4731 '(if (boundp 'diary-modify-entry-list-string-function)
4732 ;; We can rely on the hook, nothing to do
4734 ;; Hook not available, must use advice to make this work
4735 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4736 "Make the position visible."
4737 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4738 (stringp string)
4739 buffer-file-name)
4740 (setq string (org-modify-diary-entry-string string))))))
4742 (defun org-modify-diary-entry-string (string)
4743 "Add text properties to string, allowing org-mode to act on it."
4744 (org-add-props string nil
4745 'mouse-face 'highlight
4746 'help-echo (if buffer-file-name
4747 (format "mouse-2 or RET jump to diary file %s"
4748 (abbreviate-file-name buffer-file-name))
4750 'org-agenda-diary-link t
4751 'org-marker (org-agenda-new-marker (point-at-bol))))
4753 (defun org-diary-default-entry ()
4754 "Add a dummy entry to the diary.
4755 Needed to avoid empty dates which mess up holiday display."
4756 ;; Catch the error if dealing with the new add-to-diary-alist
4757 (when org-disable-agenda-to-diary
4758 (condition-case nil
4759 (org-add-to-diary-list original-date "Org-mode dummy" "")
4760 (error
4761 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4763 (defun org-add-to-diary-list (&rest args)
4764 (if (fboundp 'diary-add-to-list)
4765 (apply 'diary-add-to-list args)
4766 (apply 'add-to-diary-list args)))
4768 (defvar org-diary-last-run-time nil)
4770 ;;;###autoload
4771 (defun org-diary (&rest args)
4772 "Return diary information from org files.
4773 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4774 It accesses org files and extracts information from those files to be
4775 listed in the diary. The function accepts arguments specifying what
4776 items should be listed. For a list of arguments allowed here, see the
4777 variable `org-agenda-entry-types'.
4779 The call in the diary file should look like this:
4781 &%%(org-diary) ~/path/to/some/orgfile.org
4783 Use a separate line for each org file to check. Or, if you omit the file name,
4784 all files listed in `org-agenda-files' will be checked automatically:
4786 &%%(org-diary)
4788 If you don't give any arguments (as in the example above), the default
4789 arguments (:deadline :scheduled :timestamp :sexp) are used.
4790 So the example above may also be written as
4792 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4794 The function expects the lisp variables `entry' and `date' to be provided
4795 by the caller, because this is how the calendar works. Don't use this
4796 function from a program - use `org-agenda-get-day-entries' instead."
4797 (when (> (- (org-float-time)
4798 org-agenda-last-marker-time)
4800 ;; I am not sure if this works with sticky agendas, because the marker
4801 ;; list is then no longer a global variable.
4802 (org-agenda-reset-markers))
4803 ;; Prevent `org-compile-prefix-format' to fail when there is no agenda
4804 (when (buffer-live-p org-agenda-buffer)
4805 (org-compile-prefix-format 'agenda))
4806 (org-set-sorting-strategy 'agenda)
4807 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4808 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4809 (list entry)
4810 (org-agenda-files t)))
4811 (time (org-float-time))
4812 file rtn results)
4813 (when (or (not org-diary-last-run-time)
4814 (> (- time
4815 org-diary-last-run-time)
4817 (org-prepare-agenda-buffers files))
4818 (setq org-diary-last-run-time time)
4819 ;; If this is called during org-agenda, don't return any entries to
4820 ;; the calendar. Org Agenda will list these entries itself.
4821 (if org-disable-agenda-to-diary (setq files nil))
4822 (while (setq file (pop files))
4823 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4824 (setq results (append results rtn)))
4825 (if results
4826 (concat (org-finalize-agenda-entries results) "\n"))))
4828 ;;; Agenda entry finders
4830 (defun org-agenda-get-day-entries (file date &rest args)
4831 "Does the work for `org-diary' and `org-agenda'.
4832 FILE is the path to a file to be checked for entries. DATE is date like
4833 the one returned by `calendar-current-date'. ARGS are symbols indicating
4834 which kind of entries should be extracted. For details about these, see
4835 the documentation of `org-diary'."
4836 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4837 (let* ((org-startup-folded nil)
4838 (org-startup-align-all-tables nil)
4839 (buffer (if (file-exists-p file)
4840 (org-get-agenda-file-buffer file)
4841 (error "No such file %s" file)))
4842 arg results rtn deadline-results)
4843 (if (not buffer)
4844 ;; If file does not exist, make sure an error message ends up in diary
4845 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4846 (with-current-buffer buffer
4847 (unless (derived-mode-p 'org-mode)
4848 (error "Agenda file %s is not in `org-mode'" file))
4849 (let ((case-fold-search nil))
4850 (save-excursion
4851 (save-restriction
4852 (if org-agenda-restrict
4853 (narrow-to-region org-agenda-restrict-begin
4854 org-agenda-restrict-end)
4855 (widen))
4856 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4857 (while (setq arg (pop args))
4858 (cond
4859 ((and (eq arg :todo)
4860 (equal date (calendar-gregorian-from-absolute
4861 (org-today))))
4862 (setq rtn (org-agenda-get-todos))
4863 (setq results (append results rtn)))
4864 ((eq arg :timestamp)
4865 (setq rtn (org-agenda-get-blocks))
4866 (setq results (append results rtn))
4867 (setq rtn (org-agenda-get-timestamps deadline-results))
4868 (setq results (append results rtn)))
4869 ((eq arg :sexp)
4870 (setq rtn (org-agenda-get-sexps))
4871 (setq results (append results rtn)))
4872 ((eq arg :scheduled)
4873 (setq rtn (org-agenda-get-scheduled deadline-results))
4874 (setq results (append results rtn)))
4875 ((eq arg :closed)
4876 (setq rtn (org-agenda-get-progress))
4877 (setq results (append results rtn)))
4878 ((eq arg :deadline)
4879 (setq rtn (org-agenda-get-deadlines))
4880 (setq deadline-results (copy-sequence rtn))
4881 (setq results (append results rtn))))))))
4882 results))))
4884 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4885 (defun org-agenda-get-todos ()
4886 "Return the TODO information for agenda display."
4887 (let* ((props (list 'face nil
4888 'done-face 'org-agenda-done
4889 'org-not-done-regexp org-not-done-regexp
4890 'org-todo-regexp org-todo-regexp
4891 'org-complex-heading-regexp org-complex-heading-regexp
4892 'mouse-face 'highlight
4893 'help-echo
4894 (format "mouse-2 or RET jump to org file %s"
4895 (abbreviate-file-name buffer-file-name))))
4896 (regexp (format org-heading-keyword-regexp-format
4897 (cond
4898 ((and org-select-this-todo-keyword
4899 (equal org-select-this-todo-keyword "*"))
4900 org-todo-regexp)
4901 (org-select-this-todo-keyword
4902 (concat "\\("
4903 (mapconcat 'identity
4904 (org-split-string
4905 org-select-this-todo-keyword
4906 "|")
4907 "\\|") "\\)"))
4908 (t org-not-done-regexp))))
4909 marker priority category category-pos tags todo-state
4910 ee txt beg end)
4911 (goto-char (point-min))
4912 (while (re-search-forward regexp nil t)
4913 (catch :skip
4914 (save-match-data
4915 (beginning-of-line)
4916 (org-agenda-skip)
4917 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4918 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
4919 (goto-char (1+ beg))
4920 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
4921 (throw :skip nil)))
4922 (goto-char (match-beginning 2))
4923 (setq marker (org-agenda-new-marker (match-beginning 0))
4924 category (org-get-category)
4925 category-pos (get-text-property (point) 'org-category-position)
4926 txt (org-trim
4927 (buffer-substring (match-beginning 2) (match-end 0)))
4928 tags (org-get-tags-at (point))
4929 txt (org-agenda-format-item "" txt category tags)
4930 priority (1+ (org-get-priority txt))
4931 todo-state (org-get-todo-state))
4932 (org-add-props txt props
4933 'org-marker marker 'org-hd-marker marker
4934 'priority priority 'org-category category
4935 'org-category-position category-pos
4936 'type "todo" 'todo-state todo-state)
4937 (push txt ee)
4938 (if org-agenda-todo-list-sublevels
4939 (goto-char (match-end 2))
4940 (org-end-of-subtree 'invisible))))
4941 (nreverse ee)))
4943 (defun org-agenda-todo-custom-ignore-p (time n)
4944 "Check whether timestamp is farther away then n number of days.
4945 This function is invoked if `org-agenda-todo-ignore-deadlines',
4946 `org-agenda-todo-ignore-scheduled' or
4947 `org-agenda-todo-ignore-timestamp' is set to an integer."
4948 (let ((days (org-days-to-time time)))
4949 (if (>= n 0)
4950 (>= days n)
4951 (<= days n))))
4953 ;;;###autoload
4954 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4955 (&optional end)
4956 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
4957 (when (or org-agenda-todo-ignore-with-date
4958 org-agenda-todo-ignore-scheduled
4959 org-agenda-todo-ignore-deadlines
4960 org-agenda-todo-ignore-timestamp)
4961 (setq end (or end (save-excursion (outline-next-heading) (point))))
4962 (save-excursion
4963 (or (and org-agenda-todo-ignore-with-date
4964 (re-search-forward org-ts-regexp end t))
4965 (and org-agenda-todo-ignore-scheduled
4966 (re-search-forward org-scheduled-time-regexp end t)
4967 (cond
4968 ((eq org-agenda-todo-ignore-scheduled 'future)
4969 (> (org-days-to-time (match-string 1)) 0))
4970 ((eq org-agenda-todo-ignore-scheduled 'past)
4971 (<= (org-days-to-time (match-string 1)) 0))
4972 ((numberp org-agenda-todo-ignore-scheduled)
4973 (org-agenda-todo-custom-ignore-p
4974 (match-string 1) org-agenda-todo-ignore-scheduled))
4975 (t)))
4976 (and org-agenda-todo-ignore-deadlines
4977 (re-search-forward org-deadline-time-regexp end t)
4978 (cond
4979 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
4980 ((eq org-agenda-todo-ignore-deadlines 'far)
4981 (not (org-deadline-close (match-string 1))))
4982 ((eq org-agenda-todo-ignore-deadlines 'future)
4983 (> (org-days-to-time (match-string 1)) 0))
4984 ((eq org-agenda-todo-ignore-deadlines 'past)
4985 (<= (org-days-to-time (match-string 1)) 0))
4986 ((numberp org-agenda-todo-ignore-deadlines)
4987 (org-agenda-todo-custom-ignore-p
4988 (match-string 1) org-agenda-todo-ignore-deadlines))
4989 (t (org-deadline-close (match-string 1)))))
4990 (and org-agenda-todo-ignore-timestamp
4991 (let ((buffer (current-buffer))
4992 (regexp
4993 (concat
4994 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
4995 (start (point)))
4996 ;; Copy current buffer into a temporary one
4997 (with-temp-buffer
4998 (insert-buffer-substring buffer start end)
4999 (goto-char (point-min))
5000 ;; Delete SCHEDULED and DEADLINE items
5001 (while (re-search-forward regexp end t)
5002 (delete-region (match-beginning 0) (match-end 0)))
5003 (goto-char (point-min))
5004 ;; No search for timestamp left
5005 (when (re-search-forward org-ts-regexp nil t)
5006 (cond
5007 ((eq org-agenda-todo-ignore-timestamp 'future)
5008 (> (org-days-to-time (match-string 1)) 0))
5009 ((eq org-agenda-todo-ignore-timestamp 'past)
5010 (<= (org-days-to-time (match-string 1)) 0))
5011 ((numberp org-agenda-todo-ignore-timestamp)
5012 (org-agenda-todo-custom-ignore-p
5013 (match-string 1) org-agenda-todo-ignore-timestamp))
5014 (t))))))))))
5016 (defconst org-agenda-no-heading-message
5017 "No heading for this item in buffer or region.")
5019 (defun org-agenda-get-timestamps (&optional deadline-results)
5020 "Return the date stamp information for agenda display."
5021 (let* ((props (list 'face 'org-agenda-calendar-event
5022 'org-not-done-regexp org-not-done-regexp
5023 'org-todo-regexp org-todo-regexp
5024 'org-complex-heading-regexp org-complex-heading-regexp
5025 'mouse-face 'highlight
5026 'help-echo
5027 (format "mouse-2 or RET jump to org file %s"
5028 (abbreviate-file-name buffer-file-name))))
5029 (d1 (calendar-absolute-from-gregorian date))
5031 (deadline-position-alist
5032 (mapcar (lambda (a) (and (setq mm (get-text-property
5033 0 'org-hd-marker a))
5034 (cons (marker-position mm) a)))
5035 deadline-results))
5036 (remove-re org-ts-regexp)
5037 (regexp
5038 (concat
5039 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5040 (regexp-quote
5041 (substring
5042 (format-time-string
5043 (car org-time-stamp-formats)
5044 (apply 'encode-time ; DATE bound by calendar
5045 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5046 1 11))
5047 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5048 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5049 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5050 donep tmp priority category category-pos ee txt timestr tags
5051 b0 b3 e3 head todo-state end-of-match show-all warntime)
5052 (goto-char (point-min))
5053 (while (setq end-of-match (re-search-forward regexp nil t))
5054 (setq b0 (match-beginning 0)
5055 b3 (match-beginning 3) e3 (match-end 3)
5056 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5057 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5058 (member todo-state
5059 org-agenda-repeating-timestamp-show-all)))
5060 (catch :skip
5061 (and (org-at-date-range-p) (throw :skip nil))
5062 (org-agenda-skip)
5063 (if (and (match-end 1)
5064 (not (= d1 (org-time-string-to-absolute
5065 (match-string 1) d1 nil show-all
5066 (current-buffer) b0))))
5067 (throw :skip nil))
5068 (if (and e3
5069 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5070 (throw :skip nil))
5071 (setq tmp (buffer-substring (max (point-min)
5072 (- b0 org-ds-keyword-length))
5074 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5075 inactivep (= (char-after b0) ?\[)
5076 deadlinep (string-match org-deadline-regexp tmp)
5077 scheduledp (string-match org-scheduled-regexp tmp)
5078 closedp (and org-agenda-include-inactive-timestamps
5079 (string-match org-closed-string tmp))
5080 clockp (and org-agenda-include-inactive-timestamps
5081 (or (string-match org-clock-string tmp)
5082 (string-match "]-+\\'" tmp)))
5083 warntime (org-entry-get (point) "APPT_WARNTIME")
5084 donep (member todo-state org-done-keywords))
5085 (if (or scheduledp deadlinep closedp clockp
5086 (and donep org-agenda-skip-timestamp-if-done))
5087 (throw :skip t))
5088 (if (string-match ">" timestr)
5089 ;; substring should only run to end of time stamp
5090 (setq timestr (substring timestr 0 (match-end 0))))
5091 (setq marker (org-agenda-new-marker b0)
5092 category (org-get-category b0)
5093 category-pos (get-text-property b0 'org-category-position))
5094 (save-excursion
5095 (if (not (re-search-backward org-outline-regexp-bol nil t))
5096 (setq txt org-agenda-no-heading-message)
5097 (goto-char (match-beginning 0))
5098 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5099 (assoc (point) deadline-position-alist))
5100 (throw :skip nil))
5101 (setq hdmarker (org-agenda-new-marker)
5102 tags (org-get-tags-at))
5103 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5104 (setq head (or (match-string 1) ""))
5105 (setq txt (org-agenda-format-item
5106 (if inactivep org-agenda-inactive-leader nil)
5107 head category tags timestr
5108 remove-re)))
5109 (setq priority (org-get-priority txt))
5110 (org-add-props txt props
5111 'org-marker marker 'org-hd-marker hdmarker)
5112 (org-add-props txt nil 'priority priority
5113 'org-category category 'date date
5114 'org-category-position category-pos
5115 'todo-state todo-state
5116 'warntime warntime
5117 'type "timestamp")
5118 (push txt ee))
5119 (if org-agenda-skip-additional-timestamps-same-entry
5120 (outline-next-heading)
5121 (goto-char end-of-match))))
5122 (nreverse ee)))
5124 (defun org-agenda-get-sexps ()
5125 "Return the sexp information for agenda display."
5126 (require 'diary-lib)
5127 (let* ((props (list 'face 'org-agenda-calendar-sexp
5128 'mouse-face 'highlight
5129 'help-echo
5130 (format "mouse-2 or RET jump to org file %s"
5131 (abbreviate-file-name buffer-file-name))))
5132 (regexp "^&?%%(")
5133 marker category extra category-pos ee txt tags entry
5134 result beg b sexp sexp-entry todo-state warntime)
5135 (goto-char (point-min))
5136 (while (re-search-forward regexp nil t)
5137 (catch :skip
5138 (org-agenda-skip)
5139 (setq beg (match-beginning 0))
5140 (goto-char (1- (match-end 0)))
5141 (setq b (point))
5142 (forward-sexp 1)
5143 (setq sexp (buffer-substring b (point)))
5144 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5145 (org-trim (match-string 1))
5146 ""))
5147 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5148 (when result
5149 (setq marker (org-agenda-new-marker beg)
5150 category (org-get-category beg)
5151 category-pos (get-text-property beg 'org-category-position)
5152 tags (save-excursion (org-backward-heading-same-level 0)
5153 (org-get-tags-at))
5154 todo-state (org-get-todo-state)
5155 warntime (org-entry-get (point) "APPT_WARNTIME"))
5157 (dolist (r (if (stringp result)
5158 (list result)
5159 result)) ;; we expect a list here
5160 (when (and org-agenda-diary-sexp-prefix
5161 (string-match org-agenda-diary-sexp-prefix r))
5162 (setq extra (match-string 0 r)
5163 r (replace-match "" nil nil r)))
5164 (if (string-match "\\S-" r)
5165 (setq txt r)
5166 (setq txt "SEXP entry returned empty string"))
5168 (setq txt (org-agenda-format-item
5169 extra txt category tags 'time))
5170 (org-add-props txt props 'org-marker marker)
5171 (org-add-props txt nil
5172 'org-category category 'date date 'todo-state todo-state
5173 'org-category-position category-pos 'tags tags
5174 'type "sexp" 'warntime warntime)
5175 (push txt ee)))))
5176 (nreverse ee)))
5178 ;; Calendar sanity: define some functions that are independent of
5179 ;; `calendar-date-style'.
5180 ;; Normally I would like to use ISO format when calling the diary functions,
5181 ;; but to make sure we still have Emacs 22 compatibility we bind
5182 ;; also `european-calendar-style' and use european format
5183 (defun org-anniversary (year month day &optional mark)
5184 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5185 (org-no-warnings
5186 (let ((calendar-date-style 'european) (european-calendar-style t))
5187 (diary-anniversary day month year mark))))
5188 (defun org-cyclic (N year month day &optional mark)
5189 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5190 (org-no-warnings
5191 (let ((calendar-date-style 'european) (european-calendar-style t))
5192 (diary-cyclic N day month year mark))))
5193 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5194 "Like `diary-block', but with fixed (ISO) order of arguments."
5195 (org-no-warnings
5196 (let ((calendar-date-style 'european) (european-calendar-style t))
5197 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5198 (defun org-date (year month day &optional mark)
5199 "Like `diary-date', but with fixed (ISO) order of arguments."
5200 (org-no-warnings
5201 (let ((calendar-date-style 'european) (european-calendar-style t))
5202 (diary-date day month year mark))))
5203 (defalias 'org-float 'diary-float)
5205 ;; Define the` org-class' function
5206 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5207 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5208 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5209 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5210 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5211 `holidays', then any date that is known by the Emacs calendar to be a
5212 holiday will also be skipped."
5213 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5214 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5215 (d (calendar-absolute-from-gregorian date)))
5216 (and
5217 (<= date1 d)
5218 (<= d date2)
5219 (= (calendar-day-of-week date) dayname)
5220 (or (not skip-weeks)
5221 (progn
5222 (require 'cal-iso)
5223 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5224 (not (and (memq 'holidays skip-weeks)
5225 (calendar-check-holidays date)))
5226 entry)))
5228 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5229 "Like `org-class', but honor `calendar-date-style'.
5230 The order of the first 2 times 3 arguments depends on the variable
5231 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5232 So for American calendars, give this as MONTH DAY YEAR, for European as
5233 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5234 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5235 is any number of ISO weeks in the block period for which the item should
5236 be skipped.
5238 This function is here only for backward compatibility and it is deprecated,
5239 please use `org-class' instead."
5240 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5241 (date2 (org-order-calendar-date-args m2 d2 y2)))
5242 (org-class
5243 (nth 2 date1) (car date1) (nth 1 date1)
5244 (nth 2 date2) (car date2) (nth 1 date2)
5245 dayname skip-weeks)))
5246 (make-obsolete 'org-diary-class 'org-class "")
5248 (defvar org-agenda-show-log-scoped) ;; dynamically scope in ̀org-timeline' or`org-agenda-list'
5249 (defalias 'org-get-closed 'org-agenda-get-progress)
5250 (defun org-agenda-get-progress ()
5251 "Return the logged TODO entries for agenda display."
5252 (let* ((props (list 'mouse-face 'highlight
5253 'org-not-done-regexp org-not-done-regexp
5254 'org-todo-regexp org-todo-regexp
5255 'org-complex-heading-regexp org-complex-heading-regexp
5256 'help-echo
5257 (format "mouse-2 or RET jump to org file %s"
5258 (abbreviate-file-name buffer-file-name))))
5259 (items (if (consp org-agenda-show-log-scoped)
5260 org-agenda-show-log-scoped
5261 (if (eq org-agenda-show-log-scoped 'clockcheck)
5262 '(clock)
5263 org-agenda-log-mode-items)))
5264 (parts
5265 (delq nil
5266 (list
5267 (if (memq 'closed items) (concat "\\<" org-closed-string))
5268 (if (memq 'clock items) (concat "\\<" org-clock-string))
5269 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5270 (parts-re (if parts (mapconcat 'identity parts "\\|")
5271 (error "`org-agenda-log-mode-items' is empty")))
5272 (regexp (concat
5273 "\\(" parts-re "\\)"
5274 " *\\["
5275 (regexp-quote
5276 (substring
5277 (format-time-string
5278 (car org-time-stamp-formats)
5279 (apply 'encode-time ; DATE bound by calendar
5280 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5281 1 11))))
5282 (org-agenda-search-headline-for-time nil)
5283 marker hdmarker priority category category-pos tags closedp
5284 statep clockp state ee txt extra timestr rest clocked)
5285 (goto-char (point-min))
5286 (while (re-search-forward regexp nil t)
5287 (catch :skip
5288 (org-agenda-skip)
5289 (setq marker (org-agenda-new-marker (match-beginning 0))
5290 closedp (equal (match-string 1) org-closed-string)
5291 statep (equal (string-to-char (match-string 1)) ?-)
5292 clockp (not (or closedp statep))
5293 state (and statep (match-string 2))
5294 category (org-get-category (match-beginning 0))
5295 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5296 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5297 (when (string-match "\\]" timestr)
5298 ;; substring should only run to end of time stamp
5299 (setq rest (substring timestr (match-end 0))
5300 timestr (substring timestr 0 (match-end 0)))
5301 (if (and (not closedp) (not statep)
5302 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5303 rest))
5304 (progn (setq timestr (concat (substring timestr 0 -1)
5305 "-" (match-string 1 rest) "]"))
5306 (setq clocked (match-string 2 rest)))
5307 (setq clocked "-")))
5308 (save-excursion
5309 (setq extra
5310 (cond
5311 ((not org-agenda-log-mode-add-notes) nil)
5312 (statep
5313 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5314 (match-string 1)))
5315 (clockp
5316 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5317 (match-string 1)))))
5318 (if (not (re-search-backward org-outline-regexp-bol nil t))
5319 (setq txt org-agenda-no-heading-message)
5320 (goto-char (match-beginning 0))
5321 (setq hdmarker (org-agenda-new-marker)
5322 tags (org-get-tags-at))
5323 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5324 (setq txt (match-string 1))
5325 (when extra
5326 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5327 (setq txt (concat (substring txt 0 (match-beginning 1))
5328 " - " extra " " (match-string 2 txt)))
5329 (setq txt (concat txt " - " extra))))
5330 (setq txt (org-agenda-format-item
5331 (cond
5332 (closedp "Closed: ")
5333 (statep (concat "State: (" state ")"))
5334 (t (concat "Clocked: (" clocked ")")))
5335 txt category tags timestr)))
5336 (setq priority 100000)
5337 (org-add-props txt props
5338 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5339 'priority priority 'org-category category
5340 'org-category-position category-pos
5341 'type "closed" 'date date
5342 'undone-face 'org-warning 'done-face 'org-agenda-done)
5343 (push txt ee))
5344 (goto-char (point-at-eol))))
5345 (nreverse ee)))
5347 (defun org-agenda-show-clocking-issues ()
5348 "Add overlays, showing issues with clocking.
5349 See also the user option `org-agenda-clock-consistency-checks'."
5350 (interactive)
5351 (let* ((pl org-agenda-clock-consistency-checks)
5352 (re (concat "^[ \t]*"
5353 org-clock-string
5354 "[ \t]+"
5355 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5356 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5357 (tlstart 0.)
5358 (tlend 0.)
5359 (maxtime (org-hh:mm-string-to-minutes
5360 (or (plist-get pl :max-duration) "24:00")))
5361 (mintime (org-hh:mm-string-to-minutes
5362 (or (plist-get pl :min-duration) 0)))
5363 (maxgap (org-hh:mm-string-to-minutes
5364 ;; default 30:00 means never complain
5365 (or (plist-get pl :max-gap) "30:00")))
5366 (gapok (mapcar 'org-hh:mm-string-to-minutes
5367 (plist-get pl :gap-ok-around)))
5368 (def-face (or (plist-get pl :default-face)
5369 '((:background "DarkRed") (:foreground "white"))))
5370 issue face m te ts dt ov)
5371 (goto-char (point-min))
5372 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5373 (setq issue nil face def-face)
5374 (catch 'next
5375 (setq m (org-get-at-bol 'org-marker)
5376 te nil ts nil)
5377 (unless (and m (markerp m))
5378 (setq issue "No valid clock line") (throw 'next t))
5379 (org-with-point-at m
5380 (save-excursion
5381 (goto-char (point-at-bol))
5382 (unless (looking-at re)
5383 (error "No valid Clock line")
5384 (throw 'next t))
5385 (unless (match-end 3)
5386 (setq issue "No end time"
5387 face (or (plist-get pl :no-end-time-face) face))
5388 (throw 'next t))
5389 (setq ts (match-string 1)
5390 te (match-string 3)
5391 ts (org-float-time
5392 (apply 'encode-time (org-parse-time-string ts)))
5393 te (org-float-time
5394 (apply 'encode-time (org-parse-time-string te)))
5395 dt (- te ts))))
5396 (cond
5397 ((> dt (* 60 maxtime))
5398 ;; a very long clocking chunk
5399 (setq issue (format "Clocking interval is very long: %s"
5400 (org-minutes-to-hh:mm-string
5401 (floor (/ (float dt) 60.))))
5402 face (or (plist-get pl :long-face) face)))
5403 ((< dt (* 60 mintime))
5404 ;; a very short clocking chunk
5405 (setq issue (format "Clocking interval is very short: %s"
5406 (org-minutes-to-hh:mm-string
5407 (floor (/ (float dt) 60.))))
5408 face (or (plist-get pl :short-face) face)))
5409 ((and (> tlend 0) (< ts tlend))
5410 ;; Two clock entries are overlapping
5411 (setq issue (format "Clocking overlap: %d minutes"
5412 (/ (- tlend ts) 60))
5413 face (or (plist-get pl :overlap-face) face)))
5414 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5415 ;; There is a gap, lets see if we need to report it
5416 (unless (org-agenda-check-clock-gap tlend ts gapok)
5417 (setq issue (format "Clocking gap: %d minutes"
5418 (/ (- ts tlend) 60))
5419 face (or (plist-get pl :gap-face) face))))
5420 (t nil)))
5421 (setq tlend (or te tlend) tlstart (or ts tlstart))
5422 (when issue
5423 ;; OK, there was some issue, add an overlay to show the issue
5424 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5425 (overlay-put ov 'before-string
5426 (concat
5427 (org-add-props
5428 (format "%-43s" (concat " " issue))
5430 'face face)
5431 "\n"))
5432 (overlay-put ov 'evaporate t)))))
5434 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5435 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5436 (catch 'exit
5437 (unless ok-list
5438 ;; there are no OK times for gaps...
5439 (throw 'exit nil))
5440 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5441 ;; This is more than 24 hours, so it is OK.
5442 ;; because we have at least one OK time, that must be in the
5443 ;; 24 hour interval.
5444 (throw 'exit t))
5445 ;; We have a shorter gap.
5446 ;; Now we have to get the minute of the day when these times are
5447 (let* ((t1dec (decode-time (seconds-to-time t1)))
5448 (t2dec (decode-time (seconds-to-time t2)))
5449 ;; compute the minute on the day
5450 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5451 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5452 (when (< min2 min1)
5453 ;; if min2 is smaller than min1, this means it is on the next day.
5454 ;; Wrap it to after midnight.
5455 (setq min2 (+ min2 1440)))
5456 ;; Now check if any of the OK times is in the gap
5457 (mapc (lambda (x)
5458 ;; Wrap the time to after midnight if necessary
5459 (if (< x min1) (setq x (+ x 1440)))
5460 ;; Check if in interval
5461 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5462 ok-list)
5463 ;; Nope, this gap is not OK
5464 nil)))
5466 (defun org-agenda-get-deadlines ()
5467 "Return the deadline information for agenda display."
5468 (let* ((props (list 'mouse-face 'highlight
5469 'org-not-done-regexp org-not-done-regexp
5470 'org-todo-regexp org-todo-regexp
5471 'org-complex-heading-regexp org-complex-heading-regexp
5472 'help-echo
5473 (format "mouse-2 or RET jump to org file %s"
5474 (abbreviate-file-name buffer-file-name))))
5475 (regexp org-deadline-time-regexp)
5476 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5477 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5478 d2 diff dfrac wdays pos pos1 category category-pos
5479 tags suppress-prewarning ee txt head face s todo-state
5480 show-all upcomingp donep timestr warntime)
5481 (goto-char (point-min))
5482 (while (re-search-forward regexp nil t)
5483 (setq suppress-prewarning nil)
5484 (catch :skip
5485 (org-agenda-skip)
5486 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5487 (save-match-data
5488 (string-match org-scheduled-time-regexp
5489 (buffer-substring (point-at-bol)
5490 (point-at-eol)))))
5491 (setq suppress-prewarning
5492 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5493 org-agenda-skip-deadline-prewarning-if-scheduled
5494 0)))
5495 (setq s (match-string 1)
5496 txt nil
5497 pos (1- (match-beginning 1))
5498 todo-state (save-match-data (org-get-todo-state))
5499 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5500 (member todo-state
5501 org-agenda-repeating-timestamp-show-all))
5502 d2 (org-time-string-to-absolute
5503 (match-string 1) d1 'past show-all
5504 (current-buffer) pos)
5505 diff (- d2 d1)
5506 wdays (if suppress-prewarning
5507 (let ((org-deadline-warning-days suppress-prewarning))
5508 (org-get-wdays s))
5509 (org-get-wdays s))
5510 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5511 upcomingp (and todayp (> diff 0)))
5512 ;; When to show a deadline in the calendar:
5513 ;; If the expiration is within wdays warning time.
5514 ;; Past-due deadlines are only shown on the current date
5515 (if (and (or (and (<= diff wdays)
5516 (and todayp (not org-agenda-only-exact-dates)))
5517 (= diff 0)))
5518 (save-excursion
5519 ;; (setq todo-state (org-get-todo-state))
5520 (setq donep (member todo-state org-done-keywords))
5521 (if (and donep
5522 (or org-agenda-skip-deadline-if-done
5523 (not (= diff 0))))
5524 (setq txt nil)
5525 (setq category (org-get-category)
5526 warntime (org-entry-get (point) "APPT_WARNTIME")
5527 category-pos (get-text-property (point) 'org-category-position))
5528 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5529 (setq txt org-agenda-no-heading-message)
5530 (goto-char (match-end 0))
5531 (setq pos1 (match-beginning 0))
5532 (setq tags (org-get-tags-at pos1))
5533 (setq head (buffer-substring-no-properties
5534 (point)
5535 (progn (skip-chars-forward "^\r\n")
5536 (point))))
5537 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5538 (setq timestr
5539 (concat (substring s (match-beginning 1)) " "))
5540 (setq timestr 'time))
5541 (setq txt (org-agenda-format-item
5542 (if (= diff 0)
5543 (car org-agenda-deadline-leaders)
5544 (if (functionp
5545 (nth 1 org-agenda-deadline-leaders))
5546 (funcall
5547 (nth 1 org-agenda-deadline-leaders)
5548 diff date)
5549 (format (nth 1 org-agenda-deadline-leaders)
5550 diff)))
5551 head category tags
5552 (if (not (= diff 0)) nil timestr)))))
5553 (when txt
5554 (setq face (org-agenda-deadline-face dfrac))
5555 (org-add-props txt props
5556 'org-marker (org-agenda-new-marker pos)
5557 'warntime warntime
5558 'org-hd-marker (org-agenda-new-marker pos1)
5559 'priority (+ (- diff)
5560 (org-get-priority txt))
5561 'org-category category
5562 'org-category-position category-pos
5563 'todo-state todo-state
5564 'type (if upcomingp "upcoming-deadline" "deadline")
5565 'date (if upcomingp date d2)
5566 'face (if donep 'org-agenda-done face)
5567 'undone-face face 'done-face 'org-agenda-done)
5568 (push txt ee))))))
5569 (nreverse ee)))
5571 (defun org-agenda-deadline-face (fraction)
5572 "Return the face to displaying a deadline item.
5573 FRACTION is what fraction of the head-warning time has passed."
5574 (let ((faces org-agenda-deadline-faces) f)
5575 (catch 'exit
5576 (while (setq f (pop faces))
5577 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5579 (defun org-agenda-get-scheduled (&optional deadline-results)
5580 "Return the scheduled information for agenda display."
5581 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5582 'org-todo-regexp org-todo-regexp
5583 'org-complex-heading-regexp org-complex-heading-regexp
5584 'done-face 'org-agenda-done
5585 'mouse-face 'highlight
5586 'help-echo
5587 (format "mouse-2 or RET jump to org file %s"
5588 (abbreviate-file-name buffer-file-name))))
5589 (regexp org-scheduled-time-regexp)
5590 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5591 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5593 (deadline-position-alist
5594 (mapcar (lambda (a) (and (setq mm (get-text-property
5595 0 'org-hd-marker a))
5596 (cons (marker-position mm) a)))
5597 deadline-results))
5598 d2 diff pos pos1 category category-pos tags donep
5599 ee txt head pastschedp todo-state face timestr s habitp show-all
5600 did-habit-check-p warntime)
5601 (goto-char (point-min))
5602 (while (re-search-forward regexp nil t)
5603 (catch :skip
5604 (org-agenda-skip)
5605 (setq s (match-string 1)
5606 txt nil
5607 pos (1- (match-beginning 1))
5608 todo-state (save-match-data (org-get-todo-state))
5609 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5610 (member todo-state
5611 org-agenda-repeating-timestamp-show-all))
5612 d2 (org-time-string-to-absolute
5613 (match-string 1) d1 'past show-all
5614 (current-buffer) pos)
5615 diff (- d2 d1)
5616 warntime (org-entry-get (point) "APPT_WARNTIME"))
5617 (setq pastschedp (and todayp (< diff 0)))
5618 (setq did-habit-check-p nil)
5619 ;; When to show a scheduled item in the calendar:
5620 ;; If it is on or past the date.
5621 (when (or (and (< diff 0)
5622 (< (abs diff) org-scheduled-past-days)
5623 (and todayp (not org-agenda-only-exact-dates)))
5624 (= diff 0)
5625 ;; org-is-habit-p uses org-entry-get, which is expansive
5626 ;; so we go extra mile to only call it once
5627 (and todayp
5628 org-habit-show-all-today
5629 (setq did-habit-check-p t)
5630 (setq habitp (and (functionp 'org-is-habit-p)
5631 (org-is-habit-p)))))
5632 (save-excursion
5633 (setq donep (member todo-state org-done-keywords))
5634 (if (and donep
5635 (or org-agenda-skip-scheduled-if-done
5636 (not (= diff 0))
5637 (and (functionp 'org-is-habit-p)
5638 (org-is-habit-p))))
5639 (setq txt nil)
5640 (setq habitp (if did-habit-check-p habitp
5641 (and (functionp 'org-is-habit-p)
5642 (org-is-habit-p))))
5643 (setq category (org-get-category)
5644 category-pos (get-text-property (point) 'org-category-position))
5645 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5646 (setq txt org-agenda-no-heading-message)
5647 (goto-char (match-end 0))
5648 (setq pos1 (match-beginning 0))
5649 (if habitp
5650 (if (or (not org-habit-show-habits)
5651 (and (not todayp)
5652 org-habit-show-habits-only-for-today))
5653 (throw :skip nil))
5654 (if (and
5655 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5656 (and org-agenda-skip-scheduled-if-deadline-is-shown
5657 pastschedp))
5658 (setq mm (assoc pos1 deadline-position-alist)))
5659 (throw :skip nil)))
5660 (setq tags (org-get-tags-at))
5661 (setq head (buffer-substring-no-properties
5662 (point)
5663 (progn (skip-chars-forward "^\r\n") (point))))
5664 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5665 (setq timestr
5666 (concat (substring s (match-beginning 1)) " "))
5667 (setq timestr 'time))
5668 (setq txt (org-agenda-format-item
5669 (if (= diff 0)
5670 (car org-agenda-scheduled-leaders)
5671 (format (nth 1 org-agenda-scheduled-leaders)
5672 (- 1 diff)))
5673 head category tags
5674 (if (not (= diff 0)) nil timestr)
5675 nil habitp))))
5676 (when txt
5677 (setq face
5678 (cond
5679 ((and (not habitp) pastschedp)
5680 'org-scheduled-previously)
5681 (todayp 'org-scheduled-today)
5682 (t 'org-scheduled))
5683 habitp (and habitp (org-habit-parse-todo)))
5684 (org-add-props txt props
5685 'undone-face face
5686 'face (if donep 'org-agenda-done face)
5687 'org-marker (org-agenda-new-marker pos)
5688 'org-hd-marker (org-agenda-new-marker pos1)
5689 'type (if pastschedp "past-scheduled" "scheduled")
5690 'date (if pastschedp d2 date)
5691 'warntime warntime
5692 'priority (if habitp
5693 (org-habit-get-priority habitp)
5694 (+ 94 (- 5 diff) (org-get-priority txt)))
5695 'org-category category
5696 'category-position category-pos
5697 'org-habit-p habitp
5698 'todo-state todo-state)
5699 (push txt ee))))))
5700 (nreverse ee)))
5702 (defun org-agenda-get-blocks ()
5703 "Return the date-range information for agenda display."
5704 (let* ((props (list 'face nil
5705 'org-not-done-regexp org-not-done-regexp
5706 'org-todo-regexp org-todo-regexp
5707 'org-complex-heading-regexp org-complex-heading-regexp
5708 'mouse-face 'highlight
5709 'help-echo
5710 (format "mouse-2 or RET jump to org file %s"
5711 (abbreviate-file-name buffer-file-name))))
5712 (regexp org-tr-regexp)
5713 (d0 (calendar-absolute-from-gregorian date))
5714 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
5715 todo-state tags pos head donep)
5716 (goto-char (point-min))
5717 (while (re-search-forward regexp nil t)
5718 (catch :skip
5719 (org-agenda-skip)
5720 (setq pos (point))
5721 (let ((start-time (match-string 1))
5722 (end-time (match-string 2)))
5723 (setq s1 (match-string 1)
5724 s2 (match-string 2)
5725 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5726 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5727 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5728 ;; Only allow days between the limits, because the normal
5729 ;; date stamps will catch the limits.
5730 (save-excursion
5731 (setq todo-state (org-get-todo-state))
5732 (setq donep (member todo-state org-done-keywords))
5733 (if (and donep org-agenda-skip-timestamp-if-done)
5734 (throw :skip t))
5735 (setq marker (org-agenda-new-marker (point)))
5736 (setq category (org-get-category)
5737 category-pos (get-text-property (point) 'org-category-position))
5738 (if (not (re-search-backward org-outline-regexp-bol nil t))
5739 (setq txt org-agenda-no-heading-message)
5740 (goto-char (match-beginning 0))
5741 (setq hdmarker (org-agenda-new-marker (point)))
5742 (setq tags (org-get-tags-at))
5743 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5744 (setq head (match-string 1))
5745 (let ((remove-re
5746 (if org-agenda-remove-timeranges-from-blocks
5747 (concat
5748 "<" (regexp-quote s1) ".*?>"
5749 "--"
5750 "<" (regexp-quote s2) ".*?>")
5751 nil)))
5752 (setq txt (org-agenda-format-item
5753 (format
5754 (nth (if (= d1 d2) 0 1)
5755 org-agenda-timerange-leaders)
5756 (1+ (- d0 d1)) (1+ (- d2 d1)))
5757 head category tags
5758 (cond ((and (= d1 d0) (= d2 d0))
5759 (concat "<" start-time ">--<" end-time ">"))
5760 ((= d1 d0)
5761 (concat "<" start-time ">"))
5762 ((= d2 d0)
5763 (concat "<" end-time ">")))
5764 remove-re))))
5765 (org-add-props txt props
5766 'org-marker marker 'org-hd-marker hdmarker
5767 'type "block" 'date date
5768 'todo-state todo-state
5769 'priority (org-get-priority txt) 'org-category category
5770 'org-category-position category-pos)
5771 (push txt ee))))
5772 (goto-char pos)))
5773 ;; Sort the entries by expiration date.
5774 (nreverse ee)))
5776 ;;; Agenda presentation and sorting
5778 (defvar org-prefix-has-time nil
5779 "A flag, set by `org-compile-prefix-format'.
5780 The flag is set if the currently compiled format contains a `%t'.")
5781 (defvar org-prefix-has-tag nil
5782 "A flag, set by `org-compile-prefix-format'.
5783 The flag is set if the currently compiled format contains a `%T'.")
5784 (defvar org-prefix-has-effort nil
5785 "A flag, set by `org-compile-prefix-format'.
5786 The flag is set if the currently compiled format contains a `%e'.")
5787 (defvar org-prefix-category-length nil
5788 "Used by `org-compile-prefix-format' to remember the category field width.")
5789 (defvar org-prefix-category-max-length nil
5790 "Used by `org-compile-prefix-format' to remember the category field width.")
5792 (defun org-agenda-get-category-icon (category)
5793 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5794 (dolist (entry org-agenda-category-icon-alist)
5795 (when (org-string-match-p (car entry) category)
5796 (if (listp (cadr entry))
5797 (return (cadr entry))
5798 (return (apply 'create-image (cdr entry)))))))
5800 (defun org-agenda-format-item (extra txt &optional category tags dotime
5801 remove-re habitp)
5802 "Format TXT to be inserted into the agenda buffer.
5803 In particular, it adds the prefix and corresponding text properties. EXTRA
5804 must be a string and replaces the `%s' specifier in the prefix format.
5805 CATEGORY (string, symbol or nil) may be used to overrule the default
5806 category taken from local variable or file name. It will replace the `%c'
5807 specifier in the format. DOTIME, when non-nil, indicates that a
5808 time-of-day should be extracted from TXT for sorting of this entry, and for
5809 the `%t' specifier in the format. When DOTIME is a string, this string is
5810 searched for a time before TXT is. TAGS can be the tags of the headline.
5811 Any match of REMOVE-RE will be removed from TXT."
5812 ;; We keep the org-prefix-* variable values along with a compiled
5813 ;; formatter, so that multiple agendas existing at the same time, do
5814 ;; not step on each other toes.
5816 ;; It was inconvenient to make these variables buffer local in
5817 ;; Agenda buffers, because this function expects to be called with
5818 ;; the buffer where item comes from being current, and not agenda
5819 ;; buffer
5820 (let* ((bindings (car org-prefix-format-compiled))
5821 (formatter (cadr org-prefix-format-compiled)))
5822 (loop for (var value) in bindings
5823 do (set var value))
5824 (save-match-data
5825 ;; Diary entries sometimes have extra whitespace at the beginning
5826 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5828 ;; Fix the tags part in txt
5829 (setq txt (org-agenda-fix-displayed-tags
5830 txt tags
5831 org-agenda-show-inherited-tags
5832 org-agenda-hide-tags-regexp))
5833 (let* ((category (or category
5834 (if (stringp org-category)
5835 org-category
5836 (and org-category (symbol-name org-category)))
5837 (if buffer-file-name
5838 (file-name-sans-extension
5839 (file-name-nondirectory buffer-file-name))
5840 "")))
5841 (category-icon (org-agenda-get-category-icon category))
5842 (category-icon (if category-icon
5843 (propertize " " 'display category-icon)
5844 ""))
5845 ;; time, tag, effort are needed for the eval of the prefix format
5846 (tag (if tags (nth (1- (length tags)) tags) ""))
5847 time effort neffort
5848 (ts (if dotime (concat
5849 (if (stringp dotime) dotime "")
5850 (and org-agenda-search-headline-for-time txt))))
5851 (time-of-day (and dotime (org-get-time-of-day ts)))
5852 stamp plain s0 s1 s2 rtn srp l
5853 duration thecategory)
5854 (and (derived-mode-p 'org-mode) buffer-file-name
5855 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5856 (when (and dotime time-of-day)
5857 ;; Extract starting and ending time and move them to prefix
5858 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5859 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5860 (setq s0 (match-string 0 ts)
5861 srp (and stamp (match-end 3))
5862 s1 (match-string (if plain 1 2) ts)
5863 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5865 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5866 ;; them, we might want to remove them there to avoid duplication.
5867 ;; The user can turn this off with a variable.
5868 (if (and org-prefix-has-time
5869 org-agenda-remove-times-when-in-prefix (or stamp plain)
5870 (string-match (concat (regexp-quote s0) " *") txt)
5871 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5872 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5873 (= (match-beginning 0) 0)
5875 (setq txt (replace-match "" nil nil txt))))
5876 ;; Normalize the time(s) to 24 hour
5877 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5878 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5880 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5881 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5882 (setq s2
5883 (org-minutes-to-hh:mm-string
5884 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5886 ;; Compute the duration
5887 (when s2
5888 (setq duration (- (org-hh:mm-string-to-minutes s2)
5889 (org-hh:mm-string-to-minutes s1)))))
5891 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5892 txt)
5893 ;; Tags are in the string
5894 (if (or (eq org-agenda-remove-tags t)
5895 (and org-agenda-remove-tags
5896 org-prefix-has-tag))
5897 (setq txt (replace-match "" t t txt))
5898 (setq txt (replace-match
5899 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5900 (match-string 2 txt))
5901 t t txt))))
5902 (when (derived-mode-p 'org-mode)
5903 (setq effort
5904 (condition-case nil
5905 (org-get-effort
5906 (or (get-text-property 0 'org-hd-marker txt)
5907 (get-text-property 0 'org-marker txt)))
5908 (error nil)))
5909 (when effort
5910 (setq neffort (org-duration-string-to-minutes effort)
5911 effort (setq effort (concat "[" effort "]")))))
5912 ;; prevent erroring out with %e format when there is no effort
5913 (or effort (setq effort ""))
5915 (when remove-re
5916 (while (string-match remove-re txt)
5917 (setq txt (replace-match "" t t txt))))
5919 ;; Set org-heading property on `txt' to mark the start of the
5920 ;; heading.
5921 (add-text-properties 0 (length txt) '(org-heading t) txt)
5923 ;; Prepare the variables needed in the eval of the compiled format
5924 (setq time (cond (s2 (concat
5925 (org-agenda-time-of-day-to-ampm-maybe s1)
5926 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
5927 (if org-agenda-timegrid-use-ampm " ")))
5928 (s1 (concat
5929 (org-agenda-time-of-day-to-ampm-maybe s1)
5930 (if org-agenda-timegrid-use-ampm
5931 "........ "
5932 "......")))
5933 (t ""))
5934 extra (or (and (not habitp) extra) "")
5935 category (if (symbolp category) (symbol-name category) category)
5936 thecategory (copy-sequence category))
5937 (if (string-match org-bracket-link-regexp category)
5938 (progn
5939 (setq l (if (match-end 3)
5940 (- (match-end 3) (match-beginning 3))
5941 (- (match-end 1) (match-beginning 1))))
5942 (when (< l (or org-prefix-category-length 0))
5943 (setq category (copy-sequence category))
5944 (org-add-props category nil
5945 'extra-space (make-string
5946 (- org-prefix-category-length l 1) ?\ ))))
5947 (if (and org-prefix-category-max-length
5948 (>= (length category) org-prefix-category-max-length))
5949 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
5950 ;; Evaluate the compiled format
5951 (setq rtn (concat (eval formatter) txt))
5953 ;; And finally add the text properties
5954 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
5955 (org-add-props rtn nil
5956 'org-category (if thecategory (downcase thecategory) category)
5957 'tags (mapcar 'org-downcase-keep-props tags)
5958 'org-highest-priority org-highest-priority
5959 'org-lowest-priority org-lowest-priority
5960 'time-of-day time-of-day
5961 'duration duration
5962 'effort effort
5963 'effort-minutes neffort
5964 'txt txt
5965 'time time
5966 'extra extra
5967 'format org-prefix-format-compiled
5968 'dotime dotime)))))
5970 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
5971 "Remove tags string from TXT, and add a modified list of tags.
5972 The modified list may contain inherited tags, and tags matched by
5973 `org-agenda-hide-tags-regexp' will be removed."
5974 (when (or add-inherited hide-re)
5975 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
5976 (setq txt (substring txt 0 (match-beginning 0))))
5977 (setq tags
5978 (delq nil
5979 (mapcar (lambda (tg)
5980 (if (or (and hide-re (string-match hide-re tg))
5981 (and (not add-inherited)
5982 (get-text-property 0 'inherited tg)))
5984 tg))
5985 tags)))
5986 (when tags
5987 (let ((have-i (get-text-property 0 'inherited (car tags)))
5989 (setq txt (concat txt " :"
5990 (mapconcat
5991 (lambda (x)
5992 (setq i (get-text-property 0 'inherited x))
5993 (if (and have-i (not i))
5994 (progn
5995 (setq have-i nil)
5996 (concat ":" x))
5998 tags ":")
5999 (if have-i "::" ":"))))))
6000 txt)
6002 (defun org-downcase-keep-props (s)
6003 (let ((props (text-properties-at 0 s)))
6004 (setq s (downcase s))
6005 (add-text-properties 0 (length s) props s)
6008 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6009 (defvar org-agenda-sorting-strategy-selected nil)
6011 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6012 (catch 'exit
6013 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6014 ((and todayp (member 'today (car org-agenda-time-grid))))
6015 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6016 ((member 'weekly (car org-agenda-time-grid)))
6017 (t (throw 'exit list)))
6018 (let* ((have (delq nil (mapcar
6019 (lambda (x) (get-text-property 1 'time-of-day x))
6020 list)))
6021 (string (nth 1 org-agenda-time-grid))
6022 (gridtimes (nth 2 org-agenda-time-grid))
6023 (req (car org-agenda-time-grid))
6024 (remove (member 'remove-match req))
6025 new time)
6026 (if (and (member 'require-timed req) (not have))
6027 ;; don't show empty grid
6028 (throw 'exit list))
6029 (while (setq time (pop gridtimes))
6030 (unless (and remove (member time have))
6031 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6032 (push (org-agenda-format-item
6033 nil string "" nil
6034 (concat (substring time 0 -2) ":" (substring time -2)))
6035 new)
6036 (put-text-property
6037 2 (length (car new)) 'face 'org-time-grid (car new))))
6038 (when (and todayp org-agenda-show-current-time-in-grid)
6039 (push (org-agenda-format-item
6041 org-agenda-current-time-string
6042 "" nil
6043 (format-time-string "%H:%M "))
6044 new)
6045 (put-text-property
6046 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6048 (if (member 'time-up org-agenda-sorting-strategy-selected)
6049 (append new list)
6050 (append list new)))))
6052 (defun org-compile-prefix-format (key)
6053 "Compile the prefix format into a Lisp form that can be evaluated.
6054 The resulting form and associated variable bindings is returned
6055 and stored in the variable `org-prefix-format-compiled'."
6056 (setq org-prefix-has-time nil org-prefix-has-tag nil
6057 org-prefix-category-length nil
6058 org-prefix-has-effort nil)
6059 (let ((s (cond
6060 ((stringp org-agenda-prefix-format)
6061 org-agenda-prefix-format)
6062 ((assq key org-agenda-prefix-format)
6063 (cdr (assq key org-agenda-prefix-format)))
6064 (t " %-12:c%?-12t% s")))
6065 (start 0)
6066 varform vars var e c f opt)
6067 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
6068 s start)
6069 (setq var (or (cdr (assoc (match-string 4 s)
6070 '(("c" . category) ("t" . time) ("s" . extra)
6071 ("i" . category-icon) ("T" . tag) ("e" . effort))))
6072 'eval)
6073 c (or (match-string 3 s) "")
6074 opt (match-beginning 1)
6075 start (1+ (match-beginning 0)))
6076 (if (equal var 'time) (setq org-prefix-has-time t))
6077 (if (equal var 'tag) (setq org-prefix-has-tag t))
6078 (if (equal var 'effort) (setq org-prefix-has-effort t))
6079 (setq f (concat "%" (match-string 2 s) "s"))
6080 (when (equal var 'category)
6081 (setq org-prefix-category-length
6082 (floor (abs (string-to-number (match-string 2 s)))))
6083 (setq org-prefix-category-max-length
6084 (let ((x (match-string 2 s)))
6085 (save-match-data
6086 (if (string-match "\\.[0-9]+" x)
6087 (string-to-number (substring (match-string 0 x) 1)))))))
6088 (if (eq var 'eval)
6089 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6090 (if opt
6091 (setq varform
6092 `(if (equal "" ,var)
6094 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6095 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6096 (setq s (replace-match "%s" t nil s))
6097 (push varform vars))
6098 (setq vars (nreverse vars))
6099 (with-current-buffer org-agenda-buffer
6100 (setq org-prefix-format-compiled
6101 (list
6102 `((org-prefix-has-time ,org-prefix-has-time)
6103 (org-prefix-has-tag ,org-prefix-has-tag)
6104 (org-prefix-category-length ,org-prefix-category-length)
6105 (org-prefix-has-effort ,org-prefix-has-effort))
6106 `(format ,s ,@vars))))))
6108 (defun org-set-sorting-strategy (key)
6109 (if (symbolp (car org-agenda-sorting-strategy))
6110 ;; the old format
6111 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6112 (setq org-agenda-sorting-strategy-selected
6113 (or (cdr (assq key org-agenda-sorting-strategy))
6114 (cdr (assq 'agenda org-agenda-sorting-strategy))
6115 '(time-up category-keep priority-down)))))
6117 (defun org-get-time-of-day (s &optional string mod24)
6118 "Check string S for a time of day.
6119 If found, return it as a military time number between 0 and 2400.
6120 If not found, return nil.
6121 The optional STRING argument forces conversion into a 5 character wide string
6122 HH:MM."
6123 (save-match-data
6124 (when
6125 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6126 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6127 (let* ((h (string-to-number (match-string 1 s)))
6128 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6129 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6130 (am-p (equal ampm "am"))
6131 (h1 (cond ((not ampm) h)
6132 ((= h 12) (if am-p 0 12))
6133 (t (+ h (if am-p 0 12)))))
6134 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6135 (mod h1 24) h1))
6136 (t0 (+ (* 100 h2) m))
6137 (t1 (concat (if (>= h1 24) "+" " ")
6138 (if (and org-agenda-time-leading-zero
6139 (< t0 1000)) "0" "")
6140 (if (< t0 100) "0" "")
6141 (if (< t0 10) "0" "")
6142 (int-to-string t0))))
6143 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6145 (defvar org-agenda-before-sorting-filter-function nil
6146 "Function to be applied to agenda items prior to sorting.
6147 Prior to sorting also means just before they are inserted into the agenda.
6149 To aid sorting, you may revisit the original entries and add more text
6150 properties which will later be used by the sorting functions.
6152 The function should take a string argument, an agenda line.
6153 It has access to the text properties in that line, which contain among
6154 other things, the property `org-hd-marker' that points to the entry
6155 where the line comes from. Note that not all lines going into the agenda
6156 have this property, only most.
6158 The function should return the modified string. It is probably best
6159 to ONLY change text properties.
6161 You can also use this function as a filter, by returning nil for lines
6162 you don't want to have in the agenda at all. For this application, you
6163 could bind the variable in the options section of a custom command.")
6165 (defun org-finalize-agenda-entries (list &optional nosort)
6166 "Sort and concatenate the agenda items."
6167 (setq list (mapcar 'org-agenda-highlight-todo list))
6168 (if nosort
6169 list
6170 (when org-agenda-before-sorting-filter-function
6171 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6172 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6174 (defun org-agenda-highlight-todo (x)
6175 (let ((org-done-keywords org-done-keywords-for-agenda)
6176 (case-fold-search nil)
6178 (if (eq x 'line)
6179 (save-excursion
6180 (beginning-of-line 1)
6181 (setq re (org-get-at-bol 'org-todo-regexp))
6182 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6183 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6184 (add-text-properties (match-beginning 0) (match-end 1)
6185 (list 'face (org-get-todo-face 1)))
6186 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6187 (delete-region (match-beginning 1) (1- (match-end 0)))
6188 (goto-char (match-beginning 1))
6189 (insert (format org-agenda-todo-keyword-format s)))))
6190 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6191 (setq re (get-text-property 0 'org-todo-regexp x))
6192 (when (and re
6193 ;; Test `pl' because if there's no heading content,
6194 ;; there's no point matching to highlight. Note
6195 ;; that if we didn't test `pl' first, and there
6196 ;; happened to be no keyword from `org-todo-regexp'
6197 ;; on this heading line, then the `equal' comparison
6198 ;; afterwards would spuriously succeed in the case
6199 ;; where `pl' is nil -- causing an args-out-of-range
6200 ;; error when we try to add text properties to text
6201 ;; that isn't there.
6203 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6204 x pl) pl))
6205 (add-text-properties
6206 (or (match-end 1) (match-end 0)) (match-end 0)
6207 (list 'face (org-get-todo-face (match-string 2 x)))
6209 (when (match-end 1)
6210 (setq x (concat (substring x 0 (match-end 1))
6211 (format org-agenda-todo-keyword-format
6212 (match-string 2 x))
6213 (org-add-props " " (text-properties-at 0 x))
6214 (substring x (match-end 3)))))))
6215 x)))
6217 (defsubst org-cmp-priority (a b)
6218 "Compare the priorities of string A and B."
6219 (let ((pa (or (get-text-property 1 'priority a) 0))
6220 (pb (or (get-text-property 1 'priority b) 0)))
6221 (cond ((> pa pb) +1)
6222 ((< pa pb) -1))))
6224 (defsubst org-cmp-effort (a b)
6225 "Compare the effort values of string A and B."
6226 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6227 (ea (or (get-text-property 1 'effort-minutes a) def))
6228 (eb (or (get-text-property 1 'effort-minutes b) def)))
6229 (cond ((> ea eb) +1)
6230 ((< ea eb) -1))))
6232 (defsubst org-cmp-category (a b)
6233 "Compare the string values of categories of strings A and B."
6234 (let ((ca (or (get-text-property 1 'org-category a) ""))
6235 (cb (or (get-text-property 1 'org-category b) "")))
6236 (cond ((string-lessp ca cb) -1)
6237 ((string-lessp cb ca) +1))))
6239 (defsubst org-cmp-todo-state (a b)
6240 "Compare the todo states of strings A and B."
6241 (let* ((ma (or (get-text-property 1 'org-marker a)
6242 (get-text-property 1 'org-hd-marker a)))
6243 (mb (or (get-text-property 1 'org-marker b)
6244 (get-text-property 1 'org-hd-marker b)))
6245 (fa (and ma (marker-buffer ma)))
6246 (fb (and mb (marker-buffer mb)))
6247 (todo-kwds
6248 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6249 (and fb (with-current-buffer fb org-todo-keywords-1))))
6250 (ta (or (get-text-property 1 'todo-state a) ""))
6251 (tb (or (get-text-property 1 'todo-state b) ""))
6252 (la (- (length (member ta todo-kwds))))
6253 (lb (- (length (member tb todo-kwds))))
6254 (donepa (member ta org-done-keywords-for-agenda))
6255 (donepb (member tb org-done-keywords-for-agenda)))
6256 (cond ((and donepa (not donepb)) -1)
6257 ((and (not donepa) donepb) +1)
6258 ((< la lb) -1)
6259 ((< lb la) +1))))
6261 (defsubst org-cmp-alpha (a b)
6262 "Compare the headlines, alphabetically."
6263 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6264 (plb (text-property-any 0 (length b) 'org-heading t b))
6265 (ta (and pla (substring a pla)))
6266 (tb (and plb (substring b plb))))
6267 (when pla
6268 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6269 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6270 (setq ta (substring ta (match-end 0))))
6271 (setq ta (downcase ta)))
6272 (when plb
6273 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6274 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6275 (setq tb (substring tb (match-end 0))))
6276 (setq tb (downcase tb)))
6277 (cond ((not ta) +1)
6278 ((not tb) -1)
6279 ((string-lessp ta tb) -1)
6280 ((string-lessp tb ta) +1))))
6282 (defsubst org-cmp-tag (a b)
6283 "Compare the string values of the first tags of A and B."
6284 (let ((ta (car (last (get-text-property 1 'tags a))))
6285 (tb (car (last (get-text-property 1 'tags b)))))
6286 (cond ((not ta) +1)
6287 ((not tb) -1)
6288 ((string-lessp ta tb) -1)
6289 ((string-lessp tb ta) +1))))
6291 (defsubst org-cmp-time (a b)
6292 "Compare the time-of-day values of strings A and B."
6293 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6294 (ta (or (get-text-property 1 'time-of-day a) def))
6295 (tb (or (get-text-property 1 'time-of-day b) def)))
6296 (cond ((< ta tb) -1)
6297 ((< tb ta) +1))))
6299 (defsubst org-cmp-habit-p (a b)
6300 "Compare the todo states of strings A and B."
6301 (let ((ha (get-text-property 1 'org-habit-p a))
6302 (hb (get-text-property 1 'org-habit-p b)))
6303 (cond ((and ha (not hb)) -1)
6304 ((and (not ha) hb) +1))))
6306 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6308 (defun org-entries-lessp (a b)
6309 "Predicate for sorting agenda entries."
6310 ;; The following variables will be used when the form is evaluated.
6311 ;; So even though the compiler complains, keep them.
6312 (let* ((ss org-agenda-sorting-strategy-selected)
6313 (time-up (and (org-em 'time-up 'time-down ss)
6314 (org-cmp-time a b)))
6315 (time-down (if time-up (- time-up) nil))
6316 (priority-up (and (org-em 'priority-up 'priority-down ss)
6317 (org-cmp-priority a b)))
6318 (priority-down (if priority-up (- priority-up) nil))
6319 (effort-up (and (org-em 'effort-up 'effort-down ss)
6320 (org-cmp-effort a b)))
6321 (effort-down (if effort-up (- effort-up) nil))
6322 (category-up (and (or (org-em 'category-up 'category-down ss)
6323 (memq 'category-keep ss))
6324 (org-cmp-category a b)))
6325 (category-down (if category-up (- category-up) nil))
6326 (category-keep (if category-up +1 nil))
6327 (tag-up (and (org-em 'tag-up 'tag-down ss)
6328 (org-cmp-tag a b)))
6329 (tag-down (if tag-up (- tag-up) nil))
6330 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6331 (org-cmp-todo-state a b)))
6332 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6333 (habit-up (and (org-em 'habit-up 'habit-down ss)
6334 (org-cmp-habit-p a b)))
6335 (habit-down (if habit-up (- habit-up) nil))
6336 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6337 (org-cmp-alpha a b)))
6338 (alpha-down (if alpha-up (- alpha-up) nil))
6339 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6340 user-defined-up user-defined-down)
6341 (if (and need-user-cmp org-agenda-cmp-user-defined
6342 (functionp org-agenda-cmp-user-defined))
6343 (setq user-defined-up
6344 (funcall org-agenda-cmp-user-defined a b)
6345 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6346 (cdr (assoc
6347 (eval (cons 'or org-agenda-sorting-strategy-selected))
6348 '((-1 . t) (1 . nil) (nil . nil))))))
6350 ;;; Agenda restriction lock
6352 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6353 "Overlay to mark the headline to which agenda commands are restricted.")
6354 (overlay-put org-agenda-restriction-lock-overlay
6355 'face 'org-agenda-restriction-lock)
6356 (overlay-put org-agenda-restriction-lock-overlay
6357 'help-echo "Agendas are currently limited to this subtree.")
6358 (org-detach-overlay org-agenda-restriction-lock-overlay)
6360 (defun org-agenda-set-restriction-lock (&optional type)
6361 "Set restriction lock for agenda, to current subtree or file.
6362 Restriction will be the file if TYPE is `file', or if type is the
6363 universal prefix '(4), or if the cursor is before the first headline
6364 in the file. Otherwise, restriction will be to the current subtree."
6365 (interactive "P")
6366 (and (equal type '(4)) (setq type 'file))
6367 (setq type (cond
6368 (type type)
6369 ((org-at-heading-p) 'subtree)
6370 ((condition-case nil (org-back-to-heading t) (error nil))
6371 'subtree)
6372 (t 'file)))
6373 (if (eq type 'subtree)
6374 (progn
6375 (setq org-agenda-restrict t)
6376 (setq org-agenda-overriding-restriction 'subtree)
6377 (put 'org-agenda-files 'org-restrict
6378 (list (buffer-file-name (buffer-base-buffer))))
6379 (org-back-to-heading t)
6380 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6381 (move-marker org-agenda-restrict-begin (point))
6382 (move-marker org-agenda-restrict-end
6383 (save-excursion (org-end-of-subtree t)))
6384 (message "Locking agenda restriction to subtree"))
6385 (put 'org-agenda-files 'org-restrict
6386 (list (buffer-file-name (buffer-base-buffer))))
6387 (setq org-agenda-restrict nil)
6388 (setq org-agenda-overriding-restriction 'file)
6389 (move-marker org-agenda-restrict-begin nil)
6390 (move-marker org-agenda-restrict-end nil)
6391 (message "Locking agenda restriction to file"))
6392 (setq current-prefix-arg nil)
6393 (org-agenda-maybe-redo))
6395 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6396 "Remove the agenda restriction lock."
6397 (interactive "P")
6398 (org-detach-overlay org-agenda-restriction-lock-overlay)
6399 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6400 (setq org-agenda-overriding-restriction nil)
6401 (setq org-agenda-restrict nil)
6402 (put 'org-agenda-files 'org-restrict nil)
6403 (move-marker org-agenda-restrict-begin nil)
6404 (move-marker org-agenda-restrict-end nil)
6405 (setq current-prefix-arg nil)
6406 (message "Agenda restriction lock removed")
6407 (or noupdate (org-agenda-maybe-redo)))
6409 (defun org-agenda-maybe-redo ()
6410 "If there is any window showing the agenda view, update it."
6411 (let ((w (get-buffer-window org-agenda-buffer-name t))
6412 (w0 (selected-window)))
6413 (when w
6414 (select-window w)
6415 (org-agenda-redo)
6416 (select-window w0)
6417 (if org-agenda-overriding-restriction
6418 (message "Agenda view shifted to new %s restriction"
6419 org-agenda-overriding-restriction)
6420 (message "Agenda restriction lock removed")))))
6422 ;;; Agenda commands
6424 (defun org-agenda-check-type (error &rest types)
6425 "Check if agenda buffer is of allowed type.
6426 If ERROR is non-nil, throw an error, otherwise just return nil."
6427 (if (not org-agenda-type)
6428 (error "No Org agenda currently displayed")
6429 (if (memq org-agenda-type types)
6431 (if error
6432 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6433 nil))))
6435 (defun org-agenda-Quit (&optional arg)
6436 "Exit agenda by removing the window or the buffer."
6437 (interactive)
6438 (if org-agenda-columns-active
6439 (org-columns-quit)
6440 (let ((buf (current-buffer)))
6441 (if (eq org-agenda-window-setup 'other-frame)
6442 (progn
6443 (org-agenda-reset-markers)
6444 (kill-buffer buf)
6445 (org-columns-remove-overlays)
6446 (setq org-agenda-archives-mode nil)
6447 (delete-frame))
6448 (and (not (eq org-agenda-window-setup 'current-window))
6449 (not (one-window-p))
6450 (delete-window))
6451 (org-agenda-reset-markers)
6452 (kill-buffer buf)
6453 (org-columns-remove-overlays)
6454 (setq org-agenda-archives-mode nil)))
6455 ;; Maybe restore the pre-agenda window configuration.
6456 (and org-agenda-restore-windows-after-quit
6457 (not (eq org-agenda-window-setup 'other-frame))
6458 org-pre-agenda-window-conf
6459 (set-window-configuration org-pre-agenda-window-conf))))
6461 (defun org-agenda-quit ()
6462 "Exit agenda by killing agenda buffer or burying it when
6463 `org-agenda-sticky' is non-NIL"
6464 (interactive)
6465 (if org-agenda-columns-active
6466 (org-columns-quit)
6467 (if org-agenda-sticky
6468 (let ((buf (current-buffer)))
6469 (if (eq org-agenda-window-setup 'other-frame)
6470 (progn
6471 (delete-frame))
6472 (and (not (eq org-agenda-window-setup 'current-window))
6473 (not (one-window-p))
6474 (delete-window)))
6475 (with-current-buffer buf
6476 (bury-buffer)
6477 ;; Maybe restore the pre-agenda window configuration.
6478 (and org-agenda-restore-windows-after-quit
6479 (not (eq org-agenda-window-setup 'other-frame))
6480 org-pre-agenda-window-conf
6481 (set-window-configuration org-pre-agenda-window-conf))))
6482 (org-agenda-Quit))))
6484 (defun org-agenda-exit ()
6485 "Exit agenda by removing the window or the buffer.
6486 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6487 Org-mode buffers visited directly by the user will not be touched."
6488 (interactive)
6489 (org-release-buffers org-agenda-new-buffers)
6490 (setq org-agenda-new-buffers nil)
6491 (org-agenda-Quit))
6493 (defun org-agenda-kill-all-agenda-buffers ()
6494 "Kill all buffers in `org-agena-mode'.
6495 This is used when toggling sticky agendas. You can also explicitly invoke it
6496 with `C-c a C-k'."
6497 (interactive)
6498 (let (blist)
6499 (dolist (buf (buffer-list))
6500 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
6501 (push buf blist)))
6502 (mapc 'kill-buffer blist)))
6504 (defun org-agenda-execute (arg)
6505 "Execute another agenda command, keeping same window.
6506 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6507 in the agenda."
6508 (interactive "P")
6509 (let ((org-agenda-window-setup 'current-window))
6510 (org-agenda arg)))
6512 (defun org-agenda-redo ()
6513 "Rebuild Agenda.
6514 When this is the global TODO list, a prefix argument will be interpreted."
6515 (interactive)
6516 (let* ((org-agenda-doing-sticky-redo org-agenda-sticky)
6517 (org-agenda-sticky nil)
6518 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6519 org-agenda-buffer-name))
6520 (org-agenda-keep-modes t)
6521 (tag-filter org-agenda-tag-filter)
6522 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6523 (top-cat-filter org-agenda-top-category-filter)
6524 (cat-filter org-agenda-category-filter)
6525 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6526 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6527 (cols org-agenda-columns-active)
6528 (line (org-current-line))
6529 (window-line (- line (org-current-line (window-start))))
6530 (lprops (get 'org-agenda-redo-command 'org-lprops)))
6531 (put 'org-agenda-tag-filter :preset-filter nil)
6532 (put 'org-agenda-category-filter :preset-filter nil)
6533 (and cols (org-columns-quit))
6534 (message "Rebuilding agenda buffer...")
6535 (org-let lprops '(eval org-agenda-redo-command))
6536 (setq org-agenda-undo-list nil
6537 org-agenda-pending-undo-list nil)
6538 (message "Rebuilding agenda buffer...done")
6539 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6540 (put 'org-agenda-category-filter :preset-filter cat-preset)
6541 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6542 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6543 (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
6544 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6545 (org-goto-line line)
6546 (recenter window-line)))
6548 (defvar org-global-tags-completion-table nil)
6549 (defvar org-agenda-filter-form nil)
6550 (defvar org-agenda-filtered-by-category nil)
6552 (defun org-agenda-filter-by-category (strip)
6553 "Keep only those lines in the agenda buffer that have a specific category.
6554 The category is that of the current line."
6555 (interactive "P")
6556 (if (and org-agenda-filtered-by-category
6557 org-agenda-category-filter)
6558 (org-agenda-filter-show-all-cat)
6559 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6560 (if cat (org-agenda-filter-apply
6561 (list (concat (if strip "-" "+") cat)) 'category)
6562 (error "No category at point")))))
6564 (defun org-find-top-category (&optional pos)
6565 (save-excursion
6566 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
6567 (if pos (goto-char pos))
6568 ;; Skip up to the topmost parent
6569 (while (ignore-errors (outline-up-heading 1) t))
6570 (ignore-errors
6571 (nth 4 (org-heading-components))))))
6573 (defvar org-agenda-filtered-by-top-category nil)
6575 (defun org-agenda-filter-by-top-category (strip)
6576 "Keep only those lines in the agenda buffer that have a specific category.
6577 The category is that of the current line."
6578 (interactive "P")
6579 (if org-agenda-filtered-by-top-category
6580 (progn
6581 (setq org-agenda-filtered-by-top-category nil
6582 org-agenda-top-category-filter nil)
6583 (org-agenda-filter-show-all-cat))
6584 (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
6585 (if cat (org-agenda-filter-top-category-apply cat strip)
6586 (error "No top-level category at point")))))
6588 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6589 "Keep only those lines in the agenda buffer that have a specific tag.
6590 The tag is selected with its fast selection letter, as configured.
6591 With prefix argument STRIP, remove all lines that do have the tag.
6592 A lisp caller can specify CHAR. NARROW means that the new tag should be
6593 used to narrow the search - the interactive user can also press `-' or `+'
6594 to switch to narrowing."
6595 (interactive "P")
6596 (let* ((alist org-tag-alist-for-agenda)
6597 (tag-chars (mapconcat
6598 (lambda (x) (if (and (not (symbolp (car x)))
6599 (cdr x))
6600 (char-to-string (cdr x))
6601 ""))
6602 alist ""))
6603 (efforts (org-split-string
6604 (or (cdr (assoc (concat org-effort-property "_ALL")
6605 org-global-properties))
6606 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6607 "")))
6608 (effort-op org-agenda-filter-effort-default-operator)
6609 (effort-prompt "")
6610 (inhibit-read-only t)
6611 (current org-agenda-tag-filter)
6612 maybe-refresh a n tag)
6613 (unless char
6614 (message
6615 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6616 (if narrow "Narrow" "Filter") tag-chars
6617 (if org-agenda-auto-exclude-function "[RET], " ""))
6618 (setq char (read-char-exclusive)))
6619 (when (member char '(?+ ?-))
6620 ;; Narrowing down
6621 (cond ((equal char ?-) (setq strip t narrow t))
6622 ((equal char ?+) (setq strip nil narrow t)))
6623 (message
6624 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6625 (setq char (read-char-exclusive)))
6626 (when (member char '(?< ?> ?= ??))
6627 ;; An effort operator
6628 (setq effort-op (char-to-string char))
6629 (setq alist nil) ; to make sure it will be interpreted as effort.
6630 (unless (equal char ??)
6631 (loop for i from 0 to 9 do
6632 (setq effort-prompt
6633 (concat
6634 effort-prompt " ["
6635 (if (= i 9) "0" (int-to-string (1+ i)))
6636 "]" (nth i efforts))))
6637 (message "Effort%s: %s " effort-op effort-prompt)
6638 (setq char (read-char-exclusive))
6639 (when (or (< char ?0) (> char ?9))
6640 (error "Need 1-9,0 to select effort"))))
6641 (when (equal char ?\t)
6642 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6643 (org-set-local 'org-global-tags-completion-table
6644 (org-global-tags-completion-table)))
6645 (let ((completion-ignore-case t))
6646 (setq tag (org-icompleting-read
6647 "Tag: " org-global-tags-completion-table))))
6648 (cond
6649 ((equal char ?\r)
6650 (org-agenda-filter-show-all-tag)
6651 (when org-agenda-auto-exclude-function
6652 (setq org-agenda-tag-filter '())
6653 (dolist (tag (org-agenda-get-represented-tags))
6654 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6655 (if modifier
6656 (push modifier org-agenda-tag-filter))))
6657 (if (not (null org-agenda-tag-filter))
6658 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6659 (setq maybe-refresh t))
6660 ((equal char ?/)
6661 (org-agenda-filter-show-all-tag)
6662 (when (get 'org-agenda-tag-filter :preset-filter)
6663 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6664 (setq maybe-refresh t))
6665 ((equal char ?. )
6666 (setq org-agenda-tag-filter
6667 (mapcar (lambda(tag) (concat "+" tag))
6668 (org-get-at-bol 'tags)))
6669 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6670 (setq maybe-refresh t))
6671 ((or (equal char ?\ )
6672 (setq a (rassoc char alist))
6673 (and (>= char ?0) (<= char ?9)
6674 (setq n (if (= char ?0) 9 (- char ?0 1))
6675 tag (concat effort-op (nth n efforts))
6676 a (cons tag nil)))
6677 (and (= char ??)
6678 (setq tag "?eff")
6679 a (cons tag nil))
6680 (and tag (setq a (cons tag nil))))
6681 (org-agenda-filter-show-all-tag)
6682 (setq tag (car a))
6683 (setq org-agenda-tag-filter
6684 (cons (concat (if strip "-" "+") tag)
6685 (if narrow current nil)))
6686 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6687 (setq maybe-refresh t))
6688 (t (error "Invalid tag selection character %c" char)))
6689 (when (and maybe-refresh
6690 (eq org-agenda-clockreport-mode 'with-filter))
6691 (org-agenda-redo))))
6693 (defun org-agenda-get-represented-tags ()
6694 "Get a list of all tags currently represented in the agenda."
6695 (let (p tags)
6696 (save-excursion
6697 (goto-char (point-min))
6698 (while (setq p (next-single-property-change (point) 'tags))
6699 (goto-char p)
6700 (mapc (lambda (x) (add-to-list 'tags x))
6701 (get-text-property (point) 'tags))))
6702 tags))
6704 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6705 "Refine the current filter. See `org-agenda-filter-by-tag'."
6706 (interactive "P")
6707 (org-agenda-filter-by-tag strip char 'refine))
6709 (defun org-agenda-filter-make-matcher ()
6710 "Create the form that tests a line for agenda filter."
6711 (let (f f1)
6712 ;; first compute the tag-filter matcher
6713 (dolist (x (delete-dups
6714 (append (get 'org-agenda-tag-filter
6715 :preset-filter) org-agenda-tag-filter)))
6716 (if (member x '("-" "+"))
6717 (setq f1 (if (equal x "-") 'tags '(not tags)))
6718 (if (string-match "[<=>?]" x)
6719 (setq f1 (org-agenda-filter-effort-form x))
6720 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6721 (if (equal (string-to-char x) ?-)
6722 (setq f1 (list 'not f1))))
6723 (push f1 f))
6724 ;; then compute the category-filter matcher
6725 (dolist (x (delete-dups
6726 (append (get 'org-agenda-category-filter
6727 :preset-filter) org-agenda-category-filter)))
6728 (if (equal "-" (substring x 0 1))
6729 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
6730 (setq f1 (list 'equal (substring x 1) 'cat)))
6731 (push f1 f))
6732 (cons 'and (nreverse f))))
6734 (defun org-agenda-filter-effort-form (e)
6735 "Return the form to compare the effort of the current line with what E says.
6736 E looks like \"+<2:25\"."
6737 (let (op)
6738 (setq e (substring e 1))
6739 (setq op (string-to-char e) e (substring e 1))
6740 (setq op (cond ((equal op ?<) '<=)
6741 ((equal op ?>) '>=)
6742 ((equal op ??) op)
6743 (t '=)))
6744 (list 'org-agenda-compare-effort (list 'quote op)
6745 (org-duration-string-to-minutes e))))
6747 (defun org-agenda-compare-effort (op value)
6748 "Compare the effort of the current line with VALUE, using OP.
6749 If the line does not have an effort defined, return nil."
6750 (let ((eff (org-get-at-bol 'effort-minutes)))
6751 (if (equal op ??)
6752 (not eff)
6753 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6754 value))))
6756 (defun org-agenda-filter-apply (filter type)
6757 "Set FILTER as the new agenda filter and apply it."
6758 (let (tags cat)
6759 (if (eq type 'tag)
6760 (setq org-agenda-tag-filter filter)
6761 (setq org-agenda-category-filter filter))
6762 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6763 (if (and (eq type 'category)
6764 (not (equal (substring (car filter) 0 1) "-")))
6765 ;; Only set `org-agenda-filtered-by-category' to t
6766 ;; when a unique category is used as the filter
6767 (setq org-agenda-filtered-by-category t))
6768 (org-agenda-set-mode-name)
6769 (save-excursion
6770 (goto-char (point-min))
6771 (while (not (eobp))
6772 (if (org-get-at-bol 'org-marker)
6773 (progn
6774 (setq tags (org-get-at-bol 'tags) ; used in eval
6775 cat (get-text-property (point) 'org-category))
6776 (if (not (eval org-agenda-filter-form))
6777 (org-agenda-filter-hide-line type))
6778 (beginning-of-line 2))
6779 (beginning-of-line 2))))
6780 (if (get-char-property (point) 'invisible)
6781 (ignore-errors (org-agenda-previous-line)))))
6783 (defun org-agenda-filter-top-category-apply (category &optional negative)
6784 "Set FILTER as the new agenda filter and apply it."
6785 (org-agenda-set-mode-name)
6786 (save-excursion
6787 (goto-char (point-min))
6788 (while (not (eobp))
6789 (let* ((pos (org-get-at-bol 'org-hd-marker))
6790 (topcat (and pos (org-find-top-category pos))))
6791 (if (and topcat (funcall (if negative 'identity 'not)
6792 (string= category topcat)))
6793 (org-agenda-filter-hide-line 'category)))
6794 (beginning-of-line 2)))
6795 (if (get-char-property (point) 'invisible)
6796 (org-agenda-previous-line))
6797 (setq org-agenda-top-category-filter category
6798 org-agenda-filtered-by-top-category t))
6800 (defun org-agenda-filter-hide-line (type)
6801 (let (ov)
6802 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6803 (point-at-eol)))
6804 (overlay-put ov 'invisible t)
6805 (overlay-put ov 'type type)
6806 (if (eq type 'tag)
6807 (push ov org-agenda-tag-filter-overlays)
6808 (push ov org-agenda-cat-filter-overlays))))
6810 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6811 (setq pos (or pos (point)))
6812 (save-excursion
6813 (dolist (ov (overlays-at pos))
6814 (when (and (overlay-get ov 'invisible)
6815 (eq (overlay-get ov 'type) 'tag))
6816 (goto-char pos)
6817 (if (< (overlay-start ov) (point-at-eol))
6818 (move-overlay ov (point-at-eol)
6819 (overlay-end ov)))))))
6821 (defun org-agenda-filter-show-all-tag nil
6822 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6823 (setq org-agenda-tag-filter-overlays nil
6824 org-agenda-tag-filter nil
6825 org-agenda-filter-form nil)
6826 (org-agenda-set-mode-name))
6828 (defun org-agenda-filter-show-all-cat nil
6829 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6830 (setq org-agenda-cat-filter-overlays nil
6831 org-agenda-filtered-by-category nil
6832 org-agenda-category-filter nil
6833 org-agenda-filter-form nil)
6834 (org-agenda-set-mode-name))
6836 (defun org-agenda-manipulate-query-add ()
6837 "Manipulate the query by adding a search term with positive selection.
6838 Positive selection means the term must be matched for selection of an entry."
6839 (interactive)
6840 (org-agenda-manipulate-query ?\[))
6841 (defun org-agenda-manipulate-query-subtract ()
6842 "Manipulate the query by adding a search term with negative selection.
6843 Negative selection means term must not be matched for selection of an entry."
6844 (interactive)
6845 (org-agenda-manipulate-query ?\]))
6846 (defun org-agenda-manipulate-query-add-re ()
6847 "Manipulate the query by adding a search regexp with positive selection.
6848 Positive selection means the regexp must match for selection of an entry."
6849 (interactive)
6850 (org-agenda-manipulate-query ?\{))
6851 (defun org-agenda-manipulate-query-subtract-re ()
6852 "Manipulate the query by adding a search regexp with negative selection.
6853 Negative selection means regexp must not match for selection of an entry."
6854 (interactive)
6855 (org-agenda-manipulate-query ?\}))
6856 (defun org-agenda-manipulate-query (char)
6857 (cond
6858 ((memq org-agenda-type '(timeline agenda))
6859 (let ((org-agenda-include-inactive-timestamps t))
6860 (org-agenda-redo))
6861 (message "Display now includes inactive timestamps as well"))
6862 ((eq org-agenda-type 'search)
6863 (org-add-to-string
6864 'org-agenda-query-string
6865 (if org-agenda-last-search-view-search-was-boolean
6866 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6867 (?\{ . " +{}") (?\} . " -{}"))))
6868 " "))
6869 (setq org-agenda-redo-command
6870 (list 'org-search-view
6871 org-todo-only
6872 org-agenda-query-string
6873 (+ (length org-agenda-query-string)
6874 (if (member char '(?\{ ?\})) 0 1))))
6875 (set-register org-agenda-query-register org-agenda-query-string)
6876 (org-agenda-redo))
6877 (t (error "Cannot manipulate query for %s-type agenda buffers"
6878 org-agenda-type))))
6880 (defun org-add-to-string (var string)
6881 (set var (concat (symbol-value var) string)))
6883 (defun org-agenda-goto-date (date)
6884 "Jump to DATE in agenda."
6885 (interactive (list (let ((org-read-date-prefer-future
6886 (eval org-agenda-jump-prefer-future)))
6887 (org-read-date))))
6888 (org-agenda-list nil date))
6890 (defun org-agenda-goto-today ()
6891 "Go to today."
6892 (interactive)
6893 (org-agenda-check-type t 'timeline 'agenda)
6894 (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6895 (cond
6896 (tdpos (goto-char tdpos))
6897 ((eq org-agenda-type 'agenda)
6898 (let* ((sd (org-agenda-compute-starting-span
6899 (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
6900 (org-agenda-overriding-arguments org-agenda-last-arguments))
6901 (setf (nth 1 org-agenda-overriding-arguments) sd)
6902 (org-agenda-redo)
6903 (org-agenda-find-same-or-today-or-agenda)))
6904 (t (error "Cannot find today")))))
6906 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
6907 (goto-char
6908 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
6909 (text-property-any (point-min) (point-max) 'org-today t)
6910 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
6911 (point-min))))
6913 (defun org-agenda-later (arg)
6914 "Go forward in time by thee current span.
6915 With prefix ARG, go forward that many times the current span."
6916 (interactive "p")
6917 (org-agenda-check-type t 'agenda)
6918 (let* ((span org-agenda-current-span)
6919 (sd org-starting-day)
6920 (greg (calendar-gregorian-from-absolute sd))
6921 (cnt (org-get-at-bol 'org-day-cnt))
6922 greg2)
6923 (cond
6924 ((eq span 'day)
6925 (setq sd (+ arg sd)))
6926 ((eq span 'week)
6927 (setq sd (+ (* 7 arg) sd)))
6928 ((eq span 'month)
6929 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
6930 sd (calendar-absolute-from-gregorian greg2))
6931 (setcar greg2 (1+ (car greg2))))
6932 ((eq span 'year)
6933 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
6934 sd (calendar-absolute-from-gregorian greg2))
6935 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
6937 (setq sd (+ (* span arg) sd))))
6938 (let ((org-agenda-overriding-arguments
6939 (list (car org-agenda-last-arguments) sd span t)))
6940 (org-agenda-redo)
6941 (org-agenda-find-same-or-today-or-agenda cnt))))
6943 (defun org-agenda-earlier (arg)
6944 "Go backward in time by the current span.
6945 With prefix ARG, go backward that many times the current span."
6946 (interactive "p")
6947 (org-agenda-later (- arg)))
6949 (defun org-agenda-view-mode-dispatch ()
6950 "Call one of the view mode commands."
6951 (interactive)
6952 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
6953 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
6954 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
6955 (let ((a (read-char-exclusive)))
6956 (case a
6957 (?\ (call-interactively 'org-agenda-reset-view))
6958 (?d (call-interactively 'org-agenda-day-view))
6959 (?w (call-interactively 'org-agenda-week-view))
6960 (?m (call-interactively 'org-agenda-month-view))
6961 (?y (call-interactively 'org-agenda-year-view))
6962 (?l (call-interactively 'org-agenda-log-mode))
6963 (?L (org-agenda-log-mode '(4)))
6964 (?c (org-agenda-log-mode 'clockcheck))
6965 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
6966 (?a (call-interactively 'org-agenda-archives-mode))
6967 (?A (org-agenda-archives-mode 'files))
6968 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
6969 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
6970 (?G (call-interactively 'org-agenda-toggle-time-grid))
6971 (?D (call-interactively 'org-agenda-toggle-diary))
6972 (?\! (call-interactively 'org-agenda-toggle-deadlines))
6973 (?\[ (let ((org-agenda-include-inactive-timestamps t))
6974 (org-agenda-check-type t 'timeline 'agenda)
6975 (org-agenda-redo))
6976 (message "Display now includes inactive timestamps as well"))
6977 (?q (message "Abort"))
6978 (otherwise (error "Invalid key" )))))
6980 (defun org-agenda-reset-view ()
6981 "Switch to default view for agenda."
6982 (interactive)
6983 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
6984 (defun org-agenda-day-view (&optional day-of-year)
6985 "Switch to daily view for agenda.
6986 With argument DAY-OF-YEAR, switch to that day of the year."
6987 (interactive "P")
6988 (org-agenda-change-time-span 'day day-of-year))
6989 (defun org-agenda-week-view (&optional iso-week)
6990 "Switch to daily view for agenda.
6991 With argument ISO-WEEK, switch to the corresponding ISO week.
6992 If ISO-WEEK has more then 2 digits, only the last two encode the
6993 week. Any digits before this encode a year. So 200712 means
6994 week 12 of year 2007. Years in the range 1938-2037 can also be
6995 written as 2-digit years."
6996 (interactive "P")
6997 (org-agenda-change-time-span 'week iso-week))
6998 (defun org-agenda-month-view (&optional month)
6999 "Switch to monthly view for agenda.
7000 With argument MONTH, switch to that month."
7001 (interactive "P")
7002 (org-agenda-change-time-span 'month month))
7003 (defun org-agenda-year-view (&optional year)
7004 "Switch to yearly view for agenda.
7005 With argument YEAR, switch to that year.
7006 If MONTH has more then 2 digits, only the last two encode the
7007 month. Any digits before this encode a year. So 200712 means
7008 December year 2007. Years in the range 1938-2037 can also be
7009 written as 2-digit years."
7010 (interactive "P")
7011 (when year
7012 (setq year (org-small-year-to-year year)))
7013 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7014 (org-agenda-change-time-span 'year year)
7015 (error "Abort")))
7017 (defun org-agenda-change-time-span (span &optional n)
7018 "Change the agenda view to SPAN.
7019 SPAN may be `day', `week', `month', `year'."
7020 (org-agenda-check-type t 'agenda)
7021 (if (and (not n) (equal org-agenda-current-span span))
7022 (error "Viewing span is already \"%s\"" span))
7023 (let* ((sd (or (org-get-at-bol 'day)
7024 org-starting-day))
7025 (sd (org-agenda-compute-starting-span sd span n))
7026 (org-agenda-overriding-arguments
7027 (or org-agenda-overriding-arguments
7028 (list (car org-agenda-last-arguments) sd span t))))
7029 (org-agenda-redo)
7030 (org-agenda-find-same-or-today-or-agenda))
7031 (org-agenda-set-mode-name)
7032 (message "Switched to %s view" span))
7034 (defun org-agenda-compute-starting-span (sd span &optional n)
7035 "Compute starting date for agenda.
7036 SPAN may be `day', `week', `month', `year'. The return value
7037 is a cons cell with the starting date and the number of days,
7038 so that the date SD will be in that range."
7039 (let* ((greg (calendar-gregorian-from-absolute sd))
7040 (dg (nth 1 greg))
7041 (mg (car greg))
7042 (yg (nth 2 greg)))
7043 (cond
7044 ((eq span 'day)
7045 (when n
7046 (setq sd (+ (calendar-absolute-from-gregorian
7047 (list mg 1 yg))
7048 n -1))))
7049 ((eq span 'week)
7050 (let* ((nt (calendar-day-of-week
7051 (calendar-gregorian-from-absolute sd)))
7052 (d (if org-agenda-start-on-weekday
7053 (- nt org-agenda-start-on-weekday)
7056 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7057 (when n
7058 (require 'cal-iso)
7059 (when (> n 99)
7060 (setq y1 (org-small-year-to-year (/ n 100))
7061 n (mod n 100)))
7062 (setq sd
7063 (calendar-absolute-from-iso
7064 (list n 1
7065 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7066 ((eq span 'month)
7067 (let (y1)
7068 (when (and n (> n 99))
7069 (setq y1 (org-small-year-to-year (/ n 100))
7070 n (mod n 100)))
7071 (setq sd (calendar-absolute-from-gregorian
7072 (list (or n mg) 1 (or y1 yg))))))
7073 ((eq span 'year)
7074 (setq sd (calendar-absolute-from-gregorian
7075 (list 1 1 (or n yg))))))
7076 sd))
7078 (defun org-agenda-next-date-line (&optional arg)
7079 "Jump to the next line indicating a date in agenda buffer."
7080 (interactive "p")
7081 (org-agenda-check-type t 'agenda 'timeline)
7082 (beginning-of-line 1)
7083 ;; This does not work if user makes date format that starts with a blank
7084 (if (looking-at "^\\S-") (forward-char 1))
7085 (if (not (re-search-forward "^\\S-" nil t arg))
7086 (progn
7087 (backward-char 1)
7088 (error "No next date after this line in this buffer")))
7089 (goto-char (match-beginning 0)))
7091 (defun org-agenda-previous-date-line (&optional arg)
7092 "Jump to the previous line indicating a date in agenda buffer."
7093 (interactive "p")
7094 (org-agenda-check-type t 'agenda 'timeline)
7095 (beginning-of-line 1)
7096 (if (not (re-search-backward "^\\S-" nil t arg))
7097 (error "No previous date before this line in this buffer")))
7099 ;; Initialize the highlight
7100 (defvar org-hl (make-overlay 1 1))
7101 (overlay-put org-hl 'face 'highlight)
7103 (defun org-highlight (begin end &optional buffer)
7104 "Highlight a region with overlay."
7105 (move-overlay org-hl begin end (or buffer (current-buffer))))
7107 (defun org-unhighlight ()
7108 "Detach overlay INDEX."
7109 (org-detach-overlay org-hl))
7111 ;; FIXME this is currently not used.
7112 (defun org-highlight-until-next-command (beg end &optional buffer)
7113 "Move the highlight overlay to BEG/END, remove it before the next command."
7114 (org-highlight beg end buffer)
7115 (add-hook 'pre-command-hook 'org-unhighlight-once))
7116 (defun org-unhighlight-once ()
7117 "Remove the highlight from its position, and this function from the hook."
7118 (remove-hook 'pre-command-hook 'org-unhighlight-once)
7119 (org-unhighlight))
7121 (defun org-agenda-follow-mode ()
7122 "Toggle follow mode in an agenda buffer."
7123 (interactive)
7124 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
7125 (org-agenda-set-mode-name)
7126 (org-agenda-do-context-action)
7127 (message "Follow mode is %s"
7128 (if org-agenda-follow-mode "on" "off")))
7130 (defun org-agenda-entry-text-mode (&optional arg)
7131 "Toggle entry text mode in an agenda buffer."
7132 (interactive "P")
7133 (setq org-agenda-entry-text-mode (or (integerp arg)
7134 (not org-agenda-entry-text-mode)))
7135 (org-agenda-entry-text-hide)
7136 (and org-agenda-entry-text-mode
7137 (let ((org-agenda-entry-text-maxlines
7138 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7139 (org-agenda-entry-text-show)))
7140 (org-agenda-set-mode-name)
7141 (message "Entry text mode is %s. Maximum number of lines is %d"
7142 (if org-agenda-entry-text-mode "on" "off")
7143 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7145 (defun org-agenda-clockreport-mode (&optional with-filter)
7146 "Toggle clocktable mode in an agenda buffer.
7147 With prefix arg WITH-FILTER, make the clocktable respect the current
7148 agenda filter."
7149 (interactive "P")
7150 (org-agenda-check-type t 'agenda)
7151 (if with-filter
7152 (setq org-agenda-clockreport-mode 'with-filter)
7153 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
7154 (org-agenda-set-mode-name)
7155 (org-agenda-redo)
7156 (message "Clocktable mode is %s"
7157 (if org-agenda-clockreport-mode "on" "off")))
7159 (defun org-agenda-log-mode (&optional special)
7160 "Toggle log mode in an agenda buffer.
7161 With argument SPECIAL, show all possible log items, not only the ones
7162 configured in `org-agenda-log-mode-items'.
7163 With a double `C-u' prefix arg, show *only* log items, nothing else."
7164 (interactive "P")
7165 (org-agenda-check-type t 'agenda 'timeline)
7166 (setq org-agenda-show-log
7167 (cond
7168 ((equal special '(16)) 'only)
7169 ((eq special 'clockcheck)
7170 (if (eq org-agenda-show-log 'clockcheck)
7171 nil 'clockcheck))
7172 (special '(closed clock state))
7173 (t (not org-agenda-show-log))))
7174 (org-agenda-set-mode-name)
7175 (org-agenda-redo)
7176 (message "Log mode is %s"
7177 (if org-agenda-show-log "on" "off")))
7179 (defun org-agenda-archives-mode (&optional with-files)
7180 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7181 When called with a prefix argument, include all archive files as well."
7182 (interactive "P")
7183 (setq org-agenda-archives-mode
7184 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7185 (org-agenda-set-mode-name)
7186 (org-agenda-redo)
7187 (message
7188 "%s"
7189 (cond
7190 ((eq org-agenda-archives-mode nil)
7191 "No archives are included")
7192 ((eq org-agenda-archives-mode 'trees)
7193 (format "Trees with :%s: tag are included" org-archive-tag))
7194 ((eq org-agenda-archives-mode t)
7195 (format "Trees with :%s: tag and all active archive files are included"
7196 org-archive-tag)))))
7198 (defun org-agenda-toggle-diary ()
7199 "Toggle diary inclusion in an agenda buffer."
7200 (interactive)
7201 (org-agenda-check-type t 'agenda)
7202 (setq org-agenda-include-diary (not org-agenda-include-diary))
7203 (org-agenda-redo)
7204 (org-agenda-set-mode-name)
7205 (message "Diary inclusion turned %s"
7206 (if org-agenda-include-diary "on" "off")))
7208 (defun org-agenda-toggle-deadlines ()
7209 "Toggle inclusion of entries with a deadline in an agenda buffer."
7210 (interactive)
7211 (org-agenda-check-type t 'agenda)
7212 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7213 (org-agenda-redo)
7214 (org-agenda-set-mode-name)
7215 (message "Deadlines inclusion turned %s"
7216 (if org-agenda-include-deadlines "on" "off")))
7218 (defun org-agenda-toggle-time-grid ()
7219 "Toggle time grid in an agenda buffer."
7220 (interactive)
7221 (org-agenda-check-type t 'agenda)
7222 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7223 (org-agenda-redo)
7224 (org-agenda-set-mode-name)
7225 (message "Time-grid turned %s"
7226 (if org-agenda-use-time-grid "on" "off")))
7228 (defun org-agenda-set-mode-name ()
7229 "Set the mode name to indicate all the small mode settings."
7230 (setq mode-name
7231 (list "Org-Agenda"
7232 (if (get 'org-agenda-files 'org-restrict) " []" "")
7234 '(:eval (org-agenda-span-name org-agenda-current-span))
7235 (if org-agenda-follow-mode " Follow" "")
7236 (if org-agenda-entry-text-mode " ETxt" "")
7237 (if org-agenda-include-diary " Diary" "")
7238 (if org-agenda-include-deadlines " Ddl" "")
7239 (if org-agenda-use-time-grid " Grid" "")
7240 (if (and (boundp 'org-habit-show-habits)
7241 org-habit-show-habits) " Habit" "")
7242 (cond
7243 ((consp org-agenda-show-log) " LogAll")
7244 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7245 (org-agenda-show-log " Log")
7246 (t ""))
7247 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7248 :preset-filter))
7249 '(:eval (org-propertize
7250 (concat " <"
7251 (mapconcat
7252 'identity
7253 (append
7254 (get 'org-agenda-category-filter :preset-filter)
7255 org-agenda-category-filter)
7257 ">")
7258 'face 'org-agenda-filter-category
7259 'help-echo "Category used in filtering"))
7261 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7262 :preset-filter))
7263 '(:eval (org-propertize
7264 (concat " {"
7265 (mapconcat
7266 'identity
7267 (append
7268 (get 'org-agenda-tag-filter :preset-filter)
7269 org-agenda-tag-filter)
7271 "}")
7272 'face 'org-agenda-filter-tags
7273 'help-echo "Tags used in filtering"))
7275 (if org-agenda-archives-mode
7276 (if (eq org-agenda-archives-mode t)
7277 " Archives"
7278 (format " :%s:" org-archive-tag))
7280 (if org-agenda-clockreport-mode
7281 (if (eq org-agenda-clockreport-mode 'with-filter)
7282 " Clock{}" " Clock")
7283 "")))
7284 (force-mode-line-update))
7286 (defun org-agenda-post-command-hook ()
7287 (setq org-agenda-type
7288 (or (get-text-property (point) 'org-agenda-type)
7289 (get-text-property (max (point-min) (1- (point)))
7290 'org-agenda-type))))
7292 (defun org-agenda-next-line ()
7293 "Move cursor to the next line, and show if follow mode is active."
7294 (interactive)
7295 (call-interactively 'next-line)
7296 (org-agenda-do-context-action))
7298 (defun org-agenda-previous-line ()
7299 "Move cursor to the previous line, and show if follow-mode is active."
7300 (interactive)
7301 (call-interactively 'previous-line)
7302 (org-agenda-do-context-action))
7304 (defun org-agenda-next-item (n)
7305 "Move cursor to next agenda item."
7306 (interactive "p")
7307 (let ((col (current-column)))
7308 (dotimes (c n)
7309 (when (next-single-property-change (point-at-eol) 'org-marker)
7310 (move-end-of-line 1)
7311 (goto-char (next-single-property-change (point) 'org-marker))))
7312 (org-move-to-column col))
7313 (org-agenda-do-context-action))
7315 (defun org-agenda-previous-item (n)
7316 "Move cursor to next agenda item."
7317 (interactive "p")
7318 (dotimes (c n)
7319 (let ((col (current-column))
7320 (goto (save-excursion
7321 (move-end-of-line 0)
7322 (previous-single-property-change (point) 'org-marker))))
7323 (if goto (goto-char goto))
7324 (org-move-to-column col)))
7325 (org-agenda-do-context-action))
7327 (defun org-agenda-do-context-action ()
7328 "Show outline path and, maybe, follow mode window."
7329 (let ((m (org-get-at-bol 'org-marker)))
7330 (when (and (markerp m) (marker-buffer m))
7331 (and org-agenda-follow-mode
7332 (if org-agenda-follow-indirect
7333 (org-agenda-tree-to-indirect-buffer)
7334 (org-agenda-show)))
7335 (and org-agenda-show-outline-path
7336 (org-with-point-at m (org-display-outline-path t))))))
7338 (defun org-agenda-show-priority ()
7339 "Show the priority of the current item.
7340 This priority is composed of the main priority given with the [#A] cookies,
7341 and by additional input from the age of a schedules or deadline entry."
7342 (interactive)
7343 (let* ((pri (org-get-at-bol 'priority)))
7344 (message "Priority is %d" (if pri pri -1000))))
7346 (defun org-agenda-show-tags ()
7347 "Show the tags applicable to the current item."
7348 (interactive)
7349 (let* ((tags (org-get-at-bol 'tags)))
7350 (if tags
7351 (message "Tags are :%s:"
7352 (org-no-properties (mapconcat 'identity tags ":")))
7353 (message "No tags associated with this line"))))
7355 (defun org-agenda-goto (&optional highlight)
7356 "Go to the Org-mode file which contains the item at point."
7357 (interactive)
7358 (let* ((marker (or (org-get-at-bol 'org-marker)
7359 (org-agenda-error)))
7360 (buffer (marker-buffer marker))
7361 (pos (marker-position marker)))
7362 (switch-to-buffer-other-window buffer)
7363 (widen)
7364 (push-mark)
7365 (goto-char pos)
7366 (when (derived-mode-p 'org-mode)
7367 (org-show-context 'agenda)
7368 (save-excursion
7369 (and (outline-next-heading)
7370 (org-flag-heading nil)))) ; show the next heading
7371 (when (outline-invisible-p)
7372 (show-entry)) ; display invisible text
7373 (recenter (/ (window-height) 2))
7374 (run-hooks 'org-agenda-after-show-hook)
7375 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7377 (defvar org-agenda-after-show-hook nil
7378 "Normal hook run after an item has been shown from the agenda.
7379 Point is in the buffer where the item originated.")
7381 (defun org-agenda-kill ()
7382 "Kill the entry or subtree belonging to the current agenda entry."
7383 (interactive)
7384 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7385 (let* ((marker (or (org-get-at-bol 'org-marker)
7386 (org-agenda-error)))
7387 (buffer (marker-buffer marker))
7388 (pos (marker-position marker))
7389 (type (org-get-at-bol 'type))
7390 dbeg dend (n 0) conf)
7391 (org-with-remote-undo buffer
7392 (with-current-buffer buffer
7393 (save-excursion
7394 (goto-char pos)
7395 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
7396 (setq dbeg (progn (org-back-to-heading t) (point))
7397 dend (org-end-of-subtree t t))
7398 (setq dbeg (point-at-bol)
7399 dend (min (point-max) (1+ (point-at-eol)))))
7400 (goto-char dbeg)
7401 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7402 (setq conf (or (eq t org-agenda-confirm-kill)
7403 (and (numberp org-agenda-confirm-kill)
7404 (> n org-agenda-confirm-kill))))
7405 (and conf
7406 (not (y-or-n-p
7407 (format "Delete entry with %d lines in buffer \"%s\"? "
7408 n (buffer-name buffer))))
7409 (error "Abort"))
7410 (org-remove-subtree-entries-from-agenda buffer dbeg dend)
7411 (with-current-buffer buffer (delete-region dbeg dend))
7412 (message "Agenda item and source killed"))))
7414 (defvar org-archive-default-command)
7415 (defun org-agenda-archive-default ()
7416 "Archive the entry or subtree belonging to the current agenda entry."
7417 (interactive)
7418 (require 'org-archive)
7419 (org-agenda-archive-with org-archive-default-command))
7421 (defun org-agenda-archive-default-with-confirmation ()
7422 "Archive the entry or subtree belonging to the current agenda entry."
7423 (interactive)
7424 (require 'org-archive)
7425 (org-agenda-archive-with org-archive-default-command 'confirm))
7427 (defun org-agenda-archive ()
7428 "Archive the entry or subtree belonging to the current agenda entry."
7429 (interactive)
7430 (org-agenda-archive-with 'org-archive-subtree))
7432 (defun org-agenda-archive-to-archive-sibling ()
7433 "Move the entry to the archive sibling."
7434 (interactive)
7435 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7437 (defun org-agenda-archive-with (cmd &optional confirm)
7438 "Move the entry to the archive sibling."
7439 (interactive)
7440 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7441 (let* ((marker (or (org-get-at-bol 'org-marker)
7442 (org-agenda-error)))
7443 (buffer (marker-buffer marker))
7444 (pos (marker-position marker)))
7445 (org-with-remote-undo buffer
7446 (with-current-buffer buffer
7447 (if (derived-mode-p 'org-mode)
7448 (if (and confirm
7449 (not (y-or-n-p "Archive this subtree or entry? ")))
7450 (error "Abort")
7451 (save-excursion
7452 (goto-char pos)
7453 (org-remove-subtree-entries-from-agenda)
7454 (org-back-to-heading t)
7455 (funcall cmd)))
7456 (error "Archiving works only in Org-mode files"))))))
7458 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7459 "Remove all lines in the agenda that correspond to a given subtree.
7460 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7461 If this information is not given, the function uses the tree at point."
7462 (let ((buf (or buf (current-buffer))) m p)
7463 (save-excursion
7464 (unless (and beg end)
7465 (org-back-to-heading t)
7466 (setq beg (point))
7467 (org-end-of-subtree t)
7468 (setq end (point)))
7469 (set-buffer (get-buffer org-agenda-buffer-name))
7470 (save-excursion
7471 (goto-char (point-max))
7472 (beginning-of-line 1)
7473 (while (not (bobp))
7474 (when (and (setq m (org-get-at-bol 'org-marker))
7475 (equal buf (marker-buffer m))
7476 (setq p (marker-position m))
7477 (>= p beg)
7478 (< p end))
7479 (let ((inhibit-read-only t))
7480 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7481 (beginning-of-line 0))))))
7483 (defun org-agenda-refile (&optional goto rfloc no-update)
7484 "Refile the item at point."
7485 (interactive "P")
7486 (if (equal goto '(16))
7487 (org-refile-goto-last-stored)
7488 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7489 (org-agenda-error)))
7490 (buffer (marker-buffer marker))
7491 (pos (marker-position marker))
7492 (rfloc (or rfloc
7493 (org-refile-get-location
7494 (if goto "Goto" "Refile to") buffer
7495 org-refile-allow-creating-parent-nodes))))
7496 (with-current-buffer buffer
7497 (save-excursion
7498 (save-restriction
7499 (widen)
7500 (goto-char marker)
7501 (org-remove-subtree-entries-from-agenda)
7502 (org-refile goto buffer rfloc)))))
7503 (unless no-update (org-agenda-redo))))
7505 (defun org-agenda-open-link (&optional arg)
7506 "Follow the link in the current line, if any.
7507 This looks for a link in the displayed line in the agenda. It also looks
7508 at the text of the entry itself."
7509 (interactive "P")
7510 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7511 (org-get-at-bol 'org-marker)))
7512 (buffer (and marker (marker-buffer marker)))
7513 (prefix (buffer-substring
7514 (point-at-bol) (point-at-eol))))
7515 (cond
7516 (buffer
7517 (with-current-buffer buffer
7518 (save-excursion
7519 (save-restriction
7520 (widen)
7521 (goto-char marker)
7522 (org-offer-links-in-entry arg prefix)))))
7523 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7524 (save-excursion
7525 (beginning-of-line 1)
7526 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7527 (org-open-link-from-string (match-string 1)))
7528 (t (error "No link to open here")))))
7530 (defun org-agenda-copy-local-variable (var)
7531 "Get a variable from a referenced buffer and install it here."
7532 (let ((m (org-get-at-bol 'org-marker)))
7533 (when (and m (buffer-live-p (marker-buffer m)))
7534 (org-set-local var (with-current-buffer (marker-buffer m)
7535 (symbol-value var))))))
7537 (defun org-agenda-switch-to (&optional delete-other-windows)
7538 "Go to the Org-mode file which contains the item at point."
7539 (interactive)
7540 (if (and org-return-follows-link
7541 (not (org-get-at-bol 'org-marker))
7542 (org-in-regexp org-bracket-link-regexp))
7543 (org-open-link-from-string (match-string 0))
7544 (let* ((marker (or (org-get-at-bol 'org-marker)
7545 (org-agenda-error)))
7546 (buffer (marker-buffer marker))
7547 (pos (marker-position marker)))
7548 (org-pop-to-buffer-same-window buffer)
7549 (and delete-other-windows (delete-other-windows))
7550 (widen)
7551 (goto-char pos)
7552 (when (derived-mode-p 'org-mode)
7553 (org-show-context 'agenda)
7554 (save-excursion
7555 (and (outline-next-heading)
7556 (org-flag-heading nil))) ; show the next heading
7557 (when (outline-invisible-p)
7558 (show-entry)) ; display invisible text
7559 (run-hooks 'org-agenda-after-show-hook)))))
7561 (defun org-agenda-goto-mouse (ev)
7562 "Go to the Org-mode file which contains the item at the mouse click."
7563 (interactive "e")
7564 (mouse-set-point ev)
7565 (org-agenda-goto))
7567 (defun org-agenda-show (&optional full-entry)
7568 "Display the Org-mode file which contains the item at point.
7569 With prefix argument FULL-ENTRY, make the entire entry visible
7570 if it was hidden in the outline."
7571 (interactive "P")
7572 (let ((win (selected-window)))
7573 (if full-entry
7574 (let ((org-show-entry-below t))
7575 (org-agenda-goto t))
7576 (org-agenda-goto t))
7577 (select-window win)))
7579 (defvar org-agenda-show-window nil)
7580 (defun org-agenda-show-and-scroll-up (&optional arg)
7581 "Display the Org-mode file which contains the item at point.
7582 When called repeatedly, scroll the window that is displaying the buffer.
7583 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7584 `show-subtree' to display the item, so that drawers and logbooks stay
7585 folded."
7586 (interactive "P")
7587 (let ((win (selected-window)))
7588 (if (and (window-live-p org-agenda-show-window)
7589 (eq this-command last-command))
7590 (progn
7591 (select-window org-agenda-show-window)
7592 (ignore-errors (scroll-up)))
7593 (org-agenda-goto t)
7594 (if arg (org-show-entry) (show-subtree))
7595 (setq org-agenda-show-window (selected-window)))
7596 (select-window win)))
7598 (defun org-agenda-show-scroll-down ()
7599 "Scroll down the window showing the agenda."
7600 (interactive)
7601 (let ((win (selected-window)))
7602 (when (window-live-p org-agenda-show-window)
7603 (select-window org-agenda-show-window)
7604 (ignore-errors (scroll-down))
7605 (select-window win))))
7607 (defun org-agenda-show-1 (&optional more)
7608 "Display the Org-mode file which contains the item at point.
7609 The prefix arg selects the amount of information to display:
7611 0 hide the subtree
7612 1 just show the entry according to defaults.
7613 2 show the children view
7614 3 show the subtree view
7615 4 show the entire subtree and any LOGBOOK drawers
7616 5 show the entire subtree and any drawers
7617 With prefix argument FULL-ENTRY, make the entire entry visible
7618 if it was hidden in the outline."
7619 (interactive "p")
7620 (let ((win (selected-window)))
7621 (org-agenda-goto t)
7622 (org-recenter-heading 1)
7623 (cond
7624 ((= more 0)
7625 (hide-subtree)
7626 (save-excursion
7627 (org-back-to-heading)
7628 (run-hook-with-args 'org-cycle-hook 'folded))
7629 (message "Remote: FOLDED"))
7630 ((and (org-called-interactively-p 'any) (= more 1))
7631 (message "Remote: show with default settings"))
7632 ((= more 2)
7633 (show-entry)
7634 (show-children)
7635 (save-excursion
7636 (org-back-to-heading)
7637 (run-hook-with-args 'org-cycle-hook 'children))
7638 (message "Remote: CHILDREN"))
7639 ((= more 3)
7640 (show-subtree)
7641 (save-excursion
7642 (org-back-to-heading)
7643 (run-hook-with-args 'org-cycle-hook 'subtree))
7644 (message "Remote: SUBTREE"))
7645 ((= more 4)
7646 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7647 (org-drawer-regexp
7648 (concat "^[ \t]*:\\("
7649 (mapconcat 'regexp-quote org-drawers "\\|")
7650 "\\):[ \t]*$")))
7651 (show-subtree)
7652 (save-excursion
7653 (org-back-to-heading)
7654 (org-cycle-hide-drawers 'subtree)))
7655 (message "Remote: SUBTREE AND LOGBOOK"))
7656 ((> more 4)
7657 (show-subtree)
7658 (message "Remote: SUBTREE AND ALL DRAWERS")))
7659 (select-window win)))
7661 (defun org-recenter-heading (n)
7662 (save-excursion
7663 (org-back-to-heading)
7664 (recenter n)))
7666 (defvar org-agenda-cycle-counter nil)
7667 (defun org-agenda-cycle-show (&optional n)
7668 "Show the current entry in another window, with default settings.
7669 Default settings are taken from `org-show-hierarchy-above' and siblings.
7670 When use repeatedly in immediate succession, the remote entry will cycle
7671 through visibility
7673 children -> subtree -> folded
7675 When called with a numeric prefix arg, that arg will be passed through to
7676 `org-agenda-show-1'. For the interpretation of that argument, see the
7677 docstring of `org-agenda-show-1'."
7678 (interactive "P")
7679 (if (integerp n)
7680 (setq org-agenda-cycle-counter n)
7681 (if (not (eq last-command this-command))
7682 (setq org-agenda-cycle-counter 1)
7683 (if (equal org-agenda-cycle-counter 0)
7684 (setq org-agenda-cycle-counter 2)
7685 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7686 (if (> org-agenda-cycle-counter 3)
7687 (setq org-agenda-cycle-counter 0)))))
7688 (org-agenda-show-1 org-agenda-cycle-counter))
7690 (defun org-agenda-recenter (arg)
7691 "Display the Org-mode file which contains the item at point and recenter."
7692 (interactive "P")
7693 (let ((win (selected-window)))
7694 (org-agenda-goto t)
7695 (recenter arg)
7696 (select-window win)))
7698 (defun org-agenda-show-mouse (ev)
7699 "Display the Org-mode file which contains the item at the mouse click."
7700 (interactive "e")
7701 (mouse-set-point ev)
7702 (org-agenda-show))
7704 (defun org-agenda-check-no-diary ()
7705 "Check if the entry is a diary link and abort if yes."
7706 (if (org-get-at-bol 'org-agenda-diary-link)
7707 (org-agenda-error)))
7709 (defun org-agenda-error ()
7710 (error "Command not allowed in this line"))
7712 (defun org-agenda-tree-to-indirect-buffer ()
7713 "Show the subtree corresponding to the current entry in an indirect buffer.
7714 This calls the command `org-tree-to-indirect-buffer' from the original
7715 Org-mode buffer.
7716 With numerical prefix arg ARG, go up to this level and then take that tree.
7717 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7718 use the dedicated frame)."
7719 (interactive)
7720 (if (and current-prefix-arg (listp current-prefix-arg))
7721 (org-agenda-do-tree-to-indirect-buffer)
7722 (let ((agenda-window (selected-window))
7723 (indirect-window
7724 (and org-last-indirect-buffer
7725 (get-buffer-window org-last-indirect-buffer))))
7726 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7727 (unwind-protect
7728 (progn
7729 (unless (and indirect-window (window-live-p indirect-window))
7730 (setq indirect-window (split-window agenda-window)))
7731 (select-window indirect-window)
7732 (switch-to-buffer org-last-indirect-buffer :norecord)
7733 (fit-window-to-buffer indirect-window))
7734 (select-window (get-buffer-window org-agenda-buffer-name))))))
7736 (defun org-agenda-do-tree-to-indirect-buffer ()
7737 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7738 (org-agenda-check-no-diary)
7739 (let* ((marker (or (org-get-at-bol 'org-marker)
7740 (org-agenda-error)))
7741 (buffer (marker-buffer marker))
7742 (pos (marker-position marker)))
7743 (with-current-buffer buffer
7744 (save-excursion
7745 (goto-char pos)
7746 (call-interactively 'org-tree-to-indirect-buffer)))))
7748 (defvar org-last-heading-marker (make-marker)
7749 "Marker pointing to the headline that last changed its TODO state
7750 by a remote command from the agenda.")
7752 (defun org-agenda-todo-nextset ()
7753 "Switch TODO entry to next sequence."
7754 (interactive)
7755 (org-agenda-todo 'nextset))
7757 (defun org-agenda-todo-previousset ()
7758 "Switch TODO entry to previous sequence."
7759 (interactive)
7760 (org-agenda-todo 'previousset))
7762 (defun org-agenda-todo (&optional arg)
7763 "Cycle TODO state of line at point, also in Org-mode file.
7764 This changes the line at point, all other lines in the agenda referring to
7765 the same tree node, and the headline of the tree node in the Org-mode file."
7766 (interactive "P")
7767 (org-agenda-check-no-diary)
7768 (let* ((col (current-column))
7769 (marker (or (org-get-at-bol 'org-marker)
7770 (org-agenda-error)))
7771 (buffer (marker-buffer marker))
7772 (pos (marker-position marker))
7773 (hdmarker (org-get-at-bol 'org-hd-marker))
7774 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7775 (inhibit-read-only t)
7776 org-agenda-headline-snapshot-before-repeat newhead just-one)
7777 (org-with-remote-undo buffer
7778 (with-current-buffer buffer
7779 (widen)
7780 (goto-char pos)
7781 (org-show-context 'agenda)
7782 (save-excursion
7783 (and (outline-next-heading)
7784 (org-flag-heading nil))) ; show the next heading
7785 (let ((current-prefix-arg arg))
7786 (call-interactively 'org-todo))
7787 (and (bolp) (forward-char 1))
7788 (setq newhead (org-get-heading))
7789 (when (and (org-bound-and-true-p
7790 org-agenda-headline-snapshot-before-repeat)
7791 (not (equal org-agenda-headline-snapshot-before-repeat
7792 newhead))
7793 todayp)
7794 (setq newhead org-agenda-headline-snapshot-before-repeat
7795 just-one t))
7796 (save-excursion
7797 (org-back-to-heading)
7798 (move-marker org-last-heading-marker (point))))
7799 (beginning-of-line 1)
7800 (save-excursion
7801 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7802 (org-move-to-column col))))
7804 (defun org-agenda-add-note (&optional arg)
7805 "Add a time-stamped note to the entry at point."
7806 (interactive "P")
7807 (org-agenda-check-no-diary)
7808 (let* ((marker (or (org-get-at-bol 'org-marker)
7809 (org-agenda-error)))
7810 (buffer (marker-buffer marker))
7811 (pos (marker-position marker))
7812 (hdmarker (org-get-at-bol 'org-hd-marker))
7813 (inhibit-read-only t))
7814 (with-current-buffer buffer
7815 (widen)
7816 (goto-char pos)
7817 (org-show-context 'agenda)
7818 (save-excursion
7819 (and (outline-next-heading)
7820 (org-flag-heading nil))) ; show the next heading
7821 (org-add-note))))
7823 (defun org-agenda-change-all-lines (newhead hdmarker
7824 &optional fixface just-this)
7825 "Change all lines in the agenda buffer which match HDMARKER.
7826 The new content of the line will be NEWHEAD (as modified by
7827 `org-agenda-format-item'). HDMARKER is checked with
7828 `equal' against all `org-hd-marker' text properties in the file.
7829 If FIXFACE is non-nil, the face of each item is modified according to
7830 the new TODO state.
7831 If JUST-THIS is non-nil, change just the current line, not all.
7832 If FORCE-TAGS is non nil, the car of it returns the new tags."
7833 (let* ((inhibit-read-only t)
7834 (line (org-current-line))
7835 (org-agenda-buffer (current-buffer))
7836 (thetags (with-current-buffer (marker-buffer hdmarker)
7837 (save-excursion (save-restriction (widen)
7838 (goto-char hdmarker)
7839 (org-get-tags-at)))))
7840 props m pl undone-face done-face finish new dotime cat tags)
7841 (save-excursion
7842 (goto-char (point-max))
7843 (beginning-of-line 1)
7844 (while (not finish)
7845 (setq finish (bobp))
7846 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7847 (or (not just-this) (= (org-current-line) line))
7848 (equal m hdmarker))
7849 (setq props (text-properties-at (point))
7850 dotime (org-get-at-bol 'dotime)
7851 cat (org-get-at-bol 'org-category)
7852 tags thetags
7854 (let ((org-prefix-format-compiled
7855 (or (get-text-property (point) 'format)
7856 org-prefix-format-compiled))
7857 (extra (org-get-at-bol 'extra)))
7858 (with-current-buffer (marker-buffer hdmarker)
7859 (save-excursion
7860 (save-restriction
7861 (widen)
7862 (org-agenda-format-item extra newhead cat tags dotime)))))
7863 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
7864 undone-face (org-get-at-bol 'undone-face)
7865 done-face (org-get-at-bol 'done-face))
7866 (beginning-of-line 1)
7867 (cond
7868 ((equal new "")
7869 (and (looking-at ".*\n?") (replace-match "")))
7870 ((looking-at ".*")
7871 (replace-match new t t)
7872 (beginning-of-line 1)
7873 (add-text-properties (point-at-bol) (point-at-eol) props)
7874 (when fixface
7875 (add-text-properties
7876 (point-at-bol) (point-at-eol)
7877 (list 'face
7878 (if org-last-todo-state-is-todo
7879 undone-face done-face))))
7880 (org-agenda-highlight-todo 'line)
7881 (beginning-of-line 1))
7882 (t (error "Line update did not work"))))
7883 (beginning-of-line 0)))
7884 (org-finalize-agenda)))
7886 (defun org-agenda-align-tags (&optional line)
7887 "Align all tags in agenda items to `org-agenda-tags-column'."
7888 (let ((inhibit-read-only t) l c)
7889 (save-excursion
7890 (goto-char (if line (point-at-bol) (point-min)))
7891 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
7892 (if line (point-at-eol) nil) t)
7893 (add-text-properties
7894 (match-beginning 2) (match-end 2)
7895 (list 'face (delq nil (let ((prop (get-text-property
7896 (match-beginning 2) 'face)))
7897 (or (listp prop) (setq prop (list prop)))
7898 (if (memq 'org-tag prop)
7899 prop
7900 (cons 'org-tag prop))))))
7901 (setq l (- (match-end 2) (match-beginning 2))
7902 c (if (< org-agenda-tags-column 0)
7903 (- (abs org-agenda-tags-column) l)
7904 org-agenda-tags-column))
7905 (delete-region (match-beginning 1) (match-end 1))
7906 (goto-char (match-beginning 1))
7907 (insert (org-add-props
7908 (make-string (max 1 (- c (current-column))) ?\ )
7909 (plist-put (copy-sequence (text-properties-at (point)))
7910 'face nil))))
7911 (goto-char (point-min))
7912 (org-font-lock-add-tag-faces (point-max)))))
7914 (defun org-agenda-priority-up ()
7915 "Increase the priority of line at point, also in Org-mode file."
7916 (interactive)
7917 (org-agenda-priority 'up))
7919 (defun org-agenda-priority-down ()
7920 "Decrease the priority of line at point, also in Org-mode file."
7921 (interactive)
7922 (org-agenda-priority 'down))
7924 (defun org-agenda-priority (&optional force-direction)
7925 "Set the priority of line at point, also in Org-mode file.
7926 This changes the line at point, all other lines in the agenda referring to
7927 the same tree node, and the headline of the tree node in the Org-mode file."
7928 (interactive)
7929 (unless org-enable-priority-commands
7930 (error "Priority commands are disabled"))
7931 (org-agenda-check-no-diary)
7932 (let* ((marker (or (org-get-at-bol 'org-marker)
7933 (org-agenda-error)))
7934 (hdmarker (org-get-at-bol 'org-hd-marker))
7935 (buffer (marker-buffer hdmarker))
7936 (pos (marker-position hdmarker))
7937 (inhibit-read-only t)
7938 newhead)
7939 (org-with-remote-undo buffer
7940 (with-current-buffer buffer
7941 (widen)
7942 (goto-char pos)
7943 (org-show-context 'agenda)
7944 (save-excursion
7945 (and (outline-next-heading)
7946 (org-flag-heading nil))) ; show the next heading
7947 (funcall 'org-priority force-direction)
7948 (end-of-line 1)
7949 (setq newhead (org-get-heading)))
7950 (org-agenda-change-all-lines newhead hdmarker)
7951 (beginning-of-line 1))))
7953 ;; FIXME: should fix the tags property of the agenda line.
7954 (defun org-agenda-set-tags (&optional tag onoff)
7955 "Set tags for the current headline."
7956 (interactive)
7957 (org-agenda-check-no-diary)
7958 (if (and (org-region-active-p) (org-called-interactively-p 'any))
7959 (call-interactively 'org-change-tag-in-region)
7960 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7961 (org-agenda-error)))
7962 (buffer (marker-buffer hdmarker))
7963 (pos (marker-position hdmarker))
7964 (inhibit-read-only t)
7965 newhead)
7966 (org-with-remote-undo buffer
7967 (with-current-buffer buffer
7968 (widen)
7969 (goto-char pos)
7970 (save-excursion
7971 (org-show-context 'agenda))
7972 (save-excursion
7973 (and (outline-next-heading)
7974 (org-flag-heading nil))) ; show the next heading
7975 (goto-char pos)
7976 (if tag
7977 (org-toggle-tag tag onoff)
7978 (call-interactively 'org-set-tags))
7979 (end-of-line 1)
7980 (setq newhead (org-get-heading)))
7981 (org-agenda-change-all-lines newhead hdmarker)
7982 (beginning-of-line 1)))))
7984 (defun org-agenda-set-property ()
7985 "Set a property for the current headline."
7986 (interactive)
7987 (org-agenda-check-no-diary)
7988 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7989 (org-agenda-error)))
7990 (buffer (marker-buffer hdmarker))
7991 (pos (marker-position hdmarker))
7992 (inhibit-read-only t)
7993 newhead)
7994 (org-with-remote-undo buffer
7995 (with-current-buffer buffer
7996 (widen)
7997 (goto-char pos)
7998 (save-excursion
7999 (org-show-context 'agenda))
8000 (save-excursion
8001 (and (outline-next-heading)
8002 (org-flag-heading nil))) ; show the next heading
8003 (goto-char pos)
8004 (call-interactively 'org-set-property)))))
8006 (defun org-agenda-set-effort ()
8007 "Set the effort property for the current headline."
8008 (interactive)
8009 (org-agenda-check-no-diary)
8010 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8011 (org-agenda-error)))
8012 (buffer (marker-buffer hdmarker))
8013 (pos (marker-position hdmarker))
8014 (inhibit-read-only t)
8015 newhead)
8016 (org-with-remote-undo buffer
8017 (with-current-buffer buffer
8018 (widen)
8019 (goto-char pos)
8020 (save-excursion
8021 (org-show-context 'agenda))
8022 (save-excursion
8023 (and (outline-next-heading)
8024 (org-flag-heading nil))) ; show the next heading
8025 (goto-char pos)
8026 (call-interactively 'org-set-effort)
8027 (end-of-line 1)
8028 (setq newhead (org-get-heading)))
8029 (org-agenda-change-all-lines newhead hdmarker))))
8031 (defun org-agenda-toggle-archive-tag ()
8032 "Toggle the archive tag for the current entry."
8033 (interactive)
8034 (org-agenda-check-no-diary)
8035 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8036 (org-agenda-error)))
8037 (buffer (marker-buffer hdmarker))
8038 (pos (marker-position hdmarker))
8039 (inhibit-read-only t)
8040 newhead)
8041 (org-with-remote-undo buffer
8042 (with-current-buffer buffer
8043 (widen)
8044 (goto-char pos)
8045 (org-show-context 'agenda)
8046 (save-excursion
8047 (and (outline-next-heading)
8048 (org-flag-heading nil))) ; show the next heading
8049 (call-interactively 'org-toggle-archive-tag)
8050 (end-of-line 1)
8051 (setq newhead (org-get-heading)))
8052 (org-agenda-change-all-lines newhead hdmarker)
8053 (beginning-of-line 1))))
8055 (defun org-agenda-do-date-later (arg)
8056 (interactive "P")
8057 (cond
8058 ((or (equal arg '(16))
8059 (memq last-command
8060 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8061 (setq this-command 'org-agenda-date-later-minutes)
8062 (org-agenda-date-later-minutes 1))
8063 ((or (equal arg '(4))
8064 (memq last-command
8065 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8066 (setq this-command 'org-agenda-date-later-hours)
8067 (org-agenda-date-later-hours 1))
8069 (org-agenda-date-later (prefix-numeric-value arg)))))
8071 (defun org-agenda-do-date-earlier (arg)
8072 (interactive "P")
8073 (cond
8074 ((or (equal arg '(16))
8075 (memq last-command
8076 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8077 (setq this-command 'org-agenda-date-earlier-minutes)
8078 (org-agenda-date-earlier-minutes 1))
8079 ((or (equal arg '(4))
8080 (memq last-command
8081 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8082 (setq this-command 'org-agenda-date-earlier-hours)
8083 (org-agenda-date-earlier-hours 1))
8085 (org-agenda-date-earlier (prefix-numeric-value arg)))))
8087 (defun org-agenda-date-later (arg &optional what)
8088 "Change the date of this item to ARG day(s) later."
8089 (interactive "p")
8090 (org-agenda-check-type t 'agenda 'timeline)
8091 (org-agenda-check-no-diary)
8092 (let* ((marker (or (org-get-at-bol 'org-marker)
8093 (org-agenda-error)))
8094 (buffer (marker-buffer marker))
8095 (pos (marker-position marker))
8096 cdate today)
8097 (org-with-remote-undo buffer
8098 (with-current-buffer buffer
8099 (widen)
8100 (goto-char pos)
8101 (if (not (org-at-timestamp-p))
8102 (error "Cannot find time stamp"))
8103 (when (and org-agenda-move-date-from-past-immediately-to-today
8104 (equal arg 1)
8105 (or (not what) (eq what 'day))
8106 (not (save-match-data (org-at-date-range-p))))
8107 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
8108 cdate (calendar-absolute-from-gregorian
8109 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
8110 today (org-today))
8111 (if (> today cdate)
8112 ;; immediately shift to today
8113 (setq arg (- today cdate))))
8114 (org-timestamp-change arg (or what 'day))
8115 (when (and (org-at-date-range-p)
8116 (re-search-backward org-tr-regexp-both (point-at-bol)))
8117 (let ((end org-last-changed-timestamp))
8118 (org-timestamp-change arg (or what 'day))
8119 (setq org-last-changed-timestamp
8120 (concat org-last-changed-timestamp "--" end)))))
8121 (org-agenda-show-new-time marker org-last-changed-timestamp))
8122 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8124 (defun org-agenda-date-earlier (arg &optional what)
8125 "Change the date of this item to ARG day(s) earlier."
8126 (interactive "p")
8127 (org-agenda-date-later (- arg) what))
8129 (defun org-agenda-date-later-minutes (arg)
8130 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8131 (interactive "p")
8132 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8133 (org-agenda-date-later arg 'minute))
8135 (defun org-agenda-date-earlier-minutes (arg)
8136 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8137 (interactive "p")
8138 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8139 (org-agenda-date-earlier arg 'minute))
8141 (defun org-agenda-date-later-hours (arg)
8142 "Change the time of this item, in hour steps."
8143 (interactive "p")
8144 (org-agenda-date-later arg 'hour))
8146 (defun org-agenda-date-earlier-hours (arg)
8147 "Change the time of this item, in hour steps."
8148 (interactive "p")
8149 (org-agenda-date-earlier arg 'hour))
8151 (defun org-agenda-show-new-time (marker stamp &optional prefix)
8152 "Show new date stamp via text properties."
8153 ;; We use text properties to make this undoable
8154 (let ((inhibit-read-only t)
8155 (buffer-invisibility-spec))
8156 (setq stamp (concat " " prefix " => " stamp))
8157 (save-excursion
8158 (goto-char (point-max))
8159 (while (not (bobp))
8160 (when (equal marker (org-get-at-bol 'org-marker))
8161 (org-move-to-column (- (window-width) (length stamp)) t)
8162 (org-agenda-fix-tags-filter-overlays-at (point))
8163 (if (featurep 'xemacs)
8164 ;; Use `duplicable' property to trigger undo recording
8165 (let ((ex (make-extent nil nil))
8166 (gl (make-glyph stamp)))
8167 (set-glyph-face gl 'secondary-selection)
8168 (set-extent-properties
8169 ex (list 'invisible t 'end-glyph gl 'duplicable t))
8170 (insert-extent ex (1- (point)) (point-at-eol)))
8171 (add-text-properties
8172 (1- (point)) (point-at-eol)
8173 (list 'display (org-add-props stamp nil
8174 'face 'secondary-selection))))
8175 (beginning-of-line 1))
8176 (beginning-of-line 0)))))
8178 (defun org-agenda-date-prompt (arg)
8179 "Change the date of this item. Date is prompted for, with default today.
8180 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8181 be used to request time specification in the time stamp."
8182 (interactive "P")
8183 (org-agenda-check-type t 'agenda 'timeline)
8184 (org-agenda-check-no-diary)
8185 (let* ((marker (or (org-get-at-bol 'org-marker)
8186 (org-agenda-error)))
8187 (buffer (marker-buffer marker))
8188 (pos (marker-position marker)))
8189 (org-with-remote-undo buffer
8190 (with-current-buffer buffer
8191 (widen)
8192 (goto-char pos)
8193 (if (not (org-at-timestamp-p t))
8194 (error "Cannot find time stamp"))
8195 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
8196 (org-agenda-show-new-time marker org-last-changed-timestamp))
8197 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8199 (defun org-agenda-schedule (arg &optional time)
8200 "Schedule the item at point.
8201 ARG is passed through to `org-schedule'."
8202 (interactive "P")
8203 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8204 (org-agenda-check-no-diary)
8205 (let* ((marker (or (org-get-at-bol 'org-marker)
8206 (org-agenda-error)))
8207 (type (marker-insertion-type marker))
8208 (buffer (marker-buffer marker))
8209 (pos (marker-position marker))
8210 (org-insert-labeled-timestamps-at-point nil)
8212 (set-marker-insertion-type marker t)
8213 (org-with-remote-undo buffer
8214 (with-current-buffer buffer
8215 (widen)
8216 (goto-char pos)
8217 (setq ts (org-schedule arg time)))
8218 (org-agenda-show-new-time marker ts "S"))
8219 (message "Item scheduled for %s" ts)))
8221 (defun org-agenda-deadline (arg &optional time)
8222 "Schedule the item at point.
8223 ARG is passed through to `org-deadline'."
8224 (interactive "P")
8225 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8226 (org-agenda-check-no-diary)
8227 (let* ((marker (or (org-get-at-bol 'org-marker)
8228 (org-agenda-error)))
8229 (buffer (marker-buffer marker))
8230 (pos (marker-position marker))
8231 (org-insert-labeled-timestamps-at-point nil)
8233 (org-with-remote-undo buffer
8234 (with-current-buffer buffer
8235 (widen)
8236 (goto-char pos)
8237 (setq ts (org-deadline arg time)))
8238 (org-agenda-show-new-time marker ts "D"))
8239 (message "Deadline for this item set to %s" ts)))
8241 (defun org-agenda-action ()
8242 "Select entry for agenda action, or execute an agenda action.
8243 This command prompts for another letter. Valid inputs are:
8245 m Mark the entry at point for an agenda action
8246 s Schedule the marked entry to the date at the cursor
8247 d Set the deadline of the marked entry to the date at the cursor
8248 r Call `org-remember' with cursor date as the default date
8249 c Call `org-capture' with cursor date as the default date
8250 SPC Show marked entry in other window
8251 TAB Visit marked entry in other window
8253 The cursor may be at a date in the calendar, or in the Org agenda."
8254 (interactive)
8255 (let (ans)
8256 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
8257 (setq ans (read-char-exclusive))
8258 (cond
8259 ((equal ans ?m)
8260 ;; Mark this entry
8261 (if (eq major-mode 'org-agenda-mode)
8262 (let ((m (or (org-get-at-bol 'org-hd-marker)
8263 (org-get-at-bol 'org-marker))))
8264 (if m
8265 (progn
8266 (move-marker org-agenda-action-marker
8267 (marker-position m) (marker-buffer m))
8268 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
8269 (error "Don't know which entry to mark")))
8270 (error "This command works only in the agenda")))
8271 ((equal ans ?s)
8272 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
8273 ((equal ans ?d)
8274 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
8275 ((equal ans ?r)
8276 (org-agenda-do-action '(org-remember) t))
8277 ((equal ans ?c)
8278 (org-agenda-do-action '(org-capture) t))
8279 ((equal ans ?\ )
8280 (let ((cw (selected-window)))
8281 (org-switch-to-buffer-other-window
8282 (marker-buffer org-agenda-action-marker))
8283 (goto-char org-agenda-action-marker)
8284 (org-show-context 'agenda)
8285 (select-window cw)))
8286 ((equal ans ?\C-i)
8287 (org-switch-to-buffer-other-window
8288 (marker-buffer org-agenda-action-marker))
8289 (goto-char org-agenda-action-marker)
8290 (org-show-context 'agenda))
8291 (t (error "Invalid agenda action %c" ans)))))
8293 (defun org-agenda-do-action (form &optional current-buffer)
8294 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
8295 (let ((org-overriding-default-time (org-get-cursor-date)))
8296 (if current-buffer
8297 (eval form)
8298 (if (not (marker-buffer org-agenda-action-marker))
8299 (error "No entry has been selected for agenda action")
8300 (with-current-buffer (marker-buffer org-agenda-action-marker)
8301 (save-excursion
8302 (save-restriction
8303 (widen)
8304 (goto-char org-agenda-action-marker)
8305 (eval form))))))))
8307 (defun org-agenda-clock-in (&optional arg)
8308 "Start the clock on the currently selected item."
8309 (interactive "P")
8310 (org-agenda-check-no-diary)
8311 (if (equal arg '(4))
8312 (org-clock-in arg)
8313 (let* ((marker (or (org-get-at-bol 'org-marker)
8314 (org-agenda-error)))
8315 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8316 marker))
8317 (pos (marker-position marker))
8318 newhead)
8319 (org-with-remote-undo (marker-buffer marker)
8320 (with-current-buffer (marker-buffer marker)
8321 (widen)
8322 (goto-char pos)
8323 (org-show-context 'agenda)
8324 (org-show-entry)
8325 (org-cycle-hide-drawers 'children)
8326 (org-clock-in arg)
8327 (setq newhead (org-get-heading)))
8328 (org-agenda-change-all-lines newhead hdmarker)))))
8330 (defun org-agenda-clock-out ()
8331 "Stop the currently running clock."
8332 (interactive)
8333 (unless (marker-buffer org-clock-marker)
8334 (error "No running clock"))
8335 (let ((marker (make-marker)) newhead)
8336 (org-with-remote-undo (marker-buffer org-clock-marker)
8337 (with-current-buffer (marker-buffer org-clock-marker)
8338 (save-excursion
8339 (save-restriction
8340 (widen)
8341 (goto-char org-clock-marker)
8342 (org-back-to-heading t)
8343 (move-marker marker (point))
8344 (org-clock-out)
8345 (setq newhead (org-get-heading))))))
8346 (org-agenda-change-all-lines newhead marker)
8347 (move-marker marker nil)))
8349 (defun org-agenda-clock-cancel (&optional arg)
8350 "Cancel the currently running clock."
8351 (interactive "P")
8352 (unless (marker-buffer org-clock-marker)
8353 (error "No running clock"))
8354 (org-with-remote-undo (marker-buffer org-clock-marker)
8355 (org-clock-cancel)))
8357 (defun org-agenda-clock-goto ()
8358 "Jump to the currently clocked in task within the agenda.
8359 If the currently clocked in task is not listed in the agenda
8360 buffer, display it in another window."
8361 (interactive)
8362 (let (pos)
8363 (mapc (lambda (o)
8364 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8365 (setq pos (overlay-start o))))
8366 (overlays-in (point-min) (point-max)))
8367 (cond (pos (goto-char pos))
8368 ;; If the currently clocked entry is not in the agenda
8369 ;; buffer, we visit it in another window:
8370 (org-clock-current-task
8371 (org-switch-to-buffer-other-window (org-clock-goto)))
8372 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8374 (defun org-agenda-diary-entry-in-org-file ()
8375 "Make a diary entry in the file `org-agenda-diary-file'."
8376 (let (d1 d2 char (text "") dp1 dp2)
8377 (if (equal (buffer-name) "*Calendar*")
8378 (setq d1 (calendar-cursor-to-date t)
8379 d2 (car calendar-mark-ring))
8380 (setq dp1 (get-text-property (point-at-bol) 'day))
8381 (unless dp1 (error "No date defined in current line"))
8382 (setq d1 (calendar-gregorian-from-absolute dp1)
8383 d2 (and (ignore-errors (mark))
8384 (save-excursion
8385 (goto-char (mark))
8386 (setq dp2 (get-text-property (point-at-bol) 'day)))
8387 (calendar-gregorian-from-absolute dp2))))
8388 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8389 (setq char (read-char-exclusive))
8390 (cond
8391 ((equal char ?d)
8392 (setq text (read-string "Day entry: "))
8393 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8394 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8395 ((equal char ?a)
8396 (setq d1 (list (car d1) (nth 1 d1)
8397 (read-number (format "Reference year [%d]: " (nth 2 d1))
8398 (nth 2 d1))))
8399 (setq text (read-string "Anniversary (use %d to show years): "))
8400 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8401 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8402 ((equal char ?b)
8403 (setq text (read-string "Block entry: "))
8404 (unless (and d1 d2 (not (equal d1 d2)))
8405 (error "No block of days selected"))
8406 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8407 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8408 ((equal char ?j)
8409 (org-switch-to-buffer-other-window
8410 (find-file-noselect org-agenda-diary-file))
8411 (require 'org-datetree)
8412 (org-datetree-find-date-create d1)
8413 (org-reveal t))
8414 (t (error "Invalid selection character `%c'" char)))))
8416 (defcustom org-agenda-insert-diary-strategy 'date-tree
8417 "Where in `org-agenda-diary-file' should new entries be added?
8418 Valid values:
8420 date-tree in the date tree, as child of the date
8421 top-level as top-level entries at the end of the file."
8422 :group 'org-agenda
8423 :type '(choice
8424 (const :tag "in a date tree" date-tree)
8425 (const :tag "as top level at end of file" top-level)))
8427 (defcustom org-agenda-insert-diary-extract-time nil
8428 "Non-nil means extract any time specification from the diary entry."
8429 :group 'org-agenda
8430 :version "24.1"
8431 :type 'boolean)
8433 (defcustom org-agenda-bulk-mark-char ">"
8434 "A single-character string to be used as the bulk mark."
8435 :group 'org-agenda
8436 :version "24.1"
8437 :type 'string)
8439 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8440 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8441 If TEXT is not empty, it will become the headline of the new entry, and
8442 the resulting entry will not be shown. When TEXT is empty, switch to
8443 `org-agenda-diary-file' and let the user finish the entry there."
8444 (let ((cw (current-window-configuration)))
8445 (org-switch-to-buffer-other-window
8446 (find-file-noselect org-agenda-diary-file))
8447 (widen)
8448 (goto-char (point-min))
8449 (cond
8450 ((eq type 'anniversary)
8451 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8452 (progn
8453 (or (org-at-heading-p t)
8454 (progn
8455 (outline-next-heading)
8456 (insert "* Anniversaries\n\n")
8457 (beginning-of-line -1)))))
8458 (outline-next-heading)
8459 (org-back-over-empty-lines)
8460 (backward-char 1)
8461 (insert "\n")
8462 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8463 (nth 2 d1) (car d1) (nth 1 d1) text)))
8464 ((eq type 'day)
8465 (let ((org-prefix-has-time t)
8466 (org-agenda-time-leading-zero t)
8467 fmt time time2)
8468 (if org-agenda-insert-diary-extract-time
8469 ;; Use org-agenda-format-item to parse text for a time-range and
8470 ;; remove it. FIXME: This is a hack, we should refactor
8471 ;; that function to make time extraction available separately
8472 (setq fmt (org-agenda-format-item nil text nil nil t)
8473 time (get-text-property 0 'time fmt)
8474 time2 (if (> (length time) 0)
8475 ;; split-string removes trailing ...... if
8476 ;; no end time given. First space
8477 ;; separates time from date.
8478 (concat " " (car (split-string time "\\.")))
8479 nil)
8480 text (get-text-property 0 'txt fmt)))
8481 (if (eq org-agenda-insert-diary-strategy 'top-level)
8482 (org-agenda-insert-diary-as-top-level text)
8483 (require 'org-datetree)
8484 (org-datetree-find-date-create d1)
8485 (org-agenda-insert-diary-make-new-entry text))
8486 (org-insert-time-stamp (org-time-from-absolute
8487 (calendar-absolute-from-gregorian d1))
8488 nil nil nil nil time2))
8489 (end-of-line 0))
8490 ((eq type 'block)
8491 (if (> (calendar-absolute-from-gregorian d1)
8492 (calendar-absolute-from-gregorian d2))
8493 (setq d1 (prog1 d2 (setq d2 d1))))
8494 (if (eq org-agenda-insert-diary-strategy 'top-level)
8495 (org-agenda-insert-diary-as-top-level text)
8496 (require 'org-datetree)
8497 (org-datetree-find-date-create d1)
8498 (org-agenda-insert-diary-make-new-entry text))
8499 (org-insert-time-stamp (org-time-from-absolute
8500 (calendar-absolute-from-gregorian d1)))
8501 (insert "--")
8502 (org-insert-time-stamp (org-time-from-absolute
8503 (calendar-absolute-from-gregorian d2)))
8504 (end-of-line 0)))
8505 (if (string-match "\\S-" text)
8506 (progn
8507 (set-window-configuration cw)
8508 (message "%s entry added to %s"
8509 (capitalize (symbol-name type))
8510 (abbreviate-file-name org-agenda-diary-file)))
8511 (org-reveal t)
8512 (message "Please finish entry here"))))
8514 (defun org-agenda-insert-diary-as-top-level (text)
8515 "Make new entry as a top-level entry at the end of the file.
8516 Add TEXT as headline, and position the cursor in the second line so that
8517 a timestamp can be added there."
8518 (widen)
8519 (goto-char (point-max))
8520 (or (bolp) (insert "\n"))
8521 (insert "* " text "\n")
8522 (if org-adapt-indentation (org-indent-to-column 2)))
8524 (defun org-agenda-insert-diary-make-new-entry (text)
8525 "Make new entry as last child of current entry.
8526 Add TEXT as headline, and position the cursor in the second line so that
8527 a timestamp can be added there."
8528 (let ((org-show-following-heading t)
8529 (org-show-siblings t)
8530 (org-show-hierarchy-above t)
8531 (org-show-entry-below t)
8532 col)
8533 (outline-next-heading)
8534 (org-back-over-empty-lines)
8535 (or (looking-at "[ \t]*$")
8536 (progn (insert "\n") (backward-char 1)))
8537 (org-insert-heading nil t)
8538 (org-do-demote)
8539 (setq col (current-column))
8540 (insert text "\n")
8541 (if org-adapt-indentation (org-indent-to-column col))
8542 (let ((org-show-following-heading t)
8543 (org-show-siblings t)
8544 (org-show-hierarchy-above t)
8545 (org-show-entry-below t))
8546 (org-show-context))))
8548 (defun org-agenda-diary-entry ()
8549 "Make a diary entry, like the `i' command from the calendar.
8550 All the standard commands work: block, weekly etc.
8551 When `org-agenda-diary-file' points to a file,
8552 `org-agenda-diary-entry-in-org-file' is called instead to create
8553 entries in that Org-mode file."
8554 (interactive)
8555 (org-agenda-check-type t 'agenda 'timeline)
8556 (if (not (eq org-agenda-diary-file 'diary-file))
8557 (org-agenda-diary-entry-in-org-file)
8558 (require 'diary-lib)
8559 (let* ((char (progn
8560 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8561 (read-char-exclusive)))
8562 (cmd (cdr (assoc char
8563 '((?d . insert-diary-entry)
8564 (?w . insert-weekly-diary-entry)
8565 (?m . insert-monthly-diary-entry)
8566 (?y . insert-yearly-diary-entry)
8567 (?a . insert-anniversary-diary-entry)
8568 (?b . insert-block-diary-entry)
8569 (?c . insert-cyclic-diary-entry)))))
8570 (oldf (symbol-function 'calendar-cursor-to-date))
8571 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8572 (point (point))
8573 (mark (or (mark t) (point))))
8574 (unless cmd
8575 (error "No command associated with <%c>" char))
8576 (unless (and (get-text-property point 'day)
8577 (or (not (equal ?b char))
8578 (get-text-property mark 'day)))
8579 (error "Don't know which date to use for diary entry"))
8580 ;; We implement this by hacking the `calendar-cursor-to-date' function
8581 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8582 (let ((calendar-mark-ring
8583 (list (calendar-gregorian-from-absolute
8584 (or (get-text-property mark 'day)
8585 (get-text-property point 'day))))))
8586 (unwind-protect
8587 (progn
8588 (fset 'calendar-cursor-to-date
8589 (lambda (&optional error dummy)
8590 (calendar-gregorian-from-absolute
8591 (get-text-property point 'day))))
8592 (call-interactively cmd))
8593 (fset 'calendar-cursor-to-date oldf))))))
8595 (defun org-agenda-execute-calendar-command (cmd)
8596 "Execute a calendar command from the agenda, with the date associated to
8597 the cursor position."
8598 (org-agenda-check-type t 'agenda 'timeline)
8599 (require 'diary-lib)
8600 (unless (get-text-property (point) 'day)
8601 (error "Don't know which date to use for calendar command"))
8602 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8603 (point (point))
8604 (date (calendar-gregorian-from-absolute
8605 (get-text-property point 'day)))
8606 ;; the following 2 vars are needed in the calendar
8607 (displayed-month (car date))
8608 (displayed-year (nth 2 date)))
8609 (unwind-protect
8610 (progn
8611 (fset 'calendar-cursor-to-date
8612 (lambda (&optional error dummy)
8613 (calendar-gregorian-from-absolute
8614 (get-text-property point 'day))))
8615 (call-interactively cmd))
8616 (fset 'calendar-cursor-to-date oldf))))
8618 (defun org-agenda-phases-of-moon ()
8619 "Display the phases of the moon for the 3 months around the cursor date."
8620 (interactive)
8621 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8623 (defun org-agenda-holidays ()
8624 "Display the holidays for the 3 months around the cursor date."
8625 (interactive)
8626 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8628 (defvar calendar-longitude)
8629 (defvar calendar-latitude)
8630 (defvar calendar-location-name)
8632 (defun org-agenda-sunrise-sunset (arg)
8633 "Display sunrise and sunset for the cursor date.
8634 Latitude and longitude can be specified with the variables
8635 `calendar-latitude' and `calendar-longitude'. When called with prefix
8636 argument, latitude and longitude will be prompted for."
8637 (interactive "P")
8638 (require 'solar)
8639 (let ((calendar-longitude (if arg nil calendar-longitude))
8640 (calendar-latitude (if arg nil calendar-latitude))
8641 (calendar-location-name
8642 (if arg "the given coordinates" calendar-location-name)))
8643 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8645 (defun org-agenda-goto-calendar ()
8646 "Open the Emacs calendar with the date at the cursor."
8647 (interactive)
8648 (org-agenda-check-type t 'agenda 'timeline)
8649 (let* ((day (or (get-text-property (point) 'day)
8650 (error "Don't know which date to open in calendar")))
8651 (date (calendar-gregorian-from-absolute day))
8652 (calendar-move-hook nil)
8653 (calendar-view-holidays-initially-flag nil)
8654 (calendar-view-diary-initially-flag nil))
8655 (calendar)
8656 (calendar-goto-date date)))
8658 ;;;###autoload
8659 (defun org-calendar-goto-agenda ()
8660 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8661 This is a command that has to be installed in `calendar-mode-map'."
8662 (interactive)
8663 (org-agenda-list nil (calendar-absolute-from-gregorian
8664 (calendar-cursor-to-date))
8665 nil))
8667 (defun org-agenda-convert-date ()
8668 (interactive)
8669 (org-agenda-check-type t 'agenda 'timeline)
8670 (let ((day (get-text-property (point) 'day))
8671 date s)
8672 (unless day
8673 (error "Don't know which date to convert"))
8674 (setq date (calendar-gregorian-from-absolute day))
8675 (setq s (concat
8676 "Gregorian: " (calendar-date-string date) "\n"
8677 "ISO: " (calendar-iso-date-string date) "\n"
8678 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8679 "Julian: " (calendar-julian-date-string date) "\n"
8680 "Astron. JD: " (calendar-astro-date-string date)
8681 " (Julian date number at noon UTC)\n"
8682 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8683 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8684 "French: " (calendar-french-date-string date) "\n"
8685 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8686 "Mayan: " (calendar-mayan-date-string date) "\n"
8687 "Coptic: " (calendar-coptic-date-string date) "\n"
8688 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8689 "Persian: " (calendar-persian-date-string date) "\n"
8690 "Chinese: " (calendar-chinese-date-string date) "\n"))
8691 (with-output-to-temp-buffer "*Dates*"
8692 (princ s))
8693 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8695 ;;; Bulk commands
8697 (defvar org-agenda-bulk-marked-entries nil
8698 "List of markers that refer to marked entries in the agenda.")
8700 (defun org-agenda-bulk-marked-p ()
8701 (eq (get-char-property (point-at-bol) 'type)
8702 'org-marked-entry-overlay))
8704 (defun org-agenda-bulk-mark (&optional arg)
8705 "Mark the entry at point for future bulk action."
8706 (interactive "p")
8707 (dotimes (i (or arg 1))
8708 (unless (org-get-at-bol 'org-agenda-diary-link)
8709 (let* ((m (org-get-at-bol 'org-hd-marker))
8711 (unless (org-agenda-bulk-marked-p)
8712 (unless m (error "Nothing to mark at point"))
8713 (push m org-agenda-bulk-marked-entries)
8714 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8715 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
8716 (org-get-todo-face "TODO")
8717 'evaporate)
8718 (overlay-put ov 'type 'org-marked-entry-overlay))
8719 (beginning-of-line 2)
8720 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8721 (beginning-of-line 2))
8722 (message "%d entries marked for bulk action"
8723 (length org-agenda-bulk-marked-entries))))))
8725 (defun org-agenda-bulk-mark-all ()
8726 "Mark all entries for future agenda bulk action."
8727 (interactive)
8728 (org-agenda-bulk-mark-regexp "."))
8730 (defun org-agenda-bulk-mark-regexp (regexp)
8731 "Mark entries matching REGEXP for future agenda bulk action."
8732 (interactive "sMark entries matching regexp: ")
8733 (let ((entries-marked 0))
8734 (save-excursion
8735 (goto-char (point-min))
8736 (goto-char (next-single-property-change (point) 'txt))
8737 (while (re-search-forward regexp nil t)
8738 (when (string-match regexp (get-text-property (point) 'txt))
8739 (setq entries-marked (1+ entries-marked))
8740 (call-interactively 'org-agenda-bulk-mark))))
8741 (if (not entries-marked)
8742 (message "No entry matching this regexp."))))
8744 (defun org-agenda-bulk-unmark (&optional arg)
8745 "Unmark the entry at point for future bulk action."
8746 (interactive "P")
8747 (if arg
8748 (org-agenda-bulk-unmark-all)
8749 (cond ((org-agenda-bulk-marked-p)
8750 (org-agenda-bulk-remove-overlays
8751 (point-at-bol) (+ 2 (point-at-bol)))
8752 (setq org-agenda-bulk-marked-entries
8753 (delete (org-get-at-bol 'org-hd-marker)
8754 org-agenda-bulk-marked-entries))
8755 (beginning-of-line 2)
8756 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8757 (beginning-of-line 2))
8758 (message "%d entries left marked for bulk action"
8759 (length org-agenda-bulk-marked-entries)))
8760 (t (message "No entry to unmark here")))))
8762 (defun org-agenda-bulk-toggle ()
8763 "Toggle marking the entry at point for bulk action."
8764 (interactive)
8765 (if (org-agenda-bulk-marked-p)
8766 (org-agenda-bulk-unmark)
8767 (org-agenda-bulk-mark)))
8769 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8770 "Remove the mark overlays between BEG and END in the agenda buffer.
8771 BEG and END default to the buffer limits.
8773 This only removes the overlays, it does not remove the markers
8774 from the list in `org-agenda-bulk-marked-entries'."
8775 (interactive)
8776 (mapc (lambda (ov)
8777 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8778 (delete-overlay ov)))
8779 (overlays-in (or beg (point-min)) (or end (point-max)))))
8781 (defun org-agenda-bulk-unmark-all ()
8782 "Remove all marks in the agenda buffer.
8783 This will remove the markers and the overlays."
8784 (interactive)
8785 (if (null org-agenda-bulk-marked-entries)
8786 (message "No entry to unmark")
8787 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8788 (setq org-agenda-bulk-marked-entries nil)
8789 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
8791 (defcustom org-agenda-persistent-marks nil
8792 "Non-nil means marked items will stay marked after a bulk action.
8793 You can toggle this interactively by typing `p' when prompted for a
8794 bulk action."
8795 :group 'org-agenda
8796 :version "24.1"
8797 :type 'boolean)
8799 (defun org-agenda-bulk-action (&optional arg)
8800 "Execute an remote-editing action on all marked entries.
8801 The prefix arg is passed through to the command if possible."
8802 (interactive "P")
8803 ;; Make sure we have markers, and only valid ones
8804 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8805 (mapc
8806 (lambda (m)
8807 (unless (and (markerp m)
8808 (marker-buffer m)
8809 (buffer-live-p (marker-buffer m))
8810 (marker-position m))
8811 (error "Marker %s for bulk command is invalid" m)))
8812 org-agenda-bulk-marked-entries)
8814 ;; Prompt for the bulk command
8815 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
8816 (message (concat msg "[r]efile [$]arch [A]rch->sib [t]odo"
8817 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction "
8818 (when org-agenda-bulk-custom-functions
8819 (concat " Custom: ["
8820 (mapconcat (lambda(f) (char-to-string (car f)))
8821 org-agenda-bulk-custom-functions "")
8822 "]"))))
8823 (catch 'exit
8824 (let* ((action (read-char-exclusive))
8825 (org-log-refile (if org-log-refile 'time nil))
8826 (entries (reverse org-agenda-bulk-marked-entries))
8827 redo-at-end
8828 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8829 (cond
8830 ((equal action ?p)
8831 (let ((org-agenda-persistent-marks
8832 (not org-agenda-persistent-marks)))
8833 (org-agenda-bulk-action)
8834 (throw 'exit nil)))
8836 ((equal action ?$)
8837 (setq cmd '(org-agenda-archive)))
8839 ((equal action ?A)
8840 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8842 ((member action '(?r ?w))
8843 (setq rfloc (org-refile-get-location
8844 "Refile to"
8845 (marker-buffer (car org-agenda-bulk-marked-entries))
8846 org-refile-allow-creating-parent-nodes))
8847 (if (nth 3 rfloc)
8848 (setcar (nthcdr 3 rfloc)
8849 (move-marker (make-marker) (nth 3 rfloc)
8850 (or (get-file-buffer (nth 1 rfloc))
8851 (find-buffer-visiting (nth 1 rfloc))
8852 (error "This should not happen")))))
8854 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8855 redo-at-end t))
8857 ((equal action ?t)
8858 (setq state (org-icompleting-read
8859 "Todo state: "
8860 (with-current-buffer (marker-buffer (car entries))
8861 (mapcar 'list org-todo-keywords-1))))
8862 (setq cmd `(let ((org-inhibit-blocking t)
8863 (org-inhibit-logging 'note))
8864 (org-agenda-todo ,state))))
8866 ((memq action '(?- ?+))
8867 (setq tag (org-icompleting-read
8868 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8869 (with-current-buffer (marker-buffer (car entries))
8870 (delq nil
8871 (mapcar (lambda (x)
8872 (if (stringp (car x)) x)) org-tag-alist)))))
8873 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8875 ((memq action '(?s ?d))
8876 (let* ((date (unless arg
8877 (org-read-date
8878 nil nil nil
8879 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
8880 (ans (if arg nil org-read-date-final-answer))
8881 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8882 (setq cmd `(let* ((bound (fboundp 'read-string))
8883 (old (and bound (symbol-function 'read-string))))
8884 (unwind-protect
8885 (progn
8886 (fset 'read-string (lambda (&rest ignore) ,ans))
8887 (eval '(,c1 arg)))
8888 (if bound
8889 (fset 'read-string old)
8890 (fmakunbound 'read-string)))))))
8892 ((equal action ?S)
8893 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8894 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8895 (let ((days (read-number
8896 (format "Scatter tasks across how many %sdays: "
8897 (if arg "week" "")) 7)))
8898 (setq cmd
8899 `(let ((distance (1+ (random ,days))))
8900 (if arg
8901 (let ((dist distance)
8902 (day-of-week
8903 (calendar-day-of-week
8904 (calendar-gregorian-from-absolute (org-today)))))
8905 (dotimes (i (1+ dist))
8906 (while (member day-of-week org-agenda-weekend-days)
8907 (incf distance)
8908 (incf day-of-week)
8909 (if (= day-of-week 7)
8910 (setq day-of-week 0)))
8911 (incf day-of-week)
8912 (if (= day-of-week 7)
8913 (setq day-of-week 0)))))
8914 ;; silently fail when try to replan a sexp entry
8915 (condition-case nil
8916 (let* ((date (calendar-gregorian-from-absolute
8917 (+ (org-today) distance)))
8918 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8919 (nth 2 date))))
8920 (org-agenda-schedule nil time))
8921 (error nil)))))))
8923 ((assoc action org-agenda-bulk-custom-functions)
8924 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
8925 redo-at-end t))
8927 ((equal action ?f)
8928 (setq cmd (list (intern
8929 (org-icompleting-read "Function: "
8930 obarray 'fboundp t nil nil)))))
8932 (t (error "Invalid bulk action")))
8934 ;; Sort the markers, to make sure that parents are handled before children
8935 (setq entries (sort entries
8936 (lambda (a b)
8937 (cond
8938 ((equal (marker-buffer a) (marker-buffer b))
8939 (< (marker-position a) (marker-position b)))
8941 (string< (buffer-name (marker-buffer a))
8942 (buffer-name (marker-buffer b))))))))
8944 ;; Now loop over all markers and apply cmd
8945 (while (setq e (pop entries))
8946 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
8947 (if (not pos)
8948 (progn (message "Skipping removed entry at %s" e)
8949 (setq cntskip (1+ cntskip)))
8950 (goto-char pos)
8951 (let (org-loop-over-headlines-in-active-region)
8952 (eval cmd))
8953 (when (not org-agenda-persistent-marks)
8954 (setq org-agenda-bulk-marked-entries
8955 (delete e org-agenda-bulk-marked-entries)))
8956 (setq cnt (1+ cnt))))
8957 (when (not org-agenda-persistent-marks)
8958 (org-agenda-bulk-unmark-all))
8959 (when redo-at-end (org-agenda-redo))
8960 (message "Acted on %d entries%s%s"
8962 (if (= cntskip 0)
8964 (format ", skipped %d (disappeared before their turn)"
8965 cntskip))
8966 (if (not org-agenda-persistent-marks)
8967 "" " (kept marked)"))))))
8969 ;;; Flagging notes
8971 (defun org-agenda-show-the-flagging-note ()
8972 "Display the flagging note in the other window.
8973 When called a second time in direct sequence, offer to remove the FLAGGING
8974 tag and (if present) the flagging note."
8975 (interactive)
8976 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
8977 (win (selected-window))
8978 note heading newhead)
8979 (unless hdmarker
8980 (error "No linked entry at point"))
8981 (if (and (eq this-command last-command)
8982 (y-or-n-p "Unflag and remove any flagging note? "))
8983 (progn
8984 (org-agenda-remove-flag hdmarker)
8985 (let ((win (get-buffer-window "*Flagging Note*")))
8986 (and win (delete-window win)))
8987 (message "Entry unflagged"))
8988 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
8989 (unless note
8990 (error "No flagging note"))
8991 (org-kill-new note)
8992 (org-switch-to-buffer-other-window "*Flagging Note*")
8993 (erase-buffer)
8994 (insert note)
8995 (goto-char (point-min))
8996 (while (re-search-forward "\\\\n" nil t)
8997 (replace-match "\n" t t))
8998 (goto-char (point-min))
8999 (select-window win)
9000 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9002 (defun org-agenda-remove-flag (marker)
9003 "Remove the FLAGGED tag and any flagging note in the entry."
9004 (let (newhead)
9005 (org-with-point-at marker
9006 (org-toggle-tag "FLAGGED" 'off)
9007 (org-entry-delete nil "THEFLAGGINGNOTE")
9008 (setq newhead (org-get-heading)))
9009 (org-agenda-change-all-lines newhead marker)
9010 (message "Entry unflagged")))
9012 (defun org-agenda-get-any-marker (&optional pos)
9013 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9014 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9016 ;;; Appointment reminders
9018 (defvar appt-time-msg-list)
9020 ;;;###autoload
9021 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9022 "Activate appointments found in `org-agenda-files'.
9023 With a \\[universal-argument] prefix, refresh the list of
9024 appointments.
9026 If FILTER is t, interactively prompt the user for a regular
9027 expression, and filter out entries that don't match it.
9029 If FILTER is a string, use this string as a regular expression
9030 for filtering entries out.
9032 If FILTER is a function, filter out entries against which
9033 calling the function returns nil. This function takes one
9034 argument: an entry from `org-agenda-get-day-entries'.
9036 FILTER can also be an alist with the car of each cell being
9037 either 'headline or 'category. For example:
9039 '((headline \"IMPORTANT\")
9040 (category \"Work\"))
9042 will only add headlines containing IMPORTANT or headlines
9043 belonging to the \"Work\" category.
9045 ARGS are symbols indicating what kind of entries to consider.
9046 By default `org-agenda-to-appt' will use :deadline, :scheduled
9047 and :timestamp entries. See the docstring of `org-diary' for
9048 details and examples.
9050 If an entry as a APPT_WARNTIME property, its value will be used
9051 to override `appt-message-warning-time'."
9052 (interactive "P")
9053 (if refresh (setq appt-time-msg-list nil))
9054 (if (eq filter t)
9055 (setq filter (read-from-minibuffer "Regexp filter: ")))
9056 (let* ((cnt 0) ; count added events
9057 (scope (or args '(:deadline :scheduled :timestamp)))
9058 (org-agenda-new-buffers nil)
9059 (org-deadline-warning-days 0)
9060 ;; Do not use `org-today' here because appt only takes
9061 ;; time and without date as argument, so it may pass wrong
9062 ;; information otherwise
9063 (today (org-date-to-gregorian
9064 (time-to-days (current-time))))
9065 (org-agenda-restrict nil)
9066 (files (org-agenda-files 'unrestricted)) entries file
9067 (org-agenda-buffer nil))
9068 ;; Get all entries which may contain an appt
9069 (org-prepare-agenda-buffers files)
9070 (while (setq file (pop files))
9071 (setq entries
9072 (delq nil
9073 (append entries
9074 (apply 'org-agenda-get-day-entries
9075 file today scope)))))
9076 ;; Map thru entries and find if we should filter them out
9077 (mapc
9078 (lambda(x)
9079 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
9080 (cat (get-text-property 1 'org-category x))
9081 (tod (get-text-property 1 'time-of-day x))
9082 (ok (or (null filter)
9083 (and (stringp filter) (string-match filter evt))
9084 (and (functionp filter) (funcall filter x))
9085 (and (listp filter)
9086 (let ((cat-filter (cadr (assoc 'category filter)))
9087 (evt-filter (cadr (assoc 'headline filter))))
9088 (or (and (stringp cat-filter)
9089 (string-match cat-filter cat))
9090 (and (stringp evt-filter)
9091 (string-match evt-filter evt)))))))
9092 (wrn (get-text-property 1 'warntime x)))
9093 ;; FIXME: Shall we remove text-properties for the appt text?
9094 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
9095 (when (and ok tod)
9096 (setq tod (concat "00" (number-to-string tod))
9097 tod (when (string-match
9098 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
9099 (concat (match-string 1 tod) ":"
9100 (match-string 2 tod))))
9101 (if (version< emacs-version "23.3")
9102 (appt-add tod evt)
9103 (appt-add tod evt wrn))
9104 (setq cnt (1+ cnt))))) entries)
9105 (org-release-buffers org-agenda-new-buffers)
9106 (if (eq cnt 0)
9107 (message "No event to add")
9108 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
9110 (defun org-agenda-todayp (date)
9111 "Does DATE mean today, when considering `org-extend-today-until'?"
9112 (let ((today (org-today))
9113 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
9114 date)))
9115 (eq date today)))
9117 (defun org-agenda-todo-yesterday (&optional arg)
9118 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
9119 (interactive "P")
9120 (let* ((hour (third (decode-time
9121 (org-current-time))))
9122 (org-extend-today-until (1+ hour)))
9123 (org-agenda-todo arg)))
9125 (provide 'org-agenda)
9127 ;;; org-agenda.el ends here