org-agenda.el: Rewrite of the redo/change/append commands
[org-mode.git] / lisp / org-agenda.el
blob2c7197b0e19c95d7588bd6b73f9f5e76f23249e9
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
1853 ;;; Multiple agenda buffers support
1855 (defcustom org-agenda-sticky nil
1856 "Non-nil means agenda q key will bury agenda buffers.
1857 Agenda commands will then show existing buffer instead of generating new ones.
1858 When nil, `q' will kill the single agenda buffer."
1859 :group 'org-agenda
1860 :type 'boolean
1861 :set (lambda (var val)
1862 (if (boundp var)
1863 (org-toggle-sticky-agenda (if val 1 0))
1864 (set var val))))
1866 ;;;###autoload
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-info
1905 org-agenda-tag-filter-overlays
1906 org-agenda-cat-filter-overlays
1907 org-agenda-pre-window-conf
1908 org-agenda-columns-active
1909 org-agenda-tag-filter
1910 org-agenda-category-filter
1911 org-agenda-markers
1912 org-agenda-last-search-view-search-was-boolean
1913 org-agenda-filtered-by-category
1914 org-agenda-filter-form
1915 org-agenda-show-window
1916 org-agenda-cycle-counter
1917 org-agenda-last-prefix-arg)
1918 "Variables that must be local in agenda buffers to allow multiple buffers.")
1920 (defun org-agenda-mode ()
1921 "Mode for time-sorted view on action items in Org-mode files.
1923 The following commands are available:
1925 \\{org-agenda-mode-map}"
1926 (interactive)
1927 (cond (org-agenda-doing-sticky-redo
1928 ;; Refreshing sticky agenda-buffer
1930 ;; Preserve the value of `org-agenda-local-vars' variables,
1931 ;; while letting `kill-all-local-variables' kill the rest
1932 (let ((save (buffer-local-variables)))
1933 (kill-all-local-variables)
1934 (mapc 'make-local-variable org-agenda-local-vars)
1935 (dolist (elem save)
1936 (let ((var (car elem))
1937 (val (cdr elem)))
1938 (when (and val
1939 (member var org-agenda-local-vars))
1940 (set var val)))))
1941 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1942 (org-agenda-sticky
1943 ;; Creating a sticky Agenda buffer for the first time
1944 (kill-all-local-variables)
1945 (mapc 'make-local-variable org-agenda-local-vars)
1946 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1948 ;; Creating a non-sticky agenda buffer
1949 (kill-all-local-variables)
1950 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
1951 (setq org-agenda-undo-list nil
1952 org-agenda-pending-undo-list nil
1953 org-agenda-bulk-marked-entries nil)
1954 (setq major-mode 'org-agenda-mode)
1955 ;; Keep global-font-lock-mode from turning on font-lock-mode
1956 (org-set-local 'font-lock-global-modes (list 'not major-mode))
1957 (setq mode-name "Org-Agenda")
1958 (use-local-map org-agenda-mode-map)
1959 (easy-menu-add org-agenda-menu)
1960 (if org-startup-truncated (setq truncate-lines t))
1961 (org-set-local 'line-move-visual nil)
1962 (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1963 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1964 ;; Make sure properties are removed when copying text
1965 (make-local-variable 'filter-buffer-substring-functions)
1966 (add-hook 'filter-buffer-substring-functions
1967 (lambda (fun start end delete)
1968 (substring-no-properties (funcall fun start end delete))))
1969 (unless org-agenda-keep-modes
1970 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1971 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1972 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1973 org-agenda-show-log org-agenda-start-with-log-mode))
1975 (easy-menu-change
1976 '("Agenda") "Agenda Files"
1977 (append
1978 (list
1979 (vector
1980 (if (get 'org-agenda-files 'org-restrict)
1981 "Restricted to single file"
1982 "Edit File List")
1983 '(org-edit-agenda-file-list)
1984 (not (get 'org-agenda-files 'org-restrict)))
1985 "--")
1986 (mapcar 'org-file-menu-entry (org-agenda-files))))
1987 (org-agenda-set-mode-name)
1988 (apply
1989 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1990 (list 'org-agenda-mode-hook)))
1992 (substitute-key-definition 'undo 'org-agenda-undo
1993 org-agenda-mode-map global-map)
1994 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
1995 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
1996 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
1997 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
1998 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
1999 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2000 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2001 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2002 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2003 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2004 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2005 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2006 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2007 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2008 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2009 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2010 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2011 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2012 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2013 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2014 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2015 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2016 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2017 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2018 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2019 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2020 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2021 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2022 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2023 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2024 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2025 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2026 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2027 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2028 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2029 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2030 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2031 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2032 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2033 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2034 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
2035 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
2036 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2037 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2038 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2039 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2041 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2042 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2043 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2044 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2045 (while l (org-defkey org-agenda-mode-map
2046 (int-to-string (pop l)) 'digit-argument)))
2048 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2049 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2050 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2051 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2052 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2053 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2054 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2055 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2056 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2057 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2058 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2059 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2060 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2061 'org-clock-modify-effort-estimate)
2062 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2063 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2064 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2065 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2066 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2067 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2068 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2069 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2070 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2071 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2072 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2073 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2074 (substitute-key-definition 'next-line 'org-agenda-next-line
2075 org-agenda-mode-map global-map)
2076 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2077 org-agenda-mode-map global-map)
2078 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2079 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2080 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2081 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2082 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-show-priority)
2083 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2084 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2085 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2086 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2087 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2088 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2089 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2090 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2091 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2092 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2093 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2094 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2095 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2096 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2097 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2098 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2099 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2100 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2101 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2102 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2103 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2104 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2105 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2106 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2107 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2109 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2110 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2111 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2112 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2113 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2114 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2115 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2116 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
2117 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2118 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2119 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2120 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2122 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2123 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2124 (when org-agenda-mouse-1-follows-link
2125 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2126 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2127 '("Agenda"
2128 ("Agenda Files")
2129 "--"
2130 ("Agenda Dates"
2131 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2132 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2133 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2134 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2135 "--"
2136 ("View"
2137 ["Day View" org-agenda-day-view
2138 :active (org-agenda-check-type nil 'agenda)
2139 :style radio :selected (eq org-agenda-current-span 'day)
2140 :keys "v d (or just d)"]
2141 ["Week View" org-agenda-week-view
2142 :active (org-agenda-check-type nil 'agenda)
2143 :style radio :selected (eq org-agenda-current-span 'week)
2144 :keys "v w (or just w)"]
2145 ["Month View" org-agenda-month-view
2146 :active (org-agenda-check-type nil 'agenda)
2147 :style radio :selected (eq org-agenda-current-span 'month)
2148 :keys "v m"]
2149 ["Year View" org-agenda-year-view
2150 :active (org-agenda-check-type nil 'agenda)
2151 :style radio :selected (eq org-agenda-current-span 'year)
2152 :keys "v y"]
2153 "--"
2154 ["Include Diary" org-agenda-toggle-diary
2155 :style toggle :selected org-agenda-include-diary
2156 :active (org-agenda-check-type nil 'agenda)]
2157 ["Include Deadlines" org-agenda-toggle-deadlines
2158 :style toggle :selected org-agenda-include-deadlines
2159 :active (org-agenda-check-type nil 'agenda)]
2160 ["Use Time Grid" org-agenda-toggle-time-grid
2161 :style toggle :selected org-agenda-use-time-grid
2162 :active (org-agenda-check-type nil 'agenda)]
2163 "--"
2164 ["Show clock report" org-agenda-clockreport-mode
2165 :style toggle :selected org-agenda-clockreport-mode
2166 :active (org-agenda-check-type nil 'agenda)]
2167 ["Show some entry text" org-agenda-entry-text-mode
2168 :style toggle :selected org-agenda-entry-text-mode
2169 :active t]
2170 "--"
2171 ["Show Logbook entries" org-agenda-log-mode
2172 :style toggle :selected org-agenda-show-log
2173 :active (org-agenda-check-type nil 'agenda 'timeline)
2174 :keys "v l (or just l)"]
2175 ["Include archived trees" org-agenda-archives-mode
2176 :style toggle :selected org-agenda-archives-mode :active t
2177 :keys "v a"]
2178 ["Include archive files" (org-agenda-archives-mode t)
2179 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2180 :keys "v A"]
2181 "--"
2182 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2183 ["Write view to file" org-agenda-write t]
2184 ["Rebuild buffer" org-agenda-redo t]
2185 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2186 "--"
2187 ["Show original entry" org-agenda-show t]
2188 ["Go To (other window)" org-agenda-goto t]
2189 ["Go To (this window)" org-agenda-switch-to t]
2190 ["Follow Mode" org-agenda-follow-mode
2191 :style toggle :selected org-agenda-follow-mode :active t]
2192 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2193 "--"
2194 ("TODO"
2195 ["Cycle TODO" org-agenda-todo t]
2196 ["Next TODO set" org-agenda-todo-nextset t]
2197 ["Previous TODO set" org-agenda-todo-previousset t]
2198 ["Add note" org-agenda-add-note t])
2199 ("Archive/Refile/Delete"
2200 ["Archive default" org-agenda-archive-default t]
2201 ["Archive default" org-agenda-archive-default-with-confirmation t]
2202 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2203 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2204 ["Archive subtree" org-agenda-archive t]
2205 "--"
2206 ["Refile" org-agenda-refile t]
2207 "--"
2208 ["Delete subtree" org-agenda-kill t])
2209 ("Bulk action"
2210 ["Mark entry" org-agenda-bulk-mark t]
2211 ["Mark all" org-agenda-bulk-mark-all t]
2212 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2213 ["Unmark entry" org-agenda-bulk-unmark t]
2214 ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "C-u s"])
2215 ["Act on all marked" org-agenda-bulk-action t]
2216 "--"
2217 ("Tags and Properties"
2218 ["Show all Tags" org-agenda-show-tags t]
2219 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2220 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2221 "--"
2222 ["Column View" org-columns t])
2223 ("Deadline/Schedule"
2224 ["Schedule" org-agenda-schedule t]
2225 ["Set Deadline" org-agenda-deadline t]
2226 "--"
2227 ["Mark item" org-agenda-action :active t :keys "k m"]
2228 ["Show mark item" org-agenda-action :active t :keys "k v"]
2229 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2230 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2231 "--"
2232 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2233 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2234 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2235 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2236 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2237 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2238 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2239 ("Clock and Effort"
2240 ["Clock in" org-agenda-clock-in t]
2241 ["Clock out" org-agenda-clock-out t]
2242 ["Clock cancel" org-agenda-clock-cancel t]
2243 ["Goto running clock" org-clock-goto t]
2244 "--"
2245 ["Set Effort" org-agenda-set-effort t]
2246 ["Change clocked effort" org-clock-modify-effort-estimate
2247 (org-clock-is-active)])
2248 ("Priority"
2249 ["Set Priority" org-agenda-priority t]
2250 ["Increase Priority" org-agenda-priority-up t]
2251 ["Decrease Priority" org-agenda-priority-down t]
2252 ["Show Priority" org-agenda-show-priority t])
2253 ("Calendar/Diary"
2254 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2255 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2256 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2257 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2258 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2259 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2260 "--"
2261 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2262 "--"
2263 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2264 "--"
2265 ("MobileOrg"
2266 ["Push Files and Views" org-mobile-push t]
2267 ["Get Captured and Flagged" org-mobile-pull t]
2268 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2269 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2270 "--"
2271 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2272 "--"
2273 ["Quit" org-agenda-quit t]
2274 ["Exit and Release Buffers" org-agenda-exit t]
2277 ;;; Agenda undo
2279 (defvar org-agenda-allow-remote-undo t
2280 "Non-nil means allow remote undo from the agenda buffer.")
2281 (defvar org-agenda-undo-list nil
2282 "List of undoable operations in the agenda since last refresh.")
2283 (defvar org-agenda-undo-has-started-in nil
2284 "Buffers that have already seen `undo-start' in the current undo sequence.")
2285 (defvar org-agenda-pending-undo-list nil
2286 "In a series of undo commands, this is the list of remaining undo items.")
2288 (defun org-agenda-undo ()
2289 "Undo a remote editing step in the agenda.
2290 This undoes changes both in the agenda buffer and in the remote buffer
2291 that have been changed along."
2292 (interactive)
2293 (or org-agenda-allow-remote-undo
2294 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2295 (if (not (eq this-command last-command))
2296 (setq org-agenda-undo-has-started-in nil
2297 org-agenda-pending-undo-list org-agenda-undo-list))
2298 (if (not org-agenda-pending-undo-list)
2299 (error "No further undo information"))
2300 (let* ((entry (pop org-agenda-pending-undo-list))
2301 buf line cmd rembuf)
2302 (setq cmd (pop entry) line (pop entry))
2303 (setq rembuf (nth 2 entry))
2304 (org-with-remote-undo rembuf
2305 (while (bufferp (setq buf (pop entry)))
2306 (if (pop entry)
2307 (with-current-buffer buf
2308 (let ((last-undo-buffer buf)
2309 (inhibit-read-only t))
2310 (unless (memq buf org-agenda-undo-has-started-in)
2311 (push buf org-agenda-undo-has-started-in)
2312 (make-local-variable 'pending-undo-list)
2313 (undo-start))
2314 (while (and pending-undo-list
2315 (listp pending-undo-list)
2316 (not (car pending-undo-list)))
2317 (pop pending-undo-list))
2318 (undo-more 1))))))
2319 (org-goto-line line)
2320 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2322 (defun org-verify-change-for-undo (l1 l2)
2323 "Verify that a real change occurred between the undo lists L1 and L2."
2324 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2325 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2326 (not (eq l1 l2)))
2328 ;;; Agenda dispatch
2330 (defvar org-agenda-restrict nil)
2331 (defvar org-agenda-restrict-begin (make-marker))
2332 (defvar org-agenda-restrict-end (make-marker))
2333 (defvar org-agenda-last-dispatch-buffer nil)
2334 (defvar org-agenda-overriding-restriction nil)
2336 (defcustom org-agenda-custom-commands-contexts nil
2337 "Alist of custom agenda keys and contextual rules.
2339 For example, if you have a custom agenda command \"p\" and you
2340 want this command to be accessible only from plain text files,
2341 use this:
2343 '((\"p\" (in-file . \"\\.txt\")))
2345 Here are the available contexts definitions:
2347 in-file: command displayed only in matching files
2348 in-mode: command displayed only in matching modes
2349 not-in-file: command not displayed in matching files
2350 not-in-mode: command not displayed in matching modes
2351 [function]: a custom function taking no argument
2353 If you define several checks, the agenda command will be
2354 accessible if there is at least one valid check.
2356 You can also bind a key to another agenda custom command
2357 depending on contextual rules.
2359 '((\"p\" \"q\" (in-file . \"\\.txt\")))
2361 Here it means: in .txt files, use \"p\" as the key for the
2362 agenda command otherwise associated with \"q\". (The command
2363 originally associated with \"q\" is not displayed to avoid
2364 duplicates.)"
2365 ;; :version "24.3"
2366 :group 'org-agenda-custom-commands
2367 :type '(repeat (list :tag "Rule"
2368 (string :tag " Agenda key")
2369 (string :tag "Replace by command")
2370 (repeat :tag "Available when"
2371 (choice
2372 (cons :tag "Condition"
2373 (choice
2374 (const :tag "In file" in-file)
2375 (const :tag "Not in file" not-in-file)
2376 (const :tag "In mode" in-mode)
2377 (const :tag "Not in mode" not-in-mode))
2378 (regexp))
2379 (function :tag "Custom function"))))))
2381 (defvar org-keys)
2382 (defvar org-match)
2383 ;;;###autoload
2384 (defun org-agenda (&optional arg org-keys restriction)
2385 "Dispatch agenda commands to collect entries to the agenda buffer.
2386 Prompts for a command to execute. Any prefix arg will be passed
2387 on to the selected command. The default selections are:
2389 a Call `org-agenda-list' to display the agenda for current day or week.
2390 t Call `org-todo-list' to display the global todo list.
2391 T Call `org-todo-list' to display the global todo list, select only
2392 entries with a specific TODO keyword (the user gets a prompt).
2393 m Call `org-tags-view' to display headlines with tags matching
2394 a condition (the user is prompted for the condition).
2395 M Like `m', but select only TODO entries, no ordinary headlines.
2396 L Create a timeline for the current buffer.
2397 e Export views to associated files.
2398 s Search entries for keywords.
2399 S Search entries for keywords, only with TODO keywords.
2400 / Multi occur across all agenda files and also files listed
2401 in `org-agenda-text-search-extra-files'.
2402 < Restrict agenda commands to buffer, subtree, or region.
2403 Press several times to get the desired effect.
2404 > Remove a previous restriction.
2405 # List \"stuck\" projects.
2406 ! Configure what \"stuck\" means.
2407 C Configure custom agenda commands.
2409 More commands can be added by configuring the variable
2410 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2411 searches can be pre-defined in this way.
2413 If the current buffer is in Org-mode and visiting a file, you can also
2414 first press `<' once to indicate that the agenda should be temporarily
2415 \(until the next use of \\[org-agenda]) restricted to the current file.
2416 Pressing `<' twice means to restrict to the current subtree or region
2417 \(if active)."
2418 (interactive "P")
2419 (catch 'exit
2420 (let* ((prefix-descriptions nil)
2421 (org-agenda-buffer-name org-agenda-buffer-name)
2422 (org-agenda-window-setup (if (equal (buffer-name)
2423 org-agenda-buffer-name)
2424 'current-window
2425 org-agenda-window-setup))
2426 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2427 (org-agenda-custom-commands
2428 ;; normalize different versions
2429 (delq nil
2430 (mapcar
2431 (lambda (x)
2432 (cond ((stringp (cdr x))
2433 (push x prefix-descriptions)
2434 nil)
2435 ((stringp (nth 1 x)) x)
2436 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2437 (t (cons (car x) (cons "" (cdr x))))))
2438 org-agenda-custom-commands)))
2439 (org-agenda-custom-commands
2440 (org-contextualize-keys
2441 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2442 (buf (current-buffer))
2443 (bfn (buffer-file-name (buffer-base-buffer)))
2444 entry key type org-match lprops ans)
2445 ;; Turn off restriction unless there is an overriding one,
2446 (unless org-agenda-overriding-restriction
2447 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2448 ;; There is a request to keep the file list in place
2449 (put 'org-agenda-files 'org-restrict nil))
2450 (setq org-agenda-restrict nil)
2451 (move-marker org-agenda-restrict-begin nil)
2452 (move-marker org-agenda-restrict-end nil))
2453 ;; Delete old local properties
2454 (put 'org-agenda-redo-command 'org-lprops nil)
2455 ;; Delete previously set last-arguments
2456 (put 'org-agenda-redo-command 'last-args nil)
2457 ;; Remember where this call originated
2458 (setq org-agenda-last-dispatch-buffer (current-buffer))
2459 (unless org-keys
2460 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2461 org-keys (car ans)
2462 restriction (cdr ans)))
2463 ;; If we have sticky agenda buffers, set a name for the buffer,
2464 ;; depending on the invoking keys. The user may still set this
2465 ;; as a command option, which will overwrite what we do here.
2466 (if org-agenda-sticky
2467 (setq org-agenda-buffer-name
2468 (format "*Org Agenda(%s)*" org-keys)))
2469 ;; Establish the restriction, if any
2470 (when (and (not org-agenda-overriding-restriction) restriction)
2471 (put 'org-agenda-files 'org-restrict (list bfn))
2472 (cond
2473 ((eq restriction 'region)
2474 (setq org-agenda-restrict t)
2475 (move-marker org-agenda-restrict-begin (region-beginning))
2476 (move-marker org-agenda-restrict-end (region-end)))
2477 ((eq restriction 'subtree)
2478 (save-excursion
2479 (setq org-agenda-restrict t)
2480 (org-back-to-heading t)
2481 (move-marker org-agenda-restrict-begin (point))
2482 (move-marker org-agenda-restrict-end
2483 (progn (org-end-of-subtree t)))))))
2485 ;; For example the todo list should not need it (but does...)
2486 (cond
2487 ((setq entry (assoc org-keys org-agenda-custom-commands))
2488 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2489 (progn
2490 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2491 lprops (nth 4 entry))
2492 (if org-agenda-sticky
2493 (setq org-agenda-buffer-name
2494 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2495 (format "*Org Agenda(%s)*" org-keys))))
2496 (put 'org-agenda-redo-command 'org-lprops lprops)
2497 (cond
2498 ((eq type 'agenda)
2499 (org-let lprops '(org-agenda-list current-prefix-arg)))
2500 ((eq type 'alltodo)
2501 (org-let lprops '(org-todo-list current-prefix-arg)))
2502 ((eq type 'search)
2503 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2504 ((eq type 'stuck)
2505 (org-let lprops '(org-agenda-list-stuck-projects
2506 current-prefix-arg)))
2507 ((eq type 'tags)
2508 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2509 ((eq type 'tags-todo)
2510 (org-let lprops '(org-tags-view '(4) org-match)))
2511 ((eq type 'todo)
2512 (org-let lprops '(org-todo-list org-match)))
2513 ((eq type 'tags-tree)
2514 (org-check-for-org-mode)
2515 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2516 ((eq type 'todo-tree)
2517 (org-check-for-org-mode)
2518 (org-let lprops
2519 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2520 (regexp-quote org-match) "\\>"))))
2521 ((eq type 'occur-tree)
2522 (org-check-for-org-mode)
2523 (org-let lprops '(org-occur org-match)))
2524 ((functionp type)
2525 (org-let lprops '(funcall type org-match)))
2526 ((fboundp type)
2527 (org-let lprops '(funcall type org-match)))
2528 (t (error "Invalid custom agenda command type %s" type))))
2529 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2530 ((equal org-keys "C")
2531 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2532 (customize-variable 'org-agenda-custom-commands))
2533 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2534 ((equal org-keys "s") (call-interactively 'org-search-view))
2535 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2536 ((equal org-keys "t") (call-interactively 'org-todo-list))
2537 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2538 ((equal org-keys "m") (call-interactively 'org-tags-view))
2539 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2540 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2541 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2542 (org-add-hook
2543 'post-command-hook
2544 (lambda ()
2545 (unless (current-message)
2546 (let* ((m (org-agenda-get-any-marker))
2547 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2548 (when note
2549 (message (concat
2550 "FLAGGING-NOTE ([?] for more info): "
2551 (org-add-props
2552 (replace-regexp-in-string
2553 "\\\\n" "//"
2554 (copy-sequence note))
2555 nil 'face 'org-warning)))))))
2556 t t))
2557 ((equal org-keys "L")
2558 (unless (derived-mode-p 'org-mode)
2559 (error "This is not an Org-mode file"))
2560 (unless restriction
2561 (put 'org-agenda-files 'org-restrict (list bfn))
2562 (org-call-with-arg 'org-timeline arg)))
2563 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2564 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2565 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2566 (t (error "Invalid agenda key"))))))
2568 (defun org-agenda-append-agenda ()
2569 "Append another agenda view to the current one.
2570 This function allows interactive building of block agendas.
2571 Agenda views are separated by `org-agenda-block-separator'."
2572 (interactive)
2573 (unless (derived-mode-p 'org-agenda-mode)
2574 (error "Can only append from within agenda buffer"))
2575 (let ((org-agenda-multi t))
2576 (org-agenda)
2577 (widen)
2578 (org-finalize-agenda)
2579 (org-agenda-fit-window-to-buffer)))
2581 (defun org-agenda-normalize-custom-commands (cmds)
2582 (delq nil
2583 (mapcar
2584 (lambda (x)
2585 (cond ((stringp (cdr x)) nil)
2586 ((stringp (nth 1 x)) x)
2587 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2588 (t (cons (car x) (cons "" (cdr x))))))
2589 cmds)))
2591 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2592 "The user interface for selecting an agenda command."
2593 (catch 'exit
2594 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2595 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2596 (region-p (org-region-active-p))
2597 (custom org-agenda-custom-commands)
2598 (selstring "")
2599 restriction second-time
2600 c entry key type match prefixes rmheader header-end custom1 desc
2601 line lines left right n n1)
2602 (save-window-excursion
2603 (delete-other-windows)
2604 (org-switch-to-buffer-other-window " *Agenda Commands*")
2605 (erase-buffer)
2606 (insert (eval-when-compile
2607 (let ((header
2608 "Press key for an agenda command: < Buffer, subtree/region restriction
2609 -------------------------------- > Remove restriction
2610 a Agenda for current week or day e Export agenda views
2611 t List of all TODO entries T Entries with special TODO kwd
2612 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2613 s Search for keywords S Like s, but only TODO entries
2614 L Timeline for current buffer # List stuck projects (!=configure)
2615 / Multi-occur C Configure custom agenda commands
2616 ? Find :FLAGGED: entries * Toggle sticky agenda views
2618 (start 0))
2619 (while (string-match
2620 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2621 header start)
2622 (setq start (match-end 0))
2623 (add-text-properties (match-beginning 2) (match-end 2)
2624 '(face bold) header))
2625 header)))
2626 (setq header-end (move-marker (make-marker) (point)))
2627 (while t
2628 (setq custom1 custom)
2629 (when (eq rmheader t)
2630 (org-goto-line 1)
2631 (re-search-forward ":" nil t)
2632 (delete-region (match-end 0) (point-at-eol))
2633 (forward-char 1)
2634 (looking-at "-+")
2635 (delete-region (match-end 0) (point-at-eol))
2636 (move-marker header-end (match-end 0)))
2637 (goto-char header-end)
2638 (delete-region (point) (point-max))
2640 ;; Produce all the lines that describe custom commands and prefixes
2641 (setq lines nil)
2642 (while (setq entry (pop custom1))
2643 (setq key (car entry) desc (nth 1 entry)
2644 type (nth 2 entry)
2645 match (nth 3 entry))
2646 (if (> (length key) 1)
2647 (add-to-list 'prefixes (string-to-char key))
2648 (setq line
2649 (format
2650 "%-4s%-14s"
2651 (org-add-props (copy-sequence key)
2652 '(face bold))
2653 (cond
2654 ((string-match "\\S-" desc) desc)
2655 ((eq type 'agenda) "Agenda for current week or day")
2656 ((eq type 'alltodo) "List of all TODO entries")
2657 ((eq type 'search) "Word search")
2658 ((eq type 'stuck) "List of stuck projects")
2659 ((eq type 'todo) "TODO keyword")
2660 ((eq type 'tags) "Tags query")
2661 ((eq type 'tags-todo) "Tags (TODO)")
2662 ((eq type 'tags-tree) "Tags tree")
2663 ((eq type 'todo-tree) "TODO kwd tree")
2664 ((eq type 'occur-tree) "Occur tree")
2665 ((functionp type) (if (symbolp type)
2666 (symbol-name type)
2667 "Lambda expression"))
2668 (t "???"))))
2669 (if org-agenda-menu-show-matcher
2670 (setq line
2671 (concat line ": "
2672 (cond
2673 ((stringp match)
2674 (setq match (copy-sequence match))
2675 (org-add-props match nil 'face 'org-warning))
2676 (match
2677 (format "set of %d commands" (length match)))
2678 (t ""))))
2679 (if (org-string-nw-p match)
2680 (add-text-properties
2681 0 (length line) (list 'help-echo
2682 (concat "Matcher: "match)) line)))
2683 (push line lines)))
2684 (setq lines (nreverse lines))
2685 (when prefixes
2686 (mapc (lambda (x)
2687 (push
2688 (format "%s %s"
2689 (org-add-props (char-to-string x)
2690 nil 'face 'bold)
2691 (or (cdr (assoc (concat selstring
2692 (char-to-string x))
2693 prefix-descriptions))
2694 "Prefix key"))
2695 lines))
2696 prefixes))
2698 ;; Check if we should display in two columns
2699 (if org-agenda-menu-two-columns
2700 (progn
2701 (setq n (length lines)
2702 n1 (+ (/ n 2) (mod n 2))
2703 right (nthcdr n1 lines)
2704 left (copy-sequence lines))
2705 (setcdr (nthcdr (1- n1) left) nil))
2706 (setq left lines right nil))
2707 (while left
2708 (insert "\n" (pop left))
2709 (when right
2710 (if (< (current-column) 40)
2711 (move-to-column 40 t)
2712 (insert " "))
2713 (insert (pop right))))
2715 ;; Make the window the right size
2716 (goto-char (point-min))
2717 (if second-time
2718 (if (not (pos-visible-in-window-p (point-max)))
2719 (org-fit-window-to-buffer))
2720 (setq second-time t)
2721 (org-fit-window-to-buffer))
2723 ;; Ask for selection
2724 (message "Press key for agenda command%s:"
2725 (if (or restrict-ok org-agenda-overriding-restriction)
2726 (if org-agenda-overriding-restriction
2727 " (restriction lock active)"
2728 (if restriction
2729 (format " (restricted to %s)" restriction)
2730 " (unrestricted)"))
2731 ""))
2732 (setq c (read-char-exclusive))
2733 (message "")
2734 (cond
2735 ((assoc (char-to-string c) custom)
2736 (setq selstring (concat selstring (char-to-string c)))
2737 (throw 'exit (cons selstring restriction)))
2738 ((memq c prefixes)
2739 (setq selstring (concat selstring (char-to-string c))
2740 prefixes nil
2741 rmheader (or rmheader t)
2742 custom (delq nil (mapcar
2743 (lambda (x)
2744 (if (or (= (length (car x)) 1)
2745 (/= (string-to-char (car x)) c))
2747 (cons (substring (car x) 1) (cdr x))))
2748 custom))))
2749 ((eq c ?*)
2750 (call-interactively 'org-toggle-sticky-agenda)
2751 (sit-for 2))
2752 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2753 (message "Restriction is only possible in Org-mode buffers")
2754 (ding) (sit-for 1))
2755 ((eq c ?1)
2756 (org-agenda-remove-restriction-lock 'noupdate)
2757 (setq restriction 'buffer))
2758 ((eq c ?0)
2759 (org-agenda-remove-restriction-lock 'noupdate)
2760 (setq restriction (if region-p 'region 'subtree)))
2761 ((eq c ?<)
2762 (org-agenda-remove-restriction-lock 'noupdate)
2763 (setq restriction
2764 (cond
2765 ((eq restriction 'buffer)
2766 (if region-p 'region 'subtree))
2767 ((memq restriction '(subtree region))
2768 nil)
2769 (t 'buffer))))
2770 ((eq c ?>)
2771 (org-agenda-remove-restriction-lock 'noupdate)
2772 (setq restriction nil))
2773 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2774 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2775 ((and (> (length selstring) 0) (eq c ?\d))
2776 (delete-window)
2777 (org-agenda-get-restriction-and-command prefix-descriptions))
2779 ((equal c ?q) (error "Abort"))
2780 (t (error "Invalid key %c" c))))))))
2782 (defun org-agenda-fit-window-to-buffer ()
2783 "Fit the window to the buffer size."
2784 (and (memq org-agenda-window-setup '(reorganize-frame))
2785 (fboundp 'fit-window-to-buffer)
2786 (org-fit-window-to-buffer
2788 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
2789 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
2791 (defvar org-cmd) ; Dynamically scoped
2792 (defvar org-agenda-overriding-cmd) ; Ditto
2793 (defvar org-agenda-overriding-arguments) ; Ditto
2794 (defvar org-agenda-overriding-cmd-arguments) ; Ditto
2795 (defun org-agenda-run-series (name series)
2796 (org-let (nth 1 series) '(org-agenda-prepare name))
2797 ;; We need to reset agenda markers here, because when constructing a
2798 ;; block agenda, the individual blocks do not do that.
2799 (org-agenda-reset-markers)
2800 (let* ((org-agenda-multi t)
2801 (redo (list 'org-agenda-run-series name (list 'quote series)))
2802 (cmds (car series))
2803 (gprops (nth 1 series))
2804 match ;; The byte compiler incorrectly complains about this. Keep it!
2805 org-cmd type lprops)
2806 (while (setq org-cmd (pop cmds))
2807 (setq type (car org-cmd)
2808 match (eval (nth 1 org-cmd))
2809 lprops (nth 2 org-cmd))
2810 (let ((org-agenda-overriding-arguments
2811 (if (eq org-agenda-overriding-cmd org-cmd)
2812 (or org-agenda-overriding-arguments
2813 org-agenda-overriding-cmd-arguments))))
2814 (cond
2815 ((eq type 'agenda)
2816 (org-let2 gprops lprops
2817 '(call-interactively 'org-agenda-list)))
2818 ((eq type 'alltodo)
2819 (org-let2 gprops lprops
2820 '(call-interactively 'org-todo-list)))
2821 ((eq type 'search)
2822 (org-let2 gprops lprops
2823 '(org-search-view current-prefix-arg match nil)))
2824 ((eq type 'stuck)
2825 (org-let2 gprops lprops
2826 '(call-interactively 'org-agenda-list-stuck-projects)))
2827 ((eq type 'tags)
2828 (org-let2 gprops lprops
2829 '(org-tags-view current-prefix-arg match)))
2830 ((eq type 'tags-todo)
2831 (org-let2 gprops lprops
2832 '(org-tags-view '(4) match)))
2833 ((eq type 'todo)
2834 (org-let2 gprops lprops
2835 '(org-todo-list match)))
2836 ((fboundp type)
2837 (org-let2 gprops lprops
2838 '(funcall type match)))
2839 (t (error "Invalid type in command series")))))
2840 (widen)
2841 (let ((inhibit-read-only t))
2842 (add-text-properties (point-min) (point-max)
2843 `(org-serie t org-serie-redo-cmd ,redo)))
2844 (setq org-agenda-redo-command redo)
2845 (goto-char (point-min)))
2846 (org-agenda-fit-window-to-buffer)
2847 (org-let (nth 1 series) '(org-finalize-agenda)))
2849 ;;;###autoload
2850 (defmacro org-batch-agenda (cmd-key &rest parameters)
2851 "Run an agenda command in batch mode and send the result to STDOUT.
2852 If CMD-KEY is a string of length 1, it is used as a key in
2853 `org-agenda-custom-commands' and triggers this command. If it is a
2854 longer string it is used as a tags/todo match string.
2855 Parameters are alternating variable names and values that will be bound
2856 before running the agenda command."
2857 (org-eval-in-environment (org-make-parameter-alist parameters)
2858 (if (> (length cmd-key) 2)
2859 (org-tags-view nil cmd-key)
2860 (org-agenda nil cmd-key)))
2861 (set-buffer org-agenda-buffer-name)
2862 (princ (buffer-string)))
2863 (def-edebug-spec org-batch-agenda (form &rest sexp))
2865 (defvar org-agenda-info nil)
2867 ;;;###autoload
2868 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2869 "Run an agenda command in batch mode and send the result to STDOUT.
2870 If CMD-KEY is a string of length 1, it is used as a key in
2871 `org-agenda-custom-commands' and triggers this command. If it is a
2872 longer string it is used as a tags/todo match string.
2873 Parameters are alternating variable names and values that will be bound
2874 before running the agenda command.
2876 The output gives a line for each selected agenda item. Each
2877 item is a list of comma-separated values, like this:
2879 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2881 category The category of the item
2882 head The headline, without TODO kwd, TAGS and PRIORITY
2883 type The type of the agenda entry, can be
2884 todo selected in TODO match
2885 tagsmatch selected in tags match
2886 diary imported from diary
2887 deadline a deadline on given date
2888 scheduled scheduled on given date
2889 timestamp entry has timestamp on given date
2890 closed entry was closed on given date
2891 upcoming-deadline warning about deadline
2892 past-scheduled forwarded scheduled item
2893 block entry has date block including g. date
2894 todo The todo keyword, if any
2895 tags All tags including inherited ones, separated by colons
2896 date The relevant date, like 2007-2-14
2897 time The time, like 15:00-16:50
2898 extra Sting with extra planning info
2899 priority-l The priority letter if any was given
2900 priority-n The computed numerical priority
2901 agenda-day The day in the agenda where this is listed"
2902 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2903 (org-make-parameter-alist parameters))
2904 (if (> (length cmd-key) 2)
2905 (org-tags-view nil cmd-key)
2906 (org-agenda nil cmd-key)))
2907 (set-buffer org-agenda-buffer-name)
2908 (let* ((lines (org-split-string (buffer-string) "\n"))
2909 line)
2910 (while (setq line (pop lines))
2911 (catch 'next
2912 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2913 (setq org-agenda-info
2914 (org-fix-agenda-info (text-properties-at 0 line)))
2915 (princ
2916 (mapconcat 'org-agenda-export-csv-mapper
2917 '(org-category txt type todo tags date time extra
2918 priority-letter priority agenda-day)
2919 ","))
2920 (princ "\n")))))
2921 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2923 (defun org-fix-agenda-info (props)
2924 "Make sure all properties on an agenda item have a canonical form.
2925 This ensures the export commands can easily use it."
2926 (let (tmp re)
2927 (when (setq tmp (plist-get props 'tags))
2928 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2929 (when (setq tmp (plist-get props 'date))
2930 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2931 (let ((calendar-date-display-form '(year "-" month "-" day)))
2932 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2934 (setq tmp (calendar-date-string tmp)))
2935 (setq props (plist-put props 'date tmp)))
2936 (when (setq tmp (plist-get props 'day))
2937 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2938 (let ((calendar-date-display-form '(year "-" month "-" day)))
2939 (setq tmp (calendar-date-string tmp)))
2940 (setq props (plist-put props 'day tmp))
2941 (setq props (plist-put props 'agenda-day tmp)))
2942 (when (setq tmp (plist-get props 'txt))
2943 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2944 (plist-put props 'priority-letter (match-string 1 tmp))
2945 (setq tmp (replace-match "" t t tmp)))
2946 (when (and (setq re (plist-get props 'org-todo-regexp))
2947 (setq re (concat "\\`\\.*" re " ?"))
2948 (string-match re tmp))
2949 (plist-put props 'todo (match-string 1 tmp))
2950 (setq tmp (replace-match "" t t tmp)))
2951 (plist-put props 'txt tmp)))
2952 props)
2954 (defun org-agenda-export-csv-mapper (prop)
2955 (let ((res (plist-get org-agenda-info prop)))
2956 (setq res
2957 (cond
2958 ((not res) "")
2959 ((stringp res) res)
2960 (t (prin1-to-string res))))
2961 (while (string-match "," res)
2962 (setq res (replace-match ";" t t res)))
2963 (org-trim res)))
2965 ;;;###autoload
2966 (defun org-store-agenda-views (&rest parameters)
2967 (interactive)
2968 (eval (list 'org-batch-store-agenda-views)))
2970 ;;;###autoload
2971 (defmacro org-batch-store-agenda-views (&rest parameters)
2972 "Run all custom agenda commands that have a file argument."
2973 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2974 (pop-up-frames nil)
2975 (dir default-directory)
2976 (pars (org-make-parameter-alist parameters))
2977 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
2978 (save-window-excursion
2979 (while cmds
2980 (setq cmd (pop cmds)
2981 thiscmdkey (car cmd)
2982 thiscmdcmd (cdr cmd)
2983 match (nth 2 thiscmdcmd)
2984 bufname (if org-agenda-sticky
2985 (or (and (stringp match)
2986 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
2987 (format "*Org Agenda(%s)*" thiscmdkey))
2988 org-agenda-buffer-name)
2989 cmd-or-set (nth 2 cmd)
2990 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2991 files (nth (if (listp cmd-or-set) 4 5) cmd))
2992 (if (stringp files) (setq files (list files)))
2993 (when files
2994 (org-eval-in-environment (append org-agenda-exporter-settings
2995 opts pars)
2996 (org-agenda nil thiscmdkey))
2997 (set-buffer bufname)
2998 (while files
2999 (org-eval-in-environment (append org-agenda-exporter-settings
3000 opts pars)
3001 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3002 (and (get-buffer bufname)
3003 (kill-buffer bufname)))))))
3004 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
3006 (defvar org-agenda-current-span nil
3007 "The current span used in the agenda view.") ; local variable in the agenda buffer
3008 (defun org-agenda-mark-header-line (pos)
3009 "Mark the line at POS as an agenda structure header."
3010 (save-excursion
3011 (goto-char pos)
3012 (put-text-property (point-at-bol) (point-at-eol)
3013 'org-agenda-structural-header t)
3014 (when org-agenda-title-append
3015 (put-text-property (point-at-bol) (point-at-eol)
3016 'org-agenda-title-append org-agenda-title-append))))
3018 (defvar org-mobile-creating-agendas)
3019 (defvar org-agenda-write-buffer-name "Agenda View")
3020 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3021 "Write the current buffer (an agenda view) as a file.
3022 Depending on the extension of the file name, plain text (.txt),
3023 HTML (.html or .htm) or Postscript (.ps) is produced.
3024 If the extension is .ics, run icalendar export over all files used
3025 to construct the agenda and limit the export to entries listed in the
3026 agenda now.
3027 With prefix argument OPEN, open the new file immediately.
3028 If NOSETTINGS is given, do not scope the settings of
3029 `org-agenda-exporter-settings' into the export commands. This is used when
3030 the settings have already been scoped and we do not wish to overrule other,
3031 higher priority settings.
3032 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3033 (interactive "FWrite agenda to file: \nP")
3034 (if (not (file-writable-p file))
3035 (error "Cannot write agenda to file %s" file))
3036 (org-let (if nosettings nil org-agenda-exporter-settings)
3037 '(save-excursion
3038 (save-window-excursion
3039 (org-agenda-mark-filtered-text)
3040 (let ((bs (copy-sequence (buffer-string))) beg)
3041 (org-agenda-unmark-filtered-text)
3042 (with-temp-buffer
3043 (rename-buffer org-agenda-write-buffer-name t)
3044 (set-buffer-modified-p nil)
3045 (insert bs)
3046 (org-agenda-remove-marked-text 'org-filtered)
3047 (while (setq beg (text-property-any (point-min) (point-max)
3048 'org-filtered t))
3049 (delete-region
3050 beg (or (next-single-property-change beg 'org-filtered)
3051 (point-max))))
3052 (run-hooks 'org-agenda-before-write-hook)
3053 (cond
3054 ((org-bound-and-true-p org-mobile-creating-agendas)
3055 (org-mobile-write-agenda-for-mobile file))
3056 ((string-match "\\.html?\\'" file)
3057 (require 'htmlize)
3058 (set-buffer (htmlize-buffer (current-buffer)))
3059 (when (and org-agenda-export-html-style
3060 (string-match "<style>" org-agenda-export-html-style))
3061 ;; replace <style> section with org-agenda-export-html-style
3062 (goto-char (point-min))
3063 (kill-region (- (search-forward "<style") 6)
3064 (search-forward "</style>"))
3065 (insert org-agenda-export-html-style))
3066 (write-file file)
3067 (kill-buffer (current-buffer))
3068 (message "HTML written to %s" file))
3069 ((string-match "\\.ps\\'" file)
3070 (require 'ps-print)
3071 (ps-print-buffer-with-faces file)
3072 (message "Postscript written to %s" file))
3073 ((string-match "\\.pdf\\'" file)
3074 (require 'ps-print)
3075 (ps-print-buffer-with-faces
3076 (concat (file-name-sans-extension file) ".ps"))
3077 (call-process "ps2pdf" nil nil nil
3078 (expand-file-name
3079 (concat (file-name-sans-extension file) ".ps"))
3080 (expand-file-name file))
3081 (delete-file (concat (file-name-sans-extension file) ".ps"))
3082 (message "PDF written to %s" file))
3083 ((string-match "\\.ics\\'" file)
3084 (require 'org-icalendar)
3085 (let ((org-agenda-marker-table
3086 (org-create-marker-find-array
3087 (org-agenda-collect-markers)))
3088 (org-icalendar-verify-function 'org-check-agenda-marker-table)
3089 (org-combined-agenda-icalendar-file file))
3090 (apply 'org-export-icalendar 'combine
3091 (org-agenda-files nil 'ifmode))))
3093 (let ((bs (buffer-string)))
3094 (find-file file)
3095 (erase-buffer)
3096 (insert bs)
3097 (save-buffer 0)
3098 (kill-buffer (current-buffer))
3099 (message "Plain text written to %s" file))))))))
3100 (set-buffer (or agenda-bufname
3101 (and (called-interactively-p 'any) (buffer-name))
3102 org-agenda-buffer-name)))
3103 (when open (org-open-file file)))
3105 (defvar org-agenda-tag-filter-overlays nil)
3106 (defvar org-agenda-cat-filter-overlays nil)
3108 (defun org-agenda-mark-filtered-text ()
3109 "Mark all text hidden by filtering with a text property."
3110 (let ((inhibit-read-only t))
3111 (mapc
3112 (lambda (o)
3113 (when (equal (overlay-buffer o) (current-buffer))
3114 (put-text-property
3115 (overlay-start o) (overlay-end o)
3116 'org-filtered t)))
3117 (append org-agenda-tag-filter-overlays
3118 org-agenda-cat-filter-overlays))))
3120 (defun org-agenda-unmark-filtered-text ()
3121 "Remove the filtering text property."
3122 (let ((inhibit-read-only t))
3123 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3125 (defun org-agenda-remove-marked-text (property &optional value)
3126 "Delete all text marked with VALUE of PROPERTY.
3127 VALUE defaults to t."
3128 (let (beg)
3129 (setq value (or value t))
3130 (while (setq beg (text-property-any (point-min) (point-max)
3131 property value))
3132 (delete-region
3133 beg (or (next-single-property-change beg 'org-filtered)
3134 (point-max))))))
3136 (defun org-agenda-add-entry-text ()
3137 "Add entry text to agenda lines.
3138 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3139 entry text following headings shown in the agenda.
3140 Drawers will be excluded, also the line with scheduling/deadline info."
3141 (when (and (> org-agenda-add-entry-text-maxlines 0)
3142 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3143 (let (m txt)
3144 (goto-char (point-min))
3145 (while (not (eobp))
3146 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3147 (beginning-of-line 2)
3148 (setq txt (org-agenda-get-some-entry-text
3149 m org-agenda-add-entry-text-maxlines " > "))
3150 (end-of-line 1)
3151 (if (string-match "\\S-" txt)
3152 (insert "\n" txt)
3153 (or (eobp) (forward-char 1))))))))
3155 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3156 &rest keep)
3157 "Extract entry text from MARKER, at most N-LINES lines.
3158 This will ignore drawers etc, just get the text.
3159 If INDENT is given, prefix every line with this string. If KEEP is
3160 given, it is a list of symbols, defining stuff that should not be
3161 removed from the entry content. Currently only `planning' is allowed here."
3162 (let (txt drawer-re kwd-time-re ind)
3163 (save-excursion
3164 (with-current-buffer (marker-buffer marker)
3165 (if (not (derived-mode-p 'org-mode))
3166 (setq txt "")
3167 (save-excursion
3168 (save-restriction
3169 (widen)
3170 (goto-char marker)
3171 (end-of-line 1)
3172 (setq txt (buffer-substring
3173 (min (1+ (point)) (point-max))
3174 (progn (outline-next-heading) (point)))
3175 drawer-re org-drawer-regexp
3176 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3177 ".*\n?"))
3178 (with-temp-buffer
3179 (insert txt)
3180 (when org-agenda-add-entry-text-descriptive-links
3181 (goto-char (point-min))
3182 (while (org-activate-bracket-links (point-max))
3183 (add-text-properties (match-beginning 0) (match-end 0)
3184 '(face org-link))))
3185 (goto-char (point-min))
3186 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3187 (set-text-properties (match-beginning 0) (match-end 0)
3188 nil))
3189 (goto-char (point-min))
3190 (while (re-search-forward drawer-re nil t)
3191 (delete-region
3192 (match-beginning 0)
3193 (progn (re-search-forward
3194 "^[ \t]*:END:.*\n?" nil 'move)
3195 (point))))
3196 (unless (member 'planning keep)
3197 (goto-char (point-min))
3198 (while (re-search-forward kwd-time-re nil t)
3199 (replace-match "")))
3200 (goto-char (point-min))
3201 (when org-agenda-entry-text-exclude-regexps
3202 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3203 (while (setq re (pop re-list))
3204 (goto-char (point-min))
3205 (while (re-search-forward re nil t)
3206 (replace-match "")))))
3207 (goto-char (point-max))
3208 (skip-chars-backward " \t\n")
3209 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3211 ;; find and remove min common indentation
3212 (goto-char (point-min))
3213 (untabify (point-min) (point-max))
3214 (setq ind (org-get-indentation))
3215 (while (not (eobp))
3216 (unless (looking-at "[ \t]*$")
3217 (setq ind (min ind (org-get-indentation))))
3218 (beginning-of-line 2))
3219 (goto-char (point-min))
3220 (while (not (eobp))
3221 (unless (looking-at "[ \t]*$")
3222 (move-to-column ind)
3223 (delete-region (point-at-bol) (point)))
3224 (beginning-of-line 2))
3226 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3228 (goto-char (point-min))
3229 (when indent
3230 (while (and (not (eobp)) (re-search-forward "^" nil t))
3231 (replace-match indent t t)))
3232 (goto-char (point-min))
3233 (while (looking-at "[ \t]*\n") (replace-match ""))
3234 (goto-char (point-max))
3235 (when (> (org-current-line)
3236 n-lines)
3237 (org-goto-line (1+ n-lines))
3238 (backward-char 1))
3239 (setq txt (buffer-substring (point-min) (point)))))))))
3240 txt))
3242 (defun org-agenda-collect-markers ()
3243 "Collect the markers pointing to entries in the agenda buffer."
3244 (let (m markers)
3245 (save-excursion
3246 (goto-char (point-min))
3247 (while (not (eobp))
3248 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3249 (org-get-at-bol 'org-marker)))
3250 (push m markers))
3251 (beginning-of-line 2)))
3252 (nreverse markers)))
3254 (defun org-create-marker-find-array (marker-list)
3255 "Create a alist of files names with all marker positions in that file."
3256 (let (f tbl m a p)
3257 (while (setq m (pop marker-list))
3258 (setq p (marker-position m)
3259 f (buffer-file-name (or (buffer-base-buffer
3260 (marker-buffer m))
3261 (marker-buffer m))))
3262 (if (setq a (assoc f tbl))
3263 (push (marker-position m) (cdr a))
3264 (push (list f p) tbl)))
3265 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3266 tbl)))
3268 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3269 (defun org-check-agenda-marker-table ()
3270 "Check of the current entry is on the marker list."
3271 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3273 (and (setq a (assoc file org-agenda-marker-table))
3274 (save-match-data
3275 (save-excursion
3276 (org-back-to-heading t)
3277 (member (point) (cdr a)))))))
3279 (defun org-check-for-org-mode ()
3280 "Make sure current buffer is in org-mode. Error if not."
3281 (or (derived-mode-p 'org-mode)
3282 (error "Cannot execute org-mode agenda command on buffer in %s"
3283 major-mode)))
3285 ;;; Agenda prepare and finalize
3287 (defvar org-agenda-multi nil) ; dynamically scoped
3288 (defvar org-agenda-buffer-name "*Org Agenda*")
3289 (defvar org-agenda-pre-window-conf nil)
3290 (defvar org-agenda-columns-active nil)
3291 (defvar org-agenda-name nil)
3292 (defvar org-agenda-tag-filter nil)
3293 (defvar org-agenda-category-filter nil)
3294 (defvar org-agenda-top-category-filter nil)
3295 (defvar org-agenda-tag-filter-while-redo nil)
3296 (defvar org-agenda-tag-filter-preset nil
3297 "A preset of the tags filter used for secondary agenda filtering.
3298 This must be a list of strings, each string must be a single tag preceded
3299 by \"+\" or \"-\".
3300 This variable should not be set directly, but agenda custom commands can
3301 bind it in the options section. The preset filter is a global property of
3302 the entire agenda view. In a block agenda, it will not work reliably to
3303 define a filter for one of the individual blocks. You need to set it in
3304 the global options and expect it to be applied to the entire view.")
3306 (defvar org-agenda-category-filter-preset nil
3307 "A preset of the category filter used for secondary agenda filtering.
3308 This must be a list of strings, each string must be a single category
3309 preceded by \"+\" or \"-\".
3310 This variable should not be set directly, but agenda custom commands can
3311 bind it in the options section. The preset filter is a global property of
3312 the entire agenda view. In a block agenda, it will not work reliably to
3313 define a filter for one of the individual blocks. You need to set it in
3314 the global options and expect it to be applied to the entire view.")
3317 (defun org-agenda-use-sticky-p ()
3318 "Return non-nil if an agenda buffer named
3319 `org-agenda-buffer-name' exists and should be shown instead of
3320 generating a new one."
3321 (and
3322 ;; turned off by user
3323 org-agenda-sticky
3324 ;; For multi-agenda buffer already exists
3325 (not org-agenda-multi)
3326 ;; buffer found
3327 (get-buffer org-agenda-buffer-name)
3328 ;; C-u parameter is same as last call
3329 (with-current-buffer (get-buffer org-agenda-buffer-name)
3330 (and
3331 (equal current-prefix-arg
3332 org-agenda-last-prefix-arg)
3333 ;; In case user turned stickiness on, while having existing
3334 ;; Agenda buffer active, don't reuse that buffer, because it
3335 ;; does not have org variables local
3336 org-agenda-this-buffer-is-sticky))))
3338 (defun org-agenda-prepare-window (abuf)
3339 "Setup agenda buffer in the window."
3340 (let* ((awin (get-buffer-window abuf))
3341 wconf)
3342 (cond
3343 ((equal (current-buffer) abuf) nil)
3344 (awin (select-window awin))
3345 ((not (setq wconf (current-window-configuration))))
3346 ((equal org-agenda-window-setup 'current-window)
3347 (org-pop-to-buffer-same-window abuf))
3348 ((equal org-agenda-window-setup 'other-window)
3349 (org-switch-to-buffer-other-window abuf))
3350 ((equal org-agenda-window-setup 'other-frame)
3351 (switch-to-buffer-other-frame abuf))
3352 ((equal org-agenda-window-setup 'reorganize-frame)
3353 (delete-other-windows)
3354 (org-switch-to-buffer-other-window abuf)))
3355 ;; additional test in case agenda is invoked from within agenda
3356 ;; buffer via elisp link
3357 (unless (equal (current-buffer) abuf)
3358 (org-pop-to-buffer-same-window abuf))
3359 (setq org-agenda-pre-window-conf
3360 (or org-agenda-pre-window-conf wconf))))
3362 (defun org-agenda-prepare (&optional name)
3363 (if (org-agenda-use-sticky-p)
3364 (progn
3365 ;; Popup existing buffer
3366 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
3367 (message "Sticky Agenda buffer, use `r' to refresh")
3368 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3369 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3370 (setq org-todo-keywords-for-agenda nil)
3371 (setq org-drawers-for-agenda nil)
3372 (unless org-agenda-persistent-filter
3373 (setq org-agenda-tag-filter nil
3374 org-agenda-category-filter nil))
3375 (put 'org-agenda-tag-filter :preset-filter
3376 org-agenda-tag-filter-preset)
3377 (put 'org-agenda-category-filter :preset-filter
3378 org-agenda-category-filter-preset)
3379 (if org-agenda-multi
3380 (progn
3381 (setq buffer-read-only nil)
3382 (goto-char (point-max))
3383 (unless (or (bobp) org-agenda-compact-blocks
3384 (not org-agenda-block-separator))
3385 (insert "\n"
3386 (if (stringp org-agenda-block-separator)
3387 org-agenda-block-separator
3388 (make-string (window-width) org-agenda-block-separator))
3389 "\n"))
3390 (narrow-to-region (point) (point-max)))
3391 (setq org-done-keywords-for-agenda nil)
3393 ;; Setting any org variables that are in org-agenda-local-vars
3394 ;; list need to be done after the prepare call
3395 (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
3396 (setq buffer-read-only nil)
3397 (org-agenda-reset-markers)
3398 (let ((inhibit-read-only t)) (erase-buffer))
3399 (org-agenda-mode)
3400 (setq org-agenda-buffer (current-buffer))
3401 (setq org-agenda-contributing-files nil)
3402 (setq org-agenda-columns-active nil)
3403 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3404 (setq org-todo-keywords-for-agenda
3405 (org-uniquify org-todo-keywords-for-agenda))
3406 (setq org-done-keywords-for-agenda
3407 (org-uniquify org-done-keywords-for-agenda))
3408 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3409 (setq org-agenda-last-prefix-arg current-prefix-arg)
3410 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3411 (and name (not org-agenda-name)
3412 (org-set-local 'org-agenda-name name)))
3413 (setq buffer-read-only nil)))
3415 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3416 (defun org-finalize-agenda ()
3417 "Finishing touch for the agenda buffer, called just before displaying it."
3418 (unless org-agenda-multi
3419 (save-excursion
3420 (let ((inhibit-read-only t))
3421 (goto-char (point-min))
3422 (while (org-activate-bracket-links (point-max))
3423 (add-text-properties (match-beginning 0) (match-end 0)
3424 '(face org-link)))
3425 (org-agenda-align-tags)
3426 (unless org-agenda-with-colors
3427 (remove-text-properties (point-min) (point-max) '(face nil))))
3428 (if (and (boundp 'org-agenda-overriding-columns-format)
3429 org-agenda-overriding-columns-format)
3430 (org-set-local 'org-agenda-overriding-columns-format
3431 org-agenda-overriding-columns-format))
3432 (if (and (boundp 'org-agenda-view-columns-initially)
3433 org-agenda-view-columns-initially)
3434 (org-agenda-columns))
3435 (when org-agenda-fontify-priorities
3436 (org-agenda-fontify-priorities))
3437 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3438 (org-agenda-dim-blocked-tasks))
3439 (org-agenda-mark-clocking-task)
3440 (when org-agenda-entry-text-mode
3441 (org-agenda-entry-text-hide)
3442 (org-agenda-entry-text-show))
3443 (if (functionp 'org-habit-insert-consistency-graphs)
3444 (org-habit-insert-consistency-graphs))
3445 (run-hooks 'org-finalize-agenda-hook)
3446 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3447 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3448 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3449 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3450 (org-agenda-filter-apply org-agenda-category-filter 'category))
3451 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
3454 (defun org-agenda-mark-clocking-task ()
3455 "Mark the current clock entry in the agenda if it is present."
3456 (mapc (lambda (o)
3457 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3458 (delete-overlay o)))
3459 (overlays-in (point-min) (point-max)))
3460 (when (marker-buffer org-clock-hd-marker)
3461 (save-excursion
3462 (goto-char (point-min))
3463 (let (s ov)
3464 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3465 (goto-char s)
3466 (when (equal (org-get-at-bol 'org-hd-marker)
3467 org-clock-hd-marker)
3468 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3469 (overlay-put ov 'type 'org-agenda-clocking)
3470 (overlay-put ov 'face 'org-agenda-clocking)
3471 (overlay-put ov 'help-echo
3472 "The clock is running in this item")))))))
3474 (defun org-agenda-fontify-priorities ()
3475 "Make highest priority lines bold, and lowest italic."
3476 (interactive)
3477 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3478 (delete-overlay o)))
3479 (overlays-in (point-min) (point-max)))
3480 (save-excursion
3481 (let ((inhibit-read-only t)
3482 b e p ov h l)
3483 (goto-char (point-min))
3484 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3485 (setq h (or (get-char-property (point) 'org-highest-priority)
3486 org-highest-priority)
3487 l (or (get-char-property (point) 'org-lowest-priority)
3488 org-lowest-priority)
3489 p (string-to-char (match-string 1))
3490 b (match-beginning 0)
3491 e (if (eq org-agenda-fontify-priorities 'cookies)
3492 (match-end 0)
3493 (point-at-eol))
3494 ov (make-overlay b e))
3495 (overlay-put
3496 ov 'face
3497 (cond ((org-face-from-face-or-color
3498 'priority nil
3499 (cdr (assoc p org-priority-faces))))
3500 ((and (listp org-agenda-fontify-priorities)
3501 (org-face-from-face-or-color
3502 'priority nil
3503 (cdr (assoc p org-agenda-fontify-priorities)))))
3504 ((equal p l) 'italic)
3505 ((equal p h) 'bold)))
3506 (overlay-put ov 'org-type 'org-priority)))))
3508 (defun org-agenda-dim-blocked-tasks ()
3509 "Dim currently blocked TODO's in the agenda display."
3510 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3511 (delete-overlay o)))
3512 (overlays-in (point-min) (point-max)))
3513 (save-excursion
3514 (let ((inhibit-read-only t)
3515 (org-depend-tag-blocked nil)
3516 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3517 org-blocked-by-checkboxes
3518 invis1 b e p ov h l)
3519 (goto-char (point-min))
3520 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3521 (and pos (goto-char (1+ pos))))
3522 (setq org-blocked-by-checkboxes nil invis1 invis)
3523 (let ((marker (org-get-at-bol 'org-hd-marker)))
3524 (when (and marker
3525 (with-current-buffer (marker-buffer marker)
3526 (save-excursion (goto-char marker)
3527 (org-entry-blocked-p))))
3528 (if org-blocked-by-checkboxes (setq invis1 nil))
3529 (setq b (if invis1
3530 (max (point-min) (1- (point-at-bol)))
3531 (point-at-bol))
3532 e (point-at-eol)
3533 ov (make-overlay b e))
3534 (if invis1
3535 (overlay-put ov 'invisible t)
3536 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3537 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3539 (defvar org-agenda-skip-function nil
3540 "Function to be called at each match during agenda construction.
3541 If this function returns nil, the current match should not be skipped.
3542 Otherwise, the function must return a position from where the search
3543 should be continued.
3544 This may also be a Lisp form, it will be evaluated.
3545 Never set this variable using `setq' or so, because then it will apply
3546 to all future agenda commands. If you do want a global skipping condition,
3547 use the option `org-agenda-skip-function-global' instead.
3548 The correct usage for `org-agenda-skip-function' is to bind it with
3549 `let' to scope it dynamically into the agenda-constructing command.
3550 A good way to set it is through options in `org-agenda-custom-commands'.")
3552 (defun org-agenda-skip ()
3553 "Throw to `:skip' in places that should be skipped.
3554 Also moves point to the end of the skipped region, so that search can
3555 continue from there."
3556 (let ((p (point-at-bol)) to)
3557 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3558 (get-text-property p :org-archived)
3559 (org-end-of-subtree t)
3560 (throw :skip t))
3561 (and org-agenda-skip-comment-trees
3562 (get-text-property p :org-comment)
3563 (org-end-of-subtree t)
3564 (throw :skip t))
3565 (if (equal (char-after p) ?#) (throw :skip t))
3566 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3567 (org-agenda-skip-eval org-agenda-skip-function)))
3568 (goto-char to)
3569 (throw :skip t))))
3571 (defun org-agenda-skip-eval (form)
3572 "If FORM is a function or a list, call (or eval) is and return result.
3573 `save-excursion' and `save-match-data' are wrapped around the call, so point
3574 and match data are returned to the previous state no matter what these
3575 functions do."
3576 (let (fp)
3577 (and form
3578 (or (setq fp (functionp form))
3579 (consp form))
3580 (save-excursion
3581 (save-match-data
3582 (if fp
3583 (funcall form)
3584 (eval form)))))))
3586 (defvar org-agenda-markers nil
3587 "List of all currently active markers created by `org-agenda'.")
3588 (defvar org-agenda-last-marker-time (org-float-time)
3589 "Creation time of the last agenda marker.")
3591 (defun org-agenda-new-marker (&optional pos)
3592 "Return a new agenda marker.
3593 Org-mode keeps a list of these markers and resets them when they are
3594 no longer in use."
3595 (let ((m (copy-marker (or pos (point)))))
3596 (setq org-agenda-last-marker-time (org-float-time))
3597 (if org-agenda-buffer
3598 (with-current-buffer org-agenda-buffer
3599 (push m org-agenda-markers))
3600 (push m org-agenda-markers))
3603 (defun org-agenda-reset-markers ()
3604 "Reset markers created by `org-agenda'."
3605 (while org-agenda-markers
3606 (move-marker (pop org-agenda-markers) nil)))
3608 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3609 "Save relative positions of markers in region.
3610 This check for agenda markers in all agenda buffers currently active."
3611 (dolist (buf (buffer-list))
3612 (with-current-buffer buf
3613 (when (eq major-mode 'org-agenda-mode)
3614 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3615 org-agenda-markers)))))
3617 ;;; Entry text mode
3619 (defun org-agenda-entry-text-show-here ()
3620 "Add some text from the entry as context to the current line."
3621 (let (m txt o)
3622 (setq m (org-get-at-bol 'org-hd-marker))
3623 (unless (marker-buffer m)
3624 (error "No marker points to an entry here"))
3625 (setq txt (concat "\n" (org-no-properties
3626 (org-agenda-get-some-entry-text
3627 m org-agenda-entry-text-maxlines " > "))))
3628 (when (string-match "\\S-" txt)
3629 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3630 (overlay-put o 'evaporate t)
3631 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3632 (overlay-put o 'after-string txt))))
3634 (defun org-agenda-entry-text-show ()
3635 "Add entry context for all agenda lines."
3636 (interactive)
3637 (save-excursion
3638 (goto-char (point-max))
3639 (beginning-of-line 1)
3640 (while (not (bobp))
3641 (when (org-get-at-bol 'org-hd-marker)
3642 (org-agenda-entry-text-show-here))
3643 (beginning-of-line 0))))
3645 (defun org-agenda-entry-text-hide ()
3646 "Remove any shown entry context."
3647 (delq nil
3648 (mapcar (lambda (o)
3649 (if (eq (overlay-get o 'org-overlay-type)
3650 'agenda-entry-content)
3651 (progn (delete-overlay o) t)))
3652 (overlays-in (point-min) (point-max)))))
3654 (defun org-agenda-get-day-face (date)
3655 "Return the face DATE should be displayed with."
3656 (or (and (functionp org-agenda-day-face-function)
3657 (funcall org-agenda-day-face-function date))
3658 (cond ((org-agenda-todayp date)
3659 'org-agenda-date-today)
3660 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3661 'org-agenda-date-weekend)
3662 (t 'org-agenda-date))))
3664 ;;; Agenda timeline
3666 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3668 (defun org-timeline (&optional dotodo)
3669 "Show a time-sorted view of the entries in the current org file.
3670 Only entries with a time stamp of today or later will be listed. With
3671 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3672 under the current date.
3673 If the buffer contains an active region, only check the region for
3674 dates."
3675 (interactive "P")
3676 (let* ((dopast t)
3677 (org-agenda-show-log-scoped org-agenda-show-log)
3678 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3679 (current-buffer))))
3680 (date (calendar-current-date))
3681 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3682 (end (if (org-region-active-p) (region-end) (point-max)))
3683 (day-numbers (org-get-all-dates
3684 beg end 'no-ranges
3685 t org-agenda-show-log-scoped ; always include today
3686 org-timeline-show-empty-dates))
3687 (org-deadline-warning-days 0)
3688 (org-agenda-only-exact-dates t)
3689 (today (org-today))
3690 (past t)
3691 args
3692 s e rtn d emptyp)
3693 (setq org-agenda-redo-command
3694 (list 'progn
3695 (list 'org-switch-to-buffer-other-window (current-buffer))
3696 (list 'org-timeline (list 'quote dotodo))))
3697 (if (not dopast)
3698 ;; Remove past dates from the list of dates.
3699 (setq day-numbers (delq nil (mapcar (lambda(x)
3700 (if (>= x today) x nil))
3701 day-numbers))))
3702 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
3703 (org-compile-prefix-format 'timeline)
3704 (org-set-sorting-strategy 'timeline)
3705 (if org-agenda-show-log-scoped (push :closed args))
3706 (push :timestamp args)
3707 (push :deadline args)
3708 (push :scheduled args)
3709 (push :sexp args)
3710 (if dotodo (push :todo args))
3711 (insert "Timeline of file " entry "\n")
3712 (add-text-properties (point-min) (point)
3713 (list 'face 'org-agenda-structure))
3714 (org-agenda-mark-header-line (point-min))
3715 (while (setq d (pop day-numbers))
3716 (if (and (listp d) (eq (car d) :omitted))
3717 (progn
3718 (setq s (point))
3719 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3720 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3721 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3722 (if (and (>= d today)
3723 dopast
3724 past)
3725 (progn
3726 (setq past nil)
3727 (insert (make-string 79 ?-) "\n")))
3728 (setq date (calendar-gregorian-from-absolute d))
3729 (setq s (point))
3730 (setq rtn (and (not emptyp)
3731 (apply 'org-agenda-get-day-entries entry
3732 date args)))
3733 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3734 (progn
3735 (insert
3736 (if (stringp org-agenda-format-date)
3737 (format-time-string org-agenda-format-date
3738 (org-time-from-absolute date))
3739 (funcall org-agenda-format-date date))
3740 "\n")
3741 (put-text-property s (1- (point)) 'face
3742 (org-agenda-get-day-face date))
3743 (put-text-property s (1- (point)) 'org-date-line t)
3744 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3745 (if (equal d today)
3746 (put-text-property s (1- (point)) 'org-today t))
3747 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3748 (put-text-property s (1- (point)) 'day d)))))
3749 (goto-char (point-min))
3750 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3751 (point-min)))
3752 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3753 (org-finalize-agenda)
3754 (setq buffer-read-only t)))
3756 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3757 "Return a list of all relevant day numbers from BEG to END buffer positions.
3758 If NO-RANGES is non-nil, include only the start and end dates of a range,
3759 not every single day in the range. If FORCE-TODAY is non-nil, make
3760 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3761 inactive time stamps (those in square brackets) are included.
3762 When EMPTY is non-nil, also include days without any entries."
3763 (let ((re (concat
3764 (if pre-re pre-re "")
3765 (if inactive org-ts-regexp-both org-ts-regexp)))
3766 dates dates1 date day day1 day2 ts1 ts2 pos)
3767 (if force-today
3768 (setq dates (list (org-today))))
3769 (save-excursion
3770 (goto-char beg)
3771 (while (re-search-forward re end t)
3772 (setq day (time-to-days (org-time-string-to-time
3773 (substring (match-string 1) 0 10)
3774 (current-buffer) (match-beginning 0))))
3775 (or (memq day dates) (push day dates)))
3776 (unless no-ranges
3777 (goto-char beg)
3778 (while (re-search-forward org-tr-regexp end t)
3779 (setq pos (match-beginning 0))
3780 (setq ts1 (substring (match-string 1) 0 10)
3781 ts2 (substring (match-string 2) 0 10)
3782 day1 (time-to-days (org-time-string-to-time
3783 ts1 (current-buffer) pos))
3784 day2 (time-to-days (org-time-string-to-time
3785 ts2 (current-buffer) pos)))
3786 (while (< (setq day1 (1+ day1)) day2)
3787 (or (memq day1 dates) (push day1 dates)))))
3788 (setq dates (sort dates '<))
3789 (when empty
3790 (while (setq day (pop dates))
3791 (setq day2 (car dates))
3792 (push day dates1)
3793 (when (and day2 empty)
3794 (if (or (eq empty t)
3795 (and (numberp empty) (<= (- day2 day) empty)))
3796 (while (< (setq day (1+ day)) day2)
3797 (push (list day) dates1))
3798 (push (cons :omitted (- day2 day)) dates1))))
3799 (setq dates (nreverse dates1)))
3800 dates)))
3802 ;;; Agenda Daily/Weekly
3804 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3805 "Start day for the agenda view.
3806 Custom commands can set this variable in the options section.")
3807 (defvar org-starting-day nil) ; local variable in the agenda buffer
3808 (defvar org-arg-loc nil) ; local variable
3810 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3811 "List of types searched for when creating the daily/weekly agenda.
3812 This variable is a list of symbols that controls the types of
3813 items that appear in the daily/weekly agenda. Allowed symbols in this
3814 list are are
3816 :timestamp List items containing a date stamp or date range matching
3817 the selected date. This includes sexp entries in
3818 angular brackets.
3820 :sexp List entries resulting from plain diary-like sexps.
3822 :deadline List deadline due on that date. When the date is today,
3823 also list any deadlines past due, or due within
3824 `org-deadline-warning-days'. `:deadline' must appear before
3825 `:scheduled' if the setting of
3826 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3827 any effect.
3829 :scheduled List all items which are scheduled for the given date.
3830 The diary for *today* also contains items which were
3831 scheduled earlier and are not yet marked DONE.
3833 By default, all four types are turned on.
3835 Never set this variable globally using `setq', because then it
3836 will apply to all future agenda commands. Instead, bind it with
3837 `let' to scope it dynamically into the agenda-constructing
3838 command. A good way to set it is through options in
3839 `org-agenda-custom-commands'. For a more flexible (though
3840 somewhat less efficient) way of determining what is included in
3841 the daily/weekly agenda, see `org-agenda-skip-function'.")
3843 ;;;###autoload
3844 (defun org-agenda-list (&optional arg start-day span)
3845 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3846 The view will be for the current day or week, but from the overview buffer
3847 you will be able to go to other days/weeks.
3849 With a numeric prefix argument in an interactive call, the agenda will
3850 span ARG days. Lisp programs should instead specify SPAN to change
3851 the number of days. SPAN defaults to `org-agenda-span'.
3853 START-DAY defaults to TODAY, or to the most recent match for the weekday
3854 given in `org-agenda-start-on-weekday'."
3855 (interactive "P")
3856 (if org-agenda-overriding-arguments
3857 (setq arg (car org-agenda-overriding-arguments)
3858 start-day (nth 1 org-agenda-overriding-arguments)
3859 span (nth 2 org-agenda-overriding-arguments)))
3860 (if (and (integerp arg) (> arg 0))
3861 (setq span arg arg nil))
3862 (catch 'exit
3863 (if org-agenda-sticky
3864 (setq org-agenda-buffer-name
3865 (cond ((and org-keys (stringp org-match))
3866 (format "*Org Agenda(%s:%s)*" org-keys org-match))
3867 (org-keys
3868 (format "*Org Agenda(%s)*" org-keys))
3869 (t "*Org Agenda(a)*"))))
3870 (org-agenda-prepare "Day/Week")
3871 (setq start-day (or start-day org-agenda-start-day))
3872 (if (stringp start-day)
3873 ;; Convert to an absolute day number
3874 (setq start-day (time-to-days (org-read-date nil t start-day))))
3875 (org-compile-prefix-format 'agenda)
3876 (org-set-sorting-strategy 'agenda)
3877 (let* ((span (org-agenda-ndays-to-span
3878 (or span org-agenda-ndays org-agenda-span)))
3879 (today (org-today))
3880 (sd (or start-day today))
3881 (ndays (org-agenda-span-to-ndays span sd))
3882 (org-agenda-start-on-weekday
3883 (if (eq ndays 7)
3884 org-agenda-start-on-weekday))
3885 (thefiles (org-agenda-files nil 'ifmode))
3886 (files thefiles)
3887 (start (if (or (null org-agenda-start-on-weekday)
3888 (< ndays 7))
3890 (let* ((nt (calendar-day-of-week
3891 (calendar-gregorian-from-absolute sd)))
3892 (n1 org-agenda-start-on-weekday)
3893 (d (- nt n1)))
3894 (- sd (+ (if (< d 0) 7 0) d)))))
3895 (day-numbers (list start))
3896 (day-cnt 0)
3897 (inhibit-redisplay (not debug-on-error))
3898 (org-agenda-show-log-scoped org-agenda-show-log)
3899 s e rtn rtnall file date d start-pos end-pos todayp
3900 clocktable-start clocktable-end filter)
3901 (setq org-agenda-redo-command
3902 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3903 (dotimes (n (1- ndays))
3904 (push (1+ (car day-numbers)) day-numbers))
3905 (setq day-numbers (nreverse day-numbers))
3906 (setq clocktable-start (car day-numbers)
3907 clocktable-end (1+ (or (org-last day-numbers) 0)))
3908 (org-set-local 'org-starting-day (car day-numbers))
3909 (org-set-local 'org-arg-loc arg)
3910 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3911 (unless org-agenda-compact-blocks
3912 (let* ((d1 (car day-numbers))
3913 (d2 (org-last day-numbers))
3914 (w1 (org-days-to-iso-week d1))
3915 (w2 (org-days-to-iso-week d2)))
3916 (setq s (point))
3917 (if org-agenda-overriding-header
3918 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3919 nil 'face 'org-agenda-structure) "\n")
3920 (insert (org-agenda-span-name span)
3921 "-agenda"
3922 (if (< (- d2 d1) 350)
3923 (if (= w1 w2)
3924 (format " (W%02d)" w1)
3925 (format " (W%02d-W%02d)" w1 w2))
3927 ":\n")))
3928 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3929 'org-date-line t))
3930 (org-agenda-mark-header-line s))
3931 (while (setq d (pop day-numbers))
3932 (setq date (calendar-gregorian-from-absolute d)
3933 s (point))
3934 (if (or (setq todayp (= d today))
3935 (and (not start-pos) (= d sd)))
3936 (setq start-pos (point))
3937 (if (and start-pos (not end-pos))
3938 (setq end-pos (point))))
3939 (setq files thefiles
3940 rtnall nil)
3941 (while (setq file (pop files))
3942 (catch 'nextfile
3943 (org-check-agenda-file file)
3944 (let ((org-agenda-entry-types org-agenda-entry-types))
3945 (unless org-agenda-include-deadlines
3946 (setq org-agenda-entry-types
3947 (delq :deadline org-agenda-entry-types)))
3948 (cond
3949 ((memq org-agenda-show-log-scoped '(only clockcheck))
3950 (setq rtn (org-agenda-get-day-entries
3951 file date :closed)))
3952 (org-agenda-show-log-scoped
3953 (setq rtn (apply 'org-agenda-get-day-entries
3954 file date
3955 (append '(:closed) org-agenda-entry-types))))
3957 (setq rtn (apply 'org-agenda-get-day-entries
3958 file date
3959 org-agenda-entry-types)))))
3960 (setq rtnall (append rtnall rtn)))) ;; all entries
3961 (if org-agenda-include-diary
3962 (let ((org-agenda-search-headline-for-time t))
3963 (require 'diary-lib)
3964 (setq rtn (org-get-entries-from-diary date))
3965 (setq rtnall (append rtnall rtn))))
3966 (if (or rtnall org-agenda-show-all-dates)
3967 (progn
3968 (setq day-cnt (1+ day-cnt))
3969 (insert
3970 (if (stringp org-agenda-format-date)
3971 (format-time-string org-agenda-format-date
3972 (org-time-from-absolute date))
3973 (funcall org-agenda-format-date date))
3974 "\n")
3975 (put-text-property s (1- (point)) 'face
3976 (org-agenda-get-day-face date))
3977 (put-text-property s (1- (point)) 'org-date-line t)
3978 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3979 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3980 (when todayp
3981 (put-text-property s (1- (point)) 'org-today t))
3982 (setq rtnall
3983 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
3984 (if rtnall (insert ;; all entries
3985 (org-finalize-agenda-entries rtnall)
3986 "\n"))
3987 (put-text-property s (1- (point)) 'day d)
3988 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3989 (when (and org-agenda-clockreport-mode clocktable-start)
3990 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3991 ;; the above line is to ensure the restricted range!
3992 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3993 tbl)
3994 (setq p (org-plist-delete p :block))
3995 (setq p (plist-put p :tstart clocktable-start))
3996 (setq p (plist-put p :tend clocktable-end))
3997 (setq p (plist-put p :scope 'agenda))
3998 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3999 (setq filter (or org-agenda-tag-filter-while-redo
4000 (get 'org-agenda-tag-filter :preset-filter))))
4001 (setq p (plist-put p :tags (mapconcat (lambda (x)
4002 (if (string-match "[<>=]" x)
4005 filter ""))))
4006 (setq tbl (apply 'org-get-clocktable p))
4007 (insert tbl)))
4008 (goto-char (point-min))
4009 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4010 (unless (and (pos-visible-in-window-p (point-min))
4011 (pos-visible-in-window-p (point-max)))
4012 (goto-char (1- (point-max)))
4013 (recenter -1)
4014 (if (not (pos-visible-in-window-p (or start-pos 1)))
4015 (progn
4016 (goto-char (or start-pos 1))
4017 (recenter 1))))
4018 (goto-char (or start-pos 1))
4019 (add-text-properties (point-min) (point-max)
4020 `(org-agenda-type agenda
4021 org-last-args (,arg ,start-day ,span)
4022 org-redo-cmd ,org-agenda-redo-command
4023 org-serie-cmd ,org-cmd))
4024 (if (eq org-agenda-show-log-scoped 'clockcheck)
4025 (org-agenda-show-clocking-issues))
4026 (org-finalize-agenda)
4027 (setq buffer-read-only t)
4028 (message ""))))
4030 (defun org-agenda-ndays-to-span (n)
4031 "Return a span symbol for a span of N days, or N if none matches."
4032 (cond ((symbolp n) n)
4033 ((= n 1) 'day)
4034 ((= n 7) 'week)
4035 (t n)))
4037 (defun org-agenda-span-to-ndays (span start-day)
4038 "Return ndays from SPAN starting at START-DAY."
4039 (cond ((numberp span) span)
4040 ((eq span 'day) 1)
4041 ((eq span 'week) 7)
4042 ((eq span 'month)
4043 (let ((date (calendar-gregorian-from-absolute start-day)))
4044 (calendar-last-day-of-month (car date) (caddr date))))
4045 ((eq span 'year)
4046 (let ((date (calendar-gregorian-from-absolute start-day)))
4047 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4049 (defun org-agenda-span-name (span)
4050 "Return a SPAN name."
4051 (if (null span)
4053 (if (symbolp span)
4054 (capitalize (symbol-name span))
4055 (format "%d days" span))))
4057 ;;; Agenda word search
4059 (defvar org-agenda-search-history nil)
4061 (defvar org-search-syntax-table nil
4062 "Special syntax table for org-mode search.
4063 In this table, we have single quotes not as word constituents, to
4064 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4066 (defvar org-mode-syntax-table) ; From org.el
4067 (defun org-search-syntax-table ()
4068 (unless org-search-syntax-table
4069 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4070 (modify-syntax-entry ?' "." org-search-syntax-table)
4071 (modify-syntax-entry ?` "." org-search-syntax-table))
4072 org-search-syntax-table)
4074 (defvar org-agenda-last-search-view-search-was-boolean nil)
4076 ;;;###autoload
4077 (defun org-search-view (&optional todo-only string edit-at)
4078 "Show all entries that contain a phrase or words or regular expressions.
4080 With optional prefix argument TODO-ONLY, only consider entries that are
4081 TODO entries. The argument STRING can be used to pass a default search
4082 string into this function. If EDIT-AT is non-nil, it means that the
4083 user should get a chance to edit this string, with cursor at position
4084 EDIT-AT.
4086 The search string can be viewed either as a phrase that should be found as
4087 is, or it can be broken into a number of snippets, each of which must match
4088 in a Boolean way to select an entry. The default depends on the variable
4089 `org-agenda-search-view-always-boolean'.
4090 Even if this is turned off (the default) you can always switch to
4091 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4093 The default is a direct search of the whole phrase, where each space in
4094 the search string can expand to an arbitrary amount of whitespace,
4095 including newlines.
4097 If using a Boolean search, the search string is split on whitespace and
4098 each snippet is searched separately, with logical AND to select an entry.
4099 Words prefixed with a minus must *not* occur in the entry. Words without
4100 a prefix or prefixed with a plus must occur in the entry. Matching is
4101 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4102 match whole words, not parts of a word) if
4103 `org-agenda-search-view-force-full-words' is set (default is nil).
4105 Boolean search snippets enclosed by curly braces are interpreted as
4106 regular expressions that must or (when preceded with \"-\") must not
4107 match in the entry. Snippets enclosed into double quotes will be taken
4108 as a whole, to include whitespace.
4110 - If the search string starts with an asterisk, search only in headlines.
4111 - If (possibly after the leading star) the search string starts with an
4112 exclamation mark, this also means to look at TODO entries only, an effect
4113 that can also be achieved with a prefix argument.
4114 - If (possibly after star and exclamation mark) the search string starts
4115 with a colon, this will mean that the (non-regexp) snippets of the
4116 Boolean search must match as full words.
4118 This command searches the agenda files, and in addition the files listed
4119 in `org-agenda-text-search-extra-files'."
4120 (interactive "P")
4121 (if org-agenda-overriding-arguments
4122 (setq todo-only (car org-agenda-overriding-arguments)
4123 string (nth 1 org-agenda-overriding-arguments)
4124 edit-at (nth 2 org-agenda-overriding-arguments)))
4125 (let* ((props (list 'face nil
4126 'done-face 'org-agenda-done
4127 'org-not-done-regexp org-not-done-regexp
4128 'org-todo-regexp org-todo-regexp
4129 'org-complex-heading-regexp org-complex-heading-regexp
4130 'mouse-face 'highlight
4131 'help-echo (format "mouse-2 or RET jump to location")))
4132 (full-words org-agenda-search-view-force-full-words)
4133 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4134 regexp rtn rtnall files file pos
4135 marker category category-pos tags c neg re boolean
4136 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4137 (unless (and (not edit-at)
4138 (stringp string)
4139 (string-match "\\S-" string))
4140 (setq string (read-string
4141 (if org-agenda-search-view-always-boolean
4142 "[+-]Word/{Regexp} ...: "
4143 "Phrase or [+-]Word/{Regexp} ...: ")
4144 (cond
4145 ((integerp edit-at) (cons string edit-at))
4146 (edit-at string))
4147 'org-agenda-search-history)))
4148 (catch 'exit
4149 (if org-agenda-sticky
4150 (setq org-agenda-buffer-name
4151 (if (stringp string)
4152 (format "*Org Agenda(%s:%s)*"
4153 (or org-keys (or (and todo-only "S") "s")) string)
4154 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4155 (org-agenda-prepare "SEARCH")
4156 (org-compile-prefix-format 'search)
4157 (org-set-sorting-strategy 'search)
4158 (setq org-agenda-redo-command
4159 (list 'org-search-view (if todo-only t nil)
4160 (list 'if 'current-prefix-arg nil string)))
4161 (setq org-agenda-query-string string)
4162 (if (equal (string-to-char string) ?*)
4163 (setq hdl-only t
4164 words (substring string 1))
4165 (setq words string))
4166 (when (equal (string-to-char words) ?!)
4167 (setq todo-only t
4168 words (substring words 1)))
4169 (when (equal (string-to-char words) ?:)
4170 (setq full-words t
4171 words (substring words 1)))
4172 (if (or org-agenda-search-view-always-boolean
4173 (member (string-to-char words) '(?- ?+ ?\{)))
4174 (setq boolean t))
4175 (setq words (org-split-string words))
4176 (let (www w)
4177 (while (setq w (pop words))
4178 (while (and (string-match "\\\\\\'" w) words)
4179 (setq w (concat (substring w 0 -1) " " (pop words))))
4180 (push w www))
4181 (setq words (nreverse www) www nil)
4182 (while (setq w (pop words))
4183 (when (and (string-match "\\`[-+]?{" w)
4184 (not (string-match "}\\'" w)))
4185 (while (and words (not (string-match "}\\'" (car words))))
4186 (setq w (concat w " " (pop words))))
4187 (setq w (concat w " " (pop words))))
4188 (push w www))
4189 (setq words (nreverse www)))
4190 (setq org-agenda-last-search-view-search-was-boolean boolean)
4191 (when boolean
4192 (let (wds w)
4193 (while (setq w (pop words))
4194 (if (or (equal (substring w 0 1) "\"")
4195 (and (> (length w) 1)
4196 (member (substring w 0 1) '("+" "-"))
4197 (equal (substring w 1 2) "\"")))
4198 (while (and words (not (equal (substring w -1) "\"")))
4199 (setq w (concat w " " (pop words)))))
4200 (and (string-match "\\`\\([-+]?\\)\"" w)
4201 (setq w (replace-match "\\1" nil nil w)))
4202 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4203 (push w wds))
4204 (setq words (nreverse wds))))
4205 (if boolean
4206 (mapc (lambda (w)
4207 (setq c (string-to-char w))
4208 (if (equal c ?-)
4209 (setq neg t w (substring w 1))
4210 (if (equal c ?+)
4211 (setq neg nil w (substring w 1))
4212 (setq neg nil)))
4213 (if (string-match "\\`{.*}\\'" w)
4214 (setq re (substring w 1 -1))
4215 (if full-words
4216 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4217 (setq re (regexp-quote (downcase w)))))
4218 (if neg (push re regexps-) (push re regexps+)))
4219 words)
4220 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4221 regexps+))
4222 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4223 (if (not regexps+)
4224 (setq regexp org-outline-regexp-bol)
4225 (setq regexp (pop regexps+))
4226 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4227 regexp))))
4228 (setq files (org-agenda-files nil 'ifmode))
4229 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4230 (pop org-agenda-text-search-extra-files)
4231 (setq files (org-add-archive-files files)))
4232 (setq files (append files org-agenda-text-search-extra-files)
4233 rtnall nil)
4234 (while (setq file (pop files))
4235 (setq ee nil)
4236 (catch 'nextfile
4237 (org-check-agenda-file file)
4238 (setq buffer (if (file-exists-p file)
4239 (org-get-agenda-file-buffer file)
4240 (error "No such file %s" file)))
4241 (if (not buffer)
4242 ;; If file does not exist, make sure an error message is sent
4243 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4244 file))))
4245 (with-current-buffer buffer
4246 (with-syntax-table (org-search-syntax-table)
4247 (unless (derived-mode-p 'org-mode)
4248 (error "Agenda file %s is not in `org-mode'" file))
4249 (let ((case-fold-search t))
4250 (save-excursion
4251 (save-restriction
4252 (if org-agenda-restrict
4253 (narrow-to-region org-agenda-restrict-begin
4254 org-agenda-restrict-end)
4255 (widen))
4256 (goto-char (point-min))
4257 (unless (or (org-at-heading-p)
4258 (outline-next-heading))
4259 (throw 'nextfile t))
4260 (goto-char (max (point-min) (1- (point))))
4261 (while (re-search-forward regexp nil t)
4262 (org-back-to-heading t)
4263 (skip-chars-forward "* ")
4264 (setq beg (point-at-bol)
4265 beg1 (point)
4266 end (progn (outline-next-heading) (point)))
4267 (catch :skip
4268 (goto-char beg)
4269 (org-agenda-skip)
4270 (setq str (buffer-substring-no-properties
4271 (point-at-bol)
4272 (if hdl-only (point-at-eol) end)))
4273 (mapc (lambda (wr) (when (string-match wr str)
4274 (goto-char (1- end))
4275 (throw :skip t)))
4276 regexps-)
4277 (mapc (lambda (wr) (unless (string-match wr str)
4278 (goto-char (1- end))
4279 (throw :skip t)))
4280 (if todo-only
4281 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4282 regexps+)
4283 regexps+))
4284 (goto-char beg)
4285 (setq marker (org-agenda-new-marker (point))
4286 category (org-get-category)
4287 category-pos (get-text-property (point) 'org-category-position)
4288 tags (org-get-tags-at (point))
4289 txt (org-agenda-format-item
4291 (buffer-substring-no-properties
4292 beg1 (point-at-eol))
4293 category tags))
4294 (org-add-props txt props
4295 'org-marker marker 'org-hd-marker marker
4296 'org-todo-regexp org-todo-regexp
4297 'org-complex-heading-regexp org-complex-heading-regexp
4298 'priority 1000 'org-category category
4299 'org-category-position category-pos
4300 'type "search")
4301 (push txt ee)
4302 (goto-char (1- end))))))))))
4303 (setq rtn (nreverse ee))
4304 (setq rtnall (append rtnall rtn)))
4305 (if org-agenda-overriding-header
4306 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4307 nil 'face 'org-agenda-structure) "\n")
4308 (insert "Search words: ")
4309 (add-text-properties (point-min) (1- (point))
4310 (list 'face 'org-agenda-structure))
4311 (setq pos (point))
4312 (insert string "\n")
4313 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4314 (setq pos (point))
4315 (unless org-agenda-multi
4316 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4317 (add-text-properties pos (1- (point))
4318 (list 'face 'org-agenda-structure))))
4319 (org-agenda-mark-header-line (point-min))
4320 (when rtnall
4321 (insert (org-finalize-agenda-entries rtnall) "\n"))
4322 (goto-char (point-min))
4323 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4324 (add-text-properties (point-min) (point-max)
4325 `(org-agenda-type search
4326 org-last-args (,todo-only ,string ,edit-at)
4327 org-redo-cmd ,org-agenda-redo-command
4328 org-serie-cmd ,org-cmd))
4329 (org-finalize-agenda)
4330 (setq buffer-read-only t))))
4332 ;;; Agenda TODO list
4334 (defvar org-select-this-todo-keyword nil)
4335 (defvar org-last-arg nil)
4337 ;;;###autoload
4338 (defun org-todo-list (&optional arg)
4339 "Show all (not done) TODO entries from all agenda file in a single list.
4340 The prefix arg can be used to select a specific TODO keyword and limit
4341 the list to these. When using \\[universal-argument], you will be prompted
4342 for a keyword. A numeric prefix directly selects the Nth keyword in
4343 `org-todo-keywords-1'."
4344 (interactive "P")
4345 (if org-agenda-overriding-arguments
4346 (setq arg org-agenda-overriding-arguments))
4347 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4348 (let* ((today (org-today))
4349 (date (calendar-gregorian-from-absolute today))
4350 (kwds org-todo-keywords-for-agenda)
4351 (completion-ignore-case t)
4352 (org-select-this-todo-keyword
4353 (if (stringp arg) arg
4354 (and arg (integerp arg) (> arg 0)
4355 (nth (1- arg) kwds))))
4356 rtn rtnall files file pos)
4357 (when (equal arg '(4))
4358 (setq org-select-this-todo-keyword
4359 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4360 (mapcar 'list kwds) nil nil)))
4361 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4362 (catch 'exit
4363 (if org-agenda-sticky
4364 (setq org-agenda-buffer-name
4365 (if (stringp org-select-this-todo-keyword)
4366 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4367 org-select-this-todo-keyword)
4368 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4369 (org-agenda-prepare "TODO")
4370 (org-compile-prefix-format 'todo)
4371 (org-set-sorting-strategy 'todo)
4372 (setq org-agenda-redo-command
4373 `(org-todo-list (or current-prefix-arg (quote ,arg))))
4374 (setq files (org-agenda-files nil 'ifmode)
4375 rtnall nil)
4376 (while (setq file (pop files))
4377 (catch 'nextfile
4378 (org-check-agenda-file file)
4379 (setq rtn (org-agenda-get-day-entries file date :todo))
4380 (setq rtnall (append rtnall rtn))))
4381 (if org-agenda-overriding-header
4382 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4383 nil 'face 'org-agenda-structure) "\n")
4384 (insert "Global list of TODO items of type: ")
4385 (add-text-properties (point-min) (1- (point))
4386 (list 'face 'org-agenda-structure
4387 'short-heading
4388 (concat "ToDo: "
4389 (or org-select-this-todo-keyword "ALL"))))
4390 (org-agenda-mark-header-line (point-min))
4391 (setq pos (point))
4392 (insert (or org-select-this-todo-keyword "ALL") "\n")
4393 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4394 (setq pos (point))
4395 (unless org-agenda-multi
4396 (insert "Available with `N r': (0)[ALL]")
4397 (let ((n 0) s)
4398 (mapc (lambda (x)
4399 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4400 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4401 (insert "\n "))
4402 (insert " " s))
4403 kwds))
4404 (insert "\n"))
4405 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4406 (org-agenda-mark-header-line (point-min))
4407 (when rtnall
4408 (insert (org-finalize-agenda-entries rtnall) "\n"))
4409 (goto-char (point-min))
4410 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4411 (add-text-properties (point-min) (point-max)
4412 `(org-agenda-type todo
4413 org-last-args ,arg
4414 org-redo-cmd ,org-agenda-redo-command
4415 org-serie-cmd ,org-cmd))
4416 (org-finalize-agenda)
4417 (setq buffer-read-only t))))
4419 ;;; Agenda tags match
4421 ;;;###autoload
4422 (defun org-tags-view (&optional todo-only match)
4423 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4424 The prefix arg TODO-ONLY limits the search to TODO entries."
4425 (interactive "P")
4426 (if org-agenda-overriding-arguments
4427 (setq todo-only (car org-agenda-overriding-arguments)
4428 match (nth 1 org-agenda-overriding-arguments)))
4429 (let* ((org-tags-match-list-sublevels
4430 org-tags-match-list-sublevels)
4431 (completion-ignore-case t)
4432 rtn rtnall files file pos matcher
4433 buffer)
4434 (when (and (stringp match) (not (string-match "\\S-" match)))
4435 (setq match nil))
4436 (setq matcher (org-make-tags-matcher match)
4437 match (car matcher) matcher (cdr matcher))
4438 (catch 'exit
4439 (if org-agenda-sticky
4440 (setq org-agenda-buffer-name
4441 (if (stringp match)
4442 (format "*Org Agenda(%s:%s)*"
4443 (or org-keys (or (and todo-only "M") "m")) match)
4444 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4445 (org-agenda-prepare (concat "TAGS " match))
4446 (org-compile-prefix-format 'tags)
4447 (org-set-sorting-strategy 'tags)
4448 (setq org-agenda-query-string match)
4449 (setq org-agenda-redo-command
4450 (list 'org-tags-view `(quote ,todo-only)
4451 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4452 (setq files (org-agenda-files nil 'ifmode)
4453 rtnall nil)
4454 (while (setq file (pop files))
4455 (catch 'nextfile
4456 (org-check-agenda-file file)
4457 (setq buffer (if (file-exists-p file)
4458 (org-get-agenda-file-buffer file)
4459 (error "No such file %s" file)))
4460 (if (not buffer)
4461 ;; If file does not exist, error message to agenda
4462 (setq rtn (list
4463 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4464 rtnall (append rtnall rtn))
4465 (with-current-buffer buffer
4466 (unless (derived-mode-p 'org-mode)
4467 (error "Agenda file %s is not in `org-mode'" file))
4468 (save-excursion
4469 (save-restriction
4470 (if org-agenda-restrict
4471 (narrow-to-region org-agenda-restrict-begin
4472 org-agenda-restrict-end)
4473 (widen))
4474 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4475 (setq rtnall (append rtnall rtn))))))))
4476 (if org-agenda-overriding-header
4477 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4478 nil 'face 'org-agenda-structure) "\n")
4479 (insert "Headlines with TAGS match: ")
4480 (add-text-properties (point-min) (1- (point))
4481 (list 'face 'org-agenda-structure
4482 'short-heading
4483 (concat "Match: " match)))
4484 (setq pos (point))
4485 (insert match "\n")
4486 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4487 (setq pos (point))
4488 (unless org-agenda-multi
4489 (insert "Press `C-u r' to search again with new search string\n"))
4490 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4491 (org-agenda-mark-header-line (point-min))
4492 (when rtnall
4493 (insert (org-finalize-agenda-entries rtnall) "\n"))
4494 (goto-char (point-min))
4495 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4496 (add-text-properties (point-min) (point-max)
4497 `(org-agenda-type tags
4498 org-last-args (,todo-only ,match)
4499 org-redo-cmd ,org-agenda-redo-command
4500 org-serie-cmd ,org-cmd))
4501 (org-finalize-agenda)
4502 (setq buffer-read-only t))))
4504 ;;; Agenda Finding stuck projects
4506 (defvar org-agenda-skip-regexp nil
4507 "Regular expression used in skipping subtrees for the agenda.
4508 This is basically a temporary global variable that can be set and then
4509 used by user-defined selections using `org-agenda-skip-function'.")
4511 (defvar org-agenda-overriding-header nil
4512 "When set during agenda, todo and tags searches it replaces the header.
4513 This variable should not be set directly, but custom commands can bind it
4514 in the options section.")
4516 (defun org-agenda-skip-entry-when-regexp-matches ()
4517 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4518 If yes, it returns the end position of this entry, causing agenda commands
4519 to skip the entry but continuing the search in the subtree. This is a
4520 function that can be put into `org-agenda-skip-function' for the duration
4521 of a command."
4522 (let ((end (save-excursion (org-end-of-subtree t)))
4523 skip)
4524 (save-excursion
4525 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4526 (and skip end)))
4528 (defun org-agenda-skip-subtree-when-regexp-matches ()
4529 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4530 If yes, it returns the end position of this tree, causing agenda commands
4531 to skip this subtree. This is a function that can be put into
4532 `org-agenda-skip-function' for the duration of a command."
4533 (let ((end (save-excursion (org-end-of-subtree t)))
4534 skip)
4535 (save-excursion
4536 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4537 (and skip end)))
4539 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4540 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4541 If yes, it returns the end position of the current entry (NOT the tree),
4542 causing agenda commands to skip the entry but continuing the search in
4543 the subtree. This is a function that can be put into
4544 `org-agenda-skip-function' for the duration of a command. An important
4545 use of this function is for the stuck project list."
4546 (let ((end (save-excursion (org-end-of-subtree t)))
4547 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4548 skip)
4549 (save-excursion
4550 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4551 (and skip entry-end)))
4553 (defun org-agenda-skip-entry-if (&rest conditions)
4554 "Skip entry if any of CONDITIONS is true.
4555 See `org-agenda-skip-if' for details."
4556 (org-agenda-skip-if nil conditions))
4558 (defun org-agenda-skip-subtree-if (&rest conditions)
4559 "Skip entry if any of CONDITIONS is true.
4560 See `org-agenda-skip-if' for details."
4561 (org-agenda-skip-if t conditions))
4563 (defun org-agenda-skip-if (subtree conditions)
4564 "Checks current entity for CONDITIONS.
4565 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4566 the entry (i.e. the text before the next heading) is checked.
4568 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4569 from different tests. Valid conditions are:
4571 scheduled Check if there is a scheduled cookie
4572 notscheduled Check if there is no scheduled cookie
4573 deadline Check if there is a deadline
4574 notdeadline Check if there is no deadline
4575 timestamp Check if there is a timestamp (also deadline or scheduled)
4576 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4577 regexp Check if regexp matches
4578 notregexp Check if regexp does not match.
4579 todo Check if TODO keyword matches
4580 nottodo Check if TODO keyword does not match
4582 The regexp is taken from the conditions list, it must come right after
4583 the `regexp' or `notregexp' element.
4585 `todo' and `nottodo' accept as an argument a list of todo
4586 keywords, which may include \"*\" to match any todo keyword.
4588 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4590 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4592 Instead of a list, a keyword class may be given. For example:
4594 (org-agenda-skip-entry-if 'nottodo 'done)
4596 would skip entries that haven't been marked with any of \"DONE\"
4597 keywords. Possible classes are: `todo', `done', `any'.
4599 If any of these conditions is met, this function returns the end point of
4600 the entity, causing the search to continue from there. This is a function
4601 that can be put into `org-agenda-skip-function' for the duration of a command."
4602 (let (beg end m)
4603 (org-back-to-heading t)
4604 (setq beg (point)
4605 end (if subtree
4606 (progn (org-end-of-subtree t) (point))
4607 (progn (outline-next-heading) (1- (point)))))
4608 (goto-char beg)
4609 (and
4611 (and (memq 'scheduled conditions)
4612 (re-search-forward org-scheduled-time-regexp end t))
4613 (and (memq 'notscheduled conditions)
4614 (not (re-search-forward org-scheduled-time-regexp end t)))
4615 (and (memq 'deadline conditions)
4616 (re-search-forward org-deadline-time-regexp end t))
4617 (and (memq 'notdeadline conditions)
4618 (not (re-search-forward org-deadline-time-regexp end t)))
4619 (and (memq 'timestamp conditions)
4620 (re-search-forward org-ts-regexp end t))
4621 (and (memq 'nottimestamp conditions)
4622 (not (re-search-forward org-ts-regexp end t)))
4623 (and (setq m (memq 'regexp conditions))
4624 (stringp (nth 1 m))
4625 (re-search-forward (nth 1 m) end t))
4626 (and (setq m (memq 'notregexp conditions))
4627 (stringp (nth 1 m))
4628 (not (re-search-forward (nth 1 m) end t)))
4629 (and (or
4630 (setq m (memq 'nottodo conditions))
4631 (setq m (memq 'todo-unblocked conditions))
4632 (setq m (memq 'nottodo-unblocked conditions))
4633 (setq m (memq 'todo conditions)))
4634 (org-agenda-skip-if-todo m end)))
4635 end)))
4637 (defun org-agenda-skip-if-todo (args end)
4638 "Helper function for `org-agenda-skip-if', do not use it directly.
4639 ARGS is a list with first element either `todo', `nottodo',
4640 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4641 a list of TODO keywords, or a state symbol `todo' or `done' or
4642 `any'."
4643 (let ((kw (car args))
4644 (arg (cadr args))
4645 todo-wds todo-re)
4646 (setq todo-wds
4647 (org-uniquify
4648 (cond
4649 ((listp arg) ;; list of keywords
4650 (if (member "*" arg)
4651 (mapcar 'substring-no-properties org-todo-keywords-1)
4652 arg))
4653 ((symbolp arg) ;; keyword class name
4654 (cond
4655 ((eq arg 'todo)
4656 (org-delete-all org-done-keywords
4657 (mapcar 'substring-no-properties
4658 org-todo-keywords-1)))
4659 ((eq arg 'done) org-done-keywords)
4660 ((eq arg 'any)
4661 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4662 (setq todo-re
4663 (concat "^\\*+[ \t]+\\<\\("
4664 (mapconcat 'identity todo-wds "\\|")
4665 "\\)\\>"))
4666 (cond
4667 ((eq kw 'todo) (re-search-forward todo-re end t))
4668 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
4669 ((eq kw 'todo-unblocked)
4670 (catch 'unblocked
4671 (while (re-search-forward todo-re end t)
4672 (or (org-entry-blocked-p) (throw 'unblocked t)))
4673 nil))
4674 ((eq kw 'nottodo-unblocked)
4675 (catch 'unblocked
4676 (while (re-search-forward todo-re end t)
4677 (or (org-entry-blocked-p) (throw 'unblocked nil)))
4681 ;;;###autoload
4682 (defun org-agenda-list-stuck-projects (&rest ignore)
4683 "Create agenda view for projects that are stuck.
4684 Stuck projects are project that have no next actions. For the definitions
4685 of what a project is and how to check if it stuck, customize the variable
4686 `org-stuck-projects'."
4687 (interactive)
4688 (let* ((org-agenda-skip-function
4689 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4690 ;; We could have used org-agenda-skip-if here.
4691 (org-agenda-overriding-header
4692 (or org-agenda-overriding-header "List of stuck projects: "))
4693 (matcher (nth 0 org-stuck-projects))
4694 (todo (nth 1 org-stuck-projects))
4695 (todo-wds (if (member "*" todo)
4696 (progn
4697 (org-agenda-prepare-buffers (org-agenda-files
4698 nil 'ifmode))
4699 (org-delete-all
4700 org-done-keywords-for-agenda
4701 (copy-sequence org-todo-keywords-for-agenda)))
4702 todo))
4703 (todo-re (concat "^\\*+[ \t]+\\("
4704 (mapconcat 'identity todo-wds "\\|")
4705 "\\)\\>"))
4706 (tags (nth 2 org-stuck-projects))
4707 (tags-re (if (member "*" tags)
4708 (concat org-outline-regexp-bol
4709 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4710 (if tags
4711 (concat org-outline-regexp-bol
4712 ".*:\\("
4713 (mapconcat 'identity tags "\\|")
4714 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4715 (gen-re (nth 3 org-stuck-projects))
4716 (re-list
4717 (delq nil
4718 (list
4719 (if todo todo-re)
4720 (if tags tags-re)
4721 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4722 gen-re)))))
4723 (setq org-agenda-skip-regexp
4724 (if re-list
4725 (mapconcat 'identity re-list "\\|")
4726 (error "No information how to identify unstuck projects")))
4727 (org-tags-view nil matcher)
4728 (with-current-buffer org-agenda-buffer-name
4729 (setq org-agenda-redo-command
4730 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
4732 ;;; Diary integration
4734 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4735 (defvar diary-list-entries-hook)
4736 (defvar diary-time-regexp)
4737 (defun org-get-entries-from-diary (date)
4738 "Get the (Emacs Calendar) diary entries for DATE."
4739 (require 'diary-lib)
4740 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4741 (diary-display-hook '(fancy-diary-display))
4742 (diary-display-function 'fancy-diary-display)
4743 (pop-up-frames nil)
4744 (diary-list-entries-hook
4745 (cons 'org-diary-default-entry diary-list-entries-hook))
4746 (diary-file-name-prefix-function nil) ; turn this feature off
4747 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4748 entries
4749 (org-disable-agenda-to-diary t))
4750 (save-excursion
4751 (save-window-excursion
4752 (funcall (if (fboundp 'diary-list-entries)
4753 'diary-list-entries 'list-diary-entries)
4754 date 1)))
4755 (if (not (get-buffer diary-fancy-buffer))
4756 (setq entries nil)
4757 (with-current-buffer diary-fancy-buffer
4758 (setq buffer-read-only nil)
4759 (if (zerop (buffer-size))
4760 ;; No entries
4761 (setq entries nil)
4762 ;; Omit the date and other unnecessary stuff
4763 (org-agenda-cleanup-fancy-diary)
4764 ;; Add prefix to each line and extend the text properties
4765 (if (zerop (buffer-size))
4766 (setq entries nil)
4767 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4768 (setq entries
4769 (with-temp-buffer
4770 (insert entries) (goto-char (point-min))
4771 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4772 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4773 (replace-match (concat "; " (match-string 1)))))
4774 (buffer-string)))))
4775 (set-buffer-modified-p nil)
4776 (kill-buffer diary-fancy-buffer)))
4777 (when entries
4778 (setq entries (org-split-string entries "\n"))
4779 (setq entries
4780 (mapcar
4781 (lambda (x)
4782 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4783 ;; Extend the text properties to the beginning of the line
4784 (org-add-props x (text-properties-at (1- (length x)) x)
4785 'type "diary" 'date date 'face 'org-agenda-diary))
4786 entries)))))
4788 (defvar org-agenda-cleanup-fancy-diary-hook nil
4789 "Hook run when the fancy diary buffer is cleaned up.")
4791 (defun org-agenda-cleanup-fancy-diary ()
4792 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4793 This gets rid of the date, the underline under the date, and
4794 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4795 date. It also removes lines that contain only whitespace."
4796 (goto-char (point-min))
4797 (if (looking-at ".*?:[ \t]*")
4798 (progn
4799 (replace-match "")
4800 (re-search-forward "\n=+$" nil t)
4801 (replace-match "")
4802 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4803 (re-search-forward "\n=+$" nil t)
4804 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4805 (goto-char (point-min))
4806 (while (re-search-forward "^ +\n" nil t)
4807 (replace-match ""))
4808 (goto-char (point-min))
4809 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4810 (replace-match ""))
4811 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4813 ;; Make sure entries from the diary have the right text properties.
4814 (eval-after-load "diary-lib"
4815 '(if (boundp 'diary-modify-entry-list-string-function)
4816 ;; We can rely on the hook, nothing to do
4818 ;; Hook not available, must use advice to make this work
4819 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4820 "Make the position visible."
4821 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4822 (stringp string)
4823 buffer-file-name)
4824 (setq string (org-modify-diary-entry-string string))))))
4826 (defun org-modify-diary-entry-string (string)
4827 "Add text properties to string, allowing org-mode to act on it."
4828 (org-add-props string nil
4829 'mouse-face 'highlight
4830 'help-echo (if buffer-file-name
4831 (format "mouse-2 or RET jump to diary file %s"
4832 (abbreviate-file-name buffer-file-name))
4834 'org-agenda-diary-link t
4835 'org-marker (org-agenda-new-marker (point-at-bol))))
4837 (defun org-diary-default-entry ()
4838 "Add a dummy entry to the diary.
4839 Needed to avoid empty dates which mess up holiday display."
4840 ;; Catch the error if dealing with the new add-to-diary-alist
4841 (when org-disable-agenda-to-diary
4842 (condition-case nil
4843 (org-add-to-diary-list original-date "Org-mode dummy" "")
4844 (error
4845 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4847 (defun org-add-to-diary-list (&rest args)
4848 (if (fboundp 'diary-add-to-list)
4849 (apply 'diary-add-to-list args)
4850 (apply 'add-to-diary-list args)))
4852 (defvar org-diary-last-run-time nil)
4854 ;;;###autoload
4855 (defun org-diary (&rest args)
4856 "Return diary information from org files.
4857 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4858 It accesses org files and extracts information from those files to be
4859 listed in the diary. The function accepts arguments specifying what
4860 items should be listed. For a list of arguments allowed here, see the
4861 variable `org-agenda-entry-types'.
4863 The call in the diary file should look like this:
4865 &%%(org-diary) ~/path/to/some/orgfile.org
4867 Use a separate line for each org file to check. Or, if you omit the file name,
4868 all files listed in `org-agenda-files' will be checked automatically:
4870 &%%(org-diary)
4872 If you don't give any arguments (as in the example above), the default
4873 arguments (:deadline :scheduled :timestamp :sexp) are used.
4874 So the example above may also be written as
4876 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4878 The function expects the lisp variables `entry' and `date' to be provided
4879 by the caller, because this is how the calendar works. Don't use this
4880 function from a program - use `org-agenda-get-day-entries' instead."
4881 (when (> (- (org-float-time)
4882 org-agenda-last-marker-time)
4884 ;; I am not sure if this works with sticky agendas, because the marker
4885 ;; list is then no longer a global variable.
4886 (org-agenda-reset-markers))
4887 ;; Prevent `org-compile-prefix-format' to fail when there is no agenda
4888 (when (buffer-live-p org-agenda-buffer)
4889 (org-compile-prefix-format 'agenda))
4890 (org-set-sorting-strategy 'agenda)
4891 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4892 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4893 (list entry)
4894 (org-agenda-files t)))
4895 (time (org-float-time))
4896 file rtn results)
4897 (when (or (not org-diary-last-run-time)
4898 (> (- time
4899 org-diary-last-run-time)
4901 (org-agenda-prepare-buffers files))
4902 (setq org-diary-last-run-time time)
4903 ;; If this is called during org-agenda, don't return any entries to
4904 ;; the calendar. Org Agenda will list these entries itself.
4905 (if org-disable-agenda-to-diary (setq files nil))
4906 (while (setq file (pop files))
4907 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4908 (setq results (append results rtn)))
4909 (if results
4910 (concat (org-finalize-agenda-entries results) "\n"))))
4912 ;;; Agenda entry finders
4914 (defun org-agenda-get-day-entries (file date &rest args)
4915 "Does the work for `org-diary' and `org-agenda'.
4916 FILE is the path to a file to be checked for entries. DATE is date like
4917 the one returned by `calendar-current-date'. ARGS are symbols indicating
4918 which kind of entries should be extracted. For details about these, see
4919 the documentation of `org-diary'."
4920 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4921 (let* ((org-startup-folded nil)
4922 (org-startup-align-all-tables nil)
4923 (buffer (if (file-exists-p file)
4924 (org-get-agenda-file-buffer file)
4925 (error "No such file %s" file)))
4926 arg results rtn deadline-results)
4927 (if (not buffer)
4928 ;; If file does not exist, make sure an error message ends up in diary
4929 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4930 (with-current-buffer buffer
4931 (unless (derived-mode-p 'org-mode)
4932 (error "Agenda file %s is not in `org-mode'" file))
4933 (let ((case-fold-search nil))
4934 (save-excursion
4935 (save-restriction
4936 (if org-agenda-restrict
4937 (narrow-to-region org-agenda-restrict-begin
4938 org-agenda-restrict-end)
4939 (widen))
4940 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4941 (while (setq arg (pop args))
4942 (cond
4943 ((and (eq arg :todo)
4944 (equal date (calendar-gregorian-from-absolute
4945 (org-today))))
4946 (setq rtn (org-agenda-get-todos))
4947 (setq results (append results rtn)))
4948 ((eq arg :timestamp)
4949 (setq rtn (org-agenda-get-blocks))
4950 (setq results (append results rtn))
4951 (setq rtn (org-agenda-get-timestamps deadline-results))
4952 (setq results (append results rtn)))
4953 ((eq arg :sexp)
4954 (setq rtn (org-agenda-get-sexps))
4955 (setq results (append results rtn)))
4956 ((eq arg :scheduled)
4957 (setq rtn (org-agenda-get-scheduled deadline-results))
4958 (setq results (append results rtn)))
4959 ((eq arg :closed)
4960 (setq rtn (org-agenda-get-progress))
4961 (setq results (append results rtn)))
4962 ((eq arg :deadline)
4963 (setq rtn (org-agenda-get-deadlines))
4964 (setq deadline-results (copy-sequence rtn))
4965 (setq results (append results rtn))))))))
4966 results))))
4968 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4969 (defun org-agenda-get-todos ()
4970 "Return the TODO information for agenda display."
4971 (let* ((props (list 'face nil
4972 'done-face 'org-agenda-done
4973 'org-not-done-regexp org-not-done-regexp
4974 'org-todo-regexp org-todo-regexp
4975 'org-complex-heading-regexp org-complex-heading-regexp
4976 'mouse-face 'highlight
4977 'help-echo
4978 (format "mouse-2 or RET jump to org file %s"
4979 (abbreviate-file-name buffer-file-name))))
4980 (regexp (format org-heading-keyword-regexp-format
4981 (cond
4982 ((and org-select-this-todo-keyword
4983 (equal org-select-this-todo-keyword "*"))
4984 org-todo-regexp)
4985 (org-select-this-todo-keyword
4986 (concat "\\("
4987 (mapconcat 'identity
4988 (org-split-string
4989 org-select-this-todo-keyword
4990 "|")
4991 "\\|") "\\)"))
4992 (t org-not-done-regexp))))
4993 marker priority category category-pos tags todo-state
4994 ee txt beg end)
4995 (goto-char (point-min))
4996 (while (re-search-forward regexp nil t)
4997 (catch :skip
4998 (save-match-data
4999 (beginning-of-line)
5000 (org-agenda-skip)
5001 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5002 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5003 (goto-char (1+ beg))
5004 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5005 (throw :skip nil)))
5006 (goto-char (match-beginning 2))
5007 (setq marker (org-agenda-new-marker (match-beginning 0))
5008 category (org-get-category)
5009 category-pos (get-text-property (point) 'org-category-position)
5010 txt (org-trim
5011 (buffer-substring (match-beginning 2) (match-end 0)))
5012 tags (org-get-tags-at (point))
5013 txt (org-agenda-format-item "" txt category tags)
5014 priority (1+ (org-get-priority txt))
5015 todo-state (org-get-todo-state))
5016 (org-add-props txt props
5017 'org-marker marker 'org-hd-marker marker
5018 'priority priority 'org-category category
5019 'org-category-position category-pos
5020 'type "todo" 'todo-state todo-state)
5021 (push txt ee)
5022 (if org-agenda-todo-list-sublevels
5023 (goto-char (match-end 2))
5024 (org-end-of-subtree 'invisible))))
5025 (nreverse ee)))
5027 (defun org-agenda-todo-custom-ignore-p (time n)
5028 "Check whether timestamp is farther away then n number of days.
5029 This function is invoked if `org-agenda-todo-ignore-deadlines',
5030 `org-agenda-todo-ignore-scheduled' or
5031 `org-agenda-todo-ignore-timestamp' is set to an integer."
5032 (let ((days (org-days-to-time time)))
5033 (if (>= n 0)
5034 (>= days n)
5035 (<= days n))))
5037 ;;;###autoload
5038 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5039 (&optional end)
5040 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5041 (when (or org-agenda-todo-ignore-with-date
5042 org-agenda-todo-ignore-scheduled
5043 org-agenda-todo-ignore-deadlines
5044 org-agenda-todo-ignore-timestamp)
5045 (setq end (or end (save-excursion (outline-next-heading) (point))))
5046 (save-excursion
5047 (or (and org-agenda-todo-ignore-with-date
5048 (re-search-forward org-ts-regexp end t))
5049 (and org-agenda-todo-ignore-scheduled
5050 (re-search-forward org-scheduled-time-regexp end t)
5051 (cond
5052 ((eq org-agenda-todo-ignore-scheduled 'future)
5053 (> (org-days-to-time (match-string 1)) 0))
5054 ((eq org-agenda-todo-ignore-scheduled 'past)
5055 (<= (org-days-to-time (match-string 1)) 0))
5056 ((numberp org-agenda-todo-ignore-scheduled)
5057 (org-agenda-todo-custom-ignore-p
5058 (match-string 1) org-agenda-todo-ignore-scheduled))
5059 (t)))
5060 (and org-agenda-todo-ignore-deadlines
5061 (re-search-forward org-deadline-time-regexp end t)
5062 (cond
5063 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5064 ((eq org-agenda-todo-ignore-deadlines 'far)
5065 (not (org-deadline-close (match-string 1))))
5066 ((eq org-agenda-todo-ignore-deadlines 'future)
5067 (> (org-days-to-time (match-string 1)) 0))
5068 ((eq org-agenda-todo-ignore-deadlines 'past)
5069 (<= (org-days-to-time (match-string 1)) 0))
5070 ((numberp org-agenda-todo-ignore-deadlines)
5071 (org-agenda-todo-custom-ignore-p
5072 (match-string 1) org-agenda-todo-ignore-deadlines))
5073 (t (org-deadline-close (match-string 1)))))
5074 (and org-agenda-todo-ignore-timestamp
5075 (let ((buffer (current-buffer))
5076 (regexp
5077 (concat
5078 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5079 (start (point)))
5080 ;; Copy current buffer into a temporary one
5081 (with-temp-buffer
5082 (insert-buffer-substring buffer start end)
5083 (goto-char (point-min))
5084 ;; Delete SCHEDULED and DEADLINE items
5085 (while (re-search-forward regexp end t)
5086 (delete-region (match-beginning 0) (match-end 0)))
5087 (goto-char (point-min))
5088 ;; No search for timestamp left
5089 (when (re-search-forward org-ts-regexp nil t)
5090 (cond
5091 ((eq org-agenda-todo-ignore-timestamp 'future)
5092 (> (org-days-to-time (match-string 1)) 0))
5093 ((eq org-agenda-todo-ignore-timestamp 'past)
5094 (<= (org-days-to-time (match-string 1)) 0))
5095 ((numberp org-agenda-todo-ignore-timestamp)
5096 (org-agenda-todo-custom-ignore-p
5097 (match-string 1) org-agenda-todo-ignore-timestamp))
5098 (t))))))))))
5100 (defconst org-agenda-no-heading-message
5101 "No heading for this item in buffer or region.")
5103 (defun org-agenda-get-timestamps (&optional deadline-results)
5104 "Return the date stamp information for agenda display."
5105 (let* ((props (list 'face 'org-agenda-calendar-event
5106 'org-not-done-regexp org-not-done-regexp
5107 'org-todo-regexp org-todo-regexp
5108 'org-complex-heading-regexp org-complex-heading-regexp
5109 'mouse-face 'highlight
5110 'help-echo
5111 (format "mouse-2 or RET jump to org file %s"
5112 (abbreviate-file-name buffer-file-name))))
5113 (d1 (calendar-absolute-from-gregorian date))
5115 (deadline-position-alist
5116 (mapcar (lambda (a) (and (setq mm (get-text-property
5117 0 'org-hd-marker a))
5118 (cons (marker-position mm) a)))
5119 deadline-results))
5120 (remove-re org-ts-regexp)
5121 (regexp
5122 (concat
5123 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5124 (regexp-quote
5125 (substring
5126 (format-time-string
5127 (car org-time-stamp-formats)
5128 (apply 'encode-time ; DATE bound by calendar
5129 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5130 1 11))
5131 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5132 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5133 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5134 donep tmp priority category category-pos ee txt timestr tags
5135 b0 b3 e3 head todo-state end-of-match show-all warntime)
5136 (goto-char (point-min))
5137 (while (setq end-of-match (re-search-forward regexp nil t))
5138 (setq b0 (match-beginning 0)
5139 b3 (match-beginning 3) e3 (match-end 3)
5140 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5141 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5142 (member todo-state
5143 org-agenda-repeating-timestamp-show-all)))
5144 (catch :skip
5145 (and (org-at-date-range-p) (throw :skip nil))
5146 (org-agenda-skip)
5147 (if (and (match-end 1)
5148 (not (= d1 (org-time-string-to-absolute
5149 (match-string 1) d1 nil show-all
5150 (current-buffer) b0))))
5151 (throw :skip nil))
5152 (if (and e3
5153 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5154 (throw :skip nil))
5155 (setq tmp (buffer-substring (max (point-min)
5156 (- b0 org-ds-keyword-length))
5158 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5159 inactivep (= (char-after b0) ?\[)
5160 deadlinep (string-match org-deadline-regexp tmp)
5161 scheduledp (string-match org-scheduled-regexp tmp)
5162 closedp (and org-agenda-include-inactive-timestamps
5163 (string-match org-closed-string tmp))
5164 clockp (and org-agenda-include-inactive-timestamps
5165 (or (string-match org-clock-string tmp)
5166 (string-match "]-+\\'" tmp)))
5167 warntime (org-entry-get (point) "APPT_WARNTIME")
5168 donep (member todo-state org-done-keywords))
5169 (if (or scheduledp deadlinep closedp clockp
5170 (and donep org-agenda-skip-timestamp-if-done))
5171 (throw :skip t))
5172 (if (string-match ">" timestr)
5173 ;; substring should only run to end of time stamp
5174 (setq timestr (substring timestr 0 (match-end 0))))
5175 (setq marker (org-agenda-new-marker b0)
5176 category (org-get-category b0)
5177 category-pos (get-text-property b0 'org-category-position))
5178 (save-excursion
5179 (if (not (re-search-backward org-outline-regexp-bol nil t))
5180 (setq txt org-agenda-no-heading-message)
5181 (goto-char (match-beginning 0))
5182 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5183 (assoc (point) deadline-position-alist))
5184 (throw :skip nil))
5185 (setq hdmarker (org-agenda-new-marker)
5186 tags (org-get-tags-at))
5187 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5188 (setq head (or (match-string 1) ""))
5189 (setq txt (org-agenda-format-item
5190 (if inactivep org-agenda-inactive-leader nil)
5191 head category tags timestr
5192 remove-re)))
5193 (setq priority (org-get-priority txt))
5194 (org-add-props txt props
5195 'org-marker marker 'org-hd-marker hdmarker)
5196 (org-add-props txt nil 'priority priority
5197 'org-category category 'date date
5198 'org-category-position category-pos
5199 'todo-state todo-state
5200 'warntime warntime
5201 'type "timestamp")
5202 (push txt ee))
5203 (if org-agenda-skip-additional-timestamps-same-entry
5204 (outline-next-heading)
5205 (goto-char end-of-match))))
5206 (nreverse ee)))
5208 (defun org-agenda-get-sexps ()
5209 "Return the sexp information for agenda display."
5210 (require 'diary-lib)
5211 (let* ((props (list 'face 'org-agenda-calendar-sexp
5212 'mouse-face 'highlight
5213 'help-echo
5214 (format "mouse-2 or RET jump to org file %s"
5215 (abbreviate-file-name buffer-file-name))))
5216 (regexp "^&?%%(")
5217 marker category extra category-pos ee txt tags entry
5218 result beg b sexp sexp-entry todo-state warntime)
5219 (goto-char (point-min))
5220 (while (re-search-forward regexp nil t)
5221 (catch :skip
5222 (org-agenda-skip)
5223 (setq beg (match-beginning 0))
5224 (goto-char (1- (match-end 0)))
5225 (setq b (point))
5226 (forward-sexp 1)
5227 (setq sexp (buffer-substring b (point)))
5228 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5229 (org-trim (match-string 1))
5230 ""))
5231 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5232 (when result
5233 (setq marker (org-agenda-new-marker beg)
5234 category (org-get-category beg)
5235 category-pos (get-text-property beg 'org-category-position)
5236 tags (save-excursion (org-backward-heading-same-level 0)
5237 (org-get-tags-at))
5238 todo-state (org-get-todo-state)
5239 warntime (org-entry-get (point) "APPT_WARNTIME"))
5241 (dolist (r (if (stringp result)
5242 (list result)
5243 result)) ;; we expect a list here
5244 (when (and org-agenda-diary-sexp-prefix
5245 (string-match org-agenda-diary-sexp-prefix r))
5246 (setq extra (match-string 0 r)
5247 r (replace-match "" nil nil r)))
5248 (if (string-match "\\S-" r)
5249 (setq txt r)
5250 (setq txt "SEXP entry returned empty string"))
5252 (setq txt (org-agenda-format-item
5253 extra txt category tags 'time))
5254 (org-add-props txt props 'org-marker marker)
5255 (org-add-props txt nil
5256 'org-category category 'date date 'todo-state todo-state
5257 'org-category-position category-pos 'tags tags
5258 'type "sexp" 'warntime warntime)
5259 (push txt ee)))))
5260 (nreverse ee)))
5262 ;; Calendar sanity: define some functions that are independent of
5263 ;; `calendar-date-style'.
5264 ;; Normally I would like to use ISO format when calling the diary functions,
5265 ;; but to make sure we still have Emacs 22 compatibility we bind
5266 ;; also `european-calendar-style' and use european format
5267 (defun org-anniversary (year month day &optional mark)
5268 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5269 (org-no-warnings
5270 (let ((calendar-date-style 'european) (european-calendar-style t))
5271 (diary-anniversary day month year mark))))
5272 (defun org-cyclic (N year month day &optional mark)
5273 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5274 (org-no-warnings
5275 (let ((calendar-date-style 'european) (european-calendar-style t))
5276 (diary-cyclic N day month year mark))))
5277 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5278 "Like `diary-block', but with fixed (ISO) order of arguments."
5279 (org-no-warnings
5280 (let ((calendar-date-style 'european) (european-calendar-style t))
5281 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5282 (defun org-date (year month day &optional mark)
5283 "Like `diary-date', but with fixed (ISO) order of arguments."
5284 (org-no-warnings
5285 (let ((calendar-date-style 'european) (european-calendar-style t))
5286 (diary-date day month year mark))))
5287 (defalias 'org-float 'diary-float)
5289 ;; Define the` org-class' function
5290 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5291 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5292 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5293 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5294 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5295 `holidays', then any date that is known by the Emacs calendar to be a
5296 holiday will also be skipped."
5297 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5298 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5299 (d (calendar-absolute-from-gregorian date)))
5300 (and
5301 (<= date1 d)
5302 (<= d date2)
5303 (= (calendar-day-of-week date) dayname)
5304 (or (not skip-weeks)
5305 (progn
5306 (require 'cal-iso)
5307 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5308 (not (and (memq 'holidays skip-weeks)
5309 (calendar-check-holidays date)))
5310 entry)))
5312 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5313 "Like `org-class', but honor `calendar-date-style'.
5314 The order of the first 2 times 3 arguments depends on the variable
5315 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5316 So for American calendars, give this as MONTH DAY YEAR, for European as
5317 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5318 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5319 is any number of ISO weeks in the block period for which the item should
5320 be skipped.
5322 This function is here only for backward compatibility and it is deprecated,
5323 please use `org-class' instead."
5324 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5325 (date2 (org-order-calendar-date-args m2 d2 y2)))
5326 (org-class
5327 (nth 2 date1) (car date1) (nth 1 date1)
5328 (nth 2 date2) (car date2) (nth 1 date2)
5329 dayname skip-weeks)))
5330 (make-obsolete 'org-diary-class 'org-class "")
5332 (defvar org-agenda-show-log-scoped) ;; dynamically scope in ̀org-timeline' or`org-agenda-list'
5333 (defalias 'org-get-closed 'org-agenda-get-progress)
5334 (defun org-agenda-get-progress ()
5335 "Return the logged TODO entries for agenda display."
5336 (let* ((props (list 'mouse-face 'highlight
5337 'org-not-done-regexp org-not-done-regexp
5338 'org-todo-regexp org-todo-regexp
5339 'org-complex-heading-regexp org-complex-heading-regexp
5340 'help-echo
5341 (format "mouse-2 or RET jump to org file %s"
5342 (abbreviate-file-name buffer-file-name))))
5343 (items (if (consp org-agenda-show-log-scoped)
5344 org-agenda-show-log-scoped
5345 (if (eq org-agenda-show-log-scoped 'clockcheck)
5346 '(clock)
5347 org-agenda-log-mode-items)))
5348 (parts
5349 (delq nil
5350 (list
5351 (if (memq 'closed items) (concat "\\<" org-closed-string))
5352 (if (memq 'clock items) (concat "\\<" org-clock-string))
5353 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5354 (parts-re (if parts (mapconcat 'identity parts "\\|")
5355 (error "`org-agenda-log-mode-items' is empty")))
5356 (regexp (concat
5357 "\\(" parts-re "\\)"
5358 " *\\["
5359 (regexp-quote
5360 (substring
5361 (format-time-string
5362 (car org-time-stamp-formats)
5363 (apply 'encode-time ; DATE bound by calendar
5364 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5365 1 11))))
5366 (org-agenda-search-headline-for-time nil)
5367 marker hdmarker priority category category-pos tags closedp
5368 statep clockp state ee txt extra timestr rest clocked)
5369 (goto-char (point-min))
5370 (while (re-search-forward regexp nil t)
5371 (catch :skip
5372 (org-agenda-skip)
5373 (setq marker (org-agenda-new-marker (match-beginning 0))
5374 closedp (equal (match-string 1) org-closed-string)
5375 statep (equal (string-to-char (match-string 1)) ?-)
5376 clockp (not (or closedp statep))
5377 state (and statep (match-string 2))
5378 category (org-get-category (match-beginning 0))
5379 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5380 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5381 (when (string-match "\\]" timestr)
5382 ;; substring should only run to end of time stamp
5383 (setq rest (substring timestr (match-end 0))
5384 timestr (substring timestr 0 (match-end 0)))
5385 (if (and (not closedp) (not statep)
5386 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5387 rest))
5388 (progn (setq timestr (concat (substring timestr 0 -1)
5389 "-" (match-string 1 rest) "]"))
5390 (setq clocked (match-string 2 rest)))
5391 (setq clocked "-")))
5392 (save-excursion
5393 (setq extra
5394 (cond
5395 ((not org-agenda-log-mode-add-notes) nil)
5396 (statep
5397 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5398 (match-string 1)))
5399 (clockp
5400 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5401 (match-string 1)))))
5402 (if (not (re-search-backward org-outline-regexp-bol nil t))
5403 (setq txt org-agenda-no-heading-message)
5404 (goto-char (match-beginning 0))
5405 (setq hdmarker (org-agenda-new-marker)
5406 tags (org-get-tags-at))
5407 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5408 (setq txt (match-string 1))
5409 (when extra
5410 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5411 (setq txt (concat (substring txt 0 (match-beginning 1))
5412 " - " extra " " (match-string 2 txt)))
5413 (setq txt (concat txt " - " extra))))
5414 (setq txt (org-agenda-format-item
5415 (cond
5416 (closedp "Closed: ")
5417 (statep (concat "State: (" state ")"))
5418 (t (concat "Clocked: (" clocked ")")))
5419 txt category tags timestr)))
5420 (setq priority 100000)
5421 (org-add-props txt props
5422 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5423 'priority priority 'org-category category
5424 'org-category-position category-pos
5425 'type "closed" 'date date
5426 'undone-face 'org-warning 'done-face 'org-agenda-done)
5427 (push txt ee))
5428 (goto-char (point-at-eol))))
5429 (nreverse ee)))
5431 (defun org-agenda-show-clocking-issues ()
5432 "Add overlays, showing issues with clocking.
5433 See also the user option `org-agenda-clock-consistency-checks'."
5434 (interactive)
5435 (let* ((pl org-agenda-clock-consistency-checks)
5436 (re (concat "^[ \t]*"
5437 org-clock-string
5438 "[ \t]+"
5439 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5440 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5441 (tlstart 0.)
5442 (tlend 0.)
5443 (maxtime (org-hh:mm-string-to-minutes
5444 (or (plist-get pl :max-duration) "24:00")))
5445 (mintime (org-hh:mm-string-to-minutes
5446 (or (plist-get pl :min-duration) 0)))
5447 (maxgap (org-hh:mm-string-to-minutes
5448 ;; default 30:00 means never complain
5449 (or (plist-get pl :max-gap) "30:00")))
5450 (gapok (mapcar 'org-hh:mm-string-to-minutes
5451 (plist-get pl :gap-ok-around)))
5452 (def-face (or (plist-get pl :default-face)
5453 '((:background "DarkRed") (:foreground "white"))))
5454 issue face m te ts dt ov)
5455 (goto-char (point-min))
5456 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5457 (setq issue nil face def-face)
5458 (catch 'next
5459 (setq m (org-get-at-bol 'org-marker)
5460 te nil ts nil)
5461 (unless (and m (markerp m))
5462 (setq issue "No valid clock line") (throw 'next t))
5463 (org-with-point-at m
5464 (save-excursion
5465 (goto-char (point-at-bol))
5466 (unless (looking-at re)
5467 (error "No valid Clock line")
5468 (throw 'next t))
5469 (unless (match-end 3)
5470 (setq issue "No end time"
5471 face (or (plist-get pl :no-end-time-face) face))
5472 (throw 'next t))
5473 (setq ts (match-string 1)
5474 te (match-string 3)
5475 ts (org-float-time
5476 (apply 'encode-time (org-parse-time-string ts)))
5477 te (org-float-time
5478 (apply 'encode-time (org-parse-time-string te)))
5479 dt (- te ts))))
5480 (cond
5481 ((> dt (* 60 maxtime))
5482 ;; a very long clocking chunk
5483 (setq issue (format "Clocking interval is very long: %s"
5484 (org-minutes-to-hh:mm-string
5485 (floor (/ (float dt) 60.))))
5486 face (or (plist-get pl :long-face) face)))
5487 ((< dt (* 60 mintime))
5488 ;; a very short clocking chunk
5489 (setq issue (format "Clocking interval is very short: %s"
5490 (org-minutes-to-hh:mm-string
5491 (floor (/ (float dt) 60.))))
5492 face (or (plist-get pl :short-face) face)))
5493 ((and (> tlend 0) (< ts tlend))
5494 ;; Two clock entries are overlapping
5495 (setq issue (format "Clocking overlap: %d minutes"
5496 (/ (- tlend ts) 60))
5497 face (or (plist-get pl :overlap-face) face)))
5498 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5499 ;; There is a gap, lets see if we need to report it
5500 (unless (org-agenda-check-clock-gap tlend ts gapok)
5501 (setq issue (format "Clocking gap: %d minutes"
5502 (/ (- ts tlend) 60))
5503 face (or (plist-get pl :gap-face) face))))
5504 (t nil)))
5505 (setq tlend (or te tlend) tlstart (or ts tlstart))
5506 (when issue
5507 ;; OK, there was some issue, add an overlay to show the issue
5508 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5509 (overlay-put ov 'before-string
5510 (concat
5511 (org-add-props
5512 (format "%-43s" (concat " " issue))
5514 'face face)
5515 "\n"))
5516 (overlay-put ov 'evaporate t)))))
5518 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5519 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5520 (catch 'exit
5521 (unless ok-list
5522 ;; there are no OK times for gaps...
5523 (throw 'exit nil))
5524 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5525 ;; This is more than 24 hours, so it is OK.
5526 ;; because we have at least one OK time, that must be in the
5527 ;; 24 hour interval.
5528 (throw 'exit t))
5529 ;; We have a shorter gap.
5530 ;; Now we have to get the minute of the day when these times are
5531 (let* ((t1dec (decode-time (seconds-to-time t1)))
5532 (t2dec (decode-time (seconds-to-time t2)))
5533 ;; compute the minute on the day
5534 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5535 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5536 (when (< min2 min1)
5537 ;; if min2 is smaller than min1, this means it is on the next day.
5538 ;; Wrap it to after midnight.
5539 (setq min2 (+ min2 1440)))
5540 ;; Now check if any of the OK times is in the gap
5541 (mapc (lambda (x)
5542 ;; Wrap the time to after midnight if necessary
5543 (if (< x min1) (setq x (+ x 1440)))
5544 ;; Check if in interval
5545 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5546 ok-list)
5547 ;; Nope, this gap is not OK
5548 nil)))
5550 (defun org-agenda-get-deadlines ()
5551 "Return the deadline information for agenda display."
5552 (let* ((props (list 'mouse-face 'highlight
5553 'org-not-done-regexp org-not-done-regexp
5554 'org-todo-regexp org-todo-regexp
5555 'org-complex-heading-regexp org-complex-heading-regexp
5556 'help-echo
5557 (format "mouse-2 or RET jump to org file %s"
5558 (abbreviate-file-name buffer-file-name))))
5559 (regexp org-deadline-time-regexp)
5560 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5561 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5562 d2 diff dfrac wdays pos pos1 category category-pos
5563 tags suppress-prewarning ee txt head face s todo-state
5564 show-all upcomingp donep timestr warntime)
5565 (goto-char (point-min))
5566 (while (re-search-forward regexp nil t)
5567 (setq suppress-prewarning nil)
5568 (catch :skip
5569 (org-agenda-skip)
5570 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5571 (save-match-data
5572 (string-match org-scheduled-time-regexp
5573 (buffer-substring (point-at-bol)
5574 (point-at-eol)))))
5575 (setq suppress-prewarning
5576 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5577 org-agenda-skip-deadline-prewarning-if-scheduled
5578 0)))
5579 (setq s (match-string 1)
5580 txt nil
5581 pos (1- (match-beginning 1))
5582 todo-state (save-match-data (org-get-todo-state))
5583 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5584 (member todo-state
5585 org-agenda-repeating-timestamp-show-all))
5586 d2 (org-time-string-to-absolute
5587 (match-string 1) d1 'past show-all
5588 (current-buffer) pos)
5589 diff (- d2 d1)
5590 wdays (if suppress-prewarning
5591 (let ((org-deadline-warning-days suppress-prewarning))
5592 (org-get-wdays s))
5593 (org-get-wdays s))
5594 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5595 upcomingp (and todayp (> diff 0)))
5596 ;; When to show a deadline in the calendar:
5597 ;; If the expiration is within wdays warning time.
5598 ;; Past-due deadlines are only shown on the current date
5599 (if (and (or (and (<= diff wdays)
5600 (and todayp (not org-agenda-only-exact-dates)))
5601 (= diff 0)))
5602 (save-excursion
5603 ;; (setq todo-state (org-get-todo-state))
5604 (setq donep (member todo-state org-done-keywords))
5605 (if (and donep
5606 (or org-agenda-skip-deadline-if-done
5607 (not (= diff 0))))
5608 (setq txt nil)
5609 (setq category (org-get-category)
5610 warntime (org-entry-get (point) "APPT_WARNTIME")
5611 category-pos (get-text-property (point) 'org-category-position))
5612 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5613 (setq txt org-agenda-no-heading-message)
5614 (goto-char (match-end 0))
5615 (setq pos1 (match-beginning 0))
5616 (setq tags (org-get-tags-at pos1))
5617 (setq head (buffer-substring-no-properties
5618 (point)
5619 (progn (skip-chars-forward "^\r\n")
5620 (point))))
5621 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5622 (setq timestr
5623 (concat (substring s (match-beginning 1)) " "))
5624 (setq timestr 'time))
5625 (setq txt (org-agenda-format-item
5626 (if (= diff 0)
5627 (car org-agenda-deadline-leaders)
5628 (if (functionp
5629 (nth 1 org-agenda-deadline-leaders))
5630 (funcall
5631 (nth 1 org-agenda-deadline-leaders)
5632 diff date)
5633 (format (nth 1 org-agenda-deadline-leaders)
5634 diff)))
5635 head category tags
5636 (if (not (= diff 0)) nil timestr)))))
5637 (when txt
5638 (setq face (org-agenda-deadline-face dfrac))
5639 (org-add-props txt props
5640 'org-marker (org-agenda-new-marker pos)
5641 'warntime warntime
5642 'org-hd-marker (org-agenda-new-marker pos1)
5643 'priority (+ (- diff)
5644 (org-get-priority txt))
5645 'org-category category
5646 'org-category-position category-pos
5647 'todo-state todo-state
5648 'type (if upcomingp "upcoming-deadline" "deadline")
5649 'date (if upcomingp date d2)
5650 'face (if donep 'org-agenda-done face)
5651 'undone-face face 'done-face 'org-agenda-done)
5652 (push txt ee))))))
5653 (nreverse ee)))
5655 (defun org-agenda-deadline-face (fraction)
5656 "Return the face to displaying a deadline item.
5657 FRACTION is what fraction of the head-warning time has passed."
5658 (let ((faces org-agenda-deadline-faces) f)
5659 (catch 'exit
5660 (while (setq f (pop faces))
5661 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5663 (defun org-agenda-get-scheduled (&optional deadline-results)
5664 "Return the scheduled information for agenda display."
5665 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5666 'org-todo-regexp org-todo-regexp
5667 'org-complex-heading-regexp org-complex-heading-regexp
5668 'done-face 'org-agenda-done
5669 'mouse-face 'highlight
5670 'help-echo
5671 (format "mouse-2 or RET jump to org file %s"
5672 (abbreviate-file-name buffer-file-name))))
5673 (regexp org-scheduled-time-regexp)
5674 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5675 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5677 (deadline-position-alist
5678 (mapcar (lambda (a) (and (setq mm (get-text-property
5679 0 'org-hd-marker a))
5680 (cons (marker-position mm) a)))
5681 deadline-results))
5682 d2 diff pos pos1 category category-pos tags donep
5683 ee txt head pastschedp todo-state face timestr s habitp show-all
5684 did-habit-check-p warntime)
5685 (goto-char (point-min))
5686 (while (re-search-forward regexp nil t)
5687 (catch :skip
5688 (org-agenda-skip)
5689 (setq s (match-string 1)
5690 txt nil
5691 pos (1- (match-beginning 1))
5692 todo-state (save-match-data (org-get-todo-state))
5693 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5694 (member todo-state
5695 org-agenda-repeating-timestamp-show-all))
5696 d2 (org-time-string-to-absolute
5697 (match-string 1) d1 'past show-all
5698 (current-buffer) pos)
5699 diff (- d2 d1)
5700 warntime (org-entry-get (point) "APPT_WARNTIME"))
5701 (setq pastschedp (and todayp (< diff 0)))
5702 (setq did-habit-check-p nil)
5703 ;; When to show a scheduled item in the calendar:
5704 ;; If it is on or past the date.
5705 (when (or (and (< diff 0)
5706 (< (abs diff) org-scheduled-past-days)
5707 (and todayp (not org-agenda-only-exact-dates)))
5708 (= diff 0)
5709 ;; org-is-habit-p uses org-entry-get, which is expansive
5710 ;; so we go extra mile to only call it once
5711 (and todayp
5712 org-habit-show-all-today
5713 (setq did-habit-check-p t)
5714 (setq habitp (and (functionp 'org-is-habit-p)
5715 (org-is-habit-p)))))
5716 (save-excursion
5717 (setq donep (member todo-state org-done-keywords))
5718 (if (and donep
5719 (or org-agenda-skip-scheduled-if-done
5720 (not (= diff 0))
5721 (and (functionp 'org-is-habit-p)
5722 (org-is-habit-p))))
5723 (setq txt nil)
5724 (setq habitp (if did-habit-check-p habitp
5725 (and (functionp 'org-is-habit-p)
5726 (org-is-habit-p))))
5727 (setq category (org-get-category)
5728 category-pos (get-text-property (point) 'org-category-position))
5729 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5730 (setq txt org-agenda-no-heading-message)
5731 (goto-char (match-end 0))
5732 (setq pos1 (match-beginning 0))
5733 (if habitp
5734 (if (or (not org-habit-show-habits)
5735 (and (not todayp)
5736 org-habit-show-habits-only-for-today))
5737 (throw :skip nil))
5738 (if (and
5739 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5740 (and org-agenda-skip-scheduled-if-deadline-is-shown
5741 pastschedp))
5742 (setq mm (assoc pos1 deadline-position-alist)))
5743 (throw :skip nil)))
5744 (setq tags (org-get-tags-at))
5745 (setq head (buffer-substring-no-properties
5746 (point)
5747 (progn (skip-chars-forward "^\r\n") (point))))
5748 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5749 (setq timestr
5750 (concat (substring s (match-beginning 1)) " "))
5751 (setq timestr 'time))
5752 (setq txt (org-agenda-format-item
5753 (if (= diff 0)
5754 (car org-agenda-scheduled-leaders)
5755 (format (nth 1 org-agenda-scheduled-leaders)
5756 (- 1 diff)))
5757 head category tags
5758 (if (not (= diff 0)) nil timestr)
5759 nil habitp))))
5760 (when txt
5761 (setq face
5762 (cond
5763 ((and (not habitp) pastschedp)
5764 'org-scheduled-previously)
5765 (todayp 'org-scheduled-today)
5766 (t 'org-scheduled))
5767 habitp (and habitp (org-habit-parse-todo)))
5768 (org-add-props txt props
5769 'undone-face face
5770 'face (if donep 'org-agenda-done face)
5771 'org-marker (org-agenda-new-marker pos)
5772 'org-hd-marker (org-agenda-new-marker pos1)
5773 'type (if pastschedp "past-scheduled" "scheduled")
5774 'date (if pastschedp d2 date)
5775 'warntime warntime
5776 'priority (if habitp
5777 (org-habit-get-priority habitp)
5778 (+ 94 (- 5 diff) (org-get-priority txt)))
5779 'org-category category
5780 'category-position category-pos
5781 'org-habit-p habitp
5782 'todo-state todo-state)
5783 (push txt ee))))))
5784 (nreverse ee)))
5786 (defun org-agenda-get-blocks ()
5787 "Return the date-range information for agenda display."
5788 (let* ((props (list 'face nil
5789 'org-not-done-regexp org-not-done-regexp
5790 'org-todo-regexp org-todo-regexp
5791 'org-complex-heading-regexp org-complex-heading-regexp
5792 'mouse-face 'highlight
5793 'help-echo
5794 (format "mouse-2 or RET jump to org file %s"
5795 (abbreviate-file-name buffer-file-name))))
5796 (regexp org-tr-regexp)
5797 (d0 (calendar-absolute-from-gregorian date))
5798 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
5799 todo-state tags pos head donep)
5800 (goto-char (point-min))
5801 (while (re-search-forward regexp nil t)
5802 (catch :skip
5803 (org-agenda-skip)
5804 (setq pos (point))
5805 (let ((start-time (match-string 1))
5806 (end-time (match-string 2)))
5807 (setq s1 (match-string 1)
5808 s2 (match-string 2)
5809 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5810 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5811 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5812 ;; Only allow days between the limits, because the normal
5813 ;; date stamps will catch the limits.
5814 (save-excursion
5815 (setq todo-state (org-get-todo-state))
5816 (setq donep (member todo-state org-done-keywords))
5817 (if (and donep org-agenda-skip-timestamp-if-done)
5818 (throw :skip t))
5819 (setq marker (org-agenda-new-marker (point)))
5820 (setq category (org-get-category)
5821 category-pos (get-text-property (point) 'org-category-position))
5822 (if (not (re-search-backward org-outline-regexp-bol nil t))
5823 (setq txt org-agenda-no-heading-message)
5824 (goto-char (match-beginning 0))
5825 (setq hdmarker (org-agenda-new-marker (point)))
5826 (setq tags (org-get-tags-at))
5827 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5828 (setq head (match-string 1))
5829 (let ((remove-re
5830 (if org-agenda-remove-timeranges-from-blocks
5831 (concat
5832 "<" (regexp-quote s1) ".*?>"
5833 "--"
5834 "<" (regexp-quote s2) ".*?>")
5835 nil)))
5836 (setq txt (org-agenda-format-item
5837 (format
5838 (nth (if (= d1 d2) 0 1)
5839 org-agenda-timerange-leaders)
5840 (1+ (- d0 d1)) (1+ (- d2 d1)))
5841 head category tags
5842 (cond ((and (= d1 d0) (= d2 d0))
5843 (concat "<" start-time ">--<" end-time ">"))
5844 ((= d1 d0)
5845 (concat "<" start-time ">"))
5846 ((= d2 d0)
5847 (concat "<" end-time ">")))
5848 remove-re))))
5849 (org-add-props txt props
5850 'org-marker marker 'org-hd-marker hdmarker
5851 'type "block" 'date date
5852 'todo-state todo-state
5853 'priority (org-get-priority txt) 'org-category category
5854 'org-category-position category-pos)
5855 (push txt ee))))
5856 (goto-char pos)))
5857 ;; Sort the entries by expiration date.
5858 (nreverse ee)))
5860 ;;; Agenda presentation and sorting
5862 (defvar org-prefix-has-time nil
5863 "A flag, set by `org-compile-prefix-format'.
5864 The flag is set if the currently compiled format contains a `%t'.")
5865 (defvar org-prefix-has-tag nil
5866 "A flag, set by `org-compile-prefix-format'.
5867 The flag is set if the currently compiled format contains a `%T'.")
5868 (defvar org-prefix-has-effort nil
5869 "A flag, set by `org-compile-prefix-format'.
5870 The flag is set if the currently compiled format contains a `%e'.")
5871 (defvar org-prefix-category-length nil
5872 "Used by `org-compile-prefix-format' to remember the category field width.")
5873 (defvar org-prefix-category-max-length nil
5874 "Used by `org-compile-prefix-format' to remember the category field width.")
5876 (defun org-agenda-get-category-icon (category)
5877 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5878 (dolist (entry org-agenda-category-icon-alist)
5879 (when (org-string-match-p (car entry) category)
5880 (if (listp (cadr entry))
5881 (return (cadr entry))
5882 (return (apply 'create-image (cdr entry)))))))
5884 (defun org-agenda-format-item (extra txt &optional category tags dotime
5885 remove-re habitp)
5886 "Format TXT to be inserted into the agenda buffer.
5887 In particular, it adds the prefix and corresponding text properties. EXTRA
5888 must be a string and replaces the `%s' specifier in the prefix format.
5889 CATEGORY (string, symbol or nil) may be used to overrule the default
5890 category taken from local variable or file name. It will replace the `%c'
5891 specifier in the format. DOTIME, when non-nil, indicates that a
5892 time-of-day should be extracted from TXT for sorting of this entry, and for
5893 the `%t' specifier in the format. When DOTIME is a string, this string is
5894 searched for a time before TXT is. TAGS can be the tags of the headline.
5895 Any match of REMOVE-RE will be removed from TXT."
5896 ;; We keep the org-prefix-* variable values along with a compiled
5897 ;; formatter, so that multiple agendas existing at the same time, do
5898 ;; not step on each other toes.
5900 ;; It was inconvenient to make these variables buffer local in
5901 ;; Agenda buffers, because this function expects to be called with
5902 ;; the buffer where item comes from being current, and not agenda
5903 ;; buffer
5904 (let* ((bindings (car org-prefix-format-compiled))
5905 (formatter (cadr org-prefix-format-compiled)))
5906 (loop for (var value) in bindings
5907 do (set var value))
5908 (save-match-data
5909 ;; Diary entries sometimes have extra whitespace at the beginning
5910 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5912 ;; Fix the tags part in txt
5913 (setq txt (org-agenda-fix-displayed-tags
5914 txt tags
5915 org-agenda-show-inherited-tags
5916 org-agenda-hide-tags-regexp))
5917 (let* ((category (or category
5918 (if (stringp org-category)
5919 org-category
5920 (and org-category (symbol-name org-category)))
5921 (if buffer-file-name
5922 (file-name-sans-extension
5923 (file-name-nondirectory buffer-file-name))
5924 "")))
5925 (category-icon (org-agenda-get-category-icon category))
5926 (category-icon (if category-icon
5927 (propertize " " 'display category-icon)
5928 ""))
5929 ;; time, tag, effort are needed for the eval of the prefix format
5930 (tag (if tags (nth (1- (length tags)) tags) ""))
5931 time effort neffort
5932 (ts (if dotime (concat
5933 (if (stringp dotime) dotime "")
5934 (and org-agenda-search-headline-for-time txt))))
5935 (time-of-day (and dotime (org-get-time-of-day ts)))
5936 stamp plain s0 s1 s2 rtn srp l
5937 duration thecategory)
5938 (and (derived-mode-p 'org-mode) buffer-file-name
5939 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5940 (when (and dotime time-of-day)
5941 ;; Extract starting and ending time and move them to prefix
5942 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5943 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5944 (setq s0 (match-string 0 ts)
5945 srp (and stamp (match-end 3))
5946 s1 (match-string (if plain 1 2) ts)
5947 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5949 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5950 ;; them, we might want to remove them there to avoid duplication.
5951 ;; The user can turn this off with a variable.
5952 (if (and org-prefix-has-time
5953 org-agenda-remove-times-when-in-prefix (or stamp plain)
5954 (string-match (concat (regexp-quote s0) " *") txt)
5955 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5956 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5957 (= (match-beginning 0) 0)
5959 (setq txt (replace-match "" nil nil txt))))
5960 ;; Normalize the time(s) to 24 hour
5961 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5962 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5964 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5965 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5966 (setq s2
5967 (org-minutes-to-hh:mm-string
5968 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5970 ;; Compute the duration
5971 (when s2
5972 (setq duration (- (org-hh:mm-string-to-minutes s2)
5973 (org-hh:mm-string-to-minutes s1)))))
5975 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5976 txt)
5977 ;; Tags are in the string
5978 (if (or (eq org-agenda-remove-tags t)
5979 (and org-agenda-remove-tags
5980 org-prefix-has-tag))
5981 (setq txt (replace-match "" t t txt))
5982 (setq txt (replace-match
5983 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5984 (match-string 2 txt))
5985 t t txt))))
5986 (when (derived-mode-p 'org-mode)
5987 (setq effort
5988 (condition-case nil
5989 (org-get-effort
5990 (or (get-text-property 0 'org-hd-marker txt)
5991 (get-text-property 0 'org-marker txt)))
5992 (error nil)))
5993 (when effort
5994 (setq neffort (org-duration-string-to-minutes effort)
5995 effort (setq effort (concat "[" effort "]")))))
5996 ;; prevent erroring out with %e format when there is no effort
5997 (or effort (setq effort ""))
5999 (when remove-re
6000 (while (string-match remove-re txt)
6001 (setq txt (replace-match "" t t txt))))
6003 ;; Set org-heading property on `txt' to mark the start of the
6004 ;; heading.
6005 (add-text-properties 0 (length txt) '(org-heading t) txt)
6007 ;; Prepare the variables needed in the eval of the compiled format
6008 (setq time (cond (s2 (concat
6009 (org-agenda-time-of-day-to-ampm-maybe s1)
6010 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6011 (if org-agenda-timegrid-use-ampm " ")))
6012 (s1 (concat
6013 (org-agenda-time-of-day-to-ampm-maybe s1)
6014 (if org-agenda-timegrid-use-ampm
6015 "........ "
6016 "......")))
6017 (t ""))
6018 extra (or (and (not habitp) extra) "")
6019 category (if (symbolp category) (symbol-name category) category)
6020 thecategory (copy-sequence category))
6021 (if (string-match org-bracket-link-regexp category)
6022 (progn
6023 (setq l (if (match-end 3)
6024 (- (match-end 3) (match-beginning 3))
6025 (- (match-end 1) (match-beginning 1))))
6026 (when (< l (or org-prefix-category-length 0))
6027 (setq category (copy-sequence category))
6028 (org-add-props category nil
6029 'extra-space (make-string
6030 (- org-prefix-category-length l 1) ?\ ))))
6031 (if (and org-prefix-category-max-length
6032 (>= (length category) org-prefix-category-max-length))
6033 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6034 ;; Evaluate the compiled format
6035 (setq rtn (concat (eval formatter) txt))
6037 ;; And finally add the text properties
6038 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6039 (org-add-props rtn nil
6040 'org-category (if thecategory (downcase thecategory) category)
6041 'tags (mapcar 'org-downcase-keep-props tags)
6042 'org-highest-priority org-highest-priority
6043 'org-lowest-priority org-lowest-priority
6044 'time-of-day time-of-day
6045 'duration duration
6046 'effort effort
6047 'effort-minutes neffort
6048 'txt txt
6049 'time time
6050 'extra extra
6051 'format org-prefix-format-compiled
6052 'dotime dotime)))))
6054 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6055 "Remove tags string from TXT, and add a modified list of tags.
6056 The modified list may contain inherited tags, and tags matched by
6057 `org-agenda-hide-tags-regexp' will be removed."
6058 (when (or add-inherited hide-re)
6059 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6060 (setq txt (substring txt 0 (match-beginning 0))))
6061 (setq tags
6062 (delq nil
6063 (mapcar (lambda (tg)
6064 (if (or (and hide-re (string-match hide-re tg))
6065 (and (not add-inherited)
6066 (get-text-property 0 'inherited tg)))
6068 tg))
6069 tags)))
6070 (when tags
6071 (let ((have-i (get-text-property 0 'inherited (car tags)))
6073 (setq txt (concat txt " :"
6074 (mapconcat
6075 (lambda (x)
6076 (setq i (get-text-property 0 'inherited x))
6077 (if (and have-i (not i))
6078 (progn
6079 (setq have-i nil)
6080 (concat ":" x))
6082 tags ":")
6083 (if have-i "::" ":"))))))
6084 txt)
6086 (defun org-downcase-keep-props (s)
6087 (let ((props (text-properties-at 0 s)))
6088 (setq s (downcase s))
6089 (add-text-properties 0 (length s) props s)
6092 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6093 (defvar org-agenda-sorting-strategy-selected nil)
6095 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6096 (catch 'exit
6097 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6098 ((and todayp (member 'today (car org-agenda-time-grid))))
6099 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6100 ((member 'weekly (car org-agenda-time-grid)))
6101 (t (throw 'exit list)))
6102 (let* ((have (delq nil (mapcar
6103 (lambda (x) (get-text-property 1 'time-of-day x))
6104 list)))
6105 (string (nth 1 org-agenda-time-grid))
6106 (gridtimes (nth 2 org-agenda-time-grid))
6107 (req (car org-agenda-time-grid))
6108 (remove (member 'remove-match req))
6109 new time)
6110 (if (and (member 'require-timed req) (not have))
6111 ;; don't show empty grid
6112 (throw 'exit list))
6113 (while (setq time (pop gridtimes))
6114 (unless (and remove (member time have))
6115 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6116 (push (org-agenda-format-item
6117 nil string "" nil
6118 (concat (substring time 0 -2) ":" (substring time -2)))
6119 new)
6120 (put-text-property
6121 2 (length (car new)) 'face 'org-time-grid (car new))))
6122 (when (and todayp org-agenda-show-current-time-in-grid)
6123 (push (org-agenda-format-item
6125 org-agenda-current-time-string
6126 "" nil
6127 (format-time-string "%H:%M "))
6128 new)
6129 (put-text-property
6130 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6132 (if (member 'time-up org-agenda-sorting-strategy-selected)
6133 (append new list)
6134 (append list new)))))
6136 (defun org-compile-prefix-format (key)
6137 "Compile the prefix format into a Lisp form that can be evaluated.
6138 The resulting form and associated variable bindings is returned
6139 and stored in the variable `org-prefix-format-compiled'."
6140 (setq org-prefix-has-time nil org-prefix-has-tag nil
6141 org-prefix-category-length nil
6142 org-prefix-has-effort nil)
6143 (let ((s (cond
6144 ((stringp org-agenda-prefix-format)
6145 org-agenda-prefix-format)
6146 ((assq key org-agenda-prefix-format)
6147 (cdr (assq key org-agenda-prefix-format)))
6148 (t " %-12:c%?-12t% s")))
6149 (start 0)
6150 varform vars var e c f opt)
6151 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
6152 s start)
6153 (setq var (or (cdr (assoc (match-string 4 s)
6154 '(("c" . category) ("t" . time) ("s" . extra)
6155 ("i" . category-icon) ("T" . tag) ("e" . effort))))
6156 'eval)
6157 c (or (match-string 3 s) "")
6158 opt (match-beginning 1)
6159 start (1+ (match-beginning 0)))
6160 (if (equal var 'time) (setq org-prefix-has-time t))
6161 (if (equal var 'tag) (setq org-prefix-has-tag t))
6162 (if (equal var 'effort) (setq org-prefix-has-effort t))
6163 (setq f (concat "%" (match-string 2 s) "s"))
6164 (when (equal var 'category)
6165 (setq org-prefix-category-length
6166 (floor (abs (string-to-number (match-string 2 s)))))
6167 (setq org-prefix-category-max-length
6168 (let ((x (match-string 2 s)))
6169 (save-match-data
6170 (if (string-match "\\.[0-9]+" x)
6171 (string-to-number (substring (match-string 0 x) 1)))))))
6172 (if (eq var 'eval)
6173 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6174 (if opt
6175 (setq varform
6176 `(if (equal "" ,var)
6178 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6179 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6180 (setq s (replace-match "%s" t nil s))
6181 (push varform vars))
6182 (setq vars (nreverse vars))
6183 (with-current-buffer org-agenda-buffer
6184 (setq org-prefix-format-compiled
6185 (list
6186 `((org-prefix-has-time ,org-prefix-has-time)
6187 (org-prefix-has-tag ,org-prefix-has-tag)
6188 (org-prefix-category-length ,org-prefix-category-length)
6189 (org-prefix-has-effort ,org-prefix-has-effort))
6190 `(format ,s ,@vars))))))
6192 (defun org-set-sorting-strategy (key)
6193 (if (symbolp (car org-agenda-sorting-strategy))
6194 ;; the old format
6195 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6196 (setq org-agenda-sorting-strategy-selected
6197 (or (cdr (assq key org-agenda-sorting-strategy))
6198 (cdr (assq 'agenda org-agenda-sorting-strategy))
6199 '(time-up category-keep priority-down)))))
6201 (defun org-get-time-of-day (s &optional string mod24)
6202 "Check string S for a time of day.
6203 If found, return it as a military time number between 0 and 2400.
6204 If not found, return nil.
6205 The optional STRING argument forces conversion into a 5 character wide string
6206 HH:MM."
6207 (save-match-data
6208 (when
6209 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6210 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6211 (let* ((h (string-to-number (match-string 1 s)))
6212 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6213 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6214 (am-p (equal ampm "am"))
6215 (h1 (cond ((not ampm) h)
6216 ((= h 12) (if am-p 0 12))
6217 (t (+ h (if am-p 0 12)))))
6218 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6219 (mod h1 24) h1))
6220 (t0 (+ (* 100 h2) m))
6221 (t1 (concat (if (>= h1 24) "+" " ")
6222 (if (and org-agenda-time-leading-zero
6223 (< t0 1000)) "0" "")
6224 (if (< t0 100) "0" "")
6225 (if (< t0 10) "0" "")
6226 (int-to-string t0))))
6227 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6229 (defvar org-agenda-before-sorting-filter-function nil
6230 "Function to be applied to agenda items prior to sorting.
6231 Prior to sorting also means just before they are inserted into the agenda.
6233 To aid sorting, you may revisit the original entries and add more text
6234 properties which will later be used by the sorting functions.
6236 The function should take a string argument, an agenda line.
6237 It has access to the text properties in that line, which contain among
6238 other things, the property `org-hd-marker' that points to the entry
6239 where the line comes from. Note that not all lines going into the agenda
6240 have this property, only most.
6242 The function should return the modified string. It is probably best
6243 to ONLY change text properties.
6245 You can also use this function as a filter, by returning nil for lines
6246 you don't want to have in the agenda at all. For this application, you
6247 could bind the variable in the options section of a custom command.")
6249 (defun org-finalize-agenda-entries (list &optional nosort)
6250 "Sort and concatenate the agenda items."
6251 (setq list (mapcar 'org-agenda-highlight-todo list))
6252 (if nosort
6253 list
6254 (when org-agenda-before-sorting-filter-function
6255 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6256 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6258 (defun org-agenda-highlight-todo (x)
6259 (let ((org-done-keywords org-done-keywords-for-agenda)
6260 (case-fold-search nil)
6262 (if (eq x 'line)
6263 (save-excursion
6264 (beginning-of-line 1)
6265 (setq re (org-get-at-bol 'org-todo-regexp))
6266 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6267 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6268 (add-text-properties (match-beginning 0) (match-end 1)
6269 (list 'face (org-get-todo-face 1)))
6270 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6271 (delete-region (match-beginning 1) (1- (match-end 0)))
6272 (goto-char (match-beginning 1))
6273 (insert (format org-agenda-todo-keyword-format s)))))
6274 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6275 (setq re (get-text-property 0 'org-todo-regexp x))
6276 (when (and re
6277 ;; Test `pl' because if there's no heading content,
6278 ;; there's no point matching to highlight. Note
6279 ;; that if we didn't test `pl' first, and there
6280 ;; happened to be no keyword from `org-todo-regexp'
6281 ;; on this heading line, then the `equal' comparison
6282 ;; afterwards would spuriously succeed in the case
6283 ;; where `pl' is nil -- causing an args-out-of-range
6284 ;; error when we try to add text properties to text
6285 ;; that isn't there.
6287 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6288 x pl) pl))
6289 (add-text-properties
6290 (or (match-end 1) (match-end 0)) (match-end 0)
6291 (list 'face (org-get-todo-face (match-string 2 x)))
6293 (when (match-end 1)
6294 (setq x (concat (substring x 0 (match-end 1))
6295 (format org-agenda-todo-keyword-format
6296 (match-string 2 x))
6297 (org-add-props " " (text-properties-at 0 x))
6298 (substring x (match-end 3)))))))
6299 x)))
6301 (defsubst org-cmp-priority (a b)
6302 "Compare the priorities of string A and B."
6303 (let ((pa (or (get-text-property 1 'priority a) 0))
6304 (pb (or (get-text-property 1 'priority b) 0)))
6305 (cond ((> pa pb) +1)
6306 ((< pa pb) -1))))
6308 (defsubst org-cmp-effort (a b)
6309 "Compare the effort values of string A and B."
6310 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6311 (ea (or (get-text-property 1 'effort-minutes a) def))
6312 (eb (or (get-text-property 1 'effort-minutes b) def)))
6313 (cond ((> ea eb) +1)
6314 ((< ea eb) -1))))
6316 (defsubst org-cmp-category (a b)
6317 "Compare the string values of categories of strings A and B."
6318 (let ((ca (or (get-text-property 1 'org-category a) ""))
6319 (cb (or (get-text-property 1 'org-category b) "")))
6320 (cond ((string-lessp ca cb) -1)
6321 ((string-lessp cb ca) +1))))
6323 (defsubst org-cmp-todo-state (a b)
6324 "Compare the todo states of strings A and B."
6325 (let* ((ma (or (get-text-property 1 'org-marker a)
6326 (get-text-property 1 'org-hd-marker a)))
6327 (mb (or (get-text-property 1 'org-marker b)
6328 (get-text-property 1 'org-hd-marker b)))
6329 (fa (and ma (marker-buffer ma)))
6330 (fb (and mb (marker-buffer mb)))
6331 (todo-kwds
6332 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6333 (and fb (with-current-buffer fb org-todo-keywords-1))))
6334 (ta (or (get-text-property 1 'todo-state a) ""))
6335 (tb (or (get-text-property 1 'todo-state b) ""))
6336 (la (- (length (member ta todo-kwds))))
6337 (lb (- (length (member tb todo-kwds))))
6338 (donepa (member ta org-done-keywords-for-agenda))
6339 (donepb (member tb org-done-keywords-for-agenda)))
6340 (cond ((and donepa (not donepb)) -1)
6341 ((and (not donepa) donepb) +1)
6342 ((< la lb) -1)
6343 ((< lb la) +1))))
6345 (defsubst org-cmp-alpha (a b)
6346 "Compare the headlines, alphabetically."
6347 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6348 (plb (text-property-any 0 (length b) 'org-heading t b))
6349 (ta (and pla (substring a pla)))
6350 (tb (and plb (substring b plb))))
6351 (when pla
6352 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6353 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6354 (setq ta (substring ta (match-end 0))))
6355 (setq ta (downcase ta)))
6356 (when plb
6357 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6358 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6359 (setq tb (substring tb (match-end 0))))
6360 (setq tb (downcase tb)))
6361 (cond ((not ta) +1)
6362 ((not tb) -1)
6363 ((string-lessp ta tb) -1)
6364 ((string-lessp tb ta) +1))))
6366 (defsubst org-cmp-tag (a b)
6367 "Compare the string values of the first tags of A and B."
6368 (let ((ta (car (last (get-text-property 1 'tags a))))
6369 (tb (car (last (get-text-property 1 'tags b)))))
6370 (cond ((not ta) +1)
6371 ((not tb) -1)
6372 ((string-lessp ta tb) -1)
6373 ((string-lessp tb ta) +1))))
6375 (defsubst org-cmp-time (a b)
6376 "Compare the time-of-day values of strings A and B."
6377 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6378 (ta (or (get-text-property 1 'time-of-day a) def))
6379 (tb (or (get-text-property 1 'time-of-day b) def)))
6380 (cond ((< ta tb) -1)
6381 ((< tb ta) +1))))
6383 (defsubst org-cmp-habit-p (a b)
6384 "Compare the todo states of strings A and B."
6385 (let ((ha (get-text-property 1 'org-habit-p a))
6386 (hb (get-text-property 1 'org-habit-p b)))
6387 (cond ((and ha (not hb)) -1)
6388 ((and (not ha) hb) +1))))
6390 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6392 (defun org-entries-lessp (a b)
6393 "Predicate for sorting agenda entries."
6394 ;; The following variables will be used when the form is evaluated.
6395 ;; So even though the compiler complains, keep them.
6396 (let* ((ss org-agenda-sorting-strategy-selected)
6397 (time-up (and (org-em 'time-up 'time-down ss)
6398 (org-cmp-time a b)))
6399 (time-down (if time-up (- time-up) nil))
6400 (priority-up (and (org-em 'priority-up 'priority-down ss)
6401 (org-cmp-priority a b)))
6402 (priority-down (if priority-up (- priority-up) nil))
6403 (effort-up (and (org-em 'effort-up 'effort-down ss)
6404 (org-cmp-effort a b)))
6405 (effort-down (if effort-up (- effort-up) nil))
6406 (category-up (and (or (org-em 'category-up 'category-down ss)
6407 (memq 'category-keep ss))
6408 (org-cmp-category a b)))
6409 (category-down (if category-up (- category-up) nil))
6410 (category-keep (if category-up +1 nil))
6411 (tag-up (and (org-em 'tag-up 'tag-down ss)
6412 (org-cmp-tag a b)))
6413 (tag-down (if tag-up (- tag-up) nil))
6414 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6415 (org-cmp-todo-state a b)))
6416 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6417 (habit-up (and (org-em 'habit-up 'habit-down ss)
6418 (org-cmp-habit-p a b)))
6419 (habit-down (if habit-up (- habit-up) nil))
6420 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6421 (org-cmp-alpha a b)))
6422 (alpha-down (if alpha-up (- alpha-up) nil))
6423 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6424 user-defined-up user-defined-down)
6425 (if (and need-user-cmp org-agenda-cmp-user-defined
6426 (functionp org-agenda-cmp-user-defined))
6427 (setq user-defined-up
6428 (funcall org-agenda-cmp-user-defined a b)
6429 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6430 (cdr (assoc
6431 (eval (cons 'or org-agenda-sorting-strategy-selected))
6432 '((-1 . t) (1 . nil) (nil . nil))))))
6434 ;;; Agenda restriction lock
6436 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6437 "Overlay to mark the headline to which agenda commands are restricted.")
6438 (overlay-put org-agenda-restriction-lock-overlay
6439 'face 'org-agenda-restriction-lock)
6440 (overlay-put org-agenda-restriction-lock-overlay
6441 'help-echo "Agendas are currently limited to this subtree.")
6442 (org-detach-overlay org-agenda-restriction-lock-overlay)
6444 (defun org-agenda-set-restriction-lock (&optional type)
6445 "Set restriction lock for agenda, to current subtree or file.
6446 Restriction will be the file if TYPE is `file', or if type is the
6447 universal prefix '(4), or if the cursor is before the first headline
6448 in the file. Otherwise, restriction will be to the current subtree."
6449 (interactive "P")
6450 (and (equal type '(4)) (setq type 'file))
6451 (setq type (cond
6452 (type type)
6453 ((org-at-heading-p) 'subtree)
6454 ((condition-case nil (org-back-to-heading t) (error nil))
6455 'subtree)
6456 (t 'file)))
6457 (if (eq type 'subtree)
6458 (progn
6459 (setq org-agenda-restrict t)
6460 (setq org-agenda-overriding-restriction 'subtree)
6461 (put 'org-agenda-files 'org-restrict
6462 (list (buffer-file-name (buffer-base-buffer))))
6463 (org-back-to-heading t)
6464 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6465 (move-marker org-agenda-restrict-begin (point))
6466 (move-marker org-agenda-restrict-end
6467 (save-excursion (org-end-of-subtree t)))
6468 (message "Locking agenda restriction to subtree"))
6469 (put 'org-agenda-files 'org-restrict
6470 (list (buffer-file-name (buffer-base-buffer))))
6471 (setq org-agenda-restrict nil)
6472 (setq org-agenda-overriding-restriction 'file)
6473 (move-marker org-agenda-restrict-begin nil)
6474 (move-marker org-agenda-restrict-end nil)
6475 (message "Locking agenda restriction to file"))
6476 (setq current-prefix-arg nil)
6477 (org-agenda-maybe-redo))
6479 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6480 "Remove the agenda restriction lock."
6481 (interactive "P")
6482 (org-detach-overlay org-agenda-restriction-lock-overlay)
6483 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6484 (setq org-agenda-overriding-restriction nil)
6485 (setq org-agenda-restrict nil)
6486 (put 'org-agenda-files 'org-restrict nil)
6487 (move-marker org-agenda-restrict-begin nil)
6488 (move-marker org-agenda-restrict-end nil)
6489 (setq current-prefix-arg nil)
6490 (message "Agenda restriction lock removed")
6491 (or noupdate (org-agenda-maybe-redo)))
6493 (defun org-agenda-maybe-redo ()
6494 "If there is any window showing the agenda view, update it."
6495 (let ((w (get-buffer-window org-agenda-buffer-name t))
6496 (w0 (selected-window)))
6497 (when w
6498 (select-window w)
6499 (org-agenda-redo)
6500 (select-window w0)
6501 (if org-agenda-overriding-restriction
6502 (message "Agenda view shifted to new %s restriction"
6503 org-agenda-overriding-restriction)
6504 (message "Agenda restriction lock removed")))))
6506 ;;; Agenda commands
6508 (defun org-agenda-check-type (error &rest types)
6509 "Check if agenda buffer is of allowed type.
6510 If ERROR is non-nil, throw an error, otherwise just return nil."
6511 (if (not org-agenda-type)
6512 (error "No Org agenda currently displayed")
6513 (if (memq org-agenda-type types)
6515 (if error
6516 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6517 nil))))
6519 (defun org-agenda-Quit (&optional arg)
6520 "Exit agenda by removing the window or the buffer."
6521 (interactive)
6522 (if org-agenda-columns-active
6523 (org-columns-quit)
6524 (let ((buf (current-buffer)))
6525 (if (eq org-agenda-window-setup 'other-frame)
6526 (progn
6527 (org-agenda-reset-markers)
6528 (kill-buffer buf)
6529 (org-columns-remove-overlays)
6530 (setq org-agenda-archives-mode nil)
6531 (delete-frame))
6532 (and (not (eq org-agenda-window-setup 'current-window))
6533 (not (one-window-p))
6534 (delete-window))
6535 (org-agenda-reset-markers)
6536 (kill-buffer buf)
6537 (org-columns-remove-overlays)
6538 (setq org-agenda-archives-mode nil)))
6539 ;; Maybe restore the pre-agenda window configuration.
6540 (and org-agenda-restore-windows-after-quit
6541 (not (eq org-agenda-window-setup 'other-frame))
6542 org-agenda-pre-window-conf
6543 (set-window-configuration org-agenda-pre-window-conf)
6544 (setq org-agenda-pre-window-conf nil))))
6546 (defun org-agenda-quit ()
6547 "Exit agenda by killing agenda buffer or burying it when
6548 `org-agenda-sticky' is non-NIL"
6549 (interactive)
6550 (if org-agenda-columns-active
6551 (org-columns-quit)
6552 (if org-agenda-sticky
6553 (let ((buf (current-buffer)))
6554 (if (eq org-agenda-window-setup 'other-frame)
6555 (progn
6556 (delete-frame))
6557 (and (not (eq org-agenda-window-setup 'current-window))
6558 (not (one-window-p))
6559 (delete-window)))
6560 (with-current-buffer buf
6561 (bury-buffer)
6562 ;; Maybe restore the pre-agenda window configuration.
6563 (and org-agenda-restore-windows-after-quit
6564 (not (eq org-agenda-window-setup 'other-frame))
6565 org-agenda-pre-window-conf
6566 (set-window-configuration org-agenda-pre-window-conf)
6567 (setq org-agenda-pre-window-conf nil))))
6568 (org-agenda-Quit))))
6570 (defun org-agenda-exit ()
6571 "Exit agenda by removing the window or the buffer.
6572 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6573 Org-mode buffers visited directly by the user will not be touched."
6574 (interactive)
6575 (org-release-buffers org-agenda-new-buffers)
6576 (setq org-agenda-new-buffers nil)
6577 (org-agenda-Quit))
6579 (defun org-agenda-kill-all-agenda-buffers ()
6580 "Kill all buffers in `org-agena-mode'.
6581 This is used when toggling sticky agendas. You can also explicitly invoke it
6582 with `C-c a C-k'."
6583 (interactive)
6584 (let (blist)
6585 (dolist (buf (buffer-list))
6586 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
6587 (push buf blist)))
6588 (mapc 'kill-buffer blist)))
6590 (defun org-agenda-execute (arg)
6591 "Execute another agenda command, keeping same window.
6592 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6593 in the agenda."
6594 (interactive "P")
6595 (let ((org-agenda-window-setup 'current-window))
6596 (org-agenda arg)))
6598 (defun org-agenda-redo (&optional all)
6599 "Rebuild possibly ALL agenda view(s) in the current buffer."
6600 (interactive "P")
6601 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
6602 (cpa (unless (eq all t) current-prefix-arg))
6603 (org-agenda-doing-sticky-redo org-agenda-sticky)
6604 (org-agenda-sticky nil)
6605 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6606 org-agenda-buffer-name))
6607 (org-agenda-keep-modes t)
6608 (tag-filter org-agenda-tag-filter)
6609 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6610 (top-cat-filter org-agenda-top-category-filter)
6611 (cat-filter org-agenda-category-filter)
6612 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6613 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6614 (cols org-agenda-columns-active)
6615 (line (org-current-line))
6616 (window-line (- line (org-current-line (window-start))))
6617 (lprops (get 'org-agenda-redo-command 'org-lprops))
6618 (redo-cmd (get-text-property p 'org-redo-cmd))
6619 (last-args (get-text-property p 'org-last-args))
6620 (org-agenda-overriding-cmd (get-text-property p 'org-serie-cmd))
6621 (org-agenda-overriding-cmd-arguments
6622 (unless (eq all t)
6623 (cond ((listp last-args)
6624 (cons (or cpa (car last-args)) (cdr last-args)))
6625 ((stringp last-args)
6626 last-args))))
6627 (serie-redo-cmd (get-text-property p 'org-serie-redo-cmd)))
6628 (put 'org-agenda-tag-filter :preset-filter nil)
6629 (put 'org-agenda-category-filter :preset-filter nil)
6630 (and cols (org-columns-quit))
6631 (message "Rebuilding agenda buffer...")
6632 (if serie-redo-cmd
6633 (eval serie-redo-cmd)
6634 (org-let lprops '(eval redo-cmd)))
6635 (setq org-agenda-undo-list nil
6636 org-agenda-pending-undo-list nil)
6637 (message "Rebuilding agenda buffer...done")
6638 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6639 (put 'org-agenda-category-filter :preset-filter cat-preset)
6640 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6641 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6642 (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
6643 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6644 (org-goto-line line)
6645 (recenter window-line)))
6647 (defvar org-global-tags-completion-table nil)
6648 (defvar org-agenda-filter-form nil)
6649 (defvar org-agenda-filtered-by-category nil)
6651 (defun org-agenda-filter-by-category (strip)
6652 "Keep only those lines in the agenda buffer that have a specific category.
6653 The category is that of the current line."
6654 (interactive "P")
6655 (if (and org-agenda-filtered-by-category
6656 org-agenda-category-filter)
6657 (org-agenda-filter-show-all-cat)
6658 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6659 (if cat (org-agenda-filter-apply
6660 (list (concat (if strip "-" "+") cat)) 'category)
6661 (error "No category at point")))))
6663 (defun org-find-top-category (&optional pos)
6664 (save-excursion
6665 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
6666 (if pos (goto-char pos))
6667 ;; Skip up to the topmost parent
6668 (while (ignore-errors (outline-up-heading 1) t))
6669 (ignore-errors
6670 (nth 4 (org-heading-components))))))
6672 (defvar org-agenda-filtered-by-top-category nil)
6674 (defun org-agenda-filter-by-top-category (strip)
6675 "Keep only those lines in the agenda buffer that have a specific category.
6676 The category is that of the current line."
6677 (interactive "P")
6678 (if org-agenda-filtered-by-top-category
6679 (progn
6680 (setq org-agenda-filtered-by-top-category nil
6681 org-agenda-top-category-filter nil)
6682 (org-agenda-filter-show-all-cat))
6683 (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
6684 (if cat (org-agenda-filter-top-category-apply cat strip)
6685 (error "No top-level category at point")))))
6687 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6688 "Keep only those lines in the agenda buffer that have a specific tag.
6689 The tag is selected with its fast selection letter, as configured.
6690 With prefix argument STRIP, remove all lines that do have the tag.
6691 A lisp caller can specify CHAR. NARROW means that the new tag should be
6692 used to narrow the search - the interactive user can also press `-' or `+'
6693 to switch to narrowing."
6694 (interactive "P")
6695 (let* ((alist org-tag-alist-for-agenda)
6696 (tag-chars (mapconcat
6697 (lambda (x) (if (and (not (symbolp (car x)))
6698 (cdr x))
6699 (char-to-string (cdr x))
6700 ""))
6701 alist ""))
6702 (efforts (org-split-string
6703 (or (cdr (assoc (concat org-effort-property "_ALL")
6704 org-global-properties))
6705 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6706 "")))
6707 (effort-op org-agenda-filter-effort-default-operator)
6708 (effort-prompt "")
6709 (inhibit-read-only t)
6710 (current org-agenda-tag-filter)
6711 maybe-refresh a n tag)
6712 (unless char
6713 (message
6714 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6715 (if narrow "Narrow" "Filter") tag-chars
6716 (if org-agenda-auto-exclude-function "[RET], " ""))
6717 (setq char (read-char-exclusive)))
6718 (when (member char '(?+ ?-))
6719 ;; Narrowing down
6720 (cond ((equal char ?-) (setq strip t narrow t))
6721 ((equal char ?+) (setq strip nil narrow t)))
6722 (message
6723 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6724 (setq char (read-char-exclusive)))
6725 (when (member char '(?< ?> ?= ??))
6726 ;; An effort operator
6727 (setq effort-op (char-to-string char))
6728 (setq alist nil) ; to make sure it will be interpreted as effort.
6729 (unless (equal char ??)
6730 (loop for i from 0 to 9 do
6731 (setq effort-prompt
6732 (concat
6733 effort-prompt " ["
6734 (if (= i 9) "0" (int-to-string (1+ i)))
6735 "]" (nth i efforts))))
6736 (message "Effort%s: %s " effort-op effort-prompt)
6737 (setq char (read-char-exclusive))
6738 (when (or (< char ?0) (> char ?9))
6739 (error "Need 1-9,0 to select effort"))))
6740 (when (equal char ?\t)
6741 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6742 (org-set-local 'org-global-tags-completion-table
6743 (org-global-tags-completion-table)))
6744 (let ((completion-ignore-case t))
6745 (setq tag (org-icompleting-read
6746 "Tag: " org-global-tags-completion-table))))
6747 (cond
6748 ((equal char ?\r)
6749 (org-agenda-filter-show-all-tag)
6750 (when org-agenda-auto-exclude-function
6751 (setq org-agenda-tag-filter '())
6752 (dolist (tag (org-agenda-get-represented-tags))
6753 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6754 (if modifier
6755 (push modifier org-agenda-tag-filter))))
6756 (if (not (null org-agenda-tag-filter))
6757 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6758 (setq maybe-refresh t))
6759 ((equal char ?/)
6760 (org-agenda-filter-show-all-tag)
6761 (when (get 'org-agenda-tag-filter :preset-filter)
6762 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6763 (setq maybe-refresh t))
6764 ((equal char ?. )
6765 (setq org-agenda-tag-filter
6766 (mapcar (lambda(tag) (concat "+" tag))
6767 (org-get-at-bol 'tags)))
6768 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6769 (setq maybe-refresh t))
6770 ((or (equal char ?\ )
6771 (setq a (rassoc char alist))
6772 (and (>= char ?0) (<= char ?9)
6773 (setq n (if (= char ?0) 9 (- char ?0 1))
6774 tag (concat effort-op (nth n efforts))
6775 a (cons tag nil)))
6776 (and (= char ??)
6777 (setq tag "?eff")
6778 a (cons tag nil))
6779 (and tag (setq a (cons tag nil))))
6780 (org-agenda-filter-show-all-tag)
6781 (setq tag (car a))
6782 (setq org-agenda-tag-filter
6783 (cons (concat (if strip "-" "+") tag)
6784 (if narrow current nil)))
6785 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6786 (setq maybe-refresh t))
6787 (t (error "Invalid tag selection character %c" char)))
6788 (when (and maybe-refresh
6789 (eq org-agenda-clockreport-mode 'with-filter))
6790 (org-agenda-redo))))
6792 (defun org-agenda-get-represented-tags ()
6793 "Get a list of all tags currently represented in the agenda."
6794 (let (p tags)
6795 (save-excursion
6796 (goto-char (point-min))
6797 (while (setq p (next-single-property-change (point) 'tags))
6798 (goto-char p)
6799 (mapc (lambda (x) (add-to-list 'tags x))
6800 (get-text-property (point) 'tags))))
6801 tags))
6803 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6804 "Refine the current filter. See `org-agenda-filter-by-tag'."
6805 (interactive "P")
6806 (org-agenda-filter-by-tag strip char 'refine))
6808 (defun org-agenda-filter-make-matcher ()
6809 "Create the form that tests a line for agenda filter."
6810 (let (f f1)
6811 ;; first compute the tag-filter matcher
6812 (dolist (x (delete-dups
6813 (append (get 'org-agenda-tag-filter
6814 :preset-filter) org-agenda-tag-filter)))
6815 (if (member x '("-" "+"))
6816 (setq f1 (if (equal x "-") 'tags '(not tags)))
6817 (if (string-match "[<=>?]" x)
6818 (setq f1 (org-agenda-filter-effort-form x))
6819 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6820 (if (equal (string-to-char x) ?-)
6821 (setq f1 (list 'not f1))))
6822 (push f1 f))
6823 ;; then compute the category-filter matcher
6824 (dolist (x (delete-dups
6825 (append (get 'org-agenda-category-filter
6826 :preset-filter) org-agenda-category-filter)))
6827 (if (equal "-" (substring x 0 1))
6828 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
6829 (setq f1 (list 'equal (substring x 1) 'cat)))
6830 (push f1 f))
6831 (cons 'and (nreverse f))))
6833 (defun org-agenda-filter-effort-form (e)
6834 "Return the form to compare the effort of the current line with what E says.
6835 E looks like \"+<2:25\"."
6836 (let (op)
6837 (setq e (substring e 1))
6838 (setq op (string-to-char e) e (substring e 1))
6839 (setq op (cond ((equal op ?<) '<=)
6840 ((equal op ?>) '>=)
6841 ((equal op ??) op)
6842 (t '=)))
6843 (list 'org-agenda-compare-effort (list 'quote op)
6844 (org-duration-string-to-minutes e))))
6846 (defun org-agenda-compare-effort (op value)
6847 "Compare the effort of the current line with VALUE, using OP.
6848 If the line does not have an effort defined, return nil."
6849 (let ((eff (org-get-at-bol 'effort-minutes)))
6850 (if (equal op ??)
6851 (not eff)
6852 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6853 value))))
6855 (defun org-agenda-filter-apply (filter type)
6856 "Set FILTER as the new agenda filter and apply it."
6857 (let (tags cat)
6858 (if (eq type 'tag)
6859 (setq org-agenda-tag-filter filter)
6860 (setq org-agenda-category-filter filter))
6861 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6862 (if (and (eq type 'category)
6863 (not (equal (substring (car filter) 0 1) "-")))
6864 ;; Only set `org-agenda-filtered-by-category' to t
6865 ;; when a unique category is used as the filter
6866 (setq org-agenda-filtered-by-category t))
6867 (org-agenda-set-mode-name)
6868 (save-excursion
6869 (goto-char (point-min))
6870 (while (not (eobp))
6871 (if (org-get-at-bol 'org-marker)
6872 (progn
6873 (setq tags (org-get-at-bol 'tags) ; used in eval
6874 cat (get-text-property (point) 'org-category))
6875 (if (not (eval org-agenda-filter-form))
6876 (org-agenda-filter-hide-line type))
6877 (beginning-of-line 2))
6878 (beginning-of-line 2))))
6879 (if (get-char-property (point) 'invisible)
6880 (ignore-errors (org-agenda-previous-line)))))
6882 (defun org-agenda-filter-top-category-apply (category &optional negative)
6883 "Set FILTER as the new agenda filter and apply it."
6884 (org-agenda-set-mode-name)
6885 (save-excursion
6886 (goto-char (point-min))
6887 (while (not (eobp))
6888 (let* ((pos (org-get-at-bol 'org-hd-marker))
6889 (topcat (and pos (org-find-top-category pos))))
6890 (if (and topcat (funcall (if negative 'identity 'not)
6891 (string= category topcat)))
6892 (org-agenda-filter-hide-line 'category)))
6893 (beginning-of-line 2)))
6894 (if (get-char-property (point) 'invisible)
6895 (org-agenda-previous-line))
6896 (setq org-agenda-top-category-filter category
6897 org-agenda-filtered-by-top-category t))
6899 (defun org-agenda-filter-hide-line (type)
6900 (let (ov)
6901 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6902 (point-at-eol)))
6903 (overlay-put ov 'invisible t)
6904 (overlay-put ov 'type type)
6905 (if (eq type 'tag)
6906 (push ov org-agenda-tag-filter-overlays)
6907 (push ov org-agenda-cat-filter-overlays))))
6909 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6910 (setq pos (or pos (point)))
6911 (save-excursion
6912 (dolist (ov (overlays-at pos))
6913 (when (and (overlay-get ov 'invisible)
6914 (eq (overlay-get ov 'type) 'tag))
6915 (goto-char pos)
6916 (if (< (overlay-start ov) (point-at-eol))
6917 (move-overlay ov (point-at-eol)
6918 (overlay-end ov)))))))
6920 (defun org-agenda-filter-show-all-tag nil
6921 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6922 (setq org-agenda-tag-filter-overlays nil
6923 org-agenda-tag-filter nil
6924 org-agenda-filter-form nil)
6925 (org-agenda-set-mode-name))
6927 (defun org-agenda-filter-show-all-cat nil
6928 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6929 (setq org-agenda-cat-filter-overlays nil
6930 org-agenda-filtered-by-category nil
6931 org-agenda-category-filter nil
6932 org-agenda-filter-form nil)
6933 (org-agenda-set-mode-name))
6935 (defun org-agenda-manipulate-query-add ()
6936 "Manipulate the query by adding a search term with positive selection.
6937 Positive selection means the term must be matched for selection of an entry."
6938 (interactive)
6939 (org-agenda-manipulate-query ?\[))
6940 (defun org-agenda-manipulate-query-subtract ()
6941 "Manipulate the query by adding a search term with negative selection.
6942 Negative selection means term must not be matched for selection of an entry."
6943 (interactive)
6944 (org-agenda-manipulate-query ?\]))
6945 (defun org-agenda-manipulate-query-add-re ()
6946 "Manipulate the query by adding a search regexp with positive selection.
6947 Positive selection means the regexp must match for selection of an entry."
6948 (interactive)
6949 (org-agenda-manipulate-query ?\{))
6950 (defun org-agenda-manipulate-query-subtract-re ()
6951 "Manipulate the query by adding a search regexp with negative selection.
6952 Negative selection means regexp must not match for selection of an entry."
6953 (interactive)
6954 (org-agenda-manipulate-query ?\}))
6955 (defun org-agenda-manipulate-query (char)
6956 (cond
6957 ((memq org-agenda-type '(timeline agenda))
6958 (let ((org-agenda-include-inactive-timestamps t))
6959 (org-agenda-redo))
6960 (message "Display now includes inactive timestamps as well"))
6961 ((eq org-agenda-type 'search)
6962 (org-add-to-string
6963 'org-agenda-query-string
6964 (if org-agenda-last-search-view-search-was-boolean
6965 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6966 (?\{ . " +{}") (?\} . " -{}"))))
6967 " "))
6968 (setq org-agenda-redo-command
6969 (list 'org-search-view
6970 (car (get-text-property (point) 'org-last-args))
6971 org-agenda-query-string
6972 (+ (length org-agenda-query-string)
6973 (if (member char '(?\{ ?\})) 0 1))))
6974 (set-register org-agenda-query-register org-agenda-query-string)
6975 (let ((org-agenda-overriding-arguments
6976 (cdr org-agenda-redo-command)))
6977 (org-agenda-redo)))
6978 (t (error "Cannot manipulate query for %s-type agenda buffers"
6979 org-agenda-type))))
6981 (defun org-add-to-string (var string)
6982 (set var (concat (symbol-value var) string)))
6984 (defun org-agenda-goto-date (date)
6985 "Jump to DATE in agenda."
6986 (interactive (list (let ((org-read-date-prefer-future
6987 (eval org-agenda-jump-prefer-future)))
6988 (org-read-date))))
6989 (org-agenda-list nil date))
6991 (defun org-agenda-goto-today ()
6992 "Go to today."
6993 (interactive)
6994 (org-agenda-check-type t 'timeline 'agenda)
6995 (let* ((args (get-text-property (point) 'org-last-args))
6996 (curspan (nth 2 args))
6997 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6998 (cond
6999 (tdpos (goto-char tdpos))
7000 ((eq org-agenda-type 'agenda)
7001 (let* ((sd (org-agenda-compute-starting-span
7002 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7003 (org-agenda-overriding-arguments args))
7004 (setf (nth 1 org-agenda-overriding-arguments) sd)
7005 (org-agenda-redo)
7006 (org-agenda-find-same-or-today-or-agenda)))
7007 (t (error "Cannot find today")))))
7009 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7010 (goto-char
7011 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7012 (text-property-any (point-min) (point-max) 'org-today t)
7013 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7014 (and (get-text-property (point) 'org-serie)
7015 (org-agenda-goto-block-beginning))
7016 (point-min))))
7018 (defun org-agenda-goto-block-beginning ()
7019 "Go the agenda block beginning."
7020 (interactive)
7021 (if (not (derived-mode-p 'org-agenda-mode))
7022 (error "Cannot execute this command outside of org-agenda-mode buffers")
7023 (let (dest)
7024 (save-excursion
7025 (unless (looking-at "\\'")
7026 (forward-char))
7027 (let* ((prop 'org-agenda-structural-header)
7028 (p (previous-single-property-change (point) prop))
7029 (n (next-single-property-change (or (and (looking-at "\\`") 1)
7030 (1- (point))) prop)))
7031 (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
7032 (if (not dest)
7033 (error "Cannot find the beginning of the blog")
7034 (goto-char dest)
7035 (move-beginning-of-line 1)))))
7037 (defun org-agenda-later (arg)
7038 "Go forward in time by thee current span.
7039 With prefix ARG, go forward that many times the current span."
7040 (interactive "p")
7041 (org-agenda-check-type t 'agenda)
7042 (let* ((args (get-text-property (point) 'org-last-args))
7043 (span (or (nth 2 args) org-agenda-current-span))
7044 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7045 (greg (calendar-gregorian-from-absolute sd))
7046 (cnt (org-get-at-bol 'org-day-cnt))
7047 greg2)
7048 (cond
7049 ((numberp span)
7050 (setq sd (+ span sd)))
7051 ((eq span 'day)
7052 (setq sd (+ arg sd)))
7053 ((eq span 'week)
7054 (setq sd (+ (* 7 arg) sd)))
7055 ((eq span 'month)
7056 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7057 sd (calendar-absolute-from-gregorian greg2))
7058 (setcar greg2 (1+ (car greg2))))
7059 ((eq span 'year)
7060 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7061 sd (calendar-absolute-from-gregorian greg2))
7062 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7064 (setq sd (+ (* span arg) sd))))
7065 (let ((org-agenda-overriding-cmd
7066 ;; `cmd' may have been set by `org-agenda-run-series' which
7067 ;; uses `org-agenda-overriding-cmd' to decide whether
7068 ;; overriding is allowed for `cmd'
7069 (get-text-property (point) 'org-serie-cmd))
7070 (org-agenda-overriding-arguments
7071 (list (car args) sd span)))
7072 (org-agenda-redo)
7073 (org-agenda-find-same-or-today-or-agenda cnt))))
7075 (defun org-agenda-earlier (arg)
7076 "Go backward in time by the current span.
7077 With prefix ARG, go backward that many times the current span."
7078 (interactive "p")
7079 (org-agenda-later (- arg)))
7081 (defun org-agenda-view-mode-dispatch ()
7082 "Call one of the view mode commands."
7083 (interactive)
7084 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
7085 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7086 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7087 (let ((a (read-char-exclusive)))
7088 (case a
7089 (?\ (call-interactively 'org-agenda-reset-view))
7090 (?d (call-interactively 'org-agenda-day-view))
7091 (?w (call-interactively 'org-agenda-week-view))
7092 (?m (call-interactively 'org-agenda-month-view))
7093 (?y (call-interactively 'org-agenda-year-view))
7094 (?l (call-interactively 'org-agenda-log-mode))
7095 (?L (org-agenda-log-mode '(4)))
7096 (?c (org-agenda-log-mode 'clockcheck))
7097 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7098 (?a (call-interactively 'org-agenda-archives-mode))
7099 (?A (org-agenda-archives-mode 'files))
7100 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7101 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7102 (?G (call-interactively 'org-agenda-toggle-time-grid))
7103 (?D (call-interactively 'org-agenda-toggle-diary))
7104 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7105 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7106 (org-agenda-check-type t 'timeline 'agenda)
7107 (org-agenda-redo))
7108 (message "Display now includes inactive timestamps as well"))
7109 (?q (message "Abort"))
7110 (otherwise (error "Invalid key" )))))
7112 (defun org-agenda-reset-view ()
7113 "Switch to default view for agenda."
7114 (interactive)
7115 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7116 (defun org-agenda-day-view (&optional day-of-year)
7117 "Switch to daily view for agenda.
7118 With argument DAY-OF-YEAR, switch to that day of the year."
7119 (interactive "P")
7120 (org-agenda-change-time-span 'day day-of-year))
7121 (defun org-agenda-week-view (&optional iso-week)
7122 "Switch to daily view for agenda.
7123 With argument ISO-WEEK, switch to the corresponding ISO week.
7124 If ISO-WEEK has more then 2 digits, only the last two encode the
7125 week. Any digits before this encode a year. So 200712 means
7126 week 12 of year 2007. Years in the range 1938-2037 can also be
7127 written as 2-digit years."
7128 (interactive "P")
7129 (org-agenda-change-time-span 'week iso-week))
7130 (defun org-agenda-month-view (&optional month)
7131 "Switch to monthly view for agenda.
7132 With argument MONTH, switch to that month."
7133 (interactive "P")
7134 (org-agenda-change-time-span 'month month))
7135 (defun org-agenda-year-view (&optional year)
7136 "Switch to yearly view for agenda.
7137 With argument YEAR, switch to that year.
7138 If MONTH has more then 2 digits, only the last two encode the
7139 month. Any digits before this encode a year. So 200712 means
7140 December year 2007. Years in the range 1938-2037 can also be
7141 written as 2-digit years."
7142 (interactive "P")
7143 (when year
7144 (setq year (org-small-year-to-year year)))
7145 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7146 (org-agenda-change-time-span 'year year)
7147 (error "Abort")))
7149 (defun org-agenda-change-time-span (span &optional n)
7150 "Change the agenda view to SPAN.
7151 SPAN may be `day', `week', `month', `year'."
7152 (org-agenda-check-type t 'agenda)
7153 (let* ((args (get-text-property (point) 'org-last-args))
7154 (curspan (nth 2 args)))
7155 (if (and (not n) (equal curspan span))
7156 (error "Viewing span is already \"%s\"" span))
7157 (let* ((sd (or (org-get-at-bol 'day)
7158 (nth 1 args)
7159 org-starting-day))
7160 (sd (org-agenda-compute-starting-span sd span n))
7161 (org-agenda-overriding-cmd
7162 (get-text-property (point) 'org-serie-cmd))
7163 (org-agenda-overriding-arguments
7164 (list (car args) sd span)))
7165 (org-agenda-redo)
7166 (org-agenda-find-same-or-today-or-agenda))
7167 (org-agenda-set-mode-name)
7168 (message "Switched to %s view" span)))
7170 (defun org-agenda-compute-starting-span (sd span &optional n)
7171 "Compute starting date for agenda.
7172 SPAN may be `day', `week', `month', `year'. The return value
7173 is a cons cell with the starting date and the number of days,
7174 so that the date SD will be in that range."
7175 (let* ((greg (calendar-gregorian-from-absolute sd))
7176 (dg (nth 1 greg))
7177 (mg (car greg))
7178 (yg (nth 2 greg)))
7179 (cond
7180 ((eq span 'day)
7181 (when n
7182 (setq sd (+ (calendar-absolute-from-gregorian
7183 (list mg 1 yg))
7184 n -1))))
7185 ((eq span 'week)
7186 (let* ((nt (calendar-day-of-week
7187 (calendar-gregorian-from-absolute sd)))
7188 (d (if org-agenda-start-on-weekday
7189 (- nt org-agenda-start-on-weekday)
7192 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7193 (when n
7194 (require 'cal-iso)
7195 (when (> n 99)
7196 (setq y1 (org-small-year-to-year (/ n 100))
7197 n (mod n 100)))
7198 (setq sd
7199 (calendar-absolute-from-iso
7200 (list n 1
7201 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7202 ((eq span 'month)
7203 (let (y1)
7204 (when (and n (> n 99))
7205 (setq y1 (org-small-year-to-year (/ n 100))
7206 n (mod n 100)))
7207 (setq sd (calendar-absolute-from-gregorian
7208 (list (or n mg) 1 (or y1 yg))))))
7209 ((eq span 'year)
7210 (setq sd (calendar-absolute-from-gregorian
7211 (list 1 1 (or n yg))))))
7212 sd))
7214 (defun org-agenda-next-date-line (&optional arg)
7215 "Jump to the next line indicating a date in agenda buffer."
7216 (interactive "p")
7217 (org-agenda-check-type t 'agenda 'timeline)
7218 (beginning-of-line 1)
7219 ;; This does not work if user makes date format that starts with a blank
7220 (if (looking-at "^\\S-") (forward-char 1))
7221 (if (not (re-search-forward "^\\S-" nil t arg))
7222 (progn
7223 (backward-char 1)
7224 (error "No next date after this line in this buffer")))
7225 (goto-char (match-beginning 0)))
7227 (defun org-agenda-previous-date-line (&optional arg)
7228 "Jump to the previous line indicating a date in agenda buffer."
7229 (interactive "p")
7230 (org-agenda-check-type t 'agenda 'timeline)
7231 (beginning-of-line 1)
7232 (if (not (re-search-backward "^\\S-" nil t arg))
7233 (error "No previous date before this line in this buffer")))
7235 ;; Initialize the highlight
7236 (defvar org-hl (make-overlay 1 1))
7237 (overlay-put org-hl 'face 'highlight)
7239 (defun org-highlight (begin end &optional buffer)
7240 "Highlight a region with overlay."
7241 (move-overlay org-hl begin end (or buffer (current-buffer))))
7243 (defun org-unhighlight ()
7244 "Detach overlay INDEX."
7245 (org-detach-overlay org-hl))
7247 (defun org-unhighlight-once ()
7248 "Remove the highlight from its position, and this function from the hook."
7249 (remove-hook 'pre-command-hook 'org-unhighlight-once)
7250 (org-unhighlight))
7252 (defun org-agenda-follow-mode ()
7253 "Toggle follow mode in an agenda buffer."
7254 (interactive)
7255 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
7256 (org-agenda-set-mode-name)
7257 (org-agenda-do-context-action)
7258 (message "Follow mode is %s"
7259 (if org-agenda-follow-mode "on" "off")))
7261 (defun org-agenda-entry-text-mode (&optional arg)
7262 "Toggle entry text mode in an agenda buffer."
7263 (interactive "P")
7264 (setq org-agenda-entry-text-mode (or (integerp arg)
7265 (not org-agenda-entry-text-mode)))
7266 (org-agenda-entry-text-hide)
7267 (and org-agenda-entry-text-mode
7268 (let ((org-agenda-entry-text-maxlines
7269 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7270 (org-agenda-entry-text-show)))
7271 (org-agenda-set-mode-name)
7272 (message "Entry text mode is %s. Maximum number of lines is %d"
7273 (if org-agenda-entry-text-mode "on" "off")
7274 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7276 (defun org-agenda-clockreport-mode (&optional with-filter)
7277 "Toggle clocktable mode in an agenda buffer.
7278 With prefix arg WITH-FILTER, make the clocktable respect the current
7279 agenda filter."
7280 (interactive "P")
7281 (org-agenda-check-type t 'agenda)
7282 (if with-filter
7283 (setq org-agenda-clockreport-mode 'with-filter)
7284 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
7285 (org-agenda-set-mode-name)
7286 (org-agenda-redo)
7287 (message "Clocktable mode is %s"
7288 (if org-agenda-clockreport-mode "on" "off")))
7290 (defun org-agenda-log-mode (&optional special)
7291 "Toggle log mode in an agenda buffer.
7292 With argument SPECIAL, show all possible log items, not only the ones
7293 configured in `org-agenda-log-mode-items'.
7294 With a double `C-u' prefix arg, show *only* log items, nothing else."
7295 (interactive "P")
7296 (org-agenda-check-type t 'agenda 'timeline)
7297 (setq org-agenda-show-log
7298 (cond
7299 ((equal special '(16)) 'only)
7300 ((eq special 'clockcheck)
7301 (if (eq org-agenda-show-log 'clockcheck)
7302 nil 'clockcheck))
7303 (special '(closed clock state))
7304 (t (not org-agenda-show-log))))
7305 (org-agenda-set-mode-name)
7306 (org-agenda-redo)
7307 (message "Log mode is %s"
7308 (if org-agenda-show-log "on" "off")))
7310 (defun org-agenda-archives-mode (&optional with-files)
7311 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7312 When called with a prefix argument, include all archive files as well."
7313 (interactive "P")
7314 (setq org-agenda-archives-mode
7315 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7316 (org-agenda-set-mode-name)
7317 (org-agenda-redo)
7318 (message
7319 "%s"
7320 (cond
7321 ((eq org-agenda-archives-mode nil)
7322 "No archives are included")
7323 ((eq org-agenda-archives-mode 'trees)
7324 (format "Trees with :%s: tag are included" org-archive-tag))
7325 ((eq org-agenda-archives-mode t)
7326 (format "Trees with :%s: tag and all active archive files are included"
7327 org-archive-tag)))))
7329 (defun org-agenda-toggle-diary ()
7330 "Toggle diary inclusion in an agenda buffer."
7331 (interactive)
7332 (org-agenda-check-type t 'agenda)
7333 (setq org-agenda-include-diary (not org-agenda-include-diary))
7334 (org-agenda-redo)
7335 (org-agenda-set-mode-name)
7336 (message "Diary inclusion turned %s"
7337 (if org-agenda-include-diary "on" "off")))
7339 (defun org-agenda-toggle-deadlines ()
7340 "Toggle inclusion of entries with a deadline in an agenda buffer."
7341 (interactive)
7342 (org-agenda-check-type t 'agenda)
7343 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7344 (org-agenda-redo)
7345 (org-agenda-set-mode-name)
7346 (message "Deadlines inclusion turned %s"
7347 (if org-agenda-include-deadlines "on" "off")))
7349 (defun org-agenda-toggle-time-grid ()
7350 "Toggle time grid in an agenda buffer."
7351 (interactive)
7352 (org-agenda-check-type t 'agenda)
7353 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7354 (org-agenda-redo)
7355 (org-agenda-set-mode-name)
7356 (message "Time-grid turned %s"
7357 (if org-agenda-use-time-grid "on" "off")))
7359 (defun org-agenda-set-mode-name ()
7360 "Set the mode name to indicate all the small mode settings."
7361 (setq mode-name
7362 (list "Org-Agenda"
7363 (if (get 'org-agenda-files 'org-restrict) " []" "")
7365 '(:eval (org-agenda-span-name org-agenda-current-span))
7366 (if org-agenda-follow-mode " Follow" "")
7367 (if org-agenda-entry-text-mode " ETxt" "")
7368 (if org-agenda-include-diary " Diary" "")
7369 (if org-agenda-include-deadlines " Ddl" "")
7370 (if org-agenda-use-time-grid " Grid" "")
7371 (if (and (boundp 'org-habit-show-habits)
7372 org-habit-show-habits) " Habit" "")
7373 (cond
7374 ((consp org-agenda-show-log) " LogAll")
7375 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7376 (org-agenda-show-log " Log")
7377 (t ""))
7378 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7379 :preset-filter))
7380 '(:eval (org-propertize
7381 (concat " <"
7382 (mapconcat
7383 'identity
7384 (append
7385 (get 'org-agenda-category-filter :preset-filter)
7386 org-agenda-category-filter)
7388 ">")
7389 'face 'org-agenda-filter-category
7390 'help-echo "Category used in filtering"))
7392 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7393 :preset-filter))
7394 '(:eval (org-propertize
7395 (concat " {"
7396 (mapconcat
7397 'identity
7398 (append
7399 (get 'org-agenda-tag-filter :preset-filter)
7400 org-agenda-tag-filter)
7402 "}")
7403 'face 'org-agenda-filter-tags
7404 'help-echo "Tags used in filtering"))
7406 (if org-agenda-archives-mode
7407 (if (eq org-agenda-archives-mode t)
7408 " Archives"
7409 (format " :%s:" org-archive-tag))
7411 (if org-agenda-clockreport-mode
7412 (if (eq org-agenda-clockreport-mode 'with-filter)
7413 " Clock{}" " Clock")
7414 "")))
7415 (force-mode-line-update))
7417 (defun org-agenda-post-command-hook ()
7418 (setq org-agenda-type
7419 (or (get-text-property (point) 'org-agenda-type)
7420 (get-text-property (max (point-min) (1- (point)))
7421 'org-agenda-type))))
7423 (defun org-agenda-next-line ()
7424 "Move cursor to the next line, and show if follow mode is active."
7425 (interactive)
7426 (call-interactively 'next-line)
7427 (org-agenda-do-context-action))
7429 (defun org-agenda-previous-line ()
7430 "Move cursor to the previous line, and show if follow-mode is active."
7431 (interactive)
7432 (call-interactively 'previous-line)
7433 (org-agenda-do-context-action))
7435 (defun org-agenda-next-item (n)
7436 "Move cursor to next agenda item."
7437 (interactive "p")
7438 (let ((col (current-column)))
7439 (dotimes (c n)
7440 (when (next-single-property-change (point-at-eol) 'org-marker)
7441 (move-end-of-line 1)
7442 (goto-char (next-single-property-change (point) 'org-marker))))
7443 (org-move-to-column col))
7444 (org-agenda-do-context-action))
7446 (defun org-agenda-previous-item (n)
7447 "Move cursor to next agenda item."
7448 (interactive "p")
7449 (dotimes (c n)
7450 (let ((col (current-column))
7451 (goto (save-excursion
7452 (move-end-of-line 0)
7453 (previous-single-property-change (point) 'org-marker))))
7454 (if goto (goto-char goto))
7455 (org-move-to-column col)))
7456 (org-agenda-do-context-action))
7458 (defun org-agenda-do-context-action ()
7459 "Show outline path and, maybe, follow mode window."
7460 (let ((m (org-get-at-bol 'org-marker)))
7461 (when (and (markerp m) (marker-buffer m))
7462 (and org-agenda-follow-mode
7463 (if org-agenda-follow-indirect
7464 (org-agenda-tree-to-indirect-buffer)
7465 (org-agenda-show)))
7466 (and org-agenda-show-outline-path
7467 (org-with-point-at m (org-display-outline-path t))))))
7469 (defun org-agenda-show-priority ()
7470 "Show the priority of the current item.
7471 This priority is composed of the main priority given with the [#A] cookies,
7472 and by additional input from the age of a schedules or deadline entry."
7473 (interactive)
7474 (let* ((pri (org-get-at-bol 'priority)))
7475 (message "Priority is %d" (if pri pri -1000))))
7477 (defun org-agenda-show-tags ()
7478 "Show the tags applicable to the current item."
7479 (interactive)
7480 (let* ((tags (org-get-at-bol 'tags)))
7481 (if tags
7482 (message "Tags are :%s:"
7483 (org-no-properties (mapconcat 'identity tags ":")))
7484 (message "No tags associated with this line"))))
7486 (defun org-agenda-goto (&optional highlight)
7487 "Go to the Org-mode file which contains the item at point."
7488 (interactive)
7489 (let* ((marker (or (org-get-at-bol 'org-marker)
7490 (org-agenda-error)))
7491 (buffer (marker-buffer marker))
7492 (pos (marker-position marker)))
7493 (switch-to-buffer-other-window buffer)
7494 (widen)
7495 (push-mark)
7496 (goto-char pos)
7497 (when (derived-mode-p 'org-mode)
7498 (org-show-context 'agenda)
7499 (save-excursion
7500 (and (outline-next-heading)
7501 (org-flag-heading nil)))) ; show the next heading
7502 (when (outline-invisible-p)
7503 (show-entry)) ; display invisible text
7504 (recenter (/ (window-height) 2))
7505 (run-hooks 'org-agenda-after-show-hook)
7506 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7508 (defvar org-agenda-after-show-hook nil
7509 "Normal hook run after an item has been shown from the agenda.
7510 Point is in the buffer where the item originated.")
7512 (defun org-agenda-kill ()
7513 "Kill the entry or subtree belonging to the current agenda entry."
7514 (interactive)
7515 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7516 (let* ((bufname-orig (buffer-name))
7517 (marker (or (org-get-at-bol 'org-marker)
7518 (org-agenda-error)))
7519 (buffer (marker-buffer marker))
7520 (pos (marker-position marker))
7521 (type (org-get-at-bol 'type))
7522 dbeg dend (n 0) conf)
7523 (org-with-remote-undo buffer
7524 (with-current-buffer buffer
7525 (save-excursion
7526 (goto-char pos)
7527 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
7528 (setq dbeg (progn (org-back-to-heading t) (point))
7529 dend (org-end-of-subtree t t))
7530 (setq dbeg (point-at-bol)
7531 dend (min (point-max) (1+ (point-at-eol)))))
7532 (goto-char dbeg)
7533 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7534 (setq conf (or (eq t org-agenda-confirm-kill)
7535 (and (numberp org-agenda-confirm-kill)
7536 (> n org-agenda-confirm-kill))))
7537 (and conf
7538 (not (y-or-n-p
7539 (format "Delete entry with %d lines in buffer \"%s\"? "
7540 n (buffer-name buffer))))
7541 (error "Abort"))
7542 (let ((org-agenda-buffer-name bufname-orig))
7543 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
7544 (with-current-buffer buffer (delete-region dbeg dend))
7545 (message "Agenda item and source killed"))))
7547 (defvar org-archive-default-command)
7548 (defun org-agenda-archive-default ()
7549 "Archive the entry or subtree belonging to the current agenda entry."
7550 (interactive)
7551 (require 'org-archive)
7552 (org-agenda-archive-with org-archive-default-command))
7554 (defun org-agenda-archive-default-with-confirmation ()
7555 "Archive the entry or subtree belonging to the current agenda entry."
7556 (interactive)
7557 (require 'org-archive)
7558 (org-agenda-archive-with org-archive-default-command 'confirm))
7560 (defun org-agenda-archive ()
7561 "Archive the entry or subtree belonging to the current agenda entry."
7562 (interactive)
7563 (org-agenda-archive-with 'org-archive-subtree))
7565 (defun org-agenda-archive-to-archive-sibling ()
7566 "Move the entry to the archive sibling."
7567 (interactive)
7568 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7570 (defun org-agenda-archive-with (cmd &optional confirm)
7571 "Move the entry to the archive sibling."
7572 (interactive)
7573 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7574 (let* ((bufname-orig (buffer-name))
7575 (marker (or (org-get-at-bol 'org-marker)
7576 (org-agenda-error)))
7577 (buffer (marker-buffer marker))
7578 (pos (marker-position marker)))
7579 (org-with-remote-undo buffer
7580 (with-current-buffer buffer
7581 (if (derived-mode-p 'org-mode)
7582 (if (and confirm
7583 (not (y-or-n-p "Archive this subtree or entry? ")))
7584 (error "Abort")
7585 (save-excursion
7586 (goto-char pos)
7587 (let ((org-agenda-buffer-name bufname-orig))
7588 (org-remove-subtree-entries-from-agenda))
7589 (org-back-to-heading t)
7590 (funcall cmd)))
7591 (error "Archiving works only in Org-mode files"))))))
7593 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7594 "Remove all lines in the agenda that correspond to a given subtree.
7595 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7596 If this information is not given, the function uses the tree at point."
7597 (let ((buf (or buf (current-buffer))) m p)
7598 (save-excursion
7599 (unless (and beg end)
7600 (org-back-to-heading t)
7601 (setq beg (point))
7602 (org-end-of-subtree t)
7603 (setq end (point)))
7604 (set-buffer (get-buffer org-agenda-buffer-name))
7605 (save-excursion
7606 (goto-char (point-max))
7607 (beginning-of-line 1)
7608 (while (not (bobp))
7609 (when (and (setq m (org-get-at-bol 'org-marker))
7610 (equal buf (marker-buffer m))
7611 (setq p (marker-position m))
7612 (>= p beg)
7613 (< p end))
7614 (let ((inhibit-read-only t))
7615 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7616 (beginning-of-line 0))))))
7618 (defun org-agenda-refile (&optional goto rfloc no-update)
7619 "Refile the item at point."
7620 (interactive "P")
7621 (if (equal goto '(16))
7622 (org-refile-goto-last-stored)
7623 (let* ((buffer-orig (buffer-name))
7624 (marker (or (org-get-at-bol 'org-hd-marker)
7625 (org-agenda-error)))
7626 (buffer (marker-buffer marker))
7627 (pos (marker-position marker))
7628 (rfloc (or rfloc
7629 (org-refile-get-location
7630 (if goto "Goto" "Refile to") buffer
7631 org-refile-allow-creating-parent-nodes))))
7632 (with-current-buffer buffer
7633 (save-excursion
7634 (save-restriction
7635 (widen)
7636 (goto-char marker)
7637 (let ((org-agenda-buffer-name buffer-orig))
7638 (org-remove-subtree-entries-from-agenda))
7639 (org-refile goto buffer rfloc)))))
7640 (unless no-update (org-agenda-redo))))
7642 (defun org-agenda-open-link (&optional arg)
7643 "Follow the link in the current line, if any.
7644 This looks for a link in the displayed line in the agenda. It also looks
7645 at the text of the entry itself."
7646 (interactive "P")
7647 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7648 (org-get-at-bol 'org-marker)))
7649 (buffer (and marker (marker-buffer marker)))
7650 (prefix (buffer-substring
7651 (point-at-bol) (point-at-eol))))
7652 (cond
7653 (buffer
7654 (with-current-buffer buffer
7655 (save-excursion
7656 (save-restriction
7657 (widen)
7658 (goto-char marker)
7659 (org-offer-links-in-entry arg prefix)))))
7660 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7661 (save-excursion
7662 (beginning-of-line 1)
7663 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7664 (org-open-link-from-string (match-string 1)))
7665 (t (error "No link to open here")))))
7667 (defun org-agenda-copy-local-variable (var)
7668 "Get a variable from a referenced buffer and install it here."
7669 (let ((m (org-get-at-bol 'org-marker)))
7670 (when (and m (buffer-live-p (marker-buffer m)))
7671 (org-set-local var (with-current-buffer (marker-buffer m)
7672 (symbol-value var))))))
7674 (defun org-agenda-switch-to (&optional delete-other-windows)
7675 "Go to the Org-mode file which contains the item at point."
7676 (interactive)
7677 (if (and org-return-follows-link
7678 (not (org-get-at-bol 'org-marker))
7679 (org-in-regexp org-bracket-link-regexp))
7680 (org-open-link-from-string (match-string 0))
7681 (let* ((marker (or (org-get-at-bol 'org-marker)
7682 (org-agenda-error)))
7683 (buffer (marker-buffer marker))
7684 (pos (marker-position marker)))
7685 (org-pop-to-buffer-same-window buffer)
7686 (and delete-other-windows (delete-other-windows))
7687 (widen)
7688 (goto-char pos)
7689 (when (derived-mode-p 'org-mode)
7690 (org-show-context 'agenda)
7691 (save-excursion
7692 (and (outline-next-heading)
7693 (org-flag-heading nil))) ; show the next heading
7694 (when (outline-invisible-p)
7695 (show-entry)) ; display invisible text
7696 (run-hooks 'org-agenda-after-show-hook)))))
7698 (defun org-agenda-goto-mouse (ev)
7699 "Go to the Org-mode file which contains the item at the mouse click."
7700 (interactive "e")
7701 (mouse-set-point ev)
7702 (org-agenda-goto))
7704 (defun org-agenda-show (&optional full-entry)
7705 "Display the Org-mode file which contains the item at point.
7706 With prefix argument FULL-ENTRY, make the entire entry visible
7707 if it was hidden in the outline."
7708 (interactive "P")
7709 (let ((win (selected-window)))
7710 (if full-entry
7711 (let ((org-show-entry-below t))
7712 (org-agenda-goto t))
7713 (org-agenda-goto t))
7714 (select-window win)))
7716 (defvar org-agenda-show-window nil)
7717 (defun org-agenda-show-and-scroll-up (&optional arg)
7718 "Display the Org-mode file which contains the item at point.
7719 When called repeatedly, scroll the window that is displaying the buffer.
7720 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7721 `show-subtree' to display the item, so that drawers and logbooks stay
7722 folded."
7723 (interactive "P")
7724 (let ((win (selected-window)))
7725 (if (and (window-live-p org-agenda-show-window)
7726 (eq this-command last-command))
7727 (progn
7728 (select-window org-agenda-show-window)
7729 (ignore-errors (scroll-up)))
7730 (org-agenda-goto t)
7731 (if arg (org-show-entry) (show-subtree))
7732 (setq org-agenda-show-window (selected-window)))
7733 (select-window win)))
7735 (defun org-agenda-show-scroll-down ()
7736 "Scroll down the window showing the agenda."
7737 (interactive)
7738 (let ((win (selected-window)))
7739 (when (window-live-p org-agenda-show-window)
7740 (select-window org-agenda-show-window)
7741 (ignore-errors (scroll-down))
7742 (select-window win))))
7744 (defun org-agenda-show-1 (&optional more)
7745 "Display the Org-mode file which contains the item at point.
7746 The prefix arg selects the amount of information to display:
7748 0 hide the subtree
7749 1 just show the entry according to defaults.
7750 2 show the children view
7751 3 show the subtree view
7752 4 show the entire subtree and any LOGBOOK drawers
7753 5 show the entire subtree and any drawers
7754 With prefix argument FULL-ENTRY, make the entire entry visible
7755 if it was hidden in the outline."
7756 (interactive "p")
7757 (let ((win (selected-window)))
7758 (org-agenda-goto t)
7759 (org-recenter-heading 1)
7760 (cond
7761 ((= more 0)
7762 (hide-subtree)
7763 (save-excursion
7764 (org-back-to-heading)
7765 (run-hook-with-args 'org-cycle-hook 'folded))
7766 (message "Remote: FOLDED"))
7767 ((and (org-called-interactively-p 'any) (= more 1))
7768 (message "Remote: show with default settings"))
7769 ((= more 2)
7770 (show-entry)
7771 (show-children)
7772 (save-excursion
7773 (org-back-to-heading)
7774 (run-hook-with-args 'org-cycle-hook 'children))
7775 (message "Remote: CHILDREN"))
7776 ((= more 3)
7777 (show-subtree)
7778 (save-excursion
7779 (org-back-to-heading)
7780 (run-hook-with-args 'org-cycle-hook 'subtree))
7781 (message "Remote: SUBTREE"))
7782 ((= more 4)
7783 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7784 (org-drawer-regexp
7785 (concat "^[ \t]*:\\("
7786 (mapconcat 'regexp-quote org-drawers "\\|")
7787 "\\):[ \t]*$")))
7788 (show-subtree)
7789 (save-excursion
7790 (org-back-to-heading)
7791 (org-cycle-hide-drawers 'subtree)))
7792 (message "Remote: SUBTREE AND LOGBOOK"))
7793 ((> more 4)
7794 (show-subtree)
7795 (message "Remote: SUBTREE AND ALL DRAWERS")))
7796 (select-window win)))
7798 (defun org-recenter-heading (n)
7799 (save-excursion
7800 (org-back-to-heading)
7801 (recenter n)))
7803 (defvar org-agenda-cycle-counter nil)
7804 (defun org-agenda-cycle-show (&optional n)
7805 "Show the current entry in another window, with default settings.
7806 Default settings are taken from `org-show-hierarchy-above' and siblings.
7807 When use repeatedly in immediate succession, the remote entry will cycle
7808 through visibility
7810 children -> subtree -> folded
7812 When called with a numeric prefix arg, that arg will be passed through to
7813 `org-agenda-show-1'. For the interpretation of that argument, see the
7814 docstring of `org-agenda-show-1'."
7815 (interactive "P")
7816 (if (integerp n)
7817 (setq org-agenda-cycle-counter n)
7818 (if (not (eq last-command this-command))
7819 (setq org-agenda-cycle-counter 1)
7820 (if (equal org-agenda-cycle-counter 0)
7821 (setq org-agenda-cycle-counter 2)
7822 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7823 (if (> org-agenda-cycle-counter 3)
7824 (setq org-agenda-cycle-counter 0)))))
7825 (org-agenda-show-1 org-agenda-cycle-counter))
7827 (defun org-agenda-recenter (arg)
7828 "Display the Org-mode file which contains the item at point and recenter."
7829 (interactive "P")
7830 (let ((win (selected-window)))
7831 (org-agenda-goto t)
7832 (recenter arg)
7833 (select-window win)))
7835 (defun org-agenda-show-mouse (ev)
7836 "Display the Org-mode file which contains the item at the mouse click."
7837 (interactive "e")
7838 (mouse-set-point ev)
7839 (org-agenda-show))
7841 (defun org-agenda-check-no-diary ()
7842 "Check if the entry is a diary link and abort if yes."
7843 (if (org-get-at-bol 'org-agenda-diary-link)
7844 (org-agenda-error)))
7846 (defun org-agenda-error ()
7847 (error "Command not allowed in this line"))
7849 (defun org-agenda-tree-to-indirect-buffer ()
7850 "Show the subtree corresponding to the current entry in an indirect buffer.
7851 This calls the command `org-tree-to-indirect-buffer' from the original
7852 Org-mode buffer.
7853 With numerical prefix arg ARG, go up to this level and then take that tree.
7854 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7855 use the dedicated frame)."
7856 (interactive)
7857 (if (and current-prefix-arg (listp current-prefix-arg))
7858 (org-agenda-do-tree-to-indirect-buffer)
7859 (let ((agenda-window (selected-window))
7860 (indirect-window
7861 (and org-last-indirect-buffer
7862 (get-buffer-window org-last-indirect-buffer))))
7863 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7864 (unwind-protect
7865 (progn
7866 (unless (and indirect-window (window-live-p indirect-window))
7867 (setq indirect-window (split-window agenda-window)))
7868 (select-window indirect-window)
7869 (switch-to-buffer org-last-indirect-buffer :norecord)
7870 (fit-window-to-buffer indirect-window))
7871 (select-window (get-buffer-window org-agenda-buffer-name))))))
7873 (defun org-agenda-do-tree-to-indirect-buffer ()
7874 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7875 (org-agenda-check-no-diary)
7876 (let* ((marker (or (org-get-at-bol 'org-marker)
7877 (org-agenda-error)))
7878 (buffer (marker-buffer marker))
7879 (pos (marker-position marker)))
7880 (with-current-buffer buffer
7881 (save-excursion
7882 (goto-char pos)
7883 (call-interactively 'org-tree-to-indirect-buffer)))))
7885 (defvar org-last-heading-marker (make-marker)
7886 "Marker pointing to the headline that last changed its TODO state
7887 by a remote command from the agenda.")
7889 (defun org-agenda-todo-nextset ()
7890 "Switch TODO entry to next sequence."
7891 (interactive)
7892 (org-agenda-todo 'nextset))
7894 (defun org-agenda-todo-previousset ()
7895 "Switch TODO entry to previous sequence."
7896 (interactive)
7897 (org-agenda-todo 'previousset))
7899 (defun org-agenda-todo (&optional arg)
7900 "Cycle TODO state of line at point, also in Org-mode file.
7901 This changes the line at point, all other lines in the agenda referring to
7902 the same tree node, and the headline of the tree node in the Org-mode file."
7903 (interactive "P")
7904 (org-agenda-check-no-diary)
7905 (let* ((col (current-column))
7906 (marker (or (org-get-at-bol 'org-marker)
7907 (org-agenda-error)))
7908 (buffer (marker-buffer marker))
7909 (pos (marker-position marker))
7910 (hdmarker (org-get-at-bol 'org-hd-marker))
7911 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7912 (inhibit-read-only t)
7913 org-agenda-headline-snapshot-before-repeat newhead just-one)
7914 (org-with-remote-undo buffer
7915 (with-current-buffer buffer
7916 (widen)
7917 (goto-char pos)
7918 (org-show-context 'agenda)
7919 (save-excursion
7920 (and (outline-next-heading)
7921 (org-flag-heading nil))) ; show the next heading
7922 (let ((current-prefix-arg arg))
7923 (call-interactively 'org-todo))
7924 (and (bolp) (forward-char 1))
7925 (setq newhead (org-get-heading))
7926 (when (and (org-bound-and-true-p
7927 org-agenda-headline-snapshot-before-repeat)
7928 (not (equal org-agenda-headline-snapshot-before-repeat
7929 newhead))
7930 todayp)
7931 (setq newhead org-agenda-headline-snapshot-before-repeat
7932 just-one t))
7933 (save-excursion
7934 (org-back-to-heading)
7935 (move-marker org-last-heading-marker (point))))
7936 (beginning-of-line 1)
7937 (save-excursion
7938 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7939 (org-move-to-column col))))
7941 (defun org-agenda-add-note (&optional arg)
7942 "Add a time-stamped note to the entry at point."
7943 (interactive "P")
7944 (org-agenda-check-no-diary)
7945 (let* ((marker (or (org-get-at-bol 'org-marker)
7946 (org-agenda-error)))
7947 (buffer (marker-buffer marker))
7948 (pos (marker-position marker))
7949 (hdmarker (org-get-at-bol 'org-hd-marker))
7950 (inhibit-read-only t))
7951 (with-current-buffer buffer
7952 (widen)
7953 (goto-char pos)
7954 (org-show-context 'agenda)
7955 (save-excursion
7956 (and (outline-next-heading)
7957 (org-flag-heading nil))) ; show the next heading
7958 (org-add-note))))
7960 (defun org-agenda-change-all-lines (newhead hdmarker
7961 &optional fixface just-this)
7962 "Change all lines in the agenda buffer which match HDMARKER.
7963 The new content of the line will be NEWHEAD (as modified by
7964 `org-agenda-format-item'). HDMARKER is checked with
7965 `equal' against all `org-hd-marker' text properties in the file.
7966 If FIXFACE is non-nil, the face of each item is modified according to
7967 the new TODO state.
7968 If JUST-THIS is non-nil, change just the current line, not all.
7969 If FORCE-TAGS is non nil, the car of it returns the new tags."
7970 (let* ((inhibit-read-only t)
7971 (line (org-current-line))
7972 (org-agenda-buffer (current-buffer))
7973 (thetags (with-current-buffer (marker-buffer hdmarker)
7974 (save-excursion (save-restriction (widen)
7975 (goto-char hdmarker)
7976 (org-get-tags-at)))))
7977 props m pl undone-face done-face finish new dotime cat tags)
7978 (save-excursion
7979 (goto-char (point-max))
7980 (beginning-of-line 1)
7981 (while (not finish)
7982 (setq finish (bobp))
7983 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7984 (or (not just-this) (= (org-current-line) line))
7985 (equal m hdmarker))
7986 (setq props (text-properties-at (point))
7987 dotime (org-get-at-bol 'dotime)
7988 cat (org-get-at-bol 'org-category)
7989 tags thetags
7991 (let ((org-prefix-format-compiled
7992 (or (get-text-property (point) 'format)
7993 org-prefix-format-compiled))
7994 (extra (org-get-at-bol 'extra)))
7995 (with-current-buffer (marker-buffer hdmarker)
7996 (save-excursion
7997 (save-restriction
7998 (widen)
7999 (org-agenda-format-item extra newhead cat tags dotime)))))
8000 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8001 undone-face (org-get-at-bol 'undone-face)
8002 done-face (org-get-at-bol 'done-face))
8003 (beginning-of-line 1)
8004 (cond
8005 ((equal new "")
8006 (and (looking-at ".*\n?") (replace-match "")))
8007 ((looking-at ".*")
8008 (replace-match new t t)
8009 (beginning-of-line 1)
8010 (add-text-properties (point-at-bol) (point-at-eol) props)
8011 (when fixface
8012 (add-text-properties
8013 (point-at-bol) (point-at-eol)
8014 (list 'face
8015 (if org-last-todo-state-is-todo
8016 undone-face done-face))))
8017 (org-agenda-highlight-todo 'line)
8018 (beginning-of-line 1))
8019 (t (error "Line update did not work"))))
8020 (beginning-of-line 0)))
8021 (org-finalize-agenda)))
8023 (defun org-agenda-align-tags (&optional line)
8024 "Align all tags in agenda items to `org-agenda-tags-column'."
8025 (let ((inhibit-read-only t) l c)
8026 (save-excursion
8027 (goto-char (if line (point-at-bol) (point-min)))
8028 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8029 (if line (point-at-eol) nil) t)
8030 (add-text-properties
8031 (match-beginning 2) (match-end 2)
8032 (list 'face (delq nil (let ((prop (get-text-property
8033 (match-beginning 2) 'face)))
8034 (or (listp prop) (setq prop (list prop)))
8035 (if (memq 'org-tag prop)
8036 prop
8037 (cons 'org-tag prop))))))
8038 (setq l (- (match-end 2) (match-beginning 2))
8039 c (if (< org-agenda-tags-column 0)
8040 (- (abs org-agenda-tags-column) l)
8041 org-agenda-tags-column))
8042 (delete-region (match-beginning 1) (match-end 1))
8043 (goto-char (match-beginning 1))
8044 (insert (org-add-props
8045 (make-string (max 1 (- c (current-column))) ?\ )
8046 (plist-put (copy-sequence (text-properties-at (point)))
8047 'face nil))))
8048 (goto-char (point-min))
8049 (org-font-lock-add-tag-faces (point-max)))))
8051 (defun org-agenda-priority-up ()
8052 "Increase the priority of line at point, also in Org-mode file."
8053 (interactive)
8054 (org-agenda-priority 'up))
8056 (defun org-agenda-priority-down ()
8057 "Decrease the priority of line at point, also in Org-mode file."
8058 (interactive)
8059 (org-agenda-priority 'down))
8061 (defun org-agenda-priority (&optional force-direction)
8062 "Set the priority of line at point, also in Org-mode file.
8063 This changes the line at point, all other lines in the agenda referring to
8064 the same tree node, and the headline of the tree node in the Org-mode file."
8065 (interactive)
8066 (unless org-enable-priority-commands
8067 (error "Priority commands are disabled"))
8068 (org-agenda-check-no-diary)
8069 (let* ((marker (or (org-get-at-bol 'org-marker)
8070 (org-agenda-error)))
8071 (hdmarker (org-get-at-bol 'org-hd-marker))
8072 (buffer (marker-buffer hdmarker))
8073 (pos (marker-position hdmarker))
8074 (inhibit-read-only t)
8075 newhead)
8076 (org-with-remote-undo buffer
8077 (with-current-buffer buffer
8078 (widen)
8079 (goto-char pos)
8080 (org-show-context 'agenda)
8081 (save-excursion
8082 (and (outline-next-heading)
8083 (org-flag-heading nil))) ; show the next heading
8084 (funcall 'org-priority force-direction)
8085 (end-of-line 1)
8086 (setq newhead (org-get-heading)))
8087 (org-agenda-change-all-lines newhead hdmarker)
8088 (beginning-of-line 1))))
8090 ;; FIXME: should fix the tags property of the agenda line.
8091 (defun org-agenda-set-tags (&optional tag onoff)
8092 "Set tags for the current headline."
8093 (interactive)
8094 (org-agenda-check-no-diary)
8095 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8096 (call-interactively 'org-change-tag-in-region)
8097 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8098 (org-agenda-error)))
8099 (buffer (marker-buffer hdmarker))
8100 (pos (marker-position hdmarker))
8101 (inhibit-read-only t)
8102 newhead)
8103 (org-with-remote-undo buffer
8104 (with-current-buffer buffer
8105 (widen)
8106 (goto-char pos)
8107 (save-excursion
8108 (org-show-context 'agenda))
8109 (save-excursion
8110 (and (outline-next-heading)
8111 (org-flag-heading nil))) ; show the next heading
8112 (goto-char pos)
8113 (if tag
8114 (org-toggle-tag tag onoff)
8115 (call-interactively 'org-set-tags))
8116 (end-of-line 1)
8117 (setq newhead (org-get-heading)))
8118 (org-agenda-change-all-lines newhead hdmarker)
8119 (beginning-of-line 1)))))
8121 (defun org-agenda-set-property ()
8122 "Set a property for the current headline."
8123 (interactive)
8124 (org-agenda-check-no-diary)
8125 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8126 (org-agenda-error)))
8127 (buffer (marker-buffer hdmarker))
8128 (pos (marker-position hdmarker))
8129 (inhibit-read-only t)
8130 newhead)
8131 (org-with-remote-undo buffer
8132 (with-current-buffer buffer
8133 (widen)
8134 (goto-char pos)
8135 (save-excursion
8136 (org-show-context 'agenda))
8137 (save-excursion
8138 (and (outline-next-heading)
8139 (org-flag-heading nil))) ; show the next heading
8140 (goto-char pos)
8141 (call-interactively 'org-set-property)))))
8143 (defun org-agenda-set-effort ()
8144 "Set the effort property for the current headline."
8145 (interactive)
8146 (org-agenda-check-no-diary)
8147 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8148 (org-agenda-error)))
8149 (buffer (marker-buffer hdmarker))
8150 (pos (marker-position hdmarker))
8151 (inhibit-read-only t)
8152 newhead)
8153 (org-with-remote-undo buffer
8154 (with-current-buffer buffer
8155 (widen)
8156 (goto-char pos)
8157 (save-excursion
8158 (org-show-context 'agenda))
8159 (save-excursion
8160 (and (outline-next-heading)
8161 (org-flag-heading nil))) ; show the next heading
8162 (goto-char pos)
8163 (call-interactively 'org-set-effort)
8164 (end-of-line 1)
8165 (setq newhead (org-get-heading)))
8166 (org-agenda-change-all-lines newhead hdmarker))))
8168 (defun org-agenda-toggle-archive-tag ()
8169 "Toggle the archive tag for the current entry."
8170 (interactive)
8171 (org-agenda-check-no-diary)
8172 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8173 (org-agenda-error)))
8174 (buffer (marker-buffer hdmarker))
8175 (pos (marker-position hdmarker))
8176 (inhibit-read-only t)
8177 newhead)
8178 (org-with-remote-undo buffer
8179 (with-current-buffer buffer
8180 (widen)
8181 (goto-char pos)
8182 (org-show-context 'agenda)
8183 (save-excursion
8184 (and (outline-next-heading)
8185 (org-flag-heading nil))) ; show the next heading
8186 (call-interactively 'org-toggle-archive-tag)
8187 (end-of-line 1)
8188 (setq newhead (org-get-heading)))
8189 (org-agenda-change-all-lines newhead hdmarker)
8190 (beginning-of-line 1))))
8192 (defun org-agenda-do-date-later (arg)
8193 (interactive "P")
8194 (cond
8195 ((or (equal arg '(16))
8196 (memq last-command
8197 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8198 (setq this-command 'org-agenda-date-later-minutes)
8199 (org-agenda-date-later-minutes 1))
8200 ((or (equal arg '(4))
8201 (memq last-command
8202 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8203 (setq this-command 'org-agenda-date-later-hours)
8204 (org-agenda-date-later-hours 1))
8206 (org-agenda-date-later (prefix-numeric-value arg)))))
8208 (defun org-agenda-do-date-earlier (arg)
8209 (interactive "P")
8210 (cond
8211 ((or (equal arg '(16))
8212 (memq last-command
8213 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8214 (setq this-command 'org-agenda-date-earlier-minutes)
8215 (org-agenda-date-earlier-minutes 1))
8216 ((or (equal arg '(4))
8217 (memq last-command
8218 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8219 (setq this-command 'org-agenda-date-earlier-hours)
8220 (org-agenda-date-earlier-hours 1))
8222 (org-agenda-date-earlier (prefix-numeric-value arg)))))
8224 (defun org-agenda-date-later (arg &optional what)
8225 "Change the date of this item to ARG day(s) later."
8226 (interactive "p")
8227 (org-agenda-check-type t 'agenda 'timeline)
8228 (org-agenda-check-no-diary)
8229 (let* ((marker (or (org-get-at-bol 'org-marker)
8230 (org-agenda-error)))
8231 (buffer (marker-buffer marker))
8232 (pos (marker-position marker))
8233 cdate today)
8234 (org-with-remote-undo buffer
8235 (with-current-buffer buffer
8236 (widen)
8237 (goto-char pos)
8238 (if (not (org-at-timestamp-p))
8239 (error "Cannot find time stamp"))
8240 (when (and org-agenda-move-date-from-past-immediately-to-today
8241 (equal arg 1)
8242 (or (not what) (eq what 'day))
8243 (not (save-match-data (org-at-date-range-p))))
8244 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
8245 cdate (calendar-absolute-from-gregorian
8246 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
8247 today (org-today))
8248 (if (> today cdate)
8249 ;; immediately shift to today
8250 (setq arg (- today cdate))))
8251 (org-timestamp-change arg (or what 'day))
8252 (when (and (org-at-date-range-p)
8253 (re-search-backward org-tr-regexp-both (point-at-bol)))
8254 (let ((end org-last-changed-timestamp))
8255 (org-timestamp-change arg (or what 'day))
8256 (setq org-last-changed-timestamp
8257 (concat org-last-changed-timestamp "--" end)))))
8258 (org-agenda-show-new-time marker org-last-changed-timestamp))
8259 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8261 (defun org-agenda-date-earlier (arg &optional what)
8262 "Change the date of this item to ARG day(s) earlier."
8263 (interactive "p")
8264 (org-agenda-date-later (- arg) what))
8266 (defun org-agenda-date-later-minutes (arg)
8267 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8268 (interactive "p")
8269 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8270 (org-agenda-date-later arg 'minute))
8272 (defun org-agenda-date-earlier-minutes (arg)
8273 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8274 (interactive "p")
8275 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8276 (org-agenda-date-earlier arg 'minute))
8278 (defun org-agenda-date-later-hours (arg)
8279 "Change the time of this item, in hour steps."
8280 (interactive "p")
8281 (org-agenda-date-later arg 'hour))
8283 (defun org-agenda-date-earlier-hours (arg)
8284 "Change the time of this item, in hour steps."
8285 (interactive "p")
8286 (org-agenda-date-earlier arg 'hour))
8288 (defun org-agenda-show-new-time (marker stamp &optional prefix)
8289 "Show new date stamp via text properties."
8290 ;; We use text properties to make this undoable
8291 (let ((inhibit-read-only t)
8292 (buffer-invisibility-spec))
8293 (setq stamp (concat " " prefix " => " stamp))
8294 (save-excursion
8295 (goto-char (point-max))
8296 (while (not (bobp))
8297 (when (equal marker (org-get-at-bol 'org-marker))
8298 (org-move-to-column (- (window-width) (length stamp)) t)
8299 (org-agenda-fix-tags-filter-overlays-at (point))
8300 (if (featurep 'xemacs)
8301 ;; Use `duplicable' property to trigger undo recording
8302 (let ((ex (make-extent nil nil))
8303 (gl (make-glyph stamp)))
8304 (set-glyph-face gl 'secondary-selection)
8305 (set-extent-properties
8306 ex (list 'invisible t 'end-glyph gl 'duplicable t))
8307 (insert-extent ex (1- (point)) (point-at-eol)))
8308 (add-text-properties
8309 (1- (point)) (point-at-eol)
8310 (list 'display (org-add-props stamp nil
8311 'face 'secondary-selection))))
8312 (beginning-of-line 1))
8313 (beginning-of-line 0)))))
8315 (defun org-agenda-date-prompt (arg)
8316 "Change the date of this item. Date is prompted for, with default today.
8317 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8318 be used to request time specification in the time stamp."
8319 (interactive "P")
8320 (org-agenda-check-type t 'agenda 'timeline)
8321 (org-agenda-check-no-diary)
8322 (let* ((marker (or (org-get-at-bol 'org-marker)
8323 (org-agenda-error)))
8324 (buffer (marker-buffer marker))
8325 (pos (marker-position marker)))
8326 (org-with-remote-undo buffer
8327 (with-current-buffer buffer
8328 (widen)
8329 (goto-char pos)
8330 (if (not (org-at-timestamp-p t))
8331 (error "Cannot find time stamp"))
8332 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
8333 (org-agenda-show-new-time marker org-last-changed-timestamp))
8334 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8336 (defun org-agenda-schedule (arg &optional time)
8337 "Schedule the item at point.
8338 ARG is passed through to `org-schedule'."
8339 (interactive "P")
8340 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8341 (org-agenda-check-no-diary)
8342 (let* ((marker (or (org-get-at-bol 'org-marker)
8343 (org-agenda-error)))
8344 (type (marker-insertion-type marker))
8345 (buffer (marker-buffer marker))
8346 (pos (marker-position marker))
8347 (org-insert-labeled-timestamps-at-point nil)
8349 (set-marker-insertion-type marker t)
8350 (org-with-remote-undo buffer
8351 (with-current-buffer buffer
8352 (widen)
8353 (goto-char pos)
8354 (setq ts (org-schedule arg time)))
8355 (org-agenda-show-new-time marker ts "S"))
8356 (message "Item scheduled for %s" ts)))
8358 (defun org-agenda-deadline (arg &optional time)
8359 "Schedule the item at point.
8360 ARG is passed through to `org-deadline'."
8361 (interactive "P")
8362 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8363 (org-agenda-check-no-diary)
8364 (let* ((marker (or (org-get-at-bol 'org-marker)
8365 (org-agenda-error)))
8366 (buffer (marker-buffer marker))
8367 (pos (marker-position marker))
8368 (org-insert-labeled-timestamps-at-point nil)
8370 (org-with-remote-undo buffer
8371 (with-current-buffer buffer
8372 (widen)
8373 (goto-char pos)
8374 (setq ts (org-deadline arg time)))
8375 (org-agenda-show-new-time marker ts "D"))
8376 (message "Deadline for this item set to %s" ts)))
8378 (defun org-agenda-action ()
8379 "Select entry for agenda action, or execute an agenda action.
8380 This command prompts for another letter. Valid inputs are:
8382 m Mark the entry at point for an agenda action
8383 s Schedule the marked entry to the date at the cursor
8384 d Set the deadline of the marked entry to the date at the cursor
8385 r Call `org-remember' with cursor date as the default date
8386 c Call `org-capture' with cursor date as the default date
8387 SPC Show marked entry in other window
8388 TAB Visit marked entry in other window
8390 The cursor may be at a date in the calendar, or in the Org agenda."
8391 (interactive)
8392 (let (ans)
8393 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
8394 (setq ans (read-char-exclusive))
8395 (cond
8396 ((equal ans ?m)
8397 ;; Mark this entry
8398 (if (eq major-mode 'org-agenda-mode)
8399 (let ((m (or (org-get-at-bol 'org-hd-marker)
8400 (org-get-at-bol 'org-marker))))
8401 (if m
8402 (progn
8403 (move-marker org-agenda-action-marker
8404 (marker-position m) (marker-buffer m))
8405 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
8406 (error "Don't know which entry to mark")))
8407 (error "This command works only in the agenda")))
8408 ((equal ans ?s)
8409 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
8410 ((equal ans ?d)
8411 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
8412 ((equal ans ?r)
8413 (org-agenda-do-action '(org-remember) t))
8414 ((equal ans ?c)
8415 (org-agenda-do-action '(org-capture) t))
8416 ((equal ans ?\ )
8417 (let ((cw (selected-window)))
8418 (org-switch-to-buffer-other-window
8419 (marker-buffer org-agenda-action-marker))
8420 (goto-char org-agenda-action-marker)
8421 (org-show-context 'agenda)
8422 (select-window cw)))
8423 ((equal ans ?\C-i)
8424 (org-switch-to-buffer-other-window
8425 (marker-buffer org-agenda-action-marker))
8426 (goto-char org-agenda-action-marker)
8427 (org-show-context 'agenda))
8428 (t (error "Invalid agenda action %c" ans)))))
8430 (defun org-agenda-do-action (form &optional current-buffer)
8431 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
8432 (let ((org-overriding-default-time (org-get-cursor-date)))
8433 (if current-buffer
8434 (eval form)
8435 (if (not (marker-buffer org-agenda-action-marker))
8436 (error "No entry has been selected for agenda action")
8437 (with-current-buffer (marker-buffer org-agenda-action-marker)
8438 (save-excursion
8439 (save-restriction
8440 (widen)
8441 (goto-char org-agenda-action-marker)
8442 (eval form))))))))
8444 (defun org-agenda-clock-in (&optional arg)
8445 "Start the clock on the currently selected item."
8446 (interactive "P")
8447 (org-agenda-check-no-diary)
8448 (if (equal arg '(4))
8449 (org-clock-in arg)
8450 (let* ((marker (or (org-get-at-bol 'org-marker)
8451 (org-agenda-error)))
8452 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8453 marker))
8454 (pos (marker-position marker))
8455 newhead)
8456 (org-with-remote-undo (marker-buffer marker)
8457 (with-current-buffer (marker-buffer marker)
8458 (widen)
8459 (goto-char pos)
8460 (org-show-context 'agenda)
8461 (org-show-entry)
8462 (org-cycle-hide-drawers 'children)
8463 (org-clock-in arg)
8464 (setq newhead (org-get-heading)))
8465 (org-agenda-change-all-lines newhead hdmarker)))))
8467 (defun org-agenda-clock-out ()
8468 "Stop the currently running clock."
8469 (interactive)
8470 (unless (marker-buffer org-clock-marker)
8471 (error "No running clock"))
8472 (let ((marker (make-marker)) newhead)
8473 (org-with-remote-undo (marker-buffer org-clock-marker)
8474 (with-current-buffer (marker-buffer org-clock-marker)
8475 (save-excursion
8476 (save-restriction
8477 (widen)
8478 (goto-char org-clock-marker)
8479 (org-back-to-heading t)
8480 (move-marker marker (point))
8481 (org-clock-out)
8482 (setq newhead (org-get-heading))))))
8483 (org-agenda-change-all-lines newhead marker)
8484 (move-marker marker nil)))
8486 (defun org-agenda-clock-cancel (&optional arg)
8487 "Cancel the currently running clock."
8488 (interactive "P")
8489 (unless (marker-buffer org-clock-marker)
8490 (error "No running clock"))
8491 (org-with-remote-undo (marker-buffer org-clock-marker)
8492 (org-clock-cancel)))
8494 (defun org-agenda-clock-goto ()
8495 "Jump to the currently clocked in task within the agenda.
8496 If the currently clocked in task is not listed in the agenda
8497 buffer, display it in another window."
8498 (interactive)
8499 (let (pos)
8500 (mapc (lambda (o)
8501 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8502 (setq pos (overlay-start o))))
8503 (overlays-in (point-min) (point-max)))
8504 (cond (pos (goto-char pos))
8505 ;; If the currently clocked entry is not in the agenda
8506 ;; buffer, we visit it in another window:
8507 (org-clock-current-task
8508 (org-switch-to-buffer-other-window (org-clock-goto)))
8509 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8511 (defun org-agenda-diary-entry-in-org-file ()
8512 "Make a diary entry in the file `org-agenda-diary-file'."
8513 (let (d1 d2 char (text "") dp1 dp2)
8514 (if (equal (buffer-name) "*Calendar*")
8515 (setq d1 (calendar-cursor-to-date t)
8516 d2 (car calendar-mark-ring))
8517 (setq dp1 (get-text-property (point-at-bol) 'day))
8518 (unless dp1 (error "No date defined in current line"))
8519 (setq d1 (calendar-gregorian-from-absolute dp1)
8520 d2 (and (ignore-errors (mark))
8521 (save-excursion
8522 (goto-char (mark))
8523 (setq dp2 (get-text-property (point-at-bol) 'day)))
8524 (calendar-gregorian-from-absolute dp2))))
8525 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8526 (setq char (read-char-exclusive))
8527 (cond
8528 ((equal char ?d)
8529 (setq text (read-string "Day entry: "))
8530 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8531 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8532 ((equal char ?a)
8533 (setq d1 (list (car d1) (nth 1 d1)
8534 (read-number (format "Reference year [%d]: " (nth 2 d1))
8535 (nth 2 d1))))
8536 (setq text (read-string "Anniversary (use %d to show years): "))
8537 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8538 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8539 ((equal char ?b)
8540 (setq text (read-string "Block entry: "))
8541 (unless (and d1 d2 (not (equal d1 d2)))
8542 (error "No block of days selected"))
8543 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8544 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8545 ((equal char ?j)
8546 (org-switch-to-buffer-other-window
8547 (find-file-noselect org-agenda-diary-file))
8548 (require 'org-datetree)
8549 (org-datetree-find-date-create d1)
8550 (org-reveal t))
8551 (t (error "Invalid selection character `%c'" char)))))
8553 (defcustom org-agenda-insert-diary-strategy 'date-tree
8554 "Where in `org-agenda-diary-file' should new entries be added?
8555 Valid values:
8557 date-tree in the date tree, as child of the date
8558 top-level as top-level entries at the end of the file."
8559 :group 'org-agenda
8560 :type '(choice
8561 (const :tag "in a date tree" date-tree)
8562 (const :tag "as top level at end of file" top-level)))
8564 (defcustom org-agenda-insert-diary-extract-time nil
8565 "Non-nil means extract any time specification from the diary entry."
8566 :group 'org-agenda
8567 :version "24.1"
8568 :type 'boolean)
8570 (defcustom org-agenda-bulk-mark-char ">"
8571 "A single-character string to be used as the bulk mark."
8572 :group 'org-agenda
8573 :version "24.1"
8574 :type 'string)
8576 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8577 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8578 If TEXT is not empty, it will become the headline of the new entry, and
8579 the resulting entry will not be shown. When TEXT is empty, switch to
8580 `org-agenda-diary-file' and let the user finish the entry there."
8581 (let ((cw (current-window-configuration)))
8582 (org-switch-to-buffer-other-window
8583 (find-file-noselect org-agenda-diary-file))
8584 (widen)
8585 (goto-char (point-min))
8586 (cond
8587 ((eq type 'anniversary)
8588 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8589 (progn
8590 (or (org-at-heading-p t)
8591 (progn
8592 (outline-next-heading)
8593 (insert "* Anniversaries\n\n")
8594 (beginning-of-line -1)))))
8595 (outline-next-heading)
8596 (org-back-over-empty-lines)
8597 (backward-char 1)
8598 (insert "\n")
8599 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8600 (nth 2 d1) (car d1) (nth 1 d1) text)))
8601 ((eq type 'day)
8602 (let ((org-prefix-has-time t)
8603 (org-agenda-time-leading-zero t)
8604 fmt time time2)
8605 (if org-agenda-insert-diary-extract-time
8606 ;; Use org-agenda-format-item to parse text for a time-range and
8607 ;; remove it. FIXME: This is a hack, we should refactor
8608 ;; that function to make time extraction available separately
8609 (setq fmt (org-agenda-format-item nil text nil nil t)
8610 time (get-text-property 0 'time fmt)
8611 time2 (if (> (length time) 0)
8612 ;; split-string removes trailing ...... if
8613 ;; no end time given. First space
8614 ;; separates time from date.
8615 (concat " " (car (split-string time "\\.")))
8616 nil)
8617 text (get-text-property 0 'txt fmt)))
8618 (if (eq org-agenda-insert-diary-strategy 'top-level)
8619 (org-agenda-insert-diary-as-top-level text)
8620 (require 'org-datetree)
8621 (org-datetree-find-date-create d1)
8622 (org-agenda-insert-diary-make-new-entry text))
8623 (org-insert-time-stamp (org-time-from-absolute
8624 (calendar-absolute-from-gregorian d1))
8625 nil nil nil nil time2))
8626 (end-of-line 0))
8627 ((eq type 'block)
8628 (if (> (calendar-absolute-from-gregorian d1)
8629 (calendar-absolute-from-gregorian d2))
8630 (setq d1 (prog1 d2 (setq d2 d1))))
8631 (if (eq org-agenda-insert-diary-strategy 'top-level)
8632 (org-agenda-insert-diary-as-top-level text)
8633 (require 'org-datetree)
8634 (org-datetree-find-date-create d1)
8635 (org-agenda-insert-diary-make-new-entry text))
8636 (org-insert-time-stamp (org-time-from-absolute
8637 (calendar-absolute-from-gregorian d1)))
8638 (insert "--")
8639 (org-insert-time-stamp (org-time-from-absolute
8640 (calendar-absolute-from-gregorian d2)))
8641 (end-of-line 0)))
8642 (if (string-match "\\S-" text)
8643 (progn
8644 (set-window-configuration cw)
8645 (message "%s entry added to %s"
8646 (capitalize (symbol-name type))
8647 (abbreviate-file-name org-agenda-diary-file)))
8648 (org-reveal t)
8649 (message "Please finish entry here"))))
8651 (defun org-agenda-insert-diary-as-top-level (text)
8652 "Make new entry as a top-level entry at the end of the file.
8653 Add TEXT as headline, and position the cursor in the second line so that
8654 a timestamp can be added there."
8655 (widen)
8656 (goto-char (point-max))
8657 (or (bolp) (insert "\n"))
8658 (insert "* " text "\n")
8659 (if org-adapt-indentation (org-indent-to-column 2)))
8661 (defun org-agenda-insert-diary-make-new-entry (text)
8662 "Make new entry as last child of current entry.
8663 Add TEXT as headline, and position the cursor in the second line so that
8664 a timestamp can be added there."
8665 (let ((org-show-following-heading t)
8666 (org-show-siblings t)
8667 (org-show-hierarchy-above t)
8668 (org-show-entry-below t)
8669 col)
8670 (outline-next-heading)
8671 (org-back-over-empty-lines)
8672 (or (looking-at "[ \t]*$")
8673 (progn (insert "\n") (backward-char 1)))
8674 (org-insert-heading nil t)
8675 (org-do-demote)
8676 (setq col (current-column))
8677 (insert text "\n")
8678 (if org-adapt-indentation (org-indent-to-column col))
8679 (let ((org-show-following-heading t)
8680 (org-show-siblings t)
8681 (org-show-hierarchy-above t)
8682 (org-show-entry-below t))
8683 (org-show-context))))
8685 (defun org-agenda-diary-entry ()
8686 "Make a diary entry, like the `i' command from the calendar.
8687 All the standard commands work: block, weekly etc.
8688 When `org-agenda-diary-file' points to a file,
8689 `org-agenda-diary-entry-in-org-file' is called instead to create
8690 entries in that Org-mode file."
8691 (interactive)
8692 (org-agenda-check-type t 'agenda 'timeline)
8693 (if (not (eq org-agenda-diary-file 'diary-file))
8694 (org-agenda-diary-entry-in-org-file)
8695 (require 'diary-lib)
8696 (let* ((char (progn
8697 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8698 (read-char-exclusive)))
8699 (cmd (cdr (assoc char
8700 '((?d . insert-diary-entry)
8701 (?w . insert-weekly-diary-entry)
8702 (?m . insert-monthly-diary-entry)
8703 (?y . insert-yearly-diary-entry)
8704 (?a . insert-anniversary-diary-entry)
8705 (?b . insert-block-diary-entry)
8706 (?c . insert-cyclic-diary-entry)))))
8707 (oldf (symbol-function 'calendar-cursor-to-date))
8708 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8709 (point (point))
8710 (mark (or (mark t) (point))))
8711 (unless cmd
8712 (error "No command associated with <%c>" char))
8713 (unless (and (get-text-property point 'day)
8714 (or (not (equal ?b char))
8715 (get-text-property mark 'day)))
8716 (error "Don't know which date to use for diary entry"))
8717 ;; We implement this by hacking the `calendar-cursor-to-date' function
8718 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8719 (let ((calendar-mark-ring
8720 (list (calendar-gregorian-from-absolute
8721 (or (get-text-property mark 'day)
8722 (get-text-property point 'day))))))
8723 (unwind-protect
8724 (progn
8725 (fset 'calendar-cursor-to-date
8726 (lambda (&optional error dummy)
8727 (calendar-gregorian-from-absolute
8728 (get-text-property point 'day))))
8729 (call-interactively cmd))
8730 (fset 'calendar-cursor-to-date oldf))))))
8732 (defun org-agenda-execute-calendar-command (cmd)
8733 "Execute a calendar command from the agenda, with the date associated to
8734 the cursor position."
8735 (org-agenda-check-type t 'agenda 'timeline)
8736 (require 'diary-lib)
8737 (unless (get-text-property (point) 'day)
8738 (error "Don't know which date to use for calendar command"))
8739 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8740 (point (point))
8741 (date (calendar-gregorian-from-absolute
8742 (get-text-property point 'day)))
8743 ;; the following 2 vars are needed in the calendar
8744 (displayed-month (car date))
8745 (displayed-year (nth 2 date)))
8746 (unwind-protect
8747 (progn
8748 (fset 'calendar-cursor-to-date
8749 (lambda (&optional error dummy)
8750 (calendar-gregorian-from-absolute
8751 (get-text-property point 'day))))
8752 (call-interactively cmd))
8753 (fset 'calendar-cursor-to-date oldf))))
8755 (defun org-agenda-phases-of-moon ()
8756 "Display the phases of the moon for the 3 months around the cursor date."
8757 (interactive)
8758 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8760 (defun org-agenda-holidays ()
8761 "Display the holidays for the 3 months around the cursor date."
8762 (interactive)
8763 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8765 (defvar calendar-longitude)
8766 (defvar calendar-latitude)
8767 (defvar calendar-location-name)
8769 (defun org-agenda-sunrise-sunset (arg)
8770 "Display sunrise and sunset for the cursor date.
8771 Latitude and longitude can be specified with the variables
8772 `calendar-latitude' and `calendar-longitude'. When called with prefix
8773 argument, latitude and longitude will be prompted for."
8774 (interactive "P")
8775 (require 'solar)
8776 (let ((calendar-longitude (if arg nil calendar-longitude))
8777 (calendar-latitude (if arg nil calendar-latitude))
8778 (calendar-location-name
8779 (if arg "the given coordinates" calendar-location-name)))
8780 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8782 (defun org-agenda-goto-calendar ()
8783 "Open the Emacs calendar with the date at the cursor."
8784 (interactive)
8785 (org-agenda-check-type t 'agenda 'timeline)
8786 (let* ((day (or (get-text-property (point) 'day)
8787 (error "Don't know which date to open in calendar")))
8788 (date (calendar-gregorian-from-absolute day))
8789 (calendar-move-hook nil)
8790 (calendar-view-holidays-initially-flag nil)
8791 (calendar-view-diary-initially-flag nil))
8792 (calendar)
8793 (calendar-goto-date date)))
8795 ;;;###autoload
8796 (defun org-calendar-goto-agenda ()
8797 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8798 This is a command that has to be installed in `calendar-mode-map'."
8799 (interactive)
8800 (org-agenda-list nil (calendar-absolute-from-gregorian
8801 (calendar-cursor-to-date))
8802 nil))
8804 (defun org-agenda-convert-date ()
8805 (interactive)
8806 (org-agenda-check-type t 'agenda 'timeline)
8807 (let ((day (get-text-property (point) 'day))
8808 date s)
8809 (unless day
8810 (error "Don't know which date to convert"))
8811 (setq date (calendar-gregorian-from-absolute day))
8812 (setq s (concat
8813 "Gregorian: " (calendar-date-string date) "\n"
8814 "ISO: " (calendar-iso-date-string date) "\n"
8815 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8816 "Julian: " (calendar-julian-date-string date) "\n"
8817 "Astron. JD: " (calendar-astro-date-string date)
8818 " (Julian date number at noon UTC)\n"
8819 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8820 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8821 "French: " (calendar-french-date-string date) "\n"
8822 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8823 "Mayan: " (calendar-mayan-date-string date) "\n"
8824 "Coptic: " (calendar-coptic-date-string date) "\n"
8825 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8826 "Persian: " (calendar-persian-date-string date) "\n"
8827 "Chinese: " (calendar-chinese-date-string date) "\n"))
8828 (with-output-to-temp-buffer "*Dates*"
8829 (princ s))
8830 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8832 ;;; Bulk commands
8834 (defvar org-agenda-bulk-marked-entries nil
8835 "List of markers that refer to marked entries in the agenda.")
8837 (defun org-agenda-bulk-marked-p ()
8838 (eq (get-char-property (point-at-bol) 'type)
8839 'org-marked-entry-overlay))
8841 (defun org-agenda-bulk-mark (&optional arg)
8842 "Mark the entry at point for future bulk action."
8843 (interactive "p")
8844 (dotimes (i (or arg 1))
8845 (unless (org-get-at-bol 'org-agenda-diary-link)
8846 (let* ((m (org-get-at-bol 'org-hd-marker))
8848 (unless (org-agenda-bulk-marked-p)
8849 (unless m (error "Nothing to mark at point"))
8850 (push m org-agenda-bulk-marked-entries)
8851 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8852 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
8853 (org-get-todo-face "TODO")
8854 'evaporate)
8855 (overlay-put ov 'type 'org-marked-entry-overlay))
8856 (beginning-of-line 2)
8857 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8858 (beginning-of-line 2))
8859 (message "%d entries marked for bulk action"
8860 (length org-agenda-bulk-marked-entries))))))
8862 (defun org-agenda-bulk-mark-all ()
8863 "Mark all entries for future agenda bulk action."
8864 (interactive)
8865 (org-agenda-bulk-mark-regexp "."))
8867 (defun org-agenda-bulk-mark-regexp (regexp)
8868 "Mark entries matching REGEXP for future agenda bulk action."
8869 (interactive "sMark entries matching regexp: ")
8870 (let ((entries-marked 0))
8871 (save-excursion
8872 (goto-char (point-min))
8873 (goto-char (next-single-property-change (point) 'txt))
8874 (while (re-search-forward regexp nil t)
8875 (when (string-match regexp (get-text-property (point) 'txt))
8876 (setq entries-marked (1+ entries-marked))
8877 (call-interactively 'org-agenda-bulk-mark))))
8878 (if (not entries-marked)
8879 (message "No entry matching this regexp."))))
8881 (defun org-agenda-bulk-unmark (&optional arg)
8882 "Unmark the entry at point for future bulk action."
8883 (interactive "P")
8884 (if arg
8885 (org-agenda-bulk-unmark-all)
8886 (cond ((org-agenda-bulk-marked-p)
8887 (org-agenda-bulk-remove-overlays
8888 (point-at-bol) (+ 2 (point-at-bol)))
8889 (setq org-agenda-bulk-marked-entries
8890 (delete (org-get-at-bol 'org-hd-marker)
8891 org-agenda-bulk-marked-entries))
8892 (beginning-of-line 2)
8893 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8894 (beginning-of-line 2))
8895 (message "%d entries left marked for bulk action"
8896 (length org-agenda-bulk-marked-entries)))
8897 (t (message "No entry to unmark here")))))
8899 (defun org-agenda-bulk-toggle ()
8900 "Toggle marking the entry at point for bulk action."
8901 (interactive)
8902 (if (org-agenda-bulk-marked-p)
8903 (org-agenda-bulk-unmark)
8904 (org-agenda-bulk-mark)))
8906 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8907 "Remove the mark overlays between BEG and END in the agenda buffer.
8908 BEG and END default to the buffer limits.
8910 This only removes the overlays, it does not remove the markers
8911 from the list in `org-agenda-bulk-marked-entries'."
8912 (interactive)
8913 (mapc (lambda (ov)
8914 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8915 (delete-overlay ov)))
8916 (overlays-in (or beg (point-min)) (or end (point-max)))))
8918 (defun org-agenda-bulk-unmark-all ()
8919 "Remove all marks in the agenda buffer.
8920 This will remove the markers and the overlays."
8921 (interactive)
8922 (if (null org-agenda-bulk-marked-entries)
8923 (message "No entry to unmark")
8924 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8925 (setq org-agenda-bulk-marked-entries nil)
8926 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
8928 (defcustom org-agenda-persistent-marks nil
8929 "Non-nil means marked items will stay marked after a bulk action.
8930 You can toggle this interactively by typing `p' when prompted for a
8931 bulk action."
8932 :group 'org-agenda
8933 :version "24.1"
8934 :type 'boolean)
8936 (defun org-agenda-bulk-action (&optional arg)
8937 "Execute an remote-editing action on all marked entries.
8938 The prefix arg is passed through to the command if possible."
8939 (interactive "P")
8940 ;; Make sure we have markers, and only valid ones
8941 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8942 (mapc
8943 (lambda (m)
8944 (unless (and (markerp m)
8945 (marker-buffer m)
8946 (buffer-live-p (marker-buffer m))
8947 (marker-position m))
8948 (error "Marker %s for bulk command is invalid" m)))
8949 org-agenda-bulk-marked-entries)
8951 ;; Prompt for the bulk command
8952 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
8953 (message (concat msg "[r]efile [$]arch [A]rch->sib [t]odo"
8954 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction "
8955 (when org-agenda-bulk-custom-functions
8956 (concat " Custom: ["
8957 (mapconcat (lambda(f) (char-to-string (car f)))
8958 org-agenda-bulk-custom-functions "")
8959 "]"))))
8960 (catch 'exit
8961 (let* ((action (read-char-exclusive))
8962 (org-log-refile (if org-log-refile 'time nil))
8963 (entries (reverse org-agenda-bulk-marked-entries))
8964 redo-at-end
8965 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8966 (cond
8967 ((equal action ?p)
8968 (let ((org-agenda-persistent-marks
8969 (not org-agenda-persistent-marks)))
8970 (org-agenda-bulk-action)
8971 (throw 'exit nil)))
8973 ((equal action ?$)
8974 (setq cmd '(org-agenda-archive)))
8976 ((equal action ?A)
8977 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8979 ((member action '(?r ?w))
8980 (setq rfloc (org-refile-get-location
8981 "Refile to"
8982 (marker-buffer (car org-agenda-bulk-marked-entries))
8983 org-refile-allow-creating-parent-nodes))
8984 (if (nth 3 rfloc)
8985 (setcar (nthcdr 3 rfloc)
8986 (move-marker (make-marker) (nth 3 rfloc)
8987 (or (get-file-buffer (nth 1 rfloc))
8988 (find-buffer-visiting (nth 1 rfloc))
8989 (error "This should not happen")))))
8991 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8992 redo-at-end t))
8994 ((equal action ?t)
8995 (setq state (org-icompleting-read
8996 "Todo state: "
8997 (with-current-buffer (marker-buffer (car entries))
8998 (mapcar 'list org-todo-keywords-1))))
8999 (setq cmd `(let ((org-inhibit-blocking t)
9000 (org-inhibit-logging 'note))
9001 (org-agenda-todo ,state))))
9003 ((memq action '(?- ?+))
9004 (setq tag (org-icompleting-read
9005 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9006 (with-current-buffer (marker-buffer (car entries))
9007 (delq nil
9008 (mapcar (lambda (x)
9009 (if (stringp (car x)) x)) org-tag-alist)))))
9010 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9012 ((memq action '(?s ?d))
9013 (let* ((date (unless arg
9014 (org-read-date
9015 nil nil nil
9016 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
9017 (ans (if arg nil org-read-date-final-answer))
9018 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9019 (setq cmd `(let* ((bound (fboundp 'read-string))
9020 (old (and bound (symbol-function 'read-string))))
9021 (unwind-protect
9022 (progn
9023 (fset 'read-string (lambda (&rest ignore) ,ans))
9024 (eval '(,c1 arg)))
9025 (if bound
9026 (fset 'read-string old)
9027 (fmakunbound 'read-string)))))))
9029 ((equal action ?S)
9030 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9031 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9032 (let ((days (read-number
9033 (format "Scatter tasks across how many %sdays: "
9034 (if arg "week" "")) 7)))
9035 (setq cmd
9036 `(let ((distance (1+ (random ,days))))
9037 (if arg
9038 (let ((dist distance)
9039 (day-of-week
9040 (calendar-day-of-week
9041 (calendar-gregorian-from-absolute (org-today)))))
9042 (dotimes (i (1+ dist))
9043 (while (member day-of-week org-agenda-weekend-days)
9044 (incf distance)
9045 (incf day-of-week)
9046 (if (= day-of-week 7)
9047 (setq day-of-week 0)))
9048 (incf day-of-week)
9049 (if (= day-of-week 7)
9050 (setq day-of-week 0)))))
9051 ;; silently fail when try to replan a sexp entry
9052 (condition-case nil
9053 (let* ((date (calendar-gregorian-from-absolute
9054 (+ (org-today) distance)))
9055 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9056 (nth 2 date))))
9057 (org-agenda-schedule nil time))
9058 (error nil)))))))
9060 ((assoc action org-agenda-bulk-custom-functions)
9061 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9062 redo-at-end t))
9064 ((equal action ?f)
9065 (setq cmd (list (intern
9066 (org-icompleting-read "Function: "
9067 obarray 'fboundp t nil nil)))))
9069 (t (error "Invalid bulk action")))
9071 ;; Sort the markers, to make sure that parents are handled before children
9072 (setq entries (sort entries
9073 (lambda (a b)
9074 (cond
9075 ((equal (marker-buffer a) (marker-buffer b))
9076 (< (marker-position a) (marker-position b)))
9078 (string< (buffer-name (marker-buffer a))
9079 (buffer-name (marker-buffer b))))))))
9081 ;; Now loop over all markers and apply cmd
9082 (while (setq e (pop entries))
9083 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9084 (if (not pos)
9085 (progn (message "Skipping removed entry at %s" e)
9086 (setq cntskip (1+ cntskip)))
9087 (goto-char pos)
9088 (let (org-loop-over-headlines-in-active-region)
9089 (eval cmd))
9090 (when (not org-agenda-persistent-marks)
9091 (setq org-agenda-bulk-marked-entries
9092 (delete e org-agenda-bulk-marked-entries)))
9093 (setq cnt (1+ cnt))))
9094 (when (not org-agenda-persistent-marks)
9095 (org-agenda-bulk-unmark-all))
9096 (when redo-at-end (org-agenda-redo))
9097 (message "Acted on %d entries%s%s"
9099 (if (= cntskip 0)
9101 (format ", skipped %d (disappeared before their turn)"
9102 cntskip))
9103 (if (not org-agenda-persistent-marks)
9104 "" " (kept marked)"))))))
9106 ;;; Flagging notes
9108 (defun org-agenda-show-the-flagging-note ()
9109 "Display the flagging note in the other window.
9110 When called a second time in direct sequence, offer to remove the FLAGGING
9111 tag and (if present) the flagging note."
9112 (interactive)
9113 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
9114 (win (selected-window))
9115 note heading newhead)
9116 (unless hdmarker
9117 (error "No linked entry at point"))
9118 (if (and (eq this-command last-command)
9119 (y-or-n-p "Unflag and remove any flagging note? "))
9120 (progn
9121 (org-agenda-remove-flag hdmarker)
9122 (let ((win (get-buffer-window "*Flagging Note*")))
9123 (and win (delete-window win)))
9124 (message "Entry unflagged"))
9125 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
9126 (unless note
9127 (error "No flagging note"))
9128 (org-kill-new note)
9129 (org-switch-to-buffer-other-window "*Flagging Note*")
9130 (erase-buffer)
9131 (insert note)
9132 (goto-char (point-min))
9133 (while (re-search-forward "\\\\n" nil t)
9134 (replace-match "\n" t t))
9135 (goto-char (point-min))
9136 (select-window win)
9137 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9139 (defun org-agenda-remove-flag (marker)
9140 "Remove the FLAGGED tag and any flagging note in the entry."
9141 (let (newhead)
9142 (org-with-point-at marker
9143 (org-toggle-tag "FLAGGED" 'off)
9144 (org-entry-delete nil "THEFLAGGINGNOTE")
9145 (setq newhead (org-get-heading)))
9146 (org-agenda-change-all-lines newhead marker)
9147 (message "Entry unflagged")))
9149 (defun org-agenda-get-any-marker (&optional pos)
9150 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9151 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9153 ;;; Appointment reminders
9155 (defvar appt-time-msg-list)
9157 ;;;###autoload
9158 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9159 "Activate appointments found in `org-agenda-files'.
9160 With a \\[universal-argument] prefix, refresh the list of
9161 appointments.
9163 If FILTER is t, interactively prompt the user for a regular
9164 expression, and filter out entries that don't match it.
9166 If FILTER is a string, use this string as a regular expression
9167 for filtering entries out.
9169 If FILTER is a function, filter out entries against which
9170 calling the function returns nil. This function takes one
9171 argument: an entry from `org-agenda-get-day-entries'.
9173 FILTER can also be an alist with the car of each cell being
9174 either 'headline or 'category. For example:
9176 '((headline \"IMPORTANT\")
9177 (category \"Work\"))
9179 will only add headlines containing IMPORTANT or headlines
9180 belonging to the \"Work\" category.
9182 ARGS are symbols indicating what kind of entries to consider.
9183 By default `org-agenda-to-appt' will use :deadline, :scheduled
9184 and :timestamp entries. See the docstring of `org-diary' for
9185 details and examples.
9187 If an entry as a APPT_WARNTIME property, its value will be used
9188 to override `appt-message-warning-time'."
9189 (interactive "P")
9190 (if refresh (setq appt-time-msg-list nil))
9191 (if (eq filter t)
9192 (setq filter (read-from-minibuffer "Regexp filter: ")))
9193 (let* ((cnt 0) ; count added events
9194 (scope (or args '(:deadline :scheduled :timestamp)))
9195 (org-agenda-new-buffers nil)
9196 (org-deadline-warning-days 0)
9197 ;; Do not use `org-today' here because appt only takes
9198 ;; time and without date as argument, so it may pass wrong
9199 ;; information otherwise
9200 (today (org-date-to-gregorian
9201 (time-to-days (current-time))))
9202 (org-agenda-restrict nil)
9203 (files (org-agenda-files 'unrestricted)) entries file
9204 (org-agenda-buffer nil))
9205 ;; Get all entries which may contain an appt
9206 (org-agenda-prepare-buffers files)
9207 (while (setq file (pop files))
9208 (setq entries
9209 (delq nil
9210 (append entries
9211 (apply 'org-agenda-get-day-entries
9212 file today scope)))))
9213 ;; Map thru entries and find if we should filter them out
9214 (mapc
9215 (lambda(x)
9216 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
9217 (cat (get-text-property 1 'org-category x))
9218 (tod (get-text-property 1 'time-of-day x))
9219 (ok (or (null filter)
9220 (and (stringp filter) (string-match filter evt))
9221 (and (functionp filter) (funcall filter x))
9222 (and (listp filter)
9223 (let ((cat-filter (cadr (assoc 'category filter)))
9224 (evt-filter (cadr (assoc 'headline filter))))
9225 (or (and (stringp cat-filter)
9226 (string-match cat-filter cat))
9227 (and (stringp evt-filter)
9228 (string-match evt-filter evt)))))))
9229 (wrn (get-text-property 1 'warntime x)))
9230 ;; FIXME: Shall we remove text-properties for the appt text?
9231 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
9232 (when (and ok tod)
9233 (setq tod (concat "00" (number-to-string tod))
9234 tod (when (string-match
9235 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
9236 (concat (match-string 1 tod) ":"
9237 (match-string 2 tod))))
9238 (if (version< emacs-version "23.3")
9239 (appt-add tod evt)
9240 (appt-add tod evt wrn))
9241 (setq cnt (1+ cnt))))) entries)
9242 (org-release-buffers org-agenda-new-buffers)
9243 (if (eq cnt 0)
9244 (message "No event to add")
9245 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
9247 (defun org-agenda-todayp (date)
9248 "Does DATE mean today, when considering `org-extend-today-until'?"
9249 (let ((today (org-today))
9250 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
9251 date)))
9252 (eq date today)))
9254 (defun org-agenda-todo-yesterday (&optional arg)
9255 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
9256 (interactive "P")
9257 (let* ((hour (third (decode-time
9258 (org-current-time))))
9259 (org-extend-today-until (1+ hour)))
9260 (org-agenda-todo arg)))
9262 (provide 'org-agenda)
9264 ;;; org-agenda.el ends here