Merge branch 'master' into comment-cache
[emacs.git] / lisp / org / org-agenda.el
blobc870ddd4e43f74090f8e151a25a6781ba44735b3
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2017 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-datetree-find-date-create "org-datetree"
73 (date &optional keep-restriction))
74 (declare-function org-columns-quit "org-colview" ())
75 (declare-function diary-date-display-form "diary-lib" (&optional type))
76 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
77 (declare-function org-habit-insert-consistency-graphs
78 "org-habit" (&optional line))
79 (declare-function org-is-habit-p "org-habit" (&optional pom))
80 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
81 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
82 (declare-function org-pop-to-buffer-same-window "org-compat"
83 (&optional buffer-or-name norecord label))
84 (declare-function org-agenda-columns "org-colview" ())
85 (declare-function org-add-archive-files "org-archive" (files))
86 (declare-function org-capture "org-capture" (&optional goto keys))
88 (defvar calendar-mode-map) ; defined in calendar.el
89 (defvar org-clock-current-task nil) ; defined in org-clock.el
90 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
91 (defvar org-habit-show-habits) ; defined in org-habit.el
92 (defvar org-habit-show-habits-only-for-today)
93 (defvar org-habit-show-all-today)
95 ;; Defined somewhere in this file, but used before definition.
96 (defvar org-agenda-buffer-name "*Org Agenda*")
97 (defvar org-agenda-overriding-header nil)
98 (defvar org-agenda-title-append nil)
99 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
100 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
101 (defvar original-date) ; dynamically scoped, calendar.el does scope this
103 (defvar org-agenda-undo-list nil
104 "List of undoable operations in the agenda since last refresh.")
105 (defvar org-agenda-pending-undo-list nil
106 "In a series of undo commands, this is the list of remaining undo items.")
108 (defcustom org-agenda-confirm-kill 1
109 "When set, remote killing from the agenda buffer needs confirmation.
110 When t, a confirmation is always needed. When a number N, confirmation is
111 only needed when the text to be killed contains more than N non-white lines."
112 :group 'org-agenda
113 :type '(choice
114 (const :tag "Never" nil)
115 (const :tag "Always" t)
116 (integer :tag "When more than N lines")))
118 (defcustom org-agenda-compact-blocks nil
119 "Non-nil means make the block agenda more compact.
120 This is done globally by leaving out lines like the agenda span
121 name and week number or the separator lines."
122 :group 'org-agenda
123 :type 'boolean)
125 (defcustom org-agenda-block-separator ?=
126 "The separator between blocks in the agenda.
127 If this is a string, it will be used as the separator, with a newline added.
128 If it is a character, it will be repeated to fill the window width.
129 If nil the separator is disabled. In `org-agenda-custom-commands' this
130 addresses the separator between the current and the previous block."
131 :group 'org-agenda
132 :type '(choice
133 (const :tag "Disabled" nil)
134 (character)
135 (string)))
137 (defgroup org-agenda-export nil
138 "Options concerning exporting agenda views in Org-mode."
139 :tag "Org Agenda Export"
140 :group 'org-agenda)
142 (defcustom org-agenda-with-colors t
143 "Non-nil means use colors in agenda views."
144 :group 'org-agenda-export
145 :type 'boolean)
147 (defcustom org-agenda-exporter-settings nil
148 "Alist of variable/value pairs that should be active during agenda export.
149 This is a good place to set options for ps-print and for htmlize.
150 Note that the way this is implemented, the values will be evaluated
151 before assigned to the variables. So make sure to quote values you do
152 *not* want evaluated, for example
154 (setq org-agenda-exporter-settings
155 '((ps-print-color-p 'black-white)))"
156 :group 'org-agenda-export
157 :type '(repeat
158 (list
159 (variable)
160 (sexp :tag "Value"))))
162 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
163 "Hook run in a temporary buffer before writing the agenda to an export file.
164 A useful function for this hook is `org-agenda-add-entry-text'."
165 :group 'org-agenda-export
166 :type 'hook
167 :options '(org-agenda-add-entry-text))
169 (defcustom org-agenda-add-entry-text-maxlines 0
170 "Maximum number of entry text lines to be added to agenda.
171 This is only relevant when `org-agenda-add-entry-text' is part of
172 `org-agenda-before-write-hook', which is the default.
173 When this is 0, nothing will happen. When it is greater than 0, it
174 specifies the maximum number of lines that will be added for each entry
175 that is listed in the agenda view.
177 Note that this variable is not used during display, only when exporting
178 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
179 and `org-agenda-entry-text-maxlines'."
180 :group 'org-agenda
181 :type 'integer)
183 (defcustom org-agenda-add-entry-text-descriptive-links t
184 "Non-nil means export org-links as descriptive links in agenda added text.
185 This variable applies to the text added to the agenda when
186 `org-agenda-add-entry-text-maxlines' is larger than 0.
187 When this variable nil, the URL will (also) be shown."
188 :group 'org-agenda
189 :type 'boolean)
191 (defcustom org-agenda-export-html-style nil
192 "The style specification for exported HTML Agenda files.
193 If this variable contains a string, it will replace the default <style>
194 section as produced by `htmlize'.
195 Since there are different ways of setting style information, this variable
196 needs to contain the full HTML structure to provide a style, including the
197 surrounding HTML tags. The style specifications should include definitions
198 the fonts used by the agenda, here is an example:
200 <style type=\"text/css\">
201 p { font-weight: normal; color: gray; }
202 .org-agenda-structure {
203 font-size: 110%;
204 color: #003399;
205 font-weight: 600;
207 .org-todo {
208 color: #cc6666;
209 font-weight: bold;
211 .org-agenda-done {
212 color: #339933;
214 .org-done {
215 color: #339933;
217 .title { text-align: center; }
218 .todo, .deadline { color: red; }
219 .done { color: green; }
220 </style>
222 or, if you want to keep the style in a file,
224 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
226 As the value of this option simply gets inserted into the HTML <head> header,
227 you can \"misuse\" it to also add other text to the header."
228 :group 'org-agenda-export
229 :group 'org-export-html
230 :type '(choice
231 (const nil)
232 (string)))
234 (defcustom org-agenda-persistent-filter nil
235 "When set, keep filters from one agenda view to the next."
236 :group 'org-agenda
237 :type 'boolean)
239 (defgroup org-agenda-custom-commands nil
240 "Options concerning agenda views in Org-mode."
241 :tag "Org Agenda Custom Commands"
242 :group 'org-agenda)
244 (defconst org-sorting-choice
245 '(choice
246 (const time-up) (const time-down)
247 (const timestamp-up) (const timestamp-down)
248 (const scheduled-up) (const scheduled-down)
249 (const deadline-up) (const deadline-down)
250 (const ts-up) (const ts-down)
251 (const tsia-up) (const tsia-down)
252 (const category-keep) (const category-up) (const category-down)
253 (const tag-down) (const tag-up)
254 (const priority-up) (const priority-down)
255 (const todo-state-up) (const todo-state-down)
256 (const effort-up) (const effort-down)
257 (const habit-up) (const habit-down)
258 (const alpha-up) (const alpha-down)
259 (const user-defined-up) (const user-defined-down))
260 "Sorting choices.")
262 ;; Keep custom values for `org-agenda-filter-preset' compatible with
263 ;; the new variable `org-agenda-tag-filter-preset'.
264 (org-defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
265 (org-defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
267 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
268 "List of types searched for when creating the daily/weekly agenda.
269 This variable is a list of symbols that controls the types of
270 items that appear in the daily/weekly agenda. Allowed symbols in this
271 list are are
273 :timestamp List items containing a date stamp or date range matching
274 the selected date. This includes sexp entries in angular
275 brackets.
277 :sexp List entries resulting from plain diary-like sexps.
279 :deadline List deadline due on that date. When the date is today,
280 also list any deadlines past due, or due within
281 `org-deadline-warning-days'. `:deadline' must appear before
282 `:scheduled' if the setting of
283 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
284 any effect.
286 :deadline* Same as above, but only include the deadline if it has an
287 hour specification as [h]h:mm.
289 :scheduled List all items which are scheduled for the given date.
290 The diary for *today* also contains items which were
291 scheduled earlier and are not yet marked DONE.
293 :scheduled* Same as above, but only include the scheduled item if it
294 has an hour specification as [h]h:mm.
296 By default, all four non-starred types are turned on.
298 When :scheduled* or :deadline* are included, :schedule or :deadline
299 will be ignored.
301 Never set this variable globally using `setq', because then it
302 will apply to all future agenda commands. Instead, bind it with
303 `let' to scope it dynamically into the agenda-constructing
304 command. A good way to set it is through options in
305 `org-agenda-custom-commands'. For a more flexible (though
306 somewhat less efficient) way of determining what is included in
307 the daily/weekly agenda, see `org-agenda-skip-function'.")
309 (defconst org-agenda-custom-commands-local-options
310 `(repeat :tag "Local settings for this command. Remember to quote values"
311 (choice :tag "Setting"
312 (list :tag "Heading for this block"
313 (const org-agenda-overriding-header)
314 (string :tag "Headline"))
315 (list :tag "Files to be searched"
316 (const org-agenda-files)
317 (list
318 (const :format "" quote)
319 (repeat (file))))
320 (list :tag "Sorting strategy"
321 (const org-agenda-sorting-strategy)
322 (list
323 (const :format "" quote)
324 (repeat
325 ,org-sorting-choice)))
326 (list :tag "Prefix format"
327 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
328 (string))
329 (list :tag "Number of days in agenda"
330 (const org-agenda-span)
331 (choice (const :tag "Day" day)
332 (const :tag "Week" week)
333 (const :tag "Fortnight" fortnight)
334 (const :tag "Month" month)
335 (const :tag "Year" year)
336 (integer :tag "Custom")))
337 (list :tag "Fixed starting date"
338 (const org-agenda-start-day)
339 (string :value "2007-11-01"))
340 (list :tag "Start on day of week"
341 (const org-agenda-start-on-weekday)
342 (choice :value 1
343 (const :tag "Today" nil)
344 (integer :tag "Weekday No.")))
345 (list :tag "Include data from diary"
346 (const org-agenda-include-diary)
347 (boolean))
348 (list :tag "Deadline Warning days"
349 (const org-deadline-warning-days)
350 (integer :value 1))
351 (list :tag "Category filter preset"
352 (const org-agenda-category-filter-preset)
353 (list
354 (const :format "" quote)
355 (repeat
356 (string :tag "+category or -category"))))
357 (list :tag "Tags filter preset"
358 (const org-agenda-tag-filter-preset)
359 (list
360 (const :format "" quote)
361 (repeat
362 (string :tag "+tag or -tag"))))
363 (list :tag "Regexp filter preset"
364 (const org-agenda-regexp-filter-preset)
365 (list
366 (const :format "" quote)
367 (repeat
368 (string :tag "+regexp or -regexp"))))
369 (list :tag "Set daily/weekly entry types"
370 (const org-agenda-entry-types)
371 (list
372 (const :format "" quote)
373 (set :greedy t :value ,org-agenda-entry-types
374 (const :deadline)
375 (const :scheduled)
376 (const :deadline*)
377 (const :scheduled*)
378 (const :timestamp)
379 (const :sexp))))
380 (list :tag "Standard skipping condition"
381 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
382 (const org-agenda-skip-function)
383 (list
384 (const :format "" quote)
385 (list
386 (choice
387 :tag "Skipping range"
388 (const :tag "Skip entry" org-agenda-skip-entry-if)
389 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
390 (repeat :inline t :tag "Conditions for skipping"
391 (choice
392 :tag "Condition type"
393 (list :tag "Regexp matches" :inline t
394 (const :format "" 'regexp)
395 (regexp))
396 (list :tag "Regexp does not match" :inline t
397 (const :format "" 'notregexp)
398 (regexp))
399 (list :tag "TODO state is" :inline t
400 (const 'todo)
401 (choice
402 (const :tag "Any not-done state" 'todo)
403 (const :tag "Any done state" 'done)
404 (const :tag "Any state" 'any)
405 (list :tag "Keyword list"
406 (const :format "" quote)
407 (repeat (string :tag "Keyword")))))
408 (list :tag "TODO state is not" :inline t
409 (const 'nottodo)
410 (choice
411 (const :tag "Any not-done state" 'todo)
412 (const :tag "Any done state" 'done)
413 (const :tag "Any state" 'any)
414 (list :tag "Keyword list"
415 (const :format "" quote)
416 (repeat (string :tag "Keyword")))))
417 (const :tag "scheduled" 'scheduled)
418 (const :tag "not scheduled" 'notscheduled)
419 (const :tag "deadline" 'deadline)
420 (const :tag "no deadline" 'notdeadline)
421 (const :tag "timestamp" 'timestamp)
422 (const :tag "no timestamp" 'nottimestamp))))))
423 (list :tag "Non-standard skipping condition"
424 :value (org-agenda-skip-function)
425 (const org-agenda-skip-function)
426 (sexp :tag "Function or form (quoted!)"))
427 (list :tag "Any variable"
428 (variable :tag "Variable")
429 (sexp :tag "Value (sexp)"))))
430 "Selection of examples for agenda command settings.
431 This will be spliced into the custom type of
432 `org-agenda-custom-commands'.")
435 (defcustom org-agenda-custom-commands
436 '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
437 "Custom commands for the agenda.
438 These commands will be offered on the splash screen displayed by the
439 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
441 (key desc type match settings files)
443 key The key (one or more characters as a string) to be associated
444 with the command.
445 desc A description of the command, when omitted or nil, a default
446 description is built using MATCH.
447 type The command type, any of the following symbols:
448 agenda The daily/weekly agenda.
449 todo Entries with a specific TODO keyword, in all agenda files.
450 search Entries containing search words entry or headline.
451 tags Tags/Property/TODO match in all agenda files.
452 tags-todo Tags/P/T match in all agenda files, TODO entries only.
453 todo-tree Sparse tree of specific TODO keyword in *current* file.
454 tags-tree Sparse tree with all tags matches in *current* file.
455 occur-tree Occur sparse tree for *current* file.
456 ... A user-defined function.
457 match What to search for:
458 - a single keyword for TODO keyword searches
459 - a tags match expression for tags searches
460 - a word search expression for text searches.
461 - a regular expression for occur searches
462 For all other commands, this should be the empty string.
463 settings A list of option settings, similar to that in a let form, so like
464 this: ((opt1 val1) (opt2 val2) ...). The values will be
465 evaluated at the moment of execution, so quote them when needed.
466 files A list of files file to write the produced agenda buffer to
467 with the command `org-store-agenda-views'.
468 If a file name ends in \".html\", an HTML version of the buffer
469 is written out. If it ends in \".ps\", a postscript version is
470 produced. Otherwise, only the plain text is written to the file.
472 You can also define a set of commands, to create a composite agenda buffer.
473 In this case, an entry looks like this:
475 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
477 where
479 desc A description string to be displayed in the dispatcher menu.
480 cmd An agenda command, similar to the above. However, tree commands
481 are not allowed, but instead you can get agenda and global todo list.
482 So valid commands for a set are:
483 (agenda \"\" settings)
484 (alltodo \"\" settings)
485 (stuck \"\" settings)
486 (todo \"match\" settings files)
487 (search \"match\" settings files)
488 (tags \"match\" settings files)
489 (tags-todo \"match\" settings files)
491 Each command can carry a list of options, and another set of options can be
492 given for the whole set of commands. Individual command options take
493 precedence over the general options.
495 When using several characters as key to a command, the first characters
496 are prefix commands. For the dispatcher to display useful information, you
497 should provide a description for the prefix, like
499 (setq org-agenda-custom-commands
500 \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
501 (\"hl\" tags \"+HOME+Lisa\")
502 (\"hp\" tags \"+HOME+Peter\")
503 (\"hk\" tags \"+HOME+Kim\")))"
504 :group 'org-agenda-custom-commands
505 :type `(repeat
506 (choice :value ("x" "Describe command here" tags "" nil)
507 (list :tag "Single command"
508 (string :tag "Access Key(s) ")
509 (option (string :tag "Description"))
510 (choice
511 (const :tag "Agenda" agenda)
512 (const :tag "TODO list" alltodo)
513 (const :tag "Search words" search)
514 (const :tag "Stuck projects" stuck)
515 (const :tag "Tags/Property match (all agenda files)" tags)
516 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
517 (const :tag "TODO keyword search (all agenda files)" todo)
518 (const :tag "Tags sparse tree (current buffer)" tags-tree)
519 (const :tag "TODO keyword tree (current buffer)" todo-tree)
520 (const :tag "Occur tree (current buffer)" occur-tree)
521 (sexp :tag "Other, user-defined function"))
522 (string :tag "Match (only for some commands)")
523 ,org-agenda-custom-commands-local-options
524 (option (repeat :tag "Export" (file :tag "Export to"))))
525 (list :tag "Command series, all agenda files"
526 (string :tag "Access Key(s)")
527 (string :tag "Description ")
528 (repeat :tag "Component"
529 (choice
530 (list :tag "Agenda"
531 (const :format "" agenda)
532 (const :tag "" :format "" "")
533 ,org-agenda-custom-commands-local-options)
534 (list :tag "TODO list (all keywords)"
535 (const :format "" alltodo)
536 (const :tag "" :format "" "")
537 ,org-agenda-custom-commands-local-options)
538 (list :tag "Search words"
539 (const :format "" search)
540 (string :tag "Match")
541 ,org-agenda-custom-commands-local-options)
542 (list :tag "Stuck projects"
543 (const :format "" stuck)
544 (const :tag "" :format "" "")
545 ,org-agenda-custom-commands-local-options)
546 (list :tag "Tags search"
547 (const :format "" tags)
548 (string :tag "Match")
549 ,org-agenda-custom-commands-local-options)
550 (list :tag "Tags search, TODO entries only"
551 (const :format "" tags-todo)
552 (string :tag "Match")
553 ,org-agenda-custom-commands-local-options)
554 (list :tag "TODO keyword search"
555 (const :format "" todo)
556 (string :tag "Match")
557 ,org-agenda-custom-commands-local-options)
558 (list :tag "Other, user-defined function"
559 (symbol :tag "function")
560 (string :tag "Match")
561 ,org-agenda-custom-commands-local-options)))
563 (repeat :tag "Settings for entire command set"
564 (list (variable :tag "Any variable")
565 (sexp :tag "Value")))
566 (option (repeat :tag "Export" (file :tag "Export to"))))
567 (cons :tag "Prefix key documentation"
568 (string :tag "Access Key(s)")
569 (string :tag "Description ")))))
571 (defcustom org-agenda-query-register ?o
572 "The register holding the current query string.
573 The purpose of this is that if you construct a query string interactively,
574 you can then use it to define a custom command."
575 :group 'org-agenda-custom-commands
576 :type 'character)
578 (defcustom org-stuck-projects
579 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
580 "How to identify stuck projects.
581 This is a list of four items:
582 1. A tags/todo/property matcher string that is used to identify a project.
583 See the manual for a description of tag and property searches.
584 The entire tree below a headline matched by this is considered one project.
585 2. A list of TODO keywords identifying non-stuck projects.
586 If the project subtree contains any headline with one of these todo
587 keywords, the project is considered to be not stuck. If you specify
588 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
589 3. A list of tags identifying non-stuck projects.
590 If the project subtree contains any headline with one of these tags,
591 the project is considered to be not stuck. If you specify \"*\" as
592 a tag, any tag will mark the project unstuck. Note that this is about
593 the explicit presence of a tag somewhere in the subtree, inherited
594 tags do not count here. If inherited tags make a project not stuck,
595 use \"-TAG\" in the tags part of the matcher under (1.) above.
596 4. An arbitrary regular expression matching non-stuck projects.
598 If the project turns out to be not stuck, search continues also in the
599 subtree to see if any of the subtasks have project status.
601 See also the variable `org-tags-match-list-sublevels' which applies
602 to projects matched by this search as well.
604 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
605 or `C-c a #' to produce the list."
606 :group 'org-agenda-custom-commands
607 :type '(list
608 (string :tag "Tags/TODO match to identify a project")
609 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
610 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
611 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
613 (defcustom org-agenda-filter-effort-default-operator "<"
614 "The default operator for effort estimate filtering.
615 If you select an effort estimate limit without first pressing an operator,
616 this one will be used."
617 :group 'org-agenda-custom-commands
618 :type '(choice (const :tag "less or equal" "<")
619 (const :tag "greater or equal"">")
620 (const :tag "equal" "=")))
622 (defgroup org-agenda-skip nil
623 "Options concerning skipping parts of agenda files."
624 :tag "Org Agenda Skip"
625 :group 'org-agenda)
627 (defcustom org-agenda-skip-function-global nil
628 "Function to be called at each match during agenda construction.
629 If this function returns nil, the current match should not be skipped.
630 If the function decided to skip an agenda match, is must return the
631 buffer position from which the search should be continued.
632 This may also be a Lisp form, which will be evaluated.
634 This variable will be applied to every agenda match, including
635 tags/property searches and TODO lists. So try to make the test function
636 do its checking as efficiently as possible. To implement a skipping
637 condition just for specific agenda commands, use the variable
638 `org-agenda-skip-function' which can be set in the options section
639 of custom agenda commands."
640 :group 'org-agenda-skip
641 :type 'sexp)
643 (defgroup org-agenda-daily/weekly nil
644 "Options concerning the daily/weekly agenda."
645 :tag "Org Agenda Daily/Weekly"
646 :group 'org-agenda)
647 (defgroup org-agenda-todo-list nil
648 "Options concerning the global todo list agenda view."
649 :tag "Org Agenda Todo List"
650 :group 'org-agenda)
651 (defgroup org-agenda-match-view nil
652 "Options concerning the general tags/property/todo match agenda view."
653 :tag "Org Agenda Match View"
654 :group 'org-agenda)
655 (defgroup org-agenda-search-view nil
656 "Options concerning the search agenda view."
657 :tag "Org Agenda Search View"
658 :group 'org-agenda)
660 (defvar org-agenda-archives-mode nil
661 "Non-nil means the agenda will include archived items.
662 If this is the symbol `trees', trees in the selected agenda scope
663 that are marked with the ARCHIVE tag will be included anyway. When this is
664 t, also all archive files associated with the current selection of agenda
665 files will be included.")
667 (defcustom org-agenda-restriction-lock-highlight-subtree t
668 "Non-nil means highlight the whole subtree when restriction is active.
669 Otherwise only highlight the headline. Highlighting the whole subtree is
670 useful to ensure no edits happen beyond the restricted region."
671 :group 'org-agenda
672 :type 'boolean)
674 (defcustom org-agenda-skip-comment-trees t
675 "Non-nil means skip trees that start with the COMMENT keyword.
676 When nil, these trees are also scanned by agenda commands."
677 :group 'org-agenda-skip
678 :type 'boolean)
680 (defcustom org-agenda-todo-list-sublevels t
681 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
682 When nil, the sublevels of a TODO entry are not checked, resulting in
683 potentially much shorter TODO lists."
684 :group 'org-agenda-skip
685 :group 'org-agenda-todo-list
686 :type 'boolean)
688 (defcustom org-agenda-todo-ignore-with-date nil
689 "Non-nil means don't show entries with a date in the global todo list.
690 You can use this if you prefer to mark mere appointments with a TODO keyword,
691 but don't want them to show up in the TODO list.
692 When this is set, it also covers deadlines and scheduled items, the settings
693 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
694 will be ignored.
695 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
696 :group 'org-agenda-skip
697 :group 'org-agenda-todo-list
698 :type 'boolean)
700 (defcustom org-agenda-todo-ignore-timestamp nil
701 "Non-nil means don't show entries with a timestamp.
702 This applies when creating the global todo list.
703 Valid values are:
705 past Don't show entries for today or in the past.
707 future Don't show entries with a timestamp in the future.
708 The idea behind this is that if it has a future
709 timestamp, you don't want to think about it until the
710 date.
712 all Don't show any entries with a timestamp in the global todo list.
713 The idea behind this is that by setting a timestamp, you
714 have already \"taken care\" of this item.
716 This variable can also have an integer as a value. If positive (N),
717 todos with a timestamp N or more days in the future will be ignored. If
718 negative (-N), todos with a timestamp N or more days in the past will be
719 ignored. If 0, todos with a timestamp either today or in the future will
720 be ignored. For example, a value of -1 will exclude todos with a
721 timestamp in the past (yesterday or earlier), while a value of 7 will
722 exclude todos with a timestamp a week or more in the future.
724 See also `org-agenda-todo-ignore-with-date'.
725 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
726 to make his option also apply to the tags-todo list."
727 :group 'org-agenda-skip
728 :group 'org-agenda-todo-list
729 :version "24.1"
730 :type '(choice
731 (const :tag "Ignore future timestamp todos" future)
732 (const :tag "Ignore past or present timestamp todos" past)
733 (const :tag "Ignore all timestamp todos" all)
734 (const :tag "Show timestamp todos" nil)
735 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
737 (defcustom org-agenda-todo-ignore-scheduled nil
738 "Non-nil means, ignore some scheduled TODO items when making TODO list.
739 This applies when creating the global todo list.
740 Valid values are:
742 past Don't show entries scheduled today or in the past.
744 future Don't show entries scheduled in the future.
745 The idea behind this is that by scheduling it, you don't want to
746 think about it until the scheduled date.
748 all Don't show any scheduled entries in the global todo list.
749 The idea behind this is that by scheduling it, you have already
750 \"taken care\" of this item.
752 t Same as `all', for backward compatibility.
754 This variable can also have an integer as a value. See
755 `org-agenda-todo-ignore-timestamp' for more details.
757 See also `org-agenda-todo-ignore-with-date'.
758 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
759 to make his option also apply to the tags-todo list."
760 :group 'org-agenda-skip
761 :group 'org-agenda-todo-list
762 :type '(choice
763 (const :tag "Ignore future-scheduled todos" future)
764 (const :tag "Ignore past- or present-scheduled todos" past)
765 (const :tag "Ignore all scheduled todos" all)
766 (const :tag "Ignore all scheduled todos (compatibility)" t)
767 (const :tag "Show scheduled todos" nil)
768 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
770 (defcustom org-agenda-todo-ignore-deadlines nil
771 "Non-nil means ignore some deadline TODO items when making TODO list.
772 There are different motivations for using different values, please think
773 carefully when configuring this variable.
775 This applies when creating the global todo list.
776 Valid values are:
778 near Don't show near deadline entries. A deadline is near when it is
779 closer than `org-deadline-warning-days' days. The idea behind this
780 is that such items will appear in the agenda anyway.
782 far Don't show TODO entries where a deadline has been defined, but
783 the deadline is not near. This is useful if you don't want to
784 use the todo list to figure out what to do now.
786 past Don't show entries with a deadline timestamp for today or in the past.
788 future Don't show entries with a deadline timestamp in the future, not even
789 when they become `near' ones. Use it with caution.
791 all Ignore all TODO entries that do have a deadline.
793 t Same as `near', for backward compatibility.
795 This variable can also have an integer as a value. See
796 `org-agenda-todo-ignore-timestamp' for more details.
798 See also `org-agenda-todo-ignore-with-date'.
799 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
800 to make his option also apply to the tags-todo list."
801 :group 'org-agenda-skip
802 :group 'org-agenda-todo-list
803 :type '(choice
804 (const :tag "Ignore near deadlines" near)
805 (const :tag "Ignore near deadlines (compatibility)" t)
806 (const :tag "Ignore far deadlines" far)
807 (const :tag "Ignore all TODOs with a deadlines" all)
808 (const :tag "Show all TODOs, even if they have a deadline" nil)
809 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
811 (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
812 "Time unit to use when possibly ignoring an agenda item.
814 See the docstring of various `org-agenda-todo-ignore-*' options.
815 The default is to compare time stamps using days. An item is thus
816 considered to be in the future if it is at least one day after today.
817 Non-nil means to compare time stamps using seconds. An item is then
818 considered future if it has a time value later than current time."
819 :group 'org-agenda-skip
820 :group 'org-agenda-todo-list
821 :version "24.4"
822 :package-version '(Org . "8.0")
823 :type '(choice
824 (const :tag "Compare time with days" nil)
825 (const :tag "Compare time with seconds" t)))
827 (defcustom org-agenda-tags-todo-honor-ignore-options nil
828 "Non-nil means honor todo-list ignores options also in tags-todo search.
829 The variables
830 `org-agenda-todo-ignore-with-date',
831 `org-agenda-todo-ignore-timestamp',
832 `org-agenda-todo-ignore-scheduled',
833 `org-agenda-todo-ignore-deadlines'
834 make the global TODO list skip entries that have time stamps of certain
835 kinds. If this option is set, the same options will also apply for the
836 tags-todo search, which is the general tags/property matcher
837 restricted to unfinished TODO entries only."
838 :group 'org-agenda-skip
839 :group 'org-agenda-todo-list
840 :group 'org-agenda-match-view
841 :type 'boolean)
843 (defcustom org-agenda-skip-scheduled-if-done nil
844 "Non-nil means don't show scheduled items in agenda when they are done.
845 This is relevant for the daily/weekly agenda, not for the TODO list. And
846 it applies only to the actual date of the scheduling. Warnings about
847 an item with a past scheduling dates are always turned off when the item
848 is DONE."
849 :group 'org-agenda-skip
850 :group 'org-agenda-daily/weekly
851 :type 'boolean)
853 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
854 "Non-nil means skip scheduling line if same entry shows because of deadline.
856 In the agenda of today, an entry can show up multiple times
857 because it is both scheduled and has a nearby deadline, and maybe
858 a plain time stamp as well.
860 When this variable is nil, the entry will be shown several times.
862 When set to t, then only the deadline is shown and the fact that
863 the entry is scheduled today or was scheduled previously is not
864 shown.
866 When set to the symbol `not-today', skip scheduled previously,
867 but not scheduled today.
869 When set to the symbol `repeated-after-deadline', skip scheduled
870 items if they are repeated beyond the current deadline."
871 :group 'org-agenda-skip
872 :group 'org-agenda-daily/weekly
873 :type '(choice
874 (const :tag "Never" nil)
875 (const :tag "Always" t)
876 (const :tag "Not when scheduled today" not-today)
877 (const :tag "When repeated past deadline" repeated-after-deadline)))
879 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
880 "Non-nil means skip timestamp line if same entry shows because of deadline.
881 In the agenda of today, an entry can show up multiple times
882 because it has both a plain timestamp and has a nearby deadline.
883 When this variable is t, then only the deadline is shown and the
884 fact that the entry has a timestamp for or including today is not
885 shown. When this variable is nil, the entry will be shown
886 several times."
887 :group 'org-agenda-skip
888 :group 'org-agenda-daily/weekly
889 :version "24.1"
890 :type '(choice
891 (const :tag "Never" nil)
892 (const :tag "Always" t)))
894 (defcustom org-agenda-skip-deadline-if-done nil
895 "Non-nil means don't show deadlines when the corresponding item is done.
896 When nil, the deadline is still shown and should give you a happy feeling.
897 This is relevant for the daily/weekly agenda. And it applied only to the
898 actually date of the deadline. Warnings about approaching and past-due
899 deadlines are always turned off when the item is DONE."
900 :group 'org-agenda-skip
901 :group 'org-agenda-daily/weekly
902 :type 'boolean)
904 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
905 "Non-nil means skip deadline prewarning when entry is also scheduled.
906 This will apply on all days where a prewarning for the deadline would
907 be shown, but not at the day when the entry is actually due. On that day,
908 the deadline will be shown anyway.
909 This variable may be set to nil, t, the symbol `pre-scheduled',
910 or a number which will then give the number of days before the actual
911 deadline when the prewarnings should resume. The symbol `pre-scheduled'
912 eliminates the deadline prewarning only prior to the scheduled date.
913 This can be used in a workflow where the first showing of the deadline will
914 trigger you to schedule it, and then you don't want to be reminded of it
915 because you will take care of it on the day when scheduled."
916 :group 'org-agenda-skip
917 :group 'org-agenda-daily/weekly
918 :version "24.1"
919 :type '(choice
920 (const :tag "Always show prewarning" nil)
921 (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
922 (const :tag "Remove prewarning if entry is scheduled" t)
923 (integer :tag "Restart prewarning N days before deadline")))
925 (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
926 "Non-nil means skip scheduled delay when entry also has a deadline.
927 This variable may be set to nil, t, the symbol `post-deadline',
928 or a number which will then give the number of days after the actual
929 scheduled date when the delay should expire. The symbol `post-deadline'
930 eliminates the schedule delay when the date is posterior to the deadline."
931 :group 'org-agenda-skip
932 :group 'org-agenda-daily/weekly
933 :version "24.4"
934 :package-version '(Org . "8.0")
935 :type '(choice
936 (const :tag "Always honor delay" nil)
937 (const :tag "Ignore delay if posterior to the deadline" post-deadline)
938 (const :tag "Ignore delay if entry has a deadline" t)
939 (integer :tag "Honor delay up until N days after the scheduled date")))
941 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
942 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
943 When non-nil, after the search for timestamps has matched once in an
944 entry, the rest of the entry will not be searched."
945 :group 'org-agenda-skip
946 :type 'boolean)
948 (defcustom org-agenda-skip-timestamp-if-done nil
949 "Non-nil means don't select item by timestamp or -range if it is DONE."
950 :group 'org-agenda-skip
951 :group 'org-agenda-daily/weekly
952 :type 'boolean)
954 (defcustom org-agenda-dim-blocked-tasks t
955 "Non-nil means dim blocked tasks in the agenda display.
956 This causes some overhead during agenda construction, but if you
957 have turned on `org-enforce-todo-dependencies',
958 `org-enforce-todo-checkbox-dependencies', or any other blocking
959 mechanism, this will create useful feedback in the agenda.
961 Instead of t, this variable can also have the value `invisible'.
962 Then blocked tasks will be invisible and only become visible when
963 they become unblocked. An exemption to this behavior is when a task is
964 blocked because of unchecked checkboxes below it. Since checkboxes do
965 not show up in the agenda views, making this task invisible you remove any
966 trace from agenda views that there is something to do. Therefore, a task
967 that is blocked because of checkboxes will never be made invisible, it
968 will only be dimmed."
969 :group 'org-agenda-daily/weekly
970 :group 'org-agenda-todo-list
971 :version "24.3"
972 :type '(choice
973 (const :tag "Do not dim" nil)
974 (const :tag "Dim to a gray face" t)
975 (const :tag "Make invisible" invisible)))
977 (defcustom org-timeline-show-empty-dates 3
978 "Non-nil means `org-timeline' also shows dates without an entry.
979 When nil, only the days which actually have entries are shown.
980 When t, all days between the first and the last date are shown.
981 When an integer, show also empty dates, but if there is a gap of more than
982 N days, just insert a special line indicating the size of the gap."
983 :group 'org-agenda-skip
984 :type '(choice
985 (const :tag "None" nil)
986 (const :tag "All" t)
987 (integer :tag "at most")))
989 (defgroup org-agenda-startup nil
990 "Options concerning initial settings in the Agenda in Org Mode."
991 :tag "Org Agenda Startup"
992 :group 'org-agenda)
994 (defcustom org-agenda-menu-show-matcher t
995 "Non-nil means show the match string in the agenda dispatcher menu.
996 When nil, the matcher string is not shown, but is put into the help-echo
997 property so than moving the mouse over the command shows it.
998 Setting it to nil is good if matcher strings are very long and/or if
999 you want to use two-columns display (see `org-agenda-menu-two-columns')."
1000 :group 'org-agenda
1001 :version "24.1"
1002 :type 'boolean)
1004 (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
1006 (defcustom org-agenda-menu-two-columns nil
1007 "Non-nil means, use two columns to show custom commands in the dispatcher.
1008 If you use this, you probably want to set `org-agenda-menu-show-matcher'
1009 to nil."
1010 :group 'org-agenda
1011 :version "24.1"
1012 :type 'boolean)
1014 (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
1015 (defcustom org-agenda-finalize-hook nil
1016 "Hook run just before displaying an agenda buffer.
1017 The buffer is still writable when the hook is called.
1019 You can modify some of the buffer substrings but you should be
1020 extra careful not to modify the text properties of the agenda
1021 headlines as the agenda display heavily relies on them."
1022 :group 'org-agenda-startup
1023 :type 'hook)
1025 (defcustom org-agenda-mouse-1-follows-link nil
1026 "Non-nil means mouse-1 on a link will follow the link in the agenda.
1027 A longer mouse click will still set point. Does not work on XEmacs.
1028 Needs to be set before org.el is loaded."
1029 :group 'org-agenda-startup
1030 :type 'boolean)
1032 (defcustom org-agenda-start-with-follow-mode nil
1033 "The initial value of follow mode in a newly created agenda window."
1034 :group 'org-agenda-startup
1035 :type 'boolean)
1037 (defcustom org-agenda-follow-indirect nil
1038 "Non-nil means `org-agenda-follow-mode' displays only the
1039 current item's tree, in an indirect buffer."
1040 :group 'org-agenda
1041 :version "24.1"
1042 :type 'boolean)
1044 (defcustom org-agenda-show-outline-path t
1045 "Non-nil means show outline path in echo area after line motion."
1046 :group 'org-agenda-startup
1047 :type 'boolean)
1049 (defcustom org-agenda-start-with-entry-text-mode nil
1050 "The initial value of entry-text-mode in a newly created agenda window."
1051 :group 'org-agenda-startup
1052 :type 'boolean)
1054 (defcustom org-agenda-entry-text-maxlines 5
1055 "Number of text lines to be added when `E' is pressed in the agenda.
1057 Note that this variable only used during agenda display. Add add entry text
1058 when exporting the agenda, configure the variable
1059 `org-agenda-add-entry-ext-maxlines'."
1060 :group 'org-agenda
1061 :type 'integer)
1063 (defcustom org-agenda-entry-text-exclude-regexps nil
1064 "List of regular expressions to clean up entry text.
1065 The complete matches of all regular expressions in this list will be
1066 removed from entry text before it is shown in the agenda."
1067 :group 'org-agenda
1068 :type '(repeat (regexp)))
1070 (defcustom org-agenda-entry-text-leaders " > "
1071 "Text prepended to the entry text in agenda buffers."
1072 :version "24.4"
1073 :package-version '(Org . "8.0")
1074 :group 'org-agenda
1075 :type 'string)
1077 (defvar org-agenda-entry-text-cleanup-hook nil
1078 "Hook that is run after basic cleanup of entry text to be shown in agenda.
1079 This cleanup is done in a temporary buffer, so the function may inspect and
1080 change the entire buffer.
1081 Some default stuff like drawers and scheduling/deadline dates will already
1082 have been removed when this is called, as will any matches for regular
1083 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
1085 (defvar org-agenda-include-inactive-timestamps nil
1086 "Non-nil means include inactive time stamps in agenda and timeline.
1087 Dynamically scoped.")
1089 (defgroup org-agenda-windows nil
1090 "Options concerning the windows used by the Agenda in Org Mode."
1091 :tag "Org Agenda Windows"
1092 :group 'org-agenda)
1094 (defcustom org-agenda-window-setup 'reorganize-frame
1095 "How the agenda buffer should be displayed.
1096 Possible values for this option are:
1098 current-window Show agenda in the current window, keeping all other windows.
1099 other-window Use `switch-to-buffer-other-window' to display agenda.
1100 reorganize-frame Show only two windows on the current frame, the current
1101 window and the agenda.
1102 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1103 Also, when exiting the agenda, kill that frame.
1104 See also the variable `org-agenda-restore-windows-after-quit'."
1105 :group 'org-agenda-windows
1106 :type '(choice
1107 (const current-window)
1108 (const other-frame)
1109 (const other-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)
2084 (defconst org-agenda-local-vars
2085 '(org-agenda-this-buffer-name
2086 org-agenda-undo-list
2087 org-agenda-pending-undo-list
2088 org-agenda-follow-mode
2089 org-agenda-entry-text-mode
2090 org-agenda-clockreport-mode
2091 org-agenda-show-log
2092 org-agenda-redo-command
2093 org-agenda-query-string
2094 org-agenda-type
2095 org-agenda-bulk-marked-entries
2096 org-agenda-undo-has-started-in
2097 org-agenda-info
2098 org-agenda-pre-window-conf
2099 org-agenda-columns-active
2100 org-agenda-tag-filter
2101 org-agenda-category-filter
2102 org-agenda-top-headline-filter
2103 org-agenda-regexp-filter
2104 org-agenda-markers
2105 org-agenda-last-search-view-search-was-boolean
2106 org-agenda-filtered-by-category
2107 org-agenda-filter-form
2108 org-agenda-cycle-counter
2109 org-agenda-last-prefix-arg)
2110 "Variables that must be local in agenda buffers to allow multiple buffers.")
2112 (defun org-agenda-mode ()
2113 "Mode for time-sorted view on action items in Org-mode files.
2115 The following commands are available:
2117 \\{org-agenda-mode-map}"
2118 (interactive)
2119 (cond (org-agenda-doing-sticky-redo
2120 ;; Refreshing sticky agenda-buffer
2122 ;; Preserve the value of `org-agenda-local-vars' variables,
2123 ;; while letting `kill-all-local-variables' kill the rest
2124 (let ((save (buffer-local-variables)))
2125 (kill-all-local-variables)
2126 (mapc 'make-local-variable org-agenda-local-vars)
2127 (dolist (elem save)
2128 (let ((var (car elem))
2129 (val (cdr elem)))
2130 (when (and val
2131 (member var org-agenda-local-vars))
2132 (set var val)))))
2133 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2134 (org-agenda-sticky
2135 ;; Creating a sticky Agenda buffer for the first time
2136 (kill-all-local-variables)
2137 (mapc 'make-local-variable org-agenda-local-vars)
2138 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2140 ;; Creating a non-sticky agenda buffer
2141 (kill-all-local-variables)
2142 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
2143 (setq org-agenda-undo-list nil
2144 org-agenda-pending-undo-list nil
2145 org-agenda-bulk-marked-entries nil)
2146 (setq major-mode 'org-agenda-mode)
2147 ;; Keep global-font-lock-mode from turning on font-lock-mode
2148 (org-set-local 'font-lock-global-modes (list 'not major-mode))
2149 (setq mode-name "Org-Agenda")
2150 (setq indent-tabs-mode nil)
2151 (use-local-map org-agenda-mode-map)
2152 (easy-menu-add org-agenda-menu)
2153 (if org-startup-truncated (setq truncate-lines t))
2154 (org-set-local 'line-move-visual nil)
2155 (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
2156 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
2157 ;; Make sure properties are removed when copying text
2158 (org-add-hook 'filter-buffer-substring-functions
2159 (lambda (fun start end delete)
2160 (substring-no-properties (funcall fun start end delete)))
2161 nil t)
2162 (unless org-agenda-keep-modes
2163 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2164 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
2165 (setq org-agenda-show-log org-agenda-start-with-log-mode)
2166 (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
2167 (add-to-invisibility-spec '(org-filtered))
2168 (add-to-invisibility-spec '(org-link))
2169 (easy-menu-change
2170 '("Agenda") "Agenda Files"
2171 (append
2172 (list
2173 (vector
2174 (if (get 'org-agenda-files 'org-restrict)
2175 "Restricted to single file"
2176 "Edit File List")
2177 '(org-edit-agenda-file-list)
2178 (not (get 'org-agenda-files 'org-restrict)))
2179 "--")
2180 (mapcar 'org-file-menu-entry (org-agenda-files))))
2181 (org-agenda-set-mode-name)
2182 (apply
2183 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
2184 (list 'org-agenda-mode-hook)))
2186 (substitute-key-definition 'undo 'org-agenda-undo
2187 org-agenda-mode-map global-map)
2188 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
2189 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
2190 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
2191 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
2192 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2193 (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
2194 (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
2195 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2196 (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
2197 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2198 (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
2199 (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
2200 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2201 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2202 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2203 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2204 (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
2205 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2206 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2207 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2208 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2209 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2210 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2211 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2212 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2213 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2214 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2215 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2216 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2217 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2218 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2219 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2220 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2221 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2222 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2223 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2224 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2225 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2226 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2227 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2228 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2229 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2230 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2231 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2232 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2233 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2234 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2235 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2236 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2237 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2239 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2240 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2241 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2242 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2243 (while l (org-defkey org-agenda-mode-map
2244 (int-to-string (pop l)) 'digit-argument)))
2246 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2247 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2248 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2249 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2250 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2251 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2252 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2253 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2254 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2255 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2256 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2257 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2258 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2259 'org-clock-modify-effort-estimate)
2260 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2261 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2262 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2263 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2264 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2265 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2266 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2267 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2268 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2269 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2270 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2271 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2272 (substitute-key-definition 'next-line 'org-agenda-next-line
2273 org-agenda-mode-map global-map)
2274 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2275 org-agenda-mode-map global-map)
2276 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2277 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2278 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2279 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2280 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2281 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2282 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2283 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2284 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2285 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2286 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2287 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2288 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2289 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2290 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2291 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2292 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2293 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2294 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2295 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2296 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2297 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2298 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2299 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2300 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2301 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2302 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2303 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2304 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2305 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2307 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2308 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2309 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2310 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2311 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2312 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2313 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2314 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2315 (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
2316 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2317 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
2318 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2319 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2320 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2321 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2323 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2324 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2325 (when org-agenda-mouse-1-follows-link
2326 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2327 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2328 '("Agenda"
2329 ("Agenda Files")
2330 "--"
2331 ("Agenda Dates"
2332 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2333 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2334 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2335 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2336 "--"
2337 ("View"
2338 ["Day View" org-agenda-day-view
2339 :active (org-agenda-check-type nil 'agenda)
2340 :style radio :selected (eq org-agenda-current-span 'day)
2341 :keys "v d (or just d)"]
2342 ["Week View" org-agenda-week-view
2343 :active (org-agenda-check-type nil 'agenda)
2344 :style radio :selected (eq org-agenda-current-span 'week)
2345 :keys "v w"]
2346 ["Fortnight View" org-agenda-fortnight-view
2347 :active (org-agenda-check-type nil 'agenda)
2348 :style radio :selected (eq org-agenda-current-span 'fortnight)
2349 :keys "v f"]
2350 ["Month View" org-agenda-month-view
2351 :active (org-agenda-check-type nil 'agenda)
2352 :style radio :selected (eq org-agenda-current-span 'month)
2353 :keys "v m"]
2354 ["Year View" org-agenda-year-view
2355 :active (org-agenda-check-type nil 'agenda)
2356 :style radio :selected (eq org-agenda-current-span 'year)
2357 :keys "v y"]
2358 "--"
2359 ["Include Diary" org-agenda-toggle-diary
2360 :style toggle :selected org-agenda-include-diary
2361 :active (org-agenda-check-type nil 'agenda)]
2362 ["Include Deadlines" org-agenda-toggle-deadlines
2363 :style toggle :selected org-agenda-include-deadlines
2364 :active (org-agenda-check-type nil 'agenda)]
2365 ["Use Time Grid" org-agenda-toggle-time-grid
2366 :style toggle :selected org-agenda-use-time-grid
2367 :active (org-agenda-check-type nil 'agenda)]
2368 "--"
2369 ["Show clock report" org-agenda-clockreport-mode
2370 :style toggle :selected org-agenda-clockreport-mode
2371 :active (org-agenda-check-type nil 'agenda)]
2372 ["Show some entry text" org-agenda-entry-text-mode
2373 :style toggle :selected org-agenda-entry-text-mode
2374 :active t]
2375 "--"
2376 ["Show Logbook entries" org-agenda-log-mode
2377 :style toggle :selected org-agenda-show-log
2378 :active (org-agenda-check-type nil 'agenda 'timeline)
2379 :keys "v l (or just l)"]
2380 ["Include archived trees" org-agenda-archives-mode
2381 :style toggle :selected org-agenda-archives-mode :active t
2382 :keys "v a"]
2383 ["Include archive files" (org-agenda-archives-mode t)
2384 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2385 :keys "v A"]
2386 "--"
2387 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2388 ["Write view to file" org-agenda-write t]
2389 ["Rebuild buffer" org-agenda-redo t]
2390 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2391 "--"
2392 ["Show original entry" org-agenda-show t]
2393 ["Go To (other window)" org-agenda-goto t]
2394 ["Go To (this window)" org-agenda-switch-to t]
2395 ["Capture with cursor date" org-agenda-capture t]
2396 ["Follow Mode" org-agenda-follow-mode
2397 :style toggle :selected org-agenda-follow-mode :active t]
2398 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2399 "--"
2400 ("TODO"
2401 ["Cycle TODO" org-agenda-todo t]
2402 ["Next TODO set" org-agenda-todo-nextset t]
2403 ["Previous TODO set" org-agenda-todo-previousset t]
2404 ["Add note" org-agenda-add-note t])
2405 ("Archive/Refile/Delete"
2406 ["Archive default" org-agenda-archive-default t]
2407 ["Archive default" org-agenda-archive-default-with-confirmation t]
2408 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2409 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2410 ["Archive subtree" org-agenda-archive t]
2411 "--"
2412 ["Refile" org-agenda-refile t]
2413 "--"
2414 ["Delete subtree" org-agenda-kill t])
2415 ("Bulk action"
2416 ["Mark entry" org-agenda-bulk-mark t]
2417 ["Mark all" org-agenda-bulk-mark-all t]
2418 ["Unmark entry" org-agenda-bulk-unmark t]
2419 ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
2420 ["Toggle mark" org-agenda-bulk-toggle t]
2421 ["Toggle all" org-agenda-bulk-toggle-all t]
2422 ["Mark regexp" org-agenda-bulk-mark-regexp t])
2423 ["Act on all marked" org-agenda-bulk-action t]
2424 "--"
2425 ("Tags and Properties"
2426 ["Show all Tags" org-agenda-show-tags t]
2427 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2428 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2429 "--"
2430 ["Column View" org-columns t])
2431 ("Deadline/Schedule"
2432 ["Schedule" org-agenda-schedule t]
2433 ["Set Deadline" org-agenda-deadline t]
2434 "--"
2435 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2436 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2437 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2438 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2439 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2440 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2441 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2442 ("Clock and Effort"
2443 ["Clock in" org-agenda-clock-in t]
2444 ["Clock out" org-agenda-clock-out t]
2445 ["Clock cancel" org-agenda-clock-cancel t]
2446 ["Goto running clock" org-clock-goto t]
2447 "--"
2448 ["Set Effort" org-agenda-set-effort t]
2449 ["Change clocked effort" org-clock-modify-effort-estimate
2450 (org-clock-is-active)])
2451 ("Priority"
2452 ["Set Priority" org-agenda-priority t]
2453 ["Increase Priority" org-agenda-priority-up t]
2454 ["Decrease Priority" org-agenda-priority-down t]
2455 ["Show Priority" org-show-priority t])
2456 ("Calendar/Diary"
2457 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2458 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2459 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2460 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2461 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2462 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2463 "--"
2464 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2465 "--"
2466 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2467 "--"
2468 ("MobileOrg"
2469 ["Push Files and Views" org-mobile-push t]
2470 ["Get Captured and Flagged" org-mobile-pull t]
2471 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2472 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2473 "--"
2474 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2475 "--"
2476 ["Quit" org-agenda-quit t]
2477 ["Exit and Release Buffers" org-agenda-exit t]
2480 ;;; Agenda undo
2482 (defvar org-agenda-allow-remote-undo t
2483 "Non-nil means allow remote undo from the agenda buffer.")
2484 (defvar org-agenda-undo-has-started-in nil
2485 "Buffers that have already seen `undo-start' in the current undo sequence.")
2487 (defun org-agenda-undo ()
2488 "Undo a remote editing step in the agenda.
2489 This undoes changes both in the agenda buffer and in the remote buffer
2490 that have been changed along."
2491 (interactive)
2492 (or org-agenda-allow-remote-undo
2493 (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2494 (if (not (eq this-command last-command))
2495 (setq org-agenda-undo-has-started-in nil
2496 org-agenda-pending-undo-list org-agenda-undo-list))
2497 (if (not org-agenda-pending-undo-list)
2498 (user-error "No further undo information"))
2499 (let* ((entry (pop org-agenda-pending-undo-list))
2500 buf line cmd rembuf)
2501 (setq cmd (pop entry) line (pop entry))
2502 (setq rembuf (nth 2 entry))
2503 (org-with-remote-undo rembuf
2504 (while (bufferp (setq buf (pop entry)))
2505 (if (pop entry)
2506 (with-current-buffer buf
2507 (let ((last-undo-buffer buf)
2508 (inhibit-read-only t))
2509 (unless (memq buf org-agenda-undo-has-started-in)
2510 (push buf org-agenda-undo-has-started-in)
2511 (make-local-variable 'pending-undo-list)
2512 (undo-start))
2513 (while (and pending-undo-list
2514 (listp pending-undo-list)
2515 (not (car pending-undo-list)))
2516 (pop pending-undo-list))
2517 (undo-more 1))))))
2518 (org-goto-line line)
2519 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2521 (defun org-verify-change-for-undo (l1 l2)
2522 "Verify that a real change occurred between the undo lists L1 and L2."
2523 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2524 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2525 (not (eq l1 l2)))
2527 ;;; Agenda dispatch
2529 (defvar org-agenda-restrict-begin (make-marker))
2530 (defvar org-agenda-restrict-end (make-marker))
2531 (defvar org-agenda-last-dispatch-buffer nil)
2532 (defvar org-agenda-overriding-restriction nil)
2534 (defcustom org-agenda-custom-commands-contexts nil
2535 "Alist of custom agenda keys and contextual rules.
2537 For example, if you have a custom agenda command \"p\" and you
2538 want this command to be accessible only from plain text files,
2539 use this:
2541 \\='((\"p\" ((in-file . \"\\.txt\"))))
2543 Here are the available contexts definitions:
2545 in-file: command displayed only in matching files
2546 in-mode: command displayed only in matching modes
2547 not-in-file: command not displayed in matching files
2548 not-in-mode: command not displayed in matching modes
2549 in-buffer: command displayed only in matching buffers
2550 not-in-buffer: command not displayed in matching buffers
2551 [function]: a custom function taking no argument
2553 If you define several checks, the agenda command will be
2554 accessible if there is at least one valid check.
2556 You can also bind a key to another agenda custom command
2557 depending on contextual rules.
2559 \\='((\"p\" \"q\" ((in-file . \"\\.txt\"))))
2561 Here it means: in .txt files, use \"p\" as the key for the
2562 agenda command otherwise associated with \"q\". (The command
2563 originally associated with \"q\" is not displayed to avoid
2564 duplicates.)"
2565 :version "24.3"
2566 :group 'org-agenda-custom-commands
2567 :type '(repeat (list :tag "Rule"
2568 (string :tag " Agenda key")
2569 (string :tag "Replace by command")
2570 (repeat :tag "Available when"
2571 (choice
2572 (cons :tag "Condition"
2573 (choice
2574 (const :tag "In file" in-file)
2575 (const :tag "Not in file" not-in-file)
2576 (const :tag "In buffer" in-buffer)
2577 (const :tag "Not in buffer" not-in-buffer)
2578 (const :tag "In mode" in-mode)
2579 (const :tag "Not in mode" not-in-mode))
2580 (regexp))
2581 (function :tag "Custom function"))))))
2583 (defcustom org-agenda-max-entries nil
2584 "Maximum number of entries to display in an agenda.
2585 This can be nil (no limit) or an integer or an alist of agenda
2586 types with an associated number of entries to display in this
2587 type."
2588 :version "24.4"
2589 :package-version '(Org . "8.0")
2590 :group 'org-agenda-custom-commands
2591 :type '(choice (symbol :tag "No limit" nil)
2592 (integer :tag "Max number of entries")
2593 (repeat
2594 (cons (choice :tag "Agenda type"
2595 (const agenda)
2596 (const todo)
2597 (const tags)
2598 (const search)
2599 (const timeline))
2600 (integer :tag "Max number of entries")))))
2602 (defcustom org-agenda-max-todos nil
2603 "Maximum number of TODOs to display in an agenda.
2604 This can be nil (no limit) or an integer or an alist of agenda
2605 types with an associated number of entries to display in this
2606 type."
2607 :version "24.4"
2608 :package-version '(Org . "8.0")
2609 :group 'org-agenda-custom-commands
2610 :type '(choice (symbol :tag "No limit" nil)
2611 (integer :tag "Max number of TODOs")
2612 (repeat
2613 (cons (choice :tag "Agenda type"
2614 (const agenda)
2615 (const todo)
2616 (const tags)
2617 (const search)
2618 (const timeline))
2619 (integer :tag "Max number of TODOs")))))
2621 (defcustom org-agenda-max-tags nil
2622 "Maximum number of tagged entries to display in an agenda.
2623 This can be nil (no limit) or an integer or an alist of agenda
2624 types with an associated number of entries to display in this
2625 type."
2626 :version "24.4"
2627 :package-version '(Org . "8.0")
2628 :group 'org-agenda-custom-commands
2629 :type '(choice (symbol :tag "No limit" nil)
2630 (integer :tag "Max number of tagged entries")
2631 (repeat
2632 (cons (choice :tag "Agenda type"
2633 (const agenda)
2634 (const todo)
2635 (const tags)
2636 (const search)
2637 (const timeline))
2638 (integer :tag "Max number of tagged entries")))))
2640 (defcustom org-agenda-max-effort nil
2641 "Maximum cumulated effort duration for the agenda.
2642 This can be nil (no limit) or a number of minutes (as an integer)
2643 or an alist of agenda types with an associated number of minutes
2644 to limit entries to in this type."
2645 :version "24.4"
2646 :package-version '(Org . "8.0")
2647 :group 'org-agenda-custom-commands
2648 :type '(choice (symbol :tag "No limit" nil)
2649 (integer :tag "Max number of minutes")
2650 (repeat
2651 (cons (choice :tag "Agenda type"
2652 (const agenda)
2653 (const todo)
2654 (const tags)
2655 (const search)
2656 (const timeline))
2657 (integer :tag "Max number of minutes")))))
2659 (defvar org-keys nil)
2660 (defvar org-match nil)
2661 ;;;###autoload
2662 (defun org-agenda (&optional arg org-keys restriction)
2663 "Dispatch agenda commands to collect entries to the agenda buffer.
2664 Prompts for a command to execute. Any prefix arg will be passed
2665 on to the selected command. The default selections are:
2667 a Call `org-agenda-list' to display the agenda for current day or week.
2668 t Call `org-todo-list' to display the global todo list.
2669 T Call `org-todo-list' to display the global todo list, select only
2670 entries with a specific TODO keyword (the user gets a prompt).
2671 m Call `org-tags-view' to display headlines with tags matching
2672 a condition (the user is prompted for the condition).
2673 M Like `m', but select only TODO entries, no ordinary headlines.
2674 L Create a timeline for the current buffer.
2675 e Export views to associated files.
2676 s Search entries for keywords.
2677 S Search entries for keywords, only with TODO keywords.
2678 / Multi occur across all agenda files and also files listed
2679 in `org-agenda-text-search-extra-files'.
2680 < Restrict agenda commands to buffer, subtree, or region.
2681 Press several times to get the desired effect.
2682 > Remove a previous restriction.
2683 # List \"stuck\" projects.
2684 ! Configure what \"stuck\" means.
2685 C Configure custom agenda commands.
2687 More commands can be added by configuring the variable
2688 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2689 searches can be pre-defined in this way.
2691 If the current buffer is in Org-mode and visiting a file, you can also
2692 first press `<' once to indicate that the agenda should be temporarily
2693 \(until the next use of \\[org-agenda]) restricted to the current file.
2694 Pressing `<' twice means to restrict to the current subtree or region
2695 \(if active)."
2696 (interactive "P")
2697 (catch 'exit
2698 (let* ((prefix-descriptions nil)
2699 (org-agenda-buffer-name org-agenda-buffer-name)
2700 (org-agenda-window-setup (if (equal (buffer-name)
2701 org-agenda-buffer-name)
2702 'current-window
2703 org-agenda-window-setup))
2704 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2705 (org-agenda-custom-commands
2706 ;; normalize different versions
2707 (delq nil
2708 (mapcar
2709 (lambda (x)
2710 (cond ((stringp (cdr x))
2711 (push x prefix-descriptions)
2712 nil)
2713 ((stringp (nth 1 x)) x)
2714 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2715 (t (cons (car x) (cons "" (cdr x))))))
2716 org-agenda-custom-commands)))
2717 (org-agenda-custom-commands
2718 (org-contextualize-keys
2719 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2720 (buf (current-buffer))
2721 (bfn (buffer-file-name (buffer-base-buffer)))
2722 entry key type org-match lprops ans)
2723 ;; Turn off restriction unless there is an overriding one,
2724 (unless org-agenda-overriding-restriction
2725 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2726 ;; There is a request to keep the file list in place
2727 (put 'org-agenda-files 'org-restrict nil))
2728 (setq org-agenda-restrict nil)
2729 (move-marker org-agenda-restrict-begin nil)
2730 (move-marker org-agenda-restrict-end nil))
2731 ;; Delete old local properties
2732 (put 'org-agenda-redo-command 'org-lprops nil)
2733 ;; Delete previously set last-arguments
2734 (put 'org-agenda-redo-command 'last-args nil)
2735 ;; Remember where this call originated
2736 (setq org-agenda-last-dispatch-buffer (current-buffer))
2737 (unless org-keys
2738 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2739 org-keys (car ans)
2740 restriction (cdr ans)))
2741 ;; If we have sticky agenda buffers, set a name for the buffer,
2742 ;; depending on the invoking keys. The user may still set this
2743 ;; as a command option, which will overwrite what we do here.
2744 (if org-agenda-sticky
2745 (setq org-agenda-buffer-name
2746 (format "*Org Agenda(%s)*" org-keys)))
2747 ;; Establish the restriction, if any
2748 (when (and (not org-agenda-overriding-restriction) restriction)
2749 (put 'org-agenda-files 'org-restrict (list bfn))
2750 (cond
2751 ((eq restriction 'region)
2752 (setq org-agenda-restrict (current-buffer))
2753 (move-marker org-agenda-restrict-begin (region-beginning))
2754 (move-marker org-agenda-restrict-end (region-end)))
2755 ((eq restriction 'subtree)
2756 (save-excursion
2757 (setq org-agenda-restrict (current-buffer))
2758 (org-back-to-heading t)
2759 (move-marker org-agenda-restrict-begin (point))
2760 (move-marker org-agenda-restrict-end
2761 (progn (org-end-of-subtree t)))))))
2763 ;; For example the todo list should not need it (but does...)
2764 (cond
2765 ((setq entry (assoc org-keys org-agenda-custom-commands))
2766 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2767 (progn
2768 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2769 lprops (nth 4 entry))
2770 (if org-agenda-sticky
2771 (setq org-agenda-buffer-name
2772 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2773 (format "*Org Agenda(%s)*" org-keys))))
2774 (put 'org-agenda-redo-command 'org-lprops lprops)
2775 (cond
2776 ((eq type 'agenda)
2777 (org-let lprops '(org-agenda-list current-prefix-arg)))
2778 ((eq type 'agenda*)
2779 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2780 ((eq type 'alltodo)
2781 (org-let lprops '(org-todo-list current-prefix-arg)))
2782 ((eq type 'search)
2783 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2784 ((eq type 'stuck)
2785 (org-let lprops '(org-agenda-list-stuck-projects
2786 current-prefix-arg)))
2787 ((eq type 'tags)
2788 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2789 ((eq type 'tags-todo)
2790 (org-let lprops '(org-tags-view '(4) org-match)))
2791 ((eq type 'todo)
2792 (org-let lprops '(org-todo-list org-match)))
2793 ((eq type 'tags-tree)
2794 (org-check-for-org-mode)
2795 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2796 ((eq type 'todo-tree)
2797 (org-check-for-org-mode)
2798 (org-let lprops
2799 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2800 (regexp-quote org-match) "\\>"))))
2801 ((eq type 'occur-tree)
2802 (org-check-for-org-mode)
2803 (org-let lprops '(org-occur org-match)))
2804 ((functionp type)
2805 (org-let lprops '(funcall type org-match)))
2806 ((fboundp type)
2807 (org-let lprops '(funcall type org-match)))
2808 (t (user-error "Invalid custom agenda command type %s" type))))
2809 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2810 ((equal org-keys "C")
2811 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2812 (customize-variable 'org-agenda-custom-commands))
2813 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2814 ((equal org-keys "s") (call-interactively 'org-search-view))
2815 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2816 ((equal org-keys "t") (call-interactively 'org-todo-list))
2817 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2818 ((equal org-keys "m") (call-interactively 'org-tags-view))
2819 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2820 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2821 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2822 (org-add-hook
2823 'post-command-hook
2824 (lambda ()
2825 (unless (current-message)
2826 (let* ((m (org-agenda-get-any-marker))
2827 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2828 (when note
2829 (message (concat
2830 "FLAGGING-NOTE ([?] for more info): "
2831 (org-add-props
2832 (replace-regexp-in-string
2833 "\\\\n" "//"
2834 (copy-sequence note))
2835 nil 'face 'org-warning)))))))
2836 t t))
2837 ((equal org-keys "L")
2838 (unless (derived-mode-p 'org-mode)
2839 (user-error "This is not an Org-mode file"))
2840 (unless restriction
2841 (put 'org-agenda-files 'org-restrict (list bfn))
2842 (org-call-with-arg 'org-timeline arg)))
2843 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2844 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2845 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2846 (t (user-error "Invalid agenda key"))))))
2848 (defvar org-agenda-multi)
2850 (defun org-agenda-append-agenda ()
2851 "Append another agenda view to the current one.
2852 This function allows interactive building of block agendas.
2853 Agenda views are separated by `org-agenda-block-separator'."
2854 (interactive)
2855 (unless (derived-mode-p 'org-agenda-mode)
2856 (user-error "Can only append from within agenda buffer"))
2857 (let ((org-agenda-multi t))
2858 (org-agenda)
2859 (widen)
2860 (org-agenda-finalize)
2861 (setq buffer-read-only t)
2862 (org-agenda-fit-window-to-buffer)))
2864 (defun org-agenda-normalize-custom-commands (cmds)
2865 "Normalize custom commands CMDS."
2866 (delq nil
2867 (mapcar
2868 (lambda (x)
2869 (cond ((stringp (cdr x)) nil)
2870 ((stringp (nth 1 x)) x)
2871 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2872 (t (cons (car x) (cons "" (cdr x))))))
2873 cmds)))
2875 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2876 "The user interface for selecting an agenda command."
2877 (catch 'exit
2878 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2879 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2880 (region-p (org-region-active-p))
2881 (custom org-agenda-custom-commands)
2882 (selstring "")
2883 restriction second-time
2884 c entry key type match prefixes rmheader header-end custom1 desc
2885 line lines left right n n1)
2886 (save-window-excursion
2887 (delete-other-windows)
2888 (org-switch-to-buffer-other-window " *Agenda Commands*")
2889 (erase-buffer)
2890 (insert (eval-when-compile
2891 (let ((header
2892 "Press key for an agenda command: < Buffer, subtree/region restriction
2893 -------------------------------- > Remove restriction
2894 a Agenda for current week or day e Export agenda views
2895 t List of all TODO entries T Entries with special TODO kwd
2896 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2897 s Search for keywords S Like s, but only TODO entries
2898 L Timeline for current buffer # List stuck projects (!=configure)
2899 / Multi-occur C Configure custom agenda commands
2900 ? Find :FLAGGED: entries * Toggle sticky agenda views
2902 (start 0))
2903 (while (string-match
2904 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2905 header start)
2906 (setq start (match-end 0))
2907 (add-text-properties (match-beginning 2) (match-end 2)
2908 '(face bold) header))
2909 header)))
2910 (setq header-end (point-marker))
2911 (while t
2912 (setq custom1 custom)
2913 (when (eq rmheader t)
2914 (org-goto-line 1)
2915 (re-search-forward ":" nil t)
2916 (delete-region (match-end 0) (point-at-eol))
2917 (forward-char 1)
2918 (looking-at "-+")
2919 (delete-region (match-end 0) (point-at-eol))
2920 (move-marker header-end (match-end 0)))
2921 (goto-char header-end)
2922 (delete-region (point) (point-max))
2924 ;; Produce all the lines that describe custom commands and prefixes
2925 (setq lines nil)
2926 (while (setq entry (pop custom1))
2927 (setq key (car entry) desc (nth 1 entry)
2928 type (nth 2 entry)
2929 match (nth 3 entry))
2930 (if (> (length key) 1)
2931 (pushnew (string-to-char key) prefixes :test #'equal)
2932 (setq line
2933 (format
2934 "%-4s%-14s"
2935 (org-add-props (copy-sequence key)
2936 '(face bold))
2937 (cond
2938 ((string-match "\\S-" desc) desc)
2939 ((eq type 'agenda) "Agenda for current week or day")
2940 ((eq type 'agenda*) "Appointments for current week or day")
2941 ((eq type 'alltodo) "List of all TODO entries")
2942 ((eq type 'search) "Word search")
2943 ((eq type 'stuck) "List of stuck projects")
2944 ((eq type 'todo) "TODO keyword")
2945 ((eq type 'tags) "Tags query")
2946 ((eq type 'tags-todo) "Tags (TODO)")
2947 ((eq type 'tags-tree) "Tags tree")
2948 ((eq type 'todo-tree) "TODO kwd tree")
2949 ((eq type 'occur-tree) "Occur tree")
2950 ((functionp type) (if (symbolp type)
2951 (symbol-name type)
2952 "Lambda expression"))
2953 (t "???"))))
2954 (if org-agenda-menu-show-matcher
2955 (setq line
2956 (concat line ": "
2957 (cond
2958 ((stringp match)
2959 (setq match (copy-sequence match))
2960 (org-add-props match nil 'face 'org-warning))
2961 ((listp type)
2962 (format "set of %d commands" (length type))))))
2963 (if (org-string-nw-p match)
2964 (add-text-properties
2965 0 (length line) (list 'help-echo
2966 (concat "Matcher: " match)) line)))
2967 (push line lines)))
2968 (setq lines (nreverse lines))
2969 (when prefixes
2970 (mapc (lambda (x)
2971 (push
2972 (format "%s %s"
2973 (org-add-props (char-to-string x)
2974 nil 'face 'bold)
2975 (or (cdr (assoc (concat selstring
2976 (char-to-string x))
2977 prefix-descriptions))
2978 "Prefix key"))
2979 lines))
2980 prefixes))
2982 ;; Check if we should display in two columns
2983 (if org-agenda-menu-two-columns
2984 (progn
2985 (setq n (length lines)
2986 n1 (+ (/ n 2) (mod n 2))
2987 right (nthcdr n1 lines)
2988 left (copy-sequence lines))
2989 (setcdr (nthcdr (1- n1) left) nil))
2990 (setq left lines right nil))
2991 (while left
2992 (insert "\n" (pop left))
2993 (when right
2994 (if (< (current-column) 40)
2995 (move-to-column 40 t)
2996 (insert " "))
2997 (insert (pop right))))
2999 ;; Make the window the right size
3000 (goto-char (point-min))
3001 (if second-time
3002 (if (not (pos-visible-in-window-p (point-max)))
3003 (org-fit-window-to-buffer))
3004 (setq second-time t)
3005 (org-fit-window-to-buffer))
3007 ;; Ask for selection
3008 (message "Press key for agenda command%s:"
3009 (if (or restrict-ok org-agenda-overriding-restriction)
3010 (if org-agenda-overriding-restriction
3011 " (restriction lock active)"
3012 (if restriction
3013 (format " (restricted to %s)" restriction)
3014 " (unrestricted)"))
3015 ""))
3016 (setq c (read-char-exclusive))
3017 (message "")
3018 (cond
3019 ((assoc (char-to-string c) custom)
3020 (setq selstring (concat selstring (char-to-string c)))
3021 (throw 'exit (cons selstring restriction)))
3022 ((memq c prefixes)
3023 (setq selstring (concat selstring (char-to-string c))
3024 prefixes nil
3025 rmheader (or rmheader t)
3026 custom (delq nil (mapcar
3027 (lambda (x)
3028 (if (or (= (length (car x)) 1)
3029 (/= (string-to-char (car x)) c))
3031 (cons (substring (car x) 1) (cdr x))))
3032 custom))))
3033 ((eq c ?*)
3034 (call-interactively 'org-toggle-sticky-agenda)
3035 (sit-for 2))
3036 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3037 (message "Restriction is only possible in Org-mode buffers")
3038 (ding) (sit-for 1))
3039 ((eq c ?1)
3040 (org-agenda-remove-restriction-lock 'noupdate)
3041 (setq restriction 'buffer))
3042 ((eq c ?0)
3043 (org-agenda-remove-restriction-lock 'noupdate)
3044 (setq restriction (if region-p 'region 'subtree)))
3045 ((eq c ?<)
3046 (org-agenda-remove-restriction-lock 'noupdate)
3047 (setq restriction
3048 (cond
3049 ((eq restriction 'buffer)
3050 (if region-p 'region 'subtree))
3051 ((memq restriction '(subtree region))
3052 nil)
3053 (t 'buffer))))
3054 ((eq c ?>)
3055 (org-agenda-remove-restriction-lock 'noupdate)
3056 (setq restriction nil))
3057 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3058 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3059 ((and (> (length selstring) 0) (eq c ?\d))
3060 (delete-window)
3061 (org-agenda-get-restriction-and-command prefix-descriptions))
3063 ((equal c ?q) (error "Abort"))
3064 (t (user-error "Invalid key %c" c))))))))
3066 (defun org-agenda-fit-window-to-buffer ()
3067 "Fit the window to the buffer size."
3068 (and (memq org-agenda-window-setup '(reorganize-frame))
3069 (fboundp 'fit-window-to-buffer)
3070 (org-fit-window-to-buffer
3072 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3073 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3075 (defvar org-cmd nil)
3076 (defvar org-agenda-overriding-cmd nil)
3077 (defvar org-agenda-overriding-arguments nil)
3078 (defvar org-agenda-overriding-cmd-arguments nil)
3079 (defun org-agenda-run-series (name series)
3080 "Run agenda NAME as a SERIES of agenda commands."
3081 (org-let (nth 1 series) '(org-agenda-prepare name))
3082 ;; We need to reset agenda markers here, because when constructing a
3083 ;; block agenda, the individual blocks do not do that.
3084 (org-agenda-reset-markers)
3085 (let* ((org-agenda-multi t)
3086 (redo (list 'org-agenda-run-series name (list 'quote series)))
3087 (cmds (car series))
3088 (gprops (nth 1 series))
3089 match ;; The byte compiler incorrectly complains about this. Keep it!
3090 org-cmd type lprops)
3091 (while (setq org-cmd (pop cmds))
3092 (setq type (car org-cmd)
3093 match (eval (nth 1 org-cmd))
3094 lprops (nth 2 org-cmd))
3095 (let ((org-agenda-overriding-arguments
3096 (if (eq org-agenda-overriding-cmd org-cmd)
3097 (or org-agenda-overriding-arguments
3098 org-agenda-overriding-cmd-arguments))))
3099 (cond
3100 ((eq type 'agenda)
3101 (org-let2 gprops lprops
3102 '(call-interactively 'org-agenda-list)))
3103 ((eq type 'agenda*)
3104 (org-let2 gprops lprops
3105 '(funcall 'org-agenda-list nil nil t)))
3106 ((eq type 'alltodo)
3107 (org-let2 gprops lprops
3108 '(call-interactively 'org-todo-list)))
3109 ((eq type 'search)
3110 (org-let2 gprops lprops
3111 '(org-search-view current-prefix-arg match nil)))
3112 ((eq type 'stuck)
3113 (org-let2 gprops lprops
3114 '(call-interactively 'org-agenda-list-stuck-projects)))
3115 ((eq type 'tags)
3116 (org-let2 gprops lprops
3117 '(org-tags-view current-prefix-arg match)))
3118 ((eq type 'tags-todo)
3119 (org-let2 gprops lprops
3120 '(org-tags-view '(4) match)))
3121 ((eq type 'todo)
3122 (org-let2 gprops lprops
3123 '(org-todo-list match)))
3124 ((fboundp type)
3125 (org-let2 gprops lprops
3126 '(funcall type match)))
3127 (t (error "Invalid type in command series")))))
3128 (widen)
3129 (let ((inhibit-read-only t))
3130 (add-text-properties (point-min) (point-max)
3131 `(org-series t org-series-redo-cmd ,redo)))
3132 (setq org-agenda-redo-command redo)
3133 (goto-char (point-min)))
3134 (org-agenda-fit-window-to-buffer)
3135 (org-let (nth 1 series) '(org-agenda-finalize)))
3137 ;;;###autoload
3138 (defmacro org-batch-agenda (cmd-key &rest parameters)
3139 "Run an agenda command in batch mode and send the result to STDOUT.
3140 If CMD-KEY is a string of length 1, it is used as a key in
3141 `org-agenda-custom-commands' and triggers this command. If it is a
3142 longer string it is used as a tags/todo match string.
3143 Parameters are alternating variable names and values that will be bound
3144 before running the agenda command."
3145 (org-eval-in-environment (org-make-parameter-alist parameters)
3146 (let (org-agenda-sticky)
3147 (if (> (length cmd-key) 2)
3148 (org-tags-view nil cmd-key)
3149 (org-agenda nil cmd-key))))
3150 (set-buffer org-agenda-buffer-name)
3151 (princ (buffer-string)))
3153 (defvar org-agenda-info nil)
3155 ;;;###autoload
3156 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3157 "Run an agenda command in batch mode and send the result to STDOUT.
3158 If CMD-KEY is a string of length 1, it is used as a key in
3159 `org-agenda-custom-commands' and triggers this command. If it is a
3160 longer string it is used as a tags/todo match string.
3161 Parameters are alternating variable names and values that will be bound
3162 before running the agenda command.
3164 The output gives a line for each selected agenda item. Each
3165 item is a list of comma-separated values, like this:
3167 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3169 category The category of the item
3170 head The headline, without TODO kwd, TAGS and PRIORITY
3171 type The type of the agenda entry, can be
3172 todo selected in TODO match
3173 tagsmatch selected in tags match
3174 diary imported from diary
3175 deadline a deadline on given date
3176 scheduled scheduled on given date
3177 timestamp entry has timestamp on given date
3178 closed entry was closed on given date
3179 upcoming-deadline warning about deadline
3180 past-scheduled forwarded scheduled item
3181 block entry has date block including g. date
3182 todo The todo keyword, if any
3183 tags All tags including inherited ones, separated by colons
3184 date The relevant date, like 2007-2-14
3185 time The time, like 15:00-16:50
3186 extra Sting with extra planning info
3187 priority-l The priority letter if any was given
3188 priority-n The computed numerical priority
3189 agenda-day The day in the agenda where this is listed"
3190 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3191 (org-make-parameter-alist parameters))
3192 (if (> (length cmd-key) 2)
3193 (org-tags-view nil cmd-key)
3194 (org-agenda nil cmd-key)))
3195 (set-buffer org-agenda-buffer-name)
3196 (let* ((lines (org-split-string (buffer-string) "\n"))
3197 line)
3198 (while (setq line (pop lines))
3199 (catch 'next
3200 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3201 (setq org-agenda-info
3202 (org-fix-agenda-info (text-properties-at 0 line)))
3203 (princ
3204 (mapconcat 'org-agenda-export-csv-mapper
3205 '(org-category txt type todo tags date time extra
3206 priority-letter priority agenda-day)
3207 ","))
3208 (princ "\n")))))
3210 (defun org-fix-agenda-info (props)
3211 "Make sure all properties on an agenda item have a canonical form.
3212 This ensures the export commands can easily use it."
3213 (let (tmp re)
3214 (when (setq tmp (plist-get props 'tags))
3215 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3216 (when (setq tmp (plist-get props 'date))
3217 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3218 (let ((calendar-date-display-form '(year "-" month "-" day)))
3219 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3221 (setq tmp (calendar-date-string tmp)))
3222 (setq props (plist-put props 'date tmp)))
3223 (when (setq tmp (plist-get props 'day))
3224 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3225 (let ((calendar-date-display-form '(year "-" month "-" day)))
3226 (setq tmp (calendar-date-string tmp)))
3227 (setq props (plist-put props 'day tmp))
3228 (setq props (plist-put props 'agenda-day tmp)))
3229 (when (setq tmp (plist-get props 'txt))
3230 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3231 (plist-put props 'priority-letter (match-string 1 tmp))
3232 (setq tmp (replace-match "" t t tmp)))
3233 (when (and (setq re (plist-get props 'org-todo-regexp))
3234 (setq re (concat "\\`\\.*" re " ?"))
3235 (string-match re tmp))
3236 (plist-put props 'todo (match-string 1 tmp))
3237 (setq tmp (replace-match "" t t tmp)))
3238 (plist-put props 'txt tmp)))
3239 props)
3241 (defun org-agenda-export-csv-mapper (prop)
3242 (let ((res (plist-get org-agenda-info prop)))
3243 (setq res
3244 (cond
3245 ((not res) "")
3246 ((stringp res) res)
3247 (t (prin1-to-string res))))
3248 (while (string-match "," res)
3249 (setq res (replace-match ";" t t res)))
3250 (org-trim res)))
3252 ;;;###autoload
3253 (defun org-store-agenda-views (&rest parameters)
3254 "Store agenda views."
3255 (interactive)
3256 (eval (list 'org-batch-store-agenda-views)))
3258 ;;;###autoload
3259 (defmacro org-batch-store-agenda-views (&rest parameters)
3260 "Run all custom agenda commands that have a file argument."
3261 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3262 (pop-up-frames nil)
3263 (dir default-directory)
3264 (pars (org-make-parameter-alist parameters))
3265 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3266 (save-window-excursion
3267 (while cmds
3268 (setq cmd (pop cmds)
3269 thiscmdkey (car cmd)
3270 thiscmdcmd (cdr cmd)
3271 match (nth 2 thiscmdcmd)
3272 bufname (if org-agenda-sticky
3273 (or (and (stringp match)
3274 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3275 (format "*Org Agenda(%s)*" thiscmdkey))
3276 org-agenda-buffer-name)
3277 cmd-or-set (nth 2 cmd)
3278 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3279 files (nth (if (listp cmd-or-set) 4 5) cmd))
3280 (if (stringp files) (setq files (list files)))
3281 (when files
3282 (org-eval-in-environment (append org-agenda-exporter-settings
3283 opts pars)
3284 (org-agenda nil thiscmdkey))
3285 (set-buffer bufname)
3286 (while files
3287 (org-eval-in-environment (append org-agenda-exporter-settings
3288 opts pars)
3289 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3290 (and (get-buffer bufname)
3291 (kill-buffer bufname)))))))
3293 (defvar org-agenda-current-span nil
3294 "The current span used in the agenda view.") ; local variable in the agenda buffer
3295 (defun org-agenda-mark-header-line (pos)
3296 "Mark the line at POS as an agenda structure header."
3297 (save-excursion
3298 (goto-char pos)
3299 (put-text-property (point-at-bol) (point-at-eol)
3300 'org-agenda-structural-header t)
3301 (when org-agenda-title-append
3302 (put-text-property (point-at-bol) (point-at-eol)
3303 'org-agenda-title-append org-agenda-title-append))))
3305 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3306 (defvar org-agenda-write-buffer-name "Agenda View")
3307 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3308 "Write the current buffer (an agenda view) as a file.
3309 Depending on the extension of the file name, plain text (.txt),
3310 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3311 If the extension is .ics, run icalendar export over all files used
3312 to construct the agenda and limit the export to entries listed in the
3313 agenda now.
3314 If the extension is .org, collect all subtrees corresponding to the
3315 agenda entries and add them in an .org file.
3316 With prefix argument OPEN, open the new file immediately.
3317 If NOSETTINGS is given, do not scope the settings of
3318 `org-agenda-exporter-settings' into the export commands. This is used when
3319 the settings have already been scoped and we do not wish to overrule other,
3320 higher priority settings.
3321 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3322 (interactive "FWrite agenda to file: \nP")
3323 (if (or (not (file-writable-p file))
3324 (and (file-exists-p file)
3325 (if (org-called-interactively-p 'any)
3326 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3327 (user-error "Cannot write agenda to file %s" file))
3328 (org-let (if nosettings nil org-agenda-exporter-settings)
3329 '(save-excursion
3330 (save-window-excursion
3331 (let ((bs (copy-sequence (buffer-string))) beg content)
3332 (with-temp-buffer
3333 (rename-buffer org-agenda-write-buffer-name t)
3334 (set-buffer-modified-p nil)
3335 (insert bs)
3336 (org-agenda-remove-marked-text 'org-filtered)
3337 (run-hooks 'org-agenda-before-write-hook)
3338 (cond
3339 ((org-bound-and-true-p org-mobile-creating-agendas)
3340 (org-mobile-write-agenda-for-mobile file))
3341 ((string-match "\\.org\\'" file)
3342 (let (content p m message-log-max)
3343 (goto-char (point-min))
3344 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3345 (goto-char p)
3346 (setq m (get-text-property (point) 'org-hd-marker))
3347 (when m
3348 (push (save-excursion
3349 (set-buffer (marker-buffer m))
3350 (goto-char m)
3351 (org-copy-subtree 1 nil t t)
3352 org-subtree-clip)
3353 content)))
3354 (find-file file)
3355 (erase-buffer)
3356 (dolist (s content) (org-paste-subtree 1 s))
3357 (write-file file)
3358 (kill-buffer (current-buffer))
3359 (message "Org file written to %s" file)))
3360 ((string-match "\\.html?\\'" file)
3361 (require 'htmlize)
3362 (set-buffer (htmlize-buffer (current-buffer)))
3363 (when org-agenda-export-html-style
3364 ;; replace <style> section with org-agenda-export-html-style
3365 (goto-char (point-min))
3366 (kill-region (- (search-forward "<style") 6)
3367 (search-forward "</style>"))
3368 (insert org-agenda-export-html-style))
3369 (write-file file)
3370 (kill-buffer (current-buffer))
3371 (message "HTML written to %s" file))
3372 ((string-match "\\.ps\\'" file)
3373 (require 'ps-print)
3374 (ps-print-buffer-with-faces file)
3375 (message "Postscript written to %s" file))
3376 ((string-match "\\.pdf\\'" file)
3377 (require 'ps-print)
3378 (ps-print-buffer-with-faces
3379 (concat (file-name-sans-extension file) ".ps"))
3380 (call-process "ps2pdf" nil nil nil
3381 (expand-file-name
3382 (concat (file-name-sans-extension file) ".ps"))
3383 (expand-file-name file))
3384 (delete-file (concat (file-name-sans-extension file) ".ps"))
3385 (message "PDF written to %s" file))
3386 ((string-match "\\.ics\\'" file)
3387 (require 'ox-icalendar)
3388 (org-icalendar-export-current-agenda (expand-file-name file)))
3390 (let ((bs (buffer-string)))
3391 (find-file file)
3392 (erase-buffer)
3393 (insert bs)
3394 (save-buffer 0)
3395 (kill-buffer (current-buffer))
3396 (message "Plain text written to %s" file))))))))
3397 (set-buffer (or agenda-bufname
3398 (and (org-called-interactively-p 'any) (buffer-name))
3399 org-agenda-buffer-name)))
3400 (when open (org-open-file file)))
3402 (defun org-agenda-remove-marked-text (property &optional value)
3403 "Delete all text marked with VALUE of PROPERTY.
3404 VALUE defaults to t."
3405 (let (beg)
3406 (setq value (or value t))
3407 (while (setq beg (text-property-any (point-min) (point-max)
3408 property value))
3409 (delete-region
3410 beg (or (next-single-property-change beg property)
3411 (point-max))))))
3413 (defun org-agenda-add-entry-text ()
3414 "Add entry text to agenda lines.
3415 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3416 entry text following headings shown in the agenda.
3417 Drawers will be excluded, also the line with scheduling/deadline info."
3418 (when (and (> org-agenda-add-entry-text-maxlines 0)
3419 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3420 (let (m txt)
3421 (goto-char (point-min))
3422 (while (not (eobp))
3423 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3424 (beginning-of-line 2)
3425 (setq txt (org-agenda-get-some-entry-text
3426 m org-agenda-add-entry-text-maxlines " > "))
3427 (end-of-line 1)
3428 (if (string-match "\\S-" txt)
3429 (insert "\n" txt)
3430 (or (eobp) (forward-char 1))))))))
3432 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3433 &rest keep)
3434 "Extract entry text from MARKER, at most N-LINES lines.
3435 This will ignore drawers etc, just get the text.
3436 If INDENT is given, prefix every line with this string. If KEEP is
3437 given, it is a list of symbols, defining stuff that should not be
3438 removed from the entry content. Currently only `planning' is allowed here."
3439 (let (txt drawer-re kwd-time-re ind)
3440 (save-excursion
3441 (with-current-buffer (marker-buffer marker)
3442 (if (not (derived-mode-p 'org-mode))
3443 (setq txt "")
3444 (save-excursion
3445 (save-restriction
3446 (widen)
3447 (goto-char marker)
3448 (end-of-line 1)
3449 (setq txt (buffer-substring
3450 (min (1+ (point)) (point-max))
3451 (progn (outline-next-heading) (point)))
3452 drawer-re org-drawer-regexp
3453 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3454 ".*\n?"))
3455 (with-temp-buffer
3456 (insert txt)
3457 (when org-agenda-add-entry-text-descriptive-links
3458 (goto-char (point-min))
3459 (while (org-activate-bracket-links (point-max))
3460 (add-text-properties (match-beginning 0) (match-end 0)
3461 '(face org-link))))
3462 (goto-char (point-min))
3463 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3464 (set-text-properties (match-beginning 0) (match-end 0)
3465 nil))
3466 (goto-char (point-min))
3467 (while (re-search-forward drawer-re nil t)
3468 (delete-region
3469 (match-beginning 0)
3470 (progn (re-search-forward
3471 "^[ \t]*:END:.*\n?" nil 'move)
3472 (point))))
3473 (unless (member 'planning keep)
3474 (goto-char (point-min))
3475 (while (re-search-forward kwd-time-re nil t)
3476 (replace-match "")))
3477 (goto-char (point-min))
3478 (when org-agenda-entry-text-exclude-regexps
3479 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3480 (while (setq re (pop re-list))
3481 (goto-char (point-min))
3482 (while (re-search-forward re nil t)
3483 (replace-match "")))))
3484 (goto-char (point-max))
3485 (skip-chars-backward " \t\n")
3486 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3488 ;; find and remove min common indentation
3489 (goto-char (point-min))
3490 (untabify (point-min) (point-max))
3491 (setq ind (org-get-indentation))
3492 (while (not (eobp))
3493 (unless (looking-at "[ \t]*$")
3494 (setq ind (min ind (org-get-indentation))))
3495 (beginning-of-line 2))
3496 (goto-char (point-min))
3497 (while (not (eobp))
3498 (unless (looking-at "[ \t]*$")
3499 (move-to-column ind)
3500 (delete-region (point-at-bol) (point)))
3501 (beginning-of-line 2))
3503 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3505 (goto-char (point-min))
3506 (when indent
3507 (while (and (not (eobp)) (re-search-forward "^" nil t))
3508 (replace-match indent t t)))
3509 (goto-char (point-min))
3510 (while (looking-at "[ \t]*\n") (replace-match ""))
3511 (goto-char (point-max))
3512 (when (> (org-current-line)
3513 n-lines)
3514 (org-goto-line (1+ n-lines))
3515 (backward-char 1))
3516 (setq txt (buffer-substring (point-min) (point)))))))))
3517 txt))
3519 (defun org-check-for-org-mode ()
3520 "Make sure current buffer is in org-mode. Error if not."
3521 (or (derived-mode-p 'org-mode)
3522 (error "Cannot execute org-mode agenda command on buffer in %s"
3523 major-mode)))
3525 ;;; Agenda prepare and finalize
3527 (defvar org-agenda-multi nil) ; dynamically scoped
3528 (defvar org-agenda-pre-window-conf nil)
3529 (defvar org-agenda-columns-active nil)
3530 (defvar org-agenda-name nil)
3531 (defvar org-agenda-tag-filter nil)
3532 (defvar org-agenda-category-filter nil)
3533 (defvar org-agenda-regexp-filter nil)
3534 (defvar org-agenda-top-headline-filter nil)
3535 (defvar org-agenda-tag-filter-preset nil
3536 "A preset of the tags filter used for secondary agenda filtering.
3537 This must be a list of strings, each string must be a single tag preceded
3538 by \"+\" or \"-\".
3539 This variable should not be set directly, but agenda custom commands can
3540 bind it in the options section. The preset filter is a global property of
3541 the entire agenda view. In a block agenda, it will not work reliably to
3542 define a filter for one of the individual blocks. You need to set it in
3543 the global options and expect it to be applied to the entire view.")
3545 (defvar org-agenda-category-filter-preset nil
3546 "A preset of the category filter used for secondary agenda filtering.
3547 This must be a list of strings, each string must be a single category
3548 preceded by \"+\" or \"-\".
3549 This variable should not be set directly, but agenda custom commands can
3550 bind it in the options section. The preset filter is a global property of
3551 the entire agenda view. In a block agenda, it will not work reliably to
3552 define a filter for one of the individual blocks. You need to set it in
3553 the global options and expect it to be applied to the entire view.")
3555 (defvar org-agenda-regexp-filter-preset nil
3556 "A preset of the regexp filter used for secondary agenda filtering.
3557 This must be a list of strings, each string must be a single regexp
3558 preceded by \"+\" or \"-\".
3559 This variable should not be set directly, but agenda custom commands can
3560 bind it in the options section. The preset filter is a global property of
3561 the entire agenda view. In a block agenda, it will not work reliably to
3562 define a filter for one of the individual blocks. You need to set it in
3563 the global options and expect it to be applied to the entire view.")
3565 (defun org-agenda-use-sticky-p ()
3566 "Return non-nil if an agenda buffer named
3567 `org-agenda-buffer-name' exists and should be shown instead of
3568 generating a new one."
3569 (and
3570 ;; turned off by user
3571 org-agenda-sticky
3572 ;; For multi-agenda buffer already exists
3573 (not org-agenda-multi)
3574 ;; buffer found
3575 (get-buffer org-agenda-buffer-name)
3576 ;; C-u parameter is same as last call
3577 (with-current-buffer (get-buffer org-agenda-buffer-name)
3578 (and
3579 (equal current-prefix-arg
3580 org-agenda-last-prefix-arg)
3581 ;; In case user turned stickiness on, while having existing
3582 ;; Agenda buffer active, don't reuse that buffer, because it
3583 ;; does not have org variables local
3584 org-agenda-this-buffer-is-sticky))))
3586 (defun org-agenda-prepare-window (abuf filter-alist)
3587 "Setup agenda buffer in the window.
3588 ABUF is the buffer for the agenda window.
3589 FILTER-ALIST is an alist of filters we need to apply when
3590 `org-agenda-persistent-filter' is non-nil."
3591 (let* ((awin (get-buffer-window abuf)) wconf)
3592 (cond
3593 ((equal (current-buffer) abuf) nil)
3594 (awin (select-window awin))
3595 ((not (setq wconf (current-window-configuration))))
3596 ((equal org-agenda-window-setup 'current-window)
3597 (org-pop-to-buffer-same-window abuf))
3598 ((equal org-agenda-window-setup 'other-window)
3599 (org-switch-to-buffer-other-window abuf))
3600 ((equal org-agenda-window-setup 'other-frame)
3601 (switch-to-buffer-other-frame abuf))
3602 ((equal org-agenda-window-setup 'reorganize-frame)
3603 (delete-other-windows)
3604 (org-switch-to-buffer-other-window abuf)))
3605 (setq org-agenda-tag-filter (cdr (assoc 'tag filter-alist)))
3606 (setq org-agenda-category-filter (cdr (assoc 'cat filter-alist)))
3607 (setq org-agenda-regexp-filter (cdr (assoc 're filter-alist)))
3608 ;; Additional test in case agenda is invoked from within agenda
3609 ;; buffer via elisp link.
3610 (unless (equal (current-buffer) abuf)
3611 (org-pop-to-buffer-same-window abuf))
3612 (setq org-agenda-pre-window-conf
3613 (or org-agenda-pre-window-conf wconf))))
3615 (defun org-agenda-prepare (&optional name)
3616 (let ((filter-alist (if org-agenda-persistent-filter
3617 (list `(tag . ,org-agenda-tag-filter)
3618 `(re . ,org-agenda-regexp-filter)
3619 `(car . ,org-agenda-category-filter)))))
3620 (if (org-agenda-use-sticky-p)
3621 (progn
3622 (put 'org-agenda-tag-filter :preset-filter nil)
3623 (put 'org-agenda-category-filter :preset-filter nil)
3624 (put 'org-agenda-regexp-filter :preset-filter nil)
3625 ;; Popup existing buffer
3626 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
3627 filter-alist)
3628 (message "Sticky Agenda buffer, use `r' to refresh")
3629 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3630 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3631 (setq org-todo-keywords-for-agenda nil)
3632 (setq org-drawers-for-agenda nil)
3633 (put 'org-agenda-tag-filter :preset-filter
3634 org-agenda-tag-filter-preset)
3635 (put 'org-agenda-category-filter :preset-filter
3636 org-agenda-category-filter-preset)
3637 (put 'org-agenda-regexp-filter :preset-filter
3638 org-agenda-regexp-filter-preset)
3639 (if org-agenda-multi
3640 (progn
3641 (setq buffer-read-only nil)
3642 (goto-char (point-max))
3643 (unless (or (bobp) org-agenda-compact-blocks
3644 (not org-agenda-block-separator))
3645 (insert "\n"
3646 (if (stringp org-agenda-block-separator)
3647 org-agenda-block-separator
3648 (make-string (window-width) org-agenda-block-separator))
3649 "\n"))
3650 (narrow-to-region (point) (point-max)))
3651 (setq org-done-keywords-for-agenda nil)
3653 ;; Setting any org variables that are in org-agenda-local-vars
3654 ;; list need to be done after the prepare call
3655 (org-agenda-prepare-window
3656 (get-buffer-create org-agenda-buffer-name) filter-alist)
3657 (setq buffer-read-only nil)
3658 (org-agenda-reset-markers)
3659 (let ((inhibit-read-only t)) (erase-buffer))
3660 (org-agenda-mode)
3661 (setq org-agenda-buffer (current-buffer))
3662 (setq org-agenda-contributing-files nil)
3663 (setq org-agenda-columns-active nil)
3664 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3665 (setq org-todo-keywords-for-agenda
3666 (org-uniquify org-todo-keywords-for-agenda))
3667 (setq org-done-keywords-for-agenda
3668 (org-uniquify org-done-keywords-for-agenda))
3669 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3670 (setq org-agenda-last-prefix-arg current-prefix-arg)
3671 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3672 (and name (not org-agenda-name)
3673 (org-set-local 'org-agenda-name name)))
3674 (setq buffer-read-only nil))))
3676 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3677 (defun org-agenda-finalize ()
3678 "Finishing touch for the agenda buffer, called just before displaying it."
3679 (unless org-agenda-multi
3680 (save-excursion
3681 (let ((inhibit-read-only t))
3682 (goto-char (point-min))
3683 (save-excursion
3684 (while (org-activate-bracket-links (point-max))
3685 (add-text-properties (match-beginning 0) (match-end 0)
3686 '(face org-link))))
3687 (save-excursion
3688 (while (org-activate-plain-links (point-max))
3689 (add-text-properties (match-beginning 0) (match-end 0)
3690 '(face org-link))))
3691 (unless (eq org-agenda-remove-tags t)
3692 (org-agenda-align-tags))
3693 (unless org-agenda-with-colors
3694 (remove-text-properties (point-min) (point-max) '(face nil)))
3695 (if (and (boundp 'org-agenda-overriding-columns-format)
3696 org-agenda-overriding-columns-format)
3697 (org-set-local 'org-agenda-overriding-columns-format
3698 org-agenda-overriding-columns-format))
3699 (if (and (boundp 'org-agenda-view-columns-initially)
3700 org-agenda-view-columns-initially)
3701 (org-agenda-columns))
3702 (when org-agenda-fontify-priorities
3703 (org-agenda-fontify-priorities))
3704 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3705 (org-agenda-dim-blocked-tasks))
3706 (org-agenda-mark-clocking-task)
3707 (when org-agenda-entry-text-mode
3708 (org-agenda-entry-text-hide)
3709 (org-agenda-entry-text-show))
3710 (if (and (functionp 'org-habit-insert-consistency-graphs)
3711 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3712 (org-habit-insert-consistency-graphs))
3713 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3714 (unless (or (eq org-agenda-show-inherited-tags 'always)
3715 (and (listp org-agenda-show-inherited-tags)
3716 (memq org-agenda-type org-agenda-show-inherited-tags))
3717 (and (eq org-agenda-show-inherited-tags t)
3718 (or (eq org-agenda-use-tag-inheritance t)
3719 (and (listp org-agenda-use-tag-inheritance)
3720 (not (memq org-agenda-type
3721 org-agenda-use-tag-inheritance))))))
3722 (let (mrk)
3723 (save-excursion
3724 (goto-char (point-min))
3725 (while (equal (forward-line) 0)
3726 (when (setq mrk (get-text-property (point) 'org-hd-marker))
3727 (put-text-property (point-at-bol) (point-at-eol)
3728 'tags (org-with-point-at mrk
3729 (delete-dups
3730 (mapcar 'downcase (org-get-tags-at))))))))))
3731 (run-hooks 'org-agenda-finalize-hook)
3732 (when org-agenda-top-headline-filter
3733 (org-agenda-filter-top-headline-apply
3734 org-agenda-top-headline-filter))
3735 (when org-agenda-tag-filter
3736 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3737 (when (get 'org-agenda-tag-filter :preset-filter)
3738 (org-agenda-filter-apply
3739 (get 'org-agenda-tag-filter :preset-filter) 'tag))
3740 (when org-agenda-category-filter
3741 (org-agenda-filter-apply org-agenda-category-filter 'category))
3742 (when (get 'org-agenda-category-filter :preset-filter)
3743 (org-agenda-filter-apply
3744 (get 'org-agenda-category-filter :preset-filter) 'category))
3745 (when org-agenda-regexp-filter
3746 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3747 (when (get 'org-agenda-regexp-filter :preset-filter)
3748 (org-agenda-filter-apply
3749 (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
3750 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3752 (defun org-agenda-mark-clocking-task ()
3753 "Mark the current clock entry in the agenda if it is present."
3754 ;; We need to widen when `org-agenda-finalize' is called from
3755 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3756 (when org-clock-current-task
3757 (save-restriction
3758 (widen)
3759 (org-agenda-unmark-clocking-task)
3760 (when (marker-buffer org-clock-hd-marker)
3761 (save-excursion
3762 (goto-char (point-min))
3763 (let (s ov)
3764 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3765 (goto-char s)
3766 (when (equal (org-get-at-bol 'org-hd-marker)
3767 org-clock-hd-marker)
3768 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3769 (overlay-put ov 'type 'org-agenda-clocking)
3770 (overlay-put ov 'face 'org-agenda-clocking)
3771 (overlay-put ov 'help-echo
3772 "The clock is running in this item")))))))))
3774 (defun org-agenda-unmark-clocking-task ()
3775 "Unmark the current clocking task."
3776 (mapc (lambda (o)
3777 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3778 (delete-overlay o)))
3779 (overlays-in (point-min) (point-max))))
3781 (defun org-agenda-fontify-priorities ()
3782 "Make highest priority lines bold, and lowest italic."
3783 (interactive)
3784 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3785 (delete-overlay o)))
3786 (overlays-in (point-min) (point-max)))
3787 (save-excursion
3788 (let (b e p ov h l)
3789 (goto-char (point-min))
3790 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3791 (setq h (or (get-char-property (point) 'org-highest-priority)
3792 org-highest-priority)
3793 l (or (get-char-property (point) 'org-lowest-priority)
3794 org-lowest-priority)
3795 p (string-to-char (match-string 1))
3796 b (match-beginning 0)
3797 e (if (eq org-agenda-fontify-priorities 'cookies)
3798 (match-end 0)
3799 (point-at-eol))
3800 ov (make-overlay b e))
3801 (overlay-put
3802 ov 'face
3803 (cons (cond ((org-face-from-face-or-color
3804 'priority nil
3805 (cdr (assoc p org-priority-faces))))
3806 ((and (listp org-agenda-fontify-priorities)
3807 (org-face-from-face-or-color
3808 'priority nil
3809 (cdr (assoc p org-agenda-fontify-priorities)))))
3810 ((equal p l) 'italic)
3811 ((equal p h) 'bold))
3812 'org-priority))
3813 (overlay-put ov 'org-type 'org-priority)))))
3815 (defvar org-depend-tag-blocked)
3817 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3818 "Dim currently blocked TODOs in the agenda display.
3819 When INVISIBLE is non-nil, hide currently blocked TODO instead of
3820 dimming them."
3821 (interactive "P")
3822 (when (org-called-interactively-p 'interactive)
3823 (message "Dim or hide blocked tasks..."))
3824 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3825 (delete-overlay o)))
3826 (overlays-in (point-min) (point-max)))
3827 (save-excursion
3828 (let ((inhibit-read-only t)
3829 (org-depend-tag-blocked nil)
3830 (invis (or (not (null invisible))
3831 (eq org-agenda-dim-blocked-tasks 'invisible)))
3832 org-blocked-by-checkboxes
3833 invis1 b e p ov h l)
3834 (goto-char (point-min))
3835 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3836 (and pos (goto-char (1+ pos))))
3837 (setq org-blocked-by-checkboxes nil invis1 invis)
3838 (let ((marker (org-get-at-bol 'org-hd-marker)))
3839 (when (and marker
3840 (with-current-buffer (marker-buffer marker)
3841 (save-excursion (goto-char marker)
3842 (org-entry-blocked-p))))
3843 (if org-blocked-by-checkboxes (setq invis1 nil))
3844 (setq b (if invis1
3845 (max (point-min) (1- (point-at-bol)))
3846 (point-at-bol))
3847 e (point-at-eol)
3848 ov (make-overlay b e))
3849 (if invis1
3850 (progn (overlay-put ov 'invisible t)
3851 (overlay-put ov 'intangible t))
3852 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3853 (overlay-put ov 'org-type 'org-blocked-todo))))))
3854 (when (org-called-interactively-p 'interactive)
3855 (message "Dim or hide blocked tasks...done")))
3857 (defvar org-agenda-skip-function nil
3858 "Function to be called at each match during agenda construction.
3859 If this function returns nil, the current match should not be skipped.
3860 Otherwise, the function must return a position from where the search
3861 should be continued.
3862 This may also be a Lisp form, it will be evaluated.
3863 Never set this variable using `setq' or so, because then it will apply
3864 to all future agenda commands. If you do want a global skipping condition,
3865 use the option `org-agenda-skip-function-global' instead.
3866 The correct usage for `org-agenda-skip-function' is to bind it with
3867 `let' to scope it dynamically into the agenda-constructing command.
3868 A good way to set it is through options in `org-agenda-custom-commands'.")
3870 (defun org-agenda-skip ()
3871 "Throw to `:skip' in places that should be skipped.
3872 Also moves point to the end of the skipped region, so that search can
3873 continue from there."
3874 (let ((p (point-at-bol)) to)
3875 (when (or
3876 (save-excursion (goto-char p) (looking-at comment-start-skip))
3877 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3878 (get-text-property p :org-archived)
3879 (org-end-of-subtree t))
3880 (and org-agenda-skip-comment-trees
3881 (get-text-property p :org-comment)
3882 (org-end-of-subtree t))
3883 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3884 (org-agenda-skip-eval org-agenda-skip-function)))
3885 (goto-char to))
3886 (org-in-src-block-p t))
3887 (throw :skip t))))
3889 (defun org-agenda-skip-eval (form)
3890 "If FORM is a function or a list, call (or eval) it and return the result.
3891 `save-excursion' and `save-match-data' are wrapped around the call, so point
3892 and match data are returned to the previous state no matter what these
3893 functions do."
3894 (let (fp)
3895 (and form
3896 (or (setq fp (functionp form))
3897 (consp form))
3898 (save-excursion
3899 (save-match-data
3900 (if fp
3901 (funcall form)
3902 (eval form)))))))
3904 (defvar org-agenda-markers nil
3905 "List of all currently active markers created by `org-agenda'.")
3906 (defvar org-agenda-last-marker-time (float-time)
3907 "Creation time of the last agenda marker.")
3909 (defun org-agenda-new-marker (&optional pos)
3910 "Return a new agenda marker.
3911 Org-mode keeps a list of these markers and resets them when they are
3912 no longer in use."
3913 (let ((m (copy-marker (or pos (point)))))
3914 (setq org-agenda-last-marker-time (float-time))
3915 (if org-agenda-buffer
3916 (with-current-buffer org-agenda-buffer
3917 (push m org-agenda-markers))
3918 (push m org-agenda-markers))
3921 (defun org-agenda-reset-markers ()
3922 "Reset markers created by `org-agenda'."
3923 (while org-agenda-markers
3924 (move-marker (pop org-agenda-markers) nil)))
3926 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3927 "Save relative positions of markers in region.
3928 This check for agenda markers in all agenda buffers currently active."
3929 (dolist (buf (buffer-list))
3930 (with-current-buffer buf
3931 (when (eq major-mode 'org-agenda-mode)
3932 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3933 org-agenda-markers)))))
3935 ;;; Entry text mode
3937 (defun org-agenda-entry-text-show-here ()
3938 "Add some text from the entry as context to the current line."
3939 (let (m txt o)
3940 (setq m (org-get-at-bol 'org-hd-marker))
3941 (unless (marker-buffer m)
3942 (error "No marker points to an entry here"))
3943 (setq txt (concat "\n" (org-no-properties
3944 (org-agenda-get-some-entry-text
3945 m org-agenda-entry-text-maxlines
3946 org-agenda-entry-text-leaders))))
3947 (when (string-match "\\S-" txt)
3948 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3949 (overlay-put o 'evaporate t)
3950 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3951 (overlay-put o 'after-string txt))))
3953 (defun org-agenda-entry-text-show ()
3954 "Add entry context for all agenda lines."
3955 (interactive)
3956 (save-excursion
3957 (goto-char (point-max))
3958 (beginning-of-line 1)
3959 (while (not (bobp))
3960 (when (org-get-at-bol 'org-hd-marker)
3961 (org-agenda-entry-text-show-here))
3962 (beginning-of-line 0))))
3964 (defun org-agenda-entry-text-hide ()
3965 "Remove any shown entry context."
3966 (delq nil
3967 (mapcar (lambda (o)
3968 (if (eq (overlay-get o 'org-overlay-type)
3969 'agenda-entry-content)
3970 (progn (delete-overlay o) t)))
3971 (overlays-in (point-min) (point-max)))))
3973 (defun org-agenda-get-day-face (date)
3974 "Return the face DATE should be displayed with."
3975 (or (and (functionp org-agenda-day-face-function)
3976 (funcall org-agenda-day-face-function date))
3977 (cond ((org-agenda-todayp date)
3978 'org-agenda-date-today)
3979 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3980 'org-agenda-date-weekend)
3981 (t 'org-agenda-date))))
3983 ;;; Agenda timeline
3985 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3986 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
3988 (defun org-timeline (&optional dotodo)
3989 "Show a time-sorted view of the entries in the current org file.
3990 Only entries with a time stamp of today or later will be listed. With
3991 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3992 under the current date.
3993 If the buffer contains an active region, only check the region for
3994 dates."
3995 (interactive "P")
3996 (let* ((dopast t)
3997 (org-agenda-show-log-scoped org-agenda-show-log)
3998 (org-agenda-show-log org-agenda-show-log-scoped)
3999 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
4000 (current-buffer))))
4001 (date (calendar-current-date))
4002 (beg (if (org-region-active-p) (region-beginning) (point-min)))
4003 (end (if (org-region-active-p) (region-end) (point-max)))
4004 (day-numbers (org-get-all-dates
4005 beg end 'no-ranges
4006 t org-agenda-show-log-scoped ; always include today
4007 org-timeline-show-empty-dates))
4008 (org-deadline-warning-days 0)
4009 (org-agenda-only-exact-dates t)
4010 (today (org-today))
4011 (past t)
4012 args
4013 s e rtn d emptyp)
4014 (setq org-agenda-redo-command
4015 (list 'let
4016 (list (list 'org-agenda-show-log 'org-agenda-show-log))
4017 (list 'org-switch-to-buffer-other-window (current-buffer))
4018 (list 'org-timeline (list 'quote dotodo))))
4019 (put 'org-agenda-redo-command 'org-lprops nil)
4020 (if (not dopast)
4021 ;; Remove past dates from the list of dates.
4022 (setq day-numbers (delq nil (mapcar (lambda(x)
4023 (if (>= x today) x nil))
4024 day-numbers))))
4025 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
4026 (org-compile-prefix-format 'timeline)
4027 (org-set-sorting-strategy 'timeline)
4028 (if org-agenda-show-log-scoped (push :closed args))
4029 (push :timestamp args)
4030 (push :deadline args)
4031 (push :scheduled args)
4032 (push :sexp args)
4033 (if dotodo (push :todo args))
4034 (insert "Timeline of file " entry "\n")
4035 (add-text-properties (point-min) (point)
4036 (list 'face 'org-agenda-structure))
4037 (org-agenda-mark-header-line (point-min))
4038 (while (setq d (pop day-numbers))
4039 (if (and (listp d) (eq (car d) :omitted))
4040 (progn
4041 (setq s (point))
4042 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4043 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4044 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4045 (if (and (>= d today)
4046 dopast
4047 past)
4048 (progn
4049 (setq past nil)
4050 (insert (make-string 79 ?-) "\n")))
4051 (setq date (calendar-gregorian-from-absolute d))
4052 (setq s (point))
4053 (setq rtn (and (not emptyp)
4054 (apply 'org-agenda-get-day-entries entry
4055 date args)))
4056 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4057 (progn
4058 (insert
4059 (if (stringp org-agenda-format-date)
4060 (format-time-string org-agenda-format-date
4061 (org-time-from-absolute date))
4062 (funcall org-agenda-format-date date))
4063 "\n")
4064 (put-text-property s (1- (point)) 'face
4065 (org-agenda-get-day-face date))
4066 (put-text-property s (1- (point)) 'org-date-line t)
4067 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4068 (if (equal d today)
4069 (put-text-property s (1- (point)) 'org-today t))
4070 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4071 (put-text-property s (1- (point)) 'day d)))))
4072 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4073 (point-min)))
4074 (add-text-properties
4075 (point-min) (point-max)
4076 `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
4077 (org-agenda-finalize)
4078 (setq buffer-read-only t)))
4080 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4081 "Return a list of all relevant day numbers from BEG to END buffer positions.
4082 If NO-RANGES is non-nil, include only the start and end dates of a range,
4083 not every single day in the range. If FORCE-TODAY is non-nil, make
4084 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4085 inactive time stamps (those in square brackets) are included.
4086 When EMPTY is non-nil, also include days without any entries."
4087 (let ((re (concat
4088 (if pre-re pre-re "")
4089 (if inactive org-ts-regexp-both org-ts-regexp)))
4090 dates dates1 date day day1 day2 ts1 ts2 pos)
4091 (if force-today
4092 (setq dates (list (org-today))))
4093 (save-excursion
4094 (goto-char beg)
4095 (while (re-search-forward re end t)
4096 (setq day (time-to-days (org-time-string-to-time
4097 (substring (match-string 1) 0 10)
4098 (current-buffer) (match-beginning 0))))
4099 (or (memq day dates) (push day dates)))
4100 (unless no-ranges
4101 (goto-char beg)
4102 (while (re-search-forward org-tr-regexp end t)
4103 (setq pos (match-beginning 0))
4104 (setq ts1 (substring (match-string 1) 0 10)
4105 ts2 (substring (match-string 2) 0 10)
4106 day1 (time-to-days (org-time-string-to-time
4107 ts1 (current-buffer) pos))
4108 day2 (time-to-days (org-time-string-to-time
4109 ts2 (current-buffer) pos)))
4110 (while (< (setq day1 (1+ day1)) day2)
4111 (or (memq day1 dates) (push day1 dates)))))
4112 (setq dates (sort dates '<))
4113 (when empty
4114 (while (setq day (pop dates))
4115 (setq day2 (car dates))
4116 (push day dates1)
4117 (when (and day2 empty)
4118 (if (or (eq empty t)
4119 (and (numberp empty) (<= (- day2 day) empty)))
4120 (while (< (setq day (1+ day)) day2)
4121 (push (list day) dates1))
4122 (push (cons :omitted (- day2 day)) dates1))))
4123 (setq dates (nreverse dates1)))
4124 dates)))
4126 ;;; Agenda Daily/Weekly
4128 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4129 "Start day for the agenda view.
4130 Custom commands can set this variable in the options section.
4131 This is usually a string like \"2007-11-01\", \"+2d\" or any other
4132 input allowed when reading a date through the Org calendar.
4133 See the docstring of `org-read-date' for details.")
4134 (defvar org-starting-day nil) ; local variable in the agenda buffer
4135 (defvar org-arg-loc nil) ; local variable
4137 (defvar org-agenda-buffer-tmp-name nil)
4138 ;;;###autoload
4139 (defun org-agenda-list (&optional arg start-day span with-hour)
4140 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4141 The view will be for the current day or week, but from the overview buffer
4142 you will be able to go to other days/weeks.
4144 With a numeric prefix argument in an interactive call, the agenda will
4145 span ARG days. Lisp programs should instead specify SPAN to change
4146 the number of days. SPAN defaults to `org-agenda-span'.
4148 START-DAY defaults to TODAY, or to the most recent match for the weekday
4149 given in `org-agenda-start-on-weekday'.
4151 When WITH-HOUR is non-nil, only include scheduled and deadline
4152 items if they have an hour specification like [h]h:mm."
4153 (interactive "P")
4154 (if org-agenda-overriding-arguments
4155 (setq arg (car org-agenda-overriding-arguments)
4156 start-day (nth 1 org-agenda-overriding-arguments)
4157 span (nth 2 org-agenda-overriding-arguments)))
4158 (if (and (integerp arg) (> arg 0))
4159 (setq span arg arg nil))
4160 (catch 'exit
4161 (setq org-agenda-buffer-name
4162 (or org-agenda-buffer-tmp-name
4163 (if org-agenda-sticky
4164 (cond ((and org-keys (stringp org-match))
4165 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4166 (org-keys
4167 (format "*Org Agenda(%s)*" org-keys))
4168 (t "*Org Agenda(a)*")))
4169 org-agenda-buffer-name))
4170 (org-agenda-prepare "Day/Week")
4171 (setq start-day (or start-day org-agenda-start-day))
4172 (if (stringp start-day)
4173 ;; Convert to an absolute day number
4174 (setq start-day (time-to-days (org-read-date nil t start-day))))
4175 (org-compile-prefix-format 'agenda)
4176 (org-set-sorting-strategy 'agenda)
4177 (let* ((span (org-agenda-ndays-to-span
4178 (or span org-agenda-ndays org-agenda-span)))
4179 (today (org-today))
4180 (sd (or start-day today))
4181 (ndays (org-agenda-span-to-ndays span sd))
4182 (org-agenda-start-on-weekday
4183 (if (or (eq ndays 7) (eq ndays 14))
4184 org-agenda-start-on-weekday))
4185 (thefiles (org-agenda-files nil 'ifmode))
4186 (files thefiles)
4187 (start (if (or (null org-agenda-start-on-weekday)
4188 (< ndays 7))
4190 (let* ((nt (calendar-day-of-week
4191 (calendar-gregorian-from-absolute sd)))
4192 (n1 org-agenda-start-on-weekday)
4193 (d (- nt n1)))
4194 (- sd (+ (if (< d 0) 7 0) d)))))
4195 (day-numbers (list start))
4196 (day-cnt 0)
4197 (inhibit-redisplay (not debug-on-error))
4198 (org-agenda-show-log-scoped org-agenda-show-log)
4199 s e rtn rtnall file date d start-pos end-pos todayp
4200 clocktable-start clocktable-end filter)
4201 (setq org-agenda-redo-command
4202 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4203 (dotimes (n (1- ndays))
4204 (push (1+ (car day-numbers)) day-numbers))
4205 (setq day-numbers (nreverse day-numbers))
4206 (setq clocktable-start (car day-numbers)
4207 clocktable-end (1+ (or (org-last day-numbers) 0)))
4208 (org-set-local 'org-starting-day (car day-numbers))
4209 (org-set-local 'org-arg-loc arg)
4210 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
4211 (unless org-agenda-compact-blocks
4212 (let* ((d1 (car day-numbers))
4213 (d2 (org-last day-numbers))
4214 (w1 (org-days-to-iso-week d1))
4215 (w2 (org-days-to-iso-week d2)))
4216 (setq s (point))
4217 (if org-agenda-overriding-header
4218 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4219 nil 'face 'org-agenda-structure) "\n")
4220 (insert (org-agenda-span-name span)
4221 "-agenda"
4222 (if (< (- d2 d1) 350)
4223 (if (= w1 w2)
4224 (format " (W%02d)" w1)
4225 (format " (W%02d-W%02d)" w1 w2))
4227 ":\n")))
4228 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4229 'org-date-line t))
4230 (org-agenda-mark-header-line s))
4231 (while (setq d (pop day-numbers))
4232 (setq date (calendar-gregorian-from-absolute d)
4233 s (point))
4234 (if (or (setq todayp (= d today))
4235 (and (not start-pos) (= d sd)))
4236 (setq start-pos (point))
4237 (if (and start-pos (not end-pos))
4238 (setq end-pos (point))))
4239 (setq files thefiles
4240 rtnall nil)
4241 (while (setq file (pop files))
4242 (catch 'nextfile
4243 (org-check-agenda-file file)
4244 (let ((org-agenda-entry-types org-agenda-entry-types))
4245 ;; Starred types override non-starred equivalents
4246 (when (member :deadline* org-agenda-entry-types)
4247 (setq org-agenda-entry-types
4248 (delq :deadline org-agenda-entry-types)))
4249 (when (member :scheduled* org-agenda-entry-types)
4250 (setq org-agenda-entry-types
4251 (delq :scheduled org-agenda-entry-types)))
4252 ;; Honor with-hour
4253 (when with-hour
4254 (when (member :deadline org-agenda-entry-types)
4255 (setq org-agenda-entry-types
4256 (delq :deadline org-agenda-entry-types))
4257 (push :deadline* org-agenda-entry-types))
4258 (when (member :scheduled org-agenda-entry-types)
4259 (setq org-agenda-entry-types
4260 (delq :scheduled org-agenda-entry-types))
4261 (push :scheduled* org-agenda-entry-types)))
4262 (unless org-agenda-include-deadlines
4263 (setq org-agenda-entry-types
4264 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4265 (cond
4266 ((memq org-agenda-show-log-scoped '(only clockcheck))
4267 (setq rtn (org-agenda-get-day-entries
4268 file date :closed)))
4269 (org-agenda-show-log-scoped
4270 (setq rtn (apply 'org-agenda-get-day-entries
4271 file date
4272 (append '(:closed) org-agenda-entry-types))))
4274 (setq rtn (apply 'org-agenda-get-day-entries
4275 file date
4276 org-agenda-entry-types)))))
4277 (setq rtnall (append rtnall rtn)))) ;; all entries
4278 (if org-agenda-include-diary
4279 (let ((org-agenda-search-headline-for-time t))
4280 (require 'diary-lib)
4281 (setq rtn (org-get-entries-from-diary date))
4282 (setq rtnall (append rtnall rtn))))
4283 (if (or rtnall org-agenda-show-all-dates)
4284 (progn
4285 (setq day-cnt (1+ day-cnt))
4286 (insert
4287 (if (stringp org-agenda-format-date)
4288 (format-time-string org-agenda-format-date
4289 (org-time-from-absolute date))
4290 (funcall org-agenda-format-date date))
4291 "\n")
4292 (put-text-property s (1- (point)) 'face
4293 (org-agenda-get-day-face date))
4294 (put-text-property s (1- (point)) 'org-date-line t)
4295 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4296 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4297 (when todayp
4298 (put-text-property s (1- (point)) 'org-today t))
4299 (setq rtnall
4300 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4301 (if rtnall (insert ;; all entries
4302 (org-agenda-finalize-entries rtnall 'agenda)
4303 "\n"))
4304 (put-text-property s (1- (point)) 'day d)
4305 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4306 (when (and org-agenda-clockreport-mode clocktable-start)
4307 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4308 ;; the above line is to ensure the restricted range!
4309 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4310 tbl)
4311 (setq p (org-plist-delete p :block))
4312 (setq p (plist-put p :tstart clocktable-start))
4313 (setq p (plist-put p :tend clocktable-end))
4314 (setq p (plist-put p :scope 'agenda))
4315 (setq tbl (apply 'org-clock-get-clocktable p))
4316 (insert tbl)))
4317 (goto-char (point-min))
4318 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4319 (unless (and (pos-visible-in-window-p (point-min))
4320 (pos-visible-in-window-p (point-max)))
4321 (goto-char (1- (point-max)))
4322 (recenter -1)
4323 (if (not (pos-visible-in-window-p (or start-pos 1)))
4324 (progn
4325 (goto-char (or start-pos 1))
4326 (recenter 1))))
4327 (goto-char (or start-pos 1))
4328 (add-text-properties (point-min) (point-max)
4329 `(org-agenda-type agenda
4330 org-last-args (,arg ,start-day ,span)
4331 org-redo-cmd ,org-agenda-redo-command
4332 org-series-cmd ,org-cmd))
4333 (if (eq org-agenda-show-log-scoped 'clockcheck)
4334 (org-agenda-show-clocking-issues))
4335 (org-agenda-finalize)
4336 (setq buffer-read-only t)
4337 (message ""))))
4339 (defun org-agenda-ndays-to-span (n)
4340 "Return a span symbol for a span of N days, or N if none matches."
4341 (cond ((symbolp n) n)
4342 ((= n 1) 'day)
4343 ((= n 7) 'week)
4344 ((= n 14) 'fortnight)
4345 (t n)))
4347 (defun org-agenda-span-to-ndays (span &optional start-day)
4348 "Return ndays from SPAN, possibly starting at START-DAY.
4349 START-DAY is an absolute time value."
4350 (cond ((numberp span) span)
4351 ((eq span 'day) 1)
4352 ((eq span 'week) 7)
4353 ((eq span 'fortnight) 14)
4354 ((eq span 'month)
4355 (let ((date (calendar-gregorian-from-absolute start-day)))
4356 (calendar-last-day-of-month (car date) (caddr date))))
4357 ((eq span 'year)
4358 (let ((date (calendar-gregorian-from-absolute start-day)))
4359 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4361 (defun org-agenda-span-name (span)
4362 "Return a SPAN name."
4363 (if (null span)
4365 (if (symbolp span)
4366 (capitalize (symbol-name span))
4367 (format "%d days" span))))
4369 ;;; Agenda word search
4371 (defvar org-agenda-search-history nil)
4373 (defvar org-search-syntax-table nil
4374 "Special syntax table for org-mode search.
4375 In this table, we have single quotes not as word constituents, to
4376 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4378 (defvar org-mode-syntax-table) ; From org.el
4379 (defun org-search-syntax-table ()
4380 (unless org-search-syntax-table
4381 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4382 (modify-syntax-entry ?' "." org-search-syntax-table)
4383 (modify-syntax-entry ?` "." org-search-syntax-table))
4384 org-search-syntax-table)
4386 (defvar org-agenda-last-search-view-search-was-boolean nil)
4388 ;;;###autoload
4389 (defun org-search-view (&optional todo-only string edit-at)
4390 "Show all entries that contain a phrase or words or regular expressions.
4392 With optional prefix argument TODO-ONLY, only consider entries that are
4393 TODO entries. The argument STRING can be used to pass a default search
4394 string into this function. If EDIT-AT is non-nil, it means that the
4395 user should get a chance to edit this string, with cursor at position
4396 EDIT-AT.
4398 The search string can be viewed either as a phrase that should be found as
4399 is, or it can be broken into a number of snippets, each of which must match
4400 in a Boolean way to select an entry. The default depends on the variable
4401 `org-agenda-search-view-always-boolean'.
4402 Even if this is turned off (the default) you can always switch to
4403 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4405 The default is a direct search of the whole phrase, where each space in
4406 the search string can expand to an arbitrary amount of whitespace,
4407 including newlines.
4409 If using a Boolean search, the search string is split on whitespace and
4410 each snippet is searched separately, with logical AND to select an entry.
4411 Words prefixed with a minus must *not* occur in the entry. Words without
4412 a prefix or prefixed with a plus must occur in the entry. Matching is
4413 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4414 match whole words, not parts of a word) if
4415 `org-agenda-search-view-force-full-words' is set (default is nil).
4417 Boolean search snippets enclosed by curly braces are interpreted as
4418 regular expressions that must or (when preceded with \"-\") must not
4419 match in the entry. Snippets enclosed into double quotes will be taken
4420 as a whole, to include whitespace.
4422 - If the search string starts with an asterisk, search only in headlines.
4423 - If (possibly after the leading star) the search string starts with an
4424 exclamation mark, this also means to look at TODO entries only, an effect
4425 that can also be achieved with a prefix argument.
4426 - If (possibly after star and exclamation mark) the search string starts
4427 with a colon, this will mean that the (non-regexp) snippets of the
4428 Boolean search must match as full words.
4430 This command searches the agenda files, and in addition the files listed
4431 in `org-agenda-text-search-extra-files'."
4432 (interactive "P")
4433 (if org-agenda-overriding-arguments
4434 (setq todo-only (car org-agenda-overriding-arguments)
4435 string (nth 1 org-agenda-overriding-arguments)
4436 edit-at (nth 2 org-agenda-overriding-arguments)))
4437 (let* ((props (list 'face nil
4438 'done-face 'org-agenda-done
4439 'org-not-done-regexp org-not-done-regexp
4440 'org-todo-regexp org-todo-regexp
4441 'org-complex-heading-regexp org-complex-heading-regexp
4442 'mouse-face 'highlight
4443 'help-echo (format "mouse-2 or RET jump to location")))
4444 (full-words org-agenda-search-view-force-full-words)
4445 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4446 regexp rtn rtnall files file pos inherited-tags
4447 marker category category-pos level tags c neg re boolean
4448 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4449 (unless (and (not edit-at)
4450 (stringp string)
4451 (string-match "\\S-" string))
4452 (setq string (read-string
4453 (if org-agenda-search-view-always-boolean
4454 "[+-]Word/{Regexp} ...: "
4455 "Phrase or [+-]Word/{Regexp} ...: ")
4456 (cond
4457 ((integerp edit-at) (cons string edit-at))
4458 (edit-at string))
4459 'org-agenda-search-history)))
4460 (catch 'exit
4461 (if org-agenda-sticky
4462 (setq org-agenda-buffer-name
4463 (if (stringp string)
4464 (format "*Org Agenda(%s:%s)*"
4465 (or org-keys (or (and todo-only "S") "s")) string)
4466 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4467 (org-agenda-prepare "SEARCH")
4468 (org-compile-prefix-format 'search)
4469 (org-set-sorting-strategy 'search)
4470 (setq org-agenda-redo-command
4471 (list 'org-search-view (if todo-only t nil)
4472 (list 'if 'current-prefix-arg nil string)))
4473 (setq org-agenda-query-string string)
4474 (if (equal (string-to-char string) ?*)
4475 (setq hdl-only t
4476 words (substring string 1))
4477 (setq words string))
4478 (when (equal (string-to-char words) ?!)
4479 (setq todo-only t
4480 words (substring words 1)))
4481 (when (equal (string-to-char words) ?:)
4482 (setq full-words t
4483 words (substring words 1)))
4484 (if (or org-agenda-search-view-always-boolean
4485 (member (string-to-char words) '(?- ?+ ?\{)))
4486 (setq boolean t))
4487 (setq words (org-split-string words))
4488 (let (www w)
4489 (while (setq w (pop words))
4490 (while (and (string-match "\\\\\\'" w) words)
4491 (setq w (concat (substring w 0 -1) " " (pop words))))
4492 (push w www))
4493 (setq words (nreverse www) www nil)
4494 (while (setq w (pop words))
4495 (when (and (string-match "\\`[-+]?{" w)
4496 (not (string-match "}\\'" w)))
4497 (while (and words (not (string-match "}\\'" (car words))))
4498 (setq w (concat w " " (pop words))))
4499 (setq w (concat w " " (pop words))))
4500 (push w www))
4501 (setq words (nreverse www)))
4502 (setq org-agenda-last-search-view-search-was-boolean boolean)
4503 (when boolean
4504 (let (wds w)
4505 (while (setq w (pop words))
4506 (if (or (equal (substring w 0 1) "\"")
4507 (and (> (length w) 1)
4508 (member (substring w 0 1) '("+" "-"))
4509 (equal (substring w 1 2) "\"")))
4510 (while (and words (not (equal (substring w -1) "\"")))
4511 (setq w (concat w " " (pop words)))))
4512 (and (string-match "\\`\\([-+]?\\)\"" w)
4513 (setq w (replace-match "\\1" nil nil w)))
4514 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4515 (push w wds))
4516 (setq words (nreverse wds))))
4517 (if boolean
4518 (mapc (lambda (w)
4519 (setq c (string-to-char w))
4520 (if (equal c ?-)
4521 (setq neg t w (substring w 1))
4522 (if (equal c ?+)
4523 (setq neg nil w (substring w 1))
4524 (setq neg nil)))
4525 (if (string-match "\\`{.*}\\'" w)
4526 (setq re (substring w 1 -1))
4527 (if full-words
4528 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4529 (setq re (regexp-quote (downcase w)))))
4530 (if neg (push re regexps-) (push re regexps+)))
4531 words)
4532 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4533 regexps+))
4534 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4535 (if (not regexps+)
4536 (setq regexp org-outline-regexp-bol)
4537 (setq regexp (pop regexps+))
4538 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4539 regexp))))
4540 (setq files (org-agenda-files nil 'ifmode))
4541 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4542 (pop org-agenda-text-search-extra-files)
4543 (setq files (org-add-archive-files files)))
4544 (setq files (append files org-agenda-text-search-extra-files)
4545 rtnall nil)
4546 (while (setq file (pop files))
4547 (setq ee nil)
4548 (catch 'nextfile
4549 (org-check-agenda-file file)
4550 (setq buffer (if (file-exists-p file)
4551 (org-get-agenda-file-buffer file)
4552 (error "No such file %s" file)))
4553 (if (not buffer)
4554 ;; If file does not exist, make sure an error message is sent
4555 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4556 file))))
4557 (with-current-buffer buffer
4558 (with-syntax-table (org-search-syntax-table)
4559 (unless (derived-mode-p 'org-mode)
4560 (error "Agenda file %s is not in `org-mode'" file))
4561 (let ((case-fold-search t))
4562 (save-excursion
4563 (save-restriction
4564 (if (eq buffer org-agenda-restrict)
4565 (narrow-to-region org-agenda-restrict-begin
4566 org-agenda-restrict-end)
4567 (widen))
4568 (goto-char (point-min))
4569 (unless (or (org-at-heading-p)
4570 (outline-next-heading))
4571 (throw 'nextfile t))
4572 (goto-char (max (point-min) (1- (point))))
4573 (while (re-search-forward regexp nil t)
4574 (org-back-to-heading t)
4575 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4576 (> (org-reduced-level (org-outline-level))
4577 org-agenda-search-view-max-outline-level)
4578 (forward-line -1)
4579 (outline-back-to-heading t)))
4580 (skip-chars-forward "* ")
4581 (setq beg (point-at-bol)
4582 beg1 (point)
4583 end (progn
4584 (outline-next-heading)
4585 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4586 (> (org-reduced-level (org-outline-level))
4587 org-agenda-search-view-max-outline-level)
4588 (forward-line 1)
4589 (outline-next-heading)))
4590 (point)))
4592 (catch :skip
4593 (goto-char beg)
4594 (org-agenda-skip)
4595 (setq str (buffer-substring-no-properties
4596 (point-at-bol)
4597 (if hdl-only (point-at-eol) end)))
4598 (mapc (lambda (wr) (when (string-match wr str)
4599 (goto-char (1- end))
4600 (throw :skip t)))
4601 regexps-)
4602 (mapc (lambda (wr) (unless (string-match wr str)
4603 (goto-char (1- end))
4604 (throw :skip t)))
4605 (if todo-only
4606 (cons (concat "^\\*+[ \t]+"
4607 org-not-done-regexp)
4608 regexps+)
4609 regexps+))
4610 (goto-char beg)
4611 (setq marker (org-agenda-new-marker (point))
4612 category (org-get-category)
4613 level (make-string (org-reduced-level (org-outline-level)) ? )
4614 category-pos (get-text-property (point) 'org-category-position)
4615 inherited-tags
4616 (or (eq org-agenda-show-inherited-tags 'always)
4617 (and (listp org-agenda-show-inherited-tags)
4618 (memq 'todo org-agenda-show-inherited-tags))
4619 (and (eq org-agenda-show-inherited-tags t)
4620 (or (eq org-agenda-use-tag-inheritance t)
4621 (memq 'todo org-agenda-use-tag-inheritance))))
4622 tags (org-get-tags-at nil (not inherited-tags))
4623 txt (org-agenda-format-item
4625 (buffer-substring-no-properties
4626 beg1 (point-at-eol))
4627 level category tags t))
4628 (org-add-props txt props
4629 'org-marker marker 'org-hd-marker marker
4630 'org-todo-regexp org-todo-regexp
4631 'level level
4632 'org-complex-heading-regexp org-complex-heading-regexp
4633 'priority 1000 'org-category category
4634 'org-category-position category-pos
4635 'type "search")
4636 (push txt ee)
4637 (goto-char (1- end))))))))))
4638 (setq rtn (nreverse ee))
4639 (setq rtnall (append rtnall rtn)))
4640 (if org-agenda-overriding-header
4641 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4642 nil 'face 'org-agenda-structure) "\n")
4643 (insert "Search words: ")
4644 (add-text-properties (point-min) (1- (point))
4645 (list 'face 'org-agenda-structure))
4646 (setq pos (point))
4647 (insert string "\n")
4648 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4649 (setq pos (point))
4650 (unless org-agenda-multi
4651 (insert (substitute-command-keys
4652 "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n"))
4653 (add-text-properties pos (1- (point))
4654 (list 'face 'org-agenda-structure))))
4655 (org-agenda-mark-header-line (point-min))
4656 (when rtnall
4657 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4658 (goto-char (point-min))
4659 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4660 (add-text-properties (point-min) (point-max)
4661 `(org-agenda-type search
4662 org-last-args (,todo-only ,string ,edit-at)
4663 org-redo-cmd ,org-agenda-redo-command
4664 org-series-cmd ,org-cmd))
4665 (org-agenda-finalize)
4666 (setq buffer-read-only t))))
4668 ;;; Agenda TODO list
4670 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4671 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4672 (concat
4673 (if (or (equal keywords "ALL") (not keywords))
4674 (propertize "ALL" 'face 'warning)
4675 (mapconcat
4676 (lambda (kw)
4677 (propertize kw 'face (org-get-todo-face kw)))
4678 (org-split-string keywords "|")
4679 "|"))
4680 "\n"))
4682 (defvar org-select-this-todo-keyword nil)
4683 (defvar org-last-arg nil)
4685 ;;;###autoload
4686 (defun org-todo-list (&optional arg)
4687 "Show all (not done) TODO entries from all agenda file in a single list.
4688 The prefix arg can be used to select a specific TODO keyword and limit
4689 the list to these. When using \\[universal-argument], you will be prompted
4690 for a keyword. A numeric prefix directly selects the Nth keyword in
4691 `org-todo-keywords-1'."
4692 (interactive "P")
4693 (if org-agenda-overriding-arguments
4694 (setq arg org-agenda-overriding-arguments))
4695 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4696 (let* ((today (org-today))
4697 (date (calendar-gregorian-from-absolute today))
4698 (kwds org-todo-keywords-for-agenda)
4699 (completion-ignore-case t)
4700 (org-select-this-todo-keyword
4701 (if (stringp arg) arg
4702 (and arg (integerp arg) (> arg 0)
4703 (nth (1- arg) kwds))))
4704 rtn rtnall files file pos)
4705 (when (equal arg '(4))
4706 (setq org-select-this-todo-keyword
4707 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4708 (mapcar 'list kwds) nil nil)))
4709 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4710 (catch 'exit
4711 (if org-agenda-sticky
4712 (setq org-agenda-buffer-name
4713 (if (stringp org-select-this-todo-keyword)
4714 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4715 org-select-this-todo-keyword)
4716 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4717 (org-agenda-prepare "TODO")
4718 (org-compile-prefix-format 'todo)
4719 (org-set-sorting-strategy 'todo)
4720 (setq org-agenda-redo-command
4721 `(org-todo-list (or (and (numberp current-prefix-arg)
4722 current-prefix-arg)
4723 ,org-select-this-todo-keyword
4724 current-prefix-arg ,arg)))
4725 (setq files (org-agenda-files nil 'ifmode)
4726 rtnall nil)
4727 (while (setq file (pop files))
4728 (catch 'nextfile
4729 (org-check-agenda-file file)
4730 (setq rtn (org-agenda-get-day-entries file date :todo))
4731 (setq rtnall (append rtnall rtn))))
4732 (if org-agenda-overriding-header
4733 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4734 nil 'face 'org-agenda-structure) "\n")
4735 (insert "Global list of TODO items of type: ")
4736 (add-text-properties (point-min) (1- (point))
4737 (list 'face 'org-agenda-structure
4738 'short-heading
4739 (concat "ToDo: "
4740 (or org-select-this-todo-keyword "ALL"))))
4741 (org-agenda-mark-header-line (point-min))
4742 (insert (org-agenda-propertize-selected-todo-keywords
4743 org-select-this-todo-keyword))
4744 (setq pos (point))
4745 (unless org-agenda-multi
4746 (insert (substitute-command-keys "Available with `N r': (0)[ALL]"))
4747 (let ((n 0) s)
4748 (mapc (lambda (x)
4749 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4750 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4751 (insert "\n "))
4752 (insert " " s))
4753 kwds))
4754 (insert "\n"))
4755 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4756 (org-agenda-mark-header-line (point-min))
4757 (when rtnall
4758 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4759 (goto-char (point-min))
4760 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4761 (add-text-properties (point-min) (point-max)
4762 `(org-agenda-type todo
4763 org-last-args ,arg
4764 org-redo-cmd ,org-agenda-redo-command
4765 org-series-cmd ,org-cmd))
4766 (org-agenda-finalize)
4767 (setq buffer-read-only t))))
4769 ;;; Agenda tags match
4771 ;;;###autoload
4772 (defun org-tags-view (&optional todo-only match)
4773 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4774 The prefix arg TODO-ONLY limits the search to TODO entries."
4775 (interactive "P")
4776 (if org-agenda-overriding-arguments
4777 (setq todo-only (car org-agenda-overriding-arguments)
4778 match (nth 1 org-agenda-overriding-arguments)))
4779 (let* ((org-tags-match-list-sublevels
4780 org-tags-match-list-sublevels)
4781 (completion-ignore-case t)
4782 rtn rtnall files file pos matcher
4783 buffer)
4784 (when (and (stringp match) (not (string-match "\\S-" match)))
4785 (setq match nil))
4786 (catch 'exit
4787 (if org-agenda-sticky
4788 (setq org-agenda-buffer-name
4789 (if (stringp match)
4790 (format "*Org Agenda(%s:%s)*"
4791 (or org-keys (or (and todo-only "M") "m")) match)
4792 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4793 ;; Prepare agendas (and `org-tag-alist-for-agenda') before
4794 ;; expanding tags within `org-make-tags-matcher'
4795 (org-agenda-prepare (concat "TAGS " match))
4796 (setq matcher (org-make-tags-matcher match)
4797 match (car matcher) matcher (cdr matcher))
4798 (org-compile-prefix-format 'tags)
4799 (org-set-sorting-strategy 'tags)
4800 (setq org-agenda-query-string match)
4801 (setq org-agenda-redo-command
4802 (list 'org-tags-view `(quote ,todo-only)
4803 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4804 (setq files (org-agenda-files nil 'ifmode)
4805 rtnall nil)
4806 (while (setq file (pop files))
4807 (catch 'nextfile
4808 (org-check-agenda-file file)
4809 (setq buffer (if (file-exists-p file)
4810 (org-get-agenda-file-buffer file)
4811 (error "No such file %s" file)))
4812 (if (not buffer)
4813 ;; If file does not exist, error message to agenda
4814 (setq rtn (list
4815 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4816 rtnall (append rtnall rtn))
4817 (with-current-buffer buffer
4818 (unless (derived-mode-p 'org-mode)
4819 (error "Agenda file %s is not in `org-mode'" file))
4820 (save-excursion
4821 (save-restriction
4822 (if (eq buffer org-agenda-restrict)
4823 (narrow-to-region org-agenda-restrict-begin
4824 org-agenda-restrict-end)
4825 (widen))
4826 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4827 (setq rtnall (append rtnall rtn))))))))
4828 (if org-agenda-overriding-header
4829 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4830 nil 'face 'org-agenda-structure) "\n")
4831 (insert "Headlines with TAGS match: ")
4832 (add-text-properties (point-min) (1- (point))
4833 (list 'face 'org-agenda-structure
4834 'short-heading
4835 (concat "Match: " match)))
4836 (setq pos (point))
4837 (insert match "\n")
4838 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4839 (setq pos (point))
4840 (unless org-agenda-multi
4841 (insert (substitute-command-keys
4842 "Press `C-u r' to search again with new search string\n")))
4843 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4844 (org-agenda-mark-header-line (point-min))
4845 (when rtnall
4846 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4847 (goto-char (point-min))
4848 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4849 (add-text-properties (point-min) (point-max)
4850 `(org-agenda-type tags
4851 org-last-args (,todo-only ,match)
4852 org-redo-cmd ,org-agenda-redo-command
4853 org-series-cmd ,org-cmd))
4854 (org-agenda-finalize)
4855 (setq buffer-read-only t))))
4857 ;;; Agenda Finding stuck projects
4859 (defvar org-agenda-skip-regexp nil
4860 "Regular expression used in skipping subtrees for the agenda.
4861 This is basically a temporary global variable that can be set and then
4862 used by user-defined selections using `org-agenda-skip-function'.")
4864 (defvar org-agenda-overriding-header nil
4865 "When set during agenda, todo and tags searches it replaces the header.
4866 This variable should not be set directly, but custom commands can bind it
4867 in the options section.")
4869 (defun org-agenda-skip-entry-when-regexp-matches ()
4870 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4871 If yes, it returns the end position of this entry, causing agenda commands
4872 to skip the entry but continuing the search in the subtree. This is a
4873 function that can be put into `org-agenda-skip-function' for the duration
4874 of a command."
4875 (let ((end (save-excursion (org-end-of-subtree t)))
4876 skip)
4877 (save-excursion
4878 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4879 (and skip end)))
4881 (defun org-agenda-skip-subtree-when-regexp-matches ()
4882 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4883 If yes, it returns the end position of this tree, causing agenda commands
4884 to skip this subtree. This is a function that can be put into
4885 `org-agenda-skip-function' for the duration of a command."
4886 (let ((end (save-excursion (org-end-of-subtree t)))
4887 skip)
4888 (save-excursion
4889 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4890 (and skip end)))
4892 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4893 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4894 If yes, it returns the end position of the current entry (NOT the tree),
4895 causing agenda commands to skip the entry but continuing the search in
4896 the subtree. This is a function that can be put into
4897 `org-agenda-skip-function' for the duration of a command. An important
4898 use of this function is for the stuck project list."
4899 (let ((end (save-excursion (org-end-of-subtree t)))
4900 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4901 skip)
4902 (save-excursion
4903 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4904 (and skip entry-end)))
4906 (defun org-agenda-skip-entry-if (&rest conditions)
4907 "Skip entry if any of CONDITIONS is true.
4908 See `org-agenda-skip-if' for details."
4909 (org-agenda-skip-if nil conditions))
4911 (defun org-agenda-skip-subtree-if (&rest conditions)
4912 "Skip subtree if any of CONDITIONS is true.
4913 See `org-agenda-skip-if' for details."
4914 (org-agenda-skip-if t conditions))
4916 (defun org-agenda-skip-if (subtree conditions)
4917 "Checks current entity for CONDITIONS.
4918 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4919 the entry (i.e. the text before the next heading) is checked.
4921 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4922 from different tests. Valid conditions are:
4924 scheduled Check if there is a scheduled cookie
4925 notscheduled Check if there is no scheduled cookie
4926 deadline Check if there is a deadline
4927 notdeadline Check if there is no deadline
4928 timestamp Check if there is a timestamp (also deadline or scheduled)
4929 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4930 regexp Check if regexp matches
4931 notregexp Check if regexp does not match.
4932 todo Check if TODO keyword matches
4933 nottodo Check if TODO keyword does not match
4935 The regexp is taken from the conditions list, it must come right after
4936 the `regexp' or `notregexp' element.
4938 `todo' and `nottodo' accept as an argument a list of todo
4939 keywords, which may include \"*\" to match any todo keyword.
4941 (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
4943 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4945 Instead of a list, a keyword class may be given. For example:
4947 (org-agenda-skip-entry-if \\='nottodo \\='done)
4949 would skip entries that haven't been marked with any of \"DONE\"
4950 keywords. Possible classes are: `todo', `done', `any'.
4952 If any of these conditions is met, this function returns the end point of
4953 the entity, causing the search to continue from there. This is a function
4954 that can be put into `org-agenda-skip-function' for the duration of a command."
4955 (let (beg end m)
4956 (org-back-to-heading t)
4957 (setq beg (point)
4958 end (if subtree
4959 (progn (org-end-of-subtree t) (point))
4960 (progn (outline-next-heading) (1- (point)))))
4961 (goto-char beg)
4962 (and
4964 (and (memq 'scheduled conditions)
4965 (re-search-forward org-scheduled-time-regexp end t))
4966 (and (memq 'notscheduled conditions)
4967 (not (re-search-forward org-scheduled-time-regexp end t)))
4968 (and (memq 'deadline conditions)
4969 (re-search-forward org-deadline-time-regexp end t))
4970 (and (memq 'notdeadline conditions)
4971 (not (re-search-forward org-deadline-time-regexp end t)))
4972 (and (memq 'timestamp conditions)
4973 (re-search-forward org-ts-regexp end t))
4974 (and (memq 'nottimestamp conditions)
4975 (not (re-search-forward org-ts-regexp end t)))
4976 (and (setq m (memq 'regexp conditions))
4977 (stringp (nth 1 m))
4978 (re-search-forward (nth 1 m) end t))
4979 (and (setq m (memq 'notregexp conditions))
4980 (stringp (nth 1 m))
4981 (not (re-search-forward (nth 1 m) end t)))
4982 (and (or
4983 (setq m (memq 'nottodo conditions))
4984 (setq m (memq 'todo-unblocked conditions))
4985 (setq m (memq 'nottodo-unblocked conditions))
4986 (setq m (memq 'todo conditions)))
4987 (org-agenda-skip-if-todo m end)))
4988 end)))
4990 (defun org-agenda-skip-if-todo (args end)
4991 "Helper function for `org-agenda-skip-if', do not use it directly.
4992 ARGS is a list with first element either `todo', `nottodo',
4993 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4994 a list of TODO keywords, or a state symbol `todo' or `done' or
4995 `any'."
4996 (let ((kw (car args))
4997 (arg (cadr args))
4998 todo-wds todo-re)
4999 (setq todo-wds
5000 (org-uniquify
5001 (cond
5002 ((listp arg) ;; list of keywords
5003 (if (member "*" arg)
5004 (mapcar 'substring-no-properties org-todo-keywords-1)
5005 arg))
5006 ((symbolp arg) ;; keyword class name
5007 (cond
5008 ((eq arg 'todo)
5009 (org-delete-all org-done-keywords
5010 (mapcar 'substring-no-properties
5011 org-todo-keywords-1)))
5012 ((eq arg 'done) org-done-keywords)
5013 ((eq arg 'any)
5014 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
5015 (setq todo-re
5016 (concat "^\\*+[ \t]+\\<\\("
5017 (mapconcat 'identity todo-wds "\\|")
5018 "\\)\\>"))
5019 (cond
5020 ((eq kw 'todo) (re-search-forward todo-re end t))
5021 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
5022 ((eq kw 'todo-unblocked)
5023 (catch 'unblocked
5024 (while (re-search-forward todo-re end t)
5025 (or (org-entry-blocked-p) (throw 'unblocked t)))
5026 nil))
5027 ((eq kw 'nottodo-unblocked)
5028 (catch 'unblocked
5029 (while (re-search-forward todo-re end t)
5030 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5034 ;;;###autoload
5035 (defun org-agenda-list-stuck-projects (&rest ignore)
5036 "Create agenda view for projects that are stuck.
5037 Stuck projects are project that have no next actions. For the definitions
5038 of what a project is and how to check if it stuck, customize the variable
5039 `org-stuck-projects'."
5040 (interactive)
5041 (let* ((org-agenda-skip-function
5042 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5043 ;; We could have used org-agenda-skip-if here.
5044 (org-agenda-overriding-header
5045 (or org-agenda-overriding-header "List of stuck projects: "))
5046 (matcher (nth 0 org-stuck-projects))
5047 (todo (nth 1 org-stuck-projects))
5048 (todo-wds (if (member "*" todo)
5049 (progn
5050 (org-agenda-prepare-buffers (org-agenda-files
5051 nil 'ifmode))
5052 (org-delete-all
5053 org-done-keywords-for-agenda
5054 (copy-sequence org-todo-keywords-for-agenda)))
5055 todo))
5056 (todo-re (concat "^\\*+[ \t]+\\("
5057 (mapconcat 'identity todo-wds "\\|")
5058 "\\)\\>"))
5059 (tags (nth 2 org-stuck-projects))
5060 (tags-re (if (member "*" tags)
5061 (concat org-outline-regexp-bol
5062 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5063 (if tags
5064 (concat org-outline-regexp-bol
5065 ".*:\\("
5066 (mapconcat 'identity tags "\\|")
5067 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5068 (gen-re (nth 3 org-stuck-projects))
5069 (re-list
5070 (delq nil
5071 (list
5072 (if todo todo-re)
5073 (if tags tags-re)
5074 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5075 gen-re)))))
5076 (setq org-agenda-skip-regexp
5077 (if re-list
5078 (mapconcat 'identity re-list "\\|")
5079 (error "No information how to identify unstuck projects")))
5080 (org-tags-view nil matcher)
5081 (setq org-agenda-buffer-name (buffer-name))
5082 (with-current-buffer org-agenda-buffer-name
5083 (setq org-agenda-redo-command
5084 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5086 ;;; Diary integration
5088 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5089 (defvar diary-list-entries-hook)
5090 (defvar diary-time-regexp)
5091 (defun org-get-entries-from-diary (date)
5092 "Get the (Emacs Calendar) diary entries for DATE."
5093 (require 'diary-lib)
5094 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5095 (diary-display-function 'diary-fancy-display)
5096 (pop-up-frames nil)
5097 (diary-list-entries-hook
5098 (cons 'org-diary-default-entry diary-list-entries-hook))
5099 (diary-file-name-prefix nil) ; turn this feature off
5100 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5101 entries
5102 (org-disable-agenda-to-diary t))
5103 (save-excursion
5104 (save-window-excursion
5105 (funcall (if (fboundp 'diary-list-entries)
5106 'diary-list-entries 'list-diary-entries)
5107 date 1)))
5108 (if (not (get-buffer diary-fancy-buffer))
5109 (setq entries nil)
5110 (with-current-buffer diary-fancy-buffer
5111 (setq buffer-read-only nil)
5112 (if (zerop (buffer-size))
5113 ;; No entries
5114 (setq entries nil)
5115 ;; Omit the date and other unnecessary stuff
5116 (org-agenda-cleanup-fancy-diary)
5117 ;; Add prefix to each line and extend the text properties
5118 (if (zerop (buffer-size))
5119 (setq entries nil)
5120 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5121 (setq entries
5122 (with-temp-buffer
5123 (insert entries) (goto-char (point-min))
5124 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5125 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5126 (replace-match (concat "; " (match-string 1)))))
5127 (buffer-string)))))
5128 (set-buffer-modified-p nil)
5129 (kill-buffer diary-fancy-buffer)))
5130 (when entries
5131 (setq entries (org-split-string entries "\n"))
5132 (setq entries
5133 (mapcar
5134 (lambda (x)
5135 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5136 ;; Extend the text properties to the beginning of the line
5137 (org-add-props x (text-properties-at (1- (length x)) x)
5138 'type "diary" 'date date 'face 'org-agenda-diary))
5139 entries)))))
5141 (defvar org-agenda-cleanup-fancy-diary-hook nil
5142 "Hook run when the fancy diary buffer is cleaned up.")
5144 (defun org-agenda-cleanup-fancy-diary ()
5145 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5146 This gets rid of the date, the underline under the date, and
5147 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5148 date. It also removes lines that contain only whitespace."
5149 (goto-char (point-min))
5150 (if (looking-at ".*?:[ \t]*")
5151 (progn
5152 (replace-match "")
5153 (re-search-forward "\n=+$" nil t)
5154 (replace-match "")
5155 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5156 (re-search-forward "\n=+$" nil t)
5157 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5158 (goto-char (point-min))
5159 (while (re-search-forward "^ +\n" nil t)
5160 (replace-match ""))
5161 (goto-char (point-min))
5162 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5163 (replace-match ""))
5164 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5166 ;; Make sure entries from the diary have the right text properties.
5167 (eval-after-load "diary-lib"
5168 '(if (boundp 'diary-modify-entry-list-string-function)
5169 ;; We can rely on the hook, nothing to do
5171 ;; Hook not available, must use advice to make this work
5172 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5173 "Make the position visible."
5174 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5175 (stringp string)
5176 buffer-file-name)
5177 (setq string (org-modify-diary-entry-string string))))))
5179 (defun org-modify-diary-entry-string (string)
5180 "Add text properties to string, allowing org-mode to act on it."
5181 (org-add-props string nil
5182 'mouse-face 'highlight
5183 'help-echo (if buffer-file-name
5184 (format "mouse-2 or RET jump to diary file %s"
5185 (abbreviate-file-name buffer-file-name))
5187 'org-agenda-diary-link t
5188 'org-marker (org-agenda-new-marker (point-at-bol))))
5190 (defun org-diary-default-entry ()
5191 "Add a dummy entry to the diary.
5192 Needed to avoid empty dates which mess up holiday display."
5193 ;; Catch the error if dealing with the new add-to-diary-alist
5194 (when org-disable-agenda-to-diary
5195 (condition-case nil
5196 (org-add-to-diary-list original-date "Org-mode dummy" "")
5197 (error
5198 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5200 (defun org-add-to-diary-list (&rest args)
5201 (if (fboundp 'diary-add-to-list)
5202 (apply 'diary-add-to-list args)
5203 (apply 'add-to-diary-list args)))
5205 (defvar org-diary-last-run-time nil)
5207 ;;;###autoload
5208 (defun org-diary (&rest args)
5209 "Return diary information from org files.
5210 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5211 It accesses org files and extracts information from those files to be
5212 listed in the diary. The function accepts arguments specifying what
5213 items should be listed. For a list of arguments allowed here, see the
5214 variable `org-agenda-entry-types'.
5216 The call in the diary file should look like this:
5218 &%%(org-diary) ~/path/to/some/orgfile.org
5220 Use a separate line for each org file to check. Or, if you omit the file name,
5221 all files listed in `org-agenda-files' will be checked automatically:
5223 &%%(org-diary)
5225 If you don't give any arguments (as in the example above), the default value
5226 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5227 So the example above may also be written as
5229 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5231 The function expects the lisp variables `entry' and `date' to be provided
5232 by the caller, because this is how the calendar works. Don't use this
5233 function from a program - use `org-agenda-get-day-entries' instead."
5234 (when (> (- (float-time)
5235 org-agenda-last-marker-time)
5237 ;; I am not sure if this works with sticky agendas, because the marker
5238 ;; list is then no longer a global variable.
5239 (org-agenda-reset-markers))
5240 (org-compile-prefix-format 'agenda)
5241 (org-set-sorting-strategy 'agenda)
5242 (setq args (or args org-agenda-entry-types))
5243 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5244 (list entry)
5245 (org-agenda-files t)))
5246 (time (float-time))
5247 file rtn results)
5248 (when (or (not org-diary-last-run-time)
5249 (> (- time
5250 org-diary-last-run-time)
5252 (org-agenda-prepare-buffers files))
5253 (setq org-diary-last-run-time time)
5254 ;; If this is called during org-agenda, don't return any entries to
5255 ;; the calendar. Org Agenda will list these entries itself.
5256 (if org-disable-agenda-to-diary (setq files nil))
5257 (while (setq file (pop files))
5258 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5259 (setq results (append results rtn)))
5260 (when results
5261 (setq results
5262 (mapcar (lambda (i) (replace-regexp-in-string
5263 org-bracket-link-regexp "\\3" i)) results))
5264 (concat (org-agenda-finalize-entries results) "\n"))))
5266 ;;; Agenda entry finders
5268 (defun org-agenda-get-day-entries (file date &rest args)
5269 "Does the work for `org-diary' and `org-agenda'.
5270 FILE is the path to a file to be checked for entries. DATE is date like
5271 the one returned by `calendar-current-date'. ARGS are symbols indicating
5272 which kind of entries should be extracted. For details about these, see
5273 the documentation of `org-diary'."
5274 (setq args (or args org-agenda-entry-types))
5275 (let* ((org-startup-folded nil)
5276 (org-startup-align-all-tables nil)
5277 (buffer (if (file-exists-p file)
5278 (org-get-agenda-file-buffer file)
5279 (error "No such file %s" file)))
5280 arg results rtn deadline-results)
5281 (if (not buffer)
5282 ;; If file does not exist, make sure an error message ends up in diary
5283 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5284 (with-current-buffer buffer
5285 (unless (derived-mode-p 'org-mode)
5286 (error "Agenda file %s is not in `org-mode'" file))
5287 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5288 (let ((case-fold-search nil))
5289 (save-excursion
5290 (save-restriction
5291 (if (eq buffer org-agenda-restrict)
5292 (narrow-to-region org-agenda-restrict-begin
5293 org-agenda-restrict-end)
5294 (widen))
5295 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
5296 (while (setq arg (pop args))
5297 (cond
5298 ((and (eq arg :todo)
5299 (equal date (calendar-gregorian-from-absolute
5300 (org-today))))
5301 (setq rtn (org-agenda-get-todos))
5302 (setq results (append results rtn)))
5303 ((eq arg :timestamp)
5304 (setq rtn (org-agenda-get-blocks))
5305 (setq results (append results rtn))
5306 (setq rtn (org-agenda-get-timestamps deadline-results))
5307 (setq results (append results rtn)))
5308 ((eq arg :sexp)
5309 (setq rtn (org-agenda-get-sexps))
5310 (setq results (append results rtn)))
5311 ((eq arg :scheduled)
5312 (setq rtn (org-agenda-get-scheduled deadline-results))
5313 (setq results (append results rtn)))
5314 ((eq arg :scheduled*)
5315 (setq rtn (org-agenda-get-scheduled deadline-results t))
5316 (setq results (append results rtn)))
5317 ((eq arg :closed)
5318 (setq rtn (org-agenda-get-progress))
5319 (setq results (append results rtn)))
5320 ((eq arg :deadline)
5321 (setq rtn (org-agenda-get-deadlines))
5322 (setq deadline-results (copy-sequence rtn))
5323 (setq results (append results rtn)))
5324 ((eq arg :deadline*)
5325 (setq rtn (org-agenda-get-deadlines t))
5326 (setq deadline-results (copy-sequence rtn))
5327 (setq results (append results rtn))))))))
5328 results))))
5330 (defsubst org-em (x y list)
5331 "Is X or Y a member of LIST?"
5332 (or (memq x list) (memq y list)))
5334 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5335 (defvar org-agenda-sorting-strategy-selected nil)
5337 (defun org-agenda-get-todos ()
5338 "Return the TODO information for agenda display."
5339 (let* ((props (list 'face nil
5340 'done-face 'org-agenda-done
5341 'org-not-done-regexp org-not-done-regexp
5342 'org-todo-regexp org-todo-regexp
5343 'org-complex-heading-regexp org-complex-heading-regexp
5344 'mouse-face 'highlight
5345 'help-echo
5346 (format "mouse-2 or RET jump to org file %s"
5347 (abbreviate-file-name buffer-file-name))))
5348 (regexp (format org-heading-keyword-regexp-format
5349 (cond
5350 ((and org-select-this-todo-keyword
5351 (equal org-select-this-todo-keyword "*"))
5352 org-todo-regexp)
5353 (org-select-this-todo-keyword
5354 (concat "\\("
5355 (mapconcat 'identity
5356 (org-split-string
5357 org-select-this-todo-keyword
5358 "|")
5359 "\\|") "\\)"))
5360 (t org-not-done-regexp))))
5361 marker priority category category-pos level tags todo-state ts-date ts-date-type
5362 ee txt beg end inherited-tags todo-state-end-pos)
5363 (goto-char (point-min))
5364 (while (re-search-forward regexp nil t)
5365 (catch :skip
5366 (save-match-data
5367 (beginning-of-line)
5368 (org-agenda-skip)
5369 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5370 (unless (and (setq todo-state (org-get-todo-state))
5371 (setq todo-state-end-pos (match-end 2)))
5372 (goto-char end)
5373 (throw :skip nil))
5374 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5375 (goto-char (1+ beg))
5376 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5377 (throw :skip nil)))
5378 (goto-char (match-beginning 2))
5379 (setq marker (org-agenda-new-marker (match-beginning 0))
5380 category (org-get-category)
5381 ts-date (let (ts)
5382 (save-match-data
5383 (cond ((org-em 'scheduled-up 'scheduled-down
5384 org-agenda-sorting-strategy-selected)
5385 (setq ts (org-entry-get (point) "SCHEDULED")
5386 ts-date-type " scheduled"))
5387 ((org-em 'deadline-up 'deadline-down
5388 org-agenda-sorting-strategy-selected)
5389 (setq ts (org-entry-get (point) "DEADLINE")
5390 ts-date-type " deadline"))
5391 ((org-em 'ts-up 'ts-down
5392 org-agenda-sorting-strategy-selected)
5393 (setq ts (org-entry-get (point) "TIMESTAMP")
5394 ts-date-type " timestamp"))
5395 ((org-em 'tsia-up 'tsia-down
5396 org-agenda-sorting-strategy-selected)
5397 (setq ts (org-entry-get (point) "TIMESTAMP_IA")
5398 ts-date-type " timestamp_ia"))
5399 ((org-em 'timestamp-up 'timestamp-down
5400 org-agenda-sorting-strategy-selected)
5401 (setq ts (or (org-entry-get (point) "SCHEDULED")
5402 (org-entry-get (point) "DEADLINE")
5403 (org-entry-get (point) "TIMESTAMP")
5404 (org-entry-get (point) "TIMESTAMP_IA"))
5405 ts-date-type ""))
5406 (t (setq ts-date-type "")))
5407 (when ts (ignore-errors (org-time-string-to-absolute ts)))))
5408 category-pos (get-text-property (point) 'org-category-position)
5409 txt (org-trim
5410 (buffer-substring (match-beginning 2) (match-end 0)))
5411 inherited-tags
5412 (or (eq org-agenda-show-inherited-tags 'always)
5413 (and (listp org-agenda-show-inherited-tags)
5414 (memq 'todo org-agenda-show-inherited-tags))
5415 (and (eq org-agenda-show-inherited-tags t)
5416 (or (eq org-agenda-use-tag-inheritance t)
5417 (memq 'todo org-agenda-use-tag-inheritance))))
5418 tags (org-get-tags-at nil (not inherited-tags))
5419 level (make-string (org-reduced-level (org-outline-level)) ? )
5420 txt (org-agenda-format-item "" txt level category tags t)
5421 priority (1+ (org-get-priority txt)))
5422 (org-add-props txt props
5423 'org-marker marker 'org-hd-marker marker
5424 'priority priority 'org-category category
5425 'level level
5426 'ts-date ts-date
5427 'org-category-position category-pos
5428 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5429 (push txt ee)
5430 (if org-agenda-todo-list-sublevels
5431 (goto-char todo-state-end-pos)
5432 (org-end-of-subtree 'invisible))))
5433 (nreverse ee)))
5435 (defun org-agenda-todo-custom-ignore-p (time n)
5436 "Check whether timestamp is farther away than n number of days.
5437 This function is invoked if `org-agenda-todo-ignore-deadlines',
5438 `org-agenda-todo-ignore-scheduled' or
5439 `org-agenda-todo-ignore-timestamp' is set to an integer."
5440 (let ((days (org-time-stamp-to-now
5441 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5442 (if (>= n 0)
5443 (>= days n)
5444 (<= days n))))
5446 ;;;###autoload
5447 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5448 (&optional end)
5449 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5450 (when (or org-agenda-todo-ignore-with-date
5451 org-agenda-todo-ignore-scheduled
5452 org-agenda-todo-ignore-deadlines
5453 org-agenda-todo-ignore-timestamp)
5454 (setq end (or end (save-excursion (outline-next-heading) (point))))
5455 (save-excursion
5456 (or (and org-agenda-todo-ignore-with-date
5457 (re-search-forward org-ts-regexp end t))
5458 (and org-agenda-todo-ignore-scheduled
5459 (re-search-forward org-scheduled-time-regexp end t)
5460 (cond
5461 ((eq org-agenda-todo-ignore-scheduled 'future)
5462 (> (org-time-stamp-to-now
5463 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5464 ((eq org-agenda-todo-ignore-scheduled 'past)
5465 (<= (org-time-stamp-to-now
5466 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5467 ((numberp org-agenda-todo-ignore-scheduled)
5468 (org-agenda-todo-custom-ignore-p
5469 (match-string 1) org-agenda-todo-ignore-scheduled))
5470 (t)))
5471 (and org-agenda-todo-ignore-deadlines
5472 (re-search-forward org-deadline-time-regexp end t)
5473 (cond
5474 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5475 ((eq org-agenda-todo-ignore-deadlines 'far)
5476 (not (org-deadline-close (match-string 1))))
5477 ((eq org-agenda-todo-ignore-deadlines 'future)
5478 (> (org-time-stamp-to-now
5479 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5480 ((eq org-agenda-todo-ignore-deadlines 'past)
5481 (<= (org-time-stamp-to-now
5482 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5483 ((numberp org-agenda-todo-ignore-deadlines)
5484 (org-agenda-todo-custom-ignore-p
5485 (match-string 1) org-agenda-todo-ignore-deadlines))
5486 (t (org-deadline-close (match-string 1)))))
5487 (and org-agenda-todo-ignore-timestamp
5488 (let ((buffer (current-buffer))
5489 (regexp
5490 (concat
5491 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5492 (start (point)))
5493 ;; Copy current buffer into a temporary one
5494 (with-temp-buffer
5495 (insert-buffer-substring buffer start end)
5496 (goto-char (point-min))
5497 ;; Delete SCHEDULED and DEADLINE items
5498 (while (re-search-forward regexp end t)
5499 (delete-region (match-beginning 0) (match-end 0)))
5500 (goto-char (point-min))
5501 ;; No search for timestamp left
5502 (when (re-search-forward org-ts-regexp nil t)
5503 (cond
5504 ((eq org-agenda-todo-ignore-timestamp 'future)
5505 (> (org-time-stamp-to-now
5506 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5507 ((eq org-agenda-todo-ignore-timestamp 'past)
5508 (<= (org-time-stamp-to-now
5509 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5510 ((numberp org-agenda-todo-ignore-timestamp)
5511 (org-agenda-todo-custom-ignore-p
5512 (match-string 1) org-agenda-todo-ignore-timestamp))
5513 (t))))))))))
5515 (defun org-agenda-get-timestamps (&optional deadline-results)
5516 "Return the date stamp information for agenda display."
5517 (let* ((props (list 'face 'org-agenda-calendar-event
5518 'org-not-done-regexp org-not-done-regexp
5519 'org-todo-regexp org-todo-regexp
5520 'org-complex-heading-regexp org-complex-heading-regexp
5521 'mouse-face 'highlight
5522 'help-echo
5523 (format "mouse-2 or RET jump to org file %s"
5524 (abbreviate-file-name buffer-file-name))))
5525 (d1 (calendar-absolute-from-gregorian date))
5527 (deadline-position-alist
5528 (mapcar (lambda (a) (and (setq mm (get-text-property
5529 0 'org-hd-marker a))
5530 (cons (marker-position mm) a)))
5531 deadline-results))
5532 (remove-re org-ts-regexp)
5533 (regexp
5534 (concat
5535 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5536 (regexp-quote
5537 (substring
5538 (format-time-string
5539 (car org-time-stamp-formats)
5540 (apply 'encode-time ; DATE bound by calendar
5541 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5542 1 11))
5543 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5544 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5545 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5546 donep tmp priority category category-pos level ee txt timestr tags
5547 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5548 inherited-tags ts-date)
5549 (goto-char (point-min))
5550 (while (setq end-of-match (re-search-forward regexp nil t))
5551 (setq b0 (match-beginning 0)
5552 b3 (match-beginning 3) e3 (match-end 3)
5553 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5554 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5555 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5556 (member todo-state
5557 org-agenda-repeating-timestamp-show-all)))
5558 (catch :skip
5559 (and (org-at-date-range-p) (throw :skip nil))
5560 (org-agenda-skip)
5561 (if (and (match-end 1)
5562 (not (= d1 (org-time-string-to-absolute
5563 (match-string 1) d1 nil show-all
5564 (current-buffer) b0))))
5565 (throw :skip nil))
5566 (if (and e3
5567 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5568 (throw :skip nil))
5569 (setq tmp (buffer-substring (max (point-min)
5570 (- b0 org-ds-keyword-length))
5572 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5573 inactivep (= (char-after b0) ?\[)
5574 deadlinep (string-match org-deadline-regexp tmp)
5575 scheduledp (string-match org-scheduled-regexp tmp)
5576 closedp (and org-agenda-include-inactive-timestamps
5577 (string-match org-closed-string tmp))
5578 clockp (and org-agenda-include-inactive-timestamps
5579 (or (string-match org-clock-string tmp)
5580 (string-match "]-+\\'" tmp)))
5581 warntime (get-text-property (point) 'org-appt-warntime)
5582 donep (member todo-state org-done-keywords))
5583 (if (or scheduledp deadlinep closedp clockp
5584 (and donep org-agenda-skip-timestamp-if-done))
5585 (throw :skip t))
5586 (if (string-match ">" timestr)
5587 ;; substring should only run to end of time stamp
5588 (setq timestr (substring timestr 0 (match-end 0))))
5589 (setq marker (org-agenda-new-marker b0)
5590 category (org-get-category b0)
5591 category-pos (get-text-property b0 'org-category-position))
5592 (save-excursion
5593 (if (not (re-search-backward org-outline-regexp-bol nil t))
5594 (throw :skip nil)
5595 (goto-char (match-beginning 0))
5596 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5597 (assoc (point) deadline-position-alist))
5598 (throw :skip nil))
5599 (setq hdmarker (org-agenda-new-marker)
5600 inherited-tags
5601 (or (eq org-agenda-show-inherited-tags 'always)
5602 (and (listp org-agenda-show-inherited-tags)
5603 (memq 'agenda org-agenda-show-inherited-tags))
5604 (and (eq org-agenda-show-inherited-tags t)
5605 (or (eq org-agenda-use-tag-inheritance t)
5606 (memq 'agenda org-agenda-use-tag-inheritance))))
5607 tags (org-get-tags-at nil (not inherited-tags))
5608 level (make-string (org-reduced-level (org-outline-level)) ? ))
5609 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5610 (setq head (or (match-string 1) ""))
5611 (setq txt (org-agenda-format-item
5612 (if inactivep org-agenda-inactive-leader nil)
5613 head level category tags timestr
5614 remove-re habitp)))
5615 (setq priority (org-get-priority txt))
5616 (org-add-props txt props 'priority priority
5617 'org-marker marker 'org-hd-marker hdmarker
5618 'org-category category 'date date
5619 'level level
5620 'ts-date
5621 (ignore-errors (org-time-string-to-absolute timestr))
5622 'org-category-position category-pos
5623 'todo-state todo-state
5624 'warntime warntime
5625 'type "timestamp")
5626 (push txt ee))
5627 (if org-agenda-skip-additional-timestamps-same-entry
5628 (outline-next-heading)
5629 (goto-char end-of-match))))
5630 (nreverse ee)))
5632 (defun org-agenda-get-sexps ()
5633 "Return the sexp information for agenda display."
5634 (require 'diary-lib)
5635 (let* ((props (list 'face 'org-agenda-calendar-sexp
5636 'mouse-face 'highlight
5637 'help-echo
5638 (format "mouse-2 or RET jump to org file %s"
5639 (abbreviate-file-name buffer-file-name))))
5640 (regexp "^&?%%(")
5641 marker category extra category-pos level ee txt tags entry
5642 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5643 (goto-char (point-min))
5644 (while (re-search-forward regexp nil t)
5645 (catch :skip
5646 (org-agenda-skip)
5647 (setq beg (match-beginning 0))
5648 (goto-char (1- (match-end 0)))
5649 (setq b (point))
5650 (forward-sexp 1)
5651 (setq sexp (buffer-substring b (point)))
5652 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5653 (org-trim (match-string 1))
5654 ""))
5655 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5656 (when result
5657 (setq marker (org-agenda-new-marker beg)
5658 level (make-string (org-reduced-level (org-outline-level)) ? )
5659 category (org-get-category beg)
5660 category-pos (get-text-property beg 'org-category-position)
5661 inherited-tags
5662 (or (eq org-agenda-show-inherited-tags 'always)
5663 (and (listp org-agenda-show-inherited-tags)
5664 (memq 'agenda org-agenda-show-inherited-tags))
5665 (and (eq org-agenda-show-inherited-tags t)
5666 (or (eq org-agenda-use-tag-inheritance t)
5667 (memq 'agenda org-agenda-use-tag-inheritance))))
5668 tags (org-get-tags-at nil (not inherited-tags))
5669 todo-state (org-get-todo-state)
5670 warntime (get-text-property (point) 'org-appt-warntime)
5671 extra nil)
5673 (dolist (r (if (stringp result)
5674 (list result)
5675 result)) ;; we expect a list here
5676 (when (and org-agenda-diary-sexp-prefix
5677 (string-match org-agenda-diary-sexp-prefix r))
5678 (setq extra (match-string 0 r)
5679 r (replace-match "" nil nil r)))
5680 (if (string-match "\\S-" r)
5681 (setq txt r)
5682 (setq txt "SEXP entry returned empty string"))
5683 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5684 (org-add-props txt props 'org-marker marker
5685 'org-category category 'date date 'todo-state todo-state
5686 'org-category-position category-pos
5687 'level level
5688 'type "sexp" 'warntime warntime)
5689 (push txt ee)))))
5690 (nreverse ee)))
5692 ;; Calendar sanity: define some functions that are independent of
5693 ;; `calendar-date-style'.
5694 ;; Normally I would like to use ISO format when calling the diary functions,
5695 ;; but to make sure we still have Emacs 22 compatibility we bind
5696 ;; also `european-calendar-style' and use european format
5697 (defun org-anniversary (year month day &optional mark)
5698 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5699 (org-no-warnings
5700 (let ((calendar-date-style 'european) (european-calendar-style t))
5701 (diary-anniversary day month year mark))))
5702 (defun org-cyclic (N year month day &optional mark)
5703 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5704 (org-no-warnings
5705 (let ((calendar-date-style 'european) (european-calendar-style t))
5706 (diary-cyclic N day month year mark))))
5707 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5708 "Like `diary-block', but with fixed (ISO) order of arguments."
5709 (org-no-warnings
5710 (let ((calendar-date-style 'european) (european-calendar-style t))
5711 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5712 (defun org-date (year month day &optional mark)
5713 "Like `diary-date', but with fixed (ISO) order of arguments."
5714 (org-no-warnings
5715 (let ((calendar-date-style 'european) (european-calendar-style t))
5716 (diary-date day month year mark))))
5718 ;; Define the `org-class' function
5719 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5720 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5721 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5722 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5723 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5724 `holidays', then any date that is known by the Emacs calendar to be a
5725 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5726 then those holidays will be skipped."
5727 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5728 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5729 (d (calendar-absolute-from-gregorian date))
5730 (h (when skip-weeks (calendar-check-holidays date))))
5731 (and
5732 (<= date1 d)
5733 (<= d date2)
5734 (= (calendar-day-of-week date) dayname)
5735 (or (not skip-weeks)
5736 (progn
5737 (require 'cal-iso)
5738 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5739 (not (or (and h (memq 'holidays skip-weeks))
5740 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5741 entry)))
5743 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5744 "Like `org-class', but honor `calendar-date-style'.
5745 The order of the first 2 times 3 arguments depends on the variable
5746 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5747 So for American calendars, give this as MONTH DAY YEAR, for European as
5748 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5749 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5750 is any number of ISO weeks in the block period for which the item should
5751 be skipped.
5753 This function is here only for backward compatibility and it is deprecated,
5754 please use `org-class' instead."
5755 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5756 (date2 (org-order-calendar-date-args m2 d2 y2)))
5757 (org-class
5758 (nth 2 date1) (car date1) (nth 1 date1)
5759 (nth 2 date2) (car date2) (nth 1 date2)
5760 dayname skip-weeks)))
5761 (make-obsolete 'org-diary-class 'org-class "")
5763 (defalias 'org-get-closed 'org-agenda-get-progress)
5764 (defun org-agenda-get-progress ()
5765 "Return the logged TODO entries for agenda display."
5766 (let* ((props (list 'mouse-face 'highlight
5767 'org-not-done-regexp org-not-done-regexp
5768 'org-todo-regexp org-todo-regexp
5769 'org-complex-heading-regexp org-complex-heading-regexp
5770 'help-echo
5771 (format "mouse-2 or RET jump to org file %s"
5772 (abbreviate-file-name buffer-file-name))))
5773 (items (if (consp org-agenda-show-log-scoped)
5774 org-agenda-show-log-scoped
5775 (if (eq org-agenda-show-log-scoped 'clockcheck)
5776 '(clock)
5777 org-agenda-log-mode-items)))
5778 (parts
5779 (delq nil
5780 (list
5781 (if (memq 'closed items) (concat "\\<" org-closed-string))
5782 (if (memq 'clock items) (concat "\\<" org-clock-string))
5783 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5784 (parts-re (if parts (mapconcat 'identity parts "\\|")
5785 (error "`org-agenda-log-mode-items' is empty")))
5786 (regexp (concat
5787 "\\(" parts-re "\\)"
5788 " *\\["
5789 (regexp-quote
5790 (substring
5791 (format-time-string
5792 (car org-time-stamp-formats)
5793 (apply 'encode-time ; DATE bound by calendar
5794 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5795 1 11))))
5796 (org-agenda-search-headline-for-time nil)
5797 marker hdmarker priority category category-pos level tags closedp
5798 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5799 (goto-char (point-min))
5800 (while (re-search-forward regexp nil t)
5801 (catch :skip
5802 (org-agenda-skip)
5803 (setq marker (org-agenda-new-marker (match-beginning 0))
5804 closedp (equal (match-string 1) org-closed-string)
5805 statep (equal (string-to-char (match-string 1)) ?-)
5806 clockp (not (or closedp statep))
5807 state (and statep (match-string 2))
5808 category (org-get-category (match-beginning 0))
5809 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5810 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5811 (when (string-match "\\]" timestr)
5812 ;; substring should only run to end of time stamp
5813 (setq rest (substring timestr (match-end 0))
5814 timestr (substring timestr 0 (match-end 0)))
5815 (if (and (not closedp) (not statep)
5816 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5817 rest))
5818 (progn (setq timestr (concat (substring timestr 0 -1)
5819 "-" (match-string 1 rest) "]"))
5820 (setq clocked (match-string 2 rest)))
5821 (setq clocked "-")))
5822 (save-excursion
5823 (setq extra
5824 (cond
5825 ((not org-agenda-log-mode-add-notes) nil)
5826 (statep
5827 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5828 (match-string 1)))
5829 (clockp
5830 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5831 (match-string 1)))))
5832 (if (not (re-search-backward org-outline-regexp-bol nil t))
5833 (throw :skip nil)
5834 (goto-char (match-beginning 0))
5835 (setq hdmarker (org-agenda-new-marker)
5836 inherited-tags
5837 (or (eq org-agenda-show-inherited-tags 'always)
5838 (and (listp org-agenda-show-inherited-tags)
5839 (memq 'todo org-agenda-show-inherited-tags))
5840 (and (eq org-agenda-show-inherited-tags t)
5841 (or (eq org-agenda-use-tag-inheritance t)
5842 (memq 'todo org-agenda-use-tag-inheritance))))
5843 tags (org-get-tags-at nil (not inherited-tags))
5844 level (make-string (org-reduced-level (org-outline-level)) ? ))
5845 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5846 (setq txt (match-string 1))
5847 (when extra
5848 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5849 (setq txt (concat (substring txt 0 (match-beginning 1))
5850 " - " extra " " (match-string 2 txt)))
5851 (setq txt (concat txt " - " extra))))
5852 (setq txt (org-agenda-format-item
5853 (cond
5854 (closedp "Closed: ")
5855 (statep (concat "State: (" state ")"))
5856 (t (concat "Clocked: (" clocked ")")))
5857 txt level category tags timestr)))
5858 (setq priority 100000)
5859 (org-add-props txt props
5860 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5861 'priority priority 'org-category category
5862 'org-category-position category-pos
5863 'level level
5864 'type "closed" 'date date
5865 'undone-face 'org-warning 'done-face 'org-agenda-done)
5866 (push txt ee))
5867 (goto-char (point-at-eol))))
5868 (nreverse ee)))
5870 (defun org-agenda-show-clocking-issues ()
5871 "Add overlays, showing issues with clocking.
5872 See also the user option `org-agenda-clock-consistency-checks'."
5873 (interactive)
5874 (let* ((org-time-clocksum-use-effort-durations nil)
5875 (pl org-agenda-clock-consistency-checks)
5876 (re (concat "^[ \t]*"
5877 org-clock-string
5878 "[ \t]+"
5879 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5880 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5881 (tlstart 0.)
5882 (tlend 0.)
5883 (maxtime (org-hh:mm-string-to-minutes
5884 (or (plist-get pl :max-duration) "24:00")))
5885 (mintime (org-hh:mm-string-to-minutes
5886 (or (plist-get pl :min-duration) 0)))
5887 (maxgap (org-hh:mm-string-to-minutes
5888 ;; default 30:00 means never complain
5889 (or (plist-get pl :max-gap) "30:00")))
5890 (gapok (mapcar 'org-hh:mm-string-to-minutes
5891 (plist-get pl :gap-ok-around)))
5892 (def-face (or (plist-get pl :default-face)
5893 '((:background "DarkRed") (:foreground "white"))))
5894 issue face m te ts dt ov)
5895 (goto-char (point-min))
5896 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5897 (setq issue nil face def-face)
5898 (catch 'next
5899 (setq m (org-get-at-bol 'org-marker)
5900 te nil ts nil)
5901 (unless (and m (markerp m))
5902 (setq issue "No valid clock line") (throw 'next t))
5903 (org-with-point-at m
5904 (save-excursion
5905 (goto-char (point-at-bol))
5906 (unless (looking-at re)
5907 (error "No valid Clock line")
5908 (throw 'next t))
5909 (unless (match-end 3)
5910 (setq issue "No end time"
5911 face (or (plist-get pl :no-end-time-face) face))
5912 (throw 'next t))
5913 (setq ts (match-string 1)
5914 te (match-string 3)
5915 ts (float-time
5916 (apply 'encode-time (org-parse-time-string ts)))
5917 te (float-time
5918 (apply 'encode-time (org-parse-time-string te)))
5919 dt (- te ts))))
5920 (cond
5921 ((> dt (* 60 maxtime))
5922 ;; a very long clocking chunk
5923 (setq issue (format "Clocking interval is very long: %s"
5924 (org-minutes-to-clocksum-string
5925 (floor (/ (float dt) 60.))))
5926 face (or (plist-get pl :long-face) face)))
5927 ((< dt (* 60 mintime))
5928 ;; a very short clocking chunk
5929 (setq issue (format "Clocking interval is very short: %s"
5930 (org-minutes-to-clocksum-string
5931 (floor (/ (float dt) 60.))))
5932 face (or (plist-get pl :short-face) face)))
5933 ((and (> tlend 0) (< ts tlend))
5934 ;; Two clock entries are overlapping
5935 (setq issue (format "Clocking overlap: %d minutes"
5936 (/ (- tlend ts) 60))
5937 face (or (plist-get pl :overlap-face) face)))
5938 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5939 ;; There is a gap, lets see if we need to report it
5940 (unless (org-agenda-check-clock-gap tlend ts gapok)
5941 (setq issue (format "Clocking gap: %d minutes"
5942 (/ (- ts tlend) 60))
5943 face (or (plist-get pl :gap-face) face))))
5944 (t nil)))
5945 (setq tlend (or te tlend) tlstart (or ts tlstart))
5946 (when issue
5947 ;; OK, there was some issue, add an overlay to show the issue
5948 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5949 (overlay-put ov 'before-string
5950 (concat
5951 (org-add-props
5952 (format "%-43s" (concat " " issue))
5954 'face face)
5955 "\n"))
5956 (overlay-put ov 'evaporate t)))))
5958 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5959 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5960 (catch 'exit
5961 (unless ok-list
5962 ;; there are no OK times for gaps...
5963 (throw 'exit nil))
5964 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5965 ;; This is more than 24 hours, so it is OK.
5966 ;; because we have at least one OK time, that must be in the
5967 ;; 24 hour interval.
5968 (throw 'exit t))
5969 ;; We have a shorter gap.
5970 ;; Now we have to get the minute of the day when these times are
5971 (let* ((t1dec (decode-time (seconds-to-time t1)))
5972 (t2dec (decode-time (seconds-to-time t2)))
5973 ;; compute the minute on the day
5974 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5975 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5976 (when (< min2 min1)
5977 ;; if min2 is smaller than min1, this means it is on the next day.
5978 ;; Wrap it to after midnight.
5979 (setq min2 (+ min2 1440)))
5980 ;; Now check if any of the OK times is in the gap
5981 (mapc (lambda (x)
5982 ;; Wrap the time to after midnight if necessary
5983 (if (< x min1) (setq x (+ x 1440)))
5984 ;; Check if in interval
5985 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5986 ok-list)
5987 ;; Nope, this gap is not OK
5988 nil)))
5990 (defun org-agenda-get-deadlines (&optional with-hour)
5991 "Return the deadline information for agenda display.
5992 When WITH-HOUR is non-nil, only return deadlines with an hour
5993 specification like [h]h:mm."
5994 (let* ((props (list 'mouse-face 'highlight
5995 'org-not-done-regexp org-not-done-regexp
5996 'org-todo-regexp org-todo-regexp
5997 'org-complex-heading-regexp org-complex-heading-regexp
5998 'help-echo
5999 (format "mouse-2 or RET jump to org file %s"
6000 (abbreviate-file-name buffer-file-name))))
6001 (regexp (if with-hour
6002 org-deadline-time-hour-regexp
6003 org-deadline-time-regexp))
6004 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6005 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6006 (dl0 (car org-agenda-deadline-leaders))
6007 (dl1 (nth 1 org-agenda-deadline-leaders))
6008 (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
6009 d2 diff dfrac wdays pos pos1 category category-pos level
6010 tags suppress-prewarning ee txt head face s todo-state
6011 show-all upcomingp donep timestr warntime inherited-tags ts-date)
6012 (goto-char (point-min))
6013 (while (re-search-forward regexp nil t)
6014 (catch :skip
6015 (org-agenda-skip)
6016 (setq s (match-string 1)
6017 txt nil
6018 pos (1- (match-beginning 1))
6019 todo-state (save-match-data (org-get-todo-state))
6020 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6021 (member todo-state
6022 org-agenda-repeating-timestamp-show-all))
6023 d2 (org-time-string-to-absolute
6024 s d1 'past show-all (current-buffer) pos)
6025 diff (- d2 d1))
6026 (setq suppress-prewarning
6027 (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
6028 (let ((item (buffer-substring (point-at-bol)
6029 (point-at-eol))))
6030 (save-match-data
6031 (and (string-match
6032 org-scheduled-time-regexp item)
6033 (match-string 1 item)))))))
6034 (cond
6035 ((not ds) nil)
6036 ;; The current item has a scheduled date (in ds), so
6037 ;; evaluate its prewarning lead time.
6038 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6039 ;; Use global prewarning-restart lead time.
6040 org-agenda-skip-deadline-prewarning-if-scheduled)
6041 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6042 'pre-scheduled)
6043 ;; Set prewarning to no earlier than scheduled.
6044 (min (- d2 (org-time-string-to-absolute
6045 ds d1 'past show-all (current-buffer) pos))
6046 org-deadline-warning-days))
6047 ;; Set prewarning to deadline.
6048 (t 0))))
6049 (setq wdays (if suppress-prewarning
6050 (let ((org-deadline-warning-days suppress-prewarning))
6051 (org-get-wdays s))
6052 (org-get-wdays s))
6053 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
6054 upcomingp (and todayp (> diff 0)))
6055 ;; When to show a deadline in the calendar:
6056 ;; If the expiration is within wdays warning time.
6057 ;; Past-due deadlines are only shown on the current date
6058 (if (and (or (and (<= diff wdays)
6059 (and todayp (not org-agenda-only-exact-dates)))
6060 (= diff 0)))
6061 (save-excursion
6062 ;; (setq todo-state (org-get-todo-state))
6063 (setq donep (member todo-state org-done-keywords))
6064 (if (and donep
6065 (or org-agenda-skip-deadline-if-done
6066 (not (= diff 0))))
6067 (setq txt nil)
6068 (setq category (org-get-category)
6069 warntime (get-text-property (point) 'org-appt-warntime)
6070 category-pos (get-text-property (point) 'org-category-position))
6071 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6072 (throw :skip nil)
6073 (goto-char (match-end 0))
6074 (setq pos1 (match-beginning 0))
6075 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6076 (setq inherited-tags
6077 (or (eq org-agenda-show-inherited-tags 'always)
6078 (and (listp org-agenda-show-inherited-tags)
6079 (memq 'agenda org-agenda-show-inherited-tags))
6080 (and (eq org-agenda-show-inherited-tags t)
6081 (or (eq org-agenda-use-tag-inheritance t)
6082 (memq 'agenda org-agenda-use-tag-inheritance))))
6083 tags (org-get-tags-at pos1 (not inherited-tags)))
6084 (setq head (buffer-substring
6085 (point)
6086 (progn (skip-chars-forward "^\r\n")
6087 (point))))
6088 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6089 (setq timestr
6090 (concat (substring s (match-beginning 1)) " "))
6091 (setq timestr 'time))
6092 (setq txt (org-agenda-format-item
6093 (cond ((= diff 0) dl0)
6094 ((> diff 0)
6095 (if (functionp dl1)
6096 (funcall dl1 diff date)
6097 (format dl1 diff)))
6099 (if (functionp dl2)
6100 (funcall dl2 diff date)
6101 (format dl2 (if (string= dl2 dl1)
6102 diff (abs diff))))))
6103 head level category tags
6104 (if (not (= diff 0)) nil timestr)))))
6105 (when txt
6106 (setq face (org-agenda-deadline-face dfrac))
6107 (org-add-props txt props
6108 'org-marker (org-agenda-new-marker pos)
6109 'warntime warntime
6110 'level level
6111 'ts-date d2
6112 'org-hd-marker (org-agenda-new-marker pos1)
6113 'priority (+ (- diff)
6114 (org-get-priority txt))
6115 'org-category category
6116 'org-category-position category-pos
6117 'todo-state todo-state
6118 'type (if upcomingp "upcoming-deadline" "deadline")
6119 'date (if upcomingp date d2)
6120 'face (if donep 'org-agenda-done face)
6121 'undone-face face 'done-face 'org-agenda-done)
6122 (push txt ee))))))
6123 (nreverse ee)))
6125 (defun org-agenda-deadline-face (fraction)
6126 "Return the face to displaying a deadline item.
6127 FRACTION is what fraction of the head-warning time has passed."
6128 (let ((faces org-agenda-deadline-faces) f)
6129 (catch 'exit
6130 (while (setq f (pop faces))
6131 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6133 (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
6134 "Return the scheduled information for agenda display.
6135 When WITH-HOUR is non-nil, only return scheduled items with
6136 an hour specification like [h]h:mm."
6137 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6138 'org-todo-regexp org-todo-regexp
6139 'org-complex-heading-regexp org-complex-heading-regexp
6140 'done-face 'org-agenda-done
6141 'mouse-face 'highlight
6142 'help-echo
6143 (format "mouse-2 or RET jump to org file %s"
6144 (abbreviate-file-name buffer-file-name))))
6145 (regexp (if with-hour
6146 org-scheduled-time-hour-regexp
6147 org-scheduled-time-regexp))
6148 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6149 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6151 (deadline-position-alist
6152 (mapcar (lambda (a) (and (setq mm (get-text-property
6153 0 'org-hd-marker a))
6154 (cons (marker-position mm) a)))
6155 deadline-results))
6156 d2 diff pos pos1 category category-pos level tags donep
6157 ee txt head pastschedp todo-state face timestr s habitp show-all
6158 did-habit-check-p warntime inherited-tags ts-date suppress-delay
6159 ddays)
6160 (goto-char (point-min))
6161 (while (re-search-forward regexp nil t)
6162 (catch :skip
6163 (org-agenda-skip)
6164 (setq s (match-string 1)
6165 txt nil
6166 pos (1- (match-beginning 1))
6167 todo-state (save-match-data (org-get-todo-state))
6168 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6169 (member todo-state
6170 org-agenda-repeating-timestamp-show-all))
6171 d2 (org-time-string-to-absolute
6172 s d1 'past show-all (current-buffer) pos)
6173 diff (- d2 d1)
6174 warntime (get-text-property (point) 'org-appt-warntime))
6175 (setq pastschedp (and todayp (< diff 0)))
6176 (setq did-habit-check-p nil)
6177 (setq suppress-delay
6178 (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
6179 (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
6180 (save-match-data
6181 (and (string-match
6182 org-deadline-time-regexp item)
6183 (match-string 1 item)))))))
6184 (cond
6185 ((not ds) nil)
6186 ;; The current item has a deadline date (in ds), so
6187 ;; evaluate its delay time.
6188 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6189 ;; Use global delay time.
6190 (- org-agenda-skip-scheduled-delay-if-deadline))
6191 ((eq org-agenda-skip-scheduled-delay-if-deadline
6192 'post-deadline)
6193 ;; Set delay to no later than deadline.
6194 (min (- d2 (org-time-string-to-absolute
6195 ds d1 'past show-all (current-buffer) pos))
6196 org-scheduled-delay-days))
6197 (t 0))))
6198 (setq ddays (if suppress-delay
6199 (let ((org-scheduled-delay-days suppress-delay))
6200 (org-get-wdays s t t))
6201 (org-get-wdays s t)))
6202 ;; Use a delay of 0 when there is a repeater and the delay is
6203 ;; of the form --3d
6204 (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6205 (< (org-time-string-to-absolute s)
6206 (org-time-string-to-absolute
6207 s d2 'past nil (current-buffer) pos)))
6208 (setq ddays 0))
6209 ;; When to show a scheduled item in the calendar:
6210 ;; If it is on or past the date.
6211 (when (or (and (> ddays 0) (= diff (- ddays)))
6212 (and (zerop ddays) (= diff 0))
6213 (and (< (+ diff ddays) 0)
6214 (< (abs diff) org-scheduled-past-days)
6215 (and todayp (not org-agenda-only-exact-dates)))
6216 ;; org-is-habit-p uses org-entry-get, which is expansive
6217 ;; so we go extra mile to only call it once
6218 (and todayp
6219 (boundp 'org-habit-show-all-today)
6220 org-habit-show-all-today
6221 (setq did-habit-check-p t)
6222 (setq habitp (and (functionp 'org-is-habit-p)
6223 (org-is-habit-p)))))
6224 (save-excursion
6225 (setq donep (member todo-state org-done-keywords))
6226 (if (and donep
6227 (or org-agenda-skip-scheduled-if-done
6228 (not (= diff 0))
6229 (and (functionp 'org-is-habit-p)
6230 (org-is-habit-p))))
6231 (setq txt nil)
6232 (setq habitp (if did-habit-check-p habitp
6233 (and (functionp 'org-is-habit-p)
6234 (org-is-habit-p))))
6235 (setq category (org-get-category)
6236 category-pos (get-text-property (point) 'org-category-position))
6237 (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
6238 'repeated-after-deadline)
6239 (org-get-deadline-time (point))
6240 (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
6241 (throw :skip nil))
6242 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6243 (throw :skip nil)
6244 (goto-char (match-end 0))
6245 (setq pos1 (match-beginning 0))
6246 (if habitp
6247 (if (or (not org-habit-show-habits)
6248 (and (not todayp)
6249 (boundp 'org-habit-show-habits-only-for-today)
6250 org-habit-show-habits-only-for-today))
6251 (throw :skip nil))
6252 (if (and
6253 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
6254 (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
6255 pastschedp))
6256 (setq mm (assoc pos1 deadline-position-alist)))
6257 (throw :skip nil)))
6258 (setq inherited-tags
6259 (or (eq org-agenda-show-inherited-tags 'always)
6260 (and (listp org-agenda-show-inherited-tags)
6261 (memq 'agenda org-agenda-show-inherited-tags))
6262 (and (eq org-agenda-show-inherited-tags t)
6263 (or (eq org-agenda-use-tag-inheritance t)
6264 (memq 'agenda org-agenda-use-tag-inheritance))))
6266 tags (org-get-tags-at nil (not inherited-tags)))
6267 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6268 (setq head (buffer-substring
6269 (point)
6270 (progn (skip-chars-forward "^\r\n") (point))))
6271 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6272 (setq timestr
6273 (concat (substring s (match-beginning 1)) " "))
6274 (setq timestr 'time))
6275 (setq txt (org-agenda-format-item
6276 (if (= diff 0)
6277 (car org-agenda-scheduled-leaders)
6278 (format (nth 1 org-agenda-scheduled-leaders)
6279 (- 1 diff)))
6280 head level category tags
6281 (if (not (= diff 0)) nil timestr)
6282 nil habitp))))
6283 (when txt
6284 (setq face
6285 (cond
6286 ((and (not habitp) pastschedp)
6287 'org-scheduled-previously)
6288 (todayp 'org-scheduled-today)
6289 (t 'org-scheduled))
6290 habitp (and habitp (org-habit-parse-todo)))
6291 (org-add-props txt props
6292 'undone-face face
6293 'face (if donep 'org-agenda-done face)
6294 'org-marker (org-agenda-new-marker pos)
6295 'org-hd-marker (org-agenda-new-marker pos1)
6296 'type (if pastschedp "past-scheduled" "scheduled")
6297 'date (if pastschedp d2 date)
6298 'ts-date d2
6299 'warntime warntime
6300 'level level
6301 'priority (if habitp
6302 (org-habit-get-priority habitp)
6303 (+ 94 (- 5 diff) (org-get-priority txt)))
6304 'org-category category
6305 'category-position category-pos
6306 'org-habit-p habitp
6307 'todo-state todo-state)
6308 (push txt ee))))))
6309 (nreverse ee)))
6311 (defun org-agenda-get-blocks ()
6312 "Return the date-range information for agenda display."
6313 (let* ((props (list 'face nil
6314 'org-not-done-regexp org-not-done-regexp
6315 'org-todo-regexp org-todo-regexp
6316 'org-complex-heading-regexp org-complex-heading-regexp
6317 'mouse-face 'highlight
6318 'help-echo
6319 (format "mouse-2 or RET jump to org file %s"
6320 (abbreviate-file-name buffer-file-name))))
6321 (regexp org-tr-regexp)
6322 (d0 (calendar-absolute-from-gregorian date))
6323 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
6324 level todo-state tags pos head donep inherited-tags)
6325 (goto-char (point-min))
6326 (while (re-search-forward regexp nil t)
6327 (catch :skip
6328 (org-agenda-skip)
6329 (setq pos (point))
6330 (let ((start-time (match-string 1))
6331 (end-time (match-string 2)))
6332 (setq s1 (match-string 1)
6333 s2 (match-string 2)
6334 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6335 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6336 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6337 ;; Only allow days between the limits, because the normal
6338 ;; date stamps will catch the limits.
6339 (save-excursion
6340 (setq todo-state (org-get-todo-state))
6341 (setq donep (member todo-state org-done-keywords))
6342 (if (and donep org-agenda-skip-timestamp-if-done)
6343 (throw :skip t))
6344 (setq marker (org-agenda-new-marker (point)))
6345 (setq category (org-get-category)
6346 category-pos (get-text-property (point) 'org-category-position))
6347 (if (not (re-search-backward org-outline-regexp-bol nil t))
6348 (throw :skip nil)
6349 (goto-char (match-beginning 0))
6350 (setq hdmarker (org-agenda-new-marker (point))
6351 inherited-tags
6352 (or (eq org-agenda-show-inherited-tags 'always)
6353 (and (listp org-agenda-show-inherited-tags)
6354 (memq 'agenda org-agenda-show-inherited-tags))
6355 (and (eq org-agenda-show-inherited-tags t)
6356 (or (eq org-agenda-use-tag-inheritance t)
6357 (memq 'agenda org-agenda-use-tag-inheritance))))
6359 tags (org-get-tags-at nil (not inherited-tags)))
6360 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6361 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6362 (setq head (match-string 1))
6363 (let ((remove-re
6364 (if org-agenda-remove-timeranges-from-blocks
6365 (concat
6366 "<" (regexp-quote s1) ".*?>"
6367 "--"
6368 "<" (regexp-quote s2) ".*?>")
6369 nil)))
6370 (setq txt (org-agenda-format-item
6371 (format
6372 (nth (if (= d1 d2) 0 1)
6373 org-agenda-timerange-leaders)
6374 (1+ (- d0 d1)) (1+ (- d2 d1)))
6375 head level category tags
6376 (cond ((and (= d1 d0) (= d2 d0))
6377 (concat "<" start-time ">--<" end-time ">"))
6378 ((= d1 d0)
6379 (concat "<" start-time ">"))
6380 ((= d2 d0)
6381 (concat "<" end-time ">")))
6382 remove-re))))
6383 (org-add-props txt props
6384 'org-marker marker 'org-hd-marker hdmarker
6385 'type "block" 'date date
6386 'level level
6387 'todo-state todo-state
6388 'priority (org-get-priority txt) 'org-category category
6389 'org-category-position category-pos)
6390 (push txt ee))))
6391 (goto-char pos)))
6392 ;; Sort the entries by expiration date.
6393 (nreverse ee)))
6395 ;;; Agenda presentation and sorting
6397 (defvar org-prefix-has-time nil
6398 "A flag, set by `org-compile-prefix-format'.
6399 The flag is set if the currently compiled format contains a `%t'.")
6400 (defvar org-prefix-has-tag nil
6401 "A flag, set by `org-compile-prefix-format'.
6402 The flag is set if the currently compiled format contains a `%T'.")
6403 (defvar org-prefix-has-effort nil
6404 "A flag, set by `org-compile-prefix-format'.
6405 The flag is set if the currently compiled format contains a `%e'.")
6406 (defvar org-prefix-has-breadcrumbs nil
6407 "A flag, set by `org-compile-prefix-format'.
6408 The flag is set if the currently compiled format contains a `%b'.")
6409 (defvar org-prefix-category-length nil
6410 "Used by `org-compile-prefix-format' to remember the category field width.")
6411 (defvar org-prefix-category-max-length nil
6412 "Used by `org-compile-prefix-format' to remember the category field width.")
6414 (defun org-agenda-get-category-icon (category)
6415 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6416 (dolist (entry org-agenda-category-icon-alist)
6417 (when (org-string-match-p (car entry) category)
6418 (if (listp (cadr entry))
6419 (return (cadr entry))
6420 (return (apply 'create-image (cdr entry)))))))
6422 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6423 remove-re habitp)
6424 "Format TXT to be inserted into the agenda buffer.
6425 In particular, add the prefix and corresponding text properties.
6427 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6428 LEVEL may be a string to replace the `%l' specifier.
6429 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6430 category taken from local variable or file name. It will replace the `%c'
6431 specifier in the format.
6432 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6433 TXT for sorting of this entry, and for the `%t' specifier in the format.
6434 When DOTIME is a string, this string is searched for a time before TXT is.
6435 TAGS can be the tags of the headline.
6436 Any match of REMOVE-RE will be removed from TXT."
6437 ;; We keep the org-prefix-* variable values along with a compiled
6438 ;; formatter, so that multiple agendas existing at the same time do
6439 ;; not step on each other toes.
6441 ;; It was inconvenient to make these variables buffer local in
6442 ;; Agenda buffers, because this function expects to be called with
6443 ;; the buffer where item comes from being current, and not agenda
6444 ;; buffer
6445 (let* ((bindings (car org-prefix-format-compiled))
6446 (formatter (cadr org-prefix-format-compiled)))
6447 (loop for (var value) in bindings
6448 do (set var value))
6449 (save-match-data
6450 ;; Diary entries sometimes have extra whitespace at the beginning
6451 (setq txt (org-trim txt))
6453 ;; Fix the tags part in txt
6454 (setq txt (org-agenda-fix-displayed-tags
6455 txt tags
6456 org-agenda-show-inherited-tags
6457 org-agenda-hide-tags-regexp))
6459 (let* ((category (or category
6460 (if (stringp org-category)
6461 org-category
6462 (and org-category (symbol-name org-category)))
6463 (if buffer-file-name
6464 (file-name-sans-extension
6465 (file-name-nondirectory buffer-file-name))
6466 "")))
6467 (category-icon (org-agenda-get-category-icon category))
6468 (category-icon (if category-icon
6469 (propertize " " 'display category-icon)
6470 ""))
6471 ;; time, tag, effort are needed for the eval of the prefix format
6472 (tag (if tags (nth (1- (length tags)) tags) ""))
6473 time effort neffort
6474 (ts (if dotime (concat
6475 (if (stringp dotime) dotime "")
6476 (and org-agenda-search-headline-for-time txt))))
6477 (time-of-day (and dotime (org-get-time-of-day ts)))
6478 stamp plain s0 s1 s2 rtn srp l
6479 duration thecategory breadcrumbs)
6480 (and (derived-mode-p 'org-mode) buffer-file-name
6481 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6482 (when (and dotime time-of-day)
6483 ;; Extract starting and ending time and move them to prefix
6484 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6485 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6486 (setq s0 (match-string 0 ts)
6487 srp (and stamp (match-end 3))
6488 s1 (match-string (if plain 1 2) ts)
6489 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6491 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6492 ;; them, we might want to remove them there to avoid duplication.
6493 ;; The user can turn this off with a variable.
6494 (if (and org-prefix-has-time
6495 org-agenda-remove-times-when-in-prefix (or stamp plain)
6496 (string-match (concat (regexp-quote s0) " *") txt)
6497 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6498 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6499 (= (match-beginning 0) 0)
6501 (setq txt (replace-match "" nil nil txt))))
6502 ;; Normalize the time(s) to 24 hour
6503 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6504 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6506 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6507 (let (org-time-clocksum-use-effort-durations)
6508 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6509 (setq s2
6510 (org-minutes-to-clocksum-string
6511 (+ (org-hh:mm-string-to-minutes s1)
6512 org-agenda-default-appointment-duration)))))
6514 ;; Compute the duration
6515 (when s2
6516 (setq duration (- (org-hh:mm-string-to-minutes s2)
6517 (org-hh:mm-string-to-minutes s1)))))
6519 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6520 txt)
6521 ;; Tags are in the string
6522 (if (or (eq org-agenda-remove-tags t)
6523 (and org-agenda-remove-tags
6524 org-prefix-has-tag))
6525 (setq txt (replace-match "" t t txt))
6526 (setq txt (replace-match
6527 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6528 (match-string 2 txt))
6529 t t txt))))
6530 (when (derived-mode-p 'org-mode)
6531 (setq effort (ignore-errors (get-text-property 0 'org-effort txt))))
6533 ;; org-agenda-add-time-grid-maybe calls us with *Agenda* as
6534 ;; current buffer, so move this check outside of above
6535 (if effort
6536 (setq neffort (org-duration-string-to-minutes effort)
6537 effort (setq effort (concat "[" effort "]")))
6538 ;; prevent erroring out with %e format when there is no effort
6539 (setq effort ""))
6541 (when remove-re
6542 (while (string-match remove-re txt)
6543 (setq txt (replace-match "" t t txt))))
6545 ;; Set org-heading property on `txt' to mark the start of the
6546 ;; heading.
6547 (add-text-properties 0 (length txt) '(org-heading t) txt)
6549 ;; Prepare the variables needed in the eval of the compiled format
6550 (if org-prefix-has-breadcrumbs
6551 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6552 (let ((s (org-display-outline-path nil nil "->" t)))
6553 (if (eq "" s) "" (concat s "->"))))))
6554 (setq time (cond (s2 (concat
6555 (org-agenda-time-of-day-to-ampm-maybe s1)
6556 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6557 (if org-agenda-timegrid-use-ampm " ")))
6558 (s1 (concat
6559 (org-agenda-time-of-day-to-ampm-maybe s1)
6560 (if org-agenda-timegrid-use-ampm
6561 "........ "
6562 "......")))
6563 (t ""))
6564 extra (or (and (not habitp) extra) "")
6565 category (if (symbolp category) (symbol-name category) category)
6566 thecategory (copy-sequence category)
6567 level (or level ""))
6568 (if (string-match org-bracket-link-regexp category)
6569 (progn
6570 (setq l (if (match-end 3)
6571 (- (match-end 3) (match-beginning 3))
6572 (- (match-end 1) (match-beginning 1))))
6573 (when (< l (or org-prefix-category-length 0))
6574 (setq category (copy-sequence category))
6575 (org-add-props category nil
6576 'extra-space (make-string
6577 (- org-prefix-category-length l 1) ?\ ))))
6578 (if (and org-prefix-category-max-length
6579 (>= (length category) org-prefix-category-max-length))
6580 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6581 ;; Evaluate the compiled format
6582 (setq rtn (concat (eval formatter) txt))
6584 ;; And finally add the text properties
6585 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6586 (org-add-props rtn nil
6587 'org-category (if thecategory (downcase thecategory) category)
6588 'tags (mapcar 'org-downcase-keep-props tags)
6589 'org-highest-priority org-highest-priority
6590 'org-lowest-priority org-lowest-priority
6591 'time-of-day time-of-day
6592 'duration duration
6593 'effort effort
6594 'effort-minutes neffort
6595 'breadcrumbs breadcrumbs
6596 'txt txt
6597 'level level
6598 'time time
6599 'extra extra
6600 'format org-prefix-format-compiled
6601 'dotime dotime)))))
6603 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6604 "Remove tags string from TXT, and add a modified list of tags.
6605 The modified list may contain inherited tags, and tags matched by
6606 `org-agenda-hide-tags-regexp' will be removed."
6607 (when (or add-inherited hide-re)
6608 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6609 (setq txt (substring txt 0 (match-beginning 0))))
6610 (setq tags
6611 (delq nil
6612 (mapcar (lambda (tg)
6613 (if (or (and hide-re (string-match hide-re tg))
6614 (and (not add-inherited)
6615 (get-text-property 0 'inherited tg)))
6617 tg))
6618 tags)))
6619 (when tags
6620 (let ((have-i (get-text-property 0 'inherited (car tags)))
6622 (setq txt (concat txt " :"
6623 (mapconcat
6624 (lambda (x)
6625 (setq i (get-text-property 0 'inherited x))
6626 (if (and have-i (not i))
6627 (progn
6628 (setq have-i nil)
6629 (concat ":" x))
6631 tags ":")
6632 (if have-i "::" ":"))))))
6633 txt)
6635 (defun org-downcase-keep-props (s)
6636 (let ((props (text-properties-at 0 s)))
6637 (setq s (downcase s))
6638 (add-text-properties 0 (length s) props s)
6641 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6643 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6644 "Add a time-grid for agenda items which need it.
6646 LIST is the list of agenda items formatted by `org-agenda-list'.
6647 NDAYS is the span of the current agenda view.
6648 TODAYP is t when the current agenda view is on today."
6649 (catch 'exit
6650 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6651 ((and todayp (member 'today (car org-agenda-time-grid))))
6652 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6653 ((member 'weekly (car org-agenda-time-grid)))
6654 (t (throw 'exit list)))
6655 (let* ((have (delq nil (mapcar
6656 (lambda (x) (get-text-property 1 'time-of-day x))
6657 list)))
6658 (string (nth 1 org-agenda-time-grid))
6659 (gridtimes (nth 2 org-agenda-time-grid))
6660 (req (car org-agenda-time-grid))
6661 (remove (member 'remove-match req))
6662 new time)
6663 (if (and (member 'require-timed req) (not have))
6664 ;; don't show empty grid
6665 (throw 'exit list))
6666 (while (setq time (pop gridtimes))
6667 (unless (and remove (member time have))
6668 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6669 (push (org-agenda-format-item
6670 nil string nil "" nil
6671 (concat (substring time 0 -2) ":" (substring time -2)))
6672 new)
6673 (put-text-property
6674 2 (length (car new)) 'face 'org-time-grid (car new))))
6675 (when (and todayp org-agenda-show-current-time-in-grid)
6676 (push (org-agenda-format-item
6677 nil org-agenda-current-time-string nil "" nil
6678 (format-time-string "%H:%M "))
6679 new)
6680 (put-text-property
6681 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6683 (if (member 'time-up org-agenda-sorting-strategy-selected)
6684 (append new list)
6685 (append list new)))))
6687 (defun org-compile-prefix-format (key)
6688 "Compile the prefix format into a Lisp form that can be evaluated.
6689 The resulting form and associated variable bindings is returned
6690 and stored in the variable `org-prefix-format-compiled'."
6691 (setq org-prefix-has-time nil
6692 org-prefix-has-tag nil
6693 org-prefix-category-length nil
6694 org-prefix-has-effort nil
6695 org-prefix-has-breadcrumbs nil)
6696 (let ((s (cond
6697 ((stringp org-agenda-prefix-format)
6698 org-agenda-prefix-format)
6699 ((assq key org-agenda-prefix-format)
6700 (cdr (assq key org-agenda-prefix-format)))
6701 (t " %-12:c%?-12t% s")))
6702 (start 0)
6703 varform vars var e c f opt)
6704 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6705 s start)
6706 (setq var (or (cdr (assoc (match-string 4 s)
6707 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6708 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6709 'eval)
6710 c (or (match-string 3 s) "")
6711 opt (match-beginning 1)
6712 start (1+ (match-beginning 0)))
6713 (if (equal var 'time) (setq org-prefix-has-time t))
6714 (if (equal var 'tag) (setq org-prefix-has-tag t))
6715 (if (equal var 'effort) (setq org-prefix-has-effort t))
6716 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6717 (setq f (concat "%" (match-string 2 s) "s"))
6718 (when (equal var 'category)
6719 (setq org-prefix-category-length
6720 (floor (abs (string-to-number (match-string 2 s)))))
6721 (setq org-prefix-category-max-length
6722 (let ((x (match-string 2 s)))
6723 (save-match-data
6724 (if (string-match "\\.[0-9]+" x)
6725 (string-to-number (substring (match-string 0 x) 1)))))))
6726 (if (eq var 'eval)
6727 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6728 (if opt
6729 (setq varform
6730 `(if (equal "" ,var)
6732 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6733 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6734 (setq s (replace-match "%s" t nil s))
6735 (push varform vars))
6736 (setq vars (nreverse vars))
6737 (with-current-buffer (or org-agenda-buffer (current-buffer))
6738 (setq org-prefix-format-compiled
6739 (list
6740 `((org-prefix-has-time ,org-prefix-has-time)
6741 (org-prefix-has-tag ,org-prefix-has-tag)
6742 (org-prefix-category-length ,org-prefix-category-length)
6743 (org-prefix-has-effort ,org-prefix-has-effort)
6744 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6745 `(format ,s ,@vars))))))
6747 (defun org-set-sorting-strategy (key)
6748 (if (symbolp (car org-agenda-sorting-strategy))
6749 ;; the old format
6750 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6751 (setq org-agenda-sorting-strategy-selected
6752 (or (cdr (assq key org-agenda-sorting-strategy))
6753 (cdr (assq 'agenda org-agenda-sorting-strategy))
6754 '(time-up category-keep priority-down)))))
6756 (defun org-get-time-of-day (s &optional string mod24)
6757 "Check string S for a time of day.
6758 If found, return it as a military time number between 0 and 2400.
6759 If not found, return nil.
6760 The optional STRING argument forces conversion into a 5 character wide string
6761 HH:MM."
6762 (save-match-data
6763 (when
6764 (and
6765 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6766 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6767 (not (eq (get-text-property 1 'face s) 'org-link)))
6768 (let* ((h (string-to-number (match-string 1 s)))
6769 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6770 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6771 (am-p (equal ampm "am"))
6772 (h1 (cond ((not ampm) h)
6773 ((= h 12) (if am-p 0 12))
6774 (t (+ h (if am-p 0 12)))))
6775 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6776 (mod h1 24) h1))
6777 (t0 (+ (* 100 h2) m))
6778 (t1 (concat (if (>= h1 24) "+" " ")
6779 (if (and org-agenda-time-leading-zero
6780 (< t0 1000)) "0" "")
6781 (if (< t0 100) "0" "")
6782 (if (< t0 10) "0" "")
6783 (int-to-string t0))))
6784 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6786 (defvar org-agenda-before-sorting-filter-function nil
6787 "Function to be applied to agenda items prior to sorting.
6788 Prior to sorting also means just before they are inserted into the agenda.
6790 To aid sorting, you may revisit the original entries and add more text
6791 properties which will later be used by the sorting functions.
6793 The function should take a string argument, an agenda line.
6794 It has access to the text properties in that line, which contain among
6795 other things, the property `org-hd-marker' that points to the entry
6796 where the line comes from. Note that not all lines going into the agenda
6797 have this property, only most.
6799 The function should return the modified string. It is probably best
6800 to ONLY change text properties.
6802 You can also use this function as a filter, by returning nil for lines
6803 you don't want to have in the agenda at all. For this application, you
6804 could bind the variable in the options section of a custom command.")
6806 (defun org-agenda-finalize-entries (list &optional type)
6807 "Sort, limit and concatenate the LIST of agenda items.
6808 The optional argument TYPE tells the agenda type."
6809 (let ((max-effort (cond ((listp org-agenda-max-effort)
6810 (cdr (assoc type org-agenda-max-effort)))
6811 (t org-agenda-max-effort)))
6812 (max-todo (cond ((listp org-agenda-max-todos)
6813 (cdr (assoc type org-agenda-max-todos)))
6814 (t org-agenda-max-todos)))
6815 (max-tags (cond ((listp org-agenda-max-tags)
6816 (cdr (assoc type org-agenda-max-tags)))
6817 (t org-agenda-max-tags)))
6818 (max-entries (cond ((listp org-agenda-max-entries)
6819 (cdr (assoc type org-agenda-max-entries)))
6820 (t org-agenda-max-entries))) l)
6821 (when org-agenda-before-sorting-filter-function
6822 (setq list
6823 (delq nil
6824 (mapcar
6825 org-agenda-before-sorting-filter-function list))))
6826 (setq list (mapcar 'org-agenda-highlight-todo list)
6827 list (mapcar 'identity (sort list 'org-entries-lessp)))
6828 (when max-effort
6829 (setq list (org-agenda-limit-entries
6830 list 'effort-minutes max-effort 'identity)))
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 fun (get-text-property 1 prop e))))
6849 (if pval (setq lim (+ lim pval)))
6850 (cond ((and pval (<= lim (abs limit))) e)
6851 ((and include (not pval)) e))))
6852 list)))
6853 list)))
6855 (defun org-agenda-limit-interactively ()
6856 "In agenda, interactively limit entries to various maximums."
6857 (interactive)
6858 (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
6859 (num (string-to-number (read-from-minibuffer "How many? "))))
6860 (cond ((equal max ?e)
6861 (let ((org-agenda-max-entries num)) (org-agenda-redo)))
6862 ((equal max ?t)
6863 (let ((org-agenda-max-todos num)) (org-agenda-redo)))
6864 ((equal max ?T)
6865 (let ((org-agenda-max-tags num)) (org-agenda-redo)))
6866 ((equal max ?E)
6867 (let ((org-agenda-max-effort num)) (org-agenda-redo)))))
6868 (org-agenda-fit-window-to-buffer))
6870 (defun org-agenda-highlight-todo (x)
6871 (let ((org-done-keywords org-done-keywords-for-agenda)
6872 (case-fold-search nil)
6874 (if (eq x 'line)
6875 (save-excursion
6876 (beginning-of-line 1)
6877 (setq re (org-get-at-bol 'org-todo-regexp))
6878 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6879 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6880 (add-text-properties (match-beginning 0) (match-end 1)
6881 (list 'face (org-get-todo-face 1)))
6882 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6883 (delete-region (match-beginning 1) (1- (match-end 0)))
6884 (goto-char (match-beginning 1))
6885 (insert (format org-agenda-todo-keyword-format s)))))
6886 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6887 (setq re (get-text-property 0 'org-todo-regexp x))
6888 (when (and re
6889 ;; Test `pl' because if there's no heading content,
6890 ;; there's no point matching to highlight. Note
6891 ;; that if we didn't test `pl' first, and there
6892 ;; happened to be no keyword from `org-todo-regexp'
6893 ;; on this heading line, then the `equal' comparison
6894 ;; afterwards would spuriously succeed in the case
6895 ;; where `pl' is nil -- causing an args-out-of-range
6896 ;; error when we try to add text properties to text
6897 ;; that isn't there.
6899 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6900 x pl) pl))
6901 (add-text-properties
6902 (or (match-end 1) (match-end 0)) (match-end 0)
6903 (list 'face (org-get-todo-face (match-string 2 x)))
6905 (when (match-end 1)
6906 (setq x (concat (substring x 0 (match-end 1))
6907 (format org-agenda-todo-keyword-format
6908 (match-string 2 x))
6909 (org-add-props " " (text-properties-at 0 x))
6910 (substring x (match-end 3)))))))
6911 x)))
6913 (defsubst org-cmp-priority (a b)
6914 "Compare the priorities of string A and B."
6915 (let ((pa (or (get-text-property 1 'priority a) 0))
6916 (pb (or (get-text-property 1 'priority b) 0)))
6917 (cond ((> pa pb) +1)
6918 ((< pa pb) -1))))
6920 (defsubst org-cmp-effort (a b)
6921 "Compare the effort values of string A and B."
6922 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6923 (ea (or (get-text-property 1 'effort-minutes a) def))
6924 (eb (or (get-text-property 1 'effort-minutes b) def)))
6925 (cond ((> ea eb) +1)
6926 ((< ea eb) -1))))
6928 (defsubst org-cmp-category (a b)
6929 "Compare the string values of categories of strings A and B."
6930 (let ((ca (or (get-text-property 1 'org-category a) ""))
6931 (cb (or (get-text-property 1 'org-category b) "")))
6932 (cond ((string-lessp ca cb) -1)
6933 ((string-lessp cb ca) +1))))
6935 (defsubst org-cmp-todo-state (a b)
6936 "Compare the todo states of strings A and B."
6937 (let* ((ma (or (get-text-property 1 'org-marker a)
6938 (get-text-property 1 'org-hd-marker a)))
6939 (mb (or (get-text-property 1 'org-marker b)
6940 (get-text-property 1 'org-hd-marker b)))
6941 (fa (and ma (marker-buffer ma)))
6942 (fb (and mb (marker-buffer mb)))
6943 (todo-kwds
6944 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6945 (and fb (with-current-buffer fb org-todo-keywords-1))))
6946 (ta (or (get-text-property 1 'todo-state a) ""))
6947 (tb (or (get-text-property 1 'todo-state b) ""))
6948 (la (- (length (member ta todo-kwds))))
6949 (lb (- (length (member tb todo-kwds))))
6950 (donepa (member ta org-done-keywords-for-agenda))
6951 (donepb (member tb org-done-keywords-for-agenda)))
6952 (cond ((and donepa (not donepb)) -1)
6953 ((and (not donepa) donepb) +1)
6954 ((< la lb) -1)
6955 ((< lb la) +1))))
6957 (defsubst org-cmp-alpha (a b)
6958 "Compare the headlines, alphabetically."
6959 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6960 (plb (text-property-any 0 (length b) 'org-heading t b))
6961 (ta (and pla (substring a pla)))
6962 (tb (and plb (substring b plb))))
6963 (when pla
6964 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6965 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6966 (setq ta (substring ta (match-end 0))))
6967 (setq ta (downcase ta)))
6968 (when plb
6969 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6970 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6971 (setq tb (substring tb (match-end 0))))
6972 (setq tb (downcase tb)))
6973 (cond ((not ta) +1)
6974 ((not tb) -1)
6975 ((string-lessp ta tb) -1)
6976 ((string-lessp tb ta) +1))))
6978 (defsubst org-cmp-tag (a b)
6979 "Compare the string values of the first tags of A and B."
6980 (let ((ta (car (last (get-text-property 1 'tags a))))
6981 (tb (car (last (get-text-property 1 'tags b)))))
6982 (cond ((not ta) +1)
6983 ((not tb) -1)
6984 ((string-lessp ta tb) -1)
6985 ((string-lessp tb ta) +1))))
6987 (defsubst org-cmp-time (a b)
6988 "Compare the time-of-day values of strings A and B."
6989 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6990 (ta (or (get-text-property 1 'time-of-day a) def))
6991 (tb (or (get-text-property 1 'time-of-day b) def)))
6992 (cond ((< ta tb) -1)
6993 ((< tb ta) +1))))
6995 (defsubst org-cmp-ts (a b type)
6996 "Compare the timestamps values of entries A and B.
6997 When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
6998 \"timestamp_ia\", compare within each of these type. When TYPE
6999 is the empty string, compare all timestamps without respect of
7000 their type."
7001 (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
7002 (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
7003 (get-text-property 1 'ts-date a))
7004 def))
7005 (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
7006 (get-text-property 1 'ts-date b))
7007 def)))
7008 (cond ((< ta tb) -1)
7009 ((< tb ta) +1))))
7011 (defsubst org-cmp-habit-p (a b)
7012 "Compare the todo states of strings A and B."
7013 (let ((ha (get-text-property 1 'org-habit-p a))
7014 (hb (get-text-property 1 'org-habit-p b)))
7015 (cond ((and ha (not hb)) -1)
7016 ((and (not ha) hb) +1))))
7018 (defun org-entries-lessp (a b)
7019 "Predicate for sorting agenda entries."
7020 ;; The following variables will be used when the form is evaluated.
7021 ;; So even though the compiler complains, keep them.
7022 (let* ((ss org-agenda-sorting-strategy-selected)
7023 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
7024 (org-cmp-ts a b "")))
7025 (timestamp-down (if timestamp-up (- timestamp-up) nil))
7026 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
7027 (org-cmp-ts a b "scheduled")))
7028 (scheduled-down (if scheduled-up (- scheduled-up) nil))
7029 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
7030 (org-cmp-ts a b "deadline")))
7031 (deadline-down (if deadline-up (- deadline-up) nil))
7032 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
7033 (org-cmp-ts a b "timestamp_ia")))
7034 (tsia-down (if tsia-up (- tsia-up) nil))
7035 (ts-up (and (org-em 'ts-up 'ts-down ss)
7036 (org-cmp-ts a b "timestamp")))
7037 (ts-down (if ts-up (- ts-up) nil))
7038 (time-up (and (org-em 'time-up 'time-down ss)
7039 (org-cmp-time a b)))
7040 (time-down (if time-up (- time-up) nil))
7041 (priority-up (and (org-em 'priority-up 'priority-down ss)
7042 (org-cmp-priority a b)))
7043 (priority-down (if priority-up (- priority-up) nil))
7044 (effort-up (and (org-em 'effort-up 'effort-down ss)
7045 (org-cmp-effort a b)))
7046 (effort-down (if effort-up (- effort-up) nil))
7047 (category-up (and (or (org-em 'category-up 'category-down ss)
7048 (memq 'category-keep ss))
7049 (org-cmp-category a b)))
7050 (category-down (if category-up (- category-up) nil))
7051 (category-keep (if category-up +1 nil))
7052 (tag-up (and (org-em 'tag-up 'tag-down ss)
7053 (org-cmp-tag a b)))
7054 (tag-down (if tag-up (- tag-up) nil))
7055 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
7056 (org-cmp-todo-state a b)))
7057 (todo-state-down (if todo-state-up (- todo-state-up) nil))
7058 (habit-up (and (org-em 'habit-up 'habit-down ss)
7059 (org-cmp-habit-p a b)))
7060 (habit-down (if habit-up (- habit-up) nil))
7061 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
7062 (org-cmp-alpha a b)))
7063 (alpha-down (if alpha-up (- alpha-up) nil))
7064 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
7065 user-defined-up user-defined-down)
7066 (if (and need-user-cmp org-agenda-cmp-user-defined
7067 (functionp org-agenda-cmp-user-defined))
7068 (setq user-defined-up
7069 (funcall org-agenda-cmp-user-defined a b)
7070 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7071 (cdr (assoc
7072 (eval (cons 'or org-agenda-sorting-strategy-selected))
7073 '((-1 . t) (1 . nil) (nil . nil))))))
7075 ;;; Agenda restriction lock
7077 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7078 "Overlay to mark the headline to which agenda commands are restricted.")
7079 (overlay-put org-agenda-restriction-lock-overlay
7080 'face 'org-agenda-restriction-lock)
7081 (overlay-put org-agenda-restriction-lock-overlay
7082 'help-echo "Agendas are currently limited to this subtree.")
7083 (org-detach-overlay org-agenda-restriction-lock-overlay)
7085 ;;;###autoload
7086 (defun org-agenda-set-restriction-lock (&optional type)
7087 "Set restriction lock for agenda, to current subtree or file.
7088 Restriction will be the file if TYPE is `file', or if TYPE is the
7089 universal prefix `(4)', or if the cursor is before the first headline
7090 in the file. Otherwise, restriction will be to the current subtree."
7091 (interactive "P")
7092 (and (equal type '(4)) (setq type 'file))
7093 (setq type (cond
7094 (type type)
7095 ((org-at-heading-p) 'subtree)
7096 ((condition-case nil (org-back-to-heading t) (error nil))
7097 'subtree)
7098 (t 'file)))
7099 (if (eq type 'subtree)
7100 (progn
7101 (setq org-agenda-restrict (current-buffer))
7102 (setq org-agenda-overriding-restriction 'subtree)
7103 (put 'org-agenda-files 'org-restrict
7104 (list (buffer-file-name (buffer-base-buffer))))
7105 (org-back-to-heading t)
7106 (move-overlay org-agenda-restriction-lock-overlay
7107 (point)
7108 (if org-agenda-restriction-lock-highlight-subtree
7109 (save-excursion (org-end-of-subtree t t) (point))
7110 (point-at-eol)))
7111 (move-marker org-agenda-restrict-begin (point))
7112 (move-marker org-agenda-restrict-end
7113 (save-excursion (org-end-of-subtree t t)))
7114 (message "Locking agenda restriction to subtree"))
7115 (put 'org-agenda-files 'org-restrict
7116 (list (buffer-file-name (buffer-base-buffer))))
7117 (setq org-agenda-restrict nil)
7118 (setq org-agenda-overriding-restriction 'file)
7119 (move-marker org-agenda-restrict-begin nil)
7120 (move-marker org-agenda-restrict-end nil)
7121 (message "Locking agenda restriction to file"))
7122 (setq current-prefix-arg nil)
7123 (org-agenda-maybe-redo))
7125 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7126 "Remove the agenda restriction lock."
7127 (interactive "P")
7128 (org-detach-overlay org-agenda-restriction-lock-overlay)
7129 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7130 (setq org-agenda-overriding-restriction nil)
7131 (setq org-agenda-restrict nil)
7132 (put 'org-agenda-files 'org-restrict nil)
7133 (move-marker org-agenda-restrict-begin nil)
7134 (move-marker org-agenda-restrict-end nil)
7135 (setq current-prefix-arg nil)
7136 (message "Agenda restriction lock removed")
7137 (or noupdate (org-agenda-maybe-redo)))
7139 (defun org-agenda-maybe-redo ()
7140 "If there is any window showing the agenda view, update it."
7141 (let ((w (get-buffer-window org-agenda-buffer-name t))
7142 (w0 (selected-window)))
7143 (when w
7144 (select-window w)
7145 (org-agenda-redo)
7146 (select-window w0)
7147 (if org-agenda-overriding-restriction
7148 (message "Agenda view shifted to new %s restriction"
7149 org-agenda-overriding-restriction)
7150 (message "Agenda restriction lock removed")))))
7152 ;;; Agenda commands
7154 (defun org-agenda-check-type (error &rest types)
7155 "Check if agenda buffer is of allowed type.
7156 If ERROR is non-nil, throw an error, otherwise just return nil.
7157 Allowed types are 'agenda 'timeline 'todo 'tags 'search."
7158 (if (not org-agenda-type)
7159 (error "No Org agenda currently displayed")
7160 (if (memq org-agenda-type types)
7162 (if error
7163 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7164 nil))))
7166 (defun org-agenda-Quit ()
7167 "Exit the agenda and kill buffers loaded by `org-agenda'.
7168 Also restore the window configuration."
7169 (interactive)
7170 (if org-agenda-columns-active
7171 (org-columns-quit)
7172 (let ((buf (current-buffer)))
7173 (if (eq org-agenda-window-setup 'other-frame)
7174 (progn
7175 (org-agenda-reset-markers)
7176 (kill-buffer buf)
7177 (org-columns-remove-overlays)
7178 (setq org-agenda-archives-mode nil)
7179 (delete-frame))
7180 (and (not (eq org-agenda-window-setup 'current-window))
7181 (not (one-window-p))
7182 (delete-window))
7183 (org-agenda-reset-markers)
7184 (kill-buffer buf)
7185 (org-columns-remove-overlays)
7186 (setq org-agenda-archives-mode nil)))
7187 (setq org-agenda-buffer nil)
7188 ;; Maybe restore the pre-agenda window configuration.
7189 (and org-agenda-restore-windows-after-quit
7190 (not (eq org-agenda-window-setup 'other-frame))
7191 org-agenda-pre-window-conf
7192 (set-window-configuration org-agenda-pre-window-conf)
7193 (setq org-agenda-pre-window-conf nil))))
7195 (defun org-agenda-quit ()
7196 "Exit the agenda and restore the window configuration.
7197 When `org-agenda-sticky' is non-nil, only bury the agenda."
7198 (interactive)
7199 (if (and (eq org-indirect-buffer-display 'other-window)
7200 org-last-indirect-buffer)
7201 (let ((org-last-indirect-window
7202 (get-buffer-window org-last-indirect-buffer)))
7203 (if org-last-indirect-window
7204 (delete-window org-last-indirect-window))))
7205 (if org-agenda-columns-active
7206 (org-columns-quit)
7207 (if org-agenda-sticky
7208 (let ((buf (current-buffer)))
7209 (if (eq org-agenda-window-setup 'other-frame)
7210 (progn
7211 (delete-frame))
7212 (and (not (eq org-agenda-window-setup 'current-window))
7213 (not (one-window-p))
7214 (delete-window)))
7215 (with-current-buffer buf
7216 (bury-buffer)
7217 ;; Maybe restore the pre-agenda window configuration.
7218 (and org-agenda-restore-windows-after-quit
7219 (not (eq org-agenda-window-setup 'other-frame))
7220 org-agenda-pre-window-conf
7221 (set-window-configuration org-agenda-pre-window-conf)
7222 (setq org-agenda-pre-window-conf nil))))
7223 (org-agenda-Quit))))
7225 (defun org-agenda-exit ()
7226 "Exit the agenda and restore the window configuration.
7227 Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
7228 buffers visited directly by the user will not be touched."
7229 (interactive)
7230 (org-release-buffers org-agenda-new-buffers)
7231 (setq org-agenda-new-buffers nil)
7232 (org-agenda-Quit))
7234 (defun org-agenda-kill-all-agenda-buffers ()
7235 "Kill all buffers in `org-agenda-mode'.
7236 This is used when toggling sticky agendas.
7237 You can also explicitly invoke it with `C-c a C-k'."
7238 (interactive)
7239 (let (blist)
7240 (dolist (buf (buffer-list))
7241 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7242 (push buf blist)))
7243 (mapc 'kill-buffer blist)))
7245 (defun org-agenda-execute (arg)
7246 "Execute another agenda command, keeping same window.
7247 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7248 in the agenda."
7249 (interactive "P")
7250 (let ((org-agenda-window-setup 'current-window))
7251 (org-agenda arg)))
7253 (defun org-agenda-redo (&optional all)
7254 "Rebuild possibly ALL agenda view(s) in the current buffer."
7255 (interactive "P")
7256 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7257 (cpa (unless (eq all t) current-prefix-arg))
7258 (org-agenda-doing-sticky-redo org-agenda-sticky)
7259 (org-agenda-sticky nil)
7260 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7261 org-agenda-buffer-name))
7262 (org-agenda-keep-modes t)
7263 (tag-filter org-agenda-tag-filter)
7264 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7265 (top-hl-filter org-agenda-top-headline-filter)
7266 (cat-filter org-agenda-category-filter)
7267 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7268 (re-filter org-agenda-regexp-filter)
7269 (re-preset (get 'org-agenda-regexp-filter :preset-filter))
7270 (cols org-agenda-columns-active)
7271 (line (org-current-line))
7272 (window-line (- line (org-current-line (window-start))))
7273 (lprops (get 'org-agenda-redo-command 'org-lprops))
7274 (redo-cmd (get-text-property p 'org-redo-cmd))
7275 (last-args (get-text-property p 'org-last-args))
7276 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7277 (org-agenda-overriding-cmd-arguments
7278 (unless (eq all t)
7279 (cond ((listp last-args)
7280 (cons (or cpa (car last-args)) (cdr last-args)))
7281 ((stringp last-args)
7282 last-args))))
7283 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7284 (put 'org-agenda-tag-filter :preset-filter nil)
7285 (put 'org-agenda-category-filter :preset-filter nil)
7286 (put 'org-agenda-regexp-filter :preset-filter nil)
7287 (and cols (org-columns-quit))
7288 (message "Rebuilding agenda buffer...")
7289 (if series-redo-cmd
7290 (eval series-redo-cmd)
7291 (org-let lprops redo-cmd))
7292 (setq org-agenda-undo-list nil
7293 org-agenda-pending-undo-list nil
7294 org-agenda-tag-filter tag-filter
7295 org-agenda-category-filter cat-filter
7296 org-agenda-regexp-filter re-filter
7297 org-agenda-top-headline-filter top-hl-filter)
7298 (message "Rebuilding agenda buffer...done")
7299 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7300 (put 'org-agenda-category-filter :preset-filter cat-preset)
7301 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7302 (let ((tag (or tag-filter tag-preset))
7303 (cat (or cat-filter cat-preset))
7304 (re (or re-filter re-preset)))
7305 (when tag (org-agenda-filter-apply tag 'tag))
7306 (when cat (org-agenda-filter-apply cat 'category))
7307 (when re (org-agenda-filter-apply re 'regexp)))
7308 (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
7309 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
7310 (org-goto-line line)
7311 (recenter window-line)))
7313 (defvar org-global-tags-completion-table nil)
7314 (defvar org-agenda-filter-form nil)
7315 (defvar org-agenda-filtered-by-category nil)
7317 (defun org-agenda-filter-by-category (strip)
7318 "Keep only those lines in the agenda buffer that have a specific category.
7319 The category is that of the current line."
7320 (interactive "P")
7321 (if (and org-agenda-filtered-by-category
7322 org-agenda-category-filter)
7323 (org-agenda-filter-show-all-cat)
7324 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
7325 (cond
7326 ((and cat strip)
7327 (org-agenda-filter-apply
7328 (push (concat "-" cat) org-agenda-category-filter) 'category))
7329 ((and cat)
7330 (org-agenda-filter-apply
7331 (setq org-agenda-category-filter
7332 (list (concat "+" cat))) 'category))
7333 (t (error "No category at point"))))))
7335 (defun org-find-top-headline (&optional pos)
7336 "Find the topmost parent headline and return it."
7337 (save-excursion
7338 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
7339 (if pos (goto-char pos))
7340 ;; Skip up to the topmost parent
7341 (while (ignore-errors (outline-up-heading 1) t))
7342 (ignore-errors
7343 (nth 4 (org-heading-components))))))
7345 (defvar org-agenda-filtered-by-top-headline nil)
7346 (defun org-agenda-filter-by-top-headline (strip)
7347 "Keep only those lines that are descendants from the same top headline.
7348 The top headline is that of the current line."
7349 (interactive "P")
7350 (if org-agenda-filtered-by-top-headline
7351 (progn
7352 (setq org-agenda-filtered-by-top-headline nil
7353 org-agenda-top-headline-filter nil)
7354 (org-agenda-filter-show-all-top-filter))
7355 (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
7356 (if toph (org-agenda-filter-top-headline-apply toph strip)
7357 (error "No top-level headline at point")))))
7359 (defvar org-agenda-regexp-filter nil)
7360 (defun org-agenda-filter-by-regexp (strip)
7361 "Filter agenda entries by a regular expression.
7362 Regexp filters are cumulative.
7363 With no prefix argument, keep entries matching the regexp.
7364 With one prefix argument, filter out entries matching the regexp.
7365 With two prefix arguments, remove the regexp filters."
7366 (interactive "P")
7367 (if (not (equal strip '(16)))
7368 (let ((flt (concat (if (equal strip '(4)) "-" "+")
7369 (read-from-minibuffer
7370 (if (equal strip '(4))
7371 "Filter out entries matching regexp: "
7372 "Narrow to entries matching regexp: ")))))
7373 (push flt org-agenda-regexp-filter)
7374 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
7375 (org-agenda-filter-show-all-re)
7376 (message "Regexp filter removed")))
7378 (defun org-agenda-filter-remove-all ()
7379 "Remove all filters from the current agenda buffer."
7380 (interactive)
7381 (when org-agenda-tag-filter
7382 (org-agenda-filter-show-all-tag))
7383 (when org-agenda-category-filter
7384 (org-agenda-filter-show-all-cat))
7385 (when org-agenda-regexp-filter
7386 (org-agenda-filter-show-all-re))
7387 (when org-agenda-top-headline-filter
7388 (org-agenda-filter-show-all-top-filter))
7389 (org-agenda-finalize))
7391 (defun org-agenda-filter-by-tag (strip &optional char narrow)
7392 "Keep only those lines in the agenda buffer that have a specific tag.
7393 The tag is selected with its fast selection letter, as configured.
7394 With prefix argument STRIP, remove all lines that do have the tag.
7395 A lisp caller can specify CHAR. NARROW means that the new tag should be
7396 used to narrow the search - the interactive user can also press `-' or `+'
7397 to switch to narrowing."
7398 (interactive "P")
7399 (let* ((alist org-tag-alist-for-agenda)
7400 (tag-chars (mapconcat
7401 (lambda (x) (if (and (not (symbolp (car x)))
7402 (cdr x))
7403 (char-to-string (cdr x))
7404 ""))
7405 alist ""))
7406 (efforts (org-split-string
7407 (or (cdr (assoc (concat org-effort-property "_ALL")
7408 org-global-properties))
7409 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7410 "")))
7411 (effort-op org-agenda-filter-effort-default-operator)
7412 (effort-prompt "")
7413 (inhibit-read-only t)
7414 (current org-agenda-tag-filter)
7415 maybe-refresh a n tag)
7416 (unless char
7417 (message
7418 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
7419 (if narrow "Narrow" "Filter") tag-chars
7420 (if org-agenda-auto-exclude-function "[RET], " ""))
7421 (setq char (read-char-exclusive)))
7422 (when (member char '(?+ ?-))
7423 ;; Narrowing down
7424 (cond ((equal char ?-) (setq strip t narrow t))
7425 ((equal char ?+) (setq strip nil narrow t)))
7426 (message
7427 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
7428 (setq char (read-char-exclusive)))
7429 (when (member char '(?< ?> ?= ??))
7430 ;; An effort operator
7431 (setq effort-op (char-to-string char))
7432 (setq alist nil) ; to make sure it will be interpreted as effort.
7433 (unless (equal char ??)
7434 (loop for i from 0 to 9 do
7435 (setq effort-prompt
7436 (concat
7437 effort-prompt " ["
7438 (if (= i 9) "0" (int-to-string (1+ i)))
7439 "]" (nth i efforts))))
7440 (message "Effort%s: %s " effort-op effort-prompt)
7441 (setq char (read-char-exclusive))
7442 (when (or (< char ?0) (> char ?9))
7443 (error "Need 1-9,0 to select effort"))))
7444 (when (equal char ?\t)
7445 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7446 (org-set-local 'org-global-tags-completion-table
7447 (org-global-tags-completion-table)))
7448 (let ((completion-ignore-case t))
7449 (setq tag (org-icompleting-read
7450 "Tag: " org-global-tags-completion-table))))
7451 (cond
7452 ((equal char ?\r)
7453 (org-agenda-filter-show-all-tag)
7454 (when org-agenda-auto-exclude-function
7455 (setq org-agenda-tag-filter nil)
7456 (dolist (tag (org-agenda-get-represented-tags))
7457 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7458 (if modifier
7459 (push modifier org-agenda-tag-filter))))
7460 (if (not (null org-agenda-tag-filter))
7461 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
7462 (setq maybe-refresh t))
7463 ((equal char ?/)
7464 (org-agenda-filter-show-all-tag)
7465 (when (get 'org-agenda-tag-filter :preset-filter)
7466 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7467 (setq maybe-refresh t))
7468 ((equal char ?. )
7469 (setq org-agenda-tag-filter
7470 (mapcar (lambda(tag) (concat "+" tag))
7471 (org-get-at-bol 'tags)))
7472 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7473 (setq maybe-refresh t))
7474 ((or (equal char ?\ )
7475 (setq a (rassoc char alist))
7476 (and (>= char ?0) (<= char ?9)
7477 (setq n (if (= char ?0) 9 (- char ?0 1))
7478 tag (concat effort-op (nth n efforts))
7479 a (cons tag nil)))
7480 (and (= char ??)
7481 (setq tag "?eff")
7482 a (cons tag nil))
7483 (and tag (setq a (cons tag nil))))
7484 (org-agenda-filter-show-all-tag)
7485 (setq tag (car a))
7486 (setq org-agenda-tag-filter
7487 (cons (concat (if strip "-" "+") tag)
7488 (if narrow current nil)))
7489 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7490 (setq maybe-refresh t))
7491 (t (error "Invalid tag selection character %c" char)))
7492 (when maybe-refresh
7493 (org-agenda-redo))))
7495 (defun org-agenda-get-represented-tags ()
7496 "Get a list of all tags currently represented in the agenda."
7497 (let (p tags)
7498 (save-excursion
7499 (goto-char (point-min))
7500 (while (setq p (next-single-property-change (point) 'tags))
7501 (goto-char p)
7502 (mapc (lambda (x) (add-to-list 'tags x))
7503 (get-text-property (point) 'tags))))
7504 tags))
7506 (defun org-agenda-filter-by-tag-refine (strip &optional char)
7507 "Refine the current filter. See `org-agenda-filter-by-tag'."
7508 (interactive "P")
7509 (org-agenda-filter-by-tag strip char 'refine))
7511 (defun org-agenda-filter-make-matcher (filter type)
7512 "Create the form that tests a line for agenda filter."
7513 (let (f f1)
7514 (cond
7515 ;; Tag filter
7516 ((eq type 'tag)
7517 (setq filter
7518 (delete-dups
7519 (append (get 'org-agenda-tag-filter :preset-filter)
7520 filter)))
7521 (dolist (x filter)
7522 (let ((nfilter (org-agenda-filter-expand-tags filter)) nf nf1
7523 (ffunc
7524 (lambda (nf0 nf01 fltr notgroup op)
7525 (dolist (x fltr)
7526 (if (member x '("-" "+"))
7527 (setq nf01 (if (equal x "-") 'tags '(not tags)))
7528 (if (string-match "[<=>?]" x)
7529 (setq nf01 (org-agenda-filter-effort-form x))
7530 (setq nf01 (list 'member (downcase (substring x 1))
7531 'tags)))
7532 (when (equal (string-to-char x) ?-)
7533 (setq nf01 (list 'not nf01))
7534 (when (not notgroup) (setq op 'and))))
7535 (push nf01 nf0))
7536 (if notgroup
7537 (push (cons 'and nf0) f)
7538 (push (cons (or op 'or) nf0) f)))))
7539 (cond ((equal filter '("+"))
7540 (setq f (list (list 'not 'tags))))
7541 ((equal nfilter filter)
7542 (funcall ffunc f1 f filter t nil))
7543 (t (funcall ffunc nf1 nf nfilter nil nil))))))
7544 ;; Category filter
7545 ((eq type 'category)
7546 (setq filter
7547 (delete-dups
7548 (append (get 'org-agenda-category-filter :preset-filter)
7549 filter)))
7550 (dolist (x filter)
7551 (if (equal "-" (substring x 0 1))
7552 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7553 (setq f1 (list 'equal (substring x 1) 'cat)))
7554 (push f1 f)))
7555 ;; Regexp filter
7556 ((eq type 'regexp)
7557 (setq filter
7558 (delete-dups
7559 (append (get 'org-agenda-regexp-filter :preset-filter)
7560 filter)))
7561 (dolist (x filter)
7562 (if (equal "-" (substring x 0 1))
7563 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7564 (setq f1 (list 'string-match (substring x 1) 'txt)))
7565 (push f1 f))))
7566 (cons 'and (nreverse f))))
7568 (defun org-agenda-filter-effort-form (e)
7569 "Return the form to compare the effort of the current line with what E says.
7570 E looks like \"+<2:25\"."
7571 (let (op)
7572 (setq e (substring e 1))
7573 (setq op (string-to-char e) e (substring e 1))
7574 (setq op (cond ((equal op ?<) '<=)
7575 ((equal op ?>) '>=)
7576 ((equal op ??) op)
7577 (t '=)))
7578 (list 'org-agenda-compare-effort (list 'quote op)
7579 (org-duration-string-to-minutes e))))
7581 (defun org-agenda-compare-effort (op value)
7582 "Compare the effort of the current line with VALUE, using OP.
7583 If the line does not have an effort defined, return nil."
7584 (let ((eff (org-get-at-bol 'effort-minutes)))
7585 (if (equal op ??)
7586 (not eff)
7587 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
7588 value))))
7590 (defun org-agenda-filter-expand-tags (filter &optional no-operator)
7591 "Expand group tags in FILTER for the agenda.
7592 When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
7593 (if org-group-tags
7594 (let ((case-fold-search t) rtn)
7595 (mapc
7596 (lambda (f)
7597 (let (f0 dir)
7598 (if (string-match "^\\([+-]\\)\\(.+\\)" f)
7599 (setq dir (match-string 1 f) f0 (match-string 2 f))
7600 (setq dir (if no-operator "" "+") f0 f))
7601 (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
7602 (org-tags-expand f0 t t))
7603 rtn))))
7604 filter)
7605 (reverse rtn))
7606 filter))
7608 (defun org-agenda-filter-apply (filter type)
7609 "Set FILTER as the new agenda filter and apply it."
7610 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7611 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7612 (let (tags cat txt)
7613 (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type))
7614 ;; Only set `org-agenda-filtered-by-category' to t when a unique
7615 ;; category is used as the filter:
7616 (setq org-agenda-filtered-by-category
7617 (and (eq type 'category)
7618 (not (equal (substring (car filter) 0 1) "-"))))
7619 (org-agenda-set-mode-name)
7620 (save-excursion
7621 (goto-char (point-min))
7622 (while (not (eobp))
7623 (if (org-get-at-bol 'org-marker)
7624 (progn
7625 (setq tags ; used in eval
7626 (apply 'append
7627 (mapcar (lambda (f)
7628 (org-agenda-filter-expand-tags (list f) t))
7629 (org-get-at-bol 'tags)))
7630 cat (get-text-property (point) 'org-category)
7631 txt (get-text-property (point) 'txt))
7632 (if (not (eval org-agenda-filter-form))
7633 (org-agenda-filter-hide-line type))
7634 (beginning-of-line 2))
7635 (beginning-of-line 2))))
7636 (if (get-char-property (point) 'invisible)
7637 (ignore-errors (org-agenda-previous-line)))))
7639 (defun org-agenda-filter-top-headline-apply (hl &optional negative)
7640 "Filter by top headline HL."
7641 (org-agenda-set-mode-name)
7642 (save-excursion
7643 (goto-char (point-min))
7644 (while (not (eobp))
7645 (let* ((pos (org-get-at-bol 'org-hd-marker))
7646 (tophl (and pos (org-find-top-headline pos))))
7647 (if (and tophl (funcall (if negative 'identity 'not)
7648 (string= hl tophl)))
7649 (org-agenda-filter-hide-line 'top-headline)))
7650 (beginning-of-line 2)))
7651 (if (get-char-property (point) 'invisible)
7652 (org-agenda-previous-line))
7653 (setq org-agenda-top-headline-filter hl
7654 org-agenda-filtered-by-top-headline t))
7656 (defun org-agenda-filter-hide-line (type)
7657 "Hide lines with TYPE in the agenda buffer."
7658 (let* ((b (max (point-min) (1- (point-at-bol))))
7659 (e (point-at-eol)))
7660 (let ((inhibit-read-only t))
7661 (add-text-properties
7662 b e `(invisible org-filtered org-filter-type ,type)))))
7664 (defun org-agenda-remove-filter (type)
7665 (interactive)
7666 "Remove filter of type TYPE from the agenda buffer."
7667 (save-excursion
7668 (goto-char (point-min))
7669 (let ((inhibit-read-only t) pos)
7670 (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
7671 (goto-char pos)
7672 (remove-text-properties
7673 (point) (next-single-property-change (point) 'org-filter-type)
7674 `(invisible org-filtered org-filter-type ,type))))
7675 (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
7676 (setq org-agenda-filter-form nil)
7677 (org-agenda-set-mode-name)
7678 (org-agenda-finalize)))
7680 (defun org-agenda-filter-show-all-tag nil
7681 (org-agenda-remove-filter 'tag))
7682 (defun org-agenda-filter-show-all-re nil
7683 (org-agenda-remove-filter 'regexp))
7684 (defun org-agenda-filter-show-all-cat nil
7685 (org-agenda-remove-filter 'category))
7686 (defun org-agenda-filter-show-all-top-filter nil
7687 (org-agenda-remove-filter 'top-headline))
7689 (defun org-agenda-manipulate-query-add ()
7690 "Manipulate the query by adding a search term with positive selection.
7691 Positive selection means the term must be matched for selection of an entry."
7692 (interactive)
7693 (org-agenda-manipulate-query ?\[))
7694 (defun org-agenda-manipulate-query-subtract ()
7695 "Manipulate the query by adding a search term with negative selection.
7696 Negative selection means term must not be matched for selection of an entry."
7697 (interactive)
7698 (org-agenda-manipulate-query ?\]))
7699 (defun org-agenda-manipulate-query-add-re ()
7700 "Manipulate the query by adding a search regexp with positive selection.
7701 Positive selection means the regexp must match for selection of an entry."
7702 (interactive)
7703 (org-agenda-manipulate-query ?\{))
7704 (defun org-agenda-manipulate-query-subtract-re ()
7705 "Manipulate the query by adding a search regexp with negative selection.
7706 Negative selection means regexp must not match for selection of an entry."
7707 (interactive)
7708 (org-agenda-manipulate-query ?\}))
7709 (defun org-agenda-manipulate-query (char)
7710 (cond
7711 ((memq org-agenda-type '(timeline agenda))
7712 (let ((org-agenda-include-inactive-timestamps t))
7713 (org-agenda-redo))
7714 (message "Display now includes inactive timestamps as well"))
7715 ((eq org-agenda-type 'search)
7716 (org-add-to-string
7717 'org-agenda-query-string
7718 (if org-agenda-last-search-view-search-was-boolean
7719 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7720 (?\{ . " +{}") (?\} . " -{}"))))
7721 " "))
7722 (setq org-agenda-redo-command
7723 (list 'org-search-view
7724 (car (get-text-property (min (1- (point-max)) (point))
7725 'org-last-args))
7726 org-agenda-query-string
7727 (+ (length org-agenda-query-string)
7728 (if (member char '(?\{ ?\})) 0 1))))
7729 (set-register org-agenda-query-register org-agenda-query-string)
7730 (let ((org-agenda-overriding-arguments
7731 (cdr org-agenda-redo-command)))
7732 (org-agenda-redo)))
7733 (t (error "Cannot manipulate query for %s-type agenda buffers"
7734 org-agenda-type))))
7736 (defun org-add-to-string (var string)
7737 (set var (concat (symbol-value var) string)))
7739 (defun org-agenda-goto-date (span)
7740 "Jump to DATE in agenda."
7741 (interactive "P")
7742 (let* ((org-read-date-prefer-future
7743 (eval org-agenda-jump-prefer-future))
7744 (date (org-read-date))
7745 (day (time-to-days (org-time-string-to-time date)))
7746 (org-agenda-sticky-orig org-agenda-sticky)
7747 (org-agenda-buffer-tmp-name (buffer-name))
7748 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7749 (0-arg (or current-prefix-arg (car args)))
7750 (2-arg (nth 2 args))
7751 (with-hour-p (nth 4 org-agenda-redo-command))
7752 (newcmd (list 'org-agenda-list 0-arg date
7753 (org-agenda-span-to-ndays
7754 2-arg (org-time-string-to-absolute date))
7755 with-hour-p))
7756 (newargs (cdr newcmd))
7757 (inhibit-read-only t)
7758 org-agenda-sticky)
7759 (if (not (org-agenda-check-type t 'agenda))
7760 (error "Not available in non-agenda views")
7761 (add-text-properties (point-min) (point-max)
7762 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7763 (org-agenda-redo)
7764 (goto-char (point-min))
7765 (while (not (or (= (or (get-text-property (point) 'day) 0) day)
7766 (save-excursion (move-beginning-of-line 2) (eobp))))
7767 (move-beginning-of-line 2))
7768 (setq org-agenda-sticky org-agenda-sticky-orig
7769 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7771 (defun org-agenda-goto-today ()
7772 "Go to today."
7773 (interactive)
7774 (org-agenda-check-type t 'timeline 'agenda)
7775 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7776 (curspan (nth 2 args))
7777 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7778 (cond
7779 (tdpos (goto-char tdpos))
7780 ((eq org-agenda-type 'agenda)
7781 (let* ((sd (org-agenda-compute-starting-span
7782 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7783 (org-agenda-overriding-arguments args))
7784 (setf (nth 1 org-agenda-overriding-arguments) sd)
7785 (org-agenda-redo)
7786 (org-agenda-find-same-or-today-or-agenda)))
7787 (t (error "Cannot find today")))))
7789 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7790 (goto-char
7791 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7792 (text-property-any (point-min) (point-max) 'org-today t)
7793 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7794 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7795 (org-agenda-goto-block-beginning))
7796 (point-min))))
7798 (defun org-agenda-goto-block-beginning ()
7799 "Go the agenda block beginning."
7800 (interactive)
7801 (if (not (derived-mode-p 'org-agenda-mode))
7802 (error "Cannot execute this command outside of org-agenda-mode buffers")
7803 (let (dest)
7804 (save-excursion
7805 (unless (looking-at "\\'")
7806 (forward-char))
7807 (let* ((prop 'org-agenda-structural-header)
7808 (p (previous-single-property-change (point) prop))
7809 (n (next-single-property-change (or (and (looking-at "\\`") 1)
7810 (1- (point))) prop)))
7811 (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
7812 (if (not dest)
7813 (error "Cannot find the beginning of the blog")
7814 (goto-char dest)
7815 (move-beginning-of-line 1)))))
7817 (defun org-agenda-later (arg)
7818 "Go forward in time by the current span.
7819 With prefix ARG, go forward that many times the current span."
7820 (interactive "p")
7821 (org-agenda-check-type t 'agenda)
7822 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7823 (span (or (nth 2 args) org-agenda-current-span))
7824 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7825 (greg (calendar-gregorian-from-absolute sd))
7826 (cnt (org-get-at-bol 'org-day-cnt))
7827 greg2)
7828 (cond
7829 ((numberp span)
7830 (setq sd (+ (* span arg) sd)))
7831 ((eq span 'day)
7832 (setq sd (+ arg sd)))
7833 ((eq span 'week)
7834 (setq sd (+ (* 7 arg) sd)))
7835 ((eq span 'fortnight)
7836 (setq sd (+ (* 14 arg) sd)))
7837 ((eq span 'month)
7838 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7839 sd (calendar-absolute-from-gregorian greg2))
7840 (setcar greg2 (1+ (car greg2))))
7841 ((eq span 'year)
7842 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7843 sd (calendar-absolute-from-gregorian greg2))
7844 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7846 (setq sd (+ (* span arg) sd))))
7847 (let ((org-agenda-overriding-cmd
7848 ;; `cmd' may have been set by `org-agenda-run-series' which
7849 ;; uses `org-agenda-overriding-cmd' to decide whether
7850 ;; overriding is allowed for `cmd'
7851 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7852 (org-agenda-overriding-arguments
7853 (list (car args) sd span)))
7854 (org-agenda-redo)
7855 (org-agenda-find-same-or-today-or-agenda cnt))))
7857 (defun org-agenda-earlier (arg)
7858 "Go backward in time by the current span.
7859 With prefix ARG, go backward that many times the current span."
7860 (interactive "p")
7861 (org-agenda-later (- arg)))
7863 (defun org-agenda-view-mode-dispatch ()
7864 "Call one of the view mode commands."
7865 (interactive)
7866 (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
7867 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7868 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7869 (let ((a (read-char-exclusive)))
7870 (case a
7871 (?\ (call-interactively 'org-agenda-reset-view))
7872 (?d (call-interactively 'org-agenda-day-view))
7873 (?w (call-interactively 'org-agenda-week-view))
7874 (?t (call-interactively 'org-agenda-fortnight-view))
7875 (?m (call-interactively 'org-agenda-month-view))
7876 (?y (call-interactively 'org-agenda-year-view))
7877 (?l (call-interactively 'org-agenda-log-mode))
7878 (?L (org-agenda-log-mode '(4)))
7879 (?c (org-agenda-log-mode 'clockcheck))
7880 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7881 (?a (call-interactively 'org-agenda-archives-mode))
7882 (?A (org-agenda-archives-mode 'files))
7883 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7884 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7885 (?G (call-interactively 'org-agenda-toggle-time-grid))
7886 (?D (call-interactively 'org-agenda-toggle-diary))
7887 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7888 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7889 (org-agenda-check-type t 'timeline 'agenda)
7890 (org-agenda-redo))
7891 (message "Display now includes inactive timestamps as well"))
7892 (?q (message "Abort"))
7893 (otherwise (error "Invalid key" )))))
7895 (defun org-agenda-reset-view ()
7896 "Switch to default view for agenda."
7897 (interactive)
7898 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7899 (defun org-agenda-day-view (&optional day-of-month)
7900 "Switch to daily view for agenda.
7901 With argument DAY-OF-MONTH, switch to that day of the month."
7902 (interactive "P")
7903 (org-agenda-change-time-span 'day day-of-month))
7904 (defun org-agenda-week-view (&optional iso-week)
7905 "Switch to daily view for agenda.
7906 With argument ISO-WEEK, switch to the corresponding ISO week.
7907 If ISO-WEEK has more then 2 digits, only the last two encode the
7908 week. Any digits before this encode a year. So 200712 means
7909 week 12 of year 2007. Years in the range 1938-2037 can also be
7910 written as 2-digit years."
7911 (interactive "P")
7912 (org-agenda-change-time-span 'week iso-week))
7913 (defun org-agenda-fortnight-view (&optional iso-week)
7914 "Switch to daily view for agenda.
7915 With argument ISO-WEEK, switch to the corresponding ISO week.
7916 If ISO-WEEK has more then 2 digits, only the last two encode the
7917 week. Any digits before this encode a year. So 200712 means
7918 week 12 of year 2007. Years in the range 1938-2037 can also be
7919 written as 2-digit years."
7920 (interactive "P")
7921 (org-agenda-change-time-span 'fortnight iso-week))
7922 (defun org-agenda-month-view (&optional month)
7923 "Switch to monthly view for agenda.
7924 With argument MONTH, switch to that month."
7925 (interactive "P")
7926 (org-agenda-change-time-span 'month month))
7927 (defun org-agenda-year-view (&optional year)
7928 "Switch to yearly view for agenda.
7929 With argument YEAR, switch to that year.
7930 If MONTH has more then 2 digits, only the last two encode the
7931 month. Any digits before this encode a year. So 200712 means
7932 December year 2007. Years in the range 1938-2037 can also be
7933 written as 2-digit years."
7934 (interactive "P")
7935 (when year
7936 (setq year (org-small-year-to-year year)))
7937 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7938 (org-agenda-change-time-span 'year year)
7939 (error "Abort")))
7941 (defun org-agenda-change-time-span (span &optional n)
7942 "Change the agenda view to SPAN.
7943 SPAN may be `day', `week', `fortnight', `month', `year'."
7944 (org-agenda-check-type t 'agenda)
7945 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7946 (curspan (nth 2 args)))
7947 (if (and (not n) (equal curspan span))
7948 (error "Viewing span is already \"%s\"" span))
7949 (let* ((sd (or (org-get-at-bol 'day)
7950 (nth 1 args)
7951 org-starting-day))
7952 (sd (org-agenda-compute-starting-span sd span n))
7953 (org-agenda-overriding-cmd
7954 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7955 (org-agenda-overriding-arguments
7956 (list (car args) sd span)))
7957 (org-agenda-redo)
7958 (org-agenda-find-same-or-today-or-agenda))
7959 (org-agenda-set-mode-name)
7960 (message "Switched to %s view" span)))
7962 (defun org-agenda-compute-starting-span (sd span &optional n)
7963 "Compute starting date for agenda.
7964 SPAN may be `day', `week', `fortnight', `month', `year'. The return value
7965 is a cons cell with the starting date and the number of days,
7966 so that the date SD will be in that range."
7967 (let* ((greg (calendar-gregorian-from-absolute sd))
7968 (dg (nth 1 greg))
7969 (mg (car greg))
7970 (yg (nth 2 greg)))
7971 (cond
7972 ((eq span 'day)
7973 (when n
7974 (setq sd (+ (calendar-absolute-from-gregorian
7975 (list mg 1 yg))
7976 n -1))))
7977 ((or (eq span 'week) (eq span 'fortnight))
7978 (let* ((nt (calendar-day-of-week
7979 (calendar-gregorian-from-absolute sd)))
7980 (d (if org-agenda-start-on-weekday
7981 (- nt org-agenda-start-on-weekday)
7984 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7985 (when n
7986 (require 'cal-iso)
7987 (when (> n 99)
7988 (setq y1 (org-small-year-to-year (/ n 100))
7989 n (mod n 100)))
7990 (setq sd
7991 (calendar-absolute-from-iso
7992 (list n 1
7993 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7994 ((eq span 'month)
7995 (let (y1)
7996 (when (and n (> n 99))
7997 (setq y1 (org-small-year-to-year (/ n 100))
7998 n (mod n 100)))
7999 (setq sd (calendar-absolute-from-gregorian
8000 (list (or n mg) 1 (or y1 yg))))))
8001 ((eq span 'year)
8002 (setq sd (calendar-absolute-from-gregorian
8003 (list 1 1 (or n yg))))))
8004 sd))
8006 (defun org-agenda-next-date-line (&optional arg)
8007 "Jump to the next line indicating a date in agenda buffer."
8008 (interactive "p")
8009 (org-agenda-check-type t 'agenda 'timeline)
8010 (beginning-of-line 1)
8011 ;; This does not work if user makes date format that starts with a blank
8012 (if (looking-at "^\\S-") (forward-char 1))
8013 (if (not (re-search-forward "^\\S-" nil t arg))
8014 (progn
8015 (backward-char 1)
8016 (error "No next date after this line in this buffer")))
8017 (goto-char (match-beginning 0)))
8019 (defun org-agenda-previous-date-line (&optional arg)
8020 "Jump to the previous line indicating a date in agenda buffer."
8021 (interactive "p")
8022 (org-agenda-check-type t 'agenda 'timeline)
8023 (beginning-of-line 1)
8024 (if (not (re-search-backward "^\\S-" nil t arg))
8025 (error "No previous date before this line in this buffer")))
8027 ;; Initialize the highlight
8028 (defvar org-hl (make-overlay 1 1))
8029 (overlay-put org-hl 'face 'highlight)
8031 (defun org-highlight (begin end &optional buffer)
8032 "Highlight a region with overlay."
8033 (move-overlay org-hl begin end (or buffer (current-buffer))))
8035 (defun org-unhighlight ()
8036 "Detach overlay INDEX."
8037 (org-detach-overlay org-hl))
8039 (defun org-unhighlight-once ()
8040 "Remove the highlight from its position, and this function from the hook."
8041 (remove-hook 'pre-command-hook 'org-unhighlight-once)
8042 (org-unhighlight))
8044 (defvar org-agenda-pre-follow-window-conf nil)
8045 (defun org-agenda-follow-mode ()
8046 "Toggle follow mode in an agenda buffer."
8047 (interactive)
8048 (unless org-agenda-follow-mode
8049 (setq org-agenda-pre-follow-window-conf
8050 (current-window-configuration)))
8051 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
8052 (unless org-agenda-follow-mode
8053 (set-window-configuration org-agenda-pre-follow-window-conf))
8054 (org-agenda-set-mode-name)
8055 (org-agenda-do-context-action)
8056 (message "Follow mode is %s"
8057 (if org-agenda-follow-mode "on" "off")))
8059 (defun org-agenda-entry-text-mode (&optional arg)
8060 "Toggle entry text mode in an agenda buffer."
8061 (interactive "P")
8062 (if (or org-agenda-tag-filter
8063 org-agenda-category-filter
8064 org-agenda-regexp-filter
8065 org-agenda-top-headline-filter)
8066 (user-error "Can't show entry text in filtered views")
8067 (setq org-agenda-entry-text-mode (or (integerp arg)
8068 (not org-agenda-entry-text-mode)))
8069 (org-agenda-entry-text-hide)
8070 (and org-agenda-entry-text-mode
8071 (let ((org-agenda-entry-text-maxlines
8072 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
8073 (org-agenda-entry-text-show)))
8074 (org-agenda-set-mode-name)
8075 (message "Entry text mode is %s%s"
8076 (if org-agenda-entry-text-mode "on" "off")
8077 (if (not org-agenda-entry-text-mode) ""
8078 (format " (maximum number of lines is %d)"
8079 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
8081 (defun org-agenda-clockreport-mode ()
8082 "Toggle clocktable mode in an agenda buffer."
8083 (interactive)
8084 (org-agenda-check-type t 'agenda)
8085 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
8086 (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
8087 (org-agenda-set-mode-name)
8088 (org-agenda-redo)
8089 (message "Clocktable mode is %s"
8090 (if org-agenda-clockreport-mode "on" "off")))
8092 (defun org-agenda-log-mode (&optional special)
8093 "Toggle log mode in an agenda buffer.
8094 With argument SPECIAL, show all possible log items, not only the ones
8095 configured in `org-agenda-log-mode-items'.
8096 With a double `C-u' prefix arg, show *only* log items, nothing else."
8097 (interactive "P")
8098 (org-agenda-check-type t 'agenda 'timeline)
8099 (setq org-agenda-show-log
8100 (cond
8101 ((equal special '(16)) 'only)
8102 ((eq special 'clockcheck)
8103 (if (eq org-agenda-show-log 'clockcheck)
8104 nil 'clockcheck))
8105 (special '(closed clock state))
8106 (t (not org-agenda-show-log))))
8107 (setq org-agenda-start-with-log-mode org-agenda-show-log)
8108 (org-agenda-set-mode-name)
8109 (org-agenda-redo)
8110 (message "Log mode is %s"
8111 (if org-agenda-show-log "on" "off")))
8113 (defun org-agenda-archives-mode (&optional with-files)
8114 "Toggle inclusion of items in trees marked with :ARCHIVE:.
8115 When called with a prefix argument, include all archive files as well."
8116 (interactive "P")
8117 (setq org-agenda-archives-mode
8118 (if with-files t (if org-agenda-archives-mode nil 'trees)))
8119 (org-agenda-set-mode-name)
8120 (org-agenda-redo)
8121 (message
8122 "%s"
8123 (cond
8124 ((eq org-agenda-archives-mode nil)
8125 "No archives are included")
8126 ((eq org-agenda-archives-mode 'trees)
8127 (format "Trees with :%s: tag are included" org-archive-tag))
8128 ((eq org-agenda-archives-mode t)
8129 (format "Trees with :%s: tag and all active archive files are included"
8130 org-archive-tag)))))
8132 (defun org-agenda-toggle-diary ()
8133 "Toggle diary inclusion in an agenda buffer."
8134 (interactive)
8135 (org-agenda-check-type t 'agenda)
8136 (setq org-agenda-include-diary (not org-agenda-include-diary))
8137 (org-agenda-redo)
8138 (org-agenda-set-mode-name)
8139 (message "Diary inclusion turned %s"
8140 (if org-agenda-include-diary "on" "off")))
8142 (defun org-agenda-toggle-deadlines ()
8143 "Toggle inclusion of entries with a deadline in an agenda buffer."
8144 (interactive)
8145 (org-agenda-check-type t 'agenda)
8146 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8147 (org-agenda-redo)
8148 (org-agenda-set-mode-name)
8149 (message "Deadlines inclusion turned %s"
8150 (if org-agenda-include-deadlines "on" "off")))
8152 (defun org-agenda-toggle-time-grid ()
8153 "Toggle time grid in an agenda buffer."
8154 (interactive)
8155 (org-agenda-check-type t 'agenda)
8156 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8157 (org-agenda-redo)
8158 (org-agenda-set-mode-name)
8159 (message "Time-grid turned %s"
8160 (if org-agenda-use-time-grid "on" "off")))
8162 (defun org-agenda-set-mode-name ()
8163 "Set the mode name to indicate all the small mode settings."
8164 (setq mode-name
8165 (list "Org-Agenda"
8166 (if (get 'org-agenda-files 'org-restrict) " []" "")
8168 '(:eval (org-agenda-span-name org-agenda-current-span))
8169 (if org-agenda-follow-mode " Follow" "")
8170 (if org-agenda-entry-text-mode " ETxt" "")
8171 (if org-agenda-include-diary " Diary" "")
8172 (if org-agenda-include-deadlines " Ddl" "")
8173 (if org-agenda-use-time-grid " Grid" "")
8174 (if (and (boundp 'org-habit-show-habits)
8175 org-habit-show-habits) " Habit" "")
8176 (cond
8177 ((consp org-agenda-show-log) " LogAll")
8178 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8179 (org-agenda-show-log " Log")
8180 (t ""))
8181 (if (or org-agenda-category-filter
8182 (get 'org-agenda-category-filter :preset-filter))
8183 '(:eval (org-propertize
8184 (concat " <"
8185 (mapconcat
8186 'identity
8187 (append
8188 (get 'org-agenda-category-filter :preset-filter)
8189 org-agenda-category-filter)
8191 ">")
8192 'face 'org-agenda-filter-category
8193 'help-echo "Category used in filtering")) "")
8194 (if (or org-agenda-tag-filter
8195 (get 'org-agenda-tag-filter :preset-filter))
8196 '(:eval (org-propertize
8197 (concat " {"
8198 (mapconcat
8199 'identity
8200 (append
8201 (get 'org-agenda-tag-filter :preset-filter)
8202 org-agenda-tag-filter)
8204 "}")
8205 'face 'org-agenda-filter-tags
8206 'help-echo "Tags used in filtering")) "")
8207 (if (or org-agenda-regexp-filter
8208 (get 'org-agenda-regexp-filter :preset-filter))
8209 '(:eval (org-propertize
8210 (concat " ["
8211 (mapconcat
8212 'identity
8213 (append
8214 (get 'org-agenda-regexp-filter :preset-filter)
8215 org-agenda-regexp-filter)
8217 "]")
8218 'face 'org-agenda-filter-regexp
8219 'help-echo "Regexp used in filtering")) "")
8220 (if org-agenda-archives-mode
8221 (if (eq org-agenda-archives-mode t)
8222 " Archives"
8223 (format " :%s:" org-archive-tag))
8225 (if org-agenda-clockreport-mode " Clock" "")))
8226 (force-mode-line-update))
8228 (define-obsolete-function-alias
8229 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8231 (defun org-agenda-update-agenda-type ()
8232 "Update the agenda type after each command."
8233 (setq org-agenda-type
8234 (or (get-text-property (point) 'org-agenda-type)
8235 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8237 (defun org-agenda-next-line ()
8238 "Move cursor to the next line, and show if follow mode is active."
8239 (interactive)
8240 (call-interactively 'next-line)
8241 (org-agenda-do-context-action))
8243 (defun org-agenda-previous-line ()
8244 "Move cursor to the previous line, and show if follow-mode is active."
8245 (interactive)
8246 (call-interactively 'previous-line)
8247 (org-agenda-do-context-action))
8249 (defun org-agenda-next-item (n)
8250 "Move cursor to next agenda item."
8251 (interactive "p")
8252 (let ((col (current-column)))
8253 (dotimes (c n)
8254 (when (next-single-property-change (point-at-eol) 'org-marker)
8255 (move-end-of-line 1)
8256 (goto-char (next-single-property-change (point) 'org-marker))))
8257 (org-move-to-column col))
8258 (org-agenda-do-context-action))
8260 (defun org-agenda-previous-item (n)
8261 "Move cursor to next agenda item."
8262 (interactive "p")
8263 (dotimes (c n)
8264 (let ((col (current-column))
8265 (goto (save-excursion
8266 (move-end-of-line 0)
8267 (previous-single-property-change (point) 'org-marker))))
8268 (if goto (goto-char goto))
8269 (org-move-to-column col)))
8270 (org-agenda-do-context-action))
8272 (defun org-agenda-do-context-action ()
8273 "Show outline path and, maybe, follow mode window."
8274 (let ((m (org-get-at-bol 'org-marker)))
8275 (when (and (markerp m) (marker-buffer m))
8276 (and org-agenda-follow-mode
8277 (if org-agenda-follow-indirect
8278 (org-agenda-tree-to-indirect-buffer nil)
8279 (org-agenda-show)))
8280 (and org-agenda-show-outline-path
8281 (org-with-point-at m (org-display-outline-path t))))))
8283 (defun org-agenda-show-tags ()
8284 "Show the tags applicable to the current item."
8285 (interactive)
8286 (let* ((tags (org-get-at-bol 'tags)))
8287 (if tags
8288 (message "Tags are :%s:"
8289 (org-no-properties (mapconcat 'identity tags ":")))
8290 (message "No tags associated with this line"))))
8292 (defun org-agenda-goto (&optional highlight)
8293 "Go to the Org-mode file which contains the item at point."
8294 (interactive)
8295 (let* ((marker (or (org-get-at-bol 'org-marker)
8296 (org-agenda-error)))
8297 (buffer (marker-buffer marker))
8298 (pos (marker-position marker)))
8299 (switch-to-buffer-other-window buffer)
8300 (widen)
8301 (push-mark)
8302 (goto-char pos)
8303 (when (derived-mode-p 'org-mode)
8304 (org-show-context 'agenda)
8305 (save-excursion
8306 (and (outline-next-heading)
8307 (org-flag-heading nil)))) ; show the next heading
8308 (when (outline-invisible-p)
8309 (show-entry)) ; display invisible text
8310 (recenter (/ (window-height) 2))
8311 (run-hooks 'org-agenda-after-show-hook)
8312 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8314 (defvar org-agenda-after-show-hook nil
8315 "Normal hook run after an item has been shown from the agenda.
8316 Point is in the buffer where the item originated.")
8318 (defun org-agenda-kill ()
8319 "Kill the entry or subtree belonging to the current agenda entry."
8320 (interactive)
8321 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8322 (let* ((bufname-orig (buffer-name))
8323 (marker (or (org-get-at-bol 'org-marker)
8324 (org-agenda-error)))
8325 (buffer (marker-buffer marker))
8326 (pos (marker-position marker))
8327 (type (org-get-at-bol 'type))
8328 dbeg dend (n 0) conf)
8329 (org-with-remote-undo buffer
8330 (with-current-buffer buffer
8331 (save-excursion
8332 (goto-char pos)
8333 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8334 (setq dbeg (progn (org-back-to-heading t) (point))
8335 dend (org-end-of-subtree t t))
8336 (setq dbeg (point-at-bol)
8337 dend (min (point-max) (1+ (point-at-eol)))))
8338 (goto-char dbeg)
8339 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8340 (setq conf (or (eq t org-agenda-confirm-kill)
8341 (and (numberp org-agenda-confirm-kill)
8342 (> n org-agenda-confirm-kill))))
8343 (and conf
8344 (not (y-or-n-p
8345 (format "Delete entry with %d lines in buffer \"%s\"? "
8346 n (buffer-name buffer))))
8347 (error "Abort"))
8348 (let ((org-agenda-buffer-name bufname-orig))
8349 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8350 (with-current-buffer buffer (delete-region dbeg dend))
8351 (message "Agenda item and source killed"))))
8353 (defvar org-archive-default-command) ; defined in org-archive.el
8354 (defun org-agenda-archive-default ()
8355 "Archive the entry or subtree belonging to the current agenda entry."
8356 (interactive)
8357 (require 'org-archive)
8358 (org-agenda-archive-with org-archive-default-command))
8360 (defun org-agenda-archive-default-with-confirmation ()
8361 "Archive the entry or subtree belonging to the current agenda entry."
8362 (interactive)
8363 (require 'org-archive)
8364 (org-agenda-archive-with org-archive-default-command 'confirm))
8366 (defun org-agenda-archive ()
8367 "Archive the entry or subtree belonging to the current agenda entry."
8368 (interactive)
8369 (org-agenda-archive-with 'org-archive-subtree))
8371 (defun org-agenda-archive-to-archive-sibling ()
8372 "Move the entry to the archive sibling."
8373 (interactive)
8374 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8376 (defun org-agenda-archive-with (cmd &optional confirm)
8377 "Move the entry to the archive sibling."
8378 (interactive)
8379 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8380 (let* ((bufname-orig (buffer-name))
8381 (marker (or (org-get-at-bol 'org-marker)
8382 (org-agenda-error)))
8383 (buffer (marker-buffer marker))
8384 (pos (marker-position marker)))
8385 (org-with-remote-undo buffer
8386 (with-current-buffer buffer
8387 (if (derived-mode-p 'org-mode)
8388 (if (and confirm
8389 (not (y-or-n-p "Archive this subtree or entry? ")))
8390 (error "Abort")
8391 (save-window-excursion
8392 (goto-char pos)
8393 (let ((org-agenda-buffer-name bufname-orig))
8394 (org-remove-subtree-entries-from-agenda))
8395 (org-back-to-heading t)
8396 (funcall cmd)))
8397 (error "Archiving works only in Org-mode files"))))))
8399 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8400 "Remove all lines in the agenda that correspond to a given subtree.
8401 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8402 If this information is not given, the function uses the tree at point."
8403 (let ((buf (or buf (current-buffer))) m p)
8404 (save-excursion
8405 (unless (and beg end)
8406 (org-back-to-heading t)
8407 (setq beg (point))
8408 (org-end-of-subtree t)
8409 (setq end (point)))
8410 (set-buffer (get-buffer org-agenda-buffer-name))
8411 (save-excursion
8412 (goto-char (point-max))
8413 (beginning-of-line 1)
8414 (while (not (bobp))
8415 (when (and (setq m (org-get-at-bol 'org-marker))
8416 (equal buf (marker-buffer m))
8417 (setq p (marker-position m))
8418 (>= p beg)
8419 (< p end))
8420 (let ((inhibit-read-only t))
8421 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8422 (beginning-of-line 0))))))
8424 (defun org-agenda-refile (&optional goto rfloc no-update)
8425 "Refile the item at point.
8427 When GOTO is 0 or '(64), clear the refile cache.
8428 When GOTO is '(16), go to the location of the last refiled item.
8429 RFLOC can be a refile location obtained in a different way.
8430 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8431 (interactive "P")
8432 (cond
8433 ((member goto '(0 (64)))
8434 (org-refile-cache-clear))
8435 ((equal goto '(16))
8436 (org-refile-goto-last-stored))
8438 (let* ((buffer-orig (buffer-name))
8439 (marker (or (org-get-at-bol 'org-hd-marker)
8440 (org-agenda-error)))
8441 (buffer (marker-buffer marker))
8442 (pos (marker-position marker))
8443 (rfloc (or rfloc
8444 (org-refile-get-location
8445 (if goto "Goto" "Refile to") buffer
8446 org-refile-allow-creating-parent-nodes))))
8447 (with-current-buffer buffer
8448 (save-excursion
8449 (save-restriction
8450 (widen)
8451 (goto-char marker)
8452 (let ((org-agenda-buffer-name buffer-orig))
8453 (org-remove-subtree-entries-from-agenda))
8454 (org-refile goto buffer rfloc)))))
8455 (unless no-update (org-agenda-redo)))))
8457 (defun org-agenda-open-link (&optional arg)
8458 "Open the link(s) in the current entry, if any.
8459 This looks for a link in the displayed line in the agenda.
8460 It also looks at the text of the entry itself."
8461 (interactive "P")
8462 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8463 (org-get-at-bol 'org-marker)))
8464 (buffer (and marker (marker-buffer marker)))
8465 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8466 (lkall (and buffer (org-offer-links-in-entry
8467 buffer marker arg prefix)))
8468 (lk0 (car lkall))
8469 (lk (if (stringp lk0) (list lk0) lk0))
8470 (lkend (cdr lkall))
8471 trg)
8472 (cond
8473 ((and buffer lk)
8474 (mapcar (lambda(l)
8475 (with-current-buffer buffer
8476 (setq trg (and (string-match org-bracket-link-regexp l)
8477 (match-string 1 l)))
8478 (if (or (not trg) (string-match org-any-link-re trg))
8479 (save-excursion
8480 (save-restriction
8481 (widen)
8482 (goto-char marker)
8483 (when (search-forward l nil lkend)
8484 (goto-char (match-beginning 0))
8485 (org-open-at-point))))
8486 ;; This is an internal link, widen the buffer
8487 (switch-to-buffer-other-window buffer)
8488 (widen)
8489 (goto-char marker)
8490 (when (search-forward l nil lkend)
8491 (goto-char (match-beginning 0))
8492 (org-open-at-point)))))
8493 lk))
8494 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8495 (save-excursion
8496 (beginning-of-line 1)
8497 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8498 (org-open-link-from-string (match-string 1)))
8499 (t (message "No link to open here")))))
8501 (defun org-agenda-copy-local-variable (var)
8502 "Get a variable from a referenced buffer and install it here."
8503 (let ((m (org-get-at-bol 'org-marker)))
8504 (when (and m (buffer-live-p (marker-buffer m)))
8505 (org-set-local var (with-current-buffer (marker-buffer m)
8506 (symbol-value var))))))
8508 (defun org-agenda-switch-to (&optional delete-other-windows)
8509 "Go to the Org-mode file which contains the item at point."
8510 (interactive)
8511 (if (and org-return-follows-link
8512 (not (org-get-at-bol 'org-marker))
8513 (org-in-regexp org-bracket-link-regexp))
8514 (org-open-link-from-string (match-string 0))
8515 (let* ((marker (or (org-get-at-bol 'org-marker)
8516 (org-agenda-error)))
8517 (buffer (marker-buffer marker))
8518 (pos (marker-position marker)))
8519 (org-pop-to-buffer-same-window buffer)
8520 (and delete-other-windows (delete-other-windows))
8521 (widen)
8522 (goto-char pos)
8523 (when (derived-mode-p 'org-mode)
8524 (org-show-context 'agenda)
8525 (save-excursion
8526 (and (outline-next-heading)
8527 (org-flag-heading nil))) ; show the next heading
8528 (when (outline-invisible-p)
8529 (show-entry)) ; display invisible text
8530 (run-hooks 'org-agenda-after-show-hook)))))
8532 (defun org-agenda-goto-mouse (ev)
8533 "Go to the Org-mode file which contains the item at the mouse click."
8534 (interactive "e")
8535 (mouse-set-point ev)
8536 (org-agenda-goto))
8538 (defun org-agenda-show (&optional full-entry)
8539 "Display the Org-mode file which contains the item at point.
8540 With prefix argument FULL-ENTRY, make the entire entry visible
8541 if it was hidden in the outline."
8542 (interactive "P")
8543 (let ((win (selected-window)))
8544 (if full-entry
8545 (let ((org-show-entry-below t))
8546 (org-agenda-goto t))
8547 (org-agenda-goto t))
8548 (select-window win)))
8550 (defvar org-agenda-show-window nil)
8551 (defun org-agenda-show-and-scroll-up (&optional arg)
8552 "Display the Org-mode file which contains the item at point.
8553 When called repeatedly, scroll the window that is displaying the buffer.
8554 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8555 `show-subtree' to display the item, so that drawers and logbooks stay
8556 folded."
8557 (interactive "P")
8558 (let ((win (selected-window)))
8559 (if (and (window-live-p org-agenda-show-window)
8560 (eq this-command last-command))
8561 (progn
8562 (select-window org-agenda-show-window)
8563 (ignore-errors (scroll-up)))
8564 (org-agenda-goto t)
8565 (if arg (org-show-entry) (show-subtree))
8566 (setq org-agenda-show-window (selected-window)))
8567 (select-window win)))
8569 (defun org-agenda-show-scroll-down ()
8570 "Scroll down the window showing the agenda."
8571 (interactive)
8572 (let ((win (selected-window)))
8573 (when (window-live-p org-agenda-show-window)
8574 (select-window org-agenda-show-window)
8575 (ignore-errors (scroll-down))
8576 (select-window win))))
8578 (defun org-agenda-show-1 (&optional more)
8579 "Display the Org-mode file which contains the item at point.
8580 The prefix arg selects the amount of information to display:
8582 0 hide the subtree
8583 1 just show the entry according to defaults.
8584 2 show the children view
8585 3 show the subtree view
8586 4 show the entire subtree and any LOGBOOK drawers
8587 5 show the entire subtree and any drawers
8588 With prefix argument FULL-ENTRY, make the entire entry visible
8589 if it was hidden in the outline."
8590 (interactive "p")
8591 (let ((win (selected-window)))
8592 (org-agenda-goto t)
8593 (org-back-to-heading)
8594 (set-window-start (selected-window) (point-at-bol))
8595 (cond
8596 ((= more 0)
8597 (hide-subtree)
8598 (save-excursion
8599 (org-back-to-heading)
8600 (run-hook-with-args 'org-cycle-hook 'folded))
8601 (message "Remote: FOLDED"))
8602 ((and (org-called-interactively-p 'any) (= more 1))
8603 (message "Remote: show with default settings"))
8604 ((= more 2)
8605 (show-entry)
8606 (show-children)
8607 (save-excursion
8608 (org-back-to-heading)
8609 (run-hook-with-args 'org-cycle-hook 'children))
8610 (message "Remote: CHILDREN"))
8611 ((= more 3)
8612 (show-subtree)
8613 (save-excursion
8614 (org-back-to-heading)
8615 (run-hook-with-args 'org-cycle-hook 'subtree))
8616 (message "Remote: SUBTREE"))
8617 ((= more 4)
8618 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
8619 (org-drawer-regexp
8620 (concat "^[ \t]*:\\("
8621 (mapconcat 'regexp-quote org-drawers "\\|")
8622 "\\):[ \t]*$")))
8623 (show-subtree)
8624 (save-excursion
8625 (org-back-to-heading)
8626 (org-cycle-hide-drawers 'subtree)))
8627 (message "Remote: SUBTREE AND LOGBOOK"))
8628 ((> more 4)
8629 (show-subtree)
8630 (message "Remote: SUBTREE AND ALL DRAWERS")))
8631 (select-window win)))
8633 (defvar org-agenda-cycle-counter nil)
8634 (defun org-agenda-cycle-show (&optional n)
8635 "Show the current entry in another window, with default settings.
8636 Default settings are taken from `org-show-hierarchy-above' and siblings.
8637 When use repeatedly in immediate succession, the remote entry will cycle
8638 through visibility
8640 children -> subtree -> folded
8642 When called with a numeric prefix arg, that arg will be passed through to
8643 `org-agenda-show-1'. For the interpretation of that argument, see the
8644 docstring of `org-agenda-show-1'."
8645 (interactive "P")
8646 (if (integerp n)
8647 (setq org-agenda-cycle-counter n)
8648 (if (not (eq last-command this-command))
8649 (setq org-agenda-cycle-counter 1)
8650 (if (equal org-agenda-cycle-counter 0)
8651 (setq org-agenda-cycle-counter 2)
8652 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8653 (if (> org-agenda-cycle-counter 3)
8654 (setq org-agenda-cycle-counter 0)))))
8655 (org-agenda-show-1 org-agenda-cycle-counter))
8657 (defun org-agenda-recenter (arg)
8658 "Display the Org-mode file which contains the item at point and recenter."
8659 (interactive "P")
8660 (let ((win (selected-window)))
8661 (org-agenda-goto t)
8662 (recenter arg)
8663 (select-window win)))
8665 (defun org-agenda-show-mouse (ev)
8666 "Display the Org-mode file which contains the item at the mouse click."
8667 (interactive "e")
8668 (mouse-set-point ev)
8669 (org-agenda-show))
8671 (defun org-agenda-check-no-diary ()
8672 "Check if the entry is a diary link and abort if yes."
8673 (if (org-get-at-bol 'org-agenda-diary-link)
8674 (org-agenda-error)))
8676 (defun org-agenda-error ()
8677 (error "Command not allowed in this line"))
8679 (defun org-agenda-tree-to-indirect-buffer (arg)
8680 "Show the subtree corresponding to the current entry in an indirect buffer.
8681 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8683 With a numerical prefix ARG, go up to this level and then take that tree.
8684 With a negative numeric ARG, go up by this number of levels.
8685 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8686 use the dedicated frame)."
8687 (interactive "P")
8688 (if current-prefix-arg
8689 (org-agenda-do-tree-to-indirect-buffer arg)
8690 (let ((agenda-buffer (buffer-name))
8691 (agenda-window (selected-window))
8692 (indirect-window
8693 (and org-last-indirect-buffer
8694 (get-buffer-window org-last-indirect-buffer))))
8695 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8696 (unless (or (eq org-indirect-buffer-display 'new-frame)
8697 (eq org-indirect-buffer-display 'dedicated-frame))
8698 (unwind-protect
8699 (unless (and indirect-window (window-live-p indirect-window))
8700 (setq indirect-window (split-window agenda-window)))
8701 (and indirect-window (select-window indirect-window))
8702 (switch-to-buffer org-last-indirect-buffer :norecord)
8703 (fit-window-to-buffer indirect-window)))
8704 (select-window (get-buffer-window agenda-buffer)))))
8706 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8707 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8708 (org-agenda-check-no-diary)
8709 (let* ((marker (or (org-get-at-bol 'org-marker)
8710 (org-agenda-error)))
8711 (buffer (marker-buffer marker))
8712 (pos (marker-position marker)))
8713 (with-current-buffer buffer
8714 (save-excursion
8715 (goto-char pos)
8716 (funcall 'org-tree-to-indirect-buffer arg)))))
8718 (defvar org-last-heading-marker (make-marker)
8719 "Marker pointing to the headline that last changed its TODO state
8720 by a remote command from the agenda.")
8722 (defun org-agenda-todo-nextset ()
8723 "Switch TODO entry to next sequence."
8724 (interactive)
8725 (org-agenda-todo 'nextset))
8727 (defun org-agenda-todo-previousset ()
8728 "Switch TODO entry to previous sequence."
8729 (interactive)
8730 (org-agenda-todo 'previousset))
8732 (defun org-agenda-todo (&optional arg)
8733 "Cycle TODO state of line at point, also in Org-mode file.
8734 This changes the line at point, all other lines in the agenda referring to
8735 the same tree node, and the headline of the tree node in the Org-mode file."
8736 (interactive "P")
8737 (org-agenda-check-no-diary)
8738 (let* ((col (current-column))
8739 (marker (or (org-get-at-bol 'org-marker)
8740 (org-agenda-error)))
8741 (buffer (marker-buffer marker))
8742 (pos (marker-position marker))
8743 (hdmarker (org-get-at-bol 'org-hd-marker))
8744 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
8745 (inhibit-read-only t)
8746 org-agenda-headline-snapshot-before-repeat newhead just-one)
8747 (org-with-remote-undo buffer
8748 (with-current-buffer buffer
8749 (widen)
8750 (goto-char pos)
8751 (org-show-context 'agenda)
8752 (save-excursion
8753 (and (outline-next-heading)
8754 (org-flag-heading nil))) ; show the next heading
8755 (let ((current-prefix-arg arg))
8756 (call-interactively 'org-todo))
8757 (and (bolp) (forward-char 1))
8758 (setq newhead (org-get-heading))
8759 (when (and (org-bound-and-true-p
8760 org-agenda-headline-snapshot-before-repeat)
8761 (not (equal org-agenda-headline-snapshot-before-repeat
8762 newhead))
8763 todayp)
8764 (setq newhead org-agenda-headline-snapshot-before-repeat
8765 just-one t))
8766 (save-excursion
8767 (org-back-to-heading)
8768 (move-marker org-last-heading-marker (point))))
8769 (beginning-of-line 1)
8770 (save-window-excursion
8771 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8772 (when (org-bound-and-true-p org-clock-out-when-done)
8773 (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
8774 newhead)
8775 (org-agenda-unmark-clocking-task))
8776 (org-move-to-column col))))
8778 (defun org-agenda-add-note (&optional arg)
8779 "Add a time-stamped note to the entry at point."
8780 (interactive "P")
8781 (org-agenda-check-no-diary)
8782 (let* ((marker (or (org-get-at-bol 'org-marker)
8783 (org-agenda-error)))
8784 (buffer (marker-buffer marker))
8785 (pos (marker-position marker))
8786 (hdmarker (org-get-at-bol 'org-hd-marker))
8787 (inhibit-read-only t))
8788 (with-current-buffer buffer
8789 (widen)
8790 (goto-char pos)
8791 (org-show-context 'agenda)
8792 (save-excursion
8793 (and (outline-next-heading)
8794 (org-flag-heading nil))) ; show the next heading
8795 (org-add-note))))
8797 (defun org-agenda-change-all-lines (newhead hdmarker
8798 &optional fixface just-this)
8799 "Change all lines in the agenda buffer which match HDMARKER.
8800 The new content of the line will be NEWHEAD (as modified by
8801 `org-agenda-format-item'). HDMARKER is checked with
8802 `equal' against all `org-hd-marker' text properties in the file.
8803 If FIXFACE is non-nil, the face of each item is modified according to
8804 the new TODO state.
8805 If JUST-THIS is non-nil, change just the current line, not all.
8806 If FORCE-TAGS is non nil, the car of it returns the new tags."
8807 (let* ((inhibit-read-only t)
8808 (line (org-current-line))
8809 (org-agenda-buffer (current-buffer))
8810 (thetags (with-current-buffer (marker-buffer hdmarker)
8811 (save-excursion (save-restriction (widen)
8812 (goto-char hdmarker)
8813 (org-get-tags-at)))))
8814 props m pl undone-face done-face finish new dotime level cat tags)
8815 (save-excursion
8816 (goto-char (point-max))
8817 (beginning-of-line 1)
8818 (while (not finish)
8819 (setq finish (bobp))
8820 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8821 (or (not just-this) (= (org-current-line) line))
8822 (equal m hdmarker))
8823 (setq props (text-properties-at (point))
8824 dotime (org-get-at-bol 'dotime)
8825 cat (org-get-at-bol 'org-category)
8826 level (org-get-at-bol 'level)
8827 tags thetags
8829 (let ((org-prefix-format-compiled
8830 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8831 org-prefix-format-compiled))
8832 (extra (org-get-at-bol 'extra)))
8833 (with-current-buffer (marker-buffer hdmarker)
8834 (save-excursion
8835 (save-restriction
8836 (widen)
8837 (org-agenda-format-item extra newhead level cat tags dotime)))))
8838 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8839 undone-face (org-get-at-bol 'undone-face)
8840 done-face (org-get-at-bol 'done-face))
8841 (beginning-of-line 1)
8842 (cond
8843 ((equal new "")
8844 (and (looking-at ".*\n?") (replace-match "")))
8845 ((looking-at ".*")
8846 (replace-match new t t)
8847 (beginning-of-line 1)
8848 (add-text-properties (point-at-bol) (point-at-eol) props)
8849 (when fixface
8850 (add-text-properties
8851 (point-at-bol) (point-at-eol)
8852 (list 'face
8853 (if org-last-todo-state-is-todo
8854 undone-face done-face))))
8855 (org-agenda-highlight-todo 'line)
8856 (beginning-of-line 1))
8857 (t (error "Line update did not work")))
8858 (save-restriction
8859 (narrow-to-region (point-at-bol) (point-at-eol))
8860 (org-agenda-finalize)))
8861 (beginning-of-line 0)))))
8863 (defun org-agenda-align-tags (&optional line)
8864 "Align all tags in agenda items to `org-agenda-tags-column'."
8865 (let ((inhibit-read-only t) l c)
8866 (save-excursion
8867 (goto-char (if line (point-at-bol) (point-min)))
8868 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8869 (if line (point-at-eol) nil) t)
8870 (add-text-properties
8871 (match-beginning 2) (match-end 2)
8872 (list 'face (delq nil (let ((prop (get-text-property
8873 (match-beginning 2) 'face)))
8874 (or (listp prop) (setq prop (list prop)))
8875 (if (memq 'org-tag prop)
8876 prop
8877 (cons 'org-tag prop))))))
8878 (setq l (- (match-end 2) (match-beginning 2))
8879 c (if (< org-agenda-tags-column 0)
8880 (- (abs org-agenda-tags-column) l)
8881 org-agenda-tags-column))
8882 (delete-region (match-beginning 1) (match-end 1))
8883 (goto-char (match-beginning 1))
8884 (insert (org-add-props
8885 (make-string (max 1 (- c (current-column))) ?\ )
8886 (plist-put (copy-sequence (text-properties-at (point)))
8887 'face nil))))
8888 (goto-char (point-min))
8889 (org-font-lock-add-tag-faces (point-max)))))
8891 (defun org-agenda-priority-up ()
8892 "Increase the priority of line at point, also in Org-mode file."
8893 (interactive)
8894 (org-agenda-priority 'up))
8896 (defun org-agenda-priority-down ()
8897 "Decrease the priority of line at point, also in Org-mode file."
8898 (interactive)
8899 (org-agenda-priority 'down))
8901 (defun org-agenda-priority (&optional force-direction)
8902 "Set the priority of line at point, also in Org-mode file.
8903 This changes the line at point, all other lines in the agenda referring to
8904 the same tree node, and the headline of the tree node in the Org-mode file.
8905 Called with a universal prefix arg, show the priority instead of setting it."
8906 (interactive "P")
8907 (if (equal force-direction '(4))
8908 (org-show-priority)
8909 (unless org-enable-priority-commands
8910 (error "Priority commands are disabled"))
8911 (org-agenda-check-no-diary)
8912 (let* ((col (current-column))
8913 (marker (or (org-get-at-bol 'org-marker)
8914 (org-agenda-error)))
8915 (hdmarker (org-get-at-bol 'org-hd-marker))
8916 (buffer (marker-buffer hdmarker))
8917 (pos (marker-position hdmarker))
8918 (inhibit-read-only t)
8919 newhead)
8920 (org-with-remote-undo buffer
8921 (with-current-buffer buffer
8922 (widen)
8923 (goto-char pos)
8924 (org-show-context 'agenda)
8925 (save-excursion
8926 (and (outline-next-heading)
8927 (org-flag-heading nil))) ; show the next heading
8928 (funcall 'org-priority force-direction)
8929 (end-of-line 1)
8930 (setq newhead (org-get-heading)))
8931 (org-agenda-change-all-lines newhead hdmarker)
8932 (org-move-to-column col)))))
8934 ;; FIXME: should fix the tags property of the agenda line.
8935 (defun org-agenda-set-tags (&optional tag onoff)
8936 "Set tags for the current headline."
8937 (interactive)
8938 (org-agenda-check-no-diary)
8939 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8940 (call-interactively 'org-change-tag-in-region)
8941 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8942 (org-agenda-error)))
8943 (buffer (marker-buffer hdmarker))
8944 (pos (marker-position hdmarker))
8945 (inhibit-read-only t)
8946 newhead)
8947 (org-with-remote-undo buffer
8948 (with-current-buffer buffer
8949 (widen)
8950 (goto-char pos)
8951 (save-excursion
8952 (org-show-context 'agenda))
8953 (save-excursion
8954 (and (outline-next-heading)
8955 (org-flag-heading nil))) ; show the next heading
8956 (goto-char pos)
8957 (if tag
8958 (org-toggle-tag tag onoff)
8959 (call-interactively 'org-set-tags))
8960 (end-of-line 1)
8961 (setq newhead (org-get-heading)))
8962 (org-agenda-change-all-lines newhead hdmarker)
8963 (beginning-of-line 1)))))
8965 (defun org-agenda-set-property ()
8966 "Set a property for the current headline."
8967 (interactive)
8968 (org-agenda-check-no-diary)
8969 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8970 (org-agenda-error)))
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 (save-excursion
8980 (org-show-context 'agenda))
8981 (save-excursion
8982 (and (outline-next-heading)
8983 (org-flag-heading nil))) ; show the next heading
8984 (goto-char pos)
8985 (call-interactively 'org-set-property)))))
8987 (defun org-agenda-set-effort ()
8988 "Set the effort property for the current headline."
8989 (interactive)
8990 (org-agenda-check-no-diary)
8991 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8992 (org-agenda-error)))
8993 (buffer (marker-buffer hdmarker))
8994 (pos (marker-position hdmarker))
8995 (inhibit-read-only t)
8996 newhead)
8997 (org-with-remote-undo buffer
8998 (with-current-buffer buffer
8999 (widen)
9000 (goto-char pos)
9001 (save-excursion
9002 (org-show-context 'agenda))
9003 (save-excursion
9004 (and (outline-next-heading)
9005 (org-flag-heading nil))) ; show the next heading
9006 (goto-char pos)
9007 (call-interactively 'org-set-effort)
9008 (end-of-line 1)
9009 (setq newhead (org-get-heading)))
9010 (org-agenda-change-all-lines newhead hdmarker))))
9012 (defun org-agenda-toggle-archive-tag ()
9013 "Toggle the archive tag for the current entry."
9014 (interactive)
9015 (org-agenda-check-no-diary)
9016 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9017 (org-agenda-error)))
9018 (buffer (marker-buffer hdmarker))
9019 (pos (marker-position hdmarker))
9020 (inhibit-read-only t)
9021 newhead)
9022 (org-with-remote-undo buffer
9023 (with-current-buffer buffer
9024 (widen)
9025 (goto-char pos)
9026 (org-show-context 'agenda)
9027 (save-excursion
9028 (and (outline-next-heading)
9029 (org-flag-heading nil))) ; show the next heading
9030 (call-interactively 'org-toggle-archive-tag)
9031 (end-of-line 1)
9032 (setq newhead (org-get-heading)))
9033 (org-agenda-change-all-lines newhead hdmarker)
9034 (beginning-of-line 1))))
9036 (defun org-agenda-do-date-later (arg)
9037 (interactive "P")
9038 (cond
9039 ((or (equal arg '(16))
9040 (memq last-command
9041 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9042 (setq this-command 'org-agenda-date-later-minutes)
9043 (org-agenda-date-later-minutes 1))
9044 ((or (equal arg '(4))
9045 (memq last-command
9046 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9047 (setq this-command 'org-agenda-date-later-hours)
9048 (org-agenda-date-later-hours 1))
9050 (org-agenda-date-later (prefix-numeric-value arg)))))
9052 (defun org-agenda-do-date-earlier (arg)
9053 (interactive "P")
9054 (cond
9055 ((or (equal arg '(16))
9056 (memq last-command
9057 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9058 (setq this-command 'org-agenda-date-earlier-minutes)
9059 (org-agenda-date-earlier-minutes 1))
9060 ((or (equal arg '(4))
9061 (memq last-command
9062 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9063 (setq this-command 'org-agenda-date-earlier-hours)
9064 (org-agenda-date-earlier-hours 1))
9066 (org-agenda-date-earlier (prefix-numeric-value arg)))))
9068 (defun org-agenda-date-later (arg &optional what)
9069 "Change the date of this item to ARG day(s) later."
9070 (interactive "p")
9071 (org-agenda-check-type t 'agenda 'timeline)
9072 (org-agenda-check-no-diary)
9073 (let* ((marker (or (org-get-at-bol 'org-marker)
9074 (org-agenda-error)))
9075 (buffer (marker-buffer marker))
9076 (pos (marker-position marker))
9077 cdate today)
9078 (org-with-remote-undo buffer
9079 (with-current-buffer buffer
9080 (widen)
9081 (goto-char pos)
9082 (if (not (org-at-timestamp-p))
9083 (error "Cannot find time stamp"))
9084 (when (and org-agenda-move-date-from-past-immediately-to-today
9085 (equal arg 1)
9086 (or (not what) (eq what 'day))
9087 (not (save-match-data (org-at-date-range-p))))
9088 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
9089 cdate (calendar-absolute-from-gregorian
9090 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
9091 today (org-today))
9092 (if (> today cdate)
9093 ;; immediately shift to today
9094 (setq arg (- today cdate))))
9095 (org-timestamp-change arg (or what 'day))
9096 (when (and (org-at-date-range-p)
9097 (re-search-backward org-tr-regexp-both (point-at-bol)))
9098 (let ((end org-last-changed-timestamp))
9099 (org-timestamp-change arg (or what 'day))
9100 (setq org-last-changed-timestamp
9101 (concat org-last-changed-timestamp "--" end)))))
9102 (org-agenda-show-new-time marker org-last-changed-timestamp))
9103 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9105 (defun org-agenda-date-earlier (arg &optional what)
9106 "Change the date of this item to ARG day(s) earlier."
9107 (interactive "p")
9108 (org-agenda-date-later (- arg) what))
9110 (defun org-agenda-date-later-minutes (arg)
9111 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9112 (interactive "p")
9113 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9114 (org-agenda-date-later arg 'minute))
9116 (defun org-agenda-date-earlier-minutes (arg)
9117 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9118 (interactive "p")
9119 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9120 (org-agenda-date-earlier arg 'minute))
9122 (defun org-agenda-date-later-hours (arg)
9123 "Change the time of this item, in hour steps."
9124 (interactive "p")
9125 (org-agenda-date-later arg 'hour))
9127 (defun org-agenda-date-earlier-hours (arg)
9128 "Change the time of this item, in hour steps."
9129 (interactive "p")
9130 (org-agenda-date-earlier arg 'hour))
9132 (defun org-agenda-show-new-time (marker stamp &optional prefix)
9133 "Show new date stamp via text properties."
9134 ;; We use text properties to make this undoable
9135 (let ((inhibit-read-only t))
9136 (setq stamp (concat prefix " => " stamp " "))
9137 (save-excursion
9138 (goto-char (point-max))
9139 (while (not (bobp))
9140 (when (equal marker (org-get-at-bol 'org-marker))
9141 (remove-text-properties (point-at-bol) (point-at-eol) '(display))
9142 (org-move-to-column (- (window-width) (length stamp)) t)
9143 (if (featurep 'xemacs)
9144 ;; Use `duplicable' property to trigger undo recording
9145 (let ((ex (make-extent nil nil))
9146 (gl (make-glyph stamp)))
9147 (set-glyph-face gl 'secondary-selection)
9148 (set-extent-properties
9149 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9150 (insert-extent ex (1- (point)) (point-at-eol)))
9151 (add-text-properties
9152 (1- (point)) (point-at-eol)
9153 (list 'display (org-add-props stamp nil
9154 'face '(secondary-selection default)))))
9155 (beginning-of-line 1))
9156 (beginning-of-line 0)))))
9158 (defun org-agenda-date-prompt (arg)
9159 "Change the date of this item. Date is prompted for, with default today.
9160 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9161 be used to request time specification in the time stamp."
9162 (interactive "P")
9163 (org-agenda-check-type t 'agenda 'timeline)
9164 (org-agenda-check-no-diary)
9165 (let* ((marker (or (org-get-at-bol 'org-marker)
9166 (org-agenda-error)))
9167 (buffer (marker-buffer marker))
9168 (pos (marker-position marker)))
9169 (org-with-remote-undo buffer
9170 (with-current-buffer buffer
9171 (widen)
9172 (goto-char pos)
9173 (if (not (org-at-timestamp-p t))
9174 (error "Cannot find time stamp"))
9175 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9176 (org-agenda-show-new-time marker org-last-changed-timestamp))
9177 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9179 (defun org-agenda-schedule (arg &optional time)
9180 "Schedule the item at point.
9181 ARG is passed through to `org-schedule'."
9182 (interactive "P")
9183 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9184 (org-agenda-check-no-diary)
9185 (let* ((marker (or (org-get-at-bol 'org-marker)
9186 (org-agenda-error)))
9187 (type (marker-insertion-type marker))
9188 (buffer (marker-buffer marker))
9189 (pos (marker-position marker))
9190 (org-insert-labeled-timestamps-at-point nil)
9192 (set-marker-insertion-type marker t)
9193 (org-with-remote-undo buffer
9194 (with-current-buffer buffer
9195 (widen)
9196 (goto-char pos)
9197 (setq ts (org-schedule arg time)))
9198 (org-agenda-show-new-time marker ts " S"))
9199 (message "%s" ts)))
9201 (defun org-agenda-deadline (arg &optional time)
9202 "Schedule the item at point.
9203 ARG is passed through to `org-deadline'."
9204 (interactive "P")
9205 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9206 (org-agenda-check-no-diary)
9207 (let* ((marker (or (org-get-at-bol 'org-marker)
9208 (org-agenda-error)))
9209 (buffer (marker-buffer marker))
9210 (pos (marker-position marker))
9211 (org-insert-labeled-timestamps-at-point nil)
9213 (org-with-remote-undo buffer
9214 (with-current-buffer buffer
9215 (widen)
9216 (goto-char pos)
9217 (setq ts (org-deadline arg time)))
9218 (org-agenda-show-new-time marker ts " D"))
9219 (message "%s" ts)))
9221 (defun org-agenda-clock-in (&optional arg)
9222 "Start the clock on the currently selected item."
9223 (interactive "P")
9224 (org-agenda-check-no-diary)
9225 (if (equal arg '(4))
9226 (org-clock-in arg)
9227 (let* ((marker (or (org-get-at-bol 'org-marker)
9228 (org-agenda-error)))
9229 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9230 (pos (marker-position marker))
9231 (col (current-column))
9232 newhead)
9233 (org-with-remote-undo (marker-buffer marker)
9234 (with-current-buffer (marker-buffer marker)
9235 (widen)
9236 (goto-char pos)
9237 (org-show-context 'agenda)
9238 (org-show-entry)
9239 (org-cycle-hide-drawers 'children)
9240 (org-clock-in arg)
9241 (setq newhead (org-get-heading)))
9242 (org-agenda-change-all-lines newhead hdmarker))
9243 (org-move-to-column col))))
9245 (defun org-agenda-clock-out ()
9246 "Stop the currently running clock."
9247 (interactive)
9248 (unless (marker-buffer org-clock-marker)
9249 (error "No running clock"))
9250 (let ((marker (make-marker)) (col (current-column)) newhead)
9251 (org-with-remote-undo (marker-buffer org-clock-marker)
9252 (with-current-buffer (marker-buffer org-clock-marker)
9253 (save-excursion
9254 (save-restriction
9255 (widen)
9256 (goto-char org-clock-marker)
9257 (org-back-to-heading t)
9258 (move-marker marker (point))
9259 (org-clock-out)
9260 (setq newhead (org-get-heading))))))
9261 (org-agenda-change-all-lines newhead marker)
9262 (move-marker marker nil)
9263 (org-move-to-column col)
9264 (org-agenda-unmark-clocking-task)))
9266 (defun org-agenda-clock-cancel (&optional arg)
9267 "Cancel the currently running clock."
9268 (interactive "P")
9269 (unless (marker-buffer org-clock-marker)
9270 (user-error "No running clock"))
9271 (org-with-remote-undo (marker-buffer org-clock-marker)
9272 (org-clock-cancel)))
9274 (defun org-agenda-clock-goto ()
9275 "Jump to the currently clocked in task within the agenda.
9276 If the currently clocked in task is not listed in the agenda
9277 buffer, display it in another window."
9278 (interactive)
9279 (let (pos)
9280 (mapc (lambda (o)
9281 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9282 (setq pos (overlay-start o))))
9283 (overlays-in (point-min) (point-max)))
9284 (cond (pos (goto-char pos))
9285 ;; If the currently clocked entry is not in the agenda
9286 ;; buffer, we visit it in another window:
9287 (org-clock-current-task
9288 (org-switch-to-buffer-other-window (org-clock-goto)))
9289 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9291 (defun org-agenda-diary-entry-in-org-file ()
9292 "Make a diary entry in the file `org-agenda-diary-file'."
9293 (let (d1 d2 char (text "") dp1 dp2)
9294 (if (equal (buffer-name) "*Calendar*")
9295 (setq d1 (calendar-cursor-to-date t)
9296 d2 (car calendar-mark-ring))
9297 (setq dp1 (get-text-property (point-at-bol) 'day))
9298 (unless dp1 (user-error "No date defined in current line"))
9299 (setq d1 (calendar-gregorian-from-absolute dp1)
9300 d2 (and (ignore-errors (mark))
9301 (save-excursion
9302 (goto-char (mark))
9303 (setq dp2 (get-text-property (point-at-bol) 'day)))
9304 (calendar-gregorian-from-absolute dp2))))
9305 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9306 (setq char (read-char-exclusive))
9307 (cond
9308 ((equal char ?d)
9309 (setq text (read-string "Day entry: "))
9310 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9311 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9312 ((equal char ?a)
9313 (setq d1 (list (car d1) (nth 1 d1)
9314 (read-number (format "Reference year [%d]: " (nth 2 d1))
9315 (nth 2 d1))))
9316 (setq text (read-string "Anniversary (use %d to show years): "))
9317 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9318 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9319 ((equal char ?b)
9320 (setq text (read-string "Block entry: "))
9321 (unless (and d1 d2 (not (equal d1 d2)))
9322 (user-error "No block of days selected"))
9323 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9324 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9325 ((equal char ?j)
9326 (org-switch-to-buffer-other-window
9327 (find-file-noselect org-agenda-diary-file))
9328 (require 'org-datetree)
9329 (org-datetree-find-date-create d1)
9330 (org-reveal t))
9331 (t (user-error "Invalid selection character `%c'" char)))))
9333 (defcustom org-agenda-insert-diary-strategy 'date-tree
9334 "Where in `org-agenda-diary-file' should new entries be added?
9335 Valid values:
9337 date-tree in the date tree, as child of the date
9338 top-level as top-level entries at the end of the file."
9339 :group 'org-agenda
9340 :type '(choice
9341 (const :tag "in a date tree" date-tree)
9342 (const :tag "as top level at end of file" top-level)))
9344 (defcustom org-agenda-insert-diary-extract-time nil
9345 "Non-nil means extract any time specification from the diary entry."
9346 :group 'org-agenda
9347 :version "24.1"
9348 :type 'boolean)
9350 (defcustom org-agenda-bulk-mark-char ">"
9351 "A single-character string to be used as the bulk mark."
9352 :group 'org-agenda
9353 :version "24.1"
9354 :type 'string)
9356 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9357 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9358 If TEXT is not empty, it will become the headline of the new entry, and
9359 the resulting entry will not be shown. When TEXT is empty, switch to
9360 `org-agenda-diary-file' and let the user finish the entry there."
9361 (let ((cw (current-window-configuration)))
9362 (org-switch-to-buffer-other-window
9363 (find-file-noselect org-agenda-diary-file))
9364 (widen)
9365 (goto-char (point-min))
9366 (cond
9367 ((eq type 'anniversary)
9368 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9369 (progn
9370 (or (org-at-heading-p t)
9371 (progn
9372 (outline-next-heading)
9373 (insert "* Anniversaries\n\n")
9374 (beginning-of-line -1)))))
9375 (outline-next-heading)
9376 (org-back-over-empty-lines)
9377 (backward-char 1)
9378 (insert "\n")
9379 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9380 (nth 2 d1) (car d1) (nth 1 d1) text)))
9381 ((eq type 'day)
9382 (let ((org-prefix-has-time t)
9383 (org-agenda-time-leading-zero t)
9384 fmt time time2)
9385 (if org-agenda-insert-diary-extract-time
9386 ;; Use org-agenda-format-item to parse text for a time-range and
9387 ;; remove it. FIXME: This is a hack, we should refactor
9388 ;; that function to make time extraction available separately
9389 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9390 time (get-text-property 0 'time fmt)
9391 time2 (if (> (length time) 0)
9392 ;; split-string removes trailing ...... if
9393 ;; no end time given. First space
9394 ;; separates time from date.
9395 (concat " " (car (split-string time "\\.")))
9396 nil)
9397 text (get-text-property 0 'txt fmt)))
9398 (if (eq org-agenda-insert-diary-strategy 'top-level)
9399 (org-agenda-insert-diary-as-top-level text)
9400 (require 'org-datetree)
9401 (org-datetree-find-date-create d1)
9402 (org-agenda-insert-diary-make-new-entry text))
9403 (org-insert-time-stamp (org-time-from-absolute
9404 (calendar-absolute-from-gregorian d1))
9405 nil nil nil nil time2))
9406 (end-of-line 0))
9407 ((eq type 'block)
9408 (if (> (calendar-absolute-from-gregorian d1)
9409 (calendar-absolute-from-gregorian d2))
9410 (setq d1 (prog1 d2 (setq d2 d1))))
9411 (if (eq org-agenda-insert-diary-strategy 'top-level)
9412 (org-agenda-insert-diary-as-top-level text)
9413 (require 'org-datetree)
9414 (org-datetree-find-date-create d1)
9415 (org-agenda-insert-diary-make-new-entry text))
9416 (org-insert-time-stamp (org-time-from-absolute
9417 (calendar-absolute-from-gregorian d1)))
9418 (insert "--")
9419 (org-insert-time-stamp (org-time-from-absolute
9420 (calendar-absolute-from-gregorian d2)))
9421 (end-of-line 0)))
9422 (if (string-match "\\S-" text)
9423 (progn
9424 (set-window-configuration cw)
9425 (message "%s entry added to %s"
9426 (capitalize (symbol-name type))
9427 (abbreviate-file-name org-agenda-diary-file)))
9428 (org-reveal t)
9429 (message "Please finish entry here"))))
9431 (defun org-agenda-insert-diary-as-top-level (text)
9432 "Make new entry as a top-level entry at the end of the file.
9433 Add TEXT as headline, and position the cursor in the second line so that
9434 a timestamp can be added there."
9435 (widen)
9436 (goto-char (point-max))
9437 (or (bolp) (insert "\n"))
9438 (insert "* " text "\n")
9439 (if org-adapt-indentation (org-indent-to-column 2)))
9441 (defun org-agenda-insert-diary-make-new-entry (text)
9442 "Make a new entry with TEXT as the first child of the current subtree.
9443 Position the point in the line right after the new heading so
9444 that a timestamp can be added there."
9445 (let ((org-show-following-heading t)
9446 (org-show-siblings t)
9447 (org-show-hierarchy-above t)
9448 (org-show-entry-below t)
9449 col)
9450 (outline-next-heading)
9451 (org-back-over-empty-lines)
9452 (or (looking-at "[ \t]*$")
9453 (progn (insert "\n") (backward-char 1)))
9454 (org-insert-heading nil t)
9455 (org-do-demote)
9456 (setq col (current-column))
9457 (insert text "\n")
9458 (if org-adapt-indentation (org-indent-to-column col))
9459 (let ((org-show-following-heading t)
9460 (org-show-siblings t)
9461 (org-show-hierarchy-above t)
9462 (org-show-entry-below t))
9463 (org-show-context))))
9465 (defun org-agenda-diary-entry ()
9466 "Make a diary entry, like the `i' command from the calendar.
9467 All the standard commands work: block, weekly etc.
9468 When `org-agenda-diary-file' points to a file,
9469 `org-agenda-diary-entry-in-org-file' is called instead to create
9470 entries in that Org-mode file."
9471 (interactive)
9472 (if (not (eq org-agenda-diary-file 'diary-file))
9473 (org-agenda-diary-entry-in-org-file)
9474 (require 'diary-lib)
9475 (let* ((char (progn
9476 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9477 (read-char-exclusive)))
9478 (cmd (cdr (assoc char
9479 '((?d . insert-diary-entry)
9480 (?w . insert-weekly-diary-entry)
9481 (?m . insert-monthly-diary-entry)
9482 (?y . insert-yearly-diary-entry)
9483 (?a . insert-anniversary-diary-entry)
9484 (?b . insert-block-diary-entry)
9485 (?c . insert-cyclic-diary-entry)))))
9486 (oldf (symbol-function 'calendar-cursor-to-date))
9487 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9488 (point (point))
9489 (mark (or (mark t) (point))))
9490 (unless cmd
9491 (user-error "No command associated with <%c>" char))
9492 (unless (and (get-text-property point 'day)
9493 (or (not (equal ?b char))
9494 (get-text-property mark 'day)))
9495 (user-error "Don't know which date to use for diary entry"))
9496 ;; We implement this by hacking the `calendar-cursor-to-date' function
9497 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9498 (let ((calendar-mark-ring
9499 (list (calendar-gregorian-from-absolute
9500 (or (get-text-property mark 'day)
9501 (get-text-property point 'day))))))
9502 (unwind-protect
9503 (progn
9504 (fset 'calendar-cursor-to-date
9505 (lambda (&optional error dummy)
9506 (calendar-gregorian-from-absolute
9507 (get-text-property point 'day))))
9508 (call-interactively cmd))
9509 (fset 'calendar-cursor-to-date oldf))))))
9511 (defun org-agenda-execute-calendar-command (cmd)
9512 "Execute a calendar command from the agenda with date from cursor."
9513 (org-agenda-check-type t 'agenda 'timeline)
9514 (require 'diary-lib)
9515 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9516 (user-error "Don't know which date to use for the calendar command"))
9517 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9518 (point (point))
9519 (date (calendar-gregorian-from-absolute
9520 (get-text-property point 'day)))
9521 ;; the following 2 vars are needed in the calendar
9522 (displayed-month (car date))
9523 (displayed-year (nth 2 date)))
9524 (unwind-protect
9525 (progn
9526 (fset 'calendar-cursor-to-date
9527 (lambda (&optional error dummy)
9528 (calendar-gregorian-from-absolute
9529 (get-text-property point 'day))))
9530 (call-interactively cmd))
9531 (fset 'calendar-cursor-to-date oldf))))
9533 (defun org-agenda-phases-of-moon ()
9534 "Display the phases of the moon for the 3 months around the cursor date."
9535 (interactive)
9536 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
9538 (defun org-agenda-holidays ()
9539 "Display the holidays for the 3 months around the cursor date."
9540 (interactive)
9541 (org-agenda-execute-calendar-command 'list-calendar-holidays))
9543 (defvar calendar-longitude) ; defined in calendar.el
9544 (defvar calendar-latitude) ; defined in calendar.el
9545 (defvar calendar-location-name) ; defined in calendar.el
9547 (defun org-agenda-sunrise-sunset (arg)
9548 "Display sunrise and sunset for the cursor date.
9549 Latitude and longitude can be specified with the variables
9550 `calendar-latitude' and `calendar-longitude'. When called with prefix
9551 argument, latitude and longitude will be prompted for."
9552 (interactive "P")
9553 (require 'solar)
9554 (let ((calendar-longitude (if arg nil calendar-longitude))
9555 (calendar-latitude (if arg nil calendar-latitude))
9556 (calendar-location-name
9557 (if arg "the given coordinates" calendar-location-name)))
9558 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9560 (defun org-agenda-goto-calendar ()
9561 "Open the Emacs calendar with the date at the cursor."
9562 (interactive)
9563 (org-agenda-check-type t 'agenda 'timeline)
9564 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9565 (user-error "Don't know which date to open in calendar")))
9566 (date (calendar-gregorian-from-absolute day))
9567 (calendar-move-hook nil)
9568 (calendar-view-holidays-initially-flag nil)
9569 (calendar-view-diary-initially-flag nil))
9570 (calendar)
9571 (calendar-goto-date date)))
9573 ;;;###autoload
9574 (defun org-calendar-goto-agenda ()
9575 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9576 This is a command that has to be installed in `calendar-mode-map'."
9577 (interactive)
9578 (org-agenda-list nil (calendar-absolute-from-gregorian
9579 (calendar-cursor-to-date))
9580 nil))
9582 (defun org-agenda-convert-date ()
9583 (interactive)
9584 (org-agenda-check-type t 'agenda 'timeline)
9585 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9586 date s)
9587 (unless day
9588 (user-error "Don't know which date to convert"))
9589 (setq date (calendar-gregorian-from-absolute day))
9590 (setq s (concat
9591 "Gregorian: " (calendar-date-string date) "\n"
9592 "ISO: " (calendar-iso-date-string date) "\n"
9593 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9594 "Julian: " (calendar-julian-date-string date) "\n"
9595 "Astron. JD: " (calendar-astro-date-string date)
9596 " (Julian date number at noon UTC)\n"
9597 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9598 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9599 "French: " (calendar-french-date-string date) "\n"
9600 "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
9601 "Mayan: " (calendar-mayan-date-string date) "\n"
9602 "Coptic: " (calendar-coptic-date-string date) "\n"
9603 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9604 "Persian: " (calendar-persian-date-string date) "\n"
9605 "Chinese: " (calendar-chinese-date-string date) "\n"))
9606 (with-output-to-temp-buffer "*Dates*"
9607 (princ s))
9608 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9610 ;;; Bulk commands
9612 (defun org-agenda-bulk-marked-p ()
9613 (eq (get-char-property (point-at-bol) 'type)
9614 'org-marked-entry-overlay))
9616 (defun org-agenda-bulk-mark (&optional arg)
9617 "Mark the entry at point for future bulk action."
9618 (interactive "p")
9619 (dotimes (i (or arg 1))
9620 (unless (org-get-at-bol 'org-agenda-diary-link)
9621 (let* ((m (org-get-at-bol 'org-hd-marker))
9623 (unless (org-agenda-bulk-marked-p)
9624 (unless m (user-error "Nothing to mark at point"))
9625 (push m org-agenda-bulk-marked-entries)
9626 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9627 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9628 (org-get-todo-face "TODO")
9629 'evaporate)
9630 (overlay-put ov 'type 'org-marked-entry-overlay))
9631 (end-of-line 1)
9632 (or (ignore-errors
9633 (goto-char (next-single-property-change (point) 'org-hd-marker)))
9634 (beginning-of-line 2))
9635 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9636 (beginning-of-line 2))
9637 (message "%d entries marked for bulk action"
9638 (length org-agenda-bulk-marked-entries))))))
9640 (defun org-agenda-bulk-mark-all ()
9641 "Mark all entries for future agenda bulk action."
9642 (interactive)
9643 (org-agenda-bulk-mark-regexp "."))
9645 (defun org-agenda-bulk-mark-regexp (regexp)
9646 "Mark entries matching REGEXP for future agenda bulk action."
9647 (interactive "sMark entries matching regexp: ")
9648 (let ((entries-marked 0) txt-at-point)
9649 (save-excursion
9650 (goto-char (point-min))
9651 (goto-char (next-single-property-change (point) 'org-hd-marker))
9652 (while (and (re-search-forward regexp nil t)
9653 (setq txt-at-point (get-text-property (point) 'txt)))
9654 (when (string-match regexp txt-at-point)
9655 (setq entries-marked (1+ entries-marked))
9656 (call-interactively 'org-agenda-bulk-mark))))
9657 (if (not entries-marked)
9658 (message "No entry matching this regexp."))))
9660 (defun org-agenda-bulk-unmark (&optional arg)
9661 "Unmark the entry at point for future bulk action."
9662 (interactive "P")
9663 (if arg
9664 (org-agenda-bulk-unmark-all)
9665 (cond ((org-agenda-bulk-marked-p)
9666 (org-agenda-bulk-remove-overlays
9667 (point-at-bol) (+ 2 (point-at-bol)))
9668 (setq org-agenda-bulk-marked-entries
9669 (delete (org-get-at-bol 'org-hd-marker)
9670 org-agenda-bulk-marked-entries))
9671 (end-of-line 1)
9672 (or (ignore-errors
9673 (goto-char (next-single-property-change (point) 'txt)))
9674 (beginning-of-line 2))
9675 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9676 (beginning-of-line 2))
9677 (message "%d entries left marked for bulk action"
9678 (length org-agenda-bulk-marked-entries)))
9679 (t (message "No entry to unmark here")))))
9681 (defun org-agenda-bulk-toggle-all ()
9682 "Toggle all marks for bulk action."
9683 (interactive)
9684 (save-excursion
9685 (goto-char (point-min))
9686 (while (ignore-errors
9687 (goto-char (next-single-property-change (point) 'org-hd-marker)))
9688 (org-agenda-bulk-toggle))))
9690 (defun org-agenda-bulk-toggle ()
9691 "Toggle the mark at point for bulk action."
9692 (interactive)
9693 (if (org-agenda-bulk-marked-p)
9694 (org-agenda-bulk-unmark)
9695 (org-agenda-bulk-mark)))
9697 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9698 "Remove the mark overlays between BEG and END in the agenda buffer.
9699 BEG and END default to the buffer limits.
9701 This only removes the overlays, it does not remove the markers
9702 from the list in `org-agenda-bulk-marked-entries'."
9703 (interactive)
9704 (mapc (lambda (ov)
9705 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9706 (delete-overlay ov)))
9707 (overlays-in (or beg (point-min)) (or end (point-max)))))
9709 (defun org-agenda-bulk-unmark-all ()
9710 "Remove all marks in the agenda buffer.
9711 This will remove the markers and the overlays."
9712 (interactive)
9713 (if (null org-agenda-bulk-marked-entries)
9714 (message "No entry to unmark")
9715 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9716 (setq org-agenda-bulk-marked-entries nil)
9717 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9719 (defcustom org-agenda-persistent-marks nil
9720 "Non-nil means marked items will stay marked after a bulk action.
9721 You can toggle this interactively by typing `p' when prompted for a
9722 bulk action."
9723 :group 'org-agenda
9724 :version "24.1"
9725 :type 'boolean)
9727 (defun org-agenda-bulk-action (&optional arg)
9728 "Execute an remote-editing action on all marked entries.
9729 The prefix arg is passed through to the command if possible."
9730 (interactive "P")
9731 ;; Make sure we have markers, and only valid ones
9732 (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
9733 (mapc
9734 (lambda (m)
9735 (unless (and (markerp m)
9736 (marker-buffer m)
9737 (buffer-live-p (marker-buffer m))
9738 (marker-position m))
9739 (user-error "Marker %s for bulk command is invalid" m)))
9740 org-agenda-bulk-marked-entries)
9742 ;; Prompt for the bulk command
9743 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9744 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9745 "[S]catter [f]unction "
9746 (when org-agenda-bulk-custom-functions
9747 (concat " Custom: ["
9748 (mapconcat (lambda(f) (char-to-string (car f)))
9749 org-agenda-bulk-custom-functions "")
9750 "]"))))
9751 (catch 'exit
9752 (let* ((action (read-char-exclusive))
9753 (org-log-refile (if org-log-refile 'time nil))
9754 (entries (reverse org-agenda-bulk-marked-entries))
9755 (org-overriding-default-time
9756 (if (get-text-property (point) 'org-agenda-date-header)
9757 (org-get-cursor-date)))
9758 redo-at-end
9759 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9760 (cond
9761 ((equal action ?p)
9762 (let ((org-agenda-persistent-marks
9763 (not org-agenda-persistent-marks)))
9764 (org-agenda-bulk-action)
9765 (throw 'exit nil)))
9767 ((equal action ?$)
9768 (setq cmd '(org-agenda-archive)))
9770 ((equal action ?A)
9771 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9773 ((member action '(?r ?w))
9774 (setq rfloc (org-refile-get-location
9775 "Refile to"
9776 (marker-buffer (car entries))
9777 org-refile-allow-creating-parent-nodes))
9778 (if (nth 3 rfloc)
9779 (setcar (nthcdr 3 rfloc)
9780 (move-marker (make-marker) (nth 3 rfloc)
9781 (or (get-file-buffer (nth 1 rfloc))
9782 (find-buffer-visiting (nth 1 rfloc))
9783 (error "This should not happen")))))
9785 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9786 redo-at-end t))
9788 ((equal action ?t)
9789 (setq state (org-icompleting-read
9790 "Todo state: "
9791 (with-current-buffer (marker-buffer (car entries))
9792 (mapcar 'list org-todo-keywords-1))))
9793 (setq cmd `(let ((org-inhibit-blocking t)
9794 (org-inhibit-logging 'note))
9795 (org-agenda-todo ,state))))
9797 ((memq action '(?- ?+))
9798 (setq tag (org-icompleting-read
9799 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9800 (with-current-buffer (marker-buffer (car entries))
9801 (delq nil
9802 (mapcar (lambda (x)
9803 (if (stringp (car x)) x)) org-tag-alist)))))
9804 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9806 ((memq action '(?s ?d))
9807 (let* ((time
9808 (unless arg
9809 (org-read-date
9810 nil nil nil
9811 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9812 org-overriding-default-time)))
9813 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9814 (setq cmd `(eval '(,c1 arg ,time)))))
9816 ((equal action ?S)
9817 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9818 (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9819 (let ((days (read-number
9820 (format "Scatter tasks across how many %sdays: "
9821 (if arg "week" "")) 7)))
9822 (setq cmd
9823 `(let ((distance (1+ (random ,days))))
9824 (if arg
9825 (let ((dist distance)
9826 (day-of-week
9827 (calendar-day-of-week
9828 (calendar-gregorian-from-absolute (org-today)))))
9829 (dotimes (i (1+ dist))
9830 (while (member day-of-week org-agenda-weekend-days)
9831 (incf distance)
9832 (incf day-of-week)
9833 (if (= day-of-week 7)
9834 (setq day-of-week 0)))
9835 (incf day-of-week)
9836 (if (= day-of-week 7)
9837 (setq day-of-week 0)))))
9838 ;; silently fail when try to replan a sexp entry
9839 (condition-case nil
9840 (let* ((date (calendar-gregorian-from-absolute
9841 (+ (org-today) distance)))
9842 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9843 (nth 2 date))))
9844 (org-agenda-schedule nil time))
9845 (error nil)))))))
9847 ((assoc action org-agenda-bulk-custom-functions)
9848 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9849 redo-at-end t))
9851 ((equal action ?f)
9852 (setq cmd (list (intern
9853 (org-icompleting-read "Function: "
9854 obarray 'fboundp t nil nil)))))
9856 (t (user-error "Invalid bulk action")))
9858 ;; Sort the markers, to make sure that parents are handled before children
9859 (setq entries (sort entries
9860 (lambda (a b)
9861 (cond
9862 ((equal (marker-buffer a) (marker-buffer b))
9863 (< (marker-position a) (marker-position b)))
9865 (string< (buffer-name (marker-buffer a))
9866 (buffer-name (marker-buffer b))))))))
9868 ;; Now loop over all markers and apply cmd
9869 (while (setq e (pop entries))
9870 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9871 (if (not pos)
9872 (progn (message "Skipping removed entry at %s" e)
9873 (setq cntskip (1+ cntskip)))
9874 (goto-char pos)
9875 (let (org-loop-over-headlines-in-active-region)
9876 (eval cmd))
9877 (setq cnt (1+ cnt))))
9878 (when redo-at-end (org-agenda-redo))
9879 (unless org-agenda-persistent-marks
9880 (org-agenda-bulk-unmark-all))
9881 (message "Acted on %d entries%s%s"
9883 (if (= cntskip 0)
9885 (format ", skipped %d (disappeared before their turn)"
9886 cntskip))
9887 (if (not org-agenda-persistent-marks)
9888 "" " (kept marked)"))))))
9890 (defun org-agenda-capture (&optional with-time)
9891 "Call `org-capture' with the date at point.
9892 With a `C-1' prefix, use the HH:MM value at point (if any) or the
9893 current HH:MM time."
9894 (interactive "P")
9895 (if (not (eq major-mode 'org-agenda-mode))
9896 (user-error "You cannot do this outside of agenda buffers")
9897 (let ((org-overriding-default-time
9898 (org-get-cursor-date (equal with-time 1))))
9899 (call-interactively 'org-capture))))
9901 ;;; Dragging agenda lines forward/backward
9903 (defun org-agenda-reapply-filters ()
9904 "Re-apply all agenda filters."
9905 (mapcar
9906 (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f))))
9907 `((,org-agenda-tag-filter tag)
9908 (,org-agenda-category-filter category)
9909 (,org-agenda-regexp-filter regexp)
9910 (,(get 'org-agenda-tag-filter :preset-filter) tag)
9911 (,(get 'org-agenda-category-filter :preset-filter) category)
9912 (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
9914 (defun org-agenda-drag-line-forward (arg &optional backward)
9915 "Drag an agenda line forward by ARG lines.
9916 When the optional argument `backward' is non-nil, move backward."
9917 (interactive "p")
9918 (let ((inhibit-read-only t) lst line)
9919 (if (or (not (get-text-property (point) 'txt))
9920 (save-excursion
9921 (dotimes (n arg)
9922 (move-beginning-of-line (if backward 0 2))
9923 (push (not (get-text-property (point) 'txt)) lst))
9924 (delq nil lst)))
9925 (message "Cannot move line forward")
9926 (let ((end (save-excursion (move-beginning-of-line 2) (point))))
9927 (move-beginning-of-line 1)
9928 (setq line (buffer-substring (point) end))
9929 (delete-region (point) end)
9930 (move-beginning-of-line (funcall (if backward '1- '1+) arg))
9931 (insert line)
9932 (org-agenda-reapply-filters)
9933 (org-agenda-mark-clocking-task)
9934 (move-beginning-of-line 0)))))
9936 (defun org-agenda-drag-line-backward (arg)
9937 "Drag an agenda line backward by ARG lines."
9938 (interactive "p")
9939 (org-agenda-drag-line-forward arg t))
9941 ;;; Flagging notes
9943 (defun org-agenda-show-the-flagging-note ()
9944 "Display the flagging note in the other window.
9945 When called a second time in direct sequence, offer to remove the FLAGGING
9946 tag and (if present) the flagging note."
9947 (interactive)
9948 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
9949 (win (selected-window))
9950 note heading newhead)
9951 (unless hdmarker
9952 (user-error "No linked entry at point"))
9953 (if (and (eq this-command last-command)
9954 (y-or-n-p "Unflag and remove any flagging note? "))
9955 (progn
9956 (org-agenda-remove-flag hdmarker)
9957 (let ((win (get-buffer-window "*Flagging Note*")))
9958 (and win (delete-window win)))
9959 (message "Entry unflagged"))
9960 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
9961 (unless note
9962 (user-error "No flagging note"))
9963 (org-kill-new note)
9964 (org-switch-to-buffer-other-window "*Flagging Note*")
9965 (erase-buffer)
9966 (insert note)
9967 (goto-char (point-min))
9968 (while (re-search-forward "\\\\n" nil t)
9969 (replace-match "\n" t t))
9970 (goto-char (point-min))
9971 (select-window win)
9972 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9974 (defun org-agenda-remove-flag (marker)
9975 "Remove the FLAGGED tag and any flagging note in the entry."
9976 (let (newhead)
9977 (org-with-point-at marker
9978 (org-toggle-tag "FLAGGED" 'off)
9979 (org-entry-delete nil "THEFLAGGINGNOTE")
9980 (setq newhead (org-get-heading)))
9981 (org-agenda-change-all-lines newhead marker)
9982 (message "Entry unflagged")))
9984 (defun org-agenda-get-any-marker (&optional pos)
9985 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9986 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9988 ;;; Appointment reminders
9990 (defvar appt-time-msg-list) ; defined in appt.el
9992 ;;;###autoload
9993 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9994 "Activate appointments found in `org-agenda-files'.
9995 With a \\[universal-argument] prefix, refresh the list of
9996 appointments.
9998 If FILTER is t, interactively prompt the user for a regular
9999 expression, and filter out entries that don't match it.
10001 If FILTER is a string, use this string as a regular expression
10002 for filtering entries out.
10004 If FILTER is a function, filter out entries against which
10005 calling the function returns nil. This function takes one
10006 argument: an entry from `org-agenda-get-day-entries'.
10008 FILTER can also be an alist with the car of each cell being
10009 either `headline' or `category'. For example:
10011 ((headline \"IMPORTANT\")
10012 (category \"Work\"))
10014 will only add headlines containing IMPORTANT or headlines
10015 belonging to the \"Work\" category.
10017 ARGS are symbols indicating what kind of entries to consider.
10018 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
10019 \(i.e., deadlines and scheduled items with a hh:mm specification)
10020 and :timestamp entries. See the docstring of `org-diary' for
10021 details and examples.
10023 If an entry has a APPT_WARNTIME property, its value will be used
10024 to override `appt-message-warning-time'."
10025 (interactive "P")
10026 (if refresh (setq appt-time-msg-list nil))
10027 (if (eq filter t)
10028 (setq filter (read-from-minibuffer "Regexp filter: ")))
10029 (let* ((cnt 0) ; count added events
10030 (scope (or args '(:deadline* :scheduled* :timestamp)))
10031 (org-agenda-new-buffers nil)
10032 (org-deadline-warning-days 0)
10033 ;; Do not use `org-today' here because appt only takes
10034 ;; time and without date as argument, so it may pass wrong
10035 ;; information otherwise
10036 (today (org-date-to-gregorian
10037 (time-to-days (current-time))))
10038 (org-agenda-restrict nil)
10039 (files (org-agenda-files 'unrestricted)) entries file
10040 (org-agenda-buffer nil))
10041 ;; Get all entries which may contain an appt
10042 (org-agenda-prepare-buffers files)
10043 (while (setq file (pop files))
10044 (setq entries
10045 (delq nil
10046 (append entries
10047 (apply 'org-agenda-get-day-entries
10048 file today scope)))))
10049 ;; Map thru entries and find if we should filter them out
10050 (mapc
10051 (lambda(x)
10052 (let* ((evt (org-trim
10053 (replace-regexp-in-string
10054 org-bracket-link-regexp "\\3"
10055 (or (get-text-property 1 'txt x) ""))))
10056 (cat (get-text-property 1 'org-category x))
10057 (tod (get-text-property 1 'time-of-day x))
10058 (ok (or (null filter)
10059 (and (stringp filter) (string-match filter evt))
10060 (and (functionp filter) (funcall filter x))
10061 (and (listp filter)
10062 (let ((cat-filter (cadr (assoc 'category filter)))
10063 (evt-filter (cadr (assoc 'headline filter))))
10064 (or (and (stringp cat-filter)
10065 (string-match cat-filter cat))
10066 (and (stringp evt-filter)
10067 (string-match evt-filter evt)))))))
10068 (wrn (get-text-property 1 'warntime x)))
10069 ;; FIXME: Shall we remove text-properties for the appt text?
10070 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
10071 (when (and ok tod)
10072 (setq tod (concat "00" (number-to-string tod))
10073 tod (when (string-match
10074 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
10075 (concat (match-string 1 tod) ":"
10076 (match-string 2 tod))))
10077 (if (version< emacs-version "23.3")
10078 (appt-add tod evt)
10079 (appt-add tod evt wrn))
10080 (setq cnt (1+ cnt))))) entries)
10081 (org-release-buffers org-agenda-new-buffers)
10082 (if (eq cnt 0)
10083 (message "No event to add")
10084 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
10086 (defun org-agenda-todayp (date)
10087 "Does DATE mean today, when considering `org-extend-today-until'?"
10088 (let ((today (org-today))
10089 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
10090 date)))
10091 (eq date today)))
10093 (defun org-agenda-todo-yesterday (&optional arg)
10094 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
10095 (interactive "P")
10096 (let* ((hour (third (decode-time
10097 (org-current-time))))
10098 (org-extend-today-until (1+ hour)))
10099 (org-agenda-todo arg)))
10101 (provide 'org-agenda)
10103 ;;; org-agenda.el ends here