Re-create mulitple-agenda-buffers support, to avoid git rebase hell
[org-mode.git] / lisp / org-agenda.el
blob162aa9f9e6675a57c9fc534a7af6f05223160a8f
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 (eval-when-compile
50 (require 'cl))
52 (declare-function diary-add-to-list "diary-lib"
53 (date string specifier &optional marker globcolor literal))
54 (declare-function calendar-absolute-from-iso "cal-iso" (date))
55 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
56 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
57 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
58 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
59 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-french-date-string "cal-french" (&optional date))
61 (declare-function calendar-goto-date "cal-move" (date))
62 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
63 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
64 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
65 (declare-function calendar-iso-from-absolute "cal-iso" (date))
66 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
67 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
68 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
69 (declare-function calendar-check-holidays "holidays" (date))
71 (declare-function org-datetree-find-date-create "org-datetree"
72 (date &optional keep-restriction))
73 (declare-function org-columns-quit "org-colview" ())
74 (declare-function diary-date-display-form "diary-lib" (&optional type))
75 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
76 (declare-function org-habit-insert-consistency-graphs
77 "org-habit" (&optional line))
78 (declare-function org-is-habit-p "org-habit" (&optional pom))
79 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
80 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
81 (declare-function org-pop-to-buffer-same-window "org-compat"
82 (&optional buffer-or-name norecord label))
84 (defvar calendar-mode-map)
85 (defvar org-clock-current-task) ; defined in org-clock.el
86 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
87 (defvar org-habit-show-habits)
88 (defvar org-habit-show-habits-only-for-today)
90 ;; Defined somewhere in this file, but used before definition.
91 (defvar org-agenda-buffer-name)
92 (defvar org-agenda-overriding-header)
93 (defvar org-agenda-title-append nil)
94 (defvar entry)
95 (defvar date)
96 (defvar org-agenda-undo-list)
97 (defvar org-agenda-pending-undo-list)
98 (defvar original-date) ; dynamically scoped, calendar.el does scope this
100 (defcustom org-agenda-confirm-kill 1
101 "When set, remote killing from the agenda buffer needs confirmation.
102 When t, a confirmation is always needed. When a number N, confirmation is
103 only needed when the text to be killed contains more than N non-white lines."
104 :group 'org-agenda
105 :type '(choice
106 (const :tag "Never" nil)
107 (const :tag "Always" t)
108 (integer :tag "When more than N lines")))
110 (defcustom org-agenda-compact-blocks nil
111 "Non-nil means make the block agenda more compact.
112 This is done globally by leaving out lines like the agenda span
113 name and week number or the separator lines."
114 :group 'org-agenda
115 :type 'boolean)
117 (defcustom org-agenda-block-separator ?=
118 "The separator between blocks in the agenda.
119 If this is a string, it will be used as the separator, with a newline added.
120 If it is a character, it will be repeated to fill the window width.
121 If nil the separator is disabled. In `org-agenda-custom-commands' this
122 addresses the separator between the current and the previous block."
123 :group 'org-agenda
124 :type '(choice
125 (const :tag "Disabled" nil)
126 (character)
127 (string)))
129 (defgroup org-agenda-export nil
130 "Options concerning exporting agenda views in Org-mode."
131 :tag "Org Agenda Export"
132 :group 'org-agenda)
134 (defcustom org-agenda-with-colors t
135 "Non-nil means use colors in agenda views."
136 :group 'org-agenda-export
137 :type 'boolean)
139 (defcustom org-agenda-exporter-settings nil
140 "Alist of variable/value pairs that should be active during agenda export.
141 This is a good place to set options for ps-print and for htmlize.
142 Note that the way this is implemented, the values will be evaluated
143 before assigned to the variables. So make sure to quote values you do
144 *not* want evaluated, for example
146 (setq org-agenda-exporter-settings
147 '((ps-print-color-p 'black-white)))"
148 :group 'org-agenda-export
149 :type '(repeat
150 (list
151 (variable)
152 (sexp :tag "Value"))))
154 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
155 "Hook run in temporary buffer before writing it to an export file.
156 A useful function is `org-agenda-add-entry-text'."
157 :group 'org-agenda-export
158 :type 'hook
159 :options '(org-agenda-add-entry-text))
161 (defcustom org-agenda-add-entry-text-maxlines 0
162 "Maximum number of entry text lines to be added to agenda.
163 This is only relevant when `org-agenda-add-entry-text' is part of
164 `org-agenda-before-write-hook', which it is by default.
165 When this is 0, nothing will happen. When it is greater than 0, it
166 specifies the maximum number of lines that will be added for each entry
167 that is listed in the agenda view.
169 Note that this variable is not used during display, only when exporting
170 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
171 and `org-agenda-entry-text-maxlines'."
172 :group 'org-agenda
173 :type 'integer)
175 (defcustom org-agenda-add-entry-text-descriptive-links t
176 "Non-nil means export org-links as descriptive links in agenda added text.
177 This variable applies to the text added to the agenda when
178 `org-agenda-add-entry-text-maxlines' is larger than 0.
179 When this variable nil, the URL will (also) be shown."
180 :group 'org-agenda
181 :type 'boolean)
183 (defcustom org-agenda-export-html-style ""
184 "The style specification for exported HTML Agenda files.
185 If this variable contains a string, it will replace the default <style>
186 section as produced by `htmlize'.
187 Since there are different ways of setting style information, this variable
188 needs to contain the full HTML structure to provide a style, including the
189 surrounding HTML tags. The style specifications should include definitions
190 the fonts used by the agenda, here is an example:
192 <style type=\"text/css\">
193 p { font-weight: normal; color: gray; }
194 .org-agenda-structure {
195 font-size: 110%;
196 color: #003399;
197 font-weight: 600;
199 .org-todo {
200 color: #cc6666;
201 font-weight: bold;
203 .org-agenda-done {
204 color: #339933;
206 .org-done {
207 color: #339933;
209 .title { text-align: center; }
210 .todo, .deadline { color: red; }
211 .done { color: green; }
212 </style>
214 or, if you want to keep the style in a file,
216 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
218 As the value of this option simply gets inserted into the HTML <head> header,
219 you can \"misuse\" it to also add other text to the header. However,
220 <style>...</style> is required, if not present the variable will be ignored."
221 :group 'org-agenda-export
222 :group 'org-export-html
223 :type 'string)
225 (defcustom org-agenda-persistent-filter nil
226 "When set, keep filters from one agenda view to the next."
227 :group 'org-agenda
228 :type 'boolean)
230 (defgroup org-agenda-custom-commands nil
231 "Options concerning agenda views in Org-mode."
232 :tag "Org Agenda Custom Commands"
233 :group 'org-agenda)
235 (defconst org-sorting-choice
236 '(choice
237 (const time-up) (const time-down)
238 (const category-keep) (const category-up) (const category-down)
239 (const tag-down) (const tag-up)
240 (const priority-up) (const priority-down)
241 (const todo-state-up) (const todo-state-down)
242 (const effort-up) (const effort-down)
243 (const habit-up) (const habit-down)
244 (const alpha-up) (const alpha-down)
245 (const user-defined-up) (const user-defined-down))
246 "Sorting choices.")
248 ;; Keep custom values for `org-agenda-filter-preset' compatible with
249 ;; the new variable `org-agenda-tag-filter-preset'.
250 (if (fboundp 'defvaralias)
251 (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
252 (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
254 (defconst org-agenda-custom-commands-local-options
255 `(repeat :tag "Local settings for this command. Remember to quote values"
256 (choice :tag "Setting"
257 (list :tag "Heading for this block"
258 (const org-agenda-overriding-header)
259 (string :tag "Headline"))
260 (list :tag "Files to be searched"
261 (const org-agenda-files)
262 (list
263 (const :format "" quote)
264 (repeat (file))))
265 (list :tag "Sorting strategy"
266 (const org-agenda-sorting-strategy)
267 (list
268 (const :format "" quote)
269 (repeat
270 ,org-sorting-choice)))
271 (list :tag "Prefix format"
272 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
273 (string))
274 (list :tag "Number of days in agenda"
275 (const org-agenda-span)
276 (choice (const :tag "Day" 'day)
277 (const :tag "Week" 'week)
278 (const :tag "Month" 'month)
279 (const :tag "Year" 'year)
280 (integer :tag "Custom")))
281 (list :tag "Fixed starting date"
282 (const org-agenda-start-day)
283 (string :value "2007-11-01"))
284 (list :tag "Start on day of week"
285 (const org-agenda-start-on-weekday)
286 (choice :value 1
287 (const :tag "Today" nil)
288 (integer :tag "Weekday No.")))
289 (list :tag "Include data from diary"
290 (const org-agenda-include-diary)
291 (boolean))
292 (list :tag "Deadline Warning days"
293 (const org-deadline-warning-days)
294 (integer :value 1))
295 (list :tag "Category filter preset"
296 (const org-agenda-category-filter-preset)
297 (list
298 (const :format "" quote)
299 (repeat
300 (string :tag "+category or -category"))))
301 (list :tag "Tags filter preset"
302 (const org-agenda-tag-filter-preset)
303 (list
304 (const :format "" quote)
305 (repeat
306 (string :tag "+tag or -tag"))))
307 (list :tag "Set daily/weekly entry types"
308 (const org-agenda-entry-types)
309 (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
310 (const :deadline)
311 (const :scheduled)
312 (const :timestamp)
313 (const :sexp)))
314 (list :tag "Standard skipping condition"
315 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
316 (const org-agenda-skip-function)
317 (list
318 (const :format "" quote)
319 (list
320 (choice
321 :tag "Skipping range"
322 (const :tag "Skip entry" org-agenda-skip-entry-if)
323 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
324 (repeat :inline t :tag "Conditions for skipping"
325 (choice
326 :tag "Condition type"
327 (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
328 (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
329 (list :tag "TODO state is" :inline t
330 (const 'todo)
331 (choice
332 (const :tag "any not-done state" 'todo)
333 (const :tag "any done state" 'done)
334 (const :tag "any state" 'any)
335 (list :tag "Keyword list"
336 (const :format "" quote)
337 (repeat (string :tag "Keyword")))))
338 (list :tag "TODO state is not" :inline t
339 (const 'nottodo)
340 (choice
341 (const :tag "any not-done state" 'todo)
342 (const :tag "any done state" 'done)
343 (const :tag "any state" 'any)
344 (list :tag "Keyword list"
345 (const :format "" quote)
346 (repeat (string :tag "Keyword")))))
347 (const :tag "scheduled" 'scheduled)
348 (const :tag "not scheduled" 'notscheduled)
349 (const :tag "deadline" 'deadline)
350 (const :tag "no deadline" 'notdeadline)
351 (const :tag "timestamp" 'timestamp)
352 (const :tag "no timestamp" 'nottimestamp))))))
353 (list :tag "Non-standard skipping condition"
354 :value (org-agenda-skip-function)
355 (const org-agenda-skip-function)
356 (sexp :tag "Function or form (quoted!)"))
357 (list :tag "Any variable"
358 (variable :tag "Variable")
359 (sexp :tag "Value (sexp)"))))
360 "Selection of examples for agenda command settings.
361 This will be spliced into the custom type of
362 `org-agenda-custom-commands'.")
365 (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
366 ((agenda "") (alltodo))))
367 "Custom commands for the agenda.
368 These commands will be offered on the splash screen displayed by the
369 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
371 (key desc type match settings files)
373 key The key (one or more characters as a string) to be associated
374 with the command.
375 desc A description of the command, when omitted or nil, a default
376 description is built using MATCH.
377 type The command type, any of the following symbols:
378 agenda The daily/weekly agenda.
379 todo Entries with a specific TODO keyword, in all agenda files.
380 search Entries containing search words entry or headline.
381 tags Tags/Property/TODO match in all agenda files.
382 tags-todo Tags/P/T match in all agenda files, TODO entries only.
383 todo-tree Sparse tree of specific TODO keyword in *current* file.
384 tags-tree Sparse tree with all tags matches in *current* file.
385 occur-tree Occur sparse tree for *current* file.
386 ... A user-defined function.
387 match What to search for:
388 - a single keyword for TODO keyword searches
389 - a tags match expression for tags searches
390 - a word search expression for text searches.
391 - a regular expression for occur searches
392 For all other commands, this should be the empty string.
393 settings A list of option settings, similar to that in a let form, so like
394 this: ((opt1 val1) (opt2 val2) ...). The values will be
395 evaluated at the moment of execution, so quote them when needed.
396 files A list of files file to write the produced agenda buffer to
397 with the command `org-store-agenda-views'.
398 If a file name ends in \".html\", an HTML version of the buffer
399 is written out. If it ends in \".ps\", a postscript version is
400 produced. Otherwise, only the plain text is written to the file.
402 You can also define a set of commands, to create a composite agenda buffer.
403 In this case, an entry looks like this:
405 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
407 where
409 desc A description string to be displayed in the dispatcher menu.
410 cmd An agenda command, similar to the above. However, tree commands
411 are no allowed, but instead you can get agenda and global todo list.
412 So valid commands for a set are:
413 (agenda \"\" settings)
414 (alltodo \"\" settings)
415 (stuck \"\" settings)
416 (todo \"match\" settings files)
417 (search \"match\" settings files)
418 (tags \"match\" settings files)
419 (tags-todo \"match\" settings files)
421 Each command can carry a list of options, and another set of options can be
422 given for the whole set of commands. Individual command options take
423 precedence over the general options.
425 When using several characters as key to a command, the first characters
426 are prefix commands. For the dispatcher to display useful information, you
427 should provide a description for the prefix, like
429 (setq org-agenda-custom-commands
430 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
431 (\"hl\" tags \"+HOME+Lisa\")
432 (\"hp\" tags \"+HOME+Peter\")
433 (\"hk\" tags \"+HOME+Kim\")))"
434 :group 'org-agenda-custom-commands
435 :type `(repeat
436 (choice :value ("x" "Describe command here" tags "" nil)
437 (list :tag "Single command"
438 (string :tag "Access Key(s) ")
439 (option (string :tag "Description"))
440 (choice
441 (const :tag "Agenda" agenda)
442 (const :tag "TODO list" alltodo)
443 (const :tag "Search words" search)
444 (const :tag "Stuck projects" stuck)
445 (const :tag "Tags/Property match (all agenda files)" tags)
446 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
447 (const :tag "TODO keyword search (all agenda files)" todo)
448 (const :tag "Tags sparse tree (current buffer)" tags-tree)
449 (const :tag "TODO keyword tree (current buffer)" todo-tree)
450 (const :tag "Occur tree (current buffer)" occur-tree)
451 (sexp :tag "Other, user-defined function"))
452 (string :tag "Match (only for some commands)")
453 ,org-agenda-custom-commands-local-options
454 (option (repeat :tag "Export" (file :tag "Export to"))))
455 (list :tag "Command series, all agenda files"
456 (string :tag "Access Key(s)")
457 (string :tag "Description ")
458 (repeat :tag "Component"
459 (choice
460 (list :tag "Agenda"
461 (const :format "" agenda)
462 (const :tag "" :format "" "")
463 ,org-agenda-custom-commands-local-options)
464 (list :tag "TODO list (all keywords)"
465 (const :format "" alltodo)
466 (const :tag "" :format "" "")
467 ,org-agenda-custom-commands-local-options)
468 (list :tag "Search words"
469 (const :format "" search)
470 (string :tag "Match")
471 ,org-agenda-custom-commands-local-options)
472 (list :tag "Stuck projects"
473 (const :format "" stuck)
474 (const :tag "" :format "" "")
475 ,org-agenda-custom-commands-local-options)
476 (list :tag "Tags search"
477 (const :format "" tags)
478 (string :tag "Match")
479 ,org-agenda-custom-commands-local-options)
480 (list :tag "Tags search, TODO entries only"
481 (const :format "" tags-todo)
482 (string :tag "Match")
483 ,org-agenda-custom-commands-local-options)
484 (list :tag "TODO keyword search"
485 (const :format "" todo)
486 (string :tag "Match")
487 ,org-agenda-custom-commands-local-options)
488 (list :tag "Other, user-defined function"
489 (symbol :tag "function")
490 (string :tag "Match")
491 ,org-agenda-custom-commands-local-options)))
493 (repeat :tag "Settings for entire command set"
494 (list (variable :tag "Any variable")
495 (sexp :tag "Value")))
496 (option (repeat :tag "Export" (file :tag "Export to"))))
497 (cons :tag "Prefix key documentation"
498 (string :tag "Access Key(s)")
499 (string :tag "Description ")))))
501 (defcustom org-agenda-query-register ?o
502 "The register holding the current query string.
503 The purpose of this is that if you construct a query string interactively,
504 you can then use it to define a custom command."
505 :group 'org-agenda-custom-commands
506 :type 'character)
508 (defcustom org-stuck-projects
509 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
510 "How to identify stuck projects.
511 This is a list of four items:
512 1. A tags/todo/property matcher string that is used to identify a project.
513 See the manual for a description of tag and property searches.
514 The entire tree below a headline matched by this is considered one project.
515 2. A list of TODO keywords identifying non-stuck projects.
516 If the project subtree contains any headline with one of these todo
517 keywords, the project is considered to be not stuck. If you specify
518 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
519 3. A list of tags identifying non-stuck projects.
520 If the project subtree contains any headline with one of these tags,
521 the project is considered to be not stuck. If you specify \"*\" as
522 a tag, any tag will mark the project unstuck. Note that this is about
523 the explicit presence of a tag somewhere in the subtree, inherited
524 tags to not count here. If inherited tags make a project not stuck,
525 use \"-TAG\" in the tags part of the matcher under (1.) above.
526 4. An arbitrary regular expression matching non-stuck projects.
528 If the project turns out to be not stuck, search continues also in the
529 subtree to see if any of the subtasks have project status.
531 See also the variable `org-tags-match-list-sublevels' which applies
532 to projects matched by this search as well.
534 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
535 or `C-c a #' to produce the list."
536 :group 'org-agenda-custom-commands
537 :type '(list
538 (string :tag "Tags/TODO match to identify a project")
539 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
540 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
541 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
543 (defcustom org-agenda-filter-effort-default-operator "<"
544 "The default operator for effort estimate filtering.
545 If you select an effort estimate limit without first pressing an operator,
546 this one will be used."
547 :group 'org-agenda-custom-commands
548 :type '(choice (const :tag "less or equal" "<")
549 (const :tag "greater or equal"">")
550 (const :tag "equal" "=")))
552 (defgroup org-agenda-skip nil
553 "Options concerning skipping parts of agenda files."
554 :tag "Org Agenda Skip"
555 :group 'org-agenda)
557 (defcustom org-agenda-skip-function-global nil
558 "Function to be called at each match during agenda construction.
559 If this function returns nil, the current match should not be skipped.
560 If the function decided to skip an agenda match, is must return the
561 buffer position from which the search should be continued.
562 This may also be a Lisp form, which will be evaluated.
564 This variable will be applied to every agenda match, including
565 tags/property searches and TODO lists. So try to make the test function
566 do its checking as efficiently as possible. To implement a skipping
567 condition just for specific agenda commands, use the variable
568 `org-agenda-skip-function' which can be set in the options section
569 of custom agenda commands."
570 :group 'org-agenda-skip
571 :type 'sexp)
573 (defgroup org-agenda-daily/weekly nil
574 "Options concerning the daily/weekly agenda."
575 :tag "Org Agenda Daily/Weekly"
576 :group 'org-agenda)
577 (defgroup org-agenda-todo-list nil
578 "Options concerning the global todo list agenda view."
579 :tag "Org Agenda Todo List"
580 :group 'org-agenda)
581 (defgroup org-agenda-match-view nil
582 "Options concerning the general tags/property/todo match agenda view."
583 :tag "Org Agenda Match View"
584 :group 'org-agenda)
585 (defgroup org-agenda-search-view nil
586 "Options concerning the general tags/property/todo match agenda view."
587 :tag "Org Agenda Match View"
588 :group 'org-agenda)
590 (defvar org-agenda-archives-mode nil
591 "Non-nil means the agenda will include archived items.
592 If this is the symbol `trees', trees in the selected agenda scope
593 that are marked with the ARCHIVE tag will be included anyway. When this is
594 t, also all archive files associated with the current selection of agenda
595 files will be included.")
597 (defcustom org-agenda-skip-comment-trees t
598 "Non-nil means skip trees that start with the COMMENT keyword.
599 When nil, these trees are also scanned by agenda commands."
600 :group 'org-agenda-skip
601 :type 'boolean)
603 (defcustom org-agenda-todo-list-sublevels t
604 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
605 When nil, the sublevels of a TODO entry are not checked, resulting in
606 potentially much shorter TODO lists."
607 :group 'org-agenda-skip
608 :group 'org-agenda-todo-list
609 :type 'boolean)
611 (defcustom org-agenda-todo-ignore-with-date nil
612 "Non-nil means don't show entries with a date in the global todo list.
613 You can use this if you prefer to mark mere appointments with a TODO keyword,
614 but don't want them to show up in the TODO list.
615 When this is set, it also covers deadlines and scheduled items, the settings
616 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
617 will be ignored.
618 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
619 :group 'org-agenda-skip
620 :group 'org-agenda-todo-list
621 :type 'boolean)
623 (defcustom org-agenda-todo-ignore-timestamp nil
624 "Non-nil means don't show entries with a timestamp.
625 This applies when creating the global todo list.
626 Valid values are:
628 past Don't show entries for today or in the past.
630 future Don't show entries with a timestamp in the future.
631 The idea behind this is that if it has a future
632 timestamp, you don't want to think about it until the
633 date.
635 all Don't show any entries with a timestamp in the global todo list.
636 The idea behind this is that by setting a timestamp, you
637 have already \"taken care\" of this item.
639 This variable can also have an integer as a value. If positive (N),
640 todos with a timestamp N or more days in the future will be ignored. If
641 negative (-N), todos with a timestamp N or more days in the past will be
642 ignored. If 0, todos with a timestamp either today or in the future will
643 be ignored. For example, a value of -1 will exclude todos with a
644 timestamp in the past (yesterday or earlier), while a value of 7 will
645 exclude todos with a timestamp a week or more in the future.
647 See also `org-agenda-todo-ignore-with-date'.
648 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
649 to make his option also apply to the tags-todo list."
650 :group 'org-agenda-skip
651 :group 'org-agenda-todo-list
652 :version "24.1"
653 :type '(choice
654 (const :tag "Ignore future timestamp todos" future)
655 (const :tag "Ignore past or present timestamp todos" past)
656 (const :tag "Ignore all timestamp todos" all)
657 (const :tag "Show timestamp todos" nil)
658 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
660 (defcustom org-agenda-todo-ignore-scheduled nil
661 "Non-nil means, ignore some scheduled TODO items when making TODO list.
662 This applies when creating the global todo list.
663 Valid values are:
665 past Don't show entries scheduled today or in the past.
667 future Don't show entries scheduled in the future.
668 The idea behind this is that by scheduling it, you don't want to
669 think about it until the scheduled date.
671 all Don't show any scheduled entries in the global todo list.
672 The idea behind this is that by scheduling it, you have already
673 \"taken care\" of this item.
675 t Same as `all', for backward compatibility.
677 This variable can also have an integer as a value. See
678 `org-agenda-todo-ignore-timestamp' for more details.
680 See also `org-agenda-todo-ignore-with-date'.
681 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
682 to make his option also apply to the tags-todo list."
683 :group 'org-agenda-skip
684 :group 'org-agenda-todo-list
685 :type '(choice
686 (const :tag "Ignore future-scheduled todos" future)
687 (const :tag "Ignore past- or present-scheduled todos" past)
688 (const :tag "Ignore all scheduled todos" all)
689 (const :tag "Ignore all scheduled todos (compatibility)" t)
690 (const :tag "Show scheduled todos" nil)
691 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
693 (defcustom org-agenda-todo-ignore-deadlines nil
694 "Non-nil means ignore some deadlined TODO items when making TODO list.
695 There are different motivations for using different values, please think
696 carefully when configuring this variable.
698 This applies when creating the global todo list.
699 Valid values are:
701 near Don't show near deadline entries. A deadline is near when it is
702 closer than `org-deadline-warning-days' days. The idea behind this
703 is that such items will appear in the agenda anyway.
705 far Don't show TODO entries where a deadline has been defined, but
706 the deadline is not near. This is useful if you don't want to
707 use the todo list to figure out what to do now.
709 past Don't show entries with a deadline timestamp for today or in the past.
711 future Don't show entries with a deadline timestamp in the future, not even
712 when they become `near' ones. Use it with caution.
714 all Ignore all TODO entries that do have a deadline.
716 t Same as `near', for backward compatibility.
718 This variable can also have an integer as a value. See
719 `org-agenda-todo-ignore-timestamp' for more details.
721 See also `org-agenda-todo-ignore-with-date'.
722 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
723 to make his option also apply to the tags-todo list."
724 :group 'org-agenda-skip
725 :group 'org-agenda-todo-list
726 :type '(choice
727 (const :tag "Ignore near deadlines" near)
728 (const :tag "Ignore near deadlines (compatibility)" t)
729 (const :tag "Ignore far deadlines" far)
730 (const :tag "Ignore all TODOs with a deadlines" all)
731 (const :tag "Show all TODOs, even if they have a deadline" nil)
732 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
734 (defcustom org-agenda-tags-todo-honor-ignore-options nil
735 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
736 The variables
737 `org-agenda-todo-ignore-with-date',
738 `org-agenda-todo-ignore-timestamp',
739 `org-agenda-todo-ignore-scheduled',
740 `org-agenda-todo-ignore-deadlines'
741 make the global TODO list skip entries that have time stamps of certain
742 kinds. If this option is set, the same options will also apply for the
743 tags-todo search, which is the general tags/property matcher
744 restricted to unfinished TODO entries only."
745 :group 'org-agenda-skip
746 :group 'org-agenda-todo-list
747 :group 'org-agenda-match-view
748 :type 'boolean)
750 (defcustom org-agenda-skip-scheduled-if-done nil
751 "Non-nil means don't show scheduled items in agenda when they are done.
752 This is relevant for the daily/weekly agenda, not for the TODO list. And
753 it applies only to the actual date of the scheduling. Warnings about
754 an item with a past scheduling dates are always turned off when the item
755 is DONE."
756 :group 'org-agenda-skip
757 :group 'org-agenda-daily/weekly
758 :type 'boolean)
760 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
761 "Non-nil means skip scheduling line if same entry shows because of deadline.
762 In the agenda of today, an entry can show up multiple times because
763 it is both scheduled and has a nearby deadline, and maybe a plain time
764 stamp as well.
765 When this variable is t, then only the deadline is shown and the fact that
766 the entry is scheduled today or was scheduled previously is not shown.
767 When this variable is nil, the entry will be shown several times. When
768 the variable is the symbol `not-today', then skip scheduled previously,
769 but not scheduled today."
770 :group 'org-agenda-skip
771 :group 'org-agenda-daily/weekly
772 :type '(choice
773 (const :tag "Never" nil)
774 (const :tag "Always" t)
775 (const :tag "Not when scheduled today" not-today)))
777 (defcustom org-agenda-skip-deadline-if-done nil
778 "Non-nil means don't show deadlines when the corresponding item is done.
779 When nil, the deadline is still shown and should give you a happy feeling.
780 This is relevant for the daily/weekly agenda. And it applied only to the
781 actually date of the deadline. Warnings about approaching and past-due
782 deadlines are always turned off when the item is DONE."
783 :group 'org-agenda-skip
784 :group 'org-agenda-daily/weekly
785 :type 'boolean)
787 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
788 "Non-nil means skip deadline prewarning when entry is also scheduled.
789 This will apply on all days where a prewarning for the deadline would
790 be shown, but not at the day when the entry is actually due. On that day,
791 the deadline will be shown anyway.
792 This variable may be set to nil, t, or a number which will then give
793 the number of days before the actual deadline when the prewarnings
794 should resume.
795 This can be used in a workflow where the first showing of the deadline will
796 trigger you to schedule it, and then you don't want to be reminded of it
797 because you will take care of it on the day when scheduled."
798 :group 'org-agenda-skip
799 :group 'org-agenda-daily/weekly
800 :version "24.1"
801 :type '(choice
802 (const :tag "Alwas show prewarning" nil)
803 (const :tag "Remove prewarning if entry is scheduled" t)
804 (integer :tag "Restart prewarning N days before deadline")))
806 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
807 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
808 When non-nil, after the search for timestamps has matched once in an
809 entry, the rest of the entry will not be searched."
810 :group 'org-agenda-skip
811 :type 'boolean)
813 (defcustom org-agenda-skip-timestamp-if-done nil
814 "Non-nil means don't select item by timestamp or -range if it is DONE."
815 :group 'org-agenda-skip
816 :group 'org-agenda-daily/weekly
817 :type 'boolean)
819 (defcustom org-agenda-dim-blocked-tasks t
820 "Non-nil means dim blocked tasks in the agenda display.
821 This causes some overhead during agenda construction, but if you
822 have turned on `org-enforce-todo-dependencies',
823 `org-enforce-todo-checkbox-dependencies', or any other blocking
824 mechanism, this will create useful feedback in the agenda.
826 Instead of t, this variable can also have the value `invisible'.
827 Then blocked tasks will be invisible and only become visible when
828 they become unblocked. An exemption to this behavior is when a task is
829 blocked because of unchecked checkboxes below it. Since checkboxes do
830 not show up in the agenda views, making this task invisible you remove any
831 trace from agenda views that there is something to do. Therefore, a task
832 that is blocked because of checkboxes will never be made invisible, it
833 will only be dimmed."
834 :group 'org-agenda-daily/weekly
835 :group 'org-agenda-todo-list
836 :type '(choice
837 (const :tag "Do not dim" nil)
838 (const :tag "Dim to a gray face" t)
839 (const :tag "Make invisible" invisible)))
841 (defcustom org-timeline-show-empty-dates 3
842 "Non-nil means `org-timeline' also shows dates without an entry.
843 When nil, only the days which actually have entries are shown.
844 When t, all days between the first and the last date are shown.
845 When an integer, show also empty dates, but if there is a gap of more than
846 N days, just insert a special line indicating the size of the gap."
847 :group 'org-agenda-skip
848 :type '(choice
849 (const :tag "None" nil)
850 (const :tag "All" t)
851 (integer :tag "at most")))
853 (defgroup org-agenda-startup nil
854 "Options concerning initial settings in the Agenda in Org Mode."
855 :tag "Org Agenda Startup"
856 :group 'org-agenda)
858 (defcustom org-agenda-menu-show-matcher t
859 "Non-nil means show the match string in the agenda dispatcher menu.
860 When nil, the matcher string is not shown, but is put into the help-echo
861 property so than moving the mouse over the command shows it.
862 Setting it to nil is good if matcher strings are very long and/or if
863 you want to use two-column display (see `org-agenda-menu-two-column')."
864 :group 'org-agenda
865 :version "24.1"
866 :type 'boolean)
868 (defcustom org-agenda-menu-two-column nil
869 "Non-nil means, use two columns to show custom commands in the dispatcher.
870 If you use this, you probably want to set `org-agenda-menu-show-matcher'
871 to nil."
872 :group 'org-agenda
873 :version "24.1"
874 :type 'boolean)
876 (defcustom org-finalize-agenda-hook nil
877 "Hook run just before displaying an agenda buffer."
878 :group 'org-agenda-startup
879 :type 'hook)
881 (defcustom org-agenda-mouse-1-follows-link nil
882 "Non-nil means mouse-1 on a link will follow the link in the agenda.
883 A longer mouse click will still set point. Does not work on XEmacs.
884 Needs to be set before org.el is loaded."
885 :group 'org-agenda-startup
886 :type 'boolean)
888 (defcustom org-agenda-start-with-follow-mode nil
889 "The initial value of follow mode in a newly created agenda window."
890 :group 'org-agenda-startup
891 :type 'boolean)
893 (defcustom org-agenda-follow-indirect nil
894 "Non-nil means `org-agenda-follow-mode' displays only the
895 current item's tree, in an indirect buffer."
896 :group 'org-agenda
897 :version "24.1"
898 :type 'boolean)
900 (defcustom org-agenda-show-outline-path t
901 "Non-nil means show outline path in echo area after line motion."
902 :group 'org-agenda-startup
903 :type 'boolean)
905 (defcustom org-agenda-start-with-entry-text-mode nil
906 "The initial value of entry-text-mode in a newly created agenda window."
907 :group 'org-agenda-startup
908 :type 'boolean)
910 (defcustom org-agenda-entry-text-maxlines 5
911 "Number of text lines to be added when `E' is pressed in the agenda.
913 Note that this variable only used during agenda display. Add add entry text
914 when exporting the agenda, configure the variable
915 `org-agenda-add-entry-ext-maxlines'."
916 :group 'org-agenda
917 :type 'integer)
919 (defcustom org-agenda-entry-text-exclude-regexps nil
920 "List of regular expressions to clean up entry text.
921 The complete matches of all regular expressions in this list will be
922 removed from entry text before it is shown in the agenda."
923 :group 'org-agenda
924 :type '(repeat (regexp)))
926 (defvar org-agenda-entry-text-cleanup-hook nil
927 "Hook that is run after basic cleanup of entry text to be shown in agenda.
928 This cleanup is done in a temporary buffer, so the function may inspect and
929 change the entire buffer.
930 Some default stuff like drawers and scheduling/deadline dates will already
931 have been removed when this is called, as will any matches for regular
932 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
934 (defvar org-agenda-include-inactive-timestamps nil
935 "Non-nil means include inactive time stamps in agenda and timeline.")
937 (defgroup org-agenda-windows nil
938 "Options concerning the windows used by the Agenda in Org Mode."
939 :tag "Org Agenda Windows"
940 :group 'org-agenda)
942 (defcustom org-agenda-window-setup 'reorganize-frame
943 "How the agenda buffer should be displayed.
944 Possible values for this option are:
946 current-window Show agenda in the current window, keeping all other windows.
947 other-window Use `switch-to-buffer-other-window' to display agenda.
948 reorganize-frame Show only two windows on the current frame, the current
949 window and the agenda.
950 other-frame Use `switch-to-buffer-other-frame' to display agenda.
951 Also, when exiting the agenda, kill that frame.
952 See also the variable `org-agenda-restore-windows-after-quit'."
953 :group 'org-agenda-windows
954 :type '(choice
955 (const current-window)
956 (const other-frame)
957 (const other-window)
958 (const reorganize-frame)))
960 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
961 "The min and max height of the agenda window as a fraction of frame height.
962 The value of the variable is a cons cell with two numbers between 0 and 1.
963 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
964 :group 'org-agenda-windows
965 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
967 (defcustom org-agenda-restore-windows-after-quit nil
968 "Non-nil means restore window configuration upon exiting agenda.
969 Before the window configuration is changed for displaying the agenda,
970 the current status is recorded. When the agenda is exited with
971 `q' or `x' and this option is set, the old state is restored. If
972 `org-agenda-window-setup' is `other-frame', the value of this
973 option will be ignored."
974 :group 'org-agenda-windows
975 :type 'boolean)
977 (defcustom org-agenda-ndays nil
978 "Number of days to include in overview display.
979 Should be 1 or 7.
980 Obsolete, see `org-agenda-span'."
981 :group 'org-agenda-daily/weekly
982 :type 'integer)
984 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
986 (defcustom org-agenda-span 'week
987 "Number of days to include in overview display.
988 Can be day, week, month, year, or any number of days.
989 Custom commands can set this variable in the options section."
990 :group 'org-agenda-daily/weekly
991 :type '(choice (const :tag "Day" day)
992 (const :tag "Week" week)
993 (const :tag "Month" month)
994 (const :tag "Year" year)
995 (integer :tag "Custom")))
997 (defcustom org-agenda-start-on-weekday 1
998 "Non-nil means start the overview always on the specified weekday.
999 0 denotes Sunday, 1 denotes Monday etc.
1000 When nil, always start on the current day.
1001 Custom commands can set this variable in the options section."
1002 :group 'org-agenda-daily/weekly
1003 :type '(choice (const :tag "Today" nil)
1004 (integer :tag "Weekday No.")))
1006 (defcustom org-agenda-show-all-dates t
1007 "Non-nil means `org-agenda' shows every day in the selected range.
1008 When nil, only the days which actually have entries are shown."
1009 :group 'org-agenda-daily/weekly
1010 :type 'boolean)
1012 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1013 "Format string for displaying dates in the agenda.
1014 Used by the daily/weekly agenda and by the timeline. This should be
1015 a format string understood by `format-time-string', or a function returning
1016 the formatted date as a string. The function must take a single argument,
1017 a calendar-style date list like (month day year)."
1018 :group 'org-agenda-daily/weekly
1019 :type '(choice
1020 (string :tag "Format string")
1021 (function :tag "Function")))
1023 (defun org-agenda-format-date-aligned (date)
1024 "Format a date string for display in the daily/weekly agenda, or timeline.
1025 This function makes sure that dates are aligned for easy reading."
1026 (require 'cal-iso)
1027 (let* ((dayname (calendar-day-name date))
1028 (day (cadr date))
1029 (day-of-week (calendar-day-of-week date))
1030 (month (car date))
1031 (monthname (calendar-month-name month))
1032 (year (nth 2 date))
1033 (iso-week (org-days-to-iso-week
1034 (calendar-absolute-from-gregorian date)))
1035 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1036 (1- year))
1037 ((and (= month 12) (<= iso-week 1))
1038 (1+ year))
1039 (t year)))
1040 (weekstring (if (= day-of-week 1)
1041 (format " W%02d" iso-week)
1042 "")))
1043 (format "%-10s %2d %s %4d%s"
1044 dayname day monthname year weekstring)))
1046 (defcustom org-agenda-time-leading-zero nil
1047 "Non-nil means use leading zero for military times in agenda.
1048 For example, 9:30am would become 09:30 rather than 9:30."
1049 :group 'org-agenda-daily/weekly
1050 :version "24.1"
1051 :type 'boolean)
1053 (defcustom org-agenda-timegrid-use-ampm nil
1054 "When set, show AM/PM style timestamps on the timegrid."
1055 :group 'org-agenda
1056 :version "24.1"
1057 :type 'boolean)
1059 (defun org-agenda-time-of-day-to-ampm (time)
1060 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1061 (let* ((hour-number (string-to-number (substring time 0 -3)))
1062 (minute (substring time -2))
1063 (ampm "am"))
1064 (cond
1065 ((equal hour-number 12)
1066 (setq ampm "pm"))
1067 ((> hour-number 12)
1068 (setq ampm "pm")
1069 (setq hour-number (- hour-number 12))))
1070 (concat
1071 (if org-agenda-time-leading-zero
1072 (format "%02d" hour-number)
1073 (format "%02s" (number-to-string hour-number)))
1074 ":" minute ampm)))
1076 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1077 "Conditionally convert TIME to AM/PM format
1078 based on `org-agenda-timegrid-use-ampm'"
1079 (if org-agenda-timegrid-use-ampm
1080 (org-agenda-time-of-day-to-ampm time)
1081 time))
1083 (defcustom org-agenda-weekend-days '(6 0)
1084 "Which days are weekend?
1085 These days get the special face `org-agenda-date-weekend' in the agenda
1086 and timeline buffers."
1087 :group 'org-agenda-daily/weekly
1088 :type '(set :greedy t
1089 (const :tag "Monday" 1)
1090 (const :tag "Tuesday" 2)
1091 (const :tag "Wednesday" 3)
1092 (const :tag "Thursday" 4)
1093 (const :tag "Friday" 5)
1094 (const :tag "Saturday" 6)
1095 (const :tag "Sunday" 0)))
1097 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1098 "Non-nil means jump to today when moving a past date forward in time.
1099 When using S-right in the agenda to move a a date forward, and the date
1100 stamp currently points to the past, the first key press will move it
1101 to today. WHen nil, just move one day forward even if the date stays
1102 in the past."
1103 :group 'org-agenda-daily/weekly
1104 :version "24.1"
1105 :type 'boolean)
1107 (defcustom org-agenda-include-diary nil
1108 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1109 Custom commands can set this variable in the options section."
1110 :group 'org-agenda-daily/weekly
1111 :type 'boolean)
1113 (defcustom org-agenda-include-deadlines t
1114 "If non-nil, include entries within their deadline warning period.
1115 Custom commands can set this variable in the options section."
1116 :group 'org-agenda-daily/weekly
1117 :version "24.1"
1118 :type 'boolean)
1120 (defcustom org-agenda-repeating-timestamp-show-all t
1121 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1122 When set to a list of strings, only show occurrences of repeating
1123 stamps for these TODO keywords. When nil, only one occurrence is
1124 shown, either today or the nearest into the future."
1125 :group 'org-agenda-daily/weekly
1126 :type '(choice
1127 (const :tag "Show repeating stamps" t)
1128 (repeat :tag "Show repeating stamps for these TODO keywords"
1129 (string :tag "TODO Keyword"))
1130 (const :tag "Don't show repeating stamps" nil)))
1132 (defcustom org-scheduled-past-days 10000
1133 "No. of days to continue listing scheduled items that are not marked DONE.
1134 When an item is scheduled on a date, it shows up in the agenda on this
1135 day and will be listed until it is marked done for the number of days
1136 given here."
1137 :group 'org-agenda-daily/weekly
1138 :type 'integer)
1140 (defcustom org-agenda-log-mode-items '(closed clock)
1141 "List of items that should be shown in agenda log mode.
1142 This list may contain the following symbols:
1144 closed Show entries that have been closed on that day.
1145 clock Show entries that have received clocked time on that day.
1146 state Show all logged state changes.
1147 Note that instead of changing this variable, you can also press `C-u l' in
1148 the agenda to display all available LOG items temporarily."
1149 :group 'org-agenda-daily/weekly
1150 :type '(set :greedy t (const closed) (const clock) (const state)))
1152 (defcustom org-agenda-clock-consistency-checks
1153 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1154 :gap-ok-around ("4:00")
1155 :default-face ((:background "DarkRed") (:foreground "white"))
1156 :overlap-face nil :gap-face nil :no-end-time-face nil
1157 :long-face nil :short-face nil)
1158 "This is a property list, with the following keys:
1160 :max-duration Mark clocking chunks that are longer than this time.
1161 This is a time string like \"HH:MM\", or the number
1162 of minutes as an integer.
1164 :min-duration Mark clocking chunks that are shorter that this.
1165 This is a time string like \"HH:MM\", or the number
1166 of minutes as an integer.
1168 :max-gap Mark gaps between clocking chunks that are longer than
1169 this duration. A number of minutes, or a string
1170 like \"HH:MM\".
1172 :gap-ok-around List of times during the day which are usually not working
1173 times. When a gap is detected, but the gap contains any
1174 of these times, the gap is *not* reported. For example,
1175 if this is (\"4:00\" \"13:00\") then gaps that contain
1176 4:00 in the morning (i.e. the night) and 13:00
1177 (i.e. a typical lunch time) do not cause a warning.
1178 You should have at least one time during the night in this
1179 list, or otherwise the first task each morning will trigger
1180 a warning because it follows a long gap.
1182 Furthermore, the following properties can be used to define faces for
1183 issue display.
1185 :default-face the default face, if the specific face is undefined
1186 :overlap-face face for overlapping clocks
1187 :gap-face face for gaps between clocks
1188 :no-end-time-face face for incomplete clocks
1189 :long-face face for clock intervals that are too long
1190 :short-face face for clock intervals that are too short"
1191 :group 'org-agenda-daily/weekly
1192 :group 'org-clock
1193 :version "24.1"
1194 :type 'plist)
1196 (defcustom org-agenda-log-mode-add-notes t
1197 "Non-nil means add first line of notes to log entries in agenda views.
1198 If a log item like a state change or a clock entry is associated with
1199 notes, the first line of these notes will be added to the entry in the
1200 agenda display."
1201 :group 'org-agenda-daily/weekly
1202 :type 'boolean)
1204 (defcustom org-agenda-start-with-log-mode nil
1205 "The initial value of log-mode in a newly created agenda window."
1206 :group 'org-agenda-startup
1207 :group 'org-agenda-daily/weekly
1208 :type 'boolean)
1210 (defcustom org-agenda-start-with-clockreport-mode nil
1211 "The initial value of clockreport-mode in a newly created agenda window."
1212 :group 'org-agenda-startup
1213 :group 'org-agenda-daily/weekly
1214 :type 'boolean)
1216 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1217 "Property list with parameters for the clocktable in clockreport mode.
1218 This is the display mode that shows a clock table in the daily/weekly
1219 agenda, the properties for this dynamic block can be set here.
1220 The usual clocktable parameters are allowed here, but you cannot set
1221 the properties :name, :tstart, :tend, :block, and :scope - these will
1222 be overwritten to make sure the content accurately reflects the
1223 current display in the agenda."
1224 :group 'org-agenda-daily/weekly
1225 :type 'plist)
1227 (defcustom org-agenda-search-view-always-boolean nil
1228 "Non-nil means the search string is interpreted as individual parts.
1230 The search string for search view can either be interpreted as a phrase,
1231 or as a list of snippets that define a boolean search for a number of
1232 strings.
1234 When this is non-nil, the string will be split on whitespace, and each
1235 snippet will be searched individually, and all must match in order to
1236 select an entry. A snippet is then a single string of non-white
1237 characters, or a string in double quotes, or a regexp in {} braces.
1238 If a snippet is preceded by \"-\", the snippet must *not* match.
1239 \"+\" is syntactic sugar for positive selection. Each snippet may
1240 be found as a full word or a partial word, but see the variable
1241 `org-agenda-search-view-force-full-words'.
1243 When this is nil, search will look for the entire search phrase as one,
1244 with each space character matching any amount of whitespace, including
1245 line breaks.
1247 Even when this is nil, you can still switch to Boolean search dynamically
1248 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1249 is a regexp marked with braces like \"{abc}\", this will also switch to
1250 boolean search."
1251 :group 'org-agenda-search-view
1252 :version "24.1"
1253 :type 'boolean)
1255 (if (fboundp 'defvaralias)
1256 (defvaralias 'org-agenda-search-view-search-words-only
1257 'org-agenda-search-view-always-boolean))
1259 (defcustom org-agenda-search-view-force-full-words nil
1260 "Non-nil means, search words must be matches as complete words.
1261 When nil, they may also match part of a word."
1262 :group 'org-agenda-search-view
1263 :version "24.1"
1264 :type 'boolean)
1266 (defgroup org-agenda-time-grid nil
1267 "Options concerning the time grid in the Org-mode Agenda."
1268 :tag "Org Agenda Time Grid"
1269 :group 'org-agenda)
1271 (defcustom org-agenda-search-headline-for-time t
1272 "Non-nil means search headline for a time-of-day.
1273 If the headline contains a time-of-day in one format or another, it will
1274 be used to sort the entry into the time sequence of items for a day.
1275 Some people have time stamps in the headline that refer to the creation
1276 time or so, and then this produces an unwanted side effect. If this is
1277 the case for your, use this variable to turn off searching the headline
1278 for a time."
1279 :group 'org-agenda-time-grid
1280 :type 'boolean)
1282 (defcustom org-agenda-use-time-grid t
1283 "Non-nil means show a time grid in the agenda schedule.
1284 A time grid is a set of lines for specific times (like every two hours between
1285 8:00 and 20:00). The items scheduled for a day at specific times are
1286 sorted in between these lines.
1287 For details about when the grid will be shown, and what it will look like, see
1288 the variable `org-agenda-time-grid'."
1289 :group 'org-agenda-time-grid
1290 :type 'boolean)
1292 (defcustom org-agenda-time-grid
1293 '((daily today require-timed)
1294 "----------------"
1295 (800 1000 1200 1400 1600 1800 2000))
1297 "The settings for time grid for agenda display.
1298 This is a list of three items. The first item is again a list. It contains
1299 symbols specifying conditions when the grid should be displayed:
1301 daily if the agenda shows a single day
1302 weekly if the agenda shows an entire week
1303 today show grid on current date, independent of daily/weekly display
1304 require-timed show grid only if at least one item has a time specification
1306 The second item is a string which will be placed behind the grid time.
1308 The third item is a list of integers, indicating the times that should have
1309 a grid line."
1310 :group 'org-agenda-time-grid
1311 :type
1312 '(list
1313 (set :greedy t :tag "Grid Display Options"
1314 (const :tag "Show grid in single day agenda display" daily)
1315 (const :tag "Show grid in weekly agenda display" weekly)
1316 (const :tag "Always show grid for today" today)
1317 (const :tag "Show grid only if any timed entries are present"
1318 require-timed)
1319 (const :tag "Skip grid times already present in an entry"
1320 remove-match))
1321 (string :tag "Grid String")
1322 (repeat :tag "Grid Times" (integer :tag "Time"))))
1324 (defcustom org-agenda-show-current-time-in-grid t
1325 "Non-nil means show the current time in the time grid."
1326 :group 'org-agenda-time-grid
1327 :version "24.1"
1328 :type 'boolean)
1330 (defcustom org-agenda-current-time-string
1331 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1332 "The string for the current time marker in the agenda."
1333 :group 'org-agenda-time-grid
1334 :version "24.1"
1335 :type 'string)
1337 (defgroup org-agenda-sorting nil
1338 "Options concerning sorting in the Org-mode Agenda."
1339 :tag "Org Agenda Sorting"
1340 :group 'org-agenda)
1342 (defcustom org-agenda-sorting-strategy
1343 '((agenda habit-down time-up priority-down category-keep)
1344 (todo priority-down category-keep)
1345 (tags priority-down category-keep)
1346 (search category-keep))
1347 "Sorting structure for the agenda items of a single day.
1348 This is a list of symbols which will be used in sequence to determine
1349 if an entry should be listed before another entry. The following
1350 symbols are recognized:
1352 time-up Put entries with time-of-day indications first, early first
1353 time-down Put entries with time-of-day indications first, late first
1354 category-keep Keep the default order of categories, corresponding to the
1355 sequence in `org-agenda-files'.
1356 category-up Sort alphabetically by category, A-Z.
1357 category-down Sort alphabetically by category, Z-A.
1358 tag-up Sort alphabetically by last tag, A-Z.
1359 tag-down Sort alphabetically by last tag, Z-A.
1360 priority-up Sort numerically by priority, high priority last.
1361 priority-down Sort numerically by priority, high priority first.
1362 todo-state-up Sort by todo state, tasks that are done last.
1363 todo-state-down Sort by todo state, tasks that are done first.
1364 effort-up Sort numerically by estimated effort, high effort last.
1365 effort-down Sort numerically by estimated effort, high effort first.
1366 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1367 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1368 habit-up Put entries that are habits first
1369 habit-down Put entries that are habits last
1370 alpha-up Sort headlines alphabetically
1371 alpha-down Sort headlines alphabetically, reversed
1373 The different possibilities will be tried in sequence, and testing stops
1374 if one comparison returns a \"not-equal\". For example, the default
1375 '(time-up category-keep priority-down)
1376 means: Pull out all entries having a specified time of day and sort them,
1377 in order to make a time schedule for the current day the first thing in the
1378 agenda listing for the day. Of the entries without a time indication, keep
1379 the grouped in categories, don't sort the categories, but keep them in
1380 the sequence given in `org-agenda-files'. Within each category sort by
1381 priority.
1383 Leaving out `category-keep' would mean that items will be sorted across
1384 categories by priority.
1386 Instead of a single list, this can also be a set of list for specific
1387 contents, with a context symbol in the car of the list, any of
1388 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1390 Custom commands can bind this variable in the options section."
1391 :group 'org-agenda-sorting
1392 :type `(choice
1393 (repeat :tag "General" ,org-sorting-choice)
1394 (list :tag "Individually"
1395 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1396 (repeat ,org-sorting-choice))
1397 (cons (const :tag "Strategy for TODO lists" todo)
1398 (repeat ,org-sorting-choice))
1399 (cons (const :tag "Strategy for Tags matches" tags)
1400 (repeat ,org-sorting-choice))
1401 (cons (const :tag "Strategy for search matches" search)
1402 (repeat ,org-sorting-choice)))))
1404 (defcustom org-agenda-cmp-user-defined nil
1405 "A function to define the comparison `user-defined'.
1406 This function must receive two arguments, agenda entry a and b.
1407 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1408 the user comparison, return nil.
1409 When this is defined, you can make `user-defined-up' and `user-defined-down'
1410 part of an agenda sorting strategy."
1411 :group 'org-agenda-sorting
1412 :type 'symbol)
1414 (defcustom org-sort-agenda-notime-is-late t
1415 "Non-nil means items without time are considered late.
1416 This is only relevant for sorting. When t, items which have no explicit
1417 time like 15:30 will be considered as 99:01, i.e. later than any items which
1418 do have a time. When nil, the default time is before 0:00. You can use this
1419 option to decide if the schedule for today should come before or after timeless
1420 agenda entries."
1421 :group 'org-agenda-sorting
1422 :type 'boolean)
1424 (defcustom org-sort-agenda-noeffort-is-high t
1425 "Non-nil means items without effort estimate are sorted as high effort.
1426 This also applies when filtering an agenda view with respect to the
1427 < or > effort operator. Then, tasks with no effort defined will be treated
1428 as tasks with high effort.
1429 When nil, such items are sorted as 0 minutes effort."
1430 :group 'org-agenda-sorting
1431 :type 'boolean)
1433 (defgroup org-agenda-line-format nil
1434 "Options concerning the entry prefix in the Org-mode agenda display."
1435 :tag "Org Agenda Line Format"
1436 :group 'org-agenda)
1438 (defcustom org-agenda-prefix-format
1439 '((agenda . " %i %-12:c%?-12t% s")
1440 (timeline . " % s")
1441 (todo . " %i %-12:c")
1442 (tags . " %i %-12:c")
1443 (search . " %i %-12:c"))
1444 "Format specifications for the prefix of items in the agenda views.
1445 An alist with five entries, each for the different agenda types. The
1446 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1447 The values are format strings.
1449 This format works similar to a printf format, with the following meaning:
1451 %c the category of the item, \"Diary\" for entries from the diary,
1452 or as given by the CATEGORY keyword or derived from the file name
1453 %e the effort required by the item
1454 %i the icon category of the item, see `org-agenda-category-icon-alist'
1455 %T the last tag of the item (ignore inherited tags, which come first)
1456 %t the HH:MM time-of-day specification if one applies to the entry
1457 %s Scheduling/Deadline information, a short string
1458 %(expression) Eval EXPRESSION and replace the control string
1459 by the result
1461 All specifiers work basically like the standard `%s' of printf, but may
1462 contain two additional characters: a question mark just after the `%'
1463 and a whitespace/punctuation character just before the final letter.
1465 If the first character after `%' is a question mark, the entire field
1466 will only be included if the corresponding value applies to the current
1467 entry. This is useful for fields which should have fixed width when
1468 present, but zero width when absent. For example, \"%?-12t\" will
1469 result in a 12 character time field if a time of the day is specified,
1470 but will completely disappear in entries which do not contain a time.
1472 If there is punctuation or whitespace character just before the final
1473 format letter, this character will be appended to the field value if
1474 the value is not empty. For example, the format \"%-12:c\" leads to
1475 \"Diary: \" if the category is \"Diary\". If the category were be
1476 empty, no additional colon would be inserted.
1478 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1479 which means:
1481 - Indent the line with two space characters
1482 - Give the category a 12 chars wide field, padded with whitespace on
1483 the right (because of `-'). Append a colon if there is a category
1484 (because of `:').
1485 - If there is a time-of-day, put it into a 12 chars wide field. If no
1486 time, don't put in an empty field, just skip it (because of '?').
1487 - Finally, put the scheduling information.
1489 See also the variables `org-agenda-remove-times-when-in-prefix' and
1490 `org-agenda-remove-tags'.
1492 Custom commands can set this variable in the options section."
1493 :type '(choice
1494 (string :tag "General format")
1495 (list :greedy t :tag "View dependent"
1496 (cons (const agenda) (string :tag "Format"))
1497 (cons (const timeline) (string :tag "Format"))
1498 (cons (const todo) (string :tag "Format"))
1499 (cons (const tags) (string :tag "Format"))
1500 (cons (const search) (string :tag "Format"))))
1501 :group 'org-agenda-line-format)
1503 (defvar org-prefix-format-compiled nil
1504 "The compiled prefix format and associated variables, as a list
1505 where first element is a list of variable bindings, and second
1506 element is the compiled format expression. See the variable
1507 `org-agenda-prefix-format'.")
1509 (defcustom org-agenda-todo-keyword-format "%-1s"
1510 "Format for the TODO keyword in agenda lines.
1511 Set this to something like \"%-12s\" if you want all TODO keywords
1512 to occupy a fixed space in the agenda display."
1513 :group 'org-agenda-line-format
1514 :type 'string)
1516 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1517 "Text preceding timerange entries in the agenda view.
1518 This is a list with two strings. The first applies when the range
1519 is entirely on one day. The second applies if the range spans several days.
1520 The strings may have two \"%d\" format specifiers which will be filled
1521 with the sequence number of the days, and the total number of days in the
1522 range, respectively."
1523 :group 'org-agenda-line-format
1524 :type '(list
1525 (string :tag "Deadline today ")
1526 (choice :tag "Deadline relative"
1527 (string :tag "Format string")
1528 (function))))
1530 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1531 "Text preceding scheduled items in the agenda view.
1532 This is a list with two strings. The first applies when the item is
1533 scheduled on the current day. The second applies when it has been scheduled
1534 previously, it may contain a %d indicating that this is the nth time that
1535 this item is scheduled, due to automatic rescheduling of unfinished items
1536 for the following day. So this number is one larger than the number of days
1537 that passed since this item was scheduled first."
1538 :group 'org-agenda-line-format
1539 :type '(list
1540 (string :tag "Scheduled today ")
1541 (string :tag "Scheduled previously")))
1543 (defcustom org-agenda-inactive-leader "["
1544 "Text preceding item pulled into the agenda by inactive time stamps.
1545 These entries are added to the agenda when pressing \"[\"."
1546 :group 'org-agenda-line-format
1547 :version "24.1"
1548 :type '(list
1549 (string :tag "Scheduled today ")
1550 (string :tag "Scheduled previously")))
1552 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
1553 "Text preceding deadline items in the agenda view.
1554 This is a list with two strings. The first applies when the item has its
1555 deadline on the current day. The second applies when it is in the past or
1556 in the future, it may contain %d to capture how many days away the deadline
1557 is (was)."
1558 :group 'org-agenda-line-format
1559 :type '(list
1560 (string :tag "Deadline today ")
1561 (choice :tag "Deadline relative"
1562 (string :tag "Format string")
1563 (function))))
1565 (defcustom org-agenda-remove-times-when-in-prefix t
1566 "Non-nil means remove duplicate time specifications in agenda items.
1567 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1568 time-of-day specification in a headline or diary entry is extracted and
1569 placed into the prefix. If this option is non-nil, the original specification
1570 \(a timestamp or -range, or just a plain time(range) specification like
1571 11:30-4pm) will be removed for agenda display. This makes the agenda less
1572 cluttered.
1573 The option can be t or nil. It may also be the symbol `beg', indicating
1574 that the time should only be removed when it is located at the beginning of
1575 the headline/diary entry."
1576 :group 'org-agenda-line-format
1577 :type '(choice
1578 (const :tag "Always" t)
1579 (const :tag "Never" nil)
1580 (const :tag "When at beginning of entry" beg)))
1582 (defcustom org-agenda-remove-timeranges-from-blocks nil
1583 "Non-nil means remove time ranges specifications in agenda
1584 items that span on several days."
1585 :group 'org-agenda-line-format
1586 :version "24.1"
1587 :type 'boolean)
1589 (defcustom org-agenda-default-appointment-duration nil
1590 "Default duration for appointments that only have a starting time.
1591 When nil, no duration is specified in such cases.
1592 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1593 :group 'org-agenda-line-format
1594 :type '(choice
1595 (integer :tag "Minutes")
1596 (const :tag "No default duration")))
1598 (defcustom org-agenda-show-inherited-tags t
1599 "Non-nil means show inherited tags in each agenda line."
1600 :group 'org-agenda-line-format
1601 :type 'boolean)
1603 (defcustom org-agenda-hide-tags-regexp nil
1604 "Regular expression used to filter away specific tags in agenda views.
1605 This means that these tags will be present, but not be shown in the agenda
1606 line. Secondary filtering will still work on the hidden tags.
1607 Nil means don't hide any tags."
1608 :group 'org-agenda-line-format
1609 :type '(choice
1610 (const :tag "Hide none" nil)
1611 (string :tag "Regexp ")))
1613 (defcustom org-agenda-remove-tags nil
1614 "Non-nil means remove the tags from the headline copy in the agenda.
1615 When this is the symbol `prefix', only remove tags when
1616 `org-agenda-prefix-format' contains a `%T' specifier."
1617 :group 'org-agenda-line-format
1618 :type '(choice
1619 (const :tag "Always" t)
1620 (const :tag "Never" nil)
1621 (const :tag "When prefix format contains %T" prefix)))
1623 (if (fboundp 'defvaralias)
1624 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1625 'org-agenda-remove-tags))
1627 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1628 "Shift tags in agenda items to this column.
1629 If this number is positive, it specifies the column. If it is negative,
1630 it means that the tags should be flushright to that column. For example,
1631 -80 works well for a normal 80 character screen."
1632 :group 'org-agenda-line-format
1633 :type 'integer)
1635 (if (fboundp 'defvaralias)
1636 (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1638 (defcustom org-agenda-fontify-priorities 'cookies
1639 "Non-nil means highlight low and high priorities in agenda.
1640 When t, the highest priority entries are bold, lowest priority italic.
1641 However, settings in `org-priority-faces' will overrule these faces.
1642 When this variable is the symbol `cookies', only fontify the
1643 cookies, not the entire task.
1644 This may also be an association list of priority faces, whose
1645 keys are the character values of `org-highest-priority',
1646 `org-default-priority', and `org-lowest-priority' (the default values
1647 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1648 color as a string, or a list like `(:background \"Red\")'.
1649 If it is a color, the variable `org-faces-easy-properties'
1650 determines if it is a foreground or a background color."
1651 :group 'org-agenda-line-format
1652 :type '(choice
1653 (const :tag "Never" nil)
1654 (const :tag "Defaults" t)
1655 (const :tag "Cookies only" cookies)
1656 (repeat :tag "Specify"
1657 (list (character :tag "Priority" :value ?A)
1658 (choice :tag "Face "
1659 (string :tag "Color")
1660 (sexp :tag "Face"))))))
1662 (defcustom org-agenda-day-face-function nil
1663 "Function called to determine what face should be used to display a day.
1664 The only argument passed to that function is the day. It should
1665 returns a face, or nil if does not want to specify a face and let
1666 the normal rules apply."
1667 :group 'org-agenda-line-format
1668 :version "24.1"
1669 :type 'function)
1671 (defcustom org-agenda-category-icon-alist nil
1672 "Alist of category icon to be displayed in agenda views.
1674 Each entry should have the following format:
1676 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1678 Where CATEGORY-REGEXP is a regexp matching the categories where
1679 the icon should be displayed.
1680 FILE-OR-DATA either a file path or a string containing image data.
1682 The other fields can be omitted safely if not needed:
1683 TYPE indicates the image type.
1684 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1685 image data.
1686 PROPS are additional image attributes to assign to the image,
1687 like, e.g. `:ascent center'.
1689 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1691 If you want to set the display properties yourself, just put a
1692 list as second element:
1694 (CATEGORY-REGEXP (MY PROPERTY LIST))
1696 For example, to display a 16px horizontal space for Emacs
1697 category, you can use:
1699 (\"Emacs\" '(space . (:width (16))))"
1700 :group 'org-agenda-line-format
1701 :version "24.1"
1702 :type '(alist :key-type (string :tag "Regexp matching category")
1703 :value-type (choice (list :tag "Icon"
1704 (string :tag "File or data")
1705 (symbol :tag "Type")
1706 (boolean :tag "Data?")
1707 (repeat :tag "Extra image properties" :inline t symbol))
1708 (list :tag "Display properties" sexp))))
1710 (defgroup org-agenda-column-view nil
1711 "Options concerning column view in the agenda."
1712 :tag "Org Agenda Column View"
1713 :group 'org-agenda)
1715 (defcustom org-agenda-columns-show-summaries t
1716 "Non-nil means show summaries for columns displayed in the agenda view."
1717 :group 'org-agenda-column-view
1718 :type 'boolean)
1720 (defcustom org-agenda-columns-compute-summary-properties t
1721 "Non-nil means recompute all summary properties before column view.
1722 When column view in the agenda is listing properties that have a summary
1723 operator, it can go to all relevant buffers and recompute the summaries
1724 there. This can mean overhead for the agenda column view, but is necessary
1725 to have thing up to date.
1726 As a special case, a CLOCKSUM property also makes sure that the clock
1727 computations are current."
1728 :group 'org-agenda-column-view
1729 :type 'boolean)
1731 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1732 "Non-nil means the duration of an appointment will add to day effort.
1733 The property to which appointment durations will be added is the one given
1734 in the option `org-effort-property'. If an appointment does not have
1735 an end time, `org-agenda-default-appointment-duration' will be used. If that
1736 is not set, an appointment without end time will not contribute to the time
1737 estimate."
1738 :group 'org-agenda-column-view
1739 :type 'boolean)
1741 (defcustom org-agenda-auto-exclude-function nil
1742 "A function called with a tag to decide if it is filtered on '/ RET'.
1743 The sole argument to the function, which is called once for each
1744 possible tag, is a string giving the name of the tag. The
1745 function should return either nil if the tag should be included
1746 as normal, or \"-<TAG>\" to exclude the tag.
1747 Note that for the purpose of tag filtering, only the lower-case version of
1748 all tags will be considered, so that this function will only ever see
1749 the lower-case version of all tags."
1750 :group 'org-agenda
1751 :type 'function)
1753 (defcustom org-agenda-bulk-custom-functions nil
1754 "Alist of characters and custom functions for bulk actions.
1755 For example, this value makes those two functions available:
1757 '((?R set-category)
1758 (?C bulk-cut))
1760 With selected entries in an agenda buffer, `B R' will call
1761 the custom function `set-category' on the selected entries.
1762 Note that functions in this alist don't need to be quoted."
1763 :type 'alist
1764 :version "24.1"
1765 :group 'org-agenda)
1767 (eval-when-compile
1768 (require 'cl))
1769 (require 'org)
1771 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1772 "Execute BODY with point at location given by `org-hd-marker' property.
1773 If STRING is non-nil, the text property will be fetched from position 0
1774 in that string. If STRING is nil, it will be fetched from the beginning
1775 of the current line."
1776 (org-with-gensyms (marker)
1777 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1778 'org-hd-marker ,string)))
1779 (with-current-buffer (marker-buffer ,marker)
1780 (save-excursion
1781 (goto-char ,marker)
1782 ,@body)))))
1783 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1785 (defun org-add-agenda-custom-command (entry)
1786 "Replace or add a command in `org-agenda-custom-commands'.
1787 This is mostly for hacking and trying a new command - once the command
1788 works you probably want to add it to `org-agenda-custom-commands' for good."
1789 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1790 (if ass
1791 (setcdr ass (cdr entry))
1792 (push entry org-agenda-custom-commands))))
1794 ;;; Define the org-agenda-mode
1796 (defvar org-agenda-mode-map (make-sparse-keymap)
1797 "Keymap for `org-agenda-mode'.")
1798 (if (fboundp 'defvaralias)
1799 (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1801 (defvar org-agenda-menu) ; defined later in this file.
1802 (defvar org-agenda-restrict) ; defined later in this file.
1803 (defvar org-agenda-follow-mode nil)
1804 (defvar org-agenda-entry-text-mode nil)
1805 (defvar org-agenda-clockreport-mode nil)
1806 (defvar org-agenda-show-log nil)
1807 (defvar org-agenda-redo-command nil)
1808 (defvar org-agenda-query-string nil)
1809 (defvar org-agenda-mode-hook nil
1810 "Hook for `org-agenda-mode', run after the mode is turned on.")
1811 (defvar org-agenda-type nil)
1812 (defvar org-agenda-force-single-file nil)
1813 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1816 ;;; Multiple agenda buffers support
1818 (defcustom org-agenda-sticky nil
1819 "Non-nil means agenda q key will bury agenda buffers, instead
1820 of killing it, and agenda commands show existing buffer instead
1821 of generating new one"
1822 :group 'org-agenda
1823 :type 'boolean)
1825 (defvar org-agenda-buffer nil
1826 "Agenda buffer currently being generated")
1828 (defun org-toggle-sticky-agenda (&optional arg)
1829 "Toggle `org-agenda-sticky'"
1830 (interactive)
1831 (setq org-agenda-sticky (or arg (not org-agenda-sticky)))
1832 (message "Sticky agenda was %s" (if org-agenda-sticky "enabled" "disabled")))
1834 (defvar org-agenda-last-prefix-arg nil)
1835 (defvar org-agenda-this-buffer-name nil)
1836 (defvar org-agenda-doing-sticky-redo nil)
1837 (defvar org-agenda-this-buffer-is-sticky nil)
1839 ;; below list is generating by grepping org-agenda.el for defvar
1840 (defconst org-agenda-local-vars
1841 '(;; calendar-mode-map
1842 org-agenda-this-buffer-name
1843 org-clock-current-task
1844 org-mobile-force-id-on-agenda-items
1845 org-habit-show-habits
1846 org-habit-show-habits-only-for-today
1847 org-agenda-this-buffer-name
1848 org-agenda-overriding-header
1849 org-agenda-title-append
1850 org-agenda-undo-list
1851 org-agenda-pending-undo-list
1852 org-agenda-archives-mode
1853 org-agenda-entry-text-cleanup-hook
1854 org-agenda-include-inactive-timestamps
1855 org-prefix-format-compiled
1856 org-agenda-mode-map
1857 org-agenda-menu
1858 org-agenda-restrict
1859 org-agenda-follow-mode
1860 org-agenda-entry-text-mode
1861 org-agenda-clockreport-mode
1862 org-agenda-show-log
1863 org-agenda-redo-command
1864 org-agenda-query-string
1865 org-agenda-mode-hook
1866 org-agenda-type
1867 org-agenda-force-single-file
1868 org-agenda-bulk-marked-entries
1869 org-agenda-allow-remote-undo
1870 org-agenda-undo-list
1871 org-agenda-undo-has-started-in
1872 org-agenda-pending-undo-list
1873 org-agenda-restrict
1874 org-agenda-restrict-begin
1875 org-agenda-restrict-end
1876 org-agenda-last-dispatch-buffer
1877 ;; org-agenda-overriding-restriction
1878 ;; org-agenda-overriding-arguments
1879 org-agenda-last-arguments
1880 org-agenda-info
1881 org-mobile-creating-agendas
1882 org-agenda-tag-filter-overlays
1883 org-agenda-cat-filter-overlays
1884 org-agenda-marker-table
1885 org-pre-agenda-window-conf
1886 org-agenda-columns-active
1887 org-agenda-name
1888 org-agenda-tag-filter
1889 org-agenda-category-filter
1890 org-agenda-tag-filter-while-redo
1891 org-agenda-tag-filter-preset
1892 org-agenda-category-filter-preset
1893 org-agenda-skip-function
1894 org-agenda-markers
1895 org-agenda-last-marker-time
1896 org-agenda-only-exact-dates
1897 org-agenda-start-day
1898 org-starting-day
1899 org-agenda-current-span
1900 org-arg-loc
1901 org-agenda-entry-types
1902 org-agenda-search-history
1903 org-todo-only
1904 org-search-syntax-table
1905 org-agenda-last-search-view-search-was-boolean
1906 org-last-arg
1907 org-agenda-skip-regexp
1908 org-agenda-overriding-header
1909 org-disable-agenda-to-diary
1910 diary-list-entries-hook
1911 diary-time-regexp
1912 org-agenda-cleanup-fancy-diary-hook
1913 org-diary-last-run-time
1914 org-heading-keyword-regexp-format
1915 org-agenda-sorting-strategy
1916 org-agenda-sorting-strategy-selected
1917 org-agenda-before-sorting-filter-function
1918 org-agenda-restriction-lock-overlay
1919 org-global-tags-completion-table
1920 org-agenda-filtered-by-category
1921 org-agenda-filter-form
1922 org-hl
1923 org-agenda-after-show-hook
1924 org-archive-default-command
1925 org-agenda-show-window
1926 org-agenda-cycle-counter
1927 org-last-heading-marker
1928 ;; calendar-longitude
1929 ;; calendar-latitude
1930 ;; calendar-location-name
1931 org-agenda-bulk-marked-entries
1932 appt-time-msg-list
1933 org-agenda-last-prefix-arg))
1936 (defun org-agenda-mode ()
1937 "Mode for time-sorted view on action items in Org-mode files.
1939 The following commands are available:
1941 \\{org-agenda-mode-map}"
1942 (interactive)
1943 (kill-all-local-variables)
1944 (let ((sticky-p (or org-agenda-sticky
1945 org-agenda-doing-sticky-redo)))
1946 (when sticky-p
1947 (mapc 'make-local-variable org-agenda-local-vars))
1948 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) sticky-p))
1949 (setq org-agenda-undo-list nil
1950 org-agenda-pending-undo-list nil
1951 org-agenda-bulk-marked-entries nil)
1952 (setq major-mode 'org-agenda-mode)
1953 ;; Keep global-font-lock-mode from turning on font-lock-mode
1954 (org-set-local 'font-lock-global-modes (list 'not major-mode))
1955 (setq mode-name "Org-Agenda")
1956 (use-local-map org-agenda-mode-map)
1957 (easy-menu-add org-agenda-menu)
1958 (if org-startup-truncated (setq truncate-lines t))
1959 (org-set-local 'line-move-visual nil)
1960 (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1961 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1962 ;; Make sure properties are removed when copying text
1963 (when (boundp 'buffer-substring-filters)
1964 (org-set-local 'buffer-substring-filters
1965 (cons (lambda (x)
1966 (set-text-properties 0 (length x) nil x) x)
1967 buffer-substring-filters)))
1968 (unless org-agenda-keep-modes
1969 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1970 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1971 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1972 org-agenda-show-log org-agenda-start-with-log-mode))
1974 (easy-menu-change
1975 '("Agenda") "Agenda Files"
1976 (append
1977 (list
1978 (vector
1979 (if (get 'org-agenda-files 'org-restrict)
1980 "Restricted to single file"
1981 "Edit File List")
1982 '(org-edit-agenda-file-list)
1983 (not (get 'org-agenda-files 'org-restrict)))
1984 "--")
1985 (mapcar 'org-file-menu-entry (org-agenda-files))))
1986 (org-agenda-set-mode-name)
1987 (apply
1988 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1989 (list 'org-agenda-mode-hook)))
1991 (substitute-key-definition 'undo 'org-agenda-undo
1992 org-agenda-mode-map global-map)
1993 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
1994 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
1995 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
1996 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
1997 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
1998 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
1999 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2000 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2001 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-remove-all-marks)
2002 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2003 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2004 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2005 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2006 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2007 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2008 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2009 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2010 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2011 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2012 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2013 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2014 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2015 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2016 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2017 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2018 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2019 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2020 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2021 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2022 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2023 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2024 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2025 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2026 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2027 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2028 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2029 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2030 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2031 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2032 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
2033 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
2034 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2035 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2036 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2037 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2039 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2040 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2041 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2042 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2043 (while l (org-defkey org-agenda-mode-map
2044 (int-to-string (pop l)) 'digit-argument)))
2046 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2047 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2048 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2049 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2050 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2051 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2052 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2053 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2054 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2055 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
2056 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2057 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2058 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2059 'org-clock-modify-effort-estimate)
2060 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2061 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2062 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2063 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2064 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2065 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2066 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2067 (org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
2068 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2069 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2070 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2071 (substitute-key-definition 'next-line 'org-agenda-next-line
2072 org-agenda-mode-map global-map)
2073 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2074 org-agenda-mode-map global-map)
2075 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2076 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2077 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2078 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2079 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2080 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2081 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2082 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2083 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2084 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2085 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2086 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2087 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2088 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2089 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2090 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2091 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2092 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2093 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2094 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2095 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2096 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2097 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2098 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2099 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2100 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2101 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2102 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2103 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2104 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2106 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2107 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2108 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2109 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2110 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2111 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2112 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2113 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2114 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2115 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2116 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2118 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2119 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2120 (when org-agenda-mouse-1-follows-link
2121 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2122 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2123 '("Agenda"
2124 ("Agenda Files")
2125 "--"
2126 ("Agenda Dates"
2127 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2128 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2129 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2130 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2131 "--"
2132 ("View"
2133 ["Day View" org-agenda-day-view
2134 :active (org-agenda-check-type nil 'agenda)
2135 :style radio :selected (eq org-agenda-current-span 'day)
2136 :keys "v d (or just d)"]
2137 ["Week View" org-agenda-week-view
2138 :active (org-agenda-check-type nil 'agenda)
2139 :style radio :selected (eq org-agenda-current-span 'week)
2140 :keys "v w (or just w)"]
2141 ["Month View" org-agenda-month-view
2142 :active (org-agenda-check-type nil 'agenda)
2143 :style radio :selected (eq org-agenda-current-span 'month)
2144 :keys "v m"]
2145 ["Year View" org-agenda-year-view
2146 :active (org-agenda-check-type nil 'agenda)
2147 :style radio :selected (eq org-agenda-current-span 'year)
2148 :keys "v y"]
2149 "--"
2150 ["Include Diary" org-agenda-toggle-diary
2151 :style toggle :selected org-agenda-include-diary
2152 :active (org-agenda-check-type nil 'agenda)]
2153 ["Include Deadlines" org-agenda-toggle-deadlines
2154 :style toggle :selected org-agenda-include-deadlines
2155 :active (org-agenda-check-type nil 'agenda)]
2156 ["Use Time Grid" org-agenda-toggle-time-grid
2157 :style toggle :selected org-agenda-use-time-grid
2158 :active (org-agenda-check-type nil 'agenda)]
2159 "--"
2160 ["Show clock report" org-agenda-clockreport-mode
2161 :style toggle :selected org-agenda-clockreport-mode
2162 :active (org-agenda-check-type nil 'agenda)]
2163 ["Show some entry text" org-agenda-entry-text-mode
2164 :style toggle :selected org-agenda-entry-text-mode
2165 :active t]
2166 "--"
2167 ["Show Logbook entries" org-agenda-log-mode
2168 :style toggle :selected org-agenda-show-log
2169 :active (org-agenda-check-type nil 'agenda 'timeline)
2170 :keys "v l (or just l)"]
2171 ["Include archived trees" org-agenda-archives-mode
2172 :style toggle :selected org-agenda-archives-mode :active t
2173 :keys "v a"]
2174 ["Include archive files" (org-agenda-archives-mode t)
2175 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2176 :keys "v A"]
2177 "--"
2178 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2179 ["Write view to file" org-agenda-write t]
2180 ["Rebuild buffer" org-agenda-redo t]
2181 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2182 "--"
2183 ["Show original entry" org-agenda-show t]
2184 ["Go To (other window)" org-agenda-goto t]
2185 ["Go To (this window)" org-agenda-switch-to t]
2186 ["Follow Mode" org-agenda-follow-mode
2187 :style toggle :selected org-agenda-follow-mode :active t]
2188 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2189 "--"
2190 ("TODO"
2191 ["Cycle TODO" org-agenda-todo t]
2192 ["Next TODO set" org-agenda-todo-nextset t]
2193 ["Previous TODO set" org-agenda-todo-previousset t]
2194 ["Add note" org-agenda-add-note t])
2195 ("Archive/Refile/Delete"
2196 ["Archive default" org-agenda-archive-default t]
2197 ["Archive default" org-agenda-archive-default-with-confirmation t]
2198 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2199 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2200 ["Archive subtree" org-agenda-archive t]
2201 "--"
2202 ["Refile" org-agenda-refile t]
2203 "--"
2204 ["Delete subtree" org-agenda-kill t])
2205 ("Bulk action"
2206 ["Mark entry" org-agenda-bulk-mark t]
2207 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2208 ["Unmark entry" org-agenda-bulk-unmark t]
2209 ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
2210 ["Act on all marked" org-agenda-bulk-action t]
2211 "--"
2212 ("Tags and Properties"
2213 ["Show all Tags" org-agenda-show-tags t]
2214 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2215 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2216 "--"
2217 ["Column View" org-columns t])
2218 ("Deadline/Schedule"
2219 ["Schedule" org-agenda-schedule t]
2220 ["Set Deadline" org-agenda-deadline t]
2221 "--"
2222 ["Mark item" org-agenda-action :active t :keys "k m"]
2223 ["Show mark item" org-agenda-action :active t :keys "k v"]
2224 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2225 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2226 "--"
2227 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2228 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2229 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2230 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2231 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2232 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2233 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2234 ("Clock and Effort"
2235 ["Clock in" org-agenda-clock-in t]
2236 ["Clock out" org-agenda-clock-out t]
2237 ["Clock cancel" org-agenda-clock-cancel t]
2238 ["Goto running clock" org-clock-goto t]
2239 "--"
2240 ["Set Effort" org-agenda-set-effort t]
2241 ["Change clocked effort" org-clock-modify-effort-estimate
2242 (org-clock-is-active)])
2243 ("Priority"
2244 ["Set Priority" org-agenda-priority t]
2245 ["Increase Priority" org-agenda-priority-up t]
2246 ["Decrease Priority" org-agenda-priority-down t]
2247 ["Show Priority" org-agenda-show-priority t])
2248 ("Calendar/Diary"
2249 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2250 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2251 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2252 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2253 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2254 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2255 "--"
2256 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2257 "--"
2258 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2259 "--"
2260 ("MobileOrg"
2261 ["Push Files and Views" org-mobile-push t]
2262 ["Get Captured and Flagged" org-mobile-pull t]
2263 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2264 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2265 "--"
2266 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2267 "--"
2268 ["Quit" org-agenda-quit t]
2269 ["Exit and Release Buffers" org-agenda-exit t]
2272 ;;; Agenda undo
2274 (defvar org-agenda-allow-remote-undo t
2275 "Non-nil means allow remote undo from the agenda buffer.")
2276 (defvar org-agenda-undo-list nil
2277 "List of undoable operations in the agenda since last refresh.")
2278 (defvar org-agenda-undo-has-started-in nil
2279 "Buffers that have already seen `undo-start' in the current undo sequence.")
2280 (defvar org-agenda-pending-undo-list nil
2281 "In a series of undo commands, this is the list of remaining undo items.")
2283 (defun org-agenda-undo ()
2284 "Undo a remote editing step in the agenda.
2285 This undoes changes both in the agenda buffer and in the remote buffer
2286 that have been changed along."
2287 (interactive)
2288 (or org-agenda-allow-remote-undo
2289 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2290 (if (not (eq this-command last-command))
2291 (setq org-agenda-undo-has-started-in nil
2292 org-agenda-pending-undo-list org-agenda-undo-list))
2293 (if (not org-agenda-pending-undo-list)
2294 (error "No further undo information"))
2295 (let* ((entry (pop org-agenda-pending-undo-list))
2296 buf line cmd rembuf)
2297 (setq cmd (pop entry) line (pop entry))
2298 (setq rembuf (nth 2 entry))
2299 (org-with-remote-undo rembuf
2300 (while (bufferp (setq buf (pop entry)))
2301 (if (pop entry)
2302 (with-current-buffer buf
2303 (let ((last-undo-buffer buf)
2304 (inhibit-read-only t))
2305 (unless (memq buf org-agenda-undo-has-started-in)
2306 (push buf org-agenda-undo-has-started-in)
2307 (make-local-variable 'pending-undo-list)
2308 (undo-start))
2309 (while (and pending-undo-list
2310 (listp pending-undo-list)
2311 (not (car pending-undo-list)))
2312 (pop pending-undo-list))
2313 (undo-more 1))))))
2314 (org-goto-line line)
2315 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2317 (defun org-verify-change-for-undo (l1 l2)
2318 "Verify that a real change occurred between the undo lists L1 and L2."
2319 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2320 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2321 (not (eq l1 l2)))
2323 ;;; Agenda dispatch
2325 (defvar org-agenda-restrict nil)
2326 (defvar org-agenda-restrict-begin (make-marker))
2327 (defvar org-agenda-restrict-end (make-marker))
2328 (defvar org-agenda-last-dispatch-buffer nil)
2329 (defvar org-agenda-overriding-restriction nil)
2331 ;;;###autoload
2332 (defun org-agenda (&optional arg keys restriction)
2333 "Dispatch agenda commands to collect entries to the agenda buffer.
2334 Prompts for a command to execute. Any prefix arg will be passed
2335 on to the selected command. The default selections are:
2337 a Call `org-agenda-list' to display the agenda for current day or week.
2338 t Call `org-todo-list' to display the global todo list.
2339 T Call `org-todo-list' to display the global todo list, select only
2340 entries with a specific TODO keyword (the user gets a prompt).
2341 m Call `org-tags-view' to display headlines with tags matching
2342 a condition (the user is prompted for the condition).
2343 M Like `m', but select only TODO entries, no ordinary headlines.
2344 L Create a timeline for the current buffer.
2345 e Export views to associated files.
2346 s Search entries for keywords.
2347 / Multi occur across all agenda files and also files listed
2348 in `org-agenda-text-search-extra-files'.
2349 < Restrict agenda commands to buffer, subtree, or region.
2350 Press several times to get the desired effect.
2351 > Remove a previous restriction.
2352 # List \"stuck\" projects.
2353 ! Configure what \"stuck\" means.
2354 C Configure custom agenda commands.
2356 More commands can be added by configuring the variable
2357 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2358 searches can be pre-defined in this way.
2360 If the current buffer is in Org-mode and visiting a file, you can also
2361 first press `<' once to indicate that the agenda should be temporarily
2362 \(until the next use of \\[org-agenda]) restricted to the current file.
2363 Pressing `<' twice means to restrict to the current subtree or region
2364 \(if active)."
2365 (interactive "P")
2366 (catch 'exit
2367 (let* ((prefix-descriptions nil)
2368 (org-agenda-window-setup (if (equal (buffer-name)
2369 org-agenda-buffer-name)
2370 'current-window
2371 org-agenda-window-setup))
2372 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2373 (org-agenda-custom-commands
2374 ;; normalize different versions
2375 (delq nil
2376 (mapcar
2377 (lambda (x)
2378 (cond ((stringp (cdr x))
2379 (push x prefix-descriptions)
2380 nil)
2381 ((stringp (nth 1 x)) x)
2382 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2383 (t (cons (car x) (cons "" (cdr x))))))
2384 org-agenda-custom-commands)))
2385 (buf (current-buffer))
2386 (bfn (buffer-file-name (buffer-base-buffer)))
2387 entry key type match lprops ans)
2388 ;; Turn off restriction unless there is an overriding one,
2389 (unless org-agenda-overriding-restriction
2390 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2391 ;; There is a request to keep the file list in place
2392 (put 'org-agenda-files 'org-restrict nil))
2393 (setq org-agenda-restrict nil)
2394 (move-marker org-agenda-restrict-begin nil)
2395 (move-marker org-agenda-restrict-end nil))
2396 ;; Delete old local properties
2397 (put 'org-agenda-redo-command 'org-lprops nil)
2398 ;; Delete previously set last-arguments
2399 (put 'org-agenda-redo-command 'last-args nil)
2400 ;; Remember where this call originated
2401 (setq org-agenda-last-dispatch-buffer (current-buffer))
2402 (unless keys
2403 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2404 keys (car ans)
2405 restriction (cdr ans)))
2406 ;; Establish the restriction, if any
2407 (when (and (not org-agenda-overriding-restriction) restriction)
2408 (put 'org-agenda-files 'org-restrict (list bfn))
2409 (cond
2410 ((eq restriction 'region)
2411 (setq org-agenda-restrict t)
2412 (move-marker org-agenda-restrict-begin (region-beginning))
2413 (move-marker org-agenda-restrict-end (region-end)))
2414 ((eq restriction 'subtree)
2415 (save-excursion
2416 (setq org-agenda-restrict t)
2417 (org-back-to-heading t)
2418 (move-marker org-agenda-restrict-begin (point))
2419 (move-marker org-agenda-restrict-end
2420 (progn (org-end-of-subtree t)))))))
2422 ;; For example the todo list should not need it (but does...)
2423 (cond
2424 ((setq entry (assoc keys org-agenda-custom-commands))
2425 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2426 (progn
2427 (setq type (nth 2 entry) match (eval (nth 3 entry))
2428 lprops (nth 4 entry))
2429 (put 'org-agenda-redo-command 'org-lprops lprops)
2430 (cond
2431 ((eq type 'agenda)
2432 (org-let lprops '(org-agenda-list current-prefix-arg)))
2433 ((eq type 'alltodo)
2434 (org-let lprops '(org-todo-list current-prefix-arg)))
2435 ((eq type 'search)
2436 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2437 ((eq type 'stuck)
2438 (org-let lprops '(org-agenda-list-stuck-projects
2439 current-prefix-arg)))
2440 ((eq type 'tags)
2441 (org-let lprops '(org-tags-view current-prefix-arg match)))
2442 ((eq type 'tags-todo)
2443 (org-let lprops '(org-tags-view '(4) match)))
2444 ((eq type 'todo)
2445 (org-let lprops '(org-todo-list match)))
2446 ((eq type 'tags-tree)
2447 (org-check-for-org-mode)
2448 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2449 ((eq type 'todo-tree)
2450 (org-check-for-org-mode)
2451 (org-let lprops
2452 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2453 (regexp-quote match) "\\>"))))
2454 ((eq type 'occur-tree)
2455 (org-check-for-org-mode)
2456 (org-let lprops '(org-occur match)))
2457 ((functionp type)
2458 (org-let lprops '(funcall type match)))
2459 ((fboundp type)
2460 (org-let lprops '(funcall type match)))
2461 (t (error "Invalid custom agenda command type %s" type))))
2462 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2463 ((equal keys "C")
2464 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2465 (customize-variable 'org-agenda-custom-commands))
2466 ((equal keys "a") (call-interactively 'org-agenda-list))
2467 ((equal keys "s") (call-interactively 'org-search-view))
2468 ((equal keys "t") (call-interactively 'org-todo-list))
2469 ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2470 ((equal keys "m") (call-interactively 'org-tags-view))
2471 ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2472 ((equal keys "e") (call-interactively 'org-store-agenda-views))
2473 ((equal keys "?") (org-tags-view nil "+FLAGGED")
2474 (org-add-hook
2475 'post-command-hook
2476 (lambda ()
2477 (unless (current-message)
2478 (let* ((m (org-agenda-get-any-marker))
2479 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2480 (when note
2481 (message (concat
2482 "FLAGGING-NOTE ([?] for more info): "
2483 (org-add-props
2484 (replace-regexp-in-string
2485 "\\\\n" "//"
2486 (copy-sequence note))
2487 nil 'face 'org-warning)))))))
2488 t t))
2489 ((equal keys "L")
2490 (unless (eq major-mode 'org-mode)
2491 (error "This is not an Org-mode file"))
2492 (unless restriction
2493 (put 'org-agenda-files 'org-restrict (list bfn))
2494 (org-call-with-arg 'org-timeline arg)))
2495 ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2496 ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2497 ((equal keys "!") (customize-variable 'org-stuck-projects))
2498 (t (error "Invalid agenda key"))))))
2500 (defun org-agenda-append-agenda ()
2501 "Append another agenda view to the current one.
2502 This function allows interactive building of block agendas.
2503 Agenda views are separated by `org-agenda-block-separator'."
2504 (interactive)
2505 (unless (string= (buffer-name) org-agenda-buffer-name)
2506 (error "Can only append from within agenda buffer"))
2507 (let ((org-agenda-multi t))
2508 (org-agenda)
2509 (widen)))
2511 (defun org-agenda-normalize-custom-commands (cmds)
2512 (delq nil
2513 (mapcar
2514 (lambda (x)
2515 (cond ((stringp (cdr x)) nil)
2516 ((stringp (nth 1 x)) x)
2517 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2518 (t (cons (car x) (cons "" (cdr x))))))
2519 cmds)))
2521 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2522 "The user interface for selecting an agenda command."
2523 (catch 'exit
2524 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2525 (restrict-ok (and bfn (eq major-mode 'org-mode)))
2526 (region-p (org-region-active-p))
2527 (custom org-agenda-custom-commands)
2528 (selstring "")
2529 restriction second-time
2530 c entry key type match prefixes rmheader header-end custom1 desc
2531 line lines left right n n1)
2532 (save-window-excursion
2533 (delete-other-windows)
2534 (org-switch-to-buffer-other-window " *Agenda Commands*")
2535 (erase-buffer)
2536 (insert (eval-when-compile
2537 (let ((header
2539 Press key for an agenda command: < Buffer, subtree/region restriction
2540 -------------------------------- > Remove restriction
2541 a Agenda for current week or day e Export agenda views
2542 t List of all TODO entries T Entries with special TODO kwd
2543 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2544 L Timeline for current buffer # List stuck projects (!=configure)
2545 s Search for keywords C Configure custom agenda commands
2546 / Multi-occur ? Find :FLAGGED: entries
2548 (start 0))
2549 (while (string-match
2550 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2551 header start)
2552 (setq start (match-end 0))
2553 (add-text-properties (match-beginning 2) (match-end 2)
2554 '(face bold) header))
2555 header)))
2556 (setq header-end (move-marker (make-marker) (point)))
2557 (while t
2558 (setq custom1 custom)
2559 (when (eq rmheader t)
2560 (org-goto-line 1)
2561 (re-search-forward ":" nil t)
2562 (delete-region (match-end 0) (point-at-eol))
2563 (forward-char 1)
2564 (looking-at "-+")
2565 (delete-region (match-end 0) (point-at-eol))
2566 (move-marker header-end (match-end 0)))
2567 (goto-char header-end)
2568 (delete-region (point) (point-max))
2570 ;; Produce all the lines that describe custom commands and prefixes
2571 (setq lines nil)
2572 (while (setq entry (pop custom1))
2573 (setq key (car entry) desc (nth 1 entry)
2574 type (nth 2 entry)
2575 match (nth 3 entry))
2576 (if (> (length key) 1)
2577 (add-to-list 'prefixes (string-to-char key))
2578 (setq line
2579 (format
2580 "%-4s%-14s"
2581 (org-add-props (copy-sequence key)
2582 '(face bold))
2583 (cond
2584 ((string-match "\\S-" desc) desc)
2585 ((eq type 'agenda) "Agenda for current week or day")
2586 ((eq type 'alltodo) "List of all TODO entries")
2587 ((eq type 'search) "Word search")
2588 ((eq type 'stuck) "List of stuck projects")
2589 ((eq type 'todo) "TODO keyword")
2590 ((eq type 'tags) "Tags query")
2591 ((eq type 'tags-todo) "Tags (TODO)")
2592 ((eq type 'tags-tree) "Tags tree")
2593 ((eq type 'todo-tree) "TODO kwd tree")
2594 ((eq type 'occur-tree) "Occur tree")
2595 ((functionp type) (if (symbolp type)
2596 (symbol-name type)
2597 "Lambda expression"))
2598 (t "???"))))
2599 (if org-agenda-menu-show-matcher
2600 (setq line
2601 (concat line ": "
2602 (cond
2603 ((stringp match)
2604 (setq match (copy-sequence match))
2605 (org-add-props match nil 'face 'org-warning))
2606 (match
2607 (format "set of %d commands" (length match)))
2608 (t ""))))
2609 (if (org-string-nw-p match)
2610 (add-text-properties
2611 0 (length line) (list 'help-echo
2612 (concat "Matcher: "match)) line)))
2613 (push line lines)))
2614 (setq lines (nreverse lines))
2615 (when prefixes
2616 (mapc (lambda (x)
2617 (push
2618 (format "%s %s"
2619 (org-add-props (char-to-string x)
2620 nil 'face 'bold)
2621 (or (cdr (assoc (concat selstring
2622 (char-to-string x))
2623 prefix-descriptions))
2624 "Prefix key"))
2625 lines))
2626 prefixes))
2628 ;; Check if we should display in two columns
2629 (if org-agenda-menu-two-column
2630 (progn
2631 (setq n (length lines)
2632 n1 (+ (/ n 2) (mod n 2))
2633 right (nthcdr n1 lines)
2634 left (copy-sequence lines))
2635 (setcdr (nthcdr (1- n1) left) nil))
2636 (setq left lines right nil))
2637 (while left
2638 (insert "\n" (pop left))
2639 (when right
2640 (if (< (current-column) 40)
2641 (move-to-column 40 t)
2642 (insert " "))
2643 (insert (pop right))))
2645 ;; Make the window the right size
2646 (goto-char (point-min))
2647 (if second-time
2648 (if (not (pos-visible-in-window-p (point-max)))
2649 (org-fit-window-to-buffer))
2650 (setq second-time t)
2651 (org-fit-window-to-buffer))
2653 ;; Ask for selection
2654 (message "Press key for agenda command%s:"
2655 (if (or restrict-ok org-agenda-overriding-restriction)
2656 (if org-agenda-overriding-restriction
2657 " (restriction lock active)"
2658 (if restriction
2659 (format " (restricted to %s)" restriction)
2660 " (unrestricted)"))
2661 ""))
2662 (setq c (read-char-exclusive))
2663 (message "")
2664 (cond
2665 ((assoc (char-to-string c) custom)
2666 (setq selstring (concat selstring (char-to-string c)))
2667 (throw 'exit (cons selstring restriction)))
2668 ((memq c prefixes)
2669 (setq selstring (concat selstring (char-to-string c))
2670 prefixes nil
2671 rmheader (or rmheader t)
2672 custom (delq nil (mapcar
2673 (lambda (x)
2674 (if (or (= (length (car x)) 1)
2675 (/= (string-to-char (car x)) c))
2677 (cons (substring (car x) 1) (cdr x))))
2678 custom))))
2679 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2680 (message "Restriction is only possible in Org-mode buffers")
2681 (ding) (sit-for 1))
2682 ((eq c ?1)
2683 (org-agenda-remove-restriction-lock 'noupdate)
2684 (setq restriction 'buffer))
2685 ((eq c ?0)
2686 (org-agenda-remove-restriction-lock 'noupdate)
2687 (setq restriction (if region-p 'region 'subtree)))
2688 ((eq c ?<)
2689 (org-agenda-remove-restriction-lock 'noupdate)
2690 (setq restriction
2691 (cond
2692 ((eq restriction 'buffer)
2693 (if region-p 'region 'subtree))
2694 ((memq restriction '(subtree region))
2695 nil)
2696 (t 'buffer))))
2697 ((eq c ?>)
2698 (org-agenda-remove-restriction-lock 'noupdate)
2699 (setq restriction nil))
2700 ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2701 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2702 ((and (> (length selstring) 0) (eq c ?\d))
2703 (delete-window)
2704 (org-agenda-get-restriction-and-command prefix-descriptions))
2706 ((equal c ?q) (error "Abort"))
2707 (t (error "Invalid key %c" c))))))))
2709 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2710 (defvar org-agenda-last-arguments nil
2711 "The arguments of the previous call to `org-agenda'.")
2712 (defun org-agenda-run-series (name series)
2713 (org-let (nth 1 series) '(org-prepare-agenda name))
2714 (let* ((org-agenda-multi t)
2715 (redo (list 'org-agenda-run-series name (list 'quote series)))
2716 (org-agenda-overriding-arguments
2717 (or org-agenda-overriding-arguments
2718 (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2719 (get 'org-agenda-redo-command 'last-args))))
2720 (cmds (car series))
2721 (gprops (nth 1 series))
2722 match ;; The byte compiler incorrectly complains about this. Keep it!
2723 cmd type lprops)
2724 (while (setq cmd (pop cmds))
2725 (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2726 (cond
2727 ((eq type 'agenda)
2728 (org-let2 gprops lprops
2729 '(call-interactively 'org-agenda-list)))
2730 ((eq type 'alltodo)
2731 (org-let2 gprops lprops
2732 '(call-interactively 'org-todo-list)))
2733 ((eq type 'search)
2734 (org-let2 gprops lprops
2735 '(org-search-view current-prefix-arg match nil)))
2736 ((eq type 'stuck)
2737 (org-let2 gprops lprops
2738 '(call-interactively 'org-agenda-list-stuck-projects)))
2739 ((eq type 'tags)
2740 (org-let2 gprops lprops
2741 '(org-tags-view current-prefix-arg match)))
2742 ((eq type 'tags-todo)
2743 (org-let2 gprops lprops
2744 '(org-tags-view '(4) match)))
2745 ((eq type 'todo)
2746 (org-let2 gprops lprops
2747 '(org-todo-list match)))
2748 ((fboundp type)
2749 (org-let2 gprops lprops
2750 '(funcall type match)))
2751 (t (error "Invalid type in command series"))))
2752 (widen)
2753 (setq org-agenda-redo-command redo)
2754 (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2755 (goto-char (point-min)))
2756 (org-fit-agenda-window)
2757 (org-let (nth 1 series) '(org-finalize-agenda)))
2759 ;;;###autoload
2760 (defmacro org-batch-agenda (cmd-key &rest parameters)
2761 "Run an agenda command in batch mode and send the result to STDOUT.
2762 If CMD-KEY is a string of length 1, it is used as a key in
2763 `org-agenda-custom-commands' and triggers this command. If it is a
2764 longer string it is used as a tags/todo match string.
2765 Parameters are alternating variable names and values that will be bound
2766 before running the agenda command."
2767 (org-eval-in-environment (org-make-parameter-alist parameters)
2768 (if (> (length cmd-key) 2)
2769 (org-tags-view nil cmd-key)
2770 (org-agenda nil cmd-key)))
2771 (set-buffer org-agenda-buffer-name)
2772 (princ (buffer-string)))
2773 (def-edebug-spec org-batch-agenda (form &rest sexp))
2775 (defvar org-agenda-info nil)
2777 ;;;###autoload
2778 (defmacro org-batch-agenda-csv (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.
2786 The output gives a line for each selected agenda item. Each
2787 item is a list of comma-separated values, like this:
2789 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2791 category The category of the item
2792 head The headline, without TODO kwd, TAGS and PRIORITY
2793 type The type of the agenda entry, can be
2794 todo selected in TODO match
2795 tagsmatch selected in tags match
2796 diary imported from diary
2797 deadline a deadline on given date
2798 scheduled scheduled on given date
2799 timestamp entry has timestamp on given date
2800 closed entry was closed on given date
2801 upcoming-deadline warning about deadline
2802 past-scheduled forwarded scheduled item
2803 block entry has date block including g. date
2804 todo The todo keyword, if any
2805 tags All tags including inherited ones, separated by colons
2806 date The relevant date, like 2007-2-14
2807 time The time, like 15:00-16:50
2808 extra Sting with extra planning info
2809 priority-l The priority letter if any was given
2810 priority-n The computed numerical priority
2811 agenda-day The day in the agenda where this is listed"
2812 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2813 (org-make-parameter-alist parameters))
2814 (if (> (length cmd-key) 2)
2815 (org-tags-view nil cmd-key)
2816 (org-agenda nil cmd-key)))
2817 (set-buffer org-agenda-buffer-name)
2818 (let* ((lines (org-split-string (buffer-string) "\n"))
2819 line)
2820 (while (setq line (pop lines))
2821 (catch 'next
2822 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2823 (setq org-agenda-info
2824 (org-fix-agenda-info (text-properties-at 0 line)))
2825 (princ
2826 (mapconcat 'org-agenda-export-csv-mapper
2827 '(org-category txt type todo tags date time extra
2828 priority-letter priority agenda-day)
2829 ","))
2830 (princ "\n")))))
2831 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2833 (defun org-fix-agenda-info (props)
2834 "Make sure all properties on an agenda item have a canonical form.
2835 This ensures the export commands can easily use it."
2836 (let (tmp re)
2837 (when (setq tmp (plist-get props 'tags))
2838 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2839 (when (setq tmp (plist-get props 'date))
2840 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2841 (let ((calendar-date-display-form '(year "-" month "-" day)))
2842 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2844 (setq tmp (calendar-date-string tmp)))
2845 (setq props (plist-put props 'date tmp)))
2846 (when (setq tmp (plist-get props 'day))
2847 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2848 (let ((calendar-date-display-form '(year "-" month "-" day)))
2849 (setq tmp (calendar-date-string tmp)))
2850 (setq props (plist-put props 'day tmp))
2851 (setq props (plist-put props 'agenda-day tmp)))
2852 (when (setq tmp (plist-get props 'txt))
2853 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2854 (plist-put props 'priority-letter (match-string 1 tmp))
2855 (setq tmp (replace-match "" t t tmp)))
2856 (when (and (setq re (plist-get props 'org-todo-regexp))
2857 (setq re (concat "\\`\\.*" re " ?"))
2858 (string-match re tmp))
2859 (plist-put props 'todo (match-string 1 tmp))
2860 (setq tmp (replace-match "" t t tmp)))
2861 (plist-put props 'txt tmp)))
2862 props)
2864 (defun org-agenda-export-csv-mapper (prop)
2865 (let ((res (plist-get org-agenda-info prop)))
2866 (setq res
2867 (cond
2868 ((not res) "")
2869 ((stringp res) res)
2870 (t (prin1-to-string res))))
2871 (while (string-match "," res)
2872 (setq res (replace-match ";" t t res))) ;
2873 (org-trim res)))
2876 ;;;###autoload
2877 (defun org-store-agenda-views (&rest parameters)
2878 (interactive)
2879 (eval (list 'org-batch-store-agenda-views)))
2881 ;;;###autoload
2882 (defmacro org-batch-store-agenda-views (&rest parameters)
2883 "Run all custom agenda commands that have a file argument."
2884 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2885 (pop-up-frames nil)
2886 (dir default-directory)
2887 (pars (org-make-parameter-alist parameters))
2888 cmd thiscmdkey files opts cmd-or-set)
2889 (save-window-excursion
2890 (while cmds
2891 (setq cmd (pop cmds)
2892 thiscmdkey (car cmd)
2893 cmd-or-set (nth 2 cmd)
2894 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2895 files (nth (if (listp cmd-or-set) 4 5) cmd))
2896 (if (stringp files) (setq files (list files)))
2897 (when files
2898 (org-eval-in-environment (append org-agenda-exporter-settings
2899 opts pars)
2900 (org-agenda nil thiscmdkey))
2901 (set-buffer org-agenda-buffer-name)
2902 (while files
2903 (org-eval-in-environment (append org-agenda-exporter-settings
2904 opts pars)
2905 (org-agenda-write (expand-file-name (pop files) dir) nil t)))
2906 (and (get-buffer org-agenda-buffer-name)
2907 (kill-buffer org-agenda-buffer-name)))))))
2908 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2910 (defun org-agenda-mark-header-line (pos)
2911 "Mark the line at POS as an agenda structure header."
2912 (save-excursion
2913 (goto-char pos)
2914 (put-text-property (point-at-bol) (point-at-eol)
2915 'org-agenda-structural-header t)
2916 (when org-agenda-title-append
2917 (put-text-property (point-at-bol) (point-at-eol)
2918 'org-agenda-title-append org-agenda-title-append))))
2920 (defvar org-mobile-creating-agendas)
2921 (defvar org-agenda-write-buffer-name "Agenda View")
2922 (defun org-agenda-write (file &optional open nosettings)
2923 "Write the current buffer (an agenda view) as a file.
2924 Depending on the extension of the file name, plain text (.txt),
2925 HTML (.html or .htm) or Postscript (.ps) is produced.
2926 If the extension is .ics, run icalendar export over all files used
2927 to construct the agenda and limit the export to entries listed in the
2928 agenda now.
2929 With prefix argument OPEN, open the new file immediately.
2930 If NOSETTINGS is given, do not scope the settings of
2931 `org-agenda-exporter-settings' into the export commands. This is used when
2932 the settings have already been scoped and we do not wish to overrule other,
2933 higher priority settings."
2934 (interactive "FWrite agenda to file: \nP")
2935 (if (not (file-writable-p file))
2936 (error "Cannot write agenda to file %s" file))
2937 (org-let (if nosettings nil org-agenda-exporter-settings)
2938 '(save-excursion
2939 (save-window-excursion
2940 (org-agenda-mark-filtered-text)
2941 (let ((bs (copy-sequence (buffer-string))) beg)
2942 (org-agenda-unmark-filtered-text)
2943 (with-temp-buffer
2944 (rename-buffer org-agenda-write-buffer-name t)
2945 (set-buffer-modified-p nil)
2946 (insert bs)
2947 (org-agenda-remove-marked-text 'org-filtered)
2948 (while (setq beg (text-property-any (point-min) (point-max)
2949 'org-filtered t))
2950 (delete-region
2951 beg (or (next-single-property-change beg 'org-filtered)
2952 (point-max))))
2953 (run-hooks 'org-agenda-before-write-hook)
2954 (cond
2955 ((org-bound-and-true-p org-mobile-creating-agendas)
2956 (org-mobile-write-agenda-for-mobile file))
2957 ((string-match "\\.html?\\'" file)
2958 (require 'htmlize)
2959 (set-buffer (htmlize-buffer (current-buffer)))
2961 (when (and org-agenda-export-html-style
2962 (string-match "<style>" org-agenda-export-html-style))
2963 ;; replace <style> section with org-agenda-export-html-style
2964 (goto-char (point-min))
2965 (kill-region (- (search-forward "<style") 6)
2966 (search-forward "</style>"))
2967 (insert org-agenda-export-html-style))
2968 (write-file file)
2969 (kill-buffer (current-buffer))
2970 (message "HTML written to %s" file))
2971 ((string-match "\\.ps\\'" file)
2972 (require 'ps-print)
2973 (ps-print-buffer-with-faces file)
2974 (message "Postscript written to %s" file))
2975 ((string-match "\\.pdf\\'" file)
2976 (require 'ps-print)
2977 (ps-print-buffer-with-faces
2978 (concat (file-name-sans-extension file) ".ps"))
2979 (call-process "ps2pdf" nil nil nil
2980 (expand-file-name
2981 (concat (file-name-sans-extension file) ".ps"))
2982 (expand-file-name file))
2983 (delete-file (concat (file-name-sans-extension file) ".ps"))
2984 (message "PDF written to %s" file))
2985 ((string-match "\\.ics\\'" file)
2986 (require 'org-icalendar)
2987 (let ((org-agenda-marker-table
2988 (org-create-marker-find-array
2989 (org-agenda-collect-markers)))
2990 (org-icalendar-verify-function 'org-check-agenda-marker-table)
2991 (org-combined-agenda-icalendar-file file))
2992 (apply 'org-export-icalendar 'combine
2993 (org-agenda-files nil 'ifmode))))
2995 (let ((bs (buffer-string)))
2996 (find-file file)
2997 (erase-buffer)
2998 (insert bs)
2999 (save-buffer 0)
3000 (kill-buffer (current-buffer))
3001 (message "Plain text written to %s" file))))))))
3002 (set-buffer org-agenda-buffer-name))
3003 (when open (org-open-file file)))
3005 (defvar org-agenda-tag-filter-overlays nil)
3006 (defvar org-agenda-cat-filter-overlays nil)
3008 (defun org-agenda-mark-filtered-text ()
3009 "Mark all text hidden by filtering with a text property."
3010 (let ((inhibit-read-only t))
3011 (mapc
3012 (lambda (o)
3013 (when (equal (overlay-buffer o) (current-buffer))
3014 (put-text-property
3015 (overlay-start o) (overlay-end o)
3016 'org-filtered t)))
3017 (append org-agenda-tag-filter-overlays
3018 org-agenda-cat-filter-overlays))))
3020 (defun org-agenda-unmark-filtered-text ()
3021 "Remove the filtering text property."
3022 (let ((inhibit-read-only t))
3023 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3025 (defun org-agenda-remove-marked-text (property &optional value)
3026 "Delete all text marked with VALUE of PROPERTY.
3027 VALUE defaults to t."
3028 (let (beg)
3029 (setq value (or value t))
3030 (while (setq beg (text-property-any (point-min) (point-max)
3031 property value))
3032 (delete-region
3033 beg (or (next-single-property-change beg 'org-filtered)
3034 (point-max))))))
3036 (defun org-agenda-add-entry-text ()
3037 "Add entry text to agenda lines.
3038 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3039 entry text following headings shown in the agenda.
3040 Drawers will be excluded, also the line with scheduling/deadline info."
3041 (when (and (> org-agenda-add-entry-text-maxlines 0)
3042 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3043 (let (m txt)
3044 (goto-char (point-min))
3045 (while (not (eobp))
3046 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3047 (beginning-of-line 2)
3048 (setq txt (org-agenda-get-some-entry-text
3049 m org-agenda-add-entry-text-maxlines " > "))
3050 (end-of-line 1)
3051 (if (string-match "\\S-" txt)
3052 (insert "\n" txt)
3053 (or (eobp) (forward-char 1))))))))
3055 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3056 &rest keep)
3057 "Extract entry text from MARKER, at most N-LINES lines.
3058 This will ignore drawers etc, just get the text.
3059 If INDENT is given, prefix every line with this string. If KEEP is
3060 given, it is a list of symbols, defining stuff that should not be
3061 removed from the entry content. Currently only `planning' is allowed here."
3062 (let (txt drawer-re kwd-time-re ind)
3063 (save-excursion
3064 (with-current-buffer (marker-buffer marker)
3065 (if (not (eq major-mode 'org-mode))
3066 (setq txt "")
3067 (save-excursion
3068 (save-restriction
3069 (widen)
3070 (goto-char marker)
3071 (end-of-line 1)
3072 (setq txt (buffer-substring
3073 (min (1+ (point)) (point-max))
3074 (progn (outline-next-heading) (point)))
3075 drawer-re org-drawer-regexp
3076 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3077 ".*\n?"))
3078 (with-temp-buffer
3079 (insert txt)
3080 (when org-agenda-add-entry-text-descriptive-links
3081 (goto-char (point-min))
3082 (while (org-activate-bracket-links (point-max))
3083 (add-text-properties (match-beginning 0) (match-end 0)
3084 '(face org-link))))
3085 (goto-char (point-min))
3086 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3087 (set-text-properties (match-beginning 0) (match-end 0)
3088 nil))
3089 (goto-char (point-min))
3090 (while (re-search-forward drawer-re nil t)
3091 (delete-region
3092 (match-beginning 0)
3093 (progn (re-search-forward
3094 "^[ \t]*:END:.*\n?" nil 'move)
3095 (point))))
3096 (unless (member 'planning keep)
3097 (goto-char (point-min))
3098 (while (re-search-forward kwd-time-re nil t)
3099 (replace-match "")))
3100 (goto-char (point-min))
3101 (when org-agenda-entry-text-exclude-regexps
3102 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3103 (while (setq re (pop re-list))
3104 (goto-char (point-min))
3105 (while (re-search-forward re nil t)
3106 (replace-match "")))))
3107 (goto-char (point-max))
3108 (skip-chars-backward " \t\n")
3109 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3111 ;; find and remove min common indentation
3112 (goto-char (point-min))
3113 (untabify (point-min) (point-max))
3114 (setq ind (org-get-indentation))
3115 (while (not (eobp))
3116 (unless (looking-at "[ \t]*$")
3117 (setq ind (min ind (org-get-indentation))))
3118 (beginning-of-line 2))
3119 (goto-char (point-min))
3120 (while (not (eobp))
3121 (unless (looking-at "[ \t]*$")
3122 (move-to-column ind)
3123 (delete-region (point-at-bol) (point)))
3124 (beginning-of-line 2))
3126 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3128 (goto-char (point-min))
3129 (when indent
3130 (while (and (not (eobp)) (re-search-forward "^" nil t))
3131 (replace-match indent t t)))
3132 (goto-char (point-min))
3133 (while (looking-at "[ \t]*\n") (replace-match ""))
3134 (goto-char (point-max))
3135 (when (> (org-current-line)
3136 n-lines)
3137 (org-goto-line (1+ n-lines))
3138 (backward-char 1))
3139 (setq txt (buffer-substring (point-min) (point)))))))))
3140 txt))
3142 (defun org-agenda-collect-markers ()
3143 "Collect the markers pointing to entries in the agenda buffer."
3144 (let (m markers)
3145 (save-excursion
3146 (goto-char (point-min))
3147 (while (not (eobp))
3148 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3149 (org-get-at-bol 'org-marker)))
3150 (push m markers))
3151 (beginning-of-line 2)))
3152 (nreverse markers)))
3154 (defun org-create-marker-find-array (marker-list)
3155 "Create a alist of files names with all marker positions in that file."
3156 (let (f tbl m a p)
3157 (while (setq m (pop marker-list))
3158 (setq p (marker-position m)
3159 f (buffer-file-name (or (buffer-base-buffer
3160 (marker-buffer m))
3161 (marker-buffer m))))
3162 (if (setq a (assoc f tbl))
3163 (push (marker-position m) (cdr a))
3164 (push (list f p) tbl)))
3165 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3166 tbl)))
3168 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3169 (defun org-check-agenda-marker-table ()
3170 "Check of the current entry is on the marker list."
3171 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3173 (and (setq a (assoc file org-agenda-marker-table))
3174 (save-match-data
3175 (save-excursion
3176 (org-back-to-heading t)
3177 (member (point) (cdr a)))))))
3179 (defun org-check-for-org-mode ()
3180 "Make sure current buffer is in org-mode. Error if not."
3181 (or (eq major-mode 'org-mode)
3182 (error "Cannot execute org-mode agenda command on buffer in %s"
3183 major-mode)))
3185 (defun org-fit-agenda-window ()
3186 "Fit the window to the buffer size."
3187 (and (memq org-agenda-window-setup '(reorganize-frame))
3188 (fboundp 'fit-window-to-buffer)
3189 (org-fit-window-to-buffer
3191 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3192 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3194 ;;; Agenda prepare and finalize
3196 (defvar org-agenda-multi nil) ; dynamically scoped
3197 (defvar org-agenda-buffer-name "*Org Agenda*")
3198 (defvar org-pre-agenda-window-conf nil)
3199 (defvar org-agenda-columns-active nil)
3200 (defvar org-agenda-name nil)
3201 (defvar org-agenda-tag-filter nil)
3202 (defvar org-agenda-category-filter nil)
3203 (defvar org-agenda-tag-filter-while-redo nil)
3204 (defvar org-agenda-tag-filter-preset nil
3205 "A preset of the tags filter used for secondary agenda filtering.
3206 This must be a list of strings, each string must be a single tag preceded
3207 by \"+\" or \"-\".
3208 This variable should not be set directly, but agenda custom commands can
3209 bind it in the options section. The preset filter is a global property of
3210 the entire agenda view. In a block agenda, it will not work reliably to
3211 define a filter for one of the individual blocks. You need to set it in
3212 the global options and expect it to be applied to the entire view.")
3214 (defvar org-agenda-category-filter-preset nil
3215 "A preset of the category filter used for secondary agenda filtering.
3216 This must be a list of strings, each string must be a single category
3217 preceded by \"+\" or \"-\".
3218 This variable should not be set directly, but agenda custom commands can
3219 bind it in the options section. The preset filter is a global property of
3220 the entire agenda view. In a block agenda, it will not work reliably to
3221 define a filter for one of the individual blocks. You need to set it in
3222 the global options and expect it to be applied to the entire view.")
3225 (defun org-agenda-use-sticky-p ()
3226 "Return non-NIL if existing agenda buffer named
3227 `org-agenda-buffer-name' exists, and should be shown instead of
3228 generating a new one"
3229 (and
3230 ;; turned off by user
3231 org-agenda-sticky
3232 ;; For multi-agenda buffer already exists
3233 (not org-agenda-multi)
3234 ;; buffer found
3235 (get-buffer org-agenda-buffer-name)
3236 ;; C-u parameter is same as last call
3237 (with-current-buffer (get-buffer org-agenda-buffer-name)
3238 (and
3239 (equal current-prefix-arg
3240 org-agenda-last-prefix-arg)
3241 ;; In case user turned stickiness on, while having existing
3242 ;; Agenda buffer active, don't reuse that buffer, because it
3243 ;; does not have org variables local
3244 org-agenda-this-buffer-is-sticky))))
3246 (defun org-prepare-agenda-window (abuf)
3247 "Setup agenda buffer in the window"
3248 (let* ((awin (get-buffer-window abuf)))
3249 (cond
3250 ((equal (current-buffer) abuf) nil)
3251 (awin (select-window awin))
3252 ((not (setq org-pre-agenda-window-conf (current-window-configuration))))
3253 ((equal org-agenda-window-setup 'current-window)
3254 (org-pop-to-buffer-same-window abuf))
3255 ((equal org-agenda-window-setup 'other-window)
3256 (org-switch-to-buffer-other-window abuf))
3257 ((equal org-agenda-window-setup 'other-frame)
3258 (switch-to-buffer-other-frame abuf))
3259 ((equal org-agenda-window-setup 'reorganize-frame)
3260 (delete-other-windows)
3261 (org-switch-to-buffer-other-window abuf)))
3262 ;; additional test in case agenda is invoked from within agenda
3263 ;; buffer via elisp link
3264 (unless (equal (current-buffer) abuf)
3265 (org-pop-to-buffer-same-window abuf))))
3267 (defun org-prepare-agenda (&optional name)
3268 (if (org-agenda-use-sticky-p)
3269 (progn
3270 ;; Popup existing buffer
3271 (org-prepare-agenda-window (get-buffer org-agenda-buffer-name))
3272 (message
3273 "Sticky Agenda buffer, use `r' to refresh")
3274 (throw 'exit nil))
3275 (setq org-todo-keywords-for-agenda nil)
3276 (setq org-done-keywords-for-agenda nil)
3277 (setq org-drawers-for-agenda nil)
3278 (unless org-agenda-persistent-filter
3279 (setq org-agenda-tag-filter nil
3280 org-agenda-category-filter nil))
3281 (put 'org-agenda-tag-filter :preset-filter org-agenda-tag-filter-preset)
3282 (put 'org-agenda-category-filter :preset-filter org-agenda-category-filter-preset)
3283 (if org-agenda-multi
3284 (progn
3285 (setq buffer-read-only nil)
3286 (goto-char (point-max))
3287 (unless (or (bobp) org-agenda-compact-blocks
3288 (not org-agenda-block-separator))
3289 (insert "\n"
3290 (if (stringp org-agenda-block-separator)
3291 org-agenda-block-separator
3292 (make-string (window-width) org-agenda-block-separator))
3293 "\n"))
3294 (narrow-to-region (point) (point-max)))
3296 ;; any org variables need to be set after being in agenda buffer
3297 ;; since they are now buffer local
3298 (org-prepare-agenda-window (get-buffer-create org-agenda-buffer-name))
3299 (setq buffer-read-only nil)
3300 (let ((inhibit-read-only t)) (erase-buffer))
3301 (org-agenda-mode)
3302 (setq org-agenda-buffer (current-buffer))
3303 (org-agenda-reset-markers)
3304 (setq org-agenda-contributing-files nil)
3305 (setq org-agenda-columns-active nil)
3306 (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3307 (setq org-todo-keywords-for-agenda
3308 (org-uniquify org-todo-keywords-for-agenda))
3309 (setq org-done-keywords-for-agenda
3310 (org-uniquify org-done-keywords-for-agenda))
3311 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3312 (setq org-agenda-last-prefix-arg current-prefix-arg)
3313 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3314 (and name (not org-agenda-name)
3315 (org-set-local 'org-agenda-name name)))
3316 (setq buffer-read-only nil)))
3318 (defun org-finalize-agenda ()
3319 "Finishing touch for the agenda buffer, called just before displaying it."
3320 (unless org-agenda-multi
3321 (save-excursion
3322 (let ((inhibit-read-only t))
3323 (goto-char (point-min))
3324 (while (org-activate-bracket-links (point-max))
3325 (add-text-properties (match-beginning 0) (match-end 0)
3326 '(face org-link)))
3327 (org-agenda-align-tags)
3328 (unless org-agenda-with-colors
3329 (remove-text-properties (point-min) (point-max) '(face nil))))
3330 (if (and (boundp 'org-agenda-overriding-columns-format)
3331 org-agenda-overriding-columns-format)
3332 (org-set-local 'org-agenda-overriding-columns-format
3333 org-agenda-overriding-columns-format))
3334 (if (and (boundp 'org-agenda-view-columns-initially)
3335 org-agenda-view-columns-initially)
3336 (org-agenda-columns))
3337 (when org-agenda-fontify-priorities
3338 (org-agenda-fontify-priorities))
3339 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3340 (org-agenda-dim-blocked-tasks))
3341 (org-agenda-mark-clocking-task)
3342 (when org-agenda-entry-text-mode
3343 (org-agenda-entry-text-hide)
3344 (org-agenda-entry-text-show))
3345 (if (functionp 'org-habit-insert-consistency-graphs)
3346 (org-habit-insert-consistency-graphs))
3347 (run-hooks 'org-finalize-agenda-hook)
3348 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3349 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3350 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3351 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3352 (org-agenda-filter-apply org-agenda-category-filter 'category))
3355 (defun org-agenda-mark-clocking-task ()
3356 "Mark the current clock entry in the agenda if it is present."
3357 (mapc (lambda (o)
3358 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3359 (delete-overlay o)))
3360 (overlays-in (point-min) (point-max)))
3361 (when (marker-buffer org-clock-hd-marker)
3362 (save-excursion
3363 (goto-char (point-min))
3364 (let (s ov)
3365 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3366 (goto-char s)
3367 (when (equal (org-get-at-bol 'org-hd-marker)
3368 org-clock-hd-marker)
3369 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3370 (overlay-put ov 'type 'org-agenda-clocking)
3371 (overlay-put ov 'face 'org-agenda-clocking)
3372 (overlay-put ov 'help-echo
3373 "The clock is running in this item")))))))
3375 (defun org-agenda-fontify-priorities ()
3376 "Make highest priority lines bold, and lowest italic."
3377 (interactive)
3378 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3379 (delete-overlay o)))
3380 (overlays-in (point-min) (point-max)))
3381 (save-excursion
3382 (let ((inhibit-read-only t)
3383 b e p ov h l)
3384 (goto-char (point-min))
3385 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3386 (setq h (or (get-char-property (point) 'org-highest-priority)
3387 org-highest-priority)
3388 l (or (get-char-property (point) 'org-lowest-priority)
3389 org-lowest-priority)
3390 p (string-to-char (match-string 1))
3391 b (match-beginning 0)
3392 e (if (eq org-agenda-fontify-priorities 'cookies)
3393 (match-end 0)
3394 (point-at-eol))
3395 ov (make-overlay b e))
3396 (overlay-put
3397 ov 'face
3398 (cond ((org-face-from-face-or-color
3399 'priority nil
3400 (cdr (assoc p org-priority-faces))))
3401 ((and (listp org-agenda-fontify-priorities)
3402 (org-face-from-face-or-color
3403 'priority nil
3404 (cdr (assoc p org-agenda-fontify-priorities)))))
3405 ((equal p l) 'italic)
3406 ((equal p h) 'bold)))
3407 (overlay-put ov 'org-type 'org-priority)))))
3409 (defun org-agenda-dim-blocked-tasks ()
3410 "Dim currently blocked TODO's in the agenda display."
3411 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3412 (delete-overlay o)))
3413 (overlays-in (point-min) (point-max)))
3414 (save-excursion
3415 (let ((inhibit-read-only t)
3416 (org-depend-tag-blocked nil)
3417 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3418 org-blocked-by-checkboxes
3419 invis1 b e p ov h l)
3420 (goto-char (point-min))
3421 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3422 (and pos (goto-char (1+ pos))))
3423 (setq org-blocked-by-checkboxes nil invis1 invis)
3424 (let ((marker (org-get-at-bol 'org-hd-marker)))
3425 (when (and marker
3426 (with-current-buffer (marker-buffer marker)
3427 (save-excursion (goto-char marker)
3428 (org-entry-blocked-p))))
3429 (if org-blocked-by-checkboxes (setq invis1 nil))
3430 (setq b (if invis1
3431 (max (point-min) (1- (point-at-bol)))
3432 (point-at-bol))
3433 e (point-at-eol)
3434 ov (make-overlay b e))
3435 (if invis1
3436 (overlay-put ov 'invisible t)
3437 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3438 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3440 (defvar org-agenda-skip-function nil
3441 "Function to be called at each match during agenda construction.
3442 If this function returns nil, the current match should not be skipped.
3443 Otherwise, the function must return a position from where the search
3444 should be continued.
3445 This may also be a Lisp form, it will be evaluated.
3446 Never set this variable using `setq' or so, because then it will apply
3447 to all future agenda commands. If you do want a global skipping condition,
3448 use the option `org-agenda-skip-function-global' instead.
3449 The correct usage for `org-agenda-skip-function' is to bind it with
3450 `let' to scope it dynamically into the agenda-constructing command.
3451 A good way to set it is through options in `org-agenda-custom-commands'.")
3453 (defun org-agenda-skip ()
3454 "Throw to `:skip' in places that should be skipped.
3455 Also moves point to the end of the skipped region, so that search can
3456 continue from there."
3457 (let ((p (point-at-bol)) to)
3458 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3459 (get-text-property p :org-archived)
3460 (org-end-of-subtree t)
3461 (throw :skip t))
3462 (and org-agenda-skip-comment-trees
3463 (get-text-property p :org-comment)
3464 (org-end-of-subtree t)
3465 (throw :skip t))
3466 (if (equal (char-after p) ?#) (throw :skip t))
3467 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3468 (org-agenda-skip-eval org-agenda-skip-function)))
3469 (goto-char to)
3470 (throw :skip t))))
3472 (defun org-agenda-skip-eval (form)
3473 "If FORM is a function or a list, call (or eval) is and return result.
3474 `save-excursion' and `save-match-data' are wrapped around the call, so point
3475 and match data are returned to the previous state no matter what these
3476 functions do."
3477 (let (fp)
3478 (and form
3479 (or (setq fp (functionp form))
3480 (consp form))
3481 (save-excursion
3482 (save-match-data
3483 (if fp
3484 (funcall form)
3485 (eval form)))))))
3487 (defvar org-agenda-markers nil
3488 "List of all currently active markers created by `org-agenda'.")
3489 (defvar org-agenda-last-marker-time (org-float-time)
3490 "Creation time of the last agenda marker.")
3492 (defun org-agenda-new-marker (&optional pos)
3493 "Return a new agenda marker.
3494 Org-mode keeps a list of these markers and resets them when they are
3495 no longer in use."
3496 (let ((m (copy-marker (or pos (point)))))
3497 (setq org-agenda-last-marker-time (org-float-time))
3498 (with-current-buffer org-agenda-buffer
3499 (push m org-agenda-markers))
3502 (defun org-agenda-reset-markers ()
3503 "Reset markers created by `org-agenda'."
3504 (while org-agenda-markers
3505 (move-marker (pop org-agenda-markers) nil)))
3507 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3508 "Save relative positions of markers in region."
3509 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3510 org-agenda-markers))
3512 ;;; Entry text mode
3514 (defun org-agenda-entry-text-show-here ()
3515 "Add some text from the entry as context to the current line."
3516 (let (m txt o)
3517 (setq m (org-get-at-bol 'org-hd-marker))
3518 (unless (marker-buffer m)
3519 (error "No marker points to an entry here"))
3520 (setq txt (concat "\n" (org-no-properties
3521 (org-agenda-get-some-entry-text
3522 m org-agenda-entry-text-maxlines " > "))))
3523 (when (string-match "\\S-" txt)
3524 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3525 (overlay-put o 'evaporate t)
3526 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3527 (overlay-put o 'after-string txt))))
3529 (defun org-agenda-entry-text-show ()
3530 "Add entry context for all agenda lines."
3531 (interactive)
3532 (save-excursion
3533 (goto-char (point-max))
3534 (beginning-of-line 1)
3535 (while (not (bobp))
3536 (when (org-get-at-bol 'org-hd-marker)
3537 (org-agenda-entry-text-show-here))
3538 (beginning-of-line 0))))
3540 (defun org-agenda-entry-text-hide ()
3541 "Remove any shown entry context."
3542 (delq nil
3543 (mapcar (lambda (o)
3544 (if (eq (overlay-get o 'org-overlay-type)
3545 'agenda-entry-content)
3546 (progn (delete-overlay o) t)))
3547 (overlays-in (point-min) (point-max)))))
3549 (defun org-agenda-get-day-face (date)
3550 "Return the face DATE should be displayed with."
3551 (or (and (functionp org-agenda-day-face-function)
3552 (funcall org-agenda-day-face-function date))
3553 (cond ((org-agenda-todayp date)
3554 'org-agenda-date-today)
3555 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3556 'org-agenda-date-weekend)
3557 (t 'org-agenda-date))))
3559 ;;; Agenda timeline
3561 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3563 (defun org-timeline (&optional dotodo)
3564 "Show a time-sorted view of the entries in the current org file.
3565 Only entries with a time stamp of today or later will be listed. With
3566 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3567 under the current date.
3568 If the buffer contains an active region, only check the region for
3569 dates."
3570 (interactive "P")
3571 (let* ((dopast t)
3572 (doclosed org-agenda-show-log)
3573 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3574 (current-buffer))))
3575 (date (calendar-current-date))
3576 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3577 (end (if (org-region-active-p) (region-end) (point-max)))
3578 (day-numbers (org-get-all-dates beg end 'no-ranges
3579 t doclosed ; always include today
3580 org-timeline-show-empty-dates))
3581 (org-deadline-warning-days 0)
3582 (org-agenda-only-exact-dates t)
3583 (today (org-today))
3584 (past t)
3585 args
3586 s e rtn d emptyp)
3587 (setq org-agenda-redo-command
3588 (list 'progn
3589 (list 'org-switch-to-buffer-other-window (current-buffer))
3590 (list 'org-timeline (list 'quote dotodo))))
3591 (if (not dopast)
3592 ;; Remove past dates from the list of dates.
3593 (setq day-numbers (delq nil (mapcar (lambda(x)
3594 (if (>= x today) x nil))
3595 day-numbers))))
3596 (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3597 (org-compile-prefix-format 'timeline)
3598 (org-set-sorting-strategy 'timeline)
3599 (if doclosed (push :closed args))
3600 (push :timestamp args)
3601 (push :deadline args)
3602 (push :scheduled args)
3603 (push :sexp args)
3604 (if dotodo (push :todo args))
3605 (insert "Timeline of file " entry "\n")
3606 (add-text-properties (point-min) (point)
3607 (list 'face 'org-agenda-structure))
3608 (org-agenda-mark-header-line (point-min))
3609 (while (setq d (pop day-numbers))
3610 (if (and (listp d) (eq (car d) :omitted))
3611 (progn
3612 (setq s (point))
3613 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3614 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3615 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3616 (if (and (>= d today)
3617 dopast
3618 past)
3619 (progn
3620 (setq past nil)
3621 (insert (make-string 79 ?-) "\n")))
3622 (setq date (calendar-gregorian-from-absolute d))
3623 (setq s (point))
3624 (setq rtn (and (not emptyp)
3625 (apply 'org-agenda-get-day-entries entry
3626 date args)))
3627 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3628 (progn
3629 (insert
3630 (if (stringp org-agenda-format-date)
3631 (format-time-string org-agenda-format-date
3632 (org-time-from-absolute date))
3633 (funcall org-agenda-format-date date))
3634 "\n")
3635 (put-text-property s (1- (point)) 'face
3636 (org-agenda-get-day-face date))
3637 (put-text-property s (1- (point)) 'org-date-line t)
3638 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3639 (if (equal d today)
3640 (put-text-property s (1- (point)) 'org-today t))
3641 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3642 (put-text-property s (1- (point)) 'day d)))))
3643 (goto-char (point-min))
3644 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3645 (point-min)))
3646 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3647 (org-finalize-agenda)
3648 (setq buffer-read-only t)))
3650 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3651 "Return a list of all relevant day numbers from BEG to END buffer positions.
3652 If NO-RANGES is non-nil, include only the start and end dates of a range,
3653 not every single day in the range. If FORCE-TODAY is non-nil, make
3654 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3655 inactive time stamps (those in square brackets) are included.
3656 When EMPTY is non-nil, also include days without any entries."
3657 (let ((re (concat
3658 (if pre-re pre-re "")
3659 (if inactive org-ts-regexp-both org-ts-regexp)))
3660 dates dates1 date day day1 day2 ts1 ts2 pos)
3661 (if force-today
3662 (setq dates (list (org-today))))
3663 (save-excursion
3664 (goto-char beg)
3665 (while (re-search-forward re end t)
3666 (setq day (time-to-days (org-time-string-to-time
3667 (substring (match-string 1) 0 10)
3668 (current-buffer) (match-beginning 0))))
3669 (or (memq day dates) (push day dates)))
3670 (unless no-ranges
3671 (goto-char beg)
3672 (while (re-search-forward org-tr-regexp end t)
3673 (setq pos (match-beginning 0))
3674 (setq ts1 (substring (match-string 1) 0 10)
3675 ts2 (substring (match-string 2) 0 10)
3676 day1 (time-to-days (org-time-string-to-time
3677 ts1 (current-buffer) pos))
3678 day2 (time-to-days (org-time-string-to-time
3679 ts2 (current-buffer) pos)))
3680 (while (< (setq day1 (1+ day1)) day2)
3681 (or (memq day1 dates) (push day1 dates)))))
3682 (setq dates (sort dates '<))
3683 (when empty
3684 (while (setq day (pop dates))
3685 (setq day2 (car dates))
3686 (push day dates1)
3687 (when (and day2 empty)
3688 (if (or (eq empty t)
3689 (and (numberp empty) (<= (- day2 day) empty)))
3690 (while (< (setq day (1+ day)) day2)
3691 (push (list day) dates1))
3692 (push (cons :omitted (- day2 day)) dates1))))
3693 (setq dates (nreverse dates1)))
3694 dates)))
3696 ;;; Agenda Daily/Weekly
3698 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3699 "Start day for the agenda view.
3700 Custom commands can set this variable in the options section.")
3701 (defvar org-starting-day nil) ; local variable in the agenda buffer
3702 (defvar org-agenda-current-span nil
3703 "The current span used in the agenda view.") ; local variable in the agenda buffer
3704 (defvar org-arg-loc nil) ; local variable
3706 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3707 "List of types searched for when creating the daily/weekly agenda.
3708 This variable is a list of symbols that controls the types of
3709 items that appear in the daily/weekly agenda. Allowed symbols in this
3710 list are are
3712 :timestamp List items containing a date stamp or date range matching
3713 the selected date. This includes sexp entries in
3714 angular brackets.
3716 :sexp List entries resulting from plain diary-like sexps.
3718 :deadline List deadline due on that date. When the date is today,
3719 also list any deadlines past due, or due within
3720 `org-deadline-warning-days'. `:deadline' must appear before
3721 `:scheduled' if the setting of
3722 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3723 any effect.
3725 :scheduled List all items which are scheduled for the given date.
3726 The diary for *today* also contains items which were
3727 scheduled earlier and are not yet marked DONE.
3729 By default, all four types are turned on.
3731 Never set this variable globally using `setq', because then it
3732 will apply to all future agenda commands. Instead, bind it with
3733 `let' to scope it dynamically into the agenda-constructing
3734 command. A good way to set it is through options in
3735 `org-agenda-custom-commands'. For a more flexible (though
3736 somewhat less efficient) way of determining what is included in
3737 the daily/weekly agenda, see `org-agenda-skip-function'.")
3739 ;;;###autoload
3740 (defun org-agenda-list (&optional arg start-day span)
3741 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3742 The view will be for the current day or week, but from the overview buffer
3743 you will be able to go to other days/weeks.
3745 With a numeric prefix argument in an interactive call, the agenda will
3746 span ARG days. Lisp programs should instead specify SPAN to change
3747 the number of days. SPAN defaults to `org-agenda-span'.
3749 START-DAY defaults to TODAY, or to the most recent match for the weekday
3750 given in `org-agenda-start-on-weekday'."
3751 (interactive "P")
3752 (if (and (integerp arg) (> arg 0))
3753 (setq span arg arg nil))
3754 (org-prepare-agenda "Day/Week")
3755 (setq start-day (or start-day org-agenda-start-day))
3756 (if org-agenda-overriding-arguments
3757 (setq arg (car org-agenda-overriding-arguments)
3758 start-day (nth 1 org-agenda-overriding-arguments)
3759 span (nth 2 org-agenda-overriding-arguments)))
3760 (if (stringp start-day)
3761 ;; Convert to an absolute day number
3762 (setq start-day (time-to-days (org-read-date nil t start-day))))
3763 (setq org-agenda-last-arguments (list arg start-day span))
3764 (org-compile-prefix-format 'agenda)
3765 (org-set-sorting-strategy 'agenda)
3766 (let* ((span (org-agenda-ndays-to-span
3767 (or span org-agenda-ndays org-agenda-span)))
3768 (today (org-today))
3769 (sd (or start-day today))
3770 (ndays (org-agenda-span-to-ndays span sd))
3771 (org-agenda-start-on-weekday
3772 (if (eq ndays 7)
3773 org-agenda-start-on-weekday))
3774 (thefiles (org-agenda-files nil 'ifmode))
3775 (files thefiles)
3776 (start (if (or (null org-agenda-start-on-weekday)
3777 (< ndays 7))
3779 (let* ((nt (calendar-day-of-week
3780 (calendar-gregorian-from-absolute sd)))
3781 (n1 org-agenda-start-on-weekday)
3782 (d (- nt n1)))
3783 (- sd (+ (if (< d 0) 7 0) d)))))
3784 (day-numbers (list start))
3785 (day-cnt 0)
3786 (inhibit-redisplay (not debug-on-error))
3787 s e rtn rtnall file date d start-pos end-pos todayp
3788 clocktable-start clocktable-end filter)
3789 (setq org-agenda-redo-command
3790 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3791 (dotimes (n (1- ndays))
3792 (push (1+ (car day-numbers)) day-numbers))
3793 (setq day-numbers (nreverse day-numbers))
3794 (setq clocktable-start (car day-numbers)
3795 clocktable-end (1+ (or (org-last day-numbers) 0)))
3796 (org-set-local 'org-starting-day (car day-numbers))
3797 (org-set-local 'org-arg-loc arg)
3798 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3799 (unless org-agenda-compact-blocks
3800 (let* ((d1 (car day-numbers))
3801 (d2 (org-last day-numbers))
3802 (w1 (org-days-to-iso-week d1))
3803 (w2 (org-days-to-iso-week d2)))
3804 (setq s (point))
3805 (if org-agenda-overriding-header
3806 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3807 nil 'face 'org-agenda-structure) "\n")
3808 (insert (org-agenda-span-name span)
3809 "-agenda"
3810 (if (< (- d2 d1) 350)
3811 (if (= w1 w2)
3812 (format " (W%02d)" w1)
3813 (format " (W%02d-W%02d)" w1 w2))
3815 ":\n")))
3816 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3817 'org-date-line t))
3818 (org-agenda-mark-header-line s))
3819 (while (setq d (pop day-numbers))
3820 (setq date (calendar-gregorian-from-absolute d)
3821 s (point))
3822 (if (or (setq todayp (= d today))
3823 (and (not start-pos) (= d sd)))
3824 (setq start-pos (point))
3825 (if (and start-pos (not end-pos))
3826 (setq end-pos (point))))
3827 (setq files thefiles
3828 rtnall nil)
3829 (while (setq file (pop files))
3830 (catch 'nextfile
3831 (org-check-agenda-file file)
3832 (let ((org-agenda-entry-types org-agenda-entry-types))
3833 (unless org-agenda-include-deadlines
3834 (setq org-agenda-entry-types
3835 (delq :deadline org-agenda-entry-types)))
3836 (cond
3837 ((memq org-agenda-show-log '(only clockcheck))
3838 (setq rtn (org-agenda-get-day-entries
3839 file date :closed)))
3840 (org-agenda-show-log
3841 (setq rtn (apply 'org-agenda-get-day-entries
3842 file date
3843 (append '(:closed) org-agenda-entry-types))))
3845 (setq rtn (apply 'org-agenda-get-day-entries
3846 file date
3847 org-agenda-entry-types)))))
3848 (setq rtnall (append rtnall rtn)))) ;; all entries
3849 (if org-agenda-include-diary
3850 (let ((org-agenda-search-headline-for-time t))
3851 (require 'diary-lib)
3852 (setq rtn (org-get-entries-from-diary date))
3853 (setq rtnall (append rtnall rtn))))
3854 (if (or rtnall org-agenda-show-all-dates)
3855 (progn
3856 (setq day-cnt (1+ day-cnt))
3857 (insert
3858 (if (stringp org-agenda-format-date)
3859 (format-time-string org-agenda-format-date
3860 (org-time-from-absolute date))
3861 (funcall org-agenda-format-date date))
3862 "\n")
3863 (put-text-property s (1- (point)) 'face
3864 (org-agenda-get-day-face date))
3865 (put-text-property s (1- (point)) 'org-date-line t)
3866 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3867 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3868 (when todayp
3869 (put-text-property s (1- (point)) 'org-today t))
3870 (if rtnall (insert ;; all entries
3871 (org-finalize-agenda-entries
3872 (org-agenda-add-time-grid-maybe
3873 rtnall ndays todayp))
3874 "\n"))
3875 (put-text-property s (1- (point)) 'day d)
3876 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3877 (when (and org-agenda-clockreport-mode clocktable-start)
3878 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3879 ;; the above line is to ensure the restricted range!
3880 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3881 tbl)
3882 (setq p (org-plist-delete p :block))
3883 (setq p (plist-put p :tstart clocktable-start))
3884 (setq p (plist-put p :tend clocktable-end))
3885 (setq p (plist-put p :scope 'agenda))
3886 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3887 (setq filter (or org-agenda-tag-filter-while-redo
3888 (get 'org-agenda-tag-filter :preset-filter))))
3889 (setq p (plist-put p :tags (mapconcat (lambda (x)
3890 (if (string-match "[<>=]" x)
3893 filter ""))))
3894 (setq tbl (apply 'org-get-clocktable p))
3895 (insert tbl)))
3896 (goto-char (point-min))
3897 (or org-agenda-multi (org-fit-agenda-window))
3898 (unless (and (pos-visible-in-window-p (point-min))
3899 (pos-visible-in-window-p (point-max)))
3900 (goto-char (1- (point-max)))
3901 (recenter -1)
3902 (if (not (pos-visible-in-window-p (or start-pos 1)))
3903 (progn
3904 (goto-char (or start-pos 1))
3905 (recenter 1))))
3906 (goto-char (or start-pos 1))
3907 (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
3908 (if (eq org-agenda-show-log 'clockcheck)
3909 (org-agenda-show-clocking-issues))
3910 (org-finalize-agenda)
3911 (setq buffer-read-only t)
3912 (message "")))
3914 (defun org-agenda-ndays-to-span (n)
3915 "Return a span symbol for a span of N days, or N if none matches."
3916 (cond ((symbolp n) n)
3917 ((= n 1) 'day)
3918 ((= n 7) 'week)
3919 (t n)))
3921 (defun org-agenda-span-to-ndays (span start-day)
3922 "Return ndays from SPAN starting at START-DAY."
3923 (cond ((numberp span) span)
3924 ((eq span 'day) 1)
3925 ((eq span 'week) 7)
3926 ((eq span 'month)
3927 (let ((date (calendar-gregorian-from-absolute start-day)))
3928 (calendar-last-day-of-month (car date) (caddr date))))
3929 ((eq span 'year)
3930 (let ((date (calendar-gregorian-from-absolute start-day)))
3931 (if (calendar-leap-year-p (caddr date)) 366 365)))))
3933 (defun org-agenda-span-name (span)
3934 "Return a SPAN name."
3935 (if (null span)
3937 (if (symbolp span)
3938 (capitalize (symbol-name span))
3939 (format "%d days" span))))
3941 ;;; Agenda word search
3943 (defvar org-agenda-search-history nil)
3944 (defvar org-todo-only nil)
3946 (defvar org-search-syntax-table nil
3947 "Special syntax table for org-mode search.
3948 In this table, we have single quotes not as word constituents, to
3949 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
3951 (defun org-search-syntax-table ()
3952 (unless org-search-syntax-table
3953 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
3954 (modify-syntax-entry ?' "." org-search-syntax-table)
3955 (modify-syntax-entry ?` "." org-search-syntax-table))
3956 org-search-syntax-table)
3958 (defvar org-agenda-last-search-view-search-was-boolean nil)
3960 ;;;###autoload
3961 (defun org-search-view (&optional todo-only string edit-at)
3962 "Show all entries that contain a phrase or words or regular expressions.
3964 With optional prefix argument TODO-ONLY, only consider entries that are
3965 TODO entries. The argument STRING can be used to pass a default search
3966 string into this function. If EDIT-AT is non-nil, it means that the
3967 user should get a chance to edit this string, with cursor at position
3968 EDIT-AT.
3970 The search string can be viewed either as a phrase that should be found as
3971 is, or it can be broken into a number of snippets, each of which must match
3972 in a Boolean way to select an entry. The default depends on the variable
3973 `org-agenda-search-view-always-boolean'.
3974 Even if this is turned off (the default) you can always switch to
3975 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
3977 The default is a direct search of the whole phrase, where each space in
3978 the search string can expand to an arbitrary amount of whitespace,
3979 including newlines.
3981 If using a Boolean search, the search string is split on whitespace and
3982 each snippet is searched separately, with logical AND to select an entry.
3983 Words prefixed with a minus must *not* occur in the entry. Words without
3984 a prefix or prefixed with a plus must occur in the entry. Matching is
3985 case-insensitive. Words are enclosed by word delimiters (i.e. they must
3986 match whole words, not parts of a word) if
3987 `org-agenda-search-view-force-full-words' is set (default is nil).
3989 Boolean search snippets enclosed by curly braces are interpreted as
3990 regular expressions that must or (when preceded with \"-\") must not
3991 match in the entry. Snippets enclosed into double quotes will be taken
3992 as a whole, to include whitespace.
3994 - If the search string starts with an asterisk, search only in headlines.
3995 - If (possibly after the leading star) the search string starts with an
3996 exclamation mark, this also means to look at TODO entries only, an effect
3997 that can also be achieved with a prefix argument.
3998 - If (possibly after star and exclamation mark) the search string starts
3999 with a colon, this will mean that the (non-regexp) snippets of the
4000 Boolean search must match as full words.
4002 This command searches the agenda files, and in addition the files listed
4003 in `org-agenda-text-search-extra-files'."
4004 (interactive "P")
4005 (org-prepare-agenda "SEARCH")
4006 (org-compile-prefix-format 'search)
4007 (org-set-sorting-strategy 'search)
4008 (let* ((props (list 'face nil
4009 'done-face 'org-agenda-done
4010 'org-not-done-regexp org-not-done-regexp
4011 'org-todo-regexp org-todo-regexp
4012 'org-complex-heading-regexp org-complex-heading-regexp
4013 'mouse-face 'highlight
4014 'help-echo (format "mouse-2 or RET jump to location")))
4015 (full-words org-agenda-search-view-force-full-words)
4016 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4017 regexp rtn rtnall files file pos
4018 marker category org-category-pos tags c neg re boolean
4019 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4020 (unless (and (not edit-at)
4021 (stringp string)
4022 (string-match "\\S-" string))
4023 (setq string (read-string
4024 (if org-agenda-search-view-always-boolean
4025 "[+-]Word/{Regexp} ...: "
4026 "Phrase, or [+-]Word/{Regexp} ...: ")
4027 (cond
4028 ((integerp edit-at) (cons string edit-at))
4029 (edit-at string))
4030 'org-agenda-search-history)))
4031 (org-set-local 'org-todo-only todo-only)
4032 (setq org-agenda-redo-command
4033 (list 'org-search-view (if todo-only t nil) string
4034 '(if current-prefix-arg 1 nil)))
4035 (setq org-agenda-query-string string)
4037 (if (equal (string-to-char string) ?*)
4038 (setq hdl-only t
4039 words (substring string 1))
4040 (setq words string))
4041 (when (equal (string-to-char words) ?!)
4042 (setq todo-only t
4043 words (substring words 1)))
4044 (when (equal (string-to-char words) ?:)
4045 (setq full-words t
4046 words (substring words 1)))
4047 (if (or org-agenda-search-view-always-boolean
4048 (member (string-to-char words) '(?- ?+ ?\{)))
4049 (setq boolean t))
4050 (setq words (org-split-string words))
4051 (let (www w)
4052 (while (setq w (pop words))
4053 (while (and (string-match "\\\\\\'" w) words)
4054 (setq w (concat (substring w 0 -1) " " (pop words))))
4055 (push w www))
4056 (setq words (nreverse www) www nil)
4057 (while (setq w (pop words))
4058 (when (and (string-match "\\`[-+]?{" w)
4059 (not (string-match "}\\'" w)))
4060 (while (and words (not (string-match "}\\'" (car words))))
4061 (setq w (concat w " " (pop words))))
4062 (setq w (concat w " " (pop words))))
4063 (push w www))
4064 (setq words (nreverse www)))
4065 (setq org-agenda-last-search-view-search-was-boolean boolean)
4066 (when boolean
4067 (let (wds w)
4068 (while (setq w (pop words))
4069 (if (or (equal (substring w 0 1) "\"")
4070 (and (> (length w) 1)
4071 (member (substring w 0 1) '("+" "-"))
4072 (equal (substring w 1 2) "\"")))
4073 (while (and words (not (equal (substring w -1) "\"")))
4074 (setq w (concat w " " (pop words)))))
4075 (and (string-match "\\`\\([-+]?\\)\"" w)
4076 (setq w (replace-match "\\1" nil nil w)))
4077 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4078 (push w wds))
4079 (setq words (nreverse wds))))
4080 (if boolean
4081 (mapc (lambda (w)
4082 (setq c (string-to-char w))
4083 (if (equal c ?-)
4084 (setq neg t w (substring w 1))
4085 (if (equal c ?+)
4086 (setq neg nil w (substring w 1))
4087 (setq neg nil)))
4088 (if (string-match "\\`{.*}\\'" w)
4089 (setq re (substring w 1 -1))
4090 (if full-words
4091 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4092 (setq re (regexp-quote (downcase w)))))
4093 (if neg (push re regexps-) (push re regexps+)))
4094 words)
4095 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4096 regexps+))
4097 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4098 (if (not regexps+)
4099 (setq regexp org-outline-regexp-bol)
4100 (setq regexp (pop regexps+))
4101 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4102 regexp))))
4103 (setq files (org-agenda-files nil 'ifmode))
4104 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4105 (pop org-agenda-text-search-extra-files)
4106 (setq files (org-add-archive-files files)))
4107 (setq files (append files org-agenda-text-search-extra-files)
4108 rtnall nil)
4109 (while (setq file (pop files))
4110 (setq ee nil)
4111 (catch 'nextfile
4112 (org-check-agenda-file file)
4113 (setq buffer (if (file-exists-p file)
4114 (org-get-agenda-file-buffer file)
4115 (error "No such file %s" file)))
4116 (if (not buffer)
4117 ;; If file does not exist, make sure an error message is sent
4118 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4119 file))))
4120 (with-current-buffer buffer
4121 (with-syntax-table (org-search-syntax-table)
4122 (unless (eq major-mode 'org-mode)
4123 (error "Agenda file %s is not in `org-mode'" file))
4124 (let ((case-fold-search t))
4125 (save-excursion
4126 (save-restriction
4127 (if org-agenda-restrict
4128 (narrow-to-region org-agenda-restrict-begin
4129 org-agenda-restrict-end)
4130 (widen))
4131 (goto-char (point-min))
4132 (unless (or (org-at-heading-p)
4133 (outline-next-heading))
4134 (throw 'nextfile t))
4135 (goto-char (max (point-min) (1- (point))))
4136 (while (re-search-forward regexp nil t)
4137 (org-back-to-heading t)
4138 (skip-chars-forward "* ")
4139 (setq beg (point-at-bol)
4140 beg1 (point)
4141 end (progn (outline-next-heading) (point)))
4142 (catch :skip
4143 (goto-char beg)
4144 (org-agenda-skip)
4145 (setq str (buffer-substring-no-properties
4146 (point-at-bol)
4147 (if hdl-only (point-at-eol) end)))
4148 (mapc (lambda (wr) (when (string-match wr str)
4149 (goto-char (1- end))
4150 (throw :skip t)))
4151 regexps-)
4152 (mapc (lambda (wr) (unless (string-match wr str)
4153 (goto-char (1- end))
4154 (throw :skip t)))
4155 (if todo-only
4156 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4157 regexps+)
4158 regexps+))
4159 (goto-char beg)
4160 (setq marker (org-agenda-new-marker (point))
4161 category (org-get-category)
4162 org-category-pos (get-text-property (point) 'org-category-position)
4163 tags (org-get-tags-at (point))
4164 txt (org-agenda-format-item
4166 (buffer-substring-no-properties
4167 beg1 (point-at-eol))
4168 category tags))
4169 (org-add-props txt props
4170 'org-marker marker 'org-hd-marker marker
4171 'org-todo-regexp org-todo-regexp
4172 'org-complex-heading-regexp org-complex-heading-regexp
4173 'priority 1000 'org-category category
4174 'org-category-position org-category-pos
4175 'type "search")
4176 (push txt ee)
4177 (goto-char (1- end))))))))))
4178 (setq rtn (nreverse ee))
4179 (setq rtnall (append rtnall rtn)))
4180 (if org-agenda-overriding-header
4181 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4182 nil 'face 'org-agenda-structure) "\n")
4183 (insert "Search words: ")
4184 (add-text-properties (point-min) (1- (point))
4185 (list 'face 'org-agenda-structure))
4186 (setq pos (point))
4187 (insert string "\n")
4188 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4189 (setq pos (point))
4190 (unless org-agenda-multi
4191 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4192 (add-text-properties pos (1- (point))
4193 (list 'face 'org-agenda-structure))))
4194 (org-agenda-mark-header-line (point-min))
4195 (when rtnall
4196 (insert (org-finalize-agenda-entries rtnall) "\n"))
4197 (goto-char (point-min))
4198 (or org-agenda-multi (org-fit-agenda-window))
4199 (add-text-properties (point-min) (point-max) '(org-agenda-type search))
4200 (org-finalize-agenda)
4201 (setq buffer-read-only t)))
4203 ;;; Agenda TODO list
4205 (defvar org-select-this-todo-keyword nil)
4206 (defvar org-last-arg nil)
4208 ;;;###autoload
4209 (defun org-todo-list (arg)
4210 "Show all (not done) TODO entries from all agenda file in a single list.
4211 The prefix arg can be used to select a specific TODO keyword and limit
4212 the list to these. When using \\[universal-argument], you will be prompted
4213 for a keyword. A numeric prefix directly selects the Nth keyword in
4214 `org-todo-keywords-1'."
4215 (interactive "P")
4216 (org-prepare-agenda "TODO")
4217 (org-compile-prefix-format 'todo)
4218 (org-set-sorting-strategy 'todo)
4219 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4220 (let* ((today (org-today))
4221 (date (calendar-gregorian-from-absolute today))
4222 (kwds org-todo-keywords-for-agenda)
4223 (completion-ignore-case t)
4224 (org-select-this-todo-keyword
4225 (if (stringp arg) arg
4226 (and arg (integerp arg) (> arg 0)
4227 (nth (1- arg) kwds))))
4228 rtn rtnall files file pos)
4229 (when (equal arg '(4))
4230 (setq org-select-this-todo-keyword
4231 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4232 (mapcar 'list kwds) nil nil)))
4233 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4234 (org-set-local 'org-last-arg arg)
4235 (setq org-agenda-redo-command
4236 '(org-todo-list (or current-prefix-arg org-last-arg)))
4237 (setq files (org-agenda-files nil 'ifmode)
4238 rtnall nil)
4239 (while (setq file (pop files))
4240 (catch 'nextfile
4241 (org-check-agenda-file file)
4242 (setq rtn (org-agenda-get-day-entries file date :todo))
4243 (setq rtnall (append rtnall rtn))))
4244 (if org-agenda-overriding-header
4245 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4246 nil 'face 'org-agenda-structure) "\n")
4247 (insert "Global list of TODO items of type: ")
4248 (add-text-properties (point-min) (1- (point))
4249 (list 'face 'org-agenda-structure
4250 'short-heading
4251 (concat "ToDo: "
4252 (or org-select-this-todo-keyword "ALL"))))
4253 (org-agenda-mark-header-line (point-min))
4254 (setq pos (point))
4255 (insert (or org-select-this-todo-keyword "ALL") "\n")
4256 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4257 (setq pos (point))
4258 (unless org-agenda-multi
4259 (insert "Available with `N r': (0)ALL")
4260 (let ((n 0) s)
4261 (mapc (lambda (x)
4262 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4263 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4264 (insert "\n "))
4265 (insert " " s))
4266 kwds))
4267 (insert "\n"))
4268 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4269 (org-agenda-mark-header-line (point-min))
4270 (when rtnall
4271 (insert (org-finalize-agenda-entries rtnall) "\n"))
4272 (goto-char (point-min))
4273 (or org-agenda-multi (org-fit-agenda-window))
4274 (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
4275 (org-finalize-agenda)
4276 (setq buffer-read-only t)))
4278 ;;; Agenda tags match
4280 ;;;###autoload
4281 (defun org-tags-view (&optional todo-only match)
4282 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4283 The prefix arg TODO-ONLY limits the search to TODO entries."
4284 (interactive "P")
4285 (let* ((org-tags-match-list-sublevels
4286 org-tags-match-list-sublevels)
4287 (completion-ignore-case t)
4288 rtn rtnall files file pos matcher
4289 buffer)
4290 (when (and (stringp match) (not (string-match "\\S-" match)))
4291 (setq match nil))
4292 (setq matcher (org-make-tags-matcher match)
4293 match (car matcher) matcher (cdr matcher))
4294 (org-prepare-agenda (concat "TAGS " match))
4295 (org-compile-prefix-format 'tags)
4296 (org-set-sorting-strategy 'tags)
4297 (setq org-agenda-query-string match)
4298 (setq org-agenda-redo-command
4299 (list 'org-tags-view (list 'quote todo-only)
4300 (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
4301 (setq files (org-agenda-files nil 'ifmode)
4302 rtnall nil)
4303 (while (setq file (pop files))
4304 (catch 'nextfile
4305 (org-check-agenda-file file)
4306 (setq buffer (if (file-exists-p file)
4307 (org-get-agenda-file-buffer file)
4308 (error "No such file %s" file)))
4309 (if (not buffer)
4310 ;; If file does not exist, error message to agenda
4311 (setq rtn (list
4312 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4313 rtnall (append rtnall rtn))
4314 (with-current-buffer buffer
4315 (unless (eq major-mode 'org-mode)
4316 (error "Agenda file %s is not in `org-mode'" file))
4317 (save-excursion
4318 (save-restriction
4319 (if org-agenda-restrict
4320 (narrow-to-region org-agenda-restrict-begin
4321 org-agenda-restrict-end)
4322 (widen))
4323 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4324 (setq rtnall (append rtnall rtn))))))))
4325 (if org-agenda-overriding-header
4326 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4327 nil 'face 'org-agenda-structure) "\n")
4328 (insert "Headlines with TAGS match: ")
4329 (add-text-properties (point-min) (1- (point))
4330 (list 'face 'org-agenda-structure
4331 'short-heading
4332 (concat "Match: " match)))
4333 (setq pos (point))
4334 (insert match "\n")
4335 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4336 (setq pos (point))
4337 (unless org-agenda-multi
4338 (insert "Press `C-u r' to search again with new search string\n"))
4339 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4340 (org-agenda-mark-header-line (point-min))
4341 (when rtnall
4342 (insert (org-finalize-agenda-entries rtnall) "\n"))
4343 (goto-char (point-min))
4344 (or org-agenda-multi (org-fit-agenda-window))
4345 (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
4346 (org-finalize-agenda)
4347 (setq buffer-read-only t)))
4349 ;;; Agenda Finding stuck projects
4351 (defvar org-agenda-skip-regexp nil
4352 "Regular expression used in skipping subtrees for the agenda.
4353 This is basically a temporary global variable that can be set and then
4354 used by user-defined selections using `org-agenda-skip-function'.")
4356 (defvar org-agenda-overriding-header nil
4357 "When set during agenda, todo and tags searches it replaces the header.
4358 This variable should not be set directly, but custom commands can bind it
4359 in the options section.")
4361 (defun org-agenda-skip-entry-when-regexp-matches ()
4362 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4363 If yes, it returns the end position of this entry, causing agenda commands
4364 to skip the entry but continuing the search in the subtree. This is a
4365 function that can be put into `org-agenda-skip-function' for the duration
4366 of a command."
4367 (let ((end (save-excursion (org-end-of-subtree t)))
4368 skip)
4369 (save-excursion
4370 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4371 (and skip end)))
4373 (defun org-agenda-skip-subtree-when-regexp-matches ()
4374 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4375 If yes, it returns the end position of this tree, causing agenda commands
4376 to skip this subtree. This is a function that can be put into
4377 `org-agenda-skip-function' for the duration of a command."
4378 (let ((end (save-excursion (org-end-of-subtree t)))
4379 skip)
4380 (save-excursion
4381 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4382 (and skip end)))
4384 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4385 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4386 If yes, it returns the end position of the current entry (NOT the tree),
4387 causing agenda commands to skip the entry but continuing the search in
4388 the subtree. This is a function that can be put into
4389 `org-agenda-skip-function' for the duration of a command. An important
4390 use of this function is for the stuck project list."
4391 (let ((end (save-excursion (org-end-of-subtree t)))
4392 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4393 skip)
4394 (save-excursion
4395 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4396 (and skip entry-end)))
4398 (defun org-agenda-skip-entry-if (&rest conditions)
4399 "Skip entry if any of CONDITIONS is true.
4400 See `org-agenda-skip-if' for details."
4401 (org-agenda-skip-if nil conditions))
4403 (defun org-agenda-skip-subtree-if (&rest conditions)
4404 "Skip entry if any of CONDITIONS is true.
4405 See `org-agenda-skip-if' for details."
4406 (org-agenda-skip-if t conditions))
4408 (defun org-agenda-skip-if (subtree conditions)
4409 "Checks current entity for CONDITIONS.
4410 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4411 the entry, i.e. the text before the next heading is checked.
4413 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4414 from different tests. Valid conditions are:
4416 scheduled Check if there is a scheduled cookie
4417 notscheduled Check if there is no scheduled cookie
4418 deadline Check if there is a deadline
4419 notdeadline Check if there is no deadline
4420 timestamp Check if there is a timestamp (also deadline or scheduled)
4421 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4422 regexp Check if regexp matches
4423 notregexp Check if regexp does not match.
4424 todo Check if TODO keyword matches
4425 nottodo Check if TODO keyword does not match
4427 The regexp is taken from the conditions list, it must come right after
4428 the `regexp' or `notregexp' element.
4430 `todo' and `nottodo' accept as an argument a list of todo
4431 keywords, which may include \"*\" to match any todo keyword.
4433 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4435 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4437 Instead of a list a keyword class may be given
4439 (org-agenda-skip-entry-if 'nottodo 'done)
4441 would skip entries that haven't been marked with any of \"DONE\"
4442 keywords. Possible classes are: `todo', `done', `any'.
4444 If any of these conditions is met, this function returns the end point of
4445 the entity, causing the search to continue from there. This is a function
4446 that can be put into `org-agenda-skip-function' for the duration of a command."
4447 (let (beg end m)
4448 (org-back-to-heading t)
4449 (setq beg (point)
4450 end (if subtree
4451 (progn (org-end-of-subtree t) (point))
4452 (progn (outline-next-heading) (1- (point)))))
4453 (goto-char beg)
4454 (and
4456 (and (memq 'scheduled conditions)
4457 (re-search-forward org-scheduled-time-regexp end t))
4458 (and (memq 'notscheduled conditions)
4459 (not (re-search-forward org-scheduled-time-regexp end t)))
4460 (and (memq 'deadline conditions)
4461 (re-search-forward org-deadline-time-regexp end t))
4462 (and (memq 'notdeadline conditions)
4463 (not (re-search-forward org-deadline-time-regexp end t)))
4464 (and (memq 'timestamp conditions)
4465 (re-search-forward org-ts-regexp end t))
4466 (and (memq 'nottimestamp conditions)
4467 (not (re-search-forward org-ts-regexp end t)))
4468 (and (setq m (memq 'regexp conditions))
4469 (stringp (nth 1 m))
4470 (re-search-forward (nth 1 m) end t))
4471 (and (setq m (memq 'notregexp conditions))
4472 (stringp (nth 1 m))
4473 (not (re-search-forward (nth 1 m) end t)))
4474 (and (or
4475 (setq m (memq 'todo conditions))
4476 (setq m (memq 'nottodo conditions)))
4477 (org-agenda-skip-if-todo m end)))
4478 end)))
4480 (defun org-agenda-skip-if-todo (args end)
4481 "Helper function for `org-agenda-skip-if', do not use it directly.
4482 ARGS is a list with first element either `todo' or `nottodo'.
4483 The remainder is either a list of TODO keywords, or a state symbol
4484 `todo' or `done' or `any'."
4485 (let ((kw (car args))
4486 (arg (cadr args))
4487 todo-wds todo-re)
4488 (setq todo-wds
4489 (org-uniquify
4490 (cond
4491 ((listp arg) ;; list of keywords
4492 (if (member "*" arg)
4493 (mapcar 'substring-no-properties org-todo-keywords-1)
4494 arg))
4495 ((symbolp arg) ;; keyword class name
4496 (cond
4497 ((eq arg 'todo)
4498 (org-delete-all org-done-keywords
4499 (mapcar 'substring-no-properties
4500 org-todo-keywords-1)))
4501 ((eq arg 'done) org-done-keywords)
4502 ((eq arg 'any)
4503 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4504 (setq todo-re
4505 (concat "^\\*+[ \t]+\\<\\("
4506 (mapconcat 'identity todo-wds "\\|")
4507 "\\)\\>"))
4508 (if (eq kw 'todo)
4509 (re-search-forward todo-re end t)
4510 (not (re-search-forward todo-re end t)))))
4512 ;;;###autoload
4513 (defun org-agenda-list-stuck-projects (&rest ignore)
4514 "Create agenda view for projects that are stuck.
4515 Stuck projects are project that have no next actions. For the definitions
4516 of what a project is and how to check if it stuck, customize the variable
4517 `org-stuck-projects'."
4518 (interactive)
4519 (let* ((org-agenda-skip-function
4520 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4521 ;; We could have used org-agenda-skip-if here.
4522 (org-agenda-overriding-header
4523 (or org-agenda-overriding-header "List of stuck projects: "))
4524 (matcher (nth 0 org-stuck-projects))
4525 (todo (nth 1 org-stuck-projects))
4526 (todo-wds (if (member "*" todo)
4527 (progn
4528 (org-prepare-agenda-buffers (org-agenda-files
4529 nil 'ifmode))
4530 (org-delete-all
4531 org-done-keywords-for-agenda
4532 (copy-sequence org-todo-keywords-for-agenda)))
4533 todo))
4534 (todo-re (concat "^\\*+[ \t]+\\("
4535 (mapconcat 'identity todo-wds "\\|")
4536 "\\)\\>"))
4537 (tags (nth 2 org-stuck-projects))
4538 (tags-re (if (member "*" tags)
4539 (concat org-outline-regexp-bol
4540 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4541 (if tags
4542 (concat org-outline-regexp-bol
4543 ".*:\\("
4544 (mapconcat 'identity tags "\\|")
4545 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4546 (gen-re (nth 3 org-stuck-projects))
4547 (re-list
4548 (delq nil
4549 (list
4550 (if todo todo-re)
4551 (if tags tags-re)
4552 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4553 gen-re)))))
4554 (setq org-agenda-skip-regexp
4555 (if re-list
4556 (mapconcat 'identity re-list "\\|")
4557 (error "No information how to identify unstuck projects")))
4558 (org-tags-view nil matcher)
4559 (with-current-buffer org-agenda-buffer-name
4560 (setq org-agenda-redo-command
4561 '(org-agenda-list-stuck-projects
4562 (or current-prefix-arg org-last-arg))))))
4564 ;;; Diary integration
4566 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4567 (defvar diary-list-entries-hook)
4568 (defvar diary-time-regexp)
4569 (defun org-get-entries-from-diary (date)
4570 "Get the (Emacs Calendar) diary entries for DATE."
4571 (require 'diary-lib)
4572 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4573 (diary-display-hook '(fancy-diary-display))
4574 (diary-display-function 'fancy-diary-display)
4575 (pop-up-frames nil)
4576 (diary-list-entries-hook
4577 (cons 'org-diary-default-entry diary-list-entries-hook))
4578 (diary-file-name-prefix-function nil) ; turn this feature off
4579 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4580 entries
4581 (org-disable-agenda-to-diary t))
4582 (save-excursion
4583 (save-window-excursion
4584 (funcall (if (fboundp 'diary-list-entries)
4585 'diary-list-entries 'list-diary-entries)
4586 date 1)))
4587 (if (not (get-buffer diary-fancy-buffer))
4588 (setq entries nil)
4589 (with-current-buffer diary-fancy-buffer
4590 (setq buffer-read-only nil)
4591 (if (zerop (buffer-size))
4592 ;; No entries
4593 (setq entries nil)
4594 ;; Omit the date and other unnecessary stuff
4595 (org-agenda-cleanup-fancy-diary)
4596 ;; Add prefix to each line and extend the text properties
4597 (if (zerop (buffer-size))
4598 (setq entries nil)
4599 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4600 (setq entries
4601 (with-temp-buffer
4602 (insert entries) (goto-char (point-min))
4603 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4604 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4605 (replace-match (concat "; " (match-string 1)))))
4606 (buffer-string)))))
4607 (set-buffer-modified-p nil)
4608 (kill-buffer diary-fancy-buffer)))
4609 (when entries
4610 (setq entries (org-split-string entries "\n"))
4611 (setq entries
4612 (mapcar
4613 (lambda (x)
4614 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4615 ;; Extend the text properties to the beginning of the line
4616 (org-add-props x (text-properties-at (1- (length x)) x)
4617 'type "diary" 'date date 'face 'org-agenda-diary))
4618 entries)))))
4620 (defvar org-agenda-cleanup-fancy-diary-hook nil
4621 "Hook run when the fancy diary buffer is cleaned up.")
4623 (defun org-agenda-cleanup-fancy-diary ()
4624 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4625 This gets rid of the date, the underline under the date, and
4626 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4627 date. It also removes lines that contain only whitespace."
4628 (goto-char (point-min))
4629 (if (looking-at ".*?:[ \t]*")
4630 (progn
4631 (replace-match "")
4632 (re-search-forward "\n=+$" nil t)
4633 (replace-match "")
4634 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4635 (re-search-forward "\n=+$" nil t)
4636 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4637 (goto-char (point-min))
4638 (while (re-search-forward "^ +\n" nil t)
4639 (replace-match ""))
4640 (goto-char (point-min))
4641 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4642 (replace-match ""))
4643 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4645 ;; Make sure entries from the diary have the right text properties.
4646 (eval-after-load "diary-lib"
4647 '(if (boundp 'diary-modify-entry-list-string-function)
4648 ;; We can rely on the hook, nothing to do
4650 ;; Hook not available, must use advice to make this work
4651 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4652 "Make the position visible."
4653 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4654 (stringp string)
4655 buffer-file-name)
4656 (setq string (org-modify-diary-entry-string string))))))
4658 (defun org-modify-diary-entry-string (string)
4659 "Add text properties to string, allowing org-mode to act on it."
4660 (org-add-props string nil
4661 'mouse-face 'highlight
4662 'help-echo (if buffer-file-name
4663 (format "mouse-2 or RET jump to diary file %s"
4664 (abbreviate-file-name buffer-file-name))
4666 'org-agenda-diary-link t
4667 'org-marker (org-agenda-new-marker (point-at-bol))))
4669 (defun org-diary-default-entry ()
4670 "Add a dummy entry to the diary.
4671 Needed to avoid empty dates which mess up holiday display."
4672 ;; Catch the error if dealing with the new add-to-diary-alist
4673 (when org-disable-agenda-to-diary
4674 (condition-case nil
4675 (org-add-to-diary-list original-date "Org-mode dummy" "")
4676 (error
4677 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4679 (defun org-add-to-diary-list (&rest args)
4680 (if (fboundp 'diary-add-to-list)
4681 (apply 'diary-add-to-list args)
4682 (apply 'add-to-diary-list args)))
4684 (defvar org-diary-last-run-time nil)
4686 ;;;###autoload
4687 (defun org-diary (&rest args)
4688 "Return diary information from org-files.
4689 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4690 It accesses org files and extracts information from those files to be
4691 listed in the diary. The function accepts arguments specifying what
4692 items should be listed. For a list of arguments allowed here, see the
4693 variable `org-agenda-entry-types'.
4695 The call in the diary file should look like this:
4697 &%%(org-diary) ~/path/to/some/orgfile.org
4699 Use a separate line for each org file to check. Or, if you omit the file name,
4700 all files listed in `org-agenda-files' will be checked automatically:
4702 &%%(org-diary)
4704 If you don't give any arguments (as in the example above), the default
4705 arguments (:deadline :scheduled :timestamp :sexp) are used.
4706 So the example above may also be written as
4708 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4710 The function expects the lisp variables `entry' and `date' to be provided
4711 by the caller, because this is how the calendar works. Don't use this
4712 function from a program - use `org-agenda-get-day-entries' instead."
4713 (when (> (- (org-float-time)
4714 org-agenda-last-marker-time)
4716 (org-agenda-reset-markers))
4717 (org-compile-prefix-format 'agenda)
4718 (org-set-sorting-strategy 'agenda)
4719 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4720 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4721 (list entry)
4722 (org-agenda-files t)))
4723 (time (org-float-time))
4724 file rtn results)
4725 (when (or (not org-diary-last-run-time)
4726 (> (- time
4727 org-diary-last-run-time)
4729 (org-prepare-agenda-buffers files))
4730 (setq org-diary-last-run-time time)
4731 ;; If this is called during org-agenda, don't return any entries to
4732 ;; the calendar. Org Agenda will list these entries itself.
4733 (if org-disable-agenda-to-diary (setq files nil))
4734 (while (setq file (pop files))
4735 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4736 (setq results (append results rtn)))
4737 (if results
4738 (concat (org-finalize-agenda-entries results) "\n"))))
4740 ;;; Agenda entry finders
4742 (defun org-agenda-get-day-entries (file date &rest args)
4743 "Does the work for `org-diary' and `org-agenda'.
4744 FILE is the path to a file to be checked for entries. DATE is date like
4745 the one returned by `calendar-current-date'. ARGS are symbols indicating
4746 which kind of entries should be extracted. For details about these, see
4747 the documentation of `org-diary'."
4748 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4749 (let* ((org-startup-folded nil)
4750 (org-startup-align-all-tables nil)
4751 (buffer (if (file-exists-p file)
4752 (org-get-agenda-file-buffer file)
4753 (error "No such file %s" file)))
4754 arg results rtn deadline-results)
4755 (if (not buffer)
4756 ;; If file does not exist, make sure an error message ends up in diary
4757 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4758 (with-current-buffer buffer
4759 (unless (eq major-mode 'org-mode)
4760 (error "Agenda file %s is not in `org-mode'" file))
4761 (let ((case-fold-search nil))
4762 (save-excursion
4763 (save-restriction
4764 (if org-agenda-restrict
4765 (narrow-to-region org-agenda-restrict-begin
4766 org-agenda-restrict-end)
4767 (widen))
4768 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4769 (while (setq arg (pop args))
4770 (cond
4771 ((and (eq arg :todo)
4772 (equal date (calendar-gregorian-from-absolute
4773 (org-today))))
4774 (setq rtn (org-agenda-get-todos))
4775 (setq results (append results rtn)))
4776 ((eq arg :timestamp)
4777 (setq rtn (org-agenda-get-blocks))
4778 (setq results (append results rtn))
4779 (setq rtn (org-agenda-get-timestamps))
4780 (setq results (append results rtn)))
4781 ((eq arg :sexp)
4782 (setq rtn (org-agenda-get-sexps))
4783 (setq results (append results rtn)))
4784 ((eq arg :scheduled)
4785 (setq rtn (org-agenda-get-scheduled deadline-results))
4786 (setq results (append results rtn)))
4787 ((eq arg :closed)
4788 (setq rtn (org-agenda-get-progress))
4789 (setq results (append results rtn)))
4790 ((eq arg :deadline)
4791 (setq rtn (org-agenda-get-deadlines))
4792 (setq deadline-results (copy-sequence rtn))
4793 (setq results (append results rtn))))))))
4794 results))))
4796 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4797 (defun org-agenda-get-todos ()
4798 "Return the TODO information for agenda display."
4799 (let* ((props (list 'face nil
4800 'done-face 'org-agenda-done
4801 'org-not-done-regexp org-not-done-regexp
4802 'org-todo-regexp org-todo-regexp
4803 'org-complex-heading-regexp org-complex-heading-regexp
4804 'mouse-face 'highlight
4805 'help-echo
4806 (format "mouse-2 or RET jump to org file %s"
4807 (abbreviate-file-name buffer-file-name))))
4808 (regexp (format org-heading-keyword-regexp-format
4809 (cond
4810 ((and org-select-this-todo-keyword
4811 (equal org-select-this-todo-keyword "*"))
4812 org-todo-regexp)
4813 (org-select-this-todo-keyword
4814 (concat "\\("
4815 (mapconcat 'identity
4816 (org-split-string
4817 org-select-this-todo-keyword
4818 "|")
4819 "\\|") "\\)"))
4820 (t org-not-done-regexp))))
4821 marker priority category org-category-pos tags todo-state
4822 ee txt beg end)
4823 (goto-char (point-min))
4824 (while (re-search-forward regexp nil t)
4825 (catch :skip
4826 (save-match-data
4827 (beginning-of-line)
4828 (org-agenda-skip)
4829 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4830 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
4831 (goto-char (1+ beg))
4832 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
4833 (throw :skip nil)))
4834 (goto-char (match-beginning 2))
4835 (setq marker (org-agenda-new-marker (match-beginning 0))
4836 category (org-get-category)
4837 org-category-pos (get-text-property (point) 'org-category-position)
4838 txt (org-trim
4839 (buffer-substring (match-beginning 2) (match-end 0)))
4840 tags (org-get-tags-at (point))
4841 txt (org-agenda-format-item "" txt category tags)
4842 priority (1+ (org-get-priority txt))
4843 todo-state (org-get-todo-state))
4844 (org-add-props txt props
4845 'org-marker marker 'org-hd-marker marker
4846 'priority priority 'org-category category
4847 'org-category-position org-category-pos
4848 'type "todo" 'todo-state todo-state)
4849 (push txt ee)
4850 (if org-agenda-todo-list-sublevels
4851 (goto-char (match-end 2))
4852 (org-end-of-subtree 'invisible))))
4853 (nreverse ee)))
4855 (defun org-agenda-todo-custom-ignore-p (time n)
4856 "Check whether timestamp is farther away then n number of days.
4857 This function is invoked if `org-agenda-todo-ignore-deadlines',
4858 `org-agenda-todo-ignore-scheduled' or
4859 `org-agenda-todo-ignore-timestamp' is set to an integer."
4860 (let ((days (org-days-to-time time)))
4861 (if (>= n 0)
4862 (>= days n)
4863 (<= days n))))
4865 ;;;###autoload
4866 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4867 (&optional end)
4868 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
4869 (when (or org-agenda-todo-ignore-with-date
4870 org-agenda-todo-ignore-scheduled
4871 org-agenda-todo-ignore-deadlines
4872 org-agenda-todo-ignore-timestamp)
4873 (setq end (or end (save-excursion (outline-next-heading) (point))))
4874 (save-excursion
4875 (or (and org-agenda-todo-ignore-with-date
4876 (re-search-forward org-ts-regexp end t))
4877 (and org-agenda-todo-ignore-scheduled
4878 (re-search-forward org-scheduled-time-regexp end t)
4879 (cond
4880 ((eq org-agenda-todo-ignore-scheduled 'future)
4881 (> (org-days-to-time (match-string 1)) 0))
4882 ((eq org-agenda-todo-ignore-scheduled 'past)
4883 (<= (org-days-to-time (match-string 1)) 0))
4884 ((numberp org-agenda-todo-ignore-scheduled)
4885 (org-agenda-todo-custom-ignore-p
4886 (match-string 1) org-agenda-todo-ignore-scheduled))
4887 (t)))
4888 (and org-agenda-todo-ignore-deadlines
4889 (re-search-forward org-deadline-time-regexp end t)
4890 (cond
4891 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
4892 ((eq org-agenda-todo-ignore-deadlines 'far)
4893 (not (org-deadline-close (match-string 1))))
4894 ((eq org-agenda-todo-ignore-deadlines 'future)
4895 (> (org-days-to-time (match-string 1)) 0))
4896 ((eq org-agenda-todo-ignore-deadlines 'past)
4897 (<= (org-days-to-time (match-string 1)) 0))
4898 ((numberp org-agenda-todo-ignore-deadlines)
4899 (org-agenda-todo-custom-ignore-p
4900 (match-string 1) org-agenda-todo-ignore-deadlines))
4901 (t (org-deadline-close (match-string 1)))))
4902 (and org-agenda-todo-ignore-timestamp
4903 (let ((buffer (current-buffer))
4904 (regexp
4905 (concat
4906 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
4907 (start (point)))
4908 ;; Copy current buffer into a temporary one
4909 (with-temp-buffer
4910 (insert-buffer-substring buffer start end)
4911 (goto-char (point-min))
4912 ;; Delete SCHEDULED and DEADLINE items
4913 (while (re-search-forward regexp end t)
4914 (delete-region (match-beginning 0) (match-end 0)))
4915 (goto-char (point-min))
4916 ;; No search for timestamp left
4917 (when (re-search-forward org-ts-regexp nil t)
4918 (cond
4919 ((eq org-agenda-todo-ignore-timestamp 'future)
4920 (> (org-days-to-time (match-string 1)) 0))
4921 ((eq org-agenda-todo-ignore-timestamp 'past)
4922 (<= (org-days-to-time (match-string 1)) 0))
4923 ((numberp org-agenda-todo-ignore-timestamp)
4924 (org-agenda-todo-custom-ignore-p
4925 (match-string 1) org-agenda-todo-ignore-timestamp))
4926 (t))))))))))
4928 (defconst org-agenda-no-heading-message
4929 "No heading for this item in buffer or region.")
4931 (defun org-agenda-get-timestamps ()
4932 "Return the date stamp information for agenda display."
4933 (let* ((props (list 'face 'org-agenda-calendar-event
4934 'org-not-done-regexp org-not-done-regexp
4935 'org-todo-regexp org-todo-regexp
4936 'org-complex-heading-regexp org-complex-heading-regexp
4937 'mouse-face 'highlight
4938 'help-echo
4939 (format "mouse-2 or RET jump to org file %s"
4940 (abbreviate-file-name buffer-file-name))))
4941 (d1 (calendar-absolute-from-gregorian date))
4942 (remove-re
4943 (concat
4944 (regexp-quote
4945 (format-time-string
4946 "<%Y-%m-%d"
4947 (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
4948 ".*?>"))
4949 (regexp
4950 (concat
4951 (if org-agenda-include-inactive-timestamps "[[<]" "<")
4952 (regexp-quote
4953 (substring
4954 (format-time-string
4955 (car org-time-stamp-formats)
4956 (apply 'encode-time ; DATE bound by calendar
4957 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
4958 1 11))
4959 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
4960 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
4961 marker hdmarker deadlinep scheduledp clockp closedp inactivep
4962 donep tmp priority category org-category-pos ee txt timestr tags
4963 b0 b3 e3 head todo-state end-of-match show-all)
4964 (goto-char (point-min))
4965 (while (setq end-of-match (re-search-forward regexp nil t))
4966 (setq b0 (match-beginning 0)
4967 b3 (match-beginning 3) e3 (match-end 3)
4968 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
4969 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
4970 (member todo-state
4971 org-agenda-repeating-timestamp-show-all)))
4972 (catch :skip
4973 (and (org-at-date-range-p) (throw :skip nil))
4974 (org-agenda-skip)
4975 (if (and (match-end 1)
4976 (not (= d1 (org-time-string-to-absolute
4977 (match-string 1) d1 nil show-all
4978 (current-buffer) b0))))
4979 (throw :skip nil))
4980 (if (and e3
4981 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
4982 (throw :skip nil))
4983 (setq tmp (buffer-substring (max (point-min)
4984 (- b0 org-ds-keyword-length))
4986 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
4987 inactivep (= (char-after b0) ?\[)
4988 deadlinep (string-match org-deadline-regexp tmp)
4989 scheduledp (string-match org-scheduled-regexp tmp)
4990 closedp (and org-agenda-include-inactive-timestamps
4991 (string-match org-closed-string tmp))
4992 clockp (and org-agenda-include-inactive-timestamps
4993 (or (string-match org-clock-string tmp)
4994 (string-match "]-+\\'" tmp)))
4995 donep (member todo-state org-done-keywords))
4996 (if (or scheduledp deadlinep closedp clockp
4997 (and donep org-agenda-skip-timestamp-if-done))
4998 (throw :skip t))
4999 (if (string-match ">" timestr)
5000 ;; substring should only run to end of time stamp
5001 (setq timestr (substring timestr 0 (match-end 0))))
5002 (setq marker (org-agenda-new-marker b0)
5003 category (org-get-category b0)
5004 org-category-pos (get-text-property b0 'org-category-position))
5005 (save-excursion
5006 (if (not (re-search-backward org-outline-regexp-bol nil t))
5007 (setq txt org-agenda-no-heading-message)
5008 (goto-char (match-beginning 0))
5009 (setq hdmarker (org-agenda-new-marker)
5010 tags (org-get-tags-at))
5011 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5012 (setq head (or (match-string 1) ""))
5013 (setq txt (org-agenda-format-item
5014 (if inactivep org-agenda-inactive-leader nil)
5015 head category tags timestr
5016 remove-re)))
5017 (setq priority (org-get-priority txt))
5018 (org-add-props txt props
5019 'org-marker marker 'org-hd-marker hdmarker)
5020 (org-add-props txt nil 'priority priority
5021 'org-category category 'date date
5022 'org-category-position org-category-pos
5023 'todo-state todo-state
5024 'type "timestamp")
5025 (push txt ee))
5026 (if org-agenda-skip-additional-timestamps-same-entry
5027 (outline-next-heading)
5028 (goto-char end-of-match))))
5029 (nreverse ee)))
5031 (defun org-agenda-get-sexps ()
5032 "Return the sexp information for agenda display."
5033 (require 'diary-lib)
5034 (let* ((props (list 'face 'org-agenda-calendar-sexp
5035 'mouse-face 'highlight
5036 'help-echo
5037 (format "mouse-2 or RET jump to org file %s"
5038 (abbreviate-file-name buffer-file-name))))
5039 (regexp "^&?%%(")
5040 marker category org-category-pos ee txt tags entry
5041 result beg b sexp sexp-entry todo-state)
5042 (goto-char (point-min))
5043 (while (re-search-forward regexp nil t)
5044 (catch :skip
5045 (org-agenda-skip)
5046 (setq beg (match-beginning 0))
5047 (goto-char (1- (match-end 0)))
5048 (setq b (point))
5049 (forward-sexp 1)
5050 (setq sexp (buffer-substring b (point)))
5051 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5052 (org-trim (match-string 1))
5053 ""))
5054 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5055 (when result
5056 (setq marker (org-agenda-new-marker beg)
5057 category (org-get-category beg)
5058 org-category-pos (get-text-property beg 'org-category-position)
5059 todo-state (org-get-todo-state))
5061 (dolist (r (if (stringp result)
5062 (list result)
5063 result)) ;; we expect a list here
5064 (if (string-match "\\S-" r)
5065 (setq txt r)
5066 (setq txt "SEXP entry returned empty string"))
5068 (setq txt (org-agenda-format-item
5069 "" txt category tags 'time))
5070 (org-add-props txt props 'org-marker marker)
5071 (org-add-props txt nil
5072 'org-category category 'date date 'todo-state todo-state
5073 'org-category-position org-category-pos
5074 'type "sexp")
5075 (push txt ee)))))
5076 (nreverse ee)))
5078 ;; Calendar sanity: define some functions that are independent of
5079 ;; `calendar-date-style'.
5080 ;; Normally I would like to use ISO format when calling the diary functions,
5081 ;; but to make sure we still have Emacs 22 compatibility we bind
5082 ;; also `european-calendar-style' and use european format
5083 (defun org-anniversary (year month day &optional mark)
5084 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5085 (org-no-warnings
5086 (let ((calendar-date-style 'european) (european-calendar-style t))
5087 (diary-anniversary day month year mark))))
5088 (defun org-cyclic (N year month day &optional mark)
5089 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5090 (org-no-warnings
5091 (let ((calendar-date-style 'european) (european-calendar-style t))
5092 (diary-cyclic N day month year mark))))
5093 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5094 "Like `diary-block', but with fixed (ISO) order of arguments."
5095 (org-no-warnings
5096 (let ((calendar-date-style 'european) (european-calendar-style t))
5097 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5098 (defun org-date (year month day &optional mark)
5099 "Like `diary-date', but with fixed (ISO) order of arguments."
5100 (org-no-warnings
5101 (let ((calendar-date-style 'european) (european-calendar-style t))
5102 (diary-date day month year mark))))
5103 (defalias 'org-float 'diary-float)
5105 ;; Define the` org-class' function
5106 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5107 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5108 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5109 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5110 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5111 `holidays', then any date that is known by the Emacs calendar to be a
5112 holiday will also be skipped."
5113 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5114 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5115 (d (calendar-absolute-from-gregorian date)))
5116 (and
5117 (<= date1 d)
5118 (<= d date2)
5119 (= (calendar-day-of-week date) dayname)
5120 (or (not skip-weeks)
5121 (progn
5122 (require 'cal-iso)
5123 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5124 (not (and (memq 'holidays skip-weeks)
5125 (calendar-check-holidays date)))
5126 entry)))
5128 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5129 "Like `org-class', but honor `calendar-date-style'.
5130 The order of the first 2 times 3 arguments depends on the variable
5131 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5132 So for American calendars, give this as MONTH DAY YEAR, for European as
5133 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5134 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5135 is any number of ISO weeks in the block period for which the item should
5136 be skipped.
5138 This function is here only for backward compatibility and it is deprecated,
5139 please use `org-class' instead."
5140 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5141 (date2 (org-order-calendar-date-args m2 d2 y2)))
5142 (org-class
5143 (nth 2 date1) (car date1) (nth 1 date1)
5144 (nth 2 date2) (car date2) (nth 1 date2)
5145 dayname skip-weeks)))
5146 (make-obsolete 'org-diary-class 'org-class "")
5148 (defalias 'org-get-closed 'org-agenda-get-progress)
5149 (defun org-agenda-get-progress ()
5150 "Return the logged TODO entries for agenda display."
5151 (let* ((props (list 'mouse-face 'highlight
5152 'org-not-done-regexp org-not-done-regexp
5153 'org-todo-regexp org-todo-regexp
5154 'org-complex-heading-regexp org-complex-heading-regexp
5155 'help-echo
5156 (format "mouse-2 or RET jump to org file %s"
5157 (abbreviate-file-name buffer-file-name))))
5158 (items (if (consp org-agenda-show-log)
5159 org-agenda-show-log
5160 (if (eq org-agenda-show-log 'clockcheck)
5161 '(clock)
5162 org-agenda-log-mode-items)))
5163 (parts
5164 (delq nil
5165 (list
5166 (if (memq 'closed items) (concat "\\<" org-closed-string))
5167 (if (memq 'clock items) (concat "\\<" org-clock-string))
5168 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5169 (parts-re (if parts (mapconcat 'identity parts "\\|")
5170 (error "`org-agenda-log-mode-items' is empty")))
5171 (regexp (concat
5172 "\\(" parts-re "\\)"
5173 " *\\["
5174 (regexp-quote
5175 (substring
5176 (format-time-string
5177 (car org-time-stamp-formats)
5178 (apply 'encode-time ; DATE bound by calendar
5179 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5180 1 11))))
5181 (org-agenda-search-headline-for-time nil)
5182 marker hdmarker priority category org-category-pos tags closedp
5183 statep clockp state ee txt extra timestr rest clocked)
5184 (goto-char (point-min))
5185 (while (re-search-forward regexp nil t)
5186 (catch :skip
5187 (org-agenda-skip)
5188 (setq marker (org-agenda-new-marker (match-beginning 0))
5189 closedp (equal (match-string 1) org-closed-string)
5190 statep (equal (string-to-char (match-string 1)) ?-)
5191 clockp (not (or closedp statep))
5192 state (and statep (match-string 2))
5193 category (org-get-category (match-beginning 0))
5194 org-category-pos (get-text-property (match-beginning 0) 'org-category-position)
5195 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5196 (when (string-match "\\]" timestr)
5197 ;; substring should only run to end of time stamp
5198 (setq rest (substring timestr (match-end 0))
5199 timestr (substring timestr 0 (match-end 0)))
5200 (if (and (not closedp) (not statep)
5201 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5202 rest))
5203 (progn (setq timestr (concat (substring timestr 0 -1)
5204 "-" (match-string 1 rest) "]"))
5205 (setq clocked (match-string 2 rest)))
5206 (setq clocked "-")))
5207 (save-excursion
5208 (setq extra
5209 (cond
5210 ((not org-agenda-log-mode-add-notes) nil)
5211 (statep
5212 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5213 (match-string 1)))
5214 (clockp
5215 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5216 (match-string 1)))))
5217 (if (not (re-search-backward org-outline-regexp-bol nil t))
5218 (setq txt org-agenda-no-heading-message)
5219 (goto-char (match-beginning 0))
5220 (setq hdmarker (org-agenda-new-marker)
5221 tags (org-get-tags-at))
5222 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5223 (setq txt (match-string 1))
5224 (when extra
5225 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5226 (setq txt (concat (substring txt 0 (match-beginning 1))
5227 " - " extra " " (match-string 2 txt)))
5228 (setq txt (concat txt " - " extra))))
5229 (setq txt (org-agenda-format-item
5230 (cond
5231 (closedp "Closed: ")
5232 (statep (concat "State: (" state ")"))
5233 (t (concat "Clocked: (" clocked ")")))
5234 txt category tags timestr)))
5235 (setq priority 100000)
5236 (org-add-props txt props
5237 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5238 'priority priority 'org-category category
5239 'org-category-position org-category-pos
5240 'type "closed" 'date date
5241 'undone-face 'org-warning 'done-face 'org-agenda-done)
5242 (push txt ee))
5243 (goto-char (point-at-eol))))
5244 (nreverse ee)))
5246 (defun org-agenda-show-clocking-issues ()
5247 "Add overlays, showing issues with clocking.
5248 See also the user option `org-agenda-clock-consistency-checks'."
5249 (interactive)
5250 (let* ((pl org-agenda-clock-consistency-checks)
5251 (re (concat "^[ \t]*"
5252 org-clock-string
5253 "[ \t]+"
5254 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5255 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5256 (tlstart 0.)
5257 (tlend 0.)
5258 (maxtime (org-hh:mm-string-to-minutes
5259 (or (plist-get pl :max-duration) "24:00")))
5260 (mintime (org-hh:mm-string-to-minutes
5261 (or (plist-get pl :min-duration) 0)))
5262 (maxgap (org-hh:mm-string-to-minutes
5263 ;; default 30:00 means never complain
5264 (or (plist-get pl :max-gap) "30:00")))
5265 (gapok (mapcar 'org-hh:mm-string-to-minutes
5266 (plist-get pl :gap-ok-around)))
5267 (def-face (or (plist-get pl :default-face)
5268 '((:background "DarkRed") (:foreground "white"))))
5269 issue face m te ts dt ov)
5270 (goto-char (point-min))
5271 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5272 (setq issue nil face def-face)
5273 (catch 'next
5274 (setq m (org-get-at-bol 'org-marker)
5275 te nil ts nil)
5276 (unless (and m (markerp m))
5277 (setq issue "No valid clock line") (throw 'next t))
5278 (org-with-point-at m
5279 (save-excursion
5280 (goto-char (point-at-bol))
5281 (unless (looking-at re)
5282 (error "No valid Clock line")
5283 (throw 'next t))
5284 (unless (match-end 3)
5285 (setq issue "No end time"
5286 face (or (plist-get pl :no-end-time-face) face))
5287 (throw 'next t))
5288 (setq ts (match-string 1)
5289 te (match-string 3)
5290 ts (org-float-time
5291 (apply 'encode-time (org-parse-time-string ts)))
5292 te (org-float-time
5293 (apply 'encode-time (org-parse-time-string te)))
5294 dt (- te ts))))
5295 (cond
5296 ((> dt (* 60 maxtime))
5297 ;; a very long clocking chunk
5298 (setq issue (format "Clocking interval is very long: %s"
5299 (org-minutes-to-hh:mm-string
5300 (floor (/ (float dt) 60.))))
5301 face (or (plist-get pl :long-face) face)))
5302 ((< dt (* 60 mintime))
5303 ;; a very short clocking chunk
5304 (setq issue (format "Clocking interval is very short: %s"
5305 (org-minutes-to-hh:mm-string
5306 (floor (/ (float dt) 60.))))
5307 face (or (plist-get pl :short-face) face)))
5308 ((and (> tlend 0) (< ts tlend))
5309 ;; Two clock entries are overlapping
5310 (setq issue (format "Clocking overlap: %d minutes"
5311 (/ (- tlend ts) 60))
5312 face (or (plist-get pl :overlap-face) face)))
5313 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5314 ;; There is a gap, lets see if we need to report it
5315 (unless (org-agenda-check-clock-gap tlend ts gapok)
5316 (setq issue (format "Clocking gap: %d minutes"
5317 (/ (- ts tlend) 60))
5318 face (or (plist-get pl :gap-face) face))))
5319 (t nil)))
5320 (setq tlend (or te tlend) tlstart (or ts tlstart))
5321 (when issue
5322 ;; OK, there was some issue, add an overlay to show the issue
5323 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5324 (overlay-put ov 'before-string
5325 (concat
5326 (org-add-props
5327 (format "%-43s" (concat " " issue))
5329 'face face)
5330 "\n"))
5331 (overlay-put ov 'evaporate t)))))
5333 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5334 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5335 (catch 'exit
5336 (unless ok-list
5337 ;; there are no OK times for gaps...
5338 (throw 'exit nil))
5339 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5340 ;; This is more than 24 hours, so it is OK.
5341 ;; because we have at least one OK time, that must be in the
5342 ;; 24 hour interval.
5343 (throw 'exit t))
5344 ;; We have a shorter gap.
5345 ;; Now we have to get the minute of the day when these times are
5346 (let* ((t1dec (decode-time (seconds-to-time t1)))
5347 (t2dec (decode-time (seconds-to-time t2)))
5348 ;; compute the minute on the day
5349 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5350 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5351 (when (< min2 min1)
5352 ;; if min2 is smaller than min1, this means it is on the next day.
5353 ;; Wrap it to after midnight.
5354 (setq min2 (+ min2 1440)))
5355 ;; Now check if any of the OK times is in the gap
5356 (mapc (lambda (x)
5357 ;; Wrap the time to after midnight if necessary
5358 (if (< x min1) (setq x (+ x 1440)))
5359 ;; Check if in interval
5360 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5361 ok-list)
5362 ;; Nope, this gap is not OK
5363 nil)))
5365 (defun org-agenda-get-deadlines ()
5366 "Return the deadline information for agenda display."
5367 (let* ((props (list 'mouse-face 'highlight
5368 'org-not-done-regexp org-not-done-regexp
5369 'org-todo-regexp org-todo-regexp
5370 'org-complex-heading-regexp org-complex-heading-regexp
5371 'help-echo
5372 (format "mouse-2 or RET jump to org file %s"
5373 (abbreviate-file-name buffer-file-name))))
5374 (regexp org-deadline-time-regexp)
5375 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5376 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5377 d2 diff dfrac wdays pos pos1 category org-category-pos
5378 tags suppress-prewarning ee txt head face s todo-state
5379 show-all upcomingp donep timestr)
5380 (goto-char (point-min))
5381 (while (re-search-forward regexp nil t)
5382 (setq suppress-prewarning nil)
5383 (catch :skip
5384 (org-agenda-skip)
5385 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5386 (save-match-data
5387 (string-match org-scheduled-time-regexp
5388 (buffer-substring (point-at-bol)
5389 (point-at-eol)))))
5390 (setq suppress-prewarning
5391 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5392 org-agenda-skip-deadline-prewarning-if-scheduled
5393 0)))
5394 (setq s (match-string 1)
5395 txt nil
5396 pos (1- (match-beginning 1))
5397 todo-state (save-match-data (org-get-todo-state))
5398 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5399 (member todo-state
5400 org-agenda-repeating-timestamp-show-all))
5401 d2 (org-time-string-to-absolute
5402 (match-string 1) d1 'past show-all
5403 (current-buffer) pos)
5404 diff (- d2 d1)
5405 wdays (if suppress-prewarning
5406 (let ((org-deadline-warning-days suppress-prewarning))
5407 (org-get-wdays s))
5408 (org-get-wdays s))
5409 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5410 upcomingp (and todayp (> diff 0)))
5411 ;; When to show a deadline in the calendar:
5412 ;; If the expiration is within wdays warning time.
5413 ;; Past-due deadlines are only shown on the current date
5414 (if (and (or (and (<= diff wdays)
5415 (and todayp (not org-agenda-only-exact-dates)))
5416 (= diff 0)))
5417 (save-excursion
5418 ;; (setq todo-state (org-get-todo-state))
5419 (setq donep (member todo-state org-done-keywords))
5420 (if (and donep
5421 (or org-agenda-skip-deadline-if-done
5422 (not (= diff 0))))
5423 (setq txt nil)
5424 (setq category (org-get-category)
5425 org-category-pos (get-text-property (point) 'org-category-position))
5426 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5427 (setq txt org-agenda-no-heading-message)
5428 (goto-char (match-end 0))
5429 (setq pos1 (match-beginning 0))
5430 (setq tags (org-get-tags-at pos1))
5431 (setq head (buffer-substring-no-properties
5432 (point)
5433 (progn (skip-chars-forward "^\r\n")
5434 (point))))
5435 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5436 (setq timestr
5437 (concat (substring s (match-beginning 1)) " "))
5438 (setq timestr 'time))
5439 (setq txt (org-agenda-format-item
5440 (if (= diff 0)
5441 (car org-agenda-deadline-leaders)
5442 (if (functionp
5443 (nth 1 org-agenda-deadline-leaders))
5444 (funcall
5445 (nth 1 org-agenda-deadline-leaders)
5446 diff date)
5447 (format (nth 1 org-agenda-deadline-leaders)
5448 diff)))
5449 head category tags
5450 (if (not (= diff 0)) nil timestr)))))
5451 (when txt
5452 (setq face (org-agenda-deadline-face dfrac))
5453 (org-add-props txt props
5454 'org-marker (org-agenda-new-marker pos)
5455 'org-hd-marker (org-agenda-new-marker pos1)
5456 'priority (+ (- diff)
5457 (org-get-priority txt))
5458 'org-category category
5459 'org-category-position org-category-pos
5460 'todo-state todo-state
5461 'type (if upcomingp "upcoming-deadline" "deadline")
5462 'date (if upcomingp date d2)
5463 'face (if donep 'org-agenda-done face)
5464 'undone-face face 'done-face 'org-agenda-done)
5465 (push txt ee))))))
5466 (nreverse ee)))
5468 (defun org-agenda-deadline-face (fraction)
5469 "Return the face to displaying a deadline item.
5470 FRACTION is what fraction of the head-warning time has passed."
5471 (let ((faces org-agenda-deadline-faces) f)
5472 (catch 'exit
5473 (while (setq f (pop faces))
5474 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5476 (defun org-agenda-get-scheduled (&optional deadline-results)
5477 "Return the scheduled information for agenda display."
5478 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5479 'org-todo-regexp org-todo-regexp
5480 'org-complex-heading-regexp org-complex-heading-regexp
5481 'done-face 'org-agenda-done
5482 'mouse-face 'highlight
5483 'help-echo
5484 (format "mouse-2 or RET jump to org file %s"
5485 (abbreviate-file-name buffer-file-name))))
5486 (regexp org-scheduled-time-regexp)
5487 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5488 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5490 (deadline-position-alist
5491 (mapcar (lambda (a) (and (setq mm (get-text-property
5492 0 'org-hd-marker a))
5493 (cons (marker-position mm) a)))
5494 deadline-results))
5495 d2 diff pos pos1 category org-category-pos tags donep
5496 ee txt head pastschedp todo-state face timestr s habitp show-all)
5497 (goto-char (point-min))
5498 (while (re-search-forward regexp nil t)
5499 (catch :skip
5500 (org-agenda-skip)
5501 (setq s (match-string 1)
5502 txt nil
5503 pos (1- (match-beginning 1))
5504 todo-state (save-match-data (org-get-todo-state))
5505 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5506 (member todo-state
5507 org-agenda-repeating-timestamp-show-all))
5508 d2 (org-time-string-to-absolute
5509 (match-string 1) d1 'past show-all
5510 (current-buffer) pos)
5511 diff (- d2 d1))
5512 (setq pastschedp (and todayp (< diff 0)))
5513 ;; When to show a scheduled item in the calendar:
5514 ;; If it is on or past the date.
5515 (when (or (and (< diff 0)
5516 (< (abs diff) org-scheduled-past-days)
5517 (and todayp (not org-agenda-only-exact-dates)))
5518 (= diff 0))
5519 (save-excursion
5520 (setq donep (member todo-state org-done-keywords))
5521 (if (and donep
5522 (or org-agenda-skip-scheduled-if-done
5523 (not (= diff 0))
5524 (and (functionp 'org-is-habit-p)
5525 (org-is-habit-p))))
5526 (setq txt nil)
5527 (setq habitp (and (functionp 'org-is-habit-p)
5528 (org-is-habit-p)))
5529 (setq category (org-get-category)
5530 org-category-pos (get-text-property (point) 'org-category-position))
5531 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5532 (setq txt org-agenda-no-heading-message)
5533 (goto-char (match-end 0))
5534 (setq pos1 (match-beginning 0))
5535 (if habitp
5536 (if (or (not org-habit-show-habits)
5537 (and (not todayp)
5538 org-habit-show-habits-only-for-today))
5539 (throw :skip nil))
5540 (if (and
5541 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5542 (and org-agenda-skip-scheduled-if-deadline-is-shown
5543 pastschedp))
5544 (setq mm (assoc pos1 deadline-position-alist)))
5545 (throw :skip nil)))
5546 (setq tags (org-get-tags-at))
5547 (setq head (buffer-substring-no-properties
5548 (point)
5549 (progn (skip-chars-forward "^\r\n") (point))))
5550 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5551 (setq timestr
5552 (concat (substring s (match-beginning 1)) " "))
5553 (setq timestr 'time))
5554 (setq txt (org-agenda-format-item
5555 (if (= diff 0)
5556 (car org-agenda-scheduled-leaders)
5557 (format (nth 1 org-agenda-scheduled-leaders)
5558 (- 1 diff)))
5559 head category tags
5560 (if (not (= diff 0)) nil timestr)
5561 nil habitp))))
5562 (when txt
5563 (setq face
5564 (cond
5565 ((and (not habitp) pastschedp)
5566 'org-scheduled-previously)
5567 (todayp 'org-scheduled-today)
5568 (t 'org-scheduled))
5569 habitp (and habitp (org-habit-parse-todo)))
5570 (org-add-props txt props
5571 'undone-face face
5572 'face (if donep 'org-agenda-done face)
5573 'org-marker (org-agenda-new-marker pos)
5574 'org-hd-marker (org-agenda-new-marker pos1)
5575 'type (if pastschedp "past-scheduled" "scheduled")
5576 'date (if pastschedp d2 date)
5577 'priority (if habitp
5578 (org-habit-get-priority habitp)
5579 (+ 94 (- 5 diff) (org-get-priority txt)))
5580 'org-category category
5581 'org-category-position org-category-pos
5582 'org-habit-p habitp
5583 'todo-state todo-state)
5584 (push txt ee))))))
5585 (nreverse ee)))
5587 (defun org-agenda-get-blocks ()
5588 "Return the date-range information for agenda display."
5589 (let* ((props (list 'face nil
5590 'org-not-done-regexp org-not-done-regexp
5591 'org-todo-regexp org-todo-regexp
5592 'org-complex-heading-regexp org-complex-heading-regexp
5593 'mouse-face 'highlight
5594 'help-echo
5595 (format "mouse-2 or RET jump to org file %s"
5596 (abbreviate-file-name buffer-file-name))))
5597 (regexp org-tr-regexp)
5598 (d0 (calendar-absolute-from-gregorian date))
5599 marker hdmarker ee txt d1 d2 s1 s2 category org-category-pos
5600 todo-state tags pos head donep)
5601 (goto-char (point-min))
5602 (while (re-search-forward regexp nil t)
5603 (catch :skip
5604 (org-agenda-skip)
5605 (setq pos (point))
5606 (let ((start-time (match-string 1))
5607 (end-time (match-string 2)))
5608 (setq s1 (match-string 1)
5609 s2 (match-string 2)
5610 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5611 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5612 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5613 ;; Only allow days between the limits, because the normal
5614 ;; date stamps will catch the limits.
5615 (save-excursion
5616 (setq todo-state (org-get-todo-state))
5617 (setq donep (member todo-state org-done-keywords))
5618 (if (and donep org-agenda-skip-timestamp-if-done)
5619 (throw :skip t))
5620 (setq marker (org-agenda-new-marker (point)))
5621 (setq category (org-get-category)
5622 org-category-pos (get-text-property (point) 'org-category-position))
5623 (if (not (re-search-backward org-outline-regexp-bol nil t))
5624 (setq txt org-agenda-no-heading-message)
5625 (goto-char (match-beginning 0))
5626 (setq hdmarker (org-agenda-new-marker (point)))
5627 (setq tags (org-get-tags-at))
5628 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5629 (setq head (match-string 1))
5630 (let ((remove-re
5631 (if org-agenda-remove-timeranges-from-blocks
5632 (concat
5633 "<" (regexp-quote s1) ".*?>"
5634 "--"
5635 "<" (regexp-quote s2) ".*?>")
5636 nil)))
5637 (setq txt (org-agenda-format-item
5638 (format
5639 (nth (if (= d1 d2) 0 1)
5640 org-agenda-timerange-leaders)
5641 (1+ (- d0 d1)) (1+ (- d2 d1)))
5642 head category tags
5643 (cond ((and (= d1 d0) (= d2 d0))
5644 (concat "<" start-time ">--<" end-time ">"))
5645 ((= d1 d0)
5646 (concat "<" start-time ">"))
5647 ((= d2 d0)
5648 (concat "<" end-time ">"))
5649 (t nil))
5650 remove-re))))
5651 (org-add-props txt props
5652 'org-marker marker 'org-hd-marker hdmarker
5653 'type "block" 'date date
5654 'todo-state todo-state
5655 'priority (org-get-priority txt) 'org-category category
5656 'org-category-position org-category-pos)
5657 (push txt ee))))
5658 (goto-char pos)))
5659 ;; Sort the entries by expiration date.
5660 (nreverse ee)))
5662 ;;; Agenda presentation and sorting
5664 (defvar org-prefix-has-time nil
5665 "A flag, set by `org-compile-prefix-format'.
5666 The flag is set if the currently compiled format contains a `%t'.")
5667 (defvar org-prefix-has-tag nil
5668 "A flag, set by `org-compile-prefix-format'.
5669 The flag is set if the currently compiled format contains a `%T'.")
5670 (defvar org-prefix-has-effort nil
5671 "A flag, set by `org-compile-prefix-format'.
5672 The flag is set if the currently compiled format contains a `%e'.")
5673 (defvar org-prefix-category-length nil
5674 "Used by `org-compile-prefix-format' to remember the category field width.")
5675 (defvar org-prefix-category-max-length nil
5676 "Used by `org-compile-prefix-format' to remember the category field width.")
5678 (defun org-agenda-get-category-icon (category)
5679 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5680 (dolist (entry org-agenda-category-icon-alist)
5681 (when (org-string-match-p (car entry) category)
5682 (if (listp (cadr entry))
5683 (return (cadr entry))
5684 (return (apply 'create-image (cdr entry)))))))
5686 (defun org-agenda-format-item (extra txt &optional category tags dotime
5687 remove-re habitp)
5688 "Format TXT to be inserted into the agenda buffer.
5689 In particular, it adds the prefix and corresponding text properties. EXTRA
5690 must be a string and replaces the `%s' specifier in the prefix format.
5691 CATEGORY (string, symbol or nil) may be used to overrule the default
5692 category taken from local variable or file name. It will replace the `%c'
5693 specifier in the format. DOTIME, when non-nil, indicates that a
5694 time-of-day should be extracted from TXT for sorting of this entry, and for
5695 the `%t' specifier in the format. When DOTIME is a string, this string is
5696 searched for a time before TXT is. TAGS can be the tags of the headline.
5697 Any match of REMOVE-RE will be removed from TXT."
5698 ;; We keep the org-prefix-* variable values along with a compiled
5699 ;; formatter, so that multiple agendas existing at the same time, do
5700 ;; not step on each other toes.
5702 ;; It was inconvenient to make these variables buffer local in
5703 ;; Agenda buffers, because this function expects to be called with
5704 ;; the buffer where item comes from being current, and not agenda
5705 ;; buffer
5706 (let* ((org-prefix-format-compiled
5707 (with-current-buffer org-agenda-buffer
5708 org-prefix-format-compiled))
5709 (bindings (car org-prefix-format-compiled))
5710 (formatter (cadr org-prefix-format-compiled)))
5711 (loop for (var value) in bindings
5712 do (set var value))
5713 (save-match-data
5714 ;; Diary entries sometimes have extra whitespace at the beginning
5715 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5717 ;; Fix the tags part in txt
5718 (setq txt (org-agenda-fix-displayed-tags
5719 txt tags
5720 org-agenda-show-inherited-tags
5721 org-agenda-hide-tags-regexp))
5722 (let* ((category (or category
5723 (if (stringp org-category)
5724 org-category
5725 (and org-category (symbol-name org-category)))
5726 (if buffer-file-name
5727 (file-name-sans-extension
5728 (file-name-nondirectory buffer-file-name))
5729 "")))
5730 (category-icon (org-agenda-get-category-icon category))
5731 (category-icon (if category-icon
5732 (propertize " " 'display category-icon)
5733 ""))
5734 ;; time, tag, effort are needed for the eval of the prefix format
5735 (tag (if tags (nth (1- (length tags)) tags) ""))
5736 time effort neffort
5737 (ts (if dotime (concat
5738 (if (stringp dotime) dotime "")
5739 (and org-agenda-search-headline-for-time txt))))
5740 (time-of-day (and dotime (org-get-time-of-day ts)))
5741 stamp plain s0 s1 s2 rtn srp l
5742 duration thecategory)
5743 (and (eq major-mode 'org-mode) buffer-file-name
5744 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5745 (when (and dotime time-of-day)
5746 ;; Extract starting and ending time and move them to prefix
5747 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5748 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5749 (setq s0 (match-string 0 ts)
5750 srp (and stamp (match-end 3))
5751 s1 (match-string (if plain 1 2) ts)
5752 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5754 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5755 ;; them, we might want to remove them there to avoid duplication.
5756 ;; The user can turn this off with a variable.
5757 (if (and org-prefix-has-time
5758 org-agenda-remove-times-when-in-prefix (or stamp plain)
5759 (string-match (concat (regexp-quote s0) " *") txt)
5760 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5761 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5762 (= (match-beginning 0) 0)
5764 (setq txt (replace-match "" nil nil txt))))
5765 ;; Normalize the time(s) to 24 hour
5766 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5767 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5769 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5770 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5771 (setq s2
5772 (org-minutes-to-hh:mm-string
5773 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5775 ;; Compute the duration
5776 (when s2
5777 (setq duration (- (org-hh:mm-string-to-minutes s2)
5778 (org-hh:mm-string-to-minutes s1)))))
5780 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5781 txt)
5782 ;; Tags are in the string
5783 (if (or (eq org-agenda-remove-tags t)
5784 (and org-agenda-remove-tags
5785 org-prefix-has-tag))
5786 (setq txt (replace-match "" t t txt))
5787 (setq txt (replace-match
5788 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5789 (match-string 2 txt))
5790 t t txt))))
5791 (when (eq major-mode 'org-mode)
5792 (setq effort
5793 (condition-case nil
5794 (org-get-effort
5795 (or (get-text-property 0 'org-hd-marker txt)
5796 (get-text-property 0 'org-marker txt)))
5797 (error nil)))
5798 (when effort
5799 (setq neffort (org-duration-string-to-minutes effort)
5800 effort (setq effort (concat "[" effort "]")))))
5801 ;; prevent erroring out with %e format when there is no effort
5802 (or effort (setq effort ""))
5804 (when remove-re
5805 (while (string-match remove-re txt)
5806 (setq txt (replace-match "" t t txt))))
5808 ;; Set org-heading property on `txt' to mark the start of the
5809 ;; heading.
5810 (add-text-properties 0 (length txt) '(org-heading t) txt)
5812 ;; Prepare the variables needed in the eval of the compiled format
5813 (setq time (cond (s2 (concat
5814 (org-agenda-time-of-day-to-ampm-maybe s1)
5815 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
5816 (if org-agenda-timegrid-use-ampm " ")))
5817 (s1 (concat
5818 (org-agenda-time-of-day-to-ampm-maybe s1)
5819 (if org-agenda-timegrid-use-ampm
5820 "........ "
5821 "......")))
5822 (t ""))
5823 extra (or (and (not habitp) extra) "")
5824 category (if (symbolp category) (symbol-name category) category)
5825 thecategory (copy-sequence category))
5826 (if (string-match org-bracket-link-regexp category)
5827 (progn
5828 (setq l (if (match-end 3)
5829 (- (match-end 3) (match-beginning 3))
5830 (- (match-end 1) (match-beginning 1))))
5831 (when (< l (or org-prefix-category-length 0))
5832 (setq category (copy-sequence category))
5833 (org-add-props category nil
5834 'extra-space (make-string
5835 (- org-prefix-category-length l 1) ?\ ))))
5836 (if (and org-prefix-category-max-length
5837 (>= (length category) org-prefix-category-max-length))
5838 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
5839 ;; Evaluate the compiled format
5840 (setq rtn (concat (eval formatter) txt))
5842 ;; And finally add the text properties
5843 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
5844 (org-add-props rtn nil
5845 'org-category (if thecategory (downcase thecategory) category)
5846 'tags (mapcar 'org-downcase-keep-props tags)
5847 'org-highest-priority org-highest-priority
5848 'org-lowest-priority org-lowest-priority
5849 'time-of-day time-of-day
5850 'duration duration
5851 'effort effort
5852 'effort-minutes neffort
5853 'txt txt
5854 'time time
5855 'extra extra
5856 'format org-prefix-format-compiled
5857 'dotime dotime)))))
5859 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
5860 "Remove tags string from TXT, and add a modified list of tags.
5861 The modified list may contain inherited tags, and tags matched by
5862 `org-agenda-hide-tags-regexp' will be removed."
5863 (when (or add-inherited hide-re)
5864 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
5865 (setq txt (substring txt 0 (match-beginning 0))))
5866 (setq tags
5867 (delq nil
5868 (mapcar (lambda (tg)
5869 (if (or (and hide-re (string-match hide-re tg))
5870 (and (not add-inherited)
5871 (get-text-property 0 'inherited tg)))
5873 tg))
5874 tags)))
5875 (when tags
5876 (let ((have-i (get-text-property 0 'inherited (car tags)))
5878 (setq txt (concat txt " :"
5879 (mapconcat
5880 (lambda (x)
5881 (setq i (get-text-property 0 'inherited x))
5882 (if (and have-i (not i))
5883 (progn
5884 (setq have-i nil)
5885 (concat ":" x))
5887 tags ":")
5888 (if have-i "::" ":"))))))
5889 txt)
5891 (defun org-downcase-keep-props (s)
5892 (let ((props (text-properties-at 0 s)))
5893 (setq s (downcase s))
5894 (add-text-properties 0 (length s) props s)
5897 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
5898 (defvar org-agenda-sorting-strategy-selected nil)
5900 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
5901 (catch 'exit
5902 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
5903 ((and todayp (member 'today (car org-agenda-time-grid))))
5904 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
5905 ((member 'weekly (car org-agenda-time-grid)))
5906 (t (throw 'exit list)))
5907 (let* ((have (delq nil (mapcar
5908 (lambda (x) (get-text-property 1 'time-of-day x))
5909 list)))
5910 (string (nth 1 org-agenda-time-grid))
5911 (gridtimes (nth 2 org-agenda-time-grid))
5912 (req (car org-agenda-time-grid))
5913 (remove (member 'remove-match req))
5914 new time)
5915 (if (and (member 'require-timed req) (not have))
5916 ;; don't show empty grid
5917 (throw 'exit list))
5918 (while (setq time (pop gridtimes))
5919 (unless (and remove (member time have))
5920 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
5921 (push (org-agenda-format-item
5922 nil string "" nil
5923 (concat (substring time 0 -2) ":" (substring time -2)))
5924 new)
5925 (put-text-property
5926 2 (length (car new)) 'face 'org-time-grid (car new))))
5927 (when (and todayp org-agenda-show-current-time-in-grid)
5928 (push (org-agenda-format-item
5930 org-agenda-current-time-string
5931 "" nil
5932 (format-time-string "%H:%M "))
5933 new)
5934 (put-text-property
5935 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
5937 (if (member 'time-up org-agenda-sorting-strategy-selected)
5938 (append new list)
5939 (append list new)))))
5941 (defun org-compile-prefix-format (key)
5942 "Compile the prefix format into a Lisp form that can be evaluated.
5943 The resulting form and associated variable bindings is returned
5944 and stored in the variable `org-prefix-format-compiled'."
5945 (setq org-prefix-has-time nil org-prefix-has-tag nil
5946 org-prefix-category-length nil
5947 org-prefix-has-effort nil)
5948 (let ((s (cond
5949 ((stringp org-agenda-prefix-format)
5950 org-agenda-prefix-format)
5951 ((assq key org-agenda-prefix-format)
5952 (cdr (assq key org-agenda-prefix-format)))
5953 (t " %-12:c%?-12t% s")))
5954 (start 0)
5955 varform vars var e c f opt)
5956 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
5957 s start)
5958 (setq var (or (cdr (assoc (match-string 4 s)
5959 '(("c" . category) ("t" . time) ("s" . extra)
5960 ("i" . category-icon) ("T" . tag) ("e" . effort))))
5961 'eval)
5962 c (or (match-string 3 s) "")
5963 opt (match-beginning 1)
5964 start (1+ (match-beginning 0)))
5965 (if (equal var 'time) (setq org-prefix-has-time t))
5966 (if (equal var 'tag) (setq org-prefix-has-tag t))
5967 (if (equal var 'effort) (setq org-prefix-has-effort t))
5968 (setq f (concat "%" (match-string 2 s) "s"))
5969 (when (equal var 'category)
5970 (setq org-prefix-category-length
5971 (floor (abs (string-to-number (match-string 2 s)))))
5972 (setq org-prefix-category-max-length
5973 (let ((x (match-string 2 s)))
5974 (save-match-data
5975 (if (string-match "\\.[0-9]+" x)
5976 (string-to-number (substring (match-string 0 x) 1)))))))
5977 (if (eq var 'eval)
5978 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
5979 (if opt
5980 (setq varform
5981 `(if (equal "" ,var)
5983 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
5984 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
5985 (setq s (replace-match "%s" t nil s))
5986 (push varform vars))
5987 (setq vars (nreverse vars))
5988 (with-current-buffer org-agenda-buffer
5989 (setq org-prefix-format-compiled
5990 (list
5991 `((org-prefix-has-time ,org-prefix-has-time)
5992 (org-prefix-has-tag ,org-prefix-has-tag)
5993 (org-prefix-category-length ,org-prefix-category-length)
5994 (org-prefix-has-effort ,org-prefix-has-effort))
5995 `(format ,s ,@vars))))))
5997 (defun org-set-sorting-strategy (key)
5998 (if (symbolp (car org-agenda-sorting-strategy))
5999 ;; the old format
6000 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6001 (setq org-agenda-sorting-strategy-selected
6002 (or (cdr (assq key org-agenda-sorting-strategy))
6003 (cdr (assq 'agenda org-agenda-sorting-strategy))
6004 '(time-up category-keep priority-down)))))
6006 (defun org-get-time-of-day (s &optional string mod24)
6007 "Check string S for a time of day.
6008 If found, return it as a military time number between 0 and 2400.
6009 If not found, return nil.
6010 The optional STRING argument forces conversion into a 5 character wide string
6011 HH:MM."
6012 (save-match-data
6013 (when
6014 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6015 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6016 (let* ((h (string-to-number (match-string 1 s)))
6017 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6018 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6019 (am-p (equal ampm "am"))
6020 (h1 (cond ((not ampm) h)
6021 ((= h 12) (if am-p 0 12))
6022 (t (+ h (if am-p 0 12)))))
6023 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6024 (mod h1 24) h1))
6025 (t0 (+ (* 100 h2) m))
6026 (t1 (concat (if (>= h1 24) "+" " ")
6027 (if (and org-agenda-time-leading-zero
6028 (< t0 1000)) "0" "")
6029 (if (< t0 100) "0" "")
6030 (if (< t0 10) "0" "")
6031 (int-to-string t0))))
6032 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6034 (defvar org-agenda-before-sorting-filter-function nil
6035 "Function to be applied to agenda items prior to sorting.
6036 Prior to sorting also means just before they are inserted into the agenda.
6038 To aid sorting, you may revisit the original entries and add more text
6039 properties which will later be used by the sorting functions.
6041 The function should take a string argument, an agenda line.
6042 It has access to the text properties in that line, which contain among
6043 other things, the property `org-hd-marker' that points to the entry
6044 where the line comes from. Note that not all lines going into the agenda
6045 have this property, only most.
6047 The function should return the modified string. It is probably best
6048 to ONLY change text properties.
6050 You can also use this function as a filter, by returning nil for lines
6051 you don't want to have in the agenda at all. For this application, you
6052 could bind the variable in the options section of a custom command.")
6054 (defun org-finalize-agenda-entries (list &optional nosort)
6055 "Sort and concatenate the agenda items."
6056 (setq list (mapcar 'org-agenda-highlight-todo list))
6057 (if nosort
6058 list
6059 (when org-agenda-before-sorting-filter-function
6060 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6061 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6063 (defun org-agenda-highlight-todo (x)
6064 (let ((org-done-keywords org-done-keywords-for-agenda)
6065 (case-fold-search nil)
6067 (if (eq x 'line)
6068 (save-excursion
6069 (beginning-of-line 1)
6070 (setq re (org-get-at-bol 'org-todo-regexp))
6071 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6072 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6073 (add-text-properties (match-beginning 0) (match-end 1)
6074 (list 'face (org-get-todo-face 1)))
6075 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6076 (delete-region (match-beginning 1) (1- (match-end 0)))
6077 (goto-char (match-beginning 1))
6078 (insert (format org-agenda-todo-keyword-format s)))))
6079 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6080 (setq re (get-text-property 0 'org-todo-regexp x))
6081 (when (and re
6082 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6083 x (or pl 0)) pl))
6084 (add-text-properties
6085 (or (match-end 1) (match-end 0)) (match-end 0)
6086 (list 'face (org-get-todo-face (match-string 2 x)))
6088 (when (match-end 1)
6089 (setq x (concat (substring x 0 (match-end 1))
6090 (format org-agenda-todo-keyword-format
6091 (match-string 2 x))
6092 (org-add-props " " (text-properties-at 0 x))
6093 (substring x (match-end 3)))))))
6094 x)))
6096 (defsubst org-cmp-priority (a b)
6097 "Compare the priorities of string A and B."
6098 (let ((pa (or (get-text-property 1 'priority a) 0))
6099 (pb (or (get-text-property 1 'priority b) 0)))
6100 (cond ((> pa pb) +1)
6101 ((< pa pb) -1)
6102 (t nil))))
6104 (defsubst org-cmp-effort (a b)
6105 "Compare the effort values of string A and B."
6106 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6107 (ea (or (get-text-property 1 'effort-minutes a) def))
6108 (eb (or (get-text-property 1 'effort-minutes b) def)))
6109 (cond ((> ea eb) +1)
6110 ((< ea eb) -1)
6111 (t nil))))
6113 (defsubst org-cmp-category (a b)
6114 "Compare the string values of categories of strings A and B."
6115 (let ((ca (or (get-text-property 1 'org-category a) ""))
6116 (cb (or (get-text-property 1 'org-category b) "")))
6117 (cond ((string-lessp ca cb) -1)
6118 ((string-lessp cb ca) +1)
6119 (t nil))))
6121 (defsubst org-cmp-todo-state (a b)
6122 "Compare the todo states of strings A and B."
6123 (let* ((ma (or (get-text-property 1 'org-marker a)
6124 (get-text-property 1 'org-hd-marker a)))
6125 (mb (or (get-text-property 1 'org-marker b)
6126 (get-text-property 1 'org-hd-marker b)))
6127 (fa (and ma (marker-buffer ma)))
6128 (fb (and mb (marker-buffer mb)))
6129 (todo-kwds
6130 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6131 (and fb (with-current-buffer fb org-todo-keywords-1))))
6132 (ta (or (get-text-property 1 'todo-state a) ""))
6133 (tb (or (get-text-property 1 'todo-state b) ""))
6134 (la (- (length (member ta todo-kwds))))
6135 (lb (- (length (member tb todo-kwds))))
6136 (donepa (member ta org-done-keywords-for-agenda))
6137 (donepb (member tb org-done-keywords-for-agenda)))
6138 (cond ((and donepa (not donepb)) -1)
6139 ((and (not donepa) donepb) +1)
6140 ((< la lb) -1)
6141 ((< lb la) +1)
6142 (t nil))))
6144 (defsubst org-cmp-alpha (a b)
6145 "Compare the headlines, alphabetically."
6146 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6147 (plb (text-property-any 0 (length b) 'org-heading t b))
6148 (ta (and pla (substring a pla)))
6149 (tb (and plb (substring b plb))))
6150 (when pla
6151 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6152 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6153 (setq ta (substring ta (match-end 0))))
6154 (setq ta (downcase ta)))
6155 (when plb
6156 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6157 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6158 (setq tb (substring tb (match-end 0))))
6159 (setq tb (downcase tb)))
6160 (cond ((not ta) +1)
6161 ((not tb) -1)
6162 ((string-lessp ta tb) -1)
6163 ((string-lessp tb ta) +1)
6164 (t nil))))
6166 (defsubst org-cmp-tag (a b)
6167 "Compare the string values of the first tags of A and B."
6168 (let ((ta (car (last (get-text-property 1 'tags a))))
6169 (tb (car (last (get-text-property 1 'tags b)))))
6170 (cond ((not ta) +1)
6171 ((not tb) -1)
6172 ((string-lessp ta tb) -1)
6173 ((string-lessp tb ta) +1)
6174 (t nil))))
6176 (defsubst org-cmp-time (a b)
6177 "Compare the time-of-day values of strings A and B."
6178 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6179 (ta (or (get-text-property 1 'time-of-day a) def))
6180 (tb (or (get-text-property 1 'time-of-day b) def)))
6181 (cond ((< ta tb) -1)
6182 ((< tb ta) +1)
6183 (t nil))))
6185 (defsubst org-cmp-habit-p (a b)
6186 "Compare the todo states of strings A and B."
6187 (let ((ha (get-text-property 1 'org-habit-p a))
6188 (hb (get-text-property 1 'org-habit-p b)))
6189 (cond ((and ha (not hb)) -1)
6190 ((and (not ha) hb) +1)
6191 (t nil))))
6193 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6195 (defun org-entries-lessp (a b)
6196 "Predicate for sorting agenda entries."
6197 ;; The following variables will be used when the form is evaluated.
6198 ;; So even though the compiler complains, keep them.
6199 (let* ((ss org-agenda-sorting-strategy-selected)
6200 (time-up (and (org-em 'time-up 'time-down ss)
6201 (org-cmp-time a b)))
6202 (time-down (if time-up (- time-up) nil))
6203 (priority-up (and (org-em 'priority-up 'priority-down ss)
6204 (org-cmp-priority a b)))
6205 (priority-down (if priority-up (- priority-up) nil))
6206 (effort-up (and (org-em 'effort-up 'effort-down ss)
6207 (org-cmp-effort a b)))
6208 (effort-down (if effort-up (- effort-up) nil))
6209 (category-up (and (or (org-em 'category-up 'category-down ss)
6210 (memq 'category-keep ss))
6211 (org-cmp-category a b)))
6212 (category-down (if category-up (- category-up) nil))
6213 (category-keep (if category-up +1 nil))
6214 (tag-up (and (org-em 'tag-up 'tag-down ss)
6215 (org-cmp-tag a b)))
6216 (tag-down (if tag-up (- tag-up) nil))
6217 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6218 (org-cmp-todo-state a b)))
6219 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6220 (habit-up (and (org-em 'habit-up 'habit-down ss)
6221 (org-cmp-habit-p a b)))
6222 (habit-down (if habit-up (- habit-up) nil))
6223 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6224 (org-cmp-alpha a b)))
6225 (alpha-down (if alpha-up (- alpha-up) nil))
6226 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6227 user-defined-up user-defined-down)
6228 (if (and need-user-cmp org-agenda-cmp-user-defined
6229 (functionp org-agenda-cmp-user-defined))
6230 (setq user-defined-up
6231 (funcall org-agenda-cmp-user-defined a b)
6232 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6233 (cdr (assoc
6234 (eval (cons 'or org-agenda-sorting-strategy-selected))
6235 '((-1 . t) (1 . nil) (nil . nil))))))
6237 ;;; Agenda restriction lock
6239 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6240 "Overlay to mark the headline to which agenda commands are restricted.")
6241 (overlay-put org-agenda-restriction-lock-overlay
6242 'face 'org-agenda-restriction-lock)
6243 (overlay-put org-agenda-restriction-lock-overlay
6244 'help-echo "Agendas are currently limited to this subtree.")
6245 (org-detach-overlay org-agenda-restriction-lock-overlay)
6247 (defun org-agenda-set-restriction-lock (&optional type)
6248 "Set restriction lock for agenda, to current subtree or file.
6249 Restriction will be the file if TYPE is `file', or if type is the
6250 universal prefix '(4), or if the cursor is before the first headline
6251 in the file. Otherwise, restriction will be to the current subtree."
6252 (interactive "P")
6253 (and (equal type '(4)) (setq type 'file))
6254 (setq type (cond
6255 (type type)
6256 ((org-at-heading-p) 'subtree)
6257 ((condition-case nil (org-back-to-heading t) (error nil))
6258 'subtree)
6259 (t 'file)))
6260 (if (eq type 'subtree)
6261 (progn
6262 (setq org-agenda-restrict t)
6263 (setq org-agenda-overriding-restriction 'subtree)
6264 (put 'org-agenda-files 'org-restrict
6265 (list (buffer-file-name (buffer-base-buffer))))
6266 (org-back-to-heading t)
6267 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6268 (move-marker org-agenda-restrict-begin (point))
6269 (move-marker org-agenda-restrict-end
6270 (save-excursion (org-end-of-subtree t)))
6271 (message "Locking agenda restriction to subtree"))
6272 (put 'org-agenda-files 'org-restrict
6273 (list (buffer-file-name (buffer-base-buffer))))
6274 (setq org-agenda-restrict nil)
6275 (setq org-agenda-overriding-restriction 'file)
6276 (move-marker org-agenda-restrict-begin nil)
6277 (move-marker org-agenda-restrict-end nil)
6278 (message "Locking agenda restriction to file"))
6279 (setq current-prefix-arg nil)
6280 (org-agenda-maybe-redo))
6282 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6283 "Remove the agenda restriction lock."
6284 (interactive "P")
6285 (org-detach-overlay org-agenda-restriction-lock-overlay)
6286 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6287 (setq org-agenda-overriding-restriction nil)
6288 (setq org-agenda-restrict nil)
6289 (put 'org-agenda-files 'org-restrict nil)
6290 (move-marker org-agenda-restrict-begin nil)
6291 (move-marker org-agenda-restrict-end nil)
6292 (setq current-prefix-arg nil)
6293 (message "Agenda restriction lock removed")
6294 (or noupdate (org-agenda-maybe-redo)))
6296 (defun org-agenda-maybe-redo ()
6297 "If there is any window showing the agenda view, update it."
6298 (let ((w (get-buffer-window org-agenda-buffer-name t))
6299 (w0 (selected-window)))
6300 (when w
6301 (select-window w)
6302 (org-agenda-redo)
6303 (select-window w0)
6304 (if org-agenda-overriding-restriction
6305 (message "Agenda view shifted to new %s restriction"
6306 org-agenda-overriding-restriction)
6307 (message "Agenda restriction lock removed")))))
6309 ;;; Agenda commands
6311 (defun org-agenda-check-type (error &rest types)
6312 "Check if agenda buffer is of allowed type.
6313 If ERROR is non-nil, throw an error, otherwise just return nil."
6314 (if (memq org-agenda-type types)
6316 (if error
6317 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6318 nil)))
6321 (defun org-agenda-Quit (&optional arg)
6322 "Exit agenda by removing the window or the buffer"
6323 (interactive)
6324 (if org-agenda-columns-active
6325 (org-columns-quit)
6326 (let ((buf (current-buffer)))
6327 (if (eq org-agenda-window-setup 'other-frame)
6328 (progn
6329 (kill-buffer buf)
6330 (org-agenda-reset-markers)
6331 (org-columns-remove-overlays)
6332 (setq org-agenda-archives-mode nil)
6333 (delete-frame))
6334 (and (not (eq org-agenda-window-setup 'current-window))
6335 (not (one-window-p))
6336 (delete-window))
6337 (kill-buffer buf)
6338 (org-agenda-reset-markers)
6339 (org-columns-remove-overlays)
6340 (setq org-agenda-archives-mode nil)))
6341 ;; Maybe restore the pre-agenda window configuration.
6342 (and org-agenda-restore-windows-after-quit
6343 (not (eq org-agenda-window-setup 'other-frame))
6344 org-pre-agenda-window-conf
6345 (set-window-configuration org-pre-agenda-window-conf))))
6347 (defun org-agenda-quit ()
6348 "Exit agenda by killing agenda buffer or burying it when
6349 `org-agenda-sticky' is non-NIL"
6350 (interactive)
6351 (if org-agenda-columns-active
6352 (org-columns-quit)
6353 (if org-agenda-sticky
6354 (let ((buf (current-buffer)))
6355 (if (eq org-agenda-window-setup 'other-frame)
6356 (progn
6357 (delete-frame))
6358 (and (not (eq org-agenda-window-setup 'current-window))
6359 (not (one-window-p))
6360 (delete-window)))
6361 (with-current-buffer buf
6362 (bury-buffer)))
6363 (org-agenda-Quit))))
6365 (defun org-agenda-exit ()
6366 "Exit agenda by removing the window or the buffer.
6367 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6368 Org-mode buffers visited directly by the user will not be touched."
6369 (interactive)
6370 (org-release-buffers org-agenda-new-buffers)
6371 (setq org-agenda-new-buffers nil)
6372 (org-agenda-Quit))
6374 (defun org-agenda-execute (arg)
6375 "Execute another agenda command, keeping same window.
6376 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6377 in the agenda."
6378 (interactive "P")
6379 (let ((org-agenda-window-setup 'current-window))
6380 (org-agenda arg)))
6382 (defun org-agenda-redo ()
6383 "Rebuild Agenda.
6384 When this is the global TODO list, a prefix argument will be interpreted."
6385 (interactive)
6386 (let* ((org-agenda-doing-sticky-redo org-agenda-sticky)
6387 (org-agenda-sticky nil)
6388 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6389 org-agenda-buffer-name))
6390 (org-agenda-keep-modes t)
6391 (tag-filter org-agenda-tag-filter)
6392 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6393 (cat-filter org-agenda-category-filter)
6394 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6395 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6396 (cols org-agenda-columns-active)
6397 (line (org-current-line))
6398 (window-line (- line (org-current-line (window-start))))
6399 (lprops (get 'org-agenda-redo-command 'org-lprops)))
6400 (put 'org-agenda-tag-filter :preset-filter nil)
6401 (put 'org-agenda-category-filter :preset-filter nil)
6402 (and cols (org-columns-quit))
6403 (message "Rebuilding agenda buffer...")
6404 (org-let lprops '(eval org-agenda-redo-command))
6405 (setq org-agenda-undo-list nil
6406 org-agenda-pending-undo-list nil)
6407 (message "Rebuilding agenda buffer...done")
6408 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6409 (put 'org-agenda-category-filter :preset-filter cat-preset)
6410 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6411 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6412 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6413 (org-goto-line line)
6414 (recenter window-line)))
6416 (defvar org-global-tags-completion-table nil)
6417 (defvar org-agenda-filtered-by-category nil)
6418 (defvar org-agenda-filter-form nil)
6420 (defun org-agenda-filter-by-category (strip)
6421 "Keep only those lines in the agenda buffer that have a specific category.
6422 The category is that of the current line."
6423 (interactive "P")
6424 (if org-agenda-filtered-by-category
6425 (org-agenda-filter-show-all-cat)
6426 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6427 (if cat (org-agenda-filter-apply
6428 (list (concat (if strip "-" "+") cat)) 'category)
6429 (error "No category at point")))))
6431 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6432 "Keep only those lines in the agenda buffer that have a specific tag.
6433 The tag is selected with its fast selection letter, as configured.
6434 With prefix argument STRIP, remove all lines that do have the tag.
6435 A lisp caller can specify CHAR. NARROW means that the new tag should be
6436 used to narrow the search - the interactive user can also press `-' or `+'
6437 to switch to narrowing."
6438 (interactive "P")
6439 (let* ((alist org-tag-alist-for-agenda)
6440 (tag-chars (mapconcat
6441 (lambda (x) (if (and (not (symbolp (car x)))
6442 (cdr x))
6443 (char-to-string (cdr x))
6444 ""))
6445 alist ""))
6446 (efforts (org-split-string
6447 (or (cdr (assoc (concat org-effort-property "_ALL")
6448 org-global-properties))
6449 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6450 "")))
6451 (effort-op org-agenda-filter-effort-default-operator)
6452 (effort-prompt "")
6453 (inhibit-read-only t)
6454 (current org-agenda-tag-filter)
6455 maybe-refresh a n tag)
6456 (unless char
6457 (message
6458 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6459 (if narrow "Narrow" "Filter") tag-chars
6460 (if org-agenda-auto-exclude-function "[RET], " ""))
6461 (setq char (read-char-exclusive)))
6462 (when (member char '(?+ ?-))
6463 ;; Narrowing down
6464 (cond ((equal char ?-) (setq strip t narrow t))
6465 ((equal char ?+) (setq strip nil narrow t)))
6466 (message
6467 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6468 (setq char (read-char-exclusive)))
6469 (when (member char '(?< ?> ?= ??))
6470 ;; An effort operator
6471 (setq effort-op (char-to-string char))
6472 (setq alist nil) ; to make sure it will be interpreted as effort.
6473 (unless (equal char ??)
6474 (loop for i from 0 to 9 do
6475 (setq effort-prompt
6476 (concat
6477 effort-prompt " ["
6478 (if (= i 9) "0" (int-to-string (1+ i)))
6479 "]" (nth i efforts))))
6480 (message "Effort%s: %s " effort-op effort-prompt)
6481 (setq char (read-char-exclusive))
6482 (when (or (< char ?0) (> char ?9))
6483 (error "Need 1-9,0 to select effort"))))
6484 (when (equal char ?\t)
6485 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6486 (org-set-local 'org-global-tags-completion-table
6487 (org-global-tags-completion-table)))
6488 (let ((completion-ignore-case t))
6489 (setq tag (org-icompleting-read
6490 "Tag: " org-global-tags-completion-table))))
6491 (cond
6492 ((equal char ?\r)
6493 (org-agenda-filter-show-all-tag)
6494 (when org-agenda-auto-exclude-function
6495 (setq org-agenda-tag-filter '())
6496 (dolist (tag (org-agenda-get-represented-tags))
6497 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6498 (if modifier
6499 (push modifier org-agenda-tag-filter))))
6500 (if (not (null org-agenda-tag-filter))
6501 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6502 (setq maybe-refresh t))
6503 ((equal char ?/)
6504 (org-agenda-filter-show-all-tag)
6505 (when (get 'org-agenda-tag-filter :preset-filter)
6506 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6507 (setq maybe-refresh t))
6508 ((equal char ?. )
6509 (setq org-agenda-tag-filter
6510 (mapcar (lambda(tag) (concat "+" tag))
6511 (org-get-at-bol 'tags)))
6512 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6513 (setq maybe-refresh t))
6514 ((or (equal char ?\ )
6515 (setq a (rassoc char alist))
6516 (and (>= char ?0) (<= char ?9)
6517 (setq n (if (= char ?0) 9 (- char ?0 1))
6518 tag (concat effort-op (nth n efforts))
6519 a (cons tag nil)))
6520 (and (= char ??)
6521 (setq tag "?eff")
6522 a (cons tag nil))
6523 (and tag (setq a (cons tag nil))))
6524 (org-agenda-filter-show-all-tag)
6525 (setq tag (car a))
6526 (setq org-agenda-tag-filter
6527 (cons (concat (if strip "-" "+") tag)
6528 (if narrow current nil)))
6529 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6530 (setq maybe-refresh t))
6531 (t (error "Invalid tag selection character %c" char)))
6532 (when (and maybe-refresh
6533 (eq org-agenda-clockreport-mode 'with-filter))
6534 (org-agenda-redo))))
6536 (defun org-agenda-get-represented-tags ()
6537 "Get a list of all tags currently represented in the agenda."
6538 (let (p tags)
6539 (save-excursion
6540 (goto-char (point-min))
6541 (while (setq p (next-single-property-change (point) 'tags))
6542 (goto-char p)
6543 (mapc (lambda (x) (add-to-list 'tags x))
6544 (get-text-property (point) 'tags))))
6545 tags))
6547 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6548 "Refine the current filter. See `org-agenda-filter-by-tag'."
6549 (interactive "P")
6550 (org-agenda-filter-by-tag strip char 'refine))
6552 (defun org-agenda-filter-make-matcher ()
6553 "Create the form that tests a line for agenda filter."
6554 (let (f f1)
6555 ;; first compute the tag-filter matcher
6556 (dolist (x (delete-dups
6557 (append (get 'org-agenda-tag-filter
6558 :preset-filter) org-agenda-tag-filter)))
6559 (if (member x '("-" "+"))
6560 (setq f1 (if (equal x "-") 'tags '(not tags)))
6561 (if (string-match "[<=>?]" x)
6562 (setq f1 (org-agenda-filter-effort-form x))
6563 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6564 (if (equal (string-to-char x) ?-)
6565 (setq f1 (list 'not f1))))
6566 (push f1 f))
6567 ;; then compute the category-filter matcher
6568 (dolist (x (delete-dups
6569 (append (get 'org-agenda-category-filter
6570 :preset-filter) org-agenda-category-filter)))
6571 (setq f1 (list 'equal (substring x 1) 'cat))
6572 (push f1 f))
6573 (cons 'and (nreverse f))))
6575 (defun org-agenda-filter-effort-form (e)
6576 "Return the form to compare the effort of the current line with what E says.
6577 E looks like \"+<2:25\"."
6578 (let (op)
6579 (setq e (substring e 1))
6580 (setq op (string-to-char e) e (substring e 1))
6581 (setq op (cond ((equal op ?<) '<=)
6582 ((equal op ?>) '>=)
6583 ((equal op ??) op)
6584 (t '=)))
6585 (list 'org-agenda-compare-effort (list 'quote op)
6586 (org-duration-string-to-minutes e))))
6588 (defun org-agenda-compare-effort (op value)
6589 "Compare the effort of the current line with VALUE, using OP.
6590 If the line does not have an effort defined, return nil."
6591 (let ((eff (org-get-at-bol 'effort-minutes)))
6592 (if (equal op ??)
6593 (not eff)
6594 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6595 value))))
6597 (defun org-agenda-filter-apply (filter type)
6598 "Set FILTER as the new agenda filter and apply it."
6599 (let (tags cat)
6600 (if (eq type 'tag)
6601 (setq org-agenda-tag-filter filter)
6602 (setq org-agenda-category-filter filter
6603 org-agenda-filtered-by-category t))
6604 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6605 (org-agenda-set-mode-name)
6606 (save-excursion
6607 (goto-char (point-min))
6608 (while (not (eobp))
6609 (if (org-get-at-bol 'org-marker)
6610 (progn
6611 (setq tags (org-get-at-bol 'tags) ; used in eval
6612 cat (get-text-property (point) 'org-category))
6613 (if (not (eval org-agenda-filter-form))
6614 (org-agenda-filter-hide-line type))
6615 (beginning-of-line 2))
6616 (beginning-of-line 2))))
6617 (if (get-char-property (point) 'invisible)
6618 (org-agenda-previous-line))))
6620 (defun org-agenda-filter-hide-line (type)
6621 (let (ov)
6622 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6623 (point-at-eol)))
6624 (overlay-put ov 'invisible t)
6625 (overlay-put ov 'type type)
6626 (if (eq type 'tag)
6627 (push ov org-agenda-tag-filter-overlays)
6628 (push ov org-agenda-cat-filter-overlays))))
6630 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6631 (setq pos (or pos (point)))
6632 (save-excursion
6633 (dolist (ov (overlays-at pos))
6634 (when (and (overlay-get ov 'invisible)
6635 (eq (overlay-get ov 'type) 'tag))
6636 (goto-char pos)
6637 (if (< (overlay-start ov) (point-at-eol))
6638 (move-overlay ov (point-at-eol)
6639 (overlay-end ov)))))))
6641 (defun org-agenda-filter-show-all-tag nil
6642 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6643 (setq org-agenda-tag-filter-overlays nil
6644 org-agenda-tag-filter nil
6645 org-agenda-filter-form nil)
6646 (org-agenda-set-mode-name))
6648 (defun org-agenda-filter-show-all-cat nil
6649 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6650 (setq org-agenda-cat-filter-overlays nil
6651 org-agenda-filtered-by-category nil
6652 org-agenda-category-filter nil
6653 org-agenda-filter-form nil)
6654 (org-agenda-set-mode-name))
6656 (defun org-agenda-manipulate-query-add ()
6657 "Manipulate the query by adding a search term with positive selection.
6658 Positive selection means the term must be matched for selection of an entry."
6659 (interactive)
6660 (org-agenda-manipulate-query ?\[))
6661 (defun org-agenda-manipulate-query-subtract ()
6662 "Manipulate the query by adding a search term with negative selection.
6663 Negative selection means term must not be matched for selection of an entry."
6664 (interactive)
6665 (org-agenda-manipulate-query ?\]))
6666 (defun org-agenda-manipulate-query-add-re ()
6667 "Manipulate the query by adding a search regexp with positive selection.
6668 Positive selection means the regexp must match for selection of an entry."
6669 (interactive)
6670 (org-agenda-manipulate-query ?\{))
6671 (defun org-agenda-manipulate-query-subtract-re ()
6672 "Manipulate the query by adding a search regexp with negative selection.
6673 Negative selection means regexp must not match for selection of an entry."
6674 (interactive)
6675 (org-agenda-manipulate-query ?\}))
6676 (defun org-agenda-manipulate-query (char)
6677 (cond
6678 ((memq org-agenda-type '(timeline agenda))
6679 (let ((org-agenda-include-inactive-timestamps t))
6680 (org-agenda-redo))
6681 (message "Display now includes inactive timestamps as well"))
6682 ((eq org-agenda-type 'search)
6683 (org-add-to-string
6684 'org-agenda-query-string
6685 (if org-agenda-last-search-view-search-was-boolean
6686 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6687 (?\{ . " +{}") (?\} . " -{}"))))
6688 " "))
6689 (setq org-agenda-redo-command
6690 (list 'org-search-view
6691 org-todo-only
6692 org-agenda-query-string
6693 (+ (length org-agenda-query-string)
6694 (if (member char '(?\{ ?\})) 0 1))))
6695 (set-register org-agenda-query-register org-agenda-query-string)
6696 (org-agenda-redo))
6697 (t (error "Cannot manipulate query for %s-type agenda buffers"
6698 org-agenda-type))))
6700 (defun org-add-to-string (var string)
6701 (set var (concat (symbol-value var) string)))
6703 (defun org-agenda-goto-date (date)
6704 "Jump to DATE in agenda."
6705 (interactive (list (let ((org-read-date-prefer-future
6706 (eval org-agenda-jump-prefer-future)))
6707 (org-read-date))))
6708 (org-agenda-list nil date))
6710 (defun org-agenda-goto-today ()
6711 "Go to today."
6712 (interactive)
6713 (org-agenda-check-type t 'timeline 'agenda)
6714 (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6715 (cond
6716 (tdpos (goto-char tdpos))
6717 ((eq org-agenda-type 'agenda)
6718 (let* ((sd (org-agenda-compute-starting-span
6719 (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
6720 (org-agenda-overriding-arguments org-agenda-last-arguments))
6721 (setf (nth 1 org-agenda-overriding-arguments) sd)
6722 (org-agenda-redo)
6723 (org-agenda-find-same-or-today-or-agenda)))
6724 (t (error "Cannot find today")))))
6726 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
6727 (goto-char
6728 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
6729 (text-property-any (point-min) (point-max) 'org-today t)
6730 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
6731 (point-min))))
6733 (defun org-agenda-later (arg)
6734 "Go forward in time by thee current span.
6735 With prefix ARG, go forward that many times the current span."
6736 (interactive "p")
6737 (org-agenda-check-type t 'agenda)
6738 (let* ((span org-agenda-current-span)
6739 (sd org-starting-day)
6740 (greg (calendar-gregorian-from-absolute sd))
6741 (cnt (org-get-at-bol 'org-day-cnt))
6742 greg2)
6743 (cond
6744 ((eq span 'day)
6745 (setq sd (+ arg sd)))
6746 ((eq span 'week)
6747 (setq sd (+ (* 7 arg) sd)))
6748 ((eq span 'month)
6749 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
6750 sd (calendar-absolute-from-gregorian greg2))
6751 (setcar greg2 (1+ (car greg2))))
6752 ((eq span 'year)
6753 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
6754 sd (calendar-absolute-from-gregorian greg2))
6755 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
6757 (setq sd (+ (* span arg) sd))))
6758 (let ((org-agenda-overriding-arguments
6759 (list (car org-agenda-last-arguments) sd span t)))
6760 (org-agenda-redo)
6761 (org-agenda-find-same-or-today-or-agenda cnt))))
6763 (defun org-agenda-earlier (arg)
6764 "Go backward in time by the current span.
6765 With prefix ARG, go backward that many times the current span."
6766 (interactive "p")
6767 (org-agenda-later (- arg)))
6769 (defun org-agenda-view-mode-dispatch ()
6770 "Call one of the view mode commands."
6771 (interactive)
6772 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
6773 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
6774 [a]rch-trees [A]rch-files clock[R]eport include[D]iary
6775 [E]ntryText")
6776 (let ((a (read-char-exclusive)))
6777 (case a
6778 (?\ (call-interactively 'org-agenda-reset-view))
6779 (?d (call-interactively 'org-agenda-day-view))
6780 (?w (call-interactively 'org-agenda-week-view))
6781 (?m (call-interactively 'org-agenda-month-view))
6782 (?y (call-interactively 'org-agenda-year-view))
6783 (?l (call-interactively 'org-agenda-log-mode))
6784 (?L (org-agenda-log-mode '(4)))
6785 (?c (org-agenda-log-mode 'clockcheck))
6786 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
6787 (?a (call-interactively 'org-agenda-archives-mode))
6788 (?A (org-agenda-archives-mode 'files))
6789 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
6790 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
6791 (?G (call-interactively 'org-agenda-toggle-time-grid))
6792 (?D (call-interactively 'org-agenda-toggle-diary))
6793 (?\! (call-interactively 'org-agenda-toggle-deadlines))
6794 (?\[ (let ((org-agenda-include-inactive-timestamps t))
6795 (org-agenda-check-type t 'timeline 'agenda)
6796 (org-agenda-redo))
6797 (message "Display now includes inactive timestamps as well"))
6798 (?q (message "Abort"))
6799 (otherwise (error "Invalid key" )))))
6801 (defun org-agenda-reset-view ()
6802 "Switch to default view for agenda."
6803 (interactive)
6804 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
6805 (defun org-agenda-day-view (&optional day-of-year)
6806 "Switch to daily view for agenda.
6807 With argument DAY-OF-YEAR, switch to that day of the year."
6808 (interactive "P")
6809 (org-agenda-change-time-span 'day day-of-year))
6810 (defun org-agenda-week-view (&optional iso-week)
6811 "Switch to daily view for agenda.
6812 With argument ISO-WEEK, switch to the corresponding ISO week.
6813 If ISO-WEEK has more then 2 digits, only the last two encode the
6814 week. Any digits before this encode a year. So 200712 means
6815 week 12 of year 2007. Years in the range 1938-2037 can also be
6816 written as 2-digit years."
6817 (interactive "P")
6818 (org-agenda-change-time-span 'week iso-week))
6819 (defun org-agenda-month-view (&optional month)
6820 "Switch to monthly view for agenda.
6821 With argument MONTH, switch to that month."
6822 (interactive "P")
6823 (org-agenda-change-time-span 'month month))
6824 (defun org-agenda-year-view (&optional year)
6825 "Switch to yearly view for agenda.
6826 With argument YEAR, switch to that year.
6827 If MONTH has more then 2 digits, only the last two encode the
6828 month. Any digits before this encode a year. So 200712 means
6829 December year 2007. Years in the range 1938-2037 can also be
6830 written as 2-digit years."
6831 (interactive "P")
6832 (when year
6833 (setq year (org-small-year-to-year year)))
6834 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
6835 (org-agenda-change-time-span 'year year)
6836 (error "Abort")))
6838 (defun org-agenda-change-time-span (span &optional n)
6839 "Change the agenda view to SPAN.
6840 SPAN may be `day', `week', `month', `year'."
6841 (org-agenda-check-type t 'agenda)
6842 (if (and (not n) (equal org-agenda-current-span span))
6843 (error "Viewing span is already \"%s\"" span))
6844 (let* ((sd (or (org-get-at-bol 'day)
6845 org-starting-day))
6846 (sd (org-agenda-compute-starting-span sd span n))
6847 (org-agenda-overriding-arguments
6848 (or org-agenda-overriding-arguments
6849 (list (car org-agenda-last-arguments) sd span t))))
6850 (org-agenda-redo)
6851 (org-agenda-find-same-or-today-or-agenda))
6852 (org-agenda-set-mode-name)
6853 (message "Switched to %s view" span))
6855 (defun org-agenda-compute-starting-span (sd span &optional n)
6856 "Compute starting date for agenda.
6857 SPAN may be `day', `week', `month', `year'. The return value
6858 is a cons cell with the starting date and the number of days,
6859 so that the date SD will be in that range."
6860 (let* ((greg (calendar-gregorian-from-absolute sd))
6861 (dg (nth 1 greg))
6862 (mg (car greg))
6863 (yg (nth 2 greg)))
6864 (cond
6865 ((eq span 'day)
6866 (when n
6867 (setq sd (+ (calendar-absolute-from-gregorian
6868 (list mg 1 yg))
6869 n -1))))
6870 ((eq span 'week)
6871 (let* ((nt (calendar-day-of-week
6872 (calendar-gregorian-from-absolute sd)))
6873 (d (if org-agenda-start-on-weekday
6874 (- nt org-agenda-start-on-weekday)
6877 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
6878 (when n
6879 (require 'cal-iso)
6880 (when (> n 99)
6881 (setq y1 (org-small-year-to-year (/ n 100))
6882 n (mod n 100)))
6883 (setq sd
6884 (calendar-absolute-from-iso
6885 (list n 1
6886 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
6887 ((eq span 'month)
6888 (let (y1)
6889 (when (and n (> n 99))
6890 (setq y1 (org-small-year-to-year (/ n 100))
6891 n (mod n 100)))
6892 (setq sd (calendar-absolute-from-gregorian
6893 (list (or n mg) 1 (or y1 yg))))))
6894 ((eq span 'year)
6895 (setq sd (calendar-absolute-from-gregorian
6896 (list 1 1 (or n yg))))))
6897 sd))
6899 (defun org-agenda-next-date-line (&optional arg)
6900 "Jump to the next line indicating a date in agenda buffer."
6901 (interactive "p")
6902 (org-agenda-check-type t 'agenda 'timeline)
6903 (beginning-of-line 1)
6904 ;; This does not work if user makes date format that starts with a blank
6905 (if (looking-at "^\\S-") (forward-char 1))
6906 (if (not (re-search-forward "^\\S-" nil t arg))
6907 (progn
6908 (backward-char 1)
6909 (error "No next date after this line in this buffer")))
6910 (goto-char (match-beginning 0)))
6912 (defun org-agenda-previous-date-line (&optional arg)
6913 "Jump to the previous line indicating a date in agenda buffer."
6914 (interactive "p")
6915 (org-agenda-check-type t 'agenda 'timeline)
6916 (beginning-of-line 1)
6917 (if (not (re-search-backward "^\\S-" nil t arg))
6918 (error "No previous date before this line in this buffer")))
6920 ;; Initialize the highlight
6921 (defvar org-hl (make-overlay 1 1))
6922 (overlay-put org-hl 'face 'highlight)
6924 (defun org-highlight (begin end &optional buffer)
6925 "Highlight a region with overlay."
6926 (move-overlay org-hl begin end (or buffer (current-buffer))))
6928 (defun org-unhighlight ()
6929 "Detach overlay INDEX."
6930 (org-detach-overlay org-hl))
6932 ;; FIXME this is currently not used.
6933 (defun org-highlight-until-next-command (beg end &optional buffer)
6934 "Move the highlight overlay to BEG/END, remove it before the next command."
6935 (org-highlight beg end buffer)
6936 (add-hook 'pre-command-hook 'org-unhighlight-once))
6937 (defun org-unhighlight-once ()
6938 "Remove the highlight from its position, and this function from the hook."
6939 (remove-hook 'pre-command-hook 'org-unhighlight-once)
6940 (org-unhighlight))
6942 (defun org-agenda-follow-mode ()
6943 "Toggle follow mode in an agenda buffer."
6944 (interactive)
6945 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
6946 (org-agenda-set-mode-name)
6947 (org-agenda-do-context-action)
6948 (message "Follow mode is %s"
6949 (if org-agenda-follow-mode "on" "off")))
6951 (defun org-agenda-entry-text-mode (&optional arg)
6952 "Toggle entry text mode in an agenda buffer."
6953 (interactive "P")
6954 (setq org-agenda-entry-text-mode (or (integerp arg)
6955 (not org-agenda-entry-text-mode)))
6956 (org-agenda-entry-text-hide)
6957 (and org-agenda-entry-text-mode
6958 (let ((org-agenda-entry-text-maxlines
6959 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
6960 (org-agenda-entry-text-show)))
6961 (org-agenda-set-mode-name)
6962 (message "Entry text mode is %s. Maximum number of lines is %d"
6963 (if org-agenda-entry-text-mode "on" "off")
6964 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
6966 (defun org-agenda-clockreport-mode (&optional with-filter)
6967 "Toggle clocktable mode in an agenda buffer.
6968 With prefix arg WITH-FILTER, make the clocktable respect the current
6969 agenda filter."
6970 (interactive "P")
6971 (org-agenda-check-type t 'agenda)
6972 (if with-filter
6973 (setq org-agenda-clockreport-mode 'with-filter)
6974 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
6975 (org-agenda-set-mode-name)
6976 (org-agenda-redo)
6977 (message "Clocktable mode is %s"
6978 (if org-agenda-clockreport-mode "on" "off")))
6980 (defun org-agenda-log-mode (&optional special)
6981 "Toggle log mode in an agenda buffer.
6982 With argument SPECIAL, show all possible log items, not only the ones
6983 configured in `org-agenda-log-mode-items'.
6984 With a double `C-u' prefix arg, show *only* log items, nothing else."
6985 (interactive "P")
6986 (org-agenda-check-type t 'agenda 'timeline)
6987 (setq org-agenda-show-log
6988 (cond
6989 ((equal special '(16)) 'only)
6990 ((eq special 'clockcheck)
6991 (if (eq org-agenda-show-log 'clockcheck)
6992 nil 'clockcheck))
6993 (special '(closed clock state))
6994 (t (not org-agenda-show-log))))
6995 (org-agenda-set-mode-name)
6996 (org-agenda-redo)
6997 (message "Log mode is %s"
6998 (if org-agenda-show-log "on" "off")))
7000 (defun org-agenda-archives-mode (&optional with-files)
7001 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7002 When called with a prefix argument, include all archive files as well."
7003 (interactive "P")
7004 (setq org-agenda-archives-mode
7005 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7006 (org-agenda-set-mode-name)
7007 (org-agenda-redo)
7008 (message
7009 "%s"
7010 (cond
7011 ((eq org-agenda-archives-mode nil)
7012 "No archives are included")
7013 ((eq org-agenda-archives-mode 'trees)
7014 (format "Trees with :%s: tag are included" org-archive-tag))
7015 ((eq org-agenda-archives-mode t)
7016 (format "Trees with :%s: tag and all active archive files are included"
7017 org-archive-tag)))))
7019 (defun org-agenda-toggle-diary ()
7020 "Toggle diary inclusion in an agenda buffer."
7021 (interactive)
7022 (org-agenda-check-type t 'agenda)
7023 (setq org-agenda-include-diary (not org-agenda-include-diary))
7024 (org-agenda-redo)
7025 (org-agenda-set-mode-name)
7026 (message "Diary inclusion turned %s"
7027 (if org-agenda-include-diary "on" "off")))
7029 (defun org-agenda-toggle-deadlines ()
7030 "Toggle inclusion of entries with a deadline in an agenda buffer."
7031 (interactive)
7032 (org-agenda-check-type t 'agenda)
7033 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7034 (org-agenda-redo)
7035 (org-agenda-set-mode-name)
7036 (message "Deadlines inclusion turned %s"
7037 (if org-agenda-include-deadlines "on" "off")))
7039 (defun org-agenda-toggle-time-grid ()
7040 "Toggle time grid in an agenda buffer."
7041 (interactive)
7042 (org-agenda-check-type t 'agenda)
7043 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7044 (org-agenda-redo)
7045 (org-agenda-set-mode-name)
7046 (message "Time-grid turned %s"
7047 (if org-agenda-use-time-grid "on" "off")))
7049 (defun org-agenda-set-mode-name ()
7050 "Set the mode name to indicate all the small mode settings."
7051 (setq mode-name
7052 (list "Org-Agenda"
7053 (if (get 'org-agenda-files 'org-restrict) " []" "")
7055 '(:eval (org-agenda-span-name org-agenda-current-span))
7056 (if org-agenda-follow-mode " Follow" "")
7057 (if org-agenda-entry-text-mode " ETxt" "")
7058 (if org-agenda-include-diary " Diary" "")
7059 (if org-agenda-include-deadlines " Ddl" "")
7060 (if org-agenda-use-time-grid " Grid" "")
7061 (if (and (boundp 'org-habit-show-habits)
7062 org-habit-show-habits) " Habit" "")
7063 (cond
7064 ((consp org-agenda-show-log) " LogAll")
7065 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7066 (org-agenda-show-log " Log")
7067 (t ""))
7068 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7069 :preset-filter))
7070 '(:eval (org-propertize
7071 (concat " <"
7072 (mapconcat
7073 'identity
7074 (append
7075 (get 'org-agenda-category-filter :preset-filter)
7076 org-agenda-category-filter)
7078 ">")
7079 'face 'org-agenda-filter-category
7080 'help-echo "Category used in filtering"))
7082 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7083 :preset-filter))
7084 '(:eval (org-propertize
7085 (concat " {"
7086 (mapconcat
7087 'identity
7088 (append
7089 (get 'org-agenda-tag-filter :preset-filter)
7090 org-agenda-tag-filter)
7092 "}")
7093 'face 'org-agenda-filter-tags
7094 'help-echo "Tags used in filtering"))
7096 (if org-agenda-archives-mode
7097 (if (eq org-agenda-archives-mode t)
7098 " Archives"
7099 (format " :%s:" org-archive-tag))
7101 (if org-agenda-clockreport-mode
7102 (if (eq org-agenda-clockreport-mode 'with-filter)
7103 " Clock{}" " Clock")
7104 "")))
7105 (force-mode-line-update))
7107 (defun org-agenda-post-command-hook ()
7108 (setq org-agenda-type
7109 (or (get-text-property (point) 'org-agenda-type)
7110 (get-text-property (max (point-min) (1- (point)))
7111 'org-agenda-type))))
7113 (defun org-agenda-next-line ()
7114 "Move cursor to the next line, and show if follow mode is active."
7115 (interactive)
7116 (call-interactively 'next-line)
7117 (org-agenda-do-context-action))
7119 (defun org-agenda-previous-line ()
7120 "Move cursor to the previous line, and show if follow-mode is active."
7121 (interactive)
7122 (call-interactively 'previous-line)
7123 (org-agenda-do-context-action))
7125 (defun org-agenda-do-context-action ()
7126 "Show outline path and, maybe, follow mode window."
7127 (let ((m (org-get-at-bol 'org-marker)))
7128 (when (and (markerp m) (marker-buffer m))
7129 (and org-agenda-follow-mode
7130 (if org-agenda-follow-indirect
7131 (org-agenda-tree-to-indirect-buffer)
7132 (org-agenda-show)))
7133 (and org-agenda-show-outline-path
7134 (org-with-point-at m (org-display-outline-path t))))))
7136 (defun org-agenda-show-priority ()
7137 "Show the priority of the current item.
7138 This priority is composed of the main priority given with the [#A] cookies,
7139 and by additional input from the age of a schedules or deadline entry."
7140 (interactive)
7141 (let* ((pri (org-get-at-bol 'priority)))
7142 (message "Priority is %d" (if pri pri -1000))))
7144 (defun org-agenda-show-tags ()
7145 "Show the tags applicable to the current item."
7146 (interactive)
7147 (let* ((tags (org-get-at-bol 'tags)))
7148 (if tags
7149 (message "Tags are :%s:"
7150 (org-no-properties (mapconcat 'identity tags ":")))
7151 (message "No tags associated with this line"))))
7153 (defun org-agenda-goto (&optional highlight)
7154 "Go to the Org-mode file which contains the item at point."
7155 (interactive)
7156 (let* ((marker (or (org-get-at-bol 'org-marker)
7157 (org-agenda-error)))
7158 (buffer (marker-buffer marker))
7159 (pos (marker-position marker)))
7160 (switch-to-buffer-other-window buffer)
7161 (widen)
7162 (push-mark)
7163 (goto-char pos)
7164 (when (eq major-mode 'org-mode)
7165 (org-show-context 'agenda)
7166 (save-excursion
7167 (and (outline-next-heading)
7168 (org-flag-heading nil)))) ; show the next heading
7169 (when (outline-invisible-p)
7170 (show-entry)) ; display invisible text
7171 (recenter (/ (window-height) 2))
7172 (run-hooks 'org-agenda-after-show-hook)
7173 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7175 (defvar org-agenda-after-show-hook nil
7176 "Normal hook run after an item has been shown from the agenda.
7177 Point is in the buffer where the item originated.")
7179 (defun org-agenda-kill ()
7180 "Kill the entry or subtree belonging to the current agenda entry."
7181 (interactive)
7182 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7183 (let* ((marker (or (org-get-at-bol 'org-marker)
7184 (org-agenda-error)))
7185 (buffer (marker-buffer marker))
7186 (pos (marker-position marker))
7187 (type (org-get-at-bol 'type))
7188 dbeg dend (n 0) conf)
7189 (org-with-remote-undo buffer
7190 (with-current-buffer buffer
7191 (save-excursion
7192 (goto-char pos)
7193 (if (and (eq major-mode 'org-mode) (not (member type '("sexp"))))
7194 (setq dbeg (progn (org-back-to-heading t) (point))
7195 dend (org-end-of-subtree t t))
7196 (setq dbeg (point-at-bol)
7197 dend (min (point-max) (1+ (point-at-eol)))))
7198 (goto-char dbeg)
7199 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7200 (setq conf (or (eq t org-agenda-confirm-kill)
7201 (and (numberp org-agenda-confirm-kill)
7202 (> n org-agenda-confirm-kill))))
7203 (and conf
7204 (not (y-or-n-p
7205 (format "Delete entry with %d lines in buffer \"%s\"? "
7206 n (buffer-name buffer))))
7207 (error "Abort"))
7208 (org-remove-subtree-entries-from-agenda buffer dbeg dend)
7209 (with-current-buffer buffer (delete-region dbeg dend))
7210 (message "Agenda item and source killed"))))
7212 (defvar org-archive-default-command)
7213 (defun org-agenda-archive-default ()
7214 "Archive the entry or subtree belonging to the current agenda entry."
7215 (interactive)
7216 (require 'org-archive)
7217 (org-agenda-archive-with org-archive-default-command))
7219 (defun org-agenda-archive-default-with-confirmation ()
7220 "Archive the entry or subtree belonging to the current agenda entry."
7221 (interactive)
7222 (require 'org-archive)
7223 (org-agenda-archive-with org-archive-default-command 'confirm))
7225 (defun org-agenda-archive ()
7226 "Archive the entry or subtree belonging to the current agenda entry."
7227 (interactive)
7228 (org-agenda-archive-with 'org-archive-subtree))
7230 (defun org-agenda-archive-to-archive-sibling ()
7231 "Move the entry to the archive sibling."
7232 (interactive)
7233 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7235 (defun org-agenda-archive-with (cmd &optional confirm)
7236 "Move the entry to the archive sibling."
7237 (interactive)
7238 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7239 (let* ((marker (or (org-get-at-bol 'org-marker)
7240 (org-agenda-error)))
7241 (buffer (marker-buffer marker))
7242 (pos (marker-position marker)))
7243 (org-with-remote-undo buffer
7244 (with-current-buffer buffer
7245 (if (eq major-mode 'org-mode)
7246 (if (and confirm
7247 (not (y-or-n-p "Archive this subtree or entry? ")))
7248 (error "Abort")
7249 (save-excursion
7250 (goto-char pos)
7251 (org-remove-subtree-entries-from-agenda)
7252 (org-back-to-heading t)
7253 (funcall cmd)))
7254 (error "Archiving works only in Org-mode files"))))))
7256 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7257 "Remove all lines in the agenda that correspond to a given subtree.
7258 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7259 If this information is not given, the function uses the tree at point."
7260 (let ((buf (or buf (current-buffer))) m p)
7261 (save-excursion
7262 (unless (and beg end)
7263 (org-back-to-heading t)
7264 (setq beg (point))
7265 (org-end-of-subtree t)
7266 (setq end (point)))
7267 (set-buffer (get-buffer org-agenda-buffer-name))
7268 (save-excursion
7269 (goto-char (point-max))
7270 (beginning-of-line 1)
7271 (while (not (bobp))
7272 (when (and (setq m (org-get-at-bol 'org-marker))
7273 (equal buf (marker-buffer m))
7274 (setq p (marker-position m))
7275 (>= p beg)
7276 (< p end))
7277 (let ((inhibit-read-only t))
7278 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7279 (beginning-of-line 0))))))
7281 (defun org-agenda-refile (&optional goto rfloc no-update)
7282 "Refile the item at point."
7283 (interactive "P")
7284 (if (equal goto '(16))
7285 (org-refile-goto-last-stored)
7286 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7287 (org-agenda-error)))
7288 (buffer (marker-buffer marker))
7289 (pos (marker-position marker))
7290 (rfloc (or rfloc
7291 (org-refile-get-location
7292 (if goto "Goto" "Refile to") buffer
7293 org-refile-allow-creating-parent-nodes))))
7294 (with-current-buffer buffer
7295 (save-excursion
7296 (save-restriction
7297 (widen)
7298 (goto-char marker)
7299 (org-remove-subtree-entries-from-agenda)
7300 (org-refile goto buffer rfloc)))))
7301 (unless no-update (org-agenda-redo))))
7303 (defun org-agenda-open-link (&optional arg)
7304 "Follow the link in the current line, if any.
7305 This looks for a link in the displayed line in the agenda. It also looks
7306 at the text of the entry itself."
7307 (interactive "P")
7308 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7309 (org-get-at-bol 'org-marker)))
7310 (buffer (and marker (marker-buffer marker)))
7311 (prefix (buffer-substring
7312 (point-at-bol) (point-at-eol))))
7313 (cond
7314 (buffer
7315 (with-current-buffer buffer
7316 (save-excursion
7317 (save-restriction
7318 (widen)
7319 (goto-char marker)
7320 (org-offer-links-in-entry arg prefix)))))
7321 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7322 (save-excursion
7323 (beginning-of-line 1)
7324 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7325 (org-open-link-from-string (match-string 1)))
7326 (t (error "No link to open here")))))
7328 (defun org-agenda-copy-local-variable (var)
7329 "Get a variable from a referenced buffer and install it here."
7330 (let ((m (org-get-at-bol 'org-marker)))
7331 (when (and m (buffer-live-p (marker-buffer m)))
7332 (org-set-local var (with-current-buffer (marker-buffer m)
7333 (symbol-value var))))))
7335 (defun org-agenda-switch-to (&optional delete-other-windows)
7336 "Go to the Org-mode file which contains the item at point."
7337 (interactive)
7338 (if (and org-return-follows-link
7339 (not (org-get-at-bol 'org-marker))
7340 (org-in-regexp org-bracket-link-regexp))
7341 (org-open-link-from-string (match-string 0))
7342 (let* ((marker (or (org-get-at-bol 'org-marker)
7343 (org-agenda-error)))
7344 (buffer (marker-buffer marker))
7345 (pos (marker-position marker)))
7346 (org-pop-to-buffer-same-window buffer)
7347 (and delete-other-windows (delete-other-windows))
7348 (widen)
7349 (goto-char pos)
7350 (when (eq major-mode 'org-mode)
7351 (org-show-context 'agenda)
7352 (save-excursion
7353 (and (outline-next-heading)
7354 (org-flag-heading nil))) ; show the next heading
7355 (when (outline-invisible-p)
7356 (show-entry)))))) ; display invisible text
7358 (defun org-agenda-goto-mouse (ev)
7359 "Go to the Org-mode file which contains the item at the mouse click."
7360 (interactive "e")
7361 (mouse-set-point ev)
7362 (org-agenda-goto))
7364 (defun org-agenda-show (&optional full-entry)
7365 "Display the Org-mode file which contains the item at point.
7366 With prefix argument FULL-ENTRY, make the entire entry visible
7367 if it was hidden in the outline."
7368 (interactive "P")
7369 (let ((win (selected-window)))
7370 (if full-entry
7371 (let ((org-show-entry-below t))
7372 (org-agenda-goto t))
7373 (org-agenda-goto t))
7374 (select-window win)))
7376 (defvar org-agenda-show-window nil)
7377 (defun org-agenda-show-and-scroll-up (&optional arg)
7378 "Display the Org-mode file which contains the item at point.
7379 When called repeatedly, scroll the window that is displaying the buffer.
7380 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7381 `show-subtree' to display the item, so that drawers and logbooks stay
7382 folded."
7383 (interactive "P")
7384 (let ((win (selected-window)))
7385 (if (and (window-live-p org-agenda-show-window)
7386 (eq this-command last-command))
7387 (progn
7388 (select-window org-agenda-show-window)
7389 (ignore-errors (scroll-up)))
7390 (org-agenda-goto t)
7391 (if arg (org-show-entry) (show-subtree))
7392 (setq org-agenda-show-window (selected-window)))
7393 (select-window win)))
7395 (defun org-agenda-show-scroll-down ()
7396 "Scroll down the window showing the agenda."
7397 (interactive)
7398 (let ((win (selected-window)))
7399 (when (window-live-p org-agenda-show-window)
7400 (select-window org-agenda-show-window)
7401 (ignore-errors (scroll-down))
7402 (select-window win))))
7404 (defun org-agenda-show-1 (&optional more)
7405 "Display the Org-mode file which contains the item at point.
7406 The prefix arg selects the amount of information to display:
7408 0 hide the subtree
7409 1 just show the entry according to defaults.
7410 2 show the children view
7411 3 show the subtree view
7412 4 show the entire subtree and any LOGBOOK drawers
7413 5 show the entire subtree and any drawers
7414 With prefix argument FULL-ENTRY, make the entire entry visible
7415 if it was hidden in the outline."
7416 (interactive "p")
7417 (let ((win (selected-window)))
7418 (org-agenda-goto t)
7419 (org-recenter-heading 1)
7420 (cond
7421 ((= more 0)
7422 (hide-subtree)
7423 (save-excursion
7424 (org-back-to-heading)
7425 (run-hook-with-args 'org-cycle-hook 'folded))
7426 (message "Remote: FOLDED"))
7427 ((and (org-called-interactively-p 'any) (= more 1))
7428 (message "Remote: show with default settings"))
7429 ((= more 2)
7430 (show-entry)
7431 (show-children)
7432 (save-excursion
7433 (org-back-to-heading)
7434 (run-hook-with-args 'org-cycle-hook 'children))
7435 (message "Remote: CHILDREN"))
7436 ((= more 3)
7437 (show-subtree)
7438 (save-excursion
7439 (org-back-to-heading)
7440 (run-hook-with-args 'org-cycle-hook 'subtree))
7441 (message "Remote: SUBTREE"))
7442 ((= more 4)
7443 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7444 (org-drawer-regexp
7445 (concat "^[ \t]*:\\("
7446 (mapconcat 'regexp-quote org-drawers "\\|")
7447 "\\):[ \t]*$")))
7448 (show-subtree)
7449 (save-excursion
7450 (org-back-to-heading)
7451 (org-cycle-hide-drawers 'subtree)))
7452 (message "Remote: SUBTREE AND LOGBOOK"))
7453 ((> more 4)
7454 (show-subtree)
7455 (message "Remote: SUBTREE AND ALL DRAWERS")))
7456 (select-window win)))
7458 (defun org-recenter-heading (n)
7459 (save-excursion
7460 (org-back-to-heading)
7461 (recenter n)))
7463 (defvar org-agenda-cycle-counter nil)
7464 (defun org-agenda-cycle-show (&optional n)
7465 "Show the current entry in another window, with default settings.
7466 Default settings are taken from `org-show-hierarchy-above' and siblings.
7467 When use repeatedly in immediate succession, the remote entry will cycle
7468 through visibility
7470 children -> subtree -> folded
7472 When called with a numeric prefix arg, that arg will be passed through to
7473 `org-agenda-show-1'. For the interpretation of that argument, see the
7474 docstring of `org-agenda-show-1'."
7475 (interactive "P")
7476 (if (integerp n)
7477 (setq org-agenda-cycle-counter n)
7478 (if (not (eq last-command this-command))
7479 (setq org-agenda-cycle-counter 1)
7480 (if (equal org-agenda-cycle-counter 0)
7481 (setq org-agenda-cycle-counter 2)
7482 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7483 (if (> org-agenda-cycle-counter 3)
7484 (setq org-agenda-cycle-counter 0)))))
7485 (org-agenda-show-1 org-agenda-cycle-counter))
7487 (defun org-agenda-recenter (arg)
7488 "Display the Org-mode file which contains the item at point and recenter."
7489 (interactive "P")
7490 (let ((win (selected-window)))
7491 (org-agenda-goto t)
7492 (recenter arg)
7493 (select-window win)))
7495 (defun org-agenda-show-mouse (ev)
7496 "Display the Org-mode file which contains the item at the mouse click."
7497 (interactive "e")
7498 (mouse-set-point ev)
7499 (org-agenda-show))
7501 (defun org-agenda-check-no-diary ()
7502 "Check if the entry is a diary link and abort if yes."
7503 (if (org-get-at-bol 'org-agenda-diary-link)
7504 (org-agenda-error)))
7506 (defun org-agenda-error ()
7507 (error "Command not allowed in this line"))
7509 (defun org-agenda-tree-to-indirect-buffer ()
7510 "Show the subtree corresponding to the current entry in an indirect buffer.
7511 This calls the command `org-tree-to-indirect-buffer' from the original
7512 Org-mode buffer.
7513 With numerical prefix arg ARG, go up to this level and then take that tree.
7514 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7515 use the dedicated frame)."
7516 (interactive)
7517 (if (and current-prefix-arg (listp current-prefix-arg))
7518 (org-agenda-do-tree-to-indirect-buffer)
7519 (let ((agenda-window (selected-window))
7520 (indirect-window (and org-last-indirect-buffer (get-buffer-window org-last-indirect-buffer))))
7521 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7522 (unwind-protect
7523 (progn
7524 (unless (and indirect-window (window-live-p indirect-window))
7525 (setq indirect-window (split-window agenda-window)))
7526 (select-window indirect-window)
7527 (switch-to-buffer org-last-indirect-buffer :norecord)
7528 (fit-window-to-buffer indirect-window))
7529 (select-window agenda-window)))))
7531 (defun org-agenda-do-tree-to-indirect-buffer ()
7532 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7533 (org-agenda-check-no-diary)
7534 (let* ((marker (or (org-get-at-bol 'org-marker)
7535 (org-agenda-error)))
7536 (buffer (marker-buffer marker))
7537 (pos (marker-position marker)))
7538 (with-current-buffer buffer
7539 (save-excursion
7540 (goto-char pos)
7541 (call-interactively 'org-tree-to-indirect-buffer)))))
7543 (defvar org-last-heading-marker (make-marker)
7544 "Marker pointing to the headline that last changed its TODO state
7545 by a remote command from the agenda.")
7547 (defun org-agenda-todo-nextset ()
7548 "Switch TODO entry to next sequence."
7549 (interactive)
7550 (org-agenda-todo 'nextset))
7552 (defun org-agenda-todo-previousset ()
7553 "Switch TODO entry to previous sequence."
7554 (interactive)
7555 (org-agenda-todo 'previousset))
7557 (defun org-agenda-todo (&optional arg)
7558 "Cycle TODO state of line at point, also in Org-mode file.
7559 This changes the line at point, all other lines in the agenda referring to
7560 the same tree node, and the headline of the tree node in the Org-mode file."
7561 (interactive "P")
7562 (org-agenda-check-no-diary)
7563 (let* ((col (current-column))
7564 (marker (or (org-get-at-bol 'org-marker)
7565 (org-agenda-error)))
7566 (buffer (marker-buffer marker))
7567 (pos (marker-position marker))
7568 (hdmarker (org-get-at-bol 'org-hd-marker))
7569 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7570 (inhibit-read-only t)
7571 org-agenda-headline-snapshot-before-repeat newhead just-one)
7572 (org-with-remote-undo buffer
7573 (with-current-buffer buffer
7574 (widen)
7575 (goto-char pos)
7576 (org-show-context 'agenda)
7577 (save-excursion
7578 (and (outline-next-heading)
7579 (org-flag-heading nil))) ; show the next heading
7580 (let ((current-prefix-arg arg))
7581 (call-interactively 'org-todo))
7582 (and (bolp) (forward-char 1))
7583 (setq newhead (org-get-heading))
7584 (when (and (org-bound-and-true-p
7585 org-agenda-headline-snapshot-before-repeat)
7586 (not (equal org-agenda-headline-snapshot-before-repeat
7587 newhead))
7588 todayp)
7589 (setq newhead org-agenda-headline-snapshot-before-repeat
7590 just-one t))
7591 (save-excursion
7592 (org-back-to-heading)
7593 (move-marker org-last-heading-marker (point))))
7594 (beginning-of-line 1)
7595 (save-excursion
7596 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7597 (org-move-to-column col))))
7599 (defun org-agenda-add-note (&optional arg)
7600 "Add a time-stamped note to the entry at point."
7601 (interactive "P")
7602 (org-agenda-check-no-diary)
7603 (let* ((marker (or (org-get-at-bol 'org-marker)
7604 (org-agenda-error)))
7605 (buffer (marker-buffer marker))
7606 (pos (marker-position marker))
7607 (hdmarker (org-get-at-bol 'org-hd-marker))
7608 (inhibit-read-only t))
7609 (with-current-buffer buffer
7610 (widen)
7611 (goto-char pos)
7612 (org-show-context 'agenda)
7613 (save-excursion
7614 (and (outline-next-heading)
7615 (org-flag-heading nil))) ; show the next heading
7616 (org-add-note))))
7618 (defun org-agenda-change-all-lines (newhead hdmarker
7619 &optional fixface just-this)
7620 "Change all lines in the agenda buffer which match HDMARKER.
7621 The new content of the line will be NEWHEAD (as modified by
7622 `org-agenda-format-item'). HDMARKER is checked with
7623 `equal' against all `org-hd-marker' text properties in the file.
7624 If FIXFACE is non-nil, the face of each item is modified according to
7625 the new TODO state.
7626 If JUST-THIS is non-nil, change just the current line, not all.
7627 If FORCE-TAGS is non nil, the car of it returns the new tags."
7628 (let* ((inhibit-read-only t)
7629 (line (org-current-line))
7630 (org-agenda-buffer (current-buffer))
7631 (thetags (with-current-buffer (marker-buffer hdmarker)
7632 (save-excursion (save-restriction (widen)
7633 (goto-char hdmarker)
7634 (org-get-tags-at)))))
7635 props m pl undone-face done-face finish new dotime cat tags)
7636 (save-excursion
7637 (goto-char (point-max))
7638 (beginning-of-line 1)
7639 (while (not finish)
7640 (setq finish (bobp))
7641 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7642 (or (not just-this) (= (org-current-line) line))
7643 (equal m hdmarker))
7644 (setq props (text-properties-at (point))
7645 dotime (org-get-at-bol 'dotime)
7646 cat (org-get-at-bol 'org-category)
7647 tags thetags
7649 (let ((org-prefix-format-compiled
7650 (or (get-text-property (point) 'format)
7651 org-prefix-format-compiled)))
7652 (with-current-buffer (marker-buffer hdmarker)
7653 (save-excursion
7654 (save-restriction
7655 (widen)
7656 (org-agenda-format-item (org-get-at-bol 'extra)
7657 newhead cat tags dotime)))))
7658 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
7659 undone-face (org-get-at-bol 'undone-face)
7660 done-face (org-get-at-bol 'done-face))
7661 (beginning-of-line 1)
7662 (cond
7663 ((equal new "")
7664 (and (looking-at ".*\n?") (replace-match "")))
7665 ((looking-at ".*")
7666 (replace-match new t t)
7667 (beginning-of-line 1)
7668 (add-text-properties (point-at-bol) (point-at-eol) props)
7669 (when fixface
7670 (add-text-properties
7671 (point-at-bol) (point-at-eol)
7672 (list 'face
7673 (if org-last-todo-state-is-todo
7674 undone-face done-face))))
7675 (org-agenda-highlight-todo 'line)
7676 (beginning-of-line 1))
7677 (t (error "Line update did not work"))))
7678 (beginning-of-line 0)))
7679 (org-finalize-agenda)))
7681 (defun org-agenda-align-tags (&optional line)
7682 "Align all tags in agenda items to `org-agenda-tags-column'."
7683 (let ((inhibit-read-only t) l c)
7684 (save-excursion
7685 (goto-char (if line (point-at-bol) (point-min)))
7686 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
7687 (if line (point-at-eol) nil) t)
7688 (add-text-properties
7689 (match-beginning 2) (match-end 2)
7690 (list 'face (delq nil (let ((prop (get-text-property
7691 (match-beginning 2) 'face)))
7692 (or (listp prop) (setq prop (list prop)))
7693 (if (memq 'org-tag prop)
7694 prop
7695 (cons 'org-tag prop))))))
7696 (setq l (- (match-end 2) (match-beginning 2))
7697 c (if (< org-agenda-tags-column 0)
7698 (- (abs org-agenda-tags-column) l)
7699 org-agenda-tags-column))
7700 (delete-region (match-beginning 1) (match-end 1))
7701 (goto-char (match-beginning 1))
7702 (insert (org-add-props
7703 (make-string (max 1 (- c (current-column))) ?\ )
7704 (plist-put (copy-sequence (text-properties-at (point)))
7705 'face nil))))
7706 (goto-char (point-min))
7707 (org-font-lock-add-tag-faces (point-max)))))
7709 (defun org-agenda-priority-up ()
7710 "Increase the priority of line at point, also in Org-mode file."
7711 (interactive)
7712 (org-agenda-priority 'up))
7714 (defun org-agenda-priority-down ()
7715 "Decrease the priority of line at point, also in Org-mode file."
7716 (interactive)
7717 (org-agenda-priority 'down))
7719 (defun org-agenda-priority (&optional force-direction)
7720 "Set the priority of line at point, also in Org-mode file.
7721 This changes the line at point, all other lines in the agenda referring to
7722 the same tree node, and the headline of the tree node in the Org-mode file."
7723 (interactive)
7724 (unless org-enable-priority-commands
7725 (error "Priority commands are disabled"))
7726 (org-agenda-check-no-diary)
7727 (let* ((marker (or (org-get-at-bol 'org-marker)
7728 (org-agenda-error)))
7729 (hdmarker (org-get-at-bol 'org-hd-marker))
7730 (buffer (marker-buffer hdmarker))
7731 (pos (marker-position hdmarker))
7732 (inhibit-read-only t)
7733 newhead)
7734 (org-with-remote-undo buffer
7735 (with-current-buffer buffer
7736 (widen)
7737 (goto-char pos)
7738 (org-show-context 'agenda)
7739 (save-excursion
7740 (and (outline-next-heading)
7741 (org-flag-heading nil))) ; show the next heading
7742 (funcall 'org-priority force-direction)
7743 (end-of-line 1)
7744 (setq newhead (org-get-heading)))
7745 (org-agenda-change-all-lines newhead hdmarker)
7746 (beginning-of-line 1))))
7748 ;; FIXME: should fix the tags property of the agenda line.
7749 (defun org-agenda-set-tags (&optional tag onoff)
7750 "Set tags for the current headline."
7751 (interactive)
7752 (org-agenda-check-no-diary)
7753 (if (and (org-region-active-p) (org-called-interactively-p 'any))
7754 (call-interactively 'org-change-tag-in-region)
7755 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7756 (org-agenda-error)))
7757 (buffer (marker-buffer hdmarker))
7758 (pos (marker-position hdmarker))
7759 (inhibit-read-only t)
7760 newhead)
7761 (org-with-remote-undo buffer
7762 (with-current-buffer buffer
7763 (widen)
7764 (goto-char pos)
7765 (save-excursion
7766 (org-show-context 'agenda))
7767 (save-excursion
7768 (and (outline-next-heading)
7769 (org-flag-heading nil))) ; show the next heading
7770 (goto-char pos)
7771 (if tag
7772 (org-toggle-tag tag onoff)
7773 (call-interactively 'org-set-tags))
7774 (end-of-line 1)
7775 (setq newhead (org-get-heading)))
7776 (org-agenda-change-all-lines newhead hdmarker)
7777 (beginning-of-line 1)))))
7779 (defun org-agenda-set-property ()
7780 "Set a property for the current headline."
7781 (interactive)
7782 (org-agenda-check-no-diary)
7783 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7784 (org-agenda-error)))
7785 (buffer (marker-buffer hdmarker))
7786 (pos (marker-position hdmarker))
7787 (inhibit-read-only t)
7788 newhead)
7789 (org-with-remote-undo buffer
7790 (with-current-buffer buffer
7791 (widen)
7792 (goto-char pos)
7793 (save-excursion
7794 (org-show-context 'agenda))
7795 (save-excursion
7796 (and (outline-next-heading)
7797 (org-flag-heading nil))) ; show the next heading
7798 (goto-char pos)
7799 (call-interactively 'org-set-property)))))
7801 (defun org-agenda-set-effort ()
7802 "Set the effort property for the current headline."
7803 (interactive)
7804 (org-agenda-check-no-diary)
7805 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7806 (org-agenda-error)))
7807 (buffer (marker-buffer hdmarker))
7808 (pos (marker-position hdmarker))
7809 (inhibit-read-only t)
7810 newhead)
7811 (org-with-remote-undo buffer
7812 (with-current-buffer buffer
7813 (widen)
7814 (goto-char pos)
7815 (save-excursion
7816 (org-show-context 'agenda))
7817 (save-excursion
7818 (and (outline-next-heading)
7819 (org-flag-heading nil))) ; show the next heading
7820 (goto-char pos)
7821 (call-interactively 'org-set-effort)
7822 (end-of-line 1)
7823 (setq newhead (org-get-heading)))
7824 (org-agenda-change-all-lines newhead hdmarker))))
7826 (defun org-agenda-toggle-archive-tag ()
7827 "Toggle the archive tag for the current entry."
7828 (interactive)
7829 (org-agenda-check-no-diary)
7830 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7831 (org-agenda-error)))
7832 (buffer (marker-buffer hdmarker))
7833 (pos (marker-position hdmarker))
7834 (inhibit-read-only t)
7835 newhead)
7836 (org-with-remote-undo buffer
7837 (with-current-buffer buffer
7838 (widen)
7839 (goto-char pos)
7840 (org-show-context 'agenda)
7841 (save-excursion
7842 (and (outline-next-heading)
7843 (org-flag-heading nil))) ; show the next heading
7844 (call-interactively 'org-toggle-archive-tag)
7845 (end-of-line 1)
7846 (setq newhead (org-get-heading)))
7847 (org-agenda-change-all-lines newhead hdmarker)
7848 (beginning-of-line 1))))
7850 (defun org-agenda-do-date-later (arg)
7851 (interactive "P")
7852 (cond
7853 ((or (equal arg '(16))
7854 (memq last-command
7855 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
7856 (setq this-command 'org-agenda-date-later-minutes)
7857 (org-agenda-date-later-minutes 1))
7858 ((or (equal arg '(4))
7859 (memq last-command
7860 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
7861 (setq this-command 'org-agenda-date-later-hours)
7862 (org-agenda-date-later-hours 1))
7864 (org-agenda-date-later (prefix-numeric-value arg)))))
7866 (defun org-agenda-do-date-earlier (arg)
7867 (interactive "P")
7868 (cond
7869 ((or (equal arg '(16))
7870 (memq last-command
7871 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
7872 (setq this-command 'org-agenda-date-earlier-minutes)
7873 (org-agenda-date-earlier-minutes 1))
7874 ((or (equal arg '(4))
7875 (memq last-command
7876 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
7877 (setq this-command 'org-agenda-date-earlier-hours)
7878 (org-agenda-date-earlier-hours 1))
7880 (org-agenda-date-earlier (prefix-numeric-value arg)))))
7882 (defun org-agenda-date-later (arg &optional what)
7883 "Change the date of this item to ARG day(s) later."
7884 (interactive "p")
7885 (org-agenda-check-type t 'agenda 'timeline)
7886 (org-agenda-check-no-diary)
7887 (let* ((marker (or (org-get-at-bol 'org-marker)
7888 (org-agenda-error)))
7889 (buffer (marker-buffer marker))
7890 (pos (marker-position marker))
7891 cdate today)
7892 (org-with-remote-undo buffer
7893 (with-current-buffer buffer
7894 (widen)
7895 (goto-char pos)
7896 (if (not (org-at-timestamp-p))
7897 (error "Cannot find time stamp"))
7898 (when (and org-agenda-move-date-from-past-immediately-to-today
7899 (equal arg 1)
7900 (or (not what) (eq what 'day))
7901 (not (save-match-data (org-at-date-range-p))))
7902 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
7903 cdate (calendar-absolute-from-gregorian
7904 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
7905 today (org-today))
7906 (if (> today cdate)
7907 ;; immediately shift to today
7908 (setq arg (- today cdate))))
7909 (org-timestamp-change arg (or what 'day))
7910 (when (and (org-at-date-range-p)
7911 (re-search-backward org-tr-regexp-both (point-at-bol)))
7912 (let ((end org-last-changed-timestamp))
7913 (org-timestamp-change arg (or what 'day))
7914 (setq org-last-changed-timestamp
7915 (concat org-last-changed-timestamp "--" end)))))
7916 (org-agenda-show-new-time marker org-last-changed-timestamp))
7917 (message "Time stamp changed to %s" org-last-changed-timestamp)))
7919 (defun org-agenda-date-earlier (arg &optional what)
7920 "Change the date of this item to ARG day(s) earlier."
7921 (interactive "p")
7922 (org-agenda-date-later (- arg) what))
7924 (defun org-agenda-date-later-minutes (arg)
7925 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
7926 (interactive "p")
7927 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
7928 (org-agenda-date-later arg 'minute))
7930 (defun org-agenda-date-earlier-minutes (arg)
7931 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
7932 (interactive "p")
7933 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
7934 (org-agenda-date-earlier arg 'minute))
7936 (defun org-agenda-date-later-hours (arg)
7937 "Change the time of this item, in hour steps."
7938 (interactive "p")
7939 (org-agenda-date-later arg 'hour))
7941 (defun org-agenda-date-earlier-hours (arg)
7942 "Change the time of this item, in hour steps."
7943 (interactive "p")
7944 (org-agenda-date-earlier arg 'hour))
7946 (defun org-agenda-show-new-time (marker stamp &optional prefix)
7947 "Show new date stamp via text properties."
7948 ;; We use text properties to make this undoable
7949 (let ((inhibit-read-only t)
7950 (buffer-invisibility-spec))
7951 (setq stamp (concat " " prefix " => " stamp))
7952 (save-excursion
7953 (goto-char (point-max))
7954 (while (not (bobp))
7955 (when (equal marker (org-get-at-bol 'org-marker))
7956 (org-move-to-column (- (window-width) (length stamp)) t)
7957 (org-agenda-fix-tags-filter-overlays-at (point))
7958 (if (featurep 'xemacs)
7959 ;; Use `duplicable' property to trigger undo recording
7960 (let ((ex (make-extent nil nil))
7961 (gl (make-glyph stamp)))
7962 (set-glyph-face gl 'secondary-selection)
7963 (set-extent-properties
7964 ex (list 'invisible t 'end-glyph gl 'duplicable t))
7965 (insert-extent ex (1- (point)) (point-at-eol)))
7966 (add-text-properties
7967 (1- (point)) (point-at-eol)
7968 (list 'display (org-add-props stamp nil
7969 'face 'secondary-selection))))
7970 (beginning-of-line 1))
7971 (beginning-of-line 0)))))
7973 (defun org-agenda-date-prompt (arg)
7974 "Change the date of this item. Date is prompted for, with default today.
7975 The prefix ARG is passed to the `org-time-stamp' command and can therefore
7976 be used to request time specification in the time stamp."
7977 (interactive "P")
7978 (org-agenda-check-type t 'agenda 'timeline)
7979 (org-agenda-check-no-diary)
7980 (let* ((marker (or (org-get-at-bol 'org-marker)
7981 (org-agenda-error)))
7982 (buffer (marker-buffer marker))
7983 (pos (marker-position marker)))
7984 (org-with-remote-undo buffer
7985 (with-current-buffer buffer
7986 (widen)
7987 (goto-char pos)
7988 (if (not (org-at-timestamp-p t))
7989 (error "Cannot find time stamp"))
7990 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
7991 (org-agenda-show-new-time marker org-last-changed-timestamp))
7992 (message "Time stamp changed to %s" org-last-changed-timestamp)))
7994 (defun org-agenda-schedule (arg &optional time)
7995 "Schedule the item at point.
7996 ARG is passed through to `org-schedule'."
7997 (interactive "P")
7998 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
7999 (org-agenda-check-no-diary)
8000 (let* ((marker (or (org-get-at-bol 'org-marker)
8001 (org-agenda-error)))
8002 (type (marker-insertion-type marker))
8003 (buffer (marker-buffer marker))
8004 (pos (marker-position marker))
8005 (org-insert-labeled-timestamps-at-point nil)
8007 (set-marker-insertion-type marker t)
8008 (org-with-remote-undo buffer
8009 (with-current-buffer buffer
8010 (widen)
8011 (goto-char pos)
8012 (setq ts (org-schedule arg time)))
8013 (org-agenda-show-new-time marker ts "S"))
8014 (message "Item scheduled for %s" ts)))
8016 (defun org-agenda-deadline (arg &optional time)
8017 "Schedule the item at point.
8018 ARG is passed through to `org-deadline'."
8019 (interactive "P")
8020 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8021 (org-agenda-check-no-diary)
8022 (let* ((marker (or (org-get-at-bol 'org-marker)
8023 (org-agenda-error)))
8024 (buffer (marker-buffer marker))
8025 (pos (marker-position marker))
8026 (org-insert-labeled-timestamps-at-point nil)
8028 (org-with-remote-undo buffer
8029 (with-current-buffer buffer
8030 (widen)
8031 (goto-char pos)
8032 (setq ts (org-deadline arg time)))
8033 (org-agenda-show-new-time marker ts "D"))
8034 (message "Deadline for this item set to %s" ts)))
8036 (defun org-agenda-action ()
8037 "Select entry for agenda action, or execute an agenda action.
8038 This command prompts for another letter. Valid inputs are:
8040 m Mark the entry at point for an agenda action
8041 s Schedule the marked entry to the date at the cursor
8042 d Set the deadline of the marked entry to the date at the cursor
8043 r Call `org-remember' with cursor date as the default date
8044 c Call `org-capture' with cursor date as the default date
8045 SPC Show marked entry in other window
8046 TAB Visit marked entry in other window
8048 The cursor may be at a date in the calendar, or in the Org agenda."
8049 (interactive)
8050 (let (ans)
8051 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
8052 (setq ans (read-char-exclusive))
8053 (cond
8054 ((equal ans ?m)
8055 ;; Mark this entry
8056 (if (eq major-mode 'org-agenda-mode)
8057 (let ((m (or (org-get-at-bol 'org-hd-marker)
8058 (org-get-at-bol 'org-marker))))
8059 (if m
8060 (progn
8061 (move-marker org-agenda-action-marker
8062 (marker-position m) (marker-buffer m))
8063 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
8064 (error "Don't know which entry to mark")))
8065 (error "This command works only in the agenda")))
8066 ((equal ans ?s)
8067 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
8068 ((equal ans ?d)
8069 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
8070 ((equal ans ?r)
8071 (org-agenda-do-action '(org-remember) t))
8072 ((equal ans ?c)
8073 (org-agenda-do-action '(org-capture) t))
8074 ((equal ans ?\ )
8075 (let ((cw (selected-window)))
8076 (org-switch-to-buffer-other-window
8077 (marker-buffer org-agenda-action-marker))
8078 (goto-char org-agenda-action-marker)
8079 (org-show-context 'agenda)
8080 (select-window cw)))
8081 ((equal ans ?\C-i)
8082 (org-switch-to-buffer-other-window
8083 (marker-buffer org-agenda-action-marker))
8084 (goto-char org-agenda-action-marker)
8085 (org-show-context 'agenda))
8086 (t (error "Invalid agenda action %c" ans)))))
8088 (defun org-agenda-do-action (form &optional current-buffer)
8089 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
8090 (let ((org-overriding-default-time (org-get-cursor-date)))
8091 (if current-buffer
8092 (eval form)
8093 (if (not (marker-buffer org-agenda-action-marker))
8094 (error "No entry has been selected for agenda action")
8095 (with-current-buffer (marker-buffer org-agenda-action-marker)
8096 (save-excursion
8097 (save-restriction
8098 (widen)
8099 (goto-char org-agenda-action-marker)
8100 (eval form))))))))
8102 (defun org-agenda-clock-in (&optional arg)
8103 "Start the clock on the currently selected item."
8104 (interactive "P")
8105 (org-agenda-check-no-diary)
8106 (if (equal arg '(4))
8107 (org-clock-in arg)
8108 (let* ((marker (or (org-get-at-bol 'org-marker)
8109 (org-agenda-error)))
8110 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8111 marker))
8112 (pos (marker-position marker))
8113 newhead)
8114 (org-with-remote-undo (marker-buffer marker)
8115 (with-current-buffer (marker-buffer marker)
8116 (widen)
8117 (goto-char pos)
8118 (org-show-context 'agenda)
8119 (org-show-entry)
8120 (org-cycle-hide-drawers 'children)
8121 (org-clock-in arg)
8122 (setq newhead (org-get-heading)))
8123 (org-agenda-change-all-lines newhead hdmarker)))))
8125 (defun org-agenda-clock-out ()
8126 "Stop the currently running clock."
8127 (interactive)
8128 (unless (marker-buffer org-clock-marker)
8129 (error "No running clock"))
8130 (let ((marker (make-marker)) newhead)
8131 (org-with-remote-undo (marker-buffer org-clock-marker)
8132 (with-current-buffer (marker-buffer org-clock-marker)
8133 (save-excursion
8134 (save-restriction
8135 (widen)
8136 (goto-char org-clock-marker)
8137 (org-back-to-heading t)
8138 (move-marker marker (point))
8139 (org-clock-out)
8140 (setq newhead (org-get-heading))))))
8141 (org-agenda-change-all-lines newhead marker)
8142 (move-marker marker nil)))
8144 (defun org-agenda-clock-cancel (&optional arg)
8145 "Cancel the currently running clock."
8146 (interactive "P")
8147 (unless (marker-buffer org-clock-marker)
8148 (error "No running clock"))
8149 (org-with-remote-undo (marker-buffer org-clock-marker)
8150 (org-clock-cancel)))
8152 (defun org-agenda-clock-goto ()
8153 "Jump to the currently clocked in task within the agenda.
8154 If the currently clocked in task is not listed in the agenda
8155 buffer, display it in another window."
8156 (interactive)
8157 (let (pos)
8158 (mapc (lambda (o)
8159 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8160 (setq pos (overlay-start o))))
8161 (overlays-in (point-min) (point-max)))
8162 (cond (pos (goto-char pos))
8163 ;; If the currently clocked entry is not in the agenda
8164 ;; buffer, we visit it in another window:
8165 (org-clock-current-task
8166 (org-switch-to-buffer-other-window (org-clock-goto)))
8167 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8169 (defun org-agenda-diary-entry-in-org-file ()
8170 "Make a diary entry in the file `org-agenda-diary-file'."
8171 (let (d1 d2 char (text "") dp1 dp2)
8172 (if (equal (buffer-name) "*Calendar*")
8173 (setq d1 (calendar-cursor-to-date t)
8174 d2 (car calendar-mark-ring))
8175 (setq dp1 (get-text-property (point-at-bol) 'day))
8176 (unless dp1 (error "No date defined in current line"))
8177 (setq d1 (calendar-gregorian-from-absolute dp1)
8178 d2 (and (ignore-errors (mark))
8179 (save-excursion
8180 (goto-char (mark))
8181 (setq dp2 (get-text-property (point-at-bol) 'day)))
8182 (calendar-gregorian-from-absolute dp2))))
8183 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8184 (setq char (read-char-exclusive))
8185 (cond
8186 ((equal char ?d)
8187 (setq text (read-string "Day entry: "))
8188 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8189 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8190 ((equal char ?a)
8191 (setq d1 (list (car d1) (nth 1 d1)
8192 (read-number (format "Reference year [%d]: " (nth 2 d1))
8193 (nth 2 d1))))
8194 (setq text (read-string "Anniversary (use %d to show years): "))
8195 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8196 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8197 ((equal char ?b)
8198 (setq text (read-string "Block entry: "))
8199 (unless (and d1 d2 (not (equal d1 d2)))
8200 (error "No block of days selected"))
8201 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8202 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8203 ((equal char ?j)
8204 (org-switch-to-buffer-other-window
8205 (find-file-noselect org-agenda-diary-file))
8206 (require 'org-datetree)
8207 (org-datetree-find-date-create d1)
8208 (org-reveal t))
8209 (t (error "Invalid selection character `%c'" char)))))
8211 (defcustom org-agenda-insert-diary-strategy 'date-tree
8212 "Where in `org-agenda-diary-file' should new entries be added?
8213 Valid values:
8215 date-tree in the date tree, as child of the date
8216 top-level as top-level entries at the end of the file."
8217 :group 'org-agenda
8218 :type '(choice
8219 (const :tag "in a date tree" date-tree)
8220 (const :tag "as top level at end of file" top-level)))
8222 (defcustom org-agenda-insert-diary-extract-time nil
8223 "Non-nil means extract any time specification from the diary entry."
8224 :group 'org-agenda
8225 :version "24.1"
8226 :type 'boolean)
8228 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8229 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8230 If TEXT is not empty, it will become the headline of the new entry, and
8231 the resulting entry will not be shown. When TEXT is empty, switch to
8232 `org-agenda-diary-file' and let the user finish the entry there."
8233 (let ((cw (current-window-configuration)))
8234 (org-switch-to-buffer-other-window
8235 (find-file-noselect org-agenda-diary-file))
8236 (widen)
8237 (goto-char (point-min))
8238 (cond
8239 ((eq type 'anniversary)
8240 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8241 (progn
8242 (or (org-at-heading-p t)
8243 (progn
8244 (outline-next-heading)
8245 (insert "* Anniversaries\n\n")
8246 (beginning-of-line -1)))))
8247 (outline-next-heading)
8248 (org-back-over-empty-lines)
8249 (backward-char 1)
8250 (insert "\n")
8251 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8252 (nth 2 d1) (car d1) (nth 1 d1) text)))
8253 ((eq type 'day)
8254 (let ((org-prefix-has-time t)
8255 (org-agenda-time-leading-zero t)
8256 fmt time time2)
8257 (if org-agenda-insert-diary-extract-time
8258 ;; Use org-agenda-format-item to parse text for a time-range and
8259 ;; remove it. FIXME: This is a hack, we should refactor
8260 ;; that function to make time extraction available separately
8261 (setq fmt (org-agenda-format-item nil text nil nil t)
8262 time (get-text-property 0 'time fmt)
8263 time2 (if (> (length time) 0)
8264 ;; split-string removes trailing ...... if
8265 ;; no end time given. First space
8266 ;; separates time from date.
8267 (concat " " (car (split-string time "\\.")))
8268 nil)
8269 text (get-text-property 0 'txt fmt)))
8270 (if (eq org-agenda-insert-diary-strategy 'top-level)
8271 (org-agenda-insert-diary-as-top-level text)
8272 (require 'org-datetree)
8273 (org-datetree-find-date-create d1)
8274 (org-agenda-insert-diary-make-new-entry text))
8275 (org-insert-time-stamp (org-time-from-absolute
8276 (calendar-absolute-from-gregorian d1))
8277 nil nil nil nil time2))
8278 (end-of-line 0))
8279 ((eq type 'block)
8280 (if (> (calendar-absolute-from-gregorian d1)
8281 (calendar-absolute-from-gregorian d2))
8282 (setq d1 (prog1 d2 (setq d2 d1))))
8283 (if (eq org-agenda-insert-diary-strategy 'top-level)
8284 (org-agenda-insert-diary-as-top-level text)
8285 (require 'org-datetree)
8286 (org-datetree-find-date-create d1)
8287 (org-agenda-insert-diary-make-new-entry text))
8288 (org-insert-time-stamp (org-time-from-absolute
8289 (calendar-absolute-from-gregorian d1)))
8290 (insert "--")
8291 (org-insert-time-stamp (org-time-from-absolute
8292 (calendar-absolute-from-gregorian d2)))
8293 (end-of-line 0)))
8294 (if (string-match "\\S-" text)
8295 (progn
8296 (set-window-configuration cw)
8297 (message "%s entry added to %s"
8298 (capitalize (symbol-name type))
8299 (abbreviate-file-name org-agenda-diary-file)))
8300 (org-reveal t)
8301 (message "Please finish entry here"))))
8303 (defun org-agenda-insert-diary-as-top-level (text)
8304 "Make new entry as a top-level entry at the end of the file.
8305 Add TEXT as headline, and position the cursor in the second line so that
8306 a timestamp can be added there."
8307 (widen)
8308 (goto-char (point-max))
8309 (or (bolp) (insert "\n"))
8310 (insert "* " text "\n")
8311 (if org-adapt-indentation (org-indent-to-column 2)))
8313 (defun org-agenda-insert-diary-make-new-entry (text)
8314 "Make new entry as last child of current entry.
8315 Add TEXT as headline, and position the cursor in the second line so that
8316 a timestamp can be added there."
8317 (let ((org-show-following-heading t)
8318 (org-show-siblings t)
8319 (org-show-hierarchy-above t)
8320 (org-show-entry-below t)
8321 col)
8322 (outline-next-heading)
8323 (org-back-over-empty-lines)
8324 (or (looking-at "[ \t]*$")
8325 (progn (insert "\n") (backward-char 1)))
8326 (org-insert-heading nil t)
8327 (org-do-demote)
8328 (setq col (current-column))
8329 (insert text "\n")
8330 (if org-adapt-indentation (org-indent-to-column col))
8331 (let ((org-show-following-heading t)
8332 (org-show-siblings t)
8333 (org-show-hierarchy-above t)
8334 (org-show-entry-below t))
8335 (org-show-context))))
8337 (defun org-agenda-diary-entry ()
8338 "Make a diary entry, like the `i' command from the calendar.
8339 All the standard commands work: block, weekly etc.
8340 When `org-agenda-diary-file' points to a file,
8341 `org-agenda-diary-entry-in-org-file' is called instead to create
8342 entries in that Org-mode file."
8343 (interactive)
8344 (org-agenda-check-type t 'agenda 'timeline)
8345 (if (not (eq org-agenda-diary-file 'diary-file))
8346 (org-agenda-diary-entry-in-org-file)
8347 (require 'diary-lib)
8348 (let* ((char (progn
8349 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8350 (read-char-exclusive)))
8351 (cmd (cdr (assoc char
8352 '((?d . insert-diary-entry)
8353 (?w . insert-weekly-diary-entry)
8354 (?m . insert-monthly-diary-entry)
8355 (?y . insert-yearly-diary-entry)
8356 (?a . insert-anniversary-diary-entry)
8357 (?b . insert-block-diary-entry)
8358 (?c . insert-cyclic-diary-entry)))))
8359 (oldf (symbol-function 'calendar-cursor-to-date))
8360 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8361 (point (point))
8362 (mark (or (mark t) (point))))
8363 (unless cmd
8364 (error "No command associated with <%c>" char))
8365 (unless (and (get-text-property point 'day)
8366 (or (not (equal ?b char))
8367 (get-text-property mark 'day)))
8368 (error "Don't know which date to use for diary entry"))
8369 ;; We implement this by hacking the `calendar-cursor-to-date' function
8370 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8371 (let ((calendar-mark-ring
8372 (list (calendar-gregorian-from-absolute
8373 (or (get-text-property mark 'day)
8374 (get-text-property point 'day))))))
8375 (unwind-protect
8376 (progn
8377 (fset 'calendar-cursor-to-date
8378 (lambda (&optional error dummy)
8379 (calendar-gregorian-from-absolute
8380 (get-text-property point 'day))))
8381 (call-interactively cmd))
8382 (fset 'calendar-cursor-to-date oldf))))))
8384 (defun org-agenda-execute-calendar-command (cmd)
8385 "Execute a calendar command from the agenda, with the date associated to
8386 the cursor position."
8387 (org-agenda-check-type t 'agenda 'timeline)
8388 (require 'diary-lib)
8389 (unless (get-text-property (point) 'day)
8390 (error "Don't know which date to use for calendar command"))
8391 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8392 (point (point))
8393 (date (calendar-gregorian-from-absolute
8394 (get-text-property point 'day)))
8395 ;; the following 2 vars are needed in the calendar
8396 (displayed-month (car date))
8397 (displayed-year (nth 2 date)))
8398 (unwind-protect
8399 (progn
8400 (fset 'calendar-cursor-to-date
8401 (lambda (&optional error dummy)
8402 (calendar-gregorian-from-absolute
8403 (get-text-property point 'day))))
8404 (call-interactively cmd))
8405 (fset 'calendar-cursor-to-date oldf))))
8407 (defun org-agenda-phases-of-moon ()
8408 "Display the phases of the moon for the 3 months around the cursor date."
8409 (interactive)
8410 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8412 (defun org-agenda-holidays ()
8413 "Display the holidays for the 3 months around the cursor date."
8414 (interactive)
8415 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8417 (defvar calendar-longitude)
8418 (defvar calendar-latitude)
8419 (defvar calendar-location-name)
8421 (defun org-agenda-sunrise-sunset (arg)
8422 "Display sunrise and sunset for the cursor date.
8423 Latitude and longitude can be specified with the variables
8424 `calendar-latitude' and `calendar-longitude'. When called with prefix
8425 argument, latitude and longitude will be prompted for."
8426 (interactive "P")
8427 (require 'solar)
8428 (let ((calendar-longitude (if arg nil calendar-longitude))
8429 (calendar-latitude (if arg nil calendar-latitude))
8430 (calendar-location-name
8431 (if arg "the given coordinates" calendar-location-name)))
8432 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8434 (defun org-agenda-goto-calendar ()
8435 "Open the Emacs calendar with the date at the cursor."
8436 (interactive)
8437 (org-agenda-check-type t 'agenda 'timeline)
8438 (let* ((day (or (get-text-property (point) 'day)
8439 (error "Don't know which date to open in calendar")))
8440 (date (calendar-gregorian-from-absolute day))
8441 (calendar-move-hook nil)
8442 (calendar-view-holidays-initially-flag nil)
8443 (calendar-view-diary-initially-flag nil))
8444 (calendar)
8445 (calendar-goto-date date)))
8447 ;;;###autoload
8448 (defun org-calendar-goto-agenda ()
8449 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8450 This is a command that has to be installed in `calendar-mode-map'."
8451 (interactive)
8452 (org-agenda-list nil (calendar-absolute-from-gregorian
8453 (calendar-cursor-to-date))
8454 nil))
8456 (defun org-agenda-convert-date ()
8457 (interactive)
8458 (org-agenda-check-type t 'agenda 'timeline)
8459 (let ((day (get-text-property (point) 'day))
8460 date s)
8461 (unless day
8462 (error "Don't know which date to convert"))
8463 (setq date (calendar-gregorian-from-absolute day))
8464 (setq s (concat
8465 "Gregorian: " (calendar-date-string date) "\n"
8466 "ISO: " (calendar-iso-date-string date) "\n"
8467 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8468 "Julian: " (calendar-julian-date-string date) "\n"
8469 "Astron. JD: " (calendar-astro-date-string date)
8470 " (Julian date number at noon UTC)\n"
8471 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8472 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8473 "French: " (calendar-french-date-string date) "\n"
8474 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8475 "Mayan: " (calendar-mayan-date-string date) "\n"
8476 "Coptic: " (calendar-coptic-date-string date) "\n"
8477 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8478 "Persian: " (calendar-persian-date-string date) "\n"
8479 "Chinese: " (calendar-chinese-date-string date) "\n"))
8480 (with-output-to-temp-buffer "*Dates*"
8481 (princ s))
8482 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8484 ;;; Bulk commands
8486 (defvar org-agenda-bulk-marked-entries nil
8487 "List of markers that refer to marked entries in the agenda.")
8489 (defun org-agenda-bulk-marked-p ()
8490 (eq (get-char-property (point-at-bol) 'type)
8491 'org-marked-entry-overlay))
8493 (defun org-agenda-bulk-mark (&optional arg)
8494 "Mark the entry at point for future bulk action."
8495 (interactive "p")
8496 (dotimes (i (max arg 1))
8497 (unless (org-get-at-bol 'org-agenda-diary-link)
8498 (let* ((m (org-get-at-bol 'org-hd-marker))
8500 (unless (org-agenda-bulk-marked-p)
8501 (unless m (error "Nothing to mark at point"))
8502 (push m org-agenda-bulk-marked-entries)
8503 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8504 (org-overlay-display ov "> "
8505 (org-get-todo-face "TODO")
8506 'evaporate)
8507 (overlay-put ov 'type 'org-marked-entry-overlay))
8508 (beginning-of-line 2)
8509 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8510 (beginning-of-line 2))
8511 (message "%d entries marked for bulk action"
8512 (length org-agenda-bulk-marked-entries))))))
8514 (defun org-agenda-bulk-mark-regexp (regexp)
8515 "Mark entries match REGEXP."
8516 (interactive "sMark entries matching regexp: ")
8517 (let (entries-marked)
8518 (save-excursion
8519 (goto-char (point-min))
8520 (goto-char (next-single-property-change (point) 'txt))
8521 (while (re-search-forward regexp nil t)
8522 (when (string-match regexp (get-text-property (point) 'txt))
8523 (setq entries-marked (+ entries-marked 1))
8524 (call-interactively 'org-agenda-bulk-mark))))
8525 (if (not entries-marked)
8526 (message "No entry matching this regexp."))))
8528 (defun org-agenda-bulk-unmark ()
8529 "Unmark the entry at point for future bulk action."
8530 (interactive)
8531 (when (org-agenda-bulk-marked-p)
8532 (org-agenda-bulk-remove-overlays
8533 (point-at-bol) (+ 2 (point-at-bol)))
8534 (setq org-agenda-bulk-marked-entries
8535 (delete (org-get-at-bol 'org-hd-marker)
8536 org-agenda-bulk-marked-entries)))
8537 (beginning-of-line 2)
8538 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8539 (beginning-of-line 2))
8540 (message "%d entries marked for bulk action"
8541 (length org-agenda-bulk-marked-entries)))
8543 (defun org-agenda-bulk-toggle ()
8544 "Toggle marking the entry at point for bulk action."
8545 (interactive)
8546 (if (org-agenda-bulk-marked-p)
8547 (org-agenda-bulk-unmark)
8548 (org-agenda-bulk-mark)))
8550 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8551 "Remove the mark overlays between BEG and END in the agenda buffer.
8552 BEG and END default to the buffer limits.
8554 This only removes the overlays, it does not remove the markers
8555 from the list in `org-agenda-bulk-marked-entries'."
8556 (interactive)
8557 (mapc (lambda (ov)
8558 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8559 (delete-overlay ov)))
8560 (overlays-in (or beg (point-min)) (or end (point-max)))))
8562 (defun org-agenda-bulk-remove-all-marks ()
8563 "Remove all marks in the agenda buffer.
8564 This will remove the markers, and the overlays."
8565 (interactive)
8566 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8567 (setq org-agenda-bulk-marked-entries nil)
8568 (org-agenda-bulk-remove-overlays (point-min) (point-max)))
8570 (defun org-agenda-bulk-action (&optional arg)
8571 "Execute an remote-editing action on all marked entries.
8572 The prefix arg is passed through to the command if possible."
8573 (interactive "P")
8574 ;; Make sure we have markers, and only valid ones
8575 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8576 (mapc
8577 (lambda (m)
8578 (unless (and (markerp m)
8579 (marker-buffer m)
8580 (buffer-live-p (marker-buffer m))
8581 (marker-position m))
8582 (error "Marker %s for bulk command is invalid" m)))
8583 org-agenda-bulk-marked-entries)
8585 ;; Prompt for the bulk command
8586 (message (concat "Bulk: [r]efile [$]arch [A]rch->sib [t]odo"
8587 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction"
8588 (when org-agenda-bulk-custom-functions
8589 (concat " Custom: ["
8590 (mapconcat (lambda(f) (char-to-string (car f)))
8591 org-agenda-bulk-custom-functions "")
8592 "]"))))
8593 (let* ((action (read-char-exclusive))
8594 (org-log-refile (if org-log-refile 'time nil))
8595 (entries (reverse org-agenda-bulk-marked-entries))
8596 redo-at-end
8597 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8598 (cond
8599 ((equal action ?$)
8600 (setq cmd '(org-agenda-archive)))
8602 ((equal action ?A)
8603 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8605 ((member action '(?r ?w))
8606 (setq rfloc (org-refile-get-location
8607 "Refile to"
8608 (marker-buffer (car org-agenda-bulk-marked-entries))
8609 org-refile-allow-creating-parent-nodes))
8610 (if (nth 3 rfloc)
8611 (setcar (nthcdr 3 rfloc)
8612 (move-marker (make-marker) (nth 3 rfloc)
8613 (or (get-file-buffer (nth 1 rfloc))
8614 (find-buffer-visiting (nth 1 rfloc))
8615 (error "This should not happen")))))
8617 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8618 redo-at-end t))
8620 ((equal action ?t)
8621 (setq state (org-icompleting-read
8622 "Todo state: "
8623 (with-current-buffer (marker-buffer (car entries))
8624 (mapcar 'list org-todo-keywords-1))))
8625 (setq cmd `(let ((org-inhibit-blocking t)
8626 (org-inhibit-logging 'note))
8627 (org-agenda-todo ,state))))
8629 ((memq action '(?- ?+))
8630 (setq tag (org-icompleting-read
8631 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8632 (with-current-buffer (marker-buffer (car entries))
8633 (delq nil
8634 (mapcar (lambda (x)
8635 (if (stringp (car x)) x)) org-tag-alist)))))
8636 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8638 ((memq action '(?s ?d))
8639 (let* ((date (unless arg
8640 (org-read-date
8641 nil nil nil
8642 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
8643 (ans (if arg nil org-read-date-final-answer))
8644 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8645 (setq cmd `(let* ((bound (fboundp 'read-string))
8646 (old (and bound (symbol-function 'read-string))))
8647 (unwind-protect
8648 (progn
8649 (fset 'read-string (lambda (&rest ignore) ,ans))
8650 (eval '(,c1 arg)))
8651 (if bound
8652 (fset 'read-string old)
8653 (fmakunbound 'read-string)))))))
8655 ((equal action ?S)
8656 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8657 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8658 (let ((days (read-number
8659 (format "Scatter tasks across how many %sdays: "
8660 (if arg "week" "")) 7)))
8661 (setq cmd
8662 `(let ((distance (1+ (random ,days))))
8663 (if arg
8664 (let ((dist distance)
8665 (day-of-week
8666 (calendar-day-of-week
8667 (calendar-gregorian-from-absolute (org-today)))))
8668 (dotimes (i (1+ dist))
8669 (while (member day-of-week org-agenda-weekend-days)
8670 (incf distance)
8671 (incf day-of-week)
8672 (if (= day-of-week 7)
8673 (setq day-of-week 0)))
8674 (incf day-of-week)
8675 (if (= day-of-week 7)
8676 (setq day-of-week 0)))))
8677 ;; silently fail when try to replan a sexp entry
8678 (condition-case nil
8679 (let* ((date (calendar-gregorian-from-absolute
8680 (+ (org-today) distance)))
8681 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8682 (nth 2 date))))
8683 (org-agenda-schedule nil time))
8684 (error nil)))))))
8686 ((assoc action org-agenda-bulk-custom-functions)
8687 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
8688 redo-at-end t))
8690 ((equal action ?f)
8691 (setq cmd (list (intern
8692 (org-icompleting-read "Function: "
8693 obarray 'fboundp t nil nil)))))
8695 (t (error "Invalid bulk action")))
8697 ;; Sort the markers, to make sure that parents are handled before children
8698 (setq entries (sort entries
8699 (lambda (a b)
8700 (cond
8701 ((equal (marker-buffer a) (marker-buffer b))
8702 (< (marker-position a) (marker-position b)))
8704 (string< (buffer-name (marker-buffer a))
8705 (buffer-name (marker-buffer b))))))))
8707 ;; Now loop over all markers and apply cmd
8708 (while (setq e (pop entries))
8709 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
8710 (if (not pos)
8711 (progn (message "Skipping removed entry at %s" e)
8712 (setq cntskip (1+ cntskip)))
8713 (goto-char pos)
8714 (let (org-loop-over-headlines-in-active-region)
8715 (eval cmd))
8716 (setq org-agenda-bulk-marked-entries
8717 (delete e org-agenda-bulk-marked-entries))
8718 (setq cnt (1+ cnt))))
8719 (setq org-agenda-bulk-marked-entries nil)
8720 (org-agenda-bulk-remove-all-marks)
8721 (when redo-at-end (org-agenda-redo))
8722 (message "Acted on %d entries%s"
8724 (if (= cntskip 0)
8726 (format ", skipped %d (disappeared before their turn)"
8727 cntskip)))))
8729 ;;; Flagging notes
8731 (defun org-agenda-show-the-flagging-note ()
8732 "Display the flagging note in the other window.
8733 When called a second time in direct sequence, offer to remove the FLAGGING
8734 tag and (if present) the flagging note."
8735 (interactive)
8736 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
8737 (win (selected-window))
8738 note heading newhead)
8739 (unless hdmarker
8740 (error "No linked entry at point"))
8741 (if (and (eq this-command last-command)
8742 (y-or-n-p "Unflag and remove any flagging note? "))
8743 (progn
8744 (org-agenda-remove-flag hdmarker)
8745 (let ((win (get-buffer-window "*Flagging Note*")))
8746 (and win (delete-window win)))
8747 (message "Entry unflagged"))
8748 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
8749 (unless note
8750 (error "No flagging note"))
8751 (org-kill-new note)
8752 (org-switch-to-buffer-other-window "*Flagging Note*")
8753 (erase-buffer)
8754 (insert note)
8755 (goto-char (point-min))
8756 (while (re-search-forward "\\\\n" nil t)
8757 (replace-match "\n" t t))
8758 (goto-char (point-min))
8759 (select-window win)
8760 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
8762 (defun org-agenda-remove-flag (marker)
8763 "Remove the FLAGGED tag and any flagging note in the entry."
8764 (let (newhead)
8765 (org-with-point-at marker
8766 (org-toggle-tag "FLAGGED" 'off)
8767 (org-entry-delete nil "THEFLAGGINGNOTE")
8768 (setq newhead (org-get-heading)))
8769 (org-agenda-change-all-lines newhead marker)
8770 (message "Entry unflagged")))
8772 (defun org-agenda-get-any-marker (&optional pos)
8773 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
8774 (get-text-property (or pos (point-at-bol)) 'org-marker)))
8776 ;;; Appointment reminders
8778 (defvar appt-time-msg-list)
8780 ;;;###autoload
8781 (defun org-agenda-to-appt (&optional refresh filter &rest args)
8782 "Activate appointments found in `org-agenda-files'.
8783 With a \\[universal-argument] prefix, refresh the list of
8784 appointments.
8786 If FILTER is t, interactively prompt the user for a regular
8787 expression, and filter out entries that don't match it.
8789 If FILTER is a string, use this string as a regular expression
8790 for filtering entries out.
8792 If FILTER is a function, filter out entries against which
8793 calling the function returns nil. This function takes one
8794 argument: an entry from `org-agenda-get-day-entries'.
8796 FILTER can also be an alist with the car of each cell being
8797 either 'headline or 'category. For example:
8799 '((headline \"IMPORTANT\")
8800 (category \"Work\"))
8802 will only add headlines containing IMPORTANT or headlines
8803 belonging to the \"Work\" category.
8805 ARGS are symbols indicating what kind of entries to consider.
8806 By default `org-agenda-to-appt' will use :deadline, :scheduled
8807 and :timestamp entries. See the docstring of `org-diary' for
8808 details and examples."
8809 (interactive "P")
8810 (if refresh (setq appt-time-msg-list nil))
8811 (if (eq filter t)
8812 (setq filter (read-from-minibuffer "Regexp filter: ")))
8813 (let* ((cnt 0) ; count added events
8814 (scope (or args '(:deadline :scheduled :timestamp)))
8815 (org-agenda-new-buffers nil)
8816 (org-deadline-warning-days 0)
8817 ;; Do not use `org-today' here because appt only takes
8818 ;; time and without date as argument, so it may pass wrong
8819 ;; information otherwise
8820 (today (org-date-to-gregorian
8821 (time-to-days (current-time))))
8822 (org-agenda-restrict nil)
8823 (files (org-agenda-files 'unrestricted)) entries file)
8824 ;; Get all entries which may contain an appt
8825 (org-prepare-agenda-buffers files)
8826 (while (setq file (pop files))
8827 (setq entries
8828 (delq nil
8829 (append entries
8830 (apply 'org-agenda-get-day-entries
8831 file today scope)))))
8832 ;; Map thru entries and find if we should filter them out
8833 (mapc
8834 (lambda(x)
8835 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
8836 (cat (get-text-property 1 'org-category x))
8837 (tod (get-text-property 1 'time-of-day x))
8838 (ok (or (null filter)
8839 (and (stringp filter) (string-match filter evt))
8840 (and (functionp filter) (funcall filter x))
8841 (and (listp filter)
8842 (let ((cat-filter (cadr (assoc 'category filter)))
8843 (evt-filter (cadr (assoc 'headline filter))))
8844 (or (and (stringp cat-filter)
8845 (string-match cat-filter cat))
8846 (and (stringp evt-filter)
8847 (string-match evt-filter evt))))))))
8848 ;; FIXME: Shall we remove text-properties for the appt text?
8849 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
8850 (when (and ok tod)
8851 (setq tod (concat "00" (number-to-string tod))
8852 tod (when (string-match
8853 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
8854 (concat (match-string 1 tod) ":"
8855 (match-string 2 tod))))
8856 (appt-add tod evt)
8857 (setq cnt (1+ cnt))))) entries)
8858 (org-release-buffers org-agenda-new-buffers)
8859 (if (eq cnt 0)
8860 (message "No event to add")
8861 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
8863 (defun org-agenda-todayp (date)
8864 "Does DATE mean today, when considering `org-extend-today-until'?"
8865 (let ((today (org-today))
8866 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
8867 date)))
8868 (eq date today)))
8870 (defun org-agenda-todo-yesterday (&optional arg)
8871 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday"
8872 (interactive "P")
8873 (let* ((hour (third (decode-time
8874 (org-current-time))))
8875 (org-extend-today-until (1+ hour)))
8876 (org-agenda-todo arg)))
8878 (provide 'org-agenda)
8880 ;;; org-agenda.el ends here