org-agenda.el: Code clean-up
[org-mode.git] / lisp / org-agenda.el
blob69a72e25f5960e26d088fd78309f200b1b72b92d
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (require 'org-macs)
50 (eval-when-compile
51 (require 'cl))
53 (declare-function diary-add-to-list "diary-lib"
54 (date string specifier &optional marker globcolor literal))
55 (declare-function calendar-absolute-from-iso "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-datetree-find-date-create "org-datetree"
73 (date &optional keep-restriction))
74 (declare-function org-columns-quit "org-colview" ())
75 (declare-function diary-date-display-form "diary-lib" (&optional type))
76 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
77 (declare-function org-habit-insert-consistency-graphs
78 "org-habit" (&optional line))
79 (declare-function org-is-habit-p "org-habit" (&optional pom))
80 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
81 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
82 (declare-function org-pop-to-buffer-same-window "org-compat"
83 (&optional buffer-or-name norecord label))
84 (declare-function org-agenda-columns "org-colview" ())
85 (declare-function org-add-archive-files "org-archive" (files))
87 (defvar calendar-mode-map)
88 (defvar org-clock-current-task) ; defined in org-clock.el
89 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
90 (defvar org-habit-show-habits)
91 (defvar org-habit-show-habits-only-for-today)
92 (defvar org-habit-show-all-today nil)
94 ;; Defined somewhere in this file, but used before definition.
95 (defvar org-agenda-buffer-name)
96 (defvar org-agenda-overriding-header)
97 (defvar org-agenda-title-append nil)
98 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
99 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
100 (defvar org-agenda-undo-list)
101 (defvar org-agenda-pending-undo-list)
102 (defvar original-date) ; dynamically scoped, calendar.el does scope this
104 (defcustom org-agenda-confirm-kill 1
105 "When set, remote killing from the agenda buffer needs confirmation.
106 When t, a confirmation is always needed. When a number N, confirmation is
107 only needed when the text to be killed contains more than N non-white lines."
108 :group 'org-agenda
109 :type '(choice
110 (const :tag "Never" nil)
111 (const :tag "Always" t)
112 (integer :tag "When more than N lines")))
114 (defcustom org-agenda-compact-blocks nil
115 "Non-nil means make the block agenda more compact.
116 This is done globally by leaving out lines like the agenda span
117 name and week number or the separator lines."
118 :group 'org-agenda
119 :type 'boolean)
121 (defcustom org-agenda-block-separator ?=
122 "The separator between blocks in the agenda.
123 If this is a string, it will be used as the separator, with a newline added.
124 If it is a character, it will be repeated to fill the window width.
125 If nil the separator is disabled. In `org-agenda-custom-commands' this
126 addresses the separator between the current and the previous block."
127 :group 'org-agenda
128 :type '(choice
129 (const :tag "Disabled" nil)
130 (character)
131 (string)))
133 (defgroup org-agenda-export nil
134 "Options concerning exporting agenda views in Org-mode."
135 :tag "Org Agenda Export"
136 :group 'org-agenda)
138 (defcustom org-agenda-with-colors t
139 "Non-nil means use colors in agenda views."
140 :group 'org-agenda-export
141 :type 'boolean)
143 (defcustom org-agenda-exporter-settings nil
144 "Alist of variable/value pairs that should be active during agenda export.
145 This is a good place to set options for ps-print and for htmlize.
146 Note that the way this is implemented, the values will be evaluated
147 before assigned to the variables. So make sure to quote values you do
148 *not* want evaluated, for example
150 (setq org-agenda-exporter-settings
151 '((ps-print-color-p 'black-white)))"
152 :group 'org-agenda-export
153 :type '(repeat
154 (list
155 (variable)
156 (sexp :tag "Value"))))
158 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
159 "Hook run in temporary buffer before writing it to an export file.
160 A useful function is `org-agenda-add-entry-text'."
161 :group 'org-agenda-export
162 :type 'hook
163 :options '(org-agenda-add-entry-text))
165 (defcustom org-agenda-add-entry-text-maxlines 0
166 "Maximum number of entry text lines to be added to agenda.
167 This is only relevant when `org-agenda-add-entry-text' is part of
168 `org-agenda-before-write-hook', which it is by default.
169 When this is 0, nothing will happen. When it is greater than 0, it
170 specifies the maximum number of lines that will be added for each entry
171 that is listed in the agenda view.
173 Note that this variable is not used during display, only when exporting
174 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
175 and `org-agenda-entry-text-maxlines'."
176 :group 'org-agenda
177 :type 'integer)
179 (defcustom org-agenda-add-entry-text-descriptive-links t
180 "Non-nil means export org-links as descriptive links in agenda added text.
181 This variable applies to the text added to the agenda when
182 `org-agenda-add-entry-text-maxlines' is larger than 0.
183 When this variable nil, the URL will (also) be shown."
184 :group 'org-agenda
185 :type 'boolean)
187 (defcustom org-agenda-export-html-style ""
188 "The style specification for exported HTML Agenda files.
189 If this variable contains a string, it will replace the default <style>
190 section as produced by `htmlize'.
191 Since there are different ways of setting style information, this variable
192 needs to contain the full HTML structure to provide a style, including the
193 surrounding HTML tags. The style specifications should include definitions
194 the fonts used by the agenda, here is an example:
196 <style type=\"text/css\">
197 p { font-weight: normal; color: gray; }
198 .org-agenda-structure {
199 font-size: 110%;
200 color: #003399;
201 font-weight: 600;
203 .org-todo {
204 color: #cc6666;
205 font-weight: bold;
207 .org-agenda-done {
208 color: #339933;
210 .org-done {
211 color: #339933;
213 .title { text-align: center; }
214 .todo, .deadline { color: red; }
215 .done { color: green; }
216 </style>
218 or, if you want to keep the style in a file,
220 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
222 As the value of this option simply gets inserted into the HTML <head> header,
223 you can \"misuse\" it to also add other text to the header. However,
224 <style>...</style> is required, if not present the variable will be ignored."
225 :group 'org-agenda-export
226 :group 'org-export-html
227 :type 'string)
229 (defcustom org-agenda-persistent-filter nil
230 "When set, keep filters from one agenda view to the next."
231 :group 'org-agenda
232 :type 'boolean)
234 (defgroup org-agenda-custom-commands nil
235 "Options concerning agenda views in Org-mode."
236 :tag "Org Agenda Custom Commands"
237 :group 'org-agenda)
239 (defconst org-sorting-choice
240 '(choice
241 (const time-up) (const time-down)
242 (const category-keep) (const category-up) (const category-down)
243 (const tag-down) (const tag-up)
244 (const priority-up) (const priority-down)
245 (const todo-state-up) (const todo-state-down)
246 (const effort-up) (const effort-down)
247 (const habit-up) (const habit-down)
248 (const alpha-up) (const alpha-down)
249 (const user-defined-up) (const user-defined-down))
250 "Sorting choices.")
252 ;; Keep custom values for `org-agenda-filter-preset' compatible with
253 ;; the new variable `org-agenda-tag-filter-preset'.
254 (if (fboundp 'defvaralias)
255 (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
256 (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
258 (defconst org-agenda-custom-commands-local-options
259 `(repeat :tag "Local settings for this command. Remember to quote values"
260 (choice :tag "Setting"
261 (list :tag "Heading for this block"
262 (const org-agenda-overriding-header)
263 (string :tag "Headline"))
264 (list :tag "Files to be searched"
265 (const org-agenda-files)
266 (list
267 (const :format "" quote)
268 (repeat (file))))
269 (list :tag "Sorting strategy"
270 (const org-agenda-sorting-strategy)
271 (list
272 (const :format "" quote)
273 (repeat
274 ,org-sorting-choice)))
275 (list :tag "Prefix format"
276 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
277 (string))
278 (list :tag "Number of days in agenda"
279 (const org-agenda-span)
280 (choice (const :tag "Day" 'day)
281 (const :tag "Week" 'week)
282 (const :tag "Month" 'month)
283 (const :tag "Year" 'year)
284 (integer :tag "Custom")))
285 (list :tag "Fixed starting date"
286 (const org-agenda-start-day)
287 (string :value "2007-11-01"))
288 (list :tag "Start on day of week"
289 (const org-agenda-start-on-weekday)
290 (choice :value 1
291 (const :tag "Today" nil)
292 (integer :tag "Weekday No.")))
293 (list :tag "Include data from diary"
294 (const org-agenda-include-diary)
295 (boolean))
296 (list :tag "Deadline Warning days"
297 (const org-deadline-warning-days)
298 (integer :value 1))
299 (list :tag "Category filter preset"
300 (const org-agenda-category-filter-preset)
301 (list
302 (const :format "" quote)
303 (repeat
304 (string :tag "+category or -category"))))
305 (list :tag "Tags filter preset"
306 (const org-agenda-tag-filter-preset)
307 (list
308 (const :format "" quote)
309 (repeat
310 (string :tag "+tag or -tag"))))
311 (list :tag "Set daily/weekly entry types"
312 (const org-agenda-entry-types)
313 (list
314 (const :format "" quote)
315 (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
316 (const :deadline)
317 (const :scheduled)
318 (const :timestamp)
319 (const :sexp))))
320 (list :tag "Standard skipping condition"
321 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
322 (const org-agenda-skip-function)
323 (list
324 (const :format "" quote)
325 (list
326 (choice
327 :tag "Skipping range"
328 (const :tag "Skip entry" org-agenda-skip-entry-if)
329 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
330 (repeat :inline t :tag "Conditions for skipping"
331 (choice
332 :tag "Condition type"
333 (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
334 (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
335 (list :tag "TODO state is" :inline t
336 (const 'todo)
337 (choice
338 (const :tag "any not-done state" 'todo)
339 (const :tag "any done state" 'done)
340 (const :tag "any state" 'any)
341 (list :tag "Keyword list"
342 (const :format "" quote)
343 (repeat (string :tag "Keyword")))))
344 (list :tag "TODO state is not" :inline t
345 (const 'nottodo)
346 (choice
347 (const :tag "any not-done state" 'todo)
348 (const :tag "any done state" 'done)
349 (const :tag "any state" 'any)
350 (list :tag "Keyword list"
351 (const :format "" quote)
352 (repeat (string :tag "Keyword")))))
353 (const :tag "scheduled" 'scheduled)
354 (const :tag "not scheduled" 'notscheduled)
355 (const :tag "deadline" 'deadline)
356 (const :tag "no deadline" 'notdeadline)
357 (const :tag "timestamp" 'timestamp)
358 (const :tag "no timestamp" 'nottimestamp))))))
359 (list :tag "Non-standard skipping condition"
360 :value (org-agenda-skip-function)
361 (const org-agenda-skip-function)
362 (sexp :tag "Function or form (quoted!)"))
363 (list :tag "Any variable"
364 (variable :tag "Variable")
365 (sexp :tag "Value (sexp)"))))
366 "Selection of examples for agenda command settings.
367 This will be spliced into the custom type of
368 `org-agenda-custom-commands'.")
371 (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
372 ((agenda "") (alltodo))))
373 "Custom commands for the agenda.
374 These commands will be offered on the splash screen displayed by the
375 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
377 (key desc type match settings files)
379 key The key (one or more characters as a string) to be associated
380 with the command.
381 desc A description of the command, when omitted or nil, a default
382 description is built using MATCH.
383 type The command type, any of the following symbols:
384 agenda The daily/weekly agenda.
385 todo Entries with a specific TODO keyword, in all agenda files.
386 search Entries containing search words entry or headline.
387 tags Tags/Property/TODO match in all agenda files.
388 tags-todo Tags/P/T match in all agenda files, TODO entries only.
389 todo-tree Sparse tree of specific TODO keyword in *current* file.
390 tags-tree Sparse tree with all tags matches in *current* file.
391 occur-tree Occur sparse tree for *current* file.
392 ... A user-defined function.
393 match What to search for:
394 - a single keyword for TODO keyword searches
395 - a tags match expression for tags searches
396 - a word search expression for text searches.
397 - a regular expression for occur searches
398 For all other commands, this should be the empty string.
399 settings A list of option settings, similar to that in a let form, so like
400 this: ((opt1 val1) (opt2 val2) ...). The values will be
401 evaluated at the moment of execution, so quote them when needed.
402 files A list of files file to write the produced agenda buffer to
403 with the command `org-store-agenda-views'.
404 If a file name ends in \".html\", an HTML version of the buffer
405 is written out. If it ends in \".ps\", a postscript version is
406 produced. Otherwise, only the plain text is written to the file.
408 You can also define a set of commands, to create a composite agenda buffer.
409 In this case, an entry looks like this:
411 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
413 where
415 desc A description string to be displayed in the dispatcher menu.
416 cmd An agenda command, similar to the above. However, tree commands
417 are not allowed, but instead you can get agenda and global todo list.
418 So valid commands for a set are:
419 (agenda \"\" settings)
420 (alltodo \"\" settings)
421 (stuck \"\" settings)
422 (todo \"match\" settings files)
423 (search \"match\" settings files)
424 (tags \"match\" settings files)
425 (tags-todo \"match\" settings files)
427 Each command can carry a list of options, and another set of options can be
428 given for the whole set of commands. Individual command options take
429 precedence over the general options.
431 When using several characters as key to a command, the first characters
432 are prefix commands. For the dispatcher to display useful information, you
433 should provide a description for the prefix, like
435 (setq org-agenda-custom-commands
436 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
437 (\"hl\" tags \"+HOME+Lisa\")
438 (\"hp\" tags \"+HOME+Peter\")
439 (\"hk\" tags \"+HOME+Kim\")))"
440 :group 'org-agenda-custom-commands
441 :type `(repeat
442 (choice :value ("x" "Describe command here" tags "" nil)
443 (list :tag "Single command"
444 (string :tag "Access Key(s) ")
445 (option (string :tag "Description"))
446 (choice
447 (const :tag "Agenda" agenda)
448 (const :tag "TODO list" alltodo)
449 (const :tag "Search words" search)
450 (const :tag "Stuck projects" stuck)
451 (const :tag "Tags/Property match (all agenda files)" tags)
452 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
453 (const :tag "TODO keyword search (all agenda files)" todo)
454 (const :tag "Tags sparse tree (current buffer)" tags-tree)
455 (const :tag "TODO keyword tree (current buffer)" todo-tree)
456 (const :tag "Occur tree (current buffer)" occur-tree)
457 (sexp :tag "Other, user-defined function"))
458 (string :tag "Match (only for some commands)")
459 ,org-agenda-custom-commands-local-options
460 (option (repeat :tag "Export" (file :tag "Export to"))))
461 (list :tag "Command series, all agenda files"
462 (string :tag "Access Key(s)")
463 (string :tag "Description ")
464 (repeat :tag "Component"
465 (choice
466 (list :tag "Agenda"
467 (const :format "" agenda)
468 (const :tag "" :format "" "")
469 ,org-agenda-custom-commands-local-options)
470 (list :tag "TODO list (all keywords)"
471 (const :format "" alltodo)
472 (const :tag "" :format "" "")
473 ,org-agenda-custom-commands-local-options)
474 (list :tag "Search words"
475 (const :format "" search)
476 (string :tag "Match")
477 ,org-agenda-custom-commands-local-options)
478 (list :tag "Stuck projects"
479 (const :format "" stuck)
480 (const :tag "" :format "" "")
481 ,org-agenda-custom-commands-local-options)
482 (list :tag "Tags search"
483 (const :format "" tags)
484 (string :tag "Match")
485 ,org-agenda-custom-commands-local-options)
486 (list :tag "Tags search, TODO entries only"
487 (const :format "" tags-todo)
488 (string :tag "Match")
489 ,org-agenda-custom-commands-local-options)
490 (list :tag "TODO keyword search"
491 (const :format "" todo)
492 (string :tag "Match")
493 ,org-agenda-custom-commands-local-options)
494 (list :tag "Other, user-defined function"
495 (symbol :tag "function")
496 (string :tag "Match")
497 ,org-agenda-custom-commands-local-options)))
499 (repeat :tag "Settings for entire command set"
500 (list (variable :tag "Any variable")
501 (sexp :tag "Value")))
502 (option (repeat :tag "Export" (file :tag "Export to"))))
503 (cons :tag "Prefix key documentation"
504 (string :tag "Access Key(s)")
505 (string :tag "Description ")))))
507 (defcustom org-agenda-query-register ?o
508 "The register holding the current query string.
509 The purpose of this is that if you construct a query string interactively,
510 you can then use it to define a custom command."
511 :group 'org-agenda-custom-commands
512 :type 'character)
514 (defcustom org-stuck-projects
515 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
516 "How to identify stuck projects.
517 This is a list of four items:
518 1. A tags/todo/property matcher string that is used to identify a project.
519 See the manual for a description of tag and property searches.
520 The entire tree below a headline matched by this is considered one project.
521 2. A list of TODO keywords identifying non-stuck projects.
522 If the project subtree contains any headline with one of these todo
523 keywords, the project is considered to be not stuck. If you specify
524 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
525 3. A list of tags identifying non-stuck projects.
526 If the project subtree contains any headline with one of these tags,
527 the project is considered to be not stuck. If you specify \"*\" as
528 a tag, any tag will mark the project unstuck. Note that this is about
529 the explicit presence of a tag somewhere in the subtree, inherited
530 tags to not count here. If inherited tags make a project not stuck,
531 use \"-TAG\" in the tags part of the matcher under (1.) above.
532 4. An arbitrary regular expression matching non-stuck projects.
534 If the project turns out to be not stuck, search continues also in the
535 subtree to see if any of the subtasks have project status.
537 See also the variable `org-tags-match-list-sublevels' which applies
538 to projects matched by this search as well.
540 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
541 or `C-c a #' to produce the list."
542 :group 'org-agenda-custom-commands
543 :type '(list
544 (string :tag "Tags/TODO match to identify a project")
545 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
546 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
547 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
549 (defcustom org-agenda-filter-effort-default-operator "<"
550 "The default operator for effort estimate filtering.
551 If you select an effort estimate limit without first pressing an operator,
552 this one will be used."
553 :group 'org-agenda-custom-commands
554 :type '(choice (const :tag "less or equal" "<")
555 (const :tag "greater or equal"">")
556 (const :tag "equal" "=")))
558 (defgroup org-agenda-skip nil
559 "Options concerning skipping parts of agenda files."
560 :tag "Org Agenda Skip"
561 :group 'org-agenda)
563 (defcustom org-agenda-skip-function-global nil
564 "Function to be called at each match during agenda construction.
565 If this function returns nil, the current match should not be skipped.
566 If the function decided to skip an agenda match, is must return the
567 buffer position from which the search should be continued.
568 This may also be a Lisp form, which will be evaluated.
570 This variable will be applied to every agenda match, including
571 tags/property searches and TODO lists. So try to make the test function
572 do its checking as efficiently as possible. To implement a skipping
573 condition just for specific agenda commands, use the variable
574 `org-agenda-skip-function' which can be set in the options section
575 of custom agenda commands."
576 :group 'org-agenda-skip
577 :type 'sexp)
579 (defgroup org-agenda-daily/weekly nil
580 "Options concerning the daily/weekly agenda."
581 :tag "Org Agenda Daily/Weekly"
582 :group 'org-agenda)
583 (defgroup org-agenda-todo-list nil
584 "Options concerning the global todo list agenda view."
585 :tag "Org Agenda Todo List"
586 :group 'org-agenda)
587 (defgroup org-agenda-match-view nil
588 "Options concerning the general tags/property/todo match agenda view."
589 :tag "Org Agenda Match View"
590 :group 'org-agenda)
591 (defgroup org-agenda-search-view nil
592 "Options concerning the general tags/property/todo match agenda view."
593 :tag "Org Agenda Match View"
594 :group 'org-agenda)
596 (defvar org-agenda-archives-mode nil
597 "Non-nil means the agenda will include archived items.
598 If this is the symbol `trees', trees in the selected agenda scope
599 that are marked with the ARCHIVE tag will be included anyway. When this is
600 t, also all archive files associated with the current selection of agenda
601 files will be included.")
603 (defcustom org-agenda-skip-comment-trees t
604 "Non-nil means skip trees that start with the COMMENT keyword.
605 When nil, these trees are also scanned by agenda commands."
606 :group 'org-agenda-skip
607 :type 'boolean)
609 (defcustom org-agenda-todo-list-sublevels t
610 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
611 When nil, the sublevels of a TODO entry are not checked, resulting in
612 potentially much shorter TODO lists."
613 :group 'org-agenda-skip
614 :group 'org-agenda-todo-list
615 :type 'boolean)
617 (defcustom org-agenda-todo-ignore-with-date nil
618 "Non-nil means don't show entries with a date in the global todo list.
619 You can use this if you prefer to mark mere appointments with a TODO keyword,
620 but don't want them to show up in the TODO list.
621 When this is set, it also covers deadlines and scheduled items, the settings
622 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
623 will be ignored.
624 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
625 :group 'org-agenda-skip
626 :group 'org-agenda-todo-list
627 :type 'boolean)
629 (defcustom org-agenda-todo-ignore-timestamp nil
630 "Non-nil means don't show entries with a timestamp.
631 This applies when creating the global todo list.
632 Valid values are:
634 past Don't show entries for today or in the past.
636 future Don't show entries with a timestamp in the future.
637 The idea behind this is that if it has a future
638 timestamp, you don't want to think about it until the
639 date.
641 all Don't show any entries with a timestamp in the global todo list.
642 The idea behind this is that by setting a timestamp, you
643 have already \"taken care\" of this item.
645 This variable can also have an integer as a value. If positive (N),
646 todos with a timestamp N or more days in the future will be ignored. If
647 negative (-N), todos with a timestamp N or more days in the past will be
648 ignored. If 0, todos with a timestamp either today or in the future will
649 be ignored. For example, a value of -1 will exclude todos with a
650 timestamp in the past (yesterday or earlier), while a value of 7 will
651 exclude todos with a timestamp a week or more in the future.
653 See also `org-agenda-todo-ignore-with-date'.
654 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
655 to make his option also apply to the tags-todo list."
656 :group 'org-agenda-skip
657 :group 'org-agenda-todo-list
658 :version "24.1"
659 :type '(choice
660 (const :tag "Ignore future timestamp todos" future)
661 (const :tag "Ignore past or present timestamp todos" past)
662 (const :tag "Ignore all timestamp todos" all)
663 (const :tag "Show timestamp todos" nil)
664 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
666 (defcustom org-agenda-todo-ignore-scheduled nil
667 "Non-nil means, ignore some scheduled TODO items when making TODO list.
668 This applies when creating the global todo list.
669 Valid values are:
671 past Don't show entries scheduled today or in the past.
673 future Don't show entries scheduled in the future.
674 The idea behind this is that by scheduling it, you don't want to
675 think about it until the scheduled date.
677 all Don't show any scheduled entries in the global todo list.
678 The idea behind this is that by scheduling it, you have already
679 \"taken care\" of this item.
681 t Same as `all', for backward compatibility.
683 This variable can also have an integer as a value. See
684 `org-agenda-todo-ignore-timestamp' for more details.
686 See also `org-agenda-todo-ignore-with-date'.
687 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
688 to make his option also apply to the tags-todo list."
689 :group 'org-agenda-skip
690 :group 'org-agenda-todo-list
691 :type '(choice
692 (const :tag "Ignore future-scheduled todos" future)
693 (const :tag "Ignore past- or present-scheduled todos" past)
694 (const :tag "Ignore all scheduled todos" all)
695 (const :tag "Ignore all scheduled todos (compatibility)" t)
696 (const :tag "Show scheduled todos" nil)
697 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
699 (defcustom org-agenda-todo-ignore-deadlines nil
700 "Non-nil means ignore some deadlined TODO items when making TODO list.
701 There are different motivations for using different values, please think
702 carefully when configuring this variable.
704 This applies when creating the global todo list.
705 Valid values are:
707 near Don't show near deadline entries. A deadline is near when it is
708 closer than `org-deadline-warning-days' days. The idea behind this
709 is that such items will appear in the agenda anyway.
711 far Don't show TODO entries where a deadline has been defined, but
712 the deadline is not near. This is useful if you don't want to
713 use the todo list to figure out what to do now.
715 past Don't show entries with a deadline timestamp for today or in the past.
717 future Don't show entries with a deadline timestamp in the future, not even
718 when they become `near' ones. Use it with caution.
720 all Ignore all TODO entries that do have a deadline.
722 t Same as `near', for backward compatibility.
724 This variable can also have an integer as a value. See
725 `org-agenda-todo-ignore-timestamp' for more details.
727 See also `org-agenda-todo-ignore-with-date'.
728 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
729 to make his option also apply to the tags-todo list."
730 :group 'org-agenda-skip
731 :group 'org-agenda-todo-list
732 :type '(choice
733 (const :tag "Ignore near deadlines" near)
734 (const :tag "Ignore near deadlines (compatibility)" t)
735 (const :tag "Ignore far deadlines" far)
736 (const :tag "Ignore all TODOs with a deadlines" all)
737 (const :tag "Show all TODOs, even if they have a deadline" nil)
738 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
740 (defcustom org-agenda-tags-todo-honor-ignore-options nil
741 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
742 The variables
743 `org-agenda-todo-ignore-with-date',
744 `org-agenda-todo-ignore-timestamp',
745 `org-agenda-todo-ignore-scheduled',
746 `org-agenda-todo-ignore-deadlines'
747 make the global TODO list skip entries that have time stamps of certain
748 kinds. If this option is set, the same options will also apply for the
749 tags-todo search, which is the general tags/property matcher
750 restricted to unfinished TODO entries only."
751 :group 'org-agenda-skip
752 :group 'org-agenda-todo-list
753 :group 'org-agenda-match-view
754 :type 'boolean)
756 (defcustom org-agenda-skip-scheduled-if-done nil
757 "Non-nil means don't show scheduled items in agenda when they are done.
758 This is relevant for the daily/weekly agenda, not for the TODO list. And
759 it applies only to the actual date of the scheduling. Warnings about
760 an item with a past scheduling dates are always turned off when the item
761 is DONE."
762 :group 'org-agenda-skip
763 :group 'org-agenda-daily/weekly
764 :type 'boolean)
766 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
767 "Non-nil means skip scheduling line if same entry shows because of deadline.
768 In the agenda of today, an entry can show up multiple times because
769 it is both scheduled and has a nearby deadline, and maybe a plain time
770 stamp as well.
771 When this variable is t, then only the deadline is shown and the fact that
772 the entry is scheduled today or was scheduled previously is not shown.
773 When this variable is nil, the entry will be shown several times. When
774 the variable is the symbol `not-today', then skip scheduled previously,
775 but not scheduled today."
776 :group 'org-agenda-skip
777 :group 'org-agenda-daily/weekly
778 :type '(choice
779 (const :tag "Never" nil)
780 (const :tag "Always" t)
781 (const :tag "Not when scheduled today" not-today)))
783 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
784 "Non-nil means skip timestamp line if same entry shows because of deadline.
785 In the agenda of today, an entry can show up multiple times
786 because it has both a plain timestamp and has a nearby deadline.
787 When this variable is t, then only the deadline is shown and the
788 fact that the entry has a timestamp for or including today is not
789 shown. When this variable is nil, the entry will be shown
790 several times."
791 :group 'org-agenda-skip
792 :group 'org-agenda-daily/weekly
793 :version "24.1"
794 :type '(choice
795 (const :tag "Never" nil)
796 (const :tag "Always" t)))
798 (defcustom org-agenda-skip-deadline-if-done nil
799 "Non-nil means don't show deadlines when the corresponding item is done.
800 When nil, the deadline is still shown and should give you a happy feeling.
801 This is relevant for the daily/weekly agenda. And it applied only to the
802 actually date of the deadline. Warnings about approaching and past-due
803 deadlines are always turned off when the item is DONE."
804 :group 'org-agenda-skip
805 :group 'org-agenda-daily/weekly
806 :type 'boolean)
808 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
809 "Non-nil means skip deadline prewarning when entry is also scheduled.
810 This will apply on all days where a prewarning for the deadline would
811 be shown, but not at the day when the entry is actually due. On that day,
812 the deadline will be shown anyway.
813 This variable may be set to nil, t, or a number which will then give
814 the number of days before the actual deadline when the prewarnings
815 should resume.
816 This can be used in a workflow where the first showing of the deadline will
817 trigger you to schedule it, and then you don't want to be reminded of it
818 because you will take care of it on the day when scheduled."
819 :group 'org-agenda-skip
820 :group 'org-agenda-daily/weekly
821 :version "24.1"
822 :type '(choice
823 (const :tag "Alwas show prewarning" nil)
824 (const :tag "Remove prewarning if entry is scheduled" t)
825 (integer :tag "Restart prewarning N days before deadline")))
827 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
828 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
829 When non-nil, after the search for timestamps has matched once in an
830 entry, the rest of the entry will not be searched."
831 :group 'org-agenda-skip
832 :type 'boolean)
834 (defcustom org-agenda-skip-timestamp-if-done nil
835 "Non-nil means don't select item by timestamp or -range if it is DONE."
836 :group 'org-agenda-skip
837 :group 'org-agenda-daily/weekly
838 :type 'boolean)
840 (defcustom org-agenda-dim-blocked-tasks t
841 "Non-nil means dim blocked tasks in the agenda display.
842 This causes some overhead during agenda construction, but if you
843 have turned on `org-enforce-todo-dependencies',
844 `org-enforce-todo-checkbox-dependencies', or any other blocking
845 mechanism, this will create useful feedback in the agenda.
847 Instead of t, this variable can also have the value `invisible'.
848 Then blocked tasks will be invisible and only become visible when
849 they become unblocked. An exemption to this behavior is when a task is
850 blocked because of unchecked checkboxes below it. Since checkboxes do
851 not show up in the agenda views, making this task invisible you remove any
852 trace from agenda views that there is something to do. Therefore, a task
853 that is blocked because of checkboxes will never be made invisible, it
854 will only be dimmed."
855 :group 'org-agenda-daily/weekly
856 :group 'org-agenda-todo-list
857 :type '(choice
858 (const :tag "Do not dim" nil)
859 (const :tag "Dim to a gray face" t)
860 (const :tag "Make invisible" invisible)))
862 (defcustom org-timeline-show-empty-dates 3
863 "Non-nil means `org-timeline' also shows dates without an entry.
864 When nil, only the days which actually have entries are shown.
865 When t, all days between the first and the last date are shown.
866 When an integer, show also empty dates, but if there is a gap of more than
867 N days, just insert a special line indicating the size of the gap."
868 :group 'org-agenda-skip
869 :type '(choice
870 (const :tag "None" nil)
871 (const :tag "All" t)
872 (integer :tag "at most")))
874 (defgroup org-agenda-startup nil
875 "Options concerning initial settings in the Agenda in Org Mode."
876 :tag "Org Agenda Startup"
877 :group 'org-agenda)
879 (defcustom org-agenda-menu-show-matcher t
880 "Non-nil means show the match string in the agenda dispatcher menu.
881 When nil, the matcher string is not shown, but is put into the help-echo
882 property so than moving the mouse over the command shows it.
883 Setting it to nil is good if matcher strings are very long and/or if
884 you want to use two-columns display (see `org-agenda-menu-two-columns')."
885 :group 'org-agenda
886 :version "24.1"
887 :type 'boolean)
889 (make-obsolete-variable 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
891 (defcustom org-agenda-menu-two-columns nil
892 "Non-nil means, use two columns to show custom commands in the dispatcher.
893 If you use this, you probably want to set `org-agenda-menu-show-matcher'
894 to nil."
895 :group 'org-agenda
896 :version "24.1"
897 :type 'boolean)
899 (defcustom org-finalize-agenda-hook nil
900 "Hook run just before displaying an agenda buffer."
901 :group 'org-agenda-startup
902 :type 'hook)
904 (defcustom org-agenda-mouse-1-follows-link nil
905 "Non-nil means mouse-1 on a link will follow the link in the agenda.
906 A longer mouse click will still set point. Does not work on XEmacs.
907 Needs to be set before org.el is loaded."
908 :group 'org-agenda-startup
909 :type 'boolean)
911 (defcustom org-agenda-start-with-follow-mode nil
912 "The initial value of follow mode in a newly created agenda window."
913 :group 'org-agenda-startup
914 :type 'boolean)
916 (defcustom org-agenda-follow-indirect nil
917 "Non-nil means `org-agenda-follow-mode' displays only the
918 current item's tree, in an indirect buffer."
919 :group 'org-agenda
920 :version "24.1"
921 :type 'boolean)
923 (defcustom org-agenda-show-outline-path t
924 "Non-nil means show outline path in echo area after line motion."
925 :group 'org-agenda-startup
926 :type 'boolean)
928 (defcustom org-agenda-start-with-entry-text-mode nil
929 "The initial value of entry-text-mode in a newly created agenda window."
930 :group 'org-agenda-startup
931 :type 'boolean)
933 (defcustom org-agenda-entry-text-maxlines 5
934 "Number of text lines to be added when `E' is pressed in the agenda.
936 Note that this variable only used during agenda display. Add add entry text
937 when exporting the agenda, configure the variable
938 `org-agenda-add-entry-ext-maxlines'."
939 :group 'org-agenda
940 :type 'integer)
942 (defcustom org-agenda-entry-text-exclude-regexps nil
943 "List of regular expressions to clean up entry text.
944 The complete matches of all regular expressions in this list will be
945 removed from entry text before it is shown in the agenda."
946 :group 'org-agenda
947 :type '(repeat (regexp)))
949 (defvar org-agenda-entry-text-cleanup-hook nil
950 "Hook that is run after basic cleanup of entry text to be shown in agenda.
951 This cleanup is done in a temporary buffer, so the function may inspect and
952 change the entire buffer.
953 Some default stuff like drawers and scheduling/deadline dates will already
954 have been removed when this is called, as will any matches for regular
955 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
957 (defvar org-agenda-include-inactive-timestamps nil
958 "Non-nil means include inactive time stamps in agenda and timeline.
959 Dynamically scoped.")
961 (defgroup org-agenda-windows nil
962 "Options concerning the windows used by the Agenda in Org Mode."
963 :tag "Org Agenda Windows"
964 :group 'org-agenda)
966 (defcustom org-agenda-window-setup 'reorganize-frame
967 "How the agenda buffer should be displayed.
968 Possible values for this option are:
970 current-window Show agenda in the current window, keeping all other windows.
971 other-window Use `switch-to-buffer-other-window' to display agenda.
972 reorganize-frame Show only two windows on the current frame, the current
973 window and the agenda.
974 other-frame Use `switch-to-buffer-other-frame' to display agenda.
975 Also, when exiting the agenda, kill that frame.
976 See also the variable `org-agenda-restore-windows-after-quit'."
977 :group 'org-agenda-windows
978 :type '(choice
979 (const current-window)
980 (const other-frame)
981 (const other-window)
982 (const reorganize-frame)))
984 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
985 "The min and max height of the agenda window as a fraction of frame height.
986 The value of the variable is a cons cell with two numbers between 0 and 1.
987 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
988 :group 'org-agenda-windows
989 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
991 (defcustom org-agenda-restore-windows-after-quit nil
992 "Non-nil means restore window configuration upon exiting agenda.
993 Before the window configuration is changed for displaying the agenda,
994 the current status is recorded. When the agenda is exited with
995 `q' or `x' and this option is set, the old state is restored. If
996 `org-agenda-window-setup' is `other-frame', the value of this
997 option will be ignored."
998 :group 'org-agenda-windows
999 :type 'boolean)
1001 (defcustom org-agenda-ndays nil
1002 "Number of days to include in overview display.
1003 Should be 1 or 7.
1004 Obsolete, see `org-agenda-span'."
1005 :group 'org-agenda-daily/weekly
1006 :type 'integer)
1008 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1010 (defcustom org-agenda-span 'week
1011 "Number of days to include in overview display.
1012 Can be day, week, month, year, or any number of days.
1013 Custom commands can set this variable in the options section."
1014 :group 'org-agenda-daily/weekly
1015 :type '(choice (const :tag "Day" day)
1016 (const :tag "Week" week)
1017 (const :tag "Month" month)
1018 (const :tag "Year" year)
1019 (integer :tag "Custom")))
1021 (defcustom org-agenda-start-on-weekday 1
1022 "Non-nil means start the overview always on the specified weekday.
1023 0 denotes Sunday, 1 denotes Monday etc.
1024 When nil, always start on the current day.
1025 Custom commands can set this variable in the options section."
1026 :group 'org-agenda-daily/weekly
1027 :type '(choice (const :tag "Today" nil)
1028 (integer :tag "Weekday No.")))
1030 (defcustom org-agenda-show-all-dates t
1031 "Non-nil means `org-agenda' shows every day in the selected range.
1032 When nil, only the days which actually have entries are shown."
1033 :group 'org-agenda-daily/weekly
1034 :type 'boolean)
1036 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1037 "Format string for displaying dates in the agenda.
1038 Used by the daily/weekly agenda and by the timeline. This should be
1039 a format string understood by `format-time-string', or a function returning
1040 the formatted date as a string. The function must take a single argument,
1041 a calendar-style date list like (month day year)."
1042 :group 'org-agenda-daily/weekly
1043 :type '(choice
1044 (string :tag "Format string")
1045 (function :tag "Function")))
1047 (defun org-agenda-format-date-aligned (date)
1048 "Format a date string for display in the daily/weekly agenda, or timeline.
1049 This function makes sure that dates are aligned for easy reading."
1050 (require 'cal-iso)
1051 (let* ((dayname (calendar-day-name date))
1052 (day (cadr date))
1053 (day-of-week (calendar-day-of-week date))
1054 (month (car date))
1055 (monthname (calendar-month-name month))
1056 (year (nth 2 date))
1057 (iso-week (org-days-to-iso-week
1058 (calendar-absolute-from-gregorian date)))
1059 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1060 (1- year))
1061 ((and (= month 12) (<= iso-week 1))
1062 (1+ year))
1063 (t year)))
1064 (weekstring (if (= day-of-week 1)
1065 (format " W%02d" iso-week)
1066 "")))
1067 (format "%-10s %2d %s %4d%s"
1068 dayname day monthname year weekstring)))
1070 (defcustom org-agenda-time-leading-zero nil
1071 "Non-nil means use leading zero for military times in agenda.
1072 For example, 9:30am would become 09:30 rather than 9:30."
1073 :group 'org-agenda-daily/weekly
1074 :version "24.1"
1075 :type 'boolean)
1077 (defcustom org-agenda-timegrid-use-ampm nil
1078 "When set, show AM/PM style timestamps on the timegrid."
1079 :group 'org-agenda
1080 :version "24.1"
1081 :type 'boolean)
1083 (defun org-agenda-time-of-day-to-ampm (time)
1084 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1085 (let* ((hour-number (string-to-number (substring time 0 -3)))
1086 (minute (substring time -2))
1087 (ampm "am"))
1088 (cond
1089 ((equal hour-number 12)
1090 (setq ampm "pm"))
1091 ((> hour-number 12)
1092 (setq ampm "pm")
1093 (setq hour-number (- hour-number 12))))
1094 (concat
1095 (if org-agenda-time-leading-zero
1096 (format "%02d" hour-number)
1097 (format "%02s" (number-to-string hour-number)))
1098 ":" minute ampm)))
1100 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1101 "Conditionally convert TIME to AM/PM format
1102 based on `org-agenda-timegrid-use-ampm'"
1103 (if org-agenda-timegrid-use-ampm
1104 (org-agenda-time-of-day-to-ampm time)
1105 time))
1107 (defcustom org-agenda-weekend-days '(6 0)
1108 "Which days are weekend?
1109 These days get the special face `org-agenda-date-weekend' in the agenda
1110 and timeline buffers."
1111 :group 'org-agenda-daily/weekly
1112 :type '(set :greedy t
1113 (const :tag "Monday" 1)
1114 (const :tag "Tuesday" 2)
1115 (const :tag "Wednesday" 3)
1116 (const :tag "Thursday" 4)
1117 (const :tag "Friday" 5)
1118 (const :tag "Saturday" 6)
1119 (const :tag "Sunday" 0)))
1121 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1122 "Non-nil means jump to today when moving a past date forward in time.
1123 When using S-right in the agenda to move a a date forward, and the date
1124 stamp currently points to the past, the first key press will move it
1125 to today. WHen nil, just move one day forward even if the date stays
1126 in the past."
1127 :group 'org-agenda-daily/weekly
1128 :version "24.1"
1129 :type 'boolean)
1131 (defcustom org-agenda-include-diary nil
1132 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1133 Custom commands can set this variable in the options section."
1134 :group 'org-agenda-daily/weekly
1135 :type 'boolean)
1137 (defcustom org-agenda-include-deadlines t
1138 "If non-nil, include entries within their deadline warning period.
1139 Custom commands can set this variable in the options section."
1140 :group 'org-agenda-daily/weekly
1141 :version "24.1"
1142 :type 'boolean)
1144 (defcustom org-agenda-repeating-timestamp-show-all t
1145 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1146 When set to a list of strings, only show occurrences of repeating
1147 stamps for these TODO keywords. When nil, only one occurrence is
1148 shown, either today or the nearest into the future."
1149 :group 'org-agenda-daily/weekly
1150 :type '(choice
1151 (const :tag "Show repeating stamps" t)
1152 (repeat :tag "Show repeating stamps for these TODO keywords"
1153 (string :tag "TODO Keyword"))
1154 (const :tag "Don't show repeating stamps" nil)))
1156 (defcustom org-scheduled-past-days 10000
1157 "No. of days to continue listing scheduled items that are not marked DONE.
1158 When an item is scheduled on a date, it shows up in the agenda on this
1159 day and will be listed until it is marked done for the number of days
1160 given here."
1161 :group 'org-agenda-daily/weekly
1162 :type 'integer)
1164 (defcustom org-agenda-log-mode-items '(closed clock)
1165 "List of items that should be shown in agenda log mode.
1166 This list may contain the following symbols:
1168 closed Show entries that have been closed on that day.
1169 clock Show entries that have received clocked time on that day.
1170 state Show all logged state changes.
1171 Note that instead of changing this variable, you can also press `C-u l' in
1172 the agenda to display all available LOG items temporarily."
1173 :group 'org-agenda-daily/weekly
1174 :type '(set :greedy t (const closed) (const clock) (const state)))
1176 (defcustom org-agenda-clock-consistency-checks
1177 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1178 :gap-ok-around ("4:00")
1179 :default-face ((:background "DarkRed") (:foreground "white"))
1180 :overlap-face nil :gap-face nil :no-end-time-face nil
1181 :long-face nil :short-face nil)
1182 "This is a property list, with the following keys:
1184 :max-duration Mark clocking chunks that are longer than this time.
1185 This is a time string like \"HH:MM\", or the number
1186 of minutes as an integer.
1188 :min-duration Mark clocking chunks that are shorter that this.
1189 This is a time string like \"HH:MM\", or the number
1190 of minutes as an integer.
1192 :max-gap Mark gaps between clocking chunks that are longer than
1193 this duration. A number of minutes, or a string
1194 like \"HH:MM\".
1196 :gap-ok-around List of times during the day which are usually not working
1197 times. When a gap is detected, but the gap contains any
1198 of these times, the gap is *not* reported. For example,
1199 if this is (\"4:00\" \"13:00\") then gaps that contain
1200 4:00 in the morning (i.e. the night) and 13:00
1201 (i.e. a typical lunch time) do not cause a warning.
1202 You should have at least one time during the night in this
1203 list, or otherwise the first task each morning will trigger
1204 a warning because it follows a long gap.
1206 Furthermore, the following properties can be used to define faces for
1207 issue display.
1209 :default-face the default face, if the specific face is undefined
1210 :overlap-face face for overlapping clocks
1211 :gap-face face for gaps between clocks
1212 :no-end-time-face face for incomplete clocks
1213 :long-face face for clock intervals that are too long
1214 :short-face face for clock intervals that are too short"
1215 :group 'org-agenda-daily/weekly
1216 :group 'org-clock
1217 :version "24.1"
1218 :type 'plist)
1220 (defcustom org-agenda-log-mode-add-notes t
1221 "Non-nil means add first line of notes to log entries in agenda views.
1222 If a log item like a state change or a clock entry is associated with
1223 notes, the first line of these notes will be added to the entry in the
1224 agenda display."
1225 :group 'org-agenda-daily/weekly
1226 :type 'boolean)
1228 (defcustom org-agenda-start-with-log-mode nil
1229 "The initial value of log-mode in a newly created agenda window.
1230 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1231 explanations on the possible values."
1232 :group 'org-agenda-startup
1233 :group 'org-agenda-daily/weekly
1234 :type '(choice (const :tag "Don't show log items" nil)
1235 (const :tag "Show only log items" 'only)
1236 (const :tag "Show all possible log items" 'clockcheck)
1237 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1238 (choice (const :tag "Show closed log items" 'closed)
1239 (const :tag "Show clocked log items" 'clock)
1240 (const :tag "Show all logged state changes" 'state)))))
1242 (defcustom org-agenda-start-with-clockreport-mode nil
1243 "The initial value of clockreport-mode in a newly created agenda window."
1244 :group 'org-agenda-startup
1245 :group 'org-agenda-daily/weekly
1246 :type 'boolean)
1248 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1249 "Property list with parameters for the clocktable in clockreport mode.
1250 This is the display mode that shows a clock table in the daily/weekly
1251 agenda, the properties for this dynamic block can be set here.
1252 The usual clocktable parameters are allowed here, but you cannot set
1253 the properties :name, :tstart, :tend, :block, and :scope - these will
1254 be overwritten to make sure the content accurately reflects the
1255 current display in the agenda."
1256 :group 'org-agenda-daily/weekly
1257 :type 'plist)
1259 (defcustom org-agenda-search-view-always-boolean nil
1260 "Non-nil means the search string is interpreted as individual parts.
1262 The search string for search view can either be interpreted as a phrase,
1263 or as a list of snippets that define a boolean search for a number of
1264 strings.
1266 When this is non-nil, the string will be split on whitespace, and each
1267 snippet will be searched individually, and all must match in order to
1268 select an entry. A snippet is then a single string of non-white
1269 characters, or a string in double quotes, or a regexp in {} braces.
1270 If a snippet is preceded by \"-\", the snippet must *not* match.
1271 \"+\" is syntactic sugar for positive selection. Each snippet may
1272 be found as a full word or a partial word, but see the variable
1273 `org-agenda-search-view-force-full-words'.
1275 When this is nil, search will look for the entire search phrase as one,
1276 with each space character matching any amount of whitespace, including
1277 line breaks.
1279 Even when this is nil, you can still switch to Boolean search dynamically
1280 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1281 is a regexp marked with braces like \"{abc}\", this will also switch to
1282 boolean search."
1283 :group 'org-agenda-search-view
1284 :version "24.1"
1285 :type 'boolean)
1287 (if (fboundp 'defvaralias)
1288 (defvaralias 'org-agenda-search-view-search-words-only
1289 'org-agenda-search-view-always-boolean))
1291 (defcustom org-agenda-search-view-force-full-words nil
1292 "Non-nil means, search words must be matches as complete words.
1293 When nil, they may also match part of a word."
1294 :group 'org-agenda-search-view
1295 :version "24.1"
1296 :type 'boolean)
1298 (defgroup org-agenda-time-grid nil
1299 "Options concerning the time grid in the Org-mode Agenda."
1300 :tag "Org Agenda Time Grid"
1301 :group 'org-agenda)
1303 (defcustom org-agenda-search-headline-for-time t
1304 "Non-nil means search headline for a time-of-day.
1305 If the headline contains a time-of-day in one format or another, it will
1306 be used to sort the entry into the time sequence of items for a day.
1307 Some people have time stamps in the headline that refer to the creation
1308 time or so, and then this produces an unwanted side effect. If this is
1309 the case for your, use this variable to turn off searching the headline
1310 for a time."
1311 :group 'org-agenda-time-grid
1312 :type 'boolean)
1314 (defcustom org-agenda-use-time-grid t
1315 "Non-nil means show a time grid in the agenda schedule.
1316 A time grid is a set of lines for specific times (like every two hours between
1317 8:00 and 20:00). The items scheduled for a day at specific times are
1318 sorted in between these lines.
1319 For details about when the grid will be shown, and what it will look like, see
1320 the variable `org-agenda-time-grid'."
1321 :group 'org-agenda-time-grid
1322 :type 'boolean)
1324 (defcustom org-agenda-time-grid
1325 '((daily today require-timed)
1326 "----------------"
1327 (800 1000 1200 1400 1600 1800 2000))
1329 "The settings for time grid for agenda display.
1330 This is a list of three items. The first item is again a list. It contains
1331 symbols specifying conditions when the grid should be displayed:
1333 daily if the agenda shows a single day
1334 weekly if the agenda shows an entire week
1335 today show grid on current date, independent of daily/weekly display
1336 require-timed show grid only if at least one item has a time specification
1338 The second item is a string which will be placed behind the grid time.
1340 The third item is a list of integers, indicating the times that should have
1341 a grid line."
1342 :group 'org-agenda-time-grid
1343 :type
1344 '(list
1345 (set :greedy t :tag "Grid Display Options"
1346 (const :tag "Show grid in single day agenda display" daily)
1347 (const :tag "Show grid in weekly agenda display" weekly)
1348 (const :tag "Always show grid for today" today)
1349 (const :tag "Show grid only if any timed entries are present"
1350 require-timed)
1351 (const :tag "Skip grid times already present in an entry"
1352 remove-match))
1353 (string :tag "Grid String")
1354 (repeat :tag "Grid Times" (integer :tag "Time"))))
1356 (defcustom org-agenda-show-current-time-in-grid t
1357 "Non-nil means show the current time in the time grid."
1358 :group 'org-agenda-time-grid
1359 :version "24.1"
1360 :type 'boolean)
1362 (defcustom org-agenda-current-time-string
1363 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1364 "The string for the current time marker in the agenda."
1365 :group 'org-agenda-time-grid
1366 :version "24.1"
1367 :type 'string)
1369 (defgroup org-agenda-sorting nil
1370 "Options concerning sorting in the Org-mode Agenda."
1371 :tag "Org Agenda Sorting"
1372 :group 'org-agenda)
1374 (defcustom org-agenda-sorting-strategy
1375 '((agenda habit-down time-up priority-down category-keep)
1376 (todo priority-down category-keep)
1377 (tags priority-down category-keep)
1378 (search category-keep))
1379 "Sorting structure for the agenda items of a single day.
1380 This is a list of symbols which will be used in sequence to determine
1381 if an entry should be listed before another entry. The following
1382 symbols are recognized:
1384 time-up Put entries with time-of-day indications first, early first
1385 time-down Put entries with time-of-day indications first, late first
1386 category-keep Keep the default order of categories, corresponding to the
1387 sequence in `org-agenda-files'.
1388 category-up Sort alphabetically by category, A-Z.
1389 category-down Sort alphabetically by category, Z-A.
1390 tag-up Sort alphabetically by last tag, A-Z.
1391 tag-down Sort alphabetically by last tag, Z-A.
1392 priority-up Sort numerically by priority, high priority last.
1393 priority-down Sort numerically by priority, high priority first.
1394 todo-state-up Sort by todo state, tasks that are done last.
1395 todo-state-down Sort by todo state, tasks that are done first.
1396 effort-up Sort numerically by estimated effort, high effort last.
1397 effort-down Sort numerically by estimated effort, high effort first.
1398 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1399 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1400 habit-up Put entries that are habits first
1401 habit-down Put entries that are habits last
1402 alpha-up Sort headlines alphabetically
1403 alpha-down Sort headlines alphabetically, reversed
1405 The different possibilities will be tried in sequence, and testing stops
1406 if one comparison returns a \"not-equal\". For example, the default
1407 '(time-up category-keep priority-down)
1408 means: Pull out all entries having a specified time of day and sort them,
1409 in order to make a time schedule for the current day the first thing in the
1410 agenda listing for the day. Of the entries without a time indication, keep
1411 the grouped in categories, don't sort the categories, but keep them in
1412 the sequence given in `org-agenda-files'. Within each category sort by
1413 priority.
1415 Leaving out `category-keep' would mean that items will be sorted across
1416 categories by priority.
1418 Instead of a single list, this can also be a set of list for specific
1419 contents, with a context symbol in the car of the list, any of
1420 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1422 Custom commands can bind this variable in the options section."
1423 :group 'org-agenda-sorting
1424 :type `(choice
1425 (repeat :tag "General" ,org-sorting-choice)
1426 (list :tag "Individually"
1427 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1428 (repeat ,org-sorting-choice))
1429 (cons (const :tag "Strategy for TODO lists" todo)
1430 (repeat ,org-sorting-choice))
1431 (cons (const :tag "Strategy for Tags matches" tags)
1432 (repeat ,org-sorting-choice))
1433 (cons (const :tag "Strategy for search matches" search)
1434 (repeat ,org-sorting-choice)))))
1436 (defcustom org-agenda-cmp-user-defined nil
1437 "A function to define the comparison `user-defined'.
1438 This function must receive two arguments, agenda entry a and b.
1439 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1440 the user comparison, return nil.
1441 When this is defined, you can make `user-defined-up' and `user-defined-down'
1442 part of an agenda sorting strategy."
1443 :group 'org-agenda-sorting
1444 :type 'symbol)
1446 (defcustom org-sort-agenda-notime-is-late t
1447 "Non-nil means items without time are considered late.
1448 This is only relevant for sorting. When t, items which have no explicit
1449 time like 15:30 will be considered as 99:01, i.e. later than any items which
1450 do have a time. When nil, the default time is before 0:00. You can use this
1451 option to decide if the schedule for today should come before or after timeless
1452 agenda entries."
1453 :group 'org-agenda-sorting
1454 :type 'boolean)
1456 (defcustom org-sort-agenda-noeffort-is-high t
1457 "Non-nil means items without effort estimate are sorted as high effort.
1458 This also applies when filtering an agenda view with respect to the
1459 < or > effort operator. Then, tasks with no effort defined will be treated
1460 as tasks with high effort.
1461 When nil, such items are sorted as 0 minutes effort."
1462 :group 'org-agenda-sorting
1463 :type 'boolean)
1465 (defgroup org-agenda-line-format nil
1466 "Options concerning the entry prefix in the Org-mode agenda display."
1467 :tag "Org Agenda Line Format"
1468 :group 'org-agenda)
1470 (defcustom org-agenda-prefix-format
1471 '((agenda . " %i %-12:c%?-12t% s")
1472 (timeline . " % s")
1473 (todo . " %i %-12:c")
1474 (tags . " %i %-12:c")
1475 (search . " %i %-12:c"))
1476 "Format specifications for the prefix of items in the agenda views.
1477 An alist with five entries, each for the different agenda types. The
1478 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1479 The values are format strings.
1481 This format works similar to a printf format, with the following meaning:
1483 %c the category of the item, \"Diary\" for entries from the diary,
1484 or as given by the CATEGORY keyword or derived from the file name
1485 %e the effort required by the item
1486 %i the icon category of the item, see `org-agenda-category-icon-alist'
1487 %T the last tag of the item (ignore inherited tags, which come first)
1488 %t the HH:MM time-of-day specification if one applies to the entry
1489 %s Scheduling/Deadline information, a short string
1490 %(expression) Eval EXPRESSION and replace the control string
1491 by the result
1493 All specifiers work basically like the standard `%s' of printf, but may
1494 contain two additional characters: a question mark just after the `%'
1495 and a whitespace/punctuation character just before the final letter.
1497 If the first character after `%' is a question mark, the entire field
1498 will only be included if the corresponding value applies to the current
1499 entry. This is useful for fields which should have fixed width when
1500 present, but zero width when absent. For example, \"%?-12t\" will
1501 result in a 12 character time field if a time of the day is specified,
1502 but will completely disappear in entries which do not contain a time.
1504 If there is punctuation or whitespace character just before the final
1505 format letter, this character will be appended to the field value if
1506 the value is not empty. For example, the format \"%-12:c\" leads to
1507 \"Diary: \" if the category is \"Diary\". If the category were be
1508 empty, no additional colon would be inserted.
1510 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1511 which means:
1513 - Indent the line with two space characters
1514 - Give the category a 12 chars wide field, padded with whitespace on
1515 the right (because of `-'). Append a colon if there is a category
1516 (because of `:').
1517 - If there is a time-of-day, put it into a 12 chars wide field. If no
1518 time, don't put in an empty field, just skip it (because of '?').
1519 - Finally, put the scheduling information.
1521 See also the variables `org-agenda-remove-times-when-in-prefix' and
1522 `org-agenda-remove-tags'.
1524 Custom commands can set this variable in the options section."
1525 :type '(choice
1526 (string :tag "General format")
1527 (list :greedy t :tag "View dependent"
1528 (cons (const agenda) (string :tag "Format"))
1529 (cons (const timeline) (string :tag "Format"))
1530 (cons (const todo) (string :tag "Format"))
1531 (cons (const tags) (string :tag "Format"))
1532 (cons (const search) (string :tag "Format"))))
1533 :group 'org-agenda-line-format)
1535 (defvar org-prefix-format-compiled nil
1536 "The compiled prefix format and associated variables.
1537 This is a list where first element is a list of variable bindings, and second
1538 element is the compiled format expression. See the variable
1539 `org-agenda-prefix-format'.")
1541 (defcustom org-agenda-todo-keyword-format "%-1s"
1542 "Format for the TODO keyword in agenda lines.
1543 Set this to something like \"%-12s\" if you want all TODO keywords
1544 to occupy a fixed space in the agenda display."
1545 :group 'org-agenda-line-format
1546 :type 'string)
1548 (defcustom org-agenda-diary-sexp-prefix nil
1549 "A regexp that matches part of a diary sexp entry
1550 which should be treated as scheduling/deadline information in
1551 `org-agenda'.
1553 For example, you can use this to extract the `diary-remind-message' from
1554 `diary-remind' entries."
1555 :group 'org-agenda-line-format
1556 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1558 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1559 "Text preceding timerange entries in the agenda view.
1560 This is a list with two strings. The first applies when the range
1561 is entirely on one day. The second applies if the range spans several days.
1562 The strings may have two \"%d\" format specifiers which will be filled
1563 with the sequence number of the days, and the total number of days in the
1564 range, respectively."
1565 :group 'org-agenda-line-format
1566 :type '(list
1567 (string :tag "Deadline today ")
1568 (choice :tag "Deadline relative"
1569 (string :tag "Format string")
1570 (function))))
1572 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1573 "Text preceding scheduled items in the agenda view.
1574 This is a list with two strings. The first applies when the item is
1575 scheduled on the current day. The second applies when it has been scheduled
1576 previously, it may contain a %d indicating that this is the nth time that
1577 this item is scheduled, due to automatic rescheduling of unfinished items
1578 for the following day. So this number is one larger than the number of days
1579 that passed since this item was scheduled first."
1580 :group 'org-agenda-line-format
1581 :type '(list
1582 (string :tag "Scheduled today ")
1583 (string :tag "Scheduled previously")))
1585 (defcustom org-agenda-inactive-leader "["
1586 "Text preceding item pulled into the agenda by inactive time stamps.
1587 These entries are added to the agenda when pressing \"[\"."
1588 :group 'org-agenda-line-format
1589 :version "24.1"
1590 :type '(list
1591 (string :tag "Scheduled today ")
1592 (string :tag "Scheduled previously")))
1594 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
1595 "Text preceding deadline items in the agenda view.
1596 This is a list with two strings. The first applies when the item has its
1597 deadline on the current day. The second applies when it is in the past or
1598 in the future, it may contain %d to capture how many days away the deadline
1599 is (was)."
1600 :group 'org-agenda-line-format
1601 :type '(list
1602 (string :tag "Deadline today ")
1603 (choice :tag "Deadline relative"
1604 (string :tag "Format string")
1605 (function))))
1607 (defcustom org-agenda-remove-times-when-in-prefix t
1608 "Non-nil means remove duplicate time specifications in agenda items.
1609 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1610 time-of-day specification in a headline or diary entry is extracted and
1611 placed into the prefix. If this option is non-nil, the original specification
1612 \(a timestamp or -range, or just a plain time(range) specification like
1613 11:30-4pm) will be removed for agenda display. This makes the agenda less
1614 cluttered.
1615 The option can be t or nil. It may also be the symbol `beg', indicating
1616 that the time should only be removed when it is located at the beginning of
1617 the headline/diary entry."
1618 :group 'org-agenda-line-format
1619 :type '(choice
1620 (const :tag "Always" t)
1621 (const :tag "Never" nil)
1622 (const :tag "When at beginning of entry" beg)))
1624 (defcustom org-agenda-remove-timeranges-from-blocks nil
1625 "Non-nil means remove time ranges specifications in agenda
1626 items that span on several days."
1627 :group 'org-agenda-line-format
1628 :version "24.1"
1629 :type 'boolean)
1631 (defcustom org-agenda-default-appointment-duration nil
1632 "Default duration for appointments that only have a starting time.
1633 When nil, no duration is specified in such cases.
1634 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1635 :group 'org-agenda-line-format
1636 :type '(choice
1637 (integer :tag "Minutes")
1638 (const :tag "No default duration")))
1640 (defcustom org-agenda-show-inherited-tags t
1641 "Non-nil means show inherited tags in each agenda line."
1642 :group 'org-agenda-line-format
1643 :type 'boolean)
1645 (defcustom org-agenda-hide-tags-regexp nil
1646 "Regular expression used to filter away specific tags in agenda views.
1647 This means that these tags will be present, but not be shown in the agenda
1648 line. Secondary filtering will still work on the hidden tags.
1649 Nil means don't hide any tags."
1650 :group 'org-agenda-line-format
1651 :type '(choice
1652 (const :tag "Hide none" nil)
1653 (string :tag "Regexp ")))
1655 (defcustom org-agenda-remove-tags nil
1656 "Non-nil means remove the tags from the headline copy in the agenda.
1657 When this is the symbol `prefix', only remove tags when
1658 `org-agenda-prefix-format' contains a `%T' specifier."
1659 :group 'org-agenda-line-format
1660 :type '(choice
1661 (const :tag "Always" t)
1662 (const :tag "Never" nil)
1663 (const :tag "When prefix format contains %T" prefix)))
1665 (if (fboundp 'defvaralias)
1666 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1667 'org-agenda-remove-tags))
1669 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1670 "Shift tags in agenda items to this column.
1671 If this number is positive, it specifies the column. If it is negative,
1672 it means that the tags should be flushright to that column. For example,
1673 -80 works well for a normal 80 character screen."
1674 :group 'org-agenda-line-format
1675 :type 'integer)
1677 (if (fboundp 'defvaralias)
1678 (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1680 (defcustom org-agenda-fontify-priorities 'cookies
1681 "Non-nil means highlight low and high priorities in agenda.
1682 When t, the highest priority entries are bold, lowest priority italic.
1683 However, settings in `org-priority-faces' will overrule these faces.
1684 When this variable is the symbol `cookies', only fontify the
1685 cookies, not the entire task.
1686 This may also be an association list of priority faces, whose
1687 keys are the character values of `org-highest-priority',
1688 `org-default-priority', and `org-lowest-priority' (the default values
1689 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1690 color as a string, or a list like `(:background \"Red\")'.
1691 If it is a color, the variable `org-faces-easy-properties'
1692 determines if it is a foreground or a background color."
1693 :group 'org-agenda-line-format
1694 :type '(choice
1695 (const :tag "Never" nil)
1696 (const :tag "Defaults" t)
1697 (const :tag "Cookies only" cookies)
1698 (repeat :tag "Specify"
1699 (list (character :tag "Priority" :value ?A)
1700 (choice :tag "Face "
1701 (string :tag "Color")
1702 (sexp :tag "Face"))))))
1704 (defcustom org-agenda-day-face-function nil
1705 "Function called to determine what face should be used to display a day.
1706 The only argument passed to that function is the day. It should
1707 returns a face, or nil if does not want to specify a face and let
1708 the normal rules apply."
1709 :group 'org-agenda-line-format
1710 :version "24.1"
1711 :type 'function)
1713 (defcustom org-agenda-category-icon-alist nil
1714 "Alist of category icon to be displayed in agenda views.
1716 Each entry should have the following format:
1718 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1720 Where CATEGORY-REGEXP is a regexp matching the categories where
1721 the icon should be displayed.
1722 FILE-OR-DATA either a file path or a string containing image data.
1724 The other fields can be omitted safely if not needed:
1725 TYPE indicates the image type.
1726 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1727 image data.
1728 PROPS are additional image attributes to assign to the image,
1729 like, e.g. `:ascent center'.
1731 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1733 If you want to set the display properties yourself, just put a
1734 list as second element:
1736 (CATEGORY-REGEXP (MY PROPERTY LIST))
1738 For example, to display a 16px horizontal space for Emacs
1739 category, you can use:
1741 (\"Emacs\" '(space . (:width (16))))"
1742 :group 'org-agenda-line-format
1743 :version "24.1"
1744 :type '(alist :key-type (string :tag "Regexp matching category")
1745 :value-type (choice (list :tag "Icon"
1746 (string :tag "File or data")
1747 (symbol :tag "Type")
1748 (boolean :tag "Data?")
1749 (repeat :tag "Extra image properties" :inline t symbol))
1750 (list :tag "Display properties" sexp))))
1752 (defgroup org-agenda-column-view nil
1753 "Options concerning column view in the agenda."
1754 :tag "Org Agenda Column View"
1755 :group 'org-agenda)
1757 (defcustom org-agenda-columns-show-summaries t
1758 "Non-nil means show summaries for columns displayed in the agenda view."
1759 :group 'org-agenda-column-view
1760 :type 'boolean)
1762 (defcustom org-agenda-columns-compute-summary-properties t
1763 "Non-nil means recompute all summary properties before column view.
1764 When column view in the agenda is listing properties that have a summary
1765 operator, it can go to all relevant buffers and recompute the summaries
1766 there. This can mean overhead for the agenda column view, but is necessary
1767 to have thing up to date.
1768 As a special case, a CLOCKSUM property also makes sure that the clock
1769 computations are current."
1770 :group 'org-agenda-column-view
1771 :type 'boolean)
1773 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1774 "Non-nil means the duration of an appointment will add to day effort.
1775 The property to which appointment durations will be added is the one given
1776 in the option `org-effort-property'. If an appointment does not have
1777 an end time, `org-agenda-default-appointment-duration' will be used. If that
1778 is not set, an appointment without end time will not contribute to the time
1779 estimate."
1780 :group 'org-agenda-column-view
1781 :type 'boolean)
1783 (defcustom org-agenda-auto-exclude-function nil
1784 "A function called with a tag to decide if it is filtered on '/ RET'.
1785 The sole argument to the function, which is called once for each
1786 possible tag, is a string giving the name of the tag. The
1787 function should return either nil if the tag should be included
1788 as normal, or \"-<TAG>\" to exclude the tag.
1789 Note that for the purpose of tag filtering, only the lower-case version of
1790 all tags will be considered, so that this function will only ever see
1791 the lower-case version of all tags."
1792 :group 'org-agenda
1793 :type 'function)
1795 (defcustom org-agenda-bulk-custom-functions nil
1796 "Alist of characters and custom functions for bulk actions.
1797 For example, this value makes those two functions available:
1799 '((?R set-category)
1800 (?C bulk-cut))
1802 With selected entries in an agenda buffer, `B R' will call
1803 the custom function `set-category' on the selected entries.
1804 Note that functions in this alist don't need to be quoted."
1805 :type 'alist
1806 :version "24.1"
1807 :group 'org-agenda)
1809 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1810 "Execute BODY with point at location given by `org-hd-marker' property.
1811 If STRING is non-nil, the text property will be fetched from position 0
1812 in that string. If STRING is nil, it will be fetched from the beginning
1813 of the current line."
1814 (org-with-gensyms (marker)
1815 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1816 'org-hd-marker ,string)))
1817 (with-current-buffer (marker-buffer ,marker)
1818 (save-excursion
1819 (goto-char ,marker)
1820 ,@body)))))
1821 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1823 (defun org-add-agenda-custom-command (entry)
1824 "Replace or add a command in `org-agenda-custom-commands'.
1825 This is mostly for hacking and trying a new command - once the command
1826 works you probably want to add it to `org-agenda-custom-commands' for good."
1827 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1828 (if ass
1829 (setcdr ass (cdr entry))
1830 (push entry org-agenda-custom-commands))))
1832 ;;; Define the org-agenda-mode
1834 (defvar org-agenda-mode-map (make-sparse-keymap)
1835 "Keymap for `org-agenda-mode'.")
1836 (if (fboundp 'defvaralias)
1837 (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1839 (defvar org-agenda-menu) ; defined later in this file.
1840 (defvar org-agenda-restrict) ; defined later in this file.
1841 (defvar org-agenda-follow-mode nil)
1842 (defvar org-agenda-entry-text-mode nil)
1843 (defvar org-agenda-clockreport-mode nil)
1844 (defvar org-agenda-show-log nil)
1845 (defvar org-agenda-redo-command nil)
1846 (defvar org-agenda-query-string nil)
1847 (defvar org-agenda-mode-hook nil
1848 "Hook for `org-agenda-mode', run after the mode is turned on.")
1849 (defvar org-agenda-type nil)
1850 (defvar org-agenda-force-single-file nil)
1851 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1854 ;;; Multiple agenda buffers support
1856 (defcustom org-agenda-sticky nil
1857 "Non-nil means agenda q key will bury agenda buffers.
1858 Agenda commands will then show existing buffer instead of generating new ones.
1859 When nil, `q' will kill the single agenda buffer."
1860 :group 'org-agenda
1861 :type 'boolean
1862 :set (lambda (var val)
1863 (if (boundp var)
1864 (org-toggle-sticky-agenda (if val 1 0))
1865 (set var val))))
1867 (defun org-toggle-sticky-agenda (&optional arg)
1868 "Toggle `org-agenda-sticky'."
1869 (interactive "P")
1870 (let ((new-value (if arg
1871 (> (prefix-numeric-value arg) 0)
1872 (not org-agenda-sticky))))
1873 (if (equal new-value org-agenda-sticky)
1874 (and (org-called-interactively-p 'interactive)
1875 (message "Sticky agenda was already %s"
1876 (if org-agenda-sticky "enabled" "disabled")))
1877 (setq org-agenda-sticky new-value)
1878 (org-agenda-kill-all-agenda-buffers)
1879 (and (org-called-interactively-p 'interactive)
1880 (message "Sticky agenda was %s"
1881 (if org-agenda-sticky "enabled" "disabled"))))))
1883 (defvar org-agenda-buffer nil
1884 "Agenda buffer currently being generated.")
1886 (defvar org-agenda-last-prefix-arg nil)
1887 (defvar org-agenda-this-buffer-name nil)
1888 (defvar org-agenda-doing-sticky-redo nil)
1889 (defvar org-agenda-this-buffer-is-sticky nil)
1891 (defconst org-agenda-local-vars
1892 '(org-agenda-this-buffer-name
1893 org-agenda-undo-list
1894 org-agenda-pending-undo-list
1895 org-agenda-follow-mode
1896 org-agenda-entry-text-mode
1897 org-agenda-clockreport-mode
1898 org-agenda-show-log
1899 org-agenda-redo-command
1900 org-agenda-query-string
1901 org-agenda-type
1902 org-agenda-bulk-marked-entries
1903 org-agenda-undo-has-started-in
1904 org-agenda-last-arguments
1905 org-agenda-info
1906 org-agenda-tag-filter-overlays
1907 org-agenda-cat-filter-overlays
1908 org-pre-agenda-window-conf
1909 org-agenda-columns-active
1910 org-agenda-tag-filter
1911 org-agenda-category-filter
1912 org-agenda-markers
1913 org-agenda-last-search-view-search-was-boolean
1914 org-agenda-filtered-by-category
1915 org-agenda-filter-form
1916 org-agenda-show-window
1917 org-agenda-cycle-counter
1918 org-agenda-last-prefix-arg)
1919 "Variables that must be local in agenda buffers to allow multiple buffers.")
1921 (defun org-agenda-mode ()
1922 "Mode for time-sorted view on action items in Org-mode files.
1924 The following commands are available:
1926 \\{org-agenda-mode-map}"
1927 (interactive)
1928 (cond (org-agenda-doing-sticky-redo
1929 ;; Refreshing sticky agenda-buffer
1931 ;; Preserve the value of `org-agenda-local-vars' variables,
1932 ;; while letting `kill-all-local-variables' kill the rest
1933 (let ((save (buffer-local-variables)))
1934 (kill-all-local-variables)
1935 (mapc 'make-local-variable org-agenda-local-vars)
1936 (dolist (elem save)
1937 (let ((var (car elem))
1938 (val (cdr elem)))
1939 (when (and val
1940 (member var org-agenda-local-vars))
1941 (set var val)))))
1942 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1943 (org-agenda-sticky
1944 ;; Creating a sticky Agenda buffer for the first time
1945 (kill-all-local-variables)
1946 (mapc 'make-local-variable org-agenda-local-vars)
1947 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1949 ;; Creating a non-sticky agenda buffer
1950 (kill-all-local-variables)
1951 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
1952 (setq org-agenda-undo-list nil
1953 org-agenda-pending-undo-list nil
1954 org-agenda-bulk-marked-entries nil)
1955 (setq major-mode 'org-agenda-mode)
1956 ;; Keep global-font-lock-mode from turning on font-lock-mode
1957 (org-set-local 'font-lock-global-modes (list 'not major-mode))
1958 (setq mode-name "Org-Agenda")
1959 (use-local-map org-agenda-mode-map)
1960 (easy-menu-add org-agenda-menu)
1961 (if org-startup-truncated (setq truncate-lines t))
1962 (org-set-local 'line-move-visual nil)
1963 (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1964 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1965 ;; Make sure properties are removed when copying text
1966 (make-local-variable 'filter-buffer-substring-functions)
1967 (add-hook 'filter-buffer-substring-functions
1968 (lambda (fun start end delete)
1969 (substring-no-properties (funcall fun start end delete))))
1970 (unless org-agenda-keep-modes
1971 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1972 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1973 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1974 org-agenda-show-log org-agenda-start-with-log-mode))
1976 (easy-menu-change
1977 '("Agenda") "Agenda Files"
1978 (append
1979 (list
1980 (vector
1981 (if (get 'org-agenda-files 'org-restrict)
1982 "Restricted to single file"
1983 "Edit File List")
1984 '(org-edit-agenda-file-list)
1985 (not (get 'org-agenda-files 'org-restrict)))
1986 "--")
1987 (mapcar 'org-file-menu-entry (org-agenda-files))))
1988 (org-agenda-set-mode-name)
1989 (apply
1990 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1991 (list 'org-agenda-mode-hook)))
1993 (substitute-key-definition 'undo 'org-agenda-undo
1994 org-agenda-mode-map global-map)
1995 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
1996 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
1997 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
1998 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
1999 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2000 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2001 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2002 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2003 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2004 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2005 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2006 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2007 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2008 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2009 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2010 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2011 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2012 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2013 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2014 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2015 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2016 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2017 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2018 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2019 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2020 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2021 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2022 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2023 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2024 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2025 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2026 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2027 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2028 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2029 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2030 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2031 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2032 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2033 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2034 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2035 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
2036 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
2037 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2038 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2039 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2040 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2042 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2043 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2044 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2045 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2046 (while l (org-defkey org-agenda-mode-map
2047 (int-to-string (pop l)) 'digit-argument)))
2049 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2050 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2051 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2052 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2053 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2054 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2055 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2056 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2057 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2058 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
2059 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2060 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2061 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2062 'org-clock-modify-effort-estimate)
2063 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2064 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2065 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2066 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2067 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2068 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2069 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2070 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2071 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2072 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2073 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2074 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2075 (substitute-key-definition 'next-line 'org-agenda-next-line
2076 org-agenda-mode-map global-map)
2077 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2078 org-agenda-mode-map global-map)
2079 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2080 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2081 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2082 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2083 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-show-priority)
2084 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2085 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2086 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2087 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2088 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2089 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2090 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2091 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2092 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2093 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2094 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2095 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2096 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2097 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2098 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2099 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2100 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2101 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2102 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2103 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2104 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2105 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2106 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2107 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2108 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2110 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2111 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2112 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2113 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2114 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2115 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2116 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2117 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
2118 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2119 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2120 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2121 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2123 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2124 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2125 (when org-agenda-mouse-1-follows-link
2126 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2127 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2128 '("Agenda"
2129 ("Agenda Files")
2130 "--"
2131 ("Agenda Dates"
2132 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2133 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2134 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2135 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2136 "--"
2137 ("View"
2138 ["Day View" org-agenda-day-view
2139 :active (org-agenda-check-type nil 'agenda)
2140 :style radio :selected (eq org-agenda-current-span 'day)
2141 :keys "v d (or just d)"]
2142 ["Week View" org-agenda-week-view
2143 :active (org-agenda-check-type nil 'agenda)
2144 :style radio :selected (eq org-agenda-current-span 'week)
2145 :keys "v w (or just w)"]
2146 ["Month View" org-agenda-month-view
2147 :active (org-agenda-check-type nil 'agenda)
2148 :style radio :selected (eq org-agenda-current-span 'month)
2149 :keys "v m"]
2150 ["Year View" org-agenda-year-view
2151 :active (org-agenda-check-type nil 'agenda)
2152 :style radio :selected (eq org-agenda-current-span 'year)
2153 :keys "v y"]
2154 "--"
2155 ["Include Diary" org-agenda-toggle-diary
2156 :style toggle :selected org-agenda-include-diary
2157 :active (org-agenda-check-type nil 'agenda)]
2158 ["Include Deadlines" org-agenda-toggle-deadlines
2159 :style toggle :selected org-agenda-include-deadlines
2160 :active (org-agenda-check-type nil 'agenda)]
2161 ["Use Time Grid" org-agenda-toggle-time-grid
2162 :style toggle :selected org-agenda-use-time-grid
2163 :active (org-agenda-check-type nil 'agenda)]
2164 "--"
2165 ["Show clock report" org-agenda-clockreport-mode
2166 :style toggle :selected org-agenda-clockreport-mode
2167 :active (org-agenda-check-type nil 'agenda)]
2168 ["Show some entry text" org-agenda-entry-text-mode
2169 :style toggle :selected org-agenda-entry-text-mode
2170 :active t]
2171 "--"
2172 ["Show Logbook entries" org-agenda-log-mode
2173 :style toggle :selected org-agenda-show-log
2174 :active (org-agenda-check-type nil 'agenda 'timeline)
2175 :keys "v l (or just l)"]
2176 ["Include archived trees" org-agenda-archives-mode
2177 :style toggle :selected org-agenda-archives-mode :active t
2178 :keys "v a"]
2179 ["Include archive files" (org-agenda-archives-mode t)
2180 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2181 :keys "v A"]
2182 "--"
2183 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2184 ["Write view to file" org-agenda-write t]
2185 ["Rebuild buffer" org-agenda-redo t]
2186 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2187 "--"
2188 ["Show original entry" org-agenda-show t]
2189 ["Go To (other window)" org-agenda-goto t]
2190 ["Go To (this window)" org-agenda-switch-to t]
2191 ["Follow Mode" org-agenda-follow-mode
2192 :style toggle :selected org-agenda-follow-mode :active t]
2193 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2194 "--"
2195 ("TODO"
2196 ["Cycle TODO" org-agenda-todo t]
2197 ["Next TODO set" org-agenda-todo-nextset t]
2198 ["Previous TODO set" org-agenda-todo-previousset t]
2199 ["Add note" org-agenda-add-note t])
2200 ("Archive/Refile/Delete"
2201 ["Archive default" org-agenda-archive-default t]
2202 ["Archive default" org-agenda-archive-default-with-confirmation t]
2203 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2204 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2205 ["Archive subtree" org-agenda-archive t]
2206 "--"
2207 ["Refile" org-agenda-refile t]
2208 "--"
2209 ["Delete subtree" org-agenda-kill t])
2210 ("Bulk action"
2211 ["Mark entry" org-agenda-bulk-mark t]
2212 ["Mark all" org-agenda-bulk-mark-all t]
2213 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2214 ["Unmark entry" org-agenda-bulk-unmark t]
2215 ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "C-u s"])
2216 ["Act on all marked" org-agenda-bulk-action t]
2217 "--"
2218 ("Tags and Properties"
2219 ["Show all Tags" org-agenda-show-tags t]
2220 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2221 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2222 "--"
2223 ["Column View" org-columns t])
2224 ("Deadline/Schedule"
2225 ["Schedule" org-agenda-schedule t]
2226 ["Set Deadline" org-agenda-deadline t]
2227 "--"
2228 ["Mark item" org-agenda-action :active t :keys "k m"]
2229 ["Show mark item" org-agenda-action :active t :keys "k v"]
2230 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2231 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2232 "--"
2233 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2234 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2235 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2236 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2237 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2238 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2239 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2240 ("Clock and Effort"
2241 ["Clock in" org-agenda-clock-in t]
2242 ["Clock out" org-agenda-clock-out t]
2243 ["Clock cancel" org-agenda-clock-cancel t]
2244 ["Goto running clock" org-clock-goto t]
2245 "--"
2246 ["Set Effort" org-agenda-set-effort t]
2247 ["Change clocked effort" org-clock-modify-effort-estimate
2248 (org-clock-is-active)])
2249 ("Priority"
2250 ["Set Priority" org-agenda-priority t]
2251 ["Increase Priority" org-agenda-priority-up t]
2252 ["Decrease Priority" org-agenda-priority-down t]
2253 ["Show Priority" org-agenda-show-priority t])
2254 ("Calendar/Diary"
2255 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2256 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2257 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2258 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2259 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2260 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2261 "--"
2262 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2263 "--"
2264 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2265 "--"
2266 ("MobileOrg"
2267 ["Push Files and Views" org-mobile-push t]
2268 ["Get Captured and Flagged" org-mobile-pull t]
2269 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2270 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2271 "--"
2272 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2273 "--"
2274 ["Quit" org-agenda-quit t]
2275 ["Exit and Release Buffers" org-agenda-exit t]
2278 ;;; Agenda undo
2280 (defvar org-agenda-allow-remote-undo t
2281 "Non-nil means allow remote undo from the agenda buffer.")
2282 (defvar org-agenda-undo-list nil
2283 "List of undoable operations in the agenda since last refresh.")
2284 (defvar org-agenda-undo-has-started-in nil
2285 "Buffers that have already seen `undo-start' in the current undo sequence.")
2286 (defvar org-agenda-pending-undo-list nil
2287 "In a series of undo commands, this is the list of remaining undo items.")
2289 (defun org-agenda-undo ()
2290 "Undo a remote editing step in the agenda.
2291 This undoes changes both in the agenda buffer and in the remote buffer
2292 that have been changed along."
2293 (interactive)
2294 (or org-agenda-allow-remote-undo
2295 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2296 (if (not (eq this-command last-command))
2297 (setq org-agenda-undo-has-started-in nil
2298 org-agenda-pending-undo-list org-agenda-undo-list))
2299 (if (not org-agenda-pending-undo-list)
2300 (error "No further undo information"))
2301 (let* ((entry (pop org-agenda-pending-undo-list))
2302 buf line cmd rembuf)
2303 (setq cmd (pop entry) line (pop entry))
2304 (setq rembuf (nth 2 entry))
2305 (org-with-remote-undo rembuf
2306 (while (bufferp (setq buf (pop entry)))
2307 (if (pop entry)
2308 (with-current-buffer buf
2309 (let ((last-undo-buffer buf)
2310 (inhibit-read-only t))
2311 (unless (memq buf org-agenda-undo-has-started-in)
2312 (push buf org-agenda-undo-has-started-in)
2313 (make-local-variable 'pending-undo-list)
2314 (undo-start))
2315 (while (and pending-undo-list
2316 (listp pending-undo-list)
2317 (not (car pending-undo-list)))
2318 (pop pending-undo-list))
2319 (undo-more 1))))))
2320 (org-goto-line line)
2321 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2323 (defun org-verify-change-for-undo (l1 l2)
2324 "Verify that a real change occurred between the undo lists L1 and L2."
2325 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2326 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2327 (not (eq l1 l2)))
2329 ;;; Agenda dispatch
2331 (defvar org-agenda-restrict nil)
2332 (defvar org-agenda-restrict-begin (make-marker))
2333 (defvar org-agenda-restrict-end (make-marker))
2334 (defvar org-agenda-last-dispatch-buffer nil)
2335 (defvar org-agenda-overriding-restriction nil)
2337 ;;;###autoload
2338 (defun org-agenda (&optional arg keys restriction)
2339 "Dispatch agenda commands to collect entries to the agenda buffer.
2340 Prompts for a command to execute. Any prefix arg will be passed
2341 on to the selected command. The default selections are:
2343 a Call `org-agenda-list' to display the agenda for current day or week.
2344 t Call `org-todo-list' to display the global todo list.
2345 T Call `org-todo-list' to display the global todo list, select only
2346 entries with a specific TODO keyword (the user gets a prompt).
2347 m Call `org-tags-view' to display headlines with tags matching
2348 a condition (the user is prompted for the condition).
2349 M Like `m', but select only TODO entries, no ordinary headlines.
2350 L Create a timeline for the current buffer.
2351 e Export views to associated files.
2352 s Search entries for keywords.
2353 / Multi occur across all agenda files and also files listed
2354 in `org-agenda-text-search-extra-files'.
2355 < Restrict agenda commands to buffer, subtree, or region.
2356 Press several times to get the desired effect.
2357 > Remove a previous restriction.
2358 # List \"stuck\" projects.
2359 ! Configure what \"stuck\" means.
2360 C Configure custom agenda commands.
2362 More commands can be added by configuring the variable
2363 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2364 searches can be pre-defined in this way.
2366 If the current buffer is in Org-mode and visiting a file, you can also
2367 first press `<' once to indicate that the agenda should be temporarily
2368 \(until the next use of \\[org-agenda]) restricted to the current file.
2369 Pressing `<' twice means to restrict to the current subtree or region
2370 \(if active)."
2371 (interactive "P")
2372 (catch 'exit
2373 (let* ((prefix-descriptions nil)
2374 (org-agenda-buffer-name org-agenda-buffer-name)
2375 (org-agenda-window-setup (if (equal (buffer-name)
2376 org-agenda-buffer-name)
2377 'current-window
2378 org-agenda-window-setup))
2379 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2380 (org-agenda-custom-commands
2381 ;; normalize different versions
2382 (delq nil
2383 (mapcar
2384 (lambda (x)
2385 (cond ((stringp (cdr x))
2386 (push x prefix-descriptions)
2387 nil)
2388 ((stringp (nth 1 x)) x)
2389 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2390 (t (cons (car x) (cons "" (cdr x))))))
2391 org-agenda-custom-commands)))
2392 (buf (current-buffer))
2393 (bfn (buffer-file-name (buffer-base-buffer)))
2394 entry key type match lprops ans)
2395 ;; Turn off restriction unless there is an overriding one,
2396 (unless org-agenda-overriding-restriction
2397 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2398 ;; There is a request to keep the file list in place
2399 (put 'org-agenda-files 'org-restrict nil))
2400 (setq org-agenda-restrict nil)
2401 (move-marker org-agenda-restrict-begin nil)
2402 (move-marker org-agenda-restrict-end nil))
2403 ;; Delete old local properties
2404 (put 'org-agenda-redo-command 'org-lprops nil)
2405 ;; Delete previously set last-arguments
2406 (put 'org-agenda-redo-command 'last-args nil)
2407 ;; Remember where this call originated
2408 (setq org-agenda-last-dispatch-buffer (current-buffer))
2409 (unless keys
2410 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2411 keys (car ans)
2412 restriction (cdr ans)))
2413 ;; If we have sticky agenda buffers, set a name for the buffer,
2414 ;; depending on the invoking keys. The user may still set this
2415 ;; as a command option, which will overwrite what we do here.
2416 (if org-agenda-sticky
2417 (setq org-agenda-buffer-name (format "*Org Agenda(%s)*" keys)))
2418 ;; Establish the restriction, if any
2419 (when (and (not org-agenda-overriding-restriction) restriction)
2420 (put 'org-agenda-files 'org-restrict (list bfn))
2421 (cond
2422 ((eq restriction 'region)
2423 (setq org-agenda-restrict t)
2424 (move-marker org-agenda-restrict-begin (region-beginning))
2425 (move-marker org-agenda-restrict-end (region-end)))
2426 ((eq restriction 'subtree)
2427 (save-excursion
2428 (setq org-agenda-restrict t)
2429 (org-back-to-heading t)
2430 (move-marker org-agenda-restrict-begin (point))
2431 (move-marker org-agenda-restrict-end
2432 (progn (org-end-of-subtree t)))))))
2434 ;; For example the todo list should not need it (but does...)
2435 (cond
2436 ((setq entry (assoc keys org-agenda-custom-commands))
2437 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2438 (progn
2439 (setq type (nth 2 entry) match (eval (nth 3 entry))
2440 lprops (nth 4 entry))
2441 (put 'org-agenda-redo-command 'org-lprops lprops)
2442 (cond
2443 ((eq type 'agenda)
2444 (org-let lprops '(org-agenda-list current-prefix-arg)))
2445 ((eq type 'alltodo)
2446 (org-let lprops '(org-todo-list current-prefix-arg)))
2447 ((eq type 'search)
2448 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2449 ((eq type 'stuck)
2450 (org-let lprops '(org-agenda-list-stuck-projects
2451 current-prefix-arg)))
2452 ((eq type 'tags)
2453 (org-let lprops '(org-tags-view current-prefix-arg match)))
2454 ((eq type 'tags-todo)
2455 (org-let lprops '(org-tags-view '(4) match)))
2456 ((eq type 'todo)
2457 (org-let lprops '(org-todo-list match)))
2458 ((eq type 'tags-tree)
2459 (org-check-for-org-mode)
2460 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2461 ((eq type 'todo-tree)
2462 (org-check-for-org-mode)
2463 (org-let lprops
2464 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2465 (regexp-quote match) "\\>"))))
2466 ((eq type 'occur-tree)
2467 (org-check-for-org-mode)
2468 (org-let lprops '(org-occur match)))
2469 ((functionp type)
2470 (org-let lprops '(funcall type match)))
2471 ((fboundp type)
2472 (org-let lprops '(funcall type match)))
2473 (t (error "Invalid custom agenda command type %s" type))))
2474 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2475 ((equal keys "C")
2476 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2477 (customize-variable 'org-agenda-custom-commands))
2478 ((equal keys "a") (call-interactively 'org-agenda-list))
2479 ((equal keys "s") (call-interactively 'org-search-view))
2480 ((equal keys "t") (call-interactively 'org-todo-list))
2481 ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2482 ((equal keys "m") (call-interactively 'org-tags-view))
2483 ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2484 ((equal keys "e") (call-interactively 'org-store-agenda-views))
2485 ((equal keys "?") (org-tags-view nil "+FLAGGED")
2486 (org-add-hook
2487 'post-command-hook
2488 (lambda ()
2489 (unless (current-message)
2490 (let* ((m (org-agenda-get-any-marker))
2491 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2492 (when note
2493 (message (concat
2494 "FLAGGING-NOTE ([?] for more info): "
2495 (org-add-props
2496 (replace-regexp-in-string
2497 "\\\\n" "//"
2498 (copy-sequence note))
2499 nil 'face 'org-warning)))))))
2500 t t))
2501 ((equal keys "L")
2502 (unless (derived-mode-p 'org-mode)
2503 (error "This is not an Org-mode file"))
2504 (unless restriction
2505 (put 'org-agenda-files 'org-restrict (list bfn))
2506 (org-call-with-arg 'org-timeline arg)))
2507 ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2508 ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2509 ((equal keys "!") (customize-variable 'org-stuck-projects))
2510 (t (error "Invalid agenda key"))))))
2512 (defun org-agenda-append-agenda ()
2513 "Append another agenda view to the current one.
2514 This function allows interactive building of block agendas.
2515 Agenda views are separated by `org-agenda-block-separator'."
2516 (interactive)
2517 (unless (string= (buffer-name) org-agenda-buffer-name)
2518 (error "Can only append from within agenda buffer"))
2519 (let ((org-agenda-multi t))
2520 (org-agenda)
2521 (widen)))
2523 (defun org-agenda-normalize-custom-commands (cmds)
2524 (delq nil
2525 (mapcar
2526 (lambda (x)
2527 (cond ((stringp (cdr x)) nil)
2528 ((stringp (nth 1 x)) x)
2529 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2530 (t (cons (car x) (cons "" (cdr x))))))
2531 cmds)))
2533 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2534 "The user interface for selecting an agenda command."
2535 (catch 'exit
2536 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2537 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2538 (region-p (org-region-active-p))
2539 (custom org-agenda-custom-commands)
2540 (selstring "")
2541 restriction second-time
2542 c entry key type match prefixes rmheader header-end custom1 desc
2543 line lines left right n n1)
2544 (save-window-excursion
2545 (delete-other-windows)
2546 (org-switch-to-buffer-other-window " *Agenda Commands*")
2547 (erase-buffer)
2548 (insert (eval-when-compile
2549 (let ((header
2550 "Press key for an agenda command: < Buffer, subtree/region restriction
2551 -------------------------------- > Remove restriction
2552 a Agenda for current week or day e Export agenda views
2553 t List of all TODO entries T Entries with special TODO kwd
2554 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2555 L Timeline for current buffer # List stuck projects (!=configure)
2556 s Search for keywords * Toggle sticky agenda views
2557 / Multi-occur ? Find :FLAGGED: entries
2558 C Configure custom agenda commands
2560 (start 0))
2561 (while (string-match
2562 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2563 header start)
2564 (setq start (match-end 0))
2565 (add-text-properties (match-beginning 2) (match-end 2)
2566 '(face bold) header))
2567 header)))
2568 (setq header-end (move-marker (make-marker) (point)))
2569 (while t
2570 (setq custom1 custom)
2571 (when (eq rmheader t)
2572 (org-goto-line 1)
2573 (re-search-forward ":" nil t)
2574 (delete-region (match-end 0) (point-at-eol))
2575 (forward-char 1)
2576 (looking-at "-+")
2577 (delete-region (match-end 0) (point-at-eol))
2578 (move-marker header-end (match-end 0)))
2579 (goto-char header-end)
2580 (delete-region (point) (point-max))
2582 ;; Produce all the lines that describe custom commands and prefixes
2583 (setq lines nil)
2584 (while (setq entry (pop custom1))
2585 (setq key (car entry) desc (nth 1 entry)
2586 type (nth 2 entry)
2587 match (nth 3 entry))
2588 (if (> (length key) 1)
2589 (add-to-list 'prefixes (string-to-char key))
2590 (setq line
2591 (format
2592 "%-4s%-14s"
2593 (org-add-props (copy-sequence key)
2594 '(face bold))
2595 (cond
2596 ((string-match "\\S-" desc) desc)
2597 ((eq type 'agenda) "Agenda for current week or day")
2598 ((eq type 'alltodo) "List of all TODO entries")
2599 ((eq type 'search) "Word search")
2600 ((eq type 'stuck) "List of stuck projects")
2601 ((eq type 'todo) "TODO keyword")
2602 ((eq type 'tags) "Tags query")
2603 ((eq type 'tags-todo) "Tags (TODO)")
2604 ((eq type 'tags-tree) "Tags tree")
2605 ((eq type 'todo-tree) "TODO kwd tree")
2606 ((eq type 'occur-tree) "Occur tree")
2607 ((functionp type) (if (symbolp type)
2608 (symbol-name type)
2609 "Lambda expression"))
2610 (t "???"))))
2611 (if org-agenda-menu-show-matcher
2612 (setq line
2613 (concat line ": "
2614 (cond
2615 ((stringp match)
2616 (setq match (copy-sequence match))
2617 (org-add-props match nil 'face 'org-warning))
2618 (match
2619 (format "set of %d commands" (length match)))
2620 (t ""))))
2621 (if (org-string-nw-p match)
2622 (add-text-properties
2623 0 (length line) (list 'help-echo
2624 (concat "Matcher: "match)) line)))
2625 (push line lines)))
2626 (setq lines (nreverse lines))
2627 (when prefixes
2628 (mapc (lambda (x)
2629 (push
2630 (format "%s %s"
2631 (org-add-props (char-to-string x)
2632 nil 'face 'bold)
2633 (or (cdr (assoc (concat selstring
2634 (char-to-string x))
2635 prefix-descriptions))
2636 "Prefix key"))
2637 lines))
2638 prefixes))
2640 ;; Check if we should display in two columns
2641 (if org-agenda-menu-two-columns
2642 (progn
2643 (setq n (length lines)
2644 n1 (+ (/ n 2) (mod n 2))
2645 right (nthcdr n1 lines)
2646 left (copy-sequence lines))
2647 (setcdr (nthcdr (1- n1) left) nil))
2648 (setq left lines right nil))
2649 (while left
2650 (insert "\n" (pop left))
2651 (when right
2652 (if (< (current-column) 40)
2653 (move-to-column 40 t)
2654 (insert " "))
2655 (insert (pop right))))
2657 ;; Make the window the right size
2658 (goto-char (point-min))
2659 (if second-time
2660 (if (not (pos-visible-in-window-p (point-max)))
2661 (org-fit-window-to-buffer))
2662 (setq second-time t)
2663 (org-fit-window-to-buffer))
2665 ;; Ask for selection
2666 (message "Press key for agenda command%s:"
2667 (if (or restrict-ok org-agenda-overriding-restriction)
2668 (if org-agenda-overriding-restriction
2669 " (restriction lock active)"
2670 (if restriction
2671 (format " (restricted to %s)" restriction)
2672 " (unrestricted)"))
2673 ""))
2674 (setq c (read-char-exclusive))
2675 (message "")
2676 (cond
2677 ((assoc (char-to-string c) custom)
2678 (setq selstring (concat selstring (char-to-string c)))
2679 (throw 'exit (cons selstring restriction)))
2680 ((memq c prefixes)
2681 (setq selstring (concat selstring (char-to-string c))
2682 prefixes nil
2683 rmheader (or rmheader t)
2684 custom (delq nil (mapcar
2685 (lambda (x)
2686 (if (or (= (length (car x)) 1)
2687 (/= (string-to-char (car x)) c))
2689 (cons (substring (car x) 1) (cdr x))))
2690 custom))))
2691 ((eq c ?*)
2692 (call-interactively 'org-toggle-sticky-agenda)
2693 (sit-for 2))
2694 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2695 (message "Restriction is only possible in Org-mode buffers")
2696 (ding) (sit-for 1))
2697 ((eq c ?1)
2698 (org-agenda-remove-restriction-lock 'noupdate)
2699 (setq restriction 'buffer))
2700 ((eq c ?0)
2701 (org-agenda-remove-restriction-lock 'noupdate)
2702 (setq restriction (if region-p 'region 'subtree)))
2703 ((eq c ?<)
2704 (org-agenda-remove-restriction-lock 'noupdate)
2705 (setq restriction
2706 (cond
2707 ((eq restriction 'buffer)
2708 (if region-p 'region 'subtree))
2709 ((memq restriction '(subtree region))
2710 nil)
2711 (t 'buffer))))
2712 ((eq c ?>)
2713 (org-agenda-remove-restriction-lock 'noupdate)
2714 (setq restriction nil))
2715 ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2716 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2717 ((and (> (length selstring) 0) (eq c ?\d))
2718 (delete-window)
2719 (org-agenda-get-restriction-and-command prefix-descriptions))
2721 ((equal c ?q) (error "Abort"))
2722 (t (error "Invalid key %c" c))))))))
2724 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2725 (defvar org-agenda-last-arguments nil
2726 "The arguments of the previous call to `org-agenda'.")
2727 (defun org-agenda-run-series (name series)
2728 (org-let (nth 1 series) '(org-prepare-agenda name))
2729 ;; We need to reset agenda markers here, because when constructing a
2730 ;; block agenda, the individual blocks do not do that.
2731 (org-agenda-reset-markers)
2732 (let* ((org-agenda-multi t)
2733 (redo (list 'org-agenda-run-series name (list 'quote series)))
2734 (org-agenda-overriding-arguments
2735 (or org-agenda-overriding-arguments
2736 (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2737 (get 'org-agenda-redo-command 'last-args))))
2738 (cmds (car series))
2739 (gprops (nth 1 series))
2740 match ;; The byte compiler incorrectly complains about this. Keep it!
2741 cmd type lprops)
2742 (while (setq cmd (pop cmds))
2743 (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2744 (cond
2745 ((eq type 'agenda)
2746 (org-let2 gprops lprops
2747 '(call-interactively 'org-agenda-list)))
2748 ((eq type 'alltodo)
2749 (org-let2 gprops lprops
2750 '(call-interactively 'org-todo-list)))
2751 ((eq type 'search)
2752 (org-let2 gprops lprops
2753 '(org-search-view current-prefix-arg match nil)))
2754 ((eq type 'stuck)
2755 (org-let2 gprops lprops
2756 '(call-interactively 'org-agenda-list-stuck-projects)))
2757 ((eq type 'tags)
2758 (org-let2 gprops lprops
2759 '(org-tags-view current-prefix-arg match)))
2760 ((eq type 'tags-todo)
2761 (org-let2 gprops lprops
2762 '(org-tags-view '(4) match)))
2763 ((eq type 'todo)
2764 (org-let2 gprops lprops
2765 '(org-todo-list match)))
2766 ((fboundp type)
2767 (org-let2 gprops lprops
2768 '(funcall type match)))
2769 (t (error "Invalid type in command series"))))
2770 (widen)
2771 (setq org-agenda-redo-command redo)
2772 (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2773 (goto-char (point-min)))
2774 (org-fit-agenda-window)
2775 (org-let (nth 1 series) '(org-finalize-agenda)))
2777 ;;;###autoload
2778 (defmacro org-batch-agenda (cmd-key &rest parameters)
2779 "Run an agenda command in batch mode and send the result to STDOUT.
2780 If CMD-KEY is a string of length 1, it is used as a key in
2781 `org-agenda-custom-commands' and triggers this command. If it is a
2782 longer string it is used as a tags/todo match string.
2783 Parameters are alternating variable names and values that will be bound
2784 before running the agenda command."
2785 (org-eval-in-environment (org-make-parameter-alist parameters)
2786 (if (> (length cmd-key) 2)
2787 (org-tags-view nil cmd-key)
2788 (org-agenda nil cmd-key)))
2789 (set-buffer org-agenda-buffer-name)
2790 (princ (buffer-string)))
2791 (def-edebug-spec org-batch-agenda (form &rest sexp))
2793 (defvar org-agenda-info nil)
2795 ;;;###autoload
2796 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2797 "Run an agenda command in batch mode and send the result to STDOUT.
2798 If CMD-KEY is a string of length 1, it is used as a key in
2799 `org-agenda-custom-commands' and triggers this command. If it is a
2800 longer string it is used as a tags/todo match string.
2801 Parameters are alternating variable names and values that will be bound
2802 before running the agenda command.
2804 The output gives a line for each selected agenda item. Each
2805 item is a list of comma-separated values, like this:
2807 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2809 category The category of the item
2810 head The headline, without TODO kwd, TAGS and PRIORITY
2811 type The type of the agenda entry, can be
2812 todo selected in TODO match
2813 tagsmatch selected in tags match
2814 diary imported from diary
2815 deadline a deadline on given date
2816 scheduled scheduled on given date
2817 timestamp entry has timestamp on given date
2818 closed entry was closed on given date
2819 upcoming-deadline warning about deadline
2820 past-scheduled forwarded scheduled item
2821 block entry has date block including g. date
2822 todo The todo keyword, if any
2823 tags All tags including inherited ones, separated by colons
2824 date The relevant date, like 2007-2-14
2825 time The time, like 15:00-16:50
2826 extra Sting with extra planning info
2827 priority-l The priority letter if any was given
2828 priority-n The computed numerical priority
2829 agenda-day The day in the agenda where this is listed"
2830 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2831 (org-make-parameter-alist parameters))
2832 (if (> (length cmd-key) 2)
2833 (org-tags-view nil cmd-key)
2834 (org-agenda nil cmd-key)))
2835 (set-buffer org-agenda-buffer-name)
2836 (let* ((lines (org-split-string (buffer-string) "\n"))
2837 line)
2838 (while (setq line (pop lines))
2839 (catch 'next
2840 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2841 (setq org-agenda-info
2842 (org-fix-agenda-info (text-properties-at 0 line)))
2843 (princ
2844 (mapconcat 'org-agenda-export-csv-mapper
2845 '(org-category txt type todo tags date time extra
2846 priority-letter priority agenda-day)
2847 ","))
2848 (princ "\n")))))
2849 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2851 (defun org-fix-agenda-info (props)
2852 "Make sure all properties on an agenda item have a canonical form.
2853 This ensures the export commands can easily use it."
2854 (let (tmp re)
2855 (when (setq tmp (plist-get props 'tags))
2856 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2857 (when (setq tmp (plist-get props 'date))
2858 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2859 (let ((calendar-date-display-form '(year "-" month "-" day)))
2860 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2862 (setq tmp (calendar-date-string tmp)))
2863 (setq props (plist-put props 'date tmp)))
2864 (when (setq tmp (plist-get props 'day))
2865 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2866 (let ((calendar-date-display-form '(year "-" month "-" day)))
2867 (setq tmp (calendar-date-string tmp)))
2868 (setq props (plist-put props 'day tmp))
2869 (setq props (plist-put props 'agenda-day tmp)))
2870 (when (setq tmp (plist-get props 'txt))
2871 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2872 (plist-put props 'priority-letter (match-string 1 tmp))
2873 (setq tmp (replace-match "" t t tmp)))
2874 (when (and (setq re (plist-get props 'org-todo-regexp))
2875 (setq re (concat "\\`\\.*" re " ?"))
2876 (string-match re tmp))
2877 (plist-put props 'todo (match-string 1 tmp))
2878 (setq tmp (replace-match "" t t tmp)))
2879 (plist-put props 'txt tmp)))
2880 props)
2882 (defun org-agenda-export-csv-mapper (prop)
2883 (let ((res (plist-get org-agenda-info prop)))
2884 (setq res
2885 (cond
2886 ((not res) "")
2887 ((stringp res) res)
2888 (t (prin1-to-string res))))
2889 (while (string-match "," res)
2890 (setq res (replace-match ";" t t res)))
2891 (org-trim res)))
2893 ;;;###autoload
2894 (defun org-store-agenda-views (&rest parameters)
2895 (interactive)
2896 (eval (list 'org-batch-store-agenda-views)))
2898 ;;;###autoload
2899 (defmacro org-batch-store-agenda-views (&rest parameters)
2900 "Run all custom agenda commands that have a file argument."
2901 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2902 (pop-up-frames nil)
2903 (dir default-directory)
2904 (pars (org-make-parameter-alist parameters))
2905 cmd thiscmdkey files opts cmd-or-set bufname)
2906 (save-window-excursion
2907 (while cmds
2908 (setq cmd (pop cmds)
2909 thiscmdkey (car cmd)
2910 bufname (if org-agenda-sticky (format "*Org Agenda(%s)*" thiscmdkey)
2911 org-agenda-buffer-name)
2912 cmd-or-set (nth 2 cmd)
2913 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2914 files (nth (if (listp cmd-or-set) 4 5) cmd))
2915 (if (stringp files) (setq files (list files)))
2916 (when files
2917 (org-eval-in-environment (append org-agenda-exporter-settings
2918 opts pars)
2919 (org-agenda nil thiscmdkey))
2920 (set-buffer bufname)
2921 (while files
2922 (org-eval-in-environment (append org-agenda-exporter-settings
2923 opts pars)
2924 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
2925 (and (get-buffer bufname)
2926 (kill-buffer bufname)))))))
2927 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2929 (defun org-agenda-mark-header-line (pos)
2930 "Mark the line at POS as an agenda structure header."
2931 (save-excursion
2932 (goto-char pos)
2933 (put-text-property (point-at-bol) (point-at-eol)
2934 'org-agenda-structural-header t)
2935 (when org-agenda-title-append
2936 (put-text-property (point-at-bol) (point-at-eol)
2937 'org-agenda-title-append org-agenda-title-append))))
2939 (defvar org-mobile-creating-agendas)
2940 (defvar org-agenda-write-buffer-name "Agenda View")
2941 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
2942 "Write the current buffer (an agenda view) as a file.
2943 Depending on the extension of the file name, plain text (.txt),
2944 HTML (.html or .htm) or Postscript (.ps) is produced.
2945 If the extension is .ics, run icalendar export over all files used
2946 to construct the agenda and limit the export to entries listed in the
2947 agenda now.
2948 With prefix argument OPEN, open the new file immediately.
2949 If NOSETTINGS is given, do not scope the settings of
2950 `org-agenda-exporter-settings' into the export commands. This is used when
2951 the settings have already been scoped and we do not wish to overrule other,
2952 higher priority settings.
2953 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
2954 (interactive "FWrite agenda to file: \nP")
2955 (if (not (file-writable-p file))
2956 (error "Cannot write agenda to file %s" file))
2957 (org-let (if nosettings nil org-agenda-exporter-settings)
2958 '(save-excursion
2959 (save-window-excursion
2960 (org-agenda-mark-filtered-text)
2961 (let ((bs (copy-sequence (buffer-string))) beg)
2962 (org-agenda-unmark-filtered-text)
2963 (with-temp-buffer
2964 (rename-buffer org-agenda-write-buffer-name t)
2965 (set-buffer-modified-p nil)
2966 (insert bs)
2967 (org-agenda-remove-marked-text 'org-filtered)
2968 (while (setq beg (text-property-any (point-min) (point-max)
2969 'org-filtered t))
2970 (delete-region
2971 beg (or (next-single-property-change beg 'org-filtered)
2972 (point-max))))
2973 (run-hooks 'org-agenda-before-write-hook)
2974 (cond
2975 ((org-bound-and-true-p org-mobile-creating-agendas)
2976 (org-mobile-write-agenda-for-mobile file))
2977 ((string-match "\\.html?\\'" file)
2978 (require 'htmlize)
2979 (set-buffer (htmlize-buffer (current-buffer)))
2980 (when (and org-agenda-export-html-style
2981 (string-match "<style>" org-agenda-export-html-style))
2982 ;; replace <style> section with org-agenda-export-html-style
2983 (goto-char (point-min))
2984 (kill-region (- (search-forward "<style") 6)
2985 (search-forward "</style>"))
2986 (insert org-agenda-export-html-style))
2987 (write-file file)
2988 (kill-buffer (current-buffer))
2989 (message "HTML written to %s" file))
2990 ((string-match "\\.ps\\'" file)
2991 (require 'ps-print)
2992 (ps-print-buffer-with-faces file)
2993 (message "Postscript written to %s" file))
2994 ((string-match "\\.pdf\\'" file)
2995 (require 'ps-print)
2996 (ps-print-buffer-with-faces
2997 (concat (file-name-sans-extension file) ".ps"))
2998 (call-process "ps2pdf" nil nil nil
2999 (expand-file-name
3000 (concat (file-name-sans-extension file) ".ps"))
3001 (expand-file-name file))
3002 (delete-file (concat (file-name-sans-extension file) ".ps"))
3003 (message "PDF written to %s" file))
3004 ((string-match "\\.ics\\'" file)
3005 (require 'org-icalendar)
3006 (let ((org-agenda-marker-table
3007 (org-create-marker-find-array
3008 (org-agenda-collect-markers)))
3009 (org-icalendar-verify-function 'org-check-agenda-marker-table)
3010 (org-combined-agenda-icalendar-file file))
3011 (apply 'org-export-icalendar 'combine
3012 (org-agenda-files nil 'ifmode))))
3014 (let ((bs (buffer-string)))
3015 (find-file file)
3016 (erase-buffer)
3017 (insert bs)
3018 (save-buffer 0)
3019 (kill-buffer (current-buffer))
3020 (message "Plain text written to %s" file))))))))
3021 (set-buffer (or agenda-bufname
3022 (and (called-interactively-p 'any) (buffer-name))
3023 org-agenda-buffer-name)))
3024 (when open (org-open-file file)))
3026 (defvar org-agenda-tag-filter-overlays nil)
3027 (defvar org-agenda-cat-filter-overlays nil)
3029 (defun org-agenda-mark-filtered-text ()
3030 "Mark all text hidden by filtering with a text property."
3031 (let ((inhibit-read-only t))
3032 (mapc
3033 (lambda (o)
3034 (when (equal (overlay-buffer o) (current-buffer))
3035 (put-text-property
3036 (overlay-start o) (overlay-end o)
3037 'org-filtered t)))
3038 (append org-agenda-tag-filter-overlays
3039 org-agenda-cat-filter-overlays))))
3041 (defun org-agenda-unmark-filtered-text ()
3042 "Remove the filtering text property."
3043 (let ((inhibit-read-only t))
3044 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3046 (defun org-agenda-remove-marked-text (property &optional value)
3047 "Delete all text marked with VALUE of PROPERTY.
3048 VALUE defaults to t."
3049 (let (beg)
3050 (setq value (or value t))
3051 (while (setq beg (text-property-any (point-min) (point-max)
3052 property value))
3053 (delete-region
3054 beg (or (next-single-property-change beg 'org-filtered)
3055 (point-max))))))
3057 (defun org-agenda-add-entry-text ()
3058 "Add entry text to agenda lines.
3059 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3060 entry text following headings shown in the agenda.
3061 Drawers will be excluded, also the line with scheduling/deadline info."
3062 (when (and (> org-agenda-add-entry-text-maxlines 0)
3063 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3064 (let (m txt)
3065 (goto-char (point-min))
3066 (while (not (eobp))
3067 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3068 (beginning-of-line 2)
3069 (setq txt (org-agenda-get-some-entry-text
3070 m org-agenda-add-entry-text-maxlines " > "))
3071 (end-of-line 1)
3072 (if (string-match "\\S-" txt)
3073 (insert "\n" txt)
3074 (or (eobp) (forward-char 1))))))))
3076 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3077 &rest keep)
3078 "Extract entry text from MARKER, at most N-LINES lines.
3079 This will ignore drawers etc, just get the text.
3080 If INDENT is given, prefix every line with this string. If KEEP is
3081 given, it is a list of symbols, defining stuff that should not be
3082 removed from the entry content. Currently only `planning' is allowed here."
3083 (let (txt drawer-re kwd-time-re ind)
3084 (save-excursion
3085 (with-current-buffer (marker-buffer marker)
3086 (if (not (derived-mode-p 'org-mode))
3087 (setq txt "")
3088 (save-excursion
3089 (save-restriction
3090 (widen)
3091 (goto-char marker)
3092 (end-of-line 1)
3093 (setq txt (buffer-substring
3094 (min (1+ (point)) (point-max))
3095 (progn (outline-next-heading) (point)))
3096 drawer-re org-drawer-regexp
3097 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3098 ".*\n?"))
3099 (with-temp-buffer
3100 (insert txt)
3101 (when org-agenda-add-entry-text-descriptive-links
3102 (goto-char (point-min))
3103 (while (org-activate-bracket-links (point-max))
3104 (add-text-properties (match-beginning 0) (match-end 0)
3105 '(face org-link))))
3106 (goto-char (point-min))
3107 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3108 (set-text-properties (match-beginning 0) (match-end 0)
3109 nil))
3110 (goto-char (point-min))
3111 (while (re-search-forward drawer-re nil t)
3112 (delete-region
3113 (match-beginning 0)
3114 (progn (re-search-forward
3115 "^[ \t]*:END:.*\n?" nil 'move)
3116 (point))))
3117 (unless (member 'planning keep)
3118 (goto-char (point-min))
3119 (while (re-search-forward kwd-time-re nil t)
3120 (replace-match "")))
3121 (goto-char (point-min))
3122 (when org-agenda-entry-text-exclude-regexps
3123 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3124 (while (setq re (pop re-list))
3125 (goto-char (point-min))
3126 (while (re-search-forward re nil t)
3127 (replace-match "")))))
3128 (goto-char (point-max))
3129 (skip-chars-backward " \t\n")
3130 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3132 ;; find and remove min common indentation
3133 (goto-char (point-min))
3134 (untabify (point-min) (point-max))
3135 (setq ind (org-get-indentation))
3136 (while (not (eobp))
3137 (unless (looking-at "[ \t]*$")
3138 (setq ind (min ind (org-get-indentation))))
3139 (beginning-of-line 2))
3140 (goto-char (point-min))
3141 (while (not (eobp))
3142 (unless (looking-at "[ \t]*$")
3143 (move-to-column ind)
3144 (delete-region (point-at-bol) (point)))
3145 (beginning-of-line 2))
3147 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3149 (goto-char (point-min))
3150 (when indent
3151 (while (and (not (eobp)) (re-search-forward "^" nil t))
3152 (replace-match indent t t)))
3153 (goto-char (point-min))
3154 (while (looking-at "[ \t]*\n") (replace-match ""))
3155 (goto-char (point-max))
3156 (when (> (org-current-line)
3157 n-lines)
3158 (org-goto-line (1+ n-lines))
3159 (backward-char 1))
3160 (setq txt (buffer-substring (point-min) (point)))))))))
3161 txt))
3163 (defun org-agenda-collect-markers ()
3164 "Collect the markers pointing to entries in the agenda buffer."
3165 (let (m markers)
3166 (save-excursion
3167 (goto-char (point-min))
3168 (while (not (eobp))
3169 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3170 (org-get-at-bol 'org-marker)))
3171 (push m markers))
3172 (beginning-of-line 2)))
3173 (nreverse markers)))
3175 (defun org-create-marker-find-array (marker-list)
3176 "Create a alist of files names with all marker positions in that file."
3177 (let (f tbl m a p)
3178 (while (setq m (pop marker-list))
3179 (setq p (marker-position m)
3180 f (buffer-file-name (or (buffer-base-buffer
3181 (marker-buffer m))
3182 (marker-buffer m))))
3183 (if (setq a (assoc f tbl))
3184 (push (marker-position m) (cdr a))
3185 (push (list f p) tbl)))
3186 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3187 tbl)))
3189 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3190 (defun org-check-agenda-marker-table ()
3191 "Check of the current entry is on the marker list."
3192 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3194 (and (setq a (assoc file org-agenda-marker-table))
3195 (save-match-data
3196 (save-excursion
3197 (org-back-to-heading t)
3198 (member (point) (cdr a)))))))
3200 (defun org-check-for-org-mode ()
3201 "Make sure current buffer is in org-mode. Error if not."
3202 (or (derived-mode-p 'org-mode)
3203 (error "Cannot execute org-mode agenda command on buffer in %s"
3204 major-mode)))
3206 (defun org-fit-agenda-window ()
3207 "Fit the window to the buffer size."
3208 (and (memq org-agenda-window-setup '(reorganize-frame))
3209 (fboundp 'fit-window-to-buffer)
3210 (org-fit-window-to-buffer
3212 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3213 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3215 ;;; Agenda prepare and finalize
3217 (defvar org-agenda-multi nil) ; dynamically scoped
3218 (defvar org-agenda-buffer-name "*Org Agenda*")
3219 (defvar org-pre-agenda-window-conf nil)
3220 (defvar org-agenda-columns-active nil)
3221 (defvar org-agenda-name nil)
3222 (defvar org-agenda-tag-filter nil)
3223 (defvar org-agenda-category-filter nil)
3224 (defvar org-agenda-top-category-filter nil)
3225 (defvar org-agenda-tag-filter-while-redo nil)
3226 (defvar org-agenda-tag-filter-preset nil
3227 "A preset of the tags filter used for secondary agenda filtering.
3228 This must be a list of strings, each string must be a single tag preceded
3229 by \"+\" or \"-\".
3230 This variable should not be set directly, but agenda custom commands can
3231 bind it in the options section. The preset filter is a global property of
3232 the entire agenda view. In a block agenda, it will not work reliably to
3233 define a filter for one of the individual blocks. You need to set it in
3234 the global options and expect it to be applied to the entire view.")
3236 (defvar org-agenda-category-filter-preset nil
3237 "A preset of the category filter used for secondary agenda filtering.
3238 This must be a list of strings, each string must be a single category
3239 preceded by \"+\" or \"-\".
3240 This variable should not be set directly, but agenda custom commands can
3241 bind it in the options section. The preset filter is a global property of
3242 the entire agenda view. In a block agenda, it will not work reliably to
3243 define a filter for one of the individual blocks. You need to set it in
3244 the global options and expect it to be applied to the entire view.")
3247 (defun org-agenda-use-sticky-p ()
3248 "Return non-nil if an agenda buffer named
3249 `org-agenda-buffer-name' exists and should be shown instead of
3250 generating a new one."
3251 (and
3252 ;; turned off by user
3253 org-agenda-sticky
3254 ;; For multi-agenda buffer already exists
3255 (not org-agenda-multi)
3256 ;; buffer found
3257 (get-buffer org-agenda-buffer-name)
3258 ;; C-u parameter is same as last call
3259 (with-current-buffer (get-buffer org-agenda-buffer-name)
3260 (and
3261 (equal current-prefix-arg
3262 org-agenda-last-prefix-arg)
3263 ;; In case user turned stickiness on, while having existing
3264 ;; Agenda buffer active, don't reuse that buffer, because it
3265 ;; does not have org variables local
3266 org-agenda-this-buffer-is-sticky))))
3268 (defun org-prepare-agenda-window (abuf)
3269 "Setup agenda buffer in the window."
3270 (let* ((awin (get-buffer-window abuf))
3271 wconf)
3272 (cond
3273 ((equal (current-buffer) abuf) nil)
3274 (awin (select-window awin))
3275 ((not (setq wconf (current-window-configuration))))
3276 ((equal org-agenda-window-setup 'current-window)
3277 (org-pop-to-buffer-same-window abuf))
3278 ((equal org-agenda-window-setup 'other-window)
3279 (org-switch-to-buffer-other-window abuf))
3280 ((equal org-agenda-window-setup 'other-frame)
3281 (switch-to-buffer-other-frame abuf))
3282 ((equal org-agenda-window-setup 'reorganize-frame)
3283 (delete-other-windows)
3284 (org-switch-to-buffer-other-window abuf)))
3285 ;; additional test in case agenda is invoked from within agenda
3286 ;; buffer via elisp link
3287 (unless (equal (current-buffer) abuf)
3288 (org-pop-to-buffer-same-window abuf))
3289 (setq org-pre-agenda-window-conf wconf)))
3291 (defun org-prepare-agenda (&optional name)
3292 (if (org-agenda-use-sticky-p)
3293 (progn
3294 ;; Popup existing buffer
3295 (org-prepare-agenda-window (get-buffer org-agenda-buffer-name))
3296 (message "Sticky Agenda buffer, use `r' to refresh")
3297 (throw 'exit nil))
3298 (setq org-todo-keywords-for-agenda nil)
3299 (setq org-drawers-for-agenda nil)
3300 (unless org-agenda-persistent-filter
3301 (setq org-agenda-tag-filter nil
3302 org-agenda-category-filter nil))
3303 (put 'org-agenda-tag-filter :preset-filter org-agenda-tag-filter-preset)
3304 (put 'org-agenda-category-filter :preset-filter
3305 org-agenda-category-filter-preset)
3306 (if org-agenda-multi
3307 (progn
3308 (setq buffer-read-only nil)
3309 (goto-char (point-max))
3310 (unless (or (bobp) org-agenda-compact-blocks
3311 (not org-agenda-block-separator))
3312 (insert "\n"
3313 (if (stringp org-agenda-block-separator)
3314 org-agenda-block-separator
3315 (make-string (window-width) org-agenda-block-separator))
3316 "\n"))
3317 (narrow-to-region (point) (point-max)))
3318 (setq org-done-keywords-for-agenda nil)
3320 ;; Setting any org variables that are in org-agenda-local-vars
3321 ;; list need to be done after the prepare call
3322 (org-prepare-agenda-window (get-buffer-create org-agenda-buffer-name))
3323 (setq buffer-read-only nil)
3324 (org-agenda-reset-markers)
3325 (let ((inhibit-read-only t)) (erase-buffer))
3326 (org-agenda-mode)
3327 (setq org-agenda-buffer (current-buffer))
3328 (setq org-agenda-contributing-files nil)
3329 (setq org-agenda-columns-active nil)
3330 (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3331 (setq org-todo-keywords-for-agenda
3332 (org-uniquify org-todo-keywords-for-agenda))
3333 (setq org-done-keywords-for-agenda
3334 (org-uniquify org-done-keywords-for-agenda))
3335 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3336 (setq org-agenda-last-prefix-arg current-prefix-arg)
3337 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3338 (and name (not org-agenda-name)
3339 (org-set-local 'org-agenda-name name)))
3340 (setq buffer-read-only nil)))
3342 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3343 (defun org-finalize-agenda ()
3344 "Finishing touch for the agenda buffer, called just before displaying it."
3345 (unless org-agenda-multi
3346 (save-excursion
3347 (let ((inhibit-read-only t))
3348 (goto-char (point-min))
3349 (while (org-activate-bracket-links (point-max))
3350 (add-text-properties (match-beginning 0) (match-end 0)
3351 '(face org-link)))
3352 (org-agenda-align-tags)
3353 (unless org-agenda-with-colors
3354 (remove-text-properties (point-min) (point-max) '(face nil))))
3355 (if (and (boundp 'org-agenda-overriding-columns-format)
3356 org-agenda-overriding-columns-format)
3357 (org-set-local 'org-agenda-overriding-columns-format
3358 org-agenda-overriding-columns-format))
3359 (if (and (boundp 'org-agenda-view-columns-initially)
3360 org-agenda-view-columns-initially)
3361 (org-agenda-columns))
3362 (when org-agenda-fontify-priorities
3363 (org-agenda-fontify-priorities))
3364 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3365 (org-agenda-dim-blocked-tasks))
3366 (org-agenda-mark-clocking-task)
3367 (when org-agenda-entry-text-mode
3368 (org-agenda-entry-text-hide)
3369 (org-agenda-entry-text-show))
3370 (if (functionp 'org-habit-insert-consistency-graphs)
3371 (org-habit-insert-consistency-graphs))
3372 (run-hooks 'org-finalize-agenda-hook)
3373 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3374 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3375 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3376 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3377 (org-agenda-filter-apply org-agenda-category-filter 'category))
3378 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
3381 (defun org-agenda-mark-clocking-task ()
3382 "Mark the current clock entry in the agenda if it is present."
3383 (mapc (lambda (o)
3384 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3385 (delete-overlay o)))
3386 (overlays-in (point-min) (point-max)))
3387 (when (marker-buffer org-clock-hd-marker)
3388 (save-excursion
3389 (goto-char (point-min))
3390 (let (s ov)
3391 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3392 (goto-char s)
3393 (when (equal (org-get-at-bol 'org-hd-marker)
3394 org-clock-hd-marker)
3395 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3396 (overlay-put ov 'type 'org-agenda-clocking)
3397 (overlay-put ov 'face 'org-agenda-clocking)
3398 (overlay-put ov 'help-echo
3399 "The clock is running in this item")))))))
3401 (defun org-agenda-fontify-priorities ()
3402 "Make highest priority lines bold, and lowest italic."
3403 (interactive)
3404 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3405 (delete-overlay o)))
3406 (overlays-in (point-min) (point-max)))
3407 (save-excursion
3408 (let ((inhibit-read-only t)
3409 b e p ov h l)
3410 (goto-char (point-min))
3411 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3412 (setq h (or (get-char-property (point) 'org-highest-priority)
3413 org-highest-priority)
3414 l (or (get-char-property (point) 'org-lowest-priority)
3415 org-lowest-priority)
3416 p (string-to-char (match-string 1))
3417 b (match-beginning 0)
3418 e (if (eq org-agenda-fontify-priorities 'cookies)
3419 (match-end 0)
3420 (point-at-eol))
3421 ov (make-overlay b e))
3422 (overlay-put
3423 ov 'face
3424 (cond ((org-face-from-face-or-color
3425 'priority nil
3426 (cdr (assoc p org-priority-faces))))
3427 ((and (listp org-agenda-fontify-priorities)
3428 (org-face-from-face-or-color
3429 'priority nil
3430 (cdr (assoc p org-agenda-fontify-priorities)))))
3431 ((equal p l) 'italic)
3432 ((equal p h) 'bold)))
3433 (overlay-put ov 'org-type 'org-priority)))))
3435 (defun org-agenda-dim-blocked-tasks ()
3436 "Dim currently blocked TODO's in the agenda display."
3437 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3438 (delete-overlay o)))
3439 (overlays-in (point-min) (point-max)))
3440 (save-excursion
3441 (let ((inhibit-read-only t)
3442 (org-depend-tag-blocked nil)
3443 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3444 org-blocked-by-checkboxes
3445 invis1 b e p ov h l)
3446 (goto-char (point-min))
3447 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3448 (and pos (goto-char (1+ pos))))
3449 (setq org-blocked-by-checkboxes nil invis1 invis)
3450 (let ((marker (org-get-at-bol 'org-hd-marker)))
3451 (when (and marker
3452 (with-current-buffer (marker-buffer marker)
3453 (save-excursion (goto-char marker)
3454 (org-entry-blocked-p))))
3455 (if org-blocked-by-checkboxes (setq invis1 nil))
3456 (setq b (if invis1
3457 (max (point-min) (1- (point-at-bol)))
3458 (point-at-bol))
3459 e (point-at-eol)
3460 ov (make-overlay b e))
3461 (if invis1
3462 (overlay-put ov 'invisible t)
3463 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3464 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3466 (defvar org-agenda-skip-function nil
3467 "Function to be called at each match during agenda construction.
3468 If this function returns nil, the current match should not be skipped.
3469 Otherwise, the function must return a position from where the search
3470 should be continued.
3471 This may also be a Lisp form, it will be evaluated.
3472 Never set this variable using `setq' or so, because then it will apply
3473 to all future agenda commands. If you do want a global skipping condition,
3474 use the option `org-agenda-skip-function-global' instead.
3475 The correct usage for `org-agenda-skip-function' is to bind it with
3476 `let' to scope it dynamically into the agenda-constructing command.
3477 A good way to set it is through options in `org-agenda-custom-commands'.")
3479 (defun org-agenda-skip ()
3480 "Throw to `:skip' in places that should be skipped.
3481 Also moves point to the end of the skipped region, so that search can
3482 continue from there."
3483 (let ((p (point-at-bol)) to)
3484 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3485 (get-text-property p :org-archived)
3486 (org-end-of-subtree t)
3487 (throw :skip t))
3488 (and org-agenda-skip-comment-trees
3489 (get-text-property p :org-comment)
3490 (org-end-of-subtree t)
3491 (throw :skip t))
3492 (if (equal (char-after p) ?#) (throw :skip t))
3493 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3494 (org-agenda-skip-eval org-agenda-skip-function)))
3495 (goto-char to)
3496 (throw :skip t))))
3498 (defun org-agenda-skip-eval (form)
3499 "If FORM is a function or a list, call (or eval) is and return result.
3500 `save-excursion' and `save-match-data' are wrapped around the call, so point
3501 and match data are returned to the previous state no matter what these
3502 functions do."
3503 (let (fp)
3504 (and form
3505 (or (setq fp (functionp form))
3506 (consp form))
3507 (save-excursion
3508 (save-match-data
3509 (if fp
3510 (funcall form)
3511 (eval form)))))))
3513 (defvar org-agenda-markers nil
3514 "List of all currently active markers created by `org-agenda'.")
3515 (defvar org-agenda-last-marker-time (org-float-time)
3516 "Creation time of the last agenda marker.")
3518 (defun org-agenda-new-marker (&optional pos)
3519 "Return a new agenda marker.
3520 Org-mode keeps a list of these markers and resets them when they are
3521 no longer in use."
3522 (let ((m (copy-marker (or pos (point)))))
3523 (setq org-agenda-last-marker-time (org-float-time))
3524 (if org-agenda-buffer
3525 (with-current-buffer org-agenda-buffer
3526 (push m org-agenda-markers))
3527 (push m org-agenda-markers))
3530 (defun org-agenda-reset-markers ()
3531 "Reset markers created by `org-agenda'."
3532 (while org-agenda-markers
3533 (move-marker (pop org-agenda-markers) nil)))
3535 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3536 "Save relative positions of markers in region.
3537 This check for agenda markers in all agenda buffers currently active."
3538 (dolist (buf (buffer-list))
3539 (with-current-buffer buf
3540 (when (eq major-mode 'org-agenda-mode)
3541 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3542 org-agenda-markers)))))
3544 ;;; Entry text mode
3546 (defun org-agenda-entry-text-show-here ()
3547 "Add some text from the entry as context to the current line."
3548 (let (m txt o)
3549 (setq m (org-get-at-bol 'org-hd-marker))
3550 (unless (marker-buffer m)
3551 (error "No marker points to an entry here"))
3552 (setq txt (concat "\n" (org-no-properties
3553 (org-agenda-get-some-entry-text
3554 m org-agenda-entry-text-maxlines " > "))))
3555 (when (string-match "\\S-" txt)
3556 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3557 (overlay-put o 'evaporate t)
3558 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3559 (overlay-put o 'after-string txt))))
3561 (defun org-agenda-entry-text-show ()
3562 "Add entry context for all agenda lines."
3563 (interactive)
3564 (save-excursion
3565 (goto-char (point-max))
3566 (beginning-of-line 1)
3567 (while (not (bobp))
3568 (when (org-get-at-bol 'org-hd-marker)
3569 (org-agenda-entry-text-show-here))
3570 (beginning-of-line 0))))
3572 (defun org-agenda-entry-text-hide ()
3573 "Remove any shown entry context."
3574 (delq nil
3575 (mapcar (lambda (o)
3576 (if (eq (overlay-get o 'org-overlay-type)
3577 'agenda-entry-content)
3578 (progn (delete-overlay o) t)))
3579 (overlays-in (point-min) (point-max)))))
3581 (defun org-agenda-get-day-face (date)
3582 "Return the face DATE should be displayed with."
3583 (or (and (functionp org-agenda-day-face-function)
3584 (funcall org-agenda-day-face-function date))
3585 (cond ((org-agenda-todayp date)
3586 'org-agenda-date-today)
3587 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3588 'org-agenda-date-weekend)
3589 (t 'org-agenda-date))))
3591 ;;; Agenda timeline
3593 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3595 (defun org-timeline (&optional dotodo)
3596 "Show a time-sorted view of the entries in the current org file.
3597 Only entries with a time stamp of today or later will be listed. With
3598 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3599 under the current date.
3600 If the buffer contains an active region, only check the region for
3601 dates."
3602 (interactive "P")
3603 (let* ((dopast t)
3604 (org-agenda-show-log-scoped org-agenda-show-log)
3605 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3606 (current-buffer))))
3607 (date (calendar-current-date))
3608 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3609 (end (if (org-region-active-p) (region-end) (point-max)))
3610 (day-numbers (org-get-all-dates
3611 beg end 'no-ranges
3612 t org-agenda-show-log-scoped ; always include today
3613 org-timeline-show-empty-dates))
3614 (org-deadline-warning-days 0)
3615 (org-agenda-only-exact-dates t)
3616 (today (org-today))
3617 (past t)
3618 args
3619 s e rtn d emptyp)
3620 (setq org-agenda-redo-command
3621 (list 'progn
3622 (list 'org-switch-to-buffer-other-window (current-buffer))
3623 (list 'org-timeline (list 'quote dotodo))))
3624 (if (not dopast)
3625 ;; Remove past dates from the list of dates.
3626 (setq day-numbers (delq nil (mapcar (lambda(x)
3627 (if (>= x today) x nil))
3628 day-numbers))))
3629 (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3630 (org-compile-prefix-format 'timeline)
3631 (org-set-sorting-strategy 'timeline)
3632 (if org-agenda-show-log-scoped (push :closed args))
3633 (push :timestamp args)
3634 (push :deadline args)
3635 (push :scheduled args)
3636 (push :sexp args)
3637 (if dotodo (push :todo args))
3638 (insert "Timeline of file " entry "\n")
3639 (add-text-properties (point-min) (point)
3640 (list 'face 'org-agenda-structure))
3641 (org-agenda-mark-header-line (point-min))
3642 (while (setq d (pop day-numbers))
3643 (if (and (listp d) (eq (car d) :omitted))
3644 (progn
3645 (setq s (point))
3646 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3647 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3648 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3649 (if (and (>= d today)
3650 dopast
3651 past)
3652 (progn
3653 (setq past nil)
3654 (insert (make-string 79 ?-) "\n")))
3655 (setq date (calendar-gregorian-from-absolute d))
3656 (setq s (point))
3657 (setq rtn (and (not emptyp)
3658 (apply 'org-agenda-get-day-entries entry
3659 date args)))
3660 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3661 (progn
3662 (insert
3663 (if (stringp org-agenda-format-date)
3664 (format-time-string org-agenda-format-date
3665 (org-time-from-absolute date))
3666 (funcall org-agenda-format-date date))
3667 "\n")
3668 (put-text-property s (1- (point)) 'face
3669 (org-agenda-get-day-face date))
3670 (put-text-property s (1- (point)) 'org-date-line t)
3671 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3672 (if (equal d today)
3673 (put-text-property s (1- (point)) 'org-today t))
3674 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3675 (put-text-property s (1- (point)) 'day d)))))
3676 (goto-char (point-min))
3677 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3678 (point-min)))
3679 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3680 (org-finalize-agenda)
3681 (setq buffer-read-only t)))
3683 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3684 "Return a list of all relevant day numbers from BEG to END buffer positions.
3685 If NO-RANGES is non-nil, include only the start and end dates of a range,
3686 not every single day in the range. If FORCE-TODAY is non-nil, make
3687 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3688 inactive time stamps (those in square brackets) are included.
3689 When EMPTY is non-nil, also include days without any entries."
3690 (let ((re (concat
3691 (if pre-re pre-re "")
3692 (if inactive org-ts-regexp-both org-ts-regexp)))
3693 dates dates1 date day day1 day2 ts1 ts2 pos)
3694 (if force-today
3695 (setq dates (list (org-today))))
3696 (save-excursion
3697 (goto-char beg)
3698 (while (re-search-forward re end t)
3699 (setq day (time-to-days (org-time-string-to-time
3700 (substring (match-string 1) 0 10)
3701 (current-buffer) (match-beginning 0))))
3702 (or (memq day dates) (push day dates)))
3703 (unless no-ranges
3704 (goto-char beg)
3705 (while (re-search-forward org-tr-regexp end t)
3706 (setq pos (match-beginning 0))
3707 (setq ts1 (substring (match-string 1) 0 10)
3708 ts2 (substring (match-string 2) 0 10)
3709 day1 (time-to-days (org-time-string-to-time
3710 ts1 (current-buffer) pos))
3711 day2 (time-to-days (org-time-string-to-time
3712 ts2 (current-buffer) pos)))
3713 (while (< (setq day1 (1+ day1)) day2)
3714 (or (memq day1 dates) (push day1 dates)))))
3715 (setq dates (sort dates '<))
3716 (when empty
3717 (while (setq day (pop dates))
3718 (setq day2 (car dates))
3719 (push day dates1)
3720 (when (and day2 empty)
3721 (if (or (eq empty t)
3722 (and (numberp empty) (<= (- day2 day) empty)))
3723 (while (< (setq day (1+ day)) day2)
3724 (push (list day) dates1))
3725 (push (cons :omitted (- day2 day)) dates1))))
3726 (setq dates (nreverse dates1)))
3727 dates)))
3729 ;;; Agenda Daily/Weekly
3731 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3732 "Start day for the agenda view.
3733 Custom commands can set this variable in the options section.")
3734 (defvar org-starting-day nil) ; local variable in the agenda buffer
3735 (defvar org-agenda-current-span nil
3736 "The current span used in the agenda view.") ; local variable in the agenda buffer
3737 (defvar org-arg-loc nil) ; local variable
3739 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3740 "List of types searched for when creating the daily/weekly agenda.
3741 This variable is a list of symbols that controls the types of
3742 items that appear in the daily/weekly agenda. Allowed symbols in this
3743 list are are
3745 :timestamp List items containing a date stamp or date range matching
3746 the selected date. This includes sexp entries in
3747 angular brackets.
3749 :sexp List entries resulting from plain diary-like sexps.
3751 :deadline List deadline due on that date. When the date is today,
3752 also list any deadlines past due, or due within
3753 `org-deadline-warning-days'. `:deadline' must appear before
3754 `:scheduled' if the setting of
3755 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3756 any effect.
3758 :scheduled List all items which are scheduled for the given date.
3759 The diary for *today* also contains items which were
3760 scheduled earlier and are not yet marked DONE.
3762 By default, all four types are turned on.
3764 Never set this variable globally using `setq', because then it
3765 will apply to all future agenda commands. Instead, bind it with
3766 `let' to scope it dynamically into the agenda-constructing
3767 command. A good way to set it is through options in
3768 `org-agenda-custom-commands'. For a more flexible (though
3769 somewhat less efficient) way of determining what is included in
3770 the daily/weekly agenda, see `org-agenda-skip-function'.")
3772 ;;;###autoload
3773 (defun org-agenda-list (&optional arg start-day span)
3774 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3775 The view will be for the current day or week, but from the overview buffer
3776 you will be able to go to other days/weeks.
3778 With a numeric prefix argument in an interactive call, the agenda will
3779 span ARG days. Lisp programs should instead specify SPAN to change
3780 the number of days. SPAN defaults to `org-agenda-span'.
3782 START-DAY defaults to TODAY, or to the most recent match for the weekday
3783 given in `org-agenda-start-on-weekday'."
3784 (interactive "P")
3785 (if (and (integerp arg) (> arg 0))
3786 (setq span arg arg nil))
3787 (org-prepare-agenda "Day/Week")
3788 (setq start-day (or start-day org-agenda-start-day))
3789 (if org-agenda-overriding-arguments
3790 (setq arg (car org-agenda-overriding-arguments)
3791 start-day (nth 1 org-agenda-overriding-arguments)
3792 span (nth 2 org-agenda-overriding-arguments)))
3793 (if (stringp start-day)
3794 ;; Convert to an absolute day number
3795 (setq start-day (time-to-days (org-read-date nil t start-day))))
3796 (setq org-agenda-last-arguments (list arg start-day span))
3797 (org-compile-prefix-format 'agenda)
3798 (org-set-sorting-strategy 'agenda)
3799 (let* ((span (org-agenda-ndays-to-span
3800 (or span org-agenda-ndays org-agenda-span)))
3801 (today (org-today))
3802 (sd (or start-day today))
3803 (ndays (org-agenda-span-to-ndays span sd))
3804 (org-agenda-start-on-weekday
3805 (if (eq ndays 7)
3806 org-agenda-start-on-weekday))
3807 (thefiles (org-agenda-files nil 'ifmode))
3808 (files thefiles)
3809 (start (if (or (null org-agenda-start-on-weekday)
3810 (< ndays 7))
3812 (let* ((nt (calendar-day-of-week
3813 (calendar-gregorian-from-absolute sd)))
3814 (n1 org-agenda-start-on-weekday)
3815 (d (- nt n1)))
3816 (- sd (+ (if (< d 0) 7 0) d)))))
3817 (day-numbers (list start))
3818 (day-cnt 0)
3819 (inhibit-redisplay (not debug-on-error))
3820 (org-agenda-show-log-scoped org-agenda-show-log)
3821 s e rtn rtnall file date d start-pos end-pos todayp
3822 clocktable-start clocktable-end filter)
3823 (setq org-agenda-redo-command
3824 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3825 (dotimes (n (1- ndays))
3826 (push (1+ (car day-numbers)) day-numbers))
3827 (setq day-numbers (nreverse day-numbers))
3828 (setq clocktable-start (car day-numbers)
3829 clocktable-end (1+ (or (org-last day-numbers) 0)))
3830 (org-set-local 'org-starting-day (car day-numbers))
3831 (org-set-local 'org-arg-loc arg)
3832 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3833 (unless org-agenda-compact-blocks
3834 (let* ((d1 (car day-numbers))
3835 (d2 (org-last day-numbers))
3836 (w1 (org-days-to-iso-week d1))
3837 (w2 (org-days-to-iso-week d2)))
3838 (setq s (point))
3839 (if org-agenda-overriding-header
3840 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3841 nil 'face 'org-agenda-structure) "\n")
3842 (insert (org-agenda-span-name span)
3843 "-agenda"
3844 (if (< (- d2 d1) 350)
3845 (if (= w1 w2)
3846 (format " (W%02d)" w1)
3847 (format " (W%02d-W%02d)" w1 w2))
3849 ":\n")))
3850 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3851 'org-date-line t))
3852 (org-agenda-mark-header-line s))
3853 (while (setq d (pop day-numbers))
3854 (setq date (calendar-gregorian-from-absolute d)
3855 s (point))
3856 (if (or (setq todayp (= d today))
3857 (and (not start-pos) (= d sd)))
3858 (setq start-pos (point))
3859 (if (and start-pos (not end-pos))
3860 (setq end-pos (point))))
3861 (setq files thefiles
3862 rtnall nil)
3863 (while (setq file (pop files))
3864 (catch 'nextfile
3865 (org-check-agenda-file file)
3866 (let ((org-agenda-entry-types org-agenda-entry-types))
3867 (unless org-agenda-include-deadlines
3868 (setq org-agenda-entry-types
3869 (delq :deadline org-agenda-entry-types)))
3870 (cond
3871 ((memq org-agenda-show-log-scoped '(only clockcheck))
3872 (setq rtn (org-agenda-get-day-entries
3873 file date :closed)))
3874 (org-agenda-show-log-scoped
3875 (setq rtn (apply 'org-agenda-get-day-entries
3876 file date
3877 (append '(:closed) org-agenda-entry-types))))
3879 (setq rtn (apply 'org-agenda-get-day-entries
3880 file date
3881 org-agenda-entry-types)))))
3882 (setq rtnall (append rtnall rtn)))) ;; all entries
3883 (if org-agenda-include-diary
3884 (let ((org-agenda-search-headline-for-time t))
3885 (require 'diary-lib)
3886 (setq rtn (org-get-entries-from-diary date))
3887 (setq rtnall (append rtnall rtn))))
3888 (if (or rtnall org-agenda-show-all-dates)
3889 (progn
3890 (setq day-cnt (1+ day-cnt))
3891 (insert
3892 (if (stringp org-agenda-format-date)
3893 (format-time-string org-agenda-format-date
3894 (org-time-from-absolute date))
3895 (funcall org-agenda-format-date date))
3896 "\n")
3897 (put-text-property s (1- (point)) 'face
3898 (org-agenda-get-day-face date))
3899 (put-text-property s (1- (point)) 'org-date-line t)
3900 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3901 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3902 (when todayp
3903 (put-text-property s (1- (point)) 'org-today t))
3904 (setq rtnall
3905 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
3906 (if rtnall (insert ;; all entries
3907 (org-finalize-agenda-entries rtnall)
3908 "\n"))
3909 (put-text-property s (1- (point)) 'day d)
3910 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3911 (when (and org-agenda-clockreport-mode clocktable-start)
3912 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3913 ;; the above line is to ensure the restricted range!
3914 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3915 tbl)
3916 (setq p (org-plist-delete p :block))
3917 (setq p (plist-put p :tstart clocktable-start))
3918 (setq p (plist-put p :tend clocktable-end))
3919 (setq p (plist-put p :scope 'agenda))
3920 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3921 (setq filter (or org-agenda-tag-filter-while-redo
3922 (get 'org-agenda-tag-filter :preset-filter))))
3923 (setq p (plist-put p :tags (mapconcat (lambda (x)
3924 (if (string-match "[<>=]" x)
3927 filter ""))))
3928 (setq tbl (apply 'org-get-clocktable p))
3929 (insert tbl)))
3930 (goto-char (point-min))
3931 (or org-agenda-multi (org-fit-agenda-window))
3932 (unless (and (pos-visible-in-window-p (point-min))
3933 (pos-visible-in-window-p (point-max)))
3934 (goto-char (1- (point-max)))
3935 (recenter -1)
3936 (if (not (pos-visible-in-window-p (or start-pos 1)))
3937 (progn
3938 (goto-char (or start-pos 1))
3939 (recenter 1))))
3940 (goto-char (or start-pos 1))
3941 (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
3942 (if (eq org-agenda-show-log-scoped 'clockcheck)
3943 (org-agenda-show-clocking-issues))
3944 (org-finalize-agenda)
3945 (setq buffer-read-only t)
3946 (message "")))
3948 (defun org-agenda-ndays-to-span (n)
3949 "Return a span symbol for a span of N days, or N if none matches."
3950 (cond ((symbolp n) n)
3951 ((= n 1) 'day)
3952 ((= n 7) 'week)
3953 (t n)))
3955 (defun org-agenda-span-to-ndays (span start-day)
3956 "Return ndays from SPAN starting at START-DAY."
3957 (cond ((numberp span) span)
3958 ((eq span 'day) 1)
3959 ((eq span 'week) 7)
3960 ((eq span 'month)
3961 (let ((date (calendar-gregorian-from-absolute start-day)))
3962 (calendar-last-day-of-month (car date) (caddr date))))
3963 ((eq span 'year)
3964 (let ((date (calendar-gregorian-from-absolute start-day)))
3965 (if (calendar-leap-year-p (caddr date)) 366 365)))))
3967 (defun org-agenda-span-name (span)
3968 "Return a SPAN name."
3969 (if (null span)
3971 (if (symbolp span)
3972 (capitalize (symbol-name span))
3973 (format "%d days" span))))
3975 ;;; Agenda word search
3977 (defvar org-agenda-search-history nil)
3978 (defvar org-todo-only nil)
3980 (defvar org-search-syntax-table nil
3981 "Special syntax table for org-mode search.
3982 In this table, we have single quotes not as word constituents, to
3983 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
3985 (defvar org-mode-syntax-table) ; From org.el
3986 (defun org-search-syntax-table ()
3987 (unless org-search-syntax-table
3988 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
3989 (modify-syntax-entry ?' "." org-search-syntax-table)
3990 (modify-syntax-entry ?` "." org-search-syntax-table))
3991 org-search-syntax-table)
3993 (defvar org-agenda-last-search-view-search-was-boolean nil)
3995 ;;;###autoload
3996 (defun org-search-view (&optional todo-only string edit-at)
3997 "Show all entries that contain a phrase or words or regular expressions.
3999 With optional prefix argument TODO-ONLY, only consider entries that are
4000 TODO entries. The argument STRING can be used to pass a default search
4001 string into this function. If EDIT-AT is non-nil, it means that the
4002 user should get a chance to edit this string, with cursor at position
4003 EDIT-AT.
4005 The search string can be viewed either as a phrase that should be found as
4006 is, or it can be broken into a number of snippets, each of which must match
4007 in a Boolean way to select an entry. The default depends on the variable
4008 `org-agenda-search-view-always-boolean'.
4009 Even if this is turned off (the default) you can always switch to
4010 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4012 The default is a direct search of the whole phrase, where each space in
4013 the search string can expand to an arbitrary amount of whitespace,
4014 including newlines.
4016 If using a Boolean search, the search string is split on whitespace and
4017 each snippet is searched separately, with logical AND to select an entry.
4018 Words prefixed with a minus must *not* occur in the entry. Words without
4019 a prefix or prefixed with a plus must occur in the entry. Matching is
4020 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4021 match whole words, not parts of a word) if
4022 `org-agenda-search-view-force-full-words' is set (default is nil).
4024 Boolean search snippets enclosed by curly braces are interpreted as
4025 regular expressions that must or (when preceded with \"-\") must not
4026 match in the entry. Snippets enclosed into double quotes will be taken
4027 as a whole, to include whitespace.
4029 - If the search string starts with an asterisk, search only in headlines.
4030 - If (possibly after the leading star) the search string starts with an
4031 exclamation mark, this also means to look at TODO entries only, an effect
4032 that can also be achieved with a prefix argument.
4033 - If (possibly after star and exclamation mark) the search string starts
4034 with a colon, this will mean that the (non-regexp) snippets of the
4035 Boolean search must match as full words.
4037 This command searches the agenda files, and in addition the files listed
4038 in `org-agenda-text-search-extra-files'."
4039 (interactive "P")
4040 (org-prepare-agenda "SEARCH")
4041 (org-compile-prefix-format 'search)
4042 (org-set-sorting-strategy 'search)
4043 (let* ((props (list 'face nil
4044 'done-face 'org-agenda-done
4045 'org-not-done-regexp org-not-done-regexp
4046 'org-todo-regexp org-todo-regexp
4047 'org-complex-heading-regexp org-complex-heading-regexp
4048 'mouse-face 'highlight
4049 'help-echo (format "mouse-2 or RET jump to location")))
4050 (full-words org-agenda-search-view-force-full-words)
4051 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4052 regexp rtn rtnall files file pos
4053 marker category category-pos tags c neg re boolean
4054 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4055 (unless (and (not edit-at)
4056 (stringp string)
4057 (string-match "\\S-" string))
4058 (setq string (read-string
4059 (if org-agenda-search-view-always-boolean
4060 "[+-]Word/{Regexp} ...: "
4061 "Phrase, or [+-]Word/{Regexp} ...: ")
4062 (cond
4063 ((integerp edit-at) (cons string edit-at))
4064 (edit-at string))
4065 'org-agenda-search-history)))
4066 (org-set-local 'org-todo-only todo-only)
4067 (setq org-agenda-redo-command
4068 (list 'org-search-view (if todo-only t nil) string
4069 '(if current-prefix-arg 1 nil)))
4070 (setq org-agenda-query-string string)
4072 (if (equal (string-to-char string) ?*)
4073 (setq hdl-only t
4074 words (substring string 1))
4075 (setq words string))
4076 (when (equal (string-to-char words) ?!)
4077 (setq todo-only t
4078 words (substring words 1)))
4079 (when (equal (string-to-char words) ?:)
4080 (setq full-words t
4081 words (substring words 1)))
4082 (if (or org-agenda-search-view-always-boolean
4083 (member (string-to-char words) '(?- ?+ ?\{)))
4084 (setq boolean t))
4085 (setq words (org-split-string words))
4086 (let (www w)
4087 (while (setq w (pop words))
4088 (while (and (string-match "\\\\\\'" w) words)
4089 (setq w (concat (substring w 0 -1) " " (pop words))))
4090 (push w www))
4091 (setq words (nreverse www) www nil)
4092 (while (setq w (pop words))
4093 (when (and (string-match "\\`[-+]?{" w)
4094 (not (string-match "}\\'" w)))
4095 (while (and words (not (string-match "}\\'" (car words))))
4096 (setq w (concat w " " (pop words))))
4097 (setq w (concat w " " (pop words))))
4098 (push w www))
4099 (setq words (nreverse www)))
4100 (setq org-agenda-last-search-view-search-was-boolean boolean)
4101 (when boolean
4102 (let (wds w)
4103 (while (setq w (pop words))
4104 (if (or (equal (substring w 0 1) "\"")
4105 (and (> (length w) 1)
4106 (member (substring w 0 1) '("+" "-"))
4107 (equal (substring w 1 2) "\"")))
4108 (while (and words (not (equal (substring w -1) "\"")))
4109 (setq w (concat w " " (pop words)))))
4110 (and (string-match "\\`\\([-+]?\\)\"" w)
4111 (setq w (replace-match "\\1" nil nil w)))
4112 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4113 (push w wds))
4114 (setq words (nreverse wds))))
4115 (if boolean
4116 (mapc (lambda (w)
4117 (setq c (string-to-char w))
4118 (if (equal c ?-)
4119 (setq neg t w (substring w 1))
4120 (if (equal c ?+)
4121 (setq neg nil w (substring w 1))
4122 (setq neg nil)))
4123 (if (string-match "\\`{.*}\\'" w)
4124 (setq re (substring w 1 -1))
4125 (if full-words
4126 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4127 (setq re (regexp-quote (downcase w)))))
4128 (if neg (push re regexps-) (push re regexps+)))
4129 words)
4130 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4131 regexps+))
4132 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4133 (if (not regexps+)
4134 (setq regexp org-outline-regexp-bol)
4135 (setq regexp (pop regexps+))
4136 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4137 regexp))))
4138 (setq files (org-agenda-files nil 'ifmode))
4139 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4140 (pop org-agenda-text-search-extra-files)
4141 (setq files (org-add-archive-files files)))
4142 (setq files (append files org-agenda-text-search-extra-files)
4143 rtnall nil)
4144 (while (setq file (pop files))
4145 (setq ee nil)
4146 (catch 'nextfile
4147 (org-check-agenda-file file)
4148 (setq buffer (if (file-exists-p file)
4149 (org-get-agenda-file-buffer file)
4150 (error "No such file %s" file)))
4151 (if (not buffer)
4152 ;; If file does not exist, make sure an error message is sent
4153 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4154 file))))
4155 (with-current-buffer buffer
4156 (with-syntax-table (org-search-syntax-table)
4157 (unless (derived-mode-p 'org-mode)
4158 (error "Agenda file %s is not in `org-mode'" file))
4159 (let ((case-fold-search t))
4160 (save-excursion
4161 (save-restriction
4162 (if org-agenda-restrict
4163 (narrow-to-region org-agenda-restrict-begin
4164 org-agenda-restrict-end)
4165 (widen))
4166 (goto-char (point-min))
4167 (unless (or (org-at-heading-p)
4168 (outline-next-heading))
4169 (throw 'nextfile t))
4170 (goto-char (max (point-min) (1- (point))))
4171 (while (re-search-forward regexp nil t)
4172 (org-back-to-heading t)
4173 (skip-chars-forward "* ")
4174 (setq beg (point-at-bol)
4175 beg1 (point)
4176 end (progn (outline-next-heading) (point)))
4177 (catch :skip
4178 (goto-char beg)
4179 (org-agenda-skip)
4180 (setq str (buffer-substring-no-properties
4181 (point-at-bol)
4182 (if hdl-only (point-at-eol) end)))
4183 (mapc (lambda (wr) (when (string-match wr str)
4184 (goto-char (1- end))
4185 (throw :skip t)))
4186 regexps-)
4187 (mapc (lambda (wr) (unless (string-match wr str)
4188 (goto-char (1- end))
4189 (throw :skip t)))
4190 (if todo-only
4191 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4192 regexps+)
4193 regexps+))
4194 (goto-char beg)
4195 (setq marker (org-agenda-new-marker (point))
4196 category (org-get-category)
4197 category-pos (get-text-property (point) 'org-category-position)
4198 tags (org-get-tags-at (point))
4199 txt (org-agenda-format-item
4201 (buffer-substring-no-properties
4202 beg1 (point-at-eol))
4203 category tags))
4204 (org-add-props txt props
4205 'org-marker marker 'org-hd-marker marker
4206 'org-todo-regexp org-todo-regexp
4207 'org-complex-heading-regexp org-complex-heading-regexp
4208 'priority 1000 'org-category category
4209 'org-category-position category-pos
4210 'type "search")
4211 (push txt ee)
4212 (goto-char (1- end))))))))))
4213 (setq rtn (nreverse ee))
4214 (setq rtnall (append rtnall rtn)))
4215 (if org-agenda-overriding-header
4216 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4217 nil 'face 'org-agenda-structure) "\n")
4218 (insert "Search words: ")
4219 (add-text-properties (point-min) (1- (point))
4220 (list 'face 'org-agenda-structure))
4221 (setq pos (point))
4222 (insert string "\n")
4223 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4224 (setq pos (point))
4225 (unless org-agenda-multi
4226 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4227 (add-text-properties pos (1- (point))
4228 (list 'face 'org-agenda-structure))))
4229 (org-agenda-mark-header-line (point-min))
4230 (when rtnall
4231 (insert (org-finalize-agenda-entries rtnall) "\n"))
4232 (goto-char (point-min))
4233 (or org-agenda-multi (org-fit-agenda-window))
4234 (add-text-properties (point-min) (point-max) '(org-agenda-type search))
4235 (org-finalize-agenda)
4236 (setq buffer-read-only t)))
4238 ;;; Agenda TODO list
4240 (defvar org-select-this-todo-keyword nil)
4241 (defvar org-last-arg nil)
4243 ;;;###autoload
4244 (defun org-todo-list (arg)
4245 "Show all (not done) TODO entries from all agenda file in a single list.
4246 The prefix arg can be used to select a specific TODO keyword and limit
4247 the list to these. When using \\[universal-argument], you will be prompted
4248 for a keyword. A numeric prefix directly selects the Nth keyword in
4249 `org-todo-keywords-1'."
4250 (interactive "P")
4251 (org-prepare-agenda "TODO")
4252 (org-compile-prefix-format 'todo)
4253 (org-set-sorting-strategy 'todo)
4254 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4255 (let* ((today (org-today))
4256 (date (calendar-gregorian-from-absolute today))
4257 (kwds org-todo-keywords-for-agenda)
4258 (completion-ignore-case t)
4259 (org-select-this-todo-keyword
4260 (if (stringp arg) arg
4261 (and arg (integerp arg) (> arg 0)
4262 (nth (1- arg) kwds))))
4263 rtn rtnall files file pos)
4264 (when (equal arg '(4))
4265 (setq org-select-this-todo-keyword
4266 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4267 (mapcar 'list kwds) nil nil)))
4268 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4269 (org-set-local 'org-last-arg arg)
4270 (setq org-agenda-redo-command
4271 '(org-todo-list (or current-prefix-arg org-last-arg)))
4272 (setq files (org-agenda-files nil 'ifmode)
4273 rtnall nil)
4274 (while (setq file (pop files))
4275 (catch 'nextfile
4276 (org-check-agenda-file file)
4277 (setq rtn (org-agenda-get-day-entries file date :todo))
4278 (setq rtnall (append rtnall rtn))))
4279 (if org-agenda-overriding-header
4280 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4281 nil 'face 'org-agenda-structure) "\n")
4282 (insert "Global list of TODO items of type: ")
4283 (add-text-properties (point-min) (1- (point))
4284 (list 'face 'org-agenda-structure
4285 'short-heading
4286 (concat "ToDo: "
4287 (or org-select-this-todo-keyword "ALL"))))
4288 (org-agenda-mark-header-line (point-min))
4289 (setq pos (point))
4290 (insert (or org-select-this-todo-keyword "ALL") "\n")
4291 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4292 (setq pos (point))
4293 (unless org-agenda-multi
4294 (insert "Available with `N r': (0)ALL")
4295 (let ((n 0) s)
4296 (mapc (lambda (x)
4297 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4298 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4299 (insert "\n "))
4300 (insert " " s))
4301 kwds))
4302 (insert "\n"))
4303 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4304 (org-agenda-mark-header-line (point-min))
4305 (when rtnall
4306 (insert (org-finalize-agenda-entries rtnall) "\n"))
4307 (goto-char (point-min))
4308 (or org-agenda-multi (org-fit-agenda-window))
4309 (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
4310 (org-finalize-agenda)
4311 (setq buffer-read-only t)))
4313 ;;; Agenda tags match
4315 ;;;###autoload
4316 (defun org-tags-view (&optional todo-only match)
4317 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4318 The prefix arg TODO-ONLY limits the search to TODO entries."
4319 (interactive "P")
4320 (let* ((org-tags-match-list-sublevels
4321 org-tags-match-list-sublevels)
4322 (completion-ignore-case t)
4323 rtn rtnall files file pos matcher
4324 buffer)
4325 (when (and (stringp match) (not (string-match "\\S-" match)))
4326 (setq match nil))
4327 (setq matcher (org-make-tags-matcher match)
4328 match (car matcher) matcher (cdr matcher))
4329 (org-prepare-agenda (concat "TAGS " match))
4330 (org-compile-prefix-format 'tags)
4331 (org-set-sorting-strategy 'tags)
4332 (setq org-agenda-query-string match)
4333 (setq org-agenda-redo-command
4334 (list 'org-tags-view (list 'quote todo-only)
4335 (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
4336 (setq files (org-agenda-files nil 'ifmode)
4337 rtnall nil)
4338 (while (setq file (pop files))
4339 (catch 'nextfile
4340 (org-check-agenda-file file)
4341 (setq buffer (if (file-exists-p file)
4342 (org-get-agenda-file-buffer file)
4343 (error "No such file %s" file)))
4344 (if (not buffer)
4345 ;; If file does not exist, error message to agenda
4346 (setq rtn (list
4347 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4348 rtnall (append rtnall rtn))
4349 (with-current-buffer buffer
4350 (unless (derived-mode-p 'org-mode)
4351 (error "Agenda file %s is not in `org-mode'" file))
4352 (save-excursion
4353 (save-restriction
4354 (if org-agenda-restrict
4355 (narrow-to-region org-agenda-restrict-begin
4356 org-agenda-restrict-end)
4357 (widen))
4358 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4359 (setq rtnall (append rtnall rtn))))))))
4360 (if org-agenda-overriding-header
4361 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4362 nil 'face 'org-agenda-structure) "\n")
4363 (insert "Headlines with TAGS match: ")
4364 (add-text-properties (point-min) (1- (point))
4365 (list 'face 'org-agenda-structure
4366 'short-heading
4367 (concat "Match: " match)))
4368 (setq pos (point))
4369 (insert match "\n")
4370 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4371 (setq pos (point))
4372 (unless org-agenda-multi
4373 (insert "Press `C-u r' to search again with new search string\n"))
4374 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4375 (org-agenda-mark-header-line (point-min))
4376 (when rtnall
4377 (insert (org-finalize-agenda-entries rtnall) "\n"))
4378 (goto-char (point-min))
4379 (or org-agenda-multi (org-fit-agenda-window))
4380 (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
4381 (org-finalize-agenda)
4382 (setq buffer-read-only t)))
4384 ;;; Agenda Finding stuck projects
4386 (defvar org-agenda-skip-regexp nil
4387 "Regular expression used in skipping subtrees for the agenda.
4388 This is basically a temporary global variable that can be set and then
4389 used by user-defined selections using `org-agenda-skip-function'.")
4391 (defvar org-agenda-overriding-header nil
4392 "When set during agenda, todo and tags searches it replaces the header.
4393 This variable should not be set directly, but custom commands can bind it
4394 in the options section.")
4396 (defun org-agenda-skip-entry-when-regexp-matches ()
4397 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4398 If yes, it returns the end position of this entry, causing agenda commands
4399 to skip the entry but continuing the search in the subtree. This is a
4400 function that can be put into `org-agenda-skip-function' for the duration
4401 of a command."
4402 (let ((end (save-excursion (org-end-of-subtree t)))
4403 skip)
4404 (save-excursion
4405 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4406 (and skip end)))
4408 (defun org-agenda-skip-subtree-when-regexp-matches ()
4409 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4410 If yes, it returns the end position of this tree, causing agenda commands
4411 to skip this subtree. This is a function that can be put into
4412 `org-agenda-skip-function' for the duration of a command."
4413 (let ((end (save-excursion (org-end-of-subtree t)))
4414 skip)
4415 (save-excursion
4416 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4417 (and skip end)))
4419 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4420 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4421 If yes, it returns the end position of the current entry (NOT the tree),
4422 causing agenda commands to skip the entry but continuing the search in
4423 the subtree. This is a function that can be put into
4424 `org-agenda-skip-function' for the duration of a command. An important
4425 use of this function is for the stuck project list."
4426 (let ((end (save-excursion (org-end-of-subtree t)))
4427 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4428 skip)
4429 (save-excursion
4430 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4431 (and skip entry-end)))
4433 (defun org-agenda-skip-entry-if (&rest conditions)
4434 "Skip entry if any of CONDITIONS is true.
4435 See `org-agenda-skip-if' for details."
4436 (org-agenda-skip-if nil conditions))
4438 (defun org-agenda-skip-subtree-if (&rest conditions)
4439 "Skip entry if any of CONDITIONS is true.
4440 See `org-agenda-skip-if' for details."
4441 (org-agenda-skip-if t conditions))
4443 (defun org-agenda-skip-if (subtree conditions)
4444 "Checks current entity for CONDITIONS.
4445 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4446 the entry (i.e. the text before the next heading) is checked.
4448 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4449 from different tests. Valid conditions are:
4451 scheduled Check if there is a scheduled cookie
4452 notscheduled Check if there is no scheduled cookie
4453 deadline Check if there is a deadline
4454 notdeadline Check if there is no deadline
4455 timestamp Check if there is a timestamp (also deadline or scheduled)
4456 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4457 regexp Check if regexp matches
4458 notregexp Check if regexp does not match.
4459 todo Check if TODO keyword matches
4460 nottodo Check if TODO keyword does not match
4462 The regexp is taken from the conditions list, it must come right after
4463 the `regexp' or `notregexp' element.
4465 `todo' and `nottodo' accept as an argument a list of todo
4466 keywords, which may include \"*\" to match any todo keyword.
4468 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4470 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4472 Instead of a list, a keyword class may be given. For example:
4474 (org-agenda-skip-entry-if 'nottodo 'done)
4476 would skip entries that haven't been marked with any of \"DONE\"
4477 keywords. Possible classes are: `todo', `done', `any'.
4479 If any of these conditions is met, this function returns the end point of
4480 the entity, causing the search to continue from there. This is a function
4481 that can be put into `org-agenda-skip-function' for the duration of a command."
4482 (let (beg end m)
4483 (org-back-to-heading t)
4484 (setq beg (point)
4485 end (if subtree
4486 (progn (org-end-of-subtree t) (point))
4487 (progn (outline-next-heading) (1- (point)))))
4488 (goto-char beg)
4489 (and
4491 (and (memq 'scheduled conditions)
4492 (re-search-forward org-scheduled-time-regexp end t))
4493 (and (memq 'notscheduled conditions)
4494 (not (re-search-forward org-scheduled-time-regexp end t)))
4495 (and (memq 'deadline conditions)
4496 (re-search-forward org-deadline-time-regexp end t))
4497 (and (memq 'notdeadline conditions)
4498 (not (re-search-forward org-deadline-time-regexp end t)))
4499 (and (memq 'timestamp conditions)
4500 (re-search-forward org-ts-regexp end t))
4501 (and (memq 'nottimestamp conditions)
4502 (not (re-search-forward org-ts-regexp end t)))
4503 (and (setq m (memq 'regexp conditions))
4504 (stringp (nth 1 m))
4505 (re-search-forward (nth 1 m) end t))
4506 (and (setq m (memq 'notregexp conditions))
4507 (stringp (nth 1 m))
4508 (not (re-search-forward (nth 1 m) end t)))
4509 (and (or
4510 (setq m (memq 'nottodo conditions))
4511 (setq m (memq 'todo-unblocked conditions))
4512 (setq m (memq 'nottodo-unblocked conditions))
4513 (setq m (memq 'todo conditions)))
4514 (org-agenda-skip-if-todo m end)))
4515 end)))
4517 (defun org-agenda-skip-if-todo (args end)
4518 "Helper function for `org-agenda-skip-if', do not use it directly.
4519 ARGS is a list with first element either `todo', `nottodo',
4520 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4521 a list of TODO keywords, or a state symbol `todo' or `done' or
4522 `any'."
4523 (let ((kw (car args))
4524 (arg (cadr args))
4525 todo-wds todo-re)
4526 (setq todo-wds
4527 (org-uniquify
4528 (cond
4529 ((listp arg) ;; list of keywords
4530 (if (member "*" arg)
4531 (mapcar 'substring-no-properties org-todo-keywords-1)
4532 arg))
4533 ((symbolp arg) ;; keyword class name
4534 (cond
4535 ((eq arg 'todo)
4536 (org-delete-all org-done-keywords
4537 (mapcar 'substring-no-properties
4538 org-todo-keywords-1)))
4539 ((eq arg 'done) org-done-keywords)
4540 ((eq arg 'any)
4541 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4542 (setq todo-re
4543 (concat "^\\*+[ \t]+\\<\\("
4544 (mapconcat 'identity todo-wds "\\|")
4545 "\\)\\>"))
4546 (cond
4547 ((eq kw 'todo) (re-search-forward todo-re end t))
4548 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
4549 ((eq kw 'todo-unblocked)
4550 (catch 'unblocked
4551 (while (re-search-forward todo-re end t)
4552 (or (org-entry-blocked-p) (throw 'unblocked t)))
4553 nil))
4554 ((eq kw 'nottodo-unblocked)
4555 (catch 'unblocked
4556 (while (re-search-forward todo-re end t)
4557 (or (org-entry-blocked-p) (throw 'unblocked nil)))
4561 ;;;###autoload
4562 (defun org-agenda-list-stuck-projects (&rest ignore)
4563 "Create agenda view for projects that are stuck.
4564 Stuck projects are project that have no next actions. For the definitions
4565 of what a project is and how to check if it stuck, customize the variable
4566 `org-stuck-projects'."
4567 (interactive)
4568 (let* ((org-agenda-skip-function
4569 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4570 ;; We could have used org-agenda-skip-if here.
4571 (org-agenda-overriding-header
4572 (or org-agenda-overriding-header "List of stuck projects: "))
4573 (matcher (nth 0 org-stuck-projects))
4574 (todo (nth 1 org-stuck-projects))
4575 (todo-wds (if (member "*" todo)
4576 (progn
4577 (org-prepare-agenda-buffers (org-agenda-files
4578 nil 'ifmode))
4579 (org-delete-all
4580 org-done-keywords-for-agenda
4581 (copy-sequence org-todo-keywords-for-agenda)))
4582 todo))
4583 (todo-re (concat "^\\*+[ \t]+\\("
4584 (mapconcat 'identity todo-wds "\\|")
4585 "\\)\\>"))
4586 (tags (nth 2 org-stuck-projects))
4587 (tags-re (if (member "*" tags)
4588 (concat org-outline-regexp-bol
4589 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4590 (if tags
4591 (concat org-outline-regexp-bol
4592 ".*:\\("
4593 (mapconcat 'identity tags "\\|")
4594 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4595 (gen-re (nth 3 org-stuck-projects))
4596 (re-list
4597 (delq nil
4598 (list
4599 (if todo todo-re)
4600 (if tags tags-re)
4601 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4602 gen-re)))))
4603 (setq org-agenda-skip-regexp
4604 (if re-list
4605 (mapconcat 'identity re-list "\\|")
4606 (error "No information how to identify unstuck projects")))
4607 (org-tags-view nil matcher)
4608 (with-current-buffer org-agenda-buffer-name
4609 (setq org-agenda-redo-command
4610 '(org-agenda-list-stuck-projects
4611 (or current-prefix-arg org-last-arg))))))
4613 ;;; Diary integration
4615 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4616 (defvar diary-list-entries-hook)
4617 (defvar diary-time-regexp)
4618 (defun org-get-entries-from-diary (date)
4619 "Get the (Emacs Calendar) diary entries for DATE."
4620 (require 'diary-lib)
4621 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4622 (diary-display-hook '(fancy-diary-display))
4623 (diary-display-function 'fancy-diary-display)
4624 (pop-up-frames nil)
4625 (diary-list-entries-hook
4626 (cons 'org-diary-default-entry diary-list-entries-hook))
4627 (diary-file-name-prefix-function nil) ; turn this feature off
4628 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4629 entries
4630 (org-disable-agenda-to-diary t))
4631 (save-excursion
4632 (save-window-excursion
4633 (funcall (if (fboundp 'diary-list-entries)
4634 'diary-list-entries 'list-diary-entries)
4635 date 1)))
4636 (if (not (get-buffer diary-fancy-buffer))
4637 (setq entries nil)
4638 (with-current-buffer diary-fancy-buffer
4639 (setq buffer-read-only nil)
4640 (if (zerop (buffer-size))
4641 ;; No entries
4642 (setq entries nil)
4643 ;; Omit the date and other unnecessary stuff
4644 (org-agenda-cleanup-fancy-diary)
4645 ;; Add prefix to each line and extend the text properties
4646 (if (zerop (buffer-size))
4647 (setq entries nil)
4648 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4649 (setq entries
4650 (with-temp-buffer
4651 (insert entries) (goto-char (point-min))
4652 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4653 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4654 (replace-match (concat "; " (match-string 1)))))
4655 (buffer-string)))))
4656 (set-buffer-modified-p nil)
4657 (kill-buffer diary-fancy-buffer)))
4658 (when entries
4659 (setq entries (org-split-string entries "\n"))
4660 (setq entries
4661 (mapcar
4662 (lambda (x)
4663 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4664 ;; Extend the text properties to the beginning of the line
4665 (org-add-props x (text-properties-at (1- (length x)) x)
4666 'type "diary" 'date date 'face 'org-agenda-diary))
4667 entries)))))
4669 (defvar org-agenda-cleanup-fancy-diary-hook nil
4670 "Hook run when the fancy diary buffer is cleaned up.")
4672 (defun org-agenda-cleanup-fancy-diary ()
4673 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4674 This gets rid of the date, the underline under the date, and
4675 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4676 date. It also removes lines that contain only whitespace."
4677 (goto-char (point-min))
4678 (if (looking-at ".*?:[ \t]*")
4679 (progn
4680 (replace-match "")
4681 (re-search-forward "\n=+$" nil t)
4682 (replace-match "")
4683 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4684 (re-search-forward "\n=+$" nil t)
4685 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4686 (goto-char (point-min))
4687 (while (re-search-forward "^ +\n" nil t)
4688 (replace-match ""))
4689 (goto-char (point-min))
4690 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4691 (replace-match ""))
4692 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4694 ;; Make sure entries from the diary have the right text properties.
4695 (eval-after-load "diary-lib"
4696 '(if (boundp 'diary-modify-entry-list-string-function)
4697 ;; We can rely on the hook, nothing to do
4699 ;; Hook not available, must use advice to make this work
4700 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4701 "Make the position visible."
4702 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4703 (stringp string)
4704 buffer-file-name)
4705 (setq string (org-modify-diary-entry-string string))))))
4707 (defun org-modify-diary-entry-string (string)
4708 "Add text properties to string, allowing org-mode to act on it."
4709 (org-add-props string nil
4710 'mouse-face 'highlight
4711 'help-echo (if buffer-file-name
4712 (format "mouse-2 or RET jump to diary file %s"
4713 (abbreviate-file-name buffer-file-name))
4715 'org-agenda-diary-link t
4716 'org-marker (org-agenda-new-marker (point-at-bol))))
4718 (defun org-diary-default-entry ()
4719 "Add a dummy entry to the diary.
4720 Needed to avoid empty dates which mess up holiday display."
4721 ;; Catch the error if dealing with the new add-to-diary-alist
4722 (when org-disable-agenda-to-diary
4723 (condition-case nil
4724 (org-add-to-diary-list original-date "Org-mode dummy" "")
4725 (error
4726 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4728 (defun org-add-to-diary-list (&rest args)
4729 (if (fboundp 'diary-add-to-list)
4730 (apply 'diary-add-to-list args)
4731 (apply 'add-to-diary-list args)))
4733 (defvar org-diary-last-run-time nil)
4735 ;;;###autoload
4736 (defun org-diary (&rest args)
4737 "Return diary information from org files.
4738 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4739 It accesses org files and extracts information from those files to be
4740 listed in the diary. The function accepts arguments specifying what
4741 items should be listed. For a list of arguments allowed here, see the
4742 variable `org-agenda-entry-types'.
4744 The call in the diary file should look like this:
4746 &%%(org-diary) ~/path/to/some/orgfile.org
4748 Use a separate line for each org file to check. Or, if you omit the file name,
4749 all files listed in `org-agenda-files' will be checked automatically:
4751 &%%(org-diary)
4753 If you don't give any arguments (as in the example above), the default
4754 arguments (:deadline :scheduled :timestamp :sexp) are used.
4755 So the example above may also be written as
4757 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4759 The function expects the lisp variables `entry' and `date' to be provided
4760 by the caller, because this is how the calendar works. Don't use this
4761 function from a program - use `org-agenda-get-day-entries' instead."
4762 (when (> (- (org-float-time)
4763 org-agenda-last-marker-time)
4765 ;; I am not sure if this works with sticky agendas, because the marker
4766 ;; list is then no longer a global variable.
4767 (org-agenda-reset-markers))
4768 ;; Prevent `org-compile-prefix-format' to fail when there is no agenda
4769 (when (buffer-live-p org-agenda-buffer)
4770 (org-compile-prefix-format 'agenda))
4771 (org-set-sorting-strategy 'agenda)
4772 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4773 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4774 (list entry)
4775 (org-agenda-files t)))
4776 (time (org-float-time))
4777 file rtn results)
4778 (when (or (not org-diary-last-run-time)
4779 (> (- time
4780 org-diary-last-run-time)
4782 (org-prepare-agenda-buffers files))
4783 (setq org-diary-last-run-time time)
4784 ;; If this is called during org-agenda, don't return any entries to
4785 ;; the calendar. Org Agenda will list these entries itself.
4786 (if org-disable-agenda-to-diary (setq files nil))
4787 (while (setq file (pop files))
4788 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4789 (setq results (append results rtn)))
4790 (if results
4791 (concat (org-finalize-agenda-entries results) "\n"))))
4793 ;;; Agenda entry finders
4795 (defun org-agenda-get-day-entries (file date &rest args)
4796 "Does the work for `org-diary' and `org-agenda'.
4797 FILE is the path to a file to be checked for entries. DATE is date like
4798 the one returned by `calendar-current-date'. ARGS are symbols indicating
4799 which kind of entries should be extracted. For details about these, see
4800 the documentation of `org-diary'."
4801 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4802 (let* ((org-startup-folded nil)
4803 (org-startup-align-all-tables nil)
4804 (buffer (if (file-exists-p file)
4805 (org-get-agenda-file-buffer file)
4806 (error "No such file %s" file)))
4807 arg results rtn deadline-results)
4808 (if (not buffer)
4809 ;; If file does not exist, make sure an error message ends up in diary
4810 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4811 (with-current-buffer buffer
4812 (unless (derived-mode-p 'org-mode)
4813 (error "Agenda file %s is not in `org-mode'" file))
4814 (let ((case-fold-search nil))
4815 (save-excursion
4816 (save-restriction
4817 (if org-agenda-restrict
4818 (narrow-to-region org-agenda-restrict-begin
4819 org-agenda-restrict-end)
4820 (widen))
4821 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4822 (while (setq arg (pop args))
4823 (cond
4824 ((and (eq arg :todo)
4825 (equal date (calendar-gregorian-from-absolute
4826 (org-today))))
4827 (setq rtn (org-agenda-get-todos))
4828 (setq results (append results rtn)))
4829 ((eq arg :timestamp)
4830 (setq rtn (org-agenda-get-blocks))
4831 (setq results (append results rtn))
4832 (setq rtn (org-agenda-get-timestamps deadline-results))
4833 (setq results (append results rtn)))
4834 ((eq arg :sexp)
4835 (setq rtn (org-agenda-get-sexps))
4836 (setq results (append results rtn)))
4837 ((eq arg :scheduled)
4838 (setq rtn (org-agenda-get-scheduled deadline-results))
4839 (setq results (append results rtn)))
4840 ((eq arg :closed)
4841 (setq rtn (org-agenda-get-progress))
4842 (setq results (append results rtn)))
4843 ((eq arg :deadline)
4844 (setq rtn (org-agenda-get-deadlines))
4845 (setq deadline-results (copy-sequence rtn))
4846 (setq results (append results rtn))))))))
4847 results))))
4849 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4850 (defun org-agenda-get-todos ()
4851 "Return the TODO information for agenda display."
4852 (let* ((props (list 'face nil
4853 'done-face 'org-agenda-done
4854 'org-not-done-regexp org-not-done-regexp
4855 'org-todo-regexp org-todo-regexp
4856 'org-complex-heading-regexp org-complex-heading-regexp
4857 'mouse-face 'highlight
4858 'help-echo
4859 (format "mouse-2 or RET jump to org file %s"
4860 (abbreviate-file-name buffer-file-name))))
4861 (regexp (format org-heading-keyword-regexp-format
4862 (cond
4863 ((and org-select-this-todo-keyword
4864 (equal org-select-this-todo-keyword "*"))
4865 org-todo-regexp)
4866 (org-select-this-todo-keyword
4867 (concat "\\("
4868 (mapconcat 'identity
4869 (org-split-string
4870 org-select-this-todo-keyword
4871 "|")
4872 "\\|") "\\)"))
4873 (t org-not-done-regexp))))
4874 marker priority category category-pos tags todo-state
4875 ee txt beg end)
4876 (goto-char (point-min))
4877 (while (re-search-forward regexp nil t)
4878 (catch :skip
4879 (save-match-data
4880 (beginning-of-line)
4881 (org-agenda-skip)
4882 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4883 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
4884 (goto-char (1+ beg))
4885 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
4886 (throw :skip nil)))
4887 (goto-char (match-beginning 2))
4888 (setq marker (org-agenda-new-marker (match-beginning 0))
4889 category (org-get-category)
4890 category-pos (get-text-property (point) 'org-category-position)
4891 txt (org-trim
4892 (buffer-substring (match-beginning 2) (match-end 0)))
4893 tags (org-get-tags-at (point))
4894 txt (org-agenda-format-item "" txt category tags)
4895 priority (1+ (org-get-priority txt))
4896 todo-state (org-get-todo-state))
4897 (org-add-props txt props
4898 'org-marker marker 'org-hd-marker marker
4899 'priority priority 'org-category category
4900 'org-category-position category-pos
4901 'type "todo" 'todo-state todo-state)
4902 (push txt ee)
4903 (if org-agenda-todo-list-sublevels
4904 (goto-char (match-end 2))
4905 (org-end-of-subtree 'invisible))))
4906 (nreverse ee)))
4908 (defun org-agenda-todo-custom-ignore-p (time n)
4909 "Check whether timestamp is farther away then n number of days.
4910 This function is invoked if `org-agenda-todo-ignore-deadlines',
4911 `org-agenda-todo-ignore-scheduled' or
4912 `org-agenda-todo-ignore-timestamp' is set to an integer."
4913 (let ((days (org-days-to-time time)))
4914 (if (>= n 0)
4915 (>= days n)
4916 (<= days n))))
4918 ;;;###autoload
4919 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4920 (&optional end)
4921 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
4922 (when (or org-agenda-todo-ignore-with-date
4923 org-agenda-todo-ignore-scheduled
4924 org-agenda-todo-ignore-deadlines
4925 org-agenda-todo-ignore-timestamp)
4926 (setq end (or end (save-excursion (outline-next-heading) (point))))
4927 (save-excursion
4928 (or (and org-agenda-todo-ignore-with-date
4929 (re-search-forward org-ts-regexp end t))
4930 (and org-agenda-todo-ignore-scheduled
4931 (re-search-forward org-scheduled-time-regexp end t)
4932 (cond
4933 ((eq org-agenda-todo-ignore-scheduled 'future)
4934 (> (org-days-to-time (match-string 1)) 0))
4935 ((eq org-agenda-todo-ignore-scheduled 'past)
4936 (<= (org-days-to-time (match-string 1)) 0))
4937 ((numberp org-agenda-todo-ignore-scheduled)
4938 (org-agenda-todo-custom-ignore-p
4939 (match-string 1) org-agenda-todo-ignore-scheduled))
4940 (t)))
4941 (and org-agenda-todo-ignore-deadlines
4942 (re-search-forward org-deadline-time-regexp end t)
4943 (cond
4944 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
4945 ((eq org-agenda-todo-ignore-deadlines 'far)
4946 (not (org-deadline-close (match-string 1))))
4947 ((eq org-agenda-todo-ignore-deadlines 'future)
4948 (> (org-days-to-time (match-string 1)) 0))
4949 ((eq org-agenda-todo-ignore-deadlines 'past)
4950 (<= (org-days-to-time (match-string 1)) 0))
4951 ((numberp org-agenda-todo-ignore-deadlines)
4952 (org-agenda-todo-custom-ignore-p
4953 (match-string 1) org-agenda-todo-ignore-deadlines))
4954 (t (org-deadline-close (match-string 1)))))
4955 (and org-agenda-todo-ignore-timestamp
4956 (let ((buffer (current-buffer))
4957 (regexp
4958 (concat
4959 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
4960 (start (point)))
4961 ;; Copy current buffer into a temporary one
4962 (with-temp-buffer
4963 (insert-buffer-substring buffer start end)
4964 (goto-char (point-min))
4965 ;; Delete SCHEDULED and DEADLINE items
4966 (while (re-search-forward regexp end t)
4967 (delete-region (match-beginning 0) (match-end 0)))
4968 (goto-char (point-min))
4969 ;; No search for timestamp left
4970 (when (re-search-forward org-ts-regexp nil t)
4971 (cond
4972 ((eq org-agenda-todo-ignore-timestamp 'future)
4973 (> (org-days-to-time (match-string 1)) 0))
4974 ((eq org-agenda-todo-ignore-timestamp 'past)
4975 (<= (org-days-to-time (match-string 1)) 0))
4976 ((numberp org-agenda-todo-ignore-timestamp)
4977 (org-agenda-todo-custom-ignore-p
4978 (match-string 1) org-agenda-todo-ignore-timestamp))
4979 (t))))))))))
4981 (defconst org-agenda-no-heading-message
4982 "No heading for this item in buffer or region.")
4984 (defun org-agenda-get-timestamps (&optional deadline-results)
4985 "Return the date stamp information for agenda display."
4986 (let* ((props (list 'face 'org-agenda-calendar-event
4987 'org-not-done-regexp org-not-done-regexp
4988 'org-todo-regexp org-todo-regexp
4989 'org-complex-heading-regexp org-complex-heading-regexp
4990 'mouse-face 'highlight
4991 'help-echo
4992 (format "mouse-2 or RET jump to org file %s"
4993 (abbreviate-file-name buffer-file-name))))
4994 (d1 (calendar-absolute-from-gregorian date))
4996 (deadline-position-alist
4997 (mapcar (lambda (a) (and (setq mm (get-text-property
4998 0 'org-hd-marker a))
4999 (cons (marker-position mm) a)))
5000 deadline-results))
5001 (remove-re org-ts-regexp)
5002 (regexp
5003 (concat
5004 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5005 (regexp-quote
5006 (substring
5007 (format-time-string
5008 (car org-time-stamp-formats)
5009 (apply 'encode-time ; DATE bound by calendar
5010 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5011 1 11))
5012 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5013 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5014 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5015 donep tmp priority category category-pos ee txt timestr tags
5016 b0 b3 e3 head todo-state end-of-match show-all warntime)
5017 (goto-char (point-min))
5018 (while (setq end-of-match (re-search-forward regexp nil t))
5019 (setq b0 (match-beginning 0)
5020 b3 (match-beginning 3) e3 (match-end 3)
5021 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5022 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5023 (member todo-state
5024 org-agenda-repeating-timestamp-show-all)))
5025 (catch :skip
5026 (and (org-at-date-range-p) (throw :skip nil))
5027 (org-agenda-skip)
5028 (if (and (match-end 1)
5029 (not (= d1 (org-time-string-to-absolute
5030 (match-string 1) d1 nil show-all
5031 (current-buffer) b0))))
5032 (throw :skip nil))
5033 (if (and e3
5034 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5035 (throw :skip nil))
5036 (setq tmp (buffer-substring (max (point-min)
5037 (- b0 org-ds-keyword-length))
5039 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5040 inactivep (= (char-after b0) ?\[)
5041 deadlinep (string-match org-deadline-regexp tmp)
5042 scheduledp (string-match org-scheduled-regexp tmp)
5043 closedp (and org-agenda-include-inactive-timestamps
5044 (string-match org-closed-string tmp))
5045 clockp (and org-agenda-include-inactive-timestamps
5046 (or (string-match org-clock-string tmp)
5047 (string-match "]-+\\'" tmp)))
5048 warntime (org-entry-get (point) "APPT_WARNTIME")
5049 donep (member todo-state org-done-keywords))
5050 (if (or scheduledp deadlinep closedp clockp
5051 (and donep org-agenda-skip-timestamp-if-done))
5052 (throw :skip t))
5053 (if (string-match ">" timestr)
5054 ;; substring should only run to end of time stamp
5055 (setq timestr (substring timestr 0 (match-end 0))))
5056 (setq marker (org-agenda-new-marker b0)
5057 category (org-get-category b0)
5058 category-pos (get-text-property b0 'org-category-position))
5059 (save-excursion
5060 (if (not (re-search-backward org-outline-regexp-bol nil t))
5061 (setq txt org-agenda-no-heading-message)
5062 (goto-char (match-beginning 0))
5063 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5064 (assoc (point) deadline-position-alist))
5065 (throw :skip nil))
5066 (setq hdmarker (org-agenda-new-marker)
5067 tags (org-get-tags-at))
5068 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5069 (setq head (or (match-string 1) ""))
5070 (setq txt (org-agenda-format-item
5071 (if inactivep org-agenda-inactive-leader nil)
5072 head category tags timestr
5073 remove-re)))
5074 (setq priority (org-get-priority txt))
5075 (org-add-props txt props
5076 'org-marker marker 'org-hd-marker hdmarker)
5077 (org-add-props txt nil 'priority priority
5078 'org-category category 'date date
5079 'org-category-position category-pos
5080 'todo-state todo-state
5081 'warntime warntime
5082 'type "timestamp")
5083 (push txt ee))
5084 (if org-agenda-skip-additional-timestamps-same-entry
5085 (outline-next-heading)
5086 (goto-char end-of-match))))
5087 (nreverse ee)))
5089 (defun org-agenda-get-sexps ()
5090 "Return the sexp information for agenda display."
5091 (require 'diary-lib)
5092 (let* ((props (list 'face 'org-agenda-calendar-sexp
5093 'mouse-face 'highlight
5094 'help-echo
5095 (format "mouse-2 or RET jump to org file %s"
5096 (abbreviate-file-name buffer-file-name))))
5097 (regexp "^&?%%(")
5098 marker category extra category-pos ee txt tags entry
5099 result beg b sexp sexp-entry todo-state warntime)
5100 (goto-char (point-min))
5101 (while (re-search-forward regexp nil t)
5102 (catch :skip
5103 (org-agenda-skip)
5104 (setq beg (match-beginning 0))
5105 (goto-char (1- (match-end 0)))
5106 (setq b (point))
5107 (forward-sexp 1)
5108 (setq sexp (buffer-substring b (point)))
5109 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5110 (org-trim (match-string 1))
5111 ""))
5112 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5113 (when result
5114 (setq marker (org-agenda-new-marker beg)
5115 category (org-get-category beg)
5116 category-pos (get-text-property beg 'org-category-position)
5117 tags (save-excursion (org-backward-heading-same-level 0)
5118 (org-get-tags-at))
5119 todo-state (org-get-todo-state)
5120 warntime (org-entry-get (point) "APPT_WARNTIME"))
5122 (dolist (r (if (stringp result)
5123 (list result)
5124 result)) ;; we expect a list here
5125 (when (and org-agenda-diary-sexp-prefix
5126 (string-match org-agenda-diary-sexp-prefix r))
5127 (setq extra (match-string 0 r)
5128 r (replace-match "" nil nil r)))
5129 (if (string-match "\\S-" r)
5130 (setq txt r)
5131 (setq txt "SEXP entry returned empty string"))
5133 (setq txt (org-agenda-format-item
5134 extra txt category tags 'time))
5135 (org-add-props txt props 'org-marker marker)
5136 (org-add-props txt nil
5137 'org-category category 'date date 'todo-state todo-state
5138 'org-category-position category-pos 'tags tags
5139 'type "sexp" 'warntime warntime)
5140 (push txt ee)))))
5141 (nreverse ee)))
5143 ;; Calendar sanity: define some functions that are independent of
5144 ;; `calendar-date-style'.
5145 ;; Normally I would like to use ISO format when calling the diary functions,
5146 ;; but to make sure we still have Emacs 22 compatibility we bind
5147 ;; also `european-calendar-style' and use european format
5148 (defun org-anniversary (year month day &optional mark)
5149 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5150 (org-no-warnings
5151 (let ((calendar-date-style 'european) (european-calendar-style t))
5152 (diary-anniversary day month year mark))))
5153 (defun org-cyclic (N year month day &optional mark)
5154 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5155 (org-no-warnings
5156 (let ((calendar-date-style 'european) (european-calendar-style t))
5157 (diary-cyclic N day month year mark))))
5158 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5159 "Like `diary-block', but with fixed (ISO) order of arguments."
5160 (org-no-warnings
5161 (let ((calendar-date-style 'european) (european-calendar-style t))
5162 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5163 (defun org-date (year month day &optional mark)
5164 "Like `diary-date', but with fixed (ISO) order of arguments."
5165 (org-no-warnings
5166 (let ((calendar-date-style 'european) (european-calendar-style t))
5167 (diary-date day month year mark))))
5168 (defalias 'org-float 'diary-float)
5170 ;; Define the` org-class' function
5171 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5172 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5173 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5174 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5175 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5176 `holidays', then any date that is known by the Emacs calendar to be a
5177 holiday will also be skipped."
5178 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5179 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5180 (d (calendar-absolute-from-gregorian date)))
5181 (and
5182 (<= date1 d)
5183 (<= d date2)
5184 (= (calendar-day-of-week date) dayname)
5185 (or (not skip-weeks)
5186 (progn
5187 (require 'cal-iso)
5188 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5189 (not (and (memq 'holidays skip-weeks)
5190 (calendar-check-holidays date)))
5191 entry)))
5193 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5194 "Like `org-class', but honor `calendar-date-style'.
5195 The order of the first 2 times 3 arguments depends on the variable
5196 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5197 So for American calendars, give this as MONTH DAY YEAR, for European as
5198 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5199 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5200 is any number of ISO weeks in the block period for which the item should
5201 be skipped.
5203 This function is here only for backward compatibility and it is deprecated,
5204 please use `org-class' instead."
5205 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5206 (date2 (org-order-calendar-date-args m2 d2 y2)))
5207 (org-class
5208 (nth 2 date1) (car date1) (nth 1 date1)
5209 (nth 2 date2) (car date2) (nth 1 date2)
5210 dayname skip-weeks)))
5211 (make-obsolete 'org-diary-class 'org-class "")
5213 (defvar org-agenda-show-log-scoped) ;; dynamically scope in ̀org-timeline' or`org-agenda-list'
5214 (defalias 'org-get-closed 'org-agenda-get-progress)
5215 (defun org-agenda-get-progress ()
5216 "Return the logged TODO entries for agenda display."
5217 (let* ((props (list 'mouse-face 'highlight
5218 'org-not-done-regexp org-not-done-regexp
5219 'org-todo-regexp org-todo-regexp
5220 'org-complex-heading-regexp org-complex-heading-regexp
5221 'help-echo
5222 (format "mouse-2 or RET jump to org file %s"
5223 (abbreviate-file-name buffer-file-name))))
5224 (items (if (consp org-agenda-show-log-scoped)
5225 org-agenda-show-log-scoped
5226 (if (eq org-agenda-show-log-scoped 'clockcheck)
5227 '(clock)
5228 org-agenda-log-mode-items)))
5229 (parts
5230 (delq nil
5231 (list
5232 (if (memq 'closed items) (concat "\\<" org-closed-string))
5233 (if (memq 'clock items) (concat "\\<" org-clock-string))
5234 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5235 (parts-re (if parts (mapconcat 'identity parts "\\|")
5236 (error "`org-agenda-log-mode-items' is empty")))
5237 (regexp (concat
5238 "\\(" parts-re "\\)"
5239 " *\\["
5240 (regexp-quote
5241 (substring
5242 (format-time-string
5243 (car org-time-stamp-formats)
5244 (apply 'encode-time ; DATE bound by calendar
5245 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5246 1 11))))
5247 (org-agenda-search-headline-for-time nil)
5248 marker hdmarker priority category category-pos tags closedp
5249 statep clockp state ee txt extra timestr rest clocked)
5250 (goto-char (point-min))
5251 (while (re-search-forward regexp nil t)
5252 (catch :skip
5253 (org-agenda-skip)
5254 (setq marker (org-agenda-new-marker (match-beginning 0))
5255 closedp (equal (match-string 1) org-closed-string)
5256 statep (equal (string-to-char (match-string 1)) ?-)
5257 clockp (not (or closedp statep))
5258 state (and statep (match-string 2))
5259 category (org-get-category (match-beginning 0))
5260 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5261 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5262 (when (string-match "\\]" timestr)
5263 ;; substring should only run to end of time stamp
5264 (setq rest (substring timestr (match-end 0))
5265 timestr (substring timestr 0 (match-end 0)))
5266 (if (and (not closedp) (not statep)
5267 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5268 rest))
5269 (progn (setq timestr (concat (substring timestr 0 -1)
5270 "-" (match-string 1 rest) "]"))
5271 (setq clocked (match-string 2 rest)))
5272 (setq clocked "-")))
5273 (save-excursion
5274 (setq extra
5275 (cond
5276 ((not org-agenda-log-mode-add-notes) nil)
5277 (statep
5278 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5279 (match-string 1)))
5280 (clockp
5281 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5282 (match-string 1)))))
5283 (if (not (re-search-backward org-outline-regexp-bol nil t))
5284 (setq txt org-agenda-no-heading-message)
5285 (goto-char (match-beginning 0))
5286 (setq hdmarker (org-agenda-new-marker)
5287 tags (org-get-tags-at))
5288 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5289 (setq txt (match-string 1))
5290 (when extra
5291 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5292 (setq txt (concat (substring txt 0 (match-beginning 1))
5293 " - " extra " " (match-string 2 txt)))
5294 (setq txt (concat txt " - " extra))))
5295 (setq txt (org-agenda-format-item
5296 (cond
5297 (closedp "Closed: ")
5298 (statep (concat "State: (" state ")"))
5299 (t (concat "Clocked: (" clocked ")")))
5300 txt category tags timestr)))
5301 (setq priority 100000)
5302 (org-add-props txt props
5303 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5304 'priority priority 'org-category category
5305 'org-category-position category-pos
5306 'type "closed" 'date date
5307 'undone-face 'org-warning 'done-face 'org-agenda-done)
5308 (push txt ee))
5309 (goto-char (point-at-eol))))
5310 (nreverse ee)))
5312 (defun org-agenda-show-clocking-issues ()
5313 "Add overlays, showing issues with clocking.
5314 See also the user option `org-agenda-clock-consistency-checks'."
5315 (interactive)
5316 (let* ((pl org-agenda-clock-consistency-checks)
5317 (re (concat "^[ \t]*"
5318 org-clock-string
5319 "[ \t]+"
5320 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5321 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5322 (tlstart 0.)
5323 (tlend 0.)
5324 (maxtime (org-hh:mm-string-to-minutes
5325 (or (plist-get pl :max-duration) "24:00")))
5326 (mintime (org-hh:mm-string-to-minutes
5327 (or (plist-get pl :min-duration) 0)))
5328 (maxgap (org-hh:mm-string-to-minutes
5329 ;; default 30:00 means never complain
5330 (or (plist-get pl :max-gap) "30:00")))
5331 (gapok (mapcar 'org-hh:mm-string-to-minutes
5332 (plist-get pl :gap-ok-around)))
5333 (def-face (or (plist-get pl :default-face)
5334 '((:background "DarkRed") (:foreground "white"))))
5335 issue face m te ts dt ov)
5336 (goto-char (point-min))
5337 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5338 (setq issue nil face def-face)
5339 (catch 'next
5340 (setq m (org-get-at-bol 'org-marker)
5341 te nil ts nil)
5342 (unless (and m (markerp m))
5343 (setq issue "No valid clock line") (throw 'next t))
5344 (org-with-point-at m
5345 (save-excursion
5346 (goto-char (point-at-bol))
5347 (unless (looking-at re)
5348 (error "No valid Clock line")
5349 (throw 'next t))
5350 (unless (match-end 3)
5351 (setq issue "No end time"
5352 face (or (plist-get pl :no-end-time-face) face))
5353 (throw 'next t))
5354 (setq ts (match-string 1)
5355 te (match-string 3)
5356 ts (org-float-time
5357 (apply 'encode-time (org-parse-time-string ts)))
5358 te (org-float-time
5359 (apply 'encode-time (org-parse-time-string te)))
5360 dt (- te ts))))
5361 (cond
5362 ((> dt (* 60 maxtime))
5363 ;; a very long clocking chunk
5364 (setq issue (format "Clocking interval is very long: %s"
5365 (org-minutes-to-hh:mm-string
5366 (floor (/ (float dt) 60.))))
5367 face (or (plist-get pl :long-face) face)))
5368 ((< dt (* 60 mintime))
5369 ;; a very short clocking chunk
5370 (setq issue (format "Clocking interval is very short: %s"
5371 (org-minutes-to-hh:mm-string
5372 (floor (/ (float dt) 60.))))
5373 face (or (plist-get pl :short-face) face)))
5374 ((and (> tlend 0) (< ts tlend))
5375 ;; Two clock entries are overlapping
5376 (setq issue (format "Clocking overlap: %d minutes"
5377 (/ (- tlend ts) 60))
5378 face (or (plist-get pl :overlap-face) face)))
5379 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5380 ;; There is a gap, lets see if we need to report it
5381 (unless (org-agenda-check-clock-gap tlend ts gapok)
5382 (setq issue (format "Clocking gap: %d minutes"
5383 (/ (- ts tlend) 60))
5384 face (or (plist-get pl :gap-face) face))))
5385 (t nil)))
5386 (setq tlend (or te tlend) tlstart (or ts tlstart))
5387 (when issue
5388 ;; OK, there was some issue, add an overlay to show the issue
5389 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5390 (overlay-put ov 'before-string
5391 (concat
5392 (org-add-props
5393 (format "%-43s" (concat " " issue))
5395 'face face)
5396 "\n"))
5397 (overlay-put ov 'evaporate t)))))
5399 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5400 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5401 (catch 'exit
5402 (unless ok-list
5403 ;; there are no OK times for gaps...
5404 (throw 'exit nil))
5405 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5406 ;; This is more than 24 hours, so it is OK.
5407 ;; because we have at least one OK time, that must be in the
5408 ;; 24 hour interval.
5409 (throw 'exit t))
5410 ;; We have a shorter gap.
5411 ;; Now we have to get the minute of the day when these times are
5412 (let* ((t1dec (decode-time (seconds-to-time t1)))
5413 (t2dec (decode-time (seconds-to-time t2)))
5414 ;; compute the minute on the day
5415 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5416 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5417 (when (< min2 min1)
5418 ;; if min2 is smaller than min1, this means it is on the next day.
5419 ;; Wrap it to after midnight.
5420 (setq min2 (+ min2 1440)))
5421 ;; Now check if any of the OK times is in the gap
5422 (mapc (lambda (x)
5423 ;; Wrap the time to after midnight if necessary
5424 (if (< x min1) (setq x (+ x 1440)))
5425 ;; Check if in interval
5426 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5427 ok-list)
5428 ;; Nope, this gap is not OK
5429 nil)))
5431 (defun org-agenda-get-deadlines ()
5432 "Return the deadline information for agenda display."
5433 (let* ((props (list 'mouse-face 'highlight
5434 'org-not-done-regexp org-not-done-regexp
5435 'org-todo-regexp org-todo-regexp
5436 'org-complex-heading-regexp org-complex-heading-regexp
5437 'help-echo
5438 (format "mouse-2 or RET jump to org file %s"
5439 (abbreviate-file-name buffer-file-name))))
5440 (regexp org-deadline-time-regexp)
5441 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5442 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5443 d2 diff dfrac wdays pos pos1 category category-pos
5444 tags suppress-prewarning ee txt head face s todo-state
5445 show-all upcomingp donep timestr warntime)
5446 (goto-char (point-min))
5447 (while (re-search-forward regexp nil t)
5448 (setq suppress-prewarning nil)
5449 (catch :skip
5450 (org-agenda-skip)
5451 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5452 (save-match-data
5453 (string-match org-scheduled-time-regexp
5454 (buffer-substring (point-at-bol)
5455 (point-at-eol)))))
5456 (setq suppress-prewarning
5457 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5458 org-agenda-skip-deadline-prewarning-if-scheduled
5459 0)))
5460 (setq s (match-string 1)
5461 txt nil
5462 pos (1- (match-beginning 1))
5463 todo-state (save-match-data (org-get-todo-state))
5464 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5465 (member todo-state
5466 org-agenda-repeating-timestamp-show-all))
5467 d2 (org-time-string-to-absolute
5468 (match-string 1) d1 'past show-all
5469 (current-buffer) pos)
5470 diff (- d2 d1)
5471 wdays (if suppress-prewarning
5472 (let ((org-deadline-warning-days suppress-prewarning))
5473 (org-get-wdays s))
5474 (org-get-wdays s))
5475 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5476 upcomingp (and todayp (> diff 0)))
5477 ;; When to show a deadline in the calendar:
5478 ;; If the expiration is within wdays warning time.
5479 ;; Past-due deadlines are only shown on the current date
5480 (if (and (or (and (<= diff wdays)
5481 (and todayp (not org-agenda-only-exact-dates)))
5482 (= diff 0)))
5483 (save-excursion
5484 ;; (setq todo-state (org-get-todo-state))
5485 (setq donep (member todo-state org-done-keywords))
5486 (if (and donep
5487 (or org-agenda-skip-deadline-if-done
5488 (not (= diff 0))))
5489 (setq txt nil)
5490 (setq category (org-get-category)
5491 warntime (org-entry-get (point) "APPT_WARNTIME")
5492 category-pos (get-text-property (point) 'org-category-position))
5493 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5494 (setq txt org-agenda-no-heading-message)
5495 (goto-char (match-end 0))
5496 (setq pos1 (match-beginning 0))
5497 (setq tags (org-get-tags-at pos1))
5498 (setq head (buffer-substring-no-properties
5499 (point)
5500 (progn (skip-chars-forward "^\r\n")
5501 (point))))
5502 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5503 (setq timestr
5504 (concat (substring s (match-beginning 1)) " "))
5505 (setq timestr 'time))
5506 (setq txt (org-agenda-format-item
5507 (if (= diff 0)
5508 (car org-agenda-deadline-leaders)
5509 (if (functionp
5510 (nth 1 org-agenda-deadline-leaders))
5511 (funcall
5512 (nth 1 org-agenda-deadline-leaders)
5513 diff date)
5514 (format (nth 1 org-agenda-deadline-leaders)
5515 diff)))
5516 head category tags
5517 (if (not (= diff 0)) nil timestr)))))
5518 (when txt
5519 (setq face (org-agenda-deadline-face dfrac))
5520 (org-add-props txt props
5521 'org-marker (org-agenda-new-marker pos)
5522 'warntime warntime
5523 'org-hd-marker (org-agenda-new-marker pos1)
5524 'priority (+ (- diff)
5525 (org-get-priority txt))
5526 'org-category category
5527 'org-category-position category-pos
5528 'todo-state todo-state
5529 'type (if upcomingp "upcoming-deadline" "deadline")
5530 'date (if upcomingp date d2)
5531 'face (if donep 'org-agenda-done face)
5532 'undone-face face 'done-face 'org-agenda-done)
5533 (push txt ee))))))
5534 (nreverse ee)))
5536 (defun org-agenda-deadline-face (fraction)
5537 "Return the face to displaying a deadline item.
5538 FRACTION is what fraction of the head-warning time has passed."
5539 (let ((faces org-agenda-deadline-faces) f)
5540 (catch 'exit
5541 (while (setq f (pop faces))
5542 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5544 (defun org-agenda-get-scheduled (&optional deadline-results)
5545 "Return the scheduled information for agenda display."
5546 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5547 'org-todo-regexp org-todo-regexp
5548 'org-complex-heading-regexp org-complex-heading-regexp
5549 'done-face 'org-agenda-done
5550 'mouse-face 'highlight
5551 'help-echo
5552 (format "mouse-2 or RET jump to org file %s"
5553 (abbreviate-file-name buffer-file-name))))
5554 (regexp org-scheduled-time-regexp)
5555 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5556 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5558 (deadline-position-alist
5559 (mapcar (lambda (a) (and (setq mm (get-text-property
5560 0 'org-hd-marker a))
5561 (cons (marker-position mm) a)))
5562 deadline-results))
5563 d2 diff pos pos1 category category-pos tags donep
5564 ee txt head pastschedp todo-state face timestr s habitp show-all
5565 did-habit-check-p warntime)
5566 (goto-char (point-min))
5567 (while (re-search-forward regexp nil t)
5568 (catch :skip
5569 (org-agenda-skip)
5570 (setq s (match-string 1)
5571 txt nil
5572 pos (1- (match-beginning 1))
5573 todo-state (save-match-data (org-get-todo-state))
5574 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5575 (member todo-state
5576 org-agenda-repeating-timestamp-show-all))
5577 d2 (org-time-string-to-absolute
5578 (match-string 1) d1 'past show-all
5579 (current-buffer) pos)
5580 diff (- d2 d1)
5581 warntime (org-entry-get (point) "APPT_WARNTIME"))
5582 (setq pastschedp (and todayp (< diff 0)))
5583 (setq did-habit-check-p nil)
5584 ;; When to show a scheduled item in the calendar:
5585 ;; If it is on or past the date.
5586 (when (or (and (< diff 0)
5587 (< (abs diff) org-scheduled-past-days)
5588 (and todayp (not org-agenda-only-exact-dates)))
5589 (= diff 0)
5590 ;; org-is-habit-p uses org-entry-get, which is expansive
5591 ;; so we go extra mile to only call it once
5592 (and todayp
5593 org-habit-show-all-today
5594 (setq did-habit-check-p t)
5595 (setq habitp (and (functionp 'org-is-habit-p)
5596 (org-is-habit-p)))))
5597 (save-excursion
5598 (setq donep (member todo-state org-done-keywords))
5599 (if (and donep
5600 (or org-agenda-skip-scheduled-if-done
5601 (not (= diff 0))
5602 (and (functionp 'org-is-habit-p)
5603 (org-is-habit-p))))
5604 (setq txt nil)
5605 (setq habitp (if did-habit-check-p habitp
5606 (and (functionp 'org-is-habit-p)
5607 (org-is-habit-p))))
5608 (setq category (org-get-category)
5609 category-pos (get-text-property (point) 'org-category-position))
5610 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5611 (setq txt org-agenda-no-heading-message)
5612 (goto-char (match-end 0))
5613 (setq pos1 (match-beginning 0))
5614 (if habitp
5615 (if (or (not org-habit-show-habits)
5616 (and (not todayp)
5617 org-habit-show-habits-only-for-today))
5618 (throw :skip nil))
5619 (if (and
5620 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5621 (and org-agenda-skip-scheduled-if-deadline-is-shown
5622 pastschedp))
5623 (setq mm (assoc pos1 deadline-position-alist)))
5624 (throw :skip nil)))
5625 (setq tags (org-get-tags-at))
5626 (setq head (buffer-substring-no-properties
5627 (point)
5628 (progn (skip-chars-forward "^\r\n") (point))))
5629 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5630 (setq timestr
5631 (concat (substring s (match-beginning 1)) " "))
5632 (setq timestr 'time))
5633 (setq txt (org-agenda-format-item
5634 (if (= diff 0)
5635 (car org-agenda-scheduled-leaders)
5636 (format (nth 1 org-agenda-scheduled-leaders)
5637 (- 1 diff)))
5638 head category tags
5639 (if (not (= diff 0)) nil timestr)
5640 nil habitp))))
5641 (when txt
5642 (setq face
5643 (cond
5644 ((and (not habitp) pastschedp)
5645 'org-scheduled-previously)
5646 (todayp 'org-scheduled-today)
5647 (t 'org-scheduled))
5648 habitp (and habitp (org-habit-parse-todo)))
5649 (org-add-props txt props
5650 'undone-face face
5651 'face (if donep 'org-agenda-done face)
5652 'org-marker (org-agenda-new-marker pos)
5653 'org-hd-marker (org-agenda-new-marker pos1)
5654 'type (if pastschedp "past-scheduled" "scheduled")
5655 'date (if pastschedp d2 date)
5656 'warntime warntime
5657 'priority (if habitp
5658 (org-habit-get-priority habitp)
5659 (+ 94 (- 5 diff) (org-get-priority txt)))
5660 'org-category category
5661 'category-position category-pos
5662 'org-habit-p habitp
5663 'todo-state todo-state)
5664 (push txt ee))))))
5665 (nreverse ee)))
5667 (defun org-agenda-get-blocks ()
5668 "Return the date-range information for agenda display."
5669 (let* ((props (list 'face nil
5670 'org-not-done-regexp org-not-done-regexp
5671 'org-todo-regexp org-todo-regexp
5672 'org-complex-heading-regexp org-complex-heading-regexp
5673 'mouse-face 'highlight
5674 'help-echo
5675 (format "mouse-2 or RET jump to org file %s"
5676 (abbreviate-file-name buffer-file-name))))
5677 (regexp org-tr-regexp)
5678 (d0 (calendar-absolute-from-gregorian date))
5679 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
5680 todo-state tags pos head donep)
5681 (goto-char (point-min))
5682 (while (re-search-forward regexp nil t)
5683 (catch :skip
5684 (org-agenda-skip)
5685 (setq pos (point))
5686 (let ((start-time (match-string 1))
5687 (end-time (match-string 2)))
5688 (setq s1 (match-string 1)
5689 s2 (match-string 2)
5690 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5691 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5692 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5693 ;; Only allow days between the limits, because the normal
5694 ;; date stamps will catch the limits.
5695 (save-excursion
5696 (setq todo-state (org-get-todo-state))
5697 (setq donep (member todo-state org-done-keywords))
5698 (if (and donep org-agenda-skip-timestamp-if-done)
5699 (throw :skip t))
5700 (setq marker (org-agenda-new-marker (point)))
5701 (setq category (org-get-category)
5702 category-pos (get-text-property (point) 'org-category-position))
5703 (if (not (re-search-backward org-outline-regexp-bol nil t))
5704 (setq txt org-agenda-no-heading-message)
5705 (goto-char (match-beginning 0))
5706 (setq hdmarker (org-agenda-new-marker (point)))
5707 (setq tags (org-get-tags-at))
5708 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5709 (setq head (match-string 1))
5710 (let ((remove-re
5711 (if org-agenda-remove-timeranges-from-blocks
5712 (concat
5713 "<" (regexp-quote s1) ".*?>"
5714 "--"
5715 "<" (regexp-quote s2) ".*?>")
5716 nil)))
5717 (setq txt (org-agenda-format-item
5718 (format
5719 (nth (if (= d1 d2) 0 1)
5720 org-agenda-timerange-leaders)
5721 (1+ (- d0 d1)) (1+ (- d2 d1)))
5722 head category tags
5723 (cond ((and (= d1 d0) (= d2 d0))
5724 (concat "<" start-time ">--<" end-time ">"))
5725 ((= d1 d0)
5726 (concat "<" start-time ">"))
5727 ((= d2 d0)
5728 (concat "<" end-time ">")))
5729 remove-re))))
5730 (org-add-props txt props
5731 'org-marker marker 'org-hd-marker hdmarker
5732 'type "block" 'date date
5733 'todo-state todo-state
5734 'priority (org-get-priority txt) 'org-category category
5735 'org-category-position category-pos)
5736 (push txt ee))))
5737 (goto-char pos)))
5738 ;; Sort the entries by expiration date.
5739 (nreverse ee)))
5741 ;;; Agenda presentation and sorting
5743 (defvar org-prefix-has-time nil
5744 "A flag, set by `org-compile-prefix-format'.
5745 The flag is set if the currently compiled format contains a `%t'.")
5746 (defvar org-prefix-has-tag nil
5747 "A flag, set by `org-compile-prefix-format'.
5748 The flag is set if the currently compiled format contains a `%T'.")
5749 (defvar org-prefix-has-effort nil
5750 "A flag, set by `org-compile-prefix-format'.
5751 The flag is set if the currently compiled format contains a `%e'.")
5752 (defvar org-prefix-category-length nil
5753 "Used by `org-compile-prefix-format' to remember the category field width.")
5754 (defvar org-prefix-category-max-length nil
5755 "Used by `org-compile-prefix-format' to remember the category field width.")
5757 (defun org-agenda-get-category-icon (category)
5758 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5759 (dolist (entry org-agenda-category-icon-alist)
5760 (when (org-string-match-p (car entry) category)
5761 (if (listp (cadr entry))
5762 (return (cadr entry))
5763 (return (apply 'create-image (cdr entry)))))))
5765 (defun org-agenda-format-item (extra txt &optional category tags dotime
5766 remove-re habitp)
5767 "Format TXT to be inserted into the agenda buffer.
5768 In particular, it adds the prefix and corresponding text properties. EXTRA
5769 must be a string and replaces the `%s' specifier in the prefix format.
5770 CATEGORY (string, symbol or nil) may be used to overrule the default
5771 category taken from local variable or file name. It will replace the `%c'
5772 specifier in the format. DOTIME, when non-nil, indicates that a
5773 time-of-day should be extracted from TXT for sorting of this entry, and for
5774 the `%t' specifier in the format. When DOTIME is a string, this string is
5775 searched for a time before TXT is. TAGS can be the tags of the headline.
5776 Any match of REMOVE-RE will be removed from TXT."
5777 ;; We keep the org-prefix-* variable values along with a compiled
5778 ;; formatter, so that multiple agendas existing at the same time, do
5779 ;; not step on each other toes.
5781 ;; It was inconvenient to make these variables buffer local in
5782 ;; Agenda buffers, because this function expects to be called with
5783 ;; the buffer where item comes from being current, and not agenda
5784 ;; buffer
5785 (let* ((bindings (car org-prefix-format-compiled))
5786 (formatter (cadr org-prefix-format-compiled)))
5787 (loop for (var value) in bindings
5788 do (set var value))
5789 (save-match-data
5790 ;; Diary entries sometimes have extra whitespace at the beginning
5791 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5793 ;; Fix the tags part in txt
5794 (setq txt (org-agenda-fix-displayed-tags
5795 txt tags
5796 org-agenda-show-inherited-tags
5797 org-agenda-hide-tags-regexp))
5798 (let* ((category (or category
5799 (if (stringp org-category)
5800 org-category
5801 (and org-category (symbol-name org-category)))
5802 (if buffer-file-name
5803 (file-name-sans-extension
5804 (file-name-nondirectory buffer-file-name))
5805 "")))
5806 (category-icon (org-agenda-get-category-icon category))
5807 (category-icon (if category-icon
5808 (propertize " " 'display category-icon)
5809 ""))
5810 ;; time, tag, effort are needed for the eval of the prefix format
5811 (tag (if tags (nth (1- (length tags)) tags) ""))
5812 time effort neffort
5813 (ts (if dotime (concat
5814 (if (stringp dotime) dotime "")
5815 (and org-agenda-search-headline-for-time txt))))
5816 (time-of-day (and dotime (org-get-time-of-day ts)))
5817 stamp plain s0 s1 s2 rtn srp l
5818 duration thecategory)
5819 (and (derived-mode-p 'org-mode) buffer-file-name
5820 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5821 (when (and dotime time-of-day)
5822 ;; Extract starting and ending time and move them to prefix
5823 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5824 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5825 (setq s0 (match-string 0 ts)
5826 srp (and stamp (match-end 3))
5827 s1 (match-string (if plain 1 2) ts)
5828 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5830 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5831 ;; them, we might want to remove them there to avoid duplication.
5832 ;; The user can turn this off with a variable.
5833 (if (and org-prefix-has-time
5834 org-agenda-remove-times-when-in-prefix (or stamp plain)
5835 (string-match (concat (regexp-quote s0) " *") txt)
5836 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5837 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5838 (= (match-beginning 0) 0)
5840 (setq txt (replace-match "" nil nil txt))))
5841 ;; Normalize the time(s) to 24 hour
5842 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5843 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5845 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5846 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5847 (setq s2
5848 (org-minutes-to-hh:mm-string
5849 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5851 ;; Compute the duration
5852 (when s2
5853 (setq duration (- (org-hh:mm-string-to-minutes s2)
5854 (org-hh:mm-string-to-minutes s1)))))
5856 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5857 txt)
5858 ;; Tags are in the string
5859 (if (or (eq org-agenda-remove-tags t)
5860 (and org-agenda-remove-tags
5861 org-prefix-has-tag))
5862 (setq txt (replace-match "" t t txt))
5863 (setq txt (replace-match
5864 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5865 (match-string 2 txt))
5866 t t txt))))
5867 (when (derived-mode-p 'org-mode)
5868 (setq effort
5869 (condition-case nil
5870 (org-get-effort
5871 (or (get-text-property 0 'org-hd-marker txt)
5872 (get-text-property 0 'org-marker txt)))
5873 (error nil)))
5874 (when effort
5875 (setq neffort (org-duration-string-to-minutes effort)
5876 effort (setq effort (concat "[" effort "]")))))
5877 ;; prevent erroring out with %e format when there is no effort
5878 (or effort (setq effort ""))
5880 (when remove-re
5881 (while (string-match remove-re txt)
5882 (setq txt (replace-match "" t t txt))))
5884 ;; Set org-heading property on `txt' to mark the start of the
5885 ;; heading.
5886 (add-text-properties 0 (length txt) '(org-heading t) txt)
5888 ;; Prepare the variables needed in the eval of the compiled format
5889 (setq time (cond (s2 (concat
5890 (org-agenda-time-of-day-to-ampm-maybe s1)
5891 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
5892 (if org-agenda-timegrid-use-ampm " ")))
5893 (s1 (concat
5894 (org-agenda-time-of-day-to-ampm-maybe s1)
5895 (if org-agenda-timegrid-use-ampm
5896 "........ "
5897 "......")))
5898 (t ""))
5899 extra (or (and (not habitp) extra) "")
5900 category (if (symbolp category) (symbol-name category) category)
5901 thecategory (copy-sequence category))
5902 (if (string-match org-bracket-link-regexp category)
5903 (progn
5904 (setq l (if (match-end 3)
5905 (- (match-end 3) (match-beginning 3))
5906 (- (match-end 1) (match-beginning 1))))
5907 (when (< l (or org-prefix-category-length 0))
5908 (setq category (copy-sequence category))
5909 (org-add-props category nil
5910 'extra-space (make-string
5911 (- org-prefix-category-length l 1) ?\ ))))
5912 (if (and org-prefix-category-max-length
5913 (>= (length category) org-prefix-category-max-length))
5914 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
5915 ;; Evaluate the compiled format
5916 (setq rtn (concat (eval formatter) txt))
5918 ;; And finally add the text properties
5919 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
5920 (org-add-props rtn nil
5921 'org-category (if thecategory (downcase thecategory) category)
5922 'tags (mapcar 'org-downcase-keep-props tags)
5923 'org-highest-priority org-highest-priority
5924 'org-lowest-priority org-lowest-priority
5925 'time-of-day time-of-day
5926 'duration duration
5927 'effort effort
5928 'effort-minutes neffort
5929 'txt txt
5930 'time time
5931 'extra extra
5932 'format org-prefix-format-compiled
5933 'dotime dotime)))))
5935 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
5936 "Remove tags string from TXT, and add a modified list of tags.
5937 The modified list may contain inherited tags, and tags matched by
5938 `org-agenda-hide-tags-regexp' will be removed."
5939 (when (or add-inherited hide-re)
5940 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
5941 (setq txt (substring txt 0 (match-beginning 0))))
5942 (setq tags
5943 (delq nil
5944 (mapcar (lambda (tg)
5945 (if (or (and hide-re (string-match hide-re tg))
5946 (and (not add-inherited)
5947 (get-text-property 0 'inherited tg)))
5949 tg))
5950 tags)))
5951 (when tags
5952 (let ((have-i (get-text-property 0 'inherited (car tags)))
5954 (setq txt (concat txt " :"
5955 (mapconcat
5956 (lambda (x)
5957 (setq i (get-text-property 0 'inherited x))
5958 (if (and have-i (not i))
5959 (progn
5960 (setq have-i nil)
5961 (concat ":" x))
5963 tags ":")
5964 (if have-i "::" ":"))))))
5965 txt)
5967 (defun org-downcase-keep-props (s)
5968 (let ((props (text-properties-at 0 s)))
5969 (setq s (downcase s))
5970 (add-text-properties 0 (length s) props s)
5973 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
5974 (defvar org-agenda-sorting-strategy-selected nil)
5976 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
5977 (catch 'exit
5978 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
5979 ((and todayp (member 'today (car org-agenda-time-grid))))
5980 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
5981 ((member 'weekly (car org-agenda-time-grid)))
5982 (t (throw 'exit list)))
5983 (let* ((have (delq nil (mapcar
5984 (lambda (x) (get-text-property 1 'time-of-day x))
5985 list)))
5986 (string (nth 1 org-agenda-time-grid))
5987 (gridtimes (nth 2 org-agenda-time-grid))
5988 (req (car org-agenda-time-grid))
5989 (remove (member 'remove-match req))
5990 new time)
5991 (if (and (member 'require-timed req) (not have))
5992 ;; don't show empty grid
5993 (throw 'exit list))
5994 (while (setq time (pop gridtimes))
5995 (unless (and remove (member time have))
5996 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
5997 (push (org-agenda-format-item
5998 nil string "" nil
5999 (concat (substring time 0 -2) ":" (substring time -2)))
6000 new)
6001 (put-text-property
6002 2 (length (car new)) 'face 'org-time-grid (car new))))
6003 (when (and todayp org-agenda-show-current-time-in-grid)
6004 (push (org-agenda-format-item
6006 org-agenda-current-time-string
6007 "" nil
6008 (format-time-string "%H:%M "))
6009 new)
6010 (put-text-property
6011 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6013 (if (member 'time-up org-agenda-sorting-strategy-selected)
6014 (append new list)
6015 (append list new)))))
6017 (defun org-compile-prefix-format (key)
6018 "Compile the prefix format into a Lisp form that can be evaluated.
6019 The resulting form and associated variable bindings is returned
6020 and stored in the variable `org-prefix-format-compiled'."
6021 (setq org-prefix-has-time nil org-prefix-has-tag nil
6022 org-prefix-category-length nil
6023 org-prefix-has-effort nil)
6024 (let ((s (cond
6025 ((stringp org-agenda-prefix-format)
6026 org-agenda-prefix-format)
6027 ((assq key org-agenda-prefix-format)
6028 (cdr (assq key org-agenda-prefix-format)))
6029 (t " %-12:c%?-12t% s")))
6030 (start 0)
6031 varform vars var e c f opt)
6032 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
6033 s start)
6034 (setq var (or (cdr (assoc (match-string 4 s)
6035 '(("c" . category) ("t" . time) ("s" . extra)
6036 ("i" . category-icon) ("T" . tag) ("e" . effort))))
6037 'eval)
6038 c (or (match-string 3 s) "")
6039 opt (match-beginning 1)
6040 start (1+ (match-beginning 0)))
6041 (if (equal var 'time) (setq org-prefix-has-time t))
6042 (if (equal var 'tag) (setq org-prefix-has-tag t))
6043 (if (equal var 'effort) (setq org-prefix-has-effort t))
6044 (setq f (concat "%" (match-string 2 s) "s"))
6045 (when (equal var 'category)
6046 (setq org-prefix-category-length
6047 (floor (abs (string-to-number (match-string 2 s)))))
6048 (setq org-prefix-category-max-length
6049 (let ((x (match-string 2 s)))
6050 (save-match-data
6051 (if (string-match "\\.[0-9]+" x)
6052 (string-to-number (substring (match-string 0 x) 1)))))))
6053 (if (eq var 'eval)
6054 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6055 (if opt
6056 (setq varform
6057 `(if (equal "" ,var)
6059 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6060 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6061 (setq s (replace-match "%s" t nil s))
6062 (push varform vars))
6063 (setq vars (nreverse vars))
6064 (with-current-buffer org-agenda-buffer
6065 (setq org-prefix-format-compiled
6066 (list
6067 `((org-prefix-has-time ,org-prefix-has-time)
6068 (org-prefix-has-tag ,org-prefix-has-tag)
6069 (org-prefix-category-length ,org-prefix-category-length)
6070 (org-prefix-has-effort ,org-prefix-has-effort))
6071 `(format ,s ,@vars))))))
6073 (defun org-set-sorting-strategy (key)
6074 (if (symbolp (car org-agenda-sorting-strategy))
6075 ;; the old format
6076 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6077 (setq org-agenda-sorting-strategy-selected
6078 (or (cdr (assq key org-agenda-sorting-strategy))
6079 (cdr (assq 'agenda org-agenda-sorting-strategy))
6080 '(time-up category-keep priority-down)))))
6082 (defun org-get-time-of-day (s &optional string mod24)
6083 "Check string S for a time of day.
6084 If found, return it as a military time number between 0 and 2400.
6085 If not found, return nil.
6086 The optional STRING argument forces conversion into a 5 character wide string
6087 HH:MM."
6088 (save-match-data
6089 (when
6090 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6091 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6092 (let* ((h (string-to-number (match-string 1 s)))
6093 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6094 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6095 (am-p (equal ampm "am"))
6096 (h1 (cond ((not ampm) h)
6097 ((= h 12) (if am-p 0 12))
6098 (t (+ h (if am-p 0 12)))))
6099 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6100 (mod h1 24) h1))
6101 (t0 (+ (* 100 h2) m))
6102 (t1 (concat (if (>= h1 24) "+" " ")
6103 (if (and org-agenda-time-leading-zero
6104 (< t0 1000)) "0" "")
6105 (if (< t0 100) "0" "")
6106 (if (< t0 10) "0" "")
6107 (int-to-string t0))))
6108 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6110 (defvar org-agenda-before-sorting-filter-function nil
6111 "Function to be applied to agenda items prior to sorting.
6112 Prior to sorting also means just before they are inserted into the agenda.
6114 To aid sorting, you may revisit the original entries and add more text
6115 properties which will later be used by the sorting functions.
6117 The function should take a string argument, an agenda line.
6118 It has access to the text properties in that line, which contain among
6119 other things, the property `org-hd-marker' that points to the entry
6120 where the line comes from. Note that not all lines going into the agenda
6121 have this property, only most.
6123 The function should return the modified string. It is probably best
6124 to ONLY change text properties.
6126 You can also use this function as a filter, by returning nil for lines
6127 you don't want to have in the agenda at all. For this application, you
6128 could bind the variable in the options section of a custom command.")
6130 (defun org-finalize-agenda-entries (list &optional nosort)
6131 "Sort and concatenate the agenda items."
6132 (setq list (mapcar 'org-agenda-highlight-todo list))
6133 (if nosort
6134 list
6135 (when org-agenda-before-sorting-filter-function
6136 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6137 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6139 (defun org-agenda-highlight-todo (x)
6140 (let ((org-done-keywords org-done-keywords-for-agenda)
6141 (case-fold-search nil)
6143 (if (eq x 'line)
6144 (save-excursion
6145 (beginning-of-line 1)
6146 (setq re (org-get-at-bol 'org-todo-regexp))
6147 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6148 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6149 (add-text-properties (match-beginning 0) (match-end 1)
6150 (list 'face (org-get-todo-face 1)))
6151 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6152 (delete-region (match-beginning 1) (1- (match-end 0)))
6153 (goto-char (match-beginning 1))
6154 (insert (format org-agenda-todo-keyword-format s)))))
6155 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6156 (setq re (get-text-property 0 'org-todo-regexp x))
6157 (when (and re
6158 ;; Test `pl' because if there's no heading content,
6159 ;; there's no point matching to highlight. Note
6160 ;; that if we didn't test `pl' first, and there
6161 ;; happened to be no keyword from `org-todo-regexp'
6162 ;; on this heading line, then the `equal' comparison
6163 ;; afterwards would spuriously succeed in the case
6164 ;; where `pl' is nil -- causing an args-out-of-range
6165 ;; error when we try to add text properties to text
6166 ;; that isn't there.
6168 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6169 x pl) pl))
6170 (add-text-properties
6171 (or (match-end 1) (match-end 0)) (match-end 0)
6172 (list 'face (org-get-todo-face (match-string 2 x)))
6174 (when (match-end 1)
6175 (setq x (concat (substring x 0 (match-end 1))
6176 (format org-agenda-todo-keyword-format
6177 (match-string 2 x))
6178 (org-add-props " " (text-properties-at 0 x))
6179 (substring x (match-end 3)))))))
6180 x)))
6182 (defsubst org-cmp-priority (a b)
6183 "Compare the priorities of string A and B."
6184 (let ((pa (or (get-text-property 1 'priority a) 0))
6185 (pb (or (get-text-property 1 'priority b) 0)))
6186 (cond ((> pa pb) +1)
6187 ((< pa pb) -1))))
6189 (defsubst org-cmp-effort (a b)
6190 "Compare the effort values of string A and B."
6191 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6192 (ea (or (get-text-property 1 'effort-minutes a) def))
6193 (eb (or (get-text-property 1 'effort-minutes b) def)))
6194 (cond ((> ea eb) +1)
6195 ((< ea eb) -1))))
6197 (defsubst org-cmp-category (a b)
6198 "Compare the string values of categories of strings A and B."
6199 (let ((ca (or (get-text-property 1 'org-category a) ""))
6200 (cb (or (get-text-property 1 'org-category b) "")))
6201 (cond ((string-lessp ca cb) -1)
6202 ((string-lessp cb ca) +1))))
6204 (defsubst org-cmp-todo-state (a b)
6205 "Compare the todo states of strings A and B."
6206 (let* ((ma (or (get-text-property 1 'org-marker a)
6207 (get-text-property 1 'org-hd-marker a)))
6208 (mb (or (get-text-property 1 'org-marker b)
6209 (get-text-property 1 'org-hd-marker b)))
6210 (fa (and ma (marker-buffer ma)))
6211 (fb (and mb (marker-buffer mb)))
6212 (todo-kwds
6213 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6214 (and fb (with-current-buffer fb org-todo-keywords-1))))
6215 (ta (or (get-text-property 1 'todo-state a) ""))
6216 (tb (or (get-text-property 1 'todo-state b) ""))
6217 (la (- (length (member ta todo-kwds))))
6218 (lb (- (length (member tb todo-kwds))))
6219 (donepa (member ta org-done-keywords-for-agenda))
6220 (donepb (member tb org-done-keywords-for-agenda)))
6221 (cond ((and donepa (not donepb)) -1)
6222 ((and (not donepa) donepb) +1)
6223 ((< la lb) -1)
6224 ((< lb la) +1))))
6226 (defsubst org-cmp-alpha (a b)
6227 "Compare the headlines, alphabetically."
6228 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6229 (plb (text-property-any 0 (length b) 'org-heading t b))
6230 (ta (and pla (substring a pla)))
6231 (tb (and plb (substring b plb))))
6232 (when pla
6233 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6234 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6235 (setq ta (substring ta (match-end 0))))
6236 (setq ta (downcase ta)))
6237 (when plb
6238 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6239 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6240 (setq tb (substring tb (match-end 0))))
6241 (setq tb (downcase tb)))
6242 (cond ((not ta) +1)
6243 ((not tb) -1)
6244 ((string-lessp ta tb) -1)
6245 ((string-lessp tb ta) +1))))
6247 (defsubst org-cmp-tag (a b)
6248 "Compare the string values of the first tags of A and B."
6249 (let ((ta (car (last (get-text-property 1 'tags a))))
6250 (tb (car (last (get-text-property 1 'tags b)))))
6251 (cond ((not ta) +1)
6252 ((not tb) -1)
6253 ((string-lessp ta tb) -1)
6254 ((string-lessp tb ta) +1))))
6256 (defsubst org-cmp-time (a b)
6257 "Compare the time-of-day values of strings A and B."
6258 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6259 (ta (or (get-text-property 1 'time-of-day a) def))
6260 (tb (or (get-text-property 1 'time-of-day b) def)))
6261 (cond ((< ta tb) -1)
6262 ((< tb ta) +1))))
6264 (defsubst org-cmp-habit-p (a b)
6265 "Compare the todo states of strings A and B."
6266 (let ((ha (get-text-property 1 'org-habit-p a))
6267 (hb (get-text-property 1 'org-habit-p b)))
6268 (cond ((and ha (not hb)) -1)
6269 ((and (not ha) hb) +1))))
6271 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6273 (defun org-entries-lessp (a b)
6274 "Predicate for sorting agenda entries."
6275 ;; The following variables will be used when the form is evaluated.
6276 ;; So even though the compiler complains, keep them.
6277 (let* ((ss org-agenda-sorting-strategy-selected)
6278 (time-up (and (org-em 'time-up 'time-down ss)
6279 (org-cmp-time a b)))
6280 (time-down (if time-up (- time-up) nil))
6281 (priority-up (and (org-em 'priority-up 'priority-down ss)
6282 (org-cmp-priority a b)))
6283 (priority-down (if priority-up (- priority-up) nil))
6284 (effort-up (and (org-em 'effort-up 'effort-down ss)
6285 (org-cmp-effort a b)))
6286 (effort-down (if effort-up (- effort-up) nil))
6287 (category-up (and (or (org-em 'category-up 'category-down ss)
6288 (memq 'category-keep ss))
6289 (org-cmp-category a b)))
6290 (category-down (if category-up (- category-up) nil))
6291 (category-keep (if category-up +1 nil))
6292 (tag-up (and (org-em 'tag-up 'tag-down ss)
6293 (org-cmp-tag a b)))
6294 (tag-down (if tag-up (- tag-up) nil))
6295 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6296 (org-cmp-todo-state a b)))
6297 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6298 (habit-up (and (org-em 'habit-up 'habit-down ss)
6299 (org-cmp-habit-p a b)))
6300 (habit-down (if habit-up (- habit-up) nil))
6301 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6302 (org-cmp-alpha a b)))
6303 (alpha-down (if alpha-up (- alpha-up) nil))
6304 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6305 user-defined-up user-defined-down)
6306 (if (and need-user-cmp org-agenda-cmp-user-defined
6307 (functionp org-agenda-cmp-user-defined))
6308 (setq user-defined-up
6309 (funcall org-agenda-cmp-user-defined a b)
6310 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6311 (cdr (assoc
6312 (eval (cons 'or org-agenda-sorting-strategy-selected))
6313 '((-1 . t) (1 . nil) (nil . nil))))))
6315 ;;; Agenda restriction lock
6317 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6318 "Overlay to mark the headline to which agenda commands are restricted.")
6319 (overlay-put org-agenda-restriction-lock-overlay
6320 'face 'org-agenda-restriction-lock)
6321 (overlay-put org-agenda-restriction-lock-overlay
6322 'help-echo "Agendas are currently limited to this subtree.")
6323 (org-detach-overlay org-agenda-restriction-lock-overlay)
6325 (defun org-agenda-set-restriction-lock (&optional type)
6326 "Set restriction lock for agenda, to current subtree or file.
6327 Restriction will be the file if TYPE is `file', or if type is the
6328 universal prefix '(4), or if the cursor is before the first headline
6329 in the file. Otherwise, restriction will be to the current subtree."
6330 (interactive "P")
6331 (and (equal type '(4)) (setq type 'file))
6332 (setq type (cond
6333 (type type)
6334 ((org-at-heading-p) 'subtree)
6335 ((condition-case nil (org-back-to-heading t) (error nil))
6336 'subtree)
6337 (t 'file)))
6338 (if (eq type 'subtree)
6339 (progn
6340 (setq org-agenda-restrict t)
6341 (setq org-agenda-overriding-restriction 'subtree)
6342 (put 'org-agenda-files 'org-restrict
6343 (list (buffer-file-name (buffer-base-buffer))))
6344 (org-back-to-heading t)
6345 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6346 (move-marker org-agenda-restrict-begin (point))
6347 (move-marker org-agenda-restrict-end
6348 (save-excursion (org-end-of-subtree t)))
6349 (message "Locking agenda restriction to subtree"))
6350 (put 'org-agenda-files 'org-restrict
6351 (list (buffer-file-name (buffer-base-buffer))))
6352 (setq org-agenda-restrict nil)
6353 (setq org-agenda-overriding-restriction 'file)
6354 (move-marker org-agenda-restrict-begin nil)
6355 (move-marker org-agenda-restrict-end nil)
6356 (message "Locking agenda restriction to file"))
6357 (setq current-prefix-arg nil)
6358 (org-agenda-maybe-redo))
6360 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6361 "Remove the agenda restriction lock."
6362 (interactive "P")
6363 (org-detach-overlay org-agenda-restriction-lock-overlay)
6364 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6365 (setq org-agenda-overriding-restriction nil)
6366 (setq org-agenda-restrict nil)
6367 (put 'org-agenda-files 'org-restrict nil)
6368 (move-marker org-agenda-restrict-begin nil)
6369 (move-marker org-agenda-restrict-end nil)
6370 (setq current-prefix-arg nil)
6371 (message "Agenda restriction lock removed")
6372 (or noupdate (org-agenda-maybe-redo)))
6374 (defun org-agenda-maybe-redo ()
6375 "If there is any window showing the agenda view, update it."
6376 (let ((w (get-buffer-window org-agenda-buffer-name t))
6377 (w0 (selected-window)))
6378 (when w
6379 (select-window w)
6380 (org-agenda-redo)
6381 (select-window w0)
6382 (if org-agenda-overriding-restriction
6383 (message "Agenda view shifted to new %s restriction"
6384 org-agenda-overriding-restriction)
6385 (message "Agenda restriction lock removed")))))
6387 ;;; Agenda commands
6389 (defun org-agenda-check-type (error &rest types)
6390 "Check if agenda buffer is of allowed type.
6391 If ERROR is non-nil, throw an error, otherwise just return nil."
6392 (if (not org-agenda-type)
6393 (error "No Org agenda currently displayed")
6394 (if (memq org-agenda-type types)
6396 (if error
6397 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6398 nil))))
6400 (defun org-agenda-Quit (&optional arg)
6401 "Exit agenda by removing the window or the buffer."
6402 (interactive)
6403 (if org-agenda-columns-active
6404 (org-columns-quit)
6405 (let ((buf (current-buffer)))
6406 (if (eq org-agenda-window-setup 'other-frame)
6407 (progn
6408 (org-agenda-reset-markers)
6409 (kill-buffer buf)
6410 (org-columns-remove-overlays)
6411 (setq org-agenda-archives-mode nil)
6412 (delete-frame))
6413 (and (not (eq org-agenda-window-setup 'current-window))
6414 (not (one-window-p))
6415 (delete-window))
6416 (org-agenda-reset-markers)
6417 (kill-buffer buf)
6418 (org-columns-remove-overlays)
6419 (setq org-agenda-archives-mode nil)))
6420 ;; Maybe restore the pre-agenda window configuration.
6421 (and org-agenda-restore-windows-after-quit
6422 (not (eq org-agenda-window-setup 'other-frame))
6423 org-pre-agenda-window-conf
6424 (set-window-configuration org-pre-agenda-window-conf))))
6426 (defun org-agenda-quit ()
6427 "Exit agenda by killing agenda buffer or burying it when
6428 `org-agenda-sticky' is non-NIL"
6429 (interactive)
6430 (if org-agenda-columns-active
6431 (org-columns-quit)
6432 (if org-agenda-sticky
6433 (let ((buf (current-buffer)))
6434 (if (eq org-agenda-window-setup 'other-frame)
6435 (progn
6436 (delete-frame))
6437 (and (not (eq org-agenda-window-setup 'current-window))
6438 (not (one-window-p))
6439 (delete-window)))
6440 (with-current-buffer buf
6441 (bury-buffer)
6442 ;; Maybe restore the pre-agenda window configuration.
6443 (and org-agenda-restore-windows-after-quit
6444 (not (eq org-agenda-window-setup 'other-frame))
6445 org-pre-agenda-window-conf
6446 (set-window-configuration org-pre-agenda-window-conf))))
6447 (org-agenda-Quit))))
6449 (defun org-agenda-exit ()
6450 "Exit agenda by removing the window or the buffer.
6451 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6452 Org-mode buffers visited directly by the user will not be touched."
6453 (interactive)
6454 (org-release-buffers org-agenda-new-buffers)
6455 (setq org-agenda-new-buffers nil)
6456 (org-agenda-Quit))
6458 (defun org-agenda-kill-all-agenda-buffers ()
6459 "Kill all buffers in `org-agena-mode'.
6460 This is used when toggling sticky agendas. You can also explicitly invoke it
6461 with `C-c a C-k'."
6462 (interactive)
6463 (let (blist)
6464 (dolist (buf (buffer-list))
6465 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
6466 (push buf blist)))
6467 (mapc 'kill-buffer blist)))
6469 (defun org-agenda-execute (arg)
6470 "Execute another agenda command, keeping same window.
6471 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6472 in the agenda."
6473 (interactive "P")
6474 (let ((org-agenda-window-setup 'current-window))
6475 (org-agenda arg)))
6477 (defun org-agenda-redo ()
6478 "Rebuild Agenda.
6479 When this is the global TODO list, a prefix argument will be interpreted."
6480 (interactive)
6481 (let* ((org-agenda-doing-sticky-redo org-agenda-sticky)
6482 (org-agenda-sticky nil)
6483 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6484 org-agenda-buffer-name))
6485 (org-agenda-keep-modes t)
6486 (tag-filter org-agenda-tag-filter)
6487 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6488 (top-cat-filter org-agenda-top-category-filter)
6489 (cat-filter org-agenda-category-filter)
6490 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6491 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6492 (cols org-agenda-columns-active)
6493 (line (org-current-line))
6494 (window-line (- line (org-current-line (window-start))))
6495 (lprops (get 'org-agenda-redo-command 'org-lprops)))
6496 (put 'org-agenda-tag-filter :preset-filter nil)
6497 (put 'org-agenda-category-filter :preset-filter nil)
6498 (and cols (org-columns-quit))
6499 (message "Rebuilding agenda buffer...")
6500 (org-let lprops '(eval org-agenda-redo-command))
6501 (setq org-agenda-undo-list nil
6502 org-agenda-pending-undo-list nil)
6503 (message "Rebuilding agenda buffer...done")
6504 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6505 (put 'org-agenda-category-filter :preset-filter cat-preset)
6506 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6507 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6508 (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
6509 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6510 (org-goto-line line)
6511 (recenter window-line)))
6513 (defvar org-global-tags-completion-table nil)
6514 (defvar org-agenda-filter-form nil)
6515 (defvar org-agenda-filtered-by-category nil)
6517 (defun org-agenda-filter-by-category (strip)
6518 "Keep only those lines in the agenda buffer that have a specific category.
6519 The category is that of the current line."
6520 (interactive "P")
6521 (if org-agenda-filtered-by-category
6522 (org-agenda-filter-show-all-cat)
6523 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6524 (if cat (org-agenda-filter-apply
6525 (list (concat (if strip "-" "+") cat)) 'category)
6526 (error "No category at point")))))
6528 (defun org-find-top-category (&optional pos)
6529 (save-excursion
6530 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
6531 (if pos (goto-char pos))
6532 ;; Skip up to the topmost parent
6533 (while (ignore-errors (outline-up-heading 1) t))
6534 (ignore-errors
6535 (nth 4 (org-heading-components))))))
6537 (defvar org-agenda-filtered-by-top-category nil)
6539 (defun org-agenda-filter-by-top-category (strip)
6540 "Keep only those lines in the agenda buffer that have a specific category.
6541 The category is that of the current line."
6542 (interactive "P")
6543 (if org-agenda-filtered-by-top-category
6544 (progn
6545 (setq org-agenda-filtered-by-top-category nil
6546 org-agenda-top-category-filter nil)
6547 (org-agenda-filter-show-all-cat))
6548 (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
6549 (if cat (org-agenda-filter-top-category-apply cat strip)
6550 (error "No top-level category at point")))))
6552 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6553 "Keep only those lines in the agenda buffer that have a specific tag.
6554 The tag is selected with its fast selection letter, as configured.
6555 With prefix argument STRIP, remove all lines that do have the tag.
6556 A lisp caller can specify CHAR. NARROW means that the new tag should be
6557 used to narrow the search - the interactive user can also press `-' or `+'
6558 to switch to narrowing."
6559 (interactive "P")
6560 (let* ((alist org-tag-alist-for-agenda)
6561 (tag-chars (mapconcat
6562 (lambda (x) (if (and (not (symbolp (car x)))
6563 (cdr x))
6564 (char-to-string (cdr x))
6565 ""))
6566 alist ""))
6567 (efforts (org-split-string
6568 (or (cdr (assoc (concat org-effort-property "_ALL")
6569 org-global-properties))
6570 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6571 "")))
6572 (effort-op org-agenda-filter-effort-default-operator)
6573 (effort-prompt "")
6574 (inhibit-read-only t)
6575 (current org-agenda-tag-filter)
6576 maybe-refresh a n tag)
6577 (unless char
6578 (message
6579 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6580 (if narrow "Narrow" "Filter") tag-chars
6581 (if org-agenda-auto-exclude-function "[RET], " ""))
6582 (setq char (read-char-exclusive)))
6583 (when (member char '(?+ ?-))
6584 ;; Narrowing down
6585 (cond ((equal char ?-) (setq strip t narrow t))
6586 ((equal char ?+) (setq strip nil narrow t)))
6587 (message
6588 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6589 (setq char (read-char-exclusive)))
6590 (when (member char '(?< ?> ?= ??))
6591 ;; An effort operator
6592 (setq effort-op (char-to-string char))
6593 (setq alist nil) ; to make sure it will be interpreted as effort.
6594 (unless (equal char ??)
6595 (loop for i from 0 to 9 do
6596 (setq effort-prompt
6597 (concat
6598 effort-prompt " ["
6599 (if (= i 9) "0" (int-to-string (1+ i)))
6600 "]" (nth i efforts))))
6601 (message "Effort%s: %s " effort-op effort-prompt)
6602 (setq char (read-char-exclusive))
6603 (when (or (< char ?0) (> char ?9))
6604 (error "Need 1-9,0 to select effort"))))
6605 (when (equal char ?\t)
6606 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6607 (org-set-local 'org-global-tags-completion-table
6608 (org-global-tags-completion-table)))
6609 (let ((completion-ignore-case t))
6610 (setq tag (org-icompleting-read
6611 "Tag: " org-global-tags-completion-table))))
6612 (cond
6613 ((equal char ?\r)
6614 (org-agenda-filter-show-all-tag)
6615 (when org-agenda-auto-exclude-function
6616 (setq org-agenda-tag-filter '())
6617 (dolist (tag (org-agenda-get-represented-tags))
6618 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6619 (if modifier
6620 (push modifier org-agenda-tag-filter))))
6621 (if (not (null org-agenda-tag-filter))
6622 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6623 (setq maybe-refresh t))
6624 ((equal char ?/)
6625 (org-agenda-filter-show-all-tag)
6626 (when (get 'org-agenda-tag-filter :preset-filter)
6627 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6628 (setq maybe-refresh t))
6629 ((equal char ?. )
6630 (setq org-agenda-tag-filter
6631 (mapcar (lambda(tag) (concat "+" tag))
6632 (org-get-at-bol 'tags)))
6633 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6634 (setq maybe-refresh t))
6635 ((or (equal char ?\ )
6636 (setq a (rassoc char alist))
6637 (and (>= char ?0) (<= char ?9)
6638 (setq n (if (= char ?0) 9 (- char ?0 1))
6639 tag (concat effort-op (nth n efforts))
6640 a (cons tag nil)))
6641 (and (= char ??)
6642 (setq tag "?eff")
6643 a (cons tag nil))
6644 (and tag (setq a (cons tag nil))))
6645 (org-agenda-filter-show-all-tag)
6646 (setq tag (car a))
6647 (setq org-agenda-tag-filter
6648 (cons (concat (if strip "-" "+") tag)
6649 (if narrow current nil)))
6650 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6651 (setq maybe-refresh t))
6652 (t (error "Invalid tag selection character %c" char)))
6653 (when (and maybe-refresh
6654 (eq org-agenda-clockreport-mode 'with-filter))
6655 (org-agenda-redo))))
6657 (defun org-agenda-get-represented-tags ()
6658 "Get a list of all tags currently represented in the agenda."
6659 (let (p tags)
6660 (save-excursion
6661 (goto-char (point-min))
6662 (while (setq p (next-single-property-change (point) 'tags))
6663 (goto-char p)
6664 (mapc (lambda (x) (add-to-list 'tags x))
6665 (get-text-property (point) 'tags))))
6666 tags))
6668 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6669 "Refine the current filter. See `org-agenda-filter-by-tag'."
6670 (interactive "P")
6671 (org-agenda-filter-by-tag strip char 'refine))
6673 (defun org-agenda-filter-make-matcher ()
6674 "Create the form that tests a line for agenda filter."
6675 (let (f f1)
6676 ;; first compute the tag-filter matcher
6677 (dolist (x (delete-dups
6678 (append (get 'org-agenda-tag-filter
6679 :preset-filter) org-agenda-tag-filter)))
6680 (if (member x '("-" "+"))
6681 (setq f1 (if (equal x "-") 'tags '(not tags)))
6682 (if (string-match "[<=>?]" x)
6683 (setq f1 (org-agenda-filter-effort-form x))
6684 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6685 (if (equal (string-to-char x) ?-)
6686 (setq f1 (list 'not f1))))
6687 (push f1 f))
6688 ;; then compute the category-filter matcher
6689 (dolist (x (delete-dups
6690 (append (get 'org-agenda-category-filter
6691 :preset-filter) org-agenda-category-filter)))
6692 (if (equal "-" (substring x 0 1))
6693 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
6694 (setq f1 (list 'equal (substring x 1) 'cat)))
6695 (push f1 f))
6696 (cons 'and (nreverse f))))
6698 (defun org-agenda-filter-effort-form (e)
6699 "Return the form to compare the effort of the current line with what E says.
6700 E looks like \"+<2:25\"."
6701 (let (op)
6702 (setq e (substring e 1))
6703 (setq op (string-to-char e) e (substring e 1))
6704 (setq op (cond ((equal op ?<) '<=)
6705 ((equal op ?>) '>=)
6706 ((equal op ??) op)
6707 (t '=)))
6708 (list 'org-agenda-compare-effort (list 'quote op)
6709 (org-duration-string-to-minutes e))))
6711 (defun org-agenda-compare-effort (op value)
6712 "Compare the effort of the current line with VALUE, using OP.
6713 If the line does not have an effort defined, return nil."
6714 (let ((eff (org-get-at-bol 'effort-minutes)))
6715 (if (equal op ??)
6716 (not eff)
6717 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6718 value))))
6720 (defun org-agenda-filter-apply (filter type)
6721 "Set FILTER as the new agenda filter and apply it."
6722 (let (tags cat)
6723 (if (eq type 'tag)
6724 (setq org-agenda-tag-filter filter)
6725 (setq org-agenda-category-filter filter))
6726 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6727 (if (and (eq type 'category)
6728 (not (equal (substring (car filter) 0 1) "-")))
6729 ;; Only set `org-agenda-filtered-by-category' to t
6730 ;; when a unique category is used as the filter
6731 (setq org-agenda-filtered-by-category t))
6732 (org-agenda-set-mode-name)
6733 (save-excursion
6734 (goto-char (point-min))
6735 (while (not (eobp))
6736 (if (org-get-at-bol 'org-marker)
6737 (progn
6738 (setq tags (org-get-at-bol 'tags) ; used in eval
6739 cat (get-text-property (point) 'org-category))
6740 (if (not (eval org-agenda-filter-form))
6741 (org-agenda-filter-hide-line type))
6742 (beginning-of-line 2))
6743 (beginning-of-line 2))))
6744 (if (get-char-property (point) 'invisible)
6745 (ignore-errors (org-agenda-previous-line)))))
6747 (defun org-agenda-filter-top-category-apply (category &optional negative)
6748 "Set FILTER as the new agenda filter and apply it."
6749 (org-agenda-set-mode-name)
6750 (save-excursion
6751 (goto-char (point-min))
6752 (while (not (eobp))
6753 (let* ((pos (org-get-at-bol 'org-hd-marker))
6754 (topcat (and pos (org-find-top-category pos))))
6755 (if (and topcat (funcall (if negative 'identity 'not)
6756 (string= category topcat)))
6757 (org-agenda-filter-hide-line 'category)))
6758 (beginning-of-line 2)))
6759 (if (get-char-property (point) 'invisible)
6760 (org-agenda-previous-line))
6761 (setq org-agenda-top-category-filter category
6762 org-agenda-filtered-by-top-category t))
6764 (defun org-agenda-filter-hide-line (type)
6765 (let (ov)
6766 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6767 (point-at-eol)))
6768 (overlay-put ov 'invisible t)
6769 (overlay-put ov 'type type)
6770 (if (eq type 'tag)
6771 (push ov org-agenda-tag-filter-overlays)
6772 (push ov org-agenda-cat-filter-overlays))))
6774 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6775 (setq pos (or pos (point)))
6776 (save-excursion
6777 (dolist (ov (overlays-at pos))
6778 (when (and (overlay-get ov 'invisible)
6779 (eq (overlay-get ov 'type) 'tag))
6780 (goto-char pos)
6781 (if (< (overlay-start ov) (point-at-eol))
6782 (move-overlay ov (point-at-eol)
6783 (overlay-end ov)))))))
6785 (defun org-agenda-filter-show-all-tag nil
6786 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6787 (setq org-agenda-tag-filter-overlays nil
6788 org-agenda-tag-filter nil
6789 org-agenda-filter-form nil)
6790 (org-agenda-set-mode-name))
6792 (defun org-agenda-filter-show-all-cat nil
6793 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6794 (setq org-agenda-cat-filter-overlays nil
6795 org-agenda-filtered-by-category nil
6796 org-agenda-category-filter nil
6797 org-agenda-filter-form nil)
6798 (org-agenda-set-mode-name))
6800 (defun org-agenda-manipulate-query-add ()
6801 "Manipulate the query by adding a search term with positive selection.
6802 Positive selection means the term must be matched for selection of an entry."
6803 (interactive)
6804 (org-agenda-manipulate-query ?\[))
6805 (defun org-agenda-manipulate-query-subtract ()
6806 "Manipulate the query by adding a search term with negative selection.
6807 Negative selection means term must not be matched for selection of an entry."
6808 (interactive)
6809 (org-agenda-manipulate-query ?\]))
6810 (defun org-agenda-manipulate-query-add-re ()
6811 "Manipulate the query by adding a search regexp with positive selection.
6812 Positive selection means the regexp must match for selection of an entry."
6813 (interactive)
6814 (org-agenda-manipulate-query ?\{))
6815 (defun org-agenda-manipulate-query-subtract-re ()
6816 "Manipulate the query by adding a search regexp with negative selection.
6817 Negative selection means regexp must not match for selection of an entry."
6818 (interactive)
6819 (org-agenda-manipulate-query ?\}))
6820 (defun org-agenda-manipulate-query (char)
6821 (cond
6822 ((memq org-agenda-type '(timeline agenda))
6823 (let ((org-agenda-include-inactive-timestamps t))
6824 (org-agenda-redo))
6825 (message "Display now includes inactive timestamps as well"))
6826 ((eq org-agenda-type 'search)
6827 (org-add-to-string
6828 'org-agenda-query-string
6829 (if org-agenda-last-search-view-search-was-boolean
6830 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6831 (?\{ . " +{}") (?\} . " -{}"))))
6832 " "))
6833 (setq org-agenda-redo-command
6834 (list 'org-search-view
6835 org-todo-only
6836 org-agenda-query-string
6837 (+ (length org-agenda-query-string)
6838 (if (member char '(?\{ ?\})) 0 1))))
6839 (set-register org-agenda-query-register org-agenda-query-string)
6840 (org-agenda-redo))
6841 (t (error "Cannot manipulate query for %s-type agenda buffers"
6842 org-agenda-type))))
6844 (defun org-add-to-string (var string)
6845 (set var (concat (symbol-value var) string)))
6847 (defun org-agenda-goto-date (date)
6848 "Jump to DATE in agenda."
6849 (interactive (list (let ((org-read-date-prefer-future
6850 (eval org-agenda-jump-prefer-future)))
6851 (org-read-date))))
6852 (org-agenda-list nil date))
6854 (defun org-agenda-goto-today ()
6855 "Go to today."
6856 (interactive)
6857 (org-agenda-check-type t 'timeline 'agenda)
6858 (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6859 (cond
6860 (tdpos (goto-char tdpos))
6861 ((eq org-agenda-type 'agenda)
6862 (let* ((sd (org-agenda-compute-starting-span
6863 (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
6864 (org-agenda-overriding-arguments org-agenda-last-arguments))
6865 (setf (nth 1 org-agenda-overriding-arguments) sd)
6866 (org-agenda-redo)
6867 (org-agenda-find-same-or-today-or-agenda)))
6868 (t (error "Cannot find today")))))
6870 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
6871 (goto-char
6872 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
6873 (text-property-any (point-min) (point-max) 'org-today t)
6874 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
6875 (point-min))))
6877 (defun org-agenda-later (arg)
6878 "Go forward in time by thee current span.
6879 With prefix ARG, go forward that many times the current span."
6880 (interactive "p")
6881 (org-agenda-check-type t 'agenda)
6882 (let* ((span org-agenda-current-span)
6883 (sd org-starting-day)
6884 (greg (calendar-gregorian-from-absolute sd))
6885 (cnt (org-get-at-bol 'org-day-cnt))
6886 greg2)
6887 (cond
6888 ((eq span 'day)
6889 (setq sd (+ arg sd)))
6890 ((eq span 'week)
6891 (setq sd (+ (* 7 arg) sd)))
6892 ((eq span 'month)
6893 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
6894 sd (calendar-absolute-from-gregorian greg2))
6895 (setcar greg2 (1+ (car greg2))))
6896 ((eq span 'year)
6897 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
6898 sd (calendar-absolute-from-gregorian greg2))
6899 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
6901 (setq sd (+ (* span arg) sd))))
6902 (let ((org-agenda-overriding-arguments
6903 (list (car org-agenda-last-arguments) sd span t)))
6904 (org-agenda-redo)
6905 (org-agenda-find-same-or-today-or-agenda cnt))))
6907 (defun org-agenda-earlier (arg)
6908 "Go backward in time by the current span.
6909 With prefix ARG, go backward that many times the current span."
6910 (interactive "p")
6911 (org-agenda-later (- arg)))
6913 (defun org-agenda-view-mode-dispatch ()
6914 "Call one of the view mode commands."
6915 (interactive)
6916 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
6917 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
6918 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
6919 (let ((a (read-char-exclusive)))
6920 (case a
6921 (?\ (call-interactively 'org-agenda-reset-view))
6922 (?d (call-interactively 'org-agenda-day-view))
6923 (?w (call-interactively 'org-agenda-week-view))
6924 (?m (call-interactively 'org-agenda-month-view))
6925 (?y (call-interactively 'org-agenda-year-view))
6926 (?l (call-interactively 'org-agenda-log-mode))
6927 (?L (org-agenda-log-mode '(4)))
6928 (?c (org-agenda-log-mode 'clockcheck))
6929 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
6930 (?a (call-interactively 'org-agenda-archives-mode))
6931 (?A (org-agenda-archives-mode 'files))
6932 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
6933 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
6934 (?G (call-interactively 'org-agenda-toggle-time-grid))
6935 (?D (call-interactively 'org-agenda-toggle-diary))
6936 (?\! (call-interactively 'org-agenda-toggle-deadlines))
6937 (?\[ (let ((org-agenda-include-inactive-timestamps t))
6938 (org-agenda-check-type t 'timeline 'agenda)
6939 (org-agenda-redo))
6940 (message "Display now includes inactive timestamps as well"))
6941 (?q (message "Abort"))
6942 (otherwise (error "Invalid key" )))))
6944 (defun org-agenda-reset-view ()
6945 "Switch to default view for agenda."
6946 (interactive)
6947 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
6948 (defun org-agenda-day-view (&optional day-of-year)
6949 "Switch to daily view for agenda.
6950 With argument DAY-OF-YEAR, switch to that day of the year."
6951 (interactive "P")
6952 (org-agenda-change-time-span 'day day-of-year))
6953 (defun org-agenda-week-view (&optional iso-week)
6954 "Switch to daily view for agenda.
6955 With argument ISO-WEEK, switch to the corresponding ISO week.
6956 If ISO-WEEK has more then 2 digits, only the last two encode the
6957 week. Any digits before this encode a year. So 200712 means
6958 week 12 of year 2007. Years in the range 1938-2037 can also be
6959 written as 2-digit years."
6960 (interactive "P")
6961 (org-agenda-change-time-span 'week iso-week))
6962 (defun org-agenda-month-view (&optional month)
6963 "Switch to monthly view for agenda.
6964 With argument MONTH, switch to that month."
6965 (interactive "P")
6966 (org-agenda-change-time-span 'month month))
6967 (defun org-agenda-year-view (&optional year)
6968 "Switch to yearly view for agenda.
6969 With argument YEAR, switch to that year.
6970 If MONTH has more then 2 digits, only the last two encode the
6971 month. Any digits before this encode a year. So 200712 means
6972 December year 2007. Years in the range 1938-2037 can also be
6973 written as 2-digit years."
6974 (interactive "P")
6975 (when year
6976 (setq year (org-small-year-to-year year)))
6977 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
6978 (org-agenda-change-time-span 'year year)
6979 (error "Abort")))
6981 (defun org-agenda-change-time-span (span &optional n)
6982 "Change the agenda view to SPAN.
6983 SPAN may be `day', `week', `month', `year'."
6984 (org-agenda-check-type t 'agenda)
6985 (if (and (not n) (equal org-agenda-current-span span))
6986 (error "Viewing span is already \"%s\"" span))
6987 (let* ((sd (or (org-get-at-bol 'day)
6988 org-starting-day))
6989 (sd (org-agenda-compute-starting-span sd span n))
6990 (org-agenda-overriding-arguments
6991 (or org-agenda-overriding-arguments
6992 (list (car org-agenda-last-arguments) sd span t))))
6993 (org-agenda-redo)
6994 (org-agenda-find-same-or-today-or-agenda))
6995 (org-agenda-set-mode-name)
6996 (message "Switched to %s view" span))
6998 (defun org-agenda-compute-starting-span (sd span &optional n)
6999 "Compute starting date for agenda.
7000 SPAN may be `day', `week', `month', `year'. The return value
7001 is a cons cell with the starting date and the number of days,
7002 so that the date SD will be in that range."
7003 (let* ((greg (calendar-gregorian-from-absolute sd))
7004 (dg (nth 1 greg))
7005 (mg (car greg))
7006 (yg (nth 2 greg)))
7007 (cond
7008 ((eq span 'day)
7009 (when n
7010 (setq sd (+ (calendar-absolute-from-gregorian
7011 (list mg 1 yg))
7012 n -1))))
7013 ((eq span 'week)
7014 (let* ((nt (calendar-day-of-week
7015 (calendar-gregorian-from-absolute sd)))
7016 (d (if org-agenda-start-on-weekday
7017 (- nt org-agenda-start-on-weekday)
7020 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7021 (when n
7022 (require 'cal-iso)
7023 (when (> n 99)
7024 (setq y1 (org-small-year-to-year (/ n 100))
7025 n (mod n 100)))
7026 (setq sd
7027 (calendar-absolute-from-iso
7028 (list n 1
7029 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7030 ((eq span 'month)
7031 (let (y1)
7032 (when (and n (> n 99))
7033 (setq y1 (org-small-year-to-year (/ n 100))
7034 n (mod n 100)))
7035 (setq sd (calendar-absolute-from-gregorian
7036 (list (or n mg) 1 (or y1 yg))))))
7037 ((eq span 'year)
7038 (setq sd (calendar-absolute-from-gregorian
7039 (list 1 1 (or n yg))))))
7040 sd))
7042 (defun org-agenda-next-date-line (&optional arg)
7043 "Jump to the next line indicating a date in agenda buffer."
7044 (interactive "p")
7045 (org-agenda-check-type t 'agenda 'timeline)
7046 (beginning-of-line 1)
7047 ;; This does not work if user makes date format that starts with a blank
7048 (if (looking-at "^\\S-") (forward-char 1))
7049 (if (not (re-search-forward "^\\S-" nil t arg))
7050 (progn
7051 (backward-char 1)
7052 (error "No next date after this line in this buffer")))
7053 (goto-char (match-beginning 0)))
7055 (defun org-agenda-previous-date-line (&optional arg)
7056 "Jump to the previous line indicating a date in agenda buffer."
7057 (interactive "p")
7058 (org-agenda-check-type t 'agenda 'timeline)
7059 (beginning-of-line 1)
7060 (if (not (re-search-backward "^\\S-" nil t arg))
7061 (error "No previous date before this line in this buffer")))
7063 ;; Initialize the highlight
7064 (defvar org-hl (make-overlay 1 1))
7065 (overlay-put org-hl 'face 'highlight)
7067 (defun org-highlight (begin end &optional buffer)
7068 "Highlight a region with overlay."
7069 (move-overlay org-hl begin end (or buffer (current-buffer))))
7071 (defun org-unhighlight ()
7072 "Detach overlay INDEX."
7073 (org-detach-overlay org-hl))
7075 ;; FIXME this is currently not used.
7076 (defun org-highlight-until-next-command (beg end &optional buffer)
7077 "Move the highlight overlay to BEG/END, remove it before the next command."
7078 (org-highlight beg end buffer)
7079 (add-hook 'pre-command-hook 'org-unhighlight-once))
7080 (defun org-unhighlight-once ()
7081 "Remove the highlight from its position, and this function from the hook."
7082 (remove-hook 'pre-command-hook 'org-unhighlight-once)
7083 (org-unhighlight))
7085 (defun org-agenda-follow-mode ()
7086 "Toggle follow mode in an agenda buffer."
7087 (interactive)
7088 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
7089 (org-agenda-set-mode-name)
7090 (org-agenda-do-context-action)
7091 (message "Follow mode is %s"
7092 (if org-agenda-follow-mode "on" "off")))
7094 (defun org-agenda-entry-text-mode (&optional arg)
7095 "Toggle entry text mode in an agenda buffer."
7096 (interactive "P")
7097 (setq org-agenda-entry-text-mode (or (integerp arg)
7098 (not org-agenda-entry-text-mode)))
7099 (org-agenda-entry-text-hide)
7100 (and org-agenda-entry-text-mode
7101 (let ((org-agenda-entry-text-maxlines
7102 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7103 (org-agenda-entry-text-show)))
7104 (org-agenda-set-mode-name)
7105 (message "Entry text mode is %s. Maximum number of lines is %d"
7106 (if org-agenda-entry-text-mode "on" "off")
7107 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7109 (defun org-agenda-clockreport-mode (&optional with-filter)
7110 "Toggle clocktable mode in an agenda buffer.
7111 With prefix arg WITH-FILTER, make the clocktable respect the current
7112 agenda filter."
7113 (interactive "P")
7114 (org-agenda-check-type t 'agenda)
7115 (if with-filter
7116 (setq org-agenda-clockreport-mode 'with-filter)
7117 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
7118 (org-agenda-set-mode-name)
7119 (org-agenda-redo)
7120 (message "Clocktable mode is %s"
7121 (if org-agenda-clockreport-mode "on" "off")))
7123 (defun org-agenda-log-mode (&optional special)
7124 "Toggle log mode in an agenda buffer.
7125 With argument SPECIAL, show all possible log items, not only the ones
7126 configured in `org-agenda-log-mode-items'.
7127 With a double `C-u' prefix arg, show *only* log items, nothing else."
7128 (interactive "P")
7129 (org-agenda-check-type t 'agenda 'timeline)
7130 (setq org-agenda-show-log
7131 (cond
7132 ((equal special '(16)) 'only)
7133 ((eq special 'clockcheck)
7134 (if (eq org-agenda-show-log 'clockcheck)
7135 nil 'clockcheck))
7136 (special '(closed clock state))
7137 (t (not org-agenda-show-log))))
7138 (org-agenda-set-mode-name)
7139 (org-agenda-redo)
7140 (message "Log mode is %s"
7141 (if org-agenda-show-log "on" "off")))
7143 (defun org-agenda-archives-mode (&optional with-files)
7144 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7145 When called with a prefix argument, include all archive files as well."
7146 (interactive "P")
7147 (setq org-agenda-archives-mode
7148 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7149 (org-agenda-set-mode-name)
7150 (org-agenda-redo)
7151 (message
7152 "%s"
7153 (cond
7154 ((eq org-agenda-archives-mode nil)
7155 "No archives are included")
7156 ((eq org-agenda-archives-mode 'trees)
7157 (format "Trees with :%s: tag are included" org-archive-tag))
7158 ((eq org-agenda-archives-mode t)
7159 (format "Trees with :%s: tag and all active archive files are included"
7160 org-archive-tag)))))
7162 (defun org-agenda-toggle-diary ()
7163 "Toggle diary inclusion in an agenda buffer."
7164 (interactive)
7165 (org-agenda-check-type t 'agenda)
7166 (setq org-agenda-include-diary (not org-agenda-include-diary))
7167 (org-agenda-redo)
7168 (org-agenda-set-mode-name)
7169 (message "Diary inclusion turned %s"
7170 (if org-agenda-include-diary "on" "off")))
7172 (defun org-agenda-toggle-deadlines ()
7173 "Toggle inclusion of entries with a deadline in an agenda buffer."
7174 (interactive)
7175 (org-agenda-check-type t 'agenda)
7176 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7177 (org-agenda-redo)
7178 (org-agenda-set-mode-name)
7179 (message "Deadlines inclusion turned %s"
7180 (if org-agenda-include-deadlines "on" "off")))
7182 (defun org-agenda-toggle-time-grid ()
7183 "Toggle time grid in an agenda buffer."
7184 (interactive)
7185 (org-agenda-check-type t 'agenda)
7186 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7187 (org-agenda-redo)
7188 (org-agenda-set-mode-name)
7189 (message "Time-grid turned %s"
7190 (if org-agenda-use-time-grid "on" "off")))
7192 (defun org-agenda-set-mode-name ()
7193 "Set the mode name to indicate all the small mode settings."
7194 (setq mode-name
7195 (list "Org-Agenda"
7196 (if (get 'org-agenda-files 'org-restrict) " []" "")
7198 '(:eval (org-agenda-span-name org-agenda-current-span))
7199 (if org-agenda-follow-mode " Follow" "")
7200 (if org-agenda-entry-text-mode " ETxt" "")
7201 (if org-agenda-include-diary " Diary" "")
7202 (if org-agenda-include-deadlines " Ddl" "")
7203 (if org-agenda-use-time-grid " Grid" "")
7204 (if (and (boundp 'org-habit-show-habits)
7205 org-habit-show-habits) " Habit" "")
7206 (cond
7207 ((consp org-agenda-show-log) " LogAll")
7208 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7209 (org-agenda-show-log " Log")
7210 (t ""))
7211 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7212 :preset-filter))
7213 '(:eval (org-propertize
7214 (concat " <"
7215 (mapconcat
7216 'identity
7217 (append
7218 (get 'org-agenda-category-filter :preset-filter)
7219 org-agenda-category-filter)
7221 ">")
7222 'face 'org-agenda-filter-category
7223 'help-echo "Category used in filtering"))
7225 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7226 :preset-filter))
7227 '(:eval (org-propertize
7228 (concat " {"
7229 (mapconcat
7230 'identity
7231 (append
7232 (get 'org-agenda-tag-filter :preset-filter)
7233 org-agenda-tag-filter)
7235 "}")
7236 'face 'org-agenda-filter-tags
7237 'help-echo "Tags used in filtering"))
7239 (if org-agenda-archives-mode
7240 (if (eq org-agenda-archives-mode t)
7241 " Archives"
7242 (format " :%s:" org-archive-tag))
7244 (if org-agenda-clockreport-mode
7245 (if (eq org-agenda-clockreport-mode 'with-filter)
7246 " Clock{}" " Clock")
7247 "")))
7248 (force-mode-line-update))
7250 (defun org-agenda-post-command-hook ()
7251 (setq org-agenda-type
7252 (or (get-text-property (point) 'org-agenda-type)
7253 (get-text-property (max (point-min) (1- (point)))
7254 'org-agenda-type))))
7256 (defun org-agenda-next-line ()
7257 "Move cursor to the next line, and show if follow mode is active."
7258 (interactive)
7259 (call-interactively 'next-line)
7260 (org-agenda-do-context-action))
7262 (defun org-agenda-previous-line ()
7263 "Move cursor to the previous line, and show if follow-mode is active."
7264 (interactive)
7265 (call-interactively 'previous-line)
7266 (org-agenda-do-context-action))
7268 (defun org-agenda-next-item (n)
7269 "Move cursor to next agenda item."
7270 (interactive "p")
7271 (let ((col (current-column)))
7272 (dotimes (c n)
7273 (when (next-single-property-change (point-at-eol) 'org-marker)
7274 (move-end-of-line 1)
7275 (goto-char (next-single-property-change (point) 'org-marker))))
7276 (org-move-to-column col))
7277 (org-agenda-do-context-action))
7279 (defun org-agenda-previous-item (n)
7280 "Move cursor to next agenda item."
7281 (interactive "p")
7282 (dotimes (c n)
7283 (let ((col (current-column))
7284 (goto (save-excursion
7285 (move-end-of-line 0)
7286 (previous-single-property-change (point) 'org-marker))))
7287 (if goto (goto-char goto))
7288 (org-move-to-column col)))
7289 (org-agenda-do-context-action))
7291 (defun org-agenda-do-context-action ()
7292 "Show outline path and, maybe, follow mode window."
7293 (let ((m (org-get-at-bol 'org-marker)))
7294 (when (and (markerp m) (marker-buffer m))
7295 (and org-agenda-follow-mode
7296 (if org-agenda-follow-indirect
7297 (org-agenda-tree-to-indirect-buffer)
7298 (org-agenda-show)))
7299 (and org-agenda-show-outline-path
7300 (org-with-point-at m (org-display-outline-path t))))))
7302 (defun org-agenda-show-priority ()
7303 "Show the priority of the current item.
7304 This priority is composed of the main priority given with the [#A] cookies,
7305 and by additional input from the age of a schedules or deadline entry."
7306 (interactive)
7307 (let* ((pri (org-get-at-bol 'priority)))
7308 (message "Priority is %d" (if pri pri -1000))))
7310 (defun org-agenda-show-tags ()
7311 "Show the tags applicable to the current item."
7312 (interactive)
7313 (let* ((tags (org-get-at-bol 'tags)))
7314 (if tags
7315 (message "Tags are :%s:"
7316 (org-no-properties (mapconcat 'identity tags ":")))
7317 (message "No tags associated with this line"))))
7319 (defun org-agenda-goto (&optional highlight)
7320 "Go to the Org-mode file which contains the item at point."
7321 (interactive)
7322 (let* ((marker (or (org-get-at-bol 'org-marker)
7323 (org-agenda-error)))
7324 (buffer (marker-buffer marker))
7325 (pos (marker-position marker)))
7326 (switch-to-buffer-other-window buffer)
7327 (widen)
7328 (push-mark)
7329 (goto-char pos)
7330 (when (derived-mode-p 'org-mode)
7331 (org-show-context 'agenda)
7332 (save-excursion
7333 (and (outline-next-heading)
7334 (org-flag-heading nil)))) ; show the next heading
7335 (when (outline-invisible-p)
7336 (show-entry)) ; display invisible text
7337 (recenter (/ (window-height) 2))
7338 (run-hooks 'org-agenda-after-show-hook)
7339 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7341 (defvar org-agenda-after-show-hook nil
7342 "Normal hook run after an item has been shown from the agenda.
7343 Point is in the buffer where the item originated.")
7345 (defun org-agenda-kill ()
7346 "Kill the entry or subtree belonging to the current agenda entry."
7347 (interactive)
7348 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7349 (let* ((marker (or (org-get-at-bol 'org-marker)
7350 (org-agenda-error)))
7351 (buffer (marker-buffer marker))
7352 (pos (marker-position marker))
7353 (type (org-get-at-bol 'type))
7354 dbeg dend (n 0) conf)
7355 (org-with-remote-undo buffer
7356 (with-current-buffer buffer
7357 (save-excursion
7358 (goto-char pos)
7359 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
7360 (setq dbeg (progn (org-back-to-heading t) (point))
7361 dend (org-end-of-subtree t t))
7362 (setq dbeg (point-at-bol)
7363 dend (min (point-max) (1+ (point-at-eol)))))
7364 (goto-char dbeg)
7365 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7366 (setq conf (or (eq t org-agenda-confirm-kill)
7367 (and (numberp org-agenda-confirm-kill)
7368 (> n org-agenda-confirm-kill))))
7369 (and conf
7370 (not (y-or-n-p
7371 (format "Delete entry with %d lines in buffer \"%s\"? "
7372 n (buffer-name buffer))))
7373 (error "Abort"))
7374 (org-remove-subtree-entries-from-agenda buffer dbeg dend)
7375 (with-current-buffer buffer (delete-region dbeg dend))
7376 (message "Agenda item and source killed"))))
7378 (defvar org-archive-default-command)
7379 (defun org-agenda-archive-default ()
7380 "Archive the entry or subtree belonging to the current agenda entry."
7381 (interactive)
7382 (require 'org-archive)
7383 (org-agenda-archive-with org-archive-default-command))
7385 (defun org-agenda-archive-default-with-confirmation ()
7386 "Archive the entry or subtree belonging to the current agenda entry."
7387 (interactive)
7388 (require 'org-archive)
7389 (org-agenda-archive-with org-archive-default-command 'confirm))
7391 (defun org-agenda-archive ()
7392 "Archive the entry or subtree belonging to the current agenda entry."
7393 (interactive)
7394 (org-agenda-archive-with 'org-archive-subtree))
7396 (defun org-agenda-archive-to-archive-sibling ()
7397 "Move the entry to the archive sibling."
7398 (interactive)
7399 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7401 (defun org-agenda-archive-with (cmd &optional confirm)
7402 "Move the entry to the archive sibling."
7403 (interactive)
7404 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7405 (let* ((marker (or (org-get-at-bol 'org-marker)
7406 (org-agenda-error)))
7407 (buffer (marker-buffer marker))
7408 (pos (marker-position marker)))
7409 (org-with-remote-undo buffer
7410 (with-current-buffer buffer
7411 (if (derived-mode-p 'org-mode)
7412 (if (and confirm
7413 (not (y-or-n-p "Archive this subtree or entry? ")))
7414 (error "Abort")
7415 (save-excursion
7416 (goto-char pos)
7417 (org-remove-subtree-entries-from-agenda)
7418 (org-back-to-heading t)
7419 (funcall cmd)))
7420 (error "Archiving works only in Org-mode files"))))))
7422 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7423 "Remove all lines in the agenda that correspond to a given subtree.
7424 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7425 If this information is not given, the function uses the tree at point."
7426 (let ((buf (or buf (current-buffer))) m p)
7427 (save-excursion
7428 (unless (and beg end)
7429 (org-back-to-heading t)
7430 (setq beg (point))
7431 (org-end-of-subtree t)
7432 (setq end (point)))
7433 (set-buffer (get-buffer org-agenda-buffer-name))
7434 (save-excursion
7435 (goto-char (point-max))
7436 (beginning-of-line 1)
7437 (while (not (bobp))
7438 (when (and (setq m (org-get-at-bol 'org-marker))
7439 (equal buf (marker-buffer m))
7440 (setq p (marker-position m))
7441 (>= p beg)
7442 (< p end))
7443 (let ((inhibit-read-only t))
7444 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7445 (beginning-of-line 0))))))
7447 (defun org-agenda-refile (&optional goto rfloc no-update)
7448 "Refile the item at point."
7449 (interactive "P")
7450 (if (equal goto '(16))
7451 (org-refile-goto-last-stored)
7452 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7453 (org-agenda-error)))
7454 (buffer (marker-buffer marker))
7455 (pos (marker-position marker))
7456 (rfloc (or rfloc
7457 (org-refile-get-location
7458 (if goto "Goto" "Refile to") buffer
7459 org-refile-allow-creating-parent-nodes))))
7460 (with-current-buffer buffer
7461 (save-excursion
7462 (save-restriction
7463 (widen)
7464 (goto-char marker)
7465 (org-remove-subtree-entries-from-agenda)
7466 (org-refile goto buffer rfloc)))))
7467 (unless no-update (org-agenda-redo))))
7469 (defun org-agenda-open-link (&optional arg)
7470 "Follow the link in the current line, if any.
7471 This looks for a link in the displayed line in the agenda. It also looks
7472 at the text of the entry itself."
7473 (interactive "P")
7474 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7475 (org-get-at-bol 'org-marker)))
7476 (buffer (and marker (marker-buffer marker)))
7477 (prefix (buffer-substring
7478 (point-at-bol) (point-at-eol))))
7479 (cond
7480 (buffer
7481 (with-current-buffer buffer
7482 (save-excursion
7483 (save-restriction
7484 (widen)
7485 (goto-char marker)
7486 (org-offer-links-in-entry arg prefix)))))
7487 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7488 (save-excursion
7489 (beginning-of-line 1)
7490 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7491 (org-open-link-from-string (match-string 1)))
7492 (t (error "No link to open here")))))
7494 (defun org-agenda-copy-local-variable (var)
7495 "Get a variable from a referenced buffer and install it here."
7496 (let ((m (org-get-at-bol 'org-marker)))
7497 (when (and m (buffer-live-p (marker-buffer m)))
7498 (org-set-local var (with-current-buffer (marker-buffer m)
7499 (symbol-value var))))))
7501 (defun org-agenda-switch-to (&optional delete-other-windows)
7502 "Go to the Org-mode file which contains the item at point."
7503 (interactive)
7504 (if (and org-return-follows-link
7505 (not (org-get-at-bol 'org-marker))
7506 (org-in-regexp org-bracket-link-regexp))
7507 (org-open-link-from-string (match-string 0))
7508 (let* ((marker (or (org-get-at-bol 'org-marker)
7509 (org-agenda-error)))
7510 (buffer (marker-buffer marker))
7511 (pos (marker-position marker)))
7512 (org-pop-to-buffer-same-window buffer)
7513 (and delete-other-windows (delete-other-windows))
7514 (widen)
7515 (goto-char pos)
7516 (when (derived-mode-p 'org-mode)
7517 (org-show-context 'agenda)
7518 (save-excursion
7519 (and (outline-next-heading)
7520 (org-flag-heading nil))) ; show the next heading
7521 (when (outline-invisible-p)
7522 (show-entry)) ; display invisible text
7523 (run-hooks 'org-agenda-after-show-hook)))))
7525 (defun org-agenda-goto-mouse (ev)
7526 "Go to the Org-mode file which contains the item at the mouse click."
7527 (interactive "e")
7528 (mouse-set-point ev)
7529 (org-agenda-goto))
7531 (defun org-agenda-show (&optional full-entry)
7532 "Display the Org-mode file which contains the item at point.
7533 With prefix argument FULL-ENTRY, make the entire entry visible
7534 if it was hidden in the outline."
7535 (interactive "P")
7536 (let ((win (selected-window)))
7537 (if full-entry
7538 (let ((org-show-entry-below t))
7539 (org-agenda-goto t))
7540 (org-agenda-goto t))
7541 (select-window win)))
7543 (defvar org-agenda-show-window nil)
7544 (defun org-agenda-show-and-scroll-up (&optional arg)
7545 "Display the Org-mode file which contains the item at point.
7546 When called repeatedly, scroll the window that is displaying the buffer.
7547 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7548 `show-subtree' to display the item, so that drawers and logbooks stay
7549 folded."
7550 (interactive "P")
7551 (let ((win (selected-window)))
7552 (if (and (window-live-p org-agenda-show-window)
7553 (eq this-command last-command))
7554 (progn
7555 (select-window org-agenda-show-window)
7556 (ignore-errors (scroll-up)))
7557 (org-agenda-goto t)
7558 (if arg (org-show-entry) (show-subtree))
7559 (setq org-agenda-show-window (selected-window)))
7560 (select-window win)))
7562 (defun org-agenda-show-scroll-down ()
7563 "Scroll down the window showing the agenda."
7564 (interactive)
7565 (let ((win (selected-window)))
7566 (when (window-live-p org-agenda-show-window)
7567 (select-window org-agenda-show-window)
7568 (ignore-errors (scroll-down))
7569 (select-window win))))
7571 (defun org-agenda-show-1 (&optional more)
7572 "Display the Org-mode file which contains the item at point.
7573 The prefix arg selects the amount of information to display:
7575 0 hide the subtree
7576 1 just show the entry according to defaults.
7577 2 show the children view
7578 3 show the subtree view
7579 4 show the entire subtree and any LOGBOOK drawers
7580 5 show the entire subtree and any drawers
7581 With prefix argument FULL-ENTRY, make the entire entry visible
7582 if it was hidden in the outline."
7583 (interactive "p")
7584 (let ((win (selected-window)))
7585 (org-agenda-goto t)
7586 (org-recenter-heading 1)
7587 (cond
7588 ((= more 0)
7589 (hide-subtree)
7590 (save-excursion
7591 (org-back-to-heading)
7592 (run-hook-with-args 'org-cycle-hook 'folded))
7593 (message "Remote: FOLDED"))
7594 ((and (org-called-interactively-p 'any) (= more 1))
7595 (message "Remote: show with default settings"))
7596 ((= more 2)
7597 (show-entry)
7598 (show-children)
7599 (save-excursion
7600 (org-back-to-heading)
7601 (run-hook-with-args 'org-cycle-hook 'children))
7602 (message "Remote: CHILDREN"))
7603 ((= more 3)
7604 (show-subtree)
7605 (save-excursion
7606 (org-back-to-heading)
7607 (run-hook-with-args 'org-cycle-hook 'subtree))
7608 (message "Remote: SUBTREE"))
7609 ((= more 4)
7610 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7611 (org-drawer-regexp
7612 (concat "^[ \t]*:\\("
7613 (mapconcat 'regexp-quote org-drawers "\\|")
7614 "\\):[ \t]*$")))
7615 (show-subtree)
7616 (save-excursion
7617 (org-back-to-heading)
7618 (org-cycle-hide-drawers 'subtree)))
7619 (message "Remote: SUBTREE AND LOGBOOK"))
7620 ((> more 4)
7621 (show-subtree)
7622 (message "Remote: SUBTREE AND ALL DRAWERS")))
7623 (select-window win)))
7625 (defun org-recenter-heading (n)
7626 (save-excursion
7627 (org-back-to-heading)
7628 (recenter n)))
7630 (defvar org-agenda-cycle-counter nil)
7631 (defun org-agenda-cycle-show (&optional n)
7632 "Show the current entry in another window, with default settings.
7633 Default settings are taken from `org-show-hierarchy-above' and siblings.
7634 When use repeatedly in immediate succession, the remote entry will cycle
7635 through visibility
7637 children -> subtree -> folded
7639 When called with a numeric prefix arg, that arg will be passed through to
7640 `org-agenda-show-1'. For the interpretation of that argument, see the
7641 docstring of `org-agenda-show-1'."
7642 (interactive "P")
7643 (if (integerp n)
7644 (setq org-agenda-cycle-counter n)
7645 (if (not (eq last-command this-command))
7646 (setq org-agenda-cycle-counter 1)
7647 (if (equal org-agenda-cycle-counter 0)
7648 (setq org-agenda-cycle-counter 2)
7649 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7650 (if (> org-agenda-cycle-counter 3)
7651 (setq org-agenda-cycle-counter 0)))))
7652 (org-agenda-show-1 org-agenda-cycle-counter))
7654 (defun org-agenda-recenter (arg)
7655 "Display the Org-mode file which contains the item at point and recenter."
7656 (interactive "P")
7657 (let ((win (selected-window)))
7658 (org-agenda-goto t)
7659 (recenter arg)
7660 (select-window win)))
7662 (defun org-agenda-show-mouse (ev)
7663 "Display the Org-mode file which contains the item at the mouse click."
7664 (interactive "e")
7665 (mouse-set-point ev)
7666 (org-agenda-show))
7668 (defun org-agenda-check-no-diary ()
7669 "Check if the entry is a diary link and abort if yes."
7670 (if (org-get-at-bol 'org-agenda-diary-link)
7671 (org-agenda-error)))
7673 (defun org-agenda-error ()
7674 (error "Command not allowed in this line"))
7676 (defun org-agenda-tree-to-indirect-buffer ()
7677 "Show the subtree corresponding to the current entry in an indirect buffer.
7678 This calls the command `org-tree-to-indirect-buffer' from the original
7679 Org-mode buffer.
7680 With numerical prefix arg ARG, go up to this level and then take that tree.
7681 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7682 use the dedicated frame)."
7683 (interactive)
7684 (if (and current-prefix-arg (listp current-prefix-arg))
7685 (org-agenda-do-tree-to-indirect-buffer)
7686 (let ((agenda-window (selected-window))
7687 (indirect-window
7688 (and org-last-indirect-buffer
7689 (get-buffer-window org-last-indirect-buffer))))
7690 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7691 (unwind-protect
7692 (progn
7693 (unless (and indirect-window (window-live-p indirect-window))
7694 (setq indirect-window (split-window agenda-window)))
7695 (select-window indirect-window)
7696 (switch-to-buffer org-last-indirect-buffer :norecord)
7697 (fit-window-to-buffer indirect-window))
7698 (select-window (get-buffer-window org-agenda-buffer-name))))))
7700 (defun org-agenda-do-tree-to-indirect-buffer ()
7701 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7702 (org-agenda-check-no-diary)
7703 (let* ((marker (or (org-get-at-bol 'org-marker)
7704 (org-agenda-error)))
7705 (buffer (marker-buffer marker))
7706 (pos (marker-position marker)))
7707 (with-current-buffer buffer
7708 (save-excursion
7709 (goto-char pos)
7710 (call-interactively 'org-tree-to-indirect-buffer)))))
7712 (defvar org-last-heading-marker (make-marker)
7713 "Marker pointing to the headline that last changed its TODO state
7714 by a remote command from the agenda.")
7716 (defun org-agenda-todo-nextset ()
7717 "Switch TODO entry to next sequence."
7718 (interactive)
7719 (org-agenda-todo 'nextset))
7721 (defun org-agenda-todo-previousset ()
7722 "Switch TODO entry to previous sequence."
7723 (interactive)
7724 (org-agenda-todo 'previousset))
7726 (defun org-agenda-todo (&optional arg)
7727 "Cycle TODO state of line at point, also in Org-mode file.
7728 This changes the line at point, all other lines in the agenda referring to
7729 the same tree node, and the headline of the tree node in the Org-mode file."
7730 (interactive "P")
7731 (org-agenda-check-no-diary)
7732 (let* ((col (current-column))
7733 (marker (or (org-get-at-bol 'org-marker)
7734 (org-agenda-error)))
7735 (buffer (marker-buffer marker))
7736 (pos (marker-position marker))
7737 (hdmarker (org-get-at-bol 'org-hd-marker))
7738 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7739 (inhibit-read-only t)
7740 org-agenda-headline-snapshot-before-repeat newhead just-one)
7741 (org-with-remote-undo buffer
7742 (with-current-buffer buffer
7743 (widen)
7744 (goto-char pos)
7745 (org-show-context 'agenda)
7746 (save-excursion
7747 (and (outline-next-heading)
7748 (org-flag-heading nil))) ; show the next heading
7749 (let ((current-prefix-arg arg))
7750 (call-interactively 'org-todo))
7751 (and (bolp) (forward-char 1))
7752 (setq newhead (org-get-heading))
7753 (when (and (org-bound-and-true-p
7754 org-agenda-headline-snapshot-before-repeat)
7755 (not (equal org-agenda-headline-snapshot-before-repeat
7756 newhead))
7757 todayp)
7758 (setq newhead org-agenda-headline-snapshot-before-repeat
7759 just-one t))
7760 (save-excursion
7761 (org-back-to-heading)
7762 (move-marker org-last-heading-marker (point))))
7763 (beginning-of-line 1)
7764 (save-excursion
7765 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7766 (org-move-to-column col))))
7768 (defun org-agenda-add-note (&optional arg)
7769 "Add a time-stamped note to the entry at point."
7770 (interactive "P")
7771 (org-agenda-check-no-diary)
7772 (let* ((marker (or (org-get-at-bol 'org-marker)
7773 (org-agenda-error)))
7774 (buffer (marker-buffer marker))
7775 (pos (marker-position marker))
7776 (hdmarker (org-get-at-bol 'org-hd-marker))
7777 (inhibit-read-only t))
7778 (with-current-buffer buffer
7779 (widen)
7780 (goto-char pos)
7781 (org-show-context 'agenda)
7782 (save-excursion
7783 (and (outline-next-heading)
7784 (org-flag-heading nil))) ; show the next heading
7785 (org-add-note))))
7787 (defun org-agenda-change-all-lines (newhead hdmarker
7788 &optional fixface just-this)
7789 "Change all lines in the agenda buffer which match HDMARKER.
7790 The new content of the line will be NEWHEAD (as modified by
7791 `org-agenda-format-item'). HDMARKER is checked with
7792 `equal' against all `org-hd-marker' text properties in the file.
7793 If FIXFACE is non-nil, the face of each item is modified according to
7794 the new TODO state.
7795 If JUST-THIS is non-nil, change just the current line, not all.
7796 If FORCE-TAGS is non nil, the car of it returns the new tags."
7797 (let* ((inhibit-read-only t)
7798 (line (org-current-line))
7799 (org-agenda-buffer (current-buffer))
7800 (thetags (with-current-buffer (marker-buffer hdmarker)
7801 (save-excursion (save-restriction (widen)
7802 (goto-char hdmarker)
7803 (org-get-tags-at)))))
7804 props m pl undone-face done-face finish new dotime cat tags)
7805 (save-excursion
7806 (goto-char (point-max))
7807 (beginning-of-line 1)
7808 (while (not finish)
7809 (setq finish (bobp))
7810 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7811 (or (not just-this) (= (org-current-line) line))
7812 (equal m hdmarker))
7813 (setq props (text-properties-at (point))
7814 dotime (org-get-at-bol 'dotime)
7815 cat (org-get-at-bol 'org-category)
7816 tags thetags
7818 (let ((org-prefix-format-compiled
7819 (or (get-text-property (point) 'format)
7820 org-prefix-format-compiled))
7821 (extra (org-get-at-bol 'extra)))
7822 (with-current-buffer (marker-buffer hdmarker)
7823 (save-excursion
7824 (save-restriction
7825 (widen)
7826 (org-agenda-format-item extra newhead cat tags dotime)))))
7827 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
7828 undone-face (org-get-at-bol 'undone-face)
7829 done-face (org-get-at-bol 'done-face))
7830 (beginning-of-line 1)
7831 (cond
7832 ((equal new "")
7833 (and (looking-at ".*\n?") (replace-match "")))
7834 ((looking-at ".*")
7835 (replace-match new t t)
7836 (beginning-of-line 1)
7837 (add-text-properties (point-at-bol) (point-at-eol) props)
7838 (when fixface
7839 (add-text-properties
7840 (point-at-bol) (point-at-eol)
7841 (list 'face
7842 (if org-last-todo-state-is-todo
7843 undone-face done-face))))
7844 (org-agenda-highlight-todo 'line)
7845 (beginning-of-line 1))
7846 (t (error "Line update did not work"))))
7847 (beginning-of-line 0)))
7848 (org-finalize-agenda)))
7850 (defun org-agenda-align-tags (&optional line)
7851 "Align all tags in agenda items to `org-agenda-tags-column'."
7852 (let ((inhibit-read-only t) l c)
7853 (save-excursion
7854 (goto-char (if line (point-at-bol) (point-min)))
7855 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
7856 (if line (point-at-eol) nil) t)
7857 (add-text-properties
7858 (match-beginning 2) (match-end 2)
7859 (list 'face (delq nil (let ((prop (get-text-property
7860 (match-beginning 2) 'face)))
7861 (or (listp prop) (setq prop (list prop)))
7862 (if (memq 'org-tag prop)
7863 prop
7864 (cons 'org-tag prop))))))
7865 (setq l (- (match-end 2) (match-beginning 2))
7866 c (if (< org-agenda-tags-column 0)
7867 (- (abs org-agenda-tags-column) l)
7868 org-agenda-tags-column))
7869 (delete-region (match-beginning 1) (match-end 1))
7870 (goto-char (match-beginning 1))
7871 (insert (org-add-props
7872 (make-string (max 1 (- c (current-column))) ?\ )
7873 (plist-put (copy-sequence (text-properties-at (point)))
7874 'face nil))))
7875 (goto-char (point-min))
7876 (org-font-lock-add-tag-faces (point-max)))))
7878 (defun org-agenda-priority-up ()
7879 "Increase the priority of line at point, also in Org-mode file."
7880 (interactive)
7881 (org-agenda-priority 'up))
7883 (defun org-agenda-priority-down ()
7884 "Decrease the priority of line at point, also in Org-mode file."
7885 (interactive)
7886 (org-agenda-priority 'down))
7888 (defun org-agenda-priority (&optional force-direction)
7889 "Set the priority of line at point, also in Org-mode file.
7890 This changes the line at point, all other lines in the agenda referring to
7891 the same tree node, and the headline of the tree node in the Org-mode file."
7892 (interactive)
7893 (unless org-enable-priority-commands
7894 (error "Priority commands are disabled"))
7895 (org-agenda-check-no-diary)
7896 (let* ((marker (or (org-get-at-bol 'org-marker)
7897 (org-agenda-error)))
7898 (hdmarker (org-get-at-bol 'org-hd-marker))
7899 (buffer (marker-buffer hdmarker))
7900 (pos (marker-position hdmarker))
7901 (inhibit-read-only t)
7902 newhead)
7903 (org-with-remote-undo buffer
7904 (with-current-buffer buffer
7905 (widen)
7906 (goto-char pos)
7907 (org-show-context 'agenda)
7908 (save-excursion
7909 (and (outline-next-heading)
7910 (org-flag-heading nil))) ; show the next heading
7911 (funcall 'org-priority force-direction)
7912 (end-of-line 1)
7913 (setq newhead (org-get-heading)))
7914 (org-agenda-change-all-lines newhead hdmarker)
7915 (beginning-of-line 1))))
7917 ;; FIXME: should fix the tags property of the agenda line.
7918 (defun org-agenda-set-tags (&optional tag onoff)
7919 "Set tags for the current headline."
7920 (interactive)
7921 (org-agenda-check-no-diary)
7922 (if (and (org-region-active-p) (org-called-interactively-p 'any))
7923 (call-interactively 'org-change-tag-in-region)
7924 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7925 (org-agenda-error)))
7926 (buffer (marker-buffer hdmarker))
7927 (pos (marker-position hdmarker))
7928 (inhibit-read-only t)
7929 newhead)
7930 (org-with-remote-undo buffer
7931 (with-current-buffer buffer
7932 (widen)
7933 (goto-char pos)
7934 (save-excursion
7935 (org-show-context 'agenda))
7936 (save-excursion
7937 (and (outline-next-heading)
7938 (org-flag-heading nil))) ; show the next heading
7939 (goto-char pos)
7940 (if tag
7941 (org-toggle-tag tag onoff)
7942 (call-interactively 'org-set-tags))
7943 (end-of-line 1)
7944 (setq newhead (org-get-heading)))
7945 (org-agenda-change-all-lines newhead hdmarker)
7946 (beginning-of-line 1)))))
7948 (defun org-agenda-set-property ()
7949 "Set a property for the current headline."
7950 (interactive)
7951 (org-agenda-check-no-diary)
7952 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7953 (org-agenda-error)))
7954 (buffer (marker-buffer hdmarker))
7955 (pos (marker-position hdmarker))
7956 (inhibit-read-only t)
7957 newhead)
7958 (org-with-remote-undo buffer
7959 (with-current-buffer buffer
7960 (widen)
7961 (goto-char pos)
7962 (save-excursion
7963 (org-show-context 'agenda))
7964 (save-excursion
7965 (and (outline-next-heading)
7966 (org-flag-heading nil))) ; show the next heading
7967 (goto-char pos)
7968 (call-interactively 'org-set-property)))))
7970 (defun org-agenda-set-effort ()
7971 "Set the effort property for the current headline."
7972 (interactive)
7973 (org-agenda-check-no-diary)
7974 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7975 (org-agenda-error)))
7976 (buffer (marker-buffer hdmarker))
7977 (pos (marker-position hdmarker))
7978 (inhibit-read-only t)
7979 newhead)
7980 (org-with-remote-undo buffer
7981 (with-current-buffer buffer
7982 (widen)
7983 (goto-char pos)
7984 (save-excursion
7985 (org-show-context 'agenda))
7986 (save-excursion
7987 (and (outline-next-heading)
7988 (org-flag-heading nil))) ; show the next heading
7989 (goto-char pos)
7990 (call-interactively 'org-set-effort)
7991 (end-of-line 1)
7992 (setq newhead (org-get-heading)))
7993 (org-agenda-change-all-lines newhead hdmarker))))
7995 (defun org-agenda-toggle-archive-tag ()
7996 "Toggle the archive tag for the current entry."
7997 (interactive)
7998 (org-agenda-check-no-diary)
7999 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8000 (org-agenda-error)))
8001 (buffer (marker-buffer hdmarker))
8002 (pos (marker-position hdmarker))
8003 (inhibit-read-only t)
8004 newhead)
8005 (org-with-remote-undo buffer
8006 (with-current-buffer buffer
8007 (widen)
8008 (goto-char pos)
8009 (org-show-context 'agenda)
8010 (save-excursion
8011 (and (outline-next-heading)
8012 (org-flag-heading nil))) ; show the next heading
8013 (call-interactively 'org-toggle-archive-tag)
8014 (end-of-line 1)
8015 (setq newhead (org-get-heading)))
8016 (org-agenda-change-all-lines newhead hdmarker)
8017 (beginning-of-line 1))))
8019 (defun org-agenda-do-date-later (arg)
8020 (interactive "P")
8021 (cond
8022 ((or (equal arg '(16))
8023 (memq last-command
8024 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8025 (setq this-command 'org-agenda-date-later-minutes)
8026 (org-agenda-date-later-minutes 1))
8027 ((or (equal arg '(4))
8028 (memq last-command
8029 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8030 (setq this-command 'org-agenda-date-later-hours)
8031 (org-agenda-date-later-hours 1))
8033 (org-agenda-date-later (prefix-numeric-value arg)))))
8035 (defun org-agenda-do-date-earlier (arg)
8036 (interactive "P")
8037 (cond
8038 ((or (equal arg '(16))
8039 (memq last-command
8040 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8041 (setq this-command 'org-agenda-date-earlier-minutes)
8042 (org-agenda-date-earlier-minutes 1))
8043 ((or (equal arg '(4))
8044 (memq last-command
8045 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8046 (setq this-command 'org-agenda-date-earlier-hours)
8047 (org-agenda-date-earlier-hours 1))
8049 (org-agenda-date-earlier (prefix-numeric-value arg)))))
8051 (defun org-agenda-date-later (arg &optional what)
8052 "Change the date of this item to ARG day(s) later."
8053 (interactive "p")
8054 (org-agenda-check-type t 'agenda 'timeline)
8055 (org-agenda-check-no-diary)
8056 (let* ((marker (or (org-get-at-bol 'org-marker)
8057 (org-agenda-error)))
8058 (buffer (marker-buffer marker))
8059 (pos (marker-position marker))
8060 cdate today)
8061 (org-with-remote-undo buffer
8062 (with-current-buffer buffer
8063 (widen)
8064 (goto-char pos)
8065 (if (not (org-at-timestamp-p))
8066 (error "Cannot find time stamp"))
8067 (when (and org-agenda-move-date-from-past-immediately-to-today
8068 (equal arg 1)
8069 (or (not what) (eq what 'day))
8070 (not (save-match-data (org-at-date-range-p))))
8071 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
8072 cdate (calendar-absolute-from-gregorian
8073 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
8074 today (org-today))
8075 (if (> today cdate)
8076 ;; immediately shift to today
8077 (setq arg (- today cdate))))
8078 (org-timestamp-change arg (or what 'day))
8079 (when (and (org-at-date-range-p)
8080 (re-search-backward org-tr-regexp-both (point-at-bol)))
8081 (let ((end org-last-changed-timestamp))
8082 (org-timestamp-change arg (or what 'day))
8083 (setq org-last-changed-timestamp
8084 (concat org-last-changed-timestamp "--" end)))))
8085 (org-agenda-show-new-time marker org-last-changed-timestamp))
8086 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8088 (defun org-agenda-date-earlier (arg &optional what)
8089 "Change the date of this item to ARG day(s) earlier."
8090 (interactive "p")
8091 (org-agenda-date-later (- arg) what))
8093 (defun org-agenda-date-later-minutes (arg)
8094 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8095 (interactive "p")
8096 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8097 (org-agenda-date-later arg 'minute))
8099 (defun org-agenda-date-earlier-minutes (arg)
8100 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8101 (interactive "p")
8102 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8103 (org-agenda-date-earlier arg 'minute))
8105 (defun org-agenda-date-later-hours (arg)
8106 "Change the time of this item, in hour steps."
8107 (interactive "p")
8108 (org-agenda-date-later arg 'hour))
8110 (defun org-agenda-date-earlier-hours (arg)
8111 "Change the time of this item, in hour steps."
8112 (interactive "p")
8113 (org-agenda-date-earlier arg 'hour))
8115 (defun org-agenda-show-new-time (marker stamp &optional prefix)
8116 "Show new date stamp via text properties."
8117 ;; We use text properties to make this undoable
8118 (let ((inhibit-read-only t)
8119 (buffer-invisibility-spec))
8120 (setq stamp (concat " " prefix " => " stamp))
8121 (save-excursion
8122 (goto-char (point-max))
8123 (while (not (bobp))
8124 (when (equal marker (org-get-at-bol 'org-marker))
8125 (org-move-to-column (- (window-width) (length stamp)) t)
8126 (org-agenda-fix-tags-filter-overlays-at (point))
8127 (if (featurep 'xemacs)
8128 ;; Use `duplicable' property to trigger undo recording
8129 (let ((ex (make-extent nil nil))
8130 (gl (make-glyph stamp)))
8131 (set-glyph-face gl 'secondary-selection)
8132 (set-extent-properties
8133 ex (list 'invisible t 'end-glyph gl 'duplicable t))
8134 (insert-extent ex (1- (point)) (point-at-eol)))
8135 (add-text-properties
8136 (1- (point)) (point-at-eol)
8137 (list 'display (org-add-props stamp nil
8138 'face 'secondary-selection))))
8139 (beginning-of-line 1))
8140 (beginning-of-line 0)))))
8142 (defun org-agenda-date-prompt (arg)
8143 "Change the date of this item. Date is prompted for, with default today.
8144 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8145 be used to request time specification in the time stamp."
8146 (interactive "P")
8147 (org-agenda-check-type t 'agenda 'timeline)
8148 (org-agenda-check-no-diary)
8149 (let* ((marker (or (org-get-at-bol 'org-marker)
8150 (org-agenda-error)))
8151 (buffer (marker-buffer marker))
8152 (pos (marker-position marker)))
8153 (org-with-remote-undo buffer
8154 (with-current-buffer buffer
8155 (widen)
8156 (goto-char pos)
8157 (if (not (org-at-timestamp-p t))
8158 (error "Cannot find time stamp"))
8159 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
8160 (org-agenda-show-new-time marker org-last-changed-timestamp))
8161 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8163 (defun org-agenda-schedule (arg &optional time)
8164 "Schedule the item at point.
8165 ARG is passed through to `org-schedule'."
8166 (interactive "P")
8167 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8168 (org-agenda-check-no-diary)
8169 (let* ((marker (or (org-get-at-bol 'org-marker)
8170 (org-agenda-error)))
8171 (type (marker-insertion-type marker))
8172 (buffer (marker-buffer marker))
8173 (pos (marker-position marker))
8174 (org-insert-labeled-timestamps-at-point nil)
8176 (set-marker-insertion-type marker t)
8177 (org-with-remote-undo buffer
8178 (with-current-buffer buffer
8179 (widen)
8180 (goto-char pos)
8181 (setq ts (org-schedule arg time)))
8182 (org-agenda-show-new-time marker ts "S"))
8183 (message "Item scheduled for %s" ts)))
8185 (defun org-agenda-deadline (arg &optional time)
8186 "Schedule the item at point.
8187 ARG is passed through to `org-deadline'."
8188 (interactive "P")
8189 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8190 (org-agenda-check-no-diary)
8191 (let* ((marker (or (org-get-at-bol 'org-marker)
8192 (org-agenda-error)))
8193 (buffer (marker-buffer marker))
8194 (pos (marker-position marker))
8195 (org-insert-labeled-timestamps-at-point nil)
8197 (org-with-remote-undo buffer
8198 (with-current-buffer buffer
8199 (widen)
8200 (goto-char pos)
8201 (setq ts (org-deadline arg time)))
8202 (org-agenda-show-new-time marker ts "D"))
8203 (message "Deadline for this item set to %s" ts)))
8205 (defun org-agenda-action ()
8206 "Select entry for agenda action, or execute an agenda action.
8207 This command prompts for another letter. Valid inputs are:
8209 m Mark the entry at point for an agenda action
8210 s Schedule the marked entry to the date at the cursor
8211 d Set the deadline of the marked entry to the date at the cursor
8212 r Call `org-remember' with cursor date as the default date
8213 c Call `org-capture' with cursor date as the default date
8214 SPC Show marked entry in other window
8215 TAB Visit marked entry in other window
8217 The cursor may be at a date in the calendar, or in the Org agenda."
8218 (interactive)
8219 (let (ans)
8220 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
8221 (setq ans (read-char-exclusive))
8222 (cond
8223 ((equal ans ?m)
8224 ;; Mark this entry
8225 (if (eq major-mode 'org-agenda-mode)
8226 (let ((m (or (org-get-at-bol 'org-hd-marker)
8227 (org-get-at-bol 'org-marker))))
8228 (if m
8229 (progn
8230 (move-marker org-agenda-action-marker
8231 (marker-position m) (marker-buffer m))
8232 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
8233 (error "Don't know which entry to mark")))
8234 (error "This command works only in the agenda")))
8235 ((equal ans ?s)
8236 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
8237 ((equal ans ?d)
8238 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
8239 ((equal ans ?r)
8240 (org-agenda-do-action '(org-remember) t))
8241 ((equal ans ?c)
8242 (org-agenda-do-action '(org-capture) t))
8243 ((equal ans ?\ )
8244 (let ((cw (selected-window)))
8245 (org-switch-to-buffer-other-window
8246 (marker-buffer org-agenda-action-marker))
8247 (goto-char org-agenda-action-marker)
8248 (org-show-context 'agenda)
8249 (select-window cw)))
8250 ((equal ans ?\C-i)
8251 (org-switch-to-buffer-other-window
8252 (marker-buffer org-agenda-action-marker))
8253 (goto-char org-agenda-action-marker)
8254 (org-show-context 'agenda))
8255 (t (error "Invalid agenda action %c" ans)))))
8257 (defun org-agenda-do-action (form &optional current-buffer)
8258 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
8259 (let ((org-overriding-default-time (org-get-cursor-date)))
8260 (if current-buffer
8261 (eval form)
8262 (if (not (marker-buffer org-agenda-action-marker))
8263 (error "No entry has been selected for agenda action")
8264 (with-current-buffer (marker-buffer org-agenda-action-marker)
8265 (save-excursion
8266 (save-restriction
8267 (widen)
8268 (goto-char org-agenda-action-marker)
8269 (eval form))))))))
8271 (defun org-agenda-clock-in (&optional arg)
8272 "Start the clock on the currently selected item."
8273 (interactive "P")
8274 (org-agenda-check-no-diary)
8275 (if (equal arg '(4))
8276 (org-clock-in arg)
8277 (let* ((marker (or (org-get-at-bol 'org-marker)
8278 (org-agenda-error)))
8279 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8280 marker))
8281 (pos (marker-position marker))
8282 newhead)
8283 (org-with-remote-undo (marker-buffer marker)
8284 (with-current-buffer (marker-buffer marker)
8285 (widen)
8286 (goto-char pos)
8287 (org-show-context 'agenda)
8288 (org-show-entry)
8289 (org-cycle-hide-drawers 'children)
8290 (org-clock-in arg)
8291 (setq newhead (org-get-heading)))
8292 (org-agenda-change-all-lines newhead hdmarker)))))
8294 (defun org-agenda-clock-out ()
8295 "Stop the currently running clock."
8296 (interactive)
8297 (unless (marker-buffer org-clock-marker)
8298 (error "No running clock"))
8299 (let ((marker (make-marker)) newhead)
8300 (org-with-remote-undo (marker-buffer org-clock-marker)
8301 (with-current-buffer (marker-buffer org-clock-marker)
8302 (save-excursion
8303 (save-restriction
8304 (widen)
8305 (goto-char org-clock-marker)
8306 (org-back-to-heading t)
8307 (move-marker marker (point))
8308 (org-clock-out)
8309 (setq newhead (org-get-heading))))))
8310 (org-agenda-change-all-lines newhead marker)
8311 (move-marker marker nil)))
8313 (defun org-agenda-clock-cancel (&optional arg)
8314 "Cancel the currently running clock."
8315 (interactive "P")
8316 (unless (marker-buffer org-clock-marker)
8317 (error "No running clock"))
8318 (org-with-remote-undo (marker-buffer org-clock-marker)
8319 (org-clock-cancel)))
8321 (defun org-agenda-clock-goto ()
8322 "Jump to the currently clocked in task within the agenda.
8323 If the currently clocked in task is not listed in the agenda
8324 buffer, display it in another window."
8325 (interactive)
8326 (let (pos)
8327 (mapc (lambda (o)
8328 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8329 (setq pos (overlay-start o))))
8330 (overlays-in (point-min) (point-max)))
8331 (cond (pos (goto-char pos))
8332 ;; If the currently clocked entry is not in the agenda
8333 ;; buffer, we visit it in another window:
8334 (org-clock-current-task
8335 (org-switch-to-buffer-other-window (org-clock-goto)))
8336 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8338 (defun org-agenda-diary-entry-in-org-file ()
8339 "Make a diary entry in the file `org-agenda-diary-file'."
8340 (let (d1 d2 char (text "") dp1 dp2)
8341 (if (equal (buffer-name) "*Calendar*")
8342 (setq d1 (calendar-cursor-to-date t)
8343 d2 (car calendar-mark-ring))
8344 (setq dp1 (get-text-property (point-at-bol) 'day))
8345 (unless dp1 (error "No date defined in current line"))
8346 (setq d1 (calendar-gregorian-from-absolute dp1)
8347 d2 (and (ignore-errors (mark))
8348 (save-excursion
8349 (goto-char (mark))
8350 (setq dp2 (get-text-property (point-at-bol) 'day)))
8351 (calendar-gregorian-from-absolute dp2))))
8352 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8353 (setq char (read-char-exclusive))
8354 (cond
8355 ((equal char ?d)
8356 (setq text (read-string "Day entry: "))
8357 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8358 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8359 ((equal char ?a)
8360 (setq d1 (list (car d1) (nth 1 d1)
8361 (read-number (format "Reference year [%d]: " (nth 2 d1))
8362 (nth 2 d1))))
8363 (setq text (read-string "Anniversary (use %d to show years): "))
8364 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8365 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8366 ((equal char ?b)
8367 (setq text (read-string "Block entry: "))
8368 (unless (and d1 d2 (not (equal d1 d2)))
8369 (error "No block of days selected"))
8370 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8371 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8372 ((equal char ?j)
8373 (org-switch-to-buffer-other-window
8374 (find-file-noselect org-agenda-diary-file))
8375 (require 'org-datetree)
8376 (org-datetree-find-date-create d1)
8377 (org-reveal t))
8378 (t (error "Invalid selection character `%c'" char)))))
8380 (defcustom org-agenda-insert-diary-strategy 'date-tree
8381 "Where in `org-agenda-diary-file' should new entries be added?
8382 Valid values:
8384 date-tree in the date tree, as child of the date
8385 top-level as top-level entries at the end of the file."
8386 :group 'org-agenda
8387 :type '(choice
8388 (const :tag "in a date tree" date-tree)
8389 (const :tag "as top level at end of file" top-level)))
8391 (defcustom org-agenda-insert-diary-extract-time nil
8392 "Non-nil means extract any time specification from the diary entry."
8393 :group 'org-agenda
8394 :version "24.1"
8395 :type 'boolean)
8397 (defcustom org-agenda-bulk-mark-char ">"
8398 "A single-character string to be used as the bulk mark."
8399 :group 'org-agenda
8400 :version "24.1"
8401 :type 'string)
8403 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8404 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8405 If TEXT is not empty, it will become the headline of the new entry, and
8406 the resulting entry will not be shown. When TEXT is empty, switch to
8407 `org-agenda-diary-file' and let the user finish the entry there."
8408 (let ((cw (current-window-configuration)))
8409 (org-switch-to-buffer-other-window
8410 (find-file-noselect org-agenda-diary-file))
8411 (widen)
8412 (goto-char (point-min))
8413 (cond
8414 ((eq type 'anniversary)
8415 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8416 (progn
8417 (or (org-at-heading-p t)
8418 (progn
8419 (outline-next-heading)
8420 (insert "* Anniversaries\n\n")
8421 (beginning-of-line -1)))))
8422 (outline-next-heading)
8423 (org-back-over-empty-lines)
8424 (backward-char 1)
8425 (insert "\n")
8426 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8427 (nth 2 d1) (car d1) (nth 1 d1) text)))
8428 ((eq type 'day)
8429 (let ((org-prefix-has-time t)
8430 (org-agenda-time-leading-zero t)
8431 fmt time time2)
8432 (if org-agenda-insert-diary-extract-time
8433 ;; Use org-agenda-format-item to parse text for a time-range and
8434 ;; remove it. FIXME: This is a hack, we should refactor
8435 ;; that function to make time extraction available separately
8436 (setq fmt (org-agenda-format-item nil text nil nil t)
8437 time (get-text-property 0 'time fmt)
8438 time2 (if (> (length time) 0)
8439 ;; split-string removes trailing ...... if
8440 ;; no end time given. First space
8441 ;; separates time from date.
8442 (concat " " (car (split-string time "\\.")))
8443 nil)
8444 text (get-text-property 0 'txt fmt)))
8445 (if (eq org-agenda-insert-diary-strategy 'top-level)
8446 (org-agenda-insert-diary-as-top-level text)
8447 (require 'org-datetree)
8448 (org-datetree-find-date-create d1)
8449 (org-agenda-insert-diary-make-new-entry text))
8450 (org-insert-time-stamp (org-time-from-absolute
8451 (calendar-absolute-from-gregorian d1))
8452 nil nil nil nil time2))
8453 (end-of-line 0))
8454 ((eq type 'block)
8455 (if (> (calendar-absolute-from-gregorian d1)
8456 (calendar-absolute-from-gregorian d2))
8457 (setq d1 (prog1 d2 (setq d2 d1))))
8458 (if (eq org-agenda-insert-diary-strategy 'top-level)
8459 (org-agenda-insert-diary-as-top-level text)
8460 (require 'org-datetree)
8461 (org-datetree-find-date-create d1)
8462 (org-agenda-insert-diary-make-new-entry text))
8463 (org-insert-time-stamp (org-time-from-absolute
8464 (calendar-absolute-from-gregorian d1)))
8465 (insert "--")
8466 (org-insert-time-stamp (org-time-from-absolute
8467 (calendar-absolute-from-gregorian d2)))
8468 (end-of-line 0)))
8469 (if (string-match "\\S-" text)
8470 (progn
8471 (set-window-configuration cw)
8472 (message "%s entry added to %s"
8473 (capitalize (symbol-name type))
8474 (abbreviate-file-name org-agenda-diary-file)))
8475 (org-reveal t)
8476 (message "Please finish entry here"))))
8478 (defun org-agenda-insert-diary-as-top-level (text)
8479 "Make new entry as a top-level entry at the end of the file.
8480 Add TEXT as headline, and position the cursor in the second line so that
8481 a timestamp can be added there."
8482 (widen)
8483 (goto-char (point-max))
8484 (or (bolp) (insert "\n"))
8485 (insert "* " text "\n")
8486 (if org-adapt-indentation (org-indent-to-column 2)))
8488 (defun org-agenda-insert-diary-make-new-entry (text)
8489 "Make new entry as last child of current entry.
8490 Add TEXT as headline, and position the cursor in the second line so that
8491 a timestamp can be added there."
8492 (let ((org-show-following-heading t)
8493 (org-show-siblings t)
8494 (org-show-hierarchy-above t)
8495 (org-show-entry-below t)
8496 col)
8497 (outline-next-heading)
8498 (org-back-over-empty-lines)
8499 (or (looking-at "[ \t]*$")
8500 (progn (insert "\n") (backward-char 1)))
8501 (org-insert-heading nil t)
8502 (org-do-demote)
8503 (setq col (current-column))
8504 (insert text "\n")
8505 (if org-adapt-indentation (org-indent-to-column col))
8506 (let ((org-show-following-heading t)
8507 (org-show-siblings t)
8508 (org-show-hierarchy-above t)
8509 (org-show-entry-below t))
8510 (org-show-context))))
8512 (defun org-agenda-diary-entry ()
8513 "Make a diary entry, like the `i' command from the calendar.
8514 All the standard commands work: block, weekly etc.
8515 When `org-agenda-diary-file' points to a file,
8516 `org-agenda-diary-entry-in-org-file' is called instead to create
8517 entries in that Org-mode file."
8518 (interactive)
8519 (org-agenda-check-type t 'agenda 'timeline)
8520 (if (not (eq org-agenda-diary-file 'diary-file))
8521 (org-agenda-diary-entry-in-org-file)
8522 (require 'diary-lib)
8523 (let* ((char (progn
8524 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8525 (read-char-exclusive)))
8526 (cmd (cdr (assoc char
8527 '((?d . insert-diary-entry)
8528 (?w . insert-weekly-diary-entry)
8529 (?m . insert-monthly-diary-entry)
8530 (?y . insert-yearly-diary-entry)
8531 (?a . insert-anniversary-diary-entry)
8532 (?b . insert-block-diary-entry)
8533 (?c . insert-cyclic-diary-entry)))))
8534 (oldf (symbol-function 'calendar-cursor-to-date))
8535 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8536 (point (point))
8537 (mark (or (mark t) (point))))
8538 (unless cmd
8539 (error "No command associated with <%c>" char))
8540 (unless (and (get-text-property point 'day)
8541 (or (not (equal ?b char))
8542 (get-text-property mark 'day)))
8543 (error "Don't know which date to use for diary entry"))
8544 ;; We implement this by hacking the `calendar-cursor-to-date' function
8545 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8546 (let ((calendar-mark-ring
8547 (list (calendar-gregorian-from-absolute
8548 (or (get-text-property mark 'day)
8549 (get-text-property point 'day))))))
8550 (unwind-protect
8551 (progn
8552 (fset 'calendar-cursor-to-date
8553 (lambda (&optional error dummy)
8554 (calendar-gregorian-from-absolute
8555 (get-text-property point 'day))))
8556 (call-interactively cmd))
8557 (fset 'calendar-cursor-to-date oldf))))))
8559 (defun org-agenda-execute-calendar-command (cmd)
8560 "Execute a calendar command from the agenda, with the date associated to
8561 the cursor position."
8562 (org-agenda-check-type t 'agenda 'timeline)
8563 (require 'diary-lib)
8564 (unless (get-text-property (point) 'day)
8565 (error "Don't know which date to use for calendar command"))
8566 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8567 (point (point))
8568 (date (calendar-gregorian-from-absolute
8569 (get-text-property point 'day)))
8570 ;; the following 2 vars are needed in the calendar
8571 (displayed-month (car date))
8572 (displayed-year (nth 2 date)))
8573 (unwind-protect
8574 (progn
8575 (fset 'calendar-cursor-to-date
8576 (lambda (&optional error dummy)
8577 (calendar-gregorian-from-absolute
8578 (get-text-property point 'day))))
8579 (call-interactively cmd))
8580 (fset 'calendar-cursor-to-date oldf))))
8582 (defun org-agenda-phases-of-moon ()
8583 "Display the phases of the moon for the 3 months around the cursor date."
8584 (interactive)
8585 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8587 (defun org-agenda-holidays ()
8588 "Display the holidays for the 3 months around the cursor date."
8589 (interactive)
8590 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8592 (defvar calendar-longitude)
8593 (defvar calendar-latitude)
8594 (defvar calendar-location-name)
8596 (defun org-agenda-sunrise-sunset (arg)
8597 "Display sunrise and sunset for the cursor date.
8598 Latitude and longitude can be specified with the variables
8599 `calendar-latitude' and `calendar-longitude'. When called with prefix
8600 argument, latitude and longitude will be prompted for."
8601 (interactive "P")
8602 (require 'solar)
8603 (let ((calendar-longitude (if arg nil calendar-longitude))
8604 (calendar-latitude (if arg nil calendar-latitude))
8605 (calendar-location-name
8606 (if arg "the given coordinates" calendar-location-name)))
8607 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8609 (defun org-agenda-goto-calendar ()
8610 "Open the Emacs calendar with the date at the cursor."
8611 (interactive)
8612 (org-agenda-check-type t 'agenda 'timeline)
8613 (let* ((day (or (get-text-property (point) 'day)
8614 (error "Don't know which date to open in calendar")))
8615 (date (calendar-gregorian-from-absolute day))
8616 (calendar-move-hook nil)
8617 (calendar-view-holidays-initially-flag nil)
8618 (calendar-view-diary-initially-flag nil))
8619 (calendar)
8620 (calendar-goto-date date)))
8622 ;;;###autoload
8623 (defun org-calendar-goto-agenda ()
8624 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8625 This is a command that has to be installed in `calendar-mode-map'."
8626 (interactive)
8627 (org-agenda-list nil (calendar-absolute-from-gregorian
8628 (calendar-cursor-to-date))
8629 nil))
8631 (defun org-agenda-convert-date ()
8632 (interactive)
8633 (org-agenda-check-type t 'agenda 'timeline)
8634 (let ((day (get-text-property (point) 'day))
8635 date s)
8636 (unless day
8637 (error "Don't know which date to convert"))
8638 (setq date (calendar-gregorian-from-absolute day))
8639 (setq s (concat
8640 "Gregorian: " (calendar-date-string date) "\n"
8641 "ISO: " (calendar-iso-date-string date) "\n"
8642 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8643 "Julian: " (calendar-julian-date-string date) "\n"
8644 "Astron. JD: " (calendar-astro-date-string date)
8645 " (Julian date number at noon UTC)\n"
8646 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8647 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8648 "French: " (calendar-french-date-string date) "\n"
8649 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8650 "Mayan: " (calendar-mayan-date-string date) "\n"
8651 "Coptic: " (calendar-coptic-date-string date) "\n"
8652 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8653 "Persian: " (calendar-persian-date-string date) "\n"
8654 "Chinese: " (calendar-chinese-date-string date) "\n"))
8655 (with-output-to-temp-buffer "*Dates*"
8656 (princ s))
8657 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8659 ;;; Bulk commands
8661 (defvar org-agenda-bulk-marked-entries nil
8662 "List of markers that refer to marked entries in the agenda.")
8664 (defun org-agenda-bulk-marked-p ()
8665 (eq (get-char-property (point-at-bol) 'type)
8666 'org-marked-entry-overlay))
8668 (defun org-agenda-bulk-mark (&optional arg)
8669 "Mark the entry at point for future bulk action."
8670 (interactive "p")
8671 (dotimes (i (or arg 1))
8672 (unless (org-get-at-bol 'org-agenda-diary-link)
8673 (let* ((m (org-get-at-bol 'org-hd-marker))
8675 (unless (org-agenda-bulk-marked-p)
8676 (unless m (error "Nothing to mark at point"))
8677 (push m org-agenda-bulk-marked-entries)
8678 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8679 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
8680 (org-get-todo-face "TODO")
8681 'evaporate)
8682 (overlay-put ov 'type 'org-marked-entry-overlay))
8683 (beginning-of-line 2)
8684 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8685 (beginning-of-line 2))
8686 (message "%d entries marked for bulk action"
8687 (length org-agenda-bulk-marked-entries))))))
8689 (defun org-agenda-bulk-mark-all ()
8690 "Mark all entries for future agenda bulk action."
8691 (interactive)
8692 (org-agenda-bulk-mark-regexp "."))
8694 (defun org-agenda-bulk-mark-regexp (regexp)
8695 "Mark entries matching REGEXP for future agenda bulk action."
8696 (interactive "sMark entries matching regexp: ")
8697 (let ((entries-marked 0))
8698 (save-excursion
8699 (goto-char (point-min))
8700 (goto-char (next-single-property-change (point) 'txt))
8701 (while (re-search-forward regexp nil t)
8702 (when (string-match regexp (get-text-property (point) 'txt))
8703 (setq entries-marked (1+ entries-marked))
8704 (call-interactively 'org-agenda-bulk-mark))))
8705 (if (not entries-marked)
8706 (message "No entry matching this regexp."))))
8708 (defun org-agenda-bulk-unmark (&optional arg)
8709 "Unmark the entry at point for future bulk action."
8710 (interactive "P")
8711 (if arg
8712 (org-agenda-bulk-unmark-all)
8713 (cond ((org-agenda-bulk-marked-p)
8714 (org-agenda-bulk-remove-overlays
8715 (point-at-bol) (+ 2 (point-at-bol)))
8716 (setq org-agenda-bulk-marked-entries
8717 (delete (org-get-at-bol 'org-hd-marker)
8718 org-agenda-bulk-marked-entries))
8719 (beginning-of-line 2)
8720 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8721 (beginning-of-line 2))
8722 (message "%d entries left marked for bulk action"
8723 (length org-agenda-bulk-marked-entries)))
8724 (t (message "No entry to unmark here")))))
8726 (defun org-agenda-bulk-toggle ()
8727 "Toggle marking the entry at point for bulk action."
8728 (interactive)
8729 (if (org-agenda-bulk-marked-p)
8730 (org-agenda-bulk-unmark)
8731 (org-agenda-bulk-mark)))
8733 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8734 "Remove the mark overlays between BEG and END in the agenda buffer.
8735 BEG and END default to the buffer limits.
8737 This only removes the overlays, it does not remove the markers
8738 from the list in `org-agenda-bulk-marked-entries'."
8739 (interactive)
8740 (mapc (lambda (ov)
8741 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8742 (delete-overlay ov)))
8743 (overlays-in (or beg (point-min)) (or end (point-max)))))
8745 (defun org-agenda-bulk-unmark-all ()
8746 "Remove all marks in the agenda buffer.
8747 This will remove the markers and the overlays."
8748 (interactive)
8749 (if (null org-agenda-bulk-marked-entries)
8750 (message "No entry to unmark")
8751 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8752 (setq org-agenda-bulk-marked-entries nil)
8753 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
8755 (defcustom org-agenda-persistent-marks nil
8756 "Non-nil means marked items will stay marked after a bulk action.
8757 You can toggle this interactively by typing `p' when prompted for a
8758 bulk action."
8759 :group 'org-agenda
8760 :version "24.1"
8761 :type 'boolean)
8763 (defun org-agenda-bulk-action (&optional arg)
8764 "Execute an remote-editing action on all marked entries.
8765 The prefix arg is passed through to the command if possible."
8766 (interactive "P")
8767 ;; Make sure we have markers, and only valid ones
8768 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8769 (mapc
8770 (lambda (m)
8771 (unless (and (markerp m)
8772 (marker-buffer m)
8773 (buffer-live-p (marker-buffer m))
8774 (marker-position m))
8775 (error "Marker %s for bulk command is invalid" m)))
8776 org-agenda-bulk-marked-entries)
8778 ;; Prompt for the bulk command
8779 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
8780 (message (concat msg "[r]efile [$]arch [A]rch->sib [t]odo"
8781 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction "
8782 (when org-agenda-bulk-custom-functions
8783 (concat " Custom: ["
8784 (mapconcat (lambda(f) (char-to-string (car f)))
8785 org-agenda-bulk-custom-functions "")
8786 "]"))))
8787 (catch 'exit
8788 (let* ((action (read-char-exclusive))
8789 (org-log-refile (if org-log-refile 'time nil))
8790 (entries (reverse org-agenda-bulk-marked-entries))
8791 redo-at-end
8792 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8793 (cond
8794 ((equal action ?p)
8795 (let ((org-agenda-persistent-marks
8796 (not org-agenda-persistent-marks)))
8797 (org-agenda-bulk-action)
8798 (throw 'exit nil)))
8800 ((equal action ?$)
8801 (setq cmd '(org-agenda-archive)))
8803 ((equal action ?A)
8804 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8806 ((member action '(?r ?w))
8807 (setq rfloc (org-refile-get-location
8808 "Refile to"
8809 (marker-buffer (car org-agenda-bulk-marked-entries))
8810 org-refile-allow-creating-parent-nodes))
8811 (if (nth 3 rfloc)
8812 (setcar (nthcdr 3 rfloc)
8813 (move-marker (make-marker) (nth 3 rfloc)
8814 (or (get-file-buffer (nth 1 rfloc))
8815 (find-buffer-visiting (nth 1 rfloc))
8816 (error "This should not happen")))))
8818 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8819 redo-at-end t))
8821 ((equal action ?t)
8822 (setq state (org-icompleting-read
8823 "Todo state: "
8824 (with-current-buffer (marker-buffer (car entries))
8825 (mapcar 'list org-todo-keywords-1))))
8826 (setq cmd `(let ((org-inhibit-blocking t)
8827 (org-inhibit-logging 'note))
8828 (org-agenda-todo ,state))))
8830 ((memq action '(?- ?+))
8831 (setq tag (org-icompleting-read
8832 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8833 (with-current-buffer (marker-buffer (car entries))
8834 (delq nil
8835 (mapcar (lambda (x)
8836 (if (stringp (car x)) x)) org-tag-alist)))))
8837 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8839 ((memq action '(?s ?d))
8840 (let* ((date (unless arg
8841 (org-read-date
8842 nil nil nil
8843 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
8844 (ans (if arg nil org-read-date-final-answer))
8845 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8846 (setq cmd `(let* ((bound (fboundp 'read-string))
8847 (old (and bound (symbol-function 'read-string))))
8848 (unwind-protect
8849 (progn
8850 (fset 'read-string (lambda (&rest ignore) ,ans))
8851 (eval '(,c1 arg)))
8852 (if bound
8853 (fset 'read-string old)
8854 (fmakunbound 'read-string)))))))
8856 ((equal action ?S)
8857 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8858 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8859 (let ((days (read-number
8860 (format "Scatter tasks across how many %sdays: "
8861 (if arg "week" "")) 7)))
8862 (setq cmd
8863 `(let ((distance (1+ (random ,days))))
8864 (if arg
8865 (let ((dist distance)
8866 (day-of-week
8867 (calendar-day-of-week
8868 (calendar-gregorian-from-absolute (org-today)))))
8869 (dotimes (i (1+ dist))
8870 (while (member day-of-week org-agenda-weekend-days)
8871 (incf distance)
8872 (incf day-of-week)
8873 (if (= day-of-week 7)
8874 (setq day-of-week 0)))
8875 (incf day-of-week)
8876 (if (= day-of-week 7)
8877 (setq day-of-week 0)))))
8878 ;; silently fail when try to replan a sexp entry
8879 (condition-case nil
8880 (let* ((date (calendar-gregorian-from-absolute
8881 (+ (org-today) distance)))
8882 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8883 (nth 2 date))))
8884 (org-agenda-schedule nil time))
8885 (error nil)))))))
8887 ((assoc action org-agenda-bulk-custom-functions)
8888 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
8889 redo-at-end t))
8891 ((equal action ?f)
8892 (setq cmd (list (intern
8893 (org-icompleting-read "Function: "
8894 obarray 'fboundp t nil nil)))))
8896 (t (error "Invalid bulk action")))
8898 ;; Sort the markers, to make sure that parents are handled before children
8899 (setq entries (sort entries
8900 (lambda (a b)
8901 (cond
8902 ((equal (marker-buffer a) (marker-buffer b))
8903 (< (marker-position a) (marker-position b)))
8905 (string< (buffer-name (marker-buffer a))
8906 (buffer-name (marker-buffer b))))))))
8908 ;; Now loop over all markers and apply cmd
8909 (while (setq e (pop entries))
8910 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
8911 (if (not pos)
8912 (progn (message "Skipping removed entry at %s" e)
8913 (setq cntskip (1+ cntskip)))
8914 (goto-char pos)
8915 (let (org-loop-over-headlines-in-active-region)
8916 (eval cmd))
8917 (when (not org-agenda-persistent-marks)
8918 (setq org-agenda-bulk-marked-entries
8919 (delete e org-agenda-bulk-marked-entries)))
8920 (setq cnt (1+ cnt))))
8921 (when (not org-agenda-persistent-marks)
8922 (org-agenda-bulk-unmark-all))
8923 (when redo-at-end (org-agenda-redo))
8924 (message "Acted on %d entries%s%s"
8926 (if (= cntskip 0)
8928 (format ", skipped %d (disappeared before their turn)"
8929 cntskip))
8930 (if (not org-agenda-persistent-marks)
8931 "" " (kept marked)"))))))
8933 ;;; Flagging notes
8935 (defun org-agenda-show-the-flagging-note ()
8936 "Display the flagging note in the other window.
8937 When called a second time in direct sequence, offer to remove the FLAGGING
8938 tag and (if present) the flagging note."
8939 (interactive)
8940 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
8941 (win (selected-window))
8942 note heading newhead)
8943 (unless hdmarker
8944 (error "No linked entry at point"))
8945 (if (and (eq this-command last-command)
8946 (y-or-n-p "Unflag and remove any flagging note? "))
8947 (progn
8948 (org-agenda-remove-flag hdmarker)
8949 (let ((win (get-buffer-window "*Flagging Note*")))
8950 (and win (delete-window win)))
8951 (message "Entry unflagged"))
8952 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
8953 (unless note
8954 (error "No flagging note"))
8955 (org-kill-new note)
8956 (org-switch-to-buffer-other-window "*Flagging Note*")
8957 (erase-buffer)
8958 (insert note)
8959 (goto-char (point-min))
8960 (while (re-search-forward "\\\\n" nil t)
8961 (replace-match "\n" t t))
8962 (goto-char (point-min))
8963 (select-window win)
8964 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
8966 (defun org-agenda-remove-flag (marker)
8967 "Remove the FLAGGED tag and any flagging note in the entry."
8968 (let (newhead)
8969 (org-with-point-at marker
8970 (org-toggle-tag "FLAGGED" 'off)
8971 (org-entry-delete nil "THEFLAGGINGNOTE")
8972 (setq newhead (org-get-heading)))
8973 (org-agenda-change-all-lines newhead marker)
8974 (message "Entry unflagged")))
8976 (defun org-agenda-get-any-marker (&optional pos)
8977 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
8978 (get-text-property (or pos (point-at-bol)) 'org-marker)))
8980 ;;; Appointment reminders
8982 (defvar appt-time-msg-list)
8984 ;;;###autoload
8985 (defun org-agenda-to-appt (&optional refresh filter &rest args)
8986 "Activate appointments found in `org-agenda-files'.
8987 With a \\[universal-argument] prefix, refresh the list of
8988 appointments.
8990 If FILTER is t, interactively prompt the user for a regular
8991 expression, and filter out entries that don't match it.
8993 If FILTER is a string, use this string as a regular expression
8994 for filtering entries out.
8996 If FILTER is a function, filter out entries against which
8997 calling the function returns nil. This function takes one
8998 argument: an entry from `org-agenda-get-day-entries'.
9000 FILTER can also be an alist with the car of each cell being
9001 either 'headline or 'category. For example:
9003 '((headline \"IMPORTANT\")
9004 (category \"Work\"))
9006 will only add headlines containing IMPORTANT or headlines
9007 belonging to the \"Work\" category.
9009 ARGS are symbols indicating what kind of entries to consider.
9010 By default `org-agenda-to-appt' will use :deadline, :scheduled
9011 and :timestamp entries. See the docstring of `org-diary' for
9012 details and examples.
9014 If an entry as a APPT_WARNTIME property, its value will be used
9015 to override `appt-message-warning-time'."
9016 (interactive "P")
9017 (if refresh (setq appt-time-msg-list nil))
9018 (if (eq filter t)
9019 (setq filter (read-from-minibuffer "Regexp filter: ")))
9020 (let* ((cnt 0) ; count added events
9021 (scope (or args '(:deadline :scheduled :timestamp)))
9022 (org-agenda-new-buffers nil)
9023 (org-deadline-warning-days 0)
9024 ;; Do not use `org-today' here because appt only takes
9025 ;; time and without date as argument, so it may pass wrong
9026 ;; information otherwise
9027 (today (org-date-to-gregorian
9028 (time-to-days (current-time))))
9029 (org-agenda-restrict nil)
9030 (files (org-agenda-files 'unrestricted)) entries file
9031 (org-agenda-buffer nil))
9032 ;; Get all entries which may contain an appt
9033 (org-prepare-agenda-buffers files)
9034 (while (setq file (pop files))
9035 (setq entries
9036 (delq nil
9037 (append entries
9038 (apply 'org-agenda-get-day-entries
9039 file today scope)))))
9040 ;; Map thru entries and find if we should filter them out
9041 (mapc
9042 (lambda(x)
9043 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
9044 (cat (get-text-property 1 'org-category x))
9045 (tod (get-text-property 1 'time-of-day x))
9046 (ok (or (null filter)
9047 (and (stringp filter) (string-match filter evt))
9048 (and (functionp filter) (funcall filter x))
9049 (and (listp filter)
9050 (let ((cat-filter (cadr (assoc 'category filter)))
9051 (evt-filter (cadr (assoc 'headline filter))))
9052 (or (and (stringp cat-filter)
9053 (string-match cat-filter cat))
9054 (and (stringp evt-filter)
9055 (string-match evt-filter evt)))))))
9056 (wrn (get-text-property 1 'warntime x)))
9057 ;; FIXME: Shall we remove text-properties for the appt text?
9058 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
9059 (when (and ok tod)
9060 (setq tod (concat "00" (number-to-string tod))
9061 tod (when (string-match
9062 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
9063 (concat (match-string 1 tod) ":"
9064 (match-string 2 tod))))
9065 (if (version< emacs-version "23.3")
9066 (appt-add tod evt)
9067 (appt-add tod evt wrn))
9068 (setq cnt (1+ cnt))))) entries)
9069 (org-release-buffers org-agenda-new-buffers)
9070 (if (eq cnt 0)
9071 (message "No event to add")
9072 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
9074 (defun org-agenda-todayp (date)
9075 "Does DATE mean today, when considering `org-extend-today-until'?"
9076 (let ((today (org-today))
9077 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
9078 date)))
9079 (eq date today)))
9081 (defun org-agenda-todo-yesterday (&optional arg)
9082 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
9083 (interactive "P")
9084 (let* ((hour (third (decode-time
9085 (org-current-time))))
9086 (org-extend-today-until (1+ hour)))
9087 (org-agenda-todo arg)))
9089 (provide 'org-agenda)
9091 ;;; org-agenda.el ends here