org-agenda: Add only-window setup option
[org-mode/org-kjn.git] / lisp / org-agenda.el
blobb83c331580e4d6b00c2136b8611d41cc9ad6863f
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-iso-to-absolute "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-columns-remove-overlays "org-colview" ())
73 (declare-function org-datetree-find-date-create "org-datetree"
74 (date &optional keep-restriction))
75 (declare-function org-columns-quit "org-colview" ())
76 (declare-function diary-date-display-form "diary-lib" (&optional type))
77 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
78 (declare-function org-habit-insert-consistency-graphs
79 "org-habit" (&optional line))
80 (declare-function org-is-habit-p "org-habit" (&optional pom))
81 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
82 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
83 (declare-function org-pop-to-buffer-same-window "org-compat"
84 (&optional buffer-or-name norecord label))
85 (declare-function org-agenda-columns "org-colview" ())
86 (declare-function org-add-archive-files "org-archive" (files))
87 (declare-function org-capture "org-capture" (&optional goto keys))
89 (defvar calendar-mode-map) ; defined in calendar.el
90 (defvar org-clock-current-task nil) ; defined in org-clock.el
91 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
92 (defvar org-habit-show-habits) ; defined in org-habit.el
93 (defvar org-habit-show-habits-only-for-today)
94 (defvar org-habit-show-all-today)
96 ;; Defined somewhere in this file, but used before definition.
97 (defvar org-agenda-buffer-name "*Org Agenda*")
98 (defvar org-agenda-overriding-header nil)
99 (defvar org-agenda-title-append nil)
100 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
101 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
102 (defvar original-date) ; dynamically scoped, calendar.el does scope this
104 (defvar org-agenda-undo-list nil
105 "List of undoable operations in the agenda since last refresh.")
106 (defvar org-agenda-pending-undo-list nil
107 "In a series of undo commands, this is the list of remaining undo items.")
109 (defcustom org-agenda-confirm-kill 1
110 "When set, remote killing from the agenda buffer needs confirmation.
111 When t, a confirmation is always needed. When a number N, confirmation is
112 only needed when the text to be killed contains more than N non-white lines."
113 :group 'org-agenda
114 :type '(choice
115 (const :tag "Never" nil)
116 (const :tag "Always" t)
117 (integer :tag "When more than N lines")))
119 (defcustom org-agenda-compact-blocks nil
120 "Non-nil means make the block agenda more compact.
121 This is done globally by leaving out lines like the agenda span
122 name and week number or the separator lines."
123 :group 'org-agenda
124 :type 'boolean)
126 (defcustom org-agenda-block-separator ?=
127 "The separator between blocks in the agenda.
128 If this is a string, it will be used as the separator, with a newline added.
129 If it is a character, it will be repeated to fill the window width.
130 If nil the separator is disabled. In `org-agenda-custom-commands' this
131 addresses the separator between the current and the previous block."
132 :group 'org-agenda
133 :type '(choice
134 (const :tag "Disabled" nil)
135 (character)
136 (string)))
138 (defgroup org-agenda-export nil
139 "Options concerning exporting agenda views in Org-mode."
140 :tag "Org Agenda Export"
141 :group 'org-agenda)
143 (defcustom org-agenda-with-colors t
144 "Non-nil means use colors in agenda views."
145 :group 'org-agenda-export
146 :type 'boolean)
148 (defcustom org-agenda-exporter-settings nil
149 "Alist of variable/value pairs that should be active during agenda export.
150 This is a good place to set options for ps-print and for htmlize.
151 Note that the way this is implemented, the values will be evaluated
152 before assigned to the variables. So make sure to quote values you do
153 *not* want evaluated, for example
155 (setq org-agenda-exporter-settings
156 '((ps-print-color-p 'black-white)))"
157 :group 'org-agenda-export
158 :type '(repeat
159 (list
160 (variable)
161 (sexp :tag "Value"))))
163 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
164 "Hook run in a temporary buffer before writing the agenda to an export file.
165 A useful function for this hook is `org-agenda-add-entry-text'."
166 :group 'org-agenda-export
167 :type 'hook
168 :options '(org-agenda-add-entry-text))
170 (defcustom org-agenda-add-entry-text-maxlines 0
171 "Maximum number of entry text lines to be added to agenda.
172 This is only relevant when `org-agenda-add-entry-text' is part of
173 `org-agenda-before-write-hook', which is the default.
174 When this is 0, nothing will happen. When it is greater than 0, it
175 specifies the maximum number of lines that will be added for each entry
176 that is listed in the agenda view.
178 Note that this variable is not used during display, only when exporting
179 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
180 and `org-agenda-entry-text-maxlines'."
181 :group 'org-agenda
182 :type 'integer)
184 (defcustom org-agenda-add-entry-text-descriptive-links t
185 "Non-nil means export org-links as descriptive links in agenda added text.
186 This variable applies to the text added to the agenda when
187 `org-agenda-add-entry-text-maxlines' is larger than 0.
188 When this variable nil, the URL will (also) be shown."
189 :group 'org-agenda
190 :type 'boolean)
192 (defcustom org-agenda-export-html-style nil
193 "The style specification for exported HTML Agenda files.
194 If this variable contains a string, it will replace the default <style>
195 section as produced by `htmlize'.
196 Since there are different ways of setting style information, this variable
197 needs to contain the full HTML structure to provide a style, including the
198 surrounding HTML tags. The style specifications should include definitions
199 the fonts used by the agenda, here is an example:
201 <style type=\"text/css\">
202 p { font-weight: normal; color: gray; }
203 .org-agenda-structure {
204 font-size: 110%;
205 color: #003399;
206 font-weight: 600;
208 .org-todo {
209 color: #cc6666;
210 font-weight: bold;
212 .org-agenda-done {
213 color: #339933;
215 .org-done {
216 color: #339933;
218 .title { text-align: center; }
219 .todo, .deadline { color: red; }
220 .done { color: green; }
221 </style>
223 or, if you want to keep the style in a file,
225 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
227 As the value of this option simply gets inserted into the HTML <head> header,
228 you can \"misuse\" it to also add other text to the header."
229 :group 'org-agenda-export
230 :group 'org-export-html
231 :type '(choice
232 (const nil)
233 (string)))
235 (defcustom org-agenda-persistent-filter nil
236 "When set, keep filters from one agenda view to the next."
237 :group 'org-agenda
238 :type 'boolean)
240 (defgroup org-agenda-custom-commands nil
241 "Options concerning agenda views in Org-mode."
242 :tag "Org Agenda Custom Commands"
243 :group 'org-agenda)
245 (defconst org-sorting-choice
246 '(choice
247 (const time-up) (const time-down)
248 (const timestamp-up) (const timestamp-down)
249 (const scheduled-up) (const scheduled-down)
250 (const deadline-up) (const deadline-down)
251 (const ts-up) (const ts-down)
252 (const tsia-up) (const tsia-down)
253 (const category-keep) (const category-up) (const category-down)
254 (const tag-down) (const tag-up)
255 (const priority-up) (const priority-down)
256 (const todo-state-up) (const todo-state-down)
257 (const effort-up) (const effort-down)
258 (const habit-up) (const habit-down)
259 (const alpha-up) (const alpha-down)
260 (const user-defined-up) (const user-defined-down))
261 "Sorting choices.")
263 ;; Keep custom values for `org-agenda-filter-preset' compatible with
264 ;; the new variable `org-agenda-tag-filter-preset'.
265 (org-defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
266 (org-defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
268 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
269 "List of types searched for when creating the daily/weekly agenda.
270 This variable is a list of symbols that controls the types of
271 items that appear in the daily/weekly agenda. Allowed symbols in this
272 list are are
274 :timestamp List items containing a date stamp or date range matching
275 the selected date. This includes sexp entries in angular
276 brackets.
278 :sexp List entries resulting from plain diary-like sexps.
280 :deadline List deadline due on that date. When the date is today,
281 also list any deadlines past due, or due within
282 `org-deadline-warning-days'. `:deadline' must appear before
283 `:scheduled' if the setting of
284 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
285 any effect.
287 :deadline* Same as above, but only include the deadline if it has an
288 hour specification as [h]h:mm.
290 :scheduled List all items which are scheduled for the given date.
291 The diary for *today* also contains items which were
292 scheduled earlier and are not yet marked DONE.
294 :scheduled* Same as above, but only include the scheduled item if it
295 has an hour specification as [h]h:mm.
297 By default, all four non-starred types are turned on.
299 When :scheduled* or :deadline* are included, :schedule or :deadline
300 will be ignored.
302 Never set this variable globally using `setq', because then it
303 will apply to all future agenda commands. Instead, bind it with
304 `let' to scope it dynamically into the agenda-constructing
305 command. A good way to set it is through options in
306 `org-agenda-custom-commands'. For a more flexible (though
307 somewhat less efficient) way of determining what is included in
308 the daily/weekly agenda, see `org-agenda-skip-function'.")
310 (defconst org-agenda-custom-commands-local-options
311 `(repeat :tag "Local settings for this command. Remember to quote values"
312 (choice :tag "Setting"
313 (list :tag "Heading for this block"
314 (const org-agenda-overriding-header)
315 (string :tag "Headline"))
316 (list :tag "Files to be searched"
317 (const org-agenda-files)
318 (list
319 (const :format "" quote)
320 (repeat (file))))
321 (list :tag "Sorting strategy"
322 (const org-agenda-sorting-strategy)
323 (list
324 (const :format "" quote)
325 (repeat
326 ,org-sorting-choice)))
327 (list :tag "Prefix format"
328 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
329 (string))
330 (list :tag "Number of days in agenda"
331 (const org-agenda-span)
332 (choice (const :tag "Day" day)
333 (const :tag "Week" week)
334 (const :tag "Fortnight" fortnight)
335 (const :tag "Month" month)
336 (const :tag "Year" year)
337 (integer :tag "Custom")))
338 (list :tag "Fixed starting date"
339 (const org-agenda-start-day)
340 (string :value "2007-11-01"))
341 (list :tag "Start on day of week"
342 (const org-agenda-start-on-weekday)
343 (choice :value 1
344 (const :tag "Today" nil)
345 (integer :tag "Weekday No.")))
346 (list :tag "Include data from diary"
347 (const org-agenda-include-diary)
348 (boolean))
349 (list :tag "Deadline Warning days"
350 (const org-deadline-warning-days)
351 (integer :value 1))
352 (list :tag "Category filter preset"
353 (const org-agenda-category-filter-preset)
354 (list
355 (const :format "" quote)
356 (repeat
357 (string :tag "+category or -category"))))
358 (list :tag "Tags filter preset"
359 (const org-agenda-tag-filter-preset)
360 (list
361 (const :format "" quote)
362 (repeat
363 (string :tag "+tag or -tag"))))
364 (list :tag "Effort filter preset"
365 (const org-agenda-effort-filter-preset)
366 (list
367 (const :format "" quote)
368 (repeat
369 (string :tag "+=10 or -=10 or +<10 or ->10"))))
370 (list :tag "Regexp filter preset"
371 (const org-agenda-regexp-filter-preset)
372 (list
373 (const :format "" quote)
374 (repeat
375 (string :tag "+regexp or -regexp"))))
376 (list :tag "Set daily/weekly entry types"
377 (const org-agenda-entry-types)
378 (list
379 (const :format "" quote)
380 (set :greedy t :value ,org-agenda-entry-types
381 (const :deadline)
382 (const :scheduled)
383 (const :deadline*)
384 (const :scheduled*)
385 (const :timestamp)
386 (const :sexp))))
387 (list :tag "Standard skipping condition"
388 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
389 (const org-agenda-skip-function)
390 (list
391 (const :format "" quote)
392 (list
393 (choice
394 :tag "Skipping range"
395 (const :tag "Skip entry" org-agenda-skip-entry-if)
396 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
397 (repeat :inline t :tag "Conditions for skipping"
398 (choice
399 :tag "Condition type"
400 (list :tag "Regexp matches" :inline t
401 (const :format "" 'regexp)
402 (regexp))
403 (list :tag "Regexp does not match" :inline t
404 (const :format "" 'notregexp)
405 (regexp))
406 (list :tag "TODO state is" :inline t
407 (const 'todo)
408 (choice
409 (const :tag "Any not-done state" 'todo)
410 (const :tag "Any done state" 'done)
411 (const :tag "Any state" 'any)
412 (list :tag "Keyword list"
413 (const :format "" quote)
414 (repeat (string :tag "Keyword")))))
415 (list :tag "TODO state is not" :inline t
416 (const 'nottodo)
417 (choice
418 (const :tag "Any not-done state" 'todo)
419 (const :tag "Any done state" 'done)
420 (const :tag "Any state" 'any)
421 (list :tag "Keyword list"
422 (const :format "" quote)
423 (repeat (string :tag "Keyword")))))
424 (const :tag "scheduled" 'scheduled)
425 (const :tag "not scheduled" 'notscheduled)
426 (const :tag "deadline" 'deadline)
427 (const :tag "no deadline" 'notdeadline)
428 (const :tag "timestamp" 'timestamp)
429 (const :tag "no timestamp" 'nottimestamp))))))
430 (list :tag "Non-standard skipping condition"
431 :value (org-agenda-skip-function)
432 (const org-agenda-skip-function)
433 (sexp :tag "Function or form (quoted!)"))
434 (list :tag "Any variable"
435 (variable :tag "Variable")
436 (sexp :tag "Value (sexp)"))))
437 "Selection of examples for agenda command settings.
438 This will be spliced into the custom type of
439 `org-agenda-custom-commands'.")
442 (defcustom org-agenda-custom-commands
443 '(("n" "Agenda and all 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 only-window Show agenda, deleting all other windows.
1099 reorganize-frame Show only two windows on the current frame, the current
1100 window and the agenda.
1101 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1102 Also, when exiting the agenda, kill that frame.
1103 See also the variable `org-agenda-restore-windows-after-quit'."
1104 :group 'org-agenda-windows
1105 :type '(choice
1106 (const current-window)
1107 (const other-frame)
1108 (const other-window)
1109 (const only-window)
1110 (const reorganize-frame)))
1112 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
1113 "The min and max height of the agenda window as a fraction of frame height.
1114 The value of the variable is a cons cell with two numbers between 0 and 1.
1115 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
1116 :group 'org-agenda-windows
1117 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
1119 (defcustom org-agenda-restore-windows-after-quit nil
1120 "Non-nil means restore window configuration upon exiting agenda.
1121 Before the window configuration is changed for displaying the agenda,
1122 the current status is recorded. When the agenda is exited with
1123 `q' or `x' and this option is set, the old state is restored. If
1124 `org-agenda-window-setup' is `other-frame', the value of this
1125 option will be ignored."
1126 :group 'org-agenda-windows
1127 :type 'boolean)
1129 (defcustom org-agenda-ndays nil
1130 "Number of days to include in overview display.
1131 Should be 1 or 7.
1132 Obsolete, see `org-agenda-span'."
1133 :group 'org-agenda-daily/weekly
1134 :type '(choice (const nil)
1135 (integer)))
1137 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1139 (defcustom org-agenda-span 'week
1140 "Number of days to include in overview display.
1141 Can be day, week, month, year, or any number of days.
1142 Custom commands can set this variable in the options section."
1143 :group 'org-agenda-daily/weekly
1144 :type '(choice (const :tag "Day" day)
1145 (const :tag "Week" week)
1146 (const :tag "Fortnight" fortnight)
1147 (const :tag "Month" month)
1148 (const :tag "Year" year)
1149 (integer :tag "Custom")))
1151 (defcustom org-agenda-start-on-weekday 1
1152 "Non-nil means start the overview always on the specified weekday.
1153 0 denotes Sunday, 1 denotes Monday, etc.
1154 When nil, always start on the current day.
1155 Custom commands can set this variable in the options section."
1156 :group 'org-agenda-daily/weekly
1157 :type '(choice (const :tag "Today" nil)
1158 (integer :tag "Weekday No.")))
1160 (defcustom org-agenda-show-all-dates t
1161 "Non-nil means `org-agenda' shows every day in the selected range.
1162 When nil, only the days which actually have entries are shown."
1163 :group 'org-agenda-daily/weekly
1164 :type 'boolean)
1166 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1167 "Format string for displaying dates in the agenda.
1168 Used by the daily/weekly agenda and by the timeline. This should be
1169 a format string understood by `format-time-string', or a function returning
1170 the formatted date as a string. The function must take a single argument,
1171 a calendar-style date list like (month day year)."
1172 :group 'org-agenda-daily/weekly
1173 :type '(choice
1174 (string :tag "Format string")
1175 (function :tag "Function")))
1177 (defun org-agenda-format-date-aligned (date)
1178 "Format a DATE string for display in the daily/weekly agenda, or timeline.
1179 This function makes sure that dates are aligned for easy reading."
1180 (require 'cal-iso)
1181 (let* ((dayname (calendar-day-name date))
1182 (day (cadr date))
1183 (day-of-week (calendar-day-of-week date))
1184 (month (car date))
1185 (monthname (calendar-month-name month))
1186 (year (nth 2 date))
1187 (iso-week (org-days-to-iso-week
1188 (calendar-absolute-from-gregorian date)))
1189 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1190 (1- year))
1191 ((and (= month 12) (<= iso-week 1))
1192 (1+ year))
1193 (t year)))
1194 (weekstring (if (= day-of-week 1)
1195 (format " W%02d" iso-week)
1196 "")))
1197 (format "%-10s %2d %s %4d%s"
1198 dayname day monthname year weekstring)))
1200 (defcustom org-agenda-time-leading-zero nil
1201 "Non-nil means use leading zero for military times in agenda.
1202 For example, 9:30am would become 09:30 rather than 9:30."
1203 :group 'org-agenda-daily/weekly
1204 :version "24.1"
1205 :type 'boolean)
1207 (defcustom org-agenda-timegrid-use-ampm nil
1208 "When set, show AM/PM style timestamps on the timegrid."
1209 :group 'org-agenda
1210 :version "24.1"
1211 :type 'boolean)
1213 (defun org-agenda-time-of-day-to-ampm (time)
1214 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1215 (let* ((hour-number (string-to-number (substring time 0 -3)))
1216 (minute (substring time -2))
1217 (ampm "am"))
1218 (cond
1219 ((equal hour-number 12)
1220 (setq ampm "pm"))
1221 ((> hour-number 12)
1222 (setq ampm "pm")
1223 (setq hour-number (- hour-number 12))))
1224 (concat
1225 (if org-agenda-time-leading-zero
1226 (format "%02d" hour-number)
1227 (format "%02s" (number-to-string hour-number)))
1228 ":" minute ampm)))
1230 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1231 "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
1232 (if org-agenda-timegrid-use-ampm
1233 (org-agenda-time-of-day-to-ampm time)
1234 time))
1236 (defcustom org-agenda-weekend-days '(6 0)
1237 "Which days are weekend?
1238 These days get the special face `org-agenda-date-weekend' in the agenda
1239 and timeline buffers."
1240 :group 'org-agenda-daily/weekly
1241 :type '(set :greedy t
1242 (const :tag "Monday" 1)
1243 (const :tag "Tuesday" 2)
1244 (const :tag "Wednesday" 3)
1245 (const :tag "Thursday" 4)
1246 (const :tag "Friday" 5)
1247 (const :tag "Saturday" 6)
1248 (const :tag "Sunday" 0)))
1250 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1251 "Non-nil means jump to today when moving a past date forward in time.
1252 When using S-right in the agenda to move a a date forward, and the date
1253 stamp currently points to the past, the first key press will move it
1254 to today. WHen nil, just move one day forward even if the date stays
1255 in the past."
1256 :group 'org-agenda-daily/weekly
1257 :version "24.1"
1258 :type 'boolean)
1260 (defcustom org-agenda-include-diary nil
1261 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1262 Custom commands can set this variable in the options section."
1263 :group 'org-agenda-daily/weekly
1264 :type 'boolean)
1266 (defcustom org-agenda-include-deadlines t
1267 "If non-nil, include entries within their deadline warning period.
1268 Custom commands can set this variable in the options section."
1269 :group 'org-agenda-daily/weekly
1270 :version "24.1"
1271 :type 'boolean)
1273 (defcustom org-agenda-repeating-timestamp-show-all t
1274 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1275 When set to a list of strings, only show occurrences of repeating
1276 stamps for these TODO keywords. When nil, only one occurrence is
1277 shown, either today or the nearest into the future."
1278 :group 'org-agenda-daily/weekly
1279 :type '(choice
1280 (const :tag "Show repeating stamps" t)
1281 (repeat :tag "Show repeating stamps for these TODO keywords"
1282 (string :tag "TODO Keyword"))
1283 (const :tag "Don't show repeating stamps" nil)))
1285 (defcustom org-scheduled-past-days 10000
1286 "Number of days to continue listing scheduled items not marked DONE.
1287 When an item is scheduled on a date, it shows up in the agenda on this
1288 day and will be listed until it is marked done for the number of days
1289 given here."
1290 :group 'org-agenda-daily/weekly
1291 :type 'integer)
1293 (defcustom org-agenda-log-mode-items '(closed clock)
1294 "List of items that should be shown in agenda log mode.
1295 This list may contain the following symbols:
1297 closed Show entries that have been closed on that day.
1298 clock Show entries that have received clocked time on that day.
1299 state Show all logged state changes.
1300 Note that instead of changing this variable, you can also press `C-u l' in
1301 the agenda to display all available LOG items temporarily."
1302 :group 'org-agenda-daily/weekly
1303 :type '(set :greedy t (const closed) (const clock) (const state)))
1305 (defcustom org-agenda-clock-consistency-checks
1306 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1307 :gap-ok-around ("4:00")
1308 :default-face ((:background "DarkRed") (:foreground "white"))
1309 :overlap-face nil :gap-face nil :no-end-time-face nil
1310 :long-face nil :short-face nil)
1311 "This is a property list, with the following keys:
1313 :max-duration Mark clocking chunks that are longer than this time.
1314 This is a time string like \"HH:MM\", or the number
1315 of minutes as an integer.
1317 :min-duration Mark clocking chunks that are shorter that this.
1318 This is a time string like \"HH:MM\", or the number
1319 of minutes as an integer.
1321 :max-gap Mark gaps between clocking chunks that are longer than
1322 this duration. A number of minutes, or a string
1323 like \"HH:MM\".
1325 :gap-ok-around List of times during the day which are usually not working
1326 times. When a gap is detected, but the gap contains any
1327 of these times, the gap is *not* reported. For example,
1328 if this is (\"4:00\" \"13:00\") then gaps that contain
1329 4:00 in the morning (i.e. the night) and 13:00
1330 (i.e. a typical lunch time) do not cause a warning.
1331 You should have at least one time during the night in this
1332 list, or otherwise the first task each morning will trigger
1333 a warning because it follows a long gap.
1335 Furthermore, the following properties can be used to define faces for
1336 issue display.
1338 :default-face the default face, if the specific face is undefined
1339 :overlap-face face for overlapping clocks
1340 :gap-face face for gaps between clocks
1341 :no-end-time-face face for incomplete clocks
1342 :long-face face for clock intervals that are too long
1343 :short-face face for clock intervals that are too short"
1344 :group 'org-agenda-daily/weekly
1345 :group 'org-clock
1346 :version "24.1"
1347 :type 'plist)
1349 (defcustom org-agenda-log-mode-add-notes t
1350 "Non-nil means add first line of notes to log entries in agenda views.
1351 If a log item like a state change or a clock entry is associated with
1352 notes, the first line of these notes will be added to the entry in the
1353 agenda display."
1354 :group 'org-agenda-daily/weekly
1355 :type 'boolean)
1357 (defcustom org-agenda-start-with-log-mode nil
1358 "The initial value of log-mode in a newly created agenda window.
1359 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1360 explanations on the possible values."
1361 :group 'org-agenda-startup
1362 :group 'org-agenda-daily/weekly
1363 :type '(choice (const :tag "Don't show log items" nil)
1364 (const :tag "Show only log items" only)
1365 (const :tag "Show all possible log items" clockcheck)
1366 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1367 (choice (const :tag "Show closed log items" closed)
1368 (const :tag "Show clocked log items" clock)
1369 (const :tag "Show all logged state changes" state)))))
1371 (defcustom org-agenda-start-with-clockreport-mode nil
1372 "The initial value of clockreport-mode in a newly created agenda window."
1373 :group 'org-agenda-startup
1374 :group 'org-agenda-daily/weekly
1375 :type 'boolean)
1377 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1378 "Property list with parameters for the clocktable in clockreport mode.
1379 This is the display mode that shows a clock table in the daily/weekly
1380 agenda, the properties for this dynamic block can be set here.
1381 The usual clocktable parameters are allowed here, but you cannot set
1382 the properties :name, :tstart, :tend, :block, and :scope - these will
1383 be overwritten to make sure the content accurately reflects the
1384 current display in the agenda."
1385 :group 'org-agenda-daily/weekly
1386 :type 'plist)
1388 (defcustom org-agenda-search-view-always-boolean nil
1389 "Non-nil means the search string is interpreted as individual parts.
1391 The search string for search view can either be interpreted as a phrase,
1392 or as a list of snippets that define a boolean search for a number of
1393 strings.
1395 When this is non-nil, the string will be split on whitespace, and each
1396 snippet will be searched individually, and all must match in order to
1397 select an entry. A snippet is then a single string of non-white
1398 characters, or a string in double quotes, or a regexp in {} braces.
1399 If a snippet is preceded by \"-\", the snippet must *not* match.
1400 \"+\" is syntactic sugar for positive selection. Each snippet may
1401 be found as a full word or a partial word, but see the variable
1402 `org-agenda-search-view-force-full-words'.
1404 When this is nil, search will look for the entire search phrase as one,
1405 with each space character matching any amount of whitespace, including
1406 line breaks.
1408 Even when this is nil, you can still switch to Boolean search dynamically
1409 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1410 is a regexp marked with braces like \"{abc}\", this will also switch to
1411 boolean search."
1412 :group 'org-agenda-search-view
1413 :version "24.1"
1414 :type 'boolean)
1416 (org-defvaralias 'org-agenda-search-view-search-words-only
1417 'org-agenda-search-view-always-boolean)
1419 (defcustom org-agenda-search-view-force-full-words nil
1420 "Non-nil means, search words must be matches as complete words.
1421 When nil, they may also match part of a word."
1422 :group 'org-agenda-search-view
1423 :version "24.1"
1424 :type 'boolean)
1426 (defcustom org-agenda-search-view-max-outline-level 0
1427 "Maximum outline level to display in search view.
1428 E.g. when this is set to 1, the search view will only
1429 show headlines of level 1. When set to 0, the default
1430 value, don't limit agenda view by outline level."
1431 :group 'org-agenda-search-view
1432 :version "24.4"
1433 :package-version '(Org . "8.3")
1434 :type 'integer)
1436 (defgroup org-agenda-time-grid nil
1437 "Options concerning the time grid in the Org-mode Agenda."
1438 :tag "Org Agenda Time Grid"
1439 :group 'org-agenda)
1441 (defcustom org-agenda-search-headline-for-time t
1442 "Non-nil means search headline for a time-of-day.
1443 If the headline contains a time-of-day in one format or another, it will
1444 be used to sort the entry into the time sequence of items for a day.
1445 Some people have time stamps in the headline that refer to the creation
1446 time or so, and then this produces an unwanted side effect. If this is
1447 the case for your, use this variable to turn off searching the headline
1448 for a time."
1449 :group 'org-agenda-time-grid
1450 :type 'boolean)
1452 (defcustom org-agenda-use-time-grid t
1453 "Non-nil means show a time grid in the agenda schedule.
1454 A time grid is a set of lines for specific times (like every two hours between
1455 8:00 and 20:00). The items scheduled for a day at specific times are
1456 sorted in between these lines.
1457 For details about when the grid will be shown, and what it will look like, see
1458 the variable `org-agenda-time-grid'."
1459 :group 'org-agenda-time-grid
1460 :type 'boolean)
1462 (defcustom org-agenda-time-grid
1463 '((daily today require-timed)
1464 "----------------"
1465 (800 1000 1200 1400 1600 1800 2000))
1467 "The settings for time grid for agenda display.
1468 This is a list of three items. The first item is again a list. It contains
1469 symbols specifying conditions when the grid should be displayed:
1471 daily if the agenda shows a single day
1472 weekly if the agenda shows an entire week
1473 today show grid on current date, independent of daily/weekly display
1474 require-timed show grid only if at least one item has a time specification
1475 remove-match skip grid times already present in an entry
1477 The second item is a string which will be placed behind the grid time.
1479 The third item is a list of integers, indicating the times that should have
1480 a grid line."
1481 :group 'org-agenda-time-grid
1482 :type
1483 '(list
1484 (set :greedy t :tag "Grid Display Options"
1485 (const :tag "Show grid in single day agenda display" daily)
1486 (const :tag "Show grid in weekly agenda display" weekly)
1487 (const :tag "Always show grid for today" today)
1488 (const :tag "Show grid only if any timed entries are present"
1489 require-timed)
1490 (const :tag "Skip grid times already present in an entry"
1491 remove-match))
1492 (string :tag "Grid String")
1493 (repeat :tag "Grid Times" (integer :tag "Time"))))
1495 (defcustom org-agenda-show-current-time-in-grid t
1496 "Non-nil means show the current time in the time grid."
1497 :group 'org-agenda-time-grid
1498 :version "24.1"
1499 :type 'boolean)
1501 (defcustom org-agenda-current-time-string
1502 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1503 "The string for the current time marker in the agenda."
1504 :group 'org-agenda-time-grid
1505 :version "24.1"
1506 :type 'string)
1508 (defgroup org-agenda-sorting nil
1509 "Options concerning sorting in the Org-mode Agenda."
1510 :tag "Org Agenda Sorting"
1511 :group 'org-agenda)
1513 (defcustom org-agenda-sorting-strategy
1514 '((agenda habit-down time-up priority-down category-keep)
1515 (todo priority-down category-keep)
1516 (tags priority-down category-keep)
1517 (search category-keep))
1518 "Sorting structure for the agenda items of a single day.
1519 This is a list of symbols which will be used in sequence to determine
1520 if an entry should be listed before another entry. The following
1521 symbols are recognized:
1523 time-up Put entries with time-of-day indications first, early first
1524 time-down Put entries with time-of-day indications first, late first
1525 timestamp-up Sort by any timestamp, early first
1526 timestamp-down Sort by any timestamp, late first
1527 scheduled-up Sort by scheduled timestamp, early first
1528 scheduled-down Sort by scheduled timestamp, late first
1529 deadline-up Sort by deadline timestamp, early first
1530 deadline-down Sort by deadline timestamp, late first
1531 ts-up Sort by active timestamp, early first
1532 ts-down Sort by active timestamp, late first
1533 tsia-up Sort by inactive timestamp, early first
1534 tsia-down Sort by inactive timestamp, late first
1535 category-keep Keep the default order of categories, corresponding to the
1536 sequence in `org-agenda-files'.
1537 category-up Sort alphabetically by category, A-Z.
1538 category-down Sort alphabetically by category, Z-A.
1539 tag-up Sort alphabetically by last tag, A-Z.
1540 tag-down Sort alphabetically by last tag, Z-A.
1541 priority-up Sort numerically by priority, high priority last.
1542 priority-down Sort numerically by priority, high priority first.
1543 todo-state-up Sort by todo state, tasks that are done last.
1544 todo-state-down Sort by todo state, tasks that are done first.
1545 effort-up Sort numerically by estimated effort, high effort last.
1546 effort-down Sort numerically by estimated effort, high effort first.
1547 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1548 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1549 habit-up Put entries that are habits first
1550 habit-down Put entries that are habits last
1551 alpha-up Sort headlines alphabetically
1552 alpha-down Sort headlines alphabetically, reversed
1554 The different possibilities will be tried in sequence, and testing stops
1555 if one comparison returns a \"not-equal\". For example, the default
1556 '(time-up category-keep priority-down)
1557 means: Pull out all entries having a specified time of day and sort them,
1558 in order to make a time schedule for the current day the first thing in the
1559 agenda listing for the day. Of the entries without a time indication, keep
1560 the grouped in categories, don't sort the categories, but keep them in
1561 the sequence given in `org-agenda-files'. Within each category sort by
1562 priority.
1564 Leaving out `category-keep' would mean that items will be sorted across
1565 categories by priority.
1567 Instead of a single list, this can also be a set of list for specific
1568 contents, with a context symbol in the car of the list, any of
1569 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1571 Custom commands can bind this variable in the options section."
1572 :group 'org-agenda-sorting
1573 :type `(choice
1574 (repeat :tag "General" ,org-sorting-choice)
1575 (list :tag "Individually"
1576 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1577 (repeat ,org-sorting-choice))
1578 (cons (const :tag "Strategy for TODO lists" todo)
1579 (repeat ,org-sorting-choice))
1580 (cons (const :tag "Strategy for Tags matches" tags)
1581 (repeat ,org-sorting-choice))
1582 (cons (const :tag "Strategy for search matches" search)
1583 (repeat ,org-sorting-choice)))))
1585 (defcustom org-agenda-cmp-user-defined nil
1586 "A function to define the comparison `user-defined'.
1587 This function must receive two arguments, agenda entry a and b.
1588 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1589 the user comparison, return nil.
1590 When this is defined, you can make `user-defined-up' and `user-defined-down'
1591 part of an agenda sorting strategy."
1592 :group 'org-agenda-sorting
1593 :type 'symbol)
1595 (defcustom org-sort-agenda-notime-is-late t
1596 "Non-nil means items without time are considered late.
1597 This is only relevant for sorting. When t, items which have no explicit
1598 time like 15:30 will be considered as 99:01, i.e. later than any items which
1599 do have a time. When nil, the default time is before 0:00. You can use this
1600 option to decide if the schedule for today should come before or after timeless
1601 agenda entries."
1602 :group 'org-agenda-sorting
1603 :type 'boolean)
1605 (defcustom org-sort-agenda-noeffort-is-high t
1606 "Non-nil means items without effort estimate are sorted as high effort.
1607 This also applies when filtering an agenda view with respect to the
1608 < or > effort operator. Then, tasks with no effort defined will be treated
1609 as tasks with high effort.
1610 When nil, such items are sorted as 0 minutes effort."
1611 :group 'org-agenda-sorting
1612 :type 'boolean)
1614 (defgroup org-agenda-line-format nil
1615 "Options concerning the entry prefix in the Org-mode agenda display."
1616 :tag "Org Agenda Line Format"
1617 :group 'org-agenda)
1619 (defcustom org-agenda-prefix-format
1620 '((agenda . " %i %-12:c%?-12t% s")
1621 (timeline . " % s")
1622 (todo . " %i %-12:c")
1623 (tags . " %i %-12:c")
1624 (search . " %i %-12:c"))
1625 "Format specifications for the prefix of items in the agenda views.
1626 An alist with five entries, each for the different agenda types. The
1627 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1628 The values are format strings.
1630 This format works similar to a printf format, with the following meaning:
1632 %c the category of the item, \"Diary\" for entries from the diary,
1633 or as given by the CATEGORY keyword or derived from the file name
1634 %e the effort required by the item
1635 %l the level of the item (insert X space(s) if item is of level X)
1636 %i the icon category of the item, see `org-agenda-category-icon-alist'
1637 %T the last tag of the item (ignore inherited tags, which come first)
1638 %t the HH:MM time-of-day specification if one applies to the entry
1639 %s Scheduling/Deadline information, a short string
1640 %b show breadcrumbs, i.e., the names of the higher levels
1641 %(expression) Eval EXPRESSION and replace the control string
1642 by the result
1644 All specifiers work basically like the standard `%s' of printf, but may
1645 contain two additional characters: a question mark just after the `%'
1646 and a whitespace/punctuation character just before the final letter.
1648 If the first character after `%' is a question mark, the entire field
1649 will only be included if the corresponding value applies to the current
1650 entry. This is useful for fields which should have fixed width when
1651 present, but zero width when absent. For example, \"%?-12t\" will
1652 result in a 12 character time field if a time of the day is specified,
1653 but will completely disappear in entries which do not contain a time.
1655 If there is punctuation or whitespace character just before the
1656 final format letter, this character will be appended to the field
1657 value if the value is not empty. For example, the format
1658 \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
1659 the category is empty, no additional colon is inserted.
1661 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1662 which means:
1664 - Indent the line with two space characters
1665 - Give the category a 12 chars wide field, padded with whitespace on
1666 the right (because of `-'). Append a colon if there is a category
1667 (because of `:').
1668 - If there is a time-of-day, put it into a 12 chars wide field. If no
1669 time, don't put in an empty field, just skip it (because of '?').
1670 - Finally, put the scheduling information.
1672 See also the variables `org-agenda-remove-times-when-in-prefix' and
1673 `org-agenda-remove-tags'.
1675 Custom commands can set this variable in the options section."
1676 :type '(choice
1677 (string :tag "General format")
1678 (list :greedy t :tag "View dependent"
1679 (cons (const agenda) (string :tag "Format"))
1680 (cons (const timeline) (string :tag "Format"))
1681 (cons (const todo) (string :tag "Format"))
1682 (cons (const tags) (string :tag "Format"))
1683 (cons (const search) (string :tag "Format"))))
1684 :group 'org-agenda-line-format)
1686 (defvar org-prefix-format-compiled nil
1687 "The compiled prefix format and associated variables.
1688 This is a list where first element is a list of variable bindings, and second
1689 element is the compiled format expression. See the variable
1690 `org-agenda-prefix-format'.")
1692 (defcustom org-agenda-todo-keyword-format "%-1s"
1693 "Format for the TODO keyword in agenda lines.
1694 Set this to something like \"%-12s\" if you want all TODO keywords
1695 to occupy a fixed space in the agenda display."
1696 :group 'org-agenda-line-format
1697 :type 'string)
1699 (defcustom org-agenda-diary-sexp-prefix nil
1700 "A regexp that matches part of a diary sexp entry
1701 which should be treated as scheduling/deadline information in
1702 `org-agenda'.
1704 For example, you can use this to extract the `diary-remind-message' from
1705 `diary-remind' entries."
1706 :group 'org-agenda-line-format
1707 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1709 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1710 "Text preceding timerange entries in the agenda view.
1711 This is a list with two strings. The first applies when the range
1712 is entirely on one day. The second applies if the range spans several days.
1713 The strings may have two \"%d\" format specifiers which will be filled
1714 with the sequence number of the days, and the total number of days in the
1715 range, respectively."
1716 :group 'org-agenda-line-format
1717 :type '(list
1718 (string :tag "Deadline today ")
1719 (choice :tag "Deadline relative"
1720 (string :tag "Format string")
1721 (function))))
1723 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1724 "Text preceding scheduled items in the agenda view.
1725 This is a list with two strings. The first applies when the item is
1726 scheduled on the current day. The second applies when it has been scheduled
1727 previously, it may contain a %d indicating that this is the nth time that
1728 this item is scheduled, due to automatic rescheduling of unfinished items
1729 for the following day. So this number is one larger than the number of days
1730 that passed since this item was scheduled first."
1731 :group 'org-agenda-line-format
1732 :version "24.4"
1733 :package-version '(Org . "8.0")
1734 :type '(list
1735 (string :tag "Scheduled today ")
1736 (string :tag "Scheduled previously")))
1738 (defcustom org-agenda-inactive-leader "["
1739 "Text preceding item pulled into the agenda by inactive time stamps.
1740 These entries are added to the agenda when pressing \"[\"."
1741 :group 'org-agenda-line-format
1742 :version "24.1"
1743 :type 'string)
1745 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
1746 "Text preceding deadline items in the agenda view.
1747 This is a list with three strings. The first applies when the item has its
1748 deadline on the current day. The second applies when the deadline is in the
1749 future, the third one when it is in the past. The strings may contain %d
1750 to capture the number of days."
1751 :group 'org-agenda-line-format
1752 :version "24.4"
1753 :package-version '(Org . "8.0")
1754 :type '(list
1755 (string :tag "Deadline today ")
1756 (string :tag "Deadline in the future ")
1757 (string :tag "Deadline in the past ")))
1759 (defcustom org-agenda-remove-times-when-in-prefix t
1760 "Non-nil means remove duplicate time specifications in agenda items.
1761 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1762 time-of-day specification in a headline or diary entry is extracted and
1763 placed into the prefix. If this option is non-nil, the original specification
1764 \(a timestamp or -range, or just a plain time(range) specification like
1765 11:30-4pm) will be removed for agenda display. This makes the agenda less
1766 cluttered.
1767 The option can be t or nil. It may also be the symbol `beg', indicating
1768 that the time should only be removed when it is located at the beginning of
1769 the headline/diary entry."
1770 :group 'org-agenda-line-format
1771 :type '(choice
1772 (const :tag "Always" t)
1773 (const :tag "Never" nil)
1774 (const :tag "When at beginning of entry" beg)))
1776 (defcustom org-agenda-remove-timeranges-from-blocks nil
1777 "Non-nil means remove time ranges specifications in agenda
1778 items that span on several days."
1779 :group 'org-agenda-line-format
1780 :version "24.1"
1781 :type 'boolean)
1783 (defcustom org-agenda-default-appointment-duration nil
1784 "Default duration for appointments that only have a starting time.
1785 When nil, no duration is specified in such cases.
1786 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1787 :group 'org-agenda-line-format
1788 :type '(choice
1789 (integer :tag "Minutes")
1790 (const :tag "No default duration")))
1792 (defcustom org-agenda-show-inherited-tags t
1793 "Non-nil means show inherited tags in each agenda line.
1795 When this option is set to 'always, it take precedences over
1796 `org-agenda-use-tag-inheritance' and inherited tags are shown
1797 in every agenda.
1799 When this option is set to t (the default), inherited tags are
1800 shown when they are available, i.e. when the value of
1801 `org-agenda-use-tag-inheritance' has been taken into account.
1803 This can be set to a list of agenda types in which the agenda
1804 must display the inherited tags. Available types are 'todo,
1805 'agenda, 'search and 'timeline.
1807 When set to nil, never show inherited tags in agenda lines."
1808 :group 'org-agenda-line-format
1809 :group 'org-agenda
1810 :version "24.3"
1811 :type '(choice
1812 (const :tag "Show inherited tags when available" t)
1813 (const :tag "Always show inherited tags" always)
1814 (repeat :tag "Show inherited tags only in selected agenda types"
1815 (symbol :tag "Agenda type"))))
1817 (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
1818 "List of agenda view types where to use tag inheritance.
1820 In tags/tags-todo/tags-tree agenda views, tag inheritance is
1821 controlled by `org-use-tag-inheritance'. In other agenda types,
1822 `org-use-tag-inheritance' is not used for the selection of the
1823 agenda entries. Still, you may want the agenda to be aware of
1824 the inherited tags anyway, e.g. for later tag filtering.
1826 Allowed value are 'todo, 'search, 'timeline and 'agenda.
1828 This variable has no effect if `org-agenda-show-inherited-tags'
1829 is set to 'always. In that case, the agenda is aware of those
1830 tags.
1832 The default value sets tags in every agenda type. Setting this
1833 option to nil will speed up non-tags agenda view a lot."
1834 :group 'org-agenda
1835 :version "24.3"
1836 :type '(choice
1837 (const :tag "Use tag inheritance in all agenda types" t)
1838 (repeat :tag "Use tag inheritance in selected agenda types"
1839 (symbol :tag "Agenda type"))))
1841 (defcustom org-agenda-hide-tags-regexp nil
1842 "Regular expression used to filter away specific tags in agenda views.
1843 This means that these tags will be present, but not be shown in the agenda
1844 line. Secondary filtering will still work on the hidden tags.
1845 Nil means don't hide any tags."
1846 :group 'org-agenda-line-format
1847 :type '(choice
1848 (const :tag "Hide none" nil)
1849 (string :tag "Regexp ")))
1851 (defcustom org-agenda-remove-tags nil
1852 "Non-nil means remove the tags from the headline copy in the agenda.
1853 When this is the symbol `prefix', only remove tags when
1854 `org-agenda-prefix-format' contains a `%T' specifier."
1855 :group 'org-agenda-line-format
1856 :type '(choice
1857 (const :tag "Always" t)
1858 (const :tag "Never" nil)
1859 (const :tag "When prefix format contains %T" prefix)))
1861 (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
1862 'org-agenda-remove-tags)
1864 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1865 "Shift tags in agenda items to this column.
1866 If this number is positive, it specifies the column. If it is negative,
1867 it means that the tags should be flushright to that column. For example,
1868 -80 works well for a normal 80 character screen."
1869 :group 'org-agenda-line-format
1870 :type 'integer)
1872 (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
1874 (defcustom org-agenda-fontify-priorities 'cookies
1875 "Non-nil means highlight low and high priorities in agenda.
1876 When t, the highest priority entries are bold, lowest priority italic.
1877 However, settings in `org-priority-faces' will overrule these faces.
1878 When this variable is the symbol `cookies', only fontify the
1879 cookies, not the entire task.
1880 This may also be an association list of priority faces, whose
1881 keys are the character values of `org-highest-priority',
1882 `org-default-priority', and `org-lowest-priority' (the default values
1883 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1884 color as a string, or a list like `(:background \"Red\")'.
1885 If it is a color, the variable `org-faces-easy-properties'
1886 determines if it is a foreground or a background color."
1887 :group 'org-agenda-line-format
1888 :type '(choice
1889 (const :tag "Never" nil)
1890 (const :tag "Defaults" t)
1891 (const :tag "Cookies only" cookies)
1892 (repeat :tag "Specify"
1893 (list (character :tag "Priority" :value ?A)
1894 (choice :tag "Face "
1895 (string :tag "Color")
1896 (sexp :tag "Face"))))))
1898 (defcustom org-agenda-day-face-function nil
1899 "Function called to determine what face should be used to display a day.
1900 The only argument passed to that function is the day. It should
1901 returns a face, or nil if does not want to specify a face and let
1902 the normal rules apply."
1903 :group 'org-agenda-line-format
1904 :version "24.1"
1905 :type '(choice (const nil) (function)))
1907 (defcustom org-agenda-category-icon-alist nil
1908 "Alist of category icon to be displayed in agenda views.
1910 Each entry should have the following format:
1912 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1914 Where CATEGORY-REGEXP is a regexp matching the categories where
1915 the icon should be displayed.
1916 FILE-OR-DATA either a file path or a string containing image data.
1918 The other fields can be omitted safely if not needed:
1919 TYPE indicates the image type.
1920 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1921 image data.
1922 PROPS are additional image attributes to assign to the image,
1923 like, e.g. `:ascent center'.
1925 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1927 If you want to set the display properties yourself, just put a
1928 list as second element:
1930 (CATEGORY-REGEXP (MY PROPERTY LIST))
1932 For example, to display a 16px horizontal space for Emacs
1933 category, you can use:
1935 (\"Emacs\" '(space . (:width (16))))"
1936 :group 'org-agenda-line-format
1937 :version "24.1"
1938 :type '(alist :key-type (string :tag "Regexp matching category")
1939 :value-type (choice (list :tag "Icon"
1940 (string :tag "File or data")
1941 (symbol :tag "Type")
1942 (boolean :tag "Data?")
1943 (repeat :tag "Extra image properties" :inline t symbol))
1944 (list :tag "Display properties" sexp))))
1946 (defgroup org-agenda-column-view nil
1947 "Options concerning column view in the agenda."
1948 :tag "Org Agenda Column View"
1949 :group 'org-agenda)
1951 (defcustom org-agenda-columns-show-summaries t
1952 "Non-nil means show summaries for columns displayed in the agenda view."
1953 :group 'org-agenda-column-view
1954 :type 'boolean)
1956 (defcustom org-agenda-columns-compute-summary-properties t
1957 "Non-nil means recompute all summary properties before column view.
1958 When column view in the agenda is listing properties that have a summary
1959 operator, it can go to all relevant buffers and recompute the summaries
1960 there. This can mean overhead for the agenda column view, but is necessary
1961 to have thing up to date.
1962 As a special case, a CLOCKSUM property also makes sure that the clock
1963 computations are current."
1964 :group 'org-agenda-column-view
1965 :type 'boolean)
1967 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1968 "Non-nil means the duration of an appointment will add to day effort.
1969 The property to which appointment durations will be added is the one given
1970 in the option `org-effort-property'. If an appointment does not have
1971 an end time, `org-agenda-default-appointment-duration' will be used. If that
1972 is not set, an appointment without end time will not contribute to the time
1973 estimate."
1974 :group 'org-agenda-column-view
1975 :type 'boolean)
1977 (defcustom org-agenda-auto-exclude-function nil
1978 "A function called with a tag to decide if it is filtered on '/ RET'.
1979 The sole argument to the function, which is called once for each
1980 possible tag, is a string giving the name of the tag. The
1981 function should return either nil if the tag should be included
1982 as normal, or \"-<TAG>\" to exclude the tag.
1983 Note that for the purpose of tag filtering, only the lower-case version of
1984 all tags will be considered, so that this function will only ever see
1985 the lower-case version of all tags."
1986 :group 'org-agenda
1987 :type '(choice (const nil) (function)))
1989 (defcustom org-agenda-bulk-custom-functions nil
1990 "Alist of characters and custom functions for bulk actions.
1991 For example, this value makes those two functions available:
1993 '((?R set-category)
1994 (?C bulk-cut))
1996 With selected entries in an agenda buffer, `B R' will call
1997 the custom function `set-category' on the selected entries.
1998 Note that functions in this alist don't need to be quoted."
1999 :type 'alist
2000 :version "24.1"
2001 :group 'org-agenda)
2003 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
2004 "Execute BODY with point at location given by `org-hd-marker' property.
2005 If STRING is non-nil, the text property will be fetched from position 0
2006 in that string. If STRING is nil, it will be fetched from the beginning
2007 of the current line."
2008 (org-with-gensyms (marker)
2009 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
2010 'org-hd-marker ,string)))
2011 (with-current-buffer (marker-buffer ,marker)
2012 (save-excursion
2013 (goto-char ,marker)
2014 ,@body)))))
2015 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
2017 (defun org-add-agenda-custom-command (entry)
2018 "Replace or add a command in `org-agenda-custom-commands'.
2019 This is mostly for hacking and trying a new command - once the command
2020 works you probably want to add it to `org-agenda-custom-commands' for good."
2021 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
2022 (if ass
2023 (setcdr ass (cdr entry))
2024 (push entry org-agenda-custom-commands))))
2026 ;;; Define the org-agenda-mode
2028 (defvar org-agenda-mode-map (make-sparse-keymap)
2029 "Keymap for `org-agenda-mode'.")
2030 (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
2032 (defvar org-agenda-menu) ; defined later in this file.
2033 (defvar org-agenda-restrict nil) ; defined later in this file.
2034 (defvar org-agenda-follow-mode nil)
2035 (defvar org-agenda-entry-text-mode nil)
2036 (defvar org-agenda-clockreport-mode nil)
2037 (defvar org-agenda-show-log nil)
2038 (defvar org-agenda-redo-command nil)
2039 (defvar org-agenda-query-string nil)
2040 (defvar org-agenda-mode-hook nil
2041 "Hook run after `org-agenda-mode' is turned on.
2042 The buffer is still writable when this hook is called.")
2043 (defvar org-agenda-type nil)
2044 (defvar org-agenda-force-single-file nil)
2045 (defvar org-agenda-bulk-marked-entries nil
2046 "List of markers that refer to marked entries in the agenda.")
2048 ;;; Multiple agenda buffers support
2050 (defcustom org-agenda-sticky nil
2051 "Non-nil means agenda q key will bury agenda buffers.
2052 Agenda commands will then show existing buffer instead of generating new ones.
2053 When nil, `q' will kill the single agenda buffer."
2054 :group 'org-agenda
2055 :version "24.3"
2056 :type 'boolean)
2059 ;;;###autoload
2060 (defun org-toggle-sticky-agenda (&optional arg)
2061 "Toggle `org-agenda-sticky'."
2062 (interactive "P")
2063 (let ((new-value (if arg
2064 (> (prefix-numeric-value arg) 0)
2065 (not org-agenda-sticky))))
2066 (if (equal new-value org-agenda-sticky)
2067 (and (org-called-interactively-p 'interactive)
2068 (message "Sticky agenda was already %s"
2069 (if org-agenda-sticky "enabled" "disabled")))
2070 (setq org-agenda-sticky new-value)
2071 (org-agenda-kill-all-agenda-buffers)
2072 (and (org-called-interactively-p 'interactive)
2073 (message "Sticky agenda was %s"
2074 (if org-agenda-sticky "enabled" "disabled"))))))
2076 (defvar org-agenda-buffer nil
2077 "Agenda buffer currently being generated.")
2079 (defvar org-agenda-last-prefix-arg nil)
2080 (defvar org-agenda-this-buffer-name nil)
2081 (defvar org-agenda-doing-sticky-redo nil)
2082 (defvar org-agenda-this-buffer-is-sticky nil)
2083 (defvar org-agenda-last-indirect-buffer nil
2084 "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
2086 (defconst org-agenda-local-vars
2087 '(org-agenda-this-buffer-name
2088 org-agenda-undo-list
2089 org-agenda-pending-undo-list
2090 org-agenda-follow-mode
2091 org-agenda-entry-text-mode
2092 org-agenda-clockreport-mode
2093 org-agenda-show-log
2094 org-agenda-redo-command
2095 org-agenda-query-string
2096 org-agenda-type
2097 org-agenda-bulk-marked-entries
2098 org-agenda-undo-has-started-in
2099 org-agenda-info
2100 org-agenda-pre-window-conf
2101 org-agenda-columns-active
2102 org-agenda-tag-filter
2103 org-agenda-category-filter
2104 org-agenda-top-headline-filter
2105 org-agenda-regexp-filter
2106 org-agenda-effort-filter
2107 org-agenda-markers
2108 org-agenda-last-search-view-search-was-boolean
2109 org-agenda-last-indirect-buffer
2110 org-agenda-filtered-by-category
2111 org-agenda-filter-form
2112 org-agenda-cycle-counter
2113 org-agenda-last-prefix-arg)
2114 "Variables that must be local in agenda buffers to allow multiple buffers.")
2116 (defun org-agenda-mode ()
2117 "Mode for time-sorted view on action items in Org-mode files.
2119 The following commands are available:
2121 \\{org-agenda-mode-map}"
2122 (interactive)
2123 (cond (org-agenda-doing-sticky-redo
2124 ;; Refreshing sticky agenda-buffer
2126 ;; Preserve the value of `org-agenda-local-vars' variables,
2127 ;; while letting `kill-all-local-variables' kill the rest
2128 (let ((save (buffer-local-variables)))
2129 (kill-all-local-variables)
2130 (mapc 'make-local-variable org-agenda-local-vars)
2131 (dolist (elem save)
2132 (let ((var (car elem))
2133 (val (cdr elem)))
2134 (when (and val
2135 (member var org-agenda-local-vars))
2136 (set var val)))))
2137 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2138 (org-agenda-sticky
2139 ;; Creating a sticky Agenda buffer for the first time
2140 (kill-all-local-variables)
2141 (mapc 'make-local-variable org-agenda-local-vars)
2142 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2144 ;; Creating a non-sticky agenda buffer
2145 (kill-all-local-variables)
2146 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
2147 (setq org-agenda-undo-list nil
2148 org-agenda-pending-undo-list nil
2149 org-agenda-bulk-marked-entries nil)
2150 (setq major-mode 'org-agenda-mode)
2151 ;; Keep global-font-lock-mode from turning on font-lock-mode
2152 (org-set-local 'font-lock-global-modes (list 'not major-mode))
2153 (setq mode-name "Org-Agenda")
2154 (setq indent-tabs-mode nil)
2155 (use-local-map org-agenda-mode-map)
2156 (easy-menu-add org-agenda-menu)
2157 (if org-startup-truncated (setq truncate-lines t))
2158 (org-set-local 'line-move-visual nil)
2159 (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
2160 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
2161 ;; Make sure properties are removed when copying text
2162 (org-add-hook 'filter-buffer-substring-functions
2163 (lambda (fun start end delete)
2164 (substring-no-properties (funcall fun start end delete)))
2165 nil t)
2166 (unless org-agenda-keep-modes
2167 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2168 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
2169 (setq org-agenda-show-log org-agenda-start-with-log-mode)
2170 (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
2171 (add-to-invisibility-spec '(org-filtered))
2172 (add-to-invisibility-spec '(org-link))
2173 (easy-menu-change
2174 '("Agenda") "Agenda Files"
2175 (append
2176 (list
2177 (vector
2178 (if (get 'org-agenda-files 'org-restrict)
2179 "Restricted to single file"
2180 "Edit File List")
2181 '(org-edit-agenda-file-list)
2182 (not (get 'org-agenda-files 'org-restrict)))
2183 "--")
2184 (mapcar 'org-file-menu-entry (org-agenda-files))))
2185 (org-agenda-set-mode-name)
2186 (apply
2187 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
2188 (list 'org-agenda-mode-hook)))
2190 (substitute-key-definition 'undo 'org-agenda-undo
2191 org-agenda-mode-map global-map)
2192 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
2193 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
2194 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
2195 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
2196 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2197 (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
2198 (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
2199 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2200 (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
2201 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2202 (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
2203 (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
2204 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2205 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2206 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2207 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2208 (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
2209 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2210 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2211 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2212 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2213 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2214 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2215 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2216 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2217 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2218 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2219 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2220 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2221 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2222 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2223 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2224 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2225 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2226 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2227 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2228 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2229 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2230 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2231 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2232 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2233 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2234 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2235 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2236 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2237 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2238 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2239 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2240 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2241 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2243 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2244 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2245 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2246 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2247 (while l (org-defkey org-agenda-mode-map
2248 (int-to-string (pop l)) 'digit-argument)))
2250 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2251 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2252 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2253 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2254 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2255 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2256 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2257 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2258 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2259 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2260 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2261 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2262 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2263 'org-clock-modify-effort-estimate)
2264 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2265 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2266 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2267 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2268 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2269 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2270 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2271 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2272 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2273 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2274 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2275 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2276 (substitute-key-definition 'next-line 'org-agenda-next-line
2277 org-agenda-mode-map global-map)
2278 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2279 org-agenda-mode-map global-map)
2280 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2281 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2282 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2283 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2284 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2285 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2286 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2287 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2288 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2289 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2290 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2291 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2292 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2293 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2294 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2295 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2296 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2297 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2298 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2299 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2300 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2301 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2302 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2303 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2304 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2305 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2306 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2307 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2308 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2309 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2311 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2312 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2313 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2314 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2315 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2316 (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
2317 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2318 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2319 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2320 (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
2321 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2322 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
2323 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2324 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2325 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2326 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2328 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2329 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2331 (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
2332 (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
2334 (when org-agenda-mouse-1-follows-link
2335 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2336 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2337 '("Agenda"
2338 ("Agenda Files")
2339 "--"
2340 ("Agenda Dates"
2341 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2342 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2343 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2344 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2345 "--"
2346 ("View"
2347 ["Day View" org-agenda-day-view
2348 :active (org-agenda-check-type nil 'agenda)
2349 :style radio :selected (eq org-agenda-current-span 'day)
2350 :keys "v d (or just d)"]
2351 ["Week View" org-agenda-week-view
2352 :active (org-agenda-check-type nil 'agenda)
2353 :style radio :selected (eq org-agenda-current-span 'week)
2354 :keys "v w"]
2355 ["Fortnight View" org-agenda-fortnight-view
2356 :active (org-agenda-check-type nil 'agenda)
2357 :style radio :selected (eq org-agenda-current-span 'fortnight)
2358 :keys "v f"]
2359 ["Month View" org-agenda-month-view
2360 :active (org-agenda-check-type nil 'agenda)
2361 :style radio :selected (eq org-agenda-current-span 'month)
2362 :keys "v m"]
2363 ["Year View" org-agenda-year-view
2364 :active (org-agenda-check-type nil 'agenda)
2365 :style radio :selected (eq org-agenda-current-span 'year)
2366 :keys "v y"]
2367 "--"
2368 ["Include Diary" org-agenda-toggle-diary
2369 :style toggle :selected org-agenda-include-diary
2370 :active (org-agenda-check-type nil 'agenda)]
2371 ["Include Deadlines" org-agenda-toggle-deadlines
2372 :style toggle :selected org-agenda-include-deadlines
2373 :active (org-agenda-check-type nil 'agenda)]
2374 ["Use Time Grid" org-agenda-toggle-time-grid
2375 :style toggle :selected org-agenda-use-time-grid
2376 :active (org-agenda-check-type nil 'agenda)]
2377 "--"
2378 ["Show clock report" org-agenda-clockreport-mode
2379 :style toggle :selected org-agenda-clockreport-mode
2380 :active (org-agenda-check-type nil 'agenda)]
2381 ["Show some entry text" org-agenda-entry-text-mode
2382 :style toggle :selected org-agenda-entry-text-mode
2383 :active t]
2384 "--"
2385 ["Show Logbook entries" org-agenda-log-mode
2386 :style toggle :selected org-agenda-show-log
2387 :active (org-agenda-check-type nil 'agenda 'timeline)
2388 :keys "v l (or just l)"]
2389 ["Include archived trees" org-agenda-archives-mode
2390 :style toggle :selected org-agenda-archives-mode :active t
2391 :keys "v a"]
2392 ["Include archive files" (org-agenda-archives-mode t)
2393 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2394 :keys "v A"]
2395 "--"
2396 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2397 ["Write view to file" org-agenda-write t]
2398 ["Rebuild buffer" org-agenda-redo t]
2399 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2400 "--"
2401 ["Show original entry" org-agenda-show t]
2402 ["Go To (other window)" org-agenda-goto t]
2403 ["Go To (this window)" org-agenda-switch-to t]
2404 ["Capture with cursor date" org-agenda-capture t]
2405 ["Follow Mode" org-agenda-follow-mode
2406 :style toggle :selected org-agenda-follow-mode :active t]
2407 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2408 "--"
2409 ("TODO"
2410 ["Cycle TODO" org-agenda-todo t]
2411 ["Next TODO set" org-agenda-todo-nextset t]
2412 ["Previous TODO set" org-agenda-todo-previousset t]
2413 ["Add note" org-agenda-add-note t])
2414 ("Archive/Refile/Delete"
2415 ["Archive default" org-agenda-archive-default t]
2416 ["Archive default" org-agenda-archive-default-with-confirmation t]
2417 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2418 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2419 ["Archive subtree" org-agenda-archive t]
2420 "--"
2421 ["Refile" org-agenda-refile t]
2422 "--"
2423 ["Delete subtree" org-agenda-kill t])
2424 ("Bulk action"
2425 ["Mark entry" org-agenda-bulk-mark t]
2426 ["Mark all" org-agenda-bulk-mark-all t]
2427 ["Unmark entry" org-agenda-bulk-unmark t]
2428 ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
2429 ["Toggle mark" org-agenda-bulk-toggle t]
2430 ["Toggle all" org-agenda-bulk-toggle-all t]
2431 ["Mark regexp" org-agenda-bulk-mark-regexp t])
2432 ["Act on all marked" org-agenda-bulk-action t]
2433 "--"
2434 ("Tags and Properties"
2435 ["Show all Tags" org-agenda-show-tags t]
2436 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2437 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2438 "--"
2439 ["Column View" org-columns t])
2440 ("Deadline/Schedule"
2441 ["Schedule" org-agenda-schedule t]
2442 ["Set Deadline" org-agenda-deadline t]
2443 "--"
2444 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2445 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2446 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2447 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2448 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2449 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2450 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2451 ("Clock and Effort"
2452 ["Clock in" org-agenda-clock-in t]
2453 ["Clock out" org-agenda-clock-out t]
2454 ["Clock cancel" org-agenda-clock-cancel t]
2455 ["Goto running clock" org-clock-goto t]
2456 "--"
2457 ["Set Effort" org-agenda-set-effort t]
2458 ["Change clocked effort" org-clock-modify-effort-estimate
2459 (org-clock-is-active)])
2460 ("Priority"
2461 ["Set Priority" org-agenda-priority t]
2462 ["Increase Priority" org-agenda-priority-up t]
2463 ["Decrease Priority" org-agenda-priority-down t]
2464 ["Show Priority" org-show-priority t])
2465 ("Calendar/Diary"
2466 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2467 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2468 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2469 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2470 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2471 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2472 "--"
2473 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2474 "--"
2475 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2476 "--"
2477 ("MobileOrg"
2478 ["Push Files and Views" org-mobile-push t]
2479 ["Get Captured and Flagged" org-mobile-pull t]
2480 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2481 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2482 "--"
2483 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2484 "--"
2485 ["Quit" org-agenda-quit t]
2486 ["Exit and Release Buffers" org-agenda-exit t]
2489 ;;; Agenda undo
2491 (defvar org-agenda-allow-remote-undo t
2492 "Non-nil means allow remote undo from the agenda buffer.")
2493 (defvar org-agenda-undo-has-started-in nil
2494 "Buffers that have already seen `undo-start' in the current undo sequence.")
2496 (defun org-agenda-undo ()
2497 "Undo a remote editing step in the agenda.
2498 This undoes changes both in the agenda buffer and in the remote buffer
2499 that have been changed along."
2500 (interactive)
2501 (or org-agenda-allow-remote-undo
2502 (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2503 (if (not (eq this-command last-command))
2504 (setq org-agenda-undo-has-started-in nil
2505 org-agenda-pending-undo-list org-agenda-undo-list))
2506 (if (not org-agenda-pending-undo-list)
2507 (user-error "No further undo information"))
2508 (let* ((entry (pop org-agenda-pending-undo-list))
2509 buf line cmd rembuf)
2510 (setq cmd (pop entry) line (pop entry))
2511 (setq rembuf (nth 2 entry))
2512 (org-with-remote-undo rembuf
2513 (while (bufferp (setq buf (pop entry)))
2514 (if (pop entry)
2515 (with-current-buffer buf
2516 (let ((last-undo-buffer buf)
2517 (inhibit-read-only t))
2518 (unless (memq buf org-agenda-undo-has-started-in)
2519 (push buf org-agenda-undo-has-started-in)
2520 (make-local-variable 'pending-undo-list)
2521 (undo-start))
2522 (while (and pending-undo-list
2523 (listp pending-undo-list)
2524 (not (car pending-undo-list)))
2525 (pop pending-undo-list))
2526 (undo-more 1))))))
2527 (org-goto-line line)
2528 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2530 (defun org-verify-change-for-undo (l1 l2)
2531 "Verify that a real change occurred between the undo lists L1 and L2."
2532 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2533 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2534 (not (eq l1 l2)))
2536 ;;; Agenda dispatch
2538 (defvar org-agenda-restrict-begin (make-marker))
2539 (defvar org-agenda-restrict-end (make-marker))
2540 (defvar org-agenda-last-dispatch-buffer nil)
2541 (defvar org-agenda-overriding-restriction nil)
2543 (defcustom org-agenda-custom-commands-contexts nil
2544 "Alist of custom agenda keys and contextual rules.
2546 For example, if you have a custom agenda command \"p\" and you
2547 want this command to be accessible only from plain text files,
2548 use this:
2550 '((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
2552 Here are the available contexts definitions:
2554 in-file: command displayed only in matching files
2555 in-mode: command displayed only in matching modes
2556 not-in-file: command not displayed in matching files
2557 not-in-mode: command not displayed in matching modes
2558 in-buffer: command displayed only in matching buffers
2559 not-in-buffer: command not displayed in matching buffers
2560 [function]: a custom function taking no argument
2562 If you define several checks, the agenda command will be
2563 accessible if there is at least one valid check.
2565 You can also bind a key to another agenda custom command
2566 depending on contextual rules.
2568 '((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
2570 Here it means: in .txt files, use \"p\" as the key for the
2571 agenda command otherwise associated with \"q\". (The command
2572 originally associated with \"q\" is not displayed to avoid
2573 duplicates.)"
2574 :version "24.3"
2575 :group 'org-agenda-custom-commands
2576 :type '(repeat (list :tag "Rule"
2577 (string :tag " Agenda key")
2578 (string :tag "Replace by command")
2579 (repeat :tag "Available when"
2580 (choice
2581 (cons :tag "Condition"
2582 (choice
2583 (const :tag "In file" in-file)
2584 (const :tag "Not in file" not-in-file)
2585 (const :tag "In buffer" in-buffer)
2586 (const :tag "Not in buffer" not-in-buffer)
2587 (const :tag "In mode" in-mode)
2588 (const :tag "Not in mode" not-in-mode))
2589 (regexp))
2590 (function :tag "Custom function"))))))
2592 (defcustom org-agenda-max-entries nil
2593 "Maximum number of entries to display in an agenda.
2594 This can be nil (no limit) or an integer or an alist of agenda
2595 types with an associated number of entries to display in this
2596 type."
2597 :version "24.4"
2598 :package-version '(Org . "8.0")
2599 :group 'org-agenda-custom-commands
2600 :type '(choice (symbol :tag "No limit" nil)
2601 (integer :tag "Max number of entries")
2602 (repeat
2603 (cons (choice :tag "Agenda type"
2604 (const agenda)
2605 (const todo)
2606 (const tags)
2607 (const search)
2608 (const timeline))
2609 (integer :tag "Max number of entries")))))
2611 (defcustom org-agenda-max-todos nil
2612 "Maximum number of TODOs to display in an agenda.
2613 This can be nil (no limit) or an integer or an alist of agenda
2614 types with an associated number of entries to display in this
2615 type."
2616 :version "24.4"
2617 :package-version '(Org . "8.0")
2618 :group 'org-agenda-custom-commands
2619 :type '(choice (symbol :tag "No limit" nil)
2620 (integer :tag "Max number of TODOs")
2621 (repeat
2622 (cons (choice :tag "Agenda type"
2623 (const agenda)
2624 (const todo)
2625 (const tags)
2626 (const search)
2627 (const timeline))
2628 (integer :tag "Max number of TODOs")))))
2630 (defcustom org-agenda-max-tags nil
2631 "Maximum number of tagged entries to display in an agenda.
2632 This can be nil (no limit) or an integer or an alist of agenda
2633 types with an associated number of entries to display in this
2634 type."
2635 :version "24.4"
2636 :package-version '(Org . "8.0")
2637 :group 'org-agenda-custom-commands
2638 :type '(choice (symbol :tag "No limit" nil)
2639 (integer :tag "Max number of tagged entries")
2640 (repeat
2641 (cons (choice :tag "Agenda type"
2642 (const agenda)
2643 (const todo)
2644 (const tags)
2645 (const search)
2646 (const timeline))
2647 (integer :tag "Max number of tagged entries")))))
2649 (defcustom org-agenda-max-effort nil
2650 "Maximum cumulated effort duration for the agenda.
2651 This can be nil (no limit) or a number of minutes (as an integer)
2652 or an alist of agenda types with an associated number of minutes
2653 to limit entries to in this type."
2654 :version "24.4"
2655 :package-version '(Org . "8.0")
2656 :group 'org-agenda-custom-commands
2657 :type '(choice (symbol :tag "No limit" nil)
2658 (integer :tag "Max number of minutes")
2659 (repeat
2660 (cons (choice :tag "Agenda type"
2661 (const agenda)
2662 (const todo)
2663 (const tags)
2664 (const search)
2665 (const timeline))
2666 (integer :tag "Max number of minutes")))))
2668 (defvar org-keys nil)
2669 (defvar org-match nil)
2670 ;;;###autoload
2671 (defun org-agenda (&optional arg org-keys restriction)
2672 "Dispatch agenda commands to collect entries to the agenda buffer.
2673 Prompts for a command to execute. Any prefix arg will be passed
2674 on to the selected command. The default selections are:
2676 a Call `org-agenda-list' to display the agenda for current day or week.
2677 t Call `org-todo-list' to display the global todo list.
2678 T Call `org-todo-list' to display the global todo list, select only
2679 entries with a specific TODO keyword (the user gets a prompt).
2680 m Call `org-tags-view' to display headlines with tags matching
2681 a condition (the user is prompted for the condition).
2682 M Like `m', but select only TODO entries, no ordinary headlines.
2683 L Create a timeline for the current buffer.
2684 e Export views to associated files.
2685 s Search entries for keywords.
2686 S Search entries for keywords, only with TODO keywords.
2687 / Multi occur across all agenda files and also files listed
2688 in `org-agenda-text-search-extra-files'.
2689 < Restrict agenda commands to buffer, subtree, or region.
2690 Press several times to get the desired effect.
2691 > Remove a previous restriction.
2692 # List \"stuck\" projects.
2693 ! Configure what \"stuck\" means.
2694 C Configure custom agenda commands.
2696 More commands can be added by configuring the variable
2697 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2698 searches can be pre-defined in this way.
2700 If the current buffer is in Org-mode and visiting a file, you can also
2701 first press `<' once to indicate that the agenda should be temporarily
2702 \(until the next use of \\[org-agenda]) restricted to the current file.
2703 Pressing `<' twice means to restrict to the current subtree or region
2704 \(if active)."
2705 (interactive "P")
2706 (catch 'exit
2707 (let* ((prefix-descriptions nil)
2708 (org-agenda-buffer-name org-agenda-buffer-name)
2709 (org-agenda-window-setup (if (equal (buffer-name)
2710 org-agenda-buffer-name)
2711 'current-window
2712 org-agenda-window-setup))
2713 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2714 (org-agenda-custom-commands
2715 ;; normalize different versions
2716 (delq nil
2717 (mapcar
2718 (lambda (x)
2719 (cond ((stringp (cdr x))
2720 (push x prefix-descriptions)
2721 nil)
2722 ((stringp (nth 1 x)) x)
2723 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2724 (t (cons (car x) (cons "" (cdr x))))))
2725 org-agenda-custom-commands)))
2726 (org-agenda-custom-commands
2727 (org-contextualize-keys
2728 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2729 (buf (current-buffer))
2730 (bfn (buffer-file-name (buffer-base-buffer)))
2731 entry key type org-match lprops ans)
2732 ;; Turn off restriction unless there is an overriding one,
2733 (unless org-agenda-overriding-restriction
2734 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2735 ;; There is a request to keep the file list in place
2736 (put 'org-agenda-files 'org-restrict nil))
2737 (setq org-agenda-restrict nil)
2738 (move-marker org-agenda-restrict-begin nil)
2739 (move-marker org-agenda-restrict-end nil))
2740 ;; Delete old local properties
2741 (put 'org-agenda-redo-command 'org-lprops nil)
2742 ;; Delete previously set last-arguments
2743 (put 'org-agenda-redo-command 'last-args nil)
2744 ;; Remember where this call originated
2745 (setq org-agenda-last-dispatch-buffer (current-buffer))
2746 (unless org-keys
2747 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2748 org-keys (car ans)
2749 restriction (cdr ans)))
2750 ;; If we have sticky agenda buffers, set a name for the buffer,
2751 ;; depending on the invoking keys. The user may still set this
2752 ;; as a command option, which will overwrite what we do here.
2753 (if org-agenda-sticky
2754 (setq org-agenda-buffer-name
2755 (format "*Org Agenda(%s)*" org-keys)))
2756 ;; Establish the restriction, if any
2757 (when (and (not org-agenda-overriding-restriction) restriction)
2758 (put 'org-agenda-files 'org-restrict (list bfn))
2759 (cond
2760 ((eq restriction 'region)
2761 (setq org-agenda-restrict (current-buffer))
2762 (move-marker org-agenda-restrict-begin (region-beginning))
2763 (move-marker org-agenda-restrict-end (region-end)))
2764 ((eq restriction 'subtree)
2765 (save-excursion
2766 (setq org-agenda-restrict (current-buffer))
2767 (org-back-to-heading t)
2768 (move-marker org-agenda-restrict-begin (point))
2769 (move-marker org-agenda-restrict-end
2770 (progn (org-end-of-subtree t)))))))
2772 ;; For example the todo list should not need it (but does...)
2773 (cond
2774 ((setq entry (assoc org-keys org-agenda-custom-commands))
2775 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2776 (progn
2777 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2778 lprops (nth 4 entry))
2779 (if org-agenda-sticky
2780 (setq org-agenda-buffer-name
2781 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2782 (format "*Org Agenda(%s)*" org-keys))))
2783 (put 'org-agenda-redo-command 'org-lprops lprops)
2784 (cond
2785 ((eq type 'agenda)
2786 (org-let lprops '(org-agenda-list current-prefix-arg)))
2787 ((eq type 'agenda*)
2788 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2789 ((eq type 'alltodo)
2790 (org-let lprops '(org-todo-list current-prefix-arg)))
2791 ((eq type 'search)
2792 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2793 ((eq type 'stuck)
2794 (org-let lprops '(org-agenda-list-stuck-projects
2795 current-prefix-arg)))
2796 ((eq type 'tags)
2797 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2798 ((eq type 'tags-todo)
2799 (org-let lprops '(org-tags-view '(4) org-match)))
2800 ((eq type 'todo)
2801 (org-let lprops '(org-todo-list org-match)))
2802 ((eq type 'tags-tree)
2803 (org-check-for-org-mode)
2804 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2805 ((eq type 'todo-tree)
2806 (org-check-for-org-mode)
2807 (org-let lprops
2808 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2809 (regexp-quote org-match) "\\>"))))
2810 ((eq type 'occur-tree)
2811 (org-check-for-org-mode)
2812 (org-let lprops '(org-occur org-match)))
2813 ((functionp type)
2814 (org-let lprops '(funcall type org-match)))
2815 ((fboundp type)
2816 (org-let lprops '(funcall type org-match)))
2817 (t (user-error "Invalid custom agenda command type %s" type))))
2818 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2819 ((equal org-keys "C")
2820 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2821 (customize-variable 'org-agenda-custom-commands))
2822 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2823 ((equal org-keys "s") (call-interactively 'org-search-view))
2824 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2825 ((equal org-keys "t") (call-interactively 'org-todo-list))
2826 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2827 ((equal org-keys "m") (call-interactively 'org-tags-view))
2828 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2829 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2830 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2831 (org-add-hook
2832 'post-command-hook
2833 (lambda ()
2834 (unless (current-message)
2835 (let* ((m (org-agenda-get-any-marker))
2836 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2837 (when note
2838 (message (concat
2839 "FLAGGING-NOTE ([?] for more info): "
2840 (org-add-props
2841 (replace-regexp-in-string
2842 "\\\\n" "//"
2843 (copy-sequence note))
2844 nil 'face 'org-warning)))))))
2845 t t))
2846 ((equal org-keys "L")
2847 (unless (derived-mode-p 'org-mode)
2848 (user-error "This is not an Org-mode file"))
2849 (unless restriction
2850 (put 'org-agenda-files 'org-restrict (list bfn))
2851 (org-call-with-arg 'org-timeline arg)))
2852 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2853 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2854 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2855 (t (user-error "Invalid agenda key"))))))
2857 (defvar org-agenda-multi)
2859 (defun org-agenda-append-agenda ()
2860 "Append another agenda view to the current one.
2861 This function allows interactive building of block agendas.
2862 Agenda views are separated by `org-agenda-block-separator'."
2863 (interactive)
2864 (unless (derived-mode-p 'org-agenda-mode)
2865 (user-error "Can only append from within agenda buffer"))
2866 (let ((org-agenda-multi t))
2867 (org-agenda)
2868 (widen)
2869 (org-agenda-finalize)
2870 (setq buffer-read-only t)
2871 (org-agenda-fit-window-to-buffer)))
2873 (defun org-agenda-normalize-custom-commands (cmds)
2874 "Normalize custom commands CMDS."
2875 (delq nil
2876 (mapcar
2877 (lambda (x)
2878 (cond ((stringp (cdr x)) nil)
2879 ((stringp (nth 1 x)) x)
2880 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2881 (t (cons (car x) (cons "" (cdr x))))))
2882 cmds)))
2884 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2885 "The user interface for selecting an agenda command."
2886 (catch 'exit
2887 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2888 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2889 (region-p (org-region-active-p))
2890 (custom org-agenda-custom-commands)
2891 (selstring "")
2892 restriction second-time
2893 c entry key type match prefixes rmheader header-end custom1 desc
2894 line lines left right n n1)
2895 (save-window-excursion
2896 (delete-other-windows)
2897 (org-switch-to-buffer-other-window " *Agenda Commands*")
2898 (erase-buffer)
2899 (insert (eval-when-compile
2900 (let ((header
2901 "Press key for an agenda command: < Buffer, subtree/region restriction
2902 -------------------------------- > Remove restriction
2903 a Agenda for current week or day e Export agenda views
2904 t List of all TODO entries T Entries with special TODO kwd
2905 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2906 s Search for keywords S Like s, but only TODO entries
2907 L Timeline for current buffer # List stuck projects (!=configure)
2908 / Multi-occur C Configure custom agenda commands
2909 ? Find :FLAGGED: entries * Toggle sticky agenda views
2911 (start 0))
2912 (while (string-match
2913 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2914 header start)
2915 (setq start (match-end 0))
2916 (add-text-properties (match-beginning 2) (match-end 2)
2917 '(face bold) header))
2918 header)))
2919 (setq header-end (point-marker))
2920 (while t
2921 (setq custom1 custom)
2922 (when (eq rmheader t)
2923 (org-goto-line 1)
2924 (re-search-forward ":" nil t)
2925 (delete-region (match-end 0) (point-at-eol))
2926 (forward-char 1)
2927 (looking-at "-+")
2928 (delete-region (match-end 0) (point-at-eol))
2929 (move-marker header-end (match-end 0)))
2930 (goto-char header-end)
2931 (delete-region (point) (point-max))
2933 ;; Produce all the lines that describe custom commands and prefixes
2934 (setq lines nil)
2935 (while (setq entry (pop custom1))
2936 (setq key (car entry) desc (nth 1 entry)
2937 type (nth 2 entry)
2938 match (nth 3 entry))
2939 (if (> (length key) 1)
2940 (add-to-list 'prefixes (string-to-char key))
2941 (setq line
2942 (format
2943 "%-4s%-14s"
2944 (org-add-props (copy-sequence key)
2945 '(face bold))
2946 (cond
2947 ((string-match "\\S-" desc) desc)
2948 ((eq type 'agenda) "Agenda for current week or day")
2949 ((eq type 'agenda*) "Appointments for current week or day")
2950 ((eq type 'alltodo) "List of all TODO entries")
2951 ((eq type 'search) "Word search")
2952 ((eq type 'stuck) "List of stuck projects")
2953 ((eq type 'todo) "TODO keyword")
2954 ((eq type 'tags) "Tags query")
2955 ((eq type 'tags-todo) "Tags (TODO)")
2956 ((eq type 'tags-tree) "Tags tree")
2957 ((eq type 'todo-tree) "TODO kwd tree")
2958 ((eq type 'occur-tree) "Occur tree")
2959 ((functionp type) (if (symbolp type)
2960 (symbol-name type)
2961 "Lambda expression"))
2962 (t "???"))))
2963 (if org-agenda-menu-show-matcher
2964 (setq line
2965 (concat line ": "
2966 (cond
2967 ((stringp match)
2968 (setq match (copy-sequence match))
2969 (org-add-props match nil 'face 'org-warning))
2970 ((listp type)
2971 (format "set of %d commands" (length type))))))
2972 (if (org-string-nw-p match)
2973 (add-text-properties
2974 0 (length line) (list 'help-echo
2975 (concat "Matcher: " match)) line)))
2976 (push line lines)))
2977 (setq lines (nreverse lines))
2978 (when prefixes
2979 (mapc (lambda (x)
2980 (push
2981 (format "%s %s"
2982 (org-add-props (char-to-string x)
2983 nil 'face 'bold)
2984 (or (cdr (assoc (concat selstring
2985 (char-to-string x))
2986 prefix-descriptions))
2987 "Prefix key"))
2988 lines))
2989 prefixes))
2991 ;; Check if we should display in two columns
2992 (if org-agenda-menu-two-columns
2993 (progn
2994 (setq n (length lines)
2995 n1 (+ (/ n 2) (mod n 2))
2996 right (nthcdr n1 lines)
2997 left (copy-sequence lines))
2998 (setcdr (nthcdr (1- n1) left) nil))
2999 (setq left lines right nil))
3000 (while left
3001 (insert "\n" (pop left))
3002 (when right
3003 (if (< (current-column) 40)
3004 (move-to-column 40 t)
3005 (insert " "))
3006 (insert (pop right))))
3008 ;; Make the window the right size
3009 (goto-char (point-min))
3010 (if second-time
3011 (if (not (pos-visible-in-window-p (point-max)))
3012 (org-fit-window-to-buffer))
3013 (setq second-time t)
3014 (org-fit-window-to-buffer))
3016 ;; Ask for selection
3017 (message "Press key for agenda command%s:"
3018 (if (or restrict-ok org-agenda-overriding-restriction)
3019 (if org-agenda-overriding-restriction
3020 " (restriction lock active)"
3021 (if restriction
3022 (format " (restricted to %s)" restriction)
3023 " (unrestricted)"))
3024 ""))
3025 (setq c (read-char-exclusive))
3026 (message "")
3027 (cond
3028 ((assoc (char-to-string c) custom)
3029 (setq selstring (concat selstring (char-to-string c)))
3030 (throw 'exit (cons selstring restriction)))
3031 ((memq c prefixes)
3032 (setq selstring (concat selstring (char-to-string c))
3033 prefixes nil
3034 rmheader (or rmheader t)
3035 custom (delq nil (mapcar
3036 (lambda (x)
3037 (if (or (= (length (car x)) 1)
3038 (/= (string-to-char (car x)) c))
3040 (cons (substring (car x) 1) (cdr x))))
3041 custom))))
3042 ((eq c ?*)
3043 (call-interactively 'org-toggle-sticky-agenda)
3044 (sit-for 2))
3045 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3046 (message "Restriction is only possible in Org-mode buffers")
3047 (ding) (sit-for 1))
3048 ((eq c ?1)
3049 (org-agenda-remove-restriction-lock 'noupdate)
3050 (setq restriction 'buffer))
3051 ((eq c ?0)
3052 (org-agenda-remove-restriction-lock 'noupdate)
3053 (setq restriction (if region-p 'region 'subtree)))
3054 ((eq c ?<)
3055 (org-agenda-remove-restriction-lock 'noupdate)
3056 (setq restriction
3057 (cond
3058 ((eq restriction 'buffer)
3059 (if region-p 'region 'subtree))
3060 ((memq restriction '(subtree region))
3061 nil)
3062 (t 'buffer))))
3063 ((eq c ?>)
3064 (org-agenda-remove-restriction-lock 'noupdate)
3065 (setq restriction nil))
3066 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3067 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3068 ((and (> (length selstring) 0) (eq c ?\d))
3069 (delete-window)
3070 (org-agenda-get-restriction-and-command prefix-descriptions))
3072 ((equal c ?q) (error "Abort"))
3073 (t (user-error "Invalid key %c" c))))))))
3075 (defun org-agenda-fit-window-to-buffer ()
3076 "Fit the window to the buffer size."
3077 (and (memq org-agenda-window-setup '(reorganize-frame))
3078 (fboundp 'fit-window-to-buffer)
3079 (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
3080 (= (car org-agenda-window-frame-fractions) 1.0))
3081 (delete-other-windows)
3082 (org-fit-window-to-buffer
3084 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3085 (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
3087 (defvar org-cmd nil)
3088 (defvar org-agenda-overriding-cmd nil)
3089 (defvar org-agenda-overriding-arguments nil)
3090 (defvar org-agenda-overriding-cmd-arguments nil)
3091 (defun org-agenda-run-series (name series)
3092 "Run agenda NAME as a SERIES of agenda commands."
3093 (org-let (nth 1 series) '(org-agenda-prepare name))
3094 ;; We need to reset agenda markers here, because when constructing a
3095 ;; block agenda, the individual blocks do not do that.
3096 (org-agenda-reset-markers)
3097 (let* ((org-agenda-multi t)
3098 (redo (list 'org-agenda-run-series name (list 'quote series)))
3099 (cmds (car series))
3100 (gprops (nth 1 series))
3101 match ;; The byte compiler incorrectly complains about this. Keep it!
3102 org-cmd type lprops)
3103 (while (setq org-cmd (pop cmds))
3104 (setq type (car org-cmd)
3105 match (eval (nth 1 org-cmd))
3106 lprops (nth 2 org-cmd))
3107 (let ((org-agenda-overriding-arguments
3108 (if (eq org-agenda-overriding-cmd org-cmd)
3109 (or org-agenda-overriding-arguments
3110 org-agenda-overriding-cmd-arguments))))
3111 (cond
3112 ((eq type 'agenda)
3113 (org-let2 gprops lprops
3114 '(call-interactively 'org-agenda-list)))
3115 ((eq type 'agenda*)
3116 (org-let2 gprops lprops
3117 '(funcall 'org-agenda-list nil nil t)))
3118 ((eq type 'alltodo)
3119 (org-let2 gprops lprops
3120 '(call-interactively 'org-todo-list)))
3121 ((eq type 'search)
3122 (org-let2 gprops lprops
3123 '(org-search-view current-prefix-arg match nil)))
3124 ((eq type 'stuck)
3125 (org-let2 gprops lprops
3126 '(call-interactively 'org-agenda-list-stuck-projects)))
3127 ((eq type 'tags)
3128 (org-let2 gprops lprops
3129 '(org-tags-view current-prefix-arg match)))
3130 ((eq type 'tags-todo)
3131 (org-let2 gprops lprops
3132 '(org-tags-view '(4) match)))
3133 ((eq type 'todo)
3134 (org-let2 gprops lprops
3135 '(org-todo-list match)))
3136 ((fboundp type)
3137 (org-let2 gprops lprops
3138 '(funcall type match)))
3139 (t (error "Invalid type in command series")))))
3140 (widen)
3141 (let ((inhibit-read-only t))
3142 (add-text-properties (point-min) (point-max)
3143 `(org-series t org-series-redo-cmd ,redo)))
3144 (setq org-agenda-redo-command redo)
3145 (goto-char (point-min)))
3146 (org-agenda-fit-window-to-buffer)
3147 (org-let (nth 1 series) '(org-agenda-finalize)))
3149 ;;;###autoload
3150 (defmacro org-batch-agenda (cmd-key &rest parameters)
3151 "Run an agenda command in batch mode and send the result to STDOUT.
3152 If CMD-KEY is a string of length 1, it is used as a key in
3153 `org-agenda-custom-commands' and triggers this command. If it is a
3154 longer string it is used as a tags/todo match string.
3155 Parameters are alternating variable names and values that will be bound
3156 before running the agenda command."
3157 (org-eval-in-environment (org-make-parameter-alist parameters)
3158 (let (org-agenda-sticky)
3159 (if (> (length cmd-key) 2)
3160 (org-tags-view nil cmd-key)
3161 (org-agenda nil cmd-key))))
3162 (set-buffer org-agenda-buffer-name)
3163 (princ (buffer-string)))
3165 (defvar org-agenda-info nil)
3167 ;;;###autoload
3168 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3169 "Run an agenda command in batch mode and send the result to STDOUT.
3170 If CMD-KEY is a string of length 1, it is used as a key in
3171 `org-agenda-custom-commands' and triggers this command. If it is a
3172 longer string it is used as a tags/todo match string.
3173 Parameters are alternating variable names and values that will be bound
3174 before running the agenda command.
3176 The output gives a line for each selected agenda item. Each
3177 item is a list of comma-separated values, like this:
3179 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3181 category The category of the item
3182 head The headline, without TODO kwd, TAGS and PRIORITY
3183 type The type of the agenda entry, can be
3184 todo selected in TODO match
3185 tagsmatch selected in tags match
3186 diary imported from diary
3187 deadline a deadline on given date
3188 scheduled scheduled on given date
3189 timestamp entry has timestamp on given date
3190 closed entry was closed on given date
3191 upcoming-deadline warning about deadline
3192 past-scheduled forwarded scheduled item
3193 block entry has date block including g. date
3194 todo The todo keyword, if any
3195 tags All tags including inherited ones, separated by colons
3196 date The relevant date, like 2007-2-14
3197 time The time, like 15:00-16:50
3198 extra Sting with extra planning info
3199 priority-l The priority letter if any was given
3200 priority-n The computed numerical priority
3201 agenda-day The day in the agenda where this is listed"
3202 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3203 (org-make-parameter-alist parameters))
3204 (if (> (length cmd-key) 2)
3205 (org-tags-view nil cmd-key)
3206 (org-agenda nil cmd-key)))
3207 (set-buffer org-agenda-buffer-name)
3208 (let* ((lines (org-split-string (buffer-string) "\n"))
3209 line)
3210 (while (setq line (pop lines))
3211 (catch 'next
3212 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3213 (setq org-agenda-info
3214 (org-fix-agenda-info (text-properties-at 0 line)))
3215 (princ
3216 (mapconcat 'org-agenda-export-csv-mapper
3217 '(org-category txt type todo tags date time extra
3218 priority-letter priority agenda-day)
3219 ","))
3220 (princ "\n")))))
3222 (defun org-fix-agenda-info (props)
3223 "Make sure all properties on an agenda item have a canonical form.
3224 This ensures the export commands can easily use it."
3225 (let (tmp re)
3226 (when (setq tmp (plist-get props 'tags))
3227 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3228 (when (setq tmp (plist-get props 'date))
3229 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3230 (let ((calendar-date-display-form '(year "-" month "-" day)))
3231 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3233 (setq tmp (calendar-date-string tmp)))
3234 (setq props (plist-put props 'date tmp)))
3235 (when (setq tmp (plist-get props 'day))
3236 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3237 (let ((calendar-date-display-form '(year "-" month "-" day)))
3238 (setq tmp (calendar-date-string tmp)))
3239 (setq props (plist-put props 'day tmp))
3240 (setq props (plist-put props 'agenda-day tmp)))
3241 (when (setq tmp (plist-get props 'txt))
3242 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3243 (plist-put props 'priority-letter (match-string 1 tmp))
3244 (setq tmp (replace-match "" t t tmp)))
3245 (when (and (setq re (plist-get props 'org-todo-regexp))
3246 (setq re (concat "\\`\\.*" re " ?"))
3247 (string-match re tmp))
3248 (plist-put props 'todo (match-string 1 tmp))
3249 (setq tmp (replace-match "" t t tmp)))
3250 (plist-put props 'txt tmp)))
3251 props)
3253 (defun org-agenda-export-csv-mapper (prop)
3254 (let ((res (plist-get org-agenda-info prop)))
3255 (setq res
3256 (cond
3257 ((not res) "")
3258 ((stringp res) res)
3259 (t (prin1-to-string res))))
3260 (while (string-match "," res)
3261 (setq res (replace-match ";" t t res)))
3262 (org-trim res)))
3264 ;;;###autoload
3265 (defun org-store-agenda-views (&rest parameters)
3266 "Store agenda views."
3267 (interactive)
3268 (eval (list 'org-batch-store-agenda-views)))
3270 ;;;###autoload
3271 (defmacro org-batch-store-agenda-views (&rest parameters)
3272 "Run all custom agenda commands that have a file argument."
3273 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3274 (pop-up-frames nil)
3275 (dir default-directory)
3276 (pars (org-make-parameter-alist parameters))
3277 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3278 (save-window-excursion
3279 (while cmds
3280 (setq cmd (pop cmds)
3281 thiscmdkey (car cmd)
3282 thiscmdcmd (cdr cmd)
3283 match (nth 2 thiscmdcmd)
3284 bufname (if org-agenda-sticky
3285 (or (and (stringp match)
3286 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3287 (format "*Org Agenda(%s)*" thiscmdkey))
3288 org-agenda-buffer-name)
3289 cmd-or-set (nth 2 cmd)
3290 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3291 files (nth (if (listp cmd-or-set) 4 5) cmd))
3292 (if (stringp files) (setq files (list files)))
3293 (when files
3294 (org-eval-in-environment (append org-agenda-exporter-settings
3295 opts pars)
3296 (org-agenda nil thiscmdkey))
3297 (set-buffer bufname)
3298 (while files
3299 (org-eval-in-environment (append org-agenda-exporter-settings
3300 opts pars)
3301 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3302 (and (get-buffer bufname)
3303 (kill-buffer bufname)))))))
3305 (defvar org-agenda-current-span nil
3306 "The current span used in the agenda view.") ; local variable in the agenda buffer
3307 (defun org-agenda-mark-header-line (pos)
3308 "Mark the line at POS as an agenda structure header."
3309 (save-excursion
3310 (goto-char pos)
3311 (put-text-property (point-at-bol) (point-at-eol)
3312 'org-agenda-structural-header t)
3313 (when org-agenda-title-append
3314 (put-text-property (point-at-bol) (point-at-eol)
3315 'org-agenda-title-append org-agenda-title-append))))
3317 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3318 (defvar org-agenda-write-buffer-name "Agenda View")
3319 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3320 "Write the current buffer (an agenda view) as a file.
3322 Depending on the extension of the file name, plain text (.txt),
3323 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3324 If the extension is .ics, translate visible agenda into iCalendar
3325 format. If the extension is .org, collect all subtrees
3326 corresponding to the agenda entries and add them in an .org file.
3328 With prefix argument OPEN, open the new file immediately. If
3329 NOSETTINGS is given, do not scope the settings of
3330 `org-agenda-exporter-settings' into the export commands. This is
3331 used when the settings have already been scoped and we do not
3332 wish to overrule other, higher priority settings. If
3333 AGENDA-BUFFER-NAME is provided, use this as the buffer name for
3334 the agenda to write."
3335 (interactive "FWrite agenda to file: \nP")
3336 (if (or (not (file-writable-p file))
3337 (and (file-exists-p file)
3338 (if (org-called-interactively-p 'any)
3339 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3340 (user-error "Cannot write agenda to file %s" file))
3341 (org-let (if nosettings nil org-agenda-exporter-settings)
3342 '(save-excursion
3343 (save-window-excursion
3344 (let ((bs (copy-sequence (buffer-string))) beg content)
3345 (with-temp-buffer
3346 (rename-buffer org-agenda-write-buffer-name t)
3347 (set-buffer-modified-p nil)
3348 (insert bs)
3349 (org-agenda-remove-marked-text 'org-filtered)
3350 (run-hooks 'org-agenda-before-write-hook)
3351 (cond
3352 ((org-bound-and-true-p org-mobile-creating-agendas)
3353 (org-mobile-write-agenda-for-mobile file))
3354 ((string-match "\\.org\\'" file)
3355 (let (content p m message-log-max)
3356 (goto-char (point-min))
3357 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3358 (goto-char p)
3359 (setq m (get-text-property (point) 'org-hd-marker))
3360 (when m
3361 (push (save-excursion
3362 (set-buffer (marker-buffer m))
3363 (goto-char m)
3364 (org-copy-subtree 1 nil t t)
3365 org-subtree-clip)
3366 content)))
3367 (find-file file)
3368 (erase-buffer)
3369 (dolist (s content) (org-paste-subtree 1 s))
3370 (write-file file)
3371 (kill-buffer (current-buffer))
3372 (message "Org file written to %s" file)))
3373 ((string-match "\\.html?\\'" file)
3374 (require 'htmlize)
3375 (set-buffer (htmlize-buffer (current-buffer)))
3376 (when org-agenda-export-html-style
3377 ;; replace <style> section with org-agenda-export-html-style
3378 (goto-char (point-min))
3379 (kill-region (- (search-forward "<style") 6)
3380 (search-forward "</style>"))
3381 (insert org-agenda-export-html-style))
3382 (write-file file)
3383 (kill-buffer (current-buffer))
3384 (message "HTML written to %s" file))
3385 ((string-match "\\.ps\\'" file)
3386 (require 'ps-print)
3387 (ps-print-buffer-with-faces file)
3388 (message "Postscript written to %s" file))
3389 ((string-match "\\.pdf\\'" file)
3390 (require 'ps-print)
3391 (ps-print-buffer-with-faces
3392 (concat (file-name-sans-extension file) ".ps"))
3393 (call-process "ps2pdf" nil nil nil
3394 (expand-file-name
3395 (concat (file-name-sans-extension file) ".ps"))
3396 (expand-file-name file))
3397 (delete-file (concat (file-name-sans-extension file) ".ps"))
3398 (message "PDF written to %s" file))
3399 ((string-match "\\.ics\\'" file)
3400 (require 'ox-icalendar)
3401 (org-icalendar-export-current-agenda (expand-file-name file)))
3403 (let ((bs (buffer-string)))
3404 (find-file file)
3405 (erase-buffer)
3406 (insert bs)
3407 (save-buffer 0)
3408 (kill-buffer (current-buffer))
3409 (message "Plain text written to %s" file))))))))
3410 (set-buffer (or agenda-bufname
3411 (and (org-called-interactively-p 'any) (buffer-name))
3412 org-agenda-buffer-name)))
3413 (when open (org-open-file file)))
3415 (defun org-agenda-remove-marked-text (property &optional value)
3416 "Delete all text marked with VALUE of PROPERTY.
3417 VALUE defaults to t."
3418 (let (beg)
3419 (setq value (or value t))
3420 (while (setq beg (text-property-any (point-min) (point-max)
3421 property value))
3422 (delete-region
3423 beg (or (next-single-property-change beg property)
3424 (point-max))))))
3426 (defun org-agenda-add-entry-text ()
3427 "Add entry text to agenda lines.
3428 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3429 entry text following headings shown in the agenda.
3430 Drawers will be excluded, also the line with scheduling/deadline info."
3431 (when (and (> org-agenda-add-entry-text-maxlines 0)
3432 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3433 (let (m txt)
3434 (goto-char (point-min))
3435 (while (not (eobp))
3436 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3437 (beginning-of-line 2)
3438 (setq txt (org-agenda-get-some-entry-text
3439 m org-agenda-add-entry-text-maxlines " > "))
3440 (end-of-line 1)
3441 (if (string-match "\\S-" txt)
3442 (insert "\n" txt)
3443 (or (eobp) (forward-char 1))))))))
3445 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3446 &rest keep)
3447 "Extract entry text from MARKER, at most N-LINES lines.
3448 This will ignore drawers etc, just get the text.
3449 If INDENT is given, prefix every line with this string. If KEEP is
3450 given, it is a list of symbols, defining stuff that should not be
3451 removed from the entry content. Currently only `planning' is allowed here."
3452 (let (txt drawer-re kwd-time-re ind)
3453 (save-excursion
3454 (with-current-buffer (marker-buffer marker)
3455 (if (not (derived-mode-p 'org-mode))
3456 (setq txt "")
3457 (save-excursion
3458 (save-restriction
3459 (widen)
3460 (goto-char marker)
3461 (end-of-line 1)
3462 (setq txt (buffer-substring
3463 (min (1+ (point)) (point-max))
3464 (progn (outline-next-heading) (point)))
3465 drawer-re org-drawer-regexp
3466 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3467 ".*\n?"))
3468 (with-temp-buffer
3469 (insert txt)
3470 (when org-agenda-add-entry-text-descriptive-links
3471 (goto-char (point-min))
3472 (while (org-activate-bracket-links (point-max))
3473 (add-text-properties (match-beginning 0) (match-end 0)
3474 '(face org-link))))
3475 (goto-char (point-min))
3476 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3477 (set-text-properties (match-beginning 0) (match-end 0)
3478 nil))
3479 (goto-char (point-min))
3480 (while (re-search-forward drawer-re nil t)
3481 (delete-region
3482 (match-beginning 0)
3483 (progn (re-search-forward
3484 "^[ \t]*:END:.*\n?" nil 'move)
3485 (point))))
3486 (unless (member 'planning keep)
3487 (goto-char (point-min))
3488 (while (re-search-forward kwd-time-re nil t)
3489 (replace-match "")))
3490 (goto-char (point-min))
3491 (when org-agenda-entry-text-exclude-regexps
3492 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3493 (while (setq re (pop re-list))
3494 (goto-char (point-min))
3495 (while (re-search-forward re nil t)
3496 (replace-match "")))))
3497 (goto-char (point-max))
3498 (skip-chars-backward " \t\n")
3499 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3501 ;; find and remove min common indentation
3502 (goto-char (point-min))
3503 (untabify (point-min) (point-max))
3504 (setq ind (org-get-indentation))
3505 (while (not (eobp))
3506 (unless (looking-at "[ \t]*$")
3507 (setq ind (min ind (org-get-indentation))))
3508 (beginning-of-line 2))
3509 (goto-char (point-min))
3510 (while (not (eobp))
3511 (unless (looking-at "[ \t]*$")
3512 (move-to-column ind)
3513 (delete-region (point-at-bol) (point)))
3514 (beginning-of-line 2))
3516 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3518 (goto-char (point-min))
3519 (when indent
3520 (while (and (not (eobp)) (re-search-forward "^" nil t))
3521 (replace-match indent t t)))
3522 (goto-char (point-min))
3523 (while (looking-at "[ \t]*\n") (replace-match ""))
3524 (goto-char (point-max))
3525 (when (> (org-current-line)
3526 n-lines)
3527 (org-goto-line (1+ n-lines))
3528 (backward-char 1))
3529 (setq txt (buffer-substring (point-min) (point)))))))))
3530 txt))
3532 (defun org-check-for-org-mode ()
3533 "Make sure current buffer is in org-mode. Error if not."
3534 (or (derived-mode-p 'org-mode)
3535 (error "Cannot execute org-mode agenda command on buffer in %s"
3536 major-mode)))
3538 ;;; Agenda prepare and finalize
3540 (defvar org-agenda-multi nil) ; dynamically scoped
3541 (defvar org-agenda-pre-window-conf nil)
3542 (defvar org-agenda-columns-active nil)
3543 (defvar org-agenda-name nil)
3544 (defvar org-agenda-tag-filter nil)
3545 (defvar org-agenda-category-filter nil)
3546 (defvar org-agenda-regexp-filter nil)
3547 (defvar org-agenda-effort-filter nil)
3548 (defvar org-agenda-top-headline-filter nil)
3549 (defvar org-agenda-tag-filter-preset nil
3550 "A preset of the tags filter used for secondary agenda filtering.
3551 This must be a list of strings, each string must be a single tag preceded
3552 by \"+\" or \"-\".
3553 This variable should not be set directly, but agenda custom commands can
3554 bind it in the options section. The preset filter is a global property of
3555 the entire agenda view. In a block agenda, it will not work reliably to
3556 define a filter for one of the individual blocks. You need to set it in
3557 the global options and expect it to be applied to the entire view.")
3559 (defvar org-agenda-category-filter-preset nil
3560 "A preset of the category filter used for secondary agenda filtering.
3561 This must be a list of strings, each string must be a single category
3562 preceded by \"+\" or \"-\".
3563 This variable should not be set directly, but agenda custom commands can
3564 bind it in the options section. The preset filter is a global property of
3565 the entire agenda view. In a block agenda, it will not work reliably to
3566 define a filter for one of the individual blocks. You need to set it in
3567 the global options and expect it to be applied to the entire view.")
3569 (defvar org-agenda-regexp-filter-preset nil
3570 "A preset of the regexp filter used for secondary agenda filtering.
3571 This must be a list of strings, each string must be a single regexp
3572 preceded by \"+\" or \"-\".
3573 This variable should not be set directly, but agenda custom commands can
3574 bind it in the options section. The preset filter is a global property of
3575 the entire agenda view. In a block agenda, it will not work reliably to
3576 define a filter for one of the individual blocks. You need to set it in
3577 the global options and expect it to be applied to the entire view.")
3579 (defvar org-agenda-effort-filter-preset nil
3580 "A preset of the effort condition used for secondary agenda filtering.
3581 This must be a list of strings, each string must be a single regexp
3582 preceded by \"+\" or \"-\".
3583 This variable should not be set directly, but agenda custom commands can
3584 bind it in the options section. The preset filter is a global property of
3585 the entire agenda view. In a block agenda, it will not work reliably to
3586 define a filter for one of the individual blocks. You need to set it in
3587 the global options and expect it to be applied to the entire view.")
3589 (defun org-agenda-use-sticky-p ()
3590 "Return non-nil if an agenda buffer named
3591 `org-agenda-buffer-name' exists and should be shown instead of
3592 generating a new one."
3593 (and
3594 ;; turned off by user
3595 org-agenda-sticky
3596 ;; For multi-agenda buffer already exists
3597 (not org-agenda-multi)
3598 ;; buffer found
3599 (get-buffer org-agenda-buffer-name)
3600 ;; C-u parameter is same as last call
3601 (with-current-buffer (get-buffer org-agenda-buffer-name)
3602 (and
3603 (equal current-prefix-arg
3604 org-agenda-last-prefix-arg)
3605 ;; In case user turned stickiness on, while having existing
3606 ;; Agenda buffer active, don't reuse that buffer, because it
3607 ;; does not have org variables local
3608 org-agenda-this-buffer-is-sticky))))
3610 (defun org-agenda-prepare-window (abuf filter-alist)
3611 "Setup agenda buffer in the window.
3612 ABUF is the buffer for the agenda window.
3613 FILTER-ALIST is an alist of filters we need to apply when
3614 `org-agenda-persistent-filter' is non-nil."
3615 (let* ((awin (get-buffer-window abuf)) wconf)
3616 (cond
3617 ((equal (current-buffer) abuf) nil)
3618 (awin (select-window awin))
3619 ((not (setq wconf (current-window-configuration))))
3620 ((equal org-agenda-window-setup 'current-window)
3621 (org-pop-to-buffer-same-window abuf))
3622 ((equal org-agenda-window-setup 'other-window)
3623 (org-switch-to-buffer-other-window abuf))
3624 ((equal org-agenda-window-setup 'other-frame)
3625 (switch-to-buffer-other-frame abuf))
3626 ((eq org-agenda-window-setup 'only-window)
3627 (delete-other-windows)
3628 (org-pop-to-buffer-same-window abuf))
3629 ((equal org-agenda-window-setup 'reorganize-frame)
3630 (delete-other-windows)
3631 (org-switch-to-buffer-other-window abuf)))
3632 (setq org-agenda-tag-filter (cdr (assoc 'tag filter-alist)))
3633 (setq org-agenda-category-filter (cdr (assoc 'cat filter-alist)))
3634 (setq org-agenda-effort-filter (cdr (assoc 'effort filter-alist)))
3635 (setq org-agenda-regexp-filter (cdr (assoc 're filter-alist)))
3636 ;; Additional test in case agenda is invoked from within agenda
3637 ;; buffer via elisp link.
3638 (unless (equal (current-buffer) abuf)
3639 (org-pop-to-buffer-same-window abuf))
3640 (setq org-agenda-pre-window-conf
3641 (or wconf org-agenda-pre-window-conf))))
3643 (defun org-agenda-prepare (&optional name)
3644 (let ((filter-alist (if org-agenda-persistent-filter
3645 (list `(tag . ,org-agenda-tag-filter)
3646 `(re . ,org-agenda-regexp-filter)
3647 `(effort . ,org-agenda-effort-filter)
3648 `(car . ,org-agenda-category-filter)))))
3649 (if (org-agenda-use-sticky-p)
3650 (progn
3651 (put 'org-agenda-tag-filter :preset-filter nil)
3652 (put 'org-agenda-category-filter :preset-filter nil)
3653 (put 'org-agenda-regexp-filter :preset-filter nil)
3654 ;; Popup existing buffer
3655 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
3656 filter-alist)
3657 (message "Sticky Agenda buffer, use `r' to refresh")
3658 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3659 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3660 (setq org-todo-keywords-for-agenda nil)
3661 (put 'org-agenda-tag-filter :preset-filter
3662 org-agenda-tag-filter-preset)
3663 (put 'org-agenda-category-filter :preset-filter
3664 org-agenda-category-filter-preset)
3665 (put 'org-agenda-regexp-filter :preset-filter
3666 org-agenda-regexp-filter-preset)
3667 (put 'org-agenda-effort-filter :preset-filter
3668 org-agenda-effort-filter-preset)
3669 (if org-agenda-multi
3670 (progn
3671 (setq buffer-read-only nil)
3672 (goto-char (point-max))
3673 (unless (or (bobp) org-agenda-compact-blocks
3674 (not org-agenda-block-separator))
3675 (insert "\n"
3676 (if (stringp org-agenda-block-separator)
3677 org-agenda-block-separator
3678 (make-string (window-width) org-agenda-block-separator))
3679 "\n"))
3680 (narrow-to-region (point) (point-max)))
3681 (setq org-done-keywords-for-agenda nil)
3682 ;; Setting any org variables that are in org-agenda-local-vars
3683 ;; list need to be done after the prepare call
3684 (org-agenda-prepare-window
3685 (get-buffer-create org-agenda-buffer-name) filter-alist)
3686 (setq buffer-read-only nil)
3687 (org-agenda-reset-markers)
3688 (let ((inhibit-read-only t)) (erase-buffer))
3689 (org-agenda-mode)
3690 (setq org-agenda-buffer (current-buffer))
3691 (setq org-agenda-contributing-files nil)
3692 (setq org-agenda-columns-active nil)
3693 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3694 (setq org-todo-keywords-for-agenda
3695 (org-uniquify org-todo-keywords-for-agenda))
3696 (setq org-done-keywords-for-agenda
3697 (org-uniquify org-done-keywords-for-agenda))
3698 (setq org-agenda-last-prefix-arg current-prefix-arg)
3699 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3700 (and name (not org-agenda-name)
3701 (org-set-local 'org-agenda-name name)))
3702 (setq buffer-read-only nil))))
3704 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3705 (defun org-agenda-finalize ()
3706 "Finishing touch for the agenda buffer, called just before displaying it."
3707 (unless org-agenda-multi
3708 (save-excursion
3709 (let ((inhibit-read-only t))
3710 (goto-char (point-min))
3711 (save-excursion
3712 (while (org-activate-bracket-links (point-max))
3713 (add-text-properties (match-beginning 0) (match-end 0)
3714 '(face org-link))))
3715 (save-excursion
3716 (while (org-activate-plain-links (point-max))
3717 (add-text-properties (match-beginning 0) (match-end 0)
3718 '(face org-link))))
3719 (unless (eq org-agenda-remove-tags t)
3720 (org-agenda-align-tags))
3721 (unless org-agenda-with-colors
3722 (remove-text-properties (point-min) (point-max) '(face nil)))
3723 (if (and (boundp 'org-agenda-overriding-columns-format)
3724 org-agenda-overriding-columns-format)
3725 (org-set-local 'org-agenda-overriding-columns-format
3726 org-agenda-overriding-columns-format))
3727 (if (and (boundp 'org-agenda-view-columns-initially)
3728 org-agenda-view-columns-initially)
3729 (org-agenda-columns))
3730 (when org-agenda-fontify-priorities
3731 (org-agenda-fontify-priorities))
3732 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3733 (org-agenda-dim-blocked-tasks))
3734 (org-agenda-mark-clocking-task)
3735 (when org-agenda-entry-text-mode
3736 (org-agenda-entry-text-hide)
3737 (org-agenda-entry-text-show))
3738 (if (and (functionp 'org-habit-insert-consistency-graphs)
3739 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3740 (org-habit-insert-consistency-graphs))
3741 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3742 (unless (or (eq org-agenda-show-inherited-tags 'always)
3743 (and (listp org-agenda-show-inherited-tags)
3744 (memq org-agenda-type org-agenda-show-inherited-tags))
3745 (and (eq org-agenda-show-inherited-tags t)
3746 (or (eq org-agenda-use-tag-inheritance t)
3747 (and (listp org-agenda-use-tag-inheritance)
3748 (not (memq org-agenda-type
3749 org-agenda-use-tag-inheritance))))))
3750 (let (mrk)
3751 (save-excursion
3752 (goto-char (point-min))
3753 (while (equal (forward-line) 0)
3754 (when (setq mrk (get-text-property (point) 'org-hd-marker))
3755 (put-text-property (point-at-bol) (point-at-eol)
3756 'tags (org-with-point-at mrk
3757 (delete-dups
3758 (mapcar 'downcase (org-get-tags-at))))))))))
3759 (run-hooks 'org-agenda-finalize-hook)
3760 (when org-agenda-top-headline-filter
3761 (org-agenda-filter-top-headline-apply
3762 org-agenda-top-headline-filter))
3763 (when org-agenda-tag-filter
3764 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3765 (when (get 'org-agenda-tag-filter :preset-filter)
3766 (org-agenda-filter-apply
3767 (get 'org-agenda-tag-filter :preset-filter) 'tag))
3768 (when org-agenda-category-filter
3769 (org-agenda-filter-apply org-agenda-category-filter 'category))
3770 (when (get 'org-agenda-category-filter :preset-filter)
3771 (org-agenda-filter-apply
3772 (get 'org-agenda-category-filter :preset-filter) 'category))
3773 (when org-agenda-regexp-filter
3774 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3775 (when (get 'org-agenda-regexp-filter :preset-filter)
3776 (org-agenda-filter-apply
3777 (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
3778 (when org-agenda-effort-filter
3779 (org-agenda-filter-apply org-agenda-effort-filter 'effort))
3780 (when (get 'org-agenda-effort-filter :preset-filter)
3781 (org-agenda-filter-apply
3782 (get 'org-agenda-effort-filter :preset-filter) 'effort))
3783 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3785 (defun org-agenda-mark-clocking-task ()
3786 "Mark the current clock entry in the agenda if it is present."
3787 ;; We need to widen when `org-agenda-finalize' is called from
3788 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3789 (when org-clock-current-task
3790 (save-restriction
3791 (widen)
3792 (org-agenda-unmark-clocking-task)
3793 (when (marker-buffer org-clock-hd-marker)
3794 (save-excursion
3795 (goto-char (point-min))
3796 (let (s ov)
3797 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3798 (goto-char s)
3799 (when (equal (org-get-at-bol 'org-hd-marker)
3800 org-clock-hd-marker)
3801 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3802 (overlay-put ov 'type 'org-agenda-clocking)
3803 (overlay-put ov 'face 'org-agenda-clocking)
3804 (overlay-put ov 'help-echo
3805 "The clock is running in this item")))))))))
3807 (defun org-agenda-unmark-clocking-task ()
3808 "Unmark the current clocking task."
3809 (mapc (lambda (o)
3810 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3811 (delete-overlay o)))
3812 (overlays-in (point-min) (point-max))))
3814 (defun org-agenda-fontify-priorities ()
3815 "Make highest priority lines bold, and lowest italic."
3816 (interactive)
3817 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3818 (delete-overlay o)))
3819 (overlays-in (point-min) (point-max)))
3820 (save-excursion
3821 (let (b e p ov h l)
3822 (goto-char (point-min))
3823 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3824 (setq h (or (get-char-property (point) 'org-highest-priority)
3825 org-highest-priority)
3826 l (or (get-char-property (point) 'org-lowest-priority)
3827 org-lowest-priority)
3828 p (string-to-char (match-string 1))
3829 b (match-beginning 0)
3830 e (if (eq org-agenda-fontify-priorities 'cookies)
3831 (match-end 0)
3832 (point-at-eol))
3833 ov (make-overlay b e))
3834 (overlay-put
3835 ov 'face
3836 (cons (cond ((org-face-from-face-or-color
3837 'priority nil
3838 (cdr (assoc p org-priority-faces))))
3839 ((and (listp org-agenda-fontify-priorities)
3840 (org-face-from-face-or-color
3841 'priority nil
3842 (cdr (assoc p org-agenda-fontify-priorities)))))
3843 ((equal p l) 'italic)
3844 ((equal p h) 'bold))
3845 'org-priority))
3846 (overlay-put ov 'org-type 'org-priority)))))
3848 (defvar org-depend-tag-blocked)
3850 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3851 "Dim currently blocked TODO's in the agenda display.
3852 When INVISIBLE is non-nil, hide currently blocked TODO instead of
3853 dimming them."
3854 (interactive "P")
3855 (when (org-called-interactively-p 'interactive)
3856 (message "Dim or hide blocked tasks..."))
3857 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3858 (delete-overlay o)))
3859 (overlays-in (point-min) (point-max)))
3860 (save-excursion
3861 (let ((inhibit-read-only t)
3862 (org-depend-tag-blocked nil)
3863 (invis (or (not (null invisible))
3864 (eq org-agenda-dim-blocked-tasks 'invisible)))
3865 org-blocked-by-checkboxes
3866 invis1 b e p ov h l)
3867 (goto-char (point-min))
3868 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3869 (and pos (goto-char (1+ pos))))
3870 (setq org-blocked-by-checkboxes nil invis1 invis)
3871 (let ((marker (org-get-at-bol 'org-hd-marker)))
3872 (when (and marker
3873 (with-current-buffer (marker-buffer marker)
3874 (save-excursion (goto-char marker)
3875 (org-entry-blocked-p))))
3876 (if org-blocked-by-checkboxes (setq invis1 nil))
3877 (setq b (if invis1
3878 (max (point-min) (1- (point-at-bol)))
3879 (point-at-bol))
3880 e (point-at-eol)
3881 ov (make-overlay b e))
3882 (if invis1
3883 (progn (overlay-put ov 'invisible t)
3884 (overlay-put ov 'intangible t))
3885 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3886 (overlay-put ov 'org-type 'org-blocked-todo))))))
3887 (when (org-called-interactively-p 'interactive)
3888 (message "Dim or hide blocked tasks...done")))
3890 (defvar org-agenda-skip-function nil
3891 "Function to be called at each match during agenda construction.
3892 If this function returns nil, the current match should not be skipped.
3893 Otherwise, the function must return a position from where the search
3894 should be continued.
3895 This may also be a Lisp form, it will be evaluated.
3896 Never set this variable using `setq' or so, because then it will apply
3897 to all future agenda commands. If you do want a global skipping condition,
3898 use the option `org-agenda-skip-function-global' instead.
3899 The correct usage for `org-agenda-skip-function' is to bind it with
3900 `let' to scope it dynamically into the agenda-constructing command.
3901 A good way to set it is through options in `org-agenda-custom-commands'.")
3903 (defun org-agenda-skip ()
3904 "Throw to `:skip' in places that should be skipped.
3905 Also moves point to the end of the skipped region, so that search can
3906 continue from there."
3907 (let ((p (point-at-bol)) to)
3908 (when (or
3909 (save-excursion (goto-char p) (looking-at comment-start-skip))
3910 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3911 (get-text-property p :org-archived)
3912 (org-end-of-subtree t))
3913 (and org-agenda-skip-comment-trees
3914 (get-text-property p :org-comment)
3915 (org-end-of-subtree t))
3916 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3917 (org-agenda-skip-eval org-agenda-skip-function)))
3918 (goto-char to))
3919 (org-in-src-block-p t))
3920 (throw :skip t))))
3922 (defun org-agenda-skip-eval (form)
3923 "If FORM is a function or a list, call (or eval) it and return the result.
3924 `save-excursion' and `save-match-data' are wrapped around the call, so point
3925 and match data are returned to the previous state no matter what these
3926 functions do."
3927 (let (fp)
3928 (and form
3929 (or (setq fp (functionp form))
3930 (consp form))
3931 (save-excursion
3932 (save-match-data
3933 (if fp
3934 (funcall form)
3935 (eval form)))))))
3937 (defvar org-agenda-markers nil
3938 "List of all currently active markers created by `org-agenda'.")
3939 (defvar org-agenda-last-marker-time (org-float-time)
3940 "Creation time of the last agenda marker.")
3942 (defun org-agenda-new-marker (&optional pos)
3943 "Return a new agenda marker.
3944 Org-mode keeps a list of these markers and resets them when they are
3945 no longer in use."
3946 (let ((m (copy-marker (or pos (point)))))
3947 (setq org-agenda-last-marker-time (org-float-time))
3948 (if org-agenda-buffer
3949 (with-current-buffer org-agenda-buffer
3950 (push m org-agenda-markers))
3951 (push m org-agenda-markers))
3954 (defun org-agenda-reset-markers ()
3955 "Reset markers created by `org-agenda'."
3956 (while org-agenda-markers
3957 (move-marker (pop org-agenda-markers) nil)))
3959 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3960 "Save relative positions of markers in region.
3961 This check for agenda markers in all agenda buffers currently active."
3962 (dolist (buf (buffer-list))
3963 (with-current-buffer buf
3964 (when (eq major-mode 'org-agenda-mode)
3965 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3966 org-agenda-markers)))))
3968 ;;; Entry text mode
3970 (defun org-agenda-entry-text-show-here ()
3971 "Add some text from the entry as context to the current line."
3972 (let (m txt o)
3973 (setq m (org-get-at-bol 'org-hd-marker))
3974 (unless (marker-buffer m)
3975 (error "No marker points to an entry here"))
3976 (setq txt (concat "\n" (org-no-properties
3977 (org-agenda-get-some-entry-text
3978 m org-agenda-entry-text-maxlines
3979 org-agenda-entry-text-leaders))))
3980 (when (string-match "\\S-" txt)
3981 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3982 (overlay-put o 'evaporate t)
3983 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3984 (overlay-put o 'after-string txt))))
3986 (defun org-agenda-entry-text-show ()
3987 "Add entry context for all agenda lines."
3988 (interactive)
3989 (save-excursion
3990 (goto-char (point-max))
3991 (beginning-of-line 1)
3992 (while (not (bobp))
3993 (when (org-get-at-bol 'org-hd-marker)
3994 (org-agenda-entry-text-show-here))
3995 (beginning-of-line 0))))
3997 (defun org-agenda-entry-text-hide ()
3998 "Remove any shown entry context."
3999 (delq nil
4000 (mapcar (lambda (o)
4001 (if (eq (overlay-get o 'org-overlay-type)
4002 'agenda-entry-content)
4003 (progn (delete-overlay o) t)))
4004 (overlays-in (point-min) (point-max)))))
4006 (defun org-agenda-get-day-face (date)
4007 "Return the face DATE should be displayed with."
4008 (or (and (functionp org-agenda-day-face-function)
4009 (funcall org-agenda-day-face-function date))
4010 (cond ((org-agenda-todayp date)
4011 'org-agenda-date-today)
4012 ((member (calendar-day-of-week date) org-agenda-weekend-days)
4013 'org-agenda-date-weekend)
4014 (t 'org-agenda-date))))
4016 ;;; Agenda timeline
4018 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
4019 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
4021 (defun org-timeline (&optional dotodo)
4022 "Show a time-sorted view of the entries in the current org file.
4023 Only entries with a time stamp of today or later will be listed. With
4024 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
4025 under the current date.
4026 If the buffer contains an active region, only check the region for
4027 dates."
4028 (interactive "P")
4029 (let* ((dopast t)
4030 (org-agenda-show-log-scoped org-agenda-show-log)
4031 (org-agenda-show-log org-agenda-show-log-scoped)
4032 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
4033 (current-buffer))))
4034 (date (calendar-current-date))
4035 (beg (if (org-region-active-p) (region-beginning) (point-min)))
4036 (end (if (org-region-active-p) (region-end) (point-max)))
4037 (day-numbers (org-get-all-dates
4038 beg end 'no-ranges
4039 t org-agenda-show-log-scoped ; always include today
4040 org-timeline-show-empty-dates))
4041 (org-deadline-warning-days 0)
4042 (org-agenda-only-exact-dates t)
4043 (today (org-today))
4044 (past t)
4045 args
4046 s e rtn d emptyp)
4047 (setq org-agenda-redo-command
4048 (list 'let
4049 (list (list 'org-agenda-show-log 'org-agenda-show-log))
4050 (list 'org-switch-to-buffer-other-window (current-buffer))
4051 (list 'org-timeline (list 'quote dotodo))))
4052 (put 'org-agenda-redo-command 'org-lprops nil)
4053 (if (not dopast)
4054 ;; Remove past dates from the list of dates.
4055 (setq day-numbers (delq nil (mapcar (lambda(x)
4056 (if (>= x today) x nil))
4057 day-numbers))))
4058 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
4059 (org-compile-prefix-format 'timeline)
4060 (org-set-sorting-strategy 'timeline)
4061 (if org-agenda-show-log-scoped (push :closed args))
4062 (push :timestamp args)
4063 (push :deadline args)
4064 (push :scheduled args)
4065 (push :sexp args)
4066 (if dotodo (push :todo args))
4067 (insert "Timeline of file " entry "\n")
4068 (add-text-properties (point-min) (point)
4069 (list 'face 'org-agenda-structure))
4070 (org-agenda-mark-header-line (point-min))
4071 (while (setq d (pop day-numbers))
4072 (if (and (listp d) (eq (car d) :omitted))
4073 (progn
4074 (setq s (point))
4075 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4076 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4077 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4078 (if (and (>= d today)
4079 dopast
4080 past)
4081 (progn
4082 (setq past nil)
4083 (insert (make-string 79 ?-) "\n")))
4084 (setq date (calendar-gregorian-from-absolute d))
4085 (setq s (point))
4086 (setq rtn (and (not emptyp)
4087 (apply 'org-agenda-get-day-entries entry
4088 date args)))
4089 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4090 (progn
4091 (insert
4092 (if (stringp org-agenda-format-date)
4093 (format-time-string org-agenda-format-date
4094 (org-time-from-absolute date))
4095 (funcall org-agenda-format-date date))
4096 "\n")
4097 (put-text-property s (1- (point)) 'face
4098 (org-agenda-get-day-face date))
4099 (put-text-property s (1- (point)) 'org-date-line t)
4100 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4101 (if (equal d today)
4102 (put-text-property s (1- (point)) 'org-today t))
4103 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4104 (put-text-property s (1- (point)) 'day d)))))
4105 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4106 (point-min)))
4107 (add-text-properties
4108 (point-min) (point-max)
4109 `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
4110 (org-agenda-finalize)
4111 (setq buffer-read-only t)))
4113 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4114 "Return a list of all relevant day numbers from BEG to END buffer positions.
4115 If NO-RANGES is non-nil, include only the start and end dates of a range,
4116 not every single day in the range. If FORCE-TODAY is non-nil, make
4117 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4118 inactive time stamps (those in square brackets) are included.
4119 When EMPTY is non-nil, also include days without any entries."
4120 (let ((re (concat
4121 (if pre-re pre-re "")
4122 (if inactive org-ts-regexp-both org-ts-regexp)))
4123 dates dates1 date day day1 day2 ts1 ts2 pos)
4124 (if force-today
4125 (setq dates (list (org-today))))
4126 (save-excursion
4127 (goto-char beg)
4128 (while (re-search-forward re end t)
4129 (setq day (time-to-days (org-time-string-to-time
4130 (substring (match-string 1) 0 10)
4131 (current-buffer) (match-beginning 0))))
4132 (or (memq day dates) (push day dates)))
4133 (unless no-ranges
4134 (goto-char beg)
4135 (while (re-search-forward org-tr-regexp end t)
4136 (setq pos (match-beginning 0))
4137 (setq ts1 (substring (match-string 1) 0 10)
4138 ts2 (substring (match-string 2) 0 10)
4139 day1 (time-to-days (org-time-string-to-time
4140 ts1 (current-buffer) pos))
4141 day2 (time-to-days (org-time-string-to-time
4142 ts2 (current-buffer) pos)))
4143 (while (< (setq day1 (1+ day1)) day2)
4144 (or (memq day1 dates) (push day1 dates)))))
4145 (setq dates (sort dates '<))
4146 (when empty
4147 (while (setq day (pop dates))
4148 (setq day2 (car dates))
4149 (push day dates1)
4150 (when (and day2 empty)
4151 (if (or (eq empty t)
4152 (and (numberp empty) (<= (- day2 day) empty)))
4153 (while (< (setq day (1+ day)) day2)
4154 (push (list day) dates1))
4155 (push (cons :omitted (- day2 day)) dates1))))
4156 (setq dates (nreverse dates1)))
4157 dates)))
4159 ;;; Agenda Daily/Weekly
4161 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4162 "Start day for the agenda view.
4163 Custom commands can set this variable in the options section.
4164 This is usually a string like \"2007-11-01\", \"+2d\" or any other
4165 input allowed when reading a date through the Org calendar.
4166 See the docstring of `org-read-date' for details.")
4167 (defvar org-starting-day nil) ; local variable in the agenda buffer
4168 (defvar org-arg-loc nil) ; local variable
4170 (defvar org-agenda-buffer-tmp-name nil)
4171 ;;;###autoload
4172 (defun org-agenda-list (&optional arg start-day span with-hour)
4173 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4174 The view will be for the current day or week, but from the overview buffer
4175 you will be able to go to other days/weeks.
4177 With a numeric prefix argument in an interactive call, the agenda will
4178 span ARG days. Lisp programs should instead specify SPAN to change
4179 the number of days. SPAN defaults to `org-agenda-span'.
4181 START-DAY defaults to TODAY, or to the most recent match for the weekday
4182 given in `org-agenda-start-on-weekday'.
4184 When WITH-HOUR is non-nil, only include scheduled and deadline
4185 items if they have an hour specification like [h]h:mm."
4186 (interactive "P")
4187 (if org-agenda-overriding-arguments
4188 (setq arg (car org-agenda-overriding-arguments)
4189 start-day (nth 1 org-agenda-overriding-arguments)
4190 span (nth 2 org-agenda-overriding-arguments)))
4191 (if (and (integerp arg) (> arg 0))
4192 (setq span arg arg nil))
4193 (catch 'exit
4194 (setq org-agenda-buffer-name
4195 (or org-agenda-buffer-tmp-name
4196 (if org-agenda-sticky
4197 (cond ((and org-keys (stringp org-match))
4198 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4199 (org-keys
4200 (format "*Org Agenda(%s)*" org-keys))
4201 (t "*Org Agenda(a)*")))
4202 org-agenda-buffer-name))
4203 (org-agenda-prepare "Day/Week")
4204 (setq start-day (or start-day org-agenda-start-day))
4205 (if (stringp start-day)
4206 ;; Convert to an absolute day number
4207 (setq start-day (time-to-days (org-read-date nil t start-day))))
4208 (org-compile-prefix-format 'agenda)
4209 (org-set-sorting-strategy 'agenda)
4210 (let* ((span (org-agenda-ndays-to-span
4211 (or span org-agenda-ndays org-agenda-span)))
4212 (today (org-today))
4213 (sd (or start-day today))
4214 (ndays (org-agenda-span-to-ndays span sd))
4215 (org-agenda-start-on-weekday
4216 (if (or (eq ndays 7) (eq ndays 14))
4217 org-agenda-start-on-weekday))
4218 (thefiles (org-agenda-files nil 'ifmode))
4219 (files thefiles)
4220 (start (if (or (null org-agenda-start-on-weekday)
4221 (< ndays 7))
4223 (let* ((nt (calendar-day-of-week
4224 (calendar-gregorian-from-absolute sd)))
4225 (n1 org-agenda-start-on-weekday)
4226 (d (- nt n1)))
4227 (- sd (+ (if (< d 0) 7 0) d)))))
4228 (day-numbers (list start))
4229 (day-cnt 0)
4230 (inhibit-redisplay (not debug-on-error))
4231 (org-agenda-show-log-scoped org-agenda-show-log)
4232 s e rtn rtnall file date d start-pos end-pos todayp
4233 clocktable-start clocktable-end filter)
4234 (setq org-agenda-redo-command
4235 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4236 (dotimes (n (1- ndays))
4237 (push (1+ (car day-numbers)) day-numbers))
4238 (setq day-numbers (nreverse day-numbers))
4239 (setq clocktable-start (car day-numbers)
4240 clocktable-end (1+ (or (org-last day-numbers) 0)))
4241 (org-set-local 'org-starting-day (car day-numbers))
4242 (org-set-local 'org-arg-loc arg)
4243 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
4244 (unless org-agenda-compact-blocks
4245 (let* ((d1 (car day-numbers))
4246 (d2 (org-last day-numbers))
4247 (w1 (org-days-to-iso-week d1))
4248 (w2 (org-days-to-iso-week d2)))
4249 (setq s (point))
4250 (if org-agenda-overriding-header
4251 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4252 nil 'face 'org-agenda-structure) "\n")
4253 (insert (org-agenda-span-name span)
4254 "-agenda"
4255 (if (< (- d2 d1) 350)
4256 (if (= w1 w2)
4257 (format " (W%02d)" w1)
4258 (format " (W%02d-W%02d)" w1 w2))
4260 ":\n")))
4261 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4262 'org-date-line t))
4263 (org-agenda-mark-header-line s))
4264 (while (setq d (pop day-numbers))
4265 (setq date (calendar-gregorian-from-absolute d)
4266 s (point))
4267 (if (or (setq todayp (= d today))
4268 (and (not start-pos) (= d sd)))
4269 (setq start-pos (point))
4270 (if (and start-pos (not end-pos))
4271 (setq end-pos (point))))
4272 (setq files thefiles
4273 rtnall nil)
4274 (while (setq file (pop files))
4275 (catch 'nextfile
4276 (org-check-agenda-file file)
4277 (let ((org-agenda-entry-types org-agenda-entry-types))
4278 ;; Starred types override non-starred equivalents
4279 (when (member :deadline* org-agenda-entry-types)
4280 (setq org-agenda-entry-types
4281 (delq :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 ;; Honor with-hour
4286 (when with-hour
4287 (when (member :deadline org-agenda-entry-types)
4288 (setq org-agenda-entry-types
4289 (delq :deadline org-agenda-entry-types))
4290 (push :deadline* org-agenda-entry-types))
4291 (when (member :scheduled org-agenda-entry-types)
4292 (setq org-agenda-entry-types
4293 (delq :scheduled org-agenda-entry-types))
4294 (push :scheduled* org-agenda-entry-types)))
4295 (unless org-agenda-include-deadlines
4296 (setq org-agenda-entry-types
4297 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4298 (cond
4299 ((memq org-agenda-show-log-scoped '(only clockcheck))
4300 (setq rtn (org-agenda-get-day-entries
4301 file date :closed)))
4302 (org-agenda-show-log-scoped
4303 (setq rtn (apply 'org-agenda-get-day-entries
4304 file date
4305 (append '(:closed) org-agenda-entry-types))))
4307 (setq rtn (apply 'org-agenda-get-day-entries
4308 file date
4309 org-agenda-entry-types)))))
4310 (setq rtnall (append rtnall rtn)))) ;; all entries
4311 (if org-agenda-include-diary
4312 (let ((org-agenda-search-headline-for-time t))
4313 (require 'diary-lib)
4314 (setq rtn (org-get-entries-from-diary date))
4315 (setq rtnall (append rtnall rtn))))
4316 (if (or rtnall org-agenda-show-all-dates)
4317 (progn
4318 (setq day-cnt (1+ day-cnt))
4319 (insert
4320 (if (stringp org-agenda-format-date)
4321 (format-time-string org-agenda-format-date
4322 (org-time-from-absolute date))
4323 (funcall org-agenda-format-date date))
4324 "\n")
4325 (put-text-property s (1- (point)) 'face
4326 (org-agenda-get-day-face date))
4327 (put-text-property s (1- (point)) 'org-date-line t)
4328 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4329 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4330 (when todayp
4331 (put-text-property s (1- (point)) 'org-today t))
4332 (setq rtnall
4333 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4334 (if rtnall (insert ;; all entries
4335 (org-agenda-finalize-entries rtnall 'agenda)
4336 "\n"))
4337 (put-text-property s (1- (point)) 'day d)
4338 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4339 (when (and org-agenda-clockreport-mode clocktable-start)
4340 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4341 ;; the above line is to ensure the restricted range!
4342 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4343 tbl)
4344 (setq p (org-plist-delete p :block))
4345 (setq p (plist-put p :tstart clocktable-start))
4346 (setq p (plist-put p :tend clocktable-end))
4347 (setq p (plist-put p :scope 'agenda))
4348 (setq tbl (apply 'org-clock-get-clocktable p))
4349 (insert tbl)))
4350 (goto-char (point-min))
4351 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4352 (unless (and (pos-visible-in-window-p (point-min))
4353 (pos-visible-in-window-p (point-max)))
4354 (goto-char (1- (point-max)))
4355 (recenter -1)
4356 (if (not (pos-visible-in-window-p (or start-pos 1)))
4357 (progn
4358 (goto-char (or start-pos 1))
4359 (recenter 1))))
4360 (goto-char (or start-pos 1))
4361 (add-text-properties (point-min) (point-max)
4362 `(org-agenda-type agenda
4363 org-last-args (,arg ,start-day ,span)
4364 org-redo-cmd ,org-agenda-redo-command
4365 org-series-cmd ,org-cmd))
4366 (if (eq org-agenda-show-log-scoped 'clockcheck)
4367 (org-agenda-show-clocking-issues))
4368 (org-agenda-finalize)
4369 (setq buffer-read-only t)
4370 (message ""))))
4372 (defun org-agenda-ndays-to-span (n)
4373 "Return a span symbol for a span of N days, or N if none matches."
4374 (cond ((symbolp n) n)
4375 ((= n 1) 'day)
4376 ((= n 7) 'week)
4377 ((= n 14) 'fortnight)
4378 (t n)))
4380 (defun org-agenda-span-to-ndays (span &optional start-day)
4381 "Return ndays from SPAN, possibly starting at START-DAY.
4382 START-DAY is an absolute time value."
4383 (cond ((numberp span) span)
4384 ((eq span 'day) 1)
4385 ((eq span 'week) 7)
4386 ((eq span 'fortnight) 14)
4387 ((eq span 'month)
4388 (let ((date (calendar-gregorian-from-absolute start-day)))
4389 (calendar-last-day-of-month (car date) (caddr date))))
4390 ((eq span 'year)
4391 (let ((date (calendar-gregorian-from-absolute start-day)))
4392 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4394 (defun org-agenda-span-name (span)
4395 "Return a SPAN name."
4396 (if (null span)
4398 (if (symbolp span)
4399 (capitalize (symbol-name span))
4400 (format "%d days" span))))
4402 ;;; Agenda word search
4404 (defvar org-agenda-search-history nil)
4406 (defvar org-search-syntax-table nil
4407 "Special syntax table for org-mode search.
4408 In this table, we have single quotes not as word constituents, to
4409 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4411 (defvar org-mode-syntax-table) ; From org.el
4412 (defun org-search-syntax-table ()
4413 (unless org-search-syntax-table
4414 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4415 (modify-syntax-entry ?' "." org-search-syntax-table)
4416 (modify-syntax-entry ?` "." org-search-syntax-table))
4417 org-search-syntax-table)
4419 (defvar org-agenda-last-search-view-search-was-boolean nil)
4421 ;;;###autoload
4422 (defun org-search-view (&optional todo-only string edit-at)
4423 "Show all entries that contain a phrase or words or regular expressions.
4425 With optional prefix argument TODO-ONLY, only consider entries that are
4426 TODO entries. The argument STRING can be used to pass a default search
4427 string into this function. If EDIT-AT is non-nil, it means that the
4428 user should get a chance to edit this string, with cursor at position
4429 EDIT-AT.
4431 The search string can be viewed either as a phrase that should be found as
4432 is, or it can be broken into a number of snippets, each of which must match
4433 in a Boolean way to select an entry. The default depends on the variable
4434 `org-agenda-search-view-always-boolean'.
4435 Even if this is turned off (the default) you can always switch to
4436 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4438 The default is a direct search of the whole phrase, where each space in
4439 the search string can expand to an arbitrary amount of whitespace,
4440 including newlines.
4442 If using a Boolean search, the search string is split on whitespace and
4443 each snippet is searched separately, with logical AND to select an entry.
4444 Words prefixed with a minus must *not* occur in the entry. Words without
4445 a prefix or prefixed with a plus must occur in the entry. Matching is
4446 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4447 match whole words, not parts of a word) if
4448 `org-agenda-search-view-force-full-words' is set (default is nil).
4450 Boolean search snippets enclosed by curly braces are interpreted as
4451 regular expressions that must or (when preceded with \"-\") must not
4452 match in the entry. Snippets enclosed into double quotes will be taken
4453 as a whole, to include whitespace.
4455 - If the search string starts with an asterisk, search only in headlines.
4456 - If (possibly after the leading star) the search string starts with an
4457 exclamation mark, this also means to look at TODO entries only, an effect
4458 that can also be achieved with a prefix argument.
4459 - If (possibly after star and exclamation mark) the search string starts
4460 with a colon, this will mean that the (non-regexp) snippets of the
4461 Boolean search must match as full words.
4463 This command searches the agenda files, and in addition the files listed
4464 in `org-agenda-text-search-extra-files'."
4465 (interactive "P")
4466 (if org-agenda-overriding-arguments
4467 (setq todo-only (car org-agenda-overriding-arguments)
4468 string (nth 1 org-agenda-overriding-arguments)
4469 edit-at (nth 2 org-agenda-overriding-arguments)))
4470 (let* ((props (list 'face nil
4471 'done-face 'org-agenda-done
4472 'org-not-done-regexp org-not-done-regexp
4473 'org-todo-regexp org-todo-regexp
4474 'org-complex-heading-regexp org-complex-heading-regexp
4475 'mouse-face 'highlight
4476 'help-echo (format "mouse-2 or RET jump to location")))
4477 (full-words org-agenda-search-view-force-full-words)
4478 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4479 regexp rtn rtnall files file pos inherited-tags
4480 marker category level tags c neg re boolean
4481 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4482 (unless (and (not edit-at)
4483 (stringp string)
4484 (string-match "\\S-" string))
4485 (setq string (read-string
4486 (if org-agenda-search-view-always-boolean
4487 "[+-]Word/{Regexp} ...: "
4488 "Phrase or [+-]Word/{Regexp} ...: ")
4489 (cond
4490 ((integerp edit-at) (cons string edit-at))
4491 (edit-at string))
4492 'org-agenda-search-history)))
4493 (catch 'exit
4494 (if org-agenda-sticky
4495 (setq org-agenda-buffer-name
4496 (if (stringp string)
4497 (format "*Org Agenda(%s:%s)*"
4498 (or org-keys (or (and todo-only "S") "s")) string)
4499 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4500 (org-agenda-prepare "SEARCH")
4501 (org-compile-prefix-format 'search)
4502 (org-set-sorting-strategy 'search)
4503 (setq org-agenda-redo-command
4504 (list 'org-search-view (if todo-only t nil)
4505 (list 'if 'current-prefix-arg nil string)))
4506 (setq org-agenda-query-string string)
4507 (if (equal (string-to-char string) ?*)
4508 (setq hdl-only t
4509 words (substring string 1))
4510 (setq words string))
4511 (when (equal (string-to-char words) ?!)
4512 (setq todo-only t
4513 words (substring words 1)))
4514 (when (equal (string-to-char words) ?:)
4515 (setq full-words t
4516 words (substring words 1)))
4517 (if (or org-agenda-search-view-always-boolean
4518 (member (string-to-char words) '(?- ?+ ?\{)))
4519 (setq boolean t))
4520 (setq words (org-split-string words))
4521 (let (www w)
4522 (while (setq w (pop words))
4523 (while (and (string-match "\\\\\\'" w) words)
4524 (setq w (concat (substring w 0 -1) " " (pop words))))
4525 (push w www))
4526 (setq words (nreverse www) www nil)
4527 (while (setq w (pop words))
4528 (when (and (string-match "\\`[-+]?{" w)
4529 (not (string-match "}\\'" w)))
4530 (while (and words (not (string-match "}\\'" (car words))))
4531 (setq w (concat w " " (pop words))))
4532 (setq w (concat w " " (pop words))))
4533 (push w www))
4534 (setq words (nreverse www)))
4535 (setq org-agenda-last-search-view-search-was-boolean boolean)
4536 (when boolean
4537 (let (wds w)
4538 (while (setq w (pop words))
4539 (if (or (equal (substring w 0 1) "\"")
4540 (and (> (length w) 1)
4541 (member (substring w 0 1) '("+" "-"))
4542 (equal (substring w 1 2) "\"")))
4543 (while (and words (not (equal (substring w -1) "\"")))
4544 (setq w (concat w " " (pop words)))))
4545 (and (string-match "\\`\\([-+]?\\)\"" w)
4546 (setq w (replace-match "\\1" nil nil w)))
4547 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4548 (push w wds))
4549 (setq words (nreverse wds))))
4550 (if boolean
4551 (mapc (lambda (w)
4552 (setq c (string-to-char w))
4553 (if (equal c ?-)
4554 (setq neg t w (substring w 1))
4555 (if (equal c ?+)
4556 (setq neg nil w (substring w 1))
4557 (setq neg nil)))
4558 (if (string-match "\\`{.*}\\'" w)
4559 (setq re (substring w 1 -1))
4560 (if full-words
4561 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4562 (setq re (regexp-quote (downcase w)))))
4563 (if neg (push re regexps-) (push re regexps+)))
4564 words)
4565 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4566 regexps+))
4567 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4568 (if (not regexps+)
4569 (setq regexp org-outline-regexp-bol)
4570 (setq regexp (pop regexps+))
4571 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4572 regexp))))
4573 (setq files (org-agenda-files nil 'ifmode))
4574 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4575 (pop org-agenda-text-search-extra-files)
4576 (setq files (org-add-archive-files files)))
4577 (setq files (append files org-agenda-text-search-extra-files)
4578 rtnall nil)
4579 (while (setq file (pop files))
4580 (setq ee nil)
4581 (catch 'nextfile
4582 (org-check-agenda-file file)
4583 (setq buffer (if (file-exists-p file)
4584 (org-get-agenda-file-buffer file)
4585 (error "No such file %s" file)))
4586 (if (not buffer)
4587 ;; If file does not exist, make sure an error message is sent
4588 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4589 file))))
4590 (with-current-buffer buffer
4591 (with-syntax-table (org-search-syntax-table)
4592 (unless (derived-mode-p 'org-mode)
4593 (error "Agenda file %s is not in `org-mode'" file))
4594 (let ((case-fold-search t))
4595 (save-excursion
4596 (save-restriction
4597 (if (eq buffer org-agenda-restrict)
4598 (narrow-to-region org-agenda-restrict-begin
4599 org-agenda-restrict-end)
4600 (widen))
4601 (goto-char (point-min))
4602 (unless (or (org-at-heading-p)
4603 (outline-next-heading))
4604 (throw 'nextfile t))
4605 (goto-char (max (point-min) (1- (point))))
4606 (while (re-search-forward regexp nil t)
4607 (org-back-to-heading t)
4608 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4609 (> (org-reduced-level (org-outline-level))
4610 org-agenda-search-view-max-outline-level)
4611 (forward-line -1)
4612 (outline-back-to-heading t)))
4613 (skip-chars-forward "* ")
4614 (setq beg (point-at-bol)
4615 beg1 (point)
4616 end (progn
4617 (outline-next-heading)
4618 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4619 (> (org-reduced-level (org-outline-level))
4620 org-agenda-search-view-max-outline-level)
4621 (forward-line 1)
4622 (outline-next-heading)))
4623 (point)))
4625 (catch :skip
4626 (goto-char beg)
4627 (org-agenda-skip)
4628 (setq str (buffer-substring-no-properties
4629 (point-at-bol)
4630 (if hdl-only (point-at-eol) end)))
4631 (mapc (lambda (wr) (when (string-match wr str)
4632 (goto-char (1- end))
4633 (throw :skip t)))
4634 regexps-)
4635 (mapc (lambda (wr) (unless (string-match wr str)
4636 (goto-char (1- end))
4637 (throw :skip t)))
4638 (if todo-only
4639 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4640 regexps+)
4641 regexps+))
4642 (goto-char beg)
4643 (setq marker (org-agenda-new-marker (point))
4644 category (org-get-category)
4645 level (make-string (org-reduced-level (org-outline-level)) ? )
4646 inherited-tags
4647 (or (eq org-agenda-show-inherited-tags 'always)
4648 (and (listp org-agenda-show-inherited-tags)
4649 (memq 'todo org-agenda-show-inherited-tags))
4650 (and (eq org-agenda-show-inherited-tags t)
4651 (or (eq org-agenda-use-tag-inheritance t)
4652 (memq 'todo org-agenda-use-tag-inheritance))))
4653 tags (org-get-tags-at nil (not inherited-tags))
4654 txt (org-agenda-format-item
4656 (buffer-substring-no-properties
4657 beg1 (point-at-eol))
4658 level category tags t))
4659 (org-add-props txt props
4660 'org-marker marker 'org-hd-marker marker
4661 'org-todo-regexp org-todo-regexp
4662 'level level
4663 'org-complex-heading-regexp org-complex-heading-regexp
4664 'priority 1000
4665 'type "search")
4666 (push txt ee)
4667 (goto-char (1- end))))))))))
4668 (setq rtn (nreverse ee))
4669 (setq rtnall (append rtnall rtn)))
4670 (if org-agenda-overriding-header
4671 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4672 nil 'face 'org-agenda-structure) "\n")
4673 (insert "Search words: ")
4674 (add-text-properties (point-min) (1- (point))
4675 (list 'face 'org-agenda-structure))
4676 (setq pos (point))
4677 (insert string "\n")
4678 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4679 (setq pos (point))
4680 (unless org-agenda-multi
4681 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4682 (add-text-properties pos (1- (point))
4683 (list 'face 'org-agenda-structure))))
4684 (org-agenda-mark-header-line (point-min))
4685 (when rtnall
4686 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4687 (goto-char (point-min))
4688 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4689 (add-text-properties (point-min) (point-max)
4690 `(org-agenda-type search
4691 org-last-args (,todo-only ,string ,edit-at)
4692 org-redo-cmd ,org-agenda-redo-command
4693 org-series-cmd ,org-cmd))
4694 (org-agenda-finalize)
4695 (setq buffer-read-only t))))
4697 ;;; Agenda TODO list
4699 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4700 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4701 (concat
4702 (if (or (equal keywords "ALL") (not keywords))
4703 (propertize "ALL" 'face 'warning)
4704 (mapconcat
4705 (lambda (kw)
4706 (propertize kw 'face (org-get-todo-face kw)))
4707 (org-split-string keywords "|")
4708 "|"))
4709 "\n"))
4711 (defvar org-select-this-todo-keyword nil)
4712 (defvar org-last-arg nil)
4714 ;;;###autoload
4715 (defun org-todo-list (&optional arg)
4716 "Show all (not done) TODO entries from all agenda file in a single list.
4717 The prefix arg can be used to select a specific TODO keyword and limit
4718 the list to these. When using \\[universal-argument], you will be prompted
4719 for a keyword. A numeric prefix directly selects the Nth keyword in
4720 `org-todo-keywords-1'."
4721 (interactive "P")
4722 (if org-agenda-overriding-arguments
4723 (setq arg org-agenda-overriding-arguments))
4724 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4725 (let* ((today (org-today))
4726 (date (calendar-gregorian-from-absolute today))
4727 (kwds org-todo-keywords-for-agenda)
4728 (completion-ignore-case t)
4729 (org-select-this-todo-keyword
4730 (if (stringp arg) arg
4731 (and arg (integerp arg) (> arg 0)
4732 (nth (1- arg) kwds))))
4733 rtn rtnall files file pos)
4734 (when (equal arg '(4))
4735 (setq org-select-this-todo-keyword
4736 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4737 (mapcar 'list kwds) nil nil)))
4738 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4739 (catch 'exit
4740 (if org-agenda-sticky
4741 (setq org-agenda-buffer-name
4742 (if (stringp org-select-this-todo-keyword)
4743 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4744 org-select-this-todo-keyword)
4745 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4746 (org-agenda-prepare "TODO")
4747 (org-compile-prefix-format 'todo)
4748 (org-set-sorting-strategy 'todo)
4749 (setq org-agenda-redo-command
4750 `(org-todo-list (or (and (numberp current-prefix-arg)
4751 current-prefix-arg)
4752 ,org-select-this-todo-keyword
4753 current-prefix-arg ,arg)))
4754 (setq files (org-agenda-files nil 'ifmode)
4755 rtnall nil)
4756 (while (setq file (pop files))
4757 (catch 'nextfile
4758 (org-check-agenda-file file)
4759 (setq rtn (org-agenda-get-day-entries file date :todo))
4760 (setq rtnall (append rtnall rtn))))
4761 (if org-agenda-overriding-header
4762 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4763 nil 'face 'org-agenda-structure) "\n")
4764 (insert "Global list of TODO items of type: ")
4765 (add-text-properties (point-min) (1- (point))
4766 (list 'face 'org-agenda-structure
4767 'short-heading
4768 (concat "ToDo: "
4769 (or org-select-this-todo-keyword "ALL"))))
4770 (org-agenda-mark-header-line (point-min))
4771 (insert (org-agenda-propertize-selected-todo-keywords
4772 org-select-this-todo-keyword))
4773 (setq pos (point))
4774 (unless org-agenda-multi
4775 (insert "Available with `N r': (0)[ALL]")
4776 (let ((n 0) s)
4777 (mapc (lambda (x)
4778 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4779 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4780 (insert "\n "))
4781 (insert " " s))
4782 kwds))
4783 (insert "\n"))
4784 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4785 (org-agenda-mark-header-line (point-min))
4786 (when rtnall
4787 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4788 (goto-char (point-min))
4789 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4790 (add-text-properties (point-min) (point-max)
4791 `(org-agenda-type todo
4792 org-last-args ,arg
4793 org-redo-cmd ,org-agenda-redo-command
4794 org-series-cmd ,org-cmd))
4795 (org-agenda-finalize)
4796 (setq buffer-read-only t))))
4798 ;;; Agenda tags match
4800 ;;;###autoload
4801 (defun org-tags-view (&optional todo-only match)
4802 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4803 The prefix arg TODO-ONLY limits the search to TODO entries."
4804 (interactive "P")
4805 (if org-agenda-overriding-arguments
4806 (setq todo-only (car org-agenda-overriding-arguments)
4807 match (nth 1 org-agenda-overriding-arguments)))
4808 (let* ((org-tags-match-list-sublevels
4809 org-tags-match-list-sublevels)
4810 (completion-ignore-case t)
4811 rtn rtnall files file pos matcher
4812 buffer)
4813 (when (and (stringp match) (not (string-match "\\S-" match)))
4814 (setq match nil))
4815 (catch 'exit
4816 (if org-agenda-sticky
4817 (setq org-agenda-buffer-name
4818 (if (stringp match)
4819 (format "*Org Agenda(%s:%s)*"
4820 (or org-keys (or (and todo-only "M") "m")) match)
4821 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4822 ;; Prepare agendas (and `org-tag-alist-for-agenda') before
4823 ;; expanding tags within `org-make-tags-matcher'
4824 (org-agenda-prepare (concat "TAGS " match))
4825 (setq matcher (org-make-tags-matcher match)
4826 match (car matcher) matcher (cdr matcher))
4827 (org-compile-prefix-format 'tags)
4828 (org-set-sorting-strategy 'tags)
4829 (setq org-agenda-query-string match)
4830 (setq org-agenda-redo-command
4831 (list 'org-tags-view `(quote ,todo-only)
4832 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4833 (setq files (org-agenda-files nil 'ifmode)
4834 rtnall nil)
4835 (while (setq file (pop files))
4836 (catch 'nextfile
4837 (org-check-agenda-file file)
4838 (setq buffer (if (file-exists-p file)
4839 (org-get-agenda-file-buffer file)
4840 (error "No such file %s" file)))
4841 (if (not buffer)
4842 ;; If file does not exist, error message to agenda
4843 (setq rtn (list
4844 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4845 rtnall (append rtnall rtn))
4846 (with-current-buffer buffer
4847 (unless (derived-mode-p 'org-mode)
4848 (error "Agenda file %s is not in `org-mode'" file))
4849 (save-excursion
4850 (save-restriction
4851 (if (eq buffer org-agenda-restrict)
4852 (narrow-to-region org-agenda-restrict-begin
4853 org-agenda-restrict-end)
4854 (widen))
4855 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4856 (setq rtnall (append rtnall rtn))))))))
4857 (if org-agenda-overriding-header
4858 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4859 nil 'face 'org-agenda-structure) "\n")
4860 (insert "Headlines with TAGS match: ")
4861 (add-text-properties (point-min) (1- (point))
4862 (list 'face 'org-agenda-structure
4863 'short-heading
4864 (concat "Match: " match)))
4865 (setq pos (point))
4866 (insert match "\n")
4867 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4868 (setq pos (point))
4869 (unless org-agenda-multi
4870 (insert "Press `C-u r' to search again with new search string\n"))
4871 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4872 (org-agenda-mark-header-line (point-min))
4873 (when rtnall
4874 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4875 (goto-char (point-min))
4876 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4877 (add-text-properties (point-min) (point-max)
4878 `(org-agenda-type tags
4879 org-last-args (,todo-only ,match)
4880 org-redo-cmd ,org-agenda-redo-command
4881 org-series-cmd ,org-cmd))
4882 (org-agenda-finalize)
4883 (setq buffer-read-only t))))
4885 ;;; Agenda Finding stuck projects
4887 (defvar org-agenda-skip-regexp nil
4888 "Regular expression used in skipping subtrees for the agenda.
4889 This is basically a temporary global variable that can be set and then
4890 used by user-defined selections using `org-agenda-skip-function'.")
4892 (defvar org-agenda-overriding-header nil
4893 "When set during agenda, todo and tags searches it replaces the header.
4894 This variable should not be set directly, but custom commands can bind it
4895 in the options section.")
4897 (defun org-agenda-skip-entry-when-regexp-matches ()
4898 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4899 If yes, it returns the end position of this entry, causing agenda commands
4900 to skip the entry but continuing the search in the subtree. This is a
4901 function that can be put into `org-agenda-skip-function' for the duration
4902 of a command."
4903 (let ((end (save-excursion (org-end-of-subtree t)))
4904 skip)
4905 (save-excursion
4906 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4907 (and skip end)))
4909 (defun org-agenda-skip-subtree-when-regexp-matches ()
4910 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4911 If yes, it returns the end position of this tree, causing agenda commands
4912 to skip this subtree. This is a function that can be put into
4913 `org-agenda-skip-function' for the duration of a command."
4914 (let ((end (save-excursion (org-end-of-subtree t)))
4915 skip)
4916 (save-excursion
4917 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4918 (and skip end)))
4920 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4921 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4922 If yes, it returns the end position of the current entry (NOT the tree),
4923 causing agenda commands to skip the entry but continuing the search in
4924 the subtree. This is a function that can be put into
4925 `org-agenda-skip-function' for the duration of a command. An important
4926 use of this function is for the stuck project list."
4927 (let ((end (save-excursion (org-end-of-subtree t)))
4928 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4929 skip)
4930 (save-excursion
4931 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4932 (and skip entry-end)))
4934 (defun org-agenda-skip-entry-if (&rest conditions)
4935 "Skip entry if any of CONDITIONS is true.
4936 See `org-agenda-skip-if' for details."
4937 (org-agenda-skip-if nil conditions))
4939 (defun org-agenda-skip-subtree-if (&rest conditions)
4940 "Skip subtree if any of CONDITIONS is true.
4941 See `org-agenda-skip-if' for details."
4942 (org-agenda-skip-if t conditions))
4944 (defun org-agenda-skip-if (subtree conditions)
4945 "Checks current entity for CONDITIONS.
4946 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4947 the entry (i.e. the text before the next heading) is checked.
4949 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4950 from different tests. Valid conditions are:
4952 scheduled Check if there is a scheduled cookie
4953 notscheduled Check if there is no scheduled cookie
4954 deadline Check if there is a deadline
4955 notdeadline Check if there is no deadline
4956 timestamp Check if there is a timestamp (also deadline or scheduled)
4957 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4958 regexp Check if regexp matches
4959 notregexp Check if regexp does not match.
4960 todo Check if TODO keyword matches
4961 nottodo Check if TODO keyword does not match
4963 The regexp is taken from the conditions list, it must come right after
4964 the `regexp' or `notregexp' element.
4966 `todo' and `nottodo' accept as an argument a list of todo
4967 keywords, which may include \"*\" to match any todo keyword.
4969 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4971 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4973 Instead of a list, a keyword class may be given. For example:
4975 (org-agenda-skip-entry-if 'nottodo 'done)
4977 would skip entries that haven't been marked with any of \"DONE\"
4978 keywords. Possible classes are: `todo', `done', `any'.
4980 If any of these conditions is met, this function returns the end point of
4981 the entity, causing the search to continue from there. This is a function
4982 that can be put into `org-agenda-skip-function' for the duration of a command."
4983 (let (beg end m)
4984 (org-back-to-heading t)
4985 (setq beg (point)
4986 end (if subtree
4987 (progn (org-end-of-subtree t) (point))
4988 (progn (outline-next-heading) (1- (point)))))
4989 (goto-char beg)
4990 (and
4992 (and (memq 'scheduled conditions)
4993 (re-search-forward org-scheduled-time-regexp end t))
4994 (and (memq 'notscheduled conditions)
4995 (not (re-search-forward org-scheduled-time-regexp end t)))
4996 (and (memq 'deadline conditions)
4997 (re-search-forward org-deadline-time-regexp end t))
4998 (and (memq 'notdeadline conditions)
4999 (not (re-search-forward org-deadline-time-regexp end t)))
5000 (and (memq 'timestamp conditions)
5001 (re-search-forward org-ts-regexp end t))
5002 (and (memq 'nottimestamp conditions)
5003 (not (re-search-forward org-ts-regexp end t)))
5004 (and (setq m (memq 'regexp conditions))
5005 (stringp (nth 1 m))
5006 (re-search-forward (nth 1 m) end t))
5007 (and (setq m (memq 'notregexp conditions))
5008 (stringp (nth 1 m))
5009 (not (re-search-forward (nth 1 m) end t)))
5010 (and (or
5011 (setq m (memq 'nottodo conditions))
5012 (setq m (memq 'todo-unblocked conditions))
5013 (setq m (memq 'nottodo-unblocked conditions))
5014 (setq m (memq 'todo conditions)))
5015 (org-agenda-skip-if-todo m end)))
5016 end)))
5018 (defun org-agenda-skip-if-todo (args end)
5019 "Helper function for `org-agenda-skip-if', do not use it directly.
5020 ARGS is a list with first element either `todo', `nottodo',
5021 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
5022 a list of TODO keywords, or a state symbol `todo' or `done' or
5023 `any'."
5024 (let ((kw (car args))
5025 (arg (cadr args))
5026 todo-wds todo-re)
5027 (setq todo-wds
5028 (org-uniquify
5029 (cond
5030 ((listp arg) ;; list of keywords
5031 (if (member "*" arg)
5032 (mapcar 'substring-no-properties org-todo-keywords-1)
5033 arg))
5034 ((symbolp arg) ;; keyword class name
5035 (cond
5036 ((eq arg 'todo)
5037 (org-delete-all org-done-keywords
5038 (mapcar 'substring-no-properties
5039 org-todo-keywords-1)))
5040 ((eq arg 'done) org-done-keywords)
5041 ((eq arg 'any)
5042 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
5043 (setq todo-re
5044 (concat "^\\*+[ \t]+\\<\\("
5045 (mapconcat 'identity todo-wds "\\|")
5046 "\\)\\>"))
5047 (cond
5048 ((eq kw 'todo) (re-search-forward todo-re end t))
5049 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
5050 ((eq kw 'todo-unblocked)
5051 (catch 'unblocked
5052 (while (re-search-forward todo-re end t)
5053 (or (org-entry-blocked-p) (throw 'unblocked t)))
5054 nil))
5055 ((eq kw 'nottodo-unblocked)
5056 (catch 'unblocked
5057 (while (re-search-forward todo-re end t)
5058 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5062 ;;;###autoload
5063 (defun org-agenda-list-stuck-projects (&rest ignore)
5064 "Create agenda view for projects that are stuck.
5065 Stuck projects are project that have no next actions. For the definitions
5066 of what a project is and how to check if it stuck, customize the variable
5067 `org-stuck-projects'."
5068 (interactive)
5069 (let* ((org-agenda-skip-function
5070 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5071 ;; We could have used org-agenda-skip-if here.
5072 (org-agenda-overriding-header
5073 (or org-agenda-overriding-header "List of stuck projects: "))
5074 (matcher (nth 0 org-stuck-projects))
5075 (todo (nth 1 org-stuck-projects))
5076 (todo-wds (if (member "*" todo)
5077 (progn
5078 (org-agenda-prepare-buffers (org-agenda-files
5079 nil 'ifmode))
5080 (org-delete-all
5081 org-done-keywords-for-agenda
5082 (copy-sequence org-todo-keywords-for-agenda)))
5083 todo))
5084 (todo-re (concat "^\\*+[ \t]+\\("
5085 (mapconcat 'identity todo-wds "\\|")
5086 "\\)\\>"))
5087 (tags (nth 2 org-stuck-projects))
5088 (tags-re (if (member "*" tags)
5089 (concat org-outline-regexp-bol
5090 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5091 (if tags
5092 (concat org-outline-regexp-bol
5093 ".*:\\("
5094 (mapconcat 'identity tags "\\|")
5095 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5096 (gen-re (nth 3 org-stuck-projects))
5097 (re-list
5098 (delq nil
5099 (list
5100 (if todo todo-re)
5101 (if tags tags-re)
5102 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5103 gen-re)))))
5104 (setq org-agenda-skip-regexp
5105 (if re-list
5106 (mapconcat 'identity re-list "\\|")
5107 (error "No information how to identify unstuck projects")))
5108 (org-tags-view nil matcher)
5109 (setq org-agenda-buffer-name (buffer-name))
5110 (with-current-buffer org-agenda-buffer-name
5111 (setq org-agenda-redo-command
5112 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5114 ;;; Diary integration
5116 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5117 (defvar diary-list-entries-hook)
5118 (defvar diary-time-regexp)
5119 (defun org-get-entries-from-diary (date)
5120 "Get the (Emacs Calendar) diary entries for DATE."
5121 (require 'diary-lib)
5122 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5123 (diary-display-function 'diary-fancy-display)
5124 (pop-up-frames nil)
5125 (diary-list-entries-hook
5126 (cons 'org-diary-default-entry diary-list-entries-hook))
5127 (diary-file-name-prefix nil) ; turn this feature off
5128 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5129 entries
5130 (org-disable-agenda-to-diary t))
5131 (save-excursion
5132 (save-window-excursion
5133 (funcall (if (fboundp 'diary-list-entries)
5134 'diary-list-entries 'list-diary-entries)
5135 date 1)))
5136 (if (not (get-buffer diary-fancy-buffer))
5137 (setq entries nil)
5138 (with-current-buffer diary-fancy-buffer
5139 (setq buffer-read-only nil)
5140 (if (zerop (buffer-size))
5141 ;; No entries
5142 (setq entries nil)
5143 ;; Omit the date and other unnecessary stuff
5144 (org-agenda-cleanup-fancy-diary)
5145 ;; Add prefix to each line and extend the text properties
5146 (if (zerop (buffer-size))
5147 (setq entries nil)
5148 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5149 (setq entries
5150 (with-temp-buffer
5151 (insert entries) (goto-char (point-min))
5152 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5153 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5154 (replace-match (concat "; " (match-string 1)))))
5155 (buffer-string)))))
5156 (set-buffer-modified-p nil)
5157 (kill-buffer diary-fancy-buffer)))
5158 (when entries
5159 (setq entries (org-split-string entries "\n"))
5160 (setq entries
5161 (mapcar
5162 (lambda (x)
5163 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5164 ;; Extend the text properties to the beginning of the line
5165 (org-add-props x (text-properties-at (1- (length x)) x)
5166 'type "diary" 'date date 'face 'org-agenda-diary))
5167 entries)))))
5169 (defvar org-agenda-cleanup-fancy-diary-hook nil
5170 "Hook run when the fancy diary buffer is cleaned up.")
5172 (defun org-agenda-cleanup-fancy-diary ()
5173 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5174 This gets rid of the date, the underline under the date, and
5175 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5176 date. It also removes lines that contain only whitespace."
5177 (goto-char (point-min))
5178 (if (looking-at ".*?:[ \t]*")
5179 (progn
5180 (replace-match "")
5181 (re-search-forward "\n=+$" nil t)
5182 (replace-match "")
5183 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5184 (re-search-forward "\n=+$" nil t)
5185 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5186 (goto-char (point-min))
5187 (while (re-search-forward "^ +\n" nil t)
5188 (replace-match ""))
5189 (goto-char (point-min))
5190 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5191 (replace-match ""))
5192 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5194 ;; Make sure entries from the diary have the right text properties.
5195 (eval-after-load "diary-lib"
5196 '(if (boundp 'diary-modify-entry-list-string-function)
5197 ;; We can rely on the hook, nothing to do
5199 ;; Hook not available, must use advice to make this work
5200 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5201 "Make the position visible."
5202 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5203 (stringp string)
5204 buffer-file-name)
5205 (setq string (org-modify-diary-entry-string string))))))
5207 (defun org-modify-diary-entry-string (string)
5208 "Add text properties to string, allowing org-mode to act on it."
5209 (org-add-props string nil
5210 'mouse-face 'highlight
5211 'help-echo (if buffer-file-name
5212 (format "mouse-2 or RET jump to diary file %s"
5213 (abbreviate-file-name buffer-file-name))
5215 'org-agenda-diary-link t
5216 'org-marker (org-agenda-new-marker (point-at-bol))))
5218 (defun org-diary-default-entry ()
5219 "Add a dummy entry to the diary.
5220 Needed to avoid empty dates which mess up holiday display."
5221 ;; Catch the error if dealing with the new add-to-diary-alist
5222 (when org-disable-agenda-to-diary
5223 (condition-case nil
5224 (org-add-to-diary-list original-date "Org-mode dummy" "")
5225 (error
5226 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5228 (defun org-add-to-diary-list (&rest args)
5229 (if (fboundp 'diary-add-to-list)
5230 (apply 'diary-add-to-list args)
5231 (apply 'add-to-diary-list args)))
5233 (defvar org-diary-last-run-time nil)
5235 ;;;###autoload
5236 (defun org-diary (&rest args)
5237 "Return diary information from org files.
5238 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5239 It accesses org files and extracts information from those files to be
5240 listed in the diary. The function accepts arguments specifying what
5241 items should be listed. For a list of arguments allowed here, see the
5242 variable `org-agenda-entry-types'.
5244 The call in the diary file should look like this:
5246 &%%(org-diary) ~/path/to/some/orgfile.org
5248 Use a separate line for each org file to check. Or, if you omit the file name,
5249 all files listed in `org-agenda-files' will be checked automatically:
5251 &%%(org-diary)
5253 If you don't give any arguments (as in the example above), the default value
5254 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5255 So the example above may also be written as
5257 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5259 The function expects the lisp variables `entry' and `date' to be provided
5260 by the caller, because this is how the calendar works. Don't use this
5261 function from a program - use `org-agenda-get-day-entries' instead."
5262 (when (> (- (org-float-time)
5263 org-agenda-last-marker-time)
5265 ;; I am not sure if this works with sticky agendas, because the marker
5266 ;; list is then no longer a global variable.
5267 (org-agenda-reset-markers))
5268 (org-compile-prefix-format 'agenda)
5269 (org-set-sorting-strategy 'agenda)
5270 (setq args (or args org-agenda-entry-types))
5271 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5272 (list entry)
5273 (org-agenda-files t)))
5274 (time (org-float-time))
5275 file rtn results)
5276 (when (or (not org-diary-last-run-time)
5277 (> (- time
5278 org-diary-last-run-time)
5280 (org-agenda-prepare-buffers files))
5281 (setq org-diary-last-run-time time)
5282 ;; If this is called during org-agenda, don't return any entries to
5283 ;; the calendar. Org Agenda will list these entries itself.
5284 (if org-disable-agenda-to-diary (setq files nil))
5285 (while (setq file (pop files))
5286 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5287 (setq results (append results rtn)))
5288 (when results
5289 (setq results
5290 (mapcar (lambda (i) (replace-regexp-in-string
5291 org-bracket-link-regexp "\\3" i)) results))
5292 (concat (org-agenda-finalize-entries results) "\n"))))
5294 ;;; Agenda entry finders
5296 (defun org-agenda-get-day-entries (file date &rest args)
5297 "Does the work for `org-diary' and `org-agenda'.
5298 FILE is the path to a file to be checked for entries. DATE is date like
5299 the one returned by `calendar-current-date'. ARGS are symbols indicating
5300 which kind of entries should be extracted. For details about these, see
5301 the documentation of `org-diary'."
5302 (setq args (or args org-agenda-entry-types))
5303 (let* ((org-startup-folded nil)
5304 (org-startup-align-all-tables nil)
5305 (buffer (if (file-exists-p file)
5306 (org-get-agenda-file-buffer file)
5307 (error "No such file %s" file)))
5308 arg results rtn deadline-results)
5309 (if (not buffer)
5310 ;; If file does not exist, make sure an error message ends up in diary
5311 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5312 (with-current-buffer buffer
5313 (unless (derived-mode-p 'org-mode)
5314 (error "Agenda file %s is not in `org-mode'" file))
5315 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5316 (let ((case-fold-search nil))
5317 (save-excursion
5318 (save-restriction
5319 (if (eq buffer org-agenda-restrict)
5320 (narrow-to-region org-agenda-restrict-begin
5321 org-agenda-restrict-end)
5322 (widen))
5323 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
5324 (while (setq arg (pop args))
5325 (cond
5326 ((and (eq arg :todo)
5327 (equal date (calendar-gregorian-from-absolute
5328 (org-today))))
5329 (setq rtn (org-agenda-get-todos))
5330 (setq results (append results rtn)))
5331 ((eq arg :timestamp)
5332 (setq rtn (org-agenda-get-blocks))
5333 (setq results (append results rtn))
5334 (setq rtn (org-agenda-get-timestamps deadline-results))
5335 (setq results (append results rtn)))
5336 ((eq arg :sexp)
5337 (setq rtn (org-agenda-get-sexps))
5338 (setq results (append results rtn)))
5339 ((eq arg :scheduled)
5340 (setq rtn (org-agenda-get-scheduled deadline-results))
5341 (setq results (append results rtn)))
5342 ((eq arg :scheduled*)
5343 (setq rtn (org-agenda-get-scheduled deadline-results t))
5344 (setq results (append results rtn)))
5345 ((eq arg :closed)
5346 (setq rtn (org-agenda-get-progress))
5347 (setq results (append results rtn)))
5348 ((eq arg :deadline)
5349 (setq rtn (org-agenda-get-deadlines))
5350 (setq deadline-results (copy-sequence rtn))
5351 (setq results (append results rtn)))
5352 ((eq arg :deadline*)
5353 (setq rtn (org-agenda-get-deadlines t))
5354 (setq deadline-results (copy-sequence rtn))
5355 (setq results (append results rtn))))))))
5356 results))))
5358 (defsubst org-em (x y list)
5359 "Is X or Y a member of LIST?"
5360 (or (memq x list) (memq y list)))
5362 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5363 (defvar org-agenda-sorting-strategy-selected nil)
5365 (defun org-agenda-get-todos ()
5366 "Return the TODO information for agenda display."
5367 (let* ((props (list 'face nil
5368 'done-face 'org-agenda-done
5369 'org-not-done-regexp org-not-done-regexp
5370 'org-todo-regexp org-todo-regexp
5371 'org-complex-heading-regexp org-complex-heading-regexp
5372 'mouse-face 'highlight
5373 'help-echo
5374 (format "mouse-2 or RET jump to org file %s"
5375 (abbreviate-file-name buffer-file-name))))
5376 (regexp (format org-heading-keyword-regexp-format
5377 (cond
5378 ((and org-select-this-todo-keyword
5379 (equal org-select-this-todo-keyword "*"))
5380 org-todo-regexp)
5381 (org-select-this-todo-keyword
5382 (concat "\\("
5383 (mapconcat 'identity
5384 (org-split-string
5385 org-select-this-todo-keyword
5386 "|")
5387 "\\|") "\\)"))
5388 (t org-not-done-regexp))))
5389 marker priority category level tags todo-state ts-date ts-date-type
5390 ee txt beg end inherited-tags todo-state-end-pos)
5391 (goto-char (point-min))
5392 (while (re-search-forward regexp nil t)
5393 (catch :skip
5394 (save-match-data
5395 (beginning-of-line)
5396 (org-agenda-skip)
5397 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5398 (unless (and (setq todo-state (org-get-todo-state))
5399 (setq todo-state-end-pos (match-end 2)))
5400 (goto-char end)
5401 (throw :skip nil))
5402 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5403 (goto-char (1+ beg))
5404 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5405 (throw :skip nil)))
5406 (goto-char (match-beginning 2))
5407 (setq marker (org-agenda-new-marker (match-beginning 0))
5408 category (org-get-category)
5409 ts-date (let (ts)
5410 (save-match-data
5411 (cond ((org-em 'scheduled-up 'scheduled-down
5412 org-agenda-sorting-strategy-selected)
5413 (setq ts (org-entry-get (point) "SCHEDULED")
5414 ts-date-type " scheduled"))
5415 ((org-em 'deadline-up 'deadline-down
5416 org-agenda-sorting-strategy-selected)
5417 (setq ts (org-entry-get (point) "DEADLINE")
5418 ts-date-type " deadline"))
5419 ((org-em 'ts-up 'ts-down
5420 org-agenda-sorting-strategy-selected)
5421 (setq ts (org-entry-get (point) "TIMESTAMP")
5422 ts-date-type " timestamp"))
5423 ((org-em 'tsia-up 'tsia-down
5424 org-agenda-sorting-strategy-selected)
5425 (setq ts (org-entry-get (point) "TIMESTAMP_IA")
5426 ts-date-type " timestamp_ia"))
5427 ((org-em 'timestamp-up 'timestamp-down
5428 org-agenda-sorting-strategy-selected)
5429 (setq ts (or (org-entry-get (point) "SCHEDULED")
5430 (org-entry-get (point) "DEADLINE")
5431 (org-entry-get (point) "TIMESTAMP")
5432 (org-entry-get (point) "TIMESTAMP_IA"))
5433 ts-date-type ""))
5434 (t (setq ts-date-type "")))
5435 (when ts (ignore-errors (org-time-string-to-absolute ts)))))
5436 txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
5437 inherited-tags
5438 (or (eq org-agenda-show-inherited-tags 'always)
5439 (and (listp org-agenda-show-inherited-tags)
5440 (memq 'todo org-agenda-show-inherited-tags))
5441 (and (eq org-agenda-show-inherited-tags t)
5442 (or (eq org-agenda-use-tag-inheritance t)
5443 (memq 'todo org-agenda-use-tag-inheritance))))
5444 tags (org-get-tags-at nil (not inherited-tags))
5445 level (make-string (org-reduced-level (org-outline-level)) ? )
5446 txt (org-agenda-format-item "" txt level category tags t)
5447 priority (1+ (org-get-priority txt)))
5448 (org-add-props txt props
5449 'org-marker marker 'org-hd-marker marker
5450 'priority priority
5451 'level level
5452 'ts-date ts-date
5453 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5454 (push txt ee)
5455 (if org-agenda-todo-list-sublevels
5456 (goto-char todo-state-end-pos)
5457 (org-end-of-subtree 'invisible))))
5458 (nreverse ee)))
5460 (defun org-agenda-todo-custom-ignore-p (time n)
5461 "Check whether timestamp is farther away than n number of days.
5462 This function is invoked if `org-agenda-todo-ignore-deadlines',
5463 `org-agenda-todo-ignore-scheduled' or
5464 `org-agenda-todo-ignore-timestamp' is set to an integer."
5465 (let ((days (org-time-stamp-to-now
5466 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5467 (if (>= n 0)
5468 (>= days n)
5469 (<= days n))))
5471 ;;;###autoload
5472 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5473 (&optional end)
5474 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5475 (when (or org-agenda-todo-ignore-with-date
5476 org-agenda-todo-ignore-scheduled
5477 org-agenda-todo-ignore-deadlines
5478 org-agenda-todo-ignore-timestamp)
5479 (setq end (or end (save-excursion (outline-next-heading) (point))))
5480 (save-excursion
5481 (or (and org-agenda-todo-ignore-with-date
5482 (re-search-forward org-ts-regexp end t))
5483 (and org-agenda-todo-ignore-scheduled
5484 (re-search-forward org-scheduled-time-regexp end t)
5485 (cond
5486 ((eq org-agenda-todo-ignore-scheduled 'future)
5487 (> (org-time-stamp-to-now
5488 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5489 ((eq org-agenda-todo-ignore-scheduled 'past)
5490 (<= (org-time-stamp-to-now
5491 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5492 ((numberp org-agenda-todo-ignore-scheduled)
5493 (org-agenda-todo-custom-ignore-p
5494 (match-string 1) org-agenda-todo-ignore-scheduled))
5495 (t)))
5496 (and org-agenda-todo-ignore-deadlines
5497 (re-search-forward org-deadline-time-regexp end t)
5498 (cond
5499 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5500 ((eq org-agenda-todo-ignore-deadlines 'far)
5501 (not (org-deadline-close (match-string 1))))
5502 ((eq org-agenda-todo-ignore-deadlines 'future)
5503 (> (org-time-stamp-to-now
5504 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5505 ((eq org-agenda-todo-ignore-deadlines 'past)
5506 (<= (org-time-stamp-to-now
5507 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5508 ((numberp org-agenda-todo-ignore-deadlines)
5509 (org-agenda-todo-custom-ignore-p
5510 (match-string 1) org-agenda-todo-ignore-deadlines))
5511 (t (org-deadline-close (match-string 1)))))
5512 (and org-agenda-todo-ignore-timestamp
5513 (let ((buffer (current-buffer))
5514 (regexp
5515 (concat
5516 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5517 (start (point)))
5518 ;; Copy current buffer into a temporary one
5519 (with-temp-buffer
5520 (insert-buffer-substring buffer start end)
5521 (goto-char (point-min))
5522 ;; Delete SCHEDULED and DEADLINE items
5523 (while (re-search-forward regexp end t)
5524 (delete-region (match-beginning 0) (match-end 0)))
5525 (goto-char (point-min))
5526 ;; No search for timestamp left
5527 (when (re-search-forward org-ts-regexp nil t)
5528 (cond
5529 ((eq org-agenda-todo-ignore-timestamp 'future)
5530 (> (org-time-stamp-to-now
5531 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5532 ((eq org-agenda-todo-ignore-timestamp 'past)
5533 (<= (org-time-stamp-to-now
5534 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5535 ((numberp org-agenda-todo-ignore-timestamp)
5536 (org-agenda-todo-custom-ignore-p
5537 (match-string 1) org-agenda-todo-ignore-timestamp))
5538 (t))))))))))
5540 (defun org-agenda-get-timestamps (&optional deadline-results)
5541 "Return the date stamp information for agenda display."
5542 (let* ((props (list 'face 'org-agenda-calendar-event
5543 'org-not-done-regexp org-not-done-regexp
5544 'org-todo-regexp org-todo-regexp
5545 'org-complex-heading-regexp org-complex-heading-regexp
5546 'mouse-face 'highlight
5547 'help-echo
5548 (format "mouse-2 or RET jump to org file %s"
5549 (abbreviate-file-name buffer-file-name))))
5550 (d1 (calendar-absolute-from-gregorian date))
5552 (deadline-position-alist
5553 (mapcar (lambda (a) (and (setq mm (get-text-property
5554 0 'org-hd-marker a))
5555 (cons (marker-position mm) a)))
5556 deadline-results))
5557 (remove-re org-ts-regexp)
5558 (regexp
5559 (concat
5560 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5561 (regexp-quote
5562 (substring
5563 (format-time-string
5564 (car org-time-stamp-formats)
5565 (apply 'encode-time ; DATE bound by calendar
5566 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5567 1 11))
5568 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5569 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5570 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5571 donep tmp priority category level ee txt timestr tags
5572 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5573 inherited-tags ts-date)
5574 (goto-char (point-min))
5575 (while (setq end-of-match (re-search-forward regexp nil t))
5576 (setq b0 (match-beginning 0)
5577 b3 (match-beginning 3) e3 (match-end 3)
5578 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5579 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5580 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5581 (member todo-state
5582 org-agenda-repeating-timestamp-show-all)))
5583 (catch :skip
5584 (and (org-at-date-range-p) (throw :skip nil))
5585 (org-agenda-skip)
5586 (if (and (match-end 1)
5587 (not (= d1 (org-time-string-to-absolute
5588 (match-string 1) d1 nil show-all
5589 (current-buffer) b0))))
5590 (throw :skip nil))
5591 (if (and e3
5592 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5593 (throw :skip nil))
5594 (setq tmp (buffer-substring (max (point-min)
5595 (- b0 org-ds-keyword-length))
5597 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5598 inactivep (= (char-after b0) ?\[)
5599 deadlinep (string-match org-deadline-regexp tmp)
5600 scheduledp (string-match org-scheduled-regexp tmp)
5601 closedp (and org-agenda-include-inactive-timestamps
5602 (string-match org-closed-string tmp))
5603 clockp (and org-agenda-include-inactive-timestamps
5604 (or (string-match org-clock-string tmp)
5605 (string-match "]-+\\'" tmp)))
5606 warntime (get-text-property (point) 'org-appt-warntime)
5607 donep (member todo-state org-done-keywords))
5608 (if (or scheduledp deadlinep closedp clockp
5609 (and donep org-agenda-skip-timestamp-if-done))
5610 (throw :skip t))
5611 (if (string-match ">" timestr)
5612 ;; substring should only run to end of time stamp
5613 (setq timestr (substring timestr 0 (match-end 0))))
5614 (setq marker (org-agenda-new-marker b0)
5615 category (org-get-category b0))
5616 (save-excursion
5617 (if (not (re-search-backward org-outline-regexp-bol nil t))
5618 (throw :skip nil)
5619 (goto-char (match-beginning 0))
5620 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5621 (assoc (point) deadline-position-alist))
5622 (throw :skip nil))
5623 (setq hdmarker (org-agenda-new-marker)
5624 inherited-tags
5625 (or (eq org-agenda-show-inherited-tags 'always)
5626 (and (listp org-agenda-show-inherited-tags)
5627 (memq 'agenda org-agenda-show-inherited-tags))
5628 (and (eq org-agenda-show-inherited-tags t)
5629 (or (eq org-agenda-use-tag-inheritance t)
5630 (memq 'agenda org-agenda-use-tag-inheritance))))
5631 tags (org-get-tags-at nil (not inherited-tags))
5632 level (make-string (org-reduced-level (org-outline-level)) ? ))
5633 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5634 (setq head (or (match-string 1) ""))
5635 (setq txt (org-agenda-format-item
5636 (if inactivep org-agenda-inactive-leader nil)
5637 head level category tags timestr
5638 remove-re habitp)))
5639 (setq priority (org-get-priority txt))
5640 (org-add-props txt props 'priority priority
5641 'org-marker marker 'org-hd-marker hdmarker
5642 'date date
5643 'level level
5644 'ts-date
5645 (ignore-errors (org-time-string-to-absolute timestr))
5646 'todo-state todo-state
5647 'warntime warntime
5648 'type "timestamp")
5649 (push txt ee))
5650 (if org-agenda-skip-additional-timestamps-same-entry
5651 (outline-next-heading)
5652 (goto-char end-of-match))))
5653 (nreverse ee)))
5655 (defun org-agenda-get-sexps ()
5656 "Return the sexp information for agenda display."
5657 (require 'diary-lib)
5658 (let* ((props (list 'face 'org-agenda-calendar-sexp
5659 'mouse-face 'highlight
5660 'help-echo
5661 (format "mouse-2 or RET jump to org file %s"
5662 (abbreviate-file-name buffer-file-name))))
5663 (regexp "^&?%%(")
5664 marker category extra level ee txt tags entry
5665 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5666 (goto-char (point-min))
5667 (while (re-search-forward regexp nil t)
5668 (catch :skip
5669 (org-agenda-skip)
5670 (setq beg (match-beginning 0))
5671 (goto-char (1- (match-end 0)))
5672 (setq b (point))
5673 (forward-sexp 1)
5674 (setq sexp (buffer-substring b (point)))
5675 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5676 (org-trim (match-string 1))
5677 ""))
5678 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5679 (when result
5680 (setq marker (org-agenda-new-marker beg)
5681 level (make-string (org-reduced-level (org-outline-level)) ? )
5682 category (org-get-category beg)
5683 inherited-tags
5684 (or (eq org-agenda-show-inherited-tags 'always)
5685 (and (listp org-agenda-show-inherited-tags)
5686 (memq 'agenda org-agenda-show-inherited-tags))
5687 (and (eq org-agenda-show-inherited-tags t)
5688 (or (eq org-agenda-use-tag-inheritance t)
5689 (memq 'agenda org-agenda-use-tag-inheritance))))
5690 tags (org-get-tags-at nil (not inherited-tags))
5691 todo-state (org-get-todo-state)
5692 warntime (get-text-property (point) 'org-appt-warntime)
5693 extra nil)
5695 (dolist (r (if (stringp result)
5696 (list result)
5697 result)) ;; we expect a list here
5698 (when (and org-agenda-diary-sexp-prefix
5699 (string-match org-agenda-diary-sexp-prefix r))
5700 (setq extra (match-string 0 r)
5701 r (replace-match "" nil nil r)))
5702 (if (string-match "\\S-" r)
5703 (setq txt r)
5704 (setq txt "SEXP entry returned empty string"))
5705 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5706 (org-add-props txt props 'org-marker marker
5707 'date date 'todo-state todo-state
5708 'level level 'type "sexp" 'warntime warntime)
5709 (push txt ee)))))
5710 (nreverse ee)))
5712 ;; Calendar sanity: define some functions that are independent of
5713 ;; `calendar-date-style'.
5714 ;; Normally I would like to use ISO format when calling the diary functions,
5715 ;; but to make sure we still have Emacs 22 compatibility we bind
5716 ;; also `european-calendar-style' and use european format
5717 (defun org-anniversary (year month day &optional mark)
5718 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5719 (org-no-warnings
5720 (let ((calendar-date-style 'european) (european-calendar-style t))
5721 (diary-anniversary day month year mark))))
5722 (defun org-cyclic (N year month day &optional mark)
5723 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5724 (org-no-warnings
5725 (let ((calendar-date-style 'european) (european-calendar-style t))
5726 (diary-cyclic N day month year mark))))
5727 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5728 "Like `diary-block', but with fixed (ISO) order of arguments."
5729 (org-no-warnings
5730 (let ((calendar-date-style 'european) (european-calendar-style t))
5731 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5732 (defun org-date (year month day &optional mark)
5733 "Like `diary-date', but with fixed (ISO) order of arguments."
5734 (org-no-warnings
5735 (let ((calendar-date-style 'european) (european-calendar-style t))
5736 (diary-date day month year mark))))
5738 ;; Define the` org-class' function
5739 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5740 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5741 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5742 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5743 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5744 `holidays', then any date that is known by the Emacs calendar to be a
5745 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5746 then those holidays will be skipped."
5747 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5748 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5749 (d (calendar-absolute-from-gregorian date))
5750 (h (when skip-weeks (calendar-check-holidays date))))
5751 (and
5752 (<= date1 d)
5753 (<= d date2)
5754 (= (calendar-day-of-week date) dayname)
5755 (or (not skip-weeks)
5756 (progn
5757 (require 'cal-iso)
5758 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5759 (not (or (and h (memq 'holidays skip-weeks))
5760 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5761 entry)))
5763 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5764 "Like `org-class', but honor `calendar-date-style'.
5765 The order of the first 2 times 3 arguments depends on the variable
5766 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5767 So for American calendars, give this as MONTH DAY YEAR, for European as
5768 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5769 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5770 is any number of ISO weeks in the block period for which the item should
5771 be skipped.
5773 This function is here only for backward compatibility and it is deprecated,
5774 please use `org-class' instead."
5775 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5776 (date2 (org-order-calendar-date-args m2 d2 y2)))
5777 (org-class
5778 (nth 2 date1) (car date1) (nth 1 date1)
5779 (nth 2 date2) (car date2) (nth 1 date2)
5780 dayname skip-weeks)))
5781 (make-obsolete 'org-diary-class 'org-class "")
5783 (defalias 'org-get-closed 'org-agenda-get-progress)
5784 (defun org-agenda-get-progress ()
5785 "Return the logged TODO entries for agenda display."
5786 (let* ((props (list 'mouse-face 'highlight
5787 'org-not-done-regexp org-not-done-regexp
5788 'org-todo-regexp org-todo-regexp
5789 'org-complex-heading-regexp org-complex-heading-regexp
5790 'help-echo
5791 (format "mouse-2 or RET jump to org file %s"
5792 (abbreviate-file-name buffer-file-name))))
5793 (items (if (consp org-agenda-show-log-scoped)
5794 org-agenda-show-log-scoped
5795 (if (eq org-agenda-show-log-scoped 'clockcheck)
5796 '(clock)
5797 org-agenda-log-mode-items)))
5798 (parts
5799 (delq nil
5800 (list
5801 (if (memq 'closed items) (concat "\\<" org-closed-string))
5802 (if (memq 'clock items) (concat "\\<" org-clock-string))
5803 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5804 (parts-re (if parts (mapconcat 'identity parts "\\|")
5805 (error "`org-agenda-log-mode-items' is empty")))
5806 (regexp (concat
5807 "\\(" parts-re "\\)"
5808 " *\\["
5809 (regexp-quote
5810 (substring
5811 (format-time-string
5812 (car org-time-stamp-formats)
5813 (apply 'encode-time ; DATE bound by calendar
5814 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5815 1 11))))
5816 (org-agenda-search-headline-for-time nil)
5817 marker hdmarker priority category level tags closedp
5818 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5819 (goto-char (point-min))
5820 (while (re-search-forward regexp nil t)
5821 (catch :skip
5822 (org-agenda-skip)
5823 (setq marker (org-agenda-new-marker (match-beginning 0))
5824 closedp (equal (match-string 1) org-closed-string)
5825 statep (equal (string-to-char (match-string 1)) ?-)
5826 clockp (not (or closedp statep))
5827 state (and statep (match-string 2))
5828 category (org-get-category (match-beginning 0))
5829 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5830 (when (string-match "\\]" timestr)
5831 ;; substring should only run to end of time stamp
5832 (setq rest (substring timestr (match-end 0))
5833 timestr (substring timestr 0 (match-end 0)))
5834 (if (and (not closedp) (not statep)
5835 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5836 rest))
5837 (progn (setq timestr (concat (substring timestr 0 -1)
5838 "-" (match-string 1 rest) "]"))
5839 (setq clocked (match-string 2 rest)))
5840 (setq clocked "-")))
5841 (save-excursion
5842 (setq extra
5843 (cond
5844 ((not org-agenda-log-mode-add-notes) nil)
5845 (statep
5846 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5847 (match-string 1)))
5848 (clockp
5849 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5850 (match-string 1)))))
5851 (if (not (re-search-backward org-outline-regexp-bol nil t))
5852 (throw :skip nil)
5853 (goto-char (match-beginning 0))
5854 (setq hdmarker (org-agenda-new-marker)
5855 inherited-tags
5856 (or (eq org-agenda-show-inherited-tags 'always)
5857 (and (listp org-agenda-show-inherited-tags)
5858 (memq 'todo org-agenda-show-inherited-tags))
5859 (and (eq org-agenda-show-inherited-tags t)
5860 (or (eq org-agenda-use-tag-inheritance t)
5861 (memq 'todo org-agenda-use-tag-inheritance))))
5862 tags (org-get-tags-at nil (not inherited-tags))
5863 level (make-string (org-reduced-level (org-outline-level)) ? ))
5864 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5865 (setq txt (match-string 1))
5866 (when extra
5867 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5868 (setq txt (concat (substring txt 0 (match-beginning 1))
5869 " - " extra " " (match-string 2 txt)))
5870 (setq txt (concat txt " - " extra))))
5871 (setq txt (org-agenda-format-item
5872 (cond
5873 (closedp "Closed: ")
5874 (statep (concat "State: (" state ")"))
5875 (t (concat "Clocked: (" clocked ")")))
5876 txt level category tags timestr)))
5877 (setq priority 100000)
5878 (org-add-props txt props
5879 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5880 'priority priority 'level level
5881 'type "closed" 'date date
5882 'undone-face 'org-warning 'done-face 'org-agenda-done)
5883 (push txt ee))
5884 (goto-char (point-at-eol))))
5885 (nreverse ee)))
5887 (defun org-agenda-show-clocking-issues ()
5888 "Add overlays, showing issues with clocking.
5889 See also the user option `org-agenda-clock-consistency-checks'."
5890 (interactive)
5891 (let* ((org-time-clocksum-use-effort-durations nil)
5892 (pl org-agenda-clock-consistency-checks)
5893 (re (concat "^[ \t]*"
5894 org-clock-string
5895 "[ \t]+"
5896 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5897 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5898 (tlstart 0.)
5899 (tlend 0.)
5900 (maxtime (org-hh:mm-string-to-minutes
5901 (or (plist-get pl :max-duration) "24:00")))
5902 (mintime (org-hh:mm-string-to-minutes
5903 (or (plist-get pl :min-duration) 0)))
5904 (maxgap (org-hh:mm-string-to-minutes
5905 ;; default 30:00 means never complain
5906 (or (plist-get pl :max-gap) "30:00")))
5907 (gapok (mapcar 'org-hh:mm-string-to-minutes
5908 (plist-get pl :gap-ok-around)))
5909 (def-face (or (plist-get pl :default-face)
5910 '((:background "DarkRed") (:foreground "white"))))
5911 issue face m te ts dt ov)
5912 (goto-char (point-min))
5913 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5914 (setq issue nil face def-face)
5915 (catch 'next
5916 (setq m (org-get-at-bol 'org-marker)
5917 te nil ts nil)
5918 (unless (and m (markerp m))
5919 (setq issue "No valid clock line") (throw 'next t))
5920 (org-with-point-at m
5921 (save-excursion
5922 (goto-char (point-at-bol))
5923 (unless (looking-at re)
5924 (error "No valid Clock line")
5925 (throw 'next t))
5926 (unless (match-end 3)
5927 (setq issue "No end time"
5928 face (or (plist-get pl :no-end-time-face) face))
5929 (throw 'next t))
5930 (setq ts (match-string 1)
5931 te (match-string 3)
5932 ts (org-float-time
5933 (apply 'encode-time (org-parse-time-string ts)))
5934 te (org-float-time
5935 (apply 'encode-time (org-parse-time-string te)))
5936 dt (- te ts))))
5937 (cond
5938 ((> dt (* 60 maxtime))
5939 ;; a very long clocking chunk
5940 (setq issue (format "Clocking interval is very long: %s"
5941 (org-minutes-to-clocksum-string
5942 (floor (/ (float dt) 60.))))
5943 face (or (plist-get pl :long-face) face)))
5944 ((< dt (* 60 mintime))
5945 ;; a very short clocking chunk
5946 (setq issue (format "Clocking interval is very short: %s"
5947 (org-minutes-to-clocksum-string
5948 (floor (/ (float dt) 60.))))
5949 face (or (plist-get pl :short-face) face)))
5950 ((and (> tlend 0) (< ts tlend))
5951 ;; Two clock entries are overlapping
5952 (setq issue (format "Clocking overlap: %d minutes"
5953 (/ (- tlend ts) 60))
5954 face (or (plist-get pl :overlap-face) face)))
5955 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5956 ;; There is a gap, lets see if we need to report it
5957 (unless (org-agenda-check-clock-gap tlend ts gapok)
5958 (setq issue (format "Clocking gap: %d minutes"
5959 (/ (- ts tlend) 60))
5960 face (or (plist-get pl :gap-face) face))))
5961 (t nil)))
5962 (setq tlend (or te tlend) tlstart (or ts tlstart))
5963 (when issue
5964 ;; OK, there was some issue, add an overlay to show the issue
5965 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5966 (overlay-put ov 'before-string
5967 (concat
5968 (org-add-props
5969 (format "%-43s" (concat " " issue))
5971 'face face)
5972 "\n"))
5973 (overlay-put ov 'evaporate t)))))
5975 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5976 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5977 (catch 'exit
5978 (unless ok-list
5979 ;; there are no OK times for gaps...
5980 (throw 'exit nil))
5981 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5982 ;; This is more than 24 hours, so it is OK.
5983 ;; because we have at least one OK time, that must be in the
5984 ;; 24 hour interval.
5985 (throw 'exit t))
5986 ;; We have a shorter gap.
5987 ;; Now we have to get the minute of the day when these times are
5988 (let* ((t1dec (decode-time (seconds-to-time t1)))
5989 (t2dec (decode-time (seconds-to-time t2)))
5990 ;; compute the minute on the day
5991 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5992 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5993 (when (< min2 min1)
5994 ;; if min2 is smaller than min1, this means it is on the next day.
5995 ;; Wrap it to after midnight.
5996 (setq min2 (+ min2 1440)))
5997 ;; Now check if any of the OK times is in the gap
5998 (mapc (lambda (x)
5999 ;; Wrap the time to after midnight if necessary
6000 (if (< x min1) (setq x (+ x 1440)))
6001 ;; Check if in interval
6002 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
6003 ok-list)
6004 ;; Nope, this gap is not OK
6005 nil)))
6007 (defun org-agenda-get-deadlines (&optional with-hour)
6008 "Return the deadline information for agenda display.
6009 When WITH-HOUR is non-nil, only return deadlines with an hour
6010 specification like [h]h:mm."
6011 (let* ((props (list 'mouse-face 'highlight
6012 'org-not-done-regexp org-not-done-regexp
6013 'org-todo-regexp org-todo-regexp
6014 'org-complex-heading-regexp org-complex-heading-regexp
6015 'help-echo
6016 (format "mouse-2 or RET jump to org file %s"
6017 (abbreviate-file-name buffer-file-name))))
6018 (regexp (if with-hour
6019 org-deadline-time-hour-regexp
6020 org-deadline-time-regexp))
6021 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6022 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6023 (dl0 (car org-agenda-deadline-leaders))
6024 (dl1 (nth 1 org-agenda-deadline-leaders))
6025 (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
6026 d2 diff dfrac wdays pos pos1 category level
6027 tags suppress-prewarning ee txt head face s todo-state
6028 show-all upcomingp donep timestr warntime inherited-tags ts-date)
6029 (goto-char (point-min))
6030 (while (re-search-forward regexp nil t)
6031 (catch :skip
6032 (org-agenda-skip)
6033 (setq s (match-string 1)
6034 txt nil
6035 pos (1- (match-beginning 1))
6036 todo-state (save-match-data (org-get-todo-state))
6037 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6038 (member todo-state
6039 org-agenda-repeating-timestamp-show-all))
6040 d2 (org-time-string-to-absolute
6041 s d1 'past show-all (current-buffer) pos)
6042 diff (- d2 d1))
6043 (setq suppress-prewarning
6044 (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
6045 (let ((item (buffer-substring (point-at-bol)
6046 (point-at-eol))))
6047 (save-match-data
6048 (and (string-match
6049 org-scheduled-time-regexp item)
6050 (match-string 1 item)))))))
6051 (cond
6052 ((not ds) nil)
6053 ;; The current item has a scheduled date (in ds), so
6054 ;; evaluate its prewarning lead time.
6055 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6056 ;; Use global prewarning-restart lead time.
6057 org-agenda-skip-deadline-prewarning-if-scheduled)
6058 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6059 'pre-scheduled)
6060 ;; Set prewarning to no earlier than scheduled.
6061 (min (- d2 (org-time-string-to-absolute
6062 ds d1 'past show-all (current-buffer) pos))
6063 org-deadline-warning-days))
6064 ;; Set prewarning to deadline.
6065 (t 0))))
6066 (setq wdays (if suppress-prewarning
6067 (let ((org-deadline-warning-days suppress-prewarning))
6068 (org-get-wdays s))
6069 (org-get-wdays s))
6070 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
6071 upcomingp (and todayp (> diff 0)))
6072 ;; When to show a deadline in the calendar:
6073 ;; If the expiration is within wdays warning time.
6074 ;; Past-due deadlines are only shown on the current date
6075 (if (and (or (and (<= diff wdays)
6076 (and todayp (not org-agenda-only-exact-dates)))
6077 (= diff 0)))
6078 (save-excursion
6079 ;; (setq todo-state (org-get-todo-state))
6080 (setq donep (member todo-state org-done-keywords))
6081 (if (and donep
6082 (or org-agenda-skip-deadline-if-done
6083 (not (= diff 0))))
6084 (setq txt nil)
6085 (setq category (org-get-category)
6086 warntime (get-text-property (point) 'org-appt-warntime))
6087 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6088 (throw :skip nil)
6089 (goto-char (match-end 0))
6090 (setq pos1 (match-beginning 0))
6091 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6092 (setq inherited-tags
6093 (or (eq org-agenda-show-inherited-tags 'always)
6094 (and (listp org-agenda-show-inherited-tags)
6095 (memq 'agenda org-agenda-show-inherited-tags))
6096 (and (eq org-agenda-show-inherited-tags t)
6097 (or (eq org-agenda-use-tag-inheritance t)
6098 (memq 'agenda org-agenda-use-tag-inheritance))))
6099 tags (org-get-tags-at pos1 (not inherited-tags)))
6100 (setq head (buffer-substring
6101 (point)
6102 (progn (skip-chars-forward "^\r\n")
6103 (point))))
6104 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6105 (setq timestr
6106 (concat (substring s (match-beginning 1)) " "))
6107 (setq timestr 'time))
6108 (setq txt (org-agenda-format-item
6109 (cond ((= diff 0) dl0)
6110 ((> diff 0)
6111 (if (functionp dl1)
6112 (funcall dl1 diff date)
6113 (format dl1 diff)))
6115 (if (functionp dl2)
6116 (funcall dl2 diff date)
6117 (format dl2 (if (string= dl2 dl1)
6118 diff (abs diff))))))
6119 head level category tags
6120 (if (not (= diff 0)) nil timestr)))))
6121 (when txt
6122 (setq face (org-agenda-deadline-face dfrac))
6123 (org-add-props txt props
6124 'org-marker (org-agenda-new-marker pos)
6125 'warntime warntime
6126 'level level
6127 'ts-date d2
6128 'org-hd-marker (org-agenda-new-marker pos1)
6129 'priority (+ (- diff)
6130 (org-get-priority txt))
6131 'todo-state todo-state
6132 'type (if upcomingp "upcoming-deadline" "deadline")
6133 'date (if upcomingp date d2)
6134 'face (if donep 'org-agenda-done face)
6135 'undone-face face 'done-face 'org-agenda-done)
6136 (push txt ee))))))
6137 (nreverse ee)))
6139 (defun org-agenda-deadline-face (fraction)
6140 "Return the face to displaying a deadline item.
6141 FRACTION is what fraction of the head-warning time has passed."
6142 (let ((faces org-agenda-deadline-faces) f)
6143 (catch 'exit
6144 (while (setq f (pop faces))
6145 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6147 (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
6148 "Return the scheduled information for agenda display.
6149 When WITH-HOUR is non-nil, only return scheduled items with
6150 an hour specification like [h]h:mm."
6151 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6152 'org-todo-regexp org-todo-regexp
6153 'org-complex-heading-regexp org-complex-heading-regexp
6154 'done-face 'org-agenda-done
6155 'mouse-face 'highlight
6156 'help-echo
6157 (format "mouse-2 or RET jump to org file %s"
6158 (abbreviate-file-name buffer-file-name))))
6159 (regexp (if with-hour
6160 org-scheduled-time-hour-regexp
6161 org-scheduled-time-regexp))
6162 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6163 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6165 (deadline-position-alist
6166 (mapcar (lambda (a) (and (setq mm (get-text-property
6167 0 'org-hd-marker a))
6168 (cons (marker-position mm) a)))
6169 deadline-results))
6170 d2 diff pos pos1 category level tags donep
6171 ee txt head pastschedp todo-state face timestr s habitp show-all
6172 did-habit-check-p warntime inherited-tags ts-date suppress-delay
6173 ddays)
6174 (goto-char (point-min))
6175 (while (re-search-forward regexp nil t)
6176 (catch :skip
6177 (org-agenda-skip)
6178 (setq s (match-string 1)
6179 txt nil
6180 pos (1- (match-beginning 1))
6181 todo-state (save-match-data (org-get-todo-state))
6182 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6183 (member todo-state
6184 org-agenda-repeating-timestamp-show-all))
6185 d2 (org-time-string-to-absolute
6186 s d1 'past show-all (current-buffer) pos)
6187 diff (- d2 d1)
6188 warntime (get-text-property (point) 'org-appt-warntime))
6189 (setq pastschedp (and todayp (< diff 0)))
6190 (setq did-habit-check-p nil)
6191 (setq suppress-delay
6192 (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
6193 (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
6194 (save-match-data
6195 (and (string-match
6196 org-deadline-time-regexp item)
6197 (match-string 1 item)))))))
6198 (cond
6199 ((not ds) nil)
6200 ;; The current item has a deadline date (in ds), so
6201 ;; evaluate its delay time.
6202 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6203 ;; Use global delay time.
6204 (- org-agenda-skip-scheduled-delay-if-deadline))
6205 ((eq org-agenda-skip-scheduled-delay-if-deadline
6206 'post-deadline)
6207 ;; Set delay to no later than deadline.
6208 (min (- d2 (org-time-string-to-absolute
6209 ds d1 'past show-all (current-buffer) pos))
6210 org-scheduled-delay-days))
6211 (t 0))))
6212 (setq ddays (if suppress-delay
6213 (let ((org-scheduled-delay-days suppress-delay))
6214 (org-get-wdays s t t))
6215 (org-get-wdays s t)))
6216 ;; Use a delay of 0 when there is a repeater and the delay is
6217 ;; of the form --3d
6218 (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6219 (< (org-time-string-to-absolute s)
6220 (org-time-string-to-absolute
6221 s d2 'past nil (current-buffer) pos)))
6222 (setq ddays 0))
6223 ;; When to show a scheduled item in the calendar:
6224 ;; If it is on or past the date.
6225 (when (or (and (> ddays 0) (= diff (- ddays)))
6226 (and (zerop ddays) (= diff 0))
6227 (and (< (+ diff ddays) 0)
6228 (< (abs diff) org-scheduled-past-days)
6229 (and todayp (not org-agenda-only-exact-dates)))
6230 ;; org-is-habit-p uses org-entry-get, which is expansive
6231 ;; so we go extra mile to only call it once
6232 (and todayp
6233 (boundp 'org-habit-show-all-today)
6234 org-habit-show-all-today
6235 (setq did-habit-check-p t)
6236 (setq habitp (and (functionp 'org-is-habit-p)
6237 (org-is-habit-p)))))
6238 (save-excursion
6239 (setq donep (member todo-state org-done-keywords))
6240 (if (and donep
6241 (or org-agenda-skip-scheduled-if-done
6242 (not (= diff 0))
6243 (and (functionp 'org-is-habit-p)
6244 (org-is-habit-p))))
6245 (setq txt nil)
6246 (setq habitp (if did-habit-check-p habitp
6247 (and (functionp 'org-is-habit-p)
6248 (org-is-habit-p))))
6249 (setq category (org-get-category))
6250 (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
6251 'repeated-after-deadline)
6252 (org-get-deadline-time (point))
6253 (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
6254 (throw :skip nil))
6255 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6256 (throw :skip nil)
6257 (goto-char (match-end 0))
6258 (setq pos1 (match-beginning 0))
6259 (if habitp
6260 (if (or (not org-habit-show-habits)
6261 (and (not todayp)
6262 (boundp 'org-habit-show-habits-only-for-today)
6263 org-habit-show-habits-only-for-today))
6264 (throw :skip nil))
6265 (if (and
6266 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
6267 (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
6268 pastschedp))
6269 (setq mm (assoc pos1 deadline-position-alist)))
6270 (throw :skip nil)))
6271 (setq inherited-tags
6272 (or (eq org-agenda-show-inherited-tags 'always)
6273 (and (listp org-agenda-show-inherited-tags)
6274 (memq 'agenda org-agenda-show-inherited-tags))
6275 (and (eq org-agenda-show-inherited-tags t)
6276 (or (eq org-agenda-use-tag-inheritance t)
6277 (memq 'agenda org-agenda-use-tag-inheritance))))
6279 tags (org-get-tags-at nil (not inherited-tags)))
6280 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6281 (setq head (buffer-substring
6282 (point)
6283 (progn (skip-chars-forward "^\r\n") (point))))
6284 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6285 (setq timestr
6286 (concat (substring s (match-beginning 1)) " "))
6287 (setq timestr 'time))
6288 (setq txt (org-agenda-format-item
6289 (if (= diff 0)
6290 (car org-agenda-scheduled-leaders)
6291 (format (nth 1 org-agenda-scheduled-leaders)
6292 (- 1 diff)))
6293 head level category tags
6294 (if (not (= diff 0)) nil timestr)
6295 nil habitp))))
6296 (when txt
6297 (setq face
6298 (cond
6299 ((and (not habitp) pastschedp)
6300 'org-scheduled-previously)
6301 (todayp 'org-scheduled-today)
6302 (t 'org-scheduled))
6303 habitp (and habitp (org-habit-parse-todo)))
6304 (org-add-props txt props
6305 'undone-face face
6306 'face (if donep 'org-agenda-done face)
6307 'org-marker (org-agenda-new-marker pos)
6308 'org-hd-marker (org-agenda-new-marker pos1)
6309 'type (if pastschedp "past-scheduled" "scheduled")
6310 'date (if pastschedp d2 date)
6311 'ts-date d2
6312 'warntime warntime
6313 'level level
6314 'priority (if habitp
6315 (org-habit-get-priority habitp)
6316 (+ 94 (- 5 diff) (org-get-priority txt)))
6317 'org-habit-p habitp
6318 'todo-state todo-state)
6319 (push txt ee))))))
6320 (nreverse ee)))
6322 (defun org-agenda-get-blocks ()
6323 "Return the date-range information for agenda display."
6324 (let* ((props (list 'face nil
6325 'org-not-done-regexp org-not-done-regexp
6326 'org-todo-regexp org-todo-regexp
6327 'org-complex-heading-regexp org-complex-heading-regexp
6328 'mouse-face 'highlight
6329 'help-echo
6330 (format "mouse-2 or RET jump to org file %s"
6331 (abbreviate-file-name buffer-file-name))))
6332 (regexp org-tr-regexp)
6333 (d0 (calendar-absolute-from-gregorian date))
6334 marker hdmarker ee txt d1 d2 s1 s2 category
6335 level todo-state tags pos head donep inherited-tags)
6336 (goto-char (point-min))
6337 (while (re-search-forward regexp nil t)
6338 (catch :skip
6339 (org-agenda-skip)
6340 (setq pos (point))
6341 (let ((start-time (match-string 1))
6342 (end-time (match-string 2)))
6343 (setq s1 (match-string 1)
6344 s2 (match-string 2)
6345 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6346 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6347 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6348 ;; Only allow days between the limits, because the normal
6349 ;; date stamps will catch the limits.
6350 (save-excursion
6351 (setq todo-state (org-get-todo-state))
6352 (setq donep (member todo-state org-done-keywords))
6353 (if (and donep org-agenda-skip-timestamp-if-done)
6354 (throw :skip t))
6355 (setq marker (org-agenda-new-marker (point))
6356 category (org-get-category))
6357 (if (not (re-search-backward org-outline-regexp-bol nil t))
6358 (throw :skip nil)
6359 (goto-char (match-beginning 0))
6360 (setq hdmarker (org-agenda-new-marker (point))
6361 inherited-tags
6362 (or (eq org-agenda-show-inherited-tags 'always)
6363 (and (listp org-agenda-show-inherited-tags)
6364 (memq 'agenda org-agenda-show-inherited-tags))
6365 (and (eq org-agenda-show-inherited-tags t)
6366 (or (eq org-agenda-use-tag-inheritance t)
6367 (memq 'agenda org-agenda-use-tag-inheritance))))
6369 tags (org-get-tags-at nil (not inherited-tags)))
6370 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6371 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6372 (setq head (match-string 1))
6373 (let ((remove-re
6374 (if org-agenda-remove-timeranges-from-blocks
6375 (concat
6376 "<" (regexp-quote s1) ".*?>"
6377 "--"
6378 "<" (regexp-quote s2) ".*?>")
6379 nil)))
6380 (setq txt (org-agenda-format-item
6381 (format
6382 (nth (if (= d1 d2) 0 1)
6383 org-agenda-timerange-leaders)
6384 (1+ (- d0 d1)) (1+ (- d2 d1)))
6385 head level category tags
6386 (cond ((and (= d1 d0) (= d2 d0))
6387 (concat "<" start-time ">--<" end-time ">"))
6388 ((= d1 d0)
6389 (concat "<" start-time ">"))
6390 ((= d2 d0)
6391 (concat "<" end-time ">")))
6392 remove-re))))
6393 (org-add-props txt props
6394 'org-marker marker 'org-hd-marker hdmarker
6395 'type "block" 'date date
6396 'level level
6397 'todo-state todo-state
6398 'priority (org-get-priority txt))
6399 (push txt ee))))
6400 (goto-char pos)))
6401 ;; Sort the entries by expiration date.
6402 (nreverse ee)))
6404 ;;; Agenda presentation and sorting
6406 (defvar org-prefix-has-time nil
6407 "A flag, set by `org-compile-prefix-format'.
6408 The flag is set if the currently compiled format contains a `%t'.")
6409 (defvar org-prefix-has-tag nil
6410 "A flag, set by `org-compile-prefix-format'.
6411 The flag is set if the currently compiled format contains a `%T'.")
6412 (defvar org-prefix-has-effort nil
6413 "A flag, set by `org-compile-prefix-format'.
6414 The flag is set if the currently compiled format contains a `%e'.")
6415 (defvar org-prefix-has-breadcrumbs nil
6416 "A flag, set by `org-compile-prefix-format'.
6417 The flag is set if the currently compiled format contains a `%b'.")
6418 (defvar org-prefix-category-length nil
6419 "Used by `org-compile-prefix-format' to remember the category field width.")
6420 (defvar org-prefix-category-max-length nil
6421 "Used by `org-compile-prefix-format' to remember the category field width.")
6423 (defun org-agenda-get-category-icon (category)
6424 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6425 (dolist (entry org-agenda-category-icon-alist)
6426 (when (org-string-match-p (car entry) category)
6427 (if (listp (cadr entry))
6428 (return (cadr entry))
6429 (return (apply 'create-image (cdr entry)))))))
6431 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6432 remove-re habitp)
6433 "Format TXT to be inserted into the agenda buffer.
6434 In particular, add the prefix and corresponding text properties.
6436 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6437 LEVEL may be a string to replace the `%l' specifier.
6438 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6439 category taken from local variable or file name. It will replace the `%c'
6440 specifier in the format.
6441 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6442 TXT for sorting of this entry, and for the `%t' specifier in the format.
6443 When DOTIME is a string, this string is searched for a time before TXT is.
6444 TAGS can be the tags of the headline.
6445 Any match of REMOVE-RE will be removed from TXT."
6446 ;; We keep the org-prefix-* variable values along with a compiled
6447 ;; formatter, so that multiple agendas existing at the same time do
6448 ;; not step on each other toes.
6450 ;; It was inconvenient to make these variables buffer local in
6451 ;; Agenda buffers, because this function expects to be called with
6452 ;; the buffer where item comes from being current, and not agenda
6453 ;; buffer
6454 (let* ((bindings (car org-prefix-format-compiled))
6455 (formatter (cadr org-prefix-format-compiled)))
6456 (loop for (var value) in bindings
6457 do (set var value))
6458 (save-match-data
6459 ;; Diary entries sometimes have extra whitespace at the beginning
6460 (setq txt (org-trim txt))
6462 ;; Fix the tags part in txt
6463 (setq txt (org-agenda-fix-displayed-tags
6464 txt tags
6465 org-agenda-show-inherited-tags
6466 org-agenda-hide-tags-regexp))
6468 (let* ((category (or category
6469 (if buffer-file-name
6470 (file-name-sans-extension
6471 (file-name-nondirectory buffer-file-name))
6472 "")))
6473 (category-icon (org-agenda-get-category-icon category))
6474 (category-icon (if category-icon
6475 (propertize " " 'display category-icon)
6476 ""))
6477 (effort (and (not (string= txt ""))
6478 (get-text-property 1 'effort txt)))
6479 ;; time, tag, effort are needed for the eval of the prefix format
6480 (tag (if tags (nth (1- (length tags)) tags) ""))
6481 time
6482 (ts (if dotime (concat
6483 (if (stringp dotime) dotime "")
6484 (and org-agenda-search-headline-for-time txt))))
6485 (time-of-day (and dotime (org-get-time-of-day ts)))
6486 stamp plain s0 s1 s2 rtn srp l
6487 duration breadcrumbs)
6488 (and (derived-mode-p 'org-mode) buffer-file-name
6489 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6490 (when (and dotime time-of-day)
6491 ;; Extract starting and ending time and move them to prefix
6492 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6493 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6494 (setq s0 (match-string 0 ts)
6495 srp (and stamp (match-end 3))
6496 s1 (match-string (if plain 1 2) ts)
6497 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6499 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6500 ;; them, we might want to remove them there to avoid duplication.
6501 ;; The user can turn this off with a variable.
6502 (if (and org-prefix-has-time
6503 org-agenda-remove-times-when-in-prefix (or stamp plain)
6504 (string-match (concat (regexp-quote s0) " *") txt)
6505 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6506 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6507 (= (match-beginning 0) 0)
6509 (setq txt (replace-match "" nil nil txt))))
6510 ;; Normalize the time(s) to 24 hour
6511 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6512 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6514 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6515 (let (org-time-clocksum-use-effort-durations)
6516 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6517 (setq s2
6518 (org-minutes-to-clocksum-string
6519 (+ (org-hh:mm-string-to-minutes s1)
6520 org-agenda-default-appointment-duration)))))
6522 ;; Compute the duration
6523 (when s2
6524 (setq duration (- (org-hh:mm-string-to-minutes s2)
6525 (org-hh:mm-string-to-minutes s1)))))
6527 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6528 txt)
6529 ;; Tags are in the string
6530 (if (or (eq org-agenda-remove-tags t)
6531 (and org-agenda-remove-tags
6532 org-prefix-has-tag))
6533 (setq txt (replace-match "" t t txt))
6534 (setq txt (replace-match
6535 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6536 (match-string 2 txt))
6537 t t txt))))
6539 (when remove-re
6540 (while (string-match remove-re txt)
6541 (setq txt (replace-match "" t t txt))))
6543 ;; Set org-heading property on `txt' to mark the start of the
6544 ;; heading.
6545 (add-text-properties 0 (length txt) '(org-heading t) txt)
6547 ;; Prepare the variables needed in the eval of the compiled format
6548 (if org-prefix-has-breadcrumbs
6549 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6550 (let ((s (org-display-outline-path nil nil "->" t)))
6551 (if (eq "" s) "" (concat s "->"))))))
6552 (setq time (cond (s2 (concat
6553 (org-agenda-time-of-day-to-ampm-maybe s1)
6554 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6555 (if org-agenda-timegrid-use-ampm " ")))
6556 (s1 (concat
6557 (org-agenda-time-of-day-to-ampm-maybe s1)
6558 (if org-agenda-timegrid-use-ampm
6559 "........ "
6560 "......")))
6561 (t ""))
6562 extra (or (and (not habitp) extra) "")
6563 category (if (symbolp category) (symbol-name category) category)
6564 level (or level ""))
6565 (if (string-match org-bracket-link-regexp category)
6566 (progn
6567 (setq l (if (match-end 3)
6568 (- (match-end 3) (match-beginning 3))
6569 (- (match-end 1) (match-beginning 1))))
6570 (when (< l (or org-prefix-category-length 0))
6571 (setq category (copy-sequence category))
6572 (org-add-props category nil
6573 'extra-space (make-string
6574 (- org-prefix-category-length l 1) ?\ ))))
6575 (if (and org-prefix-category-max-length
6576 (>= (length category) org-prefix-category-max-length))
6577 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6578 ;; Evaluate the compiled format
6579 (setq rtn (concat (eval formatter) txt))
6581 ;; And finally add the text properties
6582 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6583 (org-add-props rtn nil
6584 'org-category category
6585 'tags (mapcar 'org-downcase-keep-props tags)
6586 'org-highest-priority org-highest-priority
6587 'org-lowest-priority org-lowest-priority
6588 'time-of-day time-of-day
6589 'duration duration
6590 'breadcrumbs breadcrumbs
6591 'txt txt
6592 'level level
6593 'time time
6594 'extra extra
6595 'format org-prefix-format-compiled
6596 'dotime dotime)))))
6598 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6599 "Remove tags string from TXT, and add a modified list of tags.
6600 The modified list may contain inherited tags, and tags matched by
6601 `org-agenda-hide-tags-regexp' will be removed."
6602 (when (or add-inherited hide-re)
6603 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6604 (setq txt (substring txt 0 (match-beginning 0))))
6605 (setq tags
6606 (delq nil
6607 (mapcar (lambda (tg)
6608 (if (or (and hide-re (string-match hide-re tg))
6609 (and (not add-inherited)
6610 (get-text-property 0 'inherited tg)))
6612 tg))
6613 tags)))
6614 (when tags
6615 (let ((have-i (get-text-property 0 'inherited (car tags)))
6617 (setq txt (concat txt " :"
6618 (mapconcat
6619 (lambda (x)
6620 (setq i (get-text-property 0 'inherited x))
6621 (if (and have-i (not i))
6622 (progn
6623 (setq have-i nil)
6624 (concat ":" x))
6626 tags ":")
6627 (if have-i "::" ":"))))))
6628 txt)
6630 (defun org-downcase-keep-props (s)
6631 (let ((props (text-properties-at 0 s)))
6632 (setq s (downcase s))
6633 (add-text-properties 0 (length s) props s)
6636 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6638 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6639 "Add a time-grid for agenda items which need it.
6641 LIST is the list of agenda items formatted by `org-agenda-list'.
6642 NDAYS is the span of the current agenda view.
6643 TODAYP is `t' when the current agenda view is on today."
6644 (catch 'exit
6645 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6646 ((and todayp (member 'today (car org-agenda-time-grid))))
6647 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6648 ((member 'weekly (car org-agenda-time-grid)))
6649 (t (throw 'exit list)))
6650 (let* ((have (delq nil (mapcar
6651 (lambda (x) (get-text-property 1 'time-of-day x))
6652 list)))
6653 (string (nth 1 org-agenda-time-grid))
6654 (gridtimes (nth 2 org-agenda-time-grid))
6655 (req (car org-agenda-time-grid))
6656 (remove (member 'remove-match req))
6657 new time)
6658 (if (and (member 'require-timed req) (not have))
6659 ;; don't show empty grid
6660 (throw 'exit list))
6661 (while (setq time (pop gridtimes))
6662 (unless (and remove (member time have))
6663 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6664 (push (org-agenda-format-item
6665 nil string nil "" nil
6666 (concat (substring time 0 -2) ":" (substring time -2)))
6667 new)
6668 (put-text-property
6669 2 (length (car new)) 'face 'org-time-grid (car new))))
6670 (when (and todayp org-agenda-show-current-time-in-grid)
6671 (push (org-agenda-format-item
6672 nil org-agenda-current-time-string nil "" nil
6673 (format-time-string "%H:%M "))
6674 new)
6675 (put-text-property
6676 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6678 (if (member 'time-up org-agenda-sorting-strategy-selected)
6679 (append new list)
6680 (append list new)))))
6682 (defun org-compile-prefix-format (key)
6683 "Compile the prefix format into a Lisp form that can be evaluated.
6684 The resulting form and associated variable bindings is returned
6685 and stored in the variable `org-prefix-format-compiled'."
6686 (setq org-prefix-has-time nil
6687 org-prefix-has-tag nil
6688 org-prefix-category-length nil
6689 org-prefix-has-effort nil
6690 org-prefix-has-breadcrumbs nil)
6691 (let ((s (cond
6692 ((stringp org-agenda-prefix-format)
6693 org-agenda-prefix-format)
6694 ((assq key org-agenda-prefix-format)
6695 (cdr (assq key org-agenda-prefix-format)))
6696 (t " %-12:c%?-12t% s")))
6697 (start 0)
6698 varform vars var e c f opt)
6699 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6700 s start)
6701 (setq var (or (cdr (assoc (match-string 4 s)
6702 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6703 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6704 'eval)
6705 c (or (match-string 3 s) "")
6706 opt (match-beginning 1)
6707 start (1+ (match-beginning 0)))
6708 (if (equal var 'time) (setq org-prefix-has-time t))
6709 (if (equal var 'tag) (setq org-prefix-has-tag t))
6710 (if (equal var 'effort) (setq org-prefix-has-effort t))
6711 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6712 (setq f (concat "%" (match-string 2 s) "s"))
6713 (when (equal var 'category)
6714 (setq org-prefix-category-length
6715 (floor (abs (string-to-number (match-string 2 s)))))
6716 (setq org-prefix-category-max-length
6717 (let ((x (match-string 2 s)))
6718 (save-match-data
6719 (if (string-match "\\.[0-9]+" x)
6720 (string-to-number (substring (match-string 0 x) 1)))))))
6721 (if (eq var 'eval)
6722 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6723 (if opt
6724 (setq varform
6725 `(if (or (equal "" ,var) (equal nil ,var))
6727 (format ,f (concat ,var ,c))))
6728 (setq varform
6729 `(format ,f (if (or (equal ,var "")
6730 (equal ,var nil)) ""
6731 (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6732 (setq s (replace-match "%s" t nil s))
6733 (push varform vars))
6734 (setq vars (nreverse vars))
6735 (with-current-buffer (or org-agenda-buffer (current-buffer))
6736 (setq org-prefix-format-compiled
6737 (list
6738 `((org-prefix-has-time ,org-prefix-has-time)
6739 (org-prefix-has-tag ,org-prefix-has-tag)
6740 (org-prefix-category-length ,org-prefix-category-length)
6741 (org-prefix-has-effort ,org-prefix-has-effort)
6742 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6743 `(format ,s ,@vars))))))
6745 (defun org-set-sorting-strategy (key)
6746 (if (symbolp (car org-agenda-sorting-strategy))
6747 ;; the old format
6748 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6749 (setq org-agenda-sorting-strategy-selected
6750 (or (cdr (assq key org-agenda-sorting-strategy))
6751 (cdr (assq 'agenda org-agenda-sorting-strategy))
6752 '(time-up category-keep priority-down)))))
6754 (defun org-get-time-of-day (s &optional string mod24)
6755 "Check string S for a time of day.
6756 If found, return it as a military time number between 0 and 2400.
6757 If not found, return nil.
6758 The optional STRING argument forces conversion into a 5 character wide string
6759 HH:MM."
6760 (save-match-data
6761 (when
6762 (and
6763 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6764 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6765 (not (eq (get-text-property 1 'face s) 'org-link)))
6766 (let* ((h (string-to-number (match-string 1 s)))
6767 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6768 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6769 (am-p (equal ampm "am"))
6770 (h1 (cond ((not ampm) h)
6771 ((= h 12) (if am-p 0 12))
6772 (t (+ h (if am-p 0 12)))))
6773 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6774 (mod h1 24) h1))
6775 (t0 (+ (* 100 h2) m))
6776 (t1 (concat (if (>= h1 24) "+" " ")
6777 (if (and org-agenda-time-leading-zero
6778 (< t0 1000)) "0" "")
6779 (if (< t0 100) "0" "")
6780 (if (< t0 10) "0" "")
6781 (int-to-string t0))))
6782 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6784 (defvar org-agenda-before-sorting-filter-function nil
6785 "Function to be applied to agenda items prior to sorting.
6786 Prior to sorting also means just before they are inserted into the agenda.
6788 To aid sorting, you may revisit the original entries and add more text
6789 properties which will later be used by the sorting functions.
6791 The function should take a string argument, an agenda line.
6792 It has access to the text properties in that line, which contain among
6793 other things, the property `org-hd-marker' that points to the entry
6794 where the line comes from. Note that not all lines going into the agenda
6795 have this property, only most.
6797 The function should return the modified string. It is probably best
6798 to ONLY change text properties.
6800 You can also use this function as a filter, by returning nil for lines
6801 you don't want to have in the agenda at all. For this application, you
6802 could bind the variable in the options section of a custom command.")
6804 (defun org-agenda-finalize-entries (list &optional type)
6805 "Sort, limit and concatenate the LIST of agenda items.
6806 The optional argument TYPE tells the agenda type."
6807 (let ((max-effort (cond ((listp org-agenda-max-effort)
6808 (cdr (assoc type org-agenda-max-effort)))
6809 (t org-agenda-max-effort)))
6810 (max-todo (cond ((listp org-agenda-max-todos)
6811 (cdr (assoc type org-agenda-max-todos)))
6812 (t org-agenda-max-todos)))
6813 (max-tags (cond ((listp org-agenda-max-tags)
6814 (cdr (assoc type org-agenda-max-tags)))
6815 (t org-agenda-max-tags)))
6816 (max-entries (cond ((listp org-agenda-max-entries)
6817 (cdr (assoc type org-agenda-max-entries)))
6818 (t org-agenda-max-entries))))
6819 (when org-agenda-before-sorting-filter-function
6820 (setq list
6821 (delq nil
6822 (mapcar
6823 org-agenda-before-sorting-filter-function list))))
6824 (setq list (mapcar 'org-agenda-highlight-todo list)
6825 list (mapcar 'identity (sort list 'org-entries-lessp)))
6826 (when max-effort
6827 (setq list (org-agenda-limit-entries
6828 list 'effort-minutes max-effort
6829 (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
6830 32767 -1))))))
6831 (when max-todo
6832 (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
6833 (when max-tags
6834 (setq list (org-agenda-limit-entries list 'tags max-tags)))
6835 (when max-entries
6836 (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
6837 (mapconcat 'identity list "\n")))
6839 (defun org-agenda-limit-entries (list prop limit &optional fn)
6840 "Limit the number of agenda entries."
6841 (let ((include (and limit (< limit 0))))
6842 (if limit
6843 (let ((fun (or fn (lambda (p) (if p 1))))
6844 (lim 0))
6845 (delq nil
6846 (mapcar
6847 (lambda (e)
6848 (let ((pval (funcall
6849 fun (get-text-property (1- (length e))
6850 prop e))))
6851 (if pval (setq lim (+ lim pval)))
6852 (cond ((and pval (<= lim (abs limit))) e)
6853 ((and include (not pval)) e))))
6854 list)))
6855 list)))
6857 (defun org-agenda-limit-interactively (remove)
6858 "In agenda, interactively limit entries to various maximums."
6859 (interactive "P")
6860 (if remove
6861 (progn (setq org-agenda-max-entries nil
6862 org-agenda-max-todos nil
6863 org-agenda-max-tags nil
6864 org-agenda-max-effort nil)
6865 (org-agenda-redo))
6866 (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
6867 (msg (cond ((= max ?E) "How many minutes? ")
6868 ((= max ?e) "How many entries? ")
6869 ((= max ?t) "How many TODO entries? ")
6870 ((= max ?T) "How many tagged entries? ")
6871 (t (user-error "Wrong input"))))
6872 (num (string-to-number (read-from-minibuffer msg))))
6873 (cond ((equal max ?e)
6874 (let ((org-agenda-max-entries num)) (org-agenda-redo)))
6875 ((equal max ?t)
6876 (let ((org-agenda-max-todos num)) (org-agenda-redo)))
6877 ((equal max ?T)
6878 (let ((org-agenda-max-tags num)) (org-agenda-redo)))
6879 ((equal max ?E)
6880 (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
6881 (org-agenda-fit-window-to-buffer))
6883 (defun org-agenda-highlight-todo (x)
6884 (let ((org-done-keywords org-done-keywords-for-agenda)
6885 (case-fold-search nil)
6887 (if (eq x 'line)
6888 (save-excursion
6889 (beginning-of-line 1)
6890 (setq re (org-get-at-bol 'org-todo-regexp))
6891 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6892 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6893 (add-text-properties (match-beginning 0) (match-end 1)
6894 (list 'face (org-get-todo-face 1)))
6895 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6896 (delete-region (match-beginning 1) (1- (match-end 0)))
6897 (goto-char (match-beginning 1))
6898 (insert (format org-agenda-todo-keyword-format s)))))
6899 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6900 (setq re (get-text-property 0 'org-todo-regexp x))
6901 (when (and re
6902 ;; Test `pl' because if there's no heading content,
6903 ;; there's no point matching to highlight. Note
6904 ;; that if we didn't test `pl' first, and there
6905 ;; happened to be no keyword from `org-todo-regexp'
6906 ;; on this heading line, then the `equal' comparison
6907 ;; afterwards would spuriously succeed in the case
6908 ;; where `pl' is nil -- causing an args-out-of-range
6909 ;; error when we try to add text properties to text
6910 ;; that isn't there.
6912 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6913 x pl) pl))
6914 (add-text-properties
6915 (or (match-end 1) (match-end 0)) (match-end 0)
6916 (list 'face (org-get-todo-face (match-string 2 x)))
6918 (when (match-end 1)
6919 (setq x (concat (substring x 0 (match-end 1))
6920 (format org-agenda-todo-keyword-format
6921 (match-string 2 x))
6922 (org-add-props " " (text-properties-at 0 x))
6923 (substring x (match-end 3)))))))
6924 x)))
6926 (defsubst org-cmp-values (a b property)
6927 "Compare the numeric value of text PROPERTY for string A and B."
6928 (let ((pa (or (get-text-property (1- (length a)) property a) 0))
6929 (pb (or (get-text-property (1- (length b)) property b) 0)))
6930 (cond ((> pa pb) +1)
6931 ((< pa pb) -1))))
6933 (defsubst org-cmp-effort (a b)
6934 "Compare the effort values of string A and B."
6935 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6936 (ea (or (get-text-property (1- (length a)) 'effort-minutes a) def))
6937 (eb (or (get-text-property (1- (length b)) 'effort-minutes b) def)))
6938 (cond ((> ea eb) +1)
6939 ((< ea eb) -1))))
6941 (defsubst org-cmp-category (a b)
6942 "Compare the string values of categories of strings A and B."
6943 (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
6944 (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
6945 (cond ((string-lessp ca cb) -1)
6946 ((string-lessp cb ca) +1))))
6948 (defsubst org-cmp-todo-state (a b)
6949 "Compare the todo states of strings A and B."
6950 (let* ((ma (or (get-text-property 1 'org-marker a)
6951 (get-text-property 1 'org-hd-marker a)))
6952 (mb (or (get-text-property 1 'org-marker b)
6953 (get-text-property 1 'org-hd-marker b)))
6954 (fa (and ma (marker-buffer ma)))
6955 (fb (and mb (marker-buffer mb)))
6956 (todo-kwds
6957 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6958 (and fb (with-current-buffer fb org-todo-keywords-1))))
6959 (ta (or (get-text-property 1 'todo-state a) ""))
6960 (tb (or (get-text-property 1 'todo-state b) ""))
6961 (la (- (length (member ta todo-kwds))))
6962 (lb (- (length (member tb todo-kwds))))
6963 (donepa (member ta org-done-keywords-for-agenda))
6964 (donepb (member tb org-done-keywords-for-agenda)))
6965 (cond ((and donepa (not donepb)) -1)
6966 ((and (not donepa) donepb) +1)
6967 ((< la lb) -1)
6968 ((< lb la) +1))))
6970 (defsubst org-cmp-alpha (a b)
6971 "Compare the headlines, alphabetically."
6972 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6973 (plb (text-property-any 0 (length b) 'org-heading t b))
6974 (ta (and pla (substring a pla)))
6975 (tb (and plb (substring b plb))))
6976 (when pla
6977 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6978 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6979 (setq ta (substring ta (match-end 0))))
6980 (setq ta (downcase ta)))
6981 (when plb
6982 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6983 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6984 (setq tb (substring tb (match-end 0))))
6985 (setq tb (downcase tb)))
6986 (cond ((not ta) +1)
6987 ((not tb) -1)
6988 ((string-lessp ta tb) -1)
6989 ((string-lessp tb ta) +1))))
6991 (defsubst org-cmp-tag (a b)
6992 "Compare the string values of the first tags of A and B."
6993 (let ((ta (car (last (get-text-property 1 'tags a))))
6994 (tb (car (last (get-text-property 1 'tags b)))))
6995 (cond ((not ta) +1)
6996 ((not tb) -1)
6997 ((string-lessp ta tb) -1)
6998 ((string-lessp tb ta) +1))))
7000 (defsubst org-cmp-time (a b)
7001 "Compare the time-of-day values of strings A and B."
7002 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
7003 (ta (or (get-text-property 1 'time-of-day a) def))
7004 (tb (or (get-text-property 1 'time-of-day b) def)))
7005 (cond ((< ta tb) -1)
7006 ((< tb ta) +1))))
7008 (defsubst org-cmp-ts (a b type)
7009 "Compare the timestamps values of entries A and B.
7010 When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
7011 \"timestamp_ia\", compare within each of these type. When TYPE
7012 is the empty string, compare all timestamps without respect of
7013 their type."
7014 (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
7015 (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
7016 (get-text-property 1 'ts-date a))
7017 def))
7018 (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
7019 (get-text-property 1 'ts-date b))
7020 def)))
7021 (cond ((< ta tb) -1)
7022 ((< tb ta) +1))))
7024 (defsubst org-cmp-habit-p (a b)
7025 "Compare the todo states of strings A and B."
7026 (let ((ha (get-text-property 1 'org-habit-p a))
7027 (hb (get-text-property 1 'org-habit-p b)))
7028 (cond ((and ha (not hb)) -1)
7029 ((and (not ha) hb) +1))))
7031 (defun org-entries-lessp (a b)
7032 "Predicate for sorting agenda entries."
7033 ;; The following variables will be used when the form is evaluated.
7034 ;; So even though the compiler complains, keep them.
7035 (let* ((ss org-agenda-sorting-strategy-selected)
7036 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
7037 (org-cmp-ts a b "")))
7038 (timestamp-down (if timestamp-up (- timestamp-up) nil))
7039 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
7040 (org-cmp-ts a b "scheduled")))
7041 (scheduled-down (if scheduled-up (- scheduled-up) nil))
7042 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
7043 (org-cmp-ts a b "deadline")))
7044 (deadline-down (if deadline-up (- deadline-up) nil))
7045 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
7046 (org-cmp-ts a b "timestamp_ia")))
7047 (tsia-down (if tsia-up (- tsia-up) nil))
7048 (ts-up (and (org-em 'ts-up 'ts-down ss)
7049 (org-cmp-ts a b "timestamp")))
7050 (ts-down (if ts-up (- ts-up) nil))
7051 (time-up (and (org-em 'time-up 'time-down ss)
7052 (org-cmp-time a b)))
7053 (time-down (if time-up (- time-up) nil))
7054 (stats-up (and (org-em 'stats-up 'stats-down ss)
7055 (org-cmp-values a b 'org-stats)))
7056 (stats-down (if stats-up (- stats-up) nil))
7057 (priority-up (and (org-em 'priority-up 'priority-down ss)
7058 (org-cmp-values a b 'priority)))
7059 (priority-down (if priority-up (- priority-up) nil))
7060 (effort-up (and (org-em 'effort-up 'effort-down ss)
7061 (org-cmp-effort a b)))
7062 (effort-down (if effort-up (- effort-up) nil))
7063 (category-up (and (or (org-em 'category-up 'category-down ss)
7064 (memq 'category-keep ss))
7065 (org-cmp-category a b)))
7066 (category-down (if category-up (- category-up) nil))
7067 (category-keep (if category-up +1 nil))
7068 (tag-up (and (org-em 'tag-up 'tag-down ss)
7069 (org-cmp-tag a b)))
7070 (tag-down (if tag-up (- tag-up) nil))
7071 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
7072 (org-cmp-todo-state a b)))
7073 (todo-state-down (if todo-state-up (- todo-state-up) nil))
7074 (habit-up (and (org-em 'habit-up 'habit-down ss)
7075 (org-cmp-habit-p a b)))
7076 (habit-down (if habit-up (- habit-up) nil))
7077 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
7078 (org-cmp-alpha a b)))
7079 (alpha-down (if alpha-up (- alpha-up) nil))
7080 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
7081 user-defined-up user-defined-down)
7082 (if (and need-user-cmp org-agenda-cmp-user-defined
7083 (functionp org-agenda-cmp-user-defined))
7084 (setq user-defined-up
7085 (funcall org-agenda-cmp-user-defined a b)
7086 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7087 (cdr (assoc
7088 (eval (cons 'or org-agenda-sorting-strategy-selected))
7089 '((-1 . t) (1 . nil) (nil . nil))))))
7091 ;;; Agenda restriction lock
7093 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7094 "Overlay to mark the headline to which agenda commands are restricted.")
7095 (overlay-put org-agenda-restriction-lock-overlay
7096 'face 'org-agenda-restriction-lock)
7097 (overlay-put org-agenda-restriction-lock-overlay
7098 'help-echo "Agendas are currently limited to this subtree.")
7099 (org-detach-overlay org-agenda-restriction-lock-overlay)
7101 ;;;###autoload
7102 (defun org-agenda-set-restriction-lock (&optional type)
7103 "Set restriction lock for agenda, to current subtree or file.
7104 Restriction will be the file if TYPE is `file', or if type is the
7105 universal prefix '(4), or if the cursor is before the first headline
7106 in the file. Otherwise, restriction will be to the current subtree."
7107 (interactive "P")
7108 (org-agenda-remove-restriction-lock 'noupdate)
7109 (and (equal type '(4)) (setq type 'file))
7110 (setq type (cond
7111 (type type)
7112 ((org-at-heading-p) 'subtree)
7113 ((condition-case nil (org-back-to-heading t) (error nil))
7114 'subtree)
7115 (t 'file)))
7116 (if (eq type 'subtree)
7117 (progn
7118 (setq org-agenda-restrict (current-buffer))
7119 (setq org-agenda-overriding-restriction 'subtree)
7120 (put 'org-agenda-files 'org-restrict
7121 (list (buffer-file-name (buffer-base-buffer))))
7122 (org-back-to-heading t)
7123 (move-overlay org-agenda-restriction-lock-overlay
7124 (point)
7125 (if org-agenda-restriction-lock-highlight-subtree
7126 (save-excursion (org-end-of-subtree t t) (point))
7127 (point-at-eol)))
7128 (move-marker org-agenda-restrict-begin (point))
7129 (move-marker org-agenda-restrict-end
7130 (save-excursion (org-end-of-subtree t t)))
7131 (message "Locking agenda restriction to subtree"))
7132 (put 'org-agenda-files 'org-restrict
7133 (list (buffer-file-name (buffer-base-buffer))))
7134 (setq org-agenda-restrict nil)
7135 (setq org-agenda-overriding-restriction 'file)
7136 (move-marker org-agenda-restrict-begin nil)
7137 (move-marker org-agenda-restrict-end nil)
7138 (message "Locking agenda restriction to file"))
7139 (setq current-prefix-arg nil)
7140 (org-agenda-maybe-redo))
7142 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7143 "Remove the agenda restriction lock."
7144 (interactive "P")
7145 (org-detach-overlay org-agenda-restriction-lock-overlay)
7146 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7147 (setq org-agenda-overriding-restriction nil)
7148 (setq org-agenda-restrict nil)
7149 (put 'org-agenda-files 'org-restrict nil)
7150 (move-marker org-agenda-restrict-begin nil)
7151 (move-marker org-agenda-restrict-end nil)
7152 (setq current-prefix-arg nil)
7153 (message "Agenda restriction lock removed")
7154 (or noupdate (org-agenda-maybe-redo)))
7156 (defun org-agenda-maybe-redo ()
7157 "If there is any window showing the agenda view, update it."
7158 (let ((w (get-buffer-window org-agenda-buffer-name t))
7159 (w0 (selected-window)))
7160 (when w
7161 (select-window w)
7162 (org-agenda-redo)
7163 (select-window w0)
7164 (if org-agenda-overriding-restriction
7165 (message "Agenda view shifted to new %s restriction"
7166 org-agenda-overriding-restriction)
7167 (message "Agenda restriction lock removed")))))
7169 ;;; Agenda commands
7171 (defun org-agenda-check-type (error &rest types)
7172 "Check if agenda buffer is of allowed type.
7173 If ERROR is non-nil, throw an error, otherwise just return nil.
7174 Allowed types are 'agenda 'timeline 'todo 'tags 'search."
7175 (if (not org-agenda-type)
7176 (error "No Org agenda currently displayed")
7177 (if (memq org-agenda-type types)
7179 (if error
7180 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7181 nil))))
7183 (defun org-agenda-Quit ()
7184 "Exit the agenda, killing the agenda buffer.
7185 Like `org-agenda-quit', but kill the buffer even when
7186 `org-agenda-sticky' is non-nil."
7187 (interactive)
7188 (org-agenda--quit))
7190 (defun org-agenda-quit ()
7191 "Exit the agenda.
7193 When `org-agenda-sticky' is non-nil, bury the agenda buffer
7194 instead of killing it.
7196 When `org-agenda-restore-windows-after-quit' is non-nil, restore
7197 the pre-agenda window configuration.
7199 When column view is active, exit column view instead of the
7200 agenda."
7201 (interactive)
7202 (org-agenda--quit org-agenda-sticky))
7204 (defun org-agenda--quit (&optional bury)
7205 (if org-agenda-columns-active
7206 (org-columns-quit)
7207 (let ((buf (current-buffer))
7208 (wconf org-agenda-pre-window-conf)
7209 (org-agenda-last-indirect-window
7210 (and (eq org-indirect-buffer-display 'other-window)
7211 org-agenda-last-indirect-buffer
7212 (get-buffer-window org-agenda-last-indirect-buffer))))
7213 (cond
7214 ((eq org-agenda-window-setup 'other-frame)
7215 (delete-frame))
7216 ((and org-agenda-restore-windows-after-quit
7217 wconf)
7218 ;; Maybe restore the pre-agenda window configuration. Reset
7219 ;; `org-agenda-pre-window-conf' before running
7220 ;; `set-window-configuration', which loses the current buffer.
7221 (setq org-agenda-pre-window-conf nil)
7222 (set-window-configuration wconf))
7224 (when org-agenda-last-indirect-window
7225 (delete-window org-agenda-last-indirect-window))
7226 (and (not (eq org-agenda-window-setup 'current-window))
7227 (not (one-window-p))
7228 (delete-window))))
7229 (if bury
7230 (bury-buffer buf)
7231 (kill-buffer buf)
7232 (setq org-agenda-archives-mode nil
7233 org-agenda-buffer nil)))))
7235 (defun org-agenda-exit ()
7236 "Exit the agenda, killing Org buffers loaded by the agenda.
7237 Like `org-agenda-Quit', but kill any buffers that were created by
7238 the agenda. Org buffers visited directly by the user will not be
7239 touched. Also, exit the agenda even if it is in column view."
7240 (interactive)
7241 (when org-agenda-columns-active
7242 (org-columns-quit))
7243 (org-release-buffers org-agenda-new-buffers)
7244 (setq org-agenda-new-buffers nil)
7245 (org-agenda-Quit))
7247 (defun org-agenda-kill-all-agenda-buffers ()
7248 "Kill all buffers in `org-agenda-mode'.
7249 This is used when toggling sticky agendas.
7250 You can also explicitly invoke it with `C-c a C-k'."
7251 (interactive)
7252 (let (blist)
7253 (dolist (buf (buffer-list))
7254 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7255 (push buf blist)))
7256 (mapc 'kill-buffer blist)))
7258 (defun org-agenda-execute (arg)
7259 "Execute another agenda command, keeping same window.
7260 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7261 in the agenda."
7262 (interactive "P")
7263 (let ((org-agenda-window-setup 'current-window))
7264 (org-agenda arg)))
7266 (defun org-agenda-redo (&optional all)
7267 "Rebuild possibly ALL agenda view(s) in the current buffer."
7268 (interactive "P")
7269 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7270 (cpa (unless (eq all t) current-prefix-arg))
7271 (org-agenda-doing-sticky-redo org-agenda-sticky)
7272 (org-agenda-sticky nil)
7273 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7274 org-agenda-buffer-name))
7275 (org-agenda-keep-modes t)
7276 (tag-filter org-agenda-tag-filter)
7277 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7278 (top-hl-filter org-agenda-top-headline-filter)
7279 (cat-filter org-agenda-category-filter)
7280 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7281 (re-filter org-agenda-regexp-filter)
7282 (re-preset (get 'org-agenda-regexp-filter :preset-filter))
7283 (effort-filter org-agenda-effort-filter)
7284 (effort-preset (get 'org-agenda-effort-filter :preset-filter))
7285 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
7286 (cols org-agenda-columns-active)
7287 (line (org-current-line))
7288 (window-line (- line (org-current-line (window-start))))
7289 (lprops (get 'org-agenda-redo-command 'org-lprops))
7290 (redo-cmd (get-text-property p 'org-redo-cmd))
7291 (last-args (get-text-property p 'org-last-args))
7292 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7293 (org-agenda-overriding-cmd-arguments
7294 (unless (eq all t)
7295 (cond ((listp last-args)
7296 (cons (or cpa (car last-args)) (cdr last-args)))
7297 ((stringp last-args)
7298 last-args))))
7299 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7300 (put 'org-agenda-tag-filter :preset-filter nil)
7301 (put 'org-agenda-category-filter :preset-filter nil)
7302 (put 'org-agenda-regexp-filter :preset-filter nil)
7303 (put 'org-agenda-effort-filter :preset-filter nil)
7304 (and cols (org-columns-quit))
7305 (message "Rebuilding agenda buffer...")
7306 (if series-redo-cmd
7307 (eval series-redo-cmd)
7308 (org-let lprops redo-cmd))
7309 (setq org-agenda-undo-list nil
7310 org-agenda-pending-undo-list nil
7311 org-agenda-tag-filter tag-filter
7312 org-agenda-category-filter cat-filter
7313 org-agenda-regexp-filter re-filter
7314 org-agenda-effort-filter effort-filter
7315 org-agenda-top-headline-filter top-hl-filter)
7316 (message "Rebuilding agenda buffer...done")
7317 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7318 (put 'org-agenda-category-filter :preset-filter cat-preset)
7319 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7320 (put 'org-agenda-effort-filter :preset-filter effort-preset)
7321 (let ((tag (or tag-filter tag-preset))
7322 (cat (or cat-filter cat-preset))
7323 (effort (or effort-filter effort-preset))
7324 (re (or re-filter re-preset)))
7325 (when tag (org-agenda-filter-apply tag 'tag))
7326 (when cat (org-agenda-filter-apply cat 'category))
7327 (when effort (org-agenda-filter-apply effort 'effort))
7328 (when re (org-agenda-filter-apply re 'regexp)))
7329 (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
7330 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
7331 (org-goto-line line)
7332 (recenter window-line)))
7334 (defvar org-global-tags-completion-table nil)
7335 (defvar org-agenda-filter-form nil)
7336 (defvar org-agenda-filtered-by-category nil)
7338 (defun org-agenda-filter-by-category (strip)
7339 "Keep only those lines in the agenda buffer that have a specific category.
7340 The category is that of the current line."
7341 (interactive "P")
7342 (if (and org-agenda-filtered-by-category
7343 org-agenda-category-filter)
7344 (org-agenda-filter-show-all-cat)
7345 (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
7346 (cond
7347 ((and cat strip)
7348 (org-agenda-filter-apply
7349 (push (concat "-" cat) org-agenda-category-filter) 'category))
7350 ((and cat)
7351 (org-agenda-filter-apply
7352 (setq org-agenda-category-filter
7353 (list (concat "+" cat))) 'category))
7354 (t (error "No category at point"))))))
7356 (defun org-find-top-headline (&optional pos)
7357 "Find the topmost parent headline and return it."
7358 (save-excursion
7359 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
7360 (if pos (goto-char pos))
7361 ;; Skip up to the topmost parent
7362 (while (ignore-errors (outline-up-heading 1) t))
7363 (ignore-errors
7364 (nth 4 (org-heading-components))))))
7366 (defvar org-agenda-filtered-by-top-headline nil)
7367 (defun org-agenda-filter-by-top-headline (strip)
7368 "Keep only those lines that are descendants from the same top headline.
7369 The top headline is that of the current line."
7370 (interactive "P")
7371 (if org-agenda-filtered-by-top-headline
7372 (progn
7373 (setq org-agenda-filtered-by-top-headline nil
7374 org-agenda-top-headline-filter nil)
7375 (org-agenda-filter-show-all-top-filter))
7376 (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
7377 (if toph (org-agenda-filter-top-headline-apply toph strip)
7378 (error "No top-level headline at point")))))
7380 (defvar org-agenda-regexp-filter nil)
7381 (defun org-agenda-filter-by-regexp (strip)
7382 "Filter agenda entries by a regular expression.
7383 Regexp filters are cumulative.
7384 With no prefix argument, keep entries matching the regexp.
7385 With one prefix argument, filter out entries matching the regexp.
7386 With two prefix arguments, remove the regexp filters."
7387 (interactive "P")
7388 (if (not (equal strip '(16)))
7389 (let ((flt (concat (if (equal strip '(4)) "-" "+")
7390 (read-from-minibuffer
7391 (if (equal strip '(4))
7392 "Filter out entries matching regexp: "
7393 "Narrow to entries matching regexp: ")))))
7394 (push flt org-agenda-regexp-filter)
7395 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
7396 (org-agenda-filter-show-all-re)
7397 (message "Regexp filter removed")))
7399 (defvar org-agenda-effort-filter nil)
7400 (defun org-agenda-filter-by-effort (strip)
7401 "Filter agenda entries by effort.
7402 With no prefix argument, keep entries matching the effort condition.
7403 With one prefix argument, filter out entries matching the condition.
7404 With two prefix arguments, remove the effort filters."
7405 (interactive "P")
7406 (cond ((member strip '(nil 4))
7407 (let ((efforts (org-split-string
7408 (or (cdr (assoc (concat org-effort-property "_ALL")
7409 org-global-properties))
7410 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7411 "")))
7412 (eff -1)
7413 effort-prompt op)
7414 (while (not (member op '(?< ?> ?=)))
7415 (setq op (read-char-exclusive "Effort operator? (> = or <)")))
7416 (loop for i from 0 to 9 do
7417 (setq effort-prompt
7418 (concat
7419 effort-prompt " ["
7420 (if (= i 9) "0" (int-to-string (1+ i)))
7421 "]" (nth i efforts))))
7422 (message "Effort %s%s" (char-to-string op) effort-prompt)
7423 (while (or (< eff 0) (> eff 9))
7424 (setq eff (string-to-number (char-to-string (read-char-exclusive)))))
7425 (setq org-agenda-effort-filter
7426 (list (concat (if strip "-" "+")
7427 (char-to-string op) (nth (1- eff) efforts))))
7428 (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
7429 (t (org-agenda-filter-show-all-effort)
7430 (message "Effort filter removed"))))
7432 (defun org-agenda-filter-remove-all ()
7433 "Remove all filters from the current agenda buffer."
7434 (interactive)
7435 (when org-agenda-tag-filter
7436 (org-agenda-filter-show-all-tag))
7437 (when org-agenda-category-filter
7438 (org-agenda-filter-show-all-cat))
7439 (when org-agenda-regexp-filter
7440 (org-agenda-filter-show-all-re))
7441 (when org-agenda-top-headline-filter
7442 (org-agenda-filter-show-all-top-filter))
7443 (when org-agenda-effort-filter
7444 (org-agenda-filter-show-all-effort))
7445 (org-agenda-finalize))
7447 (defun org-agenda-filter-by-tag (strip &optional char narrow)
7448 "Keep only those lines in the agenda buffer that have a specific tag.
7449 The tag is selected with its fast selection letter, as configured.
7450 With prefix argument STRIP, remove all lines that do have the tag.
7451 A lisp caller can specify CHAR. NARROW means that the new tag should be
7452 used to narrow the search - the interactive user can also press `-' or `+'
7453 to switch to narrowing."
7454 (interactive "P")
7455 (let* ((alist org-tag-alist-for-agenda)
7456 (tag-chars (mapconcat
7457 (lambda (x) (if (and (not (symbolp (car x)))
7458 (cdr x))
7459 (char-to-string (cdr x))
7460 ""))
7461 alist ""))
7462 (inhibit-read-only t)
7463 (current org-agenda-tag-filter)
7464 a n tag)
7465 (unless char
7466 (message
7467 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow"
7468 (if narrow "Narrow" "Filter") tag-chars
7469 (if org-agenda-auto-exclude-function "[RET], " ""))
7470 (setq char (read-char-exclusive)))
7471 (when (member char '(?+ ?-))
7472 ;; Narrowing down
7473 (cond ((equal char ?-) (setq strip t narrow t))
7474 ((equal char ?+) (setq strip nil narrow t)))
7475 (message
7476 "Narrow by tag [%s ], [TAB], [/]:off" tag-chars)
7477 (setq char (read-char-exclusive)))
7478 (when (equal char ?\t)
7479 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7480 (org-set-local 'org-global-tags-completion-table
7481 (org-global-tags-completion-table)))
7482 (let ((completion-ignore-case t))
7483 (setq tag (org-icompleting-read
7484 "Tag: " org-global-tags-completion-table))))
7485 (cond
7486 ((equal char ?\r)
7487 (org-agenda-filter-show-all-tag)
7488 (when org-agenda-auto-exclude-function
7489 (setq org-agenda-tag-filter nil)
7490 (dolist (tag (org-agenda-get-represented-tags))
7491 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7492 (if modifier
7493 (push modifier org-agenda-tag-filter))))
7494 (if (not (null org-agenda-tag-filter))
7495 (org-agenda-filter-apply org-agenda-tag-filter 'tag))))
7496 ((equal char ?/)
7497 (org-agenda-filter-show-all-tag)
7498 (when (get 'org-agenda-tag-filter :preset-filter)
7499 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
7500 ((equal char ?. )
7501 (setq org-agenda-tag-filter
7502 (mapcar (lambda(tag) (concat "+" tag))
7503 (org-get-at-bol 'tags)))
7504 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7505 ((or (equal char ?\ )
7506 (setq a (rassoc char alist))
7507 (and tag (setq a (cons tag nil))))
7508 (org-agenda-filter-show-all-tag)
7509 (setq tag (car a))
7510 (setq org-agenda-tag-filter
7511 (cons (concat (if strip "-" "+") tag)
7512 (if narrow current nil)))
7513 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7514 (t (error "Invalid tag selection character %c" char)))))
7516 (defun org-agenda-get-represented-tags ()
7517 "Get a list of all tags currently represented in the agenda."
7518 (let (p tags)
7519 (save-excursion
7520 (goto-char (point-min))
7521 (while (setq p (next-single-property-change (point) 'tags))
7522 (goto-char p)
7523 (mapc (lambda (x) (add-to-list 'tags x))
7524 (get-text-property (point) 'tags))))
7525 tags))
7527 (defun org-agenda-filter-by-tag-refine (strip &optional char)
7528 "Refine the current filter. See `org-agenda-filter-by-tag'."
7529 (interactive "P")
7530 (org-agenda-filter-by-tag strip char 'refine))
7532 (defun org-agenda-filter-make-matcher (filter type)
7533 "Create the form that tests a line for agenda filter."
7534 (let (f f1)
7535 (cond
7536 ;; Tag filter
7537 ((eq type 'tag)
7538 (setq filter
7539 (delete-dups
7540 (append (get 'org-agenda-tag-filter :preset-filter)
7541 filter)))
7542 (dolist (x filter)
7543 (let ((nfilter (org-agenda-filter-expand-tags filter)) nf nf1
7544 (ffunc
7545 (lambda (nf0 nf01 fltr notgroup op)
7546 (dolist (x fltr)
7547 (if (member x '("-" "+"))
7548 (setq nf01 (if (equal x "-") 'tags '(not tags)))
7549 (setq nf01 (list 'member (downcase (substring x 1))
7550 'tags))
7551 (when (equal (string-to-char x) ?-)
7552 (setq nf01 (list 'not nf01))
7553 (when (not notgroup) (setq op 'and))))
7554 (push nf01 nf0))
7555 (if notgroup
7556 (push (cons 'and nf0) f)
7557 (push (cons (or op 'or) nf0) f)))))
7558 (cond ((equal filter '("+"))
7559 (setq f (list (list 'not 'tags))))
7560 ((equal nfilter filter)
7561 (funcall ffunc f1 f filter t nil))
7562 (t (funcall ffunc nf1 nf nfilter nil nil))))))
7563 ;; Category filter
7564 ((eq type 'category)
7565 (setq filter
7566 (delete-dups
7567 (append (get 'org-agenda-category-filter :preset-filter)
7568 filter)))
7569 (dolist (x filter)
7570 (if (equal "-" (substring x 0 1))
7571 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7572 (setq f1 (list 'equal (substring x 1) 'cat)))
7573 (push f1 f)))
7574 ;; Regexp filter
7575 ((eq type 'regexp)
7576 (setq filter
7577 (delete-dups
7578 (append (get 'org-agenda-regexp-filter :preset-filter)
7579 filter)))
7580 (dolist (x filter)
7581 (if (equal "-" (substring x 0 1))
7582 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7583 (setq f1 (list 'string-match (substring x 1) 'txt)))
7584 (push f1 f)))
7585 ;; Effort filter
7586 ((eq type 'effort)
7587 (setq filter
7588 (delete-dups
7589 (append (get 'org-agenda-effort-filter :preset-filter)
7590 filter)))
7591 (dolist (x filter)
7592 (push (org-agenda-filter-effort-form x) f))))
7593 (cons 'and (nreverse f))))
7595 (defun org-agenda-filter-effort-form (e)
7596 "Return the form to compare the effort of the current line with what E says.
7597 E looks like \"+<2:25\"."
7598 (let (op)
7599 (setq e (substring e 1))
7600 (setq op (string-to-char e) e (substring e 1))
7601 (setq op (cond ((equal op ?<) '<=)
7602 ((equal op ?>) '>=)
7603 ((equal op ??) op)
7604 (t '=)))
7605 (list 'org-agenda-compare-effort (list 'quote op)
7606 (org-duration-string-to-minutes e))))
7608 (defun org-agenda-compare-effort (op value)
7609 "Compare the effort of the current line with VALUE, using OP.
7610 If the line does not have an effort defined, return nil."
7611 (let ((eff (org-get-at-eol 'effort-minutes 1)))
7612 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 -1))
7613 value)))
7615 (defun org-agenda-filter-expand-tags (filter &optional no-operator)
7616 "Expand group tags in FILTER for the agenda.
7617 When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
7618 (if org-group-tags
7619 (let ((case-fold-search t) rtn)
7620 (mapc
7621 (lambda (f)
7622 (let (f0 dir)
7623 (if (string-match "^\\([+-]\\)\\(.+\\)" f)
7624 (setq dir (match-string 1 f) f0 (match-string 2 f))
7625 (setq dir (if no-operator "" "+") f0 f))
7626 (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
7627 (org-tags-expand f0 t t))
7628 rtn))))
7629 filter)
7630 (reverse rtn))
7631 filter))
7633 (defun org-agenda-filter-apply (filter type)
7634 "Set FILTER as the new agenda filter and apply it."
7635 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7636 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7637 (let (tags cat txt)
7638 (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type))
7639 ;; Only set `org-agenda-filtered-by-category' to t when a unique
7640 ;; category is used as the filter:
7641 (setq org-agenda-filtered-by-category
7642 (and (eq type 'category)
7643 (not (equal (substring (car filter) 0 1) "-"))))
7644 (org-agenda-set-mode-name)
7645 (save-excursion
7646 (goto-char (point-min))
7647 (while (not (eobp))
7648 (if (org-get-at-bol 'org-marker)
7649 (progn
7650 (setq tags ; used in eval
7651 (apply 'append
7652 (mapcar (lambda (f)
7653 (org-agenda-filter-expand-tags (list f) t))
7654 (org-get-at-bol 'tags)))
7655 cat (org-get-at-eol 'org-category 1)
7656 txt (org-get-at-eol 'txt 1))
7657 (if (not (eval org-agenda-filter-form))
7658 (org-agenda-filter-hide-line type))
7659 (beginning-of-line 2))
7660 (beginning-of-line 2))))
7661 (if (get-char-property (point) 'invisible)
7662 (ignore-errors (org-agenda-previous-line)))))
7664 (defun org-agenda-filter-top-headline-apply (hl &optional negative)
7665 "Filter by top headline HL."
7666 (org-agenda-set-mode-name)
7667 (save-excursion
7668 (goto-char (point-min))
7669 (while (not (eobp))
7670 (let* ((pos (org-get-at-bol 'org-hd-marker))
7671 (tophl (and pos (org-find-top-headline pos))))
7672 (if (and tophl (funcall (if negative 'identity 'not)
7673 (string= hl tophl)))
7674 (org-agenda-filter-hide-line 'top-headline)))
7675 (beginning-of-line 2)))
7676 (if (get-char-property (point) 'invisible)
7677 (org-agenda-previous-line))
7678 (setq org-agenda-top-headline-filter hl
7679 org-agenda-filtered-by-top-headline t))
7681 (defun org-agenda-filter-hide-line (type)
7682 "Hide lines with TYPE in the agenda buffer."
7683 (let* ((b (max (point-min) (1- (point-at-bol))))
7684 (e (point-at-eol)))
7685 (let ((inhibit-read-only t))
7686 (add-text-properties
7687 b e `(invisible org-filtered org-filter-type ,type)))))
7689 (defun org-agenda-remove-filter (type)
7690 (interactive)
7691 "Remove filter of type TYPE from the agenda buffer."
7692 (save-excursion
7693 (goto-char (point-min))
7694 (let ((inhibit-read-only t) pos)
7695 (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
7696 (goto-char pos)
7697 (remove-text-properties
7698 (point) (next-single-property-change (point) 'org-filter-type)
7699 `(invisible org-filtered org-filter-type ,type))))
7700 (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
7701 (setq org-agenda-filter-form nil)
7702 (org-agenda-set-mode-name)
7703 (org-agenda-finalize)))
7705 (defun org-agenda-filter-show-all-tag nil
7706 (org-agenda-remove-filter 'tag))
7707 (defun org-agenda-filter-show-all-re nil
7708 (org-agenda-remove-filter 'regexp))
7709 (defun org-agenda-filter-show-all-effort nil
7710 (org-agenda-remove-filter 'effort))
7711 (defun org-agenda-filter-show-all-cat nil
7712 (org-agenda-remove-filter 'category))
7713 (defun org-agenda-filter-show-all-top-filter nil
7714 (org-agenda-remove-filter 'top-headline))
7716 (defun org-agenda-manipulate-query-add ()
7717 "Manipulate the query by adding a search term with positive selection.
7718 Positive selection means the term must be matched for selection of an entry."
7719 (interactive)
7720 (org-agenda-manipulate-query ?\[))
7721 (defun org-agenda-manipulate-query-subtract ()
7722 "Manipulate the query by adding a search term with negative selection.
7723 Negative selection means term must not be matched for selection of an entry."
7724 (interactive)
7725 (org-agenda-manipulate-query ?\]))
7726 (defun org-agenda-manipulate-query-add-re ()
7727 "Manipulate the query by adding a search regexp with positive selection.
7728 Positive selection means the regexp must match for selection of an entry."
7729 (interactive)
7730 (org-agenda-manipulate-query ?\{))
7731 (defun org-agenda-manipulate-query-subtract-re ()
7732 "Manipulate the query by adding a search regexp with negative selection.
7733 Negative selection means regexp must not match for selection of an entry."
7734 (interactive)
7735 (org-agenda-manipulate-query ?\}))
7736 (defun org-agenda-manipulate-query (char)
7737 (cond
7738 ((memq org-agenda-type '(timeline agenda))
7739 (let ((org-agenda-include-inactive-timestamps t))
7740 (org-agenda-redo))
7741 (message "Display now includes inactive timestamps as well"))
7742 ((eq org-agenda-type 'search)
7743 (org-add-to-string
7744 'org-agenda-query-string
7745 (if org-agenda-last-search-view-search-was-boolean
7746 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7747 (?\{ . " +{}") (?\} . " -{}"))))
7748 " "))
7749 (setq org-agenda-redo-command
7750 (list 'org-search-view
7751 (car (get-text-property (min (1- (point-max)) (point))
7752 'org-last-args))
7753 org-agenda-query-string
7754 (+ (length org-agenda-query-string)
7755 (if (member char '(?\{ ?\})) 0 1))))
7756 (set-register org-agenda-query-register org-agenda-query-string)
7757 (let ((org-agenda-overriding-arguments
7758 (cdr org-agenda-redo-command)))
7759 (org-agenda-redo)))
7760 (t (error "Cannot manipulate query for %s-type agenda buffers"
7761 org-agenda-type))))
7763 (defun org-add-to-string (var string)
7764 (set var (concat (symbol-value var) string)))
7766 (defun org-agenda-goto-date (span)
7767 "Jump to DATE in agenda."
7768 (interactive "P")
7769 (let* ((org-read-date-prefer-future
7770 (eval org-agenda-jump-prefer-future))
7771 (date (org-read-date))
7772 (day (time-to-days (org-time-string-to-time date)))
7773 (org-agenda-sticky-orig org-agenda-sticky)
7774 (org-agenda-buffer-tmp-name (buffer-name))
7775 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7776 (0-arg (or current-prefix-arg (car args)))
7777 (2-arg (nth 2 args))
7778 (with-hour-p (nth 4 org-agenda-redo-command))
7779 (newcmd (list 'org-agenda-list 0-arg date
7780 (org-agenda-span-to-ndays
7781 2-arg (org-time-string-to-absolute date))
7782 with-hour-p))
7783 (newargs (cdr newcmd))
7784 (inhibit-read-only t)
7785 org-agenda-sticky)
7786 (if (not (org-agenda-check-type t 'agenda))
7787 (error "Not available in non-agenda views")
7788 (add-text-properties (point-min) (point-max)
7789 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7790 (org-agenda-redo)
7791 (goto-char (point-min))
7792 (while (not (or (= (or (get-text-property (point) 'day) 0) day)
7793 (save-excursion (move-beginning-of-line 2) (eobp))))
7794 (move-beginning-of-line 2))
7795 (setq org-agenda-sticky org-agenda-sticky-orig
7796 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7798 (defun org-agenda-goto-today ()
7799 "Go to today."
7800 (interactive)
7801 (org-agenda-check-type t 'timeline 'agenda)
7802 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7803 (curspan (nth 2 args))
7804 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7805 (cond
7806 (tdpos (goto-char tdpos))
7807 ((eq org-agenda-type 'agenda)
7808 (let* ((sd (org-agenda-compute-starting-span
7809 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7810 (org-agenda-overriding-arguments args))
7811 (setf (nth 1 org-agenda-overriding-arguments) sd)
7812 (org-agenda-redo)
7813 (org-agenda-find-same-or-today-or-agenda)))
7814 (t (error "Cannot find today")))))
7816 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7817 (goto-char
7818 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7819 (text-property-any (point-min) (point-max) 'org-today t)
7820 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7821 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7822 (org-agenda-backward-block))
7823 (point-min))))
7825 (defun org-agenda-backward-block ()
7826 "Move backward by one agenda block."
7827 (interactive)
7828 (org-agenda-forward-block 'backward))
7830 (defun org-agenda-forward-block (&optional backward)
7831 "Move forward by one agenda block.
7832 When optional argument BACKWARD is set, go backward"
7833 (interactive)
7834 (cond ((not (derived-mode-p 'org-agenda-mode))
7835 (user-error
7836 "Cannot execute this command outside of org-agenda-mode buffers"))
7837 ((looking-at (if backward "\\`" "\\'"))
7838 (message "Already at the %s block" (if backward "first" "last")))
7839 (t (let ((pos (prog1 (point)
7840 (ignore-errors (if backward (backward-char 1)
7841 (move-end-of-line 1)))))
7842 (f (if backward
7843 'previous-single-property-change
7844 'next-single-property-change))
7845 moved dest)
7846 (while (and (setq dest (funcall
7847 f (point) 'org-agenda-structural-header))
7848 (not (get-text-property
7849 (point) 'org-agenda-structural-header)))
7850 (setq moved t)
7851 (goto-char dest))
7852 (if moved (move-beginning-of-line 1)
7853 (goto-char (if backward (point-min) (point-max)))
7854 (move-beginning-of-line 1)
7855 (message "No %s block" (if backward "previous" "further")))))))
7857 (defun org-agenda-later (arg)
7858 "Go forward in time by the current span.
7859 With prefix ARG, go forward that many times the current span."
7860 (interactive "p")
7861 (org-agenda-check-type t 'agenda)
7862 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7863 (span (or (nth 2 args) org-agenda-current-span))
7864 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7865 (greg (calendar-gregorian-from-absolute sd))
7866 (cnt (org-get-at-bol 'org-day-cnt))
7867 greg2)
7868 (cond
7869 ((numberp span)
7870 (setq sd (+ (* span arg) sd)))
7871 ((eq span 'day)
7872 (setq sd (+ arg sd)))
7873 ((eq span 'week)
7874 (setq sd (+ (* 7 arg) sd)))
7875 ((eq span 'fortnight)
7876 (setq sd (+ (* 14 arg) sd)))
7877 ((eq span 'month)
7878 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7879 sd (calendar-absolute-from-gregorian greg2))
7880 (setcar greg2 (1+ (car greg2))))
7881 ((eq span 'year)
7882 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7883 sd (calendar-absolute-from-gregorian greg2))
7884 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7886 (setq sd (+ (* span arg) sd))))
7887 (let ((org-agenda-overriding-cmd
7888 ;; `cmd' may have been set by `org-agenda-run-series' which
7889 ;; uses `org-agenda-overriding-cmd' to decide whether
7890 ;; overriding is allowed for `cmd'
7891 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7892 (org-agenda-overriding-arguments
7893 (list (car args) sd span)))
7894 (org-agenda-redo)
7895 (org-agenda-find-same-or-today-or-agenda cnt))))
7897 (defun org-agenda-earlier (arg)
7898 "Go backward in time by the current span.
7899 With prefix ARG, go backward that many times the current span."
7900 (interactive "p")
7901 (org-agenda-later (- arg)))
7903 (defun org-agenda-view-mode-dispatch ()
7904 "Call one of the view mode commands."
7905 (interactive)
7906 (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
7907 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7908 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7909 (let ((a (read-char-exclusive)))
7910 (case a
7911 (?\ (call-interactively 'org-agenda-reset-view))
7912 (?d (call-interactively 'org-agenda-day-view))
7913 (?w (call-interactively 'org-agenda-week-view))
7914 (?t (call-interactively 'org-agenda-fortnight-view))
7915 (?m (call-interactively 'org-agenda-month-view))
7916 (?y (call-interactively 'org-agenda-year-view))
7917 (?l (call-interactively 'org-agenda-log-mode))
7918 (?L (org-agenda-log-mode '(4)))
7919 (?c (org-agenda-log-mode 'clockcheck))
7920 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7921 (?a (call-interactively 'org-agenda-archives-mode))
7922 (?A (org-agenda-archives-mode 'files))
7923 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7924 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7925 (?G (call-interactively 'org-agenda-toggle-time-grid))
7926 (?D (call-interactively 'org-agenda-toggle-diary))
7927 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7928 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7929 (org-agenda-check-type t 'timeline 'agenda)
7930 (org-agenda-redo))
7931 (message "Display now includes inactive timestamps as well"))
7932 (?q (message "Abort"))
7933 (otherwise (error "Invalid key" )))))
7935 (defun org-agenda-reset-view ()
7936 "Switch to default view for agenda."
7937 (interactive)
7938 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7939 (defun org-agenda-day-view (&optional day-of-month)
7940 "Switch to daily view for agenda.
7941 With argument DAY-OF-MONTH, switch to that day of the month."
7942 (interactive "P")
7943 (org-agenda-change-time-span 'day day-of-month))
7944 (defun org-agenda-week-view (&optional iso-week)
7945 "Switch to daily view for agenda.
7946 With argument ISO-WEEK, switch to the corresponding ISO week.
7947 If ISO-WEEK has more then 2 digits, only the last two encode the
7948 week. Any digits before this encode a year. So 200712 means
7949 week 12 of year 2007. Years in the range 1938-2037 can also be
7950 written as 2-digit years."
7951 (interactive "P")
7952 (org-agenda-change-time-span 'week iso-week))
7953 (defun org-agenda-fortnight-view (&optional iso-week)
7954 "Switch to daily view for agenda.
7955 With argument ISO-WEEK, switch to the corresponding ISO week.
7956 If ISO-WEEK has more then 2 digits, only the last two encode the
7957 week. Any digits before this encode a year. So 200712 means
7958 week 12 of year 2007. Years in the range 1938-2037 can also be
7959 written as 2-digit years."
7960 (interactive "P")
7961 (org-agenda-change-time-span 'fortnight iso-week))
7962 (defun org-agenda-month-view (&optional month)
7963 "Switch to monthly view for agenda.
7964 With argument MONTH, switch to that month."
7965 (interactive "P")
7966 (org-agenda-change-time-span 'month month))
7967 (defun org-agenda-year-view (&optional year)
7968 "Switch to yearly view for agenda.
7969 With argument YEAR, switch to that year.
7970 If MONTH has more then 2 digits, only the last two encode the
7971 month. Any digits before this encode a year. So 200712 means
7972 December year 2007. Years in the range 1938-2037 can also be
7973 written as 2-digit years."
7974 (interactive "P")
7975 (when year
7976 (setq year (org-small-year-to-year year)))
7977 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7978 (org-agenda-change-time-span 'year year)
7979 (error "Abort")))
7981 (defun org-agenda-change-time-span (span &optional n)
7982 "Change the agenda view to SPAN.
7983 SPAN may be `day', `week', `fortnight', `month', `year'."
7984 (org-agenda-check-type t 'agenda)
7985 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7986 (curspan (nth 2 args)))
7987 (if (and (not n) (equal curspan span))
7988 (error "Viewing span is already \"%s\"" span))
7989 (let* ((sd (or (org-get-at-bol 'day)
7990 (nth 1 args)
7991 org-starting-day))
7992 (sd (org-agenda-compute-starting-span sd span n))
7993 (org-agenda-overriding-cmd
7994 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7995 (org-agenda-overriding-arguments
7996 (list (car args) sd span)))
7997 (org-agenda-redo)
7998 (org-agenda-find-same-or-today-or-agenda))
7999 (org-agenda-set-mode-name)
8000 (message "Switched to %s view" span)))
8002 (defun org-agenda-compute-starting-span (sd span &optional n)
8003 "Compute starting date for agenda.
8004 SPAN may be `day', `week', `fortnight', `month', `year'. The return value
8005 is a cons cell with the starting date and the number of days,
8006 so that the date SD will be in that range."
8007 (let* ((greg (calendar-gregorian-from-absolute sd))
8008 (dg (nth 1 greg))
8009 (mg (car greg))
8010 (yg (nth 2 greg)))
8011 (cond
8012 ((eq span 'day)
8013 (when n
8014 (setq sd (+ (calendar-absolute-from-gregorian
8015 (list mg 1 yg))
8016 n -1))))
8017 ((or (eq span 'week) (eq span 'fortnight))
8018 (let* ((nt (calendar-day-of-week
8019 (calendar-gregorian-from-absolute sd)))
8020 (d (if org-agenda-start-on-weekday
8021 (- nt org-agenda-start-on-weekday)
8024 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
8025 (when n
8026 (require 'cal-iso)
8027 (when (> n 99)
8028 (setq y1 (org-small-year-to-year (/ n 100))
8029 n (mod n 100)))
8030 (setq sd
8031 (calendar-iso-to-absolute
8032 (list n 1
8033 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
8034 ((eq span 'month)
8035 (let (y1)
8036 (when (and n (> n 99))
8037 (setq y1 (org-small-year-to-year (/ n 100))
8038 n (mod n 100)))
8039 (setq sd (calendar-absolute-from-gregorian
8040 (list (or n mg) 1 (or y1 yg))))))
8041 ((eq span 'year)
8042 (setq sd (calendar-absolute-from-gregorian
8043 (list 1 1 (or n yg))))))
8044 sd))
8046 (defun org-agenda-next-date-line (&optional arg)
8047 "Jump to the next line indicating a date in agenda buffer."
8048 (interactive "p")
8049 (org-agenda-check-type t 'agenda 'timeline)
8050 (beginning-of-line 1)
8051 ;; This does not work if user makes date format that starts with a blank
8052 (if (looking-at "^\\S-") (forward-char 1))
8053 (if (not (re-search-forward "^\\S-" nil t arg))
8054 (progn
8055 (backward-char 1)
8056 (error "No next date after this line in this buffer")))
8057 (goto-char (match-beginning 0)))
8059 (defun org-agenda-previous-date-line (&optional arg)
8060 "Jump to the previous line indicating a date in agenda buffer."
8061 (interactive "p")
8062 (org-agenda-check-type t 'agenda 'timeline)
8063 (beginning-of-line 1)
8064 (if (not (re-search-backward "^\\S-" nil t arg))
8065 (error "No previous date before this line in this buffer")))
8067 ;; Initialize the highlight
8068 (defvar org-hl (make-overlay 1 1))
8069 (overlay-put org-hl 'face 'highlight)
8071 (defun org-highlight (begin end &optional buffer)
8072 "Highlight a region with overlay."
8073 (move-overlay org-hl begin end (or buffer (current-buffer))))
8075 (defun org-unhighlight ()
8076 "Detach overlay INDEX."
8077 (org-detach-overlay org-hl))
8079 (defun org-unhighlight-once ()
8080 "Remove the highlight from its position, and this function from the hook."
8081 (remove-hook 'pre-command-hook 'org-unhighlight-once)
8082 (org-unhighlight))
8084 (defvar org-agenda-pre-follow-window-conf nil)
8085 (defun org-agenda-follow-mode ()
8086 "Toggle follow mode in an agenda buffer."
8087 (interactive)
8088 (unless org-agenda-follow-mode
8089 (setq org-agenda-pre-follow-window-conf
8090 (current-window-configuration)))
8091 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
8092 (unless org-agenda-follow-mode
8093 (set-window-configuration org-agenda-pre-follow-window-conf))
8094 (org-agenda-set-mode-name)
8095 (org-agenda-do-context-action)
8096 (message "Follow mode is %s"
8097 (if org-agenda-follow-mode "on" "off")))
8099 (defun org-agenda-entry-text-mode (&optional arg)
8100 "Toggle entry text mode in an agenda buffer."
8101 (interactive "P")
8102 (if (or org-agenda-tag-filter
8103 org-agenda-category-filter
8104 org-agenda-regexp-filter
8105 org-agenda-top-headline-filter)
8106 (user-error "Can't show entry text in filtered views")
8107 (setq org-agenda-entry-text-mode (or (integerp arg)
8108 (not org-agenda-entry-text-mode)))
8109 (org-agenda-entry-text-hide)
8110 (and org-agenda-entry-text-mode
8111 (let ((org-agenda-entry-text-maxlines
8112 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
8113 (org-agenda-entry-text-show)))
8114 (org-agenda-set-mode-name)
8115 (message "Entry text mode is %s%s"
8116 (if org-agenda-entry-text-mode "on" "off")
8117 (if (not org-agenda-entry-text-mode) ""
8118 (format " (maximum number of lines is %d)"
8119 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
8121 (defun org-agenda-clockreport-mode ()
8122 "Toggle clocktable mode in an agenda buffer."
8123 (interactive)
8124 (org-agenda-check-type t 'agenda)
8125 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
8126 (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
8127 (org-agenda-set-mode-name)
8128 (org-agenda-redo)
8129 (message "Clocktable mode is %s"
8130 (if org-agenda-clockreport-mode "on" "off")))
8132 (defun org-agenda-log-mode (&optional special)
8133 "Toggle log mode in an agenda buffer.
8134 With argument SPECIAL, show all possible log items, not only the ones
8135 configured in `org-agenda-log-mode-items'.
8136 With a double `C-u' prefix arg, show *only* log items, nothing else."
8137 (interactive "P")
8138 (org-agenda-check-type t 'agenda 'timeline)
8139 (setq org-agenda-show-log
8140 (cond
8141 ((equal special '(16)) 'only)
8142 ((eq special 'clockcheck)
8143 (if (eq org-agenda-show-log 'clockcheck)
8144 nil 'clockcheck))
8145 (special '(closed clock state))
8146 (t (not org-agenda-show-log))))
8147 (setq org-agenda-start-with-log-mode org-agenda-show-log)
8148 (org-agenda-set-mode-name)
8149 (org-agenda-redo)
8150 (message "Log mode is %s"
8151 (if org-agenda-show-log "on" "off")))
8153 (defun org-agenda-archives-mode (&optional with-files)
8154 "Toggle inclusion of items in trees marked with :ARCHIVE:.
8155 When called with a prefix argument, include all archive files as well."
8156 (interactive "P")
8157 (setq org-agenda-archives-mode
8158 (if with-files t (if org-agenda-archives-mode nil 'trees)))
8159 (org-agenda-set-mode-name)
8160 (org-agenda-redo)
8161 (message
8162 "%s"
8163 (cond
8164 ((eq org-agenda-archives-mode nil)
8165 "No archives are included")
8166 ((eq org-agenda-archives-mode 'trees)
8167 (format "Trees with :%s: tag are included" org-archive-tag))
8168 ((eq org-agenda-archives-mode t)
8169 (format "Trees with :%s: tag and all active archive files are included"
8170 org-archive-tag)))))
8172 (defun org-agenda-toggle-diary ()
8173 "Toggle diary inclusion in an agenda buffer."
8174 (interactive)
8175 (org-agenda-check-type t 'agenda)
8176 (setq org-agenda-include-diary (not org-agenda-include-diary))
8177 (org-agenda-redo)
8178 (org-agenda-set-mode-name)
8179 (message "Diary inclusion turned %s"
8180 (if org-agenda-include-diary "on" "off")))
8182 (defun org-agenda-toggle-deadlines ()
8183 "Toggle inclusion of entries with a deadline in an agenda buffer."
8184 (interactive)
8185 (org-agenda-check-type t 'agenda)
8186 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8187 (org-agenda-redo)
8188 (org-agenda-set-mode-name)
8189 (message "Deadlines inclusion turned %s"
8190 (if org-agenda-include-deadlines "on" "off")))
8192 (defun org-agenda-toggle-time-grid ()
8193 "Toggle time grid in an agenda buffer."
8194 (interactive)
8195 (org-agenda-check-type t 'agenda)
8196 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8197 (org-agenda-redo)
8198 (org-agenda-set-mode-name)
8199 (message "Time-grid turned %s"
8200 (if org-agenda-use-time-grid "on" "off")))
8202 (defun org-agenda-set-mode-name ()
8203 "Set the mode name to indicate all the small mode settings."
8204 (setq mode-name
8205 (list "Org-Agenda"
8206 (if (get 'org-agenda-files 'org-restrict) " []" "")
8208 '(:eval (org-agenda-span-name org-agenda-current-span))
8209 (if org-agenda-follow-mode " Follow" "")
8210 (if org-agenda-entry-text-mode " ETxt" "")
8211 (if org-agenda-include-diary " Diary" "")
8212 (if org-agenda-include-deadlines " Ddl" "")
8213 (if org-agenda-use-time-grid " Grid" "")
8214 (if (and (boundp 'org-habit-show-habits)
8215 org-habit-show-habits) " Habit" "")
8216 (cond
8217 ((consp org-agenda-show-log) " LogAll")
8218 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8219 (org-agenda-show-log " Log")
8220 (t ""))
8221 (if (or org-agenda-category-filter
8222 (get 'org-agenda-category-filter :preset-filter))
8223 '(:eval (org-propertize
8224 (concat " <"
8225 (mapconcat
8226 'identity
8227 (append
8228 (get 'org-agenda-category-filter :preset-filter)
8229 org-agenda-category-filter)
8231 ">")
8232 'face 'org-agenda-filter-category
8233 'help-echo "Category used in filtering")) "")
8234 (if (or org-agenda-tag-filter
8235 (get 'org-agenda-tag-filter :preset-filter))
8236 '(:eval (org-propertize
8237 (concat " {"
8238 (mapconcat
8239 'identity
8240 (append
8241 (get 'org-agenda-tag-filter :preset-filter)
8242 org-agenda-tag-filter)
8244 "}")
8245 'face 'org-agenda-filter-tags
8246 'help-echo "Tags used in filtering")) "")
8247 (if (or org-agenda-effort-filter
8248 (get 'org-agenda-effort-filter :preset-filter))
8249 '(:eval (org-propertize
8250 (concat " {"
8251 (mapconcat
8252 'identity
8253 (append
8254 (get 'org-agenda-effort-filter :preset-filter)
8255 org-agenda-effort-filter)
8257 "}")
8258 'face 'org-agenda-filter-effort
8259 'help-echo "Effort conditions used in filtering")) "")
8260 (if (or org-agenda-regexp-filter
8261 (get 'org-agenda-regexp-filter :preset-filter))
8262 '(:eval (org-propertize
8263 (concat " ["
8264 (mapconcat
8265 'identity
8266 (append
8267 (get 'org-agenda-regexp-filter :preset-filter)
8268 org-agenda-regexp-filter)
8270 "]")
8271 'face 'org-agenda-filter-regexp
8272 'help-echo "Regexp used in filtering")) "")
8273 (if org-agenda-archives-mode
8274 (if (eq org-agenda-archives-mode t)
8275 " Archives"
8276 (format " :%s:" org-archive-tag))
8278 (if org-agenda-clockreport-mode " Clock" "")))
8279 (force-mode-line-update))
8281 (define-obsolete-function-alias
8282 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8284 (defun org-agenda-update-agenda-type ()
8285 "Update the agenda type after each command."
8286 (setq org-agenda-type
8287 (or (get-text-property (point) 'org-agenda-type)
8288 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8290 (defun org-agenda-next-line ()
8291 "Move cursor to the next line, and show if follow mode is active."
8292 (interactive)
8293 (call-interactively 'next-line)
8294 (org-agenda-do-context-action))
8296 (defun org-agenda-previous-line ()
8297 "Move cursor to the previous line, and show if follow-mode is active."
8298 (interactive)
8299 (call-interactively 'previous-line)
8300 (org-agenda-do-context-action))
8302 (defun org-agenda-next-item (n)
8303 "Move cursor to next agenda item."
8304 (interactive "p")
8305 (let ((col (current-column)))
8306 (dotimes (c n)
8307 (when (next-single-property-change (point-at-eol) 'org-marker)
8308 (move-end-of-line 1)
8309 (goto-char (next-single-property-change (point) 'org-marker))))
8310 (org-move-to-column col))
8311 (org-agenda-do-context-action))
8313 (defun org-agenda-previous-item (n)
8314 "Move cursor to next agenda item."
8315 (interactive "p")
8316 (dotimes (c n)
8317 (let ((col (current-column))
8318 (goto (save-excursion
8319 (move-end-of-line 0)
8320 (previous-single-property-change (point) 'org-marker))))
8321 (if goto (goto-char goto))
8322 (org-move-to-column col)))
8323 (org-agenda-do-context-action))
8325 (defun org-agenda-do-context-action ()
8326 "Show outline path and, maybe, follow mode window."
8327 (let ((m (org-get-at-bol 'org-marker)))
8328 (when (and (markerp m) (marker-buffer m))
8329 (and org-agenda-follow-mode
8330 (if org-agenda-follow-indirect
8331 (org-agenda-tree-to-indirect-buffer nil)
8332 (org-agenda-show)))
8333 (and org-agenda-show-outline-path
8334 (org-with-point-at m (org-display-outline-path t))))))
8336 (defun org-agenda-show-tags ()
8337 "Show the tags applicable to the current item."
8338 (interactive)
8339 (let* ((tags (org-get-at-bol 'tags)))
8340 (if tags
8341 (message "Tags are :%s:"
8342 (org-no-properties (mapconcat 'identity tags ":")))
8343 (message "No tags associated with this line"))))
8345 (defun org-agenda-goto (&optional highlight)
8346 "Go to the entry at point in the corresponding Org-mode file."
8347 (interactive)
8348 (let* ((marker (or (org-get-at-bol 'org-marker)
8349 (org-agenda-error)))
8350 (buffer (marker-buffer marker))
8351 (pos (marker-position marker)))
8352 (switch-to-buffer-other-window buffer)
8353 (widen)
8354 (push-mark)
8355 (goto-char pos)
8356 (when (derived-mode-p 'org-mode)
8357 (org-show-context 'agenda)
8358 (save-excursion
8359 (and (outline-next-heading)
8360 (org-flag-heading nil)))) ; show the next heading
8361 (when (outline-invisible-p)
8362 (show-entry)) ; display invisible text
8363 (recenter (/ (window-height) 2))
8364 (org-back-to-heading t)
8365 (if (re-search-forward org-complex-heading-regexp nil t)
8366 (goto-char (match-beginning 4)))
8367 (run-hooks 'org-agenda-after-show-hook)
8368 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8370 (defvar org-agenda-after-show-hook nil
8371 "Normal hook run after an item has been shown from the agenda.
8372 Point is in the buffer where the item originated.")
8374 (defun org-agenda-kill ()
8375 "Kill the entry or subtree belonging to the current agenda entry."
8376 (interactive)
8377 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8378 (let* ((bufname-orig (buffer-name))
8379 (marker (or (org-get-at-bol 'org-marker)
8380 (org-agenda-error)))
8381 (buffer (marker-buffer marker))
8382 (pos (marker-position marker))
8383 (type (org-get-at-bol 'type))
8384 dbeg dend (n 0) conf)
8385 (org-with-remote-undo buffer
8386 (with-current-buffer buffer
8387 (save-excursion
8388 (goto-char pos)
8389 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8390 (setq dbeg (progn (org-back-to-heading t) (point))
8391 dend (org-end-of-subtree t t))
8392 (setq dbeg (point-at-bol)
8393 dend (min (point-max) (1+ (point-at-eol)))))
8394 (goto-char dbeg)
8395 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8396 (setq conf (or (eq t org-agenda-confirm-kill)
8397 (and (numberp org-agenda-confirm-kill)
8398 (> n org-agenda-confirm-kill))))
8399 (and conf
8400 (not (y-or-n-p
8401 (format "Delete entry with %d lines in buffer \"%s\"? "
8402 n (buffer-name buffer))))
8403 (error "Abort"))
8404 (let ((org-agenda-buffer-name bufname-orig))
8405 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8406 (with-current-buffer buffer (delete-region dbeg dend))
8407 (message "Agenda item and source killed"))))
8409 (defvar org-archive-default-command) ; defined in org-archive.el
8410 (defun org-agenda-archive-default ()
8411 "Archive the entry or subtree belonging to the current agenda entry."
8412 (interactive)
8413 (require 'org-archive)
8414 (org-agenda-archive-with org-archive-default-command))
8416 (defun org-agenda-archive-default-with-confirmation ()
8417 "Archive the entry or subtree belonging to the current agenda entry."
8418 (interactive)
8419 (require 'org-archive)
8420 (org-agenda-archive-with org-archive-default-command 'confirm))
8422 (defun org-agenda-archive ()
8423 "Archive the entry or subtree belonging to the current agenda entry."
8424 (interactive)
8425 (org-agenda-archive-with 'org-archive-subtree))
8427 (defun org-agenda-archive-to-archive-sibling ()
8428 "Move the entry to the archive sibling."
8429 (interactive)
8430 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8432 (defun org-agenda-archive-with (cmd &optional confirm)
8433 "Move the entry to the archive sibling."
8434 (interactive)
8435 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8436 (let* ((bufname-orig (buffer-name))
8437 (marker (or (org-get-at-bol 'org-marker)
8438 (org-agenda-error)))
8439 (buffer (marker-buffer marker))
8440 (pos (marker-position marker)))
8441 (org-with-remote-undo buffer
8442 (with-current-buffer buffer
8443 (if (derived-mode-p 'org-mode)
8444 (if (and confirm
8445 (not (y-or-n-p "Archive this subtree or entry? ")))
8446 (error "Abort")
8447 (save-window-excursion
8448 (goto-char pos)
8449 (let ((org-agenda-buffer-name bufname-orig))
8450 (org-remove-subtree-entries-from-agenda))
8451 (org-back-to-heading t)
8452 (funcall cmd)))
8453 (error "Archiving works only in Org-mode files"))))))
8455 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8456 "Remove all lines in the agenda that correspond to a given subtree.
8457 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8458 If this information is not given, the function uses the tree at point."
8459 (let ((buf (or buf (current-buffer))) m p)
8460 (save-excursion
8461 (unless (and beg end)
8462 (org-back-to-heading t)
8463 (setq beg (point))
8464 (org-end-of-subtree t)
8465 (setq end (point)))
8466 (set-buffer (get-buffer org-agenda-buffer-name))
8467 (save-excursion
8468 (goto-char (point-max))
8469 (beginning-of-line 1)
8470 (while (not (bobp))
8471 (when (and (setq m (org-get-at-bol 'org-marker))
8472 (equal buf (marker-buffer m))
8473 (setq p (marker-position m))
8474 (>= p beg)
8475 (< p end))
8476 (let ((inhibit-read-only t))
8477 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8478 (beginning-of-line 0))))))
8480 (defun org-agenda-refile (&optional goto rfloc no-update)
8481 "Refile the item at point.
8483 When GOTO is 0 or '(64) or \\[universal-argument] \\[universal-argument] \\[universal-argument], clear the refile cache.
8484 When GOTO is '(16) or \\[universal-argument] \\[universal-argument], go to the location of the last refiled item.
8485 RFLOC can be a refile location obtained in a different way.
8486 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8487 (interactive "P")
8488 (cond
8489 ((member goto '(0 (64)))
8490 (org-refile-cache-clear))
8491 ((equal goto '(16))
8492 (org-refile-goto-last-stored))
8494 (let* ((buffer-orig (buffer-name))
8495 (marker (or (org-get-at-bol 'org-hd-marker)
8496 (org-agenda-error)))
8497 (buffer (marker-buffer marker))
8498 (pos (marker-position marker))
8499 (rfloc (or rfloc
8500 (org-refile-get-location
8501 (if goto "Goto" "Refile to") buffer
8502 org-refile-allow-creating-parent-nodes))))
8503 (with-current-buffer buffer
8504 (save-excursion
8505 (save-restriction
8506 (widen)
8507 (goto-char marker)
8508 (let ((org-agenda-buffer-name buffer-orig))
8509 (org-remove-subtree-entries-from-agenda))
8510 (org-refile goto buffer rfloc)))))
8511 (unless no-update (org-agenda-redo)))))
8513 (defun org-agenda-open-link (&optional arg)
8514 "Open the link(s) in the current entry, if any.
8515 This looks for a link in the displayed line in the agenda.
8516 It also looks at the text of the entry itself."
8517 (interactive "P")
8518 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8519 (org-get-at-bol 'org-marker)))
8520 (buffer (and marker (marker-buffer marker)))
8521 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8522 (lkall (and buffer (org-offer-links-in-entry
8523 buffer marker arg prefix)))
8524 (lk0 (car lkall))
8525 (lk (if (stringp lk0) (list lk0) lk0))
8526 (lkend (cdr lkall))
8527 trg)
8528 (cond
8529 ((and buffer lk)
8530 (mapcar (lambda(l)
8531 (with-current-buffer buffer
8532 (setq trg (and (string-match org-bracket-link-regexp l)
8533 (match-string 1 l)))
8534 (if (or (not trg) (string-match org-any-link-re trg))
8535 (save-excursion
8536 (save-restriction
8537 (widen)
8538 (goto-char marker)
8539 (when (search-forward l nil lkend)
8540 (goto-char (match-beginning 0))
8541 (org-open-at-point))))
8542 ;; This is an internal link, widen the buffer
8543 (switch-to-buffer-other-window buffer)
8544 (widen)
8545 (goto-char marker)
8546 (when (search-forward l nil lkend)
8547 (goto-char (match-beginning 0))
8548 (org-open-at-point)))))
8549 lk))
8550 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8551 (save-excursion
8552 (beginning-of-line 1)
8553 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8554 (org-open-link-from-string (match-string 1)))
8555 (t (message "No link to open here")))))
8557 (defun org-agenda-copy-local-variable (var)
8558 "Get a variable from a referenced buffer and install it here."
8559 (let ((m (org-get-at-bol 'org-marker)))
8560 (when (and m (buffer-live-p (marker-buffer m)))
8561 (org-set-local var (with-current-buffer (marker-buffer m)
8562 (symbol-value var))))))
8564 (defun org-agenda-switch-to (&optional delete-other-windows)
8565 "Go to the Org-mode file which contains the item at point."
8566 (interactive)
8567 (if (and org-return-follows-link
8568 (not (org-get-at-bol 'org-marker))
8569 (org-in-regexp org-bracket-link-regexp))
8570 (org-open-link-from-string (match-string 0))
8571 (let* ((marker (or (org-get-at-bol 'org-marker)
8572 (org-agenda-error)))
8573 (buffer (marker-buffer marker))
8574 (pos (marker-position marker)))
8575 (org-pop-to-buffer-same-window buffer)
8576 (and delete-other-windows (delete-other-windows))
8577 (widen)
8578 (goto-char pos)
8579 (org-back-to-heading t)
8580 (when (derived-mode-p 'org-mode)
8581 (org-show-context 'agenda)
8582 (save-excursion
8583 (and (outline-next-heading)
8584 (org-flag-heading nil))) ; show the next heading
8585 (when (outline-invisible-p)
8586 (show-entry)) ; display invisible text
8587 (run-hooks 'org-agenda-after-show-hook)))))
8589 (defun org-agenda-goto-mouse (ev)
8590 "Go to the Org-mode file which contains the item at the mouse click."
8591 (interactive "e")
8592 (mouse-set-point ev)
8593 (org-agenda-goto))
8595 (defun org-agenda-show (&optional full-entry)
8596 "Display the Org-mode file which contains the item at point.
8597 With prefix argument FULL-ENTRY, make the entire entry visible
8598 if it was hidden in the outline."
8599 (interactive "P")
8600 (let ((win (selected-window)))
8601 (if full-entry
8602 (let ((org-show-entry-below t))
8603 (org-agenda-goto t))
8604 (org-agenda-goto t))
8605 (select-window win)))
8607 (defvar org-agenda-show-window nil)
8608 (defun org-agenda-show-and-scroll-up (&optional arg)
8609 "Display the Org-mode file which contains the item at point.
8610 When called repeatedly, scroll the window that is displaying the buffer.
8611 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8612 `show-subtree' to display the item, so that drawers and logbooks stay
8613 folded."
8614 (interactive "P")
8615 (let ((win (selected-window)))
8616 (if (and (window-live-p org-agenda-show-window)
8617 (eq this-command last-command))
8618 (progn
8619 (select-window org-agenda-show-window)
8620 (ignore-errors (scroll-up)))
8621 (org-agenda-goto t)
8622 (if arg (org-show-entry) (show-subtree))
8623 (setq org-agenda-show-window (selected-window)))
8624 (select-window win)))
8626 (defun org-agenda-show-scroll-down ()
8627 "Scroll down the window showing the agenda."
8628 (interactive)
8629 (let ((win (selected-window)))
8630 (when (window-live-p org-agenda-show-window)
8631 (select-window org-agenda-show-window)
8632 (ignore-errors (scroll-down))
8633 (select-window win))))
8635 (defun org-agenda-show-1 (&optional more)
8636 "Display the Org-mode file which contains the item at point.
8637 The prefix arg selects the amount of information to display:
8639 0 hide the subtree
8640 1 just show the entry according to defaults.
8641 2 show the children view
8642 3 show the subtree view
8643 4 show the entire subtree and any LOGBOOK drawers
8644 5 show the entire subtree and any drawers
8645 With prefix argument FULL-ENTRY, make the entire entry visible
8646 if it was hidden in the outline."
8647 (interactive "p")
8648 (let ((win (selected-window)))
8649 (org-agenda-goto t)
8650 (org-back-to-heading)
8651 (set-window-start (selected-window) (point-at-bol))
8652 (cond
8653 ((= more 0)
8654 (hide-subtree)
8655 (save-excursion
8656 (org-back-to-heading)
8657 (run-hook-with-args 'org-cycle-hook 'folded))
8658 (message "Remote: FOLDED"))
8659 ((and (org-called-interactively-p 'any) (= more 1))
8660 (message "Remote: show with default settings"))
8661 ((= more 2)
8662 (show-entry)
8663 (show-children)
8664 (save-excursion
8665 (org-back-to-heading)
8666 (run-hook-with-args 'org-cycle-hook 'children))
8667 (message "Remote: CHILDREN"))
8668 ((= more 3)
8669 (show-subtree)
8670 (save-excursion
8671 (org-back-to-heading)
8672 (run-hook-with-args 'org-cycle-hook 'subtree))
8673 (message "Remote: SUBTREE"))
8674 ((= more 4)
8675 (show-subtree)
8676 (save-excursion
8677 (org-back-to-heading)
8678 (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
8679 (message "Remote: SUBTREE AND LOGBOOK"))
8680 ((> more 4)
8681 (show-subtree)
8682 (message "Remote: SUBTREE AND ALL DRAWERS")))
8683 (select-window win)))
8685 (defvar org-agenda-cycle-counter nil)
8686 (defun org-agenda-cycle-show (&optional n)
8687 "Show the current entry in another window, with default settings.
8688 Default settings are taken from `org-show-hierarchy-above' and siblings.
8689 When use repeatedly in immediate succession, the remote entry will cycle
8690 through visibility
8692 children -> subtree -> folded
8694 When called with a numeric prefix arg, that arg will be passed through to
8695 `org-agenda-show-1'. For the interpretation of that argument, see the
8696 docstring of `org-agenda-show-1'."
8697 (interactive "P")
8698 (if (integerp n)
8699 (setq org-agenda-cycle-counter n)
8700 (if (not (eq last-command this-command))
8701 (setq org-agenda-cycle-counter 1)
8702 (if (equal org-agenda-cycle-counter 0)
8703 (setq org-agenda-cycle-counter 2)
8704 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8705 (if (> org-agenda-cycle-counter 3)
8706 (setq org-agenda-cycle-counter 0)))))
8707 (org-agenda-show-1 org-agenda-cycle-counter))
8709 (defun org-agenda-recenter (arg)
8710 "Display the Org-mode file which contains the item at point and recenter."
8711 (interactive "P")
8712 (let ((win (selected-window)))
8713 (org-agenda-goto t)
8714 (recenter arg)
8715 (select-window win)))
8717 (defun org-agenda-show-mouse (ev)
8718 "Display the Org-mode file which contains the item at the mouse click."
8719 (interactive "e")
8720 (mouse-set-point ev)
8721 (org-agenda-show))
8723 (defun org-agenda-check-no-diary ()
8724 "Check if the entry is a diary link and abort if yes."
8725 (if (org-get-at-bol 'org-agenda-diary-link)
8726 (org-agenda-error)))
8728 (defun org-agenda-error ()
8729 "Throw an error when a command is not allowed in the agenda."
8730 (user-error "Command not allowed in this line"))
8732 (defun org-agenda-tree-to-indirect-buffer (arg)
8733 "Show the subtree corresponding to the current entry in an indirect buffer.
8734 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8736 With a numerical prefix ARG, go up to this level and then take that tree.
8737 With a negative numeric ARG, go up by this number of levels.
8738 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8739 use the dedicated frame)."
8740 (interactive "P")
8741 (if current-prefix-arg
8742 (org-agenda-do-tree-to-indirect-buffer arg)
8743 (let ((agenda-buffer (buffer-name))
8744 (agenda-window (selected-window))
8745 (indirect-window
8746 (and org-last-indirect-buffer
8747 (get-buffer-window org-last-indirect-buffer))))
8748 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8749 (unless (or (eq org-indirect-buffer-display 'new-frame)
8750 (eq org-indirect-buffer-display 'dedicated-frame))
8751 (unwind-protect
8752 (unless (and indirect-window (window-live-p indirect-window))
8753 (setq indirect-window (split-window agenda-window)))
8754 (and indirect-window (select-window indirect-window))
8755 (switch-to-buffer org-last-indirect-buffer :norecord)
8756 (fit-window-to-buffer indirect-window)))
8757 (select-window (get-buffer-window agenda-buffer))
8758 (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
8760 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8761 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8762 (org-agenda-check-no-diary)
8763 (let* ((marker (or (org-get-at-bol 'org-marker)
8764 (org-agenda-error)))
8765 (buffer (marker-buffer marker))
8766 (pos (marker-position marker)))
8767 (with-current-buffer buffer
8768 (save-excursion
8769 (goto-char pos)
8770 (funcall 'org-tree-to-indirect-buffer arg)))))
8772 (defvar org-last-heading-marker (make-marker)
8773 "Marker pointing to the headline that last changed its TODO state
8774 by a remote command from the agenda.")
8776 (defun org-agenda-todo-nextset ()
8777 "Switch TODO entry to next sequence."
8778 (interactive)
8779 (org-agenda-todo 'nextset))
8781 (defun org-agenda-todo-previousset ()
8782 "Switch TODO entry to previous sequence."
8783 (interactive)
8784 (org-agenda-todo 'previousset))
8786 (defun org-agenda-todo (&optional arg)
8787 "Cycle TODO state of line at point, also in Org-mode file.
8788 This changes the line at point, all other lines in the agenda referring to
8789 the same tree node, and the headline of the tree node in the Org-mode file."
8790 (interactive "P")
8791 (org-agenda-check-no-diary)
8792 (let* ((col (current-column))
8793 (marker (or (org-get-at-bol 'org-marker)
8794 (org-agenda-error)))
8795 (buffer (marker-buffer marker))
8796 (pos (marker-position marker))
8797 (hdmarker (org-get-at-bol 'org-hd-marker))
8798 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
8799 (inhibit-read-only t)
8800 org-agenda-headline-snapshot-before-repeat newhead just-one)
8801 (org-with-remote-undo buffer
8802 (with-current-buffer buffer
8803 (widen)
8804 (goto-char pos)
8805 (org-show-context 'agenda)
8806 (save-excursion
8807 (and (outline-next-heading)
8808 (org-flag-heading nil))) ; show the next heading
8809 (let ((current-prefix-arg arg))
8810 (call-interactively 'org-todo))
8811 (and (bolp) (forward-char 1))
8812 (setq newhead (org-get-heading))
8813 (when (and (org-bound-and-true-p
8814 org-agenda-headline-snapshot-before-repeat)
8815 (not (equal org-agenda-headline-snapshot-before-repeat
8816 newhead))
8817 todayp)
8818 (setq newhead org-agenda-headline-snapshot-before-repeat
8819 just-one t))
8820 (save-excursion
8821 (org-back-to-heading)
8822 (move-marker org-last-heading-marker (point))))
8823 (beginning-of-line 1)
8824 (save-window-excursion
8825 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8826 (when (org-bound-and-true-p org-clock-out-when-done)
8827 (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
8828 newhead)
8829 (org-agenda-unmark-clocking-task))
8830 (org-move-to-column col)
8831 (org-agenda-mark-clocking-task))))
8833 (defun org-agenda-add-note (&optional arg)
8834 "Add a time-stamped note to the entry at point."
8835 (interactive "P")
8836 (org-agenda-check-no-diary)
8837 (let* ((marker (or (org-get-at-bol 'org-marker)
8838 (org-agenda-error)))
8839 (buffer (marker-buffer marker))
8840 (pos (marker-position marker))
8841 (hdmarker (org-get-at-bol 'org-hd-marker))
8842 (inhibit-read-only t))
8843 (with-current-buffer buffer
8844 (widen)
8845 (goto-char pos)
8846 (org-show-context 'agenda)
8847 (save-excursion
8848 (and (outline-next-heading)
8849 (org-flag-heading nil))) ; show the next heading
8850 (org-add-note))))
8852 (defun org-agenda-change-all-lines (newhead hdmarker
8853 &optional fixface just-this)
8854 "Change all lines in the agenda buffer which match HDMARKER.
8855 The new content of the line will be NEWHEAD (as modified by
8856 `org-agenda-format-item'). HDMARKER is checked with
8857 `equal' against all `org-hd-marker' text properties in the file.
8858 If FIXFACE is non-nil, the face of each item is modified according to
8859 the new TODO state.
8860 If JUST-THIS is non-nil, change just the current line, not all.
8861 If FORCE-TAGS is non nil, the car of it returns the new tags."
8862 (let* ((inhibit-read-only t)
8863 (line (org-current-line))
8864 (org-agenda-buffer (current-buffer))
8865 (thetags (with-current-buffer (marker-buffer hdmarker)
8866 (save-excursion (save-restriction (widen)
8867 (goto-char hdmarker)
8868 (org-get-tags-at)))))
8869 props m pl undone-face done-face finish new dotime level cat tags)
8870 (save-excursion
8871 (goto-char (point-max))
8872 (beginning-of-line 1)
8873 (while (not finish)
8874 (setq finish (bobp))
8875 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8876 (or (not just-this) (= (org-current-line) line))
8877 (equal m hdmarker))
8878 (setq props (text-properties-at (point))
8879 dotime (org-get-at-bol 'dotime)
8880 cat (org-get-at-eol 'org-category 1)
8881 level (org-get-at-bol 'level)
8882 tags thetags
8884 (let ((org-prefix-format-compiled
8885 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8886 org-prefix-format-compiled))
8887 (extra (org-get-at-bol 'extra)))
8888 (with-current-buffer (marker-buffer hdmarker)
8889 (save-excursion
8890 (save-restriction
8891 (widen)
8892 (org-agenda-format-item extra newhead level cat tags dotime)))))
8893 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8894 undone-face (org-get-at-bol 'undone-face)
8895 done-face (org-get-at-bol 'done-face))
8896 (beginning-of-line 1)
8897 (cond
8898 ((equal new "")
8899 (and (looking-at ".*\n?") (replace-match "")))
8900 ((looking-at ".*")
8901 (replace-match new t t)
8902 (beginning-of-line 1)
8903 (add-text-properties (point-at-bol) (point-at-eol) props)
8904 (when fixface
8905 (add-text-properties
8906 (point-at-bol) (point-at-eol)
8907 (list 'face
8908 (if org-last-todo-state-is-todo
8909 undone-face done-face))))
8910 (org-agenda-highlight-todo 'line)
8911 (beginning-of-line 1))
8912 (t (error "Line update did not work")))
8913 (save-restriction
8914 (narrow-to-region (point-at-bol) (point-at-eol))
8915 (org-agenda-finalize)))
8916 (beginning-of-line 0)))))
8918 (defun org-agenda-align-tags (&optional line)
8919 "Align all tags in agenda items to `org-agenda-tags-column'."
8920 (let ((inhibit-read-only t) l c)
8921 (save-excursion
8922 (goto-char (if line (point-at-bol) (point-min)))
8923 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8924 (if line (point-at-eol) nil) t)
8925 (add-text-properties
8926 (match-beginning 2) (match-end 2)
8927 (list 'face (delq nil (let ((prop (get-text-property
8928 (match-beginning 2) 'face)))
8929 (or (listp prop) (setq prop (list prop)))
8930 (if (memq 'org-tag prop)
8931 prop
8932 (cons 'org-tag prop))))))
8933 (setq l (- (match-end 2) (match-beginning 2))
8934 c (if (< org-agenda-tags-column 0)
8935 (- (abs org-agenda-tags-column) l)
8936 org-agenda-tags-column))
8937 (delete-region (match-beginning 1) (match-end 1))
8938 (goto-char (match-beginning 1))
8939 (insert (org-add-props
8940 (make-string (max 1 (- c (current-column))) ?\ )
8941 (plist-put (copy-sequence (text-properties-at (point)))
8942 'face nil))))
8943 (goto-char (point-min))
8944 (org-font-lock-add-tag-faces (point-max)))))
8946 (defun org-agenda-priority-up ()
8947 "Increase the priority of line at point, also in Org-mode file."
8948 (interactive)
8949 (org-agenda-priority 'up))
8951 (defun org-agenda-priority-down ()
8952 "Decrease the priority of line at point, also in Org-mode file."
8953 (interactive)
8954 (org-agenda-priority 'down))
8956 (defun org-agenda-priority (&optional force-direction)
8957 "Set the priority of line at point, also in Org-mode file.
8958 This changes the line at point, all other lines in the agenda referring to
8959 the same tree node, and the headline of the tree node in the Org-mode file.
8960 Called with a universal prefix arg, show the priority instead of setting it."
8961 (interactive "P")
8962 (if (equal force-direction '(4))
8963 (org-show-priority)
8964 (unless org-enable-priority-commands
8965 (error "Priority commands are disabled"))
8966 (org-agenda-check-no-diary)
8967 (let* ((col (current-column))
8968 (marker (or (org-get-at-bol 'org-marker)
8969 (org-agenda-error)))
8970 (hdmarker (org-get-at-bol 'org-hd-marker))
8971 (buffer (marker-buffer hdmarker))
8972 (pos (marker-position hdmarker))
8973 (inhibit-read-only t)
8974 newhead)
8975 (org-with-remote-undo buffer
8976 (with-current-buffer buffer
8977 (widen)
8978 (goto-char pos)
8979 (org-show-context 'agenda)
8980 (save-excursion
8981 (and (outline-next-heading)
8982 (org-flag-heading nil))) ; show the next heading
8983 (funcall 'org-priority force-direction)
8984 (end-of-line 1)
8985 (setq newhead (org-get-heading)))
8986 (org-agenda-change-all-lines newhead hdmarker)
8987 (org-move-to-column col)))))
8989 ;; FIXME: should fix the tags property of the agenda line.
8990 (defun org-agenda-set-tags (&optional tag onoff)
8991 "Set tags for the current headline."
8992 (interactive)
8993 (org-agenda-check-no-diary)
8994 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8995 (call-interactively 'org-change-tag-in-region)
8996 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8997 (org-agenda-error)))
8998 (buffer (marker-buffer hdmarker))
8999 (pos (marker-position hdmarker))
9000 (inhibit-read-only t)
9001 newhead)
9002 (org-with-remote-undo buffer
9003 (with-current-buffer buffer
9004 (widen)
9005 (goto-char pos)
9006 (save-excursion
9007 (org-show-context 'agenda))
9008 (save-excursion
9009 (and (outline-next-heading)
9010 (org-flag-heading nil))) ; show the next heading
9011 (goto-char pos)
9012 (if tag
9013 (org-toggle-tag tag onoff)
9014 (call-interactively 'org-set-tags))
9015 (end-of-line 1)
9016 (setq newhead (org-get-heading)))
9017 (org-agenda-change-all-lines newhead hdmarker)
9018 (beginning-of-line 1)))))
9020 (defun org-agenda-set-property ()
9021 "Set a property for the current headline."
9022 (interactive)
9023 (org-agenda-check-no-diary)
9024 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9025 (org-agenda-error)))
9026 (buffer (marker-buffer hdmarker))
9027 (pos (marker-position hdmarker))
9028 (inhibit-read-only t)
9029 newhead)
9030 (org-with-remote-undo buffer
9031 (with-current-buffer buffer
9032 (widen)
9033 (goto-char pos)
9034 (save-excursion
9035 (org-show-context 'agenda))
9036 (save-excursion
9037 (and (outline-next-heading)
9038 (org-flag-heading nil))) ; show the next heading
9039 (goto-char pos)
9040 (call-interactively 'org-set-property)))))
9042 (defun org-agenda-set-effort ()
9043 "Set the effort property for the current headline."
9044 (interactive)
9045 (org-agenda-check-no-diary)
9046 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9047 (org-agenda-error)))
9048 (buffer (marker-buffer hdmarker))
9049 (pos (marker-position hdmarker))
9050 (inhibit-read-only t)
9051 newhead)
9052 (org-with-remote-undo buffer
9053 (with-current-buffer buffer
9054 (widen)
9055 (goto-char pos)
9056 (save-excursion
9057 (org-show-context 'agenda))
9058 (save-excursion
9059 (and (outline-next-heading)
9060 (org-flag-heading nil))) ; show the next heading
9061 (goto-char pos)
9062 (call-interactively 'org-set-effort)
9063 (end-of-line 1)
9064 (setq newhead (org-get-heading)))
9065 (org-agenda-change-all-lines newhead hdmarker))))
9067 (defun org-agenda-toggle-archive-tag ()
9068 "Toggle the archive tag for the current entry."
9069 (interactive)
9070 (org-agenda-check-no-diary)
9071 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9072 (org-agenda-error)))
9073 (buffer (marker-buffer hdmarker))
9074 (pos (marker-position hdmarker))
9075 (inhibit-read-only t)
9076 newhead)
9077 (org-with-remote-undo buffer
9078 (with-current-buffer buffer
9079 (widen)
9080 (goto-char pos)
9081 (org-show-context 'agenda)
9082 (save-excursion
9083 (and (outline-next-heading)
9084 (org-flag-heading nil))) ; show the next heading
9085 (call-interactively 'org-toggle-archive-tag)
9086 (end-of-line 1)
9087 (setq newhead (org-get-heading)))
9088 (org-agenda-change-all-lines newhead hdmarker)
9089 (beginning-of-line 1))))
9091 (defun org-agenda-do-date-later (arg)
9092 (interactive "P")
9093 (cond
9094 ((or (equal arg '(16))
9095 (memq last-command
9096 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9097 (setq this-command 'org-agenda-date-later-minutes)
9098 (org-agenda-date-later-minutes 1))
9099 ((or (equal arg '(4))
9100 (memq last-command
9101 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9102 (setq this-command 'org-agenda-date-later-hours)
9103 (org-agenda-date-later-hours 1))
9105 (org-agenda-date-later (prefix-numeric-value arg)))))
9107 (defun org-agenda-do-date-earlier (arg)
9108 (interactive "P")
9109 (cond
9110 ((or (equal arg '(16))
9111 (memq last-command
9112 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9113 (setq this-command 'org-agenda-date-earlier-minutes)
9114 (org-agenda-date-earlier-minutes 1))
9115 ((or (equal arg '(4))
9116 (memq last-command
9117 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9118 (setq this-command 'org-agenda-date-earlier-hours)
9119 (org-agenda-date-earlier-hours 1))
9121 (org-agenda-date-earlier (prefix-numeric-value arg)))))
9123 (defun org-agenda-date-later (arg &optional what)
9124 "Change the date of this item to ARG day(s) later."
9125 (interactive "p")
9126 (org-agenda-check-type t 'agenda 'timeline)
9127 (org-agenda-check-no-diary)
9128 (let* ((marker (or (org-get-at-bol 'org-marker)
9129 (org-agenda-error)))
9130 (buffer (marker-buffer marker))
9131 (pos (marker-position marker))
9132 cdate today)
9133 (org-with-remote-undo buffer
9134 (with-current-buffer buffer
9135 (widen)
9136 (goto-char pos)
9137 (if (not (org-at-timestamp-p))
9138 (error "Cannot find time stamp"))
9139 (when (and org-agenda-move-date-from-past-immediately-to-today
9140 (equal arg 1)
9141 (or (not what) (eq what 'day))
9142 (not (save-match-data (org-at-date-range-p))))
9143 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
9144 cdate (calendar-absolute-from-gregorian
9145 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
9146 today (org-today))
9147 (if (> today cdate)
9148 ;; immediately shift to today
9149 (setq arg (- today cdate))))
9150 (org-timestamp-change arg (or what 'day))
9151 (when (and (org-at-date-range-p)
9152 (re-search-backward org-tr-regexp-both (point-at-bol)))
9153 (let ((end org-last-changed-timestamp))
9154 (org-timestamp-change arg (or what 'day))
9155 (setq org-last-changed-timestamp
9156 (concat org-last-changed-timestamp "--" end)))))
9157 (org-agenda-show-new-time marker org-last-changed-timestamp))
9158 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9160 (defun org-agenda-date-earlier (arg &optional what)
9161 "Change the date of this item to ARG day(s) earlier."
9162 (interactive "p")
9163 (org-agenda-date-later (- arg) what))
9165 (defun org-agenda-date-later-minutes (arg)
9166 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9167 (interactive "p")
9168 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9169 (org-agenda-date-later arg 'minute))
9171 (defun org-agenda-date-earlier-minutes (arg)
9172 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9173 (interactive "p")
9174 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9175 (org-agenda-date-earlier arg 'minute))
9177 (defun org-agenda-date-later-hours (arg)
9178 "Change the time of this item, in hour steps."
9179 (interactive "p")
9180 (org-agenda-date-later arg 'hour))
9182 (defun org-agenda-date-earlier-hours (arg)
9183 "Change the time of this item, in hour steps."
9184 (interactive "p")
9185 (org-agenda-date-earlier arg 'hour))
9187 (defun org-agenda-show-new-time (marker stamp &optional prefix)
9188 "Show new date stamp via text properties."
9189 ;; We use text properties to make this undoable
9190 (let ((inhibit-read-only t))
9191 (setq stamp (concat prefix " => " stamp " "))
9192 (save-excursion
9193 (goto-char (point-max))
9194 (while (not (bobp))
9195 (when (equal marker (org-get-at-bol 'org-marker))
9196 (remove-text-properties (point-at-bol) (point-at-eol) '(display))
9197 (org-move-to-column (- (window-width) (length stamp)) t)
9198 (if (featurep 'xemacs)
9199 ;; Use `duplicable' property to trigger undo recording
9200 (let ((ex (make-extent nil nil))
9201 (gl (make-glyph stamp)))
9202 (set-glyph-face gl 'secondary-selection)
9203 (set-extent-properties
9204 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9205 (insert-extent ex (1- (point)) (point-at-eol)))
9206 (add-text-properties
9207 (1- (point)) (point-at-eol)
9208 (list 'display (org-add-props stamp nil
9209 'face '(secondary-selection default)))))
9210 (beginning-of-line 1))
9211 (beginning-of-line 0)))))
9213 (defun org-agenda-date-prompt (arg)
9214 "Change the date of this item. Date is prompted for, with default today.
9215 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9216 be used to request time specification in the time stamp."
9217 (interactive "P")
9218 (org-agenda-check-type t 'agenda 'timeline)
9219 (org-agenda-check-no-diary)
9220 (let* ((marker (or (org-get-at-bol 'org-marker)
9221 (org-agenda-error)))
9222 (buffer (marker-buffer marker))
9223 (pos (marker-position marker)))
9224 (org-with-remote-undo buffer
9225 (with-current-buffer buffer
9226 (widen)
9227 (goto-char pos)
9228 (if (not (org-at-timestamp-p t))
9229 (error "Cannot find time stamp"))
9230 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9231 (org-agenda-show-new-time marker org-last-changed-timestamp))
9232 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9234 (defun org-agenda-schedule (arg &optional time)
9235 "Schedule the item at point.
9236 ARG is passed through to `org-schedule'."
9237 (interactive "P")
9238 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9239 (org-agenda-check-no-diary)
9240 (let* ((marker (or (org-get-at-bol 'org-marker)
9241 (org-agenda-error)))
9242 (type (marker-insertion-type marker))
9243 (buffer (marker-buffer marker))
9244 (pos (marker-position marker))
9246 (set-marker-insertion-type marker t)
9247 (org-with-remote-undo buffer
9248 (with-current-buffer buffer
9249 (widen)
9250 (goto-char pos)
9251 (setq ts (org-schedule arg time)))
9252 (org-agenda-show-new-time marker ts " S"))
9253 (message "%s" ts)))
9255 (defun org-agenda-deadline (arg &optional time)
9256 "Schedule the item at point.
9257 ARG is passed through to `org-deadline'."
9258 (interactive "P")
9259 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9260 (org-agenda-check-no-diary)
9261 (let* ((marker (or (org-get-at-bol 'org-marker)
9262 (org-agenda-error)))
9263 (buffer (marker-buffer marker))
9264 (pos (marker-position marker))
9266 (org-with-remote-undo buffer
9267 (with-current-buffer buffer
9268 (widen)
9269 (goto-char pos)
9270 (setq ts (org-deadline arg time)))
9271 (org-agenda-show-new-time marker ts " D"))
9272 (message "%s" ts)))
9274 (defun org-agenda-clock-in (&optional arg)
9275 "Start the clock on the currently selected item."
9276 (interactive "P")
9277 (org-agenda-check-no-diary)
9278 (if (equal arg '(4))
9279 (org-clock-in arg)
9280 (let* ((marker (or (org-get-at-bol 'org-marker)
9281 (org-agenda-error)))
9282 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9283 (pos (marker-position marker))
9284 (col (current-column))
9285 newhead)
9286 (org-with-remote-undo (marker-buffer marker)
9287 (with-current-buffer (marker-buffer marker)
9288 (widen)
9289 (goto-char pos)
9290 (org-show-context 'agenda)
9291 (org-show-entry)
9292 (org-cycle-hide-drawers 'children)
9293 (org-clock-in arg)
9294 (setq newhead (org-get-heading)))
9295 (org-agenda-change-all-lines newhead hdmarker))
9296 (org-move-to-column col))))
9298 (defun org-agenda-clock-out ()
9299 "Stop the currently running clock."
9300 (interactive)
9301 (unless (marker-buffer org-clock-marker)
9302 (error "No running clock"))
9303 (let ((marker (make-marker)) (col (current-column)) newhead)
9304 (org-with-remote-undo (marker-buffer org-clock-marker)
9305 (with-current-buffer (marker-buffer org-clock-marker)
9306 (save-excursion
9307 (save-restriction
9308 (widen)
9309 (goto-char org-clock-marker)
9310 (org-back-to-heading t)
9311 (move-marker marker (point))
9312 (org-clock-out)
9313 (setq newhead (org-get-heading))))))
9314 (org-agenda-change-all-lines newhead marker)
9315 (move-marker marker nil)
9316 (org-move-to-column col)
9317 (org-agenda-unmark-clocking-task)))
9319 (defun org-agenda-clock-cancel (&optional arg)
9320 "Cancel the currently running clock."
9321 (interactive "P")
9322 (unless (marker-buffer org-clock-marker)
9323 (user-error "No running clock"))
9324 (org-with-remote-undo (marker-buffer org-clock-marker)
9325 (org-clock-cancel)))
9327 (defun org-agenda-clock-goto ()
9328 "Jump to the currently clocked in task within the agenda.
9329 If the currently clocked in task is not listed in the agenda
9330 buffer, display it in another window."
9331 (interactive)
9332 (let (pos)
9333 (mapc (lambda (o)
9334 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9335 (setq pos (overlay-start o))))
9336 (overlays-in (point-min) (point-max)))
9337 (cond (pos (goto-char pos))
9338 ;; If the currently clocked entry is not in the agenda
9339 ;; buffer, we visit it in another window:
9340 (org-clock-current-task
9341 (org-switch-to-buffer-other-window (org-clock-goto)))
9342 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9344 (defun org-agenda-diary-entry-in-org-file ()
9345 "Make a diary entry in the file `org-agenda-diary-file'."
9346 (let (d1 d2 char (text "") dp1 dp2)
9347 (if (equal (buffer-name) "*Calendar*")
9348 (setq d1 (calendar-cursor-to-date t)
9349 d2 (car calendar-mark-ring))
9350 (setq dp1 (get-text-property (point-at-bol) 'day))
9351 (unless dp1 (user-error "No date defined in current line"))
9352 (setq d1 (calendar-gregorian-from-absolute dp1)
9353 d2 (and (ignore-errors (mark))
9354 (save-excursion
9355 (goto-char (mark))
9356 (setq dp2 (get-text-property (point-at-bol) 'day)))
9357 (calendar-gregorian-from-absolute dp2))))
9358 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9359 (setq char (read-char-exclusive))
9360 (cond
9361 ((equal char ?d)
9362 (setq text (read-string "Day entry: "))
9363 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9364 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9365 ((equal char ?a)
9366 (setq d1 (list (car d1) (nth 1 d1)
9367 (read-number (format "Reference year [%d]: " (nth 2 d1))
9368 (nth 2 d1))))
9369 (setq text (read-string "Anniversary (use %d to show years): "))
9370 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9371 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9372 ((equal char ?b)
9373 (setq text (read-string "Block entry: "))
9374 (unless (and d1 d2 (not (equal d1 d2)))
9375 (user-error "No block of days selected"))
9376 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9377 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9378 ((equal char ?j)
9379 (org-switch-to-buffer-other-window
9380 (find-file-noselect org-agenda-diary-file))
9381 (require 'org-datetree)
9382 (org-datetree-find-date-create d1)
9383 (org-reveal t))
9384 (t (user-error "Invalid selection character `%c'" char)))))
9386 (defcustom org-agenda-insert-diary-strategy 'date-tree
9387 "Where in `org-agenda-diary-file' should new entries be added?
9388 Valid values:
9390 date-tree in the date tree, as child of the date
9391 top-level as top-level entries at the end of the file."
9392 :group 'org-agenda
9393 :type '(choice
9394 (const :tag "in a date tree" date-tree)
9395 (const :tag "as top level at end of file" top-level)))
9397 (defcustom org-agenda-insert-diary-extract-time nil
9398 "Non-nil means extract any time specification from the diary entry."
9399 :group 'org-agenda
9400 :version "24.1"
9401 :type 'boolean)
9403 (defcustom org-agenda-bulk-mark-char ">"
9404 "A single-character string to be used as the bulk mark."
9405 :group 'org-agenda
9406 :version "24.1"
9407 :type 'string)
9409 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9410 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9411 If TEXT is not empty, it will become the headline of the new entry, and
9412 the resulting entry will not be shown. When TEXT is empty, switch to
9413 `org-agenda-diary-file' and let the user finish the entry there."
9414 (let ((cw (current-window-configuration)))
9415 (org-switch-to-buffer-other-window
9416 (find-file-noselect org-agenda-diary-file))
9417 (widen)
9418 (goto-char (point-min))
9419 (cond
9420 ((eq type 'anniversary)
9421 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9422 (progn
9423 (or (org-at-heading-p t)
9424 (progn
9425 (outline-next-heading)
9426 (insert "* Anniversaries\n\n")
9427 (beginning-of-line -1)))))
9428 (outline-next-heading)
9429 (org-back-over-empty-lines)
9430 (backward-char 1)
9431 (insert "\n")
9432 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9433 (nth 2 d1) (car d1) (nth 1 d1) text)))
9434 ((eq type 'day)
9435 (let ((org-prefix-has-time t)
9436 (org-agenda-time-leading-zero t)
9437 fmt time time2)
9438 (if org-agenda-insert-diary-extract-time
9439 ;; Use org-agenda-format-item to parse text for a time-range and
9440 ;; remove it. FIXME: This is a hack, we should refactor
9441 ;; that function to make time extraction available separately
9442 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9443 time (get-text-property 0 'time fmt)
9444 time2 (if (> (length time) 0)
9445 ;; split-string removes trailing ...... if
9446 ;; no end time given. First space
9447 ;; separates time from date.
9448 (concat " " (car (split-string time "\\.")))
9449 nil)
9450 text (get-text-property 0 'txt fmt)))
9451 (if (eq org-agenda-insert-diary-strategy 'top-level)
9452 (org-agenda-insert-diary-as-top-level text)
9453 (require 'org-datetree)
9454 (org-datetree-find-date-create d1)
9455 (org-agenda-insert-diary-make-new-entry text))
9456 (org-insert-time-stamp (org-time-from-absolute
9457 (calendar-absolute-from-gregorian d1))
9458 nil nil nil nil time2))
9459 (end-of-line 0))
9460 ((eq type 'block)
9461 (if (> (calendar-absolute-from-gregorian d1)
9462 (calendar-absolute-from-gregorian d2))
9463 (setq d1 (prog1 d2 (setq d2 d1))))
9464 (if (eq org-agenda-insert-diary-strategy 'top-level)
9465 (org-agenda-insert-diary-as-top-level text)
9466 (require 'org-datetree)
9467 (org-datetree-find-date-create d1)
9468 (org-agenda-insert-diary-make-new-entry text))
9469 (org-insert-time-stamp (org-time-from-absolute
9470 (calendar-absolute-from-gregorian d1)))
9471 (insert "--")
9472 (org-insert-time-stamp (org-time-from-absolute
9473 (calendar-absolute-from-gregorian d2)))
9474 (end-of-line 0)))
9475 (if (string-match "\\S-" text)
9476 (progn
9477 (set-window-configuration cw)
9478 (message "%s entry added to %s"
9479 (capitalize (symbol-name type))
9480 (abbreviate-file-name org-agenda-diary-file)))
9481 (org-reveal t)
9482 (message "Please finish entry here"))))
9484 (defun org-agenda-insert-diary-as-top-level (text)
9485 "Make new entry as a top-level entry at the end of the file.
9486 Add TEXT as headline, and position the cursor in the second line so that
9487 a timestamp can be added there."
9488 (widen)
9489 (goto-char (point-max))
9490 (or (bolp) (insert "\n"))
9491 (insert "* " text "\n")
9492 (if org-adapt-indentation (org-indent-to-column 2)))
9494 (defun org-agenda-insert-diary-make-new-entry (text)
9495 "Make a new entry with TEXT as the first child of the current subtree.
9496 Position the point in the heading's first body line so that
9497 a timestamp can be added there."
9498 (let (col)
9499 (org-with-wide-buffer
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)
9508 (forward-line)
9509 (when (org-looking-at-p org-planning-line-re) (forward-line))
9510 (when (looking-at org-property-drawer-re)
9511 (goto-char (match-end 0))
9512 (forward-line))
9513 (unless (bolp) (insert "\n"))
9514 (when org-adapt-indentation (org-indent-to-column col))
9515 (let ((org-show-following-heading t)
9516 (org-show-siblings t)
9517 (org-show-hierarchy-above t)
9518 (org-show-entry-below t))
9519 (org-show-context)))))
9521 (defun org-agenda-diary-entry ()
9522 "Make a diary entry, like the `i' command from the calendar.
9523 All the standard commands work: block, weekly etc.
9524 When `org-agenda-diary-file' points to a file,
9525 `org-agenda-diary-entry-in-org-file' is called instead to create
9526 entries in that Org-mode file."
9527 (interactive)
9528 (if (not (eq org-agenda-diary-file 'diary-file))
9529 (org-agenda-diary-entry-in-org-file)
9530 (require 'diary-lib)
9531 (let* ((char (progn
9532 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9533 (read-char-exclusive)))
9534 (cmd (cdr (assoc char
9535 '((?d . diary-insert-entry)
9536 (?w . diary-insert-weekly-entry)
9537 (?m . diary-insert-monthly-entry)
9538 (?y . diary-insert-yearly-entry)
9539 (?a . diary-insert-anniversary-entry)
9540 (?b . diary-insert-block-entry)
9541 (?c . diary-insert-cyclic-entry)))))
9542 (oldf (symbol-function 'calendar-cursor-to-date))
9543 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9544 (point (point))
9545 (mark (or (mark t) (point))))
9546 (unless cmd
9547 (user-error "No command associated with <%c>" char))
9548 (unless (and (get-text-property point 'day)
9549 (or (not (equal ?b char))
9550 (get-text-property mark 'day)))
9551 (user-error "Don't know which date to use for diary entry"))
9552 ;; We implement this by hacking the `calendar-cursor-to-date' function
9553 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9554 (let ((calendar-mark-ring
9555 (list (calendar-gregorian-from-absolute
9556 (or (get-text-property mark 'day)
9557 (get-text-property point 'day))))))
9558 (unwind-protect
9559 (progn
9560 (fset 'calendar-cursor-to-date
9561 (lambda (&optional error dummy)
9562 (calendar-gregorian-from-absolute
9563 (get-text-property point 'day))))
9564 (call-interactively cmd))
9565 (fset 'calendar-cursor-to-date oldf))))))
9567 (defun org-agenda-execute-calendar-command (cmd)
9568 "Execute a calendar command from the agenda with date from cursor."
9569 (org-agenda-check-type t 'agenda 'timeline)
9570 (require 'diary-lib)
9571 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9572 (user-error "Don't know which date to use for the calendar command"))
9573 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9574 (point (point))
9575 (date (calendar-gregorian-from-absolute
9576 (get-text-property point 'day)))
9577 ;; the following 2 vars are needed in the calendar
9578 (displayed-month (car date))
9579 (displayed-year (nth 2 date)))
9580 (unwind-protect
9581 (progn
9582 (fset 'calendar-cursor-to-date
9583 (lambda (&optional error dummy)
9584 (calendar-gregorian-from-absolute
9585 (get-text-property point 'day))))
9586 (call-interactively cmd))
9587 (fset 'calendar-cursor-to-date oldf))))
9589 (defun org-agenda-phases-of-moon ()
9590 "Display the phases of the moon for the 3 months around the cursor date."
9591 (interactive)
9592 (org-agenda-execute-calendar-command 'calendar-lunar-phases))
9594 (defun org-agenda-holidays ()
9595 "Display the holidays for the 3 months around the cursor date."
9596 (interactive)
9597 (org-agenda-execute-calendar-command 'calendar-list-holidays))
9599 (defvar calendar-longitude) ; defined in calendar.el
9600 (defvar calendar-latitude) ; defined in calendar.el
9601 (defvar calendar-location-name) ; defined in calendar.el
9603 (defun org-agenda-sunrise-sunset (arg)
9604 "Display sunrise and sunset for the cursor date.
9605 Latitude and longitude can be specified with the variables
9606 `calendar-latitude' and `calendar-longitude'. When called with prefix
9607 argument, latitude and longitude will be prompted for."
9608 (interactive "P")
9609 (require 'solar)
9610 (let ((calendar-longitude (if arg nil calendar-longitude))
9611 (calendar-latitude (if arg nil calendar-latitude))
9612 (calendar-location-name
9613 (if arg "the given coordinates" calendar-location-name)))
9614 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9616 (defun org-agenda-goto-calendar ()
9617 "Open the Emacs calendar with the date at the cursor."
9618 (interactive)
9619 (org-agenda-check-type t 'agenda 'timeline)
9620 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9621 (user-error "Don't know which date to open in calendar")))
9622 (date (calendar-gregorian-from-absolute day))
9623 (calendar-move-hook nil)
9624 (calendar-view-holidays-initially-flag nil)
9625 (calendar-view-diary-initially-flag nil))
9626 (calendar)
9627 (calendar-goto-date date)))
9629 ;;;###autoload
9630 (defun org-calendar-goto-agenda ()
9631 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9632 This is a command that has to be installed in `calendar-mode-map'."
9633 (interactive)
9634 (org-agenda-list nil (calendar-absolute-from-gregorian
9635 (calendar-cursor-to-date))
9636 nil))
9638 (defun org-agenda-convert-date ()
9639 (interactive)
9640 (org-agenda-check-type t 'agenda 'timeline)
9641 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9642 date s)
9643 (unless day
9644 (user-error "Don't know which date to convert"))
9645 (setq date (calendar-gregorian-from-absolute day))
9646 (setq s (concat
9647 "Gregorian: " (calendar-date-string date) "\n"
9648 "ISO: " (calendar-iso-date-string date) "\n"
9649 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9650 "Julian: " (calendar-julian-date-string date) "\n"
9651 "Astron. JD: " (calendar-astro-date-string date)
9652 " (Julian date number at noon UTC)\n"
9653 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9654 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9655 "French: " (calendar-french-date-string date) "\n"
9656 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
9657 "Mayan: " (calendar-mayan-date-string date) "\n"
9658 "Coptic: " (calendar-coptic-date-string date) "\n"
9659 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9660 "Persian: " (calendar-persian-date-string date) "\n"
9661 "Chinese: " (calendar-chinese-date-string date) "\n"))
9662 (with-output-to-temp-buffer "*Dates*"
9663 (princ s))
9664 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9666 ;;; Bulk commands
9668 (defun org-agenda-bulk-marked-p ()
9669 (eq (get-char-property (point-at-bol) 'type)
9670 'org-marked-entry-overlay))
9672 (defun org-agenda-bulk-mark (&optional arg)
9673 "Mark the entry at point for future bulk action."
9674 (interactive "p")
9675 (dotimes (i (or arg 1))
9676 (unless (org-get-at-bol 'org-agenda-diary-link)
9677 (let* ((m (org-get-at-bol 'org-hd-marker))
9679 (unless (org-agenda-bulk-marked-p)
9680 (unless m (user-error "Nothing to mark at point"))
9681 (push m org-agenda-bulk-marked-entries)
9682 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9683 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9684 (org-get-todo-face "TODO")
9685 'evaporate)
9686 (overlay-put ov 'type 'org-marked-entry-overlay))
9687 (end-of-line 1)
9688 (or (ignore-errors
9689 (goto-char (next-single-property-change (point) 'org-hd-marker)))
9690 (beginning-of-line 2))
9691 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9692 (beginning-of-line 2))
9693 (message "%d entries marked for bulk action"
9694 (length org-agenda-bulk-marked-entries))))))
9696 (defun org-agenda-bulk-mark-all ()
9697 "Mark all entries for future agenda bulk action."
9698 (interactive)
9699 (org-agenda-bulk-mark-regexp "."))
9701 (defun org-agenda-bulk-mark-regexp (regexp)
9702 "Mark entries matching REGEXP for future agenda bulk action."
9703 (interactive "sMark entries matching regexp: ")
9704 (let ((entries-marked 0) txt-at-point)
9705 (save-excursion
9706 (goto-char (point-min))
9707 (goto-char (next-single-property-change (point) 'org-hd-marker))
9708 (while (and (re-search-forward regexp nil t)
9709 (setq txt-at-point (get-text-property (point) 'txt)))
9710 (when (string-match regexp txt-at-point)
9711 (setq entries-marked (1+ entries-marked))
9712 (call-interactively 'org-agenda-bulk-mark))))
9713 (if (not entries-marked)
9714 (message "No entry matching this regexp."))))
9716 (defun org-agenda-bulk-unmark (&optional arg)
9717 "Unmark the entry at point for future bulk action."
9718 (interactive "P")
9719 (if arg
9720 (org-agenda-bulk-unmark-all)
9721 (cond ((org-agenda-bulk-marked-p)
9722 (org-agenda-bulk-remove-overlays
9723 (point-at-bol) (+ 2 (point-at-bol)))
9724 (setq org-agenda-bulk-marked-entries
9725 (delete (org-get-at-bol 'org-hd-marker)
9726 org-agenda-bulk-marked-entries))
9727 (end-of-line 1)
9728 (or (ignore-errors
9729 (goto-char (next-single-property-change (point) 'txt)))
9730 (beginning-of-line 2))
9731 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9732 (beginning-of-line 2))
9733 (message "%d entries left marked for bulk action"
9734 (length org-agenda-bulk-marked-entries)))
9735 (t (message "No entry to unmark here")))))
9737 (defun org-agenda-bulk-toggle-all ()
9738 "Toggle all marks for bulk action."
9739 (interactive)
9740 (save-excursion
9741 (goto-char (point-min))
9742 (while (ignore-errors
9743 (goto-char (next-single-property-change (point) 'org-hd-marker)))
9744 (org-agenda-bulk-toggle))))
9746 (defun org-agenda-bulk-toggle ()
9747 "Toggle the mark at point for bulk action."
9748 (interactive)
9749 (if (org-agenda-bulk-marked-p)
9750 (org-agenda-bulk-unmark)
9751 (org-agenda-bulk-mark)))
9753 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9754 "Remove the mark overlays between BEG and END in the agenda buffer.
9755 BEG and END default to the buffer limits.
9757 This only removes the overlays, it does not remove the markers
9758 from the list in `org-agenda-bulk-marked-entries'."
9759 (interactive)
9760 (mapc (lambda (ov)
9761 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9762 (delete-overlay ov)))
9763 (overlays-in (or beg (point-min)) (or end (point-max)))))
9765 (defun org-agenda-bulk-unmark-all ()
9766 "Remove all marks in the agenda buffer.
9767 This will remove the markers and the overlays."
9768 (interactive)
9769 (if (null org-agenda-bulk-marked-entries)
9770 (message "No entry to unmark")
9771 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9772 (setq org-agenda-bulk-marked-entries nil)
9773 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9775 (defcustom org-agenda-persistent-marks nil
9776 "Non-nil means marked items will stay marked after a bulk action.
9777 You can toggle this interactively by typing `p' when prompted for a
9778 bulk action."
9779 :group 'org-agenda
9780 :version "24.1"
9781 :type 'boolean)
9783 (defun org-agenda-bulk-action (&optional arg)
9784 "Execute an remote-editing action on all marked entries.
9785 The prefix arg is passed through to the command if possible."
9786 (interactive "P")
9787 ;; Make sure we have markers, and only valid ones
9788 (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
9789 (mapc
9790 (lambda (m)
9791 (unless (and (markerp m)
9792 (marker-buffer m)
9793 (buffer-live-p (marker-buffer m))
9794 (marker-position m))
9795 (user-error "Marker %s for bulk command is invalid" m)))
9796 org-agenda-bulk-marked-entries)
9798 ;; Prompt for the bulk command
9799 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9800 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9801 "[S]catter [f]unction "
9802 (when org-agenda-bulk-custom-functions
9803 (concat " Custom: ["
9804 (mapconcat (lambda(f) (char-to-string (car f)))
9805 org-agenda-bulk-custom-functions "")
9806 "]"))))
9807 (catch 'exit
9808 (let* ((action (read-char-exclusive))
9809 (org-log-refile (if org-log-refile 'time nil))
9810 (entries (reverse org-agenda-bulk-marked-entries))
9811 (org-overriding-default-time
9812 (if (get-text-property (point) 'org-agenda-date-header)
9813 (org-get-cursor-date)))
9814 redo-at-end
9815 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9816 (cond
9817 ((equal action ?p)
9818 (let ((org-agenda-persistent-marks
9819 (not org-agenda-persistent-marks)))
9820 (org-agenda-bulk-action)
9821 (throw 'exit nil)))
9823 ((equal action ?$)
9824 (setq cmd '(org-agenda-archive)))
9826 ((equal action ?A)
9827 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9829 ((member action '(?r ?w))
9830 (setq rfloc (org-refile-get-location
9831 "Refile to"
9832 (marker-buffer (car entries))
9833 org-refile-allow-creating-parent-nodes))
9834 (if (nth 3 rfloc)
9835 (setcar (nthcdr 3 rfloc)
9836 (move-marker (make-marker) (nth 3 rfloc)
9837 (or (get-file-buffer (nth 1 rfloc))
9838 (find-buffer-visiting (nth 1 rfloc))
9839 (error "This should not happen")))))
9841 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9842 redo-at-end t))
9844 ((equal action ?t)
9845 (setq state (org-icompleting-read
9846 "Todo state: "
9847 (with-current-buffer (marker-buffer (car entries))
9848 (mapcar 'list org-todo-keywords-1))))
9849 (setq cmd `(let ((org-inhibit-blocking t)
9850 (org-inhibit-logging 'note))
9851 (org-agenda-todo ,state))))
9853 ((memq action '(?- ?+))
9854 (setq tag (org-icompleting-read
9855 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9856 (with-current-buffer (marker-buffer (car entries))
9857 (delq nil
9858 (mapcar (lambda (x)
9859 (if (stringp (car x)) x)) org-tag-alist)))))
9860 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9862 ((memq action '(?s ?d))
9863 (let* ((time
9864 (unless arg
9865 (org-read-date
9866 nil nil nil
9867 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9868 org-overriding-default-time)))
9869 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9870 (setq cmd `(eval '(,c1 arg ,time)))))
9872 ((equal action ?S)
9873 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9874 (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9875 (let ((days (read-number
9876 (format "Scatter tasks across how many %sdays: "
9877 (if arg "week" "")) 7)))
9878 (setq cmd
9879 `(let ((distance (1+ (random ,days))))
9880 (if arg
9881 (let ((dist distance)
9882 (day-of-week
9883 (calendar-day-of-week
9884 (calendar-gregorian-from-absolute (org-today)))))
9885 (dotimes (i (1+ dist))
9886 (while (member day-of-week org-agenda-weekend-days)
9887 (incf distance)
9888 (incf day-of-week)
9889 (if (= day-of-week 7)
9890 (setq day-of-week 0)))
9891 (incf day-of-week)
9892 (if (= day-of-week 7)
9893 (setq day-of-week 0)))))
9894 ;; silently fail when try to replan a sexp entry
9895 (condition-case nil
9896 (let* ((date (calendar-gregorian-from-absolute
9897 (+ (org-today) distance)))
9898 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9899 (nth 2 date))))
9900 (org-agenda-schedule nil time))
9901 (error nil)))))))
9903 ((assoc action org-agenda-bulk-custom-functions)
9904 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9905 redo-at-end t))
9907 ((equal action ?f)
9908 (setq cmd (list (intern
9909 (org-icompleting-read "Function: "
9910 obarray 'fboundp t nil nil)))))
9912 (t (user-error "Invalid bulk action")))
9914 ;; Sort the markers, to make sure that parents are handled before children
9915 (setq entries (sort entries
9916 (lambda (a b)
9917 (cond
9918 ((equal (marker-buffer a) (marker-buffer b))
9919 (< (marker-position a) (marker-position b)))
9921 (string< (buffer-name (marker-buffer a))
9922 (buffer-name (marker-buffer b))))))))
9924 ;; Now loop over all markers and apply cmd
9925 (while (setq e (pop entries))
9926 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9927 (if (not pos)
9928 (progn (message "Skipping removed entry at %s" e)
9929 (setq cntskip (1+ cntskip)))
9930 (goto-char pos)
9931 (let (org-loop-over-headlines-in-active-region)
9932 (eval cmd))
9933 (setq cnt (1+ cnt))))
9934 (when redo-at-end (org-agenda-redo))
9935 (unless org-agenda-persistent-marks
9936 (org-agenda-bulk-unmark-all))
9937 (message "Acted on %d entries%s%s"
9939 (if (= cntskip 0)
9941 (format ", skipped %d (disappeared before their turn)"
9942 cntskip))
9943 (if (not org-agenda-persistent-marks)
9944 "" " (kept marked)"))))))
9946 (defun org-agenda-capture (&optional with-time)
9947 "Call `org-capture' with the date at point.
9948 With a `C-1' prefix, use the HH:MM value at point (if any) or the
9949 current HH:MM time."
9950 (interactive "P")
9951 (if (not (eq major-mode 'org-agenda-mode))
9952 (user-error "You cannot do this outside of agenda buffers")
9953 (let ((org-overriding-default-time
9954 (org-get-cursor-date (equal with-time 1))))
9955 (call-interactively 'org-capture))))
9957 ;;; Dragging agenda lines forward/backward
9959 (defun org-agenda-reapply-filters ()
9960 "Re-apply all agenda filters."
9961 (mapcar
9962 (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f))))
9963 `((,org-agenda-tag-filter tag)
9964 (,org-agenda-category-filter category)
9965 (,org-agenda-regexp-filter regexp)
9966 (,org-agenda-effort-filter effort)
9967 (,(get 'org-agenda-tag-filter :preset-filter) tag)
9968 (,(get 'org-agenda-category-filter :preset-filter) category)
9969 (,(get 'org-agenda-effort-filter :preset-filter) effort)
9970 (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
9972 (defun org-agenda-drag-line-forward (arg &optional backward)
9973 "Drag an agenda line forward by ARG lines.
9974 When the optional argument `backward' is non-nil, move backward."
9975 (interactive "p")
9976 (let ((inhibit-read-only t) lst line)
9977 (if (or (not (get-text-property (point) 'txt))
9978 (save-excursion
9979 (dotimes (n arg)
9980 (move-beginning-of-line (if backward 0 2))
9981 (push (not (get-text-property (point) 'txt)) lst))
9982 (delq nil lst)))
9983 (message "Cannot move line forward")
9984 (let ((end (save-excursion (move-beginning-of-line 2) (point))))
9985 (move-beginning-of-line 1)
9986 (setq line (buffer-substring (point) end))
9987 (delete-region (point) end)
9988 (move-beginning-of-line (funcall (if backward '1- '1+) arg))
9989 (insert line)
9990 (org-agenda-reapply-filters)
9991 (org-agenda-mark-clocking-task)
9992 (move-beginning-of-line 0)))))
9994 (defun org-agenda-drag-line-backward (arg)
9995 "Drag an agenda line backward by ARG lines."
9996 (interactive "p")
9997 (org-agenda-drag-line-forward arg t))
9999 ;;; Flagging notes
10001 (defun org-agenda-show-the-flagging-note ()
10002 "Display the flagging note in the other window.
10003 When called a second time in direct sequence, offer to remove the FLAGGING
10004 tag and (if present) the flagging note."
10005 (interactive)
10006 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
10007 (win (selected-window))
10008 note heading newhead)
10009 (unless hdmarker
10010 (user-error "No linked entry at point"))
10011 (if (and (eq this-command last-command)
10012 (y-or-n-p "Unflag and remove any flagging note? "))
10013 (progn
10014 (org-agenda-remove-flag hdmarker)
10015 (let ((win (get-buffer-window "*Flagging Note*")))
10016 (and win (delete-window win)))
10017 (message "Entry unflagged"))
10018 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
10019 (unless note
10020 (user-error "No flagging note"))
10021 (org-kill-new note)
10022 (org-switch-to-buffer-other-window "*Flagging Note*")
10023 (erase-buffer)
10024 (insert note)
10025 (goto-char (point-min))
10026 (while (re-search-forward "\\\\n" nil t)
10027 (replace-match "\n" t t))
10028 (goto-char (point-min))
10029 (select-window win)
10030 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
10032 (defun org-agenda-remove-flag (marker)
10033 "Remove the FLAGGED tag and any flagging note in the entry."
10034 (let (newhead)
10035 (org-with-point-at marker
10036 (org-toggle-tag "FLAGGED" 'off)
10037 (org-entry-delete nil "THEFLAGGINGNOTE")
10038 (setq newhead (org-get-heading)))
10039 (org-agenda-change-all-lines newhead marker)
10040 (message "Entry unflagged")))
10042 (defun org-agenda-get-any-marker (&optional pos)
10043 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
10044 (get-text-property (or pos (point-at-bol)) 'org-marker)))
10046 ;;; Appointment reminders
10048 (defvar appt-time-msg-list) ; defined in appt.el
10050 ;;;###autoload
10051 (defun org-agenda-to-appt (&optional refresh filter &rest args)
10052 "Activate appointments found in `org-agenda-files'.
10053 With a \\[universal-argument] prefix, refresh the list of
10054 appointments.
10056 If FILTER is t, interactively prompt the user for a regular
10057 expression, and filter out entries that don't match it.
10059 If FILTER is a string, use this string as a regular expression
10060 for filtering entries out.
10062 If FILTER is a function, filter out entries against which
10063 calling the function returns nil. This function takes one
10064 argument: an entry from `org-agenda-get-day-entries'.
10066 FILTER can also be an alist with the car of each cell being
10067 either 'headline or 'category. For example:
10069 '((headline \"IMPORTANT\")
10070 (category \"Work\"))
10072 will only add headlines containing IMPORTANT or headlines
10073 belonging to the \"Work\" category.
10075 ARGS are symbols indicating what kind of entries to consider.
10076 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
10077 \(i.e., deadlines and scheduled items with a hh:mm specification)
10078 and :timestamp entries. See the docstring of `org-diary' for
10079 details and examples.
10081 If an entry has a APPT_WARNTIME property, its value will be used
10082 to override `appt-message-warning-time'."
10083 (interactive "P")
10084 (if refresh (setq appt-time-msg-list nil))
10085 (if (eq filter t)
10086 (setq filter (read-from-minibuffer "Regexp filter: ")))
10087 (let* ((cnt 0) ; count added events
10088 (scope (or args '(:deadline* :scheduled* :timestamp)))
10089 (org-agenda-new-buffers nil)
10090 (org-deadline-warning-days 0)
10091 ;; Do not use `org-today' here because appt only takes
10092 ;; time and without date as argument, so it may pass wrong
10093 ;; information otherwise
10094 (today (org-date-to-gregorian
10095 (time-to-days (current-time))))
10096 (org-agenda-restrict nil)
10097 (files (org-agenda-files 'unrestricted)) entries file
10098 (org-agenda-buffer nil))
10099 ;; Get all entries which may contain an appt
10100 (org-agenda-prepare-buffers files)
10101 (while (setq file (pop files))
10102 (setq entries
10103 (delq nil
10104 (append entries
10105 (apply 'org-agenda-get-day-entries
10106 file today scope)))))
10107 ;; Map thru entries and find if we should filter them out
10108 (mapc
10109 (lambda(x)
10110 (let* ((evt (org-trim
10111 (replace-regexp-in-string
10112 org-bracket-link-regexp "\\3"
10113 (or (get-text-property 1 'txt x) ""))))
10114 (cat (get-text-property (1- (length x)) 'org-category x))
10115 (tod (get-text-property 1 'time-of-day x))
10116 (ok (or (null filter)
10117 (and (stringp filter) (string-match filter evt))
10118 (and (functionp filter) (funcall filter x))
10119 (and (listp filter)
10120 (let ((cat-filter (cadr (assoc 'category filter)))
10121 (evt-filter (cadr (assoc 'headline filter))))
10122 (or (and (stringp cat-filter)
10123 (string-match cat-filter cat))
10124 (and (stringp evt-filter)
10125 (string-match evt-filter evt)))))))
10126 (wrn (get-text-property 1 'warntime x)))
10127 ;; FIXME: Shall we remove text-properties for the appt text?
10128 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
10129 (when (and ok tod)
10130 (setq tod (concat "00" (number-to-string tod))
10131 tod (when (string-match
10132 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
10133 (concat (match-string 1 tod) ":"
10134 (match-string 2 tod))))
10135 (if (version< emacs-version "23.3")
10136 (appt-add tod evt)
10137 (appt-add tod evt wrn))
10138 (setq cnt (1+ cnt))))) entries)
10139 (org-release-buffers org-agenda-new-buffers)
10140 (if (eq cnt 0)
10141 (message "No event to add")
10142 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
10144 (defun org-agenda-todayp (date)
10145 "Does DATE mean today, when considering `org-extend-today-until'?"
10146 (let ((today (org-today))
10147 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
10148 date)))
10149 (eq date today)))
10151 (defun org-agenda-todo-yesterday (&optional arg)
10152 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
10153 (interactive "P")
10154 (let* ((org-use-effective-time t)
10155 (hour (third (decode-time
10156 (org-current-time))))
10157 (org-extend-today-until (1+ hour)))
10158 (org-agenda-todo arg)))
10160 (provide 'org-agenda)
10162 ;;; org-agenda.el ends here