Merge branch 'master' of orgmode.org:org-mode
[org-mode/org-tableheadings.git] / lisp / org-agenda.el
blobdbc98612c504f39b68bd7385e316cc75360e96f7
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (require 'org-macs)
50 (eval-when-compile
51 (require 'cl))
53 (declare-function diary-add-to-list "diary-lib"
54 (date string specifier &optional marker globcolor literal))
55 (declare-function calendar-absolute-from-iso "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-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 TODO's" ((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 reorganize-frame Show only two windows on the current frame, the current
1099 window and the agenda.
1100 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1101 Also, when exiting the agenda, kill that frame.
1102 See also the variable `org-agenda-restore-windows-after-quit'."
1103 :group 'org-agenda-windows
1104 :type '(choice
1105 (const current-window)
1106 (const other-frame)
1107 (const other-window)
1108 (const reorganize-frame)))
1110 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
1111 "The min and max height of the agenda window as a fraction of frame height.
1112 The value of the variable is a cons cell with two numbers between 0 and 1.
1113 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
1114 :group 'org-agenda-windows
1115 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
1117 (defcustom org-agenda-restore-windows-after-quit nil
1118 "Non-nil means restore window configuration upon exiting agenda.
1119 Before the window configuration is changed for displaying the agenda,
1120 the current status is recorded. When the agenda is exited with
1121 `q' or `x' and this option is set, the old state is restored. If
1122 `org-agenda-window-setup' is `other-frame', the value of this
1123 option will be ignored."
1124 :group 'org-agenda-windows
1125 :type 'boolean)
1127 (defcustom org-agenda-ndays nil
1128 "Number of days to include in overview display.
1129 Should be 1 or 7.
1130 Obsolete, see `org-agenda-span'."
1131 :group 'org-agenda-daily/weekly
1132 :type '(choice (const nil)
1133 (integer)))
1135 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1137 (defcustom org-agenda-span 'week
1138 "Number of days to include in overview display.
1139 Can be day, week, month, year, or any number of days.
1140 Custom commands can set this variable in the options section."
1141 :group 'org-agenda-daily/weekly
1142 :type '(choice (const :tag "Day" day)
1143 (const :tag "Week" week)
1144 (const :tag "Fortnight" fortnight)
1145 (const :tag "Month" month)
1146 (const :tag "Year" year)
1147 (integer :tag "Custom")))
1149 (defcustom org-agenda-start-on-weekday 1
1150 "Non-nil means start the overview always on the specified weekday.
1151 0 denotes Sunday, 1 denotes Monday, etc.
1152 When nil, always start on the current day.
1153 Custom commands can set this variable in the options section."
1154 :group 'org-agenda-daily/weekly
1155 :type '(choice (const :tag "Today" nil)
1156 (integer :tag "Weekday No.")))
1158 (defcustom org-agenda-show-all-dates t
1159 "Non-nil means `org-agenda' shows every day in the selected range.
1160 When nil, only the days which actually have entries are shown."
1161 :group 'org-agenda-daily/weekly
1162 :type 'boolean)
1164 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1165 "Format string for displaying dates in the agenda.
1166 Used by the daily/weekly agenda and by the timeline. This should be
1167 a format string understood by `format-time-string', or a function returning
1168 the formatted date as a string. The function must take a single argument,
1169 a calendar-style date list like (month day year)."
1170 :group 'org-agenda-daily/weekly
1171 :type '(choice
1172 (string :tag "Format string")
1173 (function :tag "Function")))
1175 (defun org-agenda-format-date-aligned (date)
1176 "Format a DATE string for display in the daily/weekly agenda, or timeline.
1177 This function makes sure that dates are aligned for easy reading."
1178 (require 'cal-iso)
1179 (let* ((dayname (calendar-day-name date))
1180 (day (cadr date))
1181 (day-of-week (calendar-day-of-week date))
1182 (month (car date))
1183 (monthname (calendar-month-name month))
1184 (year (nth 2 date))
1185 (iso-week (org-days-to-iso-week
1186 (calendar-absolute-from-gregorian date)))
1187 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1188 (1- year))
1189 ((and (= month 12) (<= iso-week 1))
1190 (1+ year))
1191 (t year)))
1192 (weekstring (if (= day-of-week 1)
1193 (format " W%02d" iso-week)
1194 "")))
1195 (format "%-10s %2d %s %4d%s"
1196 dayname day monthname year weekstring)))
1198 (defcustom org-agenda-time-leading-zero nil
1199 "Non-nil means use leading zero for military times in agenda.
1200 For example, 9:30am would become 09:30 rather than 9:30."
1201 :group 'org-agenda-daily/weekly
1202 :version "24.1"
1203 :type 'boolean)
1205 (defcustom org-agenda-timegrid-use-ampm nil
1206 "When set, show AM/PM style timestamps on the timegrid."
1207 :group 'org-agenda
1208 :version "24.1"
1209 :type 'boolean)
1211 (defun org-agenda-time-of-day-to-ampm (time)
1212 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1213 (let* ((hour-number (string-to-number (substring time 0 -3)))
1214 (minute (substring time -2))
1215 (ampm "am"))
1216 (cond
1217 ((equal hour-number 12)
1218 (setq ampm "pm"))
1219 ((> hour-number 12)
1220 (setq ampm "pm")
1221 (setq hour-number (- hour-number 12))))
1222 (concat
1223 (if org-agenda-time-leading-zero
1224 (format "%02d" hour-number)
1225 (format "%02s" (number-to-string hour-number)))
1226 ":" minute ampm)))
1228 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1229 "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
1230 (if org-agenda-timegrid-use-ampm
1231 (org-agenda-time-of-day-to-ampm time)
1232 time))
1234 (defcustom org-agenda-weekend-days '(6 0)
1235 "Which days are weekend?
1236 These days get the special face `org-agenda-date-weekend' in the agenda
1237 and timeline buffers."
1238 :group 'org-agenda-daily/weekly
1239 :type '(set :greedy t
1240 (const :tag "Monday" 1)
1241 (const :tag "Tuesday" 2)
1242 (const :tag "Wednesday" 3)
1243 (const :tag "Thursday" 4)
1244 (const :tag "Friday" 5)
1245 (const :tag "Saturday" 6)
1246 (const :tag "Sunday" 0)))
1248 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1249 "Non-nil means jump to today when moving a past date forward in time.
1250 When using S-right in the agenda to move a a date forward, and the date
1251 stamp currently points to the past, the first key press will move it
1252 to today. WHen nil, just move one day forward even if the date stays
1253 in the past."
1254 :group 'org-agenda-daily/weekly
1255 :version "24.1"
1256 :type 'boolean)
1258 (defcustom org-agenda-include-diary nil
1259 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1260 Custom commands can set this variable in the options section."
1261 :group 'org-agenda-daily/weekly
1262 :type 'boolean)
1264 (defcustom org-agenda-include-deadlines t
1265 "If non-nil, include entries within their deadline warning period.
1266 Custom commands can set this variable in the options section."
1267 :group 'org-agenda-daily/weekly
1268 :version "24.1"
1269 :type 'boolean)
1271 (defcustom org-agenda-repeating-timestamp-show-all t
1272 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1273 When set to a list of strings, only show occurrences of repeating
1274 stamps for these TODO keywords. When nil, only one occurrence is
1275 shown, either today or the nearest into the future."
1276 :group 'org-agenda-daily/weekly
1277 :type '(choice
1278 (const :tag "Show repeating stamps" t)
1279 (repeat :tag "Show repeating stamps for these TODO keywords"
1280 (string :tag "TODO Keyword"))
1281 (const :tag "Don't show repeating stamps" nil)))
1283 (defcustom org-scheduled-past-days 10000
1284 "Number of days to continue listing scheduled items not marked DONE.
1285 When an item is scheduled on a date, it shows up in the agenda on this
1286 day and will be listed until it is marked done for the number of days
1287 given here."
1288 :group 'org-agenda-daily/weekly
1289 :type 'integer)
1291 (defcustom org-agenda-log-mode-items '(closed clock)
1292 "List of items that should be shown in agenda log mode.
1293 This list may contain the following symbols:
1295 closed Show entries that have been closed on that day.
1296 clock Show entries that have received clocked time on that day.
1297 state Show all logged state changes.
1298 Note that instead of changing this variable, you can also press `C-u l' in
1299 the agenda to display all available LOG items temporarily."
1300 :group 'org-agenda-daily/weekly
1301 :type '(set :greedy t (const closed) (const clock) (const state)))
1303 (defcustom org-agenda-clock-consistency-checks
1304 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1305 :gap-ok-around ("4:00")
1306 :default-face ((:background "DarkRed") (:foreground "white"))
1307 :overlap-face nil :gap-face nil :no-end-time-face nil
1308 :long-face nil :short-face nil)
1309 "This is a property list, with the following keys:
1311 :max-duration Mark clocking chunks that are longer than this time.
1312 This is a time string like \"HH:MM\", or the number
1313 of minutes as an integer.
1315 :min-duration Mark clocking chunks that are shorter that this.
1316 This is a time string like \"HH:MM\", or the number
1317 of minutes as an integer.
1319 :max-gap Mark gaps between clocking chunks that are longer than
1320 this duration. A number of minutes, or a string
1321 like \"HH:MM\".
1323 :gap-ok-around List of times during the day which are usually not working
1324 times. When a gap is detected, but the gap contains any
1325 of these times, the gap is *not* reported. For example,
1326 if this is (\"4:00\" \"13:00\") then gaps that contain
1327 4:00 in the morning (i.e. the night) and 13:00
1328 (i.e. a typical lunch time) do not cause a warning.
1329 You should have at least one time during the night in this
1330 list, or otherwise the first task each morning will trigger
1331 a warning because it follows a long gap.
1333 Furthermore, the following properties can be used to define faces for
1334 issue display.
1336 :default-face the default face, if the specific face is undefined
1337 :overlap-face face for overlapping clocks
1338 :gap-face face for gaps between clocks
1339 :no-end-time-face face for incomplete clocks
1340 :long-face face for clock intervals that are too long
1341 :short-face face for clock intervals that are too short"
1342 :group 'org-agenda-daily/weekly
1343 :group 'org-clock
1344 :version "24.1"
1345 :type 'plist)
1347 (defcustom org-agenda-log-mode-add-notes t
1348 "Non-nil means add first line of notes to log entries in agenda views.
1349 If a log item like a state change or a clock entry is associated with
1350 notes, the first line of these notes will be added to the entry in the
1351 agenda display."
1352 :group 'org-agenda-daily/weekly
1353 :type 'boolean)
1355 (defcustom org-agenda-start-with-log-mode nil
1356 "The initial value of log-mode in a newly created agenda window.
1357 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1358 explanations on the possible values."
1359 :group 'org-agenda-startup
1360 :group 'org-agenda-daily/weekly
1361 :type '(choice (const :tag "Don't show log items" nil)
1362 (const :tag "Show only log items" only)
1363 (const :tag "Show all possible log items" clockcheck)
1364 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1365 (choice (const :tag "Show closed log items" closed)
1366 (const :tag "Show clocked log items" clock)
1367 (const :tag "Show all logged state changes" state)))))
1369 (defcustom org-agenda-start-with-clockreport-mode nil
1370 "The initial value of clockreport-mode in a newly created agenda window."
1371 :group 'org-agenda-startup
1372 :group 'org-agenda-daily/weekly
1373 :type 'boolean)
1375 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1376 "Property list with parameters for the clocktable in clockreport mode.
1377 This is the display mode that shows a clock table in the daily/weekly
1378 agenda, the properties for this dynamic block can be set here.
1379 The usual clocktable parameters are allowed here, but you cannot set
1380 the properties :name, :tstart, :tend, :block, and :scope - these will
1381 be overwritten to make sure the content accurately reflects the
1382 current display in the agenda."
1383 :group 'org-agenda-daily/weekly
1384 :type 'plist)
1386 (defcustom org-agenda-search-view-always-boolean nil
1387 "Non-nil means the search string is interpreted as individual parts.
1389 The search string for search view can either be interpreted as a phrase,
1390 or as a list of snippets that define a boolean search for a number of
1391 strings.
1393 When this is non-nil, the string will be split on whitespace, and each
1394 snippet will be searched individually, and all must match in order to
1395 select an entry. A snippet is then a single string of non-white
1396 characters, or a string in double quotes, or a regexp in {} braces.
1397 If a snippet is preceded by \"-\", the snippet must *not* match.
1398 \"+\" is syntactic sugar for positive selection. Each snippet may
1399 be found as a full word or a partial word, but see the variable
1400 `org-agenda-search-view-force-full-words'.
1402 When this is nil, search will look for the entire search phrase as one,
1403 with each space character matching any amount of whitespace, including
1404 line breaks.
1406 Even when this is nil, you can still switch to Boolean search dynamically
1407 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1408 is a regexp marked with braces like \"{abc}\", this will also switch to
1409 boolean search."
1410 :group 'org-agenda-search-view
1411 :version "24.1"
1412 :type 'boolean)
1414 (org-defvaralias 'org-agenda-search-view-search-words-only
1415 'org-agenda-search-view-always-boolean)
1417 (defcustom org-agenda-search-view-force-full-words nil
1418 "Non-nil means, search words must be matches as complete words.
1419 When nil, they may also match part of a word."
1420 :group 'org-agenda-search-view
1421 :version "24.1"
1422 :type 'boolean)
1424 (defcustom org-agenda-search-view-max-outline-level 0
1425 "Maximum outline level to display in search view.
1426 E.g. when this is set to 1, the search view will only
1427 show headlines of level 1. When set to 0, the default
1428 value, don't limit agenda view by outline level."
1429 :group 'org-agenda-search-view
1430 :version "24.4"
1431 :package-version '(Org . "8.3")
1432 :type 'integer)
1434 (defgroup org-agenda-time-grid nil
1435 "Options concerning the time grid in the Org-mode Agenda."
1436 :tag "Org Agenda Time Grid"
1437 :group 'org-agenda)
1439 (defcustom org-agenda-search-headline-for-time t
1440 "Non-nil means search headline for a time-of-day.
1441 If the headline contains a time-of-day in one format or another, it will
1442 be used to sort the entry into the time sequence of items for a day.
1443 Some people have time stamps in the headline that refer to the creation
1444 time or so, and then this produces an unwanted side effect. If this is
1445 the case for your, use this variable to turn off searching the headline
1446 for a time."
1447 :group 'org-agenda-time-grid
1448 :type 'boolean)
1450 (defcustom org-agenda-use-time-grid t
1451 "Non-nil means show a time grid in the agenda schedule.
1452 A time grid is a set of lines for specific times (like every two hours between
1453 8:00 and 20:00). The items scheduled for a day at specific times are
1454 sorted in between these lines.
1455 For details about when the grid will be shown, and what it will look like, see
1456 the variable `org-agenda-time-grid'."
1457 :group 'org-agenda-time-grid
1458 :type 'boolean)
1460 (defcustom org-agenda-time-grid
1461 '((daily today require-timed)
1462 "----------------"
1463 (800 1000 1200 1400 1600 1800 2000))
1465 "The settings for time grid for agenda display.
1466 This is a list of three items. The first item is again a list. It contains
1467 symbols specifying conditions when the grid should be displayed:
1469 daily if the agenda shows a single day
1470 weekly if the agenda shows an entire week
1471 today show grid on current date, independent of daily/weekly display
1472 require-timed show grid only if at least one item has a time specification
1474 The second item is a string which will be placed behind the grid time.
1476 The third item is a list of integers, indicating the times that should have
1477 a grid line."
1478 :group 'org-agenda-time-grid
1479 :type
1480 '(list
1481 (set :greedy t :tag "Grid Display Options"
1482 (const :tag "Show grid in single day agenda display" daily)
1483 (const :tag "Show grid in weekly agenda display" weekly)
1484 (const :tag "Always show grid for today" today)
1485 (const :tag "Show grid only if any timed entries are present"
1486 require-timed)
1487 (const :tag "Skip grid times already present in an entry"
1488 remove-match))
1489 (string :tag "Grid String")
1490 (repeat :tag "Grid Times" (integer :tag "Time"))))
1492 (defcustom org-agenda-show-current-time-in-grid t
1493 "Non-nil means show the current time in the time grid."
1494 :group 'org-agenda-time-grid
1495 :version "24.1"
1496 :type 'boolean)
1498 (defcustom org-agenda-current-time-string
1499 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1500 "The string for the current time marker in the agenda."
1501 :group 'org-agenda-time-grid
1502 :version "24.1"
1503 :type 'string)
1505 (defgroup org-agenda-sorting nil
1506 "Options concerning sorting in the Org-mode Agenda."
1507 :tag "Org Agenda Sorting"
1508 :group 'org-agenda)
1510 (defcustom org-agenda-sorting-strategy
1511 '((agenda habit-down time-up priority-down category-keep)
1512 (todo priority-down category-keep)
1513 (tags priority-down category-keep)
1514 (search category-keep))
1515 "Sorting structure for the agenda items of a single day.
1516 This is a list of symbols which will be used in sequence to determine
1517 if an entry should be listed before another entry. The following
1518 symbols are recognized:
1520 time-up Put entries with time-of-day indications first, early first
1521 time-down Put entries with time-of-day indications first, late first
1522 timestamp-up Sort by any timestamp, early first
1523 timestamp-down Sort by any timestamp, late first
1524 scheduled-up Sort by scheduled timestamp, early first
1525 scheduled-down Sort by scheduled timestamp, late first
1526 deadline-up Sort by deadline timestamp, early first
1527 deadline-down Sort by deadline timestamp, late first
1528 ts-up Sort by active timestamp, early first
1529 ts-down Sort by active timestamp, late first
1530 tsia-up Sort by inactive timestamp, early first
1531 tsia-down Sort by inactive timestamp, late first
1532 category-keep Keep the default order of categories, corresponding to the
1533 sequence in `org-agenda-files'.
1534 category-up Sort alphabetically by category, A-Z.
1535 category-down Sort alphabetically by category, Z-A.
1536 tag-up Sort alphabetically by last tag, A-Z.
1537 tag-down Sort alphabetically by last tag, Z-A.
1538 priority-up Sort numerically by priority, high priority last.
1539 priority-down Sort numerically by priority, high priority first.
1540 todo-state-up Sort by todo state, tasks that are done last.
1541 todo-state-down Sort by todo state, tasks that are done first.
1542 effort-up Sort numerically by estimated effort, high effort last.
1543 effort-down Sort numerically by estimated effort, high effort first.
1544 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1545 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1546 habit-up Put entries that are habits first
1547 habit-down Put entries that are habits last
1548 alpha-up Sort headlines alphabetically
1549 alpha-down Sort headlines alphabetically, reversed
1551 The different possibilities will be tried in sequence, and testing stops
1552 if one comparison returns a \"not-equal\". For example, the default
1553 '(time-up category-keep priority-down)
1554 means: Pull out all entries having a specified time of day and sort them,
1555 in order to make a time schedule for the current day the first thing in the
1556 agenda listing for the day. Of the entries without a time indication, keep
1557 the grouped in categories, don't sort the categories, but keep them in
1558 the sequence given in `org-agenda-files'. Within each category sort by
1559 priority.
1561 Leaving out `category-keep' would mean that items will be sorted across
1562 categories by priority.
1564 Instead of a single list, this can also be a set of list for specific
1565 contents, with a context symbol in the car of the list, any of
1566 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1568 Custom commands can bind this variable in the options section."
1569 :group 'org-agenda-sorting
1570 :type `(choice
1571 (repeat :tag "General" ,org-sorting-choice)
1572 (list :tag "Individually"
1573 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1574 (repeat ,org-sorting-choice))
1575 (cons (const :tag "Strategy for TODO lists" todo)
1576 (repeat ,org-sorting-choice))
1577 (cons (const :tag "Strategy for Tags matches" tags)
1578 (repeat ,org-sorting-choice))
1579 (cons (const :tag "Strategy for search matches" search)
1580 (repeat ,org-sorting-choice)))))
1582 (defcustom org-agenda-cmp-user-defined nil
1583 "A function to define the comparison `user-defined'.
1584 This function must receive two arguments, agenda entry a and b.
1585 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1586 the user comparison, return nil.
1587 When this is defined, you can make `user-defined-up' and `user-defined-down'
1588 part of an agenda sorting strategy."
1589 :group 'org-agenda-sorting
1590 :type 'symbol)
1592 (defcustom org-sort-agenda-notime-is-late t
1593 "Non-nil means items without time are considered late.
1594 This is only relevant for sorting. When t, items which have no explicit
1595 time like 15:30 will be considered as 99:01, i.e. later than any items which
1596 do have a time. When nil, the default time is before 0:00. You can use this
1597 option to decide if the schedule for today should come before or after timeless
1598 agenda entries."
1599 :group 'org-agenda-sorting
1600 :type 'boolean)
1602 (defcustom org-sort-agenda-noeffort-is-high t
1603 "Non-nil means items without effort estimate are sorted as high effort.
1604 This also applies when filtering an agenda view with respect to the
1605 < or > effort operator. Then, tasks with no effort defined will be treated
1606 as tasks with high effort.
1607 When nil, such items are sorted as 0 minutes effort."
1608 :group 'org-agenda-sorting
1609 :type 'boolean)
1611 (defgroup org-agenda-line-format nil
1612 "Options concerning the entry prefix in the Org-mode agenda display."
1613 :tag "Org Agenda Line Format"
1614 :group 'org-agenda)
1616 (defcustom org-agenda-prefix-format
1617 '((agenda . " %i %-12:c%?-12t% s")
1618 (timeline . " % s")
1619 (todo . " %i %-12:c")
1620 (tags . " %i %-12:c")
1621 (search . " %i %-12:c"))
1622 "Format specifications for the prefix of items in the agenda views.
1623 An alist with five entries, each for the different agenda types. The
1624 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1625 The values are format strings.
1627 This format works similar to a printf format, with the following meaning:
1629 %c the category of the item, \"Diary\" for entries from the diary,
1630 or as given by the CATEGORY keyword or derived from the file name
1631 %e the effort required by the item
1632 %l the level of the item (insert X space(s) if item is of level X)
1633 %i the icon category of the item, see `org-agenda-category-icon-alist'
1634 %T the last tag of the item (ignore inherited tags, which come first)
1635 %t the HH:MM time-of-day specification if one applies to the entry
1636 %s Scheduling/Deadline information, a short string
1637 %b show breadcrumbs, i.e., the names of the higher levels
1638 %(expression) Eval EXPRESSION and replace the control string
1639 by the result
1641 All specifiers work basically like the standard `%s' of printf, but may
1642 contain two additional characters: a question mark just after the `%'
1643 and a whitespace/punctuation character just before the final letter.
1645 If the first character after `%' is a question mark, the entire field
1646 will only be included if the corresponding value applies to the current
1647 entry. This is useful for fields which should have fixed width when
1648 present, but zero width when absent. For example, \"%?-12t\" will
1649 result in a 12 character time field if a time of the day is specified,
1650 but will completely disappear in entries which do not contain a time.
1652 If there is punctuation or whitespace character just before the
1653 final format letter, this character will be appended to the field
1654 value if the value is not empty. For example, the format
1655 \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
1656 the category is empty, no additional colon is inserted.
1658 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1659 which means:
1661 - Indent the line with two space characters
1662 - Give the category a 12 chars wide field, padded with whitespace on
1663 the right (because of `-'). Append a colon if there is a category
1664 (because of `:').
1665 - If there is a time-of-day, put it into a 12 chars wide field. If no
1666 time, don't put in an empty field, just skip it (because of '?').
1667 - Finally, put the scheduling information.
1669 See also the variables `org-agenda-remove-times-when-in-prefix' and
1670 `org-agenda-remove-tags'.
1672 Custom commands can set this variable in the options section."
1673 :type '(choice
1674 (string :tag "General format")
1675 (list :greedy t :tag "View dependent"
1676 (cons (const agenda) (string :tag "Format"))
1677 (cons (const timeline) (string :tag "Format"))
1678 (cons (const todo) (string :tag "Format"))
1679 (cons (const tags) (string :tag "Format"))
1680 (cons (const search) (string :tag "Format"))))
1681 :group 'org-agenda-line-format)
1683 (defvar org-prefix-format-compiled nil
1684 "The compiled prefix format and associated variables.
1685 This is a list where first element is a list of variable bindings, and second
1686 element is the compiled format expression. See the variable
1687 `org-agenda-prefix-format'.")
1689 (defcustom org-agenda-todo-keyword-format "%-1s"
1690 "Format for the TODO keyword in agenda lines.
1691 Set this to something like \"%-12s\" if you want all TODO keywords
1692 to occupy a fixed space in the agenda display."
1693 :group 'org-agenda-line-format
1694 :type 'string)
1696 (defcustom org-agenda-diary-sexp-prefix nil
1697 "A regexp that matches part of a diary sexp entry
1698 which should be treated as scheduling/deadline information in
1699 `org-agenda'.
1701 For example, you can use this to extract the `diary-remind-message' from
1702 `diary-remind' entries."
1703 :group 'org-agenda-line-format
1704 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1706 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1707 "Text preceding timerange entries in the agenda view.
1708 This is a list with two strings. The first applies when the range
1709 is entirely on one day. The second applies if the range spans several days.
1710 The strings may have two \"%d\" format specifiers which will be filled
1711 with the sequence number of the days, and the total number of days in the
1712 range, respectively."
1713 :group 'org-agenda-line-format
1714 :type '(list
1715 (string :tag "Deadline today ")
1716 (choice :tag "Deadline relative"
1717 (string :tag "Format string")
1718 (function))))
1720 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1721 "Text preceding scheduled items in the agenda view.
1722 This is a list with two strings. The first applies when the item is
1723 scheduled on the current day. The second applies when it has been scheduled
1724 previously, it may contain a %d indicating that this is the nth time that
1725 this item is scheduled, due to automatic rescheduling of unfinished items
1726 for the following day. So this number is one larger than the number of days
1727 that passed since this item was scheduled first."
1728 :group 'org-agenda-line-format
1729 :version "24.4"
1730 :package-version '(Org . "8.0")
1731 :type '(list
1732 (string :tag "Scheduled today ")
1733 (string :tag "Scheduled previously")))
1735 (defcustom org-agenda-inactive-leader "["
1736 "Text preceding item pulled into the agenda by inactive time stamps.
1737 These entries are added to the agenda when pressing \"[\"."
1738 :group 'org-agenda-line-format
1739 :version "24.1"
1740 :type 'string)
1742 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
1743 "Text preceding deadline items in the agenda view.
1744 This is a list with three strings. The first applies when the item has its
1745 deadline on the current day. The second applies when the deadline is in the
1746 future, the third one when it is in the past. The strings may contain %d
1747 to capture the number of days."
1748 :group 'org-agenda-line-format
1749 :version "24.4"
1750 :package-version '(Org . "8.0")
1751 :type '(list
1752 (string :tag "Deadline today ")
1753 (string :tag "Deadline in the future ")
1754 (string :tag "Deadline in the past ")))
1756 (defcustom org-agenda-remove-times-when-in-prefix t
1757 "Non-nil means remove duplicate time specifications in agenda items.
1758 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1759 time-of-day specification in a headline or diary entry is extracted and
1760 placed into the prefix. If this option is non-nil, the original specification
1761 \(a timestamp or -range, or just a plain time(range) specification like
1762 11:30-4pm) will be removed for agenda display. This makes the agenda less
1763 cluttered.
1764 The option can be t or nil. It may also be the symbol `beg', indicating
1765 that the time should only be removed when it is located at the beginning of
1766 the headline/diary entry."
1767 :group 'org-agenda-line-format
1768 :type '(choice
1769 (const :tag "Always" t)
1770 (const :tag "Never" nil)
1771 (const :tag "When at beginning of entry" beg)))
1773 (defcustom org-agenda-remove-timeranges-from-blocks nil
1774 "Non-nil means remove time ranges specifications in agenda
1775 items that span on several days."
1776 :group 'org-agenda-line-format
1777 :version "24.1"
1778 :type 'boolean)
1780 (defcustom org-agenda-default-appointment-duration nil
1781 "Default duration for appointments that only have a starting time.
1782 When nil, no duration is specified in such cases.
1783 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1784 :group 'org-agenda-line-format
1785 :type '(choice
1786 (integer :tag "Minutes")
1787 (const :tag "No default duration")))
1789 (defcustom org-agenda-show-inherited-tags t
1790 "Non-nil means show inherited tags in each agenda line.
1792 When this option is set to 'always, it take precedences over
1793 `org-agenda-use-tag-inheritance' and inherited tags are shown
1794 in every agenda.
1796 When this option is set to t (the default), inherited tags are
1797 shown when they are available, i.e. when the value of
1798 `org-agenda-use-tag-inheritance' has been taken into account.
1800 This can be set to a list of agenda types in which the agenda
1801 must display the inherited tags. Available types are 'todo,
1802 'agenda, 'search and 'timeline.
1804 When set to nil, never show inherited tags in agenda lines."
1805 :group 'org-agenda-line-format
1806 :group 'org-agenda
1807 :version "24.3"
1808 :type '(choice
1809 (const :tag "Show inherited tags when available" t)
1810 (const :tag "Always show inherited tags" always)
1811 (repeat :tag "Show inherited tags only in selected agenda types"
1812 (symbol :tag "Agenda type"))))
1814 (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
1815 "List of agenda view types where to use tag inheritance.
1817 In tags/tags-todo/tags-tree agenda views, tag inheritance is
1818 controlled by `org-use-tag-inheritance'. In other agenda types,
1819 `org-use-tag-inheritance' is not used for the selection of the
1820 agenda entries. Still, you may want the agenda to be aware of
1821 the inherited tags anyway, e.g. for later tag filtering.
1823 Allowed value are 'todo, 'search, 'timeline and 'agenda.
1825 This variable has no effect if `org-agenda-show-inherited-tags'
1826 is set to 'always. In that case, the agenda is aware of those
1827 tags.
1829 The default value sets tags in every agenda type. Setting this
1830 option to nil will speed up non-tags agenda view a lot."
1831 :group 'org-agenda
1832 :version "24.3"
1833 :type '(choice
1834 (const :tag "Use tag inheritance in all agenda types" t)
1835 (repeat :tag "Use tag inheritance in selected agenda types"
1836 (symbol :tag "Agenda type"))))
1838 (defcustom org-agenda-hide-tags-regexp nil
1839 "Regular expression used to filter away specific tags in agenda views.
1840 This means that these tags will be present, but not be shown in the agenda
1841 line. Secondary filtering will still work on the hidden tags.
1842 Nil means don't hide any tags."
1843 :group 'org-agenda-line-format
1844 :type '(choice
1845 (const :tag "Hide none" nil)
1846 (string :tag "Regexp ")))
1848 (defcustom org-agenda-remove-tags nil
1849 "Non-nil means remove the tags from the headline copy in the agenda.
1850 When this is the symbol `prefix', only remove tags when
1851 `org-agenda-prefix-format' contains a `%T' specifier."
1852 :group 'org-agenda-line-format
1853 :type '(choice
1854 (const :tag "Always" t)
1855 (const :tag "Never" nil)
1856 (const :tag "When prefix format contains %T" prefix)))
1858 (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
1859 'org-agenda-remove-tags)
1861 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1862 "Shift tags in agenda items to this column.
1863 If this number is positive, it specifies the column. If it is negative,
1864 it means that the tags should be flushright to that column. For example,
1865 -80 works well for a normal 80 character screen."
1866 :group 'org-agenda-line-format
1867 :type 'integer)
1869 (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
1871 (defcustom org-agenda-fontify-priorities 'cookies
1872 "Non-nil means highlight low and high priorities in agenda.
1873 When t, the highest priority entries are bold, lowest priority italic.
1874 However, settings in `org-priority-faces' will overrule these faces.
1875 When this variable is the symbol `cookies', only fontify the
1876 cookies, not the entire task.
1877 This may also be an association list of priority faces, whose
1878 keys are the character values of `org-highest-priority',
1879 `org-default-priority', and `org-lowest-priority' (the default values
1880 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1881 color as a string, or a list like `(:background \"Red\")'.
1882 If it is a color, the variable `org-faces-easy-properties'
1883 determines if it is a foreground or a background color."
1884 :group 'org-agenda-line-format
1885 :type '(choice
1886 (const :tag "Never" nil)
1887 (const :tag "Defaults" t)
1888 (const :tag "Cookies only" cookies)
1889 (repeat :tag "Specify"
1890 (list (character :tag "Priority" :value ?A)
1891 (choice :tag "Face "
1892 (string :tag "Color")
1893 (sexp :tag "Face"))))))
1895 (defcustom org-agenda-day-face-function nil
1896 "Function called to determine what face should be used to display a day.
1897 The only argument passed to that function is the day. It should
1898 returns a face, or nil if does not want to specify a face and let
1899 the normal rules apply."
1900 :group 'org-agenda-line-format
1901 :version "24.1"
1902 :type '(choice (const nil) (function)))
1904 (defcustom org-agenda-category-icon-alist nil
1905 "Alist of category icon to be displayed in agenda views.
1907 Each entry should have the following format:
1909 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1911 Where CATEGORY-REGEXP is a regexp matching the categories where
1912 the icon should be displayed.
1913 FILE-OR-DATA either a file path or a string containing image data.
1915 The other fields can be omitted safely if not needed:
1916 TYPE indicates the image type.
1917 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1918 image data.
1919 PROPS are additional image attributes to assign to the image,
1920 like, e.g. `:ascent center'.
1922 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1924 If you want to set the display properties yourself, just put a
1925 list as second element:
1927 (CATEGORY-REGEXP (MY PROPERTY LIST))
1929 For example, to display a 16px horizontal space for Emacs
1930 category, you can use:
1932 (\"Emacs\" '(space . (:width (16))))"
1933 :group 'org-agenda-line-format
1934 :version "24.1"
1935 :type '(alist :key-type (string :tag "Regexp matching category")
1936 :value-type (choice (list :tag "Icon"
1937 (string :tag "File or data")
1938 (symbol :tag "Type")
1939 (boolean :tag "Data?")
1940 (repeat :tag "Extra image properties" :inline t symbol))
1941 (list :tag "Display properties" sexp))))
1943 (defgroup org-agenda-column-view nil
1944 "Options concerning column view in the agenda."
1945 :tag "Org Agenda Column View"
1946 :group 'org-agenda)
1948 (defcustom org-agenda-columns-show-summaries t
1949 "Non-nil means show summaries for columns displayed in the agenda view."
1950 :group 'org-agenda-column-view
1951 :type 'boolean)
1953 (defcustom org-agenda-columns-compute-summary-properties t
1954 "Non-nil means recompute all summary properties before column view.
1955 When column view in the agenda is listing properties that have a summary
1956 operator, it can go to all relevant buffers and recompute the summaries
1957 there. This can mean overhead for the agenda column view, but is necessary
1958 to have thing up to date.
1959 As a special case, a CLOCKSUM property also makes sure that the clock
1960 computations are current."
1961 :group 'org-agenda-column-view
1962 :type 'boolean)
1964 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1965 "Non-nil means the duration of an appointment will add to day effort.
1966 The property to which appointment durations will be added is the one given
1967 in the option `org-effort-property'. If an appointment does not have
1968 an end time, `org-agenda-default-appointment-duration' will be used. If that
1969 is not set, an appointment without end time will not contribute to the time
1970 estimate."
1971 :group 'org-agenda-column-view
1972 :type 'boolean)
1974 (defcustom org-agenda-auto-exclude-function nil
1975 "A function called with a tag to decide if it is filtered on '/ RET'.
1976 The sole argument to the function, which is called once for each
1977 possible tag, is a string giving the name of the tag. The
1978 function should return either nil if the tag should be included
1979 as normal, or \"-<TAG>\" to exclude the tag.
1980 Note that for the purpose of tag filtering, only the lower-case version of
1981 all tags will be considered, so that this function will only ever see
1982 the lower-case version of all tags."
1983 :group 'org-agenda
1984 :type '(choice (const nil) (function)))
1986 (defcustom org-agenda-bulk-custom-functions nil
1987 "Alist of characters and custom functions for bulk actions.
1988 For example, this value makes those two functions available:
1990 '((?R set-category)
1991 (?C bulk-cut))
1993 With selected entries in an agenda buffer, `B R' will call
1994 the custom function `set-category' on the selected entries.
1995 Note that functions in this alist don't need to be quoted."
1996 :type 'alist
1997 :version "24.1"
1998 :group 'org-agenda)
2000 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
2001 "Execute BODY with point at location given by `org-hd-marker' property.
2002 If STRING is non-nil, the text property will be fetched from position 0
2003 in that string. If STRING is nil, it will be fetched from the beginning
2004 of the current line."
2005 (org-with-gensyms (marker)
2006 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
2007 'org-hd-marker ,string)))
2008 (with-current-buffer (marker-buffer ,marker)
2009 (save-excursion
2010 (goto-char ,marker)
2011 ,@body)))))
2012 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
2014 (defun org-add-agenda-custom-command (entry)
2015 "Replace or add a command in `org-agenda-custom-commands'.
2016 This is mostly for hacking and trying a new command - once the command
2017 works you probably want to add it to `org-agenda-custom-commands' for good."
2018 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
2019 (if ass
2020 (setcdr ass (cdr entry))
2021 (push entry org-agenda-custom-commands))))
2023 ;;; Define the org-agenda-mode
2025 (defvar org-agenda-mode-map (make-sparse-keymap)
2026 "Keymap for `org-agenda-mode'.")
2027 (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
2029 (defvar org-agenda-menu) ; defined later in this file.
2030 (defvar org-agenda-restrict nil) ; defined later in this file.
2031 (defvar org-agenda-follow-mode nil)
2032 (defvar org-agenda-entry-text-mode nil)
2033 (defvar org-agenda-clockreport-mode nil)
2034 (defvar org-agenda-show-log nil)
2035 (defvar org-agenda-redo-command nil)
2036 (defvar org-agenda-query-string nil)
2037 (defvar org-agenda-mode-hook nil
2038 "Hook run after `org-agenda-mode' is turned on.
2039 The buffer is still writable when this hook is called.")
2040 (defvar org-agenda-type nil)
2041 (defvar org-agenda-force-single-file nil)
2042 (defvar org-agenda-bulk-marked-entries nil
2043 "List of markers that refer to marked entries in the agenda.")
2045 ;;; Multiple agenda buffers support
2047 (defcustom org-agenda-sticky nil
2048 "Non-nil means agenda q key will bury agenda buffers.
2049 Agenda commands will then show existing buffer instead of generating new ones.
2050 When nil, `q' will kill the single agenda buffer."
2051 :group 'org-agenda
2052 :version "24.3"
2053 :type 'boolean)
2056 ;;;###autoload
2057 (defun org-toggle-sticky-agenda (&optional arg)
2058 "Toggle `org-agenda-sticky'."
2059 (interactive "P")
2060 (let ((new-value (if arg
2061 (> (prefix-numeric-value arg) 0)
2062 (not org-agenda-sticky))))
2063 (if (equal new-value org-agenda-sticky)
2064 (and (org-called-interactively-p 'interactive)
2065 (message "Sticky agenda was already %s"
2066 (if org-agenda-sticky "enabled" "disabled")))
2067 (setq org-agenda-sticky new-value)
2068 (org-agenda-kill-all-agenda-buffers)
2069 (and (org-called-interactively-p 'interactive)
2070 (message "Sticky agenda was %s"
2071 (if org-agenda-sticky "enabled" "disabled"))))))
2073 (defvar org-agenda-buffer nil
2074 "Agenda buffer currently being generated.")
2076 (defvar org-agenda-last-prefix-arg nil)
2077 (defvar org-agenda-this-buffer-name nil)
2078 (defvar org-agenda-doing-sticky-redo nil)
2079 (defvar org-agenda-this-buffer-is-sticky nil)
2081 (defconst org-agenda-local-vars
2082 '(org-agenda-this-buffer-name
2083 org-agenda-undo-list
2084 org-agenda-pending-undo-list
2085 org-agenda-follow-mode
2086 org-agenda-entry-text-mode
2087 org-agenda-clockreport-mode
2088 org-agenda-show-log
2089 org-agenda-redo-command
2090 org-agenda-query-string
2091 org-agenda-type
2092 org-agenda-bulk-marked-entries
2093 org-agenda-undo-has-started-in
2094 org-agenda-info
2095 org-agenda-pre-window-conf
2096 org-agenda-columns-active
2097 org-agenda-tag-filter
2098 org-agenda-category-filter
2099 org-agenda-top-headline-filter
2100 org-agenda-regexp-filter
2101 org-agenda-effort-filter
2102 org-agenda-markers
2103 org-agenda-last-search-view-search-was-boolean
2104 org-agenda-filtered-by-category
2105 org-agenda-filter-form
2106 org-agenda-cycle-counter
2107 org-agenda-last-prefix-arg)
2108 "Variables that must be local in agenda buffers to allow multiple buffers.")
2110 (defun org-agenda-mode ()
2111 "Mode for time-sorted view on action items in Org-mode files.
2113 The following commands are available:
2115 \\{org-agenda-mode-map}"
2116 (interactive)
2117 (cond (org-agenda-doing-sticky-redo
2118 ;; Refreshing sticky agenda-buffer
2120 ;; Preserve the value of `org-agenda-local-vars' variables,
2121 ;; while letting `kill-all-local-variables' kill the rest
2122 (let ((save (buffer-local-variables)))
2123 (kill-all-local-variables)
2124 (mapc 'make-local-variable org-agenda-local-vars)
2125 (dolist (elem save)
2126 (let ((var (car elem))
2127 (val (cdr elem)))
2128 (when (and val
2129 (member var org-agenda-local-vars))
2130 (set var val)))))
2131 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2132 (org-agenda-sticky
2133 ;; Creating a sticky Agenda buffer for the first time
2134 (kill-all-local-variables)
2135 (mapc 'make-local-variable org-agenda-local-vars)
2136 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2138 ;; Creating a non-sticky agenda buffer
2139 (kill-all-local-variables)
2140 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
2141 (setq org-agenda-undo-list nil
2142 org-agenda-pending-undo-list nil
2143 org-agenda-bulk-marked-entries nil)
2144 (setq major-mode 'org-agenda-mode)
2145 ;; Keep global-font-lock-mode from turning on font-lock-mode
2146 (org-set-local 'font-lock-global-modes (list 'not major-mode))
2147 (setq mode-name "Org-Agenda")
2148 (setq indent-tabs-mode nil)
2149 (use-local-map org-agenda-mode-map)
2150 (easy-menu-add org-agenda-menu)
2151 (if org-startup-truncated (setq truncate-lines t))
2152 (org-set-local 'line-move-visual nil)
2153 (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
2154 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
2155 ;; Make sure properties are removed when copying text
2156 (org-add-hook 'filter-buffer-substring-functions
2157 (lambda (fun start end delete)
2158 (substring-no-properties (funcall fun start end delete)))
2159 nil t)
2160 (unless org-agenda-keep-modes
2161 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2162 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
2163 (setq org-agenda-show-log org-agenda-start-with-log-mode)
2164 (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
2165 (add-to-invisibility-spec '(org-filtered))
2166 (add-to-invisibility-spec '(org-link))
2167 (easy-menu-change
2168 '("Agenda") "Agenda Files"
2169 (append
2170 (list
2171 (vector
2172 (if (get 'org-agenda-files 'org-restrict)
2173 "Restricted to single file"
2174 "Edit File List")
2175 '(org-edit-agenda-file-list)
2176 (not (get 'org-agenda-files 'org-restrict)))
2177 "--")
2178 (mapcar 'org-file-menu-entry (org-agenda-files))))
2179 (org-agenda-set-mode-name)
2180 (apply
2181 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
2182 (list 'org-agenda-mode-hook)))
2184 (substitute-key-definition 'undo 'org-agenda-undo
2185 org-agenda-mode-map global-map)
2186 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
2187 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
2188 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
2189 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
2190 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2191 (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
2192 (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
2193 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2194 (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
2195 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2196 (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
2197 (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
2198 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2199 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2200 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2201 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2202 (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
2203 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2204 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2205 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2206 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2207 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2208 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2209 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2210 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2211 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2212 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2213 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2214 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2215 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2216 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2217 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2218 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2219 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2220 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2221 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2222 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2223 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2224 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2225 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2226 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2227 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2228 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2229 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2230 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2231 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2232 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2233 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2234 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2235 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2237 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2238 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2239 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2240 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2241 (while l (org-defkey org-agenda-mode-map
2242 (int-to-string (pop l)) 'digit-argument)))
2244 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2245 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2246 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2247 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2248 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2249 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2250 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2251 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2252 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2253 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2254 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2255 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2256 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2257 'org-clock-modify-effort-estimate)
2258 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2259 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2260 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2261 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2262 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2263 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2264 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2265 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2266 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2267 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2268 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2269 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2270 (substitute-key-definition 'next-line 'org-agenda-next-line
2271 org-agenda-mode-map global-map)
2272 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2273 org-agenda-mode-map global-map)
2274 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2275 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2276 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2277 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2278 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2279 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2280 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2281 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2282 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2283 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2284 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2285 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2286 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2287 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2288 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2289 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2290 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2291 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2292 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2293 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2294 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2295 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2296 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2297 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2298 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2299 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2300 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2301 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2302 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2303 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2305 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2306 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2307 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2308 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2309 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2310 (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
2311 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2312 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2313 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2314 (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
2315 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2316 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
2317 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2318 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2319 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2320 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2322 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2323 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2325 (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
2326 (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
2328 (when org-agenda-mouse-1-follows-link
2329 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2330 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2331 '("Agenda"
2332 ("Agenda Files")
2333 "--"
2334 ("Agenda Dates"
2335 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2336 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2337 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2338 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2339 "--"
2340 ("View"
2341 ["Day View" org-agenda-day-view
2342 :active (org-agenda-check-type nil 'agenda)
2343 :style radio :selected (eq org-agenda-current-span 'day)
2344 :keys "v d (or just d)"]
2345 ["Week View" org-agenda-week-view
2346 :active (org-agenda-check-type nil 'agenda)
2347 :style radio :selected (eq org-agenda-current-span 'week)
2348 :keys "v w"]
2349 ["Fortnight View" org-agenda-fortnight-view
2350 :active (org-agenda-check-type nil 'agenda)
2351 :style radio :selected (eq org-agenda-current-span 'fortnight)
2352 :keys "v f"]
2353 ["Month View" org-agenda-month-view
2354 :active (org-agenda-check-type nil 'agenda)
2355 :style radio :selected (eq org-agenda-current-span 'month)
2356 :keys "v m"]
2357 ["Year View" org-agenda-year-view
2358 :active (org-agenda-check-type nil 'agenda)
2359 :style radio :selected (eq org-agenda-current-span 'year)
2360 :keys "v y"]
2361 "--"
2362 ["Include Diary" org-agenda-toggle-diary
2363 :style toggle :selected org-agenda-include-diary
2364 :active (org-agenda-check-type nil 'agenda)]
2365 ["Include Deadlines" org-agenda-toggle-deadlines
2366 :style toggle :selected org-agenda-include-deadlines
2367 :active (org-agenda-check-type nil 'agenda)]
2368 ["Use Time Grid" org-agenda-toggle-time-grid
2369 :style toggle :selected org-agenda-use-time-grid
2370 :active (org-agenda-check-type nil 'agenda)]
2371 "--"
2372 ["Show clock report" org-agenda-clockreport-mode
2373 :style toggle :selected org-agenda-clockreport-mode
2374 :active (org-agenda-check-type nil 'agenda)]
2375 ["Show some entry text" org-agenda-entry-text-mode
2376 :style toggle :selected org-agenda-entry-text-mode
2377 :active t]
2378 "--"
2379 ["Show Logbook entries" org-agenda-log-mode
2380 :style toggle :selected org-agenda-show-log
2381 :active (org-agenda-check-type nil 'agenda 'timeline)
2382 :keys "v l (or just l)"]
2383 ["Include archived trees" org-agenda-archives-mode
2384 :style toggle :selected org-agenda-archives-mode :active t
2385 :keys "v a"]
2386 ["Include archive files" (org-agenda-archives-mode t)
2387 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2388 :keys "v A"]
2389 "--"
2390 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2391 ["Write view to file" org-agenda-write t]
2392 ["Rebuild buffer" org-agenda-redo t]
2393 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2394 "--"
2395 ["Show original entry" org-agenda-show t]
2396 ["Go To (other window)" org-agenda-goto t]
2397 ["Go To (this window)" org-agenda-switch-to t]
2398 ["Capture with cursor date" org-agenda-capture t]
2399 ["Follow Mode" org-agenda-follow-mode
2400 :style toggle :selected org-agenda-follow-mode :active t]
2401 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2402 "--"
2403 ("TODO"
2404 ["Cycle TODO" org-agenda-todo t]
2405 ["Next TODO set" org-agenda-todo-nextset t]
2406 ["Previous TODO set" org-agenda-todo-previousset t]
2407 ["Add note" org-agenda-add-note t])
2408 ("Archive/Refile/Delete"
2409 ["Archive default" org-agenda-archive-default t]
2410 ["Archive default" org-agenda-archive-default-with-confirmation t]
2411 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2412 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2413 ["Archive subtree" org-agenda-archive t]
2414 "--"
2415 ["Refile" org-agenda-refile t]
2416 "--"
2417 ["Delete subtree" org-agenda-kill t])
2418 ("Bulk action"
2419 ["Mark entry" org-agenda-bulk-mark t]
2420 ["Mark all" org-agenda-bulk-mark-all t]
2421 ["Unmark entry" org-agenda-bulk-unmark t]
2422 ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
2423 ["Toggle mark" org-agenda-bulk-toggle t]
2424 ["Toggle all" org-agenda-bulk-toggle-all t]
2425 ["Mark regexp" org-agenda-bulk-mark-regexp t])
2426 ["Act on all marked" org-agenda-bulk-action t]
2427 "--"
2428 ("Tags and Properties"
2429 ["Show all Tags" org-agenda-show-tags t]
2430 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2431 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2432 "--"
2433 ["Column View" org-columns t])
2434 ("Deadline/Schedule"
2435 ["Schedule" org-agenda-schedule t]
2436 ["Set Deadline" org-agenda-deadline t]
2437 "--"
2438 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2439 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2440 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2441 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2442 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2443 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2444 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2445 ("Clock and Effort"
2446 ["Clock in" org-agenda-clock-in t]
2447 ["Clock out" org-agenda-clock-out t]
2448 ["Clock cancel" org-agenda-clock-cancel t]
2449 ["Goto running clock" org-clock-goto t]
2450 "--"
2451 ["Set Effort" org-agenda-set-effort t]
2452 ["Change clocked effort" org-clock-modify-effort-estimate
2453 (org-clock-is-active)])
2454 ("Priority"
2455 ["Set Priority" org-agenda-priority t]
2456 ["Increase Priority" org-agenda-priority-up t]
2457 ["Decrease Priority" org-agenda-priority-down t]
2458 ["Show Priority" org-show-priority t])
2459 ("Calendar/Diary"
2460 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2461 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2462 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2463 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2464 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2465 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2466 "--"
2467 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2468 "--"
2469 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2470 "--"
2471 ("MobileOrg"
2472 ["Push Files and Views" org-mobile-push t]
2473 ["Get Captured and Flagged" org-mobile-pull t]
2474 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2475 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2476 "--"
2477 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2478 "--"
2479 ["Quit" org-agenda-quit t]
2480 ["Exit and Release Buffers" org-agenda-exit t]
2483 ;;; Agenda undo
2485 (defvar org-agenda-allow-remote-undo t
2486 "Non-nil means allow remote undo from the agenda buffer.")
2487 (defvar org-agenda-undo-has-started-in nil
2488 "Buffers that have already seen `undo-start' in the current undo sequence.")
2490 (defun org-agenda-undo ()
2491 "Undo a remote editing step in the agenda.
2492 This undoes changes both in the agenda buffer and in the remote buffer
2493 that have been changed along."
2494 (interactive)
2495 (or org-agenda-allow-remote-undo
2496 (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2497 (if (not (eq this-command last-command))
2498 (setq org-agenda-undo-has-started-in nil
2499 org-agenda-pending-undo-list org-agenda-undo-list))
2500 (if (not org-agenda-pending-undo-list)
2501 (user-error "No further undo information"))
2502 (let* ((entry (pop org-agenda-pending-undo-list))
2503 buf line cmd rembuf)
2504 (setq cmd (pop entry) line (pop entry))
2505 (setq rembuf (nth 2 entry))
2506 (org-with-remote-undo rembuf
2507 (while (bufferp (setq buf (pop entry)))
2508 (if (pop entry)
2509 (with-current-buffer buf
2510 (let ((last-undo-buffer buf)
2511 (inhibit-read-only t))
2512 (unless (memq buf org-agenda-undo-has-started-in)
2513 (push buf org-agenda-undo-has-started-in)
2514 (make-local-variable 'pending-undo-list)
2515 (undo-start))
2516 (while (and pending-undo-list
2517 (listp pending-undo-list)
2518 (not (car pending-undo-list)))
2519 (pop pending-undo-list))
2520 (undo-more 1))))))
2521 (org-goto-line line)
2522 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2524 (defun org-verify-change-for-undo (l1 l2)
2525 "Verify that a real change occurred between the undo lists L1 and L2."
2526 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2527 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2528 (not (eq l1 l2)))
2530 ;;; Agenda dispatch
2532 (defvar org-agenda-restrict-begin (make-marker))
2533 (defvar org-agenda-restrict-end (make-marker))
2534 (defvar org-agenda-last-dispatch-buffer nil)
2535 (defvar org-agenda-overriding-restriction nil)
2537 (defcustom org-agenda-custom-commands-contexts nil
2538 "Alist of custom agenda keys and contextual rules.
2540 For example, if you have a custom agenda command \"p\" and you
2541 want this command to be accessible only from plain text files,
2542 use this:
2544 '((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
2546 Here are the available contexts definitions:
2548 in-file: command displayed only in matching files
2549 in-mode: command displayed only in matching modes
2550 not-in-file: command not displayed in matching files
2551 not-in-mode: command not displayed in matching modes
2552 in-buffer: command displayed only in matching buffers
2553 not-in-buffer: command not displayed in matching buffers
2554 [function]: a custom function taking no argument
2556 If you define several checks, the agenda command will be
2557 accessible if there is at least one valid check.
2559 You can also bind a key to another agenda custom command
2560 depending on contextual rules.
2562 '((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
2564 Here it means: in .txt files, use \"p\" as the key for the
2565 agenda command otherwise associated with \"q\". (The command
2566 originally associated with \"q\" is not displayed to avoid
2567 duplicates.)"
2568 :version "24.3"
2569 :group 'org-agenda-custom-commands
2570 :type '(repeat (list :tag "Rule"
2571 (string :tag " Agenda key")
2572 (string :tag "Replace by command")
2573 (repeat :tag "Available when"
2574 (choice
2575 (cons :tag "Condition"
2576 (choice
2577 (const :tag "In file" in-file)
2578 (const :tag "Not in file" not-in-file)
2579 (const :tag "In buffer" in-buffer)
2580 (const :tag "Not in buffer" not-in-buffer)
2581 (const :tag "In mode" in-mode)
2582 (const :tag "Not in mode" not-in-mode))
2583 (regexp))
2584 (function :tag "Custom function"))))))
2586 (defcustom org-agenda-max-entries nil
2587 "Maximum number of entries to display in an agenda.
2588 This can be nil (no limit) or an integer or an alist of agenda
2589 types with an associated number of entries to display in this
2590 type."
2591 :version "24.4"
2592 :package-version '(Org . "8.0")
2593 :group 'org-agenda-custom-commands
2594 :type '(choice (symbol :tag "No limit" nil)
2595 (integer :tag "Max number of entries")
2596 (repeat
2597 (cons (choice :tag "Agenda type"
2598 (const agenda)
2599 (const todo)
2600 (const tags)
2601 (const search)
2602 (const timeline))
2603 (integer :tag "Max number of entries")))))
2605 (defcustom org-agenda-max-todos nil
2606 "Maximum number of TODOs to display in an agenda.
2607 This can be nil (no limit) or an integer or an alist of agenda
2608 types with an associated number of entries to display in this
2609 type."
2610 :version "24.4"
2611 :package-version '(Org . "8.0")
2612 :group 'org-agenda-custom-commands
2613 :type '(choice (symbol :tag "No limit" nil)
2614 (integer :tag "Max number of TODOs")
2615 (repeat
2616 (cons (choice :tag "Agenda type"
2617 (const agenda)
2618 (const todo)
2619 (const tags)
2620 (const search)
2621 (const timeline))
2622 (integer :tag "Max number of TODOs")))))
2624 (defcustom org-agenda-max-tags nil
2625 "Maximum number of tagged entries to display in an agenda.
2626 This can be nil (no limit) or an integer or an alist of agenda
2627 types with an associated number of entries to display in this
2628 type."
2629 :version "24.4"
2630 :package-version '(Org . "8.0")
2631 :group 'org-agenda-custom-commands
2632 :type '(choice (symbol :tag "No limit" nil)
2633 (integer :tag "Max number of tagged entries")
2634 (repeat
2635 (cons (choice :tag "Agenda type"
2636 (const agenda)
2637 (const todo)
2638 (const tags)
2639 (const search)
2640 (const timeline))
2641 (integer :tag "Max number of tagged entries")))))
2643 (defcustom org-agenda-max-effort nil
2644 "Maximum cumulated effort duration for the agenda.
2645 This can be nil (no limit) or a number of minutes (as an integer)
2646 or an alist of agenda types with an associated number of minutes
2647 to limit entries to in this type."
2648 :version "24.4"
2649 :package-version '(Org . "8.0")
2650 :group 'org-agenda-custom-commands
2651 :type '(choice (symbol :tag "No limit" nil)
2652 (integer :tag "Max number of minutes")
2653 (repeat
2654 (cons (choice :tag "Agenda type"
2655 (const agenda)
2656 (const todo)
2657 (const tags)
2658 (const search)
2659 (const timeline))
2660 (integer :tag "Max number of minutes")))))
2662 (defvar org-keys nil)
2663 (defvar org-match nil)
2664 ;;;###autoload
2665 (defun org-agenda (&optional arg org-keys restriction)
2666 "Dispatch agenda commands to collect entries to the agenda buffer.
2667 Prompts for a command to execute. Any prefix arg will be passed
2668 on to the selected command. The default selections are:
2670 a Call `org-agenda-list' to display the agenda for current day or week.
2671 t Call `org-todo-list' to display the global todo list.
2672 T Call `org-todo-list' to display the global todo list, select only
2673 entries with a specific TODO keyword (the user gets a prompt).
2674 m Call `org-tags-view' to display headlines with tags matching
2675 a condition (the user is prompted for the condition).
2676 M Like `m', but select only TODO entries, no ordinary headlines.
2677 L Create a timeline for the current buffer.
2678 e Export views to associated files.
2679 s Search entries for keywords.
2680 S Search entries for keywords, only with TODO keywords.
2681 / Multi occur across all agenda files and also files listed
2682 in `org-agenda-text-search-extra-files'.
2683 < Restrict agenda commands to buffer, subtree, or region.
2684 Press several times to get the desired effect.
2685 > Remove a previous restriction.
2686 # List \"stuck\" projects.
2687 ! Configure what \"stuck\" means.
2688 C Configure custom agenda commands.
2690 More commands can be added by configuring the variable
2691 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2692 searches can be pre-defined in this way.
2694 If the current buffer is in Org-mode and visiting a file, you can also
2695 first press `<' once to indicate that the agenda should be temporarily
2696 \(until the next use of \\[org-agenda]) restricted to the current file.
2697 Pressing `<' twice means to restrict to the current subtree or region
2698 \(if active)."
2699 (interactive "P")
2700 (catch 'exit
2701 (let* ((prefix-descriptions nil)
2702 (org-agenda-buffer-name org-agenda-buffer-name)
2703 (org-agenda-window-setup (if (equal (buffer-name)
2704 org-agenda-buffer-name)
2705 'current-window
2706 org-agenda-window-setup))
2707 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2708 (org-agenda-custom-commands
2709 ;; normalize different versions
2710 (delq nil
2711 (mapcar
2712 (lambda (x)
2713 (cond ((stringp (cdr x))
2714 (push x prefix-descriptions)
2715 nil)
2716 ((stringp (nth 1 x)) x)
2717 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2718 (t (cons (car x) (cons "" (cdr x))))))
2719 org-agenda-custom-commands)))
2720 (org-agenda-custom-commands
2721 (org-contextualize-keys
2722 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2723 (buf (current-buffer))
2724 (bfn (buffer-file-name (buffer-base-buffer)))
2725 entry key type org-match lprops ans)
2726 ;; Turn off restriction unless there is an overriding one,
2727 (unless org-agenda-overriding-restriction
2728 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2729 ;; There is a request to keep the file list in place
2730 (put 'org-agenda-files 'org-restrict nil))
2731 (setq org-agenda-restrict nil)
2732 (move-marker org-agenda-restrict-begin nil)
2733 (move-marker org-agenda-restrict-end nil))
2734 ;; Delete old local properties
2735 (put 'org-agenda-redo-command 'org-lprops nil)
2736 ;; Delete previously set last-arguments
2737 (put 'org-agenda-redo-command 'last-args nil)
2738 ;; Remember where this call originated
2739 (setq org-agenda-last-dispatch-buffer (current-buffer))
2740 (unless org-keys
2741 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2742 org-keys (car ans)
2743 restriction (cdr ans)))
2744 ;; If we have sticky agenda buffers, set a name for the buffer,
2745 ;; depending on the invoking keys. The user may still set this
2746 ;; as a command option, which will overwrite what we do here.
2747 (if org-agenda-sticky
2748 (setq org-agenda-buffer-name
2749 (format "*Org Agenda(%s)*" org-keys)))
2750 ;; Establish the restriction, if any
2751 (when (and (not org-agenda-overriding-restriction) restriction)
2752 (put 'org-agenda-files 'org-restrict (list bfn))
2753 (cond
2754 ((eq restriction 'region)
2755 (setq org-agenda-restrict (current-buffer))
2756 (move-marker org-agenda-restrict-begin (region-beginning))
2757 (move-marker org-agenda-restrict-end (region-end)))
2758 ((eq restriction 'subtree)
2759 (save-excursion
2760 (setq org-agenda-restrict (current-buffer))
2761 (org-back-to-heading t)
2762 (move-marker org-agenda-restrict-begin (point))
2763 (move-marker org-agenda-restrict-end
2764 (progn (org-end-of-subtree t)))))))
2766 ;; For example the todo list should not need it (but does...)
2767 (cond
2768 ((setq entry (assoc org-keys org-agenda-custom-commands))
2769 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2770 (progn
2771 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2772 lprops (nth 4 entry))
2773 (if org-agenda-sticky
2774 (setq org-agenda-buffer-name
2775 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2776 (format "*Org Agenda(%s)*" org-keys))))
2777 (put 'org-agenda-redo-command 'org-lprops lprops)
2778 (cond
2779 ((eq type 'agenda)
2780 (org-let lprops '(org-agenda-list current-prefix-arg)))
2781 ((eq type 'agenda*)
2782 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2783 ((eq type 'alltodo)
2784 (org-let lprops '(org-todo-list current-prefix-arg)))
2785 ((eq type 'search)
2786 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2787 ((eq type 'stuck)
2788 (org-let lprops '(org-agenda-list-stuck-projects
2789 current-prefix-arg)))
2790 ((eq type 'tags)
2791 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2792 ((eq type 'tags-todo)
2793 (org-let lprops '(org-tags-view '(4) org-match)))
2794 ((eq type 'todo)
2795 (org-let lprops '(org-todo-list org-match)))
2796 ((eq type 'tags-tree)
2797 (org-check-for-org-mode)
2798 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2799 ((eq type 'todo-tree)
2800 (org-check-for-org-mode)
2801 (org-let lprops
2802 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2803 (regexp-quote org-match) "\\>"))))
2804 ((eq type 'occur-tree)
2805 (org-check-for-org-mode)
2806 (org-let lprops '(org-occur org-match)))
2807 ((functionp type)
2808 (org-let lprops '(funcall type org-match)))
2809 ((fboundp type)
2810 (org-let lprops '(funcall type org-match)))
2811 (t (user-error "Invalid custom agenda command type %s" type))))
2812 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2813 ((equal org-keys "C")
2814 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2815 (customize-variable 'org-agenda-custom-commands))
2816 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2817 ((equal org-keys "s") (call-interactively 'org-search-view))
2818 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2819 ((equal org-keys "t") (call-interactively 'org-todo-list))
2820 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2821 ((equal org-keys "m") (call-interactively 'org-tags-view))
2822 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2823 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2824 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2825 (org-add-hook
2826 'post-command-hook
2827 (lambda ()
2828 (unless (current-message)
2829 (let* ((m (org-agenda-get-any-marker))
2830 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2831 (when note
2832 (message (concat
2833 "FLAGGING-NOTE ([?] for more info): "
2834 (org-add-props
2835 (replace-regexp-in-string
2836 "\\\\n" "//"
2837 (copy-sequence note))
2838 nil 'face 'org-warning)))))))
2839 t t))
2840 ((equal org-keys "L")
2841 (unless (derived-mode-p 'org-mode)
2842 (user-error "This is not an Org-mode file"))
2843 (unless restriction
2844 (put 'org-agenda-files 'org-restrict (list bfn))
2845 (org-call-with-arg 'org-timeline arg)))
2846 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2847 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2848 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2849 (t (user-error "Invalid agenda key"))))))
2851 (defvar org-agenda-multi)
2853 (defun org-agenda-append-agenda ()
2854 "Append another agenda view to the current one.
2855 This function allows interactive building of block agendas.
2856 Agenda views are separated by `org-agenda-block-separator'."
2857 (interactive)
2858 (unless (derived-mode-p 'org-agenda-mode)
2859 (user-error "Can only append from within agenda buffer"))
2860 (let ((org-agenda-multi t))
2861 (org-agenda)
2862 (widen)
2863 (org-agenda-finalize)
2864 (setq buffer-read-only t)
2865 (org-agenda-fit-window-to-buffer)))
2867 (defun org-agenda-normalize-custom-commands (cmds)
2868 "Normalize custom commands CMDS."
2869 (delq nil
2870 (mapcar
2871 (lambda (x)
2872 (cond ((stringp (cdr x)) nil)
2873 ((stringp (nth 1 x)) x)
2874 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2875 (t (cons (car x) (cons "" (cdr x))))))
2876 cmds)))
2878 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2879 "The user interface for selecting an agenda command."
2880 (catch 'exit
2881 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2882 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2883 (region-p (org-region-active-p))
2884 (custom org-agenda-custom-commands)
2885 (selstring "")
2886 restriction second-time
2887 c entry key type match prefixes rmheader header-end custom1 desc
2888 line lines left right n n1)
2889 (save-window-excursion
2890 (delete-other-windows)
2891 (org-switch-to-buffer-other-window " *Agenda Commands*")
2892 (erase-buffer)
2893 (insert (eval-when-compile
2894 (let ((header
2895 "Press key for an agenda command: < Buffer, subtree/region restriction
2896 -------------------------------- > Remove restriction
2897 a Agenda for current week or day e Export agenda views
2898 t List of all TODO entries T Entries with special TODO kwd
2899 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2900 s Search for keywords S Like s, but only TODO entries
2901 L Timeline for current buffer # List stuck projects (!=configure)
2902 / Multi-occur C Configure custom agenda commands
2903 ? Find :FLAGGED: entries * Toggle sticky agenda views
2905 (start 0))
2906 (while (string-match
2907 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2908 header start)
2909 (setq start (match-end 0))
2910 (add-text-properties (match-beginning 2) (match-end 2)
2911 '(face bold) header))
2912 header)))
2913 (setq header-end (point-marker))
2914 (while t
2915 (setq custom1 custom)
2916 (when (eq rmheader t)
2917 (org-goto-line 1)
2918 (re-search-forward ":" nil t)
2919 (delete-region (match-end 0) (point-at-eol))
2920 (forward-char 1)
2921 (looking-at "-+")
2922 (delete-region (match-end 0) (point-at-eol))
2923 (move-marker header-end (match-end 0)))
2924 (goto-char header-end)
2925 (delete-region (point) (point-max))
2927 ;; Produce all the lines that describe custom commands and prefixes
2928 (setq lines nil)
2929 (while (setq entry (pop custom1))
2930 (setq key (car entry) desc (nth 1 entry)
2931 type (nth 2 entry)
2932 match (nth 3 entry))
2933 (if (> (length key) 1)
2934 (add-to-list 'prefixes (string-to-char key))
2935 (setq line
2936 (format
2937 "%-4s%-14s"
2938 (org-add-props (copy-sequence key)
2939 '(face bold))
2940 (cond
2941 ((string-match "\\S-" desc) desc)
2942 ((eq type 'agenda) "Agenda for current week or day")
2943 ((eq type 'agenda*) "Appointments for current week or day")
2944 ((eq type 'alltodo) "List of all TODO entries")
2945 ((eq type 'search) "Word search")
2946 ((eq type 'stuck) "List of stuck projects")
2947 ((eq type 'todo) "TODO keyword")
2948 ((eq type 'tags) "Tags query")
2949 ((eq type 'tags-todo) "Tags (TODO)")
2950 ((eq type 'tags-tree) "Tags tree")
2951 ((eq type 'todo-tree) "TODO kwd tree")
2952 ((eq type 'occur-tree) "Occur tree")
2953 ((functionp type) (if (symbolp type)
2954 (symbol-name type)
2955 "Lambda expression"))
2956 (t "???"))))
2957 (if org-agenda-menu-show-matcher
2958 (setq line
2959 (concat line ": "
2960 (cond
2961 ((stringp match)
2962 (setq match (copy-sequence match))
2963 (org-add-props match nil 'face 'org-warning))
2964 ((listp type)
2965 (format "set of %d commands" (length type))))))
2966 (if (org-string-nw-p match)
2967 (add-text-properties
2968 0 (length line) (list 'help-echo
2969 (concat "Matcher: " match)) line)))
2970 (push line lines)))
2971 (setq lines (nreverse lines))
2972 (when prefixes
2973 (mapc (lambda (x)
2974 (push
2975 (format "%s %s"
2976 (org-add-props (char-to-string x)
2977 nil 'face 'bold)
2978 (or (cdr (assoc (concat selstring
2979 (char-to-string x))
2980 prefix-descriptions))
2981 "Prefix key"))
2982 lines))
2983 prefixes))
2985 ;; Check if we should display in two columns
2986 (if org-agenda-menu-two-columns
2987 (progn
2988 (setq n (length lines)
2989 n1 (+ (/ n 2) (mod n 2))
2990 right (nthcdr n1 lines)
2991 left (copy-sequence lines))
2992 (setcdr (nthcdr (1- n1) left) nil))
2993 (setq left lines right nil))
2994 (while left
2995 (insert "\n" (pop left))
2996 (when right
2997 (if (< (current-column) 40)
2998 (move-to-column 40 t)
2999 (insert " "))
3000 (insert (pop right))))
3002 ;; Make the window the right size
3003 (goto-char (point-min))
3004 (if second-time
3005 (if (not (pos-visible-in-window-p (point-max)))
3006 (org-fit-window-to-buffer))
3007 (setq second-time t)
3008 (org-fit-window-to-buffer))
3010 ;; Ask for selection
3011 (message "Press key for agenda command%s:"
3012 (if (or restrict-ok org-agenda-overriding-restriction)
3013 (if org-agenda-overriding-restriction
3014 " (restriction lock active)"
3015 (if restriction
3016 (format " (restricted to %s)" restriction)
3017 " (unrestricted)"))
3018 ""))
3019 (setq c (read-char-exclusive))
3020 (message "")
3021 (cond
3022 ((assoc (char-to-string c) custom)
3023 (setq selstring (concat selstring (char-to-string c)))
3024 (throw 'exit (cons selstring restriction)))
3025 ((memq c prefixes)
3026 (setq selstring (concat selstring (char-to-string c))
3027 prefixes nil
3028 rmheader (or rmheader t)
3029 custom (delq nil (mapcar
3030 (lambda (x)
3031 (if (or (= (length (car x)) 1)
3032 (/= (string-to-char (car x)) c))
3034 (cons (substring (car x) 1) (cdr x))))
3035 custom))))
3036 ((eq c ?*)
3037 (call-interactively 'org-toggle-sticky-agenda)
3038 (sit-for 2))
3039 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3040 (message "Restriction is only possible in Org-mode buffers")
3041 (ding) (sit-for 1))
3042 ((eq c ?1)
3043 (org-agenda-remove-restriction-lock 'noupdate)
3044 (setq restriction 'buffer))
3045 ((eq c ?0)
3046 (org-agenda-remove-restriction-lock 'noupdate)
3047 (setq restriction (if region-p 'region 'subtree)))
3048 ((eq c ?<)
3049 (org-agenda-remove-restriction-lock 'noupdate)
3050 (setq restriction
3051 (cond
3052 ((eq restriction 'buffer)
3053 (if region-p 'region 'subtree))
3054 ((memq restriction '(subtree region))
3055 nil)
3056 (t 'buffer))))
3057 ((eq c ?>)
3058 (org-agenda-remove-restriction-lock 'noupdate)
3059 (setq restriction nil))
3060 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3061 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3062 ((and (> (length selstring) 0) (eq c ?\d))
3063 (delete-window)
3064 (org-agenda-get-restriction-and-command prefix-descriptions))
3066 ((equal c ?q) (error "Abort"))
3067 (t (user-error "Invalid key %c" c))))))))
3069 (defun org-agenda-fit-window-to-buffer ()
3070 "Fit the window to the buffer size."
3071 (and (memq org-agenda-window-setup '(reorganize-frame))
3072 (fboundp 'fit-window-to-buffer)
3073 (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
3074 (= (car org-agenda-window-frame-fractions) 1.0))
3075 (delete-other-windows)
3076 (org-fit-window-to-buffer
3078 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3079 (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
3081 (defvar org-cmd nil)
3082 (defvar org-agenda-overriding-cmd nil)
3083 (defvar org-agenda-overriding-arguments nil)
3084 (defvar org-agenda-overriding-cmd-arguments nil)
3085 (defun org-agenda-run-series (name series)
3086 "Run agenda NAME as a SERIES of agenda commands."
3087 (org-let (nth 1 series) '(org-agenda-prepare name))
3088 ;; We need to reset agenda markers here, because when constructing a
3089 ;; block agenda, the individual blocks do not do that.
3090 (org-agenda-reset-markers)
3091 (let* ((org-agenda-multi t)
3092 (redo (list 'org-agenda-run-series name (list 'quote series)))
3093 (cmds (car series))
3094 (gprops (nth 1 series))
3095 match ;; The byte compiler incorrectly complains about this. Keep it!
3096 org-cmd type lprops)
3097 (while (setq org-cmd (pop cmds))
3098 (setq type (car org-cmd)
3099 match (eval (nth 1 org-cmd))
3100 lprops (nth 2 org-cmd))
3101 (let ((org-agenda-overriding-arguments
3102 (if (eq org-agenda-overriding-cmd org-cmd)
3103 (or org-agenda-overriding-arguments
3104 org-agenda-overriding-cmd-arguments))))
3105 (cond
3106 ((eq type 'agenda)
3107 (org-let2 gprops lprops
3108 '(call-interactively 'org-agenda-list)))
3109 ((eq type 'agenda*)
3110 (org-let2 gprops lprops
3111 '(funcall 'org-agenda-list nil nil t)))
3112 ((eq type 'alltodo)
3113 (org-let2 gprops lprops
3114 '(call-interactively 'org-todo-list)))
3115 ((eq type 'search)
3116 (org-let2 gprops lprops
3117 '(org-search-view current-prefix-arg match nil)))
3118 ((eq type 'stuck)
3119 (org-let2 gprops lprops
3120 '(call-interactively 'org-agenda-list-stuck-projects)))
3121 ((eq type 'tags)
3122 (org-let2 gprops lprops
3123 '(org-tags-view current-prefix-arg match)))
3124 ((eq type 'tags-todo)
3125 (org-let2 gprops lprops
3126 '(org-tags-view '(4) match)))
3127 ((eq type 'todo)
3128 (org-let2 gprops lprops
3129 '(org-todo-list match)))
3130 ((fboundp type)
3131 (org-let2 gprops lprops
3132 '(funcall type match)))
3133 (t (error "Invalid type in command series")))))
3134 (widen)
3135 (let ((inhibit-read-only t))
3136 (add-text-properties (point-min) (point-max)
3137 `(org-series t org-series-redo-cmd ,redo)))
3138 (setq org-agenda-redo-command redo)
3139 (goto-char (point-min)))
3140 (org-agenda-fit-window-to-buffer)
3141 (org-let (nth 1 series) '(org-agenda-finalize)))
3143 ;;;###autoload
3144 (defmacro org-batch-agenda (cmd-key &rest parameters)
3145 "Run an agenda command in batch mode and send the result to STDOUT.
3146 If CMD-KEY is a string of length 1, it is used as a key in
3147 `org-agenda-custom-commands' and triggers this command. If it is a
3148 longer string it is used as a tags/todo match string.
3149 Parameters are alternating variable names and values that will be bound
3150 before running the agenda command."
3151 (org-eval-in-environment (org-make-parameter-alist parameters)
3152 (let (org-agenda-sticky)
3153 (if (> (length cmd-key) 2)
3154 (org-tags-view nil cmd-key)
3155 (org-agenda nil cmd-key))))
3156 (set-buffer org-agenda-buffer-name)
3157 (princ (buffer-string)))
3159 (defvar org-agenda-info nil)
3161 ;;;###autoload
3162 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3163 "Run an agenda command in batch mode and send the result to STDOUT.
3164 If CMD-KEY is a string of length 1, it is used as a key in
3165 `org-agenda-custom-commands' and triggers this command. If it is a
3166 longer string it is used as a tags/todo match string.
3167 Parameters are alternating variable names and values that will be bound
3168 before running the agenda command.
3170 The output gives a line for each selected agenda item. Each
3171 item is a list of comma-separated values, like this:
3173 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3175 category The category of the item
3176 head The headline, without TODO kwd, TAGS and PRIORITY
3177 type The type of the agenda entry, can be
3178 todo selected in TODO match
3179 tagsmatch selected in tags match
3180 diary imported from diary
3181 deadline a deadline on given date
3182 scheduled scheduled on given date
3183 timestamp entry has timestamp on given date
3184 closed entry was closed on given date
3185 upcoming-deadline warning about deadline
3186 past-scheduled forwarded scheduled item
3187 block entry has date block including g. date
3188 todo The todo keyword, if any
3189 tags All tags including inherited ones, separated by colons
3190 date The relevant date, like 2007-2-14
3191 time The time, like 15:00-16:50
3192 extra Sting with extra planning info
3193 priority-l The priority letter if any was given
3194 priority-n The computed numerical priority
3195 agenda-day The day in the agenda where this is listed"
3196 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3197 (org-make-parameter-alist parameters))
3198 (if (> (length cmd-key) 2)
3199 (org-tags-view nil cmd-key)
3200 (org-agenda nil cmd-key)))
3201 (set-buffer org-agenda-buffer-name)
3202 (let* ((lines (org-split-string (buffer-string) "\n"))
3203 line)
3204 (while (setq line (pop lines))
3205 (catch 'next
3206 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3207 (setq org-agenda-info
3208 (org-fix-agenda-info (text-properties-at 0 line)))
3209 (princ
3210 (mapconcat 'org-agenda-export-csv-mapper
3211 '(org-category txt type todo tags date time extra
3212 priority-letter priority agenda-day)
3213 ","))
3214 (princ "\n")))))
3216 (defun org-fix-agenda-info (props)
3217 "Make sure all properties on an agenda item have a canonical form.
3218 This ensures the export commands can easily use it."
3219 (let (tmp re)
3220 (when (setq tmp (plist-get props 'tags))
3221 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3222 (when (setq tmp (plist-get props 'date))
3223 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3224 (let ((calendar-date-display-form '(year "-" month "-" day)))
3225 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3227 (setq tmp (calendar-date-string tmp)))
3228 (setq props (plist-put props 'date tmp)))
3229 (when (setq tmp (plist-get props 'day))
3230 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3231 (let ((calendar-date-display-form '(year "-" month "-" day)))
3232 (setq tmp (calendar-date-string tmp)))
3233 (setq props (plist-put props 'day tmp))
3234 (setq props (plist-put props 'agenda-day tmp)))
3235 (when (setq tmp (plist-get props 'txt))
3236 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3237 (plist-put props 'priority-letter (match-string 1 tmp))
3238 (setq tmp (replace-match "" t t tmp)))
3239 (when (and (setq re (plist-get props 'org-todo-regexp))
3240 (setq re (concat "\\`\\.*" re " ?"))
3241 (string-match re tmp))
3242 (plist-put props 'todo (match-string 1 tmp))
3243 (setq tmp (replace-match "" t t tmp)))
3244 (plist-put props 'txt tmp)))
3245 props)
3247 (defun org-agenda-export-csv-mapper (prop)
3248 (let ((res (plist-get org-agenda-info prop)))
3249 (setq res
3250 (cond
3251 ((not res) "")
3252 ((stringp res) res)
3253 (t (prin1-to-string res))))
3254 (while (string-match "," res)
3255 (setq res (replace-match ";" t t res)))
3256 (org-trim res)))
3258 ;;;###autoload
3259 (defun org-store-agenda-views (&rest parameters)
3260 "Store agenda views."
3261 (interactive)
3262 (eval (list 'org-batch-store-agenda-views)))
3264 ;;;###autoload
3265 (defmacro org-batch-store-agenda-views (&rest parameters)
3266 "Run all custom agenda commands that have a file argument."
3267 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3268 (pop-up-frames nil)
3269 (dir default-directory)
3270 (pars (org-make-parameter-alist parameters))
3271 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3272 (save-window-excursion
3273 (while cmds
3274 (setq cmd (pop cmds)
3275 thiscmdkey (car cmd)
3276 thiscmdcmd (cdr cmd)
3277 match (nth 2 thiscmdcmd)
3278 bufname (if org-agenda-sticky
3279 (or (and (stringp match)
3280 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3281 (format "*Org Agenda(%s)*" thiscmdkey))
3282 org-agenda-buffer-name)
3283 cmd-or-set (nth 2 cmd)
3284 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3285 files (nth (if (listp cmd-or-set) 4 5) cmd))
3286 (if (stringp files) (setq files (list files)))
3287 (when files
3288 (org-eval-in-environment (append org-agenda-exporter-settings
3289 opts pars)
3290 (org-agenda nil thiscmdkey))
3291 (set-buffer bufname)
3292 (while files
3293 (org-eval-in-environment (append org-agenda-exporter-settings
3294 opts pars)
3295 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3296 (and (get-buffer bufname)
3297 (kill-buffer bufname)))))))
3299 (defvar org-agenda-current-span nil
3300 "The current span used in the agenda view.") ; local variable in the agenda buffer
3301 (defun org-agenda-mark-header-line (pos)
3302 "Mark the line at POS as an agenda structure header."
3303 (save-excursion
3304 (goto-char pos)
3305 (put-text-property (point-at-bol) (point-at-eol)
3306 'org-agenda-structural-header t)
3307 (when org-agenda-title-append
3308 (put-text-property (point-at-bol) (point-at-eol)
3309 'org-agenda-title-append org-agenda-title-append))))
3311 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3312 (defvar org-agenda-write-buffer-name "Agenda View")
3313 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3314 "Write the current buffer (an agenda view) as a file.
3316 Depending on the extension of the file name, plain text (.txt),
3317 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3318 If the extension is .ics, translate visible agenda into iCalendar
3319 format. If the extension is .org, collect all subtrees
3320 corresponding to the agenda entries and add them in an .org file.
3322 With prefix argument OPEN, open the new file immediately. If
3323 NOSETTINGS is given, do not scope the settings of
3324 `org-agenda-exporter-settings' into the export commands. This is
3325 used when the settings have already been scoped and we do not
3326 wish to overrule other, higher priority settings. If
3327 AGENDA-BUFFER-NAME is provided, use this as the buffer name for
3328 the agenda to write."
3329 (interactive "FWrite agenda to file: \nP")
3330 (if (or (not (file-writable-p file))
3331 (and (file-exists-p file)
3332 (if (org-called-interactively-p 'any)
3333 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3334 (user-error "Cannot write agenda to file %s" file))
3335 (org-let (if nosettings nil org-agenda-exporter-settings)
3336 '(save-excursion
3337 (save-window-excursion
3338 (let ((bs (copy-sequence (buffer-string))) beg content)
3339 (with-temp-buffer
3340 (rename-buffer org-agenda-write-buffer-name t)
3341 (set-buffer-modified-p nil)
3342 (insert bs)
3343 (org-agenda-remove-marked-text 'org-filtered)
3344 (run-hooks 'org-agenda-before-write-hook)
3345 (cond
3346 ((org-bound-and-true-p org-mobile-creating-agendas)
3347 (org-mobile-write-agenda-for-mobile file))
3348 ((string-match "\\.org\\'" file)
3349 (let (content p m message-log-max)
3350 (goto-char (point-min))
3351 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3352 (goto-char p)
3353 (setq m (get-text-property (point) 'org-hd-marker))
3354 (when m
3355 (push (save-excursion
3356 (set-buffer (marker-buffer m))
3357 (goto-char m)
3358 (org-copy-subtree 1 nil t t)
3359 org-subtree-clip)
3360 content)))
3361 (find-file file)
3362 (erase-buffer)
3363 (dolist (s content) (org-paste-subtree 1 s))
3364 (write-file file)
3365 (kill-buffer (current-buffer))
3366 (message "Org file written to %s" file)))
3367 ((string-match "\\.html?\\'" file)
3368 (require 'htmlize)
3369 (set-buffer (htmlize-buffer (current-buffer)))
3370 (when org-agenda-export-html-style
3371 ;; replace <style> section with org-agenda-export-html-style
3372 (goto-char (point-min))
3373 (kill-region (- (search-forward "<style") 6)
3374 (search-forward "</style>"))
3375 (insert org-agenda-export-html-style))
3376 (write-file file)
3377 (kill-buffer (current-buffer))
3378 (message "HTML written to %s" file))
3379 ((string-match "\\.ps\\'" file)
3380 (require 'ps-print)
3381 (ps-print-buffer-with-faces file)
3382 (message "Postscript written to %s" file))
3383 ((string-match "\\.pdf\\'" file)
3384 (require 'ps-print)
3385 (ps-print-buffer-with-faces
3386 (concat (file-name-sans-extension file) ".ps"))
3387 (call-process "ps2pdf" nil nil nil
3388 (expand-file-name
3389 (concat (file-name-sans-extension file) ".ps"))
3390 (expand-file-name file))
3391 (delete-file (concat (file-name-sans-extension file) ".ps"))
3392 (message "PDF written to %s" file))
3393 ((string-match "\\.ics\\'" file)
3394 (require 'ox-icalendar)
3395 (org-icalendar-export-current-agenda (expand-file-name file)))
3397 (let ((bs (buffer-string)))
3398 (find-file file)
3399 (erase-buffer)
3400 (insert bs)
3401 (save-buffer 0)
3402 (kill-buffer (current-buffer))
3403 (message "Plain text written to %s" file))))))))
3404 (set-buffer (or agenda-bufname
3405 (and (org-called-interactively-p 'any) (buffer-name))
3406 org-agenda-buffer-name)))
3407 (when open (org-open-file file)))
3409 (defun org-agenda-remove-marked-text (property &optional value)
3410 "Delete all text marked with VALUE of PROPERTY.
3411 VALUE defaults to t."
3412 (let (beg)
3413 (setq value (or value t))
3414 (while (setq beg (text-property-any (point-min) (point-max)
3415 property value))
3416 (delete-region
3417 beg (or (next-single-property-change beg property)
3418 (point-max))))))
3420 (defun org-agenda-add-entry-text ()
3421 "Add entry text to agenda lines.
3422 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3423 entry text following headings shown in the agenda.
3424 Drawers will be excluded, also the line with scheduling/deadline info."
3425 (when (and (> org-agenda-add-entry-text-maxlines 0)
3426 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3427 (let (m txt)
3428 (goto-char (point-min))
3429 (while (not (eobp))
3430 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3431 (beginning-of-line 2)
3432 (setq txt (org-agenda-get-some-entry-text
3433 m org-agenda-add-entry-text-maxlines " > "))
3434 (end-of-line 1)
3435 (if (string-match "\\S-" txt)
3436 (insert "\n" txt)
3437 (or (eobp) (forward-char 1))))))))
3439 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3440 &rest keep)
3441 "Extract entry text from MARKER, at most N-LINES lines.
3442 This will ignore drawers etc, just get the text.
3443 If INDENT is given, prefix every line with this string. If KEEP is
3444 given, it is a list of symbols, defining stuff that should not be
3445 removed from the entry content. Currently only `planning' is allowed here."
3446 (let (txt drawer-re kwd-time-re ind)
3447 (save-excursion
3448 (with-current-buffer (marker-buffer marker)
3449 (if (not (derived-mode-p 'org-mode))
3450 (setq txt "")
3451 (save-excursion
3452 (save-restriction
3453 (widen)
3454 (goto-char marker)
3455 (end-of-line 1)
3456 (setq txt (buffer-substring
3457 (min (1+ (point)) (point-max))
3458 (progn (outline-next-heading) (point)))
3459 drawer-re org-drawer-regexp
3460 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3461 ".*\n?"))
3462 (with-temp-buffer
3463 (insert txt)
3464 (when org-agenda-add-entry-text-descriptive-links
3465 (goto-char (point-min))
3466 (while (org-activate-bracket-links (point-max))
3467 (add-text-properties (match-beginning 0) (match-end 0)
3468 '(face org-link))))
3469 (goto-char (point-min))
3470 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3471 (set-text-properties (match-beginning 0) (match-end 0)
3472 nil))
3473 (goto-char (point-min))
3474 (while (re-search-forward drawer-re nil t)
3475 (delete-region
3476 (match-beginning 0)
3477 (progn (re-search-forward
3478 "^[ \t]*:END:.*\n?" nil 'move)
3479 (point))))
3480 (unless (member 'planning keep)
3481 (goto-char (point-min))
3482 (while (re-search-forward kwd-time-re nil t)
3483 (replace-match "")))
3484 (goto-char (point-min))
3485 (when org-agenda-entry-text-exclude-regexps
3486 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3487 (while (setq re (pop re-list))
3488 (goto-char (point-min))
3489 (while (re-search-forward re nil t)
3490 (replace-match "")))))
3491 (goto-char (point-max))
3492 (skip-chars-backward " \t\n")
3493 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3495 ;; find and remove min common indentation
3496 (goto-char (point-min))
3497 (untabify (point-min) (point-max))
3498 (setq ind (org-get-indentation))
3499 (while (not (eobp))
3500 (unless (looking-at "[ \t]*$")
3501 (setq ind (min ind (org-get-indentation))))
3502 (beginning-of-line 2))
3503 (goto-char (point-min))
3504 (while (not (eobp))
3505 (unless (looking-at "[ \t]*$")
3506 (move-to-column ind)
3507 (delete-region (point-at-bol) (point)))
3508 (beginning-of-line 2))
3510 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3512 (goto-char (point-min))
3513 (when indent
3514 (while (and (not (eobp)) (re-search-forward "^" nil t))
3515 (replace-match indent t t)))
3516 (goto-char (point-min))
3517 (while (looking-at "[ \t]*\n") (replace-match ""))
3518 (goto-char (point-max))
3519 (when (> (org-current-line)
3520 n-lines)
3521 (org-goto-line (1+ n-lines))
3522 (backward-char 1))
3523 (setq txt (buffer-substring (point-min) (point)))))))))
3524 txt))
3526 (defun org-check-for-org-mode ()
3527 "Make sure current buffer is in org-mode. Error if not."
3528 (or (derived-mode-p 'org-mode)
3529 (error "Cannot execute org-mode agenda command on buffer in %s"
3530 major-mode)))
3532 ;;; Agenda prepare and finalize
3534 (defvar org-agenda-multi nil) ; dynamically scoped
3535 (defvar org-agenda-pre-window-conf nil)
3536 (defvar org-agenda-columns-active nil)
3537 (defvar org-agenda-name nil)
3538 (defvar org-agenda-tag-filter nil)
3539 (defvar org-agenda-category-filter nil)
3540 (defvar org-agenda-regexp-filter nil)
3541 (defvar org-agenda-effort-filter nil)
3542 (defvar org-agenda-top-headline-filter nil)
3543 (defvar org-agenda-tag-filter-preset nil
3544 "A preset of the tags filter used for secondary agenda filtering.
3545 This must be a list of strings, each string must be a single tag preceded
3546 by \"+\" or \"-\".
3547 This variable should not be set directly, but agenda custom commands can
3548 bind it in the options section. The preset filter is a global property of
3549 the entire agenda view. In a block agenda, it will not work reliably to
3550 define a filter for one of the individual blocks. You need to set it in
3551 the global options and expect it to be applied to the entire view.")
3553 (defvar org-agenda-category-filter-preset nil
3554 "A preset of the category filter used for secondary agenda filtering.
3555 This must be a list of strings, each string must be a single category
3556 preceded by \"+\" or \"-\".
3557 This variable should not be set directly, but agenda custom commands can
3558 bind it in the options section. The preset filter is a global property of
3559 the entire agenda view. In a block agenda, it will not work reliably to
3560 define a filter for one of the individual blocks. You need to set it in
3561 the global options and expect it to be applied to the entire view.")
3563 (defvar org-agenda-regexp-filter-preset nil
3564 "A preset of the regexp filter used for secondary agenda filtering.
3565 This must be a list of strings, each string must be a single regexp
3566 preceded by \"+\" or \"-\".
3567 This variable should not be set directly, but agenda custom commands can
3568 bind it in the options section. The preset filter is a global property of
3569 the entire agenda view. In a block agenda, it will not work reliably to
3570 define a filter for one of the individual blocks. You need to set it in
3571 the global options and expect it to be applied to the entire view.")
3573 (defvar org-agenda-effort-filter-preset nil
3574 "A preset of the effort condition used for secondary agenda filtering.
3575 This must be a list of strings, each string must be a single regexp
3576 preceded by \"+\" or \"-\".
3577 This variable should not be set directly, but agenda custom commands can
3578 bind it in the options section. The preset filter is a global property of
3579 the entire agenda view. In a block agenda, it will not work reliably to
3580 define a filter for one of the individual blocks. You need to set it in
3581 the global options and expect it to be applied to the entire view.")
3583 (defun org-agenda-use-sticky-p ()
3584 "Return non-nil if an agenda buffer named
3585 `org-agenda-buffer-name' exists and should be shown instead of
3586 generating a new one."
3587 (and
3588 ;; turned off by user
3589 org-agenda-sticky
3590 ;; For multi-agenda buffer already exists
3591 (not org-agenda-multi)
3592 ;; buffer found
3593 (get-buffer org-agenda-buffer-name)
3594 ;; C-u parameter is same as last call
3595 (with-current-buffer (get-buffer org-agenda-buffer-name)
3596 (and
3597 (equal current-prefix-arg
3598 org-agenda-last-prefix-arg)
3599 ;; In case user turned stickiness on, while having existing
3600 ;; Agenda buffer active, don't reuse that buffer, because it
3601 ;; does not have org variables local
3602 org-agenda-this-buffer-is-sticky))))
3604 (defun org-agenda-prepare-window (abuf filter-alist)
3605 "Setup agenda buffer in the window.
3606 ABUF is the buffer for the agenda window.
3607 FILTER-ALIST is an alist of filters we need to apply when
3608 `org-agenda-persistent-filter' is non-nil."
3609 (let* ((awin (get-buffer-window abuf)) wconf)
3610 (cond
3611 ((equal (current-buffer) abuf) nil)
3612 (awin (select-window awin))
3613 ((not (setq wconf (current-window-configuration))))
3614 ((equal org-agenda-window-setup 'current-window)
3615 (org-pop-to-buffer-same-window abuf))
3616 ((equal org-agenda-window-setup 'other-window)
3617 (org-switch-to-buffer-other-window abuf))
3618 ((equal org-agenda-window-setup 'other-frame)
3619 (switch-to-buffer-other-frame abuf))
3620 ((equal org-agenda-window-setup 'reorganize-frame)
3621 (delete-other-windows)
3622 (org-switch-to-buffer-other-window abuf)))
3623 (setq org-agenda-tag-filter (cdr (assoc 'tag filter-alist)))
3624 (setq org-agenda-category-filter (cdr (assoc 'cat filter-alist)))
3625 (setq org-agenda-effort-filter (cdr (assoc 'effort filter-alist)))
3626 (setq org-agenda-regexp-filter (cdr (assoc 're filter-alist)))
3627 ;; Additional test in case agenda is invoked from within agenda
3628 ;; buffer via elisp link.
3629 (unless (equal (current-buffer) abuf)
3630 (org-pop-to-buffer-same-window abuf))
3631 (setq org-agenda-pre-window-conf
3632 (or org-agenda-pre-window-conf wconf))))
3634 (defun org-agenda-prepare (&optional name)
3635 (let ((filter-alist (if org-agenda-persistent-filter
3636 (list `(tag . ,org-agenda-tag-filter)
3637 `(re . ,org-agenda-regexp-filter)
3638 `(effort . ,org-agenda-effort-filter)
3639 `(car . ,org-agenda-category-filter)))))
3640 (if (org-agenda-use-sticky-p)
3641 (progn
3642 (put 'org-agenda-tag-filter :preset-filter nil)
3643 (put 'org-agenda-category-filter :preset-filter nil)
3644 (put 'org-agenda-regexp-filter :preset-filter nil)
3645 ;; Popup existing buffer
3646 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
3647 filter-alist)
3648 (message "Sticky Agenda buffer, use `r' to refresh")
3649 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3650 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3651 (setq org-todo-keywords-for-agenda nil)
3652 (put 'org-agenda-tag-filter :preset-filter
3653 org-agenda-tag-filter-preset)
3654 (put 'org-agenda-category-filter :preset-filter
3655 org-agenda-category-filter-preset)
3656 (put 'org-agenda-regexp-filter :preset-filter
3657 org-agenda-regexp-filter-preset)
3658 (put 'org-agenda-effort-filter :preset-filter
3659 org-agenda-effort-filter-preset)
3660 (if org-agenda-multi
3661 (progn
3662 (setq buffer-read-only nil)
3663 (goto-char (point-max))
3664 (unless (or (bobp) org-agenda-compact-blocks
3665 (not org-agenda-block-separator))
3666 (insert "\n"
3667 (if (stringp org-agenda-block-separator)
3668 org-agenda-block-separator
3669 (make-string (window-width) org-agenda-block-separator))
3670 "\n"))
3671 (narrow-to-region (point) (point-max)))
3672 (setq org-done-keywords-for-agenda nil)
3673 ;; Setting any org variables that are in org-agenda-local-vars
3674 ;; list need to be done after the prepare call
3675 (org-agenda-prepare-window
3676 (get-buffer-create org-agenda-buffer-name) filter-alist)
3677 (setq buffer-read-only nil)
3678 (org-agenda-reset-markers)
3679 (let ((inhibit-read-only t)) (erase-buffer))
3680 (org-agenda-mode)
3681 (setq org-agenda-buffer (current-buffer))
3682 (setq org-agenda-contributing-files nil)
3683 (setq org-agenda-columns-active nil)
3684 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3685 (setq org-todo-keywords-for-agenda
3686 (org-uniquify org-todo-keywords-for-agenda))
3687 (setq org-done-keywords-for-agenda
3688 (org-uniquify org-done-keywords-for-agenda))
3689 (setq org-agenda-last-prefix-arg current-prefix-arg)
3690 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3691 (and name (not org-agenda-name)
3692 (org-set-local 'org-agenda-name name)))
3693 (setq buffer-read-only nil))))
3695 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3696 (defun org-agenda-finalize ()
3697 "Finishing touch for the agenda buffer, called just before displaying it."
3698 (unless org-agenda-multi
3699 (save-excursion
3700 (let ((inhibit-read-only t))
3701 (goto-char (point-min))
3702 (save-excursion
3703 (while (org-activate-bracket-links (point-max))
3704 (add-text-properties (match-beginning 0) (match-end 0)
3705 '(face org-link))))
3706 (save-excursion
3707 (while (org-activate-plain-links (point-max))
3708 (add-text-properties (match-beginning 0) (match-end 0)
3709 '(face org-link))))
3710 (unless (eq org-agenda-remove-tags t)
3711 (org-agenda-align-tags))
3712 (unless org-agenda-with-colors
3713 (remove-text-properties (point-min) (point-max) '(face nil)))
3714 (if (and (boundp 'org-agenda-overriding-columns-format)
3715 org-agenda-overriding-columns-format)
3716 (org-set-local 'org-agenda-overriding-columns-format
3717 org-agenda-overriding-columns-format))
3718 (if (and (boundp 'org-agenda-view-columns-initially)
3719 org-agenda-view-columns-initially)
3720 (org-agenda-columns))
3721 (when org-agenda-fontify-priorities
3722 (org-agenda-fontify-priorities))
3723 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3724 (org-agenda-dim-blocked-tasks))
3725 (org-agenda-mark-clocking-task)
3726 (when org-agenda-entry-text-mode
3727 (org-agenda-entry-text-hide)
3728 (org-agenda-entry-text-show))
3729 (if (and (functionp 'org-habit-insert-consistency-graphs)
3730 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3731 (org-habit-insert-consistency-graphs))
3732 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3733 (unless (or (eq org-agenda-show-inherited-tags 'always)
3734 (and (listp org-agenda-show-inherited-tags)
3735 (memq org-agenda-type org-agenda-show-inherited-tags))
3736 (and (eq org-agenda-show-inherited-tags t)
3737 (or (eq org-agenda-use-tag-inheritance t)
3738 (and (listp org-agenda-use-tag-inheritance)
3739 (not (memq org-agenda-type
3740 org-agenda-use-tag-inheritance))))))
3741 (let (mrk)
3742 (save-excursion
3743 (goto-char (point-min))
3744 (while (equal (forward-line) 0)
3745 (when (setq mrk (get-text-property (point) 'org-hd-marker))
3746 (put-text-property (point-at-bol) (point-at-eol)
3747 'tags (org-with-point-at mrk
3748 (delete-dups
3749 (mapcar 'downcase (org-get-tags-at))))))))))
3750 (run-hooks 'org-agenda-finalize-hook)
3751 (when org-agenda-top-headline-filter
3752 (org-agenda-filter-top-headline-apply
3753 org-agenda-top-headline-filter))
3754 (when org-agenda-tag-filter
3755 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3756 (when (get 'org-agenda-tag-filter :preset-filter)
3757 (org-agenda-filter-apply
3758 (get 'org-agenda-tag-filter :preset-filter) 'tag))
3759 (when org-agenda-category-filter
3760 (org-agenda-filter-apply org-agenda-category-filter 'category))
3761 (when (get 'org-agenda-category-filter :preset-filter)
3762 (org-agenda-filter-apply
3763 (get 'org-agenda-category-filter :preset-filter) 'category))
3764 (when org-agenda-regexp-filter
3765 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3766 (when (get 'org-agenda-regexp-filter :preset-filter)
3767 (org-agenda-filter-apply
3768 (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
3769 (when org-agenda-effort-filter
3770 (org-agenda-filter-apply org-agenda-effort-filter 'effort))
3771 (when (get 'org-agenda-effort-filter :preset-filter)
3772 (org-agenda-filter-apply
3773 (get 'org-agenda-effort-filter :preset-filter) 'effort))
3774 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3776 (defun org-agenda-mark-clocking-task ()
3777 "Mark the current clock entry in the agenda if it is present."
3778 ;; We need to widen when `org-agenda-finalize' is called from
3779 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3780 (when org-clock-current-task
3781 (save-restriction
3782 (widen)
3783 (org-agenda-unmark-clocking-task)
3784 (when (marker-buffer org-clock-hd-marker)
3785 (save-excursion
3786 (goto-char (point-min))
3787 (let (s ov)
3788 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3789 (goto-char s)
3790 (when (equal (org-get-at-bol 'org-hd-marker)
3791 org-clock-hd-marker)
3792 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3793 (overlay-put ov 'type 'org-agenda-clocking)
3794 (overlay-put ov 'face 'org-agenda-clocking)
3795 (overlay-put ov 'help-echo
3796 "The clock is running in this item")))))))))
3798 (defun org-agenda-unmark-clocking-task ()
3799 "Unmark the current clocking task."
3800 (mapc (lambda (o)
3801 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3802 (delete-overlay o)))
3803 (overlays-in (point-min) (point-max))))
3805 (defun org-agenda-fontify-priorities ()
3806 "Make highest priority lines bold, and lowest italic."
3807 (interactive)
3808 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3809 (delete-overlay o)))
3810 (overlays-in (point-min) (point-max)))
3811 (save-excursion
3812 (let (b e p ov h l)
3813 (goto-char (point-min))
3814 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3815 (setq h (or (get-char-property (point) 'org-highest-priority)
3816 org-highest-priority)
3817 l (or (get-char-property (point) 'org-lowest-priority)
3818 org-lowest-priority)
3819 p (string-to-char (match-string 1))
3820 b (match-beginning 0)
3821 e (if (eq org-agenda-fontify-priorities 'cookies)
3822 (match-end 0)
3823 (point-at-eol))
3824 ov (make-overlay b e))
3825 (overlay-put
3826 ov 'face
3827 (cons (cond ((org-face-from-face-or-color
3828 'priority nil
3829 (cdr (assoc p org-priority-faces))))
3830 ((and (listp org-agenda-fontify-priorities)
3831 (org-face-from-face-or-color
3832 'priority nil
3833 (cdr (assoc p org-agenda-fontify-priorities)))))
3834 ((equal p l) 'italic)
3835 ((equal p h) 'bold))
3836 'org-priority))
3837 (overlay-put ov 'org-type 'org-priority)))))
3839 (defvar org-depend-tag-blocked)
3841 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3842 "Dim currently blocked TODO's in the agenda display.
3843 When INVISIBLE is non-nil, hide currently blocked TODO instead of
3844 dimming them."
3845 (interactive "P")
3846 (when (org-called-interactively-p 'interactive)
3847 (message "Dim or hide blocked tasks..."))
3848 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3849 (delete-overlay o)))
3850 (overlays-in (point-min) (point-max)))
3851 (save-excursion
3852 (let ((inhibit-read-only t)
3853 (org-depend-tag-blocked nil)
3854 (invis (or (not (null invisible))
3855 (eq org-agenda-dim-blocked-tasks 'invisible)))
3856 org-blocked-by-checkboxes
3857 invis1 b e p ov h l)
3858 (goto-char (point-min))
3859 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3860 (and pos (goto-char (1+ pos))))
3861 (setq org-blocked-by-checkboxes nil invis1 invis)
3862 (let ((marker (org-get-at-bol 'org-hd-marker)))
3863 (when (and marker
3864 (with-current-buffer (marker-buffer marker)
3865 (save-excursion (goto-char marker)
3866 (org-entry-blocked-p))))
3867 (if org-blocked-by-checkboxes (setq invis1 nil))
3868 (setq b (if invis1
3869 (max (point-min) (1- (point-at-bol)))
3870 (point-at-bol))
3871 e (point-at-eol)
3872 ov (make-overlay b e))
3873 (if invis1
3874 (progn (overlay-put ov 'invisible t)
3875 (overlay-put ov 'intangible t))
3876 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3877 (overlay-put ov 'org-type 'org-blocked-todo))))))
3878 (when (org-called-interactively-p 'interactive)
3879 (message "Dim or hide blocked tasks...done")))
3881 (defvar org-agenda-skip-function nil
3882 "Function to be called at each match during agenda construction.
3883 If this function returns nil, the current match should not be skipped.
3884 Otherwise, the function must return a position from where the search
3885 should be continued.
3886 This may also be a Lisp form, it will be evaluated.
3887 Never set this variable using `setq' or so, because then it will apply
3888 to all future agenda commands. If you do want a global skipping condition,
3889 use the option `org-agenda-skip-function-global' instead.
3890 The correct usage for `org-agenda-skip-function' is to bind it with
3891 `let' to scope it dynamically into the agenda-constructing command.
3892 A good way to set it is through options in `org-agenda-custom-commands'.")
3894 (defun org-agenda-skip ()
3895 "Throw to `:skip' in places that should be skipped.
3896 Also moves point to the end of the skipped region, so that search can
3897 continue from there."
3898 (let ((p (point-at-bol)) to)
3899 (when (or
3900 (save-excursion (goto-char p) (looking-at comment-start-skip))
3901 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3902 (get-text-property p :org-archived)
3903 (org-end-of-subtree t))
3904 (and org-agenda-skip-comment-trees
3905 (get-text-property p :org-comment)
3906 (org-end-of-subtree t))
3907 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3908 (org-agenda-skip-eval org-agenda-skip-function)))
3909 (goto-char to))
3910 (org-in-src-block-p t))
3911 (throw :skip t))))
3913 (defun org-agenda-skip-eval (form)
3914 "If FORM is a function or a list, call (or eval) it and return the result.
3915 `save-excursion' and `save-match-data' are wrapped around the call, so point
3916 and match data are returned to the previous state no matter what these
3917 functions do."
3918 (let (fp)
3919 (and form
3920 (or (setq fp (functionp form))
3921 (consp form))
3922 (save-excursion
3923 (save-match-data
3924 (if fp
3925 (funcall form)
3926 (eval form)))))))
3928 (defvar org-agenda-markers nil
3929 "List of all currently active markers created by `org-agenda'.")
3930 (defvar org-agenda-last-marker-time (org-float-time)
3931 "Creation time of the last agenda marker.")
3933 (defun org-agenda-new-marker (&optional pos)
3934 "Return a new agenda marker.
3935 Org-mode keeps a list of these markers and resets them when they are
3936 no longer in use."
3937 (let ((m (copy-marker (or pos (point)))))
3938 (setq org-agenda-last-marker-time (org-float-time))
3939 (if org-agenda-buffer
3940 (with-current-buffer org-agenda-buffer
3941 (push m org-agenda-markers))
3942 (push m org-agenda-markers))
3945 (defun org-agenda-reset-markers ()
3946 "Reset markers created by `org-agenda'."
3947 (while org-agenda-markers
3948 (move-marker (pop org-agenda-markers) nil)))
3950 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3951 "Save relative positions of markers in region.
3952 This check for agenda markers in all agenda buffers currently active."
3953 (dolist (buf (buffer-list))
3954 (with-current-buffer buf
3955 (when (eq major-mode 'org-agenda-mode)
3956 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3957 org-agenda-markers)))))
3959 ;;; Entry text mode
3961 (defun org-agenda-entry-text-show-here ()
3962 "Add some text from the entry as context to the current line."
3963 (let (m txt o)
3964 (setq m (org-get-at-bol 'org-hd-marker))
3965 (unless (marker-buffer m)
3966 (error "No marker points to an entry here"))
3967 (setq txt (concat "\n" (org-no-properties
3968 (org-agenda-get-some-entry-text
3969 m org-agenda-entry-text-maxlines
3970 org-agenda-entry-text-leaders))))
3971 (when (string-match "\\S-" txt)
3972 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3973 (overlay-put o 'evaporate t)
3974 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3975 (overlay-put o 'after-string txt))))
3977 (defun org-agenda-entry-text-show ()
3978 "Add entry context for all agenda lines."
3979 (interactive)
3980 (save-excursion
3981 (goto-char (point-max))
3982 (beginning-of-line 1)
3983 (while (not (bobp))
3984 (when (org-get-at-bol 'org-hd-marker)
3985 (org-agenda-entry-text-show-here))
3986 (beginning-of-line 0))))
3988 (defun org-agenda-entry-text-hide ()
3989 "Remove any shown entry context."
3990 (delq nil
3991 (mapcar (lambda (o)
3992 (if (eq (overlay-get o 'org-overlay-type)
3993 'agenda-entry-content)
3994 (progn (delete-overlay o) t)))
3995 (overlays-in (point-min) (point-max)))))
3997 (defun org-agenda-get-day-face (date)
3998 "Return the face DATE should be displayed with."
3999 (or (and (functionp org-agenda-day-face-function)
4000 (funcall org-agenda-day-face-function date))
4001 (cond ((org-agenda-todayp date)
4002 'org-agenda-date-today)
4003 ((member (calendar-day-of-week date) org-agenda-weekend-days)
4004 'org-agenda-date-weekend)
4005 (t 'org-agenda-date))))
4007 ;;; Agenda timeline
4009 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
4010 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
4012 (defun org-timeline (&optional dotodo)
4013 "Show a time-sorted view of the entries in the current org file.
4014 Only entries with a time stamp of today or later will be listed. With
4015 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
4016 under the current date.
4017 If the buffer contains an active region, only check the region for
4018 dates."
4019 (interactive "P")
4020 (let* ((dopast t)
4021 (org-agenda-show-log-scoped org-agenda-show-log)
4022 (org-agenda-show-log org-agenda-show-log-scoped)
4023 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
4024 (current-buffer))))
4025 (date (calendar-current-date))
4026 (beg (if (org-region-active-p) (region-beginning) (point-min)))
4027 (end (if (org-region-active-p) (region-end) (point-max)))
4028 (day-numbers (org-get-all-dates
4029 beg end 'no-ranges
4030 t org-agenda-show-log-scoped ; always include today
4031 org-timeline-show-empty-dates))
4032 (org-deadline-warning-days 0)
4033 (org-agenda-only-exact-dates t)
4034 (today (org-today))
4035 (past t)
4036 args
4037 s e rtn d emptyp)
4038 (setq org-agenda-redo-command
4039 (list 'let
4040 (list (list 'org-agenda-show-log 'org-agenda-show-log))
4041 (list 'org-switch-to-buffer-other-window (current-buffer))
4042 (list 'org-timeline (list 'quote dotodo))))
4043 (put 'org-agenda-redo-command 'org-lprops nil)
4044 (if (not dopast)
4045 ;; Remove past dates from the list of dates.
4046 (setq day-numbers (delq nil (mapcar (lambda(x)
4047 (if (>= x today) x nil))
4048 day-numbers))))
4049 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
4050 (org-compile-prefix-format 'timeline)
4051 (org-set-sorting-strategy 'timeline)
4052 (if org-agenda-show-log-scoped (push :closed args))
4053 (push :timestamp args)
4054 (push :deadline args)
4055 (push :scheduled args)
4056 (push :sexp args)
4057 (if dotodo (push :todo args))
4058 (insert "Timeline of file " entry "\n")
4059 (add-text-properties (point-min) (point)
4060 (list 'face 'org-agenda-structure))
4061 (org-agenda-mark-header-line (point-min))
4062 (while (setq d (pop day-numbers))
4063 (if (and (listp d) (eq (car d) :omitted))
4064 (progn
4065 (setq s (point))
4066 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4067 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4068 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4069 (if (and (>= d today)
4070 dopast
4071 past)
4072 (progn
4073 (setq past nil)
4074 (insert (make-string 79 ?-) "\n")))
4075 (setq date (calendar-gregorian-from-absolute d))
4076 (setq s (point))
4077 (setq rtn (and (not emptyp)
4078 (apply 'org-agenda-get-day-entries entry
4079 date args)))
4080 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4081 (progn
4082 (insert
4083 (if (stringp org-agenda-format-date)
4084 (format-time-string org-agenda-format-date
4085 (org-time-from-absolute date))
4086 (funcall org-agenda-format-date date))
4087 "\n")
4088 (put-text-property s (1- (point)) 'face
4089 (org-agenda-get-day-face date))
4090 (put-text-property s (1- (point)) 'org-date-line t)
4091 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4092 (if (equal d today)
4093 (put-text-property s (1- (point)) 'org-today t))
4094 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4095 (put-text-property s (1- (point)) 'day d)))))
4096 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4097 (point-min)))
4098 (add-text-properties
4099 (point-min) (point-max)
4100 `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
4101 (org-agenda-finalize)
4102 (setq buffer-read-only t)))
4104 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4105 "Return a list of all relevant day numbers from BEG to END buffer positions.
4106 If NO-RANGES is non-nil, include only the start and end dates of a range,
4107 not every single day in the range. If FORCE-TODAY is non-nil, make
4108 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4109 inactive time stamps (those in square brackets) are included.
4110 When EMPTY is non-nil, also include days without any entries."
4111 (let ((re (concat
4112 (if pre-re pre-re "")
4113 (if inactive org-ts-regexp-both org-ts-regexp)))
4114 dates dates1 date day day1 day2 ts1 ts2 pos)
4115 (if force-today
4116 (setq dates (list (org-today))))
4117 (save-excursion
4118 (goto-char beg)
4119 (while (re-search-forward re end t)
4120 (setq day (time-to-days (org-time-string-to-time
4121 (substring (match-string 1) 0 10)
4122 (current-buffer) (match-beginning 0))))
4123 (or (memq day dates) (push day dates)))
4124 (unless no-ranges
4125 (goto-char beg)
4126 (while (re-search-forward org-tr-regexp end t)
4127 (setq pos (match-beginning 0))
4128 (setq ts1 (substring (match-string 1) 0 10)
4129 ts2 (substring (match-string 2) 0 10)
4130 day1 (time-to-days (org-time-string-to-time
4131 ts1 (current-buffer) pos))
4132 day2 (time-to-days (org-time-string-to-time
4133 ts2 (current-buffer) pos)))
4134 (while (< (setq day1 (1+ day1)) day2)
4135 (or (memq day1 dates) (push day1 dates)))))
4136 (setq dates (sort dates '<))
4137 (when empty
4138 (while (setq day (pop dates))
4139 (setq day2 (car dates))
4140 (push day dates1)
4141 (when (and day2 empty)
4142 (if (or (eq empty t)
4143 (and (numberp empty) (<= (- day2 day) empty)))
4144 (while (< (setq day (1+ day)) day2)
4145 (push (list day) dates1))
4146 (push (cons :omitted (- day2 day)) dates1))))
4147 (setq dates (nreverse dates1)))
4148 dates)))
4150 ;;; Agenda Daily/Weekly
4152 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4153 "Start day for the agenda view.
4154 Custom commands can set this variable in the options section.
4155 This is usually a string like \"2007-11-01\", \"+2d\" or any other
4156 input allowed when reading a date through the Org calendar.
4157 See the docstring of `org-read-date' for details.")
4158 (defvar org-starting-day nil) ; local variable in the agenda buffer
4159 (defvar org-arg-loc nil) ; local variable
4161 (defvar org-agenda-buffer-tmp-name nil)
4162 ;;;###autoload
4163 (defun org-agenda-list (&optional arg start-day span with-hour)
4164 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4165 The view will be for the current day or week, but from the overview buffer
4166 you will be able to go to other days/weeks.
4168 With a numeric prefix argument in an interactive call, the agenda will
4169 span ARG days. Lisp programs should instead specify SPAN to change
4170 the number of days. SPAN defaults to `org-agenda-span'.
4172 START-DAY defaults to TODAY, or to the most recent match for the weekday
4173 given in `org-agenda-start-on-weekday'.
4175 When WITH-HOUR is non-nil, only include scheduled and deadline
4176 items if they have an hour specification like [h]h:mm."
4177 (interactive "P")
4178 (if org-agenda-overriding-arguments
4179 (setq arg (car org-agenda-overriding-arguments)
4180 start-day (nth 1 org-agenda-overriding-arguments)
4181 span (nth 2 org-agenda-overriding-arguments)))
4182 (if (and (integerp arg) (> arg 0))
4183 (setq span arg arg nil))
4184 (catch 'exit
4185 (setq org-agenda-buffer-name
4186 (or org-agenda-buffer-tmp-name
4187 (if org-agenda-sticky
4188 (cond ((and org-keys (stringp org-match))
4189 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4190 (org-keys
4191 (format "*Org Agenda(%s)*" org-keys))
4192 (t "*Org Agenda(a)*")))
4193 org-agenda-buffer-name))
4194 (org-agenda-prepare "Day/Week")
4195 (setq start-day (or start-day org-agenda-start-day))
4196 (if (stringp start-day)
4197 ;; Convert to an absolute day number
4198 (setq start-day (time-to-days (org-read-date nil t start-day))))
4199 (org-compile-prefix-format 'agenda)
4200 (org-set-sorting-strategy 'agenda)
4201 (let* ((span (org-agenda-ndays-to-span
4202 (or span org-agenda-ndays org-agenda-span)))
4203 (today (org-today))
4204 (sd (or start-day today))
4205 (ndays (org-agenda-span-to-ndays span sd))
4206 (org-agenda-start-on-weekday
4207 (if (or (eq ndays 7) (eq ndays 14))
4208 org-agenda-start-on-weekday))
4209 (thefiles (org-agenda-files nil 'ifmode))
4210 (files thefiles)
4211 (start (if (or (null org-agenda-start-on-weekday)
4212 (< ndays 7))
4214 (let* ((nt (calendar-day-of-week
4215 (calendar-gregorian-from-absolute sd)))
4216 (n1 org-agenda-start-on-weekday)
4217 (d (- nt n1)))
4218 (- sd (+ (if (< d 0) 7 0) d)))))
4219 (day-numbers (list start))
4220 (day-cnt 0)
4221 (inhibit-redisplay (not debug-on-error))
4222 (org-agenda-show-log-scoped org-agenda-show-log)
4223 s e rtn rtnall file date d start-pos end-pos todayp
4224 clocktable-start clocktable-end filter)
4225 (setq org-agenda-redo-command
4226 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4227 (dotimes (n (1- ndays))
4228 (push (1+ (car day-numbers)) day-numbers))
4229 (setq day-numbers (nreverse day-numbers))
4230 (setq clocktable-start (car day-numbers)
4231 clocktable-end (1+ (or (org-last day-numbers) 0)))
4232 (org-set-local 'org-starting-day (car day-numbers))
4233 (org-set-local 'org-arg-loc arg)
4234 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
4235 (unless org-agenda-compact-blocks
4236 (let* ((d1 (car day-numbers))
4237 (d2 (org-last day-numbers))
4238 (w1 (org-days-to-iso-week d1))
4239 (w2 (org-days-to-iso-week d2)))
4240 (setq s (point))
4241 (if org-agenda-overriding-header
4242 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4243 nil 'face 'org-agenda-structure) "\n")
4244 (insert (org-agenda-span-name span)
4245 "-agenda"
4246 (if (< (- d2 d1) 350)
4247 (if (= w1 w2)
4248 (format " (W%02d)" w1)
4249 (format " (W%02d-W%02d)" w1 w2))
4251 ":\n")))
4252 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4253 'org-date-line t))
4254 (org-agenda-mark-header-line s))
4255 (while (setq d (pop day-numbers))
4256 (setq date (calendar-gregorian-from-absolute d)
4257 s (point))
4258 (if (or (setq todayp (= d today))
4259 (and (not start-pos) (= d sd)))
4260 (setq start-pos (point))
4261 (if (and start-pos (not end-pos))
4262 (setq end-pos (point))))
4263 (setq files thefiles
4264 rtnall nil)
4265 (while (setq file (pop files))
4266 (catch 'nextfile
4267 (org-check-agenda-file file)
4268 (let ((org-agenda-entry-types org-agenda-entry-types))
4269 ;; Starred types override non-starred equivalents
4270 (when (member :deadline* org-agenda-entry-types)
4271 (setq org-agenda-entry-types
4272 (delq :deadline org-agenda-entry-types)))
4273 (when (member :scheduled* org-agenda-entry-types)
4274 (setq org-agenda-entry-types
4275 (delq :scheduled org-agenda-entry-types)))
4276 ;; Honor with-hour
4277 (when with-hour
4278 (when (member :deadline org-agenda-entry-types)
4279 (setq org-agenda-entry-types
4280 (delq :deadline org-agenda-entry-types))
4281 (push :deadline* org-agenda-entry-types))
4282 (when (member :scheduled org-agenda-entry-types)
4283 (setq org-agenda-entry-types
4284 (delq :scheduled org-agenda-entry-types))
4285 (push :scheduled* org-agenda-entry-types)))
4286 (unless org-agenda-include-deadlines
4287 (setq org-agenda-entry-types
4288 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4289 (cond
4290 ((memq org-agenda-show-log-scoped '(only clockcheck))
4291 (setq rtn (org-agenda-get-day-entries
4292 file date :closed)))
4293 (org-agenda-show-log-scoped
4294 (setq rtn (apply 'org-agenda-get-day-entries
4295 file date
4296 (append '(:closed) org-agenda-entry-types))))
4298 (setq rtn (apply 'org-agenda-get-day-entries
4299 file date
4300 org-agenda-entry-types)))))
4301 (setq rtnall (append rtnall rtn)))) ;; all entries
4302 (if org-agenda-include-diary
4303 (let ((org-agenda-search-headline-for-time t))
4304 (require 'diary-lib)
4305 (setq rtn (org-get-entries-from-diary date))
4306 (setq rtnall (append rtnall rtn))))
4307 (if (or rtnall org-agenda-show-all-dates)
4308 (progn
4309 (setq day-cnt (1+ day-cnt))
4310 (insert
4311 (if (stringp org-agenda-format-date)
4312 (format-time-string org-agenda-format-date
4313 (org-time-from-absolute date))
4314 (funcall org-agenda-format-date date))
4315 "\n")
4316 (put-text-property s (1- (point)) 'face
4317 (org-agenda-get-day-face date))
4318 (put-text-property s (1- (point)) 'org-date-line t)
4319 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4320 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4321 (when todayp
4322 (put-text-property s (1- (point)) 'org-today t))
4323 (setq rtnall
4324 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4325 (if rtnall (insert ;; all entries
4326 (org-agenda-finalize-entries rtnall 'agenda)
4327 "\n"))
4328 (put-text-property s (1- (point)) 'day d)
4329 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4330 (when (and org-agenda-clockreport-mode clocktable-start)
4331 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4332 ;; the above line is to ensure the restricted range!
4333 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4334 tbl)
4335 (setq p (org-plist-delete p :block))
4336 (setq p (plist-put p :tstart clocktable-start))
4337 (setq p (plist-put p :tend clocktable-end))
4338 (setq p (plist-put p :scope 'agenda))
4339 (setq tbl (apply 'org-clock-get-clocktable p))
4340 (insert tbl)))
4341 (goto-char (point-min))
4342 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4343 (unless (and (pos-visible-in-window-p (point-min))
4344 (pos-visible-in-window-p (point-max)))
4345 (goto-char (1- (point-max)))
4346 (recenter -1)
4347 (if (not (pos-visible-in-window-p (or start-pos 1)))
4348 (progn
4349 (goto-char (or start-pos 1))
4350 (recenter 1))))
4351 (goto-char (or start-pos 1))
4352 (add-text-properties (point-min) (point-max)
4353 `(org-agenda-type agenda
4354 org-last-args (,arg ,start-day ,span)
4355 org-redo-cmd ,org-agenda-redo-command
4356 org-series-cmd ,org-cmd))
4357 (if (eq org-agenda-show-log-scoped 'clockcheck)
4358 (org-agenda-show-clocking-issues))
4359 (org-agenda-finalize)
4360 (setq buffer-read-only t)
4361 (message ""))))
4363 (defun org-agenda-ndays-to-span (n)
4364 "Return a span symbol for a span of N days, or N if none matches."
4365 (cond ((symbolp n) n)
4366 ((= n 1) 'day)
4367 ((= n 7) 'week)
4368 ((= n 14) 'fortnight)
4369 (t n)))
4371 (defun org-agenda-span-to-ndays (span &optional start-day)
4372 "Return ndays from SPAN, possibly starting at START-DAY.
4373 START-DAY is an absolute time value."
4374 (cond ((numberp span) span)
4375 ((eq span 'day) 1)
4376 ((eq span 'week) 7)
4377 ((eq span 'fortnight) 14)
4378 ((eq span 'month)
4379 (let ((date (calendar-gregorian-from-absolute start-day)))
4380 (calendar-last-day-of-month (car date) (caddr date))))
4381 ((eq span 'year)
4382 (let ((date (calendar-gregorian-from-absolute start-day)))
4383 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4385 (defun org-agenda-span-name (span)
4386 "Return a SPAN name."
4387 (if (null span)
4389 (if (symbolp span)
4390 (capitalize (symbol-name span))
4391 (format "%d days" span))))
4393 ;;; Agenda word search
4395 (defvar org-agenda-search-history nil)
4397 (defvar org-search-syntax-table nil
4398 "Special syntax table for org-mode search.
4399 In this table, we have single quotes not as word constituents, to
4400 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4402 (defvar org-mode-syntax-table) ; From org.el
4403 (defun org-search-syntax-table ()
4404 (unless org-search-syntax-table
4405 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4406 (modify-syntax-entry ?' "." org-search-syntax-table)
4407 (modify-syntax-entry ?` "." org-search-syntax-table))
4408 org-search-syntax-table)
4410 (defvar org-agenda-last-search-view-search-was-boolean nil)
4412 ;;;###autoload
4413 (defun org-search-view (&optional todo-only string edit-at)
4414 "Show all entries that contain a phrase or words or regular expressions.
4416 With optional prefix argument TODO-ONLY, only consider entries that are
4417 TODO entries. The argument STRING can be used to pass a default search
4418 string into this function. If EDIT-AT is non-nil, it means that the
4419 user should get a chance to edit this string, with cursor at position
4420 EDIT-AT.
4422 The search string can be viewed either as a phrase that should be found as
4423 is, or it can be broken into a number of snippets, each of which must match
4424 in a Boolean way to select an entry. The default depends on the variable
4425 `org-agenda-search-view-always-boolean'.
4426 Even if this is turned off (the default) you can always switch to
4427 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4429 The default is a direct search of the whole phrase, where each space in
4430 the search string can expand to an arbitrary amount of whitespace,
4431 including newlines.
4433 If using a Boolean search, the search string is split on whitespace and
4434 each snippet is searched separately, with logical AND to select an entry.
4435 Words prefixed with a minus must *not* occur in the entry. Words without
4436 a prefix or prefixed with a plus must occur in the entry. Matching is
4437 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4438 match whole words, not parts of a word) if
4439 `org-agenda-search-view-force-full-words' is set (default is nil).
4441 Boolean search snippets enclosed by curly braces are interpreted as
4442 regular expressions that must or (when preceded with \"-\") must not
4443 match in the entry. Snippets enclosed into double quotes will be taken
4444 as a whole, to include whitespace.
4446 - If the search string starts with an asterisk, search only in headlines.
4447 - If (possibly after the leading star) the search string starts with an
4448 exclamation mark, this also means to look at TODO entries only, an effect
4449 that can also be achieved with a prefix argument.
4450 - If (possibly after star and exclamation mark) the search string starts
4451 with a colon, this will mean that the (non-regexp) snippets of the
4452 Boolean search must match as full words.
4454 This command searches the agenda files, and in addition the files listed
4455 in `org-agenda-text-search-extra-files'."
4456 (interactive "P")
4457 (if org-agenda-overriding-arguments
4458 (setq todo-only (car org-agenda-overriding-arguments)
4459 string (nth 1 org-agenda-overriding-arguments)
4460 edit-at (nth 2 org-agenda-overriding-arguments)))
4461 (let* ((props (list 'face nil
4462 'done-face 'org-agenda-done
4463 'org-not-done-regexp org-not-done-regexp
4464 'org-todo-regexp org-todo-regexp
4465 'org-complex-heading-regexp org-complex-heading-regexp
4466 'mouse-face 'highlight
4467 'help-echo (format "mouse-2 or RET jump to location")))
4468 (full-words org-agenda-search-view-force-full-words)
4469 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4470 regexp rtn rtnall files file pos inherited-tags
4471 marker category level tags c neg re boolean
4472 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4473 (unless (and (not edit-at)
4474 (stringp string)
4475 (string-match "\\S-" string))
4476 (setq string (read-string
4477 (if org-agenda-search-view-always-boolean
4478 "[+-]Word/{Regexp} ...: "
4479 "Phrase or [+-]Word/{Regexp} ...: ")
4480 (cond
4481 ((integerp edit-at) (cons string edit-at))
4482 (edit-at string))
4483 'org-agenda-search-history)))
4484 (catch 'exit
4485 (if org-agenda-sticky
4486 (setq org-agenda-buffer-name
4487 (if (stringp string)
4488 (format "*Org Agenda(%s:%s)*"
4489 (or org-keys (or (and todo-only "S") "s")) string)
4490 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4491 (org-agenda-prepare "SEARCH")
4492 (org-compile-prefix-format 'search)
4493 (org-set-sorting-strategy 'search)
4494 (setq org-agenda-redo-command
4495 (list 'org-search-view (if todo-only t nil)
4496 (list 'if 'current-prefix-arg nil string)))
4497 (setq org-agenda-query-string string)
4498 (if (equal (string-to-char string) ?*)
4499 (setq hdl-only t
4500 words (substring string 1))
4501 (setq words string))
4502 (when (equal (string-to-char words) ?!)
4503 (setq todo-only t
4504 words (substring words 1)))
4505 (when (equal (string-to-char words) ?:)
4506 (setq full-words t
4507 words (substring words 1)))
4508 (if (or org-agenda-search-view-always-boolean
4509 (member (string-to-char words) '(?- ?+ ?\{)))
4510 (setq boolean t))
4511 (setq words (org-split-string words))
4512 (let (www w)
4513 (while (setq w (pop words))
4514 (while (and (string-match "\\\\\\'" w) words)
4515 (setq w (concat (substring w 0 -1) " " (pop words))))
4516 (push w www))
4517 (setq words (nreverse www) www nil)
4518 (while (setq w (pop words))
4519 (when (and (string-match "\\`[-+]?{" w)
4520 (not (string-match "}\\'" w)))
4521 (while (and words (not (string-match "}\\'" (car words))))
4522 (setq w (concat w " " (pop words))))
4523 (setq w (concat w " " (pop words))))
4524 (push w www))
4525 (setq words (nreverse www)))
4526 (setq org-agenda-last-search-view-search-was-boolean boolean)
4527 (when boolean
4528 (let (wds w)
4529 (while (setq w (pop words))
4530 (if (or (equal (substring w 0 1) "\"")
4531 (and (> (length w) 1)
4532 (member (substring w 0 1) '("+" "-"))
4533 (equal (substring w 1 2) "\"")))
4534 (while (and words (not (equal (substring w -1) "\"")))
4535 (setq w (concat w " " (pop words)))))
4536 (and (string-match "\\`\\([-+]?\\)\"" w)
4537 (setq w (replace-match "\\1" nil nil w)))
4538 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4539 (push w wds))
4540 (setq words (nreverse wds))))
4541 (if boolean
4542 (mapc (lambda (w)
4543 (setq c (string-to-char w))
4544 (if (equal c ?-)
4545 (setq neg t w (substring w 1))
4546 (if (equal c ?+)
4547 (setq neg nil w (substring w 1))
4548 (setq neg nil)))
4549 (if (string-match "\\`{.*}\\'" w)
4550 (setq re (substring w 1 -1))
4551 (if full-words
4552 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4553 (setq re (regexp-quote (downcase w)))))
4554 (if neg (push re regexps-) (push re regexps+)))
4555 words)
4556 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4557 regexps+))
4558 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4559 (if (not regexps+)
4560 (setq regexp org-outline-regexp-bol)
4561 (setq regexp (pop regexps+))
4562 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4563 regexp))))
4564 (setq files (org-agenda-files nil 'ifmode))
4565 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4566 (pop org-agenda-text-search-extra-files)
4567 (setq files (org-add-archive-files files)))
4568 (setq files (append files org-agenda-text-search-extra-files)
4569 rtnall nil)
4570 (while (setq file (pop files))
4571 (setq ee nil)
4572 (catch 'nextfile
4573 (org-check-agenda-file file)
4574 (setq buffer (if (file-exists-p file)
4575 (org-get-agenda-file-buffer file)
4576 (error "No such file %s" file)))
4577 (if (not buffer)
4578 ;; If file does not exist, make sure an error message is sent
4579 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4580 file))))
4581 (with-current-buffer buffer
4582 (with-syntax-table (org-search-syntax-table)
4583 (unless (derived-mode-p 'org-mode)
4584 (error "Agenda file %s is not in `org-mode'" file))
4585 (let ((case-fold-search t))
4586 (save-excursion
4587 (save-restriction
4588 (if (eq buffer org-agenda-restrict)
4589 (narrow-to-region org-agenda-restrict-begin
4590 org-agenda-restrict-end)
4591 (widen))
4592 (goto-char (point-min))
4593 (unless (or (org-at-heading-p)
4594 (outline-next-heading))
4595 (throw 'nextfile t))
4596 (goto-char (max (point-min) (1- (point))))
4597 (while (re-search-forward regexp nil t)
4598 (org-back-to-heading t)
4599 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4600 (> (org-reduced-level (org-outline-level))
4601 org-agenda-search-view-max-outline-level)
4602 (forward-line -1)
4603 (outline-back-to-heading t)))
4604 (skip-chars-forward "* ")
4605 (setq beg (point-at-bol)
4606 beg1 (point)
4607 end (progn
4608 (outline-next-heading)
4609 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4610 (> (org-reduced-level (org-outline-level))
4611 org-agenda-search-view-max-outline-level)
4612 (forward-line 1)
4613 (outline-next-heading)))
4614 (point)))
4616 (catch :skip
4617 (goto-char beg)
4618 (org-agenda-skip)
4619 (setq str (buffer-substring-no-properties
4620 (point-at-bol)
4621 (if hdl-only (point-at-eol) end)))
4622 (mapc (lambda (wr) (when (string-match wr str)
4623 (goto-char (1- end))
4624 (throw :skip t)))
4625 regexps-)
4626 (mapc (lambda (wr) (unless (string-match wr str)
4627 (goto-char (1- end))
4628 (throw :skip t)))
4629 (if todo-only
4630 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4631 regexps+)
4632 regexps+))
4633 (goto-char beg)
4634 (setq marker (org-agenda-new-marker (point))
4635 category (org-get-category)
4636 level (make-string (org-reduced-level (org-outline-level)) ? )
4637 inherited-tags
4638 (or (eq org-agenda-show-inherited-tags 'always)
4639 (and (listp org-agenda-show-inherited-tags)
4640 (memq 'todo org-agenda-show-inherited-tags))
4641 (and (eq org-agenda-show-inherited-tags t)
4642 (or (eq org-agenda-use-tag-inheritance t)
4643 (memq 'todo org-agenda-use-tag-inheritance))))
4644 tags (org-get-tags-at nil (not inherited-tags))
4645 txt (org-agenda-format-item
4647 (buffer-substring-no-properties
4648 beg1 (point-at-eol))
4649 level category tags t))
4650 (org-add-props txt props
4651 'org-marker marker 'org-hd-marker marker
4652 'org-todo-regexp org-todo-regexp
4653 'level level
4654 'org-complex-heading-regexp org-complex-heading-regexp
4655 'priority 1000
4656 'type "search")
4657 (push txt ee)
4658 (goto-char (1- end))))))))))
4659 (setq rtn (nreverse ee))
4660 (setq rtnall (append rtnall rtn)))
4661 (if org-agenda-overriding-header
4662 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4663 nil 'face 'org-agenda-structure) "\n")
4664 (insert "Search words: ")
4665 (add-text-properties (point-min) (1- (point))
4666 (list 'face 'org-agenda-structure))
4667 (setq pos (point))
4668 (insert string "\n")
4669 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4670 (setq pos (point))
4671 (unless org-agenda-multi
4672 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4673 (add-text-properties pos (1- (point))
4674 (list 'face 'org-agenda-structure))))
4675 (org-agenda-mark-header-line (point-min))
4676 (when rtnall
4677 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4678 (goto-char (point-min))
4679 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4680 (add-text-properties (point-min) (point-max)
4681 `(org-agenda-type search
4682 org-last-args (,todo-only ,string ,edit-at)
4683 org-redo-cmd ,org-agenda-redo-command
4684 org-series-cmd ,org-cmd))
4685 (org-agenda-finalize)
4686 (setq buffer-read-only t))))
4688 ;;; Agenda TODO list
4690 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4691 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4692 (concat
4693 (if (or (equal keywords "ALL") (not keywords))
4694 (propertize "ALL" 'face 'warning)
4695 (mapconcat
4696 (lambda (kw)
4697 (propertize kw 'face (org-get-todo-face kw)))
4698 (org-split-string keywords "|")
4699 "|"))
4700 "\n"))
4702 (defvar org-select-this-todo-keyword nil)
4703 (defvar org-last-arg nil)
4705 ;;;###autoload
4706 (defun org-todo-list (&optional arg)
4707 "Show all (not done) TODO entries from all agenda file in a single list.
4708 The prefix arg can be used to select a specific TODO keyword and limit
4709 the list to these. When using \\[universal-argument], you will be prompted
4710 for a keyword. A numeric prefix directly selects the Nth keyword in
4711 `org-todo-keywords-1'."
4712 (interactive "P")
4713 (if org-agenda-overriding-arguments
4714 (setq arg org-agenda-overriding-arguments))
4715 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4716 (let* ((today (org-today))
4717 (date (calendar-gregorian-from-absolute today))
4718 (kwds org-todo-keywords-for-agenda)
4719 (completion-ignore-case t)
4720 (org-select-this-todo-keyword
4721 (if (stringp arg) arg
4722 (and arg (integerp arg) (> arg 0)
4723 (nth (1- arg) kwds))))
4724 rtn rtnall files file pos)
4725 (when (equal arg '(4))
4726 (setq org-select-this-todo-keyword
4727 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4728 (mapcar 'list kwds) nil nil)))
4729 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4730 (catch 'exit
4731 (if org-agenda-sticky
4732 (setq org-agenda-buffer-name
4733 (if (stringp org-select-this-todo-keyword)
4734 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4735 org-select-this-todo-keyword)
4736 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4737 (org-agenda-prepare "TODO")
4738 (org-compile-prefix-format 'todo)
4739 (org-set-sorting-strategy 'todo)
4740 (setq org-agenda-redo-command
4741 `(org-todo-list (or (and (numberp current-prefix-arg)
4742 current-prefix-arg)
4743 ,org-select-this-todo-keyword
4744 current-prefix-arg ,arg)))
4745 (setq files (org-agenda-files nil 'ifmode)
4746 rtnall nil)
4747 (while (setq file (pop files))
4748 (catch 'nextfile
4749 (org-check-agenda-file file)
4750 (setq rtn (org-agenda-get-day-entries file date :todo))
4751 (setq rtnall (append rtnall rtn))))
4752 (if org-agenda-overriding-header
4753 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4754 nil 'face 'org-agenda-structure) "\n")
4755 (insert "Global list of TODO items of type: ")
4756 (add-text-properties (point-min) (1- (point))
4757 (list 'face 'org-agenda-structure
4758 'short-heading
4759 (concat "ToDo: "
4760 (or org-select-this-todo-keyword "ALL"))))
4761 (org-agenda-mark-header-line (point-min))
4762 (insert (org-agenda-propertize-selected-todo-keywords
4763 org-select-this-todo-keyword))
4764 (setq pos (point))
4765 (unless org-agenda-multi
4766 (insert "Available with `N r': (0)[ALL]")
4767 (let ((n 0) s)
4768 (mapc (lambda (x)
4769 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4770 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4771 (insert "\n "))
4772 (insert " " s))
4773 kwds))
4774 (insert "\n"))
4775 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4776 (org-agenda-mark-header-line (point-min))
4777 (when rtnall
4778 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4779 (goto-char (point-min))
4780 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4781 (add-text-properties (point-min) (point-max)
4782 `(org-agenda-type todo
4783 org-last-args ,arg
4784 org-redo-cmd ,org-agenda-redo-command
4785 org-series-cmd ,org-cmd))
4786 (org-agenda-finalize)
4787 (setq buffer-read-only t))))
4789 ;;; Agenda tags match
4791 ;;;###autoload
4792 (defun org-tags-view (&optional todo-only match)
4793 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4794 The prefix arg TODO-ONLY limits the search to TODO entries."
4795 (interactive "P")
4796 (if org-agenda-overriding-arguments
4797 (setq todo-only (car org-agenda-overriding-arguments)
4798 match (nth 1 org-agenda-overriding-arguments)))
4799 (let* ((org-tags-match-list-sublevels
4800 org-tags-match-list-sublevels)
4801 (completion-ignore-case t)
4802 rtn rtnall files file pos matcher
4803 buffer)
4804 (when (and (stringp match) (not (string-match "\\S-" match)))
4805 (setq match nil))
4806 (catch 'exit
4807 (if org-agenda-sticky
4808 (setq org-agenda-buffer-name
4809 (if (stringp match)
4810 (format "*Org Agenda(%s:%s)*"
4811 (or org-keys (or (and todo-only "M") "m")) match)
4812 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4813 ;; Prepare agendas (and `org-tag-alist-for-agenda') before
4814 ;; expanding tags within `org-make-tags-matcher'
4815 (org-agenda-prepare (concat "TAGS " match))
4816 (setq matcher (org-make-tags-matcher match)
4817 match (car matcher) matcher (cdr matcher))
4818 (org-compile-prefix-format 'tags)
4819 (org-set-sorting-strategy 'tags)
4820 (setq org-agenda-query-string match)
4821 (setq org-agenda-redo-command
4822 (list 'org-tags-view `(quote ,todo-only)
4823 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4824 (setq files (org-agenda-files nil 'ifmode)
4825 rtnall nil)
4826 (while (setq file (pop files))
4827 (catch 'nextfile
4828 (org-check-agenda-file file)
4829 (setq buffer (if (file-exists-p file)
4830 (org-get-agenda-file-buffer file)
4831 (error "No such file %s" file)))
4832 (if (not buffer)
4833 ;; If file does not exist, error message to agenda
4834 (setq rtn (list
4835 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4836 rtnall (append rtnall rtn))
4837 (with-current-buffer buffer
4838 (unless (derived-mode-p 'org-mode)
4839 (error "Agenda file %s is not in `org-mode'" file))
4840 (save-excursion
4841 (save-restriction
4842 (if (eq buffer org-agenda-restrict)
4843 (narrow-to-region org-agenda-restrict-begin
4844 org-agenda-restrict-end)
4845 (widen))
4846 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4847 (setq rtnall (append rtnall rtn))))))))
4848 (if org-agenda-overriding-header
4849 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4850 nil 'face 'org-agenda-structure) "\n")
4851 (insert "Headlines with TAGS match: ")
4852 (add-text-properties (point-min) (1- (point))
4853 (list 'face 'org-agenda-structure
4854 'short-heading
4855 (concat "Match: " match)))
4856 (setq pos (point))
4857 (insert match "\n")
4858 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4859 (setq pos (point))
4860 (unless org-agenda-multi
4861 (insert "Press `C-u r' to search again with new search string\n"))
4862 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4863 (org-agenda-mark-header-line (point-min))
4864 (when rtnall
4865 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4866 (goto-char (point-min))
4867 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4868 (add-text-properties (point-min) (point-max)
4869 `(org-agenda-type tags
4870 org-last-args (,todo-only ,match)
4871 org-redo-cmd ,org-agenda-redo-command
4872 org-series-cmd ,org-cmd))
4873 (org-agenda-finalize)
4874 (setq buffer-read-only t))))
4876 ;;; Agenda Finding stuck projects
4878 (defvar org-agenda-skip-regexp nil
4879 "Regular expression used in skipping subtrees for the agenda.
4880 This is basically a temporary global variable that can be set and then
4881 used by user-defined selections using `org-agenda-skip-function'.")
4883 (defvar org-agenda-overriding-header nil
4884 "When set during agenda, todo and tags searches it replaces the header.
4885 This variable should not be set directly, but custom commands can bind it
4886 in the options section.")
4888 (defun org-agenda-skip-entry-when-regexp-matches ()
4889 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4890 If yes, it returns the end position of this entry, causing agenda commands
4891 to skip the entry but continuing the search in the subtree. This is a
4892 function that can be put into `org-agenda-skip-function' for the duration
4893 of a command."
4894 (let ((end (save-excursion (org-end-of-subtree t)))
4895 skip)
4896 (save-excursion
4897 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4898 (and skip end)))
4900 (defun org-agenda-skip-subtree-when-regexp-matches ()
4901 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4902 If yes, it returns the end position of this tree, causing agenda commands
4903 to skip this subtree. This is a function that can be put into
4904 `org-agenda-skip-function' for the duration of a command."
4905 (let ((end (save-excursion (org-end-of-subtree t)))
4906 skip)
4907 (save-excursion
4908 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4909 (and skip end)))
4911 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4912 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4913 If yes, it returns the end position of the current entry (NOT the tree),
4914 causing agenda commands to skip the entry but continuing the search in
4915 the subtree. This is a function that can be put into
4916 `org-agenda-skip-function' for the duration of a command. An important
4917 use of this function is for the stuck project list."
4918 (let ((end (save-excursion (org-end-of-subtree t)))
4919 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4920 skip)
4921 (save-excursion
4922 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4923 (and skip entry-end)))
4925 (defun org-agenda-skip-entry-if (&rest conditions)
4926 "Skip entry if any of CONDITIONS is true.
4927 See `org-agenda-skip-if' for details."
4928 (org-agenda-skip-if nil conditions))
4930 (defun org-agenda-skip-subtree-if (&rest conditions)
4931 "Skip subtree if any of CONDITIONS is true.
4932 See `org-agenda-skip-if' for details."
4933 (org-agenda-skip-if t conditions))
4935 (defun org-agenda-skip-if (subtree conditions)
4936 "Checks current entity for CONDITIONS.
4937 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4938 the entry (i.e. the text before the next heading) is checked.
4940 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4941 from different tests. Valid conditions are:
4943 scheduled Check if there is a scheduled cookie
4944 notscheduled Check if there is no scheduled cookie
4945 deadline Check if there is a deadline
4946 notdeadline Check if there is no deadline
4947 timestamp Check if there is a timestamp (also deadline or scheduled)
4948 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4949 regexp Check if regexp matches
4950 notregexp Check if regexp does not match.
4951 todo Check if TODO keyword matches
4952 nottodo Check if TODO keyword does not match
4954 The regexp is taken from the conditions list, it must come right after
4955 the `regexp' or `notregexp' element.
4957 `todo' and `nottodo' accept as an argument a list of todo
4958 keywords, which may include \"*\" to match any todo keyword.
4960 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4962 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4964 Instead of a list, a keyword class may be given. For example:
4966 (org-agenda-skip-entry-if 'nottodo 'done)
4968 would skip entries that haven't been marked with any of \"DONE\"
4969 keywords. Possible classes are: `todo', `done', `any'.
4971 If any of these conditions is met, this function returns the end point of
4972 the entity, causing the search to continue from there. This is a function
4973 that can be put into `org-agenda-skip-function' for the duration of a command."
4974 (let (beg end m)
4975 (org-back-to-heading t)
4976 (setq beg (point)
4977 end (if subtree
4978 (progn (org-end-of-subtree t) (point))
4979 (progn (outline-next-heading) (1- (point)))))
4980 (goto-char beg)
4981 (and
4983 (and (memq 'scheduled conditions)
4984 (re-search-forward org-scheduled-time-regexp end t))
4985 (and (memq 'notscheduled conditions)
4986 (not (re-search-forward org-scheduled-time-regexp end t)))
4987 (and (memq 'deadline conditions)
4988 (re-search-forward org-deadline-time-regexp end t))
4989 (and (memq 'notdeadline conditions)
4990 (not (re-search-forward org-deadline-time-regexp end t)))
4991 (and (memq 'timestamp conditions)
4992 (re-search-forward org-ts-regexp end t))
4993 (and (memq 'nottimestamp conditions)
4994 (not (re-search-forward org-ts-regexp end t)))
4995 (and (setq m (memq 'regexp conditions))
4996 (stringp (nth 1 m))
4997 (re-search-forward (nth 1 m) end t))
4998 (and (setq m (memq 'notregexp conditions))
4999 (stringp (nth 1 m))
5000 (not (re-search-forward (nth 1 m) end t)))
5001 (and (or
5002 (setq m (memq 'nottodo conditions))
5003 (setq m (memq 'todo-unblocked conditions))
5004 (setq m (memq 'nottodo-unblocked conditions))
5005 (setq m (memq 'todo conditions)))
5006 (org-agenda-skip-if-todo m end)))
5007 end)))
5009 (defun org-agenda-skip-if-todo (args end)
5010 "Helper function for `org-agenda-skip-if', do not use it directly.
5011 ARGS is a list with first element either `todo', `nottodo',
5012 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
5013 a list of TODO keywords, or a state symbol `todo' or `done' or
5014 `any'."
5015 (let ((kw (car args))
5016 (arg (cadr args))
5017 todo-wds todo-re)
5018 (setq todo-wds
5019 (org-uniquify
5020 (cond
5021 ((listp arg) ;; list of keywords
5022 (if (member "*" arg)
5023 (mapcar 'substring-no-properties org-todo-keywords-1)
5024 arg))
5025 ((symbolp arg) ;; keyword class name
5026 (cond
5027 ((eq arg 'todo)
5028 (org-delete-all org-done-keywords
5029 (mapcar 'substring-no-properties
5030 org-todo-keywords-1)))
5031 ((eq arg 'done) org-done-keywords)
5032 ((eq arg 'any)
5033 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
5034 (setq todo-re
5035 (concat "^\\*+[ \t]+\\<\\("
5036 (mapconcat 'identity todo-wds "\\|")
5037 "\\)\\>"))
5038 (cond
5039 ((eq kw 'todo) (re-search-forward todo-re end t))
5040 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
5041 ((eq kw 'todo-unblocked)
5042 (catch 'unblocked
5043 (while (re-search-forward todo-re end t)
5044 (or (org-entry-blocked-p) (throw 'unblocked t)))
5045 nil))
5046 ((eq kw 'nottodo-unblocked)
5047 (catch 'unblocked
5048 (while (re-search-forward todo-re end t)
5049 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5053 ;;;###autoload
5054 (defun org-agenda-list-stuck-projects (&rest ignore)
5055 "Create agenda view for projects that are stuck.
5056 Stuck projects are project that have no next actions. For the definitions
5057 of what a project is and how to check if it stuck, customize the variable
5058 `org-stuck-projects'."
5059 (interactive)
5060 (let* ((org-agenda-skip-function
5061 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5062 ;; We could have used org-agenda-skip-if here.
5063 (org-agenda-overriding-header
5064 (or org-agenda-overriding-header "List of stuck projects: "))
5065 (matcher (nth 0 org-stuck-projects))
5066 (todo (nth 1 org-stuck-projects))
5067 (todo-wds (if (member "*" todo)
5068 (progn
5069 (org-agenda-prepare-buffers (org-agenda-files
5070 nil 'ifmode))
5071 (org-delete-all
5072 org-done-keywords-for-agenda
5073 (copy-sequence org-todo-keywords-for-agenda)))
5074 todo))
5075 (todo-re (concat "^\\*+[ \t]+\\("
5076 (mapconcat 'identity todo-wds "\\|")
5077 "\\)\\>"))
5078 (tags (nth 2 org-stuck-projects))
5079 (tags-re (if (member "*" tags)
5080 (concat org-outline-regexp-bol
5081 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5082 (if tags
5083 (concat org-outline-regexp-bol
5084 ".*:\\("
5085 (mapconcat 'identity tags "\\|")
5086 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5087 (gen-re (nth 3 org-stuck-projects))
5088 (re-list
5089 (delq nil
5090 (list
5091 (if todo todo-re)
5092 (if tags tags-re)
5093 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5094 gen-re)))))
5095 (setq org-agenda-skip-regexp
5096 (if re-list
5097 (mapconcat 'identity re-list "\\|")
5098 (error "No information how to identify unstuck projects")))
5099 (org-tags-view nil matcher)
5100 (setq org-agenda-buffer-name (buffer-name))
5101 (with-current-buffer org-agenda-buffer-name
5102 (setq org-agenda-redo-command
5103 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5105 ;;; Diary integration
5107 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5108 (defvar diary-list-entries-hook)
5109 (defvar diary-time-regexp)
5110 (defun org-get-entries-from-diary (date)
5111 "Get the (Emacs Calendar) diary entries for DATE."
5112 (require 'diary-lib)
5113 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5114 (diary-display-hook '(fancy-diary-display))
5115 (diary-display-function 'fancy-diary-display)
5116 (pop-up-frames nil)
5117 (diary-list-entries-hook
5118 (cons 'org-diary-default-entry diary-list-entries-hook))
5119 (diary-file-name-prefix nil) ; turn this feature off
5120 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5121 entries
5122 (org-disable-agenda-to-diary t))
5123 (save-excursion
5124 (save-window-excursion
5125 (funcall (if (fboundp 'diary-list-entries)
5126 'diary-list-entries 'list-diary-entries)
5127 date 1)))
5128 (if (not (get-buffer diary-fancy-buffer))
5129 (setq entries nil)
5130 (with-current-buffer diary-fancy-buffer
5131 (setq buffer-read-only nil)
5132 (if (zerop (buffer-size))
5133 ;; No entries
5134 (setq entries nil)
5135 ;; Omit the date and other unnecessary stuff
5136 (org-agenda-cleanup-fancy-diary)
5137 ;; Add prefix to each line and extend the text properties
5138 (if (zerop (buffer-size))
5139 (setq entries nil)
5140 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5141 (setq entries
5142 (with-temp-buffer
5143 (insert entries) (goto-char (point-min))
5144 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5145 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5146 (replace-match (concat "; " (match-string 1)))))
5147 (buffer-string)))))
5148 (set-buffer-modified-p nil)
5149 (kill-buffer diary-fancy-buffer)))
5150 (when entries
5151 (setq entries (org-split-string entries "\n"))
5152 (setq entries
5153 (mapcar
5154 (lambda (x)
5155 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5156 ;; Extend the text properties to the beginning of the line
5157 (org-add-props x (text-properties-at (1- (length x)) x)
5158 'type "diary" 'date date 'face 'org-agenda-diary))
5159 entries)))))
5161 (defvar org-agenda-cleanup-fancy-diary-hook nil
5162 "Hook run when the fancy diary buffer is cleaned up.")
5164 (defun org-agenda-cleanup-fancy-diary ()
5165 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5166 This gets rid of the date, the underline under the date, and
5167 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5168 date. It also removes lines that contain only whitespace."
5169 (goto-char (point-min))
5170 (if (looking-at ".*?:[ \t]*")
5171 (progn
5172 (replace-match "")
5173 (re-search-forward "\n=+$" nil t)
5174 (replace-match "")
5175 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5176 (re-search-forward "\n=+$" nil t)
5177 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5178 (goto-char (point-min))
5179 (while (re-search-forward "^ +\n" nil t)
5180 (replace-match ""))
5181 (goto-char (point-min))
5182 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5183 (replace-match ""))
5184 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5186 ;; Make sure entries from the diary have the right text properties.
5187 (eval-after-load "diary-lib"
5188 '(if (boundp 'diary-modify-entry-list-string-function)
5189 ;; We can rely on the hook, nothing to do
5191 ;; Hook not available, must use advice to make this work
5192 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5193 "Make the position visible."
5194 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5195 (stringp string)
5196 buffer-file-name)
5197 (setq string (org-modify-diary-entry-string string))))))
5199 (defun org-modify-diary-entry-string (string)
5200 "Add text properties to string, allowing org-mode to act on it."
5201 (org-add-props string nil
5202 'mouse-face 'highlight
5203 'help-echo (if buffer-file-name
5204 (format "mouse-2 or RET jump to diary file %s"
5205 (abbreviate-file-name buffer-file-name))
5207 'org-agenda-diary-link t
5208 'org-marker (org-agenda-new-marker (point-at-bol))))
5210 (defun org-diary-default-entry ()
5211 "Add a dummy entry to the diary.
5212 Needed to avoid empty dates which mess up holiday display."
5213 ;; Catch the error if dealing with the new add-to-diary-alist
5214 (when org-disable-agenda-to-diary
5215 (condition-case nil
5216 (org-add-to-diary-list original-date "Org-mode dummy" "")
5217 (error
5218 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5220 (defun org-add-to-diary-list (&rest args)
5221 (if (fboundp 'diary-add-to-list)
5222 (apply 'diary-add-to-list args)
5223 (apply 'add-to-diary-list args)))
5225 (defvar org-diary-last-run-time nil)
5227 ;;;###autoload
5228 (defun org-diary (&rest args)
5229 "Return diary information from org files.
5230 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5231 It accesses org files and extracts information from those files to be
5232 listed in the diary. The function accepts arguments specifying what
5233 items should be listed. For a list of arguments allowed here, see the
5234 variable `org-agenda-entry-types'.
5236 The call in the diary file should look like this:
5238 &%%(org-diary) ~/path/to/some/orgfile.org
5240 Use a separate line for each org file to check. Or, if you omit the file name,
5241 all files listed in `org-agenda-files' will be checked automatically:
5243 &%%(org-diary)
5245 If you don't give any arguments (as in the example above), the default value
5246 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5247 So the example above may also be written as
5249 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5251 The function expects the lisp variables `entry' and `date' to be provided
5252 by the caller, because this is how the calendar works. Don't use this
5253 function from a program - use `org-agenda-get-day-entries' instead."
5254 (when (> (- (org-float-time)
5255 org-agenda-last-marker-time)
5257 ;; I am not sure if this works with sticky agendas, because the marker
5258 ;; list is then no longer a global variable.
5259 (org-agenda-reset-markers))
5260 (org-compile-prefix-format 'agenda)
5261 (org-set-sorting-strategy 'agenda)
5262 (setq args (or args org-agenda-entry-types))
5263 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5264 (list entry)
5265 (org-agenda-files t)))
5266 (time (org-float-time))
5267 file rtn results)
5268 (when (or (not org-diary-last-run-time)
5269 (> (- time
5270 org-diary-last-run-time)
5272 (org-agenda-prepare-buffers files))
5273 (setq org-diary-last-run-time time)
5274 ;; If this is called during org-agenda, don't return any entries to
5275 ;; the calendar. Org Agenda will list these entries itself.
5276 (if org-disable-agenda-to-diary (setq files nil))
5277 (while (setq file (pop files))
5278 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5279 (setq results (append results rtn)))
5280 (when results
5281 (setq results
5282 (mapcar (lambda (i) (replace-regexp-in-string
5283 org-bracket-link-regexp "\\3" i)) results))
5284 (concat (org-agenda-finalize-entries results) "\n"))))
5286 ;;; Agenda entry finders
5288 (defun org-agenda-get-day-entries (file date &rest args)
5289 "Does the work for `org-diary' and `org-agenda'.
5290 FILE is the path to a file to be checked for entries. DATE is date like
5291 the one returned by `calendar-current-date'. ARGS are symbols indicating
5292 which kind of entries should be extracted. For details about these, see
5293 the documentation of `org-diary'."
5294 (setq args (or args org-agenda-entry-types))
5295 (let* ((org-startup-folded nil)
5296 (org-startup-align-all-tables nil)
5297 (buffer (if (file-exists-p file)
5298 (org-get-agenda-file-buffer file)
5299 (error "No such file %s" file)))
5300 arg results rtn deadline-results)
5301 (if (not buffer)
5302 ;; If file does not exist, make sure an error message ends up in diary
5303 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5304 (with-current-buffer buffer
5305 (unless (derived-mode-p 'org-mode)
5306 (error "Agenda file %s is not in `org-mode'" file))
5307 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5308 (let ((case-fold-search nil))
5309 (save-excursion
5310 (save-restriction
5311 (if (eq buffer org-agenda-restrict)
5312 (narrow-to-region org-agenda-restrict-begin
5313 org-agenda-restrict-end)
5314 (widen))
5315 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
5316 (while (setq arg (pop args))
5317 (cond
5318 ((and (eq arg :todo)
5319 (equal date (calendar-gregorian-from-absolute
5320 (org-today))))
5321 (setq rtn (org-agenda-get-todos))
5322 (setq results (append results rtn)))
5323 ((eq arg :timestamp)
5324 (setq rtn (org-agenda-get-blocks))
5325 (setq results (append results rtn))
5326 (setq rtn (org-agenda-get-timestamps deadline-results))
5327 (setq results (append results rtn)))
5328 ((eq arg :sexp)
5329 (setq rtn (org-agenda-get-sexps))
5330 (setq results (append results rtn)))
5331 ((eq arg :scheduled)
5332 (setq rtn (org-agenda-get-scheduled deadline-results))
5333 (setq results (append results rtn)))
5334 ((eq arg :scheduled*)
5335 (setq rtn (org-agenda-get-scheduled deadline-results t))
5336 (setq results (append results rtn)))
5337 ((eq arg :closed)
5338 (setq rtn (org-agenda-get-progress))
5339 (setq results (append results rtn)))
5340 ((eq arg :deadline)
5341 (setq rtn (org-agenda-get-deadlines))
5342 (setq deadline-results (copy-sequence rtn))
5343 (setq results (append results rtn)))
5344 ((eq arg :deadline*)
5345 (setq rtn (org-agenda-get-deadlines t))
5346 (setq deadline-results (copy-sequence rtn))
5347 (setq results (append results rtn))))))))
5348 results))))
5350 (defsubst org-em (x y list)
5351 "Is X or Y a member of LIST?"
5352 (or (memq x list) (memq y list)))
5354 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5355 (defvar org-agenda-sorting-strategy-selected nil)
5357 (defun org-agenda-get-todos ()
5358 "Return the TODO information for agenda display."
5359 (let* ((props (list 'face nil
5360 'done-face 'org-agenda-done
5361 'org-not-done-regexp org-not-done-regexp
5362 'org-todo-regexp org-todo-regexp
5363 'org-complex-heading-regexp org-complex-heading-regexp
5364 'mouse-face 'highlight
5365 'help-echo
5366 (format "mouse-2 or RET jump to org file %s"
5367 (abbreviate-file-name buffer-file-name))))
5368 (regexp (format org-heading-keyword-regexp-format
5369 (cond
5370 ((and org-select-this-todo-keyword
5371 (equal org-select-this-todo-keyword "*"))
5372 org-todo-regexp)
5373 (org-select-this-todo-keyword
5374 (concat "\\("
5375 (mapconcat 'identity
5376 (org-split-string
5377 org-select-this-todo-keyword
5378 "|")
5379 "\\|") "\\)"))
5380 (t org-not-done-regexp))))
5381 marker priority category level tags todo-state ts-date ts-date-type
5382 ee txt beg end inherited-tags todo-state-end-pos)
5383 (goto-char (point-min))
5384 (while (re-search-forward regexp nil t)
5385 (catch :skip
5386 (save-match-data
5387 (beginning-of-line)
5388 (org-agenda-skip)
5389 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5390 (unless (and (setq todo-state (org-get-todo-state))
5391 (setq todo-state-end-pos (match-end 2)))
5392 (goto-char end)
5393 (throw :skip nil))
5394 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5395 (goto-char (1+ beg))
5396 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5397 (throw :skip nil)))
5398 (goto-char (match-beginning 2))
5399 (setq marker (org-agenda-new-marker (match-beginning 0))
5400 category (org-get-category)
5401 ts-date (let (ts)
5402 (save-match-data
5403 (cond ((org-em 'scheduled-up 'scheduled-down
5404 org-agenda-sorting-strategy-selected)
5405 (setq ts (org-entry-get (point) "SCHEDULED")
5406 ts-date-type " scheduled"))
5407 ((org-em 'deadline-up 'deadline-down
5408 org-agenda-sorting-strategy-selected)
5409 (setq ts (org-entry-get (point) "DEADLINE")
5410 ts-date-type " deadline"))
5411 ((org-em 'ts-up 'ts-down
5412 org-agenda-sorting-strategy-selected)
5413 (setq ts (org-entry-get (point) "TIMESTAMP")
5414 ts-date-type " timestamp"))
5415 ((org-em 'tsia-up 'tsia-down
5416 org-agenda-sorting-strategy-selected)
5417 (setq ts (org-entry-get (point) "TIMESTAMP_IA")
5418 ts-date-type " timestamp_ia"))
5419 ((org-em 'timestamp-up 'timestamp-down
5420 org-agenda-sorting-strategy-selected)
5421 (setq ts (or (org-entry-get (point) "SCHEDULED")
5422 (org-entry-get (point) "DEADLINE")
5423 (org-entry-get (point) "TIMESTAMP")
5424 (org-entry-get (point) "TIMESTAMP_IA"))
5425 ts-date-type ""))
5426 (t (setq ts-date-type "")))
5427 (when ts (ignore-errors (org-time-string-to-absolute ts)))))
5428 txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
5429 inherited-tags
5430 (or (eq org-agenda-show-inherited-tags 'always)
5431 (and (listp org-agenda-show-inherited-tags)
5432 (memq 'todo org-agenda-show-inherited-tags))
5433 (and (eq org-agenda-show-inherited-tags t)
5434 (or (eq org-agenda-use-tag-inheritance t)
5435 (memq 'todo org-agenda-use-tag-inheritance))))
5436 tags (org-get-tags-at nil (not inherited-tags))
5437 level (make-string (org-reduced-level (org-outline-level)) ? )
5438 txt (org-agenda-format-item "" txt level category tags t)
5439 priority (1+ (org-get-priority txt)))
5440 (org-add-props txt props
5441 'org-marker marker 'org-hd-marker marker
5442 'priority priority
5443 'level level
5444 'ts-date ts-date
5445 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5446 (push txt ee)
5447 (if org-agenda-todo-list-sublevels
5448 (goto-char todo-state-end-pos)
5449 (org-end-of-subtree 'invisible))))
5450 (nreverse ee)))
5452 (defun org-agenda-todo-custom-ignore-p (time n)
5453 "Check whether timestamp is farther away than n number of days.
5454 This function is invoked if `org-agenda-todo-ignore-deadlines',
5455 `org-agenda-todo-ignore-scheduled' or
5456 `org-agenda-todo-ignore-timestamp' is set to an integer."
5457 (let ((days (org-time-stamp-to-now
5458 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5459 (if (>= n 0)
5460 (>= days n)
5461 (<= days n))))
5463 ;;;###autoload
5464 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5465 (&optional end)
5466 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5467 (when (or org-agenda-todo-ignore-with-date
5468 org-agenda-todo-ignore-scheduled
5469 org-agenda-todo-ignore-deadlines
5470 org-agenda-todo-ignore-timestamp)
5471 (setq end (or end (save-excursion (outline-next-heading) (point))))
5472 (save-excursion
5473 (or (and org-agenda-todo-ignore-with-date
5474 (re-search-forward org-ts-regexp end t))
5475 (and org-agenda-todo-ignore-scheduled
5476 (re-search-forward org-scheduled-time-regexp end t)
5477 (cond
5478 ((eq org-agenda-todo-ignore-scheduled 'future)
5479 (> (org-time-stamp-to-now
5480 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5481 ((eq org-agenda-todo-ignore-scheduled 'past)
5482 (<= (org-time-stamp-to-now
5483 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5484 ((numberp org-agenda-todo-ignore-scheduled)
5485 (org-agenda-todo-custom-ignore-p
5486 (match-string 1) org-agenda-todo-ignore-scheduled))
5487 (t)))
5488 (and org-agenda-todo-ignore-deadlines
5489 (re-search-forward org-deadline-time-regexp end t)
5490 (cond
5491 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5492 ((eq org-agenda-todo-ignore-deadlines 'far)
5493 (not (org-deadline-close (match-string 1))))
5494 ((eq org-agenda-todo-ignore-deadlines 'future)
5495 (> (org-time-stamp-to-now
5496 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5497 ((eq org-agenda-todo-ignore-deadlines 'past)
5498 (<= (org-time-stamp-to-now
5499 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5500 ((numberp org-agenda-todo-ignore-deadlines)
5501 (org-agenda-todo-custom-ignore-p
5502 (match-string 1) org-agenda-todo-ignore-deadlines))
5503 (t (org-deadline-close (match-string 1)))))
5504 (and org-agenda-todo-ignore-timestamp
5505 (let ((buffer (current-buffer))
5506 (regexp
5507 (concat
5508 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5509 (start (point)))
5510 ;; Copy current buffer into a temporary one
5511 (with-temp-buffer
5512 (insert-buffer-substring buffer start end)
5513 (goto-char (point-min))
5514 ;; Delete SCHEDULED and DEADLINE items
5515 (while (re-search-forward regexp end t)
5516 (delete-region (match-beginning 0) (match-end 0)))
5517 (goto-char (point-min))
5518 ;; No search for timestamp left
5519 (when (re-search-forward org-ts-regexp nil t)
5520 (cond
5521 ((eq org-agenda-todo-ignore-timestamp 'future)
5522 (> (org-time-stamp-to-now
5523 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5524 ((eq org-agenda-todo-ignore-timestamp 'past)
5525 (<= (org-time-stamp-to-now
5526 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5527 ((numberp org-agenda-todo-ignore-timestamp)
5528 (org-agenda-todo-custom-ignore-p
5529 (match-string 1) org-agenda-todo-ignore-timestamp))
5530 (t))))))))))
5532 (defun org-agenda-get-timestamps (&optional deadline-results)
5533 "Return the date stamp information for agenda display."
5534 (let* ((props (list 'face 'org-agenda-calendar-event
5535 'org-not-done-regexp org-not-done-regexp
5536 'org-todo-regexp org-todo-regexp
5537 'org-complex-heading-regexp org-complex-heading-regexp
5538 'mouse-face 'highlight
5539 'help-echo
5540 (format "mouse-2 or RET jump to org file %s"
5541 (abbreviate-file-name buffer-file-name))))
5542 (d1 (calendar-absolute-from-gregorian date))
5544 (deadline-position-alist
5545 (mapcar (lambda (a) (and (setq mm (get-text-property
5546 0 'org-hd-marker a))
5547 (cons (marker-position mm) a)))
5548 deadline-results))
5549 (remove-re org-ts-regexp)
5550 (regexp
5551 (concat
5552 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5553 (regexp-quote
5554 (substring
5555 (format-time-string
5556 (car org-time-stamp-formats)
5557 (apply 'encode-time ; DATE bound by calendar
5558 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5559 1 11))
5560 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5561 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5562 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5563 donep tmp priority category level ee txt timestr tags
5564 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5565 inherited-tags ts-date)
5566 (goto-char (point-min))
5567 (while (setq end-of-match (re-search-forward regexp nil t))
5568 (setq b0 (match-beginning 0)
5569 b3 (match-beginning 3) e3 (match-end 3)
5570 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5571 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5572 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5573 (member todo-state
5574 org-agenda-repeating-timestamp-show-all)))
5575 (catch :skip
5576 (and (org-at-date-range-p) (throw :skip nil))
5577 (org-agenda-skip)
5578 (if (and (match-end 1)
5579 (not (= d1 (org-time-string-to-absolute
5580 (match-string 1) d1 nil show-all
5581 (current-buffer) b0))))
5582 (throw :skip nil))
5583 (if (and e3
5584 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5585 (throw :skip nil))
5586 (setq tmp (buffer-substring (max (point-min)
5587 (- b0 org-ds-keyword-length))
5589 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5590 inactivep (= (char-after b0) ?\[)
5591 deadlinep (string-match org-deadline-regexp tmp)
5592 scheduledp (string-match org-scheduled-regexp tmp)
5593 closedp (and org-agenda-include-inactive-timestamps
5594 (string-match org-closed-string tmp))
5595 clockp (and org-agenda-include-inactive-timestamps
5596 (or (string-match org-clock-string tmp)
5597 (string-match "]-+\\'" tmp)))
5598 warntime (get-text-property (point) 'org-appt-warntime)
5599 donep (member todo-state org-done-keywords))
5600 (if (or scheduledp deadlinep closedp clockp
5601 (and donep org-agenda-skip-timestamp-if-done))
5602 (throw :skip t))
5603 (if (string-match ">" timestr)
5604 ;; substring should only run to end of time stamp
5605 (setq timestr (substring timestr 0 (match-end 0))))
5606 (setq marker (org-agenda-new-marker b0)
5607 category (org-get-category b0))
5608 (save-excursion
5609 (if (not (re-search-backward org-outline-regexp-bol nil t))
5610 (throw :skip nil)
5611 (goto-char (match-beginning 0))
5612 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5613 (assoc (point) deadline-position-alist))
5614 (throw :skip nil))
5615 (setq hdmarker (org-agenda-new-marker)
5616 inherited-tags
5617 (or (eq org-agenda-show-inherited-tags 'always)
5618 (and (listp org-agenda-show-inherited-tags)
5619 (memq 'agenda org-agenda-show-inherited-tags))
5620 (and (eq org-agenda-show-inherited-tags t)
5621 (or (eq org-agenda-use-tag-inheritance t)
5622 (memq 'agenda org-agenda-use-tag-inheritance))))
5623 tags (org-get-tags-at nil (not inherited-tags))
5624 level (make-string (org-reduced-level (org-outline-level)) ? ))
5625 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5626 (setq head (or (match-string 1) ""))
5627 (setq txt (org-agenda-format-item
5628 (if inactivep org-agenda-inactive-leader nil)
5629 head level category tags timestr
5630 remove-re habitp)))
5631 (setq priority (org-get-priority txt))
5632 (org-add-props txt props 'priority priority
5633 'org-marker marker 'org-hd-marker hdmarker
5634 'date date
5635 'level level
5636 'ts-date
5637 (ignore-errors (org-time-string-to-absolute timestr))
5638 'todo-state todo-state
5639 'warntime warntime
5640 'type "timestamp")
5641 (push txt ee))
5642 (if org-agenda-skip-additional-timestamps-same-entry
5643 (outline-next-heading)
5644 (goto-char end-of-match))))
5645 (nreverse ee)))
5647 (defun org-agenda-get-sexps ()
5648 "Return the sexp information for agenda display."
5649 (require 'diary-lib)
5650 (let* ((props (list 'face 'org-agenda-calendar-sexp
5651 'mouse-face 'highlight
5652 'help-echo
5653 (format "mouse-2 or RET jump to org file %s"
5654 (abbreviate-file-name buffer-file-name))))
5655 (regexp "^&?%%(")
5656 marker category extra level ee txt tags entry
5657 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5658 (goto-char (point-min))
5659 (while (re-search-forward regexp nil t)
5660 (catch :skip
5661 (org-agenda-skip)
5662 (setq beg (match-beginning 0))
5663 (goto-char (1- (match-end 0)))
5664 (setq b (point))
5665 (forward-sexp 1)
5666 (setq sexp (buffer-substring b (point)))
5667 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5668 (org-trim (match-string 1))
5669 ""))
5670 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5671 (when result
5672 (setq marker (org-agenda-new-marker beg)
5673 level (make-string (org-reduced-level (org-outline-level)) ? )
5674 category (org-get-category beg)
5675 inherited-tags
5676 (or (eq org-agenda-show-inherited-tags 'always)
5677 (and (listp org-agenda-show-inherited-tags)
5678 (memq 'agenda org-agenda-show-inherited-tags))
5679 (and (eq org-agenda-show-inherited-tags t)
5680 (or (eq org-agenda-use-tag-inheritance t)
5681 (memq 'agenda org-agenda-use-tag-inheritance))))
5682 tags (org-get-tags-at nil (not inherited-tags))
5683 todo-state (org-get-todo-state)
5684 warntime (get-text-property (point) 'org-appt-warntime)
5685 extra nil)
5687 (dolist (r (if (stringp result)
5688 (list result)
5689 result)) ;; we expect a list here
5690 (when (and org-agenda-diary-sexp-prefix
5691 (string-match org-agenda-diary-sexp-prefix r))
5692 (setq extra (match-string 0 r)
5693 r (replace-match "" nil nil r)))
5694 (if (string-match "\\S-" r)
5695 (setq txt r)
5696 (setq txt "SEXP entry returned empty string"))
5697 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5698 (org-add-props txt props 'org-marker marker
5699 'date date 'todo-state todo-state
5700 'level level 'type "sexp" 'warntime warntime)
5701 (push txt ee)))))
5702 (nreverse ee)))
5704 ;; Calendar sanity: define some functions that are independent of
5705 ;; `calendar-date-style'.
5706 ;; Normally I would like to use ISO format when calling the diary functions,
5707 ;; but to make sure we still have Emacs 22 compatibility we bind
5708 ;; also `european-calendar-style' and use european format
5709 (defun org-anniversary (year month day &optional mark)
5710 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5711 (org-no-warnings
5712 (let ((calendar-date-style 'european) (european-calendar-style t))
5713 (diary-anniversary day month year mark))))
5714 (defun org-cyclic (N year month day &optional mark)
5715 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5716 (org-no-warnings
5717 (let ((calendar-date-style 'european) (european-calendar-style t))
5718 (diary-cyclic N day month year mark))))
5719 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5720 "Like `diary-block', but with fixed (ISO) order of arguments."
5721 (org-no-warnings
5722 (let ((calendar-date-style 'european) (european-calendar-style t))
5723 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5724 (defun org-date (year month day &optional mark)
5725 "Like `diary-date', but with fixed (ISO) order of arguments."
5726 (org-no-warnings
5727 (let ((calendar-date-style 'european) (european-calendar-style t))
5728 (diary-date day month year mark))))
5730 ;; Define the` org-class' function
5731 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5732 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5733 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5734 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5735 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5736 `holidays', then any date that is known by the Emacs calendar to be a
5737 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5738 then those holidays will be skipped."
5739 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5740 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5741 (d (calendar-absolute-from-gregorian date))
5742 (h (when skip-weeks (calendar-check-holidays date))))
5743 (and
5744 (<= date1 d)
5745 (<= d date2)
5746 (= (calendar-day-of-week date) dayname)
5747 (or (not skip-weeks)
5748 (progn
5749 (require 'cal-iso)
5750 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5751 (not (or (and h (memq 'holidays skip-weeks))
5752 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5753 entry)))
5755 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5756 "Like `org-class', but honor `calendar-date-style'.
5757 The order of the first 2 times 3 arguments depends on the variable
5758 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5759 So for American calendars, give this as MONTH DAY YEAR, for European as
5760 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5761 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5762 is any number of ISO weeks in the block period for which the item should
5763 be skipped.
5765 This function is here only for backward compatibility and it is deprecated,
5766 please use `org-class' instead."
5767 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5768 (date2 (org-order-calendar-date-args m2 d2 y2)))
5769 (org-class
5770 (nth 2 date1) (car date1) (nth 1 date1)
5771 (nth 2 date2) (car date2) (nth 1 date2)
5772 dayname skip-weeks)))
5773 (make-obsolete 'org-diary-class 'org-class "")
5775 (defalias 'org-get-closed 'org-agenda-get-progress)
5776 (defun org-agenda-get-progress ()
5777 "Return the logged TODO entries for agenda display."
5778 (let* ((props (list 'mouse-face 'highlight
5779 'org-not-done-regexp org-not-done-regexp
5780 'org-todo-regexp org-todo-regexp
5781 'org-complex-heading-regexp org-complex-heading-regexp
5782 'help-echo
5783 (format "mouse-2 or RET jump to org file %s"
5784 (abbreviate-file-name buffer-file-name))))
5785 (items (if (consp org-agenda-show-log-scoped)
5786 org-agenda-show-log-scoped
5787 (if (eq org-agenda-show-log-scoped 'clockcheck)
5788 '(clock)
5789 org-agenda-log-mode-items)))
5790 (parts
5791 (delq nil
5792 (list
5793 (if (memq 'closed items) (concat "\\<" org-closed-string))
5794 (if (memq 'clock items) (concat "\\<" org-clock-string))
5795 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5796 (parts-re (if parts (mapconcat 'identity parts "\\|")
5797 (error "`org-agenda-log-mode-items' is empty")))
5798 (regexp (concat
5799 "\\(" parts-re "\\)"
5800 " *\\["
5801 (regexp-quote
5802 (substring
5803 (format-time-string
5804 (car org-time-stamp-formats)
5805 (apply 'encode-time ; DATE bound by calendar
5806 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5807 1 11))))
5808 (org-agenda-search-headline-for-time nil)
5809 marker hdmarker priority category level tags closedp
5810 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5811 (goto-char (point-min))
5812 (while (re-search-forward regexp nil t)
5813 (catch :skip
5814 (org-agenda-skip)
5815 (setq marker (org-agenda-new-marker (match-beginning 0))
5816 closedp (equal (match-string 1) org-closed-string)
5817 statep (equal (string-to-char (match-string 1)) ?-)
5818 clockp (not (or closedp statep))
5819 state (and statep (match-string 2))
5820 category (org-get-category (match-beginning 0))
5821 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5822 (when (string-match "\\]" timestr)
5823 ;; substring should only run to end of time stamp
5824 (setq rest (substring timestr (match-end 0))
5825 timestr (substring timestr 0 (match-end 0)))
5826 (if (and (not closedp) (not statep)
5827 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5828 rest))
5829 (progn (setq timestr (concat (substring timestr 0 -1)
5830 "-" (match-string 1 rest) "]"))
5831 (setq clocked (match-string 2 rest)))
5832 (setq clocked "-")))
5833 (save-excursion
5834 (setq extra
5835 (cond
5836 ((not org-agenda-log-mode-add-notes) nil)
5837 (statep
5838 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5839 (match-string 1)))
5840 (clockp
5841 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5842 (match-string 1)))))
5843 (if (not (re-search-backward org-outline-regexp-bol nil t))
5844 (throw :skip nil)
5845 (goto-char (match-beginning 0))
5846 (setq hdmarker (org-agenda-new-marker)
5847 inherited-tags
5848 (or (eq org-agenda-show-inherited-tags 'always)
5849 (and (listp org-agenda-show-inherited-tags)
5850 (memq 'todo org-agenda-show-inherited-tags))
5851 (and (eq org-agenda-show-inherited-tags t)
5852 (or (eq org-agenda-use-tag-inheritance t)
5853 (memq 'todo org-agenda-use-tag-inheritance))))
5854 tags (org-get-tags-at nil (not inherited-tags))
5855 level (make-string (org-reduced-level (org-outline-level)) ? ))
5856 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5857 (setq txt (match-string 1))
5858 (when extra
5859 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5860 (setq txt (concat (substring txt 0 (match-beginning 1))
5861 " - " extra " " (match-string 2 txt)))
5862 (setq txt (concat txt " - " extra))))
5863 (setq txt (org-agenda-format-item
5864 (cond
5865 (closedp "Closed: ")
5866 (statep (concat "State: (" state ")"))
5867 (t (concat "Clocked: (" clocked ")")))
5868 txt level category tags timestr)))
5869 (setq priority 100000)
5870 (org-add-props txt props
5871 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5872 'priority priority 'level level
5873 'type "closed" 'date date
5874 'undone-face 'org-warning 'done-face 'org-agenda-done)
5875 (push txt ee))
5876 (goto-char (point-at-eol))))
5877 (nreverse ee)))
5879 (defun org-agenda-show-clocking-issues ()
5880 "Add overlays, showing issues with clocking.
5881 See also the user option `org-agenda-clock-consistency-checks'."
5882 (interactive)
5883 (let* ((org-time-clocksum-use-effort-durations nil)
5884 (pl org-agenda-clock-consistency-checks)
5885 (re (concat "^[ \t]*"
5886 org-clock-string
5887 "[ \t]+"
5888 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5889 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5890 (tlstart 0.)
5891 (tlend 0.)
5892 (maxtime (org-hh:mm-string-to-minutes
5893 (or (plist-get pl :max-duration) "24:00")))
5894 (mintime (org-hh:mm-string-to-minutes
5895 (or (plist-get pl :min-duration) 0)))
5896 (maxgap (org-hh:mm-string-to-minutes
5897 ;; default 30:00 means never complain
5898 (or (plist-get pl :max-gap) "30:00")))
5899 (gapok (mapcar 'org-hh:mm-string-to-minutes
5900 (plist-get pl :gap-ok-around)))
5901 (def-face (or (plist-get pl :default-face)
5902 '((:background "DarkRed") (:foreground "white"))))
5903 issue face m te ts dt ov)
5904 (goto-char (point-min))
5905 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5906 (setq issue nil face def-face)
5907 (catch 'next
5908 (setq m (org-get-at-bol 'org-marker)
5909 te nil ts nil)
5910 (unless (and m (markerp m))
5911 (setq issue "No valid clock line") (throw 'next t))
5912 (org-with-point-at m
5913 (save-excursion
5914 (goto-char (point-at-bol))
5915 (unless (looking-at re)
5916 (error "No valid Clock line")
5917 (throw 'next t))
5918 (unless (match-end 3)
5919 (setq issue "No end time"
5920 face (or (plist-get pl :no-end-time-face) face))
5921 (throw 'next t))
5922 (setq ts (match-string 1)
5923 te (match-string 3)
5924 ts (org-float-time
5925 (apply 'encode-time (org-parse-time-string ts)))
5926 te (org-float-time
5927 (apply 'encode-time (org-parse-time-string te)))
5928 dt (- te ts))))
5929 (cond
5930 ((> dt (* 60 maxtime))
5931 ;; a very long clocking chunk
5932 (setq issue (format "Clocking interval is very long: %s"
5933 (org-minutes-to-clocksum-string
5934 (floor (/ (float dt) 60.))))
5935 face (or (plist-get pl :long-face) face)))
5936 ((< dt (* 60 mintime))
5937 ;; a very short clocking chunk
5938 (setq issue (format "Clocking interval is very short: %s"
5939 (org-minutes-to-clocksum-string
5940 (floor (/ (float dt) 60.))))
5941 face (or (plist-get pl :short-face) face)))
5942 ((and (> tlend 0) (< ts tlend))
5943 ;; Two clock entries are overlapping
5944 (setq issue (format "Clocking overlap: %d minutes"
5945 (/ (- tlend ts) 60))
5946 face (or (plist-get pl :overlap-face) face)))
5947 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5948 ;; There is a gap, lets see if we need to report it
5949 (unless (org-agenda-check-clock-gap tlend ts gapok)
5950 (setq issue (format "Clocking gap: %d minutes"
5951 (/ (- ts tlend) 60))
5952 face (or (plist-get pl :gap-face) face))))
5953 (t nil)))
5954 (setq tlend (or te tlend) tlstart (or ts tlstart))
5955 (when issue
5956 ;; OK, there was some issue, add an overlay to show the issue
5957 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5958 (overlay-put ov 'before-string
5959 (concat
5960 (org-add-props
5961 (format "%-43s" (concat " " issue))
5963 'face face)
5964 "\n"))
5965 (overlay-put ov 'evaporate t)))))
5967 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5968 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5969 (catch 'exit
5970 (unless ok-list
5971 ;; there are no OK times for gaps...
5972 (throw 'exit nil))
5973 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5974 ;; This is more than 24 hours, so it is OK.
5975 ;; because we have at least one OK time, that must be in the
5976 ;; 24 hour interval.
5977 (throw 'exit t))
5978 ;; We have a shorter gap.
5979 ;; Now we have to get the minute of the day when these times are
5980 (let* ((t1dec (decode-time (seconds-to-time t1)))
5981 (t2dec (decode-time (seconds-to-time t2)))
5982 ;; compute the minute on the day
5983 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5984 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5985 (when (< min2 min1)
5986 ;; if min2 is smaller than min1, this means it is on the next day.
5987 ;; Wrap it to after midnight.
5988 (setq min2 (+ min2 1440)))
5989 ;; Now check if any of the OK times is in the gap
5990 (mapc (lambda (x)
5991 ;; Wrap the time to after midnight if necessary
5992 (if (< x min1) (setq x (+ x 1440)))
5993 ;; Check if in interval
5994 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5995 ok-list)
5996 ;; Nope, this gap is not OK
5997 nil)))
5999 (defun org-agenda-get-deadlines (&optional with-hour)
6000 "Return the deadline information for agenda display.
6001 When WITH-HOUR is non-nil, only return deadlines with an hour
6002 specification like [h]h:mm."
6003 (let* ((props (list 'mouse-face 'highlight
6004 'org-not-done-regexp org-not-done-regexp
6005 'org-todo-regexp org-todo-regexp
6006 'org-complex-heading-regexp org-complex-heading-regexp
6007 'help-echo
6008 (format "mouse-2 or RET jump to org file %s"
6009 (abbreviate-file-name buffer-file-name))))
6010 (regexp (if with-hour
6011 org-deadline-time-hour-regexp
6012 org-deadline-time-regexp))
6013 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6014 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6015 (dl0 (car org-agenda-deadline-leaders))
6016 (dl1 (nth 1 org-agenda-deadline-leaders))
6017 (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
6018 d2 diff dfrac wdays pos pos1 category level
6019 tags suppress-prewarning ee txt head face s todo-state
6020 show-all upcomingp donep timestr warntime inherited-tags ts-date)
6021 (goto-char (point-min))
6022 (while (re-search-forward regexp nil t)
6023 (catch :skip
6024 (org-agenda-skip)
6025 (setq s (match-string 1)
6026 txt nil
6027 pos (1- (match-beginning 1))
6028 todo-state (save-match-data (org-get-todo-state))
6029 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6030 (member todo-state
6031 org-agenda-repeating-timestamp-show-all))
6032 d2 (org-time-string-to-absolute
6033 s d1 'past show-all (current-buffer) pos)
6034 diff (- d2 d1))
6035 (setq suppress-prewarning
6036 (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
6037 (let ((item (buffer-substring (point-at-bol)
6038 (point-at-eol))))
6039 (save-match-data
6040 (and (string-match
6041 org-scheduled-time-regexp item)
6042 (match-string 1 item)))))))
6043 (cond
6044 ((not ds) nil)
6045 ;; The current item has a scheduled date (in ds), so
6046 ;; evaluate its prewarning lead time.
6047 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6048 ;; Use global prewarning-restart lead time.
6049 org-agenda-skip-deadline-prewarning-if-scheduled)
6050 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6051 'pre-scheduled)
6052 ;; Set prewarning to no earlier than scheduled.
6053 (min (- d2 (org-time-string-to-absolute
6054 ds d1 'past show-all (current-buffer) pos))
6055 org-deadline-warning-days))
6056 ;; Set prewarning to deadline.
6057 (t 0))))
6058 (setq wdays (if suppress-prewarning
6059 (let ((org-deadline-warning-days suppress-prewarning))
6060 (org-get-wdays s))
6061 (org-get-wdays s))
6062 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
6063 upcomingp (and todayp (> diff 0)))
6064 ;; When to show a deadline in the calendar:
6065 ;; If the expiration is within wdays warning time.
6066 ;; Past-due deadlines are only shown on the current date
6067 (if (and (or (and (<= diff wdays)
6068 (and todayp (not org-agenda-only-exact-dates)))
6069 (= diff 0)))
6070 (save-excursion
6071 ;; (setq todo-state (org-get-todo-state))
6072 (setq donep (member todo-state org-done-keywords))
6073 (if (and donep
6074 (or org-agenda-skip-deadline-if-done
6075 (not (= diff 0))))
6076 (setq txt nil)
6077 (setq category (org-get-category)
6078 warntime (get-text-property (point) 'org-appt-warntime))
6079 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6080 (throw :skip nil)
6081 (goto-char (match-end 0))
6082 (setq pos1 (match-beginning 0))
6083 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6084 (setq inherited-tags
6085 (or (eq org-agenda-show-inherited-tags 'always)
6086 (and (listp org-agenda-show-inherited-tags)
6087 (memq 'agenda org-agenda-show-inherited-tags))
6088 (and (eq org-agenda-show-inherited-tags t)
6089 (or (eq org-agenda-use-tag-inheritance t)
6090 (memq 'agenda org-agenda-use-tag-inheritance))))
6091 tags (org-get-tags-at pos1 (not inherited-tags)))
6092 (setq head (buffer-substring
6093 (point)
6094 (progn (skip-chars-forward "^\r\n")
6095 (point))))
6096 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6097 (setq timestr
6098 (concat (substring s (match-beginning 1)) " "))
6099 (setq timestr 'time))
6100 (setq txt (org-agenda-format-item
6101 (cond ((= diff 0) dl0)
6102 ((> diff 0)
6103 (if (functionp dl1)
6104 (funcall dl1 diff date)
6105 (format dl1 diff)))
6107 (if (functionp dl2)
6108 (funcall dl2 diff date)
6109 (format dl2 (if (string= dl2 dl1)
6110 diff (abs diff))))))
6111 head level category tags
6112 (if (not (= diff 0)) nil timestr)))))
6113 (when txt
6114 (setq face (org-agenda-deadline-face dfrac))
6115 (org-add-props txt props
6116 'org-marker (org-agenda-new-marker pos)
6117 'warntime warntime
6118 'level level
6119 'ts-date d2
6120 'org-hd-marker (org-agenda-new-marker pos1)
6121 'priority (+ (- diff)
6122 (org-get-priority txt))
6123 'todo-state todo-state
6124 'type (if upcomingp "upcoming-deadline" "deadline")
6125 'date (if upcomingp date d2)
6126 'face (if donep 'org-agenda-done face)
6127 'undone-face face 'done-face 'org-agenda-done)
6128 (push txt ee))))))
6129 (nreverse ee)))
6131 (defun org-agenda-deadline-face (fraction)
6132 "Return the face to displaying a deadline item.
6133 FRACTION is what fraction of the head-warning time has passed."
6134 (let ((faces org-agenda-deadline-faces) f)
6135 (catch 'exit
6136 (while (setq f (pop faces))
6137 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6139 (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
6140 "Return the scheduled information for agenda display.
6141 When WITH-HOUR is non-nil, only return scheduled items with
6142 an hour specification like [h]h:mm."
6143 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6144 'org-todo-regexp org-todo-regexp
6145 'org-complex-heading-regexp org-complex-heading-regexp
6146 'done-face 'org-agenda-done
6147 'mouse-face 'highlight
6148 'help-echo
6149 (format "mouse-2 or RET jump to org file %s"
6150 (abbreviate-file-name buffer-file-name))))
6151 (regexp (if with-hour
6152 org-scheduled-time-hour-regexp
6153 org-scheduled-time-regexp))
6154 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6155 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6157 (deadline-position-alist
6158 (mapcar (lambda (a) (and (setq mm (get-text-property
6159 0 'org-hd-marker a))
6160 (cons (marker-position mm) a)))
6161 deadline-results))
6162 d2 diff pos pos1 category level tags donep
6163 ee txt head pastschedp todo-state face timestr s habitp show-all
6164 did-habit-check-p warntime inherited-tags ts-date suppress-delay
6165 ddays)
6166 (goto-char (point-min))
6167 (while (re-search-forward regexp nil t)
6168 (catch :skip
6169 (org-agenda-skip)
6170 (setq s (match-string 1)
6171 txt nil
6172 pos (1- (match-beginning 1))
6173 todo-state (save-match-data (org-get-todo-state))
6174 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6175 (member todo-state
6176 org-agenda-repeating-timestamp-show-all))
6177 d2 (org-time-string-to-absolute
6178 s d1 'past show-all (current-buffer) pos)
6179 diff (- d2 d1)
6180 warntime (get-text-property (point) 'org-appt-warntime))
6181 (setq pastschedp (and todayp (< diff 0)))
6182 (setq did-habit-check-p nil)
6183 (setq suppress-delay
6184 (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
6185 (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
6186 (save-match-data
6187 (and (string-match
6188 org-deadline-time-regexp item)
6189 (match-string 1 item)))))))
6190 (cond
6191 ((not ds) nil)
6192 ;; The current item has a deadline date (in ds), so
6193 ;; evaluate its delay time.
6194 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6195 ;; Use global delay time.
6196 (- org-agenda-skip-scheduled-delay-if-deadline))
6197 ((eq org-agenda-skip-scheduled-delay-if-deadline
6198 'post-deadline)
6199 ;; Set delay to no later than deadline.
6200 (min (- d2 (org-time-string-to-absolute
6201 ds d1 'past show-all (current-buffer) pos))
6202 org-scheduled-delay-days))
6203 (t 0))))
6204 (setq ddays (if suppress-delay
6205 (let ((org-scheduled-delay-days suppress-delay))
6206 (org-get-wdays s t t))
6207 (org-get-wdays s t)))
6208 ;; Use a delay of 0 when there is a repeater and the delay is
6209 ;; of the form --3d
6210 (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6211 (< (org-time-string-to-absolute s)
6212 (org-time-string-to-absolute
6213 s d2 'past nil (current-buffer) pos)))
6214 (setq ddays 0))
6215 ;; When to show a scheduled item in the calendar:
6216 ;; If it is on or past the date.
6217 (when (or (and (> ddays 0) (= diff (- ddays)))
6218 (and (zerop ddays) (= diff 0))
6219 (and (< (+ diff ddays) 0)
6220 (< (abs diff) org-scheduled-past-days)
6221 (and todayp (not org-agenda-only-exact-dates)))
6222 ;; org-is-habit-p uses org-entry-get, which is expansive
6223 ;; so we go extra mile to only call it once
6224 (and todayp
6225 (boundp 'org-habit-show-all-today)
6226 org-habit-show-all-today
6227 (setq did-habit-check-p t)
6228 (setq habitp (and (functionp 'org-is-habit-p)
6229 (org-is-habit-p)))))
6230 (save-excursion
6231 (setq donep (member todo-state org-done-keywords))
6232 (if (and donep
6233 (or org-agenda-skip-scheduled-if-done
6234 (not (= diff 0))
6235 (and (functionp 'org-is-habit-p)
6236 (org-is-habit-p))))
6237 (setq txt nil)
6238 (setq habitp (if did-habit-check-p habitp
6239 (and (functionp 'org-is-habit-p)
6240 (org-is-habit-p))))
6241 (setq category (org-get-category))
6242 (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
6243 'repeated-after-deadline)
6244 (org-get-deadline-time (point))
6245 (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
6246 (throw :skip nil))
6247 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6248 (throw :skip nil)
6249 (goto-char (match-end 0))
6250 (setq pos1 (match-beginning 0))
6251 (if habitp
6252 (if (or (not org-habit-show-habits)
6253 (and (not todayp)
6254 (boundp 'org-habit-show-habits-only-for-today)
6255 org-habit-show-habits-only-for-today))
6256 (throw :skip nil))
6257 (if (and
6258 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
6259 (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
6260 pastschedp))
6261 (setq mm (assoc pos1 deadline-position-alist)))
6262 (throw :skip nil)))
6263 (setq inherited-tags
6264 (or (eq org-agenda-show-inherited-tags 'always)
6265 (and (listp org-agenda-show-inherited-tags)
6266 (memq 'agenda org-agenda-show-inherited-tags))
6267 (and (eq org-agenda-show-inherited-tags t)
6268 (or (eq org-agenda-use-tag-inheritance t)
6269 (memq 'agenda org-agenda-use-tag-inheritance))))
6271 tags (org-get-tags-at nil (not inherited-tags)))
6272 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6273 (setq head (buffer-substring
6274 (point)
6275 (progn (skip-chars-forward "^\r\n") (point))))
6276 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6277 (setq timestr
6278 (concat (substring s (match-beginning 1)) " "))
6279 (setq timestr 'time))
6280 (setq txt (org-agenda-format-item
6281 (if (= diff 0)
6282 (car org-agenda-scheduled-leaders)
6283 (format (nth 1 org-agenda-scheduled-leaders)
6284 (- 1 diff)))
6285 head level category tags
6286 (if (not (= diff 0)) nil timestr)
6287 nil habitp))))
6288 (when txt
6289 (setq face
6290 (cond
6291 ((and (not habitp) pastschedp)
6292 'org-scheduled-previously)
6293 (todayp 'org-scheduled-today)
6294 (t 'org-scheduled))
6295 habitp (and habitp (org-habit-parse-todo)))
6296 (org-add-props txt props
6297 'undone-face face
6298 'face (if donep 'org-agenda-done face)
6299 'org-marker (org-agenda-new-marker pos)
6300 'org-hd-marker (org-agenda-new-marker pos1)
6301 'type (if pastschedp "past-scheduled" "scheduled")
6302 'date (if pastschedp d2 date)
6303 'ts-date d2
6304 'warntime warntime
6305 'level level
6306 'priority (if habitp
6307 (org-habit-get-priority habitp)
6308 (+ 94 (- 5 diff) (org-get-priority txt)))
6309 'org-habit-p habitp
6310 'todo-state todo-state)
6311 (push txt ee))))))
6312 (nreverse ee)))
6314 (defun org-agenda-get-blocks ()
6315 "Return the date-range information for agenda display."
6316 (let* ((props (list 'face nil
6317 'org-not-done-regexp org-not-done-regexp
6318 'org-todo-regexp org-todo-regexp
6319 'org-complex-heading-regexp org-complex-heading-regexp
6320 'mouse-face 'highlight
6321 'help-echo
6322 (format "mouse-2 or RET jump to org file %s"
6323 (abbreviate-file-name buffer-file-name))))
6324 (regexp org-tr-regexp)
6325 (d0 (calendar-absolute-from-gregorian date))
6326 marker hdmarker ee txt d1 d2 s1 s2 category
6327 level todo-state tags pos head donep inherited-tags)
6328 (goto-char (point-min))
6329 (while (re-search-forward regexp nil t)
6330 (catch :skip
6331 (org-agenda-skip)
6332 (setq pos (point))
6333 (let ((start-time (match-string 1))
6334 (end-time (match-string 2)))
6335 (setq s1 (match-string 1)
6336 s2 (match-string 2)
6337 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6338 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6339 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6340 ;; Only allow days between the limits, because the normal
6341 ;; date stamps will catch the limits.
6342 (save-excursion
6343 (setq todo-state (org-get-todo-state))
6344 (setq donep (member todo-state org-done-keywords))
6345 (if (and donep org-agenda-skip-timestamp-if-done)
6346 (throw :skip t))
6347 (setq marker (org-agenda-new-marker (point))
6348 category (org-get-category))
6349 (if (not (re-search-backward org-outline-regexp-bol nil t))
6350 (throw :skip nil)
6351 (goto-char (match-beginning 0))
6352 (setq hdmarker (org-agenda-new-marker (point))
6353 inherited-tags
6354 (or (eq org-agenda-show-inherited-tags 'always)
6355 (and (listp org-agenda-show-inherited-tags)
6356 (memq 'agenda org-agenda-show-inherited-tags))
6357 (and (eq org-agenda-show-inherited-tags t)
6358 (or (eq org-agenda-use-tag-inheritance t)
6359 (memq 'agenda org-agenda-use-tag-inheritance))))
6361 tags (org-get-tags-at nil (not inherited-tags)))
6362 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6363 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6364 (setq head (match-string 1))
6365 (let ((remove-re
6366 (if org-agenda-remove-timeranges-from-blocks
6367 (concat
6368 "<" (regexp-quote s1) ".*?>"
6369 "--"
6370 "<" (regexp-quote s2) ".*?>")
6371 nil)))
6372 (setq txt (org-agenda-format-item
6373 (format
6374 (nth (if (= d1 d2) 0 1)
6375 org-agenda-timerange-leaders)
6376 (1+ (- d0 d1)) (1+ (- d2 d1)))
6377 head level category tags
6378 (cond ((and (= d1 d0) (= d2 d0))
6379 (concat "<" start-time ">--<" end-time ">"))
6380 ((= d1 d0)
6381 (concat "<" start-time ">"))
6382 ((= d2 d0)
6383 (concat "<" end-time ">")))
6384 remove-re))))
6385 (org-add-props txt props
6386 'org-marker marker 'org-hd-marker hdmarker
6387 'type "block" 'date date
6388 'level level
6389 'todo-state todo-state
6390 'priority (org-get-priority txt))
6391 (push txt ee))))
6392 (goto-char pos)))
6393 ;; Sort the entries by expiration date.
6394 (nreverse ee)))
6396 ;;; Agenda presentation and sorting
6398 (defvar org-prefix-has-time nil
6399 "A flag, set by `org-compile-prefix-format'.
6400 The flag is set if the currently compiled format contains a `%t'.")
6401 (defvar org-prefix-has-tag nil
6402 "A flag, set by `org-compile-prefix-format'.
6403 The flag is set if the currently compiled format contains a `%T'.")
6404 (defvar org-prefix-has-effort nil
6405 "A flag, set by `org-compile-prefix-format'.
6406 The flag is set if the currently compiled format contains a `%e'.")
6407 (defvar org-prefix-has-breadcrumbs nil
6408 "A flag, set by `org-compile-prefix-format'.
6409 The flag is set if the currently compiled format contains a `%b'.")
6410 (defvar org-prefix-category-length nil
6411 "Used by `org-compile-prefix-format' to remember the category field width.")
6412 (defvar org-prefix-category-max-length nil
6413 "Used by `org-compile-prefix-format' to remember the category field width.")
6415 (defun org-agenda-get-category-icon (category)
6416 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6417 (dolist (entry org-agenda-category-icon-alist)
6418 (when (org-string-match-p (car entry) category)
6419 (if (listp (cadr entry))
6420 (return (cadr entry))
6421 (return (apply 'create-image (cdr entry)))))))
6423 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6424 remove-re habitp)
6425 "Format TXT to be inserted into the agenda buffer.
6426 In particular, add the prefix and corresponding text properties.
6428 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6429 LEVEL may be a string to replace the `%l' specifier.
6430 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6431 category taken from local variable or file name. It will replace the `%c'
6432 specifier in the format.
6433 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6434 TXT for sorting of this entry, and for the `%t' specifier in the format.
6435 When DOTIME is a string, this string is searched for a time before TXT is.
6436 TAGS can be the tags of the headline.
6437 Any match of REMOVE-RE will be removed from TXT."
6438 ;; We keep the org-prefix-* variable values along with a compiled
6439 ;; formatter, so that multiple agendas existing at the same time do
6440 ;; not step on each other toes.
6442 ;; It was inconvenient to make these variables buffer local in
6443 ;; Agenda buffers, because this function expects to be called with
6444 ;; the buffer where item comes from being current, and not agenda
6445 ;; buffer
6446 (let* ((bindings (car org-prefix-format-compiled))
6447 (formatter (cadr org-prefix-format-compiled)))
6448 (loop for (var value) in bindings
6449 do (set var value))
6450 (save-match-data
6451 ;; Diary entries sometimes have extra whitespace at the beginning
6452 (setq txt (org-trim txt))
6454 ;; Fix the tags part in txt
6455 (setq txt (org-agenda-fix-displayed-tags
6456 txt tags
6457 org-agenda-show-inherited-tags
6458 org-agenda-hide-tags-regexp))
6460 (let* ((category (or category
6461 (if buffer-file-name
6462 (file-name-sans-extension
6463 (file-name-nondirectory buffer-file-name))
6464 "")))
6465 (category-icon (org-agenda-get-category-icon category))
6466 (category-icon (if category-icon
6467 (propertize " " 'display category-icon)
6468 ""))
6469 (effort (and (not (string= txt ""))
6470 (get-text-property 1 'effort txt)))
6471 ;; time, tag, effort are needed for the eval of the prefix format
6472 (tag (if tags (nth (1- (length tags)) tags) ""))
6473 time
6474 (ts (if dotime (concat
6475 (if (stringp dotime) dotime "")
6476 (and org-agenda-search-headline-for-time txt))))
6477 (time-of-day (and dotime (org-get-time-of-day ts)))
6478 stamp plain s0 s1 s2 rtn srp l
6479 duration breadcrumbs)
6480 (and (derived-mode-p 'org-mode) buffer-file-name
6481 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6482 (when (and dotime time-of-day)
6483 ;; Extract starting and ending time and move them to prefix
6484 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6485 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6486 (setq s0 (match-string 0 ts)
6487 srp (and stamp (match-end 3))
6488 s1 (match-string (if plain 1 2) ts)
6489 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6491 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6492 ;; them, we might want to remove them there to avoid duplication.
6493 ;; The user can turn this off with a variable.
6494 (if (and org-prefix-has-time
6495 org-agenda-remove-times-when-in-prefix (or stamp plain)
6496 (string-match (concat (regexp-quote s0) " *") txt)
6497 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6498 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6499 (= (match-beginning 0) 0)
6501 (setq txt (replace-match "" nil nil txt))))
6502 ;; Normalize the time(s) to 24 hour
6503 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6504 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6506 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6507 (let (org-time-clocksum-use-effort-durations)
6508 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6509 (setq s2
6510 (org-minutes-to-clocksum-string
6511 (+ (org-hh:mm-string-to-minutes s1)
6512 org-agenda-default-appointment-duration)))))
6514 ;; Compute the duration
6515 (when s2
6516 (setq duration (- (org-hh:mm-string-to-minutes s2)
6517 (org-hh:mm-string-to-minutes s1)))))
6519 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6520 txt)
6521 ;; Tags are in the string
6522 (if (or (eq org-agenda-remove-tags t)
6523 (and org-agenda-remove-tags
6524 org-prefix-has-tag))
6525 (setq txt (replace-match "" t t txt))
6526 (setq txt (replace-match
6527 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6528 (match-string 2 txt))
6529 t t txt))))
6531 (when remove-re
6532 (while (string-match remove-re txt)
6533 (setq txt (replace-match "" t t txt))))
6535 ;; Set org-heading property on `txt' to mark the start of the
6536 ;; heading.
6537 (add-text-properties 0 (length txt) '(org-heading t) txt)
6539 ;; Prepare the variables needed in the eval of the compiled format
6540 (if org-prefix-has-breadcrumbs
6541 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6542 (let ((s (org-display-outline-path nil nil "->" t)))
6543 (if (eq "" s) "" (concat s "->"))))))
6544 (setq time (cond (s2 (concat
6545 (org-agenda-time-of-day-to-ampm-maybe s1)
6546 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6547 (if org-agenda-timegrid-use-ampm " ")))
6548 (s1 (concat
6549 (org-agenda-time-of-day-to-ampm-maybe s1)
6550 (if org-agenda-timegrid-use-ampm
6551 "........ "
6552 "......")))
6553 (t ""))
6554 extra (or (and (not habitp) extra) "")
6555 category (if (symbolp category) (symbol-name category) category)
6556 level (or level ""))
6557 (if (string-match org-bracket-link-regexp category)
6558 (progn
6559 (setq l (if (match-end 3)
6560 (- (match-end 3) (match-beginning 3))
6561 (- (match-end 1) (match-beginning 1))))
6562 (when (< l (or org-prefix-category-length 0))
6563 (setq category (copy-sequence category))
6564 (org-add-props category nil
6565 'extra-space (make-string
6566 (- org-prefix-category-length l 1) ?\ ))))
6567 (if (and org-prefix-category-max-length
6568 (>= (length category) org-prefix-category-max-length))
6569 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6570 ;; Evaluate the compiled format
6571 (setq rtn (concat (eval formatter) txt))
6573 ;; And finally add the text properties
6574 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6575 (org-add-props rtn nil
6576 'org-category category
6577 'tags (mapcar 'org-downcase-keep-props tags)
6578 'org-highest-priority org-highest-priority
6579 'org-lowest-priority org-lowest-priority
6580 'time-of-day time-of-day
6581 'duration duration
6582 'breadcrumbs breadcrumbs
6583 'txt txt
6584 'level level
6585 'time time
6586 'extra extra
6587 'format org-prefix-format-compiled
6588 'dotime dotime)))))
6590 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6591 "Remove tags string from TXT, and add a modified list of tags.
6592 The modified list may contain inherited tags, and tags matched by
6593 `org-agenda-hide-tags-regexp' will be removed."
6594 (when (or add-inherited hide-re)
6595 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6596 (setq txt (substring txt 0 (match-beginning 0))))
6597 (setq tags
6598 (delq nil
6599 (mapcar (lambda (tg)
6600 (if (or (and hide-re (string-match hide-re tg))
6601 (and (not add-inherited)
6602 (get-text-property 0 'inherited tg)))
6604 tg))
6605 tags)))
6606 (when tags
6607 (let ((have-i (get-text-property 0 'inherited (car tags)))
6609 (setq txt (concat txt " :"
6610 (mapconcat
6611 (lambda (x)
6612 (setq i (get-text-property 0 'inherited x))
6613 (if (and have-i (not i))
6614 (progn
6615 (setq have-i nil)
6616 (concat ":" x))
6618 tags ":")
6619 (if have-i "::" ":"))))))
6620 txt)
6622 (defun org-downcase-keep-props (s)
6623 (let ((props (text-properties-at 0 s)))
6624 (setq s (downcase s))
6625 (add-text-properties 0 (length s) props s)
6628 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6630 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6631 "Add a time-grid for agenda items which need it.
6633 LIST is the list of agenda items formatted by `org-agenda-list'.
6634 NDAYS is the span of the current agenda view.
6635 TODAYP is `t' when the current agenda view is on today."
6636 (catch 'exit
6637 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6638 ((and todayp (member 'today (car org-agenda-time-grid))))
6639 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6640 ((member 'weekly (car org-agenda-time-grid)))
6641 (t (throw 'exit list)))
6642 (let* ((have (delq nil (mapcar
6643 (lambda (x) (get-text-property 1 'time-of-day x))
6644 list)))
6645 (string (nth 1 org-agenda-time-grid))
6646 (gridtimes (nth 2 org-agenda-time-grid))
6647 (req (car org-agenda-time-grid))
6648 (remove (member 'remove-match req))
6649 new time)
6650 (if (and (member 'require-timed req) (not have))
6651 ;; don't show empty grid
6652 (throw 'exit list))
6653 (while (setq time (pop gridtimes))
6654 (unless (and remove (member time have))
6655 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6656 (push (org-agenda-format-item
6657 nil string nil "" nil
6658 (concat (substring time 0 -2) ":" (substring time -2)))
6659 new)
6660 (put-text-property
6661 2 (length (car new)) 'face 'org-time-grid (car new))))
6662 (when (and todayp org-agenda-show-current-time-in-grid)
6663 (push (org-agenda-format-item
6664 nil org-agenda-current-time-string nil "" nil
6665 (format-time-string "%H:%M "))
6666 new)
6667 (put-text-property
6668 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6670 (if (member 'time-up org-agenda-sorting-strategy-selected)
6671 (append new list)
6672 (append list new)))))
6674 (defun org-compile-prefix-format (key)
6675 "Compile the prefix format into a Lisp form that can be evaluated.
6676 The resulting form and associated variable bindings is returned
6677 and stored in the variable `org-prefix-format-compiled'."
6678 (setq org-prefix-has-time nil
6679 org-prefix-has-tag nil
6680 org-prefix-category-length nil
6681 org-prefix-has-effort nil
6682 org-prefix-has-breadcrumbs nil)
6683 (let ((s (cond
6684 ((stringp org-agenda-prefix-format)
6685 org-agenda-prefix-format)
6686 ((assq key org-agenda-prefix-format)
6687 (cdr (assq key org-agenda-prefix-format)))
6688 (t " %-12:c%?-12t% s")))
6689 (start 0)
6690 varform vars var e c f opt)
6691 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6692 s start)
6693 (setq var (or (cdr (assoc (match-string 4 s)
6694 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6695 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6696 'eval)
6697 c (or (match-string 3 s) "")
6698 opt (match-beginning 1)
6699 start (1+ (match-beginning 0)))
6700 (if (equal var 'time) (setq org-prefix-has-time t))
6701 (if (equal var 'tag) (setq org-prefix-has-tag t))
6702 (if (equal var 'effort) (setq org-prefix-has-effort t))
6703 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6704 (setq f (concat "%" (match-string 2 s) "s"))
6705 (when (equal var 'category)
6706 (setq org-prefix-category-length
6707 (floor (abs (string-to-number (match-string 2 s)))))
6708 (setq org-prefix-category-max-length
6709 (let ((x (match-string 2 s)))
6710 (save-match-data
6711 (if (string-match "\\.[0-9]+" x)
6712 (string-to-number (substring (match-string 0 x) 1)))))))
6713 (if (eq var 'eval)
6714 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6715 (if opt
6716 (setq varform
6717 `(if (or (equal "" ,var) (equal nil ,var))
6719 (format ,f (concat ,var ,c))))
6720 (setq varform
6721 `(format ,f (if (or (equal ,var "")
6722 (equal ,var nil)) ""
6723 (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6724 (setq s (replace-match "%s" t nil s))
6725 (push varform vars))
6726 (setq vars (nreverse vars))
6727 (with-current-buffer (or org-agenda-buffer (current-buffer))
6728 (setq org-prefix-format-compiled
6729 (list
6730 `((org-prefix-has-time ,org-prefix-has-time)
6731 (org-prefix-has-tag ,org-prefix-has-tag)
6732 (org-prefix-category-length ,org-prefix-category-length)
6733 (org-prefix-has-effort ,org-prefix-has-effort)
6734 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6735 `(format ,s ,@vars))))))
6737 (defun org-set-sorting-strategy (key)
6738 (if (symbolp (car org-agenda-sorting-strategy))
6739 ;; the old format
6740 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6741 (setq org-agenda-sorting-strategy-selected
6742 (or (cdr (assq key org-agenda-sorting-strategy))
6743 (cdr (assq 'agenda org-agenda-sorting-strategy))
6744 '(time-up category-keep priority-down)))))
6746 (defun org-get-time-of-day (s &optional string mod24)
6747 "Check string S for a time of day.
6748 If found, return it as a military time number between 0 and 2400.
6749 If not found, return nil.
6750 The optional STRING argument forces conversion into a 5 character wide string
6751 HH:MM."
6752 (save-match-data
6753 (when
6754 (and
6755 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6756 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6757 (not (eq (get-text-property 1 'face s) 'org-link)))
6758 (let* ((h (string-to-number (match-string 1 s)))
6759 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6760 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6761 (am-p (equal ampm "am"))
6762 (h1 (cond ((not ampm) h)
6763 ((= h 12) (if am-p 0 12))
6764 (t (+ h (if am-p 0 12)))))
6765 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6766 (mod h1 24) h1))
6767 (t0 (+ (* 100 h2) m))
6768 (t1 (concat (if (>= h1 24) "+" " ")
6769 (if (and org-agenda-time-leading-zero
6770 (< t0 1000)) "0" "")
6771 (if (< t0 100) "0" "")
6772 (if (< t0 10) "0" "")
6773 (int-to-string t0))))
6774 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6776 (defvar org-agenda-before-sorting-filter-function nil
6777 "Function to be applied to agenda items prior to sorting.
6778 Prior to sorting also means just before they are inserted into the agenda.
6780 To aid sorting, you may revisit the original entries and add more text
6781 properties which will later be used by the sorting functions.
6783 The function should take a string argument, an agenda line.
6784 It has access to the text properties in that line, which contain among
6785 other things, the property `org-hd-marker' that points to the entry
6786 where the line comes from. Note that not all lines going into the agenda
6787 have this property, only most.
6789 The function should return the modified string. It is probably best
6790 to ONLY change text properties.
6792 You can also use this function as a filter, by returning nil for lines
6793 you don't want to have in the agenda at all. For this application, you
6794 could bind the variable in the options section of a custom command.")
6796 (defun org-agenda-finalize-entries (list &optional type)
6797 "Sort, limit and concatenate the LIST of agenda items.
6798 The optional argument TYPE tells the agenda type."
6799 (let ((max-effort (cond ((listp org-agenda-max-effort)
6800 (cdr (assoc type org-agenda-max-effort)))
6801 (t org-agenda-max-effort)))
6802 (max-todo (cond ((listp org-agenda-max-todos)
6803 (cdr (assoc type org-agenda-max-todos)))
6804 (t org-agenda-max-todos)))
6805 (max-tags (cond ((listp org-agenda-max-tags)
6806 (cdr (assoc type org-agenda-max-tags)))
6807 (t org-agenda-max-tags)))
6808 (max-entries (cond ((listp org-agenda-max-entries)
6809 (cdr (assoc type org-agenda-max-entries)))
6810 (t org-agenda-max-entries))))
6811 (when org-agenda-before-sorting-filter-function
6812 (setq list
6813 (delq nil
6814 (mapcar
6815 org-agenda-before-sorting-filter-function list))))
6816 (setq list (mapcar 'org-agenda-highlight-todo list)
6817 list (mapcar 'identity (sort list 'org-entries-lessp)))
6818 (when max-effort
6819 (setq list (org-agenda-limit-entries
6820 list 'effort-minutes max-effort
6821 (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
6822 32767 -1))))))
6823 (when max-todo
6824 (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
6825 (when max-tags
6826 (setq list (org-agenda-limit-entries list 'tags max-tags)))
6827 (when max-entries
6828 (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
6829 (mapconcat 'identity list "\n")))
6831 (defun org-agenda-limit-entries (list prop limit &optional fn)
6832 "Limit the number of agenda entries."
6833 (let ((include (and limit (< limit 0))))
6834 (if limit
6835 (let ((fun (or fn (lambda (p) (if p 1))))
6836 (lim 0))
6837 (delq nil
6838 (mapcar
6839 (lambda (e)
6840 (let ((pval (funcall
6841 fun (get-text-property (1- (length e))
6842 prop e))))
6843 (if pval (setq lim (+ lim pval)))
6844 (cond ((and pval (<= lim (abs limit))) e)
6845 ((and include (not pval)) e))))
6846 list)))
6847 list)))
6849 (defun org-agenda-limit-interactively (remove)
6850 "In agenda, interactively limit entries to various maximums."
6851 (interactive "P")
6852 (if remove
6853 (progn (setq org-agenda-max-entries nil
6854 org-agenda-max-todos nil
6855 org-agenda-max-tags nil
6856 org-agenda-max-effort nil)
6857 (org-agenda-redo))
6858 (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
6859 (msg (cond ((= max ?E) "How many minutes? ")
6860 ((= max ?e) "How many entries? ")
6861 ((= max ?t) "How many TODO entries? ")
6862 ((= max ?T) "How many tagged entries? ")
6863 (t (user-error "Wrong input"))))
6864 (num (string-to-number (read-from-minibuffer msg))))
6865 (cond ((equal max ?e)
6866 (let ((org-agenda-max-entries num)) (org-agenda-redo)))
6867 ((equal max ?t)
6868 (let ((org-agenda-max-todos num)) (org-agenda-redo)))
6869 ((equal max ?T)
6870 (let ((org-agenda-max-tags num)) (org-agenda-redo)))
6871 ((equal max ?E)
6872 (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
6873 (org-agenda-fit-window-to-buffer))
6875 (defun org-agenda-highlight-todo (x)
6876 (let ((org-done-keywords org-done-keywords-for-agenda)
6877 (case-fold-search nil)
6879 (if (eq x 'line)
6880 (save-excursion
6881 (beginning-of-line 1)
6882 (setq re (org-get-at-bol 'org-todo-regexp))
6883 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6884 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6885 (add-text-properties (match-beginning 0) (match-end 1)
6886 (list 'face (org-get-todo-face 1)))
6887 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6888 (delete-region (match-beginning 1) (1- (match-end 0)))
6889 (goto-char (match-beginning 1))
6890 (insert (format org-agenda-todo-keyword-format s)))))
6891 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6892 (setq re (get-text-property 0 'org-todo-regexp x))
6893 (when (and re
6894 ;; Test `pl' because if there's no heading content,
6895 ;; there's no point matching to highlight. Note
6896 ;; that if we didn't test `pl' first, and there
6897 ;; happened to be no keyword from `org-todo-regexp'
6898 ;; on this heading line, then the `equal' comparison
6899 ;; afterwards would spuriously succeed in the case
6900 ;; where `pl' is nil -- causing an args-out-of-range
6901 ;; error when we try to add text properties to text
6902 ;; that isn't there.
6904 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6905 x pl) pl))
6906 (add-text-properties
6907 (or (match-end 1) (match-end 0)) (match-end 0)
6908 (list 'face (org-get-todo-face (match-string 2 x)))
6910 (when (match-end 1)
6911 (setq x (concat (substring x 0 (match-end 1))
6912 (format org-agenda-todo-keyword-format
6913 (match-string 2 x))
6914 (org-add-props " " (text-properties-at 0 x))
6915 (substring x (match-end 3)))))))
6916 x)))
6918 (defsubst org-cmp-values (a b property)
6919 "Compare the numeric value of text PROPERTY for string A and B."
6920 (let ((pa (or (get-text-property (1- (length a)) property a) 0))
6921 (pb (or (get-text-property (1- (length b)) property b) 0)))
6922 (cond ((> pa pb) +1)
6923 ((< pa pb) -1))))
6925 (defsubst org-cmp-effort (a b)
6926 "Compare the effort values of string A and B."
6927 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6928 (ea (or (get-text-property (1- (length a)) 'effort-minutes a) def))
6929 (eb (or (get-text-property (1- (length b)) 'effort-minutes b) def)))
6930 (cond ((> ea eb) +1)
6931 ((< ea eb) -1))))
6933 (defsubst org-cmp-category (a b)
6934 "Compare the string values of categories of strings A and B."
6935 (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
6936 (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
6937 (cond ((string-lessp ca cb) -1)
6938 ((string-lessp cb ca) +1))))
6940 (defsubst org-cmp-todo-state (a b)
6941 "Compare the todo states of strings A and B."
6942 (let* ((ma (or (get-text-property 1 'org-marker a)
6943 (get-text-property 1 'org-hd-marker a)))
6944 (mb (or (get-text-property 1 'org-marker b)
6945 (get-text-property 1 'org-hd-marker b)))
6946 (fa (and ma (marker-buffer ma)))
6947 (fb (and mb (marker-buffer mb)))
6948 (todo-kwds
6949 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6950 (and fb (with-current-buffer fb org-todo-keywords-1))))
6951 (ta (or (get-text-property 1 'todo-state a) ""))
6952 (tb (or (get-text-property 1 'todo-state b) ""))
6953 (la (- (length (member ta todo-kwds))))
6954 (lb (- (length (member tb todo-kwds))))
6955 (donepa (member ta org-done-keywords-for-agenda))
6956 (donepb (member tb org-done-keywords-for-agenda)))
6957 (cond ((and donepa (not donepb)) -1)
6958 ((and (not donepa) donepb) +1)
6959 ((< la lb) -1)
6960 ((< lb la) +1))))
6962 (defsubst org-cmp-alpha (a b)
6963 "Compare the headlines, alphabetically."
6964 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6965 (plb (text-property-any 0 (length b) 'org-heading t b))
6966 (ta (and pla (substring a pla)))
6967 (tb (and plb (substring b plb))))
6968 (when pla
6969 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6970 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6971 (setq ta (substring ta (match-end 0))))
6972 (setq ta (downcase ta)))
6973 (when plb
6974 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6975 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6976 (setq tb (substring tb (match-end 0))))
6977 (setq tb (downcase tb)))
6978 (cond ((not ta) +1)
6979 ((not tb) -1)
6980 ((string-lessp ta tb) -1)
6981 ((string-lessp tb ta) +1))))
6983 (defsubst org-cmp-tag (a b)
6984 "Compare the string values of the first tags of A and B."
6985 (let ((ta (car (last (get-text-property 1 'tags a))))
6986 (tb (car (last (get-text-property 1 'tags b)))))
6987 (cond ((not ta) +1)
6988 ((not tb) -1)
6989 ((string-lessp ta tb) -1)
6990 ((string-lessp tb ta) +1))))
6992 (defsubst org-cmp-time (a b)
6993 "Compare the time-of-day values of strings A and B."
6994 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6995 (ta (or (get-text-property 1 'time-of-day a) def))
6996 (tb (or (get-text-property 1 'time-of-day b) def)))
6997 (cond ((< ta tb) -1)
6998 ((< tb ta) +1))))
7000 (defsubst org-cmp-ts (a b type)
7001 "Compare the timestamps values of entries A and B.
7002 When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
7003 \"timestamp_ia\", compare within each of these type. When TYPE
7004 is the empty string, compare all timestamps without respect of
7005 their type."
7006 (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
7007 (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
7008 (get-text-property 1 'ts-date a))
7009 def))
7010 (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
7011 (get-text-property 1 'ts-date b))
7012 def)))
7013 (cond ((< ta tb) -1)
7014 ((< tb ta) +1))))
7016 (defsubst org-cmp-habit-p (a b)
7017 "Compare the todo states of strings A and B."
7018 (let ((ha (get-text-property 1 'org-habit-p a))
7019 (hb (get-text-property 1 'org-habit-p b)))
7020 (cond ((and ha (not hb)) -1)
7021 ((and (not ha) hb) +1))))
7023 (defun org-entries-lessp (a b)
7024 "Predicate for sorting agenda entries."
7025 ;; The following variables will be used when the form is evaluated.
7026 ;; So even though the compiler complains, keep them.
7027 (let* ((ss org-agenda-sorting-strategy-selected)
7028 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
7029 (org-cmp-ts a b "")))
7030 (timestamp-down (if timestamp-up (- timestamp-up) nil))
7031 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
7032 (org-cmp-ts a b "scheduled")))
7033 (scheduled-down (if scheduled-up (- scheduled-up) nil))
7034 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
7035 (org-cmp-ts a b "deadline")))
7036 (deadline-down (if deadline-up (- deadline-up) nil))
7037 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
7038 (org-cmp-ts a b "timestamp_ia")))
7039 (tsia-down (if tsia-up (- tsia-up) nil))
7040 (ts-up (and (org-em 'ts-up 'ts-down ss)
7041 (org-cmp-ts a b "timestamp")))
7042 (ts-down (if ts-up (- ts-up) nil))
7043 (time-up (and (org-em 'time-up 'time-down ss)
7044 (org-cmp-time a b)))
7045 (time-down (if time-up (- time-up) nil))
7046 (stats-up (and (org-em 'stats-up 'stats-down ss)
7047 (org-cmp-values a b 'org-stats)))
7048 (stats-down (if stats-up (- stats-up) nil))
7049 (priority-up (and (org-em 'priority-up 'priority-down ss)
7050 (org-cmp-values a b 'priority)))
7051 (priority-down (if priority-up (- priority-up) nil))
7052 (effort-up (and (org-em 'effort-up 'effort-down ss)
7053 (org-cmp-effort a b)))
7054 (effort-down (if effort-up (- effort-up) nil))
7055 (category-up (and (or (org-em 'category-up 'category-down ss)
7056 (memq 'category-keep ss))
7057 (org-cmp-category a b)))
7058 (category-down (if category-up (- category-up) nil))
7059 (category-keep (if category-up +1 nil))
7060 (tag-up (and (org-em 'tag-up 'tag-down ss)
7061 (org-cmp-tag a b)))
7062 (tag-down (if tag-up (- tag-up) nil))
7063 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
7064 (org-cmp-todo-state a b)))
7065 (todo-state-down (if todo-state-up (- todo-state-up) nil))
7066 (habit-up (and (org-em 'habit-up 'habit-down ss)
7067 (org-cmp-habit-p a b)))
7068 (habit-down (if habit-up (- habit-up) nil))
7069 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
7070 (org-cmp-alpha a b)))
7071 (alpha-down (if alpha-up (- alpha-up) nil))
7072 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
7073 user-defined-up user-defined-down)
7074 (if (and need-user-cmp org-agenda-cmp-user-defined
7075 (functionp org-agenda-cmp-user-defined))
7076 (setq user-defined-up
7077 (funcall org-agenda-cmp-user-defined a b)
7078 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7079 (cdr (assoc
7080 (eval (cons 'or org-agenda-sorting-strategy-selected))
7081 '((-1 . t) (1 . nil) (nil . nil))))))
7083 ;;; Agenda restriction lock
7085 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7086 "Overlay to mark the headline to which agenda commands are restricted.")
7087 (overlay-put org-agenda-restriction-lock-overlay
7088 'face 'org-agenda-restriction-lock)
7089 (overlay-put org-agenda-restriction-lock-overlay
7090 'help-echo "Agendas are currently limited to this subtree.")
7091 (org-detach-overlay org-agenda-restriction-lock-overlay)
7093 ;;;###autoload
7094 (defun org-agenda-set-restriction-lock (&optional type)
7095 "Set restriction lock for agenda, to current subtree or file.
7096 Restriction will be the file if TYPE is `file', or if type is the
7097 universal prefix '(4), or if the cursor is before the first headline
7098 in the file. Otherwise, restriction will be to the current subtree."
7099 (interactive "P")
7100 (org-agenda-remove-restriction-lock 'noupdate)
7101 (and (equal type '(4)) (setq type 'file))
7102 (setq type (cond
7103 (type type)
7104 ((org-at-heading-p) 'subtree)
7105 ((condition-case nil (org-back-to-heading t) (error nil))
7106 'subtree)
7107 (t 'file)))
7108 (if (eq type 'subtree)
7109 (progn
7110 (setq org-agenda-restrict (current-buffer))
7111 (setq org-agenda-overriding-restriction 'subtree)
7112 (put 'org-agenda-files 'org-restrict
7113 (list (buffer-file-name (buffer-base-buffer))))
7114 (org-back-to-heading t)
7115 (move-overlay org-agenda-restriction-lock-overlay
7116 (point)
7117 (if org-agenda-restriction-lock-highlight-subtree
7118 (save-excursion (org-end-of-subtree t t) (point))
7119 (point-at-eol)))
7120 (move-marker org-agenda-restrict-begin (point))
7121 (move-marker org-agenda-restrict-end
7122 (save-excursion (org-end-of-subtree t t)))
7123 (message "Locking agenda restriction to subtree"))
7124 (put 'org-agenda-files 'org-restrict
7125 (list (buffer-file-name (buffer-base-buffer))))
7126 (setq org-agenda-restrict nil)
7127 (setq org-agenda-overriding-restriction 'file)
7128 (move-marker org-agenda-restrict-begin nil)
7129 (move-marker org-agenda-restrict-end nil)
7130 (message "Locking agenda restriction to file"))
7131 (setq current-prefix-arg nil)
7132 (org-agenda-maybe-redo))
7134 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7135 "Remove the agenda restriction lock."
7136 (interactive "P")
7137 (org-detach-overlay org-agenda-restriction-lock-overlay)
7138 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7139 (setq org-agenda-overriding-restriction nil)
7140 (setq org-agenda-restrict nil)
7141 (put 'org-agenda-files 'org-restrict nil)
7142 (move-marker org-agenda-restrict-begin nil)
7143 (move-marker org-agenda-restrict-end nil)
7144 (setq current-prefix-arg nil)
7145 (message "Agenda restriction lock removed")
7146 (or noupdate (org-agenda-maybe-redo)))
7148 (defun org-agenda-maybe-redo ()
7149 "If there is any window showing the agenda view, update it."
7150 (let ((w (get-buffer-window org-agenda-buffer-name t))
7151 (w0 (selected-window)))
7152 (when w
7153 (select-window w)
7154 (org-agenda-redo)
7155 (select-window w0)
7156 (if org-agenda-overriding-restriction
7157 (message "Agenda view shifted to new %s restriction"
7158 org-agenda-overriding-restriction)
7159 (message "Agenda restriction lock removed")))))
7161 ;;; Agenda commands
7163 (defun org-agenda-check-type (error &rest types)
7164 "Check if agenda buffer is of allowed type.
7165 If ERROR is non-nil, throw an error, otherwise just return nil.
7166 Allowed types are 'agenda 'timeline 'todo 'tags 'search."
7167 (if (not org-agenda-type)
7168 (error "No Org agenda currently displayed")
7169 (if (memq org-agenda-type types)
7171 (if error
7172 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7173 nil))))
7175 (defun org-agenda-Quit ()
7176 "Exit the agenda and kill buffers loaded by `org-agenda'.
7177 Also restore the window configuration."
7178 (interactive)
7179 (if org-agenda-columns-active
7180 (org-columns-quit)
7181 (let ((buf (current-buffer)))
7182 (if (eq org-agenda-window-setup 'other-frame)
7183 (progn
7184 (org-agenda-reset-markers)
7185 (kill-buffer buf)
7186 (org-columns-remove-overlays)
7187 (setq org-agenda-archives-mode nil)
7188 (delete-frame))
7189 (and (not (eq org-agenda-window-setup 'current-window))
7190 (not (one-window-p))
7191 (delete-window))
7192 (org-agenda-reset-markers)
7193 (kill-buffer buf)
7194 (org-columns-remove-overlays)
7195 (setq org-agenda-archives-mode nil)))
7196 (setq org-agenda-buffer nil)
7197 ;; Maybe restore the pre-agenda window configuration.
7198 (and org-agenda-restore-windows-after-quit
7199 (not (eq org-agenda-window-setup 'other-frame))
7200 org-agenda-pre-window-conf
7201 (set-window-configuration org-agenda-pre-window-conf)
7202 (setq org-agenda-pre-window-conf nil))))
7204 (defun org-agenda-quit ()
7205 "Exit the agenda and restore the window configuration.
7206 When `org-agenda-sticky' is non-nil, only bury the agenda."
7207 (interactive)
7208 (if (and (eq org-indirect-buffer-display 'other-window)
7209 org-last-indirect-buffer)
7210 (let ((org-last-indirect-window
7211 (get-buffer-window org-last-indirect-buffer)))
7212 (if org-last-indirect-window
7213 (delete-window org-last-indirect-window))))
7214 (if org-agenda-columns-active
7215 (org-columns-quit)
7216 (if org-agenda-sticky
7217 (let ((buf (current-buffer)))
7218 (if (eq org-agenda-window-setup 'other-frame)
7219 (progn
7220 (delete-frame))
7221 (and (not (eq org-agenda-window-setup 'current-window))
7222 (not (one-window-p))
7223 (delete-window)))
7224 (with-current-buffer buf
7225 (bury-buffer)
7226 ;; Maybe restore the pre-agenda window configuration.
7227 (and org-agenda-restore-windows-after-quit
7228 (not (eq org-agenda-window-setup 'other-frame))
7229 org-agenda-pre-window-conf
7230 (set-window-configuration org-agenda-pre-window-conf)
7231 (setq org-agenda-pre-window-conf nil))))
7232 (org-agenda-Quit))))
7234 (defun org-agenda-exit ()
7235 "Exit the agenda and restore the window configuration.
7236 Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
7237 buffers visited directly by the user will not be touched."
7238 (interactive)
7239 (org-release-buffers org-agenda-new-buffers)
7240 (setq org-agenda-new-buffers nil)
7241 (org-agenda-Quit))
7243 (defun org-agenda-kill-all-agenda-buffers ()
7244 "Kill all buffers in `org-agenda-mode'.
7245 This is used when toggling sticky agendas.
7246 You can also explicitly invoke it with `C-c a C-k'."
7247 (interactive)
7248 (let (blist)
7249 (dolist (buf (buffer-list))
7250 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7251 (push buf blist)))
7252 (mapc 'kill-buffer blist)))
7254 (defun org-agenda-execute (arg)
7255 "Execute another agenda command, keeping same window.
7256 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7257 in the agenda."
7258 (interactive "P")
7259 (let ((org-agenda-window-setup 'current-window))
7260 (org-agenda arg)))
7262 (defun org-agenda-redo (&optional all)
7263 "Rebuild possibly ALL agenda view(s) in the current buffer."
7264 (interactive "P")
7265 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7266 (cpa (unless (eq all t) current-prefix-arg))
7267 (org-agenda-doing-sticky-redo org-agenda-sticky)
7268 (org-agenda-sticky nil)
7269 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7270 org-agenda-buffer-name))
7271 (org-agenda-keep-modes t)
7272 (tag-filter org-agenda-tag-filter)
7273 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7274 (top-hl-filter org-agenda-top-headline-filter)
7275 (cat-filter org-agenda-category-filter)
7276 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7277 (re-filter org-agenda-regexp-filter)
7278 (re-preset (get 'org-agenda-regexp-filter :preset-filter))
7279 (effort-filter org-agenda-effort-filter)
7280 (effort-preset (get 'org-agenda-effort-filter :preset-filter))
7281 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
7282 (cols org-agenda-columns-active)
7283 (line (org-current-line))
7284 (window-line (- line (org-current-line (window-start))))
7285 (lprops (get 'org-agenda-redo-command 'org-lprops))
7286 (redo-cmd (get-text-property p 'org-redo-cmd))
7287 (last-args (get-text-property p 'org-last-args))
7288 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7289 (org-agenda-overriding-cmd-arguments
7290 (unless (eq all t)
7291 (cond ((listp last-args)
7292 (cons (or cpa (car last-args)) (cdr last-args)))
7293 ((stringp last-args)
7294 last-args))))
7295 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7296 (put 'org-agenda-tag-filter :preset-filter nil)
7297 (put 'org-agenda-category-filter :preset-filter nil)
7298 (put 'org-agenda-regexp-filter :preset-filter nil)
7299 (put 'org-agenda-effort-filter :preset-filter nil)
7300 (and cols (org-columns-quit))
7301 (message "Rebuilding agenda buffer...")
7302 (if series-redo-cmd
7303 (eval series-redo-cmd)
7304 (org-let lprops redo-cmd))
7305 (setq org-agenda-undo-list nil
7306 org-agenda-pending-undo-list nil
7307 org-agenda-tag-filter tag-filter
7308 org-agenda-category-filter cat-filter
7309 org-agenda-regexp-filter re-filter
7310 org-agenda-effort-filter effort-filter
7311 org-agenda-top-headline-filter top-hl-filter)
7312 (message "Rebuilding agenda buffer...done")
7313 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7314 (put 'org-agenda-category-filter :preset-filter cat-preset)
7315 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7316 (put 'org-agenda-effort-filter :preset-filter effort-preset)
7317 (let ((tag (or tag-filter tag-preset))
7318 (cat (or cat-filter cat-preset))
7319 (effort (or effort-filter effort-preset))
7320 (re (or re-filter re-preset)))
7321 (when tag (org-agenda-filter-apply tag 'tag))
7322 (when cat (org-agenda-filter-apply cat 'category))
7323 (when effort (org-agenda-filter-apply effort 'effort))
7324 (when re (org-agenda-filter-apply re 'regexp)))
7325 (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
7326 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
7327 (org-goto-line line)
7328 (recenter window-line)))
7330 (defvar org-global-tags-completion-table nil)
7331 (defvar org-agenda-filter-form nil)
7332 (defvar org-agenda-filtered-by-category nil)
7334 (defun org-agenda-filter-by-category (strip)
7335 "Keep only those lines in the agenda buffer that have a specific category.
7336 The category is that of the current line."
7337 (interactive "P")
7338 (if (and org-agenda-filtered-by-category
7339 org-agenda-category-filter)
7340 (org-agenda-filter-show-all-cat)
7341 (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
7342 (cond
7343 ((and cat strip)
7344 (org-agenda-filter-apply
7345 (push (concat "-" cat) org-agenda-category-filter) 'category))
7346 ((and cat)
7347 (org-agenda-filter-apply
7348 (setq org-agenda-category-filter
7349 (list (concat "+" cat))) 'category))
7350 (t (error "No category at point"))))))
7352 (defun org-find-top-headline (&optional pos)
7353 "Find the topmost parent headline and return it."
7354 (save-excursion
7355 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
7356 (if pos (goto-char pos))
7357 ;; Skip up to the topmost parent
7358 (while (ignore-errors (outline-up-heading 1) t))
7359 (ignore-errors
7360 (nth 4 (org-heading-components))))))
7362 (defvar org-agenda-filtered-by-top-headline nil)
7363 (defun org-agenda-filter-by-top-headline (strip)
7364 "Keep only those lines that are descendants from the same top headline.
7365 The top headline is that of the current line."
7366 (interactive "P")
7367 (if org-agenda-filtered-by-top-headline
7368 (progn
7369 (setq org-agenda-filtered-by-top-headline nil
7370 org-agenda-top-headline-filter nil)
7371 (org-agenda-filter-show-all-top-filter))
7372 (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
7373 (if toph (org-agenda-filter-top-headline-apply toph strip)
7374 (error "No top-level headline at point")))))
7376 (defvar org-agenda-regexp-filter nil)
7377 (defun org-agenda-filter-by-regexp (strip)
7378 "Filter agenda entries by a regular expression.
7379 Regexp filters are cumulative.
7380 With no prefix argument, keep entries matching the regexp.
7381 With one prefix argument, filter out entries matching the regexp.
7382 With two prefix arguments, remove the regexp filters."
7383 (interactive "P")
7384 (if (not (equal strip '(16)))
7385 (let ((flt (concat (if (equal strip '(4)) "-" "+")
7386 (read-from-minibuffer
7387 (if (equal strip '(4))
7388 "Filter out entries matching regexp: "
7389 "Narrow to entries matching regexp: ")))))
7390 (push flt org-agenda-regexp-filter)
7391 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
7392 (org-agenda-filter-show-all-re)
7393 (message "Regexp filter removed")))
7395 (defvar org-agenda-effort-filter nil)
7396 (defun org-agenda-filter-by-effort (strip)
7397 "Filter agenda entries by effort.
7398 With no prefix argument, keep entries matching the effort condition.
7399 With one prefix argument, filter out entries matching the condition.
7400 With two prefix arguments, remove the effort filters."
7401 (interactive "P")
7402 (cond ((member strip '(nil 4))
7403 (let ((efforts (org-split-string
7404 (or (cdr (assoc (concat org-effort-property "_ALL")
7405 org-global-properties))
7406 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7407 "")))
7408 (eff -1)
7409 effort-prompt op)
7410 (while (not (member op '(?< ?> ?=)))
7411 (setq op (read-char-exclusive "Effort operator? (> = or <)")))
7412 (loop for i from 0 to 9 do
7413 (setq effort-prompt
7414 (concat
7415 effort-prompt " ["
7416 (if (= i 9) "0" (int-to-string (1+ i)))
7417 "]" (nth i efforts))))
7418 (message "Effort %s%s" (char-to-string op) effort-prompt)
7419 (while (or (< eff 0) (> eff 9))
7420 (setq eff (string-to-number (char-to-string (read-char-exclusive)))))
7421 (setq org-agenda-effort-filter
7422 (list (concat (if strip "-" "+")
7423 (char-to-string op) (nth (1- eff) efforts))))
7424 (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
7425 (t (org-agenda-filter-show-all-effort)
7426 (message "Effort filter removed"))))
7428 (defun org-agenda-filter-remove-all ()
7429 "Remove all filters from the current agenda buffer."
7430 (interactive)
7431 (when org-agenda-tag-filter
7432 (org-agenda-filter-show-all-tag))
7433 (when org-agenda-category-filter
7434 (org-agenda-filter-show-all-cat))
7435 (when org-agenda-regexp-filter
7436 (org-agenda-filter-show-all-re))
7437 (when org-agenda-top-headline-filter
7438 (org-agenda-filter-show-all-top-filter))
7439 (when org-agenda-effort-filter
7440 (org-agenda-filter-show-all-effort))
7441 (org-agenda-finalize))
7443 (defun org-agenda-filter-by-tag (strip &optional char narrow)
7444 "Keep only those lines in the agenda buffer that have a specific tag.
7445 The tag is selected with its fast selection letter, as configured.
7446 With prefix argument STRIP, remove all lines that do have the tag.
7447 A lisp caller can specify CHAR. NARROW means that the new tag should be
7448 used to narrow the search - the interactive user can also press `-' or `+'
7449 to switch to narrowing."
7450 (interactive "P")
7451 (let* ((alist org-tag-alist-for-agenda)
7452 (tag-chars (mapconcat
7453 (lambda (x) (if (and (not (symbolp (car x)))
7454 (cdr x))
7455 (char-to-string (cdr x))
7456 ""))
7457 alist ""))
7458 (inhibit-read-only t)
7459 (current org-agenda-tag-filter)
7460 a n tag)
7461 (unless char
7462 (message
7463 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow"
7464 (if narrow "Narrow" "Filter") tag-chars
7465 (if org-agenda-auto-exclude-function "[RET], " ""))
7466 (setq char (read-char-exclusive)))
7467 (when (member char '(?+ ?-))
7468 ;; Narrowing down
7469 (cond ((equal char ?-) (setq strip t narrow t))
7470 ((equal char ?+) (setq strip nil narrow t)))
7471 (message
7472 "Narrow by tag [%s ], [TAB], [/]:off" tag-chars)
7473 (setq char (read-char-exclusive)))
7474 (when (equal char ?\t)
7475 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7476 (org-set-local 'org-global-tags-completion-table
7477 (org-global-tags-completion-table)))
7478 (let ((completion-ignore-case t))
7479 (setq tag (org-icompleting-read
7480 "Tag: " org-global-tags-completion-table))))
7481 (cond
7482 ((equal char ?\r)
7483 (org-agenda-filter-show-all-tag)
7484 (when org-agenda-auto-exclude-function
7485 (setq org-agenda-tag-filter nil)
7486 (dolist (tag (org-agenda-get-represented-tags))
7487 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7488 (if modifier
7489 (push modifier org-agenda-tag-filter))))
7490 (if (not (null org-agenda-tag-filter))
7491 (org-agenda-filter-apply org-agenda-tag-filter 'tag))))
7492 ((equal char ?/)
7493 (org-agenda-filter-show-all-tag)
7494 (when (get 'org-agenda-tag-filter :preset-filter)
7495 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
7496 ((equal char ?. )
7497 (setq org-agenda-tag-filter
7498 (mapcar (lambda(tag) (concat "+" tag))
7499 (org-get-at-bol 'tags)))
7500 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7501 ((or (equal char ?\ )
7502 (setq a (rassoc char alist))
7503 (and tag (setq a (cons tag nil))))
7504 (org-agenda-filter-show-all-tag)
7505 (setq tag (car a))
7506 (setq org-agenda-tag-filter
7507 (cons (concat (if strip "-" "+") tag)
7508 (if narrow current nil)))
7509 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7510 (t (error "Invalid tag selection character %c" char)))))
7512 (defun org-agenda-get-represented-tags ()
7513 "Get a list of all tags currently represented in the agenda."
7514 (let (p tags)
7515 (save-excursion
7516 (goto-char (point-min))
7517 (while (setq p (next-single-property-change (point) 'tags))
7518 (goto-char p)
7519 (mapc (lambda (x) (add-to-list 'tags x))
7520 (get-text-property (point) 'tags))))
7521 tags))
7523 (defun org-agenda-filter-by-tag-refine (strip &optional char)
7524 "Refine the current filter. See `org-agenda-filter-by-tag'."
7525 (interactive "P")
7526 (org-agenda-filter-by-tag strip char 'refine))
7528 (defun org-agenda-filter-make-matcher (filter type)
7529 "Create the form that tests a line for agenda filter."
7530 (let (f f1)
7531 (cond
7532 ;; Tag filter
7533 ((eq type 'tag)
7534 (setq filter
7535 (delete-dups
7536 (append (get 'org-agenda-tag-filter :preset-filter)
7537 filter)))
7538 (dolist (x filter)
7539 (let ((nfilter (org-agenda-filter-expand-tags filter)) nf nf1
7540 (ffunc
7541 (lambda (nf0 nf01 fltr notgroup op)
7542 (dolist (x fltr)
7543 (if (member x '("-" "+"))
7544 (setq nf01 (if (equal x "-") 'tags '(not tags)))
7545 (setq nf01 (list 'member (downcase (substring x 1))
7546 'tags))
7547 (when (equal (string-to-char x) ?-)
7548 (setq nf01 (list 'not nf01))
7549 (when (not notgroup) (setq op 'and))))
7550 (push nf01 nf0))
7551 (if notgroup
7552 (push (cons 'and nf0) f)
7553 (push (cons (or op 'or) nf0) f)))))
7554 (cond ((equal filter '("+"))
7555 (setq f (list (list 'not 'tags))))
7556 ((equal nfilter filter)
7557 (funcall ffunc f1 f filter t nil))
7558 (t (funcall ffunc nf1 nf nfilter nil nil))))))
7559 ;; Category filter
7560 ((eq type 'category)
7561 (setq filter
7562 (delete-dups
7563 (append (get 'org-agenda-category-filter :preset-filter)
7564 filter)))
7565 (dolist (x filter)
7566 (if (equal "-" (substring x 0 1))
7567 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7568 (setq f1 (list 'equal (substring x 1) 'cat)))
7569 (push f1 f)))
7570 ;; Regexp filter
7571 ((eq type 'regexp)
7572 (setq filter
7573 (delete-dups
7574 (append (get 'org-agenda-regexp-filter :preset-filter)
7575 filter)))
7576 (dolist (x filter)
7577 (if (equal "-" (substring x 0 1))
7578 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7579 (setq f1 (list 'string-match (substring x 1) 'txt)))
7580 (push f1 f)))
7581 ;; Effort filter
7582 ((eq type 'effort)
7583 (setq filter
7584 (delete-dups
7585 (append (get 'org-agenda-effort-filter :preset-filter)
7586 filter)))
7587 (dolist (x filter)
7588 (push (org-agenda-filter-effort-form x) f))))
7589 (cons 'and (nreverse f))))
7591 (defun org-agenda-filter-effort-form (e)
7592 "Return the form to compare the effort of the current line with what E says.
7593 E looks like \"+<2:25\"."
7594 (let (op)
7595 (setq e (substring e 1))
7596 (setq op (string-to-char e) e (substring e 1))
7597 (setq op (cond ((equal op ?<) '<=)
7598 ((equal op ?>) '>=)
7599 ((equal op ??) op)
7600 (t '=)))
7601 (list 'org-agenda-compare-effort (list 'quote op)
7602 (org-duration-string-to-minutes e))))
7604 (defun org-agenda-compare-effort (op value)
7605 "Compare the effort of the current line with VALUE, using OP.
7606 If the line does not have an effort defined, return nil."
7607 (let ((eff (org-get-at-eol 'effort-minutes 1)))
7608 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 -1))
7609 value)))
7611 (defun org-agenda-filter-expand-tags (filter &optional no-operator)
7612 "Expand group tags in FILTER for the agenda.
7613 When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
7614 (if org-group-tags
7615 (let ((case-fold-search t) rtn)
7616 (mapc
7617 (lambda (f)
7618 (let (f0 dir)
7619 (if (string-match "^\\([+-]\\)\\(.+\\)" f)
7620 (setq dir (match-string 1 f) f0 (match-string 2 f))
7621 (setq dir (if no-operator "" "+") f0 f))
7622 (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
7623 (org-tags-expand f0 t t))
7624 rtn))))
7625 filter)
7626 (reverse rtn))
7627 filter))
7629 (defun org-agenda-filter-apply (filter type)
7630 "Set FILTER as the new agenda filter and apply it."
7631 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7632 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7633 (let (tags cat txt)
7634 (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type))
7635 ;; Only set `org-agenda-filtered-by-category' to t when a unique
7636 ;; category is used as the filter:
7637 (setq org-agenda-filtered-by-category
7638 (and (eq type 'category)
7639 (not (equal (substring (car filter) 0 1) "-"))))
7640 (org-agenda-set-mode-name)
7641 (save-excursion
7642 (goto-char (point-min))
7643 (while (not (eobp))
7644 (if (org-get-at-bol 'org-marker)
7645 (progn
7646 (setq tags ; used in eval
7647 (apply 'append
7648 (mapcar (lambda (f)
7649 (org-agenda-filter-expand-tags (list f) t))
7650 (org-get-at-bol 'tags)))
7651 cat (org-get-at-eol 'org-category 1)
7652 txt (org-get-at-eol 'txt 1))
7653 (if (not (eval org-agenda-filter-form))
7654 (org-agenda-filter-hide-line type))
7655 (beginning-of-line 2))
7656 (beginning-of-line 2))))
7657 (if (get-char-property (point) 'invisible)
7658 (ignore-errors (org-agenda-previous-line)))))
7660 (defun org-agenda-filter-top-headline-apply (hl &optional negative)
7661 "Filter by top headline HL."
7662 (org-agenda-set-mode-name)
7663 (save-excursion
7664 (goto-char (point-min))
7665 (while (not (eobp))
7666 (let* ((pos (org-get-at-bol 'org-hd-marker))
7667 (tophl (and pos (org-find-top-headline pos))))
7668 (if (and tophl (funcall (if negative 'identity 'not)
7669 (string= hl tophl)))
7670 (org-agenda-filter-hide-line 'top-headline)))
7671 (beginning-of-line 2)))
7672 (if (get-char-property (point) 'invisible)
7673 (org-agenda-previous-line))
7674 (setq org-agenda-top-headline-filter hl
7675 org-agenda-filtered-by-top-headline t))
7677 (defun org-agenda-filter-hide-line (type)
7678 "Hide lines with TYPE in the agenda buffer."
7679 (let* ((b (max (point-min) (1- (point-at-bol))))
7680 (e (point-at-eol)))
7681 (let ((inhibit-read-only t))
7682 (add-text-properties
7683 b e `(invisible org-filtered org-filter-type ,type)))))
7685 (defun org-agenda-remove-filter (type)
7686 (interactive)
7687 "Remove filter of type TYPE from the agenda buffer."
7688 (save-excursion
7689 (goto-char (point-min))
7690 (let ((inhibit-read-only t) pos)
7691 (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
7692 (goto-char pos)
7693 (remove-text-properties
7694 (point) (next-single-property-change (point) 'org-filter-type)
7695 `(invisible org-filtered org-filter-type ,type))))
7696 (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
7697 (setq org-agenda-filter-form nil)
7698 (org-agenda-set-mode-name)
7699 (org-agenda-finalize)))
7701 (defun org-agenda-filter-show-all-tag nil
7702 (org-agenda-remove-filter 'tag))
7703 (defun org-agenda-filter-show-all-re nil
7704 (org-agenda-remove-filter 'regexp))
7705 (defun org-agenda-filter-show-all-effort nil
7706 (org-agenda-remove-filter 'effort))
7707 (defun org-agenda-filter-show-all-cat nil
7708 (org-agenda-remove-filter 'category))
7709 (defun org-agenda-filter-show-all-top-filter nil
7710 (org-agenda-remove-filter 'top-headline))
7712 (defun org-agenda-manipulate-query-add ()
7713 "Manipulate the query by adding a search term with positive selection.
7714 Positive selection means the term must be matched for selection of an entry."
7715 (interactive)
7716 (org-agenda-manipulate-query ?\[))
7717 (defun org-agenda-manipulate-query-subtract ()
7718 "Manipulate the query by adding a search term with negative selection.
7719 Negative selection means term must not be matched for selection of an entry."
7720 (interactive)
7721 (org-agenda-manipulate-query ?\]))
7722 (defun org-agenda-manipulate-query-add-re ()
7723 "Manipulate the query by adding a search regexp with positive selection.
7724 Positive selection means the regexp must match for selection of an entry."
7725 (interactive)
7726 (org-agenda-manipulate-query ?\{))
7727 (defun org-agenda-manipulate-query-subtract-re ()
7728 "Manipulate the query by adding a search regexp with negative selection.
7729 Negative selection means regexp must not match for selection of an entry."
7730 (interactive)
7731 (org-agenda-manipulate-query ?\}))
7732 (defun org-agenda-manipulate-query (char)
7733 (cond
7734 ((memq org-agenda-type '(timeline agenda))
7735 (let ((org-agenda-include-inactive-timestamps t))
7736 (org-agenda-redo))
7737 (message "Display now includes inactive timestamps as well"))
7738 ((eq org-agenda-type 'search)
7739 (org-add-to-string
7740 'org-agenda-query-string
7741 (if org-agenda-last-search-view-search-was-boolean
7742 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7743 (?\{ . " +{}") (?\} . " -{}"))))
7744 " "))
7745 (setq org-agenda-redo-command
7746 (list 'org-search-view
7747 (car (get-text-property (min (1- (point-max)) (point))
7748 'org-last-args))
7749 org-agenda-query-string
7750 (+ (length org-agenda-query-string)
7751 (if (member char '(?\{ ?\})) 0 1))))
7752 (set-register org-agenda-query-register org-agenda-query-string)
7753 (let ((org-agenda-overriding-arguments
7754 (cdr org-agenda-redo-command)))
7755 (org-agenda-redo)))
7756 (t (error "Cannot manipulate query for %s-type agenda buffers"
7757 org-agenda-type))))
7759 (defun org-add-to-string (var string)
7760 (set var (concat (symbol-value var) string)))
7762 (defun org-agenda-goto-date (span)
7763 "Jump to DATE in agenda."
7764 (interactive "P")
7765 (let* ((org-read-date-prefer-future
7766 (eval org-agenda-jump-prefer-future))
7767 (date (org-read-date))
7768 (day (time-to-days (org-time-string-to-time date)))
7769 (org-agenda-sticky-orig org-agenda-sticky)
7770 (org-agenda-buffer-tmp-name (buffer-name))
7771 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7772 (0-arg (or current-prefix-arg (car args)))
7773 (2-arg (nth 2 args))
7774 (with-hour-p (nth 4 org-agenda-redo-command))
7775 (newcmd (list 'org-agenda-list 0-arg date
7776 (org-agenda-span-to-ndays
7777 2-arg (org-time-string-to-absolute date))
7778 with-hour-p))
7779 (newargs (cdr newcmd))
7780 (inhibit-read-only t)
7781 org-agenda-sticky)
7782 (if (not (org-agenda-check-type t 'agenda))
7783 (error "Not available in non-agenda views")
7784 (add-text-properties (point-min) (point-max)
7785 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7786 (org-agenda-redo)
7787 (goto-char (point-min))
7788 (while (not (or (= (or (get-text-property (point) 'day) 0) day)
7789 (save-excursion (move-beginning-of-line 2) (eobp))))
7790 (move-beginning-of-line 2))
7791 (setq org-agenda-sticky org-agenda-sticky-orig
7792 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7794 (defun org-agenda-goto-today ()
7795 "Go to today."
7796 (interactive)
7797 (org-agenda-check-type t 'timeline 'agenda)
7798 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7799 (curspan (nth 2 args))
7800 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7801 (cond
7802 (tdpos (goto-char tdpos))
7803 ((eq org-agenda-type 'agenda)
7804 (let* ((sd (org-agenda-compute-starting-span
7805 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7806 (org-agenda-overriding-arguments args))
7807 (setf (nth 1 org-agenda-overriding-arguments) sd)
7808 (org-agenda-redo)
7809 (org-agenda-find-same-or-today-or-agenda)))
7810 (t (error "Cannot find today")))))
7812 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7813 (goto-char
7814 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7815 (text-property-any (point-min) (point-max) 'org-today t)
7816 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7817 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7818 (org-agenda-backward-block))
7819 (point-min))))
7821 (defun org-agenda-backward-block ()
7822 "Move backward by one agenda block."
7823 (interactive)
7824 (org-agenda-forward-block 'backward))
7826 (defun org-agenda-forward-block (&optional backward)
7827 "Move forward by one agenda block.
7828 When optional argument BACKWARD is set, go backward"
7829 (interactive)
7830 (cond ((not (derived-mode-p 'org-agenda-mode))
7831 (user-error
7832 "Cannot execute this command outside of org-agenda-mode buffers"))
7833 ((looking-at (if backward "\\`" "\\'"))
7834 (message "Already at the %s block" (if backward "first" "last")))
7835 (t (let ((pos (prog1 (point)
7836 (ignore-errors (if backward (backward-char 1)
7837 (move-end-of-line 1)))))
7838 (f (if backward
7839 'previous-single-property-change
7840 'next-single-property-change))
7841 moved dest)
7842 (while (and (setq dest (funcall
7843 f (point) 'org-agenda-structural-header))
7844 (not (get-text-property
7845 (point) 'org-agenda-structural-header)))
7846 (setq moved t)
7847 (goto-char dest))
7848 (if moved (move-beginning-of-line 1)
7849 (goto-char (if backward (point-min) (point-max)))
7850 (move-beginning-of-line 1)
7851 (message "No %s block" (if backward "previous" "further")))))))
7853 (defun org-agenda-later (arg)
7854 "Go forward in time by the current span.
7855 With prefix ARG, go forward that many times the current span."
7856 (interactive "p")
7857 (org-agenda-check-type t 'agenda)
7858 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7859 (span (or (nth 2 args) org-agenda-current-span))
7860 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7861 (greg (calendar-gregorian-from-absolute sd))
7862 (cnt (org-get-at-bol 'org-day-cnt))
7863 greg2)
7864 (cond
7865 ((numberp span)
7866 (setq sd (+ (* span arg) sd)))
7867 ((eq span 'day)
7868 (setq sd (+ arg sd)))
7869 ((eq span 'week)
7870 (setq sd (+ (* 7 arg) sd)))
7871 ((eq span 'fortnight)
7872 (setq sd (+ (* 14 arg) sd)))
7873 ((eq span 'month)
7874 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7875 sd (calendar-absolute-from-gregorian greg2))
7876 (setcar greg2 (1+ (car greg2))))
7877 ((eq span 'year)
7878 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7879 sd (calendar-absolute-from-gregorian greg2))
7880 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7882 (setq sd (+ (* span arg) sd))))
7883 (let ((org-agenda-overriding-cmd
7884 ;; `cmd' may have been set by `org-agenda-run-series' which
7885 ;; uses `org-agenda-overriding-cmd' to decide whether
7886 ;; overriding is allowed for `cmd'
7887 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7888 (org-agenda-overriding-arguments
7889 (list (car args) sd span)))
7890 (org-agenda-redo)
7891 (org-agenda-find-same-or-today-or-agenda cnt))))
7893 (defun org-agenda-earlier (arg)
7894 "Go backward in time by the current span.
7895 With prefix ARG, go backward that many times the current span."
7896 (interactive "p")
7897 (org-agenda-later (- arg)))
7899 (defun org-agenda-view-mode-dispatch ()
7900 "Call one of the view mode commands."
7901 (interactive)
7902 (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
7903 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7904 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7905 (let ((a (read-char-exclusive)))
7906 (case a
7907 (?\ (call-interactively 'org-agenda-reset-view))
7908 (?d (call-interactively 'org-agenda-day-view))
7909 (?w (call-interactively 'org-agenda-week-view))
7910 (?t (call-interactively 'org-agenda-fortnight-view))
7911 (?m (call-interactively 'org-agenda-month-view))
7912 (?y (call-interactively 'org-agenda-year-view))
7913 (?l (call-interactively 'org-agenda-log-mode))
7914 (?L (org-agenda-log-mode '(4)))
7915 (?c (org-agenda-log-mode 'clockcheck))
7916 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7917 (?a (call-interactively 'org-agenda-archives-mode))
7918 (?A (org-agenda-archives-mode 'files))
7919 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7920 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7921 (?G (call-interactively 'org-agenda-toggle-time-grid))
7922 (?D (call-interactively 'org-agenda-toggle-diary))
7923 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7924 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7925 (org-agenda-check-type t 'timeline 'agenda)
7926 (org-agenda-redo))
7927 (message "Display now includes inactive timestamps as well"))
7928 (?q (message "Abort"))
7929 (otherwise (error "Invalid key" )))))
7931 (defun org-agenda-reset-view ()
7932 "Switch to default view for agenda."
7933 (interactive)
7934 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7935 (defun org-agenda-day-view (&optional day-of-month)
7936 "Switch to daily view for agenda.
7937 With argument DAY-OF-MONTH, switch to that day of the month."
7938 (interactive "P")
7939 (org-agenda-change-time-span 'day day-of-month))
7940 (defun org-agenda-week-view (&optional iso-week)
7941 "Switch to daily view for agenda.
7942 With argument ISO-WEEK, switch to the corresponding ISO week.
7943 If ISO-WEEK has more then 2 digits, only the last two encode the
7944 week. Any digits before this encode a year. So 200712 means
7945 week 12 of year 2007. Years in the range 1938-2037 can also be
7946 written as 2-digit years."
7947 (interactive "P")
7948 (org-agenda-change-time-span 'week iso-week))
7949 (defun org-agenda-fortnight-view (&optional iso-week)
7950 "Switch to daily view for agenda.
7951 With argument ISO-WEEK, switch to the corresponding ISO week.
7952 If ISO-WEEK has more then 2 digits, only the last two encode the
7953 week. Any digits before this encode a year. So 200712 means
7954 week 12 of year 2007. Years in the range 1938-2037 can also be
7955 written as 2-digit years."
7956 (interactive "P")
7957 (org-agenda-change-time-span 'fortnight iso-week))
7958 (defun org-agenda-month-view (&optional month)
7959 "Switch to monthly view for agenda.
7960 With argument MONTH, switch to that month."
7961 (interactive "P")
7962 (org-agenda-change-time-span 'month month))
7963 (defun org-agenda-year-view (&optional year)
7964 "Switch to yearly view for agenda.
7965 With argument YEAR, switch to that year.
7966 If MONTH has more then 2 digits, only the last two encode the
7967 month. Any digits before this encode a year. So 200712 means
7968 December year 2007. Years in the range 1938-2037 can also be
7969 written as 2-digit years."
7970 (interactive "P")
7971 (when year
7972 (setq year (org-small-year-to-year year)))
7973 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7974 (org-agenda-change-time-span 'year year)
7975 (error "Abort")))
7977 (defun org-agenda-change-time-span (span &optional n)
7978 "Change the agenda view to SPAN.
7979 SPAN may be `day', `week', `fortnight', `month', `year'."
7980 (org-agenda-check-type t 'agenda)
7981 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7982 (curspan (nth 2 args)))
7983 (if (and (not n) (equal curspan span))
7984 (error "Viewing span is already \"%s\"" span))
7985 (let* ((sd (or (org-get-at-bol 'day)
7986 (nth 1 args)
7987 org-starting-day))
7988 (sd (org-agenda-compute-starting-span sd span n))
7989 (org-agenda-overriding-cmd
7990 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7991 (org-agenda-overriding-arguments
7992 (list (car args) sd span)))
7993 (org-agenda-redo)
7994 (org-agenda-find-same-or-today-or-agenda))
7995 (org-agenda-set-mode-name)
7996 (message "Switched to %s view" span)))
7998 (defun org-agenda-compute-starting-span (sd span &optional n)
7999 "Compute starting date for agenda.
8000 SPAN may be `day', `week', `fortnight', `month', `year'. The return value
8001 is a cons cell with the starting date and the number of days,
8002 so that the date SD will be in that range."
8003 (let* ((greg (calendar-gregorian-from-absolute sd))
8004 (dg (nth 1 greg))
8005 (mg (car greg))
8006 (yg (nth 2 greg)))
8007 (cond
8008 ((eq span 'day)
8009 (when n
8010 (setq sd (+ (calendar-absolute-from-gregorian
8011 (list mg 1 yg))
8012 n -1))))
8013 ((or (eq span 'week) (eq span 'fortnight))
8014 (let* ((nt (calendar-day-of-week
8015 (calendar-gregorian-from-absolute sd)))
8016 (d (if org-agenda-start-on-weekday
8017 (- nt org-agenda-start-on-weekday)
8020 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
8021 (when n
8022 (require 'cal-iso)
8023 (when (> n 99)
8024 (setq y1 (org-small-year-to-year (/ n 100))
8025 n (mod n 100)))
8026 (setq sd
8027 (calendar-absolute-from-iso
8028 (list n 1
8029 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
8030 ((eq span 'month)
8031 (let (y1)
8032 (when (and n (> n 99))
8033 (setq y1 (org-small-year-to-year (/ n 100))
8034 n (mod n 100)))
8035 (setq sd (calendar-absolute-from-gregorian
8036 (list (or n mg) 1 (or y1 yg))))))
8037 ((eq span 'year)
8038 (setq sd (calendar-absolute-from-gregorian
8039 (list 1 1 (or n yg))))))
8040 sd))
8042 (defun org-agenda-next-date-line (&optional arg)
8043 "Jump to the next line indicating a date in agenda buffer."
8044 (interactive "p")
8045 (org-agenda-check-type t 'agenda 'timeline)
8046 (beginning-of-line 1)
8047 ;; This does not work if user makes date format that starts with a blank
8048 (if (looking-at "^\\S-") (forward-char 1))
8049 (if (not (re-search-forward "^\\S-" nil t arg))
8050 (progn
8051 (backward-char 1)
8052 (error "No next date after this line in this buffer")))
8053 (goto-char (match-beginning 0)))
8055 (defun org-agenda-previous-date-line (&optional arg)
8056 "Jump to the previous line indicating a date in agenda buffer."
8057 (interactive "p")
8058 (org-agenda-check-type t 'agenda 'timeline)
8059 (beginning-of-line 1)
8060 (if (not (re-search-backward "^\\S-" nil t arg))
8061 (error "No previous date before this line in this buffer")))
8063 ;; Initialize the highlight
8064 (defvar org-hl (make-overlay 1 1))
8065 (overlay-put org-hl 'face 'highlight)
8067 (defun org-highlight (begin end &optional buffer)
8068 "Highlight a region with overlay."
8069 (move-overlay org-hl begin end (or buffer (current-buffer))))
8071 (defun org-unhighlight ()
8072 "Detach overlay INDEX."
8073 (org-detach-overlay org-hl))
8075 (defun org-unhighlight-once ()
8076 "Remove the highlight from its position, and this function from the hook."
8077 (remove-hook 'pre-command-hook 'org-unhighlight-once)
8078 (org-unhighlight))
8080 (defvar org-agenda-pre-follow-window-conf nil)
8081 (defun org-agenda-follow-mode ()
8082 "Toggle follow mode in an agenda buffer."
8083 (interactive)
8084 (unless org-agenda-follow-mode
8085 (setq org-agenda-pre-follow-window-conf
8086 (current-window-configuration)))
8087 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
8088 (unless org-agenda-follow-mode
8089 (set-window-configuration org-agenda-pre-follow-window-conf))
8090 (org-agenda-set-mode-name)
8091 (org-agenda-do-context-action)
8092 (message "Follow mode is %s"
8093 (if org-agenda-follow-mode "on" "off")))
8095 (defun org-agenda-entry-text-mode (&optional arg)
8096 "Toggle entry text mode in an agenda buffer."
8097 (interactive "P")
8098 (if (or org-agenda-tag-filter
8099 org-agenda-category-filter
8100 org-agenda-regexp-filter
8101 org-agenda-top-headline-filter)
8102 (user-error "Can't show entry text in filtered views")
8103 (setq org-agenda-entry-text-mode (or (integerp arg)
8104 (not org-agenda-entry-text-mode)))
8105 (org-agenda-entry-text-hide)
8106 (and org-agenda-entry-text-mode
8107 (let ((org-agenda-entry-text-maxlines
8108 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
8109 (org-agenda-entry-text-show)))
8110 (org-agenda-set-mode-name)
8111 (message "Entry text mode is %s%s"
8112 (if org-agenda-entry-text-mode "on" "off")
8113 (if (not org-agenda-entry-text-mode) ""
8114 (format " (maximum number of lines is %d)"
8115 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
8117 (defun org-agenda-clockreport-mode ()
8118 "Toggle clocktable mode in an agenda buffer."
8119 (interactive)
8120 (org-agenda-check-type t 'agenda)
8121 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
8122 (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
8123 (org-agenda-set-mode-name)
8124 (org-agenda-redo)
8125 (message "Clocktable mode is %s"
8126 (if org-agenda-clockreport-mode "on" "off")))
8128 (defun org-agenda-log-mode (&optional special)
8129 "Toggle log mode in an agenda buffer.
8130 With argument SPECIAL, show all possible log items, not only the ones
8131 configured in `org-agenda-log-mode-items'.
8132 With a double `C-u' prefix arg, show *only* log items, nothing else."
8133 (interactive "P")
8134 (org-agenda-check-type t 'agenda 'timeline)
8135 (setq org-agenda-show-log
8136 (cond
8137 ((equal special '(16)) 'only)
8138 ((eq special 'clockcheck)
8139 (if (eq org-agenda-show-log 'clockcheck)
8140 nil 'clockcheck))
8141 (special '(closed clock state))
8142 (t (not org-agenda-show-log))))
8143 (setq org-agenda-start-with-log-mode org-agenda-show-log)
8144 (org-agenda-set-mode-name)
8145 (org-agenda-redo)
8146 (message "Log mode is %s"
8147 (if org-agenda-show-log "on" "off")))
8149 (defun org-agenda-archives-mode (&optional with-files)
8150 "Toggle inclusion of items in trees marked with :ARCHIVE:.
8151 When called with a prefix argument, include all archive files as well."
8152 (interactive "P")
8153 (setq org-agenda-archives-mode
8154 (if with-files t (if org-agenda-archives-mode nil 'trees)))
8155 (org-agenda-set-mode-name)
8156 (org-agenda-redo)
8157 (message
8158 "%s"
8159 (cond
8160 ((eq org-agenda-archives-mode nil)
8161 "No archives are included")
8162 ((eq org-agenda-archives-mode 'trees)
8163 (format "Trees with :%s: tag are included" org-archive-tag))
8164 ((eq org-agenda-archives-mode t)
8165 (format "Trees with :%s: tag and all active archive files are included"
8166 org-archive-tag)))))
8168 (defun org-agenda-toggle-diary ()
8169 "Toggle diary inclusion in an agenda buffer."
8170 (interactive)
8171 (org-agenda-check-type t 'agenda)
8172 (setq org-agenda-include-diary (not org-agenda-include-diary))
8173 (org-agenda-redo)
8174 (org-agenda-set-mode-name)
8175 (message "Diary inclusion turned %s"
8176 (if org-agenda-include-diary "on" "off")))
8178 (defun org-agenda-toggle-deadlines ()
8179 "Toggle inclusion of entries with a deadline in an agenda buffer."
8180 (interactive)
8181 (org-agenda-check-type t 'agenda)
8182 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8183 (org-agenda-redo)
8184 (org-agenda-set-mode-name)
8185 (message "Deadlines inclusion turned %s"
8186 (if org-agenda-include-deadlines "on" "off")))
8188 (defun org-agenda-toggle-time-grid ()
8189 "Toggle time grid in an agenda buffer."
8190 (interactive)
8191 (org-agenda-check-type t 'agenda)
8192 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8193 (org-agenda-redo)
8194 (org-agenda-set-mode-name)
8195 (message "Time-grid turned %s"
8196 (if org-agenda-use-time-grid "on" "off")))
8198 (defun org-agenda-set-mode-name ()
8199 "Set the mode name to indicate all the small mode settings."
8200 (setq mode-name
8201 (list "Org-Agenda"
8202 (if (get 'org-agenda-files 'org-restrict) " []" "")
8204 '(:eval (org-agenda-span-name org-agenda-current-span))
8205 (if org-agenda-follow-mode " Follow" "")
8206 (if org-agenda-entry-text-mode " ETxt" "")
8207 (if org-agenda-include-diary " Diary" "")
8208 (if org-agenda-include-deadlines " Ddl" "")
8209 (if org-agenda-use-time-grid " Grid" "")
8210 (if (and (boundp 'org-habit-show-habits)
8211 org-habit-show-habits) " Habit" "")
8212 (cond
8213 ((consp org-agenda-show-log) " LogAll")
8214 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8215 (org-agenda-show-log " Log")
8216 (t ""))
8217 (if (or org-agenda-category-filter
8218 (get 'org-agenda-category-filter :preset-filter))
8219 '(:eval (org-propertize
8220 (concat " <"
8221 (mapconcat
8222 'identity
8223 (append
8224 (get 'org-agenda-category-filter :preset-filter)
8225 org-agenda-category-filter)
8227 ">")
8228 'face 'org-agenda-filter-category
8229 'help-echo "Category used in filtering")) "")
8230 (if (or org-agenda-tag-filter
8231 (get 'org-agenda-tag-filter :preset-filter))
8232 '(:eval (org-propertize
8233 (concat " {"
8234 (mapconcat
8235 'identity
8236 (append
8237 (get 'org-agenda-tag-filter :preset-filter)
8238 org-agenda-tag-filter)
8240 "}")
8241 'face 'org-agenda-filter-tags
8242 'help-echo "Tags used in filtering")) "")
8243 (if (or org-agenda-effort-filter
8244 (get 'org-agenda-effort-filter :preset-filter))
8245 '(:eval (org-propertize
8246 (concat " {"
8247 (mapconcat
8248 'identity
8249 (append
8250 (get 'org-agenda-effort-filter :preset-filter)
8251 org-agenda-effort-filter)
8253 "}")
8254 'face 'org-agenda-filter-effort
8255 'help-echo "Effort conditions used in filtering")) "")
8256 (if (or org-agenda-regexp-filter
8257 (get 'org-agenda-regexp-filter :preset-filter))
8258 '(:eval (org-propertize
8259 (concat " ["
8260 (mapconcat
8261 'identity
8262 (append
8263 (get 'org-agenda-regexp-filter :preset-filter)
8264 org-agenda-regexp-filter)
8266 "]")
8267 'face 'org-agenda-filter-regexp
8268 'help-echo "Regexp used in filtering")) "")
8269 (if org-agenda-archives-mode
8270 (if (eq org-agenda-archives-mode t)
8271 " Archives"
8272 (format " :%s:" org-archive-tag))
8274 (if org-agenda-clockreport-mode " Clock" "")))
8275 (force-mode-line-update))
8277 (define-obsolete-function-alias
8278 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8280 (defun org-agenda-update-agenda-type ()
8281 "Update the agenda type after each command."
8282 (setq org-agenda-type
8283 (or (get-text-property (point) 'org-agenda-type)
8284 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8286 (defun org-agenda-next-line ()
8287 "Move cursor to the next line, and show if follow mode is active."
8288 (interactive)
8289 (call-interactively 'next-line)
8290 (org-agenda-do-context-action))
8292 (defun org-agenda-previous-line ()
8293 "Move cursor to the previous line, and show if follow-mode is active."
8294 (interactive)
8295 (call-interactively 'previous-line)
8296 (org-agenda-do-context-action))
8298 (defun org-agenda-next-item (n)
8299 "Move cursor to next agenda item."
8300 (interactive "p")
8301 (let ((col (current-column)))
8302 (dotimes (c n)
8303 (when (next-single-property-change (point-at-eol) 'org-marker)
8304 (move-end-of-line 1)
8305 (goto-char (next-single-property-change (point) 'org-marker))))
8306 (org-move-to-column col))
8307 (org-agenda-do-context-action))
8309 (defun org-agenda-previous-item (n)
8310 "Move cursor to next agenda item."
8311 (interactive "p")
8312 (dotimes (c n)
8313 (let ((col (current-column))
8314 (goto (save-excursion
8315 (move-end-of-line 0)
8316 (previous-single-property-change (point) 'org-marker))))
8317 (if goto (goto-char goto))
8318 (org-move-to-column col)))
8319 (org-agenda-do-context-action))
8321 (defun org-agenda-do-context-action ()
8322 "Show outline path and, maybe, follow mode window."
8323 (let ((m (org-get-at-bol 'org-marker)))
8324 (when (and (markerp m) (marker-buffer m))
8325 (and org-agenda-follow-mode
8326 (if org-agenda-follow-indirect
8327 (org-agenda-tree-to-indirect-buffer nil)
8328 (org-agenda-show)))
8329 (and org-agenda-show-outline-path
8330 (org-with-point-at m (org-display-outline-path t))))))
8332 (defun org-agenda-show-tags ()
8333 "Show the tags applicable to the current item."
8334 (interactive)
8335 (let* ((tags (org-get-at-bol 'tags)))
8336 (if tags
8337 (message "Tags are :%s:"
8338 (org-no-properties (mapconcat 'identity tags ":")))
8339 (message "No tags associated with this line"))))
8341 (defun org-agenda-goto (&optional highlight)
8342 "Go to the entry at point in the corresponding Org-mode file."
8343 (interactive)
8344 (let* ((marker (or (org-get-at-bol 'org-marker)
8345 (org-agenda-error)))
8346 (buffer (marker-buffer marker))
8347 (pos (marker-position marker)))
8348 (switch-to-buffer-other-window buffer)
8349 (widen)
8350 (push-mark)
8351 (goto-char pos)
8352 (when (derived-mode-p 'org-mode)
8353 (org-show-context 'agenda)
8354 (save-excursion
8355 (and (outline-next-heading)
8356 (org-flag-heading nil)))) ; show the next heading
8357 (when (outline-invisible-p)
8358 (show-entry)) ; display invisible text
8359 (recenter (/ (window-height) 2))
8360 (org-back-to-heading t)
8361 (if (re-search-forward org-complex-heading-regexp nil t)
8362 (goto-char (match-beginning 4)))
8363 (run-hooks 'org-agenda-after-show-hook)
8364 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8366 (defvar org-agenda-after-show-hook nil
8367 "Normal hook run after an item has been shown from the agenda.
8368 Point is in the buffer where the item originated.")
8370 (defun org-agenda-kill ()
8371 "Kill the entry or subtree belonging to the current agenda entry."
8372 (interactive)
8373 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8374 (let* ((bufname-orig (buffer-name))
8375 (marker (or (org-get-at-bol 'org-marker)
8376 (org-agenda-error)))
8377 (buffer (marker-buffer marker))
8378 (pos (marker-position marker))
8379 (type (org-get-at-bol 'type))
8380 dbeg dend (n 0) conf)
8381 (org-with-remote-undo buffer
8382 (with-current-buffer buffer
8383 (save-excursion
8384 (goto-char pos)
8385 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8386 (setq dbeg (progn (org-back-to-heading t) (point))
8387 dend (org-end-of-subtree t t))
8388 (setq dbeg (point-at-bol)
8389 dend (min (point-max) (1+ (point-at-eol)))))
8390 (goto-char dbeg)
8391 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8392 (setq conf (or (eq t org-agenda-confirm-kill)
8393 (and (numberp org-agenda-confirm-kill)
8394 (> n org-agenda-confirm-kill))))
8395 (and conf
8396 (not (y-or-n-p
8397 (format "Delete entry with %d lines in buffer \"%s\"? "
8398 n (buffer-name buffer))))
8399 (error "Abort"))
8400 (let ((org-agenda-buffer-name bufname-orig))
8401 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8402 (with-current-buffer buffer (delete-region dbeg dend))
8403 (message "Agenda item and source killed"))))
8405 (defvar org-archive-default-command) ; defined in org-archive.el
8406 (defun org-agenda-archive-default ()
8407 "Archive the entry or subtree belonging to the current agenda entry."
8408 (interactive)
8409 (require 'org-archive)
8410 (org-agenda-archive-with org-archive-default-command))
8412 (defun org-agenda-archive-default-with-confirmation ()
8413 "Archive the entry or subtree belonging to the current agenda entry."
8414 (interactive)
8415 (require 'org-archive)
8416 (org-agenda-archive-with org-archive-default-command 'confirm))
8418 (defun org-agenda-archive ()
8419 "Archive the entry or subtree belonging to the current agenda entry."
8420 (interactive)
8421 (org-agenda-archive-with 'org-archive-subtree))
8423 (defun org-agenda-archive-to-archive-sibling ()
8424 "Move the entry to the archive sibling."
8425 (interactive)
8426 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8428 (defun org-agenda-archive-with (cmd &optional confirm)
8429 "Move the entry to the archive sibling."
8430 (interactive)
8431 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8432 (let* ((bufname-orig (buffer-name))
8433 (marker (or (org-get-at-bol 'org-marker)
8434 (org-agenda-error)))
8435 (buffer (marker-buffer marker))
8436 (pos (marker-position marker)))
8437 (org-with-remote-undo buffer
8438 (with-current-buffer buffer
8439 (if (derived-mode-p 'org-mode)
8440 (if (and confirm
8441 (not (y-or-n-p "Archive this subtree or entry? ")))
8442 (error "Abort")
8443 (save-window-excursion
8444 (goto-char pos)
8445 (let ((org-agenda-buffer-name bufname-orig))
8446 (org-remove-subtree-entries-from-agenda))
8447 (org-back-to-heading t)
8448 (funcall cmd)))
8449 (error "Archiving works only in Org-mode files"))))))
8451 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8452 "Remove all lines in the agenda that correspond to a given subtree.
8453 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8454 If this information is not given, the function uses the tree at point."
8455 (let ((buf (or buf (current-buffer))) m p)
8456 (save-excursion
8457 (unless (and beg end)
8458 (org-back-to-heading t)
8459 (setq beg (point))
8460 (org-end-of-subtree t)
8461 (setq end (point)))
8462 (set-buffer (get-buffer org-agenda-buffer-name))
8463 (save-excursion
8464 (goto-char (point-max))
8465 (beginning-of-line 1)
8466 (while (not (bobp))
8467 (when (and (setq m (org-get-at-bol 'org-marker))
8468 (equal buf (marker-buffer m))
8469 (setq p (marker-position m))
8470 (>= p beg)
8471 (< p end))
8472 (let ((inhibit-read-only t))
8473 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8474 (beginning-of-line 0))))))
8476 (defun org-agenda-refile (&optional goto rfloc no-update)
8477 "Refile the item at point.
8479 When GOTO is 0 or '(64) or \\[universal-argument] \\[universal-argument] \\[universal-argument], clear the refile cache.
8480 When GOTO is '(16) or \\[universal-argument] \\[universal-argument], go to the location of the last refiled item.
8481 RFLOC can be a refile location obtained in a different way.
8482 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8483 (interactive "P")
8484 (cond
8485 ((member goto '(0 (64)))
8486 (org-refile-cache-clear))
8487 ((equal goto '(16))
8488 (org-refile-goto-last-stored))
8490 (let* ((buffer-orig (buffer-name))
8491 (marker (or (org-get-at-bol 'org-hd-marker)
8492 (org-agenda-error)))
8493 (buffer (marker-buffer marker))
8494 (pos (marker-position marker))
8495 (rfloc (or rfloc
8496 (org-refile-get-location
8497 (if goto "Goto" "Refile to") buffer
8498 org-refile-allow-creating-parent-nodes))))
8499 (with-current-buffer buffer
8500 (save-excursion
8501 (save-restriction
8502 (widen)
8503 (goto-char marker)
8504 (let ((org-agenda-buffer-name buffer-orig))
8505 (org-remove-subtree-entries-from-agenda))
8506 (org-refile goto buffer rfloc)))))
8507 (unless no-update (org-agenda-redo)))))
8509 (defun org-agenda-open-link (&optional arg)
8510 "Open the link(s) in the current entry, if any.
8511 This looks for a link in the displayed line in the agenda.
8512 It also looks at the text of the entry itself."
8513 (interactive "P")
8514 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8515 (org-get-at-bol 'org-marker)))
8516 (buffer (and marker (marker-buffer marker)))
8517 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8518 (lkall (and buffer (org-offer-links-in-entry
8519 buffer marker arg prefix)))
8520 (lk0 (car lkall))
8521 (lk (if (stringp lk0) (list lk0) lk0))
8522 (lkend (cdr lkall))
8523 trg)
8524 (cond
8525 ((and buffer lk)
8526 (mapcar (lambda(l)
8527 (with-current-buffer buffer
8528 (setq trg (and (string-match org-bracket-link-regexp l)
8529 (match-string 1 l)))
8530 (if (or (not trg) (string-match org-any-link-re trg))
8531 (save-excursion
8532 (save-restriction
8533 (widen)
8534 (goto-char marker)
8535 (when (search-forward l nil lkend)
8536 (goto-char (match-beginning 0))
8537 (org-open-at-point))))
8538 ;; This is an internal link, widen the buffer
8539 (switch-to-buffer-other-window buffer)
8540 (widen)
8541 (goto-char marker)
8542 (when (search-forward l nil lkend)
8543 (goto-char (match-beginning 0))
8544 (org-open-at-point)))))
8545 lk))
8546 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8547 (save-excursion
8548 (beginning-of-line 1)
8549 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8550 (org-open-link-from-string (match-string 1)))
8551 (t (message "No link to open here")))))
8553 (defun org-agenda-copy-local-variable (var)
8554 "Get a variable from a referenced buffer and install it here."
8555 (let ((m (org-get-at-bol 'org-marker)))
8556 (when (and m (buffer-live-p (marker-buffer m)))
8557 (org-set-local var (with-current-buffer (marker-buffer m)
8558 (symbol-value var))))))
8560 (defun org-agenda-switch-to (&optional delete-other-windows)
8561 "Go to the Org-mode file which contains the item at point."
8562 (interactive)
8563 (if (and org-return-follows-link
8564 (not (org-get-at-bol 'org-marker))
8565 (org-in-regexp org-bracket-link-regexp))
8566 (org-open-link-from-string (match-string 0))
8567 (let* ((marker (or (org-get-at-bol 'org-marker)
8568 (org-agenda-error)))
8569 (buffer (marker-buffer marker))
8570 (pos (marker-position marker)))
8571 (org-pop-to-buffer-same-window buffer)
8572 (and delete-other-windows (delete-other-windows))
8573 (widen)
8574 (goto-char pos)
8575 (org-back-to-heading t)
8576 (when (derived-mode-p 'org-mode)
8577 (org-show-context 'agenda)
8578 (save-excursion
8579 (and (outline-next-heading)
8580 (org-flag-heading nil))) ; show the next heading
8581 (when (outline-invisible-p)
8582 (show-entry)) ; display invisible text
8583 (run-hooks 'org-agenda-after-show-hook)))))
8585 (defun org-agenda-goto-mouse (ev)
8586 "Go to the Org-mode file which contains the item at the mouse click."
8587 (interactive "e")
8588 (mouse-set-point ev)
8589 (org-agenda-goto))
8591 (defun org-agenda-show (&optional full-entry)
8592 "Display the Org-mode file which contains the item at point.
8593 With prefix argument FULL-ENTRY, make the entire entry visible
8594 if it was hidden in the outline."
8595 (interactive "P")
8596 (let ((win (selected-window)))
8597 (if full-entry
8598 (let ((org-show-entry-below t))
8599 (org-agenda-goto t))
8600 (org-agenda-goto t))
8601 (select-window win)))
8603 (defvar org-agenda-show-window nil)
8604 (defun org-agenda-show-and-scroll-up (&optional arg)
8605 "Display the Org-mode file which contains the item at point.
8606 When called repeatedly, scroll the window that is displaying the buffer.
8607 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8608 `show-subtree' to display the item, so that drawers and logbooks stay
8609 folded."
8610 (interactive "P")
8611 (let ((win (selected-window)))
8612 (if (and (window-live-p org-agenda-show-window)
8613 (eq this-command last-command))
8614 (progn
8615 (select-window org-agenda-show-window)
8616 (ignore-errors (scroll-up)))
8617 (org-agenda-goto t)
8618 (if arg (org-show-entry) (show-subtree))
8619 (setq org-agenda-show-window (selected-window)))
8620 (select-window win)))
8622 (defun org-agenda-show-scroll-down ()
8623 "Scroll down the window showing the agenda."
8624 (interactive)
8625 (let ((win (selected-window)))
8626 (when (window-live-p org-agenda-show-window)
8627 (select-window org-agenda-show-window)
8628 (ignore-errors (scroll-down))
8629 (select-window win))))
8631 (defun org-agenda-show-1 (&optional more)
8632 "Display the Org-mode file which contains the item at point.
8633 The prefix arg selects the amount of information to display:
8635 0 hide the subtree
8636 1 just show the entry according to defaults.
8637 2 show the children view
8638 3 show the subtree view
8639 4 show the entire subtree and any LOGBOOK drawers
8640 5 show the entire subtree and any drawers
8641 With prefix argument FULL-ENTRY, make the entire entry visible
8642 if it was hidden in the outline."
8643 (interactive "p")
8644 (let ((win (selected-window)))
8645 (org-agenda-goto t)
8646 (org-back-to-heading)
8647 (set-window-start (selected-window) (point-at-bol))
8648 (cond
8649 ((= more 0)
8650 (hide-subtree)
8651 (save-excursion
8652 (org-back-to-heading)
8653 (run-hook-with-args 'org-cycle-hook 'folded))
8654 (message "Remote: FOLDED"))
8655 ((and (org-called-interactively-p 'any) (= more 1))
8656 (message "Remote: show with default settings"))
8657 ((= more 2)
8658 (show-entry)
8659 (show-children)
8660 (save-excursion
8661 (org-back-to-heading)
8662 (run-hook-with-args 'org-cycle-hook 'children))
8663 (message "Remote: CHILDREN"))
8664 ((= more 3)
8665 (show-subtree)
8666 (save-excursion
8667 (org-back-to-heading)
8668 (run-hook-with-args 'org-cycle-hook 'subtree))
8669 (message "Remote: SUBTREE"))
8670 ((= more 4)
8671 (show-subtree)
8672 (save-excursion
8673 (org-back-to-heading)
8674 (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
8675 (message "Remote: SUBTREE AND LOGBOOK"))
8676 ((> more 4)
8677 (show-subtree)
8678 (message "Remote: SUBTREE AND ALL DRAWERS")))
8679 (select-window win)))
8681 (defvar org-agenda-cycle-counter nil)
8682 (defun org-agenda-cycle-show (&optional n)
8683 "Show the current entry in another window, with default settings.
8684 Default settings are taken from `org-show-hierarchy-above' and siblings.
8685 When use repeatedly in immediate succession, the remote entry will cycle
8686 through visibility
8688 children -> subtree -> folded
8690 When called with a numeric prefix arg, that arg will be passed through to
8691 `org-agenda-show-1'. For the interpretation of that argument, see the
8692 docstring of `org-agenda-show-1'."
8693 (interactive "P")
8694 (if (integerp n)
8695 (setq org-agenda-cycle-counter n)
8696 (if (not (eq last-command this-command))
8697 (setq org-agenda-cycle-counter 1)
8698 (if (equal org-agenda-cycle-counter 0)
8699 (setq org-agenda-cycle-counter 2)
8700 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8701 (if (> org-agenda-cycle-counter 3)
8702 (setq org-agenda-cycle-counter 0)))))
8703 (org-agenda-show-1 org-agenda-cycle-counter))
8705 (defun org-agenda-recenter (arg)
8706 "Display the Org-mode file which contains the item at point and recenter."
8707 (interactive "P")
8708 (let ((win (selected-window)))
8709 (org-agenda-goto t)
8710 (recenter arg)
8711 (select-window win)))
8713 (defun org-agenda-show-mouse (ev)
8714 "Display the Org-mode file which contains the item at the mouse click."
8715 (interactive "e")
8716 (mouse-set-point ev)
8717 (org-agenda-show))
8719 (defun org-agenda-check-no-diary ()
8720 "Check if the entry is a diary link and abort if yes."
8721 (if (org-get-at-bol 'org-agenda-diary-link)
8722 (org-agenda-error)))
8724 (defun org-agenda-error ()
8725 "Throw an error when a command is not allowed in the agenda."
8726 (user-error "Command not allowed in this line"))
8728 (defun org-agenda-tree-to-indirect-buffer (arg)
8729 "Show the subtree corresponding to the current entry in an indirect buffer.
8730 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8732 With a numerical prefix ARG, go up to this level and then take that tree.
8733 With a negative numeric ARG, go up by this number of levels.
8734 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8735 use the dedicated frame)."
8736 (interactive "P")
8737 (if current-prefix-arg
8738 (org-agenda-do-tree-to-indirect-buffer arg)
8739 (let ((agenda-buffer (buffer-name))
8740 (agenda-window (selected-window))
8741 (indirect-window
8742 (and org-last-indirect-buffer
8743 (get-buffer-window org-last-indirect-buffer))))
8744 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8745 (unless (or (eq org-indirect-buffer-display 'new-frame)
8746 (eq org-indirect-buffer-display 'dedicated-frame))
8747 (unwind-protect
8748 (unless (and indirect-window (window-live-p indirect-window))
8749 (setq indirect-window (split-window agenda-window)))
8750 (and indirect-window (select-window indirect-window))
8751 (switch-to-buffer org-last-indirect-buffer :norecord)
8752 (fit-window-to-buffer indirect-window)))
8753 (select-window (get-buffer-window agenda-buffer)))))
8755 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8756 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8757 (org-agenda-check-no-diary)
8758 (let* ((marker (or (org-get-at-bol 'org-marker)
8759 (org-agenda-error)))
8760 (buffer (marker-buffer marker))
8761 (pos (marker-position marker)))
8762 (with-current-buffer buffer
8763 (save-excursion
8764 (goto-char pos)
8765 (funcall 'org-tree-to-indirect-buffer arg)))))
8767 (defvar org-last-heading-marker (make-marker)
8768 "Marker pointing to the headline that last changed its TODO state
8769 by a remote command from the agenda.")
8771 (defun org-agenda-todo-nextset ()
8772 "Switch TODO entry to next sequence."
8773 (interactive)
8774 (org-agenda-todo 'nextset))
8776 (defun org-agenda-todo-previousset ()
8777 "Switch TODO entry to previous sequence."
8778 (interactive)
8779 (org-agenda-todo 'previousset))
8781 (defun org-agenda-todo (&optional arg)
8782 "Cycle TODO state of line at point, also in Org-mode file.
8783 This changes the line at point, all other lines in the agenda referring to
8784 the same tree node, and the headline of the tree node in the Org-mode file."
8785 (interactive "P")
8786 (org-agenda-check-no-diary)
8787 (let* ((col (current-column))
8788 (marker (or (org-get-at-bol 'org-marker)
8789 (org-agenda-error)))
8790 (buffer (marker-buffer marker))
8791 (pos (marker-position marker))
8792 (hdmarker (org-get-at-bol 'org-hd-marker))
8793 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
8794 (inhibit-read-only t)
8795 org-agenda-headline-snapshot-before-repeat newhead just-one)
8796 (org-with-remote-undo buffer
8797 (with-current-buffer buffer
8798 (widen)
8799 (goto-char pos)
8800 (org-show-context 'agenda)
8801 (save-excursion
8802 (and (outline-next-heading)
8803 (org-flag-heading nil))) ; show the next heading
8804 (let ((current-prefix-arg arg))
8805 (call-interactively 'org-todo))
8806 (and (bolp) (forward-char 1))
8807 (setq newhead (org-get-heading))
8808 (when (and (org-bound-and-true-p
8809 org-agenda-headline-snapshot-before-repeat)
8810 (not (equal org-agenda-headline-snapshot-before-repeat
8811 newhead))
8812 todayp)
8813 (setq newhead org-agenda-headline-snapshot-before-repeat
8814 just-one t))
8815 (save-excursion
8816 (org-back-to-heading)
8817 (move-marker org-last-heading-marker (point))))
8818 (beginning-of-line 1)
8819 (save-window-excursion
8820 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8821 (when (org-bound-and-true-p org-clock-out-when-done)
8822 (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
8823 newhead)
8824 (org-agenda-unmark-clocking-task))
8825 (org-move-to-column col)
8826 (org-agenda-mark-clocking-task))))
8828 (defun org-agenda-add-note (&optional arg)
8829 "Add a time-stamped note to the entry at point."
8830 (interactive "P")
8831 (org-agenda-check-no-diary)
8832 (let* ((marker (or (org-get-at-bol 'org-marker)
8833 (org-agenda-error)))
8834 (buffer (marker-buffer marker))
8835 (pos (marker-position marker))
8836 (hdmarker (org-get-at-bol 'org-hd-marker))
8837 (inhibit-read-only t))
8838 (with-current-buffer buffer
8839 (widen)
8840 (goto-char pos)
8841 (org-show-context 'agenda)
8842 (save-excursion
8843 (and (outline-next-heading)
8844 (org-flag-heading nil))) ; show the next heading
8845 (org-add-note))))
8847 (defun org-agenda-change-all-lines (newhead hdmarker
8848 &optional fixface just-this)
8849 "Change all lines in the agenda buffer which match HDMARKER.
8850 The new content of the line will be NEWHEAD (as modified by
8851 `org-agenda-format-item'). HDMARKER is checked with
8852 `equal' against all `org-hd-marker' text properties in the file.
8853 If FIXFACE is non-nil, the face of each item is modified according to
8854 the new TODO state.
8855 If JUST-THIS is non-nil, change just the current line, not all.
8856 If FORCE-TAGS is non nil, the car of it returns the new tags."
8857 (let* ((inhibit-read-only t)
8858 (line (org-current-line))
8859 (org-agenda-buffer (current-buffer))
8860 (thetags (with-current-buffer (marker-buffer hdmarker)
8861 (save-excursion (save-restriction (widen)
8862 (goto-char hdmarker)
8863 (org-get-tags-at)))))
8864 props m pl undone-face done-face finish new dotime level cat tags)
8865 (save-excursion
8866 (goto-char (point-max))
8867 (beginning-of-line 1)
8868 (while (not finish)
8869 (setq finish (bobp))
8870 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8871 (or (not just-this) (= (org-current-line) line))
8872 (equal m hdmarker))
8873 (setq props (text-properties-at (point))
8874 dotime (org-get-at-bol 'dotime)
8875 cat (org-get-at-eol 'org-category 1)
8876 level (org-get-at-bol 'level)
8877 tags thetags
8879 (let ((org-prefix-format-compiled
8880 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8881 org-prefix-format-compiled))
8882 (extra (org-get-at-bol 'extra)))
8883 (with-current-buffer (marker-buffer hdmarker)
8884 (save-excursion
8885 (save-restriction
8886 (widen)
8887 (org-agenda-format-item extra newhead level cat tags dotime)))))
8888 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8889 undone-face (org-get-at-bol 'undone-face)
8890 done-face (org-get-at-bol 'done-face))
8891 (beginning-of-line 1)
8892 (cond
8893 ((equal new "")
8894 (and (looking-at ".*\n?") (replace-match "")))
8895 ((looking-at ".*")
8896 (replace-match new t t)
8897 (beginning-of-line 1)
8898 (add-text-properties (point-at-bol) (point-at-eol) props)
8899 (when fixface
8900 (add-text-properties
8901 (point-at-bol) (point-at-eol)
8902 (list 'face
8903 (if org-last-todo-state-is-todo
8904 undone-face done-face))))
8905 (org-agenda-highlight-todo 'line)
8906 (beginning-of-line 1))
8907 (t (error "Line update did not work")))
8908 (save-restriction
8909 (narrow-to-region (point-at-bol) (point-at-eol))
8910 (org-agenda-finalize)))
8911 (beginning-of-line 0)))))
8913 (defun org-agenda-align-tags (&optional line)
8914 "Align all tags in agenda items to `org-agenda-tags-column'."
8915 (let ((inhibit-read-only t) l c)
8916 (save-excursion
8917 (goto-char (if line (point-at-bol) (point-min)))
8918 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8919 (if line (point-at-eol) nil) t)
8920 (add-text-properties
8921 (match-beginning 2) (match-end 2)
8922 (list 'face (delq nil (let ((prop (get-text-property
8923 (match-beginning 2) 'face)))
8924 (or (listp prop) (setq prop (list prop)))
8925 (if (memq 'org-tag prop)
8926 prop
8927 (cons 'org-tag prop))))))
8928 (setq l (- (match-end 2) (match-beginning 2))
8929 c (if (< org-agenda-tags-column 0)
8930 (- (abs org-agenda-tags-column) l)
8931 org-agenda-tags-column))
8932 (delete-region (match-beginning 1) (match-end 1))
8933 (goto-char (match-beginning 1))
8934 (insert (org-add-props
8935 (make-string (max 1 (- c (current-column))) ?\ )
8936 (plist-put (copy-sequence (text-properties-at (point)))
8937 'face nil))))
8938 (goto-char (point-min))
8939 (org-font-lock-add-tag-faces (point-max)))))
8941 (defun org-agenda-priority-up ()
8942 "Increase the priority of line at point, also in Org-mode file."
8943 (interactive)
8944 (org-agenda-priority 'up))
8946 (defun org-agenda-priority-down ()
8947 "Decrease the priority of line at point, also in Org-mode file."
8948 (interactive)
8949 (org-agenda-priority 'down))
8951 (defun org-agenda-priority (&optional force-direction)
8952 "Set the priority of line at point, also in Org-mode file.
8953 This changes the line at point, all other lines in the agenda referring to
8954 the same tree node, and the headline of the tree node in the Org-mode file.
8955 Called with a universal prefix arg, show the priority instead of setting it."
8956 (interactive "P")
8957 (if (equal force-direction '(4))
8958 (org-show-priority)
8959 (unless org-enable-priority-commands
8960 (error "Priority commands are disabled"))
8961 (org-agenda-check-no-diary)
8962 (let* ((col (current-column))
8963 (marker (or (org-get-at-bol 'org-marker)
8964 (org-agenda-error)))
8965 (hdmarker (org-get-at-bol 'org-hd-marker))
8966 (buffer (marker-buffer hdmarker))
8967 (pos (marker-position hdmarker))
8968 (inhibit-read-only t)
8969 newhead)
8970 (org-with-remote-undo buffer
8971 (with-current-buffer buffer
8972 (widen)
8973 (goto-char pos)
8974 (org-show-context 'agenda)
8975 (save-excursion
8976 (and (outline-next-heading)
8977 (org-flag-heading nil))) ; show the next heading
8978 (funcall 'org-priority force-direction)
8979 (end-of-line 1)
8980 (setq newhead (org-get-heading)))
8981 (org-agenda-change-all-lines newhead hdmarker)
8982 (org-move-to-column col)))))
8984 ;; FIXME: should fix the tags property of the agenda line.
8985 (defun org-agenda-set-tags (&optional tag onoff)
8986 "Set tags for the current headline."
8987 (interactive)
8988 (org-agenda-check-no-diary)
8989 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8990 (call-interactively 'org-change-tag-in-region)
8991 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8992 (org-agenda-error)))
8993 (buffer (marker-buffer hdmarker))
8994 (pos (marker-position hdmarker))
8995 (inhibit-read-only t)
8996 newhead)
8997 (org-with-remote-undo buffer
8998 (with-current-buffer buffer
8999 (widen)
9000 (goto-char pos)
9001 (save-excursion
9002 (org-show-context 'agenda))
9003 (save-excursion
9004 (and (outline-next-heading)
9005 (org-flag-heading nil))) ; show the next heading
9006 (goto-char pos)
9007 (if tag
9008 (org-toggle-tag tag onoff)
9009 (call-interactively 'org-set-tags))
9010 (end-of-line 1)
9011 (setq newhead (org-get-heading)))
9012 (org-agenda-change-all-lines newhead hdmarker)
9013 (beginning-of-line 1)))))
9015 (defun org-agenda-set-property ()
9016 "Set a property for the current headline."
9017 (interactive)
9018 (org-agenda-check-no-diary)
9019 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9020 (org-agenda-error)))
9021 (buffer (marker-buffer hdmarker))
9022 (pos (marker-position hdmarker))
9023 (inhibit-read-only t)
9024 newhead)
9025 (org-with-remote-undo buffer
9026 (with-current-buffer buffer
9027 (widen)
9028 (goto-char pos)
9029 (save-excursion
9030 (org-show-context 'agenda))
9031 (save-excursion
9032 (and (outline-next-heading)
9033 (org-flag-heading nil))) ; show the next heading
9034 (goto-char pos)
9035 (call-interactively 'org-set-property)))))
9037 (defun org-agenda-set-effort ()
9038 "Set the effort property for the current headline."
9039 (interactive)
9040 (org-agenda-check-no-diary)
9041 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9042 (org-agenda-error)))
9043 (buffer (marker-buffer hdmarker))
9044 (pos (marker-position hdmarker))
9045 (inhibit-read-only t)
9046 newhead)
9047 (org-with-remote-undo buffer
9048 (with-current-buffer buffer
9049 (widen)
9050 (goto-char pos)
9051 (save-excursion
9052 (org-show-context 'agenda))
9053 (save-excursion
9054 (and (outline-next-heading)
9055 (org-flag-heading nil))) ; show the next heading
9056 (goto-char pos)
9057 (call-interactively 'org-set-effort)
9058 (end-of-line 1)
9059 (setq newhead (org-get-heading)))
9060 (org-agenda-change-all-lines newhead hdmarker))))
9062 (defun org-agenda-toggle-archive-tag ()
9063 "Toggle the archive tag for the current entry."
9064 (interactive)
9065 (org-agenda-check-no-diary)
9066 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9067 (org-agenda-error)))
9068 (buffer (marker-buffer hdmarker))
9069 (pos (marker-position hdmarker))
9070 (inhibit-read-only t)
9071 newhead)
9072 (org-with-remote-undo buffer
9073 (with-current-buffer buffer
9074 (widen)
9075 (goto-char pos)
9076 (org-show-context 'agenda)
9077 (save-excursion
9078 (and (outline-next-heading)
9079 (org-flag-heading nil))) ; show the next heading
9080 (call-interactively 'org-toggle-archive-tag)
9081 (end-of-line 1)
9082 (setq newhead (org-get-heading)))
9083 (org-agenda-change-all-lines newhead hdmarker)
9084 (beginning-of-line 1))))
9086 (defun org-agenda-do-date-later (arg)
9087 (interactive "P")
9088 (cond
9089 ((or (equal arg '(16))
9090 (memq last-command
9091 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9092 (setq this-command 'org-agenda-date-later-minutes)
9093 (org-agenda-date-later-minutes 1))
9094 ((or (equal arg '(4))
9095 (memq last-command
9096 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9097 (setq this-command 'org-agenda-date-later-hours)
9098 (org-agenda-date-later-hours 1))
9100 (org-agenda-date-later (prefix-numeric-value arg)))))
9102 (defun org-agenda-do-date-earlier (arg)
9103 (interactive "P")
9104 (cond
9105 ((or (equal arg '(16))
9106 (memq last-command
9107 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9108 (setq this-command 'org-agenda-date-earlier-minutes)
9109 (org-agenda-date-earlier-minutes 1))
9110 ((or (equal arg '(4))
9111 (memq last-command
9112 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9113 (setq this-command 'org-agenda-date-earlier-hours)
9114 (org-agenda-date-earlier-hours 1))
9116 (org-agenda-date-earlier (prefix-numeric-value arg)))))
9118 (defun org-agenda-date-later (arg &optional what)
9119 "Change the date of this item to ARG day(s) later."
9120 (interactive "p")
9121 (org-agenda-check-type t 'agenda 'timeline)
9122 (org-agenda-check-no-diary)
9123 (let* ((marker (or (org-get-at-bol 'org-marker)
9124 (org-agenda-error)))
9125 (buffer (marker-buffer marker))
9126 (pos (marker-position marker))
9127 cdate today)
9128 (org-with-remote-undo buffer
9129 (with-current-buffer buffer
9130 (widen)
9131 (goto-char pos)
9132 (if (not (org-at-timestamp-p))
9133 (error "Cannot find time stamp"))
9134 (when (and org-agenda-move-date-from-past-immediately-to-today
9135 (equal arg 1)
9136 (or (not what) (eq what 'day))
9137 (not (save-match-data (org-at-date-range-p))))
9138 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
9139 cdate (calendar-absolute-from-gregorian
9140 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
9141 today (org-today))
9142 (if (> today cdate)
9143 ;; immediately shift to today
9144 (setq arg (- today cdate))))
9145 (org-timestamp-change arg (or what 'day))
9146 (when (and (org-at-date-range-p)
9147 (re-search-backward org-tr-regexp-both (point-at-bol)))
9148 (let ((end org-last-changed-timestamp))
9149 (org-timestamp-change arg (or what 'day))
9150 (setq org-last-changed-timestamp
9151 (concat org-last-changed-timestamp "--" end)))))
9152 (org-agenda-show-new-time marker org-last-changed-timestamp))
9153 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9155 (defun org-agenda-date-earlier (arg &optional what)
9156 "Change the date of this item to ARG day(s) earlier."
9157 (interactive "p")
9158 (org-agenda-date-later (- arg) what))
9160 (defun org-agenda-date-later-minutes (arg)
9161 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9162 (interactive "p")
9163 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9164 (org-agenda-date-later arg 'minute))
9166 (defun org-agenda-date-earlier-minutes (arg)
9167 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9168 (interactive "p")
9169 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9170 (org-agenda-date-earlier arg 'minute))
9172 (defun org-agenda-date-later-hours (arg)
9173 "Change the time of this item, in hour steps."
9174 (interactive "p")
9175 (org-agenda-date-later arg 'hour))
9177 (defun org-agenda-date-earlier-hours (arg)
9178 "Change the time of this item, in hour steps."
9179 (interactive "p")
9180 (org-agenda-date-earlier arg 'hour))
9182 (defun org-agenda-show-new-time (marker stamp &optional prefix)
9183 "Show new date stamp via text properties."
9184 ;; We use text properties to make this undoable
9185 (let ((inhibit-read-only t))
9186 (setq stamp (concat prefix " => " stamp " "))
9187 (save-excursion
9188 (goto-char (point-max))
9189 (while (not (bobp))
9190 (when (equal marker (org-get-at-bol 'org-marker))
9191 (remove-text-properties (point-at-bol) (point-at-eol) '(display))
9192 (org-move-to-column (- (window-width) (length stamp)) t)
9193 (if (featurep 'xemacs)
9194 ;; Use `duplicable' property to trigger undo recording
9195 (let ((ex (make-extent nil nil))
9196 (gl (make-glyph stamp)))
9197 (set-glyph-face gl 'secondary-selection)
9198 (set-extent-properties
9199 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9200 (insert-extent ex (1- (point)) (point-at-eol)))
9201 (add-text-properties
9202 (1- (point)) (point-at-eol)
9203 (list 'display (org-add-props stamp nil
9204 'face '(secondary-selection default)))))
9205 (beginning-of-line 1))
9206 (beginning-of-line 0)))))
9208 (defun org-agenda-date-prompt (arg)
9209 "Change the date of this item. Date is prompted for, with default today.
9210 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9211 be used to request time specification in the time stamp."
9212 (interactive "P")
9213 (org-agenda-check-type t 'agenda 'timeline)
9214 (org-agenda-check-no-diary)
9215 (let* ((marker (or (org-get-at-bol 'org-marker)
9216 (org-agenda-error)))
9217 (buffer (marker-buffer marker))
9218 (pos (marker-position marker)))
9219 (org-with-remote-undo buffer
9220 (with-current-buffer buffer
9221 (widen)
9222 (goto-char pos)
9223 (if (not (org-at-timestamp-p t))
9224 (error "Cannot find time stamp"))
9225 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9226 (org-agenda-show-new-time marker org-last-changed-timestamp))
9227 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9229 (defun org-agenda-schedule (arg &optional time)
9230 "Schedule the item at point.
9231 ARG is passed through to `org-schedule'."
9232 (interactive "P")
9233 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9234 (org-agenda-check-no-diary)
9235 (let* ((marker (or (org-get-at-bol 'org-marker)
9236 (org-agenda-error)))
9237 (type (marker-insertion-type marker))
9238 (buffer (marker-buffer marker))
9239 (pos (marker-position marker))
9240 (org-insert-labeled-timestamps-at-point nil)
9242 (set-marker-insertion-type marker t)
9243 (org-with-remote-undo buffer
9244 (with-current-buffer buffer
9245 (widen)
9246 (goto-char pos)
9247 (setq ts (org-schedule arg time)))
9248 (org-agenda-show-new-time marker ts " S"))
9249 (message "%s" ts)))
9251 (defun org-agenda-deadline (arg &optional time)
9252 "Schedule the item at point.
9253 ARG is passed through to `org-deadline'."
9254 (interactive "P")
9255 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9256 (org-agenda-check-no-diary)
9257 (let* ((marker (or (org-get-at-bol 'org-marker)
9258 (org-agenda-error)))
9259 (buffer (marker-buffer marker))
9260 (pos (marker-position marker))
9261 (org-insert-labeled-timestamps-at-point nil)
9263 (org-with-remote-undo buffer
9264 (with-current-buffer buffer
9265 (widen)
9266 (goto-char pos)
9267 (setq ts (org-deadline arg time)))
9268 (org-agenda-show-new-time marker ts " D"))
9269 (message "%s" ts)))
9271 (defun org-agenda-clock-in (&optional arg)
9272 "Start the clock on the currently selected item."
9273 (interactive "P")
9274 (org-agenda-check-no-diary)
9275 (if (equal arg '(4))
9276 (org-clock-in arg)
9277 (let* ((marker (or (org-get-at-bol 'org-marker)
9278 (org-agenda-error)))
9279 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9280 (pos (marker-position marker))
9281 (col (current-column))
9282 newhead)
9283 (org-with-remote-undo (marker-buffer marker)
9284 (with-current-buffer (marker-buffer marker)
9285 (widen)
9286 (goto-char pos)
9287 (org-show-context 'agenda)
9288 (org-show-entry)
9289 (org-cycle-hide-drawers 'children)
9290 (org-clock-in arg)
9291 (setq newhead (org-get-heading)))
9292 (org-agenda-change-all-lines newhead hdmarker))
9293 (org-move-to-column col))))
9295 (defun org-agenda-clock-out ()
9296 "Stop the currently running clock."
9297 (interactive)
9298 (unless (marker-buffer org-clock-marker)
9299 (error "No running clock"))
9300 (let ((marker (make-marker)) (col (current-column)) newhead)
9301 (org-with-remote-undo (marker-buffer org-clock-marker)
9302 (with-current-buffer (marker-buffer org-clock-marker)
9303 (save-excursion
9304 (save-restriction
9305 (widen)
9306 (goto-char org-clock-marker)
9307 (org-back-to-heading t)
9308 (move-marker marker (point))
9309 (org-clock-out)
9310 (setq newhead (org-get-heading))))))
9311 (org-agenda-change-all-lines newhead marker)
9312 (move-marker marker nil)
9313 (org-move-to-column col)
9314 (org-agenda-unmark-clocking-task)))
9316 (defun org-agenda-clock-cancel (&optional arg)
9317 "Cancel the currently running clock."
9318 (interactive "P")
9319 (unless (marker-buffer org-clock-marker)
9320 (user-error "No running clock"))
9321 (org-with-remote-undo (marker-buffer org-clock-marker)
9322 (org-clock-cancel)))
9324 (defun org-agenda-clock-goto ()
9325 "Jump to the currently clocked in task within the agenda.
9326 If the currently clocked in task is not listed in the agenda
9327 buffer, display it in another window."
9328 (interactive)
9329 (let (pos)
9330 (mapc (lambda (o)
9331 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9332 (setq pos (overlay-start o))))
9333 (overlays-in (point-min) (point-max)))
9334 (cond (pos (goto-char pos))
9335 ;; If the currently clocked entry is not in the agenda
9336 ;; buffer, we visit it in another window:
9337 (org-clock-current-task
9338 (org-switch-to-buffer-other-window (org-clock-goto)))
9339 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9341 (defun org-agenda-diary-entry-in-org-file ()
9342 "Make a diary entry in the file `org-agenda-diary-file'."
9343 (let (d1 d2 char (text "") dp1 dp2)
9344 (if (equal (buffer-name) "*Calendar*")
9345 (setq d1 (calendar-cursor-to-date t)
9346 d2 (car calendar-mark-ring))
9347 (setq dp1 (get-text-property (point-at-bol) 'day))
9348 (unless dp1 (user-error "No date defined in current line"))
9349 (setq d1 (calendar-gregorian-from-absolute dp1)
9350 d2 (and (ignore-errors (mark))
9351 (save-excursion
9352 (goto-char (mark))
9353 (setq dp2 (get-text-property (point-at-bol) 'day)))
9354 (calendar-gregorian-from-absolute dp2))))
9355 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9356 (setq char (read-char-exclusive))
9357 (cond
9358 ((equal char ?d)
9359 (setq text (read-string "Day entry: "))
9360 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9361 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9362 ((equal char ?a)
9363 (setq d1 (list (car d1) (nth 1 d1)
9364 (read-number (format "Reference year [%d]: " (nth 2 d1))
9365 (nth 2 d1))))
9366 (setq text (read-string "Anniversary (use %d to show years): "))
9367 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9368 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9369 ((equal char ?b)
9370 (setq text (read-string "Block entry: "))
9371 (unless (and d1 d2 (not (equal d1 d2)))
9372 (user-error "No block of days selected"))
9373 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9374 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9375 ((equal char ?j)
9376 (org-switch-to-buffer-other-window
9377 (find-file-noselect org-agenda-diary-file))
9378 (require 'org-datetree)
9379 (org-datetree-find-date-create d1)
9380 (org-reveal t))
9381 (t (user-error "Invalid selection character `%c'" char)))))
9383 (defcustom org-agenda-insert-diary-strategy 'date-tree
9384 "Where in `org-agenda-diary-file' should new entries be added?
9385 Valid values:
9387 date-tree in the date tree, as child of the date
9388 top-level as top-level entries at the end of the file."
9389 :group 'org-agenda
9390 :type '(choice
9391 (const :tag "in a date tree" date-tree)
9392 (const :tag "as top level at end of file" top-level)))
9394 (defcustom org-agenda-insert-diary-extract-time nil
9395 "Non-nil means extract any time specification from the diary entry."
9396 :group 'org-agenda
9397 :version "24.1"
9398 :type 'boolean)
9400 (defcustom org-agenda-bulk-mark-char ">"
9401 "A single-character string to be used as the bulk mark."
9402 :group 'org-agenda
9403 :version "24.1"
9404 :type 'string)
9406 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9407 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9408 If TEXT is not empty, it will become the headline of the new entry, and
9409 the resulting entry will not be shown. When TEXT is empty, switch to
9410 `org-agenda-diary-file' and let the user finish the entry there."
9411 (let ((cw (current-window-configuration)))
9412 (org-switch-to-buffer-other-window
9413 (find-file-noselect org-agenda-diary-file))
9414 (widen)
9415 (goto-char (point-min))
9416 (cond
9417 ((eq type 'anniversary)
9418 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9419 (progn
9420 (or (org-at-heading-p t)
9421 (progn
9422 (outline-next-heading)
9423 (insert "* Anniversaries\n\n")
9424 (beginning-of-line -1)))))
9425 (outline-next-heading)
9426 (org-back-over-empty-lines)
9427 (backward-char 1)
9428 (insert "\n")
9429 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9430 (nth 2 d1) (car d1) (nth 1 d1) text)))
9431 ((eq type 'day)
9432 (let ((org-prefix-has-time t)
9433 (org-agenda-time-leading-zero t)
9434 fmt time time2)
9435 (if org-agenda-insert-diary-extract-time
9436 ;; Use org-agenda-format-item to parse text for a time-range and
9437 ;; remove it. FIXME: This is a hack, we should refactor
9438 ;; that function to make time extraction available separately
9439 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9440 time (get-text-property 0 'time fmt)
9441 time2 (if (> (length time) 0)
9442 ;; split-string removes trailing ...... if
9443 ;; no end time given. First space
9444 ;; separates time from date.
9445 (concat " " (car (split-string time "\\.")))
9446 nil)
9447 text (get-text-property 0 'txt fmt)))
9448 (if (eq org-agenda-insert-diary-strategy 'top-level)
9449 (org-agenda-insert-diary-as-top-level text)
9450 (require 'org-datetree)
9451 (org-datetree-find-date-create d1)
9452 (org-agenda-insert-diary-make-new-entry text))
9453 (org-insert-time-stamp (org-time-from-absolute
9454 (calendar-absolute-from-gregorian d1))
9455 nil nil nil nil time2))
9456 (end-of-line 0))
9457 ((eq type 'block)
9458 (if (> (calendar-absolute-from-gregorian d1)
9459 (calendar-absolute-from-gregorian d2))
9460 (setq d1 (prog1 d2 (setq d2 d1))))
9461 (if (eq org-agenda-insert-diary-strategy 'top-level)
9462 (org-agenda-insert-diary-as-top-level text)
9463 (require 'org-datetree)
9464 (org-datetree-find-date-create d1)
9465 (org-agenda-insert-diary-make-new-entry text))
9466 (org-insert-time-stamp (org-time-from-absolute
9467 (calendar-absolute-from-gregorian d1)))
9468 (insert "--")
9469 (org-insert-time-stamp (org-time-from-absolute
9470 (calendar-absolute-from-gregorian d2)))
9471 (end-of-line 0)))
9472 (if (string-match "\\S-" text)
9473 (progn
9474 (set-window-configuration cw)
9475 (message "%s entry added to %s"
9476 (capitalize (symbol-name type))
9477 (abbreviate-file-name org-agenda-diary-file)))
9478 (org-reveal t)
9479 (message "Please finish entry here"))))
9481 (defun org-agenda-insert-diary-as-top-level (text)
9482 "Make new entry as a top-level entry at the end of the file.
9483 Add TEXT as headline, and position the cursor in the second line so that
9484 a timestamp can be added there."
9485 (widen)
9486 (goto-char (point-max))
9487 (or (bolp) (insert "\n"))
9488 (insert "* " text "\n")
9489 (if org-adapt-indentation (org-indent-to-column 2)))
9491 (defun org-agenda-insert-diary-make-new-entry (text)
9492 "Make a new entry with TEXT as the first child of the current subtree.
9493 Position the point in the line right after the new heading so
9494 that a timestamp can be added there."
9495 (let ((org-show-following-heading t)
9496 (org-show-siblings t)
9497 (org-show-hierarchy-above t)
9498 (org-show-entry-below t)
9499 col)
9500 (outline-next-heading)
9501 (org-back-over-empty-lines)
9502 (or (looking-at "[ \t]*$")
9503 (progn (insert "\n") (backward-char 1)))
9504 (org-insert-heading nil t)
9505 (org-do-demote)
9506 (setq col (current-column))
9507 (insert text "\n")
9508 (if org-adapt-indentation (org-indent-to-column col))
9509 (let ((org-show-following-heading t)
9510 (org-show-siblings t)
9511 (org-show-hierarchy-above t)
9512 (org-show-entry-below t))
9513 (org-show-context))))
9515 (defun org-agenda-diary-entry ()
9516 "Make a diary entry, like the `i' command from the calendar.
9517 All the standard commands work: block, weekly etc.
9518 When `org-agenda-diary-file' points to a file,
9519 `org-agenda-diary-entry-in-org-file' is called instead to create
9520 entries in that Org-mode file."
9521 (interactive)
9522 (if (not (eq org-agenda-diary-file 'diary-file))
9523 (org-agenda-diary-entry-in-org-file)
9524 (require 'diary-lib)
9525 (let* ((char (progn
9526 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9527 (read-char-exclusive)))
9528 (cmd (cdr (assoc char
9529 '((?d . insert-diary-entry)
9530 (?w . insert-weekly-diary-entry)
9531 (?m . insert-monthly-diary-entry)
9532 (?y . insert-yearly-diary-entry)
9533 (?a . insert-anniversary-diary-entry)
9534 (?b . insert-block-diary-entry)
9535 (?c . insert-cyclic-diary-entry)))))
9536 (oldf (symbol-function 'calendar-cursor-to-date))
9537 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9538 (point (point))
9539 (mark (or (mark t) (point))))
9540 (unless cmd
9541 (user-error "No command associated with <%c>" char))
9542 (unless (and (get-text-property point 'day)
9543 (or (not (equal ?b char))
9544 (get-text-property mark 'day)))
9545 (user-error "Don't know which date to use for diary entry"))
9546 ;; We implement this by hacking the `calendar-cursor-to-date' function
9547 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9548 (let ((calendar-mark-ring
9549 (list (calendar-gregorian-from-absolute
9550 (or (get-text-property mark 'day)
9551 (get-text-property point 'day))))))
9552 (unwind-protect
9553 (progn
9554 (fset 'calendar-cursor-to-date
9555 (lambda (&optional error dummy)
9556 (calendar-gregorian-from-absolute
9557 (get-text-property point 'day))))
9558 (call-interactively cmd))
9559 (fset 'calendar-cursor-to-date oldf))))))
9561 (defun org-agenda-execute-calendar-command (cmd)
9562 "Execute a calendar command from the agenda with date from cursor."
9563 (org-agenda-check-type t 'agenda 'timeline)
9564 (require 'diary-lib)
9565 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9566 (user-error "Don't know which date to use for the calendar command"))
9567 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9568 (point (point))
9569 (date (calendar-gregorian-from-absolute
9570 (get-text-property point 'day)))
9571 ;; the following 2 vars are needed in the calendar
9572 (displayed-month (car date))
9573 (displayed-year (nth 2 date)))
9574 (unwind-protect
9575 (progn
9576 (fset 'calendar-cursor-to-date
9577 (lambda (&optional error dummy)
9578 (calendar-gregorian-from-absolute
9579 (get-text-property point 'day))))
9580 (call-interactively cmd))
9581 (fset 'calendar-cursor-to-date oldf))))
9583 (defun org-agenda-phases-of-moon ()
9584 "Display the phases of the moon for the 3 months around the cursor date."
9585 (interactive)
9586 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
9588 (defun org-agenda-holidays ()
9589 "Display the holidays for the 3 months around the cursor date."
9590 (interactive)
9591 (org-agenda-execute-calendar-command 'list-calendar-holidays))
9593 (defvar calendar-longitude) ; defined in calendar.el
9594 (defvar calendar-latitude) ; defined in calendar.el
9595 (defvar calendar-location-name) ; defined in calendar.el
9597 (defun org-agenda-sunrise-sunset (arg)
9598 "Display sunrise and sunset for the cursor date.
9599 Latitude and longitude can be specified with the variables
9600 `calendar-latitude' and `calendar-longitude'. When called with prefix
9601 argument, latitude and longitude will be prompted for."
9602 (interactive "P")
9603 (require 'solar)
9604 (let ((calendar-longitude (if arg nil calendar-longitude))
9605 (calendar-latitude (if arg nil calendar-latitude))
9606 (calendar-location-name
9607 (if arg "the given coordinates" calendar-location-name)))
9608 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9610 (defun org-agenda-goto-calendar ()
9611 "Open the Emacs calendar with the date at the cursor."
9612 (interactive)
9613 (org-agenda-check-type t 'agenda 'timeline)
9614 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9615 (user-error "Don't know which date to open in calendar")))
9616 (date (calendar-gregorian-from-absolute day))
9617 (calendar-move-hook nil)
9618 (calendar-view-holidays-initially-flag nil)
9619 (calendar-view-diary-initially-flag nil))
9620 (calendar)
9621 (calendar-goto-date date)))
9623 ;;;###autoload
9624 (defun org-calendar-goto-agenda ()
9625 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9626 This is a command that has to be installed in `calendar-mode-map'."
9627 (interactive)
9628 (org-agenda-list nil (calendar-absolute-from-gregorian
9629 (calendar-cursor-to-date))
9630 nil))
9632 (defun org-agenda-convert-date ()
9633 (interactive)
9634 (org-agenda-check-type t 'agenda 'timeline)
9635 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9636 date s)
9637 (unless day
9638 (user-error "Don't know which date to convert"))
9639 (setq date (calendar-gregorian-from-absolute day))
9640 (setq s (concat
9641 "Gregorian: " (calendar-date-string date) "\n"
9642 "ISO: " (calendar-iso-date-string date) "\n"
9643 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9644 "Julian: " (calendar-julian-date-string date) "\n"
9645 "Astron. JD: " (calendar-astro-date-string date)
9646 " (Julian date number at noon UTC)\n"
9647 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9648 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9649 "French: " (calendar-french-date-string date) "\n"
9650 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
9651 "Mayan: " (calendar-mayan-date-string date) "\n"
9652 "Coptic: " (calendar-coptic-date-string date) "\n"
9653 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9654 "Persian: " (calendar-persian-date-string date) "\n"
9655 "Chinese: " (calendar-chinese-date-string date) "\n"))
9656 (with-output-to-temp-buffer "*Dates*"
9657 (princ s))
9658 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9660 ;;; Bulk commands
9662 (defun org-agenda-bulk-marked-p ()
9663 (eq (get-char-property (point-at-bol) 'type)
9664 'org-marked-entry-overlay))
9666 (defun org-agenda-bulk-mark (&optional arg)
9667 "Mark the entry at point for future bulk action."
9668 (interactive "p")
9669 (dotimes (i (or arg 1))
9670 (unless (org-get-at-bol 'org-agenda-diary-link)
9671 (let* ((m (org-get-at-bol 'org-hd-marker))
9673 (unless (org-agenda-bulk-marked-p)
9674 (unless m (user-error "Nothing to mark at point"))
9675 (push m org-agenda-bulk-marked-entries)
9676 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9677 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9678 (org-get-todo-face "TODO")
9679 'evaporate)
9680 (overlay-put ov 'type 'org-marked-entry-overlay))
9681 (end-of-line 1)
9682 (or (ignore-errors
9683 (goto-char (next-single-property-change (point) 'txt)))
9684 (beginning-of-line 2))
9685 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9686 (beginning-of-line 2))
9687 (message "%d entries marked for bulk action"
9688 (length org-agenda-bulk-marked-entries))))))
9690 (defun org-agenda-bulk-mark-all ()
9691 "Mark all entries for future agenda bulk action."
9692 (interactive)
9693 (org-agenda-bulk-mark-regexp "."))
9695 (defun org-agenda-bulk-mark-regexp (regexp)
9696 "Mark entries matching REGEXP for future agenda bulk action."
9697 (interactive "sMark entries matching regexp: ")
9698 (let ((entries-marked 0) txt-at-point)
9699 (save-excursion
9700 (goto-char (point-min))
9701 (goto-char (next-single-property-change (point) 'txt))
9702 (while (and (re-search-forward regexp nil t)
9703 (setq txt-at-point (get-text-property (point) 'txt)))
9704 (when (string-match regexp txt-at-point)
9705 (setq entries-marked (1+ entries-marked))
9706 (call-interactively 'org-agenda-bulk-mark))))
9707 (if (not entries-marked)
9708 (message "No entry matching this regexp."))))
9710 (defun org-agenda-bulk-unmark (&optional arg)
9711 "Unmark the entry at point for future bulk action."
9712 (interactive "P")
9713 (if arg
9714 (org-agenda-bulk-unmark-all)
9715 (cond ((org-agenda-bulk-marked-p)
9716 (org-agenda-bulk-remove-overlays
9717 (point-at-bol) (+ 2 (point-at-bol)))
9718 (setq org-agenda-bulk-marked-entries
9719 (delete (org-get-at-bol 'org-hd-marker)
9720 org-agenda-bulk-marked-entries))
9721 (end-of-line 1)
9722 (or (ignore-errors
9723 (goto-char (next-single-property-change (point) 'txt)))
9724 (beginning-of-line 2))
9725 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9726 (beginning-of-line 2))
9727 (message "%d entries left marked for bulk action"
9728 (length org-agenda-bulk-marked-entries)))
9729 (t (message "No entry to unmark here")))))
9731 (defun org-agenda-bulk-toggle-all ()
9732 "Toggle all marks for bulk action."
9733 (interactive)
9734 (save-excursion
9735 (goto-char (point-min))
9736 (while (ignore-errors
9737 (goto-char (next-single-property-change (point) 'txt)))
9738 (org-agenda-bulk-toggle))))
9740 (defun org-agenda-bulk-toggle ()
9741 "Toggle the mark at point for bulk action."
9742 (interactive)
9743 (if (org-agenda-bulk-marked-p)
9744 (org-agenda-bulk-unmark)
9745 (org-agenda-bulk-mark)))
9747 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9748 "Remove the mark overlays between BEG and END in the agenda buffer.
9749 BEG and END default to the buffer limits.
9751 This only removes the overlays, it does not remove the markers
9752 from the list in `org-agenda-bulk-marked-entries'."
9753 (interactive)
9754 (mapc (lambda (ov)
9755 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9756 (delete-overlay ov)))
9757 (overlays-in (or beg (point-min)) (or end (point-max)))))
9759 (defun org-agenda-bulk-unmark-all ()
9760 "Remove all marks in the agenda buffer.
9761 This will remove the markers and the overlays."
9762 (interactive)
9763 (if (null org-agenda-bulk-marked-entries)
9764 (message "No entry to unmark")
9765 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9766 (setq org-agenda-bulk-marked-entries nil)
9767 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9769 (defcustom org-agenda-persistent-marks nil
9770 "Non-nil means marked items will stay marked after a bulk action.
9771 You can toggle this interactively by typing `p' when prompted for a
9772 bulk action."
9773 :group 'org-agenda
9774 :version "24.1"
9775 :type 'boolean)
9777 (defun org-agenda-bulk-action (&optional arg)
9778 "Execute an remote-editing action on all marked entries.
9779 The prefix arg is passed through to the command if possible."
9780 (interactive "P")
9781 ;; Make sure we have markers, and only valid ones
9782 (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
9783 (mapc
9784 (lambda (m)
9785 (unless (and (markerp m)
9786 (marker-buffer m)
9787 (buffer-live-p (marker-buffer m))
9788 (marker-position m))
9789 (user-error "Marker %s for bulk command is invalid" m)))
9790 org-agenda-bulk-marked-entries)
9792 ;; Prompt for the bulk command
9793 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9794 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9795 "[S]catter [f]unction "
9796 (when org-agenda-bulk-custom-functions
9797 (concat " Custom: ["
9798 (mapconcat (lambda(f) (char-to-string (car f)))
9799 org-agenda-bulk-custom-functions "")
9800 "]"))))
9801 (catch 'exit
9802 (let* ((action (read-char-exclusive))
9803 (org-log-refile (if org-log-refile 'time nil))
9804 (entries (reverse org-agenda-bulk-marked-entries))
9805 (org-overriding-default-time
9806 (if (get-text-property (point) 'org-agenda-date-header)
9807 (org-get-cursor-date)))
9808 redo-at-end
9809 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9810 (cond
9811 ((equal action ?p)
9812 (let ((org-agenda-persistent-marks
9813 (not org-agenda-persistent-marks)))
9814 (org-agenda-bulk-action)
9815 (throw 'exit nil)))
9817 ((equal action ?$)
9818 (setq cmd '(org-agenda-archive)))
9820 ((equal action ?A)
9821 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9823 ((member action '(?r ?w))
9824 (setq rfloc (org-refile-get-location
9825 "Refile to"
9826 (marker-buffer (car entries))
9827 org-refile-allow-creating-parent-nodes))
9828 (if (nth 3 rfloc)
9829 (setcar (nthcdr 3 rfloc)
9830 (move-marker (make-marker) (nth 3 rfloc)
9831 (or (get-file-buffer (nth 1 rfloc))
9832 (find-buffer-visiting (nth 1 rfloc))
9833 (error "This should not happen")))))
9835 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9836 redo-at-end t))
9838 ((equal action ?t)
9839 (setq state (org-icompleting-read
9840 "Todo state: "
9841 (with-current-buffer (marker-buffer (car entries))
9842 (mapcar 'list org-todo-keywords-1))))
9843 (setq cmd `(let ((org-inhibit-blocking t)
9844 (org-inhibit-logging 'note))
9845 (org-agenda-todo ,state))))
9847 ((memq action '(?- ?+))
9848 (setq tag (org-icompleting-read
9849 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9850 (with-current-buffer (marker-buffer (car entries))
9851 (delq nil
9852 (mapcar (lambda (x)
9853 (if (stringp (car x)) x)) org-tag-alist)))))
9854 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9856 ((memq action '(?s ?d))
9857 (let* ((time
9858 (unless arg
9859 (org-read-date
9860 nil nil nil
9861 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9862 org-overriding-default-time)))
9863 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9864 (setq cmd `(eval '(,c1 arg ,time)))))
9866 ((equal action ?S)
9867 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9868 (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9869 (let ((days (read-number
9870 (format "Scatter tasks across how many %sdays: "
9871 (if arg "week" "")) 7)))
9872 (setq cmd
9873 `(let ((distance (1+ (random ,days))))
9874 (if arg
9875 (let ((dist distance)
9876 (day-of-week
9877 (calendar-day-of-week
9878 (calendar-gregorian-from-absolute (org-today)))))
9879 (dotimes (i (1+ dist))
9880 (while (member day-of-week org-agenda-weekend-days)
9881 (incf distance)
9882 (incf day-of-week)
9883 (if (= day-of-week 7)
9884 (setq day-of-week 0)))
9885 (incf day-of-week)
9886 (if (= day-of-week 7)
9887 (setq day-of-week 0)))))
9888 ;; silently fail when try to replan a sexp entry
9889 (condition-case nil
9890 (let* ((date (calendar-gregorian-from-absolute
9891 (+ (org-today) distance)))
9892 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9893 (nth 2 date))))
9894 (org-agenda-schedule nil time))
9895 (error nil)))))))
9897 ((assoc action org-agenda-bulk-custom-functions)
9898 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9899 redo-at-end t))
9901 ((equal action ?f)
9902 (setq cmd (list (intern
9903 (org-icompleting-read "Function: "
9904 obarray 'fboundp t nil nil)))))
9906 (t (user-error "Invalid bulk action")))
9908 ;; Sort the markers, to make sure that parents are handled before children
9909 (setq entries (sort entries
9910 (lambda (a b)
9911 (cond
9912 ((equal (marker-buffer a) (marker-buffer b))
9913 (< (marker-position a) (marker-position b)))
9915 (string< (buffer-name (marker-buffer a))
9916 (buffer-name (marker-buffer b))))))))
9918 ;; Now loop over all markers and apply cmd
9919 (while (setq e (pop entries))
9920 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9921 (if (not pos)
9922 (progn (message "Skipping removed entry at %s" e)
9923 (setq cntskip (1+ cntskip)))
9924 (goto-char pos)
9925 (let (org-loop-over-headlines-in-active-region)
9926 (eval cmd))
9927 (setq cnt (1+ cnt))))
9928 (when redo-at-end (org-agenda-redo))
9929 (unless org-agenda-persistent-marks
9930 (org-agenda-bulk-unmark-all))
9931 (message "Acted on %d entries%s%s"
9933 (if (= cntskip 0)
9935 (format ", skipped %d (disappeared before their turn)"
9936 cntskip))
9937 (if (not org-agenda-persistent-marks)
9938 "" " (kept marked)"))))))
9940 (defun org-agenda-capture (&optional with-time)
9941 "Call `org-capture' with the date at point.
9942 With a `C-1' prefix, use the HH:MM value at point (if any) or the
9943 current HH:MM time."
9944 (interactive "P")
9945 (if (not (eq major-mode 'org-agenda-mode))
9946 (user-error "You cannot do this outside of agenda buffers")
9947 (let ((org-overriding-default-time
9948 (org-get-cursor-date (equal with-time 1))))
9949 (call-interactively 'org-capture))))
9951 ;;; Dragging agenda lines forward/backward
9953 (defun org-agenda-reapply-filters ()
9954 "Re-apply all agenda filters."
9955 (mapcar
9956 (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f))))
9957 `((,org-agenda-tag-filter tag)
9958 (,org-agenda-category-filter category)
9959 (,org-agenda-regexp-filter regexp)
9960 (,org-agenda-effort-filter effort)
9961 (,(get 'org-agenda-tag-filter :preset-filter) tag)
9962 (,(get 'org-agenda-category-filter :preset-filter) category)
9963 (,(get 'org-agenda-effort-filter :preset-filter) effort)
9964 (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
9966 (defun org-agenda-drag-line-forward (arg &optional backward)
9967 "Drag an agenda line forward by ARG lines.
9968 When the optional argument `backward' is non-nil, move backward."
9969 (interactive "p")
9970 (let ((inhibit-read-only t) lst line)
9971 (if (or (not (get-text-property (point) 'txt))
9972 (save-excursion
9973 (dotimes (n arg)
9974 (move-beginning-of-line (if backward 0 2))
9975 (push (not (get-text-property (point) 'txt)) lst))
9976 (delq nil lst)))
9977 (message "Cannot move line forward")
9978 (let ((end (save-excursion (move-beginning-of-line 2) (point))))
9979 (move-beginning-of-line 1)
9980 (setq line (buffer-substring (point) end))
9981 (delete-region (point) end)
9982 (move-beginning-of-line (funcall (if backward '1- '1+) arg))
9983 (insert line)
9984 (org-agenda-reapply-filters)
9985 (org-agenda-mark-clocking-task)
9986 (move-beginning-of-line 0)))))
9988 (defun org-agenda-drag-line-backward (arg)
9989 "Drag an agenda line backward by ARG lines."
9990 (interactive "p")
9991 (org-agenda-drag-line-forward arg t))
9993 ;;; Flagging notes
9995 (defun org-agenda-show-the-flagging-note ()
9996 "Display the flagging note in the other window.
9997 When called a second time in direct sequence, offer to remove the FLAGGING
9998 tag and (if present) the flagging note."
9999 (interactive)
10000 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
10001 (win (selected-window))
10002 note heading newhead)
10003 (unless hdmarker
10004 (user-error "No linked entry at point"))
10005 (if (and (eq this-command last-command)
10006 (y-or-n-p "Unflag and remove any flagging note? "))
10007 (progn
10008 (org-agenda-remove-flag hdmarker)
10009 (let ((win (get-buffer-window "*Flagging Note*")))
10010 (and win (delete-window win)))
10011 (message "Entry unflagged"))
10012 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
10013 (unless note
10014 (user-error "No flagging note"))
10015 (org-kill-new note)
10016 (org-switch-to-buffer-other-window "*Flagging Note*")
10017 (erase-buffer)
10018 (insert note)
10019 (goto-char (point-min))
10020 (while (re-search-forward "\\\\n" nil t)
10021 (replace-match "\n" t t))
10022 (goto-char (point-min))
10023 (select-window win)
10024 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
10026 (defun org-agenda-remove-flag (marker)
10027 "Remove the FLAGGED tag and any flagging note in the entry."
10028 (let (newhead)
10029 (org-with-point-at marker
10030 (org-toggle-tag "FLAGGED" 'off)
10031 (org-entry-delete nil "THEFLAGGINGNOTE")
10032 (setq newhead (org-get-heading)))
10033 (org-agenda-change-all-lines newhead marker)
10034 (message "Entry unflagged")))
10036 (defun org-agenda-get-any-marker (&optional pos)
10037 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
10038 (get-text-property (or pos (point-at-bol)) 'org-marker)))
10040 ;;; Appointment reminders
10042 (defvar appt-time-msg-list) ; defined in appt.el
10044 ;;;###autoload
10045 (defun org-agenda-to-appt (&optional refresh filter &rest args)
10046 "Activate appointments found in `org-agenda-files'.
10047 With a \\[universal-argument] prefix, refresh the list of
10048 appointments.
10050 If FILTER is t, interactively prompt the user for a regular
10051 expression, and filter out entries that don't match it.
10053 If FILTER is a string, use this string as a regular expression
10054 for filtering entries out.
10056 If FILTER is a function, filter out entries against which
10057 calling the function returns nil. This function takes one
10058 argument: an entry from `org-agenda-get-day-entries'.
10060 FILTER can also be an alist with the car of each cell being
10061 either 'headline or 'category. For example:
10063 '((headline \"IMPORTANT\")
10064 (category \"Work\"))
10066 will only add headlines containing IMPORTANT or headlines
10067 belonging to the \"Work\" category.
10069 ARGS are symbols indicating what kind of entries to consider.
10070 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
10071 \(i.e., deadlines and scheduled items with a hh:mm specification)
10072 and :timestamp entries. See the docstring of `org-diary' for
10073 details and examples.
10075 If an entry has a APPT_WARNTIME property, its value will be used
10076 to override `appt-message-warning-time'."
10077 (interactive "P")
10078 (if refresh (setq appt-time-msg-list nil))
10079 (if (eq filter t)
10080 (setq filter (read-from-minibuffer "Regexp filter: ")))
10081 (let* ((cnt 0) ; count added events
10082 (scope (or args '(:deadline* :scheduled* :timestamp)))
10083 (org-agenda-new-buffers nil)
10084 (org-deadline-warning-days 0)
10085 ;; Do not use `org-today' here because appt only takes
10086 ;; time and without date as argument, so it may pass wrong
10087 ;; information otherwise
10088 (today (org-date-to-gregorian
10089 (time-to-days (current-time))))
10090 (org-agenda-restrict nil)
10091 (files (org-agenda-files 'unrestricted)) entries file
10092 (org-agenda-buffer nil))
10093 ;; Get all entries which may contain an appt
10094 (org-agenda-prepare-buffers files)
10095 (while (setq file (pop files))
10096 (setq entries
10097 (delq nil
10098 (append entries
10099 (apply 'org-agenda-get-day-entries
10100 file today scope)))))
10101 ;; Map thru entries and find if we should filter them out
10102 (mapc
10103 (lambda(x)
10104 (let* ((evt (org-trim
10105 (replace-regexp-in-string
10106 org-bracket-link-regexp "\\3"
10107 (or (get-text-property 1 'txt x) ""))))
10108 (cat (get-text-property (1- (length x)) 'org-category x))
10109 (tod (get-text-property 1 'time-of-day x))
10110 (ok (or (null filter)
10111 (and (stringp filter) (string-match filter evt))
10112 (and (functionp filter) (funcall filter x))
10113 (and (listp filter)
10114 (let ((cat-filter (cadr (assoc 'category filter)))
10115 (evt-filter (cadr (assoc 'headline filter))))
10116 (or (and (stringp cat-filter)
10117 (string-match cat-filter cat))
10118 (and (stringp evt-filter)
10119 (string-match evt-filter evt)))))))
10120 (wrn (get-text-property 1 'warntime x)))
10121 ;; FIXME: Shall we remove text-properties for the appt text?
10122 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
10123 (when (and ok tod)
10124 (setq tod (concat "00" (number-to-string tod))
10125 tod (when (string-match
10126 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
10127 (concat (match-string 1 tod) ":"
10128 (match-string 2 tod))))
10129 (if (version< emacs-version "23.3")
10130 (appt-add tod evt)
10131 (appt-add tod evt wrn))
10132 (setq cnt (1+ cnt))))) entries)
10133 (org-release-buffers org-agenda-new-buffers)
10134 (if (eq cnt 0)
10135 (message "No event to add")
10136 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
10138 (defun org-agenda-todayp (date)
10139 "Does DATE mean today, when considering `org-extend-today-until'?"
10140 (let ((today (org-today))
10141 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
10142 date)))
10143 (eq date today)))
10145 (defun org-agenda-todo-yesterday (&optional arg)
10146 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
10147 (interactive "P")
10148 (let* ((hour (third (decode-time
10149 (org-current-time))))
10150 (org-extend-today-until (1+ hour)))
10151 (org-agenda-todo arg)))
10153 (provide 'org-agenda)
10155 ;;; org-agenda.el ends here