Merge branch 'maint'
[org-mode.git] / lisp / org-agenda.el
blob6047a66391c99acab210533b99a25d7201ee65f6
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (require 'org-macs)
50 (eval-when-compile
51 (require 'cl))
53 (declare-function diary-add-to-list "diary-lib"
54 (date string specifier &optional marker globcolor literal))
55 (declare-function calendar-iso-to-absolute "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-columns-remove-overlays "org-colview" ())
73 (declare-function org-datetree-find-date-create "org-datetree"
74 (date &optional keep-restriction))
75 (declare-function org-columns-quit "org-colview" ())
76 (declare-function diary-date-display-form "diary-lib" (&optional type))
77 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
78 (declare-function org-habit-insert-consistency-graphs
79 "org-habit" (&optional line))
80 (declare-function org-is-habit-p "org-habit" (&optional pom))
81 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
82 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
83 (declare-function org-pop-to-buffer-same-window "org-compat"
84 (&optional buffer-or-name norecord label))
85 (declare-function org-agenda-columns "org-colview" ())
86 (declare-function org-add-archive-files "org-archive" (files))
87 (declare-function org-capture "org-capture" (&optional goto keys))
89 (defvar calendar-mode-map) ; defined in calendar.el
90 (defvar org-clock-current-task nil) ; defined in org-clock.el
91 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
92 (defvar org-habit-show-habits) ; defined in org-habit.el
93 (defvar org-habit-show-habits-only-for-today)
94 (defvar org-habit-show-all-today)
96 ;; Defined somewhere in this file, but used before definition.
97 (defvar org-agenda-buffer-name "*Org Agenda*")
98 (defvar org-agenda-overriding-header nil)
99 (defvar org-agenda-title-append nil)
100 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
101 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
102 (defvar original-date) ; dynamically scoped, calendar.el does scope this
104 (defvar org-agenda-undo-list nil
105 "List of undoable operations in the agenda since last refresh.")
106 (defvar org-agenda-pending-undo-list nil
107 "In a series of undo commands, this is the list of remaining undo items.")
109 (defcustom org-agenda-confirm-kill 1
110 "When set, remote killing from the agenda buffer needs confirmation.
111 When t, a confirmation is always needed. When a number N, confirmation is
112 only needed when the text to be killed contains more than N non-white lines."
113 :group 'org-agenda
114 :type '(choice
115 (const :tag "Never" nil)
116 (const :tag "Always" t)
117 (integer :tag "When more than N lines")))
119 (defcustom org-agenda-compact-blocks nil
120 "Non-nil means make the block agenda more compact.
121 This is done globally by leaving out lines like the agenda span
122 name and week number or the separator lines."
123 :group 'org-agenda
124 :type 'boolean)
126 (defcustom org-agenda-block-separator ?=
127 "The separator between blocks in the agenda.
128 If this is a string, it will be used as the separator, with a newline added.
129 If it is a character, it will be repeated to fill the window width.
130 If nil the separator is disabled. In `org-agenda-custom-commands' this
131 addresses the separator between the current and the previous block."
132 :group 'org-agenda
133 :type '(choice
134 (const :tag "Disabled" nil)
135 (character)
136 (string)))
138 (defgroup org-agenda-export nil
139 "Options concerning exporting agenda views in Org-mode."
140 :tag "Org Agenda Export"
141 :group 'org-agenda)
143 (defcustom org-agenda-with-colors t
144 "Non-nil means use colors in agenda views."
145 :group 'org-agenda-export
146 :type 'boolean)
148 (defcustom org-agenda-exporter-settings nil
149 "Alist of variable/value pairs that should be active during agenda export.
150 This is a good place to set options for ps-print and for htmlize.
151 Note that the way this is implemented, the values will be evaluated
152 before assigned to the variables. So make sure to quote values you do
153 *not* want evaluated, for example
155 (setq org-agenda-exporter-settings
156 \\='((ps-print-color-p \\='black-white)))"
157 :group 'org-agenda-export
158 :type '(repeat
159 (list
160 (variable)
161 (sexp :tag "Value"))))
163 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
164 "Hook run in a temporary buffer before writing the agenda to an export file.
165 A useful function for this hook is `org-agenda-add-entry-text'."
166 :group 'org-agenda-export
167 :type 'hook
168 :options '(org-agenda-add-entry-text))
170 (defcustom org-agenda-add-entry-text-maxlines 0
171 "Maximum number of entry text lines to be added to agenda.
172 This is only relevant when `org-agenda-add-entry-text' is part of
173 `org-agenda-before-write-hook', which is the default.
174 When this is 0, nothing will happen. When it is greater than 0, it
175 specifies the maximum number of lines that will be added for each entry
176 that is listed in the agenda view.
178 Note that this variable is not used during display, only when exporting
179 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
180 and `org-agenda-entry-text-maxlines'."
181 :group 'org-agenda
182 :type 'integer)
184 (defcustom org-agenda-add-entry-text-descriptive-links t
185 "Non-nil means export org-links as descriptive links in agenda added text.
186 This variable applies to the text added to the agenda when
187 `org-agenda-add-entry-text-maxlines' is larger than 0.
188 When this variable nil, the URL will (also) be shown."
189 :group 'org-agenda
190 :type 'boolean)
192 (defcustom org-agenda-export-html-style nil
193 "The style specification for exported HTML Agenda files.
194 If this variable contains a string, it will replace the default <style>
195 section as produced by `htmlize'.
196 Since there are different ways of setting style information, this variable
197 needs to contain the full HTML structure to provide a style, including the
198 surrounding HTML tags. The style specifications should include definitions
199 the fonts used by the agenda, here is an example:
201 <style type=\"text/css\">
202 p { font-weight: normal; color: gray; }
203 .org-agenda-structure {
204 font-size: 110%;
205 color: #003399;
206 font-weight: 600;
208 .org-todo {
209 color: #cc6666;
210 font-weight: bold;
212 .org-agenda-done {
213 color: #339933;
215 .org-done {
216 color: #339933;
218 .title { text-align: center; }
219 .todo, .deadline { color: red; }
220 .done { color: green; }
221 </style>
223 or, if you want to keep the style in a file,
225 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
227 As the value of this option simply gets inserted into the HTML <head> header,
228 you can \"misuse\" it to also add other text to the header."
229 :group 'org-agenda-export
230 :group 'org-export-html
231 :type '(choice
232 (const nil)
233 (string)))
235 (defcustom org-agenda-persistent-filter nil
236 "When set, keep filters from one agenda view to the next."
237 :group 'org-agenda
238 :type 'boolean)
240 (defgroup org-agenda-custom-commands nil
241 "Options concerning agenda views in Org-mode."
242 :tag "Org Agenda Custom Commands"
243 :group 'org-agenda)
245 (defconst org-sorting-choice
246 '(choice
247 (const time-up) (const time-down)
248 (const timestamp-up) (const timestamp-down)
249 (const scheduled-up) (const scheduled-down)
250 (const deadline-up) (const deadline-down)
251 (const ts-up) (const ts-down)
252 (const tsia-up) (const tsia-down)
253 (const category-keep) (const category-up) (const category-down)
254 (const tag-down) (const tag-up)
255 (const priority-up) (const priority-down)
256 (const todo-state-up) (const todo-state-down)
257 (const effort-up) (const effort-down)
258 (const habit-up) (const habit-down)
259 (const alpha-up) (const alpha-down)
260 (const user-defined-up) (const user-defined-down))
261 "Sorting choices.")
263 ;; Keep custom values for `org-agenda-filter-preset' compatible with
264 ;; the new variable `org-agenda-tag-filter-preset'.
265 (org-defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
266 (org-defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
268 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
269 "List of types searched for when creating the daily/weekly agenda.
270 This variable is a list of symbols that controls the types of
271 items that appear in the daily/weekly agenda. Allowed symbols in this
272 list are are
274 :timestamp List items containing a date stamp or date range matching
275 the selected date. This includes sexp entries in angular
276 brackets.
278 :sexp List entries resulting from plain diary-like sexps.
280 :deadline List deadline due on that date. When the date is today,
281 also list any deadlines past due, or due within
282 `org-deadline-warning-days'. `:deadline' must appear before
283 `:scheduled' if the setting of
284 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
285 any effect.
287 :deadline* Same as above, but only include the deadline if it has an
288 hour specification as [h]h:mm.
290 :scheduled List all items which are scheduled for the given date.
291 The diary for *today* also contains items which were
292 scheduled earlier and are not yet marked DONE.
294 :scheduled* Same as above, but only include the scheduled item if it
295 has an hour specification as [h]h:mm.
297 By default, all four non-starred types are turned on.
299 When :scheduled* or :deadline* are included, :schedule or :deadline
300 will be ignored.
302 Never set this variable globally using `setq', because then it
303 will apply to all future agenda commands. Instead, bind it with
304 `let' to scope it dynamically into the agenda-constructing
305 command. A good way to set it is through options in
306 `org-agenda-custom-commands'. For a more flexible (though
307 somewhat less efficient) way of determining what is included in
308 the daily/weekly agenda, see `org-agenda-skip-function'.")
310 (defconst org-agenda-custom-commands-local-options
311 `(repeat :tag "Local settings for this command. Remember to quote values"
312 (choice :tag "Setting"
313 (list :tag "Heading for this block"
314 (const org-agenda-overriding-header)
315 (string :tag "Headline"))
316 (list :tag "Files to be searched"
317 (const org-agenda-files)
318 (list
319 (const :format "" quote)
320 (repeat (file))))
321 (list :tag "Sorting strategy"
322 (const org-agenda-sorting-strategy)
323 (list
324 (const :format "" quote)
325 (repeat
326 ,org-sorting-choice)))
327 (list :tag "Prefix format"
328 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
329 (string))
330 (list :tag "Number of days in agenda"
331 (const org-agenda-span)
332 (choice (const :tag "Day" day)
333 (const :tag "Week" week)
334 (const :tag "Fortnight" fortnight)
335 (const :tag "Month" month)
336 (const :tag "Year" year)
337 (integer :tag "Custom")))
338 (list :tag "Fixed starting date"
339 (const org-agenda-start-day)
340 (string :value "2007-11-01"))
341 (list :tag "Start on day of week"
342 (const org-agenda-start-on-weekday)
343 (choice :value 1
344 (const :tag "Today" nil)
345 (integer :tag "Weekday No.")))
346 (list :tag "Include data from diary"
347 (const org-agenda-include-diary)
348 (boolean))
349 (list :tag "Deadline Warning days"
350 (const org-deadline-warning-days)
351 (integer :value 1))
352 (list :tag "Category filter preset"
353 (const org-agenda-category-filter-preset)
354 (list
355 (const :format "" quote)
356 (repeat
357 (string :tag "+category or -category"))))
358 (list :tag "Tags filter preset"
359 (const org-agenda-tag-filter-preset)
360 (list
361 (const :format "" quote)
362 (repeat
363 (string :tag "+tag or -tag"))))
364 (list :tag "Effort filter preset"
365 (const org-agenda-effort-filter-preset)
366 (list
367 (const :format "" quote)
368 (repeat
369 (string :tag "+=10 or -=10 or +<10 or ->10"))))
370 (list :tag "Regexp filter preset"
371 (const org-agenda-regexp-filter-preset)
372 (list
373 (const :format "" quote)
374 (repeat
375 (string :tag "+regexp or -regexp"))))
376 (list :tag "Set daily/weekly entry types"
377 (const org-agenda-entry-types)
378 (list
379 (const :format "" quote)
380 (set :greedy t :value ,org-agenda-entry-types
381 (const :deadline)
382 (const :scheduled)
383 (const :deadline*)
384 (const :scheduled*)
385 (const :timestamp)
386 (const :sexp))))
387 (list :tag "Standard skipping condition"
388 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
389 (const org-agenda-skip-function)
390 (list
391 (const :format "" quote)
392 (list
393 (choice
394 :tag "Skipping range"
395 (const :tag "Skip entry" org-agenda-skip-entry-if)
396 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
397 (repeat :inline t :tag "Conditions for skipping"
398 (choice
399 :tag "Condition type"
400 (list :tag "Regexp matches" :inline t
401 (const :format "" 'regexp)
402 (regexp))
403 (list :tag "Regexp does not match" :inline t
404 (const :format "" 'notregexp)
405 (regexp))
406 (list :tag "TODO state is" :inline t
407 (const 'todo)
408 (choice
409 (const :tag "Any not-done state" 'todo)
410 (const :tag "Any done state" 'done)
411 (const :tag "Any state" 'any)
412 (list :tag "Keyword list"
413 (const :format "" quote)
414 (repeat (string :tag "Keyword")))))
415 (list :tag "TODO state is not" :inline t
416 (const 'nottodo)
417 (choice
418 (const :tag "Any not-done state" 'todo)
419 (const :tag "Any done state" 'done)
420 (const :tag "Any state" 'any)
421 (list :tag "Keyword list"
422 (const :format "" quote)
423 (repeat (string :tag "Keyword")))))
424 (const :tag "scheduled" 'scheduled)
425 (const :tag "not scheduled" 'notscheduled)
426 (const :tag "deadline" 'deadline)
427 (const :tag "no deadline" 'notdeadline)
428 (const :tag "timestamp" 'timestamp)
429 (const :tag "no timestamp" 'nottimestamp))))))
430 (list :tag "Non-standard skipping condition"
431 :value (org-agenda-skip-function)
432 (const org-agenda-skip-function)
433 (sexp :tag "Function or form (quoted!)"))
434 (list :tag "Any variable"
435 (variable :tag "Variable")
436 (sexp :tag "Value (sexp)"))))
437 "Selection of examples for agenda command settings.
438 This will be spliced into the custom type of
439 `org-agenda-custom-commands'.")
442 (defcustom org-agenda-custom-commands
443 '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
444 "Custom commands for the agenda.
445 These commands will be offered on the splash screen displayed by the
446 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
448 (key desc type match settings files)
450 key The key (one or more characters as a string) to be associated
451 with the command.
452 desc A description of the command, when omitted or nil, a default
453 description is built using MATCH.
454 type The command type, any of the following symbols:
455 agenda The daily/weekly agenda.
456 todo Entries with a specific TODO keyword, in all agenda files.
457 search Entries containing search words entry or headline.
458 tags Tags/Property/TODO match in all agenda files.
459 tags-todo Tags/P/T match in all agenda files, TODO entries only.
460 todo-tree Sparse tree of specific TODO keyword in *current* file.
461 tags-tree Sparse tree with all tags matches in *current* file.
462 occur-tree Occur sparse tree for *current* file.
463 ... A user-defined function.
464 match What to search for:
465 - a single keyword for TODO keyword searches
466 - a tags match expression for tags searches
467 - a word search expression for text searches.
468 - a regular expression for occur searches
469 For all other commands, this should be the empty string.
470 settings A list of option settings, similar to that in a let form, so like
471 this: ((opt1 val1) (opt2 val2) ...). The values will be
472 evaluated at the moment of execution, so quote them when needed.
473 files A list of files file to write the produced agenda buffer to
474 with the command `org-store-agenda-views'.
475 If a file name ends in \".html\", an HTML version of the buffer
476 is written out. If it ends in \".ps\", a postscript version is
477 produced. Otherwise, only the plain text is written to the file.
479 You can also define a set of commands, to create a composite agenda buffer.
480 In this case, an entry looks like this:
482 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
484 where
486 desc A description string to be displayed in the dispatcher menu.
487 cmd An agenda command, similar to the above. However, tree commands
488 are not allowed, but instead you can get agenda and global todo list.
489 So valid commands for a set are:
490 (agenda \"\" settings)
491 (alltodo \"\" settings)
492 (stuck \"\" settings)
493 (todo \"match\" settings files)
494 (search \"match\" settings files)
495 (tags \"match\" settings files)
496 (tags-todo \"match\" settings files)
498 Each command can carry a list of options, and another set of options can be
499 given for the whole set of commands. Individual command options take
500 precedence over the general options.
502 When using several characters as key to a command, the first characters
503 are prefix commands. For the dispatcher to display useful information, you
504 should provide a description for the prefix, like
506 (setq org-agenda-custom-commands
507 \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
508 (\"hl\" tags \"+HOME+Lisa\")
509 (\"hp\" tags \"+HOME+Peter\")
510 (\"hk\" tags \"+HOME+Kim\")))"
511 :group 'org-agenda-custom-commands
512 :type `(repeat
513 (choice :value ("x" "Describe command here" tags "" nil)
514 (list :tag "Single command"
515 (string :tag "Access Key(s) ")
516 (option (string :tag "Description"))
517 (choice
518 (const :tag "Agenda" agenda)
519 (const :tag "TODO list" alltodo)
520 (const :tag "Search words" search)
521 (const :tag "Stuck projects" stuck)
522 (const :tag "Tags/Property match (all agenda files)" tags)
523 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
524 (const :tag "TODO keyword search (all agenda files)" todo)
525 (const :tag "Tags sparse tree (current buffer)" tags-tree)
526 (const :tag "TODO keyword tree (current buffer)" todo-tree)
527 (const :tag "Occur tree (current buffer)" occur-tree)
528 (sexp :tag "Other, user-defined function"))
529 (string :tag "Match (only for some commands)")
530 ,org-agenda-custom-commands-local-options
531 (option (repeat :tag "Export" (file :tag "Export to"))))
532 (list :tag "Command series, all agenda files"
533 (string :tag "Access Key(s)")
534 (string :tag "Description ")
535 (repeat :tag "Component"
536 (choice
537 (list :tag "Agenda"
538 (const :format "" agenda)
539 (const :tag "" :format "" "")
540 ,org-agenda-custom-commands-local-options)
541 (list :tag "TODO list (all keywords)"
542 (const :format "" alltodo)
543 (const :tag "" :format "" "")
544 ,org-agenda-custom-commands-local-options)
545 (list :tag "Search words"
546 (const :format "" search)
547 (string :tag "Match")
548 ,org-agenda-custom-commands-local-options)
549 (list :tag "Stuck projects"
550 (const :format "" stuck)
551 (const :tag "" :format "" "")
552 ,org-agenda-custom-commands-local-options)
553 (list :tag "Tags search"
554 (const :format "" tags)
555 (string :tag "Match")
556 ,org-agenda-custom-commands-local-options)
557 (list :tag "Tags search, TODO entries only"
558 (const :format "" tags-todo)
559 (string :tag "Match")
560 ,org-agenda-custom-commands-local-options)
561 (list :tag "TODO keyword search"
562 (const :format "" todo)
563 (string :tag "Match")
564 ,org-agenda-custom-commands-local-options)
565 (list :tag "Other, user-defined function"
566 (symbol :tag "function")
567 (string :tag "Match")
568 ,org-agenda-custom-commands-local-options)))
570 (repeat :tag "Settings for entire command set"
571 (list (variable :tag "Any variable")
572 (sexp :tag "Value")))
573 (option (repeat :tag "Export" (file :tag "Export to"))))
574 (cons :tag "Prefix key documentation"
575 (string :tag "Access Key(s)")
576 (string :tag "Description ")))))
578 (defcustom org-agenda-query-register ?o
579 "The register holding the current query string.
580 The purpose of this is that if you construct a query string interactively,
581 you can then use it to define a custom command."
582 :group 'org-agenda-custom-commands
583 :type 'character)
585 (defcustom org-stuck-projects
586 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
587 "How to identify stuck projects.
588 This is a list of four items:
589 1. A tags/todo/property matcher string that is used to identify a project.
590 See the manual for a description of tag and property searches.
591 The entire tree below a headline matched by this is considered one project.
592 2. A list of TODO keywords identifying non-stuck projects.
593 If the project subtree contains any headline with one of these todo
594 keywords, the project is considered to be not stuck. If you specify
595 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
596 3. A list of tags identifying non-stuck projects.
597 If the project subtree contains any headline with one of these tags,
598 the project is considered to be not stuck. If you specify \"*\" as
599 a tag, any tag will mark the project unstuck. Note that this is about
600 the explicit presence of a tag somewhere in the subtree, inherited
601 tags do not count here. If inherited tags make a project not stuck,
602 use \"-TAG\" in the tags part of the matcher under (1.) above.
603 4. An arbitrary regular expression matching non-stuck projects.
605 If the project turns out to be not stuck, search continues also in the
606 subtree to see if any of the subtasks have project status.
608 See also the variable `org-tags-match-list-sublevels' which applies
609 to projects matched by this search as well.
611 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
612 or `C-c a #' to produce the list."
613 :group 'org-agenda-custom-commands
614 :type '(list
615 (string :tag "Tags/TODO match to identify a project")
616 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
617 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
618 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
620 (defgroup org-agenda-skip nil
621 "Options concerning skipping parts of agenda files."
622 :tag "Org Agenda Skip"
623 :group 'org-agenda)
625 (defcustom org-agenda-skip-function-global nil
626 "Function to be called at each match during agenda construction.
627 If this function returns nil, the current match should not be skipped.
628 If the function decided to skip an agenda match, is must return the
629 buffer position from which the search should be continued.
630 This may also be a Lisp form, which will be evaluated.
632 This variable will be applied to every agenda match, including
633 tags/property searches and TODO lists. So try to make the test function
634 do its checking as efficiently as possible. To implement a skipping
635 condition just for specific agenda commands, use the variable
636 `org-agenda-skip-function' which can be set in the options section
637 of custom agenda commands."
638 :group 'org-agenda-skip
639 :type 'sexp)
641 (defgroup org-agenda-daily/weekly nil
642 "Options concerning the daily/weekly agenda."
643 :tag "Org Agenda Daily/Weekly"
644 :group 'org-agenda)
645 (defgroup org-agenda-todo-list nil
646 "Options concerning the global todo list agenda view."
647 :tag "Org Agenda Todo List"
648 :group 'org-agenda)
649 (defgroup org-agenda-match-view nil
650 "Options concerning the general tags/property/todo match agenda view."
651 :tag "Org Agenda Match View"
652 :group 'org-agenda)
653 (defgroup org-agenda-search-view nil
654 "Options concerning the search agenda view."
655 :tag "Org Agenda Search View"
656 :group 'org-agenda)
658 (defvar org-agenda-archives-mode nil
659 "Non-nil means the agenda will include archived items.
660 If this is the symbol `trees', trees in the selected agenda scope
661 that are marked with the ARCHIVE tag will be included anyway. When this is
662 t, also all archive files associated with the current selection of agenda
663 files will be included.")
665 (defcustom org-agenda-restriction-lock-highlight-subtree t
666 "Non-nil means highlight the whole subtree when restriction is active.
667 Otherwise only highlight the headline. Highlighting the whole subtree is
668 useful to ensure no edits happen beyond the restricted region."
669 :group 'org-agenda
670 :type 'boolean)
672 (defcustom org-agenda-skip-comment-trees t
673 "Non-nil means skip trees that start with the COMMENT keyword.
674 When nil, these trees are also scanned by agenda commands."
675 :group 'org-agenda-skip
676 :type 'boolean)
678 (defcustom org-agenda-todo-list-sublevels t
679 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
680 When nil, the sublevels of a TODO entry are not checked, resulting in
681 potentially much shorter TODO lists."
682 :group 'org-agenda-skip
683 :group 'org-agenda-todo-list
684 :type 'boolean)
686 (defcustom org-agenda-todo-ignore-with-date nil
687 "Non-nil means don't show entries with a date in the global todo list.
688 You can use this if you prefer to mark mere appointments with a TODO keyword,
689 but don't want them to show up in the TODO list.
690 When this is set, it also covers deadlines and scheduled items, the settings
691 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
692 will be ignored.
693 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
694 :group 'org-agenda-skip
695 :group 'org-agenda-todo-list
696 :type 'boolean)
698 (defcustom org-agenda-todo-ignore-timestamp nil
699 "Non-nil means don't show entries with a timestamp.
700 This applies when creating the global todo list.
701 Valid values are:
703 past Don't show entries for today or in the past.
705 future Don't show entries with a timestamp in the future.
706 The idea behind this is that if it has a future
707 timestamp, you don't want to think about it until the
708 date.
710 all Don't show any entries with a timestamp in the global todo list.
711 The idea behind this is that by setting a timestamp, you
712 have already \"taken care\" of this item.
714 This variable can also have an integer as a value. If positive (N),
715 todos with a timestamp N or more days in the future will be ignored. If
716 negative (-N), todos with a timestamp N or more days in the past will be
717 ignored. If 0, todos with a timestamp either today or in the future will
718 be ignored. For example, a value of -1 will exclude todos with a
719 timestamp in the past (yesterday or earlier), while a value of 7 will
720 exclude todos with a timestamp a week or more in the future.
722 See also `org-agenda-todo-ignore-with-date'.
723 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
724 to make his option also apply to the tags-todo list."
725 :group 'org-agenda-skip
726 :group 'org-agenda-todo-list
727 :version "24.1"
728 :type '(choice
729 (const :tag "Ignore future timestamp todos" future)
730 (const :tag "Ignore past or present timestamp todos" past)
731 (const :tag "Ignore all timestamp todos" all)
732 (const :tag "Show timestamp todos" nil)
733 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
735 (defcustom org-agenda-todo-ignore-scheduled nil
736 "Non-nil means, ignore some scheduled TODO items when making TODO list.
737 This applies when creating the global todo list.
738 Valid values are:
740 past Don't show entries scheduled today or in the past.
742 future Don't show entries scheduled in the future.
743 The idea behind this is that by scheduling it, you don't want to
744 think about it until the scheduled date.
746 all Don't show any scheduled entries in the global todo list.
747 The idea behind this is that by scheduling it, you have already
748 \"taken care\" of this item.
750 t Same as `all', for backward compatibility.
752 This variable can also have an integer as a value. See
753 `org-agenda-todo-ignore-timestamp' for more details.
755 See also `org-agenda-todo-ignore-with-date'.
756 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
757 to make his option also apply to the tags-todo list."
758 :group 'org-agenda-skip
759 :group 'org-agenda-todo-list
760 :type '(choice
761 (const :tag "Ignore future-scheduled todos" future)
762 (const :tag "Ignore past- or present-scheduled todos" past)
763 (const :tag "Ignore all scheduled todos" all)
764 (const :tag "Ignore all scheduled todos (compatibility)" t)
765 (const :tag "Show scheduled todos" nil)
766 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
768 (defcustom org-agenda-todo-ignore-deadlines nil
769 "Non-nil means ignore some deadline TODO items when making TODO list.
770 There are different motivations for using different values, please think
771 carefully when configuring this variable.
773 This applies when creating the global todo list.
774 Valid values are:
776 near Don't show near deadline entries. A deadline is near when it is
777 closer than `org-deadline-warning-days' days. The idea behind this
778 is that such items will appear in the agenda anyway.
780 far Don't show TODO entries where a deadline has been defined, but
781 the deadline is not near. This is useful if you don't want to
782 use the todo list to figure out what to do now.
784 past Don't show entries with a deadline timestamp for today or in the past.
786 future Don't show entries with a deadline timestamp in the future, not even
787 when they become `near' ones. Use it with caution.
789 all Ignore all TODO entries that do have a deadline.
791 t Same as `near', for backward compatibility.
793 This variable can also have an integer as a value. See
794 `org-agenda-todo-ignore-timestamp' for more details.
796 See also `org-agenda-todo-ignore-with-date'.
797 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
798 to make his option also apply to the tags-todo list."
799 :group 'org-agenda-skip
800 :group 'org-agenda-todo-list
801 :type '(choice
802 (const :tag "Ignore near deadlines" near)
803 (const :tag "Ignore near deadlines (compatibility)" t)
804 (const :tag "Ignore far deadlines" far)
805 (const :tag "Ignore all TODOs with a deadlines" all)
806 (const :tag "Show all TODOs, even if they have a deadline" nil)
807 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
809 (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
810 "Time unit to use when possibly ignoring an agenda item.
812 See the docstring of various `org-agenda-todo-ignore-*' options.
813 The default is to compare time stamps using days. An item is thus
814 considered to be in the future if it is at least one day after today.
815 Non-nil means to compare time stamps using seconds. An item is then
816 considered future if it has a time value later than current time."
817 :group 'org-agenda-skip
818 :group 'org-agenda-todo-list
819 :version "24.4"
820 :package-version '(Org . "8.0")
821 :type '(choice
822 (const :tag "Compare time with days" nil)
823 (const :tag "Compare time with seconds" t)))
825 (defcustom org-agenda-tags-todo-honor-ignore-options nil
826 "Non-nil means honor todo-list ignores options also in tags-todo search.
827 The variables
828 `org-agenda-todo-ignore-with-date',
829 `org-agenda-todo-ignore-timestamp',
830 `org-agenda-todo-ignore-scheduled',
831 `org-agenda-todo-ignore-deadlines'
832 make the global TODO list skip entries that have time stamps of certain
833 kinds. If this option is set, the same options will also apply for the
834 tags-todo search, which is the general tags/property matcher
835 restricted to unfinished TODO entries only."
836 :group 'org-agenda-skip
837 :group 'org-agenda-todo-list
838 :group 'org-agenda-match-view
839 :type 'boolean)
841 (defcustom org-agenda-skip-scheduled-if-done nil
842 "Non-nil means don't show scheduled items in agenda when they are done.
843 This is relevant for the daily/weekly agenda, not for the TODO list. And
844 it applies only to the actual date of the scheduling. Warnings about
845 an item with a past scheduling dates are always turned off when the item
846 is DONE."
847 :group 'org-agenda-skip
848 :group 'org-agenda-daily/weekly
849 :type 'boolean)
851 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
852 "Non-nil means skip scheduling line if same entry shows because of deadline.
854 In the agenda of today, an entry can show up multiple times
855 because it is both scheduled and has a nearby deadline, and maybe
856 a plain time stamp as well.
858 When this variable is nil, the entry will be shown several times.
860 When set to t, then only the deadline is shown and the fact that
861 the entry is scheduled today or was scheduled previously is not
862 shown.
864 When set to the symbol `not-today', skip scheduled previously,
865 but not scheduled today.
867 When set to the symbol `repeated-after-deadline', skip scheduled
868 items if they are repeated beyond the current deadline."
869 :group 'org-agenda-skip
870 :group 'org-agenda-daily/weekly
871 :type '(choice
872 (const :tag "Never" nil)
873 (const :tag "Always" t)
874 (const :tag "Not when scheduled today" not-today)
875 (const :tag "When repeated past deadline" repeated-after-deadline)))
877 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
878 "Non-nil means skip timestamp line if same entry shows because of deadline.
879 In the agenda of today, an entry can show up multiple times
880 because it has both a plain timestamp and has a nearby deadline.
881 When this variable is t, then only the deadline is shown and the
882 fact that the entry has a timestamp for or including today is not
883 shown. When this variable is nil, the entry will be shown
884 several times."
885 :group 'org-agenda-skip
886 :group 'org-agenda-daily/weekly
887 :version "24.1"
888 :type '(choice
889 (const :tag "Never" nil)
890 (const :tag "Always" t)))
892 (defcustom org-agenda-skip-deadline-if-done nil
893 "Non-nil means don't show deadlines when the corresponding item is done.
894 When nil, the deadline is still shown and should give you a happy feeling.
895 This is relevant for the daily/weekly agenda. And it applied only to the
896 actually date of the deadline. Warnings about approaching and past-due
897 deadlines are always turned off when the item is DONE."
898 :group 'org-agenda-skip
899 :group 'org-agenda-daily/weekly
900 :type 'boolean)
902 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
903 "Non-nil means skip deadline prewarning when entry is also scheduled.
904 This will apply on all days where a prewarning for the deadline would
905 be shown, but not at the day when the entry is actually due. On that day,
906 the deadline will be shown anyway.
907 This variable may be set to nil, t, the symbol `pre-scheduled',
908 or a number which will then give the number of days before the actual
909 deadline when the prewarnings should resume. The symbol `pre-scheduled'
910 eliminates the deadline prewarning only prior to the scheduled date.
911 This can be used in a workflow where the first showing of the deadline will
912 trigger you to schedule it, and then you don't want to be reminded of it
913 because you will take care of it on the day when scheduled."
914 :group 'org-agenda-skip
915 :group 'org-agenda-daily/weekly
916 :version "24.1"
917 :type '(choice
918 (const :tag "Always show prewarning" nil)
919 (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
920 (const :tag "Remove prewarning if entry is scheduled" t)
921 (integer :tag "Restart prewarning N days before deadline")))
923 (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
924 "Non-nil means skip scheduled delay when entry also has a deadline.
925 This variable may be set to nil, t, the symbol `post-deadline',
926 or a number which will then give the number of days after the actual
927 scheduled date when the delay should expire. The symbol `post-deadline'
928 eliminates the schedule delay when the date is posterior to the deadline."
929 :group 'org-agenda-skip
930 :group 'org-agenda-daily/weekly
931 :version "24.4"
932 :package-version '(Org . "8.0")
933 :type '(choice
934 (const :tag "Always honor delay" nil)
935 (const :tag "Ignore delay if posterior to the deadline" post-deadline)
936 (const :tag "Ignore delay if entry has a deadline" t)
937 (integer :tag "Honor delay up until N days after the scheduled date")))
939 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
940 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
941 When non-nil, after the search for timestamps has matched once in an
942 entry, the rest of the entry will not be searched."
943 :group 'org-agenda-skip
944 :type 'boolean)
946 (defcustom org-agenda-skip-timestamp-if-done nil
947 "Non-nil means don't select item by timestamp or -range if it is DONE."
948 :group 'org-agenda-skip
949 :group 'org-agenda-daily/weekly
950 :type 'boolean)
952 (defcustom org-agenda-dim-blocked-tasks t
953 "Non-nil means dim blocked tasks in the agenda display.
954 This causes some overhead during agenda construction, but if you
955 have turned on `org-enforce-todo-dependencies',
956 `org-enforce-todo-checkbox-dependencies', or any other blocking
957 mechanism, this will create useful feedback in the agenda.
959 Instead of t, this variable can also have the value `invisible'.
960 Then blocked tasks will be invisible and only become visible when
961 they become unblocked. An exemption to this behavior is when a task is
962 blocked because of unchecked checkboxes below it. Since checkboxes do
963 not show up in the agenda views, making this task invisible you remove any
964 trace from agenda views that there is something to do. Therefore, a task
965 that is blocked because of checkboxes will never be made invisible, it
966 will only be dimmed."
967 :group 'org-agenda-daily/weekly
968 :group 'org-agenda-todo-list
969 :version "24.3"
970 :type '(choice
971 (const :tag "Do not dim" nil)
972 (const :tag "Dim to a gray face" t)
973 (const :tag "Make invisible" invisible)))
975 (defcustom org-timeline-show-empty-dates 3
976 "Non-nil means `org-timeline' also shows dates without an entry.
977 When nil, only the days which actually have entries are shown.
978 When t, all days between the first and the last date are shown.
979 When an integer, show also empty dates, but if there is a gap of more than
980 N days, just insert a special line indicating the size of the gap."
981 :group 'org-agenda-skip
982 :type '(choice
983 (const :tag "None" nil)
984 (const :tag "All" t)
985 (integer :tag "at most")))
987 (defgroup org-agenda-startup nil
988 "Options concerning initial settings in the Agenda in Org Mode."
989 :tag "Org Agenda Startup"
990 :group 'org-agenda)
992 (defcustom org-agenda-menu-show-matcher t
993 "Non-nil means show the match string in the agenda dispatcher menu.
994 When nil, the matcher string is not shown, but is put into the help-echo
995 property so than moving the mouse over the command shows it.
996 Setting it to nil is good if matcher strings are very long and/or if
997 you want to use two-columns display (see `org-agenda-menu-two-columns')."
998 :group 'org-agenda
999 :version "24.1"
1000 :type 'boolean)
1002 (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
1004 (defcustom org-agenda-menu-two-columns nil
1005 "Non-nil means, use two columns to show custom commands in the dispatcher.
1006 If you use this, you probably want to set `org-agenda-menu-show-matcher'
1007 to nil."
1008 :group 'org-agenda
1009 :version "24.1"
1010 :type 'boolean)
1012 (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
1013 (defcustom org-agenda-finalize-hook nil
1014 "Hook run just before displaying an agenda buffer.
1015 The buffer is still writable when the hook is called.
1017 You can modify some of the buffer substrings but you should be
1018 extra careful not to modify the text properties of the agenda
1019 headlines as the agenda display heavily relies on them."
1020 :group 'org-agenda-startup
1021 :type 'hook)
1023 (defcustom org-agenda-mouse-1-follows-link nil
1024 "Non-nil means mouse-1 on a link will follow the link in the agenda.
1025 A longer mouse click will still set point. Does not work on XEmacs.
1026 Needs to be set before org.el is loaded."
1027 :group 'org-agenda-startup
1028 :type 'boolean)
1030 (defcustom org-agenda-start-with-follow-mode nil
1031 "The initial value of follow mode in a newly created agenda window."
1032 :group 'org-agenda-startup
1033 :type 'boolean)
1035 (defcustom org-agenda-follow-indirect nil
1036 "Non-nil means `org-agenda-follow-mode' displays only the
1037 current item's tree, in an indirect buffer."
1038 :group 'org-agenda
1039 :version "24.1"
1040 :type 'boolean)
1042 (defcustom org-agenda-show-outline-path t
1043 "Non-nil means show outline path in echo area after line motion."
1044 :group 'org-agenda-startup
1045 :type 'boolean)
1047 (defcustom org-agenda-start-with-entry-text-mode nil
1048 "The initial value of entry-text-mode in a newly created agenda window."
1049 :group 'org-agenda-startup
1050 :type 'boolean)
1052 (defcustom org-agenda-entry-text-maxlines 5
1053 "Number of text lines to be added when `E' is pressed in the agenda.
1055 Note that this variable only used during agenda display. Add add entry text
1056 when exporting the agenda, configure the variable
1057 `org-agenda-add-entry-ext-maxlines'."
1058 :group 'org-agenda
1059 :type 'integer)
1061 (defcustom org-agenda-entry-text-exclude-regexps nil
1062 "List of regular expressions to clean up entry text.
1063 The complete matches of all regular expressions in this list will be
1064 removed from entry text before it is shown in the agenda."
1065 :group 'org-agenda
1066 :type '(repeat (regexp)))
1068 (defcustom org-agenda-entry-text-leaders " > "
1069 "Text prepended to the entry text in agenda buffers."
1070 :version "24.4"
1071 :package-version '(Org . "8.0")
1072 :group 'org-agenda
1073 :type 'string)
1075 (defvar org-agenda-entry-text-cleanup-hook nil
1076 "Hook that is run after basic cleanup of entry text to be shown in agenda.
1077 This cleanup is done in a temporary buffer, so the function may inspect and
1078 change the entire buffer.
1079 Some default stuff like drawers and scheduling/deadline dates will already
1080 have been removed when this is called, as will any matches for regular
1081 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
1083 (defvar org-agenda-include-inactive-timestamps nil
1084 "Non-nil means include inactive time stamps in agenda and timeline.
1085 Dynamically scoped.")
1087 (defgroup org-agenda-windows nil
1088 "Options concerning the windows used by the Agenda in Org Mode."
1089 :tag "Org Agenda Windows"
1090 :group 'org-agenda)
1092 (defcustom org-agenda-window-setup 'reorganize-frame
1093 "How the agenda buffer should be displayed.
1094 Possible values for this option are:
1096 current-window Show agenda in the current window, keeping all other windows.
1097 other-window Use `switch-to-buffer-other-window' to display agenda.
1098 only-window Show agenda, deleting all other windows.
1099 reorganize-frame Show only two windows on the current frame, the current
1100 window and the agenda.
1101 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1102 Also, when exiting the agenda, kill that frame.
1103 See also the variable `org-agenda-restore-windows-after-quit'."
1104 :group 'org-agenda-windows
1105 :type '(choice
1106 (const current-window)
1107 (const other-frame)
1108 (const other-window)
1109 (const only-window)
1110 (const reorganize-frame)))
1112 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
1113 "The min and max height of the agenda window as a fraction of frame height.
1114 The value of the variable is a cons cell with two numbers between 0 and 1.
1115 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
1116 :group 'org-agenda-windows
1117 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
1119 (defcustom org-agenda-restore-windows-after-quit nil
1120 "Non-nil means restore window configuration upon exiting agenda.
1121 Before the window configuration is changed for displaying the agenda,
1122 the current status is recorded. When the agenda is exited with
1123 `q' or `x' and this option is set, the old state is restored. If
1124 `org-agenda-window-setup' is `other-frame', the value of this
1125 option will be ignored."
1126 :group 'org-agenda-windows
1127 :type 'boolean)
1129 (defcustom org-agenda-ndays nil
1130 "Number of days to include in overview display.
1131 Should be 1 or 7.
1132 Obsolete, see `org-agenda-span'."
1133 :group 'org-agenda-daily/weekly
1134 :type '(choice (const nil)
1135 (integer)))
1137 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1139 (defcustom org-agenda-span 'week
1140 "Number of days to include in overview display.
1141 Can be day, week, month, year, or any number of days.
1142 Custom commands can set this variable in the options section."
1143 :group 'org-agenda-daily/weekly
1144 :type '(choice (const :tag "Day" day)
1145 (const :tag "Week" week)
1146 (const :tag "Fortnight" fortnight)
1147 (const :tag "Month" month)
1148 (const :tag "Year" year)
1149 (integer :tag "Custom")))
1151 (defcustom org-agenda-start-on-weekday 1
1152 "Non-nil means start the overview always on the specified weekday.
1153 0 denotes Sunday, 1 denotes Monday, etc.
1154 When nil, always start on the current day.
1155 Custom commands can set this variable in the options section."
1156 :group 'org-agenda-daily/weekly
1157 :type '(choice (const :tag "Today" nil)
1158 (integer :tag "Weekday No.")))
1160 (defcustom org-agenda-show-all-dates t
1161 "Non-nil means `org-agenda' shows every day in the selected range.
1162 When nil, only the days which actually have entries are shown."
1163 :group 'org-agenda-daily/weekly
1164 :type 'boolean)
1166 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1167 "Format string for displaying dates in the agenda.
1168 Used by the daily/weekly agenda and by the timeline. This should be
1169 a format string understood by `format-time-string', or a function returning
1170 the formatted date as a string. The function must take a single argument,
1171 a calendar-style date list like (month day year)."
1172 :group 'org-agenda-daily/weekly
1173 :type '(choice
1174 (string :tag "Format string")
1175 (function :tag "Function")))
1177 (defun org-agenda-format-date-aligned (date)
1178 "Format a DATE string for display in the daily/weekly agenda, or timeline.
1179 This function makes sure that dates are aligned for easy reading."
1180 (require 'cal-iso)
1181 (let* ((dayname (calendar-day-name date))
1182 (day (cadr date))
1183 (day-of-week (calendar-day-of-week date))
1184 (month (car date))
1185 (monthname (calendar-month-name month))
1186 (year (nth 2 date))
1187 (iso-week (org-days-to-iso-week
1188 (calendar-absolute-from-gregorian date)))
1189 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1190 (1- year))
1191 ((and (= month 12) (<= iso-week 1))
1192 (1+ year))
1193 (t year)))
1194 (weekstring (if (= day-of-week 1)
1195 (format " W%02d" iso-week)
1196 "")))
1197 (format "%-10s %2d %s %4d%s"
1198 dayname day monthname year weekstring)))
1200 (defcustom org-agenda-time-leading-zero nil
1201 "Non-nil means use leading zero for military times in agenda.
1202 For example, 9:30am would become 09:30 rather than 9:30."
1203 :group 'org-agenda-daily/weekly
1204 :version "24.1"
1205 :type 'boolean)
1207 (defcustom org-agenda-timegrid-use-ampm nil
1208 "When set, show AM/PM style timestamps on the timegrid."
1209 :group 'org-agenda
1210 :version "24.1"
1211 :type 'boolean)
1213 (defun org-agenda-time-of-day-to-ampm (time)
1214 "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
1215 (let* ((hour-number (string-to-number (substring time 0 -3)))
1216 (minute (substring time -2))
1217 (ampm "am"))
1218 (cond
1219 ((equal hour-number 12)
1220 (setq ampm "pm"))
1221 ((> hour-number 12)
1222 (setq ampm "pm")
1223 (setq hour-number (- hour-number 12))))
1224 (concat
1225 (if org-agenda-time-leading-zero
1226 (format "%02d" hour-number)
1227 (format "%02s" (number-to-string hour-number)))
1228 ":" minute ampm)))
1230 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1231 "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
1232 (if org-agenda-timegrid-use-ampm
1233 (org-agenda-time-of-day-to-ampm time)
1234 time))
1236 (defcustom org-agenda-weekend-days '(6 0)
1237 "Which days are weekend?
1238 These days get the special face `org-agenda-date-weekend' in the agenda
1239 and timeline buffers."
1240 :group 'org-agenda-daily/weekly
1241 :type '(set :greedy t
1242 (const :tag "Monday" 1)
1243 (const :tag "Tuesday" 2)
1244 (const :tag "Wednesday" 3)
1245 (const :tag "Thursday" 4)
1246 (const :tag "Friday" 5)
1247 (const :tag "Saturday" 6)
1248 (const :tag "Sunday" 0)))
1250 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1251 "Non-nil means jump to today when moving a past date forward in time.
1252 When using S-right in the agenda to move a a date forward, and the date
1253 stamp currently points to the past, the first key press will move it
1254 to today. WHen nil, just move one day forward even if the date stays
1255 in the past."
1256 :group 'org-agenda-daily/weekly
1257 :version "24.1"
1258 :type 'boolean)
1260 (defcustom org-agenda-include-diary nil
1261 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1262 Custom commands can set this variable in the options section."
1263 :group 'org-agenda-daily/weekly
1264 :type 'boolean)
1266 (defcustom org-agenda-include-deadlines t
1267 "If non-nil, include entries within their deadline warning period.
1268 Custom commands can set this variable in the options section."
1269 :group 'org-agenda-daily/weekly
1270 :version "24.1"
1271 :type 'boolean)
1273 (defcustom org-agenda-repeating-timestamp-show-all t
1274 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1275 When set to a list of strings, only show occurrences of repeating
1276 stamps for these TODO keywords. When nil, only one occurrence is
1277 shown, either today or the nearest into the future."
1278 :group 'org-agenda-daily/weekly
1279 :type '(choice
1280 (const :tag "Show repeating stamps" t)
1281 (repeat :tag "Show repeating stamps for these TODO keywords"
1282 (string :tag "TODO Keyword"))
1283 (const :tag "Don't show repeating stamps" nil)))
1285 (defcustom org-scheduled-past-days 10000
1286 "Number of days to continue listing scheduled items not marked DONE.
1287 When an item is scheduled on a date, it shows up in the agenda on
1288 this day and will be listed until it is marked done or for the
1289 number of days given here."
1290 :group 'org-agenda-daily/weekly
1291 :type 'integer)
1293 (defcustom org-agenda-log-mode-items '(closed clock)
1294 "List of items that should be shown in agenda log mode.
1295 \\<org-agenda-mode-map>\
1296 This list may contain the following symbols:
1298 closed Show entries that have been closed on that day.
1299 clock Show entries that have received clocked time on that day.
1300 state Show all logged state changes.
1301 Note that instead of changing this variable, you can also press \
1302 `\\[universal-argument] \\[org-agenda-log-mode]' in
1303 the agenda to display all available LOG items temporarily."
1304 :group 'org-agenda-daily/weekly
1305 :type '(set :greedy t (const closed) (const clock) (const state)))
1307 (defcustom org-agenda-clock-consistency-checks
1308 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1309 :gap-ok-around ("4:00")
1310 :default-face ((:background "DarkRed") (:foreground "white"))
1311 :overlap-face nil :gap-face nil :no-end-time-face nil
1312 :long-face nil :short-face nil)
1313 "This is a property list, with the following keys:
1315 :max-duration Mark clocking chunks that are longer than this time.
1316 This is a time string like \"HH:MM\", or the number
1317 of minutes as an integer.
1319 :min-duration Mark clocking chunks that are shorter that this.
1320 This is a time string like \"HH:MM\", or the number
1321 of minutes as an integer.
1323 :max-gap Mark gaps between clocking chunks that are longer than
1324 this duration. A number of minutes, or a string
1325 like \"HH:MM\".
1327 :gap-ok-around List of times during the day which are usually not working
1328 times. When a gap is detected, but the gap contains any
1329 of these times, the gap is *not* reported. For example,
1330 if this is (\"4:00\" \"13:00\") then gaps that contain
1331 4:00 in the morning (i.e. the night) and 13:00
1332 (i.e. a typical lunch time) do not cause a warning.
1333 You should have at least one time during the night in this
1334 list, or otherwise the first task each morning will trigger
1335 a warning because it follows a long gap.
1337 Furthermore, the following properties can be used to define faces for
1338 issue display.
1340 :default-face the default face, if the specific face is undefined
1341 :overlap-face face for overlapping clocks
1342 :gap-face face for gaps between clocks
1343 :no-end-time-face face for incomplete clocks
1344 :long-face face for clock intervals that are too long
1345 :short-face face for clock intervals that are too short"
1346 :group 'org-agenda-daily/weekly
1347 :group 'org-clock
1348 :version "24.1"
1349 :type 'plist)
1351 (defcustom org-agenda-log-mode-add-notes t
1352 "Non-nil means add first line of notes to log entries in agenda views.
1353 If a log item like a state change or a clock entry is associated with
1354 notes, the first line of these notes will be added to the entry in the
1355 agenda display."
1356 :group 'org-agenda-daily/weekly
1357 :type 'boolean)
1359 (defcustom org-agenda-start-with-log-mode nil
1360 "The initial value of log-mode in a newly created agenda window.
1361 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1362 explanations on the possible values."
1363 :group 'org-agenda-startup
1364 :group 'org-agenda-daily/weekly
1365 :type '(choice (const :tag "Don't show log items" nil)
1366 (const :tag "Show only log items" only)
1367 (const :tag "Show all possible log items" clockcheck)
1368 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1369 (choice (const :tag "Show closed log items" closed)
1370 (const :tag "Show clocked log items" clock)
1371 (const :tag "Show all logged state changes" state)))))
1373 (defcustom org-agenda-start-with-clockreport-mode nil
1374 "The initial value of clockreport-mode in a newly created agenda window."
1375 :group 'org-agenda-startup
1376 :group 'org-agenda-daily/weekly
1377 :type 'boolean)
1379 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1380 "Property list with parameters for the clocktable in clockreport mode.
1381 This is the display mode that shows a clock table in the daily/weekly
1382 agenda, the properties for this dynamic block can be set here.
1383 The usual clocktable parameters are allowed here, but you cannot set
1384 the properties :name, :tstart, :tend, :block, and :scope - these will
1385 be overwritten to make sure the content accurately reflects the
1386 current display in the agenda."
1387 :group 'org-agenda-daily/weekly
1388 :type 'plist)
1390 (defcustom org-agenda-search-view-always-boolean nil
1391 "Non-nil means the search string is interpreted as individual parts.
1393 The search string for search view can either be interpreted as a phrase,
1394 or as a list of snippets that define a boolean search for a number of
1395 strings.
1397 When this is non-nil, the string will be split on whitespace, and each
1398 snippet will be searched individually, and all must match in order to
1399 select an entry. A snippet is then a single string of non-white
1400 characters, or a string in double quotes, or a regexp in {} braces.
1401 If a snippet is preceded by \"-\", the snippet must *not* match.
1402 \"+\" is syntactic sugar for positive selection. Each snippet may
1403 be found as a full word or a partial word, but see the variable
1404 `org-agenda-search-view-force-full-words'.
1406 When this is nil, search will look for the entire search phrase as one,
1407 with each space character matching any amount of whitespace, including
1408 line breaks.
1410 Even when this is nil, you can still switch to Boolean search dynamically
1411 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1412 is a regexp marked with braces like \"{abc}\", this will also switch to
1413 boolean search."
1414 :group 'org-agenda-search-view
1415 :version "24.1"
1416 :type 'boolean)
1418 (org-defvaralias 'org-agenda-search-view-search-words-only
1419 'org-agenda-search-view-always-boolean)
1421 (defcustom org-agenda-search-view-force-full-words nil
1422 "Non-nil means, search words must be matches as complete words.
1423 When nil, they may also match part of a word."
1424 :group 'org-agenda-search-view
1425 :version "24.1"
1426 :type 'boolean)
1428 (defcustom org-agenda-search-view-max-outline-level 0
1429 "Maximum outline level to display in search view.
1430 E.g. when this is set to 1, the search view will only
1431 show headlines of level 1. When set to 0, the default
1432 value, don't limit agenda view by outline level."
1433 :group 'org-agenda-search-view
1434 :version "24.4"
1435 :package-version '(Org . "8.3")
1436 :type 'integer)
1438 (defgroup org-agenda-time-grid nil
1439 "Options concerning the time grid in the Org-mode Agenda."
1440 :tag "Org Agenda Time Grid"
1441 :group 'org-agenda)
1443 (defcustom org-agenda-search-headline-for-time t
1444 "Non-nil means search headline for a time-of-day.
1445 If the headline contains a time-of-day in one format or another, it will
1446 be used to sort the entry into the time sequence of items for a day.
1447 Some people have time stamps in the headline that refer to the creation
1448 time or so, and then this produces an unwanted side effect. If this is
1449 the case for your, use this variable to turn off searching the headline
1450 for a time."
1451 :group 'org-agenda-time-grid
1452 :type 'boolean)
1454 (defcustom org-agenda-use-time-grid t
1455 "Non-nil means show a time grid in the agenda schedule.
1456 A time grid is a set of lines for specific times (like every two hours between
1457 8:00 and 20:00). The items scheduled for a day at specific times are
1458 sorted in between these lines.
1459 For details about when the grid will be shown, and what it will look like, see
1460 the variable `org-agenda-time-grid'."
1461 :group 'org-agenda-time-grid
1462 :type 'boolean)
1464 (defcustom org-agenda-time-grid
1465 '((daily today require-timed)
1466 "----------------"
1467 (800 1000 1200 1400 1600 1800 2000))
1469 "The settings for time grid for agenda display.
1470 This is a list of three items. The first item is again a list. It contains
1471 symbols specifying conditions when the grid should be displayed:
1473 daily if the agenda shows a single day
1474 weekly if the agenda shows an entire week
1475 today show grid on current date, independent of daily/weekly display
1476 require-timed show grid only if at least one item has a time specification
1477 remove-match skip grid times already present in an entry
1479 The second item is a string which will be placed behind the grid time.
1481 The third item is a list of integers, indicating the times that should have
1482 a grid line."
1483 :group 'org-agenda-time-grid
1484 :type
1485 '(list
1486 (set :greedy t :tag "Grid Display Options"
1487 (const :tag "Show grid in single day agenda display" daily)
1488 (const :tag "Show grid in weekly agenda display" weekly)
1489 (const :tag "Always show grid for today" today)
1490 (const :tag "Show grid only if any timed entries are present"
1491 require-timed)
1492 (const :tag "Skip grid times already present in an entry"
1493 remove-match))
1494 (string :tag "Grid String")
1495 (repeat :tag "Grid Times" (integer :tag "Time"))))
1497 (defcustom org-agenda-show-current-time-in-grid t
1498 "Non-nil means show the current time in the time grid."
1499 :group 'org-agenda-time-grid
1500 :version "24.1"
1501 :type 'boolean)
1503 (defcustom org-agenda-current-time-string
1504 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1505 "The string for the current time marker in the agenda."
1506 :group 'org-agenda-time-grid
1507 :version "24.1"
1508 :type 'string)
1510 (defgroup org-agenda-sorting nil
1511 "Options concerning sorting in the Org-mode Agenda."
1512 :tag "Org Agenda Sorting"
1513 :group 'org-agenda)
1515 (defcustom org-agenda-sorting-strategy
1516 '((agenda habit-down time-up priority-down category-keep)
1517 (todo priority-down category-keep)
1518 (tags priority-down category-keep)
1519 (search category-keep))
1520 "Sorting structure for the agenda items of a single day.
1521 This is a list of symbols which will be used in sequence to determine
1522 if an entry should be listed before another entry. The following
1523 symbols are recognized:
1525 time-up Put entries with time-of-day indications first, early first
1526 time-down Put entries with time-of-day indications first, late first
1527 timestamp-up Sort by any timestamp, early first
1528 timestamp-down Sort by any timestamp, late first
1529 scheduled-up Sort by scheduled timestamp, early first
1530 scheduled-down Sort by scheduled timestamp, late first
1531 deadline-up Sort by deadline timestamp, early first
1532 deadline-down Sort by deadline timestamp, late first
1533 ts-up Sort by active timestamp, early first
1534 ts-down Sort by active timestamp, late first
1535 tsia-up Sort by inactive timestamp, early first
1536 tsia-down Sort by inactive timestamp, late first
1537 category-keep Keep the default order of categories, corresponding to the
1538 sequence in `org-agenda-files'.
1539 category-up Sort alphabetically by category, A-Z.
1540 category-down Sort alphabetically by category, Z-A.
1541 tag-up Sort alphabetically by last tag, A-Z.
1542 tag-down Sort alphabetically by last tag, Z-A.
1543 priority-up Sort numerically by priority, high priority last.
1544 priority-down Sort numerically by priority, high priority first.
1545 todo-state-up Sort by todo state, tasks that are done last.
1546 todo-state-down Sort by todo state, tasks that are done first.
1547 effort-up Sort numerically by estimated effort, high effort last.
1548 effort-down Sort numerically by estimated effort, high effort first.
1549 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1550 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1551 habit-up Put entries that are habits first
1552 habit-down Put entries that are habits last
1553 alpha-up Sort headlines alphabetically
1554 alpha-down Sort headlines alphabetically, reversed
1556 The different possibilities will be tried in sequence, and testing stops
1557 if one comparison returns a \"not-equal\". For example, the default
1558 '(time-up category-keep priority-down)
1559 means: Pull out all entries having a specified time of day and sort them,
1560 in order to make a time schedule for the current day the first thing in the
1561 agenda listing for the day. Of the entries without a time indication, keep
1562 the grouped in categories, don't sort the categories, but keep them in
1563 the sequence given in `org-agenda-files'. Within each category sort by
1564 priority.
1566 Leaving out `category-keep' would mean that items will be sorted across
1567 categories by priority.
1569 Instead of a single list, this can also be a set of list for specific
1570 contents, with a context symbol in the car of the list, any of
1571 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1573 Custom commands can bind this variable in the options section."
1574 :group 'org-agenda-sorting
1575 :type `(choice
1576 (repeat :tag "General" ,org-sorting-choice)
1577 (list :tag "Individually"
1578 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1579 (repeat ,org-sorting-choice))
1580 (cons (const :tag "Strategy for TODO lists" todo)
1581 (repeat ,org-sorting-choice))
1582 (cons (const :tag "Strategy for Tags matches" tags)
1583 (repeat ,org-sorting-choice))
1584 (cons (const :tag "Strategy for search matches" search)
1585 (repeat ,org-sorting-choice)))))
1587 (defcustom org-agenda-cmp-user-defined nil
1588 "A function to define the comparison `user-defined'.
1589 This function must receive two arguments, agenda entry a and b.
1590 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1591 the user comparison, return nil.
1592 When this is defined, you can make `user-defined-up' and `user-defined-down'
1593 part of an agenda sorting strategy."
1594 :group 'org-agenda-sorting
1595 :type 'symbol)
1597 (defcustom org-sort-agenda-notime-is-late t
1598 "Non-nil means items without time are considered late.
1599 This is only relevant for sorting. When t, items which have no explicit
1600 time like 15:30 will be considered as 99:01, i.e. later than any items which
1601 do have a time. When nil, the default time is before 0:00. You can use this
1602 option to decide if the schedule for today should come before or after timeless
1603 agenda entries."
1604 :group 'org-agenda-sorting
1605 :type 'boolean)
1607 (defcustom org-sort-agenda-noeffort-is-high t
1608 "Non-nil means items without effort estimate are sorted as high effort.
1609 This also applies when filtering an agenda view with respect to the
1610 < or > effort operator. Then, tasks with no effort defined will be treated
1611 as tasks with high effort.
1612 When nil, such items are sorted as 0 minutes effort."
1613 :group 'org-agenda-sorting
1614 :type 'boolean)
1616 (defgroup org-agenda-line-format nil
1617 "Options concerning the entry prefix in the Org-mode agenda display."
1618 :tag "Org Agenda Line Format"
1619 :group 'org-agenda)
1621 (defcustom org-agenda-prefix-format
1622 '((agenda . " %i %-12:c%?-12t% s")
1623 (timeline . " % s")
1624 (todo . " %i %-12:c")
1625 (tags . " %i %-12:c")
1626 (search . " %i %-12:c"))
1627 "Format specifications for the prefix of items in the agenda views.
1628 An alist with five entries, each for the different agenda types. The
1629 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1630 The values are format strings.
1632 This format works similar to a printf format, with the following meaning:
1634 %c the category of the item, \"Diary\" for entries from the diary,
1635 or as given by the CATEGORY keyword or derived from the file name
1636 %e the effort required by the item
1637 %l the level of the item (insert X space(s) if item is of level X)
1638 %i the icon category of the item, see `org-agenda-category-icon-alist'
1639 %T the last tag of the item (ignore inherited tags, which come first)
1640 %t the HH:MM time-of-day specification if one applies to the entry
1641 %s Scheduling/Deadline information, a short string
1642 %b show breadcrumbs, i.e., the names of the higher levels
1643 %(expression) Eval EXPRESSION and replace the control string
1644 by the result
1646 All specifiers work basically like the standard `%s' of printf, but may
1647 contain two additional characters: a question mark just after the `%'
1648 and a whitespace/punctuation character just before the final letter.
1650 If the first character after `%' is a question mark, the entire field
1651 will only be included if the corresponding value applies to the current
1652 entry. This is useful for fields which should have fixed width when
1653 present, but zero width when absent. For example, \"%?-12t\" will
1654 result in a 12 character time field if a time of the day is specified,
1655 but will completely disappear in entries which do not contain a time.
1657 If there is punctuation or whitespace character just before the
1658 final format letter, this character will be appended to the field
1659 value if the value is not empty. For example, the format
1660 \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
1661 the category is empty, no additional colon is inserted.
1663 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1664 which means:
1666 - Indent the line with two space characters
1667 - Give the category a 12 chars wide field, padded with whitespace on
1668 the right (because of `-'). Append a colon if there is a category
1669 (because of `:').
1670 - If there is a time-of-day, put it into a 12 chars wide field. If no
1671 time, don't put in an empty field, just skip it (because of '?').
1672 - Finally, put the scheduling information.
1674 See also the variables `org-agenda-remove-times-when-in-prefix' and
1675 `org-agenda-remove-tags'.
1677 Custom commands can set this variable in the options section."
1678 :type '(choice
1679 (string :tag "General format")
1680 (list :greedy t :tag "View dependent"
1681 (cons (const agenda) (string :tag "Format"))
1682 (cons (const timeline) (string :tag "Format"))
1683 (cons (const todo) (string :tag "Format"))
1684 (cons (const tags) (string :tag "Format"))
1685 (cons (const search) (string :tag "Format"))))
1686 :group 'org-agenda-line-format)
1688 (defvar org-prefix-format-compiled nil
1689 "The compiled prefix format and associated variables.
1690 This is a list where first element is a list of variable bindings, and second
1691 element is the compiled format expression. See the variable
1692 `org-agenda-prefix-format'.")
1694 (defcustom org-agenda-todo-keyword-format "%-1s"
1695 "Format for the TODO keyword in agenda lines.
1696 Set this to something like \"%-12s\" if you want all TODO keywords
1697 to occupy a fixed space in the agenda display."
1698 :group 'org-agenda-line-format
1699 :type 'string)
1701 (defcustom org-agenda-diary-sexp-prefix nil
1702 "A regexp that matches part of a diary sexp entry
1703 which should be treated as scheduling/deadline information in
1704 `org-agenda'.
1706 For example, you can use this to extract the `diary-remind-message' from
1707 `diary-remind' entries."
1708 :group 'org-agenda-line-format
1709 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1711 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1712 "Text preceding timerange entries in the agenda view.
1713 This is a list with two strings. The first applies when the range
1714 is entirely on one day. The second applies if the range spans several days.
1715 The strings may have two \"%d\" format specifiers which will be filled
1716 with the sequence number of the days, and the total number of days in the
1717 range, respectively."
1718 :group 'org-agenda-line-format
1719 :type '(list
1720 (string :tag "Deadline today ")
1721 (choice :tag "Deadline relative"
1722 (string :tag "Format string")
1723 (function))))
1725 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1726 "Text preceding scheduled items in the agenda view.
1727 This is a list with two strings. The first applies when the item is
1728 scheduled on the current day. The second applies when it has been scheduled
1729 previously, it may contain a %d indicating that this is the nth time that
1730 this item is scheduled, due to automatic rescheduling of unfinished items
1731 for the following day. So this number is one larger than the number of days
1732 that passed since this item was scheduled first."
1733 :group 'org-agenda-line-format
1734 :version "24.4"
1735 :package-version '(Org . "8.0")
1736 :type '(list
1737 (string :tag "Scheduled today ")
1738 (string :tag "Scheduled previously")))
1740 (defcustom org-agenda-inactive-leader "["
1741 "Text preceding item pulled into the agenda by inactive time stamps.
1742 These entries are added to the agenda when pressing \"[\"."
1743 :group 'org-agenda-line-format
1744 :version "24.1"
1745 :type 'string)
1747 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
1748 "Text preceding deadline items in the agenda view.
1749 This is a list with three strings. The first applies when the item has its
1750 deadline on the current day. The second applies when the deadline is in the
1751 future, the third one when it is in the past. The strings may contain %d
1752 to capture the number of days."
1753 :group 'org-agenda-line-format
1754 :version "24.4"
1755 :package-version '(Org . "8.0")
1756 :type '(list
1757 (string :tag "Deadline today ")
1758 (string :tag "Deadline in the future ")
1759 (string :tag "Deadline in the past ")))
1761 (defcustom org-agenda-remove-times-when-in-prefix t
1762 "Non-nil means remove duplicate time specifications in agenda items.
1763 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1764 time-of-day specification in a headline or diary entry is extracted and
1765 placed into the prefix. If this option is non-nil, the original specification
1766 \(a timestamp or -range, or just a plain time(range) specification like
1767 11:30-4pm) will be removed for agenda display. This makes the agenda less
1768 cluttered.
1769 The option can be t or nil. It may also be the symbol `beg', indicating
1770 that the time should only be removed when it is located at the beginning of
1771 the headline/diary entry."
1772 :group 'org-agenda-line-format
1773 :type '(choice
1774 (const :tag "Always" t)
1775 (const :tag "Never" nil)
1776 (const :tag "When at beginning of entry" beg)))
1778 (defcustom org-agenda-remove-timeranges-from-blocks nil
1779 "Non-nil means remove time ranges specifications in agenda
1780 items that span on several days."
1781 :group 'org-agenda-line-format
1782 :version "24.1"
1783 :type 'boolean)
1785 (defcustom org-agenda-default-appointment-duration nil
1786 "Default duration for appointments that only have a starting time.
1787 When nil, no duration is specified in such cases.
1788 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1789 :group 'org-agenda-line-format
1790 :type '(choice
1791 (integer :tag "Minutes")
1792 (const :tag "No default duration")))
1794 (defcustom org-agenda-show-inherited-tags t
1795 "Non-nil means show inherited tags in each agenda line.
1797 When this option is set to `always', it take precedences over
1798 `org-agenda-use-tag-inheritance' and inherited tags are shown
1799 in every agenda.
1801 When this option is set to t (the default), inherited tags are
1802 shown when they are available, i.e. when the value of
1803 `org-agenda-use-tag-inheritance' has been taken into account.
1805 This can be set to a list of agenda types in which the agenda
1806 must display the inherited tags. Available types are `todo',
1807 `agenda', `search' and `timeline'.
1809 When set to nil, never show inherited tags in agenda lines."
1810 :group 'org-agenda-line-format
1811 :group 'org-agenda
1812 :version "24.3"
1813 :type '(choice
1814 (const :tag "Show inherited tags when available" t)
1815 (const :tag "Always show inherited tags" always)
1816 (repeat :tag "Show inherited tags only in selected agenda types"
1817 (symbol :tag "Agenda type"))))
1819 (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
1820 "List of agenda view types where to use tag inheritance.
1822 In tags/tags-todo/tags-tree agenda views, tag inheritance is
1823 controlled by `org-use-tag-inheritance'. In other agenda types,
1824 `org-use-tag-inheritance' is not used for the selection of the
1825 agenda entries. Still, you may want the agenda to be aware of
1826 the inherited tags anyway, e.g. for later tag filtering.
1828 Allowed value are `todo', `search', `timeline' and `agenda'.
1830 This variable has no effect if `org-agenda-show-inherited-tags'
1831 is set to `always'. In that case, the agenda is aware of those
1832 tags.
1834 The default value sets tags in every agenda type. Setting this
1835 option to nil will speed up non-tags agenda view a lot."
1836 :group 'org-agenda
1837 :version "24.3"
1838 :type '(choice
1839 (const :tag "Use tag inheritance in all agenda types" t)
1840 (repeat :tag "Use tag inheritance in selected agenda types"
1841 (symbol :tag "Agenda type"))))
1843 (defcustom org-agenda-hide-tags-regexp nil
1844 "Regular expression used to filter away specific tags in agenda views.
1845 This means that these tags will be present, but not be shown in the agenda
1846 line. Secondary filtering will still work on the hidden tags.
1847 Nil means don't hide any tags."
1848 :group 'org-agenda-line-format
1849 :type '(choice
1850 (const :tag "Hide none" nil)
1851 (string :tag "Regexp ")))
1853 (defcustom org-agenda-remove-tags nil
1854 "Non-nil means remove the tags from the headline copy in the agenda.
1855 When this is the symbol `prefix', only remove tags when
1856 `org-agenda-prefix-format' contains a `%T' specifier."
1857 :group 'org-agenda-line-format
1858 :type '(choice
1859 (const :tag "Always" t)
1860 (const :tag "Never" nil)
1861 (const :tag "When prefix format contains %T" prefix)))
1863 (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
1864 'org-agenda-remove-tags)
1866 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1867 "Shift tags in agenda items to this column.
1868 If this number is positive, it specifies the column. If it is negative,
1869 it means that the tags should be flushright to that column. For example,
1870 -80 works well for a normal 80 character screen."
1871 :group 'org-agenda-line-format
1872 :type 'integer)
1874 (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
1876 (defcustom org-agenda-fontify-priorities 'cookies
1877 "Non-nil means highlight low and high priorities in agenda.
1878 When t, the highest priority entries are bold, lowest priority italic.
1879 However, settings in `org-priority-faces' will overrule these faces.
1880 When this variable is the symbol `cookies', only fontify the
1881 cookies, not the entire task.
1882 This may also be an association list of priority faces, whose
1883 keys are the character values of `org-highest-priority',
1884 `org-default-priority', and `org-lowest-priority' (the default values
1885 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1886 color as a string, or a list like `(:background \"Red\")'.
1887 If it is a color, the variable `org-faces-easy-properties'
1888 determines if it is a foreground or a background color."
1889 :group 'org-agenda-line-format
1890 :type '(choice
1891 (const :tag "Never" nil)
1892 (const :tag "Defaults" t)
1893 (const :tag "Cookies only" cookies)
1894 (repeat :tag "Specify"
1895 (list (character :tag "Priority" :value ?A)
1896 (choice :tag "Face "
1897 (string :tag "Color")
1898 (sexp :tag "Face"))))))
1900 (defcustom org-agenda-day-face-function nil
1901 "Function called to determine what face should be used to display a day.
1902 The only argument passed to that function is the day. It should
1903 returns a face, or nil if does not want to specify a face and let
1904 the normal rules apply."
1905 :group 'org-agenda-line-format
1906 :version "24.1"
1907 :type '(choice (const nil) (function)))
1909 (defcustom org-agenda-category-icon-alist nil
1910 "Alist of category icon to be displayed in agenda views.
1912 Each entry should have the following format:
1914 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1916 Where CATEGORY-REGEXP is a regexp matching the categories where
1917 the icon should be displayed.
1918 FILE-OR-DATA either a file path or a string containing image data.
1920 The other fields can be omitted safely if not needed:
1921 TYPE indicates the image type.
1922 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1923 image data.
1924 PROPS are additional image attributes to assign to the image,
1925 like, e.g. `:ascent center'.
1927 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1929 If you want to set the display properties yourself, just put a
1930 list as second element:
1932 (CATEGORY-REGEXP (MY PROPERTY LIST))
1934 For example, to display a 16px horizontal space for Emacs
1935 category, you can use:
1937 (\"Emacs\" \\='(space . (:width (16))))"
1938 :group 'org-agenda-line-format
1939 :version "24.1"
1940 :type '(alist :key-type (string :tag "Regexp matching category")
1941 :value-type (choice (list :tag "Icon"
1942 (string :tag "File or data")
1943 (symbol :tag "Type")
1944 (boolean :tag "Data?")
1945 (repeat :tag "Extra image properties" :inline t symbol))
1946 (list :tag "Display properties" sexp))))
1948 (defgroup org-agenda-column-view nil
1949 "Options concerning column view in the agenda."
1950 :tag "Org Agenda Column View"
1951 :group 'org-agenda)
1953 (defcustom org-agenda-columns-show-summaries t
1954 "Non-nil means show summaries for columns displayed in the agenda view."
1955 :group 'org-agenda-column-view
1956 :type 'boolean)
1958 (defcustom org-agenda-columns-compute-summary-properties t
1959 "Non-nil means recompute all summary properties before column view.
1960 When column view in the agenda is listing properties that have a summary
1961 operator, it can go to all relevant buffers and recompute the summaries
1962 there. This can mean overhead for the agenda column view, but is necessary
1963 to have thing up to date.
1964 As a special case, a CLOCKSUM property also makes sure that the clock
1965 computations are current."
1966 :group 'org-agenda-column-view
1967 :type 'boolean)
1969 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1970 "Non-nil means the duration of an appointment will add to day effort.
1971 The property to which appointment durations will be added is the one given
1972 in the option `org-effort-property'. If an appointment does not have
1973 an end time, `org-agenda-default-appointment-duration' will be used. If that
1974 is not set, an appointment without end time will not contribute to the time
1975 estimate."
1976 :group 'org-agenda-column-view
1977 :type 'boolean)
1979 (defcustom org-agenda-auto-exclude-function nil
1980 "A function called with a tag to decide if it is filtered on \
1981 \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
1982 The sole argument to the function, which is called once for each
1983 possible tag, is a string giving the name of the tag. The
1984 function should return either nil if the tag should be included
1985 as normal, or \"-<TAG>\" to exclude the tag.
1986 Note that for the purpose of tag filtering, only the lower-case version of
1987 all tags will be considered, so that this function will only ever see
1988 the lower-case version of all tags."
1989 :group 'org-agenda
1990 :type '(choice (const nil) (function)))
1992 (defcustom org-agenda-bulk-custom-functions nil
1993 "Alist of characters and custom functions for bulk actions.
1994 For example, this value makes those two functions available:
1996 \\='((?R set-category)
1997 (?C bulk-cut))
1999 With selected entries in an agenda buffer, `B R' will call
2000 the custom function `set-category' on the selected entries.
2001 Note that functions in this alist don't need to be quoted."
2002 :type 'alist
2003 :version "24.1"
2004 :group 'org-agenda)
2006 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
2007 "Execute BODY with point at location given by `org-hd-marker' property.
2008 If STRING is non-nil, the text property will be fetched from position 0
2009 in that string. If STRING is nil, it will be fetched from the beginning
2010 of the current line."
2011 (org-with-gensyms (marker)
2012 `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
2013 'org-hd-marker ,string)))
2014 (with-current-buffer (marker-buffer ,marker)
2015 (save-excursion
2016 (goto-char ,marker)
2017 ,@body)))))
2018 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
2020 (defun org-add-agenda-custom-command (entry)
2021 "Replace or add a command in `org-agenda-custom-commands'.
2022 This is mostly for hacking and trying a new command - once the command
2023 works you probably want to add it to `org-agenda-custom-commands' for good."
2024 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
2025 (if ass
2026 (setcdr ass (cdr entry))
2027 (push entry org-agenda-custom-commands))))
2029 ;;; Define the org-agenda-mode
2031 (defvar org-agenda-mode-map (make-sparse-keymap)
2032 "Keymap for `org-agenda-mode'.")
2033 (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
2035 (defvar org-agenda-menu) ; defined later in this file.
2036 (defvar org-agenda-restrict nil) ; defined later in this file.
2037 (defvar org-agenda-follow-mode nil)
2038 (defvar org-agenda-entry-text-mode nil)
2039 (defvar org-agenda-clockreport-mode nil)
2040 (defvar org-agenda-show-log nil)
2041 (defvar org-agenda-redo-command nil)
2042 (defvar org-agenda-query-string nil)
2043 (defvar org-agenda-mode-hook nil
2044 "Hook run after `org-agenda-mode' is turned on.
2045 The buffer is still writable when this hook is called.")
2046 (defvar org-agenda-type nil)
2047 (defvar org-agenda-force-single-file nil)
2048 (defvar org-agenda-bulk-marked-entries nil
2049 "List of markers that refer to marked entries in the agenda.")
2051 ;;; Multiple agenda buffers support
2053 (defcustom org-agenda-sticky nil
2054 "Non-nil means agenda q key will bury agenda buffers.
2055 Agenda commands will then show existing buffer instead of generating new ones.
2056 When nil, `q' will kill the single agenda buffer."
2057 :group 'org-agenda
2058 :version "24.3"
2059 :type 'boolean)
2062 ;;;###autoload
2063 (defun org-toggle-sticky-agenda (&optional arg)
2064 "Toggle `org-agenda-sticky'."
2065 (interactive "P")
2066 (let ((new-value (if arg
2067 (> (prefix-numeric-value arg) 0)
2068 (not org-agenda-sticky))))
2069 (if (equal new-value org-agenda-sticky)
2070 (and (org-called-interactively-p 'interactive)
2071 (message "Sticky agenda was already %s"
2072 (if org-agenda-sticky "enabled" "disabled")))
2073 (setq org-agenda-sticky new-value)
2074 (org-agenda-kill-all-agenda-buffers)
2075 (and (org-called-interactively-p 'interactive)
2076 (message "Sticky agenda %s"
2077 (if org-agenda-sticky "enabled" "disabled"))))))
2079 (defvar org-agenda-buffer nil
2080 "Agenda buffer currently being generated.")
2082 (defvar org-agenda-last-prefix-arg nil)
2083 (defvar org-agenda-this-buffer-name nil)
2084 (defvar org-agenda-doing-sticky-redo nil)
2085 (defvar org-agenda-this-buffer-is-sticky nil)
2086 (defvar org-agenda-last-indirect-buffer nil
2087 "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
2089 (defconst org-agenda-local-vars
2090 '(org-agenda-this-buffer-name
2091 org-agenda-undo-list
2092 org-agenda-pending-undo-list
2093 org-agenda-follow-mode
2094 org-agenda-entry-text-mode
2095 org-agenda-clockreport-mode
2096 org-agenda-show-log
2097 org-agenda-redo-command
2098 org-agenda-query-string
2099 org-agenda-type
2100 org-agenda-bulk-marked-entries
2101 org-agenda-undo-has-started-in
2102 org-agenda-info
2103 org-agenda-pre-window-conf
2104 org-agenda-columns-active
2105 org-agenda-tag-filter
2106 org-agenda-category-filter
2107 org-agenda-top-headline-filter
2108 org-agenda-regexp-filter
2109 org-agenda-effort-filter
2110 org-agenda-markers
2111 org-agenda-last-search-view-search-was-boolean
2112 org-agenda-last-indirect-buffer
2113 org-agenda-filtered-by-category
2114 org-agenda-filter-form
2115 org-agenda-cycle-counter
2116 org-agenda-last-prefix-arg)
2117 "Variables that must be local in agenda buffers to allow multiple buffers.")
2119 (defun org-agenda-mode ()
2120 "Mode for time-sorted view on action items in Org-mode files.
2122 The following commands are available:
2124 \\{org-agenda-mode-map}"
2125 (interactive)
2126 (cond (org-agenda-doing-sticky-redo
2127 ;; Refreshing sticky agenda-buffer
2129 ;; Preserve the value of `org-agenda-local-vars' variables,
2130 ;; while letting `kill-all-local-variables' kill the rest
2131 (let ((save (buffer-local-variables)))
2132 (kill-all-local-variables)
2133 (mapc 'make-local-variable org-agenda-local-vars)
2134 (dolist (elem save)
2135 (let ((var (car elem))
2136 (val (cdr elem)))
2137 (when (and val
2138 (member var org-agenda-local-vars))
2139 (set var val)))))
2140 (setq-local org-agenda-this-buffer-is-sticky t))
2141 (org-agenda-sticky
2142 ;; Creating a sticky Agenda buffer for the first time
2143 (kill-all-local-variables)
2144 (mapc 'make-local-variable org-agenda-local-vars)
2145 (setq-local org-agenda-this-buffer-is-sticky t))
2147 ;; Creating a non-sticky agenda buffer
2148 (kill-all-local-variables)
2149 (setq-local org-agenda-this-buffer-is-sticky nil)))
2150 (setq org-agenda-undo-list nil
2151 org-agenda-pending-undo-list nil
2152 org-agenda-bulk-marked-entries nil)
2153 (setq major-mode 'org-agenda-mode)
2154 ;; Keep global-font-lock-mode from turning on font-lock-mode
2155 (setq-local font-lock-global-modes (list 'not major-mode))
2156 (setq mode-name "Org-Agenda")
2157 (setq indent-tabs-mode nil)
2158 (use-local-map org-agenda-mode-map)
2159 (easy-menu-add org-agenda-menu)
2160 (if org-startup-truncated (setq truncate-lines t))
2161 (setq-local line-move-visual nil)
2162 (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
2163 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
2164 ;; Make sure properties are removed when copying text
2165 (org-add-hook 'filter-buffer-substring-functions
2166 (lambda (fun start end delete)
2167 (substring-no-properties (funcall fun start end delete)))
2168 nil t)
2169 (unless org-agenda-keep-modes
2170 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2171 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
2172 (setq org-agenda-show-log org-agenda-start-with-log-mode)
2173 (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
2174 (add-to-invisibility-spec '(org-filtered))
2175 (add-to-invisibility-spec '(org-link))
2176 (easy-menu-change
2177 '("Agenda") "Agenda Files"
2178 (append
2179 (list
2180 (vector
2181 (if (get 'org-agenda-files 'org-restrict)
2182 "Restricted to single file"
2183 "Edit File List")
2184 '(org-edit-agenda-file-list)
2185 (not (get 'org-agenda-files 'org-restrict)))
2186 "--")
2187 (mapcar 'org-file-menu-entry (org-agenda-files))))
2188 (org-agenda-set-mode-name)
2189 (apply
2190 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
2191 (list 'org-agenda-mode-hook)))
2193 (substitute-key-definition 'undo 'org-agenda-undo
2194 org-agenda-mode-map global-map)
2195 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
2196 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
2197 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
2198 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
2199 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2200 (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
2201 (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
2202 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2203 (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
2204 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2205 (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
2206 (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
2207 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2208 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2209 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2210 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2211 (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
2212 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2213 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2214 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2215 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2216 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2217 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2218 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2219 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2220 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2221 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2222 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2223 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2224 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2225 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2226 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2227 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2228 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2229 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2230 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2231 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2232 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2233 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2234 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2235 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2236 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2237 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2238 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2239 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2240 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2241 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2242 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2243 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2244 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2246 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2247 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2248 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2249 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2250 (while l (org-defkey org-agenda-mode-map
2251 (int-to-string (pop l)) 'digit-argument)))
2253 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2254 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2255 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2256 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2257 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2258 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2259 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2260 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2261 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2262 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2263 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2264 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2265 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2266 'org-clock-modify-effort-estimate)
2267 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2268 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2269 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2270 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2271 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2272 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2273 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2274 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2275 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2276 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2277 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2278 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2279 (substitute-key-definition 'next-line 'org-agenda-next-line
2280 org-agenda-mode-map global-map)
2281 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2282 org-agenda-mode-map global-map)
2283 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2284 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2285 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2286 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2287 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2288 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2289 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2290 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2291 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2292 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2293 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2294 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2295 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2296 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2297 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2298 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2299 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2300 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2301 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2302 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2303 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2304 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2305 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2306 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2307 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2308 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2309 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2310 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2311 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2312 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2314 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2315 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2316 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2317 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2318 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2319 (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
2320 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2321 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2322 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2323 (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
2324 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2325 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
2326 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2327 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2328 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2329 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2331 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2332 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2334 (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
2335 (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
2337 (when org-agenda-mouse-1-follows-link
2338 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2339 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2340 '("Agenda"
2341 ("Agenda Files")
2342 "--"
2343 ("Agenda Dates"
2344 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2345 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2346 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2347 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2348 "--"
2349 ("View"
2350 ["Day View" org-agenda-day-view
2351 :active (org-agenda-check-type nil 'agenda)
2352 :style radio :selected (eq org-agenda-current-span 'day)
2353 :keys "v d (or just d)"]
2354 ["Week View" org-agenda-week-view
2355 :active (org-agenda-check-type nil 'agenda)
2356 :style radio :selected (eq org-agenda-current-span 'week)
2357 :keys "v w"]
2358 ["Fortnight View" org-agenda-fortnight-view
2359 :active (org-agenda-check-type nil 'agenda)
2360 :style radio :selected (eq org-agenda-current-span 'fortnight)
2361 :keys "v f"]
2362 ["Month View" org-agenda-month-view
2363 :active (org-agenda-check-type nil 'agenda)
2364 :style radio :selected (eq org-agenda-current-span 'month)
2365 :keys "v m"]
2366 ["Year View" org-agenda-year-view
2367 :active (org-agenda-check-type nil 'agenda)
2368 :style radio :selected (eq org-agenda-current-span 'year)
2369 :keys "v y"]
2370 "--"
2371 ["Include Diary" org-agenda-toggle-diary
2372 :style toggle :selected org-agenda-include-diary
2373 :active (org-agenda-check-type nil 'agenda)]
2374 ["Include Deadlines" org-agenda-toggle-deadlines
2375 :style toggle :selected org-agenda-include-deadlines
2376 :active (org-agenda-check-type nil 'agenda)]
2377 ["Use Time Grid" org-agenda-toggle-time-grid
2378 :style toggle :selected org-agenda-use-time-grid
2379 :active (org-agenda-check-type nil 'agenda)]
2380 "--"
2381 ["Show clock report" org-agenda-clockreport-mode
2382 :style toggle :selected org-agenda-clockreport-mode
2383 :active (org-agenda-check-type nil 'agenda)]
2384 ["Show some entry text" org-agenda-entry-text-mode
2385 :style toggle :selected org-agenda-entry-text-mode
2386 :active t]
2387 "--"
2388 ["Show Logbook entries" org-agenda-log-mode
2389 :style toggle :selected org-agenda-show-log
2390 :active (org-agenda-check-type nil 'agenda 'timeline)
2391 :keys "v l (or just l)"]
2392 ["Include archived trees" org-agenda-archives-mode
2393 :style toggle :selected org-agenda-archives-mode :active t
2394 :keys "v a"]
2395 ["Include archive files" (org-agenda-archives-mode t)
2396 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2397 :keys "v A"]
2398 "--"
2399 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2400 ["Write view to file" org-agenda-write t]
2401 ["Rebuild buffer" org-agenda-redo t]
2402 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2403 "--"
2404 ["Show original entry" org-agenda-show t]
2405 ["Go To (other window)" org-agenda-goto t]
2406 ["Go To (this window)" org-agenda-switch-to t]
2407 ["Capture with cursor date" org-agenda-capture t]
2408 ["Follow Mode" org-agenda-follow-mode
2409 :style toggle :selected org-agenda-follow-mode :active t]
2410 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2411 "--"
2412 ("TODO"
2413 ["Cycle TODO" org-agenda-todo t]
2414 ["Next TODO set" org-agenda-todo-nextset t]
2415 ["Previous TODO set" org-agenda-todo-previousset t]
2416 ["Add note" org-agenda-add-note t])
2417 ("Archive/Refile/Delete"
2418 ["Archive default" org-agenda-archive-default t]
2419 ["Archive default" org-agenda-archive-default-with-confirmation t]
2420 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2421 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2422 ["Archive subtree" org-agenda-archive t]
2423 "--"
2424 ["Refile" org-agenda-refile t]
2425 "--"
2426 ["Delete subtree" org-agenda-kill t])
2427 ("Bulk action"
2428 ["Mark entry" org-agenda-bulk-mark t]
2429 ["Mark all" org-agenda-bulk-mark-all t]
2430 ["Unmark entry" org-agenda-bulk-unmark t]
2431 ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
2432 ["Toggle mark" org-agenda-bulk-toggle t]
2433 ["Toggle all" org-agenda-bulk-toggle-all t]
2434 ["Mark regexp" org-agenda-bulk-mark-regexp t])
2435 ["Act on all marked" org-agenda-bulk-action t]
2436 "--"
2437 ("Tags and Properties"
2438 ["Show all Tags" org-agenda-show-tags t]
2439 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2440 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2441 "--"
2442 ["Column View" org-columns t])
2443 ("Deadline/Schedule"
2444 ["Schedule" org-agenda-schedule t]
2445 ["Set Deadline" org-agenda-deadline t]
2446 "--"
2447 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2448 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2449 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2450 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2451 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2452 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2453 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2454 ("Clock and Effort"
2455 ["Clock in" org-agenda-clock-in t]
2456 ["Clock out" org-agenda-clock-out t]
2457 ["Clock cancel" org-agenda-clock-cancel t]
2458 ["Goto running clock" org-clock-goto t]
2459 "--"
2460 ["Set Effort" org-agenda-set-effort t]
2461 ["Change clocked effort" org-clock-modify-effort-estimate
2462 (org-clock-is-active)])
2463 ("Priority"
2464 ["Set Priority" org-agenda-priority t]
2465 ["Increase Priority" org-agenda-priority-up t]
2466 ["Decrease Priority" org-agenda-priority-down t]
2467 ["Show Priority" org-show-priority t])
2468 ("Calendar/Diary"
2469 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2470 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2471 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2472 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2473 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2474 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2475 "--"
2476 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2477 "--"
2478 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2479 "--"
2480 ("MobileOrg"
2481 ["Push Files and Views" org-mobile-push t]
2482 ["Get Captured and Flagged" org-mobile-pull t]
2483 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2484 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2485 "--"
2486 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2487 "--"
2488 ["Quit" org-agenda-quit t]
2489 ["Exit and Release Buffers" org-agenda-exit t]
2492 ;;; Agenda undo
2494 (defvar org-agenda-allow-remote-undo t
2495 "Non-nil means allow remote undo from the agenda buffer.")
2496 (defvar org-agenda-undo-has-started-in nil
2497 "Buffers that have already seen `undo-start' in the current undo sequence.")
2499 (defun org-agenda-undo ()
2500 "Undo a remote editing step in the agenda.
2501 This undoes changes both in the agenda buffer and in the remote buffer
2502 that have been changed along."
2503 (interactive)
2504 (or org-agenda-allow-remote-undo
2505 (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2506 (if (not (eq this-command last-command))
2507 (setq org-agenda-undo-has-started-in nil
2508 org-agenda-pending-undo-list org-agenda-undo-list))
2509 (if (not org-agenda-pending-undo-list)
2510 (user-error "No further undo information"))
2511 (let* ((entry (pop org-agenda-pending-undo-list))
2512 buf line cmd rembuf)
2513 (setq cmd (pop entry) line (pop entry))
2514 (setq rembuf (nth 2 entry))
2515 (org-with-remote-undo rembuf
2516 (while (bufferp (setq buf (pop entry)))
2517 (if (pop entry)
2518 (with-current-buffer buf
2519 (let ((last-undo-buffer buf)
2520 (inhibit-read-only t))
2521 (unless (memq buf org-agenda-undo-has-started-in)
2522 (push buf org-agenda-undo-has-started-in)
2523 (make-local-variable 'pending-undo-list)
2524 (undo-start))
2525 (while (and pending-undo-list
2526 (listp pending-undo-list)
2527 (not (car pending-undo-list)))
2528 (pop pending-undo-list))
2529 (undo-more 1))))))
2530 (org-goto-line line)
2531 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2533 (defun org-verify-change-for-undo (l1 l2)
2534 "Verify that a real change occurred between the undo lists L1 and L2."
2535 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2536 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2537 (not (eq l1 l2)))
2539 ;;; Agenda dispatch
2541 (defvar org-agenda-restrict-begin (make-marker))
2542 (defvar org-agenda-restrict-end (make-marker))
2543 (defvar org-agenda-last-dispatch-buffer nil)
2544 (defvar org-agenda-overriding-restriction nil)
2546 (defcustom org-agenda-custom-commands-contexts nil
2547 "Alist of custom agenda keys and contextual rules.
2549 For example, if you have a custom agenda command \"p\" and you
2550 want this command to be accessible only from plain text files,
2551 use this:
2553 \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
2555 Here are the available contexts definitions:
2557 in-file: command displayed only in matching files
2558 in-mode: command displayed only in matching modes
2559 not-in-file: command not displayed in matching files
2560 not-in-mode: command not displayed in matching modes
2561 in-buffer: command displayed only in matching buffers
2562 not-in-buffer: command not displayed in matching buffers
2563 [function]: a custom function taking no argument
2565 If you define several checks, the agenda command will be
2566 accessible if there is at least one valid check.
2568 You can also bind a key to another agenda custom command
2569 depending on contextual rules.
2571 \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
2573 Here it means: in .txt files, use \"p\" as the key for the
2574 agenda command otherwise associated with \"q\". (The command
2575 originally associated with \"q\" is not displayed to avoid
2576 duplicates.)"
2577 :version "24.3"
2578 :group 'org-agenda-custom-commands
2579 :type '(repeat (list :tag "Rule"
2580 (string :tag " Agenda key")
2581 (string :tag "Replace by command")
2582 (repeat :tag "Available when"
2583 (choice
2584 (cons :tag "Condition"
2585 (choice
2586 (const :tag "In file" in-file)
2587 (const :tag "Not in file" not-in-file)
2588 (const :tag "In buffer" in-buffer)
2589 (const :tag "Not in buffer" not-in-buffer)
2590 (const :tag "In mode" in-mode)
2591 (const :tag "Not in mode" not-in-mode))
2592 (regexp))
2593 (function :tag "Custom function"))))))
2595 (defcustom org-agenda-max-entries nil
2596 "Maximum number of entries to display in an agenda.
2597 This can be nil (no limit) or an integer or an alist of agenda
2598 types with an associated number of entries to display in this
2599 type."
2600 :version "24.4"
2601 :package-version '(Org . "8.0")
2602 :group 'org-agenda-custom-commands
2603 :type '(choice (symbol :tag "No limit" nil)
2604 (integer :tag "Max number of entries")
2605 (repeat
2606 (cons (choice :tag "Agenda type"
2607 (const agenda)
2608 (const todo)
2609 (const tags)
2610 (const search)
2611 (const timeline))
2612 (integer :tag "Max number of entries")))))
2614 (defcustom org-agenda-max-todos nil
2615 "Maximum number of TODOs to display in an agenda.
2616 This can be nil (no limit) or an integer or an alist of agenda
2617 types with an associated number of entries to display in this
2618 type."
2619 :version "24.4"
2620 :package-version '(Org . "8.0")
2621 :group 'org-agenda-custom-commands
2622 :type '(choice (symbol :tag "No limit" nil)
2623 (integer :tag "Max number of TODOs")
2624 (repeat
2625 (cons (choice :tag "Agenda type"
2626 (const agenda)
2627 (const todo)
2628 (const tags)
2629 (const search)
2630 (const timeline))
2631 (integer :tag "Max number of TODOs")))))
2633 (defcustom org-agenda-max-tags nil
2634 "Maximum number of tagged entries to display in an agenda.
2635 This can be nil (no limit) or an integer or an alist of agenda
2636 types with an associated number of entries to display in this
2637 type."
2638 :version "24.4"
2639 :package-version '(Org . "8.0")
2640 :group 'org-agenda-custom-commands
2641 :type '(choice (symbol :tag "No limit" nil)
2642 (integer :tag "Max number of tagged entries")
2643 (repeat
2644 (cons (choice :tag "Agenda type"
2645 (const agenda)
2646 (const todo)
2647 (const tags)
2648 (const search)
2649 (const timeline))
2650 (integer :tag "Max number of tagged entries")))))
2652 (defcustom org-agenda-max-effort nil
2653 "Maximum cumulated effort duration for the agenda.
2654 This can be nil (no limit) or a number of minutes (as an integer)
2655 or an alist of agenda types with an associated number of minutes
2656 to limit entries to in this type."
2657 :version "24.4"
2658 :package-version '(Org . "8.0")
2659 :group 'org-agenda-custom-commands
2660 :type '(choice (symbol :tag "No limit" nil)
2661 (integer :tag "Max number of minutes")
2662 (repeat
2663 (cons (choice :tag "Agenda type"
2664 (const agenda)
2665 (const todo)
2666 (const tags)
2667 (const search)
2668 (const timeline))
2669 (integer :tag "Max number of minutes")))))
2671 (defvar org-keys nil)
2672 (defvar org-match nil)
2673 ;;;###autoload
2674 (defun org-agenda (&optional arg org-keys restriction)
2675 "Dispatch agenda commands to collect entries to the agenda buffer.
2676 Prompts for a command to execute. Any prefix arg will be passed
2677 on to the selected command. The default selections are:
2679 a Call `org-agenda-list' to display the agenda for current day or week.
2680 t Call `org-todo-list' to display the global todo list.
2681 T Call `org-todo-list' to display the global todo list, select only
2682 entries with a specific TODO keyword (the user gets a prompt).
2683 m Call `org-tags-view' to display headlines with tags matching
2684 a condition (the user is prompted for the condition).
2685 M Like `m', but select only TODO entries, no ordinary headlines.
2686 L Create a timeline for the current buffer.
2687 e Export views to associated files.
2688 s Search entries for keywords.
2689 S Search entries for keywords, only with TODO keywords.
2690 / Multi occur across all agenda files and also files listed
2691 in `org-agenda-text-search-extra-files'.
2692 < Restrict agenda commands to buffer, subtree, or region.
2693 Press several times to get the desired effect.
2694 > Remove a previous restriction.
2695 # List \"stuck\" projects.
2696 ! Configure what \"stuck\" means.
2697 C Configure custom agenda commands.
2699 More commands can be added by configuring the variable
2700 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2701 searches can be pre-defined in this way.
2703 If the current buffer is in Org-mode and visiting a file, you can also
2704 first press `<' once to indicate that the agenda should be temporarily
2705 \(until the next use of \\[org-agenda]) restricted to the current file.
2706 Pressing `<' twice means to restrict to the current subtree or region
2707 \(if active)."
2708 (interactive "P")
2709 (catch 'exit
2710 (let* ((prefix-descriptions nil)
2711 (org-agenda-buffer-name org-agenda-buffer-name)
2712 (org-agenda-window-setup (if (equal (buffer-name)
2713 org-agenda-buffer-name)
2714 'current-window
2715 org-agenda-window-setup))
2716 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2717 (org-agenda-custom-commands
2718 ;; normalize different versions
2719 (delq nil
2720 (mapcar
2721 (lambda (x)
2722 (cond ((stringp (cdr x))
2723 (push x prefix-descriptions)
2724 nil)
2725 ((stringp (nth 1 x)) x)
2726 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2727 (t (cons (car x) (cons "" (cdr x))))))
2728 org-agenda-custom-commands)))
2729 (org-agenda-custom-commands
2730 (org-contextualize-keys
2731 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2732 (buf (current-buffer))
2733 (bfn (buffer-file-name (buffer-base-buffer)))
2734 entry key type org-match lprops ans)
2735 ;; Turn off restriction unless there is an overriding one,
2736 (unless org-agenda-overriding-restriction
2737 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2738 ;; There is a request to keep the file list in place
2739 (put 'org-agenda-files 'org-restrict nil))
2740 (setq org-agenda-restrict nil)
2741 (move-marker org-agenda-restrict-begin nil)
2742 (move-marker org-agenda-restrict-end nil))
2743 ;; Delete old local properties
2744 (put 'org-agenda-redo-command 'org-lprops nil)
2745 ;; Delete previously set last-arguments
2746 (put 'org-agenda-redo-command 'last-args nil)
2747 ;; Remember where this call originated
2748 (setq org-agenda-last-dispatch-buffer (current-buffer))
2749 (unless org-keys
2750 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2751 org-keys (car ans)
2752 restriction (cdr ans)))
2753 ;; If we have sticky agenda buffers, set a name for the buffer,
2754 ;; depending on the invoking keys. The user may still set this
2755 ;; as a command option, which will overwrite what we do here.
2756 (if org-agenda-sticky
2757 (setq org-agenda-buffer-name
2758 (format "*Org Agenda(%s)*" org-keys)))
2759 ;; Establish the restriction, if any
2760 (when (and (not org-agenda-overriding-restriction) restriction)
2761 (put 'org-agenda-files 'org-restrict (list bfn))
2762 (cond
2763 ((eq restriction 'region)
2764 (setq org-agenda-restrict (current-buffer))
2765 (move-marker org-agenda-restrict-begin (region-beginning))
2766 (move-marker org-agenda-restrict-end (region-end)))
2767 ((eq restriction 'subtree)
2768 (save-excursion
2769 (setq org-agenda-restrict (current-buffer))
2770 (org-back-to-heading t)
2771 (move-marker org-agenda-restrict-begin (point))
2772 (move-marker org-agenda-restrict-end
2773 (progn (org-end-of-subtree t)))))))
2775 ;; For example the todo list should not need it (but does...)
2776 (cond
2777 ((setq entry (assoc org-keys org-agenda-custom-commands))
2778 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2779 (progn
2780 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2781 lprops (nth 4 entry))
2782 (if org-agenda-sticky
2783 (setq org-agenda-buffer-name
2784 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2785 (format "*Org Agenda(%s)*" org-keys))))
2786 (put 'org-agenda-redo-command 'org-lprops lprops)
2787 (cond
2788 ((eq type 'agenda)
2789 (org-let lprops '(org-agenda-list current-prefix-arg)))
2790 ((eq type 'agenda*)
2791 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2792 ((eq type 'alltodo)
2793 (org-let lprops '(org-todo-list current-prefix-arg)))
2794 ((eq type 'search)
2795 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2796 ((eq type 'stuck)
2797 (org-let lprops '(org-agenda-list-stuck-projects
2798 current-prefix-arg)))
2799 ((eq type 'tags)
2800 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2801 ((eq type 'tags-todo)
2802 (org-let lprops '(org-tags-view '(4) org-match)))
2803 ((eq type 'todo)
2804 (org-let lprops '(org-todo-list org-match)))
2805 ((eq type 'tags-tree)
2806 (org-check-for-org-mode)
2807 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2808 ((eq type 'todo-tree)
2809 (org-check-for-org-mode)
2810 (org-let lprops
2811 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2812 (regexp-quote org-match) "\\>"))))
2813 ((eq type 'occur-tree)
2814 (org-check-for-org-mode)
2815 (org-let lprops '(org-occur org-match)))
2816 ((functionp type)
2817 (org-let lprops '(funcall type org-match)))
2818 ((fboundp type)
2819 (org-let lprops '(funcall type org-match)))
2820 (t (user-error "Invalid custom agenda command type %s" type))))
2821 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2822 ((equal org-keys "C")
2823 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2824 (customize-variable 'org-agenda-custom-commands))
2825 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2826 ((equal org-keys "s") (call-interactively 'org-search-view))
2827 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2828 ((equal org-keys "t") (call-interactively 'org-todo-list))
2829 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2830 ((equal org-keys "m") (call-interactively 'org-tags-view))
2831 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2832 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2833 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2834 (org-add-hook
2835 'post-command-hook
2836 (lambda ()
2837 (unless (current-message)
2838 (let* ((m (org-agenda-get-any-marker))
2839 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2840 (when note
2841 (message (concat
2842 "FLAGGING-NOTE ([?] for more info): "
2843 (org-add-props
2844 (replace-regexp-in-string
2845 "\\\\n" "//"
2846 (copy-sequence note))
2847 nil 'face 'org-warning)))))))
2848 t t))
2849 ((equal org-keys "L")
2850 (unless (derived-mode-p 'org-mode)
2851 (user-error "This is not an Org-mode file"))
2852 (unless restriction
2853 (put 'org-agenda-files 'org-restrict (list bfn))
2854 (org-call-with-arg 'org-timeline arg)))
2855 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2856 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2857 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2858 (t (user-error "Invalid agenda key"))))))
2860 (defvar org-agenda-multi)
2862 (defun org-agenda-append-agenda ()
2863 "Append another agenda view to the current one.
2864 This function allows interactive building of block agendas.
2865 Agenda views are separated by `org-agenda-block-separator'."
2866 (interactive)
2867 (unless (derived-mode-p 'org-agenda-mode)
2868 (user-error "Can only append from within agenda buffer"))
2869 (let ((org-agenda-multi t))
2870 (org-agenda)
2871 (widen)
2872 (org-agenda-finalize)
2873 (setq buffer-read-only t)
2874 (org-agenda-fit-window-to-buffer)))
2876 (defun org-agenda-normalize-custom-commands (cmds)
2877 "Normalize custom commands CMDS."
2878 (delq nil
2879 (mapcar
2880 (lambda (x)
2881 (cond ((stringp (cdr x)) nil)
2882 ((stringp (nth 1 x)) x)
2883 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2884 (t (cons (car x) (cons "" (cdr x))))))
2885 cmds)))
2887 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2888 "The user interface for selecting an agenda command."
2889 (catch 'exit
2890 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2891 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2892 (region-p (org-region-active-p))
2893 (custom org-agenda-custom-commands)
2894 (selstring "")
2895 restriction second-time
2896 c entry key type match prefixes rmheader header-end custom1 desc
2897 line lines left right n n1)
2898 (save-window-excursion
2899 (delete-other-windows)
2900 (org-switch-to-buffer-other-window " *Agenda Commands*")
2901 (erase-buffer)
2902 (insert (eval-when-compile
2903 (let ((header
2904 "Press key for an agenda command: < Buffer, subtree/region restriction
2905 -------------------------------- > Remove restriction
2906 a Agenda for current week or day e Export agenda views
2907 t List of all TODO entries T Entries with special TODO kwd
2908 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2909 s Search for keywords S Like s, but only TODO entries
2910 L Timeline for current buffer # List stuck projects (!=configure)
2911 / Multi-occur C Configure custom agenda commands
2912 ? Find :FLAGGED: entries * Toggle sticky agenda views
2914 (start 0))
2915 (while (string-match
2916 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2917 header start)
2918 (setq start (match-end 0))
2919 (add-text-properties (match-beginning 2) (match-end 2)
2920 '(face bold) header))
2921 header)))
2922 (setq header-end (point-marker))
2923 (while t
2924 (setq custom1 custom)
2925 (when (eq rmheader t)
2926 (org-goto-line 1)
2927 (re-search-forward ":" nil t)
2928 (delete-region (match-end 0) (point-at-eol))
2929 (forward-char 1)
2930 (looking-at "-+")
2931 (delete-region (match-end 0) (point-at-eol))
2932 (move-marker header-end (match-end 0)))
2933 (goto-char header-end)
2934 (delete-region (point) (point-max))
2936 ;; Produce all the lines that describe custom commands and prefixes
2937 (setq lines nil)
2938 (while (setq entry (pop custom1))
2939 (setq key (car entry) desc (nth 1 entry)
2940 type (nth 2 entry)
2941 match (nth 3 entry))
2942 (if (> (length key) 1)
2943 (add-to-list 'prefixes (string-to-char key))
2944 (setq line
2945 (format
2946 "%-4s%-14s"
2947 (org-add-props (copy-sequence key)
2948 '(face bold))
2949 (cond
2950 ((string-match "\\S-" desc) desc)
2951 ((eq type 'agenda) "Agenda for current week or day")
2952 ((eq type 'agenda*) "Appointments for current week or day")
2953 ((eq type 'alltodo) "List of all TODO entries")
2954 ((eq type 'search) "Word search")
2955 ((eq type 'stuck) "List of stuck projects")
2956 ((eq type 'todo) "TODO keyword")
2957 ((eq type 'tags) "Tags query")
2958 ((eq type 'tags-todo) "Tags (TODO)")
2959 ((eq type 'tags-tree) "Tags tree")
2960 ((eq type 'todo-tree) "TODO kwd tree")
2961 ((eq type 'occur-tree) "Occur tree")
2962 ((functionp type) (if (symbolp type)
2963 (symbol-name type)
2964 "Lambda expression"))
2965 (t "???"))))
2966 (if org-agenda-menu-show-matcher
2967 (setq line
2968 (concat line ": "
2969 (cond
2970 ((stringp match)
2971 (setq match (copy-sequence match))
2972 (org-add-props match nil 'face 'org-warning))
2973 ((listp type)
2974 (format "set of %d commands" (length type))))))
2975 (if (org-string-nw-p match)
2976 (add-text-properties
2977 0 (length line) (list 'help-echo
2978 (concat "Matcher: " match)) line)))
2979 (push line lines)))
2980 (setq lines (nreverse lines))
2981 (when prefixes
2982 (mapc (lambda (x)
2983 (push
2984 (format "%s %s"
2985 (org-add-props (char-to-string x)
2986 nil 'face 'bold)
2987 (or (cdr (assoc (concat selstring
2988 (char-to-string x))
2989 prefix-descriptions))
2990 "Prefix key"))
2991 lines))
2992 prefixes))
2994 ;; Check if we should display in two columns
2995 (if org-agenda-menu-two-columns
2996 (progn
2997 (setq n (length lines)
2998 n1 (+ (/ n 2) (mod n 2))
2999 right (nthcdr n1 lines)
3000 left (copy-sequence lines))
3001 (setcdr (nthcdr (1- n1) left) nil))
3002 (setq left lines right nil))
3003 (while left
3004 (insert "\n" (pop left))
3005 (when right
3006 (if (< (current-column) 40)
3007 (move-to-column 40 t)
3008 (insert " "))
3009 (insert (pop right))))
3011 ;; Make the window the right size
3012 (goto-char (point-min))
3013 (if second-time
3014 (if (not (pos-visible-in-window-p (point-max)))
3015 (org-fit-window-to-buffer))
3016 (setq second-time t)
3017 (org-fit-window-to-buffer))
3019 ;; Ask for selection
3020 (message "Press key for agenda command%s:"
3021 (if (or restrict-ok org-agenda-overriding-restriction)
3022 (if org-agenda-overriding-restriction
3023 " (restriction lock active)"
3024 (if restriction
3025 (format " (restricted to %s)" restriction)
3026 " (unrestricted)"))
3027 ""))
3028 (setq c (read-char-exclusive))
3029 (message "")
3030 (cond
3031 ((assoc (char-to-string c) custom)
3032 (setq selstring (concat selstring (char-to-string c)))
3033 (throw 'exit (cons selstring restriction)))
3034 ((memq c prefixes)
3035 (setq selstring (concat selstring (char-to-string c))
3036 prefixes nil
3037 rmheader (or rmheader t)
3038 custom (delq nil (mapcar
3039 (lambda (x)
3040 (if (or (= (length (car x)) 1)
3041 (/= (string-to-char (car x)) c))
3043 (cons (substring (car x) 1) (cdr x))))
3044 custom))))
3045 ((eq c ?*)
3046 (call-interactively 'org-toggle-sticky-agenda)
3047 (sit-for 2))
3048 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3049 (message "Restriction is only possible in Org-mode buffers")
3050 (ding) (sit-for 1))
3051 ((eq c ?1)
3052 (org-agenda-remove-restriction-lock 'noupdate)
3053 (setq restriction 'buffer))
3054 ((eq c ?0)
3055 (org-agenda-remove-restriction-lock 'noupdate)
3056 (setq restriction (if region-p 'region 'subtree)))
3057 ((eq c ?<)
3058 (org-agenda-remove-restriction-lock 'noupdate)
3059 (setq restriction
3060 (cond
3061 ((eq restriction 'buffer)
3062 (if region-p 'region 'subtree))
3063 ((memq restriction '(subtree region))
3064 nil)
3065 (t 'buffer))))
3066 ((eq c ?>)
3067 (org-agenda-remove-restriction-lock 'noupdate)
3068 (setq restriction nil))
3069 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3070 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3071 ((and (> (length selstring) 0) (eq c ?\d))
3072 (delete-window)
3073 (org-agenda-get-restriction-and-command prefix-descriptions))
3075 ((equal c ?q) (error "Abort"))
3076 (t (user-error "Invalid key %c" c))))))))
3078 (defun org-agenda-fit-window-to-buffer ()
3079 "Fit the window to the buffer size."
3080 (and (memq org-agenda-window-setup '(reorganize-frame))
3081 (fboundp 'fit-window-to-buffer)
3082 (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
3083 (= (car org-agenda-window-frame-fractions) 1.0))
3084 (delete-other-windows)
3085 (org-fit-window-to-buffer
3087 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3088 (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
3090 (defvar org-cmd nil)
3091 (defvar org-agenda-overriding-cmd nil)
3092 (defvar org-agenda-overriding-arguments nil)
3093 (defvar org-agenda-overriding-cmd-arguments nil)
3094 (defun org-agenda-run-series (name series)
3095 "Run agenda NAME as a SERIES of agenda commands."
3096 (org-let (nth 1 series) '(org-agenda-prepare name))
3097 ;; We need to reset agenda markers here, because when constructing a
3098 ;; block agenda, the individual blocks do not do that.
3099 (org-agenda-reset-markers)
3100 (let* ((org-agenda-multi t)
3101 (redo (list 'org-agenda-run-series name (list 'quote series)))
3102 (cmds (car series))
3103 (gprops (nth 1 series))
3104 match ;; The byte compiler incorrectly complains about this. Keep it!
3105 org-cmd type lprops)
3106 (while (setq org-cmd (pop cmds))
3107 (setq type (car org-cmd)
3108 match (eval (nth 1 org-cmd))
3109 lprops (nth 2 org-cmd))
3110 (let ((org-agenda-overriding-arguments
3111 (if (eq org-agenda-overriding-cmd org-cmd)
3112 (or org-agenda-overriding-arguments
3113 org-agenda-overriding-cmd-arguments))))
3114 (cond
3115 ((eq type 'agenda)
3116 (org-let2 gprops lprops
3117 '(call-interactively 'org-agenda-list)))
3118 ((eq type 'agenda*)
3119 (org-let2 gprops lprops
3120 '(funcall 'org-agenda-list nil nil t)))
3121 ((eq type 'alltodo)
3122 (org-let2 gprops lprops
3123 '(call-interactively 'org-todo-list)))
3124 ((eq type 'search)
3125 (org-let2 gprops lprops
3126 '(org-search-view current-prefix-arg match nil)))
3127 ((eq type 'stuck)
3128 (org-let2 gprops lprops
3129 '(call-interactively 'org-agenda-list-stuck-projects)))
3130 ((eq type 'tags)
3131 (org-let2 gprops lprops
3132 '(org-tags-view current-prefix-arg match)))
3133 ((eq type 'tags-todo)
3134 (org-let2 gprops lprops
3135 '(org-tags-view '(4) match)))
3136 ((eq type 'todo)
3137 (org-let2 gprops lprops
3138 '(org-todo-list match)))
3139 ((fboundp type)
3140 (org-let2 gprops lprops
3141 '(funcall type match)))
3142 (t (error "Invalid type in command series")))))
3143 (widen)
3144 (let ((inhibit-read-only t))
3145 (add-text-properties (point-min) (point-max)
3146 `(org-series t org-series-redo-cmd ,redo)))
3147 (setq org-agenda-redo-command redo)
3148 (goto-char (point-min)))
3149 (org-agenda-fit-window-to-buffer)
3150 (org-let (nth 1 series) '(org-agenda-finalize)))
3152 ;;;###autoload
3153 (defmacro org-batch-agenda (cmd-key &rest parameters)
3154 "Run an agenda command in batch mode and send the result to STDOUT.
3155 If CMD-KEY is a string of length 1, it is used as a key in
3156 `org-agenda-custom-commands' and triggers this command. If it is a
3157 longer string it is used as a tags/todo match string.
3158 Parameters are alternating variable names and values that will be bound
3159 before running the agenda command."
3160 (org-eval-in-environment (org-make-parameter-alist parameters)
3161 (let (org-agenda-sticky)
3162 (if (> (length cmd-key) 1)
3163 (org-tags-view nil cmd-key)
3164 (org-agenda nil cmd-key))))
3165 (set-buffer org-agenda-buffer-name)
3166 (princ (buffer-string)))
3168 (defvar org-agenda-info nil)
3170 ;;;###autoload
3171 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3172 "Run an agenda command in batch mode and send the result to STDOUT.
3173 If CMD-KEY is a string of length 1, it is used as a key in
3174 `org-agenda-custom-commands' and triggers this command. If it is a
3175 longer string it is used as a tags/todo match string.
3176 Parameters are alternating variable names and values that will be bound
3177 before running the agenda command.
3179 The output gives a line for each selected agenda item. Each
3180 item is a list of comma-separated values, like this:
3182 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3184 category The category of the item
3185 head The headline, without TODO kwd, TAGS and PRIORITY
3186 type The type of the agenda entry, can be
3187 todo selected in TODO match
3188 tagsmatch selected in tags match
3189 diary imported from diary
3190 deadline a deadline on given date
3191 scheduled scheduled on given date
3192 timestamp entry has timestamp on given date
3193 closed entry was closed on given date
3194 upcoming-deadline warning about deadline
3195 past-scheduled forwarded scheduled item
3196 block entry has date block including g. date
3197 todo The todo keyword, if any
3198 tags All tags including inherited ones, separated by colons
3199 date The relevant date, like 2007-2-14
3200 time The time, like 15:00-16:50
3201 extra Sting with extra planning info
3202 priority-l The priority letter if any was given
3203 priority-n The computed numerical priority
3204 agenda-day The day in the agenda where this is listed"
3205 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3206 (org-make-parameter-alist parameters))
3207 (if (> (length cmd-key) 2)
3208 (org-tags-view nil cmd-key)
3209 (org-agenda nil cmd-key)))
3210 (set-buffer org-agenda-buffer-name)
3211 (let* ((lines (org-split-string (buffer-string) "\n"))
3212 line)
3213 (while (setq line (pop lines))
3214 (catch 'next
3215 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3216 (setq org-agenda-info
3217 (org-fix-agenda-info (text-properties-at 0 line)))
3218 (princ
3219 (mapconcat 'org-agenda-export-csv-mapper
3220 '(org-category txt type todo tags date time extra
3221 priority-letter priority agenda-day)
3222 ","))
3223 (princ "\n")))))
3225 (defun org-fix-agenda-info (props)
3226 "Make sure all properties on an agenda item have a canonical form.
3227 This ensures the export commands can easily use it."
3228 (let (tmp re)
3229 (when (setq tmp (plist-get props 'tags))
3230 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3231 (when (setq tmp (plist-get props 'date))
3232 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3233 (let ((calendar-date-display-form '(year "-" month "-" day)))
3234 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3236 (setq tmp (calendar-date-string tmp)))
3237 (setq props (plist-put props 'date tmp)))
3238 (when (setq tmp (plist-get props 'day))
3239 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3240 (let ((calendar-date-display-form '(year "-" month "-" day)))
3241 (setq tmp (calendar-date-string tmp)))
3242 (setq props (plist-put props 'day tmp))
3243 (setq props (plist-put props 'agenda-day tmp)))
3244 (when (setq tmp (plist-get props 'txt))
3245 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3246 (plist-put props 'priority-letter (match-string 1 tmp))
3247 (setq tmp (replace-match "" t t tmp)))
3248 (when (and (setq re (plist-get props 'org-todo-regexp))
3249 (setq re (concat "\\`\\.*" re " ?"))
3250 (string-match re tmp))
3251 (plist-put props 'todo (match-string 1 tmp))
3252 (setq tmp (replace-match "" t t tmp)))
3253 (plist-put props 'txt tmp)))
3254 props)
3256 (defun org-agenda-export-csv-mapper (prop)
3257 (let ((res (plist-get org-agenda-info prop)))
3258 (setq res
3259 (cond
3260 ((not res) "")
3261 ((stringp res) res)
3262 (t (prin1-to-string res))))
3263 (while (string-match "," res)
3264 (setq res (replace-match ";" t t res)))
3265 (org-trim res)))
3267 ;;;###autoload
3268 (defun org-store-agenda-views (&rest parameters)
3269 "Store agenda views."
3270 (interactive)
3271 (eval (list 'org-batch-store-agenda-views)))
3273 ;;;###autoload
3274 (defmacro org-batch-store-agenda-views (&rest parameters)
3275 "Run all custom agenda commands that have a file argument."
3276 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3277 (pop-up-frames nil)
3278 (dir default-directory)
3279 (pars (org-make-parameter-alist parameters))
3280 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3281 (save-window-excursion
3282 (while cmds
3283 (setq cmd (pop cmds)
3284 thiscmdkey (car cmd)
3285 thiscmdcmd (cdr cmd)
3286 match (nth 2 thiscmdcmd)
3287 bufname (if org-agenda-sticky
3288 (or (and (stringp match)
3289 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3290 (format "*Org Agenda(%s)*" thiscmdkey))
3291 org-agenda-buffer-name)
3292 cmd-or-set (nth 2 cmd)
3293 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3294 files (nth (if (listp cmd-or-set) 4 5) cmd))
3295 (if (stringp files) (setq files (list files)))
3296 (when files
3297 (org-eval-in-environment (append org-agenda-exporter-settings
3298 opts pars)
3299 (org-agenda nil thiscmdkey))
3300 (set-buffer bufname)
3301 (while files
3302 (org-eval-in-environment (append org-agenda-exporter-settings
3303 opts pars)
3304 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3305 (and (get-buffer bufname)
3306 (kill-buffer bufname)))))))
3308 (defvar org-agenda-current-span nil
3309 "The current span used in the agenda view.") ; local variable in the agenda buffer
3310 (defun org-agenda-mark-header-line (pos)
3311 "Mark the line at POS as an agenda structure header."
3312 (save-excursion
3313 (goto-char pos)
3314 (put-text-property (point-at-bol) (point-at-eol)
3315 'org-agenda-structural-header t)
3316 (when org-agenda-title-append
3317 (put-text-property (point-at-bol) (point-at-eol)
3318 'org-agenda-title-append org-agenda-title-append))))
3320 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3321 (defvar org-agenda-write-buffer-name "Agenda View")
3322 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3323 "Write the current buffer (an agenda view) as a file.
3325 Depending on the extension of the file name, plain text (.txt),
3326 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3327 If the extension is .ics, translate visible agenda into iCalendar
3328 format. If the extension is .org, collect all subtrees
3329 corresponding to the agenda entries and add them in an .org file.
3331 With prefix argument OPEN, open the new file immediately. If
3332 NOSETTINGS is given, do not scope the settings of
3333 `org-agenda-exporter-settings' into the export commands. This is
3334 used when the settings have already been scoped and we do not
3335 wish to overrule other, higher priority settings. If
3336 AGENDA-BUFFER-NAME is provided, use this as the buffer name for
3337 the agenda to write."
3338 (interactive "FWrite agenda to file: \nP")
3339 (if (or (not (file-writable-p file))
3340 (and (file-exists-p file)
3341 (if (org-called-interactively-p 'any)
3342 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3343 (user-error "Cannot write agenda to file %s" file))
3344 (org-let (if nosettings nil org-agenda-exporter-settings)
3345 '(save-excursion
3346 (save-window-excursion
3347 (let ((bs (copy-sequence (buffer-string))) beg content)
3348 (with-temp-buffer
3349 (rename-buffer org-agenda-write-buffer-name t)
3350 (set-buffer-modified-p nil)
3351 (insert bs)
3352 (org-agenda-remove-marked-text 'invisible 'org-filtered)
3353 (run-hooks 'org-agenda-before-write-hook)
3354 (cond
3355 ((org-bound-and-true-p org-mobile-creating-agendas)
3356 (org-mobile-write-agenda-for-mobile file))
3357 ((string-match "\\.org\\'" file)
3358 (let (content p m message-log-max)
3359 (goto-char (point-min))
3360 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3361 (goto-char p)
3362 (setq m (get-text-property (point) 'org-hd-marker))
3363 (when m
3364 (push (save-excursion
3365 (set-buffer (marker-buffer m))
3366 (goto-char m)
3367 (org-copy-subtree 1 nil t t)
3368 org-subtree-clip)
3369 content)))
3370 (find-file file)
3371 (erase-buffer)
3372 (dolist (s content) (org-paste-subtree 1 s))
3373 (write-file file)
3374 (kill-buffer (current-buffer))
3375 (message "Org file written to %s" file)))
3376 ((string-match "\\.html?\\'" file)
3377 (require 'htmlize)
3378 (set-buffer (htmlize-buffer (current-buffer)))
3379 (when org-agenda-export-html-style
3380 ;; replace <style> section with org-agenda-export-html-style
3381 (goto-char (point-min))
3382 (kill-region (- (search-forward "<style") 6)
3383 (search-forward "</style>"))
3384 (insert org-agenda-export-html-style))
3385 (write-file file)
3386 (kill-buffer (current-buffer))
3387 (message "HTML written to %s" file))
3388 ((string-match "\\.ps\\'" file)
3389 (require 'ps-print)
3390 (ps-print-buffer-with-faces file)
3391 (message "Postscript written to %s" file))
3392 ((string-match "\\.pdf\\'" file)
3393 (require 'ps-print)
3394 (ps-print-buffer-with-faces
3395 (concat (file-name-sans-extension file) ".ps"))
3396 (call-process "ps2pdf" nil nil nil
3397 (expand-file-name
3398 (concat (file-name-sans-extension file) ".ps"))
3399 (expand-file-name file))
3400 (delete-file (concat (file-name-sans-extension file) ".ps"))
3401 (message "PDF written to %s" file))
3402 ((string-match "\\.ics\\'" file)
3403 (require 'ox-icalendar)
3404 (org-icalendar-export-current-agenda (expand-file-name file)))
3406 (let ((bs (buffer-string)))
3407 (find-file file)
3408 (erase-buffer)
3409 (insert bs)
3410 (save-buffer 0)
3411 (kill-buffer (current-buffer))
3412 (message "Plain text written to %s" file))))))))
3413 (set-buffer (or agenda-bufname
3414 (and (org-called-interactively-p 'any) (buffer-name))
3415 org-agenda-buffer-name)))
3416 (when open (org-open-file file)))
3418 (defun org-agenda-remove-marked-text (property &optional value)
3419 "Delete all text marked with VALUE of PROPERTY.
3420 VALUE defaults to t."
3421 (let (beg)
3422 (setq value (or value t))
3423 (while (setq beg (text-property-any (point-min) (point-max)
3424 property value))
3425 (delete-region
3426 beg (or (next-single-property-change beg property)
3427 (point-max))))))
3429 (defun org-agenda-add-entry-text ()
3430 "Add entry text to agenda lines.
3431 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3432 entry text following headings shown in the agenda.
3433 Drawers will be excluded, also the line with scheduling/deadline info."
3434 (when (and (> org-agenda-add-entry-text-maxlines 0)
3435 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3436 (let (m txt)
3437 (goto-char (point-min))
3438 (while (not (eobp))
3439 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3440 (beginning-of-line 2)
3441 (setq txt (org-agenda-get-some-entry-text
3442 m org-agenda-add-entry-text-maxlines " > "))
3443 (end-of-line 1)
3444 (if (string-match "\\S-" txt)
3445 (insert "\n" txt)
3446 (or (eobp) (forward-char 1))))))))
3448 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3449 &rest keep)
3450 "Extract entry text from MARKER, at most N-LINES lines.
3451 This will ignore drawers etc, just get the text.
3452 If INDENT is given, prefix every line with this string. If KEEP is
3453 given, it is a list of symbols, defining stuff that should not be
3454 removed from the entry content. Currently only `planning' is allowed here."
3455 (let (txt drawer-re kwd-time-re ind)
3456 (save-excursion
3457 (with-current-buffer (marker-buffer marker)
3458 (if (not (derived-mode-p 'org-mode))
3459 (setq txt "")
3460 (save-excursion
3461 (save-restriction
3462 (widen)
3463 (goto-char marker)
3464 (end-of-line 1)
3465 (setq txt (buffer-substring
3466 (min (1+ (point)) (point-max))
3467 (progn (outline-next-heading) (point)))
3468 drawer-re org-drawer-regexp
3469 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3470 ".*\n?"))
3471 (with-temp-buffer
3472 (insert txt)
3473 (when org-agenda-add-entry-text-descriptive-links
3474 (goto-char (point-min))
3475 (while (org-activate-bracket-links (point-max))
3476 (add-text-properties (match-beginning 0) (match-end 0)
3477 '(face org-link))))
3478 (goto-char (point-min))
3479 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3480 (set-text-properties (match-beginning 0) (match-end 0)
3481 nil))
3482 (goto-char (point-min))
3483 (while (re-search-forward drawer-re nil t)
3484 (delete-region
3485 (match-beginning 0)
3486 (progn (re-search-forward
3487 "^[ \t]*:END:.*\n?" nil 'move)
3488 (point))))
3489 (unless (member 'planning keep)
3490 (goto-char (point-min))
3491 (while (re-search-forward kwd-time-re nil t)
3492 (replace-match "")))
3493 (goto-char (point-min))
3494 (when org-agenda-entry-text-exclude-regexps
3495 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3496 (while (setq re (pop re-list))
3497 (goto-char (point-min))
3498 (while (re-search-forward re nil t)
3499 (replace-match "")))))
3500 (goto-char (point-max))
3501 (skip-chars-backward " \t\n")
3502 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3504 ;; find and remove min common indentation
3505 (goto-char (point-min))
3506 (untabify (point-min) (point-max))
3507 (setq ind (org-get-indentation))
3508 (while (not (eobp))
3509 (unless (looking-at "[ \t]*$")
3510 (setq ind (min ind (org-get-indentation))))
3511 (beginning-of-line 2))
3512 (goto-char (point-min))
3513 (while (not (eobp))
3514 (unless (looking-at "[ \t]*$")
3515 (move-to-column ind)
3516 (delete-region (point-at-bol) (point)))
3517 (beginning-of-line 2))
3519 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3521 (goto-char (point-min))
3522 (when indent
3523 (while (and (not (eobp)) (re-search-forward "^" nil t))
3524 (replace-match indent t t)))
3525 (goto-char (point-min))
3526 (while (looking-at "[ \t]*\n") (replace-match ""))
3527 (goto-char (point-max))
3528 (when (> (org-current-line)
3529 n-lines)
3530 (org-goto-line (1+ n-lines))
3531 (backward-char 1))
3532 (setq txt (buffer-substring (point-min) (point)))))))))
3533 txt))
3535 (defun org-check-for-org-mode ()
3536 "Make sure current buffer is in org-mode. Error if not."
3537 (or (derived-mode-p 'org-mode)
3538 (error "Cannot execute org-mode agenda command on buffer in %s"
3539 major-mode)))
3541 ;;; Agenda prepare and finalize
3543 (defvar org-agenda-multi nil) ; dynamically scoped
3544 (defvar org-agenda-pre-window-conf nil)
3545 (defvar org-agenda-columns-active nil)
3546 (defvar org-agenda-name nil)
3547 (defvar org-agenda-tag-filter nil)
3548 (defvar org-agenda-category-filter nil)
3549 (defvar org-agenda-regexp-filter nil)
3550 (defvar org-agenda-effort-filter nil)
3551 (defvar org-agenda-top-headline-filter nil)
3552 (defvar org-agenda-tag-filter-preset nil
3553 "A preset of the tags filter used for secondary agenda filtering.
3554 This must be a list of strings, each string must be a single tag preceded
3555 by \"+\" or \"-\".
3556 This variable should not be set directly, but agenda custom commands can
3557 bind it in the options section. The preset filter is a global property of
3558 the entire agenda view. In a block agenda, it will not work reliably to
3559 define a filter for one of the individual blocks. You need to set it in
3560 the global options and expect it to be applied to the entire view.")
3562 (defvar org-agenda-category-filter-preset nil
3563 "A preset of the category filter used for secondary agenda filtering.
3564 This must be a list of strings, each string must be a single category
3565 preceded by \"+\" or \"-\".
3566 This variable should not be set directly, but agenda custom commands can
3567 bind it in the options section. The preset filter is a global property of
3568 the entire agenda view. In a block agenda, it will not work reliably to
3569 define a filter for one of the individual blocks. You need to set it in
3570 the global options and expect it to be applied to the entire view.")
3572 (defvar org-agenda-regexp-filter-preset nil
3573 "A preset of the regexp filter used for secondary agenda filtering.
3574 This must be a list of strings, each string must be a single regexp
3575 preceded by \"+\" or \"-\".
3576 This variable should not be set directly, but agenda custom commands can
3577 bind it in the options section. The preset filter is a global property of
3578 the entire agenda view. In a block agenda, it will not work reliably to
3579 define a filter for one of the individual blocks. You need to set it in
3580 the global options and expect it to be applied to the entire view.")
3582 (defvar org-agenda-effort-filter-preset nil
3583 "A preset of the effort condition used for secondary agenda filtering.
3584 This must be a list of strings, each string must be a single regexp
3585 preceded by \"+\" or \"-\".
3586 This variable should not be set directly, but agenda custom commands can
3587 bind it in the options section. The preset filter is a global property of
3588 the entire agenda view. In a block agenda, it will not work reliably to
3589 define a filter for one of the individual blocks. You need to set it in
3590 the global options and expect it to be applied to the entire view.")
3592 (defun org-agenda-use-sticky-p ()
3593 "Return non-nil if an agenda buffer named
3594 `org-agenda-buffer-name' exists and should be shown instead of
3595 generating a new one."
3596 (and
3597 ;; turned off by user
3598 org-agenda-sticky
3599 ;; For multi-agenda buffer already exists
3600 (not org-agenda-multi)
3601 ;; buffer found
3602 (get-buffer org-agenda-buffer-name)
3603 ;; C-u parameter is same as last call
3604 (with-current-buffer (get-buffer org-agenda-buffer-name)
3605 (and
3606 (equal current-prefix-arg
3607 org-agenda-last-prefix-arg)
3608 ;; In case user turned stickiness on, while having existing
3609 ;; Agenda buffer active, don't reuse that buffer, because it
3610 ;; does not have org variables local
3611 org-agenda-this-buffer-is-sticky))))
3613 (defun org-agenda-prepare-window (abuf filter-alist)
3614 "Setup agenda buffer in the window.
3615 ABUF is the buffer for the agenda window.
3616 FILTER-ALIST is an alist of filters we need to apply when
3617 `org-agenda-persistent-filter' is non-nil."
3618 (let* ((awin (get-buffer-window abuf)) wconf)
3619 (cond
3620 ((equal (current-buffer) abuf) nil)
3621 (awin (select-window awin))
3622 ((not (setq wconf (current-window-configuration))))
3623 ((equal org-agenda-window-setup 'current-window)
3624 (org-pop-to-buffer-same-window abuf))
3625 ((equal org-agenda-window-setup 'other-window)
3626 (org-switch-to-buffer-other-window abuf))
3627 ((equal org-agenda-window-setup 'other-frame)
3628 (switch-to-buffer-other-frame abuf))
3629 ((eq org-agenda-window-setup 'only-window)
3630 (delete-other-windows)
3631 (org-pop-to-buffer-same-window abuf))
3632 ((equal org-agenda-window-setup 'reorganize-frame)
3633 (delete-other-windows)
3634 (org-switch-to-buffer-other-window abuf)))
3635 (setq org-agenda-tag-filter (cdr (assoc 'tag filter-alist)))
3636 (setq org-agenda-category-filter (cdr (assoc 'cat filter-alist)))
3637 (setq org-agenda-effort-filter (cdr (assoc 'effort filter-alist)))
3638 (setq org-agenda-regexp-filter (cdr (assoc 're filter-alist)))
3639 ;; Additional test in case agenda is invoked from within agenda
3640 ;; buffer via elisp link.
3641 (unless (equal (current-buffer) abuf)
3642 (org-pop-to-buffer-same-window abuf))
3643 (setq org-agenda-pre-window-conf
3644 (or wconf org-agenda-pre-window-conf))))
3646 (defun org-agenda-prepare (&optional name)
3647 (let ((filter-alist (if org-agenda-persistent-filter
3648 (with-current-buffer
3649 (get-buffer-create org-agenda-buffer-name)
3650 (list `(tag . ,org-agenda-tag-filter)
3651 `(re . ,org-agenda-regexp-filter)
3652 `(effort . ,org-agenda-effort-filter)
3653 `(cat . ,org-agenda-category-filter))))))
3654 (if (org-agenda-use-sticky-p)
3655 (progn
3656 (put 'org-agenda-tag-filter :preset-filter nil)
3657 (put 'org-agenda-category-filter :preset-filter nil)
3658 (put 'org-agenda-regexp-filter :preset-filter nil)
3659 ;; Popup existing buffer
3660 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
3661 filter-alist)
3662 (message "Sticky Agenda buffer, use `r' to refresh")
3663 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3664 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3665 (setq org-todo-keywords-for-agenda nil)
3666 (put 'org-agenda-tag-filter :preset-filter
3667 org-agenda-tag-filter-preset)
3668 (put 'org-agenda-category-filter :preset-filter
3669 org-agenda-category-filter-preset)
3670 (put 'org-agenda-regexp-filter :preset-filter
3671 org-agenda-regexp-filter-preset)
3672 (put 'org-agenda-effort-filter :preset-filter
3673 org-agenda-effort-filter-preset)
3674 (if org-agenda-multi
3675 (progn
3676 (setq buffer-read-only nil)
3677 (goto-char (point-max))
3678 (unless (or (bobp) org-agenda-compact-blocks
3679 (not org-agenda-block-separator))
3680 (insert "\n"
3681 (if (stringp org-agenda-block-separator)
3682 org-agenda-block-separator
3683 (make-string (window-width) org-agenda-block-separator))
3684 "\n"))
3685 (narrow-to-region (point) (point-max)))
3686 (setq org-done-keywords-for-agenda nil)
3687 ;; Setting any org variables that are in org-agenda-local-vars
3688 ;; list need to be done after the prepare call
3689 (org-agenda-prepare-window
3690 (get-buffer-create org-agenda-buffer-name) filter-alist)
3691 (setq buffer-read-only nil)
3692 (org-agenda-reset-markers)
3693 (let ((inhibit-read-only t)) (erase-buffer))
3694 (org-agenda-mode)
3695 (setq org-agenda-buffer (current-buffer))
3696 (setq org-agenda-contributing-files nil)
3697 (setq org-agenda-columns-active nil)
3698 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3699 (setq org-todo-keywords-for-agenda
3700 (org-uniquify org-todo-keywords-for-agenda))
3701 (setq org-done-keywords-for-agenda
3702 (org-uniquify org-done-keywords-for-agenda))
3703 (setq org-agenda-last-prefix-arg current-prefix-arg)
3704 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3705 (and name (not org-agenda-name)
3706 (setq-local org-agenda-name name)))
3707 (setq buffer-read-only nil))))
3709 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3710 (defun org-agenda-finalize ()
3711 "Finishing touch for the agenda buffer, called just before displaying it."
3712 (unless org-agenda-multi
3713 (save-excursion
3714 (let ((inhibit-read-only t))
3715 (goto-char (point-min))
3716 (save-excursion
3717 (while (org-activate-bracket-links (point-max))
3718 (add-text-properties (match-beginning 0) (match-end 0)
3719 '(face org-link))))
3720 (save-excursion
3721 (while (org-activate-plain-links (point-max))
3722 (add-text-properties (match-beginning 0) (match-end 0)
3723 '(face org-link))))
3724 (unless (eq org-agenda-remove-tags t)
3725 (org-agenda-align-tags))
3726 (unless org-agenda-with-colors
3727 (remove-text-properties (point-min) (point-max) '(face nil)))
3728 (if (and (boundp 'org-agenda-overriding-columns-format)
3729 org-agenda-overriding-columns-format)
3730 (setq-local org-agenda-overriding-columns-format
3731 org-agenda-overriding-columns-format))
3732 (if (and (boundp 'org-agenda-view-columns-initially)
3733 org-agenda-view-columns-initially)
3734 (org-agenda-columns))
3735 (when org-agenda-fontify-priorities
3736 (org-agenda-fontify-priorities))
3737 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3738 (org-agenda-dim-blocked-tasks))
3739 (org-agenda-mark-clocking-task)
3740 (when org-agenda-entry-text-mode
3741 (org-agenda-entry-text-hide)
3742 (org-agenda-entry-text-show))
3743 (if (and (functionp 'org-habit-insert-consistency-graphs)
3744 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3745 (org-habit-insert-consistency-graphs))
3746 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3747 (unless (or (eq org-agenda-show-inherited-tags 'always)
3748 (and (listp org-agenda-show-inherited-tags)
3749 (memq org-agenda-type org-agenda-show-inherited-tags))
3750 (and (eq org-agenda-show-inherited-tags t)
3751 (or (eq org-agenda-use-tag-inheritance t)
3752 (and (listp org-agenda-use-tag-inheritance)
3753 (not (memq org-agenda-type
3754 org-agenda-use-tag-inheritance))))))
3755 (let (mrk)
3756 (save-excursion
3757 (goto-char (point-min))
3758 (while (equal (forward-line) 0)
3759 (when (setq mrk (get-text-property (point) 'org-hd-marker))
3760 (put-text-property (point-at-bol) (point-at-eol)
3761 'tags (org-with-point-at mrk
3762 (delete-dups
3763 (mapcar 'downcase (org-get-tags-at))))))))))
3764 (run-hooks 'org-agenda-finalize-hook)
3765 (when org-agenda-top-headline-filter
3766 (org-agenda-filter-top-headline-apply
3767 org-agenda-top-headline-filter))
3768 (when org-agenda-tag-filter
3769 (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
3770 (when (get 'org-agenda-tag-filter :preset-filter)
3771 (org-agenda-filter-apply
3772 (get 'org-agenda-tag-filter :preset-filter) 'tag t))
3773 (when org-agenda-category-filter
3774 (org-agenda-filter-apply org-agenda-category-filter 'category))
3775 (when (get 'org-agenda-category-filter :preset-filter)
3776 (org-agenda-filter-apply
3777 (get 'org-agenda-category-filter :preset-filter) 'category))
3778 (when org-agenda-regexp-filter
3779 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3780 (when (get 'org-agenda-regexp-filter :preset-filter)
3781 (org-agenda-filter-apply
3782 (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
3783 (when org-agenda-effort-filter
3784 (org-agenda-filter-apply org-agenda-effort-filter 'effort))
3785 (when (get 'org-agenda-effort-filter :preset-filter)
3786 (org-agenda-filter-apply
3787 (get 'org-agenda-effort-filter :preset-filter) 'effort))
3788 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3790 (defun org-agenda-mark-clocking-task ()
3791 "Mark the current clock entry in the agenda if it is present."
3792 ;; We need to widen when `org-agenda-finalize' is called from
3793 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3794 (when org-clock-current-task
3795 (save-restriction
3796 (widen)
3797 (org-agenda-unmark-clocking-task)
3798 (when (marker-buffer org-clock-hd-marker)
3799 (save-excursion
3800 (goto-char (point-min))
3801 (let (s ov)
3802 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3803 (goto-char s)
3804 (when (equal (org-get-at-bol 'org-hd-marker)
3805 org-clock-hd-marker)
3806 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3807 (overlay-put ov 'type 'org-agenda-clocking)
3808 (overlay-put ov 'face 'org-agenda-clocking)
3809 (overlay-put ov 'help-echo
3810 "The clock is running in this item")))))))))
3812 (defun org-agenda-unmark-clocking-task ()
3813 "Unmark the current clocking task."
3814 (mapc (lambda (o)
3815 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3816 (delete-overlay o)))
3817 (overlays-in (point-min) (point-max))))
3819 (defun org-agenda-fontify-priorities ()
3820 "Make highest priority lines bold, and lowest italic."
3821 (interactive)
3822 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3823 (delete-overlay o)))
3824 (overlays-in (point-min) (point-max)))
3825 (save-excursion
3826 (let (b e p ov h l)
3827 (goto-char (point-min))
3828 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3829 (setq h (or (get-char-property (point) 'org-highest-priority)
3830 org-highest-priority)
3831 l (or (get-char-property (point) 'org-lowest-priority)
3832 org-lowest-priority)
3833 p (string-to-char (match-string 1))
3834 b (match-beginning 0)
3835 e (if (eq org-agenda-fontify-priorities 'cookies)
3836 (match-end 0)
3837 (point-at-eol))
3838 ov (make-overlay b e))
3839 (overlay-put
3840 ov 'face
3841 (let ((special-face
3842 (cond ((org-face-from-face-or-color
3843 'priority nil
3844 (cdr (assoc p org-priority-faces))))
3845 ((and (listp org-agenda-fontify-priorities)
3846 (org-face-from-face-or-color
3847 'priority nil
3848 (cdr (assoc p org-agenda-fontify-priorities)))))
3849 ((equal p l) 'italic)
3850 ((equal p h) 'bold))))
3851 (if special-face (list special-face 'org-priority) 'org-priority)))
3852 (overlay-put ov 'org-type 'org-priority)))))
3854 (defvar org-depend-tag-blocked)
3856 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3857 "Dim currently blocked TODOs in the agenda display.
3858 When INVISIBLE is non-nil, hide currently blocked TODO instead of
3859 dimming them."
3860 (interactive "P")
3861 (when (org-called-interactively-p 'interactive)
3862 (message "Dim or hide blocked tasks..."))
3863 (dolist (o (overlays-in (point-min) (point-max)))
3864 (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
3865 (delete-overlay o)))
3866 (save-excursion
3867 (let ((inhibit-read-only t)
3868 (org-depend-tag-blocked nil)
3869 org-blocked-by-checkboxes)
3870 (goto-char (point-min))
3871 (while (let ((pos (text-property-not-all
3872 (point) (point-max) 'todo-state nil)))
3873 (when pos (goto-char pos)))
3874 (setq org-blocked-by-checkboxes nil)
3875 (let ((marker (org-get-at-bol 'org-hd-marker)))
3876 (when (and (markerp marker)
3877 (with-current-buffer (marker-buffer marker)
3878 (save-excursion (goto-char marker)
3879 (org-entry-blocked-p))))
3880 ;; Entries blocked by checkboxes cannot be made invisible.
3881 ;; See `org-agenda-dim-blocked-tasks' for details.
3882 (let* ((really-invisible
3883 (and (not org-blocked-by-checkboxes)
3884 (or invisible (eq org-agenda-dim-blocked-tasks
3885 'invisible))))
3886 (ov (make-overlay (if really-invisible (line-end-position 0)
3887 (line-beginning-position))
3888 (line-end-position))))
3889 (if really-invisible (overlay-put ov 'invisible t)
3890 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3891 (overlay-put ov 'org-type 'org-blocked-todo))))
3892 (forward-line))))
3893 (when (org-called-interactively-p 'interactive)
3894 (message "Dim or hide blocked tasks...done")))
3896 (defvar org-agenda-skip-function nil
3897 "Function to be called at each match during agenda construction.
3898 If this function returns nil, the current match should not be skipped.
3899 Otherwise, the function must return a position from where the search
3900 should be continued.
3901 This may also be a Lisp form, it will be evaluated.
3902 Never set this variable using `setq' or so, because then it will apply
3903 to all future agenda commands. If you do want a global skipping condition,
3904 use the option `org-agenda-skip-function-global' instead.
3905 The correct usage for `org-agenda-skip-function' is to bind it with
3906 `let' to scope it dynamically into the agenda-constructing command.
3907 A good way to set it is through options in `org-agenda-custom-commands'.")
3909 (defun org-agenda-skip ()
3910 "Throw to `:skip' in places that should be skipped.
3911 Also moves point to the end of the skipped region, so that search can
3912 continue from there."
3913 (let ((p (point-at-bol)) to)
3914 (when (or
3915 (save-excursion (goto-char p) (looking-at comment-start-skip))
3916 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3917 (get-text-property p :org-archived)
3918 (org-end-of-subtree t))
3919 (and org-agenda-skip-comment-trees
3920 (get-text-property p :org-comment)
3921 (org-end-of-subtree t))
3922 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3923 (org-agenda-skip-eval org-agenda-skip-function)))
3924 (goto-char to))
3925 (org-in-src-block-p t))
3926 (throw :skip t))))
3928 (defun org-agenda-skip-eval (form)
3929 "If FORM is a function or a list, call (or eval) it and return the result.
3930 `save-excursion' and `save-match-data' are wrapped around the call, so point
3931 and match data are returned to the previous state no matter what these
3932 functions do."
3933 (let (fp)
3934 (and form
3935 (or (setq fp (functionp form))
3936 (consp form))
3937 (save-excursion
3938 (save-match-data
3939 (if fp
3940 (funcall form)
3941 (eval form)))))))
3943 (defvar org-agenda-markers nil
3944 "List of all currently active markers created by `org-agenda'.")
3945 (defvar org-agenda-last-marker-time (org-float-time)
3946 "Creation time of the last agenda marker.")
3948 (defun org-agenda-new-marker (&optional pos)
3949 "Return a new agenda marker.
3950 Maker is at point, or at POS if non-nil. Org mode keeps a list of
3951 these markers and resets them when they are no longer in use."
3952 (let ((m (copy-marker (or pos (point)) t)))
3953 (setq org-agenda-last-marker-time (org-float-time))
3954 (if org-agenda-buffer
3955 (with-current-buffer org-agenda-buffer
3956 (push m org-agenda-markers))
3957 (push m org-agenda-markers))
3960 (defun org-agenda-reset-markers ()
3961 "Reset markers created by `org-agenda'."
3962 (while org-agenda-markers
3963 (move-marker (pop org-agenda-markers) nil)))
3965 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3966 "Save relative positions of markers in region.
3967 This check for agenda markers in all agenda buffers currently active."
3968 (dolist (buf (buffer-list))
3969 (with-current-buffer buf
3970 (when (eq major-mode 'org-agenda-mode)
3971 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3972 org-agenda-markers)))))
3974 ;;; Entry text mode
3976 (defun org-agenda-entry-text-show-here ()
3977 "Add some text from the entry as context to the current line."
3978 (let (m txt o)
3979 (setq m (org-get-at-bol 'org-hd-marker))
3980 (unless (marker-buffer m)
3981 (error "No marker points to an entry here"))
3982 (setq txt (concat "\n" (org-no-properties
3983 (org-agenda-get-some-entry-text
3984 m org-agenda-entry-text-maxlines
3985 org-agenda-entry-text-leaders))))
3986 (when (string-match "\\S-" txt)
3987 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3988 (overlay-put o 'evaporate t)
3989 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3990 (overlay-put o 'after-string txt))))
3992 (defun org-agenda-entry-text-show ()
3993 "Add entry context for all agenda lines."
3994 (interactive)
3995 (save-excursion
3996 (goto-char (point-max))
3997 (beginning-of-line 1)
3998 (while (not (bobp))
3999 (when (org-get-at-bol 'org-hd-marker)
4000 (org-agenda-entry-text-show-here))
4001 (beginning-of-line 0))))
4003 (defun org-agenda-entry-text-hide ()
4004 "Remove any shown entry context."
4005 (delq nil
4006 (mapcar (lambda (o)
4007 (if (eq (overlay-get o 'org-overlay-type)
4008 'agenda-entry-content)
4009 (progn (delete-overlay o) t)))
4010 (overlays-in (point-min) (point-max)))))
4012 (defun org-agenda-get-day-face (date)
4013 "Return the face DATE should be displayed with."
4014 (cond ((and (functionp org-agenda-day-face-function)
4015 (funcall org-agenda-day-face-function date)))
4016 ((org-agenda-today-p date) 'org-agenda-date-today)
4017 ((memq (calendar-day-of-week date) org-agenda-weekend-days)
4018 'org-agenda-date-weekend)
4019 (t 'org-agenda-date)))
4021 ;;; Agenda timeline
4023 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
4024 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
4026 (defun org-timeline (&optional dotodo)
4027 "Show a time-sorted view of the entries in the current org file.
4028 Only entries with a time stamp of today or later will be listed. With
4029 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
4030 under the current date.
4031 If the buffer contains an active region, only check the region for
4032 dates."
4033 (interactive "P")
4034 (let* ((dopast t)
4035 (org-agenda-show-log-scoped org-agenda-show-log)
4036 (org-agenda-show-log org-agenda-show-log-scoped)
4037 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
4038 (current-buffer))))
4039 (date (calendar-current-date))
4040 (beg (if (org-region-active-p) (region-beginning) (point-min)))
4041 (end (if (org-region-active-p) (region-end) (point-max)))
4042 (day-numbers (org-get-all-dates
4043 beg end 'no-ranges
4044 t org-agenda-show-log-scoped ; always include today
4045 org-timeline-show-empty-dates))
4046 (org-deadline-warning-days 0)
4047 (org-agenda-only-exact-dates t)
4048 (today (org-today))
4049 (past t)
4050 args
4051 s e rtn d emptyp)
4052 (setq org-agenda-redo-command
4053 (list 'let
4054 (list (list 'org-agenda-show-log 'org-agenda-show-log))
4055 (list 'org-switch-to-buffer-other-window (current-buffer))
4056 (list 'org-timeline (list 'quote dotodo))))
4057 (put 'org-agenda-redo-command 'org-lprops nil)
4058 (if (not dopast)
4059 ;; Remove past dates from the list of dates.
4060 (setq day-numbers (delq nil (mapcar (lambda(x)
4061 (if (>= x today) x nil))
4062 day-numbers))))
4063 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
4064 (org-compile-prefix-format 'timeline)
4065 (org-set-sorting-strategy 'timeline)
4066 (if org-agenda-show-log-scoped (push :closed args))
4067 (push :timestamp args)
4068 (push :deadline args)
4069 (push :scheduled args)
4070 (push :sexp args)
4071 (if dotodo (push :todo args))
4072 (insert "Timeline of file " entry "\n")
4073 (add-text-properties (point-min) (point)
4074 (list 'face 'org-agenda-structure))
4075 (org-agenda-mark-header-line (point-min))
4076 (while (setq d (pop day-numbers))
4077 (if (and (listp d) (eq (car d) :omitted))
4078 (progn
4079 (setq s (point))
4080 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4081 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4082 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4083 (if (and (>= d today)
4084 dopast
4085 past)
4086 (progn
4087 (setq past nil)
4088 (insert (make-string 79 ?-) "\n")))
4089 (setq date (calendar-gregorian-from-absolute d))
4090 (setq s (point))
4091 (setq rtn (and (not emptyp)
4092 (apply 'org-agenda-get-day-entries entry
4093 date args)))
4094 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4095 (progn
4096 (insert
4097 (if (stringp org-agenda-format-date)
4098 (format-time-string org-agenda-format-date
4099 (org-time-from-absolute date))
4100 (funcall org-agenda-format-date date))
4101 "\n")
4102 (put-text-property s (1- (point)) 'face
4103 (org-agenda-get-day-face date))
4104 (put-text-property s (1- (point)) 'org-date-line t)
4105 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4106 (if (equal d today)
4107 (put-text-property s (1- (point)) 'org-today t))
4108 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4109 (put-text-property s (1- (point)) 'day d)))))
4110 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4111 (point-min)))
4112 (add-text-properties
4113 (point-min) (point-max)
4114 `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
4115 (org-agenda-finalize)
4116 (setq buffer-read-only t)))
4118 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4119 "Return a list of all relevant day numbers from BEG to END buffer positions.
4120 If NO-RANGES is non-nil, include only the start and end dates of a range,
4121 not every single day in the range. If FORCE-TODAY is non-nil, make
4122 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4123 inactive time stamps (those in square brackets) are included.
4124 When EMPTY is non-nil, also include days without any entries."
4125 (let ((re (concat
4126 (if pre-re pre-re "")
4127 (if inactive org-ts-regexp-both org-ts-regexp)))
4128 dates dates1 date day day1 day2 ts1 ts2 pos)
4129 (if force-today
4130 (setq dates (list (org-today))))
4131 (save-excursion
4132 (goto-char beg)
4133 (while (re-search-forward re end t)
4134 (setq day (time-to-days (org-time-string-to-time
4135 (substring (match-string 1) 0 10)
4136 (current-buffer) (match-beginning 0))))
4137 (or (memq day dates) (push day dates)))
4138 (unless no-ranges
4139 (goto-char beg)
4140 (while (re-search-forward org-tr-regexp end t)
4141 (setq pos (match-beginning 0))
4142 (setq ts1 (substring (match-string 1) 0 10)
4143 ts2 (substring (match-string 2) 0 10)
4144 day1 (time-to-days (org-time-string-to-time
4145 ts1 (current-buffer) pos))
4146 day2 (time-to-days (org-time-string-to-time
4147 ts2 (current-buffer) pos)))
4148 (while (< (setq day1 (1+ day1)) day2)
4149 (or (memq day1 dates) (push day1 dates)))))
4150 (setq dates (sort dates '<))
4151 (when empty
4152 (while (setq day (pop dates))
4153 (setq day2 (car dates))
4154 (push day dates1)
4155 (when (and day2 empty)
4156 (if (or (eq empty t)
4157 (and (numberp empty) (<= (- day2 day) empty)))
4158 (while (< (setq day (1+ day)) day2)
4159 (push (list day) dates1))
4160 (push (cons :omitted (- day2 day)) dates1))))
4161 (setq dates (nreverse dates1)))
4162 dates)))
4164 ;;; Agenda Daily/Weekly
4166 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4167 "Start day for the agenda view.
4168 Custom commands can set this variable in the options section.
4169 This is usually a string like \"2007-11-01\", \"+2d\" or any other
4170 input allowed when reading a date through the Org calendar.
4171 See the docstring of `org-read-date' for details.")
4172 (defvar org-starting-day nil) ; local variable in the agenda buffer
4173 (defvar org-arg-loc nil) ; local variable
4175 (defvar org-agenda-buffer-tmp-name nil)
4176 ;;;###autoload
4177 (defun org-agenda-list (&optional arg start-day span with-hour)
4178 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4179 The view will be for the current day or week, but from the overview buffer
4180 you will be able to go to other days/weeks.
4182 With a numeric prefix argument in an interactive call, the agenda will
4183 span ARG days. Lisp programs should instead specify SPAN to change
4184 the number of days. SPAN defaults to `org-agenda-span'.
4186 START-DAY defaults to TODAY, or to the most recent match for the weekday
4187 given in `org-agenda-start-on-weekday'.
4189 When WITH-HOUR is non-nil, only include scheduled and deadline
4190 items if they have an hour specification like [h]h:mm."
4191 (interactive "P")
4192 (if org-agenda-overriding-arguments
4193 (setq arg (car org-agenda-overriding-arguments)
4194 start-day (nth 1 org-agenda-overriding-arguments)
4195 span (nth 2 org-agenda-overriding-arguments)))
4196 (if (and (integerp arg) (> arg 0))
4197 (setq span arg arg nil))
4198 (catch 'exit
4199 (setq org-agenda-buffer-name
4200 (or org-agenda-buffer-tmp-name
4201 (if org-agenda-sticky
4202 (cond ((and org-keys (stringp org-match))
4203 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4204 (org-keys
4205 (format "*Org Agenda(%s)*" org-keys))
4206 (t "*Org Agenda(a)*")))
4207 org-agenda-buffer-name))
4208 (org-agenda-prepare "Day/Week")
4209 (setq start-day (or start-day org-agenda-start-day))
4210 (if (stringp start-day)
4211 ;; Convert to an absolute day number
4212 (setq start-day (time-to-days (org-read-date nil t start-day))))
4213 (org-compile-prefix-format 'agenda)
4214 (org-set-sorting-strategy 'agenda)
4215 (let* ((span (org-agenda-ndays-to-span
4216 (or span org-agenda-ndays org-agenda-span)))
4217 (today (org-today))
4218 (sd (or start-day today))
4219 (ndays (org-agenda-span-to-ndays span sd))
4220 (org-agenda-start-on-weekday
4221 (if (or (eq ndays 7) (eq ndays 14))
4222 org-agenda-start-on-weekday))
4223 (thefiles (org-agenda-files nil 'ifmode))
4224 (files thefiles)
4225 (start (if (or (null org-agenda-start-on-weekday)
4226 (< ndays 7))
4228 (let* ((nt (calendar-day-of-week
4229 (calendar-gregorian-from-absolute sd)))
4230 (n1 org-agenda-start-on-weekday)
4231 (d (- nt n1)))
4232 (- sd (+ (if (< d 0) 7 0) d)))))
4233 (day-numbers (list start))
4234 (day-cnt 0)
4235 (inhibit-redisplay (not debug-on-error))
4236 (org-agenda-show-log-scoped org-agenda-show-log)
4237 s e rtn rtnall file date d start-pos end-pos todayp
4238 clocktable-start clocktable-end filter)
4239 (setq org-agenda-redo-command
4240 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4241 (dotimes (n (1- ndays))
4242 (push (1+ (car day-numbers)) day-numbers))
4243 (setq day-numbers (nreverse day-numbers))
4244 (setq clocktable-start (car day-numbers)
4245 clocktable-end (1+ (or (org-last day-numbers) 0)))
4246 (setq-local org-starting-day (car day-numbers))
4247 (setq-local org-arg-loc arg)
4248 (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
4249 (unless org-agenda-compact-blocks
4250 (let* ((d1 (car day-numbers))
4251 (d2 (org-last day-numbers))
4252 (w1 (org-days-to-iso-week d1))
4253 (w2 (org-days-to-iso-week d2)))
4254 (setq s (point))
4255 (if org-agenda-overriding-header
4256 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4257 nil 'face 'org-agenda-structure) "\n")
4258 (insert (org-agenda-span-name span)
4259 "-agenda"
4260 (if (< (- d2 d1) 350)
4261 (if (= w1 w2)
4262 (format " (W%02d)" w1)
4263 (format " (W%02d-W%02d)" w1 w2))
4265 ":\n")))
4266 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4267 'org-date-line t))
4268 (org-agenda-mark-header-line s))
4269 (while (setq d (pop day-numbers))
4270 (setq date (calendar-gregorian-from-absolute d)
4271 s (point))
4272 (if (or (setq todayp (= d today))
4273 (and (not start-pos) (= d sd)))
4274 (setq start-pos (point))
4275 (if (and start-pos (not end-pos))
4276 (setq end-pos (point))))
4277 (setq files thefiles
4278 rtnall nil)
4279 (while (setq file (pop files))
4280 (catch 'nextfile
4281 (org-check-agenda-file file)
4282 (let ((org-agenda-entry-types org-agenda-entry-types))
4283 ;; Starred types override non-starred equivalents
4284 (when (member :deadline* org-agenda-entry-types)
4285 (setq org-agenda-entry-types
4286 (delq :deadline org-agenda-entry-types)))
4287 (when (member :scheduled* org-agenda-entry-types)
4288 (setq org-agenda-entry-types
4289 (delq :scheduled org-agenda-entry-types)))
4290 ;; Honor with-hour
4291 (when with-hour
4292 (when (member :deadline org-agenda-entry-types)
4293 (setq org-agenda-entry-types
4294 (delq :deadline org-agenda-entry-types))
4295 (push :deadline* org-agenda-entry-types))
4296 (when (member :scheduled org-agenda-entry-types)
4297 (setq org-agenda-entry-types
4298 (delq :scheduled org-agenda-entry-types))
4299 (push :scheduled* org-agenda-entry-types)))
4300 (unless org-agenda-include-deadlines
4301 (setq org-agenda-entry-types
4302 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4303 (cond
4304 ((memq org-agenda-show-log-scoped '(only clockcheck))
4305 (setq rtn (org-agenda-get-day-entries
4306 file date :closed)))
4307 (org-agenda-show-log-scoped
4308 (setq rtn (apply 'org-agenda-get-day-entries
4309 file date
4310 (append '(:closed) org-agenda-entry-types))))
4312 (setq rtn (apply 'org-agenda-get-day-entries
4313 file date
4314 org-agenda-entry-types)))))
4315 (setq rtnall (append rtnall rtn)))) ;; all entries
4316 (if org-agenda-include-diary
4317 (let ((org-agenda-search-headline-for-time t))
4318 (require 'diary-lib)
4319 (setq rtn (org-get-entries-from-diary date))
4320 (setq rtnall (append rtnall rtn))))
4321 (if (or rtnall org-agenda-show-all-dates)
4322 (progn
4323 (setq day-cnt (1+ day-cnt))
4324 (insert
4325 (if (stringp org-agenda-format-date)
4326 (format-time-string org-agenda-format-date
4327 (org-time-from-absolute date))
4328 (funcall org-agenda-format-date date))
4329 "\n")
4330 (put-text-property s (1- (point)) 'face
4331 (org-agenda-get-day-face date))
4332 (put-text-property s (1- (point)) 'org-date-line t)
4333 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4334 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4335 (when todayp
4336 (put-text-property s (1- (point)) 'org-today t))
4337 (setq rtnall
4338 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4339 (if rtnall (insert ;; all entries
4340 (org-agenda-finalize-entries rtnall 'agenda)
4341 "\n"))
4342 (put-text-property s (1- (point)) 'day d)
4343 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4344 (when (and org-agenda-clockreport-mode clocktable-start)
4345 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4346 ;; the above line is to ensure the restricted range!
4347 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4348 tbl)
4349 (setq p (org-plist-delete p :block))
4350 (setq p (plist-put p :tstart clocktable-start))
4351 (setq p (plist-put p :tend clocktable-end))
4352 (setq p (plist-put p :scope 'agenda))
4353 (setq tbl (apply 'org-clock-get-clocktable p))
4354 (insert tbl)))
4355 (goto-char (point-min))
4356 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4357 (unless (and (pos-visible-in-window-p (point-min))
4358 (pos-visible-in-window-p (point-max)))
4359 (goto-char (1- (point-max)))
4360 (recenter -1)
4361 (if (not (pos-visible-in-window-p (or start-pos 1)))
4362 (progn
4363 (goto-char (or start-pos 1))
4364 (recenter 1))))
4365 (goto-char (or start-pos 1))
4366 (add-text-properties (point-min) (point-max)
4367 `(org-agenda-type agenda
4368 org-last-args (,arg ,start-day ,span)
4369 org-redo-cmd ,org-agenda-redo-command
4370 org-series-cmd ,org-cmd))
4371 (if (eq org-agenda-show-log-scoped 'clockcheck)
4372 (org-agenda-show-clocking-issues))
4373 (org-agenda-finalize)
4374 (setq buffer-read-only t)
4375 (message ""))))
4377 (defun org-agenda-ndays-to-span (n)
4378 "Return a span symbol for a span of N days, or N if none matches."
4379 (cond ((symbolp n) n)
4380 ((= n 1) 'day)
4381 ((= n 7) 'week)
4382 ((= n 14) 'fortnight)
4383 (t n)))
4385 (defun org-agenda-span-to-ndays (span &optional start-day)
4386 "Return ndays from SPAN, possibly starting at START-DAY.
4387 START-DAY is an absolute time value."
4388 (cond ((numberp span) span)
4389 ((eq span 'day) 1)
4390 ((eq span 'week) 7)
4391 ((eq span 'fortnight) 14)
4392 ((eq span 'month)
4393 (let ((date (calendar-gregorian-from-absolute start-day)))
4394 (calendar-last-day-of-month (car date) (caddr date))))
4395 ((eq span 'year)
4396 (let ((date (calendar-gregorian-from-absolute start-day)))
4397 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4399 (defun org-agenda-span-name (span)
4400 "Return a SPAN name."
4401 (if (null span)
4403 (if (symbolp span)
4404 (capitalize (symbol-name span))
4405 (format "%d days" span))))
4407 ;;; Agenda word search
4409 (defvar org-agenda-search-history nil)
4411 (defvar org-search-syntax-table nil
4412 "Special syntax table for org-mode search.
4413 In this table, we have single quotes not as word constituents, to
4414 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4416 (defvar org-mode-syntax-table) ; From org.el
4417 (defun org-search-syntax-table ()
4418 (unless org-search-syntax-table
4419 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4420 (modify-syntax-entry ?' "." org-search-syntax-table)
4421 (modify-syntax-entry ?` "." org-search-syntax-table))
4422 org-search-syntax-table)
4424 (defvar org-agenda-last-search-view-search-was-boolean nil)
4426 ;;;###autoload
4427 (defun org-search-view (&optional todo-only string edit-at)
4428 "Show all entries that contain a phrase or words or regular expressions.
4430 With optional prefix argument TODO-ONLY, only consider entries that are
4431 TODO entries. The argument STRING can be used to pass a default search
4432 string into this function. If EDIT-AT is non-nil, it means that the
4433 user should get a chance to edit this string, with cursor at position
4434 EDIT-AT.
4436 The search string can be viewed either as a phrase that should be found as
4437 is, or it can be broken into a number of snippets, each of which must match
4438 in a Boolean way to select an entry. The default depends on the variable
4439 `org-agenda-search-view-always-boolean'.
4440 Even if this is turned off (the default) you can always switch to
4441 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4443 The default is a direct search of the whole phrase, where each space in
4444 the search string can expand to an arbitrary amount of whitespace,
4445 including newlines.
4447 If using a Boolean search, the search string is split on whitespace and
4448 each snippet is searched separately, with logical AND to select an entry.
4449 Words prefixed with a minus must *not* occur in the entry. Words without
4450 a prefix or prefixed with a plus must occur in the entry. Matching is
4451 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4452 match whole words, not parts of a word) if
4453 `org-agenda-search-view-force-full-words' is set (default is nil).
4455 Boolean search snippets enclosed by curly braces are interpreted as
4456 regular expressions that must or (when preceded with \"-\") must not
4457 match in the entry. Snippets enclosed into double quotes will be taken
4458 as a whole, to include whitespace.
4460 - If the search string starts with an asterisk, search only in headlines.
4461 - If (possibly after the leading star) the search string starts with an
4462 exclamation mark, this also means to look at TODO entries only, an effect
4463 that can also be achieved with a prefix argument.
4464 - If (possibly after star and exclamation mark) the search string starts
4465 with a colon, this will mean that the (non-regexp) snippets of the
4466 Boolean search must match as full words.
4468 This command searches the agenda files, and in addition the files listed
4469 in `org-agenda-text-search-extra-files'."
4470 (interactive "P")
4471 (if org-agenda-overriding-arguments
4472 (setq todo-only (car org-agenda-overriding-arguments)
4473 string (nth 1 org-agenda-overriding-arguments)
4474 edit-at (nth 2 org-agenda-overriding-arguments)))
4475 (let* ((props (list 'face nil
4476 'done-face 'org-agenda-done
4477 'org-not-done-regexp org-not-done-regexp
4478 'org-todo-regexp org-todo-regexp
4479 'org-complex-heading-regexp org-complex-heading-regexp
4480 'mouse-face 'highlight
4481 'help-echo (format "mouse-2 or RET jump to location")))
4482 (full-words org-agenda-search-view-force-full-words)
4483 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4484 regexp rtn rtnall files file pos inherited-tags
4485 marker category level tags c neg re boolean
4486 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4487 (unless (and (not edit-at)
4488 (stringp string)
4489 (string-match "\\S-" string))
4490 (setq string (read-string
4491 (if org-agenda-search-view-always-boolean
4492 "[+-]Word/{Regexp} ...: "
4493 "Phrase or [+-]Word/{Regexp} ...: ")
4494 (cond
4495 ((integerp edit-at) (cons string edit-at))
4496 (edit-at string))
4497 'org-agenda-search-history)))
4498 (catch 'exit
4499 (if org-agenda-sticky
4500 (setq org-agenda-buffer-name
4501 (if (stringp string)
4502 (format "*Org Agenda(%s:%s)*"
4503 (or org-keys (or (and todo-only "S") "s")) string)
4504 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4505 (org-agenda-prepare "SEARCH")
4506 (org-compile-prefix-format 'search)
4507 (org-set-sorting-strategy 'search)
4508 (setq org-agenda-redo-command
4509 (list 'org-search-view (if todo-only t nil)
4510 (list 'if 'current-prefix-arg nil string)))
4511 (setq org-agenda-query-string string)
4512 (if (equal (string-to-char string) ?*)
4513 (setq hdl-only t
4514 words (substring string 1))
4515 (setq words string))
4516 (when (equal (string-to-char words) ?!)
4517 (setq todo-only t
4518 words (substring words 1)))
4519 (when (equal (string-to-char words) ?:)
4520 (setq full-words t
4521 words (substring words 1)))
4522 (if (or org-agenda-search-view-always-boolean
4523 (member (string-to-char words) '(?- ?+ ?\{)))
4524 (setq boolean t))
4525 (setq words (org-split-string words))
4526 (let (www w)
4527 (while (setq w (pop words))
4528 (while (and (string-match "\\\\\\'" w) words)
4529 (setq w (concat (substring w 0 -1) " " (pop words))))
4530 (push w www))
4531 (setq words (nreverse www) www nil)
4532 (while (setq w (pop words))
4533 (when (and (string-match "\\`[-+]?{" w)
4534 (not (string-match "}\\'" w)))
4535 (while (and words (not (string-match "}\\'" (car words))))
4536 (setq w (concat w " " (pop words))))
4537 (setq w (concat w " " (pop words))))
4538 (push w www))
4539 (setq words (nreverse www)))
4540 (setq org-agenda-last-search-view-search-was-boolean boolean)
4541 (when boolean
4542 (let (wds w)
4543 (while (setq w (pop words))
4544 (if (or (equal (substring w 0 1) "\"")
4545 (and (> (length w) 1)
4546 (member (substring w 0 1) '("+" "-"))
4547 (equal (substring w 1 2) "\"")))
4548 (while (and words (not (equal (substring w -1) "\"")))
4549 (setq w (concat w " " (pop words)))))
4550 (and (string-match "\\`\\([-+]?\\)\"" w)
4551 (setq w (replace-match "\\1" nil nil w)))
4552 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4553 (push w wds))
4554 (setq words (nreverse wds))))
4555 (if boolean
4556 (mapc (lambda (w)
4557 (setq c (string-to-char w))
4558 (if (equal c ?-)
4559 (setq neg t w (substring w 1))
4560 (if (equal c ?+)
4561 (setq neg nil w (substring w 1))
4562 (setq neg nil)))
4563 (if (string-match "\\`{.*}\\'" w)
4564 (setq re (substring w 1 -1))
4565 (if full-words
4566 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4567 (setq re (regexp-quote (downcase w)))))
4568 (if neg (push re regexps-) (push re regexps+)))
4569 words)
4570 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4571 regexps+))
4572 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4573 (if (not regexps+)
4574 (setq regexp org-outline-regexp-bol)
4575 (setq regexp (pop regexps+))
4576 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4577 regexp))))
4578 (setq files (org-agenda-files nil 'ifmode))
4579 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4580 (pop org-agenda-text-search-extra-files)
4581 (setq files (org-add-archive-files files)))
4582 (setq files (append files org-agenda-text-search-extra-files)
4583 rtnall nil)
4584 (while (setq file (pop files))
4585 (setq ee nil)
4586 (catch 'nextfile
4587 (org-check-agenda-file file)
4588 (setq buffer (if (file-exists-p file)
4589 (org-get-agenda-file-buffer file)
4590 (error "No such file %s" file)))
4591 (if (not buffer)
4592 ;; If file does not exist, make sure an error message is sent
4593 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4594 file))))
4595 (with-current-buffer buffer
4596 (with-syntax-table (org-search-syntax-table)
4597 (unless (derived-mode-p 'org-mode)
4598 (error "Agenda file %s is not in `org-mode'" file))
4599 (let ((case-fold-search t))
4600 (save-excursion
4601 (save-restriction
4602 (if (eq buffer org-agenda-restrict)
4603 (narrow-to-region org-agenda-restrict-begin
4604 org-agenda-restrict-end)
4605 (widen))
4606 (goto-char (point-min))
4607 (unless (or (org-at-heading-p)
4608 (outline-next-heading))
4609 (throw 'nextfile t))
4610 (goto-char (max (point-min) (1- (point))))
4611 (while (re-search-forward regexp nil t)
4612 (org-back-to-heading t)
4613 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4614 (> (org-reduced-level (org-outline-level))
4615 org-agenda-search-view-max-outline-level)
4616 (forward-line -1)
4617 (outline-back-to-heading t)))
4618 (skip-chars-forward "* ")
4619 (setq beg (point-at-bol)
4620 beg1 (point)
4621 end (progn
4622 (outline-next-heading)
4623 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4624 (> (org-reduced-level (org-outline-level))
4625 org-agenda-search-view-max-outline-level)
4626 (forward-line 1)
4627 (outline-next-heading)))
4628 (point)))
4630 (catch :skip
4631 (goto-char beg)
4632 (org-agenda-skip)
4633 (setq str (buffer-substring-no-properties
4634 (point-at-bol)
4635 (if hdl-only (point-at-eol) end)))
4636 (mapc (lambda (wr) (when (string-match wr str)
4637 (goto-char (1- end))
4638 (throw :skip t)))
4639 regexps-)
4640 (mapc (lambda (wr) (unless (string-match wr str)
4641 (goto-char (1- end))
4642 (throw :skip t)))
4643 (if todo-only
4644 (cons (concat "^\\*+[ \t]+"
4645 org-not-done-regexp)
4646 regexps+)
4647 regexps+))
4648 (goto-char beg)
4649 (setq marker (org-agenda-new-marker (point))
4650 category (org-get-category)
4651 level (make-string (org-reduced-level (org-outline-level)) ? )
4652 inherited-tags
4653 (or (eq org-agenda-show-inherited-tags 'always)
4654 (and (listp org-agenda-show-inherited-tags)
4655 (memq 'todo org-agenda-show-inherited-tags))
4656 (and (eq org-agenda-show-inherited-tags t)
4657 (or (eq org-agenda-use-tag-inheritance t)
4658 (memq 'todo org-agenda-use-tag-inheritance))))
4659 tags (org-get-tags-at nil (not inherited-tags))
4660 txt (org-agenda-format-item
4662 (buffer-substring-no-properties
4663 beg1 (point-at-eol))
4664 level category tags t))
4665 (org-add-props txt props
4666 'org-marker marker 'org-hd-marker marker
4667 'org-todo-regexp org-todo-regexp
4668 'level level
4669 'org-complex-heading-regexp org-complex-heading-regexp
4670 'priority 1000
4671 'type "search")
4672 (push txt ee)
4673 (goto-char (1- end))))))))))
4674 (setq rtn (nreverse ee))
4675 (setq rtnall (append rtnall rtn)))
4676 (if org-agenda-overriding-header
4677 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4678 nil 'face 'org-agenda-structure) "\n")
4679 (insert "Search words: ")
4680 (add-text-properties (point-min) (1- (point))
4681 (list 'face 'org-agenda-structure))
4682 (setq pos (point))
4683 (insert string "\n")
4684 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4685 (setq pos (point))
4686 (unless org-agenda-multi
4687 (insert (substitute-command-keys "\
4688 Press `\\[org-agenda-manipulate-query-add]', \
4689 `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
4690 `\\[org-agenda-manipulate-query-add-re]', \
4691 `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
4692 `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
4693 (add-text-properties pos (1- (point))
4694 (list 'face 'org-agenda-structure))))
4695 (org-agenda-mark-header-line (point-min))
4696 (when rtnall
4697 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4698 (goto-char (point-min))
4699 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4700 (add-text-properties (point-min) (point-max)
4701 `(org-agenda-type search
4702 org-last-args (,todo-only ,string ,edit-at)
4703 org-redo-cmd ,org-agenda-redo-command
4704 org-series-cmd ,org-cmd))
4705 (org-agenda-finalize)
4706 (setq buffer-read-only t))))
4708 ;;; Agenda TODO list
4710 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4711 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4712 (concat
4713 (if (or (equal keywords "ALL") (not keywords))
4714 (propertize "ALL" 'face 'warning)
4715 (mapconcat
4716 (lambda (kw)
4717 (propertize kw 'face (org-get-todo-face kw)))
4718 (org-split-string keywords "|")
4719 "|"))
4720 "\n"))
4722 (defvar org-select-this-todo-keyword nil)
4723 (defvar org-last-arg nil)
4725 ;;;###autoload
4726 (defun org-todo-list (&optional arg)
4727 "Show all (not done) TODO entries from all agenda file in a single list.
4728 The prefix arg can be used to select a specific TODO keyword and limit
4729 the list to these. When using \\[universal-argument], you will be prompted
4730 for a keyword. A numeric prefix directly selects the Nth keyword in
4731 `org-todo-keywords-1'."
4732 (interactive "P")
4733 (if org-agenda-overriding-arguments
4734 (setq arg org-agenda-overriding-arguments))
4735 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4736 (let* ((today (org-today))
4737 (date (calendar-gregorian-from-absolute today))
4738 (kwds org-todo-keywords-for-agenda)
4739 (completion-ignore-case t)
4740 (org-select-this-todo-keyword
4741 (if (stringp arg) arg
4742 (and arg (integerp arg) (> arg 0)
4743 (nth (1- arg) kwds))))
4744 rtn rtnall files file pos)
4745 (when (equal arg '(4))
4746 (setq org-select-this-todo-keyword
4747 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4748 (mapcar 'list kwds) nil nil)))
4749 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4750 (catch 'exit
4751 (if org-agenda-sticky
4752 (setq org-agenda-buffer-name
4753 (if (stringp org-select-this-todo-keyword)
4754 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4755 org-select-this-todo-keyword)
4756 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4757 (org-agenda-prepare "TODO")
4758 (org-compile-prefix-format 'todo)
4759 (org-set-sorting-strategy 'todo)
4760 (setq org-agenda-redo-command
4761 `(org-todo-list (or (and (numberp current-prefix-arg)
4762 current-prefix-arg)
4763 ,org-select-this-todo-keyword
4764 current-prefix-arg ,arg)))
4765 (setq files (org-agenda-files nil 'ifmode)
4766 rtnall nil)
4767 (while (setq file (pop files))
4768 (catch 'nextfile
4769 (org-check-agenda-file file)
4770 (setq rtn (org-agenda-get-day-entries file date :todo))
4771 (setq rtnall (append rtnall rtn))))
4772 (if org-agenda-overriding-header
4773 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4774 nil 'face 'org-agenda-structure) "\n")
4775 (insert "Global list of TODO items of type: ")
4776 (add-text-properties (point-min) (1- (point))
4777 (list 'face 'org-agenda-structure
4778 'short-heading
4779 (concat "ToDo: "
4780 (or org-select-this-todo-keyword "ALL"))))
4781 (org-agenda-mark-header-line (point-min))
4782 (insert (org-agenda-propertize-selected-todo-keywords
4783 org-select-this-todo-keyword))
4784 (setq pos (point))
4785 (unless org-agenda-multi
4786 (insert (substitute-command-keys "Available with \
4787 `N \\[org-agenda-redo]': (0)[ALL]"))
4788 (let ((n 0) s)
4789 (mapc (lambda (x)
4790 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4791 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4792 (insert "\n "))
4793 (insert " " s))
4794 kwds))
4795 (insert "\n"))
4796 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4797 (org-agenda-mark-header-line (point-min))
4798 (when rtnall
4799 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4800 (goto-char (point-min))
4801 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4802 (add-text-properties (point-min) (point-max)
4803 `(org-agenda-type todo
4804 org-last-args ,arg
4805 org-redo-cmd ,org-agenda-redo-command
4806 org-series-cmd ,org-cmd))
4807 (org-agenda-finalize)
4808 (setq buffer-read-only t))))
4810 ;;; Agenda tags match
4812 ;;;###autoload
4813 (defun org-tags-view (&optional todo-only match)
4814 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4815 The prefix arg TODO-ONLY limits the search to TODO entries."
4816 (interactive "P")
4817 (if org-agenda-overriding-arguments
4818 (setq todo-only (car org-agenda-overriding-arguments)
4819 match (nth 1 org-agenda-overriding-arguments)))
4820 (let* ((org-tags-match-list-sublevels
4821 org-tags-match-list-sublevels)
4822 (completion-ignore-case t)
4823 rtn rtnall files file pos matcher
4824 buffer)
4825 (when (and (stringp match) (not (string-match "\\S-" match)))
4826 (setq match nil))
4827 (catch 'exit
4828 (if org-agenda-sticky
4829 (setq org-agenda-buffer-name
4830 (if (stringp match)
4831 (format "*Org Agenda(%s:%s)*"
4832 (or org-keys (or (and todo-only "M") "m")) match)
4833 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4834 ;; Prepare agendas (and `org-tag-alist-for-agenda') before
4835 ;; expanding tags within `org-make-tags-matcher'
4836 (org-agenda-prepare (concat "TAGS " match))
4837 (setq matcher (org-make-tags-matcher match)
4838 match (car matcher) matcher (cdr matcher))
4839 (org-compile-prefix-format 'tags)
4840 (org-set-sorting-strategy 'tags)
4841 (setq org-agenda-query-string match)
4842 (setq org-agenda-redo-command
4843 (list 'org-tags-view `(quote ,todo-only)
4844 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4845 (setq files (org-agenda-files nil 'ifmode)
4846 rtnall nil)
4847 (while (setq file (pop files))
4848 (catch 'nextfile
4849 (org-check-agenda-file file)
4850 (setq buffer (if (file-exists-p file)
4851 (org-get-agenda-file-buffer file)
4852 (error "No such file %s" file)))
4853 (if (not buffer)
4854 ;; If file does not exist, error message to agenda
4855 (setq rtn (list
4856 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4857 rtnall (append rtnall rtn))
4858 (with-current-buffer buffer
4859 (unless (derived-mode-p 'org-mode)
4860 (error "Agenda file %s is not in `org-mode'" file))
4861 (save-excursion
4862 (save-restriction
4863 (if (eq buffer org-agenda-restrict)
4864 (narrow-to-region org-agenda-restrict-begin
4865 org-agenda-restrict-end)
4866 (widen))
4867 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4868 (setq rtnall (append rtnall rtn))))))))
4869 (if org-agenda-overriding-header
4870 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4871 nil 'face 'org-agenda-structure) "\n")
4872 (insert "Headlines with TAGS match: ")
4873 (add-text-properties (point-min) (1- (point))
4874 (list 'face 'org-agenda-structure
4875 'short-heading
4876 (concat "Match: " match)))
4877 (setq pos (point))
4878 (insert match "\n")
4879 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4880 (setq pos (point))
4881 (unless org-agenda-multi
4882 (insert (substitute-command-keys
4883 "Press `\\[universal-argument] \\[org-agenda-redo]' \
4884 to search again with new search string\n")))
4885 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4886 (org-agenda-mark-header-line (point-min))
4887 (when rtnall
4888 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4889 (goto-char (point-min))
4890 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4891 (add-text-properties (point-min) (point-max)
4892 `(org-agenda-type tags
4893 org-last-args (,todo-only ,match)
4894 org-redo-cmd ,org-agenda-redo-command
4895 org-series-cmd ,org-cmd))
4896 (org-agenda-finalize)
4897 (setq buffer-read-only t))))
4899 ;;; Agenda Finding stuck projects
4901 (defvar org-agenda-skip-regexp nil
4902 "Regular expression used in skipping subtrees for the agenda.
4903 This is basically a temporary global variable that can be set and then
4904 used by user-defined selections using `org-agenda-skip-function'.")
4906 (defvar org-agenda-overriding-header nil
4907 "When set during agenda, todo and tags searches it replaces the header.
4908 This variable should not be set directly, but custom commands can bind it
4909 in the options section.")
4911 (defun org-agenda-skip-entry-when-regexp-matches ()
4912 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4913 If yes, it returns the end position of this entry, causing agenda commands
4914 to skip the entry but continuing the search in the subtree. This is a
4915 function that can be put into `org-agenda-skip-function' for the duration
4916 of a command."
4917 (let ((end (save-excursion (org-end-of-subtree t)))
4918 skip)
4919 (save-excursion
4920 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4921 (and skip end)))
4923 (defun org-agenda-skip-subtree-when-regexp-matches ()
4924 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4925 If yes, it returns the end position of this tree, causing agenda commands
4926 to skip this subtree. This is a function that can be put into
4927 `org-agenda-skip-function' for the duration of a command."
4928 (let ((end (save-excursion (org-end-of-subtree t)))
4929 skip)
4930 (save-excursion
4931 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4932 (and skip end)))
4934 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4935 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4936 If yes, it returns the end position of the current entry (NOT the tree),
4937 causing agenda commands to skip the entry but continuing the search in
4938 the subtree. This is a function that can be put into
4939 `org-agenda-skip-function' for the duration of a command. An important
4940 use of this function is for the stuck project list."
4941 (let ((end (save-excursion (org-end-of-subtree t)))
4942 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4943 skip)
4944 (save-excursion
4945 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4946 (and skip entry-end)))
4948 (defun org-agenda-skip-entry-if (&rest conditions)
4949 "Skip entry if any of CONDITIONS is true.
4950 See `org-agenda-skip-if' for details."
4951 (org-agenda-skip-if nil conditions))
4953 (defun org-agenda-skip-subtree-if (&rest conditions)
4954 "Skip subtree if any of CONDITIONS is true.
4955 See `org-agenda-skip-if' for details."
4956 (org-agenda-skip-if t conditions))
4958 (defun org-agenda-skip-if (subtree conditions)
4959 "Checks current entity for CONDITIONS.
4960 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4961 the entry (i.e. the text before the next heading) is checked.
4963 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4964 from different tests. Valid conditions are:
4966 scheduled Check if there is a scheduled cookie
4967 notscheduled Check if there is no scheduled cookie
4968 deadline Check if there is a deadline
4969 notdeadline Check if there is no deadline
4970 timestamp Check if there is a timestamp (also deadline or scheduled)
4971 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4972 regexp Check if regexp matches
4973 notregexp Check if regexp does not match.
4974 todo Check if TODO keyword matches
4975 nottodo Check if TODO keyword does not match
4977 The regexp is taken from the conditions list, it must come right after
4978 the `regexp' or `notregexp' element.
4980 `todo' and `nottodo' accept as an argument a list of todo
4981 keywords, which may include \"*\" to match any todo keyword.
4983 (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
4985 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4987 Instead of a list, a keyword class may be given. For example:
4989 (org-agenda-skip-entry-if \\='nottodo \\='done)
4991 would skip entries that haven't been marked with any of \"DONE\"
4992 keywords. Possible classes are: `todo', `done', `any'.
4994 If any of these conditions is met, this function returns the end point of
4995 the entity, causing the search to continue from there. This is a function
4996 that can be put into `org-agenda-skip-function' for the duration of a command."
4997 (let (beg end m)
4998 (org-back-to-heading t)
4999 (setq beg (point)
5000 end (if subtree
5001 (progn (org-end-of-subtree t) (point))
5002 (progn (outline-next-heading) (1- (point)))))
5003 (goto-char beg)
5004 (and
5006 (and (memq 'scheduled conditions)
5007 (re-search-forward org-scheduled-time-regexp end t))
5008 (and (memq 'notscheduled conditions)
5009 (not (re-search-forward org-scheduled-time-regexp end t)))
5010 (and (memq 'deadline conditions)
5011 (re-search-forward org-deadline-time-regexp end t))
5012 (and (memq 'notdeadline conditions)
5013 (not (re-search-forward org-deadline-time-regexp end t)))
5014 (and (memq 'timestamp conditions)
5015 (re-search-forward org-ts-regexp end t))
5016 (and (memq 'nottimestamp conditions)
5017 (not (re-search-forward org-ts-regexp end t)))
5018 (and (setq m (memq 'regexp conditions))
5019 (stringp (nth 1 m))
5020 (re-search-forward (nth 1 m) end t))
5021 (and (setq m (memq 'notregexp conditions))
5022 (stringp (nth 1 m))
5023 (not (re-search-forward (nth 1 m) end t)))
5024 (and (or
5025 (setq m (memq 'nottodo conditions))
5026 (setq m (memq 'todo-unblocked conditions))
5027 (setq m (memq 'nottodo-unblocked conditions))
5028 (setq m (memq 'todo conditions)))
5029 (org-agenda-skip-if-todo m end)))
5030 end)))
5032 (defun org-agenda-skip-if-todo (args end)
5033 "Helper function for `org-agenda-skip-if', do not use it directly.
5034 ARGS is a list with first element either `todo', `nottodo',
5035 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
5036 a list of TODO keywords, or a state symbol `todo' or `done' or
5037 `any'."
5038 (let ((kw (car args))
5039 (arg (cadr args))
5040 todo-wds todo-re)
5041 (setq todo-wds
5042 (org-uniquify
5043 (cond
5044 ((listp arg) ;; list of keywords
5045 (if (member "*" arg)
5046 (mapcar 'substring-no-properties org-todo-keywords-1)
5047 arg))
5048 ((symbolp arg) ;; keyword class name
5049 (cond
5050 ((eq arg 'todo)
5051 (org-delete-all org-done-keywords
5052 (mapcar 'substring-no-properties
5053 org-todo-keywords-1)))
5054 ((eq arg 'done) org-done-keywords)
5055 ((eq arg 'any)
5056 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
5057 (setq todo-re
5058 (concat "^\\*+[ \t]+\\<\\("
5059 (mapconcat 'identity todo-wds "\\|")
5060 "\\)\\>"))
5061 (cond
5062 ((eq kw 'todo) (re-search-forward todo-re end t))
5063 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
5064 ((eq kw 'todo-unblocked)
5065 (catch 'unblocked
5066 (while (re-search-forward todo-re end t)
5067 (or (org-entry-blocked-p) (throw 'unblocked t)))
5068 nil))
5069 ((eq kw 'nottodo-unblocked)
5070 (catch 'unblocked
5071 (while (re-search-forward todo-re end t)
5072 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5076 ;;;###autoload
5077 (defun org-agenda-list-stuck-projects (&rest ignore)
5078 "Create agenda view for projects that are stuck.
5079 Stuck projects are project that have no next actions. For the definitions
5080 of what a project is and how to check if it stuck, customize the variable
5081 `org-stuck-projects'."
5082 (interactive)
5083 (let* ((org-agenda-skip-function
5084 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5085 ;; We could have used org-agenda-skip-if here.
5086 (org-agenda-overriding-header
5087 (or org-agenda-overriding-header "List of stuck projects: "))
5088 (matcher (nth 0 org-stuck-projects))
5089 (todo (nth 1 org-stuck-projects))
5090 (todo-wds (if (member "*" todo)
5091 (progn
5092 (org-agenda-prepare-buffers (org-agenda-files
5093 nil 'ifmode))
5094 (org-delete-all
5095 org-done-keywords-for-agenda
5096 (copy-sequence org-todo-keywords-for-agenda)))
5097 todo))
5098 (todo-re (concat "^\\*+[ \t]+\\("
5099 (mapconcat 'identity todo-wds "\\|")
5100 "\\)\\>"))
5101 (tags (nth 2 org-stuck-projects))
5102 (tags-re (if (member "*" tags)
5103 (concat org-outline-regexp-bol
5104 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5105 (if tags
5106 (concat org-outline-regexp-bol
5107 ".*:\\("
5108 (mapconcat 'identity tags "\\|")
5109 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5110 (gen-re (nth 3 org-stuck-projects))
5111 (re-list
5112 (delq nil
5113 (list
5114 (if todo todo-re)
5115 (if tags tags-re)
5116 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5117 gen-re)))))
5118 (setq org-agenda-skip-regexp
5119 (if re-list
5120 (mapconcat 'identity re-list "\\|")
5121 (error "No information how to identify unstuck projects")))
5122 (org-tags-view nil matcher)
5123 (setq org-agenda-buffer-name (buffer-name))
5124 (with-current-buffer org-agenda-buffer-name
5125 (setq org-agenda-redo-command
5126 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5128 ;;; Diary integration
5130 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5131 (defvar diary-list-entries-hook)
5132 (defvar diary-time-regexp)
5133 (defun org-get-entries-from-diary (date)
5134 "Get the (Emacs Calendar) diary entries for DATE."
5135 (require 'diary-lib)
5136 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5137 (diary-display-function 'diary-fancy-display)
5138 (pop-up-frames nil)
5139 (diary-list-entries-hook
5140 (cons 'org-diary-default-entry diary-list-entries-hook))
5141 (diary-file-name-prefix nil) ; turn this feature off
5142 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5143 entries
5144 (org-disable-agenda-to-diary t))
5145 (save-excursion
5146 (save-window-excursion
5147 (funcall (if (fboundp 'diary-list-entries)
5148 'diary-list-entries 'list-diary-entries)
5149 date 1)))
5150 (if (not (get-buffer diary-fancy-buffer))
5151 (setq entries nil)
5152 (with-current-buffer diary-fancy-buffer
5153 (setq buffer-read-only nil)
5154 (if (zerop (buffer-size))
5155 ;; No entries
5156 (setq entries nil)
5157 ;; Omit the date and other unnecessary stuff
5158 (org-agenda-cleanup-fancy-diary)
5159 ;; Add prefix to each line and extend the text properties
5160 (if (zerop (buffer-size))
5161 (setq entries nil)
5162 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5163 (setq entries
5164 (with-temp-buffer
5165 (insert entries) (goto-char (point-min))
5166 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5167 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5168 (replace-match (concat "; " (match-string 1)))))
5169 (buffer-string)))))
5170 (set-buffer-modified-p nil)
5171 (kill-buffer diary-fancy-buffer)))
5172 (when entries
5173 (setq entries (org-split-string entries "\n"))
5174 (setq entries
5175 (mapcar
5176 (lambda (x)
5177 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5178 ;; Extend the text properties to the beginning of the line
5179 (org-add-props x (text-properties-at (1- (length x)) x)
5180 'type "diary" 'date date 'face 'org-agenda-diary))
5181 entries)))))
5183 (defvar org-agenda-cleanup-fancy-diary-hook nil
5184 "Hook run when the fancy diary buffer is cleaned up.")
5186 (defun org-agenda-cleanup-fancy-diary ()
5187 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5188 This gets rid of the date, the underline under the date, and
5189 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5190 date. It also removes lines that contain only whitespace."
5191 (goto-char (point-min))
5192 (if (looking-at ".*?:[ \t]*")
5193 (progn
5194 (replace-match "")
5195 (re-search-forward "\n=+$" nil t)
5196 (replace-match "")
5197 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5198 (re-search-forward "\n=+$" nil t)
5199 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5200 (goto-char (point-min))
5201 (while (re-search-forward "^ +\n" nil t)
5202 (replace-match ""))
5203 (goto-char (point-min))
5204 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5205 (replace-match ""))
5206 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5208 ;; Make sure entries from the diary have the right text properties.
5209 (eval-after-load "diary-lib"
5210 '(if (boundp 'diary-modify-entry-list-string-function)
5211 ;; We can rely on the hook, nothing to do
5213 ;; Hook not available, must use advice to make this work
5214 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5215 "Make the position visible."
5216 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5217 (stringp string)
5218 buffer-file-name)
5219 (setq string (org-modify-diary-entry-string string))))))
5221 (defun org-modify-diary-entry-string (string)
5222 "Add text properties to string, allowing org-mode to act on it."
5223 (org-add-props string nil
5224 'mouse-face 'highlight
5225 'help-echo (if buffer-file-name
5226 (format "mouse-2 or RET jump to diary file %s"
5227 (abbreviate-file-name buffer-file-name))
5229 'org-agenda-diary-link t
5230 'org-marker (org-agenda-new-marker (point-at-bol))))
5232 (defun org-diary-default-entry ()
5233 "Add a dummy entry to the diary.
5234 Needed to avoid empty dates which mess up holiday display."
5235 ;; Catch the error if dealing with the new add-to-diary-alist
5236 (when org-disable-agenda-to-diary
5237 (condition-case nil
5238 (org-add-to-diary-list original-date "Org-mode dummy" "")
5239 (error
5240 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5242 (defun org-add-to-diary-list (&rest args)
5243 (if (fboundp 'diary-add-to-list)
5244 (apply 'diary-add-to-list args)
5245 (apply 'add-to-diary-list args)))
5247 (defvar org-diary-last-run-time nil)
5249 ;;;###autoload
5250 (defun org-diary (&rest args)
5251 "Return diary information from org files.
5252 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5253 It accesses org files and extracts information from those files to be
5254 listed in the diary. The function accepts arguments specifying what
5255 items should be listed. For a list of arguments allowed here, see the
5256 variable `org-agenda-entry-types'.
5258 The call in the diary file should look like this:
5260 &%%(org-diary) ~/path/to/some/orgfile.org
5262 Use a separate line for each org file to check. Or, if you omit the file name,
5263 all files listed in `org-agenda-files' will be checked automatically:
5265 &%%(org-diary)
5267 If you don't give any arguments (as in the example above), the default value
5268 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5269 So the example above may also be written as
5271 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5273 The function expects the lisp variables `entry' and `date' to be provided
5274 by the caller, because this is how the calendar works. Don't use this
5275 function from a program - use `org-agenda-get-day-entries' instead."
5276 (when (> (- (org-float-time)
5277 org-agenda-last-marker-time)
5279 ;; I am not sure if this works with sticky agendas, because the marker
5280 ;; list is then no longer a global variable.
5281 (org-agenda-reset-markers))
5282 (org-compile-prefix-format 'agenda)
5283 (org-set-sorting-strategy 'agenda)
5284 (setq args (or args org-agenda-entry-types))
5285 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5286 (list entry)
5287 (org-agenda-files t)))
5288 (time (org-float-time))
5289 file rtn results)
5290 (when (or (not org-diary-last-run-time)
5291 (> (- time
5292 org-diary-last-run-time)
5294 (org-agenda-prepare-buffers files))
5295 (setq org-diary-last-run-time time)
5296 ;; If this is called during org-agenda, don't return any entries to
5297 ;; the calendar. Org Agenda will list these entries itself.
5298 (if org-disable-agenda-to-diary (setq files nil))
5299 (while (setq file (pop files))
5300 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5301 (setq results (append results rtn)))
5302 (when results
5303 (setq results
5304 (mapcar (lambda (i) (replace-regexp-in-string
5305 org-bracket-link-regexp "\\3" i)) results))
5306 (concat (org-agenda-finalize-entries results) "\n"))))
5308 ;;; Agenda entry finders
5310 (defun org-agenda--timestamp-to-absolute (&rest args)
5311 "Call `org-time-string-to-absolute' with ARGS.
5312 However, throw `:skip' whenever an error is raised."
5313 (condition-case e
5314 (apply #'org-time-string-to-absolute args)
5315 (org-diary-sexp-no-match (throw :skip nil))
5316 (error
5317 (message "%s; Skipping entry" (error-message-string e))
5318 (throw :skip nil))))
5320 (defun org-agenda-get-day-entries (file date &rest args)
5321 "Does the work for `org-diary' and `org-agenda'.
5322 FILE is the path to a file to be checked for entries. DATE is date like
5323 the one returned by `calendar-current-date'. ARGS are symbols indicating
5324 which kind of entries should be extracted. For details about these, see
5325 the documentation of `org-diary'."
5326 (let* ((org-startup-folded nil)
5327 (org-startup-align-all-tables nil)
5328 (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
5329 (error "No such file %s" file))))
5330 (if (not buffer)
5331 ;; If file does not exist, signal it in diary nonetheless.
5332 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5333 (with-current-buffer buffer
5334 (unless (derived-mode-p 'org-mode)
5335 (error "Agenda file %s is not in `org-mode'" file))
5336 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5337 (save-excursion
5338 (save-restriction
5339 (if (eq buffer org-agenda-restrict)
5340 (narrow-to-region org-agenda-restrict-begin
5341 org-agenda-restrict-end)
5342 (widen))
5343 ;; Rationalize ARGS. Also make sure `:deadline' comes
5344 ;; first in order to populate DEADLINES before passing it.
5346 ;; We use `delq' since `org-uniquify' duplicates ARGS,
5347 ;; guarding us from modifying `org-agenda-entry-types'.
5348 (setf args (org-uniquify (or args org-agenda-entry-types)))
5349 (when (and (memq :scheduled args) (memq :scheduled* args))
5350 (setf args (delq :scheduled* args)))
5351 (cond
5352 ((memq :deadline args)
5353 (setf args (cons :deadline
5354 (delq :deadline (delq :deadline* args)))))
5355 ((memq :deadline* args)
5356 (setf args (cons :deadline* (delq :deadline* args)))))
5357 ;; Collect list of headlines. Return them flattened.
5358 (let ((case-fold-search nil) results deadlines)
5359 (dolist (arg args (apply #'nconc (nreverse results)))
5360 (pcase arg
5361 ((and :todo (guard (org-agenda-today-p date)))
5362 (push (org-agenda-get-todos) results))
5363 (:timestamp
5364 (push (org-agenda-get-blocks) results)
5365 (push (org-agenda-get-timestamps deadlines) results))
5366 (:sexp
5367 (push (org-agenda-get-sexps) results))
5368 (:scheduled
5369 (push (org-agenda-get-scheduled deadlines) results))
5370 (:scheduled*
5371 (push (org-agenda-get-scheduled deadlines t) results))
5372 (:closed
5373 (push (org-agenda-get-progress) results))
5374 (:deadline
5375 (setf deadlines (org-agenda-get-deadlines))
5376 (push deadlines results))
5377 (:deadline*
5378 (setf deadlines (org-agenda-get-deadlines t))
5379 (push deadlines results)))))))))))
5381 (defsubst org-em (x y list)
5382 "Is X or Y a member of LIST?"
5383 (or (memq x list) (memq y list)))
5385 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5386 (defvar org-agenda-sorting-strategy-selected nil)
5388 (defun org-agenda-entry-get-agenda-timestamp (pom)
5389 "Retrieve timestamp information for sorting agenda views.
5390 Given a point or marker POM, returns a cons cell of the timestamp
5391 and the timestamp type relevant for the sorting strategy in
5392 `org-agenda-sorting-strategy-selected'."
5393 (let (ts ts-date-type)
5394 (save-match-data
5395 (cond ((org-em 'scheduled-up 'scheduled-down
5396 org-agenda-sorting-strategy-selected)
5397 (setq ts (org-entry-get pom "SCHEDULED")
5398 ts-date-type " scheduled"))
5399 ((org-em 'deadline-up 'deadline-down
5400 org-agenda-sorting-strategy-selected)
5401 (setq ts (org-entry-get pom "DEADLINE")
5402 ts-date-type " deadline"))
5403 ((org-em 'ts-up 'ts-down
5404 org-agenda-sorting-strategy-selected)
5405 (setq ts (org-entry-get pom "TIMESTAMP")
5406 ts-date-type " timestamp"))
5407 ((org-em 'tsia-up 'tsia-down
5408 org-agenda-sorting-strategy-selected)
5409 (setq ts (org-entry-get pom "TIMESTAMP_IA")
5410 ts-date-type " timestamp_ia"))
5411 ((org-em 'timestamp-up 'timestamp-down
5412 org-agenda-sorting-strategy-selected)
5413 (setq ts (or (org-entry-get pom "SCHEDULED")
5414 (org-entry-get pom "DEADLINE")
5415 (org-entry-get pom "TIMESTAMP")
5416 (org-entry-get pom "TIMESTAMP_IA"))
5417 ts-date-type ""))
5418 (t (setq ts-date-type "")))
5419 (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
5420 ts-date-type))))
5422 (defun org-agenda-get-todos ()
5423 "Return the TODO information for agenda display."
5424 (let* ((props (list 'face nil
5425 'done-face 'org-agenda-done
5426 'org-not-done-regexp org-not-done-regexp
5427 'org-todo-regexp org-todo-regexp
5428 'org-complex-heading-regexp org-complex-heading-regexp
5429 'mouse-face 'highlight
5430 'help-echo
5431 (format "mouse-2 or RET jump to org file %s"
5432 (abbreviate-file-name buffer-file-name))))
5433 (regexp (format org-heading-keyword-regexp-format
5434 (cond
5435 ((and org-select-this-todo-keyword
5436 (equal org-select-this-todo-keyword "*"))
5437 org-todo-regexp)
5438 (org-select-this-todo-keyword
5439 (concat "\\("
5440 (mapconcat 'identity
5441 (org-split-string
5442 org-select-this-todo-keyword
5443 "|")
5444 "\\|") "\\)"))
5445 (t org-not-done-regexp))))
5446 marker priority category level tags todo-state
5447 ts-date ts-date-type ts-date-pair
5448 ee txt beg end inherited-tags todo-state-end-pos)
5449 (goto-char (point-min))
5450 (while (re-search-forward regexp nil t)
5451 (catch :skip
5452 (save-match-data
5453 (beginning-of-line)
5454 (org-agenda-skip)
5455 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5456 (unless (and (setq todo-state (org-get-todo-state))
5457 (setq todo-state-end-pos (match-end 2)))
5458 (goto-char end)
5459 (throw :skip nil))
5460 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5461 (goto-char (1+ beg))
5462 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5463 (throw :skip nil)))
5464 (goto-char (match-beginning 2))
5465 (setq marker (org-agenda-new-marker (match-beginning 0))
5466 category (org-get-category)
5467 ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
5468 ts-date (car ts-date-pair)
5469 ts-date-type (cdr ts-date-pair)
5470 txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
5471 inherited-tags
5472 (or (eq org-agenda-show-inherited-tags 'always)
5473 (and (listp org-agenda-show-inherited-tags)
5474 (memq 'todo org-agenda-show-inherited-tags))
5475 (and (eq org-agenda-show-inherited-tags t)
5476 (or (eq org-agenda-use-tag-inheritance t)
5477 (memq 'todo org-agenda-use-tag-inheritance))))
5478 tags (org-get-tags-at nil (not inherited-tags))
5479 level (make-string (org-reduced-level (org-outline-level)) ? )
5480 txt (org-agenda-format-item "" txt level category tags t)
5481 priority (1+ (org-get-priority txt)))
5482 (org-add-props txt props
5483 'org-marker marker 'org-hd-marker marker
5484 'priority priority
5485 'level level
5486 'ts-date ts-date
5487 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5488 (push txt ee)
5489 (if org-agenda-todo-list-sublevels
5490 (goto-char todo-state-end-pos)
5491 (org-end-of-subtree 'invisible))))
5492 (nreverse ee)))
5494 (defun org-agenda-todo-custom-ignore-p (time n)
5495 "Check whether timestamp is farther away than n number of days.
5496 This function is invoked if `org-agenda-todo-ignore-deadlines',
5497 `org-agenda-todo-ignore-scheduled' or
5498 `org-agenda-todo-ignore-timestamp' is set to an integer."
5499 (let ((days (org-time-stamp-to-now
5500 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5501 (if (>= n 0)
5502 (>= days n)
5503 (<= days n))))
5505 ;;;###autoload
5506 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5507 (&optional end)
5508 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5509 (when (or org-agenda-todo-ignore-with-date
5510 org-agenda-todo-ignore-scheduled
5511 org-agenda-todo-ignore-deadlines
5512 org-agenda-todo-ignore-timestamp)
5513 (setq end (or end (save-excursion (outline-next-heading) (point))))
5514 (save-excursion
5515 (or (and org-agenda-todo-ignore-with-date
5516 (re-search-forward org-ts-regexp end t))
5517 (and org-agenda-todo-ignore-scheduled
5518 (re-search-forward org-scheduled-time-regexp end t)
5519 (cond
5520 ((eq org-agenda-todo-ignore-scheduled 'future)
5521 (> (org-time-stamp-to-now
5522 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5523 ((eq org-agenda-todo-ignore-scheduled 'past)
5524 (<= (org-time-stamp-to-now
5525 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5526 ((numberp org-agenda-todo-ignore-scheduled)
5527 (org-agenda-todo-custom-ignore-p
5528 (match-string 1) org-agenda-todo-ignore-scheduled))
5529 (t)))
5530 (and org-agenda-todo-ignore-deadlines
5531 (re-search-forward org-deadline-time-regexp end t)
5532 (cond
5533 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5534 ((eq org-agenda-todo-ignore-deadlines 'far)
5535 (not (org-deadline-close (match-string 1))))
5536 ((eq org-agenda-todo-ignore-deadlines 'future)
5537 (> (org-time-stamp-to-now
5538 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5539 ((eq org-agenda-todo-ignore-deadlines 'past)
5540 (<= (org-time-stamp-to-now
5541 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5542 ((numberp org-agenda-todo-ignore-deadlines)
5543 (org-agenda-todo-custom-ignore-p
5544 (match-string 1) org-agenda-todo-ignore-deadlines))
5545 (t (org-deadline-close (match-string 1)))))
5546 (and org-agenda-todo-ignore-timestamp
5547 (let ((buffer (current-buffer))
5548 (regexp
5549 (concat
5550 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5551 (start (point)))
5552 ;; Copy current buffer into a temporary one
5553 (with-temp-buffer
5554 (insert-buffer-substring buffer start end)
5555 (goto-char (point-min))
5556 ;; Delete SCHEDULED and DEADLINE items
5557 (while (re-search-forward regexp end t)
5558 (delete-region (match-beginning 0) (match-end 0)))
5559 (goto-char (point-min))
5560 ;; No search for timestamp left
5561 (when (re-search-forward org-ts-regexp nil t)
5562 (cond
5563 ((eq org-agenda-todo-ignore-timestamp 'future)
5564 (> (org-time-stamp-to-now
5565 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5566 ((eq org-agenda-todo-ignore-timestamp 'past)
5567 (<= (org-time-stamp-to-now
5568 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5569 ((numberp org-agenda-todo-ignore-timestamp)
5570 (org-agenda-todo-custom-ignore-p
5571 (match-string 1) org-agenda-todo-ignore-timestamp))
5572 (t))))))))))
5574 (defun org-agenda-get-timestamps (&optional deadline-results)
5575 "Return the date stamp information for agenda display."
5576 (let* ((props (list 'face 'org-agenda-calendar-event
5577 'org-not-done-regexp org-not-done-regexp
5578 'org-todo-regexp org-todo-regexp
5579 'org-complex-heading-regexp org-complex-heading-regexp
5580 'mouse-face 'highlight
5581 'help-echo
5582 (format "mouse-2 or RET jump to org file %s"
5583 (abbreviate-file-name buffer-file-name))))
5584 (d1 (calendar-absolute-from-gregorian date))
5586 (deadline-position-alist
5587 (mapcar (lambda (a) (and (setq mm (get-text-property
5588 0 'org-hd-marker a))
5589 (cons (marker-position mm) a)))
5590 deadline-results))
5591 (remove-re org-ts-regexp)
5592 (regexp
5593 (concat
5594 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5595 (regexp-quote
5596 (substring
5597 (format-time-string
5598 (car org-time-stamp-formats)
5599 (apply 'encode-time ; DATE bound by calendar
5600 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5601 1 11))
5602 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5603 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5604 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5605 donep tmp priority category level ee txt timestr tags
5606 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5607 inherited-tags ts-date)
5608 (goto-char (point-min))
5609 (while (setq end-of-match (re-search-forward regexp nil t))
5610 (setq b0 (match-beginning 0)
5611 b3 (match-beginning 3) e3 (match-end 3)
5612 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5613 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5614 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5615 (member todo-state
5616 org-agenda-repeating-timestamp-show-all)))
5617 (catch :skip
5618 (and (org-at-date-range-p) (throw :skip nil))
5619 (org-agenda-skip)
5620 (if (and (match-end 1)
5621 (not (= d1 (org-agenda--timestamp-to-absolute
5622 (match-string 1) d1 nil show-all
5623 (current-buffer) b0))))
5624 (throw :skip nil))
5625 (if (and e3
5626 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5627 (throw :skip nil))
5628 (setq tmp (buffer-substring (max (point-min)
5629 (- b0 org-ds-keyword-length))
5631 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5632 inactivep (= (char-after b0) ?\[)
5633 deadlinep (string-match org-deadline-regexp tmp)
5634 scheduledp (string-match org-scheduled-regexp tmp)
5635 closedp (and org-agenda-include-inactive-timestamps
5636 (string-match org-closed-string tmp))
5637 clockp (and org-agenda-include-inactive-timestamps
5638 (or (string-match org-clock-string tmp)
5639 (string-match "]-+\\'" tmp)))
5640 warntime (get-text-property (point) 'org-appt-warntime)
5641 donep (member todo-state org-done-keywords))
5642 (if (or scheduledp deadlinep closedp clockp
5643 (and donep org-agenda-skip-timestamp-if-done))
5644 (throw :skip t))
5645 (if (string-match ">" timestr)
5646 ;; substring should only run to end of time stamp
5647 (setq timestr (substring timestr 0 (match-end 0))))
5648 (setq marker (org-agenda-new-marker b0)
5649 category (org-get-category b0))
5650 (save-excursion
5651 (if (not (re-search-backward org-outline-regexp-bol nil t))
5652 (throw :skip nil)
5653 (goto-char (match-beginning 0))
5654 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5655 (assoc (point) deadline-position-alist))
5656 (throw :skip nil))
5657 (setq hdmarker (org-agenda-new-marker)
5658 inherited-tags
5659 (or (eq org-agenda-show-inherited-tags 'always)
5660 (and (listp org-agenda-show-inherited-tags)
5661 (memq 'agenda org-agenda-show-inherited-tags))
5662 (and (eq org-agenda-show-inherited-tags t)
5663 (or (eq org-agenda-use-tag-inheritance t)
5664 (memq 'agenda org-agenda-use-tag-inheritance))))
5665 tags (org-get-tags-at nil (not inherited-tags))
5666 level (make-string (org-reduced-level (org-outline-level)) ? ))
5667 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5668 (setq head (or (match-string 1) ""))
5669 (setq txt (org-agenda-format-item
5670 (if inactivep org-agenda-inactive-leader nil)
5671 head level category tags timestr
5672 remove-re habitp)))
5673 (setq priority (org-get-priority txt))
5674 (org-add-props txt props 'priority priority
5675 'org-marker marker 'org-hd-marker hdmarker
5676 'date date
5677 'level level
5678 'ts-date
5679 (ignore-errors (org-time-string-to-absolute timestr))
5680 'todo-state todo-state
5681 'warntime warntime
5682 'type "timestamp")
5683 (push txt ee))
5684 (if org-agenda-skip-additional-timestamps-same-entry
5685 (outline-next-heading)
5686 (goto-char end-of-match))))
5687 (nreverse ee)))
5689 (defun org-agenda-get-sexps ()
5690 "Return the sexp information for agenda display."
5691 (require 'diary-lib)
5692 (let* ((props (list 'face 'org-agenda-calendar-sexp
5693 'mouse-face 'highlight
5694 'help-echo
5695 (format "mouse-2 or RET jump to org file %s"
5696 (abbreviate-file-name buffer-file-name))))
5697 (regexp "^&?%%(")
5698 marker category extra level ee txt tags entry
5699 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5700 (goto-char (point-min))
5701 (while (re-search-forward regexp nil t)
5702 (catch :skip
5703 (org-agenda-skip)
5704 (setq beg (match-beginning 0))
5705 (goto-char (1- (match-end 0)))
5706 (setq b (point))
5707 (forward-sexp 1)
5708 (setq sexp (buffer-substring b (point)))
5709 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5710 (org-trim (match-string 1))
5711 ""))
5712 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5713 (when result
5714 (setq marker (org-agenda-new-marker beg)
5715 level (make-string (org-reduced-level (org-outline-level)) ? )
5716 category (org-get-category beg)
5717 inherited-tags
5718 (or (eq org-agenda-show-inherited-tags 'always)
5719 (and (listp org-agenda-show-inherited-tags)
5720 (memq 'agenda org-agenda-show-inherited-tags))
5721 (and (eq org-agenda-show-inherited-tags t)
5722 (or (eq org-agenda-use-tag-inheritance t)
5723 (memq 'agenda org-agenda-use-tag-inheritance))))
5724 tags (org-get-tags-at nil (not inherited-tags))
5725 todo-state (org-get-todo-state)
5726 warntime (get-text-property (point) 'org-appt-warntime)
5727 extra nil)
5729 (dolist (r (if (stringp result)
5730 (list result)
5731 result)) ;; we expect a list here
5732 (when (and org-agenda-diary-sexp-prefix
5733 (string-match org-agenda-diary-sexp-prefix r))
5734 (setq extra (match-string 0 r)
5735 r (replace-match "" nil nil r)))
5736 (if (string-match "\\S-" r)
5737 (setq txt r)
5738 (setq txt "SEXP entry returned empty string"))
5739 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5740 (org-add-props txt props 'org-marker marker
5741 'date date 'todo-state todo-state
5742 'level level 'type "sexp" 'warntime warntime)
5743 (push txt ee)))))
5744 (nreverse ee)))
5746 ;; Calendar sanity: define some functions that are independent of
5747 ;; `calendar-date-style'.
5748 ;; Normally I would like to use ISO format when calling the diary functions,
5749 ;; but to make sure we still have Emacs 22 compatibility we bind
5750 ;; also `european-calendar-style' and use european format
5751 (defun org-anniversary (year month day &optional mark)
5752 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5753 (org-no-warnings
5754 (let ((calendar-date-style 'european) (european-calendar-style t))
5755 (diary-anniversary day month year mark))))
5756 (defun org-cyclic (N year month day &optional mark)
5757 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5758 (org-no-warnings
5759 (let ((calendar-date-style 'european) (european-calendar-style t))
5760 (diary-cyclic N day month year mark))))
5761 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5762 "Like `diary-block', but with fixed (ISO) order of arguments."
5763 (org-no-warnings
5764 (let ((calendar-date-style 'european) (european-calendar-style t))
5765 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5766 (defun org-date (year month day &optional mark)
5767 "Like `diary-date', but with fixed (ISO) order of arguments."
5768 (org-no-warnings
5769 (let ((calendar-date-style 'european) (european-calendar-style t))
5770 (diary-date day month year mark))))
5772 ;; Define the `org-class' function
5773 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5774 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5775 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5776 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5777 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5778 `holidays', then any date that is known by the Emacs calendar to be a
5779 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5780 then those holidays will be skipped."
5781 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5782 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5783 (d (calendar-absolute-from-gregorian date))
5784 (h (when skip-weeks (calendar-check-holidays date))))
5785 (and
5786 (<= date1 d)
5787 (<= d date2)
5788 (= (calendar-day-of-week date) dayname)
5789 (or (not skip-weeks)
5790 (progn
5791 (require 'cal-iso)
5792 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5793 (not (or (and h (memq 'holidays skip-weeks))
5794 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5795 entry)))
5797 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5798 "Like `org-class', but honor `calendar-date-style'.
5799 The order of the first 2 times 3 arguments depends on the variable
5800 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5801 So for American calendars, give this as MONTH DAY YEAR, for European as
5802 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5803 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5804 is any number of ISO weeks in the block period for which the item should
5805 be skipped.
5807 This function is here only for backward compatibility and it is deprecated,
5808 please use `org-class' instead."
5809 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5810 (date2 (org-order-calendar-date-args m2 d2 y2)))
5811 (org-class
5812 (nth 2 date1) (car date1) (nth 1 date1)
5813 (nth 2 date2) (car date2) (nth 1 date2)
5814 dayname skip-weeks)))
5815 (make-obsolete 'org-diary-class 'org-class "")
5817 (defalias 'org-get-closed 'org-agenda-get-progress)
5818 (defun org-agenda-get-progress ()
5819 "Return the logged TODO entries for agenda display."
5820 (let* ((props (list 'mouse-face 'highlight
5821 'org-not-done-regexp org-not-done-regexp
5822 'org-todo-regexp org-todo-regexp
5823 'org-complex-heading-regexp org-complex-heading-regexp
5824 'help-echo
5825 (format "mouse-2 or RET jump to org file %s"
5826 (abbreviate-file-name buffer-file-name))))
5827 (items (if (consp org-agenda-show-log-scoped)
5828 org-agenda-show-log-scoped
5829 (if (eq org-agenda-show-log-scoped 'clockcheck)
5830 '(clock)
5831 org-agenda-log-mode-items)))
5832 (parts
5833 (delq nil
5834 (list
5835 (if (memq 'closed items) (concat "\\<" org-closed-string))
5836 (if (memq 'clock items) (concat "\\<" org-clock-string))
5837 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5838 (parts-re (if parts (mapconcat 'identity parts "\\|")
5839 (error "`org-agenda-log-mode-items' is empty")))
5840 (regexp (concat
5841 "\\(" parts-re "\\)"
5842 " *\\["
5843 (regexp-quote
5844 (substring
5845 (format-time-string
5846 (car org-time-stamp-formats)
5847 (apply 'encode-time ; DATE bound by calendar
5848 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5849 1 11))))
5850 (org-agenda-search-headline-for-time nil)
5851 marker hdmarker priority category level tags closedp
5852 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5853 (goto-char (point-min))
5854 (while (re-search-forward regexp nil t)
5855 (catch :skip
5856 (org-agenda-skip)
5857 (setq marker (org-agenda-new-marker (match-beginning 0))
5858 closedp (equal (match-string 1) org-closed-string)
5859 statep (equal (string-to-char (match-string 1)) ?-)
5860 clockp (not (or closedp statep))
5861 state (and statep (match-string 2))
5862 category (org-get-category (match-beginning 0))
5863 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5864 (when (string-match "\\]" timestr)
5865 ;; substring should only run to end of time stamp
5866 (setq rest (substring timestr (match-end 0))
5867 timestr (substring timestr 0 (match-end 0)))
5868 (if (and (not closedp) (not statep)
5869 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5870 rest))
5871 (progn (setq timestr (concat (substring timestr 0 -1)
5872 "-" (match-string 1 rest) "]"))
5873 (setq clocked (match-string 2 rest)))
5874 (setq clocked "-")))
5875 (save-excursion
5876 (setq extra
5877 (cond
5878 ((not org-agenda-log-mode-add-notes) nil)
5879 (statep
5880 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5881 (match-string 1)))
5882 (clockp
5883 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5884 (match-string 1)))))
5885 (if (not (re-search-backward org-outline-regexp-bol nil t))
5886 (throw :skip nil)
5887 (goto-char (match-beginning 0))
5888 (setq hdmarker (org-agenda-new-marker)
5889 inherited-tags
5890 (or (eq org-agenda-show-inherited-tags 'always)
5891 (and (listp org-agenda-show-inherited-tags)
5892 (memq 'todo org-agenda-show-inherited-tags))
5893 (and (eq org-agenda-show-inherited-tags t)
5894 (or (eq org-agenda-use-tag-inheritance t)
5895 (memq 'todo org-agenda-use-tag-inheritance))))
5896 tags (org-get-tags-at nil (not inherited-tags))
5897 level (make-string (org-reduced-level (org-outline-level)) ? ))
5898 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5899 (setq txt (match-string 1))
5900 (when extra
5901 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5902 (setq txt (concat (substring txt 0 (match-beginning 1))
5903 " - " extra " " (match-string 2 txt)))
5904 (setq txt (concat txt " - " extra))))
5905 (setq txt (org-agenda-format-item
5906 (cond
5907 (closedp "Closed: ")
5908 (statep (concat "State: (" state ")"))
5909 (t (concat "Clocked: (" clocked ")")))
5910 txt level category tags timestr)))
5911 (setq priority 100000)
5912 (org-add-props txt props
5913 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5914 'priority priority 'level level
5915 'type "closed" 'date date
5916 'undone-face 'org-warning 'done-face 'org-agenda-done)
5917 (push txt ee))
5918 (goto-char (point-at-eol))))
5919 (nreverse ee)))
5921 (defun org-agenda-show-clocking-issues ()
5922 "Add overlays, showing issues with clocking.
5923 See also the user option `org-agenda-clock-consistency-checks'."
5924 (interactive)
5925 (let* ((org-time-clocksum-use-effort-durations nil)
5926 (pl org-agenda-clock-consistency-checks)
5927 (re (concat "^[ \t]*"
5928 org-clock-string
5929 "[ \t]+"
5930 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5931 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5932 (tlstart 0.)
5933 (tlend 0.)
5934 (maxtime (org-hh:mm-string-to-minutes
5935 (or (plist-get pl :max-duration) "24:00")))
5936 (mintime (org-hh:mm-string-to-minutes
5937 (or (plist-get pl :min-duration) 0)))
5938 (maxgap (org-hh:mm-string-to-minutes
5939 ;; default 30:00 means never complain
5940 (or (plist-get pl :max-gap) "30:00")))
5941 (gapok (mapcar 'org-hh:mm-string-to-minutes
5942 (plist-get pl :gap-ok-around)))
5943 (def-face (or (plist-get pl :default-face)
5944 '((:background "DarkRed") (:foreground "white"))))
5945 issue face m te ts dt ov)
5946 (goto-char (point-min))
5947 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5948 (setq issue nil face def-face)
5949 (catch 'next
5950 (setq m (org-get-at-bol 'org-marker)
5951 te nil ts nil)
5952 (unless (and m (markerp m))
5953 (setq issue "No valid clock line") (throw 'next t))
5954 (org-with-point-at m
5955 (save-excursion
5956 (goto-char (point-at-bol))
5957 (unless (looking-at re)
5958 (error "No valid Clock line")
5959 (throw 'next t))
5960 (unless (match-end 3)
5961 (setq issue "No end time"
5962 face (or (plist-get pl :no-end-time-face) face))
5963 (throw 'next t))
5964 (setq ts (match-string 1)
5965 te (match-string 3)
5966 ts (org-float-time
5967 (apply 'encode-time (org-parse-time-string ts)))
5968 te (org-float-time
5969 (apply 'encode-time (org-parse-time-string te)))
5970 dt (- te ts))))
5971 (cond
5972 ((> dt (* 60 maxtime))
5973 ;; a very long clocking chunk
5974 (setq issue (format "Clocking interval is very long: %s"
5975 (org-minutes-to-clocksum-string
5976 (floor (/ (float dt) 60.))))
5977 face (or (plist-get pl :long-face) face)))
5978 ((< dt (* 60 mintime))
5979 ;; a very short clocking chunk
5980 (setq issue (format "Clocking interval is very short: %s"
5981 (org-minutes-to-clocksum-string
5982 (floor (/ (float dt) 60.))))
5983 face (or (plist-get pl :short-face) face)))
5984 ((and (> tlend 0) (< ts tlend))
5985 ;; Two clock entries are overlapping
5986 (setq issue (format "Clocking overlap: %d minutes"
5987 (/ (- tlend ts) 60))
5988 face (or (plist-get pl :overlap-face) face)))
5989 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5990 ;; There is a gap, lets see if we need to report it
5991 (unless (org-agenda-check-clock-gap tlend ts gapok)
5992 (setq issue (format "Clocking gap: %d minutes"
5993 (/ (- ts tlend) 60))
5994 face (or (plist-get pl :gap-face) face))))
5995 (t nil)))
5996 (setq tlend (or te tlend) tlstart (or ts tlstart))
5997 (when issue
5998 ;; OK, there was some issue, add an overlay to show the issue
5999 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
6000 (overlay-put ov 'before-string
6001 (concat
6002 (org-add-props
6003 (format "%-43s" (concat " " issue))
6005 'face face)
6006 "\n"))
6007 (overlay-put ov 'evaporate t)))))
6009 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
6010 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
6011 (catch 'exit
6012 (unless ok-list
6013 ;; there are no OK times for gaps...
6014 (throw 'exit nil))
6015 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
6016 ;; This is more than 24 hours, so it is OK.
6017 ;; because we have at least one OK time, that must be in the
6018 ;; 24 hour interval.
6019 (throw 'exit t))
6020 ;; We have a shorter gap.
6021 ;; Now we have to get the minute of the day when these times are
6022 (let* ((t1dec (decode-time (seconds-to-time t1)))
6023 (t2dec (decode-time (seconds-to-time t2)))
6024 ;; compute the minute on the day
6025 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
6026 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
6027 (when (< min2 min1)
6028 ;; if min2 is smaller than min1, this means it is on the next day.
6029 ;; Wrap it to after midnight.
6030 (setq min2 (+ min2 1440)))
6031 ;; Now check if any of the OK times is in the gap
6032 (mapc (lambda (x)
6033 ;; Wrap the time to after midnight if necessary
6034 (if (< x min1) (setq x (+ x 1440)))
6035 ;; Check if in interval
6036 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
6037 ok-list)
6038 ;; Nope, this gap is not OK
6039 nil)))
6041 (defun org-agenda-get-deadlines (&optional with-hour)
6042 "Return the deadline information for agenda display.
6043 When WITH-HOUR is non-nil, only return deadlines with an hour
6044 specification like [h]h:mm."
6045 (let* ((props (list 'mouse-face 'highlight
6046 'org-not-done-regexp org-not-done-regexp
6047 'org-todo-regexp org-todo-regexp
6048 'org-complex-heading-regexp org-complex-heading-regexp
6049 'help-echo
6050 (format "mouse-2 or RET jump to org file %s"
6051 (abbreviate-file-name buffer-file-name))))
6052 (regexp (if with-hour
6053 org-deadline-time-hour-regexp
6054 org-deadline-time-regexp))
6055 (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
6056 (current (calendar-absolute-from-gregorian date))
6057 deadline-items)
6058 (goto-char (point-min))
6059 (while (re-search-forward regexp nil t)
6060 (catch :skip
6061 (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
6062 (org-agenda-skip)
6063 (let* ((s (match-string 1))
6064 (pos (1- (match-beginning 1)))
6065 (todo-state (save-match-data (org-get-todo-state)))
6066 (donep (member todo-state org-done-keywords))
6067 (show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6068 (member todo-state
6069 org-agenda-repeating-timestamp-show-all)))
6070 ;; DEADLINE is the current scheduled date. When it
6071 ;; contains a repeater and SHOW-ALL is non-nil,
6072 ;; LAST-REPEAT is the repeat closest to CURRENT.
6073 ;; Otherwise, LAST-REPEAT is equal to DEADLINE.
6074 (last-repeat (org-agenda--timestamp-to-absolute
6075 s current 'past show-all (current-buffer) pos))
6076 (deadline (org-agenda--timestamp-to-absolute s current))
6077 (diff (- last-repeat current))
6078 (suppress-prewarning
6079 (let ((scheduled
6080 (and org-agenda-skip-deadline-prewarning-if-scheduled
6081 (org-entry-get nil "SCHEDULED"))))
6082 (cond
6083 ((not scheduled) nil)
6084 ;; The current item has a scheduled date, so
6085 ;; evaluate its prewarning lead time.
6086 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6087 ;; Use global prewarning-restart lead time.
6088 org-agenda-skip-deadline-prewarning-if-scheduled)
6089 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6090 'pre-scheduled)
6091 ;; Set pre-warning to no earlier than SCHEDULED.
6092 (min (- last-repeat
6093 (org-agenda--timestamp-to-absolute
6094 scheduled current 'past show-all
6095 (current-buffer)
6096 (save-excursion
6097 (beginning-of-line)
6098 (1+ (search-forward org-deadline-string)))))
6099 org-deadline-warning-days))
6100 ;; Set pre-warning to deadline.
6101 (t 0))))
6102 (wdays (if suppress-prewarning
6103 (let ((org-deadline-warning-days suppress-prewarning))
6104 (org-get-wdays s))
6105 (org-get-wdays s))))
6106 ;; When to show a deadline in the calendar: if the
6107 ;; expiration is within WDAYS warning time. Past-due
6108 ;; deadlines are only shown on the current date
6109 (unless (or (and (<= diff wdays)
6110 (and todayp (not org-agenda-only-exact-dates)))
6111 (= diff 0))
6112 (throw :skip nil))
6113 ;; Skip done tasks if `org-agenda-skip-deadline-if-done' is
6114 ;; non-nil or if it isn't applicable to CURRENT deadline.
6115 (when (and donep
6116 (or org-agenda-skip-deadline-if-done
6117 (/= deadline current)))
6118 (throw :skip nil))
6119 (save-excursion
6120 (re-search-backward "^\\*+[ \t]+" nil t)
6121 (goto-char (match-end 0))
6122 (let* ((category (org-get-category))
6123 (level
6124 (make-string (org-reduced-level (org-outline-level)) ?\s))
6125 (head (buffer-substring (point) (line-end-position)))
6126 (inherited-tags
6127 (or (eq org-agenda-show-inherited-tags 'always)
6128 (and (listp org-agenda-show-inherited-tags)
6129 (memq 'agenda org-agenda-show-inherited-tags))
6130 (and (eq org-agenda-show-inherited-tags t)
6131 (or (eq org-agenda-use-tag-inheritance t)
6132 (memq 'agenda
6133 org-agenda-use-tag-inheritance)))))
6134 (tags (org-get-tags-at nil (not inherited-tags)))
6135 (timestr
6136 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6137 (concat (substring s (match-beginning 1)) " ")
6138 'time))
6139 (item
6140 (org-agenda-format-item
6141 ;; For past deadlines, make sure to report time
6142 ;; difference since date S, not since closest
6143 ;; repeater.
6144 (let ((diff (if (< (org-today) current) diff
6145 (- deadline current))))
6146 (if (= diff 0) (car org-agenda-deadline-leaders)
6147 (let ((future (nth 1 org-agenda-deadline-leaders))
6148 (past (nth 2 org-agenda-deadline-leaders)))
6149 (cond ((> diff 0) (format future diff))
6150 ((string= future past) (format past diff))
6151 (t (format past (abs diff)))))))
6152 head level category tags
6153 (and (= diff 0) timestr)))
6154 (face (org-agenda-deadline-face
6155 (- 1 (/ (float (- deadline current)) (max wdays 1)))))
6156 (upcomingp (and todayp (> diff 0)))
6157 (warntime (get-text-property (point) 'org-appt-warntime)))
6158 (org-add-props item props
6159 'org-marker (org-agenda-new-marker pos)
6160 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
6161 'warntime warntime
6162 'level level
6163 'ts-date deadline
6164 'priority (- (org-get-priority item) diff)
6165 'todo-state todo-state
6166 'type (if upcomingp "upcoming-deadline" "deadline")
6167 'date (if upcomingp date deadline)
6168 'face (if donep 'org-agenda-done face)
6169 'undone-face face
6170 'done-face 'org-agenda-done)
6171 (push item deadline-items))))))
6172 (nreverse deadline-items)))
6174 (defun org-agenda-deadline-face (fraction)
6175 "Return the face to displaying a deadline item.
6176 FRACTION is what fraction of the head-warning time has passed."
6177 (let ((faces org-agenda-deadline-faces) f)
6178 (catch 'exit
6179 (while (setq f (pop faces))
6180 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6182 (defun org-agenda-get-scheduled (&optional deadlines with-hour)
6183 "Return the scheduled information for agenda display.
6184 Optional argument DEADLINES is a list of deadline items to be
6185 displayed in agenda view. When WITH-HOUR is non-nil, only return
6186 scheduled items with an hour specification like [h]h:mm."
6187 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6188 'org-todo-regexp org-todo-regexp
6189 'org-complex-heading-regexp org-complex-heading-regexp
6190 'done-face 'org-agenda-done
6191 'mouse-face 'highlight
6192 'help-echo
6193 (format "mouse-2 or RET jump to org file %s"
6194 (abbreviate-file-name buffer-file-name))))
6195 (regexp (if with-hour
6196 org-scheduled-time-hour-regexp
6197 org-scheduled-time-regexp))
6198 (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
6199 (current (calendar-absolute-from-gregorian date))
6200 (deadline-pos
6201 (mapcar (lambda (d)
6202 (let ((m (get-text-property 0 'org-hd-marker d)))
6203 (and m (marker-position m))))
6204 deadlines))
6205 scheduled-items)
6206 (goto-char (point-min))
6207 (while (re-search-forward regexp nil t)
6208 (catch :skip
6209 (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
6210 (org-agenda-skip)
6211 (let* ((s (match-string 1))
6212 (pos (1- (match-beginning 1)))
6213 (todo-state (save-match-data (org-get-todo-state)))
6214 (donep (member todo-state org-done-keywords))
6215 (show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6216 (member todo-state
6217 org-agenda-repeating-timestamp-show-all)))
6218 ;; SCHEDULE is the current scheduled date. When it
6219 ;; contains a repeater and SHOW-ALL is non-nil,
6220 ;; LAST-REPEAT is the repeat closest to CURRENT.
6221 ;; Otherwise, LAST-REPEAT is equal to SCHEDULE.
6222 (last-repeat (org-agenda--timestamp-to-absolute
6223 s current 'past show-all (current-buffer) pos))
6224 (schedule (org-agenda--timestamp-to-absolute s current))
6225 (diff (- last-repeat current))
6226 (warntime (get-text-property (point) 'org-appt-warntime))
6227 (pastschedp (< schedule (org-today)))
6228 (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
6229 (suppress-delay
6230 (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
6231 (org-entry-get nil "DEADLINE"))))
6232 (cond
6233 ((not deadline) nil)
6234 ;; The current item has a deadline date, so
6235 ;; evaluate its delay time.
6236 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6237 ;; Use global delay time.
6238 (- org-agenda-skip-scheduled-delay-if-deadline))
6239 ((eq org-agenda-skip-scheduled-delay-if-deadline
6240 'post-deadline)
6241 ;; Set delay to no later than DEADLINE. If
6242 ;; DEADLINE has a repeater, compare last schedule
6243 ;; repeat and last deadline repeat.
6244 (min (- last-repeat
6245 (org-agenda--timestamp-to-absolute
6246 deadline current 'past show-all
6247 (current-buffer)
6248 (save-excursion
6249 (beginning-of-line)
6250 (1+ (search-forward org-deadline-string)))))
6251 org-scheduled-delay-days))
6252 (t 0))))
6253 (ddays
6254 (cond
6255 ;; Nullify delay when a repeater triggered already
6256 ;; and the delay is of the form --Xd.
6257 ((and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6258 (/= schedule last-repeat))
6260 (suppress-delay
6261 (let ((org-scheduled-delay-days suppress-delay))
6262 (org-get-wdays s t t)))
6263 (t (org-get-wdays s t)))))
6264 ;; Only show a scheduled item in the calendar if it is on or
6265 ;; past the current date. Skip it if it has been displayed
6266 ;; for more than `org-scheduled-past-days'.
6267 (unless (or (and (>= ddays 0) (= diff (- ddays)))
6268 (and (< (+ diff ddays) 0)
6269 (< (abs diff) org-scheduled-past-days)
6270 (and todayp (not org-agenda-only-exact-dates)))
6271 (and todayp
6272 habitp
6273 (bound-and-true-p org-habit-show-all-today)))
6274 (throw :skip nil))
6275 ;; Skip done habits, or tasks if
6276 ;; `org-agenda-skip-deadline-if-done' is non-nil or if it
6277 ;; was scheduled in the past anyway.
6278 (when (and donep
6279 (or org-agenda-skip-scheduled-if-done
6280 (/= schedule current)
6281 habitp))
6282 (throw :skip nil))
6283 ;; Skip entry if it already appears as a deadline, per
6284 ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
6285 ;; doesn't apply to habits.
6286 (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
6287 ((guard
6288 (or (not (assq (line-beginning-position 0) deadline-pos))
6289 habitp))
6290 nil)
6291 (`repeated-after-deadline
6292 (>= last-repeat
6293 (time-to-days (org-get-deadline-time (point)))))
6294 (`not-today pastschedp)
6295 (`t t)
6296 (_ nil))
6297 (throw :skip nil))
6298 ;; Skip habits if `org-habit-show-habits' is nil, or if we
6299 ;; only show them for today.
6300 (when (and habitp
6301 (or (not (bound-and-true-p org-habit-show-habits))
6302 (and (not todayp)
6303 (bound-and-true-p
6304 org-habit-show-habits-only-for-today))))
6305 (throw :skip nil))
6306 (save-excursion
6307 (re-search-backward "^\\*+[ \t]+" nil t)
6308 (goto-char (match-end 0))
6309 (let* ((category (org-get-category))
6310 (inherited-tags
6311 (or (eq org-agenda-show-inherited-tags 'always)
6312 (and (listp org-agenda-show-inherited-tags)
6313 (memq 'agenda org-agenda-show-inherited-tags))
6314 (and (eq org-agenda-show-inherited-tags t)
6315 (or (eq org-agenda-use-tag-inheritance t)
6316 (memq 'agenda
6317 org-agenda-use-tag-inheritance)))))
6318 (tags (org-get-tags-at nil (not inherited-tags)))
6319 (level
6320 (make-string (org-reduced-level (org-outline-level)) ?\s))
6321 (head (buffer-substring (point) (line-end-position)))
6322 (timestr
6323 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6324 (concat (substring s (match-beginning 1)) " ")
6325 'time))
6326 (item (org-agenda-format-item
6327 ;; For past scheduled dates, make sure to
6328 ;; report time difference since SCHEDULE,
6329 ;; not since closest repeater.
6330 (let ((diff (if (< (org-today) current) diff
6331 (- schedule current))))
6332 (if (= diff 0) (car org-agenda-scheduled-leaders)
6333 (format (nth 1 org-agenda-scheduled-leaders)
6334 (- 1 diff))))
6335 head level category tags
6336 (and (= diff 0) timestr)
6337 nil habitp))
6338 (face (cond ((and (not habitp) pastschedp)
6339 'org-scheduled-previously)
6340 (todayp 'org-scheduled-today)
6341 (t 'org-scheduled)))
6342 (habitp (and habitp (org-habit-parse-todo))))
6343 (org-add-props item props
6344 'undone-face face
6345 'face (if donep 'org-agenda-done face)
6346 'org-marker (org-agenda-new-marker pos)
6347 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
6348 'type (if pastschedp "past-scheduled" "scheduled")
6349 'date (if pastschedp schedule date)
6350 'ts-date schedule
6351 'warntime warntime
6352 'level level
6353 'priority (if habitp (org-habit-get-priority habitp)
6354 (+ 94 (- 5 diff) (org-get-priority item)))
6355 'org-habit-p habitp
6356 'todo-state todo-state)
6357 (push item scheduled-items))))))
6358 (nreverse scheduled-items)))
6360 (defun org-agenda-get-blocks ()
6361 "Return the date-range information for agenda display."
6362 (let* ((props (list 'face nil
6363 'org-not-done-regexp org-not-done-regexp
6364 'org-todo-regexp org-todo-regexp
6365 'org-complex-heading-regexp org-complex-heading-regexp
6366 'mouse-face 'highlight
6367 'help-echo
6368 (format "mouse-2 or RET jump to org file %s"
6369 (abbreviate-file-name buffer-file-name))))
6370 (regexp org-tr-regexp)
6371 (d0 (calendar-absolute-from-gregorian date))
6372 marker hdmarker ee txt d1 d2 s1 s2 category
6373 level todo-state tags pos head donep inherited-tags)
6374 (goto-char (point-min))
6375 (while (re-search-forward regexp nil t)
6376 (catch :skip
6377 (org-agenda-skip)
6378 (setq pos (point))
6379 (let ((start-time (match-string 1))
6380 (end-time (match-string 2)))
6381 (setq s1 (match-string 1)
6382 s2 (match-string 2)
6383 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6384 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6385 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6386 ;; Only allow days between the limits, because the normal
6387 ;; date stamps will catch the limits.
6388 (save-excursion
6389 (setq todo-state (org-get-todo-state))
6390 (setq donep (member todo-state org-done-keywords))
6391 (if (and donep org-agenda-skip-timestamp-if-done)
6392 (throw :skip t))
6393 (setq marker (org-agenda-new-marker (point))
6394 category (org-get-category))
6395 (if (not (re-search-backward org-outline-regexp-bol nil t))
6396 (throw :skip nil)
6397 (goto-char (match-beginning 0))
6398 (setq hdmarker (org-agenda-new-marker (point))
6399 inherited-tags
6400 (or (eq org-agenda-show-inherited-tags 'always)
6401 (and (listp org-agenda-show-inherited-tags)
6402 (memq 'agenda org-agenda-show-inherited-tags))
6403 (and (eq org-agenda-show-inherited-tags t)
6404 (or (eq org-agenda-use-tag-inheritance t)
6405 (memq 'agenda org-agenda-use-tag-inheritance))))
6407 tags (org-get-tags-at nil (not inherited-tags)))
6408 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6409 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6410 (setq head (match-string 1))
6411 (let ((remove-re
6412 (if org-agenda-remove-timeranges-from-blocks
6413 (concat
6414 "<" (regexp-quote s1) ".*?>"
6415 "--"
6416 "<" (regexp-quote s2) ".*?>")
6417 nil)))
6418 (setq txt (org-agenda-format-item
6419 (format
6420 (nth (if (= d1 d2) 0 1)
6421 org-agenda-timerange-leaders)
6422 (1+ (- d0 d1)) (1+ (- d2 d1)))
6423 head level category tags
6424 (cond ((and (= d1 d0) (= d2 d0))
6425 (concat "<" start-time ">--<" end-time ">"))
6426 ((= d1 d0)
6427 (concat "<" start-time ">"))
6428 ((= d2 d0)
6429 (concat "<" end-time ">")))
6430 remove-re))))
6431 (org-add-props txt props
6432 'org-marker marker 'org-hd-marker hdmarker
6433 'type "block" 'date date
6434 'level level
6435 'todo-state todo-state
6436 'priority (org-get-priority txt))
6437 (push txt ee))))
6438 (goto-char pos)))
6439 ;; Sort the entries by expiration date.
6440 (nreverse ee)))
6442 ;;; Agenda presentation and sorting
6444 (defvar org-prefix-has-time nil
6445 "A flag, set by `org-compile-prefix-format'.
6446 The flag is set if the currently compiled format contains a `%t'.")
6447 (defvar org-prefix-has-tag nil
6448 "A flag, set by `org-compile-prefix-format'.
6449 The flag is set if the currently compiled format contains a `%T'.")
6450 (defvar org-prefix-has-effort nil
6451 "A flag, set by `org-compile-prefix-format'.
6452 The flag is set if the currently compiled format contains a `%e'.")
6453 (defvar org-prefix-has-breadcrumbs nil
6454 "A flag, set by `org-compile-prefix-format'.
6455 The flag is set if the currently compiled format contains a `%b'.")
6456 (defvar org-prefix-category-length nil
6457 "Used by `org-compile-prefix-format' to remember the category field width.")
6458 (defvar org-prefix-category-max-length nil
6459 "Used by `org-compile-prefix-format' to remember the category field width.")
6461 (defun org-agenda-get-category-icon (category)
6462 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6463 (dolist (entry org-agenda-category-icon-alist)
6464 (when (org-string-match-p (car entry) category)
6465 (if (listp (cadr entry))
6466 (return (cadr entry))
6467 (return (apply 'create-image (cdr entry)))))))
6469 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6470 remove-re habitp)
6471 "Format TXT to be inserted into the agenda buffer.
6472 In particular, add the prefix and corresponding text properties.
6474 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6475 LEVEL may be a string to replace the `%l' specifier.
6476 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6477 category taken from local variable or file name. It will replace the `%c'
6478 specifier in the format.
6479 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6480 TXT for sorting of this entry, and for the `%t' specifier in the format.
6481 When DOTIME is a string, this string is searched for a time before TXT is.
6482 TAGS can be the tags of the headline.
6483 Any match of REMOVE-RE will be removed from TXT."
6484 ;; We keep the org-prefix-* variable values along with a compiled
6485 ;; formatter, so that multiple agendas existing at the same time do
6486 ;; not step on each other toes.
6488 ;; It was inconvenient to make these variables buffer local in
6489 ;; Agenda buffers, because this function expects to be called with
6490 ;; the buffer where item comes from being current, and not agenda
6491 ;; buffer
6492 (let* ((bindings (car org-prefix-format-compiled))
6493 (formatter (cadr org-prefix-format-compiled)))
6494 (loop for (var value) in bindings
6495 do (set var value))
6496 (save-match-data
6497 ;; Diary entries sometimes have extra whitespace at the beginning
6498 (setq txt (org-trim txt))
6500 ;; Fix the tags part in txt
6501 (setq txt (org-agenda-fix-displayed-tags
6502 txt tags
6503 org-agenda-show-inherited-tags
6504 org-agenda-hide-tags-regexp))
6506 (let* ((category (or category
6507 (if buffer-file-name
6508 (file-name-sans-extension
6509 (file-name-nondirectory buffer-file-name))
6510 "")))
6511 (category-icon (org-agenda-get-category-icon category))
6512 (category-icon (if category-icon
6513 (propertize " " 'display category-icon)
6514 ""))
6515 (effort (and (not (string= txt ""))
6516 (get-text-property 1 'effort txt)))
6517 ;; time, tag, effort are needed for the eval of the prefix format
6518 (tag (if tags (nth (1- (length tags)) tags) ""))
6519 time
6520 (ts (if dotime (concat
6521 (if (stringp dotime) dotime "")
6522 (and org-agenda-search-headline-for-time txt))))
6523 (time-of-day (and dotime (org-get-time-of-day ts)))
6524 stamp plain s0 s1 s2 rtn srp l
6525 duration breadcrumbs)
6526 (and (derived-mode-p 'org-mode) buffer-file-name
6527 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6528 (when (and dotime time-of-day)
6529 ;; Extract starting and ending time and move them to prefix
6530 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6531 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6532 (setq s0 (match-string 0 ts)
6533 srp (and stamp (match-end 3))
6534 s1 (match-string (if plain 1 2) ts)
6535 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6537 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6538 ;; them, we might want to remove them there to avoid duplication.
6539 ;; The user can turn this off with a variable.
6540 (if (and org-prefix-has-time
6541 org-agenda-remove-times-when-in-prefix (or stamp plain)
6542 (string-match (concat (regexp-quote s0) " *") txt)
6543 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6544 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6545 (= (match-beginning 0) 0)
6547 (setq txt (replace-match "" nil nil txt))))
6548 ;; Normalize the time(s) to 24 hour
6549 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6550 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6552 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6553 (let (org-time-clocksum-use-effort-durations)
6554 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6555 (setq s2
6556 (org-minutes-to-clocksum-string
6557 (+ (org-hh:mm-string-to-minutes s1)
6558 org-agenda-default-appointment-duration)))))
6560 ;; Compute the duration
6561 (when s2
6562 (setq duration (- (org-hh:mm-string-to-minutes s2)
6563 (org-hh:mm-string-to-minutes s1)))))
6565 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6566 txt)
6567 ;; Tags are in the string
6568 (if (or (eq org-agenda-remove-tags t)
6569 (and org-agenda-remove-tags
6570 org-prefix-has-tag))
6571 (setq txt (replace-match "" t t txt))
6572 (setq txt (replace-match
6573 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6574 (match-string 2 txt))
6575 t t txt))))
6577 (when remove-re
6578 (while (string-match remove-re txt)
6579 (setq txt (replace-match "" t t txt))))
6581 ;; Set org-heading property on `txt' to mark the start of the
6582 ;; heading.
6583 (add-text-properties 0 (length txt) '(org-heading t) txt)
6585 ;; Prepare the variables needed in the eval of the compiled format
6586 (if org-prefix-has-breadcrumbs
6587 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6588 (let ((s (org-display-outline-path nil nil "->" t)))
6589 (if (eq "" s) "" (concat s "->"))))))
6590 (setq time (cond (s2 (concat
6591 (org-agenda-time-of-day-to-ampm-maybe s1)
6592 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6593 (if org-agenda-timegrid-use-ampm " ")))
6594 (s1 (concat
6595 (org-agenda-time-of-day-to-ampm-maybe s1)
6596 (if org-agenda-timegrid-use-ampm
6597 "........ "
6598 "......")))
6599 (t ""))
6600 extra (or (and (not habitp) extra) "")
6601 category (if (symbolp category) (symbol-name category) category)
6602 level (or level ""))
6603 (if (string-match org-bracket-link-regexp category)
6604 (progn
6605 (setq l (if (match-end 3)
6606 (- (match-end 3) (match-beginning 3))
6607 (- (match-end 1) (match-beginning 1))))
6608 (when (< l (or org-prefix-category-length 0))
6609 (setq category (copy-sequence category))
6610 (org-add-props category nil
6611 'extra-space (make-string
6612 (- org-prefix-category-length l 1) ?\ ))))
6613 (if (and org-prefix-category-max-length
6614 (>= (length category) org-prefix-category-max-length))
6615 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6616 ;; Evaluate the compiled format
6617 (setq rtn (concat (eval formatter) txt))
6619 ;; And finally add the text properties
6620 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6621 (org-add-props rtn nil
6622 'org-category category
6623 'tags (mapcar 'org-downcase-keep-props tags)
6624 'org-highest-priority org-highest-priority
6625 'org-lowest-priority org-lowest-priority
6626 'time-of-day time-of-day
6627 'duration duration
6628 'breadcrumbs breadcrumbs
6629 'txt txt
6630 'level level
6631 'time time
6632 'extra extra
6633 'format org-prefix-format-compiled
6634 'dotime dotime)))))
6636 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6637 "Remove tags string from TXT, and add a modified list of tags.
6638 The modified list may contain inherited tags, and tags matched by
6639 `org-agenda-hide-tags-regexp' will be removed."
6640 (when (or add-inherited hide-re)
6641 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6642 (setq txt (substring txt 0 (match-beginning 0))))
6643 (setq tags
6644 (delq nil
6645 (mapcar (lambda (tg)
6646 (if (or (and hide-re (string-match hide-re tg))
6647 (and (not add-inherited)
6648 (get-text-property 0 'inherited tg)))
6650 tg))
6651 tags)))
6652 (when tags
6653 (let ((have-i (get-text-property 0 'inherited (car tags)))
6655 (setq txt (concat txt " :"
6656 (mapconcat
6657 (lambda (x)
6658 (setq i (get-text-property 0 'inherited x))
6659 (if (and have-i (not i))
6660 (progn
6661 (setq have-i nil)
6662 (concat ":" x))
6664 tags ":")
6665 (if have-i "::" ":"))))))
6666 txt)
6668 (defun org-downcase-keep-props (s)
6669 (let ((props (text-properties-at 0 s)))
6670 (setq s (downcase s))
6671 (add-text-properties 0 (length s) props s)
6674 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6676 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6677 "Add a time-grid for agenda items which need it.
6679 LIST is the list of agenda items formatted by `org-agenda-list'.
6680 NDAYS is the span of the current agenda view.
6681 TODAYP is t when the current agenda view is on today."
6682 (catch 'exit
6683 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6684 ((and todayp (member 'today (car org-agenda-time-grid))))
6685 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6686 ((member 'weekly (car org-agenda-time-grid)))
6687 (t (throw 'exit list)))
6688 (let* ((have (delq nil (mapcar
6689 (lambda (x) (get-text-property 1 'time-of-day x))
6690 list)))
6691 (string (nth 1 org-agenda-time-grid))
6692 (gridtimes (nth 2 org-agenda-time-grid))
6693 (req (car org-agenda-time-grid))
6694 (remove (member 'remove-match req))
6695 new time)
6696 (if (and (member 'require-timed req) (not have))
6697 ;; don't show empty grid
6698 (throw 'exit list))
6699 (while (setq time (pop gridtimes))
6700 (unless (and remove (member time have))
6701 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6702 (push (org-agenda-format-item
6703 nil string nil "" nil
6704 (concat (substring time 0 -2) ":" (substring time -2)))
6705 new)
6706 (put-text-property
6707 2 (length (car new)) 'face 'org-time-grid (car new))))
6708 (when (and todayp org-agenda-show-current-time-in-grid)
6709 (push (org-agenda-format-item
6710 nil org-agenda-current-time-string nil "" nil
6711 (format-time-string "%H:%M "))
6712 new)
6713 (put-text-property
6714 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6716 (if (member 'time-up org-agenda-sorting-strategy-selected)
6717 (append new list)
6718 (append list new)))))
6720 (defun org-compile-prefix-format (key)
6721 "Compile the prefix format into a Lisp form that can be evaluated.
6722 The resulting form and associated variable bindings is returned
6723 and stored in the variable `org-prefix-format-compiled'."
6724 (setq org-prefix-has-time nil
6725 org-prefix-has-tag nil
6726 org-prefix-category-length nil
6727 org-prefix-has-effort nil
6728 org-prefix-has-breadcrumbs nil)
6729 (let ((s (cond
6730 ((stringp org-agenda-prefix-format)
6731 org-agenda-prefix-format)
6732 ((assq key org-agenda-prefix-format)
6733 (cdr (assq key org-agenda-prefix-format)))
6734 (t " %-12:c%?-12t% s")))
6735 (start 0)
6736 varform vars var e c f opt)
6737 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6738 s start)
6739 (setq var (or (cdr (assoc (match-string 4 s)
6740 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6741 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6742 'eval)
6743 c (or (match-string 3 s) "")
6744 opt (match-beginning 1)
6745 start (1+ (match-beginning 0)))
6746 (if (equal var 'time) (setq org-prefix-has-time t))
6747 (if (equal var 'tag) (setq org-prefix-has-tag t))
6748 (if (equal var 'effort) (setq org-prefix-has-effort t))
6749 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6750 (setq f (concat "%" (match-string 2 s) "s"))
6751 (when (equal var 'category)
6752 (setq org-prefix-category-length
6753 (floor (abs (string-to-number (match-string 2 s)))))
6754 (setq org-prefix-category-max-length
6755 (let ((x (match-string 2 s)))
6756 (save-match-data
6757 (if (string-match "\\.[0-9]+" x)
6758 (string-to-number (substring (match-string 0 x) 1)))))))
6759 (if (eq var 'eval)
6760 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6761 (if opt
6762 (setq varform
6763 `(if (or (equal "" ,var) (equal nil ,var))
6765 (format ,f (concat ,var ,c))))
6766 (setq varform
6767 `(format ,f (if (or (equal ,var "")
6768 (equal ,var nil)) ""
6769 (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6770 (setq s (replace-match "%s" t nil s))
6771 (push varform vars))
6772 (setq vars (nreverse vars))
6773 (with-current-buffer (or org-agenda-buffer (current-buffer))
6774 (setq org-prefix-format-compiled
6775 (list
6776 `((org-prefix-has-time ,org-prefix-has-time)
6777 (org-prefix-has-tag ,org-prefix-has-tag)
6778 (org-prefix-category-length ,org-prefix-category-length)
6779 (org-prefix-has-effort ,org-prefix-has-effort)
6780 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6781 `(format ,s ,@vars))))))
6783 (defun org-set-sorting-strategy (key)
6784 (if (symbolp (car org-agenda-sorting-strategy))
6785 ;; the old format
6786 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6787 (setq org-agenda-sorting-strategy-selected
6788 (or (cdr (assq key org-agenda-sorting-strategy))
6789 (cdr (assq 'agenda org-agenda-sorting-strategy))
6790 '(time-up category-keep priority-down)))))
6792 (defun org-get-time-of-day (s &optional string mod24)
6793 "Check string S for a time of day.
6794 If found, return it as a military time number between 0 and 2400.
6795 If not found, return nil.
6796 The optional STRING argument forces conversion into a 5 character wide string
6797 HH:MM."
6798 (save-match-data
6799 (when
6800 (and
6801 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6802 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6803 (not (eq (get-text-property 1 'face s) 'org-link)))
6804 (let* ((h (string-to-number (match-string 1 s)))
6805 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6806 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6807 (am-p (equal ampm "am"))
6808 (h1 (cond ((not ampm) h)
6809 ((= h 12) (if am-p 0 12))
6810 (t (+ h (if am-p 0 12)))))
6811 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6812 (mod h1 24) h1))
6813 (t0 (+ (* 100 h2) m))
6814 (t1 (concat (if (>= h1 24) "+" " ")
6815 (if (and org-agenda-time-leading-zero
6816 (< t0 1000)) "0" "")
6817 (if (< t0 100) "0" "")
6818 (if (< t0 10) "0" "")
6819 (int-to-string t0))))
6820 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6822 (defvar org-agenda-before-sorting-filter-function nil
6823 "Function to be applied to agenda items prior to sorting.
6824 Prior to sorting also means just before they are inserted into the agenda.
6826 To aid sorting, you may revisit the original entries and add more text
6827 properties which will later be used by the sorting functions.
6829 The function should take a string argument, an agenda line.
6830 It has access to the text properties in that line, which contain among
6831 other things, the property `org-hd-marker' that points to the entry
6832 where the line comes from. Note that not all lines going into the agenda
6833 have this property, only most.
6835 The function should return the modified string. It is probably best
6836 to ONLY change text properties.
6838 You can also use this function as a filter, by returning nil for lines
6839 you don't want to have in the agenda at all. For this application, you
6840 could bind the variable in the options section of a custom command.")
6842 (defun org-agenda-finalize-entries (list &optional type)
6843 "Sort, limit and concatenate the LIST of agenda items.
6844 The optional argument TYPE tells the agenda type."
6845 (let ((max-effort (cond ((listp org-agenda-max-effort)
6846 (cdr (assoc type org-agenda-max-effort)))
6847 (t org-agenda-max-effort)))
6848 (max-todo (cond ((listp org-agenda-max-todos)
6849 (cdr (assoc type org-agenda-max-todos)))
6850 (t org-agenda-max-todos)))
6851 (max-tags (cond ((listp org-agenda-max-tags)
6852 (cdr (assoc type org-agenda-max-tags)))
6853 (t org-agenda-max-tags)))
6854 (max-entries (cond ((listp org-agenda-max-entries)
6855 (cdr (assoc type org-agenda-max-entries)))
6856 (t org-agenda-max-entries))))
6857 (when org-agenda-before-sorting-filter-function
6858 (setq list
6859 (delq nil
6860 (mapcar
6861 org-agenda-before-sorting-filter-function list))))
6862 (setq list (mapcar 'org-agenda-highlight-todo list)
6863 list (mapcar 'identity (sort list 'org-entries-lessp)))
6864 (when max-effort
6865 (setq list (org-agenda-limit-entries
6866 list 'effort-minutes max-effort
6867 (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
6868 32767 -1))))))
6869 (when max-todo
6870 (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
6871 (when max-tags
6872 (setq list (org-agenda-limit-entries list 'tags max-tags)))
6873 (when max-entries
6874 (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
6875 (mapconcat 'identity list "\n")))
6877 (defun org-agenda-limit-entries (list prop limit &optional fn)
6878 "Limit the number of agenda entries."
6879 (let ((include (and limit (< limit 0))))
6880 (if limit
6881 (let ((fun (or fn (lambda (p) (if p 1))))
6882 (lim 0))
6883 (delq nil
6884 (mapcar
6885 (lambda (e)
6886 (let ((pval (funcall
6887 fun (get-text-property (1- (length e))
6888 prop e))))
6889 (if pval (setq lim (+ lim pval)))
6890 (cond ((and pval (<= lim (abs limit))) e)
6891 ((and include (not pval)) e))))
6892 list)))
6893 list)))
6895 (defun org-agenda-limit-interactively (remove)
6896 "In agenda, interactively limit entries to various maximums."
6897 (interactive "P")
6898 (if remove
6899 (progn (setq org-agenda-max-entries nil
6900 org-agenda-max-todos nil
6901 org-agenda-max-tags nil
6902 org-agenda-max-effort nil)
6903 (org-agenda-redo))
6904 (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
6905 (msg (cond ((= max ?E) "How many minutes? ")
6906 ((= max ?e) "How many entries? ")
6907 ((= max ?t) "How many TODO entries? ")
6908 ((= max ?T) "How many tagged entries? ")
6909 (t (user-error "Wrong input"))))
6910 (num (string-to-number (read-from-minibuffer msg))))
6911 (cond ((equal max ?e)
6912 (let ((org-agenda-max-entries num)) (org-agenda-redo)))
6913 ((equal max ?t)
6914 (let ((org-agenda-max-todos num)) (org-agenda-redo)))
6915 ((equal max ?T)
6916 (let ((org-agenda-max-tags num)) (org-agenda-redo)))
6917 ((equal max ?E)
6918 (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
6919 (org-agenda-fit-window-to-buffer))
6921 (defun org-agenda-highlight-todo (x)
6922 (let ((org-done-keywords org-done-keywords-for-agenda)
6923 (case-fold-search nil)
6925 (if (eq x 'line)
6926 (save-excursion
6927 (beginning-of-line 1)
6928 (setq re (org-get-at-bol 'org-todo-regexp))
6929 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6930 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6931 (add-text-properties (match-beginning 0) (match-end 1)
6932 (list 'face (org-get-todo-face 1)))
6933 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6934 (delete-region (match-beginning 1) (1- (match-end 0)))
6935 (goto-char (match-beginning 1))
6936 (insert (format org-agenda-todo-keyword-format s)))))
6937 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6938 (setq re (get-text-property 0 'org-todo-regexp x))
6939 (when (and re
6940 ;; Test `pl' because if there's no heading content,
6941 ;; there's no point matching to highlight. Note
6942 ;; that if we didn't test `pl' first, and there
6943 ;; happened to be no keyword from `org-todo-regexp'
6944 ;; on this heading line, then the `equal' comparison
6945 ;; afterwards would spuriously succeed in the case
6946 ;; where `pl' is nil -- causing an args-out-of-range
6947 ;; error when we try to add text properties to text
6948 ;; that isn't there.
6950 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6951 x pl) pl))
6952 (add-text-properties
6953 (or (match-end 1) (match-end 0)) (match-end 0)
6954 (list 'face (org-get-todo-face (match-string 2 x)))
6956 (when (match-end 1)
6957 (setq x (concat (substring x 0 (match-end 1))
6958 (format org-agenda-todo-keyword-format
6959 (match-string 2 x))
6960 (org-add-props " " (text-properties-at 0 x))
6961 (substring x (match-end 3)))))))
6962 x)))
6964 (defsubst org-cmp-values (a b property)
6965 "Compare the numeric value of text PROPERTY for string A and B."
6966 (let ((pa (or (get-text-property (1- (length a)) property a) 0))
6967 (pb (or (get-text-property (1- (length b)) property b) 0)))
6968 (cond ((> pa pb) +1)
6969 ((< pa pb) -1))))
6971 (defsubst org-cmp-effort (a b)
6972 "Compare the effort values of string A and B."
6973 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6974 (ea (or (get-text-property (1- (length a)) 'effort-minutes a) def))
6975 (eb (or (get-text-property (1- (length b)) 'effort-minutes b) def)))
6976 (cond ((> ea eb) +1)
6977 ((< ea eb) -1))))
6979 (defsubst org-cmp-category (a b)
6980 "Compare the string values of categories of strings A and B."
6981 (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
6982 (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
6983 (cond ((string-lessp ca cb) -1)
6984 ((string-lessp cb ca) +1))))
6986 (defsubst org-cmp-todo-state (a b)
6987 "Compare the todo states of strings A and B."
6988 (let* ((ma (or (get-text-property 1 'org-marker a)
6989 (get-text-property 1 'org-hd-marker a)))
6990 (mb (or (get-text-property 1 'org-marker b)
6991 (get-text-property 1 'org-hd-marker b)))
6992 (fa (and ma (marker-buffer ma)))
6993 (fb (and mb (marker-buffer mb)))
6994 (todo-kwds
6995 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6996 (and fb (with-current-buffer fb org-todo-keywords-1))))
6997 (ta (or (get-text-property 1 'todo-state a) ""))
6998 (tb (or (get-text-property 1 'todo-state b) ""))
6999 (la (- (length (member ta todo-kwds))))
7000 (lb (- (length (member tb todo-kwds))))
7001 (donepa (member ta org-done-keywords-for-agenda))
7002 (donepb (member tb org-done-keywords-for-agenda)))
7003 (cond ((and donepa (not donepb)) -1)
7004 ((and (not donepa) donepb) +1)
7005 ((< la lb) -1)
7006 ((< lb la) +1))))
7008 (defsubst org-cmp-alpha (a b)
7009 "Compare the headlines, alphabetically."
7010 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
7011 (plb (text-property-any 0 (length b) 'org-heading t b))
7012 (ta (and pla (substring a pla)))
7013 (tb (and plb (substring b plb))))
7014 (when pla
7015 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
7016 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
7017 (setq ta (substring ta (match-end 0))))
7018 (setq ta (downcase ta)))
7019 (when plb
7020 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
7021 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
7022 (setq tb (substring tb (match-end 0))))
7023 (setq tb (downcase tb)))
7024 (cond ((not ta) +1)
7025 ((not tb) -1)
7026 ((string-lessp ta tb) -1)
7027 ((string-lessp tb ta) +1))))
7029 (defsubst org-cmp-tag (a b)
7030 "Compare the string values of the first tags of A and B."
7031 (let ((ta (car (last (get-text-property 1 'tags a))))
7032 (tb (car (last (get-text-property 1 'tags b)))))
7033 (cond ((not ta) +1)
7034 ((not tb) -1)
7035 ((string-lessp ta tb) -1)
7036 ((string-lessp tb ta) +1))))
7038 (defsubst org-cmp-time (a b)
7039 "Compare the time-of-day values of strings A and B."
7040 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
7041 (ta (or (get-text-property 1 'time-of-day a) def))
7042 (tb (or (get-text-property 1 'time-of-day b) def)))
7043 (cond ((< ta tb) -1)
7044 ((< tb ta) +1))))
7046 (defsubst org-cmp-ts (a b type)
7047 "Compare the timestamps values of entries A and B.
7048 When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
7049 \"timestamp_ia\", compare within each of these type. When TYPE
7050 is the empty string, compare all timestamps without respect of
7051 their type."
7052 (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
7053 (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
7054 (get-text-property 1 'ts-date a))
7055 def))
7056 (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
7057 (get-text-property 1 'ts-date b))
7058 def)))
7059 (cond ((< ta tb) -1)
7060 ((< tb ta) +1))))
7062 (defsubst org-cmp-habit-p (a b)
7063 "Compare the todo states of strings A and B."
7064 (let ((ha (get-text-property 1 'org-habit-p a))
7065 (hb (get-text-property 1 'org-habit-p b)))
7066 (cond ((and ha (not hb)) -1)
7067 ((and (not ha) hb) +1))))
7069 (defun org-entries-lessp (a b)
7070 "Predicate for sorting agenda entries."
7071 ;; The following variables will be used when the form is evaluated.
7072 ;; So even though the compiler complains, keep them.
7073 (let* ((ss org-agenda-sorting-strategy-selected)
7074 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
7075 (org-cmp-ts a b "")))
7076 (timestamp-down (if timestamp-up (- timestamp-up) nil))
7077 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
7078 (org-cmp-ts a b "scheduled")))
7079 (scheduled-down (if scheduled-up (- scheduled-up) nil))
7080 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
7081 (org-cmp-ts a b "deadline")))
7082 (deadline-down (if deadline-up (- deadline-up) nil))
7083 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
7084 (org-cmp-ts a b "timestamp_ia")))
7085 (tsia-down (if tsia-up (- tsia-up) nil))
7086 (ts-up (and (org-em 'ts-up 'ts-down ss)
7087 (org-cmp-ts a b "timestamp")))
7088 (ts-down (if ts-up (- ts-up) nil))
7089 (time-up (and (org-em 'time-up 'time-down ss)
7090 (org-cmp-time a b)))
7091 (time-down (if time-up (- time-up) nil))
7092 (stats-up (and (org-em 'stats-up 'stats-down ss)
7093 (org-cmp-values a b 'org-stats)))
7094 (stats-down (if stats-up (- stats-up) nil))
7095 (priority-up (and (org-em 'priority-up 'priority-down ss)
7096 (org-cmp-values a b 'priority)))
7097 (priority-down (if priority-up (- priority-up) nil))
7098 (effort-up (and (org-em 'effort-up 'effort-down ss)
7099 (org-cmp-effort a b)))
7100 (effort-down (if effort-up (- effort-up) nil))
7101 (category-up (and (or (org-em 'category-up 'category-down ss)
7102 (memq 'category-keep ss))
7103 (org-cmp-category a b)))
7104 (category-down (if category-up (- category-up) nil))
7105 (category-keep (if category-up +1 nil))
7106 (tag-up (and (org-em 'tag-up 'tag-down ss)
7107 (org-cmp-tag a b)))
7108 (tag-down (if tag-up (- tag-up) nil))
7109 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
7110 (org-cmp-todo-state a b)))
7111 (todo-state-down (if todo-state-up (- todo-state-up) nil))
7112 (habit-up (and (org-em 'habit-up 'habit-down ss)
7113 (org-cmp-habit-p a b)))
7114 (habit-down (if habit-up (- habit-up) nil))
7115 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
7116 (org-cmp-alpha a b)))
7117 (alpha-down (if alpha-up (- alpha-up) nil))
7118 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
7119 user-defined-up user-defined-down)
7120 (if (and need-user-cmp org-agenda-cmp-user-defined
7121 (functionp org-agenda-cmp-user-defined))
7122 (setq user-defined-up
7123 (funcall org-agenda-cmp-user-defined a b)
7124 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7125 (cdr (assoc
7126 (eval (cons 'or org-agenda-sorting-strategy-selected))
7127 '((-1 . t) (1 . nil) (nil . nil))))))
7129 ;;; Agenda restriction lock
7131 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7132 "Overlay to mark the headline to which agenda commands are restricted.")
7133 (overlay-put org-agenda-restriction-lock-overlay
7134 'face 'org-agenda-restriction-lock)
7135 (overlay-put org-agenda-restriction-lock-overlay
7136 'help-echo "Agendas are currently limited to this subtree.")
7137 (org-detach-overlay org-agenda-restriction-lock-overlay)
7139 ;;;###autoload
7140 (defun org-agenda-set-restriction-lock (&optional type)
7141 "Set restriction lock for agenda, to current subtree or file.
7142 Restriction will be the file if TYPE is `file', or if type is the
7143 universal prefix \\='(4), or if the cursor is before the first headline
7144 in the file. Otherwise, restriction will be to the current subtree."
7145 (interactive "P")
7146 (org-agenda-remove-restriction-lock 'noupdate)
7147 (and (equal type '(4)) (setq type 'file))
7148 (setq type (cond
7149 (type type)
7150 ((org-at-heading-p) 'subtree)
7151 ((condition-case nil (org-back-to-heading t) (error nil))
7152 'subtree)
7153 (t 'file)))
7154 (if (eq type 'subtree)
7155 (progn
7156 (setq org-agenda-restrict (current-buffer))
7157 (setq org-agenda-overriding-restriction 'subtree)
7158 (put 'org-agenda-files 'org-restrict
7159 (list (buffer-file-name (buffer-base-buffer))))
7160 (org-back-to-heading t)
7161 (move-overlay org-agenda-restriction-lock-overlay
7162 (point)
7163 (if org-agenda-restriction-lock-highlight-subtree
7164 (save-excursion (org-end-of-subtree t t) (point))
7165 (point-at-eol)))
7166 (move-marker org-agenda-restrict-begin (point))
7167 (move-marker org-agenda-restrict-end
7168 (save-excursion (org-end-of-subtree t t)))
7169 (message "Locking agenda restriction to subtree"))
7170 (put 'org-agenda-files 'org-restrict
7171 (list (buffer-file-name (buffer-base-buffer))))
7172 (setq org-agenda-restrict nil)
7173 (setq org-agenda-overriding-restriction 'file)
7174 (move-marker org-agenda-restrict-begin nil)
7175 (move-marker org-agenda-restrict-end nil)
7176 (message "Locking agenda restriction to file"))
7177 (setq current-prefix-arg nil)
7178 (org-agenda-maybe-redo))
7180 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7181 "Remove the agenda restriction lock."
7182 (interactive "P")
7183 (org-detach-overlay org-agenda-restriction-lock-overlay)
7184 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7185 (setq org-agenda-overriding-restriction nil)
7186 (setq org-agenda-restrict nil)
7187 (put 'org-agenda-files 'org-restrict nil)
7188 (move-marker org-agenda-restrict-begin nil)
7189 (move-marker org-agenda-restrict-end nil)
7190 (setq current-prefix-arg nil)
7191 (message "Agenda restriction lock removed")
7192 (or noupdate (org-agenda-maybe-redo)))
7194 (defun org-agenda-maybe-redo ()
7195 "If there is any window showing the agenda view, update it."
7196 (let ((w (get-buffer-window (or org-agenda-this-buffer-name
7197 org-agenda-buffer-name)
7199 (w0 (selected-window)))
7200 (when w
7201 (select-window w)
7202 (org-agenda-redo)
7203 (select-window w0)
7204 (if org-agenda-overriding-restriction
7205 (message "Agenda view shifted to new %s restriction"
7206 org-agenda-overriding-restriction)
7207 (message "Agenda restriction lock removed")))))
7209 ;;; Agenda commands
7211 (defun org-agenda-check-type (error &rest types)
7212 "Check if agenda buffer is of allowed type.
7213 If ERROR is non-nil, throw an error, otherwise just return nil.
7214 Allowed types are `agenda' `timeline' `todo' `tags' `search'."
7215 (if (not org-agenda-type)
7216 (error "No Org agenda currently displayed")
7217 (if (memq org-agenda-type types)
7219 (if error
7220 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7221 nil))))
7223 (defun org-agenda-Quit ()
7224 "Exit the agenda, killing the agenda buffer.
7225 Like `org-agenda-quit', but kill the buffer even when
7226 `org-agenda-sticky' is non-nil."
7227 (interactive)
7228 (org-agenda--quit))
7230 (defun org-agenda-quit ()
7231 "Exit the agenda.
7233 When `org-agenda-sticky' is non-nil, bury the agenda buffer
7234 instead of killing it.
7236 When `org-agenda-restore-windows-after-quit' is non-nil, restore
7237 the pre-agenda window configuration.
7239 When column view is active, exit column view instead of the
7240 agenda."
7241 (interactive)
7242 (org-agenda--quit org-agenda-sticky))
7244 (defun org-agenda--quit (&optional bury)
7245 (if org-agenda-columns-active
7246 (org-columns-quit)
7247 (let ((buf (current-buffer))
7248 (wconf org-agenda-pre-window-conf)
7249 (org-agenda-last-indirect-window
7250 (and (eq org-indirect-buffer-display 'other-window)
7251 org-agenda-last-indirect-buffer
7252 (get-buffer-window org-agenda-last-indirect-buffer))))
7253 (cond
7254 ((eq org-agenda-window-setup 'other-frame)
7255 (delete-frame))
7256 ((and org-agenda-restore-windows-after-quit
7257 wconf)
7258 ;; Maybe restore the pre-agenda window configuration. Reset
7259 ;; `org-agenda-pre-window-conf' before running
7260 ;; `set-window-configuration', which loses the current buffer.
7261 (setq org-agenda-pre-window-conf nil)
7262 (set-window-configuration wconf))
7264 (when org-agenda-last-indirect-window
7265 (delete-window org-agenda-last-indirect-window))
7266 (and (not (eq org-agenda-window-setup 'current-window))
7267 (not (one-window-p))
7268 (delete-window))))
7269 (if bury
7270 (bury-buffer buf)
7271 (kill-buffer buf)
7272 (setq org-agenda-archives-mode nil
7273 org-agenda-buffer nil)))))
7275 (defun org-agenda-exit ()
7276 "Exit the agenda, killing Org buffers loaded by the agenda.
7277 Like `org-agenda-Quit', but kill any buffers that were created by
7278 the agenda. Org buffers visited directly by the user will not be
7279 touched. Also, exit the agenda even if it is in column view."
7280 (interactive)
7281 (when org-agenda-columns-active
7282 (org-columns-quit))
7283 (org-release-buffers org-agenda-new-buffers)
7284 (setq org-agenda-new-buffers nil)
7285 (org-agenda-Quit))
7287 (defun org-agenda-kill-all-agenda-buffers ()
7288 "Kill all buffers in `org-agenda-mode'.
7289 This is used when toggling sticky agendas."
7290 (interactive)
7291 (let (blist)
7292 (dolist (buf (buffer-list))
7293 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7294 (push buf blist)))
7295 (mapc 'kill-buffer blist)))
7297 (defun org-agenda-execute (arg)
7298 "Execute another agenda command, keeping same window.
7299 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7300 in the agenda."
7301 (interactive "P")
7302 (let ((org-agenda-window-setup 'current-window))
7303 (org-agenda arg)))
7305 (defun org-agenda-redo (&optional all)
7306 "Rebuild possibly ALL agenda view(s) in the current buffer."
7307 (interactive "P")
7308 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7309 (cpa (unless (eq all t) current-prefix-arg))
7310 (org-agenda-doing-sticky-redo org-agenda-sticky)
7311 (org-agenda-sticky nil)
7312 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7313 org-agenda-buffer-name))
7314 (org-agenda-keep-modes t)
7315 (tag-filter org-agenda-tag-filter)
7316 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7317 (top-hl-filter org-agenda-top-headline-filter)
7318 (cat-filter org-agenda-category-filter)
7319 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7320 (re-filter org-agenda-regexp-filter)
7321 (re-preset (get 'org-agenda-regexp-filter :preset-filter))
7322 (effort-filter org-agenda-effort-filter)
7323 (effort-preset (get 'org-agenda-effort-filter :preset-filter))
7324 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
7325 (cols org-agenda-columns-active)
7326 (line (org-current-line))
7327 (window-line (- line (org-current-line (window-start))))
7328 (lprops (get 'org-agenda-redo-command 'org-lprops))
7329 (redo-cmd (get-text-property p 'org-redo-cmd))
7330 (last-args (get-text-property p 'org-last-args))
7331 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7332 (org-agenda-overriding-cmd-arguments
7333 (unless (eq all t)
7334 (cond ((listp last-args)
7335 (cons (or cpa (car last-args)) (cdr last-args)))
7336 ((stringp last-args)
7337 last-args))))
7338 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7339 (put 'org-agenda-tag-filter :preset-filter nil)
7340 (put 'org-agenda-category-filter :preset-filter nil)
7341 (put 'org-agenda-regexp-filter :preset-filter nil)
7342 (put 'org-agenda-effort-filter :preset-filter nil)
7343 (and cols (org-columns-quit))
7344 (message "Rebuilding agenda buffer...")
7345 (if series-redo-cmd
7346 (eval series-redo-cmd)
7347 (org-let lprops redo-cmd))
7348 (setq org-agenda-undo-list nil
7349 org-agenda-pending-undo-list nil
7350 org-agenda-tag-filter tag-filter
7351 org-agenda-category-filter cat-filter
7352 org-agenda-regexp-filter re-filter
7353 org-agenda-effort-filter effort-filter
7354 org-agenda-top-headline-filter top-hl-filter)
7355 (message "Rebuilding agenda buffer...done")
7356 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7357 (put 'org-agenda-category-filter :preset-filter cat-preset)
7358 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7359 (put 'org-agenda-effort-filter :preset-filter effort-preset)
7360 (let ((tag (or tag-filter tag-preset))
7361 (cat (or cat-filter cat-preset))
7362 (effort (or effort-filter effort-preset))
7363 (re (or re-filter re-preset)))
7364 (when tag (org-agenda-filter-apply tag 'tag t))
7365 (when cat (org-agenda-filter-apply cat 'category))
7366 (when effort (org-agenda-filter-apply effort 'effort))
7367 (when re (org-agenda-filter-apply re 'regexp)))
7368 (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
7369 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
7370 (org-goto-line line)
7371 (recenter window-line)))
7373 (defvar org-global-tags-completion-table nil)
7374 (defvar org-agenda-filter-form nil)
7375 (defvar org-agenda-filtered-by-category nil)
7377 (defun org-agenda-filter-by-category (strip)
7378 "Filter lines in the agenda buffer that have a specific category.
7379 The category is that of the current line.
7380 Without prefix argument, keep only the lines of that category.
7381 With a prefix argument, exclude the lines of that category.
7383 (interactive "P")
7384 (if (and org-agenda-filtered-by-category
7385 org-agenda-category-filter)
7386 (org-agenda-filter-show-all-cat)
7387 (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
7388 (cond
7389 ((and cat strip)
7390 (org-agenda-filter-apply
7391 (push (concat "-" cat) org-agenda-category-filter) 'category))
7392 (cat
7393 (org-agenda-filter-apply
7394 (setq org-agenda-category-filter
7395 (list (concat "+" cat))) 'category))
7396 (t (error "No category at point"))))))
7398 (defun org-find-top-headline (&optional pos)
7399 "Find the topmost parent headline and return it."
7400 (save-excursion
7401 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
7402 (if pos (goto-char pos))
7403 ;; Skip up to the topmost parent
7404 (while (ignore-errors (outline-up-heading 1) t))
7405 (ignore-errors
7406 (nth 4 (org-heading-components))))))
7408 (defvar org-agenda-filtered-by-top-headline nil)
7409 (defun org-agenda-filter-by-top-headline (strip)
7410 "Keep only those lines that are descendants from the same top headline.
7411 The top headline is that of the current line."
7412 (interactive "P")
7413 (if org-agenda-filtered-by-top-headline
7414 (progn
7415 (setq org-agenda-filtered-by-top-headline nil
7416 org-agenda-top-headline-filter nil)
7417 (org-agenda-filter-show-all-top-filter))
7418 (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
7419 (if toph (org-agenda-filter-top-headline-apply toph strip)
7420 (error "No top-level headline at point")))))
7422 (defvar org-agenda-regexp-filter nil)
7423 (defun org-agenda-filter-by-regexp (strip)
7424 "Filter agenda entries by a regular expression.
7425 Regexp filters are cumulative.
7426 With no prefix argument, keep entries matching the regexp.
7427 With one prefix argument, filter out entries matching the regexp.
7428 With two prefix arguments, remove the regexp filters."
7429 (interactive "P")
7430 (if (not (equal strip '(16)))
7431 (let ((flt (concat (if (equal strip '(4)) "-" "+")
7432 (read-from-minibuffer
7433 (if (equal strip '(4))
7434 "Filter out entries matching regexp: "
7435 "Narrow to entries matching regexp: ")))))
7436 (push flt org-agenda-regexp-filter)
7437 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
7438 (org-agenda-filter-show-all-re)
7439 (message "Regexp filter removed")))
7441 (defvar org-agenda-effort-filter nil)
7442 (defun org-agenda-filter-by-effort (strip)
7443 "Filter agenda entries by effort.
7444 With no prefix argument, keep entries matching the effort condition.
7445 With one prefix argument, filter out entries matching the condition.
7446 With two prefix arguments, remove the effort filters."
7447 (interactive "P")
7448 (cond ((member strip '(nil 4))
7449 (let ((efforts (org-split-string
7450 (or (cdr (assoc (concat org-effort-property "_ALL")
7451 org-global-properties))
7452 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7453 "")))
7454 (eff -1)
7455 effort-prompt op)
7456 (while (not (member op '(?< ?> ?=)))
7457 (setq op (read-char-exclusive "Effort operator? (> = or <)")))
7458 (loop for i from 0 to 9 do
7459 (setq effort-prompt
7460 (concat
7461 effort-prompt " ["
7462 (if (= i 9) "0" (int-to-string (1+ i)))
7463 "]" (nth i efforts))))
7464 (message "Effort %s%s" (char-to-string op) effort-prompt)
7465 (while (or (< eff 0) (> eff 9))
7466 (setq eff (string-to-number (char-to-string (read-char-exclusive)))))
7467 (setq org-agenda-effort-filter
7468 (list (concat (if strip "-" "+")
7469 (char-to-string op) (nth (1- eff) efforts))))
7470 (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
7471 (t (org-agenda-filter-show-all-effort)
7472 (message "Effort filter removed"))))
7474 (defun org-agenda-filter-remove-all ()
7475 "Remove all filters from the current agenda buffer."
7476 (interactive)
7477 (when org-agenda-tag-filter
7478 (org-agenda-filter-show-all-tag))
7479 (when org-agenda-category-filter
7480 (org-agenda-filter-show-all-cat))
7481 (when org-agenda-regexp-filter
7482 (org-agenda-filter-show-all-re))
7483 (when org-agenda-top-headline-filter
7484 (org-agenda-filter-show-all-top-filter))
7485 (when org-agenda-effort-filter
7486 (org-agenda-filter-show-all-effort))
7487 (org-agenda-finalize))
7489 (defun org-agenda-filter-by-tag (arg &optional char exclude)
7490 "Keep only those lines in the agenda buffer that have a specific tag.
7491 The tag is selected with its fast selection letter, as
7492 configured. With a single \\[universal-argument] prefix ARG,
7493 exclude the agenda search. With a double \\[universal-argument]
7494 prefix ARG, filter the literal tag. I.e. don't filter on all its
7495 group members.
7497 A lisp caller can specify CHAR. EXCLUDE means that the new tag should be
7498 used to exclude the search - the interactive user can also press `-' or `+'
7499 to switch between filtering and excluding."
7500 (interactive "P")
7501 (let* ((alist org-tag-alist-for-agenda)
7502 (tag-chars (mapconcat
7503 (lambda (x) (if (and (not (symbolp (car x)))
7504 (cdr x))
7505 (char-to-string (cdr x))
7506 ""))
7507 org-tag-alist-for-agenda ""))
7508 (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
7509 (string-to-list tag-chars)))
7510 (exclude (or exclude (equal arg '(4))))
7511 (expand (not (equal arg '(16))))
7512 (inhibit-read-only t)
7513 (current org-agenda-tag-filter)
7514 a n tag)
7515 (unless char
7516 (while (not (memq char valid-char-list))
7517 (message
7518 "%s by tag [%s ], [TAB], %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
7519 (if exclude "Exclude" "Filter") tag-chars
7520 (if org-agenda-auto-exclude-function "[RET], " "")
7521 (if expand "" ", no grouptag expand"))
7522 (setq char (read-char-exclusive))
7523 ;; Excluding or filtering down
7524 (cond ((eq char ?-) (setq exclude t))
7525 ((eq char ?+) (setq exclude nil)))))
7526 (when (eq char ?\t)
7527 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7528 (setq-local org-global-tags-completion-table
7529 (org-global-tags-completion-table)))
7530 (let ((completion-ignore-case t))
7531 (setq tag (org-icompleting-read
7532 "Tag: " org-global-tags-completion-table))))
7533 (cond
7534 ((eq char ?\r)
7535 (org-agenda-filter-show-all-tag)
7536 (when org-agenda-auto-exclude-function
7537 (setq org-agenda-tag-filter nil)
7538 (dolist (tag (org-agenda-get-represented-tags))
7539 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7540 (if modifier
7541 (push modifier org-agenda-tag-filter))))
7542 (if (not (null org-agenda-tag-filter))
7543 (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
7544 ((eq char ?/)
7545 (org-agenda-filter-show-all-tag)
7546 (when (get 'org-agenda-tag-filter :preset-filter)
7547 (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
7548 ((eq char ?.)
7549 (setq org-agenda-tag-filter
7550 (mapcar (lambda(tag) (concat "+" tag))
7551 (org-get-at-bol 'tags)))
7552 (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
7553 ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
7554 ((or (eq char ?\s)
7555 (setq a (rassoc char alist))
7556 (and tag (setq a (cons tag nil))))
7557 (org-agenda-filter-show-all-tag)
7558 (setq tag (car a))
7559 (setq org-agenda-tag-filter
7560 (cons (concat (if exclude "-" "+") tag)
7561 current))
7562 (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
7563 (t (error "Invalid tag selection character %c" char)))))
7565 (defun org-agenda-get-represented-tags ()
7566 "Get a list of all tags currently represented in the agenda."
7567 (let (p tags)
7568 (save-excursion
7569 (goto-char (point-min))
7570 (while (setq p (next-single-property-change (point) 'tags))
7571 (goto-char p)
7572 (mapc (lambda (x) (add-to-list 'tags x))
7573 (get-text-property (point) 'tags))))
7574 tags))
7576 (defun org-agenda-filter-by-tag-refine (arg &optional char)
7577 "Refine the current filter. See `org-agenda-filter-by-tag'."
7578 (interactive "P")
7579 (org-agenda-filter-by-tag arg char 'refine))
7581 (defun org-agenda-filter-make-matcher (filter type &optional expand)
7582 "Create the form that tests a line for agenda filter. Optional
7583 argument EXPAND can be used for the TYPE tag and will expand the
7584 tags in the FILTER if any of the tags in FILTER are grouptags."
7585 (let (f f1)
7586 (cond
7587 ;; Tag filter
7588 ((eq type 'tag)
7589 (setq filter
7590 (delete-dups
7591 (append (get 'org-agenda-tag-filter :preset-filter)
7592 filter)))
7593 (dolist (x filter)
7594 (let ((op (string-to-char x)))
7595 (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
7596 (setq x (list x)))
7597 (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
7598 (push f1 f))))
7599 ;; Category filter
7600 ((eq type 'category)
7601 (setq filter
7602 (delete-dups
7603 (append (get 'org-agenda-category-filter :preset-filter)
7604 filter)))
7605 (dolist (x filter)
7606 (if (equal "-" (substring x 0 1))
7607 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7608 (setq f1 (list 'equal (substring x 1) 'cat)))
7609 (push f1 f)))
7610 ;; Regexp filter
7611 ((eq type 'regexp)
7612 (setq filter
7613 (delete-dups
7614 (append (get 'org-agenda-regexp-filter :preset-filter)
7615 filter)))
7616 (dolist (x filter)
7617 (if (equal "-" (substring x 0 1))
7618 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7619 (setq f1 (list 'string-match (substring x 1) 'txt)))
7620 (push f1 f)))
7621 ;; Effort filter
7622 ((eq type 'effort)
7623 (setq filter
7624 (delete-dups
7625 (append (get 'org-agenda-effort-filter :preset-filter)
7626 filter)))
7627 (dolist (x filter)
7628 (push (org-agenda-filter-effort-form x) f))))
7629 (cons 'and (nreverse f))))
7631 (defun org-agenda-filter-make-matcher-tag-exp (tags op)
7632 "Return a form associated to tag-expression TAGS.
7633 Build a form testing a line for agenda filter for
7634 tag-expressions. OP is an operator of type CHAR that allows the
7635 function to set the right switches in the returned form."
7636 (let (form)
7637 ;; Any of the expressions can match if OP is +, all must match if
7638 ;; the operator is -.
7639 (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
7640 (let* ((tag (substring x 1))
7641 (f (cond
7642 ((string= "" tag) '(not tags))
7643 ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
7644 ;; TAG is a regexp.
7645 (list 'org-match-any-p (substring tag 1 -1) 'tags))
7646 (t (list 'member (downcase tag) 'tags)))))
7647 (push (if (eq op ?-) (list 'not f) f) form)))))
7649 (defun org-agenda-filter-effort-form (e)
7650 "Return the form to compare the effort of the current line with what E says.
7651 E looks like \"+<2:25\"."
7652 (let (op)
7653 (setq e (substring e 1))
7654 (setq op (string-to-char e) e (substring e 1))
7655 (setq op (cond ((equal op ?<) '<=)
7656 ((equal op ?>) '>=)
7657 ((equal op ??) op)
7658 (t '=)))
7659 (list 'org-agenda-compare-effort (list 'quote op)
7660 (org-duration-string-to-minutes e))))
7662 (defun org-agenda-compare-effort (op value)
7663 "Compare the effort of the current line with VALUE, using OP.
7664 If the line does not have an effort defined, return nil."
7665 (let ((eff (org-get-at-eol 'effort-minutes 1)))
7666 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 -1))
7667 value)))
7669 (defun org-agenda-filter-expand-tags (filter &optional no-operator)
7670 "Expand group tags in FILTER for the agenda.
7671 When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
7672 (if org-group-tags
7673 (let ((case-fold-search t) rtn)
7674 (mapc
7675 (lambda (f)
7676 (let (f0 dir)
7677 (if (string-match "^\\([+-]\\)\\(.+\\)" f)
7678 (setq dir (match-string 1 f) f0 (match-string 2 f))
7679 (setq dir (if no-operator "" "+") f0 f))
7680 (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
7681 (org-tags-expand f0 t t))
7682 rtn))))
7683 filter)
7684 (reverse rtn))
7685 filter))
7687 (defun org-agenda-filter-apply (filter type &optional expand)
7688 "Set FILTER as the new agenda filter and apply it. Optional
7689 argument EXPAND can be used for the TYPE tag and will expand the
7690 tags in the FILTER if any of the tags in FILTER are grouptags."
7691 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7692 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7693 (let (tags cat txt)
7694 (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
7695 ;; Only set `org-agenda-filtered-by-category' to t when a unique
7696 ;; category is used as the filter:
7697 (setq org-agenda-filtered-by-category
7698 (and (eq type 'category)
7699 (not (equal (substring (car filter) 0 1) "-"))))
7700 (org-agenda-set-mode-name)
7701 (save-excursion
7702 (goto-char (point-min))
7703 (while (not (eobp))
7704 (if (org-get-at-bol 'org-marker)
7705 (progn
7706 (setq tags (org-get-at-bol 'tags)
7707 cat (org-get-at-eol 'org-category 1)
7708 txt (org-get-at-eol 'txt 1))
7709 (if (not (eval org-agenda-filter-form))
7710 (org-agenda-filter-hide-line type))
7711 (beginning-of-line 2))
7712 (beginning-of-line 2))))
7713 (if (get-char-property (point) 'invisible)
7714 (ignore-errors (org-agenda-previous-line)))))
7716 (defun org-agenda-filter-top-headline-apply (hl &optional negative)
7717 "Filter by top headline HL."
7718 (org-agenda-set-mode-name)
7719 (save-excursion
7720 (goto-char (point-min))
7721 (while (not (eobp))
7722 (let* ((pos (org-get-at-bol 'org-hd-marker))
7723 (tophl (and pos (org-find-top-headline pos))))
7724 (if (and tophl (funcall (if negative 'identity 'not)
7725 (string= hl tophl)))
7726 (org-agenda-filter-hide-line 'top-headline)))
7727 (beginning-of-line 2)))
7728 (if (get-char-property (point) 'invisible)
7729 (org-agenda-previous-line))
7730 (setq org-agenda-top-headline-filter hl
7731 org-agenda-filtered-by-top-headline t))
7733 (defun org-agenda-filter-hide-line (type)
7734 "Hide lines with TYPE in the agenda buffer."
7735 (let* ((b (max (point-min) (1- (point-at-bol))))
7736 (e (point-at-eol)))
7737 (let ((inhibit-read-only t))
7738 (add-text-properties
7739 b e `(invisible org-filtered org-filter-type ,type)))))
7741 (defun org-agenda-remove-filter (type)
7742 (interactive)
7743 "Remove filter of type TYPE from the agenda buffer."
7744 (save-excursion
7745 (goto-char (point-min))
7746 (let ((inhibit-read-only t) pos)
7747 (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
7748 (goto-char pos)
7749 (remove-text-properties
7750 (point) (next-single-property-change (point) 'org-filter-type)
7751 `(invisible org-filtered org-filter-type ,type))))
7752 (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
7753 (setq org-agenda-filter-form nil)
7754 (org-agenda-set-mode-name)
7755 (org-agenda-finalize)))
7757 (defun org-agenda-filter-show-all-tag nil
7758 (org-agenda-remove-filter 'tag))
7759 (defun org-agenda-filter-show-all-re nil
7760 (org-agenda-remove-filter 'regexp))
7761 (defun org-agenda-filter-show-all-effort nil
7762 (org-agenda-remove-filter 'effort))
7763 (defun org-agenda-filter-show-all-cat nil
7764 (org-agenda-remove-filter 'category))
7765 (defun org-agenda-filter-show-all-top-filter nil
7766 (org-agenda-remove-filter 'top-headline))
7768 (defun org-agenda-manipulate-query-add ()
7769 "Manipulate the query by adding a search term with positive selection.
7770 Positive selection means the term must be matched for selection of an entry."
7771 (interactive)
7772 (org-agenda-manipulate-query ?\[))
7773 (defun org-agenda-manipulate-query-subtract ()
7774 "Manipulate the query by adding a search term with negative selection.
7775 Negative selection means term must not be matched for selection of an entry."
7776 (interactive)
7777 (org-agenda-manipulate-query ?\]))
7778 (defun org-agenda-manipulate-query-add-re ()
7779 "Manipulate the query by adding a search regexp with positive selection.
7780 Positive selection means the regexp must match for selection of an entry."
7781 (interactive)
7782 (org-agenda-manipulate-query ?\{))
7783 (defun org-agenda-manipulate-query-subtract-re ()
7784 "Manipulate the query by adding a search regexp with negative selection.
7785 Negative selection means regexp must not match for selection of an entry."
7786 (interactive)
7787 (org-agenda-manipulate-query ?\}))
7788 (defun org-agenda-manipulate-query (char)
7789 (cond
7790 ((memq org-agenda-type '(timeline agenda))
7791 (let ((org-agenda-include-inactive-timestamps t))
7792 (org-agenda-redo))
7793 (message "Display now includes inactive timestamps as well"))
7794 ((eq org-agenda-type 'search)
7795 (org-add-to-string
7796 'org-agenda-query-string
7797 (if org-agenda-last-search-view-search-was-boolean
7798 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7799 (?\{ . " +{}") (?\} . " -{}"))))
7800 " "))
7801 (setq org-agenda-redo-command
7802 (list 'org-search-view
7803 (car (get-text-property (min (1- (point-max)) (point))
7804 'org-last-args))
7805 org-agenda-query-string
7806 (+ (length org-agenda-query-string)
7807 (if (member char '(?\{ ?\})) 0 1))))
7808 (set-register org-agenda-query-register org-agenda-query-string)
7809 (let ((org-agenda-overriding-arguments
7810 (cdr org-agenda-redo-command)))
7811 (org-agenda-redo)))
7812 (t (error "Cannot manipulate query for %s-type agenda buffers"
7813 org-agenda-type))))
7815 (defun org-add-to-string (var string)
7816 (set var (concat (symbol-value var) string)))
7818 (defun org-agenda-goto-date (span)
7819 "Jump to DATE in agenda."
7820 (interactive "P")
7821 (let* ((org-read-date-prefer-future
7822 (eval org-agenda-jump-prefer-future))
7823 (date (org-read-date))
7824 (day (time-to-days (org-time-string-to-time date)))
7825 (org-agenda-sticky-orig org-agenda-sticky)
7826 (org-agenda-buffer-tmp-name (buffer-name))
7827 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7828 (0-arg (or current-prefix-arg (car args)))
7829 (2-arg (nth 2 args))
7830 (with-hour-p (nth 4 org-agenda-redo-command))
7831 (newcmd (list 'org-agenda-list 0-arg date
7832 (org-agenda-span-to-ndays
7833 2-arg (org-time-string-to-absolute date))
7834 with-hour-p))
7835 (newargs (cdr newcmd))
7836 (inhibit-read-only t)
7837 org-agenda-sticky)
7838 (if (not (org-agenda-check-type t 'agenda))
7839 (error "Not available in non-agenda views")
7840 (add-text-properties (point-min) (point-max)
7841 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7842 (org-agenda-redo)
7843 (goto-char (point-min))
7844 (while (not (or (= (or (get-text-property (point) 'day) 0) day)
7845 (save-excursion (move-beginning-of-line 2) (eobp))))
7846 (move-beginning-of-line 2))
7847 (setq org-agenda-sticky org-agenda-sticky-orig
7848 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7850 (defun org-agenda-goto-today ()
7851 "Go to today."
7852 (interactive)
7853 (org-agenda-check-type t 'timeline 'agenda)
7854 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7855 (curspan (nth 2 args))
7856 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7857 (cond
7858 (tdpos (goto-char tdpos))
7859 ((eq org-agenda-type 'agenda)
7860 (let* ((sd (org-agenda-compute-starting-span
7861 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7862 (org-agenda-overriding-arguments args))
7863 (setf (nth 1 org-agenda-overriding-arguments) sd)
7864 (org-agenda-redo)
7865 (org-agenda-find-same-or-today-or-agenda)))
7866 (t (error "Cannot find today")))))
7868 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7869 (goto-char
7870 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7871 (text-property-any (point-min) (point-max) 'org-today t)
7872 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7873 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7874 (org-agenda-backward-block))
7875 (point-min))))
7877 (defun org-agenda-backward-block ()
7878 "Move backward by one agenda block."
7879 (interactive)
7880 (org-agenda-forward-block 'backward))
7882 (defun org-agenda-forward-block (&optional backward)
7883 "Move forward by one agenda block.
7884 When optional argument BACKWARD is set, go backward"
7885 (interactive)
7886 (cond ((not (derived-mode-p 'org-agenda-mode))
7887 (user-error
7888 "Cannot execute this command outside of org-agenda-mode buffers"))
7889 ((looking-at (if backward "\\`" "\\'"))
7890 (message "Already at the %s block" (if backward "first" "last")))
7891 (t (let ((pos (prog1 (point)
7892 (ignore-errors (if backward (backward-char 1)
7893 (move-end-of-line 1)))))
7894 (f (if backward
7895 'previous-single-property-change
7896 'next-single-property-change))
7897 moved dest)
7898 (while (and (setq dest (funcall
7899 f (point) 'org-agenda-structural-header))
7900 (not (get-text-property
7901 (point) 'org-agenda-structural-header)))
7902 (setq moved t)
7903 (goto-char dest))
7904 (if moved (move-beginning-of-line 1)
7905 (goto-char (if backward (point-min) (point-max)))
7906 (move-beginning-of-line 1)
7907 (message "No %s block" (if backward "previous" "further")))))))
7909 (defun org-agenda-later (arg)
7910 "Go forward in time by the current span.
7911 With prefix ARG, go forward that many times the current span."
7912 (interactive "p")
7913 (org-agenda-check-type t 'agenda)
7914 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7915 (span (or (nth 2 args) org-agenda-current-span))
7916 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7917 (greg (calendar-gregorian-from-absolute sd))
7918 (cnt (org-get-at-bol 'org-day-cnt))
7919 greg2)
7920 (cond
7921 ((numberp span)
7922 (setq sd (+ (* span arg) sd)))
7923 ((eq span 'day)
7924 (setq sd (+ arg sd)))
7925 ((eq span 'week)
7926 (setq sd (+ (* 7 arg) sd)))
7927 ((eq span 'fortnight)
7928 (setq sd (+ (* 14 arg) sd)))
7929 ((eq span 'month)
7930 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7931 sd (calendar-absolute-from-gregorian greg2))
7932 (setcar greg2 (1+ (car greg2))))
7933 ((eq span 'year)
7934 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7935 sd (calendar-absolute-from-gregorian greg2))
7936 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7938 (setq sd (+ (* span arg) sd))))
7939 (let ((org-agenda-overriding-cmd
7940 ;; `cmd' may have been set by `org-agenda-run-series' which
7941 ;; uses `org-agenda-overriding-cmd' to decide whether
7942 ;; overriding is allowed for `cmd'
7943 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7944 (org-agenda-overriding-arguments
7945 (list (car args) sd span)))
7946 (org-agenda-redo)
7947 (org-agenda-find-same-or-today-or-agenda cnt))))
7949 (defun org-agenda-earlier (arg)
7950 "Go backward in time by the current span.
7951 With prefix ARG, go backward that many times the current span."
7952 (interactive "p")
7953 (org-agenda-later (- arg)))
7955 (defun org-agenda-view-mode-dispatch ()
7956 "Call one of the view mode commands."
7957 (interactive)
7958 (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
7959 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7960 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7961 (let ((a (read-char-exclusive)))
7962 (case a
7963 (?\ (call-interactively 'org-agenda-reset-view))
7964 (?d (call-interactively 'org-agenda-day-view))
7965 (?w (call-interactively 'org-agenda-week-view))
7966 (?t (call-interactively 'org-agenda-fortnight-view))
7967 (?m (call-interactively 'org-agenda-month-view))
7968 (?y (call-interactively 'org-agenda-year-view))
7969 (?l (call-interactively 'org-agenda-log-mode))
7970 (?L (org-agenda-log-mode '(4)))
7971 (?c (org-agenda-log-mode 'clockcheck))
7972 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7973 (?a (call-interactively 'org-agenda-archives-mode))
7974 (?A (org-agenda-archives-mode 'files))
7975 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7976 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7977 (?G (call-interactively 'org-agenda-toggle-time-grid))
7978 (?D (call-interactively 'org-agenda-toggle-diary))
7979 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7980 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7981 (org-agenda-check-type t 'timeline 'agenda)
7982 (org-agenda-redo))
7983 (message "Display now includes inactive timestamps as well"))
7984 (?q (message "Abort"))
7985 (otherwise (error "Invalid key" )))))
7987 (defun org-agenda-reset-view ()
7988 "Switch to default view for agenda."
7989 (interactive)
7990 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7991 (defun org-agenda-day-view (&optional day-of-month)
7992 "Switch to daily view for agenda.
7993 With argument DAY-OF-MONTH, switch to that day of the month."
7994 (interactive "P")
7995 (org-agenda-change-time-span 'day day-of-month))
7996 (defun org-agenda-week-view (&optional iso-week)
7997 "Switch to daily view for agenda.
7998 With argument ISO-WEEK, switch to the corresponding ISO week.
7999 If ISO-WEEK has more then 2 digits, only the last two encode the
8000 week. Any digits before this encode a year. So 200712 means
8001 week 12 of year 2007. Years in the range 1938-2037 can also be
8002 written as 2-digit years."
8003 (interactive "P")
8004 (org-agenda-change-time-span 'week iso-week))
8005 (defun org-agenda-fortnight-view (&optional iso-week)
8006 "Switch to daily view for agenda.
8007 With argument ISO-WEEK, switch to the corresponding ISO week.
8008 If ISO-WEEK has more then 2 digits, only the last two encode the
8009 week. Any digits before this encode a year. So 200712 means
8010 week 12 of year 2007. Years in the range 1938-2037 can also be
8011 written as 2-digit years."
8012 (interactive "P")
8013 (org-agenda-change-time-span 'fortnight iso-week))
8014 (defun org-agenda-month-view (&optional month)
8015 "Switch to monthly view for agenda.
8016 With argument MONTH, switch to that month."
8017 (interactive "P")
8018 (org-agenda-change-time-span 'month month))
8019 (defun org-agenda-year-view (&optional year)
8020 "Switch to yearly view for agenda.
8021 With argument YEAR, switch to that year.
8022 If MONTH has more then 2 digits, only the last two encode the
8023 month. Any digits before this encode a year. So 200712 means
8024 December year 2007. Years in the range 1938-2037 can also be
8025 written as 2-digit years."
8026 (interactive "P")
8027 (when year
8028 (setq year (org-small-year-to-year year)))
8029 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
8030 (org-agenda-change-time-span 'year year)
8031 (error "Abort")))
8033 (defun org-agenda-change-time-span (span &optional n)
8034 "Change the agenda view to SPAN.
8035 SPAN may be `day', `week', `fortnight', `month', `year'."
8036 (org-agenda-check-type t 'agenda)
8037 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
8038 (curspan (nth 2 args)))
8039 (if (and (not n) (equal curspan span))
8040 (error "Viewing span is already \"%s\"" span))
8041 (let* ((sd (or (org-get-at-bol 'day)
8042 (nth 1 args)
8043 org-starting-day))
8044 (sd (org-agenda-compute-starting-span sd span n))
8045 (org-agenda-overriding-cmd
8046 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
8047 (org-agenda-overriding-arguments
8048 (list (car args) sd span)))
8049 (org-agenda-redo)
8050 (org-agenda-find-same-or-today-or-agenda))
8051 (org-agenda-set-mode-name)
8052 (message "Switched to %s view" span)))
8054 (defun org-agenda-compute-starting-span (sd span &optional n)
8055 "Compute starting date for agenda.
8056 SPAN may be `day', `week', `fortnight', `month', `year'. The return value
8057 is a cons cell with the starting date and the number of days,
8058 so that the date SD will be in that range."
8059 (let* ((greg (calendar-gregorian-from-absolute sd))
8060 (dg (nth 1 greg))
8061 (mg (car greg))
8062 (yg (nth 2 greg)))
8063 (cond
8064 ((eq span 'day)
8065 (when n
8066 (setq sd (+ (calendar-absolute-from-gregorian
8067 (list mg 1 yg))
8068 n -1))))
8069 ((or (eq span 'week) (eq span 'fortnight))
8070 (let* ((nt (calendar-day-of-week
8071 (calendar-gregorian-from-absolute sd)))
8072 (d (if org-agenda-start-on-weekday
8073 (- nt org-agenda-start-on-weekday)
8076 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
8077 (when n
8078 (require 'cal-iso)
8079 (when (> n 99)
8080 (setq y1 (org-small-year-to-year (/ n 100))
8081 n (mod n 100)))
8082 (setq sd
8083 (calendar-iso-to-absolute
8084 (list n 1
8085 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
8086 ((eq span 'month)
8087 (let (y1)
8088 (when (and n (> n 99))
8089 (setq y1 (org-small-year-to-year (/ n 100))
8090 n (mod n 100)))
8091 (setq sd (calendar-absolute-from-gregorian
8092 (list (or n mg) 1 (or y1 yg))))))
8093 ((eq span 'year)
8094 (setq sd (calendar-absolute-from-gregorian
8095 (list 1 1 (or n yg))))))
8096 sd))
8098 (defun org-agenda-next-date-line (&optional arg)
8099 "Jump to the next line indicating a date in agenda buffer."
8100 (interactive "p")
8101 (org-agenda-check-type t 'agenda 'timeline)
8102 (beginning-of-line 1)
8103 ;; This does not work if user makes date format that starts with a blank
8104 (if (looking-at "^\\S-") (forward-char 1))
8105 (if (not (re-search-forward "^\\S-" nil t arg))
8106 (progn
8107 (backward-char 1)
8108 (error "No next date after this line in this buffer")))
8109 (goto-char (match-beginning 0)))
8111 (defun org-agenda-previous-date-line (&optional arg)
8112 "Jump to the previous line indicating a date in agenda buffer."
8113 (interactive "p")
8114 (org-agenda-check-type t 'agenda 'timeline)
8115 (beginning-of-line 1)
8116 (if (not (re-search-backward "^\\S-" nil t arg))
8117 (error "No previous date before this line in this buffer")))
8119 ;; Initialize the highlight
8120 (defvar org-hl (make-overlay 1 1))
8121 (overlay-put org-hl 'face 'highlight)
8123 (defun org-highlight (begin end &optional buffer)
8124 "Highlight a region with overlay."
8125 (move-overlay org-hl begin end (or buffer (current-buffer))))
8127 (defun org-unhighlight ()
8128 "Detach overlay INDEX."
8129 (org-detach-overlay org-hl))
8131 (defun org-unhighlight-once ()
8132 "Remove the highlight from its position, and this function from the hook."
8133 (remove-hook 'pre-command-hook 'org-unhighlight-once)
8134 (org-unhighlight))
8136 (defvar org-agenda-pre-follow-window-conf nil)
8137 (defun org-agenda-follow-mode ()
8138 "Toggle follow mode in an agenda buffer."
8139 (interactive)
8140 (unless org-agenda-follow-mode
8141 (setq org-agenda-pre-follow-window-conf
8142 (current-window-configuration)))
8143 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
8144 (unless org-agenda-follow-mode
8145 (set-window-configuration org-agenda-pre-follow-window-conf))
8146 (org-agenda-set-mode-name)
8147 (org-agenda-do-context-action)
8148 (message "Follow mode is %s"
8149 (if org-agenda-follow-mode "on" "off")))
8151 (defun org-agenda-entry-text-mode (&optional arg)
8152 "Toggle entry text mode in an agenda buffer."
8153 (interactive "P")
8154 (if (or org-agenda-tag-filter
8155 org-agenda-category-filter
8156 org-agenda-regexp-filter
8157 org-agenda-top-headline-filter)
8158 (user-error "Can't show entry text in filtered views")
8159 (setq org-agenda-entry-text-mode (or (integerp arg)
8160 (not org-agenda-entry-text-mode)))
8161 (org-agenda-entry-text-hide)
8162 (and org-agenda-entry-text-mode
8163 (let ((org-agenda-entry-text-maxlines
8164 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
8165 (org-agenda-entry-text-show)))
8166 (org-agenda-set-mode-name)
8167 (message "Entry text mode is %s%s"
8168 (if org-agenda-entry-text-mode "on" "off")
8169 (if (not org-agenda-entry-text-mode) ""
8170 (format " (maximum number of lines is %d)"
8171 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
8173 (defun org-agenda-clockreport-mode ()
8174 "Toggle clocktable mode in an agenda buffer."
8175 (interactive)
8176 (org-agenda-check-type t 'agenda)
8177 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
8178 (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
8179 (org-agenda-set-mode-name)
8180 (org-agenda-redo)
8181 (message "Clocktable mode is %s"
8182 (if org-agenda-clockreport-mode "on" "off")))
8184 (defun org-agenda-log-mode (&optional special)
8185 "Toggle log mode in an agenda buffer.
8186 With argument SPECIAL, show all possible log items, not only the ones
8187 configured in `org-agenda-log-mode-items'.
8188 With a double \\[universal-argument] prefix arg, show *only* \
8189 log items, nothing else."
8190 (interactive "P")
8191 (org-agenda-check-type t 'agenda 'timeline)
8192 (setq org-agenda-show-log
8193 (cond
8194 ((equal special '(16)) 'only)
8195 ((eq special 'clockcheck)
8196 (if (eq org-agenda-show-log 'clockcheck)
8197 nil 'clockcheck))
8198 (special '(closed clock state))
8199 (t (not org-agenda-show-log))))
8200 (setq org-agenda-start-with-log-mode org-agenda-show-log)
8201 (org-agenda-set-mode-name)
8202 (org-agenda-redo)
8203 (message "Log mode is %s"
8204 (if org-agenda-show-log "on" "off")))
8206 (defun org-agenda-archives-mode (&optional with-files)
8207 "Toggle inclusion of items in trees marked with :ARCHIVE:.
8208 When called with a prefix argument, include all archive files as well."
8209 (interactive "P")
8210 (setq org-agenda-archives-mode
8211 (if with-files t (if org-agenda-archives-mode nil 'trees)))
8212 (org-agenda-set-mode-name)
8213 (org-agenda-redo)
8214 (message
8215 "%s"
8216 (cond
8217 ((eq org-agenda-archives-mode nil)
8218 "No archives are included")
8219 ((eq org-agenda-archives-mode 'trees)
8220 (format "Trees with :%s: tag are included" org-archive-tag))
8221 ((eq org-agenda-archives-mode t)
8222 (format "Trees with :%s: tag and all active archive files are included"
8223 org-archive-tag)))))
8225 (defun org-agenda-toggle-diary ()
8226 "Toggle diary inclusion in an agenda buffer."
8227 (interactive)
8228 (org-agenda-check-type t 'agenda)
8229 (setq org-agenda-include-diary (not org-agenda-include-diary))
8230 (org-agenda-redo)
8231 (org-agenda-set-mode-name)
8232 (message "Diary inclusion turned %s"
8233 (if org-agenda-include-diary "on" "off")))
8235 (defun org-agenda-toggle-deadlines ()
8236 "Toggle inclusion of entries with a deadline in an agenda buffer."
8237 (interactive)
8238 (org-agenda-check-type t 'agenda)
8239 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8240 (org-agenda-redo)
8241 (org-agenda-set-mode-name)
8242 (message "Deadlines inclusion turned %s"
8243 (if org-agenda-include-deadlines "on" "off")))
8245 (defun org-agenda-toggle-time-grid ()
8246 "Toggle time grid in an agenda buffer."
8247 (interactive)
8248 (org-agenda-check-type t 'agenda)
8249 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8250 (org-agenda-redo)
8251 (org-agenda-set-mode-name)
8252 (message "Time-grid turned %s"
8253 (if org-agenda-use-time-grid "on" "off")))
8255 (defun org-agenda-set-mode-name ()
8256 "Set the mode name to indicate all the small mode settings."
8257 (setq mode-name
8258 (list "Org-Agenda"
8259 (if (get 'org-agenda-files 'org-restrict) " []" "")
8261 '(:eval (org-agenda-span-name org-agenda-current-span))
8262 (if org-agenda-follow-mode " Follow" "")
8263 (if org-agenda-entry-text-mode " ETxt" "")
8264 (if org-agenda-include-diary " Diary" "")
8265 (if org-agenda-include-deadlines " Ddl" "")
8266 (if org-agenda-use-time-grid " Grid" "")
8267 (if (and (boundp 'org-habit-show-habits)
8268 org-habit-show-habits) " Habit" "")
8269 (cond
8270 ((consp org-agenda-show-log) " LogAll")
8271 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8272 (org-agenda-show-log " Log")
8273 (t ""))
8274 (if (or org-agenda-category-filter
8275 (get 'org-agenda-category-filter :preset-filter))
8276 '(:eval (org-propertize
8277 (concat " <"
8278 (mapconcat
8279 'identity
8280 (append
8281 (get 'org-agenda-category-filter :preset-filter)
8282 org-agenda-category-filter)
8284 ">")
8285 'face 'org-agenda-filter-category
8286 'help-echo "Category used in filtering")) "")
8287 (if (or org-agenda-tag-filter
8288 (get 'org-agenda-tag-filter :preset-filter))
8289 '(:eval (org-propertize
8290 (concat " {"
8291 (mapconcat
8292 'identity
8293 (append
8294 (get 'org-agenda-tag-filter :preset-filter)
8295 org-agenda-tag-filter)
8297 "}")
8298 'face 'org-agenda-filter-tags
8299 'help-echo "Tags used in filtering")) "")
8300 (if (or org-agenda-effort-filter
8301 (get 'org-agenda-effort-filter :preset-filter))
8302 '(:eval (org-propertize
8303 (concat " {"
8304 (mapconcat
8305 'identity
8306 (append
8307 (get 'org-agenda-effort-filter :preset-filter)
8308 org-agenda-effort-filter)
8310 "}")
8311 'face 'org-agenda-filter-effort
8312 'help-echo "Effort conditions used in filtering")) "")
8313 (if (or org-agenda-regexp-filter
8314 (get 'org-agenda-regexp-filter :preset-filter))
8315 '(:eval (org-propertize
8316 (concat " ["
8317 (mapconcat
8318 'identity
8319 (append
8320 (get 'org-agenda-regexp-filter :preset-filter)
8321 org-agenda-regexp-filter)
8323 "]")
8324 'face 'org-agenda-filter-regexp
8325 'help-echo "Regexp used in filtering")) "")
8326 (if org-agenda-archives-mode
8327 (if (eq org-agenda-archives-mode t)
8328 " Archives"
8329 (format " :%s:" org-archive-tag))
8331 (if org-agenda-clockreport-mode " Clock" "")))
8332 (force-mode-line-update))
8334 (define-obsolete-function-alias
8335 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8337 (defun org-agenda-update-agenda-type ()
8338 "Update the agenda type after each command."
8339 (setq org-agenda-type
8340 (or (get-text-property (point) 'org-agenda-type)
8341 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8343 (defun org-agenda-next-line ()
8344 "Move cursor to the next line, and show if follow mode is active."
8345 (interactive)
8346 (call-interactively 'next-line)
8347 (org-agenda-do-context-action))
8349 (defun org-agenda-previous-line ()
8350 "Move cursor to the previous line, and show if follow-mode is active."
8351 (interactive)
8352 (call-interactively 'previous-line)
8353 (org-agenda-do-context-action))
8355 (defun org-agenda-next-item (n)
8356 "Move cursor to next agenda item."
8357 (interactive "p")
8358 (let ((col (current-column)))
8359 (dotimes (c n)
8360 (when (next-single-property-change (point-at-eol) 'org-marker)
8361 (move-end-of-line 1)
8362 (goto-char (next-single-property-change (point) 'org-marker))))
8363 (org-move-to-column col))
8364 (org-agenda-do-context-action))
8366 (defun org-agenda-previous-item (n)
8367 "Move cursor to next agenda item."
8368 (interactive "p")
8369 (dotimes (c n)
8370 (let ((col (current-column))
8371 (goto (save-excursion
8372 (move-end-of-line 0)
8373 (previous-single-property-change (point) 'org-marker))))
8374 (if goto (goto-char goto))
8375 (org-move-to-column col)))
8376 (org-agenda-do-context-action))
8378 (defun org-agenda-do-context-action ()
8379 "Show outline path and, maybe, follow mode window."
8380 (let ((m (org-get-at-bol 'org-marker)))
8381 (when (and (markerp m) (marker-buffer m))
8382 (and org-agenda-follow-mode
8383 (if org-agenda-follow-indirect
8384 (org-agenda-tree-to-indirect-buffer nil)
8385 (org-agenda-show)))
8386 (and org-agenda-show-outline-path
8387 (org-with-point-at m (org-display-outline-path t))))))
8389 (defun org-agenda-show-tags ()
8390 "Show the tags applicable to the current item."
8391 (interactive)
8392 (let* ((tags (org-get-at-bol 'tags)))
8393 (if tags
8394 (message "Tags are :%s:"
8395 (org-no-properties (mapconcat 'identity tags ":")))
8396 (message "No tags associated with this line"))))
8398 (defun org-agenda-goto (&optional highlight)
8399 "Go to the entry at point in the corresponding Org-mode file."
8400 (interactive)
8401 (let* ((marker (or (org-get-at-bol 'org-marker)
8402 (org-agenda-error)))
8403 (buffer (marker-buffer marker))
8404 (pos (marker-position marker)))
8405 (switch-to-buffer-other-window buffer)
8406 (widen)
8407 (push-mark)
8408 (goto-char pos)
8409 (when (derived-mode-p 'org-mode)
8410 (org-show-context 'agenda)
8411 (save-excursion
8412 (and (outline-next-heading)
8413 (org-flag-heading nil))) ; show the next heading
8414 (when (outline-invisible-p)
8415 (outline-show-entry)) ; display invisible text
8416 (recenter (/ (window-height) 2))
8417 (org-back-to-heading t)
8418 (if (re-search-forward org-complex-heading-regexp nil t)
8419 (goto-char (match-beginning 4))))
8420 (run-hooks 'org-agenda-after-show-hook)
8421 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8423 (defvar org-agenda-after-show-hook nil
8424 "Normal hook run after an item has been shown from the agenda.
8425 Point is in the buffer where the item originated.")
8427 (defun org-agenda-kill ()
8428 "Kill the entry or subtree belonging to the current agenda entry."
8429 (interactive)
8430 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8431 (let* ((bufname-orig (buffer-name))
8432 (marker (or (org-get-at-bol 'org-marker)
8433 (org-agenda-error)))
8434 (buffer (marker-buffer marker))
8435 (pos (marker-position marker))
8436 (type (org-get-at-bol 'type))
8437 dbeg dend (n 0) conf)
8438 (org-with-remote-undo buffer
8439 (with-current-buffer buffer
8440 (save-excursion
8441 (goto-char pos)
8442 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8443 (setq dbeg (progn (org-back-to-heading t) (point))
8444 dend (org-end-of-subtree t t))
8445 (setq dbeg (point-at-bol)
8446 dend (min (point-max) (1+ (point-at-eol)))))
8447 (goto-char dbeg)
8448 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8449 (setq conf (or (eq t org-agenda-confirm-kill)
8450 (and (numberp org-agenda-confirm-kill)
8451 (> n org-agenda-confirm-kill))))
8452 (and conf
8453 (not (y-or-n-p
8454 (format "Delete entry with %d lines in buffer \"%s\"? "
8455 n (buffer-name buffer))))
8456 (error "Abort"))
8457 (let ((org-agenda-buffer-name bufname-orig))
8458 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8459 (with-current-buffer buffer (delete-region dbeg dend))
8460 (message "Agenda item and source killed"))))
8462 (defvar org-archive-default-command) ; defined in org-archive.el
8463 (defun org-agenda-archive-default ()
8464 "Archive the entry or subtree belonging to the current agenda entry."
8465 (interactive)
8466 (require 'org-archive)
8467 (org-agenda-archive-with org-archive-default-command))
8469 (defun org-agenda-archive-default-with-confirmation ()
8470 "Archive the entry or subtree belonging to the current agenda entry."
8471 (interactive)
8472 (require 'org-archive)
8473 (org-agenda-archive-with org-archive-default-command 'confirm))
8475 (defun org-agenda-archive ()
8476 "Archive the entry or subtree belonging to the current agenda entry."
8477 (interactive)
8478 (org-agenda-archive-with 'org-archive-subtree))
8480 (defun org-agenda-archive-to-archive-sibling ()
8481 "Move the entry to the archive sibling."
8482 (interactive)
8483 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8485 (defun org-agenda-archive-with (cmd &optional confirm)
8486 "Move the entry to the archive sibling."
8487 (interactive)
8488 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8489 (let* ((bufname-orig (buffer-name))
8490 (marker (or (org-get-at-bol 'org-marker)
8491 (org-agenda-error)))
8492 (buffer (marker-buffer marker))
8493 (pos (marker-position marker)))
8494 (org-with-remote-undo buffer
8495 (with-current-buffer buffer
8496 (if (derived-mode-p 'org-mode)
8497 (if (and confirm
8498 (not (y-or-n-p "Archive this subtree or entry? ")))
8499 (error "Abort")
8500 (save-window-excursion
8501 (goto-char pos)
8502 (let ((org-agenda-buffer-name bufname-orig))
8503 (org-remove-subtree-entries-from-agenda))
8504 (org-back-to-heading t)
8505 (funcall cmd)))
8506 (error "Archiving works only in Org-mode files"))))))
8508 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8509 "Remove all lines in the agenda that correspond to a given subtree.
8510 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8511 If this information is not given, the function uses the tree at point."
8512 (let ((buf (or buf (current-buffer))) m p)
8513 (save-excursion
8514 (unless (and beg end)
8515 (org-back-to-heading t)
8516 (setq beg (point))
8517 (org-end-of-subtree t)
8518 (setq end (point)))
8519 (set-buffer (get-buffer org-agenda-buffer-name))
8520 (save-excursion
8521 (goto-char (point-max))
8522 (beginning-of-line 1)
8523 (while (not (bobp))
8524 (when (and (setq m (org-get-at-bol 'org-marker))
8525 (equal buf (marker-buffer m))
8526 (setq p (marker-position m))
8527 (>= p beg)
8528 (< p end))
8529 (let ((inhibit-read-only t))
8530 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8531 (beginning-of-line 0))))))
8533 (defun org-agenda-refile (&optional goto rfloc no-update)
8534 "Refile the item at point.
8536 When GOTO is 0 or \\='(64) or a triple \\[universal-argument] prefix argument,
8537 clear the refile cache.
8538 When GOTO is \\='(16) or a double \\[universal-argument] prefix argument,
8539 go to the location of the last refiled item.
8540 RFLOC can be a refile location obtained in a different way.
8541 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8542 (interactive "P")
8543 (cond
8544 ((member goto '(0 (64)))
8545 (org-refile-cache-clear))
8546 ((equal goto '(16))
8547 (org-refile-goto-last-stored))
8549 (let* ((buffer-orig (buffer-name))
8550 (marker (or (org-get-at-bol 'org-hd-marker)
8551 (org-agenda-error)))
8552 (buffer (marker-buffer marker))
8553 (pos (marker-position marker))
8554 (rfloc (or rfloc
8555 (org-refile-get-location
8556 (if goto "Goto" "Refile to") buffer
8557 org-refile-allow-creating-parent-nodes))))
8558 (with-current-buffer buffer
8559 (save-excursion
8560 (save-restriction
8561 (widen)
8562 (goto-char marker)
8563 (let ((org-agenda-buffer-name buffer-orig))
8564 (org-remove-subtree-entries-from-agenda))
8565 (org-refile goto buffer rfloc)))))
8566 (unless no-update (org-agenda-redo)))))
8568 (defun org-agenda-open-link (&optional arg)
8569 "Open the link(s) in the current entry, if any.
8570 This looks for a link in the displayed line in the agenda.
8571 It also looks at the text of the entry itself."
8572 (interactive "P")
8573 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8574 (org-get-at-bol 'org-marker)))
8575 (buffer (and marker (marker-buffer marker)))
8576 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8577 (lkall (and buffer (org-offer-links-in-entry
8578 buffer marker arg prefix)))
8579 (lk0 (car lkall))
8580 (lk (if (stringp lk0) (list lk0) lk0))
8581 (lkend (cdr lkall))
8582 trg)
8583 (cond
8584 ((and buffer lk)
8585 (mapcar (lambda(l)
8586 (with-current-buffer buffer
8587 (setq trg (and (string-match org-bracket-link-regexp l)
8588 (match-string 1 l)))
8589 (if (or (not trg) (string-match org-any-link-re trg))
8590 (save-excursion
8591 (save-restriction
8592 (widen)
8593 (goto-char marker)
8594 (when (search-forward l nil lkend)
8595 (goto-char (match-beginning 0))
8596 (org-open-at-point))))
8597 ;; This is an internal link, widen the buffer
8598 (switch-to-buffer-other-window buffer)
8599 (widen)
8600 (goto-char marker)
8601 (when (search-forward l nil lkend)
8602 (goto-char (match-beginning 0))
8603 (org-open-at-point)))))
8604 lk))
8605 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8606 (save-excursion
8607 (beginning-of-line 1)
8608 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8609 (org-open-link-from-string (match-string 1)))
8610 (t (message "No link to open here")))))
8612 (defun org-agenda-copy-local-variable (var)
8613 "Get a variable from a referenced buffer and install it here."
8614 (let ((m (org-get-at-bol 'org-marker)))
8615 (when (and m (buffer-live-p (marker-buffer m)))
8616 (set (make-local-variable var)
8617 (with-current-buffer (marker-buffer m)
8618 (symbol-value var))))))
8620 (defun org-agenda-switch-to (&optional delete-other-windows)
8621 "Go to the Org mode file which contains the item at point.
8622 When optional argument DELETE-OTHER-WINDOWS is non-nil, the
8623 displayed Org file fills the frame."
8624 (interactive)
8625 (if (and org-return-follows-link
8626 (not (org-get-at-bol 'org-marker))
8627 (org-in-regexp org-bracket-link-regexp))
8628 (org-open-link-from-string (match-string 0))
8629 (let* ((marker (or (org-get-at-bol 'org-marker)
8630 (org-agenda-error)))
8631 (buffer (marker-buffer marker))
8632 (pos (marker-position marker)))
8633 (unless buffer (user-error "Trying to switch to non-existent buffer"))
8634 (org-pop-to-buffer-same-window buffer)
8635 (when delete-other-windows (delete-other-windows))
8636 (widen)
8637 (goto-char pos)
8638 (when (derived-mode-p 'org-mode)
8639 (org-show-context 'agenda)
8640 (run-hooks 'org-agenda-after-show-hook)))))
8642 (defun org-agenda-goto-mouse (ev)
8643 "Go to the Org-mode file which contains the item at the mouse click."
8644 (interactive "e")
8645 (mouse-set-point ev)
8646 (org-agenda-goto))
8648 (defun org-agenda-show (&optional full-entry)
8649 "Display the Org-mode file which contains the item at point.
8650 With prefix argument FULL-ENTRY, make the entire entry visible
8651 if it was hidden in the outline."
8652 (interactive "P")
8653 (let ((win (selected-window)))
8654 (org-agenda-goto t)
8655 (when full-entry (org-show-entry))
8656 (select-window win)))
8658 (defvar org-agenda-show-window nil)
8659 (defun org-agenda-show-and-scroll-up (&optional arg)
8660 "Display the Org-mode file which contains the item at point.
8661 When called repeatedly, scroll the window that is displaying the buffer.
8662 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8663 `show-subtree' to display the item, so that drawers and logbooks stay
8664 folded."
8665 (interactive "P")
8666 (let ((win (selected-window)))
8667 (if (and (window-live-p org-agenda-show-window)
8668 (eq this-command last-command))
8669 (progn
8670 (select-window org-agenda-show-window)
8671 (ignore-errors (scroll-up)))
8672 (org-agenda-goto t)
8673 (if arg (org-show-entry) (outline-show-subtree))
8674 (setq org-agenda-show-window (selected-window)))
8675 (select-window win)))
8677 (defun org-agenda-show-scroll-down ()
8678 "Scroll down the window showing the agenda."
8679 (interactive)
8680 (let ((win (selected-window)))
8681 (when (window-live-p org-agenda-show-window)
8682 (select-window org-agenda-show-window)
8683 (ignore-errors (scroll-down))
8684 (select-window win))))
8686 (defun org-agenda-show-1 (&optional more)
8687 "Display the Org-mode file which contains the item at point.
8688 The prefix arg selects the amount of information to display:
8690 0 hide the subtree
8691 1 just show the entry according to defaults.
8692 2 show the children view
8693 3 show the subtree view
8694 4 show the entire subtree and any LOGBOOK drawers
8695 5 show the entire subtree and any drawers
8696 With prefix argument FULL-ENTRY, make the entire entry visible
8697 if it was hidden in the outline."
8698 (interactive "p")
8699 (let ((win (selected-window)))
8700 (org-agenda-goto t)
8701 (org-back-to-heading)
8702 (set-window-start (selected-window) (point-at-bol))
8703 (cond
8704 ((= more 0)
8705 (outline-hide-subtree)
8706 (save-excursion
8707 (org-back-to-heading)
8708 (run-hook-with-args 'org-cycle-hook 'folded))
8709 (message "Remote: FOLDED"))
8710 ((and (org-called-interactively-p 'any) (= more 1))
8711 (message "Remote: show with default settings"))
8712 ((= more 2)
8713 (outline-show-entry)
8714 (org-show-children)
8715 (save-excursion
8716 (org-back-to-heading)
8717 (run-hook-with-args 'org-cycle-hook 'children))
8718 (message "Remote: CHILDREN"))
8719 ((= more 3)
8720 (outline-show-subtree)
8721 (save-excursion
8722 (org-back-to-heading)
8723 (run-hook-with-args 'org-cycle-hook 'subtree))
8724 (message "Remote: SUBTREE"))
8725 ((= more 4)
8726 (outline-show-subtree)
8727 (save-excursion
8728 (org-back-to-heading)
8729 (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
8730 (message "Remote: SUBTREE AND LOGBOOK"))
8731 ((> more 4)
8732 (outline-show-subtree)
8733 (message "Remote: SUBTREE AND ALL DRAWERS")))
8734 (select-window win)))
8736 (defvar org-agenda-cycle-counter nil)
8737 (defun org-agenda-cycle-show (&optional n)
8738 "Show the current entry in another window, with default settings.
8740 Default settings are taken from `org-show-context-detail'. When
8741 use repeatedly in immediate succession, the remote entry will
8742 cycle through visibility
8744 children -> subtree -> folded
8746 When called with a numeric prefix arg, that arg will be passed through to
8747 `org-agenda-show-1'. For the interpretation of that argument, see the
8748 docstring of `org-agenda-show-1'."
8749 (interactive "P")
8750 (if (integerp n)
8751 (setq org-agenda-cycle-counter n)
8752 (if (not (eq last-command this-command))
8753 (setq org-agenda-cycle-counter 1)
8754 (if (equal org-agenda-cycle-counter 0)
8755 (setq org-agenda-cycle-counter 2)
8756 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8757 (if (> org-agenda-cycle-counter 3)
8758 (setq org-agenda-cycle-counter 0)))))
8759 (org-agenda-show-1 org-agenda-cycle-counter))
8761 (defun org-agenda-recenter (arg)
8762 "Display the Org-mode file which contains the item at point and recenter."
8763 (interactive "P")
8764 (let ((win (selected-window)))
8765 (org-agenda-goto t)
8766 (recenter arg)
8767 (select-window win)))
8769 (defun org-agenda-show-mouse (ev)
8770 "Display the Org-mode file which contains the item at the mouse click."
8771 (interactive "e")
8772 (mouse-set-point ev)
8773 (org-agenda-show))
8775 (defun org-agenda-check-no-diary ()
8776 "Check if the entry is a diary link and abort if yes."
8777 (if (org-get-at-bol 'org-agenda-diary-link)
8778 (org-agenda-error)))
8780 (defun org-agenda-error ()
8781 "Throw an error when a command is not allowed in the agenda."
8782 (user-error "Command not allowed in this line"))
8784 (defun org-agenda-tree-to-indirect-buffer (arg)
8785 "Show the subtree corresponding to the current entry in an indirect buffer.
8786 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8788 With a numerical prefix ARG, go up to this level and then take that tree.
8789 With a negative numeric ARG, go up by this number of levels.
8790 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8791 use the dedicated frame)."
8792 (interactive "P")
8793 (if current-prefix-arg
8794 (org-agenda-do-tree-to-indirect-buffer arg)
8795 (let ((agenda-buffer (buffer-name))
8796 (agenda-window (selected-window))
8797 (indirect-window
8798 (and org-last-indirect-buffer
8799 (get-buffer-window org-last-indirect-buffer))))
8800 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8801 (unless (or (eq org-indirect-buffer-display 'new-frame)
8802 (eq org-indirect-buffer-display 'dedicated-frame))
8803 (unwind-protect
8804 (unless (and indirect-window (window-live-p indirect-window))
8805 (setq indirect-window (split-window agenda-window)))
8806 (and indirect-window (select-window indirect-window))
8807 (switch-to-buffer org-last-indirect-buffer :norecord)
8808 (fit-window-to-buffer indirect-window)))
8809 (select-window (get-buffer-window agenda-buffer))
8810 (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
8812 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8813 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8814 (org-agenda-check-no-diary)
8815 (let* ((marker (or (org-get-at-bol 'org-marker)
8816 (org-agenda-error)))
8817 (buffer (marker-buffer marker))
8818 (pos (marker-position marker)))
8819 (with-current-buffer buffer
8820 (save-excursion
8821 (goto-char pos)
8822 (funcall 'org-tree-to-indirect-buffer arg)))))
8824 (defvar org-last-heading-marker (make-marker)
8825 "Marker pointing to the headline that last changed its TODO state
8826 by a remote command from the agenda.")
8828 (defun org-agenda-todo-nextset ()
8829 "Switch TODO entry to next sequence."
8830 (interactive)
8831 (org-agenda-todo 'nextset))
8833 (defun org-agenda-todo-previousset ()
8834 "Switch TODO entry to previous sequence."
8835 (interactive)
8836 (org-agenda-todo 'previousset))
8838 (defun org-agenda-todo (&optional arg)
8839 "Cycle TODO state of line at point, also in Org-mode file.
8840 This changes the line at point, all other lines in the agenda referring to
8841 the same tree node, and the headline of the tree node in the Org-mode file."
8842 (interactive "P")
8843 (org-agenda-check-no-diary)
8844 (let* ((col (current-column))
8845 (marker (or (org-get-at-bol 'org-marker)
8846 (org-agenda-error)))
8847 (buffer (marker-buffer marker))
8848 (pos (marker-position marker))
8849 (hdmarker (org-get-at-bol 'org-hd-marker))
8850 (todayp (org-agenda-today-p (org-get-at-bol 'day)))
8851 (inhibit-read-only t)
8852 org-agenda-headline-snapshot-before-repeat newhead just-one)
8853 (org-with-remote-undo buffer
8854 (with-current-buffer buffer
8855 (widen)
8856 (goto-char pos)
8857 (org-show-context 'agenda)
8858 (save-excursion
8859 (and (outline-next-heading)
8860 (org-flag-heading nil))) ; show the next heading
8861 (let ((current-prefix-arg arg))
8862 (call-interactively 'org-todo))
8863 (and (bolp) (forward-char 1))
8864 (setq newhead (org-get-heading))
8865 (when (and (org-bound-and-true-p
8866 org-agenda-headline-snapshot-before-repeat)
8867 (not (equal org-agenda-headline-snapshot-before-repeat
8868 newhead))
8869 todayp)
8870 (setq newhead org-agenda-headline-snapshot-before-repeat
8871 just-one t))
8872 (save-excursion
8873 (org-back-to-heading)
8874 (move-marker org-last-heading-marker (point))))
8875 (beginning-of-line 1)
8876 (save-window-excursion
8877 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8878 (when (org-bound-and-true-p org-clock-out-when-done)
8879 (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
8880 newhead)
8881 (org-agenda-unmark-clocking-task))
8882 (org-move-to-column col)
8883 (org-agenda-mark-clocking-task))))
8885 (defun org-agenda-add-note (&optional arg)
8886 "Add a time-stamped note to the entry at point."
8887 (interactive "P")
8888 (org-agenda-check-no-diary)
8889 (let* ((marker (or (org-get-at-bol 'org-marker)
8890 (org-agenda-error)))
8891 (buffer (marker-buffer marker))
8892 (pos (marker-position marker))
8893 (hdmarker (org-get-at-bol 'org-hd-marker))
8894 (inhibit-read-only t))
8895 (with-current-buffer buffer
8896 (widen)
8897 (goto-char pos)
8898 (org-show-context 'agenda)
8899 (save-excursion
8900 (and (outline-next-heading)
8901 (org-flag-heading nil))) ; show the next heading
8902 (org-add-note))))
8904 (defun org-agenda-change-all-lines (newhead hdmarker
8905 &optional fixface just-this)
8906 "Change all lines in the agenda buffer which match HDMARKER.
8907 The new content of the line will be NEWHEAD (as modified by
8908 `org-agenda-format-item'). HDMARKER is checked with
8909 `equal' against all `org-hd-marker' text properties in the file.
8910 If FIXFACE is non-nil, the face of each item is modified according to
8911 the new TODO state.
8912 If JUST-THIS is non-nil, change just the current line, not all.
8913 If FORCE-TAGS is non nil, the car of it returns the new tags."
8914 (let* ((inhibit-read-only t)
8915 (line (org-current-line))
8916 (org-agenda-buffer (current-buffer))
8917 (thetags (with-current-buffer (marker-buffer hdmarker)
8918 (save-excursion (save-restriction (widen)
8919 (goto-char hdmarker)
8920 (org-get-tags-at)))))
8921 props m pl undone-face done-face finish new dotime level cat tags)
8922 (save-excursion
8923 (goto-char (point-max))
8924 (beginning-of-line 1)
8925 (while (not finish)
8926 (setq finish (bobp))
8927 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8928 (or (not just-this) (= (org-current-line) line))
8929 (equal m hdmarker))
8930 (setq props (text-properties-at (point))
8931 dotime (org-get-at-bol 'dotime)
8932 cat (org-get-at-eol 'org-category 1)
8933 level (org-get-at-bol 'level)
8934 tags thetags
8936 (let ((org-prefix-format-compiled
8937 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8938 org-prefix-format-compiled))
8939 (extra (org-get-at-bol 'extra)))
8940 (with-current-buffer (marker-buffer hdmarker)
8941 (save-excursion
8942 (save-restriction
8943 (widen)
8944 (org-agenda-format-item extra newhead level cat tags dotime)))))
8945 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8946 undone-face (org-get-at-bol 'undone-face)
8947 done-face (org-get-at-bol 'done-face))
8948 (beginning-of-line 1)
8949 (cond
8950 ((equal new "")
8951 (and (looking-at ".*\n?") (replace-match "")))
8952 ((looking-at ".*")
8953 (replace-match new t t)
8954 (beginning-of-line 1)
8955 (add-text-properties (point-at-bol) (point-at-eol) props)
8956 (when fixface
8957 (add-text-properties
8958 (point-at-bol) (point-at-eol)
8959 (list 'face
8960 (if org-last-todo-state-is-todo
8961 undone-face done-face))))
8962 (org-agenda-highlight-todo 'line)
8963 (beginning-of-line 1))
8964 (t (error "Line update did not work")))
8965 (save-restriction
8966 (narrow-to-region (point-at-bol) (point-at-eol))
8967 (org-agenda-finalize)))
8968 (beginning-of-line 0)))))
8970 (defun org-agenda-align-tags (&optional line)
8971 "Align all tags in agenda items to `org-agenda-tags-column'."
8972 (let ((inhibit-read-only t) l c)
8973 (save-excursion
8974 (goto-char (if line (point-at-bol) (point-min)))
8975 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8976 (if line (point-at-eol) nil) t)
8977 (add-text-properties
8978 (match-beginning 2) (match-end 2)
8979 (list 'face (delq nil (let ((prop (get-text-property
8980 (match-beginning 2) 'face)))
8981 (or (listp prop) (setq prop (list prop)))
8982 (if (memq 'org-tag prop)
8983 prop
8984 (cons 'org-tag prop))))))
8985 (setq l (- (match-end 2) (match-beginning 2))
8986 c (if (< org-agenda-tags-column 0)
8987 (- (abs org-agenda-tags-column) l)
8988 org-agenda-tags-column))
8989 (delete-region (match-beginning 1) (match-end 1))
8990 (goto-char (match-beginning 1))
8991 (insert (org-add-props
8992 (make-string (max 1 (- c (current-column))) ?\ )
8993 (plist-put (copy-sequence (text-properties-at (point)))
8994 'face nil))))
8995 (goto-char (point-min))
8996 (org-font-lock-add-tag-faces (point-max)))))
8998 (defun org-agenda-priority-up ()
8999 "Increase the priority of line at point, also in Org-mode file."
9000 (interactive)
9001 (org-agenda-priority 'up))
9003 (defun org-agenda-priority-down ()
9004 "Decrease the priority of line at point, also in Org-mode file."
9005 (interactive)
9006 (org-agenda-priority 'down))
9008 (defun org-agenda-priority (&optional force-direction)
9009 "Set the priority of line at point, also in Org-mode file.
9010 This changes the line at point, all other lines in the agenda referring to
9011 the same tree node, and the headline of the tree node in the Org-mode file.
9012 Called with a universal prefix arg, show the priority instead of setting it."
9013 (interactive "P")
9014 (if (equal force-direction '(4))
9015 (org-show-priority)
9016 (unless org-enable-priority-commands
9017 (error "Priority commands are disabled"))
9018 (org-agenda-check-no-diary)
9019 (let* ((col (current-column))
9020 (marker (or (org-get-at-bol 'org-marker)
9021 (org-agenda-error)))
9022 (hdmarker (org-get-at-bol 'org-hd-marker))
9023 (buffer (marker-buffer hdmarker))
9024 (pos (marker-position hdmarker))
9025 (inhibit-read-only t)
9026 newhead)
9027 (org-with-remote-undo buffer
9028 (with-current-buffer buffer
9029 (widen)
9030 (goto-char pos)
9031 (org-show-context 'agenda)
9032 (save-excursion
9033 (and (outline-next-heading)
9034 (org-flag-heading nil))) ; show the next heading
9035 (funcall 'org-priority force-direction)
9036 (end-of-line 1)
9037 (setq newhead (org-get-heading)))
9038 (org-agenda-change-all-lines newhead hdmarker)
9039 (org-move-to-column col)))))
9041 ;; FIXME: should fix the tags property of the agenda line.
9042 (defun org-agenda-set-tags (&optional tag onoff)
9043 "Set tags for the current headline."
9044 (interactive)
9045 (org-agenda-check-no-diary)
9046 (if (and (org-region-active-p) (org-called-interactively-p 'any))
9047 (call-interactively 'org-change-tag-in-region)
9048 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9049 (org-agenda-error)))
9050 (buffer (marker-buffer hdmarker))
9051 (pos (marker-position hdmarker))
9052 (inhibit-read-only t)
9053 newhead)
9054 (org-with-remote-undo buffer
9055 (with-current-buffer buffer
9056 (widen)
9057 (goto-char pos)
9058 (save-excursion
9059 (org-show-context 'agenda))
9060 (save-excursion
9061 (and (outline-next-heading)
9062 (org-flag-heading nil))) ; show the next heading
9063 (goto-char pos)
9064 (if tag
9065 (org-toggle-tag tag onoff)
9066 (call-interactively 'org-set-tags))
9067 (end-of-line 1)
9068 (setq newhead (org-get-heading)))
9069 (org-agenda-change-all-lines newhead hdmarker)
9070 (beginning-of-line 1)))))
9072 (defun org-agenda-set-property ()
9073 "Set a property for the current headline."
9074 (interactive)
9075 (org-agenda-check-no-diary)
9076 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9077 (org-agenda-error)))
9078 (buffer (marker-buffer hdmarker))
9079 (pos (marker-position hdmarker))
9080 (inhibit-read-only t)
9081 newhead)
9082 (org-with-remote-undo buffer
9083 (with-current-buffer buffer
9084 (widen)
9085 (goto-char pos)
9086 (save-excursion
9087 (org-show-context 'agenda))
9088 (save-excursion
9089 (and (outline-next-heading)
9090 (org-flag-heading nil))) ; show the next heading
9091 (goto-char pos)
9092 (call-interactively 'org-set-property)))))
9094 (defun org-agenda-set-effort ()
9095 "Set the effort property for the current headline."
9096 (interactive)
9097 (org-agenda-check-no-diary)
9098 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9099 (org-agenda-error)))
9100 (buffer (marker-buffer hdmarker))
9101 (pos (marker-position hdmarker))
9102 (inhibit-read-only t)
9103 newhead)
9104 (org-with-remote-undo buffer
9105 (with-current-buffer buffer
9106 (widen)
9107 (goto-char pos)
9108 (save-excursion
9109 (org-show-context 'agenda))
9110 (save-excursion
9111 (and (outline-next-heading)
9112 (org-flag-heading nil))) ; show the next heading
9113 (goto-char pos)
9114 (call-interactively 'org-set-effort)
9115 (end-of-line 1)
9116 (setq newhead (org-get-heading)))
9117 (org-agenda-change-all-lines newhead hdmarker))))
9119 (defun org-agenda-toggle-archive-tag ()
9120 "Toggle the archive tag for the current entry."
9121 (interactive)
9122 (org-agenda-check-no-diary)
9123 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9124 (org-agenda-error)))
9125 (buffer (marker-buffer hdmarker))
9126 (pos (marker-position hdmarker))
9127 (inhibit-read-only t)
9128 newhead)
9129 (org-with-remote-undo buffer
9130 (with-current-buffer buffer
9131 (widen)
9132 (goto-char pos)
9133 (org-show-context 'agenda)
9134 (save-excursion
9135 (and (outline-next-heading)
9136 (org-flag-heading nil))) ; show the next heading
9137 (call-interactively 'org-toggle-archive-tag)
9138 (end-of-line 1)
9139 (setq newhead (org-get-heading)))
9140 (org-agenda-change-all-lines newhead hdmarker)
9141 (beginning-of-line 1))))
9143 (defun org-agenda-do-date-later (arg)
9144 (interactive "P")
9145 (cond
9146 ((or (equal arg '(16))
9147 (memq last-command
9148 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9149 (setq this-command 'org-agenda-date-later-minutes)
9150 (org-agenda-date-later-minutes 1))
9151 ((or (equal arg '(4))
9152 (memq last-command
9153 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9154 (setq this-command 'org-agenda-date-later-hours)
9155 (org-agenda-date-later-hours 1))
9157 (org-agenda-date-later (prefix-numeric-value arg)))))
9159 (defun org-agenda-do-date-earlier (arg)
9160 (interactive "P")
9161 (cond
9162 ((or (equal arg '(16))
9163 (memq last-command
9164 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9165 (setq this-command 'org-agenda-date-earlier-minutes)
9166 (org-agenda-date-earlier-minutes 1))
9167 ((or (equal arg '(4))
9168 (memq last-command
9169 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9170 (setq this-command 'org-agenda-date-earlier-hours)
9171 (org-agenda-date-earlier-hours 1))
9173 (org-agenda-date-earlier (prefix-numeric-value arg)))))
9175 (defun org-agenda-date-later (arg &optional what)
9176 "Change the date of this item to ARG day(s) later."
9177 (interactive "p")
9178 (org-agenda-check-type t 'agenda 'timeline)
9179 (org-agenda-check-no-diary)
9180 (let* ((marker (or (org-get-at-bol 'org-marker)
9181 (org-agenda-error)))
9182 (buffer (marker-buffer marker))
9183 (pos (marker-position marker))
9184 cdate today)
9185 (org-with-remote-undo buffer
9186 (with-current-buffer buffer
9187 (widen)
9188 (goto-char pos)
9189 (if (not (org-at-timestamp-p))
9190 (error "Cannot find time stamp"))
9191 (when (and org-agenda-move-date-from-past-immediately-to-today
9192 (equal arg 1)
9193 (or (not what) (eq what 'day))
9194 (not (save-match-data (org-at-date-range-p))))
9195 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
9196 cdate (calendar-absolute-from-gregorian
9197 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
9198 today (org-today))
9199 (if (> today cdate)
9200 ;; immediately shift to today
9201 (setq arg (- today cdate))))
9202 (org-timestamp-change arg (or what 'day))
9203 (when (and (org-at-date-range-p)
9204 (re-search-backward org-tr-regexp-both (point-at-bol)))
9205 (let ((end org-last-changed-timestamp))
9206 (org-timestamp-change arg (or what 'day))
9207 (setq org-last-changed-timestamp
9208 (concat org-last-changed-timestamp "--" end)))))
9209 (org-agenda-show-new-time marker org-last-changed-timestamp))
9210 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9212 (defun org-agenda-date-earlier (arg &optional what)
9213 "Change the date of this item to ARG day(s) earlier."
9214 (interactive "p")
9215 (org-agenda-date-later (- arg) what))
9217 (defun org-agenda-date-later-minutes (arg)
9218 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9219 (interactive "p")
9220 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9221 (org-agenda-date-later arg 'minute))
9223 (defun org-agenda-date-earlier-minutes (arg)
9224 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9225 (interactive "p")
9226 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9227 (org-agenda-date-earlier arg 'minute))
9229 (defun org-agenda-date-later-hours (arg)
9230 "Change the time of this item, in hour steps."
9231 (interactive "p")
9232 (org-agenda-date-later arg 'hour))
9234 (defun org-agenda-date-earlier-hours (arg)
9235 "Change the time of this item, in hour steps."
9236 (interactive "p")
9237 (org-agenda-date-earlier arg 'hour))
9239 (defun org-agenda-show-new-time (marker stamp &optional prefix)
9240 "Show new date stamp via text properties."
9241 ;; We use text properties to make this undoable
9242 (let ((inhibit-read-only t))
9243 (setq stamp (concat prefix " => " stamp " "))
9244 (save-excursion
9245 (goto-char (point-max))
9246 (while (not (bobp))
9247 (when (equal marker (org-get-at-bol 'org-marker))
9248 (remove-text-properties (point-at-bol) (point-at-eol) '(display))
9249 (org-move-to-column (- (window-width) (length stamp)) t)
9250 (if (featurep 'xemacs)
9251 ;; Use `duplicable' property to trigger undo recording
9252 (let ((ex (make-extent nil nil))
9253 (gl (make-glyph stamp)))
9254 (set-glyph-face gl 'secondary-selection)
9255 (set-extent-properties
9256 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9257 (insert-extent ex (1- (point)) (point-at-eol)))
9258 (add-text-properties
9259 (1- (point)) (point-at-eol)
9260 (list 'display (org-add-props stamp nil
9261 'face '(secondary-selection default)))))
9262 (beginning-of-line 1))
9263 (beginning-of-line 0)))))
9265 (defun org-agenda-date-prompt (arg)
9266 "Change the date of this item. Date is prompted for, with default today.
9267 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9268 be used to request time specification in the time stamp."
9269 (interactive "P")
9270 (org-agenda-check-type t 'agenda 'timeline)
9271 (org-agenda-check-no-diary)
9272 (let* ((marker (or (org-get-at-bol 'org-marker)
9273 (org-agenda-error)))
9274 (buffer (marker-buffer marker))
9275 (pos (marker-position marker)))
9276 (org-with-remote-undo buffer
9277 (with-current-buffer buffer
9278 (widen)
9279 (goto-char pos)
9280 (if (not (org-at-timestamp-p t))
9281 (error "Cannot find time stamp"))
9282 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9283 (org-agenda-show-new-time marker org-last-changed-timestamp))
9284 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9286 (defun org-agenda-schedule (arg &optional time)
9287 "Schedule the item at point.
9288 ARG is passed through to `org-schedule'."
9289 (interactive "P")
9290 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9291 (org-agenda-check-no-diary)
9292 (let* ((marker (or (org-get-at-bol 'org-marker)
9293 (org-agenda-error)))
9294 (type (marker-insertion-type marker))
9295 (buffer (marker-buffer marker))
9296 (pos (marker-position marker))
9298 (set-marker-insertion-type marker t)
9299 (org-with-remote-undo buffer
9300 (with-current-buffer buffer
9301 (widen)
9302 (goto-char pos)
9303 (setq ts (org-schedule arg time)))
9304 (org-agenda-show-new-time marker ts " S"))
9305 (message "%s" ts)))
9307 (defun org-agenda-deadline (arg &optional time)
9308 "Schedule the item at point.
9309 ARG is passed through to `org-deadline'."
9310 (interactive "P")
9311 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9312 (org-agenda-check-no-diary)
9313 (let* ((marker (or (org-get-at-bol 'org-marker)
9314 (org-agenda-error)))
9315 (buffer (marker-buffer marker))
9316 (pos (marker-position marker))
9318 (org-with-remote-undo buffer
9319 (with-current-buffer buffer
9320 (widen)
9321 (goto-char pos)
9322 (setq ts (org-deadline arg time)))
9323 (org-agenda-show-new-time marker ts " D"))
9324 (message "%s" ts)))
9326 (defun org-agenda-clock-in (&optional arg)
9327 "Start the clock on the currently selected item."
9328 (interactive "P")
9329 (org-agenda-check-no-diary)
9330 (if (equal arg '(4))
9331 (org-clock-in arg)
9332 (let* ((marker (or (org-get-at-bol 'org-marker)
9333 (org-agenda-error)))
9334 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9335 (pos (marker-position marker))
9336 (col (current-column))
9337 newhead)
9338 (org-with-remote-undo (marker-buffer marker)
9339 (with-current-buffer (marker-buffer marker)
9340 (widen)
9341 (goto-char pos)
9342 (org-show-context 'agenda)
9343 (org-show-entry)
9344 (org-cycle-hide-drawers 'children)
9345 (org-clock-in arg)
9346 (setq newhead (org-get-heading)))
9347 (org-agenda-change-all-lines newhead hdmarker))
9348 (org-move-to-column col))))
9350 (defun org-agenda-clock-out ()
9351 "Stop the currently running clock."
9352 (interactive)
9353 (unless (marker-buffer org-clock-marker)
9354 (error "No running clock"))
9355 (let ((marker (make-marker)) (col (current-column)) newhead)
9356 (org-with-remote-undo (marker-buffer org-clock-marker)
9357 (with-current-buffer (marker-buffer org-clock-marker)
9358 (save-excursion
9359 (save-restriction
9360 (widen)
9361 (goto-char org-clock-marker)
9362 (org-back-to-heading t)
9363 (move-marker marker (point))
9364 (org-clock-out)
9365 (setq newhead (org-get-heading))))))
9366 (org-agenda-change-all-lines newhead marker)
9367 (move-marker marker nil)
9368 (org-move-to-column col)
9369 (org-agenda-unmark-clocking-task)))
9371 (defun org-agenda-clock-cancel (&optional arg)
9372 "Cancel the currently running clock."
9373 (interactive "P")
9374 (unless (marker-buffer org-clock-marker)
9375 (user-error "No running clock"))
9376 (org-with-remote-undo (marker-buffer org-clock-marker)
9377 (org-clock-cancel)))
9379 (defun org-agenda-clock-goto ()
9380 "Jump to the currently clocked in task within the agenda.
9381 If the currently clocked in task is not listed in the agenda
9382 buffer, display it in another window."
9383 (interactive)
9384 (let (pos)
9385 (mapc (lambda (o)
9386 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9387 (setq pos (overlay-start o))))
9388 (overlays-in (point-min) (point-max)))
9389 (cond (pos (goto-char pos))
9390 ;; If the currently clocked entry is not in the agenda
9391 ;; buffer, we visit it in another window:
9392 (org-clock-current-task
9393 (org-switch-to-buffer-other-window (org-clock-goto)))
9394 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9396 (defun org-agenda-diary-entry-in-org-file ()
9397 "Make a diary entry in the file `org-agenda-diary-file'."
9398 (let (d1 d2 char (text "") dp1 dp2)
9399 (if (equal (buffer-name) "*Calendar*")
9400 (setq d1 (calendar-cursor-to-date t)
9401 d2 (car calendar-mark-ring))
9402 (setq dp1 (get-text-property (point-at-bol) 'day))
9403 (unless dp1 (user-error "No date defined in current line"))
9404 (setq d1 (calendar-gregorian-from-absolute dp1)
9405 d2 (and (ignore-errors (mark))
9406 (save-excursion
9407 (goto-char (mark))
9408 (setq dp2 (get-text-property (point-at-bol) 'day)))
9409 (calendar-gregorian-from-absolute dp2))))
9410 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9411 (setq char (read-char-exclusive))
9412 (cond
9413 ((equal char ?d)
9414 (setq text (read-string "Day entry: "))
9415 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9416 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9417 ((equal char ?a)
9418 (setq d1 (list (car d1) (nth 1 d1)
9419 (read-number (format "Reference year [%d]: " (nth 2 d1))
9420 (nth 2 d1))))
9421 (setq text (read-string "Anniversary (use %d to show years): "))
9422 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9423 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9424 ((equal char ?b)
9425 (setq text (read-string "Block entry: "))
9426 (unless (and d1 d2 (not (equal d1 d2)))
9427 (user-error "No block of days selected"))
9428 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9429 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9430 ((equal char ?j)
9431 (org-switch-to-buffer-other-window
9432 (find-file-noselect org-agenda-diary-file))
9433 (require 'org-datetree)
9434 (org-datetree-find-date-create d1)
9435 (org-reveal t))
9436 (t (user-error "Invalid selection character `%c'" char)))))
9438 (defcustom org-agenda-insert-diary-strategy 'date-tree
9439 "Where in `org-agenda-diary-file' should new entries be added?
9440 Valid values:
9442 date-tree in the date tree, as first child of the date
9443 date-tree-last in the date tree, as last child of the date
9444 top-level as top-level entries at the end of the file."
9445 :group 'org-agenda
9446 :type '(choice
9447 (const :tag "first in a date tree" date-tree)
9448 (const :tag "last in a date tree" date-tree-last)
9449 (const :tag "as top level at end of file" top-level)))
9451 (defcustom org-agenda-insert-diary-extract-time nil
9452 "Non-nil means extract any time specification from the diary entry."
9453 :group 'org-agenda
9454 :version "24.1"
9455 :type 'boolean)
9457 (defcustom org-agenda-bulk-mark-char ">"
9458 "A single-character string to be used as the bulk mark."
9459 :group 'org-agenda
9460 :version "24.1"
9461 :type 'string)
9463 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9464 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9465 If TEXT is not empty, it will become the headline of the new entry, and
9466 the resulting entry will not be shown. When TEXT is empty, switch to
9467 `org-agenda-diary-file' and let the user finish the entry there."
9468 (let ((cw (current-window-configuration)))
9469 (org-switch-to-buffer-other-window
9470 (find-file-noselect org-agenda-diary-file))
9471 (widen)
9472 (goto-char (point-min))
9473 (cond
9474 ((eq type 'anniversary)
9475 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9476 (progn
9477 (or (org-at-heading-p t)
9478 (progn
9479 (outline-next-heading)
9480 (insert "* Anniversaries\n\n")
9481 (beginning-of-line -1)))))
9482 (outline-next-heading)
9483 (org-back-over-empty-lines)
9484 (backward-char 1)
9485 (insert "\n")
9486 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9487 (nth 2 d1) (car d1) (nth 1 d1) text)))
9488 ((eq type 'day)
9489 (let ((org-prefix-has-time t)
9490 (org-agenda-time-leading-zero t)
9491 fmt time time2)
9492 (if org-agenda-insert-diary-extract-time
9493 ;; Use org-agenda-format-item to parse text for a time-range and
9494 ;; remove it. FIXME: This is a hack, we should refactor
9495 ;; that function to make time extraction available separately
9496 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9497 time (get-text-property 0 'time fmt)
9498 time2 (if (> (length time) 0)
9499 ;; split-string removes trailing ...... if
9500 ;; no end time given. First space
9501 ;; separates time from date.
9502 (concat " " (car (split-string time "\\.")))
9503 nil)
9504 text (get-text-property 0 'txt fmt)))
9505 (if (eq org-agenda-insert-diary-strategy 'top-level)
9506 (org-agenda-insert-diary-as-top-level text)
9507 (require 'org-datetree)
9508 (org-datetree-find-date-create d1)
9509 (org-agenda-insert-diary-make-new-entry text))
9510 (org-insert-time-stamp (org-time-from-absolute
9511 (calendar-absolute-from-gregorian d1))
9512 nil nil nil nil time2))
9513 (end-of-line 0))
9514 ((eq type 'block)
9515 (if (> (calendar-absolute-from-gregorian d1)
9516 (calendar-absolute-from-gregorian d2))
9517 (setq d1 (prog1 d2 (setq d2 d1))))
9518 (if (eq org-agenda-insert-diary-strategy 'top-level)
9519 (org-agenda-insert-diary-as-top-level text)
9520 (require 'org-datetree)
9521 (org-datetree-find-date-create d1)
9522 (org-agenda-insert-diary-make-new-entry text))
9523 (org-insert-time-stamp (org-time-from-absolute
9524 (calendar-absolute-from-gregorian d1)))
9525 (insert "--")
9526 (org-insert-time-stamp (org-time-from-absolute
9527 (calendar-absolute-from-gregorian d2)))
9528 (end-of-line 0)))
9529 (if (string-match "\\S-" text)
9530 (progn
9531 (set-window-configuration cw)
9532 (message "%s entry added to %s"
9533 (capitalize (symbol-name type))
9534 (abbreviate-file-name org-agenda-diary-file)))
9535 (org-reveal t)
9536 (message "Please finish entry here"))))
9538 (defun org-agenda-insert-diary-as-top-level (text)
9539 "Make new entry as a top-level entry at the end of the file.
9540 Add TEXT as headline, and position the cursor in the second line so that
9541 a timestamp can be added there."
9542 (widen)
9543 (goto-char (point-max))
9544 (unless (bolp) (insert "\n"))
9545 (org-insert-heading nil t t)
9546 (insert text)
9547 (org-end-of-meta-data)
9548 (unless (bolp) (insert "\n"))
9549 (when org-adapt-indentation (org-indent-to-column 2)))
9551 (defun org-agenda-insert-diary-make-new-entry (text)
9552 "Make a new entry with TEXT as a child of the current subtree.
9553 Position the point in the heading's first body line so that
9554 a timestamp can be added there."
9555 (cond
9556 ((eq org-agenda-insert-diary-strategy 'date-tree-last)
9557 (end-of-line)
9558 (org-insert-heading '(4) t)
9559 (org-do-demote))
9561 (outline-next-heading)
9562 (org-back-over-empty-lines)
9563 (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
9564 (org-insert-heading nil t)
9565 (org-do-demote)))
9566 (let ((col (current-column)))
9567 (insert text)
9568 (org-end-of-meta-data)
9569 ;; Ensure point is left on a blank line, at proper indentation.
9570 (unless (bolp) (insert "\n"))
9571 (unless (org-looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
9572 (when org-adapt-indentation (org-indent-to-column col)))
9573 (org-show-set-visibility 'lineage))
9575 (defun org-agenda-diary-entry ()
9576 "Make a diary entry, like the `i' command from the calendar.
9577 All the standard commands work: block, weekly etc.
9578 When `org-agenda-diary-file' points to a file,
9579 `org-agenda-diary-entry-in-org-file' is called instead to create
9580 entries in that Org-mode file."
9581 (interactive)
9582 (if (not (eq org-agenda-diary-file 'diary-file))
9583 (org-agenda-diary-entry-in-org-file)
9584 (require 'diary-lib)
9585 (let* ((char (progn
9586 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9587 (read-char-exclusive)))
9588 (cmd (cdr (assoc char
9589 '((?d . diary-insert-entry)
9590 (?w . diary-insert-weekly-entry)
9591 (?m . diary-insert-monthly-entry)
9592 (?y . diary-insert-yearly-entry)
9593 (?a . diary-insert-anniversary-entry)
9594 (?b . diary-insert-block-entry)
9595 (?c . diary-insert-cyclic-entry)))))
9596 (oldf (symbol-function 'calendar-cursor-to-date))
9597 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9598 (point (point))
9599 (mark (or (mark t) (point))))
9600 (unless cmd
9601 (user-error "No command associated with <%c>" char))
9602 (unless (and (get-text-property point 'day)
9603 (or (not (equal ?b char))
9604 (get-text-property mark 'day)))
9605 (user-error "Don't know which date to use for diary entry"))
9606 ;; We implement this by hacking the `calendar-cursor-to-date' function
9607 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9608 (let ((calendar-mark-ring
9609 (list (calendar-gregorian-from-absolute
9610 (or (get-text-property mark 'day)
9611 (get-text-property point 'day))))))
9612 (unwind-protect
9613 (progn
9614 (fset 'calendar-cursor-to-date
9615 (lambda (&optional error dummy)
9616 (calendar-gregorian-from-absolute
9617 (get-text-property point 'day))))
9618 (call-interactively cmd))
9619 (fset 'calendar-cursor-to-date oldf))))))
9621 (defun org-agenda-execute-calendar-command (cmd)
9622 "Execute a calendar command from the agenda with date from cursor."
9623 (org-agenda-check-type t 'agenda 'timeline)
9624 (require 'diary-lib)
9625 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9626 (user-error "Don't know which date to use for the calendar command"))
9627 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9628 (point (point))
9629 (date (calendar-gregorian-from-absolute
9630 (get-text-property point 'day)))
9631 ;; the following 2 vars are needed in the calendar
9632 (displayed-month (car date))
9633 (displayed-year (nth 2 date)))
9634 (unwind-protect
9635 (progn
9636 (fset 'calendar-cursor-to-date
9637 (lambda (&optional error dummy)
9638 (calendar-gregorian-from-absolute
9639 (get-text-property point 'day))))
9640 (call-interactively cmd))
9641 (fset 'calendar-cursor-to-date oldf))))
9643 (defun org-agenda-phases-of-moon ()
9644 "Display the phases of the moon for the 3 months around the cursor date."
9645 (interactive)
9646 (org-agenda-execute-calendar-command 'calendar-lunar-phases))
9648 (defun org-agenda-holidays ()
9649 "Display the holidays for the 3 months around the cursor date."
9650 (interactive)
9651 (org-agenda-execute-calendar-command 'calendar-list-holidays))
9653 (defvar calendar-longitude) ; defined in calendar.el
9654 (defvar calendar-latitude) ; defined in calendar.el
9655 (defvar calendar-location-name) ; defined in calendar.el
9657 (defun org-agenda-sunrise-sunset (arg)
9658 "Display sunrise and sunset for the cursor date.
9659 Latitude and longitude can be specified with the variables
9660 `calendar-latitude' and `calendar-longitude'. When called with prefix
9661 argument, latitude and longitude will be prompted for."
9662 (interactive "P")
9663 (require 'solar)
9664 (let ((calendar-longitude (if arg nil calendar-longitude))
9665 (calendar-latitude (if arg nil calendar-latitude))
9666 (calendar-location-name
9667 (if arg "the given coordinates" calendar-location-name)))
9668 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9670 (defun org-agenda-goto-calendar ()
9671 "Open the Emacs calendar with the date at the cursor."
9672 (interactive)
9673 (org-agenda-check-type t 'agenda 'timeline)
9674 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9675 (user-error "Don't know which date to open in calendar")))
9676 (date (calendar-gregorian-from-absolute day))
9677 (calendar-move-hook nil)
9678 (calendar-view-holidays-initially-flag nil)
9679 (calendar-view-diary-initially-flag nil))
9680 (calendar)
9681 (calendar-goto-date date)))
9683 ;;;###autoload
9684 (defun org-calendar-goto-agenda ()
9685 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9686 This is a command that has to be installed in `calendar-mode-map'."
9687 (interactive)
9688 ;; Temporarily disable sticky agenda since user clearly wants to
9689 ;; refresh view anyway.
9690 (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
9691 (org-agenda-sticky nil))
9692 (org-agenda-list nil (calendar-absolute-from-gregorian
9693 (calendar-cursor-to-date))
9694 nil)))
9696 (defun org-agenda-convert-date ()
9697 (interactive)
9698 (org-agenda-check-type t 'agenda 'timeline)
9699 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9700 date s)
9701 (unless day
9702 (user-error "Don't know which date to convert"))
9703 (setq date (calendar-gregorian-from-absolute day))
9704 (setq s (concat
9705 "Gregorian: " (calendar-date-string date) "\n"
9706 "ISO: " (calendar-iso-date-string date) "\n"
9707 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9708 "Julian: " (calendar-julian-date-string date) "\n"
9709 "Astron. JD: " (calendar-astro-date-string date)
9710 " (Julian date number at noon UTC)\n"
9711 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9712 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9713 "French: " (calendar-french-date-string date) "\n"
9714 "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
9715 "Mayan: " (calendar-mayan-date-string date) "\n"
9716 "Coptic: " (calendar-coptic-date-string date) "\n"
9717 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9718 "Persian: " (calendar-persian-date-string date) "\n"
9719 "Chinese: " (calendar-chinese-date-string date) "\n"))
9720 (with-output-to-temp-buffer "*Dates*"
9721 (princ s))
9722 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9724 ;;; Bulk commands
9726 (defun org-agenda-bulk-marked-p ()
9727 (eq (get-char-property (point-at-bol) 'type)
9728 'org-marked-entry-overlay))
9730 (defun org-agenda-bulk-mark (&optional arg)
9731 "Mark the entry at point for future bulk action."
9732 (interactive "p")
9733 (dotimes (i (or arg 1))
9734 (unless (org-get-at-bol 'org-agenda-diary-link)
9735 (let* ((m (org-get-at-bol 'org-hd-marker))
9737 (unless (org-agenda-bulk-marked-p)
9738 (unless m (user-error "Nothing to mark at point"))
9739 (push m org-agenda-bulk-marked-entries)
9740 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9741 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9742 (org-get-todo-face "TODO")
9743 'evaporate)
9744 (overlay-put ov 'type 'org-marked-entry-overlay))
9745 (end-of-line 1)
9746 (or (ignore-errors
9747 (goto-char (next-single-property-change (point) 'org-hd-marker)))
9748 (beginning-of-line 2))
9749 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9750 (beginning-of-line 2))
9751 (message "%d entries marked for bulk action"
9752 (length org-agenda-bulk-marked-entries))))))
9754 (defun org-agenda-bulk-mark-all ()
9755 "Mark all entries for future agenda bulk action."
9756 (interactive)
9757 (org-agenda-bulk-mark-regexp "."))
9759 (defun org-agenda-bulk-mark-regexp (regexp)
9760 "Mark entries matching REGEXP for future agenda bulk action."
9761 (interactive "sMark entries matching regexp: ")
9762 (let ((entries-marked 0) txt-at-point)
9763 (save-excursion
9764 (goto-char (point-min))
9765 (goto-char (next-single-property-change (point) 'org-hd-marker))
9766 (while (and (re-search-forward regexp nil t)
9767 (setq txt-at-point (get-text-property (point) 'txt)))
9768 (when (string-match regexp txt-at-point)
9769 (setq entries-marked (1+ entries-marked))
9770 (call-interactively 'org-agenda-bulk-mark))))
9771 (if (not entries-marked)
9772 (message "No entry matching this regexp."))))
9774 (defun org-agenda-bulk-unmark (&optional arg)
9775 "Unmark the entry at point for future bulk action."
9776 (interactive "P")
9777 (if arg
9778 (org-agenda-bulk-unmark-all)
9779 (cond ((org-agenda-bulk-marked-p)
9780 (org-agenda-bulk-remove-overlays
9781 (point-at-bol) (+ 2 (point-at-bol)))
9782 (setq org-agenda-bulk-marked-entries
9783 (delete (org-get-at-bol 'org-hd-marker)
9784 org-agenda-bulk-marked-entries))
9785 (end-of-line 1)
9786 (or (ignore-errors
9787 (goto-char (next-single-property-change (point) 'txt)))
9788 (beginning-of-line 2))
9789 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9790 (beginning-of-line 2))
9791 (message "%d entries left marked for bulk action"
9792 (length org-agenda-bulk-marked-entries)))
9793 (t (message "No entry to unmark here")))))
9795 (defun org-agenda-bulk-toggle-all ()
9796 "Toggle all marks for bulk action."
9797 (interactive)
9798 (save-excursion
9799 (goto-char (point-min))
9800 (while (ignore-errors
9801 (goto-char (next-single-property-change (point) 'org-hd-marker)))
9802 (org-agenda-bulk-toggle))))
9804 (defun org-agenda-bulk-toggle ()
9805 "Toggle the mark at point for bulk action."
9806 (interactive)
9807 (if (org-agenda-bulk-marked-p)
9808 (org-agenda-bulk-unmark)
9809 (org-agenda-bulk-mark)))
9811 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9812 "Remove the mark overlays between BEG and END in the agenda buffer.
9813 BEG and END default to the buffer limits.
9815 This only removes the overlays, it does not remove the markers
9816 from the list in `org-agenda-bulk-marked-entries'."
9817 (interactive)
9818 (mapc (lambda (ov)
9819 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9820 (delete-overlay ov)))
9821 (overlays-in (or beg (point-min)) (or end (point-max)))))
9823 (defun org-agenda-bulk-unmark-all ()
9824 "Remove all marks in the agenda buffer.
9825 This will remove the markers and the overlays."
9826 (interactive)
9827 (if (null org-agenda-bulk-marked-entries)
9828 (message "No entry to unmark")
9829 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9830 (setq org-agenda-bulk-marked-entries nil)
9831 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9833 (defcustom org-agenda-persistent-marks nil
9834 "Non-nil means marked items will stay marked after a bulk action.
9835 You can toggle this interactively by typing `p' when prompted for a
9836 bulk action."
9837 :group 'org-agenda
9838 :version "24.1"
9839 :type 'boolean)
9841 (defun org-agenda-bulk-action (&optional arg)
9842 "Execute an remote-editing action on all marked entries.
9843 The prefix arg is passed through to the command if possible."
9844 (interactive "P")
9845 ;; Make sure we have markers, and only valid ones
9846 (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
9847 (mapc
9848 (lambda (m)
9849 (unless (and (markerp m)
9850 (marker-buffer m)
9851 (buffer-live-p (marker-buffer m))
9852 (marker-position m))
9853 (user-error "Marker %s for bulk command is invalid" m)))
9854 org-agenda-bulk-marked-entries)
9856 ;; Prompt for the bulk command
9857 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9858 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9859 "[S]catter [f]unction "
9860 (when org-agenda-bulk-custom-functions
9861 (concat " Custom: ["
9862 (mapconcat (lambda(f) (char-to-string (car f)))
9863 org-agenda-bulk-custom-functions "")
9864 "]"))))
9865 (catch 'exit
9866 (let* ((action (read-char-exclusive))
9867 (org-log-refile (if org-log-refile 'time nil))
9868 (entries (reverse org-agenda-bulk-marked-entries))
9869 (org-overriding-default-time
9870 (if (get-text-property (point) 'org-agenda-date-header)
9871 (org-get-cursor-date)))
9872 redo-at-end
9873 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9874 (cond
9875 ((equal action ?p)
9876 (let ((org-agenda-persistent-marks
9877 (not org-agenda-persistent-marks)))
9878 (org-agenda-bulk-action)
9879 (throw 'exit nil)))
9881 ((equal action ?$)
9882 (setq cmd '(org-agenda-archive)))
9884 ((equal action ?A)
9885 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9887 ((member action '(?r ?w))
9888 (setq rfloc (org-refile-get-location
9889 "Refile to"
9890 (marker-buffer (car entries))
9891 org-refile-allow-creating-parent-nodes))
9892 (if (nth 3 rfloc)
9893 (setcar (nthcdr 3 rfloc)
9894 (move-marker (make-marker) (nth 3 rfloc)
9895 (or (get-file-buffer (nth 1 rfloc))
9896 (find-buffer-visiting (nth 1 rfloc))
9897 (error "This should not happen")))))
9899 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9900 redo-at-end t))
9902 ((equal action ?t)
9903 (setq state (org-icompleting-read
9904 "Todo state: "
9905 (with-current-buffer (marker-buffer (car entries))
9906 (mapcar 'list org-todo-keywords-1))))
9907 (setq cmd `(let ((org-inhibit-blocking t)
9908 (org-inhibit-logging 'note))
9909 (org-agenda-todo ,state))))
9911 ((memq action '(?- ?+))
9912 (setq tag (org-icompleting-read
9913 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9914 (with-current-buffer (marker-buffer (car entries))
9915 (delq nil
9916 (mapcar (lambda (x)
9917 (if (stringp (car x)) x)) org-tag-alist)))))
9918 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9920 ((memq action '(?s ?d))
9921 (let* ((time
9922 (unless arg
9923 (org-read-date
9924 nil nil nil
9925 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9926 org-overriding-default-time)))
9927 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9928 (setq cmd `(eval '(,c1 arg ,time)))))
9930 ((equal action ?S)
9931 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9932 (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9933 (let ((days (read-number
9934 (format "Scatter tasks across how many %sdays: "
9935 (if arg "week" "")) 7)))
9936 (setq cmd
9937 `(let ((distance (1+ (random ,days))))
9938 (if arg
9939 (let ((dist distance)
9940 (day-of-week
9941 (calendar-day-of-week
9942 (calendar-gregorian-from-absolute (org-today)))))
9943 (dotimes (i (1+ dist))
9944 (while (member day-of-week org-agenda-weekend-days)
9945 (incf distance)
9946 (incf day-of-week)
9947 (if (= day-of-week 7)
9948 (setq day-of-week 0)))
9949 (incf day-of-week)
9950 (if (= day-of-week 7)
9951 (setq day-of-week 0)))))
9952 ;; silently fail when try to replan a sexp entry
9953 (condition-case nil
9954 (let* ((date (calendar-gregorian-from-absolute
9955 (+ (org-today) distance)))
9956 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9957 (nth 2 date))))
9958 (org-agenda-schedule nil time))
9959 (error nil)))))))
9961 ((assoc action org-agenda-bulk-custom-functions)
9962 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9963 redo-at-end t))
9965 ((equal action ?f)
9966 (setq cmd (list (intern
9967 (org-icompleting-read "Function: "
9968 obarray 'fboundp t nil nil)))))
9970 (t (user-error "Invalid bulk action")))
9972 ;; Sort the markers, to make sure that parents are handled before children
9973 (setq entries (sort entries
9974 (lambda (a b)
9975 (cond
9976 ((equal (marker-buffer a) (marker-buffer b))
9977 (< (marker-position a) (marker-position b)))
9979 (string< (buffer-name (marker-buffer a))
9980 (buffer-name (marker-buffer b))))))))
9982 ;; Now loop over all markers and apply cmd
9983 (while (setq e (pop entries))
9984 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9985 (if (not pos)
9986 (progn (message "Skipping removed entry at %s" e)
9987 (setq cntskip (1+ cntskip)))
9988 (goto-char pos)
9989 (let (org-loop-over-headlines-in-active-region)
9990 (eval cmd))
9991 ;; `post-command-hook' is not run yet. We make sure any
9992 ;; pending log note is processed.
9993 (when (or (memq 'org-add-log-note (default-value 'post-command-hook))
9994 (memq 'org-add-log-note post-command-hook))
9995 (org-add-log-note))
9996 (setq cnt (1+ cnt))))
9997 (when redo-at-end (org-agenda-redo))
9998 (unless org-agenda-persistent-marks
9999 (org-agenda-bulk-unmark-all))
10000 (message "Acted on %d entries%s%s"
10002 (if (= cntskip 0)
10004 (format ", skipped %d (disappeared before their turn)"
10005 cntskip))
10006 (if (not org-agenda-persistent-marks)
10007 "" " (kept marked)"))))))
10009 (defun org-agenda-capture (&optional with-time)
10010 "Call `org-capture' with the date at point.
10011 With a `C-1' prefix, use the HH:MM value at point (if any) or the
10012 current HH:MM time."
10013 (interactive "P")
10014 (if (not (eq major-mode 'org-agenda-mode))
10015 (user-error "You cannot do this outside of agenda buffers")
10016 (let ((org-overriding-default-time
10017 (org-get-cursor-date (equal with-time 1))))
10018 (call-interactively 'org-capture))))
10020 ;;; Dragging agenda lines forward/backward
10022 (defun org-agenda-reapply-filters ()
10023 "Re-apply all agenda filters."
10024 (mapcar
10025 (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
10026 `((,org-agenda-tag-filter tag)
10027 (,org-agenda-category-filter category)
10028 (,org-agenda-regexp-filter regexp)
10029 (,org-agenda-effort-filter effort)
10030 (,(get 'org-agenda-tag-filter :preset-filter) tag)
10031 (,(get 'org-agenda-category-filter :preset-filter) category)
10032 (,(get 'org-agenda-effort-filter :preset-filter) effort)
10033 (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
10035 (defun org-agenda-drag-line-forward (arg &optional backward)
10036 "Drag an agenda line forward by ARG lines.
10037 When the optional argument `backward' is non-nil, move backward."
10038 (interactive "p")
10039 (let ((inhibit-read-only t) lst line)
10040 (if (or (not (get-text-property (point) 'txt))
10041 (save-excursion
10042 (dotimes (n arg)
10043 (move-beginning-of-line (if backward 0 2))
10044 (push (not (get-text-property (point) 'txt)) lst))
10045 (delq nil lst)))
10046 (message "Cannot move line forward")
10047 (let ((end (save-excursion (move-beginning-of-line 2) (point))))
10048 (move-beginning-of-line 1)
10049 (setq line (buffer-substring (point) end))
10050 (delete-region (point) end)
10051 (move-beginning-of-line (funcall (if backward '1- '1+) arg))
10052 (insert line)
10053 (org-agenda-reapply-filters)
10054 (org-agenda-mark-clocking-task)
10055 (move-beginning-of-line 0)))))
10057 (defun org-agenda-drag-line-backward (arg)
10058 "Drag an agenda line backward by ARG lines."
10059 (interactive "p")
10060 (org-agenda-drag-line-forward arg t))
10062 ;;; Flagging notes
10064 (defun org-agenda-show-the-flagging-note ()
10065 "Display the flagging note in the other window.
10066 When called a second time in direct sequence, offer to remove the FLAGGING
10067 tag and (if present) the flagging note."
10068 (interactive)
10069 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
10070 (win (selected-window))
10071 note heading newhead)
10072 (unless hdmarker
10073 (user-error "No linked entry at point"))
10074 (if (and (eq this-command last-command)
10075 (y-or-n-p "Unflag and remove any flagging note? "))
10076 (progn
10077 (org-agenda-remove-flag hdmarker)
10078 (let ((win (get-buffer-window "*Flagging Note*")))
10079 (and win (delete-window win)))
10080 (message "Entry unflagged"))
10081 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
10082 (unless note
10083 (user-error "No flagging note"))
10084 (org-kill-new note)
10085 (org-switch-to-buffer-other-window "*Flagging Note*")
10086 (erase-buffer)
10087 (insert note)
10088 (goto-char (point-min))
10089 (while (re-search-forward "\\\\n" nil t)
10090 (replace-match "\n" t t))
10091 (goto-char (point-min))
10092 (select-window win)
10093 (message (substitute-command-keys "Flagging note pushed to kill ring. \
10094 Press \\[org-agenda-show-the-flagging-note] again to remove tag and note")))))
10096 (defun org-agenda-remove-flag (marker)
10097 "Remove the FLAGGED tag and any flagging note in the entry."
10098 (let (newhead)
10099 (org-with-point-at marker
10100 (org-toggle-tag "FLAGGED" 'off)
10101 (org-entry-delete nil "THEFLAGGINGNOTE")
10102 (setq newhead (org-get-heading)))
10103 (org-agenda-change-all-lines newhead marker)
10104 (message "Entry unflagged")))
10106 (defun org-agenda-get-any-marker (&optional pos)
10107 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
10108 (get-text-property (or pos (point-at-bol)) 'org-marker)))
10110 ;;; Appointment reminders
10112 (defvar appt-time-msg-list) ; defined in appt.el
10114 ;;;###autoload
10115 (defun org-agenda-to-appt (&optional refresh filter &rest args)
10116 "Activate appointments found in `org-agenda-files'.
10117 With a \\[universal-argument] prefix, refresh the list of
10118 appointments.
10120 If FILTER is t, interactively prompt the user for a regular
10121 expression, and filter out entries that don't match it.
10123 If FILTER is a string, use this string as a regular expression
10124 for filtering entries out.
10126 If FILTER is a function, filter out entries against which
10127 calling the function returns nil. This function takes one
10128 argument: an entry from `org-agenda-get-day-entries'.
10130 FILTER can also be an alist with the car of each cell being
10131 either `headline' or `category'. For example:
10133 \\='((headline \"IMPORTANT\")
10134 (category \"Work\"))
10136 will only add headlines containing IMPORTANT or headlines
10137 belonging to the \"Work\" category.
10139 ARGS are symbols indicating what kind of entries to consider.
10140 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
10141 \(i.e., deadlines and scheduled items with a hh:mm specification)
10142 and :timestamp entries. See the docstring of `org-diary' for
10143 details and examples.
10145 If an entry has a APPT_WARNTIME property, its value will be used
10146 to override `appt-message-warning-time'."
10147 (interactive "P")
10148 (if refresh (setq appt-time-msg-list nil))
10149 (if (eq filter t)
10150 (setq filter (read-from-minibuffer "Regexp filter: ")))
10151 (let* ((cnt 0) ; count added events
10152 (scope (or args '(:deadline* :scheduled* :timestamp)))
10153 (org-agenda-new-buffers nil)
10154 (org-deadline-warning-days 0)
10155 ;; Do not use `org-today' here because appt only takes
10156 ;; time and without date as argument, so it may pass wrong
10157 ;; information otherwise
10158 (today (org-date-to-gregorian
10159 (time-to-days (current-time))))
10160 (org-agenda-restrict nil)
10161 (files (org-agenda-files 'unrestricted)) entries file
10162 (org-agenda-buffer nil))
10163 ;; Get all entries which may contain an appt
10164 (org-agenda-prepare-buffers files)
10165 (while (setq file (pop files))
10166 (setq entries
10167 (delq nil
10168 (append entries
10169 (apply 'org-agenda-get-day-entries
10170 file today scope)))))
10171 ;; Map thru entries and find if we should filter them out
10172 (mapc
10173 (lambda(x)
10174 (let* ((evt (org-trim
10175 (replace-regexp-in-string
10176 org-bracket-link-regexp "\\3"
10177 (or (get-text-property 1 'txt x) ""))))
10178 (cat (get-text-property (1- (length x)) 'org-category x))
10179 (tod (get-text-property 1 'time-of-day x))
10180 (ok (or (null filter)
10181 (and (stringp filter) (string-match filter evt))
10182 (and (functionp filter) (funcall filter x))
10183 (and (listp filter)
10184 (let ((cat-filter (cadr (assoc 'category filter)))
10185 (evt-filter (cadr (assoc 'headline filter))))
10186 (or (and (stringp cat-filter)
10187 (string-match cat-filter cat))
10188 (and (stringp evt-filter)
10189 (string-match evt-filter evt)))))))
10190 (wrn (get-text-property 1 'warntime x)))
10191 ;; FIXME: Shall we remove text-properties for the appt text?
10192 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
10193 (when (and ok tod)
10194 (setq tod (concat "00" (number-to-string tod))
10195 tod (when (string-match
10196 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
10197 (concat (match-string 1 tod) ":"
10198 (match-string 2 tod))))
10199 (if (version< emacs-version "23.3")
10200 (appt-add tod evt)
10201 (appt-add tod evt wrn))
10202 (setq cnt (1+ cnt))))) entries)
10203 (org-release-buffers org-agenda-new-buffers)
10204 (if (eq cnt 0)
10205 (message "No event to add")
10206 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
10208 (defun org-agenda-today-p (date)
10209 "Non nil when DATE means today.
10210 DATE is either a list of the form (month day year) or a number of
10211 days as returned by `calendar-absolute-from-gregorian' or
10212 `org-today'. This function considers `org-extend-today-until'
10213 when defining today."
10214 (eq (org-today)
10215 (if (consp date) (calendar-absolute-from-gregorian date) date)))
10216 (define-obsolete-function-alias 'org-agenda-todayp 'org-agenda-today-p "25.1")
10218 (defun org-agenda-todo-yesterday (&optional arg)
10219 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
10220 (interactive "P")
10221 (let* ((org-use-effective-time t)
10222 (hour (third (decode-time
10223 (org-current-time))))
10224 (org-extend-today-until (1+ hour)))
10225 (org-agenda-todo arg)))
10227 (provide 'org-agenda)
10229 ;;; org-agenda.el ends here