org-agenda.el (org-agenda-set-restriction-lock): Autoload
[org-mode.git] / lisp / org-agenda.el
blob3af1947bd33dbbe6895c8ddf7d55592e6260aa40
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (require 'org-macs)
50 (eval-when-compile
51 (require 'cl))
53 (declare-function diary-add-to-list "diary-lib"
54 (date string specifier &optional marker globcolor literal))
55 (declare-function calendar-absolute-from-iso "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-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 (const :format "" 'regexp) (regexp))
394 (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
395 (list :tag "TODO state is" :inline t
396 (const 'todo)
397 (choice
398 (const :tag "any not-done state" 'todo)
399 (const :tag "any done state" 'done)
400 (const :tag "any state" 'any)
401 (list :tag "Keyword list"
402 (const :format "" quote)
403 (repeat (string :tag "Keyword")))))
404 (list :tag "TODO state is not" :inline t
405 (const 'nottodo)
406 (choice
407 (const :tag "any not-done state" 'todo)
408 (const :tag "any done state" 'done)
409 (const :tag "any state" 'any)
410 (list :tag "Keyword list"
411 (const :format "" quote)
412 (repeat (string :tag "Keyword")))))
413 (const :tag "scheduled" 'scheduled)
414 (const :tag "not scheduled" 'notscheduled)
415 (const :tag "deadline" 'deadline)
416 (const :tag "no deadline" 'notdeadline)
417 (const :tag "timestamp" 'timestamp)
418 (const :tag "no timestamp" 'nottimestamp))))))
419 (list :tag "Non-standard skipping condition"
420 :value (org-agenda-skip-function)
421 (const org-agenda-skip-function)
422 (sexp :tag "Function or form (quoted!)"))
423 (list :tag "Any variable"
424 (variable :tag "Variable")
425 (sexp :tag "Value (sexp)"))))
426 "Selection of examples for agenda command settings.
427 This will be spliced into the custom type of
428 `org-agenda-custom-commands'.")
431 (defcustom org-agenda-custom-commands
432 '(("n" "Agenda and all TODO's" ((agenda "") (alltodo ""))))
433 "Custom commands for the agenda.
434 These commands will be offered on the splash screen displayed by the
435 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
437 (key desc type match settings files)
439 key The key (one or more characters as a string) to be associated
440 with the command.
441 desc A description of the command, when omitted or nil, a default
442 description is built using MATCH.
443 type The command type, any of the following symbols:
444 agenda The daily/weekly agenda.
445 todo Entries with a specific TODO keyword, in all agenda files.
446 search Entries containing search words entry or headline.
447 tags Tags/Property/TODO match in all agenda files.
448 tags-todo Tags/P/T match in all agenda files, TODO entries only.
449 todo-tree Sparse tree of specific TODO keyword in *current* file.
450 tags-tree Sparse tree with all tags matches in *current* file.
451 occur-tree Occur sparse tree for *current* file.
452 ... A user-defined function.
453 match What to search for:
454 - a single keyword for TODO keyword searches
455 - a tags match expression for tags searches
456 - a word search expression for text searches.
457 - a regular expression for occur searches
458 For all other commands, this should be the empty string.
459 settings A list of option settings, similar to that in a let form, so like
460 this: ((opt1 val1) (opt2 val2) ...). The values will be
461 evaluated at the moment of execution, so quote them when needed.
462 files A list of files file to write the produced agenda buffer to
463 with the command `org-store-agenda-views'.
464 If a file name ends in \".html\", an HTML version of the buffer
465 is written out. If it ends in \".ps\", a postscript version is
466 produced. Otherwise, only the plain text is written to the file.
468 You can also define a set of commands, to create a composite agenda buffer.
469 In this case, an entry looks like this:
471 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
473 where
475 desc A description string to be displayed in the dispatcher menu.
476 cmd An agenda command, similar to the above. However, tree commands
477 are not allowed, but instead you can get agenda and global todo list.
478 So valid commands for a set are:
479 (agenda \"\" settings)
480 (alltodo \"\" settings)
481 (stuck \"\" settings)
482 (todo \"match\" settings files)
483 (search \"match\" settings files)
484 (tags \"match\" settings files)
485 (tags-todo \"match\" settings files)
487 Each command can carry a list of options, and another set of options can be
488 given for the whole set of commands. Individual command options take
489 precedence over the general options.
491 When using several characters as key to a command, the first characters
492 are prefix commands. For the dispatcher to display useful information, you
493 should provide a description for the prefix, like
495 (setq org-agenda-custom-commands
496 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
497 (\"hl\" tags \"+HOME+Lisa\")
498 (\"hp\" tags \"+HOME+Peter\")
499 (\"hk\" tags \"+HOME+Kim\")))"
500 :group 'org-agenda-custom-commands
501 :type `(repeat
502 (choice :value ("x" "Describe command here" tags "" nil)
503 (list :tag "Single command"
504 (string :tag "Access Key(s) ")
505 (option (string :tag "Description"))
506 (choice
507 (const :tag "Agenda" agenda)
508 (const :tag "TODO list" alltodo)
509 (const :tag "Search words" search)
510 (const :tag "Stuck projects" stuck)
511 (const :tag "Tags/Property match (all agenda files)" tags)
512 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
513 (const :tag "TODO keyword search (all agenda files)" todo)
514 (const :tag "Tags sparse tree (current buffer)" tags-tree)
515 (const :tag "TODO keyword tree (current buffer)" todo-tree)
516 (const :tag "Occur tree (current buffer)" occur-tree)
517 (sexp :tag "Other, user-defined function"))
518 (string :tag "Match (only for some commands)")
519 ,org-agenda-custom-commands-local-options
520 (option (repeat :tag "Export" (file :tag "Export to"))))
521 (list :tag "Command series, all agenda files"
522 (string :tag "Access Key(s)")
523 (string :tag "Description ")
524 (repeat :tag "Component"
525 (choice
526 (list :tag "Agenda"
527 (const :format "" agenda)
528 (const :tag "" :format "" "")
529 ,org-agenda-custom-commands-local-options)
530 (list :tag "TODO list (all keywords)"
531 (const :format "" alltodo)
532 (const :tag "" :format "" "")
533 ,org-agenda-custom-commands-local-options)
534 (list :tag "Search words"
535 (const :format "" search)
536 (string :tag "Match")
537 ,org-agenda-custom-commands-local-options)
538 (list :tag "Stuck projects"
539 (const :format "" stuck)
540 (const :tag "" :format "" "")
541 ,org-agenda-custom-commands-local-options)
542 (list :tag "Tags search"
543 (const :format "" tags)
544 (string :tag "Match")
545 ,org-agenda-custom-commands-local-options)
546 (list :tag "Tags search, TODO entries only"
547 (const :format "" tags-todo)
548 (string :tag "Match")
549 ,org-agenda-custom-commands-local-options)
550 (list :tag "TODO keyword search"
551 (const :format "" todo)
552 (string :tag "Match")
553 ,org-agenda-custom-commands-local-options)
554 (list :tag "Other, user-defined function"
555 (symbol :tag "function")
556 (string :tag "Match")
557 ,org-agenda-custom-commands-local-options)))
559 (repeat :tag "Settings for entire command set"
560 (list (variable :tag "Any variable")
561 (sexp :tag "Value")))
562 (option (repeat :tag "Export" (file :tag "Export to"))))
563 (cons :tag "Prefix key documentation"
564 (string :tag "Access Key(s)")
565 (string :tag "Description ")))))
567 (defcustom org-agenda-query-register ?o
568 "The register holding the current query string.
569 The purpose of this is that if you construct a query string interactively,
570 you can then use it to define a custom command."
571 :group 'org-agenda-custom-commands
572 :type 'character)
574 (defcustom org-stuck-projects
575 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
576 "How to identify stuck projects.
577 This is a list of four items:
578 1. A tags/todo/property matcher string that is used to identify a project.
579 See the manual for a description of tag and property searches.
580 The entire tree below a headline matched by this is considered one project.
581 2. A list of TODO keywords identifying non-stuck projects.
582 If the project subtree contains any headline with one of these todo
583 keywords, the project is considered to be not stuck. If you specify
584 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
585 3. A list of tags identifying non-stuck projects.
586 If the project subtree contains any headline with one of these tags,
587 the project is considered to be not stuck. If you specify \"*\" as
588 a tag, any tag will mark the project unstuck. Note that this is about
589 the explicit presence of a tag somewhere in the subtree, inherited
590 tags do not count here. If inherited tags make a project not stuck,
591 use \"-TAG\" in the tags part of the matcher under (1.) above.
592 4. An arbitrary regular expression matching non-stuck projects.
594 If the project turns out to be not stuck, search continues also in the
595 subtree to see if any of the subtasks have project status.
597 See also the variable `org-tags-match-list-sublevels' which applies
598 to projects matched by this search as well.
600 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
601 or `C-c a #' to produce the list."
602 :group 'org-agenda-custom-commands
603 :type '(list
604 (string :tag "Tags/TODO match to identify a project")
605 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
606 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
607 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
609 (defcustom org-agenda-filter-effort-default-operator "<"
610 "The default operator for effort estimate filtering.
611 If you select an effort estimate limit without first pressing an operator,
612 this one will be used."
613 :group 'org-agenda-custom-commands
614 :type '(choice (const :tag "less or equal" "<")
615 (const :tag "greater or equal"">")
616 (const :tag "equal" "=")))
618 (defgroup org-agenda-skip nil
619 "Options concerning skipping parts of agenda files."
620 :tag "Org Agenda Skip"
621 :group 'org-agenda)
623 (defcustom org-agenda-skip-function-global nil
624 "Function to be called at each match during agenda construction.
625 If this function returns nil, the current match should not be skipped.
626 If the function decided to skip an agenda match, is must return the
627 buffer position from which the search should be continued.
628 This may also be a Lisp form, which will be evaluated.
630 This variable will be applied to every agenda match, including
631 tags/property searches and TODO lists. So try to make the test function
632 do its checking as efficiently as possible. To implement a skipping
633 condition just for specific agenda commands, use the variable
634 `org-agenda-skip-function' which can be set in the options section
635 of custom agenda commands."
636 :group 'org-agenda-skip
637 :type 'sexp)
639 (defgroup org-agenda-daily/weekly nil
640 "Options concerning the daily/weekly agenda."
641 :tag "Org Agenda Daily/Weekly"
642 :group 'org-agenda)
643 (defgroup org-agenda-todo-list nil
644 "Options concerning the global todo list agenda view."
645 :tag "Org Agenda Todo List"
646 :group 'org-agenda)
647 (defgroup org-agenda-match-view nil
648 "Options concerning the general tags/property/todo match agenda view."
649 :tag "Org Agenda Match View"
650 :group 'org-agenda)
651 (defgroup org-agenda-search-view nil
652 "Options concerning the general tags/property/todo match agenda view."
653 :tag "Org Agenda Match View"
654 :group 'org-agenda)
656 (defvar org-agenda-archives-mode nil
657 "Non-nil means the agenda will include archived items.
658 If this is the symbol `trees', trees in the selected agenda scope
659 that are marked with the ARCHIVE tag will be included anyway. When this is
660 t, also all archive files associated with the current selection of agenda
661 files will be included.")
663 (defcustom org-agenda-restriction-lock-highlight-subtree t
664 "Non-nil means highlight the whole subtree when restriction is active.
665 Otherwise only highlight the headline. Highlighting the whole subtree is
666 useful to ensure no edits happen beyond the restricted region."
667 :group 'org-agenda
668 :type 'boolean)
670 (defcustom org-agenda-skip-comment-trees t
671 "Non-nil means skip trees that start with the COMMENT keyword.
672 When nil, these trees are also scanned by agenda commands."
673 :group 'org-agenda-skip
674 :type 'boolean)
676 (defcustom org-agenda-todo-list-sublevels t
677 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
678 When nil, the sublevels of a TODO entry are not checked, resulting in
679 potentially much shorter TODO lists."
680 :group 'org-agenda-skip
681 :group 'org-agenda-todo-list
682 :type 'boolean)
684 (defcustom org-agenda-todo-ignore-with-date nil
685 "Non-nil means don't show entries with a date in the global todo list.
686 You can use this if you prefer to mark mere appointments with a TODO keyword,
687 but don't want them to show up in the TODO list.
688 When this is set, it also covers deadlines and scheduled items, the settings
689 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
690 will be ignored.
691 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
692 :group 'org-agenda-skip
693 :group 'org-agenda-todo-list
694 :type 'boolean)
696 (defcustom org-agenda-todo-ignore-timestamp nil
697 "Non-nil means don't show entries with a timestamp.
698 This applies when creating the global todo list.
699 Valid values are:
701 past Don't show entries for today or in the past.
703 future Don't show entries with a timestamp in the future.
704 The idea behind this is that if it has a future
705 timestamp, you don't want to think about it until the
706 date.
708 all Don't show any entries with a timestamp in the global todo list.
709 The idea behind this is that by setting a timestamp, you
710 have already \"taken care\" of this item.
712 This variable can also have an integer as a value. If positive (N),
713 todos with a timestamp N or more days in the future will be ignored. If
714 negative (-N), todos with a timestamp N or more days in the past will be
715 ignored. If 0, todos with a timestamp either today or in the future will
716 be ignored. For example, a value of -1 will exclude todos with a
717 timestamp in the past (yesterday or earlier), while a value of 7 will
718 exclude todos with a timestamp a week or more in the future.
720 See also `org-agenda-todo-ignore-with-date'.
721 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
722 to make his option also apply to the tags-todo list."
723 :group 'org-agenda-skip
724 :group 'org-agenda-todo-list
725 :version "24.1"
726 :type '(choice
727 (const :tag "Ignore future timestamp todos" future)
728 (const :tag "Ignore past or present timestamp todos" past)
729 (const :tag "Ignore all timestamp todos" all)
730 (const :tag "Show timestamp todos" nil)
731 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
733 (defcustom org-agenda-todo-ignore-scheduled nil
734 "Non-nil means, ignore some scheduled TODO items when making TODO list.
735 This applies when creating the global todo list.
736 Valid values are:
738 past Don't show entries scheduled today or in the past.
740 future Don't show entries scheduled in the future.
741 The idea behind this is that by scheduling it, you don't want to
742 think about it until the scheduled date.
744 all Don't show any scheduled entries in the global todo list.
745 The idea behind this is that by scheduling it, you have already
746 \"taken care\" of this item.
748 t Same as `all', for backward compatibility.
750 This variable can also have an integer as a value. See
751 `org-agenda-todo-ignore-timestamp' for more details.
753 See also `org-agenda-todo-ignore-with-date'.
754 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
755 to make his option also apply to the tags-todo list."
756 :group 'org-agenda-skip
757 :group 'org-agenda-todo-list
758 :type '(choice
759 (const :tag "Ignore future-scheduled todos" future)
760 (const :tag "Ignore past- or present-scheduled todos" past)
761 (const :tag "Ignore all scheduled todos" all)
762 (const :tag "Ignore all scheduled todos (compatibility)" t)
763 (const :tag "Show scheduled todos" nil)
764 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
766 (defcustom org-agenda-todo-ignore-deadlines nil
767 "Non-nil means ignore some deadlined TODO items when making TODO list.
768 There are different motivations for using different values, please think
769 carefully when configuring this variable.
771 This applies when creating the global todo list.
772 Valid values are:
774 near Don't show near deadline entries. A deadline is near when it is
775 closer than `org-deadline-warning-days' days. The idea behind this
776 is that such items will appear in the agenda anyway.
778 far Don't show TODO entries where a deadline has been defined, but
779 the deadline is not near. This is useful if you don't want to
780 use the todo list to figure out what to do now.
782 past Don't show entries with a deadline timestamp for today or in the past.
784 future Don't show entries with a deadline timestamp in the future, not even
785 when they become `near' ones. Use it with caution.
787 all Ignore all TODO entries that do have a deadline.
789 t Same as `near', for backward compatibility.
791 This variable can also have an integer as a value. See
792 `org-agenda-todo-ignore-timestamp' for more details.
794 See also `org-agenda-todo-ignore-with-date'.
795 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
796 to make his option also apply to the tags-todo list."
797 :group 'org-agenda-skip
798 :group 'org-agenda-todo-list
799 :type '(choice
800 (const :tag "Ignore near deadlines" near)
801 (const :tag "Ignore near deadlines (compatibility)" t)
802 (const :tag "Ignore far deadlines" far)
803 (const :tag "Ignore all TODOs with a deadlines" all)
804 (const :tag "Show all TODOs, even if they have a deadline" nil)
805 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
807 (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
808 "Time unit to use when possibly ignoring an agenda item.
810 See the docstring of various `org-agenda-todo-ignore-*' options.
811 The default is to compare time stamps using days. An item is thus
812 considered to be in the future if it is at least one day after today.
813 Non-nil means to compare time stamps using seconds. An item is then
814 considered future if it has a time value later than current time."
815 :group 'org-agenda-skip
816 :group 'org-agenda-todo-list
817 :version "24.4"
818 :package-version '(Org . "8.0")
819 :type '(choice
820 (const :tag "Compare time with days" nil)
821 (const :tag "Compare time with seconds" t)))
823 (defcustom org-agenda-tags-todo-honor-ignore-options nil
824 "Non-nil means honor todo-list ignores options also in tags-todo search.
825 The variables
826 `org-agenda-todo-ignore-with-date',
827 `org-agenda-todo-ignore-timestamp',
828 `org-agenda-todo-ignore-scheduled',
829 `org-agenda-todo-ignore-deadlines'
830 make the global TODO list skip entries that have time stamps of certain
831 kinds. If this option is set, the same options will also apply for the
832 tags-todo search, which is the general tags/property matcher
833 restricted to unfinished TODO entries only."
834 :group 'org-agenda-skip
835 :group 'org-agenda-todo-list
836 :group 'org-agenda-match-view
837 :type 'boolean)
839 (defcustom org-agenda-skip-scheduled-if-done nil
840 "Non-nil means don't show scheduled items in agenda when they are done.
841 This is relevant for the daily/weekly agenda, not for the TODO list. And
842 it applies only to the actual date of the scheduling. Warnings about
843 an item with a past scheduling dates are always turned off when the item
844 is DONE."
845 :group 'org-agenda-skip
846 :group 'org-agenda-daily/weekly
847 :type 'boolean)
849 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
850 "Non-nil means skip scheduling line if same entry shows because of deadline.
852 In the agenda of today, an entry can show up multiple times
853 because it is both scheduled and has a nearby deadline, and maybe
854 a plain time stamp as well.
856 When this variable is nil, the entry will be shown several times.
858 When set to t, then only the deadline is shown and the fact that
859 the entry is scheduled today or was scheduled previously is not
860 shown.
862 When set to the symbol `not-today', skip scheduled previously,
863 but not scheduled today.
865 When set to the symbol `repeated-after-deadline', skip scheduled
866 items if they are repeated beyond the current dealine."
867 :group 'org-agenda-skip
868 :group 'org-agenda-daily/weekly
869 :type '(choice
870 (const :tag "Never" nil)
871 (const :tag "Always" t)
872 (const :tag "Not when scheduled today" not-today)
873 (const :tag "When repeated past deadline" repeated-after-deadline)))
875 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
876 "Non-nil means skip timestamp line if same entry shows because of deadline.
877 In the agenda of today, an entry can show up multiple times
878 because it has both a plain timestamp and has a nearby deadline.
879 When this variable is t, then only the deadline is shown and the
880 fact that the entry has a timestamp for or including today is not
881 shown. When this variable is nil, the entry will be shown
882 several times."
883 :group 'org-agenda-skip
884 :group 'org-agenda-daily/weekly
885 :version "24.1"
886 :type '(choice
887 (const :tag "Never" nil)
888 (const :tag "Always" t)))
890 (defcustom org-agenda-skip-deadline-if-done nil
891 "Non-nil means don't show deadlines when the corresponding item is done.
892 When nil, the deadline is still shown and should give you a happy feeling.
893 This is relevant for the daily/weekly agenda. And it applied only to the
894 actually date of the deadline. Warnings about approaching and past-due
895 deadlines are always turned off when the item is DONE."
896 :group 'org-agenda-skip
897 :group 'org-agenda-daily/weekly
898 :type 'boolean)
900 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
901 "Non-nil means skip deadline prewarning when entry is also scheduled.
902 This will apply on all days where a prewarning for the deadline would
903 be shown, but not at the day when the entry is actually due. On that day,
904 the deadline will be shown anyway.
905 This variable may be set to nil, t, the symbol `pre-scheduled',
906 or a number which will then give the number of days before the actual
907 deadline when the prewarnings should resume. The symbol `pre-scheduled'
908 eliminates the deadline prewarning only prior to the scheduled date.
909 This can be used in a workflow where the first showing of the deadline will
910 trigger you to schedule it, and then you don't want to be reminded of it
911 because you will take care of it on the day when scheduled."
912 :group 'org-agenda-skip
913 :group 'org-agenda-daily/weekly
914 :version "24.1"
915 :type '(choice
916 (const :tag "Always show prewarning" nil)
917 (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
918 (const :tag "Remove prewarning if entry is scheduled" t)
919 (integer :tag "Restart prewarning N days before deadline")))
921 (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
922 "Non-nil means skip scheduled delay when entry also has a deadline.
923 This variable may be set to nil, t, the symbol `post-deadline',
924 or a number which will then give the number of days after the actual
925 scheduled date when the delay should expire. The symbol `post-deadline'
926 eliminates the schedule delay when the date is posterior to the deadline."
927 :group 'org-agenda-skip
928 :group 'org-agenda-daily/weekly
929 :version "24.4"
930 :package-version '(Org . "8.0")
931 :type '(choice
932 (const :tag "Always honor delay" nil)
933 (const :tag "Ignore delay if posterior to the deadline" post-deadline)
934 (const :tag "Ignore delay if entry has a deadline" t)
935 (integer :tag "Honor delay up until N days after the scheduled date")))
937 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
938 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
939 When non-nil, after the search for timestamps has matched once in an
940 entry, the rest of the entry will not be searched."
941 :group 'org-agenda-skip
942 :type 'boolean)
944 (defcustom org-agenda-skip-timestamp-if-done nil
945 "Non-nil means don't select item by timestamp or -range if it is DONE."
946 :group 'org-agenda-skip
947 :group 'org-agenda-daily/weekly
948 :type 'boolean)
950 (defcustom org-agenda-dim-blocked-tasks t
951 "Non-nil means dim blocked tasks in the agenda display.
952 This causes some overhead during agenda construction, but if you
953 have turned on `org-enforce-todo-dependencies',
954 `org-enforce-todo-checkbox-dependencies', or any other blocking
955 mechanism, this will create useful feedback in the agenda.
957 Instead of t, this variable can also have the value `invisible'.
958 Then blocked tasks will be invisible and only become visible when
959 they become unblocked. An exemption to this behavior is when a task is
960 blocked because of unchecked checkboxes below it. Since checkboxes do
961 not show up in the agenda views, making this task invisible you remove any
962 trace from agenda views that there is something to do. Therefore, a task
963 that is blocked because of checkboxes will never be made invisible, it
964 will only be dimmed."
965 :group 'org-agenda-daily/weekly
966 :group 'org-agenda-todo-list
967 :version "24.3"
968 :type '(choice
969 (const :tag "Do not dim" nil)
970 (const :tag "Dim to a gray face" t)
971 (const :tag "Make invisible" invisible)))
973 (defcustom org-timeline-show-empty-dates 3
974 "Non-nil means `org-timeline' also shows dates without an entry.
975 When nil, only the days which actually have entries are shown.
976 When t, all days between the first and the last date are shown.
977 When an integer, show also empty dates, but if there is a gap of more than
978 N days, just insert a special line indicating the size of the gap."
979 :group 'org-agenda-skip
980 :type '(choice
981 (const :tag "None" nil)
982 (const :tag "All" t)
983 (integer :tag "at most")))
985 (defgroup org-agenda-startup nil
986 "Options concerning initial settings in the Agenda in Org Mode."
987 :tag "Org Agenda Startup"
988 :group 'org-agenda)
990 (defcustom org-agenda-menu-show-matcher t
991 "Non-nil means show the match string in the agenda dispatcher menu.
992 When nil, the matcher string is not shown, but is put into the help-echo
993 property so than moving the mouse over the command shows it.
994 Setting it to nil is good if matcher strings are very long and/or if
995 you want to use two-columns display (see `org-agenda-menu-two-columns')."
996 :group 'org-agenda
997 :version "24.1"
998 :type 'boolean)
1000 (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
1002 (defcustom org-agenda-menu-two-columns nil
1003 "Non-nil means, use two columns to show custom commands in the dispatcher.
1004 If you use this, you probably want to set `org-agenda-menu-show-matcher'
1005 to nil."
1006 :group 'org-agenda
1007 :version "24.1"
1008 :type 'boolean)
1010 (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
1011 (defcustom org-agenda-finalize-hook nil
1012 "Hook run just before displaying an agenda buffer.
1013 The buffer is still writable when the hook is called.
1015 You can modify some of the buffer substrings but you should be
1016 extra careful not to modify the text properties of the agenda
1017 headlines as the agenda display heavily relies on them."
1018 :group 'org-agenda-startup
1019 :type 'hook)
1021 (defcustom org-agenda-mouse-1-follows-link nil
1022 "Non-nil means mouse-1 on a link will follow the link in the agenda.
1023 A longer mouse click will still set point. Does not work on XEmacs.
1024 Needs to be set before org.el is loaded."
1025 :group 'org-agenda-startup
1026 :type 'boolean)
1028 (defcustom org-agenda-start-with-follow-mode nil
1029 "The initial value of follow mode in a newly created agenda window."
1030 :group 'org-agenda-startup
1031 :type 'boolean)
1033 (defcustom org-agenda-follow-indirect nil
1034 "Non-nil means `org-agenda-follow-mode' displays only the
1035 current item's tree, in an indirect buffer."
1036 :group 'org-agenda
1037 :version "24.1"
1038 :type 'boolean)
1040 (defcustom org-agenda-show-outline-path t
1041 "Non-nil means show outline path in echo area after line motion."
1042 :group 'org-agenda-startup
1043 :type 'boolean)
1045 (defcustom org-agenda-start-with-entry-text-mode nil
1046 "The initial value of entry-text-mode in a newly created agenda window."
1047 :group 'org-agenda-startup
1048 :type 'boolean)
1050 (defcustom org-agenda-entry-text-maxlines 5
1051 "Number of text lines to be added when `E' is pressed in the agenda.
1053 Note that this variable only used during agenda display. Add add entry text
1054 when exporting the agenda, configure the variable
1055 `org-agenda-add-entry-ext-maxlines'."
1056 :group 'org-agenda
1057 :type 'integer)
1059 (defcustom org-agenda-entry-text-exclude-regexps nil
1060 "List of regular expressions to clean up entry text.
1061 The complete matches of all regular expressions in this list will be
1062 removed from entry text before it is shown in the agenda."
1063 :group 'org-agenda
1064 :type '(repeat (regexp)))
1066 (defcustom org-agenda-entry-text-leaders " > "
1067 "Text prepended to the entry text in agenda buffers."
1068 :version "24.4"
1069 :package-version '(Org . "8.0")
1070 :group 'org-agenda
1071 :type 'string)
1073 (defvar org-agenda-entry-text-cleanup-hook nil
1074 "Hook that is run after basic cleanup of entry text to be shown in agenda.
1075 This cleanup is done in a temporary buffer, so the function may inspect and
1076 change the entire buffer.
1077 Some default stuff like drawers and scheduling/deadline dates will already
1078 have been removed when this is called, as will any matches for regular
1079 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
1081 (defvar org-agenda-include-inactive-timestamps nil
1082 "Non-nil means include inactive time stamps in agenda and timeline.
1083 Dynamically scoped.")
1085 (defgroup org-agenda-windows nil
1086 "Options concerning the windows used by the Agenda in Org Mode."
1087 :tag "Org Agenda Windows"
1088 :group 'org-agenda)
1090 (defcustom org-agenda-window-setup 'reorganize-frame
1091 "How the agenda buffer should be displayed.
1092 Possible values for this option are:
1094 current-window Show agenda in the current window, keeping all other windows.
1095 other-window Use `switch-to-buffer-other-window' to display agenda.
1096 reorganize-frame Show only two windows on the current frame, the current
1097 window and the agenda.
1098 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1099 Also, when exiting the agenda, kill that frame.
1100 See also the variable `org-agenda-restore-windows-after-quit'."
1101 :group 'org-agenda-windows
1102 :type '(choice
1103 (const current-window)
1104 (const other-frame)
1105 (const other-window)
1106 (const reorganize-frame)))
1108 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
1109 "The min and max height of the agenda window as a fraction of frame height.
1110 The value of the variable is a cons cell with two numbers between 0 and 1.
1111 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
1112 :group 'org-agenda-windows
1113 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
1115 (defcustom org-agenda-restore-windows-after-quit nil
1116 "Non-nil means restore window configuration upon exiting agenda.
1117 Before the window configuration is changed for displaying the agenda,
1118 the current status is recorded. When the agenda is exited with
1119 `q' or `x' and this option is set, the old state is restored. If
1120 `org-agenda-window-setup' is `other-frame', the value of this
1121 option will be ignored."
1122 :group 'org-agenda-windows
1123 :type 'boolean)
1125 (defcustom org-agenda-ndays nil
1126 "Number of days to include in overview display.
1127 Should be 1 or 7.
1128 Obsolete, see `org-agenda-span'."
1129 :group 'org-agenda-daily/weekly
1130 :type '(choice (const nil)
1131 (integer)))
1133 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1135 (defcustom org-agenda-span 'week
1136 "Number of days to include in overview display.
1137 Can be day, week, month, year, or any number of days.
1138 Custom commands can set this variable in the options section."
1139 :group 'org-agenda-daily/weekly
1140 :type '(choice (const :tag "Day" day)
1141 (const :tag "Week" week)
1142 (const :tag "Fortnight" fortnight)
1143 (const :tag "Month" month)
1144 (const :tag "Year" year)
1145 (integer :tag "Custom")))
1147 (defcustom org-agenda-start-on-weekday 1
1148 "Non-nil means start the overview always on the specified weekday.
1149 0 denotes Sunday, 1 denotes Monday, etc.
1150 When nil, always start on the current day.
1151 Custom commands can set this variable in the options section."
1152 :group 'org-agenda-daily/weekly
1153 :type '(choice (const :tag "Today" nil)
1154 (integer :tag "Weekday No.")))
1156 (defcustom org-agenda-show-all-dates t
1157 "Non-nil means `org-agenda' shows every day in the selected range.
1158 When nil, only the days which actually have entries are shown."
1159 :group 'org-agenda-daily/weekly
1160 :type 'boolean)
1162 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1163 "Format string for displaying dates in the agenda.
1164 Used by the daily/weekly agenda and by the timeline. This should be
1165 a format string understood by `format-time-string', or a function returning
1166 the formatted date as a string. The function must take a single argument,
1167 a calendar-style date list like (month day year)."
1168 :group 'org-agenda-daily/weekly
1169 :type '(choice
1170 (string :tag "Format string")
1171 (function :tag "Function")))
1173 (defun org-agenda-format-date-aligned (date)
1174 "Format a DATE string for display in the daily/weekly agenda, or timeline.
1175 This function makes sure that dates are aligned for easy reading."
1176 (require 'cal-iso)
1177 (let* ((dayname (calendar-day-name date))
1178 (day (cadr date))
1179 (day-of-week (calendar-day-of-week date))
1180 (month (car date))
1181 (monthname (calendar-month-name month))
1182 (year (nth 2 date))
1183 (iso-week (org-days-to-iso-week
1184 (calendar-absolute-from-gregorian date)))
1185 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1186 (1- year))
1187 ((and (= month 12) (<= iso-week 1))
1188 (1+ year))
1189 (t year)))
1190 (weekstring (if (= day-of-week 1)
1191 (format " W%02d" iso-week)
1192 "")))
1193 (format "%-10s %2d %s %4d%s"
1194 dayname day monthname year weekstring)))
1196 (defcustom org-agenda-time-leading-zero nil
1197 "Non-nil means use leading zero for military times in agenda.
1198 For example, 9:30am would become 09:30 rather than 9:30."
1199 :group 'org-agenda-daily/weekly
1200 :version "24.1"
1201 :type 'boolean)
1203 (defcustom org-agenda-timegrid-use-ampm nil
1204 "When set, show AM/PM style timestamps on the timegrid."
1205 :group 'org-agenda
1206 :version "24.1"
1207 :type 'boolean)
1209 (defun org-agenda-time-of-day-to-ampm (time)
1210 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1211 (let* ((hour-number (string-to-number (substring time 0 -3)))
1212 (minute (substring time -2))
1213 (ampm "am"))
1214 (cond
1215 ((equal hour-number 12)
1216 (setq ampm "pm"))
1217 ((> hour-number 12)
1218 (setq ampm "pm")
1219 (setq hour-number (- hour-number 12))))
1220 (concat
1221 (if org-agenda-time-leading-zero
1222 (format "%02d" hour-number)
1223 (format "%02s" (number-to-string hour-number)))
1224 ":" minute ampm)))
1226 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1227 "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
1228 (if org-agenda-timegrid-use-ampm
1229 (org-agenda-time-of-day-to-ampm time)
1230 time))
1232 (defcustom org-agenda-weekend-days '(6 0)
1233 "Which days are weekend?
1234 These days get the special face `org-agenda-date-weekend' in the agenda
1235 and timeline buffers."
1236 :group 'org-agenda-daily/weekly
1237 :type '(set :greedy t
1238 (const :tag "Monday" 1)
1239 (const :tag "Tuesday" 2)
1240 (const :tag "Wednesday" 3)
1241 (const :tag "Thursday" 4)
1242 (const :tag "Friday" 5)
1243 (const :tag "Saturday" 6)
1244 (const :tag "Sunday" 0)))
1246 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1247 "Non-nil means jump to today when moving a past date forward in time.
1248 When using S-right in the agenda to move a a date forward, and the date
1249 stamp currently points to the past, the first key press will move it
1250 to today. WHen nil, just move one day forward even if the date stays
1251 in the past."
1252 :group 'org-agenda-daily/weekly
1253 :version "24.1"
1254 :type 'boolean)
1256 (defcustom org-agenda-include-diary nil
1257 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1258 Custom commands can set this variable in the options section."
1259 :group 'org-agenda-daily/weekly
1260 :type 'boolean)
1262 (defcustom org-agenda-include-deadlines t
1263 "If non-nil, include entries within their deadline warning period.
1264 Custom commands can set this variable in the options section."
1265 :group 'org-agenda-daily/weekly
1266 :version "24.1"
1267 :type 'boolean)
1269 (defcustom org-agenda-repeating-timestamp-show-all t
1270 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1271 When set to a list of strings, only show occurrences of repeating
1272 stamps for these TODO keywords. When nil, only one occurrence is
1273 shown, either today or the nearest into the future."
1274 :group 'org-agenda-daily/weekly
1275 :type '(choice
1276 (const :tag "Show repeating stamps" t)
1277 (repeat :tag "Show repeating stamps for these TODO keywords"
1278 (string :tag "TODO Keyword"))
1279 (const :tag "Don't show repeating stamps" nil)))
1281 (defcustom org-scheduled-past-days 10000
1282 "Number of days to continue listing scheduled items not marked DONE.
1283 When an item is scheduled on a date, it shows up in the agenda on this
1284 day and will be listed until it is marked done for the number of days
1285 given here."
1286 :group 'org-agenda-daily/weekly
1287 :type 'integer)
1289 (defcustom org-agenda-log-mode-items '(closed clock)
1290 "List of items that should be shown in agenda log mode.
1291 This list may contain the following symbols:
1293 closed Show entries that have been closed on that day.
1294 clock Show entries that have received clocked time on that day.
1295 state Show all logged state changes.
1296 Note that instead of changing this variable, you can also press `C-u l' in
1297 the agenda to display all available LOG items temporarily."
1298 :group 'org-agenda-daily/weekly
1299 :type '(set :greedy t (const closed) (const clock) (const state)))
1301 (defcustom org-agenda-clock-consistency-checks
1302 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1303 :gap-ok-around ("4:00")
1304 :default-face ((:background "DarkRed") (:foreground "white"))
1305 :overlap-face nil :gap-face nil :no-end-time-face nil
1306 :long-face nil :short-face nil)
1307 "This is a property list, with the following keys:
1309 :max-duration Mark clocking chunks that are longer than this time.
1310 This is a time string like \"HH:MM\", or the number
1311 of minutes as an integer.
1313 :min-duration Mark clocking chunks that are shorter that this.
1314 This is a time string like \"HH:MM\", or the number
1315 of minutes as an integer.
1317 :max-gap Mark gaps between clocking chunks that are longer than
1318 this duration. A number of minutes, or a string
1319 like \"HH:MM\".
1321 :gap-ok-around List of times during the day which are usually not working
1322 times. When a gap is detected, but the gap contains any
1323 of these times, the gap is *not* reported. For example,
1324 if this is (\"4:00\" \"13:00\") then gaps that contain
1325 4:00 in the morning (i.e. the night) and 13:00
1326 (i.e. a typical lunch time) do not cause a warning.
1327 You should have at least one time during the night in this
1328 list, or otherwise the first task each morning will trigger
1329 a warning because it follows a long gap.
1331 Furthermore, the following properties can be used to define faces for
1332 issue display.
1334 :default-face the default face, if the specific face is undefined
1335 :overlap-face face for overlapping clocks
1336 :gap-face face for gaps between clocks
1337 :no-end-time-face face for incomplete clocks
1338 :long-face face for clock intervals that are too long
1339 :short-face face for clock intervals that are too short"
1340 :group 'org-agenda-daily/weekly
1341 :group 'org-clock
1342 :version "24.1"
1343 :type 'plist)
1345 (defcustom org-agenda-log-mode-add-notes t
1346 "Non-nil means add first line of notes to log entries in agenda views.
1347 If a log item like a state change or a clock entry is associated with
1348 notes, the first line of these notes will be added to the entry in the
1349 agenda display."
1350 :group 'org-agenda-daily/weekly
1351 :type 'boolean)
1353 (defcustom org-agenda-start-with-log-mode nil
1354 "The initial value of log-mode in a newly created agenda window.
1355 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1356 explanations on the possible values."
1357 :group 'org-agenda-startup
1358 :group 'org-agenda-daily/weekly
1359 :type '(choice (const :tag "Don't show log items" nil)
1360 (const :tag "Show only log items" 'only)
1361 (const :tag "Show all possible log items" 'clockcheck)
1362 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1363 (choice (const :tag "Show closed log items" 'closed)
1364 (const :tag "Show clocked log items" 'clock)
1365 (const :tag "Show all logged state changes" 'state)))))
1367 (defcustom org-agenda-start-with-clockreport-mode nil
1368 "The initial value of clockreport-mode in a newly created agenda window."
1369 :group 'org-agenda-startup
1370 :group 'org-agenda-daily/weekly
1371 :type 'boolean)
1373 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1374 "Property list with parameters for the clocktable in clockreport mode.
1375 This is the display mode that shows a clock table in the daily/weekly
1376 agenda, the properties for this dynamic block can be set here.
1377 The usual clocktable parameters are allowed here, but you cannot set
1378 the properties :name, :tstart, :tend, :block, and :scope - these will
1379 be overwritten to make sure the content accurately reflects the
1380 current display in the agenda."
1381 :group 'org-agenda-daily/weekly
1382 :type 'plist)
1384 (defcustom org-agenda-search-view-always-boolean nil
1385 "Non-nil means the search string is interpreted as individual parts.
1387 The search string for search view can either be interpreted as a phrase,
1388 or as a list of snippets that define a boolean search for a number of
1389 strings.
1391 When this is non-nil, the string will be split on whitespace, and each
1392 snippet will be searched individually, and all must match in order to
1393 select an entry. A snippet is then a single string of non-white
1394 characters, or a string in double quotes, or a regexp in {} braces.
1395 If a snippet is preceded by \"-\", the snippet must *not* match.
1396 \"+\" is syntactic sugar for positive selection. Each snippet may
1397 be found as a full word or a partial word, but see the variable
1398 `org-agenda-search-view-force-full-words'.
1400 When this is nil, search will look for the entire search phrase as one,
1401 with each space character matching any amount of whitespace, including
1402 line breaks.
1404 Even when this is nil, you can still switch to Boolean search dynamically
1405 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1406 is a regexp marked with braces like \"{abc}\", this will also switch to
1407 boolean search."
1408 :group 'org-agenda-search-view
1409 :version "24.1"
1410 :type 'boolean)
1412 (org-defvaralias 'org-agenda-search-view-search-words-only
1413 'org-agenda-search-view-always-boolean)
1415 (defcustom org-agenda-search-view-force-full-words nil
1416 "Non-nil means, search words must be matches as complete words.
1417 When nil, they may also match part of a word."
1418 :group 'org-agenda-search-view
1419 :version "24.1"
1420 :type 'boolean)
1422 (defcustom org-agenda-search-view-max-outline-level nil
1423 "Maximum outline level to display in search view.
1424 E.g. when this is set to 1, the search view will only
1425 show headlines of level 1."
1426 :group 'org-agenda-search-view
1427 :version "24.4"
1428 :package-version '(Org . "8.0")
1429 :type 'integer)
1431 (defgroup org-agenda-time-grid nil
1432 "Options concerning the time grid in the Org-mode Agenda."
1433 :tag "Org Agenda Time Grid"
1434 :group 'org-agenda)
1436 (defcustom org-agenda-search-headline-for-time t
1437 "Non-nil means search headline for a time-of-day.
1438 If the headline contains a time-of-day in one format or another, it will
1439 be used to sort the entry into the time sequence of items for a day.
1440 Some people have time stamps in the headline that refer to the creation
1441 time or so, and then this produces an unwanted side effect. If this is
1442 the case for your, use this variable to turn off searching the headline
1443 for a time."
1444 :group 'org-agenda-time-grid
1445 :type 'boolean)
1447 (defcustom org-agenda-use-time-grid t
1448 "Non-nil means show a time grid in the agenda schedule.
1449 A time grid is a set of lines for specific times (like every two hours between
1450 8:00 and 20:00). The items scheduled for a day at specific times are
1451 sorted in between these lines.
1452 For details about when the grid will be shown, and what it will look like, see
1453 the variable `org-agenda-time-grid'."
1454 :group 'org-agenda-time-grid
1455 :type 'boolean)
1457 (defcustom org-agenda-time-grid
1458 '((daily today require-timed)
1459 "----------------"
1460 (800 1000 1200 1400 1600 1800 2000))
1462 "The settings for time grid for agenda display.
1463 This is a list of three items. The first item is again a list. It contains
1464 symbols specifying conditions when the grid should be displayed:
1466 daily if the agenda shows a single day
1467 weekly if the agenda shows an entire week
1468 today show grid on current date, independent of daily/weekly display
1469 require-timed show grid only if at least one item has a time specification
1471 The second item is a string which will be placed behind the grid time.
1473 The third item is a list of integers, indicating the times that should have
1474 a grid line."
1475 :group 'org-agenda-time-grid
1476 :type
1477 '(list
1478 (set :greedy t :tag "Grid Display Options"
1479 (const :tag "Show grid in single day agenda display" daily)
1480 (const :tag "Show grid in weekly agenda display" weekly)
1481 (const :tag "Always show grid for today" today)
1482 (const :tag "Show grid only if any timed entries are present"
1483 require-timed)
1484 (const :tag "Skip grid times already present in an entry"
1485 remove-match))
1486 (string :tag "Grid String")
1487 (repeat :tag "Grid Times" (integer :tag "Time"))))
1489 (defcustom org-agenda-show-current-time-in-grid t
1490 "Non-nil means show the current time in the time grid."
1491 :group 'org-agenda-time-grid
1492 :version "24.1"
1493 :type 'boolean)
1495 (defcustom org-agenda-current-time-string
1496 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1497 "The string for the current time marker in the agenda."
1498 :group 'org-agenda-time-grid
1499 :version "24.1"
1500 :type 'string)
1502 (defgroup org-agenda-sorting nil
1503 "Options concerning sorting in the Org-mode Agenda."
1504 :tag "Org Agenda Sorting"
1505 :group 'org-agenda)
1507 (defcustom org-agenda-sorting-strategy
1508 '((agenda habit-down time-up priority-down category-keep)
1509 (todo priority-down category-keep)
1510 (tags priority-down category-keep)
1511 (search category-keep))
1512 "Sorting structure for the agenda items of a single day.
1513 This is a list of symbols which will be used in sequence to determine
1514 if an entry should be listed before another entry. The following
1515 symbols are recognized:
1517 time-up Put entries with time-of-day indications first, early first
1518 time-down Put entries with time-of-day indications first, late first
1519 timestamp-up Sort by any timestamp, early first
1520 timestamp-down Sort by any timestamp, late first
1521 scheduled-up Sort by scheduled timestamp, early first
1522 scheduled-down Sort by scheduled timestamp, late first
1523 deadline-up Sort by deadline timestamp, early first
1524 deadline-down Sort by deadline timestamp, late first
1525 ts-up Sort by active timestamp, early first
1526 ts-down Sort by active timestamp, late first
1527 tsia-up Sort by inactive timestamp, early first
1528 tsia-down Sort by inactive timestamp, late first
1529 category-keep Keep the default order of categories, corresponding to the
1530 sequence in `org-agenda-files'.
1531 category-up Sort alphabetically by category, A-Z.
1532 category-down Sort alphabetically by category, Z-A.
1533 tag-up Sort alphabetically by last tag, A-Z.
1534 tag-down Sort alphabetically by last tag, Z-A.
1535 priority-up Sort numerically by priority, high priority last.
1536 priority-down Sort numerically by priority, high priority first.
1537 todo-state-up Sort by todo state, tasks that are done last.
1538 todo-state-down Sort by todo state, tasks that are done first.
1539 effort-up Sort numerically by estimated effort, high effort last.
1540 effort-down Sort numerically by estimated effort, high effort first.
1541 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1542 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1543 habit-up Put entries that are habits first
1544 habit-down Put entries that are habits last
1545 alpha-up Sort headlines alphabetically
1546 alpha-down Sort headlines alphabetically, reversed
1548 The different possibilities will be tried in sequence, and testing stops
1549 if one comparison returns a \"not-equal\". For example, the default
1550 '(time-up category-keep priority-down)
1551 means: Pull out all entries having a specified time of day and sort them,
1552 in order to make a time schedule for the current day the first thing in the
1553 agenda listing for the day. Of the entries without a time indication, keep
1554 the grouped in categories, don't sort the categories, but keep them in
1555 the sequence given in `org-agenda-files'. Within each category sort by
1556 priority.
1558 Leaving out `category-keep' would mean that items will be sorted across
1559 categories by priority.
1561 Instead of a single list, this can also be a set of list for specific
1562 contents, with a context symbol in the car of the list, any of
1563 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1565 Custom commands can bind this variable in the options section."
1566 :group 'org-agenda-sorting
1567 :type `(choice
1568 (repeat :tag "General" ,org-sorting-choice)
1569 (list :tag "Individually"
1570 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1571 (repeat ,org-sorting-choice))
1572 (cons (const :tag "Strategy for TODO lists" todo)
1573 (repeat ,org-sorting-choice))
1574 (cons (const :tag "Strategy for Tags matches" tags)
1575 (repeat ,org-sorting-choice))
1576 (cons (const :tag "Strategy for search matches" search)
1577 (repeat ,org-sorting-choice)))))
1579 (defcustom org-agenda-cmp-user-defined nil
1580 "A function to define the comparison `user-defined'.
1581 This function must receive two arguments, agenda entry a and b.
1582 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1583 the user comparison, return nil.
1584 When this is defined, you can make `user-defined-up' and `user-defined-down'
1585 part of an agenda sorting strategy."
1586 :group 'org-agenda-sorting
1587 :type 'symbol)
1589 (defcustom org-sort-agenda-notime-is-late t
1590 "Non-nil means items without time are considered late.
1591 This is only relevant for sorting. When t, items which have no explicit
1592 time like 15:30 will be considered as 99:01, i.e. later than any items which
1593 do have a time. When nil, the default time is before 0:00. You can use this
1594 option to decide if the schedule for today should come before or after timeless
1595 agenda entries."
1596 :group 'org-agenda-sorting
1597 :type 'boolean)
1599 (defcustom org-sort-agenda-noeffort-is-high t
1600 "Non-nil means items without effort estimate are sorted as high effort.
1601 This also applies when filtering an agenda view with respect to the
1602 < or > effort operator. Then, tasks with no effort defined will be treated
1603 as tasks with high effort.
1604 When nil, such items are sorted as 0 minutes effort."
1605 :group 'org-agenda-sorting
1606 :type 'boolean)
1608 (defgroup org-agenda-line-format nil
1609 "Options concerning the entry prefix in the Org-mode agenda display."
1610 :tag "Org Agenda Line Format"
1611 :group 'org-agenda)
1613 (defcustom org-agenda-prefix-format
1614 '((agenda . " %i %-12:c%?-12t% s")
1615 (timeline . " % s")
1616 (todo . " %i %-12:c")
1617 (tags . " %i %-12:c")
1618 (search . " %i %-12:c"))
1619 "Format specifications for the prefix of items in the agenda views.
1620 An alist with five entries, each for the different agenda types. The
1621 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1622 The values are format strings.
1624 This format works similar to a printf format, with the following meaning:
1626 %c the category of the item, \"Diary\" for entries from the diary,
1627 or as given by the CATEGORY keyword or derived from the file name
1628 %e the effort required by the item
1629 %l the level of the item (insert X space(s) if item is of level X)
1630 %i the icon category of the item, see `org-agenda-category-icon-alist'
1631 %T the last tag of the item (ignore inherited tags, which come first)
1632 %t the HH:MM time-of-day specification if one applies to the entry
1633 %s Scheduling/Deadline information, a short string
1634 %b show breadcrumbs, i.e., the names of the higher levels
1635 %(expression) Eval EXPRESSION and replace the control string
1636 by the result
1638 All specifiers work basically like the standard `%s' of printf, but may
1639 contain two additional characters: a question mark just after the `%'
1640 and a whitespace/punctuation character just before the final letter.
1642 If the first character after `%' is a question mark, the entire field
1643 will only be included if the corresponding value applies to the current
1644 entry. This is useful for fields which should have fixed width when
1645 present, but zero width when absent. For example, \"%?-12t\" will
1646 result in a 12 character time field if a time of the day is specified,
1647 but will completely disappear in entries which do not contain a time.
1649 If there is punctuation or whitespace character just before the
1650 final format letter, this character will be appended to the field
1651 value if the value is not empty. For example, the format
1652 \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
1653 the category is empty, no additional colon is inserted.
1655 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1656 which means:
1658 - Indent the line with two space characters
1659 - Give the category a 12 chars wide field, padded with whitespace on
1660 the right (because of `-'). Append a colon if there is a category
1661 (because of `:').
1662 - If there is a time-of-day, put it into a 12 chars wide field. If no
1663 time, don't put in an empty field, just skip it (because of '?').
1664 - Finally, put the scheduling information.
1666 See also the variables `org-agenda-remove-times-when-in-prefix' and
1667 `org-agenda-remove-tags'.
1669 Custom commands can set this variable in the options section."
1670 :type '(choice
1671 (string :tag "General format")
1672 (list :greedy t :tag "View dependent"
1673 (cons (const agenda) (string :tag "Format"))
1674 (cons (const timeline) (string :tag "Format"))
1675 (cons (const todo) (string :tag "Format"))
1676 (cons (const tags) (string :tag "Format"))
1677 (cons (const search) (string :tag "Format"))))
1678 :group 'org-agenda-line-format)
1680 (defvar org-prefix-format-compiled nil
1681 "The compiled prefix format and associated variables.
1682 This is a list where first element is a list of variable bindings, and second
1683 element is the compiled format expression. See the variable
1684 `org-agenda-prefix-format'.")
1686 (defcustom org-agenda-todo-keyword-format "%-1s"
1687 "Format for the TODO keyword in agenda lines.
1688 Set this to something like \"%-12s\" if you want all TODO keywords
1689 to occupy a fixed space in the agenda display."
1690 :group 'org-agenda-line-format
1691 :type 'string)
1693 (defcustom org-agenda-diary-sexp-prefix nil
1694 "A regexp that matches part of a diary sexp entry
1695 which should be treated as scheduling/deadline information in
1696 `org-agenda'.
1698 For example, you can use this to extract the `diary-remind-message' from
1699 `diary-remind' entries."
1700 :group 'org-agenda-line-format
1701 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1703 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1704 "Text preceding timerange entries in the agenda view.
1705 This is a list with two strings. The first applies when the range
1706 is entirely on one day. The second applies if the range spans several days.
1707 The strings may have two \"%d\" format specifiers which will be filled
1708 with the sequence number of the days, and the total number of days in the
1709 range, respectively."
1710 :group 'org-agenda-line-format
1711 :type '(list
1712 (string :tag "Deadline today ")
1713 (choice :tag "Deadline relative"
1714 (string :tag "Format string")
1715 (function))))
1717 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1718 "Text preceding scheduled items in the agenda view.
1719 This is a list with two strings. The first applies when the item is
1720 scheduled on the current day. The second applies when it has been scheduled
1721 previously, it may contain a %d indicating that this is the nth time that
1722 this item is scheduled, due to automatic rescheduling of unfinished items
1723 for the following day. So this number is one larger than the number of days
1724 that passed since this item was scheduled first."
1725 :group 'org-agenda-line-format
1726 :version "24.4"
1727 :package-version '(Org . "8.0")
1728 :type '(list
1729 (string :tag "Scheduled today ")
1730 (string :tag "Scheduled previously")))
1732 (defcustom org-agenda-inactive-leader "["
1733 "Text preceding item pulled into the agenda by inactive time stamps.
1734 These entries are added to the agenda when pressing \"[\"."
1735 :group 'org-agenda-line-format
1736 :version "24.1"
1737 :type 'string)
1739 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
1740 "Text preceding deadline items in the agenda view.
1741 This is a list with three strings. The first applies when the item has its
1742 deadline on the current day. The second applies when the deadline is in the
1743 future, the third one when it is in the past. The strings may contain %d
1744 to capture the number of days."
1745 :group 'org-agenda-line-format
1746 :version "24.4"
1747 :package-version '(Org . "8.0")
1748 :type '(list
1749 (string :tag "Deadline today ")
1750 (choice :tag "Deadline relative"
1751 (string :tag "Format string")
1752 (function))))
1754 (defcustom org-agenda-remove-times-when-in-prefix t
1755 "Non-nil means remove duplicate time specifications in agenda items.
1756 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1757 time-of-day specification in a headline or diary entry is extracted and
1758 placed into the prefix. If this option is non-nil, the original specification
1759 \(a timestamp or -range, or just a plain time(range) specification like
1760 11:30-4pm) will be removed for agenda display. This makes the agenda less
1761 cluttered.
1762 The option can be t or nil. It may also be the symbol `beg', indicating
1763 that the time should only be removed when it is located at the beginning of
1764 the headline/diary entry."
1765 :group 'org-agenda-line-format
1766 :type '(choice
1767 (const :tag "Always" t)
1768 (const :tag "Never" nil)
1769 (const :tag "When at beginning of entry" beg)))
1771 (defcustom org-agenda-remove-timeranges-from-blocks nil
1772 "Non-nil means remove time ranges specifications in agenda
1773 items that span on several days."
1774 :group 'org-agenda-line-format
1775 :version "24.1"
1776 :type 'boolean)
1778 (defcustom org-agenda-default-appointment-duration nil
1779 "Default duration for appointments that only have a starting time.
1780 When nil, no duration is specified in such cases.
1781 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1782 :group 'org-agenda-line-format
1783 :type '(choice
1784 (integer :tag "Minutes")
1785 (const :tag "No default duration")))
1787 (defcustom org-agenda-show-inherited-tags t
1788 "Non-nil means show inherited tags in each agenda line.
1790 When this option is set to 'always, it take precedences over
1791 `org-agenda-use-tag-inheritance' and inherited tags are shown
1792 in every agenda.
1794 When this option is set to t (the default), inherited tags are
1795 shown when they are available, i.e. when the value of
1796 `org-agenda-use-tag-inheritance' has been taken into account.
1798 This can be set to a list of agenda types in which the agenda
1799 must display the inherited tags. Available types are 'todo,
1800 'agenda, 'search and 'timeline.
1802 When set to nil, never show inherited tags in agenda lines."
1803 :group 'org-agenda-line-format
1804 :group 'org-agenda
1805 :version "24.3"
1806 :type '(choice
1807 (const :tag "Show inherited tags when available" t)
1808 (const :tag "Always show inherited tags" 'always)
1809 (repeat :tag "Show inherited tags only in selected agenda types"
1810 (symbol :tag "Agenda type"))))
1812 (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
1813 "List of agenda view types where to use tag inheritance.
1815 In tags/tags-todo/tags-tree agenda views, tag inheritance is
1816 controlled by `org-use-tag-inheritance'. In other agenda types,
1817 `org-use-tag-inheritance' is not used for the selection of the
1818 agenda entries. Still, you may want the agenda to be aware of
1819 the inherited tags anyway, e.g. for later tag filtering.
1821 Allowed value are 'todo, 'search, 'timeline and 'agenda.
1823 This variable has no effect if `org-agenda-show-inherited-tags'
1824 is set to 'always. In that case, the agenda is aware of those
1825 tags.
1827 The default value sets tags in every agenda type. Setting this
1828 option to nil will speed up non-tags agenda view a lot."
1829 :group 'org-agenda
1830 :version "24.3"
1831 :type '(choice
1832 (const :tag "Use tag inheritance in all agenda types" t)
1833 (repeat :tag "Use tag inheritance in selected agenda types"
1834 (symbol :tag "Agenda type"))))
1836 (defcustom org-agenda-hide-tags-regexp nil
1837 "Regular expression used to filter away specific tags in agenda views.
1838 This means that these tags will be present, but not be shown in the agenda
1839 line. Secondary filtering will still work on the hidden tags.
1840 Nil means don't hide any tags."
1841 :group 'org-agenda-line-format
1842 :type '(choice
1843 (const :tag "Hide none" nil)
1844 (string :tag "Regexp ")))
1846 (defcustom org-agenda-remove-tags nil
1847 "Non-nil means remove the tags from the headline copy in the agenda.
1848 When this is the symbol `prefix', only remove tags when
1849 `org-agenda-prefix-format' contains a `%T' specifier."
1850 :group 'org-agenda-line-format
1851 :type '(choice
1852 (const :tag "Always" t)
1853 (const :tag "Never" nil)
1854 (const :tag "When prefix format contains %T" prefix)))
1856 (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
1857 'org-agenda-remove-tags)
1859 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1860 "Shift tags in agenda items to this column.
1861 If this number is positive, it specifies the column. If it is negative,
1862 it means that the tags should be flushright to that column. For example,
1863 -80 works well for a normal 80 character screen."
1864 :group 'org-agenda-line-format
1865 :type 'integer)
1867 (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
1869 (defcustom org-agenda-fontify-priorities 'cookies
1870 "Non-nil means highlight low and high priorities in agenda.
1871 When t, the highest priority entries are bold, lowest priority italic.
1872 However, settings in `org-priority-faces' will overrule these faces.
1873 When this variable is the symbol `cookies', only fontify the
1874 cookies, not the entire task.
1875 This may also be an association list of priority faces, whose
1876 keys are the character values of `org-highest-priority',
1877 `org-default-priority', and `org-lowest-priority' (the default values
1878 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1879 color as a string, or a list like `(:background \"Red\")'.
1880 If it is a color, the variable `org-faces-easy-properties'
1881 determines if it is a foreground or a background color."
1882 :group 'org-agenda-line-format
1883 :type '(choice
1884 (const :tag "Never" nil)
1885 (const :tag "Defaults" t)
1886 (const :tag "Cookies only" cookies)
1887 (repeat :tag "Specify"
1888 (list (character :tag "Priority" :value ?A)
1889 (choice :tag "Face "
1890 (string :tag "Color")
1891 (sexp :tag "Face"))))))
1893 (defcustom org-agenda-day-face-function nil
1894 "Function called to determine what face should be used to display a day.
1895 The only argument passed to that function is the day. It should
1896 returns a face, or nil if does not want to specify a face and let
1897 the normal rules apply."
1898 :group 'org-agenda-line-format
1899 :version "24.1"
1900 :type '(choice (const nil) (function)))
1902 (defcustom org-agenda-category-icon-alist nil
1903 "Alist of category icon to be displayed in agenda views.
1905 Each entry should have the following format:
1907 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1909 Where CATEGORY-REGEXP is a regexp matching the categories where
1910 the icon should be displayed.
1911 FILE-OR-DATA either a file path or a string containing image data.
1913 The other fields can be omitted safely if not needed:
1914 TYPE indicates the image type.
1915 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1916 image data.
1917 PROPS are additional image attributes to assign to the image,
1918 like, e.g. `:ascent center'.
1920 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1922 If you want to set the display properties yourself, just put a
1923 list as second element:
1925 (CATEGORY-REGEXP (MY PROPERTY LIST))
1927 For example, to display a 16px horizontal space for Emacs
1928 category, you can use:
1930 (\"Emacs\" '(space . (:width (16))))"
1931 :group 'org-agenda-line-format
1932 :version "24.1"
1933 :type '(alist :key-type (string :tag "Regexp matching category")
1934 :value-type (choice (list :tag "Icon"
1935 (string :tag "File or data")
1936 (symbol :tag "Type")
1937 (boolean :tag "Data?")
1938 (repeat :tag "Extra image properties" :inline t symbol))
1939 (list :tag "Display properties" sexp))))
1941 (defgroup org-agenda-column-view nil
1942 "Options concerning column view in the agenda."
1943 :tag "Org Agenda Column View"
1944 :group 'org-agenda)
1946 (defcustom org-agenda-columns-show-summaries t
1947 "Non-nil means show summaries for columns displayed in the agenda view."
1948 :group 'org-agenda-column-view
1949 :type 'boolean)
1951 (defcustom org-agenda-columns-compute-summary-properties t
1952 "Non-nil means recompute all summary properties before column view.
1953 When column view in the agenda is listing properties that have a summary
1954 operator, it can go to all relevant buffers and recompute the summaries
1955 there. This can mean overhead for the agenda column view, but is necessary
1956 to have thing up to date.
1957 As a special case, a CLOCKSUM property also makes sure that the clock
1958 computations are current."
1959 :group 'org-agenda-column-view
1960 :type 'boolean)
1962 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1963 "Non-nil means the duration of an appointment will add to day effort.
1964 The property to which appointment durations will be added is the one given
1965 in the option `org-effort-property'. If an appointment does not have
1966 an end time, `org-agenda-default-appointment-duration' will be used. If that
1967 is not set, an appointment without end time will not contribute to the time
1968 estimate."
1969 :group 'org-agenda-column-view
1970 :type 'boolean)
1972 (defcustom org-agenda-auto-exclude-function nil
1973 "A function called with a tag to decide if it is filtered on '/ RET'.
1974 The sole argument to the function, which is called once for each
1975 possible tag, is a string giving the name of the tag. The
1976 function should return either nil if the tag should be included
1977 as normal, or \"-<TAG>\" to exclude the tag.
1978 Note that for the purpose of tag filtering, only the lower-case version of
1979 all tags will be considered, so that this function will only ever see
1980 the lower-case version of all tags."
1981 :group 'org-agenda
1982 :type '(choice (const nil) (function)))
1984 (defcustom org-agenda-bulk-custom-functions nil
1985 "Alist of characters and custom functions for bulk actions.
1986 For example, this value makes those two functions available:
1988 '((?R set-category)
1989 (?C bulk-cut))
1991 With selected entries in an agenda buffer, `B R' will call
1992 the custom function `set-category' on the selected entries.
1993 Note that functions in this alist don't need to be quoted."
1994 :type 'alist
1995 :version "24.1"
1996 :group 'org-agenda)
1998 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1999 "Execute BODY with point at location given by `org-hd-marker' property.
2000 If STRING is non-nil, the text property will be fetched from position 0
2001 in that string. If STRING is nil, it will be fetched from the beginning
2002 of the current line."
2003 (org-with-gensyms (marker)
2004 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
2005 'org-hd-marker ,string)))
2006 (with-current-buffer (marker-buffer ,marker)
2007 (save-excursion
2008 (goto-char ,marker)
2009 ,@body)))))
2010 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
2012 (defun org-add-agenda-custom-command (entry)
2013 "Replace or add a command in `org-agenda-custom-commands'.
2014 This is mostly for hacking and trying a new command - once the command
2015 works you probably want to add it to `org-agenda-custom-commands' for good."
2016 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
2017 (if ass
2018 (setcdr ass (cdr entry))
2019 (push entry org-agenda-custom-commands))))
2021 ;;; Define the org-agenda-mode
2023 (defvar org-agenda-mode-map (make-sparse-keymap)
2024 "Keymap for `org-agenda-mode'.")
2025 (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
2027 (defvar org-agenda-menu) ; defined later in this file.
2028 (defvar org-agenda-restrict nil) ; defined later in this file.
2029 (defvar org-agenda-follow-mode nil)
2030 (defvar org-agenda-entry-text-mode nil)
2031 (defvar org-agenda-clockreport-mode nil)
2032 (defvar org-agenda-show-log nil)
2033 (defvar org-agenda-redo-command nil)
2034 (defvar org-agenda-query-string nil)
2035 (defvar org-agenda-mode-hook nil
2036 "Hook run after `org-agenda-mode' is turned on.
2037 The buffer is still writable when this hook is called.")
2038 (defvar org-agenda-type nil)
2039 (defvar org-agenda-force-single-file nil)
2040 (defvar org-agenda-bulk-marked-entries nil
2041 "List of markers that refer to marked entries in the agenda.")
2043 ;;; Multiple agenda buffers support
2045 (defcustom org-agenda-sticky nil
2046 "Non-nil means agenda q key will bury agenda buffers.
2047 Agenda commands will then show existing buffer instead of generating new ones.
2048 When nil, `q' will kill the single agenda buffer."
2049 :group 'org-agenda
2050 :version "24.3"
2051 :type 'boolean)
2054 ;;;###autoload
2055 (defun org-toggle-sticky-agenda (&optional arg)
2056 "Toggle `org-agenda-sticky'."
2057 (interactive "P")
2058 (let ((new-value (if arg
2059 (> (prefix-numeric-value arg) 0)
2060 (not org-agenda-sticky))))
2061 (if (equal new-value org-agenda-sticky)
2062 (and (org-called-interactively-p 'interactive)
2063 (message "Sticky agenda was already %s"
2064 (if org-agenda-sticky "enabled" "disabled")))
2065 (setq org-agenda-sticky new-value)
2066 (org-agenda-kill-all-agenda-buffers)
2067 (and (org-called-interactively-p 'interactive)
2068 (message "Sticky agenda was %s"
2069 (if org-agenda-sticky "enabled" "disabled"))))))
2071 (defvar org-agenda-buffer nil
2072 "Agenda buffer currently being generated.")
2074 (defvar org-agenda-last-prefix-arg nil)
2075 (defvar org-agenda-this-buffer-name nil)
2076 (defvar org-agenda-doing-sticky-redo nil)
2077 (defvar org-agenda-this-buffer-is-sticky nil)
2079 (defconst org-agenda-local-vars
2080 '(org-agenda-this-buffer-name
2081 org-agenda-undo-list
2082 org-agenda-pending-undo-list
2083 org-agenda-follow-mode
2084 org-agenda-entry-text-mode
2085 org-agenda-clockreport-mode
2086 org-agenda-show-log
2087 org-agenda-redo-command
2088 org-agenda-query-string
2089 org-agenda-type
2090 org-agenda-bulk-marked-entries
2091 org-agenda-undo-has-started-in
2092 org-agenda-info
2093 org-agenda-pre-window-conf
2094 org-agenda-columns-active
2095 org-agenda-tag-filter-overlays
2096 org-agenda-tag-filter
2097 org-agenda-cat-filter-overlays
2098 org-agenda-category-filter
2099 org-agenda-re-filter-overlays
2100 org-agenda-regexp-filter
2101 org-agenda-markers
2102 org-agenda-last-search-view-search-was-boolean
2103 org-agenda-filtered-by-category
2104 org-agenda-filter-form
2105 org-agenda-cycle-counter
2106 org-agenda-last-prefix-arg)
2107 "Variables that must be local in agenda buffers to allow multiple buffers.")
2109 (defun org-agenda-mode ()
2110 "Mode for time-sorted view on action items in Org-mode files.
2112 The following commands are available:
2114 \\{org-agenda-mode-map}"
2115 (interactive)
2116 (cond (org-agenda-doing-sticky-redo
2117 ;; Refreshing sticky agenda-buffer
2119 ;; Preserve the value of `org-agenda-local-vars' variables,
2120 ;; while letting `kill-all-local-variables' kill the rest
2121 (let ((save (buffer-local-variables)))
2122 (kill-all-local-variables)
2123 (mapc 'make-local-variable org-agenda-local-vars)
2124 (dolist (elem save)
2125 (let ((var (car elem))
2126 (val (cdr elem)))
2127 (when (and val
2128 (member var org-agenda-local-vars))
2129 (set var val)))))
2130 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2131 (org-agenda-sticky
2132 ;; Creating a sticky Agenda buffer for the first time
2133 (kill-all-local-variables)
2134 (mapc 'make-local-variable org-agenda-local-vars)
2135 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2137 ;; Creating a non-sticky agenda buffer
2138 (kill-all-local-variables)
2139 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
2140 (setq org-agenda-undo-list nil
2141 org-agenda-pending-undo-list nil
2142 org-agenda-bulk-marked-entries nil)
2143 (setq major-mode 'org-agenda-mode)
2144 ;; Keep global-font-lock-mode from turning on font-lock-mode
2145 (org-set-local 'font-lock-global-modes (list 'not major-mode))
2146 (setq mode-name "Org-Agenda")
2147 (use-local-map org-agenda-mode-map)
2148 (easy-menu-add org-agenda-menu)
2149 (if org-startup-truncated (setq truncate-lines t))
2150 (org-set-local 'line-move-visual nil)
2151 (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
2152 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
2153 ;; Make sure properties are removed when copying text
2154 (org-add-hook 'filter-buffer-substring-functions
2155 (lambda (fun start end delete)
2156 (substring-no-properties (funcall fun start end delete)))
2157 nil t)
2158 (unless org-agenda-keep-modes
2159 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2160 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
2161 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
2162 org-agenda-show-log org-agenda-start-with-log-mode))
2164 (easy-menu-change
2165 '("Agenda") "Agenda Files"
2166 (append
2167 (list
2168 (vector
2169 (if (get 'org-agenda-files 'org-restrict)
2170 "Restricted to single file"
2171 "Edit File List")
2172 '(org-edit-agenda-file-list)
2173 (not (get 'org-agenda-files 'org-restrict)))
2174 "--")
2175 (mapcar 'org-file-menu-entry (org-agenda-files))))
2176 (org-agenda-set-mode-name)
2177 (apply
2178 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
2179 (list 'org-agenda-mode-hook)))
2181 (substitute-key-definition 'undo 'org-agenda-undo
2182 org-agenda-mode-map global-map)
2183 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
2184 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
2185 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
2186 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
2187 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2188 (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
2189 (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
2190 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2191 (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
2192 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2193 (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
2194 (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
2195 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2196 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2197 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2198 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2199 (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
2200 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2201 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2202 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2203 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2204 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2205 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2206 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2207 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2208 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2209 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2210 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2211 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2212 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2213 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2214 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2215 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2216 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2217 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2218 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2219 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2220 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2221 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2222 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2223 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2224 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2225 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2226 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2227 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2228 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2229 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2230 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2231 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2232 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2234 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2235 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2236 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2237 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2238 (while l (org-defkey org-agenda-mode-map
2239 (int-to-string (pop l)) 'digit-argument)))
2241 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2242 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2243 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2244 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2245 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2246 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2247 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2248 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2249 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2250 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2251 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2252 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2253 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2254 'org-clock-modify-effort-estimate)
2255 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2256 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2257 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2258 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2259 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2260 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2261 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2262 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2263 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2264 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2265 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2266 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2267 (substitute-key-definition 'next-line 'org-agenda-next-line
2268 org-agenda-mode-map global-map)
2269 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2270 org-agenda-mode-map global-map)
2271 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2272 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2273 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2274 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2275 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2276 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2277 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2278 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2279 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2280 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2281 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2282 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2283 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2284 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2285 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2286 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2287 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2288 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2289 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2290 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2291 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2292 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2293 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2294 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2295 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2296 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2297 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2298 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2299 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2300 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2302 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2303 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2304 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2305 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2306 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2307 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2308 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2309 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2310 (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
2311 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2312 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
2313 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2314 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2315 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2316 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2318 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2319 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2320 (when org-agenda-mouse-1-follows-link
2321 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2322 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2323 '("Agenda"
2324 ("Agenda Files")
2325 "--"
2326 ("Agenda Dates"
2327 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2328 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2329 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2330 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2331 "--"
2332 ("View"
2333 ["Day View" org-agenda-day-view
2334 :active (org-agenda-check-type nil 'agenda)
2335 :style radio :selected (eq org-agenda-current-span 'day)
2336 :keys "v d (or just d)"]
2337 ["Week View" org-agenda-week-view
2338 :active (org-agenda-check-type nil 'agenda)
2339 :style radio :selected (eq org-agenda-current-span 'week)
2340 :keys "v w"]
2341 ["Fortnight View" org-agenda-fortnight-view
2342 :active (org-agenda-check-type nil 'agenda)
2343 :style radio :selected (eq org-agenda-current-span 'fortnight)
2344 :keys "v f"]
2345 ["Month View" org-agenda-month-view
2346 :active (org-agenda-check-type nil 'agenda)
2347 :style radio :selected (eq org-agenda-current-span 'month)
2348 :keys "v m"]
2349 ["Year View" org-agenda-year-view
2350 :active (org-agenda-check-type nil 'agenda)
2351 :style radio :selected (eq org-agenda-current-span 'year)
2352 :keys "v y"]
2353 "--"
2354 ["Include Diary" org-agenda-toggle-diary
2355 :style toggle :selected org-agenda-include-diary
2356 :active (org-agenda-check-type nil 'agenda)]
2357 ["Include Deadlines" org-agenda-toggle-deadlines
2358 :style toggle :selected org-agenda-include-deadlines
2359 :active (org-agenda-check-type nil 'agenda)]
2360 ["Use Time Grid" org-agenda-toggle-time-grid
2361 :style toggle :selected org-agenda-use-time-grid
2362 :active (org-agenda-check-type nil 'agenda)]
2363 "--"
2364 ["Show clock report" org-agenda-clockreport-mode
2365 :style toggle :selected org-agenda-clockreport-mode
2366 :active (org-agenda-check-type nil 'agenda)]
2367 ["Show some entry text" org-agenda-entry-text-mode
2368 :style toggle :selected org-agenda-entry-text-mode
2369 :active t]
2370 "--"
2371 ["Show Logbook entries" org-agenda-log-mode
2372 :style toggle :selected org-agenda-show-log
2373 :active (org-agenda-check-type nil 'agenda 'timeline)
2374 :keys "v l (or just l)"]
2375 ["Include archived trees" org-agenda-archives-mode
2376 :style toggle :selected org-agenda-archives-mode :active t
2377 :keys "v a"]
2378 ["Include archive files" (org-agenda-archives-mode t)
2379 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2380 :keys "v A"]
2381 "--"
2382 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2383 ["Write view to file" org-agenda-write t]
2384 ["Rebuild buffer" org-agenda-redo t]
2385 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2386 "--"
2387 ["Show original entry" org-agenda-show t]
2388 ["Go To (other window)" org-agenda-goto t]
2389 ["Go To (this window)" org-agenda-switch-to t]
2390 ["Capture with cursor date" org-agenda-capture t]
2391 ["Follow Mode" org-agenda-follow-mode
2392 :style toggle :selected org-agenda-follow-mode :active t]
2393 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2394 "--"
2395 ("TODO"
2396 ["Cycle TODO" org-agenda-todo t]
2397 ["Next TODO set" org-agenda-todo-nextset t]
2398 ["Previous TODO set" org-agenda-todo-previousset t]
2399 ["Add note" org-agenda-add-note t])
2400 ("Archive/Refile/Delete"
2401 ["Archive default" org-agenda-archive-default t]
2402 ["Archive default" org-agenda-archive-default-with-confirmation t]
2403 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2404 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2405 ["Archive subtree" org-agenda-archive t]
2406 "--"
2407 ["Refile" org-agenda-refile t]
2408 "--"
2409 ["Delete subtree" org-agenda-kill t])
2410 ("Bulk action"
2411 ["Mark entry" org-agenda-bulk-mark t]
2412 ["Mark all" org-agenda-bulk-mark-all t]
2413 ["Unmark entry" org-agenda-bulk-unmark t]
2414 ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
2415 ["Toggle mark" org-agenda-bulk-toggle t]
2416 ["Toggle all" org-agenda-bulk-toggle-all t]
2417 ["Mark regexp" org-agenda-bulk-mark-regexp t])
2418 ["Act on all marked" org-agenda-bulk-action t]
2419 "--"
2420 ("Tags and Properties"
2421 ["Show all Tags" org-agenda-show-tags t]
2422 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2423 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2424 "--"
2425 ["Column View" org-columns t])
2426 ("Deadline/Schedule"
2427 ["Schedule" org-agenda-schedule t]
2428 ["Set Deadline" org-agenda-deadline t]
2429 "--"
2430 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2431 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2432 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2433 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2434 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2435 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2436 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2437 ("Clock and Effort"
2438 ["Clock in" org-agenda-clock-in t]
2439 ["Clock out" org-agenda-clock-out t]
2440 ["Clock cancel" org-agenda-clock-cancel t]
2441 ["Goto running clock" org-clock-goto t]
2442 "--"
2443 ["Set Effort" org-agenda-set-effort t]
2444 ["Change clocked effort" org-clock-modify-effort-estimate
2445 (org-clock-is-active)])
2446 ("Priority"
2447 ["Set Priority" org-agenda-priority t]
2448 ["Increase Priority" org-agenda-priority-up t]
2449 ["Decrease Priority" org-agenda-priority-down t]
2450 ["Show Priority" org-show-priority t])
2451 ("Calendar/Diary"
2452 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2453 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2454 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2455 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2456 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2457 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2458 "--"
2459 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2460 "--"
2461 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2462 "--"
2463 ("MobileOrg"
2464 ["Push Files and Views" org-mobile-push t]
2465 ["Get Captured and Flagged" org-mobile-pull t]
2466 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2467 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2468 "--"
2469 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2470 "--"
2471 ["Quit" org-agenda-quit t]
2472 ["Exit and Release Buffers" org-agenda-exit t]
2475 ;;; Agenda undo
2477 (defvar org-agenda-allow-remote-undo t
2478 "Non-nil means allow remote undo from the agenda buffer.")
2479 (defvar org-agenda-undo-has-started-in nil
2480 "Buffers that have already seen `undo-start' in the current undo sequence.")
2482 (defun org-agenda-undo ()
2483 "Undo a remote editing step in the agenda.
2484 This undoes changes both in the agenda buffer and in the remote buffer
2485 that have been changed along."
2486 (interactive)
2487 (or org-agenda-allow-remote-undo
2488 (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2489 (if (not (eq this-command last-command))
2490 (setq org-agenda-undo-has-started-in nil
2491 org-agenda-pending-undo-list org-agenda-undo-list))
2492 (if (not org-agenda-pending-undo-list)
2493 (user-error "No further undo information"))
2494 (let* ((entry (pop org-agenda-pending-undo-list))
2495 buf line cmd rembuf)
2496 (setq cmd (pop entry) line (pop entry))
2497 (setq rembuf (nth 2 entry))
2498 (org-with-remote-undo rembuf
2499 (while (bufferp (setq buf (pop entry)))
2500 (if (pop entry)
2501 (with-current-buffer buf
2502 (let ((last-undo-buffer buf)
2503 (inhibit-read-only t))
2504 (unless (memq buf org-agenda-undo-has-started-in)
2505 (push buf org-agenda-undo-has-started-in)
2506 (make-local-variable 'pending-undo-list)
2507 (undo-start))
2508 (while (and pending-undo-list
2509 (listp pending-undo-list)
2510 (not (car pending-undo-list)))
2511 (pop pending-undo-list))
2512 (undo-more 1))))))
2513 (org-goto-line line)
2514 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2516 (defun org-verify-change-for-undo (l1 l2)
2517 "Verify that a real change occurred between the undo lists L1 and L2."
2518 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2519 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2520 (not (eq l1 l2)))
2522 ;;; Agenda dispatch
2524 (defvar org-agenda-restrict-begin (make-marker))
2525 (defvar org-agenda-restrict-end (make-marker))
2526 (defvar org-agenda-last-dispatch-buffer nil)
2527 (defvar org-agenda-overriding-restriction nil)
2529 (defcustom org-agenda-custom-commands-contexts nil
2530 "Alist of custom agenda keys and contextual rules.
2532 For example, if you have a custom agenda command \"p\" and you
2533 want this command to be accessible only from plain text files,
2534 use this:
2536 '((\"p\" ((in-file . \"\\.txt\"))))
2538 Here are the available contexts definitions:
2540 in-file: command displayed only in matching files
2541 in-mode: command displayed only in matching modes
2542 not-in-file: command not displayed in matching files
2543 not-in-mode: command not displayed in matching modes
2544 in-buffer: command displayed only in matching buffers
2545 not-in-buffer: command not displayed in matching buffers
2546 [function]: a custom function taking no argument
2548 If you define several checks, the agenda command will be
2549 accessible if there is at least one valid check.
2551 You can also bind a key to another agenda custom command
2552 depending on contextual rules.
2554 '((\"p\" \"q\" ((in-file . \"\\.txt\"))))
2556 Here it means: in .txt files, use \"p\" as the key for the
2557 agenda command otherwise associated with \"q\". (The command
2558 originally associated with \"q\" is not displayed to avoid
2559 duplicates.)"
2560 :version "24.3"
2561 :group 'org-agenda-custom-commands
2562 :type '(repeat (list :tag "Rule"
2563 (string :tag " Agenda key")
2564 (string :tag "Replace by command")
2565 (repeat :tag "Available when"
2566 (choice
2567 (cons :tag "Condition"
2568 (choice
2569 (const :tag "In file" in-file)
2570 (const :tag "Not in file" not-in-file)
2571 (const :tag "In buffer" in-buffer)
2572 (const :tag "Not in buffer" not-in-buffer)
2573 (const :tag "In mode" in-mode)
2574 (const :tag "Not in mode" not-in-mode))
2575 (regexp))
2576 (function :tag "Custom function"))))))
2578 (defcustom org-agenda-max-entries nil
2579 "Maximum number of entries to display in an agenda.
2580 This can be nil (no limit) or an integer or an alist of agenda
2581 types with an associated number of entries to display in this
2582 type."
2583 :version "24.4"
2584 :package-version '(Org . "8.0")
2585 :group 'org-agenda-custom-commands
2586 :type '(choice (symbol :tag "No limit" nil)
2587 (integer :tag "Max number of entries")
2588 (repeat
2589 (cons (choice :tag "Agenda type"
2590 (const agenda)
2591 (const todo)
2592 (const tags)
2593 (const search)
2594 (const timeline))
2595 (integer :tag "Max number of entries")))))
2597 (defcustom org-agenda-max-todos nil
2598 "Maximum number of TODOs to display in an agenda.
2599 This can be nil (no limit) or an integer or an alist of agenda
2600 types with an associated number of entries to display in this
2601 type."
2602 :version "24.4"
2603 :package-version '(Org . "8.0")
2604 :group 'org-agenda-custom-commands
2605 :type '(choice (symbol :tag "No limit" nil)
2606 (integer :tag "Max number of entries")
2607 (repeat
2608 (cons (choice :tag "Agenda type"
2609 (const agenda)
2610 (const todo)
2611 (const tags)
2612 (const search)
2613 (const timeline))
2614 (integer :tag "Max number of entries")))))
2616 (defcustom org-agenda-max-tags nil
2617 "Maximum number of tagged entries to display in an agenda.
2618 This can be nil (no limit) or an integer or an alist of agenda
2619 types with an associated number of entries to display in this
2620 type."
2621 :version "24.4"
2622 :package-version '(Org . "8.0")
2623 :group 'org-agenda-custom-commands
2624 :type '(choice (symbol :tag "No limit" nil)
2625 (integer :tag "Max number of entries")
2626 (repeat
2627 (cons (choice :tag "Agenda type"
2628 (const agenda)
2629 (const todo)
2630 (const tags)
2631 (const search)
2632 (const timeline))
2633 (integer :tag "Max number of entries")))))
2635 (defcustom org-agenda-max-effort nil
2636 "Maximum cumulated effort duration for the agenda.
2637 This can be nil (no limit) or a number of minutes (as an integer)
2638 or an alist of agenda types with an associated number of minutes
2639 to limit entries to in this type."
2640 :version "24.4"
2641 :package-version '(Org . "8.0")
2642 :group 'org-agenda-custom-commands
2643 :type '(choice (symbol :tag "No limit" nil)
2644 (integer :tag "Max number of entries")
2645 (repeat
2646 (cons (choice :tag "Agenda type"
2647 (const agenda)
2648 (const todo)
2649 (const tags)
2650 (const search)
2651 (const timeline))
2652 (integer :tag "Max number of entries")))))
2654 (defvar org-keys nil)
2655 (defvar org-match nil)
2656 ;;;###autoload
2657 (defun org-agenda (&optional arg org-keys restriction)
2658 "Dispatch agenda commands to collect entries to the agenda buffer.
2659 Prompts for a command to execute. Any prefix arg will be passed
2660 on to the selected command. The default selections are:
2662 a Call `org-agenda-list' to display the agenda for current day or week.
2663 t Call `org-todo-list' to display the global todo list.
2664 T Call `org-todo-list' to display the global todo list, select only
2665 entries with a specific TODO keyword (the user gets a prompt).
2666 m Call `org-tags-view' to display headlines with tags matching
2667 a condition (the user is prompted for the condition).
2668 M Like `m', but select only TODO entries, no ordinary headlines.
2669 L Create a timeline for the current buffer.
2670 e Export views to associated files.
2671 s Search entries for keywords.
2672 S Search entries for keywords, only with TODO keywords.
2673 / Multi occur across all agenda files and also files listed
2674 in `org-agenda-text-search-extra-files'.
2675 < Restrict agenda commands to buffer, subtree, or region.
2676 Press several times to get the desired effect.
2677 > Remove a previous restriction.
2678 # List \"stuck\" projects.
2679 ! Configure what \"stuck\" means.
2680 C Configure custom agenda commands.
2682 More commands can be added by configuring the variable
2683 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2684 searches can be pre-defined in this way.
2686 If the current buffer is in Org-mode and visiting a file, you can also
2687 first press `<' once to indicate that the agenda should be temporarily
2688 \(until the next use of \\[org-agenda]) restricted to the current file.
2689 Pressing `<' twice means to restrict to the current subtree or region
2690 \(if active)."
2691 (interactive "P")
2692 (catch 'exit
2693 (let* ((prefix-descriptions nil)
2694 (org-agenda-buffer-name org-agenda-buffer-name)
2695 (org-agenda-window-setup (if (equal (buffer-name)
2696 org-agenda-buffer-name)
2697 'current-window
2698 org-agenda-window-setup))
2699 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2700 (org-agenda-custom-commands
2701 ;; normalize different versions
2702 (delq nil
2703 (mapcar
2704 (lambda (x)
2705 (cond ((stringp (cdr x))
2706 (push x prefix-descriptions)
2707 nil)
2708 ((stringp (nth 1 x)) x)
2709 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2710 (t (cons (car x) (cons "" (cdr x))))))
2711 org-agenda-custom-commands)))
2712 (org-agenda-custom-commands
2713 (org-contextualize-keys
2714 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2715 (buf (current-buffer))
2716 (bfn (buffer-file-name (buffer-base-buffer)))
2717 entry key type org-match lprops ans)
2718 ;; Turn off restriction unless there is an overriding one,
2719 (unless org-agenda-overriding-restriction
2720 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2721 ;; There is a request to keep the file list in place
2722 (put 'org-agenda-files 'org-restrict nil))
2723 (setq org-agenda-restrict nil)
2724 (move-marker org-agenda-restrict-begin nil)
2725 (move-marker org-agenda-restrict-end nil))
2726 ;; Delete old local properties
2727 (put 'org-agenda-redo-command 'org-lprops nil)
2728 ;; Delete previously set last-arguments
2729 (put 'org-agenda-redo-command 'last-args nil)
2730 ;; Remember where this call originated
2731 (setq org-agenda-last-dispatch-buffer (current-buffer))
2732 (unless org-keys
2733 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2734 org-keys (car ans)
2735 restriction (cdr ans)))
2736 ;; If we have sticky agenda buffers, set a name for the buffer,
2737 ;; depending on the invoking keys. The user may still set this
2738 ;; as a command option, which will overwrite what we do here.
2739 (if org-agenda-sticky
2740 (setq org-agenda-buffer-name
2741 (format "*Org Agenda(%s)*" org-keys)))
2742 ;; Establish the restriction, if any
2743 (when (and (not org-agenda-overriding-restriction) restriction)
2744 (put 'org-agenda-files 'org-restrict (list bfn))
2745 (cond
2746 ((eq restriction 'region)
2747 (setq org-agenda-restrict (current-buffer))
2748 (move-marker org-agenda-restrict-begin (region-beginning))
2749 (move-marker org-agenda-restrict-end (region-end)))
2750 ((eq restriction 'subtree)
2751 (save-excursion
2752 (setq org-agenda-restrict (current-buffer))
2753 (org-back-to-heading t)
2754 (move-marker org-agenda-restrict-begin (point))
2755 (move-marker org-agenda-restrict-end
2756 (progn (org-end-of-subtree t)))))))
2758 ;; For example the todo list should not need it (but does...)
2759 (cond
2760 ((setq entry (assoc org-keys org-agenda-custom-commands))
2761 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2762 (progn
2763 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2764 lprops (nth 4 entry))
2765 (if org-agenda-sticky
2766 (setq org-agenda-buffer-name
2767 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2768 (format "*Org Agenda(%s)*" org-keys))))
2769 (put 'org-agenda-redo-command 'org-lprops lprops)
2770 (cond
2771 ((eq type 'agenda)
2772 (org-let lprops '(org-agenda-list current-prefix-arg)))
2773 ((eq type 'agenda*)
2774 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2775 ((eq type 'alltodo)
2776 (org-let lprops '(org-todo-list current-prefix-arg)))
2777 ((eq type 'search)
2778 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2779 ((eq type 'stuck)
2780 (org-let lprops '(org-agenda-list-stuck-projects
2781 current-prefix-arg)))
2782 ((eq type 'tags)
2783 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2784 ((eq type 'tags-todo)
2785 (org-let lprops '(org-tags-view '(4) org-match)))
2786 ((eq type 'todo)
2787 (org-let lprops '(org-todo-list org-match)))
2788 ((eq type 'tags-tree)
2789 (org-check-for-org-mode)
2790 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2791 ((eq type 'todo-tree)
2792 (org-check-for-org-mode)
2793 (org-let lprops
2794 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2795 (regexp-quote org-match) "\\>"))))
2796 ((eq type 'occur-tree)
2797 (org-check-for-org-mode)
2798 (org-let lprops '(org-occur org-match)))
2799 ((functionp type)
2800 (org-let lprops '(funcall type org-match)))
2801 ((fboundp type)
2802 (org-let lprops '(funcall type org-match)))
2803 (t (user-error "Invalid custom agenda command type %s" type))))
2804 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2805 ((equal org-keys "C")
2806 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2807 (customize-variable 'org-agenda-custom-commands))
2808 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2809 ((equal org-keys "s") (call-interactively 'org-search-view))
2810 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2811 ((equal org-keys "t") (call-interactively 'org-todo-list))
2812 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2813 ((equal org-keys "m") (call-interactively 'org-tags-view))
2814 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2815 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2816 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2817 (org-add-hook
2818 'post-command-hook
2819 (lambda ()
2820 (unless (current-message)
2821 (let* ((m (org-agenda-get-any-marker))
2822 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2823 (when note
2824 (message (concat
2825 "FLAGGING-NOTE ([?] for more info): "
2826 (org-add-props
2827 (replace-regexp-in-string
2828 "\\\\n" "//"
2829 (copy-sequence note))
2830 nil 'face 'org-warning)))))))
2831 t t))
2832 ((equal org-keys "L")
2833 (unless (derived-mode-p 'org-mode)
2834 (user-error "This is not an Org-mode file"))
2835 (unless restriction
2836 (put 'org-agenda-files 'org-restrict (list bfn))
2837 (org-call-with-arg 'org-timeline arg)))
2838 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2839 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2840 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2841 (t (user-error "Invalid agenda key"))))))
2843 (defvar org-agenda-multi)
2845 (defun org-agenda-append-agenda ()
2846 "Append another agenda view to the current one.
2847 This function allows interactive building of block agendas.
2848 Agenda views are separated by `org-agenda-block-separator'."
2849 (interactive)
2850 (unless (derived-mode-p 'org-agenda-mode)
2851 (user-error "Can only append from within agenda buffer"))
2852 (let ((org-agenda-multi t))
2853 (org-agenda)
2854 (widen)
2855 (org-agenda-finalize)
2856 (setq buffer-read-only t)
2857 (org-agenda-fit-window-to-buffer)))
2859 (defun org-agenda-normalize-custom-commands (cmds)
2860 "Normalize custom commands CMDS."
2861 (delq nil
2862 (mapcar
2863 (lambda (x)
2864 (cond ((stringp (cdr x)) nil)
2865 ((stringp (nth 1 x)) x)
2866 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2867 (t (cons (car x) (cons "" (cdr x))))))
2868 cmds)))
2870 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2871 "The user interface for selecting an agenda command."
2872 (catch 'exit
2873 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2874 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2875 (region-p (org-region-active-p))
2876 (custom org-agenda-custom-commands)
2877 (selstring "")
2878 restriction second-time
2879 c entry key type match prefixes rmheader header-end custom1 desc
2880 line lines left right n n1)
2881 (save-window-excursion
2882 (delete-other-windows)
2883 (org-switch-to-buffer-other-window " *Agenda Commands*")
2884 (erase-buffer)
2885 (insert (eval-when-compile
2886 (let ((header
2887 "Press key for an agenda command: < Buffer, subtree/region restriction
2888 -------------------------------- > Remove restriction
2889 a Agenda for current week or day e Export agenda views
2890 t List of all TODO entries T Entries with special TODO kwd
2891 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2892 s Search for keywords S Like s, but only TODO entries
2893 L Timeline for current buffer # List stuck projects (!=configure)
2894 / Multi-occur C Configure custom agenda commands
2895 ? Find :FLAGGED: entries * Toggle sticky agenda views
2897 (start 0))
2898 (while (string-match
2899 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2900 header start)
2901 (setq start (match-end 0))
2902 (add-text-properties (match-beginning 2) (match-end 2)
2903 '(face bold) header))
2904 header)))
2905 (setq header-end (point-marker))
2906 (while t
2907 (setq custom1 custom)
2908 (when (eq rmheader t)
2909 (org-goto-line 1)
2910 (re-search-forward ":" nil t)
2911 (delete-region (match-end 0) (point-at-eol))
2912 (forward-char 1)
2913 (looking-at "-+")
2914 (delete-region (match-end 0) (point-at-eol))
2915 (move-marker header-end (match-end 0)))
2916 (goto-char header-end)
2917 (delete-region (point) (point-max))
2919 ;; Produce all the lines that describe custom commands and prefixes
2920 (setq lines nil)
2921 (while (setq entry (pop custom1))
2922 (setq key (car entry) desc (nth 1 entry)
2923 type (nth 2 entry)
2924 match (nth 3 entry))
2925 (if (> (length key) 1)
2926 (add-to-list 'prefixes (string-to-char key))
2927 (setq line
2928 (format
2929 "%-4s%-14s"
2930 (org-add-props (copy-sequence key)
2931 '(face bold))
2932 (cond
2933 ((string-match "\\S-" desc) desc)
2934 ((eq type 'agenda) "Agenda for current week or day")
2935 ((eq type 'agenda*) "Appointments for current week or day")
2936 ((eq type 'alltodo) "List of all TODO entries")
2937 ((eq type 'search) "Word search")
2938 ((eq type 'stuck) "List of stuck projects")
2939 ((eq type 'todo) "TODO keyword")
2940 ((eq type 'tags) "Tags query")
2941 ((eq type 'tags-todo) "Tags (TODO)")
2942 ((eq type 'tags-tree) "Tags tree")
2943 ((eq type 'todo-tree) "TODO kwd tree")
2944 ((eq type 'occur-tree) "Occur tree")
2945 ((functionp type) (if (symbolp type)
2946 (symbol-name type)
2947 "Lambda expression"))
2948 (t "???"))))
2949 (if org-agenda-menu-show-matcher
2950 (setq line
2951 (concat line ": "
2952 (cond
2953 ((stringp match)
2954 (setq match (copy-sequence match))
2955 (org-add-props match nil 'face 'org-warning))
2956 ((listp type)
2957 (format "set of %d commands" (length type))))))
2958 (if (org-string-nw-p match)
2959 (add-text-properties
2960 0 (length line) (list 'help-echo
2961 (concat "Matcher: " match)) line)))
2962 (push line lines)))
2963 (setq lines (nreverse lines))
2964 (when prefixes
2965 (mapc (lambda (x)
2966 (push
2967 (format "%s %s"
2968 (org-add-props (char-to-string x)
2969 nil 'face 'bold)
2970 (or (cdr (assoc (concat selstring
2971 (char-to-string x))
2972 prefix-descriptions))
2973 "Prefix key"))
2974 lines))
2975 prefixes))
2977 ;; Check if we should display in two columns
2978 (if org-agenda-menu-two-columns
2979 (progn
2980 (setq n (length lines)
2981 n1 (+ (/ n 2) (mod n 2))
2982 right (nthcdr n1 lines)
2983 left (copy-sequence lines))
2984 (setcdr (nthcdr (1- n1) left) nil))
2985 (setq left lines right nil))
2986 (while left
2987 (insert "\n" (pop left))
2988 (when right
2989 (if (< (current-column) 40)
2990 (move-to-column 40 t)
2991 (insert " "))
2992 (insert (pop right))))
2994 ;; Make the window the right size
2995 (goto-char (point-min))
2996 (if second-time
2997 (if (not (pos-visible-in-window-p (point-max)))
2998 (org-fit-window-to-buffer))
2999 (setq second-time t)
3000 (org-fit-window-to-buffer))
3002 ;; Ask for selection
3003 (message "Press key for agenda command%s:"
3004 (if (or restrict-ok org-agenda-overriding-restriction)
3005 (if org-agenda-overriding-restriction
3006 " (restriction lock active)"
3007 (if restriction
3008 (format " (restricted to %s)" restriction)
3009 " (unrestricted)"))
3010 ""))
3011 (setq c (read-char-exclusive))
3012 (message "")
3013 (cond
3014 ((assoc (char-to-string c) custom)
3015 (setq selstring (concat selstring (char-to-string c)))
3016 (throw 'exit (cons selstring restriction)))
3017 ((memq c prefixes)
3018 (setq selstring (concat selstring (char-to-string c))
3019 prefixes nil
3020 rmheader (or rmheader t)
3021 custom (delq nil (mapcar
3022 (lambda (x)
3023 (if (or (= (length (car x)) 1)
3024 (/= (string-to-char (car x)) c))
3026 (cons (substring (car x) 1) (cdr x))))
3027 custom))))
3028 ((eq c ?*)
3029 (call-interactively 'org-toggle-sticky-agenda)
3030 (sit-for 2))
3031 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3032 (message "Restriction is only possible in Org-mode buffers")
3033 (ding) (sit-for 1))
3034 ((eq c ?1)
3035 (org-agenda-remove-restriction-lock 'noupdate)
3036 (setq restriction 'buffer))
3037 ((eq c ?0)
3038 (org-agenda-remove-restriction-lock 'noupdate)
3039 (setq restriction (if region-p 'region 'subtree)))
3040 ((eq c ?<)
3041 (org-agenda-remove-restriction-lock 'noupdate)
3042 (setq restriction
3043 (cond
3044 ((eq restriction 'buffer)
3045 (if region-p 'region 'subtree))
3046 ((memq restriction '(subtree region))
3047 nil)
3048 (t 'buffer))))
3049 ((eq c ?>)
3050 (org-agenda-remove-restriction-lock 'noupdate)
3051 (setq restriction nil))
3052 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3053 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3054 ((and (> (length selstring) 0) (eq c ?\d))
3055 (delete-window)
3056 (org-agenda-get-restriction-and-command prefix-descriptions))
3058 ((equal c ?q) (error "Abort"))
3059 (t (user-error "Invalid key %c" c))))))))
3061 (defun org-agenda-fit-window-to-buffer ()
3062 "Fit the window to the buffer size."
3063 (and (memq org-agenda-window-setup '(reorganize-frame))
3064 (fboundp 'fit-window-to-buffer)
3065 (org-fit-window-to-buffer
3067 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3068 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3070 (defvar org-cmd nil)
3071 (defvar org-agenda-overriding-cmd nil)
3072 (defvar org-agenda-overriding-arguments nil)
3073 (defvar org-agenda-overriding-cmd-arguments nil)
3074 (defun org-agenda-run-series (name series)
3075 "Run agenda NAME as a SERIES of agenda commands."
3076 (org-let (nth 1 series) '(org-agenda-prepare name))
3077 ;; We need to reset agenda markers here, because when constructing a
3078 ;; block agenda, the individual blocks do not do that.
3079 (org-agenda-reset-markers)
3080 (let* ((org-agenda-multi t)
3081 (redo (list 'org-agenda-run-series name (list 'quote series)))
3082 (cmds (car series))
3083 (gprops (nth 1 series))
3084 match ;; The byte compiler incorrectly complains about this. Keep it!
3085 org-cmd type lprops)
3086 (while (setq org-cmd (pop cmds))
3087 (setq type (car org-cmd)
3088 match (eval (nth 1 org-cmd))
3089 lprops (nth 2 org-cmd))
3090 (let ((org-agenda-overriding-arguments
3091 (if (eq org-agenda-overriding-cmd org-cmd)
3092 (or org-agenda-overriding-arguments
3093 org-agenda-overriding-cmd-arguments))))
3094 (cond
3095 ((eq type 'agenda)
3096 (org-let2 gprops lprops
3097 '(call-interactively 'org-agenda-list)))
3098 ((eq type 'agenda*)
3099 (org-let2 gprops lprops
3100 '(funcall 'org-agenda-list nil nil t)))
3101 ((eq type 'alltodo)
3102 (org-let2 gprops lprops
3103 '(call-interactively 'org-todo-list)))
3104 ((eq type 'search)
3105 (org-let2 gprops lprops
3106 '(org-search-view current-prefix-arg match nil)))
3107 ((eq type 'stuck)
3108 (org-let2 gprops lprops
3109 '(call-interactively 'org-agenda-list-stuck-projects)))
3110 ((eq type 'tags)
3111 (org-let2 gprops lprops
3112 '(org-tags-view current-prefix-arg match)))
3113 ((eq type 'tags-todo)
3114 (org-let2 gprops lprops
3115 '(org-tags-view '(4) match)))
3116 ((eq type 'todo)
3117 (org-let2 gprops lprops
3118 '(org-todo-list match)))
3119 ((fboundp type)
3120 (org-let2 gprops lprops
3121 '(funcall type match)))
3122 (t (error "Invalid type in command series")))))
3123 (widen)
3124 (let ((inhibit-read-only t))
3125 (add-text-properties (point-min) (point-max)
3126 `(org-series t org-series-redo-cmd ,redo)))
3127 (setq org-agenda-redo-command redo)
3128 (goto-char (point-min)))
3129 (org-agenda-fit-window-to-buffer)
3130 (org-let (nth 1 series) '(org-agenda-finalize)))
3132 ;;;###autoload
3133 (defmacro org-batch-agenda (cmd-key &rest parameters)
3134 "Run an agenda command in batch mode and send the result to STDOUT.
3135 If CMD-KEY is a string of length 1, it is used as a key in
3136 `org-agenda-custom-commands' and triggers this command. If it is a
3137 longer string it is used as a tags/todo match string.
3138 Parameters are alternating variable names and values that will be bound
3139 before running the agenda command."
3140 (org-eval-in-environment (org-make-parameter-alist parameters)
3141 (let (org-agenda-sticky)
3142 (if (> (length cmd-key) 2)
3143 (org-tags-view nil cmd-key)
3144 (org-agenda nil cmd-key))))
3145 (set-buffer org-agenda-buffer-name)
3146 (princ (buffer-string)))
3148 (defvar org-agenda-info nil)
3150 ;;;###autoload
3151 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3152 "Run an agenda command in batch mode and send the result to STDOUT.
3153 If CMD-KEY is a string of length 1, it is used as a key in
3154 `org-agenda-custom-commands' and triggers this command. If it is a
3155 longer string it is used as a tags/todo match string.
3156 Parameters are alternating variable names and values that will be bound
3157 before running the agenda command.
3159 The output gives a line for each selected agenda item. Each
3160 item is a list of comma-separated values, like this:
3162 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3164 category The category of the item
3165 head The headline, without TODO kwd, TAGS and PRIORITY
3166 type The type of the agenda entry, can be
3167 todo selected in TODO match
3168 tagsmatch selected in tags match
3169 diary imported from diary
3170 deadline a deadline on given date
3171 scheduled scheduled on given date
3172 timestamp entry has timestamp on given date
3173 closed entry was closed on given date
3174 upcoming-deadline warning about deadline
3175 past-scheduled forwarded scheduled item
3176 block entry has date block including g. date
3177 todo The todo keyword, if any
3178 tags All tags including inherited ones, separated by colons
3179 date The relevant date, like 2007-2-14
3180 time The time, like 15:00-16:50
3181 extra Sting with extra planning info
3182 priority-l The priority letter if any was given
3183 priority-n The computed numerical priority
3184 agenda-day The day in the agenda where this is listed"
3185 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3186 (org-make-parameter-alist parameters))
3187 (if (> (length cmd-key) 2)
3188 (org-tags-view nil cmd-key)
3189 (org-agenda nil cmd-key)))
3190 (set-buffer org-agenda-buffer-name)
3191 (let* ((lines (org-split-string (buffer-string) "\n"))
3192 line)
3193 (while (setq line (pop lines))
3194 (catch 'next
3195 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3196 (setq org-agenda-info
3197 (org-fix-agenda-info (text-properties-at 0 line)))
3198 (princ
3199 (mapconcat 'org-agenda-export-csv-mapper
3200 '(org-category txt type todo tags date time extra
3201 priority-letter priority agenda-day)
3202 ","))
3203 (princ "\n")))))
3205 (defun org-fix-agenda-info (props)
3206 "Make sure all properties on an agenda item have a canonical form.
3207 This ensures the export commands can easily use it."
3208 (let (tmp re)
3209 (when (setq tmp (plist-get props 'tags))
3210 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3211 (when (setq tmp (plist-get props 'date))
3212 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3213 (let ((calendar-date-display-form '(year "-" month "-" day)))
3214 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3216 (setq tmp (calendar-date-string tmp)))
3217 (setq props (plist-put props 'date tmp)))
3218 (when (setq tmp (plist-get props 'day))
3219 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3220 (let ((calendar-date-display-form '(year "-" month "-" day)))
3221 (setq tmp (calendar-date-string tmp)))
3222 (setq props (plist-put props 'day tmp))
3223 (setq props (plist-put props 'agenda-day tmp)))
3224 (when (setq tmp (plist-get props 'txt))
3225 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3226 (plist-put props 'priority-letter (match-string 1 tmp))
3227 (setq tmp (replace-match "" t t tmp)))
3228 (when (and (setq re (plist-get props 'org-todo-regexp))
3229 (setq re (concat "\\`\\.*" re " ?"))
3230 (string-match re tmp))
3231 (plist-put props 'todo (match-string 1 tmp))
3232 (setq tmp (replace-match "" t t tmp)))
3233 (plist-put props 'txt tmp)))
3234 props)
3236 (defun org-agenda-export-csv-mapper (prop)
3237 (let ((res (plist-get org-agenda-info prop)))
3238 (setq res
3239 (cond
3240 ((not res) "")
3241 ((stringp res) res)
3242 (t (prin1-to-string res))))
3243 (while (string-match "," res)
3244 (setq res (replace-match ";" t t res)))
3245 (org-trim res)))
3247 ;;;###autoload
3248 (defun org-store-agenda-views (&rest parameters)
3249 "Store agenda views."
3250 (interactive)
3251 (eval (list 'org-batch-store-agenda-views)))
3253 ;;;###autoload
3254 (defmacro org-batch-store-agenda-views (&rest parameters)
3255 "Run all custom agenda commands that have a file argument."
3256 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3257 (pop-up-frames nil)
3258 (dir default-directory)
3259 (pars (org-make-parameter-alist parameters))
3260 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3261 (save-window-excursion
3262 (while cmds
3263 (setq cmd (pop cmds)
3264 thiscmdkey (car cmd)
3265 thiscmdcmd (cdr cmd)
3266 match (nth 2 thiscmdcmd)
3267 bufname (if org-agenda-sticky
3268 (or (and (stringp match)
3269 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3270 (format "*Org Agenda(%s)*" thiscmdkey))
3271 org-agenda-buffer-name)
3272 cmd-or-set (nth 2 cmd)
3273 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3274 files (nth (if (listp cmd-or-set) 4 5) cmd))
3275 (if (stringp files) (setq files (list files)))
3276 (when files
3277 (org-eval-in-environment (append org-agenda-exporter-settings
3278 opts pars)
3279 (org-agenda nil thiscmdkey))
3280 (set-buffer bufname)
3281 (while files
3282 (org-eval-in-environment (append org-agenda-exporter-settings
3283 opts pars)
3284 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3285 (and (get-buffer bufname)
3286 (kill-buffer bufname)))))))
3288 (defvar org-agenda-current-span nil
3289 "The current span used in the agenda view.") ; local variable in the agenda buffer
3290 (defun org-agenda-mark-header-line (pos)
3291 "Mark the line at POS as an agenda structure header."
3292 (save-excursion
3293 (goto-char pos)
3294 (put-text-property (point-at-bol) (point-at-eol)
3295 'org-agenda-structural-header t)
3296 (when org-agenda-title-append
3297 (put-text-property (point-at-bol) (point-at-eol)
3298 'org-agenda-title-append org-agenda-title-append))))
3300 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3301 (defvar org-agenda-write-buffer-name "Agenda View")
3302 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3303 "Write the current buffer (an agenda view) as a file.
3304 Depending on the extension of the file name, plain text (.txt),
3305 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3306 If the extension is .ics, run icalendar export over all files used
3307 to construct the agenda and limit the export to entries listed in the
3308 agenda now.
3309 If the extension is .org, collect all subtrees corresponding to the
3310 agenda entries and add them in an .org file.
3311 With prefix argument OPEN, open the new file immediately.
3312 If NOSETTINGS is given, do not scope the settings of
3313 `org-agenda-exporter-settings' into the export commands. This is used when
3314 the settings have already been scoped and we do not wish to overrule other,
3315 higher priority settings.
3316 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3317 (interactive "FWrite agenda to file: \nP")
3318 (if (or (not (file-writable-p file))
3319 (and (file-exists-p file)
3320 (if (org-called-interactively-p 'any)
3321 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3322 (user-error "Cannot write agenda to file %s" file))
3323 (org-let (if nosettings nil org-agenda-exporter-settings)
3324 '(save-excursion
3325 (save-window-excursion
3326 (org-agenda-mark-filtered-text)
3327 (let ((bs (copy-sequence (buffer-string))) beg content)
3328 (org-agenda-unmark-filtered-text)
3329 (with-temp-buffer
3330 (rename-buffer org-agenda-write-buffer-name t)
3331 (set-buffer-modified-p nil)
3332 (insert bs)
3333 (org-agenda-remove-marked-text 'org-filtered)
3334 (while (setq beg (text-property-any (point-min) (point-max)
3335 'org-filtered t))
3336 (delete-region
3337 beg (or (next-single-property-change beg 'org-filtered)
3338 (point-max))))
3339 (run-hooks 'org-agenda-before-write-hook)
3340 (cond
3341 ((org-bound-and-true-p org-mobile-creating-agendas)
3342 (org-mobile-write-agenda-for-mobile file))
3343 ((string-match "\\.org\\'" file)
3344 (let (content p m message-log-max)
3345 (goto-char (point-min))
3346 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3347 (goto-char p)
3348 (setq m (get-text-property (point) 'org-hd-marker))
3349 (when m
3350 (push (save-excursion
3351 (set-buffer (marker-buffer m))
3352 (goto-char m)
3353 (org-copy-subtree 1 nil t t)
3354 org-subtree-clip)
3355 content)))
3356 (find-file file)
3357 (erase-buffer)
3358 (mapcar (lambda (s) (org-paste-subtree 1 s)) (reverse content))
3359 (write-file file)
3360 (kill-buffer (current-buffer))
3361 (message "Org file written to %s" file)))
3362 ((string-match "\\.html?\\'" file)
3363 (require 'htmlize)
3364 (set-buffer (htmlize-buffer (current-buffer)))
3365 (when org-agenda-export-html-style
3366 ;; replace <style> section with org-agenda-export-html-style
3367 (goto-char (point-min))
3368 (kill-region (- (search-forward "<style") 6)
3369 (search-forward "</style>"))
3370 (insert org-agenda-export-html-style))
3371 (write-file file)
3372 (kill-buffer (current-buffer))
3373 (message "HTML written to %s" file))
3374 ((string-match "\\.ps\\'" file)
3375 (require 'ps-print)
3376 (ps-print-buffer-with-faces file)
3377 (message "Postscript written to %s" file))
3378 ((string-match "\\.pdf\\'" file)
3379 (require 'ps-print)
3380 (ps-print-buffer-with-faces
3381 (concat (file-name-sans-extension file) ".ps"))
3382 (call-process "ps2pdf" nil nil nil
3383 (expand-file-name
3384 (concat (file-name-sans-extension file) ".ps"))
3385 (expand-file-name file))
3386 (delete-file (concat (file-name-sans-extension file) ".ps"))
3387 (message "PDF written to %s" file))
3388 ((string-match "\\.ics\\'" file)
3389 (require 'ox-icalendar)
3390 (org-icalendar-export-current-agenda (expand-file-name file)))
3392 (let ((bs (buffer-string)))
3393 (find-file file)
3394 (erase-buffer)
3395 (insert bs)
3396 (save-buffer 0)
3397 (kill-buffer (current-buffer))
3398 (message "Plain text written to %s" file))))))))
3399 (set-buffer (or agenda-bufname
3400 (and (org-called-interactively-p 'any) (buffer-name))
3401 org-agenda-buffer-name)))
3402 (when open (org-open-file file)))
3404 (defvar org-agenda-tag-filter-overlays nil)
3405 (defvar org-agenda-cat-filter-overlays nil)
3406 (defvar org-agenda-re-filter-overlays nil)
3408 (defun org-agenda-mark-filtered-text ()
3409 "Mark all text hidden by filtering with a text property."
3410 (let ((inhibit-read-only t))
3411 (mapc
3412 (lambda (o)
3413 (when (equal (overlay-buffer o) (current-buffer))
3414 (put-text-property
3415 (overlay-start o) (overlay-end o)
3416 'org-filtered t)))
3417 (append org-agenda-tag-filter-overlays
3418 org-agenda-cat-filter-overlays
3419 org-agenda-re-filter-overlays))))
3421 (defun org-agenda-unmark-filtered-text ()
3422 "Remove the filtering text property."
3423 (let ((inhibit-read-only t))
3424 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3426 (defun org-agenda-remove-marked-text (property &optional value)
3427 "Delete all text marked with VALUE of PROPERTY.
3428 VALUE defaults to t."
3429 (let (beg)
3430 (setq value (or value t))
3431 (while (setq beg (text-property-any (point-min) (point-max)
3432 property value))
3433 (delete-region
3434 beg (or (next-single-property-change beg 'org-filtered)
3435 (point-max))))))
3437 (defun org-agenda-add-entry-text ()
3438 "Add entry text to agenda lines.
3439 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3440 entry text following headings shown in the agenda.
3441 Drawers will be excluded, also the line with scheduling/deadline info."
3442 (when (and (> org-agenda-add-entry-text-maxlines 0)
3443 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3444 (let (m txt)
3445 (goto-char (point-min))
3446 (while (not (eobp))
3447 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3448 (beginning-of-line 2)
3449 (setq txt (org-agenda-get-some-entry-text
3450 m org-agenda-add-entry-text-maxlines " > "))
3451 (end-of-line 1)
3452 (if (string-match "\\S-" txt)
3453 (insert "\n" txt)
3454 (or (eobp) (forward-char 1))))))))
3456 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3457 &rest keep)
3458 "Extract entry text from MARKER, at most N-LINES lines.
3459 This will ignore drawers etc, just get the text.
3460 If INDENT is given, prefix every line with this string. If KEEP is
3461 given, it is a list of symbols, defining stuff that should not be
3462 removed from the entry content. Currently only `planning' is allowed here."
3463 (let (txt drawer-re kwd-time-re ind)
3464 (save-excursion
3465 (with-current-buffer (marker-buffer marker)
3466 (if (not (derived-mode-p 'org-mode))
3467 (setq txt "")
3468 (save-excursion
3469 (save-restriction
3470 (widen)
3471 (goto-char marker)
3472 (end-of-line 1)
3473 (setq txt (buffer-substring
3474 (min (1+ (point)) (point-max))
3475 (progn (outline-next-heading) (point)))
3476 drawer-re org-drawer-regexp
3477 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3478 ".*\n?"))
3479 (with-temp-buffer
3480 (insert txt)
3481 (when org-agenda-add-entry-text-descriptive-links
3482 (goto-char (point-min))
3483 (while (org-activate-bracket-links (point-max))
3484 (add-text-properties (match-beginning 0) (match-end 0)
3485 '(face org-link))))
3486 (goto-char (point-min))
3487 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3488 (set-text-properties (match-beginning 0) (match-end 0)
3489 nil))
3490 (goto-char (point-min))
3491 (while (re-search-forward drawer-re nil t)
3492 (delete-region
3493 (match-beginning 0)
3494 (progn (re-search-forward
3495 "^[ \t]*:END:.*\n?" nil 'move)
3496 (point))))
3497 (unless (member 'planning keep)
3498 (goto-char (point-min))
3499 (while (re-search-forward kwd-time-re nil t)
3500 (replace-match "")))
3501 (goto-char (point-min))
3502 (when org-agenda-entry-text-exclude-regexps
3503 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3504 (while (setq re (pop re-list))
3505 (goto-char (point-min))
3506 (while (re-search-forward re nil t)
3507 (replace-match "")))))
3508 (goto-char (point-max))
3509 (skip-chars-backward " \t\n")
3510 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3512 ;; find and remove min common indentation
3513 (goto-char (point-min))
3514 (untabify (point-min) (point-max))
3515 (setq ind (org-get-indentation))
3516 (while (not (eobp))
3517 (unless (looking-at "[ \t]*$")
3518 (setq ind (min ind (org-get-indentation))))
3519 (beginning-of-line 2))
3520 (goto-char (point-min))
3521 (while (not (eobp))
3522 (unless (looking-at "[ \t]*$")
3523 (move-to-column ind)
3524 (delete-region (point-at-bol) (point)))
3525 (beginning-of-line 2))
3527 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3529 (goto-char (point-min))
3530 (when indent
3531 (while (and (not (eobp)) (re-search-forward "^" nil t))
3532 (replace-match indent t t)))
3533 (goto-char (point-min))
3534 (while (looking-at "[ \t]*\n") (replace-match ""))
3535 (goto-char (point-max))
3536 (when (> (org-current-line)
3537 n-lines)
3538 (org-goto-line (1+ n-lines))
3539 (backward-char 1))
3540 (setq txt (buffer-substring (point-min) (point)))))))))
3541 txt))
3543 (defun org-check-for-org-mode ()
3544 "Make sure current buffer is in org-mode. Error if not."
3545 (or (derived-mode-p 'org-mode)
3546 (error "Cannot execute org-mode agenda command on buffer in %s"
3547 major-mode)))
3549 ;;; Agenda prepare and finalize
3551 (defvar org-agenda-multi nil) ; dynamically scoped
3552 (defvar org-agenda-pre-window-conf nil)
3553 (defvar org-agenda-columns-active nil)
3554 (defvar org-agenda-name nil)
3555 (defvar org-agenda-tag-filter nil)
3556 (defvar org-agenda-category-filter nil)
3557 (defvar org-agenda-regexp-filter nil)
3558 (defvar org-agenda-top-headline-filter nil)
3559 (defvar org-agenda-tag-filter-while-redo nil)
3560 (defvar org-agenda-tag-filter-preset nil
3561 "A preset of the tags filter used for secondary agenda filtering.
3562 This must be a list of strings, each string must be a single tag preceded
3563 by \"+\" or \"-\".
3564 This variable should not be set directly, but agenda custom commands can
3565 bind it in the options section. The preset filter is a global property of
3566 the entire agenda view. In a block agenda, it will not work reliably to
3567 define a filter for one of the individual blocks. You need to set it in
3568 the global options and expect it to be applied to the entire view.")
3570 (defvar org-agenda-category-filter-preset nil
3571 "A preset of the category filter used for secondary agenda filtering.
3572 This must be a list of strings, each string must be a single category
3573 preceded by \"+\" or \"-\".
3574 This variable should not be set directly, but agenda custom commands can
3575 bind it in the options section. The preset filter is a global property of
3576 the entire agenda view. In a block agenda, it will not work reliably to
3577 define a filter for one of the individual blocks. You need to set it in
3578 the global options and expect it to be applied to the entire view.")
3580 (defvar org-agenda-regexp-filter-preset nil
3581 "A preset of the regexp filter used for secondary agenda filtering.
3582 This must be a list of strings, each string must be a single category
3583 preceded by \"+\" or \"-\".
3584 This variable should not be set directly, but agenda custom commands can
3585 bind it in the options section. The preset filter is a global property of
3586 the entire agenda view. In a block agenda, it will not work reliably to
3587 define a filter for one of the individual blocks. You need to set it in
3588 the global options and expect it to be applied to the entire view.")
3590 (defun org-agenda-use-sticky-p ()
3591 "Return non-nil if an agenda buffer named
3592 `org-agenda-buffer-name' exists and should be shown instead of
3593 generating a new one."
3594 (and
3595 ;; turned off by user
3596 org-agenda-sticky
3597 ;; For multi-agenda buffer already exists
3598 (not org-agenda-multi)
3599 ;; buffer found
3600 (get-buffer org-agenda-buffer-name)
3601 ;; C-u parameter is same as last call
3602 (with-current-buffer (get-buffer org-agenda-buffer-name)
3603 (and
3604 (equal current-prefix-arg
3605 org-agenda-last-prefix-arg)
3606 ;; In case user turned stickiness on, while having existing
3607 ;; Agenda buffer active, don't reuse that buffer, because it
3608 ;; does not have org variables local
3609 org-agenda-this-buffer-is-sticky))))
3611 (defun org-agenda-prepare-window (abuf)
3612 "Setup agenda buffer in the window."
3613 (let* ((awin (get-buffer-window abuf))
3614 wconf)
3615 (cond
3616 ((equal (current-buffer) abuf) nil)
3617 (awin (select-window awin))
3618 ((not (setq wconf (current-window-configuration))))
3619 ((equal org-agenda-window-setup 'current-window)
3620 (org-pop-to-buffer-same-window abuf))
3621 ((equal org-agenda-window-setup 'other-window)
3622 (org-switch-to-buffer-other-window abuf))
3623 ((equal org-agenda-window-setup 'other-frame)
3624 (switch-to-buffer-other-frame abuf))
3625 ((equal org-agenda-window-setup 'reorganize-frame)
3626 (delete-other-windows)
3627 (org-switch-to-buffer-other-window abuf)))
3628 ;; additional test in case agenda is invoked from within agenda
3629 ;; buffer via elisp link
3630 (unless (equal (current-buffer) abuf)
3631 (org-pop-to-buffer-same-window abuf))
3632 (setq org-agenda-pre-window-conf
3633 (or org-agenda-pre-window-conf wconf))))
3635 (defun org-agenda-prepare (&optional name)
3636 (if (org-agenda-use-sticky-p)
3637 (progn
3638 ;; Popup existing buffer
3639 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
3640 (message "Sticky Agenda buffer, use `r' to refresh")
3641 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3642 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3643 (setq org-todo-keywords-for-agenda nil)
3644 (setq org-drawers-for-agenda nil)
3645 (unless org-agenda-persistent-filter
3646 (setq org-agenda-tag-filter nil
3647 org-agenda-category-filter nil
3648 org-agenda-regexp-filter nil))
3649 (put 'org-agenda-tag-filter :preset-filter
3650 org-agenda-tag-filter-preset)
3651 (put 'org-agenda-category-filter :preset-filter
3652 org-agenda-category-filter-preset)
3653 (put 'org-agenda-regexp-filter :preset-filter
3654 org-agenda-regexp-filter-preset)
3655 (if org-agenda-multi
3656 (progn
3657 (setq buffer-read-only nil)
3658 (goto-char (point-max))
3659 (unless (or (bobp) org-agenda-compact-blocks
3660 (not org-agenda-block-separator))
3661 (insert "\n"
3662 (if (stringp org-agenda-block-separator)
3663 org-agenda-block-separator
3664 (make-string (window-width) org-agenda-block-separator))
3665 "\n"))
3666 (narrow-to-region (point) (point-max)))
3667 (setq org-done-keywords-for-agenda nil)
3669 ;; Setting any org variables that are in org-agenda-local-vars
3670 ;; list need to be done after the prepare call
3671 (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
3672 (setq buffer-read-only nil)
3673 (org-agenda-reset-markers)
3674 (let ((inhibit-read-only t)) (erase-buffer))
3675 (org-agenda-mode)
3676 (setq org-agenda-buffer (current-buffer))
3677 (setq org-agenda-contributing-files nil)
3678 (setq org-agenda-columns-active nil)
3679 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3680 (setq org-todo-keywords-for-agenda
3681 (org-uniquify org-todo-keywords-for-agenda))
3682 (setq org-done-keywords-for-agenda
3683 (org-uniquify org-done-keywords-for-agenda))
3684 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3685 (setq org-agenda-last-prefix-arg current-prefix-arg)
3686 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3687 (and name (not org-agenda-name)
3688 (org-set-local 'org-agenda-name name)))
3689 (setq buffer-read-only nil)))
3691 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3692 (defun org-agenda-finalize ()
3693 "Finishing touch for the agenda buffer, called just before displaying it."
3694 (unless org-agenda-multi
3695 (save-excursion
3696 (let ((inhibit-read-only t))
3697 (goto-char (point-min))
3698 (save-excursion
3699 (while (org-activate-bracket-links (point-max))
3700 (add-text-properties (match-beginning 0) (match-end 0)
3701 '(face org-link))))
3702 (save-excursion
3703 (while (org-activate-plain-links (point-max))
3704 (add-text-properties (match-beginning 0) (match-end 0)
3705 '(face org-link))))
3706 (unless (eq org-agenda-remove-tags t)
3707 (org-agenda-align-tags))
3708 (unless org-agenda-with-colors
3709 (remove-text-properties (point-min) (point-max) '(face nil)))
3710 (if (and (boundp 'org-agenda-overriding-columns-format)
3711 org-agenda-overriding-columns-format)
3712 (org-set-local 'org-agenda-overriding-columns-format
3713 org-agenda-overriding-columns-format))
3714 (if (and (boundp 'org-agenda-view-columns-initially)
3715 org-agenda-view-columns-initially)
3716 (org-agenda-columns))
3717 (when org-agenda-fontify-priorities
3718 (org-agenda-fontify-priorities))
3719 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3720 (org-agenda-dim-blocked-tasks))
3721 ;; We need to widen when `org-agenda-finalize' is called from
3722 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3723 (when org-clock-current-task
3724 (save-restriction
3725 (widen)
3726 (org-agenda-mark-clocking-task)))
3727 (when org-agenda-entry-text-mode
3728 (org-agenda-entry-text-hide)
3729 (org-agenda-entry-text-show))
3730 (if (and (functionp 'org-habit-insert-consistency-graphs)
3731 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3732 (org-habit-insert-consistency-graphs))
3733 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3734 (unless (or (eq org-agenda-show-inherited-tags 'always)
3735 (and (listp org-agenda-show-inherited-tags)
3736 (memq org-agenda-type org-agenda-show-inherited-tags))
3737 (and (eq org-agenda-show-inherited-tags t)
3738 (or (eq org-agenda-use-tag-inheritance t)
3739 (and (listp org-agenda-use-tag-inheritance)
3740 (not (memq org-agenda-type
3741 org-agenda-use-tag-inheritance))))))
3742 (let (mrk)
3743 (save-excursion
3744 (goto-char (point-min))
3745 (while (equal (forward-line) 0)
3746 (when (setq mrk (or (get-text-property (point) 'org-hd-marker)
3747 (get-text-property (point) 'org-hd-marker)))
3748 (put-text-property (point-at-bol) (point-at-eol)
3749 'tags (org-with-point-at mrk
3750 (delete-dups
3751 (mapcar 'downcase (org-get-tags-at))))))))))
3752 (run-hooks 'org-agenda-finalize-hook)
3753 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3754 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3755 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3756 (org-agenda-filter-apply org-agenda-category-filter 'category))
3757 (when (or org-agenda-regexp-filter (get 'org-agenda-regexp-filter :preset-filter))
3758 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3759 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3761 (defun org-agenda-mark-clocking-task ()
3762 "Mark the current clock entry in the agenda if it is present."
3763 (org-agenda-unmark-clocking-task)
3764 (when (marker-buffer org-clock-hd-marker)
3765 (save-excursion
3766 (goto-char (point-min))
3767 (let (s ov)
3768 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3769 (goto-char s)
3770 (when (equal (org-get-at-bol 'org-hd-marker)
3771 org-clock-hd-marker)
3772 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3773 (overlay-put ov 'type 'org-agenda-clocking)
3774 (overlay-put ov 'face 'org-agenda-clocking)
3775 (overlay-put ov 'help-echo
3776 "The clock is running in this item")))))))
3778 (defun org-agenda-unmark-clocking-task ()
3779 "Unmark the current clocking task."
3780 (mapc (lambda (o)
3781 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3782 (delete-overlay o)))
3783 (overlays-in (point-min) (point-max))))
3785 (defun org-agenda-fontify-priorities ()
3786 "Make highest priority lines bold, and lowest italic."
3787 (interactive)
3788 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3789 (delete-overlay o)))
3790 (overlays-in (point-min) (point-max)))
3791 (save-excursion
3792 (let (b e p ov h l)
3793 (goto-char (point-min))
3794 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3795 (setq h (or (get-char-property (point) 'org-highest-priority)
3796 org-highest-priority)
3797 l (or (get-char-property (point) 'org-lowest-priority)
3798 org-lowest-priority)
3799 p (string-to-char (match-string 1))
3800 b (match-beginning 0)
3801 e (if (eq org-agenda-fontify-priorities 'cookies)
3802 (match-end 0)
3803 (point-at-eol))
3804 ov (make-overlay b e))
3805 (overlay-put
3806 ov 'face
3807 (cons (cond ((org-face-from-face-or-color
3808 'priority nil
3809 (cdr (assoc p org-priority-faces))))
3810 ((and (listp org-agenda-fontify-priorities)
3811 (org-face-from-face-or-color
3812 'priority nil
3813 (cdr (assoc p org-agenda-fontify-priorities)))))
3814 ((equal p l) 'italic)
3815 ((equal p h) 'bold))
3816 'org-priority))
3817 (overlay-put ov 'org-type 'org-priority)))))
3819 (defvar org-depend-tag-blocked)
3821 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3822 "Dim currently blocked TODO's in the agenda display.
3823 When INVISIBLE is non-nil, hide currently blocked TODO instead of
3824 dimming them."
3825 (interactive "P")
3826 (when (org-called-interactively-p 'interactive)
3827 (message "Dim or hide blocked tasks..."))
3828 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3829 (delete-overlay o)))
3830 (overlays-in (point-min) (point-max)))
3831 (save-excursion
3832 (let ((inhibit-read-only t)
3833 (org-depend-tag-blocked nil)
3834 (invis (or (not (null invisible))
3835 (eq org-agenda-dim-blocked-tasks 'invisible)))
3836 org-blocked-by-checkboxes
3837 invis1 b e p ov h l)
3838 (goto-char (point-min))
3839 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3840 (and pos (goto-char (1+ pos))))
3841 (setq org-blocked-by-checkboxes nil invis1 invis)
3842 (let ((marker (org-get-at-bol 'org-hd-marker)))
3843 (when (and marker
3844 (with-current-buffer (marker-buffer marker)
3845 (save-excursion (goto-char marker)
3846 (org-entry-blocked-p))))
3847 (if org-blocked-by-checkboxes (setq invis1 nil))
3848 (setq b (if invis1
3849 (max (point-min) (1- (point-at-bol)))
3850 (point-at-bol))
3851 e (point-at-eol)
3852 ov (make-overlay b e))
3853 (if invis1
3854 (overlay-put ov 'invisible t)
3855 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3856 (overlay-put ov 'org-type 'org-blocked-todo))))))
3857 (when (org-called-interactively-p 'interactive)
3858 (message "Dim or hide blocked tasks...done")))
3860 (defvar org-agenda-skip-function nil
3861 "Function to be called at each match during agenda construction.
3862 If this function returns nil, the current match should not be skipped.
3863 Otherwise, the function must return a position from where the search
3864 should be continued.
3865 This may also be a Lisp form, it will be evaluated.
3866 Never set this variable using `setq' or so, because then it will apply
3867 to all future agenda commands. If you do want a global skipping condition,
3868 use the option `org-agenda-skip-function-global' instead.
3869 The correct usage for `org-agenda-skip-function' is to bind it with
3870 `let' to scope it dynamically into the agenda-constructing command.
3871 A good way to set it is through options in `org-agenda-custom-commands'.")
3873 (defun org-agenda-skip ()
3874 "Throw to `:skip' in places that should be skipped.
3875 Also moves point to the end of the skipped region, so that search can
3876 continue from there."
3877 (let ((p (point-at-bol)) to)
3878 (when (or
3879 (save-excursion (goto-char p) (looking-at comment-start-skip))
3880 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3881 (get-text-property p :org-archived)
3882 (org-end-of-subtree t))
3883 (and org-agenda-skip-comment-trees
3884 (get-text-property p :org-comment)
3885 (org-end-of-subtree t))
3886 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3887 (org-agenda-skip-eval org-agenda-skip-function)))
3888 (goto-char to))
3889 (org-in-src-block-p t))
3890 (throw :skip t))))
3892 (defun org-agenda-skip-eval (form)
3893 "If FORM is a function or a list, call (or eval) it and return the result.
3894 `save-excursion' and `save-match-data' are wrapped around the call, so point
3895 and match data are returned to the previous state no matter what these
3896 functions do."
3897 (let (fp)
3898 (and form
3899 (or (setq fp (functionp form))
3900 (consp form))
3901 (save-excursion
3902 (save-match-data
3903 (if fp
3904 (funcall form)
3905 (eval form)))))))
3907 (defvar org-agenda-markers nil
3908 "List of all currently active markers created by `org-agenda'.")
3909 (defvar org-agenda-last-marker-time (org-float-time)
3910 "Creation time of the last agenda marker.")
3912 (defun org-agenda-new-marker (&optional pos)
3913 "Return a new agenda marker.
3914 Org-mode keeps a list of these markers and resets them when they are
3915 no longer in use."
3916 (let ((m (copy-marker (or pos (point)))))
3917 (setq org-agenda-last-marker-time (org-float-time))
3918 (if org-agenda-buffer
3919 (with-current-buffer org-agenda-buffer
3920 (push m org-agenda-markers))
3921 (push m org-agenda-markers))
3924 (defun org-agenda-reset-markers ()
3925 "Reset markers created by `org-agenda'."
3926 (while org-agenda-markers
3927 (move-marker (pop org-agenda-markers) nil)))
3929 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3930 "Save relative positions of markers in region.
3931 This check for agenda markers in all agenda buffers currently active."
3932 (dolist (buf (buffer-list))
3933 (with-current-buffer buf
3934 (when (eq major-mode 'org-agenda-mode)
3935 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3936 org-agenda-markers)))))
3938 ;;; Entry text mode
3940 (defun org-agenda-entry-text-show-here ()
3941 "Add some text from the entry as context to the current line."
3942 (let (m txt o)
3943 (setq m (org-get-at-bol 'org-hd-marker))
3944 (unless (marker-buffer m)
3945 (error "No marker points to an entry here"))
3946 (setq txt (concat "\n" (org-no-properties
3947 (org-agenda-get-some-entry-text
3948 m org-agenda-entry-text-maxlines
3949 org-agenda-entry-text-leaders))))
3950 (when (string-match "\\S-" txt)
3951 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3952 (overlay-put o 'evaporate t)
3953 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3954 (overlay-put o 'after-string txt))))
3956 (defun org-agenda-entry-text-show ()
3957 "Add entry context for all agenda lines."
3958 (interactive)
3959 (save-excursion
3960 (goto-char (point-max))
3961 (beginning-of-line 1)
3962 (while (not (bobp))
3963 (when (org-get-at-bol 'org-hd-marker)
3964 (org-agenda-entry-text-show-here))
3965 (beginning-of-line 0))))
3967 (defun org-agenda-entry-text-hide ()
3968 "Remove any shown entry context."
3969 (delq nil
3970 (mapcar (lambda (o)
3971 (if (eq (overlay-get o 'org-overlay-type)
3972 'agenda-entry-content)
3973 (progn (delete-overlay o) t)))
3974 (overlays-in (point-min) (point-max)))))
3976 (defun org-agenda-get-day-face (date)
3977 "Return the face DATE should be displayed with."
3978 (or (and (functionp org-agenda-day-face-function)
3979 (funcall org-agenda-day-face-function date))
3980 (cond ((org-agenda-todayp date)
3981 'org-agenda-date-today)
3982 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3983 'org-agenda-date-weekend)
3984 (t 'org-agenda-date))))
3986 ;;; Agenda timeline
3988 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3989 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
3991 (defun org-timeline (&optional dotodo)
3992 "Show a time-sorted view of the entries in the current org file.
3993 Only entries with a time stamp of today or later will be listed. With
3994 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3995 under the current date.
3996 If the buffer contains an active region, only check the region for
3997 dates."
3998 (interactive "P")
3999 (let* ((dopast t)
4000 (org-agenda-show-log-scoped org-agenda-show-log)
4001 (org-agenda-show-log org-agenda-show-log-scoped)
4002 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
4003 (current-buffer))))
4004 (date (calendar-current-date))
4005 (beg (if (org-region-active-p) (region-beginning) (point-min)))
4006 (end (if (org-region-active-p) (region-end) (point-max)))
4007 (day-numbers (org-get-all-dates
4008 beg end 'no-ranges
4009 t org-agenda-show-log-scoped ; always include today
4010 org-timeline-show-empty-dates))
4011 (org-deadline-warning-days 0)
4012 (org-agenda-only-exact-dates t)
4013 (today (org-today))
4014 (past t)
4015 args
4016 s e rtn d emptyp)
4017 (setq org-agenda-redo-command
4018 (list 'let
4019 (list (list 'org-agenda-show-log 'org-agenda-show-log))
4020 (list 'org-switch-to-buffer-other-window (current-buffer))
4021 (list 'org-timeline (list 'quote dotodo))))
4022 (put 'org-agenda-redo-command 'org-lprops nil)
4023 (if (not dopast)
4024 ;; Remove past dates from the list of dates.
4025 (setq day-numbers (delq nil (mapcar (lambda(x)
4026 (if (>= x today) x nil))
4027 day-numbers))))
4028 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
4029 (org-compile-prefix-format 'timeline)
4030 (org-set-sorting-strategy 'timeline)
4031 (if org-agenda-show-log-scoped (push :closed args))
4032 (push :timestamp args)
4033 (push :deadline args)
4034 (push :scheduled args)
4035 (push :sexp args)
4036 (if dotodo (push :todo args))
4037 (insert "Timeline of file " entry "\n")
4038 (add-text-properties (point-min) (point)
4039 (list 'face 'org-agenda-structure))
4040 (org-agenda-mark-header-line (point-min))
4041 (while (setq d (pop day-numbers))
4042 (if (and (listp d) (eq (car d) :omitted))
4043 (progn
4044 (setq s (point))
4045 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4046 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4047 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4048 (if (and (>= d today)
4049 dopast
4050 past)
4051 (progn
4052 (setq past nil)
4053 (insert (make-string 79 ?-) "\n")))
4054 (setq date (calendar-gregorian-from-absolute d))
4055 (setq s (point))
4056 (setq rtn (and (not emptyp)
4057 (apply 'org-agenda-get-day-entries entry
4058 date args)))
4059 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4060 (progn
4061 (insert
4062 (if (stringp org-agenda-format-date)
4063 (format-time-string org-agenda-format-date
4064 (org-time-from-absolute date))
4065 (funcall org-agenda-format-date date))
4066 "\n")
4067 (put-text-property s (1- (point)) 'face
4068 (org-agenda-get-day-face date))
4069 (put-text-property s (1- (point)) 'org-date-line t)
4070 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4071 (if (equal d today)
4072 (put-text-property s (1- (point)) 'org-today t))
4073 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4074 (put-text-property s (1- (point)) 'day d)))))
4075 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4076 (point-min)))
4077 (add-text-properties
4078 (point-min) (point-max)
4079 `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
4080 (org-agenda-finalize)
4081 (setq buffer-read-only t)))
4083 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4084 "Return a list of all relevant day numbers from BEG to END buffer positions.
4085 If NO-RANGES is non-nil, include only the start and end dates of a range,
4086 not every single day in the range. If FORCE-TODAY is non-nil, make
4087 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4088 inactive time stamps (those in square brackets) are included.
4089 When EMPTY is non-nil, also include days without any entries."
4090 (let ((re (concat
4091 (if pre-re pre-re "")
4092 (if inactive org-ts-regexp-both org-ts-regexp)))
4093 dates dates1 date day day1 day2 ts1 ts2 pos)
4094 (if force-today
4095 (setq dates (list (org-today))))
4096 (save-excursion
4097 (goto-char beg)
4098 (while (re-search-forward re end t)
4099 (setq day (time-to-days (org-time-string-to-time
4100 (substring (match-string 1) 0 10)
4101 (current-buffer) (match-beginning 0))))
4102 (or (memq day dates) (push day dates)))
4103 (unless no-ranges
4104 (goto-char beg)
4105 (while (re-search-forward org-tr-regexp end t)
4106 (setq pos (match-beginning 0))
4107 (setq ts1 (substring (match-string 1) 0 10)
4108 ts2 (substring (match-string 2) 0 10)
4109 day1 (time-to-days (org-time-string-to-time
4110 ts1 (current-buffer) pos))
4111 day2 (time-to-days (org-time-string-to-time
4112 ts2 (current-buffer) pos)))
4113 (while (< (setq day1 (1+ day1)) day2)
4114 (or (memq day1 dates) (push day1 dates)))))
4115 (setq dates (sort dates '<))
4116 (when empty
4117 (while (setq day (pop dates))
4118 (setq day2 (car dates))
4119 (push day dates1)
4120 (when (and day2 empty)
4121 (if (or (eq empty t)
4122 (and (numberp empty) (<= (- day2 day) empty)))
4123 (while (< (setq day (1+ day)) day2)
4124 (push (list day) dates1))
4125 (push (cons :omitted (- day2 day)) dates1))))
4126 (setq dates (nreverse dates1)))
4127 dates)))
4129 ;;; Agenda Daily/Weekly
4131 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4132 "Start day for the agenda view.
4133 Custom commands can set this variable in the options section.
4134 This is usually a string like \"2007-11-01\", \"+2d\" or any other
4135 input allowed when reading a date through the Org calendar.
4136 See the docstring of `org-read-date' for details.")
4137 (defvar org-starting-day nil) ; local variable in the agenda buffer
4138 (defvar org-arg-loc nil) ; local variable
4140 (defvar org-agenda-buffer-tmp-name nil)
4141 ;;;###autoload
4142 (defun org-agenda-list (&optional arg start-day span with-hour)
4143 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4144 The view will be for the current day or week, but from the overview buffer
4145 you will be able to go to other days/weeks.
4147 With a numeric prefix argument in an interactive call, the agenda will
4148 span ARG days. Lisp programs should instead specify SPAN to change
4149 the number of days. SPAN defaults to `org-agenda-span'.
4151 START-DAY defaults to TODAY, or to the most recent match for the weekday
4152 given in `org-agenda-start-on-weekday'.
4154 When WITH-HOUR is non-nil, only include scheduled and deadline
4155 items if they have an hour specification like [h]h:mm."
4156 (interactive "P")
4157 (if org-agenda-overriding-arguments
4158 (setq arg (car org-agenda-overriding-arguments)
4159 start-day (nth 1 org-agenda-overriding-arguments)
4160 span (nth 2 org-agenda-overriding-arguments)))
4161 (if (and (integerp arg) (> arg 0))
4162 (setq span arg arg nil))
4163 (catch 'exit
4164 (setq org-agenda-buffer-name
4165 (or org-agenda-buffer-tmp-name
4166 (if org-agenda-sticky
4167 (cond ((and org-keys (stringp org-match))
4168 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4169 (org-keys
4170 (format "*Org Agenda(%s)*" org-keys))
4171 (t "*Org Agenda(a)*")))
4172 org-agenda-buffer-name))
4173 (org-agenda-prepare "Day/Week")
4174 (setq start-day (or start-day org-agenda-start-day))
4175 (if (stringp start-day)
4176 ;; Convert to an absolute day number
4177 (setq start-day (time-to-days (org-read-date nil t start-day))))
4178 (org-compile-prefix-format 'agenda)
4179 (org-set-sorting-strategy 'agenda)
4180 (let* ((span (org-agenda-ndays-to-span
4181 (or span org-agenda-ndays org-agenda-span)))
4182 (today (org-today))
4183 (sd (or start-day today))
4184 (ndays (org-agenda-span-to-ndays span sd))
4185 (org-agenda-start-on-weekday
4186 (if (or (eq ndays 7) (eq ndays 14))
4187 org-agenda-start-on-weekday))
4188 (thefiles (org-agenda-files nil 'ifmode))
4189 (files thefiles)
4190 (start (if (or (null org-agenda-start-on-weekday)
4191 (< ndays 7))
4193 (let* ((nt (calendar-day-of-week
4194 (calendar-gregorian-from-absolute sd)))
4195 (n1 org-agenda-start-on-weekday)
4196 (d (- nt n1)))
4197 (- sd (+ (if (< d 0) 7 0) d)))))
4198 (day-numbers (list start))
4199 (day-cnt 0)
4200 (inhibit-redisplay (not debug-on-error))
4201 (org-agenda-show-log-scoped org-agenda-show-log)
4202 s e rtn rtnall file date d start-pos end-pos todayp
4203 clocktable-start clocktable-end filter)
4204 (setq org-agenda-redo-command
4205 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4206 (dotimes (n (1- ndays))
4207 (push (1+ (car day-numbers)) day-numbers))
4208 (setq day-numbers (nreverse day-numbers))
4209 (setq clocktable-start (car day-numbers)
4210 clocktable-end (1+ (or (org-last day-numbers) 0)))
4211 (org-set-local 'org-starting-day (car day-numbers))
4212 (org-set-local 'org-arg-loc arg)
4213 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
4214 (unless org-agenda-compact-blocks
4215 (let* ((d1 (car day-numbers))
4216 (d2 (org-last day-numbers))
4217 (w1 (org-days-to-iso-week d1))
4218 (w2 (org-days-to-iso-week d2)))
4219 (setq s (point))
4220 (if org-agenda-overriding-header
4221 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4222 nil 'face 'org-agenda-structure) "\n")
4223 (insert (org-agenda-span-name span)
4224 "-agenda"
4225 (if (< (- d2 d1) 350)
4226 (if (= w1 w2)
4227 (format " (W%02d)" w1)
4228 (format " (W%02d-W%02d)" w1 w2))
4230 ":\n")))
4231 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4232 'org-date-line t))
4233 (org-agenda-mark-header-line s))
4234 (while (setq d (pop day-numbers))
4235 (setq date (calendar-gregorian-from-absolute d)
4236 s (point))
4237 (if (or (setq todayp (= d today))
4238 (and (not start-pos) (= d sd)))
4239 (setq start-pos (point))
4240 (if (and start-pos (not end-pos))
4241 (setq end-pos (point))))
4242 (setq files thefiles
4243 rtnall nil)
4244 (while (setq file (pop files))
4245 (catch 'nextfile
4246 (org-check-agenda-file file)
4247 (let ((org-agenda-entry-types org-agenda-entry-types))
4248 ;; Starred types override non-starred equivalents
4249 (when (member :deadline* org-agenda-entry-types)
4250 (setq org-agenda-entry-types
4251 (delq :deadline org-agenda-entry-types)))
4252 (when (member :scheduled* org-agenda-entry-types)
4253 (setq org-agenda-entry-types
4254 (delq :scheduled org-agenda-entry-types)))
4255 ;; Honor with-hour
4256 (when with-hour
4257 (when (member :deadline org-agenda-entry-types)
4258 (setq org-agenda-entry-types
4259 (delq :deadline org-agenda-entry-types))
4260 (push :deadline* org-agenda-entry-types))
4261 (when (member :scheduled org-agenda-entry-types)
4262 (setq org-agenda-entry-types
4263 (delq :scheduled org-agenda-entry-types))
4264 (push :scheduled* org-agenda-entry-types)))
4265 (unless org-agenda-include-deadlines
4266 (setq org-agenda-entry-types
4267 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4268 (cond
4269 ((memq org-agenda-show-log-scoped '(only clockcheck))
4270 (setq rtn (org-agenda-get-day-entries
4271 file date :closed)))
4272 (org-agenda-show-log-scoped
4273 (setq rtn (apply 'org-agenda-get-day-entries
4274 file date
4275 (append '(:closed) org-agenda-entry-types))))
4277 (setq rtn (apply 'org-agenda-get-day-entries
4278 file date
4279 org-agenda-entry-types)))))
4280 (setq rtnall (append rtnall rtn)))) ;; all entries
4281 (if org-agenda-include-diary
4282 (let ((org-agenda-search-headline-for-time t))
4283 (require 'diary-lib)
4284 (setq rtn (org-get-entries-from-diary date))
4285 (setq rtnall (append rtnall rtn))))
4286 (if (or rtnall org-agenda-show-all-dates)
4287 (progn
4288 (setq day-cnt (1+ day-cnt))
4289 (insert
4290 (if (stringp org-agenda-format-date)
4291 (format-time-string org-agenda-format-date
4292 (org-time-from-absolute date))
4293 (funcall org-agenda-format-date date))
4294 "\n")
4295 (put-text-property s (1- (point)) 'face
4296 (org-agenda-get-day-face date))
4297 (put-text-property s (1- (point)) 'org-date-line t)
4298 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4299 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4300 (when todayp
4301 (put-text-property s (1- (point)) 'org-today t))
4302 (setq rtnall
4303 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4304 (if rtnall (insert ;; all entries
4305 (org-agenda-finalize-entries rtnall 'agenda)
4306 "\n"))
4307 (put-text-property s (1- (point)) 'day d)
4308 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4309 (when (and org-agenda-clockreport-mode clocktable-start)
4310 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4311 ;; the above line is to ensure the restricted range!
4312 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4313 tbl)
4314 (setq p (org-plist-delete p :block))
4315 (setq p (plist-put p :tstart clocktable-start))
4316 (setq p (plist-put p :tend clocktable-end))
4317 (setq p (plist-put p :scope 'agenda))
4318 (when (and (eq org-agenda-clockreport-mode 'with-filter)
4319 (setq filter (or org-agenda-tag-filter-while-redo
4320 (get 'org-agenda-tag-filter :preset-filter))))
4321 (setq p (plist-put p :tags (mapconcat (lambda (x)
4322 (if (string-match "[<>=]" x)
4325 filter ""))))
4326 (setq tbl (apply 'org-clock-get-clocktable p))
4327 (insert tbl)))
4328 (goto-char (point-min))
4329 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4330 (unless (and (pos-visible-in-window-p (point-min))
4331 (pos-visible-in-window-p (point-max)))
4332 (goto-char (1- (point-max)))
4333 (recenter -1)
4334 (if (not (pos-visible-in-window-p (or start-pos 1)))
4335 (progn
4336 (goto-char (or start-pos 1))
4337 (recenter 1))))
4338 (goto-char (or start-pos 1))
4339 (add-text-properties (point-min) (point-max)
4340 `(org-agenda-type agenda
4341 org-last-args (,arg ,start-day ,span)
4342 org-redo-cmd ,org-agenda-redo-command
4343 org-series-cmd ,org-cmd))
4344 (if (eq org-agenda-show-log-scoped 'clockcheck)
4345 (org-agenda-show-clocking-issues))
4346 (org-agenda-finalize)
4347 (setq buffer-read-only t)
4348 (message ""))))
4350 (defun org-agenda-ndays-to-span (n)
4351 "Return a span symbol for a span of N days, or N if none matches."
4352 (cond ((symbolp n) n)
4353 ((= n 1) 'day)
4354 ((= n 7) 'week)
4355 ((= n 14) 'fortnight)
4356 (t n)))
4358 (defun org-agenda-span-to-ndays (span &optional start-day)
4359 "Return ndays from SPAN, possibly starting at START-DAY.
4360 START-DAY is an absolute time value."
4361 (cond ((numberp span) span)
4362 ((eq span 'day) 1)
4363 ((eq span 'week) 7)
4364 ((eq span 'fortnight) 14)
4365 ((eq span 'month)
4366 (let ((date (calendar-gregorian-from-absolute start-day)))
4367 (calendar-last-day-of-month (car date) (caddr date))))
4368 ((eq span 'year)
4369 (let ((date (calendar-gregorian-from-absolute start-day)))
4370 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4372 (defun org-agenda-span-name (span)
4373 "Return a SPAN name."
4374 (if (null span)
4376 (if (symbolp span)
4377 (capitalize (symbol-name span))
4378 (format "%d days" span))))
4380 ;;; Agenda word search
4382 (defvar org-agenda-search-history nil)
4384 (defvar org-search-syntax-table nil
4385 "Special syntax table for org-mode search.
4386 In this table, we have single quotes not as word constituents, to
4387 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4389 (defvar org-mode-syntax-table) ; From org.el
4390 (defun org-search-syntax-table ()
4391 (unless org-search-syntax-table
4392 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4393 (modify-syntax-entry ?' "." org-search-syntax-table)
4394 (modify-syntax-entry ?` "." org-search-syntax-table))
4395 org-search-syntax-table)
4397 (defvar org-agenda-last-search-view-search-was-boolean nil)
4399 ;;;###autoload
4400 (defun org-search-view (&optional todo-only string edit-at)
4401 "Show all entries that contain a phrase or words or regular expressions.
4403 With optional prefix argument TODO-ONLY, only consider entries that are
4404 TODO entries. The argument STRING can be used to pass a default search
4405 string into this function. If EDIT-AT is non-nil, it means that the
4406 user should get a chance to edit this string, with cursor at position
4407 EDIT-AT.
4409 The search string can be viewed either as a phrase that should be found as
4410 is, or it can be broken into a number of snippets, each of which must match
4411 in a Boolean way to select an entry. The default depends on the variable
4412 `org-agenda-search-view-always-boolean'.
4413 Even if this is turned off (the default) you can always switch to
4414 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4416 The default is a direct search of the whole phrase, where each space in
4417 the search string can expand to an arbitrary amount of whitespace,
4418 including newlines.
4420 If using a Boolean search, the search string is split on whitespace and
4421 each snippet is searched separately, with logical AND to select an entry.
4422 Words prefixed with a minus must *not* occur in the entry. Words without
4423 a prefix or prefixed with a plus must occur in the entry. Matching is
4424 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4425 match whole words, not parts of a word) if
4426 `org-agenda-search-view-force-full-words' is set (default is nil).
4428 Boolean search snippets enclosed by curly braces are interpreted as
4429 regular expressions that must or (when preceded with \"-\") must not
4430 match in the entry. Snippets enclosed into double quotes will be taken
4431 as a whole, to include whitespace.
4433 - If the search string starts with an asterisk, search only in headlines.
4434 - If (possibly after the leading star) the search string starts with an
4435 exclamation mark, this also means to look at TODO entries only, an effect
4436 that can also be achieved with a prefix argument.
4437 - If (possibly after star and exclamation mark) the search string starts
4438 with a colon, this will mean that the (non-regexp) snippets of the
4439 Boolean search must match as full words.
4441 This command searches the agenda files, and in addition the files listed
4442 in `org-agenda-text-search-extra-files'."
4443 (interactive "P")
4444 (if org-agenda-overriding-arguments
4445 (setq todo-only (car org-agenda-overriding-arguments)
4446 string (nth 1 org-agenda-overriding-arguments)
4447 edit-at (nth 2 org-agenda-overriding-arguments)))
4448 (let* ((props (list 'face nil
4449 'done-face 'org-agenda-done
4450 'org-not-done-regexp org-not-done-regexp
4451 'org-todo-regexp org-todo-regexp
4452 'org-complex-heading-regexp org-complex-heading-regexp
4453 'mouse-face 'highlight
4454 'help-echo (format "mouse-2 or RET jump to location")))
4455 (full-words org-agenda-search-view-force-full-words)
4456 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4457 regexp rtn rtnall files file pos inherited-tags
4458 marker category category-pos level tags c neg re boolean
4459 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4460 (unless (and (not edit-at)
4461 (stringp string)
4462 (string-match "\\S-" string))
4463 (setq string (read-string
4464 (if org-agenda-search-view-always-boolean
4465 "[+-]Word/{Regexp} ...: "
4466 "Phrase or [+-]Word/{Regexp} ...: ")
4467 (cond
4468 ((integerp edit-at) (cons string edit-at))
4469 (edit-at string))
4470 'org-agenda-search-history)))
4471 (catch 'exit
4472 (if org-agenda-sticky
4473 (setq org-agenda-buffer-name
4474 (if (stringp string)
4475 (format "*Org Agenda(%s:%s)*"
4476 (or org-keys (or (and todo-only "S") "s")) string)
4477 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4478 (org-agenda-prepare "SEARCH")
4479 (org-compile-prefix-format 'search)
4480 (org-set-sorting-strategy 'search)
4481 (setq org-agenda-redo-command
4482 (list 'org-search-view (if todo-only t nil)
4483 (list 'if 'current-prefix-arg nil string)))
4484 (setq org-agenda-query-string string)
4485 (if (equal (string-to-char string) ?*)
4486 (setq hdl-only t
4487 words (substring string 1))
4488 (setq words string))
4489 (when (equal (string-to-char words) ?!)
4490 (setq todo-only t
4491 words (substring words 1)))
4492 (when (equal (string-to-char words) ?:)
4493 (setq full-words t
4494 words (substring words 1)))
4495 (if (or org-agenda-search-view-always-boolean
4496 (member (string-to-char words) '(?- ?+ ?\{)))
4497 (setq boolean t))
4498 (setq words (org-split-string words))
4499 (let (www w)
4500 (while (setq w (pop words))
4501 (while (and (string-match "\\\\\\'" w) words)
4502 (setq w (concat (substring w 0 -1) " " (pop words))))
4503 (push w www))
4504 (setq words (nreverse www) www nil)
4505 (while (setq w (pop words))
4506 (when (and (string-match "\\`[-+]?{" w)
4507 (not (string-match "}\\'" w)))
4508 (while (and words (not (string-match "}\\'" (car words))))
4509 (setq w (concat w " " (pop words))))
4510 (setq w (concat w " " (pop words))))
4511 (push w www))
4512 (setq words (nreverse www)))
4513 (setq org-agenda-last-search-view-search-was-boolean boolean)
4514 (when boolean
4515 (let (wds w)
4516 (while (setq w (pop words))
4517 (if (or (equal (substring w 0 1) "\"")
4518 (and (> (length w) 1)
4519 (member (substring w 0 1) '("+" "-"))
4520 (equal (substring w 1 2) "\"")))
4521 (while (and words (not (equal (substring w -1) "\"")))
4522 (setq w (concat w " " (pop words)))))
4523 (and (string-match "\\`\\([-+]?\\)\"" w)
4524 (setq w (replace-match "\\1" nil nil w)))
4525 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4526 (push w wds))
4527 (setq words (nreverse wds))))
4528 (if boolean
4529 (mapc (lambda (w)
4530 (setq c (string-to-char w))
4531 (if (equal c ?-)
4532 (setq neg t w (substring w 1))
4533 (if (equal c ?+)
4534 (setq neg nil w (substring w 1))
4535 (setq neg nil)))
4536 (if (string-match "\\`{.*}\\'" w)
4537 (setq re (substring w 1 -1))
4538 (if full-words
4539 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4540 (setq re (regexp-quote (downcase w)))))
4541 (if neg (push re regexps-) (push re regexps+)))
4542 words)
4543 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4544 regexps+))
4545 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4546 (if (not regexps+)
4547 (setq regexp org-outline-regexp-bol)
4548 (setq regexp (pop regexps+))
4549 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4550 regexp))))
4551 (setq files (org-agenda-files nil 'ifmode))
4552 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4553 (pop org-agenda-text-search-extra-files)
4554 (setq files (org-add-archive-files files)))
4555 (setq files (append files org-agenda-text-search-extra-files)
4556 rtnall nil)
4557 (while (setq file (pop files))
4558 (setq ee nil)
4559 (catch 'nextfile
4560 (org-check-agenda-file file)
4561 (setq buffer (if (file-exists-p file)
4562 (org-get-agenda-file-buffer file)
4563 (error "No such file %s" file)))
4564 (if (not buffer)
4565 ;; If file does not exist, make sure an error message is sent
4566 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4567 file))))
4568 (with-current-buffer buffer
4569 (with-syntax-table (org-search-syntax-table)
4570 (unless (derived-mode-p 'org-mode)
4571 (error "Agenda file %s is not in `org-mode'" file))
4572 (let ((case-fold-search t))
4573 (save-excursion
4574 (save-restriction
4575 (if (eq buffer org-agenda-restrict)
4576 (narrow-to-region org-agenda-restrict-begin
4577 org-agenda-restrict-end)
4578 (widen))
4579 (goto-char (point-min))
4580 (unless (or (org-at-heading-p)
4581 (outline-next-heading))
4582 (throw 'nextfile t))
4583 (goto-char (max (point-min) (1- (point))))
4584 (while (re-search-forward regexp nil t)
4585 (org-back-to-heading t)
4586 (while (and org-agenda-search-view-max-outline-level
4587 (> (org-reduced-level (org-outline-level))
4588 org-agenda-search-view-max-outline-level)
4589 (forward-line -1)
4590 (outline-back-to-heading t)))
4591 (skip-chars-forward "* ")
4592 (setq beg (point-at-bol)
4593 beg1 (point)
4594 end (progn
4595 (outline-next-heading)
4596 (while (and org-agenda-search-view-max-outline-level
4597 (> (org-reduced-level (org-outline-level))
4598 org-agenda-search-view-max-outline-level)
4599 (forward-line 1)
4600 (outline-next-heading)))
4601 (point)))
4603 (catch :skip
4604 (goto-char beg)
4605 (org-agenda-skip)
4606 (setq str (buffer-substring-no-properties
4607 (point-at-bol)
4608 (if hdl-only (point-at-eol) end)))
4609 (mapc (lambda (wr) (when (string-match wr str)
4610 (goto-char (1- end))
4611 (throw :skip t)))
4612 regexps-)
4613 (mapc (lambda (wr) (unless (string-match wr str)
4614 (goto-char (1- end))
4615 (throw :skip t)))
4616 (if todo-only
4617 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4618 regexps+)
4619 regexps+))
4620 (goto-char beg)
4621 (setq marker (org-agenda-new-marker (point))
4622 category (org-get-category)
4623 level (make-string (org-reduced-level (org-outline-level)) ? )
4624 category-pos (get-text-property (point) 'org-category-position)
4625 inherited-tags
4626 (or (eq org-agenda-show-inherited-tags 'always)
4627 (and (listp org-agenda-show-inherited-tags)
4628 (memq 'todo org-agenda-show-inherited-tags))
4629 (and (eq org-agenda-show-inherited-tags t)
4630 (or (eq org-agenda-use-tag-inheritance t)
4631 (memq 'todo org-agenda-use-tag-inheritance))))
4632 tags (org-get-tags-at nil (not inherited-tags))
4633 txt (org-agenda-format-item
4635 (buffer-substring-no-properties
4636 beg1 (point-at-eol))
4637 level category tags t))
4638 (org-add-props txt props
4639 'org-marker marker 'org-hd-marker marker
4640 'org-todo-regexp org-todo-regexp
4641 'level level
4642 'org-complex-heading-regexp org-complex-heading-regexp
4643 'priority 1000 'org-category category
4644 'org-category-position category-pos
4645 'type "search")
4646 (push txt ee)
4647 (goto-char (1- end))))))))))
4648 (setq rtn (nreverse ee))
4649 (setq rtnall (append rtnall rtn)))
4650 (if org-agenda-overriding-header
4651 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4652 nil 'face 'org-agenda-structure) "\n")
4653 (insert "Search words: ")
4654 (add-text-properties (point-min) (1- (point))
4655 (list 'face 'org-agenda-structure))
4656 (setq pos (point))
4657 (insert string "\n")
4658 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4659 (setq pos (point))
4660 (unless org-agenda-multi
4661 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4662 (add-text-properties pos (1- (point))
4663 (list 'face 'org-agenda-structure))))
4664 (org-agenda-mark-header-line (point-min))
4665 (when rtnall
4666 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4667 (goto-char (point-min))
4668 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4669 (add-text-properties (point-min) (point-max)
4670 `(org-agenda-type search
4671 org-last-args (,todo-only ,string ,edit-at)
4672 org-redo-cmd ,org-agenda-redo-command
4673 org-series-cmd ,org-cmd))
4674 (org-agenda-finalize)
4675 (setq buffer-read-only t))))
4677 ;;; Agenda TODO list
4679 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4680 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4681 (concat
4682 (if (or (equal keywords "ALL") (not keywords))
4683 (propertize "ALL" 'face 'warning)
4684 (mapconcat
4685 (lambda (kw)
4686 (propertize kw 'face (org-get-todo-face kw)))
4687 (org-split-string keywords "|")
4688 "|"))
4689 "\n"))
4691 (defvar org-select-this-todo-keyword nil)
4692 (defvar org-last-arg nil)
4694 ;;;###autoload
4695 (defun org-todo-list (&optional arg)
4696 "Show all (not done) TODO entries from all agenda file in a single list.
4697 The prefix arg can be used to select a specific TODO keyword and limit
4698 the list to these. When using \\[universal-argument], you will be prompted
4699 for a keyword. A numeric prefix directly selects the Nth keyword in
4700 `org-todo-keywords-1'."
4701 (interactive "P")
4702 (if org-agenda-overriding-arguments
4703 (setq arg org-agenda-overriding-arguments))
4704 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4705 (let* ((today (org-today))
4706 (date (calendar-gregorian-from-absolute today))
4707 (kwds org-todo-keywords-for-agenda)
4708 (completion-ignore-case t)
4709 (org-select-this-todo-keyword
4710 (if (stringp arg) arg
4711 (and arg (integerp arg) (> arg 0)
4712 (nth (1- arg) kwds))))
4713 rtn rtnall files file pos)
4714 (when (equal arg '(4))
4715 (setq org-select-this-todo-keyword
4716 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4717 (mapcar 'list kwds) nil nil)))
4718 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4719 (catch 'exit
4720 (if org-agenda-sticky
4721 (setq org-agenda-buffer-name
4722 (if (stringp org-select-this-todo-keyword)
4723 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4724 org-select-this-todo-keyword)
4725 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4726 (org-agenda-prepare "TODO")
4727 (org-compile-prefix-format 'todo)
4728 (org-set-sorting-strategy 'todo)
4729 (setq org-agenda-redo-command
4730 `(org-todo-list (or (and (numberp current-prefix-arg)
4731 current-prefix-arg)
4732 ,org-select-this-todo-keyword
4733 current-prefix-arg ,arg)))
4734 (setq files (org-agenda-files nil 'ifmode)
4735 rtnall nil)
4736 (while (setq file (pop files))
4737 (catch 'nextfile
4738 (org-check-agenda-file file)
4739 (setq rtn (org-agenda-get-day-entries file date :todo))
4740 (setq rtnall (append rtnall rtn))))
4741 (if org-agenda-overriding-header
4742 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4743 nil 'face 'org-agenda-structure) "\n")
4744 (insert "Global list of TODO items of type: ")
4745 (add-text-properties (point-min) (1- (point))
4746 (list 'face 'org-agenda-structure
4747 'short-heading
4748 (concat "ToDo: "
4749 (or org-select-this-todo-keyword "ALL"))))
4750 (org-agenda-mark-header-line (point-min))
4751 (insert (org-agenda-propertize-selected-todo-keywords
4752 org-select-this-todo-keyword))
4753 (setq pos (point))
4754 (unless org-agenda-multi
4755 (insert "Available with `N r': (0)[ALL]")
4756 (let ((n 0) s)
4757 (mapc (lambda (x)
4758 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4759 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4760 (insert "\n "))
4761 (insert " " s))
4762 kwds))
4763 (insert "\n"))
4764 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4765 (org-agenda-mark-header-line (point-min))
4766 (when rtnall
4767 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4768 (goto-char (point-min))
4769 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4770 (add-text-properties (point-min) (point-max)
4771 `(org-agenda-type todo
4772 org-last-args ,arg
4773 org-redo-cmd ,org-agenda-redo-command
4774 org-series-cmd ,org-cmd))
4775 (org-agenda-finalize)
4776 (setq buffer-read-only t))))
4778 ;;; Agenda tags match
4780 ;;;###autoload
4781 (defun org-tags-view (&optional todo-only match)
4782 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4783 The prefix arg TODO-ONLY limits the search to TODO entries."
4784 (interactive "P")
4785 (if org-agenda-overriding-arguments
4786 (setq todo-only (car org-agenda-overriding-arguments)
4787 match (nth 1 org-agenda-overriding-arguments)))
4788 (let* ((org-tags-match-list-sublevels
4789 org-tags-match-list-sublevels)
4790 (completion-ignore-case t)
4791 rtn rtnall files file pos matcher
4792 buffer)
4793 (when (and (stringp match) (not (string-match "\\S-" match)))
4794 (setq match nil))
4795 (catch 'exit
4796 (if org-agenda-sticky
4797 (setq org-agenda-buffer-name
4798 (if (stringp match)
4799 (format "*Org Agenda(%s:%s)*"
4800 (or org-keys (or (and todo-only "M") "m")) match)
4801 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4802 ;; Prepare agendas (and `org-tag-alist-for-agenda') before
4803 ;; expanding tags within `org-make-tags-matcher'
4804 (org-agenda-prepare (concat "TAGS " match))
4805 (setq matcher (org-make-tags-matcher match)
4806 match (car matcher) matcher (cdr matcher))
4807 (org-compile-prefix-format 'tags)
4808 (org-set-sorting-strategy 'tags)
4809 (setq org-agenda-query-string match)
4810 (setq org-agenda-redo-command
4811 (list 'org-tags-view `(quote ,todo-only)
4812 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4813 (setq files (org-agenda-files nil 'ifmode)
4814 rtnall nil)
4815 (while (setq file (pop files))
4816 (catch 'nextfile
4817 (org-check-agenda-file file)
4818 (setq buffer (if (file-exists-p file)
4819 (org-get-agenda-file-buffer file)
4820 (error "No such file %s" file)))
4821 (if (not buffer)
4822 ;; If file does not exist, error message to agenda
4823 (setq rtn (list
4824 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4825 rtnall (append rtnall rtn))
4826 (with-current-buffer buffer
4827 (unless (derived-mode-p 'org-mode)
4828 (error "Agenda file %s is not in `org-mode'" file))
4829 (save-excursion
4830 (save-restriction
4831 (if (eq buffer org-agenda-restrict)
4832 (narrow-to-region org-agenda-restrict-begin
4833 org-agenda-restrict-end)
4834 (widen))
4835 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4836 (setq rtnall (append rtnall rtn))))))))
4837 (if org-agenda-overriding-header
4838 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4839 nil 'face 'org-agenda-structure) "\n")
4840 (insert "Headlines with TAGS match: ")
4841 (add-text-properties (point-min) (1- (point))
4842 (list 'face 'org-agenda-structure
4843 'short-heading
4844 (concat "Match: " match)))
4845 (setq pos (point))
4846 (insert match "\n")
4847 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4848 (setq pos (point))
4849 (unless org-agenda-multi
4850 (insert "Press `C-u r' to search again with new search string\n"))
4851 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4852 (org-agenda-mark-header-line (point-min))
4853 (when rtnall
4854 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4855 (goto-char (point-min))
4856 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4857 (add-text-properties (point-min) (point-max)
4858 `(org-agenda-type tags
4859 org-last-args (,todo-only ,match)
4860 org-redo-cmd ,org-agenda-redo-command
4861 org-series-cmd ,org-cmd))
4862 (org-agenda-finalize)
4863 (setq buffer-read-only t))))
4865 ;;; Agenda Finding stuck projects
4867 (defvar org-agenda-skip-regexp nil
4868 "Regular expression used in skipping subtrees for the agenda.
4869 This is basically a temporary global variable that can be set and then
4870 used by user-defined selections using `org-agenda-skip-function'.")
4872 (defvar org-agenda-overriding-header nil
4873 "When set during agenda, todo and tags searches it replaces the header.
4874 This variable should not be set directly, but custom commands can bind it
4875 in the options section.")
4877 (defun org-agenda-skip-entry-when-regexp-matches ()
4878 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4879 If yes, it returns the end position of this entry, causing agenda commands
4880 to skip the entry but continuing the search in the subtree. This is a
4881 function that can be put into `org-agenda-skip-function' for the duration
4882 of a command."
4883 (let ((end (save-excursion (org-end-of-subtree t)))
4884 skip)
4885 (save-excursion
4886 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4887 (and skip end)))
4889 (defun org-agenda-skip-subtree-when-regexp-matches ()
4890 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4891 If yes, it returns the end position of this tree, causing agenda commands
4892 to skip this subtree. This is a function that can be put into
4893 `org-agenda-skip-function' for the duration of a command."
4894 (let ((end (save-excursion (org-end-of-subtree t)))
4895 skip)
4896 (save-excursion
4897 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4898 (and skip end)))
4900 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4901 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4902 If yes, it returns the end position of the current entry (NOT the tree),
4903 causing agenda commands to skip the entry but continuing the search in
4904 the subtree. This is a function that can be put into
4905 `org-agenda-skip-function' for the duration of a command. An important
4906 use of this function is for the stuck project list."
4907 (let ((end (save-excursion (org-end-of-subtree t)))
4908 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4909 skip)
4910 (save-excursion
4911 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4912 (and skip entry-end)))
4914 (defun org-agenda-skip-entry-if (&rest conditions)
4915 "Skip entry if any of CONDITIONS is true.
4916 See `org-agenda-skip-if' for details."
4917 (org-agenda-skip-if nil conditions))
4919 (defun org-agenda-skip-subtree-if (&rest conditions)
4920 "Skip entry if any of CONDITIONS is true.
4921 See `org-agenda-skip-if' for details."
4922 (org-agenda-skip-if t conditions))
4924 (defun org-agenda-skip-if (subtree conditions)
4925 "Checks current entity for CONDITIONS.
4926 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4927 the entry (i.e. the text before the next heading) is checked.
4929 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4930 from different tests. Valid conditions are:
4932 scheduled Check if there is a scheduled cookie
4933 notscheduled Check if there is no scheduled cookie
4934 deadline Check if there is a deadline
4935 notdeadline Check if there is no deadline
4936 timestamp Check if there is a timestamp (also deadline or scheduled)
4937 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4938 regexp Check if regexp matches
4939 notregexp Check if regexp does not match.
4940 todo Check if TODO keyword matches
4941 nottodo Check if TODO keyword does not match
4943 The regexp is taken from the conditions list, it must come right after
4944 the `regexp' or `notregexp' element.
4946 `todo' and `nottodo' accept as an argument a list of todo
4947 keywords, which may include \"*\" to match any todo keyword.
4949 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4951 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4953 Instead of a list, a keyword class may be given. For example:
4955 (org-agenda-skip-entry-if 'nottodo 'done)
4957 would skip entries that haven't been marked with any of \"DONE\"
4958 keywords. Possible classes are: `todo', `done', `any'.
4960 If any of these conditions is met, this function returns the end point of
4961 the entity, causing the search to continue from there. This is a function
4962 that can be put into `org-agenda-skip-function' for the duration of a command."
4963 (let (beg end m)
4964 (org-back-to-heading t)
4965 (setq beg (point)
4966 end (if subtree
4967 (progn (org-end-of-subtree t) (point))
4968 (progn (outline-next-heading) (1- (point)))))
4969 (goto-char beg)
4970 (and
4972 (and (memq 'scheduled conditions)
4973 (re-search-forward org-scheduled-time-regexp end t))
4974 (and (memq 'notscheduled conditions)
4975 (not (re-search-forward org-scheduled-time-regexp end t)))
4976 (and (memq 'deadline conditions)
4977 (re-search-forward org-deadline-time-regexp end t))
4978 (and (memq 'notdeadline conditions)
4979 (not (re-search-forward org-deadline-time-regexp end t)))
4980 (and (memq 'timestamp conditions)
4981 (re-search-forward org-ts-regexp end t))
4982 (and (memq 'nottimestamp conditions)
4983 (not (re-search-forward org-ts-regexp end t)))
4984 (and (setq m (memq 'regexp conditions))
4985 (stringp (nth 1 m))
4986 (re-search-forward (nth 1 m) end t))
4987 (and (setq m (memq 'notregexp conditions))
4988 (stringp (nth 1 m))
4989 (not (re-search-forward (nth 1 m) end t)))
4990 (and (or
4991 (setq m (memq 'nottodo conditions))
4992 (setq m (memq 'todo-unblocked conditions))
4993 (setq m (memq 'nottodo-unblocked conditions))
4994 (setq m (memq 'todo conditions)))
4995 (org-agenda-skip-if-todo m end)))
4996 end)))
4998 (defun org-agenda-skip-if-todo (args end)
4999 "Helper function for `org-agenda-skip-if', do not use it directly.
5000 ARGS is a list with first element either `todo', `nottodo',
5001 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
5002 a list of TODO keywords, or a state symbol `todo' or `done' or
5003 `any'."
5004 (let ((kw (car args))
5005 (arg (cadr args))
5006 todo-wds todo-re)
5007 (setq todo-wds
5008 (org-uniquify
5009 (cond
5010 ((listp arg) ;; list of keywords
5011 (if (member "*" arg)
5012 (mapcar 'substring-no-properties org-todo-keywords-1)
5013 arg))
5014 ((symbolp arg) ;; keyword class name
5015 (cond
5016 ((eq arg 'todo)
5017 (org-delete-all org-done-keywords
5018 (mapcar 'substring-no-properties
5019 org-todo-keywords-1)))
5020 ((eq arg 'done) org-done-keywords)
5021 ((eq arg 'any)
5022 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
5023 (setq todo-re
5024 (concat "^\\*+[ \t]+\\<\\("
5025 (mapconcat 'identity todo-wds "\\|")
5026 "\\)\\>"))
5027 (cond
5028 ((eq kw 'todo) (re-search-forward todo-re end t))
5029 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
5030 ((eq kw 'todo-unblocked)
5031 (catch 'unblocked
5032 (while (re-search-forward todo-re end t)
5033 (or (org-entry-blocked-p) (throw 'unblocked t)))
5034 nil))
5035 ((eq kw 'nottodo-unblocked)
5036 (catch 'unblocked
5037 (while (re-search-forward todo-re end t)
5038 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5042 ;;;###autoload
5043 (defun org-agenda-list-stuck-projects (&rest ignore)
5044 "Create agenda view for projects that are stuck.
5045 Stuck projects are project that have no next actions. For the definitions
5046 of what a project is and how to check if it stuck, customize the variable
5047 `org-stuck-projects'."
5048 (interactive)
5049 (let* ((org-agenda-skip-function
5050 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5051 ;; We could have used org-agenda-skip-if here.
5052 (org-agenda-overriding-header
5053 (or org-agenda-overriding-header "List of stuck projects: "))
5054 (matcher (nth 0 org-stuck-projects))
5055 (todo (nth 1 org-stuck-projects))
5056 (todo-wds (if (member "*" todo)
5057 (progn
5058 (org-agenda-prepare-buffers (org-agenda-files
5059 nil 'ifmode))
5060 (org-delete-all
5061 org-done-keywords-for-agenda
5062 (copy-sequence org-todo-keywords-for-agenda)))
5063 todo))
5064 (todo-re (concat "^\\*+[ \t]+\\("
5065 (mapconcat 'identity todo-wds "\\|")
5066 "\\)\\>"))
5067 (tags (nth 2 org-stuck-projects))
5068 (tags-re (if (member "*" tags)
5069 (concat org-outline-regexp-bol
5070 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5071 (if tags
5072 (concat org-outline-regexp-bol
5073 ".*:\\("
5074 (mapconcat 'identity tags "\\|")
5075 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5076 (gen-re (nth 3 org-stuck-projects))
5077 (re-list
5078 (delq nil
5079 (list
5080 (if todo todo-re)
5081 (if tags tags-re)
5082 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5083 gen-re)))))
5084 (setq org-agenda-skip-regexp
5085 (if re-list
5086 (mapconcat 'identity re-list "\\|")
5087 (error "No information how to identify unstuck projects")))
5088 (org-tags-view nil matcher)
5089 (with-current-buffer org-agenda-buffer-name
5090 (setq org-agenda-redo-command
5091 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5093 ;;; Diary integration
5095 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5096 (defvar diary-list-entries-hook)
5097 (defvar diary-time-regexp)
5098 (defun org-get-entries-from-diary (date)
5099 "Get the (Emacs Calendar) diary entries for DATE."
5100 (require 'diary-lib)
5101 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5102 (diary-display-hook '(fancy-diary-display))
5103 (diary-display-function 'fancy-diary-display)
5104 (pop-up-frames nil)
5105 (diary-list-entries-hook
5106 (cons 'org-diary-default-entry diary-list-entries-hook))
5107 (diary-file-name-prefix nil) ; turn this feature off
5108 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5109 entries
5110 (org-disable-agenda-to-diary t))
5111 (save-excursion
5112 (save-window-excursion
5113 (funcall (if (fboundp 'diary-list-entries)
5114 'diary-list-entries 'list-diary-entries)
5115 date 1)))
5116 (if (not (get-buffer diary-fancy-buffer))
5117 (setq entries nil)
5118 (with-current-buffer diary-fancy-buffer
5119 (setq buffer-read-only nil)
5120 (if (zerop (buffer-size))
5121 ;; No entries
5122 (setq entries nil)
5123 ;; Omit the date and other unnecessary stuff
5124 (org-agenda-cleanup-fancy-diary)
5125 ;; Add prefix to each line and extend the text properties
5126 (if (zerop (buffer-size))
5127 (setq entries nil)
5128 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5129 (setq entries
5130 (with-temp-buffer
5131 (insert entries) (goto-char (point-min))
5132 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5133 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5134 (replace-match (concat "; " (match-string 1)))))
5135 (buffer-string)))))
5136 (set-buffer-modified-p nil)
5137 (kill-buffer diary-fancy-buffer)))
5138 (when entries
5139 (setq entries (org-split-string entries "\n"))
5140 (setq entries
5141 (mapcar
5142 (lambda (x)
5143 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5144 ;; Extend the text properties to the beginning of the line
5145 (org-add-props x (text-properties-at (1- (length x)) x)
5146 'type "diary" 'date date 'face 'org-agenda-diary))
5147 entries)))))
5149 (defvar org-agenda-cleanup-fancy-diary-hook nil
5150 "Hook run when the fancy diary buffer is cleaned up.")
5152 (defun org-agenda-cleanup-fancy-diary ()
5153 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5154 This gets rid of the date, the underline under the date, and
5155 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5156 date. It also removes lines that contain only whitespace."
5157 (goto-char (point-min))
5158 (if (looking-at ".*?:[ \t]*")
5159 (progn
5160 (replace-match "")
5161 (re-search-forward "\n=+$" nil t)
5162 (replace-match "")
5163 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5164 (re-search-forward "\n=+$" nil t)
5165 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5166 (goto-char (point-min))
5167 (while (re-search-forward "^ +\n" nil t)
5168 (replace-match ""))
5169 (goto-char (point-min))
5170 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5171 (replace-match ""))
5172 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5174 ;; Make sure entries from the diary have the right text properties.
5175 (eval-after-load "diary-lib"
5176 '(if (boundp 'diary-modify-entry-list-string-function)
5177 ;; We can rely on the hook, nothing to do
5179 ;; Hook not available, must use advice to make this work
5180 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5181 "Make the position visible."
5182 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5183 (stringp string)
5184 buffer-file-name)
5185 (setq string (org-modify-diary-entry-string string))))))
5187 (defun org-modify-diary-entry-string (string)
5188 "Add text properties to string, allowing org-mode to act on it."
5189 (org-add-props string nil
5190 'mouse-face 'highlight
5191 'help-echo (if buffer-file-name
5192 (format "mouse-2 or RET jump to diary file %s"
5193 (abbreviate-file-name buffer-file-name))
5195 'org-agenda-diary-link t
5196 'org-marker (org-agenda-new-marker (point-at-bol))))
5198 (defun org-diary-default-entry ()
5199 "Add a dummy entry to the diary.
5200 Needed to avoid empty dates which mess up holiday display."
5201 ;; Catch the error if dealing with the new add-to-diary-alist
5202 (when org-disable-agenda-to-diary
5203 (condition-case nil
5204 (org-add-to-diary-list original-date "Org-mode dummy" "")
5205 (error
5206 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5208 (defun org-add-to-diary-list (&rest args)
5209 (if (fboundp 'diary-add-to-list)
5210 (apply 'diary-add-to-list args)
5211 (apply 'add-to-diary-list args)))
5213 (defvar org-diary-last-run-time nil)
5215 ;;;###autoload
5216 (defun org-diary (&rest args)
5217 "Return diary information from org files.
5218 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5219 It accesses org files and extracts information from those files to be
5220 listed in the diary. The function accepts arguments specifying what
5221 items should be listed. For a list of arguments allowed here, see the
5222 variable `org-agenda-entry-types'.
5224 The call in the diary file should look like this:
5226 &%%(org-diary) ~/path/to/some/orgfile.org
5228 Use a separate line for each org file to check. Or, if you omit the file name,
5229 all files listed in `org-agenda-files' will be checked automatically:
5231 &%%(org-diary)
5233 If you don't give any arguments (as in the example above), the default value
5234 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5235 So the example above may also be written as
5237 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5239 The function expects the lisp variables `entry' and `date' to be provided
5240 by the caller, because this is how the calendar works. Don't use this
5241 function from a program - use `org-agenda-get-day-entries' instead."
5242 (when (> (- (org-float-time)
5243 org-agenda-last-marker-time)
5245 ;; I am not sure if this works with sticky agendas, because the marker
5246 ;; list is then no longer a global variable.
5247 (org-agenda-reset-markers))
5248 (org-compile-prefix-format 'agenda)
5249 (org-set-sorting-strategy 'agenda)
5250 (setq args (or args org-agenda-entry-types))
5251 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5252 (list entry)
5253 (org-agenda-files t)))
5254 (time (org-float-time))
5255 file rtn results)
5256 (when (or (not org-diary-last-run-time)
5257 (> (- time
5258 org-diary-last-run-time)
5260 (org-agenda-prepare-buffers files))
5261 (setq org-diary-last-run-time time)
5262 ;; If this is called during org-agenda, don't return any entries to
5263 ;; the calendar. Org Agenda will list these entries itself.
5264 (if org-disable-agenda-to-diary (setq files nil))
5265 (while (setq file (pop files))
5266 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5267 (setq results (append results rtn)))
5268 (when results
5269 (setq results
5270 (mapcar (lambda (i) (replace-regexp-in-string
5271 org-bracket-link-regexp "\\3" i)) results))
5272 (concat (org-agenda-finalize-entries results) "\n"))))
5274 ;;; Agenda entry finders
5276 (defun org-agenda-get-day-entries (file date &rest args)
5277 "Does the work for `org-diary' and `org-agenda'.
5278 FILE is the path to a file to be checked for entries. DATE is date like
5279 the one returned by `calendar-current-date'. ARGS are symbols indicating
5280 which kind of entries should be extracted. For details about these, see
5281 the documentation of `org-diary'."
5282 (setq args (or args org-agenda-entry-types))
5283 (let* ((org-startup-folded nil)
5284 (org-startup-align-all-tables nil)
5285 (buffer (if (file-exists-p file)
5286 (org-get-agenda-file-buffer file)
5287 (error "No such file %s" file)))
5288 arg results rtn deadline-results)
5289 (if (not buffer)
5290 ;; If file does not exist, make sure an error message ends up in diary
5291 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5292 (with-current-buffer buffer
5293 (unless (derived-mode-p 'org-mode)
5294 (error "Agenda file %s is not in `org-mode'" file))
5295 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5296 (let ((case-fold-search nil))
5297 (save-excursion
5298 (save-restriction
5299 (if (eq buffer org-agenda-restrict)
5300 (narrow-to-region org-agenda-restrict-begin
5301 org-agenda-restrict-end)
5302 (widen))
5303 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
5304 (while (setq arg (pop args))
5305 (cond
5306 ((and (eq arg :todo)
5307 (equal date (calendar-gregorian-from-absolute
5308 (org-today))))
5309 (setq rtn (org-agenda-get-todos))
5310 (setq results (append results rtn)))
5311 ((eq arg :timestamp)
5312 (setq rtn (org-agenda-get-blocks))
5313 (setq results (append results rtn))
5314 (setq rtn (org-agenda-get-timestamps deadline-results))
5315 (setq results (append results rtn)))
5316 ((eq arg :sexp)
5317 (setq rtn (org-agenda-get-sexps))
5318 (setq results (append results rtn)))
5319 ((eq arg :scheduled)
5320 (setq rtn (org-agenda-get-scheduled deadline-results))
5321 (setq results (append results rtn)))
5322 ((eq arg :scheduled*)
5323 (setq rtn (org-agenda-get-scheduled deadline-results t))
5324 (setq results (append results rtn)))
5325 ((eq arg :closed)
5326 (setq rtn (org-agenda-get-progress))
5327 (setq results (append results rtn)))
5328 ((eq arg :deadline)
5329 (setq rtn (org-agenda-get-deadlines))
5330 (setq deadline-results (copy-sequence rtn))
5331 (setq results (append results rtn)))
5332 ((eq arg :deadline*)
5333 (setq rtn (org-agenda-get-deadlines t))
5334 (setq deadline-results (copy-sequence rtn))
5335 (setq results (append results rtn))))))))
5336 results))))
5338 (defsubst org-em (x y list)
5339 "Is X or Y a member of LIST?"
5340 (or (memq x list) (memq y list)))
5342 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5343 (defvar org-agenda-sorting-strategy-selected nil)
5345 (defun org-agenda-get-todos ()
5346 "Return the TODO information for agenda display."
5347 (let* ((props (list 'face nil
5348 'done-face 'org-agenda-done
5349 'org-not-done-regexp org-not-done-regexp
5350 'org-todo-regexp org-todo-regexp
5351 'org-complex-heading-regexp org-complex-heading-regexp
5352 'mouse-face 'highlight
5353 'help-echo
5354 (format "mouse-2 or RET jump to org file %s"
5355 (abbreviate-file-name buffer-file-name))))
5356 (regexp (format org-heading-keyword-regexp-format
5357 (cond
5358 ((and org-select-this-todo-keyword
5359 (equal org-select-this-todo-keyword "*"))
5360 org-todo-regexp)
5361 (org-select-this-todo-keyword
5362 (concat "\\("
5363 (mapconcat 'identity
5364 (org-split-string
5365 org-select-this-todo-keyword
5366 "|")
5367 "\\|") "\\)"))
5368 (t org-not-done-regexp))))
5369 marker priority category category-pos level tags todo-state ts-date ts-date-type
5370 ee txt beg end inherited-tags todo-state-end-pos)
5371 (goto-char (point-min))
5372 (while (re-search-forward regexp nil t)
5373 (catch :skip
5374 (save-match-data
5375 (beginning-of-line)
5376 (org-agenda-skip)
5377 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5378 (unless (and (setq todo-state (org-get-todo-state))
5379 (setq todo-state-end-pos (match-end 2)))
5380 (goto-char end)
5381 (throw :skip nil))
5382 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5383 (goto-char (1+ beg))
5384 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5385 (throw :skip nil)))
5386 (goto-char (match-beginning 2))
5387 (setq marker (org-agenda-new-marker (match-beginning 0))
5388 category (org-get-category)
5389 ts-date (let (ts)
5390 (save-match-data
5391 (cond ((org-em 'scheduled-up 'scheduled-down
5392 org-agenda-sorting-strategy-selected)
5393 (setq ts (org-entry-get (point) "SCHEDULED")
5394 ts-date-type " scheduled"))
5395 ((org-em 'deadline-up 'deadline-down
5396 org-agenda-sorting-strategy-selected)
5397 (setq ts (org-entry-get (point) "DEADLINE")
5398 ts-date-type " deadline"))
5399 ((org-em 'ts-up 'ts-down
5400 org-agenda-sorting-strategy-selected)
5401 (setq ts (org-entry-get (point) "TIMESTAMP")
5402 ts-date-type " timestamp"))
5403 ((org-em 'tsia-up 'tsia-down
5404 org-agenda-sorting-strategy-selected)
5405 (setq ts (org-entry-get (point) "TIMESTAMP_IA")
5406 ts-date-type " timestamp_ia"))
5407 ((org-em 'timestamp-up 'timestamp-down
5408 org-agenda-sorting-strategy-selected)
5409 (setq ts (or (org-entry-get (point) "SCHEDULED")
5410 (org-entry-get (point) "DEADLINE")
5411 (org-entry-get (point) "TIMESTAMP")
5412 (org-entry-get (point) "TIMESTAMP_IA"))
5413 ts-date-type ""))
5414 (t (setq ts-date-type "")))
5415 (when ts (ignore-errors (org-time-string-to-absolute ts)))))
5416 category-pos (get-text-property (point) 'org-category-position)
5417 txt (org-trim
5418 (buffer-substring (match-beginning 2) (match-end 0)))
5419 inherited-tags
5420 (or (eq org-agenda-show-inherited-tags 'always)
5421 (and (listp org-agenda-show-inherited-tags)
5422 (memq 'todo org-agenda-show-inherited-tags))
5423 (and (eq org-agenda-show-inherited-tags t)
5424 (or (eq org-agenda-use-tag-inheritance t)
5425 (memq 'todo org-agenda-use-tag-inheritance))))
5426 tags (org-get-tags-at nil (not inherited-tags))
5427 level (make-string (org-reduced-level (org-outline-level)) ? )
5428 txt (org-agenda-format-item "" txt level category tags t)
5429 priority (1+ (org-get-priority txt)))
5430 (org-add-props txt props
5431 'org-marker marker 'org-hd-marker marker
5432 'priority priority 'org-category category
5433 'level level
5434 'ts-date ts-date
5435 'org-category-position category-pos
5436 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5437 (push txt ee)
5438 (if org-agenda-todo-list-sublevels
5439 (goto-char todo-state-end-pos)
5440 (org-end-of-subtree 'invisible))))
5441 (nreverse ee)))
5443 (defun org-agenda-todo-custom-ignore-p (time n)
5444 "Check whether timestamp is farther away than n number of days.
5445 This function is invoked if `org-agenda-todo-ignore-deadlines',
5446 `org-agenda-todo-ignore-scheduled' or
5447 `org-agenda-todo-ignore-timestamp' is set to an integer."
5448 (let ((days (org-time-stamp-to-now
5449 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5450 (if (>= n 0)
5451 (>= days n)
5452 (<= days n))))
5454 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5455 (&optional end)
5456 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5457 (when (or org-agenda-todo-ignore-with-date
5458 org-agenda-todo-ignore-scheduled
5459 org-agenda-todo-ignore-deadlines
5460 org-agenda-todo-ignore-timestamp)
5461 (setq end (or end (save-excursion (outline-next-heading) (point))))
5462 (save-excursion
5463 (or (and org-agenda-todo-ignore-with-date
5464 (re-search-forward org-ts-regexp end t))
5465 (and org-agenda-todo-ignore-scheduled
5466 (re-search-forward org-scheduled-time-regexp end t)
5467 (cond
5468 ((eq org-agenda-todo-ignore-scheduled 'future)
5469 (> (org-time-stamp-to-now
5470 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5471 ((eq org-agenda-todo-ignore-scheduled 'past)
5472 (<= (org-time-stamp-to-now
5473 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5474 ((numberp org-agenda-todo-ignore-scheduled)
5475 (org-agenda-todo-custom-ignore-p
5476 (match-string 1) org-agenda-todo-ignore-scheduled))
5477 (t)))
5478 (and org-agenda-todo-ignore-deadlines
5479 (re-search-forward org-deadline-time-regexp end t)
5480 (cond
5481 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5482 ((eq org-agenda-todo-ignore-deadlines 'far)
5483 (not (org-deadline-close (match-string 1))))
5484 ((eq org-agenda-todo-ignore-deadlines 'future)
5485 (> (org-time-stamp-to-now
5486 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5487 ((eq org-agenda-todo-ignore-deadlines 'past)
5488 (<= (org-time-stamp-to-now
5489 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5490 ((numberp org-agenda-todo-ignore-deadlines)
5491 (org-agenda-todo-custom-ignore-p
5492 (match-string 1) org-agenda-todo-ignore-deadlines))
5493 (t (org-deadline-close (match-string 1)))))
5494 (and org-agenda-todo-ignore-timestamp
5495 (let ((buffer (current-buffer))
5496 (regexp
5497 (concat
5498 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5499 (start (point)))
5500 ;; Copy current buffer into a temporary one
5501 (with-temp-buffer
5502 (insert-buffer-substring buffer start end)
5503 (goto-char (point-min))
5504 ;; Delete SCHEDULED and DEADLINE items
5505 (while (re-search-forward regexp end t)
5506 (delete-region (match-beginning 0) (match-end 0)))
5507 (goto-char (point-min))
5508 ;; No search for timestamp left
5509 (when (re-search-forward org-ts-regexp nil t)
5510 (cond
5511 ((eq org-agenda-todo-ignore-timestamp 'future)
5512 (> (org-time-stamp-to-now
5513 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5514 ((eq org-agenda-todo-ignore-timestamp 'past)
5515 (<= (org-time-stamp-to-now
5516 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5517 ((numberp org-agenda-todo-ignore-timestamp)
5518 (org-agenda-todo-custom-ignore-p
5519 (match-string 1) org-agenda-todo-ignore-timestamp))
5520 (t))))))))))
5522 (defun org-agenda-get-timestamps (&optional deadline-results)
5523 "Return the date stamp information for agenda display."
5524 (let* ((props (list 'face 'org-agenda-calendar-event
5525 'org-not-done-regexp org-not-done-regexp
5526 'org-todo-regexp org-todo-regexp
5527 'org-complex-heading-regexp org-complex-heading-regexp
5528 'mouse-face 'highlight
5529 'help-echo
5530 (format "mouse-2 or RET jump to org file %s"
5531 (abbreviate-file-name buffer-file-name))))
5532 (d1 (calendar-absolute-from-gregorian date))
5534 (deadline-position-alist
5535 (mapcar (lambda (a) (and (setq mm (get-text-property
5536 0 'org-hd-marker a))
5537 (cons (marker-position mm) a)))
5538 deadline-results))
5539 (remove-re org-ts-regexp)
5540 (regexp
5541 (concat
5542 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5543 (regexp-quote
5544 (substring
5545 (format-time-string
5546 (car org-time-stamp-formats)
5547 (apply 'encode-time ; DATE bound by calendar
5548 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5549 1 11))
5550 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5551 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5552 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5553 donep tmp priority category category-pos level ee txt timestr tags
5554 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5555 inherited-tags ts-date)
5556 (goto-char (point-min))
5557 (while (setq end-of-match (re-search-forward regexp nil t))
5558 (setq b0 (match-beginning 0)
5559 b3 (match-beginning 3) e3 (match-end 3)
5560 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5561 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5562 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5563 (member todo-state
5564 org-agenda-repeating-timestamp-show-all)))
5565 (catch :skip
5566 (and (org-at-date-range-p) (throw :skip nil))
5567 (org-agenda-skip)
5568 (if (and (match-end 1)
5569 (not (= d1 (org-time-string-to-absolute
5570 (match-string 1) d1 nil show-all
5571 (current-buffer) b0))))
5572 (throw :skip nil))
5573 (if (and e3
5574 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5575 (throw :skip nil))
5576 (setq tmp (buffer-substring (max (point-min)
5577 (- b0 org-ds-keyword-length))
5579 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5580 inactivep (= (char-after b0) ?\[)
5581 deadlinep (string-match org-deadline-regexp tmp)
5582 scheduledp (string-match org-scheduled-regexp tmp)
5583 closedp (and org-agenda-include-inactive-timestamps
5584 (string-match org-closed-string tmp))
5585 clockp (and org-agenda-include-inactive-timestamps
5586 (or (string-match org-clock-string tmp)
5587 (string-match "]-+\\'" tmp)))
5588 warntime (get-text-property (point) 'org-appt-warntime)
5589 donep (member todo-state org-done-keywords))
5590 (if (or scheduledp deadlinep closedp clockp
5591 (and donep org-agenda-skip-timestamp-if-done))
5592 (throw :skip t))
5593 (if (string-match ">" timestr)
5594 ;; substring should only run to end of time stamp
5595 (setq timestr (substring timestr 0 (match-end 0))))
5596 (setq marker (org-agenda-new-marker b0)
5597 category (org-get-category b0)
5598 category-pos (get-text-property b0 'org-category-position))
5599 (save-excursion
5600 (if (not (re-search-backward org-outline-regexp-bol nil t))
5601 (throw :skip nil)
5602 (goto-char (match-beginning 0))
5603 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5604 (assoc (point) deadline-position-alist))
5605 (throw :skip nil))
5606 (setq hdmarker (org-agenda-new-marker)
5607 inherited-tags
5608 (or (eq org-agenda-show-inherited-tags 'always)
5609 (and (listp org-agenda-show-inherited-tags)
5610 (memq 'agenda org-agenda-show-inherited-tags))
5611 (and (eq org-agenda-show-inherited-tags t)
5612 (or (eq org-agenda-use-tag-inheritance t)
5613 (memq 'agenda org-agenda-use-tag-inheritance))))
5614 tags (org-get-tags-at nil (not inherited-tags))
5615 level (make-string (org-reduced-level (org-outline-level)) ? ))
5616 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5617 (setq head (or (match-string 1) ""))
5618 (setq txt (org-agenda-format-item
5619 (if inactivep org-agenda-inactive-leader nil)
5620 head level category tags timestr
5621 remove-re habitp)))
5622 (setq priority (org-get-priority txt))
5623 (org-add-props txt props 'priority priority
5624 'org-marker marker 'org-hd-marker hdmarker
5625 'org-category category 'date date
5626 'level level
5627 'ts-date
5628 (ignore-errors (org-time-string-to-absolute timestr))
5629 'org-category-position category-pos
5630 'todo-state todo-state
5631 'warntime warntime
5632 'type "timestamp")
5633 (push txt ee))
5634 (if org-agenda-skip-additional-timestamps-same-entry
5635 (outline-next-heading)
5636 (goto-char end-of-match))))
5637 (nreverse ee)))
5639 (defun org-agenda-get-sexps ()
5640 "Return the sexp information for agenda display."
5641 (require 'diary-lib)
5642 (let* ((props (list 'face 'org-agenda-calendar-sexp
5643 'mouse-face 'highlight
5644 'help-echo
5645 (format "mouse-2 or RET jump to org file %s"
5646 (abbreviate-file-name buffer-file-name))))
5647 (regexp "^&?%%(")
5648 marker category extra category-pos level ee txt tags entry
5649 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5650 (goto-char (point-min))
5651 (while (re-search-forward regexp nil t)
5652 (catch :skip
5653 (org-agenda-skip)
5654 (setq beg (match-beginning 0))
5655 (goto-char (1- (match-end 0)))
5656 (setq b (point))
5657 (forward-sexp 1)
5658 (setq sexp (buffer-substring b (point)))
5659 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5660 (org-trim (match-string 1))
5661 ""))
5662 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5663 (when result
5664 (setq marker (org-agenda-new-marker beg)
5665 level (make-string (org-reduced-level (org-outline-level)) ? )
5666 category (org-get-category beg)
5667 category-pos (get-text-property beg 'org-category-position)
5668 inherited-tags
5669 (or (eq org-agenda-show-inherited-tags 'always)
5670 (and (listp org-agenda-show-inherited-tags)
5671 (memq 'agenda org-agenda-show-inherited-tags))
5672 (and (eq org-agenda-show-inherited-tags t)
5673 (or (eq org-agenda-use-tag-inheritance t)
5674 (memq 'agenda org-agenda-use-tag-inheritance))))
5675 tags (org-get-tags-at nil (not inherited-tags))
5676 todo-state (org-get-todo-state)
5677 warntime (get-text-property (point) 'org-appt-warntime)
5678 extra nil)
5680 (dolist (r (if (stringp result)
5681 (list result)
5682 result)) ;; we expect a list here
5683 (when (and org-agenda-diary-sexp-prefix
5684 (string-match org-agenda-diary-sexp-prefix r))
5685 (setq extra (match-string 0 r)
5686 r (replace-match "" nil nil r)))
5687 (if (string-match "\\S-" r)
5688 (setq txt r)
5689 (setq txt "SEXP entry returned empty string"))
5690 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5691 (org-add-props txt props 'org-marker marker
5692 'org-category category 'date date 'todo-state todo-state
5693 'org-category-position category-pos 'tags tags
5694 'level level
5695 'type "sexp" 'warntime warntime)
5696 (push txt ee)))))
5697 (nreverse ee)))
5699 ;; Calendar sanity: define some functions that are independent of
5700 ;; `calendar-date-style'.
5701 ;; Normally I would like to use ISO format when calling the diary functions,
5702 ;; but to make sure we still have Emacs 22 compatibility we bind
5703 ;; also `european-calendar-style' and use european format
5704 (defun org-anniversary (year month day &optional mark)
5705 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5706 (org-no-warnings
5707 (let ((calendar-date-style 'european) (european-calendar-style t))
5708 (diary-anniversary day month year mark))))
5709 (defun org-cyclic (N year month day &optional mark)
5710 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5711 (org-no-warnings
5712 (let ((calendar-date-style 'european) (european-calendar-style t))
5713 (diary-cyclic N day month year mark))))
5714 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5715 "Like `diary-block', but with fixed (ISO) order of arguments."
5716 (org-no-warnings
5717 (let ((calendar-date-style 'european) (european-calendar-style t))
5718 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5719 (defun org-date (year month day &optional mark)
5720 "Like `diary-date', but with fixed (ISO) order of arguments."
5721 (org-no-warnings
5722 (let ((calendar-date-style 'european) (european-calendar-style t))
5723 (diary-date day month year mark))))
5725 ;; Define the` org-class' function
5726 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5727 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5728 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5729 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5730 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5731 `holidays', then any date that is known by the Emacs calendar to be a
5732 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5733 then those holidays will be skipped."
5734 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5735 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5736 (d (calendar-absolute-from-gregorian date))
5737 (h (when skip-weeks (calendar-check-holidays date))))
5738 (and
5739 (<= date1 d)
5740 (<= d date2)
5741 (= (calendar-day-of-week date) dayname)
5742 (or (not skip-weeks)
5743 (progn
5744 (require 'cal-iso)
5745 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5746 (not (or (and h (memq 'holidays skip-weeks))
5747 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5748 entry)))
5750 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5751 "Like `org-class', but honor `calendar-date-style'.
5752 The order of the first 2 times 3 arguments depends on the variable
5753 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5754 So for American calendars, give this as MONTH DAY YEAR, for European as
5755 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5756 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5757 is any number of ISO weeks in the block period for which the item should
5758 be skipped.
5760 This function is here only for backward compatibility and it is deprecated,
5761 please use `org-class' instead."
5762 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5763 (date2 (org-order-calendar-date-args m2 d2 y2)))
5764 (org-class
5765 (nth 2 date1) (car date1) (nth 1 date1)
5766 (nth 2 date2) (car date2) (nth 1 date2)
5767 dayname skip-weeks)))
5768 (make-obsolete 'org-diary-class 'org-class "")
5770 (defalias 'org-get-closed 'org-agenda-get-progress)
5771 (defun org-agenda-get-progress ()
5772 "Return the logged TODO entries for agenda display."
5773 (let* ((props (list 'mouse-face 'highlight
5774 'org-not-done-regexp org-not-done-regexp
5775 'org-todo-regexp org-todo-regexp
5776 'org-complex-heading-regexp org-complex-heading-regexp
5777 'help-echo
5778 (format "mouse-2 or RET jump to org file %s"
5779 (abbreviate-file-name buffer-file-name))))
5780 (items (if (consp org-agenda-show-log-scoped)
5781 org-agenda-show-log-scoped
5782 (if (eq org-agenda-show-log-scoped 'clockcheck)
5783 '(clock)
5784 org-agenda-log-mode-items)))
5785 (parts
5786 (delq nil
5787 (list
5788 (if (memq 'closed items) (concat "\\<" org-closed-string))
5789 (if (memq 'clock items) (concat "\\<" org-clock-string))
5790 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5791 (parts-re (if parts (mapconcat 'identity parts "\\|")
5792 (error "`org-agenda-log-mode-items' is empty")))
5793 (regexp (concat
5794 "\\(" parts-re "\\)"
5795 " *\\["
5796 (regexp-quote
5797 (substring
5798 (format-time-string
5799 (car org-time-stamp-formats)
5800 (apply 'encode-time ; DATE bound by calendar
5801 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5802 1 11))))
5803 (org-agenda-search-headline-for-time nil)
5804 marker hdmarker priority category category-pos level tags closedp
5805 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5806 (goto-char (point-min))
5807 (while (re-search-forward regexp nil t)
5808 (catch :skip
5809 (org-agenda-skip)
5810 (setq marker (org-agenda-new-marker (match-beginning 0))
5811 closedp (equal (match-string 1) org-closed-string)
5812 statep (equal (string-to-char (match-string 1)) ?-)
5813 clockp (not (or closedp statep))
5814 state (and statep (match-string 2))
5815 category (org-get-category (match-beginning 0))
5816 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5817 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5818 (when (string-match "\\]" timestr)
5819 ;; substring should only run to end of time stamp
5820 (setq rest (substring timestr (match-end 0))
5821 timestr (substring timestr 0 (match-end 0)))
5822 (if (and (not closedp) (not statep)
5823 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5824 rest))
5825 (progn (setq timestr (concat (substring timestr 0 -1)
5826 "-" (match-string 1 rest) "]"))
5827 (setq clocked (match-string 2 rest)))
5828 (setq clocked "-")))
5829 (save-excursion
5830 (setq extra
5831 (cond
5832 ((not org-agenda-log-mode-add-notes) nil)
5833 (statep
5834 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5835 (match-string 1)))
5836 (clockp
5837 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5838 (match-string 1)))))
5839 (if (not (re-search-backward org-outline-regexp-bol nil t))
5840 (throw :skip nil)
5841 (goto-char (match-beginning 0))
5842 (setq hdmarker (org-agenda-new-marker)
5843 inherited-tags
5844 (or (eq org-agenda-show-inherited-tags 'always)
5845 (and (listp org-agenda-show-inherited-tags)
5846 (memq 'todo org-agenda-show-inherited-tags))
5847 (and (eq org-agenda-show-inherited-tags t)
5848 (or (eq org-agenda-use-tag-inheritance t)
5849 (memq 'todo org-agenda-use-tag-inheritance))))
5850 tags (org-get-tags-at nil (not inherited-tags))
5851 level (make-string (org-reduced-level (org-outline-level)) ? ))
5852 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5853 (setq txt (match-string 1))
5854 (when extra
5855 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5856 (setq txt (concat (substring txt 0 (match-beginning 1))
5857 " - " extra " " (match-string 2 txt)))
5858 (setq txt (concat txt " - " extra))))
5859 (setq txt (org-agenda-format-item
5860 (cond
5861 (closedp "Closed: ")
5862 (statep (concat "State: (" state ")"))
5863 (t (concat "Clocked: (" clocked ")")))
5864 txt level category tags timestr)))
5865 (setq priority 100000)
5866 (org-add-props txt props
5867 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5868 'priority priority 'org-category category
5869 'org-category-position category-pos
5870 'level level
5871 'type "closed" 'date date
5872 'undone-face 'org-warning 'done-face 'org-agenda-done)
5873 (push txt ee))
5874 (goto-char (point-at-eol))))
5875 (nreverse ee)))
5877 (defun org-agenda-show-clocking-issues ()
5878 "Add overlays, showing issues with clocking.
5879 See also the user option `org-agenda-clock-consistency-checks'."
5880 (interactive)
5881 (let* ((org-time-clocksum-use-effort-durations nil)
5882 (pl org-agenda-clock-consistency-checks)
5883 (re (concat "^[ \t]*"
5884 org-clock-string
5885 "[ \t]+"
5886 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5887 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5888 (tlstart 0.)
5889 (tlend 0.)
5890 (maxtime (org-hh:mm-string-to-minutes
5891 (or (plist-get pl :max-duration) "24:00")))
5892 (mintime (org-hh:mm-string-to-minutes
5893 (or (plist-get pl :min-duration) 0)))
5894 (maxgap (org-hh:mm-string-to-minutes
5895 ;; default 30:00 means never complain
5896 (or (plist-get pl :max-gap) "30:00")))
5897 (gapok (mapcar 'org-hh:mm-string-to-minutes
5898 (plist-get pl :gap-ok-around)))
5899 (def-face (or (plist-get pl :default-face)
5900 '((:background "DarkRed") (:foreground "white"))))
5901 issue face m te ts dt ov)
5902 (goto-char (point-min))
5903 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5904 (setq issue nil face def-face)
5905 (catch 'next
5906 (setq m (org-get-at-bol 'org-marker)
5907 te nil ts nil)
5908 (unless (and m (markerp m))
5909 (setq issue "No valid clock line") (throw 'next t))
5910 (org-with-point-at m
5911 (save-excursion
5912 (goto-char (point-at-bol))
5913 (unless (looking-at re)
5914 (error "No valid Clock line")
5915 (throw 'next t))
5916 (unless (match-end 3)
5917 (setq issue "No end time"
5918 face (or (plist-get pl :no-end-time-face) face))
5919 (throw 'next t))
5920 (setq ts (match-string 1)
5921 te (match-string 3)
5922 ts (org-float-time
5923 (apply 'encode-time (org-parse-time-string ts)))
5924 te (org-float-time
5925 (apply 'encode-time (org-parse-time-string te)))
5926 dt (- te ts))))
5927 (cond
5928 ((> dt (* 60 maxtime))
5929 ;; a very long clocking chunk
5930 (setq issue (format "Clocking interval is very long: %s"
5931 (org-minutes-to-clocksum-string
5932 (floor (/ (float dt) 60.))))
5933 face (or (plist-get pl :long-face) face)))
5934 ((< dt (* 60 mintime))
5935 ;; a very short clocking chunk
5936 (setq issue (format "Clocking interval is very short: %s"
5937 (org-minutes-to-clocksum-string
5938 (floor (/ (float dt) 60.))))
5939 face (or (plist-get pl :short-face) face)))
5940 ((and (> tlend 0) (< ts tlend))
5941 ;; Two clock entries are overlapping
5942 (setq issue (format "Clocking overlap: %d minutes"
5943 (/ (- tlend ts) 60))
5944 face (or (plist-get pl :overlap-face) face)))
5945 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5946 ;; There is a gap, lets see if we need to report it
5947 (unless (org-agenda-check-clock-gap tlend ts gapok)
5948 (setq issue (format "Clocking gap: %d minutes"
5949 (/ (- ts tlend) 60))
5950 face (or (plist-get pl :gap-face) face))))
5951 (t nil)))
5952 (setq tlend (or te tlend) tlstart (or ts tlstart))
5953 (when issue
5954 ;; OK, there was some issue, add an overlay to show the issue
5955 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5956 (overlay-put ov 'before-string
5957 (concat
5958 (org-add-props
5959 (format "%-43s" (concat " " issue))
5961 'face face)
5962 "\n"))
5963 (overlay-put ov 'evaporate t)))))
5965 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5966 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5967 (catch 'exit
5968 (unless ok-list
5969 ;; there are no OK times for gaps...
5970 (throw 'exit nil))
5971 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5972 ;; This is more than 24 hours, so it is OK.
5973 ;; because we have at least one OK time, that must be in the
5974 ;; 24 hour interval.
5975 (throw 'exit t))
5976 ;; We have a shorter gap.
5977 ;; Now we have to get the minute of the day when these times are
5978 (let* ((t1dec (decode-time (seconds-to-time t1)))
5979 (t2dec (decode-time (seconds-to-time t2)))
5980 ;; compute the minute on the day
5981 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5982 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5983 (when (< min2 min1)
5984 ;; if min2 is smaller than min1, this means it is on the next day.
5985 ;; Wrap it to after midnight.
5986 (setq min2 (+ min2 1440)))
5987 ;; Now check if any of the OK times is in the gap
5988 (mapc (lambda (x)
5989 ;; Wrap the time to after midnight if necessary
5990 (if (< x min1) (setq x (+ x 1440)))
5991 ;; Check if in interval
5992 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5993 ok-list)
5994 ;; Nope, this gap is not OK
5995 nil)))
5997 (defun org-agenda-get-deadlines (&optional with-hour)
5998 "Return the deadline information for agenda display.
5999 When WITH-HOUR is non-nil, only return deadlines with an hour
6000 specification like [h]h:mm."
6001 (let* ((props (list 'mouse-face 'highlight
6002 'org-not-done-regexp org-not-done-regexp
6003 'org-todo-regexp org-todo-regexp
6004 'org-complex-heading-regexp org-complex-heading-regexp
6005 'help-echo
6006 (format "mouse-2 or RET jump to org file %s"
6007 (abbreviate-file-name buffer-file-name))))
6008 (regexp (if with-hour
6009 org-deadline-time-hour-regexp
6010 org-deadline-time-regexp))
6011 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6012 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6013 (dl0 (car org-agenda-deadline-leaders))
6014 (dl1 (nth 1 org-agenda-deadline-leaders))
6015 (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
6016 d2 diff dfrac wdays pos pos1 category category-pos level
6017 tags suppress-prewarning ee txt head face s todo-state
6018 show-all upcomingp donep timestr warntime inherited-tags ts-date)
6019 (goto-char (point-min))
6020 (while (re-search-forward regexp nil t)
6021 (catch :skip
6022 (org-agenda-skip)
6023 (setq s (match-string 1)
6024 txt nil
6025 pos (1- (match-beginning 1))
6026 todo-state (save-match-data (org-get-todo-state))
6027 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6028 (member todo-state
6029 org-agenda-repeating-timestamp-show-all))
6030 d2 (org-time-string-to-absolute
6031 s d1 'past show-all (current-buffer) pos)
6032 diff (- d2 d1))
6033 (setq suppress-prewarning
6034 (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
6035 (let ((item (buffer-substring (point-at-bol)
6036 (point-at-eol))))
6037 (save-match-data
6038 (and (string-match
6039 org-scheduled-time-regexp item)
6040 (match-string 1 item)))))))
6041 (cond
6042 ((not ds) nil)
6043 ;; The current item has a scheduled date (in ds), so
6044 ;; evaluate its prewarning lead time.
6045 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6046 ;; Use global prewarning-restart lead time.
6047 org-agenda-skip-deadline-prewarning-if-scheduled)
6048 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6049 'pre-scheduled)
6050 ;; Set prewarning to no earlier than scheduled.
6051 (min (- d2 (org-time-string-to-absolute
6052 ds d1 'past show-all (current-buffer) pos))
6053 org-deadline-warning-days))
6054 ;; Set prewarning to deadline.
6055 (t 0))))
6056 (setq wdays (if suppress-prewarning
6057 (let ((org-deadline-warning-days suppress-prewarning))
6058 (org-get-wdays s))
6059 (org-get-wdays s))
6060 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
6061 upcomingp (and todayp (> diff 0)))
6062 ;; When to show a deadline in the calendar:
6063 ;; If the expiration is within wdays warning time.
6064 ;; Past-due deadlines are only shown on the current date
6065 (if (and (or (and (<= diff wdays)
6066 (and todayp (not org-agenda-only-exact-dates)))
6067 (= diff 0)))
6068 (save-excursion
6069 ;; (setq todo-state (org-get-todo-state))
6070 (setq donep (member todo-state org-done-keywords))
6071 (if (and donep
6072 (or org-agenda-skip-deadline-if-done
6073 (not (= diff 0))))
6074 (setq txt nil)
6075 (setq category (org-get-category)
6076 warntime (get-text-property (point) 'org-appt-warntime)
6077 category-pos (get-text-property (point) 'org-category-position))
6078 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6079 (throw :skip nil)
6080 (goto-char (match-end 0))
6081 (setq pos1 (match-beginning 0))
6082 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6083 (setq inherited-tags
6084 (or (eq org-agenda-show-inherited-tags 'always)
6085 (and (listp org-agenda-show-inherited-tags)
6086 (memq 'agenda org-agenda-show-inherited-tags))
6087 (and (eq org-agenda-show-inherited-tags t)
6088 (or (eq org-agenda-use-tag-inheritance t)
6089 (memq 'agenda org-agenda-use-tag-inheritance))))
6090 tags (org-get-tags-at pos1 (not inherited-tags)))
6091 (setq head (buffer-substring
6092 (point)
6093 (progn (skip-chars-forward "^\r\n")
6094 (point))))
6095 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6096 (setq timestr
6097 (concat (substring s (match-beginning 1)) " "))
6098 (setq timestr 'time))
6099 (setq txt (org-agenda-format-item
6100 (cond ((= diff 0) dl0)
6101 ((> diff 0)
6102 (if (functionp dl1)
6103 (funcall dl1 diff date)
6104 (format dl1 diff)))
6106 (if (functionp dl2)
6107 (funcall dl2 diff date)
6108 (format dl2 (if (string= dl2 dl1)
6109 diff (abs diff))))))
6110 head level category tags
6111 (if (not (= diff 0)) nil timestr)))))
6112 (when txt
6113 (setq face (org-agenda-deadline-face dfrac))
6114 (org-add-props txt props
6115 'org-marker (org-agenda-new-marker pos)
6116 'warntime warntime
6117 'level level
6118 'ts-date d2
6119 'org-hd-marker (org-agenda-new-marker pos1)
6120 'priority (+ (- diff)
6121 (org-get-priority txt))
6122 'org-category category
6123 'org-category-position category-pos
6124 'todo-state todo-state
6125 'type (if upcomingp "upcoming-deadline" "deadline")
6126 'date (if upcomingp date d2)
6127 'face (if donep 'org-agenda-done face)
6128 'undone-face face 'done-face 'org-agenda-done)
6129 (push txt ee))))))
6130 (nreverse ee)))
6132 (defun org-agenda-deadline-face (fraction)
6133 "Return the face to displaying a deadline item.
6134 FRACTION is what fraction of the head-warning time has passed."
6135 (let ((faces org-agenda-deadline-faces) f)
6136 (catch 'exit
6137 (while (setq f (pop faces))
6138 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6140 (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
6141 "Return the scheduled information for agenda display.
6142 When WITH-HOUR is non-nil, only return scheduled items with
6143 an hour specification like [h]h:mm."
6144 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6145 'org-todo-regexp org-todo-regexp
6146 'org-complex-heading-regexp org-complex-heading-regexp
6147 'done-face 'org-agenda-done
6148 'mouse-face 'highlight
6149 'help-echo
6150 (format "mouse-2 or RET jump to org file %s"
6151 (abbreviate-file-name buffer-file-name))))
6152 (regexp (if with-hour
6153 org-scheduled-time-hour-regexp
6154 org-scheduled-time-regexp))
6155 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6156 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6158 (deadline-position-alist
6159 (mapcar (lambda (a) (and (setq mm (get-text-property
6160 0 'org-hd-marker a))
6161 (cons (marker-position mm) a)))
6162 deadline-results))
6163 d2 diff pos pos1 category category-pos level tags donep
6164 ee txt head pastschedp todo-state face timestr s habitp show-all
6165 did-habit-check-p warntime inherited-tags ts-date suppress-delay
6166 ddays)
6167 (goto-char (point-min))
6168 (while (re-search-forward regexp nil t)
6169 (catch :skip
6170 (org-agenda-skip)
6171 (setq s (match-string 1)
6172 txt nil
6173 pos (1- (match-beginning 1))
6174 todo-state (save-match-data (org-get-todo-state))
6175 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6176 (member todo-state
6177 org-agenda-repeating-timestamp-show-all))
6178 d2 (org-time-string-to-absolute
6179 s d1 'past show-all (current-buffer) pos)
6180 diff (- d2 d1)
6181 warntime (get-text-property (point) 'org-appt-warntime))
6182 (setq pastschedp (and todayp (< diff 0)))
6183 (setq did-habit-check-p nil)
6184 (setq suppress-delay
6185 (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
6186 (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
6187 (save-match-data
6188 (and (string-match
6189 org-deadline-time-regexp item)
6190 (match-string 1 item)))))))
6191 (cond
6192 ((not ds) nil)
6193 ;; The current item has a deadline date (in ds), so
6194 ;; evaluate its delay time.
6195 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6196 ;; Use global delay time.
6197 (- org-agenda-skip-scheduled-delay-if-deadline))
6198 ((eq org-agenda-skip-scheduled-delay-if-deadline
6199 'post-deadline)
6200 ;; Set delay to no later than deadline.
6201 (min (- d2 (org-time-string-to-absolute
6202 ds d1 'past show-all (current-buffer) pos))
6203 org-scheduled-delay-days))
6204 (t 0))))
6205 (setq ddays (if suppress-delay
6206 (let ((org-scheduled-delay-days suppress-delay))
6207 (org-get-wdays s t t))
6208 (org-get-wdays s t)))
6209 ;; Use a delay of 0 when there is a repeater and the delay is
6210 ;; of the form --3d
6211 (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6212 (< (org-time-string-to-absolute s)
6213 (org-time-string-to-absolute
6214 s d2 'past nil (current-buffer) pos)))
6215 (setq ddays 0))
6216 ;; When to show a scheduled item in the calendar:
6217 ;; If it is on or past the date.
6218 (when (or (and (> ddays 0) (= diff (- ddays)))
6219 (and (zerop ddays) (= diff 0))
6220 (and (< (+ diff ddays) 0)
6221 (< (abs diff) org-scheduled-past-days)
6222 (and todayp (not org-agenda-only-exact-dates)))
6223 ;; org-is-habit-p uses org-entry-get, which is expansive
6224 ;; so we go extra mile to only call it once
6225 (and todayp
6226 (boundp 'org-habit-show-all-today)
6227 org-habit-show-all-today
6228 (setq did-habit-check-p t)
6229 (setq habitp (and (functionp 'org-is-habit-p)
6230 (org-is-habit-p)))))
6231 (save-excursion
6232 (setq donep (member todo-state org-done-keywords))
6233 (if (and donep
6234 (or org-agenda-skip-scheduled-if-done
6235 (not (= diff 0))
6236 (and (functionp 'org-is-habit-p)
6237 (org-is-habit-p))))
6238 (setq txt nil)
6239 (setq habitp (if did-habit-check-p habitp
6240 (and (functionp 'org-is-habit-p)
6241 (org-is-habit-p))))
6242 (setq category (org-get-category)
6243 category-pos (get-text-property (point) 'org-category-position))
6244 (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
6245 'repeated-after-deadline)
6246 (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
6247 (throw :skip nil))
6248 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6249 (throw :skip nil)
6250 (goto-char (match-end 0))
6251 (setq pos1 (match-beginning 0))
6252 (if habitp
6253 (if (or (not org-habit-show-habits)
6254 (and (not todayp)
6255 (boundp 'org-habit-show-habits-only-for-today)
6256 org-habit-show-habits-only-for-today))
6257 (throw :skip nil))
6258 (if (and
6259 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
6260 (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
6261 pastschedp))
6262 (setq mm (assoc pos1 deadline-position-alist)))
6263 (throw :skip nil)))
6264 (setq inherited-tags
6265 (or (eq org-agenda-show-inherited-tags 'always)
6266 (and (listp org-agenda-show-inherited-tags)
6267 (memq 'agenda org-agenda-show-inherited-tags))
6268 (and (eq org-agenda-show-inherited-tags t)
6269 (or (eq org-agenda-use-tag-inheritance t)
6270 (memq 'agenda org-agenda-use-tag-inheritance))))
6272 tags (org-get-tags-at nil (not inherited-tags)))
6273 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6274 (setq head (buffer-substring
6275 (point)
6276 (progn (skip-chars-forward "^\r\n") (point))))
6277 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6278 (setq timestr
6279 (concat (substring s (match-beginning 1)) " "))
6280 (setq timestr 'time))
6281 (setq txt (org-agenda-format-item
6282 (if (= diff 0)
6283 (car org-agenda-scheduled-leaders)
6284 (format (nth 1 org-agenda-scheduled-leaders)
6285 (- 1 diff)))
6286 head level category tags
6287 (if (not (= diff 0)) nil timestr)
6288 nil habitp))))
6289 (when txt
6290 (setq face
6291 (cond
6292 ((and (not habitp) pastschedp)
6293 'org-scheduled-previously)
6294 (todayp 'org-scheduled-today)
6295 (t 'org-scheduled))
6296 habitp (and habitp (org-habit-parse-todo)))
6297 (org-add-props txt props
6298 'undone-face face
6299 'face (if donep 'org-agenda-done face)
6300 'org-marker (org-agenda-new-marker pos)
6301 'org-hd-marker (org-agenda-new-marker pos1)
6302 'type (if pastschedp "past-scheduled" "scheduled")
6303 'date (if pastschedp d2 date)
6304 'ts-date d2
6305 'warntime warntime
6306 'level level
6307 'priority (if habitp
6308 (org-habit-get-priority habitp)
6309 (+ 94 (- 5 diff) (org-get-priority txt)))
6310 'org-category category
6311 'category-position category-pos
6312 'org-habit-p habitp
6313 'todo-state todo-state)
6314 (push txt ee))))))
6315 (nreverse ee)))
6317 (defun org-agenda-get-blocks ()
6318 "Return the date-range information for agenda display."
6319 (let* ((props (list 'face nil
6320 'org-not-done-regexp org-not-done-regexp
6321 'org-todo-regexp org-todo-regexp
6322 'org-complex-heading-regexp org-complex-heading-regexp
6323 'mouse-face 'highlight
6324 'help-echo
6325 (format "mouse-2 or RET jump to org file %s"
6326 (abbreviate-file-name buffer-file-name))))
6327 (regexp org-tr-regexp)
6328 (d0 (calendar-absolute-from-gregorian date))
6329 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
6330 level todo-state tags pos head donep inherited-tags)
6331 (goto-char (point-min))
6332 (while (re-search-forward regexp nil t)
6333 (catch :skip
6334 (org-agenda-skip)
6335 (setq pos (point))
6336 (let ((start-time (match-string 1))
6337 (end-time (match-string 2)))
6338 (setq s1 (match-string 1)
6339 s2 (match-string 2)
6340 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6341 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6342 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6343 ;; Only allow days between the limits, because the normal
6344 ;; date stamps will catch the limits.
6345 (save-excursion
6346 (setq todo-state (org-get-todo-state))
6347 (setq donep (member todo-state org-done-keywords))
6348 (if (and donep org-agenda-skip-timestamp-if-done)
6349 (throw :skip t))
6350 (setq marker (org-agenda-new-marker (point)))
6351 (setq category (org-get-category)
6352 category-pos (get-text-property (point) 'org-category-position))
6353 (if (not (re-search-backward org-outline-regexp-bol nil t))
6354 (throw :skip nil)
6355 (goto-char (match-beginning 0))
6356 (setq hdmarker (org-agenda-new-marker (point))
6357 inherited-tags
6358 (or (eq org-agenda-show-inherited-tags 'always)
6359 (and (listp org-agenda-show-inherited-tags)
6360 (memq 'agenda org-agenda-show-inherited-tags))
6361 (and (eq org-agenda-show-inherited-tags t)
6362 (or (eq org-agenda-use-tag-inheritance t)
6363 (memq 'agenda org-agenda-use-tag-inheritance))))
6365 tags (org-get-tags-at nil (not inherited-tags)))
6366 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6367 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6368 (setq head (match-string 1))
6369 (let ((remove-re
6370 (if org-agenda-remove-timeranges-from-blocks
6371 (concat
6372 "<" (regexp-quote s1) ".*?>"
6373 "--"
6374 "<" (regexp-quote s2) ".*?>")
6375 nil)))
6376 (setq txt (org-agenda-format-item
6377 (format
6378 (nth (if (= d1 d2) 0 1)
6379 org-agenda-timerange-leaders)
6380 (1+ (- d0 d1)) (1+ (- d2 d1)))
6381 head level category tags
6382 (cond ((and (= d1 d0) (= d2 d0))
6383 (concat "<" start-time ">--<" end-time ">"))
6384 ((= d1 d0)
6385 (concat "<" start-time ">"))
6386 ((= d2 d0)
6387 (concat "<" end-time ">")))
6388 remove-re))))
6389 (org-add-props txt props
6390 'org-marker marker 'org-hd-marker hdmarker
6391 'type "block" 'date date
6392 'level level
6393 'todo-state todo-state
6394 'priority (org-get-priority txt) 'org-category category
6395 'org-category-position category-pos)
6396 (push txt ee))))
6397 (goto-char pos)))
6398 ;; Sort the entries by expiration date.
6399 (nreverse ee)))
6401 ;;; Agenda presentation and sorting
6403 (defvar org-prefix-has-time nil
6404 "A flag, set by `org-compile-prefix-format'.
6405 The flag is set if the currently compiled format contains a `%t'.")
6406 (defvar org-prefix-has-tag nil
6407 "A flag, set by `org-compile-prefix-format'.
6408 The flag is set if the currently compiled format contains a `%T'.")
6409 (defvar org-prefix-has-effort nil
6410 "A flag, set by `org-compile-prefix-format'.
6411 The flag is set if the currently compiled format contains a `%e'.")
6412 (defvar org-prefix-has-breadcrumbs nil
6413 "A flag, set by `org-compile-prefix-format'.
6414 The flag is set if the currently compiled format contains a `%b'.")
6415 (defvar org-prefix-category-length nil
6416 "Used by `org-compile-prefix-format' to remember the category field width.")
6417 (defvar org-prefix-category-max-length nil
6418 "Used by `org-compile-prefix-format' to remember the category field width.")
6420 (defun org-agenda-get-category-icon (category)
6421 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6422 (dolist (entry org-agenda-category-icon-alist)
6423 (when (org-string-match-p (car entry) category)
6424 (if (listp (cadr entry))
6425 (return (cadr entry))
6426 (return (apply 'create-image (cdr entry)))))))
6428 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6429 remove-re habitp)
6430 "Format TXT to be inserted into the agenda buffer.
6431 In particular, add the prefix and corresponding text properties.
6433 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6434 LEVEL may be a string to replace the `%l' specifier.
6435 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6436 category taken from local variable or file name. It will replace the `%c'
6437 specifier in the format.
6438 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6439 TXT for sorting of this entry, and for the `%t' specifier in the format.
6440 When DOTIME is a string, this string is searched for a time before TXT is.
6441 TAGS can be the tags of the headline.
6442 Any match of REMOVE-RE will be removed from TXT."
6443 ;; We keep the org-prefix-* variable values along with a compiled
6444 ;; formatter, so that multiple agendas existing at the same time do
6445 ;; not step on each other toes.
6447 ;; It was inconvenient to make these variables buffer local in
6448 ;; Agenda buffers, because this function expects to be called with
6449 ;; the buffer where item comes from being current, and not agenda
6450 ;; buffer
6451 (let* ((bindings (car org-prefix-format-compiled))
6452 (formatter (cadr org-prefix-format-compiled)))
6453 (loop for (var value) in bindings
6454 do (set var value))
6455 (save-match-data
6456 ;; Diary entries sometimes have extra whitespace at the beginning
6457 (setq txt (org-trim txt))
6459 ;; Fix the tags part in txt
6460 (setq txt (org-agenda-fix-displayed-tags
6461 txt tags
6462 org-agenda-show-inherited-tags
6463 org-agenda-hide-tags-regexp))
6465 (let* ((category (or category
6466 (if (stringp org-category)
6467 org-category
6468 (and org-category (symbol-name org-category)))
6469 (if buffer-file-name
6470 (file-name-sans-extension
6471 (file-name-nondirectory buffer-file-name))
6472 "")))
6473 (category-icon (org-agenda-get-category-icon category))
6474 (category-icon (if category-icon
6475 (propertize " " 'display category-icon)
6476 ""))
6477 ;; time, tag, effort are needed for the eval of the prefix format
6478 (tag (if tags (nth (1- (length tags)) tags) ""))
6479 time effort neffort
6480 (ts (if dotime (concat
6481 (if (stringp dotime) dotime "")
6482 (and org-agenda-search-headline-for-time txt))))
6483 (time-of-day (and dotime (org-get-time-of-day ts)))
6484 stamp plain s0 s1 s2 rtn srp l
6485 duration thecategory breadcrumbs)
6486 (and (derived-mode-p 'org-mode) buffer-file-name
6487 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6488 (when (and dotime time-of-day)
6489 ;; Extract starting and ending time and move them to prefix
6490 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6491 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6492 (setq s0 (match-string 0 ts)
6493 srp (and stamp (match-end 3))
6494 s1 (match-string (if plain 1 2) ts)
6495 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6497 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6498 ;; them, we might want to remove them there to avoid duplication.
6499 ;; The user can turn this off with a variable.
6500 (if (and org-prefix-has-time
6501 org-agenda-remove-times-when-in-prefix (or stamp plain)
6502 (string-match (concat (regexp-quote s0) " *") txt)
6503 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6504 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6505 (= (match-beginning 0) 0)
6507 (setq txt (replace-match "" nil nil txt))))
6508 ;; Normalize the time(s) to 24 hour
6509 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6510 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6512 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6513 (let (org-time-clocksum-use-effort-durations)
6514 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6515 (setq s2
6516 (org-minutes-to-clocksum-string
6517 (+ (org-hh:mm-string-to-minutes s1)
6518 org-agenda-default-appointment-duration)))))
6520 ;; Compute the duration
6521 (when s2
6522 (setq duration (- (org-hh:mm-string-to-minutes s2)
6523 (org-hh:mm-string-to-minutes s1)))))
6525 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6526 txt)
6527 ;; Tags are in the string
6528 (if (or (eq org-agenda-remove-tags t)
6529 (and org-agenda-remove-tags
6530 org-prefix-has-tag))
6531 (setq txt (replace-match "" t t txt))
6532 (setq txt (replace-match
6533 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6534 (match-string 2 txt))
6535 t t txt))))
6536 (when (derived-mode-p 'org-mode)
6537 (setq effort (ignore-errors (get-text-property 0 'org-effort txt))))
6539 ;; org-agenda-add-time-grid-maybe calls us with *Agenda* as
6540 ;; current buffer, so move this check outside of above
6541 (if effort
6542 (setq neffort (org-duration-string-to-minutes effort)
6543 effort (setq effort (concat "[" effort "]")))
6544 ;; prevent erroring out with %e format when there is no effort
6545 (setq effort ""))
6547 (when remove-re
6548 (while (string-match remove-re txt)
6549 (setq txt (replace-match "" t t txt))))
6551 ;; Set org-heading property on `txt' to mark the start of the
6552 ;; heading.
6553 (add-text-properties 0 (length txt) '(org-heading t) txt)
6555 ;; Prepare the variables needed in the eval of the compiled format
6556 (if org-prefix-has-breadcrumbs
6557 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6558 (let ((s (org-display-outline-path nil nil "->" t)))
6559 (if (eq "" s) "" (concat s "->"))))))
6560 (setq time (cond (s2 (concat
6561 (org-agenda-time-of-day-to-ampm-maybe s1)
6562 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6563 (if org-agenda-timegrid-use-ampm " ")))
6564 (s1 (concat
6565 (org-agenda-time-of-day-to-ampm-maybe s1)
6566 (if org-agenda-timegrid-use-ampm
6567 "........ "
6568 "......")))
6569 (t ""))
6570 extra (or (and (not habitp) extra) "")
6571 category (if (symbolp category) (symbol-name category) category)
6572 thecategory (copy-sequence category)
6573 level (or level ""))
6574 (if (string-match org-bracket-link-regexp category)
6575 (progn
6576 (setq l (if (match-end 3)
6577 (- (match-end 3) (match-beginning 3))
6578 (- (match-end 1) (match-beginning 1))))
6579 (when (< l (or org-prefix-category-length 0))
6580 (setq category (copy-sequence category))
6581 (org-add-props category nil
6582 'extra-space (make-string
6583 (- org-prefix-category-length l 1) ?\ ))))
6584 (if (and org-prefix-category-max-length
6585 (>= (length category) org-prefix-category-max-length))
6586 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6587 ;; Evaluate the compiled format
6588 (setq rtn (concat (eval formatter) txt))
6590 ;; And finally add the text properties
6591 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6592 (org-add-props rtn nil
6593 'org-category (if thecategory (downcase thecategory) category)
6594 'tags (mapcar 'org-downcase-keep-props tags)
6595 'org-highest-priority org-highest-priority
6596 'org-lowest-priority org-lowest-priority
6597 'time-of-day time-of-day
6598 'duration duration
6599 'effort effort
6600 'effort-minutes neffort
6601 'breadcrumbs breadcrumbs
6602 'txt txt
6603 'level level
6604 'time time
6605 'extra extra
6606 'format org-prefix-format-compiled
6607 'dotime dotime)))))
6609 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6610 "Remove tags string from TXT, and add a modified list of tags.
6611 The modified list may contain inherited tags, and tags matched by
6612 `org-agenda-hide-tags-regexp' will be removed."
6613 (when (or add-inherited hide-re)
6614 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6615 (setq txt (substring txt 0 (match-beginning 0))))
6616 (setq tags
6617 (delq nil
6618 (mapcar (lambda (tg)
6619 (if (or (and hide-re (string-match hide-re tg))
6620 (and (not add-inherited)
6621 (get-text-property 0 'inherited tg)))
6623 tg))
6624 tags)))
6625 (when tags
6626 (let ((have-i (get-text-property 0 'inherited (car tags)))
6628 (setq txt (concat txt " :"
6629 (mapconcat
6630 (lambda (x)
6631 (setq i (get-text-property 0 'inherited x))
6632 (if (and have-i (not i))
6633 (progn
6634 (setq have-i nil)
6635 (concat ":" x))
6637 tags ":")
6638 (if have-i "::" ":"))))))
6639 txt)
6641 (defun org-downcase-keep-props (s)
6642 (let ((props (text-properties-at 0 s)))
6643 (setq s (downcase s))
6644 (add-text-properties 0 (length s) props s)
6647 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6649 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6650 "Add a time-grid for agenda items which need it.
6652 LIST is the list of agenda items formatted by `org-agenda-list'.
6653 NDAYS is the span of the current agenda view.
6654 TODAYP is `t' when the current agenda view is on today."
6655 (catch 'exit
6656 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6657 ((and todayp (member 'today (car org-agenda-time-grid))))
6658 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6659 ((member 'weekly (car org-agenda-time-grid)))
6660 (t (throw 'exit list)))
6661 (let* ((have (delq nil (mapcar
6662 (lambda (x) (get-text-property 1 'time-of-day x))
6663 list)))
6664 (string (nth 1 org-agenda-time-grid))
6665 (gridtimes (nth 2 org-agenda-time-grid))
6666 (req (car org-agenda-time-grid))
6667 (remove (member 'remove-match req))
6668 new time)
6669 (if (and (member 'require-timed req) (not have))
6670 ;; don't show empty grid
6671 (throw 'exit list))
6672 (while (setq time (pop gridtimes))
6673 (unless (and remove (member time have))
6674 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6675 (push (org-agenda-format-item
6676 nil string nil "" nil
6677 (concat (substring time 0 -2) ":" (substring time -2)))
6678 new)
6679 (put-text-property
6680 2 (length (car new)) 'face 'org-time-grid (car new))))
6681 (when (and todayp org-agenda-show-current-time-in-grid)
6682 (push (org-agenda-format-item
6683 nil org-agenda-current-time-string nil "" nil
6684 (format-time-string "%H:%M "))
6685 new)
6686 (put-text-property
6687 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6689 (if (member 'time-up org-agenda-sorting-strategy-selected)
6690 (append new list)
6691 (append list new)))))
6693 (defun org-compile-prefix-format (key)
6694 "Compile the prefix format into a Lisp form that can be evaluated.
6695 The resulting form and associated variable bindings is returned
6696 and stored in the variable `org-prefix-format-compiled'."
6697 (setq org-prefix-has-time nil
6698 org-prefix-has-tag nil
6699 org-prefix-category-length nil
6700 org-prefix-has-effort nil
6701 org-prefix-has-breadcrumbs nil)
6702 (let ((s (cond
6703 ((stringp org-agenda-prefix-format)
6704 org-agenda-prefix-format)
6705 ((assq key org-agenda-prefix-format)
6706 (cdr (assq key org-agenda-prefix-format)))
6707 (t " %-12:c%?-12t% s")))
6708 (start 0)
6709 varform vars var e c f opt)
6710 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6711 s start)
6712 (setq var (or (cdr (assoc (match-string 4 s)
6713 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6714 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6715 'eval)
6716 c (or (match-string 3 s) "")
6717 opt (match-beginning 1)
6718 start (1+ (match-beginning 0)))
6719 (if (equal var 'time) (setq org-prefix-has-time t))
6720 (if (equal var 'tag) (setq org-prefix-has-tag t))
6721 (if (equal var 'effort) (setq org-prefix-has-effort t))
6722 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6723 (setq f (concat "%" (match-string 2 s) "s"))
6724 (when (equal var 'category)
6725 (setq org-prefix-category-length
6726 (floor (abs (string-to-number (match-string 2 s)))))
6727 (setq org-prefix-category-max-length
6728 (let ((x (match-string 2 s)))
6729 (save-match-data
6730 (if (string-match "\\.[0-9]+" x)
6731 (string-to-number (substring (match-string 0 x) 1)))))))
6732 (if (eq var 'eval)
6733 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6734 (if opt
6735 (setq varform
6736 `(if (equal "" ,var)
6738 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6739 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6740 (setq s (replace-match "%s" t nil s))
6741 (push varform vars))
6742 (setq vars (nreverse vars))
6743 (with-current-buffer (or org-agenda-buffer (current-buffer))
6744 (setq org-prefix-format-compiled
6745 (list
6746 `((org-prefix-has-time ,org-prefix-has-time)
6747 (org-prefix-has-tag ,org-prefix-has-tag)
6748 (org-prefix-category-length ,org-prefix-category-length)
6749 (org-prefix-has-effort ,org-prefix-has-effort)
6750 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6751 `(format ,s ,@vars))))))
6753 (defun org-set-sorting-strategy (key)
6754 (if (symbolp (car org-agenda-sorting-strategy))
6755 ;; the old format
6756 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6757 (setq org-agenda-sorting-strategy-selected
6758 (or (cdr (assq key org-agenda-sorting-strategy))
6759 (cdr (assq 'agenda org-agenda-sorting-strategy))
6760 '(time-up category-keep priority-down)))))
6762 (defun org-get-time-of-day (s &optional string mod24)
6763 "Check string S for a time of day.
6764 If found, return it as a military time number between 0 and 2400.
6765 If not found, return nil.
6766 The optional STRING argument forces conversion into a 5 character wide string
6767 HH:MM."
6768 (save-match-data
6769 (when
6770 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6771 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6772 (let* ((h (string-to-number (match-string 1 s)))
6773 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6774 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6775 (am-p (equal ampm "am"))
6776 (h1 (cond ((not ampm) h)
6777 ((= h 12) (if am-p 0 12))
6778 (t (+ h (if am-p 0 12)))))
6779 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6780 (mod h1 24) h1))
6781 (t0 (+ (* 100 h2) m))
6782 (t1 (concat (if (>= h1 24) "+" " ")
6783 (if (and org-agenda-time-leading-zero
6784 (< t0 1000)) "0" "")
6785 (if (< t0 100) "0" "")
6786 (if (< t0 10) "0" "")
6787 (int-to-string t0))))
6788 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6790 (defvar org-agenda-before-sorting-filter-function nil
6791 "Function to be applied to agenda items prior to sorting.
6792 Prior to sorting also means just before they are inserted into the agenda.
6794 To aid sorting, you may revisit the original entries and add more text
6795 properties which will later be used by the sorting functions.
6797 The function should take a string argument, an agenda line.
6798 It has access to the text properties in that line, which contain among
6799 other things, the property `org-hd-marker' that points to the entry
6800 where the line comes from. Note that not all lines going into the agenda
6801 have this property, only most.
6803 The function should return the modified string. It is probably best
6804 to ONLY change text properties.
6806 You can also use this function as a filter, by returning nil for lines
6807 you don't want to have in the agenda at all. For this application, you
6808 could bind the variable in the options section of a custom command.")
6810 (defun org-agenda-finalize-entries (list &optional type)
6811 "Sort, limit and concatenate the LIST of agenda items.
6812 The optional argument TYPE tells the agenda type."
6813 (let ((max-effort (cond ((listp org-agenda-max-effort)
6814 (cdr (assoc type org-agenda-max-effort)))
6815 (t org-agenda-max-effort)))
6816 (max-todo (cond ((listp org-agenda-max-todos)
6817 (cdr (assoc type org-agenda-max-todos)))
6818 (t org-agenda-max-todos)))
6819 (max-tags (cond ((listp org-agenda-max-tags)
6820 (cdr (assoc type org-agenda-max-tags)))
6821 (t org-agenda-max-tags)))
6822 (max-entries (cond ((listp org-agenda-max-entries)
6823 (cdr (assoc type org-agenda-max-entries)))
6824 (t org-agenda-max-entries))) l)
6825 (when org-agenda-before-sorting-filter-function
6826 (setq list
6827 (delq nil
6828 (mapcar
6829 org-agenda-before-sorting-filter-function list))))
6830 (setq list (mapcar 'org-agenda-highlight-todo list)
6831 list (mapcar 'identity (sort list 'org-entries-lessp)))
6832 (when max-effort
6833 (setq list (org-agenda-limit-entries
6834 list 'effort-minutes max-effort 'identity)))
6835 (when max-todo
6836 (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
6837 (when max-tags
6838 (setq list (org-agenda-limit-entries list 'tags max-tags)))
6839 (when max-entries
6840 (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
6841 (mapconcat 'identity list "\n")))
6843 (defun org-agenda-limit-entries (list prop limit &optional fn)
6844 "Limit the number of agenda entries."
6845 (let ((include (and limit (< limit 0))))
6846 (if limit
6847 (let ((fun (or fn (lambda (p) (if p 1))))
6848 (lim 0))
6849 (delq nil
6850 (mapcar
6851 (lambda (e)
6852 (let ((pval (funcall fun (get-text-property 1 prop e))))
6853 (if pval (setq lim (+ lim pval)))
6854 (cond ((and pval (<= lim (abs limit))) e)
6855 ((and include (not pval)) e))))
6856 list)))
6857 list)))
6859 (defun org-agenda-limit-interactively ()
6860 "In agenda, interactively limit entries to various maximums."
6861 (interactive)
6862 (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
6863 (num (string-to-number (read-from-minibuffer "How many? "))))
6864 (cond ((equal max ?e)
6865 (let ((org-agenda-max-entries num)) (org-agenda-redo)))
6866 ((equal max ?t)
6867 (let ((org-agenda-max-todos num)) (org-agenda-redo)))
6868 ((equal max ?T)
6869 (let ((org-agenda-max-tags num)) (org-agenda-redo)))
6870 ((equal max ?E)
6871 (let ((org-agenda-max-effort num)) (org-agenda-redo)))))
6872 (org-agenda-fit-window-to-buffer))
6874 (defun org-agenda-highlight-todo (x)
6875 (let ((org-done-keywords org-done-keywords-for-agenda)
6876 (case-fold-search nil)
6878 (if (eq x 'line)
6879 (save-excursion
6880 (beginning-of-line 1)
6881 (setq re (org-get-at-bol 'org-todo-regexp))
6882 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6883 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6884 (add-text-properties (match-beginning 0) (match-end 1)
6885 (list 'face (org-get-todo-face 1)))
6886 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6887 (delete-region (match-beginning 1) (1- (match-end 0)))
6888 (goto-char (match-beginning 1))
6889 (insert (format org-agenda-todo-keyword-format s)))))
6890 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6891 (setq re (get-text-property 0 'org-todo-regexp x))
6892 (when (and re
6893 ;; Test `pl' because if there's no heading content,
6894 ;; there's no point matching to highlight. Note
6895 ;; that if we didn't test `pl' first, and there
6896 ;; happened to be no keyword from `org-todo-regexp'
6897 ;; on this heading line, then the `equal' comparison
6898 ;; afterwards would spuriously succeed in the case
6899 ;; where `pl' is nil -- causing an args-out-of-range
6900 ;; error when we try to add text properties to text
6901 ;; that isn't there.
6903 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6904 x pl) pl))
6905 (add-text-properties
6906 (or (match-end 1) (match-end 0)) (match-end 0)
6907 (list 'face (org-get-todo-face (match-string 2 x)))
6909 (when (match-end 1)
6910 (setq x (concat (substring x 0 (match-end 1))
6911 (format org-agenda-todo-keyword-format
6912 (match-string 2 x))
6913 (org-add-props " " (text-properties-at 0 x))
6914 (substring x (match-end 3)))))))
6915 x)))
6917 (defsubst org-cmp-priority (a b)
6918 "Compare the priorities of string A and B."
6919 (let ((pa (or (get-text-property 1 'priority a) 0))
6920 (pb (or (get-text-property 1 'priority b) 0)))
6921 (cond ((> pa pb) +1)
6922 ((< pa pb) -1))))
6924 (defsubst org-cmp-effort (a b)
6925 "Compare the effort values of string A and B."
6926 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6927 (ea (or (get-text-property 1 'effort-minutes a) def))
6928 (eb (or (get-text-property 1 'effort-minutes b) def)))
6929 (cond ((> ea eb) +1)
6930 ((< ea eb) -1))))
6932 (defsubst org-cmp-category (a b)
6933 "Compare the string values of categories of strings A and B."
6934 (let ((ca (or (get-text-property 1 'org-category a) ""))
6935 (cb (or (get-text-property 1 'org-category b) "")))
6936 (cond ((string-lessp ca cb) -1)
6937 ((string-lessp cb ca) +1))))
6939 (defsubst org-cmp-todo-state (a b)
6940 "Compare the todo states of strings A and B."
6941 (let* ((ma (or (get-text-property 1 'org-marker a)
6942 (get-text-property 1 'org-hd-marker a)))
6943 (mb (or (get-text-property 1 'org-marker b)
6944 (get-text-property 1 'org-hd-marker b)))
6945 (fa (and ma (marker-buffer ma)))
6946 (fb (and mb (marker-buffer mb)))
6947 (todo-kwds
6948 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6949 (and fb (with-current-buffer fb org-todo-keywords-1))))
6950 (ta (or (get-text-property 1 'todo-state a) ""))
6951 (tb (or (get-text-property 1 'todo-state b) ""))
6952 (la (- (length (member ta todo-kwds))))
6953 (lb (- (length (member tb todo-kwds))))
6954 (donepa (member ta org-done-keywords-for-agenda))
6955 (donepb (member tb org-done-keywords-for-agenda)))
6956 (cond ((and donepa (not donepb)) -1)
6957 ((and (not donepa) donepb) +1)
6958 ((< la lb) -1)
6959 ((< lb la) +1))))
6961 (defsubst org-cmp-alpha (a b)
6962 "Compare the headlines, alphabetically."
6963 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6964 (plb (text-property-any 0 (length b) 'org-heading t b))
6965 (ta (and pla (substring a pla)))
6966 (tb (and plb (substring b plb))))
6967 (when pla
6968 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6969 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6970 (setq ta (substring ta (match-end 0))))
6971 (setq ta (downcase ta)))
6972 (when plb
6973 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6974 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6975 (setq tb (substring tb (match-end 0))))
6976 (setq tb (downcase tb)))
6977 (cond ((not ta) +1)
6978 ((not tb) -1)
6979 ((string-lessp ta tb) -1)
6980 ((string-lessp tb ta) +1))))
6982 (defsubst org-cmp-tag (a b)
6983 "Compare the string values of the first tags of A and B."
6984 (let ((ta (car (last (get-text-property 1 'tags a))))
6985 (tb (car (last (get-text-property 1 'tags b)))))
6986 (cond ((not ta) +1)
6987 ((not tb) -1)
6988 ((string-lessp ta tb) -1)
6989 ((string-lessp tb ta) +1))))
6991 (defsubst org-cmp-time (a b)
6992 "Compare the time-of-day values of strings A and B."
6993 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6994 (ta (or (get-text-property 1 'time-of-day a) def))
6995 (tb (or (get-text-property 1 'time-of-day b) def)))
6996 (cond ((< ta tb) -1)
6997 ((< tb ta) +1))))
6999 (defsubst org-cmp-ts (a b &optional type)
7000 "Compare the timestamps values of entries A and B.
7001 When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
7002 \"timestamp_ia\", compare within each of these type. When TYPE
7003 is the empty string, compare all timestamps without respect of
7004 their type."
7005 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
7006 (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
7007 (get-text-property 1 'ts-date a)) def))
7008 (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
7009 (get-text-property 1 'ts-date b)) def)))
7010 (cond ((< ta tb) -1)
7011 ((< tb ta) +1))))
7013 (defsubst org-cmp-habit-p (a b)
7014 "Compare the todo states of strings A and B."
7015 (let ((ha (get-text-property 1 'org-habit-p a))
7016 (hb (get-text-property 1 'org-habit-p b)))
7017 (cond ((and ha (not hb)) -1)
7018 ((and (not ha) hb) +1))))
7020 (defun org-entries-lessp (a b)
7021 "Predicate for sorting agenda entries."
7022 ;; The following variables will be used when the form is evaluated.
7023 ;; So even though the compiler complains, keep them.
7024 (let* ((ss org-agenda-sorting-strategy-selected)
7025 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
7026 (org-cmp-ts a b "")))
7027 (timestamp-down (if timestamp-up (- timestamp-up) nil))
7028 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
7029 (org-cmp-ts a b "scheduled")))
7030 (scheduled-down (if scheduled-up (- scheduled-up) nil))
7031 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
7032 (org-cmp-ts a b "deadline")))
7033 (deadline-down (if deadline-up (- deadline-up) nil))
7034 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
7035 (org-cmp-ts a b "iatimestamp_ia")))
7036 (tsia-down (if tsia-up (- tsia-up) nil))
7037 (ts-up (and (org-em 'ts-up 'ts-down ss)
7038 (org-cmp-ts a b "timestamp")))
7039 (ts-down (if ts-up (- ts-up) nil))
7040 (time-up (and (org-em 'time-up 'time-down ss)
7041 (org-cmp-time a b)))
7042 (time-down (if time-up (- time-up) nil))
7043 (priority-up (and (org-em 'priority-up 'priority-down ss)
7044 (org-cmp-priority a b)))
7045 (priority-down (if priority-up (- priority-up) nil))
7046 (effort-up (and (org-em 'effort-up 'effort-down ss)
7047 (org-cmp-effort a b)))
7048 (effort-down (if effort-up (- effort-up) nil))
7049 (category-up (and (or (org-em 'category-up 'category-down ss)
7050 (memq 'category-keep ss))
7051 (org-cmp-category a b)))
7052 (category-down (if category-up (- category-up) nil))
7053 (category-keep (if category-up +1 nil))
7054 (tag-up (and (org-em 'tag-up 'tag-down ss)
7055 (org-cmp-tag a b)))
7056 (tag-down (if tag-up (- tag-up) nil))
7057 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
7058 (org-cmp-todo-state a b)))
7059 (todo-state-down (if todo-state-up (- todo-state-up) nil))
7060 (habit-up (and (org-em 'habit-up 'habit-down ss)
7061 (org-cmp-habit-p a b)))
7062 (habit-down (if habit-up (- habit-up) nil))
7063 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
7064 (org-cmp-alpha a b)))
7065 (alpha-down (if alpha-up (- alpha-up) nil))
7066 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
7067 user-defined-up user-defined-down)
7068 (if (and need-user-cmp org-agenda-cmp-user-defined
7069 (functionp org-agenda-cmp-user-defined))
7070 (setq user-defined-up
7071 (funcall org-agenda-cmp-user-defined a b)
7072 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7073 (cdr (assoc
7074 (eval (cons 'or org-agenda-sorting-strategy-selected))
7075 '((-1 . t) (1 . nil) (nil . nil))))))
7077 ;;; Agenda restriction lock
7079 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7080 "Overlay to mark the headline to which agenda commands are restricted.")
7081 (overlay-put org-agenda-restriction-lock-overlay
7082 'face 'org-agenda-restriction-lock)
7083 (overlay-put org-agenda-restriction-lock-overlay
7084 'help-echo "Agendas are currently limited to this subtree.")
7085 (org-detach-overlay org-agenda-restriction-lock-overlay)
7087 ;;;###autoload
7088 (defun org-agenda-set-restriction-lock (&optional type)
7089 "Set restriction lock for agenda, to current subtree or file.
7090 Restriction will be the file if TYPE is `file', or if type is the
7091 universal prefix '(4), or if the cursor is before the first headline
7092 in the file. Otherwise, restriction will be to the current subtree."
7093 (interactive "P")
7094 (and (equal type '(4)) (setq type 'file))
7095 (setq type (cond
7096 (type type)
7097 ((org-at-heading-p) 'subtree)
7098 ((condition-case nil (org-back-to-heading t) (error nil))
7099 'subtree)
7100 (t 'file)))
7101 (if (eq type 'subtree)
7102 (progn
7103 (setq org-agenda-restrict (current-buffer))
7104 (setq org-agenda-overriding-restriction 'subtree)
7105 (put 'org-agenda-files 'org-restrict
7106 (list (buffer-file-name (buffer-base-buffer))))
7107 (org-back-to-heading t)
7108 (move-overlay org-agenda-restriction-lock-overlay
7109 (point)
7110 (if org-agenda-restriction-lock-highlight-subtree
7111 (save-excursion (org-end-of-subtree t t) (point))
7112 (point-at-eol)))
7113 (move-marker org-agenda-restrict-begin (point))
7114 (move-marker org-agenda-restrict-end
7115 (save-excursion (org-end-of-subtree t t)))
7116 (message "Locking agenda restriction to subtree"))
7117 (put 'org-agenda-files 'org-restrict
7118 (list (buffer-file-name (buffer-base-buffer))))
7119 (setq org-agenda-restrict nil)
7120 (setq org-agenda-overriding-restriction 'file)
7121 (move-marker org-agenda-restrict-begin nil)
7122 (move-marker org-agenda-restrict-end nil)
7123 (message "Locking agenda restriction to file"))
7124 (setq current-prefix-arg nil)
7125 (org-agenda-maybe-redo))
7127 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7128 "Remove the agenda restriction lock."
7129 (interactive "P")
7130 (org-detach-overlay org-agenda-restriction-lock-overlay)
7131 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7132 (setq org-agenda-overriding-restriction nil)
7133 (setq org-agenda-restrict nil)
7134 (put 'org-agenda-files 'org-restrict nil)
7135 (move-marker org-agenda-restrict-begin nil)
7136 (move-marker org-agenda-restrict-end nil)
7137 (setq current-prefix-arg nil)
7138 (message "Agenda restriction lock removed")
7139 (or noupdate (org-agenda-maybe-redo)))
7141 (defun org-agenda-maybe-redo ()
7142 "If there is any window showing the agenda view, update it."
7143 (let ((w (get-buffer-window org-agenda-buffer-name t))
7144 (w0 (selected-window)))
7145 (when w
7146 (select-window w)
7147 (org-agenda-redo)
7148 (select-window w0)
7149 (if org-agenda-overriding-restriction
7150 (message "Agenda view shifted to new %s restriction"
7151 org-agenda-overriding-restriction)
7152 (message "Agenda restriction lock removed")))))
7154 ;;; Agenda commands
7156 (defun org-agenda-check-type (error &rest types)
7157 "Check if agenda buffer is of allowed type.
7158 If ERROR is non-nil, throw an error, otherwise just return nil.
7159 Allowed types are 'agenda 'timeline 'todo 'tags 'search."
7160 (if (not org-agenda-type)
7161 (error "No Org agenda currently displayed")
7162 (if (memq org-agenda-type types)
7164 (if error
7165 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7166 nil))))
7168 (defun org-agenda-Quit ()
7169 "Exit the agenda and kill buffers loaded by `org-agenda'.
7170 Also restore the window configuration."
7171 (interactive)
7172 (if org-agenda-columns-active
7173 (org-columns-quit)
7174 (let ((buf (current-buffer)))
7175 (if (eq org-agenda-window-setup 'other-frame)
7176 (progn
7177 (org-agenda-reset-markers)
7178 (kill-buffer buf)
7179 (org-columns-remove-overlays)
7180 (setq org-agenda-archives-mode nil)
7181 (delete-frame))
7182 (and (not (eq org-agenda-window-setup 'current-window))
7183 (not (one-window-p))
7184 (delete-window))
7185 (org-agenda-reset-markers)
7186 (kill-buffer buf)
7187 (org-columns-remove-overlays)
7188 (setq org-agenda-archives-mode nil)))
7189 (setq org-agenda-buffer nil)
7190 ;; Maybe restore the pre-agenda window configuration.
7191 (and org-agenda-restore-windows-after-quit
7192 (not (eq org-agenda-window-setup 'other-frame))
7193 org-agenda-pre-window-conf
7194 (set-window-configuration org-agenda-pre-window-conf)
7195 (setq org-agenda-pre-window-conf nil))))
7197 (defun org-agenda-quit ()
7198 "Exit the agenda and restore the window configuration.
7199 When `org-agenda-sticky' is non-nil, only bury the agenda."
7200 (interactive)
7201 (if (and (eq org-indirect-buffer-display 'other-window)
7202 org-last-indirect-buffer)
7203 (let ((org-last-indirect-window
7204 (get-buffer-window org-last-indirect-buffer)))
7205 (if org-last-indirect-window
7206 (delete-window org-last-indirect-window))))
7207 (if org-agenda-columns-active
7208 (org-columns-quit)
7209 (if org-agenda-sticky
7210 (let ((buf (current-buffer)))
7211 (if (eq org-agenda-window-setup 'other-frame)
7212 (progn
7213 (delete-frame))
7214 (and (not (eq org-agenda-window-setup 'current-window))
7215 (not (one-window-p))
7216 (delete-window)))
7217 (with-current-buffer buf
7218 (bury-buffer)
7219 ;; Maybe restore the pre-agenda window configuration.
7220 (and org-agenda-restore-windows-after-quit
7221 (not (eq org-agenda-window-setup 'other-frame))
7222 org-agenda-pre-window-conf
7223 (set-window-configuration org-agenda-pre-window-conf)
7224 (setq org-agenda-pre-window-conf nil))))
7225 (org-agenda-Quit))))
7227 (defun org-agenda-exit ()
7228 "Exit the agenda and restore the window configuration.
7229 Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
7230 buffers visited directly by the user will not be touched."
7231 (interactive)
7232 (org-release-buffers org-agenda-new-buffers)
7233 (setq org-agenda-new-buffers nil)
7234 (org-agenda-Quit))
7236 (defun org-agenda-kill-all-agenda-buffers ()
7237 "Kill all buffers in `org-agenda-mode'.
7238 This is used when toggling sticky agendas.
7239 You can also explicitly invoke it with `C-c a C-k'."
7240 (interactive)
7241 (let (blist)
7242 (dolist (buf (buffer-list))
7243 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7244 (push buf blist)))
7245 (mapc 'kill-buffer blist)))
7247 (defun org-agenda-execute (arg)
7248 "Execute another agenda command, keeping same window.
7249 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7250 in the agenda."
7251 (interactive "P")
7252 (let ((org-agenda-window-setup 'current-window))
7253 (org-agenda arg)))
7255 (defun org-agenda-redo (&optional all)
7256 "Rebuild possibly ALL agenda view(s) in the current buffer."
7257 (interactive "P")
7258 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7259 (cpa (unless (eq all t) current-prefix-arg))
7260 (org-agenda-doing-sticky-redo org-agenda-sticky)
7261 (org-agenda-sticky nil)
7262 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7263 org-agenda-buffer-name))
7264 (org-agenda-keep-modes t)
7265 (tag-filter org-agenda-tag-filter)
7266 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7267 (top-hl-filter org-agenda-top-headline-filter)
7268 (cat-filter org-agenda-category-filter)
7269 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7270 (re-filter org-agenda-regexp-filter)
7271 (re-preset (get 'org-agenda-regexp-filter :preset-filter))
7272 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
7273 (cols org-agenda-columns-active)
7274 (line (org-current-line))
7275 (window-line (- line (org-current-line (window-start))))
7276 (lprops (get 'org-agenda-redo-command 'org-lprops))
7277 (redo-cmd (get-text-property p 'org-redo-cmd))
7278 (last-args (get-text-property p 'org-last-args))
7279 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7280 (org-agenda-overriding-cmd-arguments
7281 (unless (eq all t)
7282 (cond ((listp last-args)
7283 (cons (or cpa (car last-args)) (cdr last-args)))
7284 ((stringp last-args)
7285 last-args))))
7286 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7287 (put 'org-agenda-tag-filter :preset-filter nil)
7288 (put 'org-agenda-category-filter :preset-filter nil)
7289 (put 'org-agenda-regexp-filter :preset-filter nil)
7290 (and cols (org-columns-quit))
7291 (message "Rebuilding agenda buffer...")
7292 (if series-redo-cmd
7293 (eval series-redo-cmd)
7294 (org-let lprops redo-cmd))
7295 (setq org-agenda-undo-list nil
7296 org-agenda-pending-undo-list nil
7297 org-agenda-tag-filter tag-filter
7298 org-agenda-category-filter cat-filter
7299 org-agenda-regexp-filter re-filter
7300 org-agenda-top-headline-filter top-hl-filter)
7301 (message "Rebuilding agenda buffer...done")
7302 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7303 (put 'org-agenda-category-filter :preset-filter cat-preset)
7304 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7305 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
7306 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
7307 (and (or re-filter re-preset) (org-agenda-filter-apply re-filter '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 ((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-cat))
7355 (let ((cat (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
7356 (if cat (org-agenda-filter-top-headline-apply cat strip)
7357 (error "No top-level category 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)))
7388 (defun org-agenda-filter-by-tag (strip &optional char narrow)
7389 "Keep only those lines in the agenda buffer that have a specific tag.
7390 The tag is selected with its fast selection letter, as configured.
7391 With prefix argument STRIP, remove all lines that do have the tag.
7392 A lisp caller can specify CHAR. NARROW means that the new tag should be
7393 used to narrow the search - the interactive user can also press `-' or `+'
7394 to switch to narrowing."
7395 (interactive "P")
7396 (let* ((alist org-tag-alist-for-agenda)
7397 (tag-chars (mapconcat
7398 (lambda (x) (if (and (not (symbolp (car x)))
7399 (cdr x))
7400 (char-to-string (cdr x))
7401 ""))
7402 alist ""))
7403 (efforts (org-split-string
7404 (or (cdr (assoc (concat org-effort-property "_ALL")
7405 org-global-properties))
7406 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7407 "")))
7408 (effort-op org-agenda-filter-effort-default-operator)
7409 (effort-prompt "")
7410 (inhibit-read-only t)
7411 (current org-agenda-tag-filter)
7412 maybe-refresh a n tag)
7413 (unless char
7414 (message
7415 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
7416 (if narrow "Narrow" "Filter") tag-chars
7417 (if org-agenda-auto-exclude-function "[RET], " ""))
7418 (setq char (read-char-exclusive)))
7419 (when (member char '(?+ ?-))
7420 ;; Narrowing down
7421 (cond ((equal char ?-) (setq strip t narrow t))
7422 ((equal char ?+) (setq strip nil narrow t)))
7423 (message
7424 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
7425 (setq char (read-char-exclusive)))
7426 (when (member char '(?< ?> ?= ??))
7427 ;; An effort operator
7428 (setq effort-op (char-to-string char))
7429 (setq alist nil) ; to make sure it will be interpreted as effort.
7430 (unless (equal char ??)
7431 (loop for i from 0 to 9 do
7432 (setq effort-prompt
7433 (concat
7434 effort-prompt " ["
7435 (if (= i 9) "0" (int-to-string (1+ i)))
7436 "]" (nth i efforts))))
7437 (message "Effort%s: %s " effort-op effort-prompt)
7438 (setq char (read-char-exclusive))
7439 (when (or (< char ?0) (> char ?9))
7440 (error "Need 1-9,0 to select effort"))))
7441 (when (equal char ?\t)
7442 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7443 (org-set-local 'org-global-tags-completion-table
7444 (org-global-tags-completion-table)))
7445 (let ((completion-ignore-case t))
7446 (setq tag (org-icompleting-read
7447 "Tag: " org-global-tags-completion-table))))
7448 (cond
7449 ((equal char ?\r)
7450 (org-agenda-filter-show-all-tag)
7451 (when org-agenda-auto-exclude-function
7452 (setq org-agenda-tag-filter nil)
7453 (dolist (tag (org-agenda-get-represented-tags))
7454 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7455 (if modifier
7456 (push modifier org-agenda-tag-filter))))
7457 (if (not (null org-agenda-tag-filter))
7458 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
7459 (setq maybe-refresh t))
7460 ((equal char ?/)
7461 (org-agenda-filter-show-all-tag)
7462 (when (get 'org-agenda-tag-filter :preset-filter)
7463 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7464 (setq maybe-refresh t))
7465 ((equal char ?. )
7466 (setq org-agenda-tag-filter
7467 (mapcar (lambda(tag) (concat "+" tag))
7468 (org-get-at-bol 'tags)))
7469 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7470 (setq maybe-refresh t))
7471 ((or (equal char ?\ )
7472 (setq a (rassoc char alist))
7473 (and (>= char ?0) (<= char ?9)
7474 (setq n (if (= char ?0) 9 (- char ?0 1))
7475 tag (concat effort-op (nth n efforts))
7476 a (cons tag nil)))
7477 (and (= char ??)
7478 (setq tag "?eff")
7479 a (cons tag nil))
7480 (and tag (setq a (cons tag nil))))
7481 (org-agenda-filter-show-all-tag)
7482 (setq tag (car a))
7483 (setq org-agenda-tag-filter
7484 (cons (concat (if strip "-" "+") tag)
7485 (if narrow current nil)))
7486 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7487 (setq maybe-refresh t))
7488 (t (error "Invalid tag selection character %c" char)))
7489 (when (and maybe-refresh
7490 (eq org-agenda-clockreport-mode 'with-filter))
7491 (org-agenda-redo))))
7493 (defun org-agenda-get-represented-tags ()
7494 "Get a list of all tags currently represented in the agenda."
7495 (let (p tags)
7496 (save-excursion
7497 (goto-char (point-min))
7498 (while (setq p (next-single-property-change (point) 'tags))
7499 (goto-char p)
7500 (mapc (lambda (x) (add-to-list 'tags x))
7501 (get-text-property (point) 'tags))))
7502 tags))
7504 (defun org-agenda-filter-by-tag-refine (strip &optional char)
7505 "Refine the current filter. See `org-agenda-filter-by-tag'."
7506 (interactive "P")
7507 (org-agenda-filter-by-tag strip char 'refine))
7509 (defun org-agenda-filter-make-matcher (filter type)
7510 "Create the form that tests a line for agenda filter."
7511 (let (f f1)
7512 (cond
7513 ;; Tag filter
7514 ((eq type 'tag)
7515 (setq filter
7516 (delete-dups
7517 (append (get 'org-agenda-tag-filter :preset-filter)
7518 filter)))
7519 (dolist (x filter)
7520 (let ((nfilter (org-agenda-filter-expand-tags filter)) nf nf1
7521 (ffunc
7522 (lambda (nf0 nf01 fltr notgroup op)
7523 (dolist (x fltr)
7524 (if (member x '("-" "+"))
7525 (setq nf01 (if (equal x "-") 'tags '(not tags)))
7526 (if (string-match "[<=>?]" x)
7527 (setq nf01 (org-agenda-filter-effort-form x))
7528 (setq nf01 (list 'member (downcase (substring x 1))
7529 'tags)))
7530 (when (equal (string-to-char x) ?-)
7531 (setq nf01 (list 'not nf01))
7532 (when (not notgroup) (setq op 'and))))
7533 (push nf01 nf0))
7534 (if notgroup
7535 (push (cons 'and nf0) f)
7536 (push (cons (or op 'or) nf0) f)))))
7537 (cond ((equal filter '("+"))
7538 (setq f (list (list 'not 'tags))))
7539 ((equal nfilter filter)
7540 (funcall ffunc f1 f filter t nil))
7541 (t (funcall ffunc nf1 nf nfilter nil nil))))))
7542 ;; Category filter
7543 ((eq type 'category)
7544 (setq filter
7545 (delete-dups
7546 (append (get 'org-agenda-category-filter :preset-filter)
7547 filter)))
7548 (dolist (x filter)
7549 (if (equal "-" (substring x 0 1))
7550 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7551 (setq f1 (list 'equal (substring x 1) 'cat)))
7552 (push f1 f)))
7553 ;; Regexp filter
7554 ((eq type 'regexp)
7555 (setq filter
7556 (delete-dups
7557 (append (get 'org-agenda-regexp-filter :preset-filter)
7558 filter)))
7559 (dolist (x filter)
7560 (if (equal "-" (substring x 0 1))
7561 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7562 (setq f1 (list 'string-match (substring x 1) 'txt)))
7563 (push f1 f))))
7564 (cons 'and (nreverse f))))
7566 (defun org-agenda-filter-effort-form (e)
7567 "Return the form to compare the effort of the current line with what E says.
7568 E looks like \"+<2:25\"."
7569 (let (op)
7570 (setq e (substring e 1))
7571 (setq op (string-to-char e) e (substring e 1))
7572 (setq op (cond ((equal op ?<) '<=)
7573 ((equal op ?>) '>=)
7574 ((equal op ??) op)
7575 (t '=)))
7576 (list 'org-agenda-compare-effort (list 'quote op)
7577 (org-duration-string-to-minutes e))))
7579 (defun org-agenda-compare-effort (op value)
7580 "Compare the effort of the current line with VALUE, using OP.
7581 If the line does not have an effort defined, return nil."
7582 (let ((eff (org-get-at-bol 'effort-minutes)))
7583 (if (equal op ??)
7584 (not eff)
7585 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
7586 value))))
7588 (defun org-agenda-filter-expand-tags (filter &optional no-operator)
7589 "Expand group tags in FILTER for the agenda.
7590 When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
7591 (if org-group-tags
7592 (let ((case-fold-search t) rtn)
7593 (mapc
7594 (lambda (f)
7595 (let (f0 dir)
7596 (if (string-match "^\\([+-]\\)\\(.+\\)" f)
7597 (setq dir (match-string 1 f) f0 (match-string 2 f))
7598 (setq dir (if no-operator "" "+") f0 f))
7599 (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
7600 (org-tags-expand f0 t t))
7601 rtn))))
7602 filter)
7603 (reverse rtn))
7604 filter))
7606 (defun org-agenda-filter-apply (filter type)
7607 "Set FILTER as the new agenda filter and apply it."
7608 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7609 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7610 (let (tags cat txt)
7611 (setq org-agenda-filter-form
7612 (org-agenda-filter-make-matcher filter type))
7613 (if (and (eq type 'category)
7614 (not (equal (substring (car filter) 0 1) "-")))
7615 ;; Only set `org-agenda-filtered-by-category' to t
7616 ;; when a unique category is used as the filter
7617 (setq org-agenda-filtered-by-category t))
7618 (org-agenda-set-mode-name)
7619 (save-excursion
7620 (goto-char (point-min))
7621 (while (not (eobp))
7622 (if (org-get-at-bol 'org-marker)
7623 (progn
7624 (setq tags ; used in eval
7625 (apply 'append
7626 (mapcar (lambda (f)
7627 (org-agenda-filter-expand-tags (list f) t))
7628 (org-get-at-bol 'tags)))
7629 cat (get-text-property (point) 'org-category)
7630 txt (get-text-property (point) 'txt))
7631 (if (not (eval org-agenda-filter-form))
7632 (org-agenda-filter-hide-line type))
7633 (beginning-of-line 2))
7634 (beginning-of-line 2))))
7635 (if (get-char-property (point) 'invisible)
7636 (ignore-errors (org-agenda-previous-line)))))
7638 (defun org-agenda-filter-top-headline-apply (hl &optional negative)
7639 "Filter by top headline HL."
7640 (org-agenda-set-mode-name)
7641 (save-excursion
7642 (goto-char (point-min))
7643 (while (not (eobp))
7644 (let* ((pos (org-get-at-bol 'org-hd-marker))
7645 (tophl (and pos (org-find-top-headline pos))))
7646 (if (and tophl (funcall (if negative 'identity 'not)
7647 (string= hl tophl)))
7648 (org-agenda-filter-hide-line 'category)))
7649 (beginning-of-line 2)))
7650 (if (get-char-property (point) 'invisible)
7651 (org-agenda-previous-line))
7652 (setq org-agenda-top-headline-filter hl
7653 org-agenda-filtered-by-top-headline t))
7655 (defun org-agenda-filter-hide-line (type)
7656 "Hide lines with TYPE in the agenda buffer."
7657 (let (ov)
7658 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
7659 (point-at-eol)))
7660 (overlay-put ov 'invisible t)
7661 (overlay-put ov 'type type)
7662 (cond ((eq type 'tag) (push ov org-agenda-tag-filter-overlays))
7663 ((eq type 'category) (push ov org-agenda-cat-filter-overlays))
7664 ((eq type 'regexp) (push ov org-agenda-re-filter-overlays)))))
7666 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
7667 (setq pos (or pos (point)))
7668 (save-excursion
7669 (dolist (ov (overlays-at pos))
7670 (when (and (overlay-get ov 'invisible)
7671 (eq (overlay-get ov 'type) 'tag))
7672 (goto-char pos)
7673 (if (< (overlay-start ov) (point-at-eol))
7674 (move-overlay ov (point-at-eol)
7675 (overlay-end ov)))))))
7677 (defun org-agenda-filter-show-all-tag nil
7678 "Remove tag filter overlays from the agenda buffer."
7679 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
7680 (setq org-agenda-tag-filter-overlays nil
7681 org-agenda-tag-filter nil
7682 org-agenda-filter-form nil)
7683 (org-agenda-set-mode-name))
7685 (defun org-agenda-filter-show-all-re nil
7686 "Remove regexp filter overlays from the agenda buffer."
7687 (mapc 'delete-overlay org-agenda-re-filter-overlays)
7688 (setq org-agenda-re-filter-overlays nil
7689 org-agenda-regexp-filter nil
7690 org-agenda-filter-form nil)
7691 (org-agenda-set-mode-name))
7693 (defun org-agenda-filter-show-all-cat nil
7694 "Remove category filter overlays from the agenda buffer."
7695 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
7696 (setq org-agenda-cat-filter-overlays nil
7697 org-agenda-filtered-by-category nil
7698 org-agenda-category-filter nil
7699 org-agenda-filter-form nil)
7700 (org-agenda-set-mode-name))
7702 (defun org-agenda-manipulate-query-add ()
7703 "Manipulate the query by adding a search term with positive selection.
7704 Positive selection means the term must be matched for selection of an entry."
7705 (interactive)
7706 (org-agenda-manipulate-query ?\[))
7707 (defun org-agenda-manipulate-query-subtract ()
7708 "Manipulate the query by adding a search term with negative selection.
7709 Negative selection means term must not be matched for selection of an entry."
7710 (interactive)
7711 (org-agenda-manipulate-query ?\]))
7712 (defun org-agenda-manipulate-query-add-re ()
7713 "Manipulate the query by adding a search regexp with positive selection.
7714 Positive selection means the regexp must match for selection of an entry."
7715 (interactive)
7716 (org-agenda-manipulate-query ?\{))
7717 (defun org-agenda-manipulate-query-subtract-re ()
7718 "Manipulate the query by adding a search regexp with negative selection.
7719 Negative selection means regexp must not match for selection of an entry."
7720 (interactive)
7721 (org-agenda-manipulate-query ?\}))
7722 (defun org-agenda-manipulate-query (char)
7723 (cond
7724 ((memq org-agenda-type '(timeline agenda))
7725 (let ((org-agenda-include-inactive-timestamps t))
7726 (org-agenda-redo))
7727 (message "Display now includes inactive timestamps as well"))
7728 ((eq org-agenda-type 'search)
7729 (org-add-to-string
7730 'org-agenda-query-string
7731 (if org-agenda-last-search-view-search-was-boolean
7732 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7733 (?\{ . " +{}") (?\} . " -{}"))))
7734 " "))
7735 (setq org-agenda-redo-command
7736 (list 'org-search-view
7737 (car (get-text-property (min (1- (point-max)) (point))
7738 'org-last-args))
7739 org-agenda-query-string
7740 (+ (length org-agenda-query-string)
7741 (if (member char '(?\{ ?\})) 0 1))))
7742 (set-register org-agenda-query-register org-agenda-query-string)
7743 (let ((org-agenda-overriding-arguments
7744 (cdr org-agenda-redo-command)))
7745 (org-agenda-redo)))
7746 (t (error "Cannot manipulate query for %s-type agenda buffers"
7747 org-agenda-type))))
7749 (defun org-add-to-string (var string)
7750 (set var (concat (symbol-value var) string)))
7752 (defun org-agenda-goto-date (span)
7753 "Jump to DATE in agenda."
7754 (interactive "P")
7755 (let* ((org-read-date-prefer-future
7756 (eval org-agenda-jump-prefer-future))
7757 (date (org-read-date))
7758 (day (time-to-days (org-time-string-to-time date)))
7759 (org-agenda-sticky-orig org-agenda-sticky)
7760 (org-agenda-buffer-tmp-name (buffer-name))
7761 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7762 (0-arg (or current-prefix-arg (car args)))
7763 (2-arg (nth 2 args))
7764 (with-hour-p (nth 4 org-agenda-redo-command))
7765 (newcmd (list 'org-agenda-list 0-arg date
7766 (org-agenda-span-to-ndays
7767 2-arg (org-time-string-to-absolute date))
7768 with-hour-p))
7769 (newargs (cdr newcmd))
7770 (inhibit-read-only t)
7771 org-agenda-sticky)
7772 (if (not (org-agenda-check-type t 'agenda))
7773 (error "Not available in non-agenda views")
7774 (add-text-properties (point-min) (point-max)
7775 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7776 (org-agenda-redo)
7777 (goto-char (point-min))
7778 (while (not (or (= (or (get-text-property (point) 'day) 0) day)
7779 (save-excursion (move-beginning-of-line 2) (eobp))))
7780 (move-beginning-of-line 2))
7781 (setq org-agenda-sticky org-agenda-sticky-orig
7782 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7784 (defun org-agenda-goto-today ()
7785 "Go to today."
7786 (interactive)
7787 (org-agenda-check-type t 'timeline 'agenda)
7788 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7789 (curspan (nth 2 args))
7790 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7791 (cond
7792 (tdpos (goto-char tdpos))
7793 ((eq org-agenda-type 'agenda)
7794 (let* ((sd (org-agenda-compute-starting-span
7795 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7796 (org-agenda-overriding-arguments args))
7797 (setf (nth 1 org-agenda-overriding-arguments) sd)
7798 (org-agenda-redo)
7799 (org-agenda-find-same-or-today-or-agenda)))
7800 (t (error "Cannot find today")))))
7802 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7803 (goto-char
7804 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7805 (text-property-any (point-min) (point-max) 'org-today t)
7806 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7807 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7808 (org-agenda-goto-block-beginning))
7809 (point-min))))
7811 (defun org-agenda-goto-block-beginning ()
7812 "Go the agenda block beginning."
7813 (interactive)
7814 (if (not (derived-mode-p 'org-agenda-mode))
7815 (error "Cannot execute this command outside of org-agenda-mode buffers")
7816 (let (dest)
7817 (save-excursion
7818 (unless (looking-at "\\'")
7819 (forward-char))
7820 (let* ((prop 'org-agenda-structural-header)
7821 (p (previous-single-property-change (point) prop))
7822 (n (next-single-property-change (or (and (looking-at "\\`") 1)
7823 (1- (point))) prop)))
7824 (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
7825 (if (not dest)
7826 (error "Cannot find the beginning of the blog")
7827 (goto-char dest)
7828 (move-beginning-of-line 1)))))
7830 (defun org-agenda-later (arg)
7831 "Go forward in time by the current span.
7832 With prefix ARG, go forward that many times the current span."
7833 (interactive "p")
7834 (org-agenda-check-type t 'agenda)
7835 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7836 (span (or (nth 2 args) org-agenda-current-span))
7837 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7838 (greg (calendar-gregorian-from-absolute sd))
7839 (cnt (org-get-at-bol 'org-day-cnt))
7840 greg2)
7841 (cond
7842 ((numberp span)
7843 (setq sd (+ (* span arg) sd)))
7844 ((eq span 'day)
7845 (setq sd (+ arg sd)))
7846 ((eq span 'week)
7847 (setq sd (+ (* 7 arg) sd)))
7848 ((eq span 'fortnight)
7849 (setq sd (+ (* 14 arg) sd)))
7850 ((eq span 'month)
7851 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7852 sd (calendar-absolute-from-gregorian greg2))
7853 (setcar greg2 (1+ (car greg2))))
7854 ((eq span 'year)
7855 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7856 sd (calendar-absolute-from-gregorian greg2))
7857 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7859 (setq sd (+ (* span arg) sd))))
7860 (let ((org-agenda-overriding-cmd
7861 ;; `cmd' may have been set by `org-agenda-run-series' which
7862 ;; uses `org-agenda-overriding-cmd' to decide whether
7863 ;; overriding is allowed for `cmd'
7864 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7865 (org-agenda-overriding-arguments
7866 (list (car args) sd span)))
7867 (org-agenda-redo)
7868 (org-agenda-find-same-or-today-or-agenda cnt))))
7870 (defun org-agenda-earlier (arg)
7871 "Go backward in time by the current span.
7872 With prefix ARG, go backward that many times the current span."
7873 (interactive "p")
7874 (org-agenda-later (- arg)))
7876 (defun org-agenda-view-mode-dispatch ()
7877 "Call one of the view mode commands."
7878 (interactive)
7879 (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
7880 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7881 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7882 (let ((a (read-char-exclusive)))
7883 (case a
7884 (?\ (call-interactively 'org-agenda-reset-view))
7885 (?d (call-interactively 'org-agenda-day-view))
7886 (?w (call-interactively 'org-agenda-week-view))
7887 (?t (call-interactively 'org-agenda-fortnight-view))
7888 (?m (call-interactively 'org-agenda-month-view))
7889 (?y (call-interactively 'org-agenda-year-view))
7890 (?l (call-interactively 'org-agenda-log-mode))
7891 (?L (org-agenda-log-mode '(4)))
7892 (?c (org-agenda-log-mode 'clockcheck))
7893 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7894 (?a (call-interactively 'org-agenda-archives-mode))
7895 (?A (org-agenda-archives-mode 'files))
7896 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7897 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7898 (?G (call-interactively 'org-agenda-toggle-time-grid))
7899 (?D (call-interactively 'org-agenda-toggle-diary))
7900 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7901 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7902 (org-agenda-check-type t 'timeline 'agenda)
7903 (org-agenda-redo))
7904 (message "Display now includes inactive timestamps as well"))
7905 (?q (message "Abort"))
7906 (otherwise (error "Invalid key" )))))
7908 (defun org-agenda-reset-view ()
7909 "Switch to default view for agenda."
7910 (interactive)
7911 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7912 (defun org-agenda-day-view (&optional day-of-month)
7913 "Switch to daily view for agenda.
7914 With argument DAY-OF-MONTH, switch to that day of the month."
7915 (interactive "P")
7916 (org-agenda-change-time-span 'day day-of-month))
7917 (defun org-agenda-week-view (&optional iso-week)
7918 "Switch to daily view for agenda.
7919 With argument ISO-WEEK, switch to the corresponding ISO week.
7920 If ISO-WEEK has more then 2 digits, only the last two encode the
7921 week. Any digits before this encode a year. So 200712 means
7922 week 12 of year 2007. Years in the range 1938-2037 can also be
7923 written as 2-digit years."
7924 (interactive "P")
7925 (org-agenda-change-time-span 'week iso-week))
7926 (defun org-agenda-fortnight-view (&optional iso-week)
7927 "Switch to daily view for agenda.
7928 With argument ISO-WEEK, switch to the corresponding ISO week.
7929 If ISO-WEEK has more then 2 digits, only the last two encode the
7930 week. Any digits before this encode a year. So 200712 means
7931 week 12 of year 2007. Years in the range 1938-2037 can also be
7932 written as 2-digit years."
7933 (interactive "P")
7934 (org-agenda-change-time-span 'fortnight iso-week))
7935 (defun org-agenda-month-view (&optional month)
7936 "Switch to monthly view for agenda.
7937 With argument MONTH, switch to that month."
7938 (interactive "P")
7939 (org-agenda-change-time-span 'month month))
7940 (defun org-agenda-year-view (&optional year)
7941 "Switch to yearly view for agenda.
7942 With argument YEAR, switch to that year.
7943 If MONTH has more then 2 digits, only the last two encode the
7944 month. Any digits before this encode a year. So 200712 means
7945 December year 2007. Years in the range 1938-2037 can also be
7946 written as 2-digit years."
7947 (interactive "P")
7948 (when year
7949 (setq year (org-small-year-to-year year)))
7950 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7951 (org-agenda-change-time-span 'year year)
7952 (error "Abort")))
7954 (defun org-agenda-change-time-span (span &optional n)
7955 "Change the agenda view to SPAN.
7956 SPAN may be `day', `week', `fortnight', `month', `year'."
7957 (org-agenda-check-type t 'agenda)
7958 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7959 (curspan (nth 2 args)))
7960 (if (and (not n) (equal curspan span))
7961 (error "Viewing span is already \"%s\"" span))
7962 (let* ((sd (or (org-get-at-bol 'day)
7963 (nth 1 args)
7964 org-starting-day))
7965 (sd (org-agenda-compute-starting-span sd span n))
7966 (org-agenda-overriding-cmd
7967 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7968 (org-agenda-overriding-arguments
7969 (list (car args) sd span)))
7970 (org-agenda-redo)
7971 (org-agenda-find-same-or-today-or-agenda))
7972 (org-agenda-set-mode-name)
7973 (message "Switched to %s view" span)))
7975 (defun org-agenda-compute-starting-span (sd span &optional n)
7976 "Compute starting date for agenda.
7977 SPAN may be `day', `week', `fortnight', `month', `year'. The return value
7978 is a cons cell with the starting date and the number of days,
7979 so that the date SD will be in that range."
7980 (let* ((greg (calendar-gregorian-from-absolute sd))
7981 (dg (nth 1 greg))
7982 (mg (car greg))
7983 (yg (nth 2 greg)))
7984 (cond
7985 ((eq span 'day)
7986 (when n
7987 (setq sd (+ (calendar-absolute-from-gregorian
7988 (list mg 1 yg))
7989 n -1))))
7990 ((or (eq span 'week) (eq span 'fortnight))
7991 (let* ((nt (calendar-day-of-week
7992 (calendar-gregorian-from-absolute sd)))
7993 (d (if org-agenda-start-on-weekday
7994 (- nt org-agenda-start-on-weekday)
7997 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7998 (when n
7999 (require 'cal-iso)
8000 (when (> n 99)
8001 (setq y1 (org-small-year-to-year (/ n 100))
8002 n (mod n 100)))
8003 (setq sd
8004 (calendar-absolute-from-iso
8005 (list n 1
8006 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
8007 ((eq span 'month)
8008 (let (y1)
8009 (when (and n (> n 99))
8010 (setq y1 (org-small-year-to-year (/ n 100))
8011 n (mod n 100)))
8012 (setq sd (calendar-absolute-from-gregorian
8013 (list (or n mg) 1 (or y1 yg))))))
8014 ((eq span 'year)
8015 (setq sd (calendar-absolute-from-gregorian
8016 (list 1 1 (or n yg))))))
8017 sd))
8019 (defun org-agenda-next-date-line (&optional arg)
8020 "Jump to the next line indicating a date in agenda buffer."
8021 (interactive "p")
8022 (org-agenda-check-type t 'agenda 'timeline)
8023 (beginning-of-line 1)
8024 ;; This does not work if user makes date format that starts with a blank
8025 (if (looking-at "^\\S-") (forward-char 1))
8026 (if (not (re-search-forward "^\\S-" nil t arg))
8027 (progn
8028 (backward-char 1)
8029 (error "No next date after this line in this buffer")))
8030 (goto-char (match-beginning 0)))
8032 (defun org-agenda-previous-date-line (&optional arg)
8033 "Jump to the previous line indicating a date in agenda buffer."
8034 (interactive "p")
8035 (org-agenda-check-type t 'agenda 'timeline)
8036 (beginning-of-line 1)
8037 (if (not (re-search-backward "^\\S-" nil t arg))
8038 (error "No previous date before this line in this buffer")))
8040 ;; Initialize the highlight
8041 (defvar org-hl (make-overlay 1 1))
8042 (overlay-put org-hl 'face 'highlight)
8044 (defun org-highlight (begin end &optional buffer)
8045 "Highlight a region with overlay."
8046 (move-overlay org-hl begin end (or buffer (current-buffer))))
8048 (defun org-unhighlight ()
8049 "Detach overlay INDEX."
8050 (org-detach-overlay org-hl))
8052 (defun org-unhighlight-once ()
8053 "Remove the highlight from its position, and this function from the hook."
8054 (remove-hook 'pre-command-hook 'org-unhighlight-once)
8055 (org-unhighlight))
8057 (defvar org-agenda-pre-follow-window-conf nil)
8058 (defun org-agenda-follow-mode ()
8059 "Toggle follow mode in an agenda buffer."
8060 (interactive)
8061 (unless org-agenda-follow-mode
8062 (setq org-agenda-pre-follow-window-conf
8063 (current-window-configuration)))
8064 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
8065 (unless org-agenda-follow-mode
8066 (set-window-configuration org-agenda-pre-follow-window-conf))
8067 (org-agenda-set-mode-name)
8068 (org-agenda-do-context-action)
8069 (message "Follow mode is %s"
8070 (if org-agenda-follow-mode "on" "off")))
8072 (defun org-agenda-entry-text-mode (&optional arg)
8073 "Toggle entry text mode in an agenda buffer."
8074 (interactive "P")
8075 (if (or org-agenda-tag-filter
8076 org-agenda-category-filter
8077 org-agenda-regexp-filter
8078 org-agenda-top-headline-filter)
8079 (user-error "Can't show entry text in filtered views")
8080 (setq org-agenda-entry-text-mode (or (integerp arg)
8081 (not org-agenda-entry-text-mode)))
8082 (org-agenda-entry-text-hide)
8083 (and org-agenda-entry-text-mode
8084 (let ((org-agenda-entry-text-maxlines
8085 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
8086 (org-agenda-entry-text-show)))
8087 (org-agenda-set-mode-name)
8088 (message "Entry text mode is %s%s"
8089 (if org-agenda-entry-text-mode "on" "off")
8090 (if (not org-agenda-entry-text-mode) ""
8091 (format " (maximum number of lines is %d)"
8092 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
8094 (defun org-agenda-clockreport-mode (&optional with-filter)
8095 "Toggle clocktable mode in an agenda buffer.
8096 With prefix arg WITH-FILTER, make the clocktable respect the current
8097 agenda filter."
8098 (interactive "P")
8099 (org-agenda-check-type t 'agenda)
8100 (if with-filter
8101 (setq org-agenda-clockreport-mode 'with-filter)
8102 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
8103 (org-agenda-set-mode-name)
8104 (org-agenda-redo)
8105 (message "Clocktable mode is %s"
8106 (if org-agenda-clockreport-mode "on" "off")))
8108 (defun org-agenda-log-mode (&optional special)
8109 "Toggle log mode in an agenda buffer.
8110 With argument SPECIAL, show all possible log items, not only the ones
8111 configured in `org-agenda-log-mode-items'.
8112 With a double `C-u' prefix arg, show *only* log items, nothing else."
8113 (interactive "P")
8114 (org-agenda-check-type t 'agenda 'timeline)
8115 (setq org-agenda-show-log
8116 (cond
8117 ((equal special '(16)) 'only)
8118 ((eq special 'clockcheck)
8119 (if (eq org-agenda-show-log 'clockcheck)
8120 nil 'clockcheck))
8121 (special '(closed clock state))
8122 (t (not org-agenda-show-log))))
8123 (org-agenda-set-mode-name)
8124 (org-agenda-redo)
8125 (message "Log mode is %s"
8126 (if org-agenda-show-log "on" "off")))
8128 (defun org-agenda-archives-mode (&optional with-files)
8129 "Toggle inclusion of items in trees marked with :ARCHIVE:.
8130 When called with a prefix argument, include all archive files as well."
8131 (interactive "P")
8132 (setq org-agenda-archives-mode
8133 (if with-files t (if org-agenda-archives-mode nil 'trees)))
8134 (org-agenda-set-mode-name)
8135 (org-agenda-redo)
8136 (message
8137 "%s"
8138 (cond
8139 ((eq org-agenda-archives-mode nil)
8140 "No archives are included")
8141 ((eq org-agenda-archives-mode 'trees)
8142 (format "Trees with :%s: tag are included" org-archive-tag))
8143 ((eq org-agenda-archives-mode t)
8144 (format "Trees with :%s: tag and all active archive files are included"
8145 org-archive-tag)))))
8147 (defun org-agenda-toggle-diary ()
8148 "Toggle diary inclusion in an agenda buffer."
8149 (interactive)
8150 (org-agenda-check-type t 'agenda)
8151 (setq org-agenda-include-diary (not org-agenda-include-diary))
8152 (org-agenda-redo)
8153 (org-agenda-set-mode-name)
8154 (message "Diary inclusion turned %s"
8155 (if org-agenda-include-diary "on" "off")))
8157 (defun org-agenda-toggle-deadlines ()
8158 "Toggle inclusion of entries with a deadline in an agenda buffer."
8159 (interactive)
8160 (org-agenda-check-type t 'agenda)
8161 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8162 (org-agenda-redo)
8163 (org-agenda-set-mode-name)
8164 (message "Deadlines inclusion turned %s"
8165 (if org-agenda-include-deadlines "on" "off")))
8167 (defun org-agenda-toggle-time-grid ()
8168 "Toggle time grid in an agenda buffer."
8169 (interactive)
8170 (org-agenda-check-type t 'agenda)
8171 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8172 (org-agenda-redo)
8173 (org-agenda-set-mode-name)
8174 (message "Time-grid turned %s"
8175 (if org-agenda-use-time-grid "on" "off")))
8177 (defun org-agenda-set-mode-name ()
8178 "Set the mode name to indicate all the small mode settings."
8179 (setq mode-name
8180 (list "Org-Agenda"
8181 (if (get 'org-agenda-files 'org-restrict) " []" "")
8183 '(:eval (org-agenda-span-name org-agenda-current-span))
8184 (if org-agenda-follow-mode " Follow" "")
8185 (if org-agenda-entry-text-mode " ETxt" "")
8186 (if org-agenda-include-diary " Diary" "")
8187 (if org-agenda-include-deadlines " Ddl" "")
8188 (if org-agenda-use-time-grid " Grid" "")
8189 (if (and (boundp 'org-habit-show-habits)
8190 org-habit-show-habits) " Habit" "")
8191 (cond
8192 ((consp org-agenda-show-log) " LogAll")
8193 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8194 (org-agenda-show-log " Log")
8195 (t ""))
8196 (if (or org-agenda-category-filter
8197 (get 'org-agenda-category-filter :preset-filter))
8198 '(:eval (org-propertize
8199 (concat " <"
8200 (mapconcat
8201 'identity
8202 (append
8203 (get 'org-agenda-category-filter :preset-filter)
8204 org-agenda-category-filter)
8206 ">")
8207 'face 'org-agenda-filter-category
8208 'help-echo "Category used in filtering")) "")
8209 (if (or org-agenda-tag-filter
8210 (get 'org-agenda-tag-filter :preset-filter))
8211 '(:eval (org-propertize
8212 (concat " {"
8213 (mapconcat
8214 'identity
8215 (append
8216 (get 'org-agenda-tag-filter :preset-filter)
8217 org-agenda-tag-filter)
8219 "}")
8220 'face 'org-agenda-filter-tags
8221 'help-echo "Tags used in filtering")) "")
8222 (if (or org-agenda-regexp-filter
8223 (get 'org-agenda-regexp-filter :preset-filter))
8224 '(:eval (org-propertize
8225 (concat " ["
8226 (mapconcat
8227 'identity
8228 (append
8229 (get 'org-agenda-regexp-filter :preset-filter)
8230 org-agenda-regexp-filter)
8232 "]")
8233 'face 'org-agenda-filter-regexp
8234 'help-echo "Regexp used in filtering")) "")
8235 (if org-agenda-archives-mode
8236 (if (eq org-agenda-archives-mode t)
8237 " Archives"
8238 (format " :%s:" org-archive-tag))
8240 (if org-agenda-clockreport-mode
8241 (if (eq org-agenda-clockreport-mode 'with-filter)
8242 " Clock{}" " Clock")
8243 "")))
8244 (force-mode-line-update))
8246 (define-obsolete-function-alias
8247 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8249 (defun org-agenda-update-agenda-type ()
8250 "Update the agenda type after each command."
8251 (setq org-agenda-type
8252 (or (get-text-property (point) 'org-agenda-type)
8253 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8255 (defun org-agenda-next-line ()
8256 "Move cursor to the next line, and show if follow mode is active."
8257 (interactive)
8258 (call-interactively 'next-line)
8259 (org-agenda-do-context-action))
8261 (defun org-agenda-previous-line ()
8262 "Move cursor to the previous line, and show if follow-mode is active."
8263 (interactive)
8264 (call-interactively 'previous-line)
8265 (org-agenda-do-context-action))
8267 (defun org-agenda-next-item (n)
8268 "Move cursor to next agenda item."
8269 (interactive "p")
8270 (let ((col (current-column)))
8271 (dotimes (c n)
8272 (when (next-single-property-change (point-at-eol) 'org-marker)
8273 (move-end-of-line 1)
8274 (goto-char (next-single-property-change (point) 'org-marker))))
8275 (org-move-to-column col))
8276 (org-agenda-do-context-action))
8278 (defun org-agenda-previous-item (n)
8279 "Move cursor to next agenda item."
8280 (interactive "p")
8281 (dotimes (c n)
8282 (let ((col (current-column))
8283 (goto (save-excursion
8284 (move-end-of-line 0)
8285 (previous-single-property-change (point) 'org-marker))))
8286 (if goto (goto-char goto))
8287 (org-move-to-column col)))
8288 (org-agenda-do-context-action))
8290 (defun org-agenda-do-context-action ()
8291 "Show outline path and, maybe, follow mode window."
8292 (let ((m (org-get-at-bol 'org-marker)))
8293 (when (and (markerp m) (marker-buffer m))
8294 (and org-agenda-follow-mode
8295 (if org-agenda-follow-indirect
8296 (org-agenda-tree-to-indirect-buffer nil)
8297 (org-agenda-show)))
8298 (and org-agenda-show-outline-path
8299 (org-with-point-at m (org-display-outline-path t))))))
8301 (defun org-agenda-show-tags ()
8302 "Show the tags applicable to the current item."
8303 (interactive)
8304 (let* ((tags (org-get-at-bol 'tags)))
8305 (if tags
8306 (message "Tags are :%s:"
8307 (org-no-properties (mapconcat 'identity tags ":")))
8308 (message "No tags associated with this line"))))
8310 (defun org-agenda-goto (&optional highlight)
8311 "Go to the Org-mode file which contains the item at point."
8312 (interactive)
8313 (let* ((marker (or (org-get-at-bol 'org-marker)
8314 (org-agenda-error)))
8315 (buffer (marker-buffer marker))
8316 (pos (marker-position marker)))
8317 (switch-to-buffer-other-window buffer)
8318 (widen)
8319 (push-mark)
8320 (goto-char pos)
8321 (when (derived-mode-p 'org-mode)
8322 (org-show-context 'agenda)
8323 (save-excursion
8324 (and (outline-next-heading)
8325 (org-flag-heading nil)))) ; show the next heading
8326 (when (outline-invisible-p)
8327 (show-entry)) ; display invisible text
8328 (recenter (/ (window-height) 2))
8329 (run-hooks 'org-agenda-after-show-hook)
8330 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8332 (defvar org-agenda-after-show-hook nil
8333 "Normal hook run after an item has been shown from the agenda.
8334 Point is in the buffer where the item originated.")
8336 (defun org-agenda-kill ()
8337 "Kill the entry or subtree belonging to the current agenda entry."
8338 (interactive)
8339 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8340 (let* ((bufname-orig (buffer-name))
8341 (marker (or (org-get-at-bol 'org-marker)
8342 (org-agenda-error)))
8343 (buffer (marker-buffer marker))
8344 (pos (marker-position marker))
8345 (type (org-get-at-bol 'type))
8346 dbeg dend (n 0) conf)
8347 (org-with-remote-undo buffer
8348 (with-current-buffer buffer
8349 (save-excursion
8350 (goto-char pos)
8351 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8352 (setq dbeg (progn (org-back-to-heading t) (point))
8353 dend (org-end-of-subtree t t))
8354 (setq dbeg (point-at-bol)
8355 dend (min (point-max) (1+ (point-at-eol)))))
8356 (goto-char dbeg)
8357 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8358 (setq conf (or (eq t org-agenda-confirm-kill)
8359 (and (numberp org-agenda-confirm-kill)
8360 (> n org-agenda-confirm-kill))))
8361 (and conf
8362 (not (y-or-n-p
8363 (format "Delete entry with %d lines in buffer \"%s\"? "
8364 n (buffer-name buffer))))
8365 (error "Abort"))
8366 (let ((org-agenda-buffer-name bufname-orig))
8367 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8368 (with-current-buffer buffer (delete-region dbeg dend))
8369 (message "Agenda item and source killed"))))
8371 (defvar org-archive-default-command) ; defined in org-archive.el
8372 (defun org-agenda-archive-default ()
8373 "Archive the entry or subtree belonging to the current agenda entry."
8374 (interactive)
8375 (require 'org-archive)
8376 (org-agenda-archive-with org-archive-default-command))
8378 (defun org-agenda-archive-default-with-confirmation ()
8379 "Archive the entry or subtree belonging to the current agenda entry."
8380 (interactive)
8381 (require 'org-archive)
8382 (org-agenda-archive-with org-archive-default-command 'confirm))
8384 (defun org-agenda-archive ()
8385 "Archive the entry or subtree belonging to the current agenda entry."
8386 (interactive)
8387 (org-agenda-archive-with 'org-archive-subtree))
8389 (defun org-agenda-archive-to-archive-sibling ()
8390 "Move the entry to the archive sibling."
8391 (interactive)
8392 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8394 (defun org-agenda-archive-with (cmd &optional confirm)
8395 "Move the entry to the archive sibling."
8396 (interactive)
8397 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8398 (let* ((bufname-orig (buffer-name))
8399 (marker (or (org-get-at-bol 'org-marker)
8400 (org-agenda-error)))
8401 (buffer (marker-buffer marker))
8402 (pos (marker-position marker)))
8403 (org-with-remote-undo buffer
8404 (with-current-buffer buffer
8405 (if (derived-mode-p 'org-mode)
8406 (if (and confirm
8407 (not (y-or-n-p "Archive this subtree or entry? ")))
8408 (error "Abort")
8409 (save-window-excursion
8410 (goto-char pos)
8411 (let ((org-agenda-buffer-name bufname-orig))
8412 (org-remove-subtree-entries-from-agenda))
8413 (org-back-to-heading t)
8414 (funcall cmd)))
8415 (error "Archiving works only in Org-mode files"))))))
8417 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8418 "Remove all lines in the agenda that correspond to a given subtree.
8419 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8420 If this information is not given, the function uses the tree at point."
8421 (let ((buf (or buf (current-buffer))) m p)
8422 (save-excursion
8423 (unless (and beg end)
8424 (org-back-to-heading t)
8425 (setq beg (point))
8426 (org-end-of-subtree t)
8427 (setq end (point)))
8428 (set-buffer (get-buffer org-agenda-buffer-name))
8429 (save-excursion
8430 (goto-char (point-max))
8431 (beginning-of-line 1)
8432 (while (not (bobp))
8433 (when (and (setq m (org-get-at-bol 'org-marker))
8434 (equal buf (marker-buffer m))
8435 (setq p (marker-position m))
8436 (>= p beg)
8437 (< p end))
8438 (let ((inhibit-read-only t))
8439 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8440 (beginning-of-line 0))))))
8442 (defun org-agenda-refile (&optional goto rfloc no-update)
8443 "Refile the item at point.
8445 When GOTO is 0 or '(64), clear the refile cache.
8446 When GOTO is '(16), go to the location of the last refiled item.
8447 RFLOC can be a refile location obtained in a different way.
8448 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8449 (interactive "P")
8450 (cond
8451 ((member goto '(0 (64)))
8452 (org-refile-cache-clear))
8453 ((equal goto '(16))
8454 (org-refile-goto-last-stored))
8456 (let* ((buffer-orig (buffer-name))
8457 (marker (or (org-get-at-bol 'org-hd-marker)
8458 (org-agenda-error)))
8459 (buffer (marker-buffer marker))
8460 (pos (marker-position marker))
8461 (rfloc (or rfloc
8462 (org-refile-get-location
8463 (if goto "Goto" "Refile to") buffer
8464 org-refile-allow-creating-parent-nodes))))
8465 (with-current-buffer buffer
8466 (save-excursion
8467 (save-restriction
8468 (widen)
8469 (goto-char marker)
8470 (let ((org-agenda-buffer-name buffer-orig))
8471 (org-remove-subtree-entries-from-agenda))
8472 (org-refile goto buffer rfloc)))))
8473 (unless no-update (org-agenda-redo)))))
8475 (defun org-agenda-open-link (&optional arg)
8476 "Open the link(s) in the current entry, if any.
8477 This looks for a link in the displayed line in the agenda.
8478 It also looks at the text of the entry itself."
8479 (interactive "P")
8480 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8481 (org-get-at-bol 'org-marker)))
8482 (buffer (and marker (marker-buffer marker)))
8483 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8484 (lkall (org-offer-links-in-entry buffer marker arg prefix))
8485 (lk0 (car lkall))
8486 (lk (if (stringp lk0) (list lk0) lk0))
8487 (lkend (cdr lkall))
8488 trg)
8489 (cond
8490 ((and buffer lk)
8491 (mapcar (lambda(l)
8492 (with-current-buffer buffer
8493 (setq trg (and (string-match org-bracket-link-regexp l)
8494 (match-string 1 l)))
8495 (if (or (not trg) (string-match org-any-link-re trg))
8496 (save-excursion
8497 (save-restriction
8498 (widen)
8499 (goto-char marker)
8500 (when (search-forward l nil lkend)
8501 (goto-char (match-beginning 0))
8502 (org-open-at-point))))
8503 ;; This is an internal link, widen the buffer
8504 (switch-to-buffer-other-window buffer)
8505 (widen)
8506 (goto-char marker)
8507 (when (search-forward l nil lkend)
8508 (goto-char (match-beginning 0))
8509 (org-open-at-point)))))
8510 lk))
8511 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8512 (save-excursion
8513 (beginning-of-line 1)
8514 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8515 (org-open-link-from-string (match-string 1)))
8516 (t (message "No link to open here")))))
8518 (defun org-agenda-copy-local-variable (var)
8519 "Get a variable from a referenced buffer and install it here."
8520 (let ((m (org-get-at-bol 'org-marker)))
8521 (when (and m (buffer-live-p (marker-buffer m)))
8522 (org-set-local var (with-current-buffer (marker-buffer m)
8523 (symbol-value var))))))
8525 (defun org-agenda-switch-to (&optional delete-other-windows)
8526 "Go to the Org-mode file which contains the item at point."
8527 (interactive)
8528 (if (and org-return-follows-link
8529 (not (org-get-at-bol 'org-marker))
8530 (org-in-regexp org-bracket-link-regexp))
8531 (org-open-link-from-string (match-string 0))
8532 (let* ((marker (or (org-get-at-bol 'org-marker)
8533 (org-agenda-error)))
8534 (buffer (marker-buffer marker))
8535 (pos (marker-position marker)))
8536 (org-pop-to-buffer-same-window buffer)
8537 (and delete-other-windows (delete-other-windows))
8538 (widen)
8539 (goto-char pos)
8540 (when (derived-mode-p 'org-mode)
8541 (org-show-context 'agenda)
8542 (save-excursion
8543 (and (outline-next-heading)
8544 (org-flag-heading nil))) ; show the next heading
8545 (when (outline-invisible-p)
8546 (show-entry)) ; display invisible text
8547 (run-hooks 'org-agenda-after-show-hook)))))
8549 (defun org-agenda-goto-mouse (ev)
8550 "Go to the Org-mode file which contains the item at the mouse click."
8551 (interactive "e")
8552 (mouse-set-point ev)
8553 (org-agenda-goto))
8555 (defun org-agenda-show (&optional full-entry)
8556 "Display the Org-mode file which contains the item at point.
8557 With prefix argument FULL-ENTRY, make the entire entry visible
8558 if it was hidden in the outline."
8559 (interactive "P")
8560 (let ((win (selected-window)))
8561 (if full-entry
8562 (let ((org-show-entry-below t))
8563 (org-agenda-goto t))
8564 (org-agenda-goto t))
8565 (select-window win)))
8567 (defvar org-agenda-show-window nil)
8568 (defun org-agenda-show-and-scroll-up (&optional arg)
8569 "Display the Org-mode file which contains the item at point.
8570 When called repeatedly, scroll the window that is displaying the buffer.
8571 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8572 `show-subtree' to display the item, so that drawers and logbooks stay
8573 folded."
8574 (interactive "P")
8575 (let ((win (selected-window)))
8576 (if (and (window-live-p org-agenda-show-window)
8577 (eq this-command last-command))
8578 (progn
8579 (select-window org-agenda-show-window)
8580 (ignore-errors (scroll-up)))
8581 (org-agenda-goto t)
8582 (if arg (org-show-entry) (show-subtree))
8583 (setq org-agenda-show-window (selected-window)))
8584 (select-window win)))
8586 (defun org-agenda-show-scroll-down ()
8587 "Scroll down the window showing the agenda."
8588 (interactive)
8589 (let ((win (selected-window)))
8590 (when (window-live-p org-agenda-show-window)
8591 (select-window org-agenda-show-window)
8592 (ignore-errors (scroll-down))
8593 (select-window win))))
8595 (defun org-agenda-show-1 (&optional more)
8596 "Display the Org-mode file which contains the item at point.
8597 The prefix arg selects the amount of information to display:
8599 0 hide the subtree
8600 1 just show the entry according to defaults.
8601 2 show the children view
8602 3 show the subtree view
8603 4 show the entire subtree and any LOGBOOK drawers
8604 5 show the entire subtree and any drawers
8605 With prefix argument FULL-ENTRY, make the entire entry visible
8606 if it was hidden in the outline."
8607 (interactive "p")
8608 (let ((win (selected-window)))
8609 (org-agenda-goto t)
8610 (org-recenter-heading 1)
8611 (cond
8612 ((= more 0)
8613 (hide-subtree)
8614 (save-excursion
8615 (org-back-to-heading)
8616 (run-hook-with-args 'org-cycle-hook 'folded))
8617 (message "Remote: FOLDED"))
8618 ((and (org-called-interactively-p 'any) (= more 1))
8619 (message "Remote: show with default settings"))
8620 ((= more 2)
8621 (show-entry)
8622 (show-children)
8623 (save-excursion
8624 (org-back-to-heading)
8625 (run-hook-with-args 'org-cycle-hook 'children))
8626 (message "Remote: CHILDREN"))
8627 ((= more 3)
8628 (show-subtree)
8629 (save-excursion
8630 (org-back-to-heading)
8631 (run-hook-with-args 'org-cycle-hook 'subtree))
8632 (message "Remote: SUBTREE"))
8633 ((= more 4)
8634 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
8635 (org-drawer-regexp
8636 (concat "^[ \t]*:\\("
8637 (mapconcat 'regexp-quote org-drawers "\\|")
8638 "\\):[ \t]*$")))
8639 (show-subtree)
8640 (save-excursion
8641 (org-back-to-heading)
8642 (org-cycle-hide-drawers 'subtree)))
8643 (message "Remote: SUBTREE AND LOGBOOK"))
8644 ((> more 4)
8645 (show-subtree)
8646 (message "Remote: SUBTREE AND ALL DRAWERS")))
8647 (select-window win)))
8649 (defun org-recenter-heading (n)
8650 (save-excursion
8651 (org-back-to-heading)
8652 (recenter n)))
8654 (defvar org-agenda-cycle-counter nil)
8655 (defun org-agenda-cycle-show (&optional n)
8656 "Show the current entry in another window, with default settings.
8657 Default settings are taken from `org-show-hierarchy-above' and siblings.
8658 When use repeatedly in immediate succession, the remote entry will cycle
8659 through visibility
8661 children -> subtree -> folded
8663 When called with a numeric prefix arg, that arg will be passed through to
8664 `org-agenda-show-1'. For the interpretation of that argument, see the
8665 docstring of `org-agenda-show-1'."
8666 (interactive "P")
8667 (if (integerp n)
8668 (setq org-agenda-cycle-counter n)
8669 (if (not (eq last-command this-command))
8670 (setq org-agenda-cycle-counter 1)
8671 (if (equal org-agenda-cycle-counter 0)
8672 (setq org-agenda-cycle-counter 2)
8673 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8674 (if (> org-agenda-cycle-counter 3)
8675 (setq org-agenda-cycle-counter 0)))))
8676 (org-agenda-show-1 org-agenda-cycle-counter))
8678 (defun org-agenda-recenter (arg)
8679 "Display the Org-mode file which contains the item at point and recenter."
8680 (interactive "P")
8681 (let ((win (selected-window)))
8682 (org-agenda-goto t)
8683 (recenter arg)
8684 (select-window win)))
8686 (defun org-agenda-show-mouse (ev)
8687 "Display the Org-mode file which contains the item at the mouse click."
8688 (interactive "e")
8689 (mouse-set-point ev)
8690 (org-agenda-show))
8692 (defun org-agenda-check-no-diary ()
8693 "Check if the entry is a diary link and abort if yes."
8694 (if (org-get-at-bol 'org-agenda-diary-link)
8695 (org-agenda-error)))
8697 (defun org-agenda-error ()
8698 (error "Command not allowed in this line"))
8700 (defun org-agenda-tree-to-indirect-buffer (arg)
8701 "Show the subtree corresponding to the current entry in an indirect buffer.
8702 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8704 With a numerical prefix ARG, go up to this level and then take that tree.
8705 With a negative numeric ARG, go up by this number of levels.
8706 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8707 use the dedicated frame)."
8708 (interactive "P")
8709 (if current-prefix-arg
8710 (org-agenda-do-tree-to-indirect-buffer arg)
8711 (let ((agenda-buffer (buffer-name))
8712 (agenda-window (selected-window))
8713 (indirect-window
8714 (and org-last-indirect-buffer
8715 (get-buffer-window org-last-indirect-buffer))))
8716 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8717 (unless (or (eq org-indirect-buffer-display 'new-frame)
8718 (eq org-indirect-buffer-display 'dedicated-frame))
8719 (unwind-protect
8720 (unless (and indirect-window (window-live-p indirect-window))
8721 (setq indirect-window (split-window agenda-window)))
8722 (and indirect-window (select-window indirect-window))
8723 (switch-to-buffer org-last-indirect-buffer :norecord)
8724 (fit-window-to-buffer indirect-window)))
8725 (select-window (get-buffer-window agenda-buffer)))))
8727 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8728 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8729 (org-agenda-check-no-diary)
8730 (let* ((marker (or (org-get-at-bol 'org-marker)
8731 (org-agenda-error)))
8732 (buffer (marker-buffer marker))
8733 (pos (marker-position marker)))
8734 (with-current-buffer buffer
8735 (save-excursion
8736 (goto-char pos)
8737 (funcall 'org-tree-to-indirect-buffer arg)))))
8739 (defvar org-last-heading-marker (make-marker)
8740 "Marker pointing to the headline that last changed its TODO state
8741 by a remote command from the agenda.")
8743 (defun org-agenda-todo-nextset ()
8744 "Switch TODO entry to next sequence."
8745 (interactive)
8746 (org-agenda-todo 'nextset))
8748 (defun org-agenda-todo-previousset ()
8749 "Switch TODO entry to previous sequence."
8750 (interactive)
8751 (org-agenda-todo 'previousset))
8753 (defun org-agenda-todo (&optional arg)
8754 "Cycle TODO state of line at point, also in Org-mode file.
8755 This changes the line at point, all other lines in the agenda referring to
8756 the same tree node, and the headline of the tree node in the Org-mode file."
8757 (interactive "P")
8758 (org-agenda-check-no-diary)
8759 (let* ((col (current-column))
8760 (marker (or (org-get-at-bol 'org-marker)
8761 (org-agenda-error)))
8762 (buffer (marker-buffer marker))
8763 (pos (marker-position marker))
8764 (hdmarker (org-get-at-bol 'org-hd-marker))
8765 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
8766 (inhibit-read-only t)
8767 org-agenda-headline-snapshot-before-repeat newhead just-one)
8768 (org-with-remote-undo buffer
8769 (with-current-buffer buffer
8770 (widen)
8771 (goto-char pos)
8772 (org-show-context 'agenda)
8773 (save-excursion
8774 (and (outline-next-heading)
8775 (org-flag-heading nil))) ; show the next heading
8776 (let ((current-prefix-arg arg))
8777 (call-interactively 'org-todo))
8778 (and (bolp) (forward-char 1))
8779 (setq newhead (org-get-heading))
8780 (when (and (org-bound-and-true-p
8781 org-agenda-headline-snapshot-before-repeat)
8782 (not (equal org-agenda-headline-snapshot-before-repeat
8783 newhead))
8784 todayp)
8785 (setq newhead org-agenda-headline-snapshot-before-repeat
8786 just-one t))
8787 (save-excursion
8788 (org-back-to-heading)
8789 (move-marker org-last-heading-marker (point))))
8790 (beginning-of-line 1)
8791 (save-excursion
8792 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8793 (org-move-to-column col))))
8795 (defun org-agenda-add-note (&optional arg)
8796 "Add a time-stamped note to the entry at point."
8797 (interactive "P")
8798 (org-agenda-check-no-diary)
8799 (let* ((marker (or (org-get-at-bol 'org-marker)
8800 (org-agenda-error)))
8801 (buffer (marker-buffer marker))
8802 (pos (marker-position marker))
8803 (hdmarker (org-get-at-bol 'org-hd-marker))
8804 (inhibit-read-only t))
8805 (with-current-buffer buffer
8806 (widen)
8807 (goto-char pos)
8808 (org-show-context 'agenda)
8809 (save-excursion
8810 (and (outline-next-heading)
8811 (org-flag-heading nil))) ; show the next heading
8812 (org-add-note))))
8814 (defun org-agenda-change-all-lines (newhead hdmarker
8815 &optional fixface just-this)
8816 "Change all lines in the agenda buffer which match HDMARKER.
8817 The new content of the line will be NEWHEAD (as modified by
8818 `org-agenda-format-item'). HDMARKER is checked with
8819 `equal' against all `org-hd-marker' text properties in the file.
8820 If FIXFACE is non-nil, the face of each item is modified according to
8821 the new TODO state.
8822 If JUST-THIS is non-nil, change just the current line, not all.
8823 If FORCE-TAGS is non nil, the car of it returns the new tags."
8824 (let* ((inhibit-read-only t)
8825 (line (org-current-line))
8826 (org-agenda-buffer (current-buffer))
8827 (thetags (with-current-buffer (marker-buffer hdmarker)
8828 (save-excursion (save-restriction (widen)
8829 (goto-char hdmarker)
8830 (org-get-tags-at)))))
8831 props m pl undone-face done-face finish new dotime level cat tags)
8832 (save-excursion
8833 (goto-char (point-max))
8834 (beginning-of-line 1)
8835 (while (not finish)
8836 (setq finish (bobp))
8837 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8838 (or (not just-this) (= (org-current-line) line))
8839 (equal m hdmarker))
8840 (setq props (text-properties-at (point))
8841 dotime (org-get-at-bol 'dotime)
8842 cat (org-get-at-bol 'org-category)
8843 level (org-get-at-bol 'level)
8844 tags thetags
8846 (let ((org-prefix-format-compiled
8847 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8848 org-prefix-format-compiled))
8849 (extra (org-get-at-bol 'extra)))
8850 (with-current-buffer (marker-buffer hdmarker)
8851 (save-excursion
8852 (save-restriction
8853 (widen)
8854 (org-agenda-format-item extra newhead level cat tags dotime)))))
8855 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8856 undone-face (org-get-at-bol 'undone-face)
8857 done-face (org-get-at-bol 'done-face))
8858 (beginning-of-line 1)
8859 (cond
8860 ((equal new "")
8861 (and (looking-at ".*\n?") (replace-match "")))
8862 ((looking-at ".*")
8863 (replace-match new t t)
8864 (beginning-of-line 1)
8865 (add-text-properties (point-at-bol) (point-at-eol) props)
8866 (when fixface
8867 (add-text-properties
8868 (point-at-bol) (point-at-eol)
8869 (list 'face
8870 (if org-last-todo-state-is-todo
8871 undone-face done-face))))
8872 (org-agenda-highlight-todo 'line)
8873 (beginning-of-line 1))
8874 (t (error "Line update did not work")))
8875 (save-restriction
8876 (narrow-to-region (point-at-bol) (point-at-eol))
8877 (org-agenda-finalize)))
8878 (beginning-of-line 0)))))
8880 (defun org-agenda-align-tags (&optional line)
8881 "Align all tags in agenda items to `org-agenda-tags-column'."
8882 (let ((inhibit-read-only t) l c)
8883 (save-excursion
8884 (goto-char (if line (point-at-bol) (point-min)))
8885 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8886 (if line (point-at-eol) nil) t)
8887 (add-text-properties
8888 (match-beginning 2) (match-end 2)
8889 (list 'face (delq nil (let ((prop (get-text-property
8890 (match-beginning 2) 'face)))
8891 (or (listp prop) (setq prop (list prop)))
8892 (if (memq 'org-tag prop)
8893 prop
8894 (cons 'org-tag prop))))))
8895 (setq l (- (match-end 2) (match-beginning 2))
8896 c (if (< org-agenda-tags-column 0)
8897 (- (abs org-agenda-tags-column) l)
8898 org-agenda-tags-column))
8899 (delete-region (match-beginning 1) (match-end 1))
8900 (goto-char (match-beginning 1))
8901 (insert (org-add-props
8902 (make-string (max 1 (- c (current-column))) ?\ )
8903 (plist-put (copy-sequence (text-properties-at (point)))
8904 'face nil))))
8905 (goto-char (point-min))
8906 (org-font-lock-add-tag-faces (point-max)))))
8908 (defun org-agenda-priority-up ()
8909 "Increase the priority of line at point, also in Org-mode file."
8910 (interactive)
8911 (org-agenda-priority 'up))
8913 (defun org-agenda-priority-down ()
8914 "Decrease the priority of line at point, also in Org-mode file."
8915 (interactive)
8916 (org-agenda-priority 'down))
8918 (defun org-agenda-priority (&optional force-direction)
8919 "Set the priority of line at point, also in Org-mode file.
8920 This changes the line at point, all other lines in the agenda referring to
8921 the same tree node, and the headline of the tree node in the Org-mode file.
8922 Called with a universal prefix arg, show the priority instead of setting it."
8923 (interactive "P")
8924 (if (equal force-direction '(4))
8925 (org-show-priority)
8926 (unless org-enable-priority-commands
8927 (error "Priority commands are disabled"))
8928 (org-agenda-check-no-diary)
8929 (let* ((marker (or (org-get-at-bol 'org-marker)
8930 (org-agenda-error)))
8931 (hdmarker (org-get-at-bol 'org-hd-marker))
8932 (buffer (marker-buffer hdmarker))
8933 (pos (marker-position hdmarker))
8934 (inhibit-read-only t)
8935 newhead)
8936 (org-with-remote-undo buffer
8937 (with-current-buffer buffer
8938 (widen)
8939 (goto-char pos)
8940 (org-show-context 'agenda)
8941 (save-excursion
8942 (and (outline-next-heading)
8943 (org-flag-heading nil))) ; show the next heading
8944 (funcall 'org-priority force-direction)
8945 (end-of-line 1)
8946 (setq newhead (org-get-heading)))
8947 (org-agenda-change-all-lines newhead hdmarker)
8948 (beginning-of-line 1)))))
8950 ;; FIXME: should fix the tags property of the agenda line.
8951 (defun org-agenda-set-tags (&optional tag onoff)
8952 "Set tags for the current headline."
8953 (interactive)
8954 (org-agenda-check-no-diary)
8955 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8956 (call-interactively 'org-change-tag-in-region)
8957 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8958 (org-agenda-error)))
8959 (buffer (marker-buffer hdmarker))
8960 (pos (marker-position hdmarker))
8961 (inhibit-read-only t)
8962 newhead)
8963 (org-with-remote-undo buffer
8964 (with-current-buffer buffer
8965 (widen)
8966 (goto-char pos)
8967 (save-excursion
8968 (org-show-context 'agenda))
8969 (save-excursion
8970 (and (outline-next-heading)
8971 (org-flag-heading nil))) ; show the next heading
8972 (goto-char pos)
8973 (if tag
8974 (org-toggle-tag tag onoff)
8975 (call-interactively 'org-set-tags))
8976 (end-of-line 1)
8977 (setq newhead (org-get-heading)))
8978 (org-agenda-change-all-lines newhead hdmarker)
8979 (beginning-of-line 1)))))
8981 (defun org-agenda-set-property ()
8982 "Set a property for the current headline."
8983 (interactive)
8984 (org-agenda-check-no-diary)
8985 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8986 (org-agenda-error)))
8987 (buffer (marker-buffer hdmarker))
8988 (pos (marker-position hdmarker))
8989 (inhibit-read-only t)
8990 newhead)
8991 (org-with-remote-undo buffer
8992 (with-current-buffer buffer
8993 (widen)
8994 (goto-char pos)
8995 (save-excursion
8996 (org-show-context 'agenda))
8997 (save-excursion
8998 (and (outline-next-heading)
8999 (org-flag-heading nil))) ; show the next heading
9000 (goto-char pos)
9001 (call-interactively 'org-set-property)))))
9003 (defun org-agenda-set-effort ()
9004 "Set the effort property for the current headline."
9005 (interactive)
9006 (org-agenda-check-no-diary)
9007 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9008 (org-agenda-error)))
9009 (buffer (marker-buffer hdmarker))
9010 (pos (marker-position hdmarker))
9011 (inhibit-read-only t)
9012 newhead)
9013 (org-with-remote-undo buffer
9014 (with-current-buffer buffer
9015 (widen)
9016 (goto-char pos)
9017 (save-excursion
9018 (org-show-context 'agenda))
9019 (save-excursion
9020 (and (outline-next-heading)
9021 (org-flag-heading nil))) ; show the next heading
9022 (goto-char pos)
9023 (call-interactively 'org-set-effort)
9024 (end-of-line 1)
9025 (setq newhead (org-get-heading)))
9026 (org-agenda-change-all-lines newhead hdmarker))))
9028 (defun org-agenda-toggle-archive-tag ()
9029 "Toggle the archive tag for the current entry."
9030 (interactive)
9031 (org-agenda-check-no-diary)
9032 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9033 (org-agenda-error)))
9034 (buffer (marker-buffer hdmarker))
9035 (pos (marker-position hdmarker))
9036 (inhibit-read-only t)
9037 newhead)
9038 (org-with-remote-undo buffer
9039 (with-current-buffer buffer
9040 (widen)
9041 (goto-char pos)
9042 (org-show-context 'agenda)
9043 (save-excursion
9044 (and (outline-next-heading)
9045 (org-flag-heading nil))) ; show the next heading
9046 (call-interactively 'org-toggle-archive-tag)
9047 (end-of-line 1)
9048 (setq newhead (org-get-heading)))
9049 (org-agenda-change-all-lines newhead hdmarker)
9050 (beginning-of-line 1))))
9052 (defun org-agenda-do-date-later (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-later-minutes)
9059 (org-agenda-date-later-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-later-hours)
9064 (org-agenda-date-later-hours 1))
9066 (org-agenda-date-later (prefix-numeric-value arg)))))
9068 (defun org-agenda-do-date-earlier (arg)
9069 (interactive "P")
9070 (cond
9071 ((or (equal arg '(16))
9072 (memq last-command
9073 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9074 (setq this-command 'org-agenda-date-earlier-minutes)
9075 (org-agenda-date-earlier-minutes 1))
9076 ((or (equal arg '(4))
9077 (memq last-command
9078 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9079 (setq this-command 'org-agenda-date-earlier-hours)
9080 (org-agenda-date-earlier-hours 1))
9082 (org-agenda-date-earlier (prefix-numeric-value arg)))))
9084 (defun org-agenda-date-later (arg &optional what)
9085 "Change the date of this item to ARG day(s) later."
9086 (interactive "p")
9087 (org-agenda-check-type t 'agenda 'timeline)
9088 (org-agenda-check-no-diary)
9089 (let* ((marker (or (org-get-at-bol 'org-marker)
9090 (org-agenda-error)))
9091 (buffer (marker-buffer marker))
9092 (pos (marker-position marker))
9093 cdate today)
9094 (org-with-remote-undo buffer
9095 (with-current-buffer buffer
9096 (widen)
9097 (goto-char pos)
9098 (if (not (org-at-timestamp-p))
9099 (error "Cannot find time stamp"))
9100 (when (and org-agenda-move-date-from-past-immediately-to-today
9101 (equal arg 1)
9102 (or (not what) (eq what 'day))
9103 (not (save-match-data (org-at-date-range-p))))
9104 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
9105 cdate (calendar-absolute-from-gregorian
9106 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
9107 today (org-today))
9108 (if (> today cdate)
9109 ;; immediately shift to today
9110 (setq arg (- today cdate))))
9111 (org-timestamp-change arg (or what 'day))
9112 (when (and (org-at-date-range-p)
9113 (re-search-backward org-tr-regexp-both (point-at-bol)))
9114 (let ((end org-last-changed-timestamp))
9115 (org-timestamp-change arg (or what 'day))
9116 (setq org-last-changed-timestamp
9117 (concat org-last-changed-timestamp "--" end)))))
9118 (org-agenda-show-new-time marker org-last-changed-timestamp))
9119 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9121 (defun org-agenda-date-earlier (arg &optional what)
9122 "Change the date of this item to ARG day(s) earlier."
9123 (interactive "p")
9124 (org-agenda-date-later (- arg) what))
9126 (defun org-agenda-date-later-minutes (arg)
9127 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9128 (interactive "p")
9129 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9130 (org-agenda-date-later arg 'minute))
9132 (defun org-agenda-date-earlier-minutes (arg)
9133 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9134 (interactive "p")
9135 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9136 (org-agenda-date-earlier arg 'minute))
9138 (defun org-agenda-date-later-hours (arg)
9139 "Change the time of this item, in hour steps."
9140 (interactive "p")
9141 (org-agenda-date-later arg 'hour))
9143 (defun org-agenda-date-earlier-hours (arg)
9144 "Change the time of this item, in hour steps."
9145 (interactive "p")
9146 (org-agenda-date-earlier arg 'hour))
9148 (defun org-agenda-show-new-time (marker stamp &optional prefix)
9149 "Show new date stamp via text properties."
9150 ;; We use text properties to make this undoable
9151 (let ((inhibit-read-only t))
9152 (setq stamp (concat prefix " => " stamp " "))
9153 (save-excursion
9154 (goto-char (point-max))
9155 (while (not (bobp))
9156 (when (equal marker (org-get-at-bol 'org-marker))
9157 (org-move-to-column (- (window-width) (length stamp)) t nil t)
9158 (org-agenda-fix-tags-filter-overlays-at (point))
9159 (if (featurep 'xemacs)
9160 ;; Use `duplicable' property to trigger undo recording
9161 (let ((ex (make-extent nil nil))
9162 (gl (make-glyph stamp)))
9163 (set-glyph-face gl 'secondary-selection)
9164 (set-extent-properties
9165 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9166 (insert-extent ex (1- (point)) (point-at-eol)))
9167 (add-text-properties
9168 (1- (point)) (point-at-eol)
9169 (list 'display (org-add-props stamp nil
9170 'face 'secondary-selection))))
9171 (beginning-of-line 1))
9172 (beginning-of-line 0)))))
9174 (defun org-agenda-date-prompt (arg)
9175 "Change the date of this item. Date is prompted for, with default today.
9176 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9177 be used to request time specification in the time stamp."
9178 (interactive "P")
9179 (org-agenda-check-type t 'agenda 'timeline)
9180 (org-agenda-check-no-diary)
9181 (let* ((marker (or (org-get-at-bol 'org-marker)
9182 (org-agenda-error)))
9183 (buffer (marker-buffer marker))
9184 (pos (marker-position marker)))
9185 (org-with-remote-undo buffer
9186 (with-current-buffer buffer
9187 (widen)
9188 (goto-char pos)
9189 (if (not (org-at-timestamp-p t))
9190 (error "Cannot find time stamp"))
9191 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9192 (org-agenda-show-new-time marker org-last-changed-timestamp))
9193 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9195 (defun org-agenda-schedule (arg &optional time)
9196 "Schedule the item at point.
9197 ARG is passed through to `org-schedule'."
9198 (interactive "P")
9199 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9200 (org-agenda-check-no-diary)
9201 (let* ((marker (or (org-get-at-bol 'org-marker)
9202 (org-agenda-error)))
9203 (type (marker-insertion-type marker))
9204 (buffer (marker-buffer marker))
9205 (pos (marker-position marker))
9206 (org-insert-labeled-timestamps-at-point nil)
9208 (set-marker-insertion-type marker t)
9209 (org-with-remote-undo buffer
9210 (with-current-buffer buffer
9211 (widen)
9212 (goto-char pos)
9213 (setq ts (org-schedule arg time)))
9214 (org-agenda-show-new-time marker ts " S"))
9215 (message "%s" ts)))
9217 (defun org-agenda-deadline (arg &optional time)
9218 "Schedule the item at point.
9219 ARG is passed through to `org-deadline'."
9220 (interactive "P")
9221 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9222 (org-agenda-check-no-diary)
9223 (let* ((marker (or (org-get-at-bol 'org-marker)
9224 (org-agenda-error)))
9225 (buffer (marker-buffer marker))
9226 (pos (marker-position marker))
9227 (org-insert-labeled-timestamps-at-point nil)
9229 (org-with-remote-undo buffer
9230 (with-current-buffer buffer
9231 (widen)
9232 (goto-char pos)
9233 (setq ts (org-deadline arg time)))
9234 (org-agenda-show-new-time marker ts " D"))
9235 (message "%s" ts)))
9237 (defun org-agenda-clock-in (&optional arg)
9238 "Start the clock on the currently selected item."
9239 (interactive "P")
9240 (org-agenda-check-no-diary)
9241 (if (equal arg '(4))
9242 (org-clock-in arg)
9243 (let* ((marker (or (org-get-at-bol 'org-marker)
9244 (org-agenda-error)))
9245 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9246 (pos (marker-position marker))
9247 (col (current-column))
9248 newhead)
9249 (org-with-remote-undo (marker-buffer marker)
9250 (with-current-buffer (marker-buffer marker)
9251 (widen)
9252 (goto-char pos)
9253 (org-show-context 'agenda)
9254 (org-show-entry)
9255 (org-cycle-hide-drawers 'children)
9256 (org-clock-in arg)
9257 (setq newhead (org-get-heading)))
9258 (org-agenda-change-all-lines newhead hdmarker))
9259 (org-move-to-column col))))
9261 (defun org-agenda-clock-out ()
9262 "Stop the currently running clock."
9263 (interactive)
9264 (unless (marker-buffer org-clock-marker)
9265 (error "No running clock"))
9266 (let ((marker (make-marker)) (col (current-column)) newhead)
9267 (org-with-remote-undo (marker-buffer org-clock-marker)
9268 (with-current-buffer (marker-buffer org-clock-marker)
9269 (save-excursion
9270 (save-restriction
9271 (widen)
9272 (goto-char org-clock-marker)
9273 (org-back-to-heading t)
9274 (move-marker marker (point))
9275 (org-clock-out)
9276 (setq newhead (org-get-heading))))))
9277 (org-agenda-change-all-lines newhead marker)
9278 (move-marker marker nil)
9279 (org-move-to-column col)
9280 (org-agenda-unmark-clocking-task)))
9282 (defun org-agenda-clock-cancel (&optional arg)
9283 "Cancel the currently running clock."
9284 (interactive "P")
9285 (unless (marker-buffer org-clock-marker)
9286 (user-error "No running clock"))
9287 (org-with-remote-undo (marker-buffer org-clock-marker)
9288 (org-clock-cancel)))
9290 (defun org-agenda-clock-goto ()
9291 "Jump to the currently clocked in task within the agenda.
9292 If the currently clocked in task is not listed in the agenda
9293 buffer, display it in another window."
9294 (interactive)
9295 (let (pos)
9296 (mapc (lambda (o)
9297 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9298 (setq pos (overlay-start o))))
9299 (overlays-in (point-min) (point-max)))
9300 (cond (pos (goto-char pos))
9301 ;; If the currently clocked entry is not in the agenda
9302 ;; buffer, we visit it in another window:
9303 (org-clock-current-task
9304 (org-switch-to-buffer-other-window (org-clock-goto)))
9305 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9307 (defun org-agenda-diary-entry-in-org-file ()
9308 "Make a diary entry in the file `org-agenda-diary-file'."
9309 (let (d1 d2 char (text "") dp1 dp2)
9310 (if (equal (buffer-name) "*Calendar*")
9311 (setq d1 (calendar-cursor-to-date t)
9312 d2 (car calendar-mark-ring))
9313 (setq dp1 (get-text-property (point-at-bol) 'day))
9314 (unless dp1 (user-error "No date defined in current line"))
9315 (setq d1 (calendar-gregorian-from-absolute dp1)
9316 d2 (and (ignore-errors (mark))
9317 (save-excursion
9318 (goto-char (mark))
9319 (setq dp2 (get-text-property (point-at-bol) 'day)))
9320 (calendar-gregorian-from-absolute dp2))))
9321 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9322 (setq char (read-char-exclusive))
9323 (cond
9324 ((equal char ?d)
9325 (setq text (read-string "Day entry: "))
9326 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9327 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9328 ((equal char ?a)
9329 (setq d1 (list (car d1) (nth 1 d1)
9330 (read-number (format "Reference year [%d]: " (nth 2 d1))
9331 (nth 2 d1))))
9332 (setq text (read-string "Anniversary (use %d to show years): "))
9333 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9334 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9335 ((equal char ?b)
9336 (setq text (read-string "Block entry: "))
9337 (unless (and d1 d2 (not (equal d1 d2)))
9338 (user-error "No block of days selected"))
9339 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9340 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9341 ((equal char ?j)
9342 (org-switch-to-buffer-other-window
9343 (find-file-noselect org-agenda-diary-file))
9344 (require 'org-datetree)
9345 (org-datetree-find-date-create d1)
9346 (org-reveal t))
9347 (t (user-error "Invalid selection character `%c'" char)))))
9349 (defcustom org-agenda-insert-diary-strategy 'date-tree
9350 "Where in `org-agenda-diary-file' should new entries be added?
9351 Valid values:
9353 date-tree in the date tree, as child of the date
9354 top-level as top-level entries at the end of the file."
9355 :group 'org-agenda
9356 :type '(choice
9357 (const :tag "in a date tree" date-tree)
9358 (const :tag "as top level at end of file" top-level)))
9360 (defcustom org-agenda-insert-diary-extract-time nil
9361 "Non-nil means extract any time specification from the diary entry."
9362 :group 'org-agenda
9363 :version "24.1"
9364 :type 'boolean)
9366 (defcustom org-agenda-bulk-mark-char ">"
9367 "A single-character string to be used as the bulk mark."
9368 :group 'org-agenda
9369 :version "24.1"
9370 :type 'string)
9372 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9373 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9374 If TEXT is not empty, it will become the headline of the new entry, and
9375 the resulting entry will not be shown. When TEXT is empty, switch to
9376 `org-agenda-diary-file' and let the user finish the entry there."
9377 (let ((cw (current-window-configuration)))
9378 (org-switch-to-buffer-other-window
9379 (find-file-noselect org-agenda-diary-file))
9380 (widen)
9381 (goto-char (point-min))
9382 (cond
9383 ((eq type 'anniversary)
9384 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9385 (progn
9386 (or (org-at-heading-p t)
9387 (progn
9388 (outline-next-heading)
9389 (insert "* Anniversaries\n\n")
9390 (beginning-of-line -1)))))
9391 (outline-next-heading)
9392 (org-back-over-empty-lines)
9393 (backward-char 1)
9394 (insert "\n")
9395 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9396 (nth 2 d1) (car d1) (nth 1 d1) text)))
9397 ((eq type 'day)
9398 (let ((org-prefix-has-time t)
9399 (org-agenda-time-leading-zero t)
9400 fmt time time2)
9401 (if org-agenda-insert-diary-extract-time
9402 ;; Use org-agenda-format-item to parse text for a time-range and
9403 ;; remove it. FIXME: This is a hack, we should refactor
9404 ;; that function to make time extraction available separately
9405 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9406 time (get-text-property 0 'time fmt)
9407 time2 (if (> (length time) 0)
9408 ;; split-string removes trailing ...... if
9409 ;; no end time given. First space
9410 ;; separates time from date.
9411 (concat " " (car (split-string time "\\.")))
9412 nil)
9413 text (get-text-property 0 'txt fmt)))
9414 (if (eq org-agenda-insert-diary-strategy 'top-level)
9415 (org-agenda-insert-diary-as-top-level text)
9416 (require 'org-datetree)
9417 (org-datetree-find-date-create d1)
9418 (org-agenda-insert-diary-make-new-entry text))
9419 (org-insert-time-stamp (org-time-from-absolute
9420 (calendar-absolute-from-gregorian d1))
9421 nil nil nil nil time2))
9422 (end-of-line 0))
9423 ((eq type 'block)
9424 (if (> (calendar-absolute-from-gregorian d1)
9425 (calendar-absolute-from-gregorian d2))
9426 (setq d1 (prog1 d2 (setq d2 d1))))
9427 (if (eq org-agenda-insert-diary-strategy 'top-level)
9428 (org-agenda-insert-diary-as-top-level text)
9429 (require 'org-datetree)
9430 (org-datetree-find-date-create d1)
9431 (org-agenda-insert-diary-make-new-entry text))
9432 (org-insert-time-stamp (org-time-from-absolute
9433 (calendar-absolute-from-gregorian d1)))
9434 (insert "--")
9435 (org-insert-time-stamp (org-time-from-absolute
9436 (calendar-absolute-from-gregorian d2)))
9437 (end-of-line 0)))
9438 (if (string-match "\\S-" text)
9439 (progn
9440 (set-window-configuration cw)
9441 (message "%s entry added to %s"
9442 (capitalize (symbol-name type))
9443 (abbreviate-file-name org-agenda-diary-file)))
9444 (org-reveal t)
9445 (message "Please finish entry here"))))
9447 (defun org-agenda-insert-diary-as-top-level (text)
9448 "Make new entry as a top-level entry at the end of the file.
9449 Add TEXT as headline, and position the cursor in the second line so that
9450 a timestamp can be added there."
9451 (widen)
9452 (goto-char (point-max))
9453 (or (bolp) (insert "\n"))
9454 (insert "* " text "\n")
9455 (if org-adapt-indentation (org-indent-to-column 2)))
9457 (defun org-agenda-insert-diary-make-new-entry (text)
9458 "Make new entry as last child of current entry.
9459 Add TEXT as headline, and position the cursor in the second line so that
9460 a timestamp can be added there."
9461 (let ((org-show-following-heading t)
9462 (org-show-siblings t)
9463 (org-show-hierarchy-above t)
9464 (org-show-entry-below t)
9465 col)
9466 (outline-next-heading)
9467 (org-back-over-empty-lines)
9468 (or (looking-at "[ \t]*$")
9469 (progn (insert "\n") (backward-char 1)))
9470 (org-insert-heading nil t)
9471 (org-do-demote)
9472 (setq col (current-column))
9473 (insert text "\n")
9474 (if org-adapt-indentation (org-indent-to-column col))
9475 (let ((org-show-following-heading t)
9476 (org-show-siblings t)
9477 (org-show-hierarchy-above t)
9478 (org-show-entry-below t))
9479 (org-show-context))))
9481 (defun org-agenda-diary-entry ()
9482 "Make a diary entry, like the `i' command from the calendar.
9483 All the standard commands work: block, weekly etc.
9484 When `org-agenda-diary-file' points to a file,
9485 `org-agenda-diary-entry-in-org-file' is called instead to create
9486 entries in that Org-mode file."
9487 (interactive)
9488 (if (not (eq org-agenda-diary-file 'diary-file))
9489 (org-agenda-diary-entry-in-org-file)
9490 (require 'diary-lib)
9491 (let* ((char (progn
9492 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9493 (read-char-exclusive)))
9494 (cmd (cdr (assoc char
9495 '((?d . insert-diary-entry)
9496 (?w . insert-weekly-diary-entry)
9497 (?m . insert-monthly-diary-entry)
9498 (?y . insert-yearly-diary-entry)
9499 (?a . insert-anniversary-diary-entry)
9500 (?b . insert-block-diary-entry)
9501 (?c . insert-cyclic-diary-entry)))))
9502 (oldf (symbol-function 'calendar-cursor-to-date))
9503 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9504 (point (point))
9505 (mark (or (mark t) (point))))
9506 (unless cmd
9507 (user-error "No command associated with <%c>" char))
9508 (unless (and (get-text-property point 'day)
9509 (or (not (equal ?b char))
9510 (get-text-property mark 'day)))
9511 (user-error "Don't know which date to use for diary entry"))
9512 ;; We implement this by hacking the `calendar-cursor-to-date' function
9513 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9514 (let ((calendar-mark-ring
9515 (list (calendar-gregorian-from-absolute
9516 (or (get-text-property mark 'day)
9517 (get-text-property point 'day))))))
9518 (unwind-protect
9519 (progn
9520 (fset 'calendar-cursor-to-date
9521 (lambda (&optional error dummy)
9522 (calendar-gregorian-from-absolute
9523 (get-text-property point 'day))))
9524 (call-interactively cmd))
9525 (fset 'calendar-cursor-to-date oldf))))))
9527 (defun org-agenda-execute-calendar-command (cmd)
9528 "Execute a calendar command from the agenda with date from cursor."
9529 (org-agenda-check-type t 'agenda 'timeline)
9530 (require 'diary-lib)
9531 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9532 (user-error "Don't know which date to use for the calendar command"))
9533 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9534 (point (point))
9535 (date (calendar-gregorian-from-absolute
9536 (get-text-property point 'day)))
9537 ;; the following 2 vars are needed in the calendar
9538 (displayed-month (car date))
9539 (displayed-year (nth 2 date)))
9540 (unwind-protect
9541 (progn
9542 (fset 'calendar-cursor-to-date
9543 (lambda (&optional error dummy)
9544 (calendar-gregorian-from-absolute
9545 (get-text-property point 'day))))
9546 (call-interactively cmd))
9547 (fset 'calendar-cursor-to-date oldf))))
9549 (defun org-agenda-phases-of-moon ()
9550 "Display the phases of the moon for the 3 months around the cursor date."
9551 (interactive)
9552 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
9554 (defun org-agenda-holidays ()
9555 "Display the holidays for the 3 months around the cursor date."
9556 (interactive)
9557 (org-agenda-execute-calendar-command 'list-calendar-holidays))
9559 (defvar calendar-longitude) ; defined in calendar.el
9560 (defvar calendar-latitude) ; defined in calendar.el
9561 (defvar calendar-location-name) ; defined in calendar.el
9563 (defun org-agenda-sunrise-sunset (arg)
9564 "Display sunrise and sunset for the cursor date.
9565 Latitude and longitude can be specified with the variables
9566 `calendar-latitude' and `calendar-longitude'. When called with prefix
9567 argument, latitude and longitude will be prompted for."
9568 (interactive "P")
9569 (require 'solar)
9570 (let ((calendar-longitude (if arg nil calendar-longitude))
9571 (calendar-latitude (if arg nil calendar-latitude))
9572 (calendar-location-name
9573 (if arg "the given coordinates" calendar-location-name)))
9574 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9576 (defun org-agenda-goto-calendar ()
9577 "Open the Emacs calendar with the date at the cursor."
9578 (interactive)
9579 (org-agenda-check-type t 'agenda 'timeline)
9580 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9581 (user-error "Don't know which date to open in calendar")))
9582 (date (calendar-gregorian-from-absolute day))
9583 (calendar-move-hook nil)
9584 (calendar-view-holidays-initially-flag nil)
9585 (calendar-view-diary-initially-flag nil))
9586 (calendar)
9587 (calendar-goto-date date)))
9589 ;;;###autoload
9590 (defun org-calendar-goto-agenda ()
9591 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9592 This is a command that has to be installed in `calendar-mode-map'."
9593 (interactive)
9594 (org-agenda-list nil (calendar-absolute-from-gregorian
9595 (calendar-cursor-to-date))
9596 nil))
9598 (defun org-agenda-convert-date ()
9599 (interactive)
9600 (org-agenda-check-type t 'agenda 'timeline)
9601 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9602 date s)
9603 (unless day
9604 (user-error "Don't know which date to convert"))
9605 (setq date (calendar-gregorian-from-absolute day))
9606 (setq s (concat
9607 "Gregorian: " (calendar-date-string date) "\n"
9608 "ISO: " (calendar-iso-date-string date) "\n"
9609 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9610 "Julian: " (calendar-julian-date-string date) "\n"
9611 "Astron. JD: " (calendar-astro-date-string date)
9612 " (Julian date number at noon UTC)\n"
9613 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9614 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9615 "French: " (calendar-french-date-string date) "\n"
9616 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
9617 "Mayan: " (calendar-mayan-date-string date) "\n"
9618 "Coptic: " (calendar-coptic-date-string date) "\n"
9619 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9620 "Persian: " (calendar-persian-date-string date) "\n"
9621 "Chinese: " (calendar-chinese-date-string date) "\n"))
9622 (with-output-to-temp-buffer "*Dates*"
9623 (princ s))
9624 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9626 ;;; Bulk commands
9628 (defun org-agenda-bulk-marked-p ()
9629 (eq (get-char-property (point-at-bol) 'type)
9630 'org-marked-entry-overlay))
9632 (defun org-agenda-bulk-mark (&optional arg)
9633 "Mark the entry at point for future bulk action."
9634 (interactive "p")
9635 (dotimes (i (or arg 1))
9636 (unless (org-get-at-bol 'org-agenda-diary-link)
9637 (let* ((m (org-get-at-bol 'org-hd-marker))
9639 (unless (org-agenda-bulk-marked-p)
9640 (unless m (user-error "Nothing to mark at point"))
9641 (push m org-agenda-bulk-marked-entries)
9642 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9643 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9644 (org-get-todo-face "TODO")
9645 'evaporate)
9646 (overlay-put ov 'type 'org-marked-entry-overlay))
9647 (end-of-line 1)
9648 (or (ignore-errors
9649 (goto-char (next-single-property-change (point) 'txt)))
9650 (beginning-of-line 2))
9651 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9652 (beginning-of-line 2))
9653 (message "%d entries marked for bulk action"
9654 (length org-agenda-bulk-marked-entries))))))
9656 (defun org-agenda-bulk-mark-all ()
9657 "Mark all entries for future agenda bulk action."
9658 (interactive)
9659 (org-agenda-bulk-mark-regexp "."))
9661 (defun org-agenda-bulk-mark-regexp (regexp)
9662 "Mark entries matching REGEXP for future agenda bulk action."
9663 (interactive "sMark entries matching regexp: ")
9664 (let ((entries-marked 0) txt-at-point)
9665 (save-excursion
9666 (goto-char (point-min))
9667 (goto-char (next-single-property-change (point) 'txt))
9668 (while (and (re-search-forward regexp nil t)
9669 (setq txt-at-point (get-text-property (point) 'txt)))
9670 (when (string-match regexp txt-at-point)
9671 (setq entries-marked (1+ entries-marked))
9672 (call-interactively 'org-agenda-bulk-mark))))
9673 (if (not entries-marked)
9674 (message "No entry matching this regexp."))))
9676 (defun org-agenda-bulk-unmark (&optional arg)
9677 "Unmark the entry at point for future bulk action."
9678 (interactive "P")
9679 (if arg
9680 (org-agenda-bulk-unmark-all)
9681 (cond ((org-agenda-bulk-marked-p)
9682 (org-agenda-bulk-remove-overlays
9683 (point-at-bol) (+ 2 (point-at-bol)))
9684 (setq org-agenda-bulk-marked-entries
9685 (delete (org-get-at-bol 'org-hd-marker)
9686 org-agenda-bulk-marked-entries))
9687 (end-of-line 1)
9688 (or (ignore-errors
9689 (goto-char (next-single-property-change (point) 'txt)))
9690 (beginning-of-line 2))
9691 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9692 (beginning-of-line 2))
9693 (message "%d entries left marked for bulk action"
9694 (length org-agenda-bulk-marked-entries)))
9695 (t (message "No entry to unmark here")))))
9697 (defun org-agenda-bulk-toggle-all ()
9698 "Toggle all marks for bulk action."
9699 (interactive)
9700 (save-excursion
9701 (goto-char (point-min))
9702 (while (ignore-errors
9703 (goto-char (next-single-property-change (point) 'txt)))
9704 (org-agenda-bulk-toggle))))
9706 (defun org-agenda-bulk-toggle ()
9707 "Toggle the mark at point for bulk action."
9708 (interactive)
9709 (if (org-agenda-bulk-marked-p)
9710 (org-agenda-bulk-unmark)
9711 (org-agenda-bulk-mark)))
9713 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9714 "Remove the mark overlays between BEG and END in the agenda buffer.
9715 BEG and END default to the buffer limits.
9717 This only removes the overlays, it does not remove the markers
9718 from the list in `org-agenda-bulk-marked-entries'."
9719 (interactive)
9720 (mapc (lambda (ov)
9721 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9722 (delete-overlay ov)))
9723 (overlays-in (or beg (point-min)) (or end (point-max)))))
9725 (defun org-agenda-bulk-unmark-all ()
9726 "Remove all marks in the agenda buffer.
9727 This will remove the markers and the overlays."
9728 (interactive)
9729 (if (null org-agenda-bulk-marked-entries)
9730 (message "No entry to unmark")
9731 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9732 (setq org-agenda-bulk-marked-entries nil)
9733 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9735 (defcustom org-agenda-persistent-marks nil
9736 "Non-nil means marked items will stay marked after a bulk action.
9737 You can toggle this interactively by typing `p' when prompted for a
9738 bulk action."
9739 :group 'org-agenda
9740 :version "24.1"
9741 :type 'boolean)
9743 (defun org-agenda-bulk-action (&optional arg)
9744 "Execute an remote-editing action on all marked entries.
9745 The prefix arg is passed through to the command if possible."
9746 (interactive "P")
9747 ;; Make sure we have markers, and only valid ones
9748 (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
9749 (mapc
9750 (lambda (m)
9751 (unless (and (markerp m)
9752 (marker-buffer m)
9753 (buffer-live-p (marker-buffer m))
9754 (marker-position m))
9755 (user-error "Marker %s for bulk command is invalid" m)))
9756 org-agenda-bulk-marked-entries)
9758 ;; Prompt for the bulk command
9759 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9760 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9761 "[S]catter [f]unction "
9762 (when org-agenda-bulk-custom-functions
9763 (concat " Custom: ["
9764 (mapconcat (lambda(f) (char-to-string (car f)))
9765 org-agenda-bulk-custom-functions "")
9766 "]"))))
9767 (catch 'exit
9768 (let* ((action (read-char-exclusive))
9769 (org-log-refile (if org-log-refile 'time nil))
9770 (entries (reverse org-agenda-bulk-marked-entries))
9771 (org-overriding-default-time
9772 (if (get-text-property (point) 'org-agenda-date-header)
9773 (org-get-cursor-date)))
9774 redo-at-end
9775 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9776 (cond
9777 ((equal action ?p)
9778 (let ((org-agenda-persistent-marks
9779 (not org-agenda-persistent-marks)))
9780 (org-agenda-bulk-action)
9781 (throw 'exit nil)))
9783 ((equal action ?$)
9784 (setq cmd '(org-agenda-archive)))
9786 ((equal action ?A)
9787 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9789 ((member action '(?r ?w))
9790 (setq rfloc (org-refile-get-location
9791 "Refile to"
9792 (marker-buffer (car entries))
9793 org-refile-allow-creating-parent-nodes))
9794 (if (nth 3 rfloc)
9795 (setcar (nthcdr 3 rfloc)
9796 (move-marker (make-marker) (nth 3 rfloc)
9797 (or (get-file-buffer (nth 1 rfloc))
9798 (find-buffer-visiting (nth 1 rfloc))
9799 (error "This should not happen")))))
9801 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9802 redo-at-end t))
9804 ((equal action ?t)
9805 (setq state (org-icompleting-read
9806 "Todo state: "
9807 (with-current-buffer (marker-buffer (car entries))
9808 (mapcar 'list org-todo-keywords-1))))
9809 (setq cmd `(let ((org-inhibit-blocking t)
9810 (org-inhibit-logging 'note))
9811 (org-agenda-todo ,state))))
9813 ((memq action '(?- ?+))
9814 (setq tag (org-icompleting-read
9815 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9816 (with-current-buffer (marker-buffer (car entries))
9817 (delq nil
9818 (mapcar (lambda (x)
9819 (if (stringp (car x)) x)) org-tag-alist)))))
9820 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9822 ((memq action '(?s ?d))
9823 (let* ((time
9824 (unless arg
9825 (org-read-date
9826 nil nil nil
9827 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9828 org-overriding-default-time)))
9829 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9830 (setq cmd `(eval '(,c1 arg ,time)))))
9832 ((equal action ?S)
9833 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9834 (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9835 (let ((days (read-number
9836 (format "Scatter tasks across how many %sdays: "
9837 (if arg "week" "")) 7)))
9838 (setq cmd
9839 `(let ((distance (1+ (random ,days))))
9840 (if arg
9841 (let ((dist distance)
9842 (day-of-week
9843 (calendar-day-of-week
9844 (calendar-gregorian-from-absolute (org-today)))))
9845 (dotimes (i (1+ dist))
9846 (while (member day-of-week org-agenda-weekend-days)
9847 (incf distance)
9848 (incf day-of-week)
9849 (if (= day-of-week 7)
9850 (setq day-of-week 0)))
9851 (incf day-of-week)
9852 (if (= day-of-week 7)
9853 (setq day-of-week 0)))))
9854 ;; silently fail when try to replan a sexp entry
9855 (condition-case nil
9856 (let* ((date (calendar-gregorian-from-absolute
9857 (+ (org-today) distance)))
9858 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9859 (nth 2 date))))
9860 (org-agenda-schedule nil time))
9861 (error nil)))))))
9863 ((assoc action org-agenda-bulk-custom-functions)
9864 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9865 redo-at-end t))
9867 ((equal action ?f)
9868 (setq cmd (list (intern
9869 (org-icompleting-read "Function: "
9870 obarray 'fboundp t nil nil)))))
9872 (t (user-error "Invalid bulk action")))
9874 ;; Sort the markers, to make sure that parents are handled before children
9875 (setq entries (sort entries
9876 (lambda (a b)
9877 (cond
9878 ((equal (marker-buffer a) (marker-buffer b))
9879 (< (marker-position a) (marker-position b)))
9881 (string< (buffer-name (marker-buffer a))
9882 (buffer-name (marker-buffer b))))))))
9884 ;; Now loop over all markers and apply cmd
9885 (while (setq e (pop entries))
9886 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9887 (if (not pos)
9888 (progn (message "Skipping removed entry at %s" e)
9889 (setq cntskip (1+ cntskip)))
9890 (goto-char pos)
9891 (let (org-loop-over-headlines-in-active-region)
9892 (eval cmd))
9893 (setq cnt (1+ cnt))))
9894 (when redo-at-end (org-agenda-redo))
9895 (unless org-agenda-persistent-marks
9896 (org-agenda-bulk-unmark-all))
9897 (message "Acted on %d entries%s%s"
9899 (if (= cntskip 0)
9901 (format ", skipped %d (disappeared before their turn)"
9902 cntskip))
9903 (if (not org-agenda-persistent-marks)
9904 "" " (kept marked)"))))))
9906 (defun org-agenda-capture (&optional with-time)
9907 "Call `org-capture' with the date at point.
9908 With a `C-1' prefix, use the HH:MM value at point (if any) or the
9909 current HH:MM time."
9910 (interactive "P")
9911 (if (not (eq major-mode 'org-agenda-mode))
9912 (user-error "You cannot do this outside of agenda buffers")
9913 (let ((org-overriding-default-time
9914 (org-get-cursor-date (equal with-time 1))))
9915 (call-interactively 'org-capture))))
9917 ;;; Dragging agenda lines forward/backward
9919 (defun org-agenda-drag-line-forward (arg)
9920 "Drag an agenda line forward by ARG lines."
9921 (interactive "p")
9922 (let ((inhibit-read-only t) lst)
9923 (if (or (not (get-text-property (point) 'txt))
9924 (save-excursion
9925 (dotimes (n arg)
9926 (move-beginning-of-line 2)
9927 (push (not (get-text-property (point) 'txt)) lst))
9928 (delq nil lst)))
9929 (message "Cannot move line forward")
9930 (org-drag-line-forward arg))))
9932 (defun org-agenda-drag-line-backward (arg)
9933 "Drag an agenda line backward by ARG lines."
9934 (interactive "p")
9935 (let ((inhibit-read-only t) lst)
9936 (if (or (not (get-text-property (point) 'txt))
9937 (save-excursion
9938 (dotimes (n arg)
9939 (move-beginning-of-line 0)
9940 (push (not (get-text-property (point) 'txt)) lst))
9941 (delq nil lst)))
9942 (message "Cannot move line backward")
9943 (org-drag-line-backward arg))))
9945 ;;; Flagging notes
9947 (defun org-agenda-show-the-flagging-note ()
9948 "Display the flagging note in the other window.
9949 When called a second time in direct sequence, offer to remove the FLAGGING
9950 tag and (if present) the flagging note."
9951 (interactive)
9952 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
9953 (win (selected-window))
9954 note heading newhead)
9955 (unless hdmarker
9956 (user-error "No linked entry at point"))
9957 (if (and (eq this-command last-command)
9958 (y-or-n-p "Unflag and remove any flagging note? "))
9959 (progn
9960 (org-agenda-remove-flag hdmarker)
9961 (let ((win (get-buffer-window "*Flagging Note*")))
9962 (and win (delete-window win)))
9963 (message "Entry unflagged"))
9964 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
9965 (unless note
9966 (user-error "No flagging note"))
9967 (org-kill-new note)
9968 (org-switch-to-buffer-other-window "*Flagging Note*")
9969 (erase-buffer)
9970 (insert note)
9971 (goto-char (point-min))
9972 (while (re-search-forward "\\\\n" nil t)
9973 (replace-match "\n" t t))
9974 (goto-char (point-min))
9975 (select-window win)
9976 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9978 (defun org-agenda-remove-flag (marker)
9979 "Remove the FLAGGED tag and any flagging note in the entry."
9980 (let (newhead)
9981 (org-with-point-at marker
9982 (org-toggle-tag "FLAGGED" 'off)
9983 (org-entry-delete nil "THEFLAGGINGNOTE")
9984 (setq newhead (org-get-heading)))
9985 (org-agenda-change-all-lines newhead marker)
9986 (message "Entry unflagged")))
9988 (defun org-agenda-get-any-marker (&optional pos)
9989 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9990 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9992 ;;; Appointment reminders
9994 (defvar appt-time-msg-list) ; defined in appt.el
9996 ;;;###autoload
9997 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9998 "Activate appointments found in `org-agenda-files'.
9999 With a \\[universal-argument] prefix, refresh the list of
10000 appointments.
10002 If FILTER is t, interactively prompt the user for a regular
10003 expression, and filter out entries that don't match it.
10005 If FILTER is a string, use this string as a regular expression
10006 for filtering entries out.
10008 If FILTER is a function, filter out entries against which
10009 calling the function returns nil. This function takes one
10010 argument: an entry from `org-agenda-get-day-entries'.
10012 FILTER can also be an alist with the car of each cell being
10013 either 'headline or 'category. For example:
10015 '((headline \"IMPORTANT\")
10016 (category \"Work\"))
10018 will only add headlines containing IMPORTANT or headlines
10019 belonging to the \"Work\" category.
10021 ARGS are symbols indicating what kind of entries to consider.
10022 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
10023 \(i.e., deadlines and scheduled items with a hh:mm specification)
10024 and :timestamp entries. See the docstring of `org-diary' for
10025 details and examples.
10027 If an entry has a APPT_WARNTIME property, its value will be used
10028 to override `appt-message-warning-time'."
10029 (interactive "P")
10030 (if refresh (setq appt-time-msg-list nil))
10031 (if (eq filter t)
10032 (setq filter (read-from-minibuffer "Regexp filter: ")))
10033 (let* ((cnt 0) ; count added events
10034 (scope (or args '(:deadline* :scheduled* :timestamp)))
10035 (org-agenda-new-buffers nil)
10036 (org-deadline-warning-days 0)
10037 ;; Do not use `org-today' here because appt only takes
10038 ;; time and without date as argument, so it may pass wrong
10039 ;; information otherwise
10040 (today (org-date-to-gregorian
10041 (time-to-days (current-time))))
10042 (org-agenda-restrict nil)
10043 (files (org-agenda-files 'unrestricted)) entries file
10044 (org-agenda-buffer nil))
10045 ;; Get all entries which may contain an appt
10046 (org-agenda-prepare-buffers files)
10047 (while (setq file (pop files))
10048 (setq entries
10049 (delq nil
10050 (append entries
10051 (apply 'org-agenda-get-day-entries
10052 file today scope)))))
10053 ;; Map thru entries and find if we should filter them out
10054 (mapc
10055 (lambda(x)
10056 (let* ((evt (org-trim
10057 (replace-regexp-in-string
10058 org-bracket-link-regexp "\\3"
10059 (or (get-text-property 1 'txt x) ""))))
10060 (cat (get-text-property 1 'org-category x))
10061 (tod (get-text-property 1 'time-of-day x))
10062 (ok (or (null filter)
10063 (and (stringp filter) (string-match filter evt))
10064 (and (functionp filter) (funcall filter x))
10065 (and (listp filter)
10066 (let ((cat-filter (cadr (assoc 'category filter)))
10067 (evt-filter (cadr (assoc 'headline filter))))
10068 (or (and (stringp cat-filter)
10069 (string-match cat-filter cat))
10070 (and (stringp evt-filter)
10071 (string-match evt-filter evt)))))))
10072 (wrn (get-text-property 1 'warntime x)))
10073 ;; FIXME: Shall we remove text-properties for the appt text?
10074 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
10075 (when (and ok tod)
10076 (setq tod (concat "00" (number-to-string tod))
10077 tod (when (string-match
10078 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
10079 (concat (match-string 1 tod) ":"
10080 (match-string 2 tod))))
10081 (if (version< emacs-version "23.3")
10082 (appt-add tod evt)
10083 (appt-add tod evt wrn))
10084 (setq cnt (1+ cnt))))) entries)
10085 (org-release-buffers org-agenda-new-buffers)
10086 (if (eq cnt 0)
10087 (message "No event to add")
10088 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
10090 (defun org-agenda-todayp (date)
10091 "Does DATE mean today, when considering `org-extend-today-until'?"
10092 (let ((today (org-today))
10093 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
10094 date)))
10095 (eq date today)))
10097 (defun org-agenda-todo-yesterday (&optional arg)
10098 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
10099 (interactive "P")
10100 (let* ((hour (third (decode-time
10101 (org-current-time))))
10102 (org-extend-today-until (1+ hour)))
10103 (org-agenda-todo arg)))
10105 (provide 'org-agenda)
10107 ;;; org-agenda.el ends here